chore: wip

Author: chrisbbreuer

storage/framework/core/collections/src/helpers/clone.ts

@@ -0,0 +1,17 @@
+/**
+ * Clone helper
+ *
+ * Clone an array or object
+ *
+ * @param items - The array or object to clone
+ * @returns A deep clone of the input
+ */
+export function clone<T>(items: T[]): T[]
+export function clone<T extends object>(items: T): T
+export function clone<T>(items: T[] | T): T[] | T {
+  if (Array.isArray(items)) {
+    return [...items]
+  }
+
+  return { ...items }
+}

storage/framework/core/collections/src/helpers/delete-keys.ts

@@ -0,0 +1,16 @@
+import { variadic } from './variadic'
+
+/**
+ * Delete keys helper
+ *
+ * Delete one or multiple keys from an object
+ *
+ * @param obj - The object from which to delete keys
+ * @param keys - The keys to delete
+ * @returns {void}
+ */
+export function deleteKeys<T extends object>(obj: T, ...keys: (keyof T)[]): void {
+  variadic(keys).forEach((key) => {
+    delete obj[key]
+  })
+}

storage/framework/core/collections/src/helpers/index.ts

@@ -0,0 +1,6 @@
+export * from './clone'
+export * from './delete-keys'
+export * from './is'
+export * from './nested-value'
+export * from './values'
+export * from './variadic'

storage/framework/core/collections/src/helpers/is.ts

@@ -0,0 +1,22 @@
+export const is = {
+  /**
+   * Checks if the item is an array.
+   * @param item - The item to check.
+   * @returns A boolean indicating whether the item is an array.
+   */
+  isArray: (item: unknown): item is Array<unknown> => Array.isArray(item),
+
+  /**
+   * Checks if the item is an object (excluding arrays and null).
+   * @param item - The item to check.
+   * @returns A boolean indicating whether the item is an object.
+   */
+  isObject: (item: unknown): item is object => typeof item === 'object' && !Array.isArray(item) && item !== null,
+
+  /**
+   * Checks if the item is a function.
+   * @param item - The item to check.
+   * @returns A boolean indicating whether the item is a function.
+   */
+  isFunction: (item: unknown): item is Function => typeof item === 'function',
+}

storage/framework/core/collections/src/helpers/nested-value.ts

@@ -0,0 +1,15 @@
+/**
+ * Get value of a nested property
+ *
+ * @param mainObject - The object to search for the nested property
+ * @param key - The key path to the nested property, using dot notation
+ * @returns The value of the nested property, or the mainObject if not found
+ */
+export function nestedValue<T>(mainObject: T, key: string): any {
+  try {
+    return key.split('.').reduce((obj: any, property: string) => obj[property], mainObject)
+  } catch (err) {
+    // If we end up here, we're not working with an object, and mainObject is the value itself
+    return mainObject
+  }
+}

storage/framework/core/collections/src/helpers/values.ts

@@ -0,0 +1,19 @@
+/**
+ * Values helper
+ *
+ * Retrieve values from items when it is an array, object or Collection
+ *
+ * @param items - The input array, object, or Collection
+ * @returns An array of values
+ */
+export function values<T>(items: T[] | { [key: string]: T } | { all: () => T[] }): T[] {
+  if (Array.isArray(items)) {
+    return [...items]
+  }
+
+  if ('all' in items && typeof items.all === 'function') {
+    return items.all()
+  }
+
+  return Object.values(items)
+}

storage/framework/core/collections/src/helpers/variadic.ts

@@ -0,0 +1,13 @@
+/**
+ * Variadic helper function
+ *
+ * @param args - The arguments to process
+ * @returns An array of the processed arguments
+ */
+export function variadic<T>(args: T[] | T): T[] {
+  if (Array.isArray(args)) {
+    return args
+  }
+
+  return [args]
+}