@visitscotland/component-library 5.71.4 → 5.72.0

package/dist/components/custom-components/maps/MainMap.vue.d.ts

@@ -1,9 +1,255 @@
-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<{
+    /**
+     * Override for API Key, otherwise it'll be retrieved
+     * from environment variables
+     */
+    apiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * MapId set in the Google Maps Platform console
+     * for this particular map (enables/disable GMP features)
+     */
+    mapId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Rendering Type for the Map.
+     * True = Vector Map, otherwise fallback to Raster
+     * Vector Map enables support (with correct MapID) for advanced features like shading
+     * Raster Maps are available for full compatibility across devices.
+     */
+    mapTypeVector: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Center point of map.
+     * Defaults to what is considered the center of Scotland
+     */
+    center: {
+        type: ObjectConstructor;
+        default: () => {
+            lat: number;
+            lng: number;
+        };
+    };
+    /**
+     * Zoom level.
+     * ~12 Good for big cities, ~13 for smaller cities.
+     * 6 for whole of Scotland
+     */
+    zoom: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Radius (in meters) to search from center point.
+     * Default 1000m (1km)
+     * Maximum Value 50000m (50km)
+     */
+    radius: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** Object of labels for the Maps UI */
+    labels: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /** 2 Letter language code to display Google Maps UI with */
+    languageCode: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * URL location of the categories JSON file (from static server)
+     */
+    categoriesLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** JSON object for the category labels (from CMS taxonomies) */
+    categoryLabels: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Suggested destinations for the user to choose from rather than
+     * using the text or nearby searches. */
+    featuredPlaces: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * Message to display when JavaScript is disabled
+     */
+    noJsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Message to display when Cookies disabled
+     */
+    noCookiesMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for Cookies button that will open Cookie Manager
+     */
+    cookieBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Message to display when there are no results available
+     */
+    noResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    resetMapNoResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Text to appear in alert above search results.  */
+    alertText: {
+        type: StringConstructor;
+        default: any;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Override for API Key, otherwise it'll be retrieved
+     * from environment variables
+     */
+    apiKey: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * MapId set in the Google Maps Platform console
+     * for this particular map (enables/disable GMP features)
+     */
+    mapId: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Rendering Type for the Map.
+     * True = Vector Map, otherwise fallback to Raster
+     * Vector Map enables support (with correct MapID) for advanced features like shading
+     * Raster Maps are available for full compatibility across devices.
+     */
+    mapTypeVector: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Center point of map.
+     * Defaults to what is considered the center of Scotland
+     */
+    center: {
+        type: ObjectConstructor;
+        default: () => {
+            lat: number;
+            lng: number;
+        };
+    };
+    /**
+     * Zoom level.
+     * ~12 Good for big cities, ~13 for smaller cities.
+     * 6 for whole of Scotland
+     */
+    zoom: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Radius (in meters) to search from center point.
+     * Default 1000m (1km)
+     * Maximum Value 50000m (50km)
+     */
+    radius: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** Object of labels for the Maps UI */
+    labels: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /** 2 Letter language code to display Google Maps UI with */
+    languageCode: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+    /**
+     * URL location of the categories JSON file (from static server)
+     */
+    categoriesLocation: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** JSON object for the category labels (from CMS taxonomies) */
+    categoryLabels: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Suggested destinations for the user to choose from rather than
+     * using the text or nearby searches. */
+    featuredPlaces: {
+        type: ObjectConstructor;
+        default: any;
+    };
+    /**
+     * Message to display when JavaScript is disabled
+     */
+    noJsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Message to display when Cookies disabled
+     */
+    noCookiesMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for Cookies button that will open Cookie Manager
+     */
+    cookieBtnText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Message to display when there are no results available
+     */
+    noResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    resetMapNoResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Text to appear in alert above search results.  */
+    alertText: {
+        type: StringConstructor;
+        default: any;
+    };
+}>> & Readonly<{}>, {
     center: Record<string, any>;
-    noJsMessage: string;
-    noCookiesMessage: string;
     zoom: number;
-    cookieBtnText: string;
+    apiKey: string;
     radius: number;
     labels: Record<string, any>;
     mapId: string;
@@ -11,29 +257,6 @@ declare const _default: import('vue').DefineComponent<{}, {
     languageCode: string;
     categoriesLocation: string;
     categoryLabels: Record<string, any>;
-    noResultsMessage: string;
-    resetMapNoResultsMessage: string;
-    apiKey?: string;
-    featuredPlaces?: Record<string, any>;
-    alertText?: string;
-    $props: {
-        readonly center?: Record<string, any>;
-        readonly noJsMessage?: string;
-        readonly noCookiesMessage?: string;
-        readonly zoom?: number;
-        readonly cookieBtnText?: string;
-        readonly radius?: number;
-        readonly labels?: Record<string, any>;
-        readonly mapId?: string;
-        readonly mapTypeVector?: boolean;
-        readonly languageCode?: string;
-        readonly categoriesLocation?: string;
-        readonly categoryLabels?: Record<string, any>;
-        readonly noResultsMessage?: string;
-        readonly resetMapNoResultsMessage?: string;
-        readonly apiKey?: string;
-        readonly featuredPlaces?: Record<string, any>;
-        readonly alertText?: string;
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
-export default _default;
+    featuredPlaces: Record<string, any>;
+    alertText: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/custom-components/maps/components/MapFeaturedLocation.vue.d.ts

@@ -1,7 +1,13 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    locationSelectLabel: string;
-    $props: {
-        readonly locationSelectLabel?: 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<{
+    locationSelectLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    locationSelectLabel: {
+        type: StringConstructor;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/custom-components/maps/components/MapFeaturedLocationItem.vue.d.ts

@@ -1,7 +1,15 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    place: Record<string, any>;
-    $props: {
-        readonly place?: Record<string, any>;
-    };
-}, {}, {}, {}, 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<{
+    place: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    place: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+}>> & Readonly<{}>, {
+    place: Record<string, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/custom-components/maps/components/MapFilter.vue.d.ts

@@ -8,7 +8,7 @@ type Props = {
     items: Item[];
     selectedCategory: string | string[] | undefined;
 };
-declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+declare const __VLS_export: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     changed: (args_0: {
         id: string;
         key: number | string;
@@ -22,4 +22,5 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     detailText: string;
     hasIcons: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
 export default _default;

package/dist/components/custom-components/maps/components/MapSidebar.vue.d.ts

@@ -46,15 +46,16 @@ type Props = {
     sidebarLabels: Record<string, string>;
 };
 type __VLS_Props = Props;
-type __VLS_PublicProps = __VLS_Props & {
+type __VLS_ModelProps = {
     'isOpen'?: boolean;
     'isResultsOpen'?: boolean;
 };
-declare var __VLS_50: {};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare var __VLS_58: {};
 type __VLS_Slots = {} & {
-    'vs-map-sidebar-search-results'?: (props: typeof __VLS_50) => any;
+    'vs-map-sidebar-search-results'?: (props: typeof __VLS_58) => any;
 };
-declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+declare const __VLS_base: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     "category-selected": (args_0: {
         id: string;
         key: number | string;
@@ -91,7 +92,8 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_PublicProps,
     query: string;
     selectedSubcategories: any;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {
     new (): {

package/dist/components/custom-components/maps/index.d.ts

@@ -1,10 +1,154 @@
 declare const _default: {
-    VsMainMap: import('vue').DefineComponent<{}, {
+    VsMainMap: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        apiKey: {
+            type: StringConstructor;
+            default: any;
+        };
+        mapId: {
+            type: StringConstructor;
+            default: string;
+        };
+        mapTypeVector: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        center: {
+            type: ObjectConstructor;
+            default: () => {
+                lat: number;
+                lng: number;
+            };
+        };
+        zoom: {
+            type: NumberConstructor;
+            default: number;
+        };
+        radius: {
+            type: NumberConstructor;
+            default: number;
+        };
+        labels: {
+            type: ObjectConstructor;
+            default: () => void;
+        };
+        languageCode: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+        categoriesLocation: {
+            type: StringConstructor;
+            default: string;
+        };
+        categoryLabels: {
+            type: ObjectConstructor;
+            default: () => void;
+        };
+        featuredPlaces: {
+            type: ObjectConstructor;
+            default: any;
+        };
+        noJsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        noCookiesMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        cookieBtnText: {
+            type: StringConstructor;
+            required: true;
+        };
+        noResultsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        resetMapNoResultsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        alertText: {
+            type: StringConstructor;
+            default: any;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        apiKey: {
+            type: StringConstructor;
+            default: any;
+        };
+        mapId: {
+            type: StringConstructor;
+            default: string;
+        };
+        mapTypeVector: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        center: {
+            type: ObjectConstructor;
+            default: () => {
+                lat: number;
+                lng: number;
+            };
+        };
+        zoom: {
+            type: NumberConstructor;
+            default: number;
+        };
+        radius: {
+            type: NumberConstructor;
+            default: number;
+        };
+        labels: {
+            type: ObjectConstructor;
+            default: () => void;
+        };
+        languageCode: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+        categoriesLocation: {
+            type: StringConstructor;
+            default: string;
+        };
+        categoryLabels: {
+            type: ObjectConstructor;
+            default: () => void;
+        };
+        featuredPlaces: {
+            type: ObjectConstructor;
+            default: any;
+        };
+        noJsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        noCookiesMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        cookieBtnText: {
+            type: StringConstructor;
+            required: true;
+        };
+        noResultsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        resetMapNoResultsMessage: {
+            type: StringConstructor;
+            required: true;
+        };
+        alertText: {
+            type: StringConstructor;
+            default: any;
+        };
+    }>> & Readonly<{}>, {
         center: Record<string, any>;
-        noJsMessage: string;
-        noCookiesMessage: string;
         zoom: number;
-        cookieBtnText: string;
+        apiKey: string;
         radius: number;
         labels: Record<string, any>;
         mapId: string;
@@ -12,31 +156,9 @@ declare const _default: {
         languageCode: string;
         categoriesLocation: string;
         categoryLabels: Record<string, any>;
-        noResultsMessage: string;
-        resetMapNoResultsMessage: string;
-        apiKey?: string;
-        featuredPlaces?: Record<string, any>;
-        alertText?: string;
-        $props: {
-            readonly center?: Record<string, any>;
-            readonly noJsMessage?: string;
-            readonly noCookiesMessage?: string;
-            readonly zoom?: number;
-            readonly cookieBtnText?: string;
-            readonly radius?: number;
-            readonly labels?: Record<string, any>;
-            readonly mapId?: string;
-            readonly mapTypeVector?: boolean;
-            readonly languageCode?: string;
-            readonly categoriesLocation?: string;
-            readonly categoryLabels?: Record<string, any>;
-            readonly noResultsMessage?: string;
-            readonly resetMapNoResultsMessage?: string;
-            readonly apiKey?: string;
-            readonly featuredPlaces?: Record<string, any>;
-            readonly alertText?: string;
-        };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+        featuredPlaces: Record<string, any>;
+        alertText: string;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
     VsMapSidebar: {
         new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
             categories: {
@@ -297,17 +419,29 @@ declare const _default: {
             'vs-map-sidebar-search-results'?: (props: {}) => any;
         };
     });
-    VsMapFeaturedLocation: import('vue').DefineComponent<{}, {
-        locationSelectLabel: string;
-        $props: {
-            readonly locationSelectLabel?: string;
+    VsMapFeaturedLocation: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        locationSelectLabel: {
+            type: StringConstructor;
+            required: true;
         };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
-    VsMapFeaturedLocationItem: import('vue').DefineComponent<{}, {
-        place: Record<string, any>;
-        $props: {
-            readonly place?: Record<string, any>;
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        locationSelectLabel: {
+            type: StringConstructor;
+            required: true;
+        };
+    }>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    VsMapFeaturedLocationItem: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        place: {
+            type: ObjectConstructor;
+            default: () => void;
         };
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        place: {
+            type: ObjectConstructor;
+            default: () => void;
+        };
+    }>> & Readonly<{}>, {
+        place: Record<string, any>;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 };
 export default _default;