@dakkitor/api-contracts 1.0.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"clients.contract.d.ts","sourceRoot":"","sources":["../../contracts/clients/clients.contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAgBxB,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBvB,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4B5B,CAAC;AAEJ,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;EAK7B,CAAC;AAEH,eAAO,MAAM,gCAAgC;;;;;;;;;EAG3C,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;EAElC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKlC,CAAC;AAIH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACpD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAChE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAChE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAChE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,gCAAgC,CACxC,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC1E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE1E,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiG3B,CAAC"}

package/dist/clients/clients.contract.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientsContract = exports.PaginatedResponseSchema = exports.AutocompleteQuerySchema = exports.ClientAutocompleteResponseSchema = exports.FilterClientSchema = exports.UpdateClientSchema = exports.CreateClientSchema = exports.ClientSchema = void 0;
+const core_1 = require("@ts-rest/core");
+const zod_1 = require("zod");
+const error_schemas_1 = require("../common/error-schemas");
+const ClientStatusSchema = zod_1.z.enum([
+    'APPROVED',
+    'PENDING_VERIFICATION',
+    'BLACKLISTED',
+]);
+const UserSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid(),
+    firstName: zod_1.z.string(),
+    lastName: zod_1.z.string(),
+    email: zod_1.z.string().email(),
+});
+exports.ClientSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid().describe('Client ID'),
+    name: zod_1.z.string().describe('Client Name'),
+    crn: zod_1.z.string().describe('Company Registration Number'),
+    govLink: zod_1.z.string().url().describe('Government Registration Link'),
+    status: ClientStatusSchema.describe('Client Status'),
+    director: zod_1.z.string().describe('Director Name'),
+    blacklistReason: zod_1.z
+        .string()
+        .nullable()
+        .optional()
+        .describe('Reason for Blacklisting'),
+    lastUpdatedBy: UserSchema.describe('Last Updated By'),
+    createdAt: zod_1.z.date().describe('Creation Date'),
+    updatedAt: zod_1.z.date().describe('Last Update Date'),
+    version: zod_1.z.number().describe('Version Number'),
+    agentClientLinks: zod_1.z.object({ agentId: zod_1.z.string() }).describe('Agent Link'),
+});
+exports.CreateClientSchema = zod_1.z.object({
+    name: zod_1.z.string().max(255).describe('Client Name'),
+    govLink: zod_1.z.string().url().max(2048).describe('Government Registration Link'),
+    director: zod_1.z.string().max(255).describe('Director Name'),
+});
+exports.UpdateClientSchema = zod_1.z
+    .object({
+    name: zod_1.z.string().max(255).optional().describe('Client Name'),
+    govLink: zod_1.z
+        .string()
+        .url()
+        .max(2048)
+        .optional()
+        .describe('Government Registration Link'),
+    director: zod_1.z.string().max(255).optional().describe('Director Name'),
+    status: ClientStatusSchema.optional().describe('Client Status'),
+    blacklistReason: zod_1.z
+        .string()
+        .nullable()
+        .optional()
+        .describe('Reason for Blacklisting'),
+})
+    .refine((data) => {
+    if (data.status === 'BLACKLISTED' && !data.blacklistReason) {
+        return false;
+    }
+    return true;
+}, {
+    message: 'blacklistReason is required when status is BLACKLISTED',
+    path: ['blacklistReason'],
+});
+exports.FilterClientSchema = zod_1.z.object({
+    limit: zod_1.z.coerce.number().default(50).describe('Results per page'),
+    page: zod_1.z.coerce.number().default(1).describe('Page number'),
+    search: zod_1.z.string().optional().describe('Search by name'),
+    status: ClientStatusSchema.optional().describe('Filter by Status'),
+});
+exports.ClientAutocompleteResponseSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid().describe('Client ID'),
+    name: zod_1.z.string().describe('Client Name'),
+});
+exports.AutocompleteQuerySchema = zod_1.z.object({
+    search: zod_1.z.string().optional().describe('Search...'),
+});
+exports.PaginatedResponseSchema = zod_1.z.object({
+    data: zod_1.z.array(exports.ClientSchema).describe('Client 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'),
+});
+const c = (0, core_1.initContract)();
+exports.clientsContract = c.router({
+    create: {
+        method: 'POST',
+        path: '/clients',
+        responses: {
+            201: exports.ClientSchema,
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        body: exports.CreateClientSchema,
+        summary: 'Create a new client',
+    },
+    findAll: {
+        method: 'GET',
+        path: '/clients',
+        responses: {
+            200: exports.PaginatedResponseSchema,
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        query: exports.FilterClientSchema,
+        summary: 'Get all clients',
+    },
+    autocomplete: {
+        method: 'GET',
+        path: '/clients/autocomplete',
+        responses: {
+            200: zod_1.z.array(exports.ClientAutocompleteResponseSchema),
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        query: exports.AutocompleteQuerySchema,
+        summary: 'Get clients for autocomplete',
+    },
+    findOne: {
+        method: 'GET',
+        path: '/clients/:id',
+        responses: {
+            200: exports.ClientSchema,
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid(),
+        }),
+        summary: 'Get a client by ID',
+    },
+    update: {
+        method: 'PATCH',
+        path: '/clients/:id',
+        responses: {
+            200: exports.ClientSchema,
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid(),
+        }),
+        body: exports.UpdateClientSchema,
+        summary: 'Update a client',
+    },
+    remove: {
+        method: 'DELETE',
+        path: '/clients/:id',
+        responses: {
+            204: zod_1.z.null(),
+            400: error_schemas_1.ErrorResponseSchema,
+            401: error_schemas_1.ErrorResponseSchema,
+            403: error_schemas_1.ErrorResponseSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            500: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid(),
+        }),
+        body: zod_1.z.undefined(),
+        summary: 'Delete a client',
+    },
+}, {
+    pathPrefix: '/v2', // We handle prefix in path or global prefix
+});

