/* eslint-disable */ /** * This file was automatically generated by json-schema-to-typescript. * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, * and run json-schema-to-typescript to regenerate this file. */ /** * Input schema for a DxComponent */ export type DxComponentInputSchema = CoreSchemaMetaSchema & { type?: 'object'; additionalProperties?: boolean; [k: string]: unknown; }; export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2; export type CoreSchemaMetaSchema2 = | { $id?: string; 'ui:metadata'?: UiMetadata; $schema?: string; $ref?: string; $comment?: string; title?: string; description?: string; default?: unknown; readOnly?: boolean; writeOnly?: boolean; examples?: unknown[]; multipleOf?: number; maximum?: number; exclusiveMaximum?: number; minimum?: number; exclusiveMinimum?: number; maxLength?: number; minLength?: number; pattern?: string; additionalItems?: CoreSchemaMetaSchema2; items?: CoreSchemaMetaSchema2 | SchemaArray; maxItems?: number; minItems?: number; uniqueItems?: boolean; contains?: CoreSchemaMetaSchema2; maxProperties?: number; minProperties?: number; required?: StringArray; additionalProperties?: CoreSchemaMetaSchema2; definitions?: { [k: string]: CoreSchemaMetaSchema2; }; properties?: { [k: string]: CoreSchemaMetaSchema2; }; /** * Indicates whether the field can be stored in multi-language variations */ translatable?: boolean; patternProperties?: { [k: string]: CoreSchemaMetaSchema2; }; dependencies?: { [k: string]: CoreSchemaMetaSchema2 | StringArray; }; propertyNames?: CoreSchemaMetaSchema2; const?: unknown; /** * @minItems 1 */ enum?: unknown[]; type?: | ( | 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink' ) | ( | 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink' )[]; format?: | 'date-time' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'json-pointer' | 'matrix-asset-uri' | 'multi-line' | 'password' | 'phone' | 'regex' | 'relative-json-pointer' | 'uri-reference' | 'uri-template' | 'uri' | 'uuid'; matrixAssetTypes?: ( | 'audioFile' | 'bodycopyContainer' | 'bodycopyDiv' | 'calendarEventsSearchPage' | 'contentContainerTemplate' | 'contentTypeMarkdown' | 'contentTypeNestContent' | 'contentTypeRawHtml' | 'contentTypeSnippet' | 'contentTypeWysiwyg' | 'cssFileFolder' | 'cssFile' | 'customForm' | 'dataRecord' | 'designAreaAssetLineage' | 'designAreaBody' | 'designAreaMenuNormal' | 'designAreaNestContent' | 'designCssCustomisation' | 'designCss' | 'designCustomisation' | 'designScss' | 'design' | 'docx' | 'excelDoc' | 'file' | 'folder' | 'gitBridge' | 'googleAnalyticsConnector' | 'googleAnalyticsView' | 'image' | 'jsFileFolder' | 'jsFile' | 'jsonWebToken' | 'layoutManager' | 'layout' | 'link' | 'metadataFieldDate' | 'metadataFieldRelatedAsset' | 'metadataFieldSelect' | 'metadataFieldText' | 'metadataFieldWysiwyg' | 'metadataSchema' | 'metadataSection' | 'newsItem' | 'oauthAccountManager' | 'pageAccountManager' | 'pageAssetListing' | 'pageCalendarEventsSearch' | 'pageCalendar' | 'pageContent' | 'pagePasswordReset' | 'pageRemoteContent' | 'pageRestResourceJs' | 'pageRestResourceOauthSession' | 'pageRestResourceOauthTwoLegged' | 'pageRestResource' | 'pageSiteMap' | 'pageStandard' | 'paintLayoutBodycopy' | 'paintLayoutPage' | 'pdfFile' | 'pdf' | 'persona' | 'powerpointDoc' | 'pptx' | 'redirectPage' | 'regex' | 'regularExpression' | 'rtfFile' | 'samlAccountManager' | 'saml2Acs' | 'saml2Sls' | 'searchPage' | 'site' | 'textFile' | 'TriggerTypes?' | 'userGroup' | 'wordDoc' | 'workflowSchema' | 'workflowStepCondition' | 'workflowStep' | 'workflowStream' | 'xlsx' | 'xmlFile' )[]; contentMediaType?: string; contentEncoding?: string; if?: CoreSchemaMetaSchema2; then?: CoreSchemaMetaSchema2; else?: CoreSchemaMetaSchema2; allOf?: SchemaArray; anyOf?: SchemaArray; oneOf?: SchemaArray; not?: CoreSchemaMetaSchema2; /** * Placeholder text to display in the preview */ previewPlaceholder?: string | boolean; } | boolean; /** * @minItems 1 */ export type SchemaArray = CoreSchemaMetaSchema2[]; export type StringArray = string[]; export interface JobManifest { /** * the manifest schema version */ $schema: string; /** * Name of the job */ name: string; /** * Display name of the job */ displayName: string; /** * Description of the job */ description: string; /** * Name of the main function to be executed at the root of the access url */ mainFunction: string; /** * Semver version number */ version: string; /** * Timeout in seconds before a job is stopped (min 10min, max 8h) */ timeout: number; /** * The number of these jobs that can be run at once */ concurrency: number; /** * Optional runtime image the job should execute against (e.g. "node:20", "node:24"). When omitted, job runner will default to the recommended runtime image. */ image?: string; /** * Whether failed job code executions should be retried automatically. When omitted, job runner will not retry failed job code executions. */ autoRetry?: boolean; /** * @minItems 0 */ functions: JobFunction[]; } /** * Job function definition, this object provides the runtime with input validation and what to execute */ export interface JobFunction { /** * Function name */ name: string; /** * File path to the javascript file to execute. The file path must be relative to the manifest file and cannot be in a folder above the manifest file. */ entry: string; input: DxComponentInputSchema; [k: string]: unknown; } export interface CoreSchemaMetaSchema1 { $id?: string; 'ui:metadata'?: UiMetadata; $schema?: string; $ref?: string; $comment?: string; title?: string; description?: string; default?: unknown; readOnly?: boolean; writeOnly?: boolean; examples?: unknown[]; multipleOf?: number; maximum?: number; exclusiveMaximum?: number; minimum?: number; exclusiveMinimum?: number; maxLength?: number; minLength?: number; pattern?: string; additionalItems?: CoreSchemaMetaSchema2; items?: CoreSchemaMetaSchema2 | SchemaArray; maxItems?: number; minItems?: number; uniqueItems?: boolean; contains?: CoreSchemaMetaSchema2; maxProperties?: number; minProperties?: number; required?: StringArray; additionalProperties?: CoreSchemaMetaSchema2; definitions?: { [k: string]: CoreSchemaMetaSchema2; }; properties?: { [k: string]: CoreSchemaMetaSchema2; }; /** * Indicates whether the field can be stored in multi-language variations */ translatable?: boolean; patternProperties?: { [k: string]: CoreSchemaMetaSchema2; }; dependencies?: { [k: string]: CoreSchemaMetaSchema2 | StringArray; }; propertyNames?: CoreSchemaMetaSchema2; const?: unknown; /** * @minItems 1 */ enum?: unknown[]; type?: | ( | 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink' ) | ( | 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText' | 'SquizImage' | 'SquizLink' )[]; format?: | 'date-time' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'json-pointer' | 'matrix-asset-uri' | 'multi-line' | 'password' | 'phone' | 'regex' | 'relative-json-pointer' | 'uri-reference' | 'uri-template' | 'uri' | 'uuid'; matrixAssetTypes?: ( | 'audioFile' | 'bodycopyContainer' | 'bodycopyDiv' | 'calendarEventsSearchPage' | 'contentContainerTemplate' | 'contentTypeMarkdown' | 'contentTypeNestContent' | 'contentTypeRawHtml' | 'contentTypeSnippet' | 'contentTypeWysiwyg' | 'cssFileFolder' | 'cssFile' | 'customForm' | 'dataRecord' | 'designAreaAssetLineage' | 'designAreaBody' | 'designAreaMenuNormal' | 'designAreaNestContent' | 'designCssCustomisation' | 'designCss' | 'designCustomisation' | 'designScss' | 'design' | 'docx' | 'excelDoc' | 'file' | 'folder' | 'gitBridge' | 'googleAnalyticsConnector' | 'googleAnalyticsView' | 'image' | 'jsFileFolder' | 'jsFile' | 'jsonWebToken' | 'layoutManager' | 'layout' | 'link' | 'metadataFieldDate' | 'metadataFieldRelatedAsset' | 'metadataFieldSelect' | 'metadataFieldText' | 'metadataFieldWysiwyg' | 'metadataSchema' | 'metadataSection' | 'newsItem' | 'oauthAccountManager' | 'pageAccountManager' | 'pageAssetListing' | 'pageCalendarEventsSearch' | 'pageCalendar' | 'pageContent' | 'pagePasswordReset' | 'pageRemoteContent' | 'pageRestResourceJs' | 'pageRestResourceOauthSession' | 'pageRestResourceOauthTwoLegged' | 'pageRestResource' | 'pageSiteMap' | 'pageStandard' | 'paintLayoutBodycopy' | 'paintLayoutPage' | 'pdfFile' | 'pdf' | 'persona' | 'powerpointDoc' | 'pptx' | 'redirectPage' | 'regex' | 'regularExpression' | 'rtfFile' | 'samlAccountManager' | 'saml2Acs' | 'saml2Sls' | 'searchPage' | 'site' | 'textFile' | 'TriggerTypes?' | 'userGroup' | 'wordDoc' | 'workflowSchema' | 'workflowStepCondition' | 'workflowStep' | 'workflowStream' | 'xlsx' | 'xmlFile' )[]; contentMediaType?: string; contentEncoding?: string; if?: CoreSchemaMetaSchema2; then?: CoreSchemaMetaSchema2; else?: CoreSchemaMetaSchema2; allOf?: SchemaArray; anyOf?: SchemaArray; oneOf?: SchemaArray; not?: CoreSchemaMetaSchema2; /** * Placeholder text to display in the preview */ previewPlaceholder?: string | boolean; } export interface UiMetadata { /** * Whether the component should automatically reload when the input is changed */ autoReload?: boolean; /** * Allow this property to be editable inline */ inlineEditable?: boolean; /** * Choose if an object grouping should be collapsed by default */ collapsedByDefault?: boolean; /** * Allow this property to be part of the Quick Options UI */ quickOption?: boolean; /** * Choose if the enum values are displayed as a radio button list or a dropdown */ enumWidget?: 'radio' | 'dropdown'; }