@xemahq/platform-common 0.1.3

package/dist/nestjs/swagger-keycloak.d.ts

@@ -0,0 +1,30 @@
+interface SwaggerUiOAuthOptions {
+    clientId: string;
+    usePkceWithAuthorizationCodeGrant: true;
+    scopes?: string[];
+}
+export interface KeycloakSwaggerUrls {
+    authUrl: string;
+    tokenUrl: string;
+    discoveryUrl: string;
+}
+export interface KeycloakOpenApiEnrichmentOptions {
+    discoveryUrl: string;
+    bearerSchemeName?: string;
+    oidcSchemeName?: string;
+}
+export interface KeycloakSwaggerUiOptionsInput {
+    oauth2RedirectUrl?: string | undefined;
+    oauthClientId?: string | undefined;
+    oauthScopes?: string[] | undefined;
+}
+export interface KeycloakSwaggerUiOptions {
+    persistAuthorization: true;
+    oauth2RedirectUrl?: string;
+    initOAuth?: SwaggerUiOAuthOptions;
+}
+export declare function getKeycloakSwaggerUrls(jwtIssuer: string): KeycloakSwaggerUrls;
+export declare function enrichOpenApiWithKeycloakSecurity(openapiDocument: unknown, { discoveryUrl, bearerSchemeName, oidcSchemeName, }: KeycloakOpenApiEnrichmentOptions): void;
+export declare function buildKeycloakSwaggerUiOptions({ oauth2RedirectUrl, oauthClientId, oauthScopes, }: KeycloakSwaggerUiOptionsInput): KeycloakSwaggerUiOptions;
+export {};
+//# sourceMappingURL=swagger-keycloak.d.ts.map

package/dist/nestjs/swagger-keycloak.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger-keycloak.d.ts","sourceRoot":"","sources":["../../src/nestjs/swagger-keycloak.ts"],"names":[],"mappings":"AAiBA,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC,EAAE,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,6BAA6B;IAC5C,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,wBAAwB;IACvC,oBAAoB,EAAE,IAAI,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,qBAAqB,CAAC;CACnC;AAMD,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,mBAAmB,CAO7E;AAED,wBAAgB,iCAAiC,CAC/C,eAAe,EAAE,OAAO,EACxB,EACE,YAAY,EACZ,gBAA2B,EAC3B,cAA+B,GAChC,EAAE,gCAAgC,GAClC,IAAI,CA4CN;AAED,wBAAgB,6BAA6B,CAAC,EAC5C,iBAAiB,EACjB,aAAa,EACb,WAAW,GACZ,EAAE,6BAA6B,GAAG,wBAAwB,CAoB1D"}

package/dist/nestjs/swagger-keycloak.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeycloakSwaggerUrls = getKeycloakSwaggerUrls;
+exports.enrichOpenApiWithKeycloakSecurity = enrichOpenApiWithKeycloakSecurity;
+exports.buildKeycloakSwaggerUiOptions = buildKeycloakSwaggerUiOptions;
+function trimTrailingSlash(value) {
+    return value.endsWith('/') ? value.slice(0, -1) : value;
+}
+function getKeycloakSwaggerUrls(jwtIssuer) {
+    const issuer = trimTrailingSlash(jwtIssuer);
+    return {
+        authUrl: `${issuer}/protocol/openid-connect/auth`,
+        tokenUrl: `${issuer}/protocol/openid-connect/token`,
+        discoveryUrl: `${issuer}/.well-known/openid-configuration`,
+    };
+}
+function enrichOpenApiWithKeycloakSecurity(openapiDocument, { discoveryUrl, bearerSchemeName = 'bearer', oidcSchemeName = 'keycloakOidc', }) {
+    const openApi = openapiDocument;
+    openApi.components ??= {};
+    openApi.components.securitySchemes ??= {};
+    openApi.components.securitySchemes[oidcSchemeName] = {
+        type: 'openIdConnect',
+        openIdConnectUrl: discoveryUrl,
+        description: 'Keycloak OpenID Connect discovery endpoint',
+    };
+    if (!openApi.paths) {
+        return;
+    }
+    const methods = [
+        'get',
+        'put',
+        'post',
+        'delete',
+        'options',
+        'head',
+        'patch',
+        'trace',
+    ];
+    Object.values(openApi.paths).forEach((pathItem) => {
+        methods.forEach((method) => {
+            const operation = pathItem[method];
+            if (!operation?.security || operation.security.length === 0) {
+                return;
+            }
+            operation.security = operation.security.map((requirement) => {
+                if (!(bearerSchemeName in requirement) || oidcSchemeName in requirement) {
+                    return requirement;
+                }
+                return {
+                    ...requirement,
+                    [oidcSchemeName]: requirement[bearerSchemeName],
+                };
+            });
+        });
+    });
+}
+function buildKeycloakSwaggerUiOptions({ oauth2RedirectUrl, oauthClientId, oauthScopes, }) {
+    const result = {
+        persistAuthorization: true,
+    };
+    if (oauth2RedirectUrl) {
+        result.oauth2RedirectUrl = oauth2RedirectUrl;
+    }
+    if (oauthClientId) {
+        result.initOAuth = {
+            clientId: oauthClientId,
+            usePkceWithAuthorizationCodeGrant: true,
+            ...(oauthScopes && oauthScopes.length > 0
+                ? { scopes: oauthScopes }
+                : {}),
+        };
+    }
+    return result;
+}
+//# sourceMappingURL=swagger-keycloak.js.map

