@livdot-tech/contracts 1.0.0 → 1.2.0

package/dist/common/index.d.mts

@@ -0,0 +1,315 @@
+import { z } from 'zod';
+
+/**
+ * Standard API response wrapper for all LivDot endpoints.
+ * @template T The type of the data payload.
+ */
+declare const ApiResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>, any>[k]; } : never, z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>[k_1]; } : never>;
+/**
+ * Common pagination parameters.
+ */
+declare const PaginationParamsSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    limit: number;
+}, {
+    page?: number | undefined;
+    limit?: number | undefined;
+}>;
+type PaginationParams = z.infer<typeof PaginationParamsSchema>;
+
+/**
+ * Type-safe inference for the API response.
+ */
+type ApiResponse<T> = {
+    success: boolean;
+    data?: T;
+    error?: ApiError;
+    meta?: PaginationMeta;
+};
+type ApiError = {
+    type: string;
+    title: string;
+    status: number;
+    detail: string;
+    instance?: string;
+};
+type PaginationMeta = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+};
+/**
+ * Type-safe inference for paginated responses.
+ */
+type PaginatedResponse<T> = ApiResponse<T[]> & {
+    meta: PaginationMeta;
+};
+
+/**
+ * Human-readable response messages for the LivDot platform.
+ * These are used for UI feedback and notification bodies.
+ */
+declare const ResponseMessages: {
+    readonly AUTH: {
+        readonly LOGIN_SUCCESS: "Welcome back! You have successfully logged in.";
+        readonly REGISTER_SUCCESS: "Account created successfully. Please check your email for verification.";
+        readonly PASSWORD_RESET_SENT: "If an account exists for that email, a password reset link has been sent.";
+        readonly PASSWORD_RESET_SUCCESS: "Your password has been successfully updated.";
+    };
+    readonly USER: {
+        readonly PROFILE_UPDATE_SUCCESS: "Your profile has been updated successfully.";
+        readonly HOST_PROFILE_CREATED: "Host profile created. You can now start hosting events.";
+        readonly PRODUCER_PROFILE_CREATED: "Producer profile created. Our team will review your verification details.";
+    };
+    readonly EVENT: {
+        readonly CREATED: "Event created successfully.";
+        readonly UPDATED: "Event details updated successfully.";
+        readonly PUBLISHED: "Event published! It is now visible to the public.";
+        readonly CANCELLED: "Event has been cancelled.";
+    };
+    readonly BOOKING: {
+        readonly REQUEST_SENT: "Your booking request has been sent to the producer.";
+        readonly ACCEPTED: "Booking accepted! Please proceed to fund the escrow.";
+        readonly CONFIRMED: "Escrow funded and booking confirmed. Service can now begin.";
+        readonly COMPLETED: "Service marked as completed. Funds will be released after the dispute window.";
+    };
+    readonly PAYMENT: {
+        readonly INITIATED: "Payment process started.";
+        readonly SUCCESS: "Payment verified and transaction completed.";
+        readonly FAILED: "Payment failed. Please try again or use a different method.";
+    };
+    readonly GENERAL: {
+        readonly SUCCESS: "Operation completed successfully.";
+        readonly ERROR: "An unexpected error occurred. Please contact support.";
+        readonly VALIDATION_ERROR: "Some information you provided is incorrect. Please check the highlights.";
+    };
+};
+type ResponseMessages = typeof ResponseMessages;
+
+export { type ApiError, type ApiResponse, ApiResponseSchema, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaginationParamsSchema, ResponseMessages };

package/dist/common/index.d.ts

