@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/default-schema/defaultFieldKinds.js

@@ -0,0 +1,110 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldKinds = exports.fieldKinds = exports.forbidden = exports.nodeKey = exports.sequence = exports.required = exports.valueChangeHandler = exports.valueFieldEditor = exports.optional = exports.noChangeHandler = void 0;
+const core_1 = require("../../core");
+const util_1 = require("../../util");
+const modular_schema_1 = require("../modular-schema");
+const sequence_field_1 = require("../sequence-field");
+const optional_field_1 = require("../optional-field");
+const multiplicity_1 = require("../multiplicity");
+/**
+ * ChangeHandler that only handles no-op / identity changes.
+ */
+exports.noChangeHandler = {
+    rebaser: (0, modular_schema_1.referenceFreeFieldChangeRebaser)({
+        compose: (changes) => 0,
+        invert: (changes) => 0,
+        rebase: (change, over) => 0,
+    }),
+    codecsFactory: () => optional_field_1.noChangeCodecFamily,
+    editor: { buildChildChange: (index, change) => (0, util_1.fail)("Child changes not supported") },
+    intoDelta: (change, deltaFromChild) => ({}),
+    relevantRemovedRoots: (change) => [],
+    isEmpty: (change) => true,
+};
+const optionalIdentifier = "Optional";
+/**
+ * 0 or 1 items.
+ */
+exports.optional = new modular_schema_1.FieldKindWithEditor(optionalIdentifier, multiplicity_1.Multiplicity.Optional, optional_field_1.optionalChangeHandler, (types, other) => (other.kind.identifier === exports.sequence.identifier ||
+    other.kind.identifier === optionalIdentifier) &&
+    (0, modular_schema_1.allowsTreeSchemaIdentifierSuperset)(types, other.types), new Set([]));
+exports.valueFieldEditor = {
+    ...optional_field_1.optionalFieldEditor,
+    set: (ids) => optional_field_1.optionalFieldEditor.set(false, ids),
+};
+exports.valueChangeHandler = {
+    ...exports.optional.changeHandler,
+    editor: exports.valueFieldEditor,
+};
+const requiredIdentifier = "Value";
+/**
+ * Exactly one item.
+ */
+exports.required = new modular_schema_1.FieldKindWithEditor(requiredIdentifier, multiplicity_1.Multiplicity.Single, exports.valueChangeHandler, (types, other) => (other.kind.identifier === exports.sequence.identifier ||
+    other.kind.identifier === requiredIdentifier ||
+    other.kind.identifier === exports.optional.identifier ||
+    other.kind.identifier === exports.nodeKey.identifier) &&
+    (0, modular_schema_1.allowsTreeSchemaIdentifierSuperset)(types, other.types), new Set());
+const sequenceIdentifier = "Sequence";
+/**
+ * 0 or more items.
+ */
+exports.sequence = new modular_schema_1.FieldKindWithEditor(sequenceIdentifier, multiplicity_1.Multiplicity.Sequence, sequence_field_1.sequenceFieldChangeHandler, (types, other) => other.kind.identifier === sequenceIdentifier &&
+    (0, modular_schema_1.allowsTreeSchemaIdentifierSuperset)(types, other.types), 
+// TODO: add normalizer/importers for handling ops from other kinds.
+new Set([]));
+const nodeKeyIdentifier = "NodeKey";
+/**
+ * Exactly one identifier.
+ */
+exports.nodeKey = new modular_schema_1.FieldKindWithEditor(nodeKeyIdentifier, multiplicity_1.Multiplicity.Single, exports.noChangeHandler, (types, other) => (other.kind.identifier === exports.sequence.identifier ||
+    other.kind.identifier === requiredIdentifier ||
+    other.kind.identifier === exports.optional.identifier ||
+    other.kind.identifier === nodeKeyIdentifier) &&
+    (0, modular_schema_1.allowsTreeSchemaIdentifierSuperset)(types, other.types), new Set());
+/**
+ * Exactly 0 items.
+ *
+ * Using Forbidden makes what types are listed for allowed in a field irrelevant
+ * since the field will never have values in it.
+ *
+ * Using Forbidden is equivalent to picking a kind that permits empty (like sequence or optional)
+ * and having no allowed types (or only never types).
+ * Because of this, its possible to express everything constraint wise without Forbidden,
+ * but using Forbidden can be more semantically clear than optional with no allowed types.
+ *
+ * For view schema, this can be useful if you need to:
+ * - run a specific out of schema handler when a field is present,
+ * but otherwise are ignoring or tolerating (ex: via extra fields) unmentioned fields.
+ * - prevent a specific field from being used as an extra field
+ * (perhaps for some past of future compatibility reason)
+ * - keep a field in a schema for metadata purposes
+ * (ex: for improved error messaging, error handling or documentation)
+ * that is not used in this specific version of the schema (ex: to document what it was or will be used for).
+ *
+ * For stored schema, this can be useful if you need to:
+ * - have a field which can have its schema updated to Optional or Sequence of any type.
+ * - to exclude a field from extra fields
+ * - for the schema system to use as a default for fields which aren't declared
+ * (ex: when updating a field that did not exist into one that does)
+ *
+ * See {@link emptyField} for a constant, reusable field using Forbidden.
+ */
+exports.forbidden = new modular_schema_1.FieldKindWithEditor(core_1.forbiddenFieldKindIdentifier, multiplicity_1.Multiplicity.Forbidden, exports.noChangeHandler, 
+// All multiplicities other than Value support empty.
+(types, other) => exports.fieldKinds.get(other.kind.identifier)?.multiplicity !== multiplicity_1.Multiplicity.Single, new Set());
+/**
+ * Default field kinds by identifier
+ */
+exports.fieldKinds = new Map([exports.required, exports.optional, exports.sequence, exports.nodeKey, exports.forbidden].map((s) => [s.identifier, s]));
+/**
+ * Default FieldKinds with their editor types erased.
+ * @internal
+ */
+exports.FieldKinds = { required: exports.required, optional: exports.optional, sequence: exports.sequence, nodeKey: exports.nodeKey, forbidden: exports.forbidden };
+//# sourceMappingURL=defaultFieldKinds.js.map

