@helpers4/object 2.0.0-alpha.9 → 2.0.0-beta.3

package/meta/category.json

@@ -0,0 +1,6 @@
+{
+  "category": "object",
+  "label": "Object",
+  "smallDescription": "Object manipulation utilities",
+  "description": "Utilities for working with objects including property removal, filtering, and object transformation"
+}

package/meta/examples.json

@@ -1,6 +1,21 @@
 {
   "category": "object",
   "functions": [
+    {
+      "name": "compact",
+      "examples": [
+        {
+          "title": "Remove falsy values from object",
+          "description": "Removes all entries with falsy values (false, null, undefined, 0, \"\", NaN).",
+          "code": "compact({ a: 1, b: null, c: '', d: 0, e: 'hello' })\n// => { a: 1, e: 'hello' }"
+        },
+        {
+          "title": "Clean up API response",
+          "description": "Useful to strip empty or missing fields before sending data.",
+          "code": "compact({ name: 'Alice', email: '', age: 0, role: 'admin' })\n// => { name: 'Alice', role: 'admin' }"
+        }
+      ]
+    },
     {
       "name": "deepClone",
       "examples": [
@@ -12,27 +27,52 @@
       ]
     },
     {
-      "name": "deepCompare",
+      "name": "deepMerge",
+      "examples": [
+        {
+          "title": "Merge two objects deeply",
+          "description": "Recursively merges source properties into the target object.",
+          "code": "deepMerge({ a: 1, b: { c: 2 } }, { b: { d: 3 }, e: 4 })\n// => { a: 1, b: { c: 2, d: 3 }, e: 4 }"
+        }
+      ]
+    },
+    {
+      "name": "diff",
       "examples": [
         {
           "title": "Compare nested objects",
           "description": "Deeply compares two objects, returning true when they are structurally equal.",
-          "code": "deepCompare({ a: { b: 1 } }, { a: { b: 1 } })\n// => true"
+          "code": "diff({ a: { b: 1 } }, { a: { b: 1 } })\n// => true"
         },
         {
           "title": "Detect deep differences",
           "description": "Returns a detailed diff object when nested values differ.",
-          "code": "deepCompare({ a: { b: 1 } }, { a: { b: 2 } })\n// => { a: { b: false } }"
+          "code": "diff({ a: { b: 1 } }, { a: { b: 2 } })\n// => { a: { b: false } }"
         }
       ]
     },
     {
-      "name": "deepMerge",
+      "name": "equalsDeep",
       "examples": [
         {
-          "title": "Merge two objects deeply",
-          "description": "Recursively merges source properties into the target object.",
-          "code": "deepMerge({ a: 1, b: { c: 2 } }, { b: { d: 3 }, e: 4 })\n// => { a: 1, b: { c: 2, d: 3 }, e: 4 }"
+          "title": "Compare nested objects",
+          "description": "Recursive structural equality. Returns true when the two values are deeply equal.",
+          "code": "equalsDeep({ a: { b: 1 } }, { a: { b: 1 } })\n// => true"
+        },
+        {
+          "title": "Detect deep differences",
+          "description": "Returns false when nested values differ.",
+          "code": "equalsDeep({ a: { b: 1 } }, { a: { b: 2 } })\n// => false"
+        }
+      ]
+    },
+    {
+      "name": "equalsShallow",
+      "examples": [
+        {
+          "title": "Compare two equal objects",
+          "description": "Uses JSON.stringify for a fast comparison.",
+          "code": "equalsShallow({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
         }
       ]
     },
@@ -52,12 +92,82 @@
       ]
     },
     {
-      "name": "quickCompare",
+      "name": "groupBy",
       "examples": [
         {
-          "title": "Compare two equal objects",
-          "description": "Uses JSON.stringify for a fast comparison.",
-          "code": "quickCompare({ a: 1, b: 2 }, { a: 1, b: 2 })\n// => true"
+          "title": "Group numbers by parity",
+          "description": "Groups elements by the string key returned by the callback.",
+          "code": "groupBy([1, 2, 3, 4], n => n % 2 === 0 ? 'even' : 'odd')\n// => { odd: [1, 3], even: [2, 4] }"
+        },
+        {
+          "title": "Group objects by a property",
+          "description": "Use a property accessor as the grouping key.",
+          "code": "const users = [\n  { name: 'Alice', role: 'admin' },\n  { name: 'Bob',   role: 'user'  },\n  { name: 'Carol', role: 'admin' },\n];\ngroupBy(users, u => u.role)\n// => { admin: [{...Alice}, {...Carol}], user: [{...Bob}] }"
+        }
+      ]
+    },
+    {
+      "name": "invert",
+      "examples": [
+        {
+          "title": "Swap keys and values",
+          "description": "Returns a new object with keys and values swapped.",
+          "code": "invert({ a: 'x', b: 'y', c: 'z' })\n// => { x: 'a', y: 'b', z: 'c' }"
+        },
+        {
+          "title": "Build a reverse lookup map",
+          "description": "Useful when you have a code-to-label map and need label-to-code.",
+          "code": "const STATUS_LABELS = { 200: 'OK', 404: 'Not Found', 500: 'Internal Server Error' };\nconst LABEL_TO_CODE = invert(STATUS_LABELS);\n\nLABEL_TO_CODE['OK']; // => '200'"
+        }
+      ]
+    },
+    {
+      "name": "map",
+      "examples": [
+        {
+          "title": "Transform values",
+          "description": "Maps each value of an object through a transform function.",
+          "code": "map({ a: 1, b: 2 }, v => v * 10)\n// => { a: 10, b: 20 }"
+        },
+        {
+          "title": "Transform keys",
+          "description": "Maps each key of an object through a transform function.",
+          "code": "map({ a: 1, b: 2 }, undefined, k => k.toUpperCase())\n// => { A: 1, B: 2 }"
+        },
+        {
+          "title": "Transform both keys and values in a single pass",
+          "description": "Provide both a value mapper and a key mapper to rewrite the whole object.",
+          "code": "map(\n  { price: 100, discount: 20 },\n  v => v / 100,\n  k => `${k}Ratio`\n)\n// => { priceRatio: 1, discountRatio: 0.2 }"
+        }
+      ]
+    },
+    {
+      "name": "omit",
+      "examples": [
+        {
+          "title": "Omit specific keys",
+          "description": "Creates a new object without the specified keys.",
+          "code": "omit({ a: 1, b: 2, c: 3 }, ['b'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Remove sensitive fields",
+          "description": "Useful to strip sensitive data before sending to client.",
+          "code": "const user = { id: 1, name: 'Alice', password: 'secret', token: 'abc123' };\nomit(user, ['password', 'token'])\n// => { id: 1, name: 'Alice' }"
+        }
+      ]
+    },
+    {
+      "name": "pick",
+      "examples": [
+        {
+          "title": "Pick specific keys",
+          "description": "Creates a new object with only the specified keys.",
+          "code": "pick({ a: 1, b: 2, c: 3 }, ['a', 'c'])\n// => { a: 1, c: 3 }"
+        },
+        {
+          "title": "Extract user fields",
+          "description": "Useful to select only the fields you need from an object.",
+          "code": "const user = { id: 1, name: 'Alice', email: 'alice@example.com', password: 'secret' };\npick(user, ['id', 'name', 'email'])\n// => { id: 1, name: 'Alice', email: 'alice@example.com' }"
         }
       ]
     },
