Merge pull request #519 from json-schema-tools/fix/additional-items-t…

…raversed fix: additionalItems should always be traversed
json-schema-tools · Oct 6, 2022 · 1c4c45f · 1c4c45f
2 parents 26934b1 + cf5b7f9
commit 1c4c45f
Show file tree

Hide file tree

Showing 5 changed files with 107 additions and 39 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -24,12 +24,12 @@ aliases:
 
 defaults: &defaults
   working_directory: ~/project
+  docker:
+    - image: cimg/node:16.17.0
 
 jobs:
   test:
     <<: *defaults
-    docker:
-      - image: circleci/node:16
     steps:
       - checkout
       - restore_cache: *restore-deps-cache
@@ -41,8 +41,6 @@ jobs:
 
   build:
     <<: *defaults
-    docker:
-      - image: circleci/node:16
     steps:
       - checkout
       - restore_cache: *restore-deps-cache
@@ -53,8 +51,6 @@ jobs:
 
   release:
     <<: *defaults
-    docker:
-      - image: circleci/node:16
     steps:
       - checkout
       - restore_cache: *restore-deps-cache

diff --git a/package.json b/package.json
@@ -18,7 +18,7 @@
     "build": "tsc",
     "build:docs": "typedoc",
     "test": "jest --coverage",
-    "lint": "eslint . --ext .ts"
+    "lint": "eslint . --ext .ts --fix"
   },
   "author": "Zachary Belford<belfordz66@gmail.com>",
   "license": "Apache-2.0",

diff --git a/src/index.test.ts b/src/index.test.ts
@@ -278,41 +278,113 @@ describe("traverse", () => {
       expect(mockMutation).toHaveBeenCalledTimes(4);
     });
 
-    it("traverses additionalItems as boolean", () => {
-      const testSchema: any = {
-        additionalItems: true
-      };
-      const mockMutation = jest.fn((mockS) => mockS);
+    describe("additionalItems", () => {
+      it("as a boolean schema true", () => {
+        const testSchema: any = {
+          additionalItems: true
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
 
-      traverse(testSchema, mockMutation);
+        traverse(testSchema, mockMutation);
 
-      testCalls(mockMutation, testSchema.additionalItems);
-      testCalls(mockMutation, testSchema);
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema);
 
-      expect(mockMutation).toHaveBeenCalledTimes(2);
-    });
+        expect(mockMutation).toHaveBeenCalledTimes(2);
+      });
 
-    it("traverses additionalItems as schema", () => {
-      const testSchema: any = {
-        additionalItems: {
-          properties: {
-            c: {},
-            d: {},
+      it("as a boolean schema false", () => {
+        const testSchema: any = {
+          additionalItems: false
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
+
+        traverse(testSchema, mockMutation);
+
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema);
+
+        expect(mockMutation).toHaveBeenCalledTimes(2);
+      });
+
+      it("as a boolean schema true: items is array", () => {
+        const testSchema: any = {
+          items: [{ type: "string" }],
+          additionalItems: true
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
+
+        traverse(testSchema, mockMutation);
+
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema.items[0]);
+        testCalls(mockMutation, testSchema);
+
+        expect(mockMutation).toHaveBeenCalledTimes(3);
+      });
+
+      it("as a boolean schema false: items is single schema", () => {
+        const testSchema: any = {
+          items: { type: "string" },
+          additionalItems: false
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
+
+        traverse(testSchema, mockMutation);
+
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema.items);
+        testCalls(mockMutation, testSchema);
+
+        expect(mockMutation).toHaveBeenCalledTimes(3);
+      });
+
+      it("schema with nested subschemas: items is array", () => {
+        const testSchema: any = {
+          items: [{ type: "string" }],
+          additionalItems: {
+            properties: {
+              c: {},
+              d: {},
+            },
           },
-        },
-      };
-      const mockMutation = jest.fn((mockS) => mockS);
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
 
-      traverse(testSchema, mockMutation);
+        traverse(testSchema, mockMutation);
 
-      testCalls(mockMutation, testSchema.additionalItems);
-      testCalls(mockMutation, testSchema.additionalItems.properties.c);
-      testCalls(mockMutation, testSchema.additionalItems.properties.d);
-      testCalls(mockMutation, testSchema);
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema.items[0]);
+        testCalls(mockMutation, testSchema.additionalItems.properties.c);
+        testCalls(mockMutation, testSchema.additionalItems.properties.d);
+        testCalls(mockMutation, testSchema);
 
-      expect(mockMutation).toHaveBeenCalledTimes(4);
-    });
+        expect(mockMutation).toHaveBeenCalledTimes(5);
+      });
+
+      it("schema with nested subschemas: items is single schema", () => {
+        const testSchema: any = {
+          items: { type: "string" },
+          additionalItems: {
+            properties: {
+              c: {},
+              d: {},
+            },
+          },
+        };
+        const mockMutation = jest.fn((mockS) => mockS);
+
+        traverse(testSchema, mockMutation);
+
+        testCalls(mockMutation, testSchema.additionalItems);
+        testCalls(mockMutation, testSchema.items);
+        testCalls(mockMutation, testSchema.additionalItems.properties.c);
+        testCalls(mockMutation, testSchema.additionalItems.properties.d);
+        testCalls(mockMutation, testSchema);
 
+        expect(mockMutation).toHaveBeenCalledTimes(5);
+      });
+    });
   });
 
 

diff --git a/src/index.ts b/src/index.ts
@@ -187,8 +187,6 @@ export default function traverse(
       return result;
     });
   } else {
-    let itemsIsSingleSchema = false;
-
     if (schema.items) {
       if (schema.items instanceof Array) {
         mutableSchema.items = schema.items.map((x, i) => {
@@ -215,7 +213,6 @@ export default function traverse(
             mutableSchema.items = cycledMutableSchema;
           }
         } else {
-          itemsIsSingleSchema = true;
           mutableSchema.items = traverse(
             schema.items,
             mutation,
@@ -230,8 +227,11 @@ export default function traverse(
       }
     }
 
-    if (schema.additionalItems !== undefined && !!schema.additionalItems === true && !itemsIsSingleSchema) {
-      mutableSchema.additionalItems = rec(schema.additionalItems, [...pathStack, "additionalItems"]);
+    if (schema.additionalItems !== undefined) {
+      mutableSchema.additionalItems = rec(
+        schema.additionalItems,
+        [...pathStack, "additionalItems"]
+      );
     }
 
     if (schema.properties !== undefined) {

diff --git a/src/parent.test.ts b/src/parent.test.ts
@@ -1,6 +1,6 @@
 
 import traverse from "./";
-import { JSONSchema, JSONSchemaObject } from "@json-schema-tools/meta-schema";
+import { JSONSchema } from "@json-schema-tools/meta-schema";
 
 describe("traverse parent", () => {
   const test = (s: JSONSchema, parents: JSONSchema[]) => {