@augment-vir/common 12.2.1 → 12.3.0

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

@@ -1,8 +1,23 @@
 import { UnPromise } from '../type';
+import { PropertyValueType } from './object';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };
 export type MappedValues<EntireInputGeneric extends object, MappedValueGeneric> = MappedValueGeneric extends PromiseLike<unknown> ? Promise<InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>> : InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>;
+/**
+ * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
+ * that this will not wrap the return value in a promise if any of the new object values are
+ * promises. This function also requires currying in order to get the types correct. This allows you
+ * to explicitly state the return type.
+ *
+ * @example
+ *     mapObjectValuesSync({objectToIterateOver: 'initial value'})<{objectToIterateOver: number}>(
+ *         (key, value) => ({
+ *             newValue: value.length,
+ *         }),
+ *     );
+ */
+export declare function mapObjectValuesSync<EntireInputGeneric extends object>(inputObject: EntireInputGeneric): <OutputObjectGeneric extends object>(mapCallback: (inputKey: keyof EntireInputGeneric, keyValue: EntireInputGeneric[keyof EntireInputGeneric], fullObject: EntireInputGeneric) => never extends PropertyValueType<OutputObjectGeneric> ? any : PropertyValueType<OutputObjectGeneric>) => OutputObjectGeneric;
 /**
  * Creates a new object with the same properties as the input object, but with values set to the
  * result of mapCallback for each property.

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

@@ -1,7 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapObjectValues = void 0;
+exports.mapObjectValues = exports.mapObjectValuesSync = void 0;
 const object_entries_1 = require("./object-entries");
+/**
+ * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
+ * that this will not wrap the return value in a promise if any of the new object values are
+ * promises. This function also requires currying in order to get the types correct. This allows you
+ * to explicitly state the return type.
+ *
+ * @example
+ *     mapObjectValuesSync({objectToIterateOver: 'initial value'})<{objectToIterateOver: number}>(
+ *         (key, value) => ({
+ *             newValue: value.length,
+ *         }),
+ *     );
+ */
+function mapObjectValuesSync(inputObject) {
+    function innerMap(mapCallback) {
+        const mappedObject = (0, object_entries_1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
+            const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
+            return {
+                ...accum,
+                [currentKey]: mappedValue,
+            };
+        }, {});
+        return mappedObject;
+    }
+    return innerMap;
+}
+exports.mapObjectValuesSync = mapObjectValuesSync;
 /**
  * Creates a new object with the same properties as the input object, but with values set to the
  * result of mapCallback for each property.

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

@@ -1,8 +1,23 @@
 import { UnPromise } from '../type';
+import { PropertyValueType } from './object';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };
 export type MappedValues<EntireInputGeneric extends object, MappedValueGeneric> = MappedValueGeneric extends PromiseLike<unknown> ? Promise<InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>> : InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>;
+/**
+ * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
+ * that this will not wrap the return value in a promise if any of the new object values are
+ * promises. This function also requires currying in order to get the types correct. This allows you
+ * to explicitly state the return type.
+ *
+ * @example
+ *     mapObjectValuesSync({objectToIterateOver: 'initial value'})<{objectToIterateOver: number}>(
+ *         (key, value) => ({
+ *             newValue: value.length,
+ *         }),
+ *     );
+ */
+export declare function mapObjectValuesSync<EntireInputGeneric extends object>(inputObject: EntireInputGeneric): <OutputObjectGeneric extends object>(mapCallback: (inputKey: keyof EntireInputGeneric, keyValue: EntireInputGeneric[keyof EntireInputGeneric], fullObject: EntireInputGeneric) => never extends PropertyValueType<OutputObjectGeneric> ? any : PropertyValueType<OutputObjectGeneric>) => OutputObjectGeneric;
 /**
  * Creates a new object with the same properties as the input object, but with values set to the
  * result of mapCallback for each property.

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

@@ -1,4 +1,30 @@
 import { getObjectTypedKeys } from './object-entries';
+/**
+ * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
+ * that this will not wrap the return value in a promise if any of the new object values are
+ * promises. This function also requires currying in order to get the types correct. This allows you
+ * to explicitly state the return type.
+ *
+ * @example
+ *     mapObjectValuesSync({objectToIterateOver: 'initial value'})<{objectToIterateOver: number}>(
+ *         (key, value) => ({
+ *             newValue: value.length,
+ *         }),
+ *     );
+ */
+export function mapObjectValuesSync(inputObject) {
+    function innerMap(mapCallback) {
+        const mappedObject = getObjectTypedKeys(inputObject).reduce((accum, currentKey) => {
+            const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
+            return {
+                ...accum,
+                [currentKey]: mappedValue,
+            };
+        }, {});
+        return mappedObject;
+    }
+    return innerMap;
+}
 /**
  * Creates a new object with the same properties as the input object, but with values set to the
  * result of mapCallback for each property.

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

@@ -1,8 +1,23 @@
 import { UnPromise } from '../type';
+import { PropertyValueType } from './object';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };
 export type MappedValues<EntireInputGeneric extends object, MappedValueGeneric> = MappedValueGeneric extends PromiseLike<unknown> ? Promise<InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>> : InnerMappedValues<EntireInputGeneric, UnPromise<MappedValueGeneric>>;
+/**
+ * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
+ * that this will not wrap the return value in a promise if any of the new object values are
+ * promises. This function also requires currying in order to get the types correct. This allows you
+ * to explicitly state the return type.
+ *
+ * @example
+ *     mapObjectValuesSync({objectToIterateOver: 'initial value'})<{objectToIterateOver: number}>(
+ *         (key, value) => ({
+ *             newValue: value.length,
+ *         }),
+ *     );
+ */
+export declare function mapObjectValuesSync<EntireInputGeneric extends object>(inputObject: EntireInputGeneric): <OutputObjectGeneric extends object>(mapCallback: (inputKey: keyof EntireInputGeneric, keyValue: EntireInputGeneric[keyof EntireInputGeneric], fullObject: EntireInputGeneric) => never extends PropertyValueType<OutputObjectGeneric> ? any : PropertyValueType<OutputObjectGeneric>) => OutputObjectGeneric;
 /**
  * Creates a new object with the same properties as the input object, but with values set to the
  * result of mapCallback for each property.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "12.2.1",
+    "version": "12.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,10 +24,10 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "type-fest": "^3.5.3"
+        "type-fest": "^3.5.6"
     },
     "devDependencies": {
-        "typescript": "^4.9.4"
+        "typescript": "^4.9.5"
     },
     "publishConfig": {
         "access": "public"