npm - @fluidframework/tree - Versions diffs - 2.0.0-dev-rc.1.0.0.224419 - Mend

@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2212) hide show

package/dist/feature-libraries/typed-schema/flexList.d.ts ADDED Viewed

@@ -0,0 +1,97 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ArrayToUnion } from "./typeUtils";
+/** Returns true iff the given item is a function and is not a `MarkedEager`. */
+export declare function isLazy<Item>(item: LazyItem<Item>): item is () => Item;
+/**
+ * Mark the given object as an eager item in a `FlexList`.
+ * @remarks
+ * This only has an effect on function objects that would otherwise be considered to be lazy items in a `FlexList`.
+ * @param t - The object to mark as eager.
+ * @returns `t`, marked as eager if applicable.
+ */
+export declare function markEager<T>(t: T): T;
+/**
+ * A flexible way to list values.
+ * Each item in the list can either be an "eager" **value** or a "lazy" **function that returns a value** (the latter allows cyclic references to work).
+ * @privateRemarks
+ * By default, items that are of type `"function"` will be considered lazy and all other items will be considered eager.
+ * To force a `"function"` item to be treated as an eager item, call `markEager` before putting it in the list.
+ * This is necessary e.g. when the eager list items are function types and the lazy items are functions that _return_ function types.
+ * `FlexList`s are processed by `normalizeFlexList` and `normalizeFlexListEager`.
+ * @beta
+ */
+export type FlexList<Item = unknown> = readonly LazyItem<Item>[];
+/**
+ * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are lazy.
+ */
+export declare function normalizeFlexListLazy<List extends FlexList>(t: List): FlexListToLazyArray<List>;
+/**
+ * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are eager.
+ */
+export declare function normalizeFlexListEager<List extends FlexList>(t: List): FlexListToNonLazyArray<List>;
+/**
+ * An "eager" or "lazy" Item in a `FlexList`.
+ * Lazy items are wrapped in a function to allow referring to themselves before they are declared.
+ * This makes recursive and co-recursive items possible.
+ * @beta
+ */
+export type LazyItem<Item = unknown> = Item | (() => Item);
+/**
+ * @internal
+ */
+export type NormalizedFlexList<Item> = readonly Item[];
+export type NormalizedLazyFlexList<Item> = (() => Item)[];
+/**
+ * Get the `Item` type from a `LazyItem<Item>`.
+ * @beta
+ */
+export type ExtractItemType<Item extends LazyItem> = Item extends () => infer Result ? Result : Item;
+/**
+ * @internal
+ */
+export type ExtractListItemType<List extends FlexList> = List extends FlexList<infer Item> ? Item : unknown;
+type NormalizeLazyItem<List extends LazyItem> = List extends () => unknown ? List : () => List;
+/**
+ * Normalize FlexList type to a non-lazy array.
+ */
+export type FlexListToNonLazyArray<List extends FlexList> = ArrayHasFixedLength<List> extends true ? ConstantFlexListToNonLazyArray<List> : NormalizedFlexList<ExtractListItemType<List>>;
+/**
+ * Normalize FlexList type to a union.
+ * @beta
+ */
+export type FlexListToUnion<TList extends FlexList> = ExtractItemType<ArrayToUnion<TList>>;
+/**
+ * Normalize FlexList type to a non-lazy array.
+ * @internal
+ */
+export type ConstantFlexListToNonLazyArray<List extends FlexList> = List extends readonly [
+    infer Head,
+    ...infer Tail
+] ? [ExtractItemType<Head>, ...ConstantFlexListToNonLazyArray<Tail>] : [];
+/**
+ * Detect if an array is a Tuple (fixed length) or unknown length.
+ *
+ * Types which many have one of multiple fixed lengths (like `[] | [0]`) count as having a fixed length.
+ *
+ * @remarks
+ * Type operations designed to work on tuples can often behave very badly on regular arrays.
+ * For example recursive patterns for processing them often just return the base case,
+ * losing all the type information.
+ */
+export type ArrayHasFixedLength<List extends readonly unknown[]> = number extends List["length"] ? false : true;
+/**
+ * Normalize FlexList type to a lazy array.
+ */
+export type FlexListToLazyArray<List extends FlexList> = ArrayHasFixedLength<List> extends true ? ConstantFlexListToLazyArray<List> : NormalizedLazyFlexList<ExtractListItemType<List>>;
+/**
+ * Normalize FlexList type to a lazy array.
+ */
+export type ConstantFlexListToLazyArray<List extends FlexList> = List extends readonly [
+    infer Head,
+    ...infer Tail
+] ? [NormalizeLazyItem<Head>, ...ConstantFlexListToLazyArray<Tail>] : [];
+export {};
+//# sourceMappingURL=flexList.d.ts.map

package/dist/feature-libraries/typed-schema/flexList.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"flexList.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/flexList.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAa3C,gFAAgF;AAChF,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,MAAM,IAAI,CAErE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CASpC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,GAAG,OAAO,IAAI,SAAS,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;AAEjE;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,SAAS,QAAQ,EAAE,CAAC,EAAE,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAO/F;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,SAAS,QAAQ,EAC3D,CAAC,EAAE,IAAI,GACL,sBAAsB,CAAC,IAAI,CAAC,CAQ9B;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,GAAG,OAAO,IAAI,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,IAAI,IAAI,SAAS,IAAI,EAAE,CAAC;AAEvD,MAAM,MAAM,sBAAsB,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,MAAM,MAAM,MAAM,GACjF,MAAM,GACN,IAAI,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,QAAQ,CAAC,MAAM,IAAI,CAAC,GACvF,IAAI,GACJ,OAAO,CAAC;AAEX,KAAK,iBAAiB,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM,IAAI,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,sBAAsB,CAAC,IAAI,SAAS,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,IAAI,GAC/F,8BAA8B,CAAC,IAAI,CAAC,GACpC,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,QAAQ,IAAI,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,MAAM,8BAA8B,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,SAAS;IACzF,MAAM,IAAI;IACV,GAAG,MAAM,IAAI;CACb,GACE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,8BAA8B,CAAC,IAAI,CAAC,CAAC,GAChE,EAAE,CAAC;AAEN;;;;;;;;;GASG;AAEH,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,SAAS,OAAO,EAAE,IAAI,MAAM,SAAS,IAAI,CAAC,QAAQ,CAAC,GAC7F,KAAK,GACL,IAAI,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,SAAS,IAAI,GAC5F,2BAA2B,CAAC,IAAI,CAAC,GACjC,sBAAsB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,2BAA2B,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,SAAS;IACtF,MAAM,IAAI;IACV,GAAG,MAAM,IAAI;CACb,GACE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC,GAC/D,EAAE,CAAC"}

package/dist/feature-libraries/typed-schema/flexList.js ADDED Viewed

@@ -0,0 +1,58 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeFlexListEager = exports.normalizeFlexListLazy = exports.markEager = exports.isLazy = void 0;
+/** A symbol used to identify a `MarkedEager`. */
+const flexListEager = Symbol("FlexList Eager");
+/** Returns true iff the given item is a function and is not a `MarkedEager`. */
+function isLazy(item) {
+    return typeof item === "function" && item[flexListEager] !== true;
+}
+exports.isLazy = isLazy;
+/**
+ * Mark the given object as an eager item in a `FlexList`.
+ * @remarks
+ * This only has an effect on function objects that would otherwise be considered to be lazy items in a `FlexList`.
+ * @param t - The object to mark as eager.
+ * @returns `t`, marked as eager if applicable.
+ */
+function markEager(t) {
+    return isLazy(t)
+        ? Object.defineProperty(t, flexListEager, {
+            value: true,
+            configurable: true,
+            enumerable: false,
+            writable: false,
+        })
+        : t;
+}
+exports.markEager = markEager;
+/**
+ * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are lazy.
+ */
+function normalizeFlexListLazy(t) {
+    return t.map((value) => {
+        if (isLazy(value)) {
+            return value;
+        }
+        return () => value;
+    });
+}
+exports.normalizeFlexListLazy = normalizeFlexListLazy;
+/**
+ * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are eager.
+ */
+function normalizeFlexListEager(t) {
+    const data = t.map((value) => {
+        if (isLazy(value)) {
+            return value();
+        }
+        return value;
+    });
+    return data;
+}
+exports.normalizeFlexListEager = normalizeFlexListEager;
+//# sourceMappingURL=flexList.js.map

