@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/domains/index.js

@@ -0,0 +1,23 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.leaf = exports.nodeKeyTreeSchema = exports.nodeKeySchema = exports.nodeKeyField = exports.singleJsonCursor = exports.jsonSchema = exports.jsonRoot = exports.jsonObject = exports.jsonArray = exports.cursorToJsonObject = exports.SchemaBuilder = void 0;
+var schemaBuilder_1 = require("./schemaBuilder");
+Object.defineProperty(exports, "SchemaBuilder", { enumerable: true, get: function () { return schemaBuilder_1.SchemaBuilder; } });
+var json_1 = require("./json");
+Object.defineProperty(exports, "cursorToJsonObject", { enumerable: true, get: function () { return json_1.cursorToJsonObject; } });
+Object.defineProperty(exports, "jsonArray", { enumerable: true, get: function () { return json_1.jsonArray; } });
+Object.defineProperty(exports, "jsonObject", { enumerable: true, get: function () { return json_1.jsonObject; } });
+Object.defineProperty(exports, "jsonRoot", { enumerable: true, get: function () { return json_1.jsonRoot; } });
+Object.defineProperty(exports, "jsonSchema", { enumerable: true, get: function () { return json_1.jsonSchema; } });
+Object.defineProperty(exports, "singleJsonCursor", { enumerable: true, get: function () { return json_1.singleJsonCursor; } });
+var nodeKey_1 = require("./nodeKey");
+Object.defineProperty(exports, "nodeKeyField", { enumerable: true, get: function () { return nodeKey_1.nodeKeyField; } });
+Object.defineProperty(exports, "nodeKeySchema", { enumerable: true, get: function () { return nodeKey_1.nodeKeySchema; } });
+Object.defineProperty(exports, "nodeKeyTreeSchema", { enumerable: true, get: function () { return nodeKey_1.nodeKeyTreeSchema; } });
+var leafDomain_1 = require("./leafDomain");
+Object.defineProperty(exports, "leaf", { enumerable: true, get: function () { return leafDomain_1.leaf; } });
+//# sourceMappingURL=index.js.map

package/dist/domains/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/domains/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+BAOgB;AANf,0GAAA,kBAAkB,OAAA;AAClB,iGAAA,SAAS,OAAA;AACT,kGAAA,UAAU,OAAA;AACV,gGAAA,QAAQ,OAAA;AACR,kGAAA,UAAU,OAAA;AACV,wGAAA,gBAAgB,OAAA;AAGjB,qCAA2E;AAAlE,uGAAA,YAAY,OAAA;AAAE,wGAAA,aAAa,OAAA;AAAE,4GAAA,iBAAiB,OAAA;AAEvD,2CAAoC;AAA3B,kGAAA,IAAI,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { SchemaBuilder } from \"./schemaBuilder\";\nexport {\n\tcursorToJsonObject,\n\tjsonArray,\n\tjsonObject,\n\tjsonRoot,\n\tjsonSchema,\n\tsingleJsonCursor,\n} from \"./json\";\n\nexport { nodeKeyField, nodeKeySchema, nodeKeyTreeSchema } from \"./nodeKey\";\n\nexport { leaf } from \"./leafDomain\";\n"]}

package/dist/domains/json/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { singleJsonCursor, cursorToJsonObject } from "./jsonCursor";
+export { jsonSchema, jsonObject, jsonArray, jsonRoot } from "./jsonDomainSchema";
+//# sourceMappingURL=index.d.ts.map

package/dist/domains/json/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/domains/json/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/domains/json/index.js

@@ -0,0 +1,16 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonRoot = exports.jsonArray = exports.jsonObject = exports.jsonSchema = exports.cursorToJsonObject = exports.singleJsonCursor = void 0;
+var jsonCursor_1 = require("./jsonCursor");
+Object.defineProperty(exports, "singleJsonCursor", { enumerable: true, get: function () { return jsonCursor_1.singleJsonCursor; } });
+Object.defineProperty(exports, "cursorToJsonObject", { enumerable: true, get: function () { return jsonCursor_1.cursorToJsonObject; } });
+var jsonDomainSchema_1 = require("./jsonDomainSchema");
+Object.defineProperty(exports, "jsonSchema", { enumerable: true, get: function () { return jsonDomainSchema_1.jsonSchema; } });
+Object.defineProperty(exports, "jsonObject", { enumerable: true, get: function () { return jsonDomainSchema_1.jsonObject; } });
+Object.defineProperty(exports, "jsonArray", { enumerable: true, get: function () { return jsonDomainSchema_1.jsonArray; } });
+Object.defineProperty(exports, "jsonRoot", { enumerable: true, get: function () { return jsonDomainSchema_1.jsonRoot; } });
+//# sourceMappingURL=index.js.map

package/dist/domains/json/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/domains/json/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAAoE;AAA3D,8GAAA,gBAAgB,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AAC7C,uDAAiF;AAAxE,8GAAA,UAAU,OAAA;AAAE,8GAAA,UAAU,OAAA;AAAE,6GAAA,SAAS,OAAA;AAAE,4GAAA,QAAQ,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { singleJsonCursor, cursorToJsonObject } from \"./jsonCursor\";\nexport { jsonSchema, jsonObject, jsonArray, jsonRoot } from \"./jsonDomainSchema\";\n"]}

package/dist/domains/json/jsonCursor.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITreeCursor, ITreeCursorSynchronous } from "../../core";
+import { JsonCompatible } from "../../util";
+/**
+ * Used to read a Jsonable tree for testing and benchmarking.
+ *
+ * @returns an {@link ITreeCursorSynchronous} for a single {@link JsonCompatible}.
+ */
+export declare function singleJsonCursor(root: JsonCompatible): ITreeCursorSynchronous;
+/**
+ * Extract a JS object tree from the contents of the given ITreeCursor.
+ * Assumes that ITreeCursor contains only unaugmented JsonTypes.
+ */
+export declare function cursorToJsonObject(reader: ITreeCursor): JsonCompatible;
+//# sourceMappingURL=jsonCursor.d.ts.map

