@stacksjs/objects 0.64.6 → 0.65.0

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import type { DeepMerge } from "@stacksjs/types";
+/**
+* Map key/value pairs for an object, and construct a new one
+*
+*
+* @category Object
+*
+* Transform:
+* @example
+* ```
+* objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])
+* // { A: '1', B: '2' }
+* ```
+*
+* Swap key/value:
+* @example
+* ```
+* objectMap({ a: 1, b: 2 }, (k, v) => [v, k])
+* // { 1: 'a', 2: 'b' }
+* ```
+*
+* Filter keys:
+* @example
+* ```
+* objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])
+* // { b: 2 }
+* ```
+*/
+export declare function objectMap<
+	K extends string,
+	V,
+	NK = K,
+	NV = V
+>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V>;
+/**
+* Type guard for any key, `k`.
+* Marks `k` as a key of `T` if `k` is in `obj`.
+*
+* @category Object
+* @param obj object to query for key `k`
+* @param k key to check existence in `obj`
+*/
+export declare function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T;
+/**
+* Strict typed `Object.keys`
+*
+* @category Object
+*/
+export declare function objectKeys<T extends object>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>;
+/**
+* Strict typed `Object.entries`
+*
+* @category Object
+*/
+export declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
+/**
+* Deep merge :P
+*
+* @category Object
+*/
+export declare function deepMerge<
+	T extends object = object,
+	S extends object = T
+>(target: T, ...sources: S[]): DeepMerge<T, S>;
+/**
+* Create a new subset object by providing keys.
+*
+* @category Object
+*/
+export declare function objectPick<
+	O extends object,
+	T extends keyof O
+>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
+/**
+* Clear undefined fields from an object. It mutates the object.
+*
+* @category Object
+*/
+export declare function clearUndefined<T extends object>(obj: T): T;
+/**
+* Determines whether an object has a property with the specified name
+*
+* @category Object
+*/
+export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;

package/dist/index.js

@@ -1,5 +1,5 @@
 // @bun
-import{notNullish as F}from"@stacksjs/utils";import{isObject as G}from"@stacksjs/validation";function L(q,x){return Object.fromEntries(Object.entries(q).map(([A,z])=>x(A,z)).filter(F))}function P(q,x){return x in q}function H(q){return Object.keys(q)}function Q(q){return Object.entries(q)}function E(q,...x){if(!x.length)return q;const A=x.shift();if(A===void 0)return q;if(C(q)&&C(A))H(A).forEach((z)=>{if(C(A[z])){if(!q[z])q[z]={};E(q[z],A[z])}else q[z]=A[z]});return E(q,...x)}function C(q){return G(q)&&!Array.isArray(q)}function R(q,x,A=!1){return x.reduce((z,B)=>{if(B in q){if(!A||q[B]!==void 0)z[B]=q[B]}return z},{})}function S(q){return Object.keys(q).forEach((x)=>q[x]===void 0?delete q[x]:{}),q}function T(q,x){return q==null?!1:Object.prototype.hasOwnProperty.call(q,x)}export{R as objectPick,L as objectMap,H as objectKeys,Q as objectEntries,P as isKeyOf,T as hasOwnProperty,E as deepMerge,S as clearUndefined};
+import{notNullish as F}from"@stacksjs/utils";import{isObject as G}from"@stacksjs/validation";function L(q,x){return Object.fromEntries(Object.entries(q).map(([A,z])=>x(A,z)).filter(F))}function P(q,x){return x in q}function H(q){return Object.keys(q)}function Q(q){return Object.entries(q)}function E(q,...x){if(!x.length)return q;const A=x.shift();if(A===void 0)return q;if(C(q)&&C(A))H(A).forEach((z)=>{if(C(A[z])){if(!q[z])q[z]={};E(q[z],A[z])}else q[z]=A[z]});return E(q,...x)}function C(q){return G(q)&&!Array.isArray(q)}function R(q,x,A=!1){return x.reduce((z,B)=>{if(B in q){if(!A||q[B]!==void 0)z[B]=q[B]}return z},{})}function S(q){return Object.keys(q).forEach((x)=>q[x]===void 0&&delete q[x]),q}function T(q,x){return q==null?!1:Object.prototype.hasOwnProperty.call(q,x)}export{R as objectPick,L as objectMap,H as objectKeys,Q as objectEntries,P as isKeyOf,T as hasOwnProperty,E as deepMerge,S as clearUndefined};
 
