@envive-ai/react-hooks 0.2.6-alpha-marlo.0 → 0.2.6-alpha-arthur-4

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

@@ -1,4 +1,4 @@
-import { configVersion } from "src/types/config-versions";
+import { configVersion } from '../../../../util/configVersion';
 
 const getMerchantFrontendConfigQuery = () => `
   query ($version: "${configVersion()}") {
@@ -12,92 +12,4 @@ const getMerchantFrontendConfigQuery = () => `
   }
 `;
 
-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/guards/api/isApiFormResponse.ts

@@ -1,7 +1,7 @@
-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';
+import Logger from 'src/application/logging/logger';
+import { hasPropertyOfType } from '../utils';
+import { FormResponseAttributes } from '@envive-ai/types';
 
 /**
  * Type guard to check if the provided data has the all of the properties (with the correct types) of
@@ -11,7 +11,7 @@ import { hasPropertyOfType } from 'src/application/models/guards/utils';
  *
  * @returns true if the data has the correct properties, false otherwise
  */
-export const isApiFormResponseAttributes = (data: unknown): data is ApiFormResponseAttributes => {
+export const isApiFormResponseAttributes = (data: unknown): data is FormResponseAttributes => {
   if (data == null || typeof data !== 'object') {
     Logger.logError('isApiFormResponseAttributes: data is null or not an object', undefined, {
       data,

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

@@ -1,6 +1,6 @@
-import Logger from 'src/application/logging/logger';
 import { FormSubmittedAttributes, FormType } from '@spiffy-ai/commerce-api-client';
-import { hasPropertyOfType } from 'src/application/models/guards/utils';
+import Logger from 'src/application/logging/logger';
+import { hasPropertyOfType } from '../utils';
 
 export const isApiFormSubmittedResponseAttributes = (
   data: unknown,

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

@@ -1,24 +1,6 @@
+import type { ApiOrderItemInfo, ApiOrderResponseAttributes } from '@envive-ai/types';
 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[];
-}
+import { hasPropertyOfType } from '../utils';
 
 const isApiOrderItemInfo = (data: unknown): data is ApiOrderItemInfo => {
   if (data == null || typeof data !== 'object') {

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

@@ -1,4 +1,3 @@
-import Logger from 'src/application/logging/logger';
 import {
   StatsigExperiment as ApiOrgConfigExperiment,
   StatsigFeatureGate as ApiOrgConfigFeatureGate,
@@ -6,14 +5,9 @@ import {
   Organization as ApiOrganization,
   OrganizationStatusEnum,
 } from '@spiffy-ai/commerce-api-client';
-import { ApiOrganizationConfig, isApiOrganizationConfig } from './isApiOrganizationConfig';
-
-interface ApiOrgConfigResults {
-  configs: ApiOrganizationConfig[];
-  experiments: ApiOrgConfigExperiment[];
-  gates: ApiOrgConfigFeatureGate[];
-  org: ApiOrgConfigOrganizationSettings;
-}
+import { ApiOrgConfigResults } from '@envive-ai/types';
+import { isApiOrganizationConfig } from './isApiOrganizationConfig';
+import Logger from 'src/application/logging/logger';
 
 const isApiOrgConfigExperiment = (data: unknown): data is ApiOrgConfigExperiment => {
   if (data == null || typeof data !== 'object') {

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

@@ -1,32 +1,11 @@
+import type {
+  ApiOrgAnalyticsConfigAmplitude,
+  ApiOrgAnalyticsConfigCustomerService,
+  ApiOrgAnalyticsConfigGoogleAnalytics,
+  ApiOrgAnalyticsConfig,
+  ApiOrganizationConfig,
+} from '@envive-ai/types';
 import Logger from 'src/application/logging/logger';
-import { OrganizationConfig } from '@spiffy-ai/commerce-api-client';
-
-// the "config" property is a generic object in the commerce api spec, these interfaces
-// are used to validate the structure of that object and to transform the api response
-// into a typed object for the frontend. Do not use these interfaces for anything else.
-interface ApiOrgAnalyticsConfigAmplitude {
-  session_replay_enabled: boolean;
-  session_replay_sample_rate: number;
-  tracking_enabled: boolean;
-}
-
-interface ApiOrgAnalyticsConfigCustomerService {
-  provider: string;
-}
-
-interface ApiOrgAnalyticsConfigGoogleAnalytics {
-  measurement_id: string;
-}
-
-interface ApiOrgAnalyticsConfig {
-  amplitude?: ApiOrgAnalyticsConfigAmplitude;
-  customer_service?: ApiOrgAnalyticsConfigCustomerService;
-  google_analytics?: ApiOrgAnalyticsConfigGoogleAnalytics;
-}
-
-export interface ApiOrganizationConfig extends OrganizationConfig {
-  config: ApiOrgAnalyticsConfig;
-}
 
 const isApiOrgAnalyticsConfigAmplitude = (
   data: unknown,
@@ -121,10 +100,7 @@ const isApiOrgAnalyticsConfig = (data: unknown): data is ApiOrgAnalyticsConfig =
     return false;
   }
 
-  if (
-    'amplitude' in data &&
-    !isApiOrgAnalyticsConfigAmplitude(data.amplitude)
-  ) {
+  if ('amplitude' in data && !isApiOrgAnalyticsConfigAmplitude(data.amplitude)) {
     Logger.logDebug('[spiffy-ai] isOrgAnalyticsConfig: amplitude is not an object', data);
     return false;
   }

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

@@ -1,19 +1,22 @@
-import { PDPAttributes } from '@spiffy-ai/commerce-api-client';
+import { PDPAttributes } from "@spiffy-ai/commerce-api-client";
 
 export const isApiPDPAttributes = (data: unknown): data is PDPAttributes => {
-  if (data == null || typeof data !== 'object') {
+  if (data == null || typeof data !== "object") {
     return false;
   }
 
-  if (!('product_id' in data) || typeof data.product_id !== 'string') {
+  if (!("product_id" in data) || typeof data.product_id !== "string") {
     return false;
   }
 
-  if ('parent_product_id' in data && typeof data.parent_product_id !== 'string') {
+  if (
+    "parent_product_id" in data &&
+    typeof data.parent_product_id !== "string"
+  ) {
     return false;
   }
 
-  if ('url' in data && data.url != null && typeof data.url !== 'string') {
+  if ("url" in data && data.url != null && typeof data.url !== "string") {
     return false;
   }
 

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

@@ -2,36 +2,40 @@ import {
   PLPAttributeCategory,
   PLPAttributes,
   PLPIdAttributes,
-} from '@spiffy-ai/commerce-api-client';
+} from "@spiffy-ai/commerce-api-client";
 
 export const isApiPLPIdAttribute = (data: unknown): data is PLPIdAttributes => {
-  if (data == null || typeof data !== 'object') {
+  if (data == null || typeof data !== "object") {
     return false;
   }
 
-  if (!('id' in data) || typeof data.id !== 'string') {
+  if (!("id" in data) || typeof data.id !== "string") {
     return false;
   }
 
   return true;
 };
 
-export const isApiPLPEventAttributes = (data: unknown): data is PLPAttributes => {
-  if (data == null || typeof data !== 'object') {
+export const isApiPLPEventAttributes = (
+  data: unknown
+): data is PLPAttributes => {
+  if (data == null || typeof data !== "object") {
     return false;
   }
 
   if (
-    !('category' in data) ||
-    typeof data.category !== 'string' ||
-    !Object.values(PLPAttributeCategory).includes(data.category as PLPAttributeCategory)
+    !("category" in data) ||
+    typeof data.category !== "string" ||
+    !Object.values(PLPAttributeCategory).includes(
+      data.category as PLPAttributeCategory
+    )
   ) {
     return false;
   }
 
   if (
-    !('attributes' in data) ||
-    typeof data.attributes !== 'object' ||
+    !("attributes" in data) ||
+    typeof data.attributes !== "object" ||
     !isApiPLPIdAttribute(data.attributes)
   ) {
     return false;

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

@@ -1,4 +1,4 @@
-import { ApiPageResponseAttributes } from 'src/application/models/api/responseGenerics';
+import { ApiPageResponseAttributes } from '@envive-ai/types';
 
 export const isApiPageResponseAttributes = (obj: unknown): obj is ApiPageResponseAttributes => {
   if (obj == null || typeof obj !== 'object') {

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

@@ -1,6 +1,6 @@
-import Logger from 'src/application/logging/logger';
 import { ResponseProductAttributes } from '@spiffy-ai/commerce-api-client';
 import { hasPropertyOfType } from '../utils';
+import Logger from 'src/application/logging/logger';
 
 export const isApiProductResponseAttributes = (
   attributes: unknown,
@@ -23,9 +23,7 @@ export const isApiProductResponseAttributes = (
     return false;
   }
 
-  if (
-    !hasPropertyOfType(attributes, 'image_url', 'string', true)
-  ) {
+  if (!hasPropertyOfType(attributes, 'image_url', 'string', true)) {
     Logger.logError('isApiProductResponseAttributes: image_url is not a string', undefined, {
       attributes,
     });

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

@@ -1,20 +1,23 @@
-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,13 +1,16 @@
-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,4 +1,9 @@
-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,37 +1,44 @@
-import Logger from 'src/application/logging/logger';
-import { Response, ResponseCategory } from '@spiffy-ai/commerce-api-client';
-import { hasPropertyOfType } from 'src/application/models/guards/utils';
+import { ResponseCategory } from "@spiffy-ai/commerce-api-client";
+import Logger from "src/application/logging/logger";
+import { hasPropertyOfType } from "../utils";
+import { ApiResponse } from "src/types";
 
-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 });
+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,
+    });
     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 'src/application/models/api/responseGenerics';
+import { ApiReviewResponseAttributes } from '@envive-ai/types';
 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 'src/application/models/api/responseGenerics';
+import { ApiReviewRichInformation } from '@envive-ai/types';
 
 export const isApiReviewRichInformation = (
   richInfo: unknown,

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

@@ -1,4 +1,4 @@
-import { ApiTextResponseAttributes } from 'src/application/models/api/responseGenerics';
+import { ApiTextResponseAttributes } from '@envive-ai/types';
 
 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,5 +1,4 @@
-import type { BaseEcommerceEvent } from 'src/application/models';
-
+import { BaseEcommerceEvent } from '@envive-ai/types';
 /**
  * Checks if an event is a base Google Analytics ecommerce event.
  *

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

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

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

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

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

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

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

@@ -1,4 +1,6 @@
-import { SpanxTakeAQuizCtaParameter } from '../spanxTakeAQuizCtaParameter';
-
+interface SpanxTakeAQuizCtaParameter {
+  text?: string;
+  value?: string;
+}
 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,5 +1,10 @@
+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 &&