DefinitelyTyped/types/semantic-ui-embed/global.d.ts

interface JQuery {
    embed: SemanticUI.Embed;
}

declare namespace SemanticUI {
    interface Embed {
        settings: EmbedSettings;

        /**
         * Changes iframe to a new content source
         */
        (behavior: 'change', source: string, id: string, url: string): JQuery;
        /**
         * Removes embed and shows placeholder content if available
         */
        (behavior: 'reset'): JQuery;
        /**
         * Shows embed content
         */
        (behavior: 'show'): JQuery;
        /**
         * Hides embed content and shows placeholder content
         */
        (behavior: 'hide'): JQuery;
        /**
         * Returns current content id
         */
        (behavior: 'get id'): string;
        /**
         * Returns placeholder image url
         */
        (behavior: 'get placeholder'): string;
        /**
         * Returns source name
         */
        (behavior: 'get sources'): string;
        /**
         * Returns source type
         */
        (behavior: 'get type'): string;
        /**
         * Returns URL with all parameters added
         */
        (behavior: 'get url'): string;
        /**
         * Returns whether embed content has placeholder
         */
        (behavior: 'has placeholder'): boolean;
        /**
         * Destroys instance and removes all events
         */
        (behavior: 'destroy'): JQuery;
        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value?: undefined): EmbedSettings._Impl[K];
        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value: EmbedSettings._Impl[K]): JQuery;
        (behavior: 'setting', value: EmbedSettings): JQuery;
        (settings?: EmbedSettings): JQuery;
    }

    /**
     * @see {@link http://semantic-ui.com/modules/embed.html#/settings}
     */
    type EmbedSettings = EmbedSettings.Param;

    namespace EmbedSettings {
        type Param = (Pick<_Impl, 'url'> |
            Pick<_Impl, 'icon'> |
            Pick<_Impl, 'source'> |
            Pick<_Impl, 'id'> |
            Pick<_Impl, 'parameters'> |
            Pick<_Impl, 'autoplay'> |
            Pick<_Impl, 'color'> |
            Pick<_Impl, 'hd'> |
            Pick<_Impl, 'brandedUI'> |
            Pick<_Impl, 'onCreate'> |
            Pick<_Impl, 'onDisplay'> |
            Pick<_Impl, 'onPlaceholderDisplay'> |
            Pick<_Impl, 'onEmbed'> |
            Pick<_Impl, 'selector'> |
            Pick<_Impl, 'metadata'> |
            Pick<_Impl, 'className'> |
            Pick<_Impl, 'templates'> |
            Pick<_Impl, 'error'> |
            Pick<_Impl, 'namespace'> |
            Pick<_Impl, 'name'> |
            Pick<_Impl, 'silent'> |
            Pick<_Impl, 'debug'> |
            Pick<_Impl, 'performance'> |
            Pick<_Impl, 'verbose'>) &
            Partial<Pick<_Impl, keyof _Impl>>;

        interface _Impl {
            /**
             * Specifies a url to use for embed
             *
             * @default false
             */
            url: false | string;

            // region Embed Settings

            /**
             * Specifies an icon to use with placeholder content
             *
             * @default false
             */
            icon: false | string;
            /**
             * Specifies a source to use, if no source is provided it will be determined from the domain of a specified url.
             *
             * @default false
             */
            source: false | string;
            /**
             * Specifies an id value to replace with the {id} value found in templated urls
             *
             * @default false
             */
            id: false | string;
            /**
             * Specify an object containing key/value pairs to add to the iframes GET parameters
             *
             * @default false
             */
            parameters: false | Embed.ParametersSettings;

            // endregion

            // region Video Settings

            /**
             * Default setting auto will only autoplay content when a placeholder is specified. Setting to true or false will force autoplay.
             *
             * @default 'auto'
             */
            autoplay: 'auto' | boolean;
            /**
             * Specifies a default chrome color with Vimeo or YouTube.
             *
             * @default '#444444'
             */
            color: string;
            /**
             * Whether to prefer HD content
             *
             * @default true
             */
            hd: boolean;
            /**
             * Whether to show networks branded UI like title cards, or after video calls to action.
             *
             * @default false
             */
            brandedUI: boolean;

            // endregion

            // region Callbacks

            /**
             * Callback when iframe is generated
             */
            onCreate(this: JQuery, url: string): void;
            /**
             * Whenever an iframe contents is shown
             */
            onDisplay(this: JQuery): void;
            /**
             * Callback immediately before Embed is removed from DOM
             */
            onPlaceholderDisplay(this: JQuery): void;
            /**
             * Callback when module parameters are determined. Allows you to adjust parameters at run time by returning a new parameters object.
             */
            onEmbed(this: JQuery, parameters: Embed.ParametersSettings): Embed.ParametersSettings;

            // endregion

            // region DOM Settings

            /**
             * DOM Selectors used internally
             */
            selector: Embed.SelectorSettings;
            /**
             * HTML Data attributes used to store data
             */
            metadata: Embed.MetadataSettings;
            /**
             * Class names used to attach style to state
             */
            className: Embed.ClassNameSettings;
            templates: Embed.TemplatesSettings;

            // endregion

            // region Debug Settings

            error: Embed.ErrorSettings;

            // endregion

            // region Component Settings

            // region DOM Settings

            /**
             * Event namespace. Makes sure module teardown does not effect other events attached to an element.
             */
            namespace: string;

            // endregion

            // region Debug Settings

            /**
             * Name used in log statements
             */
            name: string;
            /**
             * Silences all console output including error messages, regardless of other debug settings.
             */
            silent: boolean;
            /**
             * Debug output to console
             */
            debug: boolean;
            /**
             * Show console.table output with performance metrics
             */
            performance: boolean;
            /**
             * Debug output includes all internal behaviors
             */
            verbose: boolean;

            // endregion

            // endregion
        }
    }

    namespace Embed {
        type ParametersSettings = ParametersSettings._Impl;

        namespace ParametersSettings {
            type Param = _Impl;

            interface _Impl {
                [key: string]: any;
            }
        }

        type SelectorSettings = SelectorSettings.Param;

        namespace SelectorSettings {
            type Param = (Pick<_Impl, 'embed'> |
                Pick<_Impl, 'placeholder'> |
                Pick<_Impl, 'play'>) &
                Partial<Pick<_Impl, keyof _Impl>>;

            interface _Impl {
                /**
                 * @default '.embed'
                 */
                embed: string;
                /**
                 * @default '.placeholder'
                 */
                placeholder: string;
                /**
                 * @default '.play'
                 */
                play: string;
            }
        }

        type MetadataSettings = MetadataSettings.Param;

        namespace MetadataSettings {
            type Param = (Pick<_Impl, 'id'> |
                Pick<_Impl, 'icon'> |
                Pick<_Impl, 'placeholder'> |
                Pick<_Impl, 'source'> |
                Pick<_Impl, 'url'>) &
                Partial<Pick<_Impl, keyof _Impl>>;

            interface _Impl {
                /**
                 * @default 'id'
                 */
                id: string;
                /**
                 * @default 'icon'
                 */
                icon: string;
                /**
                 * @default 'placeholder'
                 */
                placeholder: string;
                /**
                 * @default 'source'
                 */
                source: string;
                /**
                 * @default 'url'
                 */
                url: string;
            }
        }

        type ClassNameSettings = ClassNameSettings.Param;

        namespace ClassNameSettings {
            type Param = (Pick<_Impl, 'active'> |
                Pick<_Impl, 'embed'>) &
                Partial<Pick<_Impl, keyof _Impl>>;

            interface _Impl {
                /**
                 * @default 'active'
                 */
                active: string;
                /**
                 * @default 'embed'
                 */
                embed: string;
            }
        }

        type TemplatesSettings = TemplatesSettings.Param;

        namespace TemplatesSettings {
            type Param = (Pick<_Impl, 'iframe'> |
                Pick<_Impl, 'placeholder'>) &
                Partial<Pick<_Impl, keyof _Impl>>;

            interface _Impl {
                /**
                 * returns html for iframe
                 */
                iframe(url: string, parameters: string): string;
                /**
                 * returns html for placeholder element
                 */
                placeholder(image: string, icon: string): string;
            }
        }

        type ErrorSettings = ErrorSettings.Param;

        namespace ErrorSettings {
            type Param = (Pick<_Impl, 'noURL'> |
                Pick<_Impl, 'method'>) &
                Partial<Pick<_Impl, keyof _Impl>>;

            interface _Impl {
                /**
                 * @default 'No URL specified'
                 */
                noURL: string;
                /**
                 * @default 'The method you called is not defined'
                 */
                method: string;
            }
        }
    }
}