@buildbase/sdk 0.0.9 → 0.0.10

package/dist/index.d.ts

@@ -21,6 +21,134 @@ interface IUser extends IDocument {
     currency: string;
     attributes?: Record<string, string | number | boolean>;
 }
+interface ISubscription {
+    _id: string;
+    subscriptionStatus: 'active' | 'trialing' | 'canceled' | 'past_due';
+    cancelAtPeriodEnd: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ISubscriptionItem {
+    _id: string;
+    type: 'feature' | 'limit' | 'quota';
+    name: string;
+    slug: string;
+    description?: string;
+    category: string;
+}
+interface IQuotaValue {
+    included: number;
+    overage: number;
+}
+interface IPlanVersion {
+    _id: string;
+    version: number;
+    name: string;
+    status: 'draft' | 'published';
+    features?: Record<string, boolean>;
+    limits?: Record<string, number>;
+    quotas?: Record<string, number | IQuotaValue>;
+    stripePrices?: {
+        monthly?: string;
+        yearly?: string;
+    };
+    subscriptionItems?: ISubscriptionItem[];
+    isCurrent?: boolean;
+    isLegacy?: boolean;
+    archived?: boolean;
+    deleted?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    id?: string;
+}
+interface IPlan {
+    _id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    latestVersion?: IPlanVersion;
+    archived?: boolean;
+    deleted?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    id?: string;
+}
+interface IPlanGroupLatestVersion {
+    _id: string;
+    version: number;
+    planVersionIds: string[];
+    requiredItems: string[];
+    status: 'draft' | 'published';
+    isCurrent?: boolean;
+    isLegacy?: boolean;
+    archived?: boolean;
+    deleted?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    description?: string;
+}
+interface IPlanGroup {
+    _id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    latestVersion?: IPlanGroupLatestVersion;
+    archived?: boolean;
+    deleted?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    id?: string;
+}
+interface IPlanGroupVersion {
+    _id: string;
+    version: number;
+    description?: string;
+    group?: {
+        _id: string;
+        name: string;
+        description?: string;
+    };
+    planVersionIds: IPlanVersionWithPlan[] | string[];
+    requiredItems?: string[];
+    status?: 'draft' | 'published';
+    isCurrent?: boolean;
+    isLegacy?: boolean;
+    archived?: boolean;
+    deleted?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    id?: string;
+}
+interface ISubscriptionResponse {
+    subscription: ISubscription | null;
+    planVersion: IPlanVersion | null;
+    plan: IPlan | null;
+    group: IPlanGroup | null;
+    groupVersion: IPlanGroupVersion | null;
+}
+interface IPlanVersionWithPlan extends IPlanVersion {
+    plan: IPlan;
+}
+interface IPlanGroupResponse {
+    group: IPlanGroup;
+    groupVersion: IPlanGroupVersion;
+    plans: IPlanVersionWithPlan[];
+}
+interface ISubscriptionUpdateRequest {
+    planVersionId: string;
+}
+interface ISubscriptionUpdateResponse {
+    _id: string;
+    subscriptionStatus: string;
+    workspace: string;
+    planVersion: string;
+    plan: string;
+    planGroup?: string;
+    planGroupVersion?: string;
+    cancelAtPeriodEnd: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
 
 interface IWorkspace {
     _id: string;
@@ -309,6 +437,55 @@ declare const useSaaSWorkspaces: () => {
     }>;
 };
 
+/**
+ * Hook to get and manage the current subscription for a workspace
+ * @param workspaceId - The workspace ID to get subscription for
+ * @returns Subscription data and loading/error states
+ */
+declare const useSubscription: (workspaceId: string | null | undefined) => {
+    subscription: ISubscriptionResponse | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+};
+/**
+ * Hook to get the plan group for a workspace
+ * Returns the plan group containing the current plan if subscription exists,
+ * otherwise returns the latest published group
+ * @param workspaceId - The workspace ID to get plan group for
+ * @returns Plan group data and loading/error states
+ */
+declare const usePlanGroup: (workspaceId: string | null | undefined) => {
+    planGroup: IPlanGroupResponse | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+};
+/**
+ * Hook to update subscription (upgrade/downgrade)
+ * @param workspaceId - The workspace ID to update subscription for
+ * @returns Update function and loading/error states
+ */
+declare const useUpdateSubscription: (workspaceId: string | null | undefined) => {
+    updateSubscription: (planVersionId: string) => Promise<ISubscriptionUpdateResponse>;
+    loading: boolean;
+    error: string | null;
+};
+/**
+ * Combined hook that provides both subscription and plan group data
+ * Useful for subscription management pages
+ * @param workspaceId - The workspace ID
+ * @returns Combined subscription and plan group data with loading/error states
+ */
+declare const useSubscriptionManagement: (workspaceId: string | null | undefined) => {
+    subscription: ISubscriptionResponse | null;
+    planGroup: IPlanGroupResponse | null;
+    loading: boolean;
+    error: string | null;
+    updateSubscription: (planVersionId: string) => Promise<ISubscriptionUpdateResponse>;
+    refetch: () => Promise<void>;
+};
+
 /**
  * EventEmitter class to handle and trigger event callbacks
  * This class manages all event listeners and provides methods to trigger events
@@ -481,5 +658,5 @@ declare const errorHandler: ErrorHandler;
 declare function handleError(error: Error | unknown, context?: SDKErrorContext): void;
 declare function createSDKError(message: string, code?: string, context?: SDKErrorContext, originalError?: Error): SDKError;
 
-export { ApiVersion, BetaForm, SDKErrorBoundary as ErrorBoundary, SDKError, SDKErrorBoundary, SaaSOSProvider, WhenAuthenticated, WhenRoles, WhenUnauthenticated, WhenUserFeatureDisabled, WhenUserFeatureEnabled, WhenWorkspaceFeatureDisabled, WhenWorkspaceFeatureEnabled, WhenWorkspaceRoles, WorkspaceSwitcher, createSDKError, errorHandler, eventEmitter, handleError, useSaaSAuth, useSaaSSettings, useSaaSWorkspaces, useUserAttributes, useUserFeatures };
-export type { ErrorHandlerConfig, EventData, EventType, IEventCallbacks, SDKErrorContext, UserCreatedEventData, UserUpdatedEventData, WorkspaceChangedEventData, WorkspaceCreatedEventData, WorkspaceDeletedEventData, WorkspaceUpdatedEventData, WorkspaceUserAddedEventData, WorkspaceUserRemovedEventData, WorkspaceUserRoleChangedEventData };
+export { ApiVersion, BetaForm, SDKErrorBoundary as ErrorBoundary, SDKError, SDKErrorBoundary, SaaSOSProvider, WhenAuthenticated, WhenRoles, WhenUnauthenticated, WhenUserFeatureDisabled, WhenUserFeatureEnabled, WhenWorkspaceFeatureDisabled, WhenWorkspaceFeatureEnabled, WhenWorkspaceRoles, WorkspaceSwitcher, createSDKError, errorHandler, eventEmitter, handleError, usePlanGroup, useSaaSAuth, useSaaSSettings, useSaaSWorkspaces, useSubscription, useSubscriptionManagement, useUpdateSubscription, useUserAttributes, useUserFeatures };
+export type { ErrorHandlerConfig, EventData, EventType, IEventCallbacks, IPlan, IPlanGroup, IPlanGroupLatestVersion, IPlanGroupResponse, IPlanGroupVersion, IPlanVersion, IPlanVersionWithPlan, IQuotaValue, ISubscription, ISubscriptionItem, ISubscriptionResponse, ISubscriptionUpdateRequest, ISubscriptionUpdateResponse, SDKErrorContext, UserCreatedEventData, UserUpdatedEventData, WorkspaceChangedEventData, WorkspaceCreatedEventData, WorkspaceDeletedEventData, WorkspaceUpdatedEventData, WorkspaceUserAddedEventData, WorkspaceUserRemovedEventData, WorkspaceUserRoleChangedEventData };