Remove JsonValidator export (#25381)

## Description

Remove obsolete JsonValidator Alpha API in tree.

## Breaking Changes

Users must migrate as described in changeset.

Author: CraigMacomber

.changeset/proud-candles-bake.md

@@ -0,0 +1,12 @@
+---
+"fluid-framework": minor
+"@fluidframework/tree": minor
+"__section": tree
+---
+Remove JsonValidator
+
+The `@alpha` API `JsonValidator` has been removed: its replacement `FormatValidator` must now be used.
+
+As part of this:
+- `typeboxValidator` has been replaced with `FormatValidatorBasic`.
+- `noopValidator` has been replaced with `FormatValidatorNoOp`.

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

@@ -9,7 +9,7 @@ import {
 	comparePersistedSchema,
 	extractPersistedSchema,
 	FluidClientVersion,
-	typeboxValidator,
+	FormatValidatorBasic,
 	type ForestOptions,
 	type ICodecOptions,
 	type ImplicitFieldSchema,
@@ -128,7 +128,7 @@ describe("schema", () => {
 	});
 
 	describe("historical schema can be upgraded to current schema", () => {
-		const options: ForestOptions & ICodecOptions = { jsonValidator: typeboxValidator };
+		const options: ForestOptions & ICodecOptions = { jsonValidator: FormatValidatorBasic };
 
 		for (let documentIndex = 0; documentIndex < historicalSchema.length; documentIndex++) {
 			for (let viewIndex = 0; viewIndex < historicalSchema.length; viewIndex++) {

examples/apps/tree-cli-app/src/utils.ts

@@ -21,7 +21,7 @@ import {
 	extractPersistedSchema,
 	FluidClientVersion,
 	independentInitializedView,
-	typeboxValidator,
+	FormatValidatorBasic,
 	type ForestOptions,
 	type ICodecOptions,
 	type JsonCompatible,
@@ -72,7 +72,9 @@ export function loadDocument(source: string | undefined): List {
 			});
 		}
 		case "compressed": {
-			return TreeAlpha.importCompressed(List, fileData, { jsonValidator: typeboxValidator });
+			return TreeAlpha.importCompressed(List, fileData, {
+				jsonValidator: FormatValidatorBasic,
+			});
 		}
 		case "snapshot": {
 			// TODO: This should probably do a validating parse of the data (probably using type box) rather than just casting it.
@@ -249,7 +251,7 @@ export function rejectHandles(key: string, value: unknown): unknown {
 	return value;
 }
 
-const options: ForestOptions & ICodecOptions = { jsonValidator: typeboxValidator };
+const options: ForestOptions & ICodecOptions = { jsonValidator: FormatValidatorBasic };
 
 const File = Type.Object({
 	tree: Type.Unsafe<JsonCompatible<IFluidHandle>>(),

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

@@ -314,7 +314,7 @@ export type HandleConverter<TCustom> = (data: IFluidHandle) => TCustom;
 
 // @alpha @input
 export interface ICodecOptions {
-    readonly jsonValidator: JsonValidator | FormatValidator;
+    readonly jsonValidator: FormatValidator;
 }
 
 // @alpha
@@ -552,11 +552,6 @@ export type JsonTreeSchema = JsonFieldSchema & {
     readonly $defs: Record<JsonSchemaId, JsonNodeSchema>;
 };
 
-// @alpha @input
-export interface JsonValidator {
-    compile<Schema extends TSchema>(schema: Schema): SchemaValidationFunction<Schema>;
-}
-
 // @alpha @input
 export enum KeyEncodingOptions {
     allStoredKeys = "allStoredKeys",
@@ -655,9 +650,6 @@ export interface NodeSchemaOptionsAlpha<out TCustomMetadata = unknown> extends N
     readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;
 }
 
-// @alpha
-export const noopValidator: JsonValidator;
-
 // @alpha @sealed
 export interface NormalizedAnnotatedAllowedTypes extends AnnotatedAllowedTypes<TreeNodeSchema> {
 }
@@ -916,11 +908,6 @@ export class SchemaUpgrade {
     protected _typeCheck: MakeNominal;
 }
 
-// @alpha @input
-export interface SchemaValidationFunction<Schema extends TSchema> {
-    check(data: unknown): data is Static<Schema>;
-}
-
 // @public @system
 type ScopedSchemaName<TScope extends string | undefined, TName extends number | string> = TScope extends undefined ? `${TName}` : `${TScope}.${TName}`;
 
@@ -1573,9 +1560,6 @@ export interface TreeViewEvents {
     schemaChanged(): void;
 }
 
-// @alpha
-export const typeboxValidator: JsonValidator;
-
 // @public @deprecated @system
 const typeNameSymbol: unique symbol;
 

packages/dds/tree/src/codec/codec.ts

@@ -10,7 +10,6 @@ import type { Static, TAnySchema, TSchema } from "@sinclair/typebox";
 
 import type { ChangeEncodingContext } from "../core/index.js";
 import type { JsonCompatibleReadOnly } from "../util/index.js";
-import { noopValidator } from "./noopValidator.js";
 
 /**
  * Translates decoded data to encoded data.
@@ -37,7 +36,6 @@ export interface IDecoder<TDecoded, TEncoded, TContext> {
 /**
  * Validates data complies with some particular schema.
  * Implementations are typically created by a {@link JsonValidator}.
- * @alpha @input
  */
 export interface SchemaValidationFunction<Schema extends TSchema> {
 	/**
@@ -66,6 +64,15 @@ export interface SchemaValidationFunction<Schema extends TSchema> {
  */
 export interface FormatValidator extends ErasedType<"FormatValidator"> {}
 
+/**
+ * A {@link JsonValidator} implementation which performs no validation and accepts all data as valid.
+ * @privateRemarks Having this as an option unifies opting out of validation with selection of
+ * validators, simplifying code performing validation.
+ */
+const noopValidator: JsonValidator = {
+	compile: <Schema extends TSchema>() => ({ check: (data): data is Static<Schema> => true }),
+};
+
 /**
  * A {@link FormatValidator} which does no validation.
  * @alpha
@@ -122,11 +129,10 @@ export interface ICodecOptions {
 	 * SharedTree users are still encouraged to use a non-trivial validator (i.e. not `FormatValidatorNoOp`)
 	 * whenever reasonable: it gives better fail-fast behavior when unexpected encoded data is found,
 	 * which reduces the risk of unrecoverable data corruption.
-	 *
-	 * Use of {@link JsonValidator} here is deprecated and will be removed:
-	 * it is recommended to use {@link FormatValidator} instead.
+	 * @privateRemarks
+	 * This property should probably be renamed to `validator` before stabilizing the API.
 	 */
-	readonly jsonValidator: JsonValidator | FormatValidator;
+	readonly jsonValidator: FormatValidator;
 }
 
 /**

packages/dds/tree/src/codec/index.ts

@@ -31,7 +31,6 @@ export {
 	type DiscriminatedUnionLibrary,
 	unionOptions,
 } from "./discriminatedUnions.js";
-export { noopValidator } from "./noopValidator.js";
 export {
 	Versioned,
 	makeVersionedCodec,

packages/dds/tree/src/codec/noopValidator.ts

@@ -9,8 +9,8 @@ import type { IIdCompressor } from "@fluidframework/id-compressor";
 import {
 	type CodecWriteOptions,
 	FluidClientVersion,
+	FormatValidatorNoOp,
 	type IJsonCodec,
-	noopValidator,
 } from "../../codec/index.js";
 import {
 	type IdAllocator,
@@ -83,7 +83,7 @@ export class DetachedFieldIndex {
 		options?: CodecWriteOptions,
 	) {
 		this.options = options ?? {
-			jsonValidator: noopValidator,
+			jsonValidator: FormatValidatorNoOp,
 			oldestCompatibleClient: FluidClientVersion.v2_0,
 		};
 		this.codec = makeDetachedFieldIndexCodec(revisionTagCodec, this.options, idCompressor);

packages/dds/tree/src/core/tree/detachedFieldIndex.ts

@@ -3,4 +3,4 @@
  * Licensed under the MIT License.
  */
 
-export { typeboxValidator, FormatValidatorBasic } from "./typeboxValidator.js";
+export { FormatValidatorBasic } from "./typeboxValidator.js";

packages/dds/tree/src/external-utilities/index.ts

@@ -18,10 +18,8 @@ import { toFormatValidator, type JsonValidator } from "../codec/index.js";
  * (i.e. a JSON validator is only included in an application's bundle if that application references it).
  *
  * Defining this validator in its own file also helps to ensure it is tree-shakeable.
- *
- * @alpha
  */
-export const typeboxValidator: JsonValidator = {
+const typeboxValidator: JsonValidator = {
 	compile: <Schema extends TSchema>(schema: Schema) => {
 		const compiledFormat = TypeCompiler.Compile(schema);
 		return {