@wener/utils 1.1.6 → 1.1.7

package/src/objects/parseObjectPath.ts

@@ -5,9 +5,10 @@ export type ObjectPathLike = ObjectKey | ObjectPath;
 /**
  * Parse object path
  *
- *   parseObjectPath('a.b.c') // => ['a', 'b', 'c']
- *   parseObjectPath('a[0].b') // => ['a', 0, 'b']
- *   parseObjectPath('a[0][1]') // => ['a', 0, 1]
+ * @example
+ * parseObjectPath('a.b.c') // => ['a', 'b', 'c']
+ * parseObjectPath('a[0].b') // => ['a', 0, 'b']
+ * parseObjectPath('a[0][1]') // => ['a', 0, 1]
  *
  */
 export function parseObjectPath(s: ObjectPathLike): ObjectPath {

package/src/objects/set.test.ts

@@ -1,10 +1,11 @@
+/* eslint no-proto:0 no-prototype-builtins:0 */
 import test from 'ava';
 import { set } from './set';
 
 test('set basics', (t) => {
   t.is(set({}, 'c', 3), undefined, 'should not give return value');
   {
-    let item = { foo: 1 };
+    const item = { foo: 1 };
     set(item, 'bar', 123);
     t.is(item, item);
     t.deepEqual(
@@ -30,7 +31,7 @@ test('set objects', (t) => {
     const set = (a: any, b: any, c: any) => orig(a, b, c, isMerge);
     const verb = isMerge ? 'merge' : 'overwrite';
     objects(`should ${verb} existing object value :: simple`, () => {
-      let { input } = prepare({
+      const { input } = prepare({
         hello: { a: 1 },
       });
 
@@ -51,7 +52,7 @@ test('set objects', (t) => {
     });
 
     objects(`should ${verb} existing object value :: nested`, () => {
-      let { input, copy } = prepare({
+      const { input, copy } = prepare({
         a: {
           b: {
             c: 123,
@@ -71,7 +72,7 @@ test('set objects', (t) => {
     });
 
     objects(`should ${verb} existing array value :: simple`, () => {
-      let { input } = prepare([{ foo: 1 }]);
+      const { input } = prepare([{ foo: 1 }]);
 
       set(input, '0', { bar: 2 });
 
@@ -83,7 +84,7 @@ test('set objects', (t) => {
     });
 
     objects(`should ${verb} existing array value :: nested`, () => {
-      let { input } = prepare([
+      const { input } = prepare([
         { name: 'bob', age: 56, friends: ['foobar'] },
         { name: 'alice', age: 47, friends: ['mary'] },
       ]);
@@ -118,7 +119,7 @@ test('set arrays', (t) => {
     f();
   };
   arrays('should create array instead of object via numeric key :: simple', () => {
-    let input: any = { a: 1 };
+    const input: any = { a: 1 };
     set(input, 'e.0', 2);
     t.true(Array.isArray(input.e));
     t.is(input.e[0], 2);
@@ -129,7 +130,7 @@ test('set arrays', (t) => {
   });
 
   arrays('should create array instead of object via numeric key :: nested', () => {
-    let input: any = { a: 1 };
+    const input: any = { a: 1 };
     set(input, 'e.0.0', 123);
     t.true(input.e instanceof Array);
     t.is(input.e[0][0], 123);
@@ -140,7 +141,7 @@ test('set arrays', (t) => {
   });
 
   arrays('should be able to create object inside of array', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['x', '0', 'z'], 123);
     t.true(input.x instanceof Array);
     t.deepEqual(input, {
@@ -149,16 +150,16 @@ test('set arrays', (t) => {
   });
 
   arrays('should create arrays with hole(s) if needed', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['x', '1', 'z'], 123);
     t.true(input.x instanceof Array);
     t.deepEqual(input, {
-      x: [, { z: 123 }],
+      x: [undefined, { z: 123 }],
     });
   });
 
   arrays('should create object from decimal-like key :: array :: zero :: string', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['x', '10.0', 'z'], 123);
     t.false(input.x instanceof Array);
     t.deepEqual(input, {
@@ -171,17 +172,17 @@ test('set arrays', (t) => {
   });
 
   arrays('should create array from decimal-like key :: array :: zero :: number', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['x', 10.0, 'z'], 123);
     t.true(input.x instanceof Array);
 
-    let x = Array(10);
+    const x = Array(10);
     x.push({ z: 123 });
     t.deepEqual(input, { x });
   });
 
   arrays('should create object from decimal-like key :: array :: nonzero', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['x', '10.2', 'z'], 123);
     t.false(input.x instanceof Array);
     t.deepEqual(input, {
@@ -200,8 +201,8 @@ test('set pollution', (t) => {
     f();
   };
   pollution('should protect against "__proto__" assignment', () => {
-    let input: any = { abc: 123 };
-    let before = input.__proto__;
+    const input: any = { abc: 123 };
+    const before = input.__proto__;
     set(input, '__proto__.hello', 123);
 
     t.deepEqual(input.__proto__, before);
@@ -211,8 +212,8 @@ test('set pollution', (t) => {
   });
 
   pollution('should protect against "__proto__" assignment :: nested', () => {
-    let input: any = { abc: 123 };
-    let before = input.__proto__;
+    const input: any = { abc: 123 };
+    const before = input.__proto__;
     set(input, ['xyz', '__proto__', 'hello'], 123);
 
     t.deepEqual(input.__proto__, before);
@@ -227,7 +228,7 @@ test('set pollution', (t) => {
   });
 
   pollution('should ignore "prototype" assignment', () => {
-    let input: any = { a: 123 };
+    const input: any = { a: 123 };
     set(input, 'a.prototype.hello', 'world');
 
     t.is(input.a.prototype, undefined);
@@ -243,7 +244,7 @@ test('set pollution', (t) => {
   });
 
   pollution('should ignore "constructor" assignment :: direct', () => {
-    let input: any = { a: 123 };
+    const input: any = { a: 123 };
 
     function Custom() {
       //
@@ -259,7 +260,7 @@ test('set pollution', (t) => {
   });
 
   pollution('should ignore "constructor" assignment :: nested', () => {
-    let input: any = {};
+    const input: any = {};
 
     set(input, 'constructor.prototype.hello', 'world');
     t.is(input.hasOwnProperty('constructor'), false);
@@ -272,7 +273,7 @@ test('set pollution', (t) => {
 
   // Test for CVE-2022-25645 - CWE-1321
   pollution('should ignore JSON.parse crafted object with "__proto__" key', () => {
-    let a: any = { b: { c: 1 } };
+    const a: any = { b: { c: 1 } };
     t.is(a.polluted, undefined);
     set(a, 'b', JSON.parse('{"__proto__":{"polluted":"Yes!"}}'));
     t.is(a.polluted, undefined);
@@ -284,19 +285,19 @@ test('set assigns', (t) => {
     f();
   };
   assigns('should add value to key path :: shallow :: string', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, 'abc', 123);
     t.deepEqual(input, { abc: 123 });
   });
 
   assigns('should add value to key path :: shallow :: array', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['abc'], 123);
     t.deepEqual(input, { abc: 123 });
   });
 
   assigns('should add value to key path :: nested :: string', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, 'a.b.c', 123);
     t.deepEqual(input, {
       a: {
@@ -308,7 +309,7 @@ test('set assigns', (t) => {
   });
 
   assigns('should add value to key path :: nested :: array', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['a', 'b', 'c'], 123);
     t.deepEqual(input, {
       a: {
@@ -320,7 +321,7 @@ test('set assigns', (t) => {
   });
 
   assigns('should create Array via integer key :: string', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['foo', '0'], 123);
     t.true(input.foo instanceof Array);
     t.deepEqual(input, {
@@ -329,7 +330,7 @@ test('set assigns', (t) => {
   });
 
   assigns('should create Array via integer key :: number', () => {
-    let input: any = {};
+    const input: any = {};
     set(input, ['foo', 0], 123);
     t.true(input.foo instanceof Array);
     t.deepEqual(input, {
@@ -343,7 +344,7 @@ test('set preserves', (t) => {
     f();
   };
   preserves('should preserve existing object structure', () => {
-    let input = {
+    const input = {
       a: {
         b: {
           c: 123,
@@ -366,7 +367,7 @@ test('set preserves', (t) => {
   });
 
   preserves('should overwrite existing non-object values as object', () => {
-    let input = {
+    const input = {
       a: {
         b: 123,
       },
@@ -384,7 +385,7 @@ test('set preserves', (t) => {
   });
 
   preserves('should preserve existing object tree w/ array value', () => {
-    let input = {
+    const input = {
       a: {
         b: {
           c: 123,

package/src/objects/set.ts

@@ -22,8 +22,8 @@ export function set<T extends object, V>(obj: T, key: ObjectKey | ObjectPath, va
           : val
         : typeof (x = current[k]) === typeof path
         ? x
-        : // @ts-ignore hacky type check
-        path[i] * 0 !== 0 || !!~('' + path[i]).indexOf('.')
+        : // @ts-expect-error hacky type check
+        path[i] * 0 !== 0 || !!~('' + path[i]).indexOf('.') // eslint-disable-line
         ? {}
         : [];
   }

package/src/server/polyfillBrowser.ts

@@ -2,6 +2,14 @@ import { polyfillCrypto } from './polyfillCrypto';
 import { polyfillFetch } from './polyfillFetch';
 import { polyfillJsDom } from './polyfillJsDom';
 
+/**
+ * Polyfills the browser environment with the necessary APIs for the server.
+ * Currently, this includes:
+ * - `window`
+ * - `document`
+ * - `fetch`
+ * - `crypto`
+ */
 export async function polyfillBrowser() {
   await polyfillCrypto();
   await polyfillFetch();

package/src/server/polyfillFetch.ts

@@ -12,7 +12,6 @@ export async function polyfillFetch() {
     FormData,
     Blob,
     File,
-    // @ts-ignore
   } = await import('node-fetch');
   Object.assign(globalThis, {
     fetch,

package/src/server/polyfillJsDom.ts

@@ -1,4 +1,4 @@
-import { ConstructorOptions, ResourceLoaderConstructorOptions } from 'jsdom';
+import type { ConstructorOptions, ResourceLoaderConstructorOptions } from 'jsdom';
 
 export async function polyfillJsDom() {
   if (typeof window !== 'undefined') {
@@ -8,6 +8,7 @@ export async function polyfillJsDom() {
   const { ResourceLoader, JSDOM } = await import('jsdom');
 
   // https://github.com/lukechilds/window/blob/master/src/index.js
+  // eslint-disable-next-line @typescript-eslint/no-extraneous-class
   class Window {
     constructor(opts: ResourceLoaderConstructorOptions & ConstructorOptions = {}) {
       const { proxy, strictSSL, userAgent, ...jsdomOpts } = opts;
@@ -55,7 +56,7 @@ export async function polyfillJsDom() {
     Object.getOwnPropertyNames(window)
 
       // Remove protected properties
-      .filter((prop) => protectedProperties.indexOf(prop) === -1)
+      .filter((prop) => !protectedProperties.includes(prop))
 
       // If we're only applying specific required properties remove everything else
       .filter((prop) => !(properties && properties.indexOf(prop) === -1))

package/src/strings/formatBytes.ts

@@ -12,7 +12,7 @@ export function formatBytes(bytes: number, si = false, dp = 1) {
   const thresh = si ? 1000 : 1024;
 
   if (Math.abs(bytes) < thresh) {
-    return bytes + ' B';
+    return `${bytes} B`;
   }
 
   const units = si

package/src/strings/renderTemplate.test.ts

@@ -1,3 +1,4 @@
+/* eslint no-template-curly-in-string:0 */
 import test from 'ava';
 import { renderTemplate } from './renderTemplate';
 

package/src/strings/renderTemplate.ts

@@ -1,14 +1,17 @@
 import { get } from '../objects/get';
 
 /**
- * 替换类似于 JS 的模板字符串
+ * render template like js template string
  *
- *   templateString('My name is ${name}',{name:'wener'}) // => 'My name is wener'
+ * @example
+ * renderTemplate('My name is ${name}',{name:'wener'})
+ * // 'My name is wener'
  *
+ * @param match `js` for `${name}`, common for `{{name}}`
  */
 export function renderTemplate(
   template: string,
-  data: ((v: string) => any) | object,
+  data: ((v: string) => any) | object | undefined,
   match: 'js' | 'common' | RegExp = 'js',
 ) {
   let getter: Function;
@@ -21,14 +24,14 @@ export function renderTemplate(
     getter = (v: string) => get(data, v);
   }
   if (typeof match === 'string') {
-    match = Matches[match] || Matches['js'];
+    match = Matches[match] || Matches.js;
   }
   return template.replace(match, (_, g) => {
     return getter(g.trim());
   });
 }
 
-const Matches = {
+const Matches: Record<string, RegExp> = {
   js: /\${(.*?)}/g,
   common: /{{(.*?)}}/g,
 };

package/src/typedoc.ts

@@ -0,0 +1,2 @@
+export * from './index'
+export * from './server'

package/tsconfig.json

@@ -6,7 +6,7 @@
     "lib": [
       "dom",
       "dom.iterable",
-      "ES2018"
+      "ESNext"
     ],
     "strict": true,
     "sourceMap": true,
@@ -25,6 +25,7 @@
     "node_modules"
   ],
   "include": [
+    "types.d.ts",
     "src"
   ]
 }

package/dist/cjs/_commonjsHelpers-dfec268f.js

@@ -1,2 +0,0 @@
-"use strict";var o=typeof globalThis<"u"?globalThis:typeof window<"u"?window:typeof global<"u"?global:typeof self<"u"?self:{};exports.commonjsGlobal=o;
-//# sourceMappingURL=_commonjsHelpers-dfec268f.js.map

package/dist/cjs/_commonjsHelpers-dfec268f.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_commonjsHelpers-dfec268f.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}