@squiz/dx-json-schema-lib 1.2.13-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+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.0](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.0) (2023-01-13)
+
+**Note:** Version bump only for package @squiz/dx-json-schema-lib

package/jest.config.ts

@@ -0,0 +1,20 @@
+import type { Config } from 'jest';
+
+import { config as configFunc } from 'dotenv';
+configFunc();
+
+// Sync object
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testPathIgnorePatterns: [
+    '<rootDir>/lib/',
+    '<rootDir>/cdk.out/',
+    'test.ts',
+    '/integration-tests/',
+    '.*\\.integration\\.spec\\.ts$',
+  ],
+  maxWorkers: '80%',
+};
+
+export default config;

package/jsonCompiler.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import * as path from 'path';
+import { compileFromFile } from 'json-schema-to-typescript';
+import { writeFile } from 'fs/promises';
+
+const files = ['src/manifest/v1/v1.json', 'src/formatted-text/v1/formattedText.json'];
+
+(async function main() {
+  for (const file of files) {
+    const fullPath = path.resolve(__dirname, file);
+    const directory = path.dirname(fullPath);
+    const filename = path.basename(fullPath, '.json');
+
+    const output = await compileFromFile(fullPath, {
+      cwd: directory,
+      ignoreMinAndMaxItems: true,
+      style: { singleQuote: true },
+    });
+
+    await writeFile(path.join(directory, `${filename}.ts`), output);
+  }
+})();

package/lib/JsonValidationService.d.ts

@@ -0,0 +1,9 @@
+import Ajv, { AnySchemaObject, SchemaObject } from 'ajv';
+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;
+}

package/lib/JsonValidationService.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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 v1_json_1 = __importDefault(require("./manifest/v1/v1.json"));
+const SchemaValidationError_1 = require("./errors/SchemaValidationError");
+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);
+            default:
+                throw new Error('Invalid manifest version');
+        }
+    }
+    validateContentSchema(contentSchema) {
+        // This schema matches the input definition in the manifest
+        return this.doValidate(DxComponentInputSchema_json_1.default, contentSchema);
+    }
+    validateComponentInput(functionInputSchema, inputValue) {
+        return this.doValidate(functionInputSchema, inputValue);
+    }
+    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);
+        }
+        return result;
+    }
+}
+exports.JsonValidationService = JsonValidationService;
+//# sourceMappingURL=JsonValidationService.js.map

package/lib/JsonValidationService.js.map

@@ -0,0 +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"}

package/lib/JsonValidationService.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/JsonValidationService.spec.js

