@fgv/ts-json 5.1.0-16 → 5.1.0-17

package/dist/packlets/context/contextHelpers.js

@@ -174,7 +174,7 @@ export class JsonContextHelper {
     /**
      * Applies static `JsonContextHelper.mergeContext` to the
      * {@link IJsonContext | IJsonContext} associated with this helper.
-     * @param add - Optional initializer containing {@link VariableValue | variable values} and/or
+     * @param merge - Optional initializer containing {@link VariableValue | variable values} and/or
      * {@link IJsonReferenceMap | reference maps} to be added to the {@link IJsonContext | context}.
      * @returns `Success` with a new {@link IJsonContext | IJsonContext} containing the variables and
      * references from the base context, merged with and overridden by any that were passed in, or

package/dist/packlets/editor/jsonEditorRule.js

@@ -27,7 +27,7 @@ import { failWithDetail } from '@fgv/ts-utils';
  */
 export class JsonEditorRuleBase {
     /**
-     * {@inheritdoc IJsonEditorRule.editProperty}
+     * {@inheritDoc IJsonEditorRule.editProperty}
      */
     /* c8 ignore start */
     editProperty(__key, __value, __state) {
@@ -35,13 +35,13 @@ export class JsonEditorRuleBase {
     }
     /* c8 ignore stop */
     /**
-     * {@inheritdoc IJsonEditorRule.editValue}
+     * {@inheritDoc IJsonEditorRule.editValue}
      */
     editValue(__value, __state) {
         return failWithDetail('inapplicable', 'inapplicable');
     }
     /**
-     * {@inheritdoc IJsonEditorRule.finalizeProperties}
+     * {@inheritDoc IJsonEditorRule.finalizeProperties}
      */
     finalizeProperties(__deferred, __state) {
         return failWithDetail('inapplicable', 'inapplicable');

package/dist/packlets/editor/jsonReferenceMap.js

@@ -83,7 +83,7 @@ export class ReferenceMapKeyPolicy {
     }
     /**
      * Validates a `Map\<string, T\>` using the validation rules for this policy.
-     * @param items - The `Map\<string, T\>` to be validated.
+     * @param map - The `Map\<string, T\>` to be validated.
      * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
      * validation.
      * @returns `Success` with a new `Map\<string, T\>`, or `Failure` with an error message
@@ -284,10 +284,9 @@ export class SimpleJsonMap extends SimpleJsonMapBase {
 export class PrefixedJsonMap extends SimpleJsonMap {
     /**
      * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values
-     * @param prefix - A string prefix to be enforced for and added to key names as necessary
      * @param values - A string-keyed Map or Record of the `JsonValue` to be returned
      * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values
-     * @param editor - Optional {@link JsonEditor | JsonEditor} used to format returned values
+     * @param options - Optional {@link ISimpleJsonMapOptions | options} to configure the map
      * @public
      */
     constructor(values, context, options) {

package/dist/packlets/editor/rules/conditional.js

@@ -95,7 +95,7 @@ export class ConditionalJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is conditional. Derived classes can override this
      * method to use a different format for conditional properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param key - The property key to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and a
      * {@link EditorRules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the

package/dist/packlets/editor/rules/multivalue.js

@@ -99,7 +99,7 @@ export class MultiValueJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is multi-value. Derived classes can override this
      * method to use a different format for multi-value properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param token - The property key token to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and an
      * {@link EditorRules.IMultiValuePropertyParts | IMultiValuePropertyParts}

package/dist/ts-json.d.ts

@@ -168,7 +168,7 @@ declare class ConditionalJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is conditional. Derived classes can override this
      * method to use a different format for conditional properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param key - The property key to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and a
      * {@link EditorRules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the
@@ -1108,7 +1108,7 @@ export declare class JsonContextHelper {
     /**
      * Applies static `JsonContextHelper.mergeContext` to the
      * {@link IJsonContext | IJsonContext} associated with this helper.
-     * @param add - Optional initializer containing {@link VariableValue | variable values} and/or
+     * @param merge - Optional initializer containing {@link VariableValue | variable values} and/or
      * {@link IJsonReferenceMap | reference maps} to be added to the {@link IJsonContext | context}.
      * @returns `Success` with a new {@link IJsonContext | IJsonContext} containing the variables and
      * references from the base context, merged with and overridden by any that were passed in, or
@@ -1447,15 +1447,15 @@ export declare class JsonEditorConverter extends Conversion.BaseConverter<JsonVa
  */
 export declare class JsonEditorRuleBase implements IJsonEditorRule {
     /**
-     * {@inheritdoc IJsonEditorRule.editProperty}
+     * {@inheritDoc IJsonEditorRule.editProperty}
      */
     editProperty(__key: string, __value: JsonValue, __state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
     /**
-     * {@inheritdoc IJsonEditorRule.editValue}
+     * {@inheritDoc IJsonEditorRule.editValue}
      */
     editValue(__value: JsonValue, __state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
     /**
-     * {@inheritdoc IJsonEditorRule.finalizeProperties}
+     * {@inheritDoc IJsonEditorRule.finalizeProperties}
      */
     finalizeProperties(__deferred: JsonObject[], __state: JsonEditorState): DetailedResult<JsonObject[], JsonEditFailureReason>;
 }
@@ -1872,7 +1872,7 @@ declare class MultiValueJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is multi-value. Derived classes can override this
      * method to use a different format for multi-value properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param token - The property key token to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and an
      * {@link EditorRules.IMultiValuePropertyParts | IMultiValuePropertyParts}
@@ -1891,10 +1891,9 @@ declare class MultiValueJsonEditorRule extends JsonEditorRuleBase {
 export declare class PrefixedJsonMap extends SimpleJsonMap {
     /**
      * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values
-     * @param prefix - A string prefix to be enforced for and added to key names as necessary
      * @param values - A string-keyed Map or Record of the `JsonValue` to be returned
      * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values
-     * @param editor - Optional {@link JsonEditor | JsonEditor} used to format returned values
+     * @param options - Optional {@link ISimpleJsonMapOptions | options} to configure the map
      * @public
      */
     protected constructor(values?: MapOrRecord<JsonValue>, context?: IJsonContext, options?: ISimpleJsonMapOptions);
@@ -2046,7 +2045,7 @@ export declare class ReferenceMapKeyPolicy<T> {
     validateItems(items: [string, T][], options?: IReferenceMapKeyPolicyValidateOptions): Result<[string, T][]>;
     /**
      * Validates a `Map\<string, T\>` using the validation rules for this policy.
-     * @param items - The `Map\<string, T\>` to be validated.
+     * @param map - The `Map\<string, T\>` to be validated.
      * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
      * validation.
      * @returns `Success` with a new `Map\<string, T\>`, or `Failure` with an error message

package/lib/packlets/context/contextHelpers.d.ts

@@ -105,7 +105,7 @@ export declare class JsonContextHelper {
     /**
      * Applies static `JsonContextHelper.mergeContext` to the
      * {@link IJsonContext | IJsonContext} associated with this helper.
-     * @param add - Optional initializer containing {@link VariableValue | variable values} and/or
+     * @param merge - Optional initializer containing {@link VariableValue | variable values} and/or
      * {@link IJsonReferenceMap | reference maps} to be added to the {@link IJsonContext | context}.
      * @returns `Success` with a new {@link IJsonContext | IJsonContext} containing the variables and
      * references from the base context, merged with and overridden by any that were passed in, or

package/lib/packlets/context/contextHelpers.js

@@ -177,7 +177,7 @@ class JsonContextHelper {
     /**
      * Applies static `JsonContextHelper.mergeContext` to the
      * {@link IJsonContext | IJsonContext} associated with this helper.
-     * @param add - Optional initializer containing {@link VariableValue | variable values} and/or
+     * @param merge - Optional initializer containing {@link VariableValue | variable values} and/or
      * {@link IJsonReferenceMap | reference maps} to be added to the {@link IJsonContext | context}.
      * @returns `Success` with a new {@link IJsonContext | IJsonContext} containing the variables and
      * references from the base context, merged with and overridden by any that were passed in, or

package/lib/packlets/editor/jsonEditorRule.d.ts

@@ -49,15 +49,15 @@ export interface IJsonEditorRule {
  */
 export declare class JsonEditorRuleBase implements IJsonEditorRule {
     /**
-     * {@inheritdoc IJsonEditorRule.editProperty}
+     * {@inheritDoc IJsonEditorRule.editProperty}
      */
     editProperty(__key: string, __value: JsonValue, __state: JsonEditorState): DetailedResult<JsonObject, JsonPropertyEditFailureReason>;
     /**
-     * {@inheritdoc IJsonEditorRule.editValue}
+     * {@inheritDoc IJsonEditorRule.editValue}
      */
     editValue(__value: JsonValue, __state: JsonEditorState): DetailedResult<JsonValue, JsonEditFailureReason>;
     /**
-     * {@inheritdoc IJsonEditorRule.finalizeProperties}
+     * {@inheritDoc IJsonEditorRule.finalizeProperties}
      */
     finalizeProperties(__deferred: JsonObject[], __state: JsonEditorState): DetailedResult<JsonObject[], JsonEditFailureReason>;
 }

package/lib/packlets/editor/jsonEditorRule.js

@@ -30,7 +30,7 @@ const ts_utils_1 = require("@fgv/ts-utils");
  */
 class JsonEditorRuleBase {
     /**
-     * {@inheritdoc IJsonEditorRule.editProperty}
+     * {@inheritDoc IJsonEditorRule.editProperty}
      */
     /* c8 ignore start */
     editProperty(__key, __value, __state) {
@@ -38,13 +38,13 @@ class JsonEditorRuleBase {
     }
     /* c8 ignore stop */
     /**
-     * {@inheritdoc IJsonEditorRule.editValue}
+     * {@inheritDoc IJsonEditorRule.editValue}
      */
     editValue(__value, __state) {
         return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');
     }
     /**
-     * {@inheritdoc IJsonEditorRule.finalizeProperties}
+     * {@inheritDoc IJsonEditorRule.finalizeProperties}
      */
     finalizeProperties(__deferred, __state) {
         return (0, ts_utils_1.failWithDetail)('inapplicable', 'inapplicable');

package/lib/packlets/editor/jsonReferenceMap.d.ts

@@ -67,7 +67,7 @@ export declare class ReferenceMapKeyPolicy<T> {
     validateItems(items: [string, T][], options?: IReferenceMapKeyPolicyValidateOptions): Result<[string, T][]>;
     /**
      * Validates a `Map\<string, T\>` using the validation rules for this policy.
-     * @param items - The `Map\<string, T\>` to be validated.
+     * @param map - The `Map\<string, T\>` to be validated.
      * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
      * validation.
      * @returns `Success` with a new `Map\<string, T\>`, or `Failure` with an error message
@@ -262,10 +262,9 @@ export interface IKeyPrefixOptions {
 export declare class PrefixedJsonMap extends SimpleJsonMap {
     /**
      * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values
-     * @param prefix - A string prefix to be enforced for and added to key names as necessary
      * @param values - A string-keyed Map or Record of the `JsonValue` to be returned
      * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values
-     * @param editor - Optional {@link JsonEditor | JsonEditor} used to format returned values
+     * @param options - Optional {@link ISimpleJsonMapOptions | options} to configure the map
      * @public
      */
     protected constructor(values?: MapOrRecord<JsonValue>, context?: IJsonContext, options?: ISimpleJsonMapOptions);

package/lib/packlets/editor/jsonReferenceMap.js

@@ -86,7 +86,7 @@ class ReferenceMapKeyPolicy {
     }
     /**
      * Validates a `Map\<string, T\>` using the validation rules for this policy.
-     * @param items - The `Map\<string, T\>` to be validated.
+     * @param map - The `Map\<string, T\>` to be validated.
      * @param options - Optional {@link IReferenceMapKeyPolicyValidateOptions | options} to control
      * validation.
      * @returns `Success` with a new `Map\<string, T\>`, or `Failure` with an error message
@@ -291,10 +291,9 @@ exports.SimpleJsonMap = SimpleJsonMap;
 class PrefixedJsonMap extends SimpleJsonMap {
     /**
      * Constructs a new {@link PrefixedJsonMap | PrefixedJsonMap} from the supplied values
-     * @param prefix - A string prefix to be enforced for and added to key names as necessary
      * @param values - A string-keyed Map or Record of the `JsonValue` to be returned
      * @param context - Optional {@link IJsonContext | JSON Context} used to format returned values
-     * @param editor - Optional {@link JsonEditor | JsonEditor} used to format returned values
+     * @param options - Optional {@link ISimpleJsonMapOptions | options} to configure the map
      * @public
      */
     constructor(values, context, options) {

package/lib/packlets/editor/rules/conditional.d.ts

@@ -84,7 +84,7 @@ export declare class ConditionalJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is conditional. Derived classes can override this
      * method to use a different format for conditional properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param key - The property key to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and a
      * {@link EditorRules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the

package/lib/packlets/editor/rules/conditional.js

@@ -98,7 +98,7 @@ class ConditionalJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     /**
      * Determines if a given property key is conditional. Derived classes can override this
      * method to use a different format for conditional properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param key - The property key to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and a
      * {@link EditorRules.IConditionalJsonKeyResult | IConditionalJsonKeyResult} describing the

package/lib/packlets/editor/rules/multivalue.d.ts

@@ -81,7 +81,7 @@ export declare class MultiValueJsonEditorRule extends JsonEditorRuleBase {
     /**
      * Determines if a given property key is multi-value. Derived classes can override this
      * method to use a different format for multi-value properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param token - The property key token to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and an
      * {@link EditorRules.IMultiValuePropertyParts | IMultiValuePropertyParts}

package/lib/packlets/editor/rules/multivalue.js

@@ -102,7 +102,7 @@ class MultiValueJsonEditorRule extends jsonEditorRule_1.JsonEditorRuleBase {
     /**
      * Determines if a given property key is multi-value. Derived classes can override this
      * method to use a different format for multi-value properties.
-     * @param value - The `JsonValue` of the property to be considered.
+     * @param token - The property key token to be considered.
      * @param state - The {@link JsonEditorState | editor state} for the object being edited.
      * @returns `Success` with detail `'deferred'` and an
      * {@link EditorRules.IMultiValuePropertyParts | IMultiValuePropertyParts}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-json",
-  "version": "5.1.0-16",
+  "version": "5.1.0-17",
   "description": "Typescript utilities for working with JSON",
   "main": "lib/index.js",
   "types": "dist/ts-json.d.ts",
@@ -43,16 +43,16 @@
     "@rushstack/heft-jest-plugin": "1.2.6",
     "@microsoft/api-extractor": "^7.55.2",
     "typedoc": "~0.28.16",
-    "@fgv/heft-dual-rig": "5.1.0-16",
-    "@fgv/ts-utils": "5.1.0-16",
-    "@fgv/ts-utils-jest": "5.1.0-16",
-    "@fgv/typedoc-compact-theme": "5.1.0-16",
-    "@fgv/ts-json-base": "5.1.0-16"
+    "@fgv/heft-dual-rig": "5.1.0-17",
+    "@fgv/typedoc-compact-theme": "5.1.0-17",
+    "@fgv/ts-utils": "5.1.0-17",
+    "@fgv/ts-json-base": "5.1.0-17",
+    "@fgv/ts-utils-jest": "5.1.0-17"
   },
   "peerDependencies": {
     "mustache": "^4.2.0",
-    "@fgv/ts-utils": "5.1.0-16",
-    "@fgv/ts-json-base": "5.1.0-16"
+    "@fgv/ts-utils": "5.1.0-17",
+    "@fgv/ts-json-base": "5.1.0-17"
   },
   "exports": {
     ".": {