package/dist/feature-libraries/default-schema/defaultFieldKinds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultFieldKinds.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultFieldKinds.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAMoB;AACpB,qCAAkC;AAClC,sDAQ2B;AAC3B,sDAA+D;AAC/D,sDAK2B;AAC3B,kDAA+C;AAE/C;;GAEG;AACU,QAAA,eAAe,GAA0B;IACrD,OAAO,EAAE,IAAA,gDAA+B,EAAC;QACxC,OAAO,EAAE,CAAC,OAAY,EAAE,EAAE,CAAC,CAAC;QAC5B,MAAM,EAAE,CAAC,OAAU,EAAE,EAAE,CAAC,CAAC;QACzB,MAAM,EAAE,CAAC,MAAS,EAAE,IAAO,EAAE,EAAE,CAAC,CAAC;KACjC,CAAC;IACF,aAAa,EAAE,GAAG,EAAE,CAAC,oCAAmB;IACxC,MAAM,EAAE,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,6BAA6B,CAAC,EAAE;IACpF,SAAS,EAAE,CAAC,MAAM,EAAE,cAAuB,EAAqB,EAAE,CAAC,CAAC,EAAE,CAAC;IACvE,oBAAoB,EAAE,CAAC,MAAM,EAAiC,EAAE,CAAC,EAAE;IACnE,OAAO,EAAE,CAAC,MAAS,EAAE,EAAE,CAAC,IAAI;CAC5B,CAAC;AAYF,MAAM,kBAAkB,GAAG,UAAU,CAAC;AACtC;;GAEG;AACU,QAAA,QAAQ,GAAG,IAAI,oCAAmB,CAC9C,kBAAkB,EAClB,2BAAY,CAAC,QAAQ,EACrB,sCAAqB,EACrB,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAChB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,gBAAQ,CAAC,UAAU;IAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,kBAAkB,CAAC;IAC9C,IAAA,mDAAkC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EACvD,IAAI,GAAG,CAAC,EAAE,CAAC,CACX,CAAC;AAEW,QAAA,gBAAgB,GAAqB;IACjD,GAAG,oCAAmB;IACtB,GAAG,EAAE,CAAC,GAAyD,EAAqB,EAAE,CACrF,oCAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC;CACpC,CAAC;AAEW,QAAA,kBAAkB,GAA4D;IAC1F,GAAG,gBAAQ,CAAC,aAAa;IACzB,MAAM,EAAE,wBAAgB;CACxB,CAAC;AAEF,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAEnC;;GAEG;AACU,QAAA,QAAQ,GAAG,IAAI,oCAAmB,CAC9C,kBAAkB,EAClB,2BAAY,CAAC,MAAM,EACnB,0BAAkB,EAClB,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAChB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,gBAAQ,CAAC,UAAU;IAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,kBAAkB;IAC5C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,gBAAQ,CAAC,UAAU;IAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,eAAO,CAAC,UAAU,CAAC;IAC9C,IAAA,mDAAkC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EACvD,IAAI,GAAG,EAAE,CACT,CAAC;AAEF,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAEtC;;GAEG;AACU,QAAA,QAAQ,GAAG,IAAI,oCAAmB,CAC9C,kBAAkB,EAClB,2BAAY,CAAC,QAAQ,EACrB,2CAA0B,EAC1B,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAChB,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,kBAAkB;IAC5C,IAAA,mDAAkC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;AACvD,oEAAoE;AACpE,IAAI,GAAG,CAAC,EAAE,CAAC,CACX,CAAC;AAEF,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAEpC;;GAEG;AACU,QAAA,OAAO,GAAG,IAAI,oCAAmB,CAC7C,iBAAiB,EACjB,2BAAY,CAAC,MAAM,EACnB,uBAAe,EACf,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAChB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,gBAAQ,CAAC,UAAU;IAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,kBAAkB;IAC5C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,gBAAQ,CAAC,UAAU;IAC7C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB,CAAC;IAC7C,IAAA,mDAAkC,EAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EACvD,IAAI,GAAG,EAAE,CACT,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACU,QAAA,SAAS,GAAG,IAAI,oCAAmB,CAC/C,mCAA4B,EAC5B,2BAAY,CAAC,SAAS,EACtB,uBAAe;AACf,qDAAqD;AACrD,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,kBAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,YAAY,KAAK,2BAAY,CAAC,MAAM,EAC7F,IAAI,GAAG,EAAE,CACT,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAA0D,IAAI,GAAG,CACvF,CAAC,gBAAQ,EAAE,gBAAQ,EAAE,gBAAQ,EAAE,eAAO,EAAE,iBAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAChF,CAAC;AA6BF;;;GAGG;AACU,QAAA,UAAU,GAOnB,EAAE,QAAQ,EAAR,gBAAQ,EAAE,QAAQ,EAAR,gBAAQ,EAAE,QAAQ,EAAR,gBAAQ,EAAE,OAAO,EAAP,eAAO,EAAE,SAAS,EAAT,iBAAS,EAAE,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tFieldKindIdentifier,\n\tforbiddenFieldKindIdentifier,\n\tChangesetLocalId,\n\tDeltaDetachedNodeId,\n\tDeltaFieldChanges,\n} from \"../../core\";\nimport { fail } from \"../../util\";\nimport {\n\tFieldKind,\n\tallowsTreeSchemaIdentifierSuperset,\n\tToDelta,\n\tFieldChangeHandler,\n\tFieldEditor,\n\treferenceFreeFieldChangeRebaser,\n\tFieldKindWithEditor,\n} from \"../modular-schema\";\nimport { sequenceFieldChangeHandler } from \"../sequence-field\";\nimport {\n\tnoChangeCodecFamily,\n\tOptionalChangeset,\n\toptionalChangeHandler,\n\toptionalFieldEditor,\n} from \"../optional-field\";\nimport { Multiplicity } from \"../multiplicity\";\n\n/**\n * ChangeHandler that only handles no-op / identity changes.\n */\nexport const noChangeHandler: FieldChangeHandler<0> = {\n\trebaser: referenceFreeFieldChangeRebaser({\n\t\tcompose: (changes: 0[]) => 0,\n\t\tinvert: (changes: 0) => 0,\n\t\trebase: (change: 0, over: 0) => 0,\n\t}),\n\tcodecsFactory: () => noChangeCodecFamily,\n\teditor: { buildChildChange: (index, change) => fail(\"Child changes not supported\") },\n\tintoDelta: (change, deltaFromChild: ToDelta): DeltaFieldChanges => ({}),\n\trelevantRemovedRoots: (change): Iterable<DeltaDetachedNodeId> => [],\n\tisEmpty: (change: 0) => true,\n};\n\nexport interface ValueFieldEditor extends FieldEditor<OptionalChangeset> {\n\t/**\n\t * Creates a change which replaces the current value of the field with `newValue`.\n\t * @param newContent - the new content for the field\n\t * @param changeId - the ID associated with the replacement of the current content.\n\t * @param buildId - the ID associated with the creation of the `newContent`.\n\t */\n\tset(ids: { fill: ChangesetLocalId; detach: ChangesetLocalId }): OptionalChangeset;\n}\n\nconst optionalIdentifier = \"Optional\";\n/**\n * 0 or 1 items.\n */\nexport const optional = new FieldKindWithEditor(\n\toptionalIdentifier,\n\tMultiplicity.Optional,\n\toptionalChangeHandler,\n\t(types, other) =>\n\t\t(other.kind.identifier === sequence.identifier ||\n\t\t\tother.kind.identifier === optionalIdentifier) &&\n\t\tallowsTreeSchemaIdentifierSuperset(types, other.types),\n\tnew Set([]),\n);\n\nexport const valueFieldEditor: ValueFieldEditor = {\n\t...optionalFieldEditor,\n\tset: (ids: { fill: ChangesetLocalId; detach: ChangesetLocalId }): OptionalChangeset =>\n\t\toptionalFieldEditor.set(false, ids),\n};\n\nexport const valueChangeHandler: FieldChangeHandler<OptionalChangeset, ValueFieldEditor> = {\n\t...optional.changeHandler,\n\teditor: valueFieldEditor,\n};\n\nconst requiredIdentifier = \"Value\";\n\n/**\n * Exactly one item.\n */\nexport const required = new FieldKindWithEditor(\n\trequiredIdentifier,\n\tMultiplicity.Single,\n\tvalueChangeHandler,\n\t(types, other) =>\n\t\t(other.kind.identifier === sequence.identifier ||\n\t\t\tother.kind.identifier === requiredIdentifier ||\n\t\t\tother.kind.identifier === optional.identifier ||\n\t\t\tother.kind.identifier === nodeKey.identifier) &&\n\t\tallowsTreeSchemaIdentifierSuperset(types, other.types),\n\tnew Set(),\n);\n\nconst sequenceIdentifier = \"Sequence\";\n\n/**\n * 0 or more items.\n */\nexport const sequence = new FieldKindWithEditor(\n\tsequenceIdentifier,\n\tMultiplicity.Sequence,\n\tsequenceFieldChangeHandler,\n\t(types, other) =>\n\t\tother.kind.identifier === sequenceIdentifier &&\n\t\tallowsTreeSchemaIdentifierSuperset(types, other.types),\n\t// TODO: add normalizer/importers for handling ops from other kinds.\n\tnew Set([]),\n);\n\nconst nodeKeyIdentifier = \"NodeKey\";\n\n/**\n * Exactly one identifier.\n */\nexport const nodeKey = new FieldKindWithEditor(\n\tnodeKeyIdentifier,\n\tMultiplicity.Single,\n\tnoChangeHandler,\n\t(types, other) =>\n\t\t(other.kind.identifier === sequence.identifier ||\n\t\t\tother.kind.identifier === requiredIdentifier ||\n\t\t\tother.kind.identifier === optional.identifier ||\n\t\t\tother.kind.identifier === nodeKeyIdentifier) &&\n\t\tallowsTreeSchemaIdentifierSuperset(types, other.types),\n\tnew Set(),\n);\n\n/**\n * Exactly 0 items.\n *\n * Using Forbidden makes what types are listed for allowed in a field irrelevant\n * since the field will never have values in it.\n *\n * Using Forbidden is equivalent to picking a kind that permits empty (like sequence or optional)\n * and having no allowed types (or only never types).\n * Because of this, its possible to express everything constraint wise without Forbidden,\n * but using Forbidden can be more semantically clear than optional with no allowed types.\n *\n * For view schema, this can be useful if you need to:\n * - run a specific out of schema handler when a field is present,\n * but otherwise are ignoring or tolerating (ex: via extra fields) unmentioned fields.\n * - prevent a specific field from being used as an extra field\n * (perhaps for some past of future compatibility reason)\n * - keep a field in a schema for metadata purposes\n * (ex: for improved error messaging, error handling or documentation)\n * that is not used in this specific version of the schema (ex: to document what it was or will be used for).\n *\n * For stored schema, this can be useful if you need to:\n * - have a field which can have its schema updated to Optional or Sequence of any type.\n * - to exclude a field from extra fields\n * - for the schema system to use as a default for fields which aren't declared\n * (ex: when updating a field that did not exist into one that does)\n *\n * See {@link emptyField} for a constant, reusable field using Forbidden.\n */\nexport const forbidden = new FieldKindWithEditor(\n\tforbiddenFieldKindIdentifier,\n\tMultiplicity.Forbidden,\n\tnoChangeHandler,\n\t// All multiplicities other than Value support empty.\n\t(types, other) => fieldKinds.get(other.kind.identifier)?.multiplicity !== Multiplicity.Single,\n\tnew Set(),\n);\n\n/**\n * Default field kinds by identifier\n */\nexport const fieldKinds: ReadonlyMap<FieldKindIdentifier, FieldKindWithEditor> = new Map(\n\t[required, optional, sequence, nodeKey, forbidden].map((s) => [s.identifier, s]),\n);\n\n// Create named Aliases for nicer intellisense.\n\n// TODO: Find a way to make docs like {@inheritDoc required} work in vscode.\n// TODO: ensure thy work in generated docs.\n// TODO: add these comments to the rest of the cases below.\n/**\n * @internal\n */\nexport interface Required extends FieldKind<\"Value\", Multiplicity.Single> {}\n/**\n * @internal\n */\nexport interface Optional extends FieldKind<\"Optional\", Multiplicity.Optional> {}\n/**\n * @internal\n */\nexport interface Sequence extends FieldKind<\"Sequence\", Multiplicity.Sequence> {}\n/**\n * @internal\n */\nexport interface NodeKeyFieldKind extends FieldKind<\"NodeKey\", Multiplicity.Single> {}\n/**\n * @internal\n */\nexport interface Forbidden\n\textends FieldKind<typeof forbiddenFieldKindIdentifier, Multiplicity.Forbidden> {}\n\n/**\n * Default FieldKinds with their editor types erased.\n * @internal\n */\nexport const FieldKinds: {\n\t// TODO: inheritDoc for these somehow\n\treadonly required: Required;\n\treadonly optional: Optional;\n\treadonly sequence: Sequence;\n\treadonly nodeKey: NodeKeyFieldKind;\n\treadonly forbidden: Forbidden;\n} = { required, optional, sequence, nodeKey, forbidden };\n"]}

