@buildbase/sdk 0.0.15 → 0.0.18

package/dist/types/lib/api-base.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Base API client for SDK endpoints.
+ * All domain API classes (WorkspaceApi, UserApi, etc.) extend this to share
+ * URL building, auth headers, and request/response handling.
+ */
+import type { ApiVersion } from '../providers/os/types';
+export interface IBaseApiConfig {
+    serverUrl: string;
+    version: ApiVersion;
+    orgId?: string;
+    /** When true, ensureReady() also requires orgId. Used by WorkspaceApi and SettingsApi. */
+    requireOrgId?: boolean;
+    /** API path segment after version (default 'public'). e.g. 'public' => .../v1/public, 'beta' => .../v1/beta */
+    basePath?: string;
+}
+/**
+ * Base class for SDK API clients.
+ * Provides:
+ * - baseUrl: `${serverUrl}/api/${version}/public`
+ * - getAuthHeaders()
+ * - fetchJson<T>(path, init, errorMessage): GET/POST/etc. with handleApiResponse
+ * - fetchResponse(path, init): raw Response for custom parsing (e.g. non-JSON or custom error handling)
+ */
+export declare abstract class BaseApi {
+    protected readonly serverUrl: string;
+    protected readonly version: ApiVersion;
+    protected readonly orgId: string | undefined;
+    private readonly requireOrgId;
+    private readonly basePath;
+    constructor(config: IBaseApiConfig);
+    /** Throws if config is not ready for API calls. Called automatically by fetchJson/fetchResponse. */
+    protected ensureReady(): void;
+    /** Base URL: ${serverUrl}/api/${version}/${basePath} */
+    protected get baseUrl(): string;
+    /** Auth headers (x-session-id). Subclasses can override to add more. */
+    protected getAuthHeaders(): Record<string, string>;
+    /** Build full URL from path (path can be "workspaces" or "/workspaces"). */
+    protected url(path: string): string;
+    /**
+     * Execute request and parse JSON with handleApiResponse (throws on !response.ok).
+     * Use for standard JSON APIs.
+     */
+    protected fetchJson<T>(path: string, init?: RequestInit, errorMessage?: string): Promise<T>;
+    /**
+     * Execute request and return raw Response (for custom parsing or error handling).
+     * Caller is responsible for checking response.ok and parsing body.
+     */
+    protected fetchResponse(path: string, init?: RequestInit): Promise<Response>;
+}

