@arcenpay/react 0.0.1 → 0.0.2

package/dist/{core-GECUTVXD.mjs → core-Y4UECIAE.mjs}

@@ -10087,8 +10087,8 @@ var init_appkit_core = __esm({
       }
       async injectModalUi() {
         if (!isInitialized && CoreHelperUtil.isClient()) {
-          await import("./basic-3OAVXLDO.mjs");
-          await import("./w3m-modal-LW2TBGRA.mjs");
+          await import("./basic-62X6SHFT.mjs");
+          await import("./w3m-modal-T32JFEZB.mjs");
           const isElementCreated = document.querySelector("w3m-modal");
           if (!isElementCreated) {
             const modal = document.createElement("w3m-modal");

package/dist/index.d.mts

@@ -1,7 +1,235 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { NetworkConfig, PlanTier, ContractAddresses, ComponentRenderData, ComponentDesign, ComponentElement, ArcenCompanyKeys, ArcenUserKeys, EntitlementSources, EntitlementFreshness, ConsumeEntitlementResult } from '@arcenpay/sdk';
-export { ArcenCompanyKeys, ArcenUserKeys, ComponentDesign, ComponentElement, ComponentRenderData, ConsumeEntitlementResult, EntitlementResult, FlagResult, IdentifyResult, InvoiceSummary, Plan } from '@arcenpay/sdk';
+
+interface Plan {
+    id: bigint;
+    provider: string;
+    name: string;
+    tier: PlanTier;
+    price: bigint;
+    billingInterval: number;
+    acceptedToken: string;
+    active: boolean;
+    metadataURI: string;
+}
+type PlanTier = "starter" | "pro" | "enterprise" | string;
+type EnvironmentMode = "DEVELOPMENT" | "PRODUCTION";
+interface InvoiceSummary {
+    id: string;
+    number?: string | null;
+    status: "DRAFT" | "ISSUED" | "PAID" | "VOID" | "OVERDUE";
+    currency: string;
+    customerEmail?: string | null;
+    customerWallet?: string | null;
+    subtotal: string;
+    taxTotal: string;
+    total: string;
+    issuedAt?: string | null;
+    dueAt?: string | null;
+    environmentMode: EnvironmentMode;
+}
+interface EntitlementSourceStatus {
+    enabled: boolean;
+    lastUpdatedAt: number | null;
+}
+interface EntitlementSources {
+    onChain: EntitlementSourceStatus;
+    tableland: EntitlementSourceStatus;
+    lit: EntitlementSourceStatus;
+}
+interface EntitlementFreshness {
+    resolvedAt: number | null;
+    staleAfterMs: number;
+}
+interface NetworkConfig {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    contracts: ContractAddresses;
+}
+interface ContractAddresses {
+    subscriptionRegistry: string;
+    autopayModule: string;
+    planFactory: string;
+    feeCollector: string;
+    sessionVault: string;
+    zkUsageVerifier: string;
+    mirrorRegistry?: string;
+    /** Optional ERC-4626 yield vault — set ARCENPAY_CONTRACT_<chainId>_yieldSessionVault to enable */
+    yieldSessionVault?: string;
+}
+interface ComponentEntitlement {
+    featureKey: string;
+    name: string;
+    value: boolean | string | number;
+    featureType?: "boolean" | "event_based" | "trait_based" | "credit";
+    limit?: number;
+    usage?: number;
+    exceeded?: boolean;
+    unitSingular?: string;
+    unitPlural?: string;
+}
+interface ComponentUsageItem {
+    featureKey: string;
+    name: string;
+    used: number;
+    limit?: number;
+    unitSingular: string | null;
+    unitPlural?: string | null;
+}
+interface ComponentPlanEntitlement {
+    featureName: string;
+    featureKey: string;
+    type: "BOOLEAN" | "NUMERIC" | "UNLIMITED";
+    value: boolean | number | null;
+    enabled: boolean;
+}
+interface ComponentPlanSummary {
+    id: string;
+    name: string;
+    price: string;
+    annualPrice?: string | null;
+    tier: string;
+    billingInterval: number;
+    acceptedToken?: string;
+    acceptedChainId?: number;
+    onChainPlanId?: string | null;
+    description?: string;
+    metadata?: {
+        entitlements?: ComponentPlanEntitlement[];
+        [key: string]: unknown;
+    } | null;
+}
+interface ComponentInvoiceSummary {
+    id: string;
+    number: string | null;
+    total: string;
+    currency: string;
+    status: string;
+    issuedAt: string | null;
+    dueAt?: string | null;
+    paidAt?: string | null;
+    customerEmail?: string | null;
+    customerWallet?: string | null;
+    downloadUrl?: string | null;
+}
+interface ComponentPaymentMethod {
+    walletAddress: string | null;
+    token: string | null;
+    chainId: number | null;
+}
+interface ComponentSubscriptionTransition {
+    mode?: string | null;
+    targetPlanId?: string | null;
+    targetPlanName?: string | null;
+    targetBillingPeriod?: "monthly" | "annual" | null;
+    previousPlanId?: string | null;
+    previousBillingPeriod?: "monthly" | "annual" | null;
+    requestedAt?: string | null;
+    effectiveAt?: string | null;
+    source?: string | null;
+}
+interface ComponentElement {
+    type: "planManager" | "meteredFeatures" | "includedFeatures" | "plansTable" | "nextBillDue" | "paymentMethod" | "invoices" | "unsubscribe" | "text" | "button" | string;
+    config?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface ComponentDesign {
+    primaryColor?: string;
+    secondaryColor?: string;
+    fontFamily?: string;
+    fontSize?: string | number;
+    cardStyle?: "minimal" | "bordered" | "elevated";
+    columns?: number;
+    sections?: "merged" | "separate";
+    fontColor?: string;
+    backgroundColor?: string;
+    borderRadius?: string | number;
+}
+interface ComponentRenderData {
+    component: {
+        id: string;
+        name: string;
+        elements: ComponentElement[];
+        design: ComponentDesign;
+    };
+    activePlan: ComponentPlanSummary | null;
+    entitlements: ComponentEntitlement[];
+    usage: ComponentUsageItem[];
+    plans: ComponentPlanSummary[];
+    company?: Record<string, unknown> | null;
+    userId?: string | null;
+    providerWallet?: string | null;
+    nextBillingAt?: string | null;
+    billingPeriod?: "monthly" | "annual" | null;
+    paymentMethod?: ComponentPaymentMethod | null;
+    recentInvoices?: ComponentInvoiceSummary[];
+    subscriptionTransition?: ComponentSubscriptionTransition | null;
+}
+/** Keys used to identify a company in API calls */
+interface ArcenCompanyKeys {
+    /** Caller's own internal company ID (maps to externalId) */
+    id?: string;
+    /** Wallet address (checksummed or lowercase) */
+    wallet?: string;
+    /** Company email address */
+    email?: string;
+}
+/** Keys used to identify a user in API calls */
+interface ArcenUserKeys {
+    /** Caller's own internal user ID (maps to externalId) */
+    id?: string;
+    /** Clerk user ID */
+    clerkUserId?: string;
+    /** Wallet address */
+    wallet?: string;
+    /** User email address */
+    email?: string;
+}
+/**
+ * Result of checkFlag() — boolean feature gating.
+ * Use for "should this feature be visible/enabled?"
+ */
+interface FlagResult {
+    key: string;
+    /** Whether the feature is enabled for this company/user */
+    enabled: boolean;
+    /** Machine-readable reason: 'override', 'rule:<ruleId>', 'default' */
+    reason: string;
+}
+/**
+ * Result of checkEntitlement() — quota-aware feature gating.
+ * Use for "can this action still be performed under the customer's plan limits?"
+ */
+interface EntitlementResult {
+    key: string;
+    /** Whether the feature/action is currently allowed */
+    enabled: boolean;
+    /** Machine-readable reason */
+    reason: string;
+    /** Maximum allowed usage. null = unlimited */
+    allocation: number | null;
+    /** Current usage count in the active billing period */
+    usage: number;
+    /** true when usage >= allocation (and allocation is not null) */
+    exceeded: boolean;
+}
+/**
+ * Result of consumeEntitlement() — quota-aware metered action enforcement.
+ * `consumed` is true only when a usage unit was actually recorded.
+ */
+interface ConsumeEntitlementResult extends EntitlementResult {
+    consumed: boolean;
+}
+/**
+ * Result of identify() — creates/updates company+user and returns a session token.
+ */
+interface IdentifyResult {
+    token: string;
+    companyId: string;
+    userId?: string;
+    expiresAt: string;
+}
 
 interface ArcenPayContextValue {
     session: ArcenSessionValue;
@@ -158,7 +386,7 @@ interface FeatureFlagGuardProps {
 declare function FeatureFlagGuard({ featureKey, walletAddress, children, fallback, className, requireDecryption, decryptEndpoint, decryptPayload, onDecryptionSuccess, onDecryptionError, }: FeatureFlagGuardProps): react_jsx_runtime.JSX.Element;
 
 type TemplateBlock = {
-    type: 'heading' | 'text' | 'price' | 'feature-list' | 'cta';
+    type: "heading" | "text" | "price" | "feature-list" | "cta";
     content?: string;
     amount?: string;
     interval?: string;
@@ -285,4 +513,4 @@ declare function useTrack(): {
 
 declare function createPaymentLinkCheckoutUrl(slug: string, baseUrl?: string): string;
 
-export { type ArcenCompanyIdentity, ArcenEmbed, type ArcenEmbedProps, type ArcenIdentifyInput, type ArcenPayContextValue, ArcenPayProvider, type ArcenPayProviderProps, type ArcenSessionValue, type ArcenUserIdentity, ArcenpayEmbed, type ArcenpayEmbedProps, ENTITLEMENT_ERROR_CODES, EntitlementError, type EntitlementErrorCode, FeatureFlagGuard, type TemplateBlock, TemplateRenderer, type TemplateRendererProps, type Tokens, type TrackEventInput, createPaymentLinkCheckoutUrl, getDesignTokens, renderElement, useArcenPay, useConsumeEntitlement, useEntitlement, useFlag, useFlags, useTrack };
+export { type ArcenCompanyIdentity, type ArcenCompanyKeys, ArcenEmbed, type ArcenEmbedProps, type ArcenIdentifyInput, type ArcenPayContextValue, ArcenPayProvider, type ArcenPayProviderProps, type ArcenSessionValue, type ArcenUserIdentity, type ArcenUserKeys, ArcenpayEmbed, type ArcenpayEmbedProps, type ComponentDesign, type ComponentElement, type ComponentRenderData, type ConsumeEntitlementResult, ENTITLEMENT_ERROR_CODES, EntitlementError, type EntitlementErrorCode, type EntitlementResult, FeatureFlagGuard, type FlagResult, type IdentifyResult, type InvoiceSummary, type Plan, type TemplateBlock, TemplateRenderer, type TemplateRendererProps, type Tokens, type TrackEventInput, createPaymentLinkCheckoutUrl, getDesignTokens, renderElement, useArcenPay, useConsumeEntitlement, useEntitlement, useFlag, useFlags, useTrack };

package/dist/index.d.ts

@@ -1,7 +1,235 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { NetworkConfig, PlanTier, ContractAddresses, ComponentRenderData, ComponentDesign, ComponentElement, ArcenCompanyKeys, ArcenUserKeys, EntitlementSources, EntitlementFreshness, ConsumeEntitlementResult } from '@arcenpay/sdk';
-export { ArcenCompanyKeys, ArcenUserKeys, ComponentDesign, ComponentElement, ComponentRenderData, ConsumeEntitlementResult, EntitlementResult, FlagResult, IdentifyResult, InvoiceSummary, Plan } from '@arcenpay/sdk';
+
+interface Plan {
+    id: bigint;
+    provider: string;
+    name: string;
+    tier: PlanTier;
+    price: bigint;
+    billingInterval: number;
+    acceptedToken: string;
+    active: boolean;
+    metadataURI: string;
+}
+type PlanTier = "starter" | "pro" | "enterprise" | string;
+type EnvironmentMode = "DEVELOPMENT" | "PRODUCTION";
+interface InvoiceSummary {
+    id: string;
+    number?: string | null;
+    status: "DRAFT" | "ISSUED" | "PAID" | "VOID" | "OVERDUE";
+    currency: string;
+    customerEmail?: string | null;
+    customerWallet?: string | null;
+    subtotal: string;
+    taxTotal: string;
+    total: string;
+    issuedAt?: string | null;
+    dueAt?: string | null;
+    environmentMode: EnvironmentMode;
+}
+interface EntitlementSourceStatus {
+    enabled: boolean;
+    lastUpdatedAt: number | null;
+}
+interface EntitlementSources {
+    onChain: EntitlementSourceStatus;
+    tableland: EntitlementSourceStatus;
+    lit: EntitlementSourceStatus;
+}
+interface EntitlementFreshness {
+    resolvedAt: number | null;
+    staleAfterMs: number;
+}
+interface NetworkConfig {
+    chainId: number;
+    name: string;
+    rpcUrl: string;
+    contracts: ContractAddresses;
+}
+interface ContractAddresses {
+    subscriptionRegistry: string;
+    autopayModule: string;
+    planFactory: string;
+    feeCollector: string;
+    sessionVault: string;
+    zkUsageVerifier: string;
+    mirrorRegistry?: string;
+    /** Optional ERC-4626 yield vault — set ARCENPAY_CONTRACT_<chainId>_yieldSessionVault to enable */
+    yieldSessionVault?: string;
+}
+interface ComponentEntitlement {
+    featureKey: string;
+    name: string;
+    value: boolean | string | number;
+    featureType?: "boolean" | "event_based" | "trait_based" | "credit";
+    limit?: number;
+    usage?: number;
+    exceeded?: boolean;
+    unitSingular?: string;
+    unitPlural?: string;
+}
+interface ComponentUsageItem {
+    featureKey: string;
+    name: string;
+    used: number;
+    limit?: number;
+    unitSingular: string | null;
+    unitPlural?: string | null;
+}
+interface ComponentPlanEntitlement {
+    featureName: string;
+    featureKey: string;
+    type: "BOOLEAN" | "NUMERIC" | "UNLIMITED";
+    value: boolean | number | null;
+    enabled: boolean;
+}
+interface ComponentPlanSummary {
+    id: string;
+    name: string;
+    price: string;
+    annualPrice?: string | null;
+    tier: string;
+    billingInterval: number;
+    acceptedToken?: string;
+    acceptedChainId?: number;
+    onChainPlanId?: string | null;
+    description?: string;
+    metadata?: {
+        entitlements?: ComponentPlanEntitlement[];
+        [key: string]: unknown;
+    } | null;
+}
+interface ComponentInvoiceSummary {
+    id: string;
+    number: string | null;
+    total: string;
+    currency: string;
+    status: string;
+    issuedAt: string | null;
+    dueAt?: string | null;
+    paidAt?: string | null;
+    customerEmail?: string | null;
+    customerWallet?: string | null;
+    downloadUrl?: string | null;
+}
+interface ComponentPaymentMethod {
+    walletAddress: string | null;
+    token: string | null;
+    chainId: number | null;
+}
+interface ComponentSubscriptionTransition {
+    mode?: string | null;
+    targetPlanId?: string | null;
+    targetPlanName?: string | null;
+    targetBillingPeriod?: "monthly" | "annual" | null;
+    previousPlanId?: string | null;
+    previousBillingPeriod?: "monthly" | "annual" | null;
+    requestedAt?: string | null;
+    effectiveAt?: string | null;
+    source?: string | null;
+}
+interface ComponentElement {
+    type: "planManager" | "meteredFeatures" | "includedFeatures" | "plansTable" | "nextBillDue" | "paymentMethod" | "invoices" | "unsubscribe" | "text" | "button" | string;
+    config?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface ComponentDesign {
+    primaryColor?: string;
+    secondaryColor?: string;
+    fontFamily?: string;
+    fontSize?: string | number;
+    cardStyle?: "minimal" | "bordered" | "elevated";
+    columns?: number;
+    sections?: "merged" | "separate";
+    fontColor?: string;
+    backgroundColor?: string;
+    borderRadius?: string | number;
+}
+interface ComponentRenderData {
+    component: {
+        id: string;
+        name: string;
+        elements: ComponentElement[];
+        design: ComponentDesign;
+    };
+    activePlan: ComponentPlanSummary | null;
+    entitlements: ComponentEntitlement[];
+    usage: ComponentUsageItem[];
+    plans: ComponentPlanSummary[];
+    company?: Record<string, unknown> | null;
+    userId?: string | null;
+    providerWallet?: string | null;
+    nextBillingAt?: string | null;
+    billingPeriod?: "monthly" | "annual" | null;
+    paymentMethod?: ComponentPaymentMethod | null;
+    recentInvoices?: ComponentInvoiceSummary[];
+    subscriptionTransition?: ComponentSubscriptionTransition | null;
+}
+/** Keys used to identify a company in API calls */
+interface ArcenCompanyKeys {
+    /** Caller's own internal company ID (maps to externalId) */
+    id?: string;
+    /** Wallet address (checksummed or lowercase) */
+    wallet?: string;
+    /** Company email address */
+    email?: string;
+}
+/** Keys used to identify a user in API calls */
+interface ArcenUserKeys {
+    /** Caller's own internal user ID (maps to externalId) */
+    id?: string;
+    /** Clerk user ID */
+    clerkUserId?: string;
+    /** Wallet address */
+    wallet?: string;
+    /** User email address */
+    email?: string;
+}
+/**
+ * Result of checkFlag() — boolean feature gating.
+ * Use for "should this feature be visible/enabled?"
+ */
+interface FlagResult {
+    key: string;
+    /** Whether the feature is enabled for this company/user */
+    enabled: boolean;
+    /** Machine-readable reason: 'override', 'rule:<ruleId>', 'default' */
+    reason: string;
+}
+/**
+ * Result of checkEntitlement() — quota-aware feature gating.
+ * Use for "can this action still be performed under the customer's plan limits?"
+ */
+interface EntitlementResult {
+    key: string;
+    /** Whether the feature/action is currently allowed */
+    enabled: boolean;
+    /** Machine-readable reason */
+    reason: string;
+    /** Maximum allowed usage. null = unlimited */
+    allocation: number | null;
+    /** Current usage count in the active billing period */
+    usage: number;
+    /** true when usage >= allocation (and allocation is not null) */
+    exceeded: boolean;
+}
+/**
+ * Result of consumeEntitlement() — quota-aware metered action enforcement.
+ * `consumed` is true only when a usage unit was actually recorded.
+ */
+interface ConsumeEntitlementResult extends EntitlementResult {
+    consumed: boolean;
+}
+/**
+ * Result of identify() — creates/updates company+user and returns a session token.
+ */
+interface IdentifyResult {
+    token: string;
+    companyId: string;
+    userId?: string;
+    expiresAt: string;
+}
 
 interface ArcenPayContextValue {
     session: ArcenSessionValue;
@@ -158,7 +386,7 @@ interface FeatureFlagGuardProps {
 declare function FeatureFlagGuard({ featureKey, walletAddress, children, fallback, className, requireDecryption, decryptEndpoint, decryptPayload, onDecryptionSuccess, onDecryptionError, }: FeatureFlagGuardProps): react_jsx_runtime.JSX.Element;
 
 type TemplateBlock = {
-    type: 'heading' | 'text' | 'price' | 'feature-list' | 'cta';
+    type: "heading" | "text" | "price" | "feature-list" | "cta";
     content?: string;
     amount?: string;
     interval?: string;
@@ -285,4 +513,4 @@ declare function useTrack(): {
 
 declare function createPaymentLinkCheckoutUrl(slug: string, baseUrl?: string): string;
 
-export { type ArcenCompanyIdentity, ArcenEmbed, type ArcenEmbedProps, type ArcenIdentifyInput, type ArcenPayContextValue, ArcenPayProvider, type ArcenPayProviderProps, type ArcenSessionValue, type ArcenUserIdentity, ArcenpayEmbed, type ArcenpayEmbedProps, ENTITLEMENT_ERROR_CODES, EntitlementError, type EntitlementErrorCode, FeatureFlagGuard, type TemplateBlock, TemplateRenderer, type TemplateRendererProps, type Tokens, type TrackEventInput, createPaymentLinkCheckoutUrl, getDesignTokens, renderElement, useArcenPay, useConsumeEntitlement, useEntitlement, useFlag, useFlags, useTrack };
+export { type ArcenCompanyIdentity, type ArcenCompanyKeys, ArcenEmbed, type ArcenEmbedProps, type ArcenIdentifyInput, type ArcenPayContextValue, ArcenPayProvider, type ArcenPayProviderProps, type ArcenSessionValue, type ArcenUserIdentity, type ArcenUserKeys, ArcenpayEmbed, type ArcenpayEmbedProps, type ComponentDesign, type ComponentElement, type ComponentRenderData, type ConsumeEntitlementResult, ENTITLEMENT_ERROR_CODES, EntitlementError, type EntitlementErrorCode, type EntitlementResult, FeatureFlagGuard, type FlagResult, type IdentifyResult, type InvoiceSummary, type Plan, type TemplateBlock, TemplateRenderer, type TemplateRendererProps, type Tokens, type TrackEventInput, createPaymentLinkCheckoutUrl, getDesignTokens, renderElement, useArcenPay, useConsumeEntitlement, useEntitlement, useFlag, useFlags, useTrack };