@dakkitor/api-contracts 1.1.3 → 1.1.5

package/dist/common/openapi-metadata.js

@@ -0,0 +1,155 @@
+"use strict";
+/**
+ * Project: Internal Recruitment Platform API
+ * File: openapi-metadata.ts
+ *
+ * Description: TypeScript types for OpenAPI metadata that can be attached to ts-rest routes.
+ * This metadata structure matches the patterns from api-responses.decorator.ts and will be
+ * used to post-process the generated OpenAPI spec.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStandardMetadata = exports.STANDARD_ERROR_RESPONSES = void 0;
+/**
+ * Standard error response examples and descriptions
+ */
+exports.STANDARD_ERROR_RESPONSES = {
+    400: {
+        description: 'Bad Request. The request could not be understood by the server due to malformed syntax or invalid data.',
+        example: {
+            statusCode: 400,
+            message: 'Input validation failed or request is malformed.',
+            code: 'VALIDATION_ERROR',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+    401: {
+        description: 'Unauthorized. The user is not authenticated or token is missing/invalid.',
+        example: {
+            statusCode: 401,
+            message: 'Authentication required or token is invalid.',
+            code: 'UNAUTHORIZED',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+    403: {
+        description: 'Forbidden. The user does not have the necessary permissions for this resource.',
+        example: {
+            statusCode: 403,
+            message: 'Access to this resource is forbidden.',
+            code: 'FORBIDDEN',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+    404: {
+        description: 'Not Found. The requested resource could not be found.',
+        example: {
+            statusCode: 404,
+            message: 'The requested resource could not be found.',
+            code: 'RESOURCE_NOT_FOUND',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+    409: {
+        description: 'Conflict. The resource already exists.',
+        example: {
+            statusCode: 409,
+            message: 'A conflict occurred with the current state of the resource.',
+            code: 'RESOURCE_CONFLICT',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+    500: {
+        description: 'Internal Server Error. An unexpected error occurred on the server.',
+        example: {
+            statusCode: 500,
+            message: 'An unexpected error occurred on the server.',
+            code: 'INTERNAL_SERVER_ERROR',
+            timestamp: '2024-01-01T12:00:00.000Z',
+            path: '/v2/example-endpoint',
+        },
+    },
+};
+/**
+ * Helper to create metadata for standard CRUD operations
+ */
+exports.createStandardMetadata = {
+    /**
+     * Metadata for CREATE operations (201)
+     */
+    create: (customResponses) => ({
+        responses: {
+            201: {
+                description: 'Resource created successfully.',
+            },
+            ...exports.STANDARD_ERROR_RESPONSES,
+            409: exports.STANDARD_ERROR_RESPONSES[409],
+            ...customResponses,
+        },
+    }),
+    /**
+     * Metadata for FIND ONE operations (200)
+     */
+    findOne: (customResponses) => ({
+        responses: {
+            200: {
+                description: 'Resource retrieved successfully.',
+            },
+            ...exports.STANDARD_ERROR_RESPONSES,
+            404: exports.STANDARD_ERROR_RESPONSES[404],
+            ...customResponses,
+        },
+    }),
+    /**
+     * Metadata for FIND ALL operations (200)
+     */
+    findAll: (customResponses) => ({
+        responses: {
+            200: {
+                description: 'Resources retrieved successfully.',
+            },
+            ...exports.STANDARD_ERROR_RESPONSES,
+            ...customResponses,
+        },
+    }),
+    /**
+     * Metadata for UPDATE operations (200)
+     */
+    update: (customResponses) => ({
+        responses: {
+            200: {
+                description: 'Resource updated successfully.',
+            },
+            ...exports.STANDARD_ERROR_RESPONSES,
+            404: exports.STANDARD_ERROR_RESPONSES[404],
+            409: {
+                description: 'Conflict. The resource already exists or the update causes a conflict.',
+                example: {
+                    statusCode: 409,
+                    message: 'A conflict occurred with the current state of the resource during update.',
+                    code: 'RESOURCE_CONFLICT',
+                    timestamp: '2024-01-01T12:00:00.000Z',
+                    path: '/v2/example-endpoint',
+                },
+            },
+            ...customResponses,
+        },
+    }),
+    /**
+     * Metadata for DELETE operations (204)
+     */
+    delete: (customResponses) => ({
+        responses: {
+            204: {
+                description: 'Resource deleted successfully.',
+            },
+            ...exports.STANDARD_ERROR_RESPONSES,
+            404: exports.STANDARD_ERROR_RESPONSES[404],
+            ...customResponses,
+        },
+    }),
+};

package/dist/common/pagination.schema.d.ts

@@ -1,18 +1,24 @@
 import { z } from 'zod';
 export declare const createPaginatedResponseSchema: <T extends z.ZodTypeAny>(itemSchema: T) => z.ZodObject<{
-    data: z.ZodArray<T, "many">;
-    total: z.ZodNumber;
+    items: z.ZodArray<T, "many">;
+    totalCount: z.ZodNumber;
     limit: z.ZodNumber;
     skip: z.ZodNumber;
+    currentPage: z.ZodNumber;
+    totalPages: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    data: T["_output"][];
-    total: number;
+    items: T["_output"][];
+    totalCount: number;
     limit: number;
     skip: number;
+    currentPage: number;
+    totalPages: number;
 }, {
-    data: T["_input"][];
-    total: number;
+    items: T["_input"][];
+    totalCount: number;
     limit: number;
     skip: number;
+    currentPage: number;
+    totalPages: number;
 }>;
 //# sourceMappingURL=pagination.schema.d.ts.map

package/dist/common/pagination.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pagination.schema.d.ts","sourceRoot":"","sources":["../../contracts/common/pagination.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,6BAA6B,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAClE,YAAY,CAAC;;;;;;;;;;;;;;;EAQd,CAAC"}
+{"version":3,"file":"pagination.schema.d.ts","sourceRoot":"","sources":["../../contracts/common/pagination.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,6BAA6B,GAAI,CAAC,SAAS,CAAC,CAAC,UAAU,EAClE,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;EAUd,CAAC"}

package/dist/common/pagination.schema.js

@@ -4,10 +4,12 @@ exports.createPaginatedResponseSchema = void 0;
 const zod_1 = require("zod");
 const createPaginatedResponseSchema = (itemSchema) => {
     return zod_1.z.object({
-        data: zod_1.z.array(itemSchema).describe('Records'),
-        total: zod_1.z.number().describe('Total count'),
-        limit: zod_1.z.number().describe('Results per page'),
-        skip: zod_1.z.number().describe('Records skipped'),
+        items: zod_1.z.array(itemSchema).describe('Array of items for the current page'),
+        totalCount: zod_1.z.number().describe('Total number of items available'),
+        limit: zod_1.z.number().describe('Number of items per page'),
+        skip: zod_1.z.number().describe('Number of items skipped (offset)'),
+        currentPage: zod_1.z.number().describe('Current page number'),
+        totalPages: zod_1.z.number().describe('Total number of pages'),
     });
 };
 exports.createPaginatedResponseSchema = createPaginatedResponseSchema;