@crvouga/mockingbird-service-flex 0.2.0 → 0.3.0

package/dist/cli.js

@@ -3,8 +3,8 @@ import {
   runCli,
   serveCommand,
   serveTarget
-} from "./chunk-Q6AKODYZ.js";
-import "./chunk-RB3RIE5G.js";
+} from "./chunk-7ZR3HG2Y.js";
+import "./chunk-CTPIFEBJ.js";
 
 // src/cli.ts
 var code = await runCli(

package/dist/index.d.ts

@@ -657,15 +657,50 @@ type SetupIntentRecord = {
 type NextAction = {
     type: NextActionType;
 } & Record<string, unknown>;
+/** How often a recurring price bills (`price_data.recurring`). */
+type Recurring = {
+    interval: "day" | "week" | "month" | "year";
+    interval_count?: number;
+};
 type LineItemRecord = {
     price_data: {
         product: string;
         unit_amount: number;
+        recurring?: Recurring | null;
     };
     quantity: number;
     amount_total: number;
 };
-type SessionMode = "payment" | "off_session" | "setup";
+/** What a subscription-mode session was created with (`subscription_data`). */
+type SubscriptionData = {
+    cancel_at_period_end?: boolean;
+    metadata?: Record<string, string>;
+};
+type SessionMode = "payment" | "subscription" | "off_session" | "setup";
+declare const SUBSCRIPTION_STATUSES: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused"];
+type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[number];
+/** A subscription a paid subscription-mode checkout session created. */
+type SubscriptionRecord = {
+    subscription_id: string;
+    status: SubscriptionStatus;
+    items: {
+        price_data: {
+            product: string;
+            unit_amount: number;
+            recurring: Recurring;
+        };
+        quantity: number;
+    }[];
+    customer: string | null;
+    default_payment_method: string | null;
+    cancel_at_period_end: boolean;
+    current_period_start: string;
+    current_period_end: string;
+    canceled_at: string | null;
+    metadata: Record<string, string> | null;
+    test_mode: boolean;
+    created_at: string;
+};
 type SessionStatus = "open" | "paid" | "complete" | "canceled" | "expired";
 type SessionRecord = {
     checkout_session_id: string;
@@ -676,6 +711,9 @@ type SessionRecord = {
     customer: string | null;
     payment_intent: string | null;
     setup_intent: string | null;
+    /** The subscription a paid subscription-mode session created. */
+    subscription: string | null;
+    subscription_data: SubscriptionData | null;
     mode: SessionMode;
     status: SessionStatus;
     /** The hosted page (`redirect_url` and `url`). */
@@ -745,6 +783,7 @@ declare class FlexState {
     readonly paymentIntents: Collection<PaymentIntentRecord>;
     readonly setupIntents: Collection<SetupIntentRecord>;
     readonly refunds: Collection<RefundRecord>;
+    readonly subscriptions: Collection<SubscriptionRecord>;
     readonly settings: Collection<Settings>;
     readonly ids: IdSequence;
     constructor(sqlite: SqliteClient, namespace: string, seed: {
@@ -923,10 +962,10 @@ type OpenAPIDocument = {
 };
 
 declare const document: OpenAPIDocument;
-type OperationId = "ListProducts" | "CreateProduct" | "GetProduct" | "UpdateProduct" | "ListCheckoutSessions" | "CreateCheckoutSession" | "GetCheckoutSession" | "RefundCheckoutSession" | "CreateCustomer" | "GetSetupIntent" | "HostedCheckoutPage" | "SubmitHostedCheckout" | "CancelHostedCheckout";
-type SupportedOperationId = "ListProducts" | "CreateProduct" | "GetProduct" | "UpdateProduct" | "ListCheckoutSessions" | "CreateCheckoutSession" | "GetCheckoutSession" | "RefundCheckoutSession" | "CreateCustomer" | "GetSetupIntent" | "HostedCheckoutPage" | "SubmitHostedCheckout" | "CancelHostedCheckout";
-declare const operationIds: readonly ["ListProducts", "CreateProduct", "GetProduct", "UpdateProduct", "ListCheckoutSessions", "CreateCheckoutSession", "GetCheckoutSession", "RefundCheckoutSession", "CreateCustomer", "GetSetupIntent", "HostedCheckoutPage", "SubmitHostedCheckout", "CancelHostedCheckout"];
-declare const supportedOperationIds: readonly ["ListProducts", "CreateProduct", "GetProduct", "UpdateProduct", "ListCheckoutSessions", "CreateCheckoutSession", "GetCheckoutSession", "RefundCheckoutSession", "CreateCustomer", "GetSetupIntent", "HostedCheckoutPage", "SubmitHostedCheckout", "CancelHostedCheckout"];
+type OperationId = "ListProducts" | "CreateProduct" | "GetProduct" | "UpdateProduct" | "ListCheckoutSessions" | "CreateCheckoutSession" | "GetCheckoutSession" | "RefundCheckoutSession" | "CreateCustomer" | "GetSetupIntent" | "GetSubscription" | "HostedCheckoutPage" | "SubmitHostedCheckout" | "CancelHostedCheckout";
+type SupportedOperationId = "ListProducts" | "CreateProduct" | "GetProduct" | "UpdateProduct" | "ListCheckoutSessions" | "CreateCheckoutSession" | "GetCheckoutSession" | "RefundCheckoutSession" | "CreateCustomer" | "GetSetupIntent" | "GetSubscription" | "HostedCheckoutPage" | "SubmitHostedCheckout" | "CancelHostedCheckout";
+declare const operationIds: readonly ["ListProducts", "CreateProduct", "GetProduct", "UpdateProduct", "ListCheckoutSessions", "CreateCheckoutSession", "GetCheckoutSession", "RefundCheckoutSession", "CreateCustomer", "GetSetupIntent", "GetSubscription", "HostedCheckoutPage", "SubmitHostedCheckout", "CancelHostedCheckout"];
+declare const supportedOperationIds: readonly ["ListProducts", "CreateProduct", "GetProduct", "UpdateProduct", "ListCheckoutSessions", "CreateCheckoutSession", "GetCheckoutSession", "RefundCheckoutSession", "CreateCustomer", "GetSetupIntent", "GetSubscription", "HostedCheckoutPage", "SubmitHostedCheckout", "CancelHostedCheckout"];
 
 /** Test cards the hosted page recognises (spaces are ignored). */
 declare const CARDS: {
@@ -995,7 +1034,7 @@ declare const createRuntime: (options?: FlexRuntimeOptions) => FlexRuntime;
 
 declare const FLEX_NAMESPACE = "flex";
 /** Every webhook event type the mock sends (our receiver reconciles on each). */
-declare const FLEX_EVENT_TYPES: readonly ["product.updated", "checkout.session.completed", "checkout_session.completed", "checkout.session.async_payment_succeeded", "checkout.session.async_payment_failed", "checkout.session.refunded", "checkout.session.expired", "checkout_session.expired", "payment_intent.succeeded", "refund.created", "refund.updated", "charge.refunded", "charge.refund.updated"];
+declare const FLEX_EVENT_TYPES: readonly ["product.updated", "checkout.session.completed", "checkout_session.completed", "checkout.session.async_payment_succeeded", "checkout.session.async_payment_failed", "checkout.session.refunded", "checkout.session.expired", "checkout_session.expired", "payment_intent.succeeded", "customer.subscription.created", "refund.created", "refund.updated", "charge.refunded", "charge.refund.updated"];
 type FlexEventType = (typeof FLEX_EVENT_TYPES)[number];
 /** The event inside the `{event: {...}}` webhook envelope. */
 type FlexEvent = {
@@ -1023,6 +1062,12 @@ type SessionView = {
     expandCustomer: boolean;
     expandPaymentIntent: boolean;
 };
+/**
+ * The end of a billing period that starts at `startMs`: `interval_count` intervals later.
+ * Month and year steps keep the day of month, clamped to the target month's length
+ * (Jan 31 + 1 month = Feb 28/29), the way card-network billing anchors do.
+ */
+declare const periodEnd: (startMs: number, recurring: Recurring) => number;
 /**
  * Stateful mock of the Flex HSA/FSA payments API.
  *
@@ -1069,6 +1114,14 @@ declare class FlexAPI implements FetchAPI$1 {
     private createCustomer;
     private newCustomer;
     private getSetupIntent;
+    private getSubscription;
+    /**
+     * Start the subscription a paid subscription-mode session buys: active, billed from now
+     * for one period of its first recurring line item, charged to the card just used.
+     */
+    private startSubscription;
+    /** The subscriptions paid subscription-mode sessions created in this namespace. */
+    subscriptions(): SubscriptionRecord[];
     private paymentIntentFor;
     /** Create or update the session's payment intent (`PUT /__admin/sessions/:id/payment-intent`). */
     setPaymentIntent(id: string, patch: Partial<Pick<PaymentIntentRecord, "status" | "amount_received" | "payment_method" | "customer">>): PaymentIntentRecord | undefined;
@@ -1108,5 +1161,5 @@ declare class FlexAPI implements FetchAPI$1 {
 /** Whether a string is one of the next-action types. */
 declare const isNextActionType: (value: unknown) => value is NextActionType;
 
-export { CARDS, CORPUS_ROWS, DEFAULT_SETTINGS, ELIGIBILITIES, FLEX_EVENT_TYPES, FLEX_NAMESPACE, FLEX_PRESETS, FlexAPI, NEXT_ACTION_TYPES, PAYMENT_INTENT_STATUSES, classifyCard, corpusProduct, createRuntime, document, isNextActionType, keyMode, operationIds, substituteSessionId, supportedOperationIds };
-export type { CardOutcome, CorpusRow, CustomerRecord, Eligibility, FetchAPI$1 as FetchAPI, FlexAPIOptions, FlexEvent, FlexEventType, FlexRuntime, FlexRuntimeOptions, LineItemRecord, NextAction, NextActionType, OperationId, PaymentIntentRecord, PaymentIntentStatus, PaymentMethodRecord, ProductRecord, RefundRecord, SessionMode, SessionRecord, SessionStatus, Settings, SetupIntentRecord, SqliteClient, SupportedOperationId };
+export { CARDS, CORPUS_ROWS, DEFAULT_SETTINGS, ELIGIBILITIES, FLEX_EVENT_TYPES, FLEX_NAMESPACE, FLEX_PRESETS, FlexAPI, NEXT_ACTION_TYPES, PAYMENT_INTENT_STATUSES, SUBSCRIPTION_STATUSES, classifyCard, corpusProduct, createRuntime, document, isNextActionType, keyMode, operationIds, periodEnd, substituteSessionId, supportedOperationIds };
+export type { CardOutcome, CorpusRow, CustomerRecord, Eligibility, FetchAPI$1 as FetchAPI, FlexAPIOptions, FlexEvent, FlexEventType, FlexRuntime, FlexRuntimeOptions, LineItemRecord, NextAction, NextActionType, OperationId, PaymentIntentRecord, PaymentIntentStatus, PaymentMethodRecord, ProductRecord, Recurring, RefundRecord, SessionMode, SessionRecord, SessionStatus, Settings, SetupIntentRecord, SqliteClient, SubscriptionData, SubscriptionRecord, SubscriptionStatus, SupportedOperationId };

package/dist/index.js

@@ -9,6 +9,7 @@ import {
   FlexAPI,
   NEXT_ACTION_TYPES,
   PAYMENT_INTENT_STATUSES,
+  SUBSCRIPTION_STATUSES,
   classifyCard,
   corpusProduct,
   createRuntime,
@@ -16,9 +17,10 @@ import {
   isNextActionType,
   keyMode,
   operationIds,
+  periodEnd,
   substituteSessionId,
   supportedOperationIds
-} from "./chunk-RB3RIE5G.js";
+} from "./chunk-CTPIFEBJ.js";
 export {
   CARDS,
   CORPUS_ROWS,
@@ -30,6 +32,7 @@ export {
   FlexAPI,
   NEXT_ACTION_TYPES,
   PAYMENT_INTENT_STATUSES,
+  SUBSCRIPTION_STATUSES,
   classifyCard,
   corpusProduct,
   createRuntime,
@@ -37,6 +40,7 @@ export {
   isNextActionType,
   keyMode,
   operationIds,
+  periodEnd,
   substituteSessionId,
   supportedOperationIds
 };

package/dist/server.d.ts

@@ -1160,15 +1160,50 @@ type SetupIntentRecord = {
 type NextAction = {
     type: NextActionType;
 } & Record<string, unknown>;
+/** How often a recurring price bills (`price_data.recurring`). */
+type Recurring = {
+    interval: "day" | "week" | "month" | "year";
+    interval_count?: number;
+};
 type LineItemRecord = {
     price_data: {
         product: string;
         unit_amount: number;
+        recurring?: Recurring | null;
     };
     quantity: number;
     amount_total: number;
 };
-type SessionMode = "payment" | "off_session" | "setup";
+/** What a subscription-mode session was created with (`subscription_data`). */
+type SubscriptionData = {
+    cancel_at_period_end?: boolean;
+    metadata?: Record<string, string>;
+};
+type SessionMode = "payment" | "subscription" | "off_session" | "setup";
+declare const SUBSCRIPTION_STATUSES: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused"];
+type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[number];
+/** A subscription a paid subscription-mode checkout session created. */
+type SubscriptionRecord = {
+    subscription_id: string;
+    status: SubscriptionStatus;
+    items: {
+        price_data: {
+            product: string;
+            unit_amount: number;
+            recurring: Recurring;
+        };
+        quantity: number;
+    }[];
+    customer: string | null;
+    default_payment_method: string | null;
+    cancel_at_period_end: boolean;
+    current_period_start: string;
+    current_period_end: string;
+    canceled_at: string | null;
+    metadata: Record<string, string> | null;
+    test_mode: boolean;
+    created_at: string;
+};
 type SessionStatus = "open" | "paid" | "complete" | "canceled" | "expired";
 type SessionRecord = {
     checkout_session_id: string;
@@ -1179,6 +1214,9 @@ type SessionRecord = {
     customer: string | null;
     payment_intent: string | null;
     setup_intent: string | null;
+    /** The subscription a paid subscription-mode session created. */
+    subscription: string | null;
+    subscription_data: SubscriptionData | null;
     mode: SessionMode;
     status: SessionStatus;
     /** The hosted page (`redirect_url` and `url`). */
@@ -1245,6 +1283,7 @@ declare class FlexState {
     readonly paymentIntents: Collection<PaymentIntentRecord>;
     readonly setupIntents: Collection<SetupIntentRecord>;
     readonly refunds: Collection<RefundRecord>;
+    readonly subscriptions: Collection<SubscriptionRecord>;
     readonly settings: Collection<Settings>;
     readonly ids: IdSequence;
     constructor(sqlite: SqliteClient, namespace: string, seed: {
@@ -1327,6 +1366,14 @@ declare class FlexAPI implements FetchAPI {
     private createCustomer;
     private newCustomer;
     private getSetupIntent;
+    private getSubscription;
+    /**
+     * Start the subscription a paid subscription-mode session buys: active, billed from now
+     * for one period of its first recurring line item, charged to the card just used.
+     */
+    private startSubscription;
+    /** The subscriptions paid subscription-mode sessions created in this namespace. */
+    subscriptions(): SubscriptionRecord[];
     private paymentIntentFor;
     /** Create or update the session's payment intent (`PUT /__admin/sessions/:id/payment-intent`). */
     setPaymentIntent(id: string, patch: Partial<Pick<PaymentIntentRecord, "status" | "amount_received" | "payment_method" | "customer">>): PaymentIntentRecord | undefined;

package/dist/server.js

@@ -2,8 +2,8 @@ import {
   DEFAULT_PORT,
   createServer,
   serveTarget
-} from "./chunk-Q6AKODYZ.js";
-import "./chunk-RB3RIE5G.js";
+} from "./chunk-7ZR3HG2Y.js";
+import "./chunk-CTPIFEBJ.js";
 export {
   DEFAULT_PORT,
   createServer,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crvouga/mockingbird-service-flex",
-  "version": "0.2.0",
-  "description": "Stateful mock of the Flex HSA/FSA payments API: products (recorded catalog corpus), checkout sessions in payment, off-session and setup modes, customers, setup intents, refunds, the hosted checkout page, and Svix-signed webhooks.",
+  "version": "0.3.0",
+  "description": "Stateful mock of the Flex HSA/FSA payments API: products (recorded catalog corpus), checkout sessions in payment, subscription, off-session and setup modes, subscriptions, customers, setup intents, refunds, the hosted checkout page, and Svix-signed webhooks.",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -54,7 +54,7 @@
     "layer": "service",
     "category": "payments",
     "displayName": "Flex",
-    "status": "wip",
+    "status": "ready",
     "playground": {
       "headers": {
         "authorization": "Bearer fsk_test_mockingbird"