Tweaks to checkSchemaCompatibilitySnapshots

examples/apps/tree-cli-app/src/test/schema.spec.ts

@@ -6,7 +6,7 @@
 import fs from "node:fs";
 import path from "node:path";
 
-import { checkSchemaCompatibilitySnapshots } from "@fluidframework/tree/alpha";
+import { snapshotSchemaCompatibility } from "@fluidframework/tree/alpha";
 
 import { config } from "../schema.js";
 
@@ -22,15 +22,15 @@ describe("schema", () => {
 		);
 		// This app does not actually support a stable document format, so the versions used here are arbitrary.
 		// Despite this, testing the schema for compatibility issues is a useful example of how apps should do this,
-		// and testing the checkSchemaCompatibilitySnapshots API.
+		// and testing the snapshotSchemaCompatibility API.
 		// This app has a dummy legacy version 1.0.0 schema so it can include a compatibility test for upgrading an old schema.
-		checkSchemaCompatibilitySnapshots({
+		snapshotSchemaCompatibility({
 			snapshotDirectory,
 			fileSystem: { ...fs, ...path },
 			version: "2.0.0",
 			schema: config,
 			minVersionForCollaboration: "2.0.0",
-			mode: regenerateSnapshots ? "update" : "test",
+			mode: regenerateSnapshots ? "update" : "assert",
 		});
 	});
 });

examples/data-objects/inventory-app/src/test/inventoryApp.test.tsx

@@ -9,7 +9,7 @@ import path from "node:path";
 
 import { toPropTreeNode } from "@fluidframework/react/alpha";
 import { render } from "@testing-library/react";
-import { checkSchemaCompatibilitySnapshots } from "fluid-framework/alpha";
+import { snapshotSchemaCompatibility } from "fluid-framework/alpha";
 import globalJsdom from "global-jsdom";
 import * as React from "react";
 
@@ -36,14 +36,14 @@ describe("inventoryApp", () => {
 		);
 		// This app does not actually support a stable document format, so the versions used here are arbitrary.
 		// Despite this, testing the schema for compatibility issues is a useful example of how apps should do this,
-		// and testing the checkSchemaCompatibilitySnapshots API.
-		checkSchemaCompatibilitySnapshots({
+		// and testing the snapshotSchemaCompatibility API.
+		snapshotSchemaCompatibility({
 			snapshotDirectory,
 			fileSystem: { ...fs, ...path },
 			version: "1.0.0",
 			schema: treeConfiguration,
 			minVersionForCollaboration: "1.0.0",
-			mode: regenerateSnapshots ? "update" : "test",
+			mode: regenerateSnapshots ? "update" : "assert",
 		});
 	});
 

packages/dds/tree/api-report/tree.alpha.api.md

@@ -145,9 +145,6 @@ export type ChangeMetadata = LocalChangeMetadata | RemoteChangeMetadata;
 // @alpha
 export function checkCompatibility(viewWhichCreatedStoredSchema: TreeViewConfiguration, view: TreeViewConfiguration): Omit<SchemaCompatibilityStatus, "canInitialize">;
 
-// @alpha
-export function checkSchemaCompatibilitySnapshots(options: SchemaCompatibilitySnapshotsOptions): void;
-
 // @alpha
 export function cloneWithReplacements(root: unknown, rootKey: string, replacer: (key: string, value: unknown) => {
     clone: boolean;
@@ -976,17 +973,6 @@ export interface RunTransactionParams {
     readonly preconditions?: readonly TransactionConstraintAlpha[];
 }
 
-// @alpha @input
-export interface SchemaCompatibilitySnapshotsOptions {
-    readonly fileSystem: SnapshotFileSystem;
-    readonly minVersionForCollaboration: string;
-    readonly mode: "test" | "update";
-    readonly schema: TreeViewConfiguration;
-    readonly snapshotDirectory: string;
-    readonly snapshotUnchangedVersions?: true;
-    readonly version: string;
-}
-
 // @public @sealed
 export interface SchemaCompatibilityStatus {
     readonly canInitialize: boolean;
@@ -1223,6 +1209,23 @@ export interface SnapshotFileSystem {
     }): void;
 }
 
+// @alpha
+export function snapshotSchemaCompatibility(options: SnapshotSchemaCompatibilityOptions): void;
+
+// @alpha @input
+export interface SnapshotSchemaCompatibilityOptions {
+    readonly fileSystem: SnapshotFileSystem;
+    readonly minVersionForCollaboration: string;
+    readonly mode: "assert" | "update";
+    readonly rejectSchemaChangesWithNoVersionChange?: true;
+    readonly rejectVersionsWithNoSchemaChange?: true;
+    readonly schema: TreeViewConfiguration;
+    readonly snapshotDirectory: string;
+    readonly snapshotUnchangedVersions?: true;
+    readonly version: string;
+    readonly versionComparer?: (a: string, b: string) => number;
+}
+
 // @beta @system
 export namespace System_TableSchema {
     // @sealed @system

packages/dds/tree/src/index.ts

@@ -296,13 +296,13 @@ export {
 	exportCompatibilitySchemaSnapshot,
 	importCompatibilitySchemaSnapshot,
 	checkCompatibility,
-	checkSchemaCompatibilitySnapshots,
+	snapshotSchemaCompatibility,
 	type SnapshotFileSystem,
 	incrementalSummaryHint,
 	incrementalEncodingPolicyForAllowedTypes,
 	eraseSchemaDetails,
 	eraseSchemaDetailsSubclassable,
-	type SchemaCompatibilitySnapshotsOptions,
+	type SnapshotSchemaCompatibilityOptions,
 	type ArrayPlaceAnchor,
 	createArrayInsertionAnchor,
 } from "./simple-tree/index.js";

packages/dds/tree/src/simple-tree/api/index.ts

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