rocketride 1.0.6 → 1.1.0

package/dist/esm/types/service.js

@@ -0,0 +1,82 @@
+/**
+ * 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.
+ */
+// ============================================================================
+// PROTOCOL CAPABILITY FLAGS
+// ============================================================================
+/**
+ * Protocol capability flags for service drivers.
+ *
+ * Each flag is a single bit in a uint32 bitmask describing what a service
+ * driver supports. Values are returned by the engine in the `capabilities`
+ * field of a service definition and can be tested with bitwise AND.
+ *
+ * @example
+ * ```typescript
+ * const services = await client.getServices();
+ * const svc = services.services['my_driver'];
+ * if (svc.capabilities & PROTOCOL_CAPS.GPU) {
+ *   console.log('Driver requires a GPU');
+ * }
+ * ```
+ */
+export var PROTOCOL_CAPS;
+(function (PROTOCOL_CAPS) {
+    /** No capabilities */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["NONE"] = 0] = "NONE";
+    /** Supports the file permissions interface */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["SECURITY"] = 1] = "SECURITY";
+    /** Is a filesystem interface */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["FILESYSTEM"] = 2] = "FILESYSTEM";
+    /** Supports the substream interface */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["SUBSTREAM"] = 4] = "SUBSTREAM";
+    /** Uses a network interface */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["NETWORK"] = 8] = "NETWORK";
+    /** Uses datanet or streamnet interfaces */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["DATANET"] = 16] = "DATANET";
+    /** Uses delta queries to track changes */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["SYNC"] = 32] = "SYNC";
+    /** Internal — will not be returned in services.json */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["INTERNAL"] = 64] = "INTERNAL";
+    /** Supports data catalog operations */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["CATALOG"] = 128] = "CATALOG";
+    /** Do not monitor for excessive failures */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["NOMONITOR"] = 256] = "NOMONITOR";
+    /** Source endpoint does not use include */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["NOINCLUDE"] = 512] = "NOINCLUDE";
+    /** Driver supports the invoke function */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["INVOKE"] = 1024] = "INVOKE";
+    /** Driver supports remoting execution */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["REMOTING"] = 2048] = "REMOTING";
+    /** Driver requires a GPU */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["GPU"] = 4096] = "GPU";
+    /** Driver is not SaaS compatible */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["NOSAAS"] = 8192] = "NOSAAS";
+    /** Focus on this driver */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["FOCUS"] = 16384] = "FOCUS";
+    /** Driver is deprecated */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["DEPRECATED"] = 32768] = "DEPRECATED";
+    /** Driver is experimental */
+    PROTOCOL_CAPS[PROTOCOL_CAPS["EXPERIMENTAL"] = 65536] = "EXPERIMENTAL";
+})(PROTOCOL_CAPS || (PROTOCOL_CAPS = {}));
+//# sourceMappingURL=service.js.map

package/dist/esm/types/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/client/types/service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AA8HH,+EAA+E;AAC/E,4BAA4B;AAC5B,+EAA+E;AAE/E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAN,IAAY,aAsDX;AAtDD,WAAY,aAAa;IACxB,sBAAsB;IACtB,iDAAQ,CAAA;IAER,8CAA8C;IAC9C,yDAAiB,CAAA;IAEjB,gCAAgC;IAChC,6DAAmB,CAAA;IAEnB,uCAAuC;IACvC,2DAAkB,CAAA;IAElB,+BAA+B;IAC/B,uDAAgB,CAAA;IAEhB,2CAA2C;IAC3C,wDAAgB,CAAA;IAEhB,0CAA0C;IAC1C,kDAAa,CAAA;IAEb,uDAAuD;IACvD,0DAAiB,CAAA;IAEjB,uCAAuC;IACvC,yDAAgB,CAAA;IAEhB,4CAA4C;IAC5C,6DAAkB,CAAA;IAElB,2CAA2C;IAC3C,6DAAkB,CAAA;IAElB,0CAA0C;IAC1C,wDAAgB,CAAA;IAEhB,yCAAyC;IACzC,4DAAkB,CAAA;IAElB,4BAA4B;IAC5B,kDAAa,CAAA;IAEb,oCAAoC;IACpC,wDAAgB,CAAA;IAEhB,2BAA2B;IAC3B,uDAAe,CAAA;IAEf,2BAA2B;IAC3B,iEAAoB,CAAA;IAEpB,6BAA6B;IAC7B,qEAAsB,CAAA;AACvB,CAAC,EAtDW,aAAa,KAAb,aAAa,QAsDxB"}

package/dist/types/account.d.ts

