@meith/plugin-dues 0.21.1 → 0.22.0

package/README.md

@@ -10,7 +10,7 @@ name**.
 What a paying member gets is whatever the group carries: forum access, a
 badge, a name colour. Dues never makes a permission decision — it decides who
 is in a group and until when, through the board's own
-[timed-grant capability](../../docs/plugin-api.md#timed-group-grants), and
+[timed-grant capability](../../docs/customization/plugins.md#timed-group-grants), and
 every guarantee that capability makes applies here. The load-bearing one:
 **a grant always expires on its own.** If this plugin is removed, its tasks
 stop, or Stripe closes the account, every sold membership drains away at its
@@ -33,7 +33,7 @@ answers for the board is not.
 **Try it before you read any of this**: [demo.meith.dev](https://demo.meith.dev)
 runs this plugin against a Stripe that is not Stripe — a shop with a year of
 history behind it, and a checkout a visitor can actually go through. See
-[demo mode](../../docs/demo-mode.md#the-shop-and-a-stripe-that-is-not-stripe).
+[demo mode](../../docs/guides/operations/demo-mode.md#the-shop-and-a-stripe-that-is-not-stripe).
 
 ## Setting up a board
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meith/plugin-dues",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "description": "Membership dues for a Meith board: Stripe-backed subscriptions as a contained plugin.",
   "license": "MIT",
   "repository": {
@@ -20,8 +20,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@meith/plugin-kit": "^0.21.1",
-    "@meith/theme-kit": "^0.21.1"
+    "@meith/plugin-kit": "^0.22.0",
+    "@meith/theme-kit": "^0.22.0"
   },
   "peerDependencies": {
     "react": "^19.2.0"

package/src/config.ts

@@ -14,12 +14,6 @@ export interface DuesPlanInput {
   readonly hidden?: boolean
 }
 
-/**
- * What a board still configures in code, when it registers the plugin with
- * arguments rather than taking the zero-argument export. `currency` and
- * `graceDays` moved to plugin settings — see `resolveDuesConfig` — because a
- * marketplace install can only supply a key, never a constructor argument.
- */
 export interface DuesConfigInput {
   readonly label?: string
   readonly plans?: readonly DuesPlanInput[]
@@ -39,14 +33,12 @@ export interface DuesPlan {
   readonly hidden: boolean
 }
 
-/** The half of the configuration fixed at plugin registration. */
 export interface DuesStaticConfig {
   readonly label: string
   readonly seedPlans: readonly DuesPlan[]
   readonly extraRedirectHosts: readonly string[]
 }
 
-/** The static half plus the settings an operator edits in the panel. */
 export interface DuesConfig extends DuesStaticConfig {
   readonly currency: string
   readonly graceDays: number
@@ -60,13 +52,6 @@ export const DEFAULT_GRACE_DAYS = 7
 export const MIN_GRACE_DAYS = 0
 export const MAX_GRACE_DAYS = 30
 
-/**
- * The board-wide currency is a `select` setting, and a select needs a fixed
- * list of options — unlike a plan's own currency (still any ISO 4217 code,
- * typed into the plan form), this is the curated set an operator picks a
- * default from. Labels are bare codes, on purpose: they need no translation
- * and cost nothing in the message catalog.
- */
 export const DUES_CURRENCY_OPTIONS: readonly { readonly value: string; readonly label: string }[] =
   [
     { value: 'usd', label: 'USD' },
@@ -94,16 +79,6 @@ function refuse(message: string): never {
   throw new Error(`dues plugin configuration: ${message}`)
 }
 
-/**
- * Validates the code-configured half of the plugin — a plan's `currency` is
- * still supplied per-plan on the admin form, but a code-declared *seed* plan
- * has none of its own, so it always seeds under whatever the `currency`
- * setting resolves to when the board's first request seeds it. That means
- * the period-plus-grace cap below cannot know the actual `graceDays` in
- * force (a setting, resolved per request) — it checks against the worst
- * case, `MAX_GRACE_DAYS`, so no seed can exceed the board's two-year grant
- * cap no matter how the setting is later changed.
- */
 export function parseDuesConfig(input: DuesConfigInput = {}): DuesStaticConfig {
   const label = (input.label ?? 'Membership').trim()
   if (label === '') refuse('label must not be empty.')
@@ -195,16 +170,6 @@ function clampGraceDays(value: number): number {
   return Math.min(MAX_GRACE_DAYS, Math.max(MIN_GRACE_DAYS, Math.round(value)))
 }
 
-/**
- * Merges the static, code-declared half of the configuration with the two
- * settings an operator edits in the panel. Settings have no refusal path —
- * unlike `parseDuesConfig`, a bad value here is repaired rather than thrown:
- * an unrecognised currency falls back to the default, and an out-of-range
- * grace period is clamped to 0–30 days. `resolvePluginSettings` already
- * guarantees a `select` setting's stored value is one of its declared
- * options, so the currency check below is a second, cheap line of defence
- * rather than the one this depends on.
- */
 export function resolveDuesConfig(
   staticConfig: DuesStaticConfig,
   settings: Readonly<Record<string, string | number | boolean>>,

package/src/definition.tsx

@@ -41,20 +41,9 @@ import { runReconcile, runSweep } from './tasks'
 import { CodesPage, LedgerPage, MembersPage, PlansAdminPage, StatusPage } from './ui/admin'
 import { GoPage, ManagePage, PlansPage, ReturnPage } from './ui/pages'
 
-/**
- * The code-configured path: still takes constructor arguments, for a board
- * that registers Dues directly in `community.plugins.ts` rather than
- * through a marketplace install. `dues`, below, is this called with none —
- * the zero-argument export a marketplace install actually uses.
- */
 export function createDues(input: DuesConfigInput = {}): PluginDefinition {
   const staticConfig = parseDuesConfig(input)
 
-  /**
-   * Resolved fresh per call: `currency` and `graceDays` are settings, so a
-   * request made after an operator edits them must see the new value, not
-   * one baked in when the plugin was registered.
-   */
   const configFor = (context: PluginRuntimeContext): DuesConfig =>
     resolveDuesConfig(staticConfig, context.settings)
 
@@ -68,7 +57,7 @@ export function createDues(input: DuesConfigInput = {}): PluginDefinition {
   return definePlugin({
     key: 'dues',
     name: 'Dues',
-    version: '0.21.1',
+    version: '0.22.0',
     description: en['dues.definition.description'].replace(
       '{label}',
       staticConfig.label.toLowerCase(),
@@ -370,14 +359,4 @@ export function createDues(input: DuesConfigInput = {}): PluginDefinition {
   })
 }
 
-/**
- * The zero-argument export: what a marketplace install actually registers.
- * `allowedRedirectHosts` carries only Stripe's own hosts — a marketplace
- * install cannot express a constructor argument, and `allowedRedirectHosts`
- * is fixed on the definition at this call, before any settings resolve, so
- * there is no later point where a board-configured host could be added. A
- * board that genuinely needs another redirect host (a proxy, a loopback
- * address for a test double) registers `createDues({ extraRedirectHosts })`
- * directly instead.
- */
 export const dues: PluginDefinition = createDues()

package/src/entitlement.ts

@@ -198,7 +198,6 @@ function settledPeriodEnd(
   return addBillingInterval(now, plan?.billingInterval ?? 'month')
 }
 
-/** @see plugins/dues/README.md#changing-and-retiring-one */
 const FALLBACK_PERIOD = { years: 0, months: 0, weeks: 0, days: 30 }
 
 function parseStoredPeriod(order: OrderRow) {

package/src/handlers.ts

@@ -72,7 +72,6 @@ export function entitlementDeps(services: DuesServices): EntitlementDeps {
 
 const LOOPBACK_HOSTNAMES = new Set(['127.0.0.1', 'localhost', '[::1]'])
 
-/** docs/membership-guide.md#origin-for-stripe-redirects */
 function isLoopbackHost(host: string): boolean {
   let parsed: URL
   try {
@@ -83,7 +82,6 @@ function isLoopbackHost(host: string): boolean {
   return LOOPBACK_HOSTNAMES.has(parsed.hostname.toLowerCase())
 }
 
-/** docs/membership-guide.md#origin-for-stripe-redirects */
 export function requestOrigin(request: PluginRequest): string {
   if (request.boardUrl !== '') return request.boardUrl
   const host = request.headers.host ?? ''

package/src/index.ts

@@ -1,9 +1,3 @@
-/**
- * `plugin` and `messages` (below) are the manifest-installable convention
- * board.plugins.json generation relies on (scripts/board-plugins-gen.mjs) —
- * re-exports, not a second definition, so `dues` stays the name everyone
- * reads in code that names it directly.
- */
 export type { DuesConfigInput, DuesPlanInput } from './config'
 export { createDues, dues, dues as plugin } from './definition'
 export {

package/src/plans.ts

@@ -117,12 +117,6 @@ function bad(error: string): PlanParse {
   return { ok: false, error }
 }
 
-/**
- * Checks a fixed plan's length against `MAX_GRACE_DAYS`, not the live
- * `grace_days` setting — mirroring the seed-path cap in `parseDuesConfig`
- * (`config.ts`), for the same reason: `grace_days` is a runtime setting an
- * operator can raise after the plan already exists.
- */
 export function parsePlanForm(form: PlanFormInput): PlanParse {
   const key = (form.key ?? '').trim().toLowerCase()
   if (!PLAN_KEY.test(key)) return bad('bad-key')