@augment-vir/common 22.2.2 → 22.3.0

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/object/get-or-set.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrSet = exports.getOrSetFromMap = void 0;
+const run_time_assertions_1 = require("run-time-assertions");
+function getOrSetFromMap(map, key, createNewValueCallback) {
+    const mapKey = key;
+    if (map.has(mapKey)) {
+        return map.get(mapKey);
+    }
+    else {
+        const newValue = createNewValueCallback();
+        map.set(mapKey, newValue);
+        return newValue;
+    }
+}
+exports.getOrSetFromMap = getOrSetFromMap;
+function getOrSet(originalObject, key, createCallback) {
+    if (key in originalObject) {
+        return originalObject[key];
+    }
+    else {
+        const createdValue = createCallback();
+        if ((0, run_time_assertions_1.isPromise)(createdValue)) {
+            return new Promise(async (resolve, reject) => {
+                try {
+                    const awaitedValue = await createdValue;
+                    originalObject[key] = awaitedValue;
+                    resolve(awaitedValue);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            });
+        }
+        else {
+            originalObject[key] = createdValue;
+            return createdValue;
+        }
+    }
+}
+exports.getOrSet = getOrSet;

package/dist/cjs/index.js

@@ -27,9 +27,10 @@ __exportStar(require("./augments/esm-path"), exports);
 __exportStar(require("./augments/function"), exports);
 __exportStar(require("./augments/json"), exports);
 __exportStar(require("./augments/json-compatible"), exports);
-__exportStar(require("./augments/map"), exports);
+__exportStar(require("./augments/object/any-object"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
+__exportStar(require("./augments/object/get-or-set"), exports);
 __exportStar(require("./augments/object/has-key"), exports);
 __exportStar(require("./augments/object/jsonify"), exports);
 __exportStar(require("./augments/object/map-object"), exports);

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

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

package/dist/esm/augments/object/get-or-set.js

@@ -0,0 +1,36 @@
+import { isPromise } from 'run-time-assertions';
+export function getOrSetFromMap(map, key, createNewValueCallback) {
+    const mapKey = key;
+    if (map.has(mapKey)) {
+        return map.get(mapKey);
+    }
+    else {
+        const newValue = createNewValueCallback();
+        map.set(mapKey, newValue);
+        return newValue;
+    }
+}
+export function getOrSet(originalObject, key, createCallback) {
+    if (key in originalObject) {
+        return originalObject[key];
+    }
+    else {
+        const createdValue = createCallback();
+        if (isPromise(createdValue)) {
+            return new Promise(async (resolve, reject) => {
+                try {
+                    const awaitedValue = await createdValue;
+                    originalObject[key] = awaitedValue;
+                    resolve(awaitedValue);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            });
+        }
+        else {
+            originalObject[key] = createdValue;
+            return createdValue;
+        }
+    }
+}

package/dist/esm/index.js

@@ -11,9 +11,10 @@ export * from './augments/esm-path';
 export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
-export * from './augments/map';
+export * from './augments/object/any-object';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/get-or-set';
 export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';

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

@@ -0,0 +1,2 @@
+export type AnyObject = Record<PropertyKey, any>;
+export type UnknownObject = Record<PropertyKey, unknown>;

package/dist/types/augments/object/get-or-set.d.ts

@@ -0,0 +1,26 @@
+import { MaybePromise } from '../promise/promise';
+/**
+ * Get a value from a map or call the callback and return its result and store the result in the
+ * map.
+ */
+export declare function getOrSetFromMap<MapKey extends object, MapValue>(map: WeakMap<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;
+export declare function getOrSetFromMap<MapKey, MapValue>(map: Map<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;
+/**
+ * Given an object, tries to get the given key in that object. If the key is not in that object,
+ * then the given `createCallback` is used to create a new value which is then stored in the given
+ * object and returned. Automatically handles `createCallback` returning a promise, if it does.
+ *
+ * @example
+ *     // instead of doing this
+ *     if (!myObject[myKey]) {
+ *         myObject[myKey] = myValue;
+ *     }
+ *     // notice the not null assertion here
+ *     retrievedValue![nextKey] = 'some value';
+ *
+ *     // do this
+ *     getOrSetInObject(myObject, myKey, () => myValue);
+ */
+export declare function getOrSet<OriginalObject extends object, Key extends keyof OriginalObject>(originalObject: OriginalObject, key: Key, createCallback: () => OriginalObject[Key]): Required<OriginalObject>[Key];
+export declare function getOrSet<OriginalObject extends object, Key extends keyof OriginalObject>(originalObject: OriginalObject, key: Key, createCallback: () => Promise<OriginalObject[Key]>): Promise<Required<OriginalObject>[Key]>;
+export declare function getOrSet<OriginalObject extends object, Key extends keyof OriginalObject>(originalObject: OriginalObject, key: Key, createCallback: () => MaybePromise<OriginalObject[Key]>): MaybePromise<Required<OriginalObject>[Key]>;

package/dist/types/index.d.ts

@@ -11,9 +11,10 @@ export * from './augments/esm-path';
 export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
-export * from './augments/map';
+export * from './augments/object/any-object';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
+export * from './augments/object/get-or-set';
 export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';

package/package.json

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

package/dist/cjs/augments/map.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrSetFromMap = void 0;
-function getOrSetFromMap(map, key, createNewValueCallback) {
-    const mapKey = key;
-    if (map.has(mapKey)) {
-        return map.get(mapKey);
-    }
-    else {
-        const newValue = createNewValueCallback();
-        map.set(mapKey, newValue);
-        return newValue;
-    }
-}
-exports.getOrSetFromMap = getOrSetFromMap;

package/dist/esm/augments/map.js

@@ -1,11 +0,0 @@
-export function getOrSetFromMap(map, key, createNewValueCallback) {
-    const mapKey = key;
-    if (map.has(mapKey)) {
-        return map.get(mapKey);
-    }
-    else {
-        const newValue = createNewValueCallback();
-        map.set(mapKey, newValue);
-        return newValue;
-    }
-}

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

@@ -1,6 +0,0 @@
-/**
- * Get a value from a map or call the callback and return its result and store the result in the
- * map.
- */
-export declare function getOrSetFromMap<MapKey extends object, MapValue>(map: WeakMap<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;
-export declare function getOrSetFromMap<MapKey, MapValue>(map: Map<MapKey, MapValue>, key: MapKey, createNewValueCallback: () => MapValue): MapValue;