@fgv/ts-extras 2.0.1

package/lib/packlets/experimental/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/packlets/experimental/formatter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;AAEH,4CAA2E;AAC3E,wDAAgC;AAEhC,kBAAQ,CAAC,MAAM,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAuBnC;;;GAGG;AACH,MAAa,eAAe;IAC1B;;;;;;OAMG;IACO,MAAM,CAAC,aAAa,CAAC,OAAiB,EAAE,KAAa,EAAE,KAAyB;QACxF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,KAAK,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YAC7C,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAgB;QAC5B,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,kBAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AArBD,0CAqBC;AAsBD;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAI,MAAc,EAAE,KAAU,EAAE,aAA2B;IACnF,OAAO,IAAA,qBAAU,EACf,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACjB,OAAO,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC,CACH,CAAC,SAAS,CAAC,CAAC,OAAiB,EAAE,EAAE;QAChC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACjD,OAAO,IAAA,kBAAO,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AATD,gCASC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, captureResult, mapResults, succeed } from '@fgv/ts-utils';\nimport Mustache from 'mustache';\n\nMustache.escape = (s: string) => s;\n\n/**\n * Destination format for some formatted string.\n * @beta\n */\nexport type FormatTargets = 'text' | 'markdown' | 'embed';\n\n/**\n * Interface for an object that can be formatted.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface Formattable {\n  /**\n   * Formats an object using the supplied mustache template.\n   * @param format - A mustache template used to format the object.\n   * @returns {@link Success} with the resulting string, or {@link Failure}\n   * with an error message if an error occurs.\n   */\n  format(format: string): Result<string>;\n}\n\n/**\n * Base class which adds common formatting.\n * @beta\n */\nexport class FormattableBase {\n  /**\n   * Helper enables derived classes to add named details to a formatted presentation.\n   * @param details - An array of detail description strings.\n   * @param label - Label to use for the new detail.\n   * @param value - Value to use for the new detail.\n   * @internal\n   */\n  protected static _tryAddDetail(details: string[], label: string, value: string | undefined): void {\n    if (value !== undefined) {\n      const padded = `  ${label}:`.padEnd(20, ' ');\n      details.push(`${padded} ${value}`);\n    }\n  }\n\n  /**\n   * {@inheritdoc Experimental.Formattable.format}\n   */\n  public format(template: string): Result<string> {\n    return captureResult(() => Mustache.render(template, this));\n  }\n}\n\n/**\n * Type definition for a formatting function, which takes a `string` and an\n * item and returns {@link Result | Result<string>}.\n * @beta\n */\nexport type Formatter<T> = (format: string, item: T) => Result<string>;\n\n/**\n * A collection of {@link Experimental.Formatter | formatters} indexed by target name, to enable\n * different format methods per output target.\n * @beta\n */\nexport type FormattersByExtendedTarget<TFT extends FormatTargets, T> = Record<TFT, Formatter<T>>;\n/**\n * A collection of {@link Experimental.Formatter | formatters} indexed by the\n * {@link Experimental.FormatTargets | default supported target formats}.\n * @beta\n */\nexport type FormattersByTarget<T> = FormattersByExtendedTarget<FormatTargets, T>;\n\n/**\n * Formats a list of items using the supplied template and formatter, one result\n * per output line.\n * @param format - A mustache template used to format each item.\n * @param items - The items to be formatted.\n * @param itemFormatter - The {@link Experimental.Formatter | Formatter<T>} used to format each item.\n * @returns The resulting string.\n * @beta\n */\nexport function formatList<T>(format: string, items: T[], itemFormatter: Formatter<T>): Result<string> {\n  return mapResults(\n    items.map((item) => {\n      return itemFormatter(format, item);\n    })\n  ).onSuccess((results: string[]) => {\n    const filtered = results.filter((s) => s !== '');\n    return succeed(filtered.join('\\n'));\n  });\n}\n"]}

package/lib/packlets/experimental/index.d.ts

@@ -0,0 +1,4 @@
+export * from './extendedArray';
+export * from './formatter';
+export * from './rangeOf';
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/experimental/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/experimental/index.ts"],"names":[],"mappings":"AAsBA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/lib/packlets/experimental/index.js

