fix(atomic): add explicit types for different types of store

packages/atomic/src/components.d.ts

@@ -13,6 +13,7 @@ import { ResultRenderingFunction } from "./components/search/result-lists/result
 import { Section } from "./components/search/atomic-layout-section/sections";
 import { RecommendationEngine } from "@coveo/headless/recommendation";
 import { i18n } from "i18next";
+import { AtomicStore } from "./components/search/atomic-search-interface/store";
 import { InitializationOptions } from "./components/search/atomic-search-interface/atomic-search-interface";
 import { StandaloneSearchBoxData } from "./utils/local-storage-utils";
 import { InsightEngine } from "@coveo/headless/insight";
@@ -656,7 +657,7 @@ export namespace Components {
         /**
           * Global state for Atomic.
          */
-        "store"?: ReturnType<typeof createAtomicStore>;
+        "store"?: AtomicStore;
     }
     interface AtomicResultBadge {
         /**
@@ -2479,7 +2480,7 @@ declare namespace LocalJSX {
         /**
           * Global state for Atomic.
          */
-        "store"?: ReturnType<typeof createAtomicStore>;
+        "store"?: AtomicStore;
     }
     interface AtomicResultBadge {
         /**

packages/atomic/src/components/common/interface/store.ts

@@ -6,9 +6,19 @@ export type AtomicCommonStoreData = {
   iconAssetsPath: string;
 };
 
+export interface AtomicCommonStore<StoreData extends AtomicCommonStoreData>
+  extends CommonStencilStore<StoreData> {
+  setLoadingFlag(flag: string): void;
+  unsetLoadingFlag(loadingFlag: string): void;
+  hasLoadingFlag(loadingFlag: string): boolean;
+  waitUntilAppLoaded(callback: () => void): void;
+  isAppLoaded(): boolean;
+  getUniqueIDFromEngine(engine: AnyEngineType): string;
+}
+
 export function createAtomicCommonStore<
   StoreData extends AtomicCommonStoreData
->(initialStoreData: StoreData) {
+>(initialStoreData: StoreData): AtomicCommonStore<StoreData> {
   const stencilStore = createStore(
     initialStoreData
   ) as CommonStencilStore<StoreData>;

packages/atomic/src/components/insight/atomic-insight-interface/atomic-insight-interface.tsx

@@ -21,14 +21,14 @@ import {
   BaseAtomicInterface,
   CommonAtomicInterfaceHelper,
 } from '../../common/interface/interface-common';
-import {createAtomicSvcInsightStore} from './store';
+import {AtomicSvcInsightStore, createAtomicSvcInsightStore} from './store';
 import {getAnalyticsConfig} from './analytics-config';
 
 const FirstInsightRequestExecutedFlag = 'firstInsightRequestExecuted';
 export type InitializationOptions = InsightEngineConfiguration;
 export type Bindings = CommonBindings<
   InsightEngine,
-  ReturnType<typeof createAtomicSvcInsightStore>,
+  AtomicSvcInsightStore,
   HTMLAtomicSvcInsightInterfaceElement
 >;
 

packages/atomic/src/components/insight/atomic-insight-interface/store.ts

@@ -1,13 +1,17 @@
 import {InsightEngine} from '@coveo/headless/insight';
 import {
+  AtomicCommonStore,
   AtomicCommonStoreData,
   createAtomicCommonStore,
 } from '../../common/interface/store';
 
-export interface AtomicSvgInsightStoreData extends AtomicCommonStoreData {}
+export interface AtomicSvcInsightStoreData extends AtomicCommonStoreData {}
 
-export function createAtomicSvcInsightStore() {
-  const commonStore = createAtomicCommonStore<AtomicSvgInsightStoreData>({
+export interface AtomicSvcInsightStore
+  extends AtomicCommonStore<AtomicSvcInsightStoreData> {}
+
+export function createAtomicSvcInsightStore(): AtomicSvcInsightStore {
+  const commonStore = createAtomicCommonStore<AtomicSvcInsightStoreData>({
     loadingFlags: [],
     iconAssetsPath: '',
   });

packages/atomic/src/components/recommendations/atomic-recs-interface/atomic-recs-interface.tsx

@@ -16,12 +16,12 @@ import {
   BaseAtomicInterface,
   CommonAtomicInterfaceHelper,
 } from '../../common/interface/interface-common';
-import {createAtomicRecsStore} from './store';
+import {createAtomicRecsStore, AtomicRecsStore} from './store';
 
 const FirstRecommendationExecutedFlag = 'firstRecommendationExecuted';
 export type Bindings = CommonBindings<
   RecommendationEngine,
-  ReturnType<typeof createAtomicRecsStore>,
+  AtomicRecsStore,
   HTMLAtomicRecsInterfaceElement
 >;
 

packages/atomic/src/components/recommendations/atomic-recs-interface/store.ts

@@ -1,12 +1,15 @@
 import {RecommendationEngine} from '@coveo/headless/recommendation';
 import {
+  AtomicCommonStore,
   AtomicCommonStoreData,
   createAtomicCommonStore,
 } from '../../common/interface/store';
 
 export interface AtomicRecsStoreData extends AtomicCommonStoreData {}
+export interface AtomicRecsStore
+  extends AtomicCommonStore<AtomicRecsStoreData> {}
 
-export function createAtomicRecsStore() {
+export function createAtomicRecsStore(): AtomicRecsStore {
   const commonStore = createAtomicCommonStore<AtomicRecsStoreData>({
     loadingFlags: [],
     iconAssetsPath: '',

packages/atomic/src/components/search/atomic-result/atomic-result.tsx

@@ -12,7 +12,7 @@ import {
   ResultContextEvent,
 } from '../result-template-components/result-template-decorators';
 import {ResultRenderingFunction} from '../result-lists/result-list-common';
-import {createAtomicStore} from '../atomic-search-interface/store';
+import {AtomicStore} from '../atomic-search-interface/store';
 
 const resultSectionTags = [
   'atomic-result-section-visual',
@@ -55,7 +55,7 @@ export class AtomicResult {
    * Global state for Atomic.
    * @internal
    */
-  @Prop() store?: ReturnType<typeof createAtomicStore>;
+  @Prop() store?: AtomicStore;
 
   /**
    * The result content to display.