@coveo/headless-react 2.4.29 → 2.4.30-pre.1c8addde3a

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/ssr/common.d.ts +12 -0
  2. package/dist/ssr/common.js +15 -1
  3. package/dist/ssr/common.js.map +1 -1
  4. package/dist/ssr/search-engine.js +8 -1
  5. package/dist/ssr/search-engine.js.map +1 -1
  6. package/dist/ssr/types.d.ts +10 -0
  7. package/dist/ssr-commerce/commerce-engine.js +5 -1
  8. package/dist/ssr-commerce/commerce-engine.js.map +1 -1
  9. package/dist/ssr-commerce/common.d.ts +12 -0
  10. package/dist/ssr-commerce/common.js +15 -1
  11. package/dist/ssr-commerce/common.js.map +1 -1
  12. package/dist/ssr-commerce/providers.js +1 -5
  13. package/dist/ssr-commerce/providers.js.map +1 -1
  14. package/dist/ssr-commerce/types.d.ts +15 -1
  15. package/package.json +4 -4
package/dist/ssr/common.d.ts CHANGED
@@ -4,10 +4,22 @@ import { SingletonGetter } from '../utils.js';
4
4
  import { ContextState, InferControllerHooksMapFromDefinition } from './types.js';
5
5
  export declare function buildControllerHooks<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>>(singletonContext: SingletonGetter<Context<ContextState<TEngine, TControllers> | null>>, controllersMap?: TControllers): InferControllerHooksMapFromDefinition<TControllers>;
6
6
  export declare function buildEngineHook<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>>(singletonContext: SingletonGetter<Context<ContextState<TEngine, TControllers> | null>>): () => TEngine | undefined;
7
+ /**
8
+ * @deprecated use `buildStateProvider` instead.
9
+ * It is isomorphic and can be used for both static and hydrated state.
10
+ */
7
11
  export declare function buildStaticStateProvider<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>>(singletonContext: SingletonGetter<Context<ContextState<TEngine, TControllers> | null>>): ({ controllers, children, }: PropsWithChildren<{
8
12
  controllers: InferControllerStaticStateMapFromDefinitions<TControllers>;
9
13
  }>) => import("react/jsx-runtime").JSX.Element;
14
+ /**
15
+ * @deprecated use `buildStateProvider` instead.
16
+ * It is isomorphic and can be used for both static and hydrated state.
17
+ */
10
18
  export declare function buildHydratedStateProvider<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>>(singletonContext: SingletonGetter<Context<ContextState<TEngine, TControllers> | null>>): ({ engine, controllers, children, }: PropsWithChildren<{
11
19
  engine: TEngine;
12
20
  controllers: InferControllersMapFromDefinition<TControllers>;
13
21
  }>) => import("react/jsx-runtime").JSX.Element;
22
+ export declare function buildStateProvider<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>>(singletonContext: SingletonGetter<Context<ContextState<TEngine, TControllers> | null>>): ({ engine, controllers, children, }: PropsWithChildren<{
23
+ engine?: TEngine;
24
+ controllers: InferControllersMapFromDefinition<TControllers> | InferControllerStaticStateMapFromDefinitions<TControllers>;
25
+ }>) => import("react/jsx-runtime").JSX.Element;
package/dist/ssr/common.js CHANGED
@@ -4,7 +4,7 @@ import { useSyncMemoizedStore } from '../client-utils.js';
4
4
  import { MissingEngineProviderError } from '../errors.js';
5
5
  import { capitalize, mapObject } from '../utils.js';
6
6
  function isHydratedStateContext(ctx) {
7
- return 'engine' in ctx;
7
+ return 'engine' in ctx && !!ctx.engine;
8
8
  }
