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

package/dist/index.d.mts

@@ -74,6 +74,32 @@ declare enum OAuthProvider {
     FACEBOOK = "facebook"
 }
 
+/**
+ * Subscription-related enums shared between backend and frontend.
+ */
+declare enum SubscriptionStatus {
+    TRIALING = "trialing",
+    ACTIVE = "active",
+    PAST_DUE = "past_due",
+    CANCELLED = "cancelled",
+    EXPIRED = "expired"
+}
+declare enum BillingCycle {
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+declare enum InvoiceStatus {
+    DRAFT = "draft",
+    OPEN = "open",
+    PAID = "paid",
+    VOID = "void",
+    UNCOLLECTIBLE = "uncollectible"
+}
+declare enum PaymentProviderType {
+    STRIPE = "stripe",
+    FLUTTERWAVE = "flutterwave"
+}
+
 interface SuccessResponse<T> {
     success: true;
     data: T;
@@ -278,6 +304,27 @@ interface UserResponseDto extends UserDto {
     lastActive?: string;
 }
 
+/**
+ * Full image DTO with all metadata for detailed views
+ */
+interface ImageDto {
+    id: string;
+    url: string;
+    thumbnailUrl?: string;
+    width: number;
+    height: number;
+    mimeType: string;
+    dominantColor?: string;
+}
+/**
+ * Minimal image reference for list views
+ */
+interface ImageRefDto {
+    id: string;
+    url: string;
+    thumbnailUrl?: string;
+}
+
 interface CreateBusinessDto {
     name: string;
     email: string;
@@ -296,6 +343,7 @@ interface UpdateBusinessDto {
     address?: string;
     description?: string;
     industryType?: string;
+    status?: BusinessStatus;
 }
 interface BusinessDto {
     id: string;
@@ -317,18 +365,21 @@ interface BusinessListItemDto {
     name: string;
     description?: string;
     address?: string;
+    email?: string;
+    phone?: string;
     status: string;
     industryType?: string;
     activeProgramCount?: number;
     totalCustomers?: number;
+    profileImage?: ImageRefDto;
+    images?: ImageRefDto[];
 }
 /**
  * Detailed business DTO for admin views
  * Excludes: qrSecret (never exposed)
+ * Contact fields (email, phone) are inherited from BusinessListItemDto.
  */
 interface BusinessDetailDto extends BusinessListItemDto {
-    email?: string;
-    phone?: string;
     staffCount?: number;
     programCount?: number;
     createdAt: string;
@@ -394,9 +445,112 @@ interface LoyaltyProgramDto {
     id: string;
     businessId: string;
     name: string;
+    description?: string;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    coverImage?: ImageRefDto;
+}
+
+interface PlanFeatures {
+    maxPrograms: number;
+    maxCustomers: number;
+    maxStaff: number;
+    promotions: boolean;
+    advancedAnalytics: boolean;
+    prioritySupport: boolean;
+    customBranding: boolean;
+}
+interface SubscriptionPlanDto {
+    id: string;
+    name: string;
+    displayName: string;
+    description: string | null;
+    monthlyPriceUsd: number;
+    yearlyPriceUsd: number;
+    features: PlanFeatures;
+    trialDays: number;
+    stripePriceIdMonthly: string | null;
+    stripePriceIdYearly: string | null;
+    flutterwavePlanIdMonthly: string | null;
+    flutterwavePlanIdYearly: string | null;
     isActive: boolean;
+    position: number;
     createdAt: string;
     updatedAt: string;
 }
+interface CreateSubscriptionPlanDto {
+    name: string;
+    displayName: string;
+    description?: string;
+    monthlyPriceUsd: number;
+    yearlyPriceUsd: number;
+    features: PlanFeatures;
+    trialDays?: number;
+    stripePriceIdMonthly?: string;
+    stripePriceIdYearly?: string;
+    flutterwavePlanIdMonthly?: string;
+    flutterwavePlanIdYearly?: string;
+    isActive?: boolean;
+    position?: number;
+}
+interface UpdateSubscriptionPlanDto {
+    name?: string;
+    displayName?: string;
+    description?: string;
+    monthlyPriceUsd?: number;
+    yearlyPriceUsd?: number;
+    features?: Partial<PlanFeatures>;
+    trialDays?: number;
+    stripePriceIdMonthly?: string;
+    stripePriceIdYearly?: string;
+    flutterwavePlanIdMonthly?: string;
+    flutterwavePlanIdYearly?: string;
+    isActive?: boolean;
+    position?: number;
+}
+interface BusinessSubscriptionDto {
+    id: string;
+    businessId: string;
+    planId: string;
+    status: SubscriptionStatus;
+    billingCycle: BillingCycle;
+    currentPeriodStart: string;
+    currentPeriodEnd: string | null;
+    trialEndsAt: string | null;
+    cancelledAt: string | null;
+    providerSubscriptionId: string | null;
+    providerType: PaymentProviderType | null;
+    plan?: SubscriptionPlanDto;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateBusinessSubscriptionDto {
+    businessId: string;
+    planId: string;
+    billingCycle: BillingCycle;
+    providerType: PaymentProviderType;
+    phoneNumber?: string;
+}
+interface UpgradeSubscriptionDto {
+    planId?: string;
+    billingCycle?: BillingCycle;
+}
+interface InvoiceDto {
+    id: string;
+    businessId: string;
+    subscriptionId: string | null;
+    paymentId: string | null;
+    invoiceNumber: string;
+    amount: number;
+    currency: string;
+    status: InvoiceStatus;
+    periodStart: string;
+    periodEnd: string;
+    dueDate: string;
+    paidAt: string | null;
+    providerInvoiceId: string | null;
+    createdAt: string;
+}
 
-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 };
+export { type ApiResponse, BillingCycle, type BusinessDetailDto, type BusinessDto, type BusinessListItemDto, BusinessStatus, type BusinessSubscriptionDto, type CreateBusinessDto, type CreateBusinessSubscriptionDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateSubscriptionPlanDto, type CreateUserDto, type CustomerAdminResponseDto, type CustomerDto, type CustomerResponseDto, type ErrorDetail, type ErrorResponse, type ForgotPasswordDto, type ImageDto, type ImageRefDto, type InvoiceDto, InvoiceStatus, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type OAuthCallbackQueryDto, type OAuthErrorResponseDto, type OAuthInitiateDto, OAuthProvider, type OAuthUserDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, PaymentProviderType, Permission, type PlanFeatures, type RefreshTokenDto, type RegisterDto, type ResendVerificationDto, type ResetPasswordDto, Role, type SubscriptionPlanDto, SubscriptionStatus, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateSubscriptionPlanDto, type UpdateUserDto, type UpgradeSubscriptionDto, type UserDto, type UserResponseDto, type VerificationResponseDto, type VerifyEmailDto };

package/dist/index.d.ts

@@ -74,6 +74,32 @@ declare enum OAuthProvider {
     FACEBOOK = "facebook"
 }
 
+/**
+ * Subscription-related enums shared between backend and frontend.
+ */
+declare enum SubscriptionStatus {
+    TRIALING = "trialing",
+    ACTIVE = "active",
+    PAST_DUE = "past_due",
+    CANCELLED = "cancelled",
+    EXPIRED = "expired"
+}
+declare enum BillingCycle {
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+declare enum InvoiceStatus {
+    DRAFT = "draft",
+    OPEN = "open",
+    PAID = "paid",
+    VOID = "void",
+    UNCOLLECTIBLE = "uncollectible"
+}
+declare enum PaymentProviderType {
+    STRIPE = "stripe",
+    FLUTTERWAVE = "flutterwave"
+}
+
 interface SuccessResponse<T> {
     success: true;
     data: T;
@@ -278,6 +304,27 @@ interface UserResponseDto extends UserDto {
     lastActive?: string;
 }
 
+/**
+ * Full image DTO with all metadata for detailed views
+ */
+interface ImageDto {
+    id: string;
+    url: string;
+    thumbnailUrl?: string;
+    width: number;
+    height: number;
+    mimeType: string;
+    dominantColor?: string;
+}
+/**
+ * Minimal image reference for list views
+ */
+interface ImageRefDto {
+    id: string;
+    url: string;
+    thumbnailUrl?: string;
+}
+
 interface CreateBusinessDto {
     name: string;
     email: string;
@@ -296,6 +343,7 @@ interface UpdateBusinessDto {
     address?: string;
     description?: string;
     industryType?: string;
+    status?: BusinessStatus;
 }
 interface BusinessDto {
     id: string;
@@ -317,18 +365,21 @@ interface BusinessListItemDto {
     name: string;
     description?: string;
     address?: string;
+    email?: string;
+    phone?: string;
     status: string;
     industryType?: string;
     activeProgramCount?: number;
     totalCustomers?: number;
+    profileImage?: ImageRefDto;
+    images?: ImageRefDto[];
 }
 /**
  * Detailed business DTO for admin views
  * Excludes: qrSecret (never exposed)
+ * Contact fields (email, phone) are inherited from BusinessListItemDto.
  */
 interface BusinessDetailDto extends BusinessListItemDto {
-    email?: string;
-    phone?: string;
     staffCount?: number;
     programCount?: number;
     createdAt: string;
@@ -394,9 +445,112 @@ interface LoyaltyProgramDto {
     id: string;
     businessId: string;
     name: string;
+    description?: string;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    coverImage?: ImageRefDto;
+}
+
+interface PlanFeatures {
+    maxPrograms: number;
+    maxCustomers: number;
+    maxStaff: number;
+    promotions: boolean;
+    advancedAnalytics: boolean;
+    prioritySupport: boolean;
+    customBranding: boolean;
+}
+interface SubscriptionPlanDto {
+    id: string;
+    name: string;
+    displayName: string;
+    description: string | null;
+    monthlyPriceUsd: number;
+    yearlyPriceUsd: number;
+    features: PlanFeatures;
+    trialDays: number;
+    stripePriceIdMonthly: string | null;
+    stripePriceIdYearly: string | null;
+    flutterwavePlanIdMonthly: string | null;
+    flutterwavePlanIdYearly: string | null;
     isActive: boolean;
+    position: number;
     createdAt: string;
     updatedAt: string;
 }
+interface CreateSubscriptionPlanDto {
+    name: string;
+    displayName: string;
+    description?: string;
+    monthlyPriceUsd: number;
+    yearlyPriceUsd: number;
+    features: PlanFeatures;
+    trialDays?: number;
+    stripePriceIdMonthly?: string;
+    stripePriceIdYearly?: string;
+    flutterwavePlanIdMonthly?: string;
+    flutterwavePlanIdYearly?: string;
+    isActive?: boolean;
+    position?: number;
+}
+interface UpdateSubscriptionPlanDto {
+    name?: string;
+    displayName?: string;
+    description?: string;
+    monthlyPriceUsd?: number;
+    yearlyPriceUsd?: number;
+    features?: Partial<PlanFeatures>;
+    trialDays?: number;
+    stripePriceIdMonthly?: string;
+    stripePriceIdYearly?: string;
+    flutterwavePlanIdMonthly?: string;
+    flutterwavePlanIdYearly?: string;
+    isActive?: boolean;
+    position?: number;
+}
+interface BusinessSubscriptionDto {
+    id: string;
+    businessId: string;
+    planId: string;
+    status: SubscriptionStatus;
+    billingCycle: BillingCycle;
+    currentPeriodStart: string;
+    currentPeriodEnd: string | null;
+    trialEndsAt: string | null;
+    cancelledAt: string | null;
+    providerSubscriptionId: string | null;
+    providerType: PaymentProviderType | null;
+    plan?: SubscriptionPlanDto;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateBusinessSubscriptionDto {
+    businessId: string;
+    planId: string;
+    billingCycle: BillingCycle;
+    providerType: PaymentProviderType;
+    phoneNumber?: string;
+}
+interface UpgradeSubscriptionDto {
+    planId?: string;
+    billingCycle?: BillingCycle;
+}
+interface InvoiceDto {
+    id: string;
+    businessId: string;
+    subscriptionId: string | null;
+    paymentId: string | null;
+    invoiceNumber: string;
+    amount: number;
+    currency: string;
+    status: InvoiceStatus;
+    periodStart: string;
+    periodEnd: string;
+    dueDate: string;
+    paidAt: string | null;
+    providerInvoiceId: string | null;
+    createdAt: string;
+}
 
-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 };
+export { type ApiResponse, BillingCycle, type BusinessDetailDto, type BusinessDto, type BusinessListItemDto, BusinessStatus, type BusinessSubscriptionDto, type CreateBusinessDto, type CreateBusinessSubscriptionDto, type CreateCustomerDto, type CreateLoyaltyProgramDto, type CreateSubscriptionPlanDto, type CreateUserDto, type CustomerAdminResponseDto, type CustomerDto, type CustomerResponseDto, type ErrorDetail, type ErrorResponse, type ForgotPasswordDto, type ImageDto, type ImageRefDto, type InvoiceDto, InvoiceStatus, type LoggedInUserDto, type LoginDto, type LoginResponseDto, type LoyaltyProgramDto, type OAuthCallbackQueryDto, type OAuthErrorResponseDto, type OAuthInitiateDto, OAuthProvider, type OAuthUserDto, type PaginatedResult, type PaginationMeta, type PaginationQuery, PaymentProviderType, Permission, type PlanFeatures, type RefreshTokenDto, type RegisterDto, type ResendVerificationDto, type ResetPasswordDto, Role, type SubscriptionPlanDto, SubscriptionStatus, type SuccessResponse, type UpdateBusinessDto, type UpdateCustomerDto, type UpdateLoyaltyProgramDto, type UpdateSubscriptionPlanDto, type UpdateUserDto, type UpgradeSubscriptionDto, type UserDto, type UserResponseDto, type VerificationResponseDto, type VerifyEmailDto };

package/dist/index.js

@@ -20,10 +20,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  BillingCycle: () => BillingCycle,
   BusinessStatus: () => BusinessStatus,
+  InvoiceStatus: () => InvoiceStatus,
   OAuthProvider: () => OAuthProvider,
+  PaymentProviderType: () => PaymentProviderType,
   Permission: () => Permission,
-  Role: () => Role
+  Role: () => Role,
+  SubscriptionStatus: () => SubscriptionStatus
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -106,10 +110,42 @@ var OAuthProvider = /* @__PURE__ */ ((OAuthProvider2) => {
   OAuthProvider2["FACEBOOK"] = "facebook";
   return OAuthProvider2;
 })(OAuthProvider || {});
+
+// src/enums/subscription.enum.ts
+var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
+  SubscriptionStatus2["TRIALING"] = "trialing";
+  SubscriptionStatus2["ACTIVE"] = "active";
+  SubscriptionStatus2["PAST_DUE"] = "past_due";
+  SubscriptionStatus2["CANCELLED"] = "cancelled";
+  SubscriptionStatus2["EXPIRED"] = "expired";
+  return SubscriptionStatus2;
+})(SubscriptionStatus || {});
+var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
+  BillingCycle2["MONTHLY"] = "monthly";
+  BillingCycle2["YEARLY"] = "yearly";
+  return BillingCycle2;
+})(BillingCycle || {});
+var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
+  InvoiceStatus2["DRAFT"] = "draft";
+  InvoiceStatus2["OPEN"] = "open";
+  InvoiceStatus2["PAID"] = "paid";
+  InvoiceStatus2["VOID"] = "void";
+  InvoiceStatus2["UNCOLLECTIBLE"] = "uncollectible";
+  return InvoiceStatus2;
+})(InvoiceStatus || {});
+var PaymentProviderType = /* @__PURE__ */ ((PaymentProviderType2) => {
+  PaymentProviderType2["STRIPE"] = "stripe";
+  PaymentProviderType2["FLUTTERWAVE"] = "flutterwave";
+  return PaymentProviderType2;
+})(PaymentProviderType || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  BillingCycle,
   BusinessStatus,
+  InvoiceStatus,
   OAuthProvider,
+  PaymentProviderType,
   Permission,
-  Role
+  Role,
+  SubscriptionStatus
 });

package/dist/index.mjs

@@ -77,9 +77,41 @@ var OAuthProvider = /* @__PURE__ */ ((OAuthProvider2) => {
   OAuthProvider2["FACEBOOK"] = "facebook";
   return OAuthProvider2;
 })(OAuthProvider || {});
+
+// src/enums/subscription.enum.ts
+var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
+  SubscriptionStatus2["TRIALING"] = "trialing";
+  SubscriptionStatus2["ACTIVE"] = "active";
+  SubscriptionStatus2["PAST_DUE"] = "past_due";
+  SubscriptionStatus2["CANCELLED"] = "cancelled";
+  SubscriptionStatus2["EXPIRED"] = "expired";
+  return SubscriptionStatus2;
+})(SubscriptionStatus || {});
+var BillingCycle = /* @__PURE__ */ ((BillingCycle2) => {
+  BillingCycle2["MONTHLY"] = "monthly";
+  BillingCycle2["YEARLY"] = "yearly";
+  return BillingCycle2;
+})(BillingCycle || {});
+var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
+  InvoiceStatus2["DRAFT"] = "draft";
+  InvoiceStatus2["OPEN"] = "open";
+  InvoiceStatus2["PAID"] = "paid";
+  InvoiceStatus2["VOID"] = "void";
+  InvoiceStatus2["UNCOLLECTIBLE"] = "uncollectible";
+  return InvoiceStatus2;
+})(InvoiceStatus || {});
+var PaymentProviderType = /* @__PURE__ */ ((PaymentProviderType2) => {
+  PaymentProviderType2["STRIPE"] = "stripe";
+  PaymentProviderType2["FLUTTERWAVE"] = "flutterwave";
+  return PaymentProviderType2;
+})(PaymentProviderType || {});
 export {
+  BillingCycle,
   BusinessStatus,
+  InvoiceStatus,
   OAuthProvider,
+  PaymentProviderType,
   Permission,
-  Role
+  Role,
+  SubscriptionStatus
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loyal-ix/loyalix-shared-types",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Shared TypeScript types for Loyalix frontend and backend",
   "main": "dist/index.js",
   "module": "dist/index.mjs",