@dakkitor/api-contracts 1.1.5 → 1.1.6

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

@@ -0,0 +1 @@
+{"version":3,"file":"users.contract.d.ts","sourceRoot":"","sources":["../../contracts/users/users.contract.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAuBxB,eAAO,MAAM,iBAAiB;;;;;;;;;EAW5B,CAAC;AAEH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBM,CAAC;AAE9B,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;EASM,CAAC;AAEpC,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;EAE3B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyB3B,CAAC;AAEH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;EAYM,CAAC;AAEjC,eAAO,MAAM,8BAA8B;;;;;;;;;;;;EAMM,CAAC;AAElD,eAAO,MAAM,2BAA2B;;;;;;;;;EAYM,CAAC;AAE/C,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIO,CAAC;AAIhD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6FzB,CAAC"}

package/dist/users/users.contract.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usersContract = exports.PaginatedUserResponseSchema = exports.UserAutocompleteQuerySchema = exports.UserAutocompleteResponseSchema = exports.ProfileSchema = exports.FilterUserSchema = exports.UpdateUserSchema = exports.CreateUserSchema = exports.UserSchema = exports.RolesFilterSchema = void 0;
+const zod_openapi_1 = require("@anatine/zod-openapi");
+const core_1 = require("@ts-rest/core");
+const zod_1 = require("zod");
+const error_schemas_1 = require("../common/error-schemas");
+const pagination_schema_1 = require("../common/pagination.schema");
+(0, zod_openapi_1.extendZodWithOpenApi)(zod_1.z);
+const UserRoleSchema = zod_1.z.enum([
+    'ADMIN',
+    'SECOND_AGENT',
+    'FIRST_AGENT',
+    'COMPANY_CHECKING',
+]);
+const SortOrderSchema = zod_1.z.enum(['ASC', 'DESC']);
+const UserSortableFieldsSchema = zod_1.z.enum([
+    'lastName',
+    'firstName',
+    'email',
+    'phone',
+    'createdAt',
+]);
+exports.RolesFilterSchema = zod_1.z.object({
+    values: zod_1.z
+        .array(UserRoleSchema)
+        .optional()
+        .describe('Array of roles to filter by'),
+    requireAll: zod_1.z
+        .boolean()
+        .optional()
+        .describe('If true, user must have ALL roles. If false, user must have ANY role. Default: false'),
+});
+exports.UserSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('The unique identifier of the user.'),
+    firstName: zod_1.z.string().describe("The user's first name."),
+    lastName: zod_1.z.string().describe("The user's last name."),
+    email: zod_1.z.string().email().describe("The user's email address."),
+    phone: zod_1.z.string().describe("The user's phone number."),
+    roles: zod_1.z.array(UserRoleSchema).optional().describe("The user's roles."),
+    createdAt: zod_1.z
+        .union([zod_1.z.string().datetime(), zod_1.z.date()])
+        .transform((val) => (val instanceof Date ? val.toISOString() : val))
+        .describe('The date and time the user 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 date and time the user was last updated.'),
+})
+    .openapi({ title: 'User' });
+exports.CreateUserSchema = zod_1.z
+    .object({
+    firstName: zod_1.z.string().min(1).describe('Enter first name'),
+    lastName: zod_1.z.string().min(1).describe('Enter last name'),
+    email: zod_1.z.string().email().describe('Enter email address'),
+    phone: zod_1.z.string().min(1).describe('Enter phone number'), // Basic validation, can be enhanced
+    password: zod_1.z.string().min(8).optional().describe('Enter password'),
+    roles: zod_1.z.array(UserRoleSchema).optional().describe('Select roles'),
+})
+    .openapi({ title: 'CreateUser' });
+exports.UpdateUserSchema = exports.CreateUserSchema.partial().openapi({
+    title: 'UpdateUser',
+});
+exports.FilterUserSchema = zod_1.z.object({
+    page: zod_1.z.coerce.number().default(1).describe('The page number to retrieve.'),
+    limit: zod_1.z.coerce
+        .number()
+        .default(50)
+        .describe('The number of items to return per page.'),
+    name: zod_1.z
+        .string()
+        .optional()
+        .describe('Filter users by name using fuzzy search (searches firstName and lastName)'),
+    email: zod_1.z
+        .string()
+        .optional()
+        .describe('Filter users by email (case-insensitive, partial match)'),
+    phone: zod_1.z
+        .string()
+        .optional()
+        .describe('Filter users by phone number (partial match)'),
+    roles: exports.RolesFilterSchema.optional().describe('Filter users by roles.'),
+    sortBy: UserSortableFieldsSchema.optional().describe('Field to sort users by.'),
+    sortOrder: SortOrderSchema.optional().describe('Sort order (ASC or DESC)'),
+});
+exports.ProfileSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().describe('The unique identifier of the user.'),
+    email: zod_1.z.string().describe('The email address of the user.'),
+    firstName: zod_1.z.string().optional().describe('The first name of the user.'),
+    lastName: zod_1.z.string().optional().describe('The last name of the user.'),
+    phone: zod_1.z.string().optional().describe('The phone number of the user.'),
+    roles: zod_1.z
+        .array(UserRoleSchema)
+        .optional()
+        .describe('The roles assigned to the user.'),
+})
+    .openapi({ title: 'Profile' });
+exports.UserAutocompleteResponseSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().describe('The unique identifier of the user.'),
+    firstName: zod_1.z.string().describe('The first name of the user.'),
+    lastName: zod_1.z.string().describe('The last name of the user.'),
+})
+    .openapi({ title: 'UserAutocompleteResponse' });
+exports.UserAutocompleteQuerySchema = zod_1.z
+    .object({
+    query: zod_1.z
+        .string()
+        .optional()
+        .describe('Search query string to filter results'),
+    id: zod_1.z
+        .string()
+        .uuid()
+        .optional()
+        .describe('Specific record ID to include in results'),
+})
+    .openapi({ title: 'UserAutocompleteQuery' });
+exports.PaginatedUserResponseSchema = (0, pagination_schema_1.createPaginatedResponseSchema)(exports.UserSchema)
+    .describe('Resources retrieved successfully.')
+    .openapi({ title: 'UsersPaginatedResponse' });
+const c = (0, core_1.initContract)();
+exports.usersContract = c.router({
+    create: {
+        method: 'POST',
+        path: '/v2/users',
+        responses: {
+            201: exports.UserSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        body: exports.CreateUserSchema,
+        summary: 'Create a new user',
+        metadata: { tags: ['Users'] },
+    },
+    findAll: {
+        method: 'GET',
+        path: '/v2/users',
+        responses: {
+            200: exports.PaginatedUserResponseSchema,
+        },
+        query: exports.FilterUserSchema,
+        summary: 'Get all users',
+        metadata: { tags: ['Users'] },
+    },
+    autocomplete: {
+        method: 'GET',
+        path: '/v2/users/autocomplete',
+        responses: {
+            200: zod_1.z.array(exports.UserAutocompleteResponseSchema),
+        },
+        query: exports.UserAutocompleteQuerySchema,
+        summary: 'Get users for autocomplete',
+        metadata: { tags: ['Users'] },
+    },
+    me: {
+        method: 'GET',
+        path: '/v2/users/me',
+        responses: {
+            200: exports.ProfileSchema,
+        },
+        summary: 'Get current user profile',
+        metadata: { tags: ['Users'] },
+    },
+    findOne: {
+        method: 'GET',
+        path: '/v2/users/:id',
+        responses: {
+            200: exports.UserSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('The ID of the resource (UUID format).'),
+        }),
+        summary: 'Get a user by ID',
+        metadata: { tags: ['Users'] },
+    },
+    update: {
+        method: 'PATCH',
+        path: '/v2/users/:id',
+        responses: {
+            200: exports.UserSchema,
+            404: error_schemas_1.ErrorResponseSchema,
+            409: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('The ID of the resource (UUID format).'),
+        }),
+        body: exports.UpdateUserSchema,
+        summary: 'Update a user by ID',
+        metadata: { tags: ['Users'] },
+    },
+    remove: {
+        method: 'DELETE',
+        path: '/v2/users/:id',
+        responses: {
+            204: zod_1.z.undefined(),
+            404: error_schemas_1.ErrorResponseSchema,
+        },
+        pathParams: zod_1.z.object({
+            id: zod_1.z.string().uuid().describe('The ID of the resource (UUID format).'),
+        }),
+        body: c.noBody(),
+        summary: 'Delete a user by ID',
+        metadata: { tags: ['Users'] },
+    },
+}, {
+    commonResponses: {
+        400: error_schemas_1.ErrorResponseSchema,
+        401: error_schemas_1.ErrorResponseSchema,
+        403: error_schemas_1.ErrorResponseSchema,
+        500: error_schemas_1.ErrorResponseSchema,
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dakkitor/api-contracts",
-    "version": "1.1.5",
+    "version": "1.1.6",
     "description": "TypeScript API contracts using ts-rest and Zod",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",