@@ -0,0 +1,41 @@
+"use strict";
+/*
+ * Copyright (c) 2023 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./extendedArray"), exports);
+__exportStar(require("./formatter"), exports);
+__exportStar(require("./rangeOf"), exports);
+//# sourceMappingURL=index.js.map

package/lib/packlets/experimental/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/experimental/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,kDAAgC;AAChC,8CAA4B;AAC5B,4CAA0B","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './extendedArray';\nexport * from './formatter';\nexport * from './rangeOf';\n"]}

package/lib/packlets/experimental/rangeOf.d.ts

@@ -0,0 +1,122 @@
+import { Result } from '@fgv/ts-utils';
+/**
+ * Represents a generic range of some comparable type `<T>`.
+ * @public
+ */
+export interface RangeOfProperties<T> {
+    readonly min?: T;
+    readonly max?: T;
+}
+/**
+ * Format strings (in mustache format) to
+ * use for both open-ended and complete
+ * {@link Experimental.RangeOf | RangeOf<T>}.
+ * @public
+ */
+export interface RangeOfFormats {
+    minOnly: string;
+    maxOnly: string;
+    minMax: string;
+}
+/**
+ * Default {@link Experimental.RangeOfFormats | formats} to use for both
+ * open-ended and complete {@link Experimental.RangeOf | RangeOf<T>}.
+ * @public
+ */
+export declare const DEFAULT_RANGEOF_FORMATS: RangeOfFormats;
+/**
+ * Simple implementation of a possibly open-ended range of some comparable
+ * type `<T>` with test and formatting.
+ * @public
+ */
+export declare class RangeOf<T> implements RangeOfProperties<T> {
+    /**
+     * Minimum extent of the range.
+     */
+    readonly min?: T;
+    /**
+     * Maximum extent of the range.
+     */
+    readonly max?: T;
+    /**
+     * Creates a new {@link Experimental.RangeOf | RangeOf<T>}.
+     * @param min - Optional minimum extent of the range.
+     * @param max - Optional maximum extent of the range.
+     */
+    constructor(min?: T, max?: T);
+    /**
+     * Static constructor for a {@link Experimental.RangeOf | RangeOf<T>}.
+     * @param init - {@link Experimental.RangeOfProperties | Range initializer}.
+     * @returns A new {@link Experimental.RangeOf | RangeOf<T>}.
+     */
+    static createRange<T>(init?: RangeOfProperties<T>): Result<RangeOf<T>>;
+    /**
+     * Gets a formatted description of a {@link Experimental.RangeOfProperties | RangeOfProperties<T>} given an
+     * optional set of formats and 'empty' value to use.
+     * @param range - The {@link Experimental.RangeOfProperties | RangeOfProperties<T>} to be formatted.
+     * @param formats - Optional {@link Experimental.RangeOfFormats | formats} to use. Default is
+     * {@link Experimental.DEFAULT_RANGEOF_FORMATS | DEFAULT_RANGEOF_FORMATS}.
+     * @param emptyValue - Value which represents unbounded minimum or maximum for this range. Default is `undefined`.
+     * @returns A string representation of the range.
+     */
+    static propertiesToString<T>(range: RangeOfProperties<T>, formats?: RangeOfFormats, emptyValue?: T): string | undefined;
+    /**
+     * Default comparison uses javascript built-in comparison.
+     * @param t1 - First value to be compared.
+     * @param t2 - Second value to be compared.
+     * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger
+     * and `'equal'` if `t1` and `t2` are equal.
+     * @internal
+     */
+    protected static _defaultCompare<T>(t1: T, t2: T): 'less' | 'equal' | 'greater';
+    /**
+     * Checks if a supplied value is within this range.
+     * @param t - The value to be tested.
+     * @returns `'included'` if `t` falls within the range, `'less'` if `t` falls
+     * below the minimum extent of the range and `'greater'` if `t` is above the
+     * maximum extent.
+     */
+    check(t: T): 'less' | 'included' | 'greater';
+    /**
+     * Determines if a supplied value is within this range.
+     * @param t - The value to be tested.
+     * @returns Returns `true` if `t` falls within the range, `false` otherwise.
+     */
+    includes(t: T): boolean;
+    /**
+     * Finds the transition value that would bring a supplied value `t` into
+     * range.
+     * @param t - The value to be tested.
+     * @returns The minimum extent of the range if `t` is below the range or
+     * the maximum extent of the range if `t` is above the range.  Returns
+     * `undefined` if `t` already falls within the range.
+     */
+    findTransition(t: T): T | undefined;
+    /**
+     * Formats the minimum and maximum values of this range.
+     * @param format - A format function used to format the values.
+     * @returns A {@link Experimental.RangeOfProperties | RangeOfProperties<string>} containing the
+     * formatted representation of the {@link Experimental.RangeOf.min | minimum} and
+     * {@link Experimental.RangeOf.max | maximum}
+     * extent of the range, or `undefined` for an extent that is not present.
+     */
+    toFormattedProperties(format: (value: T) => string | undefined): RangeOfProperties<string>;
+    /**
+     * Formats this range using the supplied format function.
+     * @param format - Format function used to format minimum and maximum extent values.
+     * @param formats - The {@link Experimental.RangeOfFormats | format strings} used to format the range
+     * (default {@link Experimental.DEFAULT_RANGEOF_FORMATS}).
+     * @returns Returns a formatted representation of this range.
+     */
+    format(format: (value: T) => string | undefined, formats?: RangeOfFormats): string | undefined;
+    /**
+     * Inner compare method can be overridden by a derived class.
+     * @param t1 - First value to compare.
+     * @param t2 - Second value to compare.
+     * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger
+     * and `'equal'` if `t1` and `t2` are equal.
+     * @internal
+     */
+    protected _compare(t1: T, t2: T): 'less' | 'equal' | 'greater';
+}
+//# sourceMappingURL=rangeOf.d.ts.map

