@envive-ai/react-hooks 0.1.0

package/src/application/models/cachedValue.ts

@@ -0,0 +1,8 @@
+interface CachedValue {
+  value: unknown;
+  expiry: number;
+}
+
+export type {
+  CachedValue
+}

package/src/application/models/chatElementDisplayLocation.ts

@@ -0,0 +1,22 @@
+// Chat element display location enum
+export enum ChatElementDisplayLocation {
+  IN_CHAT = 'in_chat',
+  CHAT_PREVIEW = 'chat_preview',
+  FLOATING_BUTTON = 'floating_button',
+  HELP_ME_CHOOSE = 'help_me_choose',
+  PLP_IMAGE_BANNER = 'plp_image_banner',
+  TOP_REVIEWS_SNIPPET = 'top_reviews_snippet',
+  BOTTOM_REVIEWS_SNIPPET = 'bottom_reviews_snippet',
+  BLOCK_BACK_BUTTON = 'block_back_button',
+  SWITCH_TO_AGENT = 'switch_to_agent',
+  CONVERSATIONAL_SEARCH = 'conversational_search',
+  GLOBAL_SEARCH_ENTRYPOINT = 'global_search_entrypoint',
+  SEARCH_NAV_ENTRYPOINT = 'search_nav_entrypoint',
+  SEARCH_PROMPT = 'search_prompt',
+  SEARCH_PROMPT_BUTTON = 'search_prompt_button',
+  PRODUCT_GRID = 'product_grid',
+  UNSPECIFIED = 'unspecified',
+  FILTER_MODAL = 'filter_modal',
+  PROMPT_CARD = 'prompt_card',
+  WINDOW_API_CALL = 'window_api_call',
+}

package/src/application/models/clientDetails.ts

@@ -0,0 +1,18 @@
+interface ClientDetails {
+  os?: string;
+  osVersion?: string;
+  deviceBrand?: string;
+  deviceManufacturer?: string;
+  deviceModel?: string;
+  carrier?: string;
+  country?: string;
+  region?: string;
+  browser?: string;
+  browserVersion?: string;
+  browserIpAddress?: string;
+  userAgent?: string;
+}
+
+export type {
+  ClientDetails,
+};

package/src/application/models/colorsConfig.ts

@@ -0,0 +1,28 @@
+enum ColorNames {
+  TextPrimary = 'text-primary',
+  TextSecondary = 'text-secondary',
+  TextAccent = 'text-accent',
+  TextLink = 'text-link',
+  TextLight = 'text-light',
+  BackgroundPrimary = 'background-primary',
+  BackgroundSecondary = 'background-secondary',
+  BackgroundSecondaryDark = 'background-secondary-dark',
+  BackgroundTertiary = 'background-tertiary',
+  BackgroundDark = 'background-dark',
+  BackgroundLight = 'background-light',
+  BackgroundSaturated = 'background-saturated',
+  BorderLight = 'border-light',
+  BorderMedium = 'border-medium',
+  BorderDark = 'border-dark',
+  BorderOutline = 'border-outline',
+  AccentPrimary = 'accent-primary',
+  AccentSecondary = 'accent-secondary',
+}
+
+type ColorMapping = {
+  [key in ColorNames]: string;
+};
+
+const colorVar = (color: ColorNames): string => `var(--spiffy-colors-${color})`;
+export { ColorNames, colorVar };
+export type { ColorMapping };

package/src/application/models/conversationalSearchIds.ts

@@ -0,0 +1,5 @@
+export type ConversationalSearchIds = {
+  conversationalSearchEntrypointId?: string;
+  conversationalSearchInputId?: string;
+  conversationalSearchModalId?: string;
+};

package/src/application/models/dataLayer.ts

