@apify/input_schema 2.1.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.mjs.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/intl.ts","../src/input_schema.ts","../src/utilities.ts"],"sourcesContent":["/* eslint-disable max-len,quotes,quote-props */\nconst intlStrings = {\n 'inputSchema.validation.generic':\n 'Field {rootName}.{fieldKey} {message}',\n 'inputSchema.validation.required':\n 'Field {rootName}.{fieldKey} is required',\n 'inputSchema.validation.proxyRequired':\n 'Field {rootName}.{fieldKey} is required. Please provide custom proxy URLs or use Apify Proxy.',\n 'inputSchema.validation.requestListSourcesInvalid':\n 'Items in {rootName}.{fieldKey} at positions [{invalidIndexes}] do not contain valid URLs',\n 'inputSchema.validation.arrayKeysInvalid':\n 'Keys in {rootName}.{fieldKey} at positions [{invalidIndexes}] must match regular expression \"{pattern}\"',\n 'inputSchema.validation.arrayValuesInvalid':\n 'Values in {rootName}.{fieldKey} at positions [{invalidIndexes}] must match regular expression \"{pattern}\"',\n 'inputSchema.validation.objectKeysInvalid':\n 'Keys [{invalidKeys}] in {rootName}.{fieldKey} must match regular expression \"{pattern}',\n 'inputSchema.validation.objectValuesInvalid':\n 'Keys [{invalidKeys}] in {rootName}.{fieldKey} must have string value which matches regular expression \"{pattern}\"',\n 'inputSchema.validation.additionalProperty':\n 'Property {rootName}.{fieldKey} is not allowed.',\n 'inputSchema.validation.proxyGroupsNotAvailable':\n 'You currently do not have access to proxy groups: {groups}',\n 'inputSchema.validation.customProxyInvalid':\n 'Proxy URL \"{invalidUrl}\" has invalid format, it must be http://[username[:password]]@hostname:port.',\n 'inputSchema.validation.apifyProxyCountryInvalid':\n 'Country code \"{invalidCountry}\" is invalid. Only ISO 3166-1 alpha-2 country codes are supported.',\n 'inputSchema.validation.apifyProxyCountryWithoutApifyProxyForbidden':\n 'The country for Apify Proxy can be specified only when using Apify Proxy.',\n 'inputSchema.validation.noAvailableAutoProxy':\n 'Currently you do not have access to any proxy group usable in automatic mode.',\n 'inputSchema.validation.noMatchingDefinition':\n 'Field schema.properties.{fieldKey} is not matching any input schema type definition. Please make sure that it\\'s type is valid.',\n};\n/* eslint-enable max-len,quotes,quote-props */\n\n/**\n * Helper function to simulate intl formatMessage function\n */\nexport function m(stringId: string, variables?: Record<string, any>) {\n let text = intlStrings[stringId];\n if (!text) return stringId;\n\n if (variables) {\n Object.keys(variables).forEach((variableName) => {\n text = text.split(`{${variableName}}`).join(variables[variableName]);\n });\n }\n\n return text;\n}\n","import Ajv, { ErrorObject } from 'ajv';\nimport schema from './schema.json';\nimport { m } from './intl';\n\nexport { schema as inputSchema };\nconst { definitions } = schema;\n\n/**\n * This function parses AJV error and transforms it into a readable string.\n *\n * @param error An error as returned from AJV.\n * @param rootName Usually 'input' or 'schema' based on if we are passing the input or schema.\n * @param properties (Used only when parsing input errors) List of input schema properties.\n * @param input (Used only when parsing input errors) Actual input that is being parsed.\n * @returns {null|{fieldKey: *, message: *}}\n */\nexport function parseAjvError(\n error: ErrorObject,\n rootName: string,\n properties: Record<string, { nullable?: boolean }> = {},\n input: Record<string, unknown> = {},\n): { fieldKey: string; message: string } | null {\n // There are 3 possible errors comming from validation:\n // - either { keword: 'anything', instancePath: '/someField', message: 'error message that we can use' }\n // - or { keyword: 'additionalProperties', params: { additionalProperty: 'field' }, message: 'must NOT have additional properties' }\n // - or { keyword: 'required', instancePath: '', params.missingProperty: 'someField' }\n\n let fieldKey: string;\n let message: string;\n\n // If error is with keyword type, it means that type of input is incorrect\n // this can mean that provided value is null\n if (error.keyword === 'type') {\n fieldKey = error.instancePath.split('/').pop()!;\n // Check if value is null and field is nullable, if yes, then skip this error\n if (properties[fieldKey] && properties[fieldKey].nullable && input[fieldKey] === null) {\n return null;\n }\n message = m('inputSchema.validation.generic', { rootName, fieldKey, message: error.message });\n } else if (error.keyword === 'required') {\n fieldKey = error.params.missingProperty;\n message = m('inputSchema.validation.required', { rootName, fieldKey });\n } else if (error.keyword === 'additionalProperties') {\n fieldKey = error.params.additionalProperty;\n message = m('inputSchema.validation.additionalProperty', { rootName, fieldKey });\n } else if (error.keyword === 'enum') {\n fieldKey = error.instancePath.split('/').pop()!;\n const errorMessage = `${error.message}: \"${error.params.allowedValues.join('\", \"')}\"`;\n message = m('inputSchema.validation.generic', { rootName, fieldKey, message: errorMessage });\n } else {\n fieldKey = error.instancePath.split('/').pop()!;\n message = m('inputSchema.validation.generic', { rootName, fieldKey, message: error.message });\n }\n\n return { fieldKey, message };\n}\n\n/**\n * Validates given object against schema and throws a human readable error.\n */\nconst validateAgainstSchemaOrThrow = <T> (validator: Ajv, obj: T, inputSchema: any, rootName: string) => {\n if (validator.validate(inputSchema, obj)) return;\n\n const errorMessage = parseAjvError(validator.errors![0], rootName)?.message;\n throw new Error(`Input schema is not valid (${errorMessage})`);\n};\n\n/**\n * This validates given object only against the basic input schema without checking the particular fields.\n * We override schema.properties.properties not to validate field defitions.\n */\nconst validateBasicStructure = <T> (validator: Ajv, obj: T) => {\n const schemaWithoutProperties = { ...schema };\n schemaWithoutProperties.properties = { ...schema.properties, properties: { type: 'object' } as any };\n validateAgainstSchemaOrThrow(validator, obj, schemaWithoutProperties, 'schema');\n};\n\n/**\n * Validates particular field against it's schema.\n */\nconst validateField = <T extends Record<string, any>> (validator: Ajv, fieldSchema: T, fieldKey: string) => {\n const matchingDefinitions = Object\n .values<any>(definitions) // cast as any, as the code in first branch seems to be invalid\n .filter((definition) => {\n return definition.properties.type.enum\n // This is a normal case where fieldSchema.type can be only one possible value matching definition.properties.type.enum.0\n ? definition.properties.type.enum[0] === fieldSchema.type\n // This is a type \"Any\" where fieldSchema.type is an array of possible values\n : Array.isArray(fieldSchema.type);\n });\n\n // There is not matching definition.\n if (matchingDefinitions.length === 0) {\n const errorMessage = m('inputSchema.validation.noMatchingDefinition', { fieldKey });\n throw new Error(`Input schema is not valid (${errorMessage})`);\n }\n\n // If there is only one matching then we are done and simply compare it.\n if (matchingDefinitions.length === 1) {\n validateAgainstSchemaOrThrow(validator, fieldSchema, matchingDefinitions[0], `schema.properties.${fieldKey}`);\n return;\n }\n\n // If there are more matching definitions then the type is string and we need to get the right one.\n // If the definition contains \"enum\" property then it's enum type.\n if (fieldSchema.enum) {\n const definition = matchingDefinitions.filter((item) => !!item.properties.enum).pop();\n if (!definition) throw new Error('Input schema validation failed to find \"enum property\" definition');\n validateAgainstSchemaOrThrow(validator, fieldSchema, definition, `schema.properties.${fieldKey}.enum`);\n return;\n }\n // Otherwise we use the other definition.\n const definition = matchingDefinitions.filter((item) => !item.properties.enum).pop();\n if (!definition) throw new Error('Input schema validation failed to find other than \"enum property\" definition');\n\n validateAgainstSchemaOrThrow(validator, fieldSchema, definition, `schema.properties.${fieldKey}`);\n};\n\n/**\n * This function validates given input schema first just for basic structure then each field one by one and\n * finally fully against the whole schema.\n *\n * This way we get the most accurate error message for user.\n */\nexport function validateInputSchema<T extends Record<string, any>>(validator: Ajv, inputSchema: T) {\n // First validate just basic structure without fields.\n validateBasicStructure(validator, inputSchema);\n\n // Then validate each field separately.\n Object.entries<any>(inputSchema.properties).forEach(([fieldKey, fieldSchema]) => validateField(validator, fieldSchema, fieldKey));\n\n // Finally just to be sure run validation against the whole shema.\n validateAgainstSchemaOrThrow(validator, inputSchema, schema, 'schema');\n}\n","import { PROXY_URL_REGEX, URL_REGEX } from '@apify/consts';\nimport { countries } from 'countries-list';\nimport { ValidateFunction } from 'ajv';\nimport { parseScript } from 'escaya';\nimport { m } from './intl';\nimport { parseAjvError } from './input_schema';\n\n/**\n * Validates input field configured with proxy editor\n * @param fieldKey Proxy field value\n * @param value Proxy field value\n * @param [isRequired] Whether the field is required or not\n * @param [options] Information about proxy groups availability\n * @param [options.hasAutoProxyGroups] Informs validation whether user has atleast one proxy group available in auto mode\n * @param [options.availableProxyGroups] List of available proxy groups\n * @param [options.disabledProxyGroups] Object with groupId as key and error message as value (mostly for residential/SERP)\n */\nfunction validateProxyField(\n fieldKey: Record<string, unknown>,\n value: Record<string, any>,\n isRequired = false,\n options: { hasAutoProxyGroups?: boolean; availableProxyGroups?: string[]; disabledProxyGroups?: Record<string, unknown> } | null = null,\n) {\n const fieldErrors: any[] = [];\n if (isRequired) {\n // Nullable error is already handled by AJV\n if (value === null) return fieldErrors;\n if (!value) {\n const message = m('inputSchema.validation.required', { rootName: 'input', fieldKey });\n fieldErrors.push(message);\n return fieldErrors;\n }\n\n const { useApifyProxy, proxyUrls } = value;\n if (!useApifyProxy && (!Array.isArray(proxyUrls) || proxyUrls.length === 0)) {\n fieldErrors.push(m('inputSchema.validation.proxyRequired', { rootName: 'input', fieldKey }));\n return fieldErrors;\n }\n }\n\n // Input is not required, so missing value is valid\n if (!value) return fieldErrors;\n\n const { useApifyProxy, proxyUrls, apifyProxyGroups, apifyProxyCountry } = value;\n\n if (!useApifyProxy && Array.isArray(proxyUrls)) {\n let invalidUrl = false;\n proxyUrls.forEach((url) => {\n if (!PROXY_URL_REGEX.test(url.trim())) invalidUrl = url.trim();\n });\n if (invalidUrl) {\n fieldErrors.push(m('inputSchema.validation.customProxyInvalid', { invalidUrl }));\n }\n }\n\n // Apify proxy country can be set only when using Apify proxy\n if (!useApifyProxy && apifyProxyCountry) {\n fieldErrors.push(m('inputSchema.validation.apifyProxyCountryWithoutApifyProxyForbidden'));\n }\n\n // If Apify proxy is not used skip additional checks\n if (!useApifyProxy) return fieldErrors;\n\n // If Apify proxy is used, check if there is a selected country and if so, check that it's valid (empty or a valid country code)\n if (apifyProxyCountry && !countries[apifyProxyCountry]) {\n fieldErrors.push(m('inputSchema.validation.apifyProxyCountryInvalid', { invalidCountry: apifyProxyCountry }));\n }\n\n // If options are not provided skip additional checks\n if (!options) return fieldErrors;\n\n const selectedProxyGroups = (apifyProxyGroups || []);\n\n // Auto mode, check that user has access to alteast one proxy group usable in this mode\n if (!selectedProxyGroups.length && !options.hasAutoProxyGroups) {\n fieldErrors.push(m('inputSchema.validation.noAvailableAutoProxy'));\n return fieldErrors;\n }\n\n // Check if proxy groups selected by user are available to him\n const availableProxyGroupsById = {};\n (options.availableProxyGroups || []).forEach((group) => { availableProxyGroupsById[group] = true; });\n const unavailableProxyGroups = selectedProxyGroups.filter((group: string) => !availableProxyGroupsById[group]);\n\n if (unavailableProxyGroups.length) {\n fieldErrors.push(m('inputSchema.validation.proxyGroupsNotAvailable', {\n rootName: 'input',\n fieldKey,\n groups: unavailableProxyGroups.join(', '),\n }));\n }\n\n // Check if any of the proxy groups are blocked and if yes then output the associated message\n const blockedProxyGroupsById = options.disabledProxyGroups || {};\n selectedProxyGroups\n .filter((group: string) => blockedProxyGroupsById[group])\n .forEach((blockedGroup: string) => {\n fieldErrors.push(blockedProxyGroupsById[blockedGroup]);\n });\n\n return fieldErrors;\n}\n\n/**\n * Uses AJV validator to validate input with input schema and then\n * does custom validation for our own properties (nullable, patternKey, patternValue)\n * @param validator Initialized AJV validator\n * @param inputSchema Valid input schema in object\n * @param input Input object to be validated\n * @param options (Optional) Additional validation configuration for certain fields\n */\nexport function validateInputUsingValidator(\n validator: ValidateFunction,\n inputSchema: Record<string, any>,\n input: Record<string, unknown>,\n options: Record<string, any> = {},\n) {\n const isValid = validator(input); // Check if input is valid based on schema values\n\n const { properties } = inputSchema;\n const required = inputSchema.required || [];\n\n let errors: { fieldKey: string, message: string }[] = [];\n // Process AJV validation errors\n if (!isValid) {\n errors = validator.errors!\n .map((error) => parseAjvError(error, 'input', properties, input))\n .filter((error) => !!error) as any[];\n }\n\n Object.keys(properties).forEach((property) => {\n const value = input[property] as Record<string, any>;\n const { type, editor, patternKey, patternValue } = properties[property];\n const fieldErrors = [];\n // Check that proxy is required, if yes, valides that it's correctly setup\n if (type === 'object' && editor === 'proxy') {\n const proxyValidationErrors = validateProxyField(property as any, value, required.includes(property), options.proxy);\n proxyValidationErrors.forEach((error) => {\n fieldErrors.push(error);\n });\n }\n // Check that array items fit patternKey and patternValue\n if (type === 'array' && value && Array.isArray(value)) {\n if (editor === 'requestListSources') {\n const invalidIndexes: any[] = [];\n value.forEach((item, index) => {\n if (!item) invalidIndexes.push(index);\n else if (!item.url && !item.requestsFromUrl) invalidIndexes.push(index);\n else if (item.url && !URL_REGEX.test(item.url)) invalidIndexes.push(index);\n else if (item.requestsFromUrl && !URL_REGEX.test(item.requestsFromUrl)) invalidIndexes.push(index);\n });\n if (invalidIndexes.length) {\n fieldErrors.push(m('inputSchema.validation.requestListSourcesInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidIndexes: invalidIndexes.join(','),\n }));\n }\n }\n // If patternKey is provided, then validate keys of objects in array\n if (patternKey && editor === 'keyValue') {\n const check = new RegExp(patternKey);\n const invalidIndexes: any[] = [];\n value.forEach((item, index) => {\n if (!check.test(item.key)) invalidIndexes.push(index);\n });\n if (invalidIndexes.length) {\n fieldErrors.push(m('inputSchema.validation.arrayKeysInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidIndexes: invalidIndexes.join(','),\n pattern: patternKey,\n }));\n }\n }\n // If patternValue is provided and editor is keyValue, then validate values of objecs in array\n if (patternValue && editor === 'keyValue') {\n const check = new RegExp(patternValue);\n const invalidIndexes: any[] = [];\n value.forEach((item, index) => {\n if (!check.test(item.value)) invalidIndexes.push(index);\n });\n if (invalidIndexes.length) {\n fieldErrors.push(m('inputSchema.validation.arrayValuesInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidIndexes: invalidIndexes.join(','),\n pattern: patternValue,\n }));\n }\n // If patternValue is provided and editor is stringList, then validate each item in array\n } else if (patternValue && editor === 'stringList') {\n const check = new RegExp(patternValue);\n const invalidIndexes: any[] = [];\n value.forEach((item, index) => {\n if (!check.test(item)) invalidIndexes.push(index);\n });\n if (invalidIndexes.length) {\n fieldErrors.push(m('inputSchema.validation.arrayValuesInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidIndexes: invalidIndexes.join(','),\n pattern: patternValue,\n }));\n }\n }\n }\n // Check that object items fit patternKey and patternValue\n if (type === 'object' && value) {\n if (patternKey) {\n const check = new RegExp(patternKey);\n const invalidKeys: any[] = [];\n Object.keys(value).forEach((key) => {\n if (!check.test(key)) invalidKeys.push(key);\n });\n if (invalidKeys.length) {\n fieldErrors.push(m('inputSchema.validation.objectKeysInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidKeys: invalidKeys.join(','),\n pattern: patternKey,\n }));\n }\n }\n if (patternValue) {\n const check = new RegExp(patternValue);\n const invalidKeys: any[] = [];\n Object.keys(value).forEach((key) => {\n const propertyValue = value[key];\n if (typeof propertyValue !== 'string' || !check.test(propertyValue)) invalidKeys.push(key);\n });\n if (invalidKeys.length) {\n fieldErrors.push(m('inputSchema.validation.objectValuesInvalid', {\n rootName: 'input',\n fieldKey: property,\n invalidKeys: invalidKeys.join(','),\n pattern: patternValue,\n }));\n }\n }\n }\n if (fieldErrors.length > 0) {\n const message = fieldErrors.join(', ');\n errors.push({ fieldKey: property, message });\n }\n });\n\n return errors;\n}\n\n/**\n * This functions parses all given JSON and then takes each of the jsFields.\n * Then if the field:\n * - is valid JS single function it replaces its single line string with a function delacation.\n * - is valid multiline JS code then replaces its single line string with `multiline` string\n * Then stringifies the code with given number of jsonSpacing spaces and finally prefixes whole\n * stringified JSON except the first line with globalSpacing spaces.\n */\nexport function makeInputJsFieldsReadable(json: string, jsFields: string[], jsonSpacing = 4, globalSpacing = 0): string {\n const parsedJson = JSON.parse(json);\n const replacements: Record<string, any> = {};\n\n jsFields.forEach((field) => {\n let maybeFunction = parsedJson[field];\n if (!maybeFunction || typeof maybeFunction !== 'string') return;\n\n let ast;\n try {\n ast = parseScript(maybeFunction, { cst: true });\n } catch (err) {\n // Don't do anything in a case of invalid JS code.\n return;\n }\n\n const isMultiline = maybeFunction.includes('\\n');\n const isSingleFunction = ast\n && ast.leafs\n && ast.leafs.length === 1 // Must have only one expression inside!\n && ast.leafs[0]\n && (\n // Normal function ...\n ast.leafs[0].type === 'FunctionDeclaration'\n // or arrow function\n || (\n ast.leafs[0].type === 'ExpressionStatement'\n && (ast.leafs[0] as { expression: { type: string } }).expression.type === 'ArrowFunction'\n )\n );\n\n // If it's not a function declaration or multiline JS code then we do nothing.\n if (!isSingleFunction && !isMultiline) return;\n\n const spaces = (new Array(isSingleFunction ? jsonSpacing : jsonSpacing * 2)).fill(' ').join('');\n maybeFunction = maybeFunction\n .split('\\n').join(`\\n${spaces}`) // This prefixes each line with spaces.\n .trim(); // Trim whitespace on both sides\n\n const replacementValue = isSingleFunction\n ? maybeFunction.replace(/[;]+$/g, '') // Remove trailing semicolons\n : `\\`${maybeFunction}\\``;\n const replacementToken = `<<<REPLACEMENT_TOKEN:${Math.random()}>>>`;\n replacements[replacementToken] = replacementValue;\n parsedJson[field] = replacementToken;\n });\n\n let niceJson = JSON.stringify(parsedJson, null, jsonSpacing);\n\n Object.entries(replacements).forEach(([replacementToken, replacementValue]) => {\n niceJson = niceJson.replace(`\"${replacementToken}\"`, replacementValue);\n });\n\n const globalSpaces = (new Array(globalSpacing)).fill(' ').join('');\n niceJson = niceJson.split('\\n').join(`\\n${globalSpaces}`);\n\n return niceJson;\n}\n"],"mappings":";;;;;AACA,IAAM,cAAc;AAAA,EAChB,kCACI;AAAA,EACJ,mCACI;AAAA,EACJ,wCACI;AAAA,EACJ,oDACI;AAAA,EACJ,2CACI;AAAA,EACJ,6CACI;AAAA,EACJ,4CACI;AAAA,EACJ,8CACI;AAAA,EACJ,6CACI;AAAA,EACJ,kDACI;AAAA,EACJ,6CACI;AAAA,EACJ,mDACI;AAAA,EACJ,sEACI;AAAA,EACJ,+CACI;AAAA,EACJ,+CACI;AACR;AAMO,WAAW,UAAkB,WAAiC;AACjE,MAAI,OAAO,YAAY;AACvB,MAAI,CAAC;AAAM,WAAO;AAElB,MAAI,WAAW;AACX,WAAO,KAAK,SAAS,EAAE,QAAQ,CAAC,iBAAiB;AAC7C,aAAO,KAAK,MAAM,IAAI,eAAe,EAAE,KAAK,UAAU,aAAa;AAAA,IACvE,CAAC;AAAA,EACL;AAEA,SAAO;AACX;AAXgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACjChB,IAAM,EAAE,gBAAgB;AAWjB,uBACH,OACA,UACA,aAAqD,CAAC,GACtD,QAAiC,CAAC,GACU;AAM5C,MAAI;AACJ,MAAI;AAIJ,MAAI,MAAM,YAAY,QAAQ;AAC1B,eAAW,MAAM,aAAa,MAAM,GAAG,EAAE,IAAI;AAE7C,QAAI,WAAW,aAAa,WAAW,UAAU,YAAY,MAAM,cAAc,MAAM;AACnF,aAAO;AAAA,IACX;AACA,cAAU,EAAE,kCAAkC,EAAE,UAAU,UAAU,SAAS,MAAM,QAAQ,CAAC;AAAA,EAChG,WAAW,MAAM,YAAY,YAAY;AACrC,eAAW,MAAM,OAAO;AACxB,cAAU,EAAE,mCAAmC,EAAE,UAAU,SAAS,CAAC;AAAA,EACzE,WAAW,MAAM,YAAY,wBAAwB;AACjD,eAAW,MAAM,OAAO;AACxB,cAAU,EAAE,6CAA6C,EAAE,UAAU,SAAS,CAAC;AAAA,EACnF,WAAW,MAAM,YAAY,QAAQ;AACjC,eAAW,MAAM,aAAa,MAAM,GAAG,EAAE,IAAI;AAC7C,UAAM,eAAe,GAAG,MAAM,aAAa,MAAM,OAAO,cAAc,KAAK,MAAM;AACjF,cAAU,EAAE,kCAAkC,EAAE,UAAU,UAAU,SAAS,aAAa,CAAC;AAAA,EAC/F,OAAO;AACH,eAAW,MAAM,aAAa,MAAM,GAAG,EAAE,IAAI;AAC7C,cAAU,EAAE,kCAAkC,EAAE,UAAU,UAAU,SAAS,MAAM,QAAQ,CAAC;AAAA,EAChG;AAEA,SAAO,EAAE,UAAU,QAAQ;AAC/B;AAvCgB;AA4ChB,IAAM,+BAA+B,wBAAK,WAAgB,KAAQ,aAAkB,aAAqB;AACrG,MAAI,UAAU,SAAS,aAAa,GAAG;AAAG;AAE1C,QAAM,eAAe,cAAc,UAAU,OAAQ,IAAI,QAAQ,GAAG;AACpE,QAAM,IAAI,MAAM,8BAA8B,eAAe;AACjE,GALqC;AAWrC,IAAM,yBAAyB,wBAAK,WAAgB,QAAW;AAC3D,QAAM,0BAA0B,EAAE,GAAG,eAAO;AAC5C,0BAAwB,aAAa,EAAE,GAAG,eAAO,YAAY,YAAY,EAAE,MAAM,SAAS,EAAS;AACnG,+BAA6B,WAAW,KAAK,yBAAyB,QAAQ;AAClF,GAJ+B;AAS/B,IAAM,gBAAgB,wBAAiC,WAAgB,aAAgB,aAAqB;AACxG,QAAM,sBAAsB,OACvB,OAAY,WAAW,EACvB,OAAO,CAAC,gBAAe;AACpB,WAAO,YAAW,WAAW,KAAK,OAE5B,YAAW,WAAW,KAAK,KAAK,OAAO,YAAY,OAEnD,MAAM,QAAQ,YAAY,IAAI;AAAA,EACxC,CAAC;AAGL,MAAI,oBAAoB,WAAW,GAAG;AAClC,UAAM,eAAe,EAAE,+CAA+C,EAAE,SAAS,CAAC;AAClF,UAAM,IAAI,MAAM,8BAA8B,eAAe;AAAA,EACjE;AAGA,MAAI,oBAAoB,WAAW,GAAG;AAClC,iCAA6B,WAAW,aAAa,oBAAoB,IAAI,qBAAqB,UAAU;AAC5G;AAAA,EACJ;AAIA,MAAI,YAAY,MAAM;AAClB,UAAM,cAAa,oBAAoB,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,WAAW,IAAI,EAAE,IAAI;AACpF,QAAI,CAAC;AAAY,YAAM,IAAI,MAAM,mEAAmE;AACpG,iCAA6B,WAAW,aAAa,aAAY,qBAAqB,eAAe;AACrG;AAAA,EACJ;AAEA,QAAM,aAAa,oBAAoB,OAAO,CAAC,SAAS,CAAC,KAAK,WAAW,IAAI,EAAE,IAAI;AACnF,MAAI,CAAC;AAAY,UAAM,IAAI,MAAM,8EAA8E;AAE/G,+BAA6B,WAAW,aAAa,YAAY,qBAAqB,UAAU;AACpG,GApCsB;AA4Cf,6BAA4D,WAAgB,aAAgB;AAE/F,yBAAuB,WAAW,WAAW;AAG7C,SAAO,QAAa,YAAY,UAAU,EAAE,QAAQ,CAAC,CAAC,UAAU,iBAAiB,cAAc,WAAW,aAAa,QAAQ,CAAC;AAGhI,+BAA6B,WAAW,aAAa,gBAAQ,QAAQ;AACzE;AATgB;;;AC5HhB;AACA;AAEA;AAcA,4BACI,UACA,OACA,aAAa,OACb,UAAmI,MACrI;AACE,QAAM,cAAqB,CAAC;AAC5B,MAAI,YAAY;AAEZ,QAAI,UAAU;AAAM,aAAO;AAC3B,QAAI,CAAC,OAAO;AACR,YAAM,UAAU,EAAE,mCAAmC,EAAE,UAAU,SAAS,SAAS,CAAC;AACpF,kBAAY,KAAK,OAAO;AACxB,aAAO;AAAA,IACX;AAEA,UAAM,EAAE,+BAAe,0BAAc;AACrC,QAAI,CAAC,kBAAkB,EAAC,MAAM,QAAQ,UAAS,KAAK,WAAU,WAAW,IAAI;AACzE,kBAAY,KAAK,EAAE,wCAAwC,EAAE,UAAU,SAAS,SAAS,CAAC,CAAC;AAC3F,aAAO;AAAA,IACX;AAAA,EACJ;AAGA,MAAI,CAAC;AAAO,WAAO;AAEnB,QAAM,EAAE,eAAe,WAAW,kBAAkB,sBAAsB;AAE1E,MAAI,CAAC,iBAAiB,MAAM,QAAQ,SAAS,GAAG;AAC5C,QAAI,aAAa;AACjB,cAAU,QAAQ,CAAC,QAAQ;AACvB,UAAI,CAAC,gBAAgB,KAAK,IAAI,KAAK,CAAC;AAAG,qBAAa,IAAI,KAAK;AAAA,IACjE,CAAC;AACD,QAAI,YAAY;AACZ,kBAAY,KAAK,EAAE,6CAA6C,EAAE,WAAW,CAAC,CAAC;AAAA,IACnF;AAAA,EACJ;AAGA,MAAI,CAAC,iBAAiB,mBAAmB;AACrC,gBAAY,KAAK,EAAE,oEAAoE,CAAC;AAAA,EAC5F;AAGA,MAAI,CAAC;AAAe,WAAO;AAG3B,MAAI,qBAAqB,CAAC,UAAU,oBAAoB;AACpD,gBAAY,KAAK,EAAE,mDAAmD,EAAE,gBAAgB,kBAAkB,CAAC,CAAC;AAAA,EAChH;AAGA,MAAI,CAAC;AAAS,WAAO;AAErB,QAAM,sBAAuB,oBAAoB,CAAC;AAGlD,MAAI,CAAC,oBAAoB,UAAU,CAAC,QAAQ,oBAAoB;AAC5D,gBAAY,KAAK,EAAE,6CAA6C,CAAC;AACjE,WAAO;AAAA,EACX;AAGA,QAAM,2BAA2B,CAAC;AAClC,EAAC,SAAQ,wBAAwB,CAAC,GAAG,QAAQ,CAAC,UAAU;AAAE,6BAAyB,SAAS;AAAA,EAAM,CAAC;AACnG,QAAM,yBAAyB,oBAAoB,OAAO,CAAC,UAAkB,CAAC,yBAAyB,MAAM;AAE7G,MAAI,uBAAuB,QAAQ;AAC/B,gBAAY,KAAK,EAAE,kDAAkD;AAAA,MACjE,UAAU;AAAA,MACV;AAAA,MACA,QAAQ,uBAAuB,KAAK,IAAI;AAAA,IAC5C,CAAC,CAAC;AAAA,EACN;AAGA,QAAM,yBAAyB,QAAQ,uBAAuB,CAAC;AAC/D,sBACK,OAAO,CAAC,UAAkB,uBAAuB,MAAM,EACvD,QAAQ,CAAC,iBAAyB;AAC/B,gBAAY,KAAK,uBAAuB,aAAa;AAAA,EACzD,CAAC;AAEL,SAAO;AACX;AApFS;AA8FF,qCACH,WACA,aACA,OACA,UAA+B,CAAC,GAClC;AACE,QAAM,UAAU,UAAU,KAAK;AAE/B,QAAM,EAAE,eAAe;AACvB,QAAM,WAAW,YAAY,YAAY,CAAC;AAE1C,MAAI,SAAkD,CAAC;AAEvD,MAAI,CAAC,SAAS;AACV,aAAS,UAAU,OACd,IAAI,CAAC,UAAU,cAAc,OAAO,SAAS,YAAY,KAAK,CAAC,EAC/D,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK;AAAA,EAClC;AAEA,SAAO,KAAK,UAAU,EAAE,QAAQ,CAAC,aAAa;AAC1C,UAAM,QAAQ,MAAM;AACpB,UAAM,EAAE,MAAM,QAAQ,YAAY,iBAAiB,WAAW;AAC9D,UAAM,cAAc,CAAC;AAErB,QAAI,SAAS,YAAY,WAAW,SAAS;AACzC,YAAM,wBAAwB,mBAAmB,UAAiB,OAAO,SAAS,SAAS,QAAQ,GAAG,QAAQ,KAAK;AACnH,4BAAsB,QAAQ,CAAC,UAAU;AACrC,oBAAY,KAAK,KAAK;AAAA,MAC1B,CAAC;AAAA,IACL;AAEA,QAAI,SAAS,WAAW,SAAS,MAAM,QAAQ,KAAK,GAAG;AACnD,UAAI,WAAW,sBAAsB;AACjC,cAAM,iBAAwB,CAAC;AAC/B,cAAM,QAAQ,CAAC,MAAM,UAAU;AAC3B,cAAI,CAAC;AAAM,2BAAe,KAAK,KAAK;AAAA,mBAC3B,CAAC,KAAK,OAAO,CAAC,KAAK;AAAiB,2BAAe,KAAK,KAAK;AAAA,mBAC7D,KAAK,OAAO,CAAC,UAAU,KAAK,KAAK,GAAG;AAAG,2BAAe,KAAK,KAAK;AAAA,mBAChE,KAAK,mBAAmB,CAAC,UAAU,KAAK,KAAK,eAAe;AAAG,2BAAe,KAAK,KAAK;AAAA,QACrG,CAAC;AACD,YAAI,eAAe,QAAQ;AACvB,sBAAY,KAAK,EAAE,oDAAoD;AAAA,YACnE,UAAU;AAAA,YACV,UAAU;AAAA,YACV,gBAAgB,eAAe,KAAK,GAAG;AAAA,UAC3C,CAAC,CAAC;AAAA,QACN;AAAA,MACJ;AAEA,UAAI,cAAc,WAAW,YAAY;AACrC,cAAM,QAAQ,IAAI,OAAO,UAAU;AACnC,cAAM,iBAAwB,CAAC;AAC/B,cAAM,QAAQ,CAAC,MAAM,UAAU;AAC3B,cAAI,CAAC,MAAM,KAAK,KAAK,GAAG;AAAG,2BAAe,KAAK,KAAK;AAAA,QACxD,CAAC;AACD,YAAI,eAAe,QAAQ;AACvB,sBAAY,KAAK,EAAE,2CAA2C;AAAA,YAC1D,UAAU;AAAA,YACV,UAAU;AAAA,YACV,gBAAgB,eAAe,KAAK,GAAG;AAAA,YACvC,SAAS;AAAA,UACb,CAAC,CAAC;AAAA,QACN;AAAA,MACJ;AAEA,UAAI,gBAAgB,WAAW,YAAY;AACvC,cAAM,QAAQ,IAAI,OAAO,YAAY;AACrC,cAAM,iBAAwB,CAAC;AAC/B,cAAM,QAAQ,CAAC,MAAM,UAAU;AAC3B,cAAI,CAAC,MAAM,KAAK,KAAK,KAAK;AAAG,2BAAe,KAAK,KAAK;AAAA,QAC1D,CAAC;AACD,YAAI,eAAe,QAAQ;AACvB,sBAAY,KAAK,EAAE,6CAA6C;AAAA,YAC5D,UAAU;AAAA,YACV,UAAU;AAAA,YACV,gBAAgB,eAAe,KAAK,GAAG;AAAA,YACvC,SAAS;AAAA,UACb,CAAC,CAAC;AAAA,QACN;AAAA,MAEJ,WAAW,gBAAgB,WAAW,cAAc;AAChD,cAAM,QAAQ,IAAI,OAAO,YAAY;AACrC,cAAM,iBAAwB,CAAC;AAC/B,cAAM,QAAQ,CAAC,MAAM,UAAU;AAC3B,cAAI,CAAC,MAAM,KAAK,IAAI;AAAG,2BAAe,KAAK,KAAK;AAAA,QACpD,CAAC;AACD,YAAI,eAAe,QAAQ;AACvB,sBAAY,KAAK,EAAE,6CAA6C;AAAA,YAC5D,UAAU;AAAA,YACV,UAAU;AAAA,YACV,gBAAgB,eAAe,KAAK,GAAG;AAAA,YACvC,SAAS;AAAA,UACb,CAAC,CAAC;AAAA,QACN;AAAA,MACJ;AAAA,IACJ;AAEA,QAAI,SAAS,YAAY,OAAO;AAC5B,UAAI,YAAY;AACZ,cAAM,QAAQ,IAAI,OAAO,UAAU;AACnC,cAAM,cAAqB,CAAC;AAC5B,eAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAChC,cAAI,CAAC,MAAM,KAAK,GAAG;AAAG,wBAAY,KAAK,GAAG;AAAA,QAC9C,CAAC;AACD,YAAI,YAAY,QAAQ;AACpB,sBAAY,KAAK,EAAE,4CAA4C;AAAA,YAC3D,UAAU;AAAA,YACV,UAAU;AAAA,YACV,aAAa,YAAY,KAAK,GAAG;AAAA,YACjC,SAAS;AAAA,UACb,CAAC,CAAC;AAAA,QACN;AAAA,MACJ;AACA,UAAI,cAAc;AACd,cAAM,QAAQ,IAAI,OAAO,YAAY;AACrC,cAAM,cAAqB,CAAC;AAC5B,eAAO,KAAK,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAChC,gBAAM,gBAAgB,MAAM;AAC5B,cAAI,OAAO,kBAAkB,YAAY,CAAC,MAAM,KAAK,aAAa;AAAG,wBAAY,KAAK,GAAG;AAAA,QAC7F,CAAC;AACD,YAAI,YAAY,QAAQ;AACpB,sBAAY,KAAK,EAAE,8CAA8C;AAAA,YAC7D,UAAU;AAAA,YACV,UAAU;AAAA,YACV,aAAa,YAAY,KAAK,GAAG;AAAA,YACjC,SAAS;AAAA,UACb,CAAC,CAAC;AAAA,QACN;AAAA,MACJ;AAAA,IACJ;AACA,QAAI,YAAY,SAAS,GAAG;AACxB,YAAM,UAAU,YAAY,KAAK,IAAI;AACrC,aAAO,KAAK,EAAE,UAAU,UAAU,QAAQ,CAAC;AAAA,IAC/C;AAAA,EACJ,CAAC;AAED,SAAO;AACX;AAzIgB;AAmJT,mCAAmC,MAAc,UAAoB,cAAc,GAAG,gBAAgB,GAAW;AACpH,QAAM,aAAa,KAAK,MAAM,IAAI;AAClC,QAAM,eAAoC,CAAC;AAE3C,WAAS,QAAQ,CAAC,UAAU;AACxB,QAAI,gBAAgB,WAAW;AAC/B,QAAI,CAAC,iBAAiB,OAAO,kBAAkB;AAAU;AAEzD,QAAI;AACJ,QAAI;AACA,YAAM,YAAY,eAAe,EAAE,KAAK,KAAK,CAAC;AAAA,IAClD,SAAS,KAAP;AAEE;AAAA,IACJ;AAEA,UAAM,cAAc,cAAc,SAAS,IAAI;AAC/C,UAAM,mBAAmB,OAClB,IAAI,SACJ,IAAI,MAAM,WAAW,KACrB,IAAI,MAAM,MAGT,KAAI,MAAM,GAAG,SAAS,yBAGlB,IAAI,MAAM,GAAG,SAAS,yBAClB,IAAI,MAAM,GAAwC,WAAW,SAAS;AAKtF,QAAI,CAAC,oBAAoB,CAAC;AAAa;AAEvC,UAAM,SAAU,IAAI,MAAM,mBAAmB,cAAc,cAAc,CAAC,EAAG,KAAK,GAAG,EAAE,KAAK,EAAE;AAC9F,oBAAgB,cACX,MAAM,IAAI,EAAE,KAAK;AAAA,EAAK,QAAQ,EAC9B,KAAK;AAEV,UAAM,mBAAmB,mBACnB,cAAc,QAAQ,UAAU,EAAE,IAClC,KAAK;AACX,UAAM,mBAAmB,wBAAwB,KAAK,OAAO;AAC7D,iBAAa,oBAAoB;AACjC,eAAW,SAAS;AAAA,EACxB,CAAC;AAED,MAAI,WAAW,KAAK,UAAU,YAAY,MAAM,WAAW;AAE3D,SAAO,QAAQ,YAAY,EAAE,QAAQ,CAAC,CAAC,kBAAkB,sBAAsB;AAC3E,eAAW,SAAS,QAAQ,IAAI,qBAAqB,gBAAgB;AAAA,EACzE,CAAC;AAED,QAAM,eAAgB,IAAI,MAAM,aAAa,EAAG,KAAK,GAAG,EAAE,KAAK,EAAE;AACjE,aAAW,SAAS,MAAM,IAAI,EAAE,KAAK;AAAA,EAAK,cAAc;AAExD,SAAO;AACX;AAzDgB;","names":[]}
package/package.json CHANGED
@@ -1,9 +1,17 @@
1
1
  {
2
2
  "name": "@apify/input_schema",
3
- "version": "2.1.0",
3
+ "version": "3.1.0",
4
4
  "description": "Tools and constants shared across Apify projects.",
5
- "main": "index.js",
6
- "typings": "index.d.ts",
5
+ "main": "./index.js",
6
+ "module": "./index.mjs",
7
+ "typings": "./index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./index.mjs",
11
+ "require": "./index.js",
12
+ "types": "./index.d.ts"
13
+ }
14
+ },
7
15
  "keywords": [
8
16
  "apify"
9
17
  ],