package/dist/nestjs/swagger-keycloak.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger-keycloak.js","sourceRoot":"","sources":["../../src/nestjs/swagger-keycloak.ts"],"names":[],"mappings":";;AAmDA,wDAOC;AAED,8EAmDC;AAED,sEAwBC;AA1FD,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC;AAED,SAAgB,sBAAsB,CAAC,SAAiB;IACtD,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC5C,OAAO;QACL,OAAO,EAAE,GAAG,MAAM,+BAA+B;QACjD,QAAQ,EAAE,GAAG,MAAM,gCAAgC;QACnD,YAAY,EAAE,GAAG,MAAM,mCAAmC;KAC3D,CAAC;AACJ,CAAC;AAED,SAAgB,iCAAiC,CAC/C,eAAwB,EACxB,EACE,YAAY,EACZ,gBAAgB,GAAG,QAAQ,EAC3B,cAAc,GAAG,cAAc,GACE;IAEnC,MAAM,OAAO,GAAG,eAA8C,CAAC;IAC/D,OAAO,CAAC,UAAU,KAAK,EAAE,CAAC;IAC1B,OAAO,CAAC,UAAU,CAAC,eAAe,KAAK,EAAE,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,cAAc,CAAC,GAAG;QACnD,IAAI,EAAE,eAAe;QACrB,gBAAgB,EAAE,YAAY;QAC9B,WAAW,EAAE,4CAA4C;KAC1D,CAAC;IAEF,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAiC;QAC5C,KAAK;QACL,KAAK;QACL,MAAM;QACN,QAAQ;QACR,SAAS;QACT,MAAM;QACN,OAAO;QACP,OAAO;KACR,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,CAAC,SAAS,EAAE,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5D,OAAO;YACT,CAAC;YAED,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;gBAC1D,IAAI,CAAC,CAAC,gBAAgB,IAAI,WAAW,CAAC,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;oBACxE,OAAO,WAAW,CAAC;gBACrB,CAAC;gBAED,OAAO;oBACL,GAAG,WAAW;oBACd,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC;iBAChD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,6BAA6B,CAAC,EAC5C,iBAAiB,EACjB,aAAa,EACb,WAAW,GACmB;IAC9B,MAAM,MAAM,GAA6B;QACvC,oBAAoB,EAAE,IAAI;KAC3B,CAAC;IAEF,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC/C,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,CAAC,SAAS,GAAG;YACjB,QAAQ,EAAE,aAAa;YACvB,iCAAiC,EAAE,IAAI;YACvC,GAAG,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC;gBACvC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE;gBACzB,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/nestjs/swagger.decorators.d.ts

@@ -0,0 +1,8 @@
+import { Type } from '@nestjs/common';
+export declare function ApiStandardOperation(summary: string): MethodDecorator;
+export declare function ApiDataResponse<TModel extends Type<unknown>>(model: TModel): MethodDecorator;
+export declare function ApiDataArrayResponse<TModel extends Type<unknown>>(model: TModel): MethodDecorator;
+export declare function ApiCreatedDataResponse<TModel extends Type<unknown>>(model: TModel): MethodDecorator;
+export declare function ApiPaginatedResponse<TModel extends Type<unknown>>(model: TModel): MethodDecorator;
+export declare function ApiStandardErrors(): MethodDecorator;
+//# sourceMappingURL=swagger.decorators.d.ts.map

