@fluidframework/tree 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/dist/shared-tree/schematizingTreeView.js.map

@@ -1 +1 @@
-{"version":3,"file":"schematizingTreeView.js","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,2DAAqE;AACrE,qEAA6D;AAC7D,+CAA0F;AAC1F,4DAKuC;AACvC,iDAA0F;AAC1F,+CAAiD;AACjD,sDASiC;AACjC,2DAA4F;AAE5F,+CAAqD;AAErD;;GAEG;AACH,MAAa,0BAA0B;IAmBtC,YACiB,QAAsB,EACtB,MAAsC,EACtC,cAA8B,EAC9B,eAAyB;QAHzB,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAgC;QACtC,mBAAc,GAAd,cAAc,CAAgB;QAC9B,oBAAe,GAAf,eAAe,CAAU;QAZ1B,WAAM,GAEU,IAAA,wBAAa,GAAE,CAAC;QAIxC,aAAQ,GAAG,KAAK,CAAC;QAQxB,IAAI,CAAC,UAAU,GAAG,IAAA,uBAAY,EAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAU,CAAC,8BAAmB,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,EAAE,CAAC;IACf,CAAC;IAEM,aAAa;QACnB,sBAAsB;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAEzB,yBAAyB;QACzB,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,OAAO;SACP;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,EAAE;YACpC,MAAM,IAAI,4BAAU,CACnB,uEAAuE,CACvE,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAA,gCAAY,EAC1B,IAAI,CAAC,UAAU;QACf,sCAAsC;QACtC,4BAAiB,CAAC,gBAAgB,GAAG,4BAAiB,CAAC,UAAU,EACjE,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,CACf,CAAC;QACF,IAAA,mBAAM,EAAC,MAAM,EAAE,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,cAAc;QACpB,IAAI,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,4BAAU,CAAC,+BAA+B,CAAC,CAAC;SACtD;QACD,IAAA,mBAAM,EAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,MAAM;QACb,iGAAiG;QACjG,wGAAwG;QAExG,MAAM,aAAa,GAAG,IAAA,kCAAc,EACnC,IAAI,CAAC,UAAU;QACf,sCAAsC;QACtC,4BAAiB,CAAC,gBAAgB,GAAG,4BAAiB,CAAC,UAAU,EACjE,IAAI,CAAC,QAAQ,CACb,CAAC;QACF,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,QAAQ,aAAa,EAAE;YACtB,KAAK,8BAAU,CAAC,IAAI,CAAC,CAAC;gBACrB,mDAAmD;gBACnD,IAAI,CAAC,IAAI,GAAG,aAAa,CACxB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,GAAG,EAAE;oBACJ,IAAA,mBAAM,EAAC,qBAAqB,KAAK,SAAS,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;oBACzE,qBAAqB,EAAE,CAAC;oBACxB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;oBACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;wBACnB,IAAI,CAAC,MAAM,EAAE,CAAC;qBACd;gBACF,CAAC,EACD,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,eAAe,CACpB,CAAC;gBAEF,2DAA2D;gBAC3D,wFAAwF;gBACxF,8BAA8B;gBAC9B,uEAAuE;gBACvE,sIAAsI;gBACtI,4DAA4D;gBAC5D,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;gBACzB,MAAM,qBAAqB,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;oBACxE,IAAI,QAAQ,KAAK,IAAI,CAAC,IAAI,EAAE;wBAC3B,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;wBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;qBAChC;gBACF,CAAC,CAAC,CAAC;gBACH,MAAM;aACN;YACD,KAAK,8BAAU,CAAC,YAAY,CAAC;YAC7B,KAAK,8BAAU,CAAC,UAAU,CAAC;YAC3B,KAAK,8BAAU,CAAC,gBAAgB,CAAC,CAAC;gBACjC,IAAI,CAAC,IAAI,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;gBAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;oBAC1E,UAAU,EAAE,CAAC;oBACb,IAAI,CAAC,MAAM,EAAE,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,MAAM;aACN;YACD,OAAO,CAAC,CAAC;gBACR,IAAA,4BAAe,EAAC,aAAa,CAAC,CAAC;aAC/B;SACD;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAEO,WAAW;QAClB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,YAAY,eAAe,CAAC,EAAE;YACvE,IAAI,CAAC,IAAI,CAAC,wBAAa,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACtB;IACF,CAAC;IAED,IAAW,KAAK;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,OAAO,IAAI,YAAY,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IAEM,CAAC,wBAAa,CAAC;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,IAAI,IAAI,YAAY,eAAe,EAAE;YACpC,MAAM,IAAI,4BAAU,CACnB,iFAAiF,CACjF,CAAC;SACF;QACD,OAAO,IAAA,2BAAgB,EAAC,IAAI,CAAC,QAAQ,CAA4C,CAAC;IACnF,CAAC;CACD;AAnKD,gEAmKC;AAED,MAAa,eAAe;IAC3B,YAAmC,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE7D,IAAW,UAAU;QACpB,OAAO,CACN,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,UAAU;YACzC,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,gBAAgB,CAC/C,CAAC;IACH,CAAC;IAED,IAAW,aAAa;QACvB,OAAO,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,UAAU,CAAC;IAClD,CAAC;CACD;AAbD,0CAaC;AAED;;;;;;GAMG;AACH,MAAM,QAAQ,GAAG,IAAA,qBAAU,GAA6B,CAAC;AAEzD;;;;GAIG;AACH,SAAgB,aAAa,CAC5B,QAAsB,EACtB,UAA6B,EAC7B,SAAqB,EACrB,cAA8B,EAC9B,eAAyB;IAEzB,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5C,IAAA,mBAAM,EAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAElF;QACC,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3E,IAAA,mBAAM,EACL,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU;YAC/C,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAChD,KAAK,CAAC,oDAAoD,CAC1D,CAAC;KACF;IAED,MAAM,IAAI,GAAG,IAAI,kCAAoB,CACpC,QAAQ,EACR,UAAU,CAAC,MAAM,EACjB,cAAc,EACd,eAAe,EACf,GAAG,EAAE;QACJ,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAA,mBAAM,EAAC,OAAO,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChD,SAAS,EAAE,CAAC;IACb,CAAC,CACD,CAAC;IACF,IAAA,mBAAM,EAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAClF,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAE1B,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACrE,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3E,IACC,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU;YAChD,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAC9C;YACD,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,wBAAa,CAAC,EAAE,CAAC;SACtB;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACb,CAAC;AA7CD,sCA6CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { assert, unreachableCase } from \"@fluidframework/core-utils\";\nimport { UsageError } from \"@fluidframework/telemetry-utils\";\nimport { FieldKey, AllowedUpdateType, anchorSlot, Compatibility } from \"../core/index.js\";\nimport {\n\tdefaultSchemaPolicy,\n\tFlexFieldSchema,\n\tViewSchema,\n\tNodeKeyManager,\n} from \"../feature-libraries/index.js\";\nimport { HasListeners, IEmitter, ISubscribable, createEmitter } from \"../events/index.js\";\nimport { disposeSymbol } from \"../util/index.js\";\nimport {\n\tTreeConfiguration,\n\ttoFlexConfig,\n\tImplicitFieldSchema,\n\tTreeFieldFromImplicitField,\n\tTreeView,\n\tTreeViewEvents,\n\tgetProxyForField,\n\tSchemaIncompatible,\n} from \"../simple-tree/index.js\";\nimport { TreeContent, UpdateType, ensureSchema, evaluateUpdate } from \"./schematizeTree.js\";\nimport { TreeCheckout } from \"./treeCheckout.js\";\nimport { CheckoutFlexTreeView } from \"./treeView.js\";\n\n/**\n * Implementation of TreeView wrapping a FlexTreeView.\n */\nexport class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitFieldSchema>\n\timplements TreeView<TreeFieldFromImplicitField<TRootSchema>>\n{\n\t/**\n\t * In one of three states:\n\t * 1. Valid: A checkout is present, not disposed, and it's stored schema and view schema are compatible.\n\t * 2. SchematizeError: stored schema and view schema are not compatible.\n\t * 3. disposed: `view` is undefined, and using this object will error. Some methods also transiently leave view undefined.\n\t */\n\tprivate view: CheckoutFlexTreeView<FlexFieldSchema> | SchematizeError | undefined;\n\tprivate readonly flexConfig: TreeContent;\n\tpublic readonly events: ISubscribable<TreeViewEvents> &\n\t\tIEmitter<TreeViewEvents> &\n\t\tHasListeners<TreeViewEvents> = createEmitter();\n\n\tprivate readonly viewSchema: ViewSchema;\n\n\tprivate disposed = false;\n\n\tpublic constructor(\n\t\tpublic readonly checkout: TreeCheckout,\n\t\tpublic readonly config: TreeConfiguration<TRootSchema>,\n\t\tpublic readonly nodeKeyManager: NodeKeyManager,\n\t\tpublic readonly nodeKeyFieldKey: FieldKey,\n\t) {\n\t\tthis.flexConfig = toFlexConfig(config);\n\t\tthis.viewSchema = new ViewSchema(defaultSchemaPolicy, {}, this.flexConfig.schema);\n\t\tthis.update();\n\t}\n\n\tpublic upgradeSchema(): void {\n\t\t// Errors if disposed.\n\t\tconst error = this.error;\n\n\t\t// No-op non error state.\n\t\tif (error === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (this.error?.canUpgrade !== true) {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Existing stored schema can not be upgraded (see TreeView.canUpgrade).\",\n\t\t\t);\n\t\t}\n\n\t\tconst result = ensureSchema(\n\t\t\tthis.viewSchema,\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\tAllowedUpdateType.SchemaCompatible | AllowedUpdateType.Initialize,\n\t\t\tthis.checkout,\n\t\t\tthis.flexConfig,\n\t\t);\n\t\tassert(result, 0x8bf /* Schema upgrade should always work if canUpgrade is set. */);\n\t}\n\n\t/**\n\t * Gets the view is the stored schema is compatible with the view schema,\n\t * otherwise returns an error detailing the schema incompatibility.\n\t */\n\tpublic getViewOrError(): CheckoutFlexTreeView<FlexFieldSchema> | SchematizeError {\n\t\tif (this.disposed) {\n\t\t\tthrow new UsageError(\"Accessed a disposed TreeView.\");\n\t\t}\n\t\tassert(this.view !== undefined, 0x8c0 /* unexpected getViewOrError */);\n\t\treturn this.view;\n\t}\n\n\t/**\n\t * Updates `this.view`.\n\t * Invoked during initialization and when `this.view` needs to be replaced due to stored schema changes.\n\t * Handled re-registering for events to call update in the future.\n\t * @remarks\n\t * This does not check if the view needs to be replaced, it replaces it unconditionally:\n\t * callers should do any checking to detect if its really needed before calling `update`.\n\t */\n\tprivate update(): void {\n\t\t// This implementation avoids making any edits, which prevents it from being invoked reentrantly.\n\t\t// If implicit initialization (or some other edit) is desired, it should be done outside of this method.\n\n\t\tconst compatibility = evaluateUpdate(\n\t\t\tthis.viewSchema,\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\tAllowedUpdateType.SchemaCompatible | AllowedUpdateType.Initialize,\n\t\t\tthis.checkout,\n\t\t);\n\t\tthis.disposeView();\n\t\tswitch (compatibility) {\n\t\t\tcase UpdateType.None: {\n\t\t\t\t// Remove event from checkout when view is disposed\n\t\t\t\tthis.view = requireSchema(\n\t\t\t\t\tthis.checkout,\n\t\t\t\t\tthis.viewSchema,\n\t\t\t\t\t() => {\n\t\t\t\t\t\tassert(cleanupCheckOutEvents !== undefined, 0x8c1 /* missing cleanup */);\n\t\t\t\t\t\tcleanupCheckOutEvents();\n\t\t\t\t\t\tthis.view = undefined;\n\t\t\t\t\t\tif (!this.disposed) {\n\t\t\t\t\t\t\tthis.update();\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\tthis.nodeKeyManager,\n\t\t\t\t\tthis.nodeKeyFieldKey,\n\t\t\t\t);\n\n\t\t\t\t// Trigger \"rootChanged\" if the root changes in the future.\n\t\t\t\t// Currently there is no good way to do this as FlexTreeField has no events for changes.\n\t\t\t\t// this.view.flexTree.on(????)\n\t\t\t\t// As a workaround for the above, trigger \"rootChanged\" in \"afterBatch\"\n\t\t\t\t// which isn't the correct time since we normally do events during the batch when the forest is modified, but its better than nothing.\n\t\t\t\t// TODO: provide a better event: this.view.flexTree.on(????)\n\t\t\t\tlet lastRoot = this.root;\n\t\t\t\tconst cleanupCheckOutEvents = this.checkout.events.on(\"afterBatch\", () => {\n\t\t\t\t\tif (lastRoot !== this.root) {\n\t\t\t\t\t\tlastRoot = this.root;\n\t\t\t\t\t\tthis.events.emit(\"rootChanged\");\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase UpdateType.Incompatible:\n\t\t\tcase UpdateType.Initialize:\n\t\t\tcase UpdateType.SchemaCompatible: {\n\t\t\t\tthis.view = new SchematizeError(compatibility);\n\t\t\t\tconst unregister = this.checkout.storedSchema.on(\"afterSchemaChange\", () => {\n\t\t\t\t\tunregister();\n\t\t\t\t\tthis.update();\n\t\t\t\t});\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(compatibility);\n\t\t\t}\n\t\t}\n\t\tthis.events.emit(\"rootChanged\");\n\t}\n\n\tprivate disposeView(): void {\n\t\tif (this.view !== undefined && !(this.view instanceof SchematizeError)) {\n\t\t\tthis.view[disposeSymbol]();\n\t\t\tthis.view = undefined;\n\t\t}\n\t}\n\n\tpublic get error(): SchematizeError | undefined {\n\t\tconst view = this.getViewOrError();\n\t\treturn view instanceof SchematizeError ? view : undefined;\n\t}\n\n\tpublic [disposeSymbol](): void {\n\t\tthis.getViewOrError();\n\t\tthis.disposed = true;\n\t\tthis.disposeView();\n\t}\n\n\tpublic get root(): TreeFieldFromImplicitField<TRootSchema> {\n\t\tconst view = this.getViewOrError();\n\t\tif (view instanceof SchematizeError) {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Document is out of schema. Check TreeView.error before accessing TreeView.root.\",\n\t\t\t);\n\t\t}\n\t\treturn getProxyForField(view.flexTree) as TreeFieldFromImplicitField<TRootSchema>;\n\t}\n}\n\nexport class SchematizeError implements SchemaIncompatible {\n\tpublic constructor(public readonly updateType: UpdateType) {}\n\n\tpublic get canUpgrade(): boolean {\n\t\treturn (\n\t\t\tthis.updateType === UpdateType.Initialize ||\n\t\t\tthis.updateType === UpdateType.SchemaCompatible\n\t\t);\n\t}\n\n\tpublic get canInitialize(): boolean {\n\t\treturn this.updateType === UpdateType.Initialize;\n\t}\n}\n\n/**\n * Creating multiple flex tree contexts for the same branch, and thus with the same underlying AnchorSet does not work due to how TreeNode caching works.\n * This slot is used to detect if one already exists and error if creating a second.\n *\n * TODO:\n * 1. API docs need to reflect this limitation or the limitation has to be removed.\n */\nconst ViewSlot = anchorSlot<CheckoutFlexTreeView<any>>();\n\n/**\n * Flex-Tree schematizing layer.\n * Creates a view that self-disposes when stored schema becomes incompatible.\n * This may only be called when the schema is already known to be compatible (typically via ensureSchema).\n */\nexport function requireSchema<TRoot extends FlexFieldSchema>(\n\tcheckout: TreeCheckout,\n\tviewSchema: ViewSchema<TRoot>,\n\tonDispose: () => void,\n\tnodeKeyManager: NodeKeyManager,\n\tnodeKeyFieldKey: FieldKey,\n): CheckoutFlexTreeView<TRoot> {\n\tconst slots = checkout.forest.anchors.slots;\n\tassert(!slots.has(ViewSlot), 0x8c2 /* Cannot create second view from checkout */);\n\n\t{\n\t\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\t\tassert(\n\t\t\tcompatibility.write === Compatibility.Compatible &&\n\t\t\t\tcompatibility.read === Compatibility.Compatible,\n\t\t\t0x8c3 /* requireSchema invoked with incompatible schema */,\n\t\t);\n\t}\n\n\tconst view = new CheckoutFlexTreeView(\n\t\tcheckout,\n\t\tviewSchema.schema,\n\t\tnodeKeyManager,\n\t\tnodeKeyFieldKey,\n\t\t() => {\n\t\t\tconst deleted = slots.delete(ViewSlot);\n\t\t\tassert(deleted, 0x8c4 /* unexpected dispose */);\n\t\t\tonDispose();\n\t\t},\n\t);\n\tassert(!slots.has(ViewSlot), 0x8c5 /* Cannot create second view from checkout */);\n\tslots.set(ViewSlot, view);\n\n\tconst unregister = checkout.storedSchema.on(\"afterSchemaChange\", () => {\n\t\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\t\tif (\n\t\t\tcompatibility.write !== Compatibility.Compatible ||\n\t\t\tcompatibility.read !== Compatibility.Compatible\n\t\t) {\n\t\t\tunregister();\n\t\t\tview[disposeSymbol]();\n\t\t}\n\t});\n\n\treturn view;\n}\n"]}
+{"version":3,"file":"schematizingTreeView.js","sourceRoot":"","sources":["../../src/shared-tree/schematizingTreeView.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA8E;AAC9E,uEAAsE;AAEtE,+CAA8E;AAC9E,iDAA0F;AAC1F,4DAMuC;AACvC,sDAciC;AACjC,+CAAiD;AAEjD,2DAA4F;AAE5F,+CAAqD;AAErD;;GAEG;AACH,MAAa,0BAA0B;IAsBtC,YACiB,QAAsB,EACtB,MAAsC,EACtC,cAA8B,EAC9B,eAAyB;QAHzB,aAAQ,GAAR,QAAQ,CAAc;QACtB,WAAM,GAAN,MAAM,CAAgC;QACtC,mBAAc,GAAd,cAAc,CAAgB;QAC9B,oBAAe,GAAf,eAAe,CAAU;QAf1B,WAAM,GAEU,IAAA,wBAAa,GAAE,CAAC;QAI/B,wBAAmB,GAAG,IAAI,GAAG,EAAc,CAAC;QACrD,aAAQ,GAAG,KAAK,CAAC;QAUxB,IAAI,CAAC,eAAe,GAAG,IAAA,+BAAoB,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAA,uBAAY,EAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAU,CAAC,8BAAmB,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,CAChE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,aAAa,CAAC,CACtD,CACD,CAAC;IACH,CAAC;IAEM,aAAa;QACnB,sBAAsB;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAEzB,yBAAyB;QACzB,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,OAAO;SACP;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,EAAE;YACpC,MAAM,IAAI,qBAAU,CACnB,uEAAuE,CACvE,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAA,gCAAY,EAC1B,IAAI,CAAC,UAAU;QACf,sCAAsC;QACtC,4BAAiB,CAAC,gBAAgB,GAAG,4BAAiB,CAAC,UAAU,EACjE,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,CACf,CAAC;QACF,IAAA,iBAAM,EAAC,MAAM,EAAE,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,cAAc;QACpB,IAAI,IAAI,CAAC,QAAQ,EAAE;YAClB,MAAM,IAAI,qBAAU,CAAC,+BAA+B,CAAC,CAAC;SACtD;QACD,IAAA,iBAAM,EAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,MAAM;QACb,iGAAiG;QACjG,wGAAwG;QAExG,MAAM,aAAa,GAAG,IAAA,kCAAc,EACnC,IAAI,CAAC,UAAU;QACf,sCAAsC;QACtC,4BAAiB,CAAC,gBAAgB,GAAG,4BAAiB,CAAC,UAAU,EACjE,IAAI,CAAC,QAAQ,CACb,CAAC;QACF,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,QAAQ,aAAa,EAAE;YACtB,KAAK,8BAAU,CAAC,IAAI,CAAC,CAAC;gBACrB,mDAAmD;gBACnD,IAAI,CAAC,IAAI,GAAG,aAAa,CACxB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,UAAU,EACf,GAAG,EAAE;oBACJ,IAAA,iBAAM,EAAC,qBAAqB,KAAK,SAAS,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;oBACzE,qBAAqB,EAAE,CAAC;oBACxB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;oBACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;wBACnB,IAAI,CAAC,MAAM,EAAE,CAAC;qBACd;gBACF,CAAC,EACD,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,eAAe,CACpB,CAAC;gBAEF,2DAA2D;gBAC3D,wFAAwF;gBACxF,8BAA8B;gBAC9B,uEAAuE;gBACvE,sIAAsI;gBACtI,4DAA4D;gBAC5D,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;gBACzB,MAAM,qBAAqB,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;oBACxE,IAAI,QAAQ,KAAK,IAAI,CAAC,IAAI,EAAE;wBAC3B,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;wBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;qBAChC;gBACF,CAAC,CAAC,CAAC;gBACH,MAAM;aACN;YACD,KAAK,8BAAU,CAAC,YAAY,CAAC;YAC7B,KAAK,8BAAU,CAAC,UAAU,CAAC;YAC3B,KAAK,8BAAU,CAAC,gBAAgB,CAAC,CAAC;gBACjC,IAAI,CAAC,IAAI,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;gBAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;oBAC1E,UAAU,EAAE,CAAC;oBACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACzC,MAAM;aACN;YACD,OAAO,CAAC,CAAC;gBACR,IAAA,0BAAe,EAAC,aAAa,CAAC,CAAC;aAC/B;SACD;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAEO,WAAW;QAClB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,YAAY,eAAe,CAAC,EAAE;YACvE,IAAI,CAAC,IAAI,CAAC,wBAAa,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;YACtB,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;SAC/D;IACF,CAAC;IAED,IAAW,KAAK;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,OAAO,IAAI,YAAY,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IAEM,CAAC,wBAAa,CAAC;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,IAAI,IAAI,YAAY,eAAe,EAAE;YACpC,MAAM,IAAI,qBAAU,CACnB,iFAAiF,CACjF,CAAC;SACF;QACD,OAAO,IAAA,2BAAgB,EAAC,IAAI,CAAC,QAAQ,CAA4C,CAAC;IACnF,CAAC;IAED,IAAW,IAAI,CAAC,OAA0D;QACzE,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,IAAI,IAAI,YAAY,eAAe,EAAE;YACpC,MAAM,IAAI,qBAAU,CACnB,iFAAiF,CACjF,CAAC;SACF;QAED,IAAA,mBAAQ,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,OAA4B,CAAC,CAAC;IACjF,CAAC;CACD;AA3LD,gEA2LC;AAED,MAAa,eAAe;IAC3B,YAAmC,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE7D,IAAW,UAAU;QACpB,OAAO,CACN,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,UAAU;YACzC,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,gBAAgB,CAC/C,CAAC;IACH,CAAC;IAED,IAAW,aAAa;QACvB,OAAO,IAAI,CAAC,UAAU,KAAK,8BAAU,CAAC,UAAU,CAAC;IAClD,CAAC;CACD;AAbD,0CAaC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAC5B,QAAsB,EACtB,UAA6B,EAC7B,SAAqB,EACrB,cAA8B,EAC9B,eAAyB;IAEzB,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5C,IAAA,iBAAM,EAAC,CAAC,KAAK,CAAC,GAAG,CAAC,sBAAW,CAAC,EAAE,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAErF;QACC,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3E,IAAA,iBAAM,EACL,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU;YAC/C,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAChD,KAAK,CAAC,oDAAoD,CAC1D,CAAC;KACF;IAED,MAAM,IAAI,GAAG,IAAI,kCAAoB,CACpC,QAAQ,EACR,UAAU,CAAC,MAAM,EACjB,cAAc,EACd,eAAe,EACf,SAAS,CACT,CAAC;IACF,IAAA,iBAAM,EAAC,KAAK,CAAC,GAAG,CAAC,sBAAW,CAAC,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAE9E,MAAM,UAAU,GAAG,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACrE,MAAM,aAAa,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3E,IACC,aAAa,CAAC,KAAK,KAAK,wBAAa,CAAC,UAAU;YAChD,aAAa,CAAC,IAAI,KAAK,wBAAa,CAAC,UAAU,EAC9C;YACD,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,wBAAa,CAAC,EAAE,CAAC;SACtB;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACb,CAAC;AAxCD,sCAwCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { AllowedUpdateType, Compatibility, FieldKey } from \"../core/index.js\";\nimport { HasListeners, IEmitter, ISubscribable, createEmitter } from \"../events/index.js\";\nimport {\n\tFlexFieldSchema,\n\tNodeKeyManager,\n\tViewSchema,\n\tdefaultSchemaPolicy,\n\tContextSlot,\n} from \"../feature-libraries/index.js\";\nimport {\n\tFieldSchema,\n\tImplicitFieldSchema,\n\tInsertableTreeFieldFromImplicitField,\n\tSchemaIncompatible,\n\tTreeConfiguration,\n\tTreeFieldFromImplicitField,\n\tTreeView,\n\tTreeViewEvents,\n\tgetProxyForField,\n\ttoFlexConfig,\n\tsetField,\n\tnormalizeFieldSchema,\n\tInsertableContent,\n} from \"../simple-tree/index.js\";\nimport { disposeSymbol } from \"../util/index.js\";\n\nimport { TreeContent, UpdateType, ensureSchema, evaluateUpdate } from \"./schematizeTree.js\";\nimport { TreeCheckout } from \"./treeCheckout.js\";\nimport { CheckoutFlexTreeView } from \"./treeView.js\";\n\n/**\n * Implementation of TreeView wrapping a FlexTreeView.\n */\nexport class SchematizingSimpleTreeView<in out TRootSchema extends ImplicitFieldSchema>\n\timplements TreeView<TRootSchema>\n{\n\t/**\n\t * In one of three states:\n\t * 1. Valid: A checkout is present, not disposed, and it's stored schema and view schema are compatible.\n\t * 2. SchematizeError: stored schema and view schema are not compatible.\n\t * 3. disposed: `view` is undefined, and using this object will error. Some methods also transiently leave view undefined.\n\t */\n\tprivate view: CheckoutFlexTreeView<FlexFieldSchema> | SchematizeError | undefined;\n\tprivate readonly flexConfig: TreeContent;\n\tpublic readonly events: ISubscribable<TreeViewEvents> &\n\t\tIEmitter<TreeViewEvents> &\n\t\tHasListeners<TreeViewEvents> = createEmitter();\n\n\tprivate readonly viewSchema: ViewSchema;\n\n\tprivate readonly unregisterCallbacks = new Set<() => void>();\n\tprivate disposed = false;\n\n\tprivate readonly rootFieldSchema: FieldSchema;\n\n\tpublic constructor(\n\t\tpublic readonly checkout: TreeCheckout,\n\t\tpublic readonly config: TreeConfiguration<TRootSchema>,\n\t\tpublic readonly nodeKeyManager: NodeKeyManager,\n\t\tpublic readonly nodeKeyFieldKey: FieldKey,\n\t) {\n\t\tthis.rootFieldSchema = normalizeFieldSchema(config.schema);\n\t\tthis.flexConfig = toFlexConfig(config);\n\t\tthis.viewSchema = new ViewSchema(defaultSchemaPolicy, {}, this.flexConfig.schema);\n\t\tthis.update();\n\n\t\tthis.unregisterCallbacks.add(\n\t\t\tthis.checkout.events.on(\"commitApplied\", (data, getRevertible) =>\n\t\t\t\tthis.events.emit(\"commitApplied\", data, getRevertible),\n\t\t\t),\n\t\t);\n\t}\n\n\tpublic upgradeSchema(): void {\n\t\t// Errors if disposed.\n\t\tconst error = this.error;\n\n\t\t// No-op non error state.\n\t\tif (error === undefined) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (this.error?.canUpgrade !== true) {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Existing stored schema can not be upgraded (see TreeView.canUpgrade).\",\n\t\t\t);\n\t\t}\n\n\t\tconst result = ensureSchema(\n\t\t\tthis.viewSchema,\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\tAllowedUpdateType.SchemaCompatible | AllowedUpdateType.Initialize,\n\t\t\tthis.checkout,\n\t\t\tthis.flexConfig,\n\t\t);\n\t\tassert(result, 0x8bf /* Schema upgrade should always work if canUpgrade is set. */);\n\t}\n\n\t/**\n\t * Gets the view is the stored schema is compatible with the view schema,\n\t * otherwise returns an error detailing the schema incompatibility.\n\t */\n\tpublic getViewOrError(): CheckoutFlexTreeView<FlexFieldSchema> | SchematizeError {\n\t\tif (this.disposed) {\n\t\t\tthrow new UsageError(\"Accessed a disposed TreeView.\");\n\t\t}\n\t\tassert(this.view !== undefined, 0x8c0 /* unexpected getViewOrError */);\n\t\treturn this.view;\n\t}\n\n\t/**\n\t * Updates `this.view`.\n\t * Invoked during initialization and when `this.view` needs to be replaced due to stored schema changes.\n\t * Handled re-registering for events to call update in the future.\n\t * @remarks\n\t * This does not check if the view needs to be replaced, it replaces it unconditionally:\n\t * callers should do any checking to detect if its really needed before calling `update`.\n\t */\n\tprivate update(): void {\n\t\t// This implementation avoids making any edits, which prevents it from being invoked reentrantly.\n\t\t// If implicit initialization (or some other edit) is desired, it should be done outside of this method.\n\n\t\tconst compatibility = evaluateUpdate(\n\t\t\tthis.viewSchema,\n\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\tAllowedUpdateType.SchemaCompatible | AllowedUpdateType.Initialize,\n\t\t\tthis.checkout,\n\t\t);\n\t\tthis.disposeView();\n\t\tswitch (compatibility) {\n\t\t\tcase UpdateType.None: {\n\t\t\t\t// Remove event from checkout when view is disposed\n\t\t\t\tthis.view = requireSchema(\n\t\t\t\t\tthis.checkout,\n\t\t\t\t\tthis.viewSchema,\n\t\t\t\t\t() => {\n\t\t\t\t\t\tassert(cleanupCheckOutEvents !== undefined, 0x8c1 /* missing cleanup */);\n\t\t\t\t\t\tcleanupCheckOutEvents();\n\t\t\t\t\t\tthis.view = undefined;\n\t\t\t\t\t\tif (!this.disposed) {\n\t\t\t\t\t\t\tthis.update();\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\tthis.nodeKeyManager,\n\t\t\t\t\tthis.nodeKeyFieldKey,\n\t\t\t\t);\n\n\t\t\t\t// Trigger \"rootChanged\" if the root changes in the future.\n\t\t\t\t// Currently there is no good way to do this as FlexTreeField has no events for changes.\n\t\t\t\t// this.view.flexTree.on(????)\n\t\t\t\t// As a workaround for the above, trigger \"rootChanged\" in \"afterBatch\"\n\t\t\t\t// which isn't the correct time since we normally do events during the batch when the forest is modified, but its better than nothing.\n\t\t\t\t// TODO: provide a better event: this.view.flexTree.on(????)\n\t\t\t\tlet lastRoot = this.root;\n\t\t\t\tconst cleanupCheckOutEvents = this.checkout.events.on(\"afterBatch\", () => {\n\t\t\t\t\tif (lastRoot !== this.root) {\n\t\t\t\t\t\tlastRoot = this.root;\n\t\t\t\t\t\tthis.events.emit(\"rootChanged\");\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase UpdateType.Incompatible:\n\t\t\tcase UpdateType.Initialize:\n\t\t\tcase UpdateType.SchemaCompatible: {\n\t\t\t\tthis.view = new SchematizeError(compatibility);\n\t\t\t\tconst unregister = this.checkout.storedSchema.on(\"afterSchemaChange\", () => {\n\t\t\t\t\tunregister();\n\t\t\t\t\tthis.unregisterCallbacks.delete(unregister);\n\t\t\t\t\tthis.update();\n\t\t\t\t});\n\t\t\t\tthis.unregisterCallbacks.add(unregister);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tunreachableCase(compatibility);\n\t\t\t}\n\t\t}\n\t\tthis.events.emit(\"rootChanged\");\n\t}\n\n\tprivate disposeView(): void {\n\t\tif (this.view !== undefined && !(this.view instanceof SchematizeError)) {\n\t\t\tthis.view[disposeSymbol]();\n\t\t\tthis.view = undefined;\n\t\t\tthis.unregisterCallbacks.forEach((unregister) => unregister());\n\t\t}\n\t}\n\n\tpublic get error(): SchematizeError | undefined {\n\t\tconst view = this.getViewOrError();\n\t\treturn view instanceof SchematizeError ? view : undefined;\n\t}\n\n\tpublic [disposeSymbol](): void {\n\t\tthis.getViewOrError();\n\t\tthis.disposed = true;\n\t\tthis.disposeView();\n\t}\n\n\tpublic get root(): TreeFieldFromImplicitField<TRootSchema> {\n\t\tconst view = this.getViewOrError();\n\t\tif (view instanceof SchematizeError) {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Document is out of schema. Check TreeView.error before accessing TreeView.root.\",\n\t\t\t);\n\t\t}\n\t\treturn getProxyForField(view.flexTree) as TreeFieldFromImplicitField<TRootSchema>;\n\t}\n\n\tpublic set root(newRoot: InsertableTreeFieldFromImplicitField<TRootSchema>) {\n\t\tconst view = this.getViewOrError();\n\t\tif (view instanceof SchematizeError) {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"Document is out of schema. Check TreeView.error before accessing TreeView.root.\",\n\t\t\t);\n\t\t}\n\n\t\tsetField(view.context.root, this.rootFieldSchema, newRoot as InsertableContent);\n\t}\n}\n\nexport class SchematizeError implements SchemaIncompatible {\n\tpublic constructor(public readonly updateType: UpdateType) {}\n\n\tpublic get canUpgrade(): boolean {\n\t\treturn (\n\t\t\tthis.updateType === UpdateType.Initialize ||\n\t\t\tthis.updateType === UpdateType.SchemaCompatible\n\t\t);\n\t}\n\n\tpublic get canInitialize(): boolean {\n\t\treturn this.updateType === UpdateType.Initialize;\n\t}\n}\n\n/**\n * Flex-Tree schematizing layer.\n * Creates a view that self-disposes when stored schema becomes incompatible.\n * This may only be called when the schema is already known to be compatible (typically via ensureSchema).\n */\nexport function requireSchema<TRoot extends FlexFieldSchema>(\n\tcheckout: TreeCheckout,\n\tviewSchema: ViewSchema<TRoot>,\n\tonDispose: () => void,\n\tnodeKeyManager: NodeKeyManager,\n\tnodeKeyFieldKey: FieldKey,\n): CheckoutFlexTreeView<TRoot> {\n\tconst slots = checkout.forest.anchors.slots;\n\tassert(!slots.has(ContextSlot), 0x8c2 /* Cannot create second view from checkout */);\n\n\t{\n\t\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\t\tassert(\n\t\t\tcompatibility.write === Compatibility.Compatible &&\n\t\t\t\tcompatibility.read === Compatibility.Compatible,\n\t\t\t0x8c3 /* requireSchema invoked with incompatible schema */,\n\t\t);\n\t}\n\n\tconst view = new CheckoutFlexTreeView(\n\t\tcheckout,\n\t\tviewSchema.schema,\n\t\tnodeKeyManager,\n\t\tnodeKeyFieldKey,\n\t\tonDispose,\n\t);\n\tassert(slots.has(ContextSlot), 0x90d /* Context should be tracked in slot */);\n\n\tconst unregister = checkout.storedSchema.on(\"afterSchemaChange\", () => {\n\t\tconst compatibility = viewSchema.checkCompatibility(checkout.storedSchema);\n\t\tif (\n\t\t\tcompatibility.write !== Compatibility.Compatible ||\n\t\t\tcompatibility.read !== Compatibility.Compatible\n\t\t) {\n\t\t\tunregister();\n\t\t\tview[disposeSymbol]();\n\t\t}\n\t});\n\n\treturn view;\n}\n"]}