@@ -0,0 +1,315 @@
+import { z } from 'zod';
+
+/**
+ * Standard API response wrapper for all LivDot endpoints.
+ * @template T The type of the data payload.
+ */
+declare const ApiResponseSchema: <T extends z.ZodTypeAny>(dataSchema: T) => z.ZodObject<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>, any>[k]; } : never, z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<{
+    success: z.ZodBoolean;
+    data: z.ZodOptional<T>;
+    error: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        title: z.ZodString;
+        status: z.ZodNumber;
+        detail: z.ZodString;
+        instance: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }, {
+        type: string;
+        status: number;
+        title: string;
+        detail: string;
+        instance?: string | undefined;
+    }>>;
+    meta: z.ZodOptional<z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>>;
+}>[k_1]; } : never>;
+/**
+ * Common pagination parameters.
+ */
+declare const PaginationParamsSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    limit: number;
+}, {
+    page?: number | undefined;
+    limit?: number | undefined;
+}>;
+type PaginationParams = z.infer<typeof PaginationParamsSchema>;
+
+/**
+ * Type-safe inference for the API response.
+ */
+type ApiResponse<T> = {
+    success: boolean;
+    data?: T;
+    error?: ApiError;
+    meta?: PaginationMeta;
+};
+type ApiError = {
+    type: string;
+    title: string;
+    status: number;
+    detail: string;
+    instance?: string;
+};
+type PaginationMeta = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+};
+/**
+ * Type-safe inference for paginated responses.
+ */
+type PaginatedResponse<T> = ApiResponse<T[]> & {
+    meta: PaginationMeta;
+};
+
+/**
+ * Human-readable response messages for the LivDot platform.
+ * These are used for UI feedback and notification bodies.
+ */
+declare const ResponseMessages: {
+    readonly AUTH: {
+        readonly LOGIN_SUCCESS: "Welcome back! You have successfully logged in.";
+        readonly REGISTER_SUCCESS: "Account created successfully. Please check your email for verification.";
+        readonly PASSWORD_RESET_SENT: "If an account exists for that email, a password reset link has been sent.";
+        readonly PASSWORD_RESET_SUCCESS: "Your password has been successfully updated.";
+    };
+    readonly USER: {
+        readonly PROFILE_UPDATE_SUCCESS: "Your profile has been updated successfully.";
+        readonly HOST_PROFILE_CREATED: "Host profile created. You can now start hosting events.";
+        readonly PRODUCER_PROFILE_CREATED: "Producer profile created. Our team will review your verification details.";
+    };
+    readonly EVENT: {
+        readonly CREATED: "Event created successfully.";
+        readonly UPDATED: "Event details updated successfully.";
+        readonly PUBLISHED: "Event published! It is now visible to the public.";
+        readonly CANCELLED: "Event has been cancelled.";
+    };
+    readonly BOOKING: {
+        readonly REQUEST_SENT: "Your booking request has been sent to the producer.";
+        readonly ACCEPTED: "Booking accepted! Please proceed to fund the escrow.";
+        readonly CONFIRMED: "Escrow funded and booking confirmed. Service can now begin.";
+        readonly COMPLETED: "Service marked as completed. Funds will be released after the dispute window.";
+    };
+    readonly PAYMENT: {
+        readonly INITIATED: "Payment process started.";
+        readonly SUCCESS: "Payment verified and transaction completed.";
+        readonly FAILED: "Payment failed. Please try again or use a different method.";
+    };
+    readonly GENERAL: {
+        readonly SUCCESS: "Operation completed successfully.";
+        readonly ERROR: "An unexpected error occurred. Please contact support.";
+        readonly VALIDATION_ERROR: "Some information you provided is incorrect. Please check the highlights.";
+    };
+};
+type ResponseMessages = typeof ResponseMessages;
+
+export { type ApiError, type ApiResponse, ApiResponseSchema, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaginationParamsSchema, ResponseMessages };

package/dist/common/index.js

@@ -0,0 +1,2 @@
+'use strict';var chunkF663RS3D_js=require('../chunk-F663RS3D.js');Object.defineProperty(exports,"ApiResponseSchema",{enumerable:true,get:function(){return chunkF663RS3D_js.a}});Object.defineProperty(exports,"PaginationParamsSchema",{enumerable:true,get:function(){return chunkF663RS3D_js.b}});Object.defineProperty(exports,"ResponseMessages",{enumerable:true,get:function(){return chunkF663RS3D_js.c}});//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/common/index.mjs

@@ -0,0 +1,2 @@
+export{a as ApiResponseSchema,b as PaginationParamsSchema,c as ResponseMessages}from'../chunk-WEET4HBJ.mjs';//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/common/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}