package/lib/packlets/experimental/rangeOf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rangeOf.d.ts","sourceRoot":"","sources":["../../../src/packlets/experimental/rangeOf.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,eAAe,CAAC;AAGtD;;;GAGG;AAEH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjB,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CAClB;AAED;;;;;GAKG;AAEH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,cAIrC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IACrD;;OAEG;IACH,SAAgB,GAAG,CAAC,EAAE,CAAC,CAAC;IACxB;;OAEG;IACH,SAAgB,GAAG,CAAC,EAAE,CAAC,CAAC;IAExB;;;;OAIG;gBACgB,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IAQnC;;;;OAIG;WACW,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAI7E;;;;;;;;OAQG;WACW,kBAAkB,CAAC,CAAC,EAChC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,cAAc,EACxB,UAAU,CAAC,EAAE,CAAC,GACb,MAAM,GAAG,SAAS;IAcrB;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS;IAS/E;;;;;;OAMG;IACI,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS;IAUnD;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO;IAI9B;;;;;;;OAOG;IACI,cAAc,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAU1C;;;;;;;OAOG;IACI,qBAAqB,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAOjG;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS;IAIrG;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS;CAG/D"}

package/lib/packlets/experimental/rangeOf.js

@@ -0,0 +1,185 @@
+"use strict";
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RangeOf = exports.DEFAULT_RANGEOF_FORMATS = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const mustache_1 = __importDefault(require("mustache"));
+/**
+ * Default {@link Experimental.RangeOfFormats | formats} to use for both
+ * open-ended and complete {@link Experimental.RangeOf | RangeOf<T>}.
+ * @public
+ */
+exports.DEFAULT_RANGEOF_FORMATS = {
+    minOnly: '{{min}}-',
+    maxOnly: '-{{max}}',
+    minMax: '{{min}}-{{max}}'
+};
+/**
+ * Simple implementation of a possibly open-ended range of some comparable
+ * type `<T>` with test and formatting.
+ * @public
+ */
+class RangeOf {
+    /**
+     * Creates a new {@link Experimental.RangeOf | RangeOf<T>}.
+     * @param min - Optional minimum extent of the range.
+     * @param max - Optional maximum extent of the range.
+     */
+    constructor(min, max) {
+        if (min !== undefined && max !== undefined && this._compare(min, max) === 'greater') {
+            throw new Error(`Inverted range - ${JSON.stringify(min)} must be <= ${JSON.stringify(max)}.`);
+        }
+        this.min = min;
+        this.max = max;
+    }
+    /**
+     * Static constructor for a {@link Experimental.RangeOf | RangeOf<T>}.
+     * @param init - {@link Experimental.RangeOfProperties | Range initializer}.
+     * @returns A new {@link Experimental.RangeOf | RangeOf<T>}.
+     */
+    static createRange(init) {
+        return (0, ts_utils_1.captureResult)(() => new RangeOf(init === null || init === void 0 ? void 0 : init.min, init === null || init === void 0 ? void 0 : init.max));
+    }
+    /**
+     * Gets a formatted description of a {@link Experimental.RangeOfProperties | RangeOfProperties<T>} given an
+     * optional set of formats and 'empty' value to use.
+     * @param range - The {@link Experimental.RangeOfProperties | RangeOfProperties<T>} to be formatted.
+     * @param formats - Optional {@link Experimental.RangeOfFormats | formats} to use. Default is
+     * {@link Experimental.DEFAULT_RANGEOF_FORMATS | DEFAULT_RANGEOF_FORMATS}.
+     * @param emptyValue - Value which represents unbounded minimum or maximum for this range. Default is `undefined`.
+     * @returns A string representation of the range.
+     */
+    static propertiesToString(range, formats, emptyValue) {
+        formats = formats !== null && formats !== void 0 ? formats : exports.DEFAULT_RANGEOF_FORMATS;
+        if (range.min !== undefined && range.min !== emptyValue) {
+            if (range.max !== undefined && range.max !== emptyValue) {
+                return mustache_1.default.render(formats.minMax, range);
+            }
+            else {
+                return mustache_1.default.render(formats.minOnly, range);
+            }
+        }
+        else if (range.max !== undefined && range.max !== emptyValue) {
+            return mustache_1.default.render(formats.maxOnly, range);
+        }
+        return undefined;
+    }
+    /**
+     * Default comparison uses javascript built-in comparison.
+     * @param t1 - First value to be compared.
+     * @param t2 - Second value to be compared.
+     * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger
+     * and `'equal'` if `t1` and `t2` are equal.
+     * @internal
+     */
+    static _defaultCompare(t1, t2) {
+        if (t1 < t2) {
+            return 'less';
+        }
+        else if (t1 > t2) {
+            return 'greater';
+        }
+        return 'equal';
+    }
+    /**
+     * Checks if a supplied value is within this range.
+     * @param t - The value to be tested.
+     * @returns `'included'` if `t` falls within the range, `'less'` if `t` falls
+     * below the minimum extent of the range and `'greater'` if `t` is above the
+     * maximum extent.
+     */
+    check(t) {
+        if (this.min !== undefined && this._compare(t, this.min) === 'less') {
+            return 'less';
+        }
+        if (this.max !== undefined && this._compare(t, this.max) !== 'less') {
+            return 'greater';
+        }
+        return 'included';
+    }
+    /**
+     * Determines if a supplied value is within this range.
+     * @param t - The value to be tested.
+     * @returns Returns `true` if `t` falls within the range, `false` otherwise.
+     */
+    includes(t) {
+        return this.check(t) === 'included';
+    }
+    /**
+     * Finds the transition value that would bring a supplied value `t` into
+     * range.
+     * @param t - The value to be tested.
+     * @returns The minimum extent of the range if `t` is below the range or
+     * the maximum extent of the range if `t` is above the range.  Returns
+     * `undefined` if `t` already falls within the range.
+     */
+    findTransition(t) {
+        switch (this.check(t)) {
+            case 'less':
+                return this.min;
+            case 'included':
+                return this.max;
+        }
+        return undefined;
+    }
+    /**
+     * Formats the minimum and maximum values of this range.
+     * @param format - A format function used to format the values.
+     * @returns A {@link Experimental.RangeOfProperties | RangeOfProperties<string>} containing the
+     * formatted representation of the {@link Experimental.RangeOf.min | minimum} and
+     * {@link Experimental.RangeOf.max | maximum}
+     * extent of the range, or `undefined` for an extent that is not present.
+     */
+    toFormattedProperties(format) {
+        return {
+            min: this.min !== undefined ? format(this.min) : undefined,
+            max: this.max !== undefined ? format(this.max) : undefined
+        };
+    }
+    /**
+     * Formats this range using the supplied format function.
+     * @param format - Format function used to format minimum and maximum extent values.
+     * @param formats - The {@link Experimental.RangeOfFormats | format strings} used to format the range
+     * (default {@link Experimental.DEFAULT_RANGEOF_FORMATS}).
+     * @returns Returns a formatted representation of this range.
+     */
+    format(format, formats) {
+        return RangeOf.propertiesToString(this.toFormattedProperties(format), formats);
+    }
+    /**
+     * Inner compare method can be overridden by a derived class.
+     * @param t1 - First value to compare.
+     * @param t2 - Second value to compare.
+     * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger
+     * and `'equal'` if `t1` and `t2` are equal.
+     * @internal
+     */
+    _compare(t1, t2) {
+        return RangeOf._defaultCompare(t1, t2);
+    }
+}
+exports.RangeOf = RangeOf;
+//# sourceMappingURL=rangeOf.js.map