package/dist/feature-libraries/typed-schema/flexList.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"flexList.js","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/flexList.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,iDAAiD;AACjD,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAU/C,gFAAgF;AAChF,SAAgB,MAAM,CAAO,IAAoB;IAChD,OAAO,OAAO,IAAI,KAAK,UAAU,IAAK,IAA6B,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;AAC7F,CAAC;AAFD,wBAEC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAI,CAAI;IAChC,OAAO,MAAM,CAAC,CAAC,CAAC;QACf,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,aAAa,EAAE;YACxC,KAAK,EAAE,IAAI;YACX,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;SACd,CAAC;QACJ,CAAC,CAAC,CAAC,CAAC;AACN,CAAC;AATD,8BASC;AAcD;;GAEG;AACH,SAAgB,qBAAqB,CAAwB,CAAO;IACnE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,EAAE;QAChC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;YAClB,OAAO,KAAK,CAAC;SACb;QACD,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC;IACpB,CAAC,CAA8B,CAAC;AACjC,CAAC;AAPD,sDAOC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CACrC,CAAO;IAEP,MAAM,IAAI,GAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAe,EAAE,EAAE;QAC1D,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;YAClB,OAAO,KAAK,EAAE,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO,IAAoC,CAAC;AAC7C,CAAC;AAVD,wDAUC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ArrayToUnion } from \"./typeUtils\";\n\n/** A symbol used to identify a `MarkedEager`. */\nconst flexListEager = Symbol(\"FlexList Eager\");\n\n/**\n * An object that has been marked as eager (as opposed to lazy) when used as an item in a `FlexList`.\n * It will be considered to be an eager item in a `FlexList` even if it is a function.\n */\ninterface MarkedEager {\n\t[flexListEager]: true;\n}\n\n/** Returns true iff the given item is a function and is not a `MarkedEager`. */\nexport function isLazy<Item>(item: LazyItem<Item>): item is () => Item {\n\treturn typeof item === \"function\" && (item as Partial<MarkedEager>)[flexListEager] !== true;\n}\n\n/**\n * Mark the given object as an eager item in a `FlexList`.\n * @remarks\n * This only has an effect on function objects that would otherwise be considered to be lazy items in a `FlexList`.\n * @param t - The object to mark as eager.\n * @returns `t`, marked as eager if applicable.\n */\nexport function markEager<T>(t: T): T {\n\treturn isLazy(t)\n\t\t? Object.defineProperty(t, flexListEager, {\n\t\t\t\tvalue: true,\n\t\t\t\tconfigurable: true,\n\t\t\t\tenumerable: false,\n\t\t\t\twritable: false,\n\t\t })\n\t\t: t;\n}\n\n/**\n * A flexible way to list values.\n * Each item in the list can either be an \"eager\" **value** or a \"lazy\" **function that returns a value** (the latter allows cyclic references to work).\n * @privateRemarks\n * By default, items that are of type `\"function\"` will be considered lazy and all other items will be considered eager.\n * To force a `\"function\"` item to be treated as an eager item, call `markEager` before putting it in the list.\n * This is necessary e.g. when the eager list items are function types and the lazy items are functions that _return_ function types.\n * `FlexList`s are processed by `normalizeFlexList` and `normalizeFlexListEager`.\n * @beta\n */\nexport type FlexList<Item = unknown> = readonly LazyItem<Item>[];\n\n/**\n * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are lazy.\n */\nexport function normalizeFlexListLazy<List extends FlexList>(t: List): FlexListToLazyArray<List> {\n\treturn t.map((value: LazyItem) => {\n\t\tif (isLazy(value)) {\n\t\t\treturn value;\n\t\t}\n\t\treturn () => value;\n\t}) as FlexListToLazyArray<List>;\n}\n\n/**\n * Given a `FlexList` of eager and lazy items, return an equivalent list where all items are eager.\n */\nexport function normalizeFlexListEager<List extends FlexList>(\n\tt: List,\n): FlexListToNonLazyArray<List> {\n\tconst data: readonly unknown[] = t.map((value: LazyItem) => {\n\t\tif (isLazy(value)) {\n\t\t\treturn value();\n\t\t}\n\t\treturn value;\n\t});\n\treturn data as FlexListToNonLazyArray<List>;\n}\n\n/**\n * An \"eager\" or \"lazy\" Item in a `FlexList`.\n * Lazy items are wrapped in a function to allow referring to themselves before they are declared.\n * This makes recursive and co-recursive items possible.\n * @beta\n */\nexport type LazyItem<Item = unknown> = Item | (() => Item);\n\n/**\n * @internal\n */\nexport type NormalizedFlexList<Item> = readonly Item[];\n\nexport type NormalizedLazyFlexList<Item> = (() => Item)[];\n\n/**\n * Get the `Item` type from a `LazyItem<Item>`.\n * @beta\n */\nexport type ExtractItemType<Item extends LazyItem> = Item extends () => infer Result\n\t? Result\n\t: Item;\n\n/**\n * @internal\n */\nexport type ExtractListItemType<List extends FlexList> = List extends FlexList<infer Item>\n\t? Item\n\t: unknown;\n\ntype NormalizeLazyItem<List extends LazyItem> = List extends () => unknown ? List : () => List;\n\n/**\n * Normalize FlexList type to a non-lazy array.\n */\nexport type FlexListToNonLazyArray<List extends FlexList> = ArrayHasFixedLength<List> extends true\n\t? ConstantFlexListToNonLazyArray<List>\n\t: NormalizedFlexList<ExtractListItemType<List>>;\n\n/**\n * Normalize FlexList type to a union.\n * @beta\n */\nexport type FlexListToUnion<TList extends FlexList> = ExtractItemType<ArrayToUnion<TList>>;\n\n/**\n * Normalize FlexList type to a non-lazy array.\n * @internal\n */\nexport type ConstantFlexListToNonLazyArray<List extends FlexList> = List extends readonly [\n\tinfer Head,\n\t...infer Tail,\n]\n\t? [ExtractItemType<Head>, ...ConstantFlexListToNonLazyArray<Tail>]\n\t: [];\n\n/**\n * Detect if an array is a Tuple (fixed length) or unknown length.\n *\n * Types which many have one of multiple fixed lengths (like `[] | [0]`) count as having a fixed length.\n *\n * @remarks\n * Type operations designed to work on tuples can often behave very badly on regular arrays.\n * For example recursive patterns for processing them often just return the base case,\n * losing all the type information.\n */\n// This works by determining if the length is `number` (and not a specific number).\nexport type ArrayHasFixedLength<List extends readonly unknown[]> = number extends List[\"length\"]\n\t? false\n\t: true;\n\n/**\n * Normalize FlexList type to a lazy array.\n */\nexport type FlexListToLazyArray<List extends FlexList> = ArrayHasFixedLength<List> extends true\n\t? ConstantFlexListToLazyArray<List>\n\t: NormalizedLazyFlexList<ExtractListItemType<List>>;\n\n/**\n * Normalize FlexList type to a lazy array.\n */\nexport type ConstantFlexListToLazyArray<List extends FlexList> = List extends readonly [\n\tinfer Head,\n\t...infer Tail,\n]\n\t? [NormalizeLazyItem<Head>, ...ConstantFlexListToLazyArray<Tail>]\n\t: [];\n"]}

