@fgv/ts-json-base 5.0.0-2 → 5.0.0-21

package/src/packlets/json-file/jsonFsHelper.ts

@@ -0,0 +1,262 @@
+/*
+ * 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.
+ */
+
+import { Converter, Result, Validator, captureResult, fail, mapResults, succeed } from '@fgv/ts-utils';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { JsonValue } from '../json';
+import { DefaultJsonLike, IJsonLike } from './jsonLike';
+
+/**
+ * Options for directory conversion.
+ * TODO: add filtering, allowed and excluded.
+ * @public
+ */
+export interface IJsonFsDirectoryOptions<T, TC = unknown> {
+  /**
+   * The converter used to convert incoming JSON objects.
+   */
+  converter: Converter<T, TC> | Validator<T, TC>;
+
+  /**
+   * Filter applied to items in the directory
+   */
+  files?: RegExp[];
+}
+
+/**
+ * Return value for one item in a directory conversion.
+ * @public
+ */
+export interface IReadDirectoryItem<T> {
+  /**
+   * Relative name of the file that was processed
+   */
+  filename: string;
+
+  /**
+   * The payload of the file.
+   */
+  item: T;
+}
+
+/**
+ * Function to transform the name of a some entity, given an original name
+ * and the contents of the entity.
+ * @public
+ */
+export type ItemNameTransformFunction<T> = (name: string, item: T) => Result<string>;
+
+/**
+ * Options controlling conversion of a directory to a `Map`.
+ * @public
+ */
+export interface IJsonFsDirectoryToMapOptions<T, TC = unknown> extends IJsonFsDirectoryOptions<T, TC> {
+  transformName?: ItemNameTransformFunction<T>;
+}
+
+/**
+ * Function to transform the name of some entity, given only a previous name. This
+ * default implementation always returns `Success` with the value that was passed in.
+ * @param n - The name to be transformed.
+ * @returns - `Success` with the string that was passed in.
+ * @public
+ */
+const defaultNameTransformer = (n: string): Result<string> => succeed(n);
+
+/**
+ * Configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export interface IJsonFsHelperConfig {
+  json: IJsonLike;
+  allowUndefinedWrite: boolean;
+  defaultFiles: RegExp[];
+}
+
+/**
+ * Initialization options for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export type JsonFsHelperInitOptions = Partial<IJsonFsHelperConfig>;
+
+/**
+ * Default configuration for {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+ * @public
+ */
+export const DefaultJsonFsHelperConfig: IJsonFsHelperConfig = {
+  json: DefaultJsonLike,
+  allowUndefinedWrite: false,
+  defaultFiles: [/.*.json/]
+};
+
+/**
+ * Helper class to simplify common filesystem operations involving JSON (or JSON-like)
+ * files.
+ * @public
+ */
+export class JsonFsHelper {
+  /**
+   * Configuration for this {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+   */
+  public readonly config: IJsonFsHelperConfig;
+
+  /**
+   * Construct a new {@link JsonFile.JsonFsHelper | JsonFsHelper}.
+   * @param json - Optional {@link JsonFile.IJsonLike | IJsonLike} used to process strings
+   * and JSON values.
+   */
+  public constructor(init?: JsonFsHelperInitOptions) {
+    this.config = {
+      ...DefaultJsonFsHelperConfig,
+      ...(init ?? {})
+    };
+  }
+
+  /**
+   * Read type-safe JSON from a file.
+   * @param srcPath - Path of the file to read
+   * @returns `Success` with a {@link JsonValue | JsonValue} or `Failure`
+   * with a message if an error occurs.
+   */
+  public readJsonFileSync(srcPath: string): Result<JsonValue> {
+    return captureResult(() => {
+      const fullPath = path.resolve(srcPath);
+      const body = fs.readFileSync(fullPath, 'utf8').toString();
+      return this.config.json.parse(body) as JsonValue;
+    });
+  }
+
+  /**
+   * Read a JSON file and apply a supplied converter or validator.
+   * @param srcPath - Path of the file to read.
+   * @param cv - Converter or validator used to process the file.
+   * @returns `Success` with a result of type `<T>`, or `Failure`
+   * with a message if an error occurs.
+   */
+  public convertJsonFileSync<T, TC = unknown>(
+    srcPath: string,
+    cv: Converter<T, TC> | Validator<T, TC>,
+    context?: TC
+  ): Result<T> {
+    return this.readJsonFileSync(srcPath).onSuccess((json) => {
+      return cv.convert(json, context);
+    });
+  }
+
+  /**
+   * Reads all JSON files from a directory and apply a supplied converter or validator.
+   * @param srcPath - The path of the folder to be read.
+   * @param options - {@link JsonFile.IJsonFsDirectoryOptions | Options} to control
+   * conversion and filtering
+   */
+  public convertJsonDirectorySync<T, TC = unknown>(
+    srcPath: string,
+    options: IJsonFsDirectoryOptions<T>,
+    context?: TC
+  ): Result<IReadDirectoryItem<T>[]> {
+    return captureResult<IReadDirectoryItem<T>[]>(() => {
+      const fullPath = path.resolve(srcPath);
+      if (!fs.statSync(fullPath).isDirectory()) {
+        throw new Error(`${fullPath}: Not a directory`);
+      }
+      const files = fs.readdirSync(fullPath, { withFileTypes: true });
+      const results = files
+        .map((fi) => {
+          if (fi.isFile() && this._pathMatchesOptions(options, fi.name)) {
+            const filePath = path.resolve(fullPath, fi.name);
+            return this.convertJsonFileSync(filePath, options.converter, context)
+              .onSuccess((payload) => {
+                return succeed({
+                  filename: fi.name,
+                  item: payload
+                });
+              })
+              .onFailure((message) => {
+                return fail(`${fi.name}: ${message}`);
+              });
+          }
+          return undefined;
+        })
+        .filter((r): r is Result<IReadDirectoryItem<T>> => r !== undefined);
+      return mapResults(results).orThrow();
+    });
+  }
+
+  /**
+   * Reads and converts or validates all JSON files from a directory, returning a
+   * `Map<string, T>` indexed by file base name (i.e. minus the extension)
+   * with an optional name transformation applied if present.
+   * @param srcPath - The path of the folder to be read.
+   * @param options - {@link JsonFile.IJsonFsDirectoryToMapOptions | Options} to control conversion,
+   * filtering and naming.
+   */
+  public convertJsonDirectoryToMapSync<T, TC = unknown>(
+    srcPath: string,
+    options: IJsonFsDirectoryToMapOptions<T, TC>,
+    context?: unknown
+  ): Result<Map<string, T>> {
+    return this.convertJsonDirectorySync(srcPath, options, context).onSuccess((items) => {
+      const transformName = options.transformName ?? defaultNameTransformer;
+      return mapResults(
+        items.map((item) => {
+          const basename = path.basename(item.filename, '.json');
+          return transformName(basename, item.item).onSuccess((name) => {
+            return succeed<[string, T]>([name, item.item]);
+          });
+        })
+      ).onSuccess((items) => {
+        return succeed(new Map<string, T>(items));
+      });
+    });
+  }
+
+  /**
+   * Write type-safe JSON to a file.
+   * @param srcPath - Path of the file to write.
+   * @param value - The {@link JsonValue | JsonValue} to be written.
+   */
+  public writeJsonFileSync(srcPath: string, value: JsonValue): Result<boolean> {
+    return captureResult(() => {
+      const fullPath = path.resolve(srcPath);
+      const stringified = this.config.json.stringify(value, undefined, 2);
+      /* c8 ignore next 3 */
+      if (stringified === undefined && this.config.allowUndefinedWrite !== true) {
+        throw new Error(`Could not stringify ${value}`);
+      }
+      fs.writeFileSync(fullPath, stringified!);
+      return true;
+    });
+  }
+
+  protected _pathMatchesOptions<T, TC>(options: IJsonFsDirectoryOptions<T, TC>, path: string): boolean {
+    /* c8 ignore next 1 */
+    const match = options.files ?? this.config.defaultFiles;
+    return match.some((m) => m.exec(path));
+  }
+}
+
+/**
+ * @public
+ */
+export const DefaultJsonFsHelper: JsonFsHelper = new JsonFsHelper();

