@visitscotland/component-library 5.19.0 → 5.20.0

package/dist/components/src/custom-components/federated-search/composables/dataLayerComposable.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Vue Composable for Data Layer interactions (e.g., Google Tag Manager).
+ * Replaces the dataLayerMixin for custom components. This will be removed to a wrapper
+ * project along with the components.
+ */
+export default function dataLayerComposable(): {
+    pageUrl: import('vue').ComputedRef<string>;
+    createDataLayerObject: (type: string, event: any) => void;
+    templateFiller: (template: Array<string>, values: any) => any;
+    compileFullTemplate: (templateValues: any) => any;
+    returnIsoDate: () => string;
+    pushToDataLayer: (object: any) => void;
+    dataLayerStore: import('pinia').Store<"datalayer", Pick<{
+        pageUrl: import('vue').Ref<string, string>;
+        tagsTestRun: import('vue').Ref<boolean, boolean>;
+        GTMData: import('vue').Ref<object, object>;
+        getValueFromKey: (key: string) => any;
+        setTestRun: (payload: boolean) => void;
+        setPageUrl: (payload: string) => void;
+        processPayload: (payload: {
+            key: string;
+            value: string;
+        }) => void;
+    }, "pageUrl" | "tagsTestRun" | "GTMData">, Pick<{
+        pageUrl: import('vue').Ref<string, string>;
+        tagsTestRun: import('vue').Ref<boolean, boolean>;
+        GTMData: import('vue').Ref<object, object>;
+        getValueFromKey: (key: string) => any;
+        setTestRun: (payload: boolean) => void;
+        setPageUrl: (payload: string) => void;
+        processPayload: (payload: {
+            key: string;
+            value: string;
+        }) => void;
+    }, never>, Pick<{
+        pageUrl: import('vue').Ref<string, string>;
+        tagsTestRun: import('vue').Ref<boolean, boolean>;
+        GTMData: import('vue').Ref<object, object>;
+        getValueFromKey: (key: string) => any;
+        setTestRun: (payload: boolean) => void;
+        setPageUrl: (payload: string) => void;
+        processPayload: (payload: {
+            key: string;
+            value: string;
+        }) => void;
+    }, "getValueFromKey" | "setTestRun" | "setPageUrl" | "processPayload">>;
+};

package/dist/components/src/{stores → custom-components/federated-search/stores}/federatedSearch.store.d.ts

