@fluidframework/tree 2.51.0 → 2.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +0 -1
- package/CHANGELOG.md +43 -0
- package/api-report/tree.alpha.api.md +3 -2
- package/dist/codec/codec.d.ts +2 -1
- package/dist/codec/codec.d.ts.map +1 -1
- package/dist/codec/codec.js +4 -3
- package/dist/codec/codec.js.map +1 -1
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.js +3 -2
- package/dist/core/index.js.map +1 -1
- package/dist/core/rebase/index.d.ts +1 -1
- package/dist/core/rebase/index.d.ts.map +1 -1
- package/dist/core/rebase/index.js +2 -1
- package/dist/core/rebase/index.js.map +1 -1
- package/dist/core/rebase/types.d.ts +3 -1
- package/dist/core/rebase/types.d.ts.map +1 -1
- package/dist/core/rebase/types.js +2 -1
- package/dist/core/rebase/types.js.map +1 -1
- package/dist/core/schema-stored/schema.d.ts +1 -23
- package/dist/core/schema-stored/schema.d.ts.map +1 -1
- package/dist/core/schema-stored/schema.js +2 -2
- package/dist/core/schema-stored/schema.js.map +1 -1
- package/dist/core/tree/detachedFieldIndex.d.ts.map +1 -1
- package/dist/core/tree/detachedFieldIndex.js +2 -3
- package/dist/core/tree/detachedFieldIndex.js.map +1 -1
- package/dist/core/tree/detachedFieldIndexCodecCommon.d.ts +17 -0
- package/dist/core/tree/detachedFieldIndexCodecCommon.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecCommon.js +68 -0
- package/dist/core/tree/detachedFieldIndexCodecCommon.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecV1.d.ts +11 -0
- package/dist/core/tree/detachedFieldIndexCodecV1.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecV1.js +55 -0
- package/dist/core/tree/detachedFieldIndexCodecV1.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecV2.d.ts +11 -0
- package/dist/core/tree/detachedFieldIndexCodecV2.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecV2.js +49 -0
- package/dist/core/tree/detachedFieldIndexCodecV2.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecs.d.ts +11 -0
- package/dist/core/tree/detachedFieldIndexCodecs.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexCodecs.js +26 -0
- package/dist/core/tree/detachedFieldIndexCodecs.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexFormatCommon.d.ts +37 -0
- package/dist/core/tree/detachedFieldIndexFormatCommon.d.ts.map +1 -0
- package/dist/core/tree/{detachedFieldIndexFormat.js → detachedFieldIndexFormatCommon.js} +18 -13
- package/dist/core/tree/detachedFieldIndexFormatCommon.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexFormatV1.d.ts +13 -0
- package/dist/core/tree/detachedFieldIndexFormatV1.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexFormatV1.js +12 -0
- package/dist/core/tree/detachedFieldIndexFormatV1.js.map +1 -0
- package/dist/core/tree/detachedFieldIndexFormatV2.d.ts +14 -0
- package/dist/core/tree/detachedFieldIndexFormatV2.d.ts.map +1 -0
- package/dist/core/tree/detachedFieldIndexFormatV2.js +14 -0
- package/dist/core/tree/detachedFieldIndexFormatV2.js.map +1 -0
- package/dist/feature-libraries/chunked-forest/codec/chunkDecoding.d.ts +9 -9
- package/dist/feature-libraries/chunked-forest/codec/chunkDecoding.d.ts.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/chunkDecoding.js +21 -21
- package/dist/feature-libraries/chunked-forest/codec/chunkDecoding.js.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.d.ts +4 -2
- package/dist/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.d.ts.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.js +4 -4
- package/dist/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.js.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/compressedEncode.d.ts +50 -31
- package/dist/feature-libraries/chunked-forest/codec/compressedEncode.d.ts.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/compressedEncode.js +74 -61
- package/dist/feature-libraries/chunked-forest/codec/compressedEncode.js.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/format.d.ts +20 -14
- package/dist/feature-libraries/chunked-forest/codec/format.d.ts.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/format.js +18 -12
- package/dist/feature-libraries/chunked-forest/codec/format.js.map +1 -1
- package/{lib/feature-libraries/chunked-forest/codec/nodeShape.d.ts → dist/feature-libraries/chunked-forest/codec/nodeEncoder.d.ts} +20 -14
- package/dist/feature-libraries/chunked-forest/codec/nodeEncoder.d.ts.map +1 -0
- package/dist/feature-libraries/chunked-forest/codec/{nodeShape.js → nodeEncoder.js} +23 -17
- package/dist/feature-libraries/chunked-forest/codec/nodeEncoder.js.map +1 -0
- package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncode.d.ts +7 -7
- package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncode.d.ts.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncode.js +22 -22
- package/dist/feature-libraries/chunked-forest/codec/schemaBasedEncode.js.map +1 -1
- package/dist/feature-libraries/chunked-forest/codec/uncompressedEncode.js +2 -2
- package/dist/feature-libraries/chunked-forest/codec/uncompressedEncode.js.map +1 -1
- package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts +5 -1
- package/dist/feature-libraries/default-schema/defaultFieldKinds.d.ts.map +1 -1
- package/dist/feature-libraries/default-schema/defaultFieldKinds.js +14 -2
- package/dist/feature-libraries/default-schema/defaultFieldKinds.js.map +1 -1
- package/dist/feature-libraries/default-schema/defaultSchema.d.ts.map +1 -1
- package/dist/feature-libraries/default-schema/defaultSchema.js +0 -2
- package/dist/feature-libraries/default-schema/defaultSchema.js.map +1 -1
- package/dist/feature-libraries/default-schema/index.d.ts +1 -1
- package/dist/feature-libraries/default-schema/index.d.ts.map +1 -1
- package/dist/feature-libraries/default-schema/index.js +2 -2
- package/dist/feature-libraries/default-schema/index.js.map +1 -1
- package/dist/feature-libraries/default-schema/schemaChecker.d.ts +14 -4
- package/dist/feature-libraries/default-schema/schemaChecker.d.ts.map +1 -1
- package/dist/feature-libraries/default-schema/schemaChecker.js +31 -26
- package/dist/feature-libraries/default-schema/schemaChecker.js.map +1 -1
- package/dist/feature-libraries/index.d.ts +1 -2
- package/dist/feature-libraries/index.d.ts.map +1 -1
- package/dist/feature-libraries/index.js +2 -4
- package/dist/feature-libraries/index.js.map +1 -1
- package/dist/feature-libraries/modular-schema/comparison.d.ts +5 -6
- package/dist/feature-libraries/modular-schema/comparison.d.ts.map +1 -1
- package/dist/feature-libraries/modular-schema/comparison.js +15 -16
- package/dist/feature-libraries/modular-schema/comparison.js.map +1 -1
- package/dist/feature-libraries/modular-schema/modularChangeFormat.d.ts +9 -3
- package/dist/feature-libraries/modular-schema/modularChangeFormat.d.ts.map +1 -1
- package/dist/feature-libraries/object-forest/objectForest.d.ts.map +1 -1
- package/dist/feature-libraries/object-forest/objectForest.js +2 -3
- package/dist/feature-libraries/object-forest/objectForest.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -2
- package/dist/index.js.map +1 -1
- package/dist/packageVersion.d.ts +1 -1
- package/dist/packageVersion.js +1 -1
- package/dist/packageVersion.js.map +1 -1
- package/dist/shared-tree/independentView.d.ts +8 -0
- package/dist/shared-tree/independentView.d.ts.map +1 -1
- package/dist/shared-tree/independentView.js +23 -11
- package/dist/shared-tree/independentView.js.map +1 -1
- package/dist/shared-tree/schematizeTree.js +1 -1
- package/dist/shared-tree/schematizeTree.js.map +1 -1
- package/dist/shared-tree/schematizingTreeView.d.ts +0 -1
- package/dist/shared-tree/schematizingTreeView.d.ts.map +1 -1
- package/dist/shared-tree/schematizingTreeView.js +7 -10
- package/dist/shared-tree/schematizingTreeView.js.map +1 -1
- package/dist/shared-tree/sharedTree.d.ts.map +1 -1
- package/dist/shared-tree/sharedTree.js +1 -29
- package/dist/shared-tree/sharedTree.js.map +1 -1
- package/dist/shared-tree/treeAlpha.d.ts +20 -6
- package/dist/shared-tree/treeAlpha.d.ts.map +1 -1
- package/dist/shared-tree/treeAlpha.js +9 -4
- package/dist/shared-tree/treeAlpha.js.map +1 -1
- package/dist/shared-tree/treeCheckout.d.ts +2 -1
- package/dist/shared-tree/treeCheckout.d.ts.map +1 -1
- package/dist/shared-tree/treeCheckout.js +32 -0
- package/dist/shared-tree/treeCheckout.js.map +1 -1
- package/dist/shared-tree-core/branch.d.ts.map +1 -1
- package/dist/shared-tree-core/branch.js +1 -1
- package/dist/shared-tree-core/branch.js.map +1 -1
- package/dist/simple-tree/api/conciseTree.d.ts +2 -2
- package/dist/simple-tree/api/conciseTree.d.ts.map +1 -1
- package/dist/simple-tree/api/conciseTree.js +6 -6
- package/dist/simple-tree/api/conciseTree.js.map +1 -1
- package/dist/simple-tree/api/configuration.d.ts +8 -2
- package/dist/simple-tree/api/configuration.d.ts.map +1 -1
- package/dist/simple-tree/api/configuration.js.map +1 -1
- package/dist/simple-tree/api/create.d.ts +8 -7
- package/dist/simple-tree/api/create.d.ts.map +1 -1
- package/dist/simple-tree/api/create.js +35 -22
- package/dist/simple-tree/api/create.js.map +1 -1
- package/dist/simple-tree/api/customTree.d.ts +25 -4
- package/dist/simple-tree/api/customTree.d.ts.map +1 -1
- package/dist/simple-tree/api/customTree.js +42 -16
- package/dist/simple-tree/api/customTree.js.map +1 -1
- package/dist/simple-tree/api/discrepancies.d.ts +98 -0
- package/dist/simple-tree/api/discrepancies.d.ts.map +1 -0
- package/dist/simple-tree/api/discrepancies.js +255 -0
- package/dist/simple-tree/api/discrepancies.js.map +1 -0
- package/dist/simple-tree/api/schemaCompatibilityTester.d.ts +9 -7
- package/dist/simple-tree/api/schemaCompatibilityTester.d.ts.map +1 -1
- package/dist/simple-tree/api/schemaCompatibilityTester.js +18 -117
- package/dist/simple-tree/api/schemaCompatibilityTester.js.map +1 -1
- package/dist/simple-tree/api/schemaFactory.d.ts +7 -4
- package/dist/simple-tree/api/schemaFactory.d.ts.map +1 -1
- package/dist/simple-tree/api/schemaFactory.js.map +1 -1
- package/dist/simple-tree/api/storedSchema.d.ts.map +1 -1
- package/dist/simple-tree/api/storedSchema.js +5 -1
- package/dist/simple-tree/api/storedSchema.js.map +1 -1
- package/dist/simple-tree/api/treeBeta.d.ts +2 -2
- package/dist/simple-tree/api/treeBeta.d.ts.map +1 -1
- package/dist/simple-tree/api/treeBeta.js +10 -4
- package/dist/simple-tree/api/treeBeta.js.map +1 -1
- package/dist/simple-tree/api/verboseTree.d.ts +2 -2
- package/dist/simple-tree/api/verboseTree.d.ts.map +1 -1
- package/dist/simple-tree/api/verboseTree.js +15 -15
- package/dist/simple-tree/api/verboseTree.js.map +1 -1
- package/dist/simple-tree/core/allowedTypes.d.ts +20 -4
- package/dist/simple-tree/core/allowedTypes.d.ts.map +1 -1
- package/dist/simple-tree/core/allowedTypes.js +45 -13
- package/dist/simple-tree/core/allowedTypes.js.map +1 -1
- package/dist/simple-tree/core/context.d.ts +13 -2
- package/dist/simple-tree/core/context.d.ts.map +1 -1
- package/dist/simple-tree/core/context.js +22 -9
- package/dist/simple-tree/core/context.js.map +1 -1
- package/dist/simple-tree/core/index.d.ts +2 -2
- package/dist/simple-tree/core/index.d.ts.map +1 -1
- package/dist/simple-tree/core/index.js +3 -1
- package/dist/simple-tree/core/index.js.map +1 -1
- package/dist/simple-tree/core/treeNodeKernel.d.ts +1 -1
- package/dist/simple-tree/core/treeNodeKernel.js +1 -1
- package/dist/simple-tree/core/treeNodeKernel.js.map +1 -1
- package/dist/simple-tree/core/treeNodeValid.d.ts +1 -1
- package/dist/simple-tree/core/treeNodeValid.d.ts.map +1 -1
- package/dist/simple-tree/core/treeNodeValid.js +8 -1
- package/dist/simple-tree/core/treeNodeValid.js.map +1 -1
- package/dist/simple-tree/core/walkSchema.d.ts +3 -0
- package/dist/simple-tree/core/walkSchema.d.ts.map +1 -1
- package/dist/simple-tree/core/walkSchema.js +2 -0
- package/dist/simple-tree/core/walkSchema.js.map +1 -1
- package/dist/simple-tree/createContext.d.ts +2 -0
- package/dist/simple-tree/createContext.d.ts.map +1 -1
- package/dist/simple-tree/createContext.js +3 -1
- package/dist/simple-tree/createContext.js.map +1 -1
- package/dist/simple-tree/fieldSchema.d.ts +1 -0
- package/dist/simple-tree/fieldSchema.d.ts.map +1 -1
- package/dist/simple-tree/fieldSchema.js +1 -0
- package/dist/simple-tree/fieldSchema.js.map +1 -1
- package/dist/simple-tree/index.d.ts +4 -4
- package/dist/simple-tree/index.d.ts.map +1 -1
- package/dist/simple-tree/index.js +7 -8
- package/dist/simple-tree/index.js.map +1 -1
- package/dist/simple-tree/node-kinds/array/arrayNode.d.ts.map +1 -1
- package/dist/simple-tree/node-kinds/array/arrayNode.js +1 -1
- package/dist/simple-tree/node-kinds/array/arrayNode.js.map +1 -1
- package/dist/simple-tree/node-kinds/index.d.ts +1 -1
- package/dist/simple-tree/node-kinds/index.d.ts.map +1 -1
- package/dist/simple-tree/node-kinds/index.js +1 -2
- package/dist/simple-tree/node-kinds/index.js.map +1 -1
- package/dist/simple-tree/node-kinds/object/index.d.ts +1 -1
- package/dist/simple-tree/node-kinds/object/index.d.ts.map +1 -1
- package/dist/simple-tree/node-kinds/object/index.js +1 -2
- package/dist/simple-tree/node-kinds/object/index.js.map +1 -1
- package/dist/simple-tree/node-kinds/object/objectNode.d.ts +2 -7
- package/dist/simple-tree/node-kinds/object/objectNode.d.ts.map +1 -1
- package/dist/simple-tree/node-kinds/object/objectNode.js +4 -18
- package/dist/simple-tree/node-kinds/object/objectNode.js.map +1 -1
- package/dist/simple-tree/prepareForInsertion.d.ts +5 -5
- package/dist/simple-tree/prepareForInsertion.d.ts.map +1 -1
- package/dist/simple-tree/prepareForInsertion.js +9 -3
- package/dist/simple-tree/prepareForInsertion.js.map +1 -1
- package/dist/simple-tree/toStoredSchema.d.ts +3 -0
- package/dist/simple-tree/toStoredSchema.d.ts.map +1 -1
- package/dist/simple-tree/toStoredSchema.js +3 -0
- package/dist/simple-tree/toStoredSchema.js.map +1 -1
- package/dist/simple-tree/unhydratedFlexTreeFromInsertable.d.ts +2 -2
- package/dist/simple-tree/unhydratedFlexTreeFromInsertable.d.ts.map +1 -1
- package/dist/simple-tree/unhydratedFlexTreeFromInsertable.js.map +1 -1
- package/dist/simple-tree/walkFieldSchema.d.ts +1 -0
- package/dist/simple-tree/walkFieldSchema.d.ts.map +1 -1
- package/dist/simple-tree/walkFieldSchema.js +1 -0
- package/dist/simple-tree/walkFieldSchema.js.map +1 -1
- package/lib/codec/codec.d.ts +2 -1
- package/lib/codec/codec.d.ts.map +1 -1
- package/lib/codec/codec.js +4 -3
- package/lib/codec/codec.js.map +1 -1
- package/lib/core/index.d.ts +1 -1
- package/lib/core/index.d.ts.map +1 -1
- package/lib/core/index.js +1 -1
- package/lib/core/index.js.map +1 -1
- package/lib/core/rebase/index.d.ts +1 -1
- package/lib/core/rebase/index.d.ts.map +1 -1
- package/lib/core/rebase/index.js +1 -1
- package/lib/core/rebase/index.js.map +1 -1
- package/lib/core/rebase/types.d.ts +3 -1
- package/lib/core/rebase/types.d.ts.map +1 -1
- package/lib/core/rebase/types.js +1 -0
- package/lib/core/rebase/types.js.map +1 -1
- package/lib/core/schema-stored/schema.d.ts +1 -23
- package/lib/core/schema-stored/schema.d.ts.map +1 -1
- package/lib/core/schema-stored/schema.js +2 -2
- package/lib/core/schema-stored/schema.js.map +1 -1
- package/lib/core/tree/detachedFieldIndex.d.ts.map +1 -1
- package/lib/core/tree/detachedFieldIndex.js +2 -3
- package/lib/core/tree/detachedFieldIndex.js.map +1 -1
- package/lib/core/tree/detachedFieldIndexCodecCommon.d.ts +17 -0
- package/lib/core/tree/detachedFieldIndexCodecCommon.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecCommon.js +64 -0
- package/lib/core/tree/detachedFieldIndexCodecCommon.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecV1.d.ts +11 -0
- package/lib/core/tree/detachedFieldIndexCodecV1.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecV1.js +51 -0
- package/lib/core/tree/detachedFieldIndexCodecV1.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecV2.d.ts +11 -0
- package/lib/core/tree/detachedFieldIndexCodecV2.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecV2.js +45 -0
- package/lib/core/tree/detachedFieldIndexCodecV2.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecs.d.ts +11 -0
- package/lib/core/tree/detachedFieldIndexCodecs.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexCodecs.js +21 -0
- package/lib/core/tree/detachedFieldIndexCodecs.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexFormatCommon.d.ts +37 -0
- package/lib/core/tree/detachedFieldIndexFormatCommon.d.ts.map +1 -0
- package/lib/core/tree/{detachedFieldIndexFormat.js → detachedFieldIndexFormatCommon.js} +13 -10
- package/lib/core/tree/detachedFieldIndexFormatCommon.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexFormatV1.d.ts +13 -0
- package/lib/core/tree/detachedFieldIndexFormatV1.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexFormatV1.js +9 -0
- package/lib/core/tree/detachedFieldIndexFormatV1.js.map +1 -0
- package/lib/core/tree/detachedFieldIndexFormatV2.d.ts +14 -0
- package/lib/core/tree/detachedFieldIndexFormatV2.d.ts.map +1 -0
- package/lib/core/tree/detachedFieldIndexFormatV2.js +11 -0
- package/lib/core/tree/detachedFieldIndexFormatV2.js.map +1 -0
- package/lib/feature-libraries/chunked-forest/codec/chunkDecoding.d.ts +9 -9
- package/lib/feature-libraries/chunked-forest/codec/chunkDecoding.d.ts.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/chunkDecoding.js +19 -19
- package/lib/feature-libraries/chunked-forest/codec/chunkDecoding.js.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.d.ts +4 -2
- package/lib/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.d.ts.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.js +4 -4
- package/lib/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.js.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/compressedEncode.d.ts +50 -31
- package/lib/feature-libraries/chunked-forest/codec/compressedEncode.d.ts.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/compressedEncode.js +70 -57
- package/lib/feature-libraries/chunked-forest/codec/compressedEncode.js.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/format.d.ts +20 -14
- package/lib/feature-libraries/chunked-forest/codec/format.d.ts.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/format.js +17 -11
- package/lib/feature-libraries/chunked-forest/codec/format.js.map +1 -1
- package/{dist/feature-libraries/chunked-forest/codec/nodeShape.d.ts → lib/feature-libraries/chunked-forest/codec/nodeEncoder.d.ts} +20 -14
- package/lib/feature-libraries/chunked-forest/codec/nodeEncoder.d.ts.map +1 -0
- package/lib/feature-libraries/chunked-forest/codec/{nodeShape.js → nodeEncoder.js} +21 -15
- package/lib/feature-libraries/chunked-forest/codec/nodeEncoder.js.map +1 -0
- package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncode.d.ts +7 -7
- package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncode.d.ts.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncode.js +19 -19
- package/lib/feature-libraries/chunked-forest/codec/schemaBasedEncode.js.map +1 -1
- package/lib/feature-libraries/chunked-forest/codec/uncompressedEncode.js +2 -2
- package/lib/feature-libraries/chunked-forest/codec/uncompressedEncode.js.map +1 -1
- package/lib/feature-libraries/default-schema/defaultFieldKinds.d.ts +5 -1
- package/lib/feature-libraries/default-schema/defaultFieldKinds.d.ts.map +1 -1
- package/lib/feature-libraries/default-schema/defaultFieldKinds.js +14 -2
- package/lib/feature-libraries/default-schema/defaultFieldKinds.js.map +1 -1
- package/lib/feature-libraries/default-schema/defaultSchema.d.ts.map +1 -1
- package/lib/feature-libraries/default-schema/defaultSchema.js +0 -2
- package/lib/feature-libraries/default-schema/defaultSchema.js.map +1 -1
- package/lib/feature-libraries/default-schema/index.d.ts +1 -1
- package/lib/feature-libraries/default-schema/index.d.ts.map +1 -1
- package/lib/feature-libraries/default-schema/index.js +1 -1
- package/lib/feature-libraries/default-schema/index.js.map +1 -1
- package/lib/feature-libraries/default-schema/schemaChecker.d.ts +14 -4
- package/lib/feature-libraries/default-schema/schemaChecker.d.ts.map +1 -1
- package/lib/feature-libraries/default-schema/schemaChecker.js +29 -24
- package/lib/feature-libraries/default-schema/schemaChecker.js.map +1 -1
- package/lib/feature-libraries/index.d.ts +1 -2
- package/lib/feature-libraries/index.d.ts.map +1 -1
- package/lib/feature-libraries/index.js +1 -2
- package/lib/feature-libraries/index.js.map +1 -1
- package/lib/feature-libraries/modular-schema/comparison.d.ts +5 -6
- package/lib/feature-libraries/modular-schema/comparison.d.ts.map +1 -1
- package/lib/feature-libraries/modular-schema/comparison.js +14 -14
- package/lib/feature-libraries/modular-schema/comparison.js.map +1 -1
- package/lib/feature-libraries/modular-schema/modularChangeFormat.d.ts +9 -3
- package/lib/feature-libraries/modular-schema/modularChangeFormat.d.ts.map +1 -1
- package/lib/feature-libraries/object-forest/objectForest.d.ts.map +1 -1
- package/lib/feature-libraries/object-forest/objectForest.js +3 -4
- package/lib/feature-libraries/object-forest/objectForest.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +2 -2
- package/lib/index.js.map +1 -1
- package/lib/packageVersion.d.ts +1 -1
- package/lib/packageVersion.js +1 -1
- package/lib/packageVersion.js.map +1 -1
- package/lib/shared-tree/independentView.d.ts +8 -0
- package/lib/shared-tree/independentView.d.ts.map +1 -1
- package/lib/shared-tree/independentView.js +21 -10
- package/lib/shared-tree/independentView.js.map +1 -1
- package/lib/shared-tree/schematizeTree.js +1 -1
- package/lib/shared-tree/schematizeTree.js.map +1 -1
- package/lib/shared-tree/schematizingTreeView.d.ts +0 -1
- package/lib/shared-tree/schematizingTreeView.d.ts.map +1 -1
- package/lib/shared-tree/schematizingTreeView.js +8 -11
- package/lib/shared-tree/schematizingTreeView.js.map +1 -1
- package/lib/shared-tree/sharedTree.d.ts.map +1 -1
- package/lib/shared-tree/sharedTree.js +2 -30
- package/lib/shared-tree/sharedTree.js.map +1 -1
- package/lib/shared-tree/treeAlpha.d.ts +20 -6
- package/lib/shared-tree/treeAlpha.d.ts.map +1 -1
- package/lib/shared-tree/treeAlpha.js +10 -5
- package/lib/shared-tree/treeAlpha.js.map +1 -1
- package/lib/shared-tree/treeCheckout.d.ts +2 -1
- package/lib/shared-tree/treeCheckout.d.ts.map +1 -1
- package/lib/shared-tree/treeCheckout.js +33 -1
- package/lib/shared-tree/treeCheckout.js.map +1 -1
- package/lib/shared-tree-core/branch.d.ts.map +1 -1
- package/lib/shared-tree-core/branch.js +1 -1
- package/lib/shared-tree-core/branch.js.map +1 -1
- package/lib/simple-tree/api/conciseTree.d.ts +2 -2
- package/lib/simple-tree/api/conciseTree.d.ts.map +1 -1
- package/lib/simple-tree/api/conciseTree.js +6 -6
- package/lib/simple-tree/api/conciseTree.js.map +1 -1
- package/lib/simple-tree/api/configuration.d.ts +8 -2
- package/lib/simple-tree/api/configuration.d.ts.map +1 -1
- package/lib/simple-tree/api/configuration.js.map +1 -1
- package/lib/simple-tree/api/create.d.ts +8 -7
- package/lib/simple-tree/api/create.d.ts.map +1 -1
- package/lib/simple-tree/api/create.js +38 -25
- package/lib/simple-tree/api/create.js.map +1 -1
- package/lib/simple-tree/api/customTree.d.ts +25 -4
- package/lib/simple-tree/api/customTree.d.ts.map +1 -1
- package/lib/simple-tree/api/customTree.js +43 -17
- package/lib/simple-tree/api/customTree.js.map +1 -1
- package/lib/simple-tree/api/discrepancies.d.ts +98 -0
- package/lib/simple-tree/api/discrepancies.d.ts.map +1 -0
- package/lib/simple-tree/{discrepancies.js → api/discrepancies.js} +80 -206
- package/lib/simple-tree/api/discrepancies.js.map +1 -0
- package/lib/simple-tree/api/schemaCompatibilityTester.d.ts +9 -7
- package/lib/simple-tree/api/schemaCompatibilityTester.d.ts.map +1 -1
- package/lib/simple-tree/api/schemaCompatibilityTester.js +19 -118
- package/lib/simple-tree/api/schemaCompatibilityTester.js.map +1 -1
- package/lib/simple-tree/api/schemaFactory.d.ts +7 -4
- package/lib/simple-tree/api/schemaFactory.d.ts.map +1 -1
- package/lib/simple-tree/api/schemaFactory.js.map +1 -1
- package/lib/simple-tree/api/storedSchema.d.ts.map +1 -1
- package/lib/simple-tree/api/storedSchema.js +6 -2
- package/lib/simple-tree/api/storedSchema.js.map +1 -1
- package/lib/simple-tree/api/treeBeta.d.ts +2 -2
- package/lib/simple-tree/api/treeBeta.d.ts.map +1 -1
- package/lib/simple-tree/api/treeBeta.js +8 -2
- package/lib/simple-tree/api/treeBeta.js.map +1 -1
- package/lib/simple-tree/api/verboseTree.d.ts +2 -2
- package/lib/simple-tree/api/verboseTree.d.ts.map +1 -1
- package/lib/simple-tree/api/verboseTree.js +9 -9
- package/lib/simple-tree/api/verboseTree.js.map +1 -1
- package/lib/simple-tree/core/allowedTypes.d.ts +20 -4
- package/lib/simple-tree/core/allowedTypes.d.ts.map +1 -1
- package/lib/simple-tree/core/allowedTypes.js +42 -12
- package/lib/simple-tree/core/allowedTypes.js.map +1 -1
- package/lib/simple-tree/core/context.d.ts +13 -2
- package/lib/simple-tree/core/context.d.ts.map +1 -1
- package/lib/simple-tree/core/context.js +22 -9
- package/lib/simple-tree/core/context.js.map +1 -1
- package/lib/simple-tree/core/index.d.ts +2 -2
- package/lib/simple-tree/core/index.d.ts.map +1 -1
- package/lib/simple-tree/core/index.js +2 -2
- package/lib/simple-tree/core/index.js.map +1 -1
- package/lib/simple-tree/core/treeNodeKernel.d.ts +1 -1
- package/lib/simple-tree/core/treeNodeKernel.js +1 -1
- package/lib/simple-tree/core/treeNodeKernel.js.map +1 -1
- package/lib/simple-tree/core/treeNodeValid.d.ts +1 -1
- package/lib/simple-tree/core/treeNodeValid.d.ts.map +1 -1
- package/lib/simple-tree/core/treeNodeValid.js +8 -1
- package/lib/simple-tree/core/treeNodeValid.js.map +1 -1
- package/lib/simple-tree/core/walkSchema.d.ts +3 -0
- package/lib/simple-tree/core/walkSchema.d.ts.map +1 -1
- package/lib/simple-tree/core/walkSchema.js +2 -0
- package/lib/simple-tree/core/walkSchema.js.map +1 -1
- package/lib/simple-tree/createContext.d.ts +2 -0
- package/lib/simple-tree/createContext.d.ts.map +1 -1
- package/lib/simple-tree/createContext.js +3 -1
- package/lib/simple-tree/createContext.js.map +1 -1
- package/lib/simple-tree/fieldSchema.d.ts +1 -0
- package/lib/simple-tree/fieldSchema.d.ts.map +1 -1
- package/lib/simple-tree/fieldSchema.js +1 -0
- package/lib/simple-tree/fieldSchema.js.map +1 -1
- package/lib/simple-tree/index.d.ts +4 -4
- package/lib/simple-tree/index.d.ts.map +1 -1
- package/lib/simple-tree/index.js +4 -4
- package/lib/simple-tree/index.js.map +1 -1
- package/lib/simple-tree/node-kinds/array/arrayNode.d.ts.map +1 -1
- package/lib/simple-tree/node-kinds/array/arrayNode.js +1 -1
- package/lib/simple-tree/node-kinds/array/arrayNode.js.map +1 -1
- package/lib/simple-tree/node-kinds/index.d.ts +1 -1
- package/lib/simple-tree/node-kinds/index.d.ts.map +1 -1
- package/lib/simple-tree/node-kinds/index.js +1 -1
- package/lib/simple-tree/node-kinds/index.js.map +1 -1
- package/lib/simple-tree/node-kinds/object/index.d.ts +1 -1
- package/lib/simple-tree/node-kinds/object/index.d.ts.map +1 -1
- package/lib/simple-tree/node-kinds/object/index.js +1 -1
- package/lib/simple-tree/node-kinds/object/index.js.map +1 -1
- package/lib/simple-tree/node-kinds/object/objectNode.d.ts +2 -7
- package/lib/simple-tree/node-kinds/object/objectNode.d.ts.map +1 -1
- package/lib/simple-tree/node-kinds/object/objectNode.js +3 -16
- package/lib/simple-tree/node-kinds/object/objectNode.js.map +1 -1
- package/lib/simple-tree/prepareForInsertion.d.ts +5 -5
- package/lib/simple-tree/prepareForInsertion.d.ts.map +1 -1
- package/lib/simple-tree/prepareForInsertion.js +11 -5
- package/lib/simple-tree/prepareForInsertion.js.map +1 -1
- package/lib/simple-tree/toStoredSchema.d.ts +3 -0
- package/lib/simple-tree/toStoredSchema.d.ts.map +1 -1
- package/lib/simple-tree/toStoredSchema.js +3 -0
- package/lib/simple-tree/toStoredSchema.js.map +1 -1
- package/lib/simple-tree/unhydratedFlexTreeFromInsertable.d.ts +2 -2
- package/lib/simple-tree/unhydratedFlexTreeFromInsertable.d.ts.map +1 -1
- package/lib/simple-tree/unhydratedFlexTreeFromInsertable.js +1 -1
- package/lib/simple-tree/unhydratedFlexTreeFromInsertable.js.map +1 -1
- package/lib/simple-tree/walkFieldSchema.d.ts +1 -0
- package/lib/simple-tree/walkFieldSchema.d.ts.map +1 -1
- package/lib/simple-tree/walkFieldSchema.js +1 -0
- package/lib/simple-tree/walkFieldSchema.js.map +1 -1
- package/package.json +23 -23
- package/src/codec/codec.ts +4 -3
- package/src/core/index.ts +2 -0
- package/src/core/rebase/index.ts +2 -0
- package/src/core/rebase/types.ts +4 -0
- package/src/core/schema-stored/schema.ts +2 -26
- package/src/core/tree/detachedFieldIndex.ts +4 -6
- package/src/core/tree/detachedFieldIndexCodecCommon.ts +87 -0
- package/src/core/tree/{detachedFieldIndexCodec.ts → detachedFieldIndexCodecV1.ts} +22 -68
- package/src/core/tree/detachedFieldIndexCodecV2.ts +72 -0
- package/src/core/tree/detachedFieldIndexCodecs.ts +44 -0
- package/src/core/tree/{detachedFieldIndexFormat.ts → detachedFieldIndexFormatCommon.ts} +32 -23
- package/src/core/tree/detachedFieldIndexFormatV1.ts +15 -0
- package/src/core/tree/detachedFieldIndexFormatV2.ts +17 -0
- package/src/feature-libraries/chunked-forest/codec/README.md +1 -1
- package/src/feature-libraries/chunked-forest/codec/chunkDecoding.ts +25 -25
- package/src/feature-libraries/chunked-forest/codec/chunkDecodingGeneric.ts +10 -6
- package/src/feature-libraries/chunked-forest/codec/compressedEncode.ts +96 -73
- package/src/feature-libraries/chunked-forest/codec/format.ts +20 -14
- package/src/feature-libraries/chunked-forest/codec/{nodeShape.ts → nodeEncoder.ts} +23 -17
- package/src/feature-libraries/chunked-forest/codec/schemaBasedEncode.ts +34 -34
- package/src/feature-libraries/chunked-forest/codec/uncompressedEncode.ts +5 -5
- package/src/feature-libraries/default-schema/defaultFieldKinds.ts +10 -0
- package/src/feature-libraries/default-schema/defaultSchema.ts +0 -2
- package/src/feature-libraries/default-schema/index.ts +1 -1
- package/src/feature-libraries/default-schema/schemaChecker.ts +47 -30
- package/src/feature-libraries/index.ts +1 -3
- package/src/feature-libraries/modular-schema/comparison.ts +14 -29
- package/src/feature-libraries/object-forest/objectForest.ts +10 -6
- package/src/index.ts +5 -0
- package/src/packageVersion.ts +1 -1
- package/src/shared-tree/independentView.ts +45 -19
- package/src/shared-tree/schematizeTree.ts +1 -1
- package/src/shared-tree/schematizingTreeView.ts +16 -13
- package/src/shared-tree/sharedTree.ts +2 -42
- package/src/shared-tree/treeAlpha.ts +30 -18
- package/src/shared-tree/treeCheckout.ts +54 -10
- package/src/shared-tree-core/branch.ts +1 -6
- package/src/simple-tree/api/conciseTree.ts +9 -7
- package/src/simple-tree/api/configuration.ts +8 -2
- package/src/simple-tree/api/create.ts +49 -36
- package/src/simple-tree/api/customTree.ts +59 -20
- package/src/simple-tree/{discrepancies.ts → api/discrepancies.ts} +128 -303
- package/src/simple-tree/api/schemaCompatibilityTester.ts +27 -151
- package/src/simple-tree/api/schemaFactory.ts +7 -4
- package/src/simple-tree/api/storedSchema.ts +6 -9
- package/src/simple-tree/api/treeBeta.ts +17 -4
- package/src/simple-tree/api/verboseTree.ts +17 -8
- package/src/simple-tree/core/allowedTypes.ts +54 -21
- package/src/simple-tree/core/context.ts +24 -22
- package/src/simple-tree/core/index.ts +2 -1
- package/src/simple-tree/core/treeNodeKernel.ts +1 -1
- package/src/simple-tree/core/treeNodeValid.ts +9 -2
- package/src/simple-tree/core/walkSchema.ts +3 -0
- package/src/simple-tree/createContext.ts +6 -1
- package/src/simple-tree/fieldSchema.ts +1 -0
- package/src/simple-tree/index.ts +5 -10
- package/src/simple-tree/node-kinds/array/arrayNode.ts +32 -19
- package/src/simple-tree/node-kinds/index.ts +0 -1
- package/src/simple-tree/node-kinds/object/index.ts +0 -1
- package/src/simple-tree/node-kinds/object/objectNode.ts +9 -27
- package/src/simple-tree/prepareForInsertion.ts +17 -9
- package/src/simple-tree/toStoredSchema.ts +3 -0
- package/src/simple-tree/unhydratedFlexTreeFromInsertable.ts +6 -2
- package/src/simple-tree/walkFieldSchema.ts +1 -0
- package/dist/core/tree/detachedFieldIndexCodec.d.ts +0 -11
- package/dist/core/tree/detachedFieldIndexCodec.d.ts.map +0 -1
- package/dist/core/tree/detachedFieldIndexCodec.js +0 -100
- package/dist/core/tree/detachedFieldIndexCodec.js.map +0 -1
- package/dist/core/tree/detachedFieldIndexFormat.d.ts +0 -33
- package/dist/core/tree/detachedFieldIndexFormat.d.ts.map +0 -1
- package/dist/core/tree/detachedFieldIndexFormat.js.map +0 -1
- package/dist/feature-libraries/chunked-forest/codec/nodeShape.d.ts.map +0 -1
- package/dist/feature-libraries/chunked-forest/codec/nodeShape.js.map +0 -1
- package/dist/feature-libraries/initializeForest.d.ts +0 -18
- package/dist/feature-libraries/initializeForest.d.ts.map +0 -1
- package/dist/feature-libraries/initializeForest.js +0 -35
- package/dist/feature-libraries/initializeForest.js.map +0 -1
- package/dist/simple-tree/discrepancies.d.ts +0 -167
- package/dist/simple-tree/discrepancies.d.ts.map +0 -1
- package/dist/simple-tree/discrepancies.js +0 -382
- package/dist/simple-tree/discrepancies.js.map +0 -1
- package/lib/core/tree/detachedFieldIndexCodec.d.ts +0 -11
- package/lib/core/tree/detachedFieldIndexCodec.d.ts.map +0 -1
- package/lib/core/tree/detachedFieldIndexCodec.js +0 -96
- package/lib/core/tree/detachedFieldIndexCodec.js.map +0 -1
- package/lib/core/tree/detachedFieldIndexFormat.d.ts +0 -33
- package/lib/core/tree/detachedFieldIndexFormat.d.ts.map +0 -1
- package/lib/core/tree/detachedFieldIndexFormat.js.map +0 -1
- package/lib/feature-libraries/chunked-forest/codec/nodeShape.d.ts.map +0 -1
- package/lib/feature-libraries/chunked-forest/codec/nodeShape.js.map +0 -1
- package/lib/feature-libraries/initializeForest.d.ts +0 -18
- package/lib/feature-libraries/initializeForest.d.ts.map +0 -1
- package/lib/feature-libraries/initializeForest.js +0 -31
- package/lib/feature-libraries/initializeForest.js.map +0 -1
- package/lib/simple-tree/discrepancies.d.ts +0 -167
- package/lib/simple-tree/discrepancies.d.ts.map +0 -1
- package/lib/simple-tree/discrepancies.js.map +0 -1
- package/src/feature-libraries/initializeForest.ts +0 -55
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import type { IIdCompressor } from "@fluidframework/id-compressor";
|
|
6
|
-
import { type IEditableForest, type ITreeCursorSynchronous, type RevisionTagCodec } from "../core/index.js";
|
|
7
|
-
/**
|
|
8
|
-
* Initializes the given forest with the given content.
|
|
9
|
-
* @remarks The forest must be empty when this function is called.
|
|
10
|
-
* This does not perform an edit in the typical sense.
|
|
11
|
-
* Instead, it creates a delta expressing a creation and insertion of the `content` under the {@link rootFieldKey}, and then applies the delta to the forest.
|
|
12
|
-
* If `visitAnchors` is enabled, then the delta will also be applied to the forest's {@link AnchorSet} (in which case there must be no existing anchors when this function is called).
|
|
13
|
-
*
|
|
14
|
-
* @remarks
|
|
15
|
-
* This does not perform an edit: it updates the forest content as if there was an edit that did that.
|
|
16
|
-
*/
|
|
17
|
-
export declare function initializeForest(forest: IEditableForest, content: ITreeCursorSynchronous, revisionTagCodec: RevisionTagCodec, idCompressor: IIdCompressor, visitAnchors?: boolean): void;
|
|
18
|
-
//# sourceMappingURL=initializeForest.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"initializeForest.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/initializeForest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAA4B,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE7F,OAAO,EAEN,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EAKrB,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,sBAAsB,EAC/B,gBAAgB,EAAE,gBAAgB,EAClC,YAAY,EAAE,aAAa,EAC3B,YAAY,UAAQ,GAClB,IAAI,CAmBN"}
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*!
|
|
3
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
4
|
-
* Licensed under the MIT License.
|
|
5
|
-
*/
|
|
6
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.initializeForest = void 0;
|
|
8
|
-
const internal_1 = require("@fluidframework/core-utils/internal");
|
|
9
|
-
const index_js_1 = require("../core/index.js");
|
|
10
|
-
/**
|
|
11
|
-
* Initializes the given forest with the given content.
|
|
12
|
-
* @remarks The forest must be empty when this function is called.
|
|
13
|
-
* This does not perform an edit in the typical sense.
|
|
14
|
-
* Instead, it creates a delta expressing a creation and insertion of the `content` under the {@link rootFieldKey}, and then applies the delta to the forest.
|
|
15
|
-
* If `visitAnchors` is enabled, then the delta will also be applied to the forest's {@link AnchorSet} (in which case there must be no existing anchors when this function is called).
|
|
16
|
-
*
|
|
17
|
-
* @remarks
|
|
18
|
-
* This does not perform an edit: it updates the forest content as if there was an edit that did that.
|
|
19
|
-
*/
|
|
20
|
-
function initializeForest(forest, content, revisionTagCodec, idCompressor, visitAnchors = false) {
|
|
21
|
-
(0, internal_1.assert)(forest.isEmpty, 0x747 /* forest must be empty */);
|
|
22
|
-
const delta = (0, index_js_1.deltaForRootInitialization)(forest.chunkField(content));
|
|
23
|
-
let visitor = forest.acquireVisitor();
|
|
24
|
-
if (visitAnchors) {
|
|
25
|
-
(0, internal_1.assert)(forest.anchors.isEmpty(), 0x9b7 /* anchor set must be empty */);
|
|
26
|
-
const anchorVisitor = forest.anchors.acquireVisitor();
|
|
27
|
-
visitor = (0, index_js_1.combineVisitors)([visitor, anchorVisitor]);
|
|
28
|
-
}
|
|
29
|
-
// any detached trees built here are immediately attached so the revision used here doesn't matter
|
|
30
|
-
// we use a dummy revision to make correctness checks in the detached field index easier
|
|
31
|
-
(0, index_js_1.visitDelta)(delta, visitor, (0, index_js_1.makeDetachedFieldIndex)("init", revisionTagCodec, idCompressor), 0);
|
|
32
|
-
visitor.free();
|
|
33
|
-
}
|
|
34
|
-
exports.initializeForest = initializeForest;
|
|
35
|
-
//# sourceMappingURL=initializeForest.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"initializeForest.js","sourceRoot":"","sources":["../../src/feature-libraries/initializeForest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAG7D,+CAS0B;AAE1B;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAC/B,MAAuB,EACvB,OAA+B,EAC/B,gBAAkC,EAClC,YAA2B,EAC3B,YAAY,GAAG,KAAK;IAEpB,IAAA,iBAAM,EAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IACzD,MAAM,KAAK,GAAc,IAAA,qCAA0B,EAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAChF,IAAI,OAAO,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;IACtC,IAAI,YAAY,EAAE,CAAC;QAClB,IAAA,iBAAM,EAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACvE,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACtD,OAAO,GAAG,IAAA,0BAAe,EAAC,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,kGAAkG;IAClG,wFAAwF;IACxF,IAAA,qBAAU,EACT,KAAK,EACL,OAAO,EACP,IAAA,iCAAsB,EAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,CAAC,EAC9D,CAA6B,CAC7B,CAAC;IACF,OAAO,CAAC,IAAI,EAAE,CAAC;AAChB,CAAC;AAzBD,4CAyBC","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 type { SessionSpaceCompressedId, IIdCompressor } from \"@fluidframework/id-compressor\";\n\nimport {\n\ttype DeltaRoot,\n\ttype IEditableForest,\n\ttype ITreeCursorSynchronous,\n\ttype RevisionTagCodec,\n\tcombineVisitors,\n\tdeltaForRootInitialization,\n\tmakeDetachedFieldIndex,\n\tvisitDelta,\n} from \"../core/index.js\";\n\n/**\n * Initializes the given forest with the given content.\n * @remarks The forest must be empty when this function is called.\n * This does not perform an edit in the typical sense.\n * Instead, it creates a delta expressing a creation and insertion of the `content` under the {@link rootFieldKey}, and then applies the delta to the forest.\n * If `visitAnchors` is enabled, then the delta will also be applied to the forest's {@link AnchorSet} (in which case there must be no existing anchors when this function is called).\n *\n * @remarks\n * This does not perform an edit: it updates the forest content as if there was an edit that did that.\n */\nexport function initializeForest(\n\tforest: IEditableForest,\n\tcontent: ITreeCursorSynchronous,\n\trevisionTagCodec: RevisionTagCodec,\n\tidCompressor: IIdCompressor,\n\tvisitAnchors = false,\n): void {\n\tassert(forest.isEmpty, 0x747 /* forest must be empty */);\n\tconst delta: DeltaRoot = deltaForRootInitialization(forest.chunkField(content));\n\tlet visitor = forest.acquireVisitor();\n\tif (visitAnchors) {\n\t\tassert(forest.anchors.isEmpty(), 0x9b7 /* anchor set must be empty */);\n\t\tconst anchorVisitor = forest.anchors.acquireVisitor();\n\t\tvisitor = combineVisitors([visitor, anchorVisitor]);\n\t}\n\n\t// any detached trees built here are immediately attached so the revision used here doesn't matter\n\t// we use a dummy revision to make correctness checks in the detached field index easier\n\tvisitDelta(\n\t\tdelta,\n\t\tvisitor,\n\t\tmakeDetachedFieldIndex(\"init\", revisionTagCodec, idCompressor),\n\t\t0 as SessionSpaceCompressedId,\n\t);\n\tvisitor.free();\n}\n"]}
|
|
@@ -1,167 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
-
* Licensed under the MIT License.
|
|
4
|
-
*/
|
|
5
|
-
import { type FieldKey, type FieldKindIdentifier, LeafNodeStoredSchema, MapNodeStoredSchema, ObjectNodeStoredSchema, type TreeNodeSchemaIdentifier, type TreeStoredSchema, type TreeTypeSet, type ValueSchema } from "../core/index.js";
|
|
6
|
-
import { type AnnotatedAllowedType, type TreeNodeSchema } from "./core/index.js";
|
|
7
|
-
import { type FieldSchema } from "./fieldSchema.js";
|
|
8
|
-
/**
|
|
9
|
-
* Discriminated union (keyed on `mismatch`) of discrepancies between a view and stored schema.
|
|
10
|
-
* @remarks
|
|
11
|
-
*
|
|
12
|
-
* 1. FieldDiscrepancy
|
|
13
|
-
*
|
|
14
|
-
* `FieldDiscrepancy` represents the differences between two `TreeFieldStoredSchema` objects. It consists of
|
|
15
|
-
* three types of incompatibilities:
|
|
16
|
-
*
|
|
17
|
-
* - FieldKindDiscrepancy: Indicates the differences in `FieldKindIdentifier` between two `TreeFieldStoredSchema`
|
|
18
|
-
* objects (e.g., optional, required, sequence, etc.).
|
|
19
|
-
* - AllowedTypesDiscrepancy: Indicates the differences in the allowed child types between the two schemas.
|
|
20
|
-
* - ValueSchemaDiscrepancy: Specifically indicates the differences in the `ValueSchema` of two
|
|
21
|
-
* `LeafNodeStoredSchema` objects.
|
|
22
|
-
*
|
|
23
|
-
* 2. NodeDiscrepancy
|
|
24
|
-
*
|
|
25
|
-
* `NodeDiscrepancy` represents the differences between two `TreeNodeStoredSchema` objects and includes:
|
|
26
|
-
*
|
|
27
|
-
* - NodeKindDiscrepancy: Indicates the differences in the types of `TreeNodeStoredSchema` (currently supports
|
|
28
|
-
* `ObjectNodeStoredSchema`, `MapNodeStoredSchema`, and `LeafNodeStoredSchema`).
|
|
29
|
-
* - NodeFieldsDiscrepancy: Indicates the `FieldDiscrepancy` of `TreeFieldStoredSchema` within two
|
|
30
|
-
* `TreeNodeStoredSchema`. It includes an array of `FieldDiscrepancy` instances in the `differences` field.
|
|
31
|
-
*
|
|
32
|
-
* When comparing two nodes for compatibility, it only makes sense to compare their fields if the nodes are of
|
|
33
|
-
* the same kind (map, object, leaf).
|
|
34
|
-
*
|
|
35
|
-
* 3. Discrepancy
|
|
36
|
-
*
|
|
37
|
-
* Discrepancy consists of both `NodeDiscrepancy` and `FieldDiscrepancy`, representing any kind of
|
|
38
|
-
* schema differences. See {@link getAllowedContentDiscrepancies} for more details about how we process it
|
|
39
|
-
* and the ordering.
|
|
40
|
-
*/
|
|
41
|
-
export type Discrepancy = FieldDiscrepancy | NodeDiscrepancy;
|
|
42
|
-
export type NodeDiscrepancy = NodeKindDiscrepancy | NodeFieldsDiscrepancy;
|
|
43
|
-
/**
|
|
44
|
-
* A discrepancy in the declaration of a field.
|
|
45
|
-
*/
|
|
46
|
-
export type FieldDiscrepancy = AllowedTypeDiscrepancy | FieldKindDiscrepancy | ValueSchemaDiscrepancy;
|
|
47
|
-
/**
|
|
48
|
-
* Information about where a field discrepancy is located within a collection of schema.
|
|
49
|
-
*/
|
|
50
|
-
export interface FieldDiscrepancyLocation {
|
|
51
|
-
/**
|
|
52
|
-
* The {@link TreeNodeSchemaIdentifier} that contains the discrepancy.
|
|
53
|
-
*
|
|
54
|
-
* Undefined iff the discrepancy is part of the root field schema.
|
|
55
|
-
*/
|
|
56
|
-
readonly identifier: TreeNodeSchemaIdentifier | undefined;
|
|
57
|
-
/**
|
|
58
|
-
* The {@link FieldKey} for the field that contains the discrepancy.
|
|
59
|
-
* Undefined when:
|
|
60
|
-
* - the discrepancy is part of the root field schema
|
|
61
|
-
* - the discrepancy is for 'all fields' of a map node
|
|
62
|
-
*/
|
|
63
|
-
readonly fieldKey: FieldKey | undefined;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* A discrepancy in the allowed types of a field.
|
|
67
|
-
*
|
|
68
|
-
* @remarks
|
|
69
|
-
* This reports the symmetric difference of allowed types in view/stored to enable more efficient checks for compatibility
|
|
70
|
-
*/
|
|
71
|
-
export interface AllowedTypeDiscrepancy extends FieldDiscrepancyLocation {
|
|
72
|
-
readonly mismatch: "allowedTypes";
|
|
73
|
-
/**
|
|
74
|
-
* List of annotated allowed types in viewed schema which are not allowed in stored schema
|
|
75
|
-
*/
|
|
76
|
-
readonly view: readonly AnnotatedAllowedType<TreeNodeSchema>[];
|
|
77
|
-
/**
|
|
78
|
-
* List of allowed type identifiers in stored schema which are not allowed in view schema
|
|
79
|
-
*/
|
|
80
|
-
readonly stored: readonly TreeNodeSchemaIdentifier[];
|
|
81
|
-
}
|
|
82
|
-
export interface FieldKindDiscrepancy extends FieldDiscrepancyLocation {
|
|
83
|
-
readonly mismatch: "fieldKind";
|
|
84
|
-
readonly view: FieldKindIdentifier;
|
|
85
|
-
readonly stored: FieldKindIdentifier;
|
|
86
|
-
}
|
|
87
|
-
export interface ValueSchemaDiscrepancy {
|
|
88
|
-
identifier: TreeNodeSchemaIdentifier;
|
|
89
|
-
mismatch: "valueSchema";
|
|
90
|
-
view: ValueSchema | undefined;
|
|
91
|
-
stored: ValueSchema | undefined;
|
|
92
|
-
}
|
|
93
|
-
export interface NodeKindDiscrepancy {
|
|
94
|
-
identifier: TreeNodeSchemaIdentifier;
|
|
95
|
-
mismatch: "nodeKind";
|
|
96
|
-
view: SchemaFactoryNodeKind | undefined;
|
|
97
|
-
stored: SchemaFactoryNodeKind | undefined;
|
|
98
|
-
}
|
|
99
|
-
export interface NodeFieldsDiscrepancy {
|
|
100
|
-
identifier: TreeNodeSchemaIdentifier;
|
|
101
|
-
mismatch: "fields";
|
|
102
|
-
differences: FieldDiscrepancy[];
|
|
103
|
-
}
|
|
104
|
-
type SchemaFactoryNodeKind = typeof ObjectNodeStoredSchema | typeof MapNodeStoredSchema | typeof LeafNodeStoredSchema;
|
|
105
|
-
/**
|
|
106
|
-
* Finds and reports discrepancies between a view schema and a stored schema.
|
|
107
|
-
*
|
|
108
|
-
* See documentation on {@link Discrepancy} for details of possible discrepancies.
|
|
109
|
-
* @remarks
|
|
110
|
-
* This function does not attempt to distinguish between equivalent representations of a node/field involving extraneous never trees.
|
|
111
|
-
* For example, a Forbidden field with allowed type set `[]` is equivalent to an optional field with allowed type set `[]`,
|
|
112
|
-
* as well as an optional field with an allowed type set containing only unconstructable types.
|
|
113
|
-
*
|
|
114
|
-
* It is up to the caller to determine whether such discrepancies matter.
|
|
115
|
-
*/
|
|
116
|
-
export declare function getAllowedContentDiscrepancies(view: FieldSchema, stored: TreeStoredSchema): Iterable<Discrepancy>;
|
|
117
|
-
/**
|
|
118
|
-
* Returns the allowed types that are not present in both the given view and stored schemas.
|
|
119
|
-
* It returns a tuple containing two arrays:
|
|
120
|
-
* 1. The first array contains the allowed types that are present in the view schema but not in the stored schema.
|
|
121
|
-
* 2. The second array contains the allowed types that are present in the stored schema but not in the view schema.
|
|
122
|
-
*/
|
|
123
|
-
export declare function findExtraAllowedTypes(viewAllowedTypes: readonly AnnotatedAllowedType<TreeNodeSchema>[], storedAllowedTypes: TreeTypeSet): [readonly AnnotatedAllowedType<TreeNodeSchema>[], TreeNodeSchemaIdentifier[]];
|
|
124
|
-
/**
|
|
125
|
-
* A linear extension of a partially-ordered set of `T`s. See:
|
|
126
|
-
* https://en.wikipedia.org/wiki/Linear_extension
|
|
127
|
-
*
|
|
128
|
-
* The linear extension is represented as a lookup from each poset element to its index in the linear extension.
|
|
129
|
-
*/
|
|
130
|
-
export type LinearExtension<T> = Map<T, number>;
|
|
131
|
-
/**
|
|
132
|
-
* A realizer for a partially-ordered set. See:
|
|
133
|
-
* https://en.wikipedia.org/wiki/Order_dimension
|
|
134
|
-
*/
|
|
135
|
-
export type Realizer<T> = LinearExtension<T>[];
|
|
136
|
-
/**
|
|
137
|
-
* A realizer for the partial order of field kind relaxability.
|
|
138
|
-
*
|
|
139
|
-
* It seems extremely likely that this partial order will remain dimension 2 over time (i.e. the set of allowed relaxations can be visualized
|
|
140
|
-
* with a [dominance drawing](https://en.wikipedia.org/wiki/Dominance_drawing)), so this strategy allows efficient comarison between field kinds
|
|
141
|
-
* without excessive casework.
|
|
142
|
-
*
|
|
143
|
-
* Hasse diagram for the partial order is shown below (lower fields can be relaxed to higher fields):
|
|
144
|
-
* ```
|
|
145
|
-
* sequence
|
|
146
|
-
* |
|
|
147
|
-
* optional
|
|
148
|
-
* | \
|
|
149
|
-
* required forbidden
|
|
150
|
-
* |
|
|
151
|
-
* identifier
|
|
152
|
-
* ```
|
|
153
|
-
*/
|
|
154
|
-
export declare const fieldRealizer: Realizer<FieldKindIdentifier>;
|
|
155
|
-
export declare const PosetComparisonResult: {
|
|
156
|
-
readonly Less: "<";
|
|
157
|
-
readonly Greater: ">";
|
|
158
|
-
readonly Equal: "=";
|
|
159
|
-
readonly Incomparable: "||";
|
|
160
|
-
};
|
|
161
|
-
type PosetComparisonResult = (typeof PosetComparisonResult)[keyof typeof PosetComparisonResult];
|
|
162
|
-
/**
|
|
163
|
-
* TODO: This is used by SchemaCompatibilityTester, revisit it during redesign and document
|
|
164
|
-
*/
|
|
165
|
-
export declare function comparePosetElements<T>(a: T, b: T, realizer: Realizer<T>): PosetComparisonResult;
|
|
166
|
-
export {};
|
|
167
|
-
//# sourceMappingURL=discrepancies.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"discrepancies.d.ts","sourceRoot":"","sources":["../../src/simple-tree/discrepancies.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAEN,KAAK,QAAQ,EACb,KAAK,mBAAmB,EAExB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAGtB,KAAK,wBAAwB,EAE7B,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAY,KAAK,oBAAoB,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAU3F,OAAO,EAIN,KAAK,WAAW,EAChB,MAAM,kBAAkB,CAAC;AAG1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAE7D,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,qBAAqB,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACzB,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC1D;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACvE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC;IAC/D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,wBAAwB,EAAE,CAAC;CACrD;AAED,MAAM,WAAW,oBAAqB,SAAQ,wBAAwB;IACrE,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACrC;AAED,MAAM,WAAW,sBAAsB;IACtC,UAAU,EAAE,wBAAwB,CAAC;IACrC,QAAQ,EAAE,aAAa,CAAC;IACxB,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IACnC,UAAU,EAAE,wBAAwB,CAAC;IACrC,QAAQ,EAAE,UAAU,CAAC;IACrB,IAAI,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACxC,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAqB;IACrC,UAAU,EAAE,wBAAwB,CAAC;IACrC,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAED,KAAK,qBAAqB,GACvB,OAAO,sBAAsB,GAC7B,OAAO,mBAAmB,GAC1B,OAAO,oBAAoB,CAAC;AAmD/B;;;;;;;;;;GAUG;AACH,wBAAiB,8BAA8B,CAC9C,IAAI,EAAE,WAAW,EACjB,MAAM,EAAE,gBAAgB,GACtB,QAAQ,CAAC,WAAW,CAAC,CA4CvB;AAyHD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACpC,gBAAgB,EAAE,SAAS,oBAAoB,CAAC,cAAc,CAAC,EAAE,EACjE,kBAAkB,EAAE,WAAW,GAC7B,CAAC,SAAS,oBAAoB,CAAC,cAAc,CAAC,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAW/E;AA2ID;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;AAgB/C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,mBAAmB,CAegC,CAAC;AAEzF,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AACX,KAAK,qBAAqB,GACzB,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACrC,CAAC,EAAE,CAAC,EACJ,CAAC,EAAE,CAAC,EACJ,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GACnB,qBAAqB,CAqBvB"}
|
|
@@ -1,382 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*!
|
|
3
|
-
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
4
|
-
* Licensed under the MIT License.
|
|
5
|
-
*/
|
|
6
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.comparePosetElements = exports.PosetComparisonResult = exports.fieldRealizer = exports.findExtraAllowedTypes = exports.getAllowedContentDiscrepancies = void 0;
|
|
8
|
-
const internal_1 = require("@fluidframework/core-utils/internal");
|
|
9
|
-
const index_js_1 = require("../core/index.js");
|
|
10
|
-
const index_js_2 = require("../util/index.js");
|
|
11
|
-
const index_js_3 = require("./core/index.js");
|
|
12
|
-
const index_js_4 = require("./node-kinds/index.js");
|
|
13
|
-
const toStoredSchema_js_1 = require("./toStoredSchema.js");
|
|
14
|
-
const walkFieldSchema_js_1 = require("./walkFieldSchema.js");
|
|
15
|
-
const fieldSchema_js_1 = require("./fieldSchema.js");
|
|
16
|
-
const leafNodeSchema_js_1 = require("./leafNodeSchema.js");
|
|
17
|
-
function getStoredNodeSchemaType(nodeSchema) {
|
|
18
|
-
if (nodeSchema instanceof index_js_1.ObjectNodeStoredSchema) {
|
|
19
|
-
return index_js_1.ObjectNodeStoredSchema;
|
|
20
|
-
}
|
|
21
|
-
if (nodeSchema instanceof index_js_1.MapNodeStoredSchema) {
|
|
22
|
-
return index_js_1.MapNodeStoredSchema;
|
|
23
|
-
}
|
|
24
|
-
if (nodeSchema instanceof index_js_1.LeafNodeStoredSchema) {
|
|
25
|
-
return index_js_1.LeafNodeStoredSchema;
|
|
26
|
-
}
|
|
27
|
-
(0, internal_1.fail)(0xbe8 /* Invalid stored node schema type */);
|
|
28
|
-
}
|
|
29
|
-
function doesNodeKindMatchStoredNodeKind(viewKind, storedType) {
|
|
30
|
-
switch (viewKind) {
|
|
31
|
-
case index_js_3.NodeKind.Leaf:
|
|
32
|
-
return storedType === index_js_1.LeafNodeStoredSchema;
|
|
33
|
-
case index_js_3.NodeKind.Array:
|
|
34
|
-
case index_js_3.NodeKind.Object:
|
|
35
|
-
return storedType === index_js_1.ObjectNodeStoredSchema;
|
|
36
|
-
case index_js_3.NodeKind.Map:
|
|
37
|
-
case index_js_3.NodeKind.Record:
|
|
38
|
-
return storedType === index_js_1.MapNodeStoredSchema;
|
|
39
|
-
default:
|
|
40
|
-
(0, internal_1.unreachableCase)(viewKind);
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
function getViewNodeSchemaType(schema) {
|
|
44
|
-
switch (schema.kind) {
|
|
45
|
-
case index_js_3.NodeKind.Leaf: {
|
|
46
|
-
return index_js_1.LeafNodeStoredSchema;
|
|
47
|
-
}
|
|
48
|
-
case index_js_3.NodeKind.Map:
|
|
49
|
-
case index_js_3.NodeKind.Record: {
|
|
50
|
-
return index_js_1.MapNodeStoredSchema;
|
|
51
|
-
}
|
|
52
|
-
case index_js_3.NodeKind.Object:
|
|
53
|
-
case index_js_3.NodeKind.Array: {
|
|
54
|
-
return index_js_1.ObjectNodeStoredSchema;
|
|
55
|
-
}
|
|
56
|
-
default:
|
|
57
|
-
(0, internal_1.unreachableCase)(schema.kind);
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* Finds and reports discrepancies between a view schema and a stored schema.
|
|
62
|
-
*
|
|
63
|
-
* See documentation on {@link Discrepancy} for details of possible discrepancies.
|
|
64
|
-
* @remarks
|
|
65
|
-
* This function does not attempt to distinguish between equivalent representations of a node/field involving extraneous never trees.
|
|
66
|
-
* For example, a Forbidden field with allowed type set `[]` is equivalent to an optional field with allowed type set `[]`,
|
|
67
|
-
* as well as an optional field with an allowed type set containing only unconstructable types.
|
|
68
|
-
*
|
|
69
|
-
* It is up to the caller to determine whether such discrepancies matter.
|
|
70
|
-
*/
|
|
71
|
-
function* getAllowedContentDiscrepancies(view, stored) {
|
|
72
|
-
// check root schema discrepancies
|
|
73
|
-
yield* getFieldDiscrepancies(view, stored.rootFieldSchema, undefined, undefined);
|
|
74
|
-
const viewNodeSchema = new Map();
|
|
75
|
-
(0, walkFieldSchema_js_1.walkFieldSchema)(view, {
|
|
76
|
-
node: (schema) => {
|
|
77
|
-
const identifier = (0, index_js_2.brand)(schema.identifier);
|
|
78
|
-
(0, internal_1.debugAssert)(() => !viewNodeSchema.has(identifier));
|
|
79
|
-
viewNodeSchema.set(identifier, schema);
|
|
80
|
-
},
|
|
81
|
-
});
|
|
82
|
-
for (const [identifier, viewSchema] of viewNodeSchema) {
|
|
83
|
-
const storedSchema = stored.nodeSchema.get(identifier);
|
|
84
|
-
// if the view schema has a node that's not in the stored schema
|
|
85
|
-
if (storedSchema === undefined) {
|
|
86
|
-
const viewType = getViewNodeSchemaType(viewSchema);
|
|
87
|
-
// TODO does it make sense to have this mismatch when there will also be an allowedTypes mismatch?
|
|
88
|
-
yield {
|
|
89
|
-
identifier,
|
|
90
|
-
mismatch: "nodeKind",
|
|
91
|
-
view: viewType,
|
|
92
|
-
stored: undefined,
|
|
93
|
-
};
|
|
94
|
-
}
|
|
95
|
-
else {
|
|
96
|
-
yield* getNodeDiscrepancies(identifier, viewSchema, storedSchema);
|
|
97
|
-
}
|
|
98
|
-
}
|
|
99
|
-
for (const [identifier, storedSchema] of stored.nodeSchema) {
|
|
100
|
-
if (!viewNodeSchema.has(identifier)) {
|
|
101
|
-
const storedType = getStoredNodeSchemaType(storedSchema);
|
|
102
|
-
yield {
|
|
103
|
-
identifier,
|
|
104
|
-
mismatch: "nodeKind",
|
|
105
|
-
view: undefined,
|
|
106
|
-
stored: storedType,
|
|
107
|
-
};
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
exports.getAllowedContentDiscrepancies = getAllowedContentDiscrepancies;
|
|
112
|
-
function* getNodeDiscrepancies(identifier, view, stored) {
|
|
113
|
-
if (!doesNodeKindMatchStoredNodeKind(view.kind, getStoredNodeSchemaType(stored))) {
|
|
114
|
-
yield {
|
|
115
|
-
identifier,
|
|
116
|
-
mismatch: "nodeKind",
|
|
117
|
-
view: getViewNodeSchemaType(view),
|
|
118
|
-
stored: getStoredNodeSchemaType(stored),
|
|
119
|
-
};
|
|
120
|
-
return;
|
|
121
|
-
}
|
|
122
|
-
switch (view.kind) {
|
|
123
|
-
case index_js_3.NodeKind.Object: {
|
|
124
|
-
(0, internal_1.assert)((0, index_js_4.isObjectNodeSchema)(view), 0xbe9 /* schema with node kind of object must implement ObjectNodeSchema */);
|
|
125
|
-
const fields = view.flexKeyMap;
|
|
126
|
-
const differences = Array.from(computeObjectNodeDiscrepancies(identifier, fields, stored));
|
|
127
|
-
if (differences.length > 0) {
|
|
128
|
-
yield {
|
|
129
|
-
identifier,
|
|
130
|
-
mismatch: "fields",
|
|
131
|
-
differences,
|
|
132
|
-
};
|
|
133
|
-
}
|
|
134
|
-
break;
|
|
135
|
-
}
|
|
136
|
-
case index_js_3.NodeKind.Array: {
|
|
137
|
-
(0, internal_1.assert)((0, index_js_4.isArrayNodeSchema)(view), 0xbea /* schema with node kind of array must implement ArrayNodeSchema */);
|
|
138
|
-
const fields = new Map([
|
|
139
|
-
[
|
|
140
|
-
index_js_1.EmptyKey,
|
|
141
|
-
{
|
|
142
|
-
storedKey: index_js_1.EmptyKey,
|
|
143
|
-
schema: (0, fieldSchema_js_1.createFieldSchema)(fieldSchema_js_1.FieldKind.Optional, view.info),
|
|
144
|
-
},
|
|
145
|
-
],
|
|
146
|
-
]);
|
|
147
|
-
const differences = Array.from(computeObjectNodeDiscrepancies(identifier, fields, stored, true));
|
|
148
|
-
if (differences.length > 0) {
|
|
149
|
-
yield {
|
|
150
|
-
identifier,
|
|
151
|
-
mismatch: "fields",
|
|
152
|
-
differences,
|
|
153
|
-
};
|
|
154
|
-
}
|
|
155
|
-
break;
|
|
156
|
-
}
|
|
157
|
-
case index_js_3.NodeKind.Map: {
|
|
158
|
-
(0, internal_1.assert)((0, index_js_4.isMapNodeSchema)(view), 0xbeb /* schema with node kind of map must implement MapNodeSchema */);
|
|
159
|
-
yield* getFieldDiscrepancies((0, fieldSchema_js_1.createFieldSchema)(fieldSchema_js_1.FieldKind.Optional, view.info), stored.mapFields, identifier, undefined);
|
|
160
|
-
break;
|
|
161
|
-
}
|
|
162
|
-
case index_js_3.NodeKind.Record: {
|
|
163
|
-
(0, internal_1.assert)((0, index_js_4.isRecordNodeSchema)(view), 0xbec /* schema with node kind of record must implement RecordNodeSchema */);
|
|
164
|
-
yield* getFieldDiscrepancies((0, fieldSchema_js_1.createFieldSchema)(fieldSchema_js_1.FieldKind.Optional, view.info), stored.mapFields, identifier, undefined);
|
|
165
|
-
break;
|
|
166
|
-
}
|
|
167
|
-
case index_js_3.NodeKind.Leaf: {
|
|
168
|
-
(0, internal_1.assert)(view instanceof leafNodeSchema_js_1.LeafNodeSchema, 0xbed /* schema with node kind of leaf must implement LeafNodeSchema */);
|
|
169
|
-
// TODO: leafKind seems like a bad name
|
|
170
|
-
const viewValue = view.leafKind;
|
|
171
|
-
const storedValue = stored.leafValue;
|
|
172
|
-
if (viewValue !== storedValue) {
|
|
173
|
-
yield {
|
|
174
|
-
identifier,
|
|
175
|
-
mismatch: "valueSchema",
|
|
176
|
-
view: viewValue,
|
|
177
|
-
stored: storedValue,
|
|
178
|
-
};
|
|
179
|
-
}
|
|
180
|
-
break;
|
|
181
|
-
}
|
|
182
|
-
default:
|
|
183
|
-
break;
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
/**
|
|
187
|
-
* Returns the allowed types that are not present in both the given view and stored schemas.
|
|
188
|
-
* It returns a tuple containing two arrays:
|
|
189
|
-
* 1. The first array contains the allowed types that are present in the view schema but not in the stored schema.
|
|
190
|
-
* 2. The second array contains the allowed types that are present in the stored schema but not in the view schema.
|
|
191
|
-
*/
|
|
192
|
-
function findExtraAllowedTypes(viewAllowedTypes, storedAllowedTypes) {
|
|
193
|
-
const viewNodeSchemaIdentifiers = new Set(viewAllowedTypes.map((value) => value.type.identifier));
|
|
194
|
-
const viewExtraneousAllowedTypes = [...viewAllowedTypes].filter((value) => !storedAllowedTypes.has((0, index_js_2.brand)(value.type.identifier)));
|
|
195
|
-
const storedExtraneousAllowedTypes = [...storedAllowedTypes].filter((value) => !viewNodeSchemaIdentifiers.has(value));
|
|
196
|
-
return [viewExtraneousAllowedTypes, storedExtraneousAllowedTypes];
|
|
197
|
-
}
|
|
198
|
-
exports.findExtraAllowedTypes = findExtraAllowedTypes;
|
|
199
|
-
/**
|
|
200
|
-
* The function to track the discrepancies between a field view schema and a stored schema.
|
|
201
|
-
*
|
|
202
|
-
* @remarks
|
|
203
|
-
* This function yields discrepancies in the following cases:
|
|
204
|
-
* 1. If the view schema has allowed types that are not present in the stored schema.
|
|
205
|
-
* 2. If the stored schema has allowed types that are not present in the view schema.
|
|
206
|
-
* 3. If the field kind in the view schema is not compatible with the stored schema.
|
|
207
|
-
*
|
|
208
|
-
* This function does not recurse into the nodes of the view schema and only makes comparisons at the field level.
|
|
209
|
-
*
|
|
210
|
-
* @param keyOrRoot - If the key is missing, it indicates that this is the root field schema.
|
|
211
|
-
*/
|
|
212
|
-
function* getFieldDiscrepancies(view, stored, identifier, fieldKey,
|
|
213
|
-
// TODO: This is a temporary workaround until the comparison logic is redesigned.
|
|
214
|
-
viewKindIsSequence = false) {
|
|
215
|
-
(0, internal_1.assert)(view instanceof fieldSchema_js_1.FieldSchemaAlpha, 0xbee /* all field schema should be FieldSchemaAlpha */);
|
|
216
|
-
const [viewExtra, storedExtra] = findExtraAllowedTypes(view.annotatedAllowedTypesNormalized.types, stored.types);
|
|
217
|
-
if (viewExtra.length > 0 || storedExtra.length > 0) {
|
|
218
|
-
yield {
|
|
219
|
-
identifier,
|
|
220
|
-
fieldKey,
|
|
221
|
-
mismatch: "allowedTypes",
|
|
222
|
-
view: viewExtra,
|
|
223
|
-
stored: storedExtra,
|
|
224
|
-
};
|
|
225
|
-
}
|
|
226
|
-
const viewKind = toStoredSchema_js_1.convertFieldKind.get(view.kind) ??
|
|
227
|
-
(0, internal_1.fail)(0xbef /* A conversion from a FieldKind to a FlexFieldKind should exist */);
|
|
228
|
-
// This checks if the field kind in the view schema is not compatible with the stored schema.
|
|
229
|
-
// We cannot detect if the view schema is a sequence using the kind property so it is passed in separately.
|
|
230
|
-
if ((viewKindIsSequence && stored.kind !== "Sequence") ||
|
|
231
|
-
(!viewKindIsSequence && viewKind.identifier !== stored.kind)) {
|
|
232
|
-
yield {
|
|
233
|
-
identifier,
|
|
234
|
-
fieldKey,
|
|
235
|
-
mismatch: "fieldKind",
|
|
236
|
-
view: viewKind.identifier,
|
|
237
|
-
stored: stored.kind,
|
|
238
|
-
};
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
/**
|
|
242
|
-
* Computes discrepancies between a view schema and a stored schema for nodes that are treated as object nodes in the stored schema.
|
|
243
|
-
* This includes both view object nodes and view array nodes.
|
|
244
|
-
*
|
|
245
|
-
* This function yields discrepancies in the following cases:
|
|
246
|
-
*
|
|
247
|
-
* 1. If the view schema has fields that are not present in the stored schema.
|
|
248
|
-
* 2. If the stored schema has fields that are not present in the view schema.
|
|
249
|
-
* 3. If the field kind or allowed types of a field in the view schema is not compatible with the stored schema.
|
|
250
|
-
*
|
|
251
|
-
* This function includes discrepancies within the common fields and their allowed types, but does NOT recurse to report and discrepancies within the node types referenced by those fields.
|
|
252
|
-
*/
|
|
253
|
-
function* computeObjectNodeDiscrepancies(identifier, view, stored, viewKindIsSequence = false) {
|
|
254
|
-
/**
|
|
255
|
-
* Similar to the logic used for tracking discrepancies between two node schemas, we will identify
|
|
256
|
-
* three types of differences:
|
|
257
|
-
* 1. Fields that exist in the view schema but not in the stored schema.
|
|
258
|
-
* 2. Fields that exist in both schemas but have different contents.
|
|
259
|
-
* 3. Fields that exist in the stored schema but not in the view schema.
|
|
260
|
-
*
|
|
261
|
-
* First, the view schema is iterated to track the first two types of differences.
|
|
262
|
-
* Then, the stored schema is iterated to find the third type.
|
|
263
|
-
*/
|
|
264
|
-
const viewKeys = new Set();
|
|
265
|
-
for (const [_, { storedKey: fieldKey, schema: fieldSchema }] of view) {
|
|
266
|
-
const storedSchema = stored.objectNodeFields.get(fieldKey);
|
|
267
|
-
viewKeys.add(fieldKey);
|
|
268
|
-
// If the view schema has a field that's not in the stored schema
|
|
269
|
-
if (storedSchema === undefined) {
|
|
270
|
-
const viewKind = toStoredSchema_js_1.convertFieldKind.get(fieldSchema.kind) ??
|
|
271
|
-
(0, internal_1.fail)(0xbf0 /* A conversion from a FieldKind to a FlexFieldKind should exist */);
|
|
272
|
-
yield {
|
|
273
|
-
identifier,
|
|
274
|
-
fieldKey,
|
|
275
|
-
mismatch: "fieldKind",
|
|
276
|
-
view: viewKind.identifier,
|
|
277
|
-
stored: index_js_1.storedEmptyFieldSchema.kind,
|
|
278
|
-
};
|
|
279
|
-
}
|
|
280
|
-
else {
|
|
281
|
-
yield* getFieldDiscrepancies(fieldSchema, storedSchema, identifier, fieldKey, viewKindIsSequence);
|
|
282
|
-
}
|
|
283
|
-
}
|
|
284
|
-
for (const [fieldKey, schema] of stored.objectNodeFields) {
|
|
285
|
-
// If the stored schema has a field that's not in the view schema
|
|
286
|
-
if (!viewKeys.has(fieldKey)) {
|
|
287
|
-
if (schema.kind === index_js_1.forbiddenFieldKindIdentifier) {
|
|
288
|
-
// In the stored schema the field is explicitly forbidden.
|
|
289
|
-
// This has the same semantics of the field not being mentioned in the stored schema,
|
|
290
|
-
// and thus is compatible with the view schema which does not mention this field.
|
|
291
|
-
continue;
|
|
292
|
-
}
|
|
293
|
-
yield {
|
|
294
|
-
identifier,
|
|
295
|
-
fieldKey,
|
|
296
|
-
mismatch: "fieldKind",
|
|
297
|
-
view: index_js_1.storedEmptyFieldSchema.kind,
|
|
298
|
-
stored: schema.kind,
|
|
299
|
-
};
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
}
|
|
303
|
-
/**
|
|
304
|
-
* @privateRemarks
|
|
305
|
-
* TODO: Knowledge of specific field kinds is not appropriate for modular schema.
|
|
306
|
-
* This bit of field comparison should be dependency injected by default-schema if this comparison logic remains in modular-schema
|
|
307
|
-
* (this is analogous to what is done in comparison.ts).
|
|
308
|
-
*/
|
|
309
|
-
const FieldKindIdentifiers = {
|
|
310
|
-
forbidden: (0, index_js_2.brand)("Forbidden"),
|
|
311
|
-
required: (0, index_js_2.brand)("Value"),
|
|
312
|
-
identifier: (0, index_js_2.brand)("Identifier"),
|
|
313
|
-
optional: (0, index_js_2.brand)("Optional"),
|
|
314
|
-
sequence: (0, index_js_2.brand)("Sequence"),
|
|
315
|
-
};
|
|
316
|
-
/**
|
|
317
|
-
* A realizer for the partial order of field kind relaxability.
|
|
318
|
-
*
|
|
319
|
-
* It seems extremely likely that this partial order will remain dimension 2 over time (i.e. the set of allowed relaxations can be visualized
|
|
320
|
-
* with a [dominance drawing](https://en.wikipedia.org/wiki/Dominance_drawing)), so this strategy allows efficient comarison between field kinds
|
|
321
|
-
* without excessive casework.
|
|
322
|
-
*
|
|
323
|
-
* Hasse diagram for the partial order is shown below (lower fields can be relaxed to higher fields):
|
|
324
|
-
* ```
|
|
325
|
-
* sequence
|
|
326
|
-
* |
|
|
327
|
-
* optional
|
|
328
|
-
* | \
|
|
329
|
-
* required forbidden
|
|
330
|
-
* |
|
|
331
|
-
* identifier
|
|
332
|
-
* ```
|
|
333
|
-
*/
|
|
334
|
-
exports.fieldRealizer = [
|
|
335
|
-
[
|
|
336
|
-
FieldKindIdentifiers.forbidden,
|
|
337
|
-
FieldKindIdentifiers.identifier,
|
|
338
|
-
FieldKindIdentifiers.required,
|
|
339
|
-
FieldKindIdentifiers.optional,
|
|
340
|
-
FieldKindIdentifiers.sequence,
|
|
341
|
-
],
|
|
342
|
-
[
|
|
343
|
-
FieldKindIdentifiers.identifier,
|
|
344
|
-
FieldKindIdentifiers.required,
|
|
345
|
-
FieldKindIdentifiers.forbidden,
|
|
346
|
-
FieldKindIdentifiers.optional,
|
|
347
|
-
FieldKindIdentifiers.sequence,
|
|
348
|
-
],
|
|
349
|
-
].map((extension) => new Map(extension.map((identifier, index) => [identifier, index])));
|
|
350
|
-
exports.PosetComparisonResult = {
|
|
351
|
-
Less: "<",
|
|
352
|
-
Greater: ">",
|
|
353
|
-
Equal: "=",
|
|
354
|
-
Incomparable: "||",
|
|
355
|
-
};
|
|
356
|
-
/**
|
|
357
|
-
* TODO: This is used by SchemaCompatibilityTester, revisit it during redesign and document
|
|
358
|
-
*/
|
|
359
|
-
function comparePosetElements(a, b, realizer) {
|
|
360
|
-
let hasLessThanResult = false;
|
|
361
|
-
let hasGreaterThanResult = false;
|
|
362
|
-
for (const extension of realizer) {
|
|
363
|
-
const aIndex = extension.get(a);
|
|
364
|
-
const bIndex = extension.get(b);
|
|
365
|
-
(0, internal_1.assert)(aIndex !== undefined && bIndex !== undefined, 0xbf1 /* Invalid realizer */);
|
|
366
|
-
if (aIndex < bIndex) {
|
|
367
|
-
hasLessThanResult = true;
|
|
368
|
-
}
|
|
369
|
-
else if (aIndex > bIndex) {
|
|
370
|
-
hasGreaterThanResult = true;
|
|
371
|
-
}
|
|
372
|
-
}
|
|
373
|
-
return hasLessThanResult
|
|
374
|
-
? hasGreaterThanResult
|
|
375
|
-
? exports.PosetComparisonResult.Incomparable
|
|
376
|
-
: exports.PosetComparisonResult.Less
|
|
377
|
-
: hasGreaterThanResult
|
|
378
|
-
? exports.PosetComparisonResult.Greater
|
|
379
|
-
: exports.PosetComparisonResult.Equal;
|
|
380
|
-
}
|
|
381
|
-
exports.comparePosetElements = comparePosetElements;
|
|
382
|
-
//# sourceMappingURL=discrepancies.js.map
|