@envive-ai/react-hooks 0.2.6-alpha-arthur-1 → 0.2.6-alpha.11

package/dist/variantInfo-BfKlkaWU.js

@@ -0,0 +1,11 @@
+//#region src/application/models/variantInfo/variantInfo.ts
+let VariantTypeEnum = /* @__PURE__ */ function(VariantTypeEnum$1) {
+	VariantTypeEnum$1["Pdp"] = "pdp";
+	VariantTypeEnum$1["Plp"] = "plp";
+	VariantTypeEnum$1["PageVisit"] = "page_visit";
+	return VariantTypeEnum$1;
+}({});
+
+//#endregion
+export { VariantTypeEnum };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFyaWFudEluZm8tQmZLbGthV1UuanMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL2FwcGxpY2F0aW9uL21vZGVscy92YXJpYW50SW5mby92YXJpYW50SW5mby50cyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBQTFBJbmZvIH0gZnJvbSAnLi9wbHBJbmZvJztcbmltcG9ydCB7IFBhZ2VWaXNpdEluZm8gfSBmcm9tICcuL3BhZ2VWaXNpdEluZm8nO1xuaW1wb3J0IHsgUHJvZHVjdEluZm8gfSBmcm9tICcuL3Byb2R1Y3RJbmZvJztcblxuZXhwb3J0IGVudW0gVmFyaWFudFR5cGVFbnVtIHtcbiAgUGRwID0gJ3BkcCcsXG4gIFBscCA9ICdwbHAnLFxuICBQYWdlVmlzaXQgPSAncGFnZV92aXNpdCcsXG59XG5cbmV4cG9ydCB0eXBlIFZhcmlhbnRUeXBlID0gJ3BkcCcgfCAncGxwJyB8ICdwYWdlX3Zpc2l0JztcblxuZXhwb3J0IHR5cGUgVmFyaWFudEluZm8gPSBQRFBWYXJpYW50SW5mbyB8IFBMUFZhcmlhbnRJbmZvIHwgUGFnZVZpc2l0VmFyaWFudEluZm87XG5cbmV4cG9ydCB0eXBlIFBEUFZhcmlhbnRJbmZvID0ge1xuICB2YXJpYW50SWQ6IHN0cmluZztcbiAgdmFyaWFudDogVmFyaWFudFR5cGVFbnVtLlBkcDtcbn0gJiBQcm9kdWN0SW5mbztcblxuZXhwb3J0IHR5cGUgUExQVmFyaWFudEluZm8gPSB7XG4gIHZhcmlhbnRJZDogc3RyaW5nO1xuICB2YXJpYW50OiBWYXJpYW50VHlwZUVudW0uUGxwO1xuICB1cmw/OiBzdHJpbmc7XG59ICYgUExQSW5mbztcblxuZXhwb3J0IHR5cGUgUGFnZVZpc2l0VmFyaWFudEluZm8gPSB7XG4gIHZhcmlhbnRJZDogc3RyaW5nO1xuICB2YXJpYW50OiBWYXJpYW50VHlwZUVudW0uUGFnZVZpc2l0O1xufSAmIFBhZ2VWaXNpdEluZm87XG4iXSwibWFwcGluZ3MiOiI7QUFJQSxJQUFZLDhEQUFMO0FBQ0w7QUFDQTtBQUNBIn0=

package/dist/variantInfo-DpLn4nHz.cjs

