apify-schema-tools 2.0.4 → 2.1.0

package/test/apify.test.ts

@@ -1,10 +1,10 @@
 import { describe, expect, it } from "vitest";
 
-import { generateInputDefaultsTSFileContent } from "../src/apify.js";
-import type { ObjectSchema } from "../src/json-schemas";
+import { generateInputDefaultsTsFileContent } from "../src/apify.js";
+import type { ObjectSchema } from "../src/json-schemas.js";
 
 describe("Apify utilities", () => {
-	describe("generateInputDefaultsTSFileContent", () => {
+	describe("generateInputDefaultsTsFileContent", () => {
 		it("should generate the correct content with default values", async () => {
 			const inputSchema: ObjectSchema = {
 				type: "object",
@@ -16,7 +16,7 @@ describe("Apify utilities", () => {
 				required: ["name"],
 			};
 
-			const tsContent = generateInputDefaultsTSFileContent(inputSchema);
+			const tsContent = generateInputDefaultsTsFileContent(inputSchema);
 
 			expect(tsContent).toEqual(
 				`import { Actor } from "apify";
@@ -61,7 +61,7 @@ export function getInputWithDefaultValues(input?: Input | null): InputWithDefaul
 				required: ["name"],
 			};
 
-			const tsContent = generateInputDefaultsTSFileContent(inputSchema);
+			const tsContent = generateInputDefaultsTsFileContent(inputSchema);
 
 			expect(tsContent).toEqual(
 				`import { Actor } from "apify";
@@ -81,7 +81,9 @@ export function getInputWithDefaultValues(input?: Input | null): InputWithDefaul
 		return input as InputWithDefaults;
 	}
 	if (!input) {
-		throw new Error(\`Input is required, because the following fields are required: $\{REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT.join(", ")\}\`);
+		throw new Error(\`Input is required, because the following fields are required: $\{
+			REQUIRED_INPUT_FIELDS_WITHOUT_DEFAULT.join(", ")
+		\}\`);
 	}
 	return input ?? {} as Input;
 }

package/test/common.ts

@@ -5,14 +5,14 @@ export function getTestDir(suffix: string): string {
 	return join(__dirname, `test-temp-${suffix}`);
 }
 
-export function setupTestDirectory(dirPath: string) {
+export function setupTestDirectory(dirPath: string): void {
 	// Create directory if it doesn't exist, do nothing if it already exists
 	if (!existsSync(dirPath)) {
 		mkdirSync(dirPath, { recursive: true });
 	}
 }
 
-export function cleanupTestDirectory(dirPath: string) {
+export function cleanupTestDirectory(dirPath: string): void {
 	if (existsSync(dirPath)) {
 		rmSync(dirPath, { recursive: true, force: true });
 	}

package/test/configuration.test.ts

@@ -2,9 +2,9 @@ import { existsSync } from "node:fs";
 import type { ArgumentParser } from "argparse";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import {
+	addCommonCLIArgs,
 	type CommonCLIArgs,
 	Configuration,
-	addCommonCLIArgs,
 	parseConfigurationFromFileOrDefault,
 	writeConfigurationToPackageJson,
 } from "../src/configuration.js";

package/test/json-schemas.test.ts

@@ -1,14 +1,13 @@
-import { existsSync, mkdirSync, rmSync } from "node:fs";
 import { join } from "node:path";
 import { afterEach, describe, expect, it } from "vitest";
 
 import { writeFile } from "../src/filesystem.js";
 import {
-	type ObjectSchema,
 	compareDescriptions,
 	compareSchemas,
 	filterValidSchemaProperties,
 	mergeObjectSchemas,
+	type ObjectSchema,
 	readJsonSchema,
 	readJsonSchemaField,
 	writeSchemaToField,
@@ -29,7 +28,7 @@ describe("JSON schemas utilities", () => {
 			const wrapperSchema = {
 				type: "object",
 				title: "Wrapper Schema",
-				inputSchema: {
+				field1: {
 					type: "object",
 					properties: {
 						name: { type: "string" },
@@ -37,7 +36,7 @@ describe("JSON schemas utilities", () => {
 					},
 					required: ["name"],
 				},
-				outputSchema: {
+				field2: {
 					type: "object",
 					properties: {
 						result: { type: "string" },
@@ -47,9 +46,9 @@ describe("JSON schemas utilities", () => {
 
 			writeFile(filePath, JSON.stringify(wrapperSchema));
 
-			const inputSchema = readJsonSchemaField(filePath, "inputSchema");
+			const field1Schema = readJsonSchemaField(filePath, "field1");
 
-			expect(inputSchema).toEqual({
+			expect(field1Schema).toEqual({
 				type: "object",
 				properties: {
 					name: { type: "string" },
@@ -59,40 +58,6 @@ describe("JSON schemas utilities", () => {
 			});
 		});
 
-		it("should read another field from the same schema file", () => {
-			setupTestDirectory(TEST_DIR);
-			const filePath = join(TEST_DIR, "wrapper-schema.json");
-			const wrapperSchema = {
-				type: "object",
-				title: "Wrapper Schema",
-				inputSchema: {
-					type: "object",
-					properties: {
-						name: { type: "string" },
-						age: { type: "number" },
-					},
-					required: ["name"],
-				},
-				outputSchema: {
-					type: "object",
-					properties: {
-						result: { type: "string" },
-					},
-				},
-			};
-
-			writeFile(filePath, JSON.stringify(wrapperSchema));
-
-			const outputSchema = readJsonSchemaField(filePath, "outputSchema");
-
-			expect(outputSchema).toEqual({
-				type: "object",
-				properties: {
-					result: { type: "string" },
-				},
-			});
-		});
-
 		it("should throw error when field does not exist", () => {
 			setupTestDirectory(TEST_DIR);
 			const filePath = join(TEST_DIR, "schema-without-field.json");
@@ -369,6 +334,7 @@ describe("JSON schemas utilities", () => {
 					name: { type: "string" },
 					phone: { type: "integer" },
 				},
+				additionalProperties: true,
 			};
 
 			const additionalSchema: ObjectSchema = {
@@ -390,6 +356,7 @@ describe("JSON schemas utilities", () => {
 					phone: { type: "string" }, // phone type changed to string
 					address: { type: "string" },
 				},
+				additionalProperties: true,
 			});
 		});
 
@@ -443,6 +410,35 @@ describe("JSON schemas utilities", () => {
 				},
 			});
 		});
+
+		it("should override the additionalProperties setting", () => {
+			const baseSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: { type: "string" },
+				},
+				additionalProperties: true,
+			};
+
+			const additionalSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					age: { type: "number" },
+				},
+				additionalProperties: false, // this should override the base schema
+			};
+
+			const mergedSchema = mergeObjectSchemas(baseSchema, additionalSchema);
+
+			expect(mergedSchema).toEqual({
+				type: "object",
+				properties: {
+					name: { type: "string" },
+					age: { type: "number" },
+				},
+				additionalProperties: false, // additionalProperties is false now
+			});
+		});
 	});
 
 	describe("compareJsonSchemas", () => {
@@ -486,6 +482,26 @@ describe("JSON schemas utilities", () => {
 			expect(compareSchemas(schema1, schema2)).toBe(false);
 		});
 
+		it("returns false for schemas with different additionalProperties settings", () => {
+			const schema1: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: { type: "string" },
+				},
+				additionalProperties: true,
+			};
+
+			const schema2: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: { type: "string" },
+				},
+				additionalProperties: false, // different additionalProperties setting
+			};
+
+			expect(compareSchemas(schema1, schema2)).toBe(false);
+		});
+
 		it("returns true for schemas with different descriptions, if ignoreDescriptions is true", () => {
 			const schema1: ObjectSchema = {
 				type: "object",

package/test/typescript.test.ts

@@ -1,18 +1,17 @@
-import { afterEach, describe, expect, it } from "vitest";
-
-import { cleanupTestDirectory, getTestDir, setupTestDirectory } from "./common";
-
 import path from "node:path";
+import { afterEach, describe, expect, it } from "vitest";
 import { readFile } from "../src/filesystem.js";
-import type { ObjectSchema } from "../src/json-schemas";
+import type { ObjectSchema } from "../src/json-schemas.js";
 import {
 	compareTypescriptInterfaces,
 	jsonSchemaToTypeScriptInterface,
 	parseTypeScriptInterface,
 	readGeneratedTypeScriptFile,
 	serializeTypeScriptInterface,
+	type TypeScriptInterface,
 	writeTypeScriptFile,
 } from "../src/typescript.js";
+import { cleanupTestDirectory, getTestDir, setupTestDirectory } from "./common.js";
 
 const TEST_DIR = getTestDir("typescript");
 
@@ -60,6 +59,22 @@ describe("TypeScript files utilities", () => {
 								},
 							},
 							required: ["name"],
+							additionalProperties: {
+								type: "array",
+								items: {
+									type: "object",
+									properties: {
+										key: {
+											type: "string",
+										},
+										value: {
+											type: "number",
+										},
+									},
+									required: ["key", "value"],
+									additionalProperties: false,
+								},
+							},
 						},
 					},
 					features: {
@@ -109,6 +124,25 @@ describe("TypeScript files utilities", () => {
 								type: ["number", "string"],
 							},
 						},
+						additionalProperties: {
+							doc: undefined,
+							isRequired: true,
+							isArray: true,
+							properties: {
+								key: {
+									doc: undefined,
+									isRequired: true,
+									isArray: false,
+									type: "string",
+								},
+								value: {
+									doc: undefined,
+									isRequired: true,
+									isArray: false,
+									type: "number",
+								},
+							},
+						},
 					},
 					features: {
 						doc: undefined,
@@ -123,6 +157,12 @@ describe("TypeScript files utilities", () => {
 						type: ["boolean", "null"],
 					},
 				},
+				additionalProperties: {
+					doc: undefined,
+					isRequired: true,
+					isArray: false,
+					type: "unknown",
+				},
 			});
 		});
 	});
@@ -158,6 +198,12 @@ describe("TypeScript files utilities", () => {
 								type: ["number", "string"],
 							},
 						},
+						additionalProperties: {
+							doc: undefined,
+							isRequired: true,
+							isArray: false,
+							type: "boolean",
+						},
 					},
 					features: {
 						doc: undefined,
@@ -187,12 +233,60 @@ export interface Shape {
 		 * The hex color value
 		 */
 		value?: number | string;
+		[key: string]: boolean;
 	}[];
 	features: ("dotted" | "striped" | "solid")[];
 	/**
 	 * Whether the shape is nice
 	 */
 	isNice: boolean | null;
+}`);
+		});
+
+		it("should serialize complex additionalProperties", () => {
+			const tsSchema: TypeScriptInterface = {
+				doc: "Test schema with additional properties",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+				},
+				additionalProperties: {
+					doc: "Additional properties of any type",
+					isRequired: true,
+					isArray: true,
+					properties: {
+						key: {
+							doc: undefined,
+							isRequired: true,
+							isArray: false,
+							type: "string",
+						},
+						value: {
+							doc: undefined,
+							isRequired: true,
+							isArray: false,
+							type: "number",
+						},
+					},
+				},
+			};
+
+			expect(serializeTypeScriptInterface("Shape", tsSchema)).toBe(`\
+/**
+ * Test schema with additional properties
+ */
+export interface Shape {
+	name: string;
+	[key: string]: {
+		key: string;
+		value: number;
+	}[];
 }`);
 		});
 	});
@@ -211,6 +305,10 @@ export interface Shape {
 		 * The hex color value
 		 */
 		value?: number | string;
+		[key: string]: {
+			key: string;
+			value: number;
+		}[];
 	}[];
 	features: ("dotted" | "striped" | "solid")[];
 	/**
@@ -248,6 +346,26 @@ export interface Shape {
 								type: ["number", "string"],
 							},
 						},
+						additionalProperties: {
+							doc: undefined,
+							isRequired: true,
+							isArray: true,
+							properties: {
+								key: {
+									doc: undefined,
+									isRequired: true,
+									isArray: false,
+									type: "string",
+								},
+								value: {
+									doc: undefined,
+									isRequired: true,
+									isArray: false,
+									type: "number",
+								},
+							},
+							additionalProperties: undefined,
+						},
 					},
 					features: {
 						doc: undefined,
@@ -262,12 +380,13 @@ export interface Shape {
 						type: ["boolean", "null"],
 					},
 				},
+				additionalProperties: undefined,
 			});
 		});
 	});
 
 	describe("compareTypescriptInterfaces", () => {
-		const baseInterface = {
+		const baseInterface: TypeScriptInterface = {
 			doc: "Base interface",
 			isRequired: true,
 			isArray: false,
@@ -288,7 +407,7 @@ export interface Shape {
 		};
 
 		it("should return true for identical interfaces", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -307,7 +426,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -332,7 +451,7 @@ export interface Shape {
 
 		it("should return false for interfaces with different number of properties", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -363,7 +482,7 @@ export interface Shape {
 
 		it("should return false for interfaces with different property names", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -386,9 +505,40 @@ export interface Shape {
 			expect(compareTypescriptInterfaces(interfaceA, interfaceB)).toBe(false);
 		});
 
+		it("should return false for interfaces with different additionalProperties", () => {
+			const interfaceA = baseInterface;
+			const interfaceB: TypeScriptInterface = {
+				doc: "Test interface",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+				additionalProperties: {
+					doc: "Additional properties",
+					isRequired: true,
+					isArray: false,
+					type: "boolean",
+				},
+			};
+
+			expect(compareTypescriptInterfaces(interfaceA, interfaceB)).toBe(false);
+		});
+
 		it("should return false for properties with different types", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -413,7 +563,7 @@ export interface Shape {
 
 		it("should return false for properties with different isRequired values", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -438,7 +588,7 @@ export interface Shape {
 
 		it("should return false for properties with different isArray values", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -463,7 +613,7 @@ export interface Shape {
 
 		it("should return false for properties with different documentation when ignoreDocs is false", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -489,7 +639,7 @@ export interface Shape {
 
 		it("should return true for properties with different documentation when ignoreDocs is true", () => {
 			const interfaceA = baseInterface;
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: "Test interface",
 				isRequired: true,
 				isArray: false,
@@ -513,7 +663,7 @@ export interface Shape {
 		});
 
 		it("should handle enum properties correctly", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -526,7 +676,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -544,7 +694,7 @@ export interface Shape {
 		});
 
 		it("should return false for enum properties with different values", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -557,7 +707,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -575,7 +725,7 @@ export interface Shape {
 		});
 
 		it("should handle nested interface properties correctly", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -601,7 +751,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -632,7 +782,7 @@ export interface Shape {
 		});
 
 		it("should return false for nested interfaces with different structures", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -658,7 +808,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -684,7 +834,7 @@ export interface Shape {
 		});
 
 		it("should handle union types correctly", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -697,7 +847,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -715,7 +865,7 @@ export interface Shape {
 		});
 
 		it("should return false for union types with different order", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -728,7 +878,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -746,7 +896,7 @@ export interface Shape {
 		});
 
 		it("should return false when comparing interface property to basic type property", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -766,7 +916,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -784,7 +934,7 @@ export interface Shape {
 		});
 
 		it("should return false when comparing enum property to basic type property", () => {
-			const interfaceA = {
+			const interfaceA: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,
@@ -797,7 +947,7 @@ export interface Shape {
 					},
 				},
 			};
-			const interfaceB = {
+			const interfaceB: TypeScriptInterface = {
 				doc: undefined,
 				isRequired: true,
 				isArray: false,

package/tsconfig.json

@@ -7,7 +7,7 @@
 		"outDir": "dist",
 		"noUnusedLocals": false,
 		"skipLibCheck": true,
-		"lib": ["DOM"],
+		"lib": ["DOM", "ES2022"],
 		"baseUrl": ".",
 		"paths": {
 			"apify-schema-tools": ["src"]