package/src/packlets/json-file/jsonLike.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2024 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.
+ */
+
+import { JsonValue } from '../json';
+
+/**
+ * @public
+ */
+export type JsonReviver = (key: string, value: JsonValue) => JsonValue;
+
+/**
+ * @public
+ */
+export type JsonReplacerFunction = (key: string, value: JsonValue) => JsonValue;
+
+/**
+ * @public
+ */
+export type JsonReplacerArray = (string | number)[];
+
+/**
+ * @public
+ */
+export type JsonReplacer = JsonReplacerFunction | JsonReplacerArray;
+
+/**
+ * @public
+ */
+export interface IJsonLike {
+  parse(text: string, reviver?: JsonReviver, options?: unknown): JsonValue | undefined;
+  stringify(value: JsonValue, replacer?: JsonReplacer, space?: string | number): string | undefined;
+}
+
+/**
+ * @public
+ */
+export const DefaultJsonLike: IJsonLike = JSON;

package/src/packlets/validators/index.ts

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+export * from './validators';

package/src/packlets/validators/validators.ts

@@ -0,0 +1,155 @@
+/*
+ * 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.
+ */
+
+import { Failure, Validation, Validator, fail } from '@fgv/ts-utils';
+import { JsonArray, JsonObject, JsonPrimitive, JsonValue, isJsonArray, isJsonObject } from '../json';
+
+/* eslint-disable no-use-before-define, @typescript-eslint/no-use-before-define */
+
+/**
+ * Validation context for in-place JSON validators.
+ * @public
+ */
+export interface IJsonValidatorContext {
+  ignoreUndefinedProperties?: boolean;
+}
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonPrimitive | JsonPrimitive}.
+ * @public
+ */
+export const jsonPrimitive: Validator<JsonPrimitive, IJsonValidatorContext> =
+  new Validation.Base.GenericValidator({
+    validator: (
+      from: unknown,
+      ctx?: IJsonValidatorContext,
+      self?: Validator<JsonPrimitive, IJsonValidatorContext>
+    ): boolean | Failure<JsonPrimitive> => {
+      if (from === null) {
+        return true;
+      }
+      switch (typeof from) {
+        case 'boolean':
+        case 'string':
+          return true;
+        case 'number':
+          if (!Number.isNaN(from)) {
+            return true;
+          }
+          break;
+      }
+      if (from === undefined && ctx?.ignoreUndefinedProperties === true) {
+        return true;
+      }
+      return fail(`"${String(from)}": not a valid JSON primitive.`);
+    }
+  });
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+export const jsonObject: Validator<JsonObject, IJsonValidatorContext> = new Validation.Base.GenericValidator({
+  validator: (
+    from: unknown,
+    ctx?: IJsonValidatorContext,
+    self?: Validator<JsonObject, IJsonValidatorContext>
+  ) => {
+    if (!isJsonObject(from)) {
+      return fail('not a valid JSON object.');
+    }
+    const errors: string[] = [];
+    for (const [name, value] of Object.entries(from)) {
+      jsonValue.validate(value, ctx).onFailure((m) => {
+        errors.push(`${name}: ${m}`);
+        return fail(m);
+      });
+    }
+    if (errors.length > 0) {
+      return fail(`not a valid JSON object:\n${errors.join('\n')}`);
+    }
+    return true;
+  }
+});
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+export const jsonArray: Validator<JsonArray, IJsonValidatorContext> = new Validation.Base.GenericValidator({
+  validator: (
+    from: unknown,
+    ctx?: IJsonValidatorContext,
+    self?: Validator<JsonArray, IJsonValidatorContext>
+  ) => {
+    if (!isJsonArray(from)) {
+      return fail('not an array');
+    }
+    const errors: string[] = [];
+    for (let i = 0; i < from.length; i++) {
+      const value = from[i];
+      jsonValue.validate(value, ctx).onFailure((m) => {
+        errors.push(`${i}: ${m}`);
+        return fail(m);
+      });
+    }
+    if (errors.length > 0) {
+      return fail(`array contains non-json elements:\n${errors.join('\n')}`);
+    }
+    return true;
+  }
+});
+
+/**
+ * An in-place validator which validates that a supplied `unknown` value is
+ * a valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements
+ * are `undefined` - this default behavior can be overridden by supplying an appropriate
+ * {@link Validators.IJsonValidatorContext | context} at runtime.
+ * @public
+ */
+export const jsonValue: Validator<JsonValue, IJsonValidatorContext> = new Validation.Base.GenericValidator<
+  JsonValue,
+  IJsonValidatorContext
+>({
+  validator: (
+    from: unknown,
+    ctx?: IJsonValidatorContext,
+    self?: Validator<JsonValue, IJsonValidatorContext>
+  ) => {
+    if (isJsonArray(from)) {
+      const result = jsonArray.validate(from, ctx);
+      return result.success === true ? true : result;
+    } else if (isJsonObject(from)) {
+      const result = jsonObject.validate(from, ctx);
+      return result.success === true ? true : result;
+    }
+    const result = jsonPrimitive.validate(from, ctx);
+    return result.success === true ? true : result;
+  }
+});

