@coveo/headless-react 2.9.33 → 2.10.0

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.
@@ -13,11 +13,23 @@ type UnknownAction = {
13
13
  *
14
14
  * @group Providers
15
15
  */
16
- export declare function buildProviderWithDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(definition: ReactCommerceEngineDefinition<TControllers, TSolutionType>): ({ staticState, navigatorContext, children, }: PropsWithChildren<{
16
+ export declare function buildProviderWithDefinition<TControllers extends ControllerDefinitionsMap<Controller>, TSolutionType extends SolutionType>(definition: ReactCommerceEngineDefinition<TControllers, TSolutionType>): ({ staticState, navigatorContext, accessToken, children, }: PropsWithChildren<{
17
17
  staticState: EngineStaticState<UnknownAction, InferControllerStaticStateMapFromDefinitionsWithSolutionType<TControllers, TSolutionType>>;
18
18
  /**
19
19
  * @deprecated will be removed in the next major release. The navigator context provider can now be set when fetching the static state
20
20
  */
21
21
  navigatorContext: NavigatorContext;
22
+ /**
23
+ * The per-request access token the static state was fetched with.
24
+ *
25
+ * Pass the same token you passed to `fetchStaticState()` so the hydrated engine keeps querying
26
+ * with the same permissions for facets, pagination, and every request issued after hydration.
27
+ * When omitted, the engine definition's configured access token is used.
28
+ *
29
+ * To rotate an expiring token on the running engine, configure `renewAccessToken` on the engine
30
+ * configuration. Changing this prop after hydration does not update the engine, so use the
31
+ * renewal callback to avoid rebuilding and losing interaction state.
32
+ */
33
+ accessToken?: string;
22
34
  }>) => import("react").JSX.Element;
23
35
  export {};
@@ -15,7 +15,7 @@ function getController(controllers, key) {
15
15
  * @group Providers
16
16
  */
17
17
  export function buildProviderWithDefinition(definition) {
18
- return function WrappedProvider({ staticState, navigatorContext, children, }) {
18
+ return function WrappedProvider({ staticState, navigatorContext, accessToken, children, }) {
19
19
  const [hydratedState, setHydratedState] = useState(undefined);
20
20
  definition.setNavigatorContextProvider(() => navigatorContext);
21
21
  useEffect(() => {
@@ -70,6 +70,9 @@ export function buildProviderWithDefinition(definition) {
70
70
  const args = {
71
71
  searchActions,
72
72
  };
73
+ if (accessToken !== undefined) {
74
+ args.accessToken = accessToken;
75
+ }
73
76
  if (hydrateArguments) {
74
77
  args.controllers = hydrateArguments;
75
78
  }
@@ -1 +1 @@
1
- {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/ssr-commerce/providers.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAWL,IAAI,GAOL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAyB,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAMlE,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,wEAAwE;gBACxE,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,CAA+B,WAAW,EAAE,GAAG,CAAC,CAAC;wBACvF,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,CAAkB,WAAW,EAAE,GAAG,CAAC,CAAC;wBAEzE,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS;yBAC3C,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;wBAC5B,MAAM,iBAAiB,GAAG,aAAa,CAAoB,WAAW,EAAE,GAAG,CAAC,CAAC;wBAC7E,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,OAAO,EAAE;gCACP,SAAS,EAAE,iBAAiB,CAAC,KAAK,CAAC,SAAS;gCAC5C,YAAY,EAAE,iBAAiB,CAAC,KAAK,CAAC,YAAY;6BACnD;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAkE;gBAC1E,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"}
1
+ {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/ssr-commerce/providers.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAEb,OAAO,EAWL,IAAI,GAOL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAyB,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAMlE,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,WAAW,EACX,QAAQ,GAsBR;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,wEAAwE;gBACxE,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,CAA+B,WAAW,EAAE,GAAG,CAAC,CAAC;wBACvF,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,CAAkB,WAAW,EAAE,GAAG,CAAC,CAAC;wBAEzE,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS;yBAC3C,CAAC;wBACF,MAAM;oBACR,CAAC;oBACD,KAAK,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;wBAC5B,MAAM,iBAAiB,GAAG,aAAa,CAAoB,WAAW,EAAE,GAAG,CAAC,CAAC;wBAC7E,gBAAgB,CAAC,GAAG,CAAC,GAAG;4BACtB,OAAO,EAAE;gCACP,SAAS,EAAE,iBAAiB,CAAC,KAAK,CAAC,SAAS;gCAC5C,YAAY,EAAE,iBAAiB,CAAC,KAAK,CAAC,YAAY;6BACnD;yBACF,CAAC;wBACF,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAkE;gBAC1E,aAAa;aACd,CAAC;YAEF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YACjC,CAAC;YAED,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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/headless-react",
3
- "version": "2.9.33",
3
+ "version": "2.10.0",
4
4
  "description": "React utilities for SSR (Server Side Rendering) with headless",
5
5
  "keywords": [
6
6
  "headless",
@@ -26,11 +26,11 @@
26
26
  "./ssr-commerce-next": "./dist/ssr-commerce-next/index.js"
27
27
  },
28
28
  "dependencies": {
29
- "@coveo/headless": "3.56.0"
29
+ "@coveo/headless": "3.57.0"
30
30
  },
31
31
  "devDependencies": {
32
32
  "@coveo/documentation": "1.0.0",
33
- "@testing-library/react": "16.3.2",
33
+ "@testing-library/react": "16.3.3",
34
34
  "live-server": "1.2.2",
35
35
  "publint": "0.3.24",
36
36
  "typedoc": "0.28.20",