@colixsystems/widget-sdk 0.280.0 → 0.281.0

package/README.md

@@ -88,7 +88,11 @@ See the design reference for the full architecture: [`docs/architecture/widget-m
 
 ## Status
 
-`v0.280.0` — pre-publish. The package surface (types, function names, export paths) is the v1 contract; runtime behaviour for some hooks is stubbed (each hook documents what's wired and what isn't). It is **not yet published to npm**.
+`v0.281.0` — pre-publish. The package surface (types, function names, export paths) is the v1 contract; runtime behaviour for some hooks is stubbed (each hook documents what's wired and what isn't). It is **not yet published to npm**.
+
+### What's new in 0.281.0 (contract 1.230.0)
+
+**Paid page access in the store builds.** A workspace can sell a `useAccessPlans()` plan in its iOS and Android apps by naming a RevenueCat entitlement for it. In those builds `purchase(planId)` then opens the store's own in-app purchase sheet, and access arrives when RevenueCat confirms the purchase — call `refresh()` a moment later. Each plan now carries `purchase_available`; `purchaseAvailable` is `false` only when no plan can be bought here, so check the plan's own flag before showing its button. A plan or paid-app access bought on the web also grants its RevenueCat entitlement, so `usePurchases().entitlements` in the app includes it. `usePurchases()` itself stays native-only. The payments client's `purchaseAccessPlan()` may answer with `store_product_id` (`@colixsystems/payments-client` 0.4.0).
 
 ### What's new in 0.280.0 (contract 1.229.0)
 

package/dist/contract.cjs

@@ -2343,13 +2343,13 @@ const HOOKS = [
     signature: "useAccessPlans()",
     returnShape: {
       plans:
-        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time)",
+        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at, purchase_available }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time); purchase_available: this plan can be bought here — false in an iOS/Android build for a plan the workspace does not sell in-app",
       loading: "boolean",
       error: "PaymentError | null",
       purchaseAvailable:
-        "boolean  // false in an iOS/Android build: page access is digital and needs store billing — render a visible not-available state, never a dead button or a blank",
+        "boolean  // false when no plan can be bought here (an iOS/Android build where the workspace sells no plan in-app) — render a visible not-available state, never a dead button or a blank; check each plan's purchase_available too",
       purchase:
-        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; host opens hosted Checkout; access arrives with the payment confirmation",
+        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; the host opens hosted Checkout on the web and the store's in-app purchase sheet in an iOS/Android build; access arrives with the payment confirmation, so refresh() a moment later",
       cancel:
         "(planId) => Promise<{ plan_id, renews: false, access_ends_at }>  // stop a renewing monthly plan; access runs to access_ends_at — offer it beside every plan with renews: true",
       refresh: "() => Promise<void>  // re-read after returning from Checkout",
@@ -3171,7 +3171,9 @@ const HOOKS = [
       "the buyer closed the sheet, so do not show it as a failure. A purchase needs a signed-in app user. NATIVE-ONLY: a " +
       "browser has no App Store or Google Play billing, so the web Player (and the Studio canvas) report supported:false " +
       "— ALWAYS render a visible 'available in the app' state there, never a blank or a dead button. The Expo export also " +
-      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app.",
+      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app. On the web, sell " +
+      "page access with useAccessPlans() instead: a web purchase of a plan (or of paid-app access) also grants its " +
+      "RevenueCat entitlement, so `entitlements` in the app includes what the user bought on the web.",
     returnShape: {
       supported: "boolean  // false on the web Player and in an app built without RevenueCat",
       loading: "boolean",
@@ -6662,7 +6664,10 @@ const CONTRACT = deepFreeze({
   //    `kind` (physical | service | digital); three new PaymentError codes.
   // 1.229.0: additive (sc-15167) — `useAccessPlans()`, and the payments slice
   //    gains `listAccessPlans` / `purchaseAccessPlan` / `cancelAccessPlan`.
-  version: "1.229.0",
+  // 1.230.0: additive (sc-15164) — each access plan carries
+  //    `purchase_available`; a store build buys a plan the workspace sells
+  //    in-app through the store, and web purchases grant RevenueCat entitlements.
+  version: "1.230.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/contract.js

@@ -2339,13 +2339,13 @@ const HOOKS = [
     signature: "useAccessPlans()",
     returnShape: {
       plans:
-        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time)",
+        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at, purchase_available }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time); purchase_available: this plan can be bought here — false in an iOS/Android build for a plan the workspace does not sell in-app",
       loading: "boolean",
       error: "PaymentError | null",
       purchaseAvailable:
-        "boolean  // false in an iOS/Android build: page access is digital and needs store billing — render a visible not-available state, never a dead button or a blank",
+        "boolean  // false when no plan can be bought here (an iOS/Android build where the workspace sells no plan in-app) — render a visible not-available state, never a dead button or a blank; check each plan's purchase_available too",
       purchase:
-        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; host opens hosted Checkout; access arrives with the payment confirmation",
+        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; the host opens hosted Checkout on the web and the store's in-app purchase sheet in an iOS/Android build; access arrives with the payment confirmation, so refresh() a moment later",
       cancel:
         "(planId) => Promise<{ plan_id, renews: false, access_ends_at }>  // stop a renewing monthly plan; access runs to access_ends_at — offer it beside every plan with renews: true",
       refresh: "() => Promise<void>  // re-read after returning from Checkout",
@@ -3167,7 +3167,9 @@ const HOOKS = [
       "the buyer closed the sheet, so do not show it as a failure. A purchase needs a signed-in app user. NATIVE-ONLY: a " +
       "browser has no App Store or Google Play billing, so the web Player (and the Studio canvas) report supported:false " +
       "— ALWAYS render a visible 'available in the app' state there, never a blank or a dead button. The Expo export also " +
-      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app.",
+      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app. On the web, sell " +
+      "page access with useAccessPlans() instead: a web purchase of a plan (or of paid-app access) also grants its " +
+      "RevenueCat entitlement, so `entitlements` in the app includes what the user bought on the web.",
     returnShape: {
       supported: "boolean  // false on the web Player and in an app built without RevenueCat",
       loading: "boolean",
@@ -6658,7 +6660,10 @@ const CONTRACT = deepFreeze({
   //    `kind` (physical | service | digital); three new PaymentError codes.
   // 1.229.0: additive (sc-15167) — `useAccessPlans()`, and the payments slice
   //    gains `listAccessPlans` / `purchaseAccessPlan` / `cancelAccessPlan`.
-  version: "1.229.0",
+  // 1.230.0: additive (sc-15164) — each access plan carries
+  //    `purchase_available`; a store build buys a plan the workspace sells
+  //    in-app through the store, and web purchases grant RevenueCat entitlements.
+  version: "1.230.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/hooks.js

@@ -7075,21 +7075,24 @@ export function usePayments() {
  * `{ plans, loading, error, purchaseAvailable, purchase, cancel, refresh }`:
  *
  *   plans → [{ id, name, price_cents, currency, billing, owned, renews,
- *     access_ends_at }] — `billing` is "one_time" or "monthly"; `owned` is
- *     true once the user holds the plan; `renews` while a held monthly plan
- *     will charge again; `access_ends_at` is when held access ends without a
- *     renewal (null for one-time access).
+ *     access_ends_at, purchase_available }] — `billing` is "one_time" or
+ *     "monthly"; `owned` is true once the user holds the plan; `renews` while
+ *     a held monthly plan will charge again; `access_ends_at` is when held
+ *     access ends without a renewal (null for one-time access);
+ *     `purchase_available` is whether this plan can be bought here.
  *     Render the price with `useWorkspaceCurrency().formatMoney(price_cents)`.
- *   purchaseAvailable → false where buying cannot work here: page access is a
- *     digital good, and an iOS / Android build must use store billing. Render a
- *     visible "not available in this app" state then — never a dead button and
- *     never a blank render.
+ *   purchaseAvailable → false where no plan can be bought here: page access is
+ *     a digital good, and an iOS / Android build sells only the plans the
+ *     workspace sells in-app (through store billing). Render a visible "not
+ *     available in this app" state for a plan whose `purchase_available` is
+ *     false — never a dead button and never a blank render.
  *   purchase(planId, { return_path? }?) → Promise<{ plan_id, status }>. Pass
  *     ONLY the plan id: the server sets the price and the group, so a widget can
- *     never name an amount. The HOST opens hosted Checkout (same-tab on web, the
- *     in-app browser on native). `status` is "ACTIVE" when access was granted at
- *     once (the mock provider) and "PENDING" while payment is confirmed; access
- *     arrives with the confirmation, never from the client.
+ *     never name an amount. The HOST takes the payment: hosted Checkout on the
+ *     web, the store's in-app purchase sheet in an iOS / Android build. `status`
+ *     is "ACTIVE" when access was granted at once (the mock provider) and
+ *     "PENDING" while payment is confirmed; access arrives with the
+ *     confirmation, never from the client.
  *   cancel(planId) → Promise<{ plan_id, renews: false, access_ends_at }> —
  *     stop a held monthly plan renewing (`renews` true). Access continues
  *     until `access_ends_at`; offer it beside every renewing plan.

package/dist/index.d.ts

@@ -1527,6 +1527,8 @@ export interface AccessPlan {
   renews: boolean;
   /** ISO time held access ends without a renewal; null for one-time access. */
   access_ends_at: string | null;
+  /** Whether this plan can be bought here (false in a store build that does not sell it in-app). */
+  purchase_available: boolean;
 }
 
 export interface AccessPlanPurchase {
@@ -1540,8 +1542,8 @@ export interface AccessPlansApi {
   loading: boolean;
   error: PaymentError | null;
   /**
-   * False where buying cannot work here (an iOS / Android build, where page
-   * access must use store billing): render a visible not-available state.
+   * False where no plan can be bought here (an iOS / Android build sells only
+   * the plans the workspace sells in-app): render a visible not-available state.
    */
   purchaseAvailable: boolean;
   /** Pass only the plan id; the server sets price and group. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.280.0",
+  "version": "0.281.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "homepage": "https://github.com/Colix-AB/AppStudio",
   "type": "module",

package/src/contract.js

@@ -2339,13 +2339,13 @@ const HOOKS = [
     signature: "useAccessPlans()",
     returnShape: {
       plans:
-        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time)",
+        "Array<{ id, name, price_cents, currency, billing: \"one_time\" | \"monthly\", owned, renews, access_ends_at, purchase_available }>  // owned: the user holds it; renews: a held monthly plan will charge again; access_ends_at: end of held access without a renewal (null for one-time); purchase_available: this plan can be bought here — false in an iOS/Android build for a plan the workspace does not sell in-app",
       loading: "boolean",
       error: "PaymentError | null",
       purchaseAvailable:
-        "boolean  // false in an iOS/Android build: page access is digital and needs store billing — render a visible not-available state, never a dead button or a blank",
+        "boolean  // false when no plan can be bought here (an iOS/Android build where the workspace sells no plan in-app) — render a visible not-available state, never a dead button or a blank; check each plan's purchase_available too",
       purchase:
-        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; host opens hosted Checkout; access arrives with the payment confirmation",
+        "(planId, { return_path? }?) => Promise<{ plan_id, status: \"ACTIVE\" | \"PENDING\" }>  // pass ONLY the plan id; the server sets price and group; the host opens hosted Checkout on the web and the store's in-app purchase sheet in an iOS/Android build; access arrives with the payment confirmation, so refresh() a moment later",
       cancel:
         "(planId) => Promise<{ plan_id, renews: false, access_ends_at }>  // stop a renewing monthly plan; access runs to access_ends_at — offer it beside every plan with renews: true",
       refresh: "() => Promise<void>  // re-read after returning from Checkout",
@@ -3167,7 +3167,9 @@ const HOOKS = [
       "the buyer closed the sheet, so do not show it as a failure. A purchase needs a signed-in app user. NATIVE-ONLY: a " +
       "browser has no App Store or Google Play billing, so the web Player (and the Studio canvas) report supported:false " +
       "— ALWAYS render a visible 'available in the app' state there, never a blank or a dead button. The Expo export also " +
-      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app.",
+      "reports supported:false until the workspace connects RevenueCat in Payments and rebuilds the app. On the web, sell " +
+      "page access with useAccessPlans() instead: a web purchase of a plan (or of paid-app access) also grants its " +
+      "RevenueCat entitlement, so `entitlements` in the app includes what the user bought on the web.",
     returnShape: {
       supported: "boolean  // false on the web Player and in an app built without RevenueCat",
       loading: "boolean",
@@ -6658,7 +6660,10 @@ const CONTRACT = deepFreeze({
   //    `kind` (physical | service | digital); three new PaymentError codes.
   // 1.229.0: additive (sc-15167) — `useAccessPlans()`, and the payments slice
   //    gains `listAccessPlans` / `purchaseAccessPlan` / `cancelAccessPlan`.
-  version: "1.229.0",
+  // 1.230.0: additive (sc-15164) — each access plan carries
+  //    `purchase_available`; a store build buys a plan the workspace sells
+  //    in-app through the store, and web purchases grant RevenueCat entitlements.
+  version: "1.230.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,