@fluidframework/tree 2.80.0 → 2.81.0

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

@@ -3,14 +3,15 @@
  * Licensed under the MIT License.
  */
 
+import { assert } from "@fluidframework/core-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+import type { FieldKey } from "../../core/index.js";
+import type { IncrementalEncodingPolicy } from "../../feature-libraries/index.js";
+import { oneFromIterable } from "../../util/index.js";
 import { getTreeNodeSchemaPrivateData, type AllowedTypesFull } from "../core/index.js";
 import { isArrayNodeSchema, isObjectNodeSchema } from "../node-kinds/index.js";
 import type { TreeSchema } from "../treeSchema.js";
-import type { IncrementalEncodingPolicy } from "../../feature-libraries/index.js";
-import { oneFromIterable } from "../../util/index.js";
-import { assert } from "@fluidframework/core-utils/internal";
-import type { FieldKey } from "../../core/index.js";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * A symbol when present in the {@link AnnotatedAllowedTypes.metadata}'s `custom` property as true, opts in the allowed

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

@@ -180,4 +180,7 @@ export {
 	exportCompatibilitySchemaSnapshot,
 	importCompatibilitySchemaSnapshot,
 	checkCompatibility,
+	checkSchemaCompatibilitySnapshots,
+	type SnapshotFileSystem,
+	type SchemaCompatibilitySnapshotsOptions,
 } from "./snapshotCompatibilityChecker.js";

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

@@ -5,12 +5,12 @@
 
 import type { TreeStoredSchema } from "../../core/index.js";
 import { allowsRepoSuperset, defaultSchemaPolicy } from "../../feature-libraries/index.js";
-
-import type { SchemaCompatibilityStatus } from "./tree.js";
-import { getDiscrepanciesInAllowedContent } from "./discrepancies.js";
 import { toUpgradeSchema } from "../toStoredSchema.js";
 import type { TreeSchema } from "../treeSchema.js";
 
+import { getDiscrepanciesInAllowedContent } from "./discrepancies.js";
+import type { SchemaCompatibilityStatus } from "./tree.js";
+
 /**
  * A collection of View information for schema
  * @remarks

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

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
 import { assert, fail } from "@fluidframework/core-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import type { SchemaFactory, ScopedSchemaName } from "./schemaFactory.js";
+import type { UnionToTuple } from "../../util/index.js";
 import type {
 	NodeFromSchema,
 	InternalTreeNode,
@@ -15,7 +15,8 @@ import type {
 	TreeNodeSchema,
 	TreeNodeSchemaClass,
 } from "../core/index.js";
-import type { UnionToTuple } from "../../util/index.js";
+
+import type { SchemaFactory, ScopedSchemaName } from "./schemaFactory.js";
 
 /*
  * This file does two things:

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

@@ -4,13 +4,15 @@
  */
 
 import { assert, debugAssert, unreachableCase } from "@fluidframework/core-utils/internal";
+import type { IIdCompressor } from "@fluidframework/id-compressor";
+import { createIdCompressor } from "@fluidframework/id-compressor/internal";
 import { isFluidHandle } from "@fluidframework/runtime-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import type { TreeValue } from "../../core/index.js";
 // This import is required for intellisense in @link doc comments on mouseover in VSCode.
 // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