@@ -1,4 +1,4 @@
-import { CludoCredentials } from '../types/types';
+import { CludoCredentials } from '../../../types/types';
 
 declare const useFederatedSearchStore: import('pinia').StoreDefinition<"federatedSearch", Pick<{
     filters: import('vue').Ref<any, any>;
@@ -28,13 +28,15 @@ declare const useFederatedSearchStore: import('pinia').StoreDefinition<"federate
     totalResults: import('vue').Ref<any, any>;
     totalResultsCludo: import('vue').Ref<any, any>;
     totalResultsEvents: import('vue').Ref<any, any>;
-    navigateToResultsPage: (resetPageNo?: boolean) => void;
+    navigateToResultsPage: (resetPageNo?: boolean, fromAutosuggest?: boolean) => void;
     isHomePage: import('vue').Ref<boolean, boolean>;
     startDate: import('vue').Ref<string, string>;
     endDate: import('vue').Ref<string, string>;
     sortBy: import('vue').Ref<any, any>;
     siteLanguage: import('vue').Ref<any, any>;
-}, "filters" | "currentPage" | "isHomePage" | "selectedSubCategory" | "isLoading" | "selectedCategory" | "searchTerm" | "endDate" | "startDate" | "cludoCredentials" | "cludoError" | "eventsApi" | "eventsApiError" | "results" | "searchUrl" | "selectedCategoryKey" | "selectedSubCategoryKey" | "totalResults" | "totalResultsCludo" | "totalResultsEvents" | "sortBy" | "siteLanguage">, Pick<{
+    searchInSessionCount: import('vue').Ref<number, number>;
+    queryInput: import('vue').Ref<string, string>;
+}, "filters" | "currentPage" | "isHomePage" | "selectedSubCategory" | "isLoading" | "selectedCategory" | "searchTerm" | "endDate" | "startDate" | "cludoCredentials" | "cludoError" | "eventsApi" | "eventsApiError" | "results" | "searchUrl" | "selectedCategoryKey" | "selectedSubCategoryKey" | "totalResults" | "totalResultsCludo" | "totalResultsEvents" | "sortBy" | "siteLanguage" | "searchInSessionCount" | "queryInput">, Pick<{
     filters: import('vue').Ref<any, any>;
     currentPage: import('vue').Ref<number, number>;
     cludoCredentials: import('vue').Ref<{
@@ -62,12 +64,14 @@ declare const useFederatedSearchStore: import('pinia').StoreDefinition<"federate
     totalResults: import('vue').Ref<any, any>;
     totalResultsCludo: import('vue').Ref<any, any>;
     totalResultsEvents: import('vue').Ref<any, any>;
-    navigateToResultsPage: (resetPageNo?: boolean) => void;
+    navigateToResultsPage: (resetPageNo?: boolean, fromAutosuggest?: boolean) => void;
     isHomePage: import('vue').Ref<boolean, boolean>;
     startDate: import('vue').Ref<string, string>;
     endDate: import('vue').Ref<string, string>;
     sortBy: import('vue').Ref<any, any>;
     siteLanguage: import('vue').Ref<any, any>;
+    searchInSessionCount: import('vue').Ref<number, number>;
+    queryInput: import('vue').Ref<string, string>;
 }, never>, Pick<{
     filters: import('vue').Ref<any, any>;
     currentPage: import('vue').Ref<number, number>;
@@ -96,11 +100,13 @@ declare const useFederatedSearchStore: import('pinia').StoreDefinition<"federate
     totalResults: import('vue').Ref<any, any>;
     totalResultsCludo: import('vue').Ref<any, any>;
     totalResultsEvents: import('vue').Ref<any, any>;
-    navigateToResultsPage: (resetPageNo?: boolean) => void;
+    navigateToResultsPage: (resetPageNo?: boolean, fromAutosuggest?: boolean) => void;
     isHomePage: import('vue').Ref<boolean, boolean>;
     startDate: import('vue').Ref<string, string>;
     endDate: import('vue').Ref<string, string>;
     sortBy: import('vue').Ref<any, any>;
     siteLanguage: import('vue').Ref<any, any>;
+    searchInSessionCount: import('vue').Ref<number, number>;
+    queryInput: import('vue').Ref<string, string>;
 }, "getAutoComplete" | "getSearchResults" | "navigateToResultsPage">>;
 export default useFederatedSearchStore;

package/dist/components/src/{utils/federated-search → custom-components/federated-search/utils}/cludo-autocomplete.d.ts

@@ -1,4 +1,4 @@
-import { CludoCredentials } from '../../types/types';
+import { CludoCredentials } from '../../../types/types';
 
 declare function cludoAutocomplete(searchQuery: string, cludoCredentials: CludoCredentials): Promise<any>;
 export default cludoAutocomplete;

package/dist/components/src/{utils/federated-search → custom-components/federated-search/utils}/cludo-search.d.ts

@@ -1,4 +1,4 @@
-import { CludoCredentials, FederatedSearchResult } from '../../types/types';
+import { CludoCredentials, FederatedSearchResult } from '../../../types/types';
 
 declare function cludoSearch(searchTerm: string, cludoCredentials: CludoCredentials, page: number, selectedCategory: string, selectedCategoryKey: string): Promise<{
     results: FederatedSearchResult[];

package/dist/components/src/{utils/federated-search → custom-components/federated-search/utils}/event-search.d.ts

@@ -1,4 +1,4 @@
-import { FederatedSearchResult } from '../../types/types';
+import { FederatedSearchResult } from '../../../types/types';
 
 declare function eventSearch(api: string, searchTerm: string, page: number, selectedCategoryKey: string, selectedSubCategoryKey: string[], startDate: string, endDate: string, sortBy: string, siteLanguage: string): Promise<{
     results: FederatedSearchResult[];

package/dist/components/src/utils/data-layer-templates.d.ts

@@ -18,3 +18,7 @@ export const productSearchTemplate: string[];
 export const cmsReferralTemplate: string[];
 export const accordionOpenTemplate: string[];
 export const tabClickTemplate: string[];
+export const siteSearchOpenTemplate: string[];
+export const siteSearchUsageTemplate: string[];
+export const siteSearchClickTemplate: string[];
+export const siteSearchCloseTemplate: string[];