package/lib/packlets/experimental/rangeOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rangeOf.js","sourceRoot":"","sources":["../../../src/packlets/experimental/rangeOf.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;AAEH,4CAAsD;AACtD,wDAAgC;AAyBhC;;;;GAIG;AACU,QAAA,uBAAuB,GAAmB;IACrD,OAAO,EAAE,UAAU;IACnB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,iBAAiB;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAa,OAAO;IAUlB;;;;OAIG;IACH,YAAmB,GAAO,EAAE,GAAO;QACjC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YACpF,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAI,IAA2B;QACtD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,OAAO,CAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,kBAAkB,CAC9B,KAA2B,EAC3B,OAAwB,EACxB,UAAc;QAEd,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,+BAAuB,CAAC;QAC7C,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACxD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;gBACxD,OAAO,kBAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,OAAO,kBAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC/D,OAAO,kBAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACO,MAAM,CAAC,eAAe,CAAI,EAAK,EAAE,EAAK;QAC9C,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;YACZ,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,CAAI;QACf,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,MAAM,EAAE,CAAC;YACpE,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,MAAM,EAAE,CAAC;YACpE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,CAAI;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CAAC,CAAI;QACxB,QAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,GAAG,CAAC;YAClB,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,GAAG,CAAC;QACpB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACI,qBAAqB,CAAC,MAAwC;QACnE,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YAC1D,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;SAC3D,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAwC,EAAE,OAAwB;QAC9E,OAAO,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACO,QAAQ,CAAC,EAAK,EAAE,EAAK;QAC7B,OAAO,OAAO,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;CACF;AA7JD,0BA6JC","sourcesContent":["/*\n * Copyright (c) 2020 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Result, captureResult } from '@fgv/ts-utils';\nimport Mustache from 'mustache';\n\n/**\n * Represents a generic range of some comparable type `<T>`.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface RangeOfProperties<T> {\n  readonly min?: T;\n  readonly max?: T;\n}\n\n/**\n * Format strings (in mustache format) to\n * use for both open-ended and complete\n * {@link Experimental.RangeOf | RangeOf<T>}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface RangeOfFormats {\n  minOnly: string;\n  maxOnly: string;\n  minMax: string;\n}\n\n/**\n * Default {@link Experimental.RangeOfFormats | formats} to use for both\n * open-ended and complete {@link Experimental.RangeOf | RangeOf<T>}.\n * @public\n */\nexport const DEFAULT_RANGEOF_FORMATS: RangeOfFormats = {\n  minOnly: '{{min}}-',\n  maxOnly: '-{{max}}',\n  minMax: '{{min}}-{{max}}'\n};\n\n/**\n * Simple implementation of a possibly open-ended range of some comparable\n * type `<T>` with test and formatting.\n * @public\n */\nexport class RangeOf<T> implements RangeOfProperties<T> {\n  /**\n   * Minimum extent of the range.\n   */\n  public readonly min?: T;\n  /**\n   * Maximum extent of the range.\n   */\n  public readonly max?: T;\n\n  /**\n   * Creates a new {@link Experimental.RangeOf | RangeOf<T>}.\n   * @param min - Optional minimum extent of the range.\n   * @param max - Optional maximum extent of the range.\n   */\n  public constructor(min?: T, max?: T) {\n    if (min !== undefined && max !== undefined && this._compare(min, max) === 'greater') {\n      throw new Error(`Inverted range - ${JSON.stringify(min)} must be <= ${JSON.stringify(max)}.`);\n    }\n    this.min = min;\n    this.max = max;\n  }\n\n  /**\n   * Static constructor for a {@link Experimental.RangeOf | RangeOf<T>}.\n   * @param init - {@link Experimental.RangeOfProperties | Range initializer}.\n   * @returns A new {@link Experimental.RangeOf | RangeOf<T>}.\n   */\n  public static createRange<T>(init?: RangeOfProperties<T>): Result<RangeOf<T>> {\n    return captureResult(() => new RangeOf<T>(init?.min, init?.max));\n  }\n\n  /**\n   * Gets a formatted description of a {@link Experimental.RangeOfProperties | RangeOfProperties<T>} given an\n   * optional set of formats and 'empty' value to use.\n   * @param range - The {@link Experimental.RangeOfProperties | RangeOfProperties<T>} to be formatted.\n   * @param formats - Optional {@link Experimental.RangeOfFormats | formats} to use. Default is\n   * {@link Experimental.DEFAULT_RANGEOF_FORMATS | DEFAULT_RANGEOF_FORMATS}.\n   * @param emptyValue - Value which represents unbounded minimum or maximum for this range. Default is `undefined`.\n   * @returns A string representation of the range.\n   */\n  public static propertiesToString<T>(\n    range: RangeOfProperties<T>,\n    formats?: RangeOfFormats,\n    emptyValue?: T\n  ): string | undefined {\n    formats = formats ?? DEFAULT_RANGEOF_FORMATS;\n    if (range.min !== undefined && range.min !== emptyValue) {\n      if (range.max !== undefined && range.max !== emptyValue) {\n        return Mustache.render(formats.minMax, range);\n      } else {\n        return Mustache.render(formats.minOnly, range);\n      }\n    } else if (range.max !== undefined && range.max !== emptyValue) {\n      return Mustache.render(formats.maxOnly, range);\n    }\n    return undefined;\n  }\n\n  /**\n   * Default comparison uses javascript built-in comparison.\n   * @param t1 - First value to be compared.\n   * @param t2 - Second value to be compared.\n   * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger\n   * and `'equal'` if `t1` and `t2` are equal.\n   * @internal\n   */\n  protected static _defaultCompare<T>(t1: T, t2: T): 'less' | 'equal' | 'greater' {\n    if (t1 < t2) {\n      return 'less';\n    } else if (t1 > t2) {\n      return 'greater';\n    }\n    return 'equal';\n  }\n\n  /**\n   * Checks if a supplied value is within this range.\n   * @param t - The value to be tested.\n   * @returns `'included'` if `t` falls within the range, `'less'` if `t` falls\n   * below the minimum extent of the range and `'greater'` if `t` is above the\n   * maximum extent.\n   */\n  public check(t: T): 'less' | 'included' | 'greater' {\n    if (this.min !== undefined && this._compare(t, this.min) === 'less') {\n      return 'less';\n    }\n    if (this.max !== undefined && this._compare(t, this.max) !== 'less') {\n      return 'greater';\n    }\n    return 'included';\n  }\n\n  /**\n   * Determines if a supplied value is within this range.\n   * @param t - The value to be tested.\n   * @returns Returns `true` if `t` falls within the range, `false` otherwise.\n   */\n  public includes(t: T): boolean {\n    return this.check(t) === 'included';\n  }\n\n  /**\n   * Finds the transition value that would bring a supplied value `t` into\n   * range.\n   * @param t - The value to be tested.\n   * @returns The minimum extent of the range if `t` is below the range or\n   * the maximum extent of the range if `t` is above the range.  Returns\n   * `undefined` if `t` already falls within the range.\n   */\n  public findTransition(t: T): T | undefined {\n    switch (this.check(t)) {\n      case 'less':\n        return this.min;\n      case 'included':\n        return this.max;\n    }\n    return undefined;\n  }\n\n  /**\n   * Formats the minimum and maximum values of this range.\n   * @param format - A format function used to format the values.\n   * @returns A {@link Experimental.RangeOfProperties | RangeOfProperties<string>} containing the\n   * formatted representation of the {@link Experimental.RangeOf.min | minimum} and\n   * {@link Experimental.RangeOf.max | maximum}\n   * extent of the range, or `undefined` for an extent that is not present.\n   */\n  public toFormattedProperties(format: (value: T) => string | undefined): RangeOfProperties<string> {\n    return {\n      min: this.min !== undefined ? format(this.min) : undefined,\n      max: this.max !== undefined ? format(this.max) : undefined\n    };\n  }\n\n  /**\n   * Formats this range using the supplied format function.\n   * @param format - Format function used to format minimum and maximum extent values.\n   * @param formats - The {@link Experimental.RangeOfFormats | format strings} used to format the range\n   * (default {@link Experimental.DEFAULT_RANGEOF_FORMATS}).\n   * @returns Returns a formatted representation of this range.\n   */\n  public format(format: (value: T) => string | undefined, formats?: RangeOfFormats): string | undefined {\n    return RangeOf.propertiesToString(this.toFormattedProperties(format), formats);\n  }\n\n  /**\n   * Inner compare method can be overridden by a derived class.\n   * @param t1 - First value to compare.\n   * @param t2 - Second value to compare.\n   * @returns `'less'` if `t1` is less than `t2`, `'greater'` if `t1` is larger\n   * and `'equal'` if `t1` and `t2` are equal.\n   * @internal\n   */\n  protected _compare(t1: T, t2: T): 'less' | 'equal' | 'greater' {\n    return RangeOf._defaultCompare(t1, t2);\n  }\n}\n"]}