@@ -0,0 +1,45 @@
+/**
+ * Base interface for common properties across all ecommerce events
+ */
+export interface BaseEcommerceEvent {
+  event: string;
+  ecommerce: UAEcommerceData | GA4EcommerceData;
+}
+
+/**
+ * Legacy universal analytics data. The actual payload contains more fields, but we
+ * only need the ones listed below.
+ */
+interface UAEcommerceData {
+  add: {
+    products: {
+      name: string;
+      category: string;
+      price: string;
+      quantity: string;
+    }[];
+    currencyCode: string;
+  };
+}
+
+/**
+ * Google Analytics 4 data. The actual payload contains more fields, but we
+ * only need the ones listed below.
+ */
+interface GA4EcommerceData {
+  currency: string;
+  items: {
+    item_name: string;
+    item_category: string;
+    price: number;
+    quantity: number;
+  }[];
+}
+
+export interface UAEcommerceEvent extends BaseEcommerceEvent {
+  ecommerce: UAEcommerceData;
+}
+
+export interface GA4EcommerceEvent extends BaseEcommerceEvent {
+  ecommerce: GA4EcommerceData;
+}

package/src/application/models/domMutationContinuation.ts

@@ -0,0 +1,7 @@
+enum DomMutationObserverContinuation {
+  CONTINUE = "CONTINUE",
+  EXECUTING = "EXECUTING",
+  STOP = "STOP",
+}
+
+export { DomMutationObserverContinuation };

package/src/application/models/domObservationStrategy.ts

@@ -0,0 +1,9 @@
+enum DomObservationStrategy {
+    MutationObserver = "MutationObserver",
+    Polling = "Polling",
+    None = "None"
+}
+
+export {
+  DomObservationStrategy
+}

package/src/application/models/events.ts

@@ -0,0 +1,5 @@
+// names of Spiffy specific HTML events
+export enum SpiffyEventName {
+  WidgetOpen = 'spiffy:widgetopen',
+  WidgetClose = 'spiffy:widgetclose',
+}

package/src/application/models/featureGates.ts

@@ -0,0 +1,23 @@
+export enum FeatureGates {
+  IsClientSessionEnabled = "is_client_session_enabled",
+  IsNewFeatureEnabled = "is_new_feature_enabled",
+  // IsFineTunedModel8b is defined here for the sole purpose of correlating events to a specific model in Amplitude
+  IsFineTunedModel8b = "is_fine_tuned_model_8b",
+  IsIntegratedCXEnabled = "is_integrated_cx_enabled",
+  // TODO: remove this once we've fully rolled out on non-shapewear pages
+  IsNonShapewearEnabled = "is_non_shapewear_enabled",
+  IsImageBannerEnabled = "is_image_banner_enabled",
+  IsOrderLookupEnabled = "is_order_lookup_enabled",
+  IsSummarizeReviewsEnabled = "is_summarize_reviews_enabled",
+  IsGlobalSearchEnabled = "is_global_search_enabled",
+  IsImagePromptEnabled = "is_image_prompt_enabled",
+  IsWatermarkEnabled = "is_watermark_enabled",
+  IsInferenceRegion0 = "is_inference_region_0",
+  IsGraphQLUIConfigsEnabled = "is_graphql_ui_configs_enabled",
+  IsGraphQLPageConfigsEnabled = "is_graphql_page_configs_enabled",
+  IsGraphQLComponentConfigsEnabled = "is_graphql_component_configs_enabled",
+  IsChatVariantEnabled = "is_chat_variant_enabled",
+  IsChatVariantAEnabled = "is_chat_variant_a_enabled",
+  IsChatVariantBEnabled = "is_chat_variant_b_enabled",
+  IsUserQueryAlwaysEnabled = "is_user_query_always_enabled",
+}

package/src/application/models/frontendConfig.ts

@@ -0,0 +1,14 @@
+import {
+  PageVariantConfig,
+  WidgetMountingConfig,
+  WidgetConfig,
+  OrgUIConfig,
+} from 'src/contexts/types';
+
+export interface FrontendConfig {
+  merchantOverrideCss?: string;
+  pageVariants?: PageVariantConfig[];
+  mountingConfigs?: Record<string, WidgetMountingConfig>;
+  widgetConfigs?: Record<string, WidgetConfig>;
+  uiConfigs?: Omit<OrgUIConfig, 'merchantOverrideCss'>;
+}

package/src/application/models/googleAnalyticsEvents.ts

@@ -0,0 +1,8 @@
+enum GoogleAnalyticsEvents {
+  ADD_TO_CART_v1 = 'add_to_cart',
+  ADD_TO_CART_v2 = 'addToCart',
+}
+
+export {
+  GoogleAnalyticsEvents
+}

