@squiz/dx-json-schema-lib 1.21.1-alpha.2 → 1.21.1-alpha.4

package/src/JsonValidationService.spec.ts

@@ -4,6 +4,7 @@ import { SchemaValidationError } from './errors/SchemaValidationError';
 import validManifest from './manifest/v1/__test__/schemas/validComponent.json';
 import validManifestJson from './manifest/v1/__test__/schemas/validComponentJson.json';
 import { FormattedText } from './formatted-text/v1/formattedText';
+import inputStringWithFormat from './manifest/v1/__test__/schemas/inputStringWithFormat.json';
 import { JSONSchema } from 'json-schema-library';
 import { PrimitiveType, ResolvableType, TypeResolver } from './jsonTypeResolution/arbitraryTypeResolution';
 
@@ -59,6 +60,11 @@ describe('JsonValidationService', () => {
         'failed validation: Invalid manifest version',
       );
     });
+
+    it('should return true for a valid manifest with a string format MatrixAssetUri', () => {
+      const result = jsonValidationService.validateManifest(inputStringWithFormat, 'v1');
+      expect(result).toBe(true);
+    });
   });
 
   describe('validateContentSchema', () => {
@@ -141,6 +147,62 @@ describe('JsonValidationService', () => {
   });
 
   describe('validateComponentInput', () => {
+    describe('matrix-asset-uri input', () => {
+      const functionInputSchema = {
+        type: 'object',
+
+        properties: {
+          'matrix-asset': { type: 'string', format: 'matrix-asset-uri', matrixAssetTypes: ['image'] },
+        },
+
+        required: ['matrix-asset'],
+      };
+      it('should return true for valid a string with matrix-asset-uri format', () => {
+        const validMatrixAssetUri = 'matrix-asset://canary.uat.matrix.squiz.cloud/abc123';
+        expect(
+          jsonValidationService.validateComponentInput(functionInputSchema, {
+            'matrix-asset': validMatrixAssetUri,
+          }),
+        ).toEqual(true);
+      });
+      it('should throw error for invalid matrix-asset-uri format', () => {
+        const invalidMatrixAssetUri = 'not-valid://canary.uat.matrix.squiz.cloud//abc123';
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          `failed validation: value "not-valid://canary.uat.matrix.squiz.cloud//abc123" isn't a valid matrix asset uri`,
+        );
+      });
+      it('should throw error for invalid matrix-asset-uri type number', () => {
+        const invalidMatrixAssetUri = 1234;
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          'failed validation: Expected `1234` (number) in `#/matrix-asset` to be of type `string`',
+        );
+      });
+      it('should throw error for invalid matrix-asset-uri which does not contain correct number of parts', () => {
+        const invalidMatrixAssetUri = 'matrix://';
+        expectToThrowErrorMatchingTypeAndMessage(
+          () => {
+            jsonValidationService.validateComponentInput(functionInputSchema, {
+              'matrix-asset': invalidMatrixAssetUri,
+            });
+          },
+          SchemaValidationError,
+          `failed validation: value "matrix://" isn't a valid matrix asset uri`,
+        );
+      });
+    });
+
     describe('FormattedText input', () => {
       it('should handle type as an array', () => {
         const functionInputSchema = {

package/src/JsonValidationService.ts

@@ -13,14 +13,18 @@ import { Draft07, JSONError, JSONSchema, Draft, DraftConfig, isJSONError } from
 
 import { draft07Config } from 'json-schema-library';
 import { MANIFEST_MODELS } from '.';
+import { customFormatValidators } from './validators/customFormatValidators';
 import { AnyPrimitiveType, AnyResolvableType, TypeResolver } from './jsonTypeResolution/arbitraryTypeResolution';
 import { JsonResolutionError } from './errors/JsonResolutionError';
 
 const defaultConfig: DraftConfig = {
   ...draft07Config,
+  validateFormat: {
+    ...draft07Config.validateFormat,
+    ...customFormatValidators,
+  },
   errors: {
     ...draft07Config.errors,
-
     enumError(data) {
       let values = '[]';
 

package/src/manifest/v1/DxContentMetaSchema.json

@@ -140,7 +140,34 @@
         }
       ]
     },
-    "format": { "type": "string" },
+    "format": {
+      "type": "string",
+      "enum": [
+        "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": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "$ref": "#/matrixAssetEnum"
+      }
+    },
     "contentMediaType": { "type": "string" },
     "contentEncoding": { "type": "string" },
     "if": { "$ref": "#" },
@@ -161,5 +188,93 @@
       },
       "required": ["required"]
     }
+  },
+  "matrixAssetEnum": {
+    "enum": [
+      "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"
+    ]
   }
 }

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

@@ -0,0 +1,29 @@
+{
+  "$schema": "../../v1.json",
+  "description": "t",
+  "displayName": "t",
+  "name": "test",
+  "namespace": "other",
+  "mainFunction": "main",
+  "version": "1.0.4",
+  "environment": [],
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "output": {
+        "responseType": "html"
+      },
+      "input": {
+        "type": "object",
+        "properties": {
+          "prop": {
+            "type": "string",
+            "format": "matrix-asset-uri"
+          }
+        },
+        "required": []
+      }
+    }
+  ]
+}

package/src/manifest/v1/v1.ts

@@ -65,7 +65,109 @@ export type CoreSchemaMetaSchema2 =
       type?:
         | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
         | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
-      format?: string;
+      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;
@@ -2531,7 +2633,109 @@ export interface CoreSchemaMetaSchema1 {
   type?:
     | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')
     | ('array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string' | 'FormattedText')[];
-  format?: string;
+  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;

package/src/validators/customFormatValidators.ts

@@ -0,0 +1,15 @@
+import { Draft, JSONError, JSONSchema } from 'json-schema-library';
+import { SchemaValidationError } from '../errors/SchemaValidationError';
+import { isMatrixAssetUri } from './utils/matrixAssetValidator';
+
+export const customFormatValidators: Record<
+  string,
+  (draft: Draft, schema: JSONSchema, value: unknown, pointer: string) => undefined | JSONError | JSONError[]
+> = {
+  'matrix-asset-uri': (core, schema, value): undefined => {
+    if (isMatrixAssetUri(value) === false) {
+      throw new SchemaValidationError(`value "${value}" isn't a valid matrix asset uri`);
+    }
+    return;
+  },
+};

package/src/validators/utils/matrixAssetValidator.spec.ts

@@ -0,0 +1,49 @@
+import { isMatrixAssetUri } from './matrixAssetValidator';
+
+describe('matrixAssetValidator', () => {
+  describe('should return true for valid matrix asset uri', () => {
+    it('with basic uri structure', () => {
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/123')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://dx.dev.matrix/123')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://instance-identifier/123')).toBe(true);
+    });
+
+    it('different matrix identifiers', () => {
+      expect(isMatrixAssetUri('matrix-asset://MATRIX-IDENTIFIER.STRANGE-NAME.org/123')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://matrix-identifier.STRANGE-NAME.org/123')).toBe(true);
+    });
+
+    it(' with different asset ids', () => {
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/123/')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/ASDFG1473189')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/1-2-3-a-3/456/')).toBe(true);
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/123/456/789')).toBe(true);
+    });
+  });
+
+  describe('should return false for invalid matrix asset uri', () => {
+    it('given incorrect type number', () => {
+      expect(isMatrixAssetUri(123)).toBe(false);
+    });
+
+    it('given incorrect type object', () => {
+      expect(isMatrixAssetUri({ test: 'invalid' })).toBe(false);
+    });
+
+    it('given incorrect value undefined', () => {
+      expect(isMatrixAssetUri(undefined)).toBe(false);
+    });
+
+    it('when the scheme is incorrect', () => {
+      expect(isMatrixAssetUri('invalid://matrix.org')).toBe(false);
+    });
+
+    it('when missing the asset id', () => {
+      expect(isMatrixAssetUri('matrix-asset://matrix.org/')).toBe(false);
+    });
+
+    it('when missing the asset path', () => {
+      expect(isMatrixAssetUri('matrix-asset:///123')).toBe(false);
+    });
+  });
+});

package/src/validators/utils/matrixAssetValidator.ts

@@ -0,0 +1,8 @@
+export type MatrixAssetUri = `matrix-asset://${string}`;
+
+export function isMatrixAssetUri(url: unknown): url is MatrixAssetUri {
+  if (typeof url !== 'string') return false;
+
+  /*eslint-disable no-useless-escape*/
+  return /^matrix-asset:\/\/[a-zA-Z0-9.-]+\/[a-zA-Z0-9\/._-]+\/?([0-9]+(?:\:[0-9a-z\-\._/]+\$?)?)?$/.test(url);
+}