@envive-ai/react-hooks 0.3.18 → 0.3.19-alpha-marlo-0

package/src/application/logging/logger.ts

@@ -1,20 +1,45 @@
 /* eslint-disable no-console */
 
 class Logger {
-  static logInfo(message: string, ...args: unknown[]): void {
-    console.info(`INFO: ${message}`, ...args);
+  private readonly caller: string;
+
+  /* Creates a new Logger instance.
+   * @param caller - The caller of the logger.
+   */
+  constructor(caller: string) {
+    this.caller = caller;
+  }
+
+  static getTimestamp(): string {
+    return new Date().toISOString();
+  }
+
+  logInfo(message: string, ...args: unknown[]): void {
+    console.info(
+      `INFO: [envive-ai] ${Logger.getTimestamp()} - ${this.caller} - ${message}`,
+      ...args,
+    );
   }
 
-  static logDebug(message: string, ...args: unknown[]): void {
-    console.debug(`DEBUG: ${message}`, ...args);
+  logDebug(message: string, ...args: unknown[]): void {
+    console.debug(
+      `DEBUG: [envive-ai] ${Logger.getTimestamp()} - ${this.caller} - ${message}`,
+      ...args,
+    );
   }
 
-  static logError(message: string, error: unknown | undefined, ...args: unknown[]): void {
-    console.error(`ERROR: ${message} error=${error}`, args);
+  logError(message: string, error: unknown | undefined, ...args: unknown[]): void {
+    console.error(
+      `ERROR: [envive-ai] ${Logger.getTimestamp()} - ${this.caller} - ${message} error=${error}`,
+      args,
+    );
   }
 
-  static logWarn(message: string, error: unknown | undefined, ...args: unknown[]): void {
-    console.warn(`WARN: ${message} error=${error}`, args);
+  logWarn(message: string, error: unknown | undefined, ...args: unknown[]): void {
+    console.warn(
+      `WARN: [envive-ai] ${Logger.getTimestamp()} - ${this.caller} - ${message} error=${error}`,
+      args,
+    );
   }
 }
 

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

@@ -3,6 +3,8 @@ import { FormType } from '@spiffy-ai/commerce-api-client';
 import { ApiFormResponseAttributes } from 'src/application/models/api/responseGenerics';
 import { hasPropertyOfType } from 'src/application/models/guards/utils';
 
+const logger = new Logger('isApiFormResponse');
+
 /**
  * Type guard to check if the provided data has the all of the properties (with the correct types) of
  * a FormResponseAttribute
@@ -13,14 +15,14 @@ import { hasPropertyOfType } from 'src/application/models/guards/utils';
  */
 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, {
+    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, {
+    logger.logError('isApiFormResponseAttributes: form_category is not an object', undefined, {
       data,
     });
     return false;
@@ -31,7 +33,7 @@ export const isApiFormResponseAttributes = (data: unknown): data is ApiFormRespo
       !hasPropertyOfType(data.form_category, 'form_type', 'string') ||
       !Object.values(FormType).includes(data.form_category.form_type as FormType)
     ) {
-      Logger.logError(
+      logger.logError(
         'isApiFormResponseAttributes: form_type is missing or not a valid form type',
         undefined,
         {
@@ -43,7 +45,7 @@ export const isApiFormResponseAttributes = (data: unknown): data is ApiFormRespo
   }
 
   if (!hasPropertyOfType(data, 'schema', 'object')) {
-    Logger.logError('isApiFormResponseAttributes: schema is missing or not an object', undefined, {
+    logger.logError('isApiFormResponseAttributes: schema is missing or not an object', undefined, {
       data,
     });
     return false;
@@ -52,7 +54,7 @@ export const isApiFormResponseAttributes = (data: unknown): data is ApiFormRespo
   // 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(
+    logger.logError(
       'isApiFormResponseAttributes: schema.properties is missing or not an object',
       undefined,
       {
@@ -63,7 +65,7 @@ export const isApiFormResponseAttributes = (data: unknown): data is ApiFormRespo
   }
 
   if (!hasPropertyOfType(data.schema, 'required', 'array')) {
-    Logger.logError(
+    logger.logError(
       'isApiFormResponseAttributes: schema.required is missing or not an array',
       undefined,
       { data },
@@ -76,7 +78,7 @@ export const isApiFormResponseAttributes = (data: unknown): data is ApiFormRespo
       (key: unknown) => typeof key === 'string' && key in data.schema.properties,
     )
   ) {
-    Logger.logError(
+    logger.logError(
       'isApiFormResponseAttributes: schema.required contains invalid property keys',
       undefined,
       {

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

@@ -2,21 +2,23 @@ import Logger from 'src/application/logging/logger';
 import { FormSubmittedAttributes, FormType } from '@spiffy-ai/commerce-api-client';
 import { hasPropertyOfType } from 'src/application/models/guards/utils';
 
+const logger = new Logger('isApiFormSubmittedResponseAttributes');
+
 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);
+    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);
+    logger.logError('isApiFormSubmittedResponseAttributes', 'filled_schema is not an object', data);
     return false;
   }
 
   if (!hasPropertyOfType(data, 'form_response_id', 'string')) {
-    Logger.logError(
+    logger.logError(
       'isApiFormSubmittedResponseAttributes',
       'form_response_id is not a string',
       data,
@@ -25,7 +27,7 @@ export const isApiFormSubmittedResponseAttributes = (
   }
 
   if (!('form_type' in data) || !Object.values(FormType).includes(data.form_type as FormType)) {
-    Logger.logError(
+    logger.logError(
       'isApiFormSubmittedResponseAttributes',
       'form_type is not a valid form type enum',
       data,

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

@@ -2,6 +2,8 @@ import Logger from 'src/application/logging/logger';
 import { OrderItemInfo, OrderResponseAttributes } from '@spiffy-ai/commerce-api-client';
 import { hasPropertyOfType } from 'src/application/models/guards/utils';
 
+const logger = new Logger('isApiOrderResponseAttributes');
+
 // 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
@@ -26,37 +28,37 @@ export interface ApiOrderResponseAttributes extends Omit<
 
 const isApiOrderItemInfo = (data: unknown): data is ApiOrderItemInfo => {
   if (data == null || typeof data !== 'object') {
-    Logger.logError('OrderItemInfo must be an object', undefined, { data });
+    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 });
+    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 });
+    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 });
+    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 });
+    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 });
+    logger.logError('OrderItemInfo.image must be a string or null', undefined, { data });
     return false;
   }
 
   if (!hasPropertyOfType(data, 'fulfillment_display_status', 'string', true)) {
-    Logger.logError(
+    logger.logError(
       'OrderItemInfo.fulfillment_display_status must be a string or null',
       undefined,
       {
@@ -67,24 +69,24 @@ const isApiOrderItemInfo = (data: unknown): data is ApiOrderItemInfo => {
   }
 
   if (!hasPropertyOfType(data, 'tracking_url', 'string', true)) {
-    Logger.logError('OrderItemInfo.tracking_url must be a string or null', undefined, { data });
+    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 });
+    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, {
+    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 });
+    logger.logError('OrderItemInfo.in_transit_at must be a string or null', undefined, { data });
     return false;
   }
 
@@ -93,12 +95,12 @@ const isApiOrderItemInfo = (data: unknown): data is ApiOrderItemInfo => {
 
 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 });
+    logger.logError('Order response attributes must be an object', undefined, { data });
     return false;
   }
 
   if (!hasPropertyOfType(data, 'created_at', 'string')) {
-    Logger.logError(
+    logger.logError(
       'Order response attributes must have a created_at property and have type string',
       undefined,
       {
@@ -109,7 +111,7 @@ export const isApiOrderResponseAttributes = (data: unknown): data is ApiOrderRes
   }
 
   if (!hasPropertyOfType(data, 'latest_event_date', 'string')) {
-    Logger.logError(
+    logger.logError(
       'Order response attributes must have a latest_event_date property and have type string',
       undefined,
       {
@@ -123,7 +125,7 @@ export const isApiOrderResponseAttributes = (data: unknown): data is ApiOrderRes
     !hasPropertyOfType(data, 'line_items', 'array') ||
     !data.line_items.every((item: unknown) => isApiOrderItemInfo(item))
   ) {
-    Logger.logError(
+    logger.logError(
       'Order response attributes must have a line_items property with at least one order item',
       undefined,
       {
@@ -134,7 +136,7 @@ export const isApiOrderResponseAttributes = (data: unknown): data is ApiOrderRes
   }
 
   if (!hasPropertyOfType(data, 'order_id', 'string')) {
-    Logger.logError(
+    logger.logError(
       'Order response attributes must have an order_id property and have type string',
       undefined,
       {
@@ -145,7 +147,7 @@ export const isApiOrderResponseAttributes = (data: unknown): data is ApiOrderRes
   }
 
   if (!hasPropertyOfType(data, 'order_number', 'string')) {
-    Logger.logError(
+    logger.logError(
       'Order response attributes must have an order_number property and have type string',
       undefined,
       {

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

@@ -15,22 +15,20 @@ interface ApiOrgConfigResults {
   org: ApiOrgConfigOrganizationSettings;
 }
 
+const logger = new Logger('isApiOrgConfigResults');
+
 const isApiOrgConfigExperiment = (data: unknown): data is ApiOrgConfigExperiment => {
   if (data == null || typeof data !== 'object') {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigExperiment: data is not an object', undefined, {
+    logger.logDebug('isApiOrgConfigExperiment: data is not an object', undefined, {
       data,
     });
     return false;
   }
 
   if ('group' in data && typeof data.group !== 'string' && data.group !== undefined) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigExperiment: group is not a string or undefined',
-      undefined,
-      {
-        data,
-      },
-    );
+    logger.logDebug('isApiOrgConfigExperiment: group is not a string or undefined', undefined, {
+      data,
+    });
     return false;
   }
 
@@ -39,28 +37,28 @@ const isApiOrgConfigExperiment = (data: unknown): data is ApiOrgConfigExperiment
     typeof data.group_name !== 'string' &&
     data.group_name !== undefined
   ) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigExperiment: group_name is not a string', undefined, {
+    logger.logDebug('isApiOrgConfigExperiment: group_name is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if ('name' in data && typeof data.name !== 'string' && data.name !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigExperiment: name is not a string', undefined, {
+    logger.logDebug('isApiOrgConfigExperiment: name is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if ('rule_id' in data && typeof data.rule_id !== 'string' && data.rule_id !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigExperiment: rule_id is not a string', undefined, {
+    logger.logDebug('isApiOrgConfigExperiment: rule_id is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if ('value' in data && typeof data.value !== 'object' && data.value !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigExperiment: value is not an object', undefined, {
+    logger.logDebug('isApiOrgConfigExperiment: value is not an object', undefined, {
       data,
     });
     return false;
@@ -71,28 +69,28 @@ const isApiOrgConfigExperiment = (data: unknown): data is ApiOrgConfigExperiment
 
 const isApiOrgConfigFeatureGate = (data: unknown): data is ApiOrgConfigFeatureGate => {
   if (data == null || typeof data !== 'object') {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigFeatureGate: data is not an object', undefined, {
+    logger.logDebug('isApiOrgConfigFeatureGate: data is not an object', undefined, {
       data,
     });
     return false;
   }
 
   if ('name' in data && typeof data.name !== 'string' && data.name !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigFeatureGate: name is not a string', undefined, {
+    logger.logDebug('isApiOrgConfigFeatureGate: name is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if ('rule_id' in data && typeof data.rule_id !== 'string' && data.rule_id !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigFeatureGate: rule_id is not a string', undefined, {
+    logger.logDebug('isApiOrgConfigFeatureGate: rule_id is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if ('value' in data && typeof data.value !== 'boolean' && data.value !== undefined) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigFeatureGate: value is not a boolean', undefined, {
+    logger.logDebug('isApiOrgConfigFeatureGate: value is not a boolean', undefined, {
       data,
     });
     return false;
@@ -103,35 +101,35 @@ const isApiOrgConfigFeatureGate = (data: unknown): data is ApiOrgConfigFeatureGa
 
 const isApiOrganization = (data: unknown): data is ApiOrganization => {
   if (data == null || typeof data !== 'object') {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: data is not an object', undefined, {
+    logger.logDebug('isApiOrganization: data is not an object', undefined, {
       data,
     });
     return false;
   }
 
   if (!('id' in data) || typeof data.id !== 'string') {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: id is not a string', undefined, {
+    logger.logDebug('isApiOrganization: id is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if (!('display_name' in data) || typeof data.display_name !== 'string') {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: display_name is not a string', undefined, {
+    logger.logDebug('isApiOrganization: display_name is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if (!('domain' in data) || typeof data.domain !== 'string') {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: domain is not a string', undefined, {
+    logger.logDebug('isApiOrganization: domain is not a string', undefined, {
       data,
     });
     return false;
   }
 
   if (!('short_name' in data) || typeof data.short_name !== 'string') {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: short_name is not a string', undefined, {
+    logger.logDebug('isApiOrganization: short_name is not a string', undefined, {
       data,
     });
     return false;
@@ -141,8 +139,8 @@ const isApiOrganization = (data: unknown): data is ApiOrganization => {
     !('status' in data) ||
     !Object.values(OrganizationStatusEnum).includes(data.status as OrganizationStatusEnum)
   ) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrganization: status is not a valid OrganizationStatusEnum value',
+    logger.logDebug(
+      'isApiOrganization: status is not a valid OrganizationStatusEnum value',
       undefined,
       {
         data,
@@ -157,7 +155,7 @@ const isApiOrganization = (data: unknown): data is ApiOrganization => {
     typeof data.created_at !== 'string' &&
     data.created_at !== undefined
   ) {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: created_at is not a Date', undefined, {
+    logger.logDebug('isApiOrganization: created_at is not a Date', undefined, {
       data,
     });
     return false;
@@ -169,7 +167,7 @@ const isApiOrganization = (data: unknown): data is ApiOrganization => {
     typeof data.updated_at !== 'string' &&
     data.updated_at !== undefined
   ) {
-    Logger.logDebug('[spiffy-ai] isApiOrganization: updated_at is not a Date', undefined, {
+    logger.logDebug('isApiOrganization: updated_at is not a Date', undefined, {
       data,
     });
     return false;
@@ -182,24 +180,16 @@ const isApiOrgConfigOrganizationSettings = (
   data: unknown,
 ): data is ApiOrgConfigOrganizationSettings => {
   if (data == null || typeof data !== 'object') {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigOrganizationSettings: data is not an object',
-      undefined,
-      {
-        data,
-      },
-    );
+    logger.logDebug('isApiOrgConfigOrganizationSettings: data is not an object', undefined, {
+      data,
+    });
     return false;
   }
 
   if (!('org' in data) || !isApiOrganization(data.org)) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigOrganizationSettings: org is not an object',
-      undefined,
-      {
-        data,
-      },
-    );
+    logger.logDebug('isApiOrgConfigOrganizationSettings: org is not an object', undefined, {
+      data,
+    });
     return false;
   }
 
@@ -215,7 +205,7 @@ const isApiOrgConfigOrganizationSettings = (
  */
 export const isApiOrgConfigResults = (data: unknown): data is Required<ApiOrgConfigResults> => {
   if (data == null || typeof data !== 'object') {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigResults: data is not an object', undefined, {
+    logger.logDebug('isApiOrgConfigResults: data is not an object', undefined, {
       data,
     });
     return false;
@@ -226,7 +216,7 @@ export const isApiOrgConfigResults = (data: unknown): data is Required<ApiOrgCon
     !Array.isArray(data.configs) ||
     !data.configs.every(config => isApiOrganizationConfig(config))
   ) {
-    Logger.logDebug('[spiffy-ai] isApiOrgConfigResults: configs is not an array', undefined, {
+    logger.logDebug('isApiOrgConfigResults: configs is not an array', undefined, {
       data,
     });
     return false;
@@ -238,8 +228,8 @@ export const isApiOrgConfigResults = (data: unknown): data is Required<ApiOrgCon
     (!Array.isArray(data.experiments) ||
       !data.experiments.every(exp => isApiOrgConfigExperiment(exp)))
   ) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigResults: experiments is not an array or contains invalid items',
+    logger.logDebug(
+      'isApiOrgConfigResults: experiments is not an array or contains invalid items',
       undefined,
       {
         data,
@@ -253,8 +243,8 @@ export const isApiOrgConfigResults = (data: unknown): data is Required<ApiOrgCon
     !Array.isArray(data.gates) ||
     !data.gates.every(gate => isApiOrgConfigFeatureGate(gate))
   ) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigResults: gates is not an array or contains invalid items',
+    logger.logDebug(
+      'isApiOrgConfigResults: gates is not an array or contains invalid items',
       undefined,
       {
         data,
@@ -264,10 +254,12 @@ export const isApiOrgConfigResults = (data: unknown): data is Required<ApiOrgCon
   }
 
   if (!('org' in data) || !isApiOrgConfigOrganizationSettings(data.org)) {
-    Logger.logDebug(
-      '[spiffy-ai] isApiOrgConfigResults: org is not an object or has invalid fields',
+    logger.logDebug(
+      'isApiOrgConfigResults: org is not an object or has invalid fields',
       undefined,
-      { data },
+      {
+        data,
+      },
     );
 
     return false;