package/dist/domains/json/jsonCursor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonCursor.d.ts","sourceRoot":"","sources":["../../../src/domains/json/jsonCursor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,WAAW,EAKX,sBAAsB,EACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAwE5C;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB,CAE7E;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,cAAc,CAqCtE"}

package/dist/domains/json/jsonCursor.js

@@ -0,0 +1,125 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cursorToJsonObject = exports.singleJsonCursor = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../../core");
+const feature_libraries_1 = require("../../feature-libraries");
+const leafDomain_1 = require("../leafDomain");
+const jsonDomainSchema_1 = require("./jsonDomainSchema");
+const adapter = {
+    value: (node) => node !== null && typeof node === "object"
+        ? undefined // arrays and objects have no defined value
+        : node,
+    type: (node) => {
+        const type = typeof node;
+        switch (type) {
+            case "number":
+                return leafDomain_1.leaf.number.name;
+            case "string":
+                return leafDomain_1.leaf.string.name;
+            case "boolean":
+                return leafDomain_1.leaf.boolean.name;
+            default:
+                if (node === null) {
+                    return leafDomain_1.leaf.null.name;
+                }
+                else if (Array.isArray(node)) {
+                    return jsonDomainSchema_1.jsonArray.name;
+                }
+                else {
+                    return jsonDomainSchema_1.jsonObject.name;
+                }
+        }
+    },
+    keysFromNode: (node) => {
+        switch (typeof node) {
+            case "object":
+                if (node === null) {
+                    return [];
+                }
+                else if (Array.isArray(node)) {
+                    return node.length === 0 ? [] : [core_1.EmptyKey];
+                }
+                else {
+                    return Object.keys(node);
+                }
+            default:
+                return [];
+        }
+    },
+    getFieldFromNode: (node, key) => {
+        // Object.prototype.hasOwnProperty can return true for strings (ex: with key "0"), so we have to filter them out.
+        // Rather than just special casing strings, we can handle them with an early return for all primitives.
+        if (typeof node !== "object") {
+            return [];
+        }
+        if (node === null) {
+            return [];
+        }
+        if (Array.isArray(node)) {
+            return key === core_1.EmptyKey ? node : [];
+        }
+        if (Object.prototype.hasOwnProperty.call(node, key)) {
+            const field = node[key];
+            (0, core_utils_1.assert)(field !== undefined, 0x41e /* explicit undefined fields should not be preserved in JSON */);
+            return [field];
+        }
+        return [];
+    },
+};
+/**
+ * Used to read a Jsonable tree for testing and benchmarking.
+ *
+ * @returns an {@link ITreeCursorSynchronous} for a single {@link JsonCompatible}.
+ */
+function singleJsonCursor(root) {
+    return (0, feature_libraries_1.stackTreeNodeCursor)(adapter, root);
+}
+exports.singleJsonCursor = singleJsonCursor;
+/**
+ * Extract a JS object tree from the contents of the given ITreeCursor.
+ * Assumes that ITreeCursor contains only unaugmented JsonTypes.
+ */
+function cursorToJsonObject(reader) {
+    const type = reader.type;
+    switch (type) {
+        case leafDomain_1.leaf.number.name:
+        case leafDomain_1.leaf.boolean.name:
+        case leafDomain_1.leaf.string.name:
+            (0, core_utils_1.assert)(reader.value !== undefined, 0x84f /* out of schema: missing value */);
+            (0, core_utils_1.assert)(!(0, feature_libraries_1.isFluidHandle)(reader.value), 0x850 /* out of schema: unexpected FluidHandle */);
+            return reader.value;
+        case jsonDomainSchema_1.jsonArray.name: {
+            reader.enterField(core_1.EmptyKey);
+            const result = (0, core_1.mapCursorField)(reader, cursorToJsonObject);
+            reader.exitField();
+            return result;
+        }
+        case jsonDomainSchema_1.jsonObject.name: {
+            const result = {};
+            (0, core_1.mapCursorFields)(reader, (cursor) => {
+                const key = cursor.getFieldKey();
+                (0, core_utils_1.assert)(cursor.firstNode(), 0x420 /* expected non-empty field */);
+                // like `result[key] = cursorToJsonObject(reader);` except safe when keyString == "__proto__".
+                Object.defineProperty(result, key, {
+                    enumerable: true,
+                    configurable: true,
+                    writable: true,
+                    value: cursorToJsonObject(reader),
+                });
+                (0, core_utils_1.assert)(!cursor.nextNode(), 0x421 /* expected exactly one node */);
+            });
+            return result;
+        }
+        default: {
+            (0, core_utils_1.assert)(type === leafDomain_1.leaf.null.name, 0x422 /* unexpected type */);
+            return null;
+        }
+    }
+}
+exports.cursorToJsonObject = cursorToJsonObject;
+//# sourceMappingURL=jsonCursor.js.map

