@pocketprep/types 1.19.40 → 1.19.42

package/.github/workflows/npm-publish.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 20.17.0
+          node-version: 24.22.1
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm run lint

package/API/Billing.d.ts

@@ -0,0 +1,83 @@
+import Stripe from 'stripe'
+
+/*
+ * The price contracts clients read from nest's `GET /billing/prices`. Prices
+ * are Stripe's own objects passed through unchanged, as Parse returns them, so
+ * any field the server dropped would fail at runtime rather than at compile
+ * time. Additions are safe; removals are not.
+ */
+
+/**
+ * How often a recurring price bills, derived from its Stripe interval.
+ *
+ * Not `cadence`: `Study.Class.RecommendationConfig.cadence` already spends
+ * that word on a quiz count throttling how often a recommendation reappears.
+ */
+export type BillingInterval = 'monthly' | 'quarterly' | 'yearly'
+
+/**
+ * A Stripe Price, plus a server-derived {@link BillingPrice.billingInterval}.
+ *
+ * It saves clients from parsing `nickname`, which is free text edited in the
+ * Stripe dashboard.
+ */
+export interface BillingPrice extends Stripe.Price {
+    /**
+     * Billing interval derived from `recurring`. Absent for one-time prices and
+     * for any interval that is not monthly, quarterly, or yearly.
+     *
+     * Named apart from Stripe's own `recurring.interval` (`month` / `year`),
+     * which this is derived from but does not restate.
+     */
+    billingInterval?: BillingInterval
+}
+
+/**
+ * Which client a member's plans are for. Each bundle sells the same plans at
+ * two sets of prices: `_mobile` lookup keys for members who arrive from the
+ * app, and the rest for members who start on web.
+ */
+export type PricePlatform = 'web' | 'mobile'
+
+/**
+ * The Amplitude price test that chose a member's plans, and their variant in
+ * it. When the member actually sees the plans, the client records a
+ * `$exposure` event whose `flag_key`, `variant` and `experiment_key`
+ * properties are these three fields.
+ */
+export interface PriceTest {
+    /** The test's key in Amplitude, `pricing-test-<lowercased bundle id>[-<test name>]`. */
+    flagKey: string
+    /** The member's variant key, `control` included. */
+    variant: string
+    /**
+     * Which run of the experiment assigned the variant (`exp-1`, `exp-2` after
+     * a restart), so the exposure counts toward the right run. Absent when
+     * Amplitude names none.
+     */
+    experimentKey?: string
+}
+
+/**
+ * Narrows the price list to the plans a signed-in member sees for one bundle
+ * on one platform. Both or neither: a bundle without a platform can't choose
+ * between its web and `_mobile` prices, and a platform alone names no plans.
+ */
+export interface FetchBillingPricesParams {
+    bundleId?: string
+    platform?: PricePlatform
+}
+
+export interface FetchBillingPricesResponse {
+    /**
+     * Every active price; or, when a signed-in member asks for one bundle on
+     * one platform, the monthly, quarterly and yearly plans they see there, in
+     * that order.
+     */
+    prices: BillingPrice[]
+    /**
+     * The price test that chose `prices`, control included. Absent when no
+     * test applies to the member, so there is no exposure to record.
+     */
+    priceTest?: PriceTest
+}

package/API/index.d.ts

@@ -6,3 +6,4 @@ export * from './QuestionMetric'
 export * from './Session'
 export * from './User'
 export * from './LevelUp'
+export * from './Billing'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocketprep/types",
-  "version": "1.19.40",
+  "version": "1.19.42",
   "description": "Pocket Prep type declarations",
   "repository": {
     "type": "git",
@@ -23,7 +23,7 @@
   "homepage": "https://github.com/Pocket-Prep/types#readme",
   "dependencies": {
     "@types/parse": "3.0.9",
-    "stripe": "18.3.0"
+    "stripe": "19.3.0"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "2.8.0",