@visitscotland/component-library 5.71.3 → 5.72.0

package/dist/components/custom-components/federated-search/FederatedSearch.vue.d.ts

@@ -1,40 +1,225 @@
-declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 type __VLS_WithSlots<T, S> = T & (new () => {
     $slots: S;
 });
-declare const __VLS_component: import('vue').DefineComponent<{}, {
+declare const __VLS_base: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Cludo.
+    */
+    cludoApiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Customer ID for Cludo.
+    */
+    cludoCustomerId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Engine ID for Cludo.
+    */
+    cludoEngineId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Base API endpoint for the events API
+    */
+    eventsApi: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Array of filters.
+    */
+    filters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Array of sub filters.
+    */
+    subFilters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Object of error messages
+     */
+    errorMessages: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Label for the 'From' text on each event card
+     */
+    fromText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Labels for the pagination component
+     */
+    paginationLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the search component
+     */
+    searchLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the sort component.
+     */
+    sortLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the card category badge.
+     */
+    cardCategoryLabels: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => void;
+    };
+    /**
+     * Site language used for the Events API.
+     */
+    siteLanguage: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Operator for the Cludo API query.
+     */
+    cludoApiOperator: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => boolean;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Cludo.
+    */
+    cludoApiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Customer ID for Cludo.
+    */
+    cludoCustomerId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Engine ID for Cludo.
+    */
+    cludoEngineId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Base API endpoint for the events API
+    */
+    eventsApi: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Array of filters.
+    */
+    filters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Array of sub filters.
+    */
+    subFilters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Object of error messages
+     */
+    errorMessages: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Label for the 'From' text on each event card
+     */
+    fromText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Labels for the pagination component
+     */
+    paginationLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the search component
+     */
+    searchLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the sort component.
+     */
+    sortLabels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Labels for the card category badge.
+     */
+    cardCategoryLabels: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => void;
+    };
+    /**
+     * Site language used for the Events API.
+     */
+    siteLanguage: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * Operator for the Cludo API query.
+     */
+    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[];
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 type __VLS_Slots = {
     [x: `federated-search__spotlight-${any}`]: (props: {}) => any;
 };

package/dist/components/custom-components/federated-search/components/FedFilter.vue.d.ts

@@ -1,28 +1,117 @@
-declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 type __VLS_WithSlots<T, S> = T & (new () => {
     $slots: S;
 });
-declare const __VLS_component: import('vue').DefineComponent<{}, {
+declare const __VLS_base: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    filterCategories: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Variant of filter:
+     * Primary: medium buttons with icons and 1em gap
+     * Secondary: small buttons, no icons and 0.5em gap
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => boolean;
+    };
+    wrap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * ID of currently active filter
+     */
+    activeFilter: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: string;
+    };
+    /**
+     * Enables the scroll buttons on filter
+     */
+    scrollButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Translated label for the scroll left button
+     */
+    scrollLeftText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Translated label for the scroll right button
+     */
+    scrollRightText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
     resetScroll: typeof resetScroll;
-    $emit: (event: "filter-updated", ...args: any[]) => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "filter-updated": (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    filterCategories: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Variant of filter:
+     * Primary: medium buttons with icons and 1em gap
+     * Secondary: small buttons, no icons and 0.5em gap
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => boolean;
+    };
+    wrap: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * ID of currently active filter
+     */
+    activeFilter: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: string;
+    };
+    /**
+     * Enables the scroll buttons on filter
+     */
+    scrollButtons: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Translated label for the scroll left button
+     */
+    scrollLeftText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Translated label for the scroll right button
+     */
+    scrollRightText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    "onFilter-updated"?: (...args: any[]) => any;
+}>, {
     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, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 type __VLS_Slots = {
     'fed-filter-header'?: (props: {}) => any;
 };

package/dist/components/custom-components/federated-search/components/FedSearchInput.vue.d.ts

@@ -1,21 +1,125 @@
-declare const _default: import('vue').DefineComponent<{}, {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Cludo.
+    */
+    cludoApiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Customer ID for Cludo.
+    */
+    cludoCustomerId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Engine ID for Cludo.
+    */
+    cludoEngineId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Used to determine the search and filter buttons actions.
+    */
+    isHomePage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * URL of search page.
+    */
+    searchUrl: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Array of filters to be used in the FedSearchInput component.
+    */
+    filters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Array of sub filters to be used in the FedSearchInput component.
+    */
+    subFilters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Labels for the component.
+    */
+    labels: {
+        type: ObjectConstructor;
+        required: true;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * API Key for Cludo.
+    */
+    cludoApiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Customer ID for Cludo.
+    */
+    cludoCustomerId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Engine ID for Cludo.
+    */
+    cludoEngineId: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Used to determine the search and filter buttons actions.
+    */
+    isHomePage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * URL of search page.
+    */
+    searchUrl: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Array of filters to be used in the FedSearchInput component.
+    */
+    filters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Array of sub filters to be used in the FedSearchInput component.
+    */
+    subFilters: {
+        type: ArrayConstructor;
+        default: any;
+    };
+    /**
+     * Labels for the component.
+    */
+    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>;
-export default _default;
+    subFilters: unknown[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/custom-components/federated-search/components/FedSearchSort.vue.d.ts

@@ -1,16 +1,81 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    $emit: (event: "from-date-updated" | "end-date-updated" | "sort-order-updated", ...args: any[]) => void;
-    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>;
+declare const _default: typeof __VLS_export;
 export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * Determines if the date fields are visible
+     */
+    dateFilterVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for the sort dropdown
+     *  {
+     *      id: String,
+     *      label: String,
+     *  },
+     */
+    sortOptions: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /** Label to be displayed above `from` date field */
+    fromDateLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Label to be displayed above `to` date field */
+    toDateLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Label to be displayed on the sort dropdown */
+    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<{
+    /**
+     * Determines if the date fields are visible
+     */
+    dateFilterVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Options for the sort dropdown
+     *  {
+     *      id: String,
+     *      label: String,
+     *  },
+     */
+    sortOptions: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /** Label to be displayed above `from` date field */
+    fromDateLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Label to be displayed above `to` date field */
+    toDateLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Label to be displayed on the sort dropdown */
+    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;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;