@@ -0,0 +1,17 @@
+
+//#region src/application/models/variantInfo/variantInfo.ts
+let VariantTypeEnum = /* @__PURE__ */ function(VariantTypeEnum$1) {
+	VariantTypeEnum$1["Pdp"] = "pdp";
+	VariantTypeEnum$1["Plp"] = "plp";
+	VariantTypeEnum$1["PageVisit"] = "page_visit";
+	return VariantTypeEnum$1;
+}({});
+
+//#endregion
+Object.defineProperty(exports, 'VariantTypeEnum', {
+  enumerable: true,
+  get: function () {
+    return VariantTypeEnum;
+  }
+});
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFyaWFudEluZm8tRHBMbjRuSHouY2pzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9hcHBsaWNhdGlvbi9tb2RlbHMvdmFyaWFudEluZm8vdmFyaWFudEluZm8udHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgUExQSW5mbyB9IGZyb20gJy4vcGxwSW5mbyc7XG5pbXBvcnQgeyBQYWdlVmlzaXRJbmZvIH0gZnJvbSAnLi9wYWdlVmlzaXRJbmZvJztcbmltcG9ydCB7IFByb2R1Y3RJbmZvIH0gZnJvbSAnLi9wcm9kdWN0SW5mbyc7XG5cbmV4cG9ydCBlbnVtIFZhcmlhbnRUeXBlRW51bSB7XG4gIFBkcCA9ICdwZHAnLFxuICBQbHAgPSAncGxwJyxcbiAgUGFnZVZpc2l0ID0gJ3BhZ2VfdmlzaXQnLFxufVxuXG5leHBvcnQgdHlwZSBWYXJpYW50VHlwZSA9ICdwZHAnIHwgJ3BscCcgfCAncGFnZV92aXNpdCc7XG5cbmV4cG9ydCB0eXBlIFZhcmlhbnRJbmZvID0gUERQVmFyaWFudEluZm8gfCBQTFBWYXJpYW50SW5mbyB8IFBhZ2VWaXNpdFZhcmlhbnRJbmZvO1xuXG5leHBvcnQgdHlwZSBQRFBWYXJpYW50SW5mbyA9IHtcbiAgdmFyaWFudElkOiBzdHJpbmc7XG4gIHZhcmlhbnQ6IFZhcmlhbnRUeXBlRW51bS5QZHA7XG59ICYgUHJvZHVjdEluZm87XG5cbmV4cG9ydCB0eXBlIFBMUFZhcmlhbnRJbmZvID0ge1xuICB2YXJpYW50SWQ6IHN0cmluZztcbiAgdmFyaWFudDogVmFyaWFudFR5cGVFbnVtLlBscDtcbiAgdXJsPzogc3RyaW5nO1xufSAmIFBMUEluZm87XG5cbmV4cG9ydCB0eXBlIFBhZ2VWaXNpdFZhcmlhbnRJbmZvID0ge1xuICB2YXJpYW50SWQ6IHN0cmluZztcbiAgdmFyaWFudDogVmFyaWFudFR5cGVFbnVtLlBhZ2VWaXNpdDtcbn0gJiBQYWdlVmlzaXRJbmZvO1xuIl0sIm1hcHBpbmdzIjoiOztBQUlBLElBQVksOERBQUw7QUFDTDtBQUNBO0FBQ0EifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envive-ai/react-hooks",
-  "version": "0.2.6-alpha-arthur-1",
+  "version": "0.2.6-alpha.11",
   "description": "React hooks for connecting to Envive AI services.",
   "keywords": [
     "react",
@@ -36,15 +36,13 @@
   "dependencies": {
     "@amplitude/analytics-browser": "^2.23.7",
     "@envive-ai/react-icons": "^0.1.1",
-    "@spiffy-ai/commerce-api-client": "1.1.0-SNAPSHOT.202510160819",
-    "fuse.js": "^7.1.0",
+    "@spiffy-ai/commerce-api-client": "1.1.0-SNAPSHOT.202508291501",
     "jotai": "^2.14.0",
     "react-icons": "^5.5.0",
     "ua-parser-js": "^1.0.39",
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@envive-ai/types": "0.2.2-alpha-6",
     "@types/jest": "^30.0.0",
     "@types/node": "^20.11.30",
     "@types/react": "^18.2.66",
@@ -54,6 +52,7 @@
     "typescript": "~5.8.3"
   },
   "peerDependencies": {
+    "framer-motion": ">=12.23.24",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
@@ -75,6 +74,14 @@
       "import": "./dist/application/models/guards/utils.js",
       "require": "./dist/application/models/guards/utils.cjs"
     },
+    "./application/models/utilityTypes": {
+      "import": "./dist/application/models/utilityTypes/index.js",
+      "require": "./dist/application/models/utilityTypes/index.cjs"
+    },
+    "./application/models/variantInfo": {
+      "import": "./dist/application/models/variantInfo/index.js",
+      "require": "./dist/application/models/variantInfo/index.cjs"
+    },
     "./application/utils": {
       "import": "./dist/application/utils/index.js",
       "require": "./dist/application/utils/index.cjs"
@@ -103,6 +110,10 @@
       "import": "./dist/atoms/search/index.js",
       "require": "./dist/atoms/search/index.cjs"
     },
+    "./atoms/search/types": {
+      "import": "./dist/atoms/search/types.js",
+      "require": "./dist/atoms/search/types.cjs"
+    },
     "./atoms/search/utils": {
       "import": "./dist/atoms/search/utils.js",
       "require": "./dist/atoms/search/utils.cjs"
@@ -143,6 +154,10 @@
       "import": "./dist/contexts/cdnContext/index.js",
       "require": "./dist/contexts/cdnContext/index.cjs"
     },
+    "./contexts/chatContext": {
+      "import": "./dist/contexts/chatContext/index.js",
+      "require": "./dist/contexts/chatContext/index.cjs"
+    },
     "./contexts/enviveConfigContext": {
       "import": "./dist/contexts/enviveConfigContext/index.js",
       "require": "./dist/contexts/enviveConfigContext/index.cjs"
@@ -187,6 +202,10 @@
       "import": "./dist/contexts/systemSettingsContext/index.js",
       "require": "./dist/contexts/systemSettingsContext/index.cjs"
     },
+    "./contexts/types": {
+      "import": "./dist/contexts/types.js",
+      "require": "./dist/contexts/types.cjs"
+    },
     "./contexts/userIdentityContext": {
       "import": "./dist/contexts/userIdentityContext/index.js",
       "require": "./dist/contexts/userIdentityContext/index.cjs"
@@ -195,10 +214,6 @@
       "import": "./dist/events/index.js",
       "require": "./dist/events/index.cjs"
     },
-    "./exceptions": {
-      "import": "./dist/exceptions/index.js",
-      "require": "./dist/exceptions/index.cjs"
-    },
     "./hooks/AmplitudeOperations": {
       "import": "./dist/hooks/AmplitudeOperations/index.js",
       "require": "./dist/hooks/AmplitudeOperations/index.cjs"
@@ -235,6 +250,10 @@
       "import": "./dist/hooks/ElementObserver/index.js",
       "require": "./dist/hooks/ElementObserver/index.cjs"
     },
+    "./hooks/FloatingButtonVisibility": {
+      "import": "./dist/hooks/FloatingButtonVisibility/index.js",
+      "require": "./dist/hooks/FloatingButtonVisibility/index.cjs"
+    },
     "./hooks/GrabAndScroll": {
       "import": "./dist/hooks/GrabAndScroll/index.js",
       "require": "./dist/hooks/GrabAndScroll/index.cjs"
@@ -259,6 +278,10 @@
       "import": "./dist/hooks/IsSmallScreen/index.js",
       "require": "./dist/hooks/IsSmallScreen/index.cjs"
     },
+    "./hooks/LastInteraction": {
+      "import": "./dist/hooks/LastInteraction/index.js",
+      "require": "./dist/hooks/LastInteraction/index.cjs"
+    },
     "./hooks/LocalStorageOperations": {
       "import": "./dist/hooks/LocalStorageOperations/index.js",
       "require": "./dist/hooks/LocalStorageOperations/index.cjs"
@@ -315,6 +338,10 @@
       "import": "./dist/interceptors/index.js",
       "require": "./dist/interceptors/index.cjs"
     },
+    "./interceptors/types": {
+      "import": "./dist/interceptors/types.js",
+      "require": "./dist/interceptors/types.cjs"
+    },
     "./types": {
       "import": "./dist/types/index.js",
       "require": "./dist/types/index.cjs"
@@ -418,4 +445,4 @@
       "./package.json": "./package.json"
     }
   }
