wrapper-fns 1.0.0 → 1.1.0

package/dist/contract/index.d.ts

@@ -1,3 +1,5 @@
 export { withBottleneck } from '../logic/withBottleneck';
 export { withRetry } from '../logic/withRetry';
 export { withTimeout } from '../logic/withTimeout';
+export * from '../domain/objects/Wrapper';
+export * from '../logic/withWrappers';

package/dist/contract/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withTimeout = exports.withRetry = exports.withBottleneck = void 0;
 var withBottleneck_1 = require("../logic/withBottleneck");
@@ -7,4 +21,6 @@ var withRetry_1 = require("../logic/withRetry");
 Object.defineProperty(exports, "withRetry", { enumerable: true, get: function () { return withRetry_1.withRetry; } });
 var withTimeout_1 = require("../logic/withTimeout");
 Object.defineProperty(exports, "withTimeout", { enumerable: true, get: function () { return withTimeout_1.withTimeout; } });
+__exportStar(require("../domain/objects/Wrapper"), exports);
+__exportStar(require("../logic/withWrappers"), exports);
 //# sourceMappingURL=index.js.map

package/dist/contract/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":";;;AAAA,0DAAyD;AAAhD,gHAAA,cAAc,OAAA;AACvB,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,oDAAmD;AAA1C,0GAAA,WAAW,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0DAAyD;AAAhD,gHAAA,cAAc,OAAA;AACvB,gDAA+C;AAAtC,sGAAA,SAAS,OAAA;AAClB,oDAAmD;AAA1C,0GAAA,WAAW,OAAA;AAEpB,4DAA0C;AAC1C,wDAAsC"}

package/dist/domain/objects/Wrapper.d.ts

@@ -0,0 +1,6 @@
+import { Procedure } from 'domain-glossary-procedure';
+export type Wrapper<TProcedure extends Procedure, TOptions> = (logic: TProcedure, options: TOptions) => TProcedure;
+export type WrapperChoice<TProcedure extends Procedure, TOptions> = {
+    wrapper: Wrapper<TProcedure, TOptions>;
+    options: TOptions;
+};

package/dist/domain/objects/Wrapper.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Wrapper.js.map

package/dist/domain/objects/Wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/domain/objects/Wrapper.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './contract/index';

package/dist/index.js

@@ -1,2 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./contract/index"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC"}

package/dist/logic/withWrappers.d.ts

@@ -0,0 +1,16 @@
+import { Procedure } from 'domain-glossary-procedure';
+import { WrapperChoice } from '../domain/objects/Wrapper';
+/**
+ * .what = a helper procedure to ensure that the choice.options matches the wrapper.options
+ */
+export declare const setWrapper: <TProc extends Procedure, TOptions>(input: WrapperChoice<TProc, TOptions>) => WrapperChoice<TProc, TOptions> & {
+    _safe: true;
+};
+/**
+ * .what = a wrapper of wrappers
+ * .why =
+ *   - eliminates nested indentation when multiple wrappers are used
+ */
+export declare function withWrappers<TProcedure extends Procedure, TChoices extends ReadonlyArray<WrapperChoice<TProcedure, any> & {
+    _safe: true;
+}>>(logic: TProcedure, wrappers: TChoices): TProcedure;

package/dist/logic/withWrappers.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withWrappers = exports.setWrapper = void 0;
+/**
+ * .what = a helper procedure to ensure that the choice.options matches the wrapper.options
+ */
+const setWrapper = (input) => {
+    return Object.assign(input, { _safe: true }); // add the safe flag to compile-time warn if setter was not used; // todo: use a symbol instead
+};
+exports.setWrapper = setWrapper;
+/**
+ * .what = a wrapper of wrappers
+ * .why =
+ *   - eliminates nested indentation when multiple wrappers are used
+ */
+function withWrappers(logic, wrappers) {
+    return wrappers.reduce((wrapped, { wrapper, options }) => wrapper(wrapped, options), logic);
+}
+exports.withWrappers = withWrappers;
+//# sourceMappingURL=withWrappers.js.map

package/dist/logic/withWrappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withWrappers.js","sourceRoot":"","sources":["../../src/logic/withWrappers.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACI,MAAM,UAAU,GAAG,CACxB,KAAqC,EACa,EAAE;IACpD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAa,EAAE,CAAC,CAAC,CAAC,+FAA+F;AACxJ,CAAC,CAAC;AAJW,QAAA,UAAU,cAIrB;AAEF;;;;GAIG;AACH,SAAgB,YAAY,CAK1B,KAAiB,EAAE,QAAkB;IACrC,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,EAC5D,KAAK,CACN,CAAC;AACJ,CAAC;AAVD,oCAUC"}