package/lib/packlets/hash/hash.d.ts

@@ -0,0 +1,51 @@
+import { Result } from '@fgv/ts-utils';
+/**
+ * Computes an md5 hash from an array of strings. Not secure and not intended to be secure.
+ * @param parts - The strings to be hashed
+ * @returns An md5 hash of the parts
+ * @public
+ */
+export declare function computeHash(parts: string[]): string;
+/**
+ * Computes a normalized hash for an arbitrary javascript value.
+ * @public
+ */
+export declare class Normalizer {
+    /**
+     * Computes a normalized md5 hash from an arbitrary supplied object.  Not secure and not
+     * intended to be secure.  Also not fast and not intended to be fast.
+     *
+     * Normalization just sorts Maps, Sets and object keys by hash so that differences in order
+     * do not affect the hash.
+     *
+     * @param from - The arbitrary `unknown` to be hashed.
+     * @returns A normalized md5 hash for the supplied value.
+     */
+    computeHash(from: unknown): Result<string>;
+    /**
+     * Compares two property names from some object being normalized.
+     * @param k1 - First key to be compared.
+     * @param k2 - Second key to be compared.
+     * @returns `1` if `k1` is greater, `-1` if `k2` is greater and
+     * `0` if they are equal.
+     * @internal
+     */
+    protected _compareKeys(k1: unknown, k2: unknown): number;
+    /**
+     * Normalizes an array of object property entries (e.g. as returned by `Object.entries()`).
+     * @remarks
+     * Converts property names (entry key) to string and then sorts as string.
+     * @param entries - The entries to be normalized.
+     * @returns A normalized sorted array of entries.
+     * @internal
+     */
+    protected _normalizeEntries(entries: Iterable<[unknown, unknown]>): [unknown, unknown][];
+    /**
+     * Constructs a normalized string representation of some literal value.
+     * @param from - The literal value to be normalized.
+     * @returns A normalized string representation of the literal.
+     * @internal
+     */
+    protected _normalizeLiteral(from: string | number | bigint | boolean | symbol | undefined | Date | RegExp | null): Result<string>;
+}
+//# sourceMappingURL=hash.d.ts.map