-}
+}

package/src/application/commerce-api.ts

@@ -1,6 +1,5 @@
+import Logger from "src/application/logging/logger";
 import {
-  Context,
-  ContextEnvEnum,
   Configuration,
   CustomerServiceApi,
   DefaultApi,
@@ -16,45 +15,45 @@ import {
   ResponseCategory,
   FormType,
 } from "@spiffy-ai/commerce-api-client";
+import { validateSuggestion } from "src/application/models/validators/validateSuggestion";
+import { validateUserEvent } from "src/application/models/validators/validateUserEvent";
 import {
-  SupportedEvent,
-  ProductExperiment,
-  ClientDetails,
-  UserEvent,
+  messageFromQueryEvent,
+  messageFromResponse,
+  messageFromSuggestionEvent,
+} from "src/application/utils";
+import {
+  Message,
   NextMessageRequest,
+  Response,
+  Suggestion,
   SupportedEventRequest,
-  OrgConfig,
-} from "@envive-ai/types";
-import { ApiResponse, Message, Suggestion } from "src/types";
-import { userIdAtom, chatIdAtom } from "src/atoms/app";
-import { getAtomStore } from "src/atoms/atomStore";
+  UserEvent,
+} from "src/application/models";
+import { messageRequestToCommerceMessageRequest } from "src/application/utils/nextMessageRequestToApiRequest";
+import { validateResponse } from "src/application/models/validators/validateResponse";
+import { coreSupportedEventRequestToApiRequest } from "src/application/utils/supportedEventRequestToApiRequest";
+import { SessionRestartRequired } from "src/types/exceptions/sessionExceptions";
+import { UnsupportedProductException } from "src/types/exceptions/unsupportedProductExceptions";
+import { ClientDetails } from "src/application/models/clientDetails";
+import { getAtomStore } from "src/atoms/atomStore/atomStore";
+import { ProductExperiment } from "src/application/models/productExperiment";
+import { FeatureGates } from "src/application/models/featureGates";
+import { validateOrgConfigResults } from "src/application/models/validators/validateOrgConfigResults";
+import { OrgConfig } from "src/application/models/api/orgConfigResults";
+import { SupportedEvent } from "src/atoms/app/variant";
+import { messageFromFormSubmittedEvent } from "src/application/utils/messageFromFormSubmittedEvent";
+import type { Context } from "@spiffy-ai/commerce-api-client/dist/models/Context";
+import { ContextEnvEnum } from "@spiffy-ai/commerce-api-client"; // Import ContextEnvEnum
 import {
   baseUrlAtom,
-  orgShortNameAtom,
-  contextSourceAtom,
-  envAtom,
   reactAppNameAtom,
+  contextSourceAtom,
+  orgShortNameAtom,
+  envAtom, // Import envAtom
 } from "src/atoms/envive/enviveConfig";
