Ai collab explicit

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

@@ -104,6 +104,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
 export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
     readonly custom?: TCustomMetadata;
     readonly description?: string | undefined;
+    readonly omitFromJson?: boolean | undefined;
 }
 
 // @public

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

@@ -72,6 +72,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
 export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
     readonly custom?: TCustomMetadata;
     readonly description?: string | undefined;
+    readonly omitFromJson?: boolean | undefined;
 }
 
 // @public

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

@@ -72,6 +72,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
 export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
     readonly custom?: TCustomMetadata;
     readonly description?: string | undefined;
+    readonly omitFromJson?: boolean | undefined;
 }
 
 // @public

packages/dds/tree/api-report/tree.legacy.public.api.md

@@ -72,6 +72,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
 export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
     readonly custom?: TCustomMetadata;
     readonly description?: string | undefined;
+    readonly omitFromJson?: boolean | undefined;
 }
 
 // @public

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

@@ -72,6 +72,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
 export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
     readonly custom?: TCustomMetadata;
     readonly description?: string | undefined;
+    readonly omitFromJson?: boolean | undefined;
 }
 
 // @public

packages/dds/tree/src/index.ts

@@ -159,6 +159,23 @@ export {
 	getJsonSchema,
 	type LazyItem,
 	type Unenforced,
+	type SimpleNodeSchemaBase,
+	type SimpleTreeSchema,
+	type SimpleNodeSchema,
+	type SimpleFieldSchema,
+	type SimpleLeafNodeSchema,
+	type SimpleMapNodeSchema,
+	type SimpleArrayNodeSchema,
+	type SimpleObjectNodeSchema,
+	normalizeFieldSchema,
+	isTreeNodeSchemaClass,
+	normalizeAllowedTypes,
+	getSimpleSchema,
+	numberSchema,
+	stringSchema,
+	booleanSchema,
+	handleSchema,
+	nullSchema,
 	type ReadonlyArrayNode,
 } from "./simple-tree/index.js";
 export {

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

@@ -63,6 +63,8 @@ const simpleSchemaCache = new WeakMap<TreeNodeSchema, SimpleTreeSchema>();
  *
  * @privateRemarks In the future, we may wish to move this to a more discoverable API location.
  * For now, while still an experimental API, it is surfaced as a free function.
+ *
+ * @internal
  */
 export function getSimpleSchema(schema: ImplicitFieldSchema): SimpleTreeSchema {
 	return getOrCreate(simpleSchemaCache, schema, () => toSimpleTreeSchema(schema));

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

@@ -27,7 +27,16 @@ export {
 } from "./schemaCreationUtilities.js";
 export { treeNodeApi, type TreeNodeApi } from "./treeNodeApi.js";
 export { createFromInsertable, cursorFromInsertable } from "./create.js";
-export type { SimpleTreeSchema } from "./simpleSchema.js";
+export type {
+	SimpleTreeSchema,
+	SimpleNodeSchema,
+	SimpleFieldSchema,
+	SimpleLeafNodeSchema,
+	SimpleMapNodeSchema,
+	SimpleArrayNodeSchema,
+	SimpleObjectNodeSchema,
+	SimpleNodeSchemaBase,
+} from "./simpleSchema.js";
 export {
 	type JsonSchemaId,
 	type JsonSchemaType,

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

@@ -5,11 +5,12 @@
 
 import type { ValueSchema } from "../../core/index.js";
 import type { NodeKind } from "../core/index.js";
-import type { FieldKind } from "../schemaTypes.js";
+import type { FieldKind, FieldSchemaMetadata } from "../schemaTypes.js";
 
 /**
  * Base interface for all {@link SimpleNodeSchema} implementations.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleNodeSchemaBase<TNodeKind extends NodeKind> {
@@ -24,6 +25,7 @@ export interface SimpleNodeSchemaBase<TNodeKind extends NodeKind> {
 /**
  * A {@link SimpleNodeSchema} for an object node.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleObjectNodeSchema extends SimpleNodeSchemaBase<NodeKind.Object> {
@@ -36,6 +38,7 @@ export interface SimpleObjectNodeSchema extends SimpleNodeSchemaBase<NodeKind.Ob
 /**
  * A {@link SimpleNodeSchema} for an array node.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleArrayNodeSchema extends SimpleNodeSchemaBase<NodeKind.Array> {
@@ -51,6 +54,7 @@ export interface SimpleArrayNodeSchema extends SimpleNodeSchemaBase<NodeKind.Arr
 /**
  * A {@link SimpleNodeSchema} for a map node.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleMapNodeSchema extends SimpleNodeSchemaBase<NodeKind.Map> {
@@ -66,6 +70,7 @@ export interface SimpleMapNodeSchema extends SimpleNodeSchemaBase<NodeKind.Map>
 /**
  * A {@link SimpleNodeSchema} for a leaf node.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleLeafNodeSchema extends SimpleNodeSchemaBase<NodeKind.Leaf> {
@@ -81,6 +86,8 @@ export interface SimpleLeafNodeSchema extends SimpleNodeSchemaBase<NodeKind.Leaf
  * @remarks This definition is incomplete, and references child types by identifiers.
  * To be useful, this generally needs to be used as a part of a complete {@link SimpleTreeSchema}, which
  * contains backing {@link SimpleTreeSchema.definitions} for each referenced identifier.
+ *
+ * @internal
  */
 export type SimpleNodeSchema =
 	| SimpleLeafNodeSchema
@@ -95,6 +102,7 @@ export type SimpleNodeSchema =
  * To be useful, this generally needs to be used as a part of a complete {@link SimpleTreeSchema}, which
  * contains backing {@link SimpleTreeSchema.definitions} for each referenced identifier.
  *
+ * @internal
  * @sealed
  */
 export interface SimpleFieldSchema {
@@ -112,9 +120,9 @@ export interface SimpleFieldSchema {
 	readonly allowedTypes: ReadonlySet<string>;
 
 	/**
-	 * {@inheritDoc FieldSchemaMetadata.description}
+	 * {@inheritDoc FieldSchemaMetadata}
 	 */
-	readonly description?: string | undefined;
+	readonly metadata?: FieldSchemaMetadata | undefined;
 }
 
 /**
@@ -123,7 +131,7 @@ export interface SimpleFieldSchema {
  * @remarks Contains the complete set of schema {@link SimpleTreeSchema.definitions} required to resolve references,
  * which are represented inline with identifiers.
  *
- * @sealed
+ * @internal
  */
 export interface SimpleTreeSchema extends SimpleFieldSchema {
 	/**

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

@@ -137,6 +137,10 @@ function convertObjectNodeSchema(schema: SimpleObjectNodeSchema): JsonObjectNode
 	const properties: Record<string, JsonFieldSchema> = {};
 	const required: string[] = [];
 	for (const [key, value] of Object.entries(schema.fields)) {
+		if (value.metadata?.omitFromJson === true) {
+			// Don't emit JSON Schema for fields which specify they should be excluded.
+			continue;
+		}
 		const allowedTypes: JsonSchemaRef[] = [];
 		for (const allowedType of value.allowedTypes) {
 			allowedTypes.push(createSchemaRef(allowedType));
@@ -150,8 +154,8 @@ function convertObjectNodeSchema(schema: SimpleObjectNodeSchema): JsonObjectNode
 					};
 
 		// Don't include "description" property at all if it's not present in the input.
-		if (value.description !== undefined) {
-			output.description = value.description;
+		if (value.metadata?.description !== undefined) {
+			output.description = value.metadata.description;
 		}
 
 		properties[key] = output;

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

@@ -43,7 +43,9 @@ export function toSimpleTreeSchema(schema: ImplicitFieldSchema): SimpleTreeSchem
 
 	// Include the "description" property only if it's present on the input.
 	if (normalizedSchema.metadata?.description !== undefined) {
-		output.description = normalizedSchema.metadata.description;
+		output.metadata = {
+			description: normalizedSchema.metadata.description,
+		};
 	}
 
 	return output;
@@ -140,9 +142,9 @@ function fieldSchemaToSimpleSchema(schema: FieldSchema): SimpleFieldSchema {
 		allowedTypes,
 	};
 
-	// Don't include "description" property at all if it's not present.
-	if (schema.metadata?.description !== undefined) {
-		result.description = schema.metadata.description;
+	// Don't include "metadata" property at all if it's not present.
+	if (schema.metadata !== undefined) {
+		result.metadata = schema.metadata;
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -51,7 +51,14 @@ export {
 	type NodeChangedData,
 	TreeBeta,
 	type TreeChangeEventsBeta,
+	type SimpleNodeSchemaBase,
 	type SimpleTreeSchema,
+	type SimpleNodeSchema,
+	type SimpleFieldSchema,
+	type SimpleLeafNodeSchema,
+	type SimpleMapNodeSchema,
+	type SimpleArrayNodeSchema,
+	type SimpleObjectNodeSchema,
 	type JsonSchemaId,
 	type JsonSchemaType,
 	type JsonObjectNodeSchema,
@@ -121,6 +128,7 @@ export {
 	type InsertableField,
 	type Insertable,
 	type UnsafeUnknownSchema,
+	normalizeAllowedTypes,
 } from "./schemaTypes.js";
 export {
 	getTreeNodeForField,

packages/dds/tree/src/simple-tree/leafNodeSchema.ts

@@ -63,8 +63,27 @@ function makeLeaf<Name extends string, const T extends ValueSchema>(
 }
 
 // Leaf schema shared between all SchemaFactory instances.
+/**
+ * @internal
+ */
 export const stringSchema = makeLeaf("string", ValueSchema.String);
+
+/**
+ * @internal
+ */
 export const numberSchema = makeLeaf("number", ValueSchema.Number);
+
+/**
+ * @internal
+ */
 export const booleanSchema = makeLeaf("boolean", ValueSchema.Boolean);
+
+/**
+ * @internal
+ */
 export const nullSchema = makeLeaf("null", ValueSchema.Null);
+
+/**
+ * @internal
+ */
 export const handleSchema = makeLeaf("handle", ValueSchema.FluidHandle);

packages/dds/tree/src/simple-tree/schemaTypes.ts

@@ -22,6 +22,7 @@ import { isLazy, type FlexListToUnion, type LazyItem } from "./flexList.js";
 
 /**
  * Returns true if the given schema is a {@link TreeNodeSchemaClass}, or otherwise false if it is a {@link TreeNodeSchemaNonClass}.
+ * @internal
  */
 export function isTreeNodeSchemaClass<
 	Name extends string,
@@ -230,6 +231,12 @@ export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
 	 * used as the `description` field.
 	 */
 	readonly description?: string | undefined;
+
+	/**
+	 * Whether or not to include the field in JSON output generated by `getJsonSchema` (experimental).
+	 * @defaultValue `false`
+	 */
+	readonly omitFromJson?: boolean | undefined;
 }
 
 /**
@@ -328,6 +335,8 @@ export class FieldSchema<
 
 /**
  * Normalizes a {@link ImplicitFieldSchema} to a {@link FieldSchema}.
+ *
+ * @internal
  */
 export function normalizeFieldSchema(schema: ImplicitFieldSchema): FieldSchema {
 	return schema instanceof FieldSchema
@@ -340,6 +349,8 @@ export function normalizeFieldSchema(schema: ImplicitFieldSchema): FieldSchema {
  *
  * @remarks Note: this must only be called after all required schemas have been declared, otherwise evaluation of
  * recursive schemas may fail.
+ *
+ * @internal
  */
 export function normalizeAllowedTypes(
 	types: ImplicitAllowedTypes,

packages/dds/tree/src/test/simple-tree/api/simpleSchemaToJsonSchema.spec.ts

@@ -172,12 +172,21 @@ describe("simpleSchemaToJsonSchema", () => {
 							"foo": {
 								kind: FieldKind.Optional,
 								allowedTypes: new Set<string>(["test.number"]),
-								description: "A number representing the concept of Foo.",
+								metadata: { description: "A number representing the concept of Foo." },
 							},
 							"bar": {
 								kind: FieldKind.Required,
 								allowedTypes: new Set<string>(["test.string"]),
-								description: "A string representing the concept of Bar.",
+								metadata: { description: "A string representing the concept of Bar." },
+							},
+							"id": {
+								kind: FieldKind.Identifier,
+								allowedTypes: new Set<string>(["test.string"]),
+								metadata: {
+									description: "Unique identifier for the test object.",
+									// IDs should be generated by the system. Hide from the JSON Schema.
+									omitFromJson: true,
+								},
 							},
 						},
 					},

packages/dds/tree/src/test/simple-tree/getSimpleSchema.spec.ts

@@ -33,8 +33,8 @@ describe("getSimpleSchema", () => {
 					},
 				],
 			]),
+			metadata: { description: "An optional string." },
 			allowedTypes: new Set(["com.fluidframework.leaf.string"]),
-			description: "An optional string.",
 		};
 		assert.deepEqual(actual, expected);
 	});

packages/framework/ai-collab/.eslintrc.cjs

@@ -8,7 +8,10 @@ module.exports = {
 	parserOptions: {
 		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
 	},
-	rules: {},
+	rules: {
+		"unicorn/switch-case-braces": "off",
+		"unicorn/no-array-for-each": "off",
+	},
 	overrides: [
 		{
 			// Rules only for test files