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

package/src/application/models/guards/api/isApiProductSearchAttributes.ts

@@ -1,23 +1,20 @@
-import { ProductSearchResponseAttributes } from "@spiffy-ai/commerce-api-client";
+import { ProductSearchResponseAttributes } from '@spiffy-ai/commerce-api-client';
 
 export const isApiProductSearchResponseAttributes = (
-  attributes: unknown
+  attributes: unknown,
 ): attributes is ProductSearchResponseAttributes => {
-  if (attributes == null || typeof attributes !== "object") {
+  if (attributes == null || typeof attributes !== 'object') {
     return false;
   }
 
-  if (
-    "generated_query" in attributes &&
-    typeof attributes.generated_query !== "string"
-  ) {
+  if ('generated_query' in attributes && typeof attributes.generated_query !== 'string') {
     return false;
   }
 
   if (
-    "product_count" in attributes &&
+    'product_count' in attributes &&
     attributes.product_count != null &&
-    typeof attributes.product_count !== "number"
+    typeof attributes.product_count !== 'number'
   ) {
     return false;
   }

package/src/application/models/guards/api/isApiProductSearchFilterAttributes.ts

@@ -1,16 +1,13 @@
-import { ProductSearchFilterResponseAttributes } from "@spiffy-ai/commerce-api-client";
+import { ProductSearchFilterResponseAttributes } from '@spiffy-ai/commerce-api-client';
 
 export const isApiProductSearchFilterResponseAttributes = (
-  attributes: unknown
+  attributes: unknown,
 ): attributes is ProductSearchFilterResponseAttributes => {
-  if (attributes == null || typeof attributes !== "object") {
+  if (attributes == null || typeof attributes !== 'object') {
     return false;
   }
 
-  if (
-    "filter_name" in attributes &&
-    typeof attributes.filter_name !== "string"
-  ) {
+  if ('filter_name' in attributes && typeof attributes.filter_name !== 'string') {
     return false;
   }
 

package/src/application/models/guards/api/isApiQueryTypedEventAttributes.ts

@@ -1,9 +1,4 @@
-import { QueryTypedAttributes } from "@spiffy-ai/commerce-api-client";
+import { QueryTypedAttributes } from '@spiffy-ai/commerce-api-client';
 
-export const isApiQueryTypedAttributes = (
-  data: unknown
-): data is QueryTypedAttributes =>
-  data != null &&
-  typeof data === "object" &&
-  "query" in data &&
-  typeof data.query === "string";
+export const isApiQueryTypedAttributes = (data: unknown): data is QueryTypedAttributes =>
+  data != null && typeof data === 'object' && 'query' in data && typeof data.query === 'string';

package/src/application/models/guards/api/isApiResponse.ts

@@ -1,44 +1,37 @@
-import { ResponseCategory } from "@spiffy-ai/commerce-api-client";
-import Logger from "src/application/logging/logger";
-import { hasPropertyOfType } from "../utils";
-import { ApiResponse } from "src/types";
+import Logger from 'src/application/logging/logger';
+import { Response, ResponseCategory } from '@spiffy-ai/commerce-api-client';
+import { hasPropertyOfType } from 'src/application/models/guards/utils';
 
-export const isApiResponse = (data: unknown): data is ApiResponse => {
-  if (data == null || typeof data !== "object") {
-    Logger.logError("isApiResponse: data is null or not an object", undefined, {
-      data,
-    });
+export const isApiResponse = (data: unknown): data is Response => {
+  if (data == null || typeof data !== 'object') {
+    Logger.logError('isApiResponse: data is null or not an object', undefined, { data });
     return false;
   }
 
-  if (!hasPropertyOfType(data, "id", "string")) {
-    Logger.logError("isApiResponse: id is not a string", undefined, { data });
+  if (!hasPropertyOfType(data, 'id', 'string')) {
+    Logger.logError('isApiResponse: id is not a string', undefined, { data });
     return false;
   }
 
   if (
-    !hasPropertyOfType(data, "category", "string") ||
+    !hasPropertyOfType(data, 'category', 'string') ||
     !Object.values(ResponseCategory).includes(data.category as ResponseCategory)
   ) {
     Logger.logError(
-      "isApiResponse: category is not a string or not a valid response category",
+      'isApiResponse: category is not a string or not a valid response category',
       undefined,
-      { data }
+      { data },
     );
     return false;
   }
 
-  if (!hasPropertyOfType(data, "created_at", "string")) {
-    Logger.logError("isApiResponse: created_at is not a string", undefined, {
-      data,
-    });
+  if (!hasPropertyOfType(data, 'created_at', 'string')) {
+    Logger.logError('isApiResponse: created_at is not a string', undefined, { data });
     return false;
   }
 
-  if (!hasPropertyOfType(data, "attributes", "object", true)) {
-    Logger.logError("isApiResponse: attributes is not an object", undefined, {
-      data,
-    });
+  if (!hasPropertyOfType(data, 'attributes', 'object', true)) {
+    Logger.logError('isApiResponse: attributes is not an object', undefined, { data });
     return false;
   }
 

package/src/application/models/guards/api/isApiReviewResponseAttributes.ts

@@ -1,4 +1,4 @@
-import { ApiReviewResponseAttributes } from '@envive-ai/types';
+import { ApiReviewResponseAttributes } from 'src/application/models/api/responseGenerics';
 import { isApiReviewRichInformation } from './isApiReviewRichInformation';
 
 export const isApiReviewResponseAttributes = (obj: unknown): obj is ApiReviewResponseAttributes => {

package/src/application/models/guards/api/isApiReviewRichInformation.ts

@@ -1,4 +1,4 @@
-import { ApiReviewRichInformation } from '@envive-ai/types';
+import { ApiReviewRichInformation } from 'src/application/models/api/responseGenerics';
 
 export const isApiReviewRichInformation = (
   richInfo: unknown,

package/src/application/models/guards/api/isApiTextResponseAttributes.ts

@@ -1,4 +1,4 @@
-import { ApiTextResponseAttributes } from '@envive-ai/types';
+import { ApiTextResponseAttributes } from 'src/application/models/api/responseGenerics';
 
 export const isApiTextResponseAttributes = (
   attributes: unknown,

package/src/application/models/guards/graphQL/isGraphQLColorsConfig.ts

@@ -1,5 +1,5 @@
-import { GetMerchantColorsQueryData } from '@envive-ai/types';
 import Logger from 'src/application/logging/logger';
+import { GetMerchantColorsQueryData } from 'src/application/models/graphql';
 
 const REQUIRED_COLOR_FIELDS = [
   'accent_primary',

package/src/application/models/guards/isBaseEcommerceEvent.ts

@@ -1,4 +1,5 @@
-import { BaseEcommerceEvent } from '@envive-ai/types';
+import type { BaseEcommerceEvent } from 'src/application/models';
+
 /**
  * Checks if an event is a base Google Analytics ecommerce event.
  *

package/src/application/models/guards/isGA4EcommerceEvent.ts

@@ -1,4 +1,4 @@
-import { GA4EcommerceEvent } from '@envive-ai/types';
+import type { GA4EcommerceEvent } from 'src/application/models';
 
 /**
  * Checks if an event is a Google Analytics 4 ecommerce event.

package/src/application/models/guards/isLegacyUAEcommerceEvent.ts

@@ -1,4 +1,4 @@
-import { UAEcommerceEvent } from '@envive-ai/types';
+import type { UAEcommerceEvent } from 'src/application/models';
 
 /**
  * Checks if an event is a legacy Universal Analytics ecommerce event.

package/src/application/models/guards/isMobilePLPChatPlacementParameter.ts

@@ -1,4 +1,6 @@
-import { MobilePlpChatPlacementParameter } from '@envive-ai/types';
+interface MobilePlpChatPlacementParameter {
+  row_index: number;
+}
 
 export const isMobilePLPChatPlacementParameter = (
   value: unknown,

package/src/application/models/guards/isSpanxTakeAQuizCtaParameter.ts

@@ -1,6 +1,4 @@
-interface SpanxTakeAQuizCtaParameter {
-  text?: string;
-  value?: string;
-}
+import { SpanxTakeAQuizCtaParameter } from '../spanxTakeAQuizCtaParameter';
+
 export const isSpanxTakeAQuizCtaParameter = (value: unknown): value is SpanxTakeAQuizCtaParameter =>
-  value != null && typeof value === 'object' && 'text' in value && typeof value.text === 'string';
+  value != null && typeof value === 'object' && 'text' in value && typeof value.text === 'string';

package/src/application/models/guards/isVariantInfo.ts

@@ -1,10 +1,5 @@
-import {
-  PDPVariantInfo,
-  PLPVariantInfo,
-  PageVisitVariantInfo,
-  VariantInfo,
-} from '@envive-ai/types';
 import { PageVisitCategory } from '@spiffy-ai/commerce-api-client';
+import { PDPVariantInfo, PLPVariantInfo, PageVisitVariantInfo, VariantInfo } from '../variantInfo';
 
 const isPDPVariantInfo = (variantInfo: object): variantInfo is PDPVariantInfo =>
   'variant' in variantInfo &&

package/src/application/models/index.ts

@@ -1,37 +1,102 @@
+// models
+export * from "./cachedValue";
+export * from "./chatElementDisplayLocation";
+export * from "./clientDetails";
+export * from "./colorsConfig";
+export * from "./conversationalSearchIds";
+export * from "./dataLayer";
+export * from "./events";
+export * from "./featureGates";
+export * from "./frontendConfig";
+export * from "./googleAnalyticsEvents";
+export * from "./message";
+export * from "./mobilePLPChatPlacementParameter";
+export * from "./orgsEnum";
+export * from "./productExperiment";
+export * from "./spanxTakeAQuizCtaParameter";
+export * from "./spiffyWidgets";
+
+// api
+export * from "./api/context";
+export * from "./api/generationParams";
+export * from "./api/nextMessageRequest";
+export * from "./api/orgAnalyticsConfig";
+export * from "./api/organizationConfig";
+export * from "./api/orgConfigResults";
+export * from "./api/response";
+export * from "./api/responseGenerics";
+export * from "./api/search";
+export * from "./api/suggestion";
+export * from "./api/supportedEventRequest";
+export * from "./api/userEvent";
+
 // graphql
-export * from './graphql';
-export * from './graphql/queries/getMerchantOrgIdQuery';
+export * from "./graphql";
+export * from "./graphql/queries/getMerchantColorsQuery";
+export * from "./graphql/queries/getMerchantFrontendConfigQuery";
+export * from "./graphql/queries/getMerchantOrgIdQuery";
 
 // type guards
-export * from './guards/isBaseEcommerceEvent';
-export * from './guards/isGA4EcommerceEvent';
-export * from './guards/isLegacyUAEcommerceEvent';
-export * from './guards/isMobilePLPChatPlacementParameter';
-export * from './guards/isSpanxTakeAQuizCtaParameter';
-export * from './guards/isVariantInfo';
-export * from './guards/utils';
-export * from './guards/api';
-export * from './guards/api/isApiFormResponse';
-export * from './guards/api/isApiFormSubmittedResponseAttributes';
-export * from './guards/api/isApiOrderResponseAttributes';
-export * from './guards/api/isApiOrganizationConfig';
-export * from './guards/api/isApiOrgConfigResults';
-export * from './guards/api/isApiPageResponseAttributes';
-export * from './guards/api/isApiPLPEventAttributes';
-export * from './guards/api/isApiProductSearchFilterAttributes';
-export * from './guards/graphQL/isGraphQLColorsConfig';
+export * from "./guards/isBaseEcommerceEvent";
+export * from "./guards/isGA4EcommerceEvent";
+export * from "./guards/isLegacyUAEcommerceEvent";
+export * from "./guards/isMobilePLPChatPlacementParameter";
+export * from "./guards/isSpanxTakeAQuizCtaParameter";
+export * from "./guards/isVariantInfo";
+export * from "./guards/utils";
+export * from "./guards/api";
+export * from "./guards/api/isApiFormResponse";
+export * from "./guards/api/isApiFormSubmittedResponseAttributes";
+export * from "./guards/api/isApiOrderResponseAttributes";
+export * from "./guards/api/isApiOrganizationConfig";
+export * from "./guards/api/isApiOrgConfigResults";
+export * from "./guards/api/isApiPageResponseAttributes";
+export * from "./guards/api/isApiPDPEventAttributes";
+export * from "./guards/api/isApiPLPEventAttributes";
+export * from "./guards/api/isApiProductResponseAttributes";
+export * from "./guards/api/isApiProductSearchAttributes";
+export * from "./guards/api/isApiProductSearchFilterAttributes";
+export * from "./guards/api/isApiQueryTypedEventAttributes";
+export * from "./guards/api/isApiResponse";
+export * from "./guards/api/isApiReviewResponseAttributes";
+export * from "./guards/api/isApiReviewRichInformation";
+export * from "./guards/api/isApiSearchEventAttributes";
+export * from "./guards/api/isApiSuggestion";
+export * from "./guards/api/isApiSuggestionClickedEventAttributes";
+export * from "./guards/api/isApiTextResponseAttributes";
+export * from "./guards/api/isApiUserEvent";
+export * from "./guards/graphQL/isGraphQLColorsConfig";
+
+// utilityTypes
+export * from "./utilityTypes/camelCase";
+export * from "./utilityTypes/camelCasedPropertiesDeep";
+export * from "./utilityTypes/delimiterCase";
+export * from "./utilityTypes/delimiterCasedPropertiesDeep";
+export * from "./utilityTypes";
+export * from "./utilityTypes/internal";
+export * from "./utilityTypes/primitive";
+export * from "./utilityTypes/snakeCasedPropertiesDeep";
+export * from "./utilityTypes/splitWords";
+export * from "./utilityTypes/trim";
+export * from "./utilityTypes/unknownArray";
 
 // utils
-export * from './utils/snakeToCamelTransformer';
-export * from './utils/stringToFulfillmentDisplayStatusEnumValue';
+export * from "./utils/snakeToCamelTransformer";
+export * from "./utils/stringToFulfillmentDisplayStatusEnumValue";
 
 // validators
-export * from './validators/validateGraphQLColorsConfig';
-export * from './validators/validateGraphQLFrontendConfig';
-export * from './validators/validateGraphQLOrgId';
-export * from './validators/validateMobilePLPChatPlacementParameter';
-export * from './validators/validateOrganizationConfig';
-export * from './validators/validateOrgConfigResults';
-export * from './validators/validateResponse';
-export * from './validators/validateSuggestion';
-export * from './validators/validateUserEvent';
+export * from "./validators/validateGraphQLColorsConfig";
+export * from "./validators/validateGraphQLFrontendConfig";
+export * from "./validators/validateGraphQLOrgId";
+export * from "./validators/validateMobilePLPChatPlacementParameter";
+export * from "./validators/validateOrganizationConfig";
+export * from "./validators/validateOrgConfigResults";
+export * from "./validators/validateResponse";
+export * from "./validators/validateSuggestion";
+export * from "./validators/validateUserEvent";
+
+// variantInfo
+export * from "./variantInfo";
+export * from "./variantInfo/pageVisitInfo";
+export * from "./variantInfo/plpInfo";
+export * from "./variantInfo/productInfo";

package/src/application/models/localStorageEventListener.ts

@@ -0,0 +1,4 @@
+export type LocalStorageEventListener = {
+  storageKey: string;
+  listener: (event: StorageEvent) => void;
+};

package/src/{types/Message.ts → application/models/message.ts}

@@ -1,40 +1,36 @@
+import { CustServiceAttachment, FormType } from '@spiffy-ai/commerce-api-client';
 import {
-  ApiCustServiceAttachment,
-  ApiFormType,
-  TextResponseAttributes,
+  OrderResponseAttributes,
+  ProductResponseAttributes,
   ReviewResponseAttributes,
   PageResponseAttributes,
+  TextResponseAttributes,
   SearchResponseAttributes,
   SearchProductResponseAttributes,
-  SearchProductFilterAttributes,
   AcceptableFormFieldType,
-  OrderResponseAttributes,
-  ProductResponseAttributes,
-} 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.
+  SearchProductFilterAttributes,
+} from './api/response';
 
 export enum MessageRole {
-  User = "user",
-  Assistant = "assistant",
+  User = 'user',
+  Assistant = 'assistant',
 }
 
 export enum MessageType {
-  Text = "text",
-  SuggestionClicked = "suggestion_clicked",
-  Product = "product",
-  ProductSearch = "product_search",
-  Review = "review",
-  QueryTyped = "query_typed",
-  Separator = "separator",
-  Page = "page",
-  Search = "search",
-  Attachment = "attachment",
-  CXAgentResponse = "cx_agent_response",
-  Form = "form",
-  Order = "order",
-  ProductSearchFilter = "product_search_filter",
+  Text = 'text',
+  SuggestionClicked = 'suggestion_clicked',
+  Product = 'product',
+  ProductSearch = 'product_search',
+  Review = 'review',
+  QueryTyped = 'query_typed',
+  Separator = 'separator',
+  Page = 'page',
+  Search = 'search',
+  Attachment = 'attachment',
+  CXAgentResponse = 'cx_agent_response',
+  Form = 'form',
+  Order = 'order',
+  ProductSearchFilter = 'product_search_filter',
 }
 
 export type Message = {
@@ -62,7 +58,7 @@ type AttachmentMetadata = {
   type: MessageType.Attachment;
   metadata: {
     message?: string;
-    attachment: ApiCustServiceAttachment[];
+    attachment: CustServiceAttachment[];
   };
 };
 
@@ -76,12 +72,12 @@ type CXAgentResponseMetadata = {
 
 type TextMessageMetadata = {
   type: MessageType.Text;
-  metadata: TextResponseAttributes["attributes"];
+  metadata: TextResponseAttributes['attributes'];
 };
 
 type QueryTypedMetadata = {
   type: MessageType.QueryTyped;
-  metadata: TextResponseAttributes["attributes"];
+  metadata: TextResponseAttributes['attributes'];
 };
 
 type SuggestionMessageMetadata = {
@@ -94,17 +90,17 @@ type SuggestionMessageMetadata = {
 
 export type ProductMessageMetadata = {
   type: MessageType.Product;
-  metadata: ProductResponseAttributes["attributes"];
+  metadata: ProductResponseAttributes['attributes'];
 };
 
 export type ProductSearchMessageMetadata = {
   type: MessageType.ProductSearch;
-  metadata: SearchProductResponseAttributes["attributes"];
+  metadata: SearchProductResponseAttributes['attributes'];
 };
 
 type ReviewMessageMetadata = {
   type: MessageType.Review;
-  metadata: ReviewResponseAttributes["attributes"];
+  metadata: ReviewResponseAttributes['attributes'];
 };
 
 type SeparatorMessageMetadata = {
@@ -113,17 +109,17 @@ type SeparatorMessageMetadata = {
 
 type PageMessageMetadata = {
   type: MessageType.Page;
-  metadata: PageResponseAttributes["attributes"];
+  metadata: PageResponseAttributes['attributes'];
 };
 
 type SearchMessageMetadata = {
   type: MessageType.Search;
-  metadata: SearchResponseAttributes["attributes"];
+  metadata: SearchResponseAttributes['attributes'];
 };
 
 type ProductSearchFilterMetadata = {
   type: MessageType.ProductSearchFilter;
-  metadata: SearchProductFilterAttributes["attributes"];
+  metadata: SearchProductFilterAttributes['attributes'];
 };
 
 export type FormField = {
@@ -132,19 +128,19 @@ export type FormField = {
   type: AcceptableFormFieldType;
   required: boolean;
   // this is the only format we currently support
-  format?: "email";
+  format?: 'email';
   value?: string;
 };
 
 type FormMessageMetadata = {
   type: MessageType.Form;
   metadata: {
-    formType?: ApiFormType;
+    formType?: FormType;
     fields: FormField[];
   };
 };
 
 type OrderMessageMetadata = {
   type: MessageType.Order;
-  metadata: OrderResponseAttributes["attributes"];
+  metadata: OrderResponseAttributes['attributes'];
 };

package/src/application/models/mobilePLPChatPlacementParameter.ts

@@ -0,0 +1,3 @@
+export interface MobilePLPChatPlacementParameter {
+  rowIndex: number;
+}

package/src/application/models/orgsEnum.ts

@@ -0,0 +1,36 @@
+export const OrgShortName = {
+  Coterie: 'coterie',
+  ForLoveAndLemons: 'for-love-and-lemons',
+  Greenpan: 'greenpan',
+  JordanCraig: 'jordan-craig',
+  LarryAndSerges: 'larry_and_serges',
+  LeapsAndRebounds: 'leaps-and-rebounds',
+  MantraBrand: 'mantra-brand',
+  Spanx: 'spanx',
+  SpanxStaging: 'staging-spanx',
+  Supergoop: 'supergoop',
+  UniqueVintage: 'unique-vintage',
+  JackArcher: 'jack-archer',
+  /* -- Below items are generated by plop -- */
+  SkinPerfection: 'skin-perfection',
+  LookOptic: 'look-optic',
+  FiveCbd: 'five-cbd',
+  SnapSupplements: 'snap-supplements',
+  Longevityrx: 'longevityrx',
+  VenaCbd: 'vena-cbd',
+  Medterra: 'medterra',
+  Modells: 'modells',
+  PressedFloral: 'pressed-floral',
+  KindredBravely: 'kindred-bravely',
+  WineEnthusiast: 'wine-enthusiast',
+  HomegrownCannabis: 'homegrown-cannabis',
+  DreamlandBaby: 'dreamland-baby',
+  Bandolier: 'bandolier',
+  WestonJonBoucher: 'weston-jon-boucher',
+  KutFromTheKloth: 'kut-from-the-kloth',
+  GrooveLife: 'groove-life',
+  Carpe: 'carpe',
+  WolfTactical: 'wolf-tactical',
+  WolfMattress: 'wolfmattress',
+  Default: 'default',
+} as const;

package/src/application/models/productExperiment.ts

@@ -0,0 +1,5 @@
+export enum ProductExperiment {
+  // Default is only used to ensure that the enum is non-empty, otherwise
+  // callers that try to use this enum will generate a typescript error
+  Default = 'default',
+}

package/src/application/models/spanxTakeAQuizCtaParameter.ts

@@ -0,0 +1,4 @@
+export interface SpanxTakeAQuizCtaParameter {
+  text?: string;
+  value?: string;
+}

package/src/application/models/spiffyWidgets.ts

@@ -0,0 +1,16 @@
+/**
+ * Enum of all widget names. These are widgets that are rendered and integrated into
+ * a merchant's website.
+ */
+export enum SpiffyWidgets {
+  ImageBanner = 'image_banner',
+  ImagePromptCard = 'image_prompt_card',
+  SingleImagePrompt = 'single_image_prompt',
+  EmbeddedWidget = 'embedded_widget',
+  FloatingButton = 'floating_button',
+  SuggestionBar = 'suggestion_bar',
+  SearchPrompt = 'search_prompt',
+  GlobalSearch = 'global_search',
+  SearchResults = 'search_results',
+  GlobalSearchEntryPoint = 'global_search_entry_point',
+}