@superwall/cli 2.1.1 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -1
- package/dist/{apple-BHbX0jbn.js → apple-DaqaI4vD.js} +13 -13
- package/dist/auth.d.ts +1 -1
- package/dist/auth.js +3 -3
- package/dist/{billing-4zhIBFRQ.js → billing-DyKr2kmd.js} +3 -3
- package/dist/{bind-CHLHmxgA.js → bind-BpxebZf4.js} +4 -4
- package/dist/{build-5PQeSnNN.js → build-DzbdRThf.js} +6 -6
- package/dist/{client-BIvOmWPC.js → client-BF9rCULI.js} +3 -3
- package/dist/{create-VK-pNfN7.js → create-B55V99TD.js} +22 -22
- package/dist/create-BYAPuhhf.js +19 -0
- package/dist/{create-BSNIFsnN.js → create-D7AZHYGH.js} +6 -6
- package/dist/{doctor-9JS96QkX.js → doctor-B2mPKiaJ.js} +6 -6
- package/dist/{drivers-BamBJ10Y.js → drivers-DOMky8Ug.js} +3 -3
- package/dist/entry.js +19 -19
- package/dist/{environment-eV7LEnSN.js → environment-DBwo79dy.js} +1 -1
- package/dist/{existing-C8dSYHGk.js → existing-B4VK4BCL.js} +2 -2
- package/dist/held-C9FqvNbn.js +16 -0
- package/dist/{held-BMisHn8F.js → held-DjcZPCwn.js} +6 -6
- package/dist/{integrate-VWtTNPCr.js → integrate-B8oHbvwz.js} +21 -21
- package/dist/{login-BmwG14LC.js → login-B8hgMLhS.js} +1 -1
- package/dist/login-D-a7oS_8.js +16 -0
- package/dist/{login-BimbukE5.js → login-DfhqWY9C.js} +256 -33
- package/dist/{lookup-k9EeOiZr.js → lookup-r8p6H2ZC.js} +2 -2
- package/dist/{migrate-C86h6jeF.js → migrate-DQf2Fosc.js} +21 -21
- package/dist/{notification-url-BVaTgWZ5.js → notification-url-BxPTEmkv.js} +2 -2
- package/dist/{open-0tDCQOXC.js → open-CrEnSL4v.js} +21 -17
- package/dist/{org-DUwdrKPV.js → org-Cc2WGvl1.js} +2 -2
- package/dist/{paths-BCbjCLP5.js → paths-BcNbJfpw.js} +1 -1
- package/dist/{playbook-oov9yV0q.js → playbook-D9J8frkE.js} +10 -10
- package/dist/{promote-DPGPamkE.js → promote-C8T7DCFF.js} +16 -16
- package/dist/{push-Cz4lJ8Qd.js → push-Bzs1l_5C.js} +4 -4
- package/dist/push-snV3SrnH.js +22 -0
- package/dist/{registry-CTczUigi.js → registry-CpxZbmxp.js} +83 -63
- package/dist/{resources-B1qKDVXd.js → resources-Bo6i7wBi.js} +1 -1
- package/dist/{run-DTPsVmFw.js → run-BUp4r8Kk.js} +2 -2
- package/dist/{scan-Bb48xZqB.js → scan-8cxu2fx0.js} +1 -1
- package/dist/scan-nUeXs9a1.js +4 -0
- package/dist/{scope-B6UYGuwn.js → scope-CPG_wWXL.js} +4 -4
- package/dist/{selection-BbNk9r1q.js → selection-CMA4aG4V.js} +3 -3
- package/dist/server-Boqa8jh_.js +22 -0
- package/dist/{server-EYBMKAG1.js → server-Xb3wp-mx.js} +66 -16
- package/dist/{session-xG9E8J2N.js → session-DOZV1TP6.js} +1 -1
- package/dist/session-DtBpdlF-.js +6 -0
- package/dist/{session-Crg9X-FI.js → session-eZeXR9xU.js} +9 -8
- package/dist/skills/animate-onboarding/SKILL.md +1 -1
- package/dist/skills/index.json +18 -18
- package/dist/skills/mobile-design/SKILL.md +1 -1
- package/dist/skills/onboarding-questions/SKILL.md +1 -1
- package/dist/skills/superwall/SKILL.md +102 -17
- package/dist/skills/superwall/references/api.md +13 -2
- package/dist/skills/superwall/references/data-analytics.md +7 -8
- package/dist/skills/superwall/workflows/dashboard/playbook.md +2 -1
- package/dist/skills/superwall/workflows/dashboard/setup.md +3 -1
- package/dist/skills/superwall/workflows/integrate/playbook.md +4 -2
- package/dist/skills/superwall/workflows/migrate/adapty.md +3 -3
- package/dist/skills/superwall/workflows/migrate/playbook.md +2 -1
- package/dist/skills/superwall/workflows/migrate/qonversion.md +3 -3
- package/dist/skills/superwall/workflows/migrate/revenuecat.md +4 -4
- package/dist/skills/superwall-editor/SKILL.md +53 -1
- package/dist/skills/superwall-framework/SKILL.md +10 -5
- package/dist/skills/superwall-framework/references/migrate-from-editor.md +3 -2
- package/dist/skills/superwall-framework/references/mobile-design.md +1 -1
- package/dist/{skills-Dg3k6TRC.js → skills-BI19OGlS.js} +8 -8
- package/dist/{skills-BdMKE2uO.js → skills-DDf10ufO.js} +4 -4
- package/dist/{spinner-Ba3XhlMb.js → spinner-BClMQGGN.js} +3 -3
- package/dist/{storage-CerJ5KLP.d.ts → storage-BbJF7z3l.d.ts} +1 -0
- package/dist/{storage-DIkYajce.js → storage-Po9E-CHL.js} +12 -2
- package/dist/storekit-BU6Eq_UO.js +16 -0
- package/dist/{storekit-C2UzIIMs.js → storekit-Cbn9DBLA.js} +3 -3
- package/dist/{telemetry-CVP8O6Y3.js → telemetry-s6dag6tb.js} +1 -1
- package/dist/{token-IWv2httm.js → token-CPplNMVa.js} +1 -1
- package/dist/tools-skills/animate-onboarding/SKILL.md +1 -1
- package/dist/tools-skills/mobile-design/SKILL.md +1 -1
- package/dist/tools-skills/onboarding-questions/SKILL.md +1 -1
- package/dist/tools-skills/superwall/SKILL.md +80 -8
- package/dist/tools-skills/superwall/references/api.md +116 -24
- package/dist/tools-skills/superwall/references/apple-setup.md +316 -0
- package/dist/tools-skills/superwall/references/asc.md +74 -38
- package/dist/tools-skills/superwall/references/data-analytics.md +62 -29
- package/dist/tools-skills/superwall/workflows/dashboard/playbook.md +3 -3
- package/dist/tools-skills/superwall/workflows/dashboard/setup.md +8 -8
- package/dist/tools-skills/superwall/workflows/migrate/adapty.md +6 -6
- package/dist/tools-skills/superwall/workflows/migrate/playbook.md +4 -4
- package/dist/tools-skills/superwall/workflows/migrate/qonversion.md +5 -5
- package/dist/tools-skills/superwall/workflows/migrate/revenuecat.md +6 -6
- package/dist/tools-skills/superwall/workflows/placements/android.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/expo.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/flutter.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/ios.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/playbook.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/react-native.md +2 -2
- package/dist/tools-skills/superwall/workflows/placements/strategy.md +2 -2
- package/dist/tools-skills/superwall/workflows/review/playbook.md +1 -1
- package/dist/tools-skills/superwall-editor/SKILL.md +2 -2
- package/dist/tools.d.ts +8 -8
- package/dist/tools.js +21 -24
- package/dist/{upgrade-DLf0LJDh.js → upgrade-1OYm5NQU.js} +2 -2
- package/dist/{upgrade-1t3aQUxh.js → upgrade-ahapZeex.js} +1 -1
- package/package.json +2 -2
- package/dist/create-oj3zXvHZ.js +0 -19
- package/dist/held-DeJW2gUk.js +0 -16
- package/dist/login-2JHCG6c1.js +0 -16
- package/dist/push-Chp21y3a.js +0 -22
- package/dist/scan-B1SkkUi7.js +0 -4
- package/dist/server-CwrZ-I1r.js +0 -22
- package/dist/session-DItGa4z0.js +0 -6
- package/dist/storekit-DHNxDDpA.js +0 -16
package/dist/skills/index.json
CHANGED
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
[
|
|
2
2
|
{
|
|
3
|
-
"name": "
|
|
3
|
+
"name": "animate-onboarding",
|
|
4
4
|
"channel": "latest",
|
|
5
|
-
"summary": "
|
|
5
|
+
"summary": "Animate a tap-through onboarding or web funnel (quiz, survey,..."
|
|
6
6
|
},
|
|
7
7
|
{
|
|
8
|
-
"name": "
|
|
8
|
+
"name": "mobile-design",
|
|
9
9
|
"channel": "latest",
|
|
10
|
-
"summary": "
|
|
10
|
+
"summary": "Make a web screen feel native inside a phone app — a paywall,..."
|
|
11
11
|
},
|
|
12
12
|
{
|
|
13
|
-
"name": "
|
|
13
|
+
"name": "onboarding-questions",
|
|
14
14
|
"channel": "latest",
|
|
15
|
-
"summary": "
|
|
16
|
-
},
|
|
17
|
-
{
|
|
18
|
-
"name": "animate-onboarding",
|
|
19
|
-
"channel": "next",
|
|
20
|
-
"summary": "Animate a tap-through onboarding or web funnel (quiz, survey,..."
|
|
15
|
+
"summary": "Write the brains of an app's onboarding or web2app funnel — e..."
|
|
21
16
|
},
|
|
22
17
|
{
|
|
23
|
-
"name": "
|
|
24
|
-
"channel": "
|
|
25
|
-
"summary": "
|
|
18
|
+
"name": "superwall",
|
|
19
|
+
"channel": "latest",
|
|
20
|
+
"summary": "Use the `superwall` CLI to manage apps, products, entitlement..."
|
|
26
21
|
},
|
|
27
22
|
{
|
|
28
|
-
"name": "
|
|
29
|
-
"channel": "
|
|
30
|
-
"summary": "
|
|
23
|
+
"name": "superwall-editor",
|
|
24
|
+
"channel": "latest",
|
|
25
|
+
"summary": "LEGACY — drives the browser (visual) paywall editor over a pa..."
|
|
31
26
|
},
|
|
32
27
|
{
|
|
33
28
|
"name": "superwall-framework",
|
|
34
|
-
"channel": "
|
|
29
|
+
"channel": "latest",
|
|
35
30
|
"summary": "Author any screen an app should be able to change without a r..."
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"name": "wwdc",
|
|
34
|
+
"channel": "latest",
|
|
35
|
+
"summary": "Use this skill whenever the user asks about WWDC sessions, Ap..."
|
|
36
36
|
}
|
|
37
37
|
]
|
|
@@ -440,7 +440,7 @@ screen that already exists — and read the `superwall-framework` skill for
|
|
|
440
440
|
the mechanics; the user decides. Install it if it isn't there:
|
|
441
441
|
|
|
442
442
|
```bash
|
|
443
|
-
npx skills add https://github.com/superwall/skills
|
|
443
|
+
npx skills add https://github.com/superwall/skills --skill superwall-framework --global --yes --agent claude-code universal --full-depth
|
|
444
444
|
```
|
|
445
445
|
|
|
446
446
|
This skill is complete without it: everything above applies to any web
|
|
@@ -36,7 +36,7 @@ version, and a campaign switches it live.
|
|
|
36
36
|
|
|
37
37
|
So when the spec is approved, the next step is to build it there: the
|
|
38
38
|
`superwall-framework` skill carries the how (install it if missing: `npx
|
|
39
|
-
skills add https://github.com/superwall/skills
|
|
39
|
+
skills add https://github.com/superwall/skills --skill
|
|
40
40
|
superwall-framework --global --yes --agent claude-code universal
|
|
41
41
|
--full-depth`), its `onboarding-quiz` and `web-funnel` examples are the two
|
|
42
42
|
shapes this spec takes (in-app before the paywall; on the web before
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: superwall
|
|
3
|
-
description: Use
|
|
3
|
+
description: Use the `superwall` CLI to manage apps, products, entitlements, campaigns, paywalls, App Store Connect (including connecting its keys, server notifications and revenue provider), Apple Search Ads, and ClickHouse analytics. Also covers documentation lookup, dashboard links, SDK source inspection, and integration, migration, review, and dashboard workflows. Use for Superwall API or CLI tasks, data analysis, SDK setup, provider migration, webhook events, and SDK debugging — and whenever an app has a screen it should be able to change without a release (paywall, onboarding, update-required, lifecycle prompt, announcement), which belongs in Superwall as a surface behind a placement. When the Superwall MCP connector is available, use its tools directly for account tasks (apps, products, entitlements, campaigns, paywalls, webhooks, analytics) and keep the CLI for everything else.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Superwall
|
|
@@ -99,6 +99,11 @@ viewing the account with `bootstrap`.
|
|
|
99
99
|
|
|
100
100
|
[Read the CLI reference](references/api.md).
|
|
101
101
|
|
|
102
|
+
**Before any `post`/`patch` to `/v2/...`, run `superwall api docs`** to find the
|
|
103
|
+
endpoint and its exact body. The API covers far more than the resource commands
|
|
104
|
+
(campaign audiences, variants and traffic weights, users, webhooks, charts,
|
|
105
|
+
retention): search it, never guess a path or a body.
|
|
106
|
+
|
|
102
107
|
Commands follow the API, Stripe-style: `superwall <resource> [nested]
|
|
103
108
|
<operation> [ids] [--field value]`, with `list · get · create · update · delete`
|
|
104
109
|
everywhere the API has them. **Run `superwall <resource> --help` for its
|
|
@@ -114,7 +119,8 @@ superwall apps update <app> --bundle-id com.acme.app --json
|
|
|
114
119
|
superwall paywalls list --app <id|dashboard link> --search onboarding --json
|
|
115
120
|
superwall campaigns create --description "New user paywall" --placement onboarding_complete --app <id> --json
|
|
116
121
|
superwall campaigns audiences --help # what a nested resource can do
|
|
117
|
-
superwall api docs variant #
|
|
122
|
+
superwall api docs variant # find endpoints by keyword
|
|
123
|
+
superwall api docs /v2/campaigns/{id}/audiences/{audience_id}/variants post # exact body
|
|
118
124
|
```
|
|
119
125
|
|
|
120
126
|
## App Store Connect - App Store Connect API
|
|
@@ -196,6 +202,47 @@ provider with the `{revenue_integrations:Array(String)}` parameter it fills, or
|
|
|
196
202
|
the numbers double-count apps that send revenue from both the store and
|
|
197
203
|
RevenueCat (see the reference).
|
|
198
204
|
|
|
205
|
+
## Screens as code - the Superwall framework
|
|
206
|
+
|
|
207
|
+
Use when: building or editing anything that ships through Superwall as a
|
|
208
|
+
mini React app in a `superwall/` project directory — `config.ts`, `app/`
|
|
209
|
+
routes, React hooks, `superwall create`/`dev`/`push`/`publish`.
|
|
210
|
+
|
|
211
|
+
**Reach for it on your own initiative, not only when asked for a paywall.**
|
|
212
|
+
Any screen the user would rather change without an app release belongs
|
|
213
|
+
here: paywalls and offers, onboarding and quizzes, update-required and
|
|
214
|
+
force-upgrade screens, lifecycle prompts (rate us, enable notifications,
|
|
215
|
+
trial ending, win-back), announcements, consent and legal changes. When
|
|
216
|
+
you see one of those being built natively, or as a static screen in the
|
|
217
|
+
app, say so and propose making it a Superwall surface with a placement
|
|
218
|
+
(`superwall create` for a new one, `superwall migrate --screen <path>` for
|
|
219
|
+
one that already exists natively, `register("<placement>")` at the call
|
|
220
|
+
site); the user decides. The test is: would they want to edit this after
|
|
221
|
+
shipping?
|
|
222
|
+
|
|
223
|
+
**Offer to migrate editor paywalls when you meet them.** `superwall
|
|
224
|
+
paywalls list --json` marks each row `"headless": true` (built with the
|
|
225
|
+
framework) or `false` (built in the visual editor). When the user is
|
|
226
|
+
working on an editor paywall — changing its copy, products or design,
|
|
227
|
+
adding a locale, asking why something looks off — offer the rebuild:
|
|
228
|
+
`superwall migrate <paywall-id>` scaffolds it as code, briefs the
|
|
229
|
+
rebuild, and shows the original beside the new one in the studio. Say
|
|
230
|
+
what it gains (code review, localization files, any component library,
|
|
231
|
+
the same studio for every screen) and that the original keeps serving
|
|
232
|
+
until a campaign switches; never migrate unprompted.
|
|
233
|
+
|
|
234
|
+
That work has its own skill carrying the framework's full documentation.
|
|
235
|
+
Prefer it if installed (`superwall-framework`); otherwise install it:
|
|
236
|
+
|
|
237
|
+
```bash
|
|
238
|
+
npx skills add https://github.com/superwall/skills --skill superwall-framework --global --yes --agent claude-code universal --full-depth
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
The framework is in public beta. Until the CLI turns these commands on by
|
|
242
|
+
default, it has them only while `SUPERWALL_CHANNEL=next` is set in the environment. If
|
|
243
|
+
`superwall create` answers `Unknown command`, the variable is missing from
|
|
244
|
+
your environment: ask the user to set it globally (shell rc) and relaunch.
|
|
245
|
+
|
|
199
246
|
## Docs - documentation, SDK integration, dashboard links
|
|
200
247
|
|
|
201
248
|
Use when: looking up docs, integrating/debugging an SDK, linking dashboard pages,
|
|
@@ -221,20 +268,46 @@ do not automatically upgrade it.
|
|
|
221
268
|
|
|
222
269
|
| Job | Bundled instructions | Print instructions with the installed CLI |
|
|
223
270
|
| --- | --- | --- |
|
|
224
|
-
| Full setup | `workflows/integrate/playbook.md` + the `<framework>.md` beside it (`ios`, `android`, `expo`, `react-native`, `flutter`), then `workflows/placements/` and `workflows/dashboard/` | `superwall integrate
|
|
225
|
-
| Placements at feature gates | `workflows/placements/playbook.md` + `strategy.md` + the `<framework>.md` beside it |
|
|
226
|
-
| Entitlements, products, campaigns | `workflows/dashboard/playbook.md` + `setup.md` |
|
|
227
|
-
| Existing setup review | `workflows/review/playbook.md` + the `<framework>.md` beside it (not `references/`, which is the CLI and API) | `superwall review
|
|
228
|
-
| Provider migration | `workflows/migrate/playbook.md` + `revenuecat.md` / `adapty.md` / `qonversion.md` beside it | `superwall migrate
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
271
|
+
| Full setup | `workflows/integrate/playbook.md` + the `<framework>.md` beside it (`ios`, `android`, `expo`, `react-native`, `flutter`), then `workflows/placements/` and `workflows/dashboard/` | `superwall integrate` |
|
|
272
|
+
| Placements at feature gates | `workflows/placements/playbook.md` + `strategy.md` + the `<framework>.md` beside it | part of `superwall integrate` |
|
|
273
|
+
| Entitlements, products, campaigns | `workflows/dashboard/playbook.md` + `setup.md` | part of `superwall integrate` |
|
|
274
|
+
| Existing setup review | `workflows/review/playbook.md` + the `<framework>.md` beside it (not `references/`, which is the CLI and API) | `superwall review` (`--fix` for safe fixes) |
|
|
275
|
+
| Provider migration | `workflows/migrate/playbook.md` + `revenuecat.md` / `adapty.md` / `qonversion.md` beside it | `superwall migrate` |
|
|
276
|
+
| Editor paywall → code | the `superwall-framework` skill's `references/migrate-from-editor.md`, after `superwall create --from <paywall-id>` | `superwall migrate <paywall-id>` |
|
|
277
|
+
| Native screen → surface | the `superwall-framework` skill's `references/migrate-from-native.md` + `native/<framework>.md`, after `superwall migrate --screen <path>` | `superwall migrate --screen <path>` |
|
|
278
|
+
|
|
279
|
+
The CLI bundles this skill and `superwall-framework` at build time as an
|
|
280
|
+
offline fallback, installs the live repo at `superwall login`, and reads the
|
|
281
|
+
installed live copy first, so `--skill`, headless runs and what you read here
|
|
282
|
+
are the same, newest text.
|
|
283
|
+
|
|
284
|
+
## Feedback - report what's broken, yourself
|
|
285
|
+
|
|
286
|
+
`superwall feedback` goes straight to the Superwall team. **You own it, not the
|
|
287
|
+
user.** Whenever you confirm something in Superwall doesn't work as it should,
|
|
288
|
+
report it before you move on, however small: a CLI command that errors or
|
|
289
|
+
returns wrong data, an SDK behaving against its docs, a doc that's wrong or
|
|
290
|
+
missing, a skill instruction that led you astray, a confusing error, a
|
|
291
|
+
dashboard/API mismatch, a workflow the user had to work around. Ideas and
|
|
292
|
+
missing features count too (`--kind idea`).
|
|
293
|
+
|
|
294
|
+
- **Confirm first.** Report only once you've reproduced it or ruled out your own
|
|
295
|
+
mistake (typo, wrong flag, stale CLI: `superwall upgrade`). One confirmed
|
|
296
|
+
report beats three guesses.
|
|
297
|
+
- **Write the report yourself, reproducible.** You have the context; the user
|
|
298
|
+
shouldn't have to. Title; what you ran, expected and got; the `--app` /
|
|
299
|
+
`--project` it happened in; every ID and version a teammate needs to
|
|
300
|
+
reproduce it as `--context key=value` (paywall, placement, campaign,
|
|
301
|
+
product, SDK and framework versions, device/OS); the error or log via
|
|
302
|
+
`--file`. CLI version, OS, agent, and the logged-in email and org are added
|
|
303
|
+
automatically, so the team can reach the user.
|
|
304
|
+
- **Then send it.** Tell the user in one line what you're sending ("Reporting to
|
|
305
|
+
Superwall: `push` 413s on assets over 2 MB - ok?") and send on a yes. If the
|
|
306
|
+
user has said you can send feedback without asking, just send it and mention
|
|
307
|
+
it after. Never make the user write or run it.
|
|
308
|
+
- **Strip secrets and customer data**: API keys, tokens, `.p8` contents,
|
|
309
|
+
end-user emails or IDs. Org and email of the logged-in account go along
|
|
310
|
+
automatically for follow-up.
|
|
238
311
|
|
|
239
312
|
Before reporting a bug, make sure it still happens on the latest CLI: it may
|
|
240
313
|
already be fixed.
|
|
@@ -246,5 +319,17 @@ already be fixed.
|
|
|
246
319
|
nothing. Still broken → report it, with the version you reproduced it on.
|
|
247
320
|
|
|
248
321
|
```bash
|
|
249
|
-
superwall feedback "
|
|
322
|
+
superwall feedback "Ran X; expected Y; got Z. Steps: 1… 2… 3…" \
|
|
323
|
+
--title "push 413s on assets over 2MB" --kind bug \
|
|
324
|
+
--command "superwall push" --project 7 --app 123 \
|
|
325
|
+
--context paywall=pw_abc --context sdk=expo@3.1.0 --context expo=54 \
|
|
326
|
+
--file push.log --json
|
|
250
327
|
```
|
|
328
|
+
|
|
329
|
+
`--kind`: `bug` | `docs` | `idea` | `praise` | `other`. `--file` repeats (max 5,
|
|
330
|
+
`-` reads stdin; long logs keep their last 20k chars).
|
|
331
|
+
|
|
332
|
+
Without a shell (the MCP, the dashboard agent), the `feedback` tool sends the
|
|
333
|
+
same report. It takes the same fields but can't attach files: paste the part of
|
|
334
|
+
the log that matters into the message, and pass the app so the team can find
|
|
335
|
+
the account.
|
|
@@ -113,6 +113,16 @@ command can't tell which project or app you mean, the error names the first ten
|
|
|
113
113
|
with their ids. `bootstrap --app <id>` (or `--project <id>`) loads one project's
|
|
114
114
|
tree instead of the whole account.
|
|
115
115
|
|
|
116
|
+
**Large accounts.** Every `list` takes `--search <text>` (matches id, name,
|
|
117
|
+
identifier or bundle id, case-insensitively) and `--limit <n>`. With `--json` a
|
|
118
|
+
list returns every row unless `--limit` caps it; in a terminal it shows 50 and
|
|
119
|
+
says how many more. Search instead of paging through a thousand paywalls:
|
|
120
|
+
`superwall paywalls list --app <id> --search winback --json`. `apps list --search`
|
|
121
|
+
keeps a matching project whole and otherwise only its matching apps. When a
|
|
122
|
+
command can't tell which project or app you mean, the error names the first ten
|
|
123
|
+
with their ids. `bootstrap --app <id>` (or `--project <id>`) loads one project's
|
|
124
|
+
tree instead of the whole account.
|
|
125
|
+
|
|
116
126
|
### Create
|
|
117
127
|
|
|
118
128
|
```bash
|
|
@@ -361,8 +371,9 @@ tables, query patterns, and performance guardrails.
|
|
|
361
371
|
```bash
|
|
362
372
|
superwall doctor --json # health-check the integration
|
|
363
373
|
superwall skills # install the Superwall agent skills into your agent
|
|
364
|
-
superwall upgrade #
|
|
365
|
-
superwall feedback "..."
|
|
374
|
+
superwall upgrade # update the CLI to the latest version
|
|
375
|
+
superwall feedback "..." --title "..." --kind bug --file log.txt --json
|
|
376
|
+
# report a bug or idea to the Superwall team (see SKILL.md › Feedback)
|
|
366
377
|
```
|
|
367
378
|
|
|
368
379
|
## Agent workflows
|
|
@@ -846,13 +846,12 @@ GROUP BY variantId ORDER BY variantId
|
|
|
846
846
|
|
|
847
847
|
# Related Tables (Not Documented Here But Referenced)
|
|
848
848
|
|
|
849
|
-
| Table
|
|
850
|
-
|
|
|
851
|
-
| `
|
|
852
|
-
| `open_revenue.
|
|
853
|
-
| `
|
|
854
|
-
| `sw.
|
|
855
|
-
| `sw.user_aliases_rep` | User ID to alias mappings (use FINAL, filter isDeleted=0) |
|
|
849
|
+
| Table | Purpose |
|
|
850
|
+
| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
851
|
+
| `open_revenue.attributed_events_by_experiment_rep_next` | Revenue by A/B experiment (use FINAL) |
|
|
852
|
+
| `open_revenue.sdk_events_agg` | Pre-aggregated SDK events - prefer over `events_rep` for counts/uniques. Uses AggregateFunction columns. |
|
|
853
|
+
| `sw.device_attributes_rep` | Device-level attributes (use FINAL, filter isDeleted=0) |
|
|
854
|
+
| `sw.user_aliases_rep` | User ID to alias mappings (use FINAL, filter isDeleted=0) |
|
|
856
855
|
|
|
857
856
|
#### `open_revenue.sdk_events_agg` Quick Reference
|
|
858
857
|
|
|
@@ -895,7 +894,7 @@ sw.applications_rep (applicationId)
|
|
|
895
894
|
|
|
896
895
|
#### Finding an Application
|
|
897
896
|
|
|
898
|
-
1. Search `
|
|
897
|
+
1. Search `sw.applications_rep` by name
|
|
899
898
|
2. If multiple results, check `sw.events_hr_agg` for recent event counts
|
|
900
899
|
3. Show `applicationId` + link: `superwall.com/applications/:applicationId`
|
|
901
900
|
|
|
@@ -62,7 +62,8 @@ placement (in code) → campaign (routes it) → audience (who) → paywal
|
|
|
62
62
|
|
|
63
63
|
- What already existed (ids).
|
|
64
64
|
- What you created: entitlement, product ids, campaign ids, placements attached.
|
|
65
|
-
- **Left manual:** paywall design
|
|
65
|
+
- **Left manual:** paywall design - as code with the superwall framework (`superwall create` →
|
|
66
|
+
`superwall publish`) or in the dashboard editor - attaching products to the paywall, and - if
|
|
66
67
|
products were created by hand - reconciling identifiers with App Store Connect / Google Play.
|
|
67
68
|
|
|
68
69
|
See `setup.md` (beside this file) for the App Store Connect import path, `.storekit` generation, and pricing-flag reference.
|
|
@@ -91,7 +91,9 @@ superwall campaigns placements create <campaignId> --event-name another_placemen
|
|
|
91
91
|
|
|
92
92
|
## What the CLI cannot do (leave manual)
|
|
93
93
|
|
|
94
|
-
- **Design the paywall** -
|
|
94
|
+
- **Design the paywall** - either as code with the superwall framework (`superwall create` scaffolds
|
|
95
|
+
a `superwall/` directory in the app; products are declared in the paywall's `config.ts`;
|
|
96
|
+
`superwall publish` ships it) or in the dashboard's paywall editor.
|
|
95
97
|
`superwall paywalls list --project <id> --app <id> --json` shows what exists.
|
|
96
98
|
- **Configure audiences / experiment splits** beyond the default - done in the dashboard.
|
|
97
99
|
|
|
@@ -70,8 +70,10 @@ While reading the app, note any screen the user would rather change
|
|
|
70
70
|
without a release: a paywall or offer, onboarding, an update-required or
|
|
71
71
|
force-upgrade screen, a rate-us or notifications prompt, an announcement,
|
|
72
72
|
a consent change. Mention them in your closing note as candidates for a
|
|
73
|
-
Superwall
|
|
74
|
-
placement. Don't build them here;
|
|
73
|
+
Superwall surface (`superwall create` in the app, built with the
|
|
74
|
+
`superwall-framework` skill) behind a placement. Don't build them here;
|
|
75
|
+
the placements step wires the triggers and the framework skill builds the
|
|
76
|
+
screens.
|
|
75
77
|
|
|
76
78
|
## Definition of done
|
|
77
79
|
|
|
@@ -15,12 +15,12 @@ This migrates the **SDK integration**, not the whole product. Checklist:
|
|
|
15
15
|
- [ ] Swap SDK calls (activate→configure, access-level reads, present → placement, identify) (§5)
|
|
16
16
|
- [ ] Build + verify each placement; Restore Purchases as an existing subscriber (§7)
|
|
17
17
|
- [ ] FULL only: remove Adapty dependency once verified
|
|
18
|
-
- [ ] Hand back to user: **rebuild paywalls** (dashboard editor), attach products, connect ASC/Play
|
|
18
|
+
- [ ] Hand back to user: **rebuild paywalls** (superwall framework or dashboard editor), attach products, connect ASC/Play
|
|
19
19
|
|
|
20
20
|
> **Important - what does NOT migrate:**
|
|
21
21
|
>
|
|
22
22
|
> - **Adapty paywall designs** (Paywall Builder / remote config) cannot be imported - they are
|
|
23
|
-
> **rebuilt** in the dashboard editor.
|
|
23
|
+
> **rebuilt** - as code with the superwall framework or in the dashboard editor.
|
|
24
24
|
> - **Historical analytics / attribution** stays in Adapty.
|
|
25
25
|
> - **Subscriber base:** there is currently no server-side subscriber migration from Adapty.
|
|
26
26
|
> Existing subscribers keep access because their purchases live with the store (StoreKit /
|
|
@@ -191,7 +191,7 @@ regardless) vs gated (only when entitled). Peek: `Superwall.shared.getPresentati
|
|
|
191
191
|
## 7. Order of operations + safety
|
|
192
192
|
|
|
193
193
|
1. Re-create entitlements/products/campaign+placements (CLI); import products from ASC/Play so ids match.
|
|
194
|
-
2. **Rebuild** paywalls (dashboard editor), attach products (hand-back to user - designs do not import).
|
|
194
|
+
2. **Rebuild** paywalls (superwall framework or dashboard editor), attach products (hand-back to user - designs do not import).
|
|
195
195
|
3. Add Superwall SDK alongside Adapty; configure it.
|
|
196
196
|
4. Replace `getPaywall`/present call sites with `register(placement:)`; replace access-level reads with `subscriptionStatus`.
|
|
197
197
|
5. Build, present each placement, Restore Purchases as an existing subscriber, confirm `subscriptionStatus.isActive`.
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
> **Important - what does and does not migrate:**
|
|
4
4
|
>
|
|
5
|
-
> - Paywall designs are rebuilt from scratch
|
|
5
|
+
> - Paywall designs are rebuilt from scratch - as code with the superwall framework
|
|
6
|
+
> (`superwall create`) or in the dashboard editor.
|
|
6
7
|
> - Historical analytics and attribution stay in the old provider.
|
|
7
8
|
> - Adapty/Qonversion subscribers do not currently move server-side; existing
|
|
8
9
|
> purchases are recovered from the store through Restore Purchases.
|
|
@@ -15,11 +15,11 @@ This migrates the **SDK integration**, not the whole product. Checklist:
|
|
|
15
15
|
- [ ] Swap SDK calls (init→configure, entitlement reads, present → placement, identify) (§5)
|
|
16
16
|
- [ ] Build + verify each placement; Restore Purchases as an existing subscriber (§7)
|
|
17
17
|
- [ ] FULL only: remove Qonversion dependency once verified
|
|
18
|
-
- [ ] Hand back to user: **rebuild paywalls** (dashboard editor), attach products, connect ASC/Play
|
|
18
|
+
- [ ] Hand back to user: **rebuild paywalls** (superwall framework or dashboard editor), attach products, connect ASC/Play
|
|
19
19
|
|
|
20
20
|
> **Important - what does NOT migrate:**
|
|
21
21
|
>
|
|
22
|
-
> - **Qonversion paywall UI** cannot be imported - paywalls are **rebuilt** in the dashboard editor.
|
|
22
|
+
> - **Qonversion paywall UI** cannot be imported - paywalls are **rebuilt** - as code with the superwall framework or in the dashboard editor.
|
|
23
23
|
> - **Historical analytics / attribution** stays in Qonversion.
|
|
24
24
|
> - **Subscriber base:** there is currently no server-side subscriber migration from Qonversion.
|
|
25
25
|
> Existing subscribers keep access because their purchases live with the store (StoreKit /
|
|
@@ -189,7 +189,7 @@ regardless) vs gated (only when entitled). Peek: `Superwall.shared.getPresentati
|
|
|
189
189
|
## 7. Order of operations + safety
|
|
190
190
|
|
|
191
191
|
1. Re-create entitlements/products/campaign+placements (CLI); import products from ASC/Play so ids match.
|
|
192
|
-
2. **Rebuild** paywalls (dashboard editor), attach products (hand-back to user - designs do not import).
|
|
192
|
+
2. **Rebuild** paywalls (superwall framework or dashboard editor), attach products (hand-back to user - designs do not import).
|
|
193
193
|
3. Add Superwall SDK alongside Qonversion; configure it.
|
|
194
194
|
4. Replace offering-fetch/present call sites with `register(placement:)`; replace `checkEntitlements` reads with `subscriptionStatus`.
|
|
195
195
|
5. Build, present each placement, Restore Purchases as an existing subscriber, confirm `subscriptionStatus.isActive`.
|
|
@@ -26,11 +26,11 @@ This migrates the **SDK integration**, not the whole product. Checklist:
|
|
|
26
26
|
`pk_` key / bundle id BEFORE any create; wrong account → stop dashboard work loudly (§4)
|
|
27
27
|
- [ ] Build + verify each placement; Restore Purchases as an existing subscriber (§7)
|
|
28
28
|
- [ ] FULL only: remove RC dependency once verified
|
|
29
|
-
- [ ] Hand back to user: **rebuild paywalls** (dashboard editor), attach products, connect ASC/Play
|
|
29
|
+
- [ ] Hand back to user: **rebuild paywalls** (superwall framework or dashboard editor), attach products, connect ASC/Play
|
|
30
30
|
|
|
31
31
|
> **Important - what does and does NOT migrate:**
|
|
32
32
|
>
|
|
33
|
-
> - **RC paywall designs** cannot be imported - they are **rebuilt** in the dashboard editor.
|
|
33
|
+
> - **RC paywall designs** cannot be imported - they are **rebuilt** - as code with the superwall framework or in the dashboard editor.
|
|
34
34
|
> - **Historical analytics / attribution** stays in RevenueCat.
|
|
35
35
|
> - **Subscriber base:** Superwall provides server-side RevenueCat migration tooling that ports
|
|
36
36
|
> subscription history and entitlement state - fetch the migration guide (Docs access below)
|
|
@@ -53,7 +53,7 @@ curl -sL https://www.revenuecat.com/docs/llms.txt
|
|
|
53
53
|
| RevenueCat | Superwall | Notes |
|
|
54
54
|
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
55
55
|
| Product (store SKU wrapped in RC dashboard) | **Product** (re-created) | Keep the SAME App Store / Play product identifier. Only the management layer moves. |
|
|
56
|
-
| Package (`$rc_monthly`, inside an Offering) | (no direct equal) | A package is just "product + duration slot." In Superwall you attach the raw products to a paywall (in the editor). |
|
|
56
|
+
| Package (`$rc_monthly`, inside an Offering) | (no direct equal) | A package is just "product + duration slot." In Superwall you attach the raw products to a paywall (in its `config.ts` with the framework, or in the editor). |
|
|
57
57
|
| Offering (remote set of packages) | **Paywall** + **Campaign** | RC picks products remotely via Offering; Superwall picks the whole paywall (products included) remotely via Campaign rules. |
|
|
58
58
|
| Entitlement (e.g. `pro`) | **Entitlement** (re-created) | 1:1. Recreate each RC entitlement id as a Superwall entitlement. |
|
|
59
59
|
| `customerInfo.entitlements.active` | `Superwall.shared.subscriptionStatus` (`.active(Set<Entitlement>)` / `.inactive` / `.unknown`) | Status is device-derived in FULL mode. |
|
|
@@ -358,7 +358,7 @@ Set per placement in the paywall editor (**General → Feature Gating**):
|
|
|
358
358
|
## 7. Order of operations + safety
|
|
359
359
|
|
|
360
360
|
1. Re-create entitlements, products, campaign + placements in the dashboard (CLI). Import products from ASC/Play so ids match.
|
|
361
|
-
2. **Rebuild** paywalls (dashboard editor) and attach products (hand-back to user - designs do not import).
|
|
361
|
+
2. **Rebuild** paywalls (superwall framework or dashboard editor) and attach products (hand-back to user - designs do not import).
|
|
362
362
|
3. Add Superwall SDK alongside RC (don't rip RC yet). Configure it.
|
|
363
363
|
4. Replace presentation call sites with `register(placement:)`; replace entitlement reads with `subscriptionStatus`.
|
|
364
364
|
5. Build, run, present each placement; **Restore Purchases** as an existing subscriber and confirm `subscriptionStatus.isActive`.
|
|
@@ -1,10 +1,48 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: superwall-editor
|
|
3
|
-
description:
|
|
3
|
+
description: LEGACY — drives the browser (visual) paywall editor over a pairing code. For any screen an agent builds, use superwall-framework instead (paywalls, onboarding, update-required, lifecycle prompts, announcements, offers and web flows, as React code); to move an existing editor paywall onto it, run `superwall migrate <paywall-id>`. Use this skill only when the user explicitly wants to edit inside the visual editor, or to read an editor paywall before migrating it. Covers attach/call/release, native sw-* elements and the editor tool surface.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Superwall Paywall Editor
|
|
7
7
|
|
|
8
|
+
> [!WARNING]
|
|
9
|
+
> **LEGACY. For agents, the visual editor is the second choice.** Any screen
|
|
10
|
+
> an agent builds (a paywall, an onboarding, an update-required screen, a
|
|
11
|
+
> lifecycle prompt, an announcement, an offer, a web flow) belongs in the
|
|
12
|
+
> **superwall framework**: a React mini-app in the user's repo, reviewed as
|
|
13
|
+
> code, localized from message files, previewed in the studio on every
|
|
14
|
+
> device, and shipped with `superwall push` / `promote`. Use the
|
|
15
|
+
> `superwall-framework` skill. If it isn't installed:
|
|
16
|
+
>
|
|
17
|
+
> ```bash
|
|
18
|
+
> npx skills add https://github.com/superwall/skills --skill superwall-framework --global --yes --agent claude-code universal --full-depth
|
|
19
|
+
> ```
|
|
20
|
+
>
|
|
21
|
+
> The framework is in public beta: for now the CLI has its commands only
|
|
22
|
+
> while `SUPERWALL_CHANNEL=next` is set (an `Unknown command: create` means
|
|
23
|
+
> it is missing; ask the user to set it in their shell rc and relaunch).
|
|
24
|
+
>
|
|
25
|
+
> **An editor paywall moves over in one command:**
|
|
26
|
+
>
|
|
27
|
+
> ```bash
|
|
28
|
+
> superwall migrate <paywall-id>
|
|
29
|
+
> ```
|
|
30
|
+
>
|
|
31
|
+
> It scaffolds the paywall as code, briefs the rebuild (the framework
|
|
32
|
+
> skill's `references/migrate-from-editor.md` is the playbook), and shows
|
|
33
|
+
> the original beside the new one in the studio (Compare › Original). The
|
|
34
|
+
> original keeps serving until a campaign is switched to the new one, so
|
|
35
|
+
> nothing changes for users until then.
|
|
36
|
+
>
|
|
37
|
+
> **What to do here:**
|
|
38
|
+
>
|
|
39
|
+
> - Asked to build any new screen: build it with the framework, not here.
|
|
40
|
+
> - Asked to change an editor paywall: offer the migration first, in one
|
|
41
|
+
> line, saying what it gains (code review, localization files, any
|
|
42
|
+
> component library, the same studio for every screen). If the user
|
|
43
|
+
> says no or wants a quick edit in place, continue with this skill.
|
|
44
|
+
> - Never migrate unprompted, and never refuse an explicit editor request.
|
|
45
|
+
|
|
8
46
|
Paywalls are built in a browser editor that exposes its tools over an authenticated relay. This skill drives the same surface used by the MCP gateway, so every tool runs inside the live browser session the user has open.
|
|
9
47
|
|
|
10
48
|
## When to use
|
|
@@ -59,3 +97,17 @@ Full CLI reference: [references/cli.md](references/cli.md).
|
|
|
59
97
|
- `session_locked`: another client is already attached. The user either attached from another MCP client, or a previous CLI attachment wasn't released. They can detach from the editor UI and you can retry.
|
|
60
98
|
- `unauthorized`: the controller token is stale. Re-attach with a fresh pairing code.
|
|
61
99
|
- `attach_failed: provide a valid current pairingCode`: pairing codes expire after ~10 minutes and rotate on detach. Ask the user to show you the current one.
|
|
100
|
+
|
|
101
|
+
## Report what's broken
|
|
102
|
+
|
|
103
|
+
When you confirm an editor tool misbehaves (wrong result, a crash, a schema
|
|
104
|
+
that doesn't match `tools`, a doc here that's wrong), report it yourself:
|
|
105
|
+
write it with every ID needed to reproduce it, tell the user in one line,
|
|
106
|
+
send on their yes (or straight away if they've said you may). Strip secrets
|
|
107
|
+
and customer data.
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
superwall feedback "Called X with Y; expected Z; got W." --title "..." \
|
|
111
|
+
--kind bug --command "sw-editor.sh call <tool>" --app <id> \
|
|
112
|
+
--context paywall=<id> --file error.json --json
|
|
113
|
+
```
|
|
@@ -43,8 +43,8 @@ Entry points: `superwall` (SuperwallProvider — mounted for you),
|
|
|
43
43
|
`superwall/config`, `superwall/hooks`, `superwall/navigation`,
|
|
44
44
|
`superwall/assets`.
|
|
45
45
|
|
|
46
|
-
The framework
|
|
47
|
-
`create`/`dev`/`push`/`promote`/`publish` and the rebuild forms of `migrate`
|
|
46
|
+
The framework is in public beta. Until the CLI turns them on by default, it
|
|
47
|
+
has `create`/`dev`/`push`/`promote`/`publish` and the rebuild forms of `migrate`
|
|
48
48
|
only while `SUPERWALL_CHANNEL=next` is set in the environment.
|
|
49
49
|
`Unknown command: create` means the variable is missing from your
|
|
50
50
|
environment: ask the user to set it globally (shell rc) and relaunch.
|
|
@@ -59,8 +59,8 @@ web page inside an app.
|
|
|
59
59
|
| --- | --- |
|
|
60
60
|
| **Any onboarding, quiz, survey or multi-page funnel that asks questions — must-follow.** Every answer a typed user attribute (`useUserAttribute`) saved the moment it is given, one `next` for the buttons and `entry`, `replayStack` resuming at the first unanswered question of the user's branch, attribute naming, back and "Start over" after resuming | [references/onboarding-state.md](references/onboarding-state.md) |
|
|
61
61
|
| The layout system — the DOM the framework renders, what fixed / absolute / sticky resolve against, insets (config, variables, precedence, the floor table per device and presentation), scrolling, recipes, and the debugging order for "it's under the status bar" | [references/layout.md](references/layout.md) |
|
|
62
|
-
| Mobile design craft — press feedback, hover gating, inputs and the keyboard, motion values, type, worst-case content, dark mode, platform conventions, the pre-ship audit. **Read it for every new screen, and especially when there is no design reference: its values are then the design.** | the **`mobile-design`** skill (install: `npx skills add https://github.com/superwall/skills
|
|
63
|
-
| Writing the questions of an onboarding or web2app funnel — what to ask, in what order, the branching, the statements, which answers predict revenue | the **`onboarding-questions`** skill (install: `npx skills add https://github.com/superwall/skills
|
|
62
|
+
| Mobile design craft — press feedback, hover gating, inputs and the keyboard, motion values, type, worst-case content, dark mode, platform conventions, the pre-ship audit. **Read it for every new screen, and especially when there is no design reference: its values are then the design.** | the **`mobile-design`** skill (install: `npx skills add https://github.com/superwall/skills --skill mobile-design --global --yes --agent claude-code universal --full-depth`); what the framework adds to it (the skeleton, insets, scrolling, its hooks) is [references/mobile-design.md](references/mobile-design.md) |
|
|
63
|
+
| Writing the questions of an onboarding or web2app funnel — what to ask, in what order, the branching, the statements, which answers predict revenue | the **`onboarding-questions`** skill (install: `npx skills add https://github.com/superwall/skills --skill onboarding-questions --global --yes --agent claude-code universal --full-depth`) |
|
|
64
64
|
| Animating an onboarding's page hand-offs — the chosen answer becoming the progress bar or the next hero, exits and entrances tied to the copy, mapped onto the router | the **`animate-onboarding`** skill (install: `… --skill animate-onboarding …`) |
|
|
65
65
|
| Responsive — 320px → tablet → desktop, short phones, landscape, dynamic type, sheets/drawers/popups, the verification matrix | `references/responsive.md` in the **`mobile-design`** skill |
|
|
66
66
|
| dev/push/promote/publish, creating products yourself, renames, several platforms, CI | [references/cli.md](references/cli.md) |
|
|
@@ -89,7 +89,7 @@ curl -sL https://superwall.com/docs/framework/{page}.md # one page
|
|
|
89
89
|
| Declaring products, reading variables, the three price rules | `products` |
|
|
90
90
|
| `purchase()` outcomes, restore, the two channels | `purchases` |
|
|
91
91
|
| Introductory-offer eligibility forking (`useIntroductoryOffer`), reminder notifications | `trials` |
|
|
92
|
-
| Selling on the web — modes, prefetch, the Stripe sheet, hosted checkout, promotion codes (`useDiscount`), the shopper's email, after the purchase (`postPurchase`, `useCheckoutRedemption`), `stripeMetadata`, managed payments; a Stripe product inside an iOS app (app to web: always hosted checkout, priced from the dashboard at push) | `web-checkout`, `products` |
|
|
92
|
+
| Selling on the web — modes, prefetch, the Stripe sheet, hosted checkout, promotion codes (`useDiscount`), the shopper's email, after the purchase (`postPurchase`, `useCheckoutRedemption`), `stripeMetadata`, managed payments, blocking prepaid cards (`prepaidCards`); a Stripe product inside an iOS app (app to web: always hosted checkout, priced from the dashboard at push) | `web-checkout`, `products` |
|
|
93
93
|
| Custom store products (external purchase controller, custom-store Stripe products) — declared by identifier, pushed with the dashboard's store | `products` |
|
|
94
94
|
| Continuing a flow on the web (teleport: `teleport: true` or `{ route, fallbacks, completion, … }`, `router.push(route, { teleport: true })`, prefetch, the teleport screen, `useTeleport`'s typed status, returning to the app) | `teleport` |
|
|
95
95
|
| Web funnels — answers in the URL (`useQueryState`), resume after a browser hand-off, `shift` | `web-funnels` |
|
|
@@ -133,6 +133,11 @@ Docs beyond the framework (dashboard, SDKs, web checkout setup):
|
|
|
133
133
|
`stripeMetadata` to `purchase()` for key/values on the Stripe subscription,
|
|
134
134
|
and `checkout` to override the config's mode for one button (never past
|
|
135
135
|
the iOS rule: in an iOS app a Stripe purchase always opens hosted checkout).
|
|
136
|
+
`prepaidCards: "block"` in `checkout: { mode, prepaidCards }` makes Stripe
|
|
137
|
+
refuse prepaid cards on the sheet and hosted checkout (default `"allow"`);
|
|
138
|
+
`purchase()` and `prefetch()` take `prepaidCards` to override it for one
|
|
139
|
+
product, and a teleport carries the rule to the web page. Apple Pay can't
|
|
140
|
+
filter card types, so in `applePay` mode only the sheet fallback enforces it.
|
|
136
141
|
The shape every buy button has, all three outcomes handled:
|
|
137
142
|
|
|
138
143
|
```tsx
|
|
@@ -35,7 +35,7 @@ Inside the store (`typeName` on every record):
|
|
|
35
35
|
|
|
36
36
|
| Record | What it is | Becomes |
|
|
37
37
|
| --- | --- | --- |
|
|
38
|
-
| `paywall` | settings: `presentationStyleV3`, `featureGating`, `isScrollEnabled`, `onDeviceCache`, `gameControllerSupport`, `webCheckoutDestination` | already in `config.ts` |
|
|
38
|
+
| `paywall` | settings: `presentationStyleV3`, `featureGating`, `isScrollEnabled`, `onDeviceCache`, `gameControllerSupport`, `webCheckoutDestination`, `prepaidCards` | already in `config.ts` |
|
|
39
39
|
| `paywall_product:<ref>` | a product slot, with `productVariables` (the example prices the editor rendered with) | `products.<ref>` in `config.ts`; the identifier is `"missing"` on templates and must be fixed |
|
|
40
40
|
| `paywall_language:<locale>` | a translated locale | `messages/<locale>.ts` |
|
|
41
41
|
| `node` (`type: stack \| text \| img \| video \| lottie \| icon \| navigation \| drawer`) | the element tree via `parentId`; `props` hold text, media, layout; inline `style`/classes on the rendered HTML hold the design tokens | components and CSS |
|
|
@@ -67,7 +67,8 @@ is whichever slot the selection state points at.
|
|
|
67
67
|
| `set-state` | set the matching React state |
|
|
68
68
|
| `set-attribute` | the setter of `useUserAttribute(key, parser)`, one hook per attribute (`useActions().setUserAttributes` is deprecated) |
|
|
69
69
|
| `custom-placement` | `useActions().customPlacement(name, params)` |
|
|
70
|
-
| `custom-in-app` | `useActions().
|
|
70
|
+
| `custom-in-app` (Custom Action) | `useActions().customAction(data)`: the app's existing `handleCustomPaywallAction(withName:)` handler receives `data` as the name. Fire-and-forget, nothing comes back: when the paywall needs the app's answer (the handler's result decides what the paywall does next), use `useActions().requestCallback(name)` instead and register that callback in the app. A Liquid-rendered `data` becomes a string you build in code |
|
|
71
|
+
| `request-callback` (Custom Callback) | `useActions().requestCallback(name, { behavior, variables })`; `onSuccess`/`onFailure` become code on the resolved `status` (docs: `actions`) |
|
|
71
72
|
| `request-permission` | `useActions().requestPermission(type)`; `onGranted`/`onDenied` become the resolved status |
|
|
72
73
|
| `request-store-review` | `useActions().requestStoreReview()` |
|
|
73
74
|
| `redeem-discount` | `useDiscount().redeem(code)` |
|
|
@@ -7,7 +7,7 @@ Read it for every new screen, and especially when there is no design
|
|
|
7
7
|
reference: its values are then the design. If it is not installed:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npx skills add https://github.com/superwall/skills
|
|
10
|
+
npx skills add https://github.com/superwall/skills --skill mobile-design --global --yes --agent claude-code universal --full-depth
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
This file is only what the framework adds to that: the DOM it renders, the
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import "./token-
|
|
1
|
+
import "./token-CPplNMVa.js";
|
|
2
2
|
import "./output-Ggzq5_-t.js";
|
|
3
|
-
import "./environment-
|
|
4
|
-
import "./storage-
|
|
5
|
-
import "./client-
|
|
3
|
+
import "./environment-DBwo79dy.js";
|
|
4
|
+
import "./storage-Po9E-CHL.js";
|
|
5
|
+
import "./client-BF9rCULI.js";
|
|
6
6
|
import "./config-BO1Y87kV.js";
|
|
7
|
-
import "./telemetry-
|
|
7
|
+
import "./telemetry-s6dag6tb.js";
|
|
8
8
|
import "./spawn-DmmmHIP-.js";
|
|
9
|
-
import "./spinner-
|
|
9
|
+
import "./spinner-BClMQGGN.js";
|
|
10
10
|
import "./ui-D_qf3Gvw.js";
|
|
11
|
-
import "./paths-
|
|
12
|
-
import { a as bundledSkills, c as knownSkills, d as readBundledSkill, f as runSkills, i as SUPERWALL_SKILLS_SOURCE, l as normalizeSkillFrontmatter, m as skillsRefFor, n as SKILLS_INSTALL_SOURCE, o as checkSkillsSync, p as skillSummary, r as SKILLS_REF, s as ensureSkillsCurrent, t as PLAYBOOKS, u as normalizeSkillsDir } from "./skills-
|
|
11
|
+
import "./paths-BcNbJfpw.js";
|
|
12
|
+
import { a as bundledSkills, c as knownSkills, d as readBundledSkill, f as runSkills, i as SUPERWALL_SKILLS_SOURCE, l as normalizeSkillFrontmatter, m as skillsRefFor, n as SKILLS_INSTALL_SOURCE, o as checkSkillsSync, p as skillSummary, r as SKILLS_REF, s as ensureSkillsCurrent, t as PLAYBOOKS, u as normalizeSkillsDir } from "./skills-DDf10ufO.js";
|
|
13
13
|
|
|
14
14
|
export { PLAYBOOKS, SKILLS_INSTALL_SOURCE, SKILLS_REF, SUPERWALL_SKILLS_SOURCE, bundledSkills, checkSkillsSync, ensureSkillsCurrent, knownSkills, normalizeSkillFrontmatter, normalizeSkillsDir, readBundledSkill, runSkills, skillSummary, skillsRefFor };
|