@squiz/dx-json-schema-lib 1.85.1 → 1.85.2

package/lib/manifest/userApi/v1/userApiManifestValidation.js

@@ -0,0 +1,88 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_API_FULL_MANIFEST_SCHEMA = exports.USER_API_MANIFEST_SCHEMA_URL = void 0;
+exports.validateUserApiFullManifest = validateUserApiFullManifest;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const Draft_07_json_1 = __importDefault(require("../../v1/Draft-07.json"));
+const UserApiManifestV1_json_1 = __importDefault(require("./UserApiManifestV1.json"));
+const JsonSchemaService_1 = require("../../../JsonSchemaService");
+const TypeResolverBuilder_1 = require("../../../jsonTypeResolution/TypeResolverBuilder");
+const pkgVersion = (() => {
+    try {
+        const pkgPath = path.join(__dirname, '..', '..', '..', '..', 'package.json');
+        const raw = fs.readFileSync(pkgPath, 'utf8');
+        return JSON.parse(raw).version;
+    }
+    catch {
+        return undefined;
+    }
+})();
+const draft07Remotes = {
+    'http://json-schema.org/draft-07/schema': Draft_07_json_1.default,
+    'http://json-schema.org/draft-07/schema#': Draft_07_json_1.default,
+};
+const fullManifestMetaSchema = {
+    root: UserApiManifestV1_json_1.default,
+    remotes: draft07Remotes,
+};
+const resolver = TypeResolverBuilder_1.TypeResolverBuilder.new().build();
+const fullManifestValidator = new JsonSchemaService_1.JSONSchemaService(resolver, fullManifestMetaSchema);
+/**
+ * Recommended `$schema` URL for the top-level DXP User API `manifest.json`.
+ *
+ * Published at {@link USER_API_FULL_MANIFEST_SCHEMA} under `lib/manifest/userApiManifest/UserApiManifestV1.json`.
+ */
+exports.USER_API_MANIFEST_SCHEMA_URL = typeof pkgVersion === 'string'
+    ? `https://unpkg.com/@squiz/dx-json-schema-lib@${pkgVersion}/lib/manifest/userApiManifest/UserApiManifestV1.json`
+    : 'https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json';
+/**
+ * JSON Schema bundle validating the full on-disk manifest (CLI / zip upload).
+ */
+var UserApiManifestV1_json_2 = require("./UserApiManifestV1.json");
+Object.defineProperty(exports, "USER_API_FULL_MANIFEST_SCHEMA", { enumerable: true, get: function () { return __importDefault(UserApiManifestV1_json_2).default; } });
+/**
+ * Validate the User API manifest before upload.
+ *
+ * @throws {SchemaValidationError} when validation fails.
+ */
+function validateUserApiFullManifest(input) {
+    return fullManifestValidator.validateInput(input);
+}
+//# sourceMappingURL=userApiManifestValidation.js.map

package/lib/manifest/userApi/v1/userApiManifestValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userApiManifestValidation.js","sourceRoot":"","sources":["../../../../src/manifest/userApi/v1/userApiManifestValidation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmDA,kEAEC;AArDD,uCAAyB;AACzB,2CAA6B;AAC7B,2EAAmD;AACnD,sFAAyD;AACzD,kEAA+D;AAC/D,yFAAsF;AAEtF,MAAM,UAAU,GAAG,CAAC,GAAuB,EAAE;IAC3C,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,OAAQ,IAAI,CAAC,KAAK,CAAC,GAAG,CAA0B,CAAC,OAAO,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC,EAAE,CAAC;AAEL,MAAM,cAAc,GAAG;IACrB,wCAAwC,EAAE,uBAAa;IACvD,yCAAyC,EAAE,uBAAa;CAChD,CAAC;AAEX,MAAM,sBAAsB,GAAG;IAC7B,IAAI,EAAE,gCAAiB;IACvB,OAAO,EAAE,cAAc;CACf,CAAC;AAEX,MAAM,QAAQ,GAAG,yCAAmB,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;AAEnD,MAAM,qBAAqB,GAAG,IAAI,qCAAiB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;AAEtF;;;;GAIG;AACU,QAAA,4BAA4B,GACvC,OAAO,UAAU,KAAK,QAAQ;IAC5B,CAAC,CAAC,+CAA+C,UAAU,sDAAsD;IACjH,CAAC,CAAC,wGAAwG,CAAC;AAE/G;;GAEG;AACH,mEAAoF;AAA3E,wJAAA,OAAO,OAAiC;AAEjD;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,KAAc;IACxD,OAAO,qBAAqB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC"}

