apify-schema-tools 3.1.0 → 3.2.1

package/test/apify.test.ts

@@ -1,9 +1,417 @@
 import { describe, expect, it } from "vitest";
 
-import { generateInputDefaultsTsFileContent } from "../src/apify.js";
-import type { ObjectSchema } from "../src/json-schemas.js";
+import { filterValidInputSchemaProperties, generateInputDefaultsTsFileContent } from "../src/apify.js";
+import type { ObjectSchema } from "../src/utils/json-schemas.js";
 
 describe("Apify utilities", () => {
+	describe("filterValidInputSchemaProperties", () => {
+		it("should filter out invalid root-level keys", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				title: "Test Schema",
+				description: "A test schema",
+				schemaVersion: 1,
+				properties: {
+					name: { type: "string" },
+				},
+				required: ["name"],
+				invalidKey: "should be removed",
+				anotherInvalid: 123,
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				title: "Test Schema",
+				description: "A test schema",
+				schemaVersion: 1,
+				properties: {
+					name: { type: "string" },
+				},
+				required: ["name"],
+			});
+		});
+
+		it("should filter out invalid property keys", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						title: "Name",
+						description: "User name",
+						default: "John",
+						invalidKey: "should be removed",
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						title: "Name",
+						description: "User name",
+						default: "John",
+					},
+				},
+			});
+		});
+
+		it("should preserve valid type-specific keys for string properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					email: {
+						type: "string",
+						editor: "textfield",
+						pattern: String.raw`^[a-z]+@[a-z]+\.[a-z]+$`,
+						minLength: 5,
+						maxLength: 100,
+						enum: ["test@example.com", "admin@example.com"],
+						enumTitles: ["Test User", "Admin User"],
+						nullable: true,
+						isSecret: false,
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					email: {
+						type: "string",
+						editor: "textfield",
+						pattern: String.raw`^[a-z]+@[a-z]+\.[a-z]+$`,
+						minLength: 5,
+						maxLength: 100,
+						enum: ["test@example.com", "admin@example.com"],
+						enumTitles: ["Test User", "Admin User"],
+						nullable: true,
+						isSecret: false,
+					},
+				},
+			});
+		});
+
+		it("should preserve valid type-specific keys for boolean properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					enabled: {
+						type: "boolean",
+						editor: "checkbox",
+						groupCaption: "Settings",
+						groupDescription: "Feature settings",
+						nullable: false,
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					enabled: {
+						type: "boolean",
+						editor: "checkbox",
+						groupCaption: "Settings",
+						groupDescription: "Feature settings",
+						nullable: false,
+					},
+				},
+			});
+		});
+
+		it("should preserve valid type-specific keys for integer properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					age: {
+						type: "integer",
+						editor: "number",
+						maximum: 120,
+						minimum: 0,
+						unit: "years",
+						nullable: false,
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					age: {
+						type: "integer",
+						editor: "number",
+						maximum: 120,
+						minimum: 0,
+						unit: "years",
+						nullable: false,
+					},
+				},
+			});
+		});
+
+		it("should preserve valid type-specific keys for object properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					config: {
+						type: "object",
+						editor: "json",
+						properties: {
+							key: { type: "string" },
+						},
+						additionalProperties: true,
+						required: ["key"],
+						patternKey: "^[a-z]+$",
+						patternValue: ".*",
+						maxProperties: 10,
+						minProperties: 1,
+						nullable: false,
+						isSecret: false,
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					config: {
+						type: "object",
+						editor: "json",
+						properties: {
+							key: { type: "string" },
+						},
+						additionalProperties: true,
+						required: ["key"],
+						patternKey: "^[a-z]+$",
+						patternValue: ".*",
+						maxProperties: 10,
+						minProperties: 1,
+						nullable: false,
+						isSecret: false,
+					},
+				},
+			});
+		});
+
+		it("should preserve valid type-specific keys for array properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					tags: {
+						type: "array",
+						editor: "json",
+						items: { type: "string" },
+						placeholderKey: "key",
+						placeholderValue: "value",
+						patternKey: "^[a-z]+$",
+						patternValue: ".*",
+						maxItems: 10,
+						minItems: 1,
+						uniqueItems: true,
+						nullable: false,
+						isSecret: false,
+						resourceType: "dataset",
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					tags: {
+						type: "array",
+						editor: "json",
+						items: { type: "string" },
+						placeholderKey: "key",
+						placeholderValue: "value",
+						patternKey: "^[a-z]+$",
+						patternValue: ".*",
+						maxItems: 10,
+						minItems: 1,
+						uniqueItems: true,
+						nullable: false,
+						isSecret: false,
+						resourceType: "dataset",
+					},
+				},
+			});
+		});
+
+		it("should filter invalid type-specific keys from properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						pattern: "^[a-z]+$",
+						maximum: 100,
+						groupCaption: "Invalid",
+					},
+				},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						pattern: "^[a-z]+$",
+					},
+				},
+			});
+		});
+
+		it("should handle multiple properties with different types", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						title: "Name",
+						maxLength: 50,
+					},
+					age: {
+						type: "integer",
+						title: "Age",
+						minimum: 0,
+					},
+					enabled: {
+						type: "boolean",
+						title: "Enabled",
+						nullable: false,
+					},
+					tags: {
+						type: "array",
+						title: "Tags",
+						items: { type: "string" },
+					},
+					config: {
+						type: "object",
+						title: "Config",
+						properties: {
+							key: { type: "string" },
+						},
+					},
+				},
+				required: ["name", "age"],
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {
+					name: {
+						type: "string",
+						title: "Name",
+						maxLength: 50,
+					},
+					age: {
+						type: "integer",
+						title: "Age",
+						minimum: 0,
+					},
+					enabled: {
+						type: "boolean",
+						title: "Enabled",
+						nullable: false,
+					},
+					tags: {
+						type: "array",
+						title: "Tags",
+						items: { type: "string" },
+					},
+					config: {
+						type: "object",
+						title: "Config",
+						properties: {
+							key: { type: "string" },
+						},
+					},
+				},
+				required: ["name", "age"],
+			});
+		});
+
+		it("should throw error when property is missing type", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: {
+						title: "Name",
+					},
+				},
+			};
+
+			expect(() => filterValidInputSchemaProperties(inputSchema)).toThrow(
+				'Property "name" is missing a type in the input schema',
+			);
+		});
+
+		it("should throw error when property has invalid type", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {
+					name: {
+						// @ts-expect-error - invalid type for testing
+						type: "invalid-type",
+					},
+				},
+			};
+
+			expect(() => filterValidInputSchemaProperties(inputSchema)).toThrow(
+				'Invalid property type "invalid-type" for property "name" in the input schema',
+			);
+		});
+
+		it("should handle empty properties object", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				properties: {},
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				properties: {},
+			});
+		});
+
+		it("should handle schema without properties", () => {
+			const inputSchema: ObjectSchema = {
+				type: "object",
+				title: "Empty Schema",
+			};
+
+			const result = filterValidInputSchemaProperties(inputSchema);
+
+			expect(result).toEqual({
+				type: "object",
+				title: "Empty Schema",
+			});
+		});
+	});
+
 	describe("generateInputDefaultsTsFileContent", () => {
 		it("should generate the correct content with default values", async () => {
 			const inputSchema: ObjectSchema = {