package/dist/feature-libraries/default-schema/defaultSchema.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FullSchemaPolicy } from "../modular-schema";
+/**
+ * FullSchemaPolicy with the default field kinds.
+ * @internal
+ */
+export declare const defaultSchemaPolicy: FullSchemaPolicy;
+//# sourceMappingURL=defaultSchema.d.ts.map

package/dist/feature-libraries/default-schema/defaultSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultSchema.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGrD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,gBAEjC,CAAC"}

package/dist/feature-libraries/default-schema/defaultSchema.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.defaultSchemaPolicy = void 0;
+const defaultFieldKinds_1 = require("./defaultFieldKinds");
+/**
+ * FullSchemaPolicy with the default field kinds.
+ * @internal
+ */
+exports.defaultSchemaPolicy = {
+    fieldKinds: defaultFieldKinds_1.fieldKinds,
+};
+//# sourceMappingURL=defaultSchema.js.map

package/dist/feature-libraries/default-schema/defaultSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultSchema.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/defaultSchema.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAAiD;AAEjD;;;GAGG;AACU,QAAA,mBAAmB,GAAqB;IACpD,UAAU,EAAV,8BAAU;CACV,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FullSchemaPolicy } from \"../modular-schema\";\nimport { fieldKinds } from \"./defaultFieldKinds\";\n\n/**\n * FullSchemaPolicy with the default field kinds.\n * @internal\n */\nexport const defaultSchemaPolicy: FullSchemaPolicy = {\n\tfieldKinds,\n};\n"]}

