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

package/lib/test/feature-libraries/modular-schema/schemaEvolutionExamples.spec.js

@@ -1,390 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { strict as assert } from "assert";
-import { FlexFieldSchema, ViewSchema, FieldKinds, defaultSchemaPolicy, } from "../../../feature-libraries/index.js";
-import { TreeStoredSchemaRepository, Compatibility, storedEmptyFieldSchema, } from "../../../core/index.js";
-import { allowsFieldSuperset, allowsTreeSuperset,
-// eslint-disable-next-line import/no-internal-modules
- } from "../../../feature-libraries/modular-schema/index.js";
-import { SchemaBuilder, leaf } from "../../../domains/index.js";
-class TestSchemaRepository extends TreeStoredSchemaRepository {
-    constructor(policy, data) {
-        super(data);
-        this.policy = policy;
-    }
-    /**
-     * Updates the specified schema iff all possible in schema data would remain in schema after the change.
-     * @returns true iff update was performed.
-     */
-    tryUpdateRootFieldSchema(schema) {
-        if (allowsFieldSuperset(this.policy, this, this.rootFieldSchema, schema)) {
-            this.rootFieldSchemaData = schema;
-            this.events.emit("afterSchemaChange", this);
-            return true;
-        }
-        return false;
-    }
-    /**
-     * Updates the specified schema iff all possible in schema data would remain in schema after the change.
-     * @returns true iff update was performed.
-     */
-    tryUpdateTreeSchema(identifier, schema) {
-        const original = this.nodeSchema.get(identifier);
-        if (allowsTreeSuperset(this.policy, this, original, schema)) {
-            this.nodeSchemaData.set(identifier, schema);
-            this.events.emit("afterSchemaChange", this);
-            return true;
-        }
-        return false;
-    }
-}
-function assertEnumEqual(enumObject, a, b) {
-    if (a !== b) {
-        assert.fail(`expected ${a} (${enumObject[a]}) to equal ${b} (${enumObject[b]})`);
-    }
-}
-describe("Schema Evolution Examples", () => {
-    const contentTypesBuilder = new SchemaBuilder({
-        scope: "test",
-        name: "Schema Evolution Examples: default content types",
-    });
-    const codePoint = contentTypesBuilder.fieldNode("Primitive.CodePoint", leaf.number);
-    // String made of unicode code points, allowing for sequence editing of a string.
-    const text = contentTypesBuilder.object("Text", {
-        children: FlexFieldSchema.create(FieldKinds.sequence, [codePoint]),
-    });
-    const point = contentTypesBuilder.object("Point", {
-        x: leaf.number,
-        y: leaf.number,
-    });
-    const defaultContentLibrary = contentTypesBuilder.intoLibrary();
-    const containersBuilder = new SchemaBuilder({
-        scope: "test",
-        name: "Schema Evolution Examples: default containers",
-        libraries: [defaultContentLibrary],
-    });
-    // A type that can be used to position items without an inherent position within the canvas.
-    const positionedCanvasItem = containersBuilder.object("PositionedCanvasItem", {
-        position: point,
-        content: text,
-    });
-    const canvas = containersBuilder.object("Canvas", {
-        items: FlexFieldSchema.create(FieldKinds.sequence, [positionedCanvasItem]),
-    });
-    const root = FlexFieldSchema.create(FieldKinds.required, [canvas]);
-    const tolerantRoot = FlexFieldSchema.create(FieldKinds.optional, [canvas]);
-    const treeViewSchema = containersBuilder.intoLibrary();
-    /**
-     * This shows basic usage of stored and view schema, including a schema change handled using the
-     * "Design-pattern apps can use to handle schema migrations" proposed in `Stored and View Schema.md`.
-     * Note that this focuses on simpler compatible cases
-     * (where old data meets the new schema and the schema is updated keeping the same identifier),
-     * and does only briefly mentions the case where a new identifier is needed
-     * (since adapters are not implemented yet, and they are the nice way to handle that).
-     */
-    it("basic usage", () => {
-        // Collect our view schema.
-        // This will represent our view schema for a simple canvas application.
-        const viewCollection = new SchemaBuilder({
-            scope: "test",
-            name: "basic usage",
-            libraries: [treeViewSchema],
-        }).intoSchema(root);
-        // This is where legacy schema handling logic for schematize.
-        const adapters = {};
-        // Compose all the view information together.
-        const view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);
-        // Now lets imagine using this application on a new empty document.
-        // TreeStoredSchemaRepository defaults to a state that permits no document states at all.
-        // To permit an empty document, we have to define a root field, and permit it to be empty.
-        const stored = new TestSchemaRepository(defaultSchemaPolicy);
-        assert(stored.tryUpdateRootFieldSchema(storedEmptyFieldSchema));
-        {
-            // When we open this document, we should check it's compatibility with our application:
-            const compat = view.checkCompatibility(stored);
-            // Sadly for our application, we did not allow empty roots in our view schema,
-            // nor did we provide an adapter capable of handling empty roots.
-            // This means our application is unable to view this document.
-            assertEnumEqual(Compatibility, compat.read, Compatibility.Incompatible);
-            // And since the view schema currently excludes empty roots, its also incompatible for writing:
-            assertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);
-            // Additionally even updating the document schema can't save this app,
-            // since the new schema would be incompatible with the existing document content.
-            assertEnumEqual(Compatibility, compat.writeAllowingStoredSchemaUpdates, Compatibility.Incompatible);
-            // This is where the app would inform the user that the document
-            // is not compatible with their version of the application.
-            // This situation (view schema expecting a value where stored schema does not have one),
-            // applies just the same in non-root cases, and thus the resolutions apply would also apply to other cases.
-        }
-        {
-            // There are two ways the app could add support for handling empty documents.
-            // 1. By adjusting it's view schema for the root field to tolerate empty (by making it optional).
-            // 2. By providing a MissingFieldAdapter adapter for the root field
-            //    (ex: by providing a default empty canvas).
-            // This example picks the first approach.
-            // Lets simulate the developers of the app making this change by modifying the view schema:
-            const viewCollection2 = new SchemaBuilder({
-                scope: "test",
-                name: "basic usage2",
-                libraries: [treeViewSchema],
-            }).intoSchema(tolerantRoot);
-            const view2 = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection2);
-            // When we open this document, we should check it's compatibility with our application:
-            const compat = view2.checkCompatibility(stored);
-            // The adjusted view schema can be used read this document, no adapters needed.
-            assertEnumEqual(Compatibility, compat.read, Compatibility.Compatible);
-            // However the document just has its empty root schema,
-            // so the app could make changes that could not be written back.
-            assertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);
-            // However, it is possible to update the schema in the document to match our schema
-            // (since the existing data in compatible with our schema)
-            assertEnumEqual(Compatibility, compat.writeAllowingStoredSchemaUpdates, Compatibility.Compatible);
-            // The app can consider this compatible and proceed if it is ok with updating schema on write.
-            // There are a few approaches apps might want to take here, but we will assume one that seems reasonable:
-            // If this were a document that that the app just created,
-            // it can imminently write its schema into the document:
-            // it knows there are no existing users of this document that will be broken by this.
-            // But if this is a document that it did not just create,
-            // it could inform the user that this document is supported for import,
-            // but its format may be updated when saving,
-            // and let the user choose if they want to open it readonly on read-write.
-            // A web application might want to have a table of well know format updates that it considers ok to do
-            // implicitly to avoid prompting the user if the change is a well understood forward version migration
-            // to a widely supported version.
-            // Lets assume its time to update the schema in the document
-            // (either eagerly or lazily when first needing to do so when writing into the document).
-            // Once again the order does not matter:
-            assert(stored.tryUpdateTreeSchema(canvas.name, canvas.stored));
-            assert(stored.tryUpdateTreeSchema(leaf.number.name, leaf.number.stored));
-            assert(stored.tryUpdateTreeSchema(point.name, point.stored));
-            assert(stored.tryUpdateTreeSchema(positionedCanvasItem.name, positionedCanvasItem.stored));
-            assert(stored.tryUpdateTreeSchema(text.name, text.stored));
-            assert(stored.tryUpdateTreeSchema(codePoint.name, codePoint.stored));
-            assert(stored.tryUpdateRootFieldSchema(tolerantRoot));
-            assert(stored.tryUpdateTreeSchema(leaf.number.name, leaf.number.stored));
-            assert(stored.tryUpdateTreeSchema(leaf.boolean.name, leaf.boolean.stored));
-            assert(stored.tryUpdateTreeSchema(leaf.string.name, leaf.string.stored));
-            assert(stored.tryUpdateTreeSchema(leaf.handle.name, leaf.handle.stored));
-            assert(stored.tryUpdateTreeSchema(leaf.null.name, leaf.null.stored));
-            // That will cause the document stored schema to change,
-            // which will notify and applications with the document open.
-            // They can recheck their compatibility:
-            const compatNew = view2.checkCompatibility(stored);
-            assertEnumEqual(Compatibility, compatNew.read, Compatibility.Compatible);
-            // It is now possible to write our date into the document.
-            assertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);
-            // Now lets imagine some time passes, and the developers want to add a second content type:
-            const builderWithCounter = new SchemaBuilder({
-                scope: "test",
-                name: "builderWithCounter",
-                libraries: [defaultContentLibrary],
-            });
-            const counter = builderWithCounter.object("Counter", {
-                count: leaf.number,
-            });
-            // Lets allow counters inside positionedCanvasItem, instead of just text:
-            const positionedCanvasItem2 = builderWithCounter.object("PositionedCanvasItem", {
-                position: point,
-                content: [text, counter],
-            });
-            // And canvas is still the same storage wise, but its view schema references the updated positionedCanvasItem2:
-            const canvas2 = builderWithCounter.object("Canvas", {
-                items: FlexFieldSchema.create(FieldKinds.sequence, [positionedCanvasItem2]),
-            });
-            // Once again we will simulate reloading the app with different schema by modifying the view schema.
-            const viewCollection3 = builderWithCounter.intoSchema(FlexFieldSchema.create(FieldKinds.optional, [canvas2]));
-            const view3 = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection3);
-            // With this new schema, we can load the document just like before:
-            const compat2 = view3.checkCompatibility(stored);
-            assertEnumEqual(Compatibility, compat2.read, Compatibility.Compatible);
-            assertEnumEqual(Compatibility, compat2.write, Compatibility.Incompatible);
-            assertEnumEqual(Compatibility, compat2.writeAllowingStoredSchemaUpdates, Compatibility.Compatible);
-            // This is the same case as above where we can choose to do a schema update if we want:
-            assert(stored.tryUpdateTreeSchema(positionedCanvasItem.name, positionedCanvasItem2.stored));
-            assert(stored.tryUpdateTreeSchema(counter.name, counter.stored));
-            // And recheck compat:
-            const compat3 = view3.checkCompatibility(stored);
-            assertEnumEqual(Compatibility, compat3.read, Compatibility.Compatible);
-            assertEnumEqual(Compatibility, compat3.write, Compatibility.Compatible);
-        }
-    });
-    // TODO: support adapters
-    // function makeTolerantRootAdapter(view: TreeStoredSchema): FieldAdapter {
-    // 	return {
-    // 		field: rootFieldKey,
-    // 		convert: (field): TreeFieldStoredSchema => {
-    // 			const allowed = allowsFieldSuperset(defaultSchemaPolicy, view, field, tolerantRoot);
-    // 			const out: TreeFieldStoredSchema = allowed ? root : field;
-    // 			return out;
-    // 		},
-    // 	};
-    // }
-    // /**
-    //  * This shows basic usage of stored and view schema including adapters.
-    //  */
-    // it("adapters", () => {
-    // 	// Build a schema repository.
-    // 	// This will represent our view schema for a simple canvas application,
-    // 	// same as the above example, but after some schema changes.
-    // 	const viewCollection: SchemaCollection = {
-    // 		rootFieldSchema: root,
-    // 		treeSchema: treeViewSchema.treeSchema,
-    // 		policy: defaultSchemaPolicy,
-    // 		adapters: {},
-    // 	};
-    // 	// Register an adapter that handles a missing root.
-    // 	// Currently we are just declaring that such a handler exits:
-    // 	// the API for saying what to do in this case are not done.
-    // 	const adapters: Adapters = {
-    // 		fieldAdapters: new Map([[rootFieldKey, makeTolerantRootAdapter(viewCollection)]]),
-    // 	};
-    // 	// Compose all the view information together.
-    // 	const view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);
-    // 	// Like the "basic" example, start with an empty document:
-    // 	const stored = new TestSchemaRepository(defaultSchemaPolicy);
-    // 	assert(stored.tryUpdateRootFieldSchema(emptyField));
-    // 	// Open document, and check it's compatibility with our application:
-    // 	const compat = view.checkCompatibility(stored);
-    // 	// As long as we are willing to use adapters, the application should be able to read this document.
-    // 	assertEnumEqual(Compatibility, compat.read, Compatibility.RequiresAdapters);
-    // 	// And since the document schema currently excludes empty roots, its also incompatible for writing:
-    // 	assertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);
-    // 	// Additionally even updating the document schema can't avoid needing an adapter for the root,
-    // 	// since the new schema would be incompatible with possible existing document content (empty documents).
-    // 	assertEnumEqual(
-    // 		Compatibility,
-    // 		compat.writeAllowingStoredSchemaUpdates,
-    // 		Compatibility.RequiresAdapters,
-    // 	);
-    // 	// Like with the basic example,
-    // 	// the app makes a choice here about its policy for if and when to update stored schema.
-    // 	// Lets assume eventually it updates the schema, either eagerly or lazily.
-    // 	// We can update the root to be optional:
-    // 	// TODO: add an automated way to determine that this is an upgrade that is needed and allowed.
-    // 	stored.tryUpdateRootFieldSchema(tolerantRoot);
-    // 	for (const [key, schema] of view.schema.treeSchema) {
-    // 		// All the tree schema in the view should be compatible with the stored schema,
-    // 		// so for this particular case we assert these all pass.
-    // 		assert(stored.tryUpdateTreeSchema(key, schema));
-    // 	}
-    // 	// That will cause the document stored schema to change,
-    // 	// which will notify and applications with the document open.
-    // 	// They can recheck their compatibility:
-    // 	const compatNew = view.checkCompatibility(stored);
-    // 	// We still need the adapter to handle empty documents.
-    // 	assertEnumEqual(Compatibility, compatNew.read, Compatibility.RequiresAdapters);
-    // 	// It is now possible to write our data into the document, since we have updated its stored schema.
-    // 	assertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);
-    // });
-    // /**
-    //  * Shows a schema update involving both cases:
-    //  * 1. a type that gets a new identifier since its new format is not compatible with the old one.
-    //  * 2. a type which is updated in place (same identifier)
-    //  *
-    //  * An adapter is used to allow the view schema (and thus application logic)
-    //  * to not refer to the old types, and instead factor legacy schema handling into a library of adapters.
-    //  */
-    // it("schema updating using adapters", () => {
-    // 	// In this version of the app,
-    // 	// we decided that text should be organized into a hierarchy of formatting ranges.
-    // 	// We are doing this schema change in an incompatible way, and thus introducing a new identifier:
-    // 	const formattedTextIdentifier: TreeNodeSchemaIdentifier = brand(
-    // 		"2cbc277e-8820-41ef-a3f4-0a00de8ef934",
-    // 	);
-    // 	const builder = new SchemaBuilder("adapters examples", defaultContentLibrary);
-    // 	const formattedText = builder.objectRecursive(formattedTextIdentifier, {
-    // 		content: FlexFieldSchema.createUnsafe(
-    // 			FieldKinds.sequence,
-    // 			() => formattedText,
-    // 			codePoint,
-    // 		),
-    // 		size: (number),
-    // 	});
-    // 	// We are also updating positionedCanvasItem to accept the new type.
-    // 	// It would also be possible to make this accept both types, and do this example without adapters,
-    // 	// but for this example we assume the application does not want to deal with the old text format,
-    // 	// so we will support it using adapters.
-    // 	// Were we not batching all these examples in one scope, this would reuse the `positionedCanvasItem` name
-    // 	// as no version of the app need both view schema at the same time
-    // 	// (except for some approaches for staging roll-outs which are not covered here).
-    // 	const positionedCanvasItemNew = builder.object(positionedCanvasItemIdentifier, {
-    // 		position: (point),
-    // 		// Note that we are specifically excluding the old text here
-    // 		content: (formattedText),
-    // 	});
-    // 	// And canvas is still the same storage wise, but its view schema references the updated positionedCanvasItem2:
-    // 	const canvas2 = builder.object(canvasIdentifier, {
-    // 		items: FlexFieldSchema.create(FieldKinds.sequence, positionedCanvasItemNew),
-    // 	});
-    // 	const viewCollection: SchemaCollection = builder.intoSchema(
-    // 		SchemaBuilder.required(canvas2),
-    // 	);
-    // 	const textAdapter: TreeAdapter = { input: textIdentifier, output: formattedTextIdentifier };
-    // 	// Include adapters for all compatibility cases: empty root and old text.
-    // 	const rootAdapter: FieldAdapter = makeTolerantRootAdapter(viewCollection);
-    // 	const adapters: Adapters = {
-    // 		fieldAdapters: new Map([[rootFieldKey, rootAdapter]]),
-    // 		tree: [textAdapter],
-    // 	};
-    // 	const view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);
-    // 	// Check this works for empty documents:
-    // 	{
-    // 		const stored = new TestSchemaRepository(defaultSchemaPolicy);
-    // 		assert(stored.tryUpdateRootFieldSchema(emptyField));
-    // 		const compat = view.checkCompatibility(stored);
-    // 		assert(compat.read === Compatibility.RequiresAdapters);
-    // 		assert(compat.writeAllowingStoredSchemaUpdates === Compatibility.RequiresAdapters);
-    // 	}
-    // 	// Check this works for documents with old text
-    // 	{
-    // 		const stored = new TestSchemaRepository(defaultSchemaPolicy);
-    // 		assert(stored.tryUpdateTreeSchema(canvasIdentifier, canvas));
-    // 		assert(stored.tryUpdateTreeSchema(numberIdentifier, number));
-    // 		assert(stored.tryUpdateTreeSchema(pointIdentifier, point));
-    // 		assert(
-    // 			stored.tryUpdateTreeSchema(positionedCanvasItemIdentifier, positionedCanvasItem),
-    // 		);
-    // 		assert(stored.tryUpdateTreeSchema(textIdentifier, text));
-    // 		assert(stored.tryUpdateTreeSchema(codePoint.name, codePoint));
-    // 		// This is the root type produced by the adapter for the root.
-    // 		assert(stored.tryUpdateRootFieldSchema(tolerantRoot));
-    // 		const compat = view.checkCompatibility(stored);
-    // 		assertEnumEqual(Compatibility, compat.read, Compatibility.RequiresAdapters);
-    // 		// Writing requires schema updates and/or adapters.
-    // 		assertEnumEqual(
-    // 			Compatibility,
-    // 			compat.writeAllowingStoredSchemaUpdates,
-    // 			Compatibility.RequiresAdapters,
-    // 		);
-    // 		// Note that if/when we update the stored schema for these changes,
-    // 		// the adapters are still required, since that will just permit the new types,
-    // 		// and don't exclude the old ones.
-    // 		// TODO: add an automated way to determine that this is the needed upgrade (some way to union schema?).
-    // 		const positionedCanvasItemTolerant = treeSchema({
-    // 			objectNodeFields: {
-    // 				position: fieldSchema(FieldKinds.required, [pointIdentifier]),
-    // 				// Note that we are specifically supporting both formats here.
-    // 				content: fieldSchema(FieldKinds.required, [
-    // 					formattedTextIdentifier,
-    // 					textIdentifier,
-    // 				]),
-    // 			},
-    // 			mapFields: emptyField,
-    // 		});
-    // 		assert(
-    // 			stored.tryUpdateTreeSchema(
-    // 				positionedCanvasItemIdentifier,
-    // 				positionedCanvasItemTolerant,
-    // 			),
-    // 		);
-    // 		assert(stored.tryUpdateTreeSchema(formattedTextIdentifier, formattedText));
-    // 		const compatNew = view.checkCompatibility(stored);
-    // 		assertEnumEqual(Compatibility, compatNew.read, Compatibility.RequiresAdapters);
-    // 		// Now writing is possible:
-    // 		assertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);
-    // 	}
-    // });
-});
-//# sourceMappingURL=schemaEvolutionExamples.spec.js.map