9
9
  function buildControllerHook(singletonContext, key) {
10
10
  return () => {
@@ -45,16 +45,30 @@ export function buildEngineHook(singletonContext) {
45
45
  return isHydratedStateContext(ctx) ? ctx.engine : undefined;
46
46
  };
47
47
  }
48
+ /**
49
+ * @deprecated use `buildStateProvider` instead.
50
+ * It is isomorphic and can be used for both static and hydrated state.
51
+ */
48
52
  export function buildStaticStateProvider(singletonContext) {
49
53
  return ({ controllers, children, }) => {
50
54
  const { Provider } = singletonContext.get();
51
55
  return _jsx(Provider, { value: { controllers }, children: children });
52
56
  };
53
57
  }
58
+ /**
59
+ * @deprecated use `buildStateProvider` instead.
60
+ * It is isomorphic and can be used for both static and hydrated state.
61
+ */
54
62
  export function buildHydratedStateProvider(singletonContext) {
55
63
  return ({ engine, controllers, children, }) => {
56
64
  const { Provider } = singletonContext.get();
57
65
  return _jsx(Provider, { value: { engine, controllers }, children: children });
58
66
  };
59
67
  }
68
+ export function buildStateProvider(singletonContext) {
69
+ return ({ engine, controllers, children, }) => {
70
+ const { Provider } = singletonContext.get();
71
+ return _jsx(Provider, { value: { engine, controllers }, children: children });
72
+ };
73
+ }
60
74
  //# sourceMappingURL=common.js.map
package/dist/ssr/common.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/ssr/common.tsx"],"names":[],"mappings":";AAQA,OAAO,EACL,UAAU,EACV,WAAW,EACX,OAAO,GAGR,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAC,0BAA0B,EAAC,MAAM,cAAc,CAAC;AACxD,OAAO,EAAkB,UAAU,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAQnE,SAAS,sBAAsB,CAI7B,GAAwC;IAExC,OAAO,QAAQ,IAAI,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,mBAAmB,CAK1B,gBAEC,EACD,GAAS;IAET,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,QAAoB,EAAE,EAAE,CACvB,sBAAsB,CAAC,GAAG,CAAC;YACzB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC1C,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,EACd,CAAC,GAAG,CAAC,CACN,CAAC;QACF,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,EAAC,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,EAAC,GAAG,UAAU,CAAC;YAC3D,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CACd,CAAC;QACtD,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACV,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAIlC,gBAEC,EACD,cAA6B;IAE7B,OAAO,CACL,cAAc;QACZ,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;YACvC,MAAM,UAAU,CAAC,GAAG,CAAC,EAAE;YACvB,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC3C,CAAC,CACH;QACH,CAAC,CAAC,EAAE,CACgD,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,eAAe,CAI7B,gBAEC;IAED,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAItC,gBAEC;IAED,OAAO,CAAC,EACN,WAAW,EACX,QAAQ,GAGR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,WAAW,EAAC,YAAG,QAAQ,GAAY,CAAC;IAC/D,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAIxC,gBAEC;IAED,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GAIR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,YAAG,QAAQ,GAAY,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/ssr/common.tsx"],"names":[],"mappings":";AAQA,OAAO,EACL,UAAU,EACV,WAAW,EACX,OAAO,GAGR,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAC,0BAA0B,EAAC,MAAM,cAAc,CAAC;AACxD,OAAO,EAAkB,UAAU,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAQnE,SAAS,sBAAsB,CAI7B,GAAwC;IAExC,OAAO,QAAQ,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;AACzC,CAAC;AAED,SAAS,mBAAmB,CAK1B,gBAEC,EACD,GAAS;IAET,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,QAAoB,EAAE,EAAE,CACvB,sBAAsB,CAAC,GAAG,CAAC;YACzB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC1C,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,EACd,CAAC,GAAG,CAAC,CACN,CAAC;QACF,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACxC,MAAM,EAAC,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,EAAC,GAAG,UAAU,CAAC;YAC3D,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CACd,CAAC;QACtD,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACV,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAIlC,gBAEC,EACD,cAA6B;IAE7B,OAAO,CACL,cAAc;QACZ,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;YACvC,MAAM,UAAU,CAAC,GAAG,CAAC,EAAE;YACvB,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC3C,CAAC,CACH;QACH,CAAC,CAAC,EAAE,CACgD,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,eAAe,CAI7B,gBAEC;IAED,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAItC,gBAEC;IAED,OAAO,CAAC,EACN,WAAW,EACX,QAAQ,GAGR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,WAAW,EAAC,YAAG,QAAQ,GAAY,CAAC;IAC/D,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAIxC,gBAEC;IAED,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GAIR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,YAAG,QAAQ,GAAY,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAIhC,gBAEC;IAED,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GAMR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAC,YAAG,QAAQ,GAAY,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC"}
package/dist/ssr/search-engine.js CHANGED
@@ -2,7 +2,7 @@ import { defineSearchEngine as defineBaseSearchEngine, } from '@coveo/headless/s
2
2
  // Workaround to prevent Next.js erroring about importing CSR only hooks
3
3
  import React from 'react';
4
4
  import { singleton } from '../utils.js';
5
- import { buildControllerHooks, buildEngineHook, buildHydratedStateProvider, buildStaticStateProvider, } from './common.js';
5
+ import { buildControllerHooks, buildEngineHook, buildHydratedStateProvider, buildStateProvider, buildStaticStateProvider, } from './common.js';
6
6
  // Wrapper to workaround the limitation that `createContext()` cannot be called directly during SSR in next.js
7
7
  export function createSingletonContext() {
8
8
  return singleton(() => React.createContext(null));
@@ -17,8 +17,15 @@ export function defineSearchEngine(options) {
17
17
  ...defineBaseSearchEngine({ ...options }),
18
18
  useEngine: buildEngineHook(singletonContext),
19
19
  controllers: buildControllerHooks(singletonContext, options.controllers),
20
+ /**
21
+ * @deprecated Use `StateProvider` instead.
22
+ */
20
23
  StaticStateProvider: buildStaticStateProvider(singletonContext),
24
+ /**
25
+ * @deprecated Use `StateProvider` instead.
26
+ */
21
27
  HydratedStateProvider: buildHydratedStateProvider(singletonContext),
28
+ StateProvider: buildStateProvider(singletonContext),
22
29
  };
23
30
  }
24
31
  //# sourceMappingURL=search-engine.js.map
package/dist/ssr/search-engine.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"search-engine.js","sourceRoot":"","sources":["../../src/ssr/search-engine.tsx"],"names":[],"mappings":"AAAA,OAAO,EAKL,kBAAkB,IAAI,sBAAsB,GAE7C,MAAM,qBAAqB,CAAC;AAC7B,wEAAwE;AACxE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAOrB,8GAA8G;AAC9G,MAAM,UAAU,sBAAsB;IAGpC,OAAO,SAAS,CAAC,GAAG,EAAE,CACpB,KAAK,CAAC,aAAa,CAAkD,IAAI,CAAC,CAC3E,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAGhC,OAAoD;IAEpD,MAAM,gBAAgB,GAAG,sBAAsB,EAAgB,CAAC;IAChE,OAAO;QACL,GAAG,sBAAsB,CAAC,EAAC,GAAG,OAAO,EAAC,CAAC;QACvC,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC;QAC5C,WAAW,EAAE,oBAAoB,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC;QACxE,mBAAmB,EAAE,wBAAwB,CAAC,gBAAgB,CAAC;QAC/D,qBAAqB,EAAE,0BAA0B,CAAC,gBAAgB,CAAC;KACpE,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"search-engine.js","sourceRoot":"","sources":["../../src/ssr/search-engine.tsx"],"names":[],"mappings":"AAAA,OAAO,EAKL,kBAAkB,IAAI,sBAAsB,GAE7C,MAAM,qBAAqB,CAAC;AAC7B,wEAAwE;AACxE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAOrB,8GAA8G;AAC9G,MAAM,UAAU,sBAAsB;IAGpC,OAAO,SAAS,CAAC,GAAG,EAAE,CACpB,KAAK,CAAC,aAAa,CAAkD,IAAI,CAAC,CAC3E,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAGhC,OAAoD;IAEpD,MAAM,gBAAgB,GAAG,sBAAsB,EAAgB,CAAC;IAChE,OAAO;QACL,GAAG,sBAAsB,CAAC,EAAC,GAAG,OAAO,EAAC,CAAC;QACvC,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC;QAC5C,WAAW,EAAE,oBAAoB,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC;QACxE;;WAEG;QACH,mBAAmB,EAAE,wBAAwB,CAAC,gBAAgB,CAAC;QAC/D;;WAEG;QACH,qBAAqB,EAAE,0BAA0B,CAAC,gBAAgB,CAAC;QACnE,aAAa,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;KACpD,CAAC;AACJ,CAAC"}
package/dist/ssr/types.d.ts CHANGED
@@ -18,11 +18,21 @@ export type InferControllerHooksMapFromDefinition<TControllers extends Controlle
18
18
  export type ReactEngineDefinition<TEngine extends CoreEngine, TControllers extends ControllerDefinitionsMap<TEngine, Controller>, TEngineOptions> = EngineDefinition<TEngine, TControllers, TEngineOptions> & {
19
19
  controllers: InferControllerHooksMapFromDefinition<TControllers>;
20
20
  useEngine(): TEngine | undefined;
21
+ /**
22
+ * @deprecated Use `StateProvider` instead.
23
+ */
21
24
  StaticStateProvider: FunctionComponent<PropsWithChildren<{
22
25
  controllers: InferControllerStaticStateMapFromDefinitions<TControllers>;
23
26
  }>>;
27
+ /**
28
+ * @deprecated Use `StateProvider` instead.
29
+ */
24
30
  HydratedStateProvider: FunctionComponent<PropsWithChildren<{
25
31
  engine: TEngine;
26
32
  controllers: InferControllersMapFromDefinition<TControllers>;
27
33
  }>>;
34
+ StateProvider: FunctionComponent<PropsWithChildren<{
35
+ engine?: TEngine;
36
+ controllers: InferControllersMapFromDefinition<TControllers> | InferControllerStaticStateMapFromDefinitions<TControllers>;
37
+ }>>;
28
38
  };
package/dist/ssr-commerce/commerce-engine.js CHANGED
@@ -2,7 +2,7 @@ import { defineCommerceEngine as defineBaseCommerceEngine, SolutionType, } from
2
2
  // Workaround to prevent Next.js erroring about importing CSR only hooks
3
3
  import React from 'react';
4
4
  import { singleton } from '../utils.js';
5
- import { buildControllerHooks, buildEngineHook, buildHydratedStateProvider, buildStaticStateProvider, } from './common.js';
5
+ import { buildControllerHooks, buildEngineHook, buildHydratedStateProvider, buildStateProvider, buildStaticStateProvider, } from './common.js';
6
6
  // Wrapper to workaround the limitation that `createContext()` cannot be called directly during SSR in next.js
7
7
  export function createSingletonContext() {
8
8
  return singleton(() => React.createContext(null));
@@ -24,21 +24,25 @@ export function defineCommerceEngine(options) {
24
24
  ...listingEngineDefinition,
25
25
  StaticStateProvider: buildStaticStateProvider(singletonContext, SolutionType.listing),
26
26
  HydratedStateProvider: buildHydratedStateProvider(singletonContext, SolutionType.listing),
27
+ StateProvider: buildStateProvider(singletonContext, SolutionType.listing),
27
28
  },
28
29
  searchEngineDefinition: {
29
30
  ...searchEngineDefinition,
30
31
  StaticStateProvider: buildStaticStateProvider(singletonContext, SolutionType.search),
31
32
  HydratedStateProvider: buildHydratedStateProvider(singletonContext, SolutionType.search),
33
+ StateProvider: buildStateProvider(singletonContext, SolutionType.search),
32
34
  },
33
35
  standaloneEngineDefinition: {
34
36
  ...standaloneEngineDefinition,
35
37
  StaticStateProvider: buildStaticStateProvider(singletonContext, SolutionType.standalone),
36
38
  HydratedStateProvider: buildHydratedStateProvider(singletonContext, SolutionType.standalone),
39
+ StateProvider: buildStateProvider(singletonContext, SolutionType.standalone),
37
40
  },
38
41
  recommendationEngineDefinition: {
39
42
  ...recommendationEngineDefinition,
40
43
  StaticStateProvider: buildStaticStateProvider(singletonContext, SolutionType.recommendation),
41
44
  HydratedStateProvider: buildHydratedStateProvider(singletonContext, SolutionType.recommendation),
45
+ StateProvider: buildStateProvider(singletonContext, SolutionType.recommendation),
42
46
  },
43
47
  };
44
48
  }