package/lib/manifest/userApi/v1/userApiManifestValidation.spec.d.ts

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

package/lib/manifest/userApi/v1/userApiManifestValidation.spec.js

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const userApiManifestValidation_1 = require("./userApiManifestValidation");
+const SchemaValidationError_1 = require("../../../errors/SchemaValidationError");
+describe('user API manifest validation', () => {
+    const validResolved = {
+        endpoints: [{ path: '/hello', method: 'GET', handler: 'index.hello' }],
+    };
+    const validFull = {
+        $schema: userApiManifestValidation_1.USER_API_MANIFEST_SCHEMA_URL,
+        name: 'api',
+        displayName: 'API',
+        description: '',
+        filesDir: 'src',
+        entry: 'index.ts',
+        manifest: validResolved,
+    };
+    /** Resolves `#/definitions/resolvedApiManifest` via the full-manifest root schema only. */
+    const wrapResolved = (manifestNested) => ({
+        ...validFull,
+        manifest: manifestNested,
+    });
+    const endpoint = (overrides = {}) => ({
+        path: '/r',
+        method: 'GET',
+        handler: 'handler',
+        ...overrides,
+    });
+    const expectResolvedNestedThrows = (manifestNested) => {
+        expect(() => (0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved(manifestNested))).toThrow(SchemaValidationError_1.SchemaValidationError);
+    };
+    const expectFullThrows = (input) => {
+        expect(() => (0, userApiManifestValidation_1.validateUserApiFullManifest)(input)).toThrow(SchemaValidationError_1.SchemaValidationError);
+    };
+    it('surfaces bundled full manifest schema for CDN / tooling', () => {
+        expect(userApiManifestValidation_1.USER_API_FULL_MANIFEST_SCHEMA.type).toBe('object');
+        expect(typeof userApiManifestValidation_1.USER_API_MANIFEST_SCHEMA_URL).toBe('string');
+        expect(userApiManifestValidation_1.USER_API_MANIFEST_SCHEMA_URL).toContain('dx-json-schema-lib');
+        expect(userApiManifestValidation_1.USER_API_MANIFEST_SCHEMA_URL).toContain('manifest/userApiManifest');
+    });
+    describe('nested resolvedApiManifest rules (validated only through validateUserApiFullManifest)', () => {
+        it('accepts canonical resolved manifest when nested under manifest', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved(validResolved))).toBe(true);
+        });
+        it.each(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD'])('accepts HTTP method %s', (method) => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({
+                endpoints: [endpoint({ path: `/m-${method}`, method })],
+            }))).toBe(true);
+        });
+        it('accepts multiple endpoints without extra endpoint fields', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({
+                endpoints: [
+                    { path: '/a', method: 'GET', handler: 'a' },
+                    { path: '/b', method: 'POST', handler: 'mod.b' },
+                ],
+            }))).toBe(true);
+        });
+        it('rejects handlerMap on nested manifest (endpoints only)', () => {
+            expectResolvedNestedThrows({
+                endpoints: [endpoint()],
+                handlerMap: { 'index.hello': './handlers/hello.ts' },
+            });
+        });
+        it('accepts handlers using $ and nested module paths', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({
+                endpoints: [
+                    endpoint({ handler: '$default' }),
+                    endpoint({ handler: 'ns.deep_export' }),
+                    endpoint({ handler: '_private' }),
+                ],
+            }))).toBe(true);
+        });
+        it('accepts path with only slash', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({ endpoints: [endpoint({ path: '/' })] }))).toBe(true);
+        });
+        it('accepts api-builder prototype document (alternate $schema, endpoints-only nested manifest)', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)({
+                $schema: 'https://raw.githubusercontent.com/user/api-builder-prototype/main/schemas/api-builder.schema.json',
+                name: 'test-api',
+                displayName: 'Test Api',
+                description: 'An API to test the proxy endpoint',
+                entry: 'index.ts',
+                filesDir: 'src',
+                manifest: {
+                    endpoints: [
+                        { path: '/hello/*', method: 'GET', handler: 'hello' },
+                        { path: '/add', method: 'GET', handler: 'add' },
+                        { path: '/user/:id/:type', method: 'GET', handler: 'user' },
+                        { path: '/proxy', method: 'GET', handler: 'proxy' },
+                        { path: '/health', method: 'GET', handler: 'health' },
+                    ],
+                },
+            })).toBe(true);
+        });
+        it('rejects empty endpoints array', () => {
+            expectResolvedNestedThrows({ endpoints: [] });
+            expectFullThrows({
+                ...validFull,
+                manifest: { endpoints: [] },
+            });
+        });
+        it('accepts nested manifest with only endpoints (no nested name)', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({
+                endpoints: [endpoint()],
+            }))).toBe(true);
+        });
+        it('rejects nested manifest name property (nested root allows only endpoints)', () => {
+            expectResolvedNestedThrows({ name: 'nested-id', endpoints: [endpoint()] });
+            expectResolvedNestedThrows({ name: '', endpoints: [endpoint()] });
+        });
+        it('rejects missing endpoints on nested manifest', () => {
+            expectResolvedNestedThrows({ name: 'only-name' });
+        });
+        it('rejects non-array endpoints on nested manifest', () => {
+            expectResolvedNestedThrows({ endpoints: {} });
+        });
+        it('rejects nested manifest root additionalProperties', () => {
+            expectResolvedNestedThrows({ ...validResolved, extraKey: true });
+        });
+        it('rejects extra properties on an endpoint object', () => {
+            expectResolvedNestedThrows({
+                endpoints: [{ ...endpoint(), unknownFlag: true }],
+            });
+        });
+        it.each(['path', 'method', 'handler'])('rejects endpoint missing required field %s', (field) => {
+            const ep = endpoint();
+            const partial = Object.fromEntries(Object.entries(ep).filter(([k]) => k !== field));
+            expectResolvedNestedThrows({
+                endpoints: [partial],
+            });
+        });
+        it('accepts minimal endpoint objects (only path/method/handler)', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(wrapResolved({
+                endpoints: [{ path: '/x', method: 'GET', handler: 'h' }],
+            }))).toBe(true);
+        });
+        it('rejects paths without a leading slash', () => {
+            expectResolvedNestedThrows({
+                endpoints: [endpoint({ path: 'no-leading-slash' })],
+            });
+        });
+        it('rejects invalid HTTP methods', () => {
+            expectResolvedNestedThrows({
+                endpoints: [endpoint({ method: 'TRACE' })],
+            });
+            expectResolvedNestedThrows({
+                endpoints: [endpoint({ method: 'get' })],
+            });
+        });
+        it.each([
+            { handler: '', reason: 'empty handler' },
+            { handler: '9start', reason: 'leading digit' },
+            { handler: 'bad-handler', reason: 'hyphen' },
+            { handler: 'a b', reason: 'space' },
+            { handler: '😀', reason: 'non-ASCII' },
+        ])('rejects invalid handler ($reason)', ({ handler }) => {
+            expectResolvedNestedThrows({
+                endpoints: [endpoint({ handler })],
+            });
+        });
+        it('rejects invalid nested manifest object shapes', () => {
+            expectFullThrows(wrapResolved({}));
+            expectFullThrows({
+                ...validFull,
+                manifest: [],
+            });
+            expectFullThrows({
+                ...validFull,
+                manifest: 'nested',
+            });
+        });
+    });
+    describe('validateUserApiFullManifest (root document)', () => {
+        it('accepts canonical full manifest', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(validFull)).toBe(true);
+        });
+        it('accepts omission of optional description', () => {
+            const { description: _d, ...noDesc } = validFull;
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)(noDesc)).toBe(true);
+        });
+        it('accepts endpoints-only nested manifest when root declares name', () => {
+            expect((0, userApiManifestValidation_1.validateUserApiFullManifest)({
+                ...validFull,
+                name: 'root-name',
+                manifest: {
+                    endpoints: [{ path: '/e', method: 'GET', handler: 'eh' }],
+                },
+            })).toBe(true);
+        });
+        it('rejects missing root $schema', () => {
+            const { $schema: _drop, ...withoutSchema } = validFull;
+            expectFullThrows(withoutSchema);
+        });
+        it('rejects empty $schema string', () => {
+            expectFullThrows({ ...validFull, $schema: '' });
+        });
+        it.each([['name'], ['displayName'], ['filesDir'], ['entry'], ['manifest']])('rejects full manifest missing required field %s', (field) => {
+            const { [field]: _removed, ...rest } = validFull;
+            expectFullThrows(rest);
+        });
+        it.each([
+            ['name', ''],
+            ['displayName', ''],
+            ['filesDir', ''],
+            ['entry', ''],
+        ])('rejects empty string for %s (minLength 1)', (field, value) => {
+            expectFullThrows({
+                ...validFull,
+                [field]: value,
+            });
+        });
+        it('rejects root additionalProperties on full manifest', () => {
+            expectFullThrows({ ...validFull, version: '1' });
+        });
+        it('rejects nested manifest validation failures (delegates to resolved definition)', () => {
+            expectFullThrows({
+                ...validFull,
+                manifest: {
+                    endpoints: [endpoint(), endpoint({ handler: '$default', path: '/other' })],
+                    badRootKey: true,
+                },
+            });
+            expectFullThrows({
+                ...validFull,
+                manifest: { endpoints: [] },
+            });
+        });
+        it('rejects primitives instead of manifest object root', () => {
+            expectFullThrows(null);
+            expectFullThrows(undefined);
+            expectFullThrows([]);
+            expectFullThrows('manifest');
+            expectFullThrows({});
+        });
+    });
+});
+//# sourceMappingURL=userApiManifestValidation.spec.js.map

