@stacksjs/collections 0.64.6 → 0.65.0

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stacksjs/collections",
   "type": "module",
-  "version": "0.64.6",
+  "version": "0.65.0",
   "description": "The Stacks collections.",
   "author": "Chris Breuer",
+  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/collections#readme",
@@ -36,23 +37,17 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
-  "files": [
-    "README.md",
-    "dist",
-    "src"
-  ],
+  "files": ["README.md", "dist", "src"],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "typecheck": "bun --bun tsc --noEmit",
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
+    "test": "bun test",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
     "collect.js": "^4.36.1"
   },
   "devDependencies": {
-    "@stacksjs/development": "latest"
+    "@stacksjs/development": "0.64.6"
   }
 }

package/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 }
+}

package/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]
+  })
+}

package/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'

package/src/helpers/is.ts

@@ -0,0 +1,23 @@
+/**
+ * Checks if the item is an array.
+ * @param item - The item to check.
+ * @returns A boolean indicating whether the item is an array.
+ */
+export const 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.
+ */
+export function isObject(item: unknown): item is object {
+  return 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.
+ */
+// eslint-disable-next-line ts/no-unsafe-function-type
+export const isFunction = (item: unknown): item is Function => typeof item === 'function'

package/src/helpers/nested-value.ts

@@ -0,0 +1,17 @@
+/**
+ * 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)
+  }
+  // eslint-disable-next-line unused-imports/no-unused-vars
+  catch (err) {
+    // If we end up here, we're not working with an object, and mainObject is the value itself
+    return mainObject
+  }
+}

package/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)
+}

package/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]
+}