@redeemid/emdash 0.0.5 → 0.0.6
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 +18 -5
- package/package.json +1 -1
- package/src/access.ts +148 -23
- package/src/blocks-names.ts +1 -1
- package/src/components/AccessBadge.astro +1 -1
- package/src/components/Content.astro +31 -6
- package/src/components/LockedPanel.astro +17 -1
- package/src/config.ts +24 -2
- package/src/plugin.ts +9 -1
- package/src/routes/callback.ts +19 -11
- package/src/storage.ts +23 -0
- package/src/version.ts +1 -1
- package/src/webhooks.ts +3 -3
package/README.md
CHANGED
|
@@ -2,14 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
Shopify customer accounts, member levels and paywalls for [EmDash](https://github.com/emdash-cms/emdash) sites. Shopify runs the store and the customer account; EmDash runs the content.
|
|
4
4
|
|
|
5
|
-
**Status: 0.0.
|
|
5
|
+
**Status: 0.0.6, early.** Runs on Node and Cloudflare Workers. Sign-in, the member mirror, webhooks, levels, rules, the meter and drip, teasers, badges, the page gate, the Shopify cart and checkout are covered by an end-to-end test against a fake store.
|
|
6
6
|
|
|
7
7
|
## What it does
|
|
8
8
|
|
|
9
9
|
- **Sign in with the store's customer account.** Members click "Sign in" on your site, sign in on the store's account page and come back signed in. They become EmDash Subscribers. That role only means "signed in"; it never grants content.
|
|
10
10
|
- **Mirrors the customer.** Email, name, tags and enabled/disabled status, kept current by signed Shopify webhooks.
|
|
11
11
|
- **Levels from tags.** You map Shopify customer tags to levels. Set tags in Shopify Flow or any app; RedeemID only reads them.
|
|
12
|
-
- **Rules
|
|
12
|
+
- **Rules.** Lock a collection, entries with a term (and its child terms), or set a site default; a term can also open its entries to everyone. When several term rules cover an entry, readers must pass all of them.
|
|
13
|
+
- **Meter and drip.** Signed-in readers may open a few locked entries free each month or week. A rule can also drip: members read its entries once they've held their level for so many days.
|
|
13
14
|
- **Teasers and badges.** Locked entries can show their first paragraphs, up to a word count. `<AccessBadge>` names the level an entry needs and shows a lock to readers it keeps out.
|
|
14
15
|
- **Plans, cart and checkout.** `<Plan>` shows a Shopify product's price and adds it to the visitor's Shopify cart; `<Cart>` shows the count and opens Shopify checkout.
|
|
15
16
|
- **Account.** Members get an Account link to their Shopify customer account (orders, profile, addresses) and Sign out, which also ends the Shopify session.
|
|
@@ -49,6 +50,8 @@ const config = {
|
|
|
49
50
|
join: { href: "/join/", label: "Become a member" },
|
|
50
51
|
// Optional: locked posts with no paywall break show the paragraphs within their first 40 words.
|
|
51
52
|
teaser: { posts: 40 },
|
|
53
|
+
// Optional: signed-in readers may open 3 locked posts a month.
|
|
54
|
+
meter: { limit: 3, period: "month", collections: ["posts"] },
|
|
52
55
|
};
|
|
53
56
|
|
|
54
57
|
export default defineConfig({
|
|
@@ -95,8 +98,17 @@ Each rule names a collection and the levels, any of which may read. An empty `le
|
|
|
95
98
|
| `{ collection: "posts", taxonomy: "tag", term: "free-to-read", levels: [], open: true }` | Opens entries with that term to everyone, whatever else covers them |
|
|
96
99
|
| `{ collection: "*", levels: [] }` | The site default, for collections with no rule of their own |
|
|
97
100
|
|
|
101
|
+
| `{ collection: "posts", taxonomy: "category", term: "archive", levels: ["member"], drip: 30 }` | Drip: members read these entries 30 days after their level started |
|
|
102
|
+
| `{ collection: "posts", taxonomy: "category", term: "exclusive", levels: ["pro"], meter: false }` | The meter never opens these entries |
|
|
103
|
+
|
|
98
104
|
Term rules beat the collection's rule, which beats the site default. When several term rules cover one entry (a story in Investigations, Gold, and Culture, Silver), readers must pass every one of them, so only Gold + Silver members read it. Set `combine: "any"` to let one of them be enough.
|
|
99
105
|
|
|
106
|
+
### Meter and drip
|
|
107
|
+
|
|
108
|
+
The meter lets a signed-in reader who can't read an entry open it anyway, `limit` entries per `period` (`"month"`, the default, or `"week"`, in UTC). Each entry counts once per period, when its own page renders through `<Content>` with an `id`; lists, feeds, search and the content API never count. Visitors get the wall and a nudge to sign in. While it runs, `<Content>` says how many free reads are left; when it runs out, the wall says so. Rules with `meter: false` are never metered, and the meter never opens an entry a member is waiting on by drip.
|
|
109
|
+
|
|
110
|
+
Drip holds a rule's entries back from members who pass it until they've held their level for `drip` days. A level starts when the customer first had its tag (for a `match: "all"` level, the last of its tags); with several levels the earliest counts, and with none known, the first sign-in. RedeemID notes when each tag first arrives from sign-in and webhooks, and forgets a tag when Shopify removes it. The wall shows the date the entry opens.
|
|
111
|
+
|
|
100
112
|
## Use it in templates
|
|
101
113
|
|
|
102
114
|
EmDash has no content filter hook, so templates decide what to render. Render the entry body with `<Content>` instead of `<PortableText>`:
|
|
@@ -105,12 +117,12 @@ EmDash has no content filter hook, so templates decide what to render. Render th
|
|
|
105
117
|
---
|
|
106
118
|
import Content from "@redeemid/emdash/components/Content.astro";
|
|
107
119
|
---
|
|
108
|
-
<Content value={post.data.content} collection="posts" terms={post.data.terms}>
|
|
120
|
+
<Content value={post.data.content} collection="posts" terms={post.data.terms} id={post.id}>
|
|
109
121
|
<a slot="locked" href="/join/">Become a member</a>
|
|
110
122
|
</Content>
|
|
111
123
|
```
|
|
112
124
|
|
|
113
|
-
Everything before the first Paywall break block is shown to everyone. What follows reaches the page only for readers the break allows: the levels picked on it ("Signed in" for any member), or when none are picked the entry's rule. With none picked and no rule covering the entry, the break changes nothing
|
|
125
|
+
Everything before the first Paywall break block is shown to everyone. What follows reaches the page only for readers the break allows: the levels picked on it ("Signed in" for any member), or when none are picked the entry's rule. With none picked and no rule covering the entry, the break changes nothing. A body with no break follows the entry's rule as a whole; readers it keeps out see the collection's `teaser` (the paragraphs within that many words, never half a paragraph), if one is set. Plain `<PortableText>` ignores the break and shows everything, so use `<Content>` for any body that may hold one.
|
|
114
126
|
|
|
115
127
|
A "Members only" block starts a part for the levels picked on it (none picked: the entry's rule, or any signed-in member) that runs to the next "Members only: end" block. Readers who can't read it see the wall there, and the body goes on after the end block.
|
|
116
128
|
|
|
@@ -127,7 +139,7 @@ import AccessBadge from "@redeemid/emdash/components/AccessBadge.astro";
|
|
|
127
139
|
<AccessBadge collection="posts" terms={post.data.terms} content={post.data.content} />
|
|
128
140
|
```
|
|
129
141
|
|
|
130
|
-
In your own code (`@redeemid/emdash/access`), `entryRequirement(config, collection, terms)` gives what an entry needs (a list of clauses, each passed by any of its levels, or `null` when open),
|
|
142
|
+
In your own code (`@redeemid/emdash/access`), `entryRequirement(config, collection, terms)` gives what an entry needs (a list of clauses, each passed by any of its levels, or `null` when open), `canRead(Astro, entry)` gives the verdict for the visitor, and `readEntry(Astro, { collection, terms, id })` gives it with drip and the meter applied (and counts a metered read).
|
|
131
143
|
|
|
132
144
|
Put `<Notices />` near the top of your layout. It shows the message for a `?redeemid_notice=` code (see [docs/shopify-setup.md](docs/shopify-setup.md)) and nothing otherwise; pass `messages={{ cart_empty: "…" }}` to reword one.
|
|
133
145
|
|
|
@@ -160,6 +172,7 @@ import { canRead } from "@redeemid/emdash/access";
|
|
|
160
172
|
|
|
161
173
|
const verdict = await canRead(Astro, { collection: "posts", terms: post.data.terms });
|
|
162
174
|
// verdict.allowed, verdict.reason: open | allowed | sign_in | upgrade | disabled
|
|
175
|
+
// readEntry() adds drip (verdict.opensAt) and metered (verdict.meterLeft)
|
|
163
176
|
```
|
|
164
177
|
|
|
165
178
|
Pages rendered for a signed-in member are sent with `Cache-Control: private, no-store`; pages for visitors stay cacheable.
|
package/package.json
CHANGED
package/src/access.ts
CHANGED
|
@@ -32,7 +32,7 @@ export interface Viewer {
|
|
|
32
32
|
levels: string[];
|
|
33
33
|
}
|
|
34
34
|
|
|
35
|
-
export type Reason = "open" | "allowed" | "sign_in" | "upgrade" | "disabled" | "unconfigured";
|
|
35
|
+
export type Reason = "open" | "allowed" | "sign_in" | "upgrade" | "disabled" | "unconfigured" | "drip" | "metered";
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
38
|
* What an entry needs, in conjunctive form: every clause must pass, and a
|
|
@@ -42,7 +42,7 @@ export type Reason = "open" | "allowed" | "sign_in" | "upgrade" | "disabled" | "
|
|
|
42
42
|
export type Requirement = string[][] | null;
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* The built-in level every signed-in member holds
|
|
45
|
+
* The built-in level every signed-in member holds. A clause
|
|
46
46
|
* with it passes for any signed-in member, like an empty clause.
|
|
47
47
|
*/
|
|
48
48
|
export const SIGNED_IN = "signed-in";
|
|
@@ -53,6 +53,12 @@ export interface Verdict {
|
|
|
53
53
|
/** What the entry needs (see Requirement). `[]` when it is open. */
|
|
54
54
|
required: string[][];
|
|
55
55
|
viewer: Viewer;
|
|
56
|
+
/** For "drip": when the entry opens for this member. */
|
|
57
|
+
opensAt?: Date;
|
|
58
|
+
/** For "metered", and for a locked "upgrade" when a meter runs: free entries left this period. */
|
|
59
|
+
meterLeft?: number;
|
|
60
|
+
/** The meter's size and period, when one ran. */
|
|
61
|
+
meter?: { limit: number; period: "month" | "week" };
|
|
56
62
|
}
|
|
57
63
|
|
|
58
64
|
/** A term as EmDash hydrates it onto an entry, or just its slug. */
|
|
@@ -102,26 +108,14 @@ function combined(rules: RuleConfig[], mode: "all" | "any"): string[][] {
|
|
|
102
108
|
return reduce(rules.map((r) => r.levels));
|
|
103
109
|
}
|
|
104
110
|
|
|
105
|
-
/**
|
|
106
|
-
|
|
107
|
-
*
|
|
108
|
-
* Each term the entry carries is walked up its taxonomy (with `tree`) to the
|
|
109
|
-
* nearest term that has a rule, so a child term takes its parent's rule unless
|
|
110
|
-
* it has its own. Any matching `open` rule opens the entry.
|
|
111
|
-
*/
|
|
112
|
-
export function requirement(
|
|
113
|
-
rules: RuleConfig[] = [],
|
|
114
|
-
collection: string,
|
|
115
|
-
terms: Terms = {},
|
|
116
|
-
options: { combine?: "all" | "any"; tree?: TermTree } = {},
|
|
117
|
-
): Requirement {
|
|
118
|
-
const mode = options.combine ?? "all";
|
|
111
|
+
/** The rules that decide an entry: matching term rules, else the collection's, else the site default. */
|
|
112
|
+
function deciding(rules: RuleConfig[], collection: string, terms: Terms, tree?: TermTree): RuleConfig[] | "open" {
|
|
119
113
|
const forCollection = rules.filter((r) => r.collection === collection);
|
|
120
114
|
const matched: RuleConfig[] = [];
|
|
121
115
|
for (const [taxonomy, list] of Object.entries(terms)) {
|
|
122
116
|
const taxRules = forCollection.filter((r) => r.taxonomy === taxonomy && r.term);
|
|
123
117
|
if (taxRules.length === 0) continue;
|
|
124
|
-
const parents =
|
|
118
|
+
const parents = tree?.[taxonomy] ?? {};
|
|
125
119
|
for (const ref of list ?? []) {
|
|
126
120
|
let slug: string | null = slugOf(ref);
|
|
127
121
|
const seen = new Set<string>();
|
|
@@ -136,13 +130,87 @@ export function requirement(
|
|
|
136
130
|
}
|
|
137
131
|
}
|
|
138
132
|
}
|
|
139
|
-
if (matched.some((r) => r.open)) return
|
|
140
|
-
if (matched.length > 0) return
|
|
133
|
+
if (matched.some((r) => r.open)) return "open";
|
|
134
|
+
if (matched.length > 0) return matched;
|
|
141
135
|
const whole = forCollection.filter((r) => !r.taxonomy && !r.term && !r.open);
|
|
142
|
-
if (whole.length > 0) return
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
136
|
+
if (whole.length > 0) return whole;
|
|
137
|
+
return rules.filter((r) => r.collection === "*" && !r.taxonomy && !r.term && !r.open);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* What an entry needs (see Requirement), from the site's rules.
|
|
142
|
+
*
|
|
143
|
+
* Each term the entry carries is walked up its taxonomy (with `tree`) to the
|
|
144
|
+
* nearest term that has a rule, so a child term takes its parent's rule unless
|
|
145
|
+
* it has its own. Any matching `open` rule opens the entry.
|
|
146
|
+
*/
|
|
147
|
+
export function requirement(
|
|
148
|
+
rules: RuleConfig[] = [],
|
|
149
|
+
collection: string,
|
|
150
|
+
terms: Terms = {},
|
|
151
|
+
options: { combine?: "all" | "any"; tree?: TermTree } = {},
|
|
152
|
+
): Requirement {
|
|
153
|
+
const found = deciding(rules, collection, terms, options.tree);
|
|
154
|
+
if (found === "open" || found.length === 0) return null;
|
|
155
|
+
return combined(found, options.combine ?? "all");
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/** Days of membership the entry's deciding rules ask for (the largest drip), or 0. */
|
|
159
|
+
export function dripDays(rules: RuleConfig[] = [], collection: string, terms: Terms = {}, tree?: TermTree): number {
|
|
160
|
+
const found = deciding(rules, collection, terms, tree);
|
|
161
|
+
if (found === "open") return 0;
|
|
162
|
+
return Math.max(0, ...found.map((r) => (typeof r.drip === "number" && r.drip > 0 ? r.drip : 0)));
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/** May the meter open the entry? Not when a deciding rule says `meter: false`. */
|
|
166
|
+
export function meterable(rules: RuleConfig[] = [], collection: string, terms: Terms = {}, tree?: TermTree): boolean {
|
|
167
|
+
const found = deciding(rules, collection, terms, tree);
|
|
168
|
+
return found === "open" || !found.some((r) => r.meter === false);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* When a member's membership started, for drip: the earliest start among the
|
|
173
|
+
* levels they hold now (a level starts when its last needed tag arrived),
|
|
174
|
+
* else when they first signed in. Null when neither is known.
|
|
175
|
+
*/
|
|
176
|
+
export function memberSince(member: MemberRecord, levels: LevelConfig[] = []): string | null {
|
|
177
|
+
const since = member.tagsSince ?? {};
|
|
178
|
+
const starts: string[] = [];
|
|
179
|
+
for (const slug of levelsFor(member.tags, levels)) {
|
|
180
|
+
const level = levels.find((l) => l.slug === slug);
|
|
181
|
+
const dates = (level?.tags ?? []).map((t) => since[t.toLowerCase()]).filter((d): d is string => Boolean(d)).sort();
|
|
182
|
+
if (dates.length === 0) continue;
|
|
183
|
+
const pick = level?.match === "all" ? dates[dates.length - 1] : dates[0];
|
|
184
|
+
if (pick) starts.push(pick);
|
|
185
|
+
}
|
|
186
|
+
starts.sort();
|
|
187
|
+
return starts[0] ?? member.linkedAt ?? null;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/** When drip opens an entry for this member: `since` plus `days`. */
|
|
191
|
+
export function dripOpensAt(since: string | null, days: number): Date | null {
|
|
192
|
+
if (!since || days <= 0) return null;
|
|
193
|
+
const t = Date.parse(since);
|
|
194
|
+
return Number.isNaN(t) ? null : new Date(t + days * 86_400_000);
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
/** The meter period an instant falls in: "2026-11", or ISO week "2026-W45". UTC. */
|
|
198
|
+
export function periodKey(at: Date, period: "month" | "week" = "month"): string {
|
|
199
|
+
if (period === "month") return `${at.getUTCFullYear()}-${String(at.getUTCMonth() + 1).padStart(2, "0")}`;
|
|
200
|
+
const d = new Date(Date.UTC(at.getUTCFullYear(), at.getUTCMonth(), at.getUTCDate()));
|
|
201
|
+
const day = d.getUTCDay() || 7;
|
|
202
|
+
d.setUTCDate(d.getUTCDate() + 4 - day);
|
|
203
|
+
const yearStart = Date.UTC(d.getUTCFullYear(), 0, 1);
|
|
204
|
+
const week = Math.ceil(((d.getTime() - yearStart) / 86_400_000 + 1) / 7);
|
|
205
|
+
return `${d.getUTCFullYear()}-W${String(week).padStart(2, "0")}`;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/** Count `id` against a meter: an item already counted stays free; a new one needs room. Pure. */
|
|
209
|
+
export function consume(items: string[], id: string, limit: number): { allowed: boolean; items: string[]; left: number } {
|
|
210
|
+
if (items.includes(id)) return { allowed: true, items, left: Math.max(0, limit - items.length) };
|
|
211
|
+
if (items.length >= limit) return { allowed: false, items, left: 0 };
|
|
212
|
+
const next = [...items, id];
|
|
213
|
+
return { allowed: true, items: next, left: limit - next.length };
|
|
146
214
|
}
|
|
147
215
|
|
|
148
216
|
/** Does someone holding `held` pass `required`? Signed-in membership is checked by the caller. */
|
|
@@ -290,3 +358,60 @@ export function accountUrl(returnTo = "/"): string {
|
|
|
290
358
|
export function signOutUrl(returnTo = "/"): string {
|
|
291
359
|
return `/_emdash/api/auth/redeemid/logout?return=${encodeURIComponent(safeReturn(returnTo))}`;
|
|
292
360
|
}
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* The entry's verdict with drip and the meter applied, for the entry's own
|
|
364
|
+
* page. Drip narrows a granted verdict; the meter opens a locked one for a
|
|
365
|
+
* signed-in reader while the period has room, and never opens a drip entry.
|
|
366
|
+
*/
|
|
367
|
+
export async function readEntry(
|
|
368
|
+
astro: AstroLike,
|
|
369
|
+
entry: { collection: string; terms?: Terms; id?: string },
|
|
370
|
+
override?: { required: string[][] },
|
|
371
|
+
): Promise<Verdict> {
|
|
372
|
+
const verdict = await canRead(astro, entry, override);
|
|
373
|
+
const locals = astro.locals as Locals;
|
|
374
|
+
const config = siteConfig(locals.emdash?.config);
|
|
375
|
+
if (!config) return verdict;
|
|
376
|
+
|
|
377
|
+
if (verdict.allowed && verdict.reason === "allowed" && verdict.viewer.member) {
|
|
378
|
+
const tree = await termTree(config.rules, entry.collection, entry.terms);
|
|
379
|
+
const days = dripDays(config.rules, entry.collection, entry.terms, tree);
|
|
380
|
+
const opensAt = dripOpensAt(memberSince(verdict.viewer.member, config.levels), days);
|
|
381
|
+
if (days > 0 && (!opensAt || opensAt.getTime() > Date.now())) {
|
|
382
|
+
return { ...verdict, allowed: false, reason: "drip", opensAt: opensAt ?? undefined };
|
|
383
|
+
}
|
|
384
|
+
return verdict;
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
const meter = config.meter;
|
|
388
|
+
const user = locals.user;
|
|
389
|
+
const db = locals.emdash?.db;
|
|
390
|
+
if (
|
|
391
|
+
verdict.reason !== "upgrade" ||
|
|
392
|
+
!meter ||
|
|
393
|
+
!(meter.limit > 0) ||
|
|
394
|
+
!entry.id ||
|
|
395
|
+
!user?.id ||
|
|
396
|
+
!db ||
|
|
397
|
+
(meter.collections && !meter.collections.includes(entry.collection))
|
|
398
|
+
) {
|
|
399
|
+
return verdict;
|
|
400
|
+
}
|
|
401
|
+
if (!meterable(config.rules, entry.collection, entry.terms, await termTree(config.rules, entry.collection, entry.terms))) {
|
|
402
|
+
return verdict;
|
|
403
|
+
}
|
|
404
|
+
const period = meter.period ?? "month";
|
|
405
|
+
const key = `${user.id}:${periodKey(new Date(), period)}`;
|
|
406
|
+
try {
|
|
407
|
+
const s = stores(db);
|
|
408
|
+
const record = (await s.meter.get(key)) ?? { userId: user.id, period: periodKey(new Date(), period), items: [] };
|
|
409
|
+
const used = consume(record.items, `${entry.collection}:${entry.id}`, meter.limit);
|
|
410
|
+
const info = { limit: meter.limit, period };
|
|
411
|
+
if (!used.allowed) return { ...verdict, meterLeft: 0, meter: info };
|
|
412
|
+
if (used.items !== record.items) await s.meter.put(key, { ...record, items: used.items });
|
|
413
|
+
return { ...verdict, allowed: true, reason: "metered", meterLeft: used.left, meter: info };
|
|
414
|
+
} catch {
|
|
415
|
+
return verdict;
|
|
416
|
+
}
|
|
417
|
+
}
|
package/src/blocks-names.ts
CHANGED
|
@@ -29,7 +29,7 @@ export function splitAtPaywall<T>(value: T[] | null | undefined): {
|
|
|
29
29
|
type TextNode = { _type?: unknown; children?: Array<{ text?: unknown }> };
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
|
-
* The text blocks within the first `words` words of a body
|
|
32
|
+
* The text blocks within the first `words` words of a body:
|
|
33
33
|
* a block is never cut in half, so a block that would pass the count ends the
|
|
34
34
|
* teaser. Images and custom blocks are left out. 0 gives nothing.
|
|
35
35
|
*/
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* An entry's body, with RedeemID's blocks applied.
|
|
4
4
|
*
|
|
5
|
-
* <Content value={post.data.content} collection="posts" terms={post.data.terms} />
|
|
5
|
+
* <Content value={post.data.content} collection="posts" terms={post.data.terms} id={post.id} />
|
|
6
6
|
*
|
|
7
7
|
* - "Paywall break": everything before the first one is shown to everyone.
|
|
8
8
|
* What follows reaches the page only for readers who may read it: the
|
|
9
9
|
* levels picked on the break, or when none are picked the entry's rule
|
|
10
|
-
* (with no rule, the break changes nothing
|
|
10
|
+
* (with no rule, the break changes nothing).
|
|
11
11
|
* - "Members only" … "Members only: end": the part between is for the levels
|
|
12
12
|
* picked on the start block, or the entry's rule, or any signed-in member.
|
|
13
13
|
* Readers who can't read it see the wall in its place, and the body goes on.
|
|
@@ -15,10 +15,15 @@
|
|
|
15
15
|
* the collection's teaser (config `teaser`, in words), if any.
|
|
16
16
|
*
|
|
17
17
|
* Readers kept out get the wall (LockedPanel), with the "locked" slot on top.
|
|
18
|
+
*
|
|
19
|
+
* Pass `id` on the entry's own page so drip and the meter apply: a rule's
|
|
20
|
+
* `drip` keeps it shut until the member has held their level that many days,
|
|
21
|
+
* and config `meter` lets signed-in readers open a few locked entries each
|
|
22
|
+
* period (each entry counts once). Leave `id` off in lists.
|
|
18
23
|
*/
|
|
19
24
|
import { PortableText } from "emdash/ui";
|
|
20
25
|
|
|
21
|
-
import { canRead, entryRequirement, type Terms, type Verdict } from "../access.js";
|
|
26
|
+
import { canRead, entryRequirement, readEntry, type Terms, type Verdict } from "../access.js";
|
|
22
27
|
import { sections, splitAtPaywall, teaser } from "../blocks-names.js";
|
|
23
28
|
import { siteConfig } from "../site-config.js";
|
|
24
29
|
import LockedPanel from "./LockedPanel.astro";
|
|
@@ -27,9 +32,11 @@ interface Props {
|
|
|
27
32
|
value?: unknown[] | null;
|
|
28
33
|
collection?: string;
|
|
29
34
|
terms?: Terms;
|
|
35
|
+
/** The entry's id, on its own page: turns on drip and the meter. */
|
|
36
|
+
id?: string;
|
|
30
37
|
}
|
|
31
38
|
|
|
32
|
-
const { value, collection = "", terms } = Astro.props;
|
|
39
|
+
const { value, collection = "", terms, id } = Astro.props;
|
|
33
40
|
const split = splitAtPaywall(value);
|
|
34
41
|
const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
|
|
35
42
|
const entryRule = await entryRequirement(config, collection, terms);
|
|
@@ -39,7 +46,9 @@ const required = split.paywall ? (split.levels.length ? [split.levels] : entryRu
|
|
|
39
46
|
const verdict: Verdict | { allowed: true; reason: "open" } =
|
|
40
47
|
split.paywall && required === null
|
|
41
48
|
? { allowed: true, reason: "open" }
|
|
42
|
-
:
|
|
49
|
+
: id
|
|
50
|
+
? await readEntry(Astro, { collection, terms, id }, required ? { required } : undefined)
|
|
51
|
+
: await canRead(Astro, { collection, terms }, required ? { required } : undefined);
|
|
43
52
|
const words = config?.teaser?.[collection] ?? 0;
|
|
44
53
|
const shown = split.paywall ? split.open : verdict.allowed ? split.open : teaser(split.open, words);
|
|
45
54
|
const rest = verdict.allowed ? split.locked : [];
|
|
@@ -59,8 +68,17 @@ async function parts(blocks: unknown[]) {
|
|
|
59
68
|
}
|
|
60
69
|
const before = await parts(shown);
|
|
61
70
|
const after = await parts(rest);
|
|
71
|
+
const metered = verdict.reason === "metered" ? (verdict as Verdict) : null;
|
|
72
|
+
const per = metered?.meter?.period === "week" ? "this week" : "this month";
|
|
62
73
|
---
|
|
63
74
|
|
|
75
|
+
{metered && (
|
|
76
|
+
<p class="redeemid-meter" role="status" data-redeemid-left={metered.meterLeft}>
|
|
77
|
+
{metered.meterLeft === 0
|
|
78
|
+
? `This is your last free read ${per}.`
|
|
79
|
+
: `You have ${metered.meterLeft} free ${metered.meterLeft === 1 ? "read" : "reads"} left ${per}.`}
|
|
80
|
+
</p>
|
|
81
|
+
)}
|
|
64
82
|
{before.map((p) =>
|
|
65
83
|
!p.verdict || p.verdict.allowed ? (
|
|
66
84
|
p.blocks.length > 0 && <PortableText value={p.blocks} />
|
|
@@ -77,7 +95,14 @@ const after = await parts(rest);
|
|
|
77
95
|
),
|
|
78
96
|
)
|
|
79
97
|
) : (
|
|
80
|
-
<LockedPanel
|
|
98
|
+
<LockedPanel
|
|
99
|
+
reason={verdict.reason}
|
|
100
|
+
required={verdict.required}
|
|
101
|
+
held={verdict.viewer.levels}
|
|
102
|
+
opensAt={verdict.opensAt}
|
|
103
|
+
meterLeft={verdict.meterLeft}
|
|
104
|
+
meterPeriod={verdict.meter?.period}
|
|
105
|
+
>
|
|
81
106
|
<slot name="locked" />
|
|
82
107
|
</LockedPanel>
|
|
83
108
|
)}
|
|
@@ -17,9 +17,17 @@ interface Props {
|
|
|
17
17
|
required?: string[][];
|
|
18
18
|
/** Levels the reader holds (Verdict.viewer.levels). */
|
|
19
19
|
held?: string[];
|
|
20
|
+
/** For "drip": when it opens (Verdict.opensAt). */
|
|
21
|
+
opensAt?: Date;
|
|
22
|
+
/** Free reads left when a meter ran (Verdict.meterLeft); 0 shows the meter-used text. */
|
|
23
|
+
meterLeft?: number;
|
|
24
|
+
meterPeriod?: "month" | "week";
|
|
20
25
|
}
|
|
21
26
|
|
|
22
|
-
const { reason, required = [], held = [] } = Astro.props;
|
|
27
|
+
const { reason, required = [], held = [], opensAt, meterLeft, meterPeriod } = Astro.props;
|
|
28
|
+
const opens = opensAt
|
|
29
|
+
? new Intl.DateTimeFormat("en-US", { dateStyle: "long", timeZone: "UTC" }).format(opensAt)
|
|
30
|
+
: null;
|
|
23
31
|
const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
|
|
24
32
|
const missing = required.find((clause) => clause.length > 0 && !passes(held, [clause]));
|
|
25
33
|
const level = missing ? config?.levels?.find((l) => l.slug === missing[0]) : undefined;
|
|
@@ -37,6 +45,14 @@ const here = Astro.url.pathname + Astro.url.search;
|
|
|
37
45
|
{joinHref && <> Not a member yet? <a href={joinHref}>{joinLabel}</a>.</>}
|
|
38
46
|
</p>
|
|
39
47
|
)}
|
|
48
|
+
{reason === "upgrade" && meterLeft === 0 && (
|
|
49
|
+
<p class="redeemid-locked__meter">You've used your free reads {meterPeriod === "week" ? "this week" : "this month"}.</p>
|
|
50
|
+
)}
|
|
51
|
+
{reason === "drip" && (
|
|
52
|
+
<p>
|
|
53
|
+
{opens ? <>This opens for you on <time datetime={opensAt?.toISOString()}>{opens}</time>.</> : "This opens for you after you've been a member a little longer."}
|
|
54
|
+
</p>
|
|
55
|
+
)}
|
|
40
56
|
{reason === "upgrade" && (
|
|
41
57
|
<p>
|
|
42
58
|
{level ? `This is for ${level.name} members.` : "Your membership doesn't include this yet."}
|
package/src/config.ts
CHANGED
|
@@ -22,7 +22,7 @@ export interface LevelConfig {
|
|
|
22
22
|
}
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* Who may read entries
|
|
25
|
+
* Who may read entries:
|
|
26
26
|
*
|
|
27
27
|
* - A rule with `taxonomy` and `term` covers entries that carry that term, or
|
|
28
28
|
* a child of it in a hierarchical taxonomy (a child's own rule wins over its
|
|
@@ -45,9 +45,30 @@ export interface RuleConfig {
|
|
|
45
45
|
levels: string[];
|
|
46
46
|
/**
|
|
47
47
|
* A term rule that opens its entries to everyone, whatever else covers them
|
|
48
|
-
*
|
|
48
|
+
* `levels` is ignored.
|
|
49
49
|
*/
|
|
50
50
|
open?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Drip: readers who pass the rule may read its entries only once they have
|
|
53
|
+
* been members this many days (from when they first held a level they
|
|
54
|
+
* hold now, or else when they first signed in).
|
|
55
|
+
*/
|
|
56
|
+
drip?: number;
|
|
57
|
+
/** `false`: the meter never opens this rule's entries. */
|
|
58
|
+
meter?: false;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* The meter: signed-in readers without access may open a few locked entries
|
|
63
|
+
* free each month (or week). Guests get the wall; an entry counts once per
|
|
64
|
+
* period, when its own page renders through <Content> with an `id`.
|
|
65
|
+
*/
|
|
66
|
+
export interface MeterConfig {
|
|
67
|
+
/** Free entries per period. */
|
|
68
|
+
limit: number;
|
|
69
|
+
period?: "month" | "week";
|
|
70
|
+
/** Collections the meter covers. All of them when left out. */
|
|
71
|
+
collections?: string[];
|
|
51
72
|
}
|
|
52
73
|
|
|
53
74
|
export interface RedeemIDConfig {
|
|
@@ -61,6 +82,7 @@ export interface RedeemIDConfig {
|
|
|
61
82
|
label?: string;
|
|
62
83
|
levels?: LevelConfig[];
|
|
63
84
|
rules?: RuleConfig[];
|
|
85
|
+
meter?: MeterConfig;
|
|
64
86
|
/** The wall's join link: where readers become members, e.g. { href: "/join/", label: "Become a member" }. */
|
|
65
87
|
join?: { href: string; label?: string };
|
|
66
88
|
/**
|
package/src/plugin.ts
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* - "Paywall break" (`redeemid-paywall`): everything after it in the body is
|
|
14
14
|
* for members. Pick the levels that may read on ("Signed in" for any
|
|
15
15
|
* member); none picked means the entry's rule, and nothing is locked when
|
|
16
|
-
* no rule covers the entry
|
|
16
|
+
* no rule covers the entry.
|
|
17
17
|
* - "Members only" (`redeemid-members`) and "Members only: end"
|
|
18
18
|
* (`redeemid-members-end`): the part between is for the levels picked on
|
|
19
19
|
* the start block; everyone else sees the wall there and reads on after.
|
|
@@ -281,6 +281,7 @@ async function statusPage(config: RedeemIDConfig, request: Request) {
|
|
|
281
281
|
columns: [
|
|
282
282
|
{ key: "where", label: "Covers" },
|
|
283
283
|
{ key: "levels", label: "Who can read" },
|
|
284
|
+
{ key: "extra", label: "Drip and meter" },
|
|
284
285
|
],
|
|
285
286
|
rows: rules.map((r) => ({
|
|
286
287
|
where:
|
|
@@ -290,9 +291,16 @@ async function statusPage(config: RedeemIDConfig, request: Request) {
|
|
|
290
291
|
? "Site default (collections with no rule)"
|
|
291
292
|
: `All ${r.collection}`,
|
|
292
293
|
levels: r.open ? "Everyone (opens the entry)" : r.levels.length ? describe([r.levels], levels) : "Any signed-in member",
|
|
294
|
+
extra: [r.drip ? `Opens ${r.drip} days into membership` : "", r.meter === false ? "Never metered" : ""].filter(Boolean).join("; "),
|
|
293
295
|
})),
|
|
294
296
|
}
|
|
295
297
|
: { type: "context", text: "No rules. Entries are open unless their body has a paywall break." },
|
|
298
|
+
{
|
|
299
|
+
type: "context",
|
|
300
|
+
text: config.meter?.limit
|
|
301
|
+
? `Meter: signed-in readers may open ${config.meter.limit} locked ${config.meter.limit === 1 ? "entry" : "entries"} a ${config.meter.period ?? "month"}${config.meter.collections?.length ? ` (${config.meter.collections.join(", ")})` : ""}.`
|
|
302
|
+
: "Meter: off.",
|
|
303
|
+
},
|
|
296
304
|
],
|
|
297
305
|
};
|
|
298
306
|
}
|
package/src/routes/callback.ts
CHANGED
|
@@ -17,7 +17,7 @@ import type { Kysely } from "kysely";
|
|
|
17
17
|
|
|
18
18
|
import { env, ENV, PROVIDER_ID, readConfig, storeDomain } from "../config.js";
|
|
19
19
|
import { discover, exchangeCode, identity, ShopifyError, verifyIdToken } from "../shopify.js";
|
|
20
|
-
import { emptyMember, stores } from "../storage.js";
|
|
20
|
+
import { emptyMember, stampTags, stores } from "../storage.js";
|
|
21
21
|
import { callbackUrl, fail, FLOW_TTL_MS, SESSION_FLOW, SESSION_ID_TOKEN, type Flow } from "./shared.js";
|
|
22
22
|
|
|
23
23
|
export const prerender = false;
|
|
@@ -83,16 +83,24 @@ export const GET: APIRoute = async ({ request, locals, session, redirect }) => {
|
|
|
83
83
|
|
|
84
84
|
const s = stores(emdash.db);
|
|
85
85
|
const member = (await s.members.get(who.customerId)) ?? emptyMember(who.customerId);
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
86
|
+
const now = new Date().toISOString();
|
|
87
|
+
await s.members.put(
|
|
88
|
+
who.customerId,
|
|
89
|
+
stampTags(
|
|
90
|
+
{
|
|
91
|
+
...member,
|
|
92
|
+
userId: user.id,
|
|
93
|
+
email,
|
|
94
|
+
firstName: who.firstName,
|
|
95
|
+
lastName: who.lastName,
|
|
96
|
+
tags: who.tags,
|
|
97
|
+
syncedAt: now,
|
|
98
|
+
source: "sign-in",
|
|
99
|
+
linkedAt: member.linkedAt ?? now,
|
|
100
|
+
},
|
|
101
|
+
now,
|
|
102
|
+
),
|
|
103
|
+
);
|
|
96
104
|
|
|
97
105
|
session.regenerate?.();
|
|
98
106
|
session.set("user", { id: user.id });
|
package/src/storage.ts
CHANGED
|
@@ -31,6 +31,27 @@ export interface MemberRecord {
|
|
|
31
31
|
syncedAt: string;
|
|
32
32
|
/** What wrote it last: sign-in or a webhook topic. */
|
|
33
33
|
source: string;
|
|
34
|
+
/** When each tag (lowercased) was first seen on the customer, ISO. Kept for drip; a removed tag is forgotten. */
|
|
35
|
+
tagsSince?: Record<string, string>;
|
|
36
|
+
/** When the customer first signed in here, ISO. */
|
|
37
|
+
linkedAt?: string | null;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** A signed-in reader's meter for one period: the locked items they opened free. */
|
|
41
|
+
export interface MeterRecord {
|
|
42
|
+
userId: string;
|
|
43
|
+
/** "2026-11" for a month, "2026-W45" for a week. */
|
|
44
|
+
period: string;
|
|
45
|
+
items: string[];
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/** Update `tagsSince` to the record's current tags: new tags start now, removed tags are dropped. */
|
|
49
|
+
export function stampTags(m: MemberRecord, now = new Date().toISOString()): MemberRecord {
|
|
50
|
+
const before = m.tagsSince ?? {};
|
|
51
|
+
const since: Record<string, string> = {};
|
|
52
|
+
for (const t of m.tags.map((t) => t.toLowerCase())) since[t] = before[t] ?? now;
|
|
53
|
+
m.tagsSince = since;
|
|
54
|
+
return m;
|
|
34
55
|
}
|
|
35
56
|
|
|
36
57
|
export interface DeliveryRecord {
|
|
@@ -41,11 +62,13 @@ export interface DeliveryRecord {
|
|
|
41
62
|
export const STORAGE_CONFIG = {
|
|
42
63
|
members: { indexes: ["email", "userId"] },
|
|
43
64
|
deliveries: { indexes: ["receivedAt"] },
|
|
65
|
+
meter: { indexes: ["userId"] },
|
|
44
66
|
};
|
|
45
67
|
|
|
46
68
|
export interface Stores {
|
|
47
69
|
members: StorageCollection<MemberRecord>;
|
|
48
70
|
deliveries: StorageCollection<DeliveryRecord>;
|
|
71
|
+
meter: StorageCollection<MeterRecord>;
|
|
49
72
|
}
|
|
50
73
|
|
|
51
74
|
export function stores(db: unknown): Stores {
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = "0.0.
|
|
1
|
+
export const VERSION = "0.0.6";
|
package/src/webhooks.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* only; a profile payload without `tags` never means "tags removed".
|
|
7
7
|
*/
|
|
8
8
|
|
|
9
|
-
import { cleanTags, emptyMember, numericId, type MemberRecord, type Stores } from "./storage.js";
|
|
9
|
+
import { cleanTags, emptyMember, numericId, stampTags, type MemberRecord, type Stores } from "./storage.js";
|
|
10
10
|
|
|
11
11
|
export type Kind = "profile" | "delete" | "status" | "tags" | "merge" | "compliance" | "ignored";
|
|
12
12
|
|
|
@@ -114,7 +114,7 @@ export async function apply(s: Stores, topic: string, payload: Record<string, un
|
|
|
114
114
|
if (!survivor.userId) survivor.userId = old.userId;
|
|
115
115
|
survivor.syncedAt = new Date().toISOString();
|
|
116
116
|
survivor.source = topic;
|
|
117
|
-
await s.members.put(kept, survivor);
|
|
117
|
+
await s.members.put(kept, stampTags(survivor));
|
|
118
118
|
}
|
|
119
119
|
await s.members.delete(gone);
|
|
120
120
|
return "processed";
|
|
@@ -156,6 +156,6 @@ export async function apply(s: Stores, topic: string, payload: Record<string, un
|
|
|
156
156
|
|
|
157
157
|
current.syncedAt = new Date().toISOString();
|
|
158
158
|
current.source = topic;
|
|
159
|
-
await s.members.put(id, current);
|
|
159
|
+
await s.members.put(id, stampTags(current));
|
|
160
160
|
return "processed";
|
|
161
161
|
}
|