@envive-ai/react-hooks 0.1.0

package/src/application/models/utilityTypes/splitWords.ts

@@ -0,0 +1,76 @@
+// these types come from https://github.com/sindresorhus/type-fest/blob/main/source/split-words.d.ts
+
+import type { IsLowerCase, IsNumeric, IsUpperCase, WordSeparators } from './internal';
+
+type SkipEmptyWord<Word extends string> = Word extends '' ? [] : [Word];
+
+type RemoveLastCharacter<
+  Sentence extends string,
+  Character extends string,
+> = Sentence extends `${infer LeftSide}${Character}` ? SkipEmptyWord<LeftSide> : never;
+
+/**
+ * Split a string (almost) like Lodash's `_.words()` function.
+ *
+ * - Split on each word that begins with a capital letter.
+ * - Split on each {@link WordSeparators}.
+ * - Split on numeric sequence.
+ *
+ * @example
+ * ```
+ * type Words0 = SplitWords<'helloWorld'>; // ['hello', 'World']
+ * type Words1 = SplitWords<'helloWORLD'>; // ['hello', 'WORLD']
+ * type Words2 = SplitWords<'hello-world'>; // ['hello', 'world']
+ * type Words3 = SplitWords<'--hello the_world'>; // ['hello', 'the', 'world']
+ * type Words4 = SplitWords<'lifeIs42'>; // ['life', 'Is', '42']
+ * ```
+ *
+ * @internal
+ * @category Change case
+ * @category Template literal
+ */
+export type SplitWords<
+  Sentence extends string,
+  LastCharacter extends string = '',
+  CurrentWord extends string = '',
+> = Sentence extends `${infer FirstCharacter}${infer RemainingCharacters}`
+  ? FirstCharacter extends WordSeparators
+    ? // Skip word separator
+      [...SkipEmptyWord<CurrentWord>, ...SplitWords<RemainingCharacters>]
+    : LastCharacter extends ''
+      ? // Fist char of word
+        SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>
+      : // Case change: non-numeric to numeric, push word
+        [false, true] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+        ? [
+            ...SkipEmptyWord<CurrentWord>,
+            ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>,
+          ]
+        : // Case change: numeric to non-numeric, push word
+          [true, false] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+          ? [
+              ...SkipEmptyWord<CurrentWord>,
+              ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>,
+            ]
+          : // No case change: concat word
+            [true, true] extends [IsNumeric<LastCharacter>, IsNumeric<FirstCharacter>]
+            ? SplitWords<RemainingCharacters, FirstCharacter, `${CurrentWord}${FirstCharacter}`>
+            : // Case change: lower to upper, push word
+              [true, true] extends [IsLowerCase<LastCharacter>, IsUpperCase<FirstCharacter>]
+              ? [
+                  ...SkipEmptyWord<CurrentWord>,
+                  ...SplitWords<RemainingCharacters, FirstCharacter, FirstCharacter>,
+                ]
+              : // Case change: upper to lower, brings back the last character, push word
+                [true, true] extends [IsUpperCase<LastCharacter>, IsLowerCase<FirstCharacter>]
+                ? [
+                    ...RemoveLastCharacter<CurrentWord, LastCharacter>,
+                    ...SplitWords<
+                      RemainingCharacters,
+                      FirstCharacter,
+                      `${LastCharacter}${FirstCharacter}`
+                    >,
+                  ]
+                : // No case change: concat word
+                  SplitWords<RemainingCharacters, FirstCharacter, `${CurrentWord}${FirstCharacter}`>
+  : [...SkipEmptyWord<CurrentWord>];

package/src/application/models/utilityTypes/trim.ts

@@ -0,0 +1,28 @@
+// these types come from https://github.com/sindresorhus/type-fest/blob/main/source/trim.d.ts
+
+import type { Whitespace } from './internal';
+
+/**
+ * Remove spaces from the left side.
+ */
+type TrimLeft<V extends string> = V extends `${Whitespace}${infer R}` ? TrimLeft<R> : V;
+
+/**
+ * Remove spaces from the right side.
+ */
+type TrimRight<V extends string> = V extends `${infer R}${Whitespace}` ? TrimRight<R> : V;
+
+/**
+ * Remove leading and trailing spaces from a string.
+ * @example
+ * ```
+ * import type {Trim} from 'type-fest';
+ *
+ * Trim<' foo '>
+ * //=> 'foo'
+ * ```
+ *
+ * @category String
+ * @category Template literal
+ */
+export type Trim<V extends string> = TrimLeft<TrimRight<V>>;

