type-fns 1.16.0 → 1.18.0

package/dist/types/ArrayWith.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ref:
+ * - https://stackoverflow.com/a/67655609/3068233
+ * - https://stackoverflow.com/a/73409753/3068233
+ */
+type BuildArrayWith<TCheck extends 'len' | 'min', // todo: support 'max' too?
+TLength extends number, TType, TCurrent extends TType[]> = TCurrent['length'] extends TLength ? TCheck extends 'len' ? [...TCurrent] : [...TCurrent, ...TType[]] : BuildArrayWith<TCheck, TLength, TType, [...TCurrent, TType]>;
+/**
+ * declares a type of array with a check on its length
+ */
+type ArrayWith<TCheck extends 'len' | 'min', // todo: support 'max' too?
+TLength extends number, TType> = BuildArrayWith<TCheck, TLength, TType, []>;

package/dist/types/ArrayWith.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=ArrayWith.js.map

package/dist/types/ArrayWith.js.map

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

package/dist/types/ArrayWith.test.d.ts

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

package/dist/types/ArrayWith.test.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_fns_1 = require("test-fns");
+describe('ArrayWith', () => {
+    (0, test_fns_1.given)('desire for array with min length', () => {
+        (0, test_fns_1.then)('we can declare the type', () => {
+            let products;
+        });
+        (0, test_fns_1.then)('it allows arrays of exactly the min length to it', () => {
+            const products = ['doughnut']; // 🍩
+        });
+        (0, test_fns_1.then)('it allows arrays with more than the min length to it', () => {
+            const products = ['doughnut', 'waffle']; // 🍩, 🧇
+        });
+        (0, test_fns_1.then)('it blocks arrays with less than the min length to it', () => {
+            // @ts-expect-error; Type '[]' is not assignable to type '[string, ...string[]]'. Source has 0 element(s) but target requires 1.ts(2322)
+            const products = []; // 🍩, 🧇
+        });
+    });
+    (0, test_fns_1.given)('desire for array with exact length', () => {
+        (0, test_fns_1.then)('we can declare the type', () => {
+            let products;
+        });
+        (0, test_fns_1.then)('it allows arrays of exactly the desired length to it', () => {
+            const products = ['doughnut']; // 🍩
+        });
+        (0, test_fns_1.then)('it allows arrays with more than the desired length to it', () => {
+            // @ts-expect-error; Type '[string, string]' is not assignable to type '[string]'.Source has 2 element(s) but target allows only 1.
+            const products = ['doughnut', 'waffle']; // 🍩, 🧇
+        });
+        (0, test_fns_1.then)('it blocks arrays with less than the desired length to it', () => {
+            // @ts-expect-error; Type '[]' is not assignable to type '[string]'. Source has 0 element(s) but target requires 1.ts(2322)
+            const products = [];
+        });
+    });
+});
+//# sourceMappingURL=ArrayWith.test.js.map

package/dist/types/ArrayWith.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayWith.test.js","sourceRoot":"","sources":["../../src/types/ArrayWith.test.ts"],"names":[],"mappings":";;AAAA,uCAA6C;AAE7C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAA,gBAAK,EAAC,kCAAkC,EAAE,GAAG,EAAE;QAC7C,IAAA,eAAI,EAAC,yBAAyB,EAAE,GAAG,EAAE;YACnC,IAAI,QAAqC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,kDAAkD,EAAE,GAAG,EAAE;YAC5D,MAAM,QAAQ,GAAgC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK;QACnE,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,MAAM,QAAQ,GAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;QACjF,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,wIAAwI;YACxI,MAAM,QAAQ,GAAgC,EAAE,CAAC,CAAC,SAAS;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAA,gBAAK,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC/C,IAAA,eAAI,EAAC,yBAAyB,EAAE,GAAG,EAAE;YACnC,IAAI,QAAqC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,MAAM,QAAQ,GAAgC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK;QACnE,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,0DAA0D,EAAE,GAAG,EAAE;YACpE,mIAAmI;YACnI,MAAM,QAAQ,GAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;QACjF,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,0DAA0D,EAAE,GAAG,EAAE;YACpE,2HAA2H;YAC3H,MAAM,QAAQ,GAAgC,EAAE,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/utils/environment.d.ts

@@ -3,5 +3,6 @@ export declare enum Stage {
     DEVELOPMENT = "dev",
     TEST = "test"
 }
-export declare const stage: string;
+export declare const isOfStage: import("type-fns").AssessWithAssure<string | number | symbol, Stage>;
+export declare const stage: Stage;
 export declare const serviceClientStage: Stage;

