@dakkitor/api-contracts 1.1.10 → 1.1.12

package/dist/files/files.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.contract.d.ts","sourceRoot":"","sources":["../../contracts/files/files.contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,uBAAuB;;;;;;;;;;;;EASM,CAAC;AAE3C,eAAO,MAAM,+BAA+B;;;;;;;;;EAUM,CAAC;AAEnD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6CM,CAAC;AAEtC,eAAO,MAAM,6BAA6B;;;;;;;;;EAKM,CAAC;AAEjD,eAAO,MAAM,gBAAgB;;;;;;EAQM,CAAC;AAEpC,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAEM,CAAC;AAE3C,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,+BAA+B,CACvC,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqHzB,CAAC"}

package/dist/files/files.contract.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filesContract = exports.FileResponseArraySchema = exports.UpdateFileSchema = exports.FileDownloadUrlResponseSchema = exports.FileResponseSchema = exports.GenerateUploadUrlResponseSchema = exports.GenerateUploadUrlSchema = 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)();
+exports.GenerateUploadUrlSchema = zod_1.z
+    .object({
+    fileName: zod_1.z
+        .string()
+        .min(1)
+        .describe('The name of the file to be uploaded.'),
+    contentType: zod_1.z.string().min(1).describe('The MIME type of the file.'),
+    size: zod_1.z.number().min(1).describe('The size of the file in bytes.'),
+})
+    .openapi({ title: 'GenerateUploadUrl' });
+exports.GenerateUploadUrlResponseSchema = zod_1.z
+    .object({
+    uploadUrl: zod_1.z
+        .string()
+        .describe('The pre-signed URL for the file upload (PUT request).'),
+    fileId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The unique identifier of the created file record.'),
+})
+    .openapi({ title: 'GenerateUploadUrlResponse' });
+exports.FileResponseSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('The unique identifier of the file record.'),
+    originalName: zod_1.z
+        .string()
+        .describe('The original filename as uploaded by the user.'),
+    storageKey: zod_1.z
+        .string()
+        .describe('The unique storage key where the file is stored.'),
+    mimeType: zod_1.z.string().describe('The MIME type of the file.'),
+    size: zod_1.z.number().describe('The size of the file in bytes.'),
+    location: zod_1.z
+        .string()
+        .describe('The storage location or path where the file is stored.'),
+    storageProvider: zod_1.z
+        .string()
+        .describe('The storage provider used (local, s3, azure, gcp).'),
+    description: zod_1.z
+        .string()
+        .nullable()
+        .describe('Optional user-provided description of the file.'),
+    entityType: zod_1.z
+        .string()
+        .nullable()
+        .describe('The type of entity this file is attached to (WorkerQualification, ShareCode, Worker, etc.).'),
+    entityId: zod_1.z
+        .string()
+        .uuid()
+        .nullable()
+        .describe('The UUID of the entity this file is attached to.'),
+    userId: zod_1.z
+        .string()
+        .uuid()
+        .describe('The UUID of the user who created this file.'),
+    createdAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The timestamp when the file record was created.'),
+    updatedAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The timestamp when the file record was last updated.'),
+})
+    .openapi({ title: 'FileResponse' });
+exports.FileDownloadUrlResponseSchema = zod_1.z
+    .object({
+    url: zod_1.z.string().describe('Pre-signed URL to download the file'),
+    mimeType: zod_1.z.string().describe('MIME type of the file'),
+})
+    .openapi({ title: 'FileDownloadUrlResponse' });
+exports.UpdateFileSchema = zod_1.z
+    .object({
+    description: zod_1.z
+        .string()
+        .max(500)
+        .optional()
+        .describe('Optional description of the file.'),
+})
+    .openapi({ title: 'UpdateFile' });
+exports.FileResponseArraySchema = zod_1.z
+    .array(exports.FileResponseSchema)
+    .openapi({ title: 'FileResponseArray' });
+exports.filesContract = c.router({
+    generateUploadUrl: {
+        method: 'POST',
+        path: '/v2/files/generate-upload-url',
+        body: exports.GenerateUploadUrlSchema,
+        responses: {
+            201: exports.GenerateUploadUrlResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Generate a pre-signed URL for file upload',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    findAll: {
+        method: 'GET',
+        path: '/v2/files',
+        responses: {
+            200: exports.FileResponseArraySchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Get all files',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    findByEntity: {
+        method: 'GET',
+        path: '/v2/files/entity/:entityType/:entityId',
+        pathParams: zod_1.z.object({
+            entityType: zod_1.z.string().describe('Type of entity'),
+            entityId: zod_1.z.string().uuid().describe('UUID of the entity'),
+        }),
+        responses: {
+            200: exports.FileResponseArraySchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Get all files for a specific entity',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    findOne: {
+        method: 'GET',
+        path: '/v2/files/:id',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('File ID'),
+        }),
+        responses: {
+            200: exports.FileResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Get a file metadata by ID',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    getDownloadUrl: {
+        method: 'GET',
+        path: '/v2/files/:id/download',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('File ID'),
+        }),
+        responses: {
+            200: exports.FileDownloadUrlResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Get a pre-signed URL to download a file',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    update: {
+        method: 'PATCH',
+        path: '/v2/files/:id',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('File ID'),
+        }),
+        body: exports.UpdateFileSchema,
+        responses: {
+            200: exports.FileResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Update a file metadata',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+    remove: {
+        method: 'DELETE',
+        path: '/v2/files/:id',
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('File ID'),
+        }),
+        body: zod_1.z.object({}),
+        responses: {
+            204: zod_1.z.undefined(),
+            404: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+        },
+        summary: 'Delete a file',
+        metadata: {
+            tags: ['Files'],
+        },
+    },
+}, {
+    commonResponses: {
+        400: error_schemas_1.ErrorResponseSchema,
+        401: error_schemas_1.ErrorResponseSchema,
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});