@@ -0,0 +1,209 @@
+/**
+ * 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.
+ */
+/**
+ * Account API namespace for the RocketRide TypeScript SDK.
+ *
+ * Provides typed methods for managing the authenticated user's profile,
+ * API keys, organization, members, and teams via DAP commands over the
+ * existing WebSocket connection.
+ */
+import type { RocketRideClient } from './client.js';
+import type { ConnectResult } from './types/client.js';
+import type { OrgDetail, ApiKeyRecord, MemberRecord, TeamRecord, TeamDetail, ProfileUpdate, CreateKeyParams, InviteMemberParams, TeamMemberParams } from './types/account.js';
+/**
+ * Typed wrapper around the `rrext_account_*` DAP commands.
+ *
+ * Accessed via `client.account` — not instantiated directly. All methods
+ * delegate to {@link RocketRideClient.dap} which handles envelope
+ * unwrapping and error propagation.
+ */
+export declare class AccountApi {
+    private client;
+    /** @param client - The parent RocketRideClient that owns this namespace. */
+    constructor(client: RocketRideClient);
+    /**
+     * Fetches the current user's profile from the server.
+     *
+     * @returns The user's profile data.
+     */
+    getProfile(): Promise<ConnectResult>;
+    /**
+     * Persists updated profile fields.
+     *
+     * @param fields - The profile fields to update.
+     */
+    updateProfile(fields: ProfileUpdate): Promise<void>;
+    /**
+     * Sets the user's preferred default team.
+     *
+     * @param teamId - The team ID to set as default.
+     */
+    setDefaultTeam(teamId: string): Promise<void>;
+    /**
+     * Permanently deletes the current user's account.
+     */
+    deleteAccount(): Promise<void>;
+    /**
+     * Fetches the organization detail for the given org.
+     *
+     * @param orgId - Organisation UUID. The server may infer the org if omitted.
+     * @returns The organization detail (id, name, plan, memberCount, teamCount).
+     */
+    getOrg(orgId?: string): Promise<OrgDetail>;
+    /**
+     * Updates the organization name.
+     *
+     * @param orgId - Organisation UUID.
+     * @param name  - The new organization name.
+     */
+    updateOrgName(orgId: string, name: string): Promise<void>;
+    /**
+     * Fetches the list of API keys for the current user.
+     *
+     * @returns Array of API key records.
+     */
+    listKeys(): Promise<ApiKeyRecord[]>;
+    /**
+     * Creates a new API key and returns the raw key string.
+     *
+     * @param params - Key creation parameters (name, permissions, expiresAt).
+     * @returns Object containing the raw key string.
+     */
+    createKey(params: CreateKeyParams): Promise<{
+        key: string;
+    }>;
+    /**
+     * Revokes an API key by its ID.
+     *
+     * @param keyId - The key to revoke.
+     */
+    revokeKey(keyId: string): Promise<void>;
+    /**
+     * Fetches the flat list of organization members.
+     *
+     * @param orgId - Organisation UUID.
+     * @returns Array of member records.
+     */
+    listMembers(orgId: string): Promise<MemberRecord[]>;
+    /**
+     * Sends an invitation to a new organization member.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param params - Invitation parameters (email, givenName, familyName, role).
+     */
+    inviteMember(orgId: string, params: InviteMemberParams): Promise<void>;
+    /**
+     * Updates an organization member's role.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param userId - The member's user ID.
+     * @param role   - The new role string.
+     */
+    updateMemberRole(orgId: string, userId: string, role: string): Promise<void>;
+    /**
+     * Removes an organization member.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param userId - The member's user ID.
+     */
+    removeMember(orgId: string, userId: string): Promise<void>;
+    /**
+     * Fetches the flat list of teams in the organization.
+     *
+     * @param orgId - Organisation UUID.
+     * @returns Array of team summary records.
+     */
+    listTeams(orgId: string): Promise<TeamRecord[]>;
+    /**
+     * Fetches full detail (including member list) for a specific team.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param teamId - The team to load.
+     * @returns The team detail with nested members.
+     */
+    getTeamDetail(orgId: string, teamId: string): Promise<TeamDetail>;
+    /**
+     * Creates a new team.
+     *
+     * @param orgId - Organisation UUID.
+     * @param name  - The team name.
+     */
+    createTeam(orgId: string, name: string): Promise<void>;
+    /**
+     * Deletes a team.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param teamId - The team to delete.
+     */
+    deleteTeam(orgId: string, teamId: string): Promise<void>;
+    /**
+     * Adds a member to a team with specified permissions.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param params - Parameters (teamId, userId, permissions).
+     */
+    addTeamMember(orgId: string, params: TeamMemberParams): Promise<void>;
+    /**
+     * Updates a team member's permissions.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param params - Parameters (teamId, userId, permissions).
+     */
+    updateTeamMemberPerms(orgId: string, params: TeamMemberParams): Promise<void>;
+    /**
+     * Removes a member from a team.
+     *
+     * @param orgId  - Organisation UUID.
+     * @param params - Parameters (teamId, userId).
+     */
+    removeTeamMember(orgId: string, params: {
+        teamId: string;
+        userId: string;
+    }): Promise<void>;
+    /**
+     * Returns the available ROCKETRIDE_* key names from the merged environment.
+     * Does not return values — only key names for use in dropdowns.
+     *
+     * @returns Array of key names (e.g. ['ROCKETRIDE_ANTHROPIC_KEY', 'ROCKETRIDE_OPENAI_KEY']).
+     */
+    getEnvironmentKeys(): Promise<string[]>;
+    /**
+     * Reads the environment dict for a scope (org, team, or user).
+     *
+     * @param scope   - One of 'org', 'team', 'user'.
+     * @param scopeId - For org: orgId. For team: teamId. For user: omit (uses current user).
+     * @returns Decrypted key-value dict.
+     */
+    getEnv(scope: 'org' | 'team' | 'user', scopeId?: string): Promise<Record<string, string>>;
+    /**
+     * Writes the full environment dict for a scope (org, team, or user).
+     * Replaces the entire set of keys at that scope level.
+     *
+     * @param scope   - One of 'org', 'team', 'user'.
+     * @param env     - Full key-value dict to store.
+     * @param scopeId - For org: orgId. For team: teamId. For user: omit.
+     */
+    setEnv(scope: 'org' | 'team' | 'user', env: Record<string, string>, scopeId?: string): Promise<void>;
+}
+//# sourceMappingURL=account.d.ts.map