package/dist/domains/json/jsonCursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonCursor.js","sourceRoot":"","sources":["../../../src/domains/json/jsonCursor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,qCAOoB;AAEpB,+DAA4F;AAC5F,8CAAqC;AACrC,yDAA2D;AAE3D,MAAM,OAAO,GAAkC;IAC9C,KAAK,EAAE,CAAC,IAAoB,EAAE,EAAE,CAC/B,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QACxC,CAAC,CAAC,SAAS,CAAC,2CAA2C;QACvD,CAAC,CAAC,IAAI;IACR,IAAI,EAAE,CAAC,IAAoB,EAAE,EAAE;QAC9B,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC;QAEzB,QAAQ,IAAI,EAAE;YACb,KAAK,QAAQ;gBACZ,OAAO,iBAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACzB,KAAK,QAAQ;gBACZ,OAAO,iBAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACzB,KAAK,SAAS;gBACb,OAAO,iBAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAC1B;gBACC,IAAI,IAAI,KAAK,IAAI,EAAE;oBAClB,OAAO,iBAAI,CAAC,IAAI,CAAC,IAAI,CAAC;iBACtB;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAC/B,OAAO,4BAAS,CAAC,IAAI,CAAC;iBACtB;qBAAM;oBACN,OAAO,6BAAU,CAAC,IAAI,CAAC;iBACvB;SACF;IACF,CAAC;IACD,YAAY,EAAE,CAAC,IAAoB,EAAuB,EAAE;QAC3D,QAAQ,OAAO,IAAI,EAAE;YACpB,KAAK,QAAQ;gBACZ,IAAI,IAAI,KAAK,IAAI,EAAE;oBAClB,OAAO,EAAE,CAAC;iBACV;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAC/B,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC,CAAC;iBAC3C;qBAAM;oBACN,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAe,CAAC;iBACvC;YACF;gBACC,OAAO,EAAE,CAAC;SACX;IACF,CAAC;IACD,gBAAgB,EAAE,CAAC,IAAoB,EAAE,GAAa,EAA6B,EAAE;QACpF,iHAAiH;QACjH,uGAAuG;QACvG,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC7B,OAAO,EAAE,CAAC;SACV;QAED,IAAI,IAAI,KAAK,IAAI,EAAE;YAClB,OAAO,EAAE,CAAC;SACV;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,OAAO,GAAG,KAAK,eAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;SACpC;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE;YACpD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,IAAA,mBAAM,EACL,KAAK,KAAK,SAAS,EACnB,KAAK,CAAC,+DAA+D,CACrE,CAAC;YACF,OAAO,CAAC,KAAK,CAAC,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACX,CAAC;CACD,CAAC;AAEF;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAoB;IACpD,OAAO,IAAA,uCAAmB,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC3C,CAAC;AAFD,4CAEC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAmB;IACrD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAEzB,QAAQ,IAAI,EAAE;QACb,KAAK,iBAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACtB,KAAK,iBAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvB,KAAK,iBAAI,CAAC,MAAM,CAAC,IAAI;YACpB,IAAA,mBAAM,EAAC,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAC7E,IAAA,mBAAM,EAAC,CAAC,IAAA,iCAAa,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACxF,OAAO,MAAM,CAAC,KAAK,CAAC;QACrB,KAAK,4BAAS,CAAC,IAAI,CAAC,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,eAAQ,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,IAAA,qBAAc,EAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;YAC1D,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,MAAM,CAAC;SACd;QACD,KAAK,6BAAU,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,MAAM,GAAmB,EAAE,CAAC;YAClC,IAAA,sBAAe,EAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;gBACjC,IAAA,mBAAM,EAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBACjE,8FAA8F;gBAC9F,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE;oBAClC,UAAU,EAAE,IAAI;oBAChB,YAAY,EAAE,IAAI;oBAClB,QAAQ,EAAE,IAAI;oBACd,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC;iBACjC,CAAC,CAAC;gBACH,IAAA,mBAAM,EAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;SACd;QACD,OAAO,CAAC,CAAC;YACR,IAAA,mBAAM,EAAC,IAAI,KAAK,iBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;SACZ;KACD;AACF,CAAC;AArCD,gDAqCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport {\n\tITreeCursor,\n\tEmptyKey,\n\tFieldKey,\n\tmapCursorField,\n\tmapCursorFields,\n\tITreeCursorSynchronous,\n} from \"../../core\";\nimport { JsonCompatible } from \"../../util\";\nimport { CursorAdapter, isFluidHandle, stackTreeNodeCursor } from \"../../feature-libraries\";\nimport { leaf } from \"../leafDomain\";\nimport { jsonArray, jsonObject } from \"./jsonDomainSchema\";\n\nconst adapter: CursorAdapter<JsonCompatible> = {\n\tvalue: (node: JsonCompatible) =>\n\t\tnode !== null && typeof node === \"object\"\n\t\t\t? undefined // arrays and objects have no defined value\n\t\t\t: node, // null, boolean, numbers, and strings are their own values\n\ttype: (node: JsonCompatible) => {\n\t\tconst type = typeof node;\n\n\t\tswitch (type) {\n\t\t\tcase \"number\":\n\t\t\t\treturn leaf.number.name;\n\t\t\tcase \"string\":\n\t\t\t\treturn leaf.string.name;\n\t\t\tcase \"boolean\":\n\t\t\t\treturn leaf.boolean.name;\n\t\t\tdefault:\n\t\t\t\tif (node === null) {\n\t\t\t\t\treturn leaf.null.name;\n\t\t\t\t} else if (Array.isArray(node)) {\n\t\t\t\t\treturn jsonArray.name;\n\t\t\t\t} else {\n\t\t\t\t\treturn jsonObject.name;\n\t\t\t\t}\n\t\t}\n\t},\n\tkeysFromNode: (node: JsonCompatible): readonly FieldKey[] => {\n\t\tswitch (typeof node) {\n\t\t\tcase \"object\":\n\t\t\t\tif (node === null) {\n\t\t\t\t\treturn [];\n\t\t\t\t} else if (Array.isArray(node)) {\n\t\t\t\t\treturn node.length === 0 ? [] : [EmptyKey];\n\t\t\t\t} else {\n\t\t\t\t\treturn Object.keys(node) as FieldKey[];\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\treturn [];\n\t\t}\n\t},\n\tgetFieldFromNode: (node: JsonCompatible, key: FieldKey): readonly JsonCompatible[] => {\n\t\t// Object.prototype.hasOwnProperty can return true for strings (ex: with key \"0\"), so we have to filter them out.\n\t\t// Rather than just special casing strings, we can handle them with an early return for all primitives.\n\t\tif (typeof node !== \"object\") {\n\t\t\treturn [];\n\t\t}\n\n\t\tif (node === null) {\n\t\t\treturn [];\n\t\t}\n\n\t\tif (Array.isArray(node)) {\n\t\t\treturn key === EmptyKey ? node : [];\n\t\t}\n\n\t\tif (Object.prototype.hasOwnProperty.call(node, key)) {\n\t\t\tconst field = node[key];\n\t\t\tassert(\n\t\t\t\tfield !== undefined,\n\t\t\t\t0x41e /* explicit undefined fields should not be preserved in JSON */,\n\t\t\t);\n\t\t\treturn [field];\n\t\t}\n\n\t\treturn [];\n\t},\n};\n\n/**\n * Used to read a Jsonable tree for testing and benchmarking.\n *\n * @returns an {@link ITreeCursorSynchronous} for a single {@link JsonCompatible}.\n */\nexport function singleJsonCursor(root: JsonCompatible): ITreeCursorSynchronous {\n\treturn stackTreeNodeCursor(adapter, root);\n}\n\n/**\n * Extract a JS object tree from the contents of the given ITreeCursor.\n * Assumes that ITreeCursor contains only unaugmented JsonTypes.\n */\nexport function cursorToJsonObject(reader: ITreeCursor): JsonCompatible {\n\tconst type = reader.type;\n\n\tswitch (type) {\n\t\tcase leaf.number.name:\n\t\tcase leaf.boolean.name:\n\t\tcase leaf.string.name:\n\t\t\tassert(reader.value !== undefined, 0x84f /* out of schema: missing value */);\n\t\t\tassert(!isFluidHandle(reader.value), 0x850 /* out of schema: unexpected FluidHandle */);\n\t\t\treturn reader.value;\n\t\tcase jsonArray.name: {\n\t\t\treader.enterField(EmptyKey);\n\t\t\tconst result = mapCursorField(reader, cursorToJsonObject);\n\t\t\treader.exitField();\n\t\t\treturn result;\n\t\t}\n\t\tcase jsonObject.name: {\n\t\t\tconst result: JsonCompatible = {};\n\t\t\tmapCursorFields(reader, (cursor) => {\n\t\t\t\tconst key = cursor.getFieldKey();\n\t\t\t\tassert(cursor.firstNode(), 0x420 /* expected non-empty field */);\n\t\t\t\t// like `result[key] = cursorToJsonObject(reader);` except safe when keyString == \"__proto__\".\n\t\t\t\tObject.defineProperty(result, key, {\n\t\t\t\t\tenumerable: true,\n\t\t\t\t\tconfigurable: true,\n\t\t\t\t\twritable: true,\n\t\t\t\t\tvalue: cursorToJsonObject(reader),\n\t\t\t\t});\n\t\t\t\tassert(!cursor.nextNode(), 0x421 /* expected exactly one node */);\n\t\t\t});\n\t\t\treturn result;\n\t\t}\n\t\tdefault: {\n\t\t\tassert(type === leaf.null.name, 0x422 /* unexpected type */);\n\t\t\treturn null;\n\t\t}\n\t}\n}\n"]}

