@visitscotland/component-library 5.71.4 → 5.72.0

package/dist/components/custom-components/federated-search/index.d.ts

@@ -1,222 +1,505 @@
 declare const _default: {
     VsFederatedSearch: {
-        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{}> & Readonly<{}>, {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            cludoApiKey: {
+                type: StringConstructor;
+                default: any;
+            };
+            cludoCustomerId: {
+                type: NumberConstructor;
+                default: number;
+            };
+            cludoEngineId: {
+                type: NumberConstructor;
+                default: number;
+            };
+            eventsApi: {
+                type: StringConstructor;
+                default: any;
+            };
+            filters: {
+                type: ArrayConstructor;
+                default: any;
+            };
+            subFilters: {
+                type: ArrayConstructor;
+                default: any;
+            };
+            errorMessages: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            fromText: {
+                type: StringConstructor;
+                default: string;
+            };
+            paginationLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            searchLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            sortLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            cardCategoryLabels: {
+                type: ObjectConstructor;
+                required: false;
+                default: () => void;
+            };
+            siteLanguage: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => any;
+            };
+            cludoApiOperator: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => boolean;
+            };
+        }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+            filters: unknown[];
+            eventsApi: string;
             siteLanguage: string;
             cludoApiOperator: string;
+            cludoApiKey: string;
             cludoCustomerId: number;
             cludoEngineId: number;
-            errorMessages: Record<string, any>;
+            subFilters: unknown[];
             fromText: string;
-            paginationLabels: Record<string, any>;
-            searchLabels: Record<string, any>;
-            sortLabels: Record<string, any>;
             cardCategoryLabels: Record<string, any>;
-            filters?: unknown[];
-            eventsApi?: string;
-            cludoApiKey?: string;
-            subFilters?: unknown[];
-            $props: {
-                readonly siteLanguage?: string;
-                readonly cludoApiOperator?: string;
-                readonly cludoCustomerId?: number;
-                readonly cludoEngineId?: number;
-                readonly errorMessages?: Record<string, any>;
-                readonly fromText?: string;
-                readonly paginationLabels?: Record<string, any>;
-                readonly searchLabels?: Record<string, any>;
-                readonly sortLabels?: Record<string, any>;
-                readonly cardCategoryLabels?: Record<string, any>;
-                readonly filters?: unknown[];
-                readonly eventsApi?: string;
-                readonly cludoApiKey?: string;
-                readonly subFilters?: unknown[];
-            };
-        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {}, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
             C: {};
             M: {};
             Defaults: {};
-        }, Readonly<{}> & Readonly<{}>, {
+        }, Readonly<import('vue').ExtractPropTypes<{
+            cludoApiKey: {
+                type: StringConstructor;
+                default: any;
+            };
+            cludoCustomerId: {
+                type: NumberConstructor;
+                default: number;
+            };
+            cludoEngineId: {
+                type: NumberConstructor;
+                default: number;
+            };
+            eventsApi: {
+                type: StringConstructor;
+                default: any;
+            };
+            filters: {
+                type: ArrayConstructor;
+                default: any;
+            };
+            subFilters: {
+                type: ArrayConstructor;
+                default: any;
+            };
+            errorMessages: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            fromText: {
+                type: StringConstructor;
+                default: string;
+            };
+            paginationLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            searchLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            sortLabels: {
+                type: ObjectConstructor;
+                required: true;
+            };
+            cardCategoryLabels: {
+                type: ObjectConstructor;
+                required: false;
+                default: () => void;
+            };
+            siteLanguage: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => any;
+            };
+            cludoApiOperator: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => boolean;
+            };
+        }>> & Readonly<{}>, {}, {}, {}, {}, {
+            filters: unknown[];
+            eventsApi: string;
             siteLanguage: string;
             cludoApiOperator: string;
+            cludoApiKey: string;
             cludoCustomerId: number;
             cludoEngineId: number;
-            errorMessages: Record<string, any>;
+            subFilters: unknown[];
             fromText: string;
-            paginationLabels: Record<string, any>;
-            searchLabels: Record<string, any>;
-            sortLabels: Record<string, any>;
             cardCategoryLabels: Record<string, any>;
-            filters?: unknown[];
-            eventsApi?: string;
-            cludoApiKey?: string;
-            subFilters?: unknown[];
-            $props: {
-                readonly siteLanguage?: string;
-                readonly cludoApiOperator?: string;
-                readonly cludoCustomerId?: number;
-                readonly cludoEngineId?: number;
-                readonly errorMessages?: Record<string, any>;
-                readonly fromText?: string;
-                readonly paginationLabels?: Record<string, any>;
-                readonly searchLabels?: Record<string, any>;
-                readonly sortLabels?: Record<string, any>;
-                readonly cardCategoryLabels?: Record<string, any>;
-                readonly filters?: unknown[];
-                readonly eventsApi?: string;
-                readonly cludoApiKey?: string;
-                readonly subFilters?: unknown[];
-            };
-        }, {}, {}, {}, {}>;
+        }>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
-    } & import('vue').ComponentOptionsBase<Readonly<{}> & Readonly<{}>, {
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        cludoApiKey: {
+            type: StringConstructor;
+            default: any;
+        };
+        cludoCustomerId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        cludoEngineId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        eventsApi: {
+            type: StringConstructor;
+            default: any;
+        };
+        filters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        subFilters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        errorMessages: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        fromText: {
+            type: StringConstructor;
+            default: string;
+        };
+        paginationLabels: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        searchLabels: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        sortLabels: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        cardCategoryLabels: {
+            type: ObjectConstructor;
+            required: false;
+            default: () => void;
+        };
+        siteLanguage: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+        cludoApiOperator: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => boolean;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
+        filters: unknown[];
+        eventsApi: string;
         siteLanguage: string;
         cludoApiOperator: string;
+        cludoApiKey: string;
         cludoCustomerId: number;
         cludoEngineId: number;
-        errorMessages: Record<string, any>;
+        subFilters: unknown[];
         fromText: string;
-        paginationLabels: Record<string, any>;
-        searchLabels: Record<string, any>;
-        sortLabels: Record<string, any>;
         cardCategoryLabels: Record<string, any>;
-        filters?: unknown[];
-        eventsApi?: string;
-        cludoApiKey?: string;
-        subFilters?: unknown[];
-        $props: {
-            readonly siteLanguage?: string;
-            readonly cludoApiOperator?: string;
-            readonly cludoCustomerId?: number;
-            readonly cludoEngineId?: number;
-            readonly errorMessages?: Record<string, any>;
-            readonly fromText?: string;
-            readonly paginationLabels?: Record<string, any>;
-            readonly searchLabels?: Record<string, any>;
-            readonly sortLabels?: Record<string, any>;
-            readonly cardCategoryLabels?: Record<string, any>;
-            readonly filters?: unknown[];
-            readonly eventsApi?: string;
-            readonly cludoApiKey?: string;
-            readonly subFilters?: unknown[];
-        };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
         $slots: {
             [x: `federated-search__spotlight-${any}`]: (props: {}) => any;
         };
     });