package/dist/types/account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/client/account.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAM9K;;;;;;GAMG;AACH,qBAAa,UAAU;IAEV,OAAO,CAAC,MAAM;IAD1B,4EAA4E;gBACxD,MAAM,EAAE,gBAAgB;IAM5C;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC;IAI1C;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzD;;;;OAIG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAQpC;;;;;OAKG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAIhD;;;;;OAKG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAKzC;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAKlE;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAKzD;;;;;OAKG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5E;;;;;;OAMG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlF;;;;;OAKG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQhE;;;;;OAKG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAKrD;;;;;;OAMG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIvE;;;;;OAKG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5D;;;;;OAKG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;;;;OAKG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;;;OAKG;IACG,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAInF;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQhG;;;;;OAKG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAK7C;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAS/F;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1G"}

package/dist/types/billing.d.ts

@@ -0,0 +1,135 @@
+/**
+ * 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 namespace for the RocketRide TypeScript SDK.
+ *
+ * Provides typed methods for managing subscriptions, Stripe checkout
+ * sessions, billing portal access, and compute credit wallets via DAP
+ * commands over the existing WebSocket connection.
+ */
+import type { RocketRideClient } from './client.js';
+import type { BillingDetail, StripePlan, CreditBalance, CreditPack } from './types/billing.js';
+/**
+ * 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 declare class BillingApi {
+    private client;
+    /** @param client - The parent RocketRideClient that owns this namespace. */
+    constructor(client: RocketRideClient);
+    /**
+     * 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).
+     */
+    getDetails(orgId: string): Promise<BillingDetail[]>;
+    /**
+     * 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.
+     */
+    getProductPrices(appId: string): Promise<StripePlan[]>;
+    /**
+     * 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.
+     */
+    createCheckoutSession(orgId: string, appId: string, priceId: string): Promise<{
+        clientSecret: string;
+        subscriptionId: string;
+    }>;
+    /**
+     * 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.
+     */
+    createPortalSession(orgId: string, returnUrl: string): Promise<{
+        url: string;
+    }>;
+    /**
+     * 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.
+     */
+    cancelSubscription(orgId: string, appId: string): Promise<{
+        canceled: boolean;
+    }>;
+    /**
+     * 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.
+     */
+    getCreditBalance(orgId: string): Promise<CreditBalance>;
+    /**
+     * 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.
+     */
+    listCreditPacks(): Promise<CreditPack[]>;
+    /**
+     * 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.
+     */
+    createCreditCheckout(orgId: string, packId: string, returnUrl: string): Promise<{
+        url: string;
+    }>;
+}
+//# sourceMappingURL=billing.d.ts.map

package/dist/types/billing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.d.ts","sourceRoot":"","sources":["../../src/client/billing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAM/F;;;;;;GAMG;AACH,qBAAa,UAAU;IAEV,OAAO,CAAC,MAAM;IAD1B,4EAA4E;gBACxD,MAAM,EAAE,gBAAgB;IAM5C;;;;;OAKG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKzD;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAK5D;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC;IASrI;;;;;;OAMG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAQrF;;;;;;;;;OASG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAYtF;;;;;;;;OAQG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAO7D;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAK9C;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAQtG"}