package/dist/shared-tree/sharedTree.d.ts

@@ -5,15 +5,15 @@
 import { IChannelAttributes, IChannelFactory, IChannelServices, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
 import { ISharedObject } from "@fluidframework/shared-object-base";
 import { ICodecOptions } from "../codec/index.js";
-import { TreeStoredSchemaRepository, JsonableTree, TreeStoredSchema } from "../core/index.js";
-import { SharedTreeCore } from "../shared-tree-core/index.js";
+import { JsonableTree, TreeStoredSchema, TreeStoredSchemaRepository } from "../core/index.js";
 import { FlexFieldSchema, TreeCompressionStrategy } from "../feature-libraries/index.js";
-import { ITree, TreeConfiguration, ImplicitFieldSchema, TreeFieldFromImplicitField, TreeView } from "../simple-tree/index.js";
+import { SharedTreeCore } from "../shared-tree-core/index.js";
+import { ITree, ImplicitFieldSchema, TreeConfiguration, TreeView } from "../simple-tree/index.js";
 import { InitializeAndSchematizeConfiguration } from "./schematizeTree.js";
-import { TreeCheckout } from "./treeCheckout.js";
-import { CheckoutFlexTreeView, FlexTreeView } from "./treeView.js";
 import { SharedTreeChange } from "./sharedTreeChangeTypes.js";
 import { SharedTreeEditBuilder } from "./sharedTreeEditBuilder.js";
+import { TreeCheckout } from "./treeCheckout.js";
+import { CheckoutFlexTreeView, FlexTreeView } from "./treeView.js";
 /**
  * Copy of data from an {@link ISharedTree} at some point in time.
  * @remarks
@@ -74,18 +74,68 @@ export declare class SharedTree extends SharedTreeCore<SharedTreeEditBuilder, Sh
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, optionsParam: SharedTreeOptions, telemetryContextPrefix: string);
     contentSnapshot(): SharedTreeContentSnapshot;
     schematizeFlexTree<TRoot extends FlexFieldSchema>(config: InitializeAndSchematizeConfiguration<TRoot>, onDispose: () => void): CheckoutFlexTreeView<TRoot> | undefined;
-    schematize<TRoot extends ImplicitFieldSchema>(config: TreeConfiguration<TRoot>): TreeView<TreeFieldFromImplicitField<TRoot>>;
+    schematize<TRoot extends ImplicitFieldSchema>(config: TreeConfiguration<TRoot>): TreeView<TRoot>;
     protected loadCore(services: IChannelStorageService): Promise<void>;
 }
 /**
+ * Format versions supported by SharedTree.
+ *
+ * Each version documents a required minimum version of the \@fluidframework/tree package.
+ * @internal
+ */
+export declare const SharedTreeFormatVersion: {
+    /**
+     * Requires \@fluidframework/tree \>= 2.0.0.
+     *
+     * @deprecated - FF does not currently plan on supporting this format long-term.
+     * Do not write production documents using this format, as they may not be loadable in the future.
+     */
+    readonly v1: 1;
+    /**
+     * Requires \@fluidframework/tree \>= 2.0.0.
+     */
+    readonly v2: 2;
+};
+/**
+ * Format versions supported by SharedTree.
+ *
+ * Each version documents a required minimum version of the \@fluidframework/tree package.
  * @internal
+ * @privateRemarks
+ * See packages/dds/tree/docs/main/compatibility.md for information on how to add support for a new format.
  */
-export interface SharedTreeOptions extends Partial<ICodecOptions> {
+export type SharedTreeFormatVersion = typeof SharedTreeFormatVersion;
+/**
+ * @internal
+ */
+export type SharedTreeOptions = Partial<ICodecOptions> & Partial<SharedTreeFormatOptions> & {
     /**
      * The {@link ForestType} indicating which forest type should be created for the SharedTree.
      */
     forest?: ForestType;
-    treeEncodeType?: TreeCompressionStrategy;
+};
+/**
+ * Options for configuring the persisted format SharedTree uses.
+ * @internal
+ */
+export interface SharedTreeFormatOptions {
+    /**
+     * See {@link TreeCompressionStrategy}.
+     * default: TreeCompressionStrategy.Compressed
+     */
+    treeEncodeType: TreeCompressionStrategy;
+    /**
+     * The format version SharedTree should use to persist documents.
+     *
+     * This option has compatibility implications for applications using SharedTree.
+     * Each version documents a required minimum version of \@fluidframework/tree.
+     * If this minimum version fails to be met, the SharedTree may fail to load.
+     * To be safe, application authors should verify that they have saturated this version
+     * of \@fluidframework/tree in their ecosystem before changing the format version.
+     *
+     * This option defaults to SharedTreeFormatVersion.v2.
+     */
+    formatVersion: SharedTreeFormatVersion[keyof SharedTreeFormatVersion];
 }
 /**
  * Used to distinguish between different forest types.

package/dist/shared-tree/sharedTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAiB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACN,0BAA0B,EAC1B,YAAY,EACZ,gBAAgB,EAIhB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAKN,eAAe,EAOf,uBAAuB,EAIvB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EACN,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,QAAQ,EACR,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,oCAAoC,EAAgB,MAAM,qBAAqB,CAAC;AACzF,OAAO,EAAE,YAAY,EAAsC,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGnE;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACxE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,EAAE,KAAK;IACxD;;;;;;OAMG;IACH,eAAe,IAAI,yBAAyB,CAAC;IAE7C;;;;;OAKG;IACH,kBAAkB,CAAC,KAAK,SAAS,eAAe,EAC/C,MAAM,EAAE,oCAAoC,CAAC,KAAK,CAAC,EACnD,SAAS,EAAE,MAAM,IAAI,GACnB,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,UACZ,SAAQ,cAAc,CAAC,qBAAqB,EAAE,gBAAgB,CAC9D,YAAW,WAAW;IAEtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAEM;IAC9B,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,IAAW,YAAY,IAAI,0BAA0B,CAEpD;gBAGA,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,YAAY,EAAE,iBAAiB,EAC/B,sBAAsB,EAAE,MAAM;IAuFxB,eAAe,IAAI,yBAAyB;IAc5C,kBAAkB,CAAC,KAAK,SAAS,eAAe,EACtD,MAAM,EAAE,oCAAoC,CAAC,KAAK,CAAC,EACnD,SAAS,EAAE,MAAM,IAAI,GACnB,oBAAoB,CAAC,KAAK,CAAC,GAAG,SAAS;IAenC,UAAU,CAAC,KAAK,SAAS,mBAAmB,EAClD,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAC9B,QAAQ,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;cAcrB,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;CAIlF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,OAAO,CAAC,aAAa,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,cAAc,CAAC,EAAE,uBAAuB,CAAC;CACzC;AAED;;;GAGG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,SAAS,IAAI;CACb;AAED,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,iBAAiB,CAIhE,CAAC;AAEF;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,eAAe,CAAC,WAAW,CAAC;IASlD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR3C,SAAgB,IAAI,EAAE,MAAM,CAA4C;IAExE,SAAgB,UAAU,EAAE,kBAAkB,CAI5C;gBAEkC,OAAO,GAAE,iBAAsB;IAEtD,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC7C,OAAO,CAAC,WAAW,CAAC;IAMhB,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW;CAKvE"}
+{"version":3,"file":"sharedTree.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAGnE,OAAO,EAAE,aAAa,EAAiB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACN,YAAY,EAEZ,gBAAgB,EAChB,0BAA0B,EAG1B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAEN,eAAe,EAGf,uBAAuB,EAWvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAA6B,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACzF,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAGlG,OAAO,EAAE,oCAAoC,EAAgB,MAAM,qBAAqB,CAAC;AAGzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAkB,YAAY,EAAsB,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;CACxE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,EAAE,KAAK;IACxD;;;;;;OAMG;IACH,eAAe,IAAI,yBAAyB,CAAC;IAE7C;;;;;OAKG;IACH,kBAAkB,CAAC,KAAK,SAAS,eAAe,EAC/C,MAAM,EAAE,oCAAoC,CAAC,KAAK,CAAC,EACnD,SAAS,EAAE,MAAM,IAAI,GACnB,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;CACnC;AA8BD;;;;GAIG;AACH,qBAAa,UACZ,SAAQ,cAAc,CAAC,qBAAqB,EAAE,gBAAgB,CAC9D,YAAW,WAAW;IAEtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAEM;IAC9B,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,IAAW,YAAY,IAAI,0BAA0B,CAEpD;gBAGA,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,YAAY,EAAE,iBAAiB,EAC/B,sBAAsB,EAAE,MAAM;IA6FxB,eAAe,IAAI,yBAAyB;IAc5C,kBAAkB,CAAC,KAAK,SAAS,eAAe,EACtD,MAAM,EAAE,oCAAoC,CAAC,KAAK,CAAC,EACnD,SAAS,EAAE,MAAM,IAAI,GACnB,oBAAoB,CAAC,KAAK,CAAC,GAAG,SAAS;IAenC,UAAU,CAAC,KAAK,SAAS,mBAAmB,EAClD,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAC9B,QAAQ,CAAC,KAAK,CAAC;cAcO,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;CAIlF;AAED;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IACnC;;;;;OAKG;;IAGH;;OAEG;;CAEM,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GACrD,OAAO,CAAC,uBAAuB,CAAC,GAAG;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;OAGG;IACH,cAAc,EAAE,uBAAuB,CAAC;IACxC;;;;;;;;;;OAUG;IACH,aAAa,EAAE,uBAAuB,CAAC,MAAM,uBAAuB,CAAC,CAAC;CACtE;AAED;;;GAGG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,SAAS,IAAI;CACb;AAED,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,iBAAiB,CAKhE,CAAC;AAEF;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,eAAe,CAAC,WAAW,CAAC;IASlD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR3C,SAAgB,IAAI,EAAE,MAAM,CAA4C;IAExE,SAAgB,UAAU,EAAE,kBAAkB,CAI5C;gBAEkC,OAAO,GAAE,iBAAsB;IAEtD,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC7C,OAAO,CAAC,WAAW,CAAC;IAMhB,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW;CAKvE"}

package/dist/shared-tree/sharedTree.js

@@ -4,30 +4,43 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedTreeFactory = exports.defaultSharedTreeOptions = exports.ForestType = exports.SharedTree = void 0;
-const core_utils_1 = require("@fluidframework/core-utils");
+exports.SharedTreeFactory = exports.defaultSharedTreeOptions = exports.ForestType = exports.SharedTreeFormatVersion = exports.SharedTree = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../codec/index.js");
 const index_js_2 = require("../core/index.js");
-const index_js_3 = require("../shared-tree-core/index.js");
+const index_js_3 = require("../events/index.js");
 const index_js_4 = require("../feature-libraries/index.js");
-const index_js_5 = require("../events/index.js");
+const index_js_5 = require("../shared-tree-core/index.js");
 const index_js_6 = require("../util/index.js");
 const schematizeTree_js_1 = require("./schematizeTree.js");
-const treeCheckout_js_1 = require("./treeCheckout.js");
-const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
 const schematizingTreeView_js_1 = require("./schematizingTreeView.js");
+const sharedTreeChangeFamily_js_1 = require("./sharedTreeChangeFamily.js");
+const treeCheckout_js_1 = require("./treeCheckout.js");
+const formatVersionToTopLevelCodecVersions = new Map([
+    [1, { forest: 1, schema: 1, detachedFieldIndex: 1, editManager: 1, message: 1, fieldBatch: 1 }],
+    [2, { forest: 1, schema: 1, detachedFieldIndex: 1, editManager: 2, message: 2, fieldBatch: 1 }],
+]);
+function getCodecVersions(formatVersion) {
+    const versions = formatVersionToTopLevelCodecVersions.get(formatVersion);
+    (0, internal_1.assert)(versions !== undefined, 0x90e /* Unknown format version */);
+    return versions;
+}
 /**
  * Shared tree, configured with a good set of indexes and field kinds which will maintain compatibility over time.
  *
  * TODO: detail compatibility requirements.
  */