package/dist/domains/json/jsonDomainSchema.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ValueSchema } from "../../core";
+import { TreeFieldSchema } from "../../feature-libraries";
+/**
+ * Types allowed as roots of Json content.
+ */
+export declare const jsonRoot: readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>];
+export declare const jsonObject: import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>;
+export declare const jsonArray: import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, () => import("../../feature-libraries").FieldNodeSchema<"com.fluidframework.json.array", TreeFieldSchema<import("../../feature-libraries").Sequence, readonly [() => import("../../feature-libraries").MapNodeSchema<"com.fluidframework.json.object", TreeFieldSchema<import("../../feature-libraries").Optional, readonly [any, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, any, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>, import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>]>>;
+export declare const jsonSchema: import("../../feature-libraries").SchemaLibrary;
+//# sourceMappingURL=jsonDomainSchema.d.ts.map

package/dist/domains/json/jsonDomainSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonDomainSchema.d.ts","sourceRoot":"","sources":["../../../src/domains/json/jsonDomainSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAGN,eAAe,EAEf,MAAM,yBAAyB,CAAC;AAWjC;;GAEG;AACH,eAAO,MAAM,QAAQ,qsFAAkE,CAAC;AAOxF,eAAO,MAAM,UAAU,q1FAGtB,CAAC;AAEF,eAAO,MAAM,SAAS,s1FAGrB,CAAC;AAEF,eAAO,MAAM,UAAU,iDAAwB,CAAC"}

package/dist/domains/json/jsonDomainSchema.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonSchema = exports.jsonArray = exports.jsonObject = exports.jsonRoot = void 0;
+const feature_libraries_1 = require("../../feature-libraries");
+const leafDomain_1 = require("../leafDomain");
+const builder = new feature_libraries_1.SchemaBuilderInternal({
+    scope: "com.fluidframework.json",
+    libraries: [leafDomain_1.leaf.library],
+});
+const jsonPrimitives = [...leafDomain_1.leaf.primitives, leafDomain_1.leaf.null];
+/**
+ * Types allowed as roots of Json content.
+ */
+exports.jsonRoot = [() => exports.jsonObject, () => exports.jsonArray, ...jsonPrimitives];
+{
+}
+exports.jsonObject = builder.mapRecursive("object", feature_libraries_1.TreeFieldSchema.createUnsafe(feature_libraries_1.FieldKinds.optional, exports.jsonRoot));
+exports.jsonArray = builder.fieldNodeRecursive("array", feature_libraries_1.TreeFieldSchema.createUnsafe(feature_libraries_1.FieldKinds.sequence, exports.jsonRoot));
+exports.jsonSchema = builder.intoLibrary();
+//# sourceMappingURL=jsonDomainSchema.js.map

package/dist/domains/json/jsonDomainSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonDomainSchema.js","sourceRoot":"","sources":["../../../src/domains/json/jsonDomainSchema.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,+DAKiC;AAEjC,8CAAqC;AAErC,MAAM,OAAO,GAAG,IAAI,yCAAqB,CAAC;IACzC,KAAK,EAAE,yBAAyB;IAChC,SAAS,EAAE,CAAC,iBAAI,CAAC,OAAO,CAAC;CACzB,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,CAAC,GAAG,iBAAI,CAAC,UAAU,EAAE,iBAAI,CAAC,IAAI,CAAU,CAAC;AAEhE;;GAEG;AACU,QAAA,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,kBAAU,EAAE,GAAG,EAAE,CAAC,iBAAS,EAAE,GAAG,cAAc,CAAU,CAAC;AAExF;CAGC;AAEY,QAAA,UAAU,GAAG,OAAO,CAAC,YAAY,CAC7C,QAAQ,EACR,mCAAe,CAAC,YAAY,CAAC,8BAAU,CAAC,QAAQ,EAAE,gBAAQ,CAAC,CAC3D,CAAC;AAEW,QAAA,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAClD,OAAO,EACP,mCAAe,CAAC,YAAY,CAAC,8BAAU,CAAC,QAAQ,EAAE,gBAAQ,CAAC,CAC3D,CAAC;AAEW,QAAA,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Adding this unused import makes the generated d.ts file produced by TypeScript stop breaking API-Extractor's rollup generation.\n// Without this import, TypeScript generates inline `import(\"../..\")` statements in the d.ts file,\n// which API-Extractor leaves as is when generating the rollup, leaving them pointing at the wrong directory.\n// TODO: Understand and/or remove the need for this workaround.\n// eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports\nimport { ValueSchema } from \"../../core\";\n\nimport {\n\tAllowedTypes,\n\tFieldKinds,\n\tTreeFieldSchema,\n\tSchemaBuilderInternal,\n} from \"../../feature-libraries\";\nimport { requireAssignableTo } from \"../../util\";\nimport { leaf } from \"../leafDomain\";\n\nconst builder = new SchemaBuilderInternal({\n\tscope: \"com.fluidframework.json\",\n\tlibraries: [leaf.library],\n});\n\nconst jsonPrimitives = [...leaf.primitives, leaf.null] as const;\n\n/**\n * Types allowed as roots of Json content.\n */\nexport const jsonRoot = [() => jsonObject, () => jsonArray, ...jsonPrimitives] as const;\n\n{\n\t// Recursive objects don't get this type checking automatically, so confirm it\n\ttype _check = requireAssignableTo<typeof jsonRoot, AllowedTypes>;\n}\n\nexport const jsonObject = builder.mapRecursive(\n\t\"object\",\n\tTreeFieldSchema.createUnsafe(FieldKinds.optional, jsonRoot),\n);\n\nexport const jsonArray = builder.fieldNodeRecursive(\n\t\"array\",\n\tTreeFieldSchema.createUnsafe(FieldKinds.sequence, jsonRoot),\n);\n\nexport const jsonSchema = builder.intoLibrary();\n"]}

