chore(deps): update dependency @belgattitude/eslint-config-bases to v…

…6.0.0-canary.14 (#1515) * chore(deps): update dependency @belgattitude/eslint-config-bases to v6.0.0-canary.14 * fix: edge cases with typings in plain-object * fix: edge cases with typings in plain-object * fix: edge cases with typings in plain-object --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Sebastien Vanvelthem <[email protected]>
belgattitude · Oct 8, 2024 · 2692a50 · 2692a50
1 parent 5ecbcc6
commit 2692a50
Show file tree

Hide file tree

Showing 22 changed files with 204 additions and 114 deletions.
diff --git a/.changeset/bright-toys-compete.md b/.changeset/bright-toys-compete.md
@@ -0,0 +1,5 @@
+---
+"@httpx/assert": patch
+---
+
+Improve isPlainObject and base it on @httpx/plain-object
diff --git a/docs/package.json b/docs/package.json
@@ -21,7 +21,7 @@
     "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "eslint": "8.57.1",
     "eslint-config-next": "14.2.14",
     "eslint-plugin-tailwindcss": "3.17.4",

diff --git a/integrations/prisma-exception/package.json b/integrations/prisma-exception/package.json
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@size-limit/file": "11.1.6",
     "@size-limit/webpack": "11.1.6",
     "@size-limit/webpack-why": "11.1.6",

diff --git a/package.json b/package.json
@@ -55,7 +55,7 @@
   ],
   "packageManager": "[email protected]",
   "devDependencies": {
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@changesets/changelog-github": "0.5.0",
     "@changesets/cli": "2.27.9",
     "@commitlint/cli": "19.5.0",

diff --git a/packages/assert/.size-limit.cjs b/packages/assert/.size-limit.cjs
@@ -31,7 +31,7 @@ module.exports = [
     name: 'Only assertPlainObject (ESM)',
     path: ['dist/index.mjs'],
     import: "{ assertPlainObject }",
-    limit: "487B",
+    limit: "489B",
   },
   {
     name: 'Everything (CJS)',

diff --git a/packages/assert/README.md b/packages/assert/README.md
@@ -177,31 +177,40 @@ switch(state) {
 | isPlainObject\<T?\>     | `PlainObject` |         |
 | assertPlainObject\<T?\> | `PlainObject` |         |
 
-> Inspired and compatible with [is-plain-obj](https://github.com/sindresorhus/is-plain-obj). Check the [test file](https://github.com/belgattitude/httpx/blob/main/packages/assert/src/__tests__/object.guards.test.ts)
+> Based on [@httpx/plain-object](https://github.com/belgattitude/httpx/tree/main/packages/plain-object#readme)
 
 ```typescript
 
 import { isPlainObject, assertPlainObject } from '@httpx/assert';
 
-// Simple case: without generic value
-isPlainObject({ });                     // 👈 ✅ true
-isPlainObject({ key: 'value' });        // 👈 ✅ true
-isPlainObject({ key: new Date() });     // 👈 ✅ true
-isPlainObject(new Object());            // 👈 ✅ true
-isPlainObject(Object.create(null));     // 👈 ✅ true
-isPlainObject({nested: { key: true} }); // 👈 ✅ true
-isPlainObject(runInNewContext('({})')); // 👈 ✅ true
+// ✅👇 True
 
-class Test { };
+isPlainObject({ key: 'value' });          // ✅ 
+isPlainObject({ key: new Date() });       // ✅ 
+isPlainObject(new Object());              // ✅ 
+isPlainObject(Object.create(null));       // ✅ 
+isPlainObject({ nested: { key: true} });  // ✅ 
+isPlainObject(new Proxy({}, {}));         // ✅ 
+isPlainObject({ [Symbol('tag')]: 'A' });  // ✅ 
+
+// ✅👇 (node context, workers, ...)
+const runInNewContext = await import('node:vm').then(
+    (mod) => mod.runInNewContext
+);
+isPlainObject(runInNewContext('({})'));   // ✅ 
 
-isPlainObject(new Test())               // 👈 ❌ false
-isPlainObject(10);                      // 👈 ❌ false
-isPlainObject(null);                    // 👈 ❌ false
-isPlainObject('hello');                 // 👈 ❌ false
-isPlainObject([]);                      // 👈 ❌ false
-isPlainObject(new Date());              // 👈 ❌ false
-isPlainObject(Math);                    // 👈 ❌ false
-// (... see test file)
+// ❌👇 False
+
+class Test { };
+isPlainObject(new Test())           // ❌ 
+isPlainObject(10);                  // ❌ 
+isPlainObject(null);                // ❌ 
+isPlainObject('hello');             // ❌ 
+isPlainObject([]);                  // ❌ 
+isPlainObject(new Date());          // ❌ 
+isPlainObject(Math);                // ❌ Static built-in classes 
+isPlainObject(Promise.resolve({})); // ❌
+isPlainObject(Object.create({}));   // ❌
 
 assertPlainObject({})                  // 👈 ✅ true
 

diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@sinclair/typebox": "0.33.15",

diff --git a/packages/assert/src/__tests__/object.guards.test.ts b/packages/assert/src/__tests__/object.guards.test.ts
@@ -62,20 +62,25 @@ describe('Object typeguards tests', () => {
         },
         false,
       ],
+      // globalThis
+      [globalThis, false],
       // Static built-in classes
       // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON
       [JSON, false],
       [Math, false],
       [Atomics, false],
       [JSON, false],
-      // built-in classes
+      // Built-in classes
       [new Date(), false],
       [new Map(), false],
       [new Error(), false],
       [new Set(), false],
       [new Request('http://localhost'), false],
       [new Promise(() => {}), false],
       [Promise.resolve({}), false],
+      // eslint-disable-next-line no-restricted-globals
+      [Buffer.from('123123'), false],
+      [new Uint8Array([1, 2, 3]), false],
       [Object.create({}), false],
       [/(\d+)/, false],
       // eslint-disable-next-line prefer-regex-literals
@@ -109,8 +114,15 @@ describe('Object typeguards tests', () => {
       );
     });
   });
+
   describe('Support node:vm.runInNewContext', () => {
-    const isNodeLike = typeof window === 'undefined';
+    const isNodeLike = 'window' in globalThis;
+    /*
+    const isNode = () =>
+        typeof process !== 'undefined' &&
+        !!process.versions &&
+        !!process.versions.node;
+    */
     it.skipIf(!isNodeLike)('should support vm', async () => {
       // eslint-disable-next-line import-x/no-nodejs-modules
       const runInNewContext = await import('node:vm').then(

diff --git a/packages/assert/src/__tests__/object.types.test.ts b/packages/assert/src/__tests__/object.types.test.ts
@@ -21,6 +21,8 @@ describe('object types tests', () => {
         // act
         assertPlainObject(unknownPo);
 
+        assertType<PlainObject>(unknownPo);
+
         // Now the type is Record<string, unknown>, javascript allows to retrieve it
         // even if it doesn't exist. The value should be undefined|unknown
         const invalidKeyIsUnknown = unknownPo.invalidKey;

diff --git a/packages/assert/src/messages/getTypeInfo.ts b/packages/assert/src/messages/getTypeInfo.ts
@@ -50,15 +50,3 @@ export const getTypeInfo = (v: unknown): string => {
   }
   return type;
 };
-const vowelsAndH = new Set(['a', 'e', 'i', 'o', 'u', 'y', 'h']);
-export const formatErrMsg = (
-  msg: string,
-  v: unknown,
-  options?: {
-    pfx: boolean;
-  }
-): string => {
-  const { pfx = true } = options ?? {};
-  const aOrAn = vowelsAndH.has((msg?.[0] ?? '').toLowerCase()) ? 'an' : 'a';
-  return `${pfx ? `${errPfx} ${aOrAn} ` : ''}${msg}, got: ${getTypeInfo(v)}`;
-};
diff --git a/packages/assert/src/object.asserts.ts b/packages/assert/src/object.asserts.ts
@@ -2,22 +2,52 @@ import { formatErrMsg } from './messages/errorMessages';
 import { isPlainObject } from './object.guards';
 import type {
   BasePlainObject,
-  UnspecifiedPlainObjectType,
+  DefaultBasePlainObject,
 } from './object.internal.types';
 import type { PlainObject } from './object.types';
 import type { MsgOrErrorFactory } from './types/internal.types';
 import { createAssertException } from './utils/createAssertException';
-
 /**
  * Assert a value is a plain object
+ *
+ * @example
+ * ```typescript
+ * import { assertPlainObject } from '@httpx/plain-object';
+ * import type { PlainObject } from '@httpx/plain-object';
+ *
+ * function fn(value: unknown) {
+ *
+ *     // 👇 Throws `new TypeError('Not a plain object')` if not a plain object
+ *     assertPlainObject(value);
+ *
+ *     // 👇 Throws `new TypeError('Custom message')` if not a plain object
+ *     assertPlainObject(value, 'Custom message');
+ *
+ *     // 👇 Throws custom error if not a plain object
+ *     assertPlainObject(value, () => {
+ *         throw new HttpBadRequest('Custom message');
+ *     });
+ *
+ *     return value;
+ * }
+ *
+ * try {
+ *     const value = fn({ key: 'value' });
+ *     // ✅ Value is known to be PlainObject<unknown>
+ *     assertType<PlainObject>(value);
+ * } catch (error) {
+ *     console.error(error);
+ * }
+ * ```
+ *
  * @throws TypeError
  */
 export function assertPlainObject<
-  TValue extends Record<string, unknown> = UnspecifiedPlainObjectType,
+  TValue extends BasePlainObject = DefaultBasePlainObject,
 >(
   v: unknown,
   msgOrErrorFactory?: MsgOrErrorFactory
-): asserts v is TValue extends UnspecifiedPlainObjectType
+): asserts v is TValue extends DefaultBasePlainObject
   ? BasePlainObject
   : PlainObject<TValue> {
   if (!isPlainObject<TValue>(v)) {

diff --git a/packages/assert/src/object.guards.ts b/packages/assert/src/object.guards.ts
@@ -1,6 +1,6 @@
 import type {
   BasePlainObject,
-  UnspecifiedPlainObjectType,
+  DefaultBasePlainObject,
 } from './object.internal.types';
 import type { PlainObject } from './object.types';
 
@@ -11,28 +11,43 @@ import type { PlainObject } from './object.types';
  *
  * @example
  * ```typescript
- * isPlainObject({ key: 'value' });       // 👈 ✅ true
- * isPlainObject({ key: new Date() });    // 👈 ✅ true
- * isPlainObject(new Object());           // 👈 ✅ true
- * isPlainObject(Object.create(null));    // 👈 ✅ true
- * isPlainObject({nested: { key: true} }  // 👈 ✅ true
+ * import { isPlainObject } from '@httpx/plain-object';
  *
- * class Test { };
+ * // ✅👇 True
+ *
+ * isPlainObject({ key: 'value' });          // ✅
+ * isPlainObject({ key: new Date() });       // ✅
+ * isPlainObject(new Object());              // ✅
+ * isPlainObject(Object.create(null));       // ✅
+ * isPlainObject({ nested: { key: true} });  // ✅
+ * isPlainObject(new Proxy({}, {}));         // ✅
+ * isPlainObject({ [Symbol('tag')]: 'A' });  // ✅
+ *
+ * // ✅👇 (node context, workers, ...)
+ * const runInNewContext = await import('node:vm').then(
+ *     (mod) => mod.runInNewContext
+ * );
+ * isPlainObject(runInNewContext('({})'));   // ✅
  *
- * isPlainObject(new Test())              // 👈 ❌ false
- * isPlainObject(10);                     // 👈 ❌ false
- * isPlainObject(null);                   // 👈 ❌ false
- * isPlainObject('hello');                // 👈 ❌ false
- * isPlainObject([]);                     // 👈 ❌ false
- * isPlainObject(new Date());             // 👈 ❌ false
- * isPlainObject(Math);                   // 👈 ❌ false
- * (...)
+ * // ❌👇 False
+ *
+ * class Test { };
+ * isPlainObject(new Test())           // ❌
+ * isPlainObject(10);                  // ❌
+ * isPlainObject(null);                // ❌
+ * isPlainObject('hello');             // ❌
+ * isPlainObject([]);                  // ❌
+ * isPlainObject(new Date());          // ❌
+ * isPlainObject(Math);                // ❌ Static built-in classes
+ * isPlainObject(Promise.resolve({})); // ❌
+ * isPlainObject(Object.create({}));   // ❌
+ * ```
  */
 export const isPlainObject = <
-  TValue extends Record<string, unknown> = UnspecifiedPlainObjectType,
+  TValue extends BasePlainObject = DefaultBasePlainObject,
 >(
   v: unknown
-): v is TValue extends UnspecifiedPlainObjectType
+): v is TValue extends DefaultBasePlainObject
   ? BasePlainObject
   : PlainObject<TValue> => {
   if (v === null || typeof v !== 'object') {
@@ -43,6 +58,7 @@ export const isPlainObject = <
   return (
     (proto === null ||
       proto === Object.prototype ||
+      // Required to support node:vm.runInNewContext({})
       Object.getPrototypeOf(proto) === null) &&
     // https://stackoverflow.com/a/76387885/5490184
     !(Symbol.toStringTag in v) &&

diff --git a/packages/assert/src/object.internal.types.ts b/packages/assert/src/object.internal.types.ts
@@ -1,13 +1,13 @@
 import type { Simplify } from './types/internal.types';
 
-export type PlainObjectKey = string;
-
-export type UnspecifiedPlainObjectType = BasePlainObject & {
-  readonly __httpxInternalTag: '@httpx/PlainObject';
-};
+export type PlainObjectKey = string | number | symbol;
 
 export type BasePlainObject = Record<PlainObjectKey, unknown>;
 
+export interface DefaultBasePlainObject extends BasePlainObject {
+  readonly __tag: 'default-plain-object';
+}
+
 export type PlainObjectDeepPartialUnknown<T> = {
   [P in keyof T]?: NonNullable<T[P]> extends BasePlainObject
     ? Simplify<PlainObjectDeepPartialUnknown<NonNullable<T[P]>>>

diff --git a/packages/assert/src/object.types.ts b/packages/assert/src/object.types.ts
@@ -1,13 +1,13 @@
 import type {
   BasePlainObject,
+  DefaultBasePlainObject,
   PlainObjectDeepPartialUnknown,
   PlainObjectKey,
-  UnspecifiedPlainObjectType,
 } from './object.internal.types';
 import type { Simplify } from './types/internal.types';
 
 export type PlainObject<
-  TValue extends BasePlainObject = UnspecifiedPlainObjectType,
-> = TValue extends UnspecifiedPlainObjectType
+  TValue extends BasePlainObject = DefaultBasePlainObject,
+> = TValue extends DefaultBasePlainObject
   ? Record<PlainObjectKey, unknown>
   : Simplify<PlainObjectDeepPartialUnknown<TValue>>;
diff --git a/packages/dsn-parser/package.json b/packages/dsn-parser/package.json
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@size-limit/file": "11.1.6",

diff --git a/packages/exception/package.json b/packages/exception/package.json
@@ -105,7 +105,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@size-limit/file": "11.1.6",

diff --git a/packages/json-api/package.json b/packages/json-api/package.json
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@size-limit/file": "11.1.6",

diff --git a/packages/memo-intl/package.json b/packages/memo-intl/package.json
@@ -70,7 +70,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@size-limit/file": "11.1.6",

diff --git a/packages/plain-object/package.json b/packages/plain-object/package.json
@@ -72,7 +72,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@belgattitude/eslint-config-bases": "6.0.0-canary.13",
+    "@belgattitude/eslint-config-bases": "6.0.0-canary.14",
     "@codspeed/vitest-plugin": "3.1.1",
     "@edge-runtime/vm": "4.0.3",
     "@sindresorhus/is": "7.0.1",