@fluid-experimental/property-properties 0.59.2000-61729 → 0.59.2000-63294

package/lib/propertyTemplateWrapper.d.ts

@@ -0,0 +1,74 @@
+export class PropertyTemplateWrapper {
+    /**
+     * Constructor for creating a PropertyTemplateWrapper based on the given template.
+     * @param {PropertyTemplate} in_remoteTemplate A property template
+     * @param {string} in_scope The scope of the template
+     *
+     * @constructor
+     * @package
+     * @alias property-properties.PropertyTemplateWrapper
+     * @category Properties
+     */
+    constructor(in_remoteTemplate: any, in_scope: string);
+    /** The property template this object is wrapping */
+    _propertyTemplate: any;
+    /** A property template created from this.propertyTemplate with the addition of all information
+     *  from templates this template inherits from.
+     */
+    _compiledPropertyTemplate: any;
+    _objectCreationType: string;
+    _scope: string;
+    /**
+     * To get the property template that this is wrapping.
+     * @return {property-properties.PropertyTemplate} The template this wrapper contains
+     * @package
+     */
+    getPropertyTemplate(): any;
+    /**
+     * Gets the compiled template or creates it then returns it.
+     * @param {property-properties.PropertyFactory} in_propertyFactory The assosiated PropertyFactory.
+     * @return {property-properties.PropertyTemplate} The compiled template
+     * A compiled template is the template which is actually used for creating objects.
+     * It has all information from parent Templates, and other changes.
+     * @package
+     */
+    getCompiledTemplate(in_propertyFactory: any): any;
+    /**
+     * Returns if the compiled template has been created.
+     * @return {boolean} if the compiled template has been created
+     * @package
+     */
+    hasCompiledTemplate(): boolean;
+    /**
+     * To get the creation type of the template this wraps.
+     * @return {string} A typeid which represents the creation type of this template
+     * @package
+     */
+    getCreationType(): string;
+    /**
+     * If current creation type is undefined, sets it to in_typeid if in_typeid is a creation type.
+     * If current creation type is defined, throws if in_typeid is a creation type.
+     *
+     * @param {string} in_typeid A typeid
+     * @package
+     */
+    setCreationType(in_typeid: string): void;
+    /**
+     * Contructs the compiled template from the template this wraps
+     * @param {property-properties.PropertyFactory} in_propertyFactory The associated PropertyFactory.
+     * @return {property-properties.PropertyTemplate} The compiled template
+     * A compiled template is the template which is actually used for creating objects.
+     * It has all information from parent Templates, and other changes.
+     * @package
+     */
+    _contructCompiledTemplate(in_propertyFactory: any): any;
+    /**
+     * A helper function which merges a child and parent property.
+     * The changes are applied directly to the in_childProperty.
+     * @param {object} in_childProperty The child's property defition.
+     * @param {object} in_parentProperty The parent's property defition.
+     * @package
+     */
+    _mergeProperty(in_childProperty: object, in_parentProperty: object): void;
+}
+//# sourceMappingURL=propertyTemplateWrapper.d.ts.map

package/lib/propertyTemplateWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyTemplateWrapper.d.ts","sourceRoot":"","sources":["../src/propertyTemplateWrapper.js"],"names":[],"mappings":"AA6BA;IACI;;;;;;;;;OASG;IACH,8CAPW,MAAM,EAqBhB;IAbG,oDAAoD;IACpD,uBAA0C;IAE1C;;OAEG;IACH,+BAA0C;IAG1C,4BAAoC;IAGpC,eAAsB;IAG1B;;;;OAIG;IACH,2BAEC;IAED;;;;;;;OAOG;IACH,kDAKC;IAED;;;;OAIG;IACH,uBAHY,OAAO,CAKlB;IAED;;;;OAIG;IACH,mBAHY,MAAM,CAKjB;IAED;;;;;;OAMG;IACH,2BAHW,MAAM,QAmBhB;IAED;;;;;;;OAOG;IACH,wDAuHC;IAED;;;;;;OAMG;IACH,iCAJW,MAAM,qBACN,MAAM,QAqEhB;CACJ"}

package/lib/propertyUtils.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export class PropertyUtils {
+    /**
+     * Gather all properties that pass an arbitrary predicate function
+     * @param {property-properties.NodeProperty} in_rootProperty The root property to traverse from
+     * @param {function} in_predicate The predicate function
+     * @return {Array.<property-properties.BaseProperty>} The list of properties that passed the predicate
+     * function
+     */
+    static gatherProperties: (in_rootProperty: any, in_predicate: Function) => Array<any>;
+}
+//# sourceMappingURL=propertyUtils.d.ts.map

package/lib/propertyUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyUtils.d.ts","sourceRoot":"","sources":["../src/propertyUtils.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;IACI;;;;;;OAMG;IACH,2EAHY,UAAe,CAYzB;CACL"}

package/lib/propertyUtils.js

