@fluidframework/tree 2.74.0-365691 → 2.74.0

package/lib/simple-tree/api/viewSchemaToSimpleSchema.d.ts

@@ -1,40 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type ImplicitFieldSchema } from "../fieldSchema.js";
-import type { SimpleNodeSchema, SimpleTreeSchema } from "../simpleSchema.js";
-/**
- * Converts an {@link ImplicitFieldSchema} to a "simple" schema representation.
- *
- * @param schema - The schema to convert
- * @param copySchemaObjects - If true, TreeNodeSchema and FieldSchema are copied into plain JavaScript objects. Either way, custom metadata is referenced and not copied.
- *
- * @remarks
- * Given that the Schema types used in {@link ImplicitFieldSchema} already implement the {@link SimpleNodeSchema} interfaces, there are limited use-cases for this function.
- * One possible use-case is converting schema to a more serialization friendly format.
- * This format however is not JSON compatible due to use of Maps and Sets,
- * but it it does not rely on cyclic object references for handling recursive schema and instead uses the `definitions` map.
- *
- * @privateRemarks
- * TODO: once SimpleTreeSchema is stable, {@link TreeViewConfiguration} could implement {@link SimpleTreeSchema} directly.
- * That would provide the non-copying alternative that could expose the value type of the definitions map as {@link TreeNodeSchema}.
- */
-export declare function toSimpleTreeSchema(schema: ImplicitFieldSchema, copySchemaObjects: boolean): SimpleTreeSchema;
-/**
- * Copies a {@link SimpleNodeSchema} into a new plain JavaScript object.
- *
- * @remarks Caches the result on the input schema for future calls.
- */
-export declare function copySimpleNodeSchema(schema: SimpleNodeSchema): SimpleNodeSchema;
-/**
- * Creates a copy of a SimpleTreeSchema without metadata fields. This is useful for comparing deserialized view schemas with in-memory schemas.
- * metadata and persistedMetadata are not relevant for schema compatibility checks and are not serialized by the Simple Schema serializer.
- * @see {@link simpleSchemaSerializer.ts} for the serialization logic.
- *
- * @param schema - The SimpleTreeSchema to remove fields from.
- * @param fieldsToRemove - An object specifying which fields to remove.
- * @returns A new SimpleTreeSchema without the specified fields.
- */
-export declare function copySimpleTreeSchemaWithoutMetadata(schema: SimpleTreeSchema): SimpleTreeSchema;
-//# sourceMappingURL=viewSchemaToSimpleSchema.d.ts.map

package/lib/simple-tree/api/viewSchemaToSimpleSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"viewSchemaToSimpleSchema.d.ts","sourceRoot":"","sources":["../../../src/simple-tree/api/viewSchemaToSimpleSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAwB,KAAK,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,KAAK,EAKX,gBAAgB,EAIhB,gBAAgB,EAChB,MAAM,oBAAoB,CAAC;AAW5B;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,mBAAmB,EAC3B,iBAAiB,EAAE,OAAO,GACxB,gBAAgB,CA8BlB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAc/E;AAgDD;;;;;;;;GAQG;AACH,wBAAgB,mCAAmC,CAClD,MAAM,EAAE,gBAAgB,GACtB,gBAAgB,CAmDlB"}

package/lib/simple-tree/api/viewSchemaToSimpleSchema.js

