@apify/input_schema 3.8.0 → 3.9.0

package/cjs/index.d.ts

@@ -191,61 +191,159 @@ var definitions = {
 			}
 		},
 		then: {
-			additionalProperties: false,
-			properties: {
-				type: {
-					"enum": [
-						"string"
-					]
-				},
-				title: {
-					type: "string"
-				},
-				description: {
-					type: "string"
-				},
-				"default": {
-					type: "string"
-				},
-				prefill: {
-					type: "string"
-				},
-				example: {
-					type: "string"
-				},
-				pattern: {
-					type: "string"
-				},
-				nullable: {
-					type: "boolean"
-				},
-				minLength: {
-					type: "integer"
+			"if": {
+				properties: {
+					editor: {
+						"const": "datepicker"
+					}
+				}
+			},
+			then: {
+				additionalProperties: false,
+				properties: {
+					type: {
+						"enum": [
+							"string"
+						]
+					},
+					title: {
+						type: "string"
+					},
+					description: {
+						type: "string"
+					},
+					"default": {
+						type: "string"
+					},
+					prefill: {
+						type: "string"
+					},
+					example: {
+						type: "string"
+					},
+					pattern: {
+						type: "string"
+					},
+					nullable: {
+						type: "boolean"
+					},
+					minLength: {
+						type: "integer"
+					},
+					maxLength: {
+						type: "integer"
+					},
+					editor: {
+						"enum": [
+							"datepicker"
+						]
+					},
+					sectionCaption: {
+						type: "string"
+					},
+					sectionDescription: {
+						type: "string"
+					},
+					allowAbsolute: {
+						type: "boolean"
+					},
+					allowRelative: {
+						type: "boolean"
+					}
 				},
-				maxLength: {
-					type: "integer"
+				"if": {
+					required: [
+						"allowAbsolute"
+					],
+					properties: {
+						allowAbsolute: {
+							"const": false
+						}
+					}
 				},
-				editor: {
-					"enum": [
-						"javascript",
-						"python",
-						"textfield",
-						"textarea",
-						"datepicker",
-						"hidden",
-						"dataset",
-						"keyValueStore",
-						"requestQueue"
+				then: {
+					required: [
+						"type",
+						"title",
+						"description",
+						"editor",
+						"allowRelative"
 					]
 				},
-				isSecret: {
-					type: "boolean"
-				},
-				sectionCaption: {
-					type: "string"
-				},
-				sectionDescription: {
-					type: "string"
+				anyOf: [
+					{
+						properties: {
+							allowAbsolute: {
+								"const": true
+							}
+						}
+					},
+					{
+						properties: {
+							allowRelative: {
+								"const": true
+							}
+						}
+					}
+				]
+			},
+			"else": {
+				additionalProperties: false,
+				properties: {
+					type: {
+						"enum": [
+							"string"
+						]
+					},
+					title: {
+						type: "string"
+					},
+					description: {
+						type: "string"
+					},
+					"default": {
+						type: "string"
+					},
+					prefill: {
+						type: "string"
+					},
+					example: {
+						type: "string"
+					},
+					pattern: {
+						type: "string"
+					},
+					nullable: {
+						type: "boolean"
+					},
+					minLength: {
+						type: "integer"
+					},
+					maxLength: {
+						type: "integer"
+					},
+					editor: {
+						"enum": [
+							"javascript",
+							"python",
+							"textfield",
+							"textarea",
+							"datepicker",
+							"hidden",
+							"dataset",
+							"keyValueStore",
+							"requestQueue"
+						]
+					},
+					isSecret: {
+						type: "boolean"
+					},
+					sectionCaption: {
+						type: "string"
+					},
+					sectionDescription: {
+						type: "string"
+					}
 				}
 			}
 		},
@@ -687,6 +785,8 @@ type StringFieldDefinition = CommonFieldDefinition<string> & {
     enum?: readonly string[];
     enumTitles?: readonly string[];
     isSecret?: boolean;
+    allowAbsolute?: boolean;
+    allowRelative?: boolean;
 };
 type BooleanFieldDefinition = CommonFieldDefinition<boolean> & {
     type: 'boolean';
@@ -751,6 +851,7 @@ type InputSchema = {
  */
 declare function parseAjvError(error: ErrorObject, rootName: string, properties?: Record<string, {
     nullable?: boolean;
+    editor?: string;
 }>, input?: Record<string, unknown>): {
     fieldKey: string;
     message: string;

package/esm/index.d.mts

@@ -191,61 +191,159 @@ var definitions = {
 			}
 		},
 		then: {
-			additionalProperties: false,
-			properties: {
-				type: {
-					"enum": [
-						"string"
-					]
-				},
-				title: {
-					type: "string"
-				},
-				description: {
-					type: "string"
-				},
-				"default": {
-					type: "string"
-				},
-				prefill: {
-					type: "string"
-				},
-				example: {
-					type: "string"
-				},
-				pattern: {
-					type: "string"
-				},
-				nullable: {
-					type: "boolean"
-				},
-				minLength: {
-					type: "integer"
+			"if": {
+				properties: {
+					editor: {
+						"const": "datepicker"
+					}
+				}
+			},
+			then: {
+				additionalProperties: false,
+				properties: {
+					type: {
+						"enum": [
+							"string"
+						]
+					},
+					title: {
+						type: "string"
+					},
+					description: {
+						type: "string"
+					},
+					"default": {
+						type: "string"
+					},
+					prefill: {
+						type: "string"
+					},
+					example: {
+						type: "string"
+					},
+					pattern: {
+						type: "string"
+					},
+					nullable: {
+						type: "boolean"
+					},
+					minLength: {
+						type: "integer"
+					},
+					maxLength: {
+						type: "integer"
+					},
+					editor: {
+						"enum": [
+							"datepicker"
+						]
+					},
+					sectionCaption: {
+						type: "string"
+					},
+					sectionDescription: {
+						type: "string"
+					},
+					allowAbsolute: {
+						type: "boolean"
+					},
+					allowRelative: {
+						type: "boolean"
+					}
 				},
-				maxLength: {
-					type: "integer"
+				"if": {
+					required: [
+						"allowAbsolute"
+					],
+					properties: {
+						allowAbsolute: {
+							"const": false
+						}
+					}
 				},
-				editor: {
-					"enum": [
-						"javascript",
-						"python",
-						"textfield",
-						"textarea",
-						"datepicker",
-						"hidden",
-						"dataset",
-						"keyValueStore",
-						"requestQueue"
+				then: {
+					required: [
+						"type",
+						"title",
+						"description",
+						"editor",
+						"allowRelative"
 					]
 				},
-				isSecret: {
-					type: "boolean"
-				},
-				sectionCaption: {
-					type: "string"
-				},
-				sectionDescription: {
-					type: "string"
+				anyOf: [
+					{
+						properties: {
+							allowAbsolute: {
+								"const": true
+							}
+						}
+					},
+					{
+						properties: {
+							allowRelative: {
+								"const": true
+							}
+						}
+					}
+				]
+			},
+			"else": {
+				additionalProperties: false,
+				properties: {
+					type: {
+						"enum": [
+							"string"
+						]
+					},
+					title: {
+						type: "string"
+					},
+					description: {
+						type: "string"
+					},
+					"default": {
+						type: "string"
+					},
+					prefill: {
+						type: "string"
+					},
+					example: {
+						type: "string"
+					},
+					pattern: {
+						type: "string"
+					},
+					nullable: {
+						type: "boolean"
+					},
+					minLength: {
+						type: "integer"
+					},
+					maxLength: {
+						type: "integer"
+					},
+					editor: {
+						"enum": [
+							"javascript",
+							"python",
+							"textfield",
+							"textarea",
+							"datepicker",
+							"hidden",
+							"dataset",
+							"keyValueStore",
+							"requestQueue"
+						]
+					},
+					isSecret: {
+						type: "boolean"
+					},
+					sectionCaption: {
+						type: "string"
+					},
+					sectionDescription: {
+						type: "string"
+					}
 				}
 			}
 		},
@@ -687,6 +785,8 @@ type StringFieldDefinition = CommonFieldDefinition<string> & {
     enum?: readonly string[];
     enumTitles?: readonly string[];
     isSecret?: boolean;
+    allowAbsolute?: boolean;
+    allowRelative?: boolean;
 };
 type BooleanFieldDefinition = CommonFieldDefinition<boolean> & {
     type: 'boolean';
@@ -751,6 +851,7 @@ type InputSchema = {
  */
 declare function parseAjvError(error: ErrorObject, rootName: string, properties?: Record<string, {
     nullable?: boolean;
+    editor?: string;
 }>, input?: Record<string, unknown>): {
     fieldKey: string;
     message: string;

package/esm/index.mjs

@@ -19,7 +19,12 @@ 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.datepickerInvalidFormatAbsolute": 'Field {rootName}.{fieldKey} must be a string in format "YYYY-MM-DD".',
+  "inputSchema.validation.datepickerInvalidFormatRelative": 'Field {rootName}.{fieldKey} must be a string in format "+/- number unit". Supported units are "day", "week", "month" and "year".',
+  "inputSchema.validation.datepickerInvalidFormatBoth": 'Field {rootName}.{fieldKey} must be a string in format "YYYY-MM-DD" or "+/- number unit". Supported units are "day", "week", "month" and "year".',
+  "inputSchema.validation.datepickerInvalidDate": "Field {rootName}.{fieldKey} must be a valid date.",
+  "inputSchema.validation.datepickerNoType": 'Field {rootName} must accept absolute, relative or both dates. Set "allowAbsolute", "allowRelative" or both properties.'
 };
 function m(stringId, variables) {
   let text = intlStrings[stringId];
@@ -136,22 +141,58 @@ var schema_default = {
         }
       },
       then: {
-        additionalProperties: false,
-        properties: {
-          type: { enum: ["string"] },
-          title: { type: "string" },
-          description: { type: "string" },
-          default: { type: "string" },
-          prefill: { type: "string" },
-          example: { type: "string" },
-          pattern: { type: "string" },
-          nullable: { type: "boolean" },
-          minLength: { type: "integer" },
-          maxLength: { type: "integer" },
-          editor: { enum: ["javascript", "python", "textfield", "textarea", "datepicker", "hidden", "dataset", "keyValueStore", "requestQueue"] },
-          isSecret: { type: "boolean" },
-          sectionCaption: { type: "string" },
-          sectionDescription: { type: "string" }
+        if: {
+          properties: {
+            editor: { const: "datepicker" }
+          }
+        },
+        then: {
+          additionalProperties: false,
+          properties: {
+            type: { enum: ["string"] },
+            title: { type: "string" },
+            description: { type: "string" },
+            default: { type: "string" },
+            prefill: { type: "string" },
+            example: { type: "string" },
+            pattern: { type: "string" },
+            nullable: { type: "boolean" },
+            minLength: { type: "integer" },
+            maxLength: { type: "integer" },
+            editor: { enum: ["datepicker"] },
+            sectionCaption: { type: "string" },
+            sectionDescription: { type: "string" },
+            allowAbsolute: { type: "boolean" },
+            allowRelative: { type: "boolean" }
+          },
+          if: {
+            required: ["allowAbsolute"],
+            properties: { allowAbsolute: { const: false } }
+          },
+          then: { required: ["type", "title", "description", "editor", "allowRelative"] },
+          anyOf: [
+            { properties: { allowAbsolute: { const: true } } },
+            { properties: { allowRelative: { const: true } } }
+          ]
+        },
+        else: {
+          additionalProperties: false,
+          properties: {
+            type: { enum: ["string"] },
+            title: { type: "string" },
+            description: { type: "string" },
+            default: { type: "string" },
+            prefill: { type: "string" },
+            example: { type: "string" },
+            pattern: { type: "string" },
+            nullable: { type: "boolean" },
+            minLength: { type: "integer" },
+            maxLength: { type: "integer" },
+            editor: { enum: ["javascript", "python", "textfield", "textarea", "datepicker", "hidden", "dataset", "keyValueStore", "requestQueue"] },
+            isSecret: { type: "boolean" },
+            sectionCaption: { type: "string" },
+            sectionDescription: { type: "string" }
+          }
         }
       },
       else: {
@@ -331,7 +372,11 @@ function parseAjvError(error, rootName, properties = {}, input = {}) {
     message = m("inputSchema.validation.generic", { rootName, fieldKey, message: error.message });
   } else if (error.keyword === "required") {
     fieldKey = error.params.missingProperty;
-    message = m("inputSchema.validation.required", { rootName, fieldKey });
+    if (fieldKey === "allowRelative") {
+      message = m("inputSchema.validation.datepickerNoType", { rootName });
+    } else {
+      message = m("inputSchema.validation.required", { rootName, fieldKey });
+    }
   } else if (error.keyword === "additionalProperties") {
     fieldKey = error.params.additionalProperty;
     message = m("inputSchema.validation.additionalProperty", { rootName, fieldKey });
@@ -339,6 +384,13 @@ function parseAjvError(error, rootName, properties = {}, input = {}) {
     fieldKey = error.instancePath.split("/").pop();
     const errorMessage = `${error.message}: "${error.params.allowedValues.join('", "')}"`;
     message = m("inputSchema.validation.generic", { rootName, fieldKey, message: errorMessage });
+  } else if (error.keyword === "const") {
+    fieldKey = error.instancePath.split("/").pop();
+    if (fieldKey === "allowRelative" || fieldKey === "allowAbsolute") {
+      message = m("inputSchema.validation.datepickerNoType", { rootName });
+    } else {
+      message = m("inputSchema.validation.generic", { rootName, fieldKey, message: error.message });
+    }
   } else {
     fieldKey = error.instancePath.split("/").pop();
     message = m("inputSchema.validation.generic", { rootName, fieldKey, message: error.message });
@@ -481,7 +533,7 @@ function validateInputUsingValidator(validator, inputSchema, input, options = {}
   }
   Object.keys(properties).forEach((property) => {
     const value = input[property];
-    const { type, editor, patternKey, patternValue } = properties[property];
+    const { type, editor, patternKey, patternValue, allowAbsolute, allowRelative } = properties[property];
     const fieldErrors = [];
     if (type === "object" && editor === "proxy") {
       const proxyValidationErrors = validateProxyField(property, value, required.includes(property), options.proxy);
@@ -584,6 +636,39 @@ function validateInputUsingValidator(validator, inputSchema, input, options = {}
         }
       }
     }
+    if (type === "string" && editor === "datepicker" && value && typeof value === "string") {
+      const acceptAbsolute = allowAbsolute !== false;
+      const acceptRelative = allowRelative === true;
+      const isValidAbsolute = /^[0-9]{4}-[0-9]{2}-[0-9]{2}$/.test(value);
+      const isValidRelative = /^[+-] [0-9]+ (day|week|month|year)s?$/.test(value);
+      let isValidDate;
+      if (isValidAbsolute) {
+        const [year, month, day] = value.split("-").map(Number);
+        const date = /* @__PURE__ */ new Date(`${year}-${month}-${day}`);
+        isValidDate = date.getFullYear() === year && date.getMonth() + 1 === month && date.getDate() === day;
+      }
+      if (acceptAbsolute && !acceptRelative && !isValidAbsolute) {
+        fieldErrors.push(m("inputSchema.validation.datepickerInvalidFormatAbsolute", {
+          rootName: "input",
+          fieldKey: property
+        }));
+      } else if (acceptRelative && !acceptAbsolute && !isValidRelative) {
+        fieldErrors.push(m("inputSchema.validation.datepickerInvalidFormatRelative", {
+          rootName: "input",
+          fieldKey: property
+        }));
+      } else if (acceptAbsolute && !acceptRelative && !isValidAbsolute || acceptRelative && !acceptAbsolute && !isValidRelative || acceptRelative && acceptAbsolute && !isValidAbsolute && !isValidRelative) {
+        fieldErrors.push(m("inputSchema.validation.datepickerInvalidFormatBoth", {
+          rootName: "input",
+          fieldKey: property
+        }));
+      } else if (isValidDate === false && acceptAbsolute) {
+        fieldErrors.push(m("inputSchema.validation.datepickerInvalidDate", {
+          rootName: "input",
+          fieldKey: property
+        }));
+      }
+    }
     if (fieldErrors.length > 0) {
       const message = fieldErrors.join(", ");
       errors.push({ fieldKey: property, message });