package/dist/types/providers/ContextConfigProvider.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import type { IAuthConfig } from './auth/types';
-import type { IOsState } from './os/types';
+import { type IOsState } from './os/types';
 interface ContextConfigProviderProps {
     config: IOsState;
     auth?: IAuthConfig;

package/dist/types/providers/auth/api.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Centralized API client for auth (profile).
+ * Extends BaseApi; uses explicit sessionId for profile (e.g. after redirect or hydration).
+ */
+import { IUser } from '../../api/types';
+import { BaseApi } from '../../lib/api-base';
+import type { IOsConfig } from '../os/types';
+export declare class AuthApi extends BaseApi {
+    constructor(config: Pick<IOsConfig, 'serverUrl' | 'version'>);
+    /** Fetch user profile with the given session ID (used after OAuth redirect or from storage). */
+    getProfile(sessionId: string, signal?: AbortSignal): Promise<IUser>;
+}

package/dist/types/providers/auth/hooks.d.ts

@@ -60,6 +60,8 @@ import { WorkspaceSettingsSection } from '../workspace/ui/SettingsDialog';
  * }
  * ```
  */
+/** Internal: select auth slice. Used by AuthProviderWrapper and useSaaSAuth. */
+export declare function useAuthState(): import("./types").IAuthState;
 export declare function useSaaSAuth(): {
     signIn: () => Promise<void>;
     signOut: () => Promise<void>;

package/dist/types/providers/os/api.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Centralized API client for organization (OS) settings.
+ * Extends BaseApi for shared URL/auth/request handling.
+ */
+import { BaseApi } from '../../lib/api-base';
+import type { ISettings } from '../types';
+import type { IOsConfig } from './types';
+export declare class SettingsApi extends BaseApi {
+    constructor(config: IOsConfig);
+    getSettings(signal?: AbortSignal): Promise<ISettings>;
+}

package/dist/types/providers/os/hooks.d.ts

@@ -1,4 +1,10 @@
 import type { ISettings } from '../types';
+import { type IOsState } from './types';
+/**
+ * Hook to access OS (organization) state (serverUrl, version, orgId, auth, settings).
+ * Prefer useSaaSSettings() when you only need settings.
+ */
+export declare function useSaaSOs(): IOsState;
 /**
  * Hook to access organization settings from the OS context.
  * Automatically fetches settings when OS config is ready.

package/dist/types/providers/os/types.d.ts

@@ -11,6 +11,8 @@ export interface IOsConfig {
     version: ApiVersion;
     orgId: string;
 }
+/** True when OS config has serverUrl, version, and orgId (ready for API calls). */
+export declare function isOsConfigReady(config: Pick<IOsConfig, 'serverUrl' | 'version' | 'orgId'> | null | undefined): boolean;
 export interface IOsState extends IOsConfig {
     auth?: IAuthConfig;
     settings?: ISettings | null;

package/dist/types/providers/user/api.d.ts

@@ -0,0 +1,16 @@
+import { IUser } from '../../api/types';
+import { BaseApi } from '../../lib/api-base';
+import type { IOsConfig } from '../os/types';
+/**
+ * Centralized API client for user attributes and features.
+ * Extends BaseApi for shared URL/auth/request handling.
+ */
+export declare class UserApi extends BaseApi {
+    constructor(config: Pick<IOsConfig, 'serverUrl' | 'version'>);
+    getAttributes(signal?: AbortSignal): Promise<Record<string, string | number | boolean>>;
+    updateAttributes(updates: Record<string, string | number | boolean>): Promise<IUser>;
+    updateAttribute(attributeKey: string, value: string | number | boolean): Promise<IUser>;
+    getFeatures(signal?: AbortSignal): Promise<Record<string, boolean>>;
+}
+/** Memoized UserApi instance. Recreates only when serverUrl or version change. BaseApi.ensureReady() throws if config is not set. */
+export declare function useUserApi(): UserApi;

package/dist/types/providers/user/hooks.d.ts

@@ -1,3 +1,4 @@
+export { useUserApi } from './api';
 /**
  * Hook to access user attributes from the UserProvider.
  * Must be used within a UserProvider component.

package/dist/types/providers/workspace/api.d.ts

@@ -1,12 +1,9 @@
 import { ICheckoutSessionRequest, ICheckoutSessionResponse, IInvoiceListResponse, IInvoiceResponse, IPlanGroupResponse, IPlanGroupVersion, IPlanGroupVersionsResponse, IPublicPlansResponse, ISubscriptionResponse, ISubscriptionUpdateRequest, ISubscriptionUpdateResponse, IUser } from '../../api/types';
+import { BaseApi } from '../../lib/api-base';
 import { IOsConfig } from '../os/types';
 import type { IWorkspace, IWorkspaceFeature, IWorkspaceUser } from './types';
-export declare class WorkspaceApi {
-    private version;
-    private orgId;
-    private serverUrl;
+export declare class WorkspaceApi extends BaseApi {
     constructor(config: IOsConfig);
-    getAuthHeader(): Record<string, string>;
     getWorkspaces(): Promise<IWorkspace[]>;
     createWorkspace(data: {
         name: string;
@@ -114,4 +111,18 @@ export declare class WorkspaceApi {
      * @returns Invoice details
      */
     getInvoice(workspaceId: string, invoiceId: string): Promise<IInvoiceResponse>;
+    /**
+     * Cancel subscription at the end of the current billing period
+     * Sets cancelAtPeriodEnd: true - subscription remains active until period ends
+     * @param workspaceId - The workspace ID
+     * @returns Updated subscription with cancelAtPeriodEnd and stripeCurrentPeriodEnd
+     */
+    cancelSubscriptionAtPeriodEnd(workspaceId: string): Promise<ISubscriptionResponse>;
+    /**
+     * Resume a subscription that was scheduled for cancellation
+     * Sets cancelAtPeriodEnd: false - subscription will continue after period ends
+     * @param workspaceId - The workspace ID
+     * @returns Updated subscription with cancelAtPeriodEnd set to false
+     */
+    resumeSubscription(workspaceId: string): Promise<ISubscriptionResponse>;
 }

package/dist/types/providers/workspace/hooks.d.ts

@@ -1,4 +1,6 @@
 import { IUser } from '../../api/types';
+import type { IOsConfig, IOsState } from '../os/types';
+import { WorkspaceApi } from './api';
 import { IWorkspace, IWorkspaceUser } from './types';
 /**
  * Main workspace management hook for the SDK.
@@ -105,6 +107,13 @@ import { IWorkspace, IWorkspaceUser } from './types';
  * }
  * ```
  */
+/** Memoized WorkspaceApi instance. Recreates only when serverUrl, version, or orgId change. */
+export declare function useWorkspaceApi(os: IOsConfig): WorkspaceApi;
+/** OS state + memoized WorkspaceApi. BaseApi.ensureReady() throws if config is not set. Use when a hook needs both (e.g. subscription hooks, useSaaSWorkspaces). */
+export declare function useWorkspaceApiWithOs(): {
+    os: IOsState;
+    api: WorkspaceApi;
+};
 export declare const useSaaSWorkspaces: () => {
     workspaces: IWorkspace[];
     loading: boolean;
@@ -148,4 +157,5 @@ export declare const useSaaSWorkspaces: () => {
         success: boolean;
     }>;
     switching: boolean;
+    switchingToId: string | null;
 };

