@growflowstudio/growflowbooking-admin-core 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,518 @@
+import * as react from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+/** Generic JSON value type */
+type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+type JsonObject = {
+    [key: string]: JsonValue;
+};
+type JsonArray = JsonValue[];
+/** Paginated response wrapper */
+interface PaginatedResponse<T> {
+    items: T[];
+    total: number;
+    page?: number;
+    page_size?: number;
+}
+/** HTTP fetcher function type — provided by the host application */
+type Fetcher = (url: string, options?: FetcherOptions) => Promise<unknown>;
+interface FetcherOptions {
+    method?: string;
+    body?: unknown;
+    params?: Record<string, string | number | boolean | undefined>;
+    headers?: Record<string, string>;
+}
+
+/** Subscription plan tier for a tenant */
+type TenantPlan = 'free' | 'starter' | 'professional' | 'enterprise';
+/** Admin tenant list item */
+interface AdminTenant {
+    id: string;
+    name: string;
+    slug: string;
+    plan: TenantPlan;
+    is_active: boolean;
+    owner_email: string;
+    logo_url: string | null;
+    domain: string | null;
+    max_services: number;
+    max_staff: number;
+    max_locations: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Admin tenant detail (includes stats) */
+interface AdminTenantDetail extends AdminTenant {
+    services_count: number;
+    staff_count: number;
+    locations_count: number;
+    customers_count: number;
+    bookings_count: number;
+    billing_subscription_id: string | null;
+    billing_subscriber_id: string | null;
+}
+/** Tenant resource limits */
+interface TenantLimits {
+    max_services: number;
+    max_staff: number;
+    max_locations: number;
+    max_customers: number;
+    max_bookings_per_month: number;
+}
+/** Create tenant request */
+interface AdminTenantCreate {
+    name: string;
+    slug: string;
+    owner_email: string;
+    plan?: TenantPlan;
+    domain?: string;
+    max_services?: number;
+    max_staff?: number;
+    max_locations?: number;
+}
+/** Update tenant request */
+interface AdminTenantUpdate {
+    name?: string;
+    slug?: string;
+    owner_email?: string;
+    domain?: string;
+    logo_url?: string | null;
+}
+/** Update tenant limits request */
+interface AdminTenantLimitsUpdate {
+    max_services?: number;
+    max_staff?: number;
+    max_locations?: number;
+    max_customers?: number;
+    max_bookings_per_month?: number;
+}
+
+/** Customer with tenant info */
+interface CustomerWithTenant {
+    id: string;
+    tenant_id: string;
+    tenant_name: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone: string | null;
+    is_active: boolean;
+    notes: string | null;
+    created_at: string;
+    updated_at: string;
+}
+/** Create customer request */
+interface AdminCustomerCreate {
+    tenant_id: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone?: string;
+    notes?: string;
+}
+/** Update customer request */
+interface AdminCustomerUpdate {
+    email?: string;
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+    is_active?: boolean;
+    notes?: string;
+}
+
+/** Pricing model for subscription plans */
+type PlanPricingModel = 'flat' | 'tiered' | 'usage_based';
+/** Feature included in a subscription plan */
+interface PlanFeature {
+    slug: string;
+    name: string;
+    description?: string;
+    included: boolean;
+    limit?: number;
+}
+/** Subscription plan (local DB) */
+interface SubscriptionPlan {
+    id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    pricing_model: PlanPricingModel;
+    price_monthly: number | null;
+    price_yearly: number | null;
+    currency: string;
+    features: PlanFeature[];
+    limits: Record<string, number>;
+    trial_days: number;
+    is_active: boolean;
+    sort_order: number;
+    created_at: string;
+    updated_at: string;
+}
+/** Subscription plan list response */
+interface SubscriptionPlanList {
+    items: SubscriptionPlan[];
+    total: number;
+}
+/** Create subscription plan request */
+interface SubscriptionPlanCreate {
+    slug: string;
+    name: string;
+    description?: string;
+    pricing_model?: PlanPricingModel;
+    price_monthly?: number;
+    price_yearly?: number;
+    currency?: string;
+    features?: PlanFeature[];
+    limits?: Record<string, number>;
+    trial_days?: number;
+    is_active?: boolean;
+    sort_order?: number;
+}
+/** Update subscription plan request */
+interface SubscriptionPlanUpdate {
+    name?: string;
+    description?: string;
+    pricing_model?: PlanPricingModel;
+    price_monthly?: number;
+    price_yearly?: number;
+    currency?: string;
+    features?: PlanFeature[];
+    limits?: Record<string, number>;
+    trial_days?: number;
+    is_active?: boolean;
+    sort_order?: number;
+}
+
+/** Billing plan from GrowFlow Billing (proxy) */
+interface BillingPlan {
+    id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    pricingModel: string;
+    priceMonthly: number | null;
+    priceYearly: number | null;
+    currency: string;
+    limits: Record<string, number>;
+    features: string[];
+    trialDays: number;
+    isActive: boolean;
+    contactSales: boolean;
+    color: string;
+    sortOrder: number;
+    stripeMonthlyPriceId: string | null;
+    stripeYearlyPriceId: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Billing plan list response */
+interface BillingPlanList {
+    items: BillingPlan[];
+    total: number;
+}
+/** Create billing plan request */
+interface CreateBillingPlanRequest {
+    slug: string;
+    name: string;
+    description?: string;
+    pricingModel?: string;
+    priceMonthly?: number;
+    priceYearly?: number;
+    currency?: string;
+    limits?: Record<string, number>;
+    features?: string[];
+    trialDays?: number;
+    isActive?: boolean;
+    contactSales?: boolean;
+    color?: string;
+}
+/** Update billing plan request */
+interface UpdateBillingPlanRequest {
+    name?: string;
+    description?: string;
+    pricingModel?: string;
+    priceMonthly?: number;
+    priceYearly?: number;
+    currency?: string;
+    limits?: Record<string, number>;
+    features?: string[];
+    trialDays?: number;
+    isActive?: boolean;
+    contactSales?: boolean;
+    color?: string;
+}
+/** Billing subscription status */
+type BillingSubscriptionStatus = 'active' | 'trialing' | 'past_due' | 'canceled' | 'unpaid' | 'incomplete';
+/** Billing subscription from GrowFlow Billing (proxy) */
+interface BillingSubscription {
+    id: string;
+    subscriberId: string;
+    subscriberExternalId: string;
+    subscriberEmail: string;
+    subscriberName: string | null;
+    planId: string;
+    planSlug: string;
+    planName: string;
+    stripeSubscriptionId: string | null;
+    status: BillingSubscriptionStatus;
+    billingCycle: 'monthly' | 'yearly';
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    trialStart: string | null;
+    trialEnd: string | null;
+    canceledAt: string | null;
+    cancelAt: string | null;
+    localLimits: Record<string, number> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Billing subscription list response */
+interface BillingSubscriptionList {
+    items: BillingSubscription[];
+    total: number;
+}
+/** Create billing subscription request */
+interface CreateBillingSubscriptionRequest {
+    subscriberExternalId: string;
+    subscriberEmail: string;
+    subscriberName?: string;
+    planSlug: string;
+    billingCycle?: 'monthly' | 'yearly';
+    localLimits?: Record<string, number>;
+}
+
+/** GrowFlow Billing settings for the booking platform */
+interface BillingSettings {
+    apiKeyConfigured: boolean;
+    apiKeyMasked: string | null;
+    webhookSecretConfigured: boolean;
+    webhookSecretMasked: string | null;
+    mode: string;
+    billingUrlTest: string | null;
+    billingUrlProduction: string | null;
+    clientId: string | null;
+}
+/** Update billing settings request */
+interface UpdateBillingSettingsRequest {
+    apiKey?: string;
+    webhookSecret?: string;
+    mode?: string;
+    billingUrlTest?: string;
+    billingUrlProduction?: string;
+    clientId?: string;
+}
+/** Billing connection test result */
+interface BillingTestResult {
+    success: boolean;
+    message: string;
+    plansCount: number | null;
+}
+
+interface BookingAdminApiClientOptions {
+    basePath: string;
+    fetcher: Fetcher;
+}
+/**
+ * Booking Admin API client.
+ * Provides typed methods for all booking admin endpoints.
+ * Uses a fetcher function provided by the host application (handles auth headers, base URL, etc.).
+ */
+declare class BookingAdminApiClient {
+    private basePath;
+    private fetcher;
+    constructor(options: BookingAdminApiClientOptions);
+    private request;
+    getTenants(params?: {
+        search?: string;
+        plan?: TenantPlan;
+        is_active?: boolean;
+        page?: number;
+        page_size?: number;
+    }): Promise<PaginatedResponse<AdminTenant>>;
+    getTenant(id: string): Promise<AdminTenantDetail>;
+    createTenant(data: AdminTenantCreate): Promise<AdminTenant>;
+    updateTenant(id: string, data: AdminTenantUpdate): Promise<AdminTenantDetail>;
+    deleteTenant(id: string): Promise<void>;
+    updateTenantPlan(id: string, plan: TenantPlan): Promise<AdminTenant>;
+    updateTenantStatus(id: string, isActive: boolean): Promise<AdminTenant>;
+    getTenantLimits(id: string): Promise<TenantLimits>;
+    updateTenantLimits(id: string, limits: AdminTenantLimitsUpdate): Promise<TenantLimits>;
+    getCustomers(params?: {
+        search?: string;
+        tenant_id?: string;
+        is_active?: boolean;
+        page?: number;
+        page_size?: number;
+    }): Promise<PaginatedResponse<CustomerWithTenant>>;
+    createCustomer(data: AdminCustomerCreate): Promise<CustomerWithTenant>;
+    updateCustomer(id: string, data: AdminCustomerUpdate): Promise<CustomerWithTenant>;
+    deleteCustomer(id: string): Promise<void>;
+    getSubscriptionPlans(includeInactive?: boolean): Promise<SubscriptionPlanList>;
+    getSubscriptionPlan(id: string): Promise<SubscriptionPlan>;
+    createSubscriptionPlan(data: SubscriptionPlanCreate): Promise<SubscriptionPlan>;
+    updateSubscriptionPlan(id: string, data: SubscriptionPlanUpdate): Promise<SubscriptionPlan>;
+    deleteSubscriptionPlan(id: string): Promise<void>;
+    getBillingPlans(isActive?: boolean): Promise<BillingPlanList>;
+    createBillingPlan(data: CreateBillingPlanRequest): Promise<BillingPlan>;
+    updateBillingPlan(id: string, data: UpdateBillingPlanRequest): Promise<BillingPlan>;
+    deleteBillingPlan(id: string): Promise<void>;
+    syncBillingPlanToStripe(id: string): Promise<BillingPlan>;
+    getBillingSubscriptions(params?: {
+        status?: string;
+        search?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<BillingSubscriptionList>;
+    getBillingSubscription(id: string): Promise<BillingSubscription>;
+    createBillingSubscription(data: CreateBillingSubscriptionRequest): Promise<BillingSubscription>;
+    cancelBillingSubscription(id: string, atPeriodEnd?: boolean): Promise<BillingSubscription>;
+    changeBillingSubscriptionPlan(id: string, newPlanSlug: string): Promise<BillingSubscription>;
+    getBillingSettings(): Promise<BillingSettings>;
+    updateBillingSettings(data: UpdateBillingSettingsRequest): Promise<BillingSettings>;
+    testBillingConnection(): Promise<BillingTestResult>;
+}
+/** Factory function for creating a BookingAdminApiClient */
+declare function createBookingAdminClient(options: BookingAdminApiClientOptions): BookingAdminApiClient;
+
+declare const BookingAdminClientContext: react.Context<BookingAdminApiClient | null>;
+declare function useBookingAdminClient(): BookingAdminApiClient;
+
+/**
+ * Generic hook for managing dialog state with optional associated data.
+ */
+declare function useDialogState<T = undefined>(): {
+    isOpen: boolean;
+    data: T | undefined;
+    open: (initialData?: T) => void;
+    close: () => void;
+    toggle: () => void;
+    setData: react.Dispatch<react.SetStateAction<T | undefined>>;
+};
+
+declare function useAdminTenants(params?: {
+    search?: string;
+    plan?: TenantPlan;
+    is_active?: boolean;
+    page?: number;
+    page_size?: number;
+}): _tanstack_react_query.UseQueryResult<PaginatedResponse<AdminTenant>, Error>;
+declare function useAdminTenant(id: string): _tanstack_react_query.UseQueryResult<AdminTenantDetail, Error>;
+declare function useCreateTenant(): _tanstack_react_query.UseMutationResult<AdminTenant, Error, AdminTenantCreate, unknown>;
+declare function useUpdateTenant(): _tanstack_react_query.UseMutationResult<AdminTenantDetail, Error, {
+    id: string;
+    data: AdminTenantUpdate;
+}, unknown>;
+declare function useDeleteTenant(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+declare function useUpdateTenantPlan(): _tanstack_react_query.UseMutationResult<AdminTenant, Error, {
+    id: string;
+    plan: TenantPlan;
+}, unknown>;
+declare function useUpdateTenantStatus(): _tanstack_react_query.UseMutationResult<AdminTenant, Error, {
+    id: string;
+    isActive: boolean;
+}, unknown>;
+declare function useTenantLimits(id: string): _tanstack_react_query.UseQueryResult<TenantLimits, Error>;
+declare function useUpdateTenantLimits(): _tanstack_react_query.UseMutationResult<TenantLimits, Error, {
+    id: string;
+    limits: AdminTenantLimitsUpdate;
+}, unknown>;
+
+declare function useAdminCustomers(params?: {
+    search?: string;
+    tenant_id?: string;
+    is_active?: boolean;
+    page?: number;
+    page_size?: number;
+}): _tanstack_react_query.UseQueryResult<PaginatedResponse<CustomerWithTenant>, Error>;
+declare function useCreateCustomer(): _tanstack_react_query.UseMutationResult<CustomerWithTenant, Error, AdminCustomerCreate, unknown>;
+declare function useUpdateCustomer(): _tanstack_react_query.UseMutationResult<CustomerWithTenant, Error, {
+    id: string;
+    data: AdminCustomerUpdate;
+}, unknown>;
+declare function useDeleteCustomer(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+
+declare function useSubscriptionPlans(includeInactive?: boolean): _tanstack_react_query.UseQueryResult<SubscriptionPlanList, Error>;
+declare function useSubscriptionPlan(id: string): _tanstack_react_query.UseQueryResult<SubscriptionPlan, Error>;
+declare function useCreateSubscriptionPlan(): _tanstack_react_query.UseMutationResult<SubscriptionPlan, Error, SubscriptionPlanCreate, unknown>;
+declare function useUpdateSubscriptionPlan(): _tanstack_react_query.UseMutationResult<SubscriptionPlan, Error, {
+    id: string;
+    data: SubscriptionPlanUpdate;
+}, unknown>;
+declare function useDeleteSubscriptionPlan(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+
+declare function useBillingPlans(isActive?: boolean): _tanstack_react_query.UseQueryResult<BillingPlanList, Error>;
+declare function useCreateBillingPlan(): _tanstack_react_query.UseMutationResult<BillingPlan, Error, CreateBillingPlanRequest, unknown>;
+declare function useUpdateBillingPlan(): _tanstack_react_query.UseMutationResult<BillingPlan, Error, {
+    id: string;
+    data: UpdateBillingPlanRequest;
+}, unknown>;
+declare function useDeleteBillingPlan(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+declare function useSyncBillingPlanToStripe(): _tanstack_react_query.UseMutationResult<BillingPlan, Error, string, unknown>;
+
+declare function useBillingSubscriptions(params?: {
+    status?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+}): _tanstack_react_query.UseQueryResult<BillingSubscriptionList, Error>;
+declare function useBillingSubscription(id: string): _tanstack_react_query.UseQueryResult<BillingSubscription, Error>;
+declare function useCreateBillingSubscription(): _tanstack_react_query.UseMutationResult<BillingSubscription, Error, CreateBillingSubscriptionRequest, unknown>;
+declare function useCancelBillingSubscription(): _tanstack_react_query.UseMutationResult<BillingSubscription, Error, {
+    id: string;
+    atPeriodEnd?: boolean;
+}, unknown>;
+declare function useChangeBillingSubscriptionPlan(): _tanstack_react_query.UseMutationResult<BillingSubscription, Error, {
+    id: string;
+    newPlanSlug: string;
+}, unknown>;
+
+declare function useBillingSettings(): _tanstack_react_query.UseQueryResult<BillingSettings, Error>;
+declare function useUpdateBillingSettings(): _tanstack_react_query.UseMutationResult<BillingSettings, Error, UpdateBillingSettingsRequest, unknown>;
+declare function useTestBillingConnection(): _tanstack_react_query.UseMutationResult<BillingTestResult, Error, void, unknown>;
+
+/**
+ * Format a currency amount using Intl.NumberFormat.
+ */
+declare function formatCurrency(amount: number, currency?: string, locale?: string): string;
+/**
+ * Format amount in cents to currency string.
+ */
+declare function formatCurrencyFromCents(amountCents: number, currency?: string, locale?: string): string;
+/**
+ * Format a price, returning "Contattaci" for null values.
+ */
+declare function formatPrice(price: number | null, currency?: string, locale?: string): string;
+/**
+ * Format a date string or Date object.
+ */
+declare function formatDate(date: Date | string | undefined | null, locale?: string): string;
+/**
+ * Format a Unix timestamp (seconds) to date string.
+ */
+declare function formatTimestamp(timestamp: number | null, includeTime?: boolean, locale?: string): string;
+/**
+ * Truncate long IDs for display.
+ */
+declare function truncateId(id: string, maxLength?: number): string;
+
+declare const tenantStatusColors: Record<string, string>;
+declare const tenantStatusLabels: Record<string, string>;
+declare const tenantPlanColors: Record<TenantPlan, string>;
+declare const tenantPlanLabels: Record<TenantPlan, string>;
+declare const billingSubscriptionStatusColors: Record<BillingSubscriptionStatus, string>;
+declare const billingSubscriptionStatusLabels: Record<BillingSubscriptionStatus, string>;
+
+/**
+ * Validate a plan slug format.
+ */
+declare function validateSlug(slug: string): string | null;
+/**
+ * Validate required string field.
+ */
+declare function validateRequired(value: string, fieldName: string): string | null;
+/**
+ * Validate email format.
+ */
+declare function validateEmail(email: string): string | null;
+
+export { type AdminCustomerCreate, type AdminCustomerUpdate, type AdminTenant, type AdminTenantCreate, type AdminTenantDetail, type AdminTenantLimitsUpdate, type AdminTenantUpdate, type BillingPlan, type BillingPlanList, type BillingSettings, type BillingSubscription, type BillingSubscriptionList, type BillingSubscriptionStatus, type BillingTestResult, BookingAdminApiClient, type BookingAdminApiClientOptions, BookingAdminClientContext, type CreateBillingPlanRequest, type CreateBillingSubscriptionRequest, type CustomerWithTenant, type Fetcher, type FetcherOptions, type JsonArray, type JsonObject, type JsonValue, type PaginatedResponse, type PlanFeature, type PlanPricingModel, type SubscriptionPlan, type SubscriptionPlanCreate, type SubscriptionPlanList, type SubscriptionPlanUpdate, type TenantLimits, type TenantPlan, type UpdateBillingPlanRequest, type UpdateBillingSettingsRequest, billingSubscriptionStatusColors, billingSubscriptionStatusLabels, createBookingAdminClient, formatCurrency, formatCurrencyFromCents, formatDate, formatPrice, formatTimestamp, tenantPlanColors, tenantPlanLabels, tenantStatusColors, tenantStatusLabels, truncateId, useAdminCustomers, useAdminTenant, useAdminTenants, useBillingPlans, useBillingSettings, useBillingSubscription, useBillingSubscriptions, useBookingAdminClient, useCancelBillingSubscription, useChangeBillingSubscriptionPlan, useCreateBillingPlan, useCreateBillingSubscription, useCreateCustomer, useCreateSubscriptionPlan, useCreateTenant, useDeleteBillingPlan, useDeleteCustomer, useDeleteSubscriptionPlan, useDeleteTenant, useDialogState, useSubscriptionPlan, useSubscriptionPlans, useSyncBillingPlanToStripe, useTenantLimits, useTestBillingConnection, useUpdateBillingPlan, useUpdateBillingSettings, useUpdateCustomer, useUpdateSubscriptionPlan, useUpdateTenant, useUpdateTenantLimits, useUpdateTenantPlan, useUpdateTenantStatus, validateEmail, validateRequired, validateSlug };