package/dist/nestjs/swagger.decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.decorators.d.ts","sourceRoot":"","sources":["../../src/nestjs/swagger.decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAiBvD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,CAErE;AAgFD,wBAAgB,eAAe,CAAC,MAAM,SAAS,IAAI,CAAC,OAAO,CAAC,EAC1D,KAAK,EAAE,MAAM,GACZ,eAAe,CAMjB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,IAAI,CAAC,OAAO,CAAC,EAC/D,KAAK,EAAE,MAAM,GACZ,eAAe,CAMjB;AAED,wBAAgB,sBAAsB,CAAC,MAAM,SAAS,IAAI,CAAC,OAAO,CAAC,EACjE,KAAK,EAAE,MAAM,GACZ,eAAe,CAMjB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,SAAS,IAAI,CAAC,OAAO,CAAC,EAC/D,KAAK,EAAE,MAAM,GACZ,eAAe,CAMjB;AAED,wBAAgB,iBAAiB,IAAI,eAAe,CASnD"}

package/dist/nestjs/swagger.decorators.js

@@ -0,0 +1,117 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiStandardOperation = ApiStandardOperation;
+exports.ApiDataResponse = ApiDataResponse;
+exports.ApiDataArrayResponse = ApiDataArrayResponse;
+exports.ApiCreatedDataResponse = ApiCreatedDataResponse;
+exports.ApiPaginatedResponse = ApiPaginatedResponse;
+exports.ApiStandardErrors = ApiStandardErrors;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const error_response_dto_1 = require("./error-response.dto");
+function ApiStandardOperation(summary) {
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiOperation)({ summary }));
+}
+const dataEnvelopeCache = new Map();
+const dataArrayEnvelopeCache = new Map();
+function getDataEnvelope(model) {
+    let envelope = dataEnvelopeCache.get(model);
+    if (!envelope) {
+        envelope = class {
+        };
+        Object.defineProperty(envelope, 'name', { value: `${model.name}DataEnvelope` });
+        (0, swagger_1.ApiProperty)({ type: () => model })(envelope.prototype, 'data');
+        dataEnvelopeCache.set(model, envelope);
+    }
+    return envelope;
+}
+function getDataArrayEnvelope(model) {
+    let envelope = dataArrayEnvelopeCache.get(model);
+    if (!envelope) {
+        envelope = class {
+        };
+        Object.defineProperty(envelope, 'name', { value: `${model.name}DataArrayEnvelope` });
+        (0, swagger_1.ApiProperty)({ type: () => [model] })(envelope.prototype, 'data');
+        dataArrayEnvelopeCache.set(model, envelope);
+    }
+    return envelope;
+}
+class PaginationMeta {
+    total;
+    page;
+    totalPages;
+    nextCursor;
+    previousCursor;
+    limit;
+    hasMore;
+}
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 100 }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "total", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 1 }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "page", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 5 }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "totalPages", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ type: String, example: 'opaque-cursor-token', nullable: true }),
+    __metadata("design:type", Object)
+], PaginationMeta.prototype, "nextCursor", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ type: String, example: 'opaque-cursor-token', nullable: true }),
+    __metadata("design:type", Object)
+], PaginationMeta.prototype, "previousCursor", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 20 }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "limit", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: true }),
+    __metadata("design:type", Boolean)
+], PaginationMeta.prototype, "hasMore", void 0);
+const paginatedEnvelopeCache = new Map();
+function getPaginatedEnvelope(model) {
+    let envelope = paginatedEnvelopeCache.get(model);
+    if (!envelope) {
+        envelope = class {
+        };
+        Object.defineProperty(envelope, 'name', { value: `${model.name}PaginatedEnvelope` });
+        (0, swagger_1.ApiProperty)({ type: () => [model] })(envelope.prototype, 'data');
+        (0, swagger_1.ApiPropertyOptional)({ type: () => PaginationMeta })(envelope.prototype, 'pagination');
+        paginatedEnvelopeCache.set(model, envelope);
+    }
+    return envelope;
+}
+function ApiDataResponse(model) {
+    const envelope = getDataEnvelope(model);
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(model, envelope), (0, swagger_1.ApiOkResponse)({ type: envelope }));
+}
+function ApiDataArrayResponse(model) {
+    const envelope = getDataArrayEnvelope(model);
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(model, envelope), (0, swagger_1.ApiOkResponse)({ type: envelope }));
+}
+function ApiCreatedDataResponse(model) {
+    const envelope = getDataEnvelope(model);
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(model, envelope), (0, swagger_1.ApiCreatedResponse)({ type: envelope }));
+}
+function ApiPaginatedResponse(model) {
+    const envelope = getPaginatedEnvelope(model);
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(model, PaginationMeta, envelope), (0, swagger_1.ApiOkResponse)({ type: envelope }));
+}
+function ApiStandardErrors() {
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiBadRequestResponse)({ type: error_response_dto_1.ErrorResponseDto }), (0, swagger_1.ApiUnauthorizedResponse)({ type: error_response_dto_1.ErrorResponseDto }), (0, swagger_1.ApiForbiddenResponse)({ type: error_response_dto_1.ErrorResponseDto }), (0, swagger_1.ApiNotFoundResponse)({ type: error_response_dto_1.ErrorResponseDto }), (0, swagger_1.ApiConflictResponse)({ type: error_response_dto_1.ErrorResponseDto }), (0, swagger_1.ApiInternalServerErrorResponse)({ type: error_response_dto_1.ErrorResponseDto }));
+}
+//# sourceMappingURL=swagger.decorators.js.map