-import { orgIdAtom, featureFlagServiceAtom } from "src/atoms/org";
-import {
-  UnsupportedProductException,
-  SessionRestartRequired,
-} from "src/exceptions";
-import Logger from "./logging/logger";
-import {
-  validateResponse,
-  validateSuggestion,
-  validateUserEvent,
-  validateOrgConfigResults,
-} from "./models";
-import {
-  messageRequestToCommerceMessageRequest,
-  messageFromResponse,
-  messageFromQueryEvent,
-  messageFromSuggestionEvent,
-  messageFromFormSubmittedEvent,
-  coreSupportedEventRequestToApiRequest,
-} from "./utils";
+import { userIdAtom, chatIdAtom } from "src/atoms/app"; // Import userIdAtom and chatIdAtom
+import { orgIdAtom, featureFlagServiceAtom } from "src/atoms/org/graphqlConfig"; // Import new orgIdAtom and featureFlagServiceAtom
 
 async function errorResponseBody(error: ResponseError) {
   try {
@@ -204,7 +203,7 @@ class CommerceApiClient {
 
   static getNextResponseStreaming = (
     payload: NextMessageRequest
-  ): AsyncGenerator<ApiResponse, void, unknown> => {
+  ): AsyncGenerator<Response, void, unknown> => {
     async function* generate(
       inferenceApi: InferenceApi,
       abortController: AbortController
@@ -357,7 +356,7 @@ class CommerceApiClient {
     chatId: string,
     userId: string
   ): Promise<{
-    responses: ApiResponse[][];
+    responses: Response[][];
     userEvents: UserEvent[];
     suggestions: Suggestion[];
     messages: Message[][];
@@ -384,10 +383,10 @@ class CommerceApiClient {
       );
     }
 
-    const responses: ApiResponse[][] = data?.responses?.map((turn) =>
+    const responses: Response[][] = data?.responses?.map((turn) =>
       turn
         .map((response) => validateResponse(response))
-        .filter((response): response is ApiResponse => response != null)
+        .filter((response): response is Response => response != null)
     );
 
     const suggestions: Suggestion[] = data?.suggestions
@@ -545,8 +544,6 @@ class CommerceApiClient {
         return V1OrgConfigGetSourceEnum.App;
       case ContextSourceEnum.Test:
         return V1OrgConfigGetSourceEnum.Test;
-      case ContextSourceEnum.Eval:
-        return V1OrgConfigGetSourceEnum.Test;
       default: {
         // This ensures that if new values are added to ContextSourceEnum, we catch it
         const exhaustiveCheck: never = source;

package/src/application/models/api/context.ts

@@ -0,0 +1,4 @@
+import { Context as ApiContext } from '@spiffy-ai/commerce-api-client';
+import { CamelCasedPropertiesDeep } from 'src/application/models/utilityTypes';
+
+export interface Context extends CamelCasedPropertiesDeep<ApiContext> {}

package/src/application/models/api/generationParams.ts

@@ -0,0 +1,4 @@
+import { GenerationParams as ApiGenerationParams } from '@spiffy-ai/commerce-api-client';
+import { CamelCasedPropertiesDeep } from 'src/application/models/utilityTypes';
+
+export interface GenerationParams extends CamelCasedPropertiesDeep<ApiGenerationParams> {}

package/src/application/models/api/nextMessageRequest.ts

@@ -0,0 +1,11 @@
+import { Context } from './context';
+import { UserEvent } from './userEvent';
+import { GenerationParams } from './generationParams';
+
+export interface NextMessageRequest {
+  id: string;
+  context: Context;
+  userEvents?: UserEvent[];
+  featureFlags?: Record<string, boolean>;
+  generationParams?: GenerationParams;
+}

package/src/application/models/api/orgAnalyticsConfig.ts

@@ -0,0 +1,19 @@
+export interface OrgAnalyticsConfig {
+  amplitude?: OrgAnalyticsAmplitudeConfig;
+  customerService?: OrgAnalyticsCustomerServiceConfig;
+  googleAnalytics?: OrgAnalyticsGoogleAnalyticsConfig;
+}
+
+export interface OrgAnalyticsAmplitudeConfig {
+  sessionReplayEnabled: boolean;
+  sessionReplaySampleRate: number;
+  trackingEnabled: boolean;
+}
+
+export interface OrgAnalyticsCustomerServiceConfig {
+  provider: string;
+}
+
+export interface OrgAnalyticsGoogleAnalyticsConfig {
+  measurementId?: string;
+}

package/src/application/models/api/orgConfigResults.ts

@@ -0,0 +1,44 @@
+import { OrganizationStatusEnum } from "@spiffy-ai/commerce-api-client";
+import { OrganizationConfig } from "src/application/models/api/organizationConfig";
+import { ColorMapping } from "src/application/models/colorsConfig";
+import { FrontendConfig } from "src/application/models/frontendConfig";
+
+export interface OrgConfigExperiment {
+  group?: string;
+  groupName?: string;
+  name?: string;
+  ruleId?: string;
+  value?: Record<string, unknown>;
+}
+
+export interface OrgConfigFeatureGate {
+  groupName?: string;
+  name?: string;
+  ruleId?: string;
+  value?: boolean;
+}
+
+export interface Organization {
+  id: string;
+  displayName: string;
+  domain: string;
+  shortName: string;
+  status: OrganizationStatusEnum;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export interface OrganizationSettings {
+  org: Organization;
+  // this is currently not configured by the backend
+  settings: Record<string, unknown>;
+}
+
+export interface OrgConfig {
+  configs: OrganizationConfig[];
+  experiments: OrgConfigExperiment[];
+  gates: OrgConfigFeatureGate[];
+  org: OrganizationSettings;
+  colorsConfig?: ColorMapping;
+  frontendConfig?: FrontendConfig;
+}

package/src/application/models/api/organizationConfig.ts

@@ -0,0 +1,12 @@
+import { OrgAnalyticsConfig } from './orgAnalyticsConfig';
+
+export interface OrganizationConfig {
+  createdAt: string;
+  namespace: string;
+  isLatest: boolean;
+  version: string;
+  updatedAt: string;
+  config: OrgAnalyticsConfig;
+  organizationId?: string;
+  id?: string;
+}

package/src/{types/ApiResponse.ts → application/models/api/response.ts}

@@ -1,32 +1,26 @@
+import { ResponseCategory } from '@spiffy-ai/commerce-api-client';
+import { CamelCasedPropertiesDeep } from 'src/application/models/utilityTypes';
+
 import type {
-  ApiResponseCategory,
-  ApiProductSearchResponseAttributes,
-  ApiProductResponseAttributes,
-  ApiSearchResponseProduct,
-  ApiFormType,
-  ApiFulfillmentDisplayStatus,
+  ProductSearchResponseAttributes as ApiProductSearchResponseAttributes,
+  ResponseProductAttributes as ApiProductResponseAttributes,
+  SearchResponseProduct as ApiSearchResponseProduct,
+  FormType,
+  FulfillmentDisplayStatus,
+} from '@spiffy-ai/commerce-api-client';
+import {
   ApiReviewResponseAttributes,
   ApiReviewRichInformation,
   ApiPageResponseAttributes,
   ApiTextResponseAttributes,
   ApiSearchResponseAttributes,
   ApiProductSearchFilterResponseAttributes,
-  CamelCasedPropertiesDeep,
-} from "@envive-ai/types";
-
-// TODO: These are duplicated types. Right now, since this uses discriminated unions, they don't export from the types
-// library properly. Can be fixed by refactoring the current approach use the right method is decided upon.
+} from 'src/application/models/api/responseGenerics';
 
 // Internal types
-export interface ReviewRichInformation
-  extends CamelCasedPropertiesDeep<ApiReviewRichInformation> {}
+export interface ReviewRichInformation extends CamelCasedPropertiesDeep<ApiReviewRichInformation> {}
 
-export type AcceptableFormFieldType =
-  | "string"
-  | "number"
-  | "boolean"
-  | "object"
-  | "array";
+export type AcceptableFormFieldType = 'string' | 'number' | 'boolean' | 'object' | 'array';
 
 export interface OrderItemInfo {
   itemTitle: string;
@@ -37,12 +31,12 @@ export interface OrderItemInfo {
   inTransitAt?: string;
   deliveredAt?: string;
   estimatedDeliveryAt?: string;
-  fulfillmentDisplayStatus?: ApiFulfillmentDisplayStatus;
+  fulfillmentDisplayStatus?: FulfillmentDisplayStatus;
   trackingUrl?: string;
 }
 
 export interface OrderResponseAttributes {
-  category: ApiResponseCategory.Order;
+  category: ResponseCategory.Order;
   attributes: {
     orderId: string;
     orderNumber: string;
@@ -53,12 +47,12 @@ export interface OrderResponseAttributes {
 }
 
 export interface TextResponseAttributes {
-  category: ApiResponseCategory.Text;
+  category: ResponseCategory.Text;
   attributes: CamelCasedPropertiesDeep<ApiTextResponseAttributes>;
 }
 
 export interface ProductResponseAttributes {
-  category: ApiResponseCategory.Product;
+  category: ResponseCategory.Product;
   attributes: CamelCasedPropertiesDeep<
     ApiProductResponseAttributes & {
       filters?: {
@@ -69,51 +63,51 @@ export interface ProductResponseAttributes {
 }
 
 export interface SearchResponseProductAttributes {
-  category: ApiResponseCategory.Product;
+  category: ResponseCategory.Product;
   attributes: CamelCasedPropertiesDeep<ApiSearchResponseProduct>;
 }
 
 export interface SearchResponseAttributes {
-  category: ApiResponseCategory.Text;
+  category: ResponseCategory.Text;
   attributes: CamelCasedPropertiesDeep<ApiSearchResponseAttributes>;
 }
 
 export interface SearchProductResponseAttributes {
-  category: ApiResponseCategory.ProductSearch;
+  category: ResponseCategory.ProductSearch;
   attributes: CamelCasedPropertiesDeep<ApiProductSearchResponseAttributes>;
 }
 
 export interface SearchProductFilterAttributes {
-  category: ApiResponseCategory.ProductSearchFilter;
+  category: ResponseCategory.ProductSearchFilter;
   attributes: CamelCasedPropertiesDeep<ApiProductSearchFilterResponseAttributes>;
 }
 
 export interface ReviewResponseAttributes {
-  category: ApiResponseCategory.Review;
+  category: ResponseCategory.Review;
   attributes: CamelCasedPropertiesDeep<ApiReviewResponseAttributes>;
 }
 
 export interface SeparatorResponseAttributes {
-  category: ApiResponseCategory.Separator;
+  category: ResponseCategory.Separator;
 }
 
 export interface PageResponseAttributes {
-  category: ApiResponseCategory.Page;
+  category: ResponseCategory.Page;
   attributes: CamelCasedPropertiesDeep<ApiPageResponseAttributes>;
 }
 
 export interface FormResponseAttributes {
-  category: ApiResponseCategory.Form;
+  category: ResponseCategory.Form;
   attributes: {
     formCategory?: {
-      formType: ApiFormType;
+      formType: FormType;
     };
     schema: {
       properties: {
         [key: string]: {
           type: AcceptableFormFieldType;
           title: string;
-          format?: "email";
+          format?: 'email';
         };
       };
       required: string[];
@@ -121,10 +115,10 @@ export interface FormResponseAttributes {
   };
 }
 
-export type ApiResponse = {
+export type Response = {
   id: string;
   createdAt: string;
-  category: ApiResponseCategory;
+  category: ResponseCategory;
 } & (
   | TextResponseAttributes
   | ProductResponseAttributes

package/src/application/models/api/responseGenerics.ts

@@ -0,0 +1,67 @@
+import { FormResponseAttributesFormCategory } from '@spiffy-ai/commerce-api-client';
+import { AcceptableFormFieldType } from './response';
+
+// Boundary types, these are generic objects not defined in the SDK but can be returned by the API
+// as properties of the response attributes
+export interface ApiReviewRichInformation {
+  cons?: string[];
+  pros?: string[];
+  review_date?: string;
+  reviewer_title?: string;
+  product_familiarity?: 'IVE_TESTED_IT' | 'I_OWN_IT';
+}
+
+export interface ApiTextResponseAttributes {
+  content: string;
+}
+
+export interface ApiSearchResponseAttributes {
+  search_term: string;
+  selected_filters?: string[];
+  filters?: {
+    [key: string]: string[];
+  };
+}
+
+export interface ApiSearchResponseProductAttributes {
+  response_id?: string;
+}
+
+export interface ApiProductSearchFilterResponseAttributes {
+  filter_name: string;
+}
+
+export interface ApiReviewResponseAttributes {
+  id?: string;
+  product_id?: string;
+  title?: string;
+  reviewer?: string;
+  review?: string;
+  stars?: number;
+  rich_information?: ApiReviewRichInformation;
+
+  onClick?: () => void;
+}
+
+export interface ApiPageResponseAttributes {
+  id?: string;
+  title?: string;
+  description?: string;
+  url?: string;
+}
+
+export interface ApiFormResponseSchemaAttributes {
+  properties: {
+    [key: string]: {
+      format?: 'email';
+      type: AcceptableFormFieldType;
+      title: string;
+    };
+  };
+  required: Array<keyof ApiFormResponseSchemaAttributes['properties']>;
+}
+
+export interface ApiFormResponseAttributes {
+  form_category?: FormResponseAttributesFormCategory;
+  schema: ApiFormResponseSchemaAttributes;
+}

package/src/application/models/api/search.ts

@@ -0,0 +1,26 @@
+import {
+  ProductSearchResponse as ApiProductSearchResponse,
+  ProductSearchResponseAttributes as ApiProductSearchResponseAttributes,
+  SearchResponseProduct,
+} from '@spiffy-ai/commerce-api-client';
+import { CamelCasedPropertiesDeep } from 'src/application/models/utilityTypes';
+
+// Transform API types using CamelCasedPropertiesDeep
+export interface ProductSearchResponse extends CamelCasedPropertiesDeep<ApiProductSearchResponse> {}
+export interface ProductSearchResponseAttributes
+  extends CamelCasedPropertiesDeep<ApiProductSearchResponseAttributes> {}
+
+// Custom search result interface (flattened structure)
+export interface SearchResult {
+  products: SearchResponseProduct[]; // Flattened from all responses
+  filters: string[]; // Combined from all responses
+  generatedQuery?: string;
+  totalProductCount: number;
+  searchResponseId: string;
+}
+
+// Search parameters interface
+export interface SearchParams {
+  query: string;
+  limit?: number;
+}

package/src/application/models/api/suggestion.ts

@@ -0,0 +1,4 @@
+import { Suggestion as ApiSuggestion } from '@spiffy-ai/commerce-api-client';
+import { CamelCasedPropertiesDeep } from 'src/application/models/utilityTypes';
+
+export interface Suggestion extends CamelCasedPropertiesDeep<ApiSuggestion> {}

package/src/application/models/api/supportedEventRequest.ts

@@ -0,0 +1,8 @@
+import { UserEvent } from './userEvent';
+import { Context } from './context';
+
+export interface SupportedEventRequest {
+  id: string;
+  context: Context;
+  userEvent: UserEvent;
+}