rocketride 1.0.6 → 1.1.1

package/dist/esm/billing.js

@@ -0,0 +1,167 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2026 Aparavi Software AG
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+// =============================================================================
+// BILLING API CLASS
+// =============================================================================
+/**
+ * Typed wrapper around the `rrext_account_billing` DAP command.
+ *
+ * Accessed via `client.billing` — not instantiated directly. All methods
+ * delegate to {@link RocketRideClient.dap} which handles envelope
+ * unwrapping and error propagation.
+ */
+export class BillingApi {
+    /** @param client - The parent RocketRideClient that owns this namespace. */
+    constructor(client) {
+        this.client = client;
+    }
+    // =========================================================================
+    // SUBSCRIPTION OPERATIONS
+    // =========================================================================
+    /**
+     * Fetches the per-app subscription details for the given org.
+     *
+     * @param orgId - Organisation UUID whose subscriptions to load.
+     * @returns Array of BillingDetail rows (one per subscribed app).
+     */
+    async getDetails(orgId) {
+        const body = await this.client.call('rrext_account_billing', { subcommand: 'list', orgId });
+        return body.subscriptions ?? [];
+    }
+    /**
+     * Fetches the active subscription plans (prices) for an app.
+     *
+     * Plans are returned sorted month-first, year-second, formatted for
+     * display in the checkout plan picker. The server resolves the app's
+     * Stripe product internally and calls `stripe.Price.list()` so pricing
+     * changes in the Stripe dashboard are reflected immediately.
+     *
+     * @param appId - App identifier (e.g. "rocketride.pipeBuilder").
+     * @returns Array of StripePlan objects ready for display.
+     */
+    async getProductPrices(appId) {
+        const body = await this.client.call('rrext_account_billing', { subcommand: 'prices', appId });
+        return body.plans ?? [];
+    }
+    /**
+     * Creates a Stripe subscription and returns the Stripe Elements client_secret.
+     *
+     * The returned client_secret is passed to `stripe.confirmPayment()` to
+     * complete the checkout without a browser redirect to Stripe.
+     *
+     * @param orgId   - Organisation UUID to subscribe.
+     * @param appId   - App being subscribed (e.g. "brandi").
+     * @param priceId - Stripe price_* identifier for the plan.
+     * @returns Object with client_secret for Stripe Elements and subscription_id.
+     */
+    async createCheckoutSession(orgId, appId, priceId) {
+        return this.client.call('rrext_account_billing', {
+            subcommand: 'subscribe',
+            orgId,
+            appId,
+            priceId,
+        });
+    }
+    /**
+     * Creates a Stripe Billing Portal session for managing payment methods.
+     *
+     * @param orgId     - Organisation UUID whose Stripe customer portal to open.
+     * @param returnUrl - URL to redirect the user back to after portal interaction.
+     * @returns Object with portal URL to redirect the user to.
+     */
+    async createPortalSession(orgId, returnUrl) {
+        return this.client.call('rrext_account_billing', {
+            subcommand: 'portal',
+            orgId,
+            returnUrl,
+        });
+    }
+    /**
+     * Schedules an app subscription for cancellation at the end of the current period.
+     *
+     * The user retains access until the period ends. The webhook handler will
+     * update `cancel_at_period_end` in the database asynchronously.
+     *
+     * @param orgId - Organisation UUID that owns the subscription.
+     * @param appId - App to cancel (e.g. "brandi").
+     * @returns Object with canceled: true on success.
+     */
+    async cancelSubscription(orgId, appId) {
+        return this.client.call('rrext_account_billing', {
+            subcommand: 'cancel',
+            orgId,
+            appId,
+        });
+    }
+    // =========================================================================
+    // COMPUTE CREDITS WALLET
+    // =========================================================================
+    /**
+     * Reads the org's compute credit balance.
+     *
+     * The balance lives in a Redis-backed wallet on the engine side; this
+     * call is cheap and safe to poll (~1 req/s is fine for a live widget).
+     *
+     * @param orgId - Organisation UUID to query.
+     * @returns The credit balance with lifetime stats.
+     */
+    async getCreditBalance(orgId) {
+        return this.client.call('rrext_account_billing', {
+            subcommand: 'credits_balance',
+            orgId,
+        });
+    }
+    /**
+     * Loads the purchasable credit packs, sourced from the Stripe catalog
+     * that Terraform maintains. Call once on modal mount.
+     *
+     * @returns Array of credit pack pricing rows.
+     */
+    async listCreditPacks() {
+        const body = await this.client.call('rrext_account_billing', { subcommand: 'credits_packs' });
+        return body.packs ?? [];
+    }
+    /**
+     * Creates a one-off Stripe Checkout session for a credit pack purchase
+     * and returns the redirect URL.
+     *
+     * The frontend redirects the user to Stripe-hosted checkout; on success
+     * Stripe redirects back to the app, and the `checkout.session.completed`
+     * webhook increments the wallet server-side.
+     *
+     * @param orgId     - Organisation UUID that the credits belong to.
+     * @param packId    - Pack key returned by {@link listCreditPacks}.
+     * @param returnUrl - Where Stripe sends the user after payment.
+     * @returns Object with the Stripe checkout URL.
+     */
+    async createCreditCheckout(orgId, packId, returnUrl) {
+        return this.client.call('rrext_account_billing', {
+            subcommand: 'credits_checkout',
+            orgId,
+            packId,
+            returnUrl,
+        });
+    }
+}
+//# sourceMappingURL=billing.js.map

package/dist/esm/billing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.js","sourceRoot":"","sources":["../../src/client/billing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAaH,gFAAgF;AAChF,oBAAoB;AACpB,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IACtB,4EAA4E;IAC5E,YAAoB,MAAwB;QAAxB,WAAM,GAAN,MAAM,CAAkB;IAAG,CAAC;IAEhD,4EAA4E;IAC5E,0BAA0B;IAC1B,4EAA4E;IAE5E;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,KAAa;QAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gBAAgB,CAAC,KAAa;QACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9F,OAAO,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,qBAAqB,CAAC,KAAa,EAAE,KAAa,EAAE,OAAe;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAmD,uBAAuB,EAAE;YAClG,UAAU,EAAE,WAAW;YACvB,KAAK;YACL,KAAK;YACL,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CAAC,KAAa,EAAE,SAAiB;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAkB,uBAAuB,EAAE;YACjE,UAAU,EAAE,QAAQ;YACpB,KAAK;YACL,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAa,EAAE,KAAa;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB,uBAAuB,EAAE;YACvE,UAAU,EAAE,QAAQ;YACpB,KAAK;YACL,KAAK;SACL,CAAC,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,yBAAyB;IACzB,4EAA4E;IAE5E;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAC,KAAa;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAgB,uBAAuB,EAAE;YAC/D,UAAU,EAAE,iBAAiB;YAC7B,KAAK;SACL,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe;QACpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC;QAC9F,OAAO,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,oBAAoB,CAAC,KAAa,EAAE,MAAc,EAAE,SAAiB;QAC1E,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAkB,uBAAuB,EAAE;YACjE,UAAU,EAAE,kBAAkB;YAC9B,KAAK;YACL,MAAM;YACN,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;CACD"}