@zajno/common 2.0.9 → 2.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zajno/common",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "description": "Zajno's re-usable utilities for JS/TS projects",
   "repository": {
     "type": "git",
@@ -27,18 +27,18 @@
   "devDependencies": {
     "@faker-js/faker": "^7.6.0",
     "@types/jest": "^29.5.0",
-    "@types/node": "^18.15.10",
+    "@types/node": "^18.15.11",
     "@zajno/eslint-config": "^2.3.0",
     "cpy-cli": "^4.2.0",
-    "eslint": "^8.36.0",
+    "eslint": "^8.38.0",
     "fast-check": "^3.7.1",
     "jest": "^29.5.0",
     "jest-extended": "^3.2.4",
     "rimraf": "^3",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
-    "typescript": "^5.0.2"
+    "typescript": "^5.0.4"
   },
   "peerDependencies": {
     "tslib": "^2.4"

package/structures/promiseProxy.d.ts

@@ -0,0 +1,30 @@
+import { LazyPromise } from '../lazy/promise';
+import { FunctionKeys, StringKeys } from '../types';
+declare const PromiseGetter: "__promise";
+type AllowedFnKeys<T> = FunctionKeys<T, any[], void>;
+type PromiseProxy<T, TKeys extends StringKeys<T> = StringKeys<T>, TFnKeys = never, TWrap extends Object = {}> = {
+    [K in TKeys]: T[K] extends Function ? (K extends TFnKeys ? T[K] : never) : T[K];
+} & {
+    readonly [PromiseGetter]: Promise<T>;
+} & TWrap;
+type ForbiddenKeys = typeof PromiseGetter;
+type NoForbiddenKeys<T> = {
+    [K in keyof T]: K extends ForbiddenKeys ? never : T[K];
+};
+type Options<T, TFnKeys, TWrap, TLazy> = {
+    loader: () => Promise<T>;
+    fnKeys?: TFnKeys[];
+    wrap?: TWrap;
+    lazy?: TLazy;
+};
+/**
+ * Creates a proxy object that will be resolved to the object returned by the loader function. // Thanks CoPilot for this comment :)
+ *
+ * @param loader a function returning a promise that resolves to a proxied object
+ * @param fnKeys an array of keys that should be treated as functions so that they can be called before the object is resolved
+ * @param wrap an object that will be used as a wrapper for the proxied object. can contain any fields that will be copied to the resolved object
+ * @returns a proxy object that will be resolved to the object returned by the loader function
+ */
+export declare function createPromiseProxy<T extends NoForbiddenKeys<T>, TFnKeys extends AllowedFnKeys<T> = never, TWrap extends Object = {}>(options: Options<T, TFnKeys, TWrap, typeof LazyPromise>): PromiseProxy<T, StringKeys<T>, TFnKeys, TWrap>;
+export {};
+//# sourceMappingURL=promiseProxy.d.ts.map

package/structures/promiseProxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promiseProxy.d.ts","sourceRoot":"","sources":["../../src/structures/promiseProxy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEpD,QAAA,MAAM,aAAa,aAAuB,CAAC;AAE3C,KAAK,aAAa,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;AAErD,KAAK,YAAY,CAAC,CAAC,EAAE,KAAK,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,KAAK,EAAE,KAAK,SAAS,MAAM,GAAG,EAAG,IAAI;KAC5G,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAC7B,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAClC,CAAC,CAAC,CAAC,CAAC;CACb,GAAG;IACA,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACxC,GAAG,KAAK,CAAC;AAEV,KAAK,aAAa,GAAG,OAAO,aAAa,CAAC;AAC1C,KAAK,eAAe,CAAC,CAAC,IAAI;KACrB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,aAAa,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,KAAK,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI;IACrC,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,IAAI,CAAC,EAAE,KAAK,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,KAAK,SAAS,MAAM,GAAG,EAAG,EACjI,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,WAAW,CAAC,GACxD,YAAY,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAoFhD"}

package/structures/promiseProxy.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPromiseProxy = void 0;
+const promise_1 = require("../lazy/promise");
+const PromiseGetter = '__promise';
+/**
+ * Creates a proxy object that will be resolved to the object returned by the loader function. // Thanks CoPilot for this comment :)
+ *
+ * @param loader a function returning a promise that resolves to a proxied object
+ * @param fnKeys an array of keys that should be treated as functions so that they can be called before the object is resolved
+ * @param wrap an object that will be used as a wrapper for the proxied object. can contain any fields that will be copied to the resolved object
+ * @returns a proxy object that will be resolved to the object returned by the loader function
+ */
+function createPromiseProxy(options) {
+    const { loader, fnKeys, wrap, lazy: TLazy = promise_1.LazyPromise } = options;
+    // wrapper object that will hold values temporarily while loading is in progress
+    const wrapper = wrap || {};
+    const functionCalls = new Map();
+    let _resolved = null;
+    let lazy = new TLazy(async () => {
+        // do the loading
+        const result = await loader();
+        // copy values from wrapper to result
+        Object.entries(wrapper).forEach(([key, value]) => {
+            if (value !== undefined && (!wrap || wrap[key] == null)) {
+                result[key] = value;
+            }
+        });
+        // call functions that were called before the object was resolved
+        for (const [key, args] of functionCalls) {
+            const fn = result[key];
+            fn.apply(result, args);
+        }
+        _resolved = result;
+        if (_resolved) {
+            // free up memory, we don't need the wrapper anymore
+            lazy = null;
+        }
+        return result;
+    });
+    const proxy = new Proxy(wrapper, {
+        get(target, key) {
+            if (key === PromiseGetter) {
+                return _resolved ? null : lazy.promise;
+            }
+            const current = _resolved || lazy.value;
+            if (current) {
+                if (wrap && !(key in current) && key in wrap) {
+                    return target[key];
+                }
+                const res = current[key];
+                if (typeof res === 'function') {
+                    return res.bind(current);
+                }
+                return res;
+            }
+            if (fnKeys === null || fnKeys === void 0 ? void 0 : fnKeys.includes(key)) {
+                return (...args) => {
+                    functionCalls.set(key, args);
+                };
+            }
+            return target[key];
+        },
+        set(target, key, value) {
+            const current = _resolved || lazy.value;
+            if (current) {
+                current[key] = value;
+            }
+            else {
+                target[key] = value;
+            }
+            return true;
+        },
+        getOwnPropertyDescriptor(target, key) {
+            const current = _resolved || lazy.value;
+            if (current) {
+                return Object.getOwnPropertyDescriptor(current, key);
+            }
+            return Object.getOwnPropertyDescriptor(target, key);
+        },
+        ownKeys(target) {
+            const current = _resolved || lazy.value;
+            if (current) {
+                return Object.keys(current);
+            }
+            return Object.keys(target);
+        },
+    });
+    return proxy;
+}
+exports.createPromiseProxy = createPromiseProxy;
+//# sourceMappingURL=promiseProxy.js.map

package/structures/promiseProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promiseProxy.js","sourceRoot":"","sources":["../../src/structures/promiseProxy.ts"],"names":[],"mappings":";;;AAAA,6CAA8C;AAG9C,MAAM,aAAa,GAAG,WAAoB,CAAC;AAwB3C;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAC9B,OAAuD;IAEvD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,GAAG,qBAAW,EAAE,GAAG,OAAO,CAAC;IAEpE,gFAAgF;IAChF,MAAM,OAAO,GAAG,IAAI,IAAI,EAA+B,CAAC;IACxD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEhD,IAAI,SAAS,GAAM,IAAI,CAAC;IAExB,IAAI,IAAI,GAAG,IAAI,KAAK,CAAC,KAAK,IAAI,EAAE;QAC5B,iBAAiB;QACjB,MAAM,MAAM,GAAM,MAAM,MAAM,EAAE,CAAC;QACjC,qCAAqC;QACrC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE;gBACrD,MAAM,CAAC,GAAc,CAAC,GAAG,KAAmB,CAAC;aAChD;QACL,CAAC,CAAC,CAAC;QACH,iEAAiE;QACjE,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,aAAa,EAAE;YACrC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAA6B,CAAC;YACnD,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAC1B;QAED,SAAS,GAAG,MAAM,CAAC;QACnB,IAAI,SAAS,EAAE;YACX,oDAAoD;YACpD,IAAI,GAAG,IAAI,CAAC;SACf;QACD,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE;QAC7B,GAAG,CAAC,MAAM,EAAE,GAAG;YACX,IAAI,GAAG,KAAK,aAAa,EAAE;gBACvB,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C;YAED,MAAM,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;YACxC,IAAI,OAAO,EAAE;gBACT,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE;oBAC1C,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACtB;gBACD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBACzB,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;oBAC3B,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBAC5B;gBACD,OAAO,GAAG,CAAC;aACd;YAED,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,GAAc,CAAC,EAAE;gBAClC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;oBACtB,aAAa,CAAC,GAAG,CAAC,GAAc,EAAE,IAAI,CAAC,CAAC;gBAC5C,CAAC,CAAC;aACL;YAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK;YAClB,MAAM,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;YACxC,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACxB;iBAAM;gBACH,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACvB;YACD,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,wBAAwB,CAAC,MAAM,EAAE,GAAG;YAChC,MAAM,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;YACxC,IAAI,OAAO,EAAE;gBACT,OAAO,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;aACxD;YACD,OAAO,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,CAAC,MAAM;YACV,MAAM,OAAO,GAAG,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC;YACxC,IAAI,OAAO,EAAE;gBACT,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/B;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;KACJ,CAAC,CAAC;IAEH,OAAO,KAAuD,CAAC;AACnE,CAAC;AAtFD,gDAsFC"}

package/types/index.d.ts

@@ -5,6 +5,14 @@ export type Predicate<T> = (value: T) => boolean;
 export type TypedKeys<T extends Object, K> = {
     [P in keyof T]: T[P] extends K ? P : never;
 }[keyof T];
+/** Type for extracting only string keys from T (skips number & symbol keys) */
+export type StringKeys<T> = {
+    [K in keyof T]: K extends string ? K : never;
+}[keyof T];
+/** Type for extraction only keys, values of which are functions with certain args and return result */
+export type FunctionKeys<T, TArgs extends any[] = any[], TRes = any> = {
+    [K in keyof T]: T[K] extends (...args: TArgs) => TRes ? K : never;
+}[keyof T];
 export type ArrayTail<T> = T extends [any, ...infer P] ? [...P] : T;
 export type NestedPick<T, K extends any[]> = K extends Array<never> ? T : {
     [P in K[0]]: P extends keyof T ? NestedPick<T[P], ArrayTail<K>> : never;

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAE7B,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;AAEjD,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,IAAI;KACxC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAC7C,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAEpE,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,IAAI,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GAC7D,CAAC,GACD;KACG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAC1E,CAAC;AAEN,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACrB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjC,CAAC;AAGF,MAAM,MAAM,WAAW,CACf,CAAC,EACD,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAClB,MAAM,SAAS,CAAC,GACd,CAAC,EAAE,GACH,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GACrB,CAAC,GACD,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAE7B,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC;AAEjD,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,IAAI;KACxC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAC7C,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,+EAA+E;AAC/E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAC/C,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,uGAAuG;AACvG,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,KAAK,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,GAAG,IAAI;KAClE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,IAAI,GAAG,CAAC,GAAG,KAAK;CACpE,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAEpE,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,GAAG,EAAE,IAAI,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GAC7D,CAAC,GACD;KACG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAC1E,CAAC;AAEN,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACrB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjC,CAAC;AAGF,MAAM,MAAM,WAAW,CACf,CAAC,EACD,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAClB,MAAM,SAAS,CAAC,GACd,CAAC,EAAE,GACH,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GACrB,CAAC,GACD,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC"}