package/dist/ssr-commerce/commerce-engine.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"commerce-engine.js","sourceRoot":"","sources":["../../src/ssr-commerce/commerce-engine.tsx"],"names":[],"mappings":"AAAA,OAAO,EAIL,oBAAoB,IAAI,wBAAwB,EAEhD,YAAY,GAEb,MAAM,8BAA8B,CAAC;AACtC,wEAAwE;AACxE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,SAAS,EAAkB,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAiBrB,8GAA8G;AAC9G,MAAM,UAAU,sBAAsB;IAIpC,OAAO,SAAS,CAAC,GAAG,EAAE,CACpB,KAAK,CAAC,aAAa,CAAmD,IAAI,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAGlC,OAAsD;IAqBtD,MAAM,gBAAgB,GAAG,sBAAsB,EAAgB,CAAC;IAUhE,MAAM,EACJ,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,8BAA8B,GAC/B,GAAG,wBAAwB,CAAC,EAAC,GAAG,OAAO,EAAC,CAAC,CAAC;IAC3C,OAAO;QACL,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC;QAC5C,WAAW,EAAE,oBAAoB,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC;QACxE,uBAAuB,EAAE;YACvB,GAAG,uBAAuB;YAC1B,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAkC,EAClC,YAAY,CAAC,OAAO,CACrB;YAED,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAkC,EAClC,YAAY,CAAC,OAAO,CACrB;SACF;QACD,sBAAsB,EAAE;YACtB,GAAG,sBAAsB;YACzB,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAiC,EACjC,YAAY,CAAC,MAAM,CACpB;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAiC,EACjC,YAAY,CAAC,MAAM,CACpB;SACF;QACD,0BAA0B,EAAE;YAC1B,GAAG,0BAA0B;YAC7B,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAqC,EACrC,YAAY,CAAC,UAAU,CACxB;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAqC,EACrC,YAAY,CAAC,UAAU,CACxB;SACF;QACD,8BAA8B,EAAE;YAC9B,GAAG,8BAA8B;YACjC,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAyC,EACzC,YAAY,CAAC,cAAc,CAC5B;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAyC,EACzC,YAAY,CAAC,cAAc,CAC5B;SACF;KACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"commerce-engine.js","sourceRoot":"","sources":["../../src/ssr-commerce/commerce-engine.tsx"],"names":[],"mappings":"AAAA,OAAO,EAIL,oBAAoB,IAAI,wBAAwB,EAEhD,YAAY,GAEb,MAAM,8BAA8B,CAAC;AACtC,wEAAwE;AACxE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,SAAS,EAAkB,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AAiBrB,8GAA8G;AAC9G,MAAM,UAAU,sBAAsB;IAIpC,OAAO,SAAS,CAAC,GAAG,EAAE,CACpB,KAAK,CAAC,aAAa,CAAmD,IAAI,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAGlC,OAAsD;IAqBtD,MAAM,gBAAgB,GAAG,sBAAsB,EAAgB,CAAC;IAUhE,MAAM,EACJ,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,8BAA8B,GAC/B,GAAG,wBAAwB,CAAC,EAAC,GAAG,OAAO,EAAC,CAAC,CAAC;IAC3C,OAAO;QACL,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC;QAC5C,WAAW,EAAE,oBAAoB,CAAC,gBAAgB,EAAE,OAAO,CAAC,WAAW,CAAC;QACxE,uBAAuB,EAAE;YACvB,GAAG,uBAAuB;YAC1B,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAkC,EAClC,YAAY,CAAC,OAAO,CACrB;YAED,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAkC,EAClC,YAAY,CAAC,OAAO,CACrB;YAED,aAAa,EAAE,kBAAkB,CAC/B,gBAAkC,EAClC,YAAY,CAAC,OAAO,CACrB;SACF;QACD,sBAAsB,EAAE;YACtB,GAAG,sBAAsB;YACzB,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAiC,EACjC,YAAY,CAAC,MAAM,CACpB;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAiC,EACjC,YAAY,CAAC,MAAM,CACpB;YACD,aAAa,EAAE,kBAAkB,CAC/B,gBAAiC,EACjC,YAAY,CAAC,MAAM,CACpB;SACF;QACD,0BAA0B,EAAE;YAC1B,GAAG,0BAA0B;YAC7B,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAqC,EACrC,YAAY,CAAC,UAAU,CACxB;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAqC,EACrC,YAAY,CAAC,UAAU,CACxB;YACD,aAAa,EAAE,kBAAkB,CAC/B,gBAAqC,EACrC,YAAY,CAAC,UAAU,CACxB;SACF;QACD,8BAA8B,EAAE;YAC9B,GAAG,8BAA8B;YACjC,mBAAmB,EAAE,wBAAwB,CAC3C,gBAAyC,EACzC,YAAY,CAAC,cAAc,CAC5B;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,gBAAyC,EACzC,YAAY,CAAC,cAAc,CAC5B;YACD,aAAa,EAAE,kBAAkB,CAC/B,gBAAyC,EACzC,YAAY,CAAC,cAAc,CAC5B;SACF;KACF,CAAC;AACJ,CAAC"}
package/dist/ssr-commerce/common.d.ts CHANGED
@@ -4,10 +4,22 @@ import { SingletonGetter } from '../utils.js';
4
4
  import { ContextState, InferControllerHooksMapFromDefinition } from './types.js';
