type-fns 0.8.1 → 0.9.1

package/dist/checks/hasMetadata.d.ts

@@ -1,7 +1,7 @@
 /**
  * these are the keys most commonly used metadata keys
  */
-declare const typicalMetadataKeys: readonly ["id", "uuid", "createdAt", "updatedAt", "effectiveAt"];
+declare const typicalMetadataKeys: readonly ["id", "uuid", "createdAt", "updatedAt", "deletedAt", "effectiveAt"];
 /**
  * these are the keys most commonly used metadata keys
  */
@@ -14,6 +14,7 @@ type TypicalMetadataKeys = typeof typicalMetadataKeys[number];
  * - `uuid`
  * - `createdAt`
  * - `updatedAt`
+ * - `deletedAt`
  * - `effectiveAt`
  *
  * note:
@@ -32,9 +33,10 @@ MetadataKeys>>;
  * - `uuid`
  * - `createdAt`
  * - `updatedAt`
+ * - `deletedAt`
  * - `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 declare const hasMetadata: <MetadataKeys extends string = "id" | "uuid" | "createdAt" | "updatedAt" | "deletedAt" | "effectiveAt", T extends Record<string, any> = Record<string, any>>(obj: T, keys?: MetadataKeys[]) => obj is HasMetadata<T, MetadataKeys>;
 export {};

package/dist/checks/hasMetadata.js

@@ -9,6 +9,7 @@ const typicalMetadataKeys = [
     'uuid',
     'createdAt',
     'updatedAt',
+    'deletedAt',
     'effectiveAt',
 ];
 /**
@@ -19,6 +20,7 @@ const typicalMetadataKeys = [
  * - `uuid`
  * - `createdAt`
  * - `updatedAt`
+ * - `deletedAt`
  * - `effectiveAt`
  *
  * see more information about the `HasMetadata` type in its jsdoc on-hover documentation

package/dist/checks/hasMetadata.js.map

@@ -1 +1 @@
-{"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"}
+{"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,WAAW;IACX,aAAa;CACL,CAAC;AAoCX;;;;;;;;;;;;GAYG;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/companions/omit.d.ts

@@ -0,0 +1,4 @@
+/**
+ * a companion to the `Omit` type, returns a new object without the omitted attributes
+ */
+export declare const omit: <T extends Record<string, any>>(obj: T, keys: (keyof T)[]) => Omit<T, keyof T>;

package/dist/companions/omit.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.omit = void 0;
+/**
+ * a companion to the `Omit` type, returns a new object without the omitted attributes
+ */
+const omit = (obj, keys) => Object.entries(obj).reduce((summary, [key, value]) => {
+    // if key is in the specified keys, dont add it to the new object
+    if (keys.includes(key))
+        return summary;
+    // if it is not within specified keys, add it
+    return Object.assign(Object.assign({}, summary), { [key]: value });
+}, {});
+exports.omit = omit;
+//# sourceMappingURL=omit.js.map

package/dist/companions/omit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.js","sourceRoot":"","sources":["../../src/companions/omit.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAiB,EACa,EAAE,CAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,iEAAiE;IACjE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAEvC,6CAA6C;IAC7C,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAV1B,QAAA,IAAI,QAUsB"}

package/dist/companions/pick.d.ts

@@ -0,0 +1,4 @@
+/**
+ * a companion to the `Pick` type, returns a new object with only the picked attributes
+ */
+export declare const pick: <T extends Record<string, any>>(obj: T, keys: (keyof T)[]) => Pick<T, keyof T>;

package/dist/companions/pick.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pick = void 0;
+/**
+ * a companion to the `Pick` type, returns a new object with only the picked attributes
+ */
+const pick = (obj, keys) => Object.entries(obj).reduce((summary, [key, value]) => {
+    // if key is not in the specified keys, dont add it to the new object
+    if (!keys.includes(key))
+        return summary;
+    // if it is within specified keys, add it
+    return Object.assign(Object.assign({}, summary), { [key]: value });
+}, {});
+exports.pick = pick;
+//# sourceMappingURL=pick.js.map

package/dist/companions/pick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.js","sourceRoot":"","sources":["../../src/companions/pick.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAiB,EACa,EAAE,CAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,qEAAqE;IACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAExC,yCAAyC;IACzC,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAV1B,QAAA,IAAI,QAUsB"}

package/dist/index.d.ts

@@ -10,3 +10,5 @@ export * from './types/PickOne';
 export * from './checks/isNotNull';
 export * from './checks/isNotUndefined';
 export * from './types/DropFirst';
+export * from './companions/omit';
+export * from './companions/pick';

package/dist/index.js

@@ -26,4 +26,6 @@ __exportStar(require("./types/PickOne"), exports);
 __exportStar(require("./checks/isNotNull"), exports);
 __exportStar(require("./checks/isNotUndefined"), exports);
 __exportStar(require("./types/DropFirst"), exports);
+__exportStar(require("./companions/omit"), exports);
+__exportStar(require("./companions/pick"), 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;AACxC,oDAAkC"}
+{"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;AAClC,oDAAkC;AAClC,oDAAkC"}

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": "0.8.1",
+  "version": "0.9.1",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [
@@ -25,25 +25,23 @@
   ],
   "scripts": {
     "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:format": "npm run fix:format:prettier",
     "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",
+    "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: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: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: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",
@@ -62,8 +60,8 @@
     "@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",
+    "declapract": "0.11.2",
+    "declapract-typescript-ehmpathy": "0.23.7",
     "depcheck": "1.4.3",
     "eslint": "8.30.0",
     "eslint-config-airbnb-typescript": "17.0.0",

package/readme.md

@@ -1,8 +1,5 @@
 # type-fns
 
-![ci_on_commit](https://github.com/ehmpathy/type-fns/workflows/ci_on_commit/badge.svg)
-![deploy_on_tag](https://github.com/ehmpathy/type-fns/workflows/deploy_on_tag/badge.svg)
-
 Narrow your codepaths with generic types, type checks, and type guards for simpler, safer, and easier to read code.
 
 # Purpose