@noirtrack/sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to `@noirtrack/sdk` are documented here. This project follows semantic versioning (while pre-1.0, a minor bump may include breaking changes).
 
+## 0.4.0
+
+### Added
+
+- **Subscriptions.** `revenue()` accepts `subscriptionId`, `interval` (`day`, `week`, `month` or `year`) and `intervalCount`, so sales sent from your backend count toward MRR and churn on the Subscriptions page.
+- **Failed payments.** `revenue({ status: 'failed', amount, paymentId })` records a declined attempt as revenue at risk. It never adds to revenue, and the same `paymentId` is stored once.
+
 ## 0.3.0
 
 ### Added

package/dist/core/secret.d.ts

@@ -15,7 +15,11 @@ export interface SecretApi {
         currency?: string;
         visitorId?: string;
         event?: string;
-        status?: 'paid' | 'refunded' | 'cancelled' | 'subscription_ended';
+        status?: 'paid' | 'refunded' | 'cancelled' | 'subscription_ended' | 'failed';
+        subscriptionId?: string;
+        interval?: 'day' | 'week' | 'month' | 'year';
+        intervalCount?: number;
+        paymentId?: string;
         refund?: boolean;
     }): Promise<boolean>;
     identify(input: IdentifyInput & {

package/dist/core/secret.js

@@ -36,6 +36,10 @@ export function createSecretApi(config) {
             visitor_id: input.visitorId,
             event: input.event,
             status: input.status,
+            subscription_id: input.subscriptionId,
+            interval: input.interval,
+            interval_count: input.intervalCount,
+            payment_id: input.paymentId,
             refund: input.refund, // legacy; the server normalises it to status:refunded
         }, head, timeoutMs);
     }

package/dist/core/types.d.ts

@@ -55,7 +55,7 @@ export type RevenueInput = {
     visitorId?: string;
 } | {
     /**
-     * Required for `paid`/`refunded`; omit for `cancelled`/`subscription_ended` (no money moves).
+     * Required for `paid`/`refunded`/`failed`; omit for `cancelled`/`subscription_ended` (no money moves).
      * The server rejects a `paid`/`refunded` call with no amount (422) and the SDK fails open
      * silently — the revenue is dropped, not thrown — so always pass it for those two statuses.
      */
@@ -63,8 +63,16 @@ export type RevenueInput = {
     currency?: string;
     visitorId?: string;
     event?: string;
-    /** Lifecycle status. Default `paid`. */
-    status?: 'paid' | 'refunded' | 'cancelled' | 'subscription_ended';
+    /** Lifecycle status. Default `paid`. `failed` records a declined attempt as revenue at risk, never as revenue. */
+    status?: 'paid' | 'refunded' | 'cancelled' | 'subscription_ended' | 'failed';
+    /** Your subscription id. Links renewals and cancellations so MRR and churn are tracked. */
+    subscriptionId?: string;
+    /** Billing period of the subscription. Default `month`. */
+    interval?: 'day' | 'week' | 'month' | 'year';
+    /** How many intervals one payment covers, 1 to 36. Default 1 (a quarterly plan is `month` × 3). */
+    intervalCount?: number;
+    /** Your provider's id for a failed attempt, so a retried notification is stored once. */
+    paymentId?: string;
     /** @deprecated Legacy alias for `status: 'refunded'`. */
     refund?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@noirtrack/sdk",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "description": "NoirTrack server SDK. Block bots and bad traffic before your app renders, and record goals, revenue, and identify from your backend with one secret key. Framework-agnostic core plus Next.js, Express, and fetch/edge adapters.",
     "homepage": "https://noirtrack.com/docs",
     "bugs": {