package/dist/feature-libraries/typed-schema/index.d.ts ADDED Viewed

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { TreeNodeSchema, TreeFieldSchema, Any, allowedTypesToTypeSet, AllowedTypes, LazyTreeNodeSchema, LeafNodeSchema, MapNodeSchema, ObjectNodeSchema, FieldNodeSchema, FlexTreeSchema, Unenforced, AllowedTypeSet, MapFieldSchema, SchemaCollection, TreeNodeSchemaBase, Fields, schemaIsFieldNode, schemaIsLeaf, schemaIsMap, schemaIsObjectNode, NormalizeObjectNodeFields, NormalizeField, intoStoredSchema, allowedTypesSchemaSet, intoStoredSchemaCollection, } from "./typedTreeSchema";
+export { ViewSchema } from "./view";
+export { bannedFieldNames, fieldApiPrefixes, validateObjectNodeFieldName, SchemaLibraryData, SchemaLintConfiguration, aggregateSchemaLibraries, schemaLintDefault, } from "./schemaCollection";
+export { FlexList, markEager, FlexListToUnion, LazyItem, isLazy } from "./flexList";
+import * as InternalTypedSchemaTypes from "./internal";
+export { InternalTypedSchemaTypes };
+//# sourceMappingURL=index.d.ts.map

package/dist/feature-libraries/typed-schema/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,cAAc,EACd,eAAe,EACf,GAAG,EACH,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,UAAU,EACV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,MAAM,EACN,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,yBAAyB,EACzB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,0BAA0B,GAC1B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAChB,2BAA2B,EAC3B,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,iBAAiB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGpF,OAAO,KAAK,wBAAwB,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,CAAC"}

package/dist/feature-libraries/typed-schema/index.js ADDED Viewed

@@ -0,0 +1,61 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalTypedSchemaTypes = exports.isLazy = exports.markEager = exports.schemaLintDefault = exports.aggregateSchemaLibraries = exports.validateObjectNodeFieldName = exports.fieldApiPrefixes = exports.bannedFieldNames = exports.ViewSchema = exports.intoStoredSchemaCollection = exports.allowedTypesSchemaSet = exports.intoStoredSchema = exports.schemaIsObjectNode = exports.schemaIsMap = exports.schemaIsLeaf = exports.schemaIsFieldNode = exports.TreeNodeSchemaBase = exports.FieldNodeSchema = exports.ObjectNodeSchema = exports.MapNodeSchema = exports.LeafNodeSchema = exports.allowedTypesToTypeSet = exports.Any = exports.TreeFieldSchema = void 0;
+var typedTreeSchema_1 = require("./typedTreeSchema");
+Object.defineProperty(exports, "TreeFieldSchema", { enumerable: true, get: function () { return typedTreeSchema_1.TreeFieldSchema; } });
+Object.defineProperty(exports, "Any", { enumerable: true, get: function () { return typedTreeSchema_1.Any; } });
+Object.defineProperty(exports, "allowedTypesToTypeSet", { enumerable: true, get: function () { return typedTreeSchema_1.allowedTypesToTypeSet; } });
+Object.defineProperty(exports, "LeafNodeSchema", { enumerable: true, get: function () { return typedTreeSchema_1.LeafNodeSchema; } });
+Object.defineProperty(exports, "MapNodeSchema", { enumerable: true, get: function () { return typedTreeSchema_1.MapNodeSchema; } });
+Object.defineProperty(exports, "ObjectNodeSchema", { enumerable: true, get: function () { return typedTreeSchema_1.ObjectNodeSchema; } });
+Object.defineProperty(exports, "FieldNodeSchema", { enumerable: true, get: function () { return typedTreeSchema_1.FieldNodeSchema; } });
+Object.defineProperty(exports, "TreeNodeSchemaBase", { enumerable: true, get: function () { return typedTreeSchema_1.TreeNodeSchemaBase; } });
+Object.defineProperty(exports, "schemaIsFieldNode", { enumerable: true, get: function () { return typedTreeSchema_1.schemaIsFieldNode; } });
+Object.defineProperty(exports, "schemaIsLeaf", { enumerable: true, get: function () { return typedTreeSchema_1.schemaIsLeaf; } });
+Object.defineProperty(exports, "schemaIsMap", { enumerable: true, get: function () { return typedTreeSchema_1.schemaIsMap; } });
+Object.defineProperty(exports, "schemaIsObjectNode", { enumerable: true, get: function () { return typedTreeSchema_1.schemaIsObjectNode; } });
+Object.defineProperty(exports, "intoStoredSchema", { enumerable: true, get: function () { return typedTreeSchema_1.intoStoredSchema; } });
+Object.defineProperty(exports, "allowedTypesSchemaSet", { enumerable: true, get: function () { return typedTreeSchema_1.allowedTypesSchemaSet; } });
+Object.defineProperty(exports, "intoStoredSchemaCollection", { enumerable: true, get: function () { return typedTreeSchema_1.intoStoredSchemaCollection; } });
+var view_1 = require("./view");
+Object.defineProperty(exports, "ViewSchema", { enumerable: true, get: function () { return view_1.ViewSchema; } });
+var schemaCollection_1 = require("./schemaCollection");
+Object.defineProperty(exports, "bannedFieldNames", { enumerable: true, get: function () { return schemaCollection_1.bannedFieldNames; } });
+Object.defineProperty(exports, "fieldApiPrefixes", { enumerable: true, get: function () { return schemaCollection_1.fieldApiPrefixes; } });
+Object.defineProperty(exports, "validateObjectNodeFieldName", { enumerable: true, get: function () { return schemaCollection_1.validateObjectNodeFieldName; } });
+Object.defineProperty(exports, "aggregateSchemaLibraries", { enumerable: true, get: function () { return schemaCollection_1.aggregateSchemaLibraries; } });
+Object.defineProperty(exports, "schemaLintDefault", { enumerable: true, get: function () { return schemaCollection_1.schemaLintDefault; } });
+var flexList_1 = require("./flexList");
+Object.defineProperty(exports, "markEager", { enumerable: true, get: function () { return flexList_1.markEager; } });
+Object.defineProperty(exports, "isLazy", { enumerable: true, get: function () { return flexList_1.isLazy; } });
+// Below here are things that are used by the above, but not part of the desired API surface.
+const InternalTypedSchemaTypes = __importStar(require("./internal"));
+exports.InternalTypedSchemaTypes = InternalTypedSchemaTypes;
+//# sourceMappingURL=index.js.map