@@ -1,171 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import { normalizeFieldSchema } from "../fieldSchema.js";
-import { NodeKind } from "../core/index.js";
-import { ArrayNodeSchema, MapNodeSchema, ObjectNodeSchema, RecordNodeSchema, } from "../node-kinds/index.js";
-import { walkFieldSchema } from "../walkFieldSchema.js";
-import { LeafNodeSchema } from "../leafNodeSchema.js";
-/**
- * Converts an {@link ImplicitFieldSchema} to a "simple" schema representation.
- *
- * @param schema - The schema to convert
- * @param copySchemaObjects - If true, TreeNodeSchema and FieldSchema are copied into plain JavaScript objects. Either way, custom metadata is referenced and not copied.
- *
- * @remarks
- * Given that the Schema types used in {@link ImplicitFieldSchema} already implement the {@link SimpleNodeSchema} interfaces, there are limited use-cases for this function.
- * One possible use-case is converting schema to a more serialization friendly format.
- * This format however is not JSON compatible due to use of Maps and Sets,
- * but it it does not rely on cyclic object references for handling recursive schema and instead uses the `definitions` map.
- *
- * @privateRemarks
- * TODO: once SimpleTreeSchema is stable, {@link TreeViewConfiguration} could implement {@link SimpleTreeSchema} directly.
- * That would provide the non-copying alternative that could expose the value type of the definitions map as {@link TreeNodeSchema}.
- */
-export function toSimpleTreeSchema(schema, copySchemaObjects) {
-    const normalizedSchema = normalizeFieldSchema(schema);
-    const definitions = new Map();
-    walkFieldSchema(normalizedSchema, {
-        node: (nodeSchema) => {
-            // The set of node kinds is extensible, but the typing of SimpleNodeSchema is not, so we need to check that the schema is one of the known kinds.
-            assert(nodeSchema instanceof ArrayNodeSchema ||
-                nodeSchema instanceof MapNodeSchema ||
-                nodeSchema instanceof LeafNodeSchema ||
-                nodeSchema instanceof ObjectNodeSchema ||
-                nodeSchema instanceof RecordNodeSchema, 0xb60 /* Invalid schema */);
-            const outSchema = copySchemaObjects ? copySimpleNodeSchema(nodeSchema) : nodeSchema;
-            definitions.set(nodeSchema.identifier, outSchema);
-        },
-    });
-    return {
-        root: copySchemaObjects
-            ? ({
-                simpleAllowedTypes: normalizedSchema.simpleAllowedTypes,
-                kind: normalizedSchema.kind,
-                metadata: normalizedSchema.metadata,
-                persistedMetadata: normalizedSchema.persistedMetadata,
-            })
-            : normalizedSchema,
-        definitions,
-    };
-}
-/**
- * Copies a {@link SimpleNodeSchema} into a new plain JavaScript object.
- *
- * @remarks Caches the result on the input schema for future calls.
- */
-export function copySimpleNodeSchema(schema) {
-    const kind = schema.kind;
-    switch (kind) {
-        case NodeKind.Leaf:
-            return copySimpleLeafSchema(schema);
-        case NodeKind.Array:
-        case NodeKind.Map:
-        case NodeKind.Record:
-            return copySimpleSchemaWithAllowedTypes(schema);
-        case NodeKind.Object:
-            return copySimpleObjectSchema(schema);
-        default:
-            unreachableCase(kind);
-    }
-}
-function copySimpleLeafSchema(schema) {
-    return {
-        kind: NodeKind.Leaf,
-        leafKind: schema.leafKind,
-        metadata: schema.metadata,
-        persistedMetadata: schema.persistedMetadata,
-    };
-}
-function copySimpleSchemaWithAllowedTypes(schema) {
-    return {
-        kind: schema.kind,
-        simpleAllowedTypes: schema.simpleAllowedTypes,
-        metadata: schema.metadata,
-        persistedMetadata: schema.persistedMetadata,
-    };
-}
-function copySimpleObjectSchema(schema) {
-    const fields = new Map();
-    for (const [propertyKey, field] of schema.fields) {
-        // field already is a SimpleObjectFieldSchema, but copy the subset of the properties needed by this interface to get a clean simple object.
-        const simpleField = {
-            kind: field.kind,
-            simpleAllowedTypes: field.simpleAllowedTypes,
-            metadata: field.metadata,
-            persistedMetadata: field.persistedMetadata,
-            storedKey: field.storedKey,
-        };
-        fields.set(propertyKey, simpleField);
-    }
-    const simpleObject = {
-        kind: NodeKind.Object,
-        fields,
-        metadata: schema.metadata,
-        persistedMetadata: schema.persistedMetadata,
-        allowUnknownOptionalFields: schema.allowUnknownOptionalFields,
-    };
-    return simpleObject;
-}
-/**
- * Creates a copy of a SimpleTreeSchema without metadata fields. This is useful for comparing deserialized view schemas with in-memory schemas.
- * metadata and persistedMetadata are not relevant for schema compatibility checks and are not serialized by the Simple Schema serializer.
- * @see {@link simpleSchemaSerializer.ts} for the serialization logic.
- *
- * @param schema - The SimpleTreeSchema to remove fields from.
- * @param fieldsToRemove - An object specifying which fields to remove.
- * @returns A new SimpleTreeSchema without the specified fields.
- */
-export function copySimpleTreeSchemaWithoutMetadata(schema) {
-    const definitions = new Map();
-    for (const [identifier, nodeSchema] of schema.definitions.entries()) {
-        const kind = nodeSchema.kind;
-        switch (kind) {
-            case NodeKind.Array:
-            case NodeKind.Map:
-            case NodeKind.Record:
-            case NodeKind.Leaf: {
-                const outputNodeSchema = {
-                    ...nodeSchema,
-                    metadata: {},
-                    persistedMetadata: undefined,
-                };
-                definitions.set(identifier, outputNodeSchema);
-                break;
-            }
-            case NodeKind.Object: {
-                const outputFields = new Map();
-                for (const [propertyKey, fieldSchema] of nodeSchema.fields.entries()) {
-                    const outputField = {
-                        ...fieldSchema,
-                        metadata: {},
-                        persistedMetadata: undefined,
-                    };
-                    outputFields.set(propertyKey, outputField);
-                }
-                const outputNodeSchema = {
-                    ...nodeSchema,
-                    metadata: {},
-                    persistedMetadata: undefined,
-                    fields: outputFields,
-                };
-                definitions.set(identifier, outputNodeSchema);
-                break;
-            }
-            default:
-                unreachableCase(kind);
-        }
-    }
-    return {
-        root: {
-            kind: schema.root.kind,
-            simpleAllowedTypes: schema.root.simpleAllowedTypes,
-            metadata: {},
-            persistedMetadata: undefined,
-        },
-        definitions,
-    };
-}
-//# sourceMappingURL=viewSchemaToSimpleSchema.js.map