package/lib/packlets/hash/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../../src/packlets/hash/hash.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAA4C,MAAM,eAAe,CAAC;AAEjF;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAEnD;AAED;;;GAGG;AACH,qBAAa,UAAU;IACrB;;;;;;;;;OASG;IACI,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;IA4BjD;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM;IAaxD;;;;;;;OAOG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE;IAIxF;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CACzB,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,GACnF,MAAM,CAAC,MAAM,CAAC;CAuBlB"}

package/lib/packlets/hash/hash.js

@@ -0,0 +1,166 @@
+"use strict";
+/*
+ * Copyright (c) 2021 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Normalizer = exports.computeHash = void 0;
+const crypto = __importStar(require("crypto"));
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Computes an md5 hash from an array of strings. Not secure and not intended to be secure.
+ * @param parts - The strings to be hashed
+ * @returns An md5 hash of the parts
+ * @public
+ */
+function computeHash(parts) {
+    return crypto.createHash('md5').update(parts.join('|'), 'utf8').digest('hex');
+}
+exports.computeHash = computeHash;
+/**
+ * Computes a normalized hash for an arbitrary javascript value.
+ * @public
+ */
+class Normalizer {
+    /**
+     * Computes a normalized md5 hash from an arbitrary supplied object.  Not secure and not
+     * intended to be secure.  Also not fast and not intended to be fast.
+     *
+     * Normalization just sorts Maps, Sets and object keys by hash so that differences in order
+     * do not affect the hash.
+     *
+     * @param from - The arbitrary `unknown` to be hashed.
+     * @returns A normalized md5 hash for the supplied value.
+     */
+    computeHash(from) {
+        switch (typeof from) {
+            case 'string':
+            case 'bigint':
+            case 'boolean':
+            case 'number':
+            case 'symbol':
+            case 'undefined':
+                return this._normalizeLiteral(from).onSuccess((v) => {
+                    return (0, ts_utils_1.captureResult)(() => computeHash([v]));
+                });
+            case 'object':
+                if (from === null || from instanceof Date || from instanceof RegExp) {
+                    return this._normalizeLiteral(from).onSuccess((v) => {
+                        return (0, ts_utils_1.captureResult)(() => computeHash([v]));
+                    });
+                }
+                else if (Array.isArray(from)) {
+                    return (0, ts_utils_1.mapResults)(from.map((e) => this.computeHash(e))).onSuccess((a) => {
+                        return (0, ts_utils_1.captureResult)(() => computeHash(a));
+                    });
+                }
+                else if (from instanceof Map || from instanceof Set) {
+                    return this.computeHash(this._normalizeEntries(from.entries()));
+                }
+                return this.computeHash(this._normalizeEntries(Object.entries(from)));
+        }
+        return (0, ts_utils_1.fail)(`computeHash: Unexpected type - cannot hash '${typeof from}'`);
+    }
+    /**
+     * Compares two property names from some object being normalized.
+     * @param k1 - First key to be compared.
+     * @param k2 - Second key to be compared.
+     * @returns `1` if `k1` is greater, `-1` if `k2` is greater and
+     * `0` if they are equal.
+     * @internal
+     */
+    _compareKeys(k1, k2) {
+        const cs1 = String(k1);
+        const cs2 = String(k2);
+        if (cs1 > cs2) {
+            return 1;
+        }
+        if (cs2 > cs1) {
+            return -1;
+        }
+        /* c8 ignore next 2 */
+        return 0;
+    }
+    /**
+     * Normalizes an array of object property entries (e.g. as returned by `Object.entries()`).
+     * @remarks
+     * Converts property names (entry key) to string and then sorts as string.
+     * @param entries - The entries to be normalized.
+     * @returns A normalized sorted array of entries.
+     * @internal
+     */
+    _normalizeEntries(entries) {
+        return Array.from(entries).sort((e1, e2) => this._compareKeys(e1[0], e2[0]));
+    }
+    /**
+     * Constructs a normalized string representation of some literal value.
+     * @param from - The literal value to be normalized.
+     * @returns A normalized string representation of the literal.
+     * @internal
+     */
+    _normalizeLiteral(from) {
+        switch (typeof from) {
+            case 'string':
+                return (0, ts_utils_1.succeed)(from);
+            case 'bigint':
+            case 'boolean':
+            case 'number':
+            case 'symbol':
+            case 'undefined':
+                return (0, ts_utils_1.succeed)(`${typeof from}:[[[${String(from)}]]]`);
+        }
+        if (from === null) {
+            return (0, ts_utils_1.succeed)('object:[[[null]]');
+        }
+        if (from instanceof Date) {
+            return (0, ts_utils_1.succeed)(`Date:[[[${String(from.valueOf())}]]]`);
+        }
+        if (from instanceof RegExp) {
+            return (0, ts_utils_1.succeed)(`RegExp:[[[${from.toString()}]]]`);
+        }
+        /* c8 ignore next 2 */
+        return (0, ts_utils_1.fail)(`cannot normalize ${JSON.stringify(from)}`);
+    }
+}
+exports.Normalizer = Normalizer;
+//# sourceMappingURL=hash.js.map