package/dist/feature-libraries/typed-schema/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,qDA2B2B;AAzB1B,kHAAA,eAAe,OAAA;AACf,sGAAA,GAAG,OAAA;AACH,wHAAA,qBAAqB,OAAA;AAGrB,iHAAA,cAAc,OAAA;AACd,gHAAA,aAAa,OAAA;AACb,mHAAA,gBAAgB,OAAA;AAChB,kHAAA,eAAe,OAAA;AAMf,qHAAA,kBAAkB,OAAA;AAElB,oHAAA,iBAAiB,OAAA;AACjB,+GAAA,YAAY,OAAA;AACZ,8GAAA,WAAW,OAAA;AACX,qHAAA,kBAAkB,OAAA;AAGlB,mHAAA,gBAAgB,OAAA;AAChB,wHAAA,qBAAqB,OAAA;AACrB,6HAAA,0BAA0B,OAAA;AAG3B,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AAEnB,uDAQ4B;AAP3B,oHAAA,gBAAgB,OAAA;AAChB,oHAAA,gBAAgB,OAAA;AAChB,+HAAA,2BAA2B,OAAA;AAG3B,4HAAA,wBAAwB,OAAA;AACxB,qHAAA,iBAAiB,OAAA;AAGlB,uCAAoF;AAAjE,qGAAA,SAAS,OAAA;AAA6B,kGAAA,MAAM,OAAA;AAE/D,6FAA6F;AAC7F,qEAAuD;AAC9C,4DAAwB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tTreeNodeSchema,\n\tTreeFieldSchema,\n\tAny,\n\tallowedTypesToTypeSet,\n\tAllowedTypes,\n\tLazyTreeNodeSchema,\n\tLeafNodeSchema,\n\tMapNodeSchema,\n\tObjectNodeSchema,\n\tFieldNodeSchema,\n\tFlexTreeSchema,\n\tUnenforced,\n\tAllowedTypeSet,\n\tMapFieldSchema,\n\tSchemaCollection,\n\tTreeNodeSchemaBase,\n\tFields,\n\tschemaIsFieldNode,\n\tschemaIsLeaf,\n\tschemaIsMap,\n\tschemaIsObjectNode,\n\tNormalizeObjectNodeFields,\n\tNormalizeField,\n\tintoStoredSchema,\n\tallowedTypesSchemaSet,\n\tintoStoredSchemaCollection,\n} from \"./typedTreeSchema\";\n\nexport { ViewSchema } from \"./view\";\n\nexport {\n\tbannedFieldNames,\n\tfieldApiPrefixes,\n\tvalidateObjectNodeFieldName,\n\tSchemaLibraryData,\n\tSchemaLintConfiguration,\n\taggregateSchemaLibraries,\n\tschemaLintDefault,\n} from \"./schemaCollection\";\n\nexport { FlexList, markEager, FlexListToUnion, LazyItem, isLazy } from \"./flexList\";\n\n// Below here are things that are used by the above, but not part of the desired API surface.\nimport * as InternalTypedSchemaTypes from \"./internal\";\nexport { InternalTypedSchemaTypes };\n"]}

package/dist/feature-libraries/typed-schema/internal.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { ArrayToUnion } from "./typeUtils";
+export { FlexList, LazyItem, ExtractItemType, FlexListToUnion } from "./flexList";
+//# sourceMappingURL=internal.d.ts.map

package/dist/feature-libraries/typed-schema/internal.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/internal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC"}

package/dist/feature-libraries/typed-schema/internal.js ADDED Viewed

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=internal.js.map

package/dist/feature-libraries/typed-schema/internal.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"internal.js","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/internal.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Used by public types, but not part of the desired API surface\n\nexport { ArrayToUnion } from \"./typeUtils\";\n\nexport { FlexList, LazyItem, ExtractItemType, FlexListToUnion } from \"./flexList\";\n"]}

package/dist/feature-libraries/typed-schema/schemaCollection.d.ts ADDED Viewed

@@ -0,0 +1,67 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Adapters, TreeAdapter } from "../../core";
+import { TreeFieldSchema, SchemaCollection } from "./typedTreeSchema";
+import { Sourced } from "./view";
+/**
+ * Schema data collected by a single SchemaBuilder (does not include referenced libraries).
+ * @internal
+ */
+export interface SchemaLibraryData extends SchemaCollection {
+    readonly name: string;
+    readonly adapters: Adapters;
+}
+/**
+ * Mutable adapter collection which records the associated factory.
+ * See {@link Adapters}.
+ */
+export interface SourcedAdapters {
+    readonly tree: (Sourced & TreeAdapter)[];
+}
+/**
+ * Allows opting into and out of errors for some unusual schema patterns which are usually bugs.
+ * @internal
+ */
+export interface SchemaLintConfiguration {
+    readonly rejectForbidden: boolean;
+    readonly rejectEmpty: boolean;
+}
+export declare const schemaLintDefault: SchemaLintConfiguration;
+/**
+ * Build and validate a SchemaCollection.
+ *
+ * As much as possible tries to detect anything that might be a mistake made by the schema author.
+ * This will error on some valid but probably never intended to be used patterns
+ * (like libraries with the same name, nodes which are impossible to create etc).
+ *
+ * @param name - Name of the resulting library.
+ * @param lintConfiguration - configuration for what errors to generate.
+ * @param libraries - Data to aggregate into the SchemaCollection.
+ * @param rootFieldSchema - Only validated: not included in the result.
+ *
+ * @privateRemarks
+ * This checks that input works with defaultSchemaPolicy.
+ * If support fo other policies is added, this will need to take in the policy.
+ */
+export declare function aggregateSchemaLibraries(name: string, lintConfiguration: SchemaLintConfiguration, libraries: Iterable<SchemaLibraryData>, rootFieldSchema?: TreeFieldSchema): SchemaLibraryData;
+/**
+ * Returns an array of descriptions of errors in the collection.
+ *
+ * As much as possible tries to detect anything that might be a mistake made by the schema author.
+ * This will error on some valid but probably never intended to be used patterns (like never nodes).
+ */
+export declare function validateSchemaCollection(lintConfiguration: SchemaLintConfiguration, collection: SchemaCollection, rootFieldSchema?: TreeFieldSchema): string[];
+export declare function validateRootField(lintConfiguration: SchemaLintConfiguration, collection: SchemaCollection, field: TreeFieldSchema, errors: string[]): void;
+export declare function validateField(lintConfiguration: SchemaLintConfiguration, collection: SchemaCollection, field: TreeFieldSchema, describeField: () => string, errors: string[]): void;
+/**
+ * Reserved field names to avoid collisions with the API.
+ */
+export declare const bannedFieldNames: Set<string>;
+/**
+ * Field names starting with these must not be followed by an upper case letter
+ */
+export declare const fieldApiPrefixes: Set<string>;
+export declare function validateObjectNodeFieldName(name: string, describeField: () => string, errors: string[]): void;
+//# sourceMappingURL=schemaCollection.d.ts.map

package/dist/feature-libraries/typed-schema/schemaCollection.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"schemaCollection.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/schemaCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,QAAQ,EAAE,WAAW,EAA4B,MAAM,YAAY,CAAC;AAI7E,OAAO,EACN,eAAe,EAGf,gBAAgB,EAKhB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAIjC;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,GAAG,WAAW,CAAC,EAAE,CAAC;CACzC;AAMD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC9B;AAED,eAAO,MAAM,iBAAiB,EAAE,uBAG/B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACvC,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,uBAAuB,EAC1C,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EACtC,eAAe,CAAC,EAAE,eAAe,GAC/B,iBAAiB,CAuDnB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,iBAAiB,EAAE,uBAAuB,EAC1C,UAAU,EAAE,gBAAgB,EAC5B,eAAe,CAAC,EAAE,eAAe,GAC/B,MAAM,EAAE,CA+CV;AAED,wBAAgB,iBAAiB,CAChC,iBAAiB,EAAE,uBAAuB,EAC1C,UAAU,EAAE,gBAAgB,EAC5B,KAAK,EAAE,eAAe,EACtB,MAAM,EAAE,MAAM,EAAE,GACd,IAAI,CAGN;AAED,wBAAgB,aAAa,CAC5B,iBAAiB,EAAE,uBAAuB,EAC1C,UAAU,EAAE,gBAAgB,EAC5B,KAAK,EAAE,eAAe,EACtB,aAAa,EAAE,MAAM,MAAM,EAC3B,MAAM,EAAE,MAAM,EAAE,GACd,IAAI,CA0CN;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,aAY3B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,gBAAgB,aAA4B,CAAC;AAE1D,wBAAgB,2BAA2B,CAC1C,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,MAAM,EAC3B,MAAM,EAAE,MAAM,EAAE,GACd,IAAI,CAyBN"}