package/dist/nestjs/swagger.decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.decorators.js","sourceRoot":"","sources":["../../src/nestjs/swagger.decorators.ts"],"names":[],"mappings":";;;;;;;;;;;AAiBA,oDAEC;AAgFD,0CAQC;AAED,oDAQC;AAED,wDAQC;AAED,oDAQC;AAED,8CASC;AApJD,2CAAuD;AACvD,6CAayB;AACzB,6DAAwD;AAExD,SAAgB,oBAAoB,CAAC,OAAe;IAClD,OAAO,IAAA,wBAAe,EAAC,IAAA,sBAAY,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAYD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAgC,CAAC;AAClE,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAgC,CAAC;AAEvE,SAAS,eAAe,CAA+B,KAAa;IAClE,IAAI,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,GAAG;SAAQ,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC;QAChF,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC/D,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,oBAAoB,CAA+B,KAAa;IACvE,IAAI,QAAQ,GAAG,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,GAAG;SAAQ,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC;QACrF,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACjE,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAYD,MAAM,cAAc;IAEqB,KAAK,CAAU;IACjB,IAAI,CAAU;IACd,UAAU,CAAU;IAIzD,UAAU,CAAiB;IAE3B,cAAc,CAAiB;IAGO,KAAK,CAAU;IACb,OAAO,CAAW;CAC3D;AAbwC;IAAtC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;;6CAAgB;AACjB;IAApC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;4CAAe;AACd;IAApC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;kDAAqB;AAIzD;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDAC3D;AAE3B;IADC,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACvD;AAGO;IAArC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;;6CAAgB;AACb;IAAvC,IAAA,6BAAmB,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;+CAAmB;AAG5D,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAgC,CAAC;AAEvE,SAAS,oBAAoB,CAA+B,KAAa;IACvE,IAAI,QAAQ,GAAG,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,GAAG;SAAQ,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,mBAAmB,EAAE,CAAC,CAAC;QACrF,IAAA,qBAAW,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACjE,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACtF,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAID,SAAgB,eAAe,CAC7B,KAAa;IAEb,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,IAAA,wBAAe,EACpB,IAAA,wBAAc,EAAC,KAAK,EAAE,QAAQ,CAAC,EAC/B,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAClC,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,KAAa;IAEb,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,IAAA,wBAAe,EACpB,IAAA,wBAAc,EAAC,KAAK,EAAE,QAAQ,CAAC,EAC/B,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAClC,CAAC;AACJ,CAAC;AAED,SAAgB,sBAAsB,CACpC,KAAa;IAEb,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,IAAA,wBAAe,EACpB,IAAA,wBAAc,EAAC,KAAK,EAAE,QAAQ,CAAC,EAC/B,IAAA,4BAAkB,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CACvC,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,KAAa;IAEb,MAAM,QAAQ,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,IAAA,wBAAe,EACpB,IAAA,wBAAc,EAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,CAAC,EAC/C,IAAA,uBAAa,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAClC,CAAC;AACJ,CAAC;AAED,SAAgB,iBAAiB;IAC/B,OAAO,IAAA,wBAAe,EACpB,IAAA,+BAAqB,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,EACjD,IAAA,iCAAuB,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,EACnD,IAAA,8BAAoB,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,EAChD,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,EAC/C,IAAA,6BAAmB,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,EAC/C,IAAA,wCAA8B,EAAC,EAAE,IAAI,EAAE,qCAAgB,EAAE,CAAC,CAC3D,CAAC;AACJ,CAAC"}

