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

package/lib/processValidationResult.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processValidationResult = void 0;
+const SchemaValidationError_1 = require("./errors/SchemaValidationError");
+function processValidationResult(errors) {
+    if (errors.length > 0) {
+        const ValidationDataMap = errors.reduce((acc, error) => {
+            var _a;
+            const pointer = (_a = error === null || error === void 0 ? void 0 : error.data) === null || _a === void 0 ? void 0 : _a.pointer;
+            const validationData = {
+                message: error.message,
+                data: error.data,
+            };
+            Object.keys(acc).includes(pointer) && Array.isArray(acc[pointer])
+                ? acc[pointer].push(validationData)
+                : (acc[pointer] = [validationData]);
+            return acc;
+        }, {});
+        throw new SchemaValidationError_1.SchemaValidationError(errors.map((a) => a.message).join(',\n'), undefined, ValidationDataMap);
+    }
+    return true;
+}
+exports.processValidationResult = processValidationResult;
+//# sourceMappingURL=processValidationResult.js.map

package/lib/processValidationResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processValidationResult.js","sourceRoot":"","sources":["../src/processValidationResult.ts"],"names":[],"mappings":";;;AACA,0EAA0G;AAE1G,SAAgB,uBAAuB,CAAC,MAAmB;IACzD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,iBAAiB,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,GAAsB,EAAE,KAAgB,EAAE,EAAE;;YACtG,MAAM,OAAO,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,0CAAE,OAAO,CAAC;YACrC,MAAM,cAAc,GAAmB;gBACrC,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI;aACjB,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC/D,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;gBACnC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,MAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;KACzG;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAhBD,0DAgBC"}

package/lib/validators/customKeywordValidators.d.ts

@@ -0,0 +1,2 @@
+import { Draft, JSONError, JSONSchema } from '@squiz/json-schema-library';
+export declare const customKeywordValidators: Record<string, (draft: Draft, schema: JSONSchema, value: unknown, pointer: string) => undefined | JSONError | JSONError[]>;

package/lib/validators/customKeywordValidators.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customKeywordValidators = void 0;
+exports.customKeywordValidators = {
+    'ui:metadata': (core, schema, value, pointer) => {
+        const fieldValue = value;
+        const uiMetadata = fieldValue['ui:metadata'];
+        if (uiMetadata === null || uiMetadata === void 0 ? void 0 : uiMetadata.quickOption) {
+            if (!fieldValue.enum) {
+                const error = {
+                    name: 'uiMetadataError',
+                    code: 'uiMetadata-error',
+                    type: 'error',
+                    message: `ui:metadata property quickOption is only valid for enum based properties.`,
+                    data: { expected: 'enum', pointer: pointer, received: typeof value, value: value },
+                };
+                return [error];
+            }
+        }
+        if (uiMetadata === null || uiMetadata === void 0 ? void 0 : uiMetadata.enumWidget) {
+            if (!fieldValue.enum) {
+                const error = {
+                    name: 'uiMetadataError',
+                    code: 'uiMetadata-error',
+                    type: 'error',
+                    message: `ui:metadata property enumWidget is only valid for enum based properties.`,
+                    data: { expected: 'enum', pointer: pointer, received: typeof value, value: value },
+                };
+                return [error];
+            }
+        }
+        if (uiMetadata === null || uiMetadata === void 0 ? void 0 : uiMetadata.collapsedByDefault) {
+            if (fieldValue.type !== 'object') {
+                const error = {
+                    name: 'uiMetadataError',
+                    code: 'uiMetadata-error',
+                    type: 'error',
+                    message: `ui:metadata property collapsedByDefault is only valid for object properties.`,
+                    data: { expected: 'object', pointer: pointer, received: typeof value, value: value },
+                };
+                return [error];
+            }
+        }
+        return undefined;
+    },
+};
+//# sourceMappingURL=customKeywordValidators.js.map

package/lib/validators/customKeywordValidators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customKeywordValidators.js","sourceRoot":"","sources":["../../src/validators/customKeywordValidators.ts"],"names":[],"mappings":";;;AAGa,QAAA,uBAAuB,GAGhC;IACF,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAA2B,EAAE;QACvE,MAAM,UAAU,GAAG,KAA6B,CAAC;QACjD,MAAM,UAAU,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;QAE7C,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,WAAW,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBACpB,MAAM,KAAK,GAAc;oBACvB,IAAI,EAAE,iBAAiB;oBACvB,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,2EAA2E;oBACpF,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;iBACnF,CAAC;gBACF,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;SACF;QAED,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,EAAE;YAC1B,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBACpB,MAAM,KAAK,GAAc;oBACvB,IAAI,EAAE,iBAAiB;oBACvB,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,0EAA0E;oBACnF,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;iBACnF,CAAC;gBACF,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;SACF;QAED,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,kBAAkB,EAAE;YAClC,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAChC,MAAM,KAAK,GAAc;oBACvB,IAAI,EAAE,iBAAiB;oBACvB,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,8EAA8E;oBACvF,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;iBACrF,CAAC;gBACF,OAAO,CAAC,KAAK,CAAC,CAAC;aAChB;SACF;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF,CAAC"}