package/dist/health/health.contract.d.ts

@@ -0,0 +1,161 @@
+import { z } from 'zod';
+export declare const HealthCheckStatusSchema: z.ZodEnum<["error", "ok", "shutting_down"]>;
+export declare const HealthIndicatorResultSchema: z.ZodRecord<z.ZodString, z.ZodAny>;
+export declare const HealthCheckResultSchema: z.ZodObject<{
+    status: z.ZodEnum<["error", "ok", "shutting_down"]>;
+    info: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    details: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    details: Record<string, any>;
+    status: "error" | "ok" | "shutting_down";
+    error?: Record<string, any> | undefined;
+    info?: Record<string, any> | undefined;
+}, {
+    details: Record<string, any>;
+    status: "error" | "ok" | "shutting_down";
+    error?: Record<string, any> | undefined;
+    info?: Record<string, any> | undefined;
+}>;
+export type HealthCheckStatus = z.infer<typeof HealthCheckStatusSchema>;
+export type HealthIndicatorResult = z.infer<typeof HealthIndicatorResultSchema>;
+export type HealthCheckResult = z.infer<typeof HealthCheckResultSchema>;
+export declare const healthContract: {
+    check: {
+        metadata: {
+            tags: string[];
+            isPublic: boolean;
+        };
+        summary: "Check API health";
+        method: "GET";
+        path: "/v2/health";
+        responses: {
+            500: z.ZodObject<{
+                statusCode: z.ZodNumber;
+                message: z.ZodString;
+                code: z.ZodString;
+                details: z.ZodOptional<z.ZodUnknown>;
+                timestamp: z.ZodString;
+                path: z.ZodString;
+                correlationId: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: number;
+                message: string;
+                code: string;
+                timestamp: string;
+                path: string;
+                details?: unknown;
+                correlationId?: string | undefined;
+            }, {
+                statusCode: number;
+                message: string;
+                code: string;
+                timestamp: string;
+                path: string;
+                details?: unknown;
+                correlationId?: string | undefined;
+            }>;
+            200: z.ZodObject<{
+                status: z.ZodEnum<["error", "ok", "shutting_down"]>;
+                info: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                details: z.ZodRecord<z.ZodString, z.ZodAny>;
+            }, "strip", z.ZodTypeAny, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }>;
+            503: z.ZodObject<{
+                status: z.ZodEnum<["error", "ok", "shutting_down"]>;
+                info: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                details: z.ZodRecord<z.ZodString, z.ZodAny>;
+            }, "strip", z.ZodTypeAny, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }>;
+        };
+    };
+    liveness: {
+        metadata: {
+            tags: string[];
+            isPublic: boolean;
+        };
+        summary: "Liveness check";
+        method: "GET";
+        path: "/v2/health/live";
+        responses: {
+            500: z.ZodObject<{
+                statusCode: z.ZodNumber;
+                message: z.ZodString;
+                code: z.ZodString;
+                details: z.ZodOptional<z.ZodUnknown>;
+                timestamp: z.ZodString;
+                path: z.ZodString;
+                correlationId: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                statusCode: number;
+                message: string;
+                code: string;
+                timestamp: string;
+                path: string;
+                details?: unknown;
+                correlationId?: string | undefined;
+            }, {
+                statusCode: number;
+                message: string;
+                code: string;
+                timestamp: string;
+                path: string;
+                details?: unknown;
+                correlationId?: string | undefined;
+            }>;
+            200: z.ZodObject<{
+                status: z.ZodEnum<["error", "ok", "shutting_down"]>;
+                info: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                details: z.ZodRecord<z.ZodString, z.ZodAny>;
+            }, "strip", z.ZodTypeAny, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }>;
+            503: z.ZodObject<{
+                status: z.ZodEnum<["error", "ok", "shutting_down"]>;
+                info: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+                details: z.ZodRecord<z.ZodString, z.ZodAny>;
+            }, "strip", z.ZodTypeAny, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }, {
+                details: Record<string, any>;
+                status: "error" | "ok" | "shutting_down";
+                error?: Record<string, any> | undefined;
+                info?: Record<string, any> | undefined;
+            }>;
+        };
+    };
+};
+//# sourceMappingURL=health.contract.d.ts.map