package/lib/manifest/userApi/v1/userApiManifestValidation.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userApiManifestValidation.spec.js","sourceRoot":"","sources":["../../../../src/manifest/userApi/v1/userApiManifestValidation.spec.ts"],"names":[],"mappings":";;AAAA,2EAIqC;AACrC,iFAA8E;AAE9E,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,MAAM,aAAa,GAAG;QACpB,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;KACvE,CAAC;IAEF,MAAM,SAAS,GAAG;QAChB,OAAO,EAAE,wDAA4B;QACrC,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,aAAa;KACxB,CAAC;IAEF,2FAA2F;IAC3F,MAAM,YAAY,GAAG,CAAC,cAAuC,EAAE,EAAE,CAAC,CAAC;QACjE,GAAG,SAAS;QACZ,QAAQ,EAAE,cAAc;KACzB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,CACf,YAIK,EAAE,EACP,EAAE,CAAC,CAAC;QACJ,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,SAAS;QAClB,GAAG,SAAS;KACb,CAAC,CAAC;IAEH,MAAM,0BAA0B,GAAG,CAAC,cAAuC,EAAE,EAAE;QAC7E,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,uDAA2B,EAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;IACzG,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,EAAE;QAC1C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,uDAA2B,EAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,6CAAqB,CAAC,CAAC;IAClF,CAAC,CAAC;IAEF,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,CAAC,yDAA6B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,CAAC,OAAO,wDAA4B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,wDAA4B,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACrE,MAAM,CAAC,wDAA4B,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uFAAuF,EAAE,GAAG,EAAE;QACrG,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,CAAC,IAAA,uDAA2B,EAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC,CAC5E,wBAAwB,EACxB,CAAC,MAAM,EAAE,EAAE;YACT,MAAM,CACJ,IAAA,uDAA2B,EACzB,YAAY,CAAC;gBACX,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;aACxD,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CACF,CAAC;QAEF,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,CACJ,IAAA,uDAA2B,EACzB,YAAY,CAAC;gBACX,SAAS,EAAE;oBACT,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE;oBAC3C,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE;iBACjD;aACF,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC;gBACvB,UAAU,EAAE,EAAE,aAAa,EAAE,qBAAqB,EAAE;aACrD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,CACJ,IAAA,uDAA2B,EACzB,YAAY,CAAC;gBACX,SAAS,EAAE;oBACT,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;oBACjC,QAAQ,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;oBACvC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;iBAClC;aACF,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,CAAC,IAAA,uDAA2B,EAAC,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4FAA4F,EAAE,GAAG,EAAE;YACpG,MAAM,CACJ,IAAA,uDAA2B,EAAC;gBAC1B,OAAO,EAAE,mGAAmG;gBAC5G,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,UAAU;gBACvB,WAAW,EAAE,mCAAmC;gBAChD,KAAK,EAAE,UAAU;gBACjB,QAAQ,EAAE,KAAK;gBACf,QAAQ,EAAE;oBACR,SAAS,EAAE;wBACT,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;wBACrD,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE;wBAC/C,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE;wBAC3D,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;wBACnD,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE;qBACtD;iBACF;aACF,CAAC,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,0BAA0B,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9C,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;aAC5B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,CACJ,IAAA,uDAA2B,EACzB,YAAY,CAAC;gBACX,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC;aACxB,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;YACnF,0BAA0B,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;YAC3E,0BAA0B,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,0BAA0B,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,0BAA0B,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,0BAA0B,CAAC,EAAE,GAAG,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,EAAE,GAAG,QAAQ,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;aAClD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC,CAAC,4CAA4C,EAAE,CAAC,KAAK,EAAE,EAAE;YACtG,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAA4B,CAAC;YAC/G,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,OAAO,CAAC;aACrB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,CACJ,IAAA,uDAA2B,EACzB,YAAY,CAAC;gBACX,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;aACzD,CAAC,CACH,CACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;aACpD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;aAC3C,CAAC,CAAC;YACH,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;aACzC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC;YACN,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE;YACxC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE;YAC9C,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE;YAC5C,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;YACnC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE;SACvC,CAAC,CAAC,mCAAmC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACtD,0BAA0B,CAAC;gBACzB,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;aACnC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,gBAAgB,CAAC,YAAY,CAAC,EAA6B,CAAC,CAAC,CAAC;YAC9D,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,QAAQ,EAAE,EAAa;aACxB,CAAC,CAAC;YACH,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,QAAQ,EAAE,QAAmB;aAC9B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6CAA6C,EAAE,GAAG,EAAE;QAC3D,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,CAAC,IAAA,uDAA2B,EAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;YACjD,MAAM,CAAC,IAAA,uDAA2B,EAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,CACJ,IAAA,uDAA2B,EAAC;gBAC1B,GAAG,SAAS;gBACZ,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE;oBACR,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;iBAC1D;aACF,CAAC,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,aAAa,EAAE,GAAG,SAAS,CAAC;YACvD,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,gBAAgB,CAAC,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,CAAU,CAAC,CAClF,iDAAiD,EACjD,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,SAAoC,CAAC;YAC5E,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CACF,CAAC;QAEF,EAAE,CAAC,IAAI,CAAC;YACN,CAAC,MAAM,EAAE,EAAE,CAAC;YACZ,CAAC,aAAa,EAAE,EAAE,CAAC;YACnB,CAAC,UAAU,EAAE,EAAE,CAAC;YAChB,CAAC,OAAO,EAAE,EAAE,CAAC;SACL,CAAC,CAAC,2CAA2C,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACxE,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,CAAC,KAAK,CAAC,EAAE,KAAK;aACf,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,gBAAgB,CAAC,EAAE,GAAG,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;YACxF,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,QAAQ,EAAE;oBACR,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;oBAC1E,UAAU,EAAE,IAAI;iBACjB;aACF,CAAC,CAAC;YACH,gBAAgB,CAAC;gBACf,GAAG,SAAS;gBACZ,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;aAC5B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACvB,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAC5B,gBAAgB,CAAC,EAAE,CAAC,CAAC;YACrB,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC7B,gBAAgB,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "@squiz/dx-json-schema-lib",
-  "version": "1.85.1",
+  "version": "1.85.2",
   "description": "",
   "main": "lib/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./lib/*": "./lib/*",
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -11,6 +20,7 @@
     "compile": "tsc",
     "precompile": "ts-node jsonCompiler.ts",
     "test": "jest -c jest.config.ts",
