@squiz/dx-json-schema-lib 1.34.1-alpha.0 → 1.34.1-alpha.2

package/src/JsonValidationService.spec.ts

@@ -13,7 +13,10 @@ import {
   ResolvableType,
   TypeResolver,
 } from './jsonTypeResolution/TypeResolver';
-import { FormattedTextType, SquizImageType } from './primitiveTypes';
+import { FormattedTextType, SquizImageType, SquizLinkType } from './primitiveTypes';
+import { TypeResolverBuilder } from './jsonTypeResolution/TypeResolverBuilder';
+import { MatrixAssetUri } from './validators/utils/matrixAssetValidator';
+import { MatrixAssetType } from './resolvableTypes';
 
 function expectToThrowErrorMatchingTypeAndMessage(
   // eslint-disable-next-line @typescript-eslint/ban-types
@@ -153,22 +156,32 @@ describe('JsonValidationService', () => {
             });
           },
           SchemaValidationError,
-          `failed validation: matrix asset uri "not-valid://canary uat matrix.squiz.cloud//abc123" isn't a valid matrix asset uri`,
+          'failed validation: Value matrix-asset-uri (not-valid://canary uat matrix.squiz.cloud//abc123) in `#/matrix-asset` is not a valid matrix asset uri',
           {
-            '#/matrix-asset': {
-              assetId: {
-                data: { expected: /^\d+(?::.+)?$/, received: '/abc123' },
-                message: 'Matrix Asset Id has invalid format, must match /^d+(?::.+)?$/',
-              },
-              identifier: {
-                data: { expected: /^[a-zA-Z0-9.-]+$/, received: 'canary uat matrix.squiz.cloud' },
-                message: 'Matrix Identifier has invalid format, must match /^[a-zA-Z0-9.-]+$/',
-              },
-              scheme: {
-                data: { expected: 'matrix-asset', received: 'not-valid' },
-                message: 'Uri scheme is invalid, must match "matrix-asset"',
+            '#/matrix-asset': [
+              {
+                data: {
+                  errors: {
+                    assetId: {
+                      data: { expected: /^\d+(?::.+)?$/, received: '/abc123' },
+                      message: 'Matrix Asset Id has invalid format, must match /^d+(?::.+)?$/',
+                    },
+                    identifier: {
+                      data: { expected: /^[a-zA-Z0-9.-]+$/, received: 'canary uat matrix.squiz.cloud' },
+                      message: 'Matrix Identifier has invalid format, must match /^[a-zA-Z0-9.-]+$/',
+                    },
+                    scheme: {
+                      data: { expected: 'matrix-asset', received: 'not-valid' },
+                      message: 'Uri scheme is invalid, must match "matrix-asset"',
+                    },
+                  },
+                  pointer: '#/matrix-asset',
+                  value: 'not-valid://canary uat matrix.squiz.cloud//abc123',
+                },
+                message:
+                  'Value matrix-asset-uri (not-valid://canary uat matrix.squiz.cloud//abc123) in `#/matrix-asset` is not a valid matrix asset uri',
               },
-            },
+            ],
           },
         );
       });
@@ -201,22 +214,31 @@ describe('JsonValidationService', () => {
             });
           },
           SchemaValidationError,