-import type { TreeAlpha } from "../../shared-tree/index.js";
+import type { FlexTreeHydratedContextMinimal } from "../../feature-libraries/index.js";
 import {
 	type JsonCompatibleReadOnlyObject,
 	type RestrictiveStringRecord,
@@ -31,6 +33,17 @@ import type {
 	ImplicitAllowedTypes,
 	InsertableTreeNodeFromImplicitAllowedTypes,
 } from "../core/index.js";
+import {
+	FieldKind,
+	type FieldSchema,
+	type ImplicitFieldSchema,
+	// This import prevents a large number of FieldProps references in the API reports from showing up as FieldProps_2.
+	// eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+	type FieldProps,
+	createFieldSchema,
+	type DefaultProvider,
+	getDefaultProvider,
+} from "../fieldSchema.js";
 import {
 	booleanSchema,
 	handleSchema,
@@ -51,24 +64,10 @@ import {
 	type TreeMapNode,
 	type TreeObjectNode,
 } from "../node-kinds/index.js";
-import {
-	FieldKind,
-	type FieldSchema,
-	type ImplicitFieldSchema,
-	// This import prevents a large number of FieldProps references in the API reports from showing up as FieldProps_2.
-	// eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
-	type FieldProps,
-	createFieldSchema,
-	type DefaultProvider,
-	getDefaultProvider,
-} from "../fieldSchema.js";
-
-import type { System_Unsafe } from "./typesUnsafe.js";
-import type { IIdCompressor } from "@fluidframework/id-compressor";
-import { createIdCompressor } from "@fluidframework/id-compressor/internal";
-import type { FlexTreeHydratedContextMinimal } from "../../feature-libraries/index.js";
 import { unhydratedFlexTreeFromInsertable } from "../unhydratedFlexTreeFromInsertable.js";
+
 import { type SchemaStatics, schemaStatics } from "./schemaStatics.js";
+import type { System_Unsafe } from "./typesUnsafe.js";
 
 /**
  * Gets the leaf domain schema compatible with a given {@link TreeValue}.

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

@@ -3,6 +3,23 @@
  * Licensed under the MIT License.
  */
 
+import type { RestrictiveStringRecord } from "../../util/index.js";
+import type {
+	NodeKind,
+	TreeNodeSchemaClass,
+	ImplicitAllowedTypes,
+	WithType,
+} from "../core/index.js";
+import type { ImplicitFieldSchema } from "../fieldSchema.js";
+// These imports prevent a large number of type references in the API reports from showing up as *_2.
+/* eslint-disable unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars, import-x/no-duplicates */
+import type {
+	FieldProps,
+	FieldSchemaAlpha,
+	FieldPropsAlpha,
+	FieldKind,
+} from "../fieldSchema.js";
+import type { LeafSchema } from "../leafNodeSchema.js";
 import {
 	type ArrayNodeCustomizableSchema,
 	arraySchema,
@@ -13,6 +30,9 @@ import {
 	type RecordNodeCustomizableSchema,
 	recordSchema,
 } from "../node-kinds/index.js";
+import type { SchemaType, SimpleObjectNodeSchema } from "../simpleSchema.js";
+import type { SimpleLeafNodeSchema } from "../simpleSchema.js";
+
 import {
 	defaultSchemaFactoryObjectOptions,
 	scoped,
@@ -20,34 +40,14 @@ import {
 	type ObjectSchemaOptionsAlpha,
 	type ScopedSchemaName,
 } from "./schemaFactory.js";
+import { SchemaFactoryBeta } from "./schemaFactoryBeta.js";
 import { schemaStatics } from "./schemaStatics.js";
-import type { ImplicitFieldSchema } from "../fieldSchema.js";
-import type { RestrictiveStringRecord } from "../../util/index.js";
-import type {
-	NodeKind,
-	TreeNodeSchemaClass,
-	ImplicitAllowedTypes,
-	WithType,
-} from "../core/index.js";
 import type {
 	ArrayNodeCustomizableSchemaUnsafe,
 	MapNodeCustomizableSchemaUnsafe,
 	System_Unsafe,
 	TreeRecordNodeUnsafe,
 } from "./typesUnsafe.js";
-import type { SchemaType, SimpleObjectNodeSchema } from "../simpleSchema.js";
-import { SchemaFactoryBeta } from "./schemaFactoryBeta.js";
-
-// These imports prevent a large number of type references in the API reports from showing up as *_2.
-/* eslint-disable unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars, import-x/no-duplicates */
-import type {
-	FieldProps,
-	FieldSchemaAlpha,
-	FieldPropsAlpha,
-	FieldKind,
-} from "../fieldSchema.js";
-import type { LeafSchema } from "../leafNodeSchema.js";
-import type { SimpleLeafNodeSchema } from "../simpleSchema.js";
 import type { FieldSchemaAlphaUnsafe } from "./typesUnsafe.js";
 /* eslint-enable unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars, import-x/no-duplicates */
 
@@ -94,7 +94,7 @@ export class SchemaFactoryAlpha<
 	} {
 		return objectSchema(scoped<TScope, TName, Name>(this, name), fields, true, {
 			...defaultSchemaFactoryObjectOptions,
-			...(options ?? {}),
+			...options,
 		});
 	}
 

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

@@ -3,6 +3,9 @@
  * Licensed under the MIT License.
  */
 
+import type { RestrictiveStringRecord } from "../../util/index.js";
+// eslint-disable-next-line unused-imports/no-unused-imports, import-x/no-duplicates -- This import prevents a large number of type references in the API reports from showing up as *_2.
+import type { RestrictiveStringRecord as _RestrictiveStringRecord } from "../../util/index.js";
 import {
 	AnnotatedAllowedTypesInternal,
 	createSchemaUpgrade,
@@ -19,7 +22,17 @@ import {
 	type TreeNodeSchemaNonClass,
 	type WithType,
 } from "../core/index.js";
-
+import type { ImplicitFieldSchema } from "../fieldSchema.js";
+/* eslint-disable unused-imports/no-unused-imports, import-x/no-duplicates -- These imports prevent a large number of type references in the API reports from showing up as *_2. */
+import type {
+	FieldProps as _FieldProps,
+	FieldSchemaAlpha as _FieldSchemaAlpha,
+	FieldPropsAlpha as _FieldPropsAlpha,
+	FieldKind as _FieldKind,
+	ImplicitFieldSchema as _ImplicitFieldSchema,
+} from "../fieldSchema.js";
+import type { LeafSchema as _LeafSchema } from "../leafNodeSchema.js";
+/* eslint-enable unused-imports/no-unused-imports, import-x/no-duplicates */
 import {
 	objectSchema,
 	recordSchema,
@@ -28,6 +41,9 @@ import {
 	type TreeObjectNode,
 	type TreeRecordNode,
 } from "../node-kinds/index.js";
+// eslint-disable-next-line unused-imports/no-unused-imports -- This import prevents a large number of type references in the API reports from showing up as *_2.
+import type { SimpleLeafNodeSchema as _SimpleLeafNodeSchema } from "../simpleSchema.js";
+
 import {
 	defaultSchemaFactoryObjectOptions,
 	SchemaFactory,
@@ -46,20 +62,6 @@ import type {
 	Unenforced,
 } from "./typesUnsafe.js";
 
-// These imports prevent a large number of type references in the API reports from showing up as *_2.
-/* eslint-disable unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars, import-x/no-duplicates */
-import type {
-	FieldProps,
-	FieldSchemaAlpha,
-	FieldPropsAlpha,
-	FieldKind,
-	ImplicitFieldSchema,
-} from "../fieldSchema.js";
-import type { LeafSchema } from "../leafNodeSchema.js";
-import type { SimpleLeafNodeSchema } from "../simpleSchema.js";
-import type { RestrictiveStringRecord } from "../../util/index.js";
-/* eslint-enable unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars, import-x/no-duplicates */
-
 /**
  * Stateless APIs exposed via {@link SchemaFactoryBeta} as both instance properties and as statics.
  * @see {@link SchemaStatics} for why this is useful.
@@ -260,7 +262,7 @@ export class SchemaFactoryBeta<
 	> {
 		return objectSchema(scoped<TScope, TName, Name>(this, name), fields, true, {
 			...defaultSchemaFactoryObjectOptions,
-			...(options ?? {}),
+			...options,
 		});
 	}
 

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

@@ -13,8 +13,8 @@ import type {
 	InsertableTreeNodeFromImplicitAllowedTypes,
 	TreeNodeSchemaClass,
 } from "../core/index.js";
-import type { InsertableObjectFromSchemaRecord } from "../node-kinds/index.js";
 import type { ImplicitFieldSchema } from "../fieldSchema.js";
+import type { InsertableObjectFromSchemaRecord } from "../node-kinds/index.js";
 
 /**
  * Compile time check for validity of a recursive schema.

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

@@ -24,8 +24,8 @@ import type {
 	SimpleNodeSchema,
 	SimpleTreeSchema,
 } from "../simpleSchema.js";
-
 import type { TreeSchema } from "../treeSchema.js";
+
 import { SchemaFactoryAlpha } from "./schemaFactoryAlpha.js";
 
 const factory = new SchemaFactoryAlpha(undefined);

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

@@ -4,6 +4,7 @@
  */
 
 import type { IFluidHandle } from "@fluidframework/core-interfaces";
+
 import type { ImplicitAllowedTypes } from "../core/index.js";
 import { FieldKind, getDefaultProvider, createFieldSchema } from "../fieldSchema.js";
 import type {
@@ -21,6 +22,7 @@ import {
 	nullSchema,
 	handleSchema,
 } from "../leafNodeSchema.js";
+
 import type { System_Unsafe, FieldSchemaAlphaUnsafe } from "./typesUnsafe.js";
 
 /**

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

@@ -3,8 +3,19 @@
  * Licensed under the MIT License.
  */
 
-import { objectToMap, type JsonCompatibleReadOnly } from "../../util/index.js";
 import { unreachableCase, transformMapValues } from "@fluidframework/core-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+import {
+	DiscriminatedUnionDispatcher,
+	extractJsonValidator,
+	FormatValidatorNoOp,
+	type FormatValidator,
+} from "../../codec/index.js";
+import type { ValueSchema } from "../../core/index.js";
+import { objectToMap, type JsonCompatibleReadOnly } from "../../util/index.js";
+import { createSchemaUpgrade, NodeKind, SchemaUpgrade } from "../core/index.js";
+import type { FieldKind } from "../fieldSchema.js";
 import type {
 	SimpleAllowedTypeAttributes,
 	SimpleArrayNodeSchema,
@@ -17,17 +28,7 @@ import type {
 	SimpleRecordNodeSchema,
 	SimpleTreeSchema,
 } from "../simpleSchema.js";
-import { createSchemaUpgrade, NodeKind, SchemaUpgrade } from "../core/index.js";
-import type { FieldKind } from "../fieldSchema.js";
-import type { ValueSchema } from "../../core/index.js";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
 import * as Format from "../simpleSchemaFormatV1.js";
-import {
-	DiscriminatedUnionDispatcher,
-	extractJsonValidator,
-	FormatValidatorNoOp,
-	type FormatValidator,
-} from "../../codec/index.js";
 
 /**
  * Encodes the compatibility impacting subset of simple schema (view or stored) into a serializable format.

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

@@ -5,8 +5,28 @@
 
 import { unreachableCase } from "@fluidframework/core-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
 import { ValueSchema } from "../../core/index.js";
 import { copyProperty, hasSingle, type Mutable } from "../../util/index.js";
+import { NodeKind, type TreeNodeSchema } from "../core/index.js";
+import { FieldKind } from "../fieldSchema.js";
+import { LeafNodeSchema } from "../leafNodeSchema.js";
+import {
+	ArrayNodeSchema,
+	isMapNodeSchema,
+	isRecordNodeSchema,
+	ObjectNodeSchema,
+} from "../node-kinds/index.js";
+import type {
+	SimpleArrayNodeSchema,
+	SimpleLeafNodeSchema,
+	SimpleMapNodeSchema,
+	SimpleRecordNodeSchema,
+} from "../simpleSchema.js";
+import type { TreeSchema } from "../treeSchema.js";
+
+import { KeyEncodingOptions } from "./customTree.js";
+import type { TreeSchemaEncodingOptions } from "./getJsonSchema.js";
 import type {
 	JsonArrayNodeSchema,
 	JsonFieldSchema,
@@ -20,24 +40,6 @@ import type {
 	JsonLeafSchemaType,
 	JsonRecordNodeSchema,
 } from "./jsonSchema.js";
-import { FieldKind } from "../fieldSchema.js";
-import type {
-	SimpleArrayNodeSchema,
-	SimpleLeafNodeSchema,
-	SimpleMapNodeSchema,
-	SimpleRecordNodeSchema,
-} from "../simpleSchema.js";
-import { NodeKind, type TreeNodeSchema } from "../core/index.js";
-import type { TreeSchema } from "../treeSchema.js";
-import type { TreeSchemaEncodingOptions } from "./getJsonSchema.js";
-import {
-	ArrayNodeSchema,
-	isMapNodeSchema,
-	isRecordNodeSchema,
-	ObjectNodeSchema,
-} from "../node-kinds/index.js";
-import { LeafNodeSchema } from "../leafNodeSchema.js";
-import { KeyEncodingOptions } from "./customTree.js";
 
 /**
  * Generates a JSON Schema representation from a simple tree schema.
@@ -110,9 +112,9 @@ function convertArrayNodeSchema(schema: SimpleArrayNodeSchema): JsonArrayNodeSch
 	const allowedTypesIdentifiers: ReadonlySet<string> = new Set(
 		schema.simpleAllowedTypes.keys(),
 	);
-	allowedTypesIdentifiers.forEach((type) => {
+	for (const type of allowedTypesIdentifiers) {
 		allowedTypes.push(createSchemaRef(type));
-	});
+	}
 
 	const items: JsonFieldSchema = hasSingle(allowedTypes)
 		? allowedTypes[0]
@@ -216,9 +218,9 @@ function convertRecordLikeNodeSchema(
 	const allowedTypesIdentifiers: ReadonlySet<string> = new Set(
 		schema.simpleAllowedTypes.keys(),
 	);
-	allowedTypesIdentifiers.forEach((type) => {
+	for (const type of allowedTypesIdentifiers) {
 		allowedTypes.push(createSchemaRef(type));
-	});
+	}
 
 	const output = {
 		type: "object",

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

@@ -4,6 +4,7 @@
  */
 
 import { fail } from "@fluidframework/core-utils/internal";
+
 import type {
 	AnchorNode,
 	FieldKey,
@@ -19,18 +20,19 @@ import {
 	type TreeIndexKey,
 	type KeyFinder,
 } from "../../feature-libraries/index.js";
+import type { SchematizingSimpleTreeView } from "../../shared-tree/index.js";
 import { brand } from "../../util/index.js";
-import type { ImplicitFieldSchema } from "../fieldSchema.js";
 import {
 	treeNodeFromAnchor,
 	type TreeNode,
 	type TreeNodeSchema,
 	type NodeFromSchema,
 } from "../core/index.js";
-import { treeNodeApi } from "./treeNodeApi.js";
-import type { TreeView } from "./tree.js";
+import type { ImplicitFieldSchema } from "../fieldSchema.js";
 import { walkFieldSchema } from "../walkFieldSchema.js";
-import type { SchematizingSimpleTreeView } from "../../shared-tree/index.js";
+
+import type { TreeView } from "./tree.js";
+import { treeNodeApi } from "./treeNodeApi.js";
 
 /**
  * A {@link TreeIndex} that returns tree nodes given their associated keys.