@fgv/ts-utils 1.9.4 → 2.0.1-alpha.0

package/lib/packlets/conversion/stringConverter.js

@@ -0,0 +1,97 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringConverter = void 0;
+const base_1 = require("../base");
+const converter_1 = require("./converter");
+/**
+ * The {@link Conversion.StringConverter | StringConverter} class extends
+ * {@link Conversion.BaseConverter | BaseConverter} to provide string-specific
+ * helper methods.
+ * @public
+ */
+class StringConverter extends converter_1.BaseConverter {
+    /**
+     * Construct a new {@link Conversion.StringConverter | StringConverter}.
+     * @param defaultContext - Optional context used by the conversion.
+     * @param traits - Optional traits to be applied to the conversion.
+     * @param converter - Optional conversion function to be used for the conversion.
+     */
+    constructor(defaultContext, traits, converter = StringConverter._convert) {
+        super(converter, defaultContext, traits);
+    }
+    /**
+     * @internal
+     */
+    static _convert(from) {
+        return typeof from === 'string' ? (0, base_1.succeed)(from) : (0, base_1.fail)(`Not a string: ${JSON.stringify(from)}`);
+    }
+    /**
+     * @internal
+     */
+    static _wrap(wrapped, converter, traits) {
+        return new StringConverter(undefined, undefined, (from) => {
+            return wrapped.convert(from).onSuccess(converter);
+        })._with(wrapped._traits(traits));
+    }
+    /**
+     * Concrete implementation of {@link Conversion.StringConverter.matching#string | StringConverter.matching(string)},
+     * {@link Conversion.StringConverter.matching#array | StringConverter.matching(string[])},
+     * {@link Conversion.StringConverter.matching#set | StringConverter.matching(Set<string>)}, and
+     * {@link Conversion.StringConverter.matching#regexp | StringConverter.matching(RegExp)}.
+     * @internal
+     */
+    matching(match, options) {
+        const message = options === null || options === void 0 ? void 0 : options.message;
+        if (typeof match === 'string') {
+            return StringConverter._wrap(this, (from) => {
+                return match === from
+                    ? (0, base_1.succeed)(from)
+                    : (0, base_1.fail)(message ? `"${from}": ${message}` : `"${from}": does not match "${match}"`);
+            });
+        }
+        else if (match instanceof RegExp) {
+            return StringConverter._wrap(this, (from) => {
+                return match.test(from)
+                    ? (0, base_1.succeed)(from)
+                    : (0, base_1.fail)(message ? `"${from}": ${message}` : `"${from}": does not match "${match}"`);
+            });
+        }
+        else if (match instanceof Set) {
+            return StringConverter._wrap(this, (from) => {
+                return match.has(from)
+                    ? (0, base_1.succeed)(from)
+                    : (0, base_1.fail)(message ? `"${from}": ${message}` : `"${from}": not found in set`);
+            });
+        }
+        else {
+            return StringConverter._wrap(this, (from) => {
+                return match.includes(from)
+                    ? (0, base_1.succeed)(from)
+                    : (0, base_1.fail)(message ? `"${from}": ${message}` : `"${from}": not found in [${match.join(',')}]`);
+            });
+        }
+    }
+}
+exports.StringConverter = StringConverter;
+//# sourceMappingURL=stringConverter.js.map