package/lib/simple-tree/api/viewSchemaToSimpleSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"viewSchemaToSimpleSchema.js","sourceRoot":"","sources":["../../../src/simple-tree/api/viewSchemaToSimpleSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAA4B,MAAM,mBAAmB,CAAC;AAYnF,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EACN,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,gBAAgB,GAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,kBAAkB,CACjC,MAA2B,EAC3B,iBAA0B;IAE1B,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAC;IACxD,eAAe,CAAC,gBAAgB,EAAE;QACjC,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE;YACpB,iJAAiJ;YACjJ,MAAM,CACL,UAAU,YAAY,eAAe;gBACpC,UAAU,YAAY,aAAa;gBACnC,UAAU,YAAY,cAAc;gBACpC,UAAU,YAAY,gBAAgB;gBACtC,UAAU,YAAY,gBAAgB,EACvC,KAAK,CAAC,oBAAoB,CAC1B,CAAC;YACF,MAAM,SAAS,GAAG,iBAAiB,CAAC,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YACpF,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACnD,CAAC;KACD,CAAC,CAAC;IAEH,OAAO;QACN,IAAI,EAAE,iBAAiB;YACtB,CAAC,CAAC,CAAC;gBACD,kBAAkB,EAAE,gBAAgB,CAAC,kBAAkB;gBACvD,IAAI,EAAE,gBAAgB,CAAC,IAAI;gBAC3B,QAAQ,EAAE,gBAAgB,CAAC,QAAQ;gBACnC,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB;aACzB,CAAC;YAC/B,CAAC,CAAC,gBAAgB;QACnB,WAAW;KACX,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAwB;IAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACzB,QAAQ,IAAI,EAAE,CAAC;QACd,KAAK,QAAQ,CAAC,IAAI;YACjB,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACrC,KAAK,QAAQ,CAAC,KAAK,CAAC;QACpB,KAAK,QAAQ,CAAC,GAAG,CAAC;QAClB,KAAK,QAAQ,CAAC,MAAM;YACnB,OAAO,gCAAgC,CAAC,MAAM,CAAC,CAAC;QACjD,KAAK,QAAQ,CAAC,MAAM;YACnB,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACvC;YACC,eAAe,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA4B;IACzD,OAAO;QACN,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KAC3C,CAAC;AACH,CAAC;AAED,SAAS,gCAAgC,CACxC,MAA4E;IAE5E,OAAO;QACN,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;KAC3C,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,MAA8B;IAC7D,MAAM,MAAM,GAAyC,IAAI,GAAG,EAAE,CAAC;IAC/D,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClD,2IAA2I;QAC3I,MAAM,WAAW,GAAG;YACnB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;YAC5C,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,SAAS,EAAE,KAAK,CAAC,SAAS;SAC1B,CAAC;QAEF,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,YAAY,GAAG;QACpB,IAAI,EAAE,QAAQ,CAAC,MAAM;QACrB,MAAM;QACN,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,0BAA0B,EAAE,MAAM,CAAC,0BAA0B;KAC5B,CAAC;IAEnC,OAAO,YAAY,CAAC;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mCAAmC,CAClD,MAAwB;IAExB,MAAM,WAAW,GAAG,IAAI,GAAG,EAA4B,CAAC;IAExD,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC7B,QAAQ,IAAI,EAAE,CAAC;YACd,KAAK,QAAQ,CAAC,KAAK,CAAC;YACpB,KAAK,QAAQ,CAAC,GAAG,CAAC;YAClB,KAAK,QAAQ,CAAC,MAAM,CAAC;YACrB,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpB,MAAM,gBAAgB,GAAG;oBACxB,GAAG,UAAU;oBACb,QAAQ,EAAE,EAAE;oBACZ,iBAAiB,EAAE,SAAS;iBAC5B,CAAC;gBACF,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;gBAC9C,MAAM;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAmC,CAAC;gBAChE,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;oBACtE,MAAM,WAAW,GAA4B;wBAC5C,GAAG,WAAW;wBACd,QAAQ,EAAE,EAAE;wBACZ,iBAAiB,EAAE,SAAS;qBAC5B,CAAC;oBACF,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;gBAC5C,CAAC;gBACD,MAAM,gBAAgB,GAAG;oBACxB,GAAG,UAAU;oBACb,QAAQ,EAAE,EAAE;oBACZ,iBAAiB,EAAE,SAAS;oBAC5B,MAAM,EAAE,YAAY;iBACpB,CAAC;gBACF,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;gBAC9C,MAAM;YACP,CAAC;YACD;gBACC,eAAe,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACF,CAAC;IAED,OAAO;QACN,IAAI,EAAE;YACL,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI;YACtB,kBAAkB,EAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB;YAClD,QAAQ,EAAE,EAAE;YACZ,iBAAiB,EAAE,SAAS;SAC5B;QACD,WAAW;KACX,CAAC;AACH,CAAC","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 { normalizeFieldSchema, type ImplicitFieldSchema } from \"../fieldSchema.js\";\nimport type {\n\tSimpleArrayNodeSchema,\n\tSimpleFieldSchema,\n\tSimpleLeafNodeSchema,\n\tSimpleMapNodeSchema,\n\tSimpleNodeSchema,\n\tSimpleObjectFieldSchema,\n\tSimpleObjectNodeSchema,\n\tSimpleRecordNodeSchema,\n\tSimpleTreeSchema,\n} from \"../simpleSchema.js\";\nimport { NodeKind } from \"../core/index.js\";\nimport {\n\tArrayNodeSchema,\n\tMapNodeSchema,\n\tObjectNodeSchema,\n\tRecordNodeSchema,\n} from \"../node-kinds/index.js\";\nimport { walkFieldSchema } from \"../walkFieldSchema.js\";\nimport { LeafNodeSchema } from \"../leafNodeSchema.js\";\n\n/**\n * Converts an {@link ImplicitFieldSchema} to a \"simple\" schema representation.\n *\n * @param schema - The schema to convert\n * @param copySchemaObjects - If true, TreeNodeSchema and FieldSchema are copied into plain JavaScript objects. Either way, custom metadata is referenced and not copied.\n *\n * @remarks\n * Given that the Schema types used in {@link ImplicitFieldSchema} already implement the {@link SimpleNodeSchema} interfaces, there are limited use-cases for this function.\n * One possible use-case is converting schema to a more serialization friendly format.\n * This format however is not JSON compatible due to use of Maps and Sets,\n * but it it does not rely on cyclic object references for handling recursive schema and instead uses the `definitions` map.\n *\n * @privateRemarks\n * TODO: once SimpleTreeSchema is stable, {@link TreeViewConfiguration} could implement {@link SimpleTreeSchema} directly.\n * That would provide the non-copying alternative that could expose the value type of the definitions map as {@link TreeNodeSchema}.\n */\nexport function toSimpleTreeSchema(\n\tschema: ImplicitFieldSchema,\n\tcopySchemaObjects: boolean,\n): SimpleTreeSchema {\n\tconst normalizedSchema = normalizeFieldSchema(schema);\n\tconst definitions = new Map<string, SimpleNodeSchema>();\n\twalkFieldSchema(normalizedSchema, {\n\t\tnode: (nodeSchema) => {\n\t\t\t// The set of node kinds is extensible, but the typing of SimpleNodeSchema is not, so we need to check that the schema is one of the known kinds.\n\t\t\tassert(\n\t\t\t\tnodeSchema instanceof ArrayNodeSchema ||\n\t\t\t\t\tnodeSchema instanceof MapNodeSchema ||\n\t\t\t\t\tnodeSchema instanceof LeafNodeSchema ||\n\t\t\t\t\tnodeSchema instanceof ObjectNodeSchema ||\n\t\t\t\t\tnodeSchema instanceof RecordNodeSchema,\n\t\t\t\t0xb60 /* Invalid schema */,\n\t\t\t);\n\t\t\tconst outSchema = copySchemaObjects ? copySimpleNodeSchema(nodeSchema) : nodeSchema;\n\t\t\tdefinitions.set(nodeSchema.identifier, outSchema);\n\t\t},\n\t});\n\n\treturn {\n\t\troot: copySchemaObjects\n\t\t\t? ({\n\t\t\t\t\tsimpleAllowedTypes: normalizedSchema.simpleAllowedTypes,\n\t\t\t\t\tkind: normalizedSchema.kind,\n\t\t\t\t\tmetadata: normalizedSchema.metadata,\n\t\t\t\t\tpersistedMetadata: normalizedSchema.persistedMetadata,\n\t\t\t\t} satisfies SimpleFieldSchema)\n\t\t\t: normalizedSchema,\n\t\tdefinitions,\n\t};\n}\n\n/**\n * Copies a {@link SimpleNodeSchema} into a new plain JavaScript object.\n *\n * @remarks Caches the result on the input schema for future calls.\n */\nexport function copySimpleNodeSchema(schema: SimpleNodeSchema): SimpleNodeSchema {\n\tconst kind = schema.kind;\n\tswitch (kind) {\n\t\tcase NodeKind.Leaf:\n\t\t\treturn copySimpleLeafSchema(schema);\n\t\tcase NodeKind.Array:\n\t\tcase NodeKind.Map:\n\t\tcase NodeKind.Record:\n\t\t\treturn copySimpleSchemaWithAllowedTypes(schema);\n\t\tcase NodeKind.Object:\n\t\t\treturn copySimpleObjectSchema(schema);\n\t\tdefault:\n\t\t\tunreachableCase(kind);\n\t}\n}\n\nfunction copySimpleLeafSchema(schema: SimpleLeafNodeSchema): SimpleLeafNodeSchema {\n\treturn {\n\t\tkind: NodeKind.Leaf,\n\t\tleafKind: schema.leafKind,\n\t\tmetadata: schema.metadata,\n\t\tpersistedMetadata: schema.persistedMetadata,\n\t};\n}\n\nfunction copySimpleSchemaWithAllowedTypes(\n\tschema: SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema,\n): SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema {\n\treturn {\n\t\tkind: schema.kind,\n\t\tsimpleAllowedTypes: schema.simpleAllowedTypes,\n\t\tmetadata: schema.metadata,\n\t\tpersistedMetadata: schema.persistedMetadata,\n\t};\n}\n\nfunction copySimpleObjectSchema(schema: SimpleObjectNodeSchema): SimpleObjectNodeSchema {\n\tconst fields: Map<string, SimpleObjectFieldSchema> = new Map();\n\tfor (const [propertyKey, field] of schema.fields) {\n\t\t// field already is a SimpleObjectFieldSchema, but copy the subset of the properties needed by this interface to get a clean simple object.\n\t\tconst simpleField = {\n\t\t\tkind: field.kind,\n\t\t\tsimpleAllowedTypes: field.simpleAllowedTypes,\n\t\t\tmetadata: field.metadata,\n\t\t\tpersistedMetadata: field.persistedMetadata,\n\t\t\tstoredKey: field.storedKey,\n\t\t};\n\n\t\tfields.set(propertyKey, simpleField);\n\t}\n\n\tconst simpleObject = {\n\t\tkind: NodeKind.Object,\n\t\tfields,\n\t\tmetadata: schema.metadata,\n\t\tpersistedMetadata: schema.persistedMetadata,\n\t\tallowUnknownOptionalFields: schema.allowUnknownOptionalFields,\n\t} satisfies SimpleObjectNodeSchema;\n\n\treturn simpleObject;\n}\n\n/**\n * Creates a copy of a SimpleTreeSchema without metadata fields. This is useful for comparing deserialized view schemas with in-memory schemas.\n * metadata and persistedMetadata are not relevant for schema compatibility checks and are not serialized by the Simple Schema serializer.\n * @see {@link simpleSchemaSerializer.ts} for the serialization logic.\n *\n * @param schema - The SimpleTreeSchema to remove fields from.\n * @param fieldsToRemove - An object specifying which fields to remove.\n * @returns A new SimpleTreeSchema without the specified fields.\n */\nexport function copySimpleTreeSchemaWithoutMetadata(\n\tschema: SimpleTreeSchema,\n): SimpleTreeSchema {\n\tconst definitions = new Map<string, SimpleNodeSchema>();\n\n\tfor (const [identifier, nodeSchema] of schema.definitions.entries()) {\n\t\tconst kind = nodeSchema.kind;\n\t\tswitch (kind) {\n\t\t\tcase NodeKind.Array:\n\t\t\tcase NodeKind.Map:\n\t\t\tcase NodeKind.Record:\n\t\t\tcase NodeKind.Leaf: {\n\t\t\t\tconst outputNodeSchema = {\n\t\t\t\t\t...nodeSchema,\n\t\t\t\t\tmetadata: {},\n\t\t\t\t\tpersistedMetadata: undefined,\n\t\t\t\t};\n\t\t\t\tdefinitions.set(identifier, outputNodeSchema);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase NodeKind.Object: {\n\t\t\t\tconst outputFields = new Map<string, SimpleObjectFieldSchema>();\n\t\t\t\tfor (const [propertyKey, fieldSchema] of nodeSchema.fields.entries()) {\n\t\t\t\t\tconst outputField: SimpleObjectFieldSchema = {\n\t\t\t\t\t\t...fieldSchema,\n\t\t\t\t\t\tmetadata: {},\n\t\t\t\t\t\tpersistedMetadata: undefined,\n\t\t\t\t\t};\n\t\t\t\t\toutputFields.set(propertyKey, outputField);\n\t\t\t\t}\n\t\t\t\tconst outputNodeSchema = {\n\t\t\t\t\t...nodeSchema,\n\t\t\t\t\tmetadata: {},\n\t\t\t\t\tpersistedMetadata: undefined,\n\t\t\t\t\tfields: outputFields,\n\t\t\t\t};\n\t\t\t\tdefinitions.set(identifier, outputNodeSchema);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault:\n\t\t\t\tunreachableCase(kind);\n\t\t}\n\t}\n\n\treturn {\n\t\troot: {\n\t\t\tkind: schema.root.kind,\n\t\t\tsimpleAllowedTypes: schema.root.simpleAllowedTypes,\n\t\t\tmetadata: {},\n\t\t\tpersistedMetadata: undefined,\n\t\t},\n\t\tdefinitions,\n\t};\n}\n"]}