package/dist/logic/withWrappers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/logic/withWrappers.test.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_fns_1 = require("test-fns");
+const withWrappers_1 = require("./withWrappers");
+describe('withWrappers', () => {
+    (0, test_fns_1.given)('a simple procedure to wrap', () => {
+        const withTimeoutCallInputs = [];
+        const withTimeout = (logic, { threshold }) => {
+            return async (input, context) => {
+                withTimeoutCallInputs.push(input);
+                const start = Date.now();
+                const result = await logic(input, context);
+                const duration = Date.now() - start;
+                if (duration > threshold)
+                    console.warn(`Took too long: ${duration}ms`);
+                return result;
+            };
+        };
+        const withLogTrailCallInputs = [];
+        const withLogTrail = (logic, { name }) => {
+            return async (input, context) => {
+                withLogTrailCallInputs.push(input);
+                console.log(`[${name}] Input:`, input);
+                const result = await logic(input, context);
+                console.log(`[${name}] Output:`, result);
+                return result;
+            };
+        };
+        const logic = async (input, context) => {
+            return `Processed ${input.payload} for ${context.userUuid}`;
+        };
+        (0, test_fns_1.then)('it should successfully execute the wrappers', async () => {
+            const wrapped = (0, withWrappers_1.withWrappers)(logic, [
+                (0, withWrappers_1.setWrapper)({
+                    wrapper: withLogTrail,
+                    options: { name: 'wrapped-procedure' },
+                }),
+                (0, withWrappers_1.setWrapper)({
+                    wrapper: withTimeout,
+                    options: { threshold: 100 },
+                }),
+            ]);
+            await wrapped({ payload: 'yellow' }, { userUuid: 'beefbeef...' });
+            expect(withLogTrailCallInputs.length).toEqual(1);
+            expect(withTimeoutCallInputs.length).toEqual(1);
+            await wrapped({ payload: 'blue' }, { userUuid: 'beefbeef...' });
+            expect(withLogTrailCallInputs.length).toEqual(2);
+            expect(withTimeoutCallInputs.length).toEqual(2);
+        });
+        (0, test_fns_1.then)('it should typethrow if setWrapper was not used', {
+            because: 'this guarantees the options are typechecked',
+        }, () => {
+            (0, withWrappers_1.withWrappers)(logic, [
+                // @ts-expect-error: Property '_safe' is missing in type '{ wrapper: Wrapper<Procedure, { name: string; }>; options: { name: string; }; }' but required in type '{ _safe: true; }'.
+                {
+                    wrapper: withLogTrail,
+                    options: { name: 'wrapped-procedure' },
+                },
+            ]);
+        });
+    });
+});
+//# sourceMappingURL=withWrappers.test.js.map

package/dist/logic/withWrappers.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withWrappers.test.js","sourceRoot":"","sources":["../../src/logic/withWrappers.test.ts"],"names":[],"mappings":";;AAAA,uCAAuC;AAIvC,iDAA0D;AAE1D,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAA,gBAAK,EAAC,4BAA4B,EAAE,GAAG,EAAE;QACvC,MAAM,qBAAqB,GAAU,EAAE,CAAC;QACxC,MAAM,WAAW,GAA8C,CAC7D,KAAK,EACL,EAAE,SAAS,EAAE,EACb,EAAE;YACF,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC9B,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;gBACpC,IAAI,QAAQ,GAAG,SAAS;oBAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,QAAQ,IAAI,CAAC,CAAC;gBACvE,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,sBAAsB,GAAU,EAAE,CAAC;QACzC,MAAM,YAAY,GAAyC,CACzD,KAAK,EACL,EAAE,IAAI,EAAE,EACR,EAAE;YACF,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBAC9B,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,UAAU,EAAE,KAAK,CAAC,CAAC;gBACvC,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW,EAAE,MAAM,CAAC,CAAC;gBACzC,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,KAAK,GAIP,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC3B,OAAO,aAAa,KAAK,CAAC,OAAO,QAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QAC9D,CAAC,CAAC;QAEF,IAAA,eAAI,EAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,OAAO,GAAG,IAAA,2BAAY,EAAC,KAAK,EAAE;gBAClC,IAAA,yBAAU,EAAC;oBACT,OAAO,EAAE,YAAY;oBACrB,OAAO,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE;iBACvC,CAAC;gBACF,IAAA,yBAAU,EAAC;oBACT,OAAO,EAAE,WAAW;oBACpB,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE;iBAC5B,CAAC;aACH,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;YAClE,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAEhD,MAAM,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;YAChE,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,IAAA,eAAI,EACF,gDAAgD,EAChD;YACE,OAAO,EAAE,6CAA6C;SACvD,EACD,GAAG,EAAE;YACH,IAAA,2BAAY,EAAC,KAAK,EAAE;gBAClB,mLAAmL;gBACnL;oBACE,OAAO,EAAE,YAAY;oBACrB,OAAO,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE;iBACvC;aACF,CAAC,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "wrapper-fns",
   "author": "ehmpathy",
   "description": "Use wrappers for simpler, safer, and more readable code",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "repository": "ehmpathy/wrapper-fns",
   "homepage": "https://github.com/ehmpathy/wrapper-fns",
   "keywords": [
@@ -51,6 +51,7 @@
   "dependencies": {
     "@ehmpathy/uni-time": "1.7.4",
     "bottleneck": "2.19.5",
+    "domain-glossary-procedure": "1.0.0",
     "visualogic": "1.3.2"
   },
   "devDependencies": {
@@ -74,6 +75,7 @@
     "husky": "8.0.3",
     "jest": "29.3.1",
     "prettier": "2.8.1",
+    "test-fns": "1.5.0",
     "ts-jest": "29.1.3",
     "ts-node": "10.9.2",
     "typescript": "5.4.5"

package/readme.md

@@ -16,6 +16,26 @@ npm install wrapper-fns
 
 # use
 
+### `withWrappers`
+
+applies wrappers chosen in a list, to avoid nested indentations
+
+```ts
+const wrapped = withWrappers(doGreatThing, [
+  setWrapper({
+    wrapper: withLogTrail,
+    options: { name: 'doGreatThing' },
+  }),
+  setWrapper({
+    wrapper: withTimeout,
+    options: { threshold: 100 },
+  }),
+]);
+```
+
+*note, we use `setWrapper` to allow typescript to enforce the relationship between `options` and the `wrapper`*
+
+
 ### `withRetry`
 
 retries the wrapped logic execution in case of failure