package/src/application/models/graphql/index.ts

@@ -0,0 +1,2 @@
+export * from './queries/getMerchantFrontendConfigQuery';
+export * from './queries/getMerchantColorsQuery';

package/src/application/models/graphql/queries/getMerchantColorsQuery.ts

@@ -0,0 +1,37 @@
+import { configVersion } from 'src/adapters/spiffy/commerce/graphql';
+
+const getMerchantColorsQuery = () => `
+  query ($version: "${configVersion()}") {
+    me {
+      getProductsConfigByVersion(version: $version) {
+        colors {
+          values
+        }
+      }
+    }
+  }
+`;
+
+interface GetMerchantColorsQueryData {
+  accent_primary: string;
+  accent_secondary: string;
+  background_dark: string;
+  background_light: string;
+  background_primary: string;
+  background_saturated: string;
+  background_secondary: string;
+  background_secondary_dark: string;
+  background_tertiary: string;
+  border_dark: string;
+  border_light: string;
+  border_medium: string;
+  border_outline: string;
+  text_accent: string;
+  text_light: string;
+  text_link: string;
+  text_primary: string;
+  text_secondary: string;
+}
+
+export { getMerchantColorsQuery };
+export type { GetMerchantColorsQueryData };

package/src/application/models/graphql/queries/getMerchantFrontendConfigQuery.ts

@@ -0,0 +1,103 @@
+import { configVersion } from 'src/adapters/spiffy/commerce/graphql';
+
+const getMerchantFrontendConfigQuery = () => `
+  query ($version: "${configVersion()}") {
+    me {
+      getProductsConfigByVersion(version: $version) {
+        frontend {
+          values
+        }
+      }
+    }
+  }
+`;
+
+type MountingConfigQueryData = {
+  mounting_config_id?: string;
+  container_id?: string;
+  check_id?: string;
+  parent_insertion_point?: {
+    selector?: string;
+    selection_index?: number;
+    insertion_type?: string;
+  };
+  insertion_point?: {
+    selector?: string;
+    selection_index?: number;
+    insertion_type?: string;
+  };
+  grid_insertion_type?: string;
+  wrapping_element?: {
+    class_name?: string;
+    element?: string;
+    insertion_type?: string;
+  };
+  div_check_selector?: string;
+  suppression_selector?: string;
+  style?: Record<string, string | number>;
+  class_name?: string;
+  data_attributes?: Record<string, string>;
+};
+
+type WidgetConfigQueryData = {
+  widget_config_id: string;
+  type: string;
+  content_id?: string;
+  // Widget-specific configuration fields will be stored as generic Record
+  // since each widget type has different configuration structure
+  [key: string]: unknown;
+};
+
+type PageVariantCheckQueryData = {
+  check_type: string;
+  [key: string]: unknown;
+};
+
+type WidgetMountingQueryData = {
+  mounting_config_id: string;
+  widget_config_id?: string;
+  mounting_point_widgets?: Array<{
+    checks: PageVariantCheckQueryData[];
+    widget_config_id: string;
+  }>;
+};
+
+type PageVariantQueryData = {
+  variant_id: string;
+  variant_type: string;
+  variant_checks: PageVariantCheckQueryData[];
+  widget_mounting: WidgetMountingQueryData[];
+  plp_id_extractor?: string;
+  product_id_extractor?: string;
+  parent_product_id_extractor?: string;
+};
+
+type UIConfigQueryData = {
+  shortName: string;
+  [key: string]: unknown;
+};
+
+interface GetMerchantFrontendConfigQueryData {
+  merchant_override_css?: string;
+  page_variants?: PageVariantQueryData[];
+  mounting_configs?: {
+    key: string;
+    config: MountingConfigQueryData;
+  }[];
+  widget_configs?: {
+    key: string;
+    config: WidgetConfigQueryData;
+  }[];
+  ui_configs?: UIConfigQueryData;
+}
+
+export { getMerchantFrontendConfigQuery };
+export type {
+  GetMerchantFrontendConfigQueryData,
+  MountingConfigQueryData,
+  WidgetConfigQueryData,
+  PageVariantQueryData,
+  PageVariantCheckQueryData,
+  WidgetMountingQueryData,
+  UIConfigQueryData,
+};

