react-autoql 8.31.0 → 8.32.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-autoql",
-  "version": "8.31.0",
+  "version": "8.32.0",
   "description": "React Widget Library",
   "main": "dist/autoql.cjs.js",
   "module": "dist/autoql.esm.js",
@@ -33,7 +33,7 @@
     "test:coverage": "npm test -- --coverage",
     "test:badges": "npm run test:coverage  && npx make-coverage-badge --output-path ./public/badge.svg",
     "test:staged": "cross-env NODE_OPTIONS= jest --findRelatedTests",
-    "build": "cross-env NODE_OPTIONS=--experimental-global-webcrypto rollup -c",
+    "build": "rollup -c",
     "lint": "eslint src/**/*.js",
     "lint:fix": "eslint --fix 'src/**/*.js'",
     "format": "prettier --write 'src/**/*.{js,css,md,json}' --config ./.prettierrc",

package/src/index.d.ts

@@ -1,15 +1,164 @@
 import * as React from 'react'
+import type { Authentication } from 'autoql-fe-utils'
 
 export * from 'autoql-fe-utils'
 
-// ─── Shared config interfaces ────────────────────────────────────────────────
+export type BillingQuotaStatus = 'no_quota' | 'under_quota' | 'at_or_over_quota'
+
+export type BillingCustomerKeyState = 'idle' | 'loading' | 'success' | 'missing_customer' | 'error'
+
+export type BillingUsageState = 'idle' | 'loading' | 'success' | 'missing_customer' | 'unavailable' | 'error'
+
+export type BillingHistoryState = 'idle' | 'loading' | 'success' | 'unavailable' | 'error'
+
+export interface BillingCustomerScope {
+  scope_type?: string
+  scope_id?: string
+}
+
+export type BillingExecutionType = 'STRIPE' | 'EXPORT'
+
+export interface BillingCustomerKeyResponse {
+  billing_customer_key: string
+  scope?: BillingCustomerScope | null
+  billing_execution_type?: BillingExecutionType
+}
+
+export interface BillingCurrentUsage {
+  integrator_id: number
+  billing_customer_key: string
+  billing_period: string
+  usage_to_date_micros: number
+  free_allowance_micros: number
+  allowance_applied_to_date_micros: number
+  allowance_remaining_micros: number
+  estimated_billable_usage_micros: number
+  active_monthly_quota_micros: number | null
+  pending_monthly_quota_micros: number | null
+  pending_effective_billing_period: string | null
+  remaining_quota_micros: number | null
+  quota_status: BillingQuotaStatus
+}
+
+export interface BillingHistoryItem {
+  billing_period: string
+  usage_to_date_micros: number
+  quota_projection_label: 'current_quota_projection'
+  current_quota_projection_monthly_micros?: number | null
+  current_quota_projection_status: BillingQuotaStatus
+}
+
+export interface BillingQuotaUpdateResponse {
+  integrator_id: number
+  billing_customer_key: string
+  currency: string
+  active_monthly_quota_micros: number | null
+  active_effective_billing_period: string | null
+  pending_monthly_quota_micros: number | null
+  pending_effective_billing_period: string | null
+  current_billing_period: string
+  current_period_usage_micros: number
+  upsert_result: 'created' | 'updated' | 'noop'
+  effective_update_mode: 'immediate' | 'scheduled' | 'none'
+  updated_by?: string | null
+  updated_by_type?: string | null
+}
+
+export interface UseBillingCustomerKeyArgs {
+  authentication: Authentication
+}
+
+export interface UseBillingCustomerKeyResult {
+  billingCustomerKey: string | null
+  data: BillingCustomerKeyResponse | null
+  scope: BillingCustomerScope | null
+  state: BillingCustomerKeyState
+}
+
+export interface UseBillingUsageArgs {
+  authentication: Authentication
+  billingCustomerKey?: string | null
+  refreshKey?: number
+}
+
+export interface UseBillingUsageResult {
+  data: BillingCurrentUsage | null
+  state: BillingUsageState
+}
 
