@squiz/dx-json-schema-lib 1.39.0 → 1.39.1-alpha.1

package/src/manifest/v1/JobV1.ts

@@ -0,0 +1,447 @@
+/* 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;
+      $schema?: string;
+      $ref?: string;
+      $comment?: string;
+      title?: string;
+      description?: string;
+      default?: true;
+      readOnly?: boolean;
+      writeOnly?: boolean;
+      examples?: true[];
+      multipleOf?: number;
+      maximum?: number;
+      exclusiveMaximum?: number;
+      minimum?: number;
+      exclusiveMinimum?: number;
+      maxLength?: number;
+      minLength?: number & number;
+      pattern?: string;
+      additionalItems?: CoreSchemaMetaSchema2;
+      items?: CoreSchemaMetaSchema2 | SchemaArray;
+      maxItems?: number;
+      minItems?: number & number;
+      uniqueItems?: boolean;
+      contains?: CoreSchemaMetaSchema2;
+      maxProperties?: number;
+      minProperties?: number & number;
+      required?: StringArray;
+      additionalProperties?: CoreSchemaMetaSchema2;
+      definitions?: {
+        [k: string]: CoreSchemaMetaSchema2;
+      };
+      properties?: {
+        [k: string]: CoreSchemaMetaSchema2;
+      };
+      patternProperties?: {
+        [k: string]: CoreSchemaMetaSchema2;
+      };
+      dependencies?: {
+        [k: string]: CoreSchemaMetaSchema2 | StringArray;
+      };
+      propertyNames?: CoreSchemaMetaSchema2;
+      const?: true;
+      /**
+       * @minItems 1
+       */
+      enum?: true[];
+      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'
+        | '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;
+    }
+  | 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 5s, max 8h)
+   */
+  timeout: number;
+  /**
+   * The number of these jobs that can be run at once
+   */
+  concurrency: number;
+  /**
+   * @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;
+  $schema?: string;
+  $ref?: string;
+  $comment?: string;
+  title?: string;
+  description?: string;
+  default?: true;
+  readOnly?: boolean;
+  writeOnly?: boolean;
+  examples?: true[];
+  multipleOf?: number;
+  maximum?: number;
+  exclusiveMaximum?: number;
+  minimum?: number;
+  exclusiveMinimum?: number;
+  maxLength?: number;
+  minLength?: number & number;
+  pattern?: string;
+  additionalItems?: CoreSchemaMetaSchema2;
+  items?: CoreSchemaMetaSchema2 | SchemaArray;
+  maxItems?: number;
+  minItems?: number & number;
+  uniqueItems?: boolean;
+  contains?: CoreSchemaMetaSchema2;
+  maxProperties?: number;
+  minProperties?: number & number;
+  required?: StringArray;
+  additionalProperties?: CoreSchemaMetaSchema2;
+  definitions?: {
+    [k: string]: CoreSchemaMetaSchema2;
+  };
+  properties?: {
+    [k: string]: CoreSchemaMetaSchema2;
+  };
+  patternProperties?: {
+    [k: string]: CoreSchemaMetaSchema2;
+  };
+  dependencies?: {
+    [k: string]: CoreSchemaMetaSchema2 | StringArray;
+  };
+  propertyNames?: CoreSchemaMetaSchema2;
+  const?: true;
+  /**
+   * @minItems 1
+   */
+  enum?: true[];
+  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'
+    | '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;
+}

package/src/manifest/v1/__test__/schemas/badFunctionInputJob.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://localhost:3040/schemas/JobV1.json#",
+  "name": "simple-job",
+  "displayName": "Simple job",
+  "version": "1.0.22",
+  "mainFunction": "main",
+  "description": "some-description",
+  "concurrency": 1,
+  "timeout": 10000,
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "input": {
+        "type": "object",
+        "properties": {
+          "something": {
+            "type": "wrongType"
+          }
+        },
+        "required": ["something"]
+      }
+    }
+  ]
+}

