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

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

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

package/lib/manifest/userApi/v1/UserApiManifestV1.json

@@ -0,0 +1,77 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "title": "UserApiManifestV1",
+    "type": "object",
+    "additionalProperties": false,
+    "definitions": {
+        "resolvedApiManifest": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["endpoints"],
+            "properties": {
+                "endpoints": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": ["path", "method", "handler"],
+                        "properties": {
+                            "path": {
+                                "type": "string",
+                                "pattern": "^/.*",
+                                "description": "URL path routed to this endpoint; must start with /. May include `*` wildcards or `:param` segments (api-builder style)."
+                            },
+                            "method": {
+                                "type": "string",
+                                "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"],
+                                "description": "HTTP method for this route."
+                            },
+                            "handler": {
+                                "type": "string",
+                                "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$.]*$",
+                                "description": "Exported handler reference (module.export form)."
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "required": ["$schema", "name", "displayName", "filesDir", "entry", "manifest"],
+    "properties": {
+        "$schema": {
+            "type": "string",
+            "minLength": 1,
+            "description": "JSON Schema reference for IDE support."
+        },
+        "name": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^[a-z](?:[a-z0-9-]|_(?!_))*[a-z0-9]$",
+            "description": "Slug for this deployment. Lowercase letters, digits, hyphens, or underscores only; must start with a letter, end with a letter or digit, and cannot contain consecutive underscores."
+        },
+        "displayName": {
+            "type": "string",
+            "minLength": 1
+        },
+        "description": {
+            "type": "string",
+            "description": "Human-readable summary of what the API provides."
+        },
+        "filesDir": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Directory (relative to the manifest) containing sources."
+        },
+        "entry": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Entry module path under filesDir (e.g. index.ts)."
+        },
+        "manifest": {
+            "$ref": "#/definitions/resolvedApiManifest"
+        }
+    }
+}

package/lib/manifest/userApi/v1/index.d.ts

