type-fns 0.6.0 → 0.8.1

package/dist/checks/hasId.d.ts

@@ -1,7 +1,7 @@
 /**
  * asserts that an object has an id
  */
-export declare type HasId<T> = T & {
+export type HasId<T> = T & {
     id: number;
 };
 /**

package/dist/checks/hasId.js

@@ -4,7 +4,8 @@ exports.hasId = void 0;
 /**
  * checks whether not an object that may have an id does have the id, at runtime
  */
-exports.hasId = (obj) => {
+const hasId = (obj) => {
     return !!obj.id;
 };
+exports.hasId = hasId;
 //# sourceMappingURL=hasId.js.map

package/dist/checks/hasId.js.map

@@ -1 +1 @@
-{"version":3,"file":"hasId.js","sourceRoot":"","sources":["../../src/checks/hasId.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACU,QAAA,KAAK,GAAG,CAAwC,GAAM,EAAmB,EAAE;IACtF,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;AAClB,CAAC,CAAC"}
+{"version":3,"file":"hasId.js","sourceRoot":"","sources":["../../src/checks/hasId.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACI,MAAM,KAAK,GAAG,CACnB,GAAM,EACW,EAAE;IACnB,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;AAClB,CAAC,CAAC;AAJW,QAAA,KAAK,SAIhB"}

package/dist/checks/hasId.test.d.ts

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

package/dist/checks/hasId.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hasId_1 = require("./hasId");
+describe('hasId', () => {
+    it('should return true if an object has an id', () => {
+        const obj = { id: 821, name: 'bob' };
+        const itHasId = (0, hasId_1.hasId)(obj);
+        expect(itHasId).toEqual(true);
+    });
+    it('should return false if an object does not have an id', () => {
+        const obj = { name: 'bob' };
+        const itHasId = (0, hasId_1.hasId)(obj);
+        expect(itHasId).toEqual(false);
+    });
+});
+//# sourceMappingURL=hasId.test.js.map

package/dist/checks/hasId.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasId.test.js","sourceRoot":"","sources":["../../src/checks/hasId.test.ts"],"names":[],"mappings":";;AAAA,mCAAgC;AAEhC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,GAAG,GAAkC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACpE,MAAM,OAAO,GAAG,IAAA,aAAK,EAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,GAAG,GAAkC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,IAAA,aAAK,EAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/hasMetadata.d.ts

@@ -1,7 +1,11 @@
 /**
  * these are the keys most commonly used metadata keys
  */
-declare type TypicalMetadataKeys = 'id' | 'uuid' | 'createdAt' | 'updatedAt' | 'effectiveAt';
+declare const typicalMetadataKeys: readonly ["id", "uuid", "createdAt", "updatedAt", "effectiveAt"];
+/**
+ * these are the keys most commonly used metadata keys
+ */
+type TypicalMetadataKeys = typeof typicalMetadataKeys[number];
 /**
  * asserts that any optional metadata keys of the object will now be required
  *
@@ -15,9 +19,22 @@ declare type TypicalMetadataKeys = 'id' | 'uuid' | 'createdAt' | 'updatedAt' | '
  * note:
  * - this type does not make any other optional, non-metadata keys required
  *   - i.e., any optional types on the object that are not specified as metadata keys will not be made required
- * - this type does not _add_ any database-generated properties to the type definition
+ * - this type does not _add_ any metadata properties to the type definition
  *   - i.e., if a metadata key was not already present on the object's type - it will not be added
  */
-export declare type HasMetadata<T extends Record<string, any>, MetadataKeys = TypicalMetadataKeys> = T & Required<Pick<T, keyof T & // that are on the object
+export type HasMetadata<T extends Record<string, any>, MetadataKeys = TypicalMetadataKeys> = T & Required<Pick<T, keyof T & // that are on the object
 MetadataKeys>>;
+/**
+ * for an object of type T, asserts that the object HasMetadata<T, K> for all listed metadata keys K
+ *
+ * by default, the following keys are considered to be metadata:
+ * - `id`
+ * - `uuid`
+ * - `createdAt`
+ * - `updatedAt`
+ * - `effectiveAt`
+ *
+ * see more information about the `HasMetadata` type in its jsdoc on-hover documentation
+ */
+export declare const hasMetadata: <MetadataKeys extends string = "id" | "uuid" | "createdAt" | "updatedAt" | "effectiveAt", T extends Record<string, any> = Record<string, any>>(obj: T, keys?: MetadataKeys[]) => obj is HasMetadata<T, MetadataKeys>;
 export {};

package/dist/checks/hasMetadata.js

@@ -1,3 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasMetadata = void 0;
+/**
+ * these are the keys most commonly used metadata keys
+ */
+const typicalMetadataKeys = [
+    'id',
+    'uuid',
+    'createdAt',
+    'updatedAt',
+    'effectiveAt',
+];
+/**
+ * for an object of type T, asserts that the object HasMetadata<T, K> for all listed metadata keys K
+ *
+ * by default, the following keys are considered to be metadata:
+ * - `id`
+ * - `uuid`
+ * - `createdAt`
+ * - `updatedAt`
+ * - `effectiveAt`
+ *
+ * see more information about the `HasMetadata` type in its jsdoc on-hover documentation
+ */
+const hasMetadata = (obj, keys = typicalMetadataKeys) => keys.every((key) => obj[key] !== undefined);
+exports.hasMetadata = hasMetadata;
 //# sourceMappingURL=hasMetadata.js.map

package/dist/checks/hasMetadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"hasMetadata.js","sourceRoot":"","sources":["../../src/checks/hasMetadata.ts"],"names":[],"mappings":""}
+{"version":3,"file":"hasMetadata.js","sourceRoot":"","sources":["../../src/checks/hasMetadata.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAM,mBAAmB,GAAG;IAC1B,IAAI;IACJ,MAAM;IACN,WAAW;IACX,WAAW;IACX,aAAa;CACL,CAAC;AAmCX;;;;;;;;;;;GAWG;AACI,MAAM,WAAW,GAAG,CAIzB,GAAM,EACN,OAAuB,mBAA4C,EACvB,EAAE,CAC9C,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;AAPjC,QAAA,WAAW,eAOsB"}

package/dist/checks/hasMetadata.test.d.ts

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

package/dist/checks/hasMetadata.test.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+describe('HasMetadata', () => {
+    it('should enable accessing an optional metadata property of a type', () => {
+        const pot = { id: 123, age: 72 };
+        expect(pot.id.toFixed).toBeDefined(); // no type errors
+    });
+});
+describe('hasMetadata', () => {
+    it('should enable accessing an optional metadata property of a type', () => {
+        const pot = { id: 123, age: 72 };
+        if (!(0, __1.hasMetadata)(pot, ['id']))
+            throw new Error('doesnt have metadata');
+        expect(pot.id.toFixed).toBeDefined();
+    });
+});
+//# sourceMappingURL=hasMetadata.test.js.map

package/dist/checks/hasMetadata.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasMetadata.test.js","sourceRoot":"","sources":["../../src/checks/hasMetadata.test.ts"],"names":[],"mappings":";;AAAA,0BAAiC;AAGjC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAEzE,MAAM,GAAG,GAA2B,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,iBAAiB;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAEzE,MAAM,GAAG,GAAc,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAA,eAAW,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QACvE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/hasUuid.d.ts

@@ -1,7 +1,7 @@
 /**
  * asserts that an object has a uuid
  */
-export declare type HasUuid<T> = T & {
+export type HasUuid<T> = T & {
     uuid: string;
 };
 /**

package/dist/checks/hasUuid.js

@@ -4,7 +4,8 @@ exports.hasUuid = void 0;
 /**
  * checks whether not an object that may have a uuid does have the uuid, at runtime
  */
-exports.hasUuid = (obj) => {
+const hasUuid = (obj) => {
     return typeof obj.uuid === 'string';
 };
+exports.hasUuid = hasUuid;
 //# sourceMappingURL=hasUuid.js.map

package/dist/checks/hasUuid.js.map

@@ -1 +1 @@
-{"version":3,"file":"hasUuid.js","sourceRoot":"","sources":["../../src/checks/hasUuid.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACU,QAAA,OAAO,GAAG,CAA0C,GAAM,EAAqB,EAAE;IAC5F,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;AACtC,CAAC,CAAC"}
+{"version":3,"file":"hasUuid.js","sourceRoot":"","sources":["../../src/checks/hasUuid.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACI,MAAM,OAAO,GAAG,CACrB,GAAM,EACa,EAAE;IACrB,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;AACtC,CAAC,CAAC;AAJW,QAAA,OAAO,WAIlB"}

package/dist/checks/hasUuid.test.d.ts

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

package/dist/checks/hasUuid.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hasUuid_1 = require("./hasUuid");
+describe('hasUuid', () => {
+    it('should return true if an object has an id', () => {
+        const obj = { uuid: 'uuid', name: 'bob' };
+        const itHasUuid = (0, hasUuid_1.hasUuid)(obj);
+        expect(itHasUuid).toEqual(true);
+    });
+    it('should return false if an object does not have an id', () => {
+        const obj = { name: 'bob' };
+        const itHasUuid = (0, hasUuid_1.hasUuid)(obj);
+        expect(itHasUuid).toEqual(false);
+    });
+});
+//# sourceMappingURL=hasUuid.test.js.map

package/dist/checks/hasUuid.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasUuid.test.js","sourceRoot":"","sources":["../../src/checks/hasUuid.test.ts"],"names":[],"mappings":";;AAAA,uCAAoC;AAEpC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,GAAG,GAAoC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAA,iBAAO,EAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,GAAG,GAAoC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAA,iBAAO,EAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/isAFunction.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAFunction = void 0;
-exports.isAFunction = (obj) => typeof obj === 'function';
+// eslint-disable-next-line @typescript-eslint/ban-types
+const isAFunction = (obj) => typeof obj === 'function';
+exports.isAFunction = isAFunction;
 //# sourceMappingURL=isAFunction.js.map

package/dist/checks/isAFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"isAFunction.js","sourceRoot":"","sources":["../../src/checks/isAFunction.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,CAAC,GAAQ,EAAmB,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,CAAC"}
+{"version":3,"file":"isAFunction.js","sourceRoot":"","sources":["../../src/checks/isAFunction.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACjD,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAmB,EAAE,CACvD,OAAO,GAAG,KAAK,UAAU,CAAC;AADf,QAAA,WAAW,eACI"}

package/dist/checks/isAPromise.d.ts

@@ -1,4 +1,4 @@
 /**
  * checks whether the value is a promise
  */
-export declare const isAPromise: <T extends unknown = any>(obj: any) => obj is Promise<T>;
+export declare const isAPromise: <T = any>(obj: any) => obj is Promise<T>;

package/dist/checks/isAPromise.js

@@ -4,5 +4,6 @@ exports.isAPromise = void 0;
 /**
  * checks whether the value is a promise
  */
-exports.isAPromise = (obj) => Promise.resolve(obj) === obj;
+const isAPromise = (obj) => Promise.resolve(obj) === obj;
+exports.isAPromise = isAPromise;
 //# sourceMappingURL=isAPromise.js.map

package/dist/checks/isAPromise.js.map

@@ -1 +1 @@
-{"version":3,"file":"isAPromise.js","sourceRoot":"","sources":["../../src/checks/isAPromise.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,UAAU,GAAG,CAAsB,GAAQ,EAAqB,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC"}
+{"version":3,"file":"isAPromise.js","sourceRoot":"","sources":["../../src/checks/isAPromise.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,UAAU,GAAG,CAAU,GAAQ,EAAqB,EAAE,CACjE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC;AADlB,QAAA,UAAU,cACQ"}

package/dist/checks/isAPromise.test.d.ts

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

package/dist/checks/isAPromise.test.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isAPromise_1 = require("./isAPromise");
+describe('isAPromise', () => {
+    it('should return true for promises', () => {
+        const descision = (0, isAPromise_1.isAPromise)(Promise.resolve('hello'));
+        expect(descision).toEqual(true);
+    });
+    it('should return false for not promises', () => {
+        const descision = (0, isAPromise_1.isAPromise)('hello');
+        expect(descision).toEqual(false);
+    });
+    it('should be usable to narrow the typescript type', () => {
+        // imagine we didn't know whether soonerOrLater is a promise or a string
+        const soonerOrLater = Promise.resolve('hello');
+        // we can use this check to narrow down the typescript type and do operations specific to each type
+        if ((0, isAPromise_1.isAPromise)(soonerOrLater)) {
+            void soonerOrLater.then(() => 'done');
+        }
+        else {
+            void soonerOrLater.toLowerCase();
+        }
+    });
+});
+//# sourceMappingURL=isAPromise.test.js.map

package/dist/checks/isAPromise.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isAPromise.test.js","sourceRoot":"","sources":["../../src/checks/isAPromise.test.ts"],"names":[],"mappings":";;AAAA,6CAA0C;AAE1C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,SAAS,GAAG,IAAA,uBAAU,EAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,SAAS,GAAG,IAAA,uBAAU,EAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,wEAAwE;QACxE,MAAM,aAAa,GAA6B,OAAO,CAAC,OAAO,CAC7D,OAAO,CACD,CAAC;QAET,mGAAmG;QACnG,IAAI,IAAA,uBAAU,EAAC,aAAa,CAAC,EAAE;YAC7B,KAAK,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;SACvC;aAAM;YACL,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC;SAClC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/isNotNull.d.ts

@@ -4,7 +4,7 @@
  * ref
  * - https://stackoverflow.com/a/63045455/3068233
  */
-export declare type NotNull<T> = T extends null ? never : T;
+export type NotNull<T> = T extends null ? never : T;
 /**
  * checks whether the value is not undefined
  */

package/dist/checks/isNotNull.js

@@ -4,5 +4,6 @@ exports.isNotNull = void 0;
 /**
  * checks whether the value is not undefined
  */
-exports.isNotNull = (val) => val !== null;
+const isNotNull = (val) => val !== null;
+exports.isNotNull = isNotNull;
 //# sourceMappingURL=isNotNull.js.map

package/dist/checks/isNotNull.js.map

@@ -1 +1 @@
-{"version":3,"file":"isNotNull.js","sourceRoot":"","sources":["../../src/checks/isNotNull.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACU,QAAA,SAAS,GAAG,CAAI,GAAM,EAAqB,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC"}
+{"version":3,"file":"isNotNull.js","sourceRoot":"","sources":["../../src/checks/isNotNull.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACI,MAAM,SAAS,GAAG,CAAI,GAAM,EAAqB,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC;AAA3D,QAAA,SAAS,aAAkD"}

package/dist/checks/isNotNull.test.d.ts

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

package/dist/checks/isNotNull.test.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const __1 = require("..");
+describe('isNotNull', () => {
+    it('should constrain type correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const maybeNumber = undefined; // valid
+        if ((0, __1.isNotNull)(maybeNumber)) {
+            const defNumber = maybeNumber; // valid
+        }
+    }));
+});
+describe('NotNull', () => {
+    it('should constrain type correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const notMaybeNumber = 821;
+        const onlyNumber = notMaybeNumber; // valid
+    }));
+});
+//# sourceMappingURL=isNotNull.test.js.map

package/dist/checks/isNotNull.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNotNull.test.js","sourceRoot":"","sources":["../../src/checks/isNotNull.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sDAAsD;AACtD,0BAAwC;AAExC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAG/C,MAAM,WAAW,GAAgB,SAAgB,CAAC,CAAC,QAAQ;QAE3D,IAAI,IAAA,aAAS,EAAC,WAAW,CAAC,EAAE;YAC1B,MAAM,SAAS,GAAW,WAAW,CAAC,CAAC,QAAQ;SAChD;IACH,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAG/C,MAAM,cAAc,GAAyB,GAAU,CAAC;QACxD,MAAM,UAAU,GAAW,cAAc,CAAC,CAAC,QAAQ;IACrD,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/isNotUndefined.d.ts

@@ -4,7 +4,7 @@
  * ref
  * - https://stackoverflow.com/a/63045455/3068233
  */
-export declare type NotUndefined<T> = T extends undefined ? never : T;
+export type NotUndefined<T> = T extends undefined ? never : T;
 /**
  * checks whether the value is not undefined
  */

package/dist/checks/isNotUndefined.js

@@ -4,5 +4,6 @@ exports.isNotUndefined = void 0;
 /**
  * checks whether the value is not undefined
  */
-exports.isNotUndefined = (val) => typeof val !== 'undefined';
+const isNotUndefined = (val) => typeof val !== 'undefined';
+exports.isNotUndefined = isNotUndefined;
 //# sourceMappingURL=isNotUndefined.js.map

package/dist/checks/isNotUndefined.js.map

@@ -1 +1 @@
-{"version":3,"file":"isNotUndefined.js","sourceRoot":"","sources":["../../src/checks/isNotUndefined.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACU,QAAA,cAAc,GAAG,CAAI,GAAM,EAA0B,EAAE,CAAC,OAAO,GAAG,KAAK,WAAW,CAAC"}
+{"version":3,"file":"isNotUndefined.js","sourceRoot":"","sources":["../../src/checks/isNotUndefined.ts"],"names":[],"mappings":";;;AAQA;;GAEG;AACI,MAAM,cAAc,GAAG,CAAI,GAAM,EAA0B,EAAE,CAClE,OAAO,GAAG,KAAK,WAAW,CAAC;AADhB,QAAA,cAAc,kBACE"}

package/dist/checks/isNotUndefined.test.d.ts

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

package/dist/checks/isNotUndefined.test.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const __1 = require("..");
+describe('isNotUndefined', () => {
+    it('should constrain type correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const maybeNumber = undefined; // valid
+        if ((0, __1.isNotUndefined)(maybeNumber)) {
+            const defNumber = maybeNumber; // valid
+        }
+    }));
+});
+describe('NotUndefined', () => {
+    it('should constrain type correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const notMaybeNumber = 821;
+        const onlyNumber = notMaybeNumber; // valid
+    }));
+});
+//# sourceMappingURL=isNotUndefined.test.js.map

package/dist/checks/isNotUndefined.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNotUndefined.test.js","sourceRoot":"","sources":["../../src/checks/isNotUndefined.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sDAAsD;AACtD,0BAAkD;AAElD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAG/C,MAAM,WAAW,GAAgB,SAAgB,CAAC,CAAC,QAAQ;QAE3D,IAAI,IAAA,kBAAc,EAAC,WAAW,CAAC,EAAE;YAC/B,MAAM,SAAS,GAAW,WAAW,CAAC,CAAC,QAAQ;SAChD;IACH,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAG/C,MAAM,cAAc,GAA8B,GAAU,CAAC;QAC7D,MAAM,UAAU,GAAW,cAAc,CAAC,CAAC,QAAQ;IACrD,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/isOfEnum.d.ts

@@ -1,7 +1,3 @@
-/**
- * `Something` = `any`, with the exclusion of `null` and `undefined`
- */
-declare type Something = {};
 /**
  * a generic fn that allows us to create type checks for enums. for example:
  * ```ts
@@ -23,5 +19,8 @@ declare type Something = {};
  *
  * ref: https://stackoverflow.com/a/58278753/3068233
  */
-export declare const createIsOfEnum: <T>(e: T) => (token: Something) => token is T[keyof T];
-export {};
+export declare const createIsOfEnum: <T extends {
+    [index: string]: string | number;
+    [index: number]: string | number;
+    [index: symbol]: string | number;
+}>(e: T) => (token: string | number | symbol) => token is T[keyof T];

package/dist/checks/isOfEnum.js

@@ -22,5 +22,6 @@ exports.createIsOfEnum = void 0;
  *
  * ref: https://stackoverflow.com/a/58278753/3068233
  */
-exports.createIsOfEnum = (e) => (token) => Object.values(e).includes(token);
+const createIsOfEnum = (e) => (token) => Object.values(e).includes(token);
+exports.createIsOfEnum = createIsOfEnum;
 //# sourceMappingURL=isOfEnum.js.map

package/dist/checks/isOfEnum.js.map

@@ -1 +1 @@
-{"version":3,"file":"isOfEnum.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,cAAc,GAAG,CAAI,CAAI,EAAE,EAAE,CAAC,CAAC,KAAgB,EAAuB,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAmB,CAAC,CAAC"}
+{"version":3,"file":"isOfEnum.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,cAAc,GACzB,CAAmE,CAAI,EAAE,EAAE,CAC3E,CAAC,KAA+B,EAAuB,EAAE,CACvD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAmB,CAAC,CAAC;AAHtC,QAAA,cAAc,kBAGwB"}

package/dist/checks/isOfEnum.test.d.ts

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

package/dist/checks/isOfEnum.test.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isOfEnum_1 = require("./isOfEnum");
+describe('isOfEnum', () => {
+    it('can be used for custom enums correctly', () => {
+        let Planet;
+        (function (Planet) {
+            Planet["VENUS"] = "VENUS";
+            Planet["EARTH"] = "EARTH";
+            Planet["MARS"] = "MARS";
+        })(Planet || (Planet = {}));
+        const isPlanet = (0, isOfEnum_1.createIsOfEnum)(Planet);
+        const earthIsPlanet = isPlanet('EARTH');
+        const plutoIsPlanet = isPlanet('PLUTO');
+        expect(earthIsPlanet).toEqual(true);
+        expect(plutoIsPlanet).toEqual(false);
+    });
+});
+//# sourceMappingURL=isOfEnum.test.js.map

package/dist/checks/isOfEnum.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isOfEnum.test.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.test.ts"],"names":[],"mappings":";;AAAA,yCAA4C;AAE5C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,IAAK,MAIJ;QAJD,WAAK,MAAM;YACT,yBAAe,CAAA;YACf,yBAAe,CAAA;YACf,uBAAa,CAAA;QACf,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;QACD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/checks/isPresent.js

@@ -6,5 +6,6 @@ exports.isPresent = void 0;
  *
  * https://github.com/microsoft/TypeScript/issues/16069#issuecomment-566222173
  */
-exports.isPresent = (t) => t !== undefined && t !== null;
+const isPresent = (t) => t !== undefined && t !== null;
+exports.isPresent = isPresent;
 //# sourceMappingURL=isPresent.js.map

package/dist/checks/isPresent.js.map

@@ -1 +1 @@
-{"version":3,"file":"isPresent.js","sourceRoot":"","sources":["../../src/checks/isPresent.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACU,QAAA,SAAS,GAAG,CAAI,CAA8B,EAAU,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC"}
+{"version":3,"file":"isPresent.js","sourceRoot":"","sources":["../../src/checks/isPresent.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,SAAS,GAAG,CAAI,CAA8B,EAAU,EAAE,CACrE,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,CAAC;AADnB,QAAA,SAAS,aACU"}

package/dist/checks/isPresent.test.d.ts

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

package/dist/checks/isPresent.test.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isPresent_1 = require("./isPresent");
+describe('isPresent', () => {
+    it('should return false if is null', () => {
+        expect((0, isPresent_1.isPresent)(null)).toEqual(false);
+    });
+    it('should return false if is undefined', () => {
+        expect((0, isPresent_1.isPresent)(null)).toEqual(false);
+    });
+    it('should return true if is falsy', () => {
+        expect((0, isPresent_1.isPresent)(false)).toEqual(true);
+        expect((0, isPresent_1.isPresent)(0)).toEqual(true);
+        expect((0, isPresent_1.isPresent)('')).toEqual(true);
+    });
+    it('should be useful in having correct types after filtering', () => {
+        const stringsOrNulls = ['hello', '', null, 'world', undefined]; // type = `(string | null | undefined)[]`
+        const strings = stringsOrNulls.filter(isPresent_1.isPresent); // type = string[]
+        // check that it did what we expected in runtime
+        expect(strings).toEqual(['hello', '', 'world']);
+        // check that it successfully informed typescript of this too
+        strings.map((string) => string.toUpperCase()); // This should not throw a type error, because the filter should have told typescript it took out the nulls
+    });
+});
+//# sourceMappingURL=isPresent.test.js.map

package/dist/checks/isPresent.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPresent.test.js","sourceRoot":"","sources":["../../src/checks/isPresent.test.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AAExC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAA,qBAAS,EAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,CAAC,IAAA,qBAAS,EAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,yCAAyC;QACzG,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,qBAAS,CAAC,CAAC,CAAC,kBAAkB;QAEpE,gDAAgD;QAChD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,2GAA2G;IAC5J,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/deps.d.ts

@@ -0,0 +1 @@
+export { v4 as uuid } from 'uuid';

package/dist/deps.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uuid = void 0;
+var uuid_1 = require("uuid");
+Object.defineProperty(exports, "uuid", { enumerable: true, get: function () { return uuid_1.v4; } });
+//# sourceMappingURL=deps.js.map

package/dist/deps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deps.js","sourceRoot":"","sources":["../src/deps.ts"],"names":[],"mappings":";;;AAAA,6BAAkC;AAAzB,4FAAA,EAAE,OAAQ"}

package/dist/domain/constants.d.ts

@@ -0,0 +1,3 @@
+/**
+ * constants shared across the whole service but not tied to a specific domain object go in this file
+ */

package/dist/domain/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * constants shared across the whole service but not tied to a specific domain object go in this file
+ */
+//# sourceMappingURL=constants.js.map

package/dist/domain/constants.js.map

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

package/dist/index.d.ts

@@ -9,3 +9,4 @@ export * from './checks/isAPromise';
 export * from './types/PickOne';
 export * from './checks/isNotNull';
 export * from './checks/isNotUndefined';
+export * from './types/DropFirst';

package/dist/index.js

@@ -1,13 +1,17 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    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("./checks/hasId"), exports);
@@ -21,4 +25,5 @@ __exportStar(require("./checks/isAPromise"), exports);
 __exportStar(require("./types/PickOne"), exports);
 __exportStar(require("./checks/isNotNull"), exports);
 __exportStar(require("./checks/isNotUndefined"), exports);
+__exportStar(require("./types/DropFirst"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA+B;AAC/B,mDAAiC;AACjC,uDAAqC;AACrC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,mDAAiC;AACjC,uDAAqC;AACrC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,0DAAwC;AACxC,oDAAkC"}

package/dist/types/DropFirst.d.ts

@@ -0,0 +1,10 @@
+/**
+ * drop the first type in an array
+ *
+ * example use cases
+ * - reference all parameters except first in typescript
+ *
+ * ref
+ * - https://stackoverflow.com/questions/63024617/how-to-reference-all-parameters-except-first-in-typescript
+ */
+export type DropFirst<T extends unknown[]> = T extends [any, ...infer U] ? U : never;

package/dist/types/DropFirst.js

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

package/dist/types/DropFirst.js.map

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

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

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

package/dist/types/DropFirst.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+describe('DropFirst', () => {
+    it('should be drop the first type in an array', () => {
+        const numStrStr = [1, '2', '3'];
+        const strStr = ['1', '2'];
+        const str = strStr[0];
+        const num = numStrStr[0];
+    });
+});
+//# sourceMappingURL=DropFirst.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DropFirst.test.js","sourceRoot":"","sources":["../../src/types/DropFirst.test.ts"],"names":[],"mappings":";;AAEA,sDAAsD;AACtD,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QAEnD,MAAM,SAAS,GAAuB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACpD,MAAM,MAAM,GAAkC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,GAAG,GAAW,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAW,SAAS,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/types/PickOne.d.ts

@@ -4,6 +4,6 @@
  * ref:
  * - https://stackoverflow.com/a/56933182/3068233
  */
-export declare type PickOne<T> = {
+export type PickOne<T> = {
     [P in keyof T]: Record<P, T[P]> & Partial<Record<Exclude<keyof T, P>, undefined>>;
 }[keyof T];

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

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

package/dist/types/PickOne.test.js

@@ -0,0 +1,38 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+describe('PickOne', () => {
+    it('should constrain type correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const findWrench = ({}) => __awaiter(void 0, void 0, void 0, function* () {
+            // ...
+        });
+        // you can find by metric
+        yield findWrench({
+            size: {
+                metric: { millimeters: 16 },
+            },
+        });
+        // you can find by imperial
+        yield findWrench({
+            size: {
+                imperial: { inches: '5/16' },
+            },
+        });
+        // you can't find by both
+        // await findWrench({
+        //   size: {
+        //     metric: { millimeters: 16 },
+        //     imperial: { inches: '5/16' },
+        //   },
+        // });
+    }));
+});
+//# sourceMappingURL=PickOne.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PickOne.test.js","sourceRoot":"","sources":["../../src/types/PickOne.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,iCAAiC,EAAE,GAAS,EAAE;QAC/C,MAAM,UAAU,GAAG,CAAO,EAezB,EAAE,EAAE;YACH,MAAM;QACR,CAAC,CAAA,CAAC;QAEF,yBAAyB;QACzB,MAAM,UAAU,CAAC;YACf,IAAI,EAAE;gBACJ,MAAM,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;aAC5B;SACF,CAAC,CAAC;QAEH,2BAA2B;QAC3B,MAAM,UAAU,CAAC;YACf,IAAI,EAAE;gBACJ,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;aAC7B;SACF,CAAC,CAAC;QAEH,yBAAyB;QACzB,qBAAqB;QACrB,YAAY;QACZ,mCAAmC;QACnC,oCAAoC;QACpC,OAAO;QACP,MAAM;IACR,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/utils/environment.d.ts

@@ -0,0 +1,7 @@
+export declare enum Stage {
+    PRODUCTION = "prod",
+    DEVELOPMENT = "dev",
+    TEST = "test"
+}
+export declare const stage: string;
+export declare const serviceClientStage: Stage;

package/dist/utils/environment.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serviceClientStage = exports.stage = exports.Stage = void 0;
+var Stage;
+(function (Stage) {
+    Stage["PRODUCTION"] = "prod";
+    Stage["DEVELOPMENT"] = "dev";
+    Stage["TEST"] = "test";
+})(Stage = exports.Stage || (exports.Stage = {}));
+/**
+ * this allows us to infer what the stage should be in environments that do not have STAGE specified
+ * - e.g., when running locally
+ * - e.g., when running tests
+ */
+const inferStageFromNodeEnv = () => {
+    const nodeEnv = process.env.NODE_ENV; // default to test if not defined
+    if (!nodeEnv)
+        throw new Error('process.env.NODE_ENV must be defined');
+    if (nodeEnv === 'production')
+        return Stage.PRODUCTION;
+    if (nodeEnv === 'development')
+        return Stage.DEVELOPMENT;
+    if (nodeEnv === 'test')
+        return Stage.TEST;
+    throw new Error(`unexpected nodeEnv '${nodeEnv}'`);
+};
+/**
+ * a method that exposes relevant environmental variables in a standard way
+ */
+const getEnvironment = () => {
+    var _a;
+    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');
+    return { stage };
+};
+// export stage immediately, since it does not change
+exports.stage = getEnvironment().stage;
+// export service client stage
+exports.serviceClientStage = exports.stage === Stage.PRODUCTION ? Stage.PRODUCTION : Stage.DEVELOPMENT; // i.e., if its prod, hit prod. otherwise, dev
+//# sourceMappingURL=environment.js.map

package/dist/utils/environment.js.map

@@ -0,0 +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,GAAL,aAAK,KAAL,aAAK,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"}

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

@@ -0,0 +1,9 @@
+/**
+ * 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

@@ -0,0 +1,17 @@
+"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

@@ -0,0 +1 @@
+{"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"}

package/dist/wrappers/withNot.js

@@ -11,5 +11,6 @@ exports.withNot = void 0;
  * const invalidOptions = objects.filter(withNot(isOfStatus));
  * ```
  */
-exports.withNot = (is) => (args) => !is(args);
+const withNot = (is) => (args) => !is(args);
+exports.withNot = withNot;
 //# sourceMappingURL=withNot.js.map

package/dist/wrappers/withNot.js.map

@@ -1 +1 @@
-{"version":3,"file":"withNot.js","sourceRoot":"","sources":["../../src/wrappers/withNot.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACU,QAAA,OAAO,GAAG,CAAI,EAAwB,EAA0B,EAAE,CAAC,CAAC,IAAO,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"withNot.js","sourceRoot":"","sources":["../../src/wrappers/withNot.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACI,MAAM,OAAO,GAClB,CAAI,EAAwB,EAA0B,EAAE,CACxD,CAAC,IAAO,EAAE,EAAE,CACV,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AAHD,QAAA,OAAO,WAGN"}

package/dist/wrappers/withNot.test.d.ts

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

package/dist/wrappers/withNot.test.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hasId_1 = require("../checks/hasId");
+const withNot_1 = require("./withNot");
+describe('withNot', () => {
+    it('should return false if an object has an id after wrapping hasId', () => {
+        const obj = { id: 821, name: 'bob' };
+        const itDoesNotHaveId = (0, withNot_1.withNot)(hasId_1.hasId)(obj);
+        expect(itDoesNotHaveId).toEqual(false);
+    });
+    it('should return false if an object does not have an id', () => {
+        const obj = { name: 'bob' };
+        const itDoesNotHaveId = (0, withNot_1.withNot)(hasId_1.hasId)(obj);
+        expect(itDoesNotHaveId).toEqual(true);
+    });
+});
+//# sourceMappingURL=withNot.test.js.map

package/dist/wrappers/withNot.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withNot.test.js","sourceRoot":"","sources":["../../src/wrappers/withNot.test.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AACxC,uCAAoC;AAEpC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,GAAG,GAAkC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACpE,MAAM,eAAe,GAAG,IAAA,iBAAO,EAAC,aAAK,CAAC,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,GAAG,GAAkC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAC3D,MAAM,eAAe,GAAG,IAAA,iBAAO,EAAC,aAAK,CAAC,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "type-fns",
-  "version": "0.6.0",
+  "author": "ehmpathy",
   "description": "A set of types, type checks, and type guards for simpler, safer, and easier to read code.",
-  "author": "UladKasach @uladkasach",
-  "license": "MIT",
+  "version": "0.8.1",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [
@@ -25,40 +24,63 @@
     "/dist"
   ],
   "scripts": {
-    "build:clean": "rm -rf ./dist",
-    "build:ts": "tsc -p ./tsconfig.build.json",
-    "build": "npm run build:clean && npm run build:ts",
-    "test:types": "tsc --noEmit",
-    "test:format": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
-    "test:lint": "eslint -c ./.eslintrc.js src/**/*.ts",
-    "test:unit": "jest --forceExit --verbose --passWithNoTests",
-    "test:integration": "jest -c ./jest.integration.config.js --forceExit --verbose --passWithNoTests",
-    "test": "npm run test:types && npm run test:lint && npm run test:unit && npm run test:integration",
+    "commit:with-cli": "npx cz",
+    "fix:format:terraform": "echo 'no terraform'",
+    "fix:format:prettier": "prettier --write '**/*.ts' --config ./prettier.config.js",
+    "fix:format": "npm run fix:format:prettier && npm run fix:format:terraform",
+    "fix:lint": "eslint -c ./.eslintrc.js src/**/*.ts --fix",
+    "build:artifact": "echo 'no artifact'",
+    "build:clean": "rm dist/ -rf",
+    "build:compile": "tsc -p ./tsconfig.build.json",
+    "build": "npm run build:clean && npm run build:compile && npm run build:artifact",
+    "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",
-    "preversion": "npm run prepublish && npm run test",
+    "test:lint:deps": "npx depcheck -c ./depcheckrc.yml",
+    "test:format:terraform": "echo 'no terraform'",
+    "test:format:prettier": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
+    "test:format": "npm run test:format:prettier && npm run test:format:terraform",
+    "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:lint:eslint": "eslint -c ./.eslintrc.js src/**/*.ts",
+    "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",
+    "preversion": "npm run prepush",
     "postversion": "git push origin HEAD --tags --no-verify"
   },
   "devDependencies": {
-    "@types/jest": "^24.0.18",
-    "@types/lodash.pick": "^4.4.6",
-    "@types/uuid": "^3.4.5",
-    "@typescript-eslint/eslint-plugin": "2.19.0",
-    "@typescript-eslint/parser": "2.19.0",
-    "dotenv": "^8.1.0",
-    "eslint": "6.1.0",
-    "eslint-config-airbnb-base": "14.0.0",
-    "eslint-config-airbnb-typescript": "7.0.0",
-    "eslint-config-prettier": "6.10.0",
-    "eslint-plugin-import": "2.20.1",
-    "eslint-plugin-prettier": "3.1.2",
-    "husky": "^1.3.1",
-    "jest": "^25.5.4",
-    "joi": "^17.2.1",
-    "prettier": "^2.0.4",
-    "ts-jest": "^25.4.0",
-    "typescript": "^3.8.3",
-    "uuid": "^3.3.3",
-    "yup": "^0.29.3"
+    "@commitlint/cli": "13.1.0",
+    "@commitlint/config-conventional": "13.1.0",
+    "@trivago/prettier-plugin-sort-imports": "2.0.4",
+    "@tsconfig/node-lts-strictest": "18.12.1",
+    "@types/jest": "29.2.4",
+    "@types/uuid": "9.0.0",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "core-js": "3.26.1",
+    "cz-conventional-changelog": "3.3.0",
+    "declapract": "^0.10.9",
+    "declapract-typescript-ehmpathy": "^0.20.11",
+    "depcheck": "1.4.3",
+    "eslint": "8.30.0",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "7.0.2",
+    "jest": "29.3.1",
+    "prettier": "2.8.1",
+    "ts-jest": "29.0.3",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.4",
+    "uuid": "^3.3.3"
   },
-  "dependencies": {}
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
 }

package/{README.md → readme.md}

@@ -89,6 +89,20 @@ await findWrench({
 })
 ```
 
+### `DropFirst`
+
+The generic type `DropFirst` lets you exclude the first element of an array.
+
+```ts
+type NumberStringString = [number, string, string];
+const numStrStr: NumberStringString = [1, '2', '3'];
+const strStr: DropFirst<NumberStringString> = ['1', '2'];
+const str: string = strStr[0];
+const num: number = numStrStr[0];
+```
+
+Useful, for example, if you want to change the first parameter of a function while keeping the rest the same.
+
 ## type guards
 
 ### `isPresent`

package/changelog.md

@@ -1,58 +0,0 @@
-# Changelog
-
-## [0.6.0](https://www.github.com/ehmpathy/type-fns/compare/v0.5.1...v0.6.0) (2022-11-25)
-
-
-### Features
-
-* **checks:** add isNotUndefined and isNotNull checks ([e810bdf](https://www.github.com/ehmpathy/type-fns/commit/e810bdf5e2ec6b9caa3e289aa8a7c693524b5e65))
-
-### [0.5.1](https://www.github.com/ehmpathy/type-fns/compare/v0.5.0...v0.5.1) (2022-11-25)
-
-
-### Bug Fixes
-
-* **exports:** actually export NotUndefined ([1869b05](https://www.github.com/ehmpathy/type-fns/commit/1869b05e59764b3b822298dac223b9cb09b02fc0))
-
-## [0.5.0](https://www.github.com/ehmpathy/type-fns/compare/v0.4.1...v0.5.0) (2022-11-25)
-
-
-### Features
-
-* **types:** add the NotUndefined generic type ([bd613c2](https://www.github.com/ehmpathy/type-fns/commit/bd613c27ced111eb44c971734ab343a9cd2fbe8e))
-
-### [0.4.1](https://www.github.com/ehmpathy/type-fns/compare/v0.4.0...v0.4.1) (2022-11-24)
-
-
-### Bug Fixes
-
-* **exports:** actually export isAPromise, isAFunction, PickOne ([ad5b28f](https://www.github.com/ehmpathy/type-fns/commit/ad5b28f1d2da9fe382d1245d38d970b1b0e7bd1c))
-
-## [0.4.0](https://www.github.com/ehmpathy/type-fns/compare/v0.3.0...v0.4.0) (2022-11-24)
-
-
-### Features
-
-* **checks:** add isAFunction, isAPromise, and PickOne type checks and generic type ([981ae42](https://www.github.com/ehmpathy/type-fns/commit/981ae4275530bdae203b9013bed193f1afda6b8d))
-
-
-### Bug Fixes
-
-* **cicd:** update github actions, test scripts, and swap repo org to ehmpathy ([b6a1458](https://www.github.com/ehmpathy/type-fns/commit/b6a1458b6d2d5423255fc8eaee2e3181d0c14850))
-* **doc:** fix comment describing has metadata in code ([d7d2e55](https://www.github.com/ehmpathy/type-fns/commit/d7d2e556ba03ad5a573f90d6ea75c5696f493058))
-* **name:** rename package to type-fns ([66258d9](https://www.github.com/ehmpathy/type-fns/commit/66258d93e7964c675b92f50061ddcb11a79f2b69))
-* **tests:** remove example of type error from tests ([326123c](https://www.github.com/ehmpathy/type-fns/commit/326123cf845b31e82edb0d3d50cd6034217df2fa))
-
-## [0.3.0](https://www.github.com/ehmpathy/type-fns/compare/v0.2.1...v0.3.0) (2022-01-03)
-
-
-### Features
-
-* **checks:** add the HasMetadata type modifier ([85f0ca4](https://www.github.com/ehmpathy/type-fns/commit/85f0ca467983ea6f1fc5845990f98dbe9cbe5e8f))
-
-### [0.2.1](https://www.github.com/ehmpathy/type-fns/compare/v0.2.0...v0.2.1) (2021-11-16)
-
-
-### Bug Fixes
-
-* **enum:** forbid giving isOfEnum functions null or undefined as an input ([98ec621](https://www.github.com/ehmpathy/type-fns/commit/98ec6216bc5775cbb2015f400358fe7d5fffc303))