@squiz/dx-json-schema-lib 1.79.0 → 1.80.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.80.0
+
+### Minor Changes
+
+- 63fecb7: Add enumWidget ui:metadata configuration
+
 ## 1.79.0
 
 ### Minor Changes

package/jest.config.ts

@@ -1,14 +1,25 @@
 import type { Config } from 'jest';
 
 import { config as configFunc } from 'dotenv';
+import { defaultConfig } from '../../jest.config';
 configFunc();
 
 // Sync object
 const config: Config = {
-  preset: 'ts-jest',
+  ...defaultConfig,
   testTimeout: 60_000,
   testEnvironment: 'node',
-
+  clearMocks: false,
+  resetMocks: false,
+  resetModules: false,
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 90,
+      lines: 90,
+      statements: 90,
+    },
+  },
   testPathIgnorePatterns: [
     '<rootDir>/lib/',
     '<rootDir>/cdk.out/',

package/lib/JsonSchemaService.d.ts

@@ -0,0 +1,34 @@
+import { Input } from '@sagold/json-query';
+import { JSONSchema, Draft } from '@squiz/json-schema-library';
+import { AnyPrimitiveType, AnyResolvableType, TypeResolver } from './jsonTypeResolution/TypeResolver';
+export declare const ComponentInputMetaSchema: MetaSchemaInput;
+export declare const RenderInputMetaSchema: MetaSchemaInput;
+export declare const ManifestV1MetaSchema: MetaSchemaInput;
+export declare const JobV1MetaSchema: MetaSchemaInput;
+interface MetaSchemaInput {
+    root: JSONSchema;
+    remotes?: Record<string, JSONSchema>;
+}
+/**
+ * A service that can be used to validate and resolve JSON against a schema.
+ */
+export declare class JSONSchemaService<P extends AnyPrimitiveType, R extends AnyResolvableType> {
+    private typeResolver;
+    schema: Draft;
+    constructor(typeResolver: TypeResolver<P, R>, metaSchema: MetaSchemaInput);
+    private doResolveRef;
+    /**
+     * Validate an input value against a specified schema
+     * @throws {SchemaValidationError} if the input is invalid
+     * @returns true if the input is valid
+     */
+    validateInput(input: unknown, inputSchema?: JSONSchema): true | never;
+    /**
+     * Resolve an input object by replacing all resolvable shapes with their resolved values
+     * @param input any input object which matches the input schema
+     * @param inputSchema a JSONSchema which provides type information about the input object
+     * @returns the input object with all resolvable shapes resolved
+     */
+    resolveInput(input: Input, inputSchema: JSONSchema): Promise<Input>;
+}
+export {};

package/lib/JsonSchemaService.js

@@ -0,0 +1,140 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONSchemaService = exports.JobV1MetaSchema = exports.ManifestV1MetaSchema = exports.RenderInputMetaSchema = exports.ComponentInputMetaSchema = void 0;
+const json_query_1 = __importDefault(require("@sagold/json-query"));
+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 MatrixAssetSchema_json_1 = __importDefault(require("./manifest/v1/MatrixAssetSchema.json"));
+const Draft_07_json_1 = __importDefault(require("./manifest/v1/Draft-07.json"));
+const JobV1_json_1 = __importDefault(require("./manifest/v1/JobV1.json"));
+const v1_json_1 = __importDefault(require("./manifest/v1/v1.json"));
+const json_schema_library_1 = require("@squiz/json-schema-library");
+const json_schema_library_2 = require("@squiz/json-schema-library");
+const JsonResolutionError_1 = require("./errors/JsonResolutionError");
+const processValidationResult_1 = require("./processValidationResult");
+const _1 = require(".");
+exports.ComponentInputMetaSchema = {
+    root: DxComponentInputSchema_json_1.default,
+    remotes: {
+        'DxComponentInputSchema.json/DxContentMetaSchema.json': DxContentMetaSchema_json_1.default,
+    },
+};
+exports.RenderInputMetaSchema = {
+    root: Draft_07_json_1.default,
+};
+exports.ManifestV1MetaSchema = {
+    root: v1_json_1.default,
+    remotes: {
+        'DxComponentInputSchema.json/DxContentMetaSchema.json': DxContentMetaSchema_json_1.default,
+        '/DxComponentInputSchema.json': DxComponentInputSchema_json_1.default,
+        '/DxComponentIcons.json': DxComponentIcons_json_1.default,
+        '/MatrixAssetSchema.json': MatrixAssetSchema_json_1.default,
+        'http://json-schema.org/draft-07/schema': Draft_07_json_1.default,
+        'http://json-schema.org/draft-07/schema#': Draft_07_json_1.default,
+    },
+};
+exports.JobV1MetaSchema = {
+    root: JobV1_json_1.default,
+    remotes: {
+        'DxComponentInputSchema.json/DxContentMetaSchema.json': DxContentMetaSchema_json_1.default,
+        '/DxComponentInputSchema.json': DxComponentInputSchema_json_1.default,
+        'http://json-schema.org/draft-07/schema': Draft_07_json_1.default,
+        'http://json-schema.org/draft-07/schema#': Draft_07_json_1.default,
+    },
+};
+/**
+ * A service that can be used to validate and resolve JSON against a schema.
+ */
+class JSONSchemaService {
+    constructor(typeResolver, metaSchema) {
+        this.typeResolver = typeResolver;
+        this.schema = new json_schema_library_1.Draft({
+            ..._1.defaultConfig,
+            resolveRef: (schema, rootSchema) => this.doResolveRef(schema, rootSchema),
+            validate: (core, data, schema, pointer) => _1.defaultConfig.validate(core, data, schema, pointer),
+            resolveOneOf: (core, data, schema, pointer) => _1.defaultConfig.resolveOneOf(core, data, schema, pointer),
+        }, metaSchema.root);
+        for (const [key, value] of Object.entries(metaSchema.remotes || {})) {
+            this.schema.addRemoteSchema(key, value);
+        }
+        for (const schema of this.typeResolver.validationSchemaDefinitions) {
+            // Please find a better way of doing this.
+            this.schema.addRemoteSchema(`/${schema.title}.json`, schema);
+            this.schema.addRemoteSchema(`#/${schema.title}.json`, schema);
+        }
+    }
+    doResolveRef(schema, rootSchema) {
+        const initialRef = json_schema_library_2.draft07Config.resolveRef(schema, rootSchema);
+        if (!initialRef)
+            return initialRef;
+        if (!this.typeResolver.isPrimitiveType(initialRef.type))
+            return initialRef;
+        const validationSchemas = this.typeResolver.getValidationSchemaForPrimitive(initialRef.type);
+        // All validation schemas are pre-compiled as remote schemas and are referenced below
+        const fullValidationSchema = {
+            oneOf: validationSchemas.map((schema) => ({ $ref: `${schema.title}.json` })),
+        };
+        return this.schema.compileSchema(fullValidationSchema);
+    }
+    /**
+     * Validate an input value against a specified schema
+     * @throws {SchemaValidationError} if the input is invalid
+     * @returns true if the input is valid
+     */
+    validateInput(input, inputSchema = this.schema.rootSchema) {
+        inputSchema = this.schema.compileSchema(inputSchema);
+        const errors = this.schema.validate(input, inputSchema);
+        return (0, processValidationResult_1.processValidationResult)(errors);
+    }
+    /**
+     * Resolve an input object by replacing all resolvable shapes with their resolved values
+     * @param input any input object which matches the input schema
+     * @param inputSchema a JSONSchema which provides type information about the input object
+     * @returns the input object with all resolvable shapes resolved
+     */
+    async resolveInput(input, inputSchema) {
+        const setters = [];
+        this.schema.each(input, async (schema, value, pointer) => {
+            // Bug in library for Array item schemas which won't resolve the oneOf schema
+            if (Array.isArray(schema === null || schema === void 0 ? void 0 : schema.oneOf)) {
+                const oldSchema = schema;
+                schema = this.schema.resolveOneOf(value, schema);
+                schema.oneOfSchema = oldSchema;
+            }
+            if (!this.typeResolver.isResolvableSchema(schema))
+                return;
+            // If its a resolvable schema, it should exist in a oneOf array with other schemas
+            // Including a primitive schema
+            const allPossibleSchemaTitles = schema.oneOfSchema.oneOf.map((o) => o.$ref.replace('.json', ''));
+            const primitiveSchema = allPossibleSchemaTitles.find((title) => this.typeResolver.isPrimitiveType(title));
+            if (!primitiveSchema)
+                return;
+            const resolver = this.typeResolver.tryGetResolver(primitiveSchema, schema);
+            if (!resolver)
+                return;
+            const setResolvedData = Promise.resolve()
+                .then(() => resolver(value))
+                .then((resolvedData) => (item) => json_query_1.default.set(item, pointer, resolvedData, 'replace'))
+                .catch((e) => Promise.reject(new JsonResolutionError_1.JsonResolutionError(e, pointer, value)));
+            setters.push(setResolvedData);
+        }, inputSchema);
+        const potentialResolutionErrors = [];
+        for (const resolveResult of await Promise.allSettled(setters)) {
+            if (resolveResult.status === 'rejected') {
+                potentialResolutionErrors.push(resolveResult.reason);
+                continue;
+            }
+            input = resolveResult.value(input);
+        }
+        if (potentialResolutionErrors.length) {
+            throw new Error(`Error(s) occurred when resolving JSON:\n${potentialResolutionErrors.join('\n')}`);
+        }
+        return input;
+    }
+}
+exports.JSONSchemaService = JSONSchemaService;
+//# sourceMappingURL=JsonSchemaService.js.map

package/lib/JsonSchemaService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonSchemaService.js","sourceRoot":"","sources":["../src/JsonSchemaService.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAsD;AAEtD,4GAA+E;AAC/E,gGAAmE;AACnE,sGAAyE;AACzE,kGAAqE;AAErE,gFAAwD;AAExD,0EAA6C;AAC7C,oEAAuC;AACvC,oEAA+D;AAE/D,oEAA2D;AAE3D,sEAAmE;AACnE,uEAAoE;AACpE,wBAAkC;AAErB,QAAA,wBAAwB,GAAoB;IACvD,IAAI,EAAE,qCAAsB;IAC5B,OAAO,EAAE;QACP,sDAAsD,EAAE,kCAAmB;KAC5E;CACF,CAAC;AAEW,QAAA,qBAAqB,GAAoB;IACpD,IAAI,EAAE,uBAAa;CACpB,CAAC;AAEW,QAAA,oBAAoB,GAAoB;IACnD,IAAI,EAAE,iBAAE;IACR,OAAO,EAAE;QACP,sDAAsD,EAAE,kCAAmB;QAC3E,8BAA8B,EAAE,qCAAsB;QACtD,wBAAwB,EAAE,+BAAgB;QAC1C,yBAAyB,EAAE,gCAAiB;QAC5C,wCAAwC,EAAE,uBAAa;QACvD,yCAAyC,EAAE,uBAAa;KACzD;CACF,CAAC;AAEW,QAAA,eAAe,GAAoB;IAC9C,IAAI,EAAE,oBAAK;IACX,OAAO,EAAE;QACP,sDAAsD,EAAE,kCAAmB;QAC3E,8BAA8B,EAAE,qCAAsB;QACtD,wCAAwC,EAAE,uBAAa;QACvD,yCAAyC,EAAE,uBAAa;KACzD;CACF,CAAC;AAMF;;GAEG;AACH,MAAa,iBAAiB;IAE5B,YAAoB,YAAgC,EAAE,UAA2B;QAA7D,iBAAY,GAAZ,YAAY,CAAoB;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,2BAAK,CACrB;YACE,GAAG,gBAAa;YAChB,UAAU,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;YACzE,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,gBAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC;YAC9F,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,gBAAa,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC;SACvG,EACD,UAAU,CAAC,IAAI,CAChB,CAAC;QAEF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE;YACnE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACzC;QAED,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,CAAC,2BAA2B,EAAE;YAClE,0CAA0C;YAC1C,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,MAAM,CAAC,KAAK,OAAO,EAAE,MAAoB,CAAC,CAAC;YAC3E,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,MAAM,CAAC,KAAK,OAAO,EAAE,MAAoB,CAAC,CAAC;SAC7E;IACH,CAAC;IAEO,YAAY,CAAC,MAAkB,EAAE,UAAsB;QAC7D,MAAM,UAAU,GAAG,mCAAa,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAChE,IAAI,CAAC,UAAU;YAAE,OAAO,UAAU,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,UAAU,CAAC;QAE3E,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,+BAA+B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7F,qFAAqF;QACrF,MAAM,oBAAoB,GAAG;YAC3B,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;SAC7E,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAc,EAAE,cAA0B,IAAI,CAAC,MAAM,CAAC,UAAU;QACnF,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACxD,OAAO,IAAA,iDAAuB,EAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,KAAY,EAAE,WAAuB;QAC7D,MAAM,OAAO,GAA4C,EAAE,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,KAAK,EACL,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC/B,6EAA6E;YAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,EAAE;gBAChC,MAAM,SAAS,GAAG,MAAM,CAAC;gBACzB,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACjD,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;aAChC;YACD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,MAAM,CAAC;gBAAE,OAAO;YAC1D,kFAAkF;YAClF,+BAA+B;YAC/B,MAAM,uBAAuB,GAAkB,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAa,EAAE,EAAE,CAC5F,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAC5B,CAAC;YAEF,MAAM,eAAe,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1G,IAAI,CAAC,eAAe;gBAAE,OAAO;YAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,eAAe,EAAE,MAAa,CAAC,CAAC;YAClF,IAAI,CAAC,QAAQ;gBAAE,OAAO;YACtB,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE;iBACtC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBAC3B,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,IAAkB,EAAE,EAAE,CAAC,oBAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,SAAgB,CAAC,CAAC;iBAC5G,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,yCAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YAC5E,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChC,CAAC,EACD,WAAW,CACZ,CAAC;QAEF,MAAM,yBAAyB,GAAG,EAAE,CAAC;QACrC,KAAK,MAAM,aAAa,IAAI,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC7D,IAAI,aAAa,CAAC,MAAM,KAAK,UAAU,EAAE;gBACvC,yBAAyB,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,SAAS;aACV;YAED,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACpC;QACD,IAAI,yBAAyB,CAAC,MAAM,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,2CAA2C,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACpG;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAnGD,8CAmGC"}

package/lib/JsonSchemaService.spec.d.ts

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