@redeemid/emdash 0.0.8 → 0.0.10

package/src/components/Collection.astro

@@ -8,6 +8,7 @@
  */
 import { siteConfig } from "../site-config.js";
 import { collection as loadCollection, money, type Collection } from "../storefront.js";
+import { text } from "../text.js";
 
 interface Props {
 	handle: string;
@@ -45,7 +46,7 @@ const href = (h: string) => productHref?.replaceAll("{handle}", encodeURICompone
 				<li class="redeemid-collection__item" data-redeemid-product={p.handle}>
 					{p.image && <img src={p.image.url} alt={p.image.altText ?? ""} loading="lazy" />}
 					<h3>{href(p.handle) ? <a href={href(p.handle)}>{p.title}</a> : p.title}</h3>
-					<p class="redeemid-collection__price">{p.availableForSale ? (p.price ? `From ${money(p.price)}` : "") : "Sold out"}</p>
+					<p class="redeemid-collection__price">{p.availableForSale ? (p.price ? text(config, "From {price}", { price: money(p.price) }) : "") : text(config, "Sold out")}</p>
 				</li>
 			))}
 		</ul>

package/src/components/Content.astro

@@ -26,6 +26,7 @@ import { PortableText } from "emdash/ui";
 import { canRead, entryRequirement, readEntry, type Terms, type Verdict } from "../access.js";
 import { sections, splitAtPaywall, teaser } from "../blocks-names.js";
 import { siteConfig } from "../site-config.js";