5
5
  export declare function buildControllerHooks<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(singletonContext: SingletonGetter<Context<ContextState<TControllers, TSolutionType> | null>>, controllersMap?: TControllers): InferControllerHooksMapFromDefinition<TControllers>;
6
6
  export declare function buildEngineHook<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(singletonContext: SingletonGetter<Context<ContextState<TControllers, TSolutionType> | null>>): () => SSRCommerceEngine | undefined;
7
+ /**
8
+ * @deprecated use `buildStateProvider` instead.
9
+ * It is isomorphic and can be used for both static and hydrated state.
10
+ */
7
11
  export declare function buildStaticStateProvider<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(singletonContext: SingletonGetter<Context<ContextState<TControllers, TSolutionType> | null>>, solutionType: TSolutionType): ({ controllers, children, }: PropsWithChildren<{
8
12
  controllers: InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>;
9
13
  }>) => import("react/jsx-runtime").JSX.Element;
14
+ /**
15
+ * @deprecated use `buildStateProvider` instead.
16
+ * It is isomorphic and can be used for both static and hydrated state.
17
+ */
10
18
  export declare function buildHydratedStateProvider<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(singletonContext: SingletonGetter<Context<ContextState<TControllers, TSolutionType> | null>>, solutionType: TSolutionType): ({ engine, controllers, children, }: PropsWithChildren<{
11
19
  engine: SSRCommerceEngine;
12
20
  controllers: InferControllersMapFromDefinition<TControllers, TSolutionType>;
13
21
  }>) => import("react/jsx-runtime").JSX.Element;