@@ -28,19 +36,19 @@
28
36
  "scripts": {
29
37
  "build": "npm run clean && npm run compile && npm run copy",
30
38
  "clean": "rimraf ./dist",
31
- "compile": "tsc -p tsconfig.build.json",
32
- "copy": "ts-node -T ../../scripts/copy.ts"
39
+ "compile": "tsup && tsc -p tsconfig.build.json",
40
+ "copy": "ts-node -T ../../scripts/copy.ts && ts-node -T ./scripts/copy-schema.ts"
33
41
  },
34
42
  "publishConfig": {
35
43
  "access": "public"
36
44
  },
37
45
  "dependencies": {
38
- "@apify/consts": "^1.11.0",
46
+ "@apify/consts": "^2.1.0",
39
47
  "countries-list": "^2.6.1",
40
48
  "escaya": "^0.0.61"
41
49
  },
42
50
  "peerDependencies": {
43
51
  "ajv": "^8.0.0"
44
52
  },
45
- "gitHead": "ed4bf3b571073ea64aa2ed0ba4ee264ba5d269c6"
53
+ "gitHead": "0e506c93a3f45910b294c163b63f9dc3c32b6143"
46
54
  }
package/schema.json CHANGED
@@ -63,6 +63,7 @@
63
63
  "nullable": { "type": "boolean" },
