@dakkitor/api-contracts 1.5.0 → 1.7.0

package/dist/outreach/lab-outreach.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lab-outreach.contract.d.ts","sourceRoot":"","sources":["../../contracts/outreach/lab-outreach.contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;EAOhB,CAAC;AAEZ,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;IAiBxC,CAAC;AAEL,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMlC,CAAC;AAEZ,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQ3B,CAAC;AAEZ,eAAO,MAAM,yBAAyB;;;;;;;;;EAK3B,CAAC;AAEZ,eAAO,MAAM,uBAAuB;;;;;;EAIzB,CAAC;AAEZ,eAAO,MAAM,2BAA2B;;;;;;EAI7B,CAAC;AAEZ,eAAO,MAAM,4BAA4B;;;;;;;;;;;;EAM9B,CAAC;AAqBZ;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI1B,CAAC;AAEZ,eAAO,MAAM,4BAA4B;;;;;;;;;EAK9B,CAAC;AAEZ,eAAO,MAAM,kCAAkC;;;;;;EAIpC,CAAC;AAEZ,eAAO,MAAM,mCAAmC;;;;;;;;;;EAGnC,CAAC;AAEd,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgE/B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AACtD,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,gCAAgC,CACxC,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/dist/outreach/lab-outreach.contract.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.labOutreachContract = exports.LabRunAuthorizationPathParamsSchema = exports.LabOutreachRequestPathParamsSchema = exports.CompleteLabRunResponseSchema = exports.CompleteLabRunBodySchema = exports.LabRunDeliveryEvidenceSchema = exports.AbandonLabRunResponseSchema = exports.AbandonLabRunBodySchema = exports.StartLabRunResponseSchema = exports.LabRunAuthorizationSchema = exports.LabRunAuthorizationRequestSchema = exports.LabRunAuthorizationRoutesSchema = exports.LabRouteSchema = void 0;
+const core_1 = require("@ts-rest/core");
+const zod_1 = require("zod");
+const error_schemas_1 = require("../common/error-schemas");
+const c = (0, core_1.initContract)();
+const Sha256Schema = zod_1.z.string().regex(/^[a-f0-9]{64}$/);
+exports.LabRouteSchema = zod_1.z
+    .object({
+    senderLocalDeviceKey: zod_1.z.string().min(1),
+    targetLabDeviceId: zod_1.z.string().uuid(),
+    targetIdentityVersion: zod_1.z.number().int().positive(),
+    renderedBodySha256: Sha256Schema,
+})
+    .strict();
+exports.LabRunAuthorizationRoutesSchema = zod_1.z
+    .array(exports.LabRouteSchema)
+    .min(1)
+    .max(10)
+    .superRefine((routes, context) => {
+    const seenSenders = new Set();
+    for (const [index, route] of routes.entries()) {
+        if (seenSenders.has(route.senderLocalDeviceKey)) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'Authorization route senders must be unique',
+                path: [index, 'senderLocalDeviceKey'],
+            });
+        }
+        seenSenders.add(route.senderLocalDeviceKey);
+    }
+});
+exports.LabRunAuthorizationRequestSchema = zod_1.z
+    .object({
+    campaignId: zod_1.z.string().uuid(),
+    fleetRevision: zod_1.z.number().int().nonnegative(),
+    routes: exports.LabRunAuthorizationRoutesSchema,
+})
+    .strict();
+exports.LabRunAuthorizationSchema = zod_1.z
+    .object({
+    authorizationId: zod_1.z.string().uuid(),
+    campaignId: zod_1.z.string().uuid(),
+    fleetRevision: zod_1.z.number().int().nonnegative(),
+    routes: exports.LabRunAuthorizationRoutesSchema,
+    expiresAt: zod_1.z.string().datetime(),
+})
+    .strict();
+exports.StartLabRunResponseSchema = zod_1.z
+    .object({
+    authorizationId: zod_1.z.string().uuid(),
+    startedAt: zod_1.z.string().datetime(),
+})
+    .strict();
+exports.AbandonLabRunBodySchema = zod_1.z
+    .object({
+    reason: zod_1.z.enum(['FAILED', 'CANCELED', 'START_TIMEOUT']),
+})
+    .strict();
+exports.AbandonLabRunResponseSchema = zod_1.z
+    .object({
+    abandoned: zod_1.z.literal(true),
+})
+    .strict();
+exports.LabRunDeliveryEvidenceSchema = zod_1.z
+    .object({
+    routeIndex: zod_1.z.number().int().nonnegative(),
+    deliveryJournalId: zod_1.z.string().uuid(),
+    evidenceSha256: Sha256Schema,
+})
+    .strict();
+const CompleteLabRunEvidenceSchema = zod_1.z
+    .array(exports.LabRunDeliveryEvidenceSchema)
+    .min(1)
+    .max(10)
+    .superRefine((evidence, context) => {
+    const seenRouteIndexes = new Set();
+    for (const [index, item] of evidence.entries()) {
+        if (seenRouteIndexes.has(item.routeIndex)) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                message: 'Delivery evidence route indexes must be unique',
+                path: [index, 'routeIndex'],
+            });
+        }
+        seenRouteIndexes.add(item.routeIndex);
+    }
+});
+/**
+ * The service verifies that this contains exactly one item for each authorized
+ * route, because that count and route set are authorization-owned state.
+ */
+exports.CompleteLabRunBodySchema = zod_1.z
+    .object({
+    evidence: CompleteLabRunEvidenceSchema,
+})
+    .strict();
+exports.CompleteLabRunResponseSchema = zod_1.z
+    .object({
+    completed: zod_1.z.literal(true),
+    completedAt: zod_1.z.string().datetime(),
+})
+    .strict();
+exports.LabOutreachRequestPathParamsSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid(),
+})
+    .strict();
+exports.LabRunAuthorizationPathParamsSchema = exports.LabOutreachRequestPathParamsSchema.extend({
+    authorizationId: zod_1.z.string().uuid(),
+}).strict();
+exports.labOutreachContract = c.router({
+    authorize: {
+        method: 'POST',
+        path: '/outreach/requests/:id/lab-authorizations',
+        pathParams: exports.LabOutreachRequestPathParamsSchema,
+        body: exports.LabRunAuthorizationRequestSchema,
+        responses: {
+            201: exports.LabRunAuthorizationSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Authorize a bounded Relay Lab run',
+        metadata: { tags: ['Outreach'] },
+    },
+    start: {
+        method: 'POST',
+        path: '/outreach/requests/:id/lab-authorizations/:authorizationId/start',
+        pathParams: exports.LabRunAuthorizationPathParamsSchema,
+        body: zod_1.z.object({}).strict(),
+        responses: {
+            200: exports.StartLabRunResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Mark an authorized Relay Lab run as started',
+        metadata: { tags: ['Outreach'] },
+    },
+    abandon: {
+        method: 'POST',
+        path: '/outreach/requests/:id/lab-authorizations/:authorizationId/abandon',
+        pathParams: exports.LabRunAuthorizationPathParamsSchema,
+        body: exports.AbandonLabRunBodySchema,
+        responses: {
+            200: exports.AbandonLabRunResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Abandon an uncompleted Relay Lab run',
+        metadata: { tags: ['Outreach'] },
+    },
+    complete: {
+        method: 'POST',
+        path: '/outreach/requests/:id/lab-authorizations/:authorizationId/complete',
+        pathParams: exports.LabRunAuthorizationPathParamsSchema,
+        body: exports.CompleteLabRunBodySchema,
+        responses: {
+            200: exports.CompleteLabRunResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Complete a Relay Lab run with delivery evidence',
+        metadata: { tags: ['Outreach'] },
+    },
+}, {
+    pathPrefix: '/v2',
+    commonResponses: {
+        400: error_schemas_1.ErrorResponseSchema,
+        401: error_schemas_1.ErrorResponseSchema,
+        403: error_schemas_1.ErrorResponseSchema,
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});

package/dist/outreach/lab-outreach.contract.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lab-outreach.contract.spec.d.ts.map

package/dist/outreach/lab-outreach.contract.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lab-outreach.contract.spec.d.ts","sourceRoot":"","sources":["../../contracts/outreach/lab-outreach.contract.spec.ts"],"names":[],"mappings":""}

package/dist/outreach/lab-outreach.contract.spec.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bun_test_1 = require("bun:test");
+const lab_outreach_contract_1 = require("./lab-outreach.contract");
+const index_1 = require("../index");
+const requestId = '11111111-1111-4111-8111-111111111111';
+const campaignId = '22222222-2222-4222-8222-222222222222';
+const authorizationId = '33333333-3333-4333-8333-333333333333';
+const labDeviceId = '44444444-4444-4444-8444-444444444444';
+const route = {
+    senderLocalDeviceKey: 'phone-01',
+    targetLabDeviceId: labDeviceId,
+    targetIdentityVersion: 1,
+    renderedBodySha256: 'a'.repeat(64),
+};
+(0, bun_test_1.describe)('Lab outreach authorization schemas', () => {
+    (0, bun_test_1.it)('requires between one and ten Lab-only routes', () => {
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRunAuthorizationRequestSchema.safeParse({
+            campaignId,
+            fleetRevision: 43,
+            routes: [],
+        }).success).toBe(false);
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRunAuthorizationRequestSchema.safeParse({
+            campaignId,
+            fleetRevision: 43,
+            routes: Array.from({ length: 11 }, () => route),
+        }).success).toBe(false);
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRunAuthorizationRequestSchema.parse({
+            campaignId,
+            fleetRevision: 43,
+            routes: [route],
+        }).routes).toEqual([route]);
+    });
+    (0, bun_test_1.it)('does not permit worker fields on a Lab route', () => {
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRouteSchema.safeParse({ ...route, workerId: requestId }).success).toBe(false);
+    });
+    (0, bun_test_1.it)('requires distinct local senders in every authorization route array', () => {
+        const duplicateSenderRoutes = [
+            route,
+            {
+                ...route,
+                targetLabDeviceId: requestId,
+                targetIdentityVersion: 2,
+            },
+        ];
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRunAuthorizationRequestSchema.safeParse({
+            campaignId,
+            fleetRevision: 43,
+            routes: duplicateSenderRoutes,
+        }).success).toBe(false);
+        (0, bun_test_1.expect)(lab_outreach_contract_1.LabRunAuthorizationSchema.safeParse({
+            authorizationId,
+            campaignId,
+            fleetRevision: 43,
+            routes: duplicateSenderRoutes,
+            expiresAt: '2026-08-02T09:00:00.000Z',
+        }).success).toBe(false);
+    });
+    (0, bun_test_1.it)('requires distinct delivery evidence for each authorized route index', () => {
+        (0, bun_test_1.expect)(lab_outreach_contract_1.CompleteLabRunBodySchema.safeParse({
+            evidence: [
+                {
+                    routeIndex: 0,
+                    deliveryJournalId: requestId,
+                    evidenceSha256: 'b'.repeat(64),
+                },
+                {
+                    routeIndex: 0,
+                    deliveryJournalId: campaignId,
+                    evidenceSha256: 'c'.repeat(64),
+                },
+            ],
+        }).success).toBe(false);
+    });
+});
+(0, bun_test_1.describe)('labOutreachContract routes', () => {
+    (0, bun_test_1.it)('uses the request and authorization identifiers consistently', () => {
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.authorize.path).toBe('/v2/outreach/requests/:id/lab-authorizations');
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.start.path).toBe('/v2/outreach/requests/:id/lab-authorizations/:authorizationId/start');
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.abandon.path).toBe('/v2/outreach/requests/:id/lab-authorizations/:authorizationId/abandon');
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.complete.path).toBe('/v2/outreach/requests/:id/lab-authorizations/:authorizationId/complete');
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.start.pathParams).toBe(lab_outreach_contract_1.labOutreachContract.complete.pathParams);
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.authorize.pathParams.parse({ id: requestId })).toEqual({ id: requestId });
+        (0, bun_test_1.expect)(lab_outreach_contract_1.labOutreachContract.complete.pathParams.parse({
+            id: requestId,
+            authorizationId,
+        })).toEqual({ id: requestId, authorizationId });
+        (0, bun_test_1.expect)(index_1.apiContractRouter.LabOutreach.authorize.path).toBe('/v2/outreach/requests/:id/lab-authorizations');
+    });
+});