-export interface Authentication {
-  token?: string
-  apiKey?: string
-  domain?: string
+export interface UseBillingHistoryArgs {
+  authentication: Authentication
+  billingCustomerKey?: string | null
+  from?: string
+  to?: string
 }
 
+export interface UseBillingHistoryResult {
+  items: BillingHistoryItem[]
+  state: BillingHistoryState
+}
+
+export interface UseBillingQuotaUpdateArgs {
+  authentication: Authentication
+  billingCustomerKey?: string | null
+}
+
+export interface UseBillingQuotaUpdateResult {
+  isSaving: boolean
+  updateQuota: (monthlyQuotaMicros: number) => Promise<BillingQuotaUpdateResponse>
+}
+
+export declare function useBillingCustomerKey(args: UseBillingCustomerKeyArgs): UseBillingCustomerKeyResult
+export declare function useBillingUsage(args: UseBillingUsageArgs): UseBillingUsageResult
+export declare function useBillingHistory(args: UseBillingHistoryArgs): UseBillingHistoryResult
+export declare function useBillingQuotaUpdate(args: UseBillingQuotaUpdateArgs): UseBillingQuotaUpdateResult
+
+export type MagicWandBillingGateState = 'over_quota' | 'unavailable' | null
+
+export interface UseMagicWandBillingGateArgs {
+  authentication?: Authentication
+  enabled?: boolean
+}
+
+export interface UseMagicWandBillingGateResult {
+  quotaStatus?: BillingQuotaStatus
+  billingExecutionType?: BillingExecutionType
+}
+
+export declare function useMagicWandBillingGate(
+  args?: UseMagicWandBillingGateArgs,
+): UseMagicWandBillingGateResult
+
+export declare function getMagicWandBillingErrorState(error: any): MagicWandBillingGateState
+
+export declare const MAGIC_WAND_BILLING_GATE_MESSAGES: {
+  over_quota: string
+  over_quota_summary: string
+  unavailable: string
+}
+
+// Broadcasts to every mounted useMagicWandBillingGate instance that billing usage may have
+// changed (e.g. call this after a quota-increase flow completes) so proactive blocking clears
+// without waiting for a remount.
+export declare function refreshBillingUsage(): void
+
+export declare function formatMicrosAsCurrency(
+  micros?: number | null,
+  emptyLabel?: string,
+  currency?: string,
+  locale?: string,
+): string
+export declare function microsFromCurrencyInput(value: string): number | null
+export declare function currencyInputFromMicros(micros?: number | null, currency?: string): string
+export declare function formatBillingPeriod(period?: string | null): string
+export declare function getDefaultBillingHistoryRange(): { from: string; to: string }
+
+export declare function getStoredBillingCustomerKey(apiKey?: string): string | null
+export declare function setStoredBillingCustomerKey(billingCustomerKey: string, apiKey?: string): void
+export declare function clearStoredBillingCustomerKey(apiKey?: string): void
+
+// ─── Shared config interfaces ────────────────────────────────────────────────
+
 export interface AutoQLConfig {
   translation?: string
   test?: boolean
@@ -91,6 +240,8 @@ export interface DashboardProps {
   enableCyclicalDates?: boolean
   enableMagicWand?: boolean
   showMagicWandQuoteButton?: boolean
+  enableBillingGate?: boolean
+  onQuotaExceeded?: () => void
   enableCustomColumns?: boolean
   preferRegularTableInitialDisplayType?: boolean
   source?: string | string[]
@@ -139,6 +290,8 @@ export interface DataMessengerProps {
   disableColumnSelectionForDataExplorer?: boolean
   enableMagicWand?: boolean
   showMagicWandQuoteButton?: boolean
+  enableBillingGate?: boolean
+  onQuotaExceeded?: () => void
   enableCyclicalDates?: boolean
   projectSelectList?: Array<{ projectId: string; displayName: string }>
   selectedProjectId?: string