package/dist/schemas/xema/analysis.json

@@ -0,0 +1,51 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schemas.xema.dev/analysis",
+    "title": "Unit / Coordinator Analysis Report",
+    "description": "Schema for /workspace/deliverables/analysis.json — phase decisions, assumptions, conflicts. All fields required; use empty arrays when no items.",
+    "type": "object",
+    "required": ["status", "summary", "decisions", "assumptions", "conflicts"],
+    "additionalProperties": true,
+    "properties": {
+        "status": { "type": "string", "enum": ["completed", "partial", "blocked"] },
+        "summary": { "type": "string", "description": "One-paragraph summary of analytical work." },
+        "decisions": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["semanticKey", "topic", "value", "rationale"],
+                "additionalProperties": true,
+                "properties": {
+                    "semanticKey": { "type": "string" },
+                    "topic": { "type": "string" },
+                    "value": { "type": "string" },
+                    "rationale": { "type": "string" }
+                }
+            }
+        },
+        "assumptions": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["semanticKey", "assumption", "impact"],
+                "additionalProperties": true,
+                "properties": {
+                    "semanticKey": { "type": "string" },
+                    "assumption": { "type": "string" },
+                    "impact": { "type": "string" }
+                }
+            }
+        },
+        "conflicts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": true,
+                "properties": {
+                    "topic": { "type": "string" },
+                    "description": { "type": "string" }
+                }
+            }
+        }
+    }
+}

package/dist/schemas/xema/clarification-contract.json

@@ -0,0 +1,49 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schemas.xema.dev/clarification-contract",
+    "title": "Clarification Contract",
+    "description": "Schema for the clarification contract the clarification reviewer evaluates. Written to /workspace/inputs/contract.json for clarification-reviewer role.",
+    "type": "object",
+    "required": ["request", "problems", "decisions"],
+    "additionalProperties": true,
+    "properties": {
+        "request": {
+            "type": "object",
+            "required": ["prompt", "normalizedIntent"],
+            "additionalProperties": true,
+            "properties": {
+                "prompt": { "type": "string" },
+                "normalizedIntent": { "type": "string" }
+            }
+        },
+        "problems": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["id", "title"],
+                "additionalProperties": true
+            }
+        },
+        "decisions": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "userDecisions": { "type": "array" },
+                "autoDelegatedDecisions": { "type": "array" },
+                "confirmedAssumptions": { "type": "array" }
+            }
+        },
+        "constraints": { "type": "array" },
+        "openCaveats": { "type": "array" },
+        "riskAcceptances": { "type": "array" },
+        "requirementsReadiness": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "isReady": { "type": "boolean" }
+            }
+        },
+        "scope": { "type": "object", "additionalProperties": true },
+        "executionProfile": { "type": "object", "additionalProperties": true }
+    }
+}

package/dist/schemas/xema/context.json