-//# debugId=827CAABF0174DF6764756E2164756E21
+//# debugId=F1DD95F2B382242F64756E2164756E21
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["../src/index.ts"],
   "sourcesContent": [
-    "import type { DeepMerge } from '@stacksjs/types'\nimport { notNullish } from '@stacksjs/utils'\nimport { isObject } from '@stacksjs/validation'\n\n/**\n * Map key/value pairs for an object, and construct a new one\n *\n *\n * @category Object\n *\n * Transform:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])\n * // { A: '1', B: '2' }\n * ```\n *\n * Swap key/value:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [v, k])\n * // { 1: 'a', 2: 'b' }\n * ```\n *\n * Filter keys:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])\n * // { b: 2 }\n * ```\n */\nexport function objectMap<K extends string, V, NK = K, NV = V>(\n  obj: Record<K, V>,\n  fn: (key: K, value: V) => [NK, NV] | undefined,\n): Record<K, V> {\n  return Object.fromEntries(\n    Object.entries(obj)\n      .map(([k, v]) => fn(k as K, v as V))\n      .filter(notNullish),\n  )\n}\n\n/**\n * Type guard for any key, `k`.\n * Marks `k` as a key of `T` if `k` is in `obj`.\n *\n * @category Object\n * @param obj object to query for key `k`\n * @param k key to check existence in `obj`\n */\nexport function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {\n  return k in obj\n}\n\n/**\n * Strict typed `Object.keys`\n *\n * @category Object\n */\nexport function objectKeys<T extends object>(obj: T) {\n  return Object.keys(obj) as Array<`${keyof T & (string | number | boolean | null | undefined)}`>\n}\n\n/**\n * Strict typed `Object.entries`\n *\n * @category Object\n */\nexport function objectEntries<T extends object>(obj: T) {\n  return Object.entries(obj) as Array<[keyof T, T[keyof T]]>\n}\n\n/**\n * Deep merge :P\n *\n * @category Object\n */\nexport function deepMerge<T extends object = object, S extends object = T>(\n  target: T,\n  ...sources: S[]\n): DeepMerge<T, S> {\n  if (!sources.length) return target as any\n\n  const source = sources.shift()\n  if (source === undefined) return target as any\n\n  if (isMergeableObject(target) && isMergeableObject(source)) {\n    objectKeys(source).forEach((key) => {\n      // @ts-expect-error some description\n      if (isMergeableObject(source[key])) {\n        // @ts-expect-error some description\n        if (!target[key])\n          // @ts-expect-error some description\n          target[key] = {}\n\n        // @ts-expect-error some description\n        deepMerge(target[key], source[key])\n      } else {\n        // @ts-expect-error some description\n        target[key] = source[key]\n      }\n    })\n  }\n\n  return deepMerge(target, ...sources)\n}\n\nfunction isMergeableObject(item: any): item is object {\n  return isObject(item) && !Array.isArray(item)\n}\n\n/**\n * Create a new subset object by providing keys.\n *\n * @category Object\n */\nexport function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false) {\n  return keys.reduce(\n    (n, k) => {\n      if (k in obj) {\n        if (!omitUndefined || obj[k] !== undefined) n[k] = obj[k]\n      }\n      return n\n    },\n    {} as Pick<O, T>,\n  )\n}\n\n/**\n * Clear undefined fields from an object. It mutates the object.\n *\n * @category Object\n */\nexport function clearUndefined<T extends object>(obj: T): T {\n  Object.keys(obj).forEach((key: string) => (obj[key] === undefined ? delete obj[key] : {}))\n  return obj\n}\n\n/**\n * Determines whether an object has a property with the specified name\n *\n * @category Object\n */\nexport function hasOwnProperty<T>(obj: T, v: PropertyKey) {\n  return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)\n}\n"
+    "import type { DeepMerge } from '@stacksjs/types'\nimport { notNullish } from '@stacksjs/utils'\nimport { isObject } from '@stacksjs/validation'\n\n/**\n * Map key/value pairs for an object, and construct a new one\n *\n *\n * @category Object\n *\n * Transform:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])\n * // { A: '1', B: '2' }\n * ```\n *\n * Swap key/value:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [v, k])\n * // { 1: 'a', 2: 'b' }\n * ```\n *\n * Filter keys:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])\n * // { b: 2 }\n * ```\n */\nexport function objectMap<K extends string, V, NK = K, NV = V>(\n  obj: Record<K, V>,\n  fn: (key: K, value: V) => [NK, NV] | undefined,\n): Record<K, V> {\n  return Object.fromEntries(\n    Object.entries(obj)\n      .map(([k, v]) => fn(k as K, v as V))\n      .filter(notNullish),\n  )\n}\n\n/**\n * Type guard for any key, `k`.\n * Marks `k` as a key of `T` if `k` is in `obj`.\n *\n * @category Object\n * @param obj object to query for key `k`\n * @param k key to check existence in `obj`\n */\nexport function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {\n  return k in obj\n}\n\n/**\n * Strict typed `Object.keys`\n *\n * @category Object\n */\nexport function objectKeys<T extends object>(obj: T) {\n  return Object.keys(obj) as Array<`${keyof T & (string | number | boolean | null | undefined)}`>\n}\n\n/**\n * Strict typed `Object.entries`\n *\n * @category Object\n */\nexport function objectEntries<T extends object>(obj: T) {\n  return Object.entries(obj) as Array<[keyof T, T[keyof T]]>\n}\n\n/**\n * Deep merge :P\n *\n * @category Object\n */\nexport function deepMerge<T extends object = object, S extends object = T>(\n  target: T,\n  ...sources: S[]\n): DeepMerge<T, S> {\n  if (!sources.length)\n    return target as any\n\n  const source = sources.shift()\n  if (source === undefined)\n    return target as any\n\n  if (isMergeableObject(target) && isMergeableObject(source)) {\n    objectKeys(source).forEach((key) => {\n      // @ts-expect-error some description\n      if (isMergeableObject(source[key])) {\n        // @ts-expect-error some description\n        if (!target[key])\n          // @ts-expect-error some description\n          target[key] = {}\n\n        // @ts-expect-error some description\n        deepMerge(target[key], source[key])\n      }\n      else {\n        // @ts-expect-error some description\n        target[key] = source[key]\n      }\n    })\n  }\n\n  return deepMerge(target, ...sources)\n}\n\nfunction isMergeableObject(item: any): item is object {\n  return isObject(item) && !Array.isArray(item)\n}\n\n/**\n * Create a new subset object by providing keys.\n *\n * @category Object\n */\nexport function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false): Pick<O, T> {\n  return keys.reduce(\n    (n, k) => {\n      if (k in obj) {\n        if (!omitUndefined || obj[k] !== undefined)\n          n[k] = obj[k]\n      }\n      return n\n    },\n    {} as Pick<O, T>,\n  )\n}\n\n/**\n * Clear undefined fields from an object. It mutates the object.\n *\n * @category Object\n */\nexport function clearUndefined<T extends object>(obj: T): T {\n  ;(Object.keys(obj) as Array<keyof T>).forEach(key => obj[key] === undefined && delete obj[key])\n  return obj\n}\n\n/**\n * Determines whether an object has a property with the specified name\n *\n * @category Object\n */\nexport function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean {\n  return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)\n}\n"
   ],