22
+ export declare function buildStateProvider<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(singletonContext: SingletonGetter<Context<ContextState<TControllers, TSolutionType> | null>>, solutionType: TSolutionType): ({ engine, controllers, children, }: PropsWithChildren<{
23
+ engine?: SSRCommerceEngine;
24
+ controllers: InferControllersMapFromDefinition<TControllers, TSolutionType> | InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>;
25
+ }>) => import("react/jsx-runtime").JSX.Element;
package/dist/ssr-commerce/common.js CHANGED
@@ -5,7 +5,7 @@ import { useSyncMemoizedStore } from '../client-utils.js';
5
5
  import { MissingEngineProviderError, UndefinedControllerError, } from '../errors.js';
6
6
  import { capitalize, mapObject } from '../utils.js';
7
7
  function isHydratedStateContext(ctx) {
8
- return 'engine' in ctx;
8
+ return 'engine' in ctx && !!ctx.engine;
9
9
  }
10
10
  function buildControllerHook(singletonContext, key, controllerDefinition) {
11
11
  return () => {
@@ -51,16 +51,30 @@ export function buildEngineHook(singletonContext) {
51
51
  return isHydratedStateContext(ctx) ? ctx.engine : undefined;
52
52
  };
53
53
  }
54
+ /**
55
+ * @deprecated use `buildStateProvider` instead.
56
+ * It is isomorphic and can be used for both static and hydrated state.
57
+ */
54
58
  export function buildStaticStateProvider(singletonContext, solutionType) {
55
59
  return ({ controllers, children, }) => {
56
60
  const { Provider } = singletonContext.get();
57
61
  return _jsx(Provider, { value: { controllers, solutionType }, children: children });
58
62
  };
59
63
  }
64
+ /**
65
+ * @deprecated use `buildStateProvider` instead.
66
+ * It is isomorphic and can be used for both static and hydrated state.
67
+ */
60
68
  export function buildHydratedStateProvider(singletonContext, solutionType) {
61
69
  return ({ engine, controllers, children, }) => {
62
70
  const { Provider } = singletonContext.get();
63
71
  return (_jsx(Provider, { value: { engine, controllers, solutionType }, children: children }));
64
72
  };
65
73
  }
74
+ export function buildStateProvider(singletonContext, solutionType) {
75
+ return ({ engine, controllers, children, }) => {
76
+ const { Provider } = singletonContext.get();
77
+ return (_jsx(Provider, { value: { engine, controllers, solutionType }, children: children }));
78
+ };
79
+ }
66
80
  //# sourceMappingURL=common.js.map
package/dist/ssr-commerce/common.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/ssr-commerce/common.tsx"],"names":[],"mappings":";AAAA,OAAO,EAOL,YAAY,GAEb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,UAAU,EACV,WAAW,EACX,OAAO,GAGR,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAkB,UAAU,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAQnE,SAAS,sBAAsB,CAI7B,GAA8C;IAE9C,OAAO,QAAQ,IAAI,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,mBAAmB,CAK1B,gBAEC,EACD,GAAS,EACT,oBAAsD;IAEtD,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAErD,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,MAAM,CACpD,CAAC,YAAY,EAAE,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,KAAK,IAAI,CAC9D,CAAC;QAIF,IAAI,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,wBAAwB,CAChC,GAAG,CAAC,QAAQ,EAAE,EACd,sBAAsB,CACvB,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,QAAoB,EAAE,EAAE,CACvB,sBAAsB,CAAC,GAAG,CAAC;YACzB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC3D,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,EACd,CAAC,GAAG,CAAC,CACN,CAAC;QACF,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,CAAC;YACzD,MAAM,EAAC,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,EAAC,GAAG,UAAU,CAAC;YAC3D,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAIhE,CAAC;QACJ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACf,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAIlC,gBAEC,EACD,cAA6B;IAE7B,OAAO,CACL,cAAc;QACZ,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,oBAAoB,CAAC,EAAE,EAAE,CAAC;YAClE,MAAM,UAAU,CAAC,GAAG,CAAC,EAAE;YACvB,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,EAAE,oBAAoB,CAAC;SACjE,CAAC,CACH;QACH,CAAC,CAAC,EAAE,CACgD,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,eAAe,CAI7B,gBAEC;IAED,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAItC,gBAEC,EACD,YAA2B;IAE3B,OAAO,CAAC,EACN,WAAW,EACX,QAAQ,GAMR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,WAAW,EAAE,YAAY,EAAC,YAAG,QAAQ,GAAY,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAIxC,gBAEC,EACD,YAA2B;IAE3B,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GAIR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,CACL,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAC,YACjD,QAAQ,GACA,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/ssr-commerce/common.tsx"],"names":[],"mappings":";AAAA,OAAO,EAOL,YAAY,GAEb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,UAAU,EACV,WAAW,EACX,OAAO,GAGR,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAkB,UAAU,EAAE,SAAS,EAAC,MAAM,aAAa,CAAC;AAQnE,SAAS,sBAAsB,CAI7B,GAA8C;IAE9C,OAAO,QAAQ,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;AACzC,CAAC;AAED,SAAS,mBAAmB,CAK1B,gBAEC,EACD,GAAS,EACT,oBAAsD;IAEtD,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAErD,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,MAAM,CACpD,CAAC,YAAY,EAAE,EAAE,CAAC,oBAAoB,CAAC,YAAY,CAAC,KAAK,IAAI,CAC9D,CAAC;QAIF,IAAI,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,wBAAwB,CAChC,GAAG,CAAC,QAAQ,EAAE,EACd,sBAAsB,CACvB,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,WAAW,CAC3B,CAAC,QAAoB,EAAE,EAAE,CACvB,sBAAsB,CAAC,GAAG,CAAC;YACzB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;YAC3D,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,EACd,CAAC,GAAG,CAAC,CACN,CAAC;QACF,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE;YAC3B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,GAAoB,CAAC,CAAC;YACzD,MAAM,EAAC,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,EAAC,GAAG,UAAU,CAAC;YAC3D,OAAO,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAIhE,CAAC;QACJ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACf,OAAO,EAAC,KAAK,EAAE,OAAO,EAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAIlC,gBAEC,EACD,cAA6B;IAE7B,OAAO,CACL,cAAc;QACZ,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,oBAAoB,CAAC,EAAE,EAAE,CAAC;YAClE,MAAM,UAAU,CAAC,GAAG,CAAC,EAAE;YACvB,mBAAmB,CAAC,gBAAgB,EAAE,GAAG,EAAE,oBAAoB,CAAC;SACjE,CAAC,CACH;QACH,CAAC,CAAC,EAAE,CACgD,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,eAAe,CAI7B,gBAEC;IAED,OAAO,GAAG,EAAE;QACV,MAAM,GAAG,GAAG,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACzC,CAAC;QACD,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAItC,gBAEC,EACD,YAA2B;IAE3B,OAAO,CAAC,EACN,WAAW,EACX,QAAQ,GAMR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,WAAW,EAAE,YAAY,EAAC,YAAG,QAAQ,GAAY,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAIxC,gBAEC,EACD,YAA2B;IAE3B,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GAIR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,CACL,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAC,YACjD,QAAQ,GACA,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAIhC,gBAEC,EACD,YAA2B;IAE3B,OAAO,CAAC,EACN,MAAM,EACN,WAAW,EACX,QAAQ,GASR,EAAE,EAAE;QACJ,MAAM,EAAC,QAAQ,EAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC1C,OAAO,CACL,KAAC,QAAQ,IAAC,KAAK,EAAE,EAAC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAC,YACjD,QAAQ,GACA,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
package/dist/ssr-commerce/providers.js CHANGED
@@ -71,11 +71,7 @@ export function buildProviderWithDefinition(definition) {
71
71
  });