-          `failed validation: matrix asset uri "matrix://" isn't a valid matrix asset uri`,
+          'failed validation: Value matrix-asset-uri (matrix://) in `#/matrix-asset` is not a valid matrix asset uri',
           {
-            '#/matrix-asset': {
-              assetId: {
-                data: { expected: /^\d+(?::.+)?$/, received: '' },
-                message: 'Matrix Asset Id has invalid format, must match /^d+(?::.+)?$/',
-              },
-              identifier: {
-                data: { expected: /^[a-zA-Z0-9.-]+$/, received: '' },
-                message: 'Matrix Identifier has invalid format, must match /^[a-zA-Z0-9.-]+$/',
-              },
-              scheme: {
-                data: { expected: 'matrix-asset', received: 'matrix' },
-                message: 'Uri scheme is invalid, must match "matrix-asset"',
+            '#/matrix-asset': [
+              {
+                data: {
+                  errors: {
+                    assetId: {
+                      data: { expected: /^\d+(?::.+)?$/, received: '' },
+                      message: 'Matrix Asset Id has invalid format, must match /^d+(?::.+)?$/',
+                    },
+                    identifier: {
+                      data: { expected: /^[a-zA-Z0-9.-]+$/, received: '' },
+                      message: 'Matrix Identifier has invalid format, must match /^[a-zA-Z0-9.-]+$/',
+                    },
+                    scheme: {
+                      data: { expected: 'matrix-asset', received: 'matrix' },
+                      message: 'Uri scheme is invalid, must match "matrix-asset"',
+                    },
+                  },
+                  pointer: '#/matrix-asset',
+                  value: 'matrix://',
+                },
+                message: 'Value matrix-asset-uri (matrix://) in `#/matrix-asset` is not a valid matrix asset uri',
               },
-            },
+            ],
           },
         );
       });
@@ -1374,3 +1396,542 @@ describe('JsonSchemaService', () => {
     });
   });
 });
