@owostack/types 0.3.2 → 0.4.0

package/README.md

@@ -25,9 +25,12 @@ import type {
   OwostackConfig,
   AttachParams,
   CheckResult,
+  CreditsBalanceDetails,
 } from "@owostack/types";
 ```
 
+`CheckResult` and `TrackResult` expose canonical credit-backed balance state via `credits`, which is `null` for non-credit features and otherwise resolves to either a `credit_system` or `prepaid` shape.
+
 ## License
 
 Apache-2.0

package/dist/index.d.ts

@@ -168,14 +168,37 @@ interface ResponseDetails {
     pricing?: PricingDetails;
 }
 /** Plan credit breakdown for credit system features */
-interface PlanCredits {
+interface CreditPlanBalance {
     /** Credits used this period */
     used: number;
     /** Plan credit limit */
     limit: number | null;
+    /** Remaining plan credits: limit - used (null = unlimited) */
+    balance: number | null;
     /** ISO timestamp when plan credits reset */
     resetsAt: string;
 }
+interface CreditSystemBalanceDetails {
+    /** Source of the balance details */
+    source: "credit_system";
+    /** Credit system slug backing this feature */
+    systemSlug: string;
+    /** Credit cost per unit for this feature */
+    costPerUnit: number;
+    /** Purchased add-on balance remaining for this credit system */
+    addonBalance: number;
+    /** Plan-provided balance for the current reset window */
+    plan: CreditPlanBalance;
+}
+interface PrepaidBalanceDetails {
+    /** Source of the balance details */
+    source: "prepaid";
+    /** Purchased add-on balance is not applicable for prepaid features */
+    addonBalance: null;
+    /** Plan-provided balance for the current reset window */
+    plan: CreditPlanBalance;
+}
+type CreditsBalanceDetails = CreditSystemBalanceDetails | PrepaidBalanceDetails;
 interface CheckResult {
     /** Whether access is allowed */
     allowed: boolean;
@@ -191,10 +214,8 @@ interface CheckResult {
     resetsAt: string | null;
     /** Reset interval (null for boolean features) */
     resetInterval: string | null;
-    /** Add-on credit balance for this credit system (only for credit system features) */
-    addonCredits?: number;
-    /** Plan credit breakdown (only for credit system features) */
-    planCredits?: PlanCredits;
+    /** Canonical balance details for credit-backed features */
+    credits: CreditsBalanceDetails | null;
     /** Contextual details (trial info, plan name, overage, human message) */
     details: ResponseDetails;
 }
@@ -232,10 +253,8 @@ interface TrackResult {
     resetsAt: string | null;
     /** Reset interval */
     resetInterval: string | null;
-    /** Add-on credit balance for this credit system (only for credit system features) */
-    addonCredits?: number;
-    /** Plan credit breakdown (only for credit system features) */
-    planCredits?: PlanCredits;
+    /** Canonical balance details for credit-backed features */
+    credits: CreditsBalanceDetails | null;
     /** Contextual details (trial info, plan name, overage, human message) */
     details: ResponseDetails;
 }
@@ -494,6 +513,8 @@ type CatalogEntry = PlanDefinition | CreditSystemDefinition | CreditPackDefiniti
 interface MeteredFeatureConfig {
     /** Limit for this plan (null = unlimited) */
     limit?: number | null;
+    /** Limit for this plan during a trial period (null = unlimited) */
+    trialLimit?: number | null;
     /** Reset interval (default: "monthly") */
     reset?: ResetInterval;
     /** Overage behavior (default: "block") */
@@ -693,6 +714,8 @@ interface PublicPlanFeature {
     enabled: boolean;
     /** Usage limit (null = unlimited) */
     limit: number | null;
+    /** Trial usage limit (null = unlimited) */
+    trialLimit?: number | null;
     /** Reset interval */
     resetInterval: string | null;
     /** Unit label (e.g. "call", "message", "GB") */
@@ -738,6 +761,8 @@ interface PublicPlan {
     planGroup: string | null;
     /** Trial period in days (0 = no trial) */
     trialDays: number;
+    /** Whether a card is required to start the trial */
+    trialCardRequired: boolean;
     /** Features included in this plan */
     features: PublicPlanFeature[];
 }
@@ -795,6 +820,7 @@ interface SyncPayload {
             slug: string;
             enabled: boolean;
             limit?: number | null;
+            trialLimit?: number | null;
             reset?: ResetInterval;
             usageModel?: "included" | "usage_based" | "prepaid";
             pricePerUnit?: number;
@@ -934,4 +960,4 @@ interface ListEntitiesResult {
     total: number;
 }
 
-export type { AddEntityParams, AddEntityResult, AddonParams, AddonResult, AttachParams, AttachResult, BillingFeatureUsage, BillingTierBreakdown, BillingUsageParams, BillingUsageResult, BooleanFeatureConfig, CardInfo, CatalogEntry, CheckCode, CheckParams, CheckResult, CreditPackDefinition, CreditSystemDefinition, CreditSystemFeatureEntry, Currency, CurrentPricingTier, Customer, CustomerData, CustomerParams, CustomerResult, Entitlement, Entity, Feature, FeatureLimit, Invoice, InvoiceLineItem, InvoiceParams, InvoiceResult, InvoicesParams, InvoicesResult, ListEntitiesParams, ListEntitiesResult, MeteredFeatureConfig, OverageDetails, OwostackConfig, PayInvoiceParams, PayInvoiceResult, PaymentChannel, PaymentMethodInfo, Plan, PlanCredits, PlanDefinition, PlanFeatureEntry, PlanInterval, PlansParams, PlansResult, PricingDetails, PricingTier, PublicPlan, PublicPlanFeature, RatingModel, RemoveEntityParams, RemoveEntityResult, ResetInterval, ResponseDetails, Subscription, SubscriptionStatus, SyncChanges, SyncPayload, SyncResult, TrackCode, TrackParams, TrackResult, UsageRecord, WalletRemoveResult, WalletResult, WalletSetupParams, WalletSetupResult };
+export type { AddEntityParams, AddEntityResult, AddonParams, AddonResult, AttachParams, AttachResult, BillingFeatureUsage, BillingTierBreakdown, BillingUsageParams, BillingUsageResult, BooleanFeatureConfig, CardInfo, CatalogEntry, CheckCode, CheckParams, CheckResult, CreditPackDefinition, CreditPlanBalance, CreditSystemBalanceDetails, CreditSystemDefinition, CreditSystemFeatureEntry, CreditsBalanceDetails, Currency, CurrentPricingTier, Customer, CustomerData, CustomerParams, CustomerResult, Entitlement, Entity, Feature, FeatureLimit, Invoice, InvoiceLineItem, InvoiceParams, InvoiceResult, InvoicesParams, InvoicesResult, ListEntitiesParams, ListEntitiesResult, MeteredFeatureConfig, OverageDetails, OwostackConfig, PayInvoiceParams, PayInvoiceResult, PaymentChannel, PaymentMethodInfo, Plan, PlanDefinition, PlanFeatureEntry, PlanInterval, PlansParams, PlansResult, PrepaidBalanceDetails, PricingDetails, PricingTier, PublicPlan, PublicPlanFeature, RatingModel, RemoveEntityParams, RemoveEntityResult, ResetInterval, ResponseDetails, Subscription, SubscriptionStatus, SyncChanges, SyncPayload, SyncResult, TrackCode, TrackParams, TrackResult, UsageRecord, WalletRemoveResult, WalletResult, WalletSetupParams, WalletSetupResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owostack/types",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Shared TypeScript types for Owostack",
   "license": "Apache-2.0",
   "repository": {
@@ -17,6 +17,7 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "development": "./src/index.ts",
       "import": "./dist/index.js"
     }
   },