@@ -0,0 +1,143 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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"));
+describe('JsonValidationService', () => {
+    let jsonValidationService;
+    beforeEach(() => {
+        jsonValidationService = new JsonValidationService_1.JsonValidationService();
+    });
+    describe('validateManifest', () => {
+        it('should return true for a valid manifest', () => {
+            const result = jsonValidationService.validateManifest(validComponent_json_1.default, 'v1');
+            expect(result).toBe(true);
+        });
+        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(() => {
+                jsonValidationService.validateManifest(invalidManifest, 'v1');
+            }).toMatchInlineSnapshot(`[Function]`);
+        });
+        it('should throw an error for an invalid manifest version', () => {
+            expect(() => {
+                jsonValidationService.validateManifest(validComponent_json_1.default, 'invalid-version');
+            }).toThrow(Error);
+        });
+    });
+    describe('validateContentSchema', () => {
+        it('should return true for a valid content schema', () => {
+            const contentSchema = {
+                type: 'object',
+                properties: {
+                    'my-input': { type: 'number' },
+                },
+                required: ['my-input'],
+            };
+            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', () => {
+            const contentSchema = {
+                type: 'object',
+                properties: {
+                    'my-input': {
+                        type: 'object',
+                        properties: {
+                            'my-deep-input': { type: 'object' },
+                        },
+                    },
+                },
+                required: ['my-input'],
+            };
+            expect(() => {
+                jsonValidationService.validateContentSchema(contentSchema);
+            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+        });
+        it('should throw a SchemaValidationError for an invalid content schema, top level type must be object', () => {
+            const contentSchema = {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        'my-input': { type: 'number' },
+                    },
+                    required: ['my-input'],
+                },
+            };
+            expect(() => {
+                jsonValidationService.validateContentSchema(contentSchema);
+            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+        });
+        // TODO DEVX-658
+        it.skip('should throw a SchemaValidationError for an invalid content schema missing the required property', () => {
+            const contentSchema = {
+                type: 'object',
+                properties: {
+                    'my-input': { type: 'number' },
+                },
+            };
+            expect(() => {
+                jsonValidationService.validateContentSchema(contentSchema);
+            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+        });
+    });
+    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]`);
+        });
+        // 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);
+            }).toThrow(SchemaValidationError_1.SchemaValidationError);
+            expect(() => {
+                jsonValidationService.validateComponentInput(functionInputSchema, inputValue);
+            }).toMatchInlineSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=JsonValidationService.spec.js.map

package/lib/JsonValidationService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonValidationService.spec.js","sourceRoot":"","sources":["../src/JsonValidationService.spec.ts"],"names":[],"mappings":";;;;;AAAA,mEAAgE;AAChE,0EAAuE;AAEvE,6GAA+E;AAE/E,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,qBAA4C,CAAC;IACjD,UAAU,CAAC,GAAG,EAAE;QACd,qBAAqB,GAAG,IAAI,6CAAqB,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,6BAAa,EAAE,IAAI,CAAC,CAAC;YAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,eAAe,GAAG,EAAE,GAAG,6BAAa,EAAE,CAAC;YAE7C,OAAQ,eAAuB,CAAC,IAAI,CAAC;YAErC,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;YAClC,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,gBAAgB,CAAC,6BAAa,EAAE,iBAAwB,CAAC,CAAC;YAClF,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,aAAa,GAAG;gBACpB,IAAI,EAAE,QAAQ;gBAEd,UAAU,EAAE;oBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC/B;gBAED,QAAQ,EAAE,CAAC,UAAU,CAAC;aACvB,CAAC;YACF,MAAM,MAAM,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;YAC1E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,EAAE,CAAC,IAAI,CAAC,8GAA8G,EAAE,GAAG,EAAE;YAC3H,MAAM,aAAa,GAAG;gBACpB,IAAI,EAAE,QAAQ;gBAEd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBAEd,UAAU,EAAE;4BACV,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yBACpC;qBACF;iBACF;gBAED,QAAQ,EAAE,CAAC,UAAU,CAAC;aACvB,CAAC;YACF,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mGAAmG,EAAE,GAAG,EAAE;YAC3G,MAAM,aAAa,GAAG;gBACpB,IAAI,EAAE,OAAO;gBAEb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC/B;oBACD,QAAQ,EAAE,CAAC,UAAU,CAAC;iBACvB;aACF,CAAC;YACF,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,EAAE,CAAC,IAAI,CAAC,kGAAkG,EAAE,GAAG,EAAE;YAC/G,MAAM,aAAa,GAAG;gBACpB,IAAI,EAAE,QAAQ;gBAEd,UAAU,EAAE;oBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC/B;aACF,CAAC;YACF,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,MAAM,mBAAmB,GAAG;YAC1B,IAAI,EAAE,QAAQ;YAEd,UAAU,EAAE;gBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAC/B;YAED,QAAQ,EAAE,CAAC,UAAU,CAAC;SACvB,CAAC;QAEF,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,UAAU,GAAG;gBACjB,UAAU,EAAE,GAAG;aAChB,CAAC;YACF,MAAM,MAAM,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAC7F,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,UAAU,GAAG;gBACjB,UAAU,EAAE,KAAK;aAClB,CAAC;YACF,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;YAClC,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;YACnF,MAAM,UAAU,GAAG,EAAE,CAAC;YACtB,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;YAClC,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,EAAE,CAAC,IAAI,CAAC,8EAA8E,EAAE,GAAG,EAAE;YAC3F,MAAM,UAAU,GAAG;gBACjB,UAAU,EAAE,GAAG;gBACf,YAAY,EAAE,GAAG;aAClB,CAAC;YACF,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;YAClC,MAAM,CAAC,GAAG,EAAE;gBACV,qBAAqB,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC,qBAAqB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/errors/SchemaValidationError.d.ts

@@ -0,0 +1,4 @@
+import { IOutputError } from 'better-ajv-errors';
+export declare class SchemaValidationError extends Error {
+    constructor(validationErrors: IOutputError[], error?: Error);
+}

package/lib/errors/SchemaValidationError.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaValidationError = void 0;
+class SchemaValidationError extends Error {
+    constructor(validationErrors, error) {
+        super(`failed validation: ${validationErrors.map((e) => e.error).join(', ')}`);
+        this.stack = error === null || error === void 0 ? void 0 : error.stack;
+        this.name = 'SchemaValidationError';
+    }
+}
+exports.SchemaValidationError = SchemaValidationError;
+//# sourceMappingURL=SchemaValidationError.js.map

package/lib/errors/SchemaValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaValidationError.js","sourceRoot":"","sources":["../../src/errors/SchemaValidationError.ts"],"names":[],"mappings":";;;AAEA,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,gBAAgC,EAAE,KAAa;QACzD,KAAK,CAAC,sBAAsB,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/E,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAND,sDAMC"}

package/lib/formatted-text/v1/formattedText.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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.
+ */
+export type FormattedNodes = HigherOrderFormattedNodes | BaseFormattedNodes;
+export type HigherOrderFormattedNodes = FormattedTextLinkToMatrixAsset | FormattedTextMatrixImage;
+export type FormattedTextLinkToMatrixAsset = FormattedNodeWithChildren & {
+    type: 'link-to-matrix-asset';
+    matrixIdentifier?: string;
+    matrixDomain: string;
+    matrixAssetId: string;
+    target: '_blank' | '_self' | '_parent' | '_top';
+};
+export type FormattedNodeWithChildren = FormattedNode & {
+    children: FormattedNodes[];
+};
+export type FormattedTextMatrixImage = FormattedNode & {
+    type: 'matrix-image';
+    matrixIdentifier?: string;
+    matrixDomain: string;
+    matrixAssetId: string;
+};
+export type BaseFormattedNodes = FormattedTextTag | TextNode;
+export type FormattedTextTag = FormattedNodeWithChildren & {
+    type: 'tag';
+    tag: string;
+    attributes?: {
+        [k: string]: string;
+    };
+    font?: FormattedNodeFontProperties;
+};
+export type FormattedText = FormattedNodes[];
+export interface FormattedNode {
+    type: string;
+    formattingOptions?: {
+        alignment?: 'center' | 'left' | 'right' | 'justify';
+    };
+}
+export interface FormattedNodeFontProperties {
+    bold?: boolean;
+    underline?: boolean;
+    italics?: boolean;
+    color?: string;
+    size?: string;
+    fontFamily?: string;
+}
+export interface TextNode {
+    type: 'text';
+    value: string;
+}

package/lib/formatted-text/v1/formattedText.js

@@ -0,0 +1,9 @@
+"use strict";
+/* tslint: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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=formattedText.js.map

package/lib/formatted-text/v1/formattedText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formattedText.js","sourceRoot":"","sources":["../../../src/formatted-text/v1/formattedText.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB;;;;GAIG"}

package/lib/formatted-text/v1/formattedText.json

@@ -0,0 +1,134 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "array",
+    "additionalProperties": false,
+    "title": "FormattedText",
+    "items": {
+        "$ref": "#/definitions/FormattedNodes"
+    },
+    "definitions": {
+        "FormattedNodes": {
+            "anyOf": [{ "$ref": "#/definitions/HigherOrderFormattedNodes" }, { "$ref": "#/definitions/BaseFormattedNodes" }]
+        },
+        "HigherOrderFormattedNodes": {
+            "anyOf": [
+                { "$ref": "#/definitions/FormattedTextLinkToMatrixAsset" },
+                { "$ref": "#/definitions/FormattedTextMatrixImage" }
+            ]
+        },
+        "BaseFormattedNodes": {
+            "anyOf": [{ "$ref": "#/definitions/FormattedTextTag" }, { "$ref": "#/definitions/TextNode" }]
+        },
+        "TextNode": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "type": { "const": "text" },
+                "value": { "type": "string" }
+            },
+            "required": ["type", "value"]
+        },
+        "FormattedNode": {
+            "type": "object",
+            "properties": {
+                "type": { "type": "string" },
+                "formattingOptions": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "alignment": {
+                            "type": "string",
+                            "enum": ["center", "left", "right", "justify"]
+                        }
+                    }
+                }
+            },
+            "required": ["type"],
+            "additionalProperties": false
+        },
+        "FormattedNodeWithChildren": {
+            "type": "object",
+            "additionalProperties": false,
+            "allOf": [
+                { "$ref": "#/definitions/FormattedNode" },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "children": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/FormattedNodes"
+                            }
+                        }
+                    },
+                    "required": ["children"]
+                }
+            ]
+        },
+        "FormattedTextTag": {
+            "allOf": [
+                { "$ref": "#/definitions/FormattedNodeWithChildren" },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "const": "tag" },
+                        "tag": { "type": "string", "minLength": 1 },
+                        "attributes": {
+                            "type": "object",
+                            "additionalProperties": { "type": "string" }
+                        },
+                        "font": {
+                            "title": "FormattedNodeFontProperties",
+                            "type": "object",
+                            "additionalProperties": false,
+                            "properties": {
+                                "bold": { "type": "boolean" },
+                                "underline": { "type": "boolean" },
+                                "italics": { "type": "boolean" },
+                                "color": { "type": "string" },
+                                "size": { "type": "string" },
+                                "fontFamily": { "type": "string" }
+                            }
+                        }
+                    },
+                    "required": ["type", "tag"]
+                }
+            ]
+        },
+        "FormattedTextLinkToMatrixAsset": {
+            "allOf": [
+                { "$ref": "#/definitions/FormattedNodeWithChildren" },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "const": "link-to-matrix-asset" },
+                        "matrixIdentifier": { "type": "string", "minLength": 1 },
+                        "matrixDomain": { "type": "string", "minLength": 1 },
+                        "matrixAssetId": { "type": "string", "minLength": 1 },
+                        "target": { "type": "string", "enum": ["_blank", "_self", "_parent", "_top"] }
+                    },
+                    "required": ["type", "matrixDomain", "matrixAssetId", "target"]
+                }
+            ]
+        },
+        "FormattedTextMatrixImage": {
+            "allOf": [
+                { "$ref": "#/definitions/FormattedNode" },
+                {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "const": "matrix-image" },
+                        "matrixIdentifier": { "type": "string", "minLength": 1 },
+                        "matrixDomain": { "type": "string", "minLength": 1 },
+                        "matrixAssetId": { "type": "string", "minLength": 1 }
+                    },
+                    "required": ["type", "matrixDomain", "matrixAssetId"]
+                }
+            ]
+        }
+    }
+}

package/lib/formatted-text/v1/formattedTextModels.d.ts

@@ -0,0 +1 @@
+export * as v1 from './formattedText';

package/lib/formatted-text/v1/formattedTextModels.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+exports.v1 = __importStar(require("./formattedText"));
+//# sourceMappingURL=formattedTextModels.js.map

package/lib/formatted-text/v1/formattedTextModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formattedTextModels.js","sourceRoot":"","sources":["../../../src/formatted-text/v1/formattedTextModels.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAsC"}

package/lib/formatted-text/v1/formattedTextSchemas.d.ts

@@ -0,0 +1,2 @@
+import v1 from './formattedText.json';
+export { v1 };

package/lib/formatted-text/v1/formattedTextSchemas.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+const formattedText_json_1 = __importDefault(require("./formattedText.json"));
+exports.v1 = formattedText_json_1.default;
+//# sourceMappingURL=formattedTextSchemas.js.map

package/lib/formatted-text/v1/formattedTextSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formattedTextSchemas.js","sourceRoot":"","sources":["../../../src/formatted-text/v1/formattedTextSchemas.ts"],"names":[],"mappings":";;;;;;AAAA,8EAAsC;AAE7B,aAFF,4BAAE,CAEE"}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+export * as MANIFEST_MODELS from './manifest/v1/manifestModels';
+export * as MANIFEST_SCHEMAS from './manifest/v1/manifestSchemas';
+export * as FORMATTED_TEXT_MODELS from './formatted-text/v1/formattedTextModels';
+export * as FORMATTED_TEXT_SCHEMAS from './formatted-text/v1/formattedTextSchemas';
+export * as SUB_SCHEMAS from './manifest/v1/subSchemas';
+export * from './JsonValidationService';
+export * from './errors/SchemaValidationError';

package/lib/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUB_SCHEMAS = exports.FORMATTED_TEXT_SCHEMAS = exports.FORMATTED_TEXT_MODELS = exports.MANIFEST_SCHEMAS = exports.MANIFEST_MODELS = void 0;
+exports.MANIFEST_MODELS = __importStar(require("./manifest/v1/manifestModels"));
+exports.MANIFEST_SCHEMAS = __importStar(require("./manifest/v1/manifestSchemas"));
+exports.FORMATTED_TEXT_MODELS = __importStar(require("./formatted-text/v1/formattedTextModels"));
+exports.FORMATTED_TEXT_SCHEMAS = __importStar(require("./formatted-text/v1/formattedTextSchemas"));
+exports.SUB_SCHEMAS = __importStar(require("./manifest/v1/subSchemas"));
+__exportStar(require("./JsonValidationService"), exports);
+__exportStar(require("./errors/SchemaValidationError"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gFAAgE;AAChE,kFAAkE;AAElE,iGAAiF;AACjF,mGAAmF;AAEnF,wEAAwD;AAExD,0DAAwC;AACxC,iEAA+C"}