@qelos/global-types 3.11.8 → 3.11.9

package/index.ts

@@ -13,4 +13,5 @@ export * from './app-configuration-metadata'
 export * from './integration-sources'
 export * from './integration'
 export * from './integration-targets'
-export * from './no-code-components';
+export * from './no-code-components';
+export * from './payments';

package/integration-sources.ts

@@ -12,6 +12,8 @@ export enum IntegrationSourceKind {
   GitHub = 'github',
   Gemini = 'gemini',
   Sumit = 'sumit',
+  PayPal = 'paypal',
+  Paddle = 'paddle',
   AWS = 'aws',
   Cloudflare = 'cloudflare',
 }
@@ -91,6 +93,30 @@ export const SumitTargetOperation = {
   deleteRecurringPayment: 'deleteRecurringPayment',
 }
 
+export const PayPalTargetOperation = {
+  createOrder: 'createOrder',
+  captureOrder: 'captureOrder',
+  refundPayment: 'refundPayment',
+  createProduct: 'createProduct',
+  createSubscription: 'createSubscription',
+  listTransactions: 'listTransactions',
+} as const;
+
+export const PaddleTargetOperation = {
+  createProduct: 'createProduct',
+  listProducts: 'listProducts',
+  createPrice: 'createPrice',
+  listPrices: 'listPrices',
+  createSubscription: 'createSubscription',
+  getSubscription: 'getSubscription',
+  listSubscriptions: 'listSubscriptions',
+  cancelSubscription: 'cancelSubscription',
+  listTransactions: 'listTransactions',
+  getTransaction: 'getTransaction',
+  createCustomer: 'createCustomer',
+  listCustomers: 'listCustomers',
+} as const;
+
 export const AWSTargetOperation = {
   callFunction: 'callFunction',
   getFunction: 'getFunction',
@@ -154,6 +180,29 @@ export interface ISumitSource extends IIntegrationSource {
   };
 }
 
+export interface IPayPalSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.PayPal;
+  authentication: {
+    clientSecret: string;
+  };
+  metadata: {
+    clientId: string;
+    environment: 'sandbox' | 'live';
+  };
+}
+
+export interface IPaddleSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.Paddle;
+  authentication: {
+    apiKey: string;
+  };
+  metadata: {
+    environment: 'sandbox' | 'live';
+  };
+}
+
 export interface IQelosSource extends IIntegrationSource {
   _id?: string;
   kind: IntegrationSourceKind.Qelos;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qelos/global-types",
-  "version": "3.11.8",
+  "version": "3.11.9",
   "description": "",
   "main": "index.ts",
   "types": "index.ts",

package/payments.ts

@@ -0,0 +1,131 @@
+/** Determines whether billing is tied to individual users (B2C) or workspaces (B2B). */
+export type BillableEntityType = 'user' | 'workspace';
+
+/** Lifecycle states of a subscription. */
+export type SubscriptionStatus = 'pending' | 'active' | 'canceled' | 'past_due' | 'trialing' | 'expired';
+
+/** Supported billing intervals. */
+export type BillingCycle = 'monthly' | 'yearly';
+
+/** Payment status of an invoice. */
+export type InvoiceStatus = 'paid' | 'pending' | 'failed' | 'refunded';
+
+/** Type of discount a coupon provides. */
+export type CouponDiscountType = 'percentage' | 'fixed';
+
+/**
+ * Arbitrary limits associated with a plan (e.g. max users, storage quota).
+ * Keys are limit names; values can be numbers, booleans, or strings.
+ */
+export interface IPlanLimits {
+  [key: string]: number | boolean | string;
+}
+
+/**
+ * Maps payment provider kinds to their external product/price identifiers.
+ * Used to link internal plans to provider-specific entities.
+ */
+export interface IPlanExternalIds {
+  [providerKind: string]: {
+    productId?: string;
+    monthlyPriceId?: string;
+    yearlyPriceId?: string;
+  };
+}
+
+/** A pricing plan that users or workspaces can subscribe to. */
+export interface IPlan {
+  _id?: string;
+  /** Tenant identifier for multi-tenant isolation. */
+  tenant: string;
+  name: string;
+  description?: string;
+  /** Human-readable feature descriptions displayed on pricing pages. */
+  features: string[];
+  monthlyPrice: number;
+  yearlyPrice: number;
+  /** ISO 4217 currency code (e.g. "USD", "EUR"). */
+  currency: string;
+  isActive: boolean;
+  /** Controls display order — lower numbers appear first. */
+  sortOrder: number;
+  limits?: IPlanLimits;
+  externalIds?: IPlanExternalIds;
+  metadata?: Record<string, any>;
+  created?: Date;
+}
+
+/** A subscription linking a billable entity to a plan. */
+export interface ISubscription {
+  _id?: string;
+  tenant: string;
+  /** Reference to the subscribed plan. */
+  planId: string;
+  billableEntityType: BillableEntityType;
+  billableEntityId: string;
+  status: SubscriptionStatus;
+  billingCycle: BillingCycle;
+  currentPeriodStart?: Date;
+  currentPeriodEnd?: Date;
+  /** Provider-side subscription identifier for reconciliation. */
+  externalSubscriptionId?: string;
+  /** Integration source ID used for this subscription's provider calls. */
+  providerId?: string;
+  /** Payment provider kind (e.g. "paddle", "paypal", "sumit"). */
+  providerKind?: string;
+  couponId?: string;
+  metadata?: Record<string, any>;
+  created?: Date;
+}
+
+/** A single line item within an invoice. */
+export interface IInvoiceItem {
+  description: string;
+  amount: number;
+  quantity: number;
+}
+
+/** An invoice record for a payment event. */
+export interface IInvoice {
+  _id?: string;
+  tenant: string;
+  subscriptionId?: string;
+  billableEntityType: BillableEntityType;
+  billableEntityId: string;
+  amount: number;
+  /** ISO 4217 currency code. */
+  currency: string;
+  status: InvoiceStatus;
+  /** Provider-side invoice identifier. */
+  externalInvoiceId?: string;
+  providerKind?: string;
+  /** URL to download/view the invoice from the provider. */
+  invoiceUrl?: string;
+  paidAt?: Date;
+  periodStart?: Date;
+  periodEnd?: Date;
+  items: IInvoiceItem[];
+  created?: Date;
+}
+
+/** A discount coupon that can be applied during checkout. */
+export interface ICoupon {
+  _id?: string;
+  tenant: string;
+  /** Unique coupon code entered by users. */
+  code: string;
+  discountType: CouponDiscountType;
+  /** For percentage: 0–100. For fixed: absolute amount in the coupon's currency. */
+  discountValue: number;
+  /** ISO 4217 currency code — relevant for fixed-amount discounts. */
+  currency?: string;
+  /** `null` or `undefined` means unlimited redemptions. */
+  maxRedemptions?: number;
+  currentRedemptions: number;
+  validFrom?: Date;
+  validUntil?: Date;
+  /** Empty array means the coupon applies to all plans. */
+  applicablePlanIds: string[];
+  isActive: boolean;
+  created?: Date;
+}