feat: handle sub-schema validation

Author: mfori

package.json

@@ -66,7 +66,7 @@
     "dependencies": {
         "@apify/actor-templates": "^0.1.5",
         "@apify/consts": "^2.36.0",
-        "@apify/input_schema": "^3.12.0",
+        "@apify/input_schema": "^3.17.0",
         "@apify/utilities": "^2.15.1",
         "@crawlee/memory-storage": "^3.12.0",
         "@root/walk": "~1.1.0",

src/commands/run.ts

@@ -29,7 +29,7 @@ import { getAjvValidator, getDefaultsFromInputSchema, readInputSchema } from '..
 import { error, info, warning } from '../lib/outputs.js';
 import { replaceSecretsValue } from '../lib/secrets.js';
 import {
-	Ajv,
+	Ajv2019,
 	checkIfStorageIsEmpty,
 	getLocalInput,
 	getLocalKeyValueStorePath,
@@ -436,7 +436,7 @@ export class RunCommand extends ApifyCommand<typeof RunCommand> {
 		}
 
 		// Step 1: validate the input schema
-		const validator = new Ajv({ strict: false, unicodeRegExp: false });
+		const validator = new Ajv2019({ strict: false, unicodeRegExp: false });
 		validateInputSchema(validator, inputSchema); // This one throws an error in a case of invalid schema.
 
 		const defaults = getDefaultsFromInputSchema(inputSchema);

src/commands/validate-schema.ts

@@ -7,7 +7,7 @@ import { Args } from '../lib/command-framework/args.js';
 import { LOCAL_CONFIG_PATH } from '../lib/consts.js';
 import { readInputSchema } from '../lib/input_schema.js';
 import { info, success } from '../lib/outputs.js';
-import { Ajv } from '../lib/utils.js';
+import { Ajv2019 } from '../lib/utils.js';
 
 export class ValidateInputSchemaCommand extends ApifyCommand<typeof ValidateInputSchemaCommand> {
 	static override name = 'validate-schema' as const;
@@ -45,7 +45,7 @@ export class ValidateInputSchemaCommand extends ApifyCommand<typeof ValidateInpu
 			info({ message: `Validating input schema embedded in '${LOCAL_CONFIG_PATH}'` });
 		}
 
-		const validator = new Ajv({ strict: false });
+		const validator = new Ajv2019({ strict: false });
 		validateInputSchema(validator, inputSchema); // This one throws an error in a case of invalid schema.
 		success({ message: 'Input schema is valid.' });
 	}

src/lib/input_schema.ts

@@ -9,7 +9,7 @@ import { validateInputSchema } from '@apify/input_schema';
 
 import { ACTOR_SPECIFICATION_FOLDER } from './consts.js';
 import { warning } from './outputs.js';
-import { Ajv, getJsonFileContent, getLocalConfig, getLocalKeyValueStorePath } from './utils.js';
+import { Ajv2019, getJsonFileContent, getLocalConfig, getLocalKeyValueStorePath } from './utils.js';
 
 const DEFAULT_INPUT_SCHEMA_PATHS = [
 	'.actor/INPUT_SCHEMA.json',
@@ -85,7 +85,7 @@ export const createPrefilledInputFileFromInputSchema = async (actorFolderDir: st
 			 * It is not possible to install the package here because it is private
 			 * We should move it to @apify/input_schema and use it from there.
 			 */
-			const validator = new Ajv({ strict: false });
+			const validator = new Ajv2019({ strict: false });
 			validateInputSchema(validator, inputSchema);
 
 			// inputFile = _.mapObject(inputSchema.properties as any, (fieldSchema) =>

src/lib/utils.ts

@@ -9,7 +9,7 @@ import { finished } from 'node:stream/promises';
 import { DurationFormatter as SapphireDurationFormatter, TimeTypes } from '@sapphire/duration';
 import { Timestamp } from '@sapphire/timestamp';
 import AdmZip from 'adm-zip';
-import _Ajv from 'ajv';
+import _Ajv2019 from 'ajv/dist/2019.js';
 import { type ActorRun, ApifyClient, type ApifyClientOptions, type Build } from 'apify-client';
 import archiver from 'archiver';
 import { AxiosHeaders } from 'axios';
@@ -47,7 +47,7 @@ import type { AuthJSON } from './types.js';
 
 // Export AJV properly: https://github.com/ajv-validator/ajv/issues/2132
 // Welcome to the state of JavaScript/TypeScript and CJS/ESM interop.
-export const Ajv = _Ajv as unknown as typeof import('ajv').default;
+export const Ajv2019 = _Ajv2019 as unknown as typeof import('ajv/dist/2019.js').default;
 
 export const httpsGet = async (url: string) => {
 	return new Promise<IncomingMessage>((resolve, reject) => {

test/__setup__/input-schemas/valid.json

@@ -56,7 +56,29 @@
 			"default": false,
 			"groupCaption": "Options",
 			"groupDescription": "Various options for this Actor"
-		}
+		},
+        "person": {
+            "title": "Person",
+            "type": "object",
+            "description": "An example of a nested object",
+            "editor": "schemaBased",
+            "properties": {
+                "firstName": {
+                    "type": "string",
+                    "title": "First Name",
+                    "description": "First name of the person",
+                    "editor": "textfield"
+                },
+                "lastName": {
+                    "type": "string",
+                    "title": "Last Name",
+                    "description": "Last name of the person",
+                    "editor": "textfield"
+                }
+            },
+            "additionalProperties": false,
+            "required": ["lastName"]
+        }
 	},
 	"required": ["queries"]
 }

yarn.lock

@@ -49,16 +49,17 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@apify/input_schema@npm:^3.12.0":
-  version: 3.15.2
-  resolution: "@apify/input_schema@npm:3.15.2"
+"@apify/input_schema@npm:^3.17.0":
+  version: 3.17.0
+  resolution: "@apify/input_schema@npm:3.17.0"
   dependencies:
     "@apify/consts": "npm:^2.43.0"
+    "@apify/input_secrets": "npm:^1.2.1"
     acorn-loose: "npm:^8.4.0"
     countries-list: "npm:^3.0.0"
   peerDependencies:
     ajv: ^8.0.0
-  checksum: 10c0/4f75e00eb2fe94879b4caa5b3d208dc638890e41ddb22843b605a924b5db4d89e95d29c8f961cc6e180fece8be8abdacee40ad04df5b0abbfc22c08f22a59e40
+  checksum: 10c0/9d6a761f2bfb91cecd4d84a4094eda6a7c512bcbc98d875441062c88a3a1e83260bf90d113b8d0063457cd8a37d205d95138584267c8ee69e8bb863719164109
   languageName: node
   linkType: hard
 
@@ -73,6 +74,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@apify/input_secrets@npm:^1.2.1":
+  version: 1.2.1
+  resolution: "@apify/input_secrets@npm:1.2.1"
+  dependencies:
+    "@apify/log": "npm:^2.5.20"
+    "@apify/utilities": "npm:^2.16.2"
+    ow: "npm:^0.28.2"
+  checksum: 10c0/0494940e807d33acc2779576a2fe4610bb359e535e8da31d3d06c5b2e6efda20a775711fcb51a1be0ed672116bee286bc00341d31135c9c27fcbe5b7f9f24a2d
+  languageName: node
+  linkType: hard
+
 "@apify/log@npm:^2.2.6, @apify/log@npm:^2.4.0, @apify/log@npm:^2.4.3, @apify/log@npm:^2.5.20":
   version: 2.5.20
   resolution: "@apify/log@npm:2.5.20"
@@ -2465,7 +2477,7 @@ __metadata:
     "@apify/actor-templates": "npm:^0.1.5"
     "@apify/consts": "npm:^2.36.0"
     "@apify/eslint-config": "npm:^1.0.0"
-    "@apify/input_schema": "npm:^3.12.0"
+    "@apify/input_schema": "npm:^3.17.0"
     "@apify/tsconfig": "npm:^0.1.1"
     "@apify/utilities": "npm:^2.15.1"
     "@biomejs/biome": "npm:^2.0.0"