package/dist/domains/leafDomain.d.ts

@@ -0,0 +1,73 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ValueSchema } from "../core";
+/**
+ * Built-in {@link LeafNodeSchema}.
+ * @internal
+ */
+export declare const leaf: {
+    /**
+     * {@link LeafNodeSchema} for holding a JavaScript `number`.
+     *
+     * @remarks
+     * The number is a [double-precision 64-bit binary format IEEE 754](https://en.wikipedia.org/wiki/Double-precision_floating-point_format) value, however there are some exceptions:
+     * - `NaN`, and the infinities should not be used.
+     * - `-0` may be converted to `0` in some cases.
+     *
+     * These limitations match the limitations of JSON.
+     * @privateRemarks
+     * TODO:
+     * We should be much more clear about what happens if you use problematic values.
+     * We should validate and/or normalize them when inserting content.
+     */
+    number: import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>;
+    /**
+     * {@link LeafNodeSchema} for holding a boolean.
+     */
+    boolean: import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>;
+    /**
+     * {@link LeafNodeSchema} for holding a JavaScript `string`.
+     *
+     * @remarks
+     * Strings containing unpaired UTF-16 surrogate pair code units may not be handled correctly.
+     *
+     * These limitations come from the use of UTF-8 encoding of the strings, which requires them to be valid unicode.
+     * JavaScript does not make this requirement for its strings so not all possible JavaScript strings are supported.
+     * @privateRemarks
+     * TODO:
+     * We should be much more clear about what happens if you use problematic values.
+     * We should validate and/or normalize them when inserting content.
+     */
+    string: import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>;
+    /**
+     * {@link LeafNodeSchema} for holding an {@link @fluidframework/core-interfaces#IFluidHandle}.
+     */
+    handle: import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.handle", ValueSchema.FluidHandle>;
+    /**
+     * {@link LeafNodeSchema} for JavaScript `null`.
+     *
+     * @remarks
+     * There are good [reasons to avoid using null](https://www.npmjs.com/package/%40rushstack/eslint-plugin#rushstackno-new-null) in JavaScript, however sometimes it is desired.
+     * This {@link LeafNodeSchema} node provides the option to include nulls in trees when desired.
+     * Unless directly inter-operating with existing data using null, consider other approaches, like wrapping the value in an optional field, or using a more specifically named empty object node.
+     */
+    null: import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>;
+    /**
+     * The set of {@link LeafNodeSchema} which correspond to JavaScript primitive (non-object) types.
+     */
+    primitives: readonly [import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>];
+    /**
+     * All {@link LeafNodeSchema} defined in this library..
+     */
+    all: readonly [import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.handle", ValueSchema.FluidHandle>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.null", ValueSchema.Null>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.number", ValueSchema.Number>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.boolean", ValueSchema.Boolean>, import("../feature-libraries").LeafNodeSchema<"com.fluidframework.leaf.string", ValueSchema.String>];
+    /**
+     * {@link SchemaLibrary} of the {@link LeafNodeSchema}.
+     *
+     * @privateRemarks
+     * This is included by default in schema produced with {@link SchemaBuilder}.
+     */
+    library: import("../feature-libraries").SchemaLibrary;
+};
+//# sourceMappingURL=leafDomain.d.ts.map

