fomantic-ui 2.9.3-beta.46 → 2.9.3-beta.47

package/types/fomantic-ui-embed.d.ts

@@ -57,315 +57,269 @@ declare namespace FomanticUI {
          */
         (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;
+        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value?: undefined, ): Partial<Pick<EmbedSettings, keyof EmbedSettings>>;
+        <K extends keyof EmbedSettings>(behavior: 'setting', name: K, value: EmbedSettings[K]): JQuery;
+        (behavior: 'setting', value: Partial<Pick<EmbedSettings, keyof EmbedSettings>>): JQuery;
+        (settings?: Partial<Pick<EmbedSettings, keyof EmbedSettings>>): JQuery;
     }
 
     /**
      * @see {@link https://fomantic-ui.com/modules/embed.html#/settings}
      */
-    type EmbedSettings = EmbedSettings.Param;
-
-    namespace EmbedSettings {
-        type Param = (
-            | Pick<_Impl, 'icon'>
-            | Pick<_Impl, 'source'>
-            | Pick<_Impl, 'url'>
-            | 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, 'name'>
-            | Pick<_Impl, 'namespace'>
-            | Pick<_Impl, 'silent'>
-            | Pick<_Impl, 'debug'>
-            | Pick<_Impl, 'performance'>
-            | Pick<_Impl, 'verbose'>
-            | Pick<_Impl, 'error'>
-        ) &
-            Partial<Pick<_Impl, keyof _Impl>>;
-
-        interface _Impl {
-            // 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 a url to use for embed.
-             * @default false
-             */
-            url: 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 | object;
-
-            // 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;
-
-            /**
-             * Default setting 'auto' will only autoplay content when a placeholder is specified.
-             * Setting to 'true' or 'false' will force autoplay.
-             * @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: object): void;
-
-            // endregion
-
-            // region DOM Settings
-
-            /**
-             * DOM Selectors used internally.
-             * Selectors used to find parts of a module.
-             */
-            selector: Embed.SelectorSettings;
-
-            /**
-             * HTML Data attributes used to store data.
-             */
-            metadata: Embed.MetadataSettings;
-
-            /**
-             * Class names used to determine element state.
-             */
-            className: Embed.ClassNameSettings;
-
-            /**
-             *
-             */
-            templates: Embed.TemplateSettings;
-
-            // endregion
-
-            // region Debug Settings
-
-            /**
-             * Name used in log statements
-             */
-            name: string;
-
-            /**
-             * Event namespace. Makes sure module teardown does not effect other events attached to an element.
-             */
-            namespace: 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;
-
-            error: Embed.ErrorSettings;
-
-            // endregion
-        }
+    interface EmbedSettings {
+        // region Embed Settings
 
-        namespace Embed {
-            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;
-                }
-            }
+        /**
+         * Specifies an icon to use with placeholder content.
+         * @default false
+         */
+        icon: false | 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;
-                }
-            }
+        /**
+         * 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;
 
-            type ClassNameSettings = ClassNameSettings.Param;
+        /**
+         * Specifies a url to use for embed.
+         * @default false
+         */
+        url: false | string;
 
-            namespace ClassNameSettings {
-                type Param = (Pick<_Impl, 'active'> | Pick<_Impl, 'embed'>) & Partial<Pick<_Impl, keyof _Impl>>;
+        /**
+         * Specifies an id value to replace with the '{id}' value found in templated urls.
+         * @default false
+         */
+        id: false | string;
 
-                interface _Impl {
-                    /**
-                     * @default 'active'
-                     */
-                    active: string;
+        /**
+         * Specify an object containing key/value pairs to add to the iframes GET parameters.
+         * @default false
+         */
+        parameters: false | object;
 
-                    /**
-                     * @default 'embed'
-                     */
-                    embed: string;
-                }
-            }
+        // 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;
+
+        /**
+         * Default setting 'auto' will only autoplay content when a placeholder is specified.
+         * Setting to 'true' or 'false' will force autoplay.
+         * @default '#444'
+         */
+        color: string;
 
-            type TemplateSettings = TemplateSettings.Param;
+        /**
+         * 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
 
-            namespace TemplateSettings {
-                type Param = (Pick<_Impl, 'iframe'> | Pick<_Impl, 'placeholder'>) & Partial<Pick<_Impl, keyof _Impl>>;
+        // region Callbacks
+
+        /**
+         * Callback when iframe is generated.
+         */
+        onCreate(this: JQuery, url: string): void;
+
+        /**
+         * Whenever an iframe contents is shown.
+         */
+        onDisplay(this: JQuery): void;
+
+        /**
+         * Whenever the module is cleared.
+         */
+        onReset(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: object): void;
 
