feat(marshalling): add any marshalling (#2054)

Author: philibea

packages/client/src/helpers/json.ts

@@ -42,3 +42,68 @@ export const isJSONObject = (obj: unknown): obj is JSONObject => {
     objT === 'object'
   )
 }
+
+/**
+ * Camelizes a string.
+ *
+ * @param str - The string to camelize
+ * @returns The camelized string
+ *
+ * @internal
+ */
+export const camelize = (str: string): string => {
+  const strLength = str.length
+  if (strLength <= 0) {
+    return str
+  }
+  let out = ''
+  for (let capNext = false, index = 0; index < strLength; index += 1) {
+    const char = str.charAt(index)
+    if (char >= 'a' && char <= 'z') {
+      if (capNext) {
+        out += char.toUpperCase()
+      } else {
+        out += char
+      }
+    } else if (char >= 'A' && char <= 'Z') {
+      out += char
+    } else if (char >= '0' && char <= '9') {
+      out += char
+    }
+    capNext = char === '_' || char === ' ' || char === '-' || char === '.'
+  }
+
+  return out.charAt(0).toLowerCase() + out.substring(1)
+}
+
+/**
+ * Camelizes keys of an object (deeply).
+ *
+ * @param obj - The object
+ * @param ignoreKeys - The keys to ignore
+ * @returns The object with camelized keys
+ *
+ * @internal
+ */
+export const camelizeKeys = <T>(
+  obj: object | unknown[] | unknown,
+  ignoreKeys: string[] = [],
+): T => {
+  if (Array.isArray(obj)) {
+    return obj.map(v => camelizeKeys(v, ignoreKeys)) as unknown as T
+  }
+
+  if (obj && typeof obj === 'object' && !(obj instanceof Date)) {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [camelize(key)]: ignoreKeys.includes(key)
+          ? (value as unknown)
+          : camelizeKeys(value, ignoreKeys),
+      }),
+      {},
+    ) as T
+  }
+
+  return obj as T
+}

packages/client/src/scw/custom-marshalling.ts

@@ -1,4 +1,4 @@
-import { isJSONObject } from '../helpers/json'
+import { camelizeKeys, isJSONObject } from '../helpers/json'
 import { unmarshalArrayOfObject, unmarshalDate } from '../helpers/marshalling'
 import { fromByteArray } from '../vendor/base64'
 import type {
@@ -207,3 +207,61 @@ export const marshalTimeSeries = (
 export const marshalDecimal = (obj: Decimal): { value: string } => ({
   value: obj.toString(),
 })
+
+/**
+ * Unmarshals record to convert iso dates from string to Dates.
+ *
+ * @param obj - The input
+ * @param keys - The keys requiring a conversion
+ * @returns The updated input
+ *
+ * @internal
+ */
+export const unmarshalDates = <T>(obj: unknown, keys: string[]): T => {
+  if (Array.isArray(obj)) {
+    return obj.map(v => unmarshalDates(v, keys)) as unknown as T
+  }
+
+  if (obj && typeof obj === 'object') {
+    return Object.entries(obj).reduce(
+      (acc, [key, value]) => ({
+        ...acc,
+        [key]:
+          typeof value === 'string' && keys.includes(key)
+            ? new Date(value)
+            : unmarshalDates(value, keys),
+      }),
+      {},
+    ) as T
+  }
+
+  return obj as T
+}
+
+/**
+ * Unmarshals input to a record with camilized keys and instanciated Date.
+ *
+ * @param obj - The input
+ * @param ignoreKeys - The keys which should be not be transformed
+ * @param dateKeys - The keys which should be transformed to Date
+ * @returns The record
+ *
+ * @throws TypeError
+ * Thrown if the input isn't {@link JSONObject}.
+ *
+ * @internal
+ */
+export const unmarshalAnyRes = <T>(
+  obj: unknown,
+  ignoreKeys: string[] = [],
+  dateKeys?: string[],
+): T => {
+  if (!isJSONObject(obj)) {
+    throw new TypeError(`Data isn't a dictionary.`)
+  }
+
+  return camelizeKeys(
+    dateKeys && dateKeys.length > 0 ? unmarshalDates(obj, dateKeys) : obj,
+    ignoreKeys,
+  )
+}