package/dist/domains/leafDomain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leafDomain.d.ts","sourceRoot":"","sources":["../../src/domains/leafDomain.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAkBtC;;;GAGG;AACH,eAAO,MAAM,IAAI;IAChB;;;;;;;;;;;;;OAaG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;OAYG;;IAGH;;OAEG;;IAGH;;;;;;;OAOG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;CAEH,CAAC"}

package/dist/domains/leafDomain.js

@@ -0,0 +1,89 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.leaf = void 0;
+const feature_libraries_1 = require("../feature-libraries");
+const core_1 = require("../core");
+/**
+ * Names in this domain follow https://en.wikipedia.org/wiki/Reverse_domain_name_notation
+ */
+const builder = new feature_libraries_1.SchemaBuilderInternal({ scope: "com.fluidframework.leaf" });
+const number = builder.leaf("number", core_1.ValueSchema.Number);
+const boolean = builder.leaf("boolean", core_1.ValueSchema.Boolean);
+const string = builder.leaf("string", core_1.ValueSchema.String);
+const handle = builder.leaf("handle", core_1.ValueSchema.FluidHandle);
+const nullSchema = builder.leaf("null", core_1.ValueSchema.Null);
+const primitives = [number, boolean, string];
+const all = [handle, nullSchema, ...primitives];
+const library = builder.intoLibrary();
+/**
+ * Built-in {@link LeafNodeSchema}.
+ * @internal
+ */
+exports.leaf = {
+    /**
+     * {@link LeafNodeSchema} for holding a JavaScript `number`.
+     *
+     * @remarks
+     * The number is a [double-precision 64-bit binary format IEEE 754](https://en.wikipedia.org/wiki/Double-precision_floating-point_format) value, however there are some exceptions:
+     * - `NaN`, and the infinities should not be used.
+     * - `-0` may be converted to `0` in some cases.
+     *
+     * These limitations match the limitations of JSON.
+     * @privateRemarks
+     * TODO:
+     * We should be much more clear about what happens if you use problematic values.
+     * We should validate and/or normalize them when inserting content.
+     */
+    number,
+    /**
+     * {@link LeafNodeSchema} for holding a boolean.
+     */
+    boolean,
+    /**
+     * {@link LeafNodeSchema} for holding a JavaScript `string`.
+     *
+     * @remarks
+     * Strings containing unpaired UTF-16 surrogate pair code units may not be handled correctly.
+     *
+     * These limitations come from the use of UTF-8 encoding of the strings, which requires them to be valid unicode.
+     * JavaScript does not make this requirement for its strings so not all possible JavaScript strings are supported.
+     * @privateRemarks
+     * TODO:
+     * We should be much more clear about what happens if you use problematic values.
+     * We should validate and/or normalize them when inserting content.
+     */
+    string,
+    /**
+     * {@link LeafNodeSchema} for holding an {@link @fluidframework/core-interfaces#IFluidHandle}.
+     */
+    handle,
+    /**
+     * {@link LeafNodeSchema} for JavaScript `null`.
+     *
+     * @remarks
+     * There are good [reasons to avoid using null](https://www.npmjs.com/package/%40rushstack/eslint-plugin#rushstackno-new-null) in JavaScript, however sometimes it is desired.
+     * This {@link LeafNodeSchema} node provides the option to include nulls in trees when desired.
+     * Unless directly inter-operating with existing data using null, consider other approaches, like wrapping the value in an optional field, or using a more specifically named empty object node.
+     */
+    null: nullSchema,
+    /**
+     * The set of {@link LeafNodeSchema} which correspond to JavaScript primitive (non-object) types.
+     */
+    primitives,
+    /**
+     * All {@link LeafNodeSchema} defined in this library..
+     */
+    all,
+    /**
+     * {@link SchemaLibrary} of the {@link LeafNodeSchema}.
+     *
+     * @privateRemarks
+     * This is included by default in schema produced with {@link SchemaBuilder}.
+     */
+    library,
+};
+//# sourceMappingURL=leafDomain.js.map