package/src/application/models/utilityTypes/unknownArray.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents an array with `unknown` value.
+ *
+ * Use case: You want a type that all arrays can be assigned to, but you don't care about the value.
+ *
+ * @example
+ * ```
+ * import type {UnknownArray} from 'type-fest';
+ *
+ * type IsArray<T> = T extends UnknownArray ? true : false;
+ *
+ * type A = IsArray<['foo']>;
+ * //=> true
+ *
+ * type B = IsArray<readonly number[]>;
+ * //=> true
+ *
+ * type C = IsArray<string>;
+ * //=> false
+ * ```
+ *
+ * @category Type
+ * @category Array
+ */
+export type UnknownArray = readonly unknown[];

package/src/application/models/utils/snakeToCamelTransformer.ts

@@ -0,0 +1,90 @@
+/**
+ * Generic utility to transform snake_case object keys to camelCase at runtime.
+ * This is the runtime equivalent of the CamelCasedPropertiesDeep type utility.
+ */
+
+// List of acronyms that should be preserved as uppercase in camelCase and lowercase in snake_case
+const PRESERVED_ACRONYMS = ['PLP', 'PDP', 'SVG'];
+
+/**
+ * Converts a snake_case string to camelCase
+ * Handles specific acronyms like PLP and PDP correctly
+ */
+const toCamelCase = (str: string): string => {
+  // Pre-process: convert all words that match the PRESERVED_ACRONYMS regex to uppercase
+  let processedStr = str;
+  for (const acronym of PRESERVED_ACRONYMS) {
+    const regex = new RegExp(`_${acronym}_?`, 'gi');
+
+    if (processedStr.match(regex)) {
+      processedStr = processedStr.replace(regex, (v) =>
+        v.endsWith('_') ? `${acronym}_` : `${acronym}`,
+      );
+    }
+  }
+  return processedStr.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+};
+
+/**
+ * Converts a camelCase string to snake_case
+ * Handles consecutive capital letters correctly (e.g., "PDP" -> "pdp", not "p_d_p")
+ * Preserves specific acronyms like PLP and PDP as lowercase in snake_case
+ */
+const toSnakeCase = (str: string) =>
+  str
+    .replace(/([A-Z])(?=[a-z])/g, '_$1')
+    .replace(/([a-z])([A-Z])/g, '$1_$2')
+    .toLowerCase()
+    .replace(/^_/, '');
+
+/**
+ * Recursively transforms all object keys from snake_case to camelCase
+ */
+export const transformSnakeToCamel = (obj: unknown): unknown => {
+  if (obj === null || obj === undefined) {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((val) => transformSnakeToCamel(val));
+  }
+
+  if (typeof obj === 'object') {
+    const result: Record<string, unknown> = {};
+
+    for (const [key, value] of Object.entries(obj)) {
+      const camelKey = toCamelCase(key);
+      result[camelKey] = transformSnakeToCamel(value);
+    }
+
+    return result;
+  }
+
+  return obj;
+};
+
+/**
+ * Recursively transforms all object keys from camelCase to snake_case
+ */
+export const transformCamelToSnake = (obj: unknown): unknown => {
+  if (obj === null || obj === undefined) {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map(transformCamelToSnake);
+  }
+
+  if (typeof obj === 'object') {
+    const result: Record<string, unknown> = {};
+
+    for (const [key, value] of Object.entries(obj)) {
+      const snakeKey = toSnakeCase(key);
+      result[snakeKey] = transformCamelToSnake(value);
+    }
+
+    return result;
+  }
+
+  return obj;
+};

package/src/application/models/utils/stringToFulfillmentDisplayStatusEnumValue.ts