package/dist/common/error-schemas.d.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+/**
+ * Shared error response schema matching IErrorResponse interface.
+ * This ensures type consistency between backend error handling and contract definitions.
+ */
+export declare const ErrorResponseSchema: 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;
+}>;
+export type ErrorResponseV2 = z.infer<typeof ErrorResponseSchema>;
+//# sourceMappingURL=error-schemas.d.ts.map

package/dist/common/error-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-schemas.d.ts","sourceRoot":"","sources":["../../contracts/common/error-schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;EAQ9B,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dist/common/error-schemas.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResponseSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Shared error response schema matching IErrorResponse interface.
+ * This ensures type consistency between backend error handling and contract definitions.
+ */
+exports.ErrorResponseSchema = zod_1.z.object({
+    statusCode: zod_1.z.number().describe('HTTP Status Code'),
+    message: zod_1.z.string().describe('Human-readable error message'),
+    code: zod_1.z.string().describe('Machine-readable error code'),
+    details: zod_1.z.unknown().optional().describe('Additional error details'),
+    timestamp: zod_1.z.string().describe('Error timestamp'),
+    path: zod_1.z.string().describe('Request path'),
+    correlationId: zod_1.z.string().optional().describe('Request correlation ID'),
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './clients/clients.contract';
+export * from './common/error-schemas';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../contracts/index.ts"],"names":[],"mappings":"AACA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export all contracts
+__exportStar(require("./clients/clients.contract"), exports);
+__exportStar(require("./common/error-schemas"), exports);

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@dakkitor/api-contracts",
+    "version": "1.0.0",
+    "description": "TypeScript API contracts using ts-rest and Zod",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build",
+        "test": "echo \"No tests yet\" && exit 0"
+    },
+    "keywords": [
+        "typescript",
+        "api",
+        "contracts",
+        "ts-rest",
+        "zod",
+        "types"
+    ],
+    "author": "Doru",
+    "license": "MIT",
+    "peerDependencies": {
+        "@ts-rest/core": "^3.30.0",
+        "zod": "^3.22.0"
+    },
+    "devDependencies": {
+        "@ts-rest/core": "^3.30.0",
+        "typescript": "^5.3.3",
+        "zod": "^3.22.4"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}