@pelatform/starter.db 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -6,6 +6,84 @@ declare const createIdCustom: ({ prefix }: {
     prefix: string;
 }) => string;
 
+/**
+ * Represents a failed API operation.
+ *
+ * Used as a standardized error result across services and API layers.
+ * The `code` should be a machine-readable identifier,
+ * while `message` should be human-readable.
+ */
+type ApiErrorResult = {
+    /**
+     * Indicates the operation failed.
+     */
+    ok: false;
+    /**
+     * Error payload containing a code and message.
+     */
+    error: {
+        /**
+         * Machine-readable error code.
+         * Example: "NOT_FOUND", "UNAUTHORIZED", "VALIDATION_ERROR"
+         */
+        code: string;
+        /**
+         * Human-readable error message.
+         * Safe to display to end users.
+         */
+        message: string;
+    };
+};
+/**
+ * Represents a successful API operation.
+ *
+ * Wraps the returned data in a consistent response shape.
+ *
+ * @template T - Type of the successful response data
+ */
+type ApiSuccessResult<T> = {
+    /**
+     * Indicates the operation was successful.
+     */
+    ok: true;
+    /**
+     * Payload returned from the operation.
+     */
+    data: T;
+};
+/**
+ * Creates a standardized API error response.
+ *
+ * This helper ensures all error responses share
+ * the same structure and can be handled consistently
+ * by clients or higher-level handlers.
+ *
+ * @param code - Machine-readable error code
+ * @param message - Human-readable error message
+ * @returns ApiErrorResult object
+ *
+ * @example
+ * ```ts
+ * return ApiError("NOT_FOUND", "User not found");
+ * ```
+ */
+declare function ApiError(code: string, message: string): ApiErrorResult;
+/**
+ * Creates a standardized API success response.
+ *
+ * Wraps the provided data in a consistent success shape.
+ *
+ * @template T - Type of the returned data
+ * @param data - Data to return to the client
+ * @returns ApiSuccessResult containing the data
+ *
+ * @example
+ * ```ts
+ * return ApiSuccess(user);
+ * ```
+ */
+declare function ApiSuccess<T>(data: T): ApiSuccessResult<T>;
+
 /**
  * Creates a new email log entry in the database.
  *
@@ -30,7 +108,7 @@ declare function createEmailLog(db: any, email: string, metadata: any): Promise<
  * @param customSelect - Optional Prisma select object to customize returned fields.
  * @returns The user object with role and active workspace, or an error object.
  */
-declare function getUser(db: any, session: any, customSelect?: any): Promise<any>;
+declare function getUser(db: any, session: any, customSelect?: any): Promise<ApiErrorResult | ApiSuccessResult<any>>;
 /**
  * Updates a user's information in the database.
  *
@@ -43,7 +121,7 @@ declare function getUser(db: any, session: any, customSelect?: any): Promise<any
  * @param customSelect - Optional Prisma select object to customize returned fields.
  * @returns The updated user object with role and active workspace, or an error object.
  */
-declare function updateUser(db: any, session: any, data: Record<string, any>, customSelect?: any): Promise<any>;
+declare function updateUser(db: any, session: any, data: Record<string, any>, customSelect?: any): Promise<ApiErrorResult | ApiSuccessResult<any>>;
 /**
  * Updates a specific user's data by their ID.
  *
@@ -82,7 +160,7 @@ declare function getInitialUserData(db: any, session: any): Promise<{
  * @param customSelect - Optional Prisma select object.
  * @returns The workspace object with currentUserRole, or an error object.
  */
-declare function getWorkspacebySlug(db: any, session: any, slug: string, customSelect?: any): Promise<any>;
+declare function getWorkspacebySlug(db: any, session: any, slug: string, customSelect?: any): Promise<ApiErrorResult | ApiSuccessResult<any>>;
 /**
  * Retrieves a list of workspaces the user is a member of.
  *
@@ -91,7 +169,7 @@ declare function getWorkspacebySlug(db: any, session: any, slug: string, customS
  * @param customSelect - Optional Prisma select object.
  * @returns Array of workspace objects with currentUserRole, or an error object.
  */
