@constructor-io/constructorio-ui-asa 1.1.1 → 1.2.0

package/lib/cjs/hooks/useCioAsaContext.js

@@ -5,8 +5,18 @@ const react_1 = require("react");
 exports.AsaContext = (0, react_1.createContext)(null);
 exports.AsaContext.displayName = 'AsaContext';
 /**
- * React Hook to access state provided by CioAsa provider.
- * Note: Should only be used by components nested under a CioAsa provider
+ * React Hook to access the state provided by the CioAsa provider.
+ *
+ * Returns `null` when called from a component that is not nested under a
+ * `CioAsaProvider`, so guard the result before reading from it:
+ *
+ * ```tsx
+ * const context = useCioAsaContext();
+ * const tracking = useAsaTracking({
+ *   tracker: context?.cioClient?.tracker ?? undefined,
+ *   section: context?.section,
+ * });
+ * ```
  */
 function useCioAsaContext() {
     return (0, react_1.useContext)(exports.AsaContext);

package/lib/cjs/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConstructorIOClient = exports.normalizeItemToProduct = exports.useAsaTracking = exports.useAsaResults = exports.Button = exports.ResultsBlock = exports.Chat = exports.CioAsaProvider = void 0;
+exports.ConstructorIOClient = exports.normalizeItemToProduct = exports.useCioAsaContext = exports.useAsaTracking = exports.useAsaResults = exports.Button = exports.ResultsBlock = exports.Chat = exports.CioAsaProvider = void 0;
 // Components
 var CioAsaProvider_1 = require("./components/CioAsaProvider/CioAsaProvider");
 Object.defineProperty(exports, "CioAsaProvider", { enumerable: true, get: function () { return __importDefault(CioAsaProvider_1).default; } });
@@ -18,6 +18,8 @@ var useAsaResults_1 = require("./hooks/useAsaResults");
 Object.defineProperty(exports, "useAsaResults", { enumerable: true, get: function () { return __importDefault(useAsaResults_1).default; } });
 var useAsaTracking_1 = require("./hooks/useAsaTracking");
 Object.defineProperty(exports, "useAsaTracking", { enumerable: true, get: function () { return __importDefault(useAsaTracking_1).default; } });
+var useCioAsaContext_1 = require("./hooks/useCioAsaContext");
+Object.defineProperty(exports, "useCioAsaContext", { enumerable: true, get: function () { return __importDefault(useCioAsaContext_1).default; } });
 // Utils
 var productNormalizer_1 = require("./utils/productNormalizer");
 Object.defineProperty(exports, "normalizeItemToProduct", { enumerable: true, get: function () { return productNormalizer_1.normalizeItemToProduct; } });

package/lib/cjs/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.1.1';
+exports.default = '1.2.0';

package/lib/mjs/hooks/useCioAsaContext.js

@@ -2,8 +2,18 @@ import { createContext, useContext } from 'react';
 export const AsaContext = createContext(null);
 AsaContext.displayName = 'AsaContext';
 /**
- * React Hook to access state provided by CioAsa provider.
- * Note: Should only be used by components nested under a CioAsa provider
+ * React Hook to access the state provided by the CioAsa provider.
+ *
+ * Returns `null` when called from a component that is not nested under a
+ * `CioAsaProvider`, so guard the result before reading from it:
+ *
+ * ```tsx
+ * const context = useCioAsaContext();
+ * const tracking = useAsaTracking({
+ *   tracker: context?.cioClient?.tracker ?? undefined,
+ *   section: context?.section,
+ * });
+ * ```
  */
 export function useCioAsaContext() {
     return useContext(AsaContext);

package/lib/mjs/index.js

@@ -6,6 +6,7 @@ export { default as Button } from './components/Button/Button';
 // Hooks
 export { default as useAsaResults } from './hooks/useAsaResults';
 export { default as useAsaTracking } from './hooks/useAsaTracking';
+export { default as useCioAsaContext } from './hooks/useCioAsaContext';
 // Utils
 export { normalizeItemToProduct } from './utils/productNormalizer';
 // Re-exported client value from the JS client (used to construct/type a cioClient)

package/lib/mjs/version.js

@@ -1 +1 @@
-export default '1.1.1';
+export default '1.2.0';

package/lib/types/hooks/useCioAsaContext.d.ts

@@ -1,9 +1,19 @@
 /// <reference types="react" />
-import { AsaContextValue } from '../types';
+import { AsaContextValue, Nullable } from '../types';
 export declare const AsaContext: import("react").Context<AsaContextValue | null>;
 /**
- * React Hook to access state provided by CioAsa provider.
- * Note: Should only be used by components nested under a CioAsa provider
+ * React Hook to access the state provided by the CioAsa provider.
+ *
+ * Returns `null` when called from a component that is not nested under a
+ * `CioAsaProvider`, so guard the result before reading from it:
+ *
+ * ```tsx
+ * const context = useCioAsaContext();
+ * const tracking = useAsaTracking({
+ *   tracker: context?.cioClient?.tracker ?? undefined,
+ *   section: context?.section,
+ * });
+ * ```
  */
-export declare function useCioAsaContext(): AsaContextValue;
+export declare function useCioAsaContext(): Nullable<AsaContextValue>;
 export default useCioAsaContext;

package/lib/types/index.d.ts

@@ -7,6 +7,7 @@ export { default as Button } from './components/Button/Button';
 export type { ButtonProps } from './components/Button/Button';
 export { default as useAsaResults } from './hooks/useAsaResults';
 export { default as useAsaTracking } from './hooks/useAsaTracking';
+export { default as useCioAsaContext } from './hooks/useCioAsaContext';
 export type { UseAsaTrackingProps, UseAsaTrackingReturn } from './hooks/useAsaTracking';
 export { normalizeItemToProduct } from './utils/productNormalizer';
 export type { Product, NormalizeOptions } from './utils/productNormalizer';

package/lib/types/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.1.1";
+declare const _default: "1.2.0";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-asa",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Constructor.io AI Shopping Agent UI library for web applications",
   "author": "constructor.io",
   "license": "MIT",