@@ -0,0 +1,79 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schemas.xema.dev/context",
+    "title": "Xema Workspace Context",
+    "description": "Invocation identity + authority written by the orchestrator to /workspace/context.json before an agent runs. Read once at task start.",
+    "type": "object",
+    "required": ["invocation", "project", "authority"],
+    "additionalProperties": false,
+    "properties": {
+        "invocation": {
+            "type": "object",
+            "required": ["role", "surface", "attempt"],
+            "additionalProperties": false,
+            "properties": {
+                "runId": { "type": ["string", "null"], "description": "Pipeline run id. Null for interactive sessions." },
+                "phaseKey": { "type": ["string", "null"], "description": "Pipeline phase. Null when not applicable." },
+                "packageId": { "type": ["string", "null"], "description": "Unit scope. Null when not unit-scoped." },
+                "sessionId": { "type": ["string", "null"], "description": "Interactive session id. Null for pipeline invocations." },
+                "attempt": { "type": "integer", "minimum": 1, "description": "Increments on each gate-rejected retry." },
+                "role": {
+                    "type": "string",
+                    "enum": ["unit-worker", "coordinator", "gate-reviewer", "clarification-coordinator", "agent-session"]
+                },
+                "surface": {
+                    "type": "string",
+                    "enum": ["pipeline-run", "agent-session", "gate-review"]
+                }
+            }
+        },
+        "project": {
+            "type": "object",
+            "required": ["orgId", "projectId"],
+            "additionalProperties": false,
+            "properties": {
+                "orgId": { "type": "string" },
+                "projectId": { "type": "string" },
+                "pipelineBranch": { "type": ["string", "null"] }
+            }
+        },
+        "authority": {
+            "type": "object",
+            "required": ["mayWriteWorkspace", "mayWriteKnowledgeBase", "mayEditRepos"],
+            "additionalProperties": false,
+            "properties": {
+                "mayWriteWorkspace": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "description": "Absolute workspace paths the agent may write to. Reads outside these are still permitted where not chmod-protected."
+                },
+                "mayWriteKnowledgeBase": { "type": "boolean" },
+                "mayEditRepos": { "type": "boolean" },
+                "writePolicy": {
+                    "type": "string",
+                    "enum": ["own-pages-only", "full-write", "read-only"]
+                }
+            }
+        },
+        "knowledgeBase": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "spaceSlug": { "type": "string" }
+            }
+        },
+        "inputs": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "hasRetryContext": { "type": "boolean", "description": "true when inputs/prior-attempt/ exists (attempt >= 2)." },
+                "hasUpstream": { "type": "boolean", "description": "true when inputs/upstream/ exists with prior-phase artifacts." },
+                "upstreamPhases": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "description": "Phase keys present under inputs/upstream/."
+                }
+            }
+        }
+    }
+}

package/dist/schemas/xema/index.d.ts

@@ -0,0 +1,8 @@
+export type XemaSchemaName = 'analysis' | 'clarification-contract' | 'context' | 'manifest' | 'review-history';
+export declare const XEMA_SCHEMAS: Record<string, Record<string, unknown>>;
+export declare function getXemaSchema(name: string): Record<string, unknown> | null;
+export declare function listXemaSchemas(): Array<{
+    name: string;
+    $id: string;
+}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/schemas/xema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/xema/index.ts"],"names":[],"mappings":"AAsBA,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,wBAAwB,GACxB,SAAS,GACT,UAAU,GACV,gBAAgB,CAAC;AAOrB,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMhE,CAAC;AAGF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAE1E;AAGD,wBAAgB,eAAe,IAAI,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAKtE"}

package/dist/schemas/xema/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XEMA_SCHEMAS = void 0;
+exports.getXemaSchema = getXemaSchema;
+exports.listXemaSchemas = listXemaSchemas;
+const analysis_json_1 = __importDefault(require("./analysis.json"));
+const clarification_contract_json_1 = __importDefault(require("./clarification-contract.json"));
+const context_json_1 = __importDefault(require("./context.json"));
+const manifest_json_1 = __importDefault(require("./manifest.json"));
+const review_history_json_1 = __importDefault(require("./review-history.json"));
+exports.XEMA_SCHEMAS = {
+    analysis: analysis_json_1.default,
+    'clarification-contract': clarification_contract_json_1.default,
+    context: context_json_1.default,
+    manifest: manifest_json_1.default,
+    'review-history': review_history_json_1.default,
+};
+function getXemaSchema(name) {
+    return exports.XEMA_SCHEMAS[name] ?? null;
+}
+function listXemaSchemas() {
+    return Object.entries(exports.XEMA_SCHEMAS).map(([name, schema]) => {
+        const $id = typeof schema.$id === 'string' ? schema.$id : `urn:xema:${name}`;
+        return { name, $id };
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/schemas/xema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/schemas/xema/index.ts"],"names":[],"mappings":";;;;;;AA2CA,sCAEC;AAGD,0CAKC;AAtCD,oEAAuC;AACvC,gGAAkE;AAClE,kEAAqC;AACrC,oEAAuC;AACvC,gFAAkD;AAerC,QAAA,YAAY,GAA4C;IACnE,QAAQ,EAAE,uBAAmC;IAC7C,wBAAwB,EAAE,qCAAgD;IAC1E,OAAO,EAAE,sBAAkC;IAC3C,QAAQ,EAAE,uBAAmC;IAC7C,gBAAgB,EAAE,6BAAwC;CAC3D,CAAC;AAGF,SAAgB,aAAa,CAAC,IAAY;IACxC,OAAO,oBAAY,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACpC,CAAC;AAGD,SAAgB,eAAe;IAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,oBAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QACzD,MAAM,GAAG,GAAG,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC;QAC7E,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/schemas/xema/manifest.json

@@ -0,0 +1,32 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schemas.xema.dev/manifest",
+    "title": "Unit / Coordinator Output Manifest",
+    "description": "Schema for /workspace/deliverables/manifest.json — list of pages the orchestrator should harvest. Written LAST by unit workers and coordinators.",
+    "type": "object",
+    "required": ["pages"],
+    "additionalProperties": false,
+    "properties": {
+        "pages": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["slug", "title"],
+                "additionalProperties": false,
+                "properties": {
+                    "slug": {
+                        "type": "string",
+                        "pattern": "^[a-z0-9][a-z0-9-]*$",
+                        "description": "Kebab-case page slug — also the filename under deliverables/pages/."
+                    },
+                    "title": { "type": "string" },
+                    "parentSlug": {
+                        "type": "string",
+                        "description": "Must reference another page slug in the same manifest."
+                    }
+                }
+            }
+        },
+        "status": { "type": "string", "enum": ["complete", "partial"] }
+    }
+}

