@fluid-experimental/property-changeset 1.2.3-83900 → 2.0.0-internal.1.0.0

package/dist/validationResultBuilder.d.ts

@@ -19,22 +19,22 @@ export declare class ValidationResultBuilder {
     private readonly _result;
     /**
      * Instantiates a ValidationResultBuilder
-     * @param in_typeid A template typeid.
+     * @param in_typeid - A template typeid.
      */
     constructor(in_typeid: string);
     /**
      * Add a validation error.
-     * @param {Error} in_error An Error instance.
+     * @param {Error} in_error - An Error instance.
      */
     get result(): SchemaValidationResult;
     /**
      * Add a validation error.
-     * @param in_error An Error instance.
+     * @param in_error - An Error instance.
      */
     addError(in_error: Error): void;
     /**
      * Add a validation warning.
-     * @param in_msg A warning description.
+     * @param in_msg - A warning description.
      */
     addWarning(in_msg: string): void;
     /**

package/dist/validationResultBuilder.js

@@ -13,7 +13,7 @@ exports.ValidationResultBuilder = void 0;
 class ValidationResultBuilder {
     /**
      * Instantiates a ValidationResultBuilder
-     * @param in_typeid A template typeid.
+     * @param in_typeid - A template typeid.
      */
     constructor(in_typeid) {
         this._result = {
@@ -29,14 +29,14 @@ class ValidationResultBuilder {
     }
     /**
      * Add a validation error.
-     * @param {Error} in_error An Error instance.
+     * @param {Error} in_error - An Error instance.
      */
     get result() {
         return this._result;
     }
     /**
      * Add a validation error.
-     * @param in_error An Error instance.
+     * @param in_error - An Error instance.
      */
     addError(in_error) {
         this._result.isValid = false;
@@ -47,7 +47,7 @@ class ValidationResultBuilder {
     }
     /**
      * Add a validation warning.
-     * @param in_msg A warning description.
+     * @param in_msg - A warning description.
      */
     addWarning(in_msg) {
         this._result.warnings.push(in_msg);

package/dist/validationResultBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationResultBuilder.js","sourceRoot":"","sources":["../src/validationResultBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH;;;;GAIG;;;AAWH,MAAa,uBAAuB;IAGhC;;;OAGG;IACH,YAAY,SAAiB;QACzB,IAAI,CAAC,OAAO,GAAG;YACX,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;SACtB,CAAC;QAEF,IAAI,SAAS,EAAE;YACX,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;SACnC;IACL,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,QAAe;QAC3B,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;QAC7B,8CAA8C;QAC9C,IAAI,QAAQ,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,MAAc;QAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,OAAO;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;CACJ;AAzDD,0DAyDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/**\n * @fileoverview\n * The ValidationResultBuilder maintains validation context that ultimately gets returned as a\n * single result.\n */\n\n export declare interface SchemaValidationResult {\n    isValid: boolean;\n    errors: Error[];\n    warnings: string[];\n    resolvedTypes: string[];\n    unresolvedTypes: string[];\n    typeid?: string;\n}\n\nexport class ValidationResultBuilder {\n    private readonly _result: SchemaValidationResult;\n\n    /**\n     * Instantiates a ValidationResultBuilder\n     * @param in_typeid A template typeid.\n     */\n    constructor(in_typeid: string) {\n        this._result = {\n            isValid: true,\n            errors: [],\n            warnings: [],\n            resolvedTypes: [],\n            unresolvedTypes: [],\n        };\n\n        if (in_typeid) {\n            this._result.typeid = in_typeid;\n        }\n    }\n\n    /**\n     * Add a validation error.\n     * @param {Error} in_error An Error instance.\n     */\n    public get result() {\n        return this._result;\n    }\n\n    /**\n     * Add a validation error.\n     * @param in_error An Error instance.\n     */\n    public addError(in_error: Error) {\n        this._result.isValid = false;\n        // remove empty error messages before logging.\n        if (in_error.message) {\n            this._result.errors.push(in_error);\n        }\n    }\n\n    /**\n     * Add a validation warning.\n     * @param in_msg A warning description.\n     */\n    public addWarning(in_msg: string) {\n        this._result.warnings.push(in_msg);\n    }\n\n    /**\n     * Fetches the boolean validation result.\n     * @return True if validation produced no error, false otherwise. Warnings don't affect\n     *   this value.\n     */\n    public isValid(): boolean {\n        return this._result.isValid;\n    }\n}\n"]}
+{"version":3,"file":"validationResultBuilder.js","sourceRoot":"","sources":["../src/validationResultBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH;;;;GAIG;;;AAWH,MAAa,uBAAuB;IAGhC;;;OAGG;IACH,YAAY,SAAiB;QACzB,IAAI,CAAC,OAAO,GAAG;YACX,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;SACtB,CAAC;QAEF,IAAI,SAAS,EAAE;YACX,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;SACnC;IACL,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,QAAe;QAC3B,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;QAC7B,8CAA8C;QAC9C,IAAI,QAAQ,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,MAAc;QAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,OAAO;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;CACJ;AAzDD,0DAyDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/**\n * @fileoverview\n * The ValidationResultBuilder maintains validation context that ultimately gets returned as a\n * single result.\n */\n\n export declare interface SchemaValidationResult {\n    isValid: boolean;\n    errors: Error[];\n    warnings: string[];\n    resolvedTypes: string[];\n    unresolvedTypes: string[];\n    typeid?: string;\n}\n\nexport class ValidationResultBuilder {\n    private readonly _result: SchemaValidationResult;\n\n    /**\n     * Instantiates a ValidationResultBuilder\n     * @param in_typeid - A template typeid.\n     */\n    constructor(in_typeid: string) {\n        this._result = {\n            isValid: true,\n            errors: [],\n            warnings: [],\n            resolvedTypes: [],\n            unresolvedTypes: [],\n        };\n\n        if (in_typeid) {\n            this._result.typeid = in_typeid;\n        }\n    }\n\n    /**\n     * Add a validation error.\n     * @param {Error} in_error - An Error instance.\n     */\n    public get result() {\n        return this._result;\n    }\n\n    /**\n     * Add a validation error.\n     * @param in_error - An Error instance.\n     */\n    public addError(in_error: Error) {\n        this._result.isValid = false;\n        // remove empty error messages before logging.\n        if (in_error.message) {\n            this._result.errors.push(in_error);\n        }\n    }\n\n    /**\n     * Add a validation warning.\n     * @param in_msg - A warning description.\n     */\n    public addWarning(in_msg: string) {\n        this._result.warnings.push(in_msg);\n    }\n\n    /**\n     * Fetches the boolean validation result.\n     * @return True if validation produced no error, false otherwise. Warnings don't affect\n     *   this value.\n     */\n    public isValid(): boolean {\n        return this._result.isValid;\n    }\n}\n"]}

package/lib/changeset.js

@@ -118,12 +118,12 @@ export class ChangeSet {
     /**
      * Applies a changeset to a given property (recursively). The ChangeSet is assumed to be relative to the same
      * property root and it will be applied behind the base ChangeSet (assuming that the changes are relative to the
-     * state after the base ChangeSet has been applied. It will change the base ChangeSet.)
+     * state after the base ChangeSet has been applied. It will change the base ChangeSet).
      *
-     * @param io_basePropertyChanges    - The ChangeSet describing the initial state
-     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param io_basePropertyChanges - The ChangeSet describing the initial state.
+     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     _performApplyAfterOnProperty(io_basePropertyChanges, in_appliedPropertyChanges, in_removeEmpty, in_options) {
         // Apply dynamic property operations
@@ -187,14 +187,14 @@ export class ChangeSet {
     /**
      * Decides based on the given Typeid which applyAfter operation to perform.
      * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * since it needs to be able to overwrite this entry
      *
-     * @param in_changedKey             - The key of the entry in the object
-     * @param in_baseChanges            - The object containing the state before the applyAfter
-     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification
-     * @param in_typeid                 - The typeid of the property to modify
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param in_changedKey - The key of the entry in the object.
+     * @param in_baseChanges - The object containing the state before the applyAfter.
+     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification.
+     * @param in_typeid - The typeid of the property to modify.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     performApplyAfterOnPropertyWithTypeid(in_changedKey, in_baseChanges, in_appliedPropertyChanges, in_typeid, in_removeEmpty, in_options) {
         const splitTypeid = extractContext(in_typeid);
@@ -318,12 +318,11 @@ export class ChangeSet {
      * this class and transforms it in such a way that it can be applied after this ChangeSet. The function will modify
      * the supplied ChangeSet
      *
-     * @param io_changeSet   -
-     *     The ChangeSet that is rebased behind the state obtained by application of this ChangeSet
-     * @param out_conflicts A list of paths that resulted in conflicts together with the type of the conflict
-     * @param in_options - Optional additional parameters
+     * @param io_changeSet - The ChangeSet that is rebased behind the state obtained by application of this ChangeSet.
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
+     * @param in_options - Optional additional parameters.
      * @returns The rebased ChangeSet (the same object as io_changeSet, it will be
-     *     modified in place)
+     * modified in place).
      */
     _rebaseChangeSet(io_changeSet, out_conflicts, in_options) {
         // We actually only pass this request to the recursive internal function
@@ -332,14 +331,10 @@ export class ChangeSet {
     /**
      * Internal helper function that performs a rebase on a single property
      *
-     * @param in_ownPropertyChangeSet -
-     *     The ChangeSet for the property stored in this class
-     * @param io_rebasePropertyChangeSet -
-     *     The ChangeSet for the property to be rebased
-     * @param in_basePath -
-     *     Base path to get to the property processed by this function
-     * @param out_conflicts -
-     *     A list of paths that resulted in conflicts together with the type of the conflict
+     * @param in_ownPropertyChangeSet - The ChangeSet for the property stored in this class
+     * @param io_rebasePropertyChangeSet - The ChangeSet for the property to be rebased
+     * @param in_basePath - Base path to get to the property processed by this function
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict
      * @param in_options - Optional additional parameters
      * @returns The rebased ChangeSet for this property
      */
@@ -471,23 +466,22 @@ export class ChangeSet {
         return io_rebasePropertyChangeSet;
     }
     /**
-     * Decides based on the given Typeid which rebase operation to perform
-     * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * Decides based on the given Typeid which rebase operation to perform.
+     *
+     * @remarks Note: This function is not directly called on the ChangeSet but on the object containing it together
+     * with a key since it needs to be able to overwrite this entry
      *
-     * @param in_key                          - The key of the entry in the object
-     * @param in_ownPropertyChangeSet         - The object containing the ChangeSet for the property
-     *                                                   stored in this class
-     * @param io_rebasePropertyChangeSet      - The object containing the ChangeSet for the property to
-     *                                                   be rebased
-     * @param in_typeid                       - The typeid of the property to rebase
-     * @param in_basePath                     - Base path to get to the property processed by this function
-     * @param in_removeEmpty                 - Should empty ChangeSets be removed?
-     * @param out_conflicts - A list of paths that resulted in
-     *                                                   conflicts together with the type of the conflict
+     * @param in_key - The key of the entry in the object
+     * @param in_ownPropertyChangeSet - The object containing the ChangeSet for the property stored in this class.
+     * @param io_rebasePropertyChangeSet - The object containing the ChangeSet for the property to be rebased.
+     * @param in_typeid - The typeid of the property to rebase.
+     * @param in_basePath - Base path to get to the property processed by this function.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
      *
      * @returns Has there been a simple set collision? Those have to be handled separately
-     *                   TODO: We should unify the handling of set collisions
+     *
+     * @privateRemarks TODO: We should unify the handling of set collisions
      * @private
      */
     rebaseChangeSetForPropertyEntryWithTypeid(in_key, in_ownPropertyChangeSet, io_rebasePropertyChangeSet, in_typeid, in_basePath, in_removeEmpty, out_conflicts, in_options) {
@@ -536,10 +530,10 @@ export class ChangeSet {
         return false;
     }
     /**
-     * recursive helper function for ChangeSet.prototype._toReversibleChangeSet
+     * Recursive helper function for ChangeSet.prototype._toReversibleChangeSet
      * which converts a irreversible changeset to a reversible changeset
      * or updates the former state of a reversible changeset
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     _recursivelyBuildReversibleChangeSet(in_context) {
         const opType = in_context.getOperationType();
@@ -738,7 +732,7 @@ export class ChangeSet {
      * WARNING: This function is still experimental and needs more testing
      * and it's set to private for now. It will be converted to a public API function
      * in a later release.
-     * @param in_oldSerializedState the old state
+     * @param in_oldSerializedState - The old state.
      */
     _toReversibleChangeSet(in_oldSerializedState) {
         ConsoleUtils.assert(in_oldSerializedState !== undefined, `${MSG.ASSERTION_FAILED}Missing function parameter "in_oldSerializedState" of "_toReversibleChangeSet".`);
@@ -884,8 +878,8 @@ export class ChangeSet {
     }
     /**
      * Helper function to extract the first level paths from a given change set
-     * @param in_changeSet The ChangeSet to extract paths from
-     * @param isPrimitiveCollection Is this a primitive type collection?
+     * @param in_changeSet - The ChangeSet to extract paths from.
+     * @param isPrimitiveCollection - Is this a primitive type collection?
      *
      * @returns List of paths found at the first level of the change set
      */
@@ -906,7 +900,7 @@ export class ChangeSet {
     }
     /**
      * recursive helper function for ChangeSet.prototype._toInverseChangeSet
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     _recursivelyInvertReversibleChangeset(in_context) {
         in_context.setUserData(in_context.getUserData() || {});