@magic/types 0.1.28 → 0.1.30

package/README.md

@@ -360,6 +360,15 @@ update dependencies
 - options.strict makes the tests include sort order of objects and array, [1, 2] is [2, 1] if options.strict = true
 - update dependencies
 
-##### 0.1.29 - unreleased
+##### 0.1.29
+
+- change types of is.ln, is.len, is.length and is.count to reflect their type as function with subfunctions
+
+##### 0.1.30
+
+- fix deep.equal and deep.different implementations and tests
+- update dependencies
+
+##### 0.1.31 - unreleased
 
 ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/types",
-  "version": "0.1.28",
+  "version": "0.1.30",
   "author": "Wizards & Witches",
   "homepage": "https://github.com/magic/types",
   "license": "AGPL-3.0",
@@ -10,8 +10,8 @@
   "type": "module",
   "scripts": {
     "start": "t",
-    "build": "tsc && npm run format && echo 'Types generated in dist/*'",
-    "prepublishOnly": "npm run build",
+    "build": "tsc && npm run format",
+    "prepublishOnly": "npm run test && npm run build",
     "build:docs": "NODE_ENV=production magic build",
     "prod": "NODE_ENV=production magic build serve",
     "clean": "magic clean",
@@ -20,7 +20,8 @@
     "test": "t",
     "format": "f -w --exclude docs",
     "format:check": "f --exclude docs",
-    "calls": "calls"
+    "calls": "calls",
+    "lint": "tsc --noEmit"
   },
   "engines": {
     "node": ">=18"
@@ -45,8 +46,7 @@
     "@magic-themes/docs": "0.0.15",
     "@magic/core": "0.0.156",
     "@magic/format": "0.0.68",
-    "@magic/fs": "0.0.31",
-    "@magic/test": "0.2.20",
+    "@magic/test": "0.2.24",
     "typescript": "5.9.3"
   },
   "keywords": [
@@ -61,6 +61,6 @@
     }
   ],
   "dependencies": {
-    "@types/node": "24.7.1"
+    "@types/node": "24.9.2"
   }
 }

package/src/deep/equal.js

@@ -18,9 +18,12 @@ import is from '../lib.js'
  * @param {unknown} [b]
  * @param {object} [options]
  * @param {boolean} [options.strict=false]
+ * @param {boolean} [options.arrayOrderStrict=true]
  * @returns {boolean | ((c: unknown) => boolean)}
  */