64
64
  "sectionCaption": { "type": "string" },
65
65
  "sectionDescription": { "type": "string" },
66
+
66
67
  "enum": {
67
68
  "type": "array",
68
69
  "items": { "type": "string" }
@@ -114,6 +115,7 @@
114
115
  "minItems": { "type": "integer" },
115
116
  "maxItems": { "type": "integer" },
116
117
  "uniqueItems": { "type": "boolean" },
118
+
117
119
  "editor": { "enum": ["json", "requestListSources", "pseudoUrls", "keyValue", "stringList", "hidden"] },
118
120
  "sectionCaption": { "type": "string" },
119
121
  "sectionDescription": { "type": "string" }
@@ -136,6 +138,7 @@
136
138
  "nullable": { "type": "boolean" },
137
139
  "minProperties": { "type": "integer" },
138
140
  "maxProperties": { "type": "integer" },
141
+
139
142
  "editor": { "enum": ["json", "proxy", "hidden"] },
140
143
  "sectionCaption": { "type": "string" },
141
144
  "sectionDescription": { "type": "string" }
package/input_schema.js DELETED
@@ -1,123 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.validateInputSchema = exports.parseAjvError = exports.inputSchema = void 0;
7
- const schema_json_1 = __importDefault(require("./schema.json"));
8
- exports.inputSchema = schema_json_1.default;
9
- const intl_1 = require("./intl");
10
- const { definitions } = schema_json_1.default;
11
- /**
12
- * This function parses AJV error and transforms it into a readable string.
13
- *
14
- * @param error An error as returned from AJV.
15
- * @param rootName Usually 'input' or 'schema' based on if we are passing the input or schema.
16
- * @param properties (Used only when parsing input errors) List of input schema properties.
17
- * @param input (Used only when parsing input errors) Actual input that is being parsed.
18
- * @returns {null|{fieldKey: *, message: *}}
19
- */
20
- function parseAjvError(error, rootName, properties = {}, input = {}) {
21
- // There are 3 possible errors comming from validation:
22
- // - either { keword: 'anything', instancePath: '/someField', message: 'error message that we can use' }
23
- // - or { keyword: 'additionalProperties', params: { additionalProperty: 'field' }, message: 'must NOT have additional properties' }
24
- // - or { keyword: 'required', instancePath: '', params.missingProperty: 'someField' }
25
- let fieldKey;
26
- let message;
27
- // If error is with keyword type, it means that type of input is incorrect
28
- // this can mean that provided value is null
29
- if (error.keyword === 'type') {
30
- fieldKey = error.instancePath.split('/').pop();
31
- // Check if value is null and field is nullable, if yes, then skip this error
32
- if (properties[fieldKey] && properties[fieldKey].nullable && input[fieldKey] === null) {
33
- return null;
34
- }
35
- message = (0, intl_1.m)('inputSchema.validation.generic', { rootName, fieldKey, message: error.message });
36
- }
37
- else if (error.keyword === 'required') {
38
- fieldKey = error.params.missingProperty;
39
- message = (0, intl_1.m)('inputSchema.validation.required', { rootName, fieldKey });
40
- }
41
- else if (error.keyword === 'additionalProperties') {
42
- fieldKey = error.params.additionalProperty;
43
- message = (0, intl_1.m)('inputSchema.validation.additionalProperty', { rootName, fieldKey });
44
- }
45
- else {
46
- fieldKey = error.instancePath.split('/').pop();
47
- message = (0, intl_1.m)('inputSchema.validation.generic', { rootName, fieldKey, message: error.message });
48
- }
49
- return { fieldKey, message };
50
- }
51
- exports.parseAjvError = parseAjvError;
52
- /**
53
- * Validates given object against schema and throws a human readable error.
54
- */
55
- const validateAgainstSchemaOrThrow = (validator, obj, inputSchema, rootName) => {
56
- var _a;
57
- if (validator.validate(inputSchema, obj))
58
- return;
59
- const errorMessage = (_a = parseAjvError(validator.errors[0], rootName)) === null || _a === void 0 ? void 0 : _a.message;
60
- throw new Error(`Input schema is not valid (${errorMessage})`);
61
- };
62
- /**
63
- * This validates given object only against the basic input schema without checking the particular fields.
64
- * We override schema.properties.properties not to validate field defitions.
65
- */
66
- const validateBasicStructure = (validator, obj) => {
67
- const schemaWithoutProperties = Object.assign({}, schema_json_1.default);
68
- schemaWithoutProperties.properties = Object.assign(Object.assign({}, schema_json_1.default.properties), { properties: { type: 'object' } });
69
- validateAgainstSchemaOrThrow(validator, obj, schemaWithoutProperties, 'schema');
70
- };
71
- /**
72
- * Validates particular field against it's schema.
73
- */
74
- const validateField = (validator, fieldSchema, fieldKey) => {
75
- const matchingDefinitions = Object
76
- .values(definitions) // cast as any, as the code in first branch seems to be invalid
77
- .filter((definition) => {
78
- return definition.properties.type.enum
79
- // This is a normal case where fieldSchema.type can be only one possible value matching definition.properties.type.enum.0
80
- ? definition.properties.type.enum[0] === fieldSchema.type
81
- // This is a type "Any" where fieldSchema.type is an array of possible values
82
- : Array.isArray(fieldSchema.type);
83
- });
84
- // There is not matching definition.
85
- if (matchingDefinitions.length === 0) {
86
- const errorMessage = (0, intl_1.m)('inputSchema.validation.noMatchingDefinition', { fieldKey });
87
- throw new Error(`Input schema is not valid (${errorMessage})`);
88
- }
89
- // If there is only one matching then we are done and simply compare it.
90
- if (matchingDefinitions.length === 1) {
91
- validateAgainstSchemaOrThrow(validator, fieldSchema, matchingDefinitions[0], `schema.properties.${fieldKey}`);
92
- return;
93
- }
94
- // If there are more matching definitions then the type is string and we need to get the right one.
95
- // If the definition contains "enum" property then it's enum type.
96
- if (fieldSchema.enum) {
97
- const definition = matchingDefinitions.filter((item) => !!item.properties.enum).pop();
98
- if (!definition)
99
- throw new Error('Input schema validation failed to find "enum property" definition');
100
- validateAgainstSchemaOrThrow(validator, fieldSchema, definition, `schema.properties.${fieldKey}.enum`);
101
- return;
102
- }
103
- // Otherwise we use the other definition.
104
- const definition = matchingDefinitions.filter((item) => !item.properties.enum).pop();
105
- if (!definition)
106
- throw new Error('Input schema validation failed to find other than "enum property" definition');
107
- validateAgainstSchemaOrThrow(validator, fieldSchema, definition, `schema.properties.${fieldKey}`);
108
- };
109
- /**
110
- * This function validates given input schema first just for basic structure then each field one by one and
111
- * finally fully against the whole schema.
112
- *
113
- * This way we get the most accurate error message for user.
114
- */
115
- function validateInputSchema(validator, inputSchema) {
116
- // First validate just basic structure without fields.
117
- validateBasicStructure(validator, inputSchema);
118
- // Then validate each field separately.
119
- Object.entries(inputSchema.properties).forEach(([fieldKey, fieldSchema]) => validateField(validator, fieldSchema, fieldKey));
120
- // Finally just to be sure run validation against the whole shema.
121
- validateAgainstSchemaOrThrow(validator, inputSchema, schema_json_1.default, 'schema');
122
- }
123
- exports.validateInputSchema = validateInputSchema;
package/intl.js DELETED
@@ -1,37 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.m = void 0;
4
- /* eslint-disable max-len,quotes,quote-props */
5
- const intlStrings = {
6
- 'inputSchema.validation.generic': 'Field {rootName}.{fieldKey} {message}',
7
- 'inputSchema.validation.required': 'Field {rootName}.{fieldKey} is required',
8
- 'inputSchema.validation.proxyRequired': 'Field {rootName}.{fieldKey} is required. Please provide custom proxy URLs or use Apify Proxy.',
9
- 'inputSchema.validation.requestListSourcesInvalid': 'Items in {rootName}.{fieldKey} at positions [{invalidIndexes}] do not contain valid URLs',
10
- 'inputSchema.validation.arrayKeysInvalid': 'Keys in {rootName}.{fieldKey} at positions [{invalidIndexes}] must match regular expression "{pattern}"',
11
- 'inputSchema.validation.arrayValuesInvalid': 'Values in {rootName}.{fieldKey} at positions [{invalidIndexes}] must match regular expression "{pattern}"',
12
- 'inputSchema.validation.objectKeysInvalid': 'Keys [{invalidKeys}] in {rootName}.{fieldKey} must match regular expression "{pattern}',
13
- 'inputSchema.validation.objectValuesInvalid': 'Keys [{invalidKeys}] in {rootName}.{fieldKey} must have string value which matches regular expression "{pattern}"',
14
- 'inputSchema.validation.additionalProperty': 'Property {rootName}.{fieldKey} is not allowed.',
15
- 'inputSchema.validation.proxyGroupsNotAvailable': 'You currently do not have access to proxy groups: {groups}',
16
- 'inputSchema.validation.customProxyInvalid': 'Proxy URL "{invalidUrl}" has invalid format, it must be http://[username[:password]]@hostname:port.',
17
- 'inputSchema.validation.apifyProxyCountryInvalid': 'Country code "{invalidCountry}" is invalid. Only ISO 3166-1 alpha-2 country codes are supported.',
18
- 'inputSchema.validation.apifyProxyCountryWithoutApifyProxyForbidden': 'The country for Apify Proxy can be specified only when using Apify Proxy.',
19
- 'inputSchema.validation.noAvailableAutoProxy': 'Currently you do not have access to any proxy group usable in automatic mode.',
20
- 'inputSchema.validation.noMatchingDefinition': 'Field schema.properties.{fieldKey} is not matching any input schema type definition. Please make sure that it\'s type is valid.',
21
- };
22
- /* eslint-enable max-len,quotes,quote-props */
23
- /**
24
- * Helper function to simulate intl formatMessage function
25
- */
26
- function m(stringId, variables) {
27
- let text = intlStrings[stringId];
28
- if (!text)
29
- return stringId;
30
- if (variables) {
31
- Object.keys(variables).forEach((variableName) => {
32
- text = text.split(`{${variableName}}`).join(variables[variableName]);
33
- });
34
- }
35
- return text;
36
- }
37
- exports.m = m;
package/utilities.js DELETED
@@ -1,294 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.makeInputJsFieldsReadable = exports.validateInputUsingValidator = void 0;
4
- const consts_1 = require("@apify/consts");
5
- const countries_list_1 = require("countries-list");
6
- const escaya_1 = require("escaya");
7
- const intl_1 = require("./intl");
8
- const input_schema_1 = require("./input_schema");
9
- /**
10
- * Validates input field configured with proxy editor
11
- * @param fieldKey Proxy field value
12
- * @param value Proxy field value
13
- * @param [isRequired] Whether the field is required or not
14
- * @param [options] Information about proxy groups availability
15
- * @param [options.hasAutoProxyGroups] Informs validation whether user has atleast one proxy group available in auto mode
16
- * @param [options.availableProxyGroups] List of available proxy groups
17
- * @param [options.disabledProxyGroups] Object with groupId as key and error message as value (mostly for residential/SERP)
18
- */
19
- function validateProxyField(fieldKey, value, isRequired = false, options = null) {
20
- const fieldErrors = [];
21
- if (isRequired) {
22
- // Nullable error is already handled by AJV
23
- if (value === null)
24
- return fieldErrors;
25
- if (!value) {
26
- const message = (0, intl_1.m)('inputSchema.validation.required', { rootName: 'input', fieldKey });
27
- fieldErrors.push(message);
28
- return fieldErrors;
29
- }
30
- const { useApifyProxy, proxyUrls } = value;
31
- if (!useApifyProxy && (!Array.isArray(proxyUrls) || proxyUrls.length === 0)) {
32
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.proxyRequired', { rootName: 'input', fieldKey }));
33
- return fieldErrors;
34
- }
35
- }
36
- // Input is not required, so missing value is valid
37
- if (!value)
38
- return fieldErrors;
39
- const { useApifyProxy, proxyUrls, apifyProxyGroups, apifyProxyCountry } = value;
40
- if (!useApifyProxy && Array.isArray(proxyUrls)) {
41
- let invalidUrl = false;
42
- proxyUrls.forEach((url) => {
43
- if (!consts_1.PROXY_URL_REGEX.test(url.trim()))
44
- invalidUrl = url.trim();
45
- });
46
- if (invalidUrl) {
47
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.customProxyInvalid', { invalidUrl }));
48
- }
49
- }
50
- // Apify proxy country can be set only when using Apify proxy
51
- if (!useApifyProxy && apifyProxyCountry) {
52
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.apifyProxyCountryWithoutApifyProxyForbidden'));
53
- }
54
- // If Apify proxy is not used skip additional checks
55
- if (!useApifyProxy)
56
- return fieldErrors;
57
- // If Apify proxy is used, check if there is a selected country and if so, check that it's valid (empty or a valid country code)
58
- if (apifyProxyCountry && !countries_list_1.countries[apifyProxyCountry]) {
59
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.apifyProxyCountryInvalid', { invalidCountry: apifyProxyCountry }));
60
- }
61
- // If options are not provided skip additional checks
62
- if (!options)
63
- return fieldErrors;
64
- const selectedProxyGroups = (apifyProxyGroups || []);
65
- // Auto mode, check that user has access to alteast one proxy group usable in this mode
66
- if (!selectedProxyGroups.length && !options.hasAutoProxyGroups) {
67
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.noAvailableAutoProxy'));
68
- return fieldErrors;
69
- }
70
- // Check if proxy groups selected by user are available to him
71
- const availableProxyGroupsById = {};
72
- (options.availableProxyGroups || []).forEach((group) => { availableProxyGroupsById[group] = true; });
73
- const unavailableProxyGroups = selectedProxyGroups.filter((group) => !availableProxyGroupsById[group]);
74
- if (unavailableProxyGroups.length) {
75
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.proxyGroupsNotAvailable', {
76
- rootName: 'input',
77
- fieldKey,
78
- groups: unavailableProxyGroups.join(', '),
79
- }));
80
- }
81
- // Check if any of the proxy groups are blocked and if yes then output the associated message
82
- const blockedProxyGroupsById = options.disabledProxyGroups || {};
83
- selectedProxyGroups
84
- .filter((group) => blockedProxyGroupsById[group])
85
- .forEach((blockedGroup) => {
86
- fieldErrors.push(blockedProxyGroupsById[blockedGroup]);
87
- });
88
- return fieldErrors;
89
- }
90
- /**
91
- * Uses AJV validator to validate input with input schema and then
92
- * does custom validation for our own properties (nullable, patternKey, patternValue)
93
- * @param validator Initialized AJV validator
94
- * @param inputSchema Valid input schema in object
95
- * @param input Input object to be validated
96
- * @param options (Optional) Additional validation configuration for certain fields
97
- */
98
- function validateInputUsingValidator(validator, inputSchema, input, options = {}) {
99
- const isValid = validator(input); // Check if input is valid based on schema values
100
- const { properties } = inputSchema;
101
- const required = inputSchema.required || [];
102
- let errors = [];
103
- // Process AJV validation errors
104
- if (!isValid) {
105
- errors = validator.errors
106
- .map((error) => (0, input_schema_1.parseAjvError)(error, 'input', properties, input))
107
- .filter((error) => !!error);
108
- }
109
- Object.keys(properties).forEach((property) => {
110
- const value = input[property];
111
- const { type, editor, patternKey, patternValue } = properties[property];
112
- const fieldErrors = [];
113
- // Check that proxy is required, if yes, valides that it's correctly setup
114
- if (type === 'object' && editor === 'proxy') {
115
- const proxyValidationErrors = validateProxyField(property, value, required.includes(property), options.proxy);
116
- proxyValidationErrors.forEach((error) => {
117
- fieldErrors.push(error);
118
- });
119
- }
120
- // Check that array items fit patternKey and patternValue
121
- if (type === 'array' && value && Array.isArray(value)) {
122
- if (editor === 'requestListSources') {
123
- const invalidIndexes = [];
124
- value.forEach((item, index) => {
125
- if (!item)
126
- invalidIndexes.push(index);
127
- else if (!item.url && !item.requestsFromUrl)
128
- invalidIndexes.push(index);
129
- else if (item.url && !consts_1.URL_REGEX.test(item.url))
130
- invalidIndexes.push(index);
131
- else if (item.requestsFromUrl && !consts_1.URL_REGEX.test(item.requestsFromUrl))
132
- invalidIndexes.push(index);
133
- });
134
- if (invalidIndexes.length) {
135
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.requestListSourcesInvalid', {
136
- rootName: 'input',
137
- fieldKey: property,
138
- invalidIndexes: invalidIndexes.join(','),
139
- }));
140
- }
141
- }
142
- // If patternKey is provided, then validate keys of objects in array
143
- if (patternKey && editor === 'keyValue') {
144
- const check = new RegExp(patternKey);
145
- const invalidIndexes = [];
146
- value.forEach((item, index) => {
147
- if (!check.test(item.key))
148
- invalidIndexes.push(index);
149
- });
150
- if (invalidIndexes.length) {
151
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.arrayKeysInvalid', {
152
- rootName: 'input',
153
- fieldKey: property,
154
- invalidIndexes: invalidIndexes.join(','),
155
- pattern: patternKey,
156
- }));
157
- }
158
- }
159
- // If patternValue is provided and editor is keyValue, then validate values of objecs in array
160
- if (patternValue && editor === 'keyValue') {
161
- const check = new RegExp(patternValue);
162
- const invalidIndexes = [];
163
- value.forEach((item, index) => {
164
- if (!check.test(item.value))
165
- invalidIndexes.push(index);
166
- });
167
- if (invalidIndexes.length) {
168
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.arrayValuesInvalid', {
169
- rootName: 'input',
170
- fieldKey: property,
171
- invalidIndexes: invalidIndexes.join(','),
172
- pattern: patternValue,
173
- }));
174
- }
175
- // If patternValue is provided and editor is stringList, then validate each item in array
176
- }
177
- else if (patternValue && editor === 'stringList') {
178
- const check = new RegExp(patternValue);
179
- const invalidIndexes = [];
180
- value.forEach((item, index) => {
181
- if (!check.test(item))
182
- invalidIndexes.push(index);
183
- });
184
- if (invalidIndexes.length) {
185
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.arrayValuesInvalid', {
186
- rootName: 'input',
187
- fieldKey: property,
188
- invalidIndexes: invalidIndexes.join(','),
189
- pattern: patternValue,
190
- }));
191
- }
192
- }
193
- }
194
- // Check that object items fit patternKey and patternValue
195
- if (type === 'object' && value) {
196
- if (patternKey) {
197
- const check = new RegExp(patternKey);
198
- const invalidKeys = [];
199
- Object.keys(value).forEach((key) => {
200
- if (!check.test(key))
201
- invalidKeys.push(key);
202
- });
203
- if (invalidKeys.length) {
204
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.objectKeysInvalid', {
205
- rootName: 'input',
206
- fieldKey: property,
207
- invalidKeys: invalidKeys.join(','),
208
- pattern: patternKey,
209
- }));
210
- }
211
- }
212
- if (patternValue) {
213
- const check = new RegExp(patternValue);
214
- const invalidKeys = [];
215
- Object.keys(value).forEach((key) => {
216
- const propertyValue = value[key];
217
- if (typeof propertyValue !== 'string' || !check.test(propertyValue))
218
- invalidKeys.push(key);
219
- });
220
- if (invalidKeys.length) {
221
- fieldErrors.push((0, intl_1.m)('inputSchema.validation.objectValuesInvalid', {
222
- rootName: 'input',
223
- fieldKey: property,
224
- invalidKeys: invalidKeys.join(','),
225
- pattern: patternValue,
226
- }));
227
- }
228
- }
229
- }
230
- if (fieldErrors.length > 0) {
231
- const message = fieldErrors.join(', ');
232
- errors.push({ fieldKey: property, message });
233
- }
234
- });
235
- return errors;
236
- }
237
- exports.validateInputUsingValidator = validateInputUsingValidator;
238
- /**
239
- * This functions parses all given JSON and then takes each of the jsFields.
240
- * Then if the field:
241
- * - is valid JS single function it replaces its single line string with a function delacation.
242
- * - is valid multiline JS code then replaces its single line string with `multiline` string
243
- * Then stringifies the code with given number of jsonSpacing spaces and finally prefixes whole
244
- * stringified JSON except the first line with globalSpacing spaces.
245
- */
246
- function makeInputJsFieldsReadable(json, jsFields, jsonSpacing = 4, globalSpacing = 0) {
247
- const parsedJson = JSON.parse(json);
248
- const replacements = {};
249
- jsFields.forEach((field) => {
250
- let maybeFunction = parsedJson[field];
251
- if (!maybeFunction || typeof maybeFunction !== 'string')
252
- return;
253
- let ast;
254
- try {
255
- ast = (0, escaya_1.parseScript)(maybeFunction, { cst: true });
256
- }
257
- catch (err) {
258
- // Don't do anything in a case of invalid JS code.
259
- return;
260
- }
261
- const isMultiline = maybeFunction.includes('\n');
262
- const isSingleFunction = ast
263
- && ast.leafs
264
- && ast.leafs.length === 1 // Must have only one expression inside!
265
- && ast.leafs[0]
266
- && (
267
- // Normal function ...
268
- ast.leafs[0].type === 'FunctionDeclaration'
269
- // or arrow function
270
- || (ast.leafs[0].type === 'ExpressionStatement'
271
- && ast.leafs[0].expression.type === 'ArrowFunction'));
272
- // If it's not a function declaration or multiline JS code then we do nothing.
273
- if (!isSingleFunction && !isMultiline)
274
- return;
275
- const spaces = (new Array(isSingleFunction ? jsonSpacing : jsonSpacing * 2)).fill(' ').join('');
276
- maybeFunction = maybeFunction
277
- .split('\n').join(`\n${spaces}`) // This prefixes each line with spaces.
278
- .trim(); // Trim whitespace on both sides
279
- const replacementValue = isSingleFunction
280
- ? maybeFunction.replace(/[;]+$/g, '') // Remove trailing semicolons
281
- : `\`${maybeFunction}\``;
282
- const replacementToken = `<<<REPLACEMENT_TOKEN:${Math.random()}>>>`;
283
- replacements[replacementToken] = replacementValue;
284
- parsedJson[field] = replacementToken;
285
- });
286
- let niceJson = JSON.stringify(parsedJson, null, jsonSpacing);
287
- Object.entries(replacements).forEach(([replacementToken, replacementValue]) => {
288
- niceJson = niceJson.replace(`"${replacementToken}"`, replacementValue);
289
- });
290
- const globalSpaces = (new Array(globalSpacing)).fill(' ').join('');
291
- niceJson = niceJson.split('\n').join(`\n${globalSpaces}`);
292
- return niceJson;
293
- }
294
- exports.makeInputJsFieldsReadable = makeInputJsFieldsReadable;