-  "mappings": ";AACA,qBAAS,wBACT,mBAAS,6BA6BF,SAAS,CAA8C,CAC5D,EACA,EACc,CACd,OAAO,OAAO,YACZ,OAAO,QAAQ,CAAG,EACf,IAAI,EAAE,EAAG,KAAO,EAAG,EAAQ,CAAM,CAAC,EAClC,OAAO,CAAU,CACtB,EAWK,SAAS,CAAyB,CAAC,EAAQ,EAA4B,CAC5E,OAAO,KAAK,EAQP,SAAS,CAA4B,CAAC,EAAQ,CACnD,OAAO,OAAO,KAAK,CAAG,EAQjB,SAAS,CAA+B,CAAC,EAAQ,CACtD,OAAO,OAAO,QAAQ,CAAG,EAQpB,SAAS,CAA0D,CACxE,KACG,EACc,CACjB,IAAK,EAAQ,OAAQ,OAAO,EAE5B,MAAM,EAAS,EAAQ,MAAM,EAC7B,GAAI,IAAW,OAAW,OAAO,EAEjC,GAAI,EAAkB,CAAM,GAAK,EAAkB,CAAM,EACvD,EAAW,CAAM,EAAE,QAAQ,CAAC,IAAQ,CAElC,GAAI,EAAkB,EAAO,EAAI,EAAG,CAElC,IAAK,EAAO,GAEV,EAAO,GAAO,CAAC,EAGjB,EAAU,EAAO,GAAM,EAAO,EAAI,MAGlC,GAAO,GAAO,EAAO,GAExB,EAGH,OAAO,EAAU,EAAQ,GAAG,CAAO,EAGrC,SAAS,CAAiB,CAAC,EAA2B,CACpD,OAAO,EAAS,CAAI,IAAM,MAAM,QAAQ,CAAI,EAQvC,SAAS,CAA+C,CAAC,EAAQ,EAAW,EAAgB,GAAO,CACxG,OAAO,EAAK,OACV,CAAC,EAAG,IAAM,CACR,GAAI,KAAK,GACP,IAAK,GAAiB,EAAI,KAAO,OAAW,EAAE,GAAK,EAAI,GAEzD,OAAO,GAET,CAAC,CACH,EAQK,SAAS,CAAgC,CAAC,EAAW,CAE1D,OADA,OAAO,KAAK,CAAG,EAAE,QAAQ,CAAC,IAAiB,EAAI,KAAS,cAAmB,EAAI,GAAO,CAAC,CAAE,EAClF,EAQF,SAAS,CAAiB,CAAC,EAAQ,EAAgB,CACxD,OAAO,GAAO,KAAO,GAAQ,OAAO,UAAU,eAAe,KAAK,EAAK,CAAC",
-  "debugId": "827CAABF0174DF6764756E2164756E21",
+  "mappings": ";AACA,qBAAS,wBACT,mBAAS,6BA6BF,SAAS,CAA8C,CAC5D,EACA,EACc,CACd,OAAO,OAAO,YACZ,OAAO,QAAQ,CAAG,EACf,IAAI,EAAE,EAAG,KAAO,EAAG,EAAQ,CAAM,CAAC,EAClC,OAAO,CAAU,CACtB,EAWK,SAAS,CAAyB,CAAC,EAAQ,EAA4B,CAC5E,OAAO,KAAK,EAQP,SAAS,CAA4B,CAAC,EAAQ,CACnD,OAAO,OAAO,KAAK,CAAG,EAQjB,SAAS,CAA+B,CAAC,EAAQ,CACtD,OAAO,OAAO,QAAQ,CAAG,EAQpB,SAAS,CAA0D,CACxE,KACG,EACc,CACjB,IAAK,EAAQ,OACX,OAAO,EAET,MAAM,EAAS,EAAQ,MAAM,EAC7B,GAAI,IAAW,OACb,OAAO,EAET,GAAI,EAAkB,CAAM,GAAK,EAAkB,CAAM,EACvD,EAAW,CAAM,EAAE,QAAQ,CAAC,IAAQ,CAElC,GAAI,EAAkB,EAAO,EAAI,EAAG,CAElC,IAAK,EAAO,GAEV,EAAO,GAAO,CAAC,EAGjB,EAAU,EAAO,GAAM,EAAO,EAAI,MAIlC,GAAO,GAAO,EAAO,GAExB,EAGH,OAAO,EAAU,EAAQ,GAAG,CAAO,EAGrC,SAAS,CAAiB,CAAC,EAA2B,CACpD,OAAO,EAAS,CAAI,IAAM,MAAM,QAAQ,CAAI,EAQvC,SAAS,CAA+C,CAAC,EAAQ,EAAW,EAAgB,GAAmB,CACpH,OAAO,EAAK,OACV,CAAC,EAAG,IAAM,CACR,GAAI,KAAK,GACP,IAAK,GAAiB,EAAI,KAAO,OAC/B,EAAE,GAAK,EAAI,GAEf,OAAO,GAET,CAAC,CACH,EAQK,SAAS,CAAgC,CAAC,EAAW,CAE1D,OADE,OAAO,KAAK,CAAG,EAAqB,QAAQ,KAAO,EAAI,KAAS,eAAoB,EAAI,EAAI,EACvF,EAQF,SAAS,CAAiB,CAAC,EAAQ,EAAyB,CACjE,OAAO,GAAO,KAAO,GAAQ,OAAO,UAAU,eAAe,KAAK,EAAK,CAAC",
+  "debugId": "F1DD95F2B382242F64756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@stacksjs/objects",
   "type": "module",