package/lib/validators/customKeywordValidators.spec.d.ts

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

package/lib/validators/customKeywordValidators.spec.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const customKeywordValidators_1 = require("./customKeywordValidators");
+describe('customKeywordValidators', () => {
+    describe('ui:metadata', () => {
+        it('no ui:metadata is valid', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, {}, '#/functions/0/input/properties/users-contact');
+            expect(result).toBe(undefined);
+        });
+        it('no quickOption without enum is valid', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { 'ui:metadata': {} }, '#/functions/0/input/properties/users-contact');
+            expect(result).toBe(undefined);
+        });
+        it('quickOption is valid on enum', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { enum: ['north', 'south'], 'ui:metadata': { quickOption: true } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toBe(undefined);
+        });
+        it('quickOption:false is valid without enum', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { 'ui:metadata': { quickOption: false } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toBe(undefined);
+        });
+        it('quickOption:false is valid with enum', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { enum: ['north', 'south'], 'ui:metadata': { quickOption: false } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toBe(undefined);
+        });
+        it('quickOption:true is not valid without enum', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { 'ui:metadata': { quickOption: true } }, '#/functions/0/input/properties/users-contact');
+            const error = Array.isArray(result) ? result[0] : result;
+            expect(result).not.toEqual(undefined);
+            expect(error).toEqual(expect.objectContaining({
+                name: 'uiMetadataError',
+                code: 'uiMetadata-error',
+                type: 'error',
+            }));
+        });
+        it('quickOption:true is valid with empty enum', () => {
+            // Enums being empty is a separate JSON schema rule / validation issue
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { enum: [], 'ui:metadata': { quickOption: true } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toEqual(undefined);
+        });
+        it.each(['radio', 'dropdown'])('enumWidget:%s is valid with enum', (enumWidget) => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { enum: [], 'ui:metadata': { enumWidget } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toEqual(undefined);
+        });
+        it('enumWidget is invalid without enum', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { 'ui:metadata': { enumWidget: 'radio' } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toContainEqual(expect.objectContaining({
+                name: 'uiMetadataError',
+                code: 'uiMetadata-error',
+                type: 'error',
+            }));
+        });
+        it('collapsedByDefault is valid with object property', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { type: 'object', 'ui:metadata': { collapsedByDefault: true } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toEqual(undefined);
+        });
+        it('collapsedByDefault is invalid for non-object properties', () => {
+            const result = customKeywordValidators_1.customKeywordValidators['ui:metadata'](
+            // eslint-disable-next-line
+            // @ts-ignore - the null properties aren't used in this keyword validation
+            null, null, { type: 'string', 'ui:metadata': { collapsedByDefault: true } }, '#/functions/0/input/properties/users-contact');
+            expect(result).toContainEqual(expect.objectContaining({
+                name: 'uiMetadataError',
+                code: 'uiMetadata-error',
+                type: 'error',
+            }));
+        });
+    });
+});
+//# sourceMappingURL=customKeywordValidators.spec.js.map

package/lib/validators/customKeywordValidators.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customKeywordValidators.spec.js","sourceRoot":"","sources":["../../src/validators/customKeywordValidators.spec.ts"],"names":[],"mappings":";;AAAA,uEAAoE;AAEpE,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,EACF,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,aAAa,EAAE,EAAE,EAAE,EACrB,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAClE,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EACzC,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EACnE,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EACxC,8CAA8C,CAC/C,CAAC;YAEF,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAEzD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CACnB,MAAM,CAAC,gBAAgB,CAAC;gBACtB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,OAAO;aACd,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,sEAAsE;YAEtE,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAClD,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,kCAAkC,EAAE,CAAC,UAAU,EAAE,EAAE;YAChF,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,UAAU,EAAE,EAAE,EAC3C,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,aAAa,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAC1C,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAC3B,MAAM,CAAC,gBAAgB,CAAC;gBACtB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,OAAO;aACd,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,EAC/D,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,MAAM,GAAG,iDAAuB,CAAC,aAAa,CAAC;YACnD,2BAA2B;YAC3B,0EAA0E;YAC1E,IAAI,EACJ,IAAI,EACJ,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,EAAE,EAC/D,8CAA8C,CAC/C,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAC3B,MAAM,CAAC,gBAAgB,CAAC;gBACtB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,kBAAkB;gBACxB,IAAI,EAAE,OAAO;aACd,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.79.0",
+  "version": "1.80.0",
   "description": "",
   "main": "lib/index.js",
   "private": false,