package/CHANGELOG.md

@@ -1,100 +0,0 @@
-# Change Log - @fgv/ts-json-base
-
-This log was last generated on Thu, 17 Jul 2025 00:13:24 GMT and should not be manually modified.
-
-## 5.0.0
-Thu, 17 Jul 2025 00:13:24 GMT
-
-### Updates
-
-- add sanitizeJsonObject
-- upgrade dependencies
-- bump version
-
-## 4.6.0
-Wed, 02 Jul 2025 05:48:16 GMT
-
-_Version update only_
-
-## 4.5.1
-Wed, 02 Jul 2025 05:47:11 GMT
-
-### Updates
-
-- update rushstack
-
-## 4.5.0
-Tue, 01 Jul 2025 03:26:11 GMT
-
-_Version update only_
-
-## 4.4.0
-Sat, 01 Feb 2025 17:13:10 GMT
-
-_Version update only_
-
-## 4.3.0
-Thu, 30 Jan 2025 00:35:17 GMT
-
-_Version update only_
-
-## 4.2.2
-Thu, 23 Jan 2025 06:19:32 GMT
-
-_Version update only_
-
-## 4.2.1
-Tue, 21 Jan 2025 04:19:21 GMT
-
-_Version update only_
-
-## 4.2.0
-Mon, 20 Jan 2025 09:46:53 GMT
-
-### Updates
-
-- plumb conversion context through
-
-## 4.1.0
-Thu, 09 Jan 2025 05:33:39 GMT
-
-### Updates
-
-- update dependencies
-
-## 4.0.2
-Tue, 14 May 2024 14:45:53 GMT
-
-_Version update only_
-
-## 4.0.1
-Tue, 14 May 2024 05:02:20 GMT
-
-### Updates
-
-- publish
-
-## 4.0.0
-Tue, 14 May 2024 03:09:27 GMT
-
-### Updates
-
-- clean up and renaming in JSON file helpers
-- update generated api docs
-- generalize fs helper to enable yaml
-
-## 3.0.0
-Mon, 22 Jan 2024 07:00:18 GMT
-
-### Updates
-
-- add validators
-- initial refactor
-
-## 2.2.0
-Thu, 18 Jan 2024 05:45:04 GMT
-
-### Updates
-
-- initial refactor
-

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAC;AAEpD,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC"}

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,kEAAoD;AAK3C,gCAAU;AAJnB,+DAAiD;AAI5B,4BAAQ;AAH7B,kEAAoD;AAGrB,gCAAU;AADzC,kDAAgC","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 * as Converters from './packlets/converters';\nimport * as JsonFile from './packlets/json-file';\nimport * as Validators from './packlets/validators';\n\nexport * from './packlets/json';\nexport { Converters, JsonFile, Validators };\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"converters.d.ts","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAc,SAAS,EAAyB,MAAM,eAAe,CAAC;AAC7E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAA6B,MAAM,SAAS,CAAC;AAIrG;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,qBAAqB,CAqBzE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,qBAAqB,CAgCnE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAkCjE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,qBAAqB,CAgBjE,CAAC"}

