feat(kit): the two shapes Teams added, taught and built
MODULE_API 1.6.0 expands the contract this book teaches against, so the book
owes two shapes and one correction. Chapter 2 gains both and the template grows
a working version of each, because a reader following a snippet has no way to
find out whether it runs.
ONE SENTENCE WAS WRONG. Chapter 2 said, of extension slots, "Only core may
declare a slot; a module may only fill one". 1.6.0 inverted exactly that: a
module declares a place on its OWN page and core fills it. That is not a stale
detail - a new game's module cannot implement Teams at all without the inverted
direction, so it is the shape the reader needs and did not have.
THE TWO SHAPES
- The inverted slot. A new "Slots go the other way too" section: why the
direction has to invert (core owns the Team, not the word for one), the
namespace rule, one slot per PLACE, the optional { core } naming which of
core's three contributions goes there, and why asking for one core does not
offer throws when almost everything else in that registry fails open.
- registerTeamProvider, in "Becoming the source of Teams". The first
registration where core calls YOU and waits, which is where every rule in it
comes from: the envelope, the ten-second budget, refusing as a normal answer,
and the one mistake worth naming - answering with an empty list because the
game is unreachable, which core reads as authoritative and acts on.
projectRoster gets its own treatment because it is the exception that fails
CLOSED. pageUrlTemplate is a footnote beside it, as intended.
WHAT THE TEMPLATE GREW
model/clans/ - the provider over two tables, with the guards that matter: an
unreachable game refuses rather than reporting no clans, an empty roster is
refused unless the game says the clan is empty (which is why the schema keeps a
member count the rows cannot supply), and the audience rule lives in one file
that both projectRoster and the module's own page consult, because a second copy
drifts in the direction that publishes what core is withholding.
Its own /clans routes, deliberately not /teams - core mounts that itself, and
the loader would refuse the collision. A clan list page and a clan page that
declares three slots for core.
12 provider tests and three registration tests, 47 server and 20 client in
total. The purge test finally proves something: two of the three tables are now
a parent and its child.
WHAT IT DOES NOT DO. Enumerate the contract. The kit teaches one path end to end
and links out; it has never mentioned three pre-Teams registrations and that is
the design, not a gap.
FOUND WHILE WRITING IT: core filled three literal uo.guild.* slot names, so the
inverted direction reached exactly one module and every other game's page came
up empty with nothing logged. Fixed in website#160 / Module-uo#15 / docs#165
before this chapter could teach it - which is what this phase is for.
The ci/core-ref.json pin moves in a later commit on this branch: checkCoreApi is
an equality against a core on main, and 1.6.0 does not reach main until the
cutover.
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
52
template/server/router/public/clans.router.js
Normal file
52
template/server/router/public/clans.router.js
Normal file
@@ -0,0 +1,52 @@
|
||||
// ── Public · Clans ────────────────────────────────────────────────────────
|
||||
//
|
||||
// Mounted at `/api/v1/public/clans`. The module's own surface for the things
|
||||
// core calls Teams — the list and one clan's roster, in this game's vocabulary,
|
||||
// served from this module's tables.
|
||||
//
|
||||
// ── Why the prefix is `/clans` and could not be `/teams` ──────────────────
|
||||
//
|
||||
// **Core mounts `/api/v1/public/teams` itself.** Teams are a core primitive, so
|
||||
// core answers the platform-level questions about them; what this module adds is
|
||||
// the same clans in its own words, with the fields core has no schema for. The
|
||||
// loader would refuse `/teams` outright at registration — a prefix collision it
|
||||
// CAN see, unlike the tier-root routes `world.router.js` warns about — so the
|
||||
// failure here is loud, immediate, and a boot that never happens.
|
||||
//
|
||||
// Which raises the question worth answering before you copy this: **does your
|
||||
// module need this router at all?** Core already serves `/public/teams` and
|
||||
// `/public/teams/:slug/roster`, projected through your `projectRoster`. A module
|
||||
// wants its own only when it has something core does not model — here the game's
|
||||
// rank labels and who is online, which are this game's ideas and not Teams. If
|
||||
// what you would serve is what core already serves, do not.
|
||||
|
||||
const core = require('../../core')
|
||||
|
||||
const express = core.express
|
||||
const clans = require('./clans.controller')
|
||||
const { siteMode } = core.middleware
|
||||
|
||||
const clansRouter = express.Router()
|
||||
|
||||
clansRouter.get(
|
||||
'/',
|
||||
// #swagger.tags = ['Public · Example Game']
|
||||
// #swagger.summary = 'Every clan the game has reported'
|
||||
// #swagger.description = 'The clans this deployment knows about, in the game’s own vocabulary. Core calls these Teams and serves its own view of them at `/public/teams`; this route adds what core has no schema for. Answers with an empty list rather than failing when the game is unreachable — the list is a page, not a sync.'
|
||||
/* #swagger.responses[200] = { description: 'The clans', content: { "application/json": { schema: { $ref: "#/components/schemas/ExamplegameClanList" } } } } */
|
||||
siteMode,
|
||||
clans.list,
|
||||
)
|
||||
|
||||
clansRouter.get(
|
||||
'/:externalId',
|
||||
// #swagger.tags = ['Public · Example Game']
|
||||
// #swagger.summary = 'One clan and its roster'
|
||||
// #swagger.description = 'A clan by the game’s own id, with the roster as the game reported it. This is the module’s unprojected view of its OWN data and it deliberately withholds the member key and any linked account id — the roster core serves at `/public/teams/{slug}/roster` is the one that runs through `projectRoster`, and a module route that published more than core’s would route around its own visibility rules.'
|
||||
/* #swagger.responses[200] = { description: 'The clan', content: { "application/json": { schema: { $ref: "#/components/schemas/ExamplegameClan" } } } } */
|
||||
/* #swagger.responses[404] = { description: 'No such clan', content: { "application/json": { schema: { $ref: "#/components/schemas/Error" } } } } */
|
||||
siteMode,
|
||||
clans.detail,
|
||||
)
|
||||
|
||||
module.exports = clansRouter
|
||||
Reference in New Issue
Block a user