package/dist/feature-libraries/default-schema/index.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { FieldKinds, Required, Optional, Sequence, NodeKeyFieldKind, Forbidden, fieldKinds, } from "./defaultFieldKinds";
+export { DefaultChangeset, DefaultChangeFamily, DefaultEditBuilder, IDefaultEditBuilder, ValueFieldEditBuilder, OptionalFieldEditBuilder, SequenceFieldEditBuilder, intoDelta, relevantRemovedRoots, } from "./defaultEditBuilder";
+export { defaultSchemaPolicy } from "./defaultSchema";
+//# sourceMappingURL=index.d.ts.map

package/dist/feature-libraries/default-schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,SAAS,EACT,UAAU,GACV,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACN,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,SAAS,EACT,oBAAoB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/feature-libraries/default-schema/index.js

@@ -0,0 +1,18 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultSchemaPolicy = exports.relevantRemovedRoots = exports.intoDelta = exports.DefaultEditBuilder = exports.DefaultChangeFamily = exports.fieldKinds = exports.FieldKinds = void 0;
+var defaultFieldKinds_1 = require("./defaultFieldKinds");
+Object.defineProperty(exports, "FieldKinds", { enumerable: true, get: function () { return defaultFieldKinds_1.FieldKinds; } });
+Object.defineProperty(exports, "fieldKinds", { enumerable: true, get: function () { return defaultFieldKinds_1.fieldKinds; } });
+var defaultEditBuilder_1 = require("./defaultEditBuilder");
+Object.defineProperty(exports, "DefaultChangeFamily", { enumerable: true, get: function () { return defaultEditBuilder_1.DefaultChangeFamily; } });
+Object.defineProperty(exports, "DefaultEditBuilder", { enumerable: true, get: function () { return defaultEditBuilder_1.DefaultEditBuilder; } });
+Object.defineProperty(exports, "intoDelta", { enumerable: true, get: function () { return defaultEditBuilder_1.intoDelta; } });
+Object.defineProperty(exports, "relevantRemovedRoots", { enumerable: true, get: function () { return defaultEditBuilder_1.relevantRemovedRoots; } });
+var defaultSchema_1 = require("./defaultSchema");
+Object.defineProperty(exports, "defaultSchemaPolicy", { enumerable: true, get: function () { return defaultSchema_1.defaultSchemaPolicy; } });
+//# sourceMappingURL=index.js.map