@@ -8,7 +8,7 @@ export class PropertyUtils {
  * Gather all properties that pass an arbitrary predicate function
  * @param {property-properties.NodeProperty} in_rootProperty The root property to traverse from
  * @param {function} in_predicate The predicate function
- * @return {Array.<property-properties.BasePropertyy>} The list of properties that passed the predicate
+ * @return {Array.<property-properties.BaseProperty>} The list of properties that passed the predicate
  * function
  */
 PropertyUtils.gatherProperties = function (in_rootProperty, in_predicate) {

package/lib/propertyUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"propertyUtils.js","sourceRoot":"","sources":["../src/propertyUtils.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,OAAO,aAAa;;AACtB;;;;;;GAMG;AACI,8BAAgB,GAAG,UAAS,eAAe,EAAE,YAAY;IAC5D,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,eAAe,CAAC,YAAY,CAAC,UAAS,QAAQ,EAAE,IAAI;QAChD,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;YACxB,kBAAkB,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACvC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport class PropertyUtils {\n    /**\n     * Gather all properties that pass an arbitrary predicate function\n     * @param {property-properties.NodeProperty} in_rootProperty The root property to traverse from\n     * @param {function} in_predicate The predicate function\n     * @return {Array.<property-properties.BasePropertyy>} The list of properties that passed the predicate\n     * function\n     */\n    static gatherProperties = function(in_rootProperty, in_predicate) {\n        var gatheredProperties = {};\n        in_rootProperty.traverseDown(function(property, path) {\n            if (in_predicate(property)) {\n                gatheredProperties[path] = property;\n            }\n        });\n\n        return gatheredProperties;\n    };\n}\n"]}
+{"version":3,"file":"propertyUtils.js","sourceRoot":"","sources":["../src/propertyUtils.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,OAAO,aAAa;;AACtB;;;;;;GAMG;AACI,8BAAgB,GAAG,UAAS,eAAe,EAAE,YAAY;IAC5D,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,eAAe,CAAC,YAAY,CAAC,UAAS,QAAQ,EAAE,IAAI;QAChD,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;YACxB,kBAAkB,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;SACvC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC9B,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport class PropertyUtils {\n    /**\n     * Gather all properties that pass an arbitrary predicate function\n     * @param {property-properties.NodeProperty} in_rootProperty The root property to traverse from\n     * @param {function} in_predicate The predicate function\n     * @return {Array.<property-properties.BaseProperty>} The list of properties that passed the predicate\n     * function\n     */\n    static gatherProperties = function(in_rootProperty, in_predicate) {\n        var gatheredProperties = {};\n        in_rootProperty.traverseDown(function(property, path) {\n            if (in_predicate(property)) {\n                gatheredProperties[path] = property;\n            }\n        });\n\n        return gatheredProperties;\n    };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/property-properties",
-  "version": "0.59.2000-61729",
+  "version": "0.59.2000-63294",
   "description": "definitions of properties",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -61,8 +61,8 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-experimental/property-changeset": "0.59.2000-61729",
-    "@fluid-experimental/property-common": "0.59.2000-61729",
+    "@fluid-experimental/property-changeset": "0.59.2000-63294",
+    "@fluid-experimental/property-common": "0.59.2000-63294",
     "ajv": "7.1.1",
     "async": "^3.2.0",
     "fastest-json-copy": "^1.0.1",
@@ -73,7 +73,7 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "0.59.2000-61729",
+    "@fluidframework/mocha-test-setup": "0.59.2000-63294",
     "@types/mocha": "^8.2.2",
     "chai": "^4.2.0",
     "concurrently": "^6.2.0",
@@ -82,8 +82,11 @@
     "eslint-plugin-editorconfig": "~3.2.0",
     "eslint-plugin-eslint-comments": "~3.2.0",
     "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-no-null": "~1.0.2",
+    "eslint-plugin-jest": "~26.1.3",
+    "eslint-plugin-mocha": "~10.0.3",
+    "eslint-plugin-promise": "~6.0.0",
     "eslint-plugin-react": "~7.28.0",
+    "eslint-plugin-tsdoc": "~0.2.14",
     "eslint-plugin-unicorn": "~40.0.0",
     "mocha": "^8.4.0",
     "nock": "^10.0.1",

package/src/index.d.ts

@@ -2244,7 +2244,7 @@ declare module "@fluid-experimental/property-properties" {
             /**
              * Returns the full property type identifier for the ChangeSet including the enum type id
              * @param  in_hideCollection  if true the collection type (if applicable) will be omitted
-             *                since that is not aplicable here, this param is ignored. Default to false
+             *                since that is not applicable here, this param is ignored. Default to false
              * @return The typeid
              */
             getFullTypeid(in_hideCollection?: boolean): string;
@@ -2267,7 +2267,7 @@ declare module "@fluid-experimental/property-properties" {
              */
             getParent(): BaseProperty | undefined;
             /**
-             * checks whether the property is dynamic (only properties inherting from NodeProperty are)
+             * checks whether the property is dynamic (only properties inheriting from NodeProperty are)
              */
             isDynamic(): boolean;
             /**
@@ -2547,7 +2547,7 @@ declare module "@fluid-experimental/property-properties" {
             /**
              * Returns the full property type identifier for the ChangeSet including the enum type id
              * @param  in_hideCollection - if true the collection type (if applicable) will be omitted
-             *                since that is not aplicable here, this param is ignored. Default to false
+             *                since that is not applicable here, this param is ignored. Default to false
              * @return The typeid
              */
             getFullTypeid(in_hideCollection: boolean): string;