+    "test:integration": "jest -c jest.integration.config.ts",
     "test:update-snapshots": "jest -c jest.config.ts --updateSnapshot",
     "clean": "rimraf \"tsconfig.tsbuildinfo\" \"./lib\""
   },

package/src/JsonSchemaService.ts

@@ -16,7 +16,8 @@ import { draft07Config } from '@squiz/json-schema-library';
 import { AnyPrimitiveType, AnyResolvableType, ResolverContext, TypeResolver } from './jsonTypeResolution/TypeResolver';
 import { JsonResolutionError } from './errors/JsonResolutionError';
 import { processValidationResult } from './processValidationResult';
-import { defaultConfig, FORMATTED_TEXT_SCHEMA_ID } from '.';
+import { defaultConfig } from './defaultDraftConfig';
+import { FORMATTED_TEXT_SCHEMA_ID } from './formatted-text/v1/formattedTextConstants';
 
 export const ComponentInputMetaSchema: MetaSchemaInput = {
   root: DxComponentInputSchema,

package/src/JsonValidationService.ts

@@ -3,111 +3,24 @@ import DxContentMetaSchema from './manifest/v1/DxContentMetaSchema.json';
 import FormattedText from './formatted-text/v1/formattedText.json';
 
 import { SchemaValidationError } from './errors/SchemaValidationError';
-import { Draft07, JSONSchema, Draft, DraftConfig } from '@squiz/json-schema-library';
+import { Draft07, JSONSchema, Draft } from '@squiz/json-schema-library';
 
 import { draft07Config } from '@squiz/json-schema-library';
-import {
-  BaseFormattedTextType,
-  ComponentInputFormattedTextType,
-  FORMATTED_TEXT_SCHEMA_ID,
-  MANIFEST_MODELS,
-  SquizImageType,
-  SquizLinkType,
-  TypeResolverBuilder,
-} from '.';
-import { customFormatValidators } from './validators/customFormatValidators';
-import { customKeywordValidators } from './validators/customKeywordValidators';
+import { FORMATTED_TEXT_SCHEMA_ID } from './formatted-text/v1/formattedTextConstants';
+import * as MANIFEST_MODELS from './manifest/v1/manifestModels';
+import { BaseFormattedTextType, ComponentInputFormattedTextType } from './primitiveTypes/FormattedText';
+import { SquizImageType } from './primitiveTypes/SquizImage';
+import { SquizLinkType } from './primitiveTypes/SquizLink';
+import { TypeResolverBuilder } from './jsonTypeResolution/TypeResolverBuilder';
 import {
   ComponentInputMetaSchema,
   JobV1MetaSchema,
   JSONSchemaService,
   ManifestV1MetaSchema,
 } from './JsonSchemaService';
+import { defaultConfig } from './defaultDraftConfig';
 
-export const defaultConfig: DraftConfig = {
-  ...draft07Config,
-  validateFormat: {
-    ...draft07Config.validateFormat,
-    ...customFormatValidators,
-  },
-  typeKeywords: {
-    ...draft07Config.typeKeywords,
-    array: draft07Config.typeKeywords.array.concat('ui:metadata'),
-    object: draft07Config.typeKeywords.object.concat('ui:metadata'),
-    boolean: draft07Config.typeKeywords.boolean.concat('ui:metadata'),
-    string: draft07Config.typeKeywords.string.concat('ui:metadata'),
-    number: draft07Config.typeKeywords.number.concat('ui:metadata'),
-  },
-  validateKeyword: {
-    ...draft07Config.validateKeyword,
-    ...customKeywordValidators,
-  },
-  errors: {
-    ...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,
-      };
-    },
-
-    typeError(data) {
-      let value = `${data.value}`;
-
-      if (data.received == 'object') {
-        value = `Object ${JSON.stringify(data.value)}`;
-      }
-
-      if (data.received == 'array') {
-        value = `Array ${JSON.stringify(data.value)}`;
-      }
-
-      const expected = JSON.stringify(data.expected).replace(/"/g, '`');
-
-      return {
-        type: 'error',
-        name: 'TypeError',
-        code: 'type-error',
-        message: `Expected \`${value}\` (${data.received}) in \`${data.pointer}\` to be of type ${expected}`,
-        data,
-      };
-    },
-  },
-};
+export { defaultConfig };
 
 const FTSchema = new Draft07(FormattedText, defaultConfig);
 

