@augment-vir/common 8.1.0 → 9.1.0

package/dist/cjs/augments/object/filter-object.d.ts

@@ -0,0 +1,5 @@
+import { PropertyValueType } from './object';
+export declare function filterObject<ObjectGeneric>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: PropertyValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
+export declare function omitObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, omitTheseKeys: ReadonlyArray<KeyGeneric>): Omit<ObjectGeneric, KeyGeneric>;
+export declare function pickObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, pickTheseKeys: ReadonlyArray<KeyGeneric>): Pick<ObjectGeneric, KeyGeneric>;
+//# sourceMappingURL=filter-object.d.ts.map

package/dist/cjs/augments/object/filter-object.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pickObjectKeys = exports.omitObjectKeys = exports.filterObject = void 0;
+const object_entries_1 = require("./object-entries");
+function filterObject(inputObject, callback) {
+    const filteredKeys = (0, object_entries_1.getObjectTypedKeys)(inputObject).filter((key) => {
+        const value = inputObject[key];
+        return callback(key, value, inputObject);
+    });
+    return filteredKeys.reduce((accum, key) => {
+        accum[key] = inputObject[key];
+        return accum;
+    }, {});
+}
+exports.filterObject = filterObject;
+function omitObjectKeys(inputObject, omitTheseKeys) {
+    return filterObject(inputObject, (currentKey) => {
+        return !omitTheseKeys.includes(currentKey);
+    });
+}
+exports.omitObjectKeys = omitObjectKeys;
+function pickObjectKeys(inputObject, pickTheseKeys) {
+    return filterObject(inputObject, (currentKey) => {
+        return pickTheseKeys.includes(currentKey);
+    });
+}
+exports.pickObjectKeys = pickObjectKeys;

package/dist/cjs/augments/object/jsonify.d.ts

@@ -0,0 +1,3 @@
+import { Jsonify } from 'type-fest';
+export declare function jsonify<InputGeneric>(input: InputGeneric): Jsonify<InputGeneric>;
+//# sourceMappingURL=jsonify.d.ts.map

package/dist/cjs/augments/object/jsonify.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonify = void 0;
+function jsonify(input) {
+    return JSON.parse(JSON.stringify(input));
+}
+exports.jsonify = jsonify;

package/dist/cjs/augments/object/nested-keys.d.ts

@@ -1,11 +1,11 @@
 import { UnionToIntersection } from 'type-fest';