package/dist/schemas/xema/review-history.json

@@ -0,0 +1,42 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schemas.xema.dev/review-history",
+    "title": "Retry Review History",
+    "description": "Structured shape the orchestrator writes to /workspace/inputs/prior-attempt/review-history.md. The file itself is markdown; this schema documents the source JSON the writer consumes.",
+    "type": "object",
+    "required": ["attempt", "priorVerdict", "mustFix"],
+    "additionalProperties": false,
+    "properties": {
+        "attempt": { "type": "integer", "minimum": 2 },
+        "priorVerdict": { "type": "string", "enum": ["rejected", "conditional"] },
+        "mustFix": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["severity", "findingId", "summary"],
+                "additionalProperties": true,
+                "properties": {
+                    "severity": { "type": "string", "enum": ["BLOCKING", "MAJOR", "MINOR"] },
+                    "findingId": { "type": "string" },
+                    "summary": { "type": "string", "description": "One-line description of what's wrong and where." },
+                    "targetDeliverable": { "type": "string" },
+                    "route": { "type": "object" }
+                }
+            }
+        },
+        "alreadyVerifiedOk": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "Things accepted in prior attempt — keep stable. E.g. 'Requirement IDs FR-001..FR-011 accepted — do not renumber'."
+        },
+        "doNotChange": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "Hard constraints. E.g. 'Page slug req-api-overview must remain stable'."
+        },
+        "reviewerNotes": {
+            "type": "array",
+            "items": { "type": "string" }
+        }
+    }
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@xemahq/platform-common",
+  "version": "0.1.3",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@nestjs/common": ">=10",
+    "@nestjs/core": ">=10",
+    "@nestjs/platform-express": ">=10",
+    "@nestjs/swagger": ">=7",
+    "rxjs": ">=7"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/platform-express": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@xemahq/event-hub-client": "^8.3.1",
+    "cloudevents": "^8.0.2",
+    "jwks-rsa": "^3.2.2",
+    "zod": "^4.3.6",
+    "@xemahq/llm-gateway-contracts": "0.1.1",
+    "@xemahq/agent-workspace-contracts": "0.1.1",
+    "@xemahq/subject-contracts": "0.1.0",
+    "@xemahq/workflow-contracts": "0.1.1"
+  },
+  "devDependencies": {
+    "@nestjs/common": "11.1.13",
+    "@nestjs/config": "4.0.2",
+    "@nestjs/core": "11.1.13",
+    "@nestjs/platform-express": "11.1.13",
+    "@nestjs/swagger": "11.2.6",
+    "@nestjs/testing": "11.1.13",
+    "@xemahq/event-hub-client": "^8.3.1",
+    "@types/express": "5.0.3",
+    "@types/jest": "^30.0.0",
+    "@types/node": "25.2.3",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.14.4",
+    "jest": "^30.3.0",
+    "prettier": "3.6.2",
+    "reflect-metadata": "0.2.2",
+    "rxjs": "7.8.2",
+    "ts-jest": "^29.4.9",
+    "typescript": "5.9.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "xema-source": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./dist/*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./dist/lib/*": {
+      "types": "./dist/lib/*.d.ts",
+      "default": "./dist/lib/*.js"
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "jest --config jest.config.ts"
+  }
+}