package/src/defaultDraftConfig.ts

@@ -0,0 +1,89 @@
+import { draft07Config, DraftConfig } from '@squiz/json-schema-library';
+
+import { customFormatValidators } from './validators/customFormatValidators';
+import { customKeywordValidators } from './validators/customKeywordValidators';
+
+export const defaultConfig: DraftConfig = {
+  ...draft07Config,
+  validateFormat: {
+    ...draft07Config.validateFormat,
+    ...customFormatValidators,
+  },
+  typeKeywords: {
+    ...draft07Config.typeKeywords,
+    array: draft07Config.typeKeywords.array.concat('ui:metadata'),
+    object: draft07Config.typeKeywords.object.concat('ui:metadata'),
+    boolean: draft07Config.typeKeywords.boolean.concat('ui:metadata'),
+    string: draft07Config.typeKeywords.string.concat('ui:metadata'),
+    number: draft07Config.typeKeywords.number.concat('ui:metadata'),
+  },
+  validateKeyword: {
+    ...draft07Config.validateKeyword,
+    ...customKeywordValidators,
+  },
+  errors: {
+    ...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,
+      };
+    },
+
+    typeError(data) {
+      let value = `${data.value}`;
+
+      if (data.received == 'object') {
+        value = `Object ${JSON.stringify(data.value)}`;
+      }
+
+      if (data.received == 'array') {
+        value = `Array ${JSON.stringify(data.value)}`;
+      }
+
+      const expected = JSON.stringify(data.expected).replace(/"/g, '`');
+
+      return {
+        type: 'error',
+        name: 'TypeError',
+        code: 'type-error',
+        message: `Expected \`${value}\` (${data.received}) in \`${data.pointer}\` to be of type ${expected}`,
+        data,
+      };
+    },
+  },
+};