-import { ObjectValueType } from './object';
-export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+import { PropertyValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = PropertyValueType<{
     [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
 }>;
-export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>> extends object ? [
     keyof ObjectGeneric,
-    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+    ...(NestedKeys<UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>>> | [])
 ] : [keyof ObjectGeneric];
 export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = NestedKeysGeneric extends readonly [infer FirstEntry, ...infer FollowingEntries] ? FirstEntry extends keyof ObjectGeneric ? FollowingEntries extends never[] ? ObjectGeneric[FirstEntry] : ObjectGeneric[FirstEntry] extends object ? FollowingEntries extends NestedSequentialKeys<ObjectGeneric[FirstEntry]> ? NestedValue<ObjectGeneric[FirstEntry], FollowingEntries> : never : never : never : never;
 export declare function getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;

package/dist/cjs/augments/object/object.d.ts

@@ -3,8 +3,7 @@ export type PartialWithNullable<T extends object> = {
 };
 export declare function isObject(input: any): input is NonNullable<object>;
 export declare function areJsonEqual(a: object, b: object): boolean;
-export declare function filterObject<ObjectGeneric extends object>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: ObjectValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
 /** The input here must be serializable otherwise JSON parsing errors will be thrown */
 export declare function copyThroughJson<T>(input: T): T;
-export type ObjectValueType<T extends object> = T[keyof T];
+export type PropertyValueType<T> = T[keyof T];
 //# sourceMappingURL=object.d.ts.map

package/dist/cjs/augments/object/object.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.copyThroughJson = exports.filterObject = exports.areJsonEqual = exports.isObject = void 0;
+exports.copyThroughJson = exports.areJsonEqual = exports.isObject = void 0;
 const object_entries_1 = require("./object-entries");
 function isObject(input) {
     return !!input && typeof input === 'object';
@@ -18,17 +18,6 @@ function areJsonEqual(a, b) {
     }
 }
 exports.areJsonEqual = areJsonEqual;
-function filterObject(inputObject, callback) {
-    const filteredKeys = (0, object_entries_1.getObjectTypedKeys)(inputObject).filter((key) => {
-        const value = inputObject[key];
-        return callback(key, value, inputObject);
-    });
-    return filteredKeys.reduce((accum, key) => {
-        accum[key] = inputObject[key];
-        return accum;
-    }, {});
-}
-exports.filterObject = filterObject;
 /** The input here must be serializable otherwise JSON parsing errors will be thrown */
 function copyThroughJson(input) {
     try {

package/dist/cjs/index.d.ts

@@ -8,6 +8,8 @@ export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
 export * from './augments/object/enum';
+export * from './augments/object/filter-object';
+export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
 export * from './augments/object/nested-keys';

package/dist/cjs/index.js

@@ -24,6 +24,8 @@ __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
 __exportStar(require("./augments/object/enum"), exports);
+__exportStar(require("./augments/object/filter-object"), exports);
+__exportStar(require("./augments/object/jsonify"), exports);
 __exportStar(require("./augments/object/map-object"), exports);
 __exportStar(require("./augments/object/matches-object-shape"), exports);
 __exportStar(require("./augments/object/nested-keys"), exports);

package/dist/esm/augments/object/filter-object.d.ts

@@ -0,0 +1,5 @@
+import { PropertyValueType } from './object';
+export declare function filterObject<ObjectGeneric>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: PropertyValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
+export declare function omitObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, omitTheseKeys: ReadonlyArray<KeyGeneric>): Omit<ObjectGeneric, KeyGeneric>;
+export declare function pickObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, pickTheseKeys: ReadonlyArray<KeyGeneric>): Pick<ObjectGeneric, KeyGeneric>;
+//# sourceMappingURL=filter-object.d.ts.map

package/dist/esm/augments/object/filter-object.js

@@ -0,0 +1,21 @@
+import { getObjectTypedKeys } from './object-entries';
+export function filterObject(inputObject, callback) {
+    const filteredKeys = getObjectTypedKeys(inputObject).filter((key) => {
+        const value = inputObject[key];
+        return callback(key, value, inputObject);
+    });
+    return filteredKeys.reduce((accum, key) => {
+        accum[key] = inputObject[key];
+        return accum;
+    }, {});
+}
+export function omitObjectKeys(inputObject, omitTheseKeys) {
+    return filterObject(inputObject, (currentKey) => {
+        return !omitTheseKeys.includes(currentKey);
+    });
+}
+export function pickObjectKeys(inputObject, pickTheseKeys) {
+    return filterObject(inputObject, (currentKey) => {
+        return pickTheseKeys.includes(currentKey);
+    });
+}

package/dist/esm/augments/object/jsonify.d.ts

@@ -0,0 +1,3 @@
+import { Jsonify } from 'type-fest';
+export declare function jsonify<InputGeneric>(input: InputGeneric): Jsonify<InputGeneric>;
+//# sourceMappingURL=jsonify.d.ts.map

package/dist/esm/augments/object/jsonify.js

@@ -0,0 +1,3 @@
+export function jsonify(input) {
+    return JSON.parse(JSON.stringify(input));
+}

package/dist/esm/augments/object/nested-keys.d.ts

@@ -1,11 +1,11 @@
 import { UnionToIntersection } from 'type-fest';
-import { ObjectValueType } from './object';
-export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+import { PropertyValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = PropertyValueType<{
     [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
 }>;
-export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>> extends object ? [
     keyof ObjectGeneric,
-    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+    ...(NestedKeys<UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>>> | [])
 ] : [keyof ObjectGeneric];
 export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = NestedKeysGeneric extends readonly [infer FirstEntry, ...infer FollowingEntries] ? FirstEntry extends keyof ObjectGeneric ? FollowingEntries extends never[] ? ObjectGeneric[FirstEntry] : ObjectGeneric[FirstEntry] extends object ? FollowingEntries extends NestedSequentialKeys<ObjectGeneric[FirstEntry]> ? NestedValue<ObjectGeneric[FirstEntry], FollowingEntries> : never : never : never : never;
 export declare function getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;

package/dist/esm/augments/object/object.d.ts

@@ -3,8 +3,7 @@ export type PartialWithNullable<T extends object> = {
 };
 export declare function isObject(input: any): input is NonNullable<object>;
 export declare function areJsonEqual(a: object, b: object): boolean;
-export declare function filterObject<ObjectGeneric extends object>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: ObjectValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
 /** The input here must be serializable otherwise JSON parsing errors will be thrown */
 export declare function copyThroughJson<T>(input: T): T;
-export type ObjectValueType<T extends object> = T[keyof T];
+export type PropertyValueType<T> = T[keyof T];
 //# sourceMappingURL=object.d.ts.map

package/dist/esm/augments/object/object.js

@@ -1,4 +1,4 @@
-import { getEntriesSortedByKey, getObjectTypedKeys } from './object-entries';
+import { getEntriesSortedByKey } from './object-entries';
 export function isObject(input) {
     return !!input && typeof input === 'object';
 }
@@ -13,16 +13,6 @@ export function areJsonEqual(a, b) {
         throw error;
     }
 }
-export function filterObject(inputObject, callback) {
-    const filteredKeys = getObjectTypedKeys(inputObject).filter((key) => {
-        const value = inputObject[key];
-        return callback(key, value, inputObject);
-    });
-    return filteredKeys.reduce((accum, key) => {
-        accum[key] = inputObject[key];
-        return accum;
-    }, {});
-}
 /** The input here must be serializable otherwise JSON parsing errors will be thrown */
 export function copyThroughJson(input) {
     try {

package/dist/esm/index.d.ts

@@ -8,6 +8,8 @@ export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
 export * from './augments/object/enum';
+export * from './augments/object/filter-object';
+export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
 export * from './augments/object/nested-keys';

package/dist/esm/index.js

@@ -8,6 +8,8 @@ export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
 export * from './augments/object/enum';
+export * from './augments/object/filter-object';
+export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
 export * from './augments/object/nested-keys';

package/dist/types/augments/object/filter-object.d.ts

@@ -0,0 +1,5 @@
+import { PropertyValueType } from './object';
+export declare function filterObject<ObjectGeneric>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: PropertyValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
+export declare function omitObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, omitTheseKeys: ReadonlyArray<KeyGeneric>): Omit<ObjectGeneric, KeyGeneric>;
+export declare function pickObjectKeys<ObjectGeneric, KeyGeneric extends keyof ObjectGeneric>(inputObject: Readonly<ObjectGeneric>, pickTheseKeys: ReadonlyArray<KeyGeneric>): Pick<ObjectGeneric, KeyGeneric>;
+//# sourceMappingURL=filter-object.d.ts.map

package/dist/types/augments/object/jsonify.d.ts

@@ -0,0 +1,3 @@
+import { Jsonify } from 'type-fest';
+export declare function jsonify<InputGeneric>(input: InputGeneric): Jsonify<InputGeneric>;
+//# sourceMappingURL=jsonify.d.ts.map

package/dist/types/augments/object/nested-keys.d.ts

@@ -1,11 +1,11 @@
 import { UnionToIntersection } from 'type-fest';
-import { ObjectValueType } from './object';
-export type NestedSequentialKeys<ObjectGeneric extends object> = ObjectValueType<{
+import { PropertyValueType } from './object';
+export type NestedSequentialKeys<ObjectGeneric extends object> = PropertyValueType<{
     [Prop in keyof ObjectGeneric]: NonNullable<ObjectGeneric[Prop]> extends object ? [Prop, ...(NestedSequentialKeys<NonNullable<ObjectGeneric[Prop]>> | [])] : [Prop];
 }>;
-export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>> extends object ? [
+export type NestedKeys<ObjectGeneric extends object> = UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>> extends object ? [
     keyof ObjectGeneric,
-    ...(NestedKeys<UnionToIntersection<Extract<ObjectValueType<ObjectGeneric>, object>>> | [])
+    ...(NestedKeys<UnionToIntersection<Extract<PropertyValueType<ObjectGeneric>, object>>> | [])
 ] : [keyof ObjectGeneric];
 export type NestedValue<ObjectGeneric extends object, NestedKeysGeneric extends NestedSequentialKeys<ObjectGeneric>> = NestedKeysGeneric extends readonly [infer FirstEntry, ...infer FollowingEntries] ? FirstEntry extends keyof ObjectGeneric ? FollowingEntries extends never[] ? ObjectGeneric[FirstEntry] : ObjectGeneric[FirstEntry] extends object ? FollowingEntries extends NestedSequentialKeys<ObjectGeneric[FirstEntry]> ? NestedValue<ObjectGeneric[FirstEntry], FollowingEntries> : never : never : never : never;
 export declare function getValueFromNestedKeys<ObjectGeneric extends object, KeysGeneric extends NestedSequentialKeys<ObjectGeneric>>(inputObject: ObjectGeneric, nestedKeys: KeysGeneric): NestedValue<ObjectGeneric, KeysGeneric> | undefined;

package/dist/types/augments/object/object.d.ts

@@ -3,8 +3,7 @@ export type PartialWithNullable<T extends object> = {
 };
 export declare function isObject(input: any): input is NonNullable<object>;
 export declare function areJsonEqual(a: object, b: object): boolean;
-export declare function filterObject<ObjectGeneric extends object>(inputObject: ObjectGeneric, callback: (key: keyof ObjectGeneric, value: ObjectValueType<ObjectGeneric>, fullObject: ObjectGeneric) => boolean): Partial<ObjectGeneric>;
 /** The input here must be serializable otherwise JSON parsing errors will be thrown */
 export declare function copyThroughJson<T>(input: T): T;
-export type ObjectValueType<T extends object> = T[keyof T];
+export type PropertyValueType<T> = T[keyof T];
 //# sourceMappingURL=object.d.ts.map

package/dist/types/index.d.ts

@@ -8,6 +8,8 @@ export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
 export * from './augments/object/enum';
+export * from './augments/object/filter-object';
+export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
 export * from './augments/object/matches-object-shape';
 export * from './augments/object/nested-keys';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "8.1.0",
+    "version": "9.1.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"