@apify/input_schema 3.15.2 → 3.16.0

package/esm/index.mjs

@@ -19,7 +19,8 @@ var intlStrings = {
   "inputSchema.validation.noAvailableAutoProxy": "Currently you do not have access to any proxy group usable in automatic mode.",
   "inputSchema.validation.noMatchingDefinition": "Field schema.properties.{fieldKey} is not matching any input schema type definition. Please make sure that it's type is valid.",
   "inputSchema.validation.missingRequiredField": "Field schema.properties.{fieldKey} does not exist, but it is specified in schema.required. Either define the field or remove it from schema.required.",
-  "inputSchema.validation.proxyGroupMustBeArrayOfStrings": "Field {rootName}.{fieldKey}.apifyProxyGroups must be an array of strings."
+  "inputSchema.validation.proxyGroupMustBeArrayOfStrings": "Field {rootName}.{fieldKey}.apifyProxyGroups must be an array of strings.",
+  "inputSchema.validation.secretFieldSchemaChanged": "The field schema.properties.{fieldKey} is a secret field, but its schema has changed. Please update the value in the input editor."
 };
 function m(stringId, variables) {
   let text = intlStrings[stringId];
@@ -188,6 +189,7 @@ var schema_default = {
           type: { enum: ["string"] },
           title: { type: "string" },
           description: { type: "string" },
+          prefill: { type: "string" },
           example: { type: "string" },
           nullable: { type: "boolean" },
           editor: { enum: ["textfield", "textarea", "hidden"] },
@@ -202,48 +204,84 @@ var schema_default = {
       type: "object",
       properties: {
         type: { enum: ["array"] },
-        editor: { enum: ["json", "requestListSources", "pseudoUrls", "globs", "keyValue", "stringList", "select", "hidden"] }
+        editor: { enum: ["json", "requestListSources", "pseudoUrls", "globs", "keyValue", "stringList", "select", "hidden"] },
+        isSecret: { type: "boolean" }
       },
       additionalProperties: true,
       required: ["type", "title", "description", "editor"],
       if: {
         properties: {
-          editor: { const: "select" }
+          isSecret: {
+            not: {
+              const: true
+            }
+          }
         }
       },
       then: {
-        additionalProperties: false,
-        required: ["items"],
-        properties: {
-          type: { enum: ["array"] },
-          editor: { enum: ["select"] },
-          title: { type: "string" },
-          description: { type: "string" },
-          default: { type: "array" },
-          prefill: { type: "array" },
-          example: { type: "array" },
-          nullable: { type: "boolean" },
-          minItems: { type: "integer" },
-          maxItems: { type: "integer" },
-          uniqueItems: { type: "boolean" },
-          sectionCaption: { type: "string" },
-          sectionDescription: { type: "string" },
-          items: {
-            type: "object",
-            additionalProperties: false,
-            properties: {
-              type: { enum: ["string"] },
-              enum: {
-                type: "array",
-                items: { type: "string" },
-                uniqueItems: true
+        if: {
+          properties: {
+            editor: { const: "select" }
+          }
+        },
+        then: {
+          additionalProperties: false,
+          required: ["items"],
+          properties: {
+            type: { enum: ["array"] },
+            editor: { enum: ["select"] },
+            title: { type: "string" },
+            description: { type: "string" },
+            default: { type: "array" },
+            prefill: { type: "array" },
+            example: { type: "array" },
+            nullable: { type: "boolean" },
+            minItems: { type: "integer" },
+            maxItems: { type: "integer" },
+            uniqueItems: { type: "boolean" },
+            sectionCaption: { type: "string" },
+            sectionDescription: { type: "string" },
+            items: {
+              type: "object",
+              additionalProperties: false,
+              properties: {
+                type: { enum: ["string"] },
+                enum: {
+                  type: "array",
+                  items: { type: "string" },
+                  uniqueItems: true
+                },
+                enumTitles: {
+                  type: "array",
+                  items: { type: "string" }
+                }
               },
-              enumTitles: {
-                type: "array",
-                items: { type: "string" }
-              }
+              required: ["type", "enum"]
             },
-            required: ["type", "enum"]
+            isSecret: { enum: [false] }
+          }
+        },
+        else: {
+          additionalProperties: false,
+          properties: {
+            type: { enum: ["array"] },
+            editor: { enum: ["json", "requestListSources", "pseudoUrls", "globs", "keyValue", "stringList", "hidden"] },
+            title: { type: "string" },
+            description: { type: "string" },
+            default: { type: "array" },
+            prefill: { type: "array" },
+            example: { type: "array" },
+            nullable: { type: "boolean" },
+            minItems: { type: "integer" },
+            maxItems: { type: "integer" },
+            uniqueItems: { type: "boolean" },
+            sectionCaption: { type: "string" },
+            sectionDescription: { type: "string" },
+            placeholderKey: { type: "string" },
+            placeholderValue: { type: "string" },
+            patternKey: { type: "string" },
+            patternValue: { type: "string" },
+            isSecret: { enum: [false] }
           }
         }
       },
@@ -251,10 +289,9 @@ var schema_default = {
         additionalProperties: false,
         properties: {
           type: { enum: ["array"] },
-          editor: { enum: ["json", "requestListSources", "pseudoUrls", "globs", "keyValue", "stringList", "hidden"] },
+          editor: { enum: ["json", "hidden"] },
           title: { type: "string" },
           description: { type: "string" },
-          default: { type: "array" },
           prefill: { type: "array" },
           example: { type: "array" },
           nullable: { type: "boolean" },
@@ -263,34 +300,70 @@ var schema_default = {
           uniqueItems: { type: "boolean" },
           sectionCaption: { type: "string" },
           sectionDescription: { type: "string" },
-          placeholderKey: { type: "string" },
-          placeholderValue: { type: "string" },
-          patternKey: { type: "string" },
-          patternValue: { type: "string" }
+          isSecret: { enum: [true] }
         }
       }
     },
     objectProperty: {
       title: "Object property",
       type: "object",
-      additionalProperties: false,
+      additionalProperties: true,
       properties: {
         type: { enum: ["object"] },
         title: { type: "string" },
         description: { type: "string" },
-        default: { type: "object" },
-        prefill: { type: "object" },
-        example: { type: "object" },
-        patternKey: { type: "string" },
-        patternValue: { type: "string" },
-        nullable: { type: "boolean" },
-        minProperties: { type: "integer" },
-        maxProperties: { type: "integer" },
         editor: { enum: ["json", "proxy", "hidden"] },
-        sectionCaption: { type: "string" },
-        sectionDescription: { type: "string" }
+        isSecret: { type: "boolean" }
       },
-      required: ["type", "title", "description", "editor"]
+      required: ["type", "title", "description", "editor"],
+      if: {
+        properties: {
+          isSecret: {
+            not: {
+              const: true
+            }
+          }
+        }
+      },
+      then: {
+        additionalProperties: false,
+        properties: {
+          type: { enum: ["object"] },
+          title: { type: "string" },
+          description: { type: "string" },
+          default: { type: "object" },
+          prefill: { type: "object" },
+          example: { type: "object" },
+          patternKey: { type: "string" },
+          patternValue: { type: "string" },
+          nullable: { type: "boolean" },
+          minProperties: { type: "integer" },
+          maxProperties: { type: "integer" },
+          editor: { enum: ["json", "proxy", "hidden"] },
+          sectionCaption: { type: "string" },
+          sectionDescription: { type: "string" },
+          isSecret: { enum: [false] }
+        }
+      },
+      else: {
+        additionalProperties: false,
+        properties: {
+          type: { enum: ["object"] },
+          title: { type: "string" },
+          description: { type: "string" },
+          prefill: { type: "object" },
+          example: { type: "object" },
+          patternKey: { type: "string" },
+          patternValue: { type: "string" },
+          nullable: { type: "boolean" },
+          minProperties: { type: "integer" },
+          maxProperties: { type: "integer" },
+          editor: { enum: ["json", "hidden"] },
+          sectionCaption: { type: "string" },
+          sectionDescription: { type: "string" },
+          isSecret: { enum: [true] }
+        }
+      }
     },
     integerProperty: {
       title: "Integer property",
@@ -557,6 +630,7 @@ __name(validateInputSchema, "validateInputSchema");
 import { parse } from "acorn-loose";
 import { countries } from "countries-list";
 import { PROXY_URL_REGEX, URL_REGEX } from "@apify/consts";
+import { isEncryptedValueForFieldSchema, isEncryptedValueForFieldType } from "@apify/input_secrets";
 function validateProxyField(fieldKey, value, isRequired = false, options = null) {
   const fieldErrors = [];
   if (isRequired) {
@@ -626,11 +700,21 @@ function validateInputUsingValidator(validator, inputSchema, input, options = {}
   const required = inputSchema.required || [];
   let errors = [];
   if (!isValid) {
-    errors = validator.errors.map((error) => parseAjvError(error, "input", properties, input)).filter((error) => !!error);
+    errors = validator.errors.filter((error) => {
+      if (error.keyword === "type" && error.instancePath) {
+        const path = error.instancePath.replace(/^\//, "").split("/")[0];
+        const propSchema = inputSchema.properties?.[path];
+        const value = input[path];
+        if (propSchema?.isSecret && typeof value === "string" && (propSchema.type === "object" || propSchema.type === "array") && isEncryptedValueForFieldType(value, propSchema.type)) {
+          return false;
+        }
+      }
+      return true;
+    }).map((error) => parseAjvError(error, "input", properties, input)).filter((error) => !!error);
   }
   Object.keys(properties).forEach((property) => {
     const value = input[property];
-    const { type, editor, patternKey, patternValue } = properties[property];
+    const { type, editor, patternKey, patternValue, isSecret } = properties[property];
     const fieldErrors = [];
     if (type === "object" && editor === "proxy") {
       const proxyValidationErrors = validateProxyField(property, value, required.includes(property), options.proxy);
@@ -700,7 +784,7 @@ function validateInputUsingValidator(validator, inputSchema, input, options = {}
         }
       }
     }
-    if (type === "object" && value) {
+    if (type === "object" && value && typeof value === "object") {
       if (patternKey) {
         const check = new RegExp(patternKey);
         const invalidKeys = [];
@@ -733,6 +817,11 @@ function validateInputUsingValidator(validator, inputSchema, input, options = {}
         }
       }
     }
+    if (isSecret && value && typeof value === "string") {
+      if (isEncryptedValueForFieldType(value, type) && !isEncryptedValueForFieldSchema(value, properties[property])) {
+        fieldErrors.push(m("inputSchema.validation.secretFieldSchemaChanged", { fieldKey: property }));
+      }
+    }
     if (fieldErrors.length > 0) {
       const message = fieldErrors.join(", ");
       errors.push({ fieldKey: property, message });