@taiger-common/model 1.0.53 → 1.0.55

package/dist/types/api/common.d.ts

@@ -1,19 +1,79 @@
 /**
  * Common API response types shared across all domains.
  */
-/** Base response for mutation endpoints that return no data payload */
-export interface SuccessResponse {
+import { z } from 'zod';
+export declare const SuccessResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+}, {
     success: boolean;
-    message?: string;
-}
+    message?: string | undefined;
+}>;
+/**
+ * Factory that wraps a data schema in the standard API response envelope.
+ * Usage: createApiResponseSchema(z.array(UserWithIdSchema))
+ */
+export declare const createApiResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<T>;
+}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<T>;
+}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<T>;
+}>, any>[k]; } : never, z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<T>;
+}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<T>;
+}>[k_1]; } : never>;
+/**
+ * Factory for paginated list responses.
+ * Usage: createPaginatedResponseSchema(SomeItemSchema)
+ */
+export declare const createPaginatedResponseSchema: <T extends z.ZodTypeAny>(itemSchema: T) => z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+} & {
+    data: z.ZodOptional<z.ZodArray<T, "many">>;
+} & {
+    total: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    message?: string | undefined;
+    data?: T["_output"][] | undefined;
+    total?: number | undefined;
+}, {
+    success: boolean;
+    message?: string | undefined;
+    data?: T["_input"][] | undefined;
+    total?: number | undefined;
+}>;
+/** Base response for mutation endpoints that return no data payload */
+export type SuccessResponse = z.infer<typeof SuccessResponseSchema>;
 /** Generic API response wrapper used by most backend endpoints */
-export interface ApiResponse<T = unknown> extends SuccessResponse {
+export type ApiResponse<T = unknown> = SuccessResponse & {
     data?: T;
-}
+};
 /** Paginated list response */
-export interface PaginatedResponse<T> extends ApiResponse<T[]> {
+export type PaginatedResponse<T> = ApiResponse<T[]> & {
     total?: number;
-}
+};
 export type StudentId = string;
 export type ApplicationId = string;
 export type UserId = string;