-declare function getWorkspaceList(db: any, session: any, customSelect?: any): Promise<any>;
+declare function getWorkspaceList(db: any, session: any, customSelect?: any): Promise<ApiErrorResult | ApiSuccessResult<any>>;
 /**
  * Fetches the initial workspace data for the active user.
  *
@@ -216,4 +294,4 @@ declare const workspaceSelect: {
     };
 };
 
-export { createEmailLog, createId, createIdCustom, getInitialUserData, getInitialWorkspaceData, getLastActiveWorkspace, getUser, getWorkspaceList, getWorkspacebySlug, updateUser, updateUserData, userSelect, validateWorkspaceAccess, workspaceSelect };
+export { ApiError, type ApiErrorResult, ApiSuccess, type ApiSuccessResult, createEmailLog, createId, createIdCustom, getInitialUserData, getInitialWorkspaceData, getLastActiveWorkspace, getUser, getWorkspaceList, getWorkspacebySlug, updateUser, updateUserData, userSelect, validateWorkspaceAccess, workspaceSelect };

package/dist/index.js

@@ -25,6 +25,20 @@ var createIdCustom = ({ prefix }) => {
   return `${prefix}${id}`;
 };
 
+// src/lib/utils.ts
+function ApiError(code, message) {
+  return {
+    ok: false,
+    error: { code, message }
+  };
+}
+function ApiSuccess(data) {
+  return {
+    ok: true,
+    data
+  };
+}
+
 // src/queries/email-log.ts
 async function createEmailLog(db, email, metadata) {
   await db.emailLog.create({
@@ -65,7 +79,7 @@ var userSelect = (workspaceId) => ({
 // src/queries/user.ts
 async function getUser(db, session, customSelect) {
   if (!session || !session.user) {
-    return { error: true, message: "User not authenticated" };
+    return ApiError("UNAUTHORIZED", "User not authenticated");
   }
   try {
     const result = await db.user.findUnique({
@@ -73,22 +87,22 @@ async function getUser(db, session, customSelect) {
       select: customSelect || userSelect(session?.session?.activeOrganizationId || "")
     });
     if (!result) {
-      return { error: true, message: "User not found" };
+      return ApiError("NOT_FOUND", "User not found");
     }
     const user = {
       ...result,
       workspaceRole: result?.members[0]?.role || null,
       activeWorkspace: result?.members[0]?.organization || null
     };
-    return user;
+    return ApiSuccess(user);
   } catch (error) {
     console.error("Error fetching user data:", error);
-    return { error: true, message: "Error fetching user data." };
+    return ApiError("INTERNAL_SERVER_ERROR", "Error fetching user data.");
   }
 }
 async function updateUser(db, session, data, customSelect) {
   if (!session || !session.user) {
-    return { error: true, message: "User not authenticated" };
+    return ApiError("UNAUTHORIZED", "User not authenticated");
   }
   try {
     const result = await db.user.update({
@@ -97,17 +111,17 @@ async function updateUser(db, session, data, customSelect) {
       select: customSelect || userSelect(session?.session?.activeOrganizationId || "")
     });
     if (!result) {
-      return { error: true, message: "User not found" };
+      return ApiError("NOT_FOUND", "User not found");
     }
     const user = {
       ...result,
       workspaceRole: result?.members[0]?.role || null,
       activeWorkspace: result?.members[0]?.organization || null
     };
-    return user;
+    return ApiSuccess(user);
   } catch (error) {
     console.error("Error updating user data:", error);
-    return { error: true, message: "Error updating user data." };
+    return ApiError("INTERNAL_SERVER_ERROR", "Error updating user data.");
   }
 }
 async function updateUserData(db, userId, data) {
@@ -220,7 +234,7 @@ var workspaceSelect = {
 // src/queries/workspace.ts
 async function getWorkspacebySlug(db, session, slug, customSelect) {
   if (!session || !session.user) {
-    return { error: true, message: "User not authenticated" };
+    return ApiError("UNAUTHORIZED", "User not authenticated");
   }
   try {
     const result = await db.organization.findUnique({
@@ -228,11 +242,11 @@ async function getWorkspacebySlug(db, session, slug, customSelect) {
       select: customSelect || workspaceSelect
     });
     if (!result) {
-      return { error: true, message: "Workspace not found" };
+      return ApiError("NOT_FOUND", "Workspace not found");
     }
     const isUserMember = result.members.some((member) => member.userId === session.user.id);
     if (!isUserMember) {
-      return { error: true, message: "User is not a member of the workspace" };
+      return ApiError("FORBIDDEN", "User is not a member of the workspace");
     }
     const currentUserMember = result.members.find(
       (member) => member.userId === session.user.id
@@ -242,15 +256,15 @@ async function getWorkspacebySlug(db, session, slug, customSelect) {
       ...result,
       currentUserRole
     };
-    return workspace;
+    return ApiSuccess(workspace);
   } catch (error) {
     console.error("Error fetching workspace data:", error);
-    return { error: true, message: "Error fetching workspace data." };
+    return ApiError("INTERNAL_SERVER_ERROR", "Error fetching workspace data.");
   }
 }
 async function getWorkspaceList(db, session, customSelect) {
   if (!session || !session.user) {
-    return { error: true, message: "User not authenticated" };
+    return ApiError("UNAUTHORIZED", "User not authenticated");
   }
   try {
     const result = await db.organization.findMany({
@@ -273,10 +287,10 @@ async function getWorkspaceList(db, session, customSelect) {
         currentUserRole: currentUserMember?.role || null
       };
     });
-    return workspaces;
+    return ApiSuccess(workspaces);
   } catch (error) {
     console.error("Error fetching workspace list:", error);
-    return { error: true, message: "Error fetching workspace list." };
+    return ApiError("INTERNAL_SERVER_ERROR", "Error fetching workspace list.");
   }
 }
 async function getInitialWorkspaceData(db, session, customSelect) {
@@ -371,6 +385,8 @@ async function validateWorkspaceAccess(db, session, slug) {
   return Boolean(workspace);
 }
 export {
+  ApiError,
+  ApiSuccess,
   createEmailLog,
   createId,
   createIdCustom,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pelatform/starter.db",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A part of SaaS starter kit for Pelatform applications.",
   "author": "Pelatform",
   "license": "MIT",