@colixsystems/widget-sdk 0.277.3 → 0.278.0

package/README.md

@@ -87,7 +87,15 @@ See the design reference for the full architecture: [`docs/architecture/widget-m
 
 ## Status
 
-`v0.277.3` — 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.278.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.278.0 (contract 1.227.0)
+
+**New `usePurchases()` hook: sell digital goods in the native app through the App Store and Google Play.** It runs on the workspace's own RevenueCat project and returns `{ supported, loading, offering, entitlements, error, purchase, restore, refresh }`. `offering` is the current offering (`{ id, packages: [{ id, title, description, priceString, currencyCode }] }`), `entitlements` the signed-in user's active entitlement identifiers, and `purchase(packageId)` / `restore()` resolve the updated entitlements or reject with a `PurchasesError` (`UNSUPPORTED`, `SIGN_IN_REQUIRED`, `CANCELLED`, `NOT_FOUND`, `PURCHASE_FAILED`, `INTERNAL`). It is native-only: a browser has no store billing, so on the web Player `supported` is `false` and the widget must show a visible "available in the app" state. `react-native-purchases` is now a vetted native-only import; prefer the hook, and never configure or log in Purchases yourself.
+
+### What's new in 0.277.4
+
+**`<MarkdownInput>` brings its own editor on web.** The web field loads a build of the editor with Tiptap inlined, so the SDK no longer lists any `@tiptap/*` package as a peer and an app that renders `<MarkdownInput>` on web installs nothing extra.
 
 ### What's new in 0.277.3
 

package/dist/contract.cjs

@@ -3130,6 +3130,37 @@ const HOOKS = [
     requiredContextSlice: [],
     scopes: null,
   },
+  // sc-15163 — native-only in-app purchase. Optional slice; the hook reports
+  // supported:false on the web Player rather than throwing at render.
+  {
+    name: "usePurchases",
+    signature: "usePurchases()",
+    description:
+      "Sell digital goods (a subscription, premium content, credits) in the native app through the App Store and Google " +
+      "Play, on the workspace's own RevenueCat project. Returns { supported, loading, offering, entitlements, error, " +
+      "purchase, restore, refresh }. `offering` is the current offering set up in RevenueCat — { id, packages: [{ id, " +
+      "title, description, priceString, currencyCode }] } or null; show priceString as-is, the store localises it. " +
+      "`entitlements` lists the signed-in user's ACTIVE entitlement identifiers — unlock content by checking it. " +
+      "purchase(packageId) opens the store's own sheet and resolves the updated entitlements; restore() re-reads purchases " +
+      "made on another device (offer it: the stores require a way to restore). Both reject with a PurchasesError whose " +
+      ".code is one of UNSUPPORTED | SIGN_IN_REQUIRED | CANCELLED | NOT_FOUND | PURCHASE_FAILED | INTERNAL; CANCELLED means " +
+      "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.",
+    returnShape: {
+      supported: "boolean  // false on the web Player and in an app built without RevenueCat",
+      loading: "boolean",
+      offering: "{ id, packages: [{ id, title, description, priceString, currencyCode }] } | null",
+      entitlements: "string[]  // active entitlement identifiers",
+      error: "PurchasesError | null",
+      purchase: "(packageId: string) => Promise<string[]>  // rejects with PurchasesError",
+      restore: "() => Promise<string[]>  // rejects with PurchasesError",
+      refresh: "() => Promise<void>",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
   {
     name: "useAudioPlayer",
     signature: "useAudioPlayer(uri)",
@@ -4432,7 +4463,11 @@ const WIDGET_CONTEXT_SHAPE = {
       "audioRecorder: { isSupported() -> boolean, getPermission() -> Promise<'granted' | 'denied' | 'undetermined'>, " +
       "start() -> Promise<{ getStatus() -> { durationMs, levelDb, ended }, stop() -> Promise<{ file, uri, durationMs, mime, release? }>, cancel() }> }, " +
       "audioPlayer: { isSupported() -> boolean, load(uri, onStatus({ loaded, playing, positionMs, durationMs, error? })) -> " +
-      "{ play() -> Promise<void>, pause(), seek(ms) -> Promise<void>, release() } } }. " +
+      "{ play() -> Promise<void>, pause(), seek(ms) -> Promise<void>, release() } }, " +
+      "purchases: { isSupported() -> boolean, getOffering() -> Promise<offering | null>, getEntitlements() -> Promise<string[]>, " +
+      "purchase(packageId) -> Promise<string[]>, restore() -> Promise<string[]> } }. " +
+      "purchases backs usePurchases() and is NATIVE-ONLY: the Expo export brokers it through react-native-purchases when the " +
+      "workspace connected RevenueCat; the web Player never does, because a browser has no store billing. " +
       "Backs useGeolocation(), useSpeechToText(), useCamera(), useImageEditor(), useBarcodeScanner(), usePdfExport().openPdf, useAudioRecorder() and useAudioPlayer(). The web Player brokers them via " +
       "navigator.geolocation, window.SpeechRecognition, a getUserMedia camera preview, a host-side canvas, BarcodeDetector, a new browser tab, MediaRecorder and an <audio> element; the Expo export via " +
       "expo-location, expo-speech-recognition, expo-image-picker, expo-image-manipulator, expo-camera, expo-print and expo-audio. " +
@@ -4472,6 +4507,7 @@ const WIDGET_CONTEXT_SHAPE = {
       pdfViewer: "object",
       audioRecorder: "object",
       audioPlayer: "object",
+      purchases: "object",
     },
   },
 };
@@ -4702,6 +4738,18 @@ const VETTED_IMPORTS = [
     description:
       "Native clipboard. The SDK's useClipboard() hook already wraps this; reach for it directly only if you need RN-specific options.",
   },
+  // sc-15163 — native-only: a browser has no App Store / Google Play billing.
+  {
+    specifier: "react-native-purchases",
+    platforms: ["native"],
+    category: "payments",
+    description:
+      "RevenueCat in-app purchase (StoreKit / Play Billing). PREFER usePurchases() from the SDK, which already runs on the " +
+      "app's configured, signed-in customer. Import this directly only for what the hook does not cover, and NEVER call " +
+      "Purchases.configure, logIn or logOut — the app owns them, and it configures Purchases only when the workspace " +
+      "connected RevenueCat. Native-only because no browser offers store billing: author it in widget.native.jsx and give " +
+      "widget.web.jsx a visible 'available in the app' state.",
+  },
   {
     specifier: "expo-haptics",
     platforms: ["native"],
@@ -6577,7 +6625,10 @@ const CONTRACT = deepFreeze({
   // 1.226.0: behaviour (sc-15080) — `<MarkdownInput>` is a rich-text editor
   //    showing the formatted result; `showPreview`, `previewLabel` and
   //    `renderImage` are accepted and ignored.
-  version: "1.226.0",
+  // 1.227.0: additive (sc-15163) — new native-only `usePurchases()` hook and
+  //    `PurchasesError`, a `device.purchases` slice, and the vetted
+  //    `react-native-purchases` import.
+  version: "1.227.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/contract.js

@@ -3126,6 +3126,37 @@ const HOOKS = [
     requiredContextSlice: [],
     scopes: null,
   },
+  // sc-15163 — native-only in-app purchase. Optional slice; the hook reports
+  // supported:false on the web Player rather than throwing at render.
+  {
+    name: "usePurchases",
+    signature: "usePurchases()",
+    description:
+      "Sell digital goods (a subscription, premium content, credits) in the native app through the App Store and Google " +
+      "Play, on the workspace's own RevenueCat project. Returns { supported, loading, offering, entitlements, error, " +
+      "purchase, restore, refresh }. `offering` is the current offering set up in RevenueCat — { id, packages: [{ id, " +
+      "title, description, priceString, currencyCode }] } or null; show priceString as-is, the store localises it. " +
+      "`entitlements` lists the signed-in user's ACTIVE entitlement identifiers — unlock content by checking it. " +
+      "purchase(packageId) opens the store's own sheet and resolves the updated entitlements; restore() re-reads purchases " +
+      "made on another device (offer it: the stores require a way to restore). Both reject with a PurchasesError whose " +
+      ".code is one of UNSUPPORTED | SIGN_IN_REQUIRED | CANCELLED | NOT_FOUND | PURCHASE_FAILED | INTERNAL; CANCELLED means " +
+      "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.",
+    returnShape: {
+      supported: "boolean  // false on the web Player and in an app built without RevenueCat",
+      loading: "boolean",
+      offering: "{ id, packages: [{ id, title, description, priceString, currencyCode }] } | null",
+      entitlements: "string[]  // active entitlement identifiers",
+      error: "PurchasesError | null",
+      purchase: "(packageId: string) => Promise<string[]>  // rejects with PurchasesError",
+      restore: "() => Promise<string[]>  // rejects with PurchasesError",
+      refresh: "() => Promise<void>",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
   {
     name: "useAudioPlayer",
     signature: "useAudioPlayer(uri)",
@@ -4428,7 +4459,11 @@ const WIDGET_CONTEXT_SHAPE = {
       "audioRecorder: { isSupported() -> boolean, getPermission() -> Promise<'granted' | 'denied' | 'undetermined'>, " +
       "start() -> Promise<{ getStatus() -> { durationMs, levelDb, ended }, stop() -> Promise<{ file, uri, durationMs, mime, release? }>, cancel() }> }, " +
       "audioPlayer: { isSupported() -> boolean, load(uri, onStatus({ loaded, playing, positionMs, durationMs, error? })) -> " +
-      "{ play() -> Promise<void>, pause(), seek(ms) -> Promise<void>, release() } } }. " +
+      "{ play() -> Promise<void>, pause(), seek(ms) -> Promise<void>, release() } }, " +
+      "purchases: { isSupported() -> boolean, getOffering() -> Promise<offering | null>, getEntitlements() -> Promise<string[]>, " +
+      "purchase(packageId) -> Promise<string[]>, restore() -> Promise<string[]> } }. " +
+      "purchases backs usePurchases() and is NATIVE-ONLY: the Expo export brokers it through react-native-purchases when the " +
+      "workspace connected RevenueCat; the web Player never does, because a browser has no store billing. " +
       "Backs useGeolocation(), useSpeechToText(), useCamera(), useImageEditor(), useBarcodeScanner(), usePdfExport().openPdf, useAudioRecorder() and useAudioPlayer(). The web Player brokers them via " +
       "navigator.geolocation, window.SpeechRecognition, a getUserMedia camera preview, a host-side canvas, BarcodeDetector, a new browser tab, MediaRecorder and an <audio> element; the Expo export via " +
       "expo-location, expo-speech-recognition, expo-image-picker, expo-image-manipulator, expo-camera, expo-print and expo-audio. " +
@@ -4468,6 +4503,7 @@ const WIDGET_CONTEXT_SHAPE = {
       pdfViewer: "object",
       audioRecorder: "object",
       audioPlayer: "object",
+      purchases: "object",
     },
   },
 };
@@ -4698,6 +4734,18 @@ const VETTED_IMPORTS = [
     description:
       "Native clipboard. The SDK's useClipboard() hook already wraps this; reach for it directly only if you need RN-specific options.",
   },
+  // sc-15163 — native-only: a browser has no App Store / Google Play billing.
+  {
+    specifier: "react-native-purchases",
+    platforms: ["native"],
+    category: "payments",
+    description:
+      "RevenueCat in-app purchase (StoreKit / Play Billing). PREFER usePurchases() from the SDK, which already runs on the " +
+      "app's configured, signed-in customer. Import this directly only for what the hook does not cover, and NEVER call " +
+      "Purchases.configure, logIn or logOut — the app owns them, and it configures Purchases only when the workspace " +
+      "connected RevenueCat. Native-only because no browser offers store billing: author it in widget.native.jsx and give " +
+      "widget.web.jsx a visible 'available in the app' state.",
+  },
   {
     specifier: "expo-haptics",
     platforms: ["native"],
@@ -6573,7 +6621,10 @@ const CONTRACT = deepFreeze({
   // 1.226.0: behaviour (sc-15080) — `<MarkdownInput>` is a rich-text editor
   //    showing the formatted result; `showPreview`, `previewLabel` and
   //    `renderImage` are accepted and ignored.
-  version: "1.226.0",
+  // 1.227.0: additive (sc-15163) — new native-only `usePurchases()` hook and
+  //    `PurchasesError`, a `device.purchases` slice, and the vetted
+  //    `react-native-purchases` import.
+  version: "1.227.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/index.d.ts

@@ -946,6 +946,14 @@ export interface WidgetContext<TProps = unknown> {
         release(): void;
       };
     };
+    /** sc-15163 — backs usePurchases. Brokered by the Expo export only. */
+    purchases?: {
+      isSupported?(): boolean;
+      getOffering(): Promise<PurchaseOffering | null>;
+      getEntitlements(): Promise<string[]>;
+      purchase(packageId: string): Promise<string[]>;
+      restore(): Promise<string[]>;
+    };
     speech?: {
       isSupported?(): boolean;
       start(
@@ -2895,6 +2903,54 @@ export interface AudioPlayerResult {
  */
 export function useAudioPlayer(uri: string | null | undefined): AudioPlayerResult;
 
+/** One package of the current offering, as the store prices it. */
+export interface PurchasePackage {
+  id: string;
+  title: string;
+  description: string;
+  priceString: string;
+  currencyCode: string;
+}
+
+/** The current offering the workspace set up in RevenueCat. */
+export interface PurchaseOffering {
+  id: string;
+  packages: PurchasePackage[];
+}
+
+/** What `usePurchases()` returns. */
+export interface PurchasesResult {
+  /** False on the web Player: store billing needs the native app. */
+  supported: boolean;
+  loading: boolean;
+  offering: PurchaseOffering | null;
+  /** The signed-in user's active entitlement identifiers. */
+  entitlements: string[];
+  error: PurchasesError | null;
+  purchase(packageId: string): Promise<string[]>;
+  restore(): Promise<string[]>;
+  refresh(): Promise<void>;
+}
+
+/**
+ * Sell digital goods through the App Store and Google Play, on the
+ * workspace's own RevenueCat project. Native-only: on the web Player
+ * `supported` is false — render a visible "not available on the web" state.
+ */
+export function usePurchases(): PurchasesResult;
+
+/** Error surfaced by `usePurchases()`. */
+export class PurchasesError extends Error {
+  code:
+    | "UNSUPPORTED"
+    | "SIGN_IN_REQUIRED"
+    | "CANCELLED"
+    | "NOT_FOUND"
+    | "PURCHASE_FAILED"
+    | "INTERNAL";
+  constructor(code: PurchasesError["code"], message: string, opts?: { cause?: unknown });
+}
+
 /** Error surfaced by `useAudioPlayer()`. */
 export class AudioPlayerError extends Error {
   code: "UNSUPPORTED" | "LOAD_FAILED" | "BLOCKED" | "INTERNAL";

package/dist/index.js

@@ -132,6 +132,8 @@ export {
   useAudioPlayer,
   AudioPlayerError,
 } from "./audio.js";
+// sc-15163 — native-only in-app purchase; the web Player brokers none.
+export { usePurchases, PurchasesError } from "./purchases.js";
 export { useDatastoreFigure } from "./datastore-figure.js";
 export {
   useDatastoreAggregate,

package/dist/index.native.js

@@ -130,6 +130,8 @@ export {
   useAudioPlayer,
   AudioPlayerError,
 } from "./audio.js";
+// sc-15163 — native-only in-app purchase; the web Player brokers none.
+export { usePurchases, PurchasesError } from "./purchases.js";
 export { useDatastoreFigure } from "./datastore-figure.js";
 export {
   useDatastoreAggregate,