+import { text } from "../text.js";
 import LockedPanel from "./LockedPanel.astro";
 
 interface Props {
@@ -69,14 +70,19 @@ async function parts(blocks: unknown[]) {
 const before = await parts(shown);
 const after = await parts(rest);
 const metered = verdict.reason === "metered" ? (verdict as Verdict) : null;
-const per = metered?.meter?.period === "week" ? "this week" : "this month";
+const week = metered?.meter?.period === "week";
+const left = metered?.meterLeft ?? 0;
+const meterText =
+	left === 0
+		? text(config, week ? "This is your last free read this week." : "This is your last free read this month.")
+		: left === 1
+			? text(config, week ? "You have 1 free read left this week." : "You have 1 free read left this month.")
+			: text(config, week ? "You have {count} free reads left this week." : "You have {count} free reads left this month.", { count: left });
 ---
 
 {metered && (
 	<p class="redeemid-meter" role="status" data-redeemid-left={metered.meterLeft}>
-		{metered.meterLeft === 0
-			? `This is your last free read ${per}.`
-			: `You have ${metered.meterLeft} free ${metered.meterLeft === 1 ? "read" : "reads"} left ${per}.`}
+		{meterText}
 	</p>
 )}
 {before.map((p) =>

package/src/components/Contribution.astro

@@ -9,6 +9,7 @@
  */
 import { siteConfig } from "../site-config.js";
 import { money, product as loadProduct, type Product } from "../storefront.js";
+import { text } from "../text.js";
 
 interface Props {
 	handle: string;
@@ -20,8 +21,8 @@ interface Props {
 	title?: string;
 }
 
-const { handle, amounts = [5, 10, 25], initial = 10, label = "Give", title } = Astro.props;
 const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const { handle, amounts = [5, 10, 25], initial = 10, label = text(config, "Give"), title } = Astro.props;
 let p: Product | null = null;
 if (config) {
 	try {
@@ -57,13 +58,13 @@ const id = `redeemid-give-${handle}`;
 					</p>
 				)}
 				<p>
-					<label for={`${id}-amount`}>Another amount ({currency})</label>
+					<label for={`${id}-amount`}>{text(config, "Another amount ({currency})", { currency })}</label>
 					<input id={`${id}-amount`} name="quantity" type="number" min="1" max="1000" step="1" value={initial} inputmode="numeric" />
 				</p>
 			</>
 		) : (
 			<p>
-				<label for={`${id}-amount`}>Quantity ({money(variant.price)} each)</label>
+				<label for={`${id}-amount`}>{text(config, "Quantity ({price} each)", { price: money(variant.price) })}</label>
 				<input id={`${id}-amount`} name="quantity" type="number" min="1" max="1000" value="1" inputmode="numeric" />
 			</p>
 		)}

package/src/components/Feature.astro

@@ -0,0 +1,20 @@
+---
+/**
+ * Shows its default slot only to members who hold the feature (see config
+ * `features`), and the "else" slot to everyone else.
+ *
+ *   <Feature slug="supporter">
+ *     <p>Thanks for supporting us.</p>
+ *     <a slot="else" href="/support/">Support us</a>
+ *   </Feature>
+ */
+import { hasFeature } from "../features.js";
+
+interface Props {
+	slug: string;
+}
+
+const held = await hasFeature(Astro, Astro.props.slug);
+---
+
+{held ? <slot /> : <slot name="else" />}

package/src/components/LockedPanel.astro

@@ -10,6 +10,7 @@
  */
 import { passes, signInUrl, type Reason } from "../access.js";
 import { siteConfig } from "../site-config.js";
+import { text, textParts } from "../text.js";
 
 interface Props {
 	reason: Reason;
@@ -32,7 +33,8 @@ const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).em
 const missing = required.find((clause) => clause.length > 0 && !passes(held, [clause]));
 const level = missing ? config?.levels?.find((l) => l.slug === missing[0]) : undefined;
 const joinHref = level?.joinUrl ?? config?.join?.href;
-const joinLabel = config?.join?.label ?? "Become a member";
+const joinLabel = config?.join?.label ?? text(config, "Become a member");
+const week = meterPeriod === "week";
 const here = Astro.url.pathname + Astro.url.search;
 ---
 
@@ -41,24 +43,24 @@ const here = Astro.url.pathname + Astro.url.search;
 	{level?.wall && (reason === "sign_in" || reason === "upgrade") && <p class="redeemid-locked__wall">{level.wall}</p>}
 	{reason === "sign_in" && (
 		<p>
-			This is for members. <a href={signInUrl(here)}>Sign in</a> to read on.
-			{joinHref && <> Not a member yet? <a href={joinHref}>{joinLabel}</a>.</>}
+			{textParts(config, "This is for members. {signIn} to read on.", { signIn: <a href={signInUrl(here)}>{text(config, "Sign in")}</a> })}
+			{joinHref && <> {textParts(config, "Not a member yet? {join}.", { join: <a href={joinHref}>{joinLabel}</a> })}</>}
 		</p>
 	)}
 	{reason === "upgrade" && meterLeft === 0 && (
-		<p class="redeemid-locked__meter">You've used your free reads {meterPeriod === "week" ? "this week" : "this month"}.</p>
+		<p class="redeemid-locked__meter">{text(config, week ? "You've used your free reads this week." : "You've used your free reads this month.")}</p>
 	)}
 	{reason === "drip" && (
 		<p>
-			{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."}
+			{opens ? textParts(config, "This opens for you on {date}.", { date: <time datetime={opensAt?.toISOString()}>{opens}</time> }) : text(config, "This opens for you after you've been a member a little longer.")}
 		</p>
 	)}
 	{reason === "upgrade" && (
 		<p>
-			{level ? `This is for ${level.name} members.` : "Your membership doesn't include this yet."}
+			{level ? text(config, "This is for {level} members.", { level: level.name }) : text(config, "Your membership doesn't include this yet.")}
 			{joinHref && <> <a href={joinHref}>{joinLabel}</a></>}
 		</p>
 	)}
-	{reason === "disabled" && <p>Your account is turned off. Contact the store for help.</p>}
-	{reason === "unconfigured" && <p>This is for members.</p>}
+	{reason === "disabled" && <p>{text(config, "Your account is turned off. Contact the store for help.")}</p>}
+	{reason === "unconfigured" && <p>{text(config, "This is for members.")}</p>}
 </div>

package/src/components/MemberCard.astro

@@ -10,21 +10,25 @@
  * membership reads it from the store again.
  */
 import { accountUrl, membership, meterUsage, refreshUrl, signInUrl, signOutUrl, viewer } from "../access.js";
+import { featuresFor } from "../features.js";
 import { siteConfig } from "../site-config.js";
+import { text, textParts } from "../text.js";
 
 interface Props {
 	/** Heading text; the member's first name is added after it. */
 	title?: string;
 }
 
-const { title = "Your membership" } = Astro.props;
-const v = await viewer(Astro);
 const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const { title = text(config, "Your membership") } = Astro.props;
+const v = await viewer(Astro);
 const here = Astro.url.pathname + Astro.url.search;
 const m = v.member;
 const disabled = m?.status === "disabled";
 const { current, past } = m && !disabled ? membership(m, config?.levels) : { current: [], past: [] };
 const meter = v.signedIn ? await meterUsage(Astro) : null;
+const held = m ? featuresFor(m, config?.features, config?.levels) : [];
+const features = (config?.features ?? []).filter((f) => held.includes(f.slug));
 const date = (iso: string | null) => {
 	if (!iso) return null;
 	const t = Date.parse(iso);
@@ -45,29 +49,34 @@ const join = config?.join;
 				</p>
 			)}
 			{disabled ? (
-				<p class="redeemid-member__disabled">Your account is turned off. Contact the store for help.</p>
+				<p class="redeemid-member__disabled">{text(config, "Your account is turned off. Contact the store for help.")}</p>
 			) : current.length > 0 ? (
 				<ul class="redeemid-member__levels">
 					{current.map((l) => (
 						<li data-redeemid-level={l.slug}>
 							<strong>{l.name}</strong>
-							{date(l.since) && <> since <time datetime={l.since ?? undefined}>{date(l.since)}</time></>}
+							{date(l.since) && <> {textParts(config, "since {date}", { date: <time datetime={l.since ?? undefined}>{date(l.since)}</time> })}</>}
 						</li>
 					))}
 				</ul>
 			) : (
 				<p class="redeemid-member__none">
-					You don't have a membership yet.{join && <> <a href={join.href}>{join.label ?? "Become a member"}</a></>}
+					{text(config, "You don't have a membership yet.")}{join && <> <a href={join.href}>{join.label ?? text(config, "Become a member")}</a></>}
+				</p>
+			)}
+			{features.length > 0 && (
+				<p class="redeemid-member__features">
+					{text(config, "Includes: {features}", { features: features.map((f) => f.name).join(", ") })}
 				</p>
 			)}
 			{past.length > 0 && (
 				<>
-					<h3 class="redeemid-member__subtitle">Before</h3>
+					<h3 class="redeemid-member__subtitle">{text(config, "Before")}</h3>
 					<ul class="redeemid-member__past">
 						{past.map((l) => (
 							<li data-redeemid-level={l.slug}>
 								{l.name}
-								{date(l.from) ? `, ${date(l.from)} to ${date(l.to)}` : `, until ${date(l.to)}`}
+								{", "}{date(l.from) ? text(config, "{from} to {to}", { from: date(l.from) ?? "", to: date(l.to) ?? "" }) : text(config, "until {to}", { to: date(l.to) ?? "" })}
 							</li>
 						))}
 					</ul>
@@ -75,21 +84,21 @@ const join = config?.join;
 			)}
 			{meter && current.length === 0 && !disabled && (
 				<p class="redeemid-member__meter" data-redeemid-used={meter.used}>
-					Free reads {meter.period === "week" ? "this week" : "this month"}: {meter.used} of {meter.limit} used.
+					{text(config, meter.period === "week" ? "Free reads this week: {used} of {limit} used." : "Free reads this month: {used} of {limit} used.", { used: meter.used, limit: meter.limit })}
 				</p>
 			)}
 			<p class="redeemid-member__actions">
-				<a href={accountUrl(here)}>Orders and details</a>
-				<a href={refreshUrl(here)}>Refresh membership</a>
+				<a href={accountUrl(here)}>{text(config, "Orders and details")}</a>
+				<a href={refreshUrl(here)}>{text(config, "Refresh membership")}</a>
 			</p>
 			<form method="post" action={signOutUrl("/")}>
-				<button type="submit">Sign out</button>
+				<button type="submit">{text(config, "Sign out")}</button>
 			</form>
-			<p class="redeemid-member__note">Just bought a plan? It can take a minute to show here. Refresh membership checks again.</p>
+			<p class="redeemid-member__note">{text(config, "Just bought a plan? It can take a minute to show here. Refresh membership checks again.")}</p>
 		</>
 	) : (
 		<p>
-			<a href={signInUrl(here)}>{config?.label ?? "Sign in"}</a> to see your membership.
+			{textParts(config, "{signIn} to see your membership.", { signIn: <a href={signInUrl(here)}>{config?.label ?? text(config, "Sign in")}</a> })}
 		</p>
 	)}
 </section>

package/src/components/Notices.astro

@@ -2,8 +2,11 @@
 /**
  * The message for a `?redeemid_notice=` code that sign-in, Buy, Cart and
  * Account send readers back with. Renders nothing without one. Pass
- * `messages` to reword any of them.
+ * `messages` to reword any of them (config `text` does too, for every page).
  */
+import { siteConfig } from "../site-config.js";
+import { text as replace } from "../text.js";
+
 interface Props {
 	messages?: Record<string, string>;
 }
@@ -26,12 +29,17 @@ const DEFAULTS: Record<string, string> = {
 	discount_applied: "Discount applied.",
 	discount_not_applicable: "That discount code doesn't apply to this cart.",
 	refreshed: "Your membership is up to date.",
+	preferences_saved: "Your preferences are saved.",
+	preferences_refused: "Some answers weren't saved. Check them and try again.",
+	preferences_unavailable: "Your preferences can't be saved right now. Try again in a few minutes.",
 	account_unavailable: "Your account page isn't available right now. Try again in a few minutes.",
 };
 
 const { messages = {} } = Astro.props;
 const code = Astro.url.searchParams.get("redeemid_notice") ?? "";
-const text = code ? (messages[code] ?? DEFAULTS[code]) : undefined;
+const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const fallback = DEFAULTS[code];
+const text = code ? (messages[code] ?? (fallback ? replace(config, fallback) : undefined)) : undefined;
 ---
 
 {text && (

package/src/components/Plan.astro

@@ -12,6 +12,7 @@
 import { viewer } from "../access.js";
 import { siteConfig } from "../site-config.js";
 import { plan as loadPlan, type Plan } from "../storefront.js";
+import { text } from "../text.js";
 
 interface Props {
 	handle: string;
@@ -24,8 +25,8 @@ interface Props {
 	heldLabel?: string;
 }
 
-const { handle, label = "Join", title, levels = [], heldLabel = "You're on this plan." } = Astro.props;
 const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const { handle, label = text(config, "Join"), title, levels = [], heldLabel = text(config, "You're on this plan.") } = Astro.props;
 let p: Plan | null = null;
 if (config) {
 	try {
@@ -55,7 +56,7 @@ const held = levels.length > 0 && (await viewer(Astro)).levels.some((l) => level
 				<button type="submit">{label}</button>
 			</form>
 		) : (
-			<p class="redeemid-plan__unavailable">Not available right now.</p>
+			<p class="redeemid-plan__unavailable">{text(config, "Not available right now.")}</p>
 		)}
 	</div>
 ) : (

package/src/components/Preferences.astro

@@ -0,0 +1,102 @@
+---
+/**
+ * The member's preferences form: every field in `preferences`, read from
+ * their Shopify customer, with a control for each type. Fields set to "view"
+ * are shown, not editable. Works without JavaScript: it posts to the
+ * preferences route and comes back with a notice. Visitors and sites without
+ * preferences get nothing (or the "signed-out" slot).
+ *
+ *   <Preferences title="Your preferences" />
+ */
+import { viewer } from "../access.js";
+import { preferencesConfigured, readPreferences, type PreferenceField } from "../preferences.js";
+import { siteConfig } from "../site-config.js";
+import { text } from "../text.js";
+
+interface Props {
+	title?: string;
+	/** Heading level for the title. */
+	heading?: "h2" | "h3" | "h4";
+	label?: string;
+}
+
+const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const { title = text(config, "Your preferences"), heading = "h2", label = text(config, "Save preferences") } = Astro.props;
+const v = await viewer(Astro);
+const m = v.member;
+let fields: PreferenceField[] = [];
+let failed = false;
+if (config && preferencesConfigured(config) && m && m.status !== "disabled") {
+	try {
+		fields = await readPreferences(config, m.customerId);
+	} catch (e) {
+		failed = true;
+		console.error("[redeemid] preferences not read:", (e as Error).message);
+	}
+}
+const here = Astro.url.pathname + Astro.url.search.replace(/[?&]redeemid_notice=[^&]*/, "").replace(/^&/, "?");
+const H = heading;
+const id = (key: string) => `redeemid-pref-${key.replace(/[^\w-]/g, "-")}`;
+const show = (f: PreferenceField) =>
+	f.value === null || (Array.isArray(f.value) && f.value.length === 0) ? text(config, "Not set") : Array.isArray(f.value) ? f.value.join(", ") : f.type === "boolean" ? text(config, f.value ? "Yes" : "No") : String(f.value);
+const editable = fields.filter((f) => f.editable);
+---
+
+{v.signedIn && (fields.length > 0 || failed) ? (
+	<section class="redeemid-preferences">
+		<H class="redeemid-preferences__title">{title}</H>
+		{failed ? (
+			<p>{text(config, "Your preferences can't be loaded right now. Try again in a few minutes.")}</p>
+		) : (
+			<form method="post" action="/_emdash/api/auth/redeemid/preferences">
+				<input type="hidden" name="return" value={here} />
+				{fields.map((f) => (
+					<div class="redeemid-preferences__field" data-redeemid-pref={f.key}>
+						{f.editable && <input type="hidden" name={`present:${f.key}`} value="1" />}
+						{!f.editable ? (
+							<p>
+								<strong>{f.name}:</strong> {show(f)}
+							</p>
+						) : f.type === "boolean" ? (
+							<label>
+								<input type="checkbox" name={`pref:${f.key}`} value="true" checked={f.value === true} /> {f.name}
+							</label>
+						) : f.type === "list.single_line_text_field" && f.choices ? (
+							<fieldset>
+								<legend>{f.name}</legend>
+								{f.choices.map((c) => (
+									<label>
+										<input type="checkbox" name={`pref:${f.key}`} value={c} checked={Array.isArray(f.value) && f.value.includes(c)} /> {c}
+									</label>
+								))}
+							</fieldset>
+						) : (
+							<>
+								<label for={id(f.key)}>{f.name}</label>
+								{f.choices ? (
+									<select id={id(f.key)} name={`pref:${f.key}`}>
+										<option value="">{text(config, "Not set")}</option>
+										{f.choices.map((c) => <option value={c} selected={f.value === c}>{c}</option>)}
+									</select>
+								) : f.type === "multi_line_text_field" || f.type === "list.single_line_text_field" ? (
+									<textarea id={id(f.key)} name={`pref:${f.key}`} rows="3" maxlength={f.max && f.type === "multi_line_text_field" ? Number(f.max) : undefined}>{Array.isArray(f.value) ? f.value.join("\n") : (f.value ?? "")}</textarea>
+								) : f.type === "number_integer" || f.type === "number_decimal" ? (
+									<input id={id(f.key)} type="number" name={`pref:${f.key}`} step={f.type === "number_integer" ? "1" : "any"} min={f.min ?? undefined} max={f.max ?? undefined} value={f.value === null ? "" : String(f.value)} />
+								) : f.type === "date" ? (
+									<input id={id(f.key)} type="date" name={`pref:${f.key}`} min={f.min?.slice(0, 10)} max={f.max?.slice(0, 10)} value={typeof f.value === "string" ? f.value : ""} />
+								) : (
+									<input id={id(f.key)} type="text" name={`pref:${f.key}`} maxlength={f.max ? Number(f.max) : undefined} value={typeof f.value === "string" ? f.value : ""} />
+								)}
+								{f.type === "list.single_line_text_field" && !f.choices && <small>{text(config, "One per line.")}</small>}
+							</>
+						)}
+						{f.description && f.editable && <small class="redeemid-preferences__help">{f.description}</small>}
+					</div>
+				))}
+				{editable.length > 0 && <button type="submit">{label}</button>}
+			</form>
+		)}
+	</section>
+) : (
+	!v.signedIn && <slot name="signed-out" />
+)}

package/src/components/Product.astro

@@ -9,6 +9,7 @@
  */
 import { siteConfig } from "../site-config.js";
 import { money, product as loadProduct, type Product } from "../storefront.js";
+import { text } from "../text.js";
 
 interface Props {
 	handle: string;
@@ -20,8 +21,8 @@ interface Props {
 	buyLabel?: string;
 }
 
-const { handle, heading = "h2", compact = false, addLabel = "Add to cart", buyLabel = "Buy now" } = Astro.props;
 const config = siteConfig((Astro.locals as { emdash?: { config?: unknown } }).emdash?.config);
+const { handle, heading = "h2", compact = false, addLabel = text(config, "Add to cart"), buyLabel = text(config, "Buy now") } = Astro.props;
 let p: Product | null = null;
 if (config) {
 	try {
@@ -50,11 +51,11 @@ const id = `redeemid-product-${handle}`;
 				<input type="hidden" name="return" value={here} />
 				{p.variants.length > 1 ? (
 					<p>
-						<label for={`${id}-variant`}>Option</label>
+						<label for={`${id}-variant`}>{text(config, "Option")}</label>
 						<select id={`${id}-variant`} name="variant">
 							{p.variants.map((v) => (
 								<option value={v.id} disabled={!v.availableForSale}>
-									{v.title} ({money(v.price)}){!v.availableForSale && " sold out"}
+									{text(config, v.availableForSale ? "{option} ({price})" : "{option} ({price}) sold out", { option: v.title, price: money(v.price) })}
 								</option>
 							))}
 						</select>
@@ -63,14 +64,14 @@ const id = `redeemid-product-${handle}`;
 					<input type="hidden" name="variant" value={first?.id} />
 				)}
 				<p>
-					<label for={`${id}-quantity`}>Quantity</label>
+					<label for={`${id}-quantity`}>{text(config, "Quantity")}</label>
 					<input id={`${id}-quantity`} name="quantity" type="number" min="1" max="1000" value="1" inputmode="numeric" />
 				</p>
 				<button type="submit" name="then" value="back">{addLabel}</button>
 				<button type="submit" name="then" value="checkout">{buyLabel}</button>
 			</form>
 		) : (
-			<p class="redeemid-product__unavailable">Sold out.</p>
+			<p class="redeemid-product__unavailable">{text(config, "Sold out.")}</p>
 		)}
 	</div>
 ) : (

package/src/config.ts

@@ -63,6 +63,40 @@ export interface RuleConfig {
  * free each month (or week). Guests get the wall; an entry counts once per
  * period, when its own page renders through <Content> with an `id`.
  */
+/** A perk members hold through any of its levels or Shopify tags. */
+export interface FeatureConfig {
+	slug: string;
+	name: string;
+	levels?: string[];
+	tags?: string[];
+}
+
+/** Where to send signed member events (see events.ts). The signing secret is REDEEMID_EVENTS_SECRET. */
+/** A media folder whose files only some readers may download. Any of the given ways in is enough. */
+export interface FileRule {
+	/** The media folder's name in the EmDash media library. */
+	folder: string;
+	/** Members holding any of these levels. An empty list means any signed-in member. */
+	levels?: string[];
+	/** Members holding any of these features. */
+	features?: string[];
+	/** Whoever can read a published entry that uses the file (its rule, drip and the levels picked in its body). */
+	entries?: boolean;
+}
+
+export interface PreferenceConfig {
+	/** "namespace.key" of a customer metafield definition. */
+	key: string;
+	/** "edit" (default): members can change it. "view": members only see it. */
+	access?: "view" | "edit";
+}
+
+export interface EventsConfig {
+	url: string;
+	/** Send only these events. All of them when left out. */
+	only?: Array<"member.signed_in" | "member.levels_changed" | "meter.used" | "meter.exhausted" | "preferences.saved">;
+}
+
 export interface MeterConfig {
 	/** Free entries per period. */
 	limit: number;
@@ -83,6 +117,21 @@ export interface RedeemIDConfig {
 	levels?: LevelConfig[];
 	rules?: RuleConfig[];
 	meter?: MeterConfig;
+	features?: FeatureConfig[];
+	events?: EventsConfig;
+	/**
+	 * Customer metafields members may see or change, in this order, by
+	 * "namespace.key". Define them in Shopify (Settings → Custom data →
+	 * Customers). Needs the Admin API app (staff tools) for reading and saving.
+	 */
+	preferences?: PreferenceConfig[];
+	/** Protected files, by media folder. See FileRule. */
+	files?: FileRule[];
+	/**
+	 * Replacement text, by each string's original English, e.g.
+	 * { "Sign in": "Log in" }. One string at a time; see text.ts for the list.
+	 */
+	text?: Record<string, string>;
 	/** The wall's join link: where readers become members, e.g. { href: "/join/", label: "Become a member" }. */
 	join?: { href: string; label?: string };
 	/**
@@ -123,6 +172,10 @@ export const ENV = {
 	clientSecret: "REDEEMID_SHOPIFY_CUSTOMER_ACCOUNT_CLIENT_SECRET",
 	/** Client secret of the Shopify (Admin API) app whose webhooks the site receives. Shopify signs webhooks with it. */
 	webhookSecret: "REDEEMID_SHOPIFY_ADMIN_APP_CLIENT_SECRET",
+	/** Client ID of that Shopify (Admin API) app. With the secret it lets staff tools call the Admin API (client credentials). */
+	adminClientId: "REDEEMID_SHOPIFY_ADMIN_APP_CLIENT_ID",
+	/** Secret for signing the outbound events RedeemID sends to `events.url`. */
+	eventsSecret: "REDEEMID_EVENTS_SECRET",
 	/** Storefront API private token, for server-side plan and checkout calls. */
 	storefrontPrivateToken: "REDEEMID_SHOPIFY_STOREFRONT_PRIVATE_TOKEN",
 	/** Storefront API public token, used only when the private token isn't set. */

package/src/descriptor.ts

@@ -11,6 +11,7 @@ import { VERSION } from "./version.js";
 export const PAGES = [
 	{ path: "/", label: "Members", icon: "users" },
 	{ path: "/status", label: "Status", icon: "pulse" },
+	{ path: "/test", label: "Access test", icon: "search" },
 ];
 export const WIDGETS = [{ id: "status", title: "RedeemID", size: "half" as const }];
 

package/src/events.ts

@@ -0,0 +1,75 @@
+/**
+ * Outbound events: RedeemID POSTs JSON to `events.url` when something
+ * happens to a member, signed so the receiver can trust it.
+ *
+ *   events: { url: "https://hooks.example.com/redeemid" }   // + REDEEMID_EVENTS_SECRET
+ *
+ * Headers: X-RedeemID-Event (the name), X-RedeemID-Delivery (a fresh id) and
+ * X-RedeemID-Signature: sha256=<hex HMAC of the raw body>. Events:
+ * member.signed_in, member.levels_changed, meter.used, meter.exhausted,
+ * preferences.saved.
+ * Sending never blocks or breaks the page: failures are logged and dropped.
+ * No event carries an email address or a name; match people by `customerId`.
+ */
+
+import { env, ENV, type RedeemIDConfig } from "./config.js";
+import { USER_AGENT } from "./shopify.js";
+
+export type EventName = "member.signed_in" | "member.levels_changed" | "meter.used" | "meter.exhausted" | "preferences.saved";
+
+const TIMEOUT_MS = 3000;
+
+export async function signBody(body: string, secret: string): Promise<string> {
+	const key = await crypto.subtle.importKey("raw", new TextEncoder().encode(secret), { name: "HMAC", hash: "SHA-256" }, false, ["sign"]);
+	const mac = new Uint8Array(await crypto.subtle.sign("HMAC", key, new TextEncoder().encode(body)));
+	return [...mac].map((b) => b.toString(16).padStart(2, "0")).join("");
+}
+
+/** Send one event. Returns whether the receiver answered 2xx; never throws. */
+export async function emit(config: RedeemIDConfig | null, name: EventName, data: Record<string, unknown>, fetcher: typeof fetch = fetch): Promise<boolean> {
+	const url = config?.events?.url;
+	const secret = env(ENV.eventsSecret);
+	if (!url || !secret) return false;
+	if (config.events?.only && !config.events.only.includes(name)) return false;
+	const id = crypto.randomUUID();
+	const body = JSON.stringify({ id, event: name, at: new Date().toISOString(), data });
+	try {
+		const res = await fetcher(url, {
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+				"User-Agent": USER_AGENT,
+				"X-RedeemID-Event": name,
+				"X-RedeemID-Delivery": id,
+				"X-RedeemID-Signature": `sha256=${await signBody(body, secret)}`,
+			},
+			body,
+			signal: AbortSignal.timeout(TIMEOUT_MS),
+		});
+		return res.ok;
+	} catch (e) {
+		console.error("[redeemid] event not sent:", name, (e as Error).message);
+		return false;
+	}
+}
+
+/** Send member.levels_changed when a mirror write changed the member's levels. */
+export async function levelChange(
+	config: RedeemIDConfig | null,
+	beforeTags: string[] | null,
+	after: { customerId: string; tags: string[]; status: string },
+	source: string,
+	fetcher: typeof fetch = fetch,
+): Promise<void> {
+	if (!config?.events?.url) return;
+	const { levelsFor } = await import("./access.js");
+	const was = beforeTags ? levelsFor(beforeTags, config.levels) : [];
+	const now = after.status === "disabled" ? [] : levelsFor(after.tags, config.levels);
+	if (was.length === now.length && was.every((l) => now.includes(l))) return;
+	await emit(
+		config,
+		"member.levels_changed",
+		{ customerId: after.customerId, levels: now, added: now.filter((l) => !was.includes(l)), removed: was.filter((l) => !now.includes(l)), source },
+		fetcher,
+	);
+}