@hailer/app-sdk 2.0.0-beta-7 → 2.0.0-beta-9

package/lib/types.d.ts

@@ -457,4 +457,551 @@ export interface Version {
     packageHash: string;
     created: number;
 }
+export interface PricingPlan {
+    planId: 'monthly' | 'yearly' | 'one_time';
+    label: string;
+    price: number;
+    currency: string;
+    interval: 'month' | 'year' | null;
+}
+export interface PaymentProvider {
+    priceId?: {
+        monthly?: string;
+        yearly?: string;
+        one_time?: string;
+    };
+    trial_days?: number;
+}
+export interface PricingProviders {
+    stripe?: PaymentProvider;
+    paddle?: PaymentProvider;
+}
+export interface PricingData {
+    _id?: string;
+    productId?: string;
+    types: PricingPlan[];
+    providers: PricingProviders;
+    paymentEnabled?: boolean;
+    created?: number;
+    updated?: number;
+}
+export interface CreatePricingRequest {
+    productId: string;
+    types: PricingPlan[];
+    providers: PricingProviders;
+    paymentEnabled?: boolean;
+}
+export interface UpdatePricingRequest {
+    productId: string;
+    types: PricingPlan[];
+    providers: PricingProviders;
+    paymentEnabled?: boolean;
+}
+export interface CreatePurchaseRequest {
+    productId: string;
+    workspaceId: string;
+    planType: 'monthly' | 'yearly' | 'one_time';
+    successUrl?: string;
+    cancelUrl?: string;
+    useTokens?: boolean;
+}
+export interface CreatePurchaseResponse {
+    status: 'installed_free' | 'subscription_created' | 'checkout_required' | 'payment_processed' | 'payment_failed';
+    message?: string;
+    productId?: string;
+    planType?: string;
+    purchaseId?: string;
+    subscriptionId?: string;
+    provider?: string;
+    trialDays?: number;
+    checkoutUrl?: string;
+    error?: string;
+}
+export interface Purchase {
+    _id: string;
+    uid: string;
+    cid: string;
+    productId?: string;
+    productName?: string;
+    provider?: 'stripe' | 'paddle' | 'fuze';
+    type: 'monthly' | 'yearly' | 'one_time';
+    purchaseType: 'workspace' | 'product';
+    startedAt: number;
+    created: number;
+    updated?: number;
+    customStatus?: string;
+    expiresAt?: number;
+    trialDays?: number;
+    trialStart?: number;
+    trialEnd?: number;
+    pricePaid?: {
+        amount: number;
+        currency: string;
+    };
+    pricing?: {
+        amount: number;
+        currency: string;
+        interval: string;
+        source: string;
+    };
+    stripe?: {
+        customerId?: string;
+        checkoutSessionId?: string;
+        subscriptionId?: string;
+        paymentIntentId?: string;
+        status?: string;
+    };
+    paddle?: {
+        customerId?: string;
+        subscriptionId?: string;
+        status?: string;
+    };
+    fuze?: {
+        customerId?: string;
+        subscriptionId?: string;
+        status?: string;
+    };
+}
+export interface AdminWorkspaceListItem {
+    _id: string;
+    name: string;
+    memberCount: number;
+    created: number;
+    updated?: number;
+    paymentPlan?: string;
+    monthlyPrice?: number;
+    paymentMethod?: 'subscription' | 'invoice';
+    subscriptionActive?: boolean;
+    provider?: string;
+    stripeStatus?: string;
+    hasPendingSubscription?: boolean;
+    tokenBalance?: number;
+    autoReloadEnabled?: boolean;
+}
+export interface AdminWorkspaceListRequest {
+    filter?: {
+        name?: string;
+    };
+    options?: {
+        search?: string;
+        sortBy?: string;
+        sortOrder?: string;
+        limit?: number;
+        skip?: number;
+    };
+}
+export interface AdminWorkspaceListResponse {
+    workspaces: AdminWorkspaceListItem[];
+    totalCount: number;
+}
+export interface AdminPurchaseData {
+    _id: string;
+    uid: string;
+    cid: string;
+    productId?: string | null;
+    productName?: string | null;
+    provider?: string;
+    type: string;
+    purchaseType: 'workspace' | 'product';
+    billingType?: 'subscription' | 'invoice';
+    planName?: 'flexible' | 'pro' | 'business' | 'enterprise';
+    startedAt?: number;
+    expiresAt?: number;
+    created: number;
+    updated?: number;
+    customStatus?: string;
+    trialStart?: number;
+    trialEnd?: number;
+    pricePaid?: {
+        amount: number;
+        currency: string;
+    };
+    pricing?: {
+        amount: number;
+        currency: string;
+        interval?: string;
+        source: 'purchase_record' | 'pricing_collection';
+    };
+    availablePricing?: Array<{
+        planId: 'monthly' | 'yearly' | 'one_time';
+        label: string;
+        price: number;
+        currency: string;
+        interval: string | null;
+    }>;
+    trialDays?: number;
+    stripe?: {
+        customerId?: string;
+        checkoutSessionId?: string;
+        subscriptionId?: string;
+        paymentIntentId?: string;
+        status?: string;
+    };
+    paddle?: {
+        customerId?: string;
+        subscriptionId?: string;
+        status?: string;
+    };
+    fuze?: {
+        customerId?: string;
+        subscriptionId?: string;
+        status?: string;
+    };
+}
+export interface AdminWorkspaceOverrides {
+    public?: boolean;
+    tableEdit?: boolean;
+    restricted?: boolean;
+    isolatedTeams?: boolean;
+    insight?: boolean;
+    groups?: boolean;
+    customRoles?: boolean;
+    activityRecovery?: boolean;
+    fastFunctions?: boolean;
+}
+export interface AdminWorkspaceMarketplaceSettings {
+    creatorPercent: number;
+}
+export interface AdminWorkspace extends AdminWorkspaceListItem {
+    purchaseId?: string;
+    purchases?: AdminPurchaseData[];
+    overrides?: AdminWorkspaceOverrides;
+    marketplace?: AdminWorkspaceMarketplaceSettings;
+}
+export interface AdminUpdateOverridesRequest {
+    workspaceId: string;
+    overrides: AdminWorkspaceOverrides;
+}
+export interface AdminUpdateMarketplaceSettingsRequest {
+    workspaceId: string;
+    creatorPercent: number;
+}
+export interface AdminCreateStripeSessionRequest {
+    workspaceId: string;
+    planName: 'flexible' | 'pro' | 'business' | 'enterprise';
+    customPrice: number;
+    paymentMethod: 'stripe';
+    baseUrl: string;
+}
+export interface AdminCreateStripeSessionResponse {
+    success: boolean;
+    message: string;
+    sessionUrl?: string;
+}
+export interface AdminCreateInvoiceIntegrationRequest {
+    workspaceId: string;
+    planName: 'enterprise';
+    customPrice: number;
+    paymentMethod: 'hailer';
+}
+export interface AdminCreateInvoiceIntegrationResponse {
+    success: boolean;
+    message: string;
+}
+export interface AdminUpdateWorkspaceSubscriptionRequest {
+    purchaseId: string;
+    billingType: 'subscription' | 'invoice';
+    customPrice: number;
+    planName: 'flexible' | 'pro' | 'business' | 'enterprise';
+    tokenAmount?: number;
+}
+export interface AdminUpdatePurchasePriceRequest {
+    purchaseId: string;
+    workspaceId: string;
+    newPrice: number;
+}
+export interface AdminWorkspaceUser {
+    _id: string;
+    name: string;
+    email: string;
+    role: 'owner' | 'admin' | 'user' | 'guest' | 'inviter';
+    joined?: number;
+    lastActive?: number;
+    emailVerified?: boolean;
+}
+export interface AdminWorkspaceUsersListRequest {
+    workspaceId?: string;
+    filter?: {
+        email?: string;
+        role?: string;
+    };
+    options?: {
+        search?: string;
+        sortBy?: string;
+        sortOrder?: string;
+        limit?: number;
+        skip?: number;
+    };
+}
+export interface AdminWorkspaceUsersListResponse {
+    users: AdminWorkspaceUser[];
+    totalCount: number;
+}
+export interface AdminUpdateUserRequest {
+    userId: string;
+    updates: {
+        emailVerified?: boolean;
+    };
+}
+export interface AdminUpdateUserResponse {
+    success: boolean;
+}
+export interface AdminUpdateTokenBalanceRequest {
+    workspaceId: string;
+    tokenAmount: number;
+    payoutType?: 'admin_bonus' | 'creator_payout';
+    payoutMonth?: number;
+    payoutYear?: number;
+    creatorPercent?: number;
+}
+export interface AdminTokenTransaction {
+    _id: string;
+    uid: string;
+    cid: string;
+    workspaceName: string;
+    created: number;
+    type: 'purchase' | 'deduction' | 'bonus' | 'admin_adjustment' | 'creator_payout';
+    amount: number;
+    reason: string;
+    meta?: {
+        payoutMonth?: number;
+        payoutYear?: number;
+        creatorProfit?: number;
+        creatorPercent?: number;
+        [key: string]: any;
+    };
+    createdAt: number;
+}
+export interface AdminTokenTransactionFilter {
+    workspaceId?: string;
+    type?: 'purchase' | 'deduction' | 'bonus' | 'admin_adjustment' | 'creator_payout';
+    operation?: string;
+    dateFrom?: number;
+    dateTo?: number;
+    search?: string;
+}
+export interface AdminTokenTransactionStatistics {
+    netChange: number;
+    totalPurchases: number;
+    totalPurchasesEuro: number;
+    purchasesBySource: {
+        stripe: {
+            count: number;
+            tokens: number;
+            revenue: number;
+        };
+        adminPortal: {
+            count: number;
+            tokens: number;
+            revenue: number;
+        };
+    };
+    totalDeductions: number;
+    totalDeductionsEuro: number;
+    consumptionByOperation: {
+        [operation: string]: {
+            count: number;
+            tokens: number;
+        };
+    };
+    totalBonuses: number;
+    totalBonusesEuro: number;
+    totalCreatorPayouts: number;
+    totalCreatorPayoutsEuro: number;
+    totalRefunds: number;
+    totalRefundsEuro: number;
+}
+export interface AdminTokenTransactionsListRequest {
+    filter?: AdminTokenTransactionFilter;
+    options?: {
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+        limit?: number;
+        skip?: number;
+    };
+}
+export interface AdminTokenTransactionsListResponse {
+    transactions: AdminTokenTransaction[];
+    totalCount: number;
+    statistics: AdminTokenTransactionStatistics;
+}
+export interface AdminInvoicePurchase {
+    _id: string;
+    uid: string;
+    cid: string;
+    workspaceName: string;
+    created: number;
+    purchaseType: 'workspace' | 'product';
+    type: 'monthly' | 'yearly' | 'one_time';
+    provider: 'hailer';
+    billingType: 'invoice';
+    planName?: string;
+    productId?: string;
+    productName?: string;
+    pricePaid?: {
+        amount: number;
+        currency: string;
+    };
+    customStatus?: string;
+    invoiceHandled?: boolean;
+    startedAt: number;
+    expiresAt?: number;
+    trialStart?: number;
+    trialEnd?: number;
+}
+export interface AdminInvoiceListRequest {
+    filter?: {
+        workspaceId?: string;
+        purchaseType?: 'workspace' | 'product';
+        status?: 'handled' | 'unhandled' | 'all';
+        search?: string;
+    };
+    options?: {
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+        limit?: number;
+        skip?: number;
+    };
+}
+export interface AdminInvoiceWorkspaceGroup {
+    cid: string;
+    workspaceName: string;
+    allHandled: boolean;
+    purchases: AdminInvoicePurchase[];
+}
+export interface AdminInvoiceListResponse {
+    invoices: AdminInvoicePurchase[];
+    totalCount: number;
+    workspaceGroups: AdminInvoiceWorkspaceGroup[];
+}
+export interface AdminInvoiceUpdateHandledRequest {
+    purchaseIds: string | string[];
+    handled: boolean;
+}
+export interface AdminInvoiceUpdateHandledResponse {
+    updatedCount: number;
+}
+export interface AdminRevenuePurchase {
+    _id: string;
+    uid: string;
+    cid: string;
+    workspaceName: string;
+    created: number;
+    purchaseType: 'workspace' | 'product';
+    type: 'monthly' | 'yearly' | 'one_time';
+    provider: string;
+    productId?: string;
+    productName?: string;
+    productOwnerCid?: string;
+    productOwnerName?: string;
+    pricePaid?: {
+        amount: number;
+        currency: string;
+    };
+    startedAt: number;
+    expiresAt?: number;
+    normalizedMonthlyRevenue: number;
+    isMarketplace: boolean;
+    profitToHailer: number;
+    profitToCreator?: number;
+    statusInMonth: 'active' | 'started' | 'ended';
+}
+export interface AdminRevenueWorkspaceGroup {
+    cid: string;
+    workspaceName: string;
+    totalRevenue: number;
+    totalMRR: number;
+    totalOneTime: number;
+    totalCreatorProfit: number;
+    totalHailerProfit: number;
+    creatorPercent: number;
+    productCount: number;
+    paidOut?: boolean;
+    productBreakdown: Array<{
+        productId: string;
+        productName: string;
+        installationCount: number;
+        totalRevenue: number;
+        subscriptionTypes: {
+            monthly: number;
+            yearly: number;
+            one_time: number;
+        };
+        installedBy: Array<{
+            cid: string;
+            workspaceName: string;
+            type: string;
+        }>;
+    }>;
+    purchases: AdminRevenuePurchase[];
+}
+export interface AdminRevenueWorkspaceSubscriptions {
+    totalWorkspaces: number;
+    totalRevenue: number;
+    byPlan: Array<{
+        planName: string;
+        count: number;
+        revenue: number;
+    }>;
+}
+export interface AdminRevenueStatistics {
+    selectedMonth: {
+        month: number;
+        year: number;
+    };
+    totalMRR: number;
+    totalOneTime: number;
+    totalRevenue: number;
+    activeCount: number;
+    hailerProfit: number;
+    creatorProfit: number;
+}
+export interface AdminRevenueListRequest {
+    month: number;
+    year: number;
+    filter?: {
+        workspaceId?: string;
+        purchaseType?: 'workspace' | 'product';
+        subscriptionType?: 'monthly' | 'yearly' | 'one_time';
+        search?: string;
+    };
+    options?: {
+        sortBy?: string;
+        sortOrder?: 'asc' | 'desc';
+        limit?: number;
+        skip?: number;
+    };
+}
+export interface AdminRevenueListResponse {
+    purchases: AdminRevenuePurchase[];
+    totalCount: number;
+    workspaceGroups: AdminRevenueWorkspaceGroup[];
+    statistics: AdminRevenueStatistics;
+}
+export interface StripeTaxLineItem {
+    amount: number;
+    reference: string;
+    tax_code?: string;
+    quantity?: number;
+}
+export interface StripeTaxCalculationRequest {
+    workspaceId: string;
+    lineItems: StripeTaxLineItem[];
+}
+export interface StripeTaxLineItemResult {
+    reference: string;
+    amount: number;
+    taxAmount: number;
+    totalAmount: number;
+}
+export interface StripeTaxCalculationResponse {
+    amountSubtotal: number;
+    amountTax: number;
+    amountTotal: number;
+    taxRate?: number;
+    country?: string;
+    countryName?: string;
+    currency: string;
+    lineItems: StripeTaxLineItemResult[];
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hailer/app-sdk",
-    "version": "2.0.0-beta-7",
+    "version": "2.0.0-beta-9",
     "description": "SDK for building Hailer Apps",
     "author": "",
     "license": "ISC",