feat(input_schema): Add enumSuggestedValues property to input schema (#569)

Solves apify/apify-core#24101 - adds support
for `enumSuggestedValues` property, that can be used instead of `enum`
and it:
- wouldn't trigger enum validation, value can be anything
- would be used only on FE to render select which would accept inserting
custom value

I put this to `stringProperty`, accepting now `select` editor (only if
`enumSuggestedValues` is specified), because it supports also other
validation keywords (`pattern`,...) which makes totally sense to put
another constraints on the custom value. (But there's no reason to allow
these additional validation keywords when using `enum`.)

Other things works still the same
- `enum` can be defined only if `editor` is not defined or is `select`
- `enumSuggestedValues` can be defined only if `editor` is `select`.
- only one of `enum` or `enumSuggestedValues` can (must) be defined if
`editor` is `select`
- it works the same for arrays

Draft with changes to make this work in UI is ready here:
apify/apify-core#24164

Author: mfori

packages/input_schema/src/types.ts

@@ -16,7 +16,8 @@ export type StringFieldDefinition = CommonFieldDefinition<string> & {
     minLength?: number;
     maxLength?: number;
     enum?: readonly string[]; // required if editor is 'select'
-    enumTitles?: readonly string[]
+    enumTitles?: readonly string[];
+    enumSuggestedValues?: readonly string[];
     isSecret?: boolean;
     // Used for 'datepicker' editor, absolute is considered as default value
     dateType?: 'absolute' | 'relative' | 'absoluteOrRelative';

packages/json_schemas/schemas/input.schema.json

@@ -98,17 +98,13 @@
                 "title": { "type": "string" },
                 "description": { "type": "string" },
                 "nullable": { "type": "boolean" },
-                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "datepicker", "hidden", "fileupload"] },
+                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "datepicker", "select", "fileupload", "hidden"] },
                 "isSecret": { "type": "boolean" }
             },
             "required": ["type", "title", "description", "editor"],
             "if": {
                 "properties": {
-                    "isSecret": {
-                        "not": {
-                            "const": true
-                        }
-                    }
+                    "isSecret": { "not": { "const": true } }
                 }
             },
             "then": {
@@ -142,7 +138,7 @@
                         },
                         "else": {
                             "properties": {
-                                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "hidden", "fileupload"] }
+                                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "select", "fileupload", "hidden"] }
                             }
                         }
                     },
@@ -156,6 +152,30 @@
                         "else": {
                             "properties": { "default": { "type": ["string", "null"] } }
                         }
+                    },
+                    {
+                        "if": {
+                            "required": ["editor"],
+                            "properties": {
+                                "editor": { "const": "select" }
+                            }
+                        },
+                        "then": {
+                            "properties": {
+                                "enumSuggestedValues": {
+                                    "type": "array",
+                                    "items": { "type": "string" },
+                                    "minItems": 1,
+                                    "uniqueItems": true
+                                },
+                                "enumTitles": {
+                                    "type": "array",
+                                    "items": { "type": "string" },
+                                    "minItems": 1
+                                }
+                            },
+                            "required": ["enumSuggestedValues"]
+                        }
                     }
                 ]
             },
@@ -694,7 +714,7 @@
                 "nullable": { "type": "boolean" },
                 "minLength": { "type": "integer" },
                 "maxLength": { "type": "integer" },
-                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "datepicker", "hidden", "fileupload"] }
+                "editor": { "enum": ["javascript", "python", "textfield", "textarea", "datepicker", "select", "fileupload", "hidden"] }
             },
             "required": ["type", "title", "description"],
             "allOf": [
@@ -712,7 +732,7 @@
                     },
                     "else": {
                         "properties": {
-                            "editor": { "enum": ["javascript", "python", "textfield", "textarea", "hidden", "fileupload"] }
+                            "editor": { "enum": ["javascript", "python", "textfield", "textarea", "select", "fileupload", "hidden"] }
                         }
                     }
                 },
@@ -726,6 +746,30 @@
                     "else": {
                         "properties": { "default": { "type": ["string", "null"] } }
                     }
+                },
+                {
+                    "if": {
+                        "required": ["editor"],
+                        "properties": {
+                            "editor": { "const": "select" }
+                        }
+                    },
+                    "then": {
+                        "properties": {
+                            "enumSuggestedValues": {
+                                "type": "array",
+                                "items": { "type": "string" },
+                                "minItems": 1,
+                                "uniqueItems": true
+                            },
+                            "enumTitles": {
+                                "type": "array",
+                                "items": { "type": "string" },
+                                "minItems": 1
+                            }
+                        },
+                        "required": ["enumSuggestedValues"]
+                    }
                 }
             ]
         },
@@ -1137,9 +1181,18 @@
                 "enumTitles": {
                     "type": "array",
                     "items": { "type": "string" }
+                },
+                "enumSuggestedValues": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "minItems": 1,
+                    "uniqueItems": true
                 }
             },
-            "required": ["type", "enum"]
+            "oneOf": [
+                { "required": ["type", "enum"] },
+                { "required": ["type", "enumSuggestedValues"] }
+            ]
         },
         "arrayItemsKeyValue": {
             "title": "Utils: Array items keyValue definition",