@dereekb/util 2.1.0 → 4.0.1

package/src/lib/assertion/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./assert.error"), exports);
-(0, tslib_1.__exportStar)(require("./assert"), exports);
-(0, tslib_1.__exportStar)(require("./assertion.generic"), exports);
-(0, tslib_1.__exportStar)(require("./assertion.number"), exports);
-(0, tslib_1.__exportStar)(require("./assertion"), exports);
+tslib_1.__exportStar(require("./assert.error"), exports);
+tslib_1.__exportStar(require("./assert"), exports);
+tslib_1.__exportStar(require("./assertion.generic"), exports);
+tslib_1.__exportStar(require("./assertion.number"), exports);
+tslib_1.__exportStar(require("./assertion"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/assertion/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/assertion/index.ts"],"names":[],"mappings":";;;AAAA,8DAA+B;AAC/B,wDAAyB;AACzB,mEAAoC;AACpC,kEAAmC;AACnC,2DAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/assertion/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,mDAAyB;AACzB,8DAAoC;AACpC,6DAAmC;AACnC,sDAA4B"}

package/src/lib/auth/auth.role.claims.d.ts

@@ -0,0 +1,98 @@
+import { AuthRole, AuthRoleSet } from "./auth.role";
+import { ArrayOrValue } from '../array/array';
+/**
+ * Key in the claims.
+ */
+export declare type AuthClaimKey = string;
+/**
+ * Value in claims.
+ */
+export declare type ClearAuthClaimValue = null;
+/**
+ * Value in claims.
+ */
+export declare type SimpleAuthClaimValue = string | number;
+/**
+ * Value in claims.
+ */
+export declare type AuthClaimValue = SimpleAuthClaimValue | object;
+/**
+ * An object that contains "claims" in the context of a JSON Web Token (JWT).
+ *
+ * It is keyed by the claims key.
+ */
+export declare type AuthClaims<T = any> = {
+    [K in keyof T]: AuthClaimValue;
+};
+/**
+ * A claims update.
+ */
+export declare type AuthClaimsUpdate<T = any> = {
+    [K in keyof Partial<T>]: AuthClaimValue | ClearAuthClaimValue;
+};
+/**
+ * Configuration for a claims key.
+ */
+export declare type AuthRoleClaimsFactoryConfigEntry = AuthRoleClaimsFactoryConfigEntrySimpleOptions | AuthRoleClaimsFactoryConfigEntryEncodeOptions;
+/**
+ *
+ */
+export interface AuthRoleClaimsFactoryConfigEntrySimpleOptions {
+    /**
+     * The roles to add when this claims is encountered.
+     */
+    roles: ArrayOrValue<AuthRole>;
+    /**
+     * (Optional) claim value. Overrides the default claim value.
+     */
+    value?: SimpleAuthClaimValue;
+}
+/**
+ * A more configurable configuration for a single claims value.
+ */
+export interface AuthRoleClaimsFactoryConfigEntryEncodeOptions {
+    /**
+     * (Optional) function of retrieving the value associated with this entry given the input claims.
+     *
+     * If not defined, will defer to role for finding matches and pull from value.
+     */
+    encodeValueFromRoles: (roles: AuthRoleSet) => AuthClaimValue | undefined;
+    /**
+     * (Optional) Auth roles associated with this claims. If not defined, the claims key is used.
+     */
+    decodeRolesFromValue: (value: AuthClaimValue) => AuthRole[] | undefined;
+}
+export declare type AuthRoleClaimsFactoryConfig = {
+    [key: string]: AuthRoleClaimsFactoryConfigEntry;
+};
+export interface AuthRoleClaimsFactoryDefaults {
+    /**
+     * Default value to use for claims that have no value present.
+     */
+    claimValue?: any;
+    /**
+     * Default value for claims that are not defined.
+     */
+    emptyValue?: any;
+}
+export declare type AuthRoleClaimsToRolesFunction<T extends AuthRoleClaimsFactoryConfig = any> = (roles: AuthRoleSet) => AuthClaims<T>;
+export declare type AuthRoleRolesToClaimsFunction<T extends AuthRoleClaimsFactoryConfig = any> = (claims: AuthClaims<T>) => AuthRoleSet;
+/**
+ * Service used for converting claims to/from a roles set.
+ */
+export interface AuthRoleClaimsService<T extends AuthRoleClaimsFactoryConfig = any> {
+    readonly toClaims: AuthRoleClaimsToRolesFunction<T>;
+    readonly toRoles: AuthRoleRolesToClaimsFunction<T>;
+    readonly defaultClaimValue: any;
+    readonly defaultEmptyValue: any;
+}
+export declare const AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE: null;
+export declare const AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE = 1;
+/**
+ * Creates a AuthRoleClaimsService using the input configuration.
+ *
+ * @param config
+ * @param defaults
+ * @returns
+ */
+export declare function authRoleClaimsService<T extends AuthRoleClaimsFactoryConfig>(config: T, defaults?: AuthRoleClaimsFactoryDefaults): AuthRoleClaimsService<T>;

package/src/lib/auth/auth.role.claims.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authRoleClaimsService = exports.AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE = exports.AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE = void 0;
+const object_1 = require("../object/object");
+const object_map_1 = require("../object/object.map");
+const array_1 = require("../array/array");
+const set_1 = require("../set");
+exports.AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE = null;
+exports.AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE = 1;
+/**
+ * Creates a AuthRoleClaimsService using the input configuration.
+ *
+ * @param config
+ * @param defaults
+ * @returns
+ */
+function authRoleClaimsService(config, defaults = {}) {
+    const defaultClaimValue = (0, object_1.objectHasKey)(defaults, 'claimValue') ? defaults === null || defaults === void 0 ? void 0 : defaults.claimValue : exports.AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE;
+    const defaultEmptyValue = (0, object_1.objectHasKey)(defaults, 'emptyValue') ? defaults === null || defaults === void 0 ? void 0 : defaults.emptyValue : exports.AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE;
+    function isSimpleOptions(entry) {
+        return entry.roles != null;
+    }
+    const tuples = (0, object_map_1.objectToTuples)(config).map((x) => {
+        var _a;
+        const inputEntry = x[1];
+        let entry;
+        if (isSimpleOptions(inputEntry)) {
+            const expectedValue = (_a = inputEntry.value) !== null && _a !== void 0 ? _a : defaultClaimValue;
+            const claimRoles = (0, array_1.asArray)(inputEntry.roles);
+            // since checking uses equivalence, the objects will never match equivalence via the === properly.
+            // AuthRoleClaimsFactoryConfigEntryEncodeOptions is likely to be used for these cases anyways, but this will help avoid unexpected errors.
+            if (typeof expectedValue === 'object') {
+                throw new Error(`failed decoding claims. Expected value to be a string or number. Object isn't supported with simple claims.`);
+            }
+            entry = {
+                encodeValueFromRoles: (roles) => {
+                    var _a;
+                    let claimsValue;
+                    // only set the claims value if all values are present in the claims.
+                    if ((0, set_1.setContainsAllValues)(roles, claimRoles)) {
+                        claimsValue = (_a = inputEntry.value) !== null && _a !== void 0 ? _a : defaultClaimValue;
+                    }
+                    return claimsValue;
+                },
+                decodeRolesFromValue: (value) => {
+                    if (value === expectedValue) {
+                        return claimRoles;
+                    }
+                    else {
+                        return [];
+                    }
+                }
+            };
+        }
+        else {
+            entry = inputEntry;
+        }
+        entry.claimKey = x[0];
+        return [x[0], entry];
+    });
+    const authRolesMap = new Map(tuples.map(x => [(x[0]).toLowerCase(), x[1]]));
+    const toClaims = (roles) => {
+        const claims = {};
+        // iterate by each claim value to build the claims.
+        tuples.forEach(([claimsKey, entry]) => {
+            var _a;
+            let claimsValue = (_a = entry.encodeValueFromRoles(roles)) !== null && _a !== void 0 ? _a : defaultEmptyValue;
+            claims[claimsKey] = claimsValue;
+        });
+        return claims;
+    };
+    const toRoles = (claims) => {
+        const roles = new Set();
+        (0, object_1.forEachKeyValue)(claims, {
+            forEach: ([claimsKey, value]) => {
+                const entry = authRolesMap.get(claimsKey);
+                if (entry != null) {
+                    const decodedRoles = entry.decodeRolesFromValue(value);
+                    (0, set_1.addToSet)(roles, decodedRoles);
+                }
+            }
+        });
+        return roles;
+    };
+    return {
+        toClaims,
+        toRoles,
+        defaultClaimValue,
+        defaultEmptyValue
+    };
+}
+exports.authRoleClaimsService = authRoleClaimsService;
+//# sourceMappingURL=auth.role.claims.js.map

package/src/lib/auth/auth.role.claims.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.role.claims.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/auth/auth.role.claims.ts"],"names":[],"mappings":";;;AACA,6CAAiE;AACjE,qDAAsD;AACtD,0CAAuD;AACvD,gCAAwD;AA8G3C,QAAA,oCAAoC,GAAG,IAAI,CAAC;AAC5C,QAAA,oCAAoC,GAAG,CAAC,CAAC;AAMtD;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAwC,MAAS,EAAE,WAA0C,EAAE;IAElI,MAAM,iBAAiB,GAAG,IAAA,qBAAY,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,CAAC,CAAC,CAAC,4CAAoC,CAAC;IAC7H,MAAM,iBAAiB,GAAG,IAAA,qBAAY,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,CAAC,CAAC,CAAC,4CAAoC,CAAC;IAE7H,SAAS,eAAe,CAAC,KAAuC;QAC9D,OAAQ,KAAuD,CAAC,KAAK,IAAI,IAAI,CAAC;IAChF,CAAC;IAED,MAAM,MAAM,GAA0D,IAAA,2BAAc,EAAmC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;;QACvI,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,KAAoD,CAAC;QAEzD,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE;YAC/B,MAAM,aAAa,GAAG,MAAA,UAAU,CAAC,KAAK,mCAAI,iBAAiB,CAAC;YAC5D,MAAM,UAAU,GAAG,IAAA,eAAO,EAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAE7C,kGAAkG;YAClG,0IAA0I;YAC1I,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;gBACrC,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAC;aAChI;YAED,KAAK,GAAG;gBACN,oBAAoB,EAAE,CAAC,KAAkB,EAAE,EAAE;;oBAC3C,IAAI,WAAW,CAAC;oBAEhB,qEAAqE;oBACrE,IAAI,IAAA,0BAAoB,EAAC,KAAK,EAAE,UAAU,CAAC,EAAE;wBAC3C,WAAW,GAAG,MAAA,UAAU,CAAC,KAAK,mCAAI,iBAAiB,CAAC;qBACrD;oBAED,OAAO,WAAW,CAAC;gBACrB,CAAC;gBACD,oBAAoB,EAAE,CAAC,KAAqB,EAAE,EAAE;oBAC9C,IAAI,KAAK,KAAK,aAAa,EAAE;wBAC3B,OAAO,UAAU,CAAC;qBACnB;yBAAM;wBACL,OAAO,EAAE,CAAC;qBACX;gBACH,CAAC;aACF,CAAC;SACH;aAAM;YACL,KAAK,GAAG,UAAU,CAAC;SACpB;QAEA,KAA6C,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAA4C,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAoD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/H,MAAM,QAAQ,GAAG,CAAC,KAAkB,EAAE,EAAE;QACtC,MAAM,MAAM,GAAe,EAAE,CAAC;QAE9B,mDAAmD;QACnD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;;YACpC,IAAI,WAAW,GAAG,MAAA,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,mCAAI,iBAAiB,CAAC;YACzE,MAAM,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,MAAkB,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAEhC,IAAA,wBAAe,EAAC,MAAM,EAAE;YACtB,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,KAAK,CAAgB,EAAE,EAAE;gBAC7C,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBAE1C,IAAI,KAAK,IAAI,IAAI,EAAE;oBACjB,MAAM,YAAY,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBACvD,IAAA,cAAQ,EAAC,KAAK,EAAE,YAAY,CAAC,CAAC;iBAC/B;YACH,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ;QACR,OAAO;QACP,iBAAiB;QACjB,iBAAiB;KAClB,CAAA;AACH,CAAC;AAvFD,sDAuFC"}

package/src/lib/auth/auth.role.d.ts

@@ -0,0 +1,22 @@
+import { Maybe } from "../value/maybe";
+/**
+ * An application role.
+ *
+ * Is used in the client to decide which content a user can view.
+ *
+ * Roles should always be lowercase.
+ */
+export declare type AuthRole = string;
+/**
+ * A set of auth roles for a user.
+ */
+export declare type AuthRoleSet = Set<AuthRole>;
+/**
+ * Auth role for a full admin. Is allowed into all sections of the app.
+ */
+export declare const AUTH_ADMIN_ROLE = "admin";
+/**
+ * Auth role for a general user. Is allowed into the app and is logged in.
+ */
+export declare const AUTH_USER_ROLE = "user";
+export declare function authRolesSetHasRoles(authRolesSet: AuthRoleSet, roles: Maybe<Iterable<AuthRole>>): boolean;

package/src/lib/auth/auth.role.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authRolesSetHasRoles = exports.AUTH_USER_ROLE = exports.AUTH_ADMIN_ROLE = void 0;
+const set_1 = require("../set/set");
+/**
+ * Auth role for a full admin. Is allowed into all sections of the app.
+ */
+exports.AUTH_ADMIN_ROLE = 'admin';
+/**
+ * Auth role for a general user. Is allowed into the app and is logged in.
+ */
+exports.AUTH_USER_ROLE = 'user';
+function authRolesSetHasRoles(authRolesSet, roles) {
+    return (0, set_1.setContainsAllValues)(authRolesSet, roles !== null && roles !== void 0 ? roles : []);
+}
+exports.authRolesSetHasRoles = authRolesSetHasRoles;
+//# sourceMappingURL=auth.role.js.map

package/src/lib/auth/auth.role.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.role.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/auth/auth.role.ts"],"names":[],"mappings":";;;AAAA,oCAAkD;AAiBlD;;GAEG;AACU,QAAA,eAAe,GAAG,OAAO,CAAC;AAEvC;;GAEG;AACU,QAAA,cAAc,GAAG,MAAM,CAAC;AAErC,SAAgB,oBAAoB,CAAC,YAAyB,EAAE,KAAgC;IAC9F,OAAO,IAAA,0BAAoB,EAAC,YAAY,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAA;AACxD,CAAC;AAFD,oDAEC"}

package/src/lib/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './auth.role';
+export * from './auth.role.claims';

package/src/lib/auth/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./auth.role"), exports);
+tslib_1.__exportStar(require("./auth.role.claims"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/auth/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC"}

package/src/lib/contact/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./domain"), exports);
-(0, tslib_1.__exportStar)(require("./email"), exports);
-(0, tslib_1.__exportStar)(require("./phone"), exports);
+tslib_1.__exportStar(require("./domain"), exports);
+tslib_1.__exportStar(require("./email"), exports);
+tslib_1.__exportStar(require("./phone"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/contact/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/contact/index.ts"],"names":[],"mappings":";;;AAAA,wDAAyB;AACzB,uDAAwB;AACxB,uDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/contact/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,kDAAwB;AACxB,kDAAwB"}

package/src/lib/date/date.d.ts

@@ -1,4 +1,4 @@
-import { Maybe } from "../value";
+import { Maybe } from "../value/maybe";
 /**
  * A valid ISO8601 formatted date string.
  */

package/src/lib/date/date.time.d.ts

@@ -1,4 +1,4 @@
-import { Maybe } from "../value";
+import { Maybe } from "../value/maybe";
 /**
  * Represents a string for a time. This may be human-input, and
  * can be interpreted in various ways depending on the input.

package/src/lib/date/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./date"), exports);
-(0, tslib_1.__exportStar)(require("./date.time"), exports);
+tslib_1.__exportStar(require("./date"), exports);
+tslib_1.__exportStar(require("./date.time"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/date/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/date/index.ts"],"names":[],"mappings":";;;AAAA,sDAAuB;AACvB,2DAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/date/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,sDAA4B"}

package/src/lib/error/error.d.ts

@@ -1,3 +1,4 @@
+import { Maybe } from '../value/maybe';
 /**
  * A unique identifier for a specific error.
  */
@@ -12,8 +13,12 @@ export interface CodedError {
  * An error with a human-readable message.
  */
 export interface ReadableError extends Partial<CodedError> {
-    message: string;
+    message?: Maybe<string>;
 }
+export declare function readableError(code: StringErrorCode, message?: string): {
+    code: string;
+    message: string | undefined;
+};
 export interface ReadableDataError<T = any> extends ReadableError {
     data?: T;
 }

package/src/lib/error/error.js

@@ -1,7 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertToReadableError = void 0;
+exports.convertToReadableError = exports.readableError = void 0;
 const make_error_1 = require("make-error");
+function readableError(code, message) {
+    return {
+        code,
+        message
+    };
+}
+exports.readableError = readableError;
 /**
  * Converts the input error content to a ReadableError or CodedError.
  *

package/src/lib/error/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/error.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAgCvC;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,UAAkC;IACvE,IAAI,KAA6C,CAAC;IAElD,IAAI,UAAU,EAAE;QACd,IAAK,UAAyB,CAAC,IAAI,EAAE;YACnC,KAAK,GAAG,UAA2B,CAAC;SACrC;aAAM,IAAK,UAA2B,CAAC,IAAI,EAAE;YAC5C,KAAK,GAAI,UAA2B,CAAC,IAAqB,CAAC;SAC5D;aAAM,IAAI,UAAU,YAAY,sBAAS,EAAE;YAC1C,KAAK,GAAG;gBACN,IAAI,EAAG,UAAkB,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI;gBACjD,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B,CAAC;SACH;aAAM;YACL,KAAK,GAAG;gBACN,IAAI,EAAE,OAAO;gBACb,OAAO,EAAG,UAAkB,CAAC,OAAO,IAAI,EAAE;aAC3C,CAAC;SACH;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAtBD,wDAsBC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/error.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAsBvC,SAAgB,aAAa,CAAC,IAAqB,EAAE,OAAgB;IACnE,OAAO;QACL,IAAI;QACJ,OAAO;KACR,CAAC;AACJ,CAAC;AALD,sCAKC;AAYD;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,UAAkC;IACvE,IAAI,KAA6C,CAAC;IAElD,IAAI,UAAU,EAAE;QACd,IAAK,UAAyB,CAAC,IAAI,EAAE;YACnC,KAAK,GAAG,UAA2B,CAAC;SACrC;aAAM,IAAK,UAA2B,CAAC,IAAI,EAAE;YAC5C,KAAK,GAAI,UAA2B,CAAC,IAAqB,CAAC;SAC5D;aAAM,IAAI,UAAU,YAAY,sBAAS,EAAE;YAC1C,KAAK,GAAG;gBACN,IAAI,EAAG,UAAkB,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI;gBACjD,OAAO,EAAE,UAAU,CAAC,OAAO;aAC5B,CAAC;SACH;aAAM;YACL,KAAK,GAAG;gBACN,IAAI,EAAE,OAAO;gBACb,OAAO,EAAG,UAAkB,CAAC,OAAO,IAAI,EAAE;aAC3C,CAAC;SACH;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAtBD,wDAsBC"}

package/src/lib/error/error.server.d.ts

@@ -1,16 +1,9 @@
-import { StringErrorCode, ReadableDataError } from './error';
+import { Maybe } from '../value/maybe';
+import { ReadableError, ReadableDataError, StringErrorCode } from './error';
 /**
  * The expected error object returned from the server.
  */
-export interface ServerErrorResponseData {
-    /**
-     * Unique identifier of the error returned, if available.
-     */
-    code?: StringErrorCode;
-    /**
-     * User-readable message of the error returned.
-     */
-    message?: string;
+export interface ServerErrorResponseData extends ReadableError {
     /**
      * Additional keys/data returned in the error data.
      */
@@ -26,9 +19,9 @@ export interface ServerError<T = any> extends ReadableDataError<T> {
  * Base server-error class.
  */
 export declare class ServerErrorResponse<T extends ServerErrorResponseData = ServerErrorResponseData> implements ServerError<T> {
-    readonly code?: string;
+    readonly code?: StringErrorCode;
     readonly status: number;
-    readonly message: string;
+    readonly message: Maybe<string>;
     readonly data?: T;
     constructor({ code, status, data, message }: ServerError<T>);
 }

package/src/lib/error/error.server.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.server.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/error.server.ts"],"names":[],"mappings":";;;AA2BA;;GAEG;AACH,MAAa,mBAAmB;IAO9B,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAkB;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAEF;AAdD,kDAcC;AAED,MAAa,+BAAgC,SAAQ,mBAAmB;IAEtE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAwB;QACvD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;CAEF;AAND,0EAMC"}
+{"version":3,"file":"error.server.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/error.server.ts"],"names":[],"mappings":";;;AAoBA;;GAEG;AACH,MAAa,mBAAmB;IAO9B,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAkB;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CAEF;AAdD,kDAcC;AAED,MAAa,+BAAgC,SAAQ,mBAAmB;IAEtE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAwB;QACvD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;CAEF;AAND,0EAMC"}

package/src/lib/error/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./error.server"), exports);
-(0, tslib_1.__exportStar)(require("./error"), exports);
+tslib_1.__exportStar(require("./error.server"), exports);
+tslib_1.__exportStar(require("./error"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/error/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/index.ts"],"names":[],"mappings":";;;AAAA,8DAA+B;AAC/B,uDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/error/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,kDAAwB"}

package/src/lib/filter/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./filter"), exports);
+tslib_1.__exportStar(require("./filter"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/filter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/filter/index.ts"],"names":[],"mappings":";;;AAAA,wDAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/filter/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB"}

package/src/lib/function/function.forward.d.ts

@@ -0,0 +1,9 @@
+import { Getter } from "../getter/getter";
+export declare type ForwardFunction<I extends (...args: any[]) => O, O = any> = I;
+/**
+ * Wraps a Getter that returns a function. When the function is invoked, the getter retrieves the function then calls it with the input arguments.
+ *
+ * @param getter
+ * @returns
+ */
+export declare function forwardFunction<I extends (...args: any[]) => O, O = any>(getter: Getter<I>): ForwardFunction<I>;

package/src/lib/function/function.forward.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forwardFunction = void 0;
+/**
+ * Wraps a Getter that returns a function. When the function is invoked, the getter retrieves the function then calls it with the input arguments.
+ *
+ * @param getter
+ * @returns
+ */
+function forwardFunction(getter) {
+    const fn = ((...args) => {
+        const forwardFn = getter();
+        return forwardFn(...args);
+    });
+    return fn;
+}
+exports.forwardFunction = forwardFunction;
+//# sourceMappingURL=function.forward.js.map

package/src/lib/function/function.forward.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.forward.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/function/function.forward.ts"],"names":[],"mappings":";;;AAKA;;;;;GAKG;AACH,SAAgB,eAAe,CAA2C,MAAiB;IACzF,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;QAC7B,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5B,CAAC,CAA0B,CAAC;IAE5B,OAAO,EAAE,CAAC;AACZ,CAAC;AAPD,0CAOC"}

package/src/lib/function/index.d.ts

@@ -0,0 +1 @@
+export * from './function.forward';

package/src/lib/function/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./function.forward"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/function/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/function/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC"}

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

@@ -0,0 +1,38 @@
+import { FactoryWithInput, Getter } from "./getter";
+/**
+ * Getter that returns a cached value.
+ */
+export declare type CachedGetter<T> = Getter<T> & {
+    /**
+     * Sets the value in the cache.
+     *
+     * @param value
+     */
+    set(value: T): void;
+    /**
+     * Resets/clears the cache.
+     */
+    reset(): void;
+    /**
+     * Re-initializes the getter and reloads the value from the source.
+     */
+    init(): void;
+};
+export declare type CachedFactoryWithInput<T, A = any> = CachedGetter<T> & FactoryWithInput<T, A> & {
+    /**
+     * Re-initializes the cache using the factory function.
+     *
+     * @param input
+     */
+    init(input?: A): void;
+};
+/**
+ * Creates a CachedGetter from the input Getter.
+ *
+ * The value will be retrieved once, then cached permenantly by this function.
+ *
+ * @param getter
+ * @returns
+ */
+export declare function cachedGetter<T>(getter: Getter<T>): CachedFactoryWithInput<T>;
+export declare function cachedGetter<T, A = any>(factory: FactoryWithInput<T, A>): CachedFactoryWithInput<T, A>;

package/src/lib/getter/getter.cache.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cachedGetter = void 0;
+function cachedGetter(factory) {
+    let loaded;
+    const init = (input) => {
+        loaded = {
+            value: factory(input)
+        };
+    };
+    const result = ((input) => {
+        if (!loaded) {
+            init(input);
+        }
+        return loaded.value;
+    });
+    result.set = (value) => loaded = { value };
+    result.reset = () => loaded = undefined;
+    result.init = init;
+    return result;
+}
+exports.cachedGetter = cachedGetter;
+//# sourceMappingURL=getter.cache.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getter.cache.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/getter/getter.cache.ts"],"names":[],"mappings":";;;AA8CA,SAAgB,YAAY,CAAa,OAA+B;IACtE,IAAI,MAA2B,CAAC;IAEhC,MAAM,IAAI,GAAG,CAAC,KAAS,EAAE,EAAE;QACzB,MAAM,GAAG;YACP,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC;SACtB,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,CAAC,KAAS,EAAE,EAAE;QAC5B,IAAI,CAAC,MAAM,EAAE;YACX,IAAI,CAAC,KAAK,CAAC,CAAC;SACb;QAED,OAAO,MAAO,CAAC,KAAK,CAAC;IACvB,CAAC,CAAiC,CAAC;IAEnC,MAAM,CAAC,GAAG,GAAG,CAAC,KAAQ,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC;IAC9C,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,MAAM,GAAG,SAAS,CAAC;IACxC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnB,OAAO,MAAM,CAAC;AAChB,CAAC;AAtBD,oCAsBC"}

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

@@ -0,0 +1,61 @@
+/**
+ * Function that returns a value.
+ */
+export declare type Getter<T> = () => T;
+/**
+ * Getter with the design of returning a new value each time.
+ */
+export declare type Factory<T> = Getter<T>;
+/**
+ * Function that returns a value with an optional single argument.
+ */
+export declare type FactoryWithInput<T, A> = (args?: A) => T;
+/**
+ * Function that returns a value with a single argument.
+ */
+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>;
+/**
+ * Either a GetterWithInput, or a Getter.
+ */
+export declare type GetterOrFactoryWithInput<T, A> = Getter<T> | FactoryWithInput<T, A>;
+/**
+ * Either a GetterOrValue, or a FactoryWithInput.
+ */
+export declare type GetterOrValueWithInput<T extends string | number | object | symbol, A> = GetterOrValue<T> | FactoryWithInput<T, A>;
+export declare type StringOrGetter = GetterOrValue<string>;
+/**
+ * Returns true if the input object looks like a Getter (is a function).
+ *
+ * @param value
+ * @returns
+ */
+export declare function isGetter<T = any>(value: any): value is Getter<T>;
+/**
+ * If the input is a function, it is executed. Otherwise, the value is returned.
+ *
+ * @param input
+ * @returns
+ */
+export declare function getValueFromGetter<T>(input: GetterOrValue<T>): T;
+export declare function getValueFromGetter<T>(this: any, input: GetterOrValue<T>): T;
+export declare function getValueFromGetter<T>(this: any, input: GetterOrValue<T>, inputArgs?: any): T;
+export declare function getValueFromGetter<T, A>(this: any, input: GetterOrFactoryWithInput<T, A>, args?: A): T;
+export declare function getValueFromGetter<T extends string | number | object | symbol, A>(this: any, input: GetterOrValueWithInput<T, A>, args?: A): T;
+/**
+ * Returns the input as a getter.
+ *
+ * @param input
+ * @returns
+ */
+export declare function asGetter<T>(input: GetterOrValue<T>): Getter<T>;
+/**
+ * Wraps the input and returns a Getter for that value.
+ *
+ * @param input
+ * @returns
+ */
+export declare function makeGetter<T>(input: T): Getter<T>;