package/dist/feature-libraries/typed-schema/schemaCollection.js ADDED Viewed

@@ -0,0 +1,207 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateObjectNodeFieldName = exports.fieldApiPrefixes = exports.bannedFieldNames = exports.validateField = exports.validateRootField = exports.validateSchemaCollection = exports.aggregateSchemaLibraries = exports.schemaLintDefault = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const util_1 = require("../../util");
+const default_schema_1 = require("../default-schema");
+const multiplicity_1 = require("../multiplicity");
+const typedTreeSchema_1 = require("./typedTreeSchema");
+const flexList_1 = require("./flexList");
+{
+}
+exports.schemaLintDefault = {
+    rejectForbidden: true,
+    rejectEmpty: true,
+};
+/**
+ * Build and validate a SchemaCollection.
+ *
+ * As much as possible tries to detect anything that might be a mistake made by the schema author.
+ * This will error on some valid but probably never intended to be used patterns
+ * (like libraries with the same name, nodes which are impossible to create etc).
+ *
+ * @param name - Name of the resulting library.
+ * @param lintConfiguration - configuration for what errors to generate.
+ * @param libraries - Data to aggregate into the SchemaCollection.
+ * @param rootFieldSchema - Only validated: not included in the result.
+ *
+ * @privateRemarks
+ * This checks that input works with defaultSchemaPolicy.
+ * If support fo other policies is added, this will need to take in the policy.
+ */
+function aggregateSchemaLibraries(name, lintConfiguration, libraries, rootFieldSchema) {
+    const nodeSchema = new Map();
+    const adapters = { tree: [] };
+    const errors = [];
+    const librarySet = new Set();
+    const libraryNames = new Set();
+    for (const library of libraries) {
+        if (librarySet.has(library)) {
+            // SchemaBuilder should ensure this doesn't happen, but include it here for completeness.
+            errors.push(`Duplicate library named "${library.name}"`);
+            continue;
+        }
+        librarySet.add(library);
+        if (libraryNames.has(library.name)) {
+            // This wouldn't break anything, but could make error messages confusing, so its better to avoid duplicates.
+            errors.push(`Found another library with name "${library.name}"`);
+        }
+        for (const [key, tree] of library.nodeSchema) {
+            // This check is an assert since if it fails, the other error messages would be incorrect.
+            (0, core_utils_1.assert)(tree.builder.name === library.name, 0x6a9 /* tree must be part by the library its in */);
+            const existing = nodeSchema.get(key);
+            if (existing !== undefined) {
+                errors.push(`Multiple tree schema for identifier "${key}". One from library "${existing.builder.name}" and one from "${tree.builder.name}"`);
+            }
+            else {
+                nodeSchema.set(key, tree);
+            }
+        }
+        for (const _adapter of library.adapters.tree ?? []) {
+            (0, util_1.fail)("Adapters not yet supported");
+        }
+    }
+    if (errors.length !== 0) {
+        (0, util_1.fail)(errors.join("\n"));
+    }
+    const result = { rootFieldSchema, nodeSchema, adapters, policy: default_schema_1.defaultSchemaPolicy };
+    const errors2 = validateSchemaCollection(lintConfiguration, result, rootFieldSchema);
+    if (errors2.length !== 0) {
+        (0, util_1.fail)(errors2.join("\n"));
+    }
+    return {
+        name,
+        nodeSchema,
+        adapters,
+    };
+}
+exports.aggregateSchemaLibraries = aggregateSchemaLibraries;
+/**
+ * Returns an array of descriptions of errors in the collection.
+ *
+ * As much as possible tries to detect anything that might be a mistake made by the schema author.
+ * This will error on some valid but probably never intended to be used patterns (like never nodes).
+ */
+function validateSchemaCollection(lintConfiguration, collection, rootFieldSchema) {
+    const errors = [];
+    // TODO: make this check specific to document schema. Replace check here for no tre or field schema (empty library).
+    if (collection.nodeSchema.size === 0 && lintConfiguration.rejectEmpty) {
+        errors.push("No tree schema are included, meaning no data can possibly be stored.");
+    }
+    // Validate that all schema referenced are included, and none are "never".
+    if (rootFieldSchema !== undefined) {
+        validateRootField(lintConfiguration, collection, rootFieldSchema, errors);
+    }
+    for (const [identifier, tree] of collection.nodeSchema) {
+        if (tree instanceof typedTreeSchema_1.MapNodeSchema) {
+            validateField(lintConfiguration, collection, tree.info, () => `Map fields of "${identifier}" schema from library "${tree.builder.name}"`, errors);
+            if (tree.info.kind.multiplicity === multiplicity_1.Multiplicity.Single) {
+                errors.push(`Map fields of "${identifier}" schema from library "${tree.builder.name}" has kind with multiplicity "Single". This is invalid since it requires all possible field keys to have a value under them.`);
+            }
+        }
+        else if (tree instanceof typedTreeSchema_1.LeafNodeSchema) {
+            // No validation for now.
+        }
+        else if (tree instanceof typedTreeSchema_1.FieldNodeSchema) {
+            const description = () => `Field node field of "${identifier}" schema from library "${tree.builder.name}"`;
+            validateField(lintConfiguration, collection, tree.info, description, errors);
+        }
+        else if (tree instanceof typedTreeSchema_1.ObjectNodeSchema) {
+            for (const [key, field] of tree.objectNodeFields) {
+                const description = () => `Object node field "${key}" of "${identifier}" schema from library "${tree.builder.name}"`;
+                validateField(lintConfiguration, collection, field, description, errors);
+                validateObjectNodeFieldName(key, description, errors);
+            }
+        }
+        else {
+            // TODO: there should be a common fallback that works for cases without a specialized implementation.
+            (0, util_1.fail)("unrecognized node kind");
+        }
+    }
+    // TODO: validate adapters
+    return errors;
+}
+exports.validateSchemaCollection = validateSchemaCollection;
+function validateRootField(lintConfiguration, collection, field, errors) {
+    const describeField = () => `Root field schema`;
+    validateField(lintConfiguration, collection, field, describeField, errors);
+}
+exports.validateRootField = validateRootField;
+function validateField(lintConfiguration, collection, field, describeField, errors) {
+    const types = field.allowedTypes;
+    if (!(0, typedTreeSchema_1.allowedTypesIsAny)(types)) {
+        const normalizedTypes = (0, flexList_1.normalizeFlexListEager)(types);
+        for (const type of normalizedTypes) {
+            const referenced = collection.nodeSchema.get(type.name);
+            if (referenced === undefined) {
+                errors.push(`${describeField()} references type "${type.name}" from library "${type.builder.name}" which is not defined. Perhaps another type was intended, or that library needs to be added.`);
+            }
+        }
+        if (types.length === 0 && lintConfiguration.rejectEmpty) {
+            errors.push(`${describeField()} requires children to have a type from a set of zero types. This means the field must always be empty.`);
+        }
+    }
+    const kind = field.kind;
+    const kindFromPolicy = default_schema_1.defaultSchemaPolicy.fieldKinds.get(kind.identifier);
+    if (kindFromPolicy === undefined) {
+        errors.push(`"${describeField()}" has unknown field kind "${kind.identifier}".`);
+    }
+    else if (kindFromPolicy !== kind) {
+        errors.push(`${describeField()} has field kind "${kind.identifier}" which isn't a reference to the default kind with that identifier.`);
+    }
+    else if (kind === default_schema_1.FieldKinds.forbidden) {
+        if (lintConfiguration.rejectForbidden) {
+            errors.push(`${describeField()} explicitly uses "forbidden" kind, which is not recommended.`);
+        }
+    } // else if (kind !== counter) {
+    // 	errors.push(
+    // 		`${describeField()} explicitly uses "counter" kind, which is finished.`,
+    // 	);
+    // }
+}
+exports.validateField = validateField;
+/**
+ * Reserved field names to avoid collisions with the API.
+ */
+exports.bannedFieldNames = new Set([
+    "constructor",
+    "context",
+    "is",
+    "on",
+    "parentField",
+    "schema",
+    "treeStatus",
+    "tryGetField",
+    "type",
+    "value",
+    "localNodeKey",
+]);
+/**
+ * Field names starting with these must not be followed by an upper case letter
+ */
+exports.fieldApiPrefixes = new Set(["set", "boxed"]);
+function validateObjectNodeFieldName(name, describeField, errors) {
+    // TODO: Remove conflicts between possible field keys and editable-tree API members.
+    const suggestion = "Pick a different field name to avoid property name collisions in the implementation. In the future this list of reserved names will be removed.";
+    if (exports.bannedFieldNames.has(name)) {
+        errors.push(`${describeField()} uses "${name}" one of the banned field names (${[
+            ...exports.bannedFieldNames,
+        ]}). ${suggestion}`);
+    }
+    for (const prefix of exports.fieldApiPrefixes) {
+        if (name.startsWith(prefix)) {
+            const afterPrefix = name.slice(prefix.length);
+            if (afterPrefix === (0, util_1.capitalize)(afterPrefix)) {
+                errors.push(`${describeField()} has name that starts with one of the banned prefixes (${[
+                    ...exports.fieldApiPrefixes,
+                ]}) followed by something other than a lowercase letter. ${suggestion}`);
+            }
+        }
+    }
+}
+exports.validateObjectNodeFieldName = validateObjectNodeFieldName;
+//# sourceMappingURL=schemaCollection.js.map

