@servemate/dto 1.0.0

package/dist/dto/user.dto.d.ts

@@ -0,0 +1,411 @@
+import { z } from 'zod';
+import { UserRole } from './enums';
+/**
+ * User-related constants
+ */
+export declare const UserSortColumn: {
+    readonly ID: "id";
+    readonly NAME: "name";
+    readonly EMAIL: "email";
+    readonly ROLE: "role";
+    readonly CREATED_AT: "createdAt";
+    readonly UPDATED_AT: "updatedAt";
+};
+export type UserSortColumn = (typeof UserSortColumn)[keyof typeof UserSortColumn];
+/**
+ *
+ * User schemas
+ */
+/**
+ * Schema for a complete user object.
+ * This schema defines all the fields that a user can have in the system.
+ * It uses Zod for runtime type checking and validation.
+ */
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    email: z.ZodString;
+    role: z.ZodNativeEnum<{
+        readonly ADMIN: "ADMIN";
+        readonly USER: "USER";
+        readonly HOST: "HOST";
+        readonly MANAGER: "MANAGER";
+    }>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    password: z.ZodString;
+    createdAt: z.ZodDefault<z.ZodDate>;
+    updatedAt: z.ZodDefault<z.ZodDate>;
+    lastLogin: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    name: string;
+    createdAt: Date;
+    updatedAt: Date;
+    email: string;
+    role: "ADMIN" | "USER" | "HOST" | "MANAGER";
+    isActive: boolean;
+    password: string;
+    lastLogin?: Date | null | undefined;
+}, {
+    id: number;
+    name: string;
+    email: string;
+    role: "ADMIN" | "USER" | "HOST" | "MANAGER";
+    password: string;
+    createdAt?: Date | undefined;
+    updatedAt?: Date | undefined;
+    isActive?: boolean | undefined;
+    lastLogin?: Date | null | undefined;
+}>;
+/**
+ * Schema for creating a new user.
+ * This schema picks specific fields from the UserSchema to ensure only necessary data is provided when creating a user.
+ *
+ * @remarks
+ * The schema includes the following fields:
+ * - name: The user's name
+ * - email: The user's email address
+ * - role: The user's role in the system
+ * - password: The user's password
+ *
+ * @returns A Zod schema object that can be used to validate data for creating a new user
+ */
+export declare const CreateUserSchema: z.ZodObject<Pick<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    email: z.ZodString;
+    role: z.ZodNativeEnum<{
+        readonly ADMIN: "ADMIN";
+        readonly USER: "USER";
+        readonly HOST: "HOST";
+        readonly MANAGER: "MANAGER";
+    }>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    password: z.ZodString;
+    createdAt: z.ZodDefault<z.ZodDate>;
+    updatedAt: z.ZodDefault<z.ZodDate>;
+    lastLogin: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+}, "name" | "email" | "role" | "password">, "strip", z.ZodTypeAny, {
+    name: string;
+    email: string;
+    role: "ADMIN" | "USER" | "HOST" | "MANAGER";
+    password: string;
+}, {
+    name: string;
+    email: string;
+    role: "ADMIN" | "USER" | "HOST" | "MANAGER";
+    password: string;
+}>;
+/**
+ * Schema for a single ID parameter.
+ * Used when an API endpoint requires only an ID as input.
+ *
+ * @property {string} id - The unique identifier (non-empty string).
+ */
+export declare const IdParamSchema: z.ZodObject<{
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+}, {
+    id: string;
+}>;
+/**
+ * Schema for user query parameters.
+ * This schema defines and validates the structure of query parameters used for searching, filtering, and sorting users.
+ *
+ * @param {object} params - The object containing user query parameters
+ * @param {string} [params.id] - The user's ID (optional, will be transformed to a number)
+ * @param {string} [params.email] - The user's email address (optional, must be a valid email)
+ * @param {string} [params.name] - The user's name (optional, minimum 3 characters)
+ * @param {string} [params.page] - The page number for pagination (optional, will be transformed to a number)
+ * @param {string} [params.pageSize] - The number of items per page (optional, will be transformed to a number)
+ * @param {UserSortColumn} [params.sortBy] - The column to sort by (optional, must be a valid UserSortColumn)
+ * @param {'asc' | 'desc'} [params.sortOrder] - The order to sort in (optional, 'asc' or 'desc')
+ * @param {string} [params.role] - The user's role (optional, will be transformed to uppercase and validated against Role enum)
+ * @param {boolean} [params.isActive] - The user's active status (optional)
+ * @param {string} [params.createdAfter] - The date after which users were created (optional, must be a valid date string)
+ * @param {string} [params.createdBefore] - The date before which users were created (optional, must be a valid date string)
+ *
+ * @returns {z.ZodObject} A Zod schema object that can be used to validate and transform user query parameters
+ */
+export declare const UserParamSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodNumber>;
+    email: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    page: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodString>, number | undefined, string | undefined>>;
+    pageSize: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodString>, number | undefined, string | undefined>>;
+    sortBy: z.ZodOptional<z.ZodOptional<z.ZodNativeEnum<{
+        readonly ID: "id";
+        readonly NAME: "name";
+        readonly EMAIL: "email";
+        readonly ROLE: "role";
+        readonly CREATED_AT: "createdAt";
+        readonly UPDATED_AT: "updatedAt";
+    }>>>;
+    sortOrder: z.ZodOptional<z.ZodOptional<z.ZodEnum<["asc", "desc"]>>>;
+    role: z.ZodOptional<z.ZodOptional<z.ZodPipeline<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>, z.ZodNativeEnum<{
+        readonly ADMIN: "ADMIN";
+        readonly USER: "USER";
+        readonly HOST: "HOST";
+        readonly MANAGER: "MANAGER";
+    }>>>>;
+    isActive: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodEnum<["true", "false"]>>, boolean | undefined, "true" | "false" | undefined>>;
+    createdAfter: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>>;
+    createdBefore: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>>;
+}, "strip", z.ZodTypeAny, {
+    page?: number | undefined;
+    pageSize?: number | undefined;
+    sortOrder?: "asc" | "desc" | undefined;
+    id?: number | undefined;
+    name?: string | undefined;
+    sortBy?: "id" | "name" | "createdAt" | "updatedAt" | "email" | "role" | undefined;
+    email?: string | undefined;
+    role?: "ADMIN" | "USER" | "HOST" | "MANAGER" | undefined;
+    isActive?: boolean | undefined;
+    createdAfter?: string | undefined;
+    createdBefore?: string | undefined;
+}, {
+    page?: string | undefined;
+    pageSize?: string | undefined;
+    sortOrder?: "asc" | "desc" | undefined;
+    id?: number | undefined;
+    name?: string | undefined;
+    sortBy?: "id" | "name" | "createdAt" | "updatedAt" | "email" | "role" | undefined;
+    email?: string | undefined;
+    role?: string | undefined;
+    isActive?: "true" | "false" | undefined;
+    createdAfter?: string | undefined;
+    createdBefore?: string | undefined;
+}>;
+/**
+ * Schema for updating user information.
+ * All fields are optional, but at least one must be provided.
+ *
+ * @property {string} [name] - The user's new name (optional, minimum 1 character).
+ * @property {string} [email] - The user's new email address (optional).
+ * @property {Role} [role] - The user's new role (optional).
+ * @property {boolean} [isActive] - The user's new active status (optional).
+ */
+export declare const UpdateUserSchema: z.ZodEffects<z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    role: z.ZodOptional<z.ZodNativeEnum<{
+        readonly ADMIN: "ADMIN";
+        readonly USER: "USER";
+        readonly HOST: "HOST";
+        readonly MANAGER: "MANAGER";
+    }>>;
+    isActive: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    lastLogin: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodDate>>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    email?: string | undefined;
+    role?: "ADMIN" | "USER" | "HOST" | "MANAGER" | undefined;
+    isActive?: boolean | undefined;
+    lastLogin?: Date | null | undefined;
+}, {
+    name?: string | undefined;
+    email?: string | undefined;
+    role?: "ADMIN" | "USER" | "HOST" | "MANAGER" | undefined;
+    isActive?: boolean | undefined;
+    lastLogin?: Date | null | undefined;
+}>, {
+    name?: string | undefined;
+    email?: string | undefined;
+    role?: "ADMIN" | "USER" | "HOST" | "MANAGER" | undefined;
+    isActive?: boolean | undefined;
+    lastLogin?: Date | null | undefined;
+}, {
+    name?: string | undefined;
+    email?: string | undefined;
+    role?: "ADMIN" | "USER" | "HOST" | "MANAGER" | undefined;
+    isActive?: boolean | undefined;
+    lastLogin?: Date | null | undefined;
+}>;
+/**
+ * Schema for user login credentials.
+ * Used for authenticating users in the system.
+ *
+ * @property {string} email - The user's email address.
+ * @property {string} password - The user's password.
+ */
+export declare const UserLoginSchema: z.ZodObject<Pick<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    email: z.ZodString;
+    role: z.ZodNativeEnum<{
+        readonly ADMIN: "ADMIN";
+        readonly USER: "USER";
+        readonly HOST: "HOST";
+        readonly MANAGER: "MANAGER";
+    }>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    password: z.ZodString;
+    createdAt: z.ZodDefault<z.ZodDate>;
+    updatedAt: z.ZodDefault<z.ZodDate>;
+    lastLogin: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+}, "email" | "password">, "strip", z.ZodTypeAny, {
+    email: string;
+    password: string;
+}, {
+    email: string;
+    password: string;
+}>;
+/**
+ * User types
+ */
+/**
+ * Type definition for a complete user object.
+ * This type is inferred from the UserSchema, ensuring type safety when working with user data.
+ * @typedef {Object} UserDto
+ * @property {number} id - The unique identifier for the user
+ * @property {string} name - The user's full name
+ * @property {string} email - The user's email address
+ * @property {Role} role - The user's role in the system
+ * @property {boolean} isActive - Whether the user account is active
+ * @property {string} password - The user's hashed password
+ * @property {Date} createdAt - The timestamp when the user account was created
+ * @property {Date} updatedAt - The timestamp when the user account was last updated
+ * @property {Date | null} [lastLogin] - The timestamp of the user's last login (optional)
+ */
+export type UserDto = z.infer<typeof UserSchema>;
+/**
+ * Type definition for the data required to create a new user.
+ * This type is inferred from the CreateUserSchema, ensuring type safety when creating users.
+ *
+ * @property {string} name - The user's name (non-empty string)
+ * @property {string} email - The user's email address (valid email format)
+ * @property {Role} role - The user's role in the system. Must be one of the following:
+ *   - ADMIN: Administrator with full system access
+ *   - USER: Standard user with basic privileges
+ *   - HOST: User with hosting capabilities
+ *   - MANAGER: User with management responsibilities
+ * @property {string} password - The user's password (will be hashed before storage)
+ *
+ * @see {@link Role} for the complete list of available roles
+ * @see {@link UserSchema} for the full user schema including additional fields
+ */
+export type CreateUserDto = z.infer<typeof CreateUserSchema>;
+/**
+ * Type definition for an ID parameter.
+ * This type is inferred from the IdParamSchema.
+ *
+ * @property {string} id - The unique identifier (non-empty string)
+ */
+export type IdParamDto = z.infer<typeof IdParamSchema>;
+/**
+ * Represents the shape of query parameters used for user-related operations.
+ * This type is inferred from the UserParamSchema, ensuring type safety and consistency
+ * with the defined schema for user query parameters.
+ *
+ *
+ * @property {number} [id] - The user's ID (optional)
+ * @property {string} [email] - The user's email address (optional)
+ * @property {string} [name] - The user's name (optional, minimum 3 characters)
+ * @property {number} [page] - The page number for pagination (optional)
+ * @property {number} [pageSize] - The number of items per page (optional)
+ * @property {UserSortColumn} [sortBy] - The column to sort by (optional)
+ * @property {'asc' | 'desc'} [sortOrder] - The order to sort in (optional)
+ * @property {Role} [role] - The user's role (optional)
+ * @property {boolean} [isActive] - The user's active status (optional)
+ * @property {string} [createdAfter] - The date after which users were created (optional)
+ * @property {string} [createdBefore] - The date before which users were created (optional)
+ * @see {@link UserSortColumn} for the available sort columns
+ * @see {@link Role} for the available user roles
+ */
+export type UserSearchCriteria = z.infer<typeof UserParamSchema>;
+/**
+ * Type definition for updating user information.
+ * This type is inferred from the UpdateUserSchema.
+ *
+ * @property {string} [name] - The user's new name (optional, minimum 1 character)
+ * @property {string} [email] - The user's new email address (optional)
+ * @property {Role} [role] - The user's new role (optional)
+ * @property {boolean} [isActive] - The user's new active status (optional)
+ *
+ * @see {@link Role} for the available user roles
+ */
+export type UpdateUserDto = z.infer<typeof UpdateUserSchema>;
+/**
+ * Type definition for user validation credentials.
+ * This type is inferred from the UserLoginSchema and used for authenticating users.
+ *
+ * @property {string} email - The user's email address
+ * @property {string} password - The user's password
+ */
+export type UserCredentials = z.infer<typeof UserLoginSchema>;
+/**
+ * Type definition for validated user data.
+ * This type represents the user data after successful authentication, excluding sensitive information.
+ *
+ * @property {number} id - The unique identifier for the user
+ * @property {string} name - The user's full name
+ * @property {string} email - The user's email address
+ * @property {Role} role - The user's role in the system
+ */
+export type ValidatedUserData = Omit<UserDto, 'password' | 'isActive' | 'createdAt' | 'updatedAt' | 'lastLogin'>;
+/**
+ * Type definition for a user list item.
+ * This type represents a user in a list view, excluding the password for security reasons.
+ *
+ * @property {number} id - The unique identifier for the user
+ * @property {string} name - The user's full name
+ * @property {string} email - The user's email address
+ * @property {Role} role - The user's role in the system
+ * @property {boolean} isActive - Whether the user account is active
+ * @property {Date} createdAt - The timestamp when the user account was created
+ * @property {Date} updatedAt - The timestamp when the user account was last updated
+ * @property {Date | null} [lastLogin] - The timestamp of the user's last login (optional)
+ */
+export type UserListItem = Omit<UserDto, 'password'>;
+/**
+ * Represents the result of a user list query.
+ * This type encapsulates both the list of users and the total count of users matching the query criteria.
+ *
+ * @see {@link UserListItem}
+ * @property { UserListItem[]} users -  An array of user objects, each containing non-sensitive user information.
+ * @property {number} totalCount - The total number of users that match the query criteria, regardless of pagination.
+ */
+export type UserListResult = {
+    users: UserListItem[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+};
+/**
+ * Represents the filters that can be applied when querying users.
+ *
+ * @interface IUserFilters
+ * @property {Role} [role] - Optional. The role to filter users by.
+ * @property {boolean} [isActive] - Optional. Whether to filter for active or inactive users.
+ * @property {Date} [createdAfter] - Optional. The date after which users were created.
+ * @property {Date} [createdBefore] - Optional. The date before which users were created.
+ * @see {@link Role} for the available user roles.
+ */
+export type IUserFilters = {
+    role?: UserRole;
+    isActive?: boolean;
+    createdAfter?: Date;
+    createdBefore?: Date;
+};
+/**
+ * Type definition for creating a new user.
+ * This type is inferred from the CreateUserSchema and contains all necessary fields for user creation.
+ *
+ * @property {string} name - The user's full name
+ * @property {string} email - The user's email address
+ * @property {Role} role - The user's role in the system
+ * @property {string} password - The user's password (will be hashed before storage)
+ * @see {@link Role} for the available user roles
+ */
+export type CreateUser = z.infer<typeof CreateUserSchema>;
+/**
+ * Type definition for data returned after creating a new user.
+ * This type contains only non-sensitive information about the newly created user.
+ *
+ * @property {string} name - The user's full name
+ * @property {string} email - The user's email address
+ */
+export type CreatedUserData = Pick<UserDto, 'name' | 'email'>;
+//# sourceMappingURL=user.dto.d.ts.map

package/dist/dto/user.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.dto.d.ts","sourceRoot":"","sources":["../../src/dto/user.dto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;GAEG;AAEH,eAAO,MAAM,cAAc;;;;;;;CAOjB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAClF;;;GAGG;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUrB,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;EAK3B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;EAExB,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CjB,CAAC;AAEZ;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW1B,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;EAG1B,CAAC;AAEH;;GAEG;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CACnC,OAAO,EACP,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,CACjE,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAErD;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,aAAa,CAAC,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC"}

package/dist/dto/user.dto.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserLoginSchema = exports.UpdateUserSchema = exports.UserParamSchema = exports.IdParamSchema = exports.CreateUserSchema = exports.UserSchema = exports.UserSortColumn = void 0;
+const zod_1 = require("zod");
+const enums_1 = require("./enums");
+/**
+ * User-related constants
+ */
+exports.UserSortColumn = {
+    ID: 'id',
+    NAME: 'name',
+    EMAIL: 'email',
+    ROLE: 'role',
+    CREATED_AT: 'createdAt',
+    UPDATED_AT: 'updatedAt',
+};
+/**
+ *
+ * User schemas
+ */
+/**
+ * Schema for a complete user object.
+ * This schema defines all the fields that a user can have in the system.
+ * It uses Zod for runtime type checking and validation.
+ */
+exports.UserSchema = zod_1.z.object({
+    id: zod_1.z.number().min(1, { message: 'ID must not be empty' }),
+    name: zod_1.z.string().min(1, { message: 'Name must not be empty' }),
+    email: zod_1.z.string().email({ message: 'Invalid email address' }),
+    role: zod_1.z.nativeEnum(enums_1.UserRole, { message: 'Invalid role' }),
+    isActive: zod_1.z.boolean().default(true),
+    password: zod_1.z.string(),
+    createdAt: zod_1.z.date().default(() => new Date()),
+    updatedAt: zod_1.z.date().default(() => new Date()),
+    lastLogin: zod_1.z.date().optional().nullable(),
+});
+/**
+ * Schema for creating a new user.
+ * This schema picks specific fields from the UserSchema to ensure only necessary data is provided when creating a user.
+ *
+ * @remarks
+ * The schema includes the following fields:
+ * - name: The user's name
+ * - email: The user's email address
+ * - role: The user's role in the system
+ * - password: The user's password
+ *
+ * @returns A Zod schema object that can be used to validate data for creating a new user
+ */
+exports.CreateUserSchema = exports.UserSchema.pick({
+    name: true,
+    email: true,
+    role: true,
+    password: true,
+});
+/**
+ * Schema for a single ID parameter.
+ * Used when an API endpoint requires only an ID as input.
+ *
+ * @property {string} id - The unique identifier (non-empty string).
+ */
+exports.IdParamSchema = zod_1.z.object({
+    id: zod_1.z.string().min(1, { message: 'ID must not be empty' }),
+});
+/**
+ * Schema for user query parameters.
+ * This schema defines and validates the structure of query parameters used for searching, filtering, and sorting users.
+ *
+ * @param {object} params - The object containing user query parameters
+ * @param {string} [params.id] - The user's ID (optional, will be transformed to a number)
+ * @param {string} [params.email] - The user's email address (optional, must be a valid email)
+ * @param {string} [params.name] - The user's name (optional, minimum 3 characters)
+ * @param {string} [params.page] - The page number for pagination (optional, will be transformed to a number)
+ * @param {string} [params.pageSize] - The number of items per page (optional, will be transformed to a number)
+ * @param {UserSortColumn} [params.sortBy] - The column to sort by (optional, must be a valid UserSortColumn)
+ * @param {'asc' | 'desc'} [params.sortOrder] - The order to sort in (optional, 'asc' or 'desc')
+ * @param {string} [params.role] - The user's role (optional, will be transformed to uppercase and validated against Role enum)
+ * @param {boolean} [params.isActive] - The user's active status (optional)
+ * @param {string} [params.createdAfter] - The date after which users were created (optional, must be a valid date string)
+ * @param {string} [params.createdBefore] - The date before which users were created (optional, must be a valid date string)
+ *
+ * @returns {z.ZodObject} A Zod schema object that can be used to validate and transform user query parameters
+ */
+exports.UserParamSchema = zod_1.z
+    .object({
+    id: zod_1.z.coerce.number(),
+    email: zod_1.z.string().email().optional(),
+    name: zod_1.z.string().min(3).optional(),
+    page: zod_1.z
+        .string()
+        .optional()
+        .transform((value) => (value ? parseInt(value) : undefined)),
+    pageSize: zod_1.z
+        .string()
+        .optional()
+        .transform((value) => (value ? parseInt(value) : undefined)),
+    sortBy: zod_1.z.nativeEnum(exports.UserSortColumn).optional(),
+    sortOrder: zod_1.z.enum(['asc', 'desc']).optional(),
+    role: zod_1.z
+        .string()
+        .optional()
+        .transform((value) => value === null || value === void 0 ? void 0 : value.toUpperCase())
+        .pipe(zod_1.z.nativeEnum(enums_1.UserRole))
+        .optional(),
+    isActive: zod_1.z
+        .enum(['true', 'false'])
+        .optional()
+        .transform((val) => {
+        if (val === 'true')
+            return true;
+        if (val === 'false')
+            return false;
+        return undefined;
+    }),
+    createdAfter: zod_1.z
+        .string()
+        .optional()
+        .refine((value) => !value || !isNaN(Date.parse(value)), {
+        message: 'createdAfter must be a valid date string',
+    }),
+    createdBefore: zod_1.z
+        .string()
+        .optional()
+        .refine((value) => !value || !isNaN(Date.parse(value)), {
+        message: 'createdBefore must be a valid date string',
+    }),
+})
+    .partial();
+/**
+ * Schema for updating user information.
+ * All fields are optional, but at least one must be provided.
+ *
+ * @property {string} [name] - The user's new name (optional, minimum 1 character).
+ * @property {string} [email] - The user's new email address (optional).
+ * @property {Role} [role] - The user's new role (optional).
+ * @property {boolean} [isActive] - The user's new active status (optional).
+ */
+exports.UpdateUserSchema = exports.UserSchema.pick({
+    name: true,
+    email: true,
+    role: true,
+    isActive: true,
+    lastLogin: true,
+})
+    .partial()
+    .refine((data) => Object.values(data).some((value) => value !== undefined), {
+    message: 'At least one field must be provided in the body',
+    path: ['name', 'email', 'role', 'isActive', 'lastLogin'],
+});
+/**
+ * Schema for user login credentials.
+ * Used for authenticating users in the system.
+ *
+ * @property {string} email - The user's email address.
+ * @property {string} password - The user's password.
+ */
+exports.UserLoginSchema = exports.UserSchema.pick({
+    email: true,
+    password: true,
+});
+//# sourceMappingURL=user.dto.js.map

package/dist/dto/user.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.dto.js","sourceRoot":"","sources":["../../src/dto/user.dto.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,mCAAmC;AAEnC;;GAEG;AAEU,QAAA,cAAc,GAAG;IAC7B,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,WAAW;IACvB,UAAU,EAAE,WAAW;CACd,CAAC;AAGX;;;GAGG;AAEH;;;;GAIG;AACU,QAAA,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IAClC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAC1D,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IAC9D,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;IAC7D,IAAI,EAAE,OAAC,CAAC,UAAU,CAAC,gBAAQ,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACnC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;IAC7C,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;IAC7C,SAAS,EAAE,OAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACU,QAAA,gBAAgB,GAAG,kBAAU,CAAC,IAAI,CAAC;IAC/C,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;CACd,CAAC,CAAC;AAEH;;;;;GAKG;AACU,QAAA,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IACrC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;CAC1D,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,eAAe,GAAG,OAAC;KAC9B,MAAM,CAAC;IACP,EAAE,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE;IACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACpC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7D,QAAQ,EAAE,OAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7D,MAAM,EAAE,OAAC,CAAC,UAAU,CAAC,sBAAc,CAAC,CAAC,QAAQ,EAAE;IAC/C,SAAS,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7C,IAAI,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,EAAE,CAAC;SAC1C,IAAI,CAAC,OAAC,CAAC,UAAU,CAAC,gBAAQ,CAAC,CAAC;SAC5B,QAAQ,EAAE;IACZ,QAAQ,EAAE,OAAC;SACT,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACvB,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QAClB,IAAI,GAAG,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QAChC,IAAI,GAAG,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC;QAClC,OAAO,SAAS,CAAC;IAClB,CAAC,CAAC;IACH,YAAY,EAAE,OAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;QACvD,OAAO,EAAE,0CAA0C;KACnD,CAAC;IACH,aAAa,EAAE,OAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;QACvD,OAAO,EAAE,2CAA2C;KACpD,CAAC;CACH,CAAC;KACD,OAAO,EAAE,CAAC;AAEZ;;;;;;;;GAQG;AACU,QAAA,gBAAgB,GAAG,kBAAU,CAAC,IAAI,CAAC;IAC/C,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,IAAI;IACd,SAAS,EAAE,IAAI;CACf,CAAC;KACA,OAAO,EAAE;KACT,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,EAAE;IAC3E,OAAO,EAAE,iDAAiD;IAC1D,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC;CACxD,CAAC,CAAC;AAEJ;;;;;;GAMG;AACU,QAAA,eAAe,GAAG,kBAAU,CAAC,IAAI,CAAC;IAC9C,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;CACd,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './dto';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"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 });
+__exportStar(require("./dto"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB"}

package/package.json

@@ -0,0 +1,45 @@
+{
+	"name": "@servemate/dto",
+	"version": "1.0.0",
+	"description": "DTO package for ServeMate service",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"clean": "rm -rf dist",
+		"prebuild": "npm run clean",
+		"prepare": "npm run build",
+		"test": "echo \"No tests specified\"",
+		"pack": "npm pack --dry-run"
+	},
+	"dependencies": {
+		"zod": "^3.23.8"
+	},
+	"devDependencies": {
+		"typescript": "^5.7.2"
+	},
+	"peerDependencies": {
+		"zod": "^3.0.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/inmorpher/ServeMate-DTO.git"
+	},
+	"bugs": {
+		"url": "https://github.com/inmorpher/ServeMate-DTO/issues"
+	},
+	"homepage": "https://github.com/inmorpher/ServeMate-DTO#readme",
+	"keywords": [
+		"dto",
+		"servemate",
+		"typescript"
+	],
+	"author": "",
+	"license": "ISC",
+	"publishConfig": {
+		"access": "public"
+	}
+}