package/lib/packlets/converters/converters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"converters.js","sourceRoot":"","sources":["../../../src/packlets/converters/converters.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,4CAA6E;AAC7E,kCAAqG;AAYrG;;;GAGG;AACU,QAAA,aAAa,GAAoD,IAAI,qBAAU,CAAC,aAAa,CACxG,CACE,IAAa,EACb,MAAuD,EACvD,GAA2B,EACJ,EAAE;IACzB,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IACD,QAAQ,OAAO,IAAI,EAAE,CAAC;QACpB,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;QACvB,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxB,OAAO,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,MAAM;IACV,CAAC;IACD,OAAO,IAAA,eAAI,EAAC,IAAI,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;AAChE,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,UAAU,GAAiD,IAAI,qBAAU,CAAC,aAAa,CAClG,CACE,IAAa,EACb,MAAoD,EACpD,GAA2B,EACP,EAAE;IACtB,IAAI,CAAC,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAA,eAAI,EAAC,0BAA0B,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,qCAAqC;YACrC,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAY,EAAE,EAAE;YAC1B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,6BAA6B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAChG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,CAAC,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,IAAA,eAAI,EAAC,cAAc,CAAC,CAAC;IAC9B,CAAC;IACD,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,SAAS,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,yBAAyB,MAAK,IAAI,EAAE,CAAC;YACnE,6DAA6D;YAC7D,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACf,SAAS;QACX,CAAC;QACD,iBAAS;aACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACZ,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACf,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,OAAO,IAAA,eAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,IAAA,eAAI,EAAC,sCAAsC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CACF,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,SAAS,GAAgD,IAAI,qBAAU,CAAC,aAAa,CAIhG,CACE,IAAa,EACb,MAAmD,EACnD,GAA2B,EACR,EAAE;IACrB,IAAI,IAAA,kBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,iBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,IAAA,mBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,kBAAU,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,qBAAa,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC1C,CAAC,CACF,CAAC","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 { Conversion, Converter, Result, fail, succeed } from '@fgv/ts-utils';\nimport { JsonArray, JsonObject, JsonPrimitive, JsonValue, isJsonArray, isJsonObject } from '../json';\n\n/* eslint-disable no-use-before-define, @typescript-eslint/no-use-before-define */\n\n/**\n * Conversion context for JSON converters.\n * @public\n */\nexport interface IJsonConverterContext {\n  ignoreUndefinedProperties?: boolean;\n}\n\n/**\n * An converter which converts a supplied `unknown` value to a valid {@link JsonPrimitive | JsonPrimitive}.\n * @public\n */\nexport const jsonPrimitive: Converter<JsonPrimitive, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonPrimitive, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonPrimitive> => {\n    if (from === null) {\n      return succeed(null);\n    }\n    switch (typeof from) {\n      case 'boolean':\n      case 'string':\n        return succeed(from);\n      case 'number':\n        if (!Number.isNaN(from)) {\n          return succeed(from);\n        }\n        break;\n    }\n    return fail(`\"${String(from)}\": not a valid JSON primitive.`);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value into\n * a valid {@link JsonObject | JsonObject}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * {@link Converters.IJsonConverterContext | context} at runtime.\n *\n * Guaranteed to return a new object.\n * @public\n */\nexport const jsonObject: Converter<JsonObject, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonObject, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonObject> => {\n    if (!isJsonObject(from)) {\n      return fail('not a valid JSON object.');\n    }\n    const obj: JsonObject = {};\n    const errors: string[] = [];\n    for (const [name, value] of Object.entries(from)) {\n      if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n        // optionally ignore undefined values\n        continue;\n      }\n      jsonValue\n        .convert(value, ctx)\n        .onSuccess((v: JsonValue) => {\n          obj[name] = v;\n          return succeed(v);\n        })\n        .onFailure((m) => {\n          errors.push(`${name}: ${m}`);\n          return fail(m);\n        });\n    }\n    if (errors.length > 0) {\n      return fail(`not a valid JSON object:\\n${errors.join('\\n')}`);\n    }\n    return succeed(obj);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to\n * a valid {@link JsonArray | JsonArray}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * {@link Converters.IJsonConverterContext | context} at runtime.\n *\n * Guaranteed to return a new array.\n * @public\n */\nexport const jsonArray: Converter<JsonArray, IJsonConverterContext> = new Conversion.BaseConverter(\n  (\n    from: unknown,\n    __self: Converter<JsonArray, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonArray> => {\n    if (!isJsonArray(from)) {\n      return fail('not an array');\n    }\n    const arr: JsonValue[] = [];\n    const errors: string[] = [];\n    for (let i = 0; i < from.length; i++) {\n      const value = from[i];\n      if (value === undefined && ctx?.ignoreUndefinedProperties === true) {\n        // convert undefined to 'null' for parity with JSON.stringify\n        arr.push(null);\n        continue;\n      }\n      jsonValue\n        .convert(value, ctx)\n        .onSuccess((v) => {\n          arr.push(v);\n          return succeed(v);\n        })\n        .onFailure((m) => {\n          errors.push(`${i}: ${m}`);\n          return fail(m);\n        });\n    }\n    if (errors.length > 0) {\n      return fail(`array contains non-json elements:\\n${errors.join('\\n')}`);\n    }\n    return succeed(arr);\n  }\n);\n\n/**\n * An copying converter which converts a supplied `unknown` value to a\n * valid {@link JsonValue | JsonValue}. Fails by default if any properties or array elements\n * are `undefined` - this default behavior can be overridden by supplying an appropriate\n * {@link Converters.IJsonConverterContext | context} at runtime.\n * @public\n */\nexport const jsonValue: Converter<JsonValue, IJsonConverterContext> = new Conversion.BaseConverter<\n  JsonValue,\n  IJsonConverterContext\n>(\n  (\n    from: unknown,\n    __self: Converter<JsonValue, IJsonConverterContext>,\n    ctx?: IJsonConverterContext\n  ): Result<JsonValue> => {\n    if (isJsonArray(from)) {\n      return jsonArray.convert(from, ctx);\n    } else if (isJsonObject(from)) {\n      return jsonObject.convert(from, ctx);\n    }\n    return jsonPrimitive.convert(from, ctx);\n  }\n);\n"]}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/converters/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 './converters';\n"]}