package/lib/packlets/hash/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../../src/packlets/hash/hash.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,+CAAiC;AACjC,4CAAiF;AAEjF;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAe;IACzC,OAAO,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChF,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACH,MAAa,UAAU;IACrB;;;;;;;;;OASG;IACI,WAAW,CAAC,IAAa;QAC9B,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;oBAClD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAC;YACL,KAAK,QAAQ;gBACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;oBACpE,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;wBAClD,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/C,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/B,OAAO,IAAA,qBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;wBACtE,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC7C,CAAC,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,IAAI,YAAY,GAAG,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;oBACtD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAClE,CAAC;gBACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,IAAA,eAAI,EAAC,+CAA+C,OAAO,IAAI,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IACO,YAAY,CAAC,EAAW,EAAE,EAAW;QAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvB,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,sBAAsB;QACtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACO,iBAAiB,CAAC,OAAqC;QAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;OAKG;IACO,iBAAiB,CACzB,IAAoF;QAEpF,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW;gBACd,OAAO,IAAA,kBAAO,EAAC,GAAG,OAAO,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO,IAAA,kBAAO,EAAC,kBAAkB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;YACzB,OAAO,IAAA,kBAAO,EAAC,WAAW,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YAC3B,OAAO,IAAA,kBAAO,EAAC,aAAa,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,sBAAsB;QACtB,OAAO,IAAA,eAAI,EAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AAvGD,gCAuGC","sourcesContent":["/*\n * Copyright (c) 2021 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport * as crypto from 'crypto';\nimport { Result, captureResult, fail, mapResults, succeed } from '@fgv/ts-utils';\n\n/**\n * Computes an md5 hash from an array of strings. Not secure and not intended to be secure.\n * @param parts - The strings to be hashed\n * @returns An md5 hash of the parts\n * @public\n */\nexport function computeHash(parts: string[]): string {\n  return crypto.createHash('md5').update(parts.join('|'), 'utf8').digest('hex');\n}\n\n/**\n * Computes a normalized hash for an arbitrary javascript value.\n * @public\n */\nexport class Normalizer {\n  /**\n   * Computes a normalized md5 hash from an arbitrary supplied object.  Not secure and not\n   * intended to be secure.  Also not fast and not intended to be fast.\n   *\n   * Normalization just sorts Maps, Sets and object keys by hash so that differences in order\n   * do not affect the hash.\n   *\n   * @param from - The arbitrary `unknown` to be hashed.\n   * @returns A normalized md5 hash for the supplied value.\n   */\n  public computeHash(from: unknown): Result<string> {\n    switch (typeof from) {\n      case 'string':\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return this._normalizeLiteral(from).onSuccess((v) => {\n          return captureResult(() => computeHash([v]));\n        });\n      case 'object':\n        if (from === null || from instanceof Date || from instanceof RegExp) {\n          return this._normalizeLiteral(from).onSuccess((v) => {\n            return captureResult(() => computeHash([v]));\n          });\n        } else if (Array.isArray(from)) {\n          return mapResults(from.map((e) => this.computeHash(e))).onSuccess((a) => {\n            return captureResult(() => computeHash(a));\n          });\n        } else if (from instanceof Map || from instanceof Set) {\n          return this.computeHash(this._normalizeEntries(from.entries()));\n        }\n        return this.computeHash(this._normalizeEntries(Object.entries(from)));\n    }\n    return fail(`computeHash: Unexpected type - cannot hash '${typeof from}'`);\n  }\n\n  /**\n   * Compares two property names from some object being normalized.\n   * @param k1 - First key to be compared.\n   * @param k2 - Second key to be compared.\n   * @returns `1` if `k1` is greater, `-1` if `k2` is greater and\n   * `0` if they are equal.\n   * @internal\n   */\n  protected _compareKeys(k1: unknown, k2: unknown): number {\n    const cs1 = String(k1);\n    const cs2 = String(k2);\n    if (cs1 > cs2) {\n      return 1;\n    }\n    if (cs2 > cs1) {\n      return -1;\n    }\n    /* c8 ignore next 2 */\n    return 0;\n  }\n\n  /**\n   * Normalizes an array of object property entries (e.g. as returned by `Object.entries()`).\n   * @remarks\n   * Converts property names (entry key) to string and then sorts as string.\n   * @param entries - The entries to be normalized.\n   * @returns A normalized sorted array of entries.\n   * @internal\n   */\n  protected _normalizeEntries(entries: Iterable<[unknown, unknown]>): [unknown, unknown][] {\n    return Array.from(entries).sort((e1, e2) => this._compareKeys(e1[0], e2[0]));\n  }\n\n  /**\n   * Constructs a normalized string representation of some literal value.\n   * @param from - The literal value to be normalized.\n   * @returns A normalized string representation of the literal.\n   * @internal\n   */\n  protected _normalizeLiteral(\n    from: string | number | bigint | boolean | symbol | undefined | Date | RegExp | null\n  ): Result<string> {\n    switch (typeof from) {\n      case 'string':\n        return succeed(from);\n      case 'bigint':\n      case 'boolean':\n      case 'number':\n      case 'symbol':\n      case 'undefined':\n        return succeed(`${typeof from}:[[[${String(from)}]]]`);\n    }\n    if (from === null) {\n      return succeed('object:[[[null]]');\n    }\n    if (from instanceof Date) {\n      return succeed(`Date:[[[${String(from.valueOf())}]]]`);\n    }\n    if (from instanceof RegExp) {\n      return succeed(`RegExp:[[[${from.toString()}]]]`);\n    }\n    /* c8 ignore next 2 */\n    return fail(`cannot normalize ${JSON.stringify(from)}`);\n  }\n}\n"]}