package/dist/domains/leafDomain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"leafDomain.js","sourceRoot":"","sources":["../../src/domains/leafDomain.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,4DAA6D;AAC7D,kCAAsC;AAEtC;;GAEG;AACH,MAAM,OAAO,GAAG,IAAI,yCAAqB,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC,CAAC;AAEhF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAW,CAAC,MAAM,CAAC,CAAC;AAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAW,CAAC,OAAO,CAAC,CAAC;AAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAW,CAAC,MAAM,CAAC,CAAC;AAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAW,CAAC,WAAW,CAAC,CAAC;AAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAW,CAAC,IAAI,CAAC,CAAC;AAE1D,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAU,CAAC;AACtD,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,CAAU,CAAC;AAEzD,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;AAEtC;;;GAGG;AACU,QAAA,IAAI,GAAG;IACnB;;;;;;;;;;;;;OAaG;IACH,MAAM;IAEN;;OAEG;IACH,OAAO;IAEP;;;;;;;;;;;;OAYG;IACH,MAAM;IAEN;;OAEG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,UAAU;IAEV;;OAEG;IACH,GAAG;IAEH;;;;;OAKG;IACH,OAAO;CACP,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SchemaBuilderInternal } from \"../feature-libraries\";\nimport { ValueSchema } from \"../core\";\n\n/**\n * Names in this domain follow https://en.wikipedia.org/wiki/Reverse_domain_name_notation\n */\nconst builder = new SchemaBuilderInternal({ scope: \"com.fluidframework.leaf\" });\n\nconst number = builder.leaf(\"number\", ValueSchema.Number);\nconst boolean = builder.leaf(\"boolean\", ValueSchema.Boolean);\nconst string = builder.leaf(\"string\", ValueSchema.String);\nconst handle = builder.leaf(\"handle\", ValueSchema.FluidHandle);\nconst nullSchema = builder.leaf(\"null\", ValueSchema.Null);\n\nconst primitives = [number, boolean, string] as const;\nconst all = [handle, nullSchema, ...primitives] as const;\n\nconst library = builder.intoLibrary();\n\n/**\n * Built-in {@link LeafNodeSchema}.\n * @internal\n */\nexport const leaf = {\n\t/**\n\t * {@link LeafNodeSchema} for holding a JavaScript `number`.\n\t *\n\t * @remarks\n\t * The number is a [double-precision 64-bit binary format IEEE 754](https://en.wikipedia.org/wiki/Double-precision_floating-point_format) value, however there are some exceptions:\n\t * - `NaN`, and the infinities should not be used.\n\t * - `-0` may be converted to `0` in some cases.\n\t *\n\t * These limitations match the limitations of JSON.\n\t * @privateRemarks\n\t * TODO:\n\t * We should be much more clear about what happens if you use problematic values.\n\t * We should validate and/or normalize them when inserting content.\n\t */\n\tnumber,\n\n\t/**\n\t * {@link LeafNodeSchema} for holding a boolean.\n\t */\n\tboolean,\n\n\t/**\n\t * {@link LeafNodeSchema} for holding a JavaScript `string`.\n\t *\n\t * @remarks\n\t * Strings containing unpaired UTF-16 surrogate pair code units may not be handled correctly.\n\t *\n\t * These limitations come from the use of UTF-8 encoding of the strings, which requires them to be valid unicode.\n\t * JavaScript does not make this requirement for its strings so not all possible JavaScript strings are supported.\n\t * @privateRemarks\n\t * TODO:\n\t * We should be much more clear about what happens if you use problematic values.\n\t * We should validate and/or normalize them when inserting content.\n\t */\n\tstring,\n\n\t/**\n\t * {@link LeafNodeSchema} for holding an {@link @fluidframework/core-interfaces#IFluidHandle}.\n\t */\n\thandle,\n\n\t/**\n\t * {@link LeafNodeSchema} for JavaScript `null`.\n\t *\n\t * @remarks\n\t * There are good [reasons to avoid using null](https://www.npmjs.com/package/%40rushstack/eslint-plugin#rushstackno-new-null) in JavaScript, however sometimes it is desired.\n\t * This {@link LeafNodeSchema} node provides the option to include nulls in trees when desired.\n\t * Unless directly inter-operating with existing data using null, consider other approaches, like wrapping the value in an optional field, or using a more specifically named empty object node.\n\t */\n\tnull: nullSchema,\n\n\t/**\n\t * The set of {@link LeafNodeSchema} which correspond to JavaScript primitive (non-object) types.\n\t */\n\tprimitives,\n\n\t/**\n\t * All {@link LeafNodeSchema} defined in this library..\n\t */\n\tall,\n\n\t/**\n\t * {@link SchemaLibrary} of the {@link LeafNodeSchema}.\n\t *\n\t * @privateRemarks\n\t * This is included by default in schema produced with {@link SchemaBuilder}.\n\t */\n\tlibrary,\n};\n"]}

package/dist/domains/nodeKey/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { nodeKeyField, nodeKeySchema, nodeKeyTreeSchema } from "./nodeKeySchema";
+//# sourceMappingURL=index.d.ts.map

package/dist/domains/nodeKey/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/domains/nodeKey/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/domains/nodeKey/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeKeyTreeSchema = exports.nodeKeySchema = exports.nodeKeyField = void 0;
+var nodeKeySchema_1 = require("./nodeKeySchema");
+Object.defineProperty(exports, "nodeKeyField", { enumerable: true, get: function () { return nodeKeySchema_1.nodeKeyField; } });
+Object.defineProperty(exports, "nodeKeySchema", { enumerable: true, get: function () { return nodeKeySchema_1.nodeKeySchema; } });
+Object.defineProperty(exports, "nodeKeyTreeSchema", { enumerable: true, get: function () { return nodeKeySchema_1.nodeKeyTreeSchema; } });
+//# sourceMappingURL=index.js.map

package/dist/domains/nodeKey/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/domains/nodeKey/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAiF;AAAxE,6GAAA,YAAY,OAAA;AAAE,8GAAA,aAAa,OAAA;AAAE,kHAAA,iBAAiB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { nodeKeyField, nodeKeySchema, nodeKeyTreeSchema } from \"./nodeKeySchema\";\n"]}

