Move Json domain from test to internal

experimental/framework/tree-react-api/src/test/importer.spec.ts

@@ -5,11 +5,18 @@
 
 import { strict as assert } from "node:assert";
 
+import { JsonArray } from "@fluidframework/tree/internal";
+
 import { RecursiveMap } from "../testExports.js";
 
 describe("import tests", () => {
 	it("recursive map", () => {
 		const r = new RecursiveMap([["", new RecursiveMap([])]]);
 		assert.equal(r.size, 1);
 	});
+
+	it("JsonArray", () => {
+		const r = new JsonArray([1]);
+		assert.equal(r[0], 1);
+	});
 });

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

@@ -21,6 +21,20 @@ export type AllowedTypes = readonly LazyItem<TreeNodeSchema>[];
 // @public
 type AllowedTypesUnsafe = readonly LazyItem<TreeNodeSchemaUnsafe>[];
 
+// @alpha
+export const _APIExtractorWorkaroundJsonArrayBase: TreeNodeSchemaClass_2<"com.fluidframework.json.array", NodeKind_2.Array, TreeArrayNodeUnsafe_2<readonly [() => typeof JsonObject, () => typeof JsonArray, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>]> & WithType_2<"com.fluidframework.json.array", NodeKind_2.Array, unknown>, {
+[Symbol.iterator](): Iterator<string | number | JsonObject | JsonArray | InsertableTypedNodeUnsafe_2<TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaCore_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, true, unknown, boolean> & {
+create(data: boolean): boolean;
+}> | null, any, undefined>;
+}, false, readonly [() => typeof JsonObject, () => typeof JsonArray, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>], undefined>;
+
+// @alpha
+export const _APIExtractorWorkaroundJsonObjectBase: TreeNodeSchemaClass_2<"com.fluidframework.json.object", NodeKind_2.Map, TreeMapNodeUnsafe_2<readonly [() => typeof JsonObject, () => typeof JsonArray, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>]> & WithType_2<"com.fluidframework.json.object", NodeKind_2.Map, unknown>, {
+[Symbol.iterator](): Iterator<[string, string | number | JsonObject | JsonArray | InsertableTypedNodeUnsafe_2<TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaCore_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, true, unknown, boolean> & {
+create(data: boolean): boolean;
+}> | null], any, undefined>;
+}, false, readonly [() => typeof JsonObject, () => typeof JsonArray, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>], undefined>;
+
 // @public
 type ApplyKind<T, Kind extends FieldKind> = {
     [FieldKind.Required]: T;
@@ -337,6 +351,10 @@ export interface ITreeViewConfiguration<TSchema extends ImplicitFieldSchema = Im
     readonly schema: TSchema;
 }
 
+// @alpha
+export class JsonArray extends _APIExtractorWorkaroundJsonArrayBase {
+}
+
 // @alpha @sealed
 export interface JsonArrayNodeSchema extends JsonNodeSchemaBase<NodeKind.Array, "array"> {
     readonly items: JsonFieldSchema;
@@ -381,13 +399,23 @@ export interface JsonNodeSchemaBase<TNodeKind extends NodeKind, TJsonSchemaType
     readonly type: TJsonSchemaType;
 }
 
+// @alpha
+export class JsonObject extends _APIExtractorWorkaroundJsonObjectBase {
+}
+
 // @alpha @sealed
 export interface JsonObjectNodeSchema extends JsonNodeSchemaBase<NodeKind.Object, "object"> {
     readonly additionalProperties?: boolean;
     readonly properties: Record<string, JsonFieldSchema>;
     readonly required?: string[];
 }
 
+// @alpha
+export const JsonPrimitive: readonly [TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>];
+
+// @alpha (undocumented)
+export type JsonPrimitive = TreeNodeFromImplicitAllowedTypes<typeof JsonPrimitive>;
+
 // @alpha
 export type JsonRefPath = `#/$defs/${JsonSchemaId}`;
 