package/dist/feature-libraries/default-schema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/default-schema/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yDAQ6B;AAP5B,+GAAA,UAAU,OAAA;AAMV,+GAAA,UAAU,OAAA;AAGX,2DAU8B;AAR7B,yHAAA,mBAAmB,OAAA;AACnB,wHAAA,kBAAkB,OAAA;AAKlB,+GAAA,SAAS,OAAA;AACT,0HAAA,oBAAoB,OAAA;AAGrB,iDAAsD;AAA7C,oHAAA,mBAAmB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tFieldKinds,\n\tRequired,\n\tOptional,\n\tSequence,\n\tNodeKeyFieldKind,\n\tForbidden,\n\tfieldKinds,\n} from \"./defaultFieldKinds\";\n\nexport {\n\tDefaultChangeset,\n\tDefaultChangeFamily,\n\tDefaultEditBuilder,\n\tIDefaultEditBuilder,\n\tValueFieldEditBuilder,\n\tOptionalFieldEditBuilder,\n\tSequenceFieldEditBuilder,\n\tintoDelta,\n\trelevantRemovedRoots,\n} from \"./defaultEditBuilder\";\n\nexport { defaultSchemaPolicy } from \"./defaultSchema\";\n"]}

package/dist/feature-libraries/deltaUtils.d.ts

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ChangeAtomId, DeltaDetachedNodeId, DeltaFieldChanges, DeltaFieldMap, DeltaMark, DeltaRoot, RevisionTag } from "../core";
+export declare function nodeIdFromChangeAtom(changeAtom: ChangeAtomId, fallbackRevision?: RevisionTag): DeltaDetachedNodeId;
+/**
+ * Converts a `Delta.Root` whose tree content is represented with by `TIn` instances
+ * into a `Delta.Root`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertDeltaEqual}.
+ * @param root - The delta to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+export declare function mapRootChanges<TIn, TOut>(root: DeltaRoot<TIn>, func: (tree: TIn) => TOut): DeltaRoot<TOut>;
+/**
+ * Converts a `Delta.FieldMarks` whose tree content is represented with by `TIn` instances
+ * into a `Delta.FieldMarks`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertDeltaEqual}.
+ * @param fields - The Map of fields to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+export declare function mapFieldsChanges<TIn, TOut>(fields: DeltaFieldMap<TIn>, func: (tree: TIn) => TOut): DeltaFieldMap<TOut>;
+/**
+ * Converts a `Delta.FieldChanges` whose tree content is represented with by `TIn` instances
+ * into a `Delta.FieldChanges`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param fieldChanges - The instance to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+export declare function mapFieldChanges<TIn, TOut>(fieldChanges: DeltaFieldChanges<TIn>, func: (tree: TIn) => TOut): DeltaFieldChanges<TOut>;
+/**
+ * Converts a list of `Delta.Mark`s whose tree content is represented by `TIn` instances
+ * into a list of `Delta.Mark`s whose tree content is represented by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param list - The list of marks to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+export declare function mapMarkList<TIn, TOut>(list: readonly DeltaMark<TIn>[], func: (tree: TIn) => TOut): DeltaMark<TOut>[];
+/**
+ * Converts a `Delta.Mark` whose tree content is represented with by `TIn` instances
+ * into a `Delta.Mark`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param mark - The mark to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+export declare function mapMark<TIn, TOut>(mark: DeltaMark<TIn>, func: (tree: TIn) => TOut): DeltaMark<TOut>;
+//# sourceMappingURL=deltaUtils.d.ts.map

package/dist/feature-libraries/deltaUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltaUtils.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/deltaUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,SAAS,EAET,WAAW,EAEX,MAAM,SAAS,CAAC;AAGjB,wBAAgB,oBAAoB,CACnC,UAAU,EAAE,YAAY,EACxB,gBAAgB,CAAC,EAAE,WAAW,GAC5B,mBAAmB,CAErB;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,IAAI,EACvC,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EACpB,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GACvB,SAAS,CAAC,IAAI,CAAC,CAYjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,IAAI,EACzC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,EAC1B,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GACvB,aAAa,CAAC,IAAI,CAAC,CAMrB;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,IAAI,EACxC,YAAY,EAAE,iBAAiB,CAAC,GAAG,CAAC,EACpC,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GACvB,iBAAiB,CAAC,IAAI,CAAC,CAqBzB;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,IAAI,EACpC,IAAI,EAAE,SAAS,SAAS,CAAC,GAAG,CAAC,EAAE,EAC/B,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GACvB,SAAS,CAAC,IAAI,CAAC,EAAE,CAEnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,IAAI,EAChC,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EACpB,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GACvB,SAAS,CAAC,IAAI,CAAC,CAYjB"}

package/dist/feature-libraries/deltaUtils.js

@@ -0,0 +1,126 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapMark = exports.mapMarkList = exports.mapFieldChanges = exports.mapFieldsChanges = exports.mapRootChanges = exports.nodeIdFromChangeAtom = void 0;
+const core_1 = require("../core");
+function nodeIdFromChangeAtom(changeAtom, fallbackRevision) {
+    return (0, core_1.makeDetachedNodeId)(changeAtom.revision ?? fallbackRevision, changeAtom.localId);
+}
+exports.nodeIdFromChangeAtom = nodeIdFromChangeAtom;
+/**
+ * Converts a `Delta.Root` whose tree content is represented with by `TIn` instances
+ * into a `Delta.Root`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertDeltaEqual}.
+ * @param root - The delta to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+function mapRootChanges(root, func) {
+    const out = {};
+    if (root.fields !== undefined) {
+        out.fields = mapFieldsChanges(root.fields, func);
+    }
+    if (root.build !== undefined) {
+        out.build = root.build.map(({ id, trees }) => ({
+            id,
+            trees: trees.map(func),
+        }));
+    }
+    return out;
+}
+exports.mapRootChanges = mapRootChanges;
+/**
+ * Converts a `Delta.FieldMarks` whose tree content is represented with by `TIn` instances
+ * into a `Delta.FieldMarks`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertDeltaEqual}.
+ * @param fields - The Map of fields to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+function mapFieldsChanges(fields, func) {
+    const out = new Map();
+    for (const [k, v] of fields) {
+        out.set(k, mapFieldChanges(v, func));
+    }
+    return out;
+}
+exports.mapFieldsChanges = mapFieldsChanges;
+/**
+ * Converts a `Delta.FieldChanges` whose tree content is represented with by `TIn` instances
+ * into a `Delta.FieldChanges`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param fieldChanges - The instance to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+function mapFieldChanges(fieldChanges, func) {
+    const out = {};
+    if (fieldChanges.local !== undefined) {
+        out.local = mapMarkList(fieldChanges.local, func);
+    }
+    if (fieldChanges.global !== undefined) {
+        out.global = fieldChanges.global.map(({ id, fields }) => ({
+            id,
+            fields: mapFieldsChanges(fields, func),
+        }));
+    }
+    if (fieldChanges.build !== undefined) {
+        out.build = fieldChanges.build.map(({ id, trees }) => ({
+            id,
+            trees: trees.map(func),
+        }));
+    }
+    if (fieldChanges.rename !== undefined) {
+        out.rename = fieldChanges.rename;
+    }
+    return out;
+}
+exports.mapFieldChanges = mapFieldChanges;
+/**
+ * Converts a list of `Delta.Mark`s whose tree content is represented by `TIn` instances
+ * into a list of `Delta.Mark`s whose tree content is represented by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param list - The list of marks to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+function mapMarkList(list, func) {
+    return list.map((mark) => mapMark(mark, func));
+}
+exports.mapMarkList = mapMarkList;
+/**
+ * Converts a `Delta.Mark` whose tree content is represented with by `TIn` instances
+ * into a `Delta.Mark`whose tree content is represented with by `TOut` instances.
+ *
+ * This function is useful for converting `Delta`s that represent tree content with cursors
+ * into `Delta`s that represent tree content with a deep-comparable representation of the content.
+ * See {@link assertMarkListEqual}.
+ * @param mark - The mark to convert. Not mutated.
+ * @param func - The functions used to map tree content.
+ */
+function mapMark(mark, func) {
+    const out = { count: mark.count };
+    if (mark.fields !== undefined) {
+        out.fields = mapFieldsChanges(mark.fields, func);
+    }
+    if (mark.detach !== undefined) {
+        out.detach = mark.detach;
+    }
+    if (mark.attach !== undefined) {
+        out.attach = mark.attach;
+    }
+    return out;
+}
+exports.mapMark = mapMark;
+//# sourceMappingURL=deltaUtils.js.map