package/src/simple-tree/api/viewSchemaToSimpleSchema.ts

@@ -1,209 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import { normalizeFieldSchema, type ImplicitFieldSchema } from "../fieldSchema.js";
-import type {
-	SimpleArrayNodeSchema,
-	SimpleFieldSchema,
-	SimpleLeafNodeSchema,
-	SimpleMapNodeSchema,
-	SimpleNodeSchema,
-	SimpleObjectFieldSchema,
-	SimpleObjectNodeSchema,
-	SimpleRecordNodeSchema,
-	SimpleTreeSchema,
-} from "../simpleSchema.js";
-import { NodeKind } from "../core/index.js";
-import {
-	ArrayNodeSchema,
-	MapNodeSchema,
-	ObjectNodeSchema,
-	RecordNodeSchema,
-} from "../node-kinds/index.js";
-import { walkFieldSchema } from "../walkFieldSchema.js";
-import { LeafNodeSchema } from "../leafNodeSchema.js";
-
-/**
- * Converts an {@link ImplicitFieldSchema} to a "simple" schema representation.
- *
- * @param schema - The schema to convert
- * @param copySchemaObjects - If true, TreeNodeSchema and FieldSchema are copied into plain JavaScript objects. Either way, custom metadata is referenced and not copied.
- *
- * @remarks
- * Given that the Schema types used in {@link ImplicitFieldSchema} already implement the {@link SimpleNodeSchema} interfaces, there are limited use-cases for this function.
- * One possible use-case is converting schema to a more serialization friendly format.
- * This format however is not JSON compatible due to use of Maps and Sets,
- * but it it does not rely on cyclic object references for handling recursive schema and instead uses the `definitions` map.
- *
- * @privateRemarks
- * TODO: once SimpleTreeSchema is stable, {@link TreeViewConfiguration} could implement {@link SimpleTreeSchema} directly.
- * That would provide the non-copying alternative that could expose the value type of the definitions map as {@link TreeNodeSchema}.
- */
-export function toSimpleTreeSchema(
-	schema: ImplicitFieldSchema,
-	copySchemaObjects: boolean,
-): SimpleTreeSchema {
-	const normalizedSchema = normalizeFieldSchema(schema);
-	const definitions = new Map<string, SimpleNodeSchema>();
-	walkFieldSchema(normalizedSchema, {
-		node: (nodeSchema) => {
-			// The set of node kinds is extensible, but the typing of SimpleNodeSchema is not, so we need to check that the schema is one of the known kinds.
-			assert(
-				nodeSchema instanceof ArrayNodeSchema ||
-					nodeSchema instanceof MapNodeSchema ||
-					nodeSchema instanceof LeafNodeSchema ||
-					nodeSchema instanceof ObjectNodeSchema ||
-					nodeSchema instanceof RecordNodeSchema,
-				0xb60 /* Invalid schema */,
-			);
-			const outSchema = copySchemaObjects ? copySimpleNodeSchema(nodeSchema) : nodeSchema;
-			definitions.set(nodeSchema.identifier, outSchema);
-		},
-	});
-
-	return {
-		root: copySchemaObjects
-			? ({
-					simpleAllowedTypes: normalizedSchema.simpleAllowedTypes,
-					kind: normalizedSchema.kind,
-					metadata: normalizedSchema.metadata,
-					persistedMetadata: normalizedSchema.persistedMetadata,
-				} satisfies SimpleFieldSchema)
-			: normalizedSchema,
-		definitions,
-	};
-}
-
-/**
- * Copies a {@link SimpleNodeSchema} into a new plain JavaScript object.
- *
- * @remarks Caches the result on the input schema for future calls.
- */
-export function copySimpleNodeSchema(schema: SimpleNodeSchema): SimpleNodeSchema {
-	const kind = schema.kind;
-	switch (kind) {
-		case NodeKind.Leaf:
-			return copySimpleLeafSchema(schema);
-		case NodeKind.Array:
-		case NodeKind.Map:
-		case NodeKind.Record:
-			return copySimpleSchemaWithAllowedTypes(schema);
-		case NodeKind.Object:
-			return copySimpleObjectSchema(schema);
-		default:
-			unreachableCase(kind);
-	}
-}
-
-function copySimpleLeafSchema(schema: SimpleLeafNodeSchema): SimpleLeafNodeSchema {
-	return {
-		kind: NodeKind.Leaf,
-		leafKind: schema.leafKind,
-		metadata: schema.metadata,
-		persistedMetadata: schema.persistedMetadata,
-	};
-}
-
-function copySimpleSchemaWithAllowedTypes(
-	schema: SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema,
-): SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleRecordNodeSchema {
-	return {
-		kind: schema.kind,
-		simpleAllowedTypes: schema.simpleAllowedTypes,
-		metadata: schema.metadata,
-		persistedMetadata: schema.persistedMetadata,
-	};
-}
-
-function copySimpleObjectSchema(schema: SimpleObjectNodeSchema): SimpleObjectNodeSchema {
-	const fields: Map<string, SimpleObjectFieldSchema> = new Map();
-	for (const [propertyKey, field] of schema.fields) {
-		// field already is a SimpleObjectFieldSchema, but copy the subset of the properties needed by this interface to get a clean simple object.
-		const simpleField = {
-			kind: field.kind,
-			simpleAllowedTypes: field.simpleAllowedTypes,
-			metadata: field.metadata,
-			persistedMetadata: field.persistedMetadata,
-			storedKey: field.storedKey,
-		};
-
-		fields.set(propertyKey, simpleField);
-	}
-
-	const simpleObject = {
-		kind: NodeKind.Object,
-		fields,
-		metadata: schema.metadata,
-		persistedMetadata: schema.persistedMetadata,
-		allowUnknownOptionalFields: schema.allowUnknownOptionalFields,
-	} satisfies SimpleObjectNodeSchema;
-
-	return simpleObject;
-}
-
-/**
- * Creates a copy of a SimpleTreeSchema without metadata fields. This is useful for comparing deserialized view schemas with in-memory schemas.
- * metadata and persistedMetadata are not relevant for schema compatibility checks and are not serialized by the Simple Schema serializer.
- * @see {@link simpleSchemaSerializer.ts} for the serialization logic.
- *
- * @param schema - The SimpleTreeSchema to remove fields from.
- * @param fieldsToRemove - An object specifying which fields to remove.
- * @returns A new SimpleTreeSchema without the specified fields.
- */
-export function copySimpleTreeSchemaWithoutMetadata(
-	schema: SimpleTreeSchema,
-): SimpleTreeSchema {
-	const definitions = new Map<string, SimpleNodeSchema>();
-
-	for (const [identifier, nodeSchema] of schema.definitions.entries()) {
-		const kind = nodeSchema.kind;
-		switch (kind) {
-			case NodeKind.Array:
-			case NodeKind.Map:
-			case NodeKind.Record:
-			case NodeKind.Leaf: {
-				const outputNodeSchema = {
-					...nodeSchema,
-					metadata: {},
-					persistedMetadata: undefined,
-				};
-				definitions.set(identifier, outputNodeSchema);
-				break;
-			}
-			case NodeKind.Object: {
-				const outputFields = new Map<string, SimpleObjectFieldSchema>();
-				for (const [propertyKey, fieldSchema] of nodeSchema.fields.entries()) {
-					const outputField: SimpleObjectFieldSchema = {
-						...fieldSchema,
-						metadata: {},
-						persistedMetadata: undefined,
-					};
-					outputFields.set(propertyKey, outputField);
-				}
-				const outputNodeSchema = {
-					...nodeSchema,
-					metadata: {},
-					persistedMetadata: undefined,
-					fields: outputFields,
-				};
-				definitions.set(identifier, outputNodeSchema);
-				break;
-			}
-			default:
-				unreachableCase(kind);
-		}
-	}
-
-	return {
-		root: {
-			kind: schema.root.kind,
-			simpleAllowedTypes: schema.root.simpleAllowedTypes,
-			metadata: {},
-			persistedMetadata: undefined,
-		},
-		definitions,
-	};
-}