@qelos/sdk 3.11.11 → 4.1.0

package/dist/payments.d.ts

@@ -2,11 +2,19 @@ import { QelosSDKOptions } from './types';
 import BaseSDK from './base-sdk';
 import { IPlan, ISubscription, IInvoice, ICoupon, BillingCycle } from '@qelos/global-types';
 export interface CheckoutRequest {
-    planId: string;
-    billingCycle: BillingCycle;
+    /** Required when not providing `subscriptionId`. Must be a non-dynamic plan. */
+    planId?: string;
+    /** Required when not providing `subscriptionId`. */
+    billingCycle?: BillingCycle;
     couponCode?: string;
     successUrl?: string;
     cancelUrl?: string;
+    /**
+     * Pre-created subscription ID. Required for dynamic plans — the admin must set
+     * `dynamicAmount` on the subscription before this checkout call will succeed.
+     * When provided, `planId` and `billingCycle` are ignored.
+     */
+    subscriptionId?: string;
 }
 export interface CheckoutResponse {
     subscriptionId: string;
@@ -22,6 +30,24 @@ export default class QlPayments extends BaseSDK {
         isActive?: boolean;
     }): Promise<IPlan[]>;
     getPlan(planId: string): Promise<IPlan>;
+    /**
+     * Creates a pending subscription for the authenticated user without initiating
+     * payment. Use this as the first step for any plan, and the only step before
+     * `checkout()` for dynamic plans (the admin must call `setSubscriptionDynamicAmount`
+     * before the user can complete checkout).
+     */
+    subscribeToPlan(planId: string, billingCycle: BillingCycle, couponCode?: string): Promise<ISubscription>;
+    /**
+     * Initiates a provider checkout session.
+     *
+     * **Static plans**: pass `planId` + `billingCycle` (a subscription is created
+     * inline).
+     *
+     * **Dynamic plans**: the user must first call `subscribeToPlan()` to create a
+     * pending subscription, then an admin must set the dynamic amount via
+     * `setSubscriptionDynamicAmount()`. Only then should this method be called with
+     * `subscriptionId` pointing to that pending subscription.
+     */
     checkout(params: CheckoutRequest): Promise<CheckoutResponse>;
     getMySubscription(): Promise<ISubscription>;
     cancelSubscription(subscriptionId: string): Promise<ISubscription>;

package/dist/payments.js

