@growflowstudio/growflowbilling-admin-core 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present GrowFlow Studio
+
+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.

package/dist/index.d.mts

@@ -0,0 +1,447 @@
+import * as react from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+type AdminPlanPricingModel = 'flat' | 'tiered' | 'per_unit' | 'usage_based';
+interface AdminPlan {
+    id: string;
+    client_id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    pricing_model: AdminPlanPricingModel;
+    price_monthly: number | null;
+    price_yearly: number | null;
+    currency: string;
+    stripe_price_id_monthly: string | null;
+    stripe_price_id_yearly: string | null;
+    limits: Record<string, number> | null;
+    features: string[] | null;
+    trial_days: number;
+    is_active: boolean;
+    contact_sales: boolean;
+    color: string;
+    sort_order: number;
+    created_at: string;
+    updated_at: string;
+}
+interface AdminPlanCreate {
+    slug: string;
+    name: string;
+    description?: string;
+    pricing_model?: AdminPlanPricingModel;
+    price_monthly?: number;
+    price_yearly?: number;
+    currency?: string;
+    limits?: Record<string, number>;
+    features?: string[];
+    trial_days?: number;
+    is_active?: boolean;
+    contact_sales?: boolean;
+    color?: string;
+    sort_order?: number;
+}
+interface AdminPlanUpdate {
+    name?: string;
+    description?: string;
+    pricing_model?: AdminPlanPricingModel;
+    price_monthly?: number;
+    price_yearly?: number;
+    limits?: Record<string, number>;
+    features?: string[];
+    trial_days?: number;
+    is_active?: boolean;
+    contact_sales?: boolean;
+    color?: string;
+    sort_order?: number;
+}
+
+type AdminSubscriptionStatus = 'active' | 'trialing' | 'past_due' | 'canceled' | 'unpaid' | 'incomplete';
+interface AdminSubscription {
+    id: string;
+    subscriber_id: string;
+    subscriber_external_id: string;
+    subscriber_email: string;
+    subscriber_name: string | null;
+    plan_id: string;
+    plan_slug: string;
+    plan_name: string;
+    stripe_subscription_id: string | null;
+    status: AdminSubscriptionStatus;
+    billing_cycle: 'monthly' | 'yearly';
+    current_period_start: string | null;
+    current_period_end: string | null;
+    trial_start: string | null;
+    trial_end: string | null;
+    canceled_at: string | null;
+    cancel_at: string | null;
+    created_at: string;
+    updated_at: string;
+}
+interface AdminSubscriptionCreate {
+    subscriber_external_id: string;
+    subscriber_email: string;
+    subscriber_name?: string;
+    plan_slug: string;
+    billing_cycle?: 'monthly' | 'yearly';
+}
+
+interface PaginatedResponse<T> {
+    items: T[];
+    total: number;
+}
+interface CursorPaginatedResponse<T> {
+    data: T[];
+    has_more: boolean;
+}
+/** Represents any valid JSON primitive value */
+type JsonPrimitive = string | number | boolean | null;
+/** Represents a valid JSON object */
+type JsonObject = {
+    [key: string]: JsonValue;
+};
+/** Represents a valid JSON array */
+type JsonArray = JsonValue[];
+/** Represents any valid JSON value (recursive) */
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+/** Billing recurring interval */
+type RecurringInterval = 'month' | 'year' | 'week' | 'day';
+/** Refund status from Stripe */
+type RefundStatus = 'pending' | 'succeeded' | 'failed' | 'canceled';
+
+type AdminPaymentStatus = 'succeeded' | 'pending' | 'failed' | 'canceled' | 'requires_payment_method';
+interface AdminPayment {
+    id: string;
+    amount: number;
+    currency: string;
+    status: AdminPaymentStatus;
+    created: number;
+    customer_id: string | null;
+    customer_email: string | null;
+    description: string | null;
+    metadata: Record<string, string>;
+}
+interface AdminPaymentRefund {
+    id: string;
+    amount: number;
+    status: RefundStatus;
+    reason: string | null;
+    created: number;
+}
+
+type AdminInvoiceStatus = 'draft' | 'open' | 'paid' | 'void' | 'uncollectible';
+interface AdminInvoice {
+    id: string;
+    number: string | null;
+    status: AdminInvoiceStatus;
+    amount_due: number;
+    amount_paid: number;
+    amount_remaining: number;
+    currency: string;
+    created: number;
+    due_date: number | null;
+    customer_id: string | null;
+    customer_email: string | null;
+    customer_name: string | null;
+    subscription_id: string | null;
+    invoice_pdf: string | null;
+    hosted_invoice_url: string | null;
+    lines: AdminInvoiceLineItem[];
+}
+interface AdminInvoiceLineItem {
+    id: string;
+    description: string;
+    amount: number;
+    quantity: number;
+    currency: string;
+}
+
+/** Known fields in product extra_data. Extends index signature to allow additional project-specific fields. */
+interface ProductExtraData {
+    feature_slug?: string;
+    [key: string]: JsonValue | undefined;
+}
+interface AdminProduct {
+    id: string;
+    client_id: string;
+    stripe_product_id: string | null;
+    stripe_price_id: string | null;
+    name: string;
+    description: string | null;
+    price_cents: number;
+    currency: string;
+    recurring_interval: RecurringInterval | null;
+    category: string | null;
+    is_active: boolean;
+    extra_data: ProductExtraData | null;
+    created_at: string | null;
+    updated_at: string | null;
+}
+interface AdminProductCreate {
+    client_id?: string;
+    name: string;
+    description?: string;
+    price_cents: number;
+    currency?: string;
+    recurring_interval?: RecurringInterval;
+    category?: string;
+    is_active?: boolean;
+    sync_stripe?: boolean;
+    extra_data?: ProductExtraData;
+}
+interface AdminProductUpdate {
+    name?: string;
+    description?: string;
+    price_cents?: number;
+    currency?: string;
+    recurring_interval?: RecurringInterval;
+    category?: string;
+    is_active?: boolean;
+    extra_data?: ProductExtraData;
+}
+
+/** Admin Feature — corresponds to the Feature entity in the billing system */
+interface AdminFeature {
+    id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    icon: string | null;
+    category: string | null;
+    is_available: boolean;
+    billing_product_id: string | null;
+    default_config: JsonObject;
+    created_at: string;
+    updated_at: string;
+}
+interface AdminFeatureCreate {
+    slug: string;
+    name: string;
+    description?: string;
+    icon?: string;
+    category?: string;
+    is_available?: boolean;
+    billing_product_id?: string;
+    default_config?: JsonObject;
+}
+interface AdminFeatureUpdate {
+    name?: string;
+    description?: string;
+    icon?: string;
+    category?: string;
+    is_available?: boolean;
+    billing_product_id?: string;
+    default_config?: JsonObject;
+}
+interface AdminFeatureListResponse {
+    features: AdminFeature[];
+    total: number;
+}
+interface AdminFeatureFilters {
+    available_only?: boolean;
+    category?: string;
+}
+
+/**
+ * A generic fetcher function that consumer projects provide.
+ * It handles auth tokens, refresh, and base URL internally.
+ */
+type Fetcher = <T>(url: string, options?: RequestInit) => Promise<T>;
+interface BillingAdminClientConfig {
+    /** Base path for billing admin API (e.g., '/api/v1/billing-admin') */
+    basePath: string;
+    /** HTTP fetcher function provided by the host application */
+    fetcher: Fetcher;
+}
+declare class BillingAdminApiClient {
+    private basePath;
+    private fetcher;
+    constructor(config: BillingAdminClientConfig);
+    private url;
+    getPlans(params?: {
+        is_active?: boolean;
+    }): Promise<PaginatedResponse<AdminPlan>>;
+    getPlan(planId: string): Promise<AdminPlan>;
+    createPlan(data: AdminPlanCreate): Promise<AdminPlan>;
+    updatePlan(planId: string, data: AdminPlanUpdate): Promise<AdminPlan>;
+    deletePlan(planId: string): Promise<void>;
+    syncPlanToStripe(planId: string): Promise<AdminPlan>;
+    getSubscriptions(params?: {
+        status?: AdminSubscriptionStatus;
+        search?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<AdminSubscription>>;
+    getSubscription(subscriptionId: string): Promise<AdminSubscription>;
+    cancelSubscription(subscriptionId: string, atPeriodEnd?: boolean): Promise<AdminSubscription>;
+    createSubscription(data: AdminSubscriptionCreate): Promise<AdminSubscription>;
+    changeSubscriptionPlan(subscriptionId: string, newPlanSlug: string): Promise<void>;
+    getPayments(params?: {
+        status?: AdminPaymentStatus | string;
+        search?: string;
+        limit?: number;
+        starting_after?: string;
+    }): Promise<CursorPaginatedResponse<AdminPayment>>;
+    getPayment(paymentId: string): Promise<AdminPayment>;
+    refundPayment(paymentId: string, params?: {
+        amount?: number;
+        reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer';
+    }): Promise<AdminPaymentRefund>;
+    getInvoices(params?: {
+        status?: string;
+        search?: string;
+        store_id?: string;
+        limit?: number;
+        starting_after?: string;
+    }): Promise<CursorPaginatedResponse<AdminInvoice>>;
+    getInvoice(invoiceId: string): Promise<AdminInvoice>;
+    sendInvoice(invoiceId: string): Promise<AdminInvoice>;
+    voidInvoice(invoiceId: string): Promise<AdminInvoice>;
+    getProducts(params?: {
+        is_active?: boolean;
+    }): Promise<PaginatedResponse<AdminProduct>>;
+    getProduct(productId: string): Promise<AdminProduct>;
+    createProduct(data: AdminProductCreate): Promise<AdminProduct>;
+    updateProduct(productId: string, data: AdminProductUpdate): Promise<AdminProduct>;
+    deleteProduct(productId: string): Promise<void>;
+    syncProductToStripe(productId: string): Promise<AdminProduct>;
+    getFeatures(params?: AdminFeatureFilters): Promise<AdminFeatureListResponse>;
+    getAvailableFeatures(category?: string): Promise<AdminFeatureListResponse>;
+    getFeature(featureId: string): Promise<AdminFeature>;
+    createFeature(data: AdminFeatureCreate): Promise<AdminFeature>;
+    updateFeature(featureId: string, data: AdminFeatureUpdate): Promise<AdminFeature>;
+    deleteFeature(featureId: string): Promise<void>;
+    getClientInfo(): Promise<{
+        client_id: string | null;
+    }>;
+}
+/**
+ * Factory function to create a BillingAdminApiClient instance.
+ */
+declare function createBillingAdminClient(config: BillingAdminClientConfig): BillingAdminApiClient;
+
+declare const BillingAdminClientContext: react.Context<BillingAdminApiClient | null>;
+declare function useBillingAdminClient(): BillingAdminApiClient;
+
+/**
+ * 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 useAdminPlans(params?: {
+    is_active?: boolean;
+}): _tanstack_react_query.UseQueryResult<PaginatedResponse<AdminPlan>, Error>;
+declare function useCreatePlan(): _tanstack_react_query.UseMutationResult<AdminPlan, Error, AdminPlanCreate, unknown>;
+declare function useUpdatePlan(): _tanstack_react_query.UseMutationResult<AdminPlan, Error, {
+    id: string;
+    data: AdminPlanUpdate;
+}, unknown>;
+declare function useDeletePlan(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+declare function useSyncPlanToStripe(): _tanstack_react_query.UseMutationResult<AdminPlan, Error, string, unknown>;
+
+declare function useAdminSubscriptions(params?: {
+    status?: AdminSubscriptionStatus;
+    search?: string;
+    limit?: number;
+    offset?: number;
+}): _tanstack_react_query.UseQueryResult<PaginatedResponse<AdminSubscription>, Error>;
+declare function useCreateSubscription(): _tanstack_react_query.UseMutationResult<AdminSubscription, Error, AdminSubscriptionCreate, unknown>;
+declare function useCancelSubscription(): _tanstack_react_query.UseMutationResult<AdminSubscription, Error, {
+    id: string;
+    atPeriodEnd: boolean;
+}, unknown>;
+declare function useChangeSubscriptionPlan(): _tanstack_react_query.UseMutationResult<void, Error, {
+    id: string;
+    newPlanSlug: string;
+}, unknown>;
+
+declare function useAdminPayments(params?: {
+    status?: string;
+    search?: string;
+    limit?: number;
+    starting_after?: string;
+}): _tanstack_react_query.UseQueryResult<CursorPaginatedResponse<AdminPayment>, Error>;
+declare function useRefundPayment(): _tanstack_react_query.UseMutationResult<AdminPaymentRefund, Error, {
+    id: string;
+    amount?: number;
+    reason?: "duplicate" | "fraudulent" | "requested_by_customer";
+}, unknown>;
+
+declare function useAdminInvoices(params?: {
+    status?: string;
+    search?: string;
+    store_id?: string;
+    limit?: number;
+    starting_after?: string;
+}): _tanstack_react_query.UseQueryResult<CursorPaginatedResponse<AdminInvoice>, Error>;
+declare function useSendInvoice(): _tanstack_react_query.UseMutationResult<AdminInvoice, Error, string, unknown>;
+declare function useVoidInvoice(): _tanstack_react_query.UseMutationResult<AdminInvoice, Error, string, unknown>;
+
+declare function useAdminProducts(params?: {
+    is_active?: boolean;
+}): _tanstack_react_query.UseQueryResult<PaginatedResponse<AdminProduct>, Error>;
+declare function useCreateProduct(): _tanstack_react_query.UseMutationResult<AdminProduct, Error, AdminProductCreate, unknown>;
+declare function useUpdateProduct(): _tanstack_react_query.UseMutationResult<AdminProduct, Error, {
+    id: string;
+    data: AdminProductUpdate;
+}, unknown>;
+declare function useDeleteProduct(): _tanstack_react_query.UseMutationResult<void, Error, string, unknown>;
+declare function useSyncProductToStripe(): _tanstack_react_query.UseMutationResult<AdminProduct, Error, string, unknown>;
+
+declare function useAdminFeatures(params?: AdminFeatureFilters): _tanstack_react_query.UseQueryResult<AdminFeatureListResponse, Error>;
+declare function useAvailableFeatures(category?: string): _tanstack_react_query.UseQueryResult<AdminFeatureListResponse, Error>;
+declare function useCreateFeature(): _tanstack_react_query.UseMutationResult<AdminFeature, Error, AdminFeatureCreate, unknown>;
+declare function useUpdateFeature(): _tanstack_react_query.UseMutationResult<AdminFeature, Error, {
+    id: string;
+    data: AdminFeatureUpdate;
+}, unknown>;
+declare function useDeleteFeature(): _tanstack_react_query.UseMutationResult<void, Error, string, 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 subscriptionStatusColors: Record<AdminSubscriptionStatus, string>;
+declare const subscriptionStatusLabels: Record<AdminSubscriptionStatus, string>;
+declare const paymentStatusColors: Record<AdminPaymentStatus, string>;
+declare const paymentStatusLabels: Record<AdminPaymentStatus, string>;
+declare const invoiceStatusColors: Record<AdminInvoiceStatus, string>;
+declare const invoiceStatusLabels: Record<AdminInvoiceStatus, 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;
+
+export { type AdminFeature, type AdminFeatureCreate, type AdminFeatureFilters, type AdminFeatureListResponse, type AdminFeatureUpdate, type AdminInvoice, type AdminInvoiceLineItem, type AdminInvoiceStatus, type AdminPayment, type AdminPaymentRefund, type AdminPaymentStatus, type AdminPlan, type AdminPlanCreate, type AdminPlanPricingModel, type AdminPlanUpdate, type AdminProduct, type AdminProductCreate, type AdminProductUpdate, type AdminSubscription, type AdminSubscriptionCreate, type AdminSubscriptionStatus, BillingAdminApiClient, type BillingAdminClientConfig, BillingAdminClientContext, type CursorPaginatedResponse, type Fetcher, type JsonArray, type JsonObject, type JsonPrimitive, type JsonValue, type PaginatedResponse, type ProductExtraData, type RecurringInterval, type RefundStatus, createBillingAdminClient, formatCurrency, formatCurrencyFromCents, formatDate, formatPrice, formatTimestamp, invoiceStatusColors, invoiceStatusLabels, paymentStatusColors, paymentStatusLabels, subscriptionStatusColors, subscriptionStatusLabels, truncateId, useAdminFeatures, useAdminInvoices, useAdminPayments, useAdminPlans, useAdminProducts, useAdminSubscriptions, useAvailableFeatures, useBillingAdminClient, useCancelSubscription, useChangeSubscriptionPlan, useCreateFeature, useCreatePlan, useCreateProduct, useCreateSubscription, useDeleteFeature, useDeletePlan, useDeleteProduct, useDialogState, useRefundPayment, useSendInvoice, useSyncPlanToStripe, useSyncProductToStripe, useUpdateFeature, useUpdatePlan, useUpdateProduct, useVoidInvoice, validateRequired, validateSlug };