package/dist/feature-libraries/deltaUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltaUtils.js","sourceRoot":"","sources":["../../src/feature-libraries/deltaUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kCAUiB;AAGjB,SAAgB,oBAAoB,CACnC,UAAwB,EACxB,gBAA8B;IAE9B,OAAO,IAAA,yBAAkB,EAAC,UAAU,CAAC,QAAQ,IAAI,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;AACxF,CAAC;AALD,oDAKC;AAED;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAC7B,IAAoB,EACpB,IAAyB;IAEzB,MAAM,GAAG,GAA6B,EAAE,CAAC;IACzC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9B,GAAG,CAAC,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACjD;IACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;QAC7B,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9C,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;SACtB,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAfD,wCAeC;AAED;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAC/B,MAA0B,EAC1B,IAAyB;IAEzB,MAAM,GAAG,GAA2C,IAAI,GAAG,EAAE,CAAC;IAC9D,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE;QAC5B,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;KACrC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AATD,4CASC;AAED;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC9B,YAAoC,EACpC,IAAyB;IAEzB,MAAM,GAAG,GAAqC,EAAE,CAAC;IACjD,IAAI,YAAY,CAAC,KAAK,KAAK,SAAS,EAAE;QACrC,GAAG,CAAC,KAAK,GAAG,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;KAClD;IACD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE;QACtC,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;YACzD,EAAE;YACF,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC;SACtC,CAAC,CAAC,CAAC;KACJ;IACD,IAAI,YAAY,CAAC,KAAK,KAAK,SAAS,EAAE;QACrC,GAAG,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACtD,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;SACtB,CAAC,CAAC,CAAC;KACJ;IACD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE;QACtC,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;KACjC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAxBD,0CAwBC;AAED;;;;;;;;;GASG;AACH,SAAgB,WAAW,CAC1B,IAA+B,EAC/B,IAAyB;IAEzB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAChE,CAAC;AALD,kCAKC;AAED;;;;;;;;;GASG;AACH,SAAgB,OAAO,CACtB,IAAoB,EACpB,IAAyB;IAEzB,MAAM,GAAG,GAA6B,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC5D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9B,GAAG,CAAC,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACjD;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;KACzB;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;QAC9B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;KACzB;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAfD,0BAeC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tChangeAtomId,\n\tDeltaDetachedNodeId,\n\tDeltaFieldChanges,\n\tDeltaFieldMap,\n\tDeltaMark,\n\tDeltaRoot,\n\tFieldKey,\n\tRevisionTag,\n\tmakeDetachedNodeId,\n} from \"../core\";\nimport { Mutable } from \"../util\";\n\nexport function nodeIdFromChangeAtom(\n\tchangeAtom: ChangeAtomId,\n\tfallbackRevision?: RevisionTag,\n): DeltaDetachedNodeId {\n\treturn makeDetachedNodeId(changeAtom.revision ?? fallbackRevision, changeAtom.localId);\n}\n\n/**\n * Converts a `Delta.Root` whose tree content is represented with by `TIn` instances\n * into a `Delta.Root`whose tree content is represented with by `TOut` instances.\n *\n * This function is useful for converting `Delta`s that represent tree content with cursors\n * into `Delta`s that represent tree content with a deep-comparable representation of the content.\n * See {@link assertDeltaEqual}.\n * @param root - The delta to convert. Not mutated.\n * @param func - The functions used to map tree content.\n */\nexport function mapRootChanges<TIn, TOut>(\n\troot: DeltaRoot<TIn>,\n\tfunc: (tree: TIn) => TOut,\n): DeltaRoot<TOut> {\n\tconst out: Mutable<DeltaRoot<TOut>> = {};\n\tif (root.fields !== undefined) {\n\t\tout.fields = mapFieldsChanges(root.fields, func);\n\t}\n\tif (root.build !== undefined) {\n\t\tout.build = root.build.map(({ id, trees }) => ({\n\t\t\tid,\n\t\t\ttrees: trees.map(func),\n\t\t}));\n\t}\n\treturn out;\n}\n\n/**\n * Converts a `Delta.FieldMarks` whose tree content is represented with by `TIn` instances\n * into a `Delta.FieldMarks`whose tree content is represented with by `TOut` instances.\n *\n * This function is useful for converting `Delta`s that represent tree content with cursors\n * into `Delta`s that represent tree content with a deep-comparable representation of the content.\n * See {@link assertDeltaEqual}.\n * @param fields - The Map of fields to convert. Not mutated.\n * @param func - The functions used to map tree content.\n */\nexport function mapFieldsChanges<TIn, TOut>(\n\tfields: DeltaFieldMap<TIn>,\n\tfunc: (tree: TIn) => TOut,\n): DeltaFieldMap<TOut> {\n\tconst out: Map<FieldKey, DeltaFieldChanges<TOut>> = new Map();\n\tfor (const [k, v] of fields) {\n\t\tout.set(k, mapFieldChanges(v, func));\n\t}\n\treturn out;\n}\n\n/**\n * Converts a `Delta.FieldChanges` whose tree content is represented with by `TIn` instances\n * into a `Delta.FieldChanges`whose tree content is represented with by `TOut` instances.\n *\n * This function is useful for converting `Delta`s that represent tree content with cursors\n * into `Delta`s that represent tree content with a deep-comparable representation of the content.\n * See {@link assertMarkListEqual}.\n * @param fieldChanges - The instance to convert. Not mutated.\n * @param func - The functions used to map tree content.\n */\nexport function mapFieldChanges<TIn, TOut>(\n\tfieldChanges: DeltaFieldChanges<TIn>,\n\tfunc: (tree: TIn) => TOut,\n): DeltaFieldChanges<TOut> {\n\tconst out: Mutable<DeltaFieldChanges<TOut>> = {};\n\tif (fieldChanges.local !== undefined) {\n\t\tout.local = mapMarkList(fieldChanges.local, func);\n\t}\n\tif (fieldChanges.global !== undefined) {\n\t\tout.global = fieldChanges.global.map(({ id, fields }) => ({\n\t\t\tid,\n\t\t\tfields: mapFieldsChanges(fields, func),\n\t\t}));\n\t}\n\tif (fieldChanges.build !== undefined) {\n\t\tout.build = fieldChanges.build.map(({ id, trees }) => ({\n\t\t\tid,\n\t\t\ttrees: trees.map(func),\n\t\t}));\n\t}\n\tif (fieldChanges.rename !== undefined) {\n\t\tout.rename = fieldChanges.rename;\n\t}\n\treturn out;\n}\n\n/**\n * Converts a list of `Delta.Mark`s whose tree content is represented by `TIn` instances\n * into a list of `Delta.Mark`s whose tree content is represented by `TOut` instances.\n *\n * This function is useful for converting `Delta`s that represent tree content with cursors\n * into `Delta`s that represent tree content with a deep-comparable representation of the content.\n * See {@link assertMarkListEqual}.\n * @param list - The list of marks to convert. Not mutated.\n * @param func - The functions used to map tree content.\n */\nexport function mapMarkList<TIn, TOut>(\n\tlist: readonly DeltaMark<TIn>[],\n\tfunc: (tree: TIn) => TOut,\n): DeltaMark<TOut>[] {\n\treturn list.map((mark: DeltaMark<TIn>) => mapMark(mark, func));\n}\n\n/**\n * Converts a `Delta.Mark` whose tree content is represented with by `TIn` instances\n * into a `Delta.Mark`whose tree content is represented with by `TOut` instances.\n *\n * This function is useful for converting `Delta`s that represent tree content with cursors\n * into `Delta`s that represent tree content with a deep-comparable representation of the content.\n * See {@link assertMarkListEqual}.\n * @param mark - The mark to convert. Not mutated.\n * @param func - The functions used to map tree content.\n */\nexport function mapMark<TIn, TOut>(\n\tmark: DeltaMark<TIn>,\n\tfunc: (tree: TIn) => TOut,\n): DeltaMark<TOut> {\n\tconst out: Mutable<DeltaMark<TOut>> = { count: mark.count };\n\tif (mark.fields !== undefined) {\n\t\tout.fields = mapFieldsChanges(mark.fields, func);\n\t}\n\tif (mark.detach !== undefined) {\n\t\tout.detach = mark.detach;\n\t}\n\tif (mark.attach !== undefined) {\n\t\tout.attach = mark.attach;\n\t}\n\treturn out;\n}\n"]}