@@ -11,6 +11,30 @@ export default class QlPayments extends BaseSDK {
     getPlan(planId) {
         return this.callJsonApi(`${this.relativePath}/plans/${planId}`);
     }
+    /**
+     * Creates a pending subscription for the authenticated user without initiating
+     * payment. Use this as the first step for any plan, and the only step before
+     * `checkout()` for dynamic plans (the admin must call `setSubscriptionDynamicAmount`
+     * before the user can complete checkout).
+     */
+    subscribeToPlan(planId, billingCycle, couponCode) {
+        return this.callJsonApi(`${this.relativePath}/subscriptions`, {
+            method: 'post',
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify({ planId, billingCycle, couponCode }),
+        });
+    }
+    /**
+     * Initiates a provider checkout session.
+     *
+     * **Static plans**: pass `planId` + `billingCycle` (a subscription is created
+     * inline).
+     *
+     * **Dynamic plans**: the user must first call `subscribeToPlan()` to create a
+     * pending subscription, then an admin must set the dynamic amount via
+     * `setSubscriptionDynamicAmount()`. Only then should this method be called with
+     * `subscriptionId` pointing to that pending subscription.
+     */
     checkout(params) {
         return this.callJsonApi(`${this.relativePath}/checkout`, {
             method: 'post',

package/dist/payments.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments.js","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AAmBjC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IACrC,YAAY,GAAG,MAAM,CAAC;IAE9B,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,KAA8B;QACrC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,KAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,WAAW,CAAU,GAAG,IAAI,CAAC,YAAY,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,WAAW,CAAQ,GAAG,IAAI,CAAC,YAAY,UAAU,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,QAAQ,CAAC,MAAuB;QAC9B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,WAAW,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAC7B,CACF,CAAC;IACJ,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,WAAW,CAAgB,GAAG,IAAI,CAAC,YAAY,mBAAmB,CAAC,CAAC;IAClF,CAAC;IAED,kBAAkB,CAAC,cAAsB;QACvC,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,kBAAkB,cAAc,SAAS,EAC7D,EAAE,MAAM,EAAE,KAAK,EAAE,CAClB,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,KAA2B;QACrC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,KAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,WAAW,CAAa,GAAG,IAAI,CAAC,YAAY,YAAY,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAW,GAAG,IAAI,CAAC,YAAY,aAAa,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,cAAc,CAAC,IAAY,EAAE,MAAe;QAC1C,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,mBAAmB,EACvC;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;SACvC,CACF,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AA2BjC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,OAAO;IACrC,YAAY,GAAG,MAAM,CAAC;IAE9B,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,KAA8B;QACrC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,KAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,WAAW,CAAU,GAAG,IAAI,CAAC,YAAY,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,WAAW,CAAQ,GAAG,IAAI,CAAC,YAAY,UAAU,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,MAAc,EAAE,YAA0B,EAAE,UAAmB;QAC7E,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,gBAAgB,EACpC;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;SAC3D,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAuB;QAC9B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,WAAW,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAC7B,CACF,CAAC;IACJ,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,WAAW,CAAgB,GAAG,IAAI,CAAC,YAAY,mBAAmB,CAAC,CAAC;IAClF,CAAC;IAED,kBAAkB,CAAC,cAAsB;QACvC,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,kBAAkB,cAAc,SAAS,EAC7D,EAAE,MAAM,EAAE,KAAK,EAAE,CAClB,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,KAA2B;QACrC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,KAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC,WAAW,CAAa,GAAG,IAAI,CAAC,YAAY,YAAY,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAW,GAAG,IAAI,CAAC,YAAY,aAAa,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,cAAc,CAAC,IAAY,EAAE,MAAe;QAC1C,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,mBAAmB,EACvC;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;SACvC,CACF,CAAC;IACJ,CAAC;CACF"}

package/dist/workspaces.d.ts

@@ -6,8 +6,11 @@ export interface IWorkspaceMember {
     created?: string | Date;
 }
 export interface IInvite {
+    _id?: string;
     name?: string;
     email: string;
+    phone?: string;
+    roles?: string[];
     created?: string | Date;
 }
 export interface IWorkspace {
@@ -31,4 +34,17 @@ export default class QlWorkspaces extends BaseSDK {
         name: string;
     }): Promise<IWorkspace>;
     activate(workspaceId: string): Promise<IWorkspace>;
+    inviteUser(workspaceId: string, email: string, roles?: string[]): Promise<IWorkspace>;
+    removeMember(workspaceId: string, userId: string): Promise<{
+        message: string;
+        removedMemberId?: string;
+        userId?: string;
+    }>;
+    updateMemberRoles(workspaceId: string, userId: string, roles: string[]): Promise<{
+        message: string;
+        updatedMember?: IWorkspaceMember;
+        workspaceId?: string;
+    }>;
+    listInvites(workspaceId: string): Promise<IInvite[]>;
+    revokeInvite(workspaceId: string, inviteId: string): Promise<IWorkspace>;
 }

package/dist/workspaces.js

@@ -36,5 +36,45 @@ export default class QlWorkspaces extends BaseSDK {
             headers: { 'content-type': 'application/json' },
         });
     }
+    async inviteUser(workspaceId, email, roles) {
+        const ws = await this.getWorkspace(workspaceId);
+        const inviteRoles = roles && roles.length > 0 ? roles : ['member'];
+        const invites = [...(ws.invites || [])];
+        const normalized = email.trim().toLowerCase();
+        const index = invites.findIndex((i) => (i.email || '').trim().toLowerCase() === normalized);
+        if (index >= 0) {
+            invites[index] = { ...invites[index], email: invites[index].email || email, roles: inviteRoles };
+        }
+        else {
+            invites.push({ email, roles: inviteRoles });
+        }
+        return this.update(workspaceId, { invites });
+    }
+    removeMember(workspaceId, userId) {
+        const path = `${this.relativePath}/${workspaceId}/members/${encodeURIComponent(userId)}`;
+        return this.callJsonApi(path, { method: 'delete' });
+    }
+    updateMemberRoles(workspaceId, userId, roles) {
+        const path = `${this.relativePath}/${workspaceId}/members/${encodeURIComponent(userId)}`;
+        return this.callJsonApi(path, {
+            method: 'put',
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify({ roles }),
+        });
+    }
+    async listInvites(workspaceId) {
+        const ws = await this.getWorkspace(workspaceId);
+        return ws.invites ?? [];
+    }
+    async revokeInvite(workspaceId, inviteId) {
+        const ws = await this.getWorkspace(workspaceId);
+        const prev = ws.invites || [];
+        const idStr = String(inviteId);
+        const invites = prev.filter((inv) => String(inv._id ?? '') !== idStr);
+        if (invites.length === prev.length) {
+            throw new Error('Invitation not found');
+        }
+        return this.update(workspaceId, { invites });
+    }
 }
 //# sourceMappingURL=workspaces.js.map