+
+describe('JSONSchemaService - validation', () => {
+  const typeResolver = TypeResolverBuilder.new()
+    .addPrimitive(SquizImageType)
+    .addPrimitive(SquizLinkType)
+    .addPrimitive(FormattedTextType)
+    .build();
+
+  const jsonSchemaService = new JSONSchemaService(typeResolver, ComponentInputMetaSchema);
+
+  it('should validate a schema with all the squiz primitive types', () => {
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+        link: { type: 'SquizLink' },
+        text: { type: 'FormattedText' },
+      },
+      required: ['image', 'link', 'text'],
+    };
+    const formattedText: FormattedText = [
+      {
+        tag: 'p',
+        type: 'tag',
+        children: [{ type: 'text', value: 'hello' }],
+      },
+    ];
+    const input: {
+      image: SquizImageType['__shape__'];
+      link: SquizLinkType['__shape__'];
+      text: FormattedText;
+    } = {
+      image: {
+        name: 'test-image.jpeg',
+        imageVariations: {
+          original: {
+            aspectRatio: '1:1',
+            height: 100,
+            width: 100,
+            url: 'https://www.squiz.net',
+            byteSize: 100,
+            mimeType: 'image/jpeg',
+            sha1Hash: '123',
+          },
+        },
+      },
+      link: {
+        name: 'test-link',
+        url: 'https://www.squiz.net',
+        target: '_blank',
+      },
+      text: formattedText,
+    };
+
+    const result = jsonSchemaService.validateInput(input, schema);
+
+    expect(result).toEqual(true);
+  });
+
+  it('should validate a schema with all the squiz primitive types and matrix-asset-uri format', () => {
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+        link: { type: 'SquizLink' },
+        text: { type: 'FormattedText' },
+        asset: {
+          type: 'string',
+          format: 'matrix-asset-uri',
+        },
+      },
+      required: ['image', 'link', 'text', 'asset'],
+    };
+    const formattedText: FormattedText = [
+      {
+        tag: 'p',
+        type: 'tag',
+        children: [{ type: 'text', value: 'hello' }],
+      },
+    ];
+    const input: {
+      image: SquizImageType['__shape__'];
+      link: SquizLinkType['__shape__'];
+      text: FormattedText;
+      asset: MatrixAssetUri;
+    } = {
+      image: {
+        name: 'test-image.jpeg',
+        imageVariations: {
+          original: {
+            aspectRatio: '1:1',
+            height: 100,
+            width: 100,
+            url: 'https://www.squiz.net',
+            byteSize: 100,
+            mimeType: 'image/jpeg',
+            sha1Hash: '123',
+          },
+        },
+      },
+      link: {
+        name: 'test-link',
+        url: 'https://www.squiz.net',
+        target: '_blank',
+      },
+      text: formattedText,
+      asset: 'matrix-asset://identifier/123',
+    };
+
+    const result = jsonSchemaService.validateInput(input, schema);
+
+    expect(result).toEqual(true);
+  });
+
+  it('should catch validation errors when there is a schema with all the squiz primitive types', () => {
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+        link: { type: 'SquizLink' },
+        text: { type: 'FormattedText' },
+      },
+      required: ['image', 'link', 'text'],
+    };
+    const formattedText: FormattedText = [
+      //@ts-expect-error - wrong type
+      {
+        children: [{ type: 'text', value: 'hello' }],
+      },
+    ];
+    const input: {
+      image: SquizImageType['__shape__'];
+      link: SquizLinkType['__shape__'];
+      text: FormattedText;
+    } = {
+      image: {
+        name: 'test-image.jpeg',
+        imageVariations: {
+          //@ts-expect-error - wrong type
+          original: {
+            width: 100,
+            url: 'https://www.squiz.net',
+            byteSize: 100,
+            mimeType: 'image/jpeg',
+            sha1Hash: '123',
+          },
+        },
+      },
+      //@ts-expect-error - wrong type
+      link: {
+        name: 'test-link',
+        target: '_blank',
+      },
+      text: formattedText,
+    };
+
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => jsonSchemaService.validateInput(input, schema),
+      SchemaValidationError,
+      'failed validation: Value `{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}` in `#/image` does not match any given oneof schema,\nValue `{"name":"test-link","target":"_blank"}` in `#/link` does not match any given oneof schema,\nValue `[{"children":[{"type":"text","value":"hello"}]}]` in `#/text` does not match any given oneof schema',
+      {
+        '#/image': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'required-property-error',
+                  data: { key: 'height', pointer: '#/image/imageVariations/original' },
+                  message: 'The required property `height` is missing at `#/image/imageVariations/original`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+                {
+                  code: 'required-property-error',
+                  data: { key: 'aspectRatio', pointer: '#/image/imageVariations/original' },
+                  message: 'The required property `aspectRatio` is missing at `#/image/imageVariations/original`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'SquizImage.json' }],
+              pointer: '#/image',
+              value:
+                '{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}',
+            },
+            message:
+              'Value `{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}` in `#/image` does not match any given oneof schema',
+          },
+        ],
+        '#/link': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'required-property-error',
+                  data: { key: 'url', pointer: '#/link' },
+                  message: 'The required property `url` is missing at `#/link`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'SquizLink.json' }],
+              pointer: '#/link',
+              value: '{"name":"test-link","target":"_blank"}',
+            },
+            message: 'Value `{"name":"test-link","target":"_blank"}` in `#/link` does not match any given oneof schema',
+          },
+        ],
+        '#/text': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'any-of-error',
+                  data: {
+                    anyOf: [
+                      { $ref: '#/definitions/HigherOrderFormattedNodes' },
+                      { $ref: '#/definitions/BaseFormattedNodes' },
+                    ],
+                    pointer: '#/text/0',
+                    value: { children: [{ type: 'text', value: 'hello' }] },
+                  },
+                  message: 'Object at `#/text/0` does not match any schema',
+                  name: 'AnyOfError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'FormattedText.json' }],
+              pointer: '#/text',
+              value: '[{"children":[{"type":"text","value":"hello"}]}]',
+            },
+            message:
+              'Value `[{"children":[{"type":"text","value":"hello"}]}]` in `#/text` does not match any given oneof schema',
+          },
+        ],
+      },
+    );
+  });
+
+  it('should catch validation errors when invalid matrix-asset-uri is provided with invalid other squiz primitive types ', () => {
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+        link: { type: 'SquizLink' },
+        text: { type: 'FormattedText' },
+        asset: {
+          type: 'string',
+          format: 'matrix-asset-uri',
+        },
+      },
+
+      required: ['image', 'link', 'text', 'asset'],
+    };
+    const formattedText: FormattedText = [
+      //@ts-expect-error - wrong type
+      {
+        children: [{ type: 'text', value: 'hello' }],
+      },
+    ];
+    const input: {
+      image: SquizImageType['__shape__'];
+      link: SquizLinkType['__shape__'];
+      text: FormattedText;
+      asset: MatrixAssetUri;
+    } = {
+      image: {
+        name: 'test-image.jpeg',
+        imageVariations: {
+          //@ts-expect-error - wrong type
+          original: {
+            width: 100,
+            url: 'https://www.squiz.net',
+            byteSize: 100,
+            mimeType: 'image/jpeg',
+            sha1Hash: '123',
+          },
+        },
+      },
+      //@ts-expect-error - wrong type
+      link: {
+        name: 'test-link',
+        target: '_blank',
+      },
+      text: formattedText,
+      // @ts-expect-error - wrong type
+      asset: 'matrix://123',
+    };
+
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => jsonSchemaService.validateInput(input, schema),
+      SchemaValidationError,
+      'failed validation: Value `{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}` in `#/image` does not match any given oneof schema,\nValue `{"name":"test-link","target":"_blank"}` in `#/link` does not match any given oneof schema,\nValue `[{"children":[{"type":"text","value":"hello"}]}]` in `#/text` does not match any given oneof schema,\nValue matrix-asset-uri (matrix://123) in `#/asset` is not a valid matrix asset uri',
+      {
+        '#/asset': [
+          {
+            data: {
+              errors: {
+                assetId: {
+                  data: { expected: /^\d+(?::.+)?$/, received: '' },
+                  message: 'Matrix Asset Id has invalid format, must match /^d+(?::.+)?$/',
+                },
+                scheme: {
+                  data: { expected: 'matrix-asset', received: 'matrix' },
+                  message: 'Uri scheme is invalid, must match "matrix-asset"',
+                },
+              },
+              pointer: '#/asset',
+              value: 'matrix://123',
+            },
+            message: 'Value matrix-asset-uri (matrix://123) in `#/asset` is not a valid matrix asset uri',
+          },
+        ],
+        '#/image': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'required-property-error',
+                  data: { key: 'height', pointer: '#/image/imageVariations/original' },
+                  message: 'The required property `height` is missing at `#/image/imageVariations/original`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+                {
+                  code: 'required-property-error',
+                  data: { key: 'aspectRatio', pointer: '#/image/imageVariations/original' },
+                  message: 'The required property `aspectRatio` is missing at `#/image/imageVariations/original`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'SquizImage.json' }],
+              pointer: '#/image',
+              value:
+                '{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}',
+            },
+            message:
+              'Value `{"name":"test-image.jpeg","imageVariations":{"original":{"width":100,"url":"https://www.squiz.net","byteSize":100,"mimeType":"image/jpeg","sha1Hash":"123"}}}` in `#/image` does not match any given oneof schema',
+          },
+        ],
+        '#/link': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'required-property-error',
+                  data: { key: 'url', pointer: '#/link' },
+                  message: 'The required property `url` is missing at `#/link`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'SquizLink.json' }],
+              pointer: '#/link',
+              value: '{"name":"test-link","target":"_blank"}',
+            },
+            message: 'Value `{"name":"test-link","target":"_blank"}` in `#/link` does not match any given oneof schema',
+          },
+        ],
+        '#/text': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'any-of-error',
+                  data: {
+                    anyOf: [
+                      { $ref: '#/definitions/HigherOrderFormattedNodes' },
+                      { $ref: '#/definitions/BaseFormattedNodes' },
+                    ],
+                    pointer: '#/text/0',
+                    value: { children: [{ type: 'text', value: 'hello' }] },
+                  },
+                  message: 'Object at `#/text/0` does not match any schema',
+                  name: 'AnyOfError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'FormattedText.json' }],
+              pointer: '#/text',
+              value: '[{"children":[{"type":"text","value":"hello"}]}]',
+            },
+            message:
+              'Value `[{"children":[{"type":"text","value":"hello"}]}]` in `#/text` does not match any given oneof schema',
+          },
+        ],
+      },
+    );
+  });
+
+  it('should validate when MatrixAssetType is being used for a squiz primitive type with resolver', () => {
+    const typeResolver = TypeResolverBuilder.new()
+      .addPrimitive(SquizImageType)
+      .addPrimitive(SquizLinkType)
+      .addPrimitive(FormattedTextType)
+      .addResolver(SquizImageType, MatrixAssetType, (): SquizImageType['__shape__'] => {
+        return {
+          name: '',
+          imageVariations: {
+            original: {
+              width: 0,
+              height: 0,
+              url: '',
+              mimeType: '',
+              byteSize: 0,
+              sha1Hash: '',
+              aspectRatio: '',
+            },
+          },
+        };
+      })
+      .build();
+
+    const jsonSchemaService = new JSONSchemaService(typeResolver, ComponentInputMetaSchema);
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+        link: { type: 'SquizLink' },
+        text: { type: 'FormattedText' },
+        asset: {
+          type: 'string',
+          format: 'matrix-asset-uri',
+        },
+      },
+      required: ['image', 'link', 'text', 'asset'],
+    };
+    const formattedText: FormattedText = [
+      {
+        tag: 'p',
+        type: 'tag',
+        children: [{ type: 'text', value: 'hello' }],
+      },
+    ];
+    const input: {
+      image: MatrixAssetType['__shape__'];
+      link: SquizLinkType['__shape__'];
+      text: FormattedText;
+      asset: MatrixAssetUri;
+    } = {
+      image: {
+        matrixAssetId: '123',
+        matrixIdentifier: 'identifier',
+        matrixDomain: 'domain',
+      },
+      link: {
+        name: 'test-link',
+        url: 'https://www.squiz.net',
+        target: '_blank',
+      },
+      text: formattedText,
+      asset: 'matrix-asset://identifier/123',
+    };
+
+    expect(jsonSchemaService.validateInput(input, schema)).toEqual(true);
+  });
+
+  it('it should catch MatrixAssetType validation errors when being use for squiz primitive type with resolver', () => {
+    const typeResolver = TypeResolverBuilder.new()
+      .addPrimitive(SquizImageType)
+      .addPrimitive(SquizLinkType)
+      .addPrimitive(FormattedTextType)
+      .addResolver(SquizImageType, MatrixAssetType, (): SquizImageType['__shape__'] => {
+        return {
+          name: '',
+          imageVariations: {
+            original: {
+              width: 0,
+              height: 0,
+              url: '',
+              mimeType: '',
+              byteSize: 0,
+              sha1Hash: '',
+              aspectRatio: '',
+            },
+          },
+        };
+      })
+      .build();
+
+    const jsonSchemaService = new JSONSchemaService(typeResolver, ComponentInputMetaSchema);
+    const schema = {
+      type: 'object',
+      properties: {
+        image: { type: 'SquizImage' },
+      },
+      required: ['image'],
+    };
+    const input: {
+      image: MatrixAssetType['__shape__'];
+    } = {
+      //@ts-expect-error - intentionally invalid input
+      image: {
+        matrixIdentifier: 'identifier',
+      },
+    };
+    expectToThrowErrorMatchingTypeAndMessage(
+      () => jsonSchemaService.validateInput(input, schema),
+      SchemaValidationError,
+      'failed validation: Value `{"matrixIdentifier":"identifier"}` in `#/image` does not match any given oneof schema',
+      {
+        '#/image': [
+          {
+            data: {
+              errors: [
+                {
+                  code: 'required-property-error',
+                  data: { key: 'name', pointer: '#/image' },
+                  message: 'The required property `name` is missing at `#/image`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+                {
+                  code: 'required-property-error',
+                  data: { key: 'imageVariations', pointer: '#/image' },
+                  message: 'The required property `imageVariations` is missing at `#/image`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+                {
+                  code: 'required-property-error',
+                  data: { key: 'matrixAssetId', pointer: '#/image' },
+                  message: 'The required property `matrixAssetId` is missing at `#/image`',
+                  name: 'RequiredPropertyError',
+                  type: 'error',
+                },
+              ],
+              oneOf: [{ $ref: 'SquizImage.json' }, { $ref: 'MatrixAsset.json' }],
+              pointer: '#/image',
+              value: '{"matrixIdentifier":"identifier"}',
+            },
+            message: 'Value `{"matrixIdentifier":"identifier"}` in `#/image` does not match any given oneof schema',
+          },
+        ],
+      },
+    );
+  });
+});