-    VsFederatedSearchInput: import('vue').DefineComponent<{}, {
+    VsFederatedSearchInput: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        cludoApiKey: {
+            type: StringConstructor;
+            default: any;
+        };
+        cludoCustomerId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        cludoEngineId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        isHomePage: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        searchUrl: {
+            type: StringConstructor;
+            default: any;
+        };
+        filters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        subFilters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        labels: {
+            type: ObjectConstructor;
+            required: true;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        cludoApiKey: {
+            type: StringConstructor;
+            default: any;
+        };
+        cludoCustomerId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        cludoEngineId: {
+            type: NumberConstructor;
+            default: number;
+        };
+        isHomePage: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        searchUrl: {
+            type: StringConstructor;
+            default: any;
+        };
+        filters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        subFilters: {
+            type: ArrayConstructor;
+            default: any;
+        };
+        labels: {
+            type: ObjectConstructor;
+            required: true;
+        };
+    }>> & Readonly<{}>, {
+        filters: unknown[];
         isHomePage: boolean;
+        searchUrl: string;
+        cludoApiKey: string;
         cludoCustomerId: number;
         cludoEngineId: number;
-        labels: Record<string, any>;
-        filters?: unknown[];
-        searchUrl?: string;
-        cludoApiKey?: string;
-        subFilters?: unknown[];
-        $props: {
-            readonly isHomePage?: boolean;
-            readonly cludoCustomerId?: number;
-            readonly cludoEngineId?: number;
-            readonly labels?: Record<string, any>;
-            readonly filters?: unknown[];
-            readonly searchUrl?: string;
-            readonly cludoApiKey?: string;
-            readonly subFilters?: unknown[];
-        };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+        subFilters: unknown[];
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
     VsFedFilter: {
-        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{}> & Readonly<{}>, {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            filterCategories: {
+                type: ArrayConstructor;
+                required: true;
+            };
+            variant: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => boolean;
+            };
+            wrap: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            activeFilter: {
+                type: (StringConstructor | ArrayConstructor)[];
+                default: string;
+            };
+            scrollButtons: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            scrollLeftText: {
+                type: StringConstructor;
+                default: string;
+            };
+            scrollRightText: {
+                type: StringConstructor;
+                default: string;
+            };
+        }>> & Readonly<{
+            "onFilter-updated"?: (...args: any[]) => any;
+        }>, {
             resetScroll: () => void;
-            $emit: (event: "filter-updated", ...args: any[]) => void;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+            "filter-updated": (...args: any[]) => void;
+        }, import('vue').PublicProps, {
             variant: string;
             wrap: boolean;
-            filterCategories: unknown[];
             activeFilter: string | unknown[];
             scrollButtons: boolean;
             scrollLeftText: string;
             scrollRightText: string;
-            $props: {
-                readonly variant?: string;
-                readonly wrap?: boolean;
-                readonly filterCategories?: unknown[];
-                readonly activeFilter?: string | unknown[];
-                readonly scrollButtons?: boolean;
-                readonly scrollLeftText?: string;
-                readonly scrollRightText?: string;
-            };
-        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {}, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
             C: {};
             M: {};
             Defaults: {};
-        }, Readonly<{}> & Readonly<{}>, {
+        }, Readonly<import('vue').ExtractPropTypes<{
+            filterCategories: {
+                type: ArrayConstructor;
+                required: true;
+            };
+            variant: {
+                type: StringConstructor;
+                default: string;
+                validator: (value: unknown) => boolean;
+            };
+            wrap: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            activeFilter: {
+                type: (StringConstructor | ArrayConstructor)[];
+                default: string;
+            };
+            scrollButtons: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            scrollLeftText: {
+                type: StringConstructor;
+                default: string;
+            };
+            scrollRightText: {
+                type: StringConstructor;
+                default: string;
+            };
+        }>> & Readonly<{
+            "onFilter-updated"?: (...args: any[]) => any;
+        }>, {
             resetScroll: () => void;
-            $emit: (event: "filter-updated", ...args: any[]) => void;
+        }, {}, {}, {}, {
             variant: string;
             wrap: boolean;
-            filterCategories: unknown[];
             activeFilter: string | unknown[];
             scrollButtons: boolean;
             scrollLeftText: string;
             scrollRightText: string;
-            $props: {
-                readonly variant?: string;
-                readonly wrap?: boolean;
-                readonly filterCategories?: unknown[];
-                readonly activeFilter?: string | unknown[];
-                readonly scrollButtons?: boolean;
-                readonly scrollLeftText?: string;
-                readonly scrollRightText?: string;
-            };
-        }, {}, {}, {}, {}>;
+        }>;
         __isFragment?: never;
         __isTeleport?: never;
         __isSuspense?: never;
-    } & import('vue').ComponentOptionsBase<Readonly<{}> & Readonly<{}>, {
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        filterCategories: {
+            type: ArrayConstructor;
+            required: true;
+        };
+        variant: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => boolean;
+        };
+        wrap: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        activeFilter: {
+            type: (StringConstructor | ArrayConstructor)[];
+            default: string;
+        };
+        scrollButtons: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        scrollLeftText: {
+            type: StringConstructor;
+            default: string;
+        };
+        scrollRightText: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{
+        "onFilter-updated"?: (...args: any[]) => any;
+    }>, {
         resetScroll: () => void;
-        $emit: (event: "filter-updated", ...args: any[]) => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        "filter-updated": (...args: any[]) => void;
+    }, string, {
         variant: string;
         wrap: boolean;
-        filterCategories: unknown[];
         activeFilter: string | unknown[];
         scrollButtons: boolean;
         scrollLeftText: string;
         scrollRightText: string;
-        $props: {
-            readonly variant?: string;
-            readonly wrap?: boolean;
-            readonly filterCategories?: unknown[];
-            readonly activeFilter?: string | unknown[];
-            readonly scrollButtons?: boolean;
-            readonly scrollLeftText?: string;
-            readonly scrollRightText?: string;
-        };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
         $slots: {
             'fed-filter-header'?: (props: {}) => any;
         };
     });
