2.5 KiB
2.5 KiB
Changelog
Each package and app has its own section and its own tags (contracts@1.0.0, accounts@1.0.0, …).
Unreleased
contracts@1.1.0 - 2026-11-04
Contracts
- Hub protocol v2: optional
requireson a release ([{ product, version }]), the sibling versions it needs. The Hub refuses an update request with409 REQUIREMENT_NOT_METuntil 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, andnpm 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/1andcrosscode.event-feed/1: the event, the feed response and theevent.changedwebhook. Checks thatstartsAt/endsAtmatch the sessions and that only Cross Events takes registrations.parseEventFeedskips and reports a bad event instead of failing the whole feed;eventKeyis 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 theuser.updated,user.deleted(with a "deferred" reply) anduser.exportback-channel calls.- Sign-in return:
isSafeReturnPath,safeReturnPath,encodeState/decodeStateandisRegisteredRedirectUri, so every product sends people back to the page they came from in the same safe way. - Hub protocol v2:
producton 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/productin 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 bynpm 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.startsAtmatching the sessions) only run in zod.