package/dist/workspaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../src/workspaces.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AA0BjC,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IACvC,YAAY,GAAG,iBAAiB,CAAC;IAEzC,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAA;IAChB,CAAC;IAED,YAAY,CAAC,WAAmB;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAa,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED,UAAU,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAqB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,UAAU,CAAC,CAAA;IAC5F,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,WAAW,CAAe,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,WAAmB;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAA4B;QACtD,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,EACrC;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CACF,CAAA;IACH,CAAC;IAED,MAAM,CAAC,SAAiD;QACtD,OAAO,IAAI,CAAC,WAAW,CAAa,IAAI,CAAC,YAAY,EAAE;YACrD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;SAChC,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,WAAmB;QAC1B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,WAAW,EAC9C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAC9C,CACF,CAAA;IACH,CAAC;CACF"}
+{"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../src/workspaces.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AA6BjC,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IACvC,YAAY,GAAG,iBAAiB,CAAC;IAEzC,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAA;IAChB,CAAC;IAED,YAAY,CAAC,WAAmB;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAa,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED,UAAU,CAAC,WAAmB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAqB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,UAAU,CAAC,CAAA;IAC5F,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,WAAW,CAAe,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,WAAmB;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAA4B;QACtD,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,EAAE,EACrC;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CACF,CAAA;IACH,CAAC;IAED,MAAM,CAAC,SAAiD;QACtD,OAAO,IAAI,CAAC,WAAW,CAAa,IAAI,CAAC,YAAY,EAAE;YACrD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;SAChC,CAAC,CAAA;IACJ,CAAC;IAED,QAAQ,CAAC,WAAmB;QAC1B,OAAO,IAAI,CAAC,WAAW,CACrB,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,WAAW,EAC9C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAC9C,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,WAAmB,EACnB,KAAa,EACb,KAAgB;QAEhB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACnE,MAAM,OAAO,GAAc,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,CAAC;QAC5F,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,GAAG,EAAC,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,KAAK,EAAE,KAAK,EAAE,WAAW,EAAC,CAAC;SAChG;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,EAAC,KAAK,EAAE,KAAK,EAAE,WAAW,EAAC,CAAC,CAAC;SAC3C;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC7C,CAAC;IAED,YAAY,CAAC,WAAmB,EAAE,MAAc;QAK9C,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,YAAY,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACpD,CAAC;IAED,iBAAiB,CACf,WAAmB,EACnB,MAAc,EACd,KAAe;QAMf,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,IAAI,WAAW,YAAY,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QACzF,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;YAC5B,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAC,KAAK,EAAC,CAAC;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,WAAmB;QACnC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChD,OAAO,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACtD,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;QACtE,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/docs/payments.md

@@ -0,0 +1,301 @@
+# Payments SDK
+
+The payments SDK is split into two classes:
+
+- **`QlPayments`** (`sdk.payments`) — available to any authenticated user. Covers subscribing, checkout, invoices, and coupon validation. Users cannot set prices.
+- **`QlPaymentsAdmin`** (`adminSdk.payments`) — available to privileged callers only. Extends the user surface with plan/coupon management, cross-entity subscription control, and the ability to set dynamic amounts.
+
+---
+
+## Setup
+
+```typescript
+import { QelosSDK } from '@qelos/sdk';
+import { QelosAdminSDK } from '@qelos/sdk/administrator';
+
+const sdk = new QelosSDK({ baseUrl: 'https://your-qelos-instance.com' });
+const adminSdk = new QelosAdminSDK({ baseUrl: 'https://your-qelos-instance.com' });
+```
+
+---
+
+## Static Plan Checkout (One Step)
+
+For plans where the price is fixed, the user can subscribe and pay in a single `checkout()` call. Qelos creates the pending subscription internally.
+
+```typescript
+// List available plans
+const plans = await sdk.payments.getPlans({ isActive: true });
+const plan = plans.find(p => p.name === 'Pro');
+
+// Validate an optional coupon
+const coupon = await sdk.payments.validateCoupon('SUMMER20', plan._id);
+
+// Initiate checkout — subscription is created inline
+const result = await sdk.payments.checkout({
+  planId: plan._id,
+  billingCycle: 'monthly',
+  couponCode: 'SUMMER20',
+  successUrl: 'https://myapp.com/success',
+  cancelUrl: 'https://myapp.com/cancel',
+});
+
+// Redirect the user
+window.location.href = result.checkoutUrl;
+```
+
+---
+
+## Dynamic Plan Two-Phase Flow
+
+Dynamic plans have variable pricing (e.g., usage-based). The user cannot set the amount — only an admin can. The flow is:
+
+1. User creates a pending subscription.
+2. Admin reviews usage / context and sets the amount.
+3. User initiates checkout with the subscription ID.
+
+### Step 1 — User subscribes
+
+```typescript
+const subscription = await sdk.payments.subscribeToPlan(
+  'dynamic-plan-id',
+  'monthly',
+);
+// subscription.status === 'pending'
+// Store subscription._id and show the user a "waiting for quote" state
+```
+
+### Step 2 — Admin sets the amount
+
+```typescript
+// Admin SDK — run server-side or in the admin dashboard
+await adminSdk.payments.setSubscriptionDynamicAmount(
+  subscription._id,
+  149.00,  // amount in the plan's currency
+);
+```
+
+### Step 3 — User completes checkout
+
+```typescript
+const result = await sdk.payments.checkout({
+  subscriptionId: subscription._id,
+  successUrl: 'https://myapp.com/success',
+  cancelUrl: 'https://myapp.com/cancel',
+});
+
+window.location.href = result.checkoutUrl;
+```
+
+### Admin convenience shortcut
+
+Admins can collapse steps 1–3 into a single call. This creates a pending subscription with the given amount and immediately initiates checkout:
+
+```typescript
+const result = await adminSdk.payments.checkout({
+  planId: 'dynamic-plan-id',
+  billingCycle: 'monthly',
+  amount: 149.00,
+  billableEntityType: 'workspace',
+  billableEntityId: 'workspace-id',
+  successUrl: 'https://myapp.com/success',
+});
+```
+
+---
+
+## Listing Plans and Subscriptions
+
+### User SDK
+
+```typescript
+// Public plan listing (unauthenticated)
+const plans = await sdk.payments.getPlans({ isActive: true });
+
+// Single plan
+const plan = await sdk.payments.getPlan('plan-id');
+
+// Current user's active subscription
+const subscription = await sdk.payments.getMySubscription();
+
+// User's invoices
+const invoices = await sdk.payments.getInvoices();
+const invoice = await sdk.payments.getInvoice('invoice-id');
+```
+
+### Admin SDK
+
+```typescript
+// All plans (including inactive)
+const allPlans = await adminSdk.payments.getPlans();
+
+// All subscriptions with optional filters
+const workspaceSubs = await adminSdk.payments.getSubscriptions({
+  billableEntityType: 'workspace',
+  billableEntityId: 'workspace-id',
+  status: 'active',
+});
+
+// All invoices across entities
+const invoices = await adminSdk.payments.getInvoices({
+  billableEntityType: 'user',
+  billableEntityId: 'user-id',
+  status: 'paid',
+});
+```
+
+---
+
+## Coupon Validation
+
+Validate a coupon before showing it applied in the UI:
+
+```typescript
+try {
+  const coupon = await sdk.payments.validateCoupon('PROMO10', 'plan-id');
+  console.log(coupon.discountType);  // 'percentage' | 'fixed'
+  console.log(coupon.discountValue); // e.g. 10 (%)
+} catch (err) {
+  // err.code: COUPON_NOT_FOUND | COUPON_EXPIRED | COUPON_NOT_APPLICABLE | ...
+}
+```
+
+---
+
+## Invoice Retrieval
+
+```typescript
+// User's own invoices
+const invoices = await sdk.payments.getInvoices({ status: 'paid' });
+
+// Single invoice (e.g. for download link)
+const invoice = await sdk.payments.getInvoice('invoice-id');
+console.log(invoice.invoiceUrl);
+```
+
+---
+
+## Cancellation
+
+```typescript
+// User cancels their own subscription
+await sdk.payments.cancelSubscription('subscription-id');
+
+// Admin cancels any subscription
+await adminSdk.payments.cancelSubscription('subscription-id');
+```
+
+---
+
+## Admin Plan Management
+
+```typescript
+// Create a plan
+const plan = await adminSdk.payments.createPlan({
+  name: 'Enterprise',
+  monthlyPrice: 299,
+  yearlyPrice: 2990,
+  currency: 'USD',
+  dynamic: false,
+  isActive: true,
+});
+
+// Create a dynamic plan
+const dynamicPlan = await adminSdk.payments.createPlan({
+  name: 'Usage-Based',
+  currency: 'USD',
+  dynamic: true,
+  isActive: true,
+  monthlyPrice: 0,
+  yearlyPrice: 0,
+});
+
+// Update
+await adminSdk.payments.updatePlan(plan._id, { monthlyPrice: 349 });
+
+// Delete
+await adminSdk.payments.deletePlan(plan._id);
+```
+
+---
+
+## Admin Coupon Management
+
+```typescript
+// Create a 20% off coupon
+const coupon = await adminSdk.payments.createCoupon({
+  code: 'SUMMER20',
+  discountType: 'percentage',
+  discountValue: 20,
+  isActive: true,
+  applicablePlanIds: ['plan-id'],
+  maxRedemptions: 100,
+});
+
+// Update
+await adminSdk.payments.updateCoupon(coupon._id, { isActive: false });
+
+// Delete
+await adminSdk.payments.deleteCoupon(coupon._id);
+```
+
+---
+
+## `QlPayments` Reference (User SDK)
+
+| Method | Description |
+|---|---|
+| `getPlans(query?)` | List public plans |
+| `getPlan(planId)` | Get a single plan |
+| `subscribeToPlan(planId, billingCycle, couponCode?)` | Create a pending subscription (first step for dynamic plans) |
+| `checkout(params)` | Initiate a checkout session |
+| `getMySubscription()` | Get the current user's active subscription |
+| `cancelSubscription(subscriptionId)` | Cancel a subscription |
+| `getInvoices(query?)` | List the current user's invoices |
+| `getInvoice(invoiceId)` | Get a single invoice |
+| `validateCoupon(code, planId?)` | Validate a coupon code |
+
+---
+
+## `QlPaymentsAdmin` Reference (Admin SDK)
+
+| Method | Description |
+|---|---|
+| `getPlans(query?)` | List all plans |
+| `getPlan(planId)` | Get a single plan |
+| `createPlan(data)` | Create a plan |
+| `updatePlan(planId, data)` | Update a plan |
+| `deletePlan(planId)` | Delete a plan |
+| `checkout(params)` | Initiate checkout with entity overrides and optional `amount` |
+| `getSubscriptions(query?)` | List subscriptions across all entities |
+| `getSubscription(subscriptionId)` | Get a single subscription |
+| `createSubscription(data)` | Create a pending subscription on behalf of any entity |
+| `cancelSubscription(subscriptionId)` | Cancel any subscription |
+| `setSubscriptionDynamicAmount(subscriptionId, amount)` | Set or update the dynamic amount on a pending subscription |
+| `getInvoices(query?)` | List invoices across all entities |
+| `getInvoice(invoiceId)` | Get a single invoice |
+| `getCoupons(query?)` | List coupons |
+| `getCoupon(couponId)` | Get a single coupon |
+| `createCoupon(data)` | Create a coupon |
+| `updateCoupon(couponId, data)` | Update a coupon |
+| `deleteCoupon(couponId)` | Delete a coupon |
+
+---
+
+## Permissions Summary
+
+| Action | User SDK | Admin SDK |
+|---|---|---|
+| List/get plans | public plans only | all plans |
+| Create/update/delete plans | no | yes |
+| Create subscription (own entity) | yes | yes |
+| Create subscription (any entity) | no | yes |
+| Set `dynamicAmount` | no | yes |
+| Initiate checkout | yes | yes, with entity override |
+| Set checkout `amount` directly | no | yes (dynamic plans) |
+| List own subscriptions/invoices | yes | yes |
+| List all subscriptions/invoices | no | yes |
+| Cancel own subscription | yes | yes |
+| Cancel any subscription | no | yes |
+| Validate coupon | yes | yes |
+| Manage coupons | no | yes |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qelos/sdk",
-  "version": "3.11.11",
+  "version": "4.1.0",
   "description": "SDK for Qelos API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -102,7 +102,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@qelos/global-types": "^3.11.11"
+    "@qelos/global-types": "^4.1.0"
   },
   "devDependencies": {
     "tsx": "^4.21.0",

package/src/__tests__/blueprints.types.test-d.ts

@@ -0,0 +1,49 @@
+// Compile-only type test for `BlueprintEntitiesRegistry` augmentation
+// and the overloaded `entitiesOf` signatures. Runs as part of `tsc --noEmit`
+// (type-check / build); not executed by `node --test`.
+
+import QlBlueprints from '../blueprints';
+import type { IBaseBlueprintEntity } from '../blueprints-entities';
+import type QlBlueprintEntities from '../blueprints-entities';
+
+interface TodoProperties {
+  title: string;
+  done: boolean;
+}
+
+interface TodoEntity extends IBaseBlueprintEntity, TodoProperties {}
+
+declare module '../blueprints' {
+  interface BlueprintEntitiesRegistry {
+    todo: TodoEntity;
+  }
+}
+
+type Equal<A, B> =
+  (<T>() => T extends A ? 1 : 2) extends (<T>() => T extends B ? 1 : 2) ? true : false;
+type Expect<T extends true> = T;
+
+declare const blueprints: QlBlueprints;
+
+// 1. Registry-keyed lookup resolves to the augmented entity type.
+const todos = blueprints.entitiesOf('todo');
+type TodosCheck = Expect<Equal<typeof todos, QlBlueprintEntities<TodoEntity>>>;
+
+// `find()` returns the merged entity shape from the registry.
+declare const found: Awaited<ReturnType<typeof todos.find>>;
+type FoundCheck = Expect<Equal<typeof found, (IBaseBlueprintEntity & TodoEntity)[]>>;
+
+// 2. Explicit-generic fallback still compiles for unregistered keys.
+interface AdHoc {
+  name: string;
+}
+const adhoc = blueprints.entitiesOf<AdHoc>('not-in-registry');
+type AdHocCheck = Expect<Equal<typeof adhoc, QlBlueprintEntities<AdHoc>>>;
+
+// 3. Plain string key with no generic falls back to `any` (legacy behavior).
+const dynamicKey: string = 'todo';
+const loose = blueprints.entitiesOf(dynamicKey);
+type LooseCheck = Expect<Equal<typeof loose, QlBlueprintEntities<any>>>;
+
+// Mark generated checks as used so the file remains a valid module.
+export type _Checks = [TodosCheck, FoundCheck, AdHocCheck, LooseCheck];

package/src/administrator/events.ts

@@ -4,6 +4,7 @@ import BaseSDK from '../base-sdk';
 export interface IQelosEvent {
   tenant: string;
   user?: string;
+  workspace?: string;
   source: string;
   kind: string;
   eventName: string;
@@ -19,15 +20,19 @@ export default class QlEvents extends BaseSDK {
     super(options)
   }
 
-  getList(params?: { page?: number; kind?: string; eventName?: string; source?: string; user?: string; workspace?: string; period?: string }) {
+  getList(params?: { page?: number; limit?: number; kind?: string; eventName?: string; source?: string; user?: string; workspace?: string; search?: string; period?: string; from?: string; to?: string }) {
     const queryParams = new URLSearchParams();
     if (params?.page !== undefined) queryParams.append('page', params.page.toString());
+    if (params?.limit !== undefined) queryParams.append('limit', params.limit.toString());
     if (params?.kind) queryParams.append('kind', params.kind);
     if (params?.eventName) queryParams.append('eventName', params.eventName);
     if (params?.source) queryParams.append('source', params.source);
     if (params?.user) queryParams.append('user', params.user);
     if (params?.workspace) queryParams.append('workspace', params.workspace);
+    if (params?.search) queryParams.append('search', params.search);
     if (params?.period) queryParams.append('period', params.period);
+    if (params?.from) queryParams.append('from', params.from);
+    if (params?.to) queryParams.append('to', params.to);
     
     const queryString = queryParams.toString();
     return this.callJsonApi<IQelosEvent[]>(this.relativePath + (queryString ? '?' + queryString : ''));

package/src/administrator/payments.ts

@@ -2,9 +2,42 @@ import { QelosSDKOptions } from '../types';
 import BaseSDK from '../base-sdk';
 import {
   IPlan, ISubscription, IInvoice, ICoupon,
-  BillableEntityType, SubscriptionStatus, InvoiceStatus,
+  BillableEntityType, SubscriptionStatus, InvoiceStatus, BillingCycle,
 } from '@qelos/global-types';
 
+export interface AdminCheckoutRequest {
+  planId: string;
+  billingCycle: BillingCycle;
+  /** When omitted, the authenticated user / default billable entity is used (same as public checkout). */
+  billableEntityType?: BillableEntityType;
+  billableEntityId?: string;
+  couponCode?: string;
+  successUrl?: string;
+  cancelUrl?: string;
+  /**
+   * Admin-only. For plans with `dynamic: true`, sets the `dynamicAmount` on the
+   * pending subscription before initiating checkout. Regular users cannot set this;
+   * use `setSubscriptionDynamicAmount()` + a separate `checkout()` call instead.
+   */
+  amount?: number;
+}
+
+export interface CreateSubscriptionData {
+  planId: string;
+  billingCycle: BillingCycle;
+  billableEntityType: BillableEntityType;
+  billableEntityId: string;
+  /** Required for plans with `dynamic: true` before checkout can be initiated. */
+  dynamicAmount?: number;
+  couponCode?: string;
+}
+
+export interface AdminCheckoutResponse {
+  subscriptionId: string;
+  checkoutUrl?: string;
+  clientToken?: string;
+}
+
 export default class QlPaymentsAdmin extends BaseSDK {
   constructor(private options: QelosSDKOptions) {
     super(options);
@@ -41,6 +74,18 @@ export default class QlPaymentsAdmin extends BaseSDK {
     return this.callJsonApi<IPlan>(`/api/plans/${planId}`, { method: 'delete' });
   }
 
+  /**
+   * Start subscription checkout (same as `sdk.payments.checkout`, plus optional billable-entity overrides for admins).
+   * For plans with `dynamic: true`, `amount` is required.
+   */
+  checkout(params: AdminCheckoutRequest) {
+    return this.callJsonApi<AdminCheckoutResponse>('/api/checkout', {
+      method: 'post',
+      headers: { 'content-type': 'application/json' },
+      body: JSON.stringify(params),
+    });
+  }
+
   // --- Subscriptions ---
 
   getSubscriptions(query?: {
@@ -56,6 +101,19 @@ export default class QlPaymentsAdmin extends BaseSDK {
     return this.callJsonApi<ISubscription>(`/api/subscriptions/${subscriptionId}`);
   }
 
+  /**
+   * Creates a pending subscription on behalf of any billable entity. Admins can
+   * also set `dynamicAmount` here for dynamic plans, making the subscription
+   * immediately ready for checkout.
+   */
+  createSubscription(data: CreateSubscriptionData) {
+    return this.callJsonApi<ISubscription>('/api/subscriptions', {
+      method: 'post',
+      headers: { 'content-type': 'application/json' },
+      body: JSON.stringify(data),
+    });
+  }
+
   cancelSubscription(subscriptionId: string) {
     return this.callJsonApi<ISubscription>(
       `/api/subscriptions/${subscriptionId}/cancel`,
@@ -63,6 +121,21 @@ export default class QlPaymentsAdmin extends BaseSDK {
     );
   }
 
+  /**
+   * Sets or updates the dynamic amount for a pending subscription. Only admins
+   * can call this. Must be done before a user can complete checkout on a dynamic plan.
+   */
+  setSubscriptionDynamicAmount(subscriptionId: string, amount: number) {
+    return this.callJsonApi<ISubscription>(
+      `/api/subscriptions/${subscriptionId}/dynamic-amount`,
+      {
+        method: 'put',
+        headers: { 'content-type': 'application/json' },
+        body: JSON.stringify({ amount }),
+      },
+    );
+  }
+
   // --- Invoices ---
 
   getInvoices(query?: {