@@ -407,6 +435,12 @@ export type JsonTreeSchema = JsonFieldSchema & {
     readonly $defs: Record<JsonSchemaId, JsonNodeSchema>;
 };
 
+// @alpha
+export const JsonUnion: readonly [() => typeof JsonObject, () => typeof JsonArray, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.null", NodeKind_2.Leaf, null, null, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.boolean", NodeKind_2.Leaf, boolean, boolean, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.number", NodeKind_2.Leaf, number, number, true, unknown, never>, TreeNodeSchemaNonClass_2<"com.fluidframework.leaf.string", NodeKind_2.Leaf, string, string, true, unknown, never>];
+
+// @alpha (undocumented)
+export type JsonUnion = TreeNodeFromImplicitAllowedTypes<typeof JsonUnion>;
+
 // @alpha
 export interface JsonValidator {
     compile<Schema extends TSchema>(schema: Schema): SchemaValidationFunction<Schema>;
@@ -518,6 +552,9 @@ export type ReadSchema<TSchema extends ImplicitFieldSchema | UnsafeUnknownSchema
 TSchema
 ] extends [ImplicitFieldSchema] ? TSchema : ImplicitFieldSchema;
 
+// @alpha
+export const _RecursiveArrayWorkaroundJsonArray: FixRecursiveArraySchema<typeof _APIExtractorWorkaroundJsonArrayBase>;
+
 // @public @deprecated
 export type RestrictiveReadonlyRecord<K extends symbol | string, T> = {
     readonly [P in symbol | string]: P extends K ? T : never;

packages/dds/tree/src/index.ts

@@ -233,3 +233,13 @@ export {
 export type { MapNodeInsertableData } from "./simple-tree/index.js";
 
 export type { JsonCompatible, JsonCompatibleObject } from "./util/index.js";
+
+export {
+	JsonUnion,
+	JsonArray,
+	JsonObject,
+	JsonPrimitive,
+	_RecursiveArrayWorkaroundJsonArray,
+	_APIExtractorWorkaroundJsonObjectBase,
+	_APIExtractorWorkaroundJsonArrayBase,
+} from "./jsonDomainSchema.js";

packages/dds/tree/src/jsonDomainSchema.ts

@@ -0,0 +1,110 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+	SchemaFactory,
+	type AllowedTypes,
+	type FixRecursiveArraySchema,
+	type TreeNodeFromImplicitAllowedTypes,
+	type ValidateRecursiveSchema,
+} from "./simple-tree/index.js";
+
+const sf = new SchemaFactory("com.fluidframework.json");
+
+/**
+ * {@link AllowedTypes} for primitives types allowed in JSON.
+ * @alpha
+ */
+export const JsonPrimitive = [
+	sf.null,
+	sf.boolean,
+	sf.number,
+	sf.string,
+] as const satisfies AllowedTypes;
+
+/**
+ * @alpha
+ */
+export type JsonPrimitive = TreeNodeFromImplicitAllowedTypes<typeof JsonPrimitive>;
+
+/**
+ * {@link AllowedTypes} for any content allowed in the JSON domain.
+ * @example
+ * ```typescript
+ * const tree = TreeAlpha.importConcise(JsonUnion, { example: { nested: true }, value: 5 });
+ * ```
+ * @alpha
+ */
+export const JsonUnion = [() => JsonObject, () => JsonArray, ...JsonPrimitive] as const;
+
+/**
+ * @alpha
+ */
+export type JsonUnion = TreeNodeFromImplicitAllowedTypes<typeof JsonUnion>;
+
+/**
+ * Do not use. Exists only as a workaround for {@link https://github.com/microsoft/TypeScript/issues/59550} and {@link https://github.com/microsoft/rushstack/issues/4429}.
+ * @system @alpha
+ */
+export const _APIExtractorWorkaroundJsonObjectBase = sf.mapRecursive("object", JsonUnion);
+
+/**
+ * Arbitrary JSON object as a {@link TreeNode}.
+ * @remarks
+ * API of the tree node is more aligned with an es6 map than a JS object using its properties like a map.
+ * @example
+ * ```typescript
+ * // Due to TypeScript restrictions on recursive types, the constructor and be somewhat limiting.
+ * const fromArray = new JsonObject([["a", 0]]);
+ * // Using `importConcise` can work better for JSON data:
+ * const imported = TreeAlpha.importConcise(JsonObject, { a: 0 });
+ * // Node API is like a Map:
+ * const value = imported.get("a");
+ * ```
+ * @alpha
+ */
+export class JsonObject extends _APIExtractorWorkaroundJsonObjectBase {}
+{
+	type _check = ValidateRecursiveSchema<typeof JsonObject>;
+}
+
+/**
+ * D.ts bug workaround, see {@link FixRecursiveArraySchema}.
+ * @privateRemarks
+ * Normally this would reference JsonArray, but when combining this workaround with the other workaround, this has to reference the base type.
+ * Testing for this has to be in a separate package, and is thus part of experimental/framework/tree-react-api/src/test/importer.spec.ts.
+ * @system @alpha
+ */
+export declare const _RecursiveArrayWorkaroundJsonArray: FixRecursiveArraySchema<
+	typeof _APIExtractorWorkaroundJsonArrayBase
+>;
+
+/**
+ * Do not use. Exists only as a workaround for {@link https://github.com/microsoft/TypeScript/issues/59550} and {@link https://github.com/microsoft/rushstack/issues/4429}.
+ * @system @alpha
+ */
+export const _APIExtractorWorkaroundJsonArrayBase = sf.arrayRecursive("array", JsonUnion);
+
+/**
+ * Arbitrary JSON object as a {@link TreeNode}.
+ * @remarks
+ * This can be worked around by using {@link TreeAlpha.importConcise}.
+ * @example
+ * ```typescript
+ * // Due to TypeScript restrictions on recursive types, the constructor and be somewhat limiting.
+ * const usingConstructor = new JsonArray(["a", 0, new JsonArray([1])]);
+ * // Using `importConcise` can work better for JSON data:
+ * const imported = TreeAlpha.importConcise(JsonArray, ["a", 0, [1]]);
+ * // Node API is like an Array:
+ * const outer: JsonUnion = imported[0];
+ * assert(Tree.is(outer, JsonArray));
+ * const inner = outer[0];
+ * ```
+ * @alpha
+ */
+export class JsonArray extends _APIExtractorWorkaroundJsonArrayBase {}
+{
+	type _check = ValidateRecursiveSchema<typeof JsonArray>;
+}

packages/dds/tree/src/test/cursorTestSuite.ts

@@ -33,7 +33,7 @@ import {
 	SchemaFactory,
 	stringSchema,
 } from "../simple-tree/index.js";
-import { JsonArray, JsonObject } from "./json/index.js";
+import { JsonArray, JsonObject } from "../jsonDomainSchema.js";
 
 const sf = new SchemaFactory("Cursor Test Suite");
 

packages/dds/tree/src/test/domains/json/jsonCursor.bench.ts

@@ -41,7 +41,8 @@ import { clone } from "./jsObjectUtil.js";
 import { generateTwitterJsonByByteSize } from "./twitter.js";
 // eslint-disable-next-line import/no-internal-modules
 import { toStoredSchema } from "../../../simple-tree/toStoredSchema.js";
-import { JsonUnion, cursorToJsonObject, singleJsonCursor } from "../../json/index.js";
+import { cursorToJsonObject, singleJsonCursor } from "../../json/index.js";
+import { JsonUnion } from "../../../jsonDomainSchema.js";
 
 // Shared tree keys that map to the type used by the Twitter type/dataset
 export const TwitterKey = {

packages/dds/tree/src/test/feature-libraries/chunked-forest/basicChunk.spec.ts

@@ -42,7 +42,7 @@ import {
 } from "../../cursorTestSuite.js";
 import { numberSequenceField, validateChunkCursor } from "./fieldCursorTestUtilities.js";
 import { emptyShape, testData } from "./uniformChunkTestData.js";
-import { JsonObject } from "../../json/index.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 import { numberSchema } from "../../../simple-tree/index.js";
 
 const basicOnlyChunkCompressor: ChunkCompressor = {

packages/dds/tree/src/test/feature-libraries/chunked-forest/chunkEncodingEndToEnd.spec.ts

@@ -78,7 +78,7 @@ import type { Format } from "../../../feature-libraries/forest-summary/format.js
 import type { EncodedFieldBatch } from "../../../feature-libraries/chunked-forest/index.js";
 import { jsonSequenceRootSchema } from "../../sequenceRootUtils.js";
 // eslint-disable-next-line import/no-internal-modules
-import { JsonObject } from "../../json/jsonDomainSchema.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 import { brand } from "../../../util/index.js";
 // eslint-disable-next-line import/no-internal-modules
 import { ChunkedForest } from "../../../feature-libraries/chunked-forest/chunkedForest.js";

packages/dds/tree/src/test/feature-libraries/chunked-forest/chunkTree.spec.ts

@@ -57,8 +57,9 @@ import {
 	stringSchema,
 	toStoredSchema,
 } from "../../../simple-tree/index.js";
-import { fieldJsonCursor, JsonObject, singleJsonCursor } from "../../json/index.js";
+import { fieldJsonCursor, singleJsonCursor } from "../../json/index.js";
 import { testIdCompressor } from "../../utils.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 
 const builder = new SchemaFactory("chunkTree");
 const empty = builder.object("empty", {});

packages/dds/tree/src/test/feature-libraries/chunked-forest/uniformChunk.spec.ts

@@ -8,7 +8,7 @@ import { strict as assert } from "assert";
 import { BenchmarkType, benchmark } from "@fluid-tools/benchmark";
 
 import { EmptyKey, type ITreeCursorSynchronous } from "../../../core/index.js";
-import { cursorToJsonObject, singleJsonCursor, JsonObject } from "../../json/index.js";
+import { cursorToJsonObject, singleJsonCursor } from "../../json/index.js";
 import {
 	type ChunkShape,
 	TreeShape,
@@ -31,6 +31,7 @@ import { brand } from "../../../util/index.js";
 // eslint-disable-next-line import/no-internal-modules
 import { numberSchema, stringSchema } from "../../../simple-tree/leafNodeSchema.js";
 import { validateUsageError } from "../../utils.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 
 // Validate a few aspects of shapes that are easier to verify here than via checking the cursor.
 function validateShape(shape: ChunkShape): void {

packages/dds/tree/src/test/feature-libraries/chunked-forest/uniformChunkTestData.ts

@@ -14,7 +14,7 @@ import {
 import { numberSchema } from "../../../simple-tree/index.js";
 import { brand, makeArray } from "../../../util/index.js";
 import { type TestField, EmptyObject } from "../../cursorTestSuite.js";
-import { JsonArray, JsonObject } from "../../json/index.js";
+import { JsonArray, JsonObject } from "../../../jsonDomainSchema.js";
 
 export const emptyShape = new TreeShape(brand(EmptyObject.identifier), false, []);
 

packages/dds/tree/src/test/feature-libraries/default-field-kinds/defaultChangeFamily.spec.ts

@@ -36,7 +36,7 @@ import {
 	testIdCompressor,
 	testRevisionTagCodec,
 } from "../../utils.js";
-import { JsonObject } from "../../json/index.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 import { numberSchema, stringSchema } from "../../../simple-tree/index.js";
 
 const defaultChangeFamily = new DefaultChangeFamily(failCodecFamily);

packages/dds/tree/src/test/feature-libraries/flex-tree/lazyField.spec.ts

@@ -52,7 +52,8 @@ import {
 	stringSchema,
 } from "../../../simple-tree/index.js";
 import { getStoredSchema, toStoredSchema } from "../../../simple-tree/toStoredSchema.js";
-import { JsonObject, JsonUnion, singleJsonCursor } from "../../json/index.js";
+import { singleJsonCursor } from "../../json/index.js";
+import { JsonObject, JsonUnion } from "../../../jsonDomainSchema.js";
 
 const detachedField: FieldKey = brand("detached");
 const detachedFieldAnchor: FieldAnchor = { parent: undefined, fieldKey: detachedField };

packages/dds/tree/src/test/feature-libraries/flex-tree/lazyNode.spec.ts

@@ -22,9 +22,10 @@ import type { FlexTreeField, FlexTreeNode } from "../../../feature-libraries/ind
 
 import { readonlyTreeWithContent } from "./utils.js";
 import { cursorFromInsertable, SchemaFactory } from "../../../simple-tree/index.js";
-import { JsonObject, singleJsonCursor } from "../../json/index.js";
+import { singleJsonCursor } from "../../json/index.js";
 import { stringSchema } from "../../../simple-tree/leafNodeSchema.js";
 import { brand } from "../../../util/index.js";
+import { JsonObject } from "../../../jsonDomainSchema.js";
 
 /**
  * Test {@link LazyTreeNode} implementation.

packages/dds/tree/src/test/feature-libraries/schema-index/codec.spec.ts

@@ -20,11 +20,11 @@ import { type EncodingTestData, makeEncodingTestSuite } from "../../utils.js";
 // eslint-disable-next-line import/no-internal-modules
 import { toStoredSchema } from "../../../simple-tree/toStoredSchema.js";
 import { SchemaFactory } from "../../../simple-tree/index.js";
-import { jsonPrimitiveSchema, JsonUnion } from "../../json/index.js";
+import { JsonPrimitive, JsonUnion } from "../../../jsonDomainSchema.js";
 
 const codec = makeSchemaCodec({ jsonValidator: typeboxValidator });
 
-const schema2 = toStoredSchema(new SchemaFactory("testSchemas").optional(jsonPrimitiveSchema));
+const schema2 = toStoredSchema(new SchemaFactory("testSchemas").optional(JsonPrimitive));
 
 const testCases: EncodingTestData<TreeStoredSchema, Format> = {
 	successes: [

packages/dds/tree/src/test/feature-libraries/schema-index/schemaSummarizer.spec.ts

@@ -10,7 +10,7 @@ import {
 } from "../../../feature-libraries/schema-index/schemaSummarizer.js";
 import { toStoredSchema } from "../../../simple-tree/index.js";
 import { takeJsonSnapshot, useSnapshotDirectory } from "../../snapshots/index.js";
-import { JsonUnion } from "../../json/index.js";
+import { JsonUnion } from "../../../jsonDomainSchema.js";
 
 describe("schemaSummarizer", () => {
 	describe("encodeTreeSchema", () => {

packages/dds/tree/src/test/forestTestSuite.ts

@@ -58,7 +58,8 @@ import {
 	toStoredSchema,
 } from "../simple-tree/index.js";
 import { jsonSequenceRootSchema } from "./sequenceRootUtils.js";
-import { cursorToJsonObject, JsonArray, singleJsonCursor } from "./json/index.js";
+import { cursorToJsonObject, singleJsonCursor } from "./json/index.js";
+import { JsonArray } from "../jsonDomainSchema.js";
 
 /**
  * Configuration for the forest test suite.

packages/dds/tree/src/test/json/index.ts

@@ -8,4 +8,3 @@ export {
 	cursorToJsonObject,
 	fieldJsonCursor,
 } from "./jsonCursor.js";
-export { JsonUnion, JsonArray, JsonObject, jsonPrimitiveSchema } from "./jsonDomainSchema.js";

packages/dds/tree/src/test/json/jsonCursor.ts

@@ -22,7 +22,7 @@ import {
 } from "../../feature-libraries/index.js";
 import { brand, isReadonlyArray, type JsonCompatible } from "../../util/index.js";
 
-import { JsonArray, JsonObject } from "./jsonDomainSchema.js";
+import { JsonArray, JsonObject } from "../../jsonDomainSchema.js";
 import { isFluidHandle } from "@fluidframework/runtime-utils/internal";
 import {
 	booleanSchema,