-export const equal = (a, b, options = { strict: false }) => {
+export const equal = (a, b, options = {}) => {
+  const { strict = false, arrayOrderStrict = false } = options
+
   // curry
   if (is.undefined(b)) {
     if (is.undefined(a)) {
@@ -39,15 +42,11 @@ export const equal = (a, b, options = { strict: false }) => {
     return false
   }
 
-  // bool, string, number, falsy values
-  if (is.comparable(a) || is.comparable(b)) {
-    return a === b
+  /* functions are handled by their toString value */
+  if (is.function(a) && is.function(b)) {
+    return a.toString() === b.toString()
   }
 
-  // if (is.arguments(a)) {
-  //  return is.length.eq(a, b)
-  // }
-
   if (!is.object(a) || !is.object(b)) {
     return a === b
   }
@@ -58,30 +57,17 @@ export const equal = (a, b, options = { strict: false }) => {
   }
 
   // real types must match too
-  // if (Object.prototype.toString.call(a) !== Object.prototype.toString.call(b)) {
-  //   return false
-  // }
+  if (Object.prototype.toString.call(a) !== Object.prototype.toString.call(b)) {
+    return false
+  }
 
   // dates
   if (is.date(a)) {
-    return a === b
+    return a.toString() === b.toString()
   }
 
-  /* functions are handled by prototype comparison above */
-  // if (is.function(a)) {
-  //   if (!is.function(b)) {
-  //     return false
-  //   }
-
-  //   return a.toString() === b.toString()
-  // }
-
   // buffers
-  if (is.buffer(a)) {
-    if (!is.buffer(b)) {
-      return false
-    }
-
+  if (is.buffer(a) && is.buffer(b)) {
     if (a.length !== b.length) {
       return false
     }
@@ -95,24 +81,17 @@ export const equal = (a, b, options = { strict: false }) => {
     return true
   }
 
-  if (is.objectNative(a) || is.array(a)) {
-    if (is.array(a)) {
-      if (!is.array(b)) {
-        return false
-      }
-
-      if (!options.strict) {
-        a.sort()
-        b.sort()
-      }
-
-      return !a.some((v, i) => v !== b[i])
+  if (is.array(a) && is.array(b)) {
+    if (!strict && !arrayOrderStrict) {
+      a.sort()
+      b.sort()
     }
 
-    if (!is.objectNative(b)) {
-      return false
-    }
+    const allEqual = !a.some((v, i) => !equal(v, b[i]))
+    return allEqual
+  }
 
+  if (is.objectNative(a) && is.objectNative(b)) {
     const aObj = a
     const bObj = b
 
@@ -124,7 +103,7 @@ export const equal = (a, b, options = { strict: false }) => {
       return false
     }
 
-    if (!options.strict) {
+    if (!strict) {
       ka.sort()
       kb.sort()
     }
@@ -137,15 +116,8 @@ export const equal = (a, b, options = { strict: false }) => {
     }
 
     // equivalent values for every corresponding key, and
-    // ~~~possibly expensive deep test
-    let key
-    for (let i = ka.length - 1; i >= 0; i--) {
-      key = ka[i]
-
-      if (!equal(aObj[key], bObj[key])) {
-        return false
-      }
-    }
+    // ~~~ possibly expensive deep test
+    return !ka.some(key => !equal(aObj[key], bObj[key]))
   }
 
   return typeof a === typeof b

package/src/fns.js

@@ -340,7 +340,7 @@ export const isLengthSmallerOrEqual = (a, b) =>
  * - null/undefined → true
  * - arrays, objects, regex → empty if size < 1
  * - errors/dates → never empty
- * - numbers, strings → falsy or 0/""
+ * - numbers, strings → falsy or 0, ""
  * @param {unknown} e
  * @returns {boolean}
  */

package/src/lib.js

@@ -1,11 +1,68 @@
 import * as fns from './fns.js'
 import * as deep from './deep/index.js'
 
-export const is = {
-  count: fns.getLength,
-  length: fns.getLength,
-  len: fns.getLength,
-  ln: fns.getLength,
+// count, length, len and ln are functions that return the length,
+// but they also have comparison methods attached as properties.
+// This creates enhanced length functions with comparison capabilities.
+
+/**
+ * @typedef {typeof fns.isLengthEqual} LengthComparison
+ */
+
+/**
+ * @typedef {typeof fns.getLength & {
+ *   eq: LengthComparison,
+ *   equal: LengthComparison,
+ *   gt: LengthComparison,
+ *   bigger: LengthComparison,
+ *   biggerequal: LengthComparison,
+ *   greater: LengthComparison,
+ *   greaterequal: LengthComparison,
+ *   gte: LengthComparison,
+ *   gteq: LengthComparison,
+ *   lower: LengthComparison,
+ *   smaller: LengthComparison,
+ *   lt: LengthComparison,
+ *   lowerequal: LengthComparison,
+ *   smallerequal: LengthComparison,
+ *   lte: LengthComparison,
+ *   lteq: LengthComparison
+ * }} EnhancedLengthFunction
+ */
+
+// Create enhanced length functions with comparison methods
+const lengthFunctions = {
+  eq: fns.isLengthEqual,
+  equal: fns.isLengthEqual,
+  gt: fns.isLengthGreater,
+  bigger: fns.isLengthGreater,
+  biggerequal: fns.isLengthGreaterOrEqual,
+  greater: fns.isLengthGreater,
+  greaterequal: fns.isLengthGreaterOrEqual,
+  gte: fns.isLengthGreaterOrEqual,
+  gteq: fns.isLengthGreaterOrEqual,
+  lower: fns.isLengthSmaller,
+  smaller: fns.isLengthSmaller,
+  lt: fns.isLengthSmaller,
+  lowerequal: fns.isLengthSmallerOrEqual,
+  smallerequal: fns.isLengthSmallerOrEqual,
+  lte: fns.isLengthSmallerOrEqual,
+  lteq: fns.isLengthSmallerOrEqual,
+}
+
+// Replace the original length functions with enhanced versions
+const ln = /** @type {EnhancedLengthFunction} */ (fns.getLength)
+Object.assign(ln, lengthFunctions)
+
+const length = ln
+const len = ln
+const count = ln
+
+export const is = /** @type {const} */ {
+  count,
+  length,
+  len,
+  ln,
 
   isError: fns.isError,
   error: fns.isError,
@@ -269,34 +326,4 @@ export const is = {
   ...deep,
 }
 
-// count, length, len and ln are functions that return the length,
-// but they also have comparison methods attached as properties.
-// This creates enhanced length functions with comparison capabilities.
-
-// Create enhanced length functions with comparison methods
-const lengthFunctions = {
-  eq: fns.isLengthEqual,
-  equal: fns.isLengthEqual,
-  gt: fns.isLengthGreater,
-  bigger: fns.isLengthGreater,
-  biggerequal: fns.isLengthGreaterOrEqual,
-  greater: fns.isLengthGreater,
-  greaterequal: fns.isLengthGreaterOrEqual,
-  gte: fns.isLengthGreaterOrEqual,
-  gteq: fns.isLengthGreaterOrEqual,
-  lower: fns.isLengthSmaller,
-  smaller: fns.isLengthSmaller,
-  lt: fns.isLengthSmaller,
-  lowerequal: fns.isLengthSmallerOrEqual,
-  smallerequal: fns.isLengthSmallerOrEqual,
-  lte: fns.isLengthSmallerOrEqual,
-  lteq: fns.isLengthSmallerOrEqual,
-}
-
-// Replace the original length functions with enhanced versions
-is.ln = fns.getLength
-Object.assign(is.ln, lengthFunctions)
-
-is.length = is.len = is.count = is.ln
-
 export default is

package/types/index.d.ts

@@ -183,10 +183,10 @@ export const is: {
       (a: unknown): (c: unknown) => boolean
     }
   }
-  count: (arg: unknown) => number
-  length: (arg: unknown) => number
-  len: (arg: unknown) => number
-  ln: (arg: unknown) => number
+  count: import('./lib.js').EnhancedLengthFunction
+  length: import('./lib.js').EnhancedLengthFunction
+  len: import('./lib.js').EnhancedLengthFunction
+  ln: import('./lib.js').EnhancedLengthFunction
   isError: (e: unknown) => e is Error
   error: (e: unknown) => e is Error
   err: (e: unknown) => e is Error

package/types/lib.d.ts

@@ -181,10 +181,10 @@ export const is: {
       (a: unknown): (c: unknown) => boolean
     }
   }
-  count: (arg: unknown) => number
-  length: (arg: unknown) => number
-  len: (arg: unknown) => number
-  ln: (arg: unknown) => number
+  count: EnhancedLengthFunction
+  length: EnhancedLengthFunction
+  len: EnhancedLengthFunction
+  ln: EnhancedLengthFunction
   isError: (e: unknown) => e is Error
   error: (e: unknown) => e is Error
   err: (e: unknown) => e is Error
@@ -508,3 +508,23 @@ export const is: {
   }
 }
 export default is
+export type LengthComparison = typeof fns.isLengthEqual
+export type EnhancedLengthFunction = typeof fns.getLength & {
+  eq: LengthComparison
+  equal: LengthComparison
+  gt: LengthComparison
+  bigger: LengthComparison
+  biggerequal: LengthComparison
+  greater: LengthComparison
+  greaterequal: LengthComparison
+  gte: LengthComparison
+  gteq: LengthComparison
+  lower: LengthComparison
+  smaller: LengthComparison
+  lt: LengthComparison
+  lowerequal: LengthComparison
+  smallerequal: LengthComparison
+  lte: LengthComparison
+  lteq: LengthComparison
+}
+import * as fns from './fns.js'