change: replace node.additionalItems by node.items for consistency

Author: sagold

src/SchemaNode.ts

@@ -114,19 +114,6 @@ export interface SchemaNode extends SchemaNodeMethodsType {
     $id?: string;
     $defs?: Record<string, SchemaNode>;
     $ref?: string;
-    /**
-     * # Items-object schema for additional items for drafts <= 2019-09
-     *
-     * - `additionalItems` is ignored when items-schema is not an array
-     *
-     *  If `items` is present, and its annotation result is a number, validation succeeds if every
-     *  instance element at an index greater than that number validates against "additionalItems".
-     *  Otherwise, if `items` is absent or its annotation result is the boolean true,
-     * `additionalItems` is ignored.
-     *
-     * [Specification](https://json-schema.org/draft/2019-09/draft-handrews-json-schema-02#additionalItems)
-     */
-    additionalItems?: SchemaNode;
     additionalProperties?: SchemaNode;
     allOf?: SchemaNode[];
     anyOf?: SchemaNode[];
@@ -136,9 +123,9 @@ export interface SchemaNode extends SchemaNodeMethodsType {
     else?: SchemaNode;
     if?: SchemaNode;
     /**
-     * # Items-array schema for all drafts
+     * # Items-array schema - for all drafts
      *
-     * - for drafts prior 2020-12 items[]-schema stored as `prefixItems`
+     * - for drafts prior 2020-12 `schema.items[]`-schema stored as `node.prefixItems`
      *
      * Validation succeeds if each element of the instance validates against the schema at the
      * same position, if any.
@@ -154,9 +141,9 @@ export interface SchemaNode extends SchemaNodeMethodsType {
      */
     prefixItems?: SchemaNode[];
     /**
-     * # Items-object schema
+     * # Items-object schema for additional array item - for all drafts
      *
-     * - ⚠️ For drafts < 2020-12, `additionalItems` is still used and must be referenced by `node.additionalItems`
+     * - for drafts prior 2020-12 `schema.additionalItems` object-schema stored as `node.items`
      *
      * Validation succeeds if each element of the instance not covered by `prefixItems` validates
      * against this schema.
@@ -167,6 +154,7 @@ export interface SchemaNode extends SchemaNodeMethodsType {
      *
      * [Docs](https://www.learnjsonschema.com/2020-12/applicator/items/)
      * | [Examples](https://json-schema.org/understanding-json-schema/reference/array#items)
+     * | [AdditionalItems Specification](https://json-schema.org/draft/2019-09/draft-handrews-json-schema-02#additionalItems)
      */
     items?: SchemaNode;
     not?: SchemaNode;

src/draft2019-09/keywords/additionalItems.ts

@@ -9,7 +9,7 @@ export const additionalItemsKeyword: Keyword = {
     keyword: "additionalItems",
     order: -10,
     parse: parseAdditionalItems,
-    addResolve: (node: SchemaNode) => node.additionalItems != null,
+    addResolve: (node: SchemaNode) => node.items != null,
     resolve: additionalItemsResolver,
     addValidate: ({ schema }) =>
         schema.additionalItems != null && schema.additionalItems !== true && Array.isArray(schema.items),
@@ -20,7 +20,7 @@ export const additionalItemsKeyword: Keyword = {
 export function parseAdditionalItems(node: SchemaNode) {
     const { schema, evaluationPath, schemaLocation } = node;
     if ((isObject(schema.additionalItems) || schema.additionalItems === true) && Array.isArray(schema.items)) {
-        node.additionalItems = node.compileSchema(
+        node.items = node.compileSchema(
             schema.additionalItems,
             `${evaluationPath}/additionalItems`,
             `${schemaLocation}/additionalItems`
@@ -32,7 +32,7 @@ function additionalItemsResolver({ node, key, data }: JsonSchemaResolverParams)
     if (Array.isArray(data)) {
         // @attention: items, etc should already have been tried
         const value = getValue(data, key);
-        const { node: childNode, error } = node.additionalItems.reduceNode(value);
+        const { node: childNode, error } = node.items.reduceNode(value);
         return childNode ?? error;
     }
 }
@@ -51,8 +51,8 @@ function validateAdditionalItems({ node, data, pointer, path }: JsonSchemaValida
     const errors: ValidationResult[] = [];
     for (let i = startIndex; i < data.length; i += 1) {
         const item = data[i];
-        if (node.additionalItems) {
-            const validationResult = validateNode(node.additionalItems, item, `${pointer}/${i}`, path);
+        if (node.items) {
+            const validationResult = validateNode(node.items, item, `${pointer}/${i}`, path);
             validationResult && errors.push(...validationResult);
         } else if (schema.additionalItems === false) {
             errors.push(

src/draft2019-09/keywords/items.ts

@@ -14,12 +14,12 @@ export const itemsKeyword: Keyword = {
 };
 
 function itemsResolver({ node, key }: JsonSchemaResolverParams) {
+    if (node.prefixItems?.[key as number]) {
+        return node.prefixItems[key as number];
+    }
     if (node.items) {
         return node.items;
     }
-    if (node.prefixItems[key as number]) {
-        return node.prefixItems[key as number];
-    }
 }
 
 export function parseItems(node: SchemaNode) {

src/draft2019-09/methods/getChildSchemaSelection.test.ts

@@ -167,6 +167,7 @@ describe("getChildSelection (2019)", () => {
 
             assert(!isJsonError(result));
             assert.deepEqual(result.length, 1);
+
             assert.deepEqual(
                 result.map((n) => n.schema),
                 [{ type: "string" }]

src/draft2019-09/methods/getChildSelection.ts

@@ -23,13 +23,12 @@ export function getChildSelection(node: SchemaNode, property: string | number):
     }
 
     // array.items[] exceeded (or undefined), but additionalItems specified
-    if (node.additionalItems && node.items == null) {
+    if (node.schema.additionalItems) {
         // we fallback to a string if no schema is defined - might be subject for configuration
-        // @ts-expect-error boolean schema
-        if (node.additionalItems.schema === true) {
+        if (node.schema.additionalItems === true) {
             return [node.compileSchema({ type: "string" })];
         }
-        return [node.additionalItems.resolveRef()];
+        return [node.items.resolveRef()];
     }
 
     // array.items[] exceeded

src/draft2019-09/methods/getData.ts

@@ -273,10 +273,10 @@ const TYPE: Record<string, (node: SchemaNode, data: unknown, opts: TemplateOptio
         // when there are no array-items are defined
         if (schema.items == null) {
             // => all items are additionalItems
-            if (node.additionalItems) {
+            if (node.items) {
                 const itemCount = Math.max(minItems, d.length);
                 for (let i = 0; i < itemCount; i += 1) {
-                    d[i] = node.additionalItems.getData(d[i], opts);
+                    d[i] = node.items.getData(d[i], opts);
                 }
             }
             return d || [];
@@ -289,7 +289,7 @@ const TYPE: Record<string, (node: SchemaNode, data: unknown, opts: TemplateOptio
             // build defined set of items
             const length = Math.max(minItems ?? 0, node.prefixItems.length);
             for (let i = 0; i < length; i += 1) {
-                const childNode = node.prefixItems[i] ?? node.additionalItems;
+                const childNode = node.prefixItems[i] ?? node.items;
                 if ((childNode && canResolveRef(childNode, opts)) || input[i] !== undefined) {
                     const result = childNode.getData(d[i] == null ? template[i] : d[i], opts);
                     if (result !== undefined) {
@@ -306,8 +306,7 @@ const TYPE: Record<string, (node: SchemaNode, data: unknown, opts: TemplateOptio
         }
 
         // build data from items-definition
-        // @ts-expect-error asd
-        if ((node.items && canResolveRef(node.items, opts)) || data?.length > 0) {
+        if ((node.items && canResolveRef(node.items, opts)) || (Array.isArray(data) && data?.length > 0)) {
             // @attention this should disable cache or break intended behaviour as we reset it after loop
             // intention: reset cache after each property. last call will add counters
             const cache = { ...opts.cache };

src/mergeNode.ts

@@ -89,7 +89,6 @@ export function mergeNode(a: SchemaNode, b?: SchemaNode, ...omit: string[]): Sch
         reducers: a.reducers.concat(b.reducers).filter(removeDuplicates).sort(sortCb),
         validators: a.validators.concat(b.validators).filter(removeDuplicates).sort(sortCb),
 
-        additionalItems: mergeNode(a.additionalItems, b.additionalItems),
         additionalProperties: mergeNode(a.additionalProperties, b.additionalProperties),
         contains: mergeNode(a.contains, b.contains),
         if: mergeNode(a.if, b.if),

src/methods/toSchemaNodes.ts

@@ -20,7 +20,6 @@ export function toSchemaNodes(node: SchemaNode | unknown, nodeList: SchemaNode[]
     nodeList.push(node);
 
     eachProperty(nodeList, node.$defs);
-    node.additionalItems && toSchemaNodes(node.additionalItems, nodeList);
     node.additionalProperties && toSchemaNodes(node.additionalProperties, nodeList);
     eachItem(nodeList, node.allOf);
     eachItem(nodeList, node.anyOf);