-    VsFedSearchSort: import('vue').DefineComponent<{}, {
-        $emit: (event: "from-date-updated" | "end-date-updated" | "sort-order-updated", ...args: any[]) => void;
+    VsFedSearchSort: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        dateFilterVisible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        sortOptions: {
+            type: ArrayConstructor;
+            required: true;
+        };
+        fromDateLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+        toDateLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+        sortLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        "from-date-updated": (...args: any[]) => void;
+        "end-date-updated": (...args: any[]) => void;
+        "sort-order-updated": (...args: any[]) => void;
+    }, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        dateFilterVisible: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        sortOptions: {
+            type: ArrayConstructor;
+            required: true;
+        };
+        fromDateLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+        toDateLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+        sortLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+    }>> & Readonly<{
+        "onFrom-date-updated"?: (...args: any[]) => any;
+        "onEnd-date-updated"?: (...args: any[]) => any;
+        "onSort-order-updated"?: (...args: any[]) => any;
+    }>, {
         dateFilterVisible: boolean;
-        sortOptions: unknown[];
-        fromDateLabel: string;
-        toDateLabel: string;
-        sortLabel: string;
-        $props: {
-            readonly dateFilterVisible?: boolean;
-            readonly sortOptions?: unknown[];
-            readonly fromDateLabel?: string;
-            readonly toDateLabel?: string;
-            readonly sortLabel?: string;
-        };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 };
 export default _default;