package/lib/packlets/conversion/stringConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringConverter.js","sourceRoot":"","sources":["../../../src/packlets/conversion/stringConverter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAChD,2CAAwE;AAiBxE;;;;;GAKG;AACH,MAAa,eAAyD,SAAQ,yBAAoB;IAChG;;;;;OAKG;IACH,YACE,cAAmB,EACnB,MAAwB,EACxB,YAAgF,eAAe,CAAC,QAAQ;QAExG,KAAK,CAAC,SAAS,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,QAAQ,CAAmB,IAAa;QACvD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,KAAK,CACpB,OAA+B,EAC/B,SAAiC,EACjC,MAAwB;QAExB,OAAO,IAAI,eAAe,CAAQ,SAAS,EAAE,SAAS,EAAE,CAAC,IAAa,EAAE,EAAE;YACxE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,CAAC;IA8CD;;;;;;OAMG;IACI,QAAQ,CACb,KAA0C,EAC1C,OAAqC;QAErC,MAAM,OAAO,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,KAAK,IAAI;oBACnB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,KAAK,YAAY,MAAM,EAAE;YAClC,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;oBACrB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,sBAAsB,KAAK,GAAG,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,KAAK,YAAY,GAAG,EAAE;YAC/B,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;oBACpB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,eAAe,CAAC,KAAK,CAAQ,IAAI,EAAE,CAAC,IAAO,EAAE,EAAE;gBACpD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACzB,CAAC,CAAC,IAAA,cAAO,EAAC,IAAS,CAAC;oBACpB,CAAC,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,oBAAoB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/F,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;CACF;AArHD,0CAqHC","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\nimport { Result, fail, succeed } from '../base';\nimport { BaseConverter, Converter, ConverterTraits } from './converter';\n\n/**\n * Options for {@link Conversion.StringConverter | StringConverter}\n * matching method\n * @public\n */\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface StringMatchOptions {\n  /**\n   * An optional message to be displayed if a non-matching string\n   * is encountered.\n   */\n  message?: string;\n}\n\n/**\n * The {@link Conversion.StringConverter | StringConverter} class extends\n * {@link Conversion.BaseConverter | BaseConverter} to provide string-specific\n * helper methods.\n * @public\n */\nexport class StringConverter<T extends string = string, TC = unknown> extends BaseConverter<T, TC> {\n  /**\n   * Construct a new {@link Conversion.StringConverter | StringConverter}.\n   * @param defaultContext - Optional context used by the conversion.\n   * @param traits - Optional traits to be applied to the conversion.\n   * @param converter - Optional conversion function to be used for the conversion.\n   */\n  public constructor(\n    defaultContext?: TC,\n    traits?: ConverterTraits,\n    converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T> = StringConverter._convert\n  ) {\n    super(converter, defaultContext, traits);\n  }\n\n  /**\n   * @internal\n   */\n  protected static _convert<T extends string>(from: unknown): Result<T> {\n    return typeof from === 'string' ? succeed(from as T) : fail(`Not a string: ${JSON.stringify(from)}`);\n  }\n\n  /**\n   * @internal\n   */\n  protected static _wrap<T extends string, TC>(\n    wrapped: StringConverter<T, TC>,\n    converter: (from: T) => Result<T>,\n    traits?: ConverterTraits\n  ): StringConverter<T, TC> {\n    return new StringConverter<T, TC>(undefined, undefined, (from: unknown) => {\n      return wrapped.convert(from).onSuccess(converter);\n    })._with(wrapped._traits(traits));\n  }\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * a supplied string.\n   * @param match - The string to be matched\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_STRING}\n   */\n  public matching(match: string, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * one of a supplied array of strings.\n   * @param match - The array of allowed strings.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_ARRAY}\n   */\n  public matching(match: string[], options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * one of a supplied `Set` of strings.\n   * @param match - The `Set` of allowed strings.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion.\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_SET}\n   */\n  public matching(match: Set<T>, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Returns a {@link Conversion.StringConverter | StringConverter} which constrains the result to match\n   * a supplied regular expression.\n   * @param match - The regular expression to be used as a constraint.\n   * @param options - Optional {@link Conversion.StringMatchOptions} for this conversion\n   * @returns {@link Success} with a matching string or {@link Failure} with an informative\n   * error if the string does not match.\n   * {@label WITH_REGEXP}\n   */\n  public matching(match: RegExp, options?: Partial<StringMatchOptions>): StringConverter<T, TC>;\n\n  /**\n   * Concrete implementation of {@link Conversion.StringConverter.matching#string | StringConverter.matching(string)},\n   * {@link Conversion.StringConverter.matching#array | StringConverter.matching(string[])},\n   * {@link Conversion.StringConverter.matching#set | StringConverter.matching(Set<string>)}, and\n   * {@link Conversion.StringConverter.matching#regexp | StringConverter.matching(RegExp)}.\n   * @internal\n   */\n  public matching(\n    match: string | string[] | Set<T> | RegExp,\n    options?: Partial<StringMatchOptions>\n  ): StringConverter<T, TC> {\n    const message = options?.message;\n    if (typeof match === 'string') {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match === from\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": does not match \"${match}\"`);\n      });\n    } else if (match instanceof RegExp) {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.test(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": does not match \"${match}\"`);\n      });\n    } else if (match instanceof Set) {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.has(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": not found in set`);\n      });\n    } else {\n      return StringConverter._wrap<T, TC>(this, (from: T) => {\n        return match.includes(from)\n          ? succeed(from as T)\n          : fail(message ? `\"${from}\": ${message}` : `\"${from}\": not found in [${match.join(',')}]`);\n      });\n    }\n  }\n}\n"]}

package/{csvHelpers.d.ts → lib/packlets/csv/csvHelpers.d.ts}

@@ -1,4 +1,4 @@
-import { Result } from './result';
+import { Result } from '../base';
 /**
  * Options for {@link Csv.readCsvFileSync}
  * @beta

package/lib/packlets/csv/csvHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvHelpers.d.ts","sourceRoot":"","sources":["../../../src/packlets/csv/csvHelpers.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAEhD;;;GAGG;AAEH,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CActF"}

package/lib/packlets/csv/csvHelpers.js

@@ -0,0 +1,69 @@
+"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 __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.readCsvFileSync = void 0;
+const fs = __importStar(require("fs"));
+const papaparse_1 = require("papaparse");
+const path = __importStar(require("path"));
+const base_1 = require("../base");
+/**
+ * Reads a CSV file from a supplied path.
+ * @param srcPath - Source path from which the file is read.
+ * @param options - optional parameters to control the processing
+ * @returns The contents of the file.
+ * @beta
+ */
+function readCsvFileSync(srcPath, options) {
+    return (0, base_1.captureResult)(() => {
+        const fullPath = path.resolve(srcPath);
+        const body = fs.readFileSync(fullPath, 'utf8').toString();
+        options = options !== null && options !== void 0 ? options : {};
+        // eslint-disable-next-line
+        return (0, papaparse_1.parse)(body, Object.assign({ transform: (s) => s.trim(), header: false, dynamicTyping: false, skipEmptyLines: 'greedy' }, options)).data.slice(1);
+    });
+}
+exports.readCsvFileSync = readCsvFileSync;
+//# sourceMappingURL=csvHelpers.js.map

package/lib/packlets/csv/csvHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvHelpers.js","sourceRoot":"","sources":["../../../src/packlets/csv/csvHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AACzB,yCAAkC;AAClC,2CAA6B;AAC7B,kCAAgD;AAWhD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,OAAe,EAAE,OAAoB;IACnE,OAAO,IAAA,oBAAa,EAAC,GAAG,EAAE;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1D,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,2BAA2B;QAC3B,OAAO,IAAA,iBAAK,EAAC,IAAI,kBACf,SAAS,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAClC,MAAM,EAAE,KAAK,EACb,aAAa,EAAE,KAAK,EACpB,cAAc,EAAE,QAAQ,IACrB,OAAO,EACV,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,0CAcC","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 * as fs from 'fs';\nimport { parse } from 'papaparse';\nimport * as path from 'path';\nimport { Result, captureResult } from '../base';\n\n/**\n * Options for {@link Csv.readCsvFileSync}\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface CsvOptions {\n  delimiter?: string;\n}\n\n/**\n * Reads a CSV file from a supplied path.\n * @param srcPath - Source path from which the file is read.\n * @param options - optional parameters to control the processing\n * @returns The contents of the file.\n * @beta\n */\nexport function readCsvFileSync(srcPath: string, options?: CsvOptions): Result<unknown> {\n  return captureResult(() => {\n    const fullPath = path.resolve(srcPath);\n    const body = fs.readFileSync(fullPath, 'utf8').toString();\n    options = options ?? {};\n    // eslint-disable-next-line\n    return parse(body, {\n      transform: (s: string) => s.trim(),\n      header: false,\n      dynamicTyping: false,\n      skipEmptyLines: 'greedy',\n      ...options\n    }).data.slice(1);\n  });\n}\n"]}

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

@@ -0,0 +1,2 @@
+export * from './csvHelpers';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/csv/index.ts"],"names":[],"mappings":"AAsBA,cAAc,cAAc,CAAC"}

package/lib/packlets/csv/index.js

@@ -0,0 +1,39 @@
+"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 __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("./csvHelpers"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/csv/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,+CAA6B","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\nexport * from './csvHelpers';\n"]}

package/{extendedArray.d.ts → lib/packlets/experimental/extendedArray.d.ts}

@@ -1,4 +1,4 @@
-import { Result } from './result';
+import { Result } from '../base';
 /**
  * An experimental array template which extend built-in `Array` to include a handful
  * of predicates which return {@link Result | Result<T>}.
@@ -7,16 +7,16 @@ import { Result } from './result';
 export declare class ExtendedArray<T> extends Array<T> {
     readonly itemDescription: string;
     /**
-     * Constructs an {@link ExtendedArray}.
+     * Constructs an {@link Experimental.ExtendedArray}.
      * @param itemDescription - Brief description of the type of each item in this array.
      * @param items - The initial contents of the array.
      */
     constructor(itemDescription: string, ...items: T[]);
     /**
      * Type guard to determine if some arbitrary array is an
-     * {@link ExtendedArray}
+     * {@link Experimental.ExtendedArray}
      * @param a - The `Array` to be tested.
-     * @returns Returns `true` if `a` is an {@link ExtendedArray},
+     * @returns Returns `true` if `a` is an {@link Experimental.ExtendedArray},
      * `false` otherwise.
      */
     static isExtendedArray<T>(a?: T[]): a is ExtendedArray<T>;
@@ -30,7 +30,7 @@ export declare class ExtendedArray<T> extends Array<T> {
      */
     single(predicate?: (item: T) => boolean): Result<T>;
     /**
-     * Returns the first element of an {@link ExtendedArray}. Fails with an
+     * Returns the first element of an {@link Experimental.ExtendedArray}. Fails with an
      * error message if the array is empty.
      * @param failMessage - Optional message to be displayed in the event of failure.
      * @returns Returns {@link Success | Success<T>} with the value of the first element
@@ -38,7 +38,7 @@ export declare class ExtendedArray<T> extends Array<T> {
      */
     first(failMessage?: string): Result<T>;
     /**
-     * Returns an array containing all elements of an {@link ExtendedArray}. Fails with
+     * Returns an array containing all elements of an {@link Experimental.ExtendedArray}. Fails with
      * an error message if the array is empty.
      * @param failMessage - Optional message to be displayed in the event of failure.
      * @returns Returns {@link Success | Success<T[]>} with a new (non-extended) `Array`
@@ -48,7 +48,7 @@ export declare class ExtendedArray<T> extends Array<T> {
     atLeastOne(failMessage?: string): Result<T[]>;
     /**
      * Gets a new (non-extended) `Array` containing all of the elements from this
-     * {@link ExtendedArray}.
+     * {@link Experimental.ExtendedArray}.
      * @returns A new (non-extended) `Array<T>`.
      */
     all(): T[];

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

@@ -0,0 +1 @@
+{"version":3,"file":"extendedArray.d.ts","sourceRoot":"","sources":["../../../src/packlets/experimental/extendedArray.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAC5C,SAAgB,eAAe,EAAE,MAAM,CAAC;IAExC;;;;OAIG;gBACgB,eAAe,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC,EAAE;IAKzD;;;;;;OAMG;WACW,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;IAIhE;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IAW1D;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;IAO7C;;;;;;;OAOG;IACI,UAAU,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC;IAOpD;;;;OAIG;IACI,GAAG,IAAI,CAAC,EAAE;CAGlB"}

package/lib/packlets/experimental/extendedArray.js

@@ -0,0 +1,106 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendedArray = void 0;
+const base_1 = require("../base");
+/**
+ * An experimental array template which extend built-in `Array` to include a handful
+ * of predicates which return {@link Result | Result<T>}.
+ * @beta
+ */
+class ExtendedArray extends Array {
+    /**
+     * Constructs an {@link Experimental.ExtendedArray}.
+     * @param itemDescription - Brief description of the type of each item in this array.
+     * @param items - The initial contents of the array.
+     */
+    constructor(itemDescription, ...items) {
+        super(...items);
+        this.itemDescription = itemDescription;
+    }
+    /**
+     * Type guard to determine if some arbitrary array is an
+     * {@link Experimental.ExtendedArray}
+     * @param a - The `Array` to be tested.
+     * @returns Returns `true` if `a` is an {@link Experimental.ExtendedArray},
+     * `false` otherwise.
+     */
+    static isExtendedArray(a) {
+        return a instanceof ExtendedArray;
+    }
+    /**
+     * Determines if this array contains exactly one element which matches
+     * a supplied predicate.
+     * @param predicate - The predicate function to be applied.
+     * @returns Returns {@link Success | Success<T>} with the single matching
+     * result if exactly one item matches `predicate`.  Returns {@link Failure}
+     * with an error message if there are no matches or more than one match.
+     */
+    single(predicate) {
+        const match = predicate ? this.filter(predicate) : this;
+        if (match.length === 1) {
+            return (0, base_1.succeed)(match[0]);
+        }
+        if (match.length === 0) {
+            return (0, base_1.fail)(`${this.itemDescription} not found`);
+        }
+        return (0, base_1.fail)(`${this.itemDescription} matches ${match.length} items`);
+    }
+    /**
+     * Returns the first element of an {@link Experimental.ExtendedArray}. Fails with an
+     * error message if the array is empty.
+     * @param failMessage - Optional message to be displayed in the event of failure.
+     * @returns Returns {@link Success | Success<T>} with the value of the first element
+     * in the array, or {@link Failure} with an error message if the array is empty.
+     */
+    first(failMessage) {
+        if (this.length > 0) {
+            return (0, base_1.succeed)(this[0]);
+        }
+        return (0, base_1.fail)(failMessage !== null && failMessage !== void 0 ? failMessage : `${this.itemDescription} not found`);
+    }
+    /**
+     * Returns an array containing all elements of an {@link Experimental.ExtendedArray}. Fails with
+     * an error message if the array is empty.
+     * @param failMessage - Optional message to be displayed in the event of failure.
+     * @returns Returns {@link Success | Success<T[]>} with a new (non-extended) `Array`
+     * containing the elements of this array, or {@link Failure} with an error message
+     * if the array is empty.
+     */
+    atLeastOne(failMessage) {
+        if (this.length > 0) {
+            return (0, base_1.succeed)(Array.from(this));
+        }
+        return (0, base_1.fail)(failMessage !== null && failMessage !== void 0 ? failMessage : `${this.itemDescription} not found`);
+    }
+    /**
+     * Gets a new (non-extended) `Array` containing all of the elements from this
+     * {@link Experimental.ExtendedArray}.
+     * @returns A new (non-extended) `Array<T>`.
+     */
+    all() {
+        return Array.from(this);
+    }
+}
+exports.ExtendedArray = ExtendedArray;
+//# sourceMappingURL=extendedArray.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"extendedArray.js","sourceRoot":"","sources":["../../../src/packlets/experimental/extendedArray.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,kCAAgD;AAEhD;;;;GAIG;AACH,MAAa,aAAiB,SAAQ,KAAQ;IAG5C;;;;OAIG;IACH,YAAmB,eAAuB,EAAE,GAAG,KAAU;QACvD,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;QAChB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,eAAe,CAAI,CAAO;QACtC,OAAO,CAAC,YAAY,aAAa,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,SAAgC;QAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,OAAO,IAAA,cAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,eAAe,YAAY,CAAC,CAAC;SAClD;QACD,OAAO,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,eAAe,YAAY,KAAK,CAAC,MAAM,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAoB;QAC/B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACnB,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACzB;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,GAAG,IAAI,CAAC,eAAe,YAAY,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,WAAoB;QACpC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACnB,OAAO,IAAA,cAAO,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SAClC;QACD,OAAO,IAAA,WAAI,EAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,GAAG,IAAI,CAAC,eAAe,YAAY,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,GAAG;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AAhFD,sCAgFC","sourcesContent":["/*\r\n * Copyright (c) 2020 Erik Fortune\r\n *\r\n * Permission is hereby granted, free of charge, to any person obtaining a copy\r\n * of this software and associated documentation files (the \"Software\"), to deal\r\n * in the Software without restriction, including without limitation the rights\r\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n * copies of the Software, and to permit persons to whom the Software is\r\n * furnished to do so, subject to the following conditions:\r\n *\r\n * The above copyright notice and this permission notice shall be included in all\r\n * copies or substantial portions of the Software.\r\n *\r\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n * SOFTWARE.\r\n */\r\n\r\nimport { Result, fail, succeed } from '../base';\r\n\r\n/**\r\n * An experimental array template which extend built-in `Array` to include a handful\r\n * of predicates which return {@link Result | Result<T>}.\r\n * @beta\r\n */\r\nexport class ExtendedArray<T> extends Array<T> {\r\n  public readonly itemDescription: string;\r\n\r\n  /**\r\n   * Constructs an {@link Experimental.ExtendedArray}.\r\n   * @param itemDescription - Brief description of the type of each item in this array.\r\n   * @param items - The initial contents of the array.\r\n   */\r\n  public constructor(itemDescription: string, ...items: T[]) {\r\n    super(...items);\r\n    this.itemDescription = itemDescription;\r\n  }\r\n\r\n  /**\r\n   * Type guard to determine if some arbitrary array is an\r\n   * {@link Experimental.ExtendedArray}\r\n   * @param a - The `Array` to be tested.\r\n   * @returns Returns `true` if `a` is an {@link Experimental.ExtendedArray},\r\n   * `false` otherwise.\r\n   */\r\n  public static isExtendedArray<T>(a?: T[]): a is ExtendedArray<T> {\r\n    return a instanceof ExtendedArray;\r\n  }\r\n\r\n  /**\r\n   * Determines if this array contains exactly one element which matches\r\n   * a supplied predicate.\r\n   * @param predicate - The predicate function to be applied.\r\n   * @returns Returns {@link Success | Success<T>} with the single matching\r\n   * result if exactly one item matches `predicate`.  Returns {@link Failure}\r\n   * with an error message if there are no matches or more than one match.\r\n   */\r\n  public single(predicate?: (item: T) => boolean): Result<T> {\r\n    const match = predicate ? this.filter(predicate) : this;\r\n    if (match.length === 1) {\r\n      return succeed(match[0]);\r\n    }\r\n    if (match.length === 0) {\r\n      return fail(`${this.itemDescription} not found`);\r\n    }\r\n    return fail(`${this.itemDescription} matches ${match.length} items`);\r\n  }\r\n\r\n  /**\r\n   * Returns the first element of an {@link Experimental.ExtendedArray}. Fails with an\r\n   * error message if the array is empty.\r\n   * @param failMessage - Optional message to be displayed in the event of failure.\r\n   * @returns Returns {@link Success | Success<T>} with the value of the first element\r\n   * in the array, or {@link Failure} with an error message if the array is empty.\r\n   */\r\n  public first(failMessage?: string): Result<T> {\r\n    if (this.length > 0) {\r\n      return succeed(this[0]);\r\n    }\r\n    return fail(failMessage ?? `${this.itemDescription} not found`);\r\n  }\r\n\r\n  /**\r\n   * Returns an array containing all elements of an {@link Experimental.ExtendedArray}. Fails with\r\n   * an error message if the array is empty.\r\n   * @param failMessage - Optional message to be displayed in the event of failure.\r\n   * @returns Returns {@link Success | Success<T[]>} with a new (non-extended) `Array`\r\n   * containing the elements of this array, or {@link Failure} with an error message\r\n   * if the array is empty.\r\n   */\r\n  public atLeastOne(failMessage?: string): Result<T[]> {\r\n    if (this.length > 0) {\r\n      return succeed(Array.from(this));\r\n    }\r\n    return fail(failMessage ?? `${this.itemDescription} not found`);\r\n  }\r\n\r\n  /**\r\n   * Gets a new (non-extended) `Array` containing all of the elements from this\r\n   * {@link Experimental.ExtendedArray}.\r\n   * @returns A new (non-extended) `Array<T>`.\r\n   */\r\n  public all(): T[] {\r\n    return Array.from(this);\r\n  }\r\n}\r\n"]}

package/{formatter.d.ts → lib/packlets/experimental/formatter.d.ts}

@@ -1,4 +1,4 @@
-import { Result } from './result';
+import { Result } from '../base';
 /**
  * Destination format for some formatted string.
  * @beta
@@ -31,7 +31,7 @@ export declare class FormattableBase {
      */
     protected static _tryAddDetail(details: string[], label: string, value: string | undefined): void;
     /**
-     * {@inheritdoc Formattable.format}
+     * {@inheritdoc Experimental.Formattable.format}
      */
     format(template: string): Result<string>;
 }
@@ -42,14 +42,14 @@ export declare class FormattableBase {
  */
 export type Formatter<T> = (format: string, item: T) => Result<string>;
 /**
- * A collection of {@link Formatter | formatters} indexed by target name, to enable
+ * A collection of {@link Experimental.Formatter | formatters} indexed by target name, to enable
  * different format methods per output target.
  * @beta
  */
 export type FormattersByExtendedTarget<TFT extends FormatTargets, T> = Record<TFT, Formatter<T>>;
 /**
- * A collection of {@link Formatter | formatters} indexed by the {@link FormatTargets | default supported
- * target formats}.
+ * A collection of {@link Experimental.Formatter | formatters} indexed by the
+ * {@link Experimental.FormatTargets | default supported target formats}.
  * @beta
  */
 export type FormattersByTarget<T> = FormattersByExtendedTarget<FormatTargets, T>;
@@ -58,7 +58,7 @@ export type FormattersByTarget<T> = FormattersByExtendedTarget<FormatTargets, T>
  * per output line.
  * @param format - A mustache template used to format each item.
  * @param items - The items to be formatted.
- * @param itemFormatter - The {@link Formatter | Formatter<T>} used to format each item.
+ * @param itemFormatter - The {@link Experimental.Formatter | Formatter<T>} used to format each item.
  * @returns The resulting string.
  * @beta
  */

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

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../../src/packlets/experimental/formatter.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAAsC,MAAM,SAAS,CAAC;AAIrE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;AAE1D;;;GAGG;AAEH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;CACxC;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAOjG;;OAEG;IACI,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;CAGhD;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;AAEvE;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CAAC,GAAG,SAAS,aAAa,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACjG;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,0BAA0B,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;AAEjF;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CASrG"}

package/lib/packlets/experimental/formatter.js

@@ -0,0 +1,75 @@
+"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.formatList = exports.FormattableBase = void 0;
+const mustache_1 = __importDefault(require("mustache"));
+const base_1 = require("../base");
+mustache_1.default.escape = (s) => s;
+/**
+ * Base class which adds common formatting.
+ * @beta
+ */
+class FormattableBase {
+    /**
+     * Helper enables derived classes to add named details to a formatted presentation.
+     * @param details - An array of detail description strings.
+     * @param label - Label to use for the new detail.
+     * @param value - Value to use for the new detail.
+     * @internal
+     */
+    static _tryAddDetail(details, label, value) {
+        if (value !== undefined) {
+            const padded = `  ${label}:`.padEnd(20, ' ');
+            details.push(`${padded} ${value}`);
+        }
+    }
+    /**
+     * {@inheritdoc Experimental.Formattable.format}
+     */
+    format(template) {
+        return (0, base_1.captureResult)(() => mustache_1.default.render(template, this));
+    }
+}
+exports.FormattableBase = FormattableBase;
+/**
+ * Formats a list of items using the supplied template and formatter, one result
+ * per output line.
+ * @param format - A mustache template used to format each item.
+ * @param items - The items to be formatted.
+ * @param itemFormatter - The {@link Experimental.Formatter | Formatter<T>} used to format each item.
+ * @returns The resulting string.
+ * @beta
+ */
+function formatList(format, items, itemFormatter) {
+    return (0, base_1.mapResults)(items.map((item) => {
+        return itemFormatter(format, item);
+    })).onSuccess((results) => {
+        const filtered = results.filter((s) => s !== '');
+        return (0, base_1.succeed)(filtered.join('\n'));
+    });
+}
+exports.formatList = formatList;
+//# sourceMappingURL=formatter.js.map

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,wDAAgC;AAChC,kCAAqE;AAErE,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;YACvB,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;SACpC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAgB;QAC5B,OAAO,IAAA,oBAAa,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,iBAAU,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,cAAO,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 Mustache from 'mustache';\nimport { Result, captureResult, mapResults, succeed } from '../base';\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"]}