package/dist/feature-libraries/typed-schema/schemaCollection.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"schemaCollection.js","sourceRoot":"","sources":["../../../src/feature-libraries/typed-schema/schemaCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD,qCAAmE;AACnE,sDAAoE;AACpE,kDAA+C;AAC/C,uDAS2B;AAC3B,yCAAoD;AAsBpD;CAEC;AAWY,QAAA,iBAAiB,GAA4B;IACzD,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,IAAI;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,wBAAwB,CACvC,IAAY,EACZ,iBAA0C,EAC1C,SAAsC,EACtC,eAAiC;IAEjC,MAAM,UAAU,GAAkD,IAAI,GAAG,EAAE,CAAC;IAC5E,MAAM,QAAQ,GAAoB,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAE/C,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,UAAU,GAA2B,IAAI,GAAG,EAAE,CAAC;IACrD,MAAM,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;IAE5C,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE;QAChC,IAAI,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC5B,yFAAyF;YACzF,MAAM,CAAC,IAAI,CAAC,4BAA4B,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;YACzD,SAAS;SACT;QACD,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnC,4GAA4G;YAC5G,MAAM,CAAC,IAAI,CAAC,oCAAoC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;SACjE;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE;YAC7C,0FAA0F;YAC1F,IAAA,mBAAM,EACL,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAClC,KAAK,CAAC,6CAA6C,CACnD,CAAC;YACF,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC3B,MAAM,CAAC,IAAI,CACV,wCAAwC,GAAG,wBAAwB,QAAQ,CAAC,OAAO,CAAC,IAAI,mBAAmB,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAC/H,CAAC;aACF;iBAAM;gBACN,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aAC1B;SACD;QACD,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,EAAE;YACnD,IAAA,WAAI,EAAC,4BAA4B,CAAC,CAAC;SACnC;KACD;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,IAAA,WAAI,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KACxB;IAED,MAAM,MAAM,GAAG,EAAE,eAAe,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,oCAAmB,EAAE,CAAC;IACtF,MAAM,OAAO,GAAG,wBAAwB,CAAC,iBAAiB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;IACrF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACzB,IAAA,WAAI,EAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KACzB;IAED,OAAO;QACN,IAAI;QACJ,UAAU;QACV,QAAQ;KACR,CAAC;AACH,CAAC;AA5DD,4DA4DC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CACvC,iBAA0C,EAC1C,UAA4B,EAC5B,eAAiC;IAEjC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,oHAAoH;IACpH,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,IAAI,iBAAiB,CAAC,WAAW,EAAE;QACtE,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;KACpF;IAED,0EAA0E;IAC1E,IAAI,eAAe,KAAK,SAAS,EAAE;QAClC,iBAAiB,CAAC,iBAAiB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;KAC1E;IACD,KAAK,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC,UAAU,EAAE;QACvD,IAAI,IAAI,YAAY,+BAAa,EAAE;YAClC,aAAa,CACZ,iBAAiB,EACjB,UAAU,EACV,IAAI,CAAC,IAAI,EACT,GAAG,EAAE,CAAC,kBAAkB,UAAU,0BAA0B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAChF,MAAM,CACN,CAAC;YACF,IAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAA6B,KAAK,2BAAY,CAAC,MAAM,EAAE;gBAC1E,MAAM,CAAC,IAAI,CACV,kBAAkB,UAAU,0BAA0B,IAAI,CAAC,OAAO,CAAC,IAAI,8HAA8H,CACrM,CAAC;aACF;SACD;aAAM,IAAI,IAAI,YAAY,gCAAc,EAAE;YAC1C,yBAAyB;SACzB;aAAM,IAAI,IAAI,YAAY,iCAAe,EAAE;YAC3C,MAAM,WAAW,GAAG,GAAG,EAAE,CACxB,wBAAwB,UAAU,0BAA0B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;YAClF,aAAa,CAAC,iBAAiB,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;SAC7E;aAAM,IAAI,IAAI,YAAY,kCAAgB,EAAE;YAC5C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACjD,MAAM,WAAW,GAAG,GAAG,EAAE,CACxB,sBAAsB,GAAG,SAAS,UAAU,0BAA0B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBAC5F,aAAa,CAAC,iBAAiB,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;gBACzE,2BAA2B,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;aACtD;SACD;aAAM;YACN,qGAAqG;YACrG,IAAA,WAAI,EAAC,wBAAwB,CAAC,CAAC;SAC/B;KACD;IAED,0BAA0B;IAC1B,OAAO,MAAM,CAAC;AACf,CAAC;AAnDD,4DAmDC;AAED,SAAgB,iBAAiB,CAChC,iBAA0C,EAC1C,UAA4B,EAC5B,KAAsB,EACtB,MAAgB;IAEhB,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,mBAAmB,CAAC;IAChD,aAAa,CAAC,iBAAiB,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AAC5E,CAAC;AARD,8CAQC;AAED,SAAgB,aAAa,CAC5B,iBAA0C,EAC1C,UAA4B,EAC5B,KAAsB,EACtB,aAA2B,EAC3B,MAAgB;IAEhB,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,CAAC;IACjC,IAAI,CAAC,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAAE;QAC9B,MAAM,eAAe,GAAG,IAAA,iCAAsB,EAAC,KAAK,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;YACnC,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC7B,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,mBAC/C,IAAI,CAAC,OAAO,CAAC,IACd,+FAA+F,CAC/F,CAAC;aACF;SACD;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,CAAC,WAAW,EAAE;YACxD,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,wGAAwG,CAC1H,CAAC;SACF;KACD;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,MAAM,cAAc,GAAG,oCAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3E,IAAI,cAAc,KAAK,SAAS,EAAE;QACjC,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,EAAE,6BAA6B,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;KACjF;SAAM,IAAI,cAAc,KAAK,IAAI,EAAE;QACnC,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,oBACjB,IAAI,CAAC,UACN,qEAAqE,CACrE,CAAC;KACF;SAAM,IAAI,IAAI,KAAK,2BAAU,CAAC,SAAS,EAAE;QACzC,IAAI,iBAAiB,CAAC,eAAe,EAAE;YACtC,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,8DAA8D,CAChF,CAAC;SACF;KACD,CAAC,+BAA+B;IACjC,gBAAgB;IAChB,6EAA6E;IAC7E,MAAM;IACN,IAAI;AACL,CAAC;AAhDD,sCAgDC;AAED;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,GAAG,CAAC;IACvC,aAAa;IACb,SAAS;IACT,IAAI;IACJ,IAAI;IACJ,aAAa;IACb,QAAQ;IACR,YAAY;IACZ,aAAa;IACb,MAAM;IACN,OAAO;IACP,cAAc;CACd,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAE1D,SAAgB,2BAA2B,CAC1C,IAAY,EACZ,aAA2B,EAC3B,MAAgB;IAEhB,oFAAoF;IACpF,MAAM,UAAU,GACf,iJAAiJ,CAAC;IAEnJ,IAAI,wBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QAC/B,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,UAAU,IAAI,oCAAoC;YACnE,GAAG,wBAAgB;SACnB,MAAM,UAAU,EAAE,CACnB,CAAC;KACF;IAED,KAAK,MAAM,MAAM,IAAI,wBAAgB,EAAE;QACtC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC5B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,WAAW,KAAK,IAAA,iBAAU,EAAC,WAAW,CAAC,EAAE;gBAC5C,MAAM,CAAC,IAAI,CACV,GAAG,aAAa,EAAE,0DAA0D;oBAC3E,GAAG,wBAAgB;iBACnB,0DAA0D,UAAU,EAAE,CACvE,CAAC;aACF;SACD;KACD;AACF,CAAC;AA7BD,kEA6BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { Adapters, TreeAdapter, TreeNodeSchemaIdentifier } from \"../../core\";\nimport { capitalize, fail, requireAssignableTo } from \"../../util\";\nimport { defaultSchemaPolicy, FieldKinds } from \"../default-schema\";\nimport { Multiplicity } from \"../multiplicity\";\nimport {\n\tTreeFieldSchema,\n\tTreeNodeSchema,\n\tallowedTypesIsAny,\n\tSchemaCollection,\n\tMapNodeSchema,\n\tLeafNodeSchema,\n\tFieldNodeSchema,\n\tObjectNodeSchema,\n} from \"./typedTreeSchema\";\nimport { normalizeFlexListEager } from \"./flexList\";\nimport { Sourced } from \"./view\";\n\n// TODO: tests for this file\n\n/**\n * Schema data collected by a single SchemaBuilder (does not include referenced libraries).\n * @internal\n */\nexport interface SchemaLibraryData extends SchemaCollection {\n\treadonly name: string;\n\treadonly adapters: Adapters;\n}\n\n/**\n * Mutable adapter collection which records the associated factory.\n * See {@link Adapters}.\n */\nexport interface SourcedAdapters {\n\treadonly tree: (Sourced & TreeAdapter)[];\n}\n\n{\n\ttype _check = requireAssignableTo<SourcedAdapters, Adapters>;\n}\n\n/**\n * Allows opting into and out of errors for some unusual schema patterns which are usually bugs.\n * @internal\n */\nexport interface SchemaLintConfiguration {\n\treadonly rejectForbidden: boolean;\n\treadonly rejectEmpty: boolean;\n}\n\nexport const schemaLintDefault: SchemaLintConfiguration = {\n\trejectForbidden: true,\n\trejectEmpty: true,\n};\n\n/**\n * Build and validate a SchemaCollection.\n *\n * As much as possible tries to detect anything that might be a mistake made by the schema author.\n * This will error on some valid but probably never intended to be used patterns\n * (like libraries with the same name, nodes which are impossible to create etc).\n *\n * @param name - Name of the resulting library.\n * @param lintConfiguration - configuration for what errors to generate.\n * @param libraries - Data to aggregate into the SchemaCollection.\n * @param rootFieldSchema - Only validated: not included in the result.\n *\n * @privateRemarks\n * This checks that input works with defaultSchemaPolicy.\n * If support fo other policies is added, this will need to take in the policy.\n */\nexport function aggregateSchemaLibraries(\n\tname: string,\n\tlintConfiguration: SchemaLintConfiguration,\n\tlibraries: Iterable<SchemaLibraryData>,\n\trootFieldSchema?: TreeFieldSchema,\n): SchemaLibraryData {\n\tconst nodeSchema: Map<TreeNodeSchemaIdentifier, TreeNodeSchema> = new Map();\n\tconst adapters: SourcedAdapters = { tree: [] };\n\n\tconst errors: string[] = [];\n\tconst librarySet: Set<SchemaLibraryData> = new Set();\n\tconst libraryNames: Set<string> = new Set();\n\n\tfor (const library of libraries) {\n\t\tif (librarySet.has(library)) {\n\t\t\t// SchemaBuilder should ensure this doesn't happen, but include it here for completeness.\n\t\t\terrors.push(`Duplicate library named \"${library.name}\"`);\n\t\t\tcontinue;\n\t\t}\n\t\tlibrarySet.add(library);\n\t\tif (libraryNames.has(library.name)) {\n\t\t\t// This wouldn't break anything, but could make error messages confusing, so its better to avoid duplicates.\n\t\t\terrors.push(`Found another library with name \"${library.name}\"`);\n\t\t}\n\n\t\tfor (const [key, tree] of library.nodeSchema) {\n\t\t\t// This check is an assert since if it fails, the other error messages would be incorrect.\n\t\t\tassert(\n\t\t\t\ttree.builder.name === library.name,\n\t\t\t\t0x6a9 /* tree must be part by the library its in */,\n\t\t\t);\n\t\t\tconst existing = nodeSchema.get(key);\n\t\t\tif (existing !== undefined) {\n\t\t\t\terrors.push(\n\t\t\t\t\t`Multiple tree schema for identifier \"${key}\". One from library \"${existing.builder.name}\" and one from \"${tree.builder.name}\"`,\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tnodeSchema.set(key, tree);\n\t\t\t}\n\t\t}\n\t\tfor (const _adapter of library.adapters.tree ?? []) {\n\t\t\tfail(\"Adapters not yet supported\");\n\t\t}\n\t}\n\n\tif (errors.length !== 0) {\n\t\tfail(errors.join(\"\\n\"));\n\t}\n\n\tconst result = { rootFieldSchema, nodeSchema, adapters, policy: defaultSchemaPolicy };\n\tconst errors2 = validateSchemaCollection(lintConfiguration, result, rootFieldSchema);\n\tif (errors2.length !== 0) {\n\t\tfail(errors2.join(\"\\n\"));\n\t}\n\n\treturn {\n\t\tname,\n\t\tnodeSchema,\n\t\tadapters,\n\t};\n}\n\n/**\n * Returns an array of descriptions of errors in the collection.\n *\n * As much as possible tries to detect anything that might be a mistake made by the schema author.\n * This will error on some valid but probably never intended to be used patterns (like never nodes).\n */\nexport function validateSchemaCollection(\n\tlintConfiguration: SchemaLintConfiguration,\n\tcollection: SchemaCollection,\n\trootFieldSchema?: TreeFieldSchema,\n): string[] {\n\tconst errors: string[] = [];\n\n\t// TODO: make this check specific to document schema. Replace check here for no tre or field schema (empty library).\n\tif (collection.nodeSchema.size === 0 && lintConfiguration.rejectEmpty) {\n\t\terrors.push(\"No tree schema are included, meaning no data can possibly be stored.\");\n\t}\n\n\t// Validate that all schema referenced are included, and none are \"never\".\n\tif (rootFieldSchema !== undefined) {\n\t\tvalidateRootField(lintConfiguration, collection, rootFieldSchema, errors);\n\t}\n\tfor (const [identifier, tree] of collection.nodeSchema) {\n\t\tif (tree instanceof MapNodeSchema) {\n\t\t\tvalidateField(\n\t\t\t\tlintConfiguration,\n\t\t\t\tcollection,\n\t\t\t\ttree.info,\n\t\t\t\t() => `Map fields of \"${identifier}\" schema from library \"${tree.builder.name}\"`,\n\t\t\t\terrors,\n\t\t\t);\n\t\t\tif ((tree.info.kind.multiplicity as Multiplicity) === Multiplicity.Single) {\n\t\t\t\terrors.push(\n\t\t\t\t\t`Map fields of \"${identifier}\" schema from library \"${tree.builder.name}\" has kind with multiplicity \"Single\". This is invalid since it requires all possible field keys to have a value under them.`,\n\t\t\t\t);\n\t\t\t}\n\t\t} else if (tree instanceof LeafNodeSchema) {\n\t\t\t// No validation for now.\n\t\t} else if (tree instanceof FieldNodeSchema) {\n\t\t\tconst description = () =>\n\t\t\t\t`Field node field of \"${identifier}\" schema from library \"${tree.builder.name}\"`;\n\t\t\tvalidateField(lintConfiguration, collection, tree.info, description, errors);\n\t\t} else if (tree instanceof ObjectNodeSchema) {\n\t\t\tfor (const [key, field] of tree.objectNodeFields) {\n\t\t\t\tconst description = () =>\n\t\t\t\t\t`Object node field \"${key}\" of \"${identifier}\" schema from library \"${tree.builder.name}\"`;\n\t\t\t\tvalidateField(lintConfiguration, collection, field, description, errors);\n\t\t\t\tvalidateObjectNodeFieldName(key, description, errors);\n\t\t\t}\n\t\t} else {\n\t\t\t// TODO: there should be a common fallback that works for cases without a specialized implementation.\n\t\t\tfail(\"unrecognized node kind\");\n\t\t}\n\t}\n\n\t// TODO: validate adapters\n\treturn errors;\n}\n\nexport function validateRootField(\n\tlintConfiguration: SchemaLintConfiguration,\n\tcollection: SchemaCollection,\n\tfield: TreeFieldSchema,\n\terrors: string[],\n): void {\n\tconst describeField = () => `Root field schema`;\n\tvalidateField(lintConfiguration, collection, field, describeField, errors);\n}\n\nexport function validateField(\n\tlintConfiguration: SchemaLintConfiguration,\n\tcollection: SchemaCollection,\n\tfield: TreeFieldSchema,\n\tdescribeField: () => string,\n\terrors: string[],\n): void {\n\tconst types = field.allowedTypes;\n\tif (!allowedTypesIsAny(types)) {\n\t\tconst normalizedTypes = normalizeFlexListEager(types);\n\t\tfor (const type of normalizedTypes) {\n\t\t\tconst referenced = collection.nodeSchema.get(type.name);\n\t\t\tif (referenced === undefined) {\n\t\t\t\terrors.push(\n\t\t\t\t\t`${describeField()} references type \"${type.name}\" from library \"${\n\t\t\t\t\t\ttype.builder.name\n\t\t\t\t\t}\" which is not defined. Perhaps another type was intended, or that library needs to be added.`,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t\tif (types.length === 0 && lintConfiguration.rejectEmpty) {\n\t\t\terrors.push(\n\t\t\t\t`${describeField()} requires children to have a type from a set of zero types. This means the field must always be empty.`,\n\t\t\t);\n\t\t}\n\t}\n\n\tconst kind = field.kind;\n\tconst kindFromPolicy = defaultSchemaPolicy.fieldKinds.get(kind.identifier);\n\tif (kindFromPolicy === undefined) {\n\t\terrors.push(`\"${describeField()}\" has unknown field kind \"${kind.identifier}\".`);\n\t} else if (kindFromPolicy !== kind) {\n\t\terrors.push(\n\t\t\t`${describeField()} has field kind \"${\n\t\t\t\tkind.identifier\n\t\t\t}\" which isn't a reference to the default kind with that identifier.`,\n\t\t);\n\t} else if (kind === FieldKinds.forbidden) {\n\t\tif (lintConfiguration.rejectForbidden) {\n\t\t\terrors.push(\n\t\t\t\t`${describeField()} explicitly uses \"forbidden\" kind, which is not recommended.`,\n\t\t\t);\n\t\t}\n\t} // else if (kind !== counter) {\n\t// \terrors.push(\n\t// \t\t`${describeField()} explicitly uses \"counter\" kind, which is finished.`,\n\t// \t);\n\t// }\n}\n\n/**\n * Reserved field names to avoid collisions with the API.\n */\nexport const bannedFieldNames = new Set([\n\t\"constructor\",\n\t\"context\",\n\t\"is\",\n\t\"on\",\n\t\"parentField\",\n\t\"schema\",\n\t\"treeStatus\",\n\t\"tryGetField\",\n\t\"type\",\n\t\"value\",\n\t\"localNodeKey\",\n]);\n\n/**\n * Field names starting with these must not be followed by an upper case letter\n */\nexport const fieldApiPrefixes = new Set([\"set\", \"boxed\"]);\n\nexport function validateObjectNodeFieldName(\n\tname: string,\n\tdescribeField: () => string,\n\terrors: string[],\n): void {\n\t// TODO: Remove conflicts between possible field keys and editable-tree API members.\n\tconst suggestion =\n\t\t\"Pick a different field name to avoid property name collisions in the implementation. In the future this list of reserved names will be removed.\";\n\n\tif (bannedFieldNames.has(name)) {\n\t\terrors.push(\n\t\t\t`${describeField()} uses \"${name}\" one of the banned field names (${[\n\t\t\t\t...bannedFieldNames,\n\t\t\t]}). ${suggestion}`,\n\t\t);\n\t}\n\n\tfor (const prefix of fieldApiPrefixes) {\n\t\tif (name.startsWith(prefix)) {\n\t\t\tconst afterPrefix = name.slice(prefix.length);\n\t\t\tif (afterPrefix === capitalize(afterPrefix)) {\n\t\t\t\terrors.push(\n\t\t\t\t\t`${describeField()} has name that starts with one of the banned prefixes (${[\n\t\t\t\t\t\t...fieldApiPrefixes,\n\t\t\t\t\t]}) followed by something other than a lowercase letter. ${suggestion}`,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/feature-libraries/typed-schema/typeUtils.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Utilities for manipulating types.
+ */
+/**
+ * Convert a object type into the type of a ReadonlyMap from field name to value.
+ */
+export type ObjectToMap<ObjectMap, MapKey extends number | string, MapValue> = ReadonlyMap<MapKey, MapValue> & {
+    get<TKey extends keyof ObjectMap>(key: TKey): ObjectMap[TKey];
+};
+export declare function objectToMapTyped<ObjectMap extends Record<MapKey, MapValue>, MapKey extends string, MapValue>(objectMap: ObjectMap): ObjectToMap<ObjectMap, MapKey, MapValue>;
+/**
+ * Convert a Array type into the type of ReadonlySet.
+ *
+ * Same as `keyof ListToKeys<T, unknown>` but work for values that are not valid keys.
+ * @beta
+ */
+export type ArrayToUnion<T extends readonly unknown[]> = T extends readonly (infer TValue)[] ? TValue : never;
+//# sourceMappingURL=typeUtils.d.ts.map