72
72
  });
73
73
  }, [staticState]);
74
- if (hydratedState) {
75
- return (_jsx(definition.HydratedStateProvider, { engine: hydratedState.engine, controllers: hydratedState.controllers, children: children }));
76
- }
77
- const StaticStateProviderWithAnyControllers = definition.StaticStateProvider;
78
- return (_jsx(StaticStateProviderWithAnyControllers, { controllers: staticState.controllers, children: children }));
74
+ return (_jsx(definition.StateProvider, { engine: hydratedState?.engine, controllers: hydratedState?.controllers || staticState.controllers, children: children }));
79
75
  };
80
76
  }
81
77
  //# sourceMappingURL=providers.js.map
package/dist/ssr-commerce/providers.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/ssr-commerce/providers.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAUL,IAAI,GAOL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAoB,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAM7D,SAAS,aAAa,CACpB,WAGC,EACD,GAAW;IAEX,OAAO,WAAW,CAAC,GAAG,CAAM,CAAC;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAGzC,UAAsE;IACtE,OAAO,SAAS,eAAe,CAAC,EAC9B,WAAW,EACX,gBAAgB,EAChB,QAAQ,GAUR;QACA,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAEhD,SAAS,CAAC,CAAC;QACb,UAAU,CAAC,2BAA2B,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC;QAE/D,SAAS,CAAC,GAAG,EAAE;YACb,MAAM,EAAC,aAAa,EAAE,WAAW,EAAC,GAAG,WAAW,CAAC;YACjD,MAAM,gBAAgB,GAAuB,EAAE,CAAC;YAEhD,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC5D,MAAM,eAAe,GAAG,UAAgC,CAAC;gBAEzD,QAAQ,eAAe,CAAC,KAAK,EAAE,CAAC;oBAC9B,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;wBACf,MAAM,IAAI,GAAG,aAAa,CAAO,WAAW,EAAE,GAAG,CAAC,CAAC;wBACnD,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,YAAY,EAAE;gCACZ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;6BACxB;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;wBAClB,MAAM,OAAO,GAAG,aAAa,CAAU,WAAW,EAAE,GAAG,CAAC,CAAC;wBACzD,gBAAgB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;wBACtC,MAAM;oBACR,CAAC;oBAED,KAAK,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;wBAC3B,MAAM,gBAAgB,GAAG,aAAa,CAEpC,WAAW,EAAE,GAAG,CAAC,CAAC;wBACpB,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,YAAY,EAAE;gCACZ,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU;6BAC9C;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;wBAC1B,MAAM,eAAe,GAAG,aAAa,CACnC,WAAW,EACX,GAAG,CACJ,CAAC;wBAEF,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS;yBAC3C,CAAC;wBACF,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GACa;gBACrB,aAAa;aACd,CAAC;YAEF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,GAAG,gBAAgB,CAAC;YACtC,CAAC;YAED,iGAAiG;YACjG,MAAM,eAAe,GAAG,UAGvB,CAAC;YACF,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAC,MAAM,EAAE,WAAW,EAAC,EAAE,EAAE;gBACtE,gBAAgB,CAAC;oBACf,MAAM;oBACN,WAAW,EAAE,WAGZ;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,CACL,KAAC,UAAU,CAAC,qBAAqB,IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,EAC5B,WAAW,EAAE,aAAa,CAAC,WAAW,YAErC,QAAQ,GACwB,CACpC,CAAC;QACJ,CAAC;QAED,MAAM,qCAAqC,GACzC,UAAU,CAAC,mBAMT,CAAC;QAEL,OAAO,CACL,KAAC,qCAAqC,IACpC,WAAW,EAAE,WAAW,CAAC,WAAW,YAEnC,QAAQ,GAC6B,CACzC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/ssr-commerce/providers.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAUL,IAAI,GAOL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAoB,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAM7D,SAAS,aAAa,CACpB,WAGC,EACD,GAAW;IAEX,OAAO,WAAW,CAAC,GAAG,CAAM,CAAC;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAGzC,UAAsE;IACtE,OAAO,SAAS,eAAe,CAAC,EAC9B,WAAW,EACX,gBAAgB,EAChB,QAAQ,GAUR;QACA,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAEhD,SAAS,CAAC,CAAC;QACb,UAAU,CAAC,2BAA2B,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC;QAE/D,SAAS,CAAC,GAAG,EAAE;YACb,MAAM,EAAC,aAAa,EAAE,WAAW,EAAC,GAAG,WAAW,CAAC;YACjD,MAAM,gBAAgB,GAAuB,EAAE,CAAC;YAEhD,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC5D,MAAM,eAAe,GAAG,UAAgC,CAAC;gBAEzD,QAAQ,eAAe,CAAC,KAAK,EAAE,CAAC;oBAC9B,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;wBACf,MAAM,IAAI,GAAG,aAAa,CAAO,WAAW,EAAE,GAAG,CAAC,CAAC;wBACnD,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,YAAY,EAAE;gCACZ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;6BACxB;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;wBAClB,MAAM,OAAO,GAAG,aAAa,CAAU,WAAW,EAAE,GAAG,CAAC,CAAC;wBACzD,gBAAgB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;wBACtC,MAAM;oBACR,CAAC;oBAED,KAAK,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;wBAC3B,MAAM,gBAAgB,GAAG,aAAa,CAEpC,WAAW,EAAE,GAAG,CAAC,CAAC;wBACpB,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,YAAY,EAAE;gCACZ,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU;6BAC9C;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;wBAC1B,MAAM,eAAe,GAAG,aAAa,CACnC,WAAW,EACX,GAAG,CACJ,CAAC;wBAEF,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS;yBAC3C,CAAC;wBACF,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GACa;gBACrB,aAAa;aACd,CAAC;YAEF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,GAAG,gBAAgB,CAAC;YACtC,CAAC;YAED,iGAAiG;YACjG,MAAM,eAAe,GAAG,UAGvB,CAAC;YACF,eAAe,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAC,MAAM,EAAE,WAAW,EAAC,EAAE,EAAE;gBACtE,gBAAgB,CAAC;oBACf,MAAM;oBACN,WAAW,EAAE,WAGZ;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAElB,OAAO,CACL,KAAC,UAAU,CAAC,aAAa,IACvB,MAAM,EAAE,aAAa,EAAE,MAAM,EAC7B,WAAW,EAAE,aAAa,EAAE,WAAW,IAAI,WAAW,CAAC,WAAW,YAEjE,QAAQ,GACgB,CAC5B,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}
package/dist/ssr-commerce/types.d.ts CHANGED
@@ -9,7 +9,11 @@ export type ContextHydratedState<TControllers extends ControllerDefinitionsMap<C
9
9
  controllers: InferControllersMapFromDefinition<TControllers, TSolutionType>;
