@qelos/global-types 4.2.1 → 4.3.0

package/dist/payments.d.ts

@@ -1,165 +0,0 @@
-/** 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';
-/**
- * Real-world identity of the billable entity, passed through checkout so payment
- * providers (e.g. Sumit) can create a properly-named customer record instead of
- * falling back to the raw billable entity ID.
- */
-export interface CheckoutCustomer {
-    name?: string;
-    /** Legal/invoice name, e.g. a company name distinct from the contact's personal name. */
-    nameForInvoice?: string;
-    email?: string;
-    phone?: string;
-    address?: string;
-    city?: string;
-    /** Company tax/VAT identifier. */
-    taxId?: string;
-}
-/** Tenant payments settings stored in the `payments-configuration` configuration key. */
-export interface IPaymentsConfigurationMetadata {
-    isEnabled?: boolean;
-    /** Integration source `_id` (admin UI field name). */
-    paymentSourceId?: string;
-    /** Same as `paymentSourceId`; normalized by the payments service when loading config. */
-    providerSourceId?: string;
-    providerKind?: 'paddle' | 'paypal' | 'sumit' | 'dodopayments' | string;
-    defaultCurrency?: string;
-    gracePeriodDays?: number;
-    /** Default redirect URL after successful checkout (required for Sumit unless overridden per checkout). */
-    successUrl?: string;
-    /** Default redirect URL when the user cancels checkout (required for Sumit unless overridden per checkout). */
-    cancelUrl?: string;
-    webhookSecret?: string;
-}
-/**
- * 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;
-    /**
-     * 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>;
-    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;
-    /**
-     * 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;
-}
-/** 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;
-}

package/dist/payments.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=payments.js.map

package/dist/payments.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"payments.js","sourceRoot":"","sources":["../payments.ts"],"names":[],"mappings":""}

package/dist/plugin-crud.d.ts

@@ -1,11 +0,0 @@
-export interface IPluginCrud {
-    name: string;
-    display: {
-        name: string;
-        plural: string;
-        capitalized: string;
-        capitalizedPlural: string;
-    };
-    identifierKey: string;
-    schema: any;
-}

package/dist/plugin-crud.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=plugin-crud.js.map

package/dist/plugin-crud.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin-crud.js","sourceRoot":"","sources":["../plugin-crud.ts"],"names":[],"mappings":""}

package/dist/plugin.d.ts

@@ -1,30 +0,0 @@
-import { IMicroFrontend } from './micro-frontend';
-import { IEventSubscriber } from './event-subscriber';
-import { IPluginCrud } from './plugin-crud';
-import { IInjectable } from './injectable';
-import { INavbarGroup } from './navbar-group';
-export interface IPlugin {
-    tenant: string;
-    name: string;
-    description?: string;
-    apiPath: string;
-    registerUrl: string;
-    user: string;
-    token: string;
-    proxyUrl: string;
-    authAcquire: {
-        refreshTokenUrl: string;
-        refreshTokenKey: string;
-        accessTokenKey: string;
-    };
-    auth: {
-        refreshTokenIdentifier?: string;
-    };
-    manifestUrl: string;
-    callbackUrl?: string;
-    subscribedEvents: IEventSubscriber[];
-    microFrontends: IMicroFrontend[];
-    cruds: IPluginCrud[];
-    injectables: IInjectable[];
-    navBarGroups?: INavbarGroup[];
-}

package/dist/plugin.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../plugin.ts"],"names":[],"mappings":""}

package/dist/qelos-integrator.d.ts

@@ -1,112 +0,0 @@
-/**
- * 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;
-}

package/dist/qelos-integrator.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * 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`.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=qelos-integrator.js.map

package/dist/qelos-integrator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"qelos-integrator.js","sourceRoot":"","sources":["../qelos-integrator.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG"}

package/dist/query-filters.d.ts

@@ -1,7 +0,0 @@
-export interface ICommonQueryFilters {
-    $populate?: boolean;
-    $sort?: string;
-    $limit?: number;
-    $page?: number;
-    $flat?: boolean;
-}

package/dist/query-filters.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=query-filters.js.map

package/dist/query-filters.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-filters.js","sourceRoot":"","sources":["../query-filters.ts"],"names":[],"mappings":""}

package/dist/screen-requirement.d.ts

@@ -1,22 +0,0 @@
-export interface IScreenRequirement {
-    key: string;
-    fromHTTP?: {
-        uri: string;
-        method: string;
-        query?: any;
-    };
-    fromCrud?: {
-        name: string;
-        identifier?: string;
-        query?: any;
-    };
-    fromBlueprint?: {
-        name: string;
-        identifier?: string;
-        query?: any;
-        dependsOn?: string;
-        dependsField?: string;
-    };
-    fromData?: any;
-    lazy?: boolean;
-}

package/dist/screen-requirement.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=screen-requirement.js.map

package/dist/screen-requirement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"screen-requirement.js","sourceRoot":"","sources":["../screen-requirement.ts"],"names":[],"mappings":""}

package/dist/workspace-configuration-metadata.d.ts

@@ -1,17 +0,0 @@
-export interface WorkspaceLabelDefinition {
-    title: string;
-    description: string;
-    value: string[];
-    allowedRolesForCreation?: string[];
-}
-export interface WorkspaceConfigurationMetadata {
-    isActive: boolean;
-    creationPrivilegedRoles: string[];
-    viewMembersPrivilegedWsRoles: string[];
-    labels: WorkspaceLabelDefinition[];
-    allowNonLabeledWorkspaces: boolean;
-    allowNonWorkspaceUsers: boolean;
-    allowLogo?: boolean;
-    createWorkspacePageTitle?: string;
-    labelsSelectorTitle?: string;
-}

package/dist/workspace-configuration-metadata.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=workspace-configuration-metadata.js.map

package/dist/workspace-configuration-metadata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workspace-configuration-metadata.js","sourceRoot":"","sources":["../workspace-configuration-metadata.ts"],"names":[],"mappings":""}