@stacksjs/objects 0.70.23 → 0.70.25

package/README.md

@@ -29,7 +29,7 @@ const collection = collect([{
 console.log(collection.avg('pages')) // 636
 ```
 
-To view the full documentation, please visit [https://stacksjs.org/objects](https://stacksjs.org/objects).
+To view the full documentation, please visit [<https://stacksjs.com/object>s](https://stacksjs.com/objects).
 
 ## 🧪 Testing
 

package/dist/index.js

@@ -1,2 +1,2 @@
 // @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;let 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,B])=>x(A,B)).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;let[A,...B]=x;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,...B)}function C(q){return G(q)&&!Array.isArray(q)}function R(q,x,A=!1){return x.reduce((B,z)=>{if(z in q){if(!A||q[z]!==void 0)B[z]=q[z]}return B},{})}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};

package/dist/src/index.d.ts

@@ -0,0 +1,74 @@
+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): void;
+/**
+ * Strict typed `Object.entries`
+ *
+ * @category Object
+ */
+export declare function objectEntries<T extends object>(obj: T): void;
+/**
+ * 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/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@stacksjs/objects",
   "type": "module",
-  "version": "0.70.23",
+  "version": "0.70.25",
   "description": "The Stacks objects.",
   "author": "Chris Breuer",
-  "contributors": ["Chris Breuer <chris@stacksjs.org>"],
+  "contributors": [
+    "Chris Breuer <chris@stacksjs.com>"
+  ],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/objects#readme",
@@ -16,28 +18,40 @@
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
   },
-  "keywords": ["objects", "utilities", "functions", "stacks"],
+  "keywords": [
+    "objects",
+    "utilities",
+    "functions",
+    "stacks"
+  ],
   "exports": {
     ".": {
+      "bun": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
     "./*": {
+      "bun": "./src/*",
       "import": "./dist/*"
     }
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["README.md", "dist"],
+  "files": [
+    "README.md",
+    "dist"
+  ],
   "scripts": {
     "build": "bun build.ts",
     "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@stacksjs/collections": "0.70.22",
-    "@stacksjs/development": "0.70.22",
-    "@stacksjs/types": "0.70.22",
-    "@stacksjs/utils": "0.70.22",
-    "@stacksjs/validation": "0.70.22"
-  }
+    "@stacksjs/collections": "0.70.23",
+    "better-dx": "^0.2.12",
+    "@stacksjs/types": "0.70.23",
+    "@stacksjs/utils": "0.70.23",
+    "@stacksjs/validation": "0.70.23"
+  },
+  "sideEffects": false
 }

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-import type { DeepMerge } from '@stacksjs/types';
-
-export declare function objectMap<K extends string, V, NK = K, NV = V>(obj: Record<K, V>, fn: (key: K, value: V)): Record<K, V>;
-export declare function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T;
-export declare function objectKeys<T extends object>(obj: T): void;
-export declare function objectEntries<T extends object>(obj: T): void;
-export declare function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S>;
-declare function isMergeableObject(item: any): item is object;
-export declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined): Pick<O, T>;
-export declare function clearUndefined<T extends object>(obj: T): T;
-export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;