@stacksjs/objects 0.39.0 → 0.40.0

package/dist/index.d.ts

@@ -1 +1,76 @@
+import type { DeepMerge } from '@stacksjs/types';
 export { Collection, collect } from '@stacksjs/collections';
+/**
+ * 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): (`${keyof T & undefined}` | `${keyof T & null}` | `${keyof T & string}` | `${keyof T & number}` | `${keyof T & false}` | `${keyof T & true}`)[];
+/**
+ * Strict typed `Object.entries`
+ *
+ * @category Object
+ */
+export declare function objectEntries<T extends object>(obj: T): [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 giving keys
+ *
+ * @category Object
+ */
+export declare function objectPick<O, 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
+ *
+ * @see https://eslint.org/docs/rules/no-prototype-builtins
+ * @category Object
+ */
+export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): any;

package/dist/index.mjs

@@ -1 +1,56 @@
+import { isObject, notNullish } from "@stacksjs/utils";
 export { Collection, collect } from "@stacksjs/collections";
+export function objectMap(obj, fn) {
+  return Object.fromEntries(
+    Object.entries(obj).map(([k, v]) => fn(k, v)).filter(notNullish)
+  );
+}
+export function isKeyOf(obj, k) {
+  return k in obj;
+}
+export function objectKeys(obj) {
+  return Object.keys(obj);
+}
+export function objectEntries(obj) {
+  return Object.entries(obj);
+}
+export function deepMerge(target, ...sources) {
+  if (!sources.length)
+    return target;
+  const source = sources.shift();
+  if (source === void 0)
+    return target;
+  if (isMergeableObject(target) && isMergeableObject(source)) {
+    objectKeys(source).forEach((key) => {
+      if (isMergeableObject(source[key])) {
+        if (!target[key])
+          target[key] = {};
+        deepMerge(target[key], source[key]);
+      } else {
+        target[key] = source[key];
+      }
+    });
+  }
+  return deepMerge(target, ...sources);
+}
+function isMergeableObject(item) {
+  return isObject(item) && !Array.isArray(item);
+}
+export function objectPick(obj, keys, omitUndefined = false) {
+  return keys.reduce((n, k) => {
+    if (k in obj) {
+      if (!omitUndefined || obj[k] !== void 0)
+        n[k] = obj[k];
+    }
+    return n;
+  }, {});
+}
+export function clearUndefined(obj) {
+  Object.keys(obj).forEach((key) => obj[key] === void 0 ? delete obj[key] : {});
+  return obj;
+}
+export function hasOwnProperty(obj, v) {
+  if (obj == null)
+    return false;
+  return Object.prototype.hasOwnProperty.call(obj, v);
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/objects",
   "type": "module",
-  "version": "0.39.0",
-  "packageManager": "pnpm@7.15.0",
+  "version": "0.40.0",
+  "packageManager": "pnpm@7.16.0",
   "description": "The Stacks objects.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -34,10 +34,10 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.15.0"
+    "pnpm": ">=7.16.0"
   },
   "dependencies": {
-    "@stacksjs/collections": "0.39.0"
+    "@stacksjs/collections": "0.40.0"
   },
   "devDependencies": {
     "mkdist": "^0.4.0",