package/lib/test/feature-libraries/modular-schema/schemaEvolutionExamples.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaEvolutionExamples.spec.js","sourceRoot":"","sources":["../../../../src/test/feature-libraries/modular-schema/schemaEvolutionExamples.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EACN,eAAe,EAEf,UAAU,EACV,UAAU,EACV,mBAAmB,GAEnB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAIN,0BAA0B,EAE1B,aAAa,EACb,sBAAsB,GAEtB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACN,mBAAmB,EACnB,kBAAkB;AAClB,sDAAsD;EACtD,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAEhE,MAAM,oBAAqB,SAAQ,0BAA0B;IAC5D,YACiB,MAAwB,EACxC,IAAuB;QAEvB,KAAK,CAAC,IAAI,CAAC,CAAC;QAHI,WAAM,GAAN,MAAM,CAAkB;IAIzC,CAAC;IAED;;;OAGG;IACI,wBAAwB,CAAC,MAA6B;QAC5D,IAAI,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,EAAE;YACzE,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IACD;;;OAGG;IACI,mBAAmB,CACzB,UAAoC,EACpC,MAA4B;QAE5B,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE;YAC5D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAED,SAAS,eAAe,CACvB,UAAiB,EACjB,CAAS,EACT,CAAS;IAET,IAAI,CAAC,KAAK,CAAC,EAAE;QACZ,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;KACjF;AACF,CAAC;AAED,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IAC1C,MAAM,mBAAmB,GAAG,IAAI,aAAa,CAAC;QAC7C,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,kDAAkD;KACxD,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAEpF,iFAAiF;IACjF,MAAM,IAAI,GAAG,mBAAmB,CAAC,MAAM,CAAC,MAAM,EAAE;QAC/C,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC;KAClE,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;QACjD,CAAC,EAAE,IAAI,CAAC,MAAM;QACd,CAAC,EAAE,IAAI,CAAC,MAAM;KACd,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG,mBAAmB,CAAC,WAAW,EAAE,CAAC;IAEhE,MAAM,iBAAiB,GAAG,IAAI,aAAa,CAAC;QAC3C,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,+CAA+C;QACrD,SAAS,EAAE,CAAC,qBAAqB,CAAC;KAClC,CAAC,CAAC;IAEH,4FAA4F;IAC5F,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,MAAM,CAAC,sBAAsB,EAAE;QAC7E,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,IAAI;KACb,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE;QACjD,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,oBAAoB,CAAC,CAAC;KAC1E,CAAC,CAAC;IAEH,MAAM,IAAI,GAAoB,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEpF,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3E,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAEvD;;;;;;;OAOG;IACH,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;QACtB,2BAA2B;QAC3B,uEAAuE;QACvE,MAAM,cAAc,GAAmB,IAAI,aAAa,CAAC;YACxD,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,cAAc,CAAC;SAC3B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEpB,6DAA6D;QAC7D,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,6CAA6C;QAC7C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,mBAAmB,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QAE3E,mEAAmE;QACnE,yFAAyF;QACzF,0FAA0F;QAC1F,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAEhE;YACC,uFAAuF;YACvF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAE/C,8EAA8E;YAC9E,iEAAiE;YACjE,8DAA8D;YAC9D,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;YAExE,+FAA+F;YAC/F,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;YAEzE,sEAAsE;YACtE,iFAAiF;YACjF,eAAe,CACd,aAAa,EACb,MAAM,CAAC,gCAAgC,EACvC,aAAa,CAAC,YAAY,CAC1B,CAAC;YAEF,gEAAgE;YAChE,2DAA2D;YAC3D,wFAAwF;YACxF,2GAA2G;SAC3G;QAED;YACC,6EAA6E;YAC7E,iGAAiG;YACjG,mEAAmE;YACnE,gDAAgD;YAEhD,yCAAyC;YACzC,2FAA2F;YAC3F,MAAM,eAAe,GAAG,IAAI,aAAa,CAAC;gBACzC,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,cAAc;gBACpB,SAAS,EAAE,CAAC,cAAc,CAAC;aAC3B,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,mBAAmB,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;YAC7E,uFAAuF;YACvF,MAAM,MAAM,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAEhD,+EAA+E;YAC/E,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YAEtE,uDAAuD;YACvD,gEAAgE;YAChE,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;YAEzE,mFAAmF;YACnF,0DAA0D;YAC1D,eAAe,CACd,aAAa,EACb,MAAM,CAAC,gCAAgC,EACvC,aAAa,CAAC,UAAU,CACxB,CAAC;YAEF,8FAA8F;YAC9F,yGAAyG;YACzG,0DAA0D;YAC1D,wDAAwD;YACxD,qFAAqF;YACrF,yDAAyD;YACzD,uEAAuE;YACvE,6CAA6C;YAC7C,0EAA0E;YAC1E,sGAAsG;YACtG,sGAAsG;YACtG,iCAAiC;YAEjC,4DAA4D;YAC5D,yFAAyF;YACzF,wCAAwC;YACxC,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACzE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7D,MAAM,CACL,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,IAAI,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAClF,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACzE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACzE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YACzE,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAErE,wDAAwD;YACxD,6DAA6D;YAC7D,wCAAwC;YACxC,MAAM,SAAS,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACnD,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YACzE,0DAA0D;YAC1D,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YAE1E,2FAA2F;YAC3F,MAAM,kBAAkB,GAAG,IAAI,aAAa,CAAC;gBAC5C,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,oBAAoB;gBAC1B,SAAS,EAAE,CAAC,qBAAqB,CAAC;aAClC,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE;gBACpD,KAAK,EAAE,IAAI,CAAC,MAAM;aAClB,CAAC,CAAC;YACH,yEAAyE;YACzE,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,MAAM,CAAC,sBAAsB,EAAE;gBAC/E,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC;aACxB,CAAC,CAAC;YACH,+GAA+G;YAC/G,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACnD,KAAK,EAAE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC,CAAC;aAC3E,CAAC,CAAC;YACH,oGAAoG;YACpG,MAAM,eAAe,GAAmB,kBAAkB,CAAC,UAAU,CACpE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CACtD,CAAC;YACF,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,mBAAmB,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;YAE7E,mEAAmE;YACnE,MAAM,OAAO,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACjD,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YACvE,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;YAC1E,eAAe,CACd,aAAa,EACb,OAAO,CAAC,gCAAgC,EACxC,aAAa,CAAC,UAAU,CACxB,CAAC;YAEF,uFAAuF;YACvF,MAAM,CACL,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC,CACnF,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAEjE,sBAAsB;YACtB,MAAM,OAAO,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YACjD,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;YACvE,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;SACxE;IACF,CAAC,CAAC,CAAC;IAEH,yBAAyB;IAEzB,2EAA2E;IAC3E,YAAY;IACZ,yBAAyB;IACzB,iDAAiD;IACjD,0FAA0F;IAC1F,gEAAgE;IAChE,iBAAiB;IACjB,OAAO;IACP,MAAM;IACN,IAAI;IAEJ,MAAM;IACN,0EAA0E;IAC1E,MAAM;IACN,yBAAyB;IACzB,iCAAiC;IACjC,2EAA2E;IAC3E,gEAAgE;IAChE,8CAA8C;IAC9C,2BAA2B;IAC3B,2CAA2C;IAC3C,iCAAiC;IACjC,kBAAkB;IAClB,MAAM;IAEN,uDAAuD;IACvD,iEAAiE;IACjE,+DAA+D;IAC/D,gCAAgC;IAChC,uFAAuF;IACvF,MAAM;IACN,iDAAiD;IACjD,+EAA+E;IAE/E,8DAA8D;IAC9D,iEAAiE;IACjE,wDAAwD;IAExD,wEAAwE;IACxE,mDAAmD;IAEnD,uGAAuG;IACvG,gFAAgF;IAEhF,uGAAuG;IACvG,6EAA6E;IAE7E,kGAAkG;IAClG,4GAA4G;IAC5G,oBAAoB;IACpB,mBAAmB;IACnB,6CAA6C;IAC7C,oCAAoC;IACpC,MAAM;IAEN,mCAAmC;IACnC,4FAA4F;IAC5F,8EAA8E;IAE9E,6CAA6C;IAC7C,kGAAkG;IAClG,kDAAkD;IAClD,yDAAyD;IACzD,oFAAoF;IACpF,6DAA6D;IAC7D,qDAAqD;IACrD,KAAK;IAEL,4DAA4D;IAC5D,iEAAiE;IACjE,4CAA4C;IAC5C,sDAAsD;IACtD,2DAA2D;IAC3D,mFAAmF;IACnF,uGAAuG;IACvG,8EAA8E;IAC9E,MAAM;IAEN,MAAM;IACN,iDAAiD;IACjD,mGAAmG;IACnG,2DAA2D;IAC3D,KAAK;IACL,8EAA8E;IAC9E,0GAA0G;IAC1G,MAAM;IACN,+CAA+C;IAC/C,kCAAkC;IAClC,sFAAsF;IACtF,qGAAqG;IACrG,oEAAoE;IACpE,4CAA4C;IAC5C,MAAM;IACN,kFAAkF;IAClF,4EAA4E;IAC5E,2CAA2C;IAC3C,0BAA0B;IAC1B,0BAA0B;IAC1B,gBAAgB;IAChB,OAAO;IACP,oBAAoB;IACpB,OAAO;IAEP,wEAAwE;IACxE,sGAAsG;IACtG,qGAAqG;IACrG,4CAA4C;IAC5C,6GAA6G;IAC7G,sEAAsE;IACtE,qFAAqF;IACrF,oFAAoF;IACpF,uBAAuB;IACvB,iEAAiE;IACjE,8BAA8B;IAC9B,OAAO;IACP,mHAAmH;IACnH,sDAAsD;IACtD,iFAAiF;IACjF,OAAO;IAEP,gEAAgE;IAChE,qCAAqC;IACrC,MAAM;IAEN,gGAAgG;IAEhG,6EAA6E;IAC7E,8EAA8E;IAC9E,gCAAgC;IAChC,2DAA2D;IAC3D,yBAAyB;IACzB,MAAM;IAEN,+EAA+E;IAE/E,4CAA4C;IAC5C,KAAK;IACL,kEAAkE;IAClE,yDAAyD;IACzD,oDAAoD;IACpD,4DAA4D;IAC5D,wFAAwF;IACxF,KAAK;IAEL,mDAAmD;IACnD,KAAK;IACL,kEAAkE;IAClE,kEAAkE;IAClE,kEAAkE;IAClE,gEAAgE;IAChE,YAAY;IACZ,uFAAuF;IACvF,OAAO;IACP,8DAA8D;IAC9D,mEAAmE;IACnE,mEAAmE;IACnE,2DAA2D;IAE3D,oDAAoD;IACpD,iFAAiF;IACjF,wDAAwD;IACxD,qBAAqB;IACrB,oBAAoB;IACpB,8CAA8C;IAC9C,qCAAqC;IACrC,OAAO;IAEP,wEAAwE;IACxE,mFAAmF;IACnF,uCAAuC;IACvC,4GAA4G;IAC5G,sDAAsD;IACtD,yBAAyB;IACzB,qEAAqE;IACrE,qEAAqE;IACrE,kDAAkD;IAClD,gCAAgC;IAChC,uBAAuB;IACvB,UAAU;IACV,QAAQ;IACR,4BAA4B;IAC5B,QAAQ;IACR,YAAY;IACZ,iCAAiC;IACjC,sCAAsC;IACtC,oCAAoC;IACpC,QAAQ;IACR,OAAO;IACP,gFAAgF;IAEhF,uDAAuD;IACvD,oFAAoF;IACpF,gCAAgC;IAChC,+EAA+E;IAC/E,KAAK;IACL,MAAM;AACP,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\n\nimport {\n\tFlexFieldSchema,\n\tFullSchemaPolicy,\n\tViewSchema,\n\tFieldKinds,\n\tdefaultSchemaPolicy,\n\tFlexTreeSchema,\n} from \"../../../feature-libraries/index.js\";\nimport {\n\tTreeFieldStoredSchema,\n\tTreeNodeStoredSchema,\n\tTreeNodeSchemaIdentifier,\n\tTreeStoredSchemaRepository,\n\tAdapters,\n\tCompatibility,\n\tstoredEmptyFieldSchema,\n\tTreeStoredSchema,\n} from \"../../../core/index.js\";\nimport {\n\tallowsFieldSuperset,\n\tallowsTreeSuperset,\n\t// eslint-disable-next-line import/no-internal-modules\n} from \"../../../feature-libraries/modular-schema/index.js\";\nimport { SchemaBuilder, leaf } from \"../../../domains/index.js\";\n\nclass TestSchemaRepository extends TreeStoredSchemaRepository {\n\tpublic constructor(\n\t\tpublic readonly policy: FullSchemaPolicy,\n\t\tdata?: TreeStoredSchema,\n\t) {\n\t\tsuper(data);\n\t}\n\n\t/**\n\t * Updates the specified schema iff all possible in schema data would remain in schema after the change.\n\t * @returns true iff update was performed.\n\t */\n\tpublic tryUpdateRootFieldSchema(schema: TreeFieldStoredSchema): boolean {\n\t\tif (allowsFieldSuperset(this.policy, this, this.rootFieldSchema, schema)) {\n\t\t\tthis.rootFieldSchemaData = schema;\n\t\t\tthis.events.emit(\"afterSchemaChange\", this);\n\t\t\treturn true;\n\t\t}\n\t\treturn false;\n\t}\n\t/**\n\t * Updates the specified schema iff all possible in schema data would remain in schema after the change.\n\t * @returns true iff update was performed.\n\t */\n\tpublic tryUpdateTreeSchema(\n\t\tidentifier: TreeNodeSchemaIdentifier,\n\t\tschema: TreeNodeStoredSchema,\n\t): boolean {\n\t\tconst original = this.nodeSchema.get(identifier);\n\t\tif (allowsTreeSuperset(this.policy, this, original, schema)) {\n\t\t\tthis.nodeSchemaData.set(identifier, schema);\n\t\t\tthis.events.emit(\"afterSchemaChange\", this);\n\t\t\treturn true;\n\t\t}\n\t\treturn false;\n\t}\n}\n\nfunction assertEnumEqual<TEnum extends { [key: number]: string }>(\n\tenumObject: TEnum,\n\ta: number,\n\tb: number,\n): void {\n\tif (a !== b) {\n\t\tassert.fail(`expected ${a} (${enumObject[a]}) to equal ${b} (${enumObject[b]})`);\n\t}\n}\n\ndescribe(\"Schema Evolution Examples\", () => {\n\tconst contentTypesBuilder = new SchemaBuilder({\n\t\tscope: \"test\",\n\t\tname: \"Schema Evolution Examples: default content types\",\n\t});\n\n\tconst codePoint = contentTypesBuilder.fieldNode(\"Primitive.CodePoint\", leaf.number);\n\n\t// String made of unicode code points, allowing for sequence editing of a string.\n\tconst text = contentTypesBuilder.object(\"Text\", {\n\t\tchildren: FlexFieldSchema.create(FieldKinds.sequence, [codePoint]),\n\t});\n\n\tconst point = contentTypesBuilder.object(\"Point\", {\n\t\tx: leaf.number,\n\t\ty: leaf.number,\n\t});\n\n\tconst defaultContentLibrary = contentTypesBuilder.intoLibrary();\n\n\tconst containersBuilder = new SchemaBuilder({\n\t\tscope: \"test\",\n\t\tname: \"Schema Evolution Examples: default containers\",\n\t\tlibraries: [defaultContentLibrary],\n\t});\n\n\t// A type that can be used to position items without an inherent position within the canvas.\n\tconst positionedCanvasItem = containersBuilder.object(\"PositionedCanvasItem\", {\n\t\tposition: point,\n\t\tcontent: text,\n\t});\n\tconst canvas = containersBuilder.object(\"Canvas\", {\n\t\titems: FlexFieldSchema.create(FieldKinds.sequence, [positionedCanvasItem]),\n\t});\n\n\tconst root: FlexFieldSchema = FlexFieldSchema.create(FieldKinds.required, [canvas]);\n\n\tconst tolerantRoot = FlexFieldSchema.create(FieldKinds.optional, [canvas]);\n\n\tconst treeViewSchema = containersBuilder.intoLibrary();\n\n\t/**\n\t * This shows basic usage of stored and view schema, including a schema change handled using the\n\t * \"Design-pattern apps can use to handle schema migrations\" proposed in `Stored and View Schema.md`.\n\t * Note that this focuses on simpler compatible cases\n\t * (where old data meets the new schema and the schema is updated keeping the same identifier),\n\t * and does only briefly mentions the case where a new identifier is needed\n\t * (since adapters are not implemented yet, and they are the nice way to handle that).\n\t */\n\tit(\"basic usage\", () => {\n\t\t// Collect our view schema.\n\t\t// This will represent our view schema for a simple canvas application.\n\t\tconst viewCollection: FlexTreeSchema = new SchemaBuilder({\n\t\t\tscope: \"test\",\n\t\t\tname: \"basic usage\",\n\t\t\tlibraries: [treeViewSchema],\n\t\t}).intoSchema(root);\n\n\t\t// This is where legacy schema handling logic for schematize.\n\t\tconst adapters: Adapters = {};\n\t\t// Compose all the view information together.\n\t\tconst view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);\n\n\t\t// Now lets imagine using this application on a new empty document.\n\t\t// TreeStoredSchemaRepository defaults to a state that permits no document states at all.\n\t\t// To permit an empty document, we have to define a root field, and permit it to be empty.\n\t\tconst stored = new TestSchemaRepository(defaultSchemaPolicy);\n\t\tassert(stored.tryUpdateRootFieldSchema(storedEmptyFieldSchema));\n\n\t\t{\n\t\t\t// When we open this document, we should check it's compatibility with our application:\n\t\t\tconst compat = view.checkCompatibility(stored);\n\n\t\t\t// Sadly for our application, we did not allow empty roots in our view schema,\n\t\t\t// nor did we provide an adapter capable of handling empty roots.\n\t\t\t// This means our application is unable to view this document.\n\t\t\tassertEnumEqual(Compatibility, compat.read, Compatibility.Incompatible);\n\n\t\t\t// And since the view schema currently excludes empty roots, its also incompatible for writing:\n\t\t\tassertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);\n\n\t\t\t// Additionally even updating the document schema can't save this app,\n\t\t\t// since the new schema would be incompatible with the existing document content.\n\t\t\tassertEnumEqual(\n\t\t\t\tCompatibility,\n\t\t\t\tcompat.writeAllowingStoredSchemaUpdates,\n\t\t\t\tCompatibility.Incompatible,\n\t\t\t);\n\n\t\t\t// This is where the app would inform the user that the document\n\t\t\t// is not compatible with their version of the application.\n\t\t\t// This situation (view schema expecting a value where stored schema does not have one),\n\t\t\t// applies just the same in non-root cases, and thus the resolutions apply would also apply to other cases.\n\t\t}\n\n\t\t{\n\t\t\t// There are two ways the app could add support for handling empty documents.\n\t\t\t// 1. By adjusting it's view schema for the root field to tolerate empty (by making it optional).\n\t\t\t// 2. By providing a MissingFieldAdapter adapter for the root field\n\t\t\t//    (ex: by providing a default empty canvas).\n\n\t\t\t// This example picks the first approach.\n\t\t\t// Lets simulate the developers of the app making this change by modifying the view schema:\n\t\t\tconst viewCollection2 = new SchemaBuilder({\n\t\t\t\tscope: \"test\",\n\t\t\t\tname: \"basic usage2\",\n\t\t\t\tlibraries: [treeViewSchema],\n\t\t\t}).intoSchema(tolerantRoot);\n\t\t\tconst view2 = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection2);\n\t\t\t// When we open this document, we should check it's compatibility with our application:\n\t\t\tconst compat = view2.checkCompatibility(stored);\n\n\t\t\t// The adjusted view schema can be used read this document, no adapters needed.\n\t\t\tassertEnumEqual(Compatibility, compat.read, Compatibility.Compatible);\n\n\t\t\t// However the document just has its empty root schema,\n\t\t\t// so the app could make changes that could not be written back.\n\t\t\tassertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);\n\n\t\t\t// However, it is possible to update the schema in the document to match our schema\n\t\t\t// (since the existing data in compatible with our schema)\n\t\t\tassertEnumEqual(\n\t\t\t\tCompatibility,\n\t\t\t\tcompat.writeAllowingStoredSchemaUpdates,\n\t\t\t\tCompatibility.Compatible,\n\t\t\t);\n\n\t\t\t// The app can consider this compatible and proceed if it is ok with updating schema on write.\n\t\t\t// There are a few approaches apps might want to take here, but we will assume one that seems reasonable:\n\t\t\t// If this were a document that that the app just created,\n\t\t\t// it can imminently write its schema into the document:\n\t\t\t// it knows there are no existing users of this document that will be broken by this.\n\t\t\t// But if this is a document that it did not just create,\n\t\t\t// it could inform the user that this document is supported for import,\n\t\t\t// but its format may be updated when saving,\n\t\t\t// and let the user choose if they want to open it readonly on read-write.\n\t\t\t// A web application might want to have a table of well know format updates that it considers ok to do\n\t\t\t// implicitly to avoid prompting the user if the change is a well understood forward version migration\n\t\t\t// to a widely supported version.\n\n\t\t\t// Lets assume its time to update the schema in the document\n\t\t\t// (either eagerly or lazily when first needing to do so when writing into the document).\n\t\t\t// Once again the order does not matter:\n\t\t\tassert(stored.tryUpdateTreeSchema(canvas.name, canvas.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.number.name, leaf.number.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(point.name, point.stored));\n\t\t\tassert(\n\t\t\t\tstored.tryUpdateTreeSchema(positionedCanvasItem.name, positionedCanvasItem.stored),\n\t\t\t);\n\t\t\tassert(stored.tryUpdateTreeSchema(text.name, text.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(codePoint.name, codePoint.stored));\n\t\t\tassert(stored.tryUpdateRootFieldSchema(tolerantRoot));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.number.name, leaf.number.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.boolean.name, leaf.boolean.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.string.name, leaf.string.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.handle.name, leaf.handle.stored));\n\t\t\tassert(stored.tryUpdateTreeSchema(leaf.null.name, leaf.null.stored));\n\n\t\t\t// That will cause the document stored schema to change,\n\t\t\t// which will notify and applications with the document open.\n\t\t\t// They can recheck their compatibility:\n\t\t\tconst compatNew = view2.checkCompatibility(stored);\n\t\t\tassertEnumEqual(Compatibility, compatNew.read, Compatibility.Compatible);\n\t\t\t// It is now possible to write our date into the document.\n\t\t\tassertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);\n\n\t\t\t// Now lets imagine some time passes, and the developers want to add a second content type:\n\t\t\tconst builderWithCounter = new SchemaBuilder({\n\t\t\t\tscope: \"test\",\n\t\t\t\tname: \"builderWithCounter\",\n\t\t\t\tlibraries: [defaultContentLibrary],\n\t\t\t});\n\n\t\t\tconst counter = builderWithCounter.object(\"Counter\", {\n\t\t\t\tcount: leaf.number,\n\t\t\t});\n\t\t\t// Lets allow counters inside positionedCanvasItem, instead of just text:\n\t\t\tconst positionedCanvasItem2 = builderWithCounter.object(\"PositionedCanvasItem\", {\n\t\t\t\tposition: point,\n\t\t\t\tcontent: [text, counter],\n\t\t\t});\n\t\t\t// And canvas is still the same storage wise, but its view schema references the updated positionedCanvasItem2:\n\t\t\tconst canvas2 = builderWithCounter.object(\"Canvas\", {\n\t\t\t\titems: FlexFieldSchema.create(FieldKinds.sequence, [positionedCanvasItem2]),\n\t\t\t});\n\t\t\t// Once again we will simulate reloading the app with different schema by modifying the view schema.\n\t\t\tconst viewCollection3: FlexTreeSchema = builderWithCounter.intoSchema(\n\t\t\t\tFlexFieldSchema.create(FieldKinds.optional, [canvas2]),\n\t\t\t);\n\t\t\tconst view3 = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection3);\n\n\t\t\t// With this new schema, we can load the document just like before:\n\t\t\tconst compat2 = view3.checkCompatibility(stored);\n\t\t\tassertEnumEqual(Compatibility, compat2.read, Compatibility.Compatible);\n\t\t\tassertEnumEqual(Compatibility, compat2.write, Compatibility.Incompatible);\n\t\t\tassertEnumEqual(\n\t\t\t\tCompatibility,\n\t\t\t\tcompat2.writeAllowingStoredSchemaUpdates,\n\t\t\t\tCompatibility.Compatible,\n\t\t\t);\n\n\t\t\t// This is the same case as above where we can choose to do a schema update if we want:\n\t\t\tassert(\n\t\t\t\tstored.tryUpdateTreeSchema(positionedCanvasItem.name, positionedCanvasItem2.stored),\n\t\t\t);\n\t\t\tassert(stored.tryUpdateTreeSchema(counter.name, counter.stored));\n\n\t\t\t// And recheck compat:\n\t\t\tconst compat3 = view3.checkCompatibility(stored);\n\t\t\tassertEnumEqual(Compatibility, compat3.read, Compatibility.Compatible);\n\t\t\tassertEnumEqual(Compatibility, compat3.write, Compatibility.Compatible);\n\t\t}\n\t});\n\n\t// TODO: support adapters\n\n\t// function makeTolerantRootAdapter(view: TreeStoredSchema): FieldAdapter {\n\t// \treturn {\n\t// \t\tfield: rootFieldKey,\n\t// \t\tconvert: (field): TreeFieldStoredSchema => {\n\t// \t\t\tconst allowed = allowsFieldSuperset(defaultSchemaPolicy, view, field, tolerantRoot);\n\t// \t\t\tconst out: TreeFieldStoredSchema = allowed ? root : field;\n\t// \t\t\treturn out;\n\t// \t\t},\n\t// \t};\n\t// }\n\n\t// /**\n\t//  * This shows basic usage of stored and view schema including adapters.\n\t//  */\n\t// it(\"adapters\", () => {\n\t// \t// Build a schema repository.\n\t// \t// This will represent our view schema for a simple canvas application,\n\t// \t// same as the above example, but after some schema changes.\n\t// \tconst viewCollection: SchemaCollection = {\n\t// \t\trootFieldSchema: root,\n\t// \t\ttreeSchema: treeViewSchema.treeSchema,\n\t// \t\tpolicy: defaultSchemaPolicy,\n\t// \t\tadapters: {},\n\t// \t};\n\n\t// \t// Register an adapter that handles a missing root.\n\t// \t// Currently we are just declaring that such a handler exits:\n\t// \t// the API for saying what to do in this case are not done.\n\t// \tconst adapters: Adapters = {\n\t// \t\tfieldAdapters: new Map([[rootFieldKey, makeTolerantRootAdapter(viewCollection)]]),\n\t// \t};\n\t// \t// Compose all the view information together.\n\t// \tconst view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);\n\n\t// \t// Like the \"basic\" example, start with an empty document:\n\t// \tconst stored = new TestSchemaRepository(defaultSchemaPolicy);\n\t// \tassert(stored.tryUpdateRootFieldSchema(emptyField));\n\n\t// \t// Open document, and check it's compatibility with our application:\n\t// \tconst compat = view.checkCompatibility(stored);\n\n\t// \t// As long as we are willing to use adapters, the application should be able to read this document.\n\t// \tassertEnumEqual(Compatibility, compat.read, Compatibility.RequiresAdapters);\n\n\t// \t// And since the document schema currently excludes empty roots, its also incompatible for writing:\n\t// \tassertEnumEqual(Compatibility, compat.write, Compatibility.Incompatible);\n\n\t// \t// Additionally even updating the document schema can't avoid needing an adapter for the root,\n\t// \t// since the new schema would be incompatible with possible existing document content (empty documents).\n\t// \tassertEnumEqual(\n\t// \t\tCompatibility,\n\t// \t\tcompat.writeAllowingStoredSchemaUpdates,\n\t// \t\tCompatibility.RequiresAdapters,\n\t// \t);\n\n\t// \t// Like with the basic example,\n\t// \t// the app makes a choice here about its policy for if and when to update stored schema.\n\t// \t// Lets assume eventually it updates the schema, either eagerly or lazily.\n\n\t// \t// We can update the root to be optional:\n\t// \t// TODO: add an automated way to determine that this is an upgrade that is needed and allowed.\n\t// \tstored.tryUpdateRootFieldSchema(tolerantRoot);\n\t// \tfor (const [key, schema] of view.schema.treeSchema) {\n\t// \t\t// All the tree schema in the view should be compatible with the stored schema,\n\t// \t\t// so for this particular case we assert these all pass.\n\t// \t\tassert(stored.tryUpdateTreeSchema(key, schema));\n\t// \t}\n\n\t// \t// That will cause the document stored schema to change,\n\t// \t// which will notify and applications with the document open.\n\t// \t// They can recheck their compatibility:\n\t// \tconst compatNew = view.checkCompatibility(stored);\n\t// \t// We still need the adapter to handle empty documents.\n\t// \tassertEnumEqual(Compatibility, compatNew.read, Compatibility.RequiresAdapters);\n\t// \t// It is now possible to write our data into the document, since we have updated its stored schema.\n\t// \tassertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);\n\t// });\n\n\t// /**\n\t//  * Shows a schema update involving both cases:\n\t//  * 1. a type that gets a new identifier since its new format is not compatible with the old one.\n\t//  * 2. a type which is updated in place (same identifier)\n\t//  *\n\t//  * An adapter is used to allow the view schema (and thus application logic)\n\t//  * to not refer to the old types, and instead factor legacy schema handling into a library of adapters.\n\t//  */\n\t// it(\"schema updating using adapters\", () => {\n\t// \t// In this version of the app,\n\t// \t// we decided that text should be organized into a hierarchy of formatting ranges.\n\t// \t// We are doing this schema change in an incompatible way, and thus introducing a new identifier:\n\t// \tconst formattedTextIdentifier: TreeNodeSchemaIdentifier = brand(\n\t// \t\t\"2cbc277e-8820-41ef-a3f4-0a00de8ef934\",\n\t// \t);\n\t// \tconst builder = new SchemaBuilder(\"adapters examples\", defaultContentLibrary);\n\t// \tconst formattedText = builder.objectRecursive(formattedTextIdentifier, {\n\t// \t\tcontent: FlexFieldSchema.createUnsafe(\n\t// \t\t\tFieldKinds.sequence,\n\t// \t\t\t() => formattedText,\n\t// \t\t\tcodePoint,\n\t// \t\t),\n\t// \t\tsize: (number),\n\t// \t});\n\n\t// \t// We are also updating positionedCanvasItem to accept the new type.\n\t// \t// It would also be possible to make this accept both types, and do this example without adapters,\n\t// \t// but for this example we assume the application does not want to deal with the old text format,\n\t// \t// so we will support it using adapters.\n\t// \t// Were we not batching all these examples in one scope, this would reuse the `positionedCanvasItem` name\n\t// \t// as no version of the app need both view schema at the same time\n\t// \t// (except for some approaches for staging roll-outs which are not covered here).\n\t// \tconst positionedCanvasItemNew = builder.object(positionedCanvasItemIdentifier, {\n\t// \t\tposition: (point),\n\t// \t\t// Note that we are specifically excluding the old text here\n\t// \t\tcontent: (formattedText),\n\t// \t});\n\t// \t// And canvas is still the same storage wise, but its view schema references the updated positionedCanvasItem2:\n\t// \tconst canvas2 = builder.object(canvasIdentifier, {\n\t// \t\titems: FlexFieldSchema.create(FieldKinds.sequence, positionedCanvasItemNew),\n\t// \t});\n\n\t// \tconst viewCollection: SchemaCollection = builder.intoSchema(\n\t// \t\tSchemaBuilder.required(canvas2),\n\t// \t);\n\n\t// \tconst textAdapter: TreeAdapter = { input: textIdentifier, output: formattedTextIdentifier };\n\n\t// \t// Include adapters for all compatibility cases: empty root and old text.\n\t// \tconst rootAdapter: FieldAdapter = makeTolerantRootAdapter(viewCollection);\n\t// \tconst adapters: Adapters = {\n\t// \t\tfieldAdapters: new Map([[rootFieldKey, rootAdapter]]),\n\t// \t\ttree: [textAdapter],\n\t// \t};\n\n\t// \tconst view = new ViewSchema(defaultSchemaPolicy, adapters, viewCollection);\n\n\t// \t// Check this works for empty documents:\n\t// \t{\n\t// \t\tconst stored = new TestSchemaRepository(defaultSchemaPolicy);\n\t// \t\tassert(stored.tryUpdateRootFieldSchema(emptyField));\n\t// \t\tconst compat = view.checkCompatibility(stored);\n\t// \t\tassert(compat.read === Compatibility.RequiresAdapters);\n\t// \t\tassert(compat.writeAllowingStoredSchemaUpdates === Compatibility.RequiresAdapters);\n\t// \t}\n\n\t// \t// Check this works for documents with old text\n\t// \t{\n\t// \t\tconst stored = new TestSchemaRepository(defaultSchemaPolicy);\n\t// \t\tassert(stored.tryUpdateTreeSchema(canvasIdentifier, canvas));\n\t// \t\tassert(stored.tryUpdateTreeSchema(numberIdentifier, number));\n\t// \t\tassert(stored.tryUpdateTreeSchema(pointIdentifier, point));\n\t// \t\tassert(\n\t// \t\t\tstored.tryUpdateTreeSchema(positionedCanvasItemIdentifier, positionedCanvasItem),\n\t// \t\t);\n\t// \t\tassert(stored.tryUpdateTreeSchema(textIdentifier, text));\n\t// \t\tassert(stored.tryUpdateTreeSchema(codePoint.name, codePoint));\n\t// \t\t// This is the root type produced by the adapter for the root.\n\t// \t\tassert(stored.tryUpdateRootFieldSchema(tolerantRoot));\n\n\t// \t\tconst compat = view.checkCompatibility(stored);\n\t// \t\tassertEnumEqual(Compatibility, compat.read, Compatibility.RequiresAdapters);\n\t// \t\t// Writing requires schema updates and/or adapters.\n\t// \t\tassertEnumEqual(\n\t// \t\t\tCompatibility,\n\t// \t\t\tcompat.writeAllowingStoredSchemaUpdates,\n\t// \t\t\tCompatibility.RequiresAdapters,\n\t// \t\t);\n\n\t// \t\t// Note that if/when we update the stored schema for these changes,\n\t// \t\t// the adapters are still required, since that will just permit the new types,\n\t// \t\t// and don't exclude the old ones.\n\t// \t\t// TODO: add an automated way to determine that this is the needed upgrade (some way to union schema?).\n\t// \t\tconst positionedCanvasItemTolerant = treeSchema({\n\t// \t\t\tobjectNodeFields: {\n\t// \t\t\t\tposition: fieldSchema(FieldKinds.required, [pointIdentifier]),\n\t// \t\t\t\t// Note that we are specifically supporting both formats here.\n\t// \t\t\t\tcontent: fieldSchema(FieldKinds.required, [\n\t// \t\t\t\t\tformattedTextIdentifier,\n\t// \t\t\t\t\ttextIdentifier,\n\t// \t\t\t\t]),\n\t// \t\t\t},\n\t// \t\t\tmapFields: emptyField,\n\t// \t\t});\n\t// \t\tassert(\n\t// \t\t\tstored.tryUpdateTreeSchema(\n\t// \t\t\t\tpositionedCanvasItemIdentifier,\n\t// \t\t\t\tpositionedCanvasItemTolerant,\n\t// \t\t\t),\n\t// \t\t);\n\t// \t\tassert(stored.tryUpdateTreeSchema(formattedTextIdentifier, formattedText));\n\n\t// \t\tconst compatNew = view.checkCompatibility(stored);\n\t// \t\tassertEnumEqual(Compatibility, compatNew.read, Compatibility.RequiresAdapters);\n\t// \t\t// Now writing is possible:\n\t// \t\tassertEnumEqual(Compatibility, compatNew.write, Compatibility.Compatible);\n\t// \t}\n\t// });\n});\n"]}

package/lib/test/feature-libraries/modularChangeFamilyIntegration.spec.d.ts

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

package/lib/test/feature-libraries/modularChangeFamilyIntegration.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"modularChangeFamilyIntegration.spec.d.ts","sourceRoot":"","sources":["../../../src/test/feature-libraries/modularChangeFamilyIntegration.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG"}