@squiz/dx-json-schema-lib 1.2.13-alpha.2 → 1.2.13-alpha.3

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.13-alpha.3](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.3) (2023-01-16)
+
+**Note:** Version bump only for package @squiz/dx-json-schema-lib
+
 ## [1.2.13-alpha.2](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.2) (2023-01-13)
 
 **Note:** Version bump only for package @squiz/dx-json-schema-lib

package/jest.config.ts

@@ -7,6 +7,7 @@ configFunc();
 const config: Config = {
   preset: 'ts-jest',
   testEnvironment: 'node',
+
   testPathIgnorePatterns: [
     '<rootDir>/lib/',
     '<rootDir>/cdk.out/',
@@ -15,6 +16,12 @@ const config: Config = {
     '.*\\.integration\\.spec\\.ts$',
   ],
   maxWorkers: '80%',
+
+  globals: {
+    'ts-jest': {
+      diagnostics: false,
+    },
+  },
 };
 
 export default config;

package/lib/JsonValidationService.d.ts

@@ -1,9 +1,7 @@
-import Ajv, { AnySchemaObject, SchemaObject } from 'ajv';
+import { JSONSchema } from 'json-schema-library';
 export declare class JsonValidationService {
-    ajv: Ajv;
-    constructor();
     validateManifest(manifest: unknown, version: 'v1'): true;
-    validateContentSchema(contentSchema: AnySchemaObject): true;
-    validateComponentInput(functionInputSchema: SchemaObject, inputValue: unknown): true;
-    private doValidate;
+    validateContentSchema(contentSchema: JSONSchema): true;
+    validateComponentInput(functionInputSchema: JSONSchema, inputValue: unknown): true;
+    private processValidationResult;
 }

package/lib/JsonValidationService.js

@@ -4,50 +4,112 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonValidationService = void 0;
-const ajv_1 = __importDefault(require("ajv"));
-const ajv_formats_1 = __importDefault(require("ajv-formats"));
-const better_ajv_errors_1 = __importDefault(require("better-ajv-errors"));
 const DxComponentInputSchema_json_1 = __importDefault(require("./manifest/v1/DxComponentInputSchema.json"));
 const DxComponentIcons_json_1 = __importDefault(require("./manifest/v1/DxComponentIcons.json"));
 const DxContentMetaSchema_json_1 = __importDefault(require("./manifest/v1/DxContentMetaSchema.json"));
+const Draft_07_json_1 = __importDefault(require("./manifest/v1/Draft-07.json"));
+const formattedText_json_1 = __importDefault(require("./formatted-text/v1/formattedText.json"));
 const v1_json_1 = __importDefault(require("./manifest/v1/v1.json"));
 const SchemaValidationError_1 = require("./errors/SchemaValidationError");
+const json_schema_library_1 = require("json-schema-library");
+const json_schema_library_2 = require("json-schema-library");
+const defaultConfig = {
+    ...json_schema_library_2.draft07Config,
+    errors: {
+        ...json_schema_library_2.draft07Config.errors,
+        enumError(data) {
+            let values = '[]';
+            if (data.values && Array.isArray(data.values)) {
+                if (data.values.length < 5) {
+                    values = `[${data.values.join(', ')}]`;
+                }
+                else {
+                    const firstFiveValues = data.values.slice(0, 5);
+                    values = `[${firstFiveValues.join(', ')}, ... ${data.values.length - 5} more]`;
+                }
+            }
+            return {
+                type: 'error',
+                name: 'EnumError',
+                code: 'enum-error',
+                message: `Expected given value \`${data.value}\` in ${data.pointer}\` to be one of \`${values}\``,
+                data,
+            };
+        },
+        anyOfError(data) {
+            let value = `Value \`${data.value}\` at`;
+            if (typeof data.value == 'object') {
+                value = 'Object at';
+            }
+            if (Array.isArray(data.value)) {
+                value = 'Array at';
+            }
+            return {
+                type: 'error',
+                name: 'AnyOfError',
+                code: 'any-of-error',
+                message: `${value} \`${data.pointer}\` does not match any schema`,
+                data,
+            };
+        },
+    },
+};
+const FTSchema = new json_schema_library_1.Draft07(formattedText_json_1.default);
+const ComponentInputSchema = new json_schema_library_1.Draft({
+    ...defaultConfig,
+    resolveRef(schema, rootSchema) {
+        const resolvedSchema = json_schema_library_2.draft07Config.resolveRef(schema, rootSchema);
+        if (!resolvedSchema) {
+            return resolvedSchema;
+        }
+        if (resolvedSchema.type === 'FormattedText') {
+            return FTSchema.rootSchema;
+        }
+        else if (Array.isArray(resolvedSchema.type) && resolvedSchema.type.includes('FormattedText')) {
+            return {
+                ...schema,
+                ...FTSchema.rootSchema,
+                type: resolvedSchema.type.filter((t) => t !== 'FormattedText').concat(formattedText_json_1.default.type),
+            };
+        }
+        else {
+            return resolvedSchema;
+        }
+    },
+}, DxComponentInputSchema_json_1.default);
+ComponentInputSchema.addRemoteSchema('DxComponentInputSchema.json/DxContentMetaSchema.json', DxContentMetaSchema_json_1.default);
+const v1Schema = new json_schema_library_1.Draft07(v1_json_1.default, defaultConfig);
+v1Schema.addRemoteSchema('DxComponentInputSchema.json/DxContentMetaSchema.json', DxContentMetaSchema_json_1.default);
+v1Schema.addRemoteSchema('/DxComponentInputSchema.json', ComponentInputSchema.getSchema());
+v1Schema.addRemoteSchema('/DxComponentIcons.json', DxComponentIcons_json_1.default);
+v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema', Draft_07_json_1.default);
+v1Schema.addRemoteSchema('http://json-schema.org/draft-07/schema#', Draft_07_json_1.default);
+const ContentSchemaSchema = new json_schema_library_1.Draft07(DxComponentInputSchema_json_1.default, defaultConfig);
+ContentSchemaSchema.addRemoteSchema('DxComponentInputSchema.json/DxContentMetaSchema.json', DxContentMetaSchema_json_1.default);
 class JsonValidationService {
-    constructor() {
-        this.ajv = new ajv_1.default({
-            strict: true,
-            schemas: { DxContentMetaSchema: DxContentMetaSchema_json_1.default, v1: v1_json_1.default, DxComponentIcons: DxComponentIcons_json_1.default, DxComponentInputSchema: DxComponentInputSchema_json_1.default },
-            allowUnionTypes: true,
-            allErrors: true,
-            formats: {
-                'multi-line': true,
-            },
-        });
-        (0, ajv_formats_1.default)(this.ajv);
-    }
     validateManifest(manifest, version) {
         switch (version) {
-            case 'v1':
-                return this.doValidate(v1_json_1.default, manifest);
+            case 'v1': {
+                const validationResult = v1Schema.validate(manifest);
+                return this.processValidationResult(validationResult);
+            }
             default:
-                throw new Error('Invalid manifest version');
+                throw new SchemaValidationError_1.SchemaValidationError('Invalid manifest version');
         }
     }
     validateContentSchema(contentSchema) {
-        // This schema matches the input definition in the manifest
-        return this.doValidate(DxComponentInputSchema_json_1.default, contentSchema);
+        return this.processValidationResult(ContentSchemaSchema.validate(contentSchema));
     }
     validateComponentInput(functionInputSchema, inputValue) {
-        return this.doValidate(functionInputSchema, inputValue);
+        const inputSchema = ComponentInputSchema.compileSchema(functionInputSchema);
+        const errors = ComponentInputSchema.validate(inputValue, inputSchema);
+        return this.processValidationResult(errors);
     }
-    doValidate(schema, value) {
-        const result = this.ajv.validate(schema, value);
-        if (!result) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const betterErrors = (0, better_ajv_errors_1.default)(schema, value, this.ajv.errors, { format: 'js' });
-            throw new SchemaValidationError_1.SchemaValidationError(betterErrors);
+    processValidationResult(errors) {
+        if (errors.length > 0) {
+            throw new SchemaValidationError_1.SchemaValidationError(errors.map((a) => a.message).join(',\n'));
         }
-        return result;
+        return true;
     }
 }
 exports.JsonValidationService = JsonValidationService;

package/lib/JsonValidationService.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonValidationService.js","sourceRoot":"","sources":["../src/JsonValidationService.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAyD;AACzD,8DAAqC;AACrC,0EAAgD;AAEhD,4GAA+E;AAC/E,gGAAmE;AACnE,sGAAyE;AACzE,oEAAuC;AACvC,0EAAuE;AAEvE,MAAa,qBAAqB;IAEhC;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC;YACjB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,EAAE,mBAAmB,EAAnB,kCAAmB,EAAE,EAAE,EAAF,iBAAE,EAAE,gBAAgB,EAAhB,+BAAgB,EAAE,sBAAsB,EAAtB,qCAAsB,EAAE;YAC9E,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE;gBACP,YAAY,EAAE,IAAI;aACnB;SACF,CAAC,CAAC;QAEH,IAAA,qBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,gBAAgB,CAAC,QAAiB,EAAE,OAAa;QAC/C,QAAQ,OAAO,EAAE;YACf,KAAK,IAAI;gBACP,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAE,EAAE,QAAQ,CAAC,CAAC;YAEvC;gBACE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC/C;IACH,CAAC;IAED,qBAAqB,CAAC,aAA8B;QAClD,2DAA2D;QAC3D,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAsB,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;IAED,sBAAsB,CAAC,mBAAiC,EAAE,UAAmB;QAC3E,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAEO,UAAU,CAAC,MAA6B,EAAE,KAAc;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,EAAE;YACX,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAA,2BAAe,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,MAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YACxF,MAAM,IAAI,6CAAqB,CAAC,YAAY,CAAC,CAAC;SAC/C;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA3CD,sDA2CC"}
+{"version":3,"file":"JsonValidationService.js","sourceRoot":"","sources":["../src/JsonValidationService.ts"],"names":[],"mappings":";;;;;;AAAA,4GAA+E;AAC/E,gGAAmE;AACnE,sGAAyE;AACzE,gFAAwD;AAExD,gGAAmE;AAEnE,oEAAuC;AACvC,0EAAuE;AACvE,6DAAyF;AAEzF,6DAAoD;AAGpD,MAAM,aAAa,GAAgB;IACjC,GAAG,mCAAa;IAChB,MAAM,EAAE;QACN,GAAG,mCAAa,CAAC,MAAM;QAEvB,SAAS,CAAC,IAAI;YACZ,IAAI,MAAM,GAAG,IAAI,CAAC;YAElB,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC1B,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;iBACxC;qBAAM;oBACL,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAChD,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC;iBAChF;aACF;YAED,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,0BAA0B,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,qBAAqB,MAAM,IAAI;gBACjG,IAAI;aACL,CAAC;QACJ,CAAC;QAED,UAAU,CAAC,IAAI;YACb,IAAI,KAAK,GAAG,WAAW,IAAI,CAAC,KAAK,OAAO,CAAC;YAEzC,IAAI,OAAO,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE;gBACjC,KAAK,GAAG,WAAW,CAAC;aACrB;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC7B,KAAK,GAAG,UAAU,CAAC;aACpB;YAED,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,GAAG,KAAK,MAAM,IAAI,CAAC,OAAO,8BAA8B;gBACjE,IAAI;aACL,CAAC;QACJ,CAAC;KACF;CACF,CAAC;AAEF,MAAM,QAAQ,GAAG,IAAI,6BAAO,CAAC,4BAAa,CAAC,CAAC;AAE5C,MAAM,oBAAoB,GAAG,IAAI,2BAAK,CACpC;IACE,GAAG,aAAa;IAEhB,UAAU,CAAC,MAAM,EAAE,UAAU;QAC3B,MAAM,cAAc,GAAG,mCAAa,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAA4C,CAAC;QAC/G,IAAI,CAAC,cAAc,EAAE;YACnB,OAAO,cAAc,CAAC;SACvB;QACD,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,EAAE;YAC3C,OAAO,QAAQ,CAAC,UAAU,CAAC;SAC5B;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;YAC9F,OAAO;gBACL,GAAG,MAAM;gBACT,GAAG,QAAQ,CAAC,UAAU;gBACtB,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,eAAe,CAAC,CAAC,MAAM,CAAC,4BAAa,CAAC,IAAe,CAAC;aACrG,CAAC;SACH;aAAM;YACL,OAAO,cAAc,CAAC;SACvB;IACH,CAAC;CACF,EACD,qCAAsB,CACvB,CAAC;AACF,oBAAoB,CAAC,eAAe,CAAC,sDAAsD,EAAE,kCAAmB,CAAC,CAAC;AAElH,MAAM,QAAQ,GAAG,IAAI,6BAAO,CAAC,iBAAE,EAAE,aAAa,CAAC,CAAC;AAEhD,QAAQ,CAAC,eAAe,CAAC,sDAAsD,EAAE,kCAAmB,CAAC,CAAC;AACtG,QAAQ,CAAC,eAAe,CAAC,8BAA8B,EAAE,oBAAoB,CAAC,SAAS,EAAE,CAAC,CAAC;AAC3F,QAAQ,CAAC,eAAe,CAAC,wBAAwB,EAAE,+BAAgB,CAAC,CAAC;AACrE,QAAQ,CAAC,eAAe,CAAC,wCAAwC,EAAE,uBAAa,CAAC,CAAC;AAClF,QAAQ,CAAC,eAAe,CAAC,yCAAyC,EAAE,uBAAa,CAAC,CAAC;AAEnF,MAAM,mBAAmB,GAAG,IAAI,6BAAO,CAAC,qCAAsB,EAAE,aAAa,CAAC,CAAC;AAC/E,mBAAmB,CAAC,eAAe,CAAC,sDAAsD,EAAE,kCAAmB,CAAC,CAAC;AAEjH,MAAa,qBAAqB;IAChC,gBAAgB,CAAC,QAAiB,EAAE,OAAa;QAC/C,QAAQ,OAAO,EAAE;YACf,KAAK,IAAI,CAAC,CAAC;gBACT,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;aACvD;YAED;gBACE,MAAM,IAAI,6CAAqB,CAAC,0BAA0B,CAAC,CAAC;SAC/D;IACH,CAAC;IACD,qBAAqB,CAAC,aAAyB;QAC7C,OAAO,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,sBAAsB,CAAC,mBAA+B,EAAE,UAAmB;QACzE,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;QAC5E,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEtE,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEO,uBAAuB,CAAC,MAAmB;QACjD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;SAC3E;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA9BD,sDA8BC"}

package/lib/JsonValidationService.spec.js

@@ -6,12 +6,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const JsonValidationService_1 = require("./JsonValidationService");
 const SchemaValidationError_1 = require("./errors/SchemaValidationError");
 const validComponent_json_1 = __importDefault(require("./manifest/v1/__test__/schemas/validComponent.json"));
+const validComponentJson_json_1 = __importDefault(require("./manifest/v1/__test__/schemas/validComponentJson.json"));
+// eslint-disable-next-line @typescript-eslint/ban-types
+function expectToThrowErrorMatchingTypeAndMessage(received, errorType, message) {
+    let error = null;
+    try {
+        received();
+    }
+    catch (e) {
+        error = e;
+    }
+    expect(error).toBeDefined();
+    expect(error === null || error === void 0 ? void 0 : error.message).toEqual(message);
+    expect(error).toBeInstanceOf(errorType);
+}
 describe('JsonValidationService', () => {
-    let jsonValidationService;
-    beforeEach(() => {
-        jsonValidationService = new JsonValidationService_1.JsonValidationService();
-    });
+    const jsonValidationService = new JsonValidationService_1.JsonValidationService();
     describe('validateManifest', () => {
+        it('should return true for a valid JSON endpoint manifest', () => {
+            const result = jsonValidationService.validateManifest(validComponentJson_json_1.default, 'v1');
+            expect(result).toBe(true);
+        });
         it('should return true for a valid manifest', () => {
             const result = jsonValidationService.validateManifest(validComponent_json_1.default, 'v1');
             expect(result).toBe(true);
@@ -19,17 +34,14 @@ describe('JsonValidationService', () => {
         it('should throw a SchemaValidationError for an invalid manifest', () => {
             const invalidManifest = { ...validComponent_json_1.default };
             delete invalidManifest.name;
-            expect(() => {
-                jsonValidationService.validateManifest(invalidManifest, 'v1');
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
-            expect(() => {
+            expectToThrowErrorMatchingTypeAndMessage(() => {
                 jsonValidationService.validateManifest(invalidManifest, 'v1');
-            }).toMatchInlineSnapshot(`[Function]`);
+            }, SchemaValidationError_1.SchemaValidationError, `failed validation: The required property \`name\` is missing at \`#\``);
         });
         it('should throw an error for an invalid manifest version', () => {
-            expect(() => {
+            expectToThrowErrorMatchingTypeAndMessage(() => {
                 jsonValidationService.validateManifest(validComponent_json_1.default, 'invalid-version');
-            }).toThrow(Error);
+            }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Invalid manifest version');
         });
     });
     describe('validateContentSchema', () => {
@@ -44,8 +56,7 @@ describe('JsonValidationService', () => {
             const result = jsonValidationService.validateContentSchema(contentSchema);
             expect(result).toBe(true);
         });
-        // TODO DEVX-658
-        it.skip('should return false for an invalid content schema, where the required property is missed from a child object', () => {
+        it('should return false for an invalid content schema, where the required property is missed from a child object', () => {
             const contentSchema = {
                 type: 'object',
                 properties: {
@@ -58,9 +69,9 @@ describe('JsonValidationService', () => {
                 },
                 required: ['my-input'],
             };
-            expect(() => {
+            expectToThrowErrorMatchingTypeAndMessage(() => {
                 jsonValidationService.validateContentSchema(contentSchema);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+            }, SchemaValidationError_1.SchemaValidationError, 'failed validation: The required property `required` is missing at `#/properties/my-input`');
         });
         it('should throw a SchemaValidationError for an invalid content schema, top level type must be object', () => {
             const contentSchema = {
@@ -73,70 +84,270 @@ describe('JsonValidationService', () => {
                     required: ['my-input'],
                 },
             };
-            expect(() => {
+            expectToThrowErrorMatchingTypeAndMessage(() => {
                 jsonValidationService.validateContentSchema(contentSchema);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+            }, SchemaValidationError_1.SchemaValidationError, `failed validation: Expected value at \`#/type\` to be \`object\`, but value given is \`array\``);
         });
-        // TODO DEVX-658
-        it.skip('should throw a SchemaValidationError for an invalid content schema missing the required property', () => {
+        it('should throw a SchemaValidationError for an invalid content schema missing the required property', () => {
             const contentSchema = {
                 type: 'object',
                 properties: {
                     'my-input': { type: 'number' },
                 },
             };
-            expect(() => {
+            expectToThrowErrorMatchingTypeAndMessage(() => {
                 jsonValidationService.validateContentSchema(contentSchema);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+            }, SchemaValidationError_1.SchemaValidationError, 'failed validation: The required property `required` is missing at `#`');
         });
     });
     describe('validateComponentInput', () => {
-        const functionInputSchema = {
-            type: 'object',
-            properties: {
-                'my-input': { type: 'number' },
-            },
-            required: ['my-input'],
-        };
-        it('should return true for valid input values', () => {
-            const inputValue = {
-                'my-input': 123,
-            };
-            const result = jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            expect(result).toBe(true);
-        });
-        it('should throw a SchemaValidationError for invalid input type', () => {
-            const inputValue = {
-                'my-input': '123',
-            };
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toMatchInlineSnapshot(`[Function]`);
-        });
-        it('should throw a SchemaValidationError for invalid input missing properties', () => {
-            const inputValue = {};
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toMatchInlineSnapshot(`[Function]`);
+        describe('FormattedText input', () => {
+            it('should handle type as an array', () => {
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: ['number', 'string'] },
+                    },
+                    required: ['my-input'],
+                };
+                expect(jsonValidationService.validateComponentInput(functionInputSchema, {
+                    'my-input': 'formattedText',
+                })).toEqual(true);
+                expect(jsonValidationService.validateComponentInput(functionInputSchema, {
+                    'my-input': 123,
+                })).toEqual(true);
+            });
+            it('should handle type is an array of both string and FormattedText', () => {
+                const formattedText = [
+                    {
+                        tag: 'p',
+                        type: 'tag',
+                        children: [
+                            { type: 'text', value: 'This is some ' },
+                            { type: 'text', value: 'Link to asset 12345' },
+                            { type: 'text', value: ' with an image ' },
+                            { type: 'text', value: '.' },
+                        ],
+                    },
+                ];
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: ['FormattedText', 'string'] },
+                    },
+                    required: ['my-input'],
+                };
+                expect(jsonValidationService.validateComponentInput(functionInputSchema, {
+                    'my-input': formattedText,
+                })).toEqual(true);
+                expect(jsonValidationService.validateComponentInput(functionInputSchema, {
+                    'my-input': 'hello',
+                })).toEqual(true);
+            });
+            it('should return true if input is formatted text', () => {
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'FormattedText' },
+                    },
+                    required: ['my-input'],
+                };
+                const formattedText = [
+                    {
+                        tag: 'p',
+                        type: 'tag',
+                        children: [
+                            { type: 'text', value: 'This is some ' },
+                            { type: 'text', value: 'Link to asset 12345' },
+                            { type: 'text', value: ' with an image ' },
+                            { type: 'text', value: '.' },
+                        ],
+                    },
+                ];
+                const inputValue = {
+                    'my-input': formattedText,
+                };
+                expect(jsonValidationService.validateComponentInput(functionInputSchema, inputValue)).toEqual(true);
+            });
+            it('should throw an error if the FormattedText input is not formatted text', () => {
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'FormattedText' },
+                    },
+                    required: ['my-input'],
+                };
+                const inputValue = {
+                    'my-input': 123,
+                };
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, `failed validation: Expected \`123\` (number) in \`#/my-input\` to be of type \`array\``);
+            });
+            it('should throw an error if the FormattedText input is invalid formatted text', () => {
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'FormattedText' },
+                    },
+                    required: ['my-input'],
+                };
+                const inputValue = {
+                    'my-input': {
+                        something: 'aa',
+                    },
+                };
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, `failed validation: Expected \`[object Object]\` (object) in \`#/my-input\` to be of type \`array\``);
+            });
+            it('should throw an error if the FormattedText input is invalid formatted text (deeply nested)', () => {
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'FormattedText' },
+                    },
+                    required: ['my-input'],
+                };
+                const formattedText = [
+                    {
+                        tag: 'p',
+                        type: 'tag',
+                        children: [
+                            { type: 'text', value: 'This is some ' },
+                            { type: 'text', value: 'Link to asset 12345' },
+                            { type: 'text', value: ' with an image ' },
+                            { type: 'text', value: 123 },
+                            { type: 'text', value: '.' },
+                        ],
+                    },
+                ];
+                const inputValue = {
+                    'my-input': formattedText,
+                };
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Object at `#/my-input/0` does not match any schema');
+            });
+            it('should validate an array of formatted texts', () => {
+                const formattedText = [
+                    {
+                        tag: 'p',
+                        type: 'tag',
+                        children: [{ type: 'text', value: 'hello' }],
+                    },
+                ];
+                const schema = {
+                    type: 'object',
+                    properties: {
+                        arr: {
+                            type: 'array',
+                            items: { type: 'FormattedText' },
+                        },
+                    },
+                };
+                const value = {
+                    arr: [formattedText],
+                };
+                expect(jsonValidationService.validateComponentInput(schema, value)).toEqual(true);
+            });
+            it('should throw an error if the FormattedText input is invalid formatted text (deeply, deeply nested)', () => {
+                const formattedText = [
+                    {
+                        tag: 'p',
+                        type: 'tag',
+                        children: [{ type: 'text', value: 'hello' }],
+                    },
+                ];
+                const inputValue = {
+                    'my-input': formattedText,
+                    deep: {
+                        arr: [
+                            {
+                                prop: formattedText,
+                                formattedTextArray: [formattedText, formattedText, { bad: 'data' }],
+                            },
+                        ],
+                    },
+                };
+                const functionInputSchema = {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'FormattedText' },
+                        deep: {
+                            type: 'object',
+                            properties: {
+                                arr: {
+                                    type: 'array',
+                                    items: {
+                                        type: 'object',
+                                        required: ['prop', 'formattedTextArray'],
+                                        properties: {
+                                            prop: 'FormattedText',
+                                            formattedTextArray: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'FormattedText',
+                                                },
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                            required: ['arr'],
+                        },
+                    },
+                    required: ['my-input', 'deep'],
+                };
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Expected `[object Object]` (object) in `#/deep/arr/0/formattedTextArray/2` to be of type `array`');
+            });
         });
-        // TODO DEVX-658
-        it.skip('should throw a SchemaValidationError for invalid input additional properties', () => {
-            const inputValue = {
-                'my-input': 123,
-                'my-input-2': 123,
+        describe('standard inputs', () => {
+            const functionInputSchema = {
+                type: 'object',
+                properties: {
+                    'my-input': { type: 'number' },
+                },
+                required: ['my-input'],
             };
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toThrow(SchemaValidationError_1.SchemaValidationError);
-            expect(() => {
-                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
-            }).toMatchInlineSnapshot();
+            it('should return true for valid input values', () => {
+                const inputValue = {
+                    'my-input': 123,
+                };
+                const result = jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                expect(result).toBe(true);
+            });
+            it('should throw a SchemaValidationError for invalid input type', () => {
+                const inputValue = {
+                    'my-input': '123',
+                };
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, `failed validation: Expected \`123\` (string) in \`#/my-input\` to be of type \`number\``);
+            });
+            it('should throw a SchemaValidationError for invalid input missing properties', () => {
+                const inputValue = {};
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }, SchemaValidationError_1.SchemaValidationError, `failed validation: The required property \`my-input\` is missing at \`#\``);
+            });
+            it('should throw a SchemaValidationError with a truncated enum value list if there are more than 5 enum options', () => {
+                expectToThrowErrorMatchingTypeAndMessage(() => {
+                    jsonValidationService.validateComponentInput({ type: 'object', properties: { enum: { type: 'string', enum: ['a', 'b', 'c', 'd', 'e', 'f', 'g'] } } }, { enum: 'z' });
+                }, SchemaValidationError_1.SchemaValidationError, 'failed validation: Expected given value `z` in #/enum` to be one of `[a, b, c, d, e, ... 2 more]`');
+            });
+            // TODO DEVX-658
+            it.skip('should throw a SchemaValidationError for invalid input additional properties', () => {
+                const inputValue = {
+                    'my-input': 123,
+                    'my-input-2': 123,
+                };
+                expect(() => {
+                    jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+                }).toThrowErrorMatchingInlineSnapshot();
+            });
         });
     });
 });