package/src/formatted-text/v1/formattedTextConstants.ts

@@ -0,0 +1,2 @@
+/** `$id` of the Formatted Text JSON Schema bundled with dx-json-schema-lib. */
+export const FORMATTED_TEXT_SCHEMA_ID = 'SquizFormattedTextSchema.json';

package/src/formatted-text/v1/resolveFormattedTextNodes.ts

@@ -10,6 +10,9 @@ import {
   HigherOrderFormattedNodes,
   TextNode,
 } from './formattedText';
+import { FORMATTED_TEXT_SCHEMA_ID } from './formattedTextConstants';
+
+export { FORMATTED_TEXT_SCHEMA_ID };
 
 export interface FormattedNodeWithChildren {
   children: FormattedNode[];
@@ -25,8 +28,6 @@ export type ResolverConfig<Nodes extends FormattedNode, Output extends Resolutio
   [N in Nodes as N['type']]: Resolver<N, Output>;
 } & { default?: Resolver<FormattedNode, Output> };
 
-export const FORMATTED_TEXT_SCHEMA_ID = 'SquizFormattedTextSchema.json';
-
 export type ResolvedChildNode<
   DEFAULT_NODES extends FormattedNode,
   CHILD_NODE extends ResolutionOutput<FormattedNode>,

package/src/index.ts

@@ -18,3 +18,5 @@ export * from './jsonTypeResolution/TypeResolver';
 export * from './jsonTypeResolution/TypeResolverBuilder';
 export * from './primitiveTypes';
 export * from './resolvableTypes';
+
+export * from './manifest/userApi/v1';