@deepintel-ltd/buildlink-api-contracts 0.2.23

package/contracts/transmittals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transmittals.d.ts","sourceRoot":"","sources":["../../../src/contracts/transmittals.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmBxB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8J/B,CAAC;AAGH,YAAY,EACV,wBAAwB,EACxB,WAAW,EACX,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,yBAAyB,CAAC"}

package/contracts/transmittals.js

@@ -0,0 +1,156 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { CuidSchema, JsonApiCollectionResponseSchema, JsonApiErrorResponseSchema, JsonApiResponseSchema, } from '../schemas/common';
+import { CreateTransmittalRequestSchema, TransmittalFiltersSchema, TransmittalQueryParamsSchema, TransmittalResourceSchema, TransmittalStatsSchema, UpdateTransmittalRequestSchema, } from '../schemas/transmittals';
+const c = initContract();
+export const transmittalsContract = c.router({
+    // ===== TRANSMITTAL MANAGEMENT =====
+    getTransmittals: {
+        method: 'GET',
+        path: '/projects/:projectId/transmittals',
+        pathParams: z.object({
+            projectId: CuidSchema,
+        }),
+        query: TransmittalFiltersSchema,
+        responses: {
+            200: JsonApiCollectionResponseSchema(TransmittalResourceSchema),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Get transmittals for a project with filtering and pagination',
+    },
+    createTransmittal: {
+        method: 'POST',
+        path: '/projects/:projectId/transmittals',
+        pathParams: z.object({
+            projectId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        body: CreateTransmittalRequestSchema,
+        responses: {
+            201: JsonApiResponseSchema(TransmittalResourceSchema),
+            400: JsonApiErrorResponseSchema,
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Create a new transmittal for a project',
+    },
+    getTransmittal: {
+        method: 'GET',
+        path: '/transmittals/:transmittalId',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        responses: {
+            200: JsonApiResponseSchema(TransmittalResourceSchema),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Get a specific transmittal by ID',
+    },
+    updateTransmittal: {
+        method: 'PUT',
+        path: '/transmittals/:transmittalId',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        body: UpdateTransmittalRequestSchema,
+        responses: {
+            200: JsonApiResponseSchema(TransmittalResourceSchema),
+            400: JsonApiErrorResponseSchema,
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Update a transmittal',
+    },
+    deleteTransmittal: {
+        method: 'DELETE',
+        path: '/transmittals/:transmittalId',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        responses: {
+            204: z.void(),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Delete a transmittal',
+    },
+    submitTransmittal: {
+        method: 'POST',
+        path: '/transmittals/:transmittalId/submit',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        body: z.object({}),
+        responses: {
+            200: JsonApiResponseSchema(TransmittalResourceSchema),
+            400: JsonApiErrorResponseSchema,
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Submit a transmittal for review',
+    },
+    reviewTransmittal: {
+        method: 'POST',
+        path: '/transmittals/:transmittalId/review',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        body: z.object({
+            status: z.enum(['APPROVED', 'REJECTED']),
+            reviewNotes: z.string().max(1000).optional(),
+        }),
+        responses: {
+            200: JsonApiResponseSchema(TransmittalResourceSchema),
+            400: JsonApiErrorResponseSchema,
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Review a transmittal (approve/reject)',
+    },
+    getTransmittalStats: {
+        method: 'GET',
+        path: '/projects/:projectId/transmittals/stats',
+        pathParams: z.object({
+            projectId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        responses: {
+            200: JsonApiResponseSchema(TransmittalStatsSchema),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Get transmittal statistics for a project',
+    },
+    acknowledgeTransmittal: {
+        method: 'PATCH',
+        path: '/transmittals/:transmittalId/acknowledge',
+        pathParams: z.object({
+            transmittalId: CuidSchema,
+        }),
+        query: TransmittalQueryParamsSchema,
+        body: z.object({}),
+        responses: {
+            200: JsonApiResponseSchema(TransmittalResourceSchema),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Acknowledge receipt of a transmittal',
+    },
+});
+//# sourceMappingURL=transmittals.js.map

package/contracts/transmittals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transmittals.js","sourceRoot":"","sources":["../../../src/contracts/transmittals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,UAAU,EACV,+BAA+B,EAC/B,0BAA0B,EAC1B,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,8BAA8B,EAC9B,wBAAwB,EACxB,4BAA4B,EAC5B,yBAAyB,EACzB,sBAAsB,EACtB,8BAA8B,GAC/B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,qCAAqC;IAErC,eAAe,EAAE;QACf,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,mCAAmC;QACzC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,KAAK,EAAE,wBAAwB;QAC/B,SAAS,EAAE;YACT,GAAG,EAAE,+BAA+B,CAAC,yBAAyB,CAAC;YAC/D,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,8DAA8D;KACxE;IAED,iBAAiB,EAAE;QACjB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,mCAAmC;QACzC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,8BAA8B;QACpC,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,wCAAwC;KAClD;IAED,cAAc,EAAE;QACd,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,kCAAkC;KAC5C;IAED,iBAAiB,EAAE;QACjB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,8BAA8B;QACpC,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,sBAAsB;KAChC;IAED,iBAAiB,EAAE;QACjB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,8BAA8B;QACpC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE;YACb,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,sBAAsB;KAChC;IAED,iBAAiB,EAAE;QACjB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,qCAAqC;QAC3C,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAClB,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,iCAAiC;KAC3C;IAED,iBAAiB,EAAE;QACjB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,qCAAqC;QAC3C,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YACb,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YACxC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;SAC7C,CAAC;QACF,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,uCAAuC;KACjD;IAED,mBAAmB,EAAE;QACnB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,yCAAyC;QAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,sBAAsB,CAAC;YAClD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,0CAA0C;KACpD;IAED,sBAAsB,EAAE;QACtB,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,0CAA0C;QAChD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;QACF,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAClB,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;YACrD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,sCAAsC;KAChD;CACF,CAAC,CAAC"}