@dereekb/util 7.6.0 → 7.7.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [7.7.0](https://github.com/dereekb/dbx-components/compare/v7.6.0-dev...v7.7.0) (2022-06-09)
+
+
+### Features
+
+* added UseAsync ([f52ff34](https://github.com/dereekb/dbx-components/commit/f52ff345621ecbcb4d6b0f2957dcd7f4f901ac3a))
+
+
+
 # [7.6.0](https://github.com/dereekb/dbx-components/compare/v7.5.0-dev...v7.6.0) (2022-06-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "7.6.0",
+  "version": "7.7.0",
   "type": "commonjs",
   "exports": {
     ".": {

package/src/lib/getter/getter.d.ts

@@ -1,3 +1,4 @@
+import { PromiseOrValue } from '../promise/promise';
 /**
  * Function that returns a value.
  */
@@ -18,6 +19,10 @@ export declare type FactoryWithRequiredInput<T, A> = (args: A) => T;
  * Either a Getter, or an instance of the item.
  */
 export declare type GetterOrValue<T> = T | Getter<T>;
+/**
+ * A GetterOrValue returned from a Promise.
+ */
+export declare type AsyncGetterOrValue<T> = GetterOrValue<PromiseOrValue<T>>;
 /**
  * Either a GetterWithInput, or a Getter.
  */

package/src/lib/getter/getter.js.map

@@ -1 +1 @@
-{"version":3,"file":"getter.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/getter/getter.ts"],"names":[],"mappings":";;;AAqCA;;;;;GAKG;AACH,SAAgB,QAAQ,CAAc,KAAc;IAClD,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAFD,4BAEC;AAaD,SAAgB,kBAAkB,CAAsB,KAAc,EAAE,IAAQ;IAC9E,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;QAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;KACpB;SAAM;QACL,OAAO,KAAU,CAAC;KACnB;AACH,CAAC;AAND,gDAMC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAI,KAAuB;IACjD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;QAC/B,OAAO,KAAkB,CAAC;KAC3B;SAAM;QACL,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;KAC1B;AACH,CAAC;AAND,4BAMC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAI,KAAQ;IACpC,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;AACrB,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"getter.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/getter/getter.ts"],"names":[],"mappings":";;;AA4CA;;;;;GAKG;AACH,SAAgB,QAAQ,CAAc,KAAc;IAClD,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAFD,4BAEC;AAaD,SAAgB,kBAAkB,CAAsB,KAAc,EAAE,IAAQ;IAC9E,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;QAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;KACpB;SAAM;QACL,OAAO,KAAU,CAAC;KACnB;AACH,CAAC;AAND,gDAMC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAI,KAAuB;IACjD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;QAC/B,OAAO,KAAkB,CAAC;KAC3B;SAAM;QACL,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;KAC1B;AACH,CAAC;AAND,4BAMC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAI,KAAQ;IACpC,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;AACrB,CAAC;AAFD,gCAEC"}

package/src/lib/promise/use.d.ts

@@ -1,12 +1,11 @@
 import { GetterOrValue } from '../getter';
-import { PromiseOrValue } from './promise';
-export declare type UsePromiseUseFunction<I, O> = (value: I) => PromiseOrValue<O>;
+import { UseAsync } from '../value';
 /**
- * Uses a value returned from a promise.
+ * Uses a cached promise value.
  */
-export declare type UsePromiseFunction<I> = <O>(useFn: UsePromiseUseFunction<I, O>) => Promise<O>;
+export declare type UsePromiseFunction<I> = <O>(useFn: UseAsync<I, O>) => Promise<O>;
 /**
- * Creates a UsePromiseFactory.
+ * Creates a UsePromiseFunction.
  *
  * @param input
  * @returns

package/src/lib/promise/use.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.usePromise = void 0;
 const getter_1 = require("../getter");
 /**
- * Creates a UsePromiseFactory.
+ * Creates a UsePromiseFunction.
  *
  * @param input
  * @returns

package/src/lib/promise/use.js.map

@@ -1 +1 @@
-{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/promise/use.ts"],"names":[],"mappings":";;;AAAA,sCAAoD;AAUpD;;;;;GAKG;AACH,SAAgB,UAAU,CAAI,KAAgC;IAC5D,MAAM,OAAO,GAAG,IAAA,iBAAQ,EAAC,KAAK,CAAC,CAAC;IAChC,OAAO,CAAI,KAAkC,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAe,CAAC;AACxF,CAAC;AAHD,gCAGC"}
+{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/promise/use.ts"],"names":[],"mappings":";;;AAAA,sCAAoD;AAQpD;;;;;GAKG;AACH,SAAgB,UAAU,CAAI,KAAgC;IAC5D,MAAM,OAAO,GAAG,IAAA,iBAAQ,EAAC,KAAK,CAAC,CAAC;IAChC,OAAO,CAAI,KAAqB,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAe,CAAC;AAC3E,CAAC;AAHD,gCAGC"}

package/src/lib/value/use.d.ts

@@ -1,4 +1,5 @@
-import { GetterOrValue } from '../getter';
+import { AsyncGetterOrValue, GetterOrValue } from '../getter';
+import { PromiseOrValue } from '../promise/promise';
 import { MapFunction } from './map';
 import { Maybe } from './maybe.type';
 /**
@@ -24,3 +25,18 @@ export declare type UseContextFunction<I> = <O>(input: Maybe<I>) => Maybe<O>;
  * Creates a UseContextFunction.
  */
 export declare function useContextFunction<I, O>(use: UseValue<I, O>, defaultValue?: GetterOrValue<O>): UseContextFunction<I>;
+/**
+ * A map function with the intent of using the input value, and returning another value as a promise.
+ */
+export declare type UseAsync<I, O = void> = MapFunction<I, PromiseOrValue<O>>;
+export declare function useAsync<I, O = void>(input: Maybe<I>, use: UseValue<I, O>, defaultValue?: Maybe<GetterOrValue<O>>): Promise<Maybe<O>>;
+export declare type UseAsyncFunction<I> = MappedUseAsyncFunction<I, I>;
+export declare type MappedUseAsyncFunction<A, I> = <O = void>(input: Maybe<A>, use: UseAsync<I, O>, defaultValue?: Maybe<AsyncGetterOrValue<O>>) => Promise<Maybe<O>>;
+/**
+ * Creates a MappedUseFunction.
+ */
+export declare function mappedUseAsyncFunction<A, I>(map: MapFunction<A, Maybe<PromiseOrValue<I>>>): MappedUseAsyncFunction<A, I>;
+/**
+ * Wraps another MappedUseFunction or MappedUseAsyncFunction and maps the input values.
+ */
+export declare function wrapUseAsyncFunction<A, B, I>(mappedUsePromiseFn: MappedUseAsyncFunction<A, B>, map: MapFunction<B, Maybe<PromiseOrValue<I>>>): MappedUseAsyncFunction<A, I>;

package/src/lib/value/use.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useContextFunction = exports.wrapUseFunction = exports.mappedUseFunction = exports.useValue = void 0;
+exports.wrapUseAsyncFunction = exports.mappedUseAsyncFunction = exports.useAsync = exports.useContextFunction = exports.wrapUseFunction = exports.mappedUseFunction = exports.useValue = void 0;
+const tslib_1 = require("tslib");
 const getter_1 = require("../getter");
 function useValue(input, use, defaultValue) {
     let result;
@@ -45,4 +46,33 @@ function useContextFunction(use, defaultValue) {
     });
 }
 exports.useContextFunction = useContextFunction;
+function useAsync(input, use, defaultValue) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        let result;
+        if (input != null) {
+            result = (yield use(input));
+        }
+        else {
+            result = yield (0, getter_1.getValueFromGetter)(defaultValue);
+        }
+        return result;
+    });
+}
+exports.useAsync = useAsync;
+/**
+ * Creates a MappedUseFunction.
+ */
+function mappedUseAsyncFunction(map) {
+    return wrapUseAsyncFunction(useAsync, map);
+}
+exports.mappedUseAsyncFunction = mappedUseAsyncFunction;
+/**
+ * Wraps another MappedUseFunction or MappedUseAsyncFunction and maps the input values.
+ */
+function wrapUseAsyncFunction(mappedUsePromiseFn, map) {
+    return ((input, useFn, defaultValue) => {
+        return mappedUsePromiseFn(input, ((value) => tslib_1.__awaiter(this, void 0, void 0, function* () { return useValue(yield map(value), useFn, defaultValue); })), defaultValue);
+    });
+}
+exports.wrapUseAsyncFunction = wrapUseAsyncFunction;
 //# sourceMappingURL=use.js.map

package/src/lib/value/use.js.map

@@ -1 +1 @@
-{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/use.ts"],"names":[],"mappings":";;;AAAA,sCAA8D;AAU9D,SAAgB,QAAQ,CAAc,KAAe,EAAE,GAAmB,EAAE,YAAsC;IAChH,IAAI,MAAgB,CAAC;IAErB,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAa,CAAC;KACjC;SAAM;QACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;KAC3C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,4BAUC;AAKD;;GAEG;AACH,SAAgB,iBAAiB,CAAO,GAA6B;IACnE,OAAO,eAAe,CAAU,QAAe,EAAE,GAAU,CAAC,CAAC;AAC/D,CAAC;AAFD,8CAEC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAU,WAAoC,EAAE,GAA6B;IAC1G,OAAO,CAAC,CAAW,KAAe,EAAE,KAAqB,EAAE,YAAsC,EAAE,EAAE;QACnG,OAAO,WAAW,CAAI,KAAK,EAAE,CAAC,CAAC,KAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAmB,EAAE,YAAY,CAAC,CAAC;IAC1H,CAAC,CAA4B,CAAC;AAChC,CAAC;AAJD,0CAIC;AAOD;;GAEG;AACH,SAAgB,kBAAkB,CAAO,GAAmB,EAAE,YAA+B;IAC3F,OAAO,CAAC,CAAC,KAAe,EAAE,EAAE;QAC1B,IAAI,MAAgB,CAAC;QAErB,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;SACrB;aAAM;YACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;SAC3C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAA0B,CAAC;AAC9B,CAAC;AAZD,gDAYC"}
+{"version":3,"file":"use.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/use.ts"],"names":[],"mappings":";;;;AAAA,sCAAkF;AAWlF,SAAgB,QAAQ,CAAc,KAAe,EAAE,GAAmB,EAAE,YAAsC;IAChH,IAAI,MAAgB,CAAC;IAErB,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAa,CAAC;KACjC;SAAM;QACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;KAC3C;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,4BAUC;AAKD;;GAEG;AACH,SAAgB,iBAAiB,CAAO,GAA6B;IACnE,OAAO,eAAe,CAAU,QAAe,EAAE,GAAU,CAAC,CAAC;AAC/D,CAAC;AAFD,8CAEC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAU,WAAoC,EAAE,GAA6B;IAC1G,OAAO,CAAC,CAAW,KAAe,EAAE,KAAqB,EAAE,YAAsC,EAAE,EAAE;QACnG,OAAO,WAAW,CAAI,KAAK,EAAE,CAAC,CAAC,KAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAmB,EAAE,YAAY,CAAC,CAAC;IAC1H,CAAC,CAA4B,CAAC;AAChC,CAAC;AAJD,0CAIC;AAOD;;GAEG;AACH,SAAgB,kBAAkB,CAAO,GAAmB,EAAE,YAA+B;IAC3F,OAAO,CAAC,CAAC,KAAe,EAAE,EAAE;QAC1B,IAAI,MAAgB,CAAC;QAErB,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;SACrB;aAAM;YACL,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;SAC3C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAA0B,CAAC;AAC9B,CAAC;AAZD,gDAYC;AAQD,SAAsB,QAAQ,CAAc,KAAe,EAAE,GAAmB,EAAE,YAAsC;;QACtH,IAAI,MAAgB,CAAC;QAErB,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,MAAM,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAa,CAAC;SACzC;aAAM;YACL,MAAM,GAAG,MAAM,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;SACjD;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAVD,4BAUC;AAKD;;GAEG;AACH,SAAgB,sBAAsB,CAAO,GAA6C;IACxF,OAAO,oBAAoB,CAAU,QAAe,EAAE,GAAU,CAAC,CAAC;AACpE,CAAC;AAFD,wDAEC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAU,kBAAgD,EAAE,GAA6C;IAC3I,OAAO,CAAC,CAAW,KAAe,EAAE,KAAqB,EAAE,YAA2C,EAAE,EAAE;QACxG,OAAO,kBAAkB,CAAI,KAAK,EAAE,CAAC,CAAO,KAAQ,EAAE,EAAE,wDAAC,OAAA,QAAQ,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA,GAAA,CAAmB,EAAE,YAAY,CAAC,CAAC;IAC7I,CAAC,CAAiC,CAAC;AACrC,CAAC;AAJD,oDAIC"}

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [7.7.0](https://github.com/dereekb/dbx-components/compare/v7.6.0-dev...v7.7.0) (2022-06-09)
+
+
+
 # [7.6.0](https://github.com/dereekb/dbx-components/compare/v7.5.0-dev...v7.6.0) (2022-06-09)
 
 

package/test/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/util/test",
-  "version": "7.6.0",
+  "version": "7.7.0",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@dereekb/util": "7.6.0",
+    "@dereekb/util": "7.7.0",
     "make-error": "^1.3.0",
     "ts-essentials": "^9.1.2",
     "extra-set": "^2.2.11",