@nehorai/credits 1.4.0 → 1.6.0

package/dist/{types-BBxIWHK2.d.ts → types-CjLj3GW5.d.ts}

@@ -45,9 +45,16 @@ declare function toPortableTimestamp(value: unknown): string;
  */
 declare function toDate(value: unknown): Date;
 /**
- * Subscription tiers for the credits system
+ * Built-in tier ids (autocomplete) — apps may add more via config.
  */
-type SubscriptionTier = "free" | "basic" | "premium" | "unlimited";
+type BuiltinTier = "free" | "basic" | "premium" | "unlimited";
+/**
+ * Subscription tiers for the credits system.
+ *
+ * Any built-in OR any config-defined tier id. The `(string & {})` keeps builtin
+ * autocomplete while accepting arbitrary configured tiers.
+ */
+type SubscriptionTier = BuiltinTier | (string & {});
 /**
  * Operation types for cost tracking (provider-agnostic)
  *
@@ -129,6 +136,27 @@ interface CreditCheckResult {
     /** Shortfall if insufficient */
     shortfall: number;
 }
+/**
+ * Result of a one-shot atomic credit deduction (see `CreditsService.deductCredits`).
+ *
+ * Discriminated on `success` so callers get exhaustive narrowing:
+ * - `success: true`  -> `newBalance` is populated, `available`/`shortfall` are not present.
+ * - `success: false` -> `available`/`shortfall` describe the shortfall, no mutation occurred.
+ */
+type DeductCreditsResult = {
+    success: true;
+    /** Combined balance (balance + bonusCredits) after the deduction */
+    newBalance: number;
+} | {
+    success: false;
+    reason: "insufficient";
+    /** Combined balance (balance + bonusCredits - reserved) available before the attempt */
+    available: number;
+    /** Credits that were requested */
+    required: number;
+    /** How many more credits would have been needed */
+    shortfall: number;
+};
 /**
  * Result of monthly reset operation
  */
@@ -257,6 +285,12 @@ interface TierConfig {
     monthlyCredits: number;
     priceUsd: number;
     features: string[];
+    /** Free/default tier marker — no subscription expiry, balance untouched on tier change. Defaults to priceUsd === 0. */
+    isFree?: boolean;
+    /** Unlimited tier marker. Defaults to monthlyCredits === 0. */
+    unlimited?: boolean;
+    /** Tier assigned to brand-new users. Defaults to the tier flagged isFree. */
+    isDefault?: boolean;
 }
 /**
  * Options for withCredits HOF
@@ -274,4 +308,4 @@ interface WithCreditsOptions {
     resourceType?: ResourceType;
 }
 
-export { type AIProviderType as A, type CreditSource as C, type JournalReferenceType as J, type MonthlyResetResult as M, type PortableTransaction as P, type ReservationStatus as R, type SubscriptionTier as S, type TierConfig as T, type UsageHistoryEntry as U, type WithCreditsOptions as W, type CreditOperationType as a, type PortableUserCredits as b, type PortableReservation as c, type PortableUsageLog as d, type SubscriptionExpiryResult as e, type PortableJournalEntry as f, type CreditCheckResult as g, type ResourceType as h, type TransactionType as i, type UsageHistoryResponse as j, calculateAvailableCredits as k, toPortableTimestamp as l, toDate as t };
+export { type AIProviderType as A, type BuiltinTier as B, type CreditSource as C, type DeductCreditsResult as D, type JournalReferenceType as J, type MonthlyResetResult as M, type PortableTransaction as P, type ReservationStatus as R, type SubscriptionTier as S, type TierConfig as T, type UsageHistoryEntry as U, type WithCreditsOptions as W, type CreditOperationType as a, type PortableUserCredits as b, type PortableReservation as c, type PortableUsageLog as d, type SubscriptionExpiryResult as e, type PortableJournalEntry as f, type CreditCheckResult as g, type ResourceType as h, type TransactionType as i, type UsageHistoryResponse as j, calculateAvailableCredits as k, toPortableTimestamp as l, toDate as t };

package/dist/{types-aJsyv8df.d.ts → types-G4WK0rM-.d.ts}

@@ -1,4 +1,4 @@
-import { C as CreditSource, J as JournalReferenceType, a as CreditOperationType, P as PortableTransaction, A as AIProviderType, S as SubscriptionTier, b as PortableUserCredits, c as PortableReservation, R as ReservationStatus, d as PortableUsageLog, M as MonthlyResetResult, e as SubscriptionExpiryResult, f as PortableJournalEntry } from './types-BBxIWHK2.js';
+import { C as CreditSource, J as JournalReferenceType, a as CreditOperationType, P as PortableTransaction, A as AIProviderType, S as SubscriptionTier, b as PortableUserCredits, c as PortableReservation, R as ReservationStatus, d as PortableUsageLog, M as MonthlyResetResult, e as SubscriptionExpiryResult, f as PortableJournalEntry } from './types-CjLj3GW5.js';
 
 /**
  * Input for creating a credit reservation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nehorai/credits",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -52,6 +52,14 @@
     "url": "https://github.com/NehoraiHadad/nehorai-plugins",
     "directory": "packages/credits"
   },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "pnpm build"
+  },
   "dependencies": {
     "zod": "^3.24.2"
   },
@@ -59,12 +67,5 @@
     "typescript": "^5.7.3",
     "vitest": "^3.0.5",
     "@types/node": "^22.13.4"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Nehorai Hadad
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.