@tinkerlandai/indiana-react-native 0.0.0-stage → 0.6.3

package/dist/index.d.ts

@@ -0,0 +1,379 @@
+import { z } from 'zod';
+
+declare const scopeSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    environment: z.ZodEnum<{
+        sandbox: "sandbox";
+        live: "live";
+    }>;
+}, z.core.$strict>;
+type Scope = z.infer<typeof scopeSchema>;
+
+declare const errorRecoverySchema: z.ZodEnum<{
+    fix_request: "fix_request";
+    authenticate: "authenticate";
+    check_permissions: "check_permissions";
+    check_scope: "check_scope";
+    resolve_conflict: "resolve_conflict";
+    reload_state: "reload_state";
+    retry_same_request: "retry_same_request";
+    configure_integration: "configure_integration";
+    check_availability: "check_availability";
+    upgrade_sdk: "upgrade_sdk";
+    recover_operation: "recover_operation";
+    contact_support: "contact_support";
+}>;
+type ErrorRecovery = z.infer<typeof errorRecoverySchema>;
+/** Safe business reasons; never SQL text, resource IDs or provider responses. */
+declare const errorReasonSchema: z.ZodEnum<{
+    CAPABILITY_NOT_ENABLED: "CAPABILITY_NOT_ENABLED";
+    INTEGRATION_MISSING: "INTEGRATION_MISSING";
+    PROVIDER_CREDENTIAL_REJECTED: "PROVIDER_CREDENTIAL_REJECTED";
+    PRICE_BINDING_REQUIRED: "PRICE_BINDING_REQUIRED";
+    IDEMPOTENCY_CONFLICT: "IDEMPOTENCY_CONFLICT";
+    RESULT_UNKNOWN: "RESULT_UNKNOWN";
+    STATE_CHANGED: "STATE_CHANGED";
+    OPERATION_IN_PROGRESS: "OPERATION_IN_PROGRESS";
+    FUNNEL_VERSION_RETIRED: "FUNNEL_VERSION_RETIRED";
+}>;
+type ErrorReason = z.infer<typeof errorReasonSchema>;
+
+declare class IndianaError extends Error {
+    readonly code: string;
+    readonly status?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly retryable: boolean;
+    readonly recovery: ErrorRecovery;
+    readonly retryAfterSeconds?: number;
+    readonly reason?: ErrorReason;
+    constructor(code: string, message: string, status?: number | undefined, requestId?: string | undefined, metadata?: {
+        retryable?: boolean;
+        recovery?: ErrorRecovery;
+        retryAfterSeconds?: number;
+        reason?: ErrorReason;
+    });
+}
+
+declare const usageCommandSchema: z.ZodUnion<readonly [z.ZodObject<{
+    eventName: z.ZodString;
+    quantity: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    properties: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>, z.ZodTransform<{
+        [k: string]: string;
+    }, Record<string, string | number | boolean>>>>;
+    entityId: z.ZodOptional<z.ZodUUID>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    internal_feature_id: z.ZodUUID;
+    quantity: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    properties: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>, z.ZodTransform<{
+        [k: string]: string;
+    }, Record<string, string | number | boolean>>>>;
+    entityId: z.ZodOptional<z.ZodUUID>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>]>;
+declare const usageResponseSchema: z.ZodObject<{
+    requestId: z.ZodUUID;
+    scope: z.ZodObject<{
+        projectId: z.ZodString;
+        environment: z.ZodEnum<{
+            sandbox: "sandbox";
+            live: "live";
+        }>;
+    }, z.core.$strict>;
+    receipts: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        internal_feature_id: z.ZodUUID;
+        kind: z.ZodEnum<{
+            consume: "consume";
+            reserve: "reserve";
+            confirm: "confirm";
+            refund: "refund";
+            release: "release";
+            expire: "expire";
+        }>;
+        originalId: z.ZodNullable<z.ZodUUID>;
+        quantity: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        requestedQuantity: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+        overageBehavior: z.ZodOptional<z.ZodEnum<{
+            cap: "cap";
+            overflow: "overflow";
+        }>>;
+        accepted: z.ZodBoolean;
+        reason: z.ZodNullable<z.ZodEnum<{
+            expired: "expired";
+            unavailable: "unavailable";
+            insufficient_balance: "insufficient_balance";
+            limit_exceeded: "limit_exceeded";
+            awaiting_topup: "awaiting_topup";
+            authorization_required: "authorization_required";
+            payment_blocked: "payment_blocked";
+            cash_budget_exceeded: "cash_budget_exceeded";
+        }>>;
+        createdAt: z.ZodISODateTime;
+        reservationStatus: z.ZodNullable<z.ZodEnum<{
+            expired: "expired";
+            pending: "pending";
+            confirmed: "confirmed";
+            released: "released";
+        }>>;
+        expiresAt: z.ZodNullable<z.ZodISODateTime>;
+        allocations: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            funding: z.ZodLiteral<"balance">;
+            sourceId: z.ZodUUID;
+            rolloverId: z.ZodNullable<z.ZodUUID>;
+            units: z.ZodString;
+            amount: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            funding: z.ZodLiteral<"unbilled">;
+            units: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            funding: z.ZodLiteral<"prepaid">;
+            sourceId: z.ZodUUID;
+            units: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+            amount: z.ZodString;
+            pricing: z.ZodArray<z.ZodObject<{
+                internal_credit_feature_id: z.ZodNullable<z.ZodUUID>;
+                internal_metered_feature_id: z.ZodUUID;
+                dimension: z.ZodString;
+                counterKey: z.ZodString;
+                cycleStart: z.ZodISODateTime;
+                unitCost: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+                units: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+                amount: z.ZodString;
+                tier: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>, z.ZodObject<{
+            funding: z.ZodLiteral<"postpaid">;
+            invoiceLineId: z.ZodNullable<z.ZodUUID>;
+            units: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+            authorizationId: z.ZodUUID;
+        }, z.core.$strict>], "funding">>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const entitlementInputSchema: z.ZodObject<{
+    requirement: z.ZodObject<{
+        internal_feature_id: z.ZodUUID;
+        quantity: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+        properties: z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>, z.ZodTransform<{
+            [k: string]: string;
+        }, Record<string, string | number | boolean>>>;
+        entityId: z.ZodOptional<z.ZodUUID>;
+    }, z.core.$strict>;
+    commerce: z.ZodOptional<z.ZodObject<{
+        provider: z.ZodEnum<{
+            apple: "apple";
+            google: "google";
+            stripe: "stripe";
+        }>;
+        currency: z.ZodEnum<{
+            USD: "USD";
+            EUR: "EUR";
+            CNY: "CNY";
+            GBP: "GBP";
+            JPY: "JPY";
+            CAD: "CAD";
+            AUD: "AUD";
+            NZD: "NZD";
+            CHF: "CHF";
+            HKD: "HKD";
+            SGD: "SGD";
+            KRW: "KRW";
+            INR: "INR";
+            BRL: "BRL";
+            MXN: "MXN";
+            TWD: "TWD";
+            THB: "THB";
+            IDR: "IDR";
+            MYR: "MYR";
+            PHP: "PHP";
+            VND: "VND";
+            ZAR: "ZAR";
+            AED: "AED";
+            SAR: "SAR";
+            SEK: "SEK";
+            NOK: "NOK";
+            DKK: "DKK";
+            PLN: "PLN";
+            CZK: "CZK";
+            HUF: "HUF";
+            ILS: "ILS";
+            TRY: "TRY";
+            RON: "RON";
+        }>;
+    }, z.core.$strict>>;
+    paywallId: z.ZodOptional<z.ZodUUID>;
+}, z.core.$strict>;
+type UsageCommand = z.input<typeof usageCommandSchema>;
+interface IndianaReactNativeOptions {
+    baseUrl?: string;
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+    scope: Scope;
+    /** Authenticate the app user on your backend and select its Customer there. No Indiana credential is passed to this callback. */
+    usageReporter?: (command: UsageCommand) => Promise<z.output<typeof usageResponseSchema>>;
+}
+/** React Native core APIs. No DOM, WebView, store SDK or server credential is required. */
+declare function createIndianaReactNative(options: IndianaReactNativeOptions): {
+    identify(customerToken: string): void;
+    reset(): void;
+    readHoldings(): Promise<{
+        requestId: string;
+        scope: {
+            projectId: string;
+            environment: "sandbox" | "live";
+        };
+        holdings: {
+            customerId: string;
+            snapshotAt: string;
+            memberships: {
+                id: string;
+                productId: string;
+                productVersionId: string;
+                billingProductVersionId: string;
+                version: number;
+                key: string;
+                name: string;
+                groupId: string | null;
+                membershipType: "main" | "addon";
+                status: "active" | "scheduled" | "expired" | "past_due" | "unknown" | "pending" | "trial" | "paused" | "ended" | "trialing";
+                cancelAtPeriodEnd: boolean;
+                accessEnabled: boolean;
+                renewalChange: {
+                    productVersionId: string;
+                    name: string;
+                    version: number;
+                    effectiveAt: string;
+                    benefitsAppliedAt: string | null;
+                    timing: "immediate" | "renewal";
+                    changeKind: "quantity" | "plan" | "seats";
+                    seat: {
+                        key: string;
+                        fromQuantity: number;
+                        toQuantity: number;
+                    } | null;
+                    status: "scheduled" | "pending" | "prepared" | "confirmed" | "quoted";
+                    feature?: {
+                        internal_feature_id: string;
+                        name: string;
+                        fromQuantity: number;
+                        toQuantity: number;
+                    } | undefined;
+                } | null;
+                period: {
+                    phase: "trial" | "paid";
+                    startsAt: string;
+                    endsAt: string | null;
+                } | null;
+            }[];
+            membershipsLimited: boolean;
+            balances: {
+                usageType: "consumable" | "non_consumable" | null;
+                accessible: boolean;
+                unlimited: boolean;
+                available: string;
+                held: string;
+                debt: string;
+                nextExpiresAt: string | null;
+                usage: {
+                    internal_feature_id: string;
+                    entityId: string | null;
+                    operationId: string | null;
+                    usage: string;
+                    capacity: string | null;
+                    remaining: string | null;
+                    withinLimit: boolean;
+                    revision: number;
+                    updatedAt: string | null;
+                } | null;
+                internal_feature_id: string;
+                key: string;
+                name: string;
+                kind: "metered" | "access" | "credit";
+            }[];
+            balancesLimited: boolean;
+        };
+    }>;
+    checkEntitlement(input: z.input<typeof entitlementInputSchema>): Promise<{
+        requestId: string;
+        scope: {
+            projectId: string;
+            environment: "sandbox" | "live";
+        };
+        check: {
+            internal_feature_id: string;
+            name: string;
+            kind: "metered" | "access" | "credit";
+            quantity: string;
+            allowed: boolean;
+            reason: "unavailable" | "insufficient_balance" | "limit_exceeded" | "awaiting_topup" | "authorization_required" | "payment_blocked" | "cash_budget_exceeded" | "not_entitled" | "capacity_exceeded" | "authentication_required" | null;
+            preview: {
+                scenario: "usage_limit" | "feature_flag";
+                candidates: {
+                    productId: string;
+                    productVersionId: string;
+                    name: string;
+                    action: "upgrade" | "purchase" | "addon" | "topup";
+                    membershipId: string | null;
+                    currency: "USD" | "EUR" | "CNY" | "GBP" | "JPY" | "CAD" | "AUD" | "NZD" | "CHF" | "HKD" | "SGD" | "KRW" | "INR" | "BRL" | "MXN" | "TWD" | "THB" | "IDR" | "MYR" | "PHP" | "VND" | "ZAR" | "AED" | "SAR" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "HUF" | "ILS" | "TRY" | "RON";
+                    amountMinor: string;
+                    interval: "week" | "month" | "year" | "free" | "one_time";
+                    intervalCount: number;
+                }[];
+            } | null;
+        };
+    }>;
+    trackUsage(command: UsageCommand): Promise<{
+        requestId: string;
+        scope: {
+            projectId: string;
+            environment: "sandbox" | "live";
+        };
+        receipts: {
+            id: string;
+            internal_feature_id: string;
+            kind: "consume" | "reserve" | "confirm" | "refund" | "release" | "expire";
+            originalId: string | null;
+            quantity: string;
+            accepted: boolean;
+            reason: "expired" | "unavailable" | "insufficient_balance" | "limit_exceeded" | "awaiting_topup" | "authorization_required" | "payment_blocked" | "cash_budget_exceeded" | null;
+            createdAt: string;
+            reservationStatus: "expired" | "pending" | "confirmed" | "released" | null;
+            expiresAt: string | null;
+            allocations: ({
+                funding: "prepaid";
+                sourceId: string;
+                units: string;
+                amount: string;
+                pricing: {
+                    internal_credit_feature_id: string | null;
+                    internal_metered_feature_id: string;
+                    dimension: string;
+                    counterKey: string;
+                    cycleStart: string;
+                    unitCost: string;
+                    units: string;
+                    amount: string;
+                    tier: number | null;
+                }[];
+            } | {
+                funding: "balance";
+                sourceId: string;
+                rolloverId: string | null;
+                units: string;
+                amount: string;
+            } | {
+                funding: "unbilled";
+                units: string;
+            } | {
+                funding: "postpaid";
+                invoiceLineId: string | null;
+                units: string;
+                authorizationId: string;
+            })[];
+            requestedQuantity?: string | undefined;
+            overageBehavior?: "cap" | "overflow" | undefined;
+        }[];
+    }>;
+};
+
+export { IndianaError, type IndianaReactNativeOptions, type UsageCommand, createIndianaReactNative };