package/dist/feature-libraries/detachedFieldIndexSummarizer.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
+import { IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { DetachedFieldIndex } from "../core";
+import { Summarizable, SummaryElementParser, SummaryElementStringifier } from "../shared-tree-core";
+/**
+ * Provides methods for summarizing and loading a tree index.
+ */
+export declare class DetachedFieldIndexSummarizer implements Summarizable {
+    private readonly detachedFieldIndex;
+    readonly key = "DetachedFieldIndex";
+    constructor(detachedFieldIndex: DetachedFieldIndex);
+    getAttachSummary(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    summarize(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    load(services: IChannelStorageService, parse: SummaryElementParser): Promise<void>;
+}
+//# sourceMappingURL=detachedFieldIndexSummarizer.d.ts.map

package/dist/feature-libraries/detachedFieldIndexSummarizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detachedFieldIndexSummarizer.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/detachedFieldIndexSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAOpG;;GAEG;AACH,qBAAa,4BAA6B,YAAW,YAAY;IAG7C,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAFtD,SAAgB,GAAG,wBAAwB;gBAEP,kBAAkB,EAAE,kBAAkB;IAEnE,gBAAgB,CACtB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAIX,SAAS,CACrB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAI1B,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAU7C,IAAI,CAChB,QAAQ,EAAE,sBAAsB,EAChC,KAAK,EAAE,oBAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;CAOhB"}

package/dist/feature-libraries/detachedFieldIndexSummarizer.js

@@ -0,0 +1,46 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DetachedFieldIndexSummarizer = void 0;
+const shared_object_base_1 = require("@fluidframework/shared-object-base");
+const client_utils_1 = require("@fluid-internal/client-utils");
+/**
+ * The storage key for the blob in the summary containing schema data
+ */
+const detachedFieldIndexBlobKey = "DetachedFieldIndexBlob";
+/**
+ * Provides methods for summarizing and loading a tree index.
+ */
+class DetachedFieldIndexSummarizer {
+    constructor(detachedFieldIndex) {
+        this.detachedFieldIndex = detachedFieldIndex;
+        this.key = "DetachedFieldIndex";
+    }
+    getAttachSummary(stringify, fullTree, trackState, telemetryContext) {
+        return (0, shared_object_base_1.createSingleBlobSummary)(detachedFieldIndexBlobKey, this.detachedFieldIndex.encode());
+    }
+    async summarize(stringify, fullTree, trackState, telemetryContext) {
+        return (0, shared_object_base_1.createSingleBlobSummary)(detachedFieldIndexBlobKey, this.detachedFieldIndex.encode());
+    }
+    getGCData(fullGC) {
+        // TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically
+        // by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates
+        // to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each
+        // blob.
+        return {
+            gcNodes: {},
+        };
+    }
+    async load(services, parse) {
+        if (await services.contains(detachedFieldIndexBlobKey)) {
+            const detachedFieldIndexBuffer = await services.readBlob(detachedFieldIndexBlobKey);
+            const treeBufferString = (0, client_utils_1.bufferToString)(detachedFieldIndexBuffer, "utf8");
+            this.detachedFieldIndex.loadData(treeBufferString);
+        }
+    }
+}
+exports.DetachedFieldIndexSummarizer = DetachedFieldIndexSummarizer;
+//# sourceMappingURL=detachedFieldIndexSummarizer.js.map

package/dist/feature-libraries/detachedFieldIndexSummarizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detachedFieldIndexSummarizer.js","sourceRoot":"","sources":["../../src/feature-libraries/detachedFieldIndexSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,2EAA6E;AAE7E,+DAA8D;AAI9D;;GAEG;AACH,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAE3D;;GAEG;AACH,MAAa,4BAA4B;IAGxC,YAAoC,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QAF1D,QAAG,GAAG,oBAAoB,CAAC;IAEkC,CAAC;IAEvE,gBAAgB,CACtB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC;QAEpC,OAAO,IAAA,4CAAuB,EAAC,yBAAyB,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7F,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC;QAEpC,OAAO,IAAA,4CAAuB,EAAC,yBAAyB,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7F,CAAC;IAEM,SAAS,CAAC,MAAgB;QAChC,wGAAwG;QACxG,0GAA0G;QAC1G,2GAA2G;QAC3G,QAAQ;QACR,OAAO;YACN,OAAO,EAAE,EAAE;SACX,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAChB,QAAgC,EAChC,KAA2B;QAE3B,IAAI,MAAM,QAAQ,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE;YACvD,MAAM,wBAAwB,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;YACpF,MAAM,gBAAgB,GAAG,IAAA,6BAAc,EAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;YAC1E,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;SACnD;IACF,CAAC;CACD;AA3CD,oEA2CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIGarbageCollectionData,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary } from \"@fluidframework/shared-object-base\";\nimport { IChannelStorageService } from \"@fluidframework/datastore-definitions\";\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { DetachedFieldIndex } from \"../core\";\nimport { Summarizable, SummaryElementParser, SummaryElementStringifier } from \"../shared-tree-core\";\n\n/**\n * The storage key for the blob in the summary containing schema data\n */\nconst detachedFieldIndexBlobKey = \"DetachedFieldIndexBlob\";\n\n/**\n * Provides methods for summarizing and loading a tree index.\n */\nexport class DetachedFieldIndexSummarizer implements Summarizable {\n\tpublic readonly key = \"DetachedFieldIndex\";\n\n\tpublic constructor(private readonly detachedFieldIndex: DetachedFieldIndex) {}\n\n\tpublic getAttachSummary(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats {\n\t\treturn createSingleBlobSummary(detachedFieldIndexBlobKey, this.detachedFieldIndex.encode());\n\t}\n\n\tpublic async summarize(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats> {\n\t\treturn createSingleBlobSummary(detachedFieldIndexBlobKey, this.detachedFieldIndex.encode());\n\t}\n\n\tpublic getGCData(fullGC?: boolean): IGarbageCollectionData {\n\t\t// TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically\n\t\t// by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates\n\t\t// to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each\n\t\t// blob.\n\t\treturn {\n\t\t\tgcNodes: {},\n\t\t};\n\t}\n\n\tpublic async load(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t): Promise<void> {\n\t\tif (await services.contains(detachedFieldIndexBlobKey)) {\n\t\t\tconst detachedFieldIndexBuffer = await services.readBlob(detachedFieldIndexBlobKey);\n\t\t\tconst treeBufferString = bufferToString(detachedFieldIndexBuffer, \"utf8\");\n\t\t\tthis.detachedFieldIndex.loadData(treeBufferString);\n\t\t}\n\t}\n}\n"]}