53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
# Changelog
|
|
|
|
Each package and app has its own section and its own tags (`contracts@1.0.0`, `accounts@1.0.0`, …).
|
|
|
|
## Unreleased
|
|
|
|
### Docs
|
|
|
|
- The roadmap (`docs/ROADMAP-v3.md`) and the Hub protocol (`docs/hub-protocol.md`) move here from
|
|
`hope-events/docs/`, since they cover every product. New: `docs/HANDOVER.md` (where each phase
|
|
stands) and `docs/EVENTS-2.2-PLAN.md` (phase 1b, Cross Events into the monorepo).
|
|
|
|
## contracts@1.1.0 - 2026-11-04
|
|
|
|
### Contracts
|
|
|
|
- Hub protocol v2: optional `requires` on a release (`[{ product, version }]`), the sibling
|
|
versions it needs. The Hub refuses an update request with `409 REQUIREMENT_NOT_MET` until
|
|
they're met (Hub 2.0, ROADMAP-v3 §5). Optional, so the schema stays `/1`-compatible.
|
|
|
|
## contracts@1.0.0 - 2026-11-04
|
|
|
|
### Monorepo
|
|
|
|
- Set up: npm workspaces (`packages/*`, `apps/*`), shared TypeScript, ESLint and Jest setup,
|
|
and `npm run check` (lint, typecheck, tests and build).
|
|
- `packages/contracts`: package set up with a dual CommonJS / ESM build (tsup) and the
|
|
schema-name helpers every contract uses (`crosscode.<name>/<major>`).
|
|
- `packages/ui`, `apps/accounts`, `apps/website`, `apps/app`: placeholders.
|
|
|
|
### Contracts
|
|
|
|
- `crosscode.event/1` and `crosscode.event-feed/1`: the event, the feed response and the
|
|
`event.changed` webhook. Checks that `startsAt` / `endsAt` match the sessions and that only
|
|
Cross Events takes registrations. `parseEventFeed` skips and reports a bad event instead of
|
|
failing the whole feed; `eventKey` is the cross-product id.
|
|
- `crosscode.church/1`: the church profile (branding, campuses, service times, contact, links).
|
|
- `crosscode.identity/1`: sign-in claims (no roles; 2FA method including the authenticator app,
|
|
news consent, privacy notice version) and the `user.updated`, `user.deleted` (with a
|
|
"deferred" reply) and `user.export` back-channel calls.
|
|
- Sign-in return: `isSafeReturnPath`, `safeReturnPath`, `encodeState` / `decodeState` and
|
|
`isRegisteredRedirectUri`, so every product sends people back to the page they came from in
|
|
the same safe way.
|
|
- Hub protocol v2: `product` on register and heartbeat, stats per product (Events as in v1;
|
|
Website storage and App active-member bands for billing), the install's public key, linked
|
|
products in the replies, `customerId` / `product` in the licence token.
|
|
- `@crosscode/contracts/signing` (Node only): the Hub's HMAC scheme for the Hub and product links.
|
|
- Sample payloads for every contract in `samples/`, checked by the tests.
|
|
- **JSON Schema** (draft 2020-12) for every contract in `schemas/`, generated from the zod
|
|
schemas by `npm run build` (`scripts/json-schemas.cjs`), for consumers that don't use
|
|
TypeScript or zod. A test checks the files match the zod schemas and that every sample passes
|
|
them (Ajv). Checks JSON Schema can't express (e.g. `startsAt` matching the sessions) only run in zod.
|