package/dist/domains/nodeKey/nodeKeySchema.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ValueSchema } from "../../core";
+import { TreeFieldSchema } from "../../feature-libraries";
+/**
+ * Schema for a node which holds a {@link StableNodeKey}.
+ *
+ * @privateRemarks
+ * This being a leaf may cause issues with leaf unboxing plans.
+ * This might need to be changed to be a node holding a string node instead.
+ */
+export declare const nodeKeyTreeSchema: import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.nodeKey.NodeKey", ValueSchema.String>;
+/**
+ * Key and Field schema for working with {@link LocalNodeKey}s in a shared tree.
+ * Node keys are added to object nodes via a field.
+ * This object can be expanded into a schema to add the field.
+ *
+ * Requires including {@link nodeKeySchema}.
+ */
+export declare const nodeKeyField: {
+    __n_id__: TreeFieldSchema<import("../../feature-libraries").NodeKeyFieldKind, readonly [import("../../feature-libraries").LeafNodeSchema<"com.fluidframework.nodeKey.NodeKey", ValueSchema.String>]>;
+};
+/**
+ * The schema library for working with {@link StableNodeKey}s in a tree.
+ * Required to use {@link nodeKeyField}.
+ */
+export declare const nodeKeySchema: import("../../feature-libraries").SchemaLibrary;
+//# sourceMappingURL=nodeKeySchema.d.ts.map

package/dist/domains/nodeKey/nodeKeySchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeKeySchema.d.ts","sourceRoot":"","sources":["../../../src/domains/nodeKey/nodeKeySchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAKN,eAAe,EACf,MAAM,yBAAyB,CAAC;AAIjC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,4GAA8C,CAAC;AAG7E;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;CAExB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,iDAAwB,CAAC"}

package/dist/domains/nodeKey/nodeKeySchema.js

@@ -0,0 +1,36 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeKeySchema = exports.nodeKeyField = exports.nodeKeyTreeSchema = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../../core");
+const feature_libraries_1 = require("../../feature-libraries");
+const builder = new feature_libraries_1.SchemaBuilderInternal({ scope: "com.fluidframework.nodeKey" });
+/**
+ * Schema for a node which holds a {@link StableNodeKey}.
+ *
+ * @privateRemarks
+ * This being a leaf may cause issues with leaf unboxing plans.
+ * This might need to be changed to be a node holding a string node instead.
+ */
+exports.nodeKeyTreeSchema = builder.leaf("NodeKey", core_1.ValueSchema.String);
+(0, core_utils_1.assert)(exports.nodeKeyTreeSchema.name === feature_libraries_1.nodeKeyTreeIdentifier, 0x7ae /* mismatched identifiers */);
+/**
+ * Key and Field schema for working with {@link LocalNodeKey}s in a shared tree.
+ * Node keys are added to object nodes via a field.
+ * This object can be expanded into a schema to add the field.
+ *
+ * Requires including {@link nodeKeySchema}.
+ */
+exports.nodeKeyField = {
+    [feature_libraries_1.nodeKeyFieldKey]: feature_libraries_1.TreeFieldSchema.create(feature_libraries_1.FieldKinds.nodeKey, [exports.nodeKeyTreeSchema]),
+};
+/**
+ * The schema library for working with {@link StableNodeKey}s in a tree.
+ * Required to use {@link nodeKeyField}.
+ */
+exports.nodeKeySchema = builder.intoLibrary();
+//# sourceMappingURL=nodeKeySchema.js.map

package/dist/domains/nodeKey/nodeKeySchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeKeySchema.js","sourceRoot":"","sources":["../../../src/domains/nodeKey/nodeKeySchema.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,qCAAyC;AACzC,+DAMiC;AAEjC,MAAM,OAAO,GAAG,IAAI,yCAAqB,CAAC,EAAE,KAAK,EAAE,4BAA4B,EAAE,CAAC,CAAC;AAEnF;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAW,CAAC,MAAM,CAAC,CAAC;AAC7E,IAAA,mBAAM,EAAC,yBAAiB,CAAC,IAAI,KAAK,yCAAqB,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAE7F;;;;;;GAMG;AACU,QAAA,YAAY,GAAG;IAC3B,CAAC,mCAAe,CAAC,EAAE,mCAAe,CAAC,MAAM,CAAC,8BAAU,CAAC,OAAO,EAAE,CAAC,yBAAiB,CAAC,CAAC;CAClF,CAAC;AAEF;;;GAGG;AACU,QAAA,aAAa,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { ValueSchema } from \"../../core\";\nimport {\n\tnodeKeyFieldKey,\n\tFieldKinds,\n\tnodeKeyTreeIdentifier,\n\tSchemaBuilderInternal,\n\tTreeFieldSchema,\n} from \"../../feature-libraries\";\n\nconst builder = new SchemaBuilderInternal({ scope: \"com.fluidframework.nodeKey\" });\n\n/**\n * Schema for a node which holds a {@link StableNodeKey}.\n *\n * @privateRemarks\n * This being a leaf may cause issues with leaf unboxing plans.\n * This might need to be changed to be a node holding a string node instead.\n */\nexport const nodeKeyTreeSchema = builder.leaf(\"NodeKey\", ValueSchema.String);\nassert(nodeKeyTreeSchema.name === nodeKeyTreeIdentifier, 0x7ae /* mismatched identifiers */);\n\n/**\n * Key and Field schema for working with {@link LocalNodeKey}s in a shared tree.\n * Node keys are added to object nodes via a field.\n * This object can be expanded into a schema to add the field.\n *\n * Requires including {@link nodeKeySchema}.\n */\nexport const nodeKeyField = {\n\t[nodeKeyFieldKey]: TreeFieldSchema.create(FieldKinds.nodeKey, [nodeKeyTreeSchema]),\n};\n\n/**\n * The schema library for working with {@link StableNodeKey}s in a tree.\n * Required to use {@link nodeKeyField}.\n */\nexport const nodeKeySchema = builder.intoLibrary();\n"]}