package/dist/utils/environment.js

@@ -1,12 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serviceClientStage = exports.stage = exports.Stage = void 0;
+exports.serviceClientStage = exports.stage = exports.isOfStage = exports.Stage = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const type_fns_1 = require("type-fns");
 var Stage;
 (function (Stage) {
     Stage["PRODUCTION"] = "prod";
     Stage["DEVELOPMENT"] = "dev";
     Stage["TEST"] = "test";
 })(Stage || (exports.Stage = Stage = {}));
+exports.isOfStage = (0, type_fns_1.createIsOfEnum)(Stage);
+/**
+ * verify that the server is on UTC timezone
+ *
+ * why?
+ * - non UTC timezone usage causes problems and takes a while to track down
+ * - by failing fast if the server our code runs in is not in UTC, we avoid these issues
+ * =>
+ * - create a pit of success
+ */
+const TIMEZONE = process.env.TZ;
+if (TIMEZONE !== 'UTC')
+    throw new error_fns_1.UnexpectedCodePathError('env.TZ is not set to UTC. this can cause issues. please set the env var', { found: TIMEZONE, desire: 'UTC' });
 /**
  * this allows us to infer what the stage should be in environments that do not have STAGE specified
  * - e.g., when running locally
@@ -32,6 +47,8 @@ const getEnvironment = () => {
     const stage = (_a = process.env.STAGE) !== null && _a !== void 0 ? _a : inferStageFromNodeEnv(); // figure it out from NODE_ENV if not explicitly defined
     if (!stage)
         throw new Error('process.env.STAGE must be defined');
+    if (!(0, exports.isOfStage)(stage))
+        throw new Error(`invalid stage defined '${stage}'`);
     return { stage };
 };
 // export stage immediately, since it does not change

package/dist/utils/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/utils/environment.ts"],"names":[],"mappings":";;;AAAA,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAED;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACjC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iCAAiC;IACvE,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtE,IAAI,OAAO,KAAK,YAAY;QAAE,OAAO,KAAK,CAAC,UAAU,CAAC;IACtD,IAAI,OAAO,KAAK,aAAa;QAAE,OAAO,KAAK,CAAC,WAAW,CAAC;IACxD,IAAI,OAAO,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IAC1C,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,GAAG,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,cAAc,GAAG,GAAG,EAAE;;IAC1B,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,KAAK,mCAAI,qBAAqB,EAAE,CAAC,CAAC,wDAAwD;IACpH,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACjE,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,qDAAqD;AACtC,aAAK,GAAK,cAAc,EAAE,OAAC;AAE1C,8BAA8B;AACjB,QAAA,kBAAkB,GAC7B,aAAK,KAAK,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,8CAA8C"}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/utils/environment.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAC9D,uCAA0C;AAE1C,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AACY,QAAA,SAAS,GAAG,IAAA,yBAAc,EAAC,KAAK,CAAC,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;AAChC,IAAI,QAAQ,KAAK,KAAK;IACpB,MAAM,IAAI,mCAAuB,CAC/B,yEAAyE,EACzE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CACnC,CAAC;AAEJ;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACjC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iCAAiC;IACvE,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtE,IAAI,OAAO,KAAK,YAAY;QAAE,OAAO,KAAK,CAAC,UAAU,CAAC;IACtD,IAAI,OAAO,KAAK,aAAa;QAAE,OAAO,KAAK,CAAC,WAAW,CAAC;IACxD,IAAI,OAAO,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IAC1C,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,GAAG,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,cAAc,GAAG,GAAG,EAAE;;IAC1B,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,KAAK,mCAAI,qBAAqB,EAAE,CAAC,CAAC,wDAAwD;IACpH,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACjE,IAAI,CAAC,IAAA,iBAAS,EAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,GAAG,CAAC,CAAC;IAC3E,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF,qDAAqD;AACtC,aAAK,GAAK,cAAc,EAAE,OAAC;AAE1C,8BAA8B;AACjB,QAAA,kBAAkB,GAC7B,aAAK,KAAK,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,8CAA8C"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "type-fns",
   "author": "ehmpathy",
   "description": "A set of types, type checks, and type guards for simpler, safer, and easier to read code.",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [
@@ -16,6 +16,7 @@
     "typescript"
   ],
   "bugs": "https://github.com/ehmpathy/type-fns/issues",
+  "license": "MIT",
   "main": "dist/index.js",
   "engines": {
     "node": ">=8.0.0"
@@ -34,25 +35,31 @@
     "build": "npm run build:clean && npm run build:compile",
     "test:commits": "LAST_TAG=$(git describe --tags --abbrev=0 @^ 2> /dev/null || git rev-list --max-parents=0 HEAD) && npx commitlint --from $LAST_TAG --to HEAD --verbose",
     "test:types": "tsc -p ./tsconfig.build.json --noEmit",
-    "prepublish": "npm run build",
     "test:format:prettier": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
     "test:format": "npm run test:format:prettier",
     "test:lint:deps": "npx depcheck -c ./depcheckrc.yml",
     "test:lint:eslint": "eslint -c ./.eslintrc.js src/**/*.ts",
     "test:lint": "npm run test:lint:eslint && npm run test:lint:deps",