package/lib/packlets/json/common.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/packlets/json/common.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,MAAM,EAAgC,MAAM,eAAe,CAAC;AAIrE;;;GAGG;AAEH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAE7D;;;;GAIG;AAEH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;AAE/D;;;GAGG;AAEH,MAAM,WAAW,SAAU,SAAQ,KAAK,CAAC,SAAS,CAAC;CAAG;AAEtD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE7D;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,aAAa,CAEpE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,UAAU,CAQ9D;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,SAAS,CAE5D;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,CAStE;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAa9E;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,CAOhF;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAE7D;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAExD"}

package/lib/packlets/json/common.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/packlets/json/common.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAkDH,0CAEC;AASD,oCAQC;AASD,kCAEC;AAUD,8CASC;AAUD,sCAaC;AAYD,wCAOC;AAWD,oCAEC;AAUD,gDAEC;AApKD,4CAAqE;AAyCrE;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,IAAa;IAC3C,OAAO,OAAO,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC;AAC5G,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,IAAa;IACxC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACpB,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC;QACzB,CAAC,CAAC,IAAI,YAAY,IAAI,CAAC,CACxB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,IAAa;IACvC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,IAAa;IAC7C,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAA,kBAAO,EAAC,WAAW,CAAC,CAAC;IAC9B,CAAC;SAAM,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAA,kBAAO,EAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;SAAM,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAA,kBAAO,EAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,IAAA,eAAI,EAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,GAAe,EAAE,IAAY;IACzD,IAAI,MAAM,GAAc,GAAG,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,YAAY,IAAI,kBAAkB,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,YAAY,IAAI,kBAAkB,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,OAAO,IAAA,kBAAO,EAAC,MAAM,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAAC,GAAe,EAAE,IAAY;IAC1D,OAAO,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9C,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,IAAA,eAAI,EAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,IAAa;IACxC,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAI,IAAO;IAC3C,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,CAAC","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, fail, succeed } from '@fgv/ts-utils';\n\n/* eslint-disable no-use-before-define */\n\n/**\n * Primitive (terminal) values allowed in by JSON.\n * @public\n */\n// eslint-disable-next-line @rushstack/no-new-null\nexport type JsonPrimitive = boolean | number | string | null;\n\n/**\n * A {@link JsonObject | JsonObject} is a string-keyed object\n * containing only valid {@link JsonValue | JSON values}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport interface JsonObject {\n  [key: string]: JsonValue;\n}\n\n/**\n * A {@link JsonValue | JsonValue} is one of: a {@link JsonPrimitive | JsonPrimitive},\n * a {@link JsonObject | JsonObject} or an {@link JsonArray | JsonArray}.\n * @public\n */\nexport type JsonValue = JsonPrimitive | JsonObject | JsonArray;\n\n/**\n * A {@link JsonArray | JsonArray} is an array containing only valid {@link JsonValue | JsonValues}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/naming-convention\nexport interface JsonArray extends Array<JsonValue> {}\n\n/**\n * Classes of {@link JsonValue | JsonValue}.\n * @public\n */\nexport type JsonValueType = 'primitive' | 'object' | 'array';\n\n/**\n * Test if an `unknown` is a {@link JsonValue | JsonValue}.\n * @param from - The `unknown` to be tested\n * @returns `true` if the supplied parameter is a valid {@link JsonPrimitive | JsonPrimitive},\n * `false` otherwise.\n * @public\n */\nexport function isJsonPrimitive(from: unknown): from is JsonPrimitive {\n  return typeof from === 'boolean' || typeof from === 'number' || typeof from === 'string' || from === null;\n}\n\n/**\n * Test if an `unknown` is potentially a {@link JsonObject | JsonObject}.\n * @param from - The `unknown` to be tested.\n * @returns `true` if the supplied parameter is a non-array, non-special object,\n * `false` otherwise.\n * @public\n */\nexport function isJsonObject(from: unknown): from is JsonObject {\n  return (\n    typeof from === 'object' &&\n    from !== null &&\n    !Array.isArray(from) &&\n    !(from instanceof RegExp) &&\n    !(from instanceof Date)\n  );\n}\n\n/**\n * Test if an `unknown` is potentially a {@link JsonArray | JsonArray}.\n * @param from - The `unknown` to be tested.\n * @returns `true` if the supplied parameter is an array object,\n * `false` otherwise.\n * @public\n */\nexport function isJsonArray(from: unknown): from is JsonArray {\n  return typeof from === 'object' && Array.isArray(from);\n}\n\n/**\n * Identifies whether some `unknown` value is a {@link JsonPrimitive | primitive},\n * {@link JsonObject | object} or {@link JsonArray | array}. Fails for any value\n * that cannot be converted to JSON (e.g. a function) _but_ this is a shallow test -\n * it does not test the properties of an object or elements in an array.\n * @param from - The `unknown` value to be tested\n * @public\n */\nexport function classifyJsonValue(from: unknown): Result<JsonValueType> {\n  if (isJsonPrimitive(from)) {\n    return succeed('primitive');\n  } else if (isJsonObject(from)) {\n    return succeed('object');\n  } else if (isJsonArray(from)) {\n    return succeed('array');\n  }\n  return fail(`Invalid JSON: ${from}`);\n}\n\n/**\n * Picks a nested field from a supplied {@link JsonObject | JsonObject}.\n * @param src - The {@link JsonObject | object} from which the field is to be picked.\n * @param path - Dot-separated path of the member to be picked.\n * @returns `Success` with the property if the path is valid, `Failure`\n * with an error message otherwise.\n * @public\n */\nexport function pickJsonValue(src: JsonObject, path: string): Result<JsonValue> {\n  let result: JsonValue = src;\n  for (const part of path.split('.')) {\n    if (result && isJsonObject(result)) {\n      result = result[part];\n      if (result === undefined) {\n        return fail(`${path}: child '${part}' does not exist`);\n      }\n    } else {\n      return fail(`${path}: child '${part}' does not exist`);\n    }\n  }\n  return succeed(result);\n}\n\n/**\n * Picks a nested {@link JsonObject | JsonObject} from a supplied\n * {@link JsonObject | JsonObject}.\n * @param src - The {@link JsonObject | object} from which the field is\n * to be picked.\n * @param path - Dot-separated path of the member to be picked.\n * @returns `Success` with the property if the path is valid and the value\n * is an object. Returns `Failure` with details if an error occurs.\n * @public\n */\nexport function pickJsonObject(src: JsonObject, path: string): Result<JsonObject> {\n  return pickJsonValue(src, path).onSuccess((v) => {\n    if (!isJsonObject(v)) {\n      return fail(`${path}: not an object`);\n    }\n    return succeed(v);\n  });\n}\n\n/**\n * \"Sanitizes\" an `unknown` by stringifying and then parsing it.  Guarantees a\n * valid {@link JsonValue | JsonValue} but is not idempotent and gives no guarantees\n * about fidelity. Fails if the supplied value cannot be stringified as Json.\n * @param from - The `unknown` to be sanitized.\n * @returns `Success` with a {@link JsonValue | JsonValue} if conversion succeeds,\n * `Failure` with details if an error occurs.\n * @public\n */\nexport function sanitizeJson(from: unknown): Result<JsonValue> {\n  return captureResult(() => JSON.parse(JSON.stringify(from)));\n}\n\n/**\n * Sanitizes some value using JSON stringification and parsing, returning an\n * returning a matching strongly-typed value.\n * @param from - The value to be sanitized.\n * @returns `Success` with a {@link JsonObject | JsonObject} if conversion succeeds,\n * `Failure` with details if an error occurs.\n * @public\n */\nexport function sanitizeJsonObject<T>(from: T): Result<T> {\n  return captureResult(() => JSON.parse(JSON.stringify(from)));\n}\n"]}

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

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