@@ -71,6 +181,26 @@
         }
       ]
     },
+    {
+      "name": "safeJsonParse",
+      "examples": [
+        {
+          "title": "Parse valid JSON",
+          "description": "Returns the parsed value when the input is valid JSON.",
+          "code": "safeJsonParse<{ a: number }>('{\"a\":1}')\n// => { a: 1 }"
+        },
+        {
+          "title": "Return null on invalid input",
+          "description": "Returns null instead of throwing when JSON is malformed.",
+          "code": "safeJsonParse('invalid')\n// => null"
+        },
+        {
+          "title": "Use a fallback value",
+          "description": "Returns the provided fallback when parsing fails.",
+          "code": "safeJsonParse('invalid', [])\n// => []"
+        }
+      ]
+    },
     {
       "name": "set",
       "examples": [

package/meta/licenses.json

@@ -1,11 +1,4 @@
 {
   "category": "object",
-  "dependencies": [
-    {
-      "name": "radashi",
-      "license": "MIT",
-      "homepage": "https://radashi.js.org",
-      "repository": "https://github.com/radashi-org/radashi"
-    }
-  ]
+  "dependencies": []
 }

package/meta/native-alternatives.json

@@ -0,0 +1,50 @@
+{
+  "category": "object",
+  "functions": [
+    {
+      "name": "keys / values",
+      "libraries": [
+        "lodash",
+        "radashi",
+        "ramda"
+      ],
+      "native": "Object.keys() / Object.values()",
+      "since": "ES2017",
+      "example": "Object.keys(obj)\nObject.values(obj)",
+      "notes": "TypeScript types keys as string[]"
+    },
+    {
+      "name": "toPairs / fromPairs",
+      "libraries": [
+        "lodash",
+        "ramda"
+      ],
+      "native": "Object.entries() / Object.fromEntries()",
+      "since": "ES2019",
+      "example": "Object.entries(obj)\nObject.fromEntries(entries)"
+    },
+    {
+      "name": "has",
+      "libraries": [
+        "lodash",
+        "ramda"
+      ],
+      "native": "Object.hasOwn(obj, key)",
+      "since": "ES2022",
+      "example": "Object.hasOwn(obj, 'key')",
+      "notes": "Replaces obj.hasOwnProperty(key)"
+    },
+    {
+      "name": "merge (shallow)",
+      "libraries": [
+        "lodash",
+        "radashi",
+        "ramda"
+      ],
+      "native": "{ ...a, ...b } or Object.assign({}, a, b)",
+      "since": "ES2015",
+      "example": "const merged = { ...defaults, ...options }",
+      "notes": "For deep merge, use deepMerge from helpers4"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/object",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0-beta.3",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for object.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",
@@ -21,17 +21,26 @@
     "./meta/api.json": "./meta/api.json",
     "./meta/examples.json": "./meta/examples.json",
     "./meta/licenses.json": "./meta/licenses.json",
+    "./llms.txt": "./llms.txt",
     "./package.json": "./package.json"
   },
   "keywords": [
     "helpers",
     "object",
+    "compact",
     "deepClone",
-    "deepCompare",
     "deepMerge",
+    "diff",
+    "equalsDeep",
+    "equalsShallow",
     "get",
-    "quickCompare",
+    "groupBy",
+    "invert",
+    "map",
+    "omit",
+    "pick",
     "removeUndefinedNull",
+    "safeJsonParse",
     "set"
   ],
   "files": [
@@ -39,14 +48,12 @@
     "lib/index.d.ts",
     "lib/index.js.map",
     "meta/",
+    "llms.txt",
     "LICENSE.md",
     "package.json",
     "README.md"
   ],
   "engines": {
     "node": ">=18.0.0"
-  },
-  "peerDependencies": {
-    "radashi": "^12.7.2"
   }
 }