@loyal-ix/loyalix-shared-types 1.0.0 → 1.2.0

package/dist/index.d.mts

@@ -65,6 +65,15 @@ declare enum BusinessStatus {
     SUSPENDED = "suspended"
 }
 
+/**
+ * OAuth Provider Enum
+ * Supported third-party authentication providers
+ */
+declare enum OAuthProvider {
+    GOOGLE = "google",
+    FACEBOOK = "facebook"
+}
+
 interface SuccessResponse<T> {
     success: true;
     data: T;
@@ -153,6 +162,84 @@ interface LoginResponseDto {
     user: LoggedInUserDto;
 }
 
+interface VerifyEmailDto {
+    token: string;
+}
+interface ResendVerificationDto {
+    email: string;
+}
+interface VerificationResponseDto {
+    success: boolean;
+    message: string;
+}
+
+interface ForgotPasswordDto {
+    email: string;
+}
+interface ResetPasswordDto {
+    token: string;
+    newPassword: string;
+}
+
+/**
+ * OAuth Authentication DTOs
+ * Used for third-party authentication (Google, Facebook)
+ */
+/**
+ * OAuth user data received from provider after authentication
+ */
+interface OAuthUserDto {
+    /** Email from OAuth provider */
+    email: string;
+    /** First name from OAuth profile */
+    firstName?: string;
+    /** Last name from OAuth profile */
+    lastName?: string;
+    /** OAuth provider name (google, facebook) */
+    provider: string;
+    /** Unique user ID from the OAuth provider */
+    providerId: string;
+    /** OAuth access token (optional, for API calls) */
+    accessToken?: string;
+    /** OAuth refresh token (optional, for token refresh) */
+    refreshToken?: string;
+    /** Profile photo URL from OAuth provider */
+    profilePhoto?: string;
+    /** Account type for new registrations */
+    accountType?: 'customer' | 'business';
+}
+/**
+ * DTO for initiating OAuth flow
+ */
+interface OAuthInitiateDto {
+    /** Account type - required for new user registration */
+    accountType: 'customer' | 'business';
+}
+/**
+ * OAuth error response when authentication fails
+ */
+interface OAuthErrorResponseDto {
+    /** Error code for programmatic handling */
+    code: string;
+    /** Human-readable error message */
+    message: string;
+    /** Existing auth method if email conflict (e.g., 'email', 'google', 'facebook') */
+    existingAuthMethod?: string;
+}
+/**
+ * OAuth callback query parameters
+ */
+interface OAuthCallbackQueryDto {
+    /** OAuth authorization code */
+    code?: string;
+    /** State parameter (contains accountType) */
+    state?: string;
+    /** Error from OAuth provider */
+    error?: string;
+    /** Error description from OAuth provider */
+    error_description?: string;
+}
+
 interface CreateUserDto {
     email: string;
     password: string;
@@ -174,7 +261,6 @@ interface UpdateUserDto {
 interface UserDto {
     id: string;
     email: string;
-    username?: string;
     firstName?: string;
     lastName?: string;
     phoneNumber?: string;
@@ -182,6 +268,15 @@ interface UserDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * User response DTO with roles and profile photo
+ * Used for API responses - excludes sensitive fields (password, deviceToken)
+ */
+interface UserResponseDto extends UserDto {
+    roles: string[];
+    profilePhotoUrl?: string;
+    lastActive?: string;
+}
 
 interface CreateBusinessDto {
     name: string;
@@ -213,6 +308,32 @@ interface BusinessDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Minimal business DTO for list endpoints (public-facing)
+ * Excludes sensitive fields: qrSecret, staffMembers details
+ */
+interface BusinessListItemDto {
+    id: string;
+    name: string;
+    description?: string;
+    address?: string;
+    status: string;
+    industryType?: string;
+    activeProgramCount?: number;
+    totalCustomers?: number;
+}
+/**
+ * Detailed business DTO for admin views
+ * Excludes: qrSecret (never exposed)
+ */
+interface BusinessDetailDto extends BusinessListItemDto {
+    email?: string;
+    phone?: string;
+    staffCount?: number;
+    programCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
 
 interface CreateCustomerDto {
     userId: string;
@@ -234,6 +355,31 @@ interface CustomerDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Customer response DTO with nested user info
+ * Excludes sensitive user fields: password, deviceToken
+ */
+interface CustomerResponseDto {
+    id: string;
+    status: string;
+    user: {
+        id: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        phoneNumber?: string;
+        profilePhotoUrl?: string;
+    };
+    enrollmentCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Customer response for admin views - includes notes
+ */
+interface CustomerAdminResponseDto extends CustomerResponseDto {
+    notes?: string;
+}
 
 interface CreateLoyaltyProgramDto {
     businessId: string;
@@ -253,4 +399,4 @@ interface LoyaltyProgramDto {
     updatedAt: string;
 }
 
-export { type ApiResponse, type BusinessDto, BusinessStatus, type CreateBusinessDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateUserDto, type CustomerDto, type ErrorDetail, type ErrorResponse, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, Permission, type RefreshTokenDto, type RegisterDto, Role, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateUserDto, type UserDto };
+export { type ApiResponse, type BusinessDetailDto, type BusinessDto, type BusinessListItemDto, BusinessStatus, type CreateBusinessDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateUserDto, type CustomerAdminResponseDto, type CustomerDto, type CustomerResponseDto, type ErrorDetail, type ErrorResponse, type ForgotPasswordDto, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type OAuthCallbackQueryDto, type OAuthErrorResponseDto, type OAuthInitiateDto, OAuthProvider, type OAuthUserDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, Permission, type RefreshTokenDto, type RegisterDto, type ResendVerificationDto, type ResetPasswordDto, Role, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateUserDto, type UserDto, type UserResponseDto, type VerificationResponseDto, type VerifyEmailDto };

package/dist/index.d.ts

@@ -65,6 +65,15 @@ declare enum BusinessStatus {
     SUSPENDED = "suspended"
 }
 
+/**
+ * OAuth Provider Enum
+ * Supported third-party authentication providers
+ */
+declare enum OAuthProvider {
+    GOOGLE = "google",
+    FACEBOOK = "facebook"
+}
+
 interface SuccessResponse<T> {
     success: true;
     data: T;
@@ -153,6 +162,84 @@ interface LoginResponseDto {
     user: LoggedInUserDto;
 }
 
+interface VerifyEmailDto {
+    token: string;
+}
+interface ResendVerificationDto {
+    email: string;
+}
+interface VerificationResponseDto {
+    success: boolean;
+    message: string;
+}
+
+interface ForgotPasswordDto {
+    email: string;
+}
+interface ResetPasswordDto {
+    token: string;
+    newPassword: string;
+}
+
+/**
+ * OAuth Authentication DTOs
+ * Used for third-party authentication (Google, Facebook)
+ */
+/**
+ * OAuth user data received from provider after authentication
+ */
+interface OAuthUserDto {
+    /** Email from OAuth provider */
+    email: string;
+    /** First name from OAuth profile */
+    firstName?: string;
+    /** Last name from OAuth profile */
+    lastName?: string;
+    /** OAuth provider name (google, facebook) */
+    provider: string;
+    /** Unique user ID from the OAuth provider */
+    providerId: string;
+    /** OAuth access token (optional, for API calls) */
+    accessToken?: string;
+    /** OAuth refresh token (optional, for token refresh) */
+    refreshToken?: string;
+    /** Profile photo URL from OAuth provider */
+    profilePhoto?: string;
+    /** Account type for new registrations */
+    accountType?: 'customer' | 'business';
+}
+/**
+ * DTO for initiating OAuth flow
+ */
+interface OAuthInitiateDto {
+    /** Account type - required for new user registration */
+    accountType: 'customer' | 'business';
+}
+/**
+ * OAuth error response when authentication fails
+ */
+interface OAuthErrorResponseDto {
+    /** Error code for programmatic handling */
+    code: string;
+    /** Human-readable error message */
+    message: string;
+    /** Existing auth method if email conflict (e.g., 'email', 'google', 'facebook') */
+    existingAuthMethod?: string;
+}
+/**
+ * OAuth callback query parameters
+ */
+interface OAuthCallbackQueryDto {
+    /** OAuth authorization code */
+    code?: string;
+    /** State parameter (contains accountType) */
+    state?: string;
+    /** Error from OAuth provider */
+    error?: string;
+    /** Error description from OAuth provider */
+    error_description?: string;
+}
+
 interface CreateUserDto {
     email: string;
     password: string;
@@ -174,7 +261,6 @@ interface UpdateUserDto {
 interface UserDto {
     id: string;
     email: string;
-    username?: string;
     firstName?: string;
     lastName?: string;
     phoneNumber?: string;
@@ -182,6 +268,15 @@ interface UserDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * User response DTO with roles and profile photo
+ * Used for API responses - excludes sensitive fields (password, deviceToken)
+ */
+interface UserResponseDto extends UserDto {
+    roles: string[];
+    profilePhotoUrl?: string;
+    lastActive?: string;
+}
 
 interface CreateBusinessDto {
     name: string;
@@ -213,6 +308,32 @@ interface BusinessDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Minimal business DTO for list endpoints (public-facing)
+ * Excludes sensitive fields: qrSecret, staffMembers details
+ */
+interface BusinessListItemDto {
+    id: string;
+    name: string;
+    description?: string;
+    address?: string;
+    status: string;
+    industryType?: string;
+    activeProgramCount?: number;
+    totalCustomers?: number;
+}
+/**
+ * Detailed business DTO for admin views
+ * Excludes: qrSecret (never exposed)
+ */
+interface BusinessDetailDto extends BusinessListItemDto {
+    email?: string;
+    phone?: string;
+    staffCount?: number;
+    programCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
 
 interface CreateCustomerDto {
     userId: string;
@@ -234,6 +355,31 @@ interface CustomerDto {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Customer response DTO with nested user info
+ * Excludes sensitive user fields: password, deviceToken
+ */
+interface CustomerResponseDto {
+    id: string;
+    status: string;
+    user: {
+        id: string;
+        email: string;
+        firstName?: string;
+        lastName?: string;
+        phoneNumber?: string;
+        profilePhotoUrl?: string;
+    };
+    enrollmentCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Customer response for admin views - includes notes
+ */
+interface CustomerAdminResponseDto extends CustomerResponseDto {
+    notes?: string;
+}
 
 interface CreateLoyaltyProgramDto {
     businessId: string;
@@ -253,4 +399,4 @@ interface LoyaltyProgramDto {
     updatedAt: string;
 }
 
-export { type ApiResponse, type BusinessDto, BusinessStatus, type CreateBusinessDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateUserDto, type CustomerDto, type ErrorDetail, type ErrorResponse, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, Permission, type RefreshTokenDto, type RegisterDto, Role, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateUserDto, type UserDto };
+export { type ApiResponse, type BusinessDetailDto, type BusinessDto, type BusinessListItemDto, BusinessStatus, type CreateBusinessDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateUserDto, type CustomerAdminResponseDto, type CustomerDto, type CustomerResponseDto, type ErrorDetail, type ErrorResponse, type ForgotPasswordDto, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type OAuthCallbackQueryDto, type OAuthErrorResponseDto, type OAuthInitiateDto, OAuthProvider, type OAuthUserDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, Permission, type RefreshTokenDto, type RegisterDto, type ResendVerificationDto, type ResetPasswordDto, Role, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateUserDto, type UserDto, type UserResponseDto, type VerificationResponseDto, type VerifyEmailDto };

package/dist/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   BusinessStatus: () => BusinessStatus,
+  OAuthProvider: () => OAuthProvider,
   Permission: () => Permission,
   Role: () => Role
 });
@@ -98,9 +99,17 @@ var BusinessStatus = /* @__PURE__ */ ((BusinessStatus2) => {
   BusinessStatus2["SUSPENDED"] = "suspended";
   return BusinessStatus2;
 })(BusinessStatus || {});
+
+// src/enums/oauth-provider.enum.ts
+var OAuthProvider = /* @__PURE__ */ ((OAuthProvider2) => {
+  OAuthProvider2["GOOGLE"] = "google";
+  OAuthProvider2["FACEBOOK"] = "facebook";
+  return OAuthProvider2;
+})(OAuthProvider || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BusinessStatus,
+  OAuthProvider,
   Permission,
   Role
 });

package/dist/index.mjs

@@ -70,8 +70,16 @@ var BusinessStatus = /* @__PURE__ */ ((BusinessStatus2) => {
   BusinessStatus2["SUSPENDED"] = "suspended";
   return BusinessStatus2;
 })(BusinessStatus || {});
+
+// src/enums/oauth-provider.enum.ts
+var OAuthProvider = /* @__PURE__ */ ((OAuthProvider2) => {
+  OAuthProvider2["GOOGLE"] = "google";
+  OAuthProvider2["FACEBOOK"] = "facebook";
+  return OAuthProvider2;
+})(OAuthProvider || {});
 export {
   BusinessStatus,
+  OAuthProvider,
   Permission,
   Role
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loyal-ix/loyalix-shared-types",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Shared TypeScript types for Loyalix frontend and backend",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -12,6 +12,12 @@
       "require": "./dist/index.js"
     }
   },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm run build"
+  },
   "devDependencies": {
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
@@ -29,14 +35,9 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/loyalix/shared-types.git"
+    "url": "https://github.com/zeufack/loyalix-shared-type"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "clean": "rm -rf dist"
   }
-}
+}