-                interface _Impl {
-                    /**
-                     * @default function
-                     */
-                    iframe: Function;
+        // endregion
 
-                    /**
-                     * @default function
-                     */
-                    placeholder: Function;
-                }
+        // region DOM Settings
+
+        /**
+         * DOM Selectors used internally.
+         * Selectors used to find parts of a module.
+         */
+        selector: Embed.SelectorSettings;
+
+        /**
+         * HTML Data attributes used to store data.
+         */
+        metadata: Embed.MetadataSettings;
+
+        /**
+         * Class names used to determine element state.
+         */
+        className: Embed.ClassNameSettings;
+
+        /**
+         *
+         */
+        templates: Embed.TemplateSettings;
+
+        // endregion
+
+        // region Debug Settings
+
+        /**
+         * Name used in log statements
+         * @default 'Embed''
+         */
+        name: string;
+
+        /**
+         * Event namespace. Makes sure module teardown does not effect other events attached to an element.
+         * @default 'embed''
+         */
+        namespace: string;
+
+        /**
+         * Silences all console output including error messages, regardless of other debug settings.
+         * @default false
+         */
+        silent: boolean;
+
+        /**
+         * Debug output to console
+         * @default false
+         */
+        debug: boolean;
+
+        /**
+         * Show console.table output with performance metrics
+         * @default true
+         */
+        performance: boolean;
+
+        /**
+         * Debug output includes all internal behaviors
+         * @default false
+         */
+        verbose: boolean;
+
+        error: Embed.ErrorSettings;
+
+        // endregion
+    }
+
+    namespace Embed {
+        type SelectorSettings = Partial<Pick<Settings.Selectors, keyof Settings.Selectors>>;
+        type MetadataSettings = Partial<Pick<Settings.Metadatas, keyof Settings.Metadatas>>;
+        type ClassNameSettings = Partial<Pick<Settings.ClassNames, keyof Settings.ClassNames>>;
+        type TemplateSettings = Partial<Pick<Settings.Templates, keyof Settings.Templates>>;
+        type ErrorSettings = Partial<Pick<Settings.Errors, keyof Settings.Errors>>;
+
+        namespace Settings {
+            interface Selectors {
+                /**
+                 * @default '.embed'
+                 */
+                embed: string;
+
+                /**
+                 * @default '.placeholder'
+                 */
+                placeholder: string;
+
+                /**
+                 * @default '.icon'
+                 */
+                icon: string;
             }
 
-            type ErrorSettings = ErrorSettings.Param;
+            interface Metadatas {
+                /**
+                 * @default 'id'
+                 */
+                id: string;
+
+                /**
+                 * @default 'icon'
+                 */
+                icon: string;
+
+                /**
+                 * @default 'placeholder'
+                 */
+                placeholder: string;
+
+                /**
+                 * @default 'source'
+                 */
+                source: string;
+
+                /**
+                 * @default 'url'
+                 */
+                url: string;
+            }
+
+            interface ClassNames {
+                /**
+                 * @default 'active'
+                 */
+                active: string;
 
-            namespace ErrorSettings {
-                type Param = (Pick<_Impl, 'noURL'> | Pick<_Impl, 'method'>) & Partial<Pick<_Impl, keyof _Impl>>;
+                /**
+                 * @default 'embed'
+                 */
+                embed: string;
+            }
+
+            interface Templates {
+                /**
+                 * @default function
+                 */
+                deQuote(string: string, encode: boolean): string;
+
+                /**
+                 * @default function
+                 */
+                iframe(url: string, parameters: any): string;
+
+                /**
+                 * @default function
+                 */
+                placeholder(image: string, icon: string): string;
+            }
 
-                interface _Impl {
-                    /**
-                     * @default 'No URL specified'
-                     */
-                    noURL: string;
+            interface Errors {
+                /**
+                 * @default 'No URL specified'
+                 */
+                noURL: string;
 
-                    /**
-                     * @default 'The method you called is not defined'
-                     */
-                    method: string;
-                }
+                /**
+                 * @default 'The method you called is not defined'
+                 */
+                method: string;
             }
         }
     }