package/dist/health/health.contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.contract.d.ts","sourceRoot":"","sources":["../../contracts/health/health.contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,uBAAuB,6CAEM,CAAC;AAE3C,eAAO,MAAM,2BAA2B,oCAAoB,CAAC;AAE7D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;EAaM,CAAC;AAE3C,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmC1B,CAAC"}

package/dist/health/health.contract.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.healthContract = exports.HealthCheckResultSchema = exports.HealthIndicatorResultSchema = exports.HealthCheckStatusSchema = 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)();
+exports.HealthCheckStatusSchema = zod_1.z
+    .enum(['error', 'ok', 'shutting_down'])
+    .openapi({ title: 'HealthCheckStatus' });
+exports.HealthIndicatorResultSchema = zod_1.z.record(zod_1.z.any());
+exports.HealthCheckResultSchema = zod_1.z
+    .object({
+    status: exports.HealthCheckStatusSchema.describe('Health status'),
+    info: exports.HealthIndicatorResultSchema.optional().describe('Information about the health check'),
+    error: exports.HealthIndicatorResultSchema.optional().describe('Error details if any'),
+    details: exports.HealthIndicatorResultSchema.describe('Detailed health check results'),
+})
+    .openapi({ title: 'HealthCheckResult' });
+exports.healthContract = c.router({
+    check: {
+        method: 'GET',
+        path: '/health',
+        responses: {
+            200: exports.HealthCheckResultSchema,
+            503: exports.HealthCheckResultSchema, // Health check might return 503 if unhealthy
+        },
+        summary: 'Check API health',
+        metadata: {
+            tags: ['Health'],
+            isPublic: true,
+        },
+    },
+    liveness: {
+        method: 'GET',
+        path: '/health/live',
+        responses: {
+            200: exports.HealthCheckResultSchema,
+            503: exports.HealthCheckResultSchema,
+        },
+        summary: 'Liveness check',
+        metadata: {
+            tags: ['Health'],
+            isPublic: true,
+        },
+    },
+}, {
+    pathPrefix: '/v2',
+    commonResponses: {
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});