-class SharedTree extends index_js_3.SharedTreeCore {
+class SharedTree extends index_js_5.SharedTreeCore {
     get storedSchema() {
         return this.checkout.storedSchema;
     }
     constructor(id, runtime, attributes, optionsParam, telemetryContextPrefix) {
-        (0, core_utils_1.assert)(runtime.idCompressor !== undefined, 0x883 /* IdCompressor must be enabled to use SharedTree */);
+        if (runtime.idCompressor === undefined) {
+            throw new internal_2.UsageError("IdCompressor must be enabled to use SharedTree");
+        }
         const options = { ...exports.defaultSharedTreeOptions, ...optionsParam };
+        const codecVersions = getCodecVersions(options.formatVersion);
         const schema = new index_js_2.TreeStoredSchemaRepository();
         const forest = options.forest === ForestType.Optimized
             ? (0, index_js_4.buildChunkedForest)((0, index_js_4.makeTreeChunker)(schema, index_js_4.defaultSchemaPolicy))
@@ -37,7 +50,7 @@ class SharedTree extends index_js_3.SharedTreeCore {
         const schemaSummarizer = new index_js_4.SchemaSummarizer(runtime, schema, options, {
             getCurrentSeq: () => this.runtime.deltaManager.lastSequenceNumber,
         });
-        const fieldBatchCodec = (0, index_js_4.makeFieldBatchCodec)(options);
+        const fieldBatchCodec = (0, index_js_4.makeFieldBatchCodec)(options, codecVersions.fieldBatch);
         const encoderContext = {
             schema: {
                 schema,
@@ -66,10 +79,10 @@ class SharedTree extends index_js_3.SharedTreeCore {
             // programmatically reload the SharedTree container.
             throw error;
         });
-        super([schemaSummarizer, forestSummarizer, removedRootsSummarizer], changeFamily, options, id, runtime, attributes, telemetryContextPrefix, { schema, policy: index_js_4.defaultSchemaPolicy });
-        this._events = (0, index_js_5.createEmitter)();
+        super([schemaSummarizer, forestSummarizer, removedRootsSummarizer], changeFamily, options, codecVersions, id, runtime, attributes, telemetryContextPrefix, { schema, policy: index_js_4.defaultSchemaPolicy });
+        this._events = (0, index_js_3.createEmitter)();
         const localBranch = this.getLocalBranch();
-        this.checkout = (0, treeCheckout_js_1.createTreeCheckout)(runtime.idCompressor, revisionTagCodec, {
+        this.checkout = (0, treeCheckout_js_1.createTreeCheckout)(runtime.idCompressor, this.mintRevisionTag, revisionTagCodec, {
             branch: localBranch,
             changeFamily,
             schema,
@@ -115,6 +128,25 @@ class SharedTree extends index_js_3.SharedTreeCore {
     }
 }
 exports.SharedTree = SharedTree;
+/**
+ * Format versions supported by SharedTree.
+ *
+ * Each version documents a required minimum version of the \@fluidframework/tree package.
+ * @internal
+ */
+exports.SharedTreeFormatVersion = {
+    /**
+     * Requires \@fluidframework/tree \>= 2.0.0.
+     *
+     * @deprecated - FF does not currently plan on supporting this format long-term.
+     * Do not write production documents using this format, as they may not be loadable in the future.
+     */
+    v1: 1,
+    /**
+     * Requires \@fluidframework/tree \>= 2.0.0.
+     */
+    v2: 2,
+};
 /**
  * Used to distinguish between different forest types.
  * @internal
@@ -134,6 +166,7 @@ exports.defaultSharedTreeOptions = {
     jsonValidator: index_js_1.noopValidator,
     forest: ForestType.Reference,
     treeEncodeType: index_js_4.TreeCompressionStrategy.Compressed,
+    formatVersion: exports.SharedTreeFormatVersion.v2,
 };
 /**
  * A channel factory that creates {@link ISharedTree}s.

package/dist/shared-tree/sharedTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTree.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAUH,2DAAoD;AACpD,gDAAiE;AACjE,+CAO0B;AAC1B,2DAA8D;AAC9D,4DAgBuC;AACvC,iDAA0F;AAC1F,+CAAyC;AAQzC,2DAAyF;AACzF,uDAAqF;AAGrF,2EAAqE;AAErE,uEAAsF;AAwDtF;;;;GAIG;AACH,MAAa,UACZ,SAAQ,yBAAuD;IAO/D,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACnC,CAAC;IAED,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,YAA+B,EAC/B,sBAA8B;QAE9B,IAAA,mBAAM,EACL,OAAO,CAAC,YAAY,KAAK,SAAS,EAClC,KAAK,CAAC,oDAAoD,CAC1D,CAAC;QAEF,MAAM,OAAO,GAAG,EAAE,GAAG,gCAAwB,EAAE,GAAG,YAAY,EAAE,CAAC;QACjE,MAAM,MAAM,GAAG,IAAI,qCAA0B,EAAE,CAAC;QAChD,MAAM,MAAM,GACX,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC,SAAS;YACtC,CAAC,CAAC,IAAA,6BAAkB,EAAC,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,CAAC,CAAC;YAClE,CAAC,CAAC,IAAA,sBAAW,GAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACpE,MAAM,YAAY,GAAG,IAAA,iCAAsB,EAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;YACvE,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACjE,CAAC,CAAC;QACH,MAAM,eAAe,GAAG,IAAA,8BAAmB,EAAC,OAAO,CAAC,CAAC;QAErD,MAAM,cAAc,GAAG;YACtB,MAAM,EAAE;gBACP,MAAM;gBACN,MAAM,EAAE,8BAAmB;aAC3B;YACD,UAAU,EAAE,OAAO,CAAC,cAAc;SAClC,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,OAAO,CACP,CAAC;QACF,MAAM,sBAAsB,GAAG,IAAI,uCAA4B,CAAC,YAAY,CAAC,CAAC;QAC9E,MAAM,iBAAiB,GAAG,IAAI,kDAAsB,CACnD,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,OAAO,CAAC,cAAc,CACtB,CAAC;QACF,MAAM,YAAY,GAAG,IAAA,oCAAyB,EAC7C,iBAAiB,EACjB,kDAAsB,CAAC,WAAW,EAClC,CAAC,KAAc,EAAE,EAAE;YAClB,4CAA4C;YAC5C,oFAAoF;YACpF,4BAA4B;YAC5B,4FAA4F;YAC5F,0FAA0F;YAC1F,iGAAiG;YACjG,2EAA2E;YAC3E,2FAA2F;YAC3F,wFAAwF;YACxF,sFAAsF;YACtF,uFAAuF;YACvF,0BAA0B;YAC1B,kFAAkF;YAClF,gFAAgF;YAChF,oDAAoD;YACpD,MAAM,KAAK,CAAC;QACb,CAAC,CACD,CAAC;QACF,KAAK,CACJ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAC5D,YAAY,EACZ,OAAO,EACP,EAAE,EACF,OAAO,EACP,UAAU,EACV,sBAAsB,EACtB,EAAE,MAAM,EAAE,MAAM,EAAE,8BAAmB,EAAE,CACvC,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,IAAA,wBAAa,GAAkB,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAA,oCAAkB,EAAC,OAAO,CAAC,YAAY,EAAE,gBAAgB,EAAE;YAC1E,MAAM,EAAE,WAAW;YACnB,YAAY;YACZ,MAAM;YACN,MAAM;YACN,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY;YACZ,wBAAwB,EAAE,OAAO,CAAC,cAAc;SAChD,CAAC,CAAC;IACJ,CAAC;IAEM,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI;YACH,IAAA,8BAAmB,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClD,OAAO;gBACN,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;gBACjC,IAAI,EAAE,IAAA,sCAA2B,EAAC,MAAM,CAAC;gBACzC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;aACxC,CAAC;SACF;gBAAS;YACT,MAAM,CAAC,IAAI,EAAE,CAAC;SACd;IACF,CAAC;IAEM,kBAAkB,CACxB,MAAmD,EACnD,SAAqB;QAErB,MAAM,UAAU,GAAG,IAAI,qBAAU,CAAC,8BAAmB,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAA,gCAAY,EAAC,UAAU,EAAE,MAAM,CAAC,0BAA0B,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YACxF,OAAO,SAAS,CAAC;SACjB;QAED,OAAO,IAAA,uCAAa,EACnB,IAAI,CAAC,QAAQ,EACb,UAAU,EACV,SAAS,EACT,IAAA,+BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAC/C,IAAA,gBAAK,EAAC,0BAAsB,CAAC,CAC7B,CAAC;IACH,CAAC;IAEM,UAAU,CAChB,MAAgC;QAEhC,MAAM,IAAI,GAAG,IAAI,oDAA0B,CAC1C,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAA,+BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAC/C,IAAA,gBAAK,EAAC,0BAAsB,CAAC,CAC7B,CAAC;QACF,mGAAmG;QACnG,IAAI,IAAI,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,aAAa,EAAE,CAAC;SACrB;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAEkB,KAAK,CAAC,QAAQ,CAAC,QAAgC;QACjE,MAAM,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;CACD;AA5JD,gCA4JC;AAaD;;;GAGG;AACH,IAAY,UASX;AATD,WAAY,UAAU;IACrB;;OAEG;IACH,qDAAa,CAAA;IACb;;OAEG;IACH,qDAAa,CAAA;AACd,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAEY,QAAA,wBAAwB,GAAgC;IACpE,aAAa,EAAE,wBAAa;IAC5B,MAAM,EAAE,UAAU,CAAC,SAAS;IAC5B,cAAc,EAAE,kCAAuB,CAAC,UAAU;CAClD,CAAC;AAEF;;;GAGG;AACH,MAAa,iBAAiB;IAS7B,YAAoC,UAA6B,EAAE;QAA/B,YAAO,GAAP,OAAO,CAAwB;QARnD,SAAI,GAAW,wCAAwC,CAAC;QAExD,eAAU,GAAuB;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,qBAAqB,EAAE,OAAO;YAC9B,cAAc,EAAE,OAAO;SACvB,CAAC;IAEoE,CAAC;IAEhE,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,iBAA+C;QAE/C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxF,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,OAA+B,EAAE,EAAU;QACxD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACtF,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AA3BD,8CA2BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIChannelStorageService,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { ICodecOptions, noopValidator } from \"../codec/index.js\";\nimport {\n\tTreeStoredSchemaRepository,\n\tJsonableTree,\n\tTreeStoredSchema,\n\tmakeDetachedFieldIndex,\n\tmoveToDetachedField,\n\tRevisionTagCodec,\n} from \"../core/index.js\";\nimport { SharedTreeCore } from \"../shared-tree-core/index.js\";\nimport {\n\tdefaultSchemaPolicy,\n\tForestSummarizer,\n\tSchemaSummarizer,\n\tbuildForest,\n\tFlexFieldSchema,\n\tbuildChunkedForest,\n\tmakeTreeChunker,\n\tDetachedFieldIndexSummarizer,\n\tcreateNodeKeyManager,\n\tnodeKeyFieldKey as defaultNodeKeyFieldKey,\n\tjsonableTreeFromFieldCursor,\n\tTreeCompressionStrategy,\n\tViewSchema,\n\tmakeMitigatedChangeFamily,\n\tmakeFieldBatchCodec,\n} from \"../feature-libraries/index.js\";\nimport { HasListeners, IEmitter, ISubscribable, createEmitter } from \"../events/index.js\";\nimport { brand } from \"../util/index.js\";\nimport {\n\tITree,\n\tTreeConfiguration,\n\tImplicitFieldSchema,\n\tTreeFieldFromImplicitField,\n\tTreeView,\n} from \"../simple-tree/index.js\";\nimport { InitializeAndSchematizeConfiguration, ensureSchema } from \"./schematizeTree.js\";\nimport { TreeCheckout, CheckoutEvents, createTreeCheckout } from \"./treeCheckout.js\";\nimport { CheckoutFlexTreeView, FlexTreeView } from \"./treeView.js\";\nimport { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport { SharedTreeChangeFamily } from \"./sharedTreeChangeFamily.js\";\nimport { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\nimport { SchematizingSimpleTreeView, requireSchema } from \"./schematizingTreeView.js\";\n\n/**\n * Copy of data from an {@link ISharedTree} at some point in time.\n * @remarks\n * This is unrelated to Fluids concept of \"snapshots\".\n * @internal\n */\nexport interface SharedTreeContentSnapshot {\n\t/**\n\t * The schema stored in the document.\n\t *\n\t * @remarks\n\t * Edits to the schema can mutate the schema stored of the tree which took this snapshot (but this snapshot will remain the same)\n\t * This is mainly useful for debugging cases where schematize reports an incompatible view schema.\n\t */\n\treadonly schema: TreeStoredSchema;\n\t/**\n\t * All {@link TreeStatus#InDocument} content.\n\t */\n\treadonly tree: JsonableTree[];\n\t/**\n\t * All {@link TreeStatus#Removed} content.\n\t */\n\treadonly removed: [string | number | undefined, number, JsonableTree][];\n}\n\n/**\n * Collaboratively editable tree distributed data-structure,\n * powered by {@link @fluidframework/shared-object-base#ISharedObject}.\n *\n * See [the README](../../README.md) for details.\n * @internal\n */\nexport interface ISharedTree extends ISharedObject, ITree {\n\t/**\n\t * Provides a copy of the current content of the tree.\n\t * This can be useful for inspecting the tree when no suitable view schema is available.\n\t * This is only intended for use in testing and exceptional code paths: it is not performant.\n\t *\n\t * This does not include everything that is included in a tree summary, since information about how to merge future edits is omitted.\n\t */\n\tcontentSnapshot(): SharedTreeContentSnapshot;\n\n\t/**\n\t * Like {@link ITree.schematize}, but uses the flex-tree schema system and exposes the tree as a flex-tree.\n\t *\n\t * Returned view is disposed when the stored schema becomes incompatible with the view schema.\n\t * Undefined is returned if the stored data could not be made compatible with the view schema.\n\t */\n\tschematizeFlexTree<TRoot extends FlexFieldSchema>(\n\t\tconfig: InitializeAndSchematizeConfiguration<TRoot>,\n\t\tonDispose: () => void,\n\t): FlexTreeView<TRoot> | undefined;\n}\n\n/**\n * Shared tree, configured with a good set of indexes and field kinds which will maintain compatibility over time.\n *\n * TODO: detail compatibility requirements.\n */\nexport class SharedTree\n\textends SharedTreeCore<SharedTreeEditBuilder, SharedTreeChange>\n\timplements ISharedTree\n{\n\tprivate readonly _events: ISubscribable<CheckoutEvents> &\n\t\tIEmitter<CheckoutEvents> &\n\t\tHasListeners<CheckoutEvents>;\n\tpublic readonly checkout: TreeCheckout;\n\tpublic get storedSchema(): TreeStoredSchemaRepository {\n\t\treturn this.checkout.storedSchema;\n\t}\n\n\tpublic constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\toptionsParam: SharedTreeOptions,\n\t\ttelemetryContextPrefix: string,\n\t) {\n\t\tassert(\n\t\t\truntime.idCompressor !== undefined,\n\t\t\t0x883 /* IdCompressor must be enabled to use SharedTree */,\n\t\t);\n\n\t\tconst options = { ...defaultSharedTreeOptions, ...optionsParam };\n\t\tconst schema = new TreeStoredSchemaRepository();\n\t\tconst forest =\n\t\t\toptions.forest === ForestType.Optimized\n\t\t\t\t? buildChunkedForest(makeTreeChunker(schema, defaultSchemaPolicy))\n\t\t\t\t: buildForest();\n\t\tconst revisionTagCodec = new RevisionTagCodec(runtime.idCompressor);\n\t\tconst removedRoots = makeDetachedFieldIndex(\"repair\", revisionTagCodec, options);\n\t\tconst schemaSummarizer = new SchemaSummarizer(runtime, schema, options, {\n\t\t\tgetCurrentSeq: () => this.runtime.deltaManager.lastSequenceNumber,\n\t\t});\n\t\tconst fieldBatchCodec = makeFieldBatchCodec(options);\n\n\t\tconst encoderContext = {\n\t\t\tschema: {\n\t\t\t\tschema,\n\t\t\t\tpolicy: defaultSchemaPolicy,\n\t\t\t},\n\t\t\tencodeType: options.treeEncodeType,\n\t\t};\n\t\tconst forestSummarizer = new ForestSummarizer(\n\t\t\tforest,\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\tencoderContext,\n\t\t\toptions,\n\t\t);\n\t\tconst removedRootsSummarizer = new DetachedFieldIndexSummarizer(removedRoots);\n\t\tconst innerChangeFamily = new SharedTreeChangeFamily(\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\toptions,\n\t\t\toptions.treeEncodeType,\n\t\t);\n\t\tconst changeFamily = makeMitigatedChangeFamily(\n\t\t\tinnerChangeFamily,\n\t\t\tSharedTreeChangeFamily.emptyChange,\n\t\t\t(error: unknown) => {\n\t\t\t\t// TODO:6344 Add telemetry for these errors.\n\t\t\t\t// Rethrowing the error has a different effect depending on the context in which the\n\t\t\t\t// ChangeFamily was invoked:\n\t\t\t\t// - If the ChangeFamily was invoked as part of incoming op processing, rethrowing the error\n\t\t\t\t// will cause the runtime to disconnect the client, log a severe error, and not reconnect.\n\t\t\t\t// This will not cause the host application to crash because it is not on the stack at that time.\n\t\t\t\t// TODO: let the host application know that the client is now disconnected.\n\t\t\t\t// - If the ChangeFamily was invoked as part of dealing with a local change, rethrowing the\n\t\t\t\t// error will cause the host application to crash. This is not ideal, but is better than\n\t\t\t\t// letting the application either send an invalid change to the server or allowing the\n\t\t\t\t// application to continue working when its local branches contain edits that cannot be\n\t\t\t\t// reflected in its views.\n\t\t\t\t// The best course of action for a host application in such a state is to restart.\n\t\t\t\t// TODO: let the host application know about this situation and provide a way to\n\t\t\t\t// programmatically reload the SharedTree container.\n\t\t\t\tthrow error;\n\t\t\t},\n\t\t);\n\t\tsuper(\n\t\t\t[schemaSummarizer, forestSummarizer, removedRootsSummarizer],\n\t\t\tchangeFamily,\n\t\t\toptions,\n\t\t\tid,\n\t\t\truntime,\n\t\t\tattributes,\n\t\t\ttelemetryContextPrefix,\n\t\t\t{ schema, policy: defaultSchemaPolicy },\n\t\t);\n\t\tthis._events = createEmitter<CheckoutEvents>();\n\t\tconst localBranch = this.getLocalBranch();\n\t\tthis.checkout = createTreeCheckout(runtime.idCompressor, revisionTagCodec, {\n\t\t\tbranch: localBranch,\n\t\t\tchangeFamily,\n\t\t\tschema,\n\t\t\tforest,\n\t\t\tfieldBatchCodec,\n\t\t\tevents: this._events,\n\t\t\tremovedRoots,\n\t\t\tchunkCompressionStrategy: options.treeEncodeType,\n\t\t});\n\t}\n\n\tpublic contentSnapshot(): SharedTreeContentSnapshot {\n\t\tconst cursor = this.checkout.forest.allocateCursor();\n\t\ttry {\n\t\t\tmoveToDetachedField(this.checkout.forest, cursor);\n\t\t\treturn {\n\t\t\t\tschema: this.storedSchema.clone(),\n\t\t\t\ttree: jsonableTreeFromFieldCursor(cursor),\n\t\t\t\tremoved: this.checkout.getRemovedRoots(),\n\t\t\t};\n\t\t} finally {\n\t\t\tcursor.free();\n\t\t}\n\t}\n\n\tpublic schematizeFlexTree<TRoot extends FlexFieldSchema>(\n\t\tconfig: InitializeAndSchematizeConfiguration<TRoot>,\n\t\tonDispose: () => void,\n\t): CheckoutFlexTreeView<TRoot> | undefined {\n\t\tconst viewSchema = new ViewSchema(defaultSchemaPolicy, {}, config.schema);\n\t\tif (!ensureSchema(viewSchema, config.allowedSchemaModifications, this.checkout, config)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\treturn requireSchema(\n\t\t\tthis.checkout,\n\t\t\tviewSchema,\n\t\t\tonDispose,\n\t\t\tcreateNodeKeyManager(this.runtime.idCompressor),\n\t\t\tbrand(defaultNodeKeyFieldKey),\n\t\t);\n\t}\n\n\tpublic schematize<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeConfiguration<TRoot>,\n\t): TreeView<TreeFieldFromImplicitField<TRoot>> {\n\t\tconst view = new SchematizingSimpleTreeView(\n\t\t\tthis.checkout,\n\t\t\tconfig,\n\t\t\tcreateNodeKeyManager(this.runtime.idCompressor),\n\t\t\tbrand(defaultNodeKeyFieldKey),\n\t\t);\n\t\t// As a subjective API design choice, we initialize the tree here if it is not already initialized.\n\t\tif (view.error?.canInitialize === true) {\n\t\t\tview.upgradeSchema();\n\t\t}\n\t\treturn view;\n\t}\n\n\tprotected override async loadCore(services: IChannelStorageService): Promise<void> {\n\t\tawait super.loadCore(services);\n\t\tthis._events.emit(\"afterBatch\");\n\t}\n}\n\n/**\n * @internal\n */\nexport interface SharedTreeOptions extends Partial<ICodecOptions> {\n\t/**\n\t * The {@link ForestType} indicating which forest type should be created for the SharedTree.\n\t */\n\tforest?: ForestType;\n\ttreeEncodeType?: TreeCompressionStrategy;\n}\n\n/**\n * Used to distinguish between different forest types.\n * @internal\n */\nexport enum ForestType {\n\t/**\n\t * The \"ObjectForest\" forest type.\n\t */\n\tReference = 0,\n\t/**\n\t * The \"ChunkedForest\" forest type.\n\t */\n\tOptimized = 1,\n}\n\nexport const defaultSharedTreeOptions: Required<SharedTreeOptions> = {\n\tjsonValidator: noopValidator,\n\tforest: ForestType.Reference,\n\ttreeEncodeType: TreeCompressionStrategy.Compressed,\n};\n\n/**\n * A channel factory that creates {@link ISharedTree}s.\n * @internal\n */\nexport class SharedTreeFactory implements IChannelFactory<ISharedTree> {\n\tpublic readonly type: string = \"https://graph.microsoft.com/types/tree\";\n\n\tpublic readonly attributes: IChannelAttributes = {\n\t\ttype: this.type,\n\t\tsnapshotFormatVersion: \"0.0.0\",\n\t\tpackageVersion: \"0.0.0\",\n\t};\n\n\tpublic constructor(private readonly options: SharedTreeOptions = {}) {}\n\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tchannelAttributes: Readonly<IChannelAttributes>,\n\t): Promise<ISharedTree> {\n\t\tconst tree = new SharedTree(id, runtime, channelAttributes, this.options, \"SharedTree\");\n\t\tawait tree.load(services);\n\t\treturn tree;\n\t}\n\n\tpublic create(runtime: IFluidDataStoreRuntime, id: string): ISharedTree {\n\t\tconst tree = new SharedTree(id, runtime, this.attributes, this.options, \"SharedTree\");\n\t\ttree.initializeLocal();\n\t\treturn tree;\n\t}\n}\n"]}
+{"version":3,"file":"sharedTree.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAS7D,uEAAsE;AAEtE,gDAAiE;AACjE,+CAO0B;AAC1B,iDAA0F;AAC1F,4DAgBuC;AACvC,2DAAyF;AAEzF,+CAAyC;AAEzC,2DAAyF;AACzF,uEAAsF;AACtF,2EAAqE;AAGrE,uDAAqF;AA0ErF,MAAM,oCAAoC,GAAG,IAAI,GAAG,CAAgC;IACnF,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAC/F,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;CAC/F,CAAC,CAAC;AAEH,SAAS,gBAAgB,CAAC,aAAqB;IAC9C,MAAM,QAAQ,GAAG,oCAAoC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACzE,IAAA,iBAAM,EAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACnE,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAa,UACZ,SAAQ,yBAAuD;IAO/D,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACnC,CAAC;IAED,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,YAA+B,EAC/B,sBAA8B;QAE9B,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;YACvC,MAAM,IAAI,qBAAU,CAAC,gDAAgD,CAAC,CAAC;SACvE;QAED,MAAM,OAAO,GAAG,EAAE,GAAG,gCAAwB,EAAE,GAAG,YAAY,EAAE,CAAC;QACjE,MAAM,aAAa,GAAG,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,qCAA0B,EAAE,CAAC;QAChD,MAAM,MAAM,GACX,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC,SAAS;YACtC,CAAC,CAAC,IAAA,6BAAkB,EAAC,IAAA,0BAAe,EAAC,MAAM,EAAE,8BAAmB,CAAC,CAAC;YAClE,CAAC,CAAC,IAAA,sBAAW,GAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACpE,MAAM,YAAY,GAAG,IAAA,iCAAsB,EAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;YACvE,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB;SACjE,CAAC,CAAC;QACH,MAAM,eAAe,GAAG,IAAA,8BAAmB,EAAC,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;QAE/E,MAAM,cAAc,GAAG;YACtB,MAAM,EAAE;gBACP,MAAM;gBACN,MAAM,EAAE,8BAAmB;aAC3B;YACD,UAAU,EAAE,OAAO,CAAC,cAAc;SAClC,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,2BAAgB,CAC5C,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,OAAO,CACP,CAAC;QACF,MAAM,sBAAsB,GAAG,IAAI,uCAA4B,CAAC,YAAY,CAAC,CAAC;QAC9E,MAAM,iBAAiB,GAAG,IAAI,kDAAsB,CACnD,gBAAgB,EAChB,eAAe,EACf,OAAO,EACP,OAAO,CAAC,cAAc,CACtB,CAAC;QACF,MAAM,YAAY,GAAG,IAAA,oCAAyB,EAC7C,iBAAiB,EACjB,kDAAsB,CAAC,WAAW,EAClC,CAAC,KAAc,EAAE,EAAE;YAClB,4CAA4C;YAC5C,oFAAoF;YACpF,4BAA4B;YAC5B,4FAA4F;YAC5F,0FAA0F;YAC1F,iGAAiG;YACjG,2EAA2E;YAC3E,2FAA2F;YAC3F,wFAAwF;YACxF,sFAAsF;YACtF,uFAAuF;YACvF,0BAA0B;YAC1B,kFAAkF;YAClF,gFAAgF;YAChF,oDAAoD;YACpD,MAAM,KAAK,CAAC;QACb,CAAC,CACD,CAAC;QACF,KAAK,CACJ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAC5D,YAAY,EACZ,OAAO,EACP,aAAa,EACb,EAAE,EACF,OAAO,EACP,UAAU,EACV,sBAAsB,EACtB,EAAE,MAAM,EAAE,MAAM,EAAE,8BAAmB,EAAE,CACvC,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,IAAA,wBAAa,GAAkB,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAA,oCAAkB,EACjC,OAAO,CAAC,YAAY,EACpB,IAAI,CAAC,eAAe,EACpB,gBAAgB,EAChB;YACC,MAAM,EAAE,WAAW;YACnB,YAAY;YACZ,MAAM;YACN,MAAM;YACN,eAAe;YACf,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY;YACZ,wBAAwB,EAAE,OAAO,CAAC,cAAc;SAChD,CACD,CAAC;IACH,CAAC;IAEM,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI;YACH,IAAA,8BAAmB,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClD,OAAO;gBACN,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;gBACjC,IAAI,EAAE,IAAA,sCAA2B,EAAC,MAAM,CAAC;gBACzC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;aACxC,CAAC;SACF;gBAAS;YACT,MAAM,CAAC,IAAI,EAAE,CAAC;SACd;IACF,CAAC;IAEM,kBAAkB,CACxB,MAAmD,EACnD,SAAqB;QAErB,MAAM,UAAU,GAAG,IAAI,qBAAU,CAAC,8BAAmB,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAA,gCAAY,EAAC,UAAU,EAAE,MAAM,CAAC,0BAA0B,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YACxF,OAAO,SAAS,CAAC;SACjB;QAED,OAAO,IAAA,uCAAa,EACnB,IAAI,CAAC,QAAQ,EACb,UAAU,EACV,SAAS,EACT,IAAA,+BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAC/C,IAAA,gBAAK,EAAC,0BAAsB,CAAC,CAC7B,CAAC;IACH,CAAC;IAEM,UAAU,CAChB,MAAgC;QAEhC,MAAM,IAAI,GAAG,IAAI,oDAA0B,CAC1C,IAAI,CAAC,QAAQ,EACb,MAAM,EACN,IAAA,+BAAoB,EAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAC/C,IAAA,gBAAK,EAAC,0BAAsB,CAAC,CAC7B,CAAC;QACF,mGAAmG;QACnG,IAAI,IAAI,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,aAAa,EAAE,CAAC;SACrB;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAEkB,KAAK,CAAC,QAAQ,CAAC,QAAgC;QACjE,MAAM,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;CACD;AAlKD,gCAkKC;AAED;;;;;GAKG;AACU,QAAA,uBAAuB,GAAG;IACtC;;;;;OAKG;IACH,EAAE,EAAE,CAAC;IAEL;;OAEG;IACH,EAAE,EAAE,CAAC;CACI,CAAC;AA+CX;;;GAGG;AACH,IAAY,UASX;AATD,WAAY,UAAU;IACrB;;OAEG;IACH,qDAAa,CAAA;IACb;;OAEG;IACH,qDAAa,CAAA;AACd,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAEY,QAAA,wBAAwB,GAAgC;IACpE,aAAa,EAAE,wBAAa;IAC5B,MAAM,EAAE,UAAU,CAAC,SAAS;IAC5B,cAAc,EAAE,kCAAuB,CAAC,UAAU;IAClD,aAAa,EAAE,+BAAuB,CAAC,EAAE;CACzC,CAAC;AAEF;;;GAGG;AACH,MAAa,iBAAiB;IAS7B,YAAoC,UAA6B,EAAE;QAA/B,YAAO,GAAP,OAAO,CAAwB;QARnD,SAAI,GAAW,wCAAwC,CAAC;QAExD,eAAU,GAAuB;YAChD,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,qBAAqB,EAAE,OAAO;YAC9B,cAAc,EAAE,OAAO;SACvB,CAAC;IAEoE,CAAC;IAEhE,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,iBAA+C;QAE/C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACxF,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,OAA+B,EAAE,EAAU;QACxD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACtF,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AA3BD,8CA2BC","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/internal\";\nimport {\n\tIChannelAttributes,\n\tIChannelFactory,\n\tIChannelServices,\n\tIChannelStorageService,\n\tIFluidDataStoreRuntime,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject } from \"@fluidframework/shared-object-base\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { ICodecOptions, noopValidator } from \"../codec/index.js\";\nimport {\n\tJsonableTree,\n\tRevisionTagCodec,\n\tTreeStoredSchema,\n\tTreeStoredSchemaRepository,\n\tmakeDetachedFieldIndex,\n\tmoveToDetachedField,\n} from \"../core/index.js\";\nimport { HasListeners, IEmitter, ISubscribable, createEmitter } from \"../events/index.js\";\nimport {\n\tDetachedFieldIndexSummarizer,\n\tFlexFieldSchema,\n\tForestSummarizer,\n\tSchemaSummarizer,\n\tTreeCompressionStrategy,\n\tViewSchema,\n\tbuildChunkedForest,\n\tbuildForest,\n\tcreateNodeKeyManager,\n\tnodeKeyFieldKey as defaultNodeKeyFieldKey,\n\tdefaultSchemaPolicy,\n\tjsonableTreeFromFieldCursor,\n\tmakeFieldBatchCodec,\n\tmakeMitigatedChangeFamily,\n\tmakeTreeChunker,\n} from \"../feature-libraries/index.js\";\nimport { ExplicitCoreCodecVersions, SharedTreeCore } from \"../shared-tree-core/index.js\";\nimport { ITree, ImplicitFieldSchema, TreeConfiguration, TreeView } from \"../simple-tree/index.js\";\nimport { brand } from \"../util/index.js\";\n\nimport { InitializeAndSchematizeConfiguration, ensureSchema } from \"./schematizeTree.js\";\nimport { SchematizingSimpleTreeView, requireSchema } from \"./schematizingTreeView.js\";\nimport { SharedTreeChangeFamily } from \"./sharedTreeChangeFamily.js\";\nimport { SharedTreeChange } from \"./sharedTreeChangeTypes.js\";\nimport { SharedTreeEditBuilder } from \"./sharedTreeEditBuilder.js\";\nimport { CheckoutEvents, TreeCheckout, createTreeCheckout } from \"./treeCheckout.js\";\nimport { CheckoutFlexTreeView, FlexTreeView } from \"./treeView.js\";\n\n/**\n * Copy of data from an {@link ISharedTree} at some point in time.\n * @remarks\n * This is unrelated to Fluids concept of \"snapshots\".\n * @internal\n */\nexport interface SharedTreeContentSnapshot {\n\t/**\n\t * The schema stored in the document.\n\t *\n\t * @remarks\n\t * Edits to the schema can mutate the schema stored of the tree which took this snapshot (but this snapshot will remain the same)\n\t * This is mainly useful for debugging cases where schematize reports an incompatible view schema.\n\t */\n\treadonly schema: TreeStoredSchema;\n\t/**\n\t * All {@link TreeStatus#InDocument} content.\n\t */\n\treadonly tree: JsonableTree[];\n\t/**\n\t * All {@link TreeStatus#Removed} content.\n\t */\n\treadonly removed: [string | number | undefined, number, JsonableTree][];\n}\n\n/**\n * Collaboratively editable tree distributed data-structure,\n * powered by {@link @fluidframework/shared-object-base#ISharedObject}.\n *\n * See [the README](../../README.md) for details.\n * @internal\n */\nexport interface ISharedTree extends ISharedObject, ITree {\n\t/**\n\t * Provides a copy of the current content of the tree.\n\t * This can be useful for inspecting the tree when no suitable view schema is available.\n\t * This is only intended for use in testing and exceptional code paths: it is not performant.\n\t *\n\t * This does not include everything that is included in a tree summary, since information about how to merge future edits is omitted.\n\t */\n\tcontentSnapshot(): SharedTreeContentSnapshot;\n\n\t/**\n\t * Like {@link ITree.schematize}, but uses the flex-tree schema system and exposes the tree as a flex-tree.\n\t *\n\t * Returned view is disposed when the stored schema becomes incompatible with the view schema.\n\t * Undefined is returned if the stored data could not be made compatible with the view schema.\n\t */\n\tschematizeFlexTree<TRoot extends FlexFieldSchema>(\n\t\tconfig: InitializeAndSchematizeConfiguration<TRoot>,\n\t\tonDispose: () => void,\n\t): FlexTreeView<TRoot> | undefined;\n}\n\n/**\n * Has an entry for each codec which writes an explicit version into its data.\n *\n * This is used to map the single API entrypoint controlling the format {@link SharedTreeOptions.formatVersion}\n * to a list of write versions that for each codec that should be used for that format.\n *\n * Note that all explicitly versioned codecs should be using the format version from the data to read encoded data.\n *\n * TODO: Plumb these write versions into forest, schema, detached field index codec creation.\n */\ninterface ExplicitCodecVersions extends ExplicitCoreCodecVersions {\n\tforest: number;\n\tschema: number;\n\tdetachedFieldIndex: number;\n\tfieldBatch: number;\n}\n\nconst formatVersionToTopLevelCodecVersions = new Map<number, ExplicitCodecVersions>([\n\t[1, { forest: 1, schema: 1, detachedFieldIndex: 1, editManager: 1, message: 1, fieldBatch: 1 }],\n\t[2, { forest: 1, schema: 1, detachedFieldIndex: 1, editManager: 2, message: 2, fieldBatch: 1 }],\n]);\n\nfunction getCodecVersions(formatVersion: number): ExplicitCodecVersions {\n\tconst versions = formatVersionToTopLevelCodecVersions.get(formatVersion);\n\tassert(versions !== undefined, 0x90e /* Unknown format version */);\n\treturn versions;\n}\n\n/**\n * Shared tree, configured with a good set of indexes and field kinds which will maintain compatibility over time.\n *\n * TODO: detail compatibility requirements.\n */\nexport class SharedTree\n\textends SharedTreeCore<SharedTreeEditBuilder, SharedTreeChange>\n\timplements ISharedTree\n{\n\tprivate readonly _events: ISubscribable<CheckoutEvents> &\n\t\tIEmitter<CheckoutEvents> &\n\t\tHasListeners<CheckoutEvents>;\n\tpublic readonly checkout: TreeCheckout;\n\tpublic get storedSchema(): TreeStoredSchemaRepository {\n\t\treturn this.checkout.storedSchema;\n\t}\n\n\tpublic constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\toptionsParam: SharedTreeOptions,\n\t\ttelemetryContextPrefix: string,\n\t) {\n\t\tif (runtime.idCompressor === undefined) {\n\t\t\tthrow new UsageError(\"IdCompressor must be enabled to use SharedTree\");\n\t\t}\n\n\t\tconst options = { ...defaultSharedTreeOptions, ...optionsParam };\n\t\tconst codecVersions = getCodecVersions(options.formatVersion);\n\t\tconst schema = new TreeStoredSchemaRepository();\n\t\tconst forest =\n\t\t\toptions.forest === ForestType.Optimized\n\t\t\t\t? buildChunkedForest(makeTreeChunker(schema, defaultSchemaPolicy))\n\t\t\t\t: buildForest();\n\t\tconst revisionTagCodec = new RevisionTagCodec(runtime.idCompressor);\n\t\tconst removedRoots = makeDetachedFieldIndex(\"repair\", revisionTagCodec, options);\n\t\tconst schemaSummarizer = new SchemaSummarizer(runtime, schema, options, {\n\t\t\tgetCurrentSeq: () => this.runtime.deltaManager.lastSequenceNumber,\n\t\t});\n\t\tconst fieldBatchCodec = makeFieldBatchCodec(options, codecVersions.fieldBatch);\n\n\t\tconst encoderContext = {\n\t\t\tschema: {\n\t\t\t\tschema,\n\t\t\t\tpolicy: defaultSchemaPolicy,\n\t\t\t},\n\t\t\tencodeType: options.treeEncodeType,\n\t\t};\n\t\tconst forestSummarizer = new ForestSummarizer(\n\t\t\tforest,\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\tencoderContext,\n\t\t\toptions,\n\t\t);\n\t\tconst removedRootsSummarizer = new DetachedFieldIndexSummarizer(removedRoots);\n\t\tconst innerChangeFamily = new SharedTreeChangeFamily(\n\t\t\trevisionTagCodec,\n\t\t\tfieldBatchCodec,\n\t\t\toptions,\n\t\t\toptions.treeEncodeType,\n\t\t);\n\t\tconst changeFamily = makeMitigatedChangeFamily(\n\t\t\tinnerChangeFamily,\n\t\t\tSharedTreeChangeFamily.emptyChange,\n\t\t\t(error: unknown) => {\n\t\t\t\t// TODO:6344 Add telemetry for these errors.\n\t\t\t\t// Rethrowing the error has a different effect depending on the context in which the\n\t\t\t\t// ChangeFamily was invoked:\n\t\t\t\t// - If the ChangeFamily was invoked as part of incoming op processing, rethrowing the error\n\t\t\t\t// will cause the runtime to disconnect the client, log a severe error, and not reconnect.\n\t\t\t\t// This will not cause the host application to crash because it is not on the stack at that time.\n\t\t\t\t// TODO: let the host application know that the client is now disconnected.\n\t\t\t\t// - If the ChangeFamily was invoked as part of dealing with a local change, rethrowing the\n\t\t\t\t// error will cause the host application to crash. This is not ideal, but is better than\n\t\t\t\t// letting the application either send an invalid change to the server or allowing the\n\t\t\t\t// application to continue working when its local branches contain edits that cannot be\n\t\t\t\t// reflected in its views.\n\t\t\t\t// The best course of action for a host application in such a state is to restart.\n\t\t\t\t// TODO: let the host application know about this situation and provide a way to\n\t\t\t\t// programmatically reload the SharedTree container.\n\t\t\t\tthrow error;\n\t\t\t},\n\t\t);\n\t\tsuper(\n\t\t\t[schemaSummarizer, forestSummarizer, removedRootsSummarizer],\n\t\t\tchangeFamily,\n\t\t\toptions,\n\t\t\tcodecVersions,\n\t\t\tid,\n\t\t\truntime,\n\t\t\tattributes,\n\t\t\ttelemetryContextPrefix,\n\t\t\t{ schema, policy: defaultSchemaPolicy },\n\t\t);\n\t\tthis._events = createEmitter<CheckoutEvents>();\n\t\tconst localBranch = this.getLocalBranch();\n\t\tthis.checkout = createTreeCheckout(\n\t\t\truntime.idCompressor,\n\t\t\tthis.mintRevisionTag,\n\t\t\trevisionTagCodec,\n\t\t\t{\n\t\t\t\tbranch: localBranch,\n\t\t\t\tchangeFamily,\n\t\t\t\tschema,\n\t\t\t\tforest,\n\t\t\t\tfieldBatchCodec,\n\t\t\t\tevents: this._events,\n\t\t\t\tremovedRoots,\n\t\t\t\tchunkCompressionStrategy: options.treeEncodeType,\n\t\t\t},\n\t\t);\n\t}\n\n\tpublic contentSnapshot(): SharedTreeContentSnapshot {\n\t\tconst cursor = this.checkout.forest.allocateCursor();\n\t\ttry {\n\t\t\tmoveToDetachedField(this.checkout.forest, cursor);\n\t\t\treturn {\n\t\t\t\tschema: this.storedSchema.clone(),\n\t\t\t\ttree: jsonableTreeFromFieldCursor(cursor),\n\t\t\t\tremoved: this.checkout.getRemovedRoots(),\n\t\t\t};\n\t\t} finally {\n\t\t\tcursor.free();\n\t\t}\n\t}\n\n\tpublic schematizeFlexTree<TRoot extends FlexFieldSchema>(\n\t\tconfig: InitializeAndSchematizeConfiguration<TRoot>,\n\t\tonDispose: () => void,\n\t): CheckoutFlexTreeView<TRoot> | undefined {\n\t\tconst viewSchema = new ViewSchema(defaultSchemaPolicy, {}, config.schema);\n\t\tif (!ensureSchema(viewSchema, config.allowedSchemaModifications, this.checkout, config)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\treturn requireSchema(\n\t\t\tthis.checkout,\n\t\t\tviewSchema,\n\t\t\tonDispose,\n\t\t\tcreateNodeKeyManager(this.runtime.idCompressor),\n\t\t\tbrand(defaultNodeKeyFieldKey),\n\t\t);\n\t}\n\n\tpublic schematize<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeConfiguration<TRoot>,\n\t): TreeView<TRoot> {\n\t\tconst view = new SchematizingSimpleTreeView(\n\t\t\tthis.checkout,\n\t\t\tconfig,\n\t\t\tcreateNodeKeyManager(this.runtime.idCompressor),\n\t\t\tbrand(defaultNodeKeyFieldKey),\n\t\t);\n\t\t// As a subjective API design choice, we initialize the tree here if it is not already initialized.\n\t\tif (view.error?.canInitialize === true) {\n\t\t\tview.upgradeSchema();\n\t\t}\n\t\treturn view;\n\t}\n\n\tprotected override async loadCore(services: IChannelStorageService): Promise<void> {\n\t\tawait super.loadCore(services);\n\t\tthis._events.emit(\"afterBatch\");\n\t}\n}\n\n/**\n * Format versions supported by SharedTree.\n *\n * Each version documents a required minimum version of the \\@fluidframework/tree package.\n * @internal\n */\nexport const SharedTreeFormatVersion = {\n\t/**\n\t * Requires \\@fluidframework/tree \\>= 2.0.0.\n\t *\n\t * @deprecated - FF does not currently plan on supporting this format long-term.\n\t * Do not write production documents using this format, as they may not be loadable in the future.\n\t */\n\tv1: 1,\n\n\t/**\n\t * Requires \\@fluidframework/tree \\>= 2.0.0.\n\t */\n\tv2: 2,\n} as const;\n\n/**\n * Format versions supported by SharedTree.\n *\n * Each version documents a required minimum version of the \\@fluidframework/tree package.\n * @internal\n * @privateRemarks\n * See packages/dds/tree/docs/main/compatibility.md for information on how to add support for a new format.\n */\nexport type SharedTreeFormatVersion = typeof SharedTreeFormatVersion;\n\n/**\n * @internal\n */\nexport type SharedTreeOptions = Partial<ICodecOptions> &\n\tPartial<SharedTreeFormatOptions> & {\n\t\t/**\n\t\t * The {@link ForestType} indicating which forest type should be created for the SharedTree.\n\t\t */\n\t\tforest?: ForestType;\n\t};\n\n/**\n * Options for configuring the persisted format SharedTree uses.\n * @internal\n */\nexport interface SharedTreeFormatOptions {\n\t/**\n\t * See {@link TreeCompressionStrategy}.\n\t * default: TreeCompressionStrategy.Compressed\n\t */\n\ttreeEncodeType: TreeCompressionStrategy;\n\t/**\n\t * The format version SharedTree should use to persist documents.\n\t *\n\t * This option has compatibility implications for applications using SharedTree.\n\t * Each version documents a required minimum version of \\@fluidframework/tree.\n\t * If this minimum version fails to be met, the SharedTree may fail to load.\n\t * To be safe, application authors should verify that they have saturated this version\n\t * of \\@fluidframework/tree in their ecosystem before changing the format version.\n\t *\n\t * This option defaults to SharedTreeFormatVersion.v2.\n\t */\n\tformatVersion: SharedTreeFormatVersion[keyof SharedTreeFormatVersion];\n}\n\n/**\n * Used to distinguish between different forest types.\n * @internal\n */\nexport enum ForestType {\n\t/**\n\t * The \"ObjectForest\" forest type.\n\t */\n\tReference = 0,\n\t/**\n\t * The \"ChunkedForest\" forest type.\n\t */\n\tOptimized = 1,\n}\n\nexport const defaultSharedTreeOptions: Required<SharedTreeOptions> = {\n\tjsonValidator: noopValidator,\n\tforest: ForestType.Reference,\n\ttreeEncodeType: TreeCompressionStrategy.Compressed,\n\tformatVersion: SharedTreeFormatVersion.v2,\n};\n\n/**\n * A channel factory that creates {@link ISharedTree}s.\n * @internal\n */\nexport class SharedTreeFactory implements IChannelFactory<ISharedTree> {\n\tpublic readonly type: string = \"https://graph.microsoft.com/types/tree\";\n\n\tpublic readonly attributes: IChannelAttributes = {\n\t\ttype: this.type,\n\t\tsnapshotFormatVersion: \"0.0.0\",\n\t\tpackageVersion: \"0.0.0\",\n\t};\n\n\tpublic constructor(private readonly options: SharedTreeOptions = {}) {}\n\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tchannelAttributes: Readonly<IChannelAttributes>,\n\t): Promise<ISharedTree> {\n\t\tconst tree = new SharedTree(id, runtime, channelAttributes, this.options, \"SharedTree\");\n\t\tawait tree.load(services);\n\t\treturn tree;\n\t}\n\n\tpublic create(runtime: IFluidDataStoreRuntime, id: string): ISharedTree {\n\t\tconst tree = new SharedTree(id, runtime, this.attributes, this.options, \"SharedTree\");\n\t\ttree.initializeLocal();\n\t\treturn tree;\n\t}\n}\n"]}

package/dist/shared-tree/sharedTreeChangeCodecs.d.ts

@@ -2,11 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IJsonCodec, ICodecOptions, ICodecFamily } from "../codec/index.js";
+import { ICodecFamily, ICodecOptions } from "../codec/index.js";
 import { ChangeEncodingContext } from "../core/index.js";
-import { EncodedModularChangeset, ModularChangeset } from "../feature-libraries/index.js";
+import { ModularChangeset } from "../feature-libraries/index.js";
 import { SharedTreeChange } from "./sharedTreeChangeTypes.js";
-import { EncodedSharedTreeChange } from "./sharedTreeChangeFormat.js";
-export declare function makeSharedTreeChangeCodec(modularChangeCodec: IJsonCodec<ModularChangeset, EncodedModularChangeset, EncodedModularChangeset, ChangeEncodingContext>, codecOptions: ICodecOptions): IJsonCodec<SharedTreeChange, EncodedSharedTreeChange, EncodedSharedTreeChange, ChangeEncodingContext>;
-export declare function makeSharedTreeChangeCodecFamily(modularChangeCodec: IJsonCodec<ModularChangeset, EncodedModularChangeset, EncodedModularChangeset, ChangeEncodingContext>, options: ICodecOptions): ICodecFamily<SharedTreeChange, ChangeEncodingContext>;
+export declare function makeSharedTreeChangeCodecFamily(modularChangeCodecFamily: ICodecFamily<ModularChangeset, ChangeEncodingContext>, options: ICodecOptions): ICodecFamily<SharedTreeChange, ChangeEncodingContext>;
 //# sourceMappingURL=sharedTreeChangeCodecs.d.ts.map

package/dist/shared-tree/sharedTreeChangeCodecs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EACV,aAAa,EACb,YAAY,EAGZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAoB,MAAM,kBAAkB,CAAC;AAE3E,OAAO,EACN,uBAAuB,EACvB,gBAAgB,EAGhB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAyB,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAgC,MAAM,6BAA6B,CAAC;AAEpG,wBAAgB,yBAAyB,CACxC,kBAAkB,EAAE,UAAU,CAC7B,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,CACrB,EACD,YAAY,EAAE,aAAa,GACzB,UAAU,CACZ,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,CACrB,CA8DA;AAED,wBAAgB,+BAA+B,CAC9C,kBAAkB,EAAE,UAAU,CAC7B,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,CACrB,EACD,OAAO,EAAE,aAAa,GACpB,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAEvD"}
+{"version":3,"file":"sharedTreeChangeCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,YAAY,EACZ,aAAa,EAIb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAoB,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EACN,gBAAgB,EAIhB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,EAAE,gBAAgB,EAAyB,MAAM,4BAA4B,CAAC;AAErF,wBAAgB,+BAA+B,CAC9C,wBAAwB,EAAE,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,EAC/E,OAAO,EAAE,aAAa,GACpB,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAoBvD"}

package/dist/shared-tree/sharedTreeChangeCodecs.js

@@ -4,12 +4,25 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeSharedTreeChangeCodecFamily = exports.makeSharedTreeChangeCodec = void 0;
+exports.makeSharedTreeChangeCodecFamily = void 0;
 const index_js_1 = require("../codec/index.js");
 const index_js_2 = require("../feature-libraries/index.js");
 const sharedTreeChangeFormat_js_1 = require("./sharedTreeChangeFormat.js");
-function makeSharedTreeChangeCodec(modularChangeCodec, codecOptions) {
-    const schemaChangeCodec = (0, index_js_2.makeSchemaChangeCodec)(codecOptions);
+function makeSharedTreeChangeCodecFamily(modularChangeCodecFamily, options) {
+    const schemaChangeCodecs = (0, index_js_2.makeSchemaChangeCodecs)(options);
+    return (0, index_js_1.makeCodecFamily)([
+        [
+            1,
+            makeSharedTreeChangeCodec(modularChangeCodecFamily.resolve(1).json, schemaChangeCodecs.resolve(1).json, options),
+        ],
+        [
+            2,
+            makeSharedTreeChangeCodec(modularChangeCodecFamily.resolve(2).json, schemaChangeCodecs.resolve(1).json, options),
+        ],
+    ]);
+}
+exports.makeSharedTreeChangeCodecFamily = makeSharedTreeChangeCodecFamily;
+function makeSharedTreeChangeCodec(modularChangeCodec, schemaChangeCodec, codecOptions) {
     const decoderLibrary = new index_js_1.DiscriminatedUnionDispatcher({
         data(encoded, context) {
             return {
@@ -24,7 +37,7 @@ function makeSharedTreeChangeCodec(modularChangeCodec, codecOptions) {
             };
         },
     });
-    return {
+    return (0, index_js_1.withSchemaValidation)(sharedTreeChangeFormat_js_1.EncodedSharedTreeChange, {
         encode: (change, context) => {
             const changes = [];
             let updatedSchema;
@@ -61,12 +74,6 @@ function makeSharedTreeChangeCodec(modularChangeCodec, codecOptions) {
             }
             return { changes };
         },
-        encodedSchema: sharedTreeChangeFormat_js_1.EncodedSharedTreeChange,
-    };
+    }, codecOptions.jsonValidator);
 }
-exports.makeSharedTreeChangeCodec = makeSharedTreeChangeCodec;
-function makeSharedTreeChangeCodecFamily(modularChangeCodec, options) {
-    return (0, index_js_1.makeCodecFamily)([[0, makeSharedTreeChangeCodec(modularChangeCodec, options)]]);
-}
-exports.makeSharedTreeChangeCodecFamily = makeSharedTreeChangeCodecFamily;
 //# sourceMappingURL=sharedTreeChangeCodecs.js.map

package/dist/shared-tree/sharedTreeChangeCodecs.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeCodecs.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gDAM2B;AAG3B,4DAKuC;AAEvC,2EAAoG;AAEpG,SAAgB,yBAAyB,CACxC,kBAKC,EACD,YAA2B;IAO3B,MAAM,iBAAiB,GAAG,IAAA,gCAAqB,EAAC,YAAY,CAAC,CAAC;IAE9D,MAAM,cAAc,GAAG,IAAI,uCAA4B,CAIrD;QACD,IAAI,CAAC,OAAO,EAAE,OAAO;YACpB,OAAO;gBACN,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;aACxD,CAAC;QACH,CAAC;QACD,MAAM,CAAC,OAAO;YACb,OAAO;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC;aAC9C,CAAC;QACH,CAAC;KACD,CAAC,CAAC;IAEH,OAAO;QACN,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,aAA2C,CAAC;YAChD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE;gBAC3C,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE;oBAClC,MAAM,eAAe,GACpB,aAAa,KAAK,SAAS;wBAC1B,CAAC,CAAC;4BACA,MAAM,EACL,OAAO,CAAC,MAAM,KAAK,SAAS;gCAC3B,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM;gCACvB,CAAC,CAAC,8BAAmB;4BACvB,MAAM,EAAE,aAAa;yBACpB;wBACH,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;oBACnB,OAAO,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE;4BAC1D,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,MAAM,EAAE,eAAe;yBACvB,CAAC;qBACF,CAAC,CAAC;iBACH;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;oBAC3C,OAAO,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC;qBAC3D,CAAC,CAAC;oBACH,aAAa,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;iBACrD;aACD;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE;YAClC,MAAM,OAAO,GAAyC,EAAE,CAAC;YACzD,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;aAC1D;YACD,OAAO,EAAE,OAAO,EAAE,CAAC;QACpB,CAAC;QACD,aAAa,EAAE,mDAAuB;KACtC,CAAC;AACH,CAAC;AA3ED,8DA2EC;AAED,SAAgB,+BAA+B,CAC9C,kBAKC,EACD,OAAsB;IAEtB,OAAO,IAAA,0BAAe,EAAC,CAAC,CAAC,CAAC,EAAE,yBAAyB,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,CAAC;AAVD,0EAUC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIJsonCodec,\n\tICodecOptions,\n\tICodecFamily,\n\tmakeCodecFamily,\n\tDiscriminatedUnionDispatcher,\n} from \"../codec/index.js\";\nimport { ChangeEncodingContext, TreeStoredSchema } from \"../core/index.js\";\nimport { Mutable } from \"../util/index.js\";\nimport {\n\tEncodedModularChangeset,\n\tModularChangeset,\n\tdefaultSchemaPolicy,\n\tmakeSchemaChangeCodec,\n} from \"../feature-libraries/index.js\";\nimport { SharedTreeChange, SharedTreeInnerChange } from \"./sharedTreeChangeTypes.js\";\nimport { EncodedSharedTreeChange, EncodedSharedTreeInnerChange } from \"./sharedTreeChangeFormat.js\";\n\nexport function makeSharedTreeChangeCodec(\n\tmodularChangeCodec: IJsonCodec<\n\t\tModularChangeset,\n\t\tEncodedModularChangeset,\n\t\tEncodedModularChangeset,\n\t\tChangeEncodingContext\n\t>,\n\tcodecOptions: ICodecOptions,\n): IJsonCodec<\n\tSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tChangeEncodingContext\n> {\n\tconst schemaChangeCodec = makeSchemaChangeCodec(codecOptions);\n\n\tconst decoderLibrary = new DiscriminatedUnionDispatcher<\n\t\tEncodedSharedTreeInnerChange,\n\t\t[context: ChangeEncodingContext],\n\t\tSharedTreeInnerChange\n\t>({\n\t\tdata(encoded, context): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"data\",\n\t\t\t\tinnerChange: modularChangeCodec.decode(encoded, context),\n\t\t\t};\n\t\t},\n\t\tschema(encoded): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"schema\",\n\t\t\t\tinnerChange: schemaChangeCodec.decode(encoded),\n\t\t\t};\n\t\t},\n\t});\n\n\treturn {\n\t\tencode: (change, context) => {\n\t\t\tconst changes: EncodedSharedTreeInnerChange[] = [];\n\t\t\tlet updatedSchema: TreeStoredSchema | undefined;\n\t\t\tfor (const decodedChange of change.changes) {\n\t\t\t\tif (decodedChange.type === \"data\") {\n\t\t\t\t\tconst schemaAndPolicy =\n\t\t\t\t\t\tupdatedSchema !== undefined\n\t\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\t\tpolicy:\n\t\t\t\t\t\t\t\t\t\tcontext.schema !== undefined\n\t\t\t\t\t\t\t\t\t\t\t? context.schema.policy\n\t\t\t\t\t\t\t\t\t\t\t: defaultSchemaPolicy,\n\t\t\t\t\t\t\t\t\tschema: updatedSchema,\n\t\t\t\t\t\t\t  }\n\t\t\t\t\t\t\t: context.schema;\n\t\t\t\t\tchanges.push({\n\t\t\t\t\t\tdata: modularChangeCodec.encode(decodedChange.innerChange, {\n\t\t\t\t\t\t\toriginatorId: context.originatorId,\n\t\t\t\t\t\t\tschema: schemaAndPolicy,\n\t\t\t\t\t\t}),\n\t\t\t\t\t});\n\t\t\t\t} else if (decodedChange.type === \"schema\") {\n\t\t\t\t\tchanges.push({\n\t\t\t\t\t\tschema: schemaChangeCodec.encode(decodedChange.innerChange),\n\t\t\t\t\t});\n\t\t\t\t\tupdatedSchema = decodedChange.innerChange.schema.new;\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn changes;\n\t\t},\n\t\tdecode: (encodedChange, context) => {\n\t\t\tconst changes: Mutable<SharedTreeChange[\"changes\"]> = [];\n\t\t\tfor (const subChange of encodedChange) {\n\t\t\t\tchanges.push(decoderLibrary.dispatch(subChange, context));\n\t\t\t}\n\t\t\treturn { changes };\n\t\t},\n\t\tencodedSchema: EncodedSharedTreeChange,\n\t};\n}\n\nexport function makeSharedTreeChangeCodecFamily(\n\tmodularChangeCodec: IJsonCodec<\n\t\tModularChangeset,\n\t\tEncodedModularChangeset,\n\t\tEncodedModularChangeset,\n\t\tChangeEncodingContext\n\t>,\n\toptions: ICodecOptions,\n): ICodecFamily<SharedTreeChange, ChangeEncodingContext> {\n\treturn makeCodecFamily([[0, makeSharedTreeChangeCodec(modularChangeCodec, options)]]);\n}\n"]}
+{"version":3,"file":"sharedTreeChangeCodecs.js","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gDAO2B;AAE3B,4DAKuC;AAGvC,2EAAoG;AAGpG,SAAgB,+BAA+B,CAC9C,wBAA+E,EAC/E,OAAsB;IAEtB,MAAM,kBAAkB,GAAG,IAAA,iCAAsB,EAAC,OAAO,CAAC,CAAC;IAC3D,OAAO,IAAA,0BAAe,EAAC;QACtB;YACC,CAAC;YACD,yBAAyB,CACxB,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EACxC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAClC,OAAO,CACP;SACD;QACD;YACC,CAAC;YACD,yBAAyB,CACxB,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EACxC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAClC,OAAO,CACP;SACD;KACD,CAAC,CAAC;AACJ,CAAC;AAvBD,0EAuBC;AAED,SAAS,yBAAyB,CACjC,kBAKC,EACD,iBAA2C,EAC3C,YAA2B;IAO3B,MAAM,cAAc,GAAG,IAAI,uCAA4B,CAIrD;QACD,IAAI,CAAC,OAAO,EAAE,OAAO;YACpB,OAAO;gBACN,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;aACxD,CAAC;QACH,CAAC;QACD,MAAM,CAAC,OAAO;YACb,OAAO;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC;aAC9C,CAAC;QACH,CAAC;KACD,CAAC,CAAC;IAEH,OAAO,IAAA,+BAAoB,EAC1B,mDAAuB,EACvB;QACC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,aAA2C,CAAC;YAChD,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE;gBAC3C,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM,EAAE;oBAClC,MAAM,eAAe,GACpB,aAAa,KAAK,SAAS;wBAC1B,CAAC,CAAC;4BACA,MAAM,EACL,OAAO,CAAC,MAAM,KAAK,SAAS;gCAC3B,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM;gCACvB,CAAC,CAAC,8BAAmB;4BACvB,MAAM,EAAE,aAAa;yBACpB;wBACH,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;oBACnB,OAAO,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE;4BAC1D,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,MAAM,EAAE,eAAe;yBACvB,CAAC;qBACF,CAAC,CAAC;iBACH;qBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;oBAC3C,OAAO,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC;qBAC3D,CAAC,CAAC;oBACH,aAAa,GAAG,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;iBACrD;aACD;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE;YAClC,MAAM,OAAO,GAAyC,EAAE,CAAC;YACzD,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE;gBACtC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;aAC1D;YACD,OAAO,EAAE,OAAO,EAAE,CAAC;QACpB,CAAC;KACD,EACD,YAAY,CAAC,aAAa,CAC1B,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tDiscriminatedUnionDispatcher,\n\tICodecFamily,\n\tICodecOptions,\n\tIJsonCodec,\n\tmakeCodecFamily,\n\twithSchemaValidation,\n} from \"../codec/index.js\";\nimport { ChangeEncodingContext, TreeStoredSchema } from \"../core/index.js\";\nimport {\n\tModularChangeset,\n\ttype SchemaChange,\n\tdefaultSchemaPolicy,\n\tmakeSchemaChangeCodecs,\n} from \"../feature-libraries/index.js\";\nimport { type JsonCompatibleReadOnly, Mutable } from \"../util/index.js\";\n\nimport { EncodedSharedTreeChange, EncodedSharedTreeInnerChange } from \"./sharedTreeChangeFormat.js\";\nimport { SharedTreeChange, SharedTreeInnerChange } from \"./sharedTreeChangeTypes.js\";\n\nexport function makeSharedTreeChangeCodecFamily(\n\tmodularChangeCodecFamily: ICodecFamily<ModularChangeset, ChangeEncodingContext>,\n\toptions: ICodecOptions,\n): ICodecFamily<SharedTreeChange, ChangeEncodingContext> {\n\tconst schemaChangeCodecs = makeSchemaChangeCodecs(options);\n\treturn makeCodecFamily([\n\t\t[\n\t\t\t1,\n\t\t\tmakeSharedTreeChangeCodec(\n\t\t\t\tmodularChangeCodecFamily.resolve(1).json,\n\t\t\t\tschemaChangeCodecs.resolve(1).json,\n\t\t\t\toptions,\n\t\t\t),\n\t\t],\n\t\t[\n\t\t\t2,\n\t\t\tmakeSharedTreeChangeCodec(\n\t\t\t\tmodularChangeCodecFamily.resolve(2).json,\n\t\t\t\tschemaChangeCodecs.resolve(1).json,\n\t\t\t\toptions,\n\t\t\t),\n\t\t],\n\t]);\n}\n\nfunction makeSharedTreeChangeCodec(\n\tmodularChangeCodec: IJsonCodec<\n\t\tModularChangeset,\n\t\tJsonCompatibleReadOnly,\n\t\tJsonCompatibleReadOnly,\n\t\tChangeEncodingContext\n\t>,\n\tschemaChangeCodec: IJsonCodec<SchemaChange>,\n\tcodecOptions: ICodecOptions,\n): IJsonCodec<\n\tSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tEncodedSharedTreeChange,\n\tChangeEncodingContext\n> {\n\tconst decoderLibrary = new DiscriminatedUnionDispatcher<\n\t\tEncodedSharedTreeInnerChange,\n\t\t[context: ChangeEncodingContext],\n\t\tSharedTreeInnerChange\n\t>({\n\t\tdata(encoded, context): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"data\",\n\t\t\t\tinnerChange: modularChangeCodec.decode(encoded, context),\n\t\t\t};\n\t\t},\n\t\tschema(encoded): SharedTreeInnerChange {\n\t\t\treturn {\n\t\t\t\ttype: \"schema\",\n\t\t\t\tinnerChange: schemaChangeCodec.decode(encoded),\n\t\t\t};\n\t\t},\n\t});\n\n\treturn withSchemaValidation(\n\t\tEncodedSharedTreeChange,\n\t\t{\n\t\t\tencode: (change, context) => {\n\t\t\t\tconst changes: EncodedSharedTreeInnerChange[] = [];\n\t\t\t\tlet updatedSchema: TreeStoredSchema | undefined;\n\t\t\t\tfor (const decodedChange of change.changes) {\n\t\t\t\t\tif (decodedChange.type === \"data\") {\n\t\t\t\t\t\tconst schemaAndPolicy =\n\t\t\t\t\t\t\tupdatedSchema !== undefined\n\t\t\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\t\t\tpolicy:\n\t\t\t\t\t\t\t\t\t\t\tcontext.schema !== undefined\n\t\t\t\t\t\t\t\t\t\t\t\t? context.schema.policy\n\t\t\t\t\t\t\t\t\t\t\t\t: defaultSchemaPolicy,\n\t\t\t\t\t\t\t\t\t\tschema: updatedSchema,\n\t\t\t\t\t\t\t\t  }\n\t\t\t\t\t\t\t\t: context.schema;\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tdata: modularChangeCodec.encode(decodedChange.innerChange, {\n\t\t\t\t\t\t\t\toriginatorId: context.originatorId,\n\t\t\t\t\t\t\t\tschema: schemaAndPolicy,\n\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t});\n\t\t\t\t\t} else if (decodedChange.type === \"schema\") {\n\t\t\t\t\t\tchanges.push({\n\t\t\t\t\t\t\tschema: schemaChangeCodec.encode(decodedChange.innerChange),\n\t\t\t\t\t\t});\n\t\t\t\t\t\tupdatedSchema = decodedChange.innerChange.schema.new;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn changes;\n\t\t\t},\n\t\t\tdecode: (encodedChange, context) => {\n\t\t\t\tconst changes: Mutable<SharedTreeChange[\"changes\"]> = [];\n\t\t\t\tfor (const subChange of encodedChange) {\n\t\t\t\t\tchanges.push(decoderLibrary.dispatch(subChange, context));\n\t\t\t\t}\n\t\t\t\treturn { changes };\n\t\t\t},\n\t\t},\n\t\tcodecOptions.jsonValidator,\n\t);\n}\n"]}

package/dist/shared-tree/sharedTreeChangeFamily.d.ts

@@ -23,4 +23,5 @@ export declare class SharedTreeChangeFamily implements ChangeFamily<SharedTreeEd
     rebase(change: SharedTreeChange, over: TaggedChange<SharedTreeChange>, revisionMetadata: RevisionMetadataSource): SharedTreeChange;
     get rebaser(): ChangeRebaser<SharedTreeChange>;
 }
+export declare function hasSchemaChange(change: SharedTreeChange): boolean;
 //# sourceMappingURL=sharedTreeChangeFamily.d.ts.map

package/dist/shared-tree/sharedTreeChangeFamily.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedTreeChangeFamily.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeFamily.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EACN,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EAEZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAIN,eAAe,EACf,uBAAuB,EACvB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE;;;;GAIG;AACH,qBAAa,sBACZ,YACC,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACrD,aAAa,CAAC,gBAAgB,CAAC;IAEhC,gBAAuB,WAAW,EAAE,gBAAgB,CAElD;IAEF,SAAgB,MAAM,EAAE,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAAC;IAC9E,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAsB;gBAGzD,gBAAgB,EAAE,gBAAgB,EAClC,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,aAAa,EAC3B,wBAAwB,CAAC,EAAE,uBAAuB;IAe5C,WAAW,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,qBAAqB;IAItF,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,GAAG,gBAAgB;IA6BpE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,OAAO,GAAG,gBAAgB;IAiCrF,MAAM,CACZ,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,YAAY,CAAC,gBAAgB,CAAC,EACpC,gBAAgB,EAAE,sBAAsB,GACtC,gBAAgB;IA0CnB,IAAW,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAEpD;CACD"}
+{"version":3,"file":"sharedTreeChangeFamily.d.ts","sourceRoot":"","sources":["../../src/shared-tree/sharedTreeChangeFamily.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EACN,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,YAAY,EAEZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACN,eAAe,EAGf,uBAAuB,EAIvB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE;;;;GAIG;AACH,qBAAa,sBACZ,YACC,YAAY,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,EACrD,aAAa,CAAC,gBAAgB,CAAC;IAEhC,gBAAuB,WAAW,EAAE,gBAAgB,CAElD;IAEF,SAAgB,MAAM,EAAE,YAAY,CAAC,gBAAgB,EAAE,qBAAqB,CAAC,CAAC;IAC9E,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAsB;gBAGzD,gBAAgB,EAAE,gBAAgB,EAClC,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,aAAa,EAC3B,wBAAwB,CAAC,EAAE,uBAAuB;IAgB5C,WAAW,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,GAAG,qBAAqB;IAItF,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,GAAG,gBAAgB;IA6BpE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,OAAO,GAAG,gBAAgB;IAkCrF,MAAM,CACZ,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,YAAY,CAAC,gBAAgB,CAAC,EACpC,gBAAgB,EAAE,sBAAsB,GACtC,gBAAgB;IA0CnB,IAAW,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAEpD;CACD;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAEjE"}

package/dist/shared-tree/sharedTreeChangeFamily.js

@@ -4,8 +4,8 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SharedTreeChangeFamily = void 0;
-const core_utils_1 = require("@fluidframework/core-utils");
+exports.hasSchemaChange = exports.SharedTreeChangeFamily = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
 const index_js_1 = require("../core/index.js");
 const index_js_2 = require("../feature-libraries/index.js");
 const index_js_3 = require("../util/index.js");
@@ -18,8 +18,9 @@ const sharedTreeEditBuilder_js_1 = require("./sharedTreeEditBuilder.js");
  */
 class SharedTreeChangeFamily {
     constructor(revisionTagCodec, fieldBatchCodec, codecOptions, chunkCompressionStrategy) {
-        this.modularChangeFamily = new index_js_2.ModularChangeFamily(index_js_2.fieldKinds, revisionTagCodec, fieldBatchCodec, codecOptions, chunkCompressionStrategy);
-        this.codecs = (0, sharedTreeChangeCodecs_js_1.makeSharedTreeChangeCodecFamily)(this.modularChangeFamily.latestCodec, codecOptions);
+        const modularChangeCodec = (0, index_js_2.makeModularChangeCodecFamily)(index_js_2.fieldKindConfigurations, revisionTagCodec, fieldBatchCodec, codecOptions, chunkCompressionStrategy);
+        this.modularChangeFamily = new index_js_2.ModularChangeFamily(index_js_2.fieldKinds, modularChangeCodec);
+        this.codecs = (0, sharedTreeChangeCodecs_js_1.makeSharedTreeChangeCodecFamily)(this.modularChangeFamily.codecs, codecOptions);
     }
     buildEditor(changeReceiver) {
         return new sharedTreeEditBuilder_js_1.SharedTreeEditBuilder(this.modularChangeFamily, changeReceiver);
@@ -66,6 +67,7 @@ class SharedTreeChangeFamily {
                                 new: innerChange.innerChange.schema.old,
                                 old: innerChange.innerChange.schema.new,
                             },
+                            isInverse: true,
                         },
                     };
                 }
@@ -92,10 +94,10 @@ class SharedTreeChangeFamily {
             // will result in rebase never being called.
             return SharedTreeChangeFamily.emptyChange;
         }
-        (0, core_utils_1.assert)(change.changes.length === 1 && over.change.changes.length === 1, 0x884 /* SharedTreeChange should have exactly one inner change if no schema change is present. */);
+        (0, internal_1.assert)(change.changes.length === 1 && over.change.changes.length === 1, 0x884 /* SharedTreeChange should have exactly one inner change if no schema change is present. */);
         const dataChangeIntention = change.changes[0];
         const dataChangeOver = over.change.changes[0];
-        (0, core_utils_1.assert)(dataChangeIntention.type === "data" && dataChangeOver.type === "data", 0x885 /* Data change should be present. */);
+        (0, internal_1.assert)(dataChangeIntention.type === "data" && dataChangeOver.type === "data", 0x885 /* Data change should be present. */);
         return {
             changes: [
                 {
@@ -116,4 +118,5 @@ SharedTreeChangeFamily.emptyChange = {
 function hasSchemaChange(change) {
     return change.changes.some((innerChange) => innerChange.type === "schema");
 }
+exports.hasSchemaChange = hasSchemaChange;
 //# sourceMappingURL=sharedTreeChangeFamily.js.map