@@ -0,0 +1,68 @@
+import { FulfillmentDisplayStatus } from '@spiffy-ai/commerce-api-client';
+
+/**
+ * Converts a string to a FulfillmentDisplayStatus enum value.
+ *
+ * @param status - The string to convert.
+ *
+ * @returns The FulfillmentDisplayStatus enum value or undefined if the string
+ * does not map to a valid enum
+ */
+export const stringToFulfillmentDisplayStatusEnumValue = (
+  status: string,
+): FulfillmentDisplayStatus | undefined => {
+  switch (status) {
+    case 'ATTEMPTED_DELIVERY':
+      return FulfillmentDisplayStatus.ATTEMPTED_DELIVERY;
+    case 'CANCELED':
+      return FulfillmentDisplayStatus.CANCELED;
+    case 'CONFIRMED':
+      return FulfillmentDisplayStatus.CONFIRMED;
+    case 'DELIVERED':
+      return FulfillmentDisplayStatus.DELIVERED;
+    case 'FAILURE':
+      return FulfillmentDisplayStatus.FAILURE;
+    case 'FULFILLED':
+      return FulfillmentDisplayStatus.FULFILLED;
+    case 'IN_TRANSIT':
+      return FulfillmentDisplayStatus.IN_TRANSIT;
+    case 'LABEL_PRINTED':
+      return FulfillmentDisplayStatus.LABEL_PRINTED;
+    case 'LABEL_PURCHASED':
+      return FulfillmentDisplayStatus.LABEL_PURCHASED;
+    case 'LABEL_VOIDED':
+      return FulfillmentDisplayStatus.LABEL_VOIDED;
+    case 'MARKED_AS_FULFILLED':
+      return FulfillmentDisplayStatus.MARKED_AS_FULFILLED;
+    case 'NOT_DELIVERED':
+      return FulfillmentDisplayStatus.NOT_DELIVERED;
+    case 'OUT_FOR_DELIVERY':
+      return FulfillmentDisplayStatus.OUT_FOR_DELIVERY;
+    case 'PICKED_UP':
+      return FulfillmentDisplayStatus.PICKED_UP;
+    case 'READY_FOR_PICKUP':
+      return FulfillmentDisplayStatus.READY_FOR_PICKUP;
+    case 'SUBMITTED':
+      return FulfillmentDisplayStatus.SUBMITTED;
+    case 'IN_PROGRESS':
+      return FulfillmentDisplayStatus.IN_PROGRESS;
+    case 'ON_HOLD':
+      return FulfillmentDisplayStatus.ON_HOLD;
+    case 'OPEN':
+      return FulfillmentDisplayStatus.OPEN;
+    case 'PARTIALLY_FULFILLED':
+      return FulfillmentDisplayStatus.PARTIALLY_FULFILLED;
+    case 'PENDING_FULFILLMENT':
+      return FulfillmentDisplayStatus.PENDING_FULFILLMENT;
+    case 'REQUEST_DECLINED':
+      return FulfillmentDisplayStatus.REQUEST_DECLINED;
+    case 'RESTOCKED':
+      return FulfillmentDisplayStatus.RESTOCKED;
+    case 'SCHEDULED':
+      return FulfillmentDisplayStatus.SCHEDULED;
+    case 'UNFULFILLED':
+      return FulfillmentDisplayStatus.UNFULFILLED;
+    default:
+      return undefined;
+  }
+};

package/src/application/models/validators/validateGraphQLColorsConfig.ts

@@ -0,0 +1,29 @@
+import { ColorMapping, ColorNames } from 'src/application/models/colorsConfig';
+import { isGraphQLColorsConfig } from 'src/application/models/guards/graphQL/isGraphQLColorsConfig';
+
+export const validateGraphQLColorsConfig = (data: unknown): ColorMapping | undefined => {
+  if (!isGraphQLColorsConfig(data)) {
+    return undefined;
+  }
+
+  return {
+    [ColorNames.TextPrimary]: data.text_primary,
+    [ColorNames.TextSecondary]: data.text_secondary,
+    [ColorNames.TextAccent]: data.text_accent,
+    [ColorNames.TextLink]: data.text_link,
+    [ColorNames.TextLight]: data.text_light,
+    [ColorNames.BackgroundPrimary]: data.background_primary,
+    [ColorNames.BackgroundSecondary]: data.background_secondary,
+    [ColorNames.BackgroundSecondaryDark]: data.background_secondary_dark,
+    [ColorNames.BackgroundTertiary]: data.background_tertiary,
+    [ColorNames.BackgroundDark]: data.background_dark,
+    [ColorNames.BorderLight]: data.border_light,
+    [ColorNames.BorderMedium]: data.border_medium,
+    [ColorNames.BorderDark]: data.border_dark,
+    [ColorNames.BorderOutline]: data.border_outline,
+    [ColorNames.AccentPrimary]: data.accent_primary,
+    [ColorNames.AccentSecondary]: data.accent_secondary,
+    [ColorNames.BackgroundLight]: data.background_light,
+    [ColorNames.BackgroundSaturated]: data.background_saturated,
+  };
+};