package/dist/types/providers/workspace/subscription-hooks.d.ts

@@ -120,7 +120,7 @@ export declare const useSubscription: (workspaceId: string | null | undefined) =
  *
  *   return (
  *     <div>
- *       <h3>{planGroup.name}</h3>
+ *       <h3>{planGroup.group.name}</h3>
  *       {planGroup.plans.map(plan => (
  *         <PlanCard key={plan._id} plan={plan} />
  *       ))}
@@ -480,3 +480,83 @@ export declare const useInvoice: (workspaceId: string | null | undefined, invoic
     error: string | null;
     refetch: () => Promise<void>;
 };
+/**
+ * Hook to cancel a subscription at the end of the current billing period.
+ * Sets cancelAtPeriodEnd: true - subscription remains active until period ends.
+ *
+ * @param workspaceId - The workspace ID. Can be null/undefined.
+ * @returns An object containing:
+ * - `cancelSubscription()`: Function to cancel subscription at period end
+ * - `loading`: Boolean indicating if cancellation is in progress
+ * - `error`: Error message string (null if no error)
+ *
+ * @example
+ * ```tsx
+ * function CancelSubscriptionButton() {
+ *   const { currentWorkspace } = useSaaSWorkspaces();
+ *   const { cancelSubscription, loading } = useCancelSubscription(currentWorkspace?._id);
+ *   const { refetch } = useSubscription(currentWorkspace?._id);
+ *
+ *   const handleCancel = async () => {
+ *     try {
+ *       await cancelSubscription();
+ *       await refetch(); // Refresh subscription data
+ *       alert('Subscription will be canceled at the end of the billing period');
+ *     } catch (error) {
+ *       console.error('Failed to cancel:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <button onClick={handleCancel} disabled={loading}>
+ *       {loading ? 'Canceling...' : 'Cancel Subscription'}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+export declare const useCancelSubscription: (workspaceId: string | null | undefined) => {
+    cancelSubscription: () => Promise<ISubscriptionResponse>;
+    loading: boolean;
+    error: string | null;
+};
+/**
+ * Hook to resume a subscription that was scheduled for cancellation.
+ * Sets cancelAtPeriodEnd: false - subscription will continue after period ends.
+ *
+ * @param workspaceId - The workspace ID. Can be null/undefined.
+ * @returns An object containing:
+ * - `resumeSubscription()`: Function to resume subscription
+ * - `loading`: Boolean indicating if resume is in progress
+ * - `error`: Error message string (null if no error)
+ *
+ * @example
+ * ```tsx
+ * function ResumeSubscriptionButton() {
+ *   const { currentWorkspace } = useSaaSWorkspaces();
+ *   const { resumeSubscription, loading } = useResumeSubscription(currentWorkspace?._id);
+ *   const { refetch } = useSubscription(currentWorkspace?._id);
+ *
+ *   const handleResume = async () => {
+ *     try {
+ *       await resumeSubscription();
+ *       await refetch(); // Refresh subscription data
+ *       alert('Subscription has been resumed');
+ *     } catch (error) {
+ *       console.error('Failed to resume:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <button onClick={handleResume} disabled={loading}>
+ *       {loading ? 'Resuming...' : 'Resume Subscription'}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+export declare const useResumeSubscription: (workspaceId: string | null | undefined) => {
+    resumeSubscription: () => Promise<ISubscriptionResponse>;
+    loading: boolean;
+    error: string | null;
+};

package/dist/types/providers/workspace/ui/SubscriptionDialog.d.ts

@@ -1,11 +1,12 @@
 import React from 'react';
-import { IPlanVersionWithPlan } from '../../../api/types';
+import { BillingInterval, IPlanVersionWithPlan } from '../../../api/types';
 interface SubscriptionDialogProps {
     open: boolean;
     onOpenChange: (open: boolean) => void;
     planVersions: IPlanVersionWithPlan[];
     currentPlanVersionId?: string | null;
-    onSelectPlan: (planVersionId: string) => Promise<void>;
+    currentStripePriceId?: string | null;
+    onSelectPlan: (planVersionId: string, billingInterval: BillingInterval) => Promise<void>;
     loading?: boolean;
 }
 declare const SubscriptionDialog: React.FC<SubscriptionDialogProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildbase/sdk",
-  "version": "0.0.15",
+  "version": "0.0.18",
   "type": "module",
   "description": "A SDK for Buildbase",
   "main": "dist/index.js",