@qelos/global-types 3.11.11 → 4.1.0

package/index.ts

@@ -14,4 +14,5 @@ export * from './integration-sources'
 export * from './integration'
 export * from './integration-targets'
 export * from './no-code-components';
-export * from './payments';
+export * from './payments';
+export * from './qelos-integrator';

package/integration-sources.ts

@@ -14,6 +14,7 @@ export enum IntegrationSourceKind {
   Sumit = 'sumit',
   PayPal = 'paypal',
   Paddle = 'paddle',
+  DodoPayments = 'dodopayments',
   AWS = 'aws',
   Cloudflare = 'cloudflare',
 }
@@ -117,6 +118,27 @@ export const PaddleTargetOperation = {
   listCustomers: 'listCustomers',
 } as const;
 
+export const DodoPaymentsTargetOperation = {
+  // Payments
+  createPayment: 'createPayment',
+  getPayment: 'getPayment',
+  listPayments: 'listPayments',
+  // Subscriptions
+  createSubscription: 'createSubscription',
+  getSubscription: 'getSubscription',
+  updateSubscription: 'updateSubscription',
+  cancelSubscription: 'cancelSubscription',
+  listSubscriptions: 'listSubscriptions',
+  // Products
+  createProduct: 'createProduct',
+  getProduct: 'getProduct',
+  listProducts: 'listProducts',
+  // Customers
+  createCustomer: 'createCustomer',
+  getCustomer: 'getCustomer',
+  listCustomers: 'listCustomers',
+} as const;
+
 export const AWSTargetOperation = {
   callFunction: 'callFunction',
   getFunction: 'getFunction',
@@ -203,6 +225,17 @@ export interface IPaddleSource extends IIntegrationSource {
   };
 }
 
+export interface IDodoPaymentsSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.DodoPayments;
+  authentication: {
+    apiKey: string;
+  };
+  metadata: {
+    environment: 'test' | '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.11",
+  "version": "4.1.0",
   "description": "",
   "main": "index.ts",
   "types": "index.ts",

package/payments.ts

@@ -49,6 +49,13 @@ export interface IPlan {
   isActive: boolean;
   /** Controls display order — lower numbers appear first. */
   sortOrder: number;
+  /**
+   * When `true`, the price is not fixed — it is calculated at checkout time
+   * (e.g. per-user, per-item, or otherwise variable). `monthlyPrice` /
+   * `yearlyPrice` are ignored for dynamic plans; the caller must supply an
+   * `amount` at checkout instead.
+   */
+  dynamic?: boolean;
   limits?: IPlanLimits;
   externalIds?: IPlanExternalIds;
   metadata?: Record<string, any>;
@@ -74,6 +81,12 @@ export interface ISubscription {
   /** Payment provider kind (e.g. "paddle", "paypal", "sumit"). */
   providerKind?: string;
   couponId?: string;
+  /**
+   * Admin-configured charge amount for dynamic-priced plans. Only admins may
+   * set this field; it is read by the checkout service when `IPlan.dynamic` is
+   * `true`. Must be set before checkout can proceed on a dynamic plan.
+   */
+  dynamicAmount?: number;
   metadata?: Record<string, any>;
   created?: Date;
 }

package/qelos-integrator.ts

@@ -0,0 +1,124 @@
+/**
+ * Shared contracts every Qelos framework integrator (`@qelos/integrator-*`)
+ * builds upon. Defined here — rather than in each integrator — so the
+ * per-request shape and configuration surface are guaranteed identical across
+ * frameworks.
+ *
+ * `@qelos/sdk` depends on `@qelos/global-types`, so this file deliberately
+ * avoids importing from the SDK; instead, {@link QelosContext} is generic over
+ * the SDK instance type and integrators specialize it with the concrete
+ * `QelosSDK` / `IUser` / `IWorkspace` types from `@qelos/sdk`.
+ */
+
+/**
+ * Tokens read from an inbound request. Integrators mutate this object in place
+ * when a refresh occurs so later code can read the current pair.
+ */
+export interface QelosTokenPair {
+  accessToken?: string;
+  refreshToken?: string;
+}
+
+/**
+ * Result of a successful token refresh.
+ */
+export interface ResolvedTokens {
+  accessToken: string;
+  refreshToken?: string;
+}
+
+/**
+ * Minimal user contract shared by all integrators. The SDK's `IUser` (rich,
+ * with first/last name, metadata, etc.) is assignable to this and is what
+ * integrators actually plug in via the `TUser` parameter on
+ * {@link QelosContext}.
+ */
+export interface IQelosUser {
+  _id: string;
+  username: string;
+  email: string;
+  roles: string[];
+
+  [key: string]: any;
+}
+
+/**
+ * Minimal workspace contract shared by all integrators. The SDK's `IWorkspace`
+ * is assignable to this.
+ */
+export interface IQelosWorkspace {
+  name: string;
+
+  [key: string]: any;
+}
+
+/**
+ * Base configuration contract every framework integrator builds upon.
+ * Framework-specific configs (e.g. `QelosExpressConfig`, `QelosNextConfig`)
+ * extend this with transport-specific options such as `sdkOptions`.
+ */
+export interface QelosConfig {
+  /**
+   * Base URL of the Qelos backend (e.g. https://yourdomain.com).
+   */
+  appUrl: string;
+  /**
+   * Static API token used for service-to-service calls. When provided, no
+   * cookie/refresh-token handling is performed.
+   */
+  apiToken?: string;
+  /**
+   * Cookie name carrying the Qelos access token. Defaults to `q_access_token`.
+   */
+  accessTokenCookie?: string;
+  /**
+   * Cookie name carrying the Qelos refresh token. Defaults to `q_refresh_token`.
+   */
+  refreshTokenCookie?: string;
+  /**
+   * If true, the integrator rejects requests (401) when the user cannot be
+   * resolved. Defaults to `false` — anonymous requests pass through with
+   * `qelos.user = null`.
+   */
+  requireAuth?: boolean;
+  /**
+   * Skip the integrator entirely for requests whose path starts with any of
+   * these prefixes. Useful for `/health`, `/_next`, `/api/_auth`, etc.
+   */
+  skipPaths?: string[];
+}
+
+/**
+ * Per-request Qelos context every integrator produces. Generic over the SDK
+ * instance type and the user/workspace shape so framework integrators narrow
+ * these to the SDK's concrete types (`QelosSDK`, `IUser`, `IWorkspace`)
+ * without dragging the SDK into `@qelos/global-types`.
+ */
+export interface QelosContext<
+  TSdk = unknown,
+  TUser extends IQelosUser = IQelosUser,
+  TWorkspace extends IQelosWorkspace = IQelosWorkspace,
+> {
+  /**
+   * The authenticated user, or `null` when anonymous.
+   */
+  user: TUser | null;
+  /**
+   * The active workspace for the request, or `null` when none is active /
+   * the user is anonymous.
+   */
+  workspace: TWorkspace | null;
+  /**
+   * The full list of workspaces the user has access to.
+   */
+  workspaces: TWorkspace[];
+  /**
+   * SDK instance bound to the current request's tokens.
+   */
+  sdk: TSdk;
+  /**
+   * Tokens read from the request. Mutated in place when a refresh occurs so
+   * later code can read the current pair.
+   */
+  tokens: QelosTokenPair;
+}