package/src/application/models/graphql/queries/getMerchantOrgIdQuery.ts

@@ -0,0 +1,11 @@
+const getMerchantOrgIdQuery = `
+  query {
+    me {
+      org {
+        id
+      }
+    }
+  }
+`;
+
+export { getMerchantOrgIdQuery };

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

@@ -0,0 +1,12 @@
+export * from './isApiPDPEventAttributes';
+export * from './isApiQueryTypedEventAttributes';
+export * from './isApiResponse';
+export * from './isApiProductResponseAttributes';
+export * from './isApiReviewResponseAttributes';
+export * from './isApiReviewRichInformation';
+export * from './isApiSearchEventAttributes';
+export * from './isApiSuggestion';
+export * from './isApiSuggestionClickedEventAttributes';
+export * from './isApiTextResponseAttributes';
+export * from './isApiUserEvent';
+export * from './isApiProductSearchAttributes';

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

@@ -0,0 +1,90 @@
+import Logger from 'src/application/logging/logger';
+import { FormType } from '@spiffy-ai/commerce-api-client';
+import { ApiFormResponseAttributes } from 'src/application/models/api/responseGenerics';
+import { hasPropertyOfType } from 'src/application/models/guards/utils';
+
+/**
+ * Type guard to check if the provided data has the all of the properties (with the correct types) of
+ * a FormResponseAttribute
+ *
+ * @param data - The data to check
+ *
+ * @returns true if the data has the correct properties, false otherwise
+ */
+export const isApiFormResponseAttributes = (data: unknown): data is ApiFormResponseAttributes => {
+  if (data == null || typeof data !== 'object') {
+    Logger.logError('isApiFormResponseAttributes: data is null or not an object', undefined, {
+      data,
+    });
+    return false;
+  }
+
+  if ('form_category' in data && typeof data.form_category !== 'object') {
+    Logger.logError('isApiFormResponseAttributes: form_category is not an object', undefined, {
+      data,
+    });
+    return false;
+  }
+
+  if ('form_category' in data && typeof data.form_category === 'object') {
+    if (
+      !hasPropertyOfType(data.form_category, 'form_type', 'string') ||
+      !Object.values(FormType).includes(data.form_category.form_type as FormType)
+    ) {
+      Logger.logError(
+        'isApiFormResponseAttributes: form_type is missing or not a valid form type',
+        undefined,
+        {
+          data,
+        },
+      );
+      return false;
+    }
+  }
+
+  if (!hasPropertyOfType(data, 'schema', 'object')) {
+    Logger.logError('isApiFormResponseAttributes: schema is missing or not an object', undefined, {
+      data,
+    });
+    return false;
+  }
+
+  // TODO: also wanna validate the fields of data.schema.properties but might wanna change the schema
+  // to not have the property name as a key in the object
+  if (!hasPropertyOfType(data.schema, 'properties', 'object')) {
+    Logger.logError(
+      'isApiFormResponseAttributes: schema.properties is missing or not an object',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (!hasPropertyOfType(data.schema, 'required', 'array')) {
+    Logger.logError(
+      'isApiFormResponseAttributes: schema.required is missing or not an array',
+      undefined,
+      { data },
+    );
+    return false;
+  }
+
+  if (
+    !data.schema.required.every(
+      (key: unknown) => typeof key === 'string' && key in data.schema.properties,
+    )
+  ) {
+    Logger.logError(
+      'isApiFormResponseAttributes: schema.required contains invalid property keys',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  return true;
+};

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

@@ -0,0 +1,37 @@
+import Logger from 'src/application/logging/logger';
+import { FormSubmittedAttributes, FormType } from '@spiffy-ai/commerce-api-client';
+import { hasPropertyOfType } from 'src/application/models/guards/utils';
+
+export const isApiFormSubmittedResponseAttributes = (
+  data: unknown,
+): data is FormSubmittedAttributes => {
+  if (data == null || typeof data !== 'object') {
+    Logger.logError('isApiFormSubmittedResponseAttributes', 'data is null or not an object', data);
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'filled_schema', 'object')) {
+    Logger.logError('isApiFormSubmittedResponseAttributes', 'filled_schema is not an object', data);
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'form_response_id', 'string')) {
+    Logger.logError(
+      'isApiFormSubmittedResponseAttributes',
+      'form_response_id is not a string',
+      data,
+    );
+    return false;
+  }
+
+  if (!('form_type' in data) || !Object.values(FormType).includes(data.form_type as FormType)) {
+    Logger.logError(
+      'isApiFormSubmittedResponseAttributes',
+      'form_type is not a valid form type enum',
+      data,
+    );
+    return false;
+  }
+
+  return true;
+};

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

@@ -0,0 +1,155 @@
+import Logger from 'src/application/logging/logger';
+import { OrderItemInfo, OrderResponseAttributes } from '@spiffy-ai/commerce-api-client';
+import { hasPropertyOfType } from 'src/application/models/guards/utils';
+
+// the client SDK generates date-time format types as `Date` but the openapi typescript generator
+// does not correctly deserialize date-time values so they are always `string` at runtime instead of
+// `Date` objects. These interfaces override the SDK types so that we can validate against the actual
+// `string` values. https://github.com/OpenAPITools/openapi-generator/issues/926
+export interface ApiOrderItemInfo
+  extends Omit<OrderItemInfo, 'delivered_at' | 'estimated_delivery_at' | 'in_transit_at'> {
+  delivered_at?: string;
+  estimated_delivery_at?: string;
+  in_transit_at?: string;
+}
+
+export interface ApiOrderResponseAttributes
+  extends Omit<OrderResponseAttributes, 'created_at' | 'latest_event_date' | 'line_items'> {
+  created_at: string;
+  latest_event_date: string;
+  line_items: ApiOrderItemInfo[];
+}
+
+const isApiOrderItemInfo = (data: unknown): data is ApiOrderItemInfo => {
+  if (data == null || typeof data !== 'object') {
+    Logger.logError('OrderItemInfo must be an object', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'order_item_id', 'string')) {
+    Logger.logError('OrderItemInfo must have an order_item_id property', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'item_title', 'string')) {
+    Logger.logError('OrderItemInfo must have an item_title property', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'item_price', 'number')) {
+    Logger.logError('OrderItemInfo must have an item_price property', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'item_quantity', 'number')) {
+    Logger.logError('OrderItemInfo must have an item_quantity property', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'image', 'string', true)) {
+    Logger.logError('OrderItemInfo.image must be a string or null', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'fulfillment_display_status', 'string', true)) {
+    Logger.logError(
+      'OrderItemInfo.fulfillment_display_status must be a string or null',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'tracking_url', 'string', true)) {
+    Logger.logError('OrderItemInfo.tracking_url must be a string or null', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'delivered_at', 'string', true)) {
+    Logger.logError('OrderItemInfo.delivered_at must be a string or null', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'estimated_delivery_at', 'string', true)) {
+    Logger.logError('OrderItemInfo.estimated_delivery_at must be a string or null', undefined, {
+      data,
+    });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'in_transit_at', 'string', true)) {
+    Logger.logError('OrderItemInfo.in_transit_at must be a string or null', undefined, { data });
+    return false;
+  }
+
+  return true;
+};
+
+export const isApiOrderResponseAttributes = (data: unknown): data is ApiOrderResponseAttributes => {
+  if (data == null || typeof data !== 'object') {
+    Logger.logError('Order response attributes must be an object', undefined, { data });
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'created_at', 'string')) {
+    Logger.logError(
+      'Order response attributes must have a created_at property and have type string',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'latest_event_date', 'string')) {
+    Logger.logError(
+      'Order response attributes must have a latest_event_date property and have type string',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (
+    !hasPropertyOfType(data, 'line_items', 'array') ||
+    !data.line_items.every((item: unknown) => isApiOrderItemInfo(item))
+  ) {
+    Logger.logError(
+      'Order response attributes must have a line_items property with at least one order item',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'order_id', 'string')) {
+    Logger.logError(
+      'Order response attributes must have an order_id property and have type string',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  if (!hasPropertyOfType(data, 'order_number', 'string')) {
+    Logger.logError(
+      'Order response attributes must have an order_number property and have type string',
+      undefined,
+      {
+        data,
+      },
+    );
+    return false;
+  }
+
+  return true;
+};