package/src/manifest/v1/__test__/schemas/nonObjectFunctionInputJob.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://localhost:3040/schemas/JobV1.json#",
+  "name": "simple-job",
+  "displayName": "Simple Job",
+  "version": "1.0.22",
+  "mainFunction": "main",
+  "description": "some-description",
+  "concurrency": 1,
+  "timeout": 10000,
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "input": {
+        "type": "string",
+        "properties": {
+          "something": {
+            "type": "string"
+          }
+        },
+        "required": ["something"]
+      }
+    }
+  ]
+}

package/src/manifest/v1/__test__/schemas/validJob.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://localhost:3040/schemas/JobV1.json#",
+  "name": "simple-job",
+  "displayName": "Simple Job",
+  "version": "1.0.22",
+  "mainFunction": "main",
+  "description": "some-description",
+  "concurrency": 1,
+  "timeout": 10000,
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "input": {
+        "type": "object",
+        "properties": {
+          "something": {
+            "type": "string"
+          }
+        },
+        "required": ["something"]
+      }
+    }
+  ]
+}

package/src/manifest/v1/manifestModels.ts

@@ -1 +1,2 @@
 export * as v1 from './v1';
+export * as JobV1 from './JobV1';

package/src/manifest/v1/manifestSchemas.ts

@@ -1,3 +1,4 @@
 import v1 from './v1.json';
+import JobV1 from './JobV1.json';
 
-export { v1 };
+export { v1, JobV1 };

package/src/manifest/v1/v1.json

@@ -4,15 +4,28 @@
   "title": "ComponentManifest",
   "additionalProperties": false,
   "properties": {
-    "$schema": { "type": "string", "description": "the manifest schema version" },
+    "$schema": {
+      "type": "string",
+      "description": "the manifest schema version"
+    },
     "namespace": {
       "type": "string",
       "description": "Namespace of the component",
       "$ref": "#/definitions/name-pattern"
     },
-    "name": { "type": "string", "description": "Name of the component", "$ref": "#/definitions/name-pattern" },
-    "displayName": { "type": "string", "description": "Display name of the component" },
-    "description": { "type": "string", "description": "Description of the component" },
+    "name": {
+      "type": "string",
+      "description": "Name of the component",
+      "$ref": "#/definitions/name-pattern"
+    },
+    "displayName": {
+      "type": "string",
+      "description": "Display name of the component"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the component"
+    },
     "mainFunction": {
       "type": "string",
       "description": "Name of the main function to be executed at the root of the access url"
@@ -46,7 +59,6 @@
         "required": ["name"]
       }
     },
-
     "staticFiles": {
       "type": "object",
       "properties": {
@@ -55,7 +67,6 @@
           "description": "The location the system begins looking static files. All static files will be referenced from here."
         }
       },
-
       "required": ["locationRoot"]
     },
     "functions": {
@@ -86,8 +97,9 @@
                 "additionalProperties": false,
                 "description": "The HtmlResponse type is for returning html content. The response out of the function must be a string. This response object also includes references to resources (staticFiles) the component needs to execute correctly. It is up to the integrating system to respect this.",
                 "properties": {
-                  "responseType": { "const": "html" },
-
+                  "responseType": {
+                    "const": "html"
+                  },
                   "staticFiles": {
                     "type": "array",
                     "description": "A list of static resources that are required for the component to execute correctly",
@@ -247,7 +259,6 @@
                     }
                   }
                 },
-
                 "required": ["responseType"]
               },
               {
@@ -255,8 +266,12 @@
                 "type": "object",
                 "additionalProperties": false,
                 "properties": {
-                  "responseType": { "const": "json" },
-                  "definition": { "$ref": "http://json-schema.org/draft-07/schema#" },
+                  "responseType": {
+                    "const": "json"
+                  },
+                  "definition": {
+                    "$ref": "http://json-schema.org/draft-07/schema#"
+                  },
                   "headers": {
                     "title": "ResponseHeaders",
                     "type": "object",
@@ -266,7 +281,6 @@
                     }
                   }
                 },
-
                 "required": ["responseType", "definition"]
               }
             ]
@@ -432,9 +446,7 @@
       }
     }
   },
-
   "required": ["name", "namespace", "displayName", "description", "version", "functions", "$schema", "mainFunction"],
-
   "definitions": {
     "name-pattern": {
       "type": "string",