@@ -0,0 +1,2 @@
+export { USER_API_FULL_MANIFEST_SCHEMA, USER_API_MANIFEST_SCHEMA_URL, validateUserApiFullManifest, } from './userApiManifestValidation';
+export type { UserApiManifestV1 as UserApiManifest } from './UserApiManifestV1';

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUserApiFullManifest = exports.USER_API_MANIFEST_SCHEMA_URL = exports.USER_API_FULL_MANIFEST_SCHEMA = void 0;
+var userApiManifestValidation_1 = require("./userApiManifestValidation");
+Object.defineProperty(exports, "USER_API_FULL_MANIFEST_SCHEMA", { enumerable: true, get: function () { return userApiManifestValidation_1.USER_API_FULL_MANIFEST_SCHEMA; } });
+Object.defineProperty(exports, "USER_API_MANIFEST_SCHEMA_URL", { enumerable: true, get: function () { return userApiManifestValidation_1.USER_API_MANIFEST_SCHEMA_URL; } });
+Object.defineProperty(exports, "validateUserApiFullManifest", { enumerable: true, get: function () { return userApiManifestValidation_1.validateUserApiFullManifest; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/manifest/userApi/v1/index.ts"],"names":[],"mappings":";;;AAAA,yEAIqC;AAHnC,0IAAA,6BAA6B,OAAA;AAC7B,yIAAA,4BAA4B,OAAA;AAC5B,wIAAA,2BAA2B,OAAA"}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-extra-public.manifest.json

@@ -0,0 +1,10 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "GET",
+            "handler": "noop",
+            "public": true
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-handler-hyphen.manifest.json

@@ -0,0 +1,9 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "GET",
+            "handler": "bad-name"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-handler-leading-digit.manifest.json

@@ -0,0 +1,9 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "GET",
+            "handler": "0badIdentifier"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-method-invalid.manifest.json

@@ -0,0 +1,9 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "TRACE",
+            "handler": "noop"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-missing-method.manifest.json

@@ -0,0 +1,8 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "handler": "noop"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-endpoint-missing-path.manifest.json

@@ -0,0 +1,8 @@
+{
+    "endpoints": [
+        {
+            "method": "GET",
+            "handler": "noop"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-displayName-empty.manifest.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "needs-display-name",
+    "displayName": "",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/only",
+                "method": "GET",
+                "handler": "h"
+            }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-manifest-not-object.manifest.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "bad-manifest-shape",
+    "displayName": "Manifest not an object",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": "not-an-object"
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-missing-manifest.manifest.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "missing-nested-manifest",
+    "displayName": "Manifest object absent",
+    "filesDir": "src",
+    "entry": "index.ts"
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-missing-schema.manifest.json

@@ -0,0 +1,15 @@
+{
+    "name": "missing-dollar-schema",
+    "displayName": "Missing dollar schema field",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/only",
+                "method": "GET",
+                "handler": "h"
+            }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-name-empty.manifest.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "",
+    "displayName": "Empty slug",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/only",
+                "method": "GET",
+                "handler": "h"
+            }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-full-root-extra-property.manifest.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "extra-root-prop",
+    "displayName": "Extra root prop",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/only",
+                "method": "GET",
+                "handler": "h"
+            }
+        ]
+    },
+    "telemetryChannel": "forbidden-root-key-example"
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-nested-manifest-handlerMap.manifest.json

@@ -0,0 +1,12 @@
+{
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "GET",
+            "handler": "noop"
+        }
+    ],
+    "handlerMap": {
+        "noop": "./noop.ts"
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-nested-manifest-name.manifest.json

@@ -0,0 +1,10 @@
+{
+    "name": "must-not-live-under-manifest",
+    "endpoints": [
+        {
+            "path": "/ok",
+            "method": "GET",
+            "handler": "noop"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-resolved-empty-endpoints.manifest.json

@@ -0,0 +1,4 @@
+{
+    "name": "integration-sample-api",
+    "endpoints": []
+}

package/lib/manifest/userApi/v1/integration-fixtures/invalid-resolved-no-leading-slash.manifest.json

@@ -0,0 +1,11 @@
+{
+    "name": "integration-sample-api",
+    "endpoints": [
+        {
+            "path": "needs-leading-slash",
+            "method": "GET",
+            "handler": "index.x",
+            "public": true
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/valid-full-each-http-method.manifest.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "all-methods-api",
+    "displayName": "Covers enum methods",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            { "path": "/g", "method": "GET", "handler": "handlers.g" },
+            { "path": "/po", "method": "POST", "handler": "handlers.po" },
+            { "path": "/pu", "method": "PUT", "handler": "handlers.pu" },
+            { "path": "/pa", "method": "PATCH", "handler": "handlers.pa" },
+            { "path": "/d", "method": "DELETE", "handler": "handlers.d" },
+            { "path": "/o", "method": "OPTIONS", "handler": "handlers.o" },
+            { "path": "/h", "method": "HEAD", "handler": "handlers.h" }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/valid-full-no-description.manifest.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "no-description-api",
+    "displayName": "No optional description field",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/health",
+                "method": "GET",
+                "handler": "health"
+            }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/valid-full.manifest.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+    "name": "integration-sample-api",
+    "displayName": "Integration sample API",
+    "description": "Fixture used only by filesystem-backed integration tests",
+    "filesDir": "src",
+    "entry": "index.ts",
+    "manifest": {
+        "endpoints": [
+            {
+                "path": "/integration/hello",
+                "method": "GET",
+                "handler": "index.helloWorld"
+            },
+            {
+                "path": "/integration/items",
+                "method": "POST",
+                "handler": "handlers.createItem"
+            }
+        ]
+    }
+}

package/lib/manifest/userApi/v1/integration-fixtures/valid-resolved-slash-path.manifest.json

@@ -0,0 +1,14 @@
+{
+    "endpoints": [
+        {
+            "path": "/",
+            "method": "GET",
+            "handler": "root"
+        },
+        {
+            "path": "/integration/items",
+            "method": "POST",
+            "handler": "handlers.createItem"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/integration-fixtures/valid-resolved.manifest.json

@@ -0,0 +1,14 @@
+{
+    "endpoints": [
+        {
+            "path": "/integration/hello",
+            "method": "GET",
+            "handler": "index.helloWorld"
+        },
+        {
+            "path": "/integration/items",
+            "method": "POST",
+            "handler": "handlers.createItem"
+        }
+    ]
+}

package/lib/manifest/userApi/v1/userApiManifest.integration.spec.d.ts

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

package/lib/manifest/userApi/v1/userApiManifest.integration.spec.js

@@ -0,0 +1,201 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const Draft_07_json_1 = __importDefault(require("../../v1/Draft-07.json"));
+const __1 = require("../../..");
+/** Must align with `integration-fixtures/valid-full.manifest.json` `$schema`. */
+const FULL_MANIFEST_FIXTURE_SCHEMA = 'https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json';
+/** Directory containing `UserApiManifestV1.json` (this spec sits alongside those files). */
+const USER_API_SCHEMA_DIR = __dirname;
+/** `src/manifest/userApi/v1` → package root (four levels up). */
+const PACKAGE_ROOT = path_1.default.join(USER_API_SCHEMA_DIR, '..', '..', '..', '..');
+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,
+};
+function loadJson(relPathUnderSrcDir) {
+    const abs = path_1.default.isAbsolute(relPathUnderSrcDir)
+        ? relPathUnderSrcDir
+        : path_1.default.join(USER_API_SCHEMA_DIR, relPathUnderSrcDir);
+    return JSON.parse(fs_1.default.readFileSync(abs, 'utf8'));
+}
+function fixture(name) {
+    return loadJson(path_1.default.join('integration-fixtures', name));
+}
+function fixtureRecord(name) {
+    return fixture(name);
+}
+/** Standalone resolved manifests: validated only after {@link wrapResolvedFixtureAsFull}. */
+const INVALID_WRAPPED_FIXTURES = [
+    'invalid-nested-manifest-name.manifest.json',
+    'invalid-nested-manifest-handlerMap.manifest.json',
+    'invalid-endpoint-extra-public.manifest.json',
+    'invalid-endpoint-handler-leading-digit.manifest.json',
+    'invalid-endpoint-handler-hyphen.manifest.json',
+    'invalid-endpoint-method-invalid.manifest.json',
+    'invalid-endpoint-missing-method.manifest.json',
+    'invalid-endpoint-missing-path.manifest.json',
+    'invalid-resolved-empty-endpoints.manifest.json',
+    'invalid-resolved-no-leading-slash.manifest.json',
+];
+/** Full top-level documents consumed directly by {@link JSONSchemaService.validateInput}. */
+const INVALID_FULL_MANIFEST_FIXTURES = [
+    'invalid-full-root-extra-property.manifest.json',
+    'invalid-full-name-empty.manifest.json',
+    'invalid-full-displayName-empty.manifest.json',
+    'invalid-full-missing-schema.manifest.json',
+    'invalid-full-missing-manifest.manifest.json',
+    'invalid-full-manifest-not-object.manifest.json',
+];
+/** Non-schema regression check: validators must not omit or reorder fixture endpoint fields. */
+function expectFixtureEndpointsUnchanged(validated) {
+    var _a, _b;
+    const data = validated;
+    const endpoints = (_b = (_a = data.manifest) === null || _a === void 0 ? void 0 : _a.endpoints) !== null && _b !== void 0 ? _b : data.endpoints;
+    expect(endpoints).toHaveLength(2);
+    expect(endpoints).toContainEqual({
+        path: '/integration/hello',
+        method: 'GET',
+        handler: 'index.helloWorld',
+    });
+    expect(endpoints).toContainEqual({
+        path: '/integration/items',
+        method: 'POST',
+        handler: 'handlers.createItem',
+    });
+}
+/** Wrap standalone resolved fixture JSON under a minimal UserApiManifestV1 root (only full manifest is validated publicly). */
+function wrapResolvedFixtureAsFull(resolved) {
+    return {
+        $schema: FULL_MANIFEST_FIXTURE_SCHEMA,
+        name: typeof resolved.name === 'string' ? resolved.name : 'wrapped-api',
+        displayName: 'Integration fixture envelope',
+        description: '',
+        filesDir: 'src',
+        entry: 'index.ts',
+        manifest: resolved,
+    };
+}
+function createFullManifestValidator(schemaFromDisk) {
+    const resolver = __1.TypeResolverBuilder.new().build();
+    return new __1.JSONSchemaService(resolver, {
+        root: schemaFromDisk,
+        remotes: draft07Remotes,
+    });
+}
+describe('user-api JSON schemas (integration, filesystem-backed)', () => {
+    describe('published schema documents on disk', () => {
+        it('parses UserApiManifestV1.json and exposes nested resolved manifest definition', () => {
+            var _a;
+            const schema = loadJson('UserApiManifestV1.json');
+            expect(schema.$schema).toBe('http://json-schema.org/draft-07/schema#');
+            expect(schema.title).toBe('UserApiManifestV1');
+            expect(schema.additionalProperties).toBe(false);
+            expect(schema.required).toEqual(expect.arrayContaining(['$schema', 'name', 'displayName', 'filesDir', 'entry', 'manifest']));
+            const { resolvedApiManifest } = schema.definitions;
+            expect(resolvedApiManifest.required).toEqual(expect.arrayContaining(['endpoints']));
+            const rootProps = schema.properties;
+            expect(rootProps.manifest.$ref).toBe('#/definitions/resolvedApiManifest');
+            expect(resolvedApiManifest.properties).toHaveProperty('endpoints');
+            expect(Object.keys((_a = resolvedApiManifest.properties) !== null && _a !== void 0 ? _a : {})).toEqual(['endpoints']);
+            expect(resolvedApiManifest.required).toEqual(['endpoints']);
+        });
+        it('UserApiManifestV1 endpoint items require path, method, handler only and forbid extra endpoint keys', () => {
+            var _a;
+            const schema = loadJson('UserApiManifestV1.json');
+            const items = schema.definitions.resolvedApiManifest.properties.endpoints.items;
+            expect(items.required).toEqual(['path', 'method', 'handler']);
+            expect(items.additionalProperties).toBe(false);
+            expect(items.properties).toMatchObject({
+                path: expect.objectContaining({ type: 'string' }),
+                method: expect.objectContaining({ type: 'string' }),
+                handler: expect.objectContaining({ type: 'string' }),
+            });
+            expect(Object.keys((_a = items.properties) !== null && _a !== void 0 ? _a : {})).toHaveLength(3);
+        });
+        it('UserApiManifestV1 nested resolved manifest forbids arbitrary root keys (endpoints only)', () => {
+            const schema = loadJson('UserApiManifestV1.json');
+            expect(schema.definitions.resolvedApiManifest.additionalProperties).toBe(false);
+        });
+    });
+    describe('validation pipeline using schemas read from filesystem (not TS imports)', () => {
+        const fullManifestSchemaRoot = loadJson('UserApiManifestV1.json');
+        const fullValidator = createFullManifestValidator(fullManifestSchemaRoot);
+        const validResolved = fixtureRecord('valid-resolved.manifest.json');
+        function expectRejectWhenWrapped(filename) {
+            expect(() => fullValidator.validateInput(wrapResolvedFixtureAsFull(fixtureRecord(filename)))).toThrow(__1.SchemaValidationError);
+        }
+        function expectRejectFullDocument(blob) {
+            expect(() => fullValidator.validateInput(blob)).toThrow(__1.SchemaValidationError);
+        }
+        it.each(INVALID_WRAPPED_FIXTURES)('rejects wrapped nested manifest from %s', (filename) => {
+            expectRejectWhenWrapped(filename);
+        });
+        it.each(INVALID_FULL_MANIFEST_FIXTURES)('rejects full manifest document %s', (filename) => {
+            expectRejectFullDocument(fixture(filename));
+        });
+        it('accepts realistic full manifest fixture aligned with nested endpoint schema', () => {
+            const blob = fixture('valid-full.manifest.json');
+            expect(fullValidator.validateInput(blob)).toBe(true);
+            expectFixtureEndpointsUnchanged(blob);
+        });
+        it('accepts valid-resolved fixture when wrapped under a minimal full manifest envelope', () => {
+            const wrapped = wrapResolvedFixtureAsFull(validResolved);
+            expect(fullValidator.validateInput(wrapped)).toBe(true);
+            expectFixtureEndpointsUnchanged(wrapped);
+        });
+        it('valid-resolved fixture is endpoints-only at nested root (no manifest.name)', () => {
+            expect(Array.isArray(validResolved.endpoints)).toBe(true);
+        });
+        it('accepts api-builder-style paths (wildcard and :param) using disk-backed schema', () => {
+            const wrapped = wrapResolvedFixtureAsFull({
+                endpoints: [
+                    { path: '/hello/*', method: 'GET', handler: 'hello' },
+                    { path: '/user/:id/:type', method: 'GET', handler: 'user' },
+                ],
+            });
+            expect(fullValidator.validateInput(wrapped)).toBe(true);
+        });
+        it('accepts alternate $schema URL on envelope (filesystem validation path)', () => {
+            const blob = {
+                $schema: 'https://raw.githubusercontent.com/user/api-builder-prototype/main/schemas/api-builder.schema.json',
+                name: 'integration-proto',
+                displayName: 'Proto',
+                filesDir: 'src',
+                entry: 'index.ts',
+                manifest: {
+                    endpoints: [{ path: '/health', method: 'GET', handler: 'health' }],
+                },
+            };
+            expect(fullValidator.validateInput(blob)).toBe(true);
+        });
+        it('accepts full manifest when optional description is omitted', () => {
+            expect(fullValidator.validateInput(fixture('valid-full-no-description.manifest.json'))).toBe(true);
+        });
+        it('accepts one endpoint per allowed HTTP method value', () => {
+            const blob = fixture('valid-full-each-http-method.manifest.json');
+            expect(fullValidator.validateInput(blob)).toBe(true);
+            expect(blob.manifest.endpoints.map((e) => e.method).sort()).toEqual(['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT'].sort());
+        });
+        it('accepts minimal path "/" in wrapped resolved fixture alongside another endpoint', () => {
+            const wrapped = wrapResolvedFixtureAsFull(fixtureRecord('valid-resolved-slash-path.manifest.json'));
+            expect(fullValidator.validateInput(wrapped)).toBe(true);
+            const endpoints = wrapped.manifest.endpoints;
+            expect(endpoints.some((e) => e.path === '/')).toBe(true);
+        });
+    });
+    describe('artifacts under lib/ after compile (when present)', () => {
+        const srcFull = path_1.default.join(USER_API_SCHEMA_DIR, 'UserApiManifestV1.json');
+        const libFull = path_1.default.join(PACKAGE_ROOT, 'lib', 'manifest', 'userApi', 'v1', 'UserApiManifestV1.json');
+        const libExists = fs_1.default.existsSync(libFull);
+        const itOrSkip = libExists ? it : it.skip;
+        itOrSkip('copied lib UserApiManifestV1.json payload matches src', () => {
+            expect(loadJson(libFull)).toEqual(loadJson(srcFull));
+        });
+    });
+});
+//# sourceMappingURL=userApiManifest.integration.spec.js.map

package/lib/manifest/userApi/v1/userApiManifest.integration.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userApiManifest.integration.spec.js","sourceRoot":"","sources":["../../../../src/manifest/userApi/v1/userApiManifest.integration.spec.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,2EAAmD;AACnD,gCAAyF;AAEzF,iFAAiF;AACjF,MAAM,4BAA4B,GAChC,wGAAwG,CAAC;AAE3G,4FAA4F;AAC5F,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,iEAAiE;AACjE,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE5E,MAAM,cAAc,GAAG;IACrB,wCAAwC,EAAE,uBAAa;IACvD,yCAAyC,EAAE,uBAAa;CAChD,CAAC;AAEX,SAAS,QAAQ,CAAC,kBAA0B;IAC1C,MAAM,GAAG,GAAG,cAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;QAC7C,CAAC,CAAC,kBAAkB;QACpB,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAY,CAAC;AAC7D,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,OAAO,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,OAAO,CAAC,IAAI,CAA4B,CAAC;AAClD,CAAC;AAED,6FAA6F;AAC7F,MAAM,wBAAwB,GAAG;IAC/B,4CAA4C;IAC5C,kDAAkD;IAClD,6CAA6C;IAC7C,sDAAsD;IACtD,+CAA+C;IAC/C,+CAA+C;IAC/C,+CAA+C;IAC/C,6CAA6C;IAC7C,gDAAgD;IAChD,iDAAiD;CACzC,CAAC;AAEX,6FAA6F;AAC7F,MAAM,8BAA8B,GAAG;IACrC,gDAAgD;IAChD,uCAAuC;IACvC,8CAA8C;IAC9C,2CAA2C;IAC3C,6CAA6C;IAC7C,gDAAgD;CACxC,CAAC;AAQX,gGAAgG;AAChG,SAAS,+BAA+B,CAAC,SAAkB;;IACzD,MAAM,IAAI,GAAG,SAA2F,CAAC;IACzG,MAAM,SAAS,GAAG,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;IAC7D,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAElC,MAAM,CAAC,SAAU,CAAC,CAAC,cAAc,CAAC;QAChC,IAAI,EAAE,oBAAoB;QAC1B,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,kBAAkB;KAC5B,CAAC,CAAC;IACH,MAAM,CAAC,SAAU,CAAC,CAAC,cAAc,CAAC;QAChC,IAAI,EAAE,oBAAoB;QAC1B,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,qBAAqB;KAC/B,CAAC,CAAC;AACL,CAAC;AAED,+HAA+H;AAC/H,SAAS,yBAAyB,CAAC,QAAiC;IAClE,OAAO;QACL,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa;QACvE,WAAW,EAAE,8BAA8B;QAC3C,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,QAAQ;KACnB,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAAC,cAA0B;IAC7D,MAAM,QAAQ,GAAG,uBAAmB,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;IACnD,OAAO,IAAI,qBAAiB,CAAC,QAAQ,EAAE;QACrC,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,cAAc;KACxB,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,wDAAwD,EAAE,GAAG,EAAE;IACtE,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAClD,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;;YACvF,MAAM,MAAM,GAAG,QAAQ,CAAC,wBAAwB,CAA4B,CAAC;YAC7E,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YACvE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAC7B,MAAM,CAAC,eAAe,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAC5F,CAAC;YAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC,WAKtC,CAAC;YACF,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAEpF,MAAM,SAAS,GAAG,MAAM,CAAC,UAA6C,CAAC;YACvE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YAE1E,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACnE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAA,mBAAmB,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;YACjF,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oGAAoG,EAAE,GAAG,EAAE;;YAC5G,MAAM,MAAM,GAAG,QAAQ,CAAC,wBAAwB,CAc/C,CAAC;YACF,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;YAChF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;YAC9D,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,aAAa,CAAC;gBACrC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACjD,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACnD,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;aACrD,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAA,KAAK,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yFAAyF,EAAE,GAAG,EAAE;YACjG,MAAM,MAAM,GAAG,QAAQ,CAAC,wBAAwB,CAE/C,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yEAAyE,EAAE,GAAG,EAAE;QACvF,MAAM,sBAAsB,GAAG,QAAQ,CAAC,wBAAwB,CAAe,CAAC;QAChF,MAAM,aAAa,GAAG,2BAA2B,CAAC,sBAAsB,CAAC,CAAC;QAC1E,MAAM,aAAa,GAAG,aAAa,CAAC,8BAA8B,CAAC,CAAC;QAEpE,SAAS,uBAAuB,CAAC,QAAgB;YAC/C,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,aAAa,CAAC,yBAAyB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CACnG,yBAAqB,CACtB,CAAC;QACJ,CAAC;QAED,SAAS,wBAAwB,CAAC,IAAa;YAC7C,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,yBAAqB,CAAC,CAAC;QACjF,CAAC;QAED,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,yCAAyC,EAAE,CAAC,QAAQ,EAAE,EAAE;YACxF,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC,mCAAmC,EAAE,CAAC,QAAQ,EAAE,EAAE;YACxF,wBAAwB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;YACrF,MAAM,IAAI,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;YACjD,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrD,+BAA+B,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;YAC5F,MAAM,OAAO,GAAG,yBAAyB,CAAC,aAAa,CAAC,CAAC;YACzD,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;YACpF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;YACxF,MAAM,OAAO,GAAG,yBAAyB,CAAC;gBACxC,SAAS,EAAE;oBACT,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;oBACrD,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE;iBAC5D;aACF,CAAC,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,IAAI,GAAG;gBACX,OAAO,EAAE,mGAAmG;gBAC5G,IAAI,EAAE,mBAAmB;gBACzB,WAAW,EAAE,OAAO;gBACpB,QAAQ,EAAE,KAAK;gBACf,KAAK,EAAE,UAAU;gBACjB,QAAQ,EAAE;oBACR,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;iBACnE;aACF,CAAC;YACF,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,yCAAyC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,IAAI,GAAG,OAAO,CAAC,2CAA2C,CAE/D,CAAC;YACF,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CACjE,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CACpE,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;YACzF,MAAM,OAAO,GAAG,yBAAyB,CAAC,aAAa,CAAC,yCAAyC,CAAC,CAAC,CAAC;YACpG,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,SAAS,GAAI,OAAO,CAAC,QAA8C,CAAC,SAAS,CAAC;YACpF,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACjE,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,wBAAwB,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,wBAAwB,CAAC,CAAC;QAEtG,MAAM,SAAS,GAAG,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC;QAE1C,QAAQ,CAAC,uDAAuD,EAAE,GAAG,EAAE;YACrE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,16 @@
+/**
+ * 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`.
+ */
+export declare const USER_API_MANIFEST_SCHEMA_URL: string;
+/**
+ * JSON Schema bundle validating the full on-disk manifest (CLI / zip upload).
+ */
+export { default as USER_API_FULL_MANIFEST_SCHEMA } from './UserApiManifestV1.json';
+/**
+ * Validate the User API manifest before upload.
+ *
+ * @throws {SchemaValidationError} when validation fails.
+ */
+export declare function validateUserApiFullManifest(input: unknown): true;