10
10
  solutionType: TSolutionType;
11
11
  };
12
- export type ContextState<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = ContextStaticState<TControllers, TSolutionType> | ContextHydratedState<TControllers, TSolutionType>;
12
+ export type ContextState<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType> = {
13
+ engine?: SSRCommerceEngine;
14
+ controllers: InferControllersMapFromDefinition<TControllers, TSolutionType> | InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>;
15
+ solutionType: TSolutionType;
16
+ };
13
17
  export type ControllerHook<TController extends Controller> = () => {
14
18
  state: TController['state'];
15
19
  methods?: Omit<TController, 'state' | 'subscribe'>;
@@ -18,11 +22,21 @@ export type InferControllerHooksMapFromDefinition<TControllers extends Controlle
18
22
  [K in keyof TControllers as `use${Capitalize<K extends string ? K : never>}`]: ControllerHook<InferControllerFromDefinition<TControllers[K]>>;
19
23
  };
20
24
  export type ReactEngineDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TEngineOptions, TSolutionType extends SolutionType> = EngineDefinition<TControllers, TEngineOptions, TSolutionType> & {
25
+ /**
26
+ * @deprecated Use `StateProvider` instead.
27
+ */
21
28
  StaticStateProvider: FunctionComponent<PropsWithChildren<{
22
29
  controllers: InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>;
23
30
  }>>;
31
+ /**
32
+ * @deprecated Use `StateProvider` instead.
33
+ */
24
34
  HydratedStateProvider: FunctionComponent<PropsWithChildren<{
25
35
  engine: SSRCommerceEngine;
26
36
  controllers: InferControllersMapFromDefinition<TControllers, TSolutionType>;
27
37
  }>>;
38
+ StateProvider: FunctionComponent<PropsWithChildren<{
39
+ engine?: SSRCommerceEngine;
40
+ controllers: InferControllersMapFromDefinition<TControllers, TSolutionType> | InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>;
41
+ }>>;
28
42
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/headless-react",
3
- "version": "2.4.29",
3
+ "version": "2.4.30-pre.1c8addde3a",
4
4
  "description": "React utilities for SSR (Server Side Rendering) with headless",
5
5
  "homepage": "https://docs.coveo.com/en/headless/latest/",
6
6
  "repository": {
@@ -40,7 +40,7 @@
40
40
  "serve:typedoc": "live-server ./docs"
41
41
  },
42
42
  "dependencies": {
43
- "@coveo/headless": "3.25.2"
43
+ "@coveo/headless": "3.26.0-pre.1c8addde3a"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@coveo/ci": "1.0.0",
@@ -50,11 +50,11 @@
50
50
  "eslint-plugin-testing-library": "7.1.1",
51
51
  "gts": "5.3.1",
52
52
  "live-server": "1.2.2",
53
- "publint": "0.3.6",
53
+ "publint": "0.3.12",
54
54
  "rimraf": "6.0.1",
55
55
  "typescript": "5.8.3",
56
56
  "typedoc": "0.28.5",
57
- "vitest": "3.1.4"
57
+ "vitest": "3.2.1"
58
58
  },
59
59
  "peerDependencies": {
60
60
  "react": "^18 || ^19",