-    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests",
-    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --verbose --passWithNoTests",
+    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main')",
+    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main')",
     "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
     "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally",
     "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
     "prepush": "npm run test && npm run build",
+    "prepublish": "npm run build",
     "preversion": "npm run prepush",
-    "postversion": "git push origin HEAD --tags --no-verify"
+    "postversion": "git push origin HEAD --tags --no-verify",
+    "postinstall": "[ -d .git ] && npx husky install || exit 0"
+  },
+  "dependencies": {
+    "@ehmpathy/error-fns": "1.0.2",
+    "type-fns": "1.16.0",
+    "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "13.1.0",
+    "@commitlint/cli": "19.3.0",
     "@commitlint/config-conventional": "13.1.0",
-    "@trivago/prettier-plugin-sort-imports": "2.0.4",
+    "@trivago/prettier-plugin-sort-imports": "4.3.0",
     "@tsconfig/node-lts-strictest": "18.12.1",
     "@types/jest": "29.2.4",
     "@types/uuid": "9.0.0",
@@ -60,19 +67,19 @@
     "@typescript-eslint/parser": "7.8.0",
     "core-js": "3.26.1",
     "cz-conventional-changelog": "3.3.0",
-    "declapract": "0.11.2",
-    "declapract-typescript-ehmpathy": "0.23.7",
+    "declapract": "0.11.5",
+    "declapract-typescript-ehmpathy": "0.33.6",
     "depcheck": "1.4.3",
     "eslint": "8.56.0",
     "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.2.1",
-    "husky": "7.0.2",
+    "husky": "8.0.3",
     "jest": "29.3.1",
     "prettier": "2.8.1",
     "test-fns": "1.3.0",
-    "ts-jest": "29.0.3",
+    "ts-jest": "29.1.3",
     "ts-node": "10.9.2",
     "typescript": "5.4.5",
     "uuid": "^3.3.3"
@@ -81,8 +88,5 @@
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
     }
-  },
-  "dependencies": {
-    "@ehmpathy/error-fns": "1.0.2"
   }
 }

package/dist/utils/errors/UnexpectedCodePathError.d.ts

@@ -1,9 +0,0 @@
-/**
- * UnexpectedCodePath errors are used to indicate that we've reached a code path that should never have been reached
- *
- * Purpose of having a dedicated class for this type of error is to allow us to easily add metadata about what was going on when we reached this code path
- * - e.g., the variables in memory at the time
- */
-export declare class UnexpectedCodePathError extends Error {
-    constructor(message: string, metadata?: Record<string, any>);
-}

package/dist/utils/errors/UnexpectedCodePathError.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnexpectedCodePathError = void 0;
-/**
- * UnexpectedCodePath errors are used to indicate that we've reached a code path that should never have been reached
- *
- * Purpose of having a dedicated class for this type of error is to allow us to easily add metadata about what was going on when we reached this code path
- * - e.g., the variables in memory at the time
- */
-class UnexpectedCodePathError extends Error {
-    constructor(message, metadata) {
-        const fullMessage = `UnexpectedCodePath: ${message}${metadata ? `\n\n${JSON.stringify(metadata)}` : ''}}`;
-        super(fullMessage);
-    }
-}
-exports.UnexpectedCodePathError = UnexpectedCodePathError;
-//# sourceMappingURL=UnexpectedCodePathError.js.map

package/dist/utils/errors/UnexpectedCodePathError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UnexpectedCodePathError.js","sourceRoot":"","sources":["../../../src/utils/errors/UnexpectedCodePathError.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,OAAe,EAAE,QAA8B;QACzD,MAAM,WAAW,GAAG,uBAAuB,OAAO,GAChD,QAAQ,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EACjD,GAAG,CAAC;QACJ,KAAK,CAAC,WAAW,CAAC,CAAC;IACrB,CAAC;CACF;AAPD,0DAOC"}