-  "version": "0.64.6",
+  "version": "0.65.0",
   "description": "The Stacks objects.",
   "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/objects#readme",
@@ -15,12 +16,7 @@
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
   },
-  "keywords": [
-    "objects",
-    "utilities",
-    "functions",
-    "stacks"
-  ],
+  "keywords": ["objects", "utilities", "functions", "stacks"],
   "exports": {
     ".": {
       "bun": "./src/index.ts",
@@ -33,26 +29,19 @@
   },
   "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",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/collections": "latest",
-    "@stacksjs/types": "latest",
-    "@stacksjs/utils": "latest",
-    "@stacksjs/validation": "latest"
+    "@stacksjs/collections": "0.64.6",
+    "@stacksjs/types": "0.64.6",
+    "@stacksjs/utils": "0.64.6",
+    "@stacksjs/validation": "0.64.6"
   },
   "devDependencies": {
-    "@stacksjs/development": "latest"
+    "@stacksjs/development": "0.64.6"
   }
 }

package/src/index.ts

@@ -79,10 +79,12 @@ export function deepMerge<T extends object = object, S extends object = T>(
   target: T,
   ...sources: S[]
 ): DeepMerge<T, S> {
-  if (!sources.length) return target as any
+  if (!sources.length)
+    return target as any
 
   const source = sources.shift()
-  if (source === undefined) return target as any
+  if (source === undefined)
+    return target as any
 
   if (isMergeableObject(target) && isMergeableObject(source)) {
     objectKeys(source).forEach((key) => {
@@ -95,7 +97,8 @@ export function deepMerge<T extends object = object, S extends object = T>(
 
         // @ts-expect-error some description
         deepMerge(target[key], source[key])
-      } else {
+      }
+      else {
         // @ts-expect-error some description
         target[key] = source[key]
       }
@@ -114,11 +117,12 @@ function isMergeableObject(item: any): item is object {
  *
  * @category Object
  */
-export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false) {
+export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false): Pick<O, T> {
   return keys.reduce(
     (n, k) => {
       if (k in obj) {
-        if (!omitUndefined || obj[k] !== undefined) n[k] = obj[k]
+        if (!omitUndefined || obj[k] !== undefined)
+          n[k] = obj[k]
       }
       return n
     },
@@ -132,7 +136,7 @@ export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[
  * @category Object
  */
 export function clearUndefined<T extends object>(obj: T): T {
-  Object.keys(obj).forEach((key: string) => (obj[key] === undefined ? delete obj[key] : {}))
+  ;(Object.keys(obj) as Array<keyof T>).forEach(key => obj[key] === undefined && delete obj[key])
   return obj
 }
 
@@ -141,6 +145,6 @@ export function clearUndefined<T extends object>(obj: T): T {
  *
  * @category Object
  */
-export function hasOwnProperty<T>(obj: T, v: PropertyKey) {
+export function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean {
   return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)
 }