@onlyworlds/sdk 4.81.0 → 4.81.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/CHANGELOG.md +110 -104
- package/README.md +2 -2
- package/SCHEMA.md +1 -1
- package/dist/index.d.ts +12 -12
- package/dist/index.js +4 -4
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# For AI agents using @onlyworlds/sdk
|
|
2
2
|
|
|
3
|
-
**Current as of**: SDK **4.x** · schema-dist **v0.33.0-dist.
|
|
3
|
+
**Current as of**: SDK **4.x** · schema-dist **v0.33.0-dist.74** (canonical 00.33.00).
|
|
4
4
|
This line is asserted by `codegen:check` in CI — if the pin moves and this file is not
|
|
5
5
|
re-read against it, the check fails rather than letting this document rot quietly.
|
|
6
6
|
|
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ earlier history lives in git log only.
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased]
|
|
7
7
|
|
|
8
|
+
## [4.81.1] - 2026-10-26
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- **Schema repinned to schema-dist `v0.33.0-dist.74`** (from dist.73; the same canonical 00.33.00, so `ONLYWORLDS_VERSION` stays `'00.33.00'`, no schema file moved and no generated type changed). Serial 74 is text only: the dist's README ends on a maintainer line, and six profile pages (checks, names, packet, review, room, spine) no longer name people or point inside the project's own tracker. No reader and no fixture changed.
|
|
13
|
+
|
|
8
14
|
## [4.81.0] - 2026-10-26
|
|
9
15
|
|
|
10
16
|
### Added
|
|
@@ -83,7 +89,7 @@ earlier history lives in git log only.
|
|
|
83
89
|
|
|
84
90
|
### Added
|
|
85
91
|
|
|
86
|
-
- **A hide's and an unhide's row on `/changes`**: `OwChangeUpsert` names `changed_at`, `changed_by` and `changed_via`, which keel sends only on the upsert row a hide or an unhide gives the readers who still see the element (the owner's keys, a co-builder, the member who made it
|
|
92
|
+
- **A hide's and an unhide's row on `/changes`**: `OwChangeUpsert` names `changed_at`, `changed_by` and `changed_via`, which keel sends only on the upsert row a hide or an unhide gives the readers who still see the element (the owner's keys, a co-builder, the member who made it). The body carries `hidden: true` after a hide and no `hidden` after an unhide; the row's `change_seq` is the act's, the element's own stays in `element`. Every other upsert row carries none of the three.
|
|
87
93
|
|
|
88
94
|
## [4.73.0] - 2026-10-25
|
|
89
95
|
|
|
@@ -107,7 +113,7 @@ earlier history lives in git log only.
|
|
|
107
113
|
|
|
108
114
|
### Fixed
|
|
109
115
|
|
|
110
|
-
- **`OwElementBase.hidden`'s doc comment says what a create does with it.** It said a write ignores the mark. Since
|
|
116
|
+
- **`OwElementBase.hidden`'s doc comment says what a create does with it.** It said a write ignores the mark. Since 2026-10-23, a create (a POST, a PUT of a new id, a `/bulk` item that creates) carrying `hidden: true` creates the element hidden, from the owner's keys or a co-builder's; any other key gets 403 `hidden_not_allowed` and nothing is created. Every other write still ignores it. The SDK already sent the mark as the element had it; only the words were wrong, in the types an editor shows (`dist/index.d.ts`). (Corrected after release: the entry first said they reach the docs' TypeScript reference, which lists the methods and not this field.)
|
|
111
117
|
- Tests: `create`, `upsert` and `bulk` send `hidden` as given (it is not on the stripped list); a 403 `hidden_not_allowed` surfaces as `OwApiError.code`.
|
|
112
118
|
|
|
113
119
|
## [4.72.1] - 2026-10-24
|
|
@@ -131,14 +137,14 @@ earlier history lives in git log only.
|
|
|
131
137
|
|
|
132
138
|
- **`buildAskContext(items, index, { includeProposed, includeHidden, includeRoom })`**, each default false: true sends that kind again. A proposed element sent carries the review profile's label on its first line, `[proposed, not yet reviewed] Name (type)`, where the AI reading the text sees it. An option that is not a boolean is a TypeError, and an unknown key is refused by name (the options fence, `test/options.test.mjs`). Types `OwAskContextOptions` and `OwAskLeftOut`.
|
|
133
139
|
- **`REVIEW_PROPOSED_LABEL`** (`'proposed, not yet reviewed'`), generated into `types.generated.ts` from rule 1's own sentence in the vendored `profiles/review.md` ("labels each one it keeps **"…"**"); codegen exits 1 if the sentence is missing or occurs twice.
|
|
134
|
-
- **`minted_by: string | null` on `OwWorldLink` and `OwCreatedWorldLink
|
|
140
|
+
- **`minted_by: string | null` on `OwWorldLink` and `OwCreatedWorldLink`**: the membership (its id in GET /api/v2/members) of the co-builder who minted the link over POST /api/v2/links; null for a link the owner made. Served by `createWorldLink` and `listWorldLinks`. No client for `/api/v2/links` itself yet.
|
|
135
141
|
- Tests: each mark left out by default and listed; `hidden` as §4.8 reads it (`"true"` and 1 out, false and null in); a doubt (`"yes"`, `{}`) treated as proposed and labelled when asked, a cleared `null` settled; each `include*` bringing back its own kind only; the label on the first line; a hidden proposed element counted once, under hidden; a kept element's links to a hidden element and from a room element read without their names; the limits over what remains; the fence and the boolean check. Ten mutants, each red on its own test: no proposed filter, no hidden filter, no room filter, no label, a doubt not proposed, proposed checked before hidden, left-out elements counted toward the total, no link view, no option fence, no boolean check.
|
|
136
142
|
|
|
137
143
|
## [4.71.0] - 2026-10-24
|
|
138
144
|
|
|
139
145
|
### Added
|
|
140
146
|
|
|
141
|
-
- **`nfc(text)`**: Normalization Form C as Unicode 15.1 defines it, built from Unicode's own `UnicodeData-15.1.0.txt` and `CompositionExclusions-15.1.0.txt` (schema-dist serial 57
|
|
147
|
+
- **`nfc(text)`**: Normalization Form C as Unicode 15.1 defines it, built from Unicode's own `UnicodeData-15.1.0.txt` and `CompositionExclusions-15.1.0.txt` (schema-dist serial 57), never the runtime's. It is the NFC half of OW-18's fold, beside `simpleCaseFold`, exported so a tool that compares names the way a world file does gets the same answer. This export is why the release is a minor, not 4.70.1.
|
|
142
148
|
|
|
143
149
|
### Fixed
|
|
144
150
|
|
|
@@ -153,47 +159,47 @@ earlier history lives in git log only.
|
|
|
153
159
|
|
|
154
160
|
### Added
|
|
155
161
|
|
|
156
|
-
- **`writeWorldFile(files, topDir, { includeHidden: false })`** (folder spec §4.8, Skeld,
|
|
162
|
+
- **`writeWorldFile(files, topDir, { includeHidden: false })`** (folder spec §4.8, Skeld, 2026-10-23): a world file is a copy, so an element file carrying the hidden mark travels byte for byte by default, as before. A tool making a file to hand to someone else passes `includeHidden: false`, and every `.json` file directly in a type folder of `elements/` or the legacy `spatial/` whose JSON has a top-level `hidden` (anything but absent, `null` or `false`, so `"true"` and `1` count, as the Python package's `is_hidden`) is left out whole. A file there that is not UTF-8 JSON, or not an object, is kept. Nothing else is rewritten: a visible element's link to a hidden one keeps its id. The two defaults differ on purpose: private records out unless asked, hidden kept unless the write is a share.
|
|
157
163
|
- **`report: (r: OwWriteWorldFileReport) => void`**, a `writeWorldFile` option: called once with `{ hiddenLeftOut }` after the archive is made and before it is returned, never on a refusal. The return stays the bytes. An `includeHidden` that is not a boolean, or a `report` that is not a function, is a `TypeError` before anything is written; both keys join the options fence.
|
|
158
164
|
|
|
159
165
|
### Fixed
|
|
160
166
|
|
|
161
|
-
- **`draught`'s doc comment names `compact`** (4.69.0
|
|
167
|
+
- **`draught`'s doc comment names `compact`** (4.69.0), so the docs' generated reference row carries it.
|
|
162
168
|
- Tests: a hidden element file byte-identical by default and with `includeHidden: true`, the report 0; left out as a share, the report 1, every other file byte-identical; the legacy layout, `.JSON`, and a doubtful mark left out; not JSON, not UTF-8, not an object, a null or nested mark, a deeper file, a non-JSON file and the other parts kept; the same bytes for the same files either way; the report not called on a refusal; the fence. Watched failing with the leave-out turned into a keep (3 tests red), restored. The 85-case `.owworld` set unchanged.
|
|
163
169
|
|
|
164
170
|
## [4.69.0] - 2026-10-23
|
|
165
171
|
|
|
166
172
|
### Added
|
|
167
173
|
|
|
168
|
-
- **`draught(id, { compact: true })
|
|
174
|
+
- **`draught(id, { compact: true })`**: the draught without its empty sections. Every empty array or object section and an empty `cut` are left out. The frame (`world`, `calendar`, `as_of`, `now`, `mode`, `policy`) and every null stay, so a null is still an answer: `character` null means she is hidden from this reader, `style` null that she has no style element, `recent_cursor` null that the read had no `since`. An absent section means nothing in it, never that it was not read (`policy.components` says what was). The answer is typed `OwDraughtCompact` (`cut` optional); without `compact`, or with `compact: false`, it is `OwDraught` as before, the fixed shape. A `compact` that is not a boolean is a TypeError before anything is sent. MCP's `get_draught` defaults to compact; this route defaults to the fixed shape.
|
|
169
175
|
|
|
170
176
|
## [4.68.0] - 2026-10-23
|
|
171
177
|
|
|
172
178
|
### Fixed
|
|
173
179
|
|
|
174
|
-
- **`patchWorld` strips `counts`**, which a keyless `GET /world` carries (
|
|
175
|
-
- **`reviewNewElement` refuses a reason with an accept** before sending (keel takes `{ decision: 'accept' }` alone; a reason was its 422), and **checks its answer**: an accept that answers no `element`, or a decline no `deleted`, is a `TypeError` naming the route. Both as the Python package does (Quillon,
|
|
180
|
+
- **`patchWorld` strips `counts`**, which a keyless `GET /world` carries (the public reader, on since 2026-10-23) and `PATCH` answers as an unknown key, so the body of a keyless read goes back too. Quillon's port found it (2026-10-23); the Python package's live wire test went red on the same key the same hour.
|
|
181
|
+
- **`reviewNewElement` refuses a reason with an accept** before sending (keel takes `{ decision: 'accept' }` alone; a reason was its 422), and **checks its answer**: an accept that answers no `element`, or a decline no `deleted`, is a `TypeError` naming the route. Both as the Python package does (Quillon, 2026-10-23).
|
|
176
182
|
|
|
177
183
|
## [4.67.0] - 2026-10-23
|
|
178
184
|
|
|
179
185
|
### Added
|
|
180
186
|
|
|
181
|
-
- **The draught's `room` and `proposed` components**: `OwDraughtComponent` is now keel's thirteen, in its order. `room`
|
|
187
|
+
- **The draught's `room` and `proposed` components**: `OwDraughtComponent` is now keel's thirteen, in its order. `room` is the room profile's other elements that reach her (a board entry, a spec, a heart, a vote, a sitting, a member card, a work item that is not open or taken), each there or nowhere; the type missed it since keel shipped it. `proposed` (live 2026-10-23) is every element carrying `x_review_proposed` that reaches her, there or nowhere, whatever section would have held it; `cut.proposed` counts the ones left out, the component unnamed or its budget spent, so a tool handing a draught on can say so. Both are off unless named, as `messages` is: `draught(id, { components: [..., 'room', 'proposed'] })`. `OwDraught.room` and `OwDraught.proposed` are typed.
|
|
182
188
|
|
|
183
189
|
### Fixed
|
|
184
190
|
|
|
185
|
-
- **`OwDraughtItem` nests the element**: keel has served each draught row as `{ via, circles?, her_links, grade, dated?, element }` since the route shipped
|
|
191
|
+
- **`OwDraughtItem` nests the element**: keel has served each draught row as `{ via, circles?, her_links, grade, dated?, element }` since the route shipped, and the type spread the element's fields onto the row instead. Read `row.element.name`, not `row.name` (which was `undefined` at runtime all along); TypeScript code that read the spread form now fails to compile where it was already wrong. In the same way `OwDraught.character` is `{ self, grade, element }`, and optional (absent unless `self` is served), `work` rows carry `packet` (the work item's `x_packet_elements`), `messages` rows carry `author` (`membership`, `kind`, `role`), and rows may carry `circles`. Read from keel's `elements/draught.py` and its OpenAPI `Draught` schema; nothing at runtime changed.
|
|
186
192
|
- Tests: `components: ['room', 'proposed']` is sent as `components=room,proposed`; the published `OwDraughtComponent` lists keel's COMPONENTS in order; the nested rows, `cut.proposed`, `character.element`, `packet`, `author` and `circles` compile against the built `.d.ts`, and a spread read and an unknown component do not. Watched failing with `'proposed'` cut from the type.
|
|
187
193
|
|
|
188
194
|
## [4.66.0] - 2026-10-23
|
|
189
195
|
|
|
190
196
|
### Added
|
|
191
197
|
|
|
192
|
-
- **`createAccountWorld({ name, pin?, keyName?, source?, producer? })`** (account token): `POST /account/worlds` makes a world on the account with its one write key. Sent in keel's spelling, only the keys given (`keyName` as `key_name
|
|
193
|
-
- **The world's queue lists new elements written as proposed** (
|
|
198
|
+
- **`createAccountWorld({ name, pin?, keyName?, source?, producer? })`** (account token): `POST /account/worlds` makes a world on the account with its one write key. Sent in keel's spelling, only the keys given (`keyName` as `key_name`: 1 to 80 characters, trimmed, `null` for none; `source` and `producer`: the folder format's provenance lines, each an object or `null`, kept on the World and served by `getWorld()` as `origin`). `pin` only while the account has no PIN (it becomes the account PIN); an account with one must leave it out. Either mistake is a 422 with `err.param === 'pin'` and nothing made, so a tool that cannot tell which account it holds sends without `pin` first and again with it on that 422, as Atlas's Make online does. Returns `OwCreatedAccountWorld`: the world's row as `listAccountWorlds` lists it, plus the full write key once in `key`. No Idempotency-Key (the document declares none), and neither `X-OW-Agent` nor `X-OW-Client` (it declares neither here). keel's document gives the 201 no schema, so the type is read from keel's handler. A world key is a `TypeError`, as is an unknown option or a missing `name`, before anything is sent. Atlas can retire its own `AccountClient.createWorld` for it.
|
|
199
|
+
- **The world's queue lists new elements written as proposed** (live 2026-10-23): `worldProposals()` now returns `OwWorldProposalList`, whose rows are `OwWorldProposalRow`, told apart by `kind`: `OwProposal` (`kind: 'proposal'`) or `OwProposedNewElement` (`kind: 'new_element'`: an element carrying `x_review_proposed`, its `by`, `evidence` and `expires` the mark's words, `state` `open` or `lapsed`). One order, newest first by `created_at`; the cursor is opaque and goes back as it came (an old bare proposal id still reads). `listProposals` keeps `OwProposalList`: one element's proposals only.
|
|
194
200
|
- **`reviewNewElement(type, id, { decision, reason? })`**: `POST /{type}/{id}/review`, a keeper (the owner or a co-builder, with the PIN) settles a new element written as proposed. `accept` clears the mark and returns `{ element }`; `decline` deletes the element and returns `{ deleted }` (its id); the reason is answered back and kept nowhere. Sends `X-OW-Client`, as the document lists, and no `X-OW-Agent`. A `decision` other than `accept` or `decline`, or an unknown key, is a `TypeError` before sending. Type `OwReviewed`, options `OwReviewInput`.
|
|
195
201
|
- **`err.isNotProposed`**: 422 `not_proposed`, the element carries no mark to settle. `isProposedOnly` (403) also answers the seat the mark names.
|
|
196
|
-
- **`OwProposal.kind`** (`'proposal'`) and **`OwProposal.omitted
|
|
202
|
+
- **`OwProposal.kind`** (`'proposal'`) and **`OwProposal.omitted`**: a row's `fields` now holds only what differs from the element when proposed, and `omitted` names the fields an upsert left out that were not empty (each in `fields` at its empty value, so an accept empties it; `[]` for a patch, a link edit or `propose`). A propose with nothing new is a 422 with `param: 'fields'`; a seat's write that changes nothing under the world's switch answers 200 with the element and makes no row.
|
|
197
203
|
|
|
198
204
|
### Changed
|
|
199
205
|
|
|
@@ -204,7 +210,7 @@ earlier history lives in git log only.
|
|
|
204
210
|
|
|
205
211
|
### Fixed
|
|
206
212
|
|
|
207
|
-
- **`patchWorld` takes a `getWorld()` body back again** (
|
|
213
|
+
- **`patchWorld` takes a `getWorld()` body back again** (live 2026-10-23). keel's `GET /world` now serves `origin`, and a PATCH naming it is a 422 (an unknown key), so a world body read and sent back failed. `patchWorld` now leaves out `origin`, and `id` too: keel answers `id` with the same 422 (it is not a key PATCH takes), so the round trip 4.57.1's entry promised never held for a whole body. `owner_character` is still sent.
|
|
208
214
|
|
|
209
215
|
### Added
|
|
210
216
|
|
|
@@ -235,7 +241,7 @@ earlier history lives in git log only.
|
|
|
235
241
|
|
|
236
242
|
### Added
|
|
237
243
|
|
|
238
|
-
- **`typeWord(world, type, { supertype, many })`**, the names profile's reader (schema-dist `profiles/names.md
|
|
244
|
+
- **`typeWord(world, type, { supertype, many })`**, the names profile's reader (schema-dist `profiles/names.md`): a world's own word for a type, from `x_names` on the World (a `getWorld()` body, keel serving `x_` keys on the World, or a folder's `world.json`). The supertype's entry first, matched trimmed and without regard to case (the room profile's one definition, shared with `isRoomElement`), then the type's entry, else `null`: print the standard's name. `many: true` gives the plural, `one` when the pair has none. A value that is not a names map is `null` everywhere; a bad entry or an unknown slug is ignored. The options object refuses an unknown key with a `TypeError`. Types `OwNamesMap` and `OwWordPair`. Display only: the API, the folder, the schema and every id keep the standard's names.
|
|
239
245
|
- Tests: the profile's 23-case fixture, read from the vendored distribution, as its own test; no world, no map and an unknown option.
|
|
240
246
|
|
|
241
247
|
### Changed
|
|
@@ -246,41 +252,41 @@ earlier history lives in git log only.
|
|
|
246
252
|
|
|
247
253
|
### Added
|
|
248
254
|
|
|
249
|
-
- **`delete(type, id, { ifMatch })`** (
|
|
255
|
+
- **`delete(type, id, { ifMatch })`** (live 2026-10-22 21:3x): `DELETE` reads `If-Match` exactly as `PATCH` does. With the element's `change_seq` as you read it, a delete of an element someone changed since is refused, `OwPreconditionFailedError` (412) with `current`, nothing deleted; on an element already gone it is the idempotent 204. Under a world's proposals switch a delete is never a proposal. The options object refuses an unknown key like every other.
|
|
250
256
|
- Tests: the header sent and left out, the unknown option, the 412; each watched failing with the header dropped. The wire gate now reads from keel's document which Character operations take `If-Match` (it held a hand list of two and missed this one) and fails on 4.60.0.
|
|
251
257
|
|
|
252
258
|
## [4.60.0] - 2026-10-22
|
|
253
259
|
|
|
254
260
|
### Added
|
|
255
261
|
|
|
256
|
-
- **`OwFrontDoor`, and `front_door` on `OwMe` and `OwAgentJoined`** (
|
|
262
|
+
- **`OwFrontDoor`, and `front_door` on `OwMe` and `OwAgentJoined`** (live 2026-10-22 20:1x). `me()`, `setMyCharacter()` and an agent's `redeemJoin()` answer carry the world's front door for the key: `sponsor` (`{id, kind, name}` of the person who answers for a seat, or null), `sponsor_character`, `my_character`, `charter` (the world's Charter, every member's to read: read it first) and `charter_skill` (up to five Objects the Charter names). Every id is one the key may read; anything hidden is null or left out. Types only: the client already passed the body through. Required on both types, as keel's document declares it; a hand-built `OwMe` in a consumer's test needs the field.
|
|
257
263
|
|
|
258
264
|
## [4.59.0] - 2026-10-22
|
|
259
265
|
|
|
260
266
|
### Changed
|
|
261
267
|
|
|
262
|
-
- **`API-Pin` is sent only where keel checks it** (Skeld's ruling,
|
|
268
|
+
- **`API-Pin` is sent only where keel checks it** (Skeld's ruling, 2026-10-22). keel verifies a PIN wherever one is sent (argon2, 64 MiB each), and on 2026-10-22 scripts reading with the PIN OOM-killed staging on a cold cache after a restart. The client used to send a configured `apiPin` on every request. It now sends it on every request whose method is not GET (every write: elements, links, bulk, adopt, hide and unhide, media and file tickets, seats, world links, proposals, `setMyCharacter`, `mintWorldKey`, `patchWorld`, and any route added later), on `GET /me` (`me()`, the connection test: keel checks a PIN there when sent), and on every request of a 10-digit legacy key (v1 parity: such a key needs the PIN on reads of a world with a PIN). Any other read from an `ow_w_`, `ow_r_` or member key goes without it; an account token never sent it and still does not. The rule is derived in `request()` from the method and path, so a raw `request()` call follows it too. No API changed.
|
|
263
269
|
- Tests: `test/api-pin.test.mjs`, five, on a recorded fetch: eight reads, `me()` and ten writes across POST, PATCH, PUT and DELETE, for an `ow_w_` key with a PIN, a legacy key with a PIN, an `ow_r_` key with none and an account token with one configured; and raw `request()` GETs to other paths, `/me` and other methods. Two existing tests that expected the PIN on a GET now expect none. Mutants: the PIN on every request again fails four tests; without the `/me` clause, three; without the legacy clause, one.
|
|
264
270
|
|
|
265
271
|
## [4.58.0] - 2026-10-22
|
|
266
272
|
|
|
267
273
|
### Added
|
|
268
274
|
|
|
269
|
-
- **The proposed change** (
|
|
275
|
+
- **The proposed change** (live 2026-10-22 16:25). Six calls: `propose(type, id, { fields, evidence, expires? })` (any member key that reads the element; `fields` cleaned as a PATCH body is; `Idempotency-Key` only when given), `listProposals(type, id, { limit?, cursor? })`, `worldProposals({ state?, since?, element?, limit?, cursor? })` (the queue, newest first; keepers see every row, others their own), `acceptProposal(type, id, pid)` (`{ proposal, element }`: the keeper's own write, one feed row), `declineProposal(type, id, pid, { reason? })` and `withdrawProposal(type, id, pid)` (204). Types `OwProposal`, `OwProposalList`, `OwProposed`, `OwProposalState`, `OwProposalQuery`, `OwWorldProposalQuery`, `OwProposalAccepted`. Every options object refuses an unknown key with a `TypeError` before anything is sent. `X-OW-Client` goes on `propose` and accept, where the document lists it; `X-OW-Agent` on none of them.
|
|
270
276
|
- **A write held as a proposal is an error, never a body.** Under the world's **AI seats propose, a person accepts** switch an agent seat's `patch`, `upsert` or `editLinks` answers `202`: the client throws `OwProposedError` (`status` 202, `proposal`, `isProposed`) rather than returning something that is not the element; a `202` with no proposal in its body is a plain `OwApiError` 202. A `/bulk` slot with `status: 202` is left in the result as the document shapes it, typed. `create`, `adopt` and `delete` are not read for a 202: the document gives them none.
|
|
271
277
|
- **Five codes**: `isStaleProposal` (`OwStaleProposalError` with `conflicts: [{ field, base, current }]` and `current`, parsed like the 412), `isOwnProposal`, `isProposedOnly`, `isTooManyOpen`, `isFieldNotVisible`.
|
|
272
278
|
- **`OwWorldMeta.agent_writes_proposed?: boolean`**, read-only; `patchWorld` strips it with `slug`, `public_page`, `public_read` and `agent_narrator_rule`.
|
|
273
|
-
- Tests: 20 on a recorded fetch, 18 red first; two mutants caught. Live on production with the demo key, reads only: `getWorld()` carries `agent_writes_proposed: false`; the queue answers `404` to a read key with no member, as the document says. Not exercised live yet: `propose`, accept, decline, withdraw and the `409` (staging
|
|
279
|
+
- Tests: 20 on a recorded fetch, 18 red first; two mutants caught. Live on production with the demo key, reads only: `getWorld()` carries `agent_writes_proposed: false`; the queue answers `404` to a read key with no member, as the document says. Not exercised live yet: `propose`, accept, decline, withdraw and the `409` (staging does not serve the proposed change at release time; a round-trip script waits for it). Not wired yet: the queue's `ETag`/`If-None-Match` (a conditional `worldProposals`, on the `changesHead` pattern, when a poller asks).
|
|
274
280
|
|
|
275
281
|
## [4.57.2] - 2026-10-22
|
|
276
282
|
|
|
277
283
|
### Changed
|
|
278
284
|
|
|
279
|
-
- **Schema repinned to schema-dist `v0.33.0-dist.47`** (same canonical 00.33.00; no schema file moved, no generated type changed). The distribution gains `profiles/checks.md` and `profiles/checks.fixture.json`, the checks profile: a work world's Charter carries its house rules as `x_checks_rules`, beside the sentences a person reads
|
|
285
|
+
- **Schema repinned to schema-dist `v0.33.0-dist.47`** (same canonical 00.33.00; no schema file moved, no generated type changed). The distribution gains `profiles/checks.md` and `profiles/checks.fixture.json`, the checks profile: a work world's Charter carries its house rules as `x_checks_rules`, beside the sentences a person reads. `profiles/room.md` now defines "trimmed and without regard to case" once, for every profile that folds like the room's pairs: trimmed is leading and trailing whitespace removed, nothing inside touched; without regard to case is the trimmed value after simple case folding.
|
|
280
286
|
|
|
281
287
|
### Fixed
|
|
282
288
|
|
|
283
|
-
- **`isRoomElement` trims Unicode White_Space exactly**, the 25 code points of the property, at both ends of the type and the supertype. It used JavaScript's `trim()`, which also strips U+FEFF, a byte order mark. Skeld's ruling (
|
|
289
|
+
- **`isRoomElement` trims Unicode White_Space exactly**, the 25 code points of the property, at both ends of the type and the supertype. It used JavaScript's `trim()`, which also strips U+FEFF, a byte order mark. Skeld's ruling (2026-10-22) is that a byte order mark stays, so a supertype `"\uFEFFMessage"` is no longer a room element; `" Message\u3000"` still is, and a leading U+200B (zero width space, not White_Space) still is not. The room fixture's 23 cases answer as before.
|
|
284
290
|
|
|
285
291
|
## [4.57.1] - 2026-10-22
|
|
286
292
|
|
|
@@ -292,8 +298,8 @@ earlier history lives in git log only.
|
|
|
292
298
|
|
|
293
299
|
### Added
|
|
294
300
|
|
|
295
|
-
- **The conditional head poll** (
|
|
296
|
-
- **The public page on `OwWorldMeta`** (
|
|
301
|
+
- **The conditional head poll** (live 2026-10-22): `changesHead()` keeps the last head read's `ETag` per client and sends it back as `If-None-Match` on the next one, exactly as received (keel's 200 sends a weak `W/"821:-"`; nothing is quoted, parsed or compared). keel's tag is `"<head>:<epoch>"`, so a view change moves it as a new change does. When nothing moved, keel answers 304 Not Modified with no body, and `changesHead()` returns the `head`, `cursor` and `epoch` of the last 200 with `unchanged: true`; every 200 says `unchanged: false`. keel refunds a 304 against the request budget, so a poll that mostly finds nothing costs little. A 409 `resync_required` from `changesHead()`, `changes()` or `changesAll()` clears the held tag, so the next head read is a full 200 with `epoch_reason`. A 304 while no tag is held is an `OwApiError` with status 304, never a made-up head. The client still never polls or sleeps on its own: the interval is the caller's.
|
|
302
|
+
- **The public page on `OwWorldMeta`** (live 2026-10-22), both read-only: `slug` (`string | null`), the page's address, onlyworlds.com/w/<slug>, null while the page is off, and also a keyless `?world=` value; `public_page` (the new `OwWorldPublicPage`), the page as its owner set it: `on`, `palette` (midnight, daylight, parchment, brass, dusk, or null for the house's), `hero` (one plain line), `sections` (the types shown in order, empty for all), `pin` (an element id or null) and `index` (always false for now), every key present with the page off. Both are set by the owner on the world page; `patchWorld()` strips them, so a body read from `getWorld()` stays writable.
|
|
297
303
|
- **`request()` gains two options**: `ifNoneMatch` (a tag sent as `If-None-Match` as given) and `onEtag(etag, status)` (called with each response's `ETag` and status before the body is read; with it given, a 304 returns null instead of throwing). Every other path is unchanged.
|
|
298
304
|
|
|
299
305
|
### Changed
|
|
@@ -304,7 +310,7 @@ earlier history lives in git log only.
|
|
|
304
310
|
|
|
305
311
|
### Added
|
|
306
312
|
|
|
307
|
-
- **The client's name** (
|
|
313
|
+
- **The client's name** (live 2026-10-22): a constructor option `client`, default `'sdk'`, sent as `X-OW-Client` on every element write (`create`, `upsert`, `patch`, `delete`, `editLinks`, `bulk`, `adopt`) and on no read. keel stores it on the element as `changed_client`, so a reader can tell which tool made the last change (`new OwV2Client({ ..., client: 'atlas' })`). The rule is keel's, exact here: lower case letters, digits and hyphens, 1 to 32 characters (`[a-z0-9-]{1,32}`). Anything else, a capital, a space, an empty string, 33 characters or a value that is not a string, is a TypeError at construction naming the option and the rule, and nothing is trimmed; keel's own fence for a stranger's header is to store null, never a 422. The name is the client's claim about itself, never proof; it changes no door and no permission, and `agent` still decides `X-OW-Agent`.
|
|
308
314
|
- **`changed_client`** on `OwElementBase` (`string | null`, server-managed, read-only, beside `changed_by` and `changed_via`): the name the last write gave, null when it gave none or one outside the rule, for keel's own writes, and for changes from before names were recorded. Sent back in a write it is ignored. **`deleted_client`** on a `/changes` delete (`OwChangeDelete`, beside `deleted_by` and `deleted_via`), the same for the delete; null on a `hidden` row.
|
|
309
315
|
|
|
310
316
|
### Changed
|
|
@@ -316,7 +322,7 @@ earlier history lives in git log only.
|
|
|
316
322
|
|
|
317
323
|
### Added
|
|
318
324
|
|
|
319
|
-
- **The room profile** (schema-dist `profiles/room.md`, serial 45; Skeld's rulings,
|
|
325
|
+
- **The room profile** (schema-dist `profiles/room.md`, serial 45; Skeld's rulings, 2026-10-22): `ROOM_PAIRS`, the eight type-and-supertype pairs a parlor puts in a world (narrative/Message, narrative/Board, relation/Work item, construct/Spec, relation/Heart, relation/Vote, event/Sitting, character/Member), and `isRoomElement(el)`, true when an element's type and supertype, each trimmed and compared without regard to case, match one of them **and** it carries the mark `x_room_of` (the id of the world or sitting the room belongs to) as a non-empty string. A pair without the mark is lore (a novel's letters are Narratives with supertype Message); a mark without a pair is not a room element. The pair match is the whole word, a missing or empty supertype is never a room element, and a Law with supertype `Charter` stays lore. A lore view leaves room elements out unless the person asks; the room's own views show them whole. A convention on the 22 types: no type, field or wire change. `ROOM_PAIRS` is generated from the fixture's `pairs` and checked at codegen against the page's table (they must agree, or codegen exits 1); the mark's name is generated from the fixture's `mark.field` and checked against the page. Case is folded by Unicode simple case folding (`simpleCaseFold`), the same fold as the Python package's `is_room_element`. A new test replays the fixture's 23 cases from the vendored dist.
|
|
320
326
|
|
|
321
327
|
### Changed
|
|
322
328
|
|
|
@@ -372,18 +378,18 @@ earlier history lives in git log only.
|
|
|
372
378
|
|
|
373
379
|
### Added
|
|
374
380
|
|
|
375
|
-
- `setMyCharacter(characterId | null)`: `PUT /me/character`, a person member's pick of the roster Character that is them in this world
|
|
376
|
-
- `hidden?: true` on every element body (`OwElementBase`): present only when the owner or a co-builder hid the element and this reader still sees it
|
|
377
|
-
- `site` joins `OwWriteDoor`: a write or delete the owner made signed in on onlyworlds.com
|
|
381
|
+
- `setMyCharacter(characterId | null)`: `PUT /me/character`, a person member's pick of the roster Character that is them in this world; answers the `/me` body. `err.isCharacterHidden` for the 422 `character_hidden` it and the member PATCH answer.
|
|
382
|
+
- `hidden?: true` on every element body (`OwElementBase`): present only when the owner or a co-builder hid the element and this reader still sees it; never on other readers' bodies, ignored in a write.
|
|
383
|
+
- `site` joins `OwWriteDoor`: a write or delete the owner made signed in on onlyworlds.com.
|
|
378
384
|
|
|
379
385
|
## [4.49.0] - 2026-10-22
|
|
380
386
|
|
|
381
387
|
### Changed
|
|
382
388
|
|
|
383
|
-
- **The world file follows Folder Format §4.7, the `.owworld` archive
|
|
389
|
+
- **The world file follows Folder Format §4.7, the `.owworld` archive**, and gives the spec's verdict and cause on every one of the 74 fixtures in its conformance set (Quillon's, `owworld-fixtures`), plus its three on-demand floor cases.
|
|
384
390
|
- The reader parses the central directory itself (zip64 included) and runs every check on names, kinds, methods and sizes before it inflates anything.
|
|
385
391
|
- Six new refusal causes join `OwWorldFileReason`: `duplicate` (OW-17), `collision` (OW-18: NFC, then simple case folding), `link` (OW-20), `method` (OW-21), `name` (OW-22) and `marker` (OW-6). A `Record<OwWorldFileReason, …>` in a caller needs the six new keys.
|
|
386
|
-
- The OW-18 fold is the C and S rows of Unicode's CaseFolding.txt 15.1, built in as a table, never the runtime's casing, so a fold a newer Unicode adds stays out until the pin moves (Skeld's ruling,
|
|
392
|
+
- The OW-18 fold is the C and S rows of Unicode's CaseFolding.txt 15.1, built in as a table, never the runtime's casing, so a fold a newer Unicode adds stays out until the pin moves (Skeld's ruling, 2026-10-22). `simpleCaseFold(text)` exports it.
|
|
387
393
|
- Files beside the world's folder are ignored, no longer `more_than_one` (OW-4). A `world.json` under `records/` is a producer's data, not a second world (OW-5). A spanned archive is `not_openable`. An entry that inflates past the size it declares is `too_big` at any budget (OW-14).
|
|
388
394
|
- The default budget is the spec's floor: `WORLD_FILE_MAX_BYTES` 2 GiB (was 1 GiB), `WORLD_FILE_MAX_ENTRIES` 500,000 (was 200,000) (OW-15).
|
|
389
395
|
- A `mimetype` marker is never required. One with other bytes than `WORLD_FILE_MEDIA_TYPE` (`application/vnd.onlyworlds.world+zip`, newly exported) is refused, and the marker is never returned as a file.
|
|
@@ -401,50 +407,50 @@ earlier history lives in git log only.
|
|
|
401
407
|
|
|
402
408
|
### Added
|
|
403
409
|
|
|
404
|
-
- `listHidden()`: `GET /world/hidden`, the world's hidden elements newest first as `OwHiddenRow[]` (`type`, `id`, `set_at`, `set_by
|
|
410
|
+
- `listHidden()`: `GET /world/hidden`, the world's hidden elements newest first as `OwHiddenRow[]` (`type`, `id`, `set_at`, `set_by`). Any key of the owner's or a co-builder's; served with `Cache-Control: no-store`, so read it each time. For the parlor, whose host room marks what it hid (Temper, 2026-10-22).
|
|
405
411
|
|
|
406
412
|
## [4.47.0] - 2026-10-22
|
|
407
413
|
|
|
408
414
|
### Added
|
|
409
|
-
- `draught(characterId, policy)`: `GET /character/{id}/context` (
|
|
415
|
+
- `draught(characterId, policy)`: `GET /character/{id}/context` (live 2026-10-22 02:05), one Character's context in one read, typed as `OwDraught` with the policy's seven keys (`components`, `mode`, `asOf`, `undated`, `since`, `budget`, `depth`) as `OwDraughtPolicy`.
|
|
410
416
|
- `list` takes `ids` (1 to 200, the list's own order; one the key cannot see is absent) and `createdBy` (a membership id, or `'owner'`), the two list filters of the same PR; both were already reachable through `filter`.
|
|
411
417
|
|
|
412
418
|
## [4.46.0] - 2026-10-22
|
|
413
419
|
|
|
414
420
|
### Added
|
|
415
|
-
- **Sign in with OnlyWorlds** (
|
|
421
|
+
- **Sign in with OnlyWorlds** (live 2026-10-22 01:50): `signInWithOnlyWorlds({ clientId, redirectUri, resume, storage, navigate })` mints `state` and a PKCE S256 verifier, keeps them under the client id in `storage` (sessionStorage by default; required in Node), refuses a `redirectUri` that is not an `https:` string before sending, and sends the browser to `/signin/authorize`. `completeSignIn({ clientId, storage, url })` on the callback page checks `state` and the page, takes `code` and `state` out of the address bar, trades the code once at `POST /api/v2/auth/token` with no credential, and returns `OwSignInResult` (`token`, `account`, `resume`); the record is cleared either way and the SDK keeps no token. `OwSignInError` gains `invalid_grant` and `state_mismatch`. `pkceChallenge` and `base64url` exported.
|
|
416
422
|
|
|
417
423
|
## [4.45.0] - 2026-10-22
|
|
418
424
|
|
|
419
425
|
### Added
|
|
420
|
-
- `hide(type, id)` and `unhide(type, id)`: the hidden mark's writes, `PUT` and `DELETE /{type}/{id}/hidden
|
|
426
|
+
- `hide(type, id)` and `unhide(type, id)`: the hidden mark's writes, `PUT` and `DELETE /{type}/{id}/hidden`, for the parlor (Temper, 2026-10-22). 204; the element's body and `change_seq` do not move.
|
|
421
427
|
- `listAccountWorlds()` (`GET /account/worlds`, `OwAccountWorld[]`: owned and shared worlds with their keys by name and last four) and `mintWorldKey(worldId, { scope, name })` (`POST /account/worlds/{id}/keys`, `OwMintedKey` with the full key once), the two account routes Atlas and the parlor hand-rolled. Account token only.
|
|
422
428
|
|
|
423
429
|
## [4.44.0] - 2026-10-22
|
|
424
430
|
|
|
425
431
|
### Added
|
|
426
|
-
- `changes({ after })` and `changesAll(since, { after })
|
|
432
|
+
- `changes({ after })` and `changesAll(since, { after })` (live 2026-10-22 00:55): `GET /changes?after=<ISO time>` returns only the changes made at or after that time, a filter and not a position: order, `cursor`, `has_more` and `head` are unchanged, and the window is read by passing the cursor back as `since` with the same `after`. A bad value is a 422 naming `after`.
|
|
427
433
|
|
|
428
434
|
## [4.43.0] - 2026-10-22
|
|
429
435
|
|
|
430
436
|
### Added
|
|
431
|
-
- `adopt(type, id, member)`: change who made an element, `POST /{type}/{id}/adopt` with `{member}` (
|
|
432
|
-
- `createWorldLink`'s `maxUses` is documented for person links too (
|
|
437
|
+
- `adopt(type, id, member)`: change who made an element, `POST /{type}/{id}/adopt` with `{member}` (live 2026-10-22 00:43). `member` is a membership id of the world or `'owner'` (`created_by` null). The owner's key or a co-builder's with its PIN; a contributor's is 403 `not_author` (`isNotAuthor`). Returns the updated element; the write takes a new `change_seq` and the feed carries the element with its new `created_by`.
|
|
438
|
+
- `createWorldLink`'s `maxUses` is documented for person links too (live the same hour): 2 to 50 lets in that many accounts, each joining once with the link's role. The client sent it already; the comment said player links only.
|
|
433
439
|
|
|
434
440
|
## [4.42.4] - 2026-10-21
|
|
435
441
|
|
|
436
442
|
### Fixed
|
|
437
|
-
- **`parseDate` refuses a date the typed era does not hold**, rather than reading its number as an absolute year in another era. With a down era Before Gate turning on 6 Frost, "10 Thaw, 1 BG" read as step 39 ("10 Thaw, 2 AG") and "3 Frost, 0 BG" as "3 Frost, 1 BG"; both now answer `not a date in Before Gate`. The absolute reading stays for a step in no era, where `formatStep` prints the absolute year. No date `formatStep` prints changes how it parses: 20,826 round trips over the profile fixture's calendars read the same before and after. Found by Temper in Atlas 1.67.1 (
|
|
443
|
+
- **`parseDate` refuses a date the typed era does not hold**, rather than reading its number as an absolute year in another era. With a down era Before Gate turning on 6 Frost, "10 Thaw, 1 BG" read as step 39 ("10 Thaw, 2 AG") and "3 Frost, 0 BG" as "3 Frost, 1 BG"; both now answer `not a date in Before Gate`. The absolute reading stays for a step in no era, where `formatStep` prints the absolute year. No date `formatStep` prints changes how it parses: 20,826 round trips over the profile fixture's calendars read the same before and after. Found by Temper in Atlas 1.67.1 (2026-10-21).
|
|
438
444
|
|
|
439
445
|
## [4.42.3] - 2026-10-21
|
|
440
446
|
|
|
441
447
|
### Fixed
|
|
442
|
-
- **`parseDate` reads a down era's dates back to the step they were written from, with a mid-year pivot too.** 4.42.2 moved the display count to the year holding the step before the pivot, and the parse kept the old count, so with a mid-year pivot every date before it parsed back one year early ("6 Frost, 4 BG" read 20 steps early on a 20-step year). Year-boundary pivots were never affected. Found by Quillon porting 4.42.2 to the Unity SDK and confirmed on this kernel by Temper (
|
|
443
|
-
- `redeemJoin`'s doc names a full world's refusal as 422 `world_full` (`isWorldFull`), as keel answers since the party link; it said `invalid_request` (Quillon,
|
|
448
|
+
- **`parseDate` reads a down era's dates back to the step they were written from, with a mid-year pivot too.** 4.42.2 moved the display count to the year holding the step before the pivot, and the parse kept the old count, so with a mid-year pivot every date before it parsed back one year early ("6 Frost, 4 BG" read 20 steps early on a 20-step year). Year-boundary pivots were never affected. Found by Quillon porting 4.42.2 to the Unity SDK and confirmed on this kernel by Temper (2026-10-20); a round-trip test now holds every step on both sides of the pivot.
|
|
449
|
+
- `redeemJoin`'s doc names a full world's refusal as 422 `world_full` (`isWorldFull`), as keel answers since the party link; it said `invalid_request` (Quillon, 2026-10-20).
|
|
444
450
|
|
|
445
451
|
## [4.42.2] - 2026-10-20
|
|
446
452
|
|
|
447
|
-
Two calendar reading fixes, found writing the `atlas_calendar` profile's conformance fixture (
|
|
453
|
+
Two calendar reading fixes, found writing the `atlas_calendar` profile's conformance fixture (2026-10-20).
|
|
448
454
|
|
|
449
455
|
### Fixed
|
|
450
456
|
- **A down era has no year zero, even when its pivot falls mid-year.** Its year is now counted from the year holding the step just before the pivot, which reads `year_base` (1 by default). With the pivot mid-year, the earlier steps of the pivot's own year read year 0 ("0 BG") and every year before it one lower; with the pivot on a year's first step, nothing changes. The mirror of an up era, whose first partial year is year 1.
|
|
@@ -452,7 +458,7 @@ Two calendar reading fixes, found writing the `atlas_calendar` profile's conform
|
|
|
452
458
|
|
|
453
459
|
## [4.42.1] - 2026-10-20
|
|
454
460
|
|
|
455
|
-
The calendar reader refuses what the `atlas_calendar` profile refuses (schema-dist `profiles/calendar.md`; Quillon's Unity read,
|
|
461
|
+
The calendar reader refuses what the `atlas_calendar` profile refuses (schema-dist `profiles/calendar.md`; Quillon's Unity read, 2026-10-20).
|
|
456
462
|
|
|
457
463
|
### Fixed
|
|
458
464
|
- **`readCalendarValue` / `readCalendarConfig` no longer throw on a falsy `eras` or `intercalary`** (`false`, `0`, `""`): it threw a `TypeError` where the profile says a reader refuses and shows bare numbers. It now returns `null`.
|
|
@@ -460,7 +466,7 @@ The calendar reader refuses what the `atlas_calendar` profile refuses (schema-di
|
|
|
460
466
|
|
|
461
467
|
## [4.42.0] - 2026-10-20
|
|
462
468
|
|
|
463
|
-
Schema 00.32.02 (Skeld,
|
|
469
|
+
Schema 00.32.02 (Skeld, 2026-10-20): repinned to schema-dist v0.32.2-dist.29.
|
|
464
470
|
|
|
465
471
|
### Changed
|
|
466
472
|
- **A Narrative's `start_date`** reads "Date when the narrative is first told or recorded, measured in world TIME units; the span it recounts lives on its events" (it read "Date when the narrative begins"), and **its `end_date`** reads "Date when the narrative stops being told, measured in world TIME units; empty while it is still told" (it read "Date when the narrative ends"), in the generated doc comments and `SCHEMA.md`. No field, type or link changed.
|
|
@@ -468,7 +474,7 @@ Schema 00.32.02 (Skeld, OW Council h58 #8811): repinned to schema-dist v0.32.2-d
|
|
|
468
474
|
|
|
469
475
|
## [4.41.0] - 2026-10-20
|
|
470
476
|
|
|
471
|
-
A known-of stub's public fields
|
|
477
|
+
A known-of stub's public fields, live in production, and schema-dist v0.32.1-dist.28, which publishes them.
|
|
472
478
|
|
|
473
479
|
### Added
|
|
474
480
|
- **`PUBLIC_FIELDS`** (generated from the distribution's `presentation.json`, `types.<type>.public`): per element type,
|
|
@@ -488,7 +494,7 @@ A known-of stub's public fields (keel PR 117, keel #448), live in production, an
|
|
|
488
494
|
|
|
489
495
|
## [4.40.0] - 2026-10-20
|
|
490
496
|
|
|
491
|
-
The "known of" stub's client half
|
|
497
|
+
The "known of" stub's client half, live in production since 2026-10-20 13:47.
|
|
492
498
|
|
|
493
499
|
### Added
|
|
494
500
|
- **`known_of?: true`** on `OwElementBase` (generated; `SCHEMA.md` says it too): present, and true, only on a
|
|
@@ -507,10 +513,10 @@ The "known of" stub's client half (keel PR 113, B16; keel #421 §7g), live in pr
|
|
|
507
513
|
|
|
508
514
|
## [4.39.0] - 2026-10-20
|
|
509
515
|
|
|
510
|
-
The party link
|
|
516
|
+
The party link, live in production since 2026-10-20 13:15.
|
|
511
517
|
|
|
512
518
|
### Added
|
|
513
|
-
- The party link (
|
|
519
|
+
- The party link (for Lantern's pick screen, Temper): one player link for a
|
|
514
520
|
table of players. `createWorldLink(worldId, { reader: 'player', maxUses, characters })`, sent as `max_uses`
|
|
515
521
|
and `characters`: 2 to 50 uses, each player picking one Character from the owner's list, in its order; no
|
|
516
522
|
list, each player names a fresh Character after themselves. A table takes no `character`. A link for one
|
|
@@ -520,15 +526,15 @@ The party link (keel #422 PR 2, keel PR 110), live in production since 2026-10-2
|
|
|
520
526
|
`redeemJoin(code, { character })` sends the pick; with `name_required`, `name` alone. A pick a live seat
|
|
521
527
|
already plays is 422 `character_taken` (`err.isCharacterTaken`); a pick off the list, hidden or deleted
|
|
522
528
|
since the link was made, or missing, is 422 `invalid_request` with param `character`
|
|
523
|
-
(`err.isCharacterInvalid`, true for that param only); a world with its 50 players is 422 `world_full` (`err.isWorldFull`, its own code at my ask, Skeld
|
|
529
|
+
(`err.isCharacterInvalid`, true for that param only); a world with its 50 players is 422 `world_full` (`err.isWorldFull`, its own code at my ask, Skeld, 2026-10-20); the last place
|
|
524
530
|
lost to another player is the one 404 (`err.isNotFound`).
|
|
525
531
|
|
|
526
532
|
### Changed
|
|
527
|
-
- Repinned to schema-dist v0.32.1-dist.27: only `example/world-export.json` moved (its `schema_version` now 00.32.01, Skeld
|
|
533
|
+
- Repinned to schema-dist v0.32.1-dist.27: only `example/world-export.json` moved (its `schema_version` now 00.32.01, Skeld, 2026-10-20); no schema file moved, so the generated files change only their source lines.
|
|
528
534
|
|
|
529
535
|
## [4.38.0] - 2026-10-20
|
|
530
536
|
|
|
531
|
-
Schema 00.32.01 (
|
|
537
|
+
Schema 00.32.01 (Titus's word, 2026-10-20): repinned to schema-dist v0.32.1-dist.26.
|
|
532
538
|
|
|
533
539
|
### Changed
|
|
534
540
|
- **An Event's `characters`** reads "Characters who know about the event: they were present, aware of it, or involved in it" (it read "Key characters relevant to the event"), in the generated doc comment and `SCHEMA.md`. No field, type or link changed.
|
|
@@ -536,22 +542,22 @@ Schema 00.32.01 (the Captain's word, h55 #8395): repinned to schema-dist v0.32.1
|
|
|
536
542
|
|
|
537
543
|
## [4.37.0] - 2026-10-20
|
|
538
544
|
|
|
539
|
-
The hidden mark
|
|
545
|
+
The hidden mark, live in production since 2026-10-20 09:24; walked on staging with the mark on, 25 of 25.
|
|
540
546
|
|
|
541
547
|
### Added
|
|
542
|
-
- A `/changes` delete row's `reason` (`OwDeleteReason`: `deleted` | `hidden` | `out_of_view`; keel
|
|
548
|
+
- A `/changes` delete row's `reason` (`OwDeleteReason`: `deleted` | `hidden` | `out_of_view`; keel's hidden
|
|
543
549
|
mark): an element hidden from this reader leaves its copy as a deleted one does, and a GET of it answers 404,
|
|
544
550
|
not 410. `isResyncRequired`'s comment names every case keel now sends it for, not only a guest's.
|
|
545
|
-
- `viewAs` on `get`, `list` and `listAll`, sent as `as` (
|
|
551
|
+
- `viewAs` on `get`, `list` and `listAll`, sent as `as` (view as): the owner's key reads as a
|
|
546
552
|
member (a membership id), as a Character's guest (a Character id) or as the public (`'public'`). A member key
|
|
547
553
|
gets 403 `view_as_owner_only` (`err.isViewAsOwnerOnly`); an element hidden from that reader is 404, never 410;
|
|
548
554
|
an unknown value is 422. Until keel's hidden mark is on, keel answers 422 (an unknown parameter).
|
|
549
555
|
- `err.resyncReason` (`'role'` | `'view'` | `undefined`) and `OwResyncReason`: why `/changes` answered 409
|
|
550
|
-
`resync_required`, from the envelope's `reason` (
|
|
556
|
+
`resync_required`, from the envelope's `reason` (only while keel's hidden mark is on).
|
|
551
557
|
`epoch_reason` beside `epoch` on `OwChangesPage` and on `changesHead()`'s answer: why the epoch last moved.
|
|
552
558
|
|
|
553
559
|
### Changed
|
|
554
|
-
- The resync instruction adds the hidden mark's reasons to 4.36.1's keep (
|
|
560
|
+
- The resync instruction adds the hidden mark's reasons to 4.36.1's keep (Titus, 2026-10-20): after a
|
|
555
561
|
409 `resync_required`, walk again from the start; reason `role` (the key's own role or membership moved):
|
|
556
562
|
keep what the local copy holds that the walk no longer names; reason `view`, or a delete row with reason
|
|
557
563
|
`hidden`: drop it; no reason (keel's hidden mark off): keep it, a reset never empties a copy. A tool never
|
|
@@ -562,37 +568,37 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
562
568
|
|
|
563
569
|
### Changed
|
|
564
570
|
|
|
565
|
-
- `pinExpectation`'s doc comment: a legacy key that can write sends its PIN on every read of a world that has one, whether or not the world is open to read (
|
|
571
|
+
- `pinExpectation`'s doc comment: a legacy key that can write sends its PIN on every read of a world that has one, whether or not the world is open to read (the demo split). The `'required-for-private-reads'` literal keeps its name until 5.0, since renaming a literal in a published union is a type break. A demo-range key is kind `legacy` too and never needs a PIN. No code change.
|
|
566
572
|
|
|
567
573
|
## [4.36.1] - 2026-10-20
|
|
568
574
|
|
|
569
575
|
### Changed
|
|
570
576
|
|
|
571
|
-
- The reset rule in `isResyncRequired`'s and `changes`' doc comments: on a 409 `resync_required`, walk from zero and keep what the local copy holds that the new walk does not name; a reset never empties a copy. It said replace. Keel says keep
|
|
577
|
+
- The reset rule in `isResyncRequired`'s and `changes`' doc comments: on a 409 `resync_required`, walk from zero and keep what the local copy holds that the new walk does not name; a reset never empties a copy. It said replace. Keel says keep (Titus's ruling, 2026-10-20: sharing is forward-only). No code change.
|
|
572
578
|
|
|
573
579
|
## [4.36.0] - 2026-10-20
|
|
574
580
|
|
|
575
581
|
### Changed
|
|
576
582
|
|
|
577
|
-
- **`fieldLabel`** keeps a word written all in capitals as written (`STR` reads "STR", `plan_B` "Plan B"), so a custom stat block reads the same in every tool (Temper,
|
|
583
|
+
- **`fieldLabel`** keeps a word written all in capitals as written (`STR` reads "STR", `plan_B` "Plan B"), so a custom stat block reads the same in every tool (Temper, 2026-10-20; Lantern and Atlas both call it). Schema field names are all lowercase, so no schema label changes.
|
|
578
584
|
|
|
579
585
|
## [4.35.0] - 2026-10-20
|
|
580
586
|
|
|
581
587
|
### Added
|
|
582
588
|
|
|
583
|
-
- **`createWorldLink(worldId, { preview })`** and `preview` on `OwWorldLink` (
|
|
589
|
+
- **`createWorldLink(worldId, { preview })`** and `preview` on `OwWorldLink` (live 2026-10-20): a person or player link with `preview: true` is `/join/<world_id>#<code>`, so a chat that unfurls it shows the world's name and picture; the code stays in the fragment. Absent means off, as keel rules for the API; `true` on an agent link is 422, param `preview`. The wire gate failed on production's document until this release.
|
|
584
590
|
|
|
585
591
|
## [4.34.0] - 2026-10-20
|
|
586
592
|
|
|
587
593
|
### Added
|
|
588
594
|
|
|
589
|
-
- **`fieldLabel(name)`** and **`FIELD_ACRONYMS`**: a field name as the words a tool shows, by the house rule (
|
|
595
|
+
- **`fieldLabel(name)`** and **`FIELD_ACRONYMS`**: a field name as the words a tool shows, by the house rule (Titus, 2026-10-20): sentence case, acronyms kept wherever they fall (`birth_date` → "Birth date", `image_url` → "Image URL"). Seeded from Atlas's `humanizeFieldName` as of 1.59.1, so Atlas, Lantern and Council read one copy. The name is taken as given: a tool that hides an extension prefix drops it first.
|
|
590
596
|
|
|
591
597
|
## [4.33.1] - 2026-10-19
|
|
592
598
|
|
|
593
599
|
### Fixed
|
|
594
600
|
- An `agent: true` client's file uploads now declare it: `createFileTicket` (and so `uploadFile`) sends
|
|
595
|
-
`X-OW-Agent`, the one files route keel's document lists it on
|
|
601
|
+
`X-OW-Agent`, the one files route keel's document lists it on, so the file reads
|
|
596
602
|
`added_by.agent: true`. The other files routes and the upload host get no such header.
|
|
597
603
|
|
|
598
604
|
## [4.33.0] - 2026-10-19
|
|
@@ -600,12 +606,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
600
606
|
### Added
|
|
601
607
|
- `FILE_EXTENSIONS` (every extension a file on an element may end in, to its kind: keel's list, `.yml` and
|
|
602
608
|
`.markdown` included) and `fileKindOf(name)` (the kind, or `undefined`), so a file picker's accept list reads
|
|
603
|
-
the SDK's instead of a copy (Atlas,
|
|
609
|
+
the SDK's instead of a copy (Atlas, 2026-10-19).
|
|
604
610
|
|
|
605
611
|
## [4.32.0] - 2026-10-19
|
|
606
612
|
|
|
607
613
|
### Added
|
|
608
|
-
- **Files on elements
|
|
614
|
+
- **Files on elements**, for Atlas's file list on an element:
|
|
609
615
|
- `listFiles(type, id)`: the element's files, newest first (`OwFileRow`: `id`, `name`, `kind`,
|
|
610
616
|
`size`, `label`, `added_by` with `name`, `membership` and `agent`, `added_at`), as keel sends them.
|
|
611
617
|
- `uploadFile(type, id, file, { name?, kind?, label?, ticket?, onProgress? })`: a ticket from the API,
|
|
@@ -632,7 +638,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
632
638
|
## [4.31.0] — 2026-10-18
|
|
633
639
|
|
|
634
640
|
### Added
|
|
635
|
-
- **Signing in with a password
|
|
641
|
+
- **Signing in with a password**: `signInWithPassword({ email | username, password, tokenName })`
|
|
636
642
|
turns an email address (or username) and password into a new account token (`ow_a_`) for this device,
|
|
637
643
|
named `tokenName`, the name the account's tokens page lists it under. It signs in at keel's sign-in service
|
|
638
644
|
(`{baseUrl}/auth/app/v1`), mints the token with that session at `POST /account/tokens`, then ends the
|
|
@@ -647,7 +653,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
647
653
|
account's worlds, revoked and read back as `key_revoked`).
|
|
648
654
|
|
|
649
655
|
### Changed
|
|
650
|
-
- `me()`'s doc names the player kind
|
|
656
|
+
- `me()`'s doc names the player kind.
|
|
651
657
|
|
|
652
658
|
## [4.30.1] — 2026-10-16
|
|
653
659
|
|
|
@@ -661,7 +667,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
661
667
|
## [4.30.0] — 2026-10-16
|
|
662
668
|
|
|
663
669
|
### Added
|
|
664
|
-
- **A friend with only a link
|
|
670
|
+
- **A friend with only a link**:
|
|
665
671
|
- `redeemJoin(code, { name?, agentName? })`: redeems a join code that needs no account, at `POST /join`,
|
|
666
672
|
sending no credential whatever key the client holds. The answer's `kind` tells the two apart:
|
|
667
673
|
`OwPlayerJoined` (a read key, `ow_r_`, no PIN, and the Character the player reads as) or
|
|
@@ -678,19 +684,19 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
678
684
|
## [4.29.0] — 2026-10-16
|
|
679
685
|
|
|
680
686
|
### Added
|
|
681
|
-
- `rekeySeat(worldId, seatId)
|
|
687
|
+
- `rekeySeat(worldId, seatId)`: a new key and secret for a seat whose AI lost
|
|
682
688
|
its own, by its sponsor or the world's owner. The old key and secret stop at once; the answer has
|
|
683
689
|
`createSeat`'s shape (`OwSeatCreated`: `key`, `pin`, `env`), shown once. No Idempotency-Key, by keel's
|
|
684
690
|
rule: if the answer is lost too, ask for another.
|
|
685
691
|
|
|
686
692
|
### Changed
|
|
687
693
|
- `createSeat`'s doc names `rekeySeat` as the way back from a lost answer.
|
|
688
|
-
- `OwApiError.param`'s doc: `API-Pin` on a 401 PIN refusal
|
|
694
|
+
- `OwApiError.param`'s doc: `API-Pin` on a 401 PIN refusal, not only a 422/400's field.
|
|
689
695
|
|
|
690
696
|
## [4.28.0] — 2026-10-16
|
|
691
697
|
|
|
692
698
|
### Added
|
|
693
|
-
- **Seats for your own AI
|
|
699
|
+
- **Seats for your own AI**, on an account token (`ow_a_`):
|
|
694
700
|
- `createSeat(worldId, { name, role?, character? })`: a seat for your own AI in a world you own or
|
|
695
701
|
belong to, with its own write key and `ow_s_` secret and no join link. You answer for it. `role` is at
|
|
696
702
|
most your own; `character` is `new` (default), `none`, or `mine` (it plays the Character you play).
|
|
@@ -709,7 +715,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
709
715
|
element's position in `items` (the ids the Python package mints), so the same key and items send the
|
|
710
716
|
same body from either client, and a resend after keel's 24-hour replay window rewrites the same
|
|
711
717
|
elements instead of creating new ones. Without a key, a fresh UUIDv7 each. Ids you pass are kept, and
|
|
712
|
-
your items are not changed. Found by Quillon's parity audit of the Unity SDK (
|
|
718
|
+
your items are not changed. Found by Quillon's parity audit of the Unity SDK (2026-10-16).
|
|
713
719
|
|
|
714
720
|
## [4.27.1] — 2026-10-16
|
|
715
721
|
|
|
@@ -720,12 +726,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
720
726
|
Python package mints), so the retry sends the same body and gets the first answer back. Without a key,
|
|
721
727
|
a fresh UUIDv7 as before; an id you pass is kept.
|
|
722
728
|
- `create`'s doc said a keyed retry "rewrites the same element"; keel's replay writes nothing. Found by
|
|
723
|
-
Quillon's parity audit of the Unity SDK (
|
|
729
|
+
Quillon's parity audit of the Unity SDK (2026-10-16).
|
|
724
730
|
|
|
725
731
|
## [4.27.0] — 2026-10-16
|
|
726
732
|
|
|
727
733
|
### Added
|
|
728
|
-
- `OwApiError.isIdempotencyInFlight
|
|
734
|
+
- `OwApiError.isIdempotencyInFlight`: a request with the same Idempotency-Key is still
|
|
729
735
|
running (409 `idempotency_in_flight`, `retryAfter` 1). Nothing was written by this one; send again with
|
|
730
736
|
the same key and body after `retryAfter` and it replays the first answer. `isIdempotencyConflict` stays
|
|
731
737
|
the different-body case only. The client still does not retry for you.
|
|
@@ -733,7 +739,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
733
739
|
## [4.26.0] — 2026-10-15
|
|
734
740
|
|
|
735
741
|
### Added
|
|
736
|
-
- **The door of every write
|
|
742
|
+
- **The door of every write**. An opt-in
|
|
737
743
|
`agent: true` on `OwClientConfig` sends `X-OW-Agent` on every element write (create, upsert,
|
|
738
744
|
patch, delete, editLinks, bulk: the operations keel's document declares it on; never on reads,
|
|
739
745
|
account routes or the image edge); keel records such writes as `declared`, agent-made, and stores only that the header was
|
|
@@ -750,10 +756,10 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
750
756
|
- **`OwWorldMeta` types every field keel's `World` declares** (it named four): the description and
|
|
751
757
|
picture, the calendar (`time_format_names`, `time_format_equivalents`, `time_basic_unit`, the three
|
|
752
758
|
`time_range_*`), the three unit labels, `public_read`, `owner_character`, `created_at`, and new
|
|
753
|
-
**`agent_narrator_rule`** (
|
|
759
|
+
**`agent_narrator_rule`** (whether a Narrative written through an agent seat is
|
|
754
760
|
narrated by that seat's own Character; read-only, set on the world page). Past `id` and `name`
|
|
755
761
|
they stay optional so code that builds a world meta keeps compiling; keel always sends all of them.
|
|
756
|
-
`updated_at` and `created_at` read `string | null`, as the document says.
|
|
762
|
+
`updated_at` and `created_at` read `string | null`, as the document says. The wire gate now
|
|
757
763
|
holds this type to `World` (it had held only the PATCH body). Council and Lantern type-check on it.
|
|
758
764
|
|
|
759
765
|
## [4.24.0] — 2026-10-15
|
|
@@ -765,11 +771,11 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
765
771
|
keel keeps a hash); `listWorldLinks(worldId)` the links without codes, each with its `status`
|
|
766
772
|
and `uses`; `revokeWorldLink(worldId, linkId)`. Types `OwWorldLink`, `OwCreatedWorldLink`. A
|
|
767
773
|
non-owner, and a world that doesn't exist, get 404; a world key is a TypeError before sending.
|
|
768
|
-
For Lantern's Invite someone (Temper,
|
|
774
|
+
For Lantern's Invite someone (Temper, 2026-10-15).
|
|
769
775
|
|
|
770
776
|
### Changed
|
|
771
|
-
- `acceptJoin`'s doc comment and the README: accepting needs no account PIN for any role
|
|
772
|
-
|
|
777
|
+
- `acceptJoin`'s doc comment and the README: accepting needs no account PIN for any role,
|
|
778
|
+
so its refusals are 404 and 409 `already_member`; `pin_required` now belongs to
|
|
773
779
|
minting a write key for the membership. `isPinRequired` stays.
|
|
774
780
|
- Doc comments say "token rating" for the account's daily budget (`ask`, `sort`, `allowance`,
|
|
775
781
|
`OwAllowance`, the answers' `token_rating`), as the README did in 4.23.0; the docs site's
|
|
@@ -781,14 +787,14 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
781
787
|
- **`TokenResource.consume()`, `getAccessKey()`, `revokeSession()`, `revokeAllSessions()`**: keel
|
|
782
788
|
serves none of these routes (each answers 404 `not_found` on production; `accounts/token_api.py`
|
|
783
789
|
mounts only `status/` and `encryption-info/`). Spending is server-side, in the route that does the
|
|
784
|
-
work (the Council's acts through keel's council proxy,
|
|
790
|
+
work (the Council's acts through keel's council proxy, Skeld's ruling, 2026-10-14), and
|
|
785
791
|
`OwV2Client.allowance()` reads the token rating. They stay callable and leave in 5.0. A 404 from
|
|
786
|
-
any token route now says what keel serves instead of "an older server". Found by
|
|
792
|
+
any token route now says what keel serves instead of "an older server". Found by the wire
|
|
787
793
|
gate, which until now never drove this class (its routes are not in keel's document).
|
|
788
794
|
|
|
789
795
|
### Changed
|
|
790
|
-
- README and docs: "token rating" is the one word for the account's daily budget (
|
|
791
|
-
|
|
796
|
+
- README and docs: "token rating" is the one word for the account's daily budget (Titus,
|
|
797
|
+
2026-10-14). Names in the API (`allowance()`, `/account/allowance`) are unchanged.
|
|
792
798
|
|
|
793
799
|
## [4.22.0] — 2026-10-14
|
|
794
800
|
|
|
@@ -796,23 +802,23 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
796
802
|
- **`client.me()` and `client.members()`**: GET /me (who this world key is: world, scope, kind,
|
|
797
803
|
role, membership id, Character) and GET /members (the roster's rows, unwrapped from `{ data }`).
|
|
798
804
|
Lantern reads a player's role from /me by hand today. Types `OwMe`, `OwMember`, typed from
|
|
799
|
-
keel's declared schemas and held to them by
|
|
805
|
+
keel's declared schemas and held to them by the wire gate. An account token is a
|
|
800
806
|
TypeError before sending; the tests fail with that guard removed, or with the rows left
|
|
801
807
|
wrapped.
|
|
802
808
|
|
|
803
809
|
### Changed
|
|
804
810
|
- The calendar kernel is the SDK's own: Atlas 245aad3 deleted its `core/calendar.ts` and imports
|
|
805
|
-
this one (Temper,
|
|
811
|
+
this one (Temper, 2026-10-14), so the copy record (`src/calendar/SOURCES.json`) and the re-copy
|
|
806
812
|
script (`codegen/atlas-calendar.mjs`) are gone. A kernel change is an SDK release now. No code
|
|
807
813
|
change.
|
|
808
814
|
|
|
809
815
|
## [4.21.0] — 2026-10-14
|
|
810
816
|
|
|
811
817
|
### Added
|
|
812
|
-
- **`client.allowance()`**: GET /account/allowance (keel 872431f, Skeld
|
|
818
|
+
- **`client.allowance()`**: GET /account/allowance (keel 872431f, Skeld, 2026-10-14), the
|
|
813
819
|
account's daily AI allowance read without spending: `token_rating`, `tokens_used_today`,
|
|
814
820
|
`tokens_remaining`, `resets_at` (the next midnight UTC). Account token only, like ask and
|
|
815
|
-
sort. Type `OwAllowance`, held by
|
|
821
|
+
sort. Type `OwAllowance`, held by the wire gate to the route's declared schema, as
|
|
816
822
|
`OwAskAnswer`, `OwSortAnswer` and `OwJoinPreview` now are to theirs.
|
|
817
823
|
|
|
818
824
|
### Fixed
|
|
@@ -823,13 +829,13 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
823
829
|
|
|
824
830
|
### Added
|
|
825
831
|
- **World calendars**, Atlas's calendar code in the SDK so Lantern can name dates (Temper,
|
|
826
|
-
|
|
832
|
+
2026-10-14): `formatStep`, `formatYearLabel`, `breakdownStep`, `parseDate` and the rest of
|
|
827
833
|
Atlas's `src/core/calendar.ts` (Atlas 02d6a6d), plus `worldCalendars`,
|
|
828
834
|
`resolveCalendarLens` and `readCalendarValue` from its `calendar-lens.ts`, on any element
|
|
829
835
|
shape. `CALENDAR_FIELD` is `atlas_calendar`: Atlas owns the field, its meaning and its
|
|
830
|
-
writes, and other tools read it (Skeld,
|
|
836
|
+
writes, and other tools read it (Skeld, 2026-10-14).
|
|
831
837
|
- `src/calendar/calendar.ts` is Atlas's file byte for byte, recorded in
|
|
832
|
-
`src/calendar/SOURCES.json
|
|
838
|
+
`src/calendar/SOURCES.json`; `codegen/atlas-calendar.mjs` re-copies it
|
|
833
839
|
and ports Atlas's 48 kernel tests (TypeScript's transpiler, a five-matcher `test/expect.mjs`
|
|
834
840
|
over node:test). Watched failing: a planted `floorMod` edit failed two tests and the record
|
|
835
841
|
(EDITED); a lens edit failed its test. An app that imports none of it bundles none of it.
|
|
@@ -838,7 +844,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
838
844
|
|
|
839
845
|
### Added
|
|
840
846
|
- **`tokens_remaining` and `token_rating` on `OwAskAnswer` and `OwSortAnswer`**: since keel
|
|
841
|
-
a6244db (Skeld,
|
|
847
|
+
a6244db (Skeld, 2026-10-14) ask and sort spend from the account's daily token rating, one
|
|
842
848
|
meter with the Council. `remaining` stays a count of answers: how many more calls of this
|
|
843
849
|
size fit in what is left today (keel 504437b), never tokens. Typed from keel's code
|
|
844
850
|
(`accounts/ask.py`), since its OpenAPI document gives these answers no schema.
|
|
@@ -849,10 +855,10 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
849
855
|
each one by its own name: `x_eye_colour` reads `eye colour: grey`; an id in one is a link,
|
|
850
856
|
by name; a long value is cut like a description. `atlas_*` machinery stays out, and so do
|
|
851
857
|
object values (a tool's state). Lantern shows and edits custom fields now, so Ask can answer
|
|
852
|
-
what find already could (Temper,
|
|
858
|
+
what find already could (Temper, 2026-10-13). The trial's lookup
|
|
853
859
|
still skips them; parity holds on its ten questions, whose fixture has no custom text.
|
|
854
860
|
- The lookup's stopword set is an array literal, so bundlers mark it pure and drop it from
|
|
855
|
-
apps that never call the lookup (451 bytes; Temper,
|
|
861
|
+
apps that never call the lookup (451 bytes; Temper, 2026-10-14).
|
|
856
862
|
|
|
857
863
|
## [4.18.1] — 2026-10-12
|
|
858
864
|
|
|
@@ -866,13 +872,13 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
866
872
|
|
|
867
873
|
### Added
|
|
868
874
|
- **`client.sort({ worldId, notes, slice })`**: POST /account/sort, ask's sibling (Temper for
|
|
869
|
-
Lantern,
|
|
875
|
+
Lantern, 2026-10-12; Skeld's route). Notes as words or
|
|
870
876
|
`{ text, image_url }`; the slice is the app's own lookup. Rows of four kinds come back to
|
|
871
877
|
review (`make`, `add_to`, `link`, `ask` with an optional `then`) and `not_proposed` with
|
|
872
878
|
reasons; nothing is written. One allowance with `ask`, and the same refusals. Types
|
|
873
879
|
`OwSortRef`, `OwSortNote`, `OwSortRow` and its four kinds, `OwSortAnswer`. Built against
|
|
874
|
-
keel PR #4 (90961fa, Skeld's final for the types
|
|
875
|
-
main and in production
|
|
880
|
+
keel PR #4 (90961fa, Skeld's final for the types), released once it was on keel
|
|
881
|
+
main and in production: verify-sdk-wire PASS 1,111 against production's document.
|
|
876
882
|
|
|
877
883
|
## [4.17.0] — 2026-10-12
|
|
878
884
|
|
|
@@ -881,7 +887,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
881
887
|
says which view epoch it ran under (a guest's integer; `null` for other keys or a keel
|
|
882
888
|
without the field) and the first poll after it needs no extra walk to learn it. Live on
|
|
883
889
|
Moppetopia: a full walk of 465 changes returns `{ cursor, head: 818, epoch: null }`. The first
|
|
884
|
-
tests of `changesAll`'s return value (Temper,
|
|
890
|
+
tests of `changesAll`'s return value (Temper, 2026-10-12).
|
|
885
891
|
|
|
886
892
|
## [4.16.0] — 2026-10-12
|
|
887
893
|
|
|
@@ -892,7 +898,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
892
898
|
`epoch` moved; nothing needs to read inside the cursor. `changesHead()` answers
|
|
893
899
|
`epoch: null` from a keel without the field. Checked live on Moppetopia (the head read and a
|
|
894
900
|
page both carry `epoch: null`). The wire gate now holds `OwChangesPage` and `OwBulkResponse`
|
|
895
|
-
to keel's `ChangesPage` and `BulkResult
|
|
901
|
+
to keel's `ChangesPage` and `BulkResult`, and failed on 4.15.0 for the missing
|
|
896
902
|
`epoch` before this release.
|
|
897
903
|
Published from tag `v4.16.0`; the workflow's read-back gave up before npm showed the
|
|
898
904
|
version, so the tarball (shasum `d08de22b`) was read back by hand against a build of the tag.
|
|
@@ -923,7 +929,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
923
929
|
## [4.13.0] — 2026-10-12
|
|
924
930
|
|
|
925
931
|
### Added
|
|
926
|
-
- **Ask your world
|
|
932
|
+
- **Ask your world.** `client.ask({ worldId, question, context })` sends a
|
|
927
933
|
question to keel's AI proxy with the account's `ow_a_` token (a world key is a `TypeError`
|
|
928
934
|
before sending) and returns `OwAskAnswer` (`answer`, `model`, `stop_reason`, `usage`,
|
|
929
935
|
`remaining`). The answer comes from `context` only, or is "The world doesn't say.".
|
|
@@ -935,12 +941,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
935
941
|
New getters: `isQuotaExceeded` (429; `retryAfter` runs to midnight UTC), `isAskUnavailable`
|
|
936
942
|
(503), `isAskFailed` (502). keel's document gives no request schema for `/account/ask`, so
|
|
937
943
|
the body (`world_id`, `question`, `context`) is read from keel's code (`accounts/ask.py`).
|
|
938
|
-
Not yet run live: no
|
|
944
|
+
Not yet run live: no account token was at hand to run it with.
|
|
939
945
|
|
|
940
946
|
## [4.12.0] — 2026-10-12
|
|
941
947
|
|
|
942
948
|
### Added
|
|
943
|
-
- **Joining a world by link
|
|
949
|
+
- **Joining a world by link.** `previewJoin(code)` reads what a join code holds
|
|
944
950
|
without using it (`OwJoinPreview`: `reader`, `world`, `invited_by`, `owner_character`,
|
|
945
951
|
`role`, `with_character`, `expires_at`) and sends no credential, whatever key the client
|
|
946
952
|
holds. `acceptJoin(code)` accepts an invite link as the account behind the client's `ow_a_`
|
|
@@ -961,7 +967,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
961
967
|
forms first, then name words, supertype and subtype, one link step in both directions, then
|
|
962
968
|
other text and numbers (always below any name hit). Each hit says why it matched.
|
|
963
969
|
`renderElement` gives a compact text card with links by name, which is what a model reads
|
|
964
|
-
when one phrases the answer. Measured on two real worlds (
|
|
970
|
+
when one phrases the answer. Measured on two real worlds (a Lantern Ask trial):
|
|
965
971
|
the answer was in the first three results for 60 of 60 questions that name their subject
|
|
966
972
|
and 17 of 24 held-out questions that only describe it; this code returns the same top 8
|
|
967
973
|
as the trial's on all 100 questions. Names in any script are matched (Chinese and Japanese
|
|
@@ -1002,7 +1008,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
1002
1008
|
## [4.9.0] — 2026-10-11
|
|
1003
1009
|
|
|
1004
1010
|
### Added
|
|
1005
|
-
- **Only if unchanged
|
|
1011
|
+
- **Only if unchanged.** `patch(type, id, partial, { ifMatch })` and
|
|
1006
1012
|
`editLinks(type, id, field, edit, { ifMatch })` send `If-Match: "<change_seq>"`: the write
|
|
1007
1013
|
lands only if the element is still at that `change_seq`. When it has moved, nothing is
|
|
1008
1014
|
written and the call throws **`OwPreconditionFailedError`** (412 `precondition_failed`), an
|
package/README.md
CHANGED
|
@@ -5,8 +5,6 @@
|
|
|
5
5
|
|
|
6
6
|
OnlyWorlds is an open standard for worldbuilding data: 22 element types (characters, locations, events, laws and the rest) that any tool can read and write. This is a typed client for its API, with the schema's constants (element types, icons, colour families, field metadata) generated from the published [schema distribution](https://github.com/OnlyWorlds/schema-dist). It runs in Node 18+ and in the browser through a bundler (ESM only).
|
|
7
7
|
|
|
8
|
-
**Who writes this repository.** The SDK is maintained by Kael, one of a crew of AI minds working with the OnlyWorlds founder, who answers for it. Kael reads and answers its issues and pull requests; until the crew posts from an identity of its own, those replies post from the founder's account, so a reply from `tmoosting` may be Kael's. `CHANGELOG.md` is the crew's record as it was written: its crew names, room references and keel items (keel #519, the API server's own tracker) point at records outside this repository.
|
|
9
|
-
|
|
10
8
|
## Install
|
|
11
9
|
|
|
12
10
|
```bash
|
|
@@ -422,3 +420,5 @@ Use this SDK for known operations in your own code (CRUD, sync, bulk). To let an
|
|
|
422
420
|
## Licence and contributions
|
|
423
421
|
|
|
424
422
|
The code is MIT (`LICENSE`). Issues are welcome: a bug, a wrong word, a thing you could not do. Pull requests are read; a small fix is usually taken as is, and a change to what the package does is better opened as an issue first, since it may already be built or ruled out. A reply can take a few days. A vulnerability goes privately, never in an issue: `SECURITY.md`. What we ask at the door, and what you can expect: [the code of conduct](https://github.com/OnlyWorlds/OnlyWorlds/blob/main/CODE_OF_CONDUCT.md).
|
|
423
|
+
|
|
424
|
+
Maintained by Kael, an AI agent working for Titus. Issues and pull requests are read and answered here.
|
package/SCHEMA.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OnlyWorlds Schema Reference
|
|
2
2
|
|
|
3
|
-
**Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.33.0-dist.
|
|
3
|
+
**Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.33.0-dist.74** — canonical schema **00.33.00**, published 2026-10-26.
|
|
4
4
|
|
|
5
5
|
GENERATED from the canonical schema YAML — do not hand-edit (regenerate: `python codegen/generate_types.py`).
|
|
6
6
|
Written for both humans and AI agents reading this package locally.
|
package/dist/index.d.ts
CHANGED
|
@@ -29,7 +29,7 @@ interface OwElementBase {
|
|
|
29
29
|
created_by?: string | null;
|
|
30
30
|
/** The membership whose write last changed this element (server-managed, read-only); null for the world's owner and for anything last changed before writes recorded it. */
|
|
31
31
|
changed_by?: string | null;
|
|
32
|
-
/** The door of the last write (server-managed, read-only): `seat` (an agent seat), `mcp`, `declared` (a client that sent X-OW-Agent), then `api`, `v1`, `sync`, `server` (keel's own writes) or `site` (the owner signed in on onlyworlds.com
|
|
32
|
+
/** The door of the last write (server-managed, read-only): `seat` (an agent seat), `mcp`, `declared` (a client that sent X-OW-Agent), then `api`, `v1`, `sync`, `server` (keel's own writes) or `site` (the owner signed in on onlyworlds.com). The first three are agent-made. Null for anything last changed before writes recorded it. */
|
|
33
33
|
changed_via?: 'seat' | 'mcp' | 'declared' | 'api' | 'v1' | 'sync' | 'server' | 'site' | null;
|
|
34
34
|
/** The name the client gave in the X-OW-Client header on the last write (server-managed, read-only): lower case letters, digits and hyphens, 1 to 32 characters, such as `sdk` or `atlas`. It is the client's claim about itself, never proof, and says nothing about whether an agent drove the write (that is `changed_via`). Null when the last write sent no name or one outside the rule, for keel's own writes, and for anything last changed before names were recorded. Sent in a write it is ignored. This SDK sends its `client` option, `sdk` by default. */
|
|
35
35
|
changed_client?: string | null;
|
|
@@ -57,7 +57,7 @@ declare const ELEMENT_ICONS: Record<ElementType, string>;
|
|
|
57
57
|
/** The fields onlyworlds.com shows on a known-of element (`known_of: true`, see isKnownOf)
|
|
58
58
|
* besides the base fields, with their values; every other field of a stub reads unset.
|
|
59
59
|
* Platform behaviour, not a default to override. Source: the distribution's
|
|
60
|
-
* `presentation.json` sidecar, `types.<type>.public
|
|
60
|
+
* `presentation.json` sidecar, `types.<type>.public`. */
|
|
61
61
|
declare const PUBLIC_FIELDS: {
|
|
62
62
|
readonly ability: readonly [];
|
|
63
63
|
readonly character: readonly ["physicality", "height", "weight", "species", "reputation"];
|
|
@@ -2662,7 +2662,7 @@ interface OwWorldLink {
|
|
|
2662
2662
|
uses: number;
|
|
2663
2663
|
/** A table is `pending` while `uses < max_uses` (and neither revoked nor expired), `used` once full. */
|
|
2664
2664
|
status: 'pending' | 'used' | 'revoked' | 'expired';
|
|
2665
|
-
/** The membership (its id in GET /api/v2/members) of the co-builder who minted the link over POST /api/v2/links; null for a link the owner made
|
|
2665
|
+
/** The membership (its id in GET /api/v2/members) of the co-builder who minted the link over POST /api/v2/links; null for a link the owner made. */
|
|
2666
2666
|
minted_by: string | null;
|
|
2667
2667
|
/** Whether the link shows the world's name and picture when it is pasted into a chat: then the link is `/join/<world_id>#<code>`, else `/join#<code>`. Never on an agent link. */
|
|
2668
2668
|
preview?: boolean;
|
|
@@ -2761,7 +2761,7 @@ interface OwSignedIn {
|
|
|
2761
2761
|
* (`'collaborator'`, with `member_role` the membership's role). Keys by name and last four only,
|
|
2762
2762
|
* never the key; on a shared world only the member's own keys.
|
|
2763
2763
|
*/
|
|
2764
|
-
/** The draught's policy
|
|
2764
|
+
/** The draught's policy: what GET /character/{id}/context serves and how. */
|
|
2765
2765
|
interface OwDraughtPolicy {
|
|
2766
2766
|
/** Sections to serve; default every one but `messages`, `room` and `proposed`, each served only when named. */
|
|
2767
2767
|
components?: OwDraughtComponent[];
|
|
@@ -2808,7 +2808,7 @@ interface OwDraughtItem {
|
|
|
2808
2808
|
/** The element's body exactly as the list route serves it to the same reader. */
|
|
2809
2809
|
element: OwElement;
|
|
2810
2810
|
}
|
|
2811
|
-
/** One Character's context in one read, GET /character/{id}/context (
|
|
2811
|
+
/** One Character's context in one read, GET /character/{id}/context (the draught). */
|
|
2812
2812
|
/** The draught under `compact`: every section may be absent, and so may `cut` (nothing was cut). */
|
|
2813
2813
|
type OwDraughtCompact = Omit<OwDraught, 'cut'> & {
|
|
2814
2814
|
cut?: Record<string, number>;
|
|
@@ -3122,9 +3122,9 @@ interface OwFileDownload {
|
|
|
3122
3122
|
interface ListParams {
|
|
3123
3123
|
limit?: number;
|
|
3124
3124
|
cursor?: string;
|
|
3125
|
-
/** Only these ids (1 to 200), in the list's own order; one this key cannot see is simply absent
|
|
3125
|
+
/** Only these ids (1 to 200), in the list's own order; one this key cannot see is simply absent. */
|
|
3126
3126
|
ids?: string[];
|
|
3127
|
-
/** A membership id, or `'owner'` for the owner's own writes: only what that member created
|
|
3127
|
+
/** A membership id, or `'owner'` for the owner's own writes: only what that member created. */
|
|
3128
3128
|
createdBy?: string;
|
|
3129
3129
|
/** One-level stub expansion, e.g. ['friends', 'location']. */
|
|
3130
3130
|
expand?: string[];
|
|
@@ -3308,8 +3308,8 @@ declare class OwApiError extends Error {
|
|
|
3308
3308
|
*/
|
|
3309
3309
|
get isViewAsOwnerOnly(): boolean;
|
|
3310
3310
|
/**
|
|
3311
|
-
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of
|
|
3312
|
-
*
|
|
3311
|
+
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of),
|
|
3312
|
+
* true or false: the key marks a stub and is never written. Drop it and send only
|
|
3313
3313
|
* the fields you mean. This client never sends it (`known_of` is stripped, a stub is a
|
|
3314
3314
|
* TypeError before sending), so it reaches you only through `request()`. `/bulk` never
|
|
3315
3315
|
* throws for it: the item's slot carries the code, and its siblings apply.
|
|
@@ -3546,7 +3546,7 @@ declare function pinExpectation(kind: OwKeyKind): 'never' | 'optional' | 'requir
|
|
|
3546
3546
|
|
|
3547
3547
|
/**
|
|
3548
3548
|
* Sign in with OnlyWorlds: OAuth 2.1's authorization code with PKCE (S256) for public clients
|
|
3549
|
-
* (
|
|
3549
|
+
* (live 2026-10-22).
|
|
3550
3550
|
*
|
|
3551
3551
|
* Two calls. `beginSignIn` mints `state` and a PKCE verifier, keeps them under the client id in a
|
|
3552
3552
|
* storage the page shares with its callback (sessionStorage by default), and hands back the
|
|
@@ -3677,7 +3677,7 @@ declare class OwV2Client {
|
|
|
3677
3677
|
/** GET /{type}/ -- one cursor page. */
|
|
3678
3678
|
list(type: ElementType | string, params?: ListParams): Promise<OwPage>;
|
|
3679
3679
|
/**
|
|
3680
|
-
* GET /character/{id}/context -- the draught
|
|
3680
|
+
* GET /character/{id}/context -- the draught: what one Character knows, as the
|
|
3681
3681
|
* recorded world holds it, in one read: her element, what she holds and sits in, her open work,
|
|
3682
3682
|
* how she works, the Events she was in, the Narratives she knows, everything else that names
|
|
3683
3683
|
* her, her sheet, what changed around her (`since`), and who plays whom; the world's name and
|
|
@@ -3812,7 +3812,7 @@ declare class OwV2Client {
|
|
|
3812
3812
|
* the cursor and walk from zero. For what the local copy holds that the walk no longer names,
|
|
3813
3813
|
* read err.resyncReason (while keel's hidden mark is on): `role`, keep it; `view`,
|
|
3814
3814
|
* drop it (as for a delete row with reason `hidden`). Without a reason, keep it (keel's own
|
|
3815
|
-
* words
|
|
3815
|
+
* words; sharing is forward-only). Never empty a copy on your own.
|
|
3816
3816
|
* Citizenship: heaviest route on the platform; default page size is polite.
|
|
3817
3817
|
* keel sends the cursor of a page at the head as a number (an empty page, for a key
|
|
3818
3818
|
* whose cursor carries no epoch); it is handed back as a string, like every cursor here.
|
package/dist/index.js
CHANGED
|
@@ -174,8 +174,8 @@ var OwApiError = class extends Error {
|
|
|
174
174
|
return this.status === 403 && this.code === "view_as_owner_only";
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of
|
|
178
|
-
*
|
|
177
|
+
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of),
|
|
178
|
+
* true or false: the key marks a stub and is never written. Drop it and send only
|
|
179
179
|
* the fields you mean. This client never sends it (`known_of` is stripped, a stub is a
|
|
180
180
|
* TypeError before sending), so it reaches you only through `request()`. `/bulk` never
|
|
181
181
|
* throws for it: the item's slot carries the code, and its siblings apply.
|
|
@@ -889,7 +889,7 @@ var OwV2Client = class {
|
|
|
889
889
|
* the cursor and walk from zero. For what the local copy holds that the walk no longer names,
|
|
890
890
|
* read err.resyncReason (while keel's hidden mark is on): `role`, keep it; `view`,
|
|
891
891
|
* drop it (as for a delete row with reason `hidden`). Without a reason, keep it (keel's own
|
|
892
|
-
* words
|
|
892
|
+
* words; sharing is forward-only). Never empty a copy on your own.
|
|
893
893
|
* Citizenship: heaviest route on the platform; default page size is polite.
|
|
894
894
|
* keel sends the cursor of a page at the head as a number (an empty page, for a key
|
|
895
895
|
* whose cursor carries no epoch); it is handed back as a string, like every cursor here.
|
|
@@ -1748,7 +1748,7 @@ var OwV2Client = class {
|
|
|
1748
1748
|
if (opts.keepalive !== void 0) send.keepalive = opts.keepalive;
|
|
1749
1749
|
await this.request("DELETE", `/account/worlds/${encodeURIComponent(worldId)}/keys/${encodeURIComponent(keyId)}`, send);
|
|
1750
1750
|
}
|
|
1751
|
-
// -- Sign in with OnlyWorlds (OAuth 2.1 code + PKCE
|
|
1751
|
+
// -- Sign in with OnlyWorlds (OAuth 2.1 code + PKCE) ----------------------
|
|
1752
1752
|
/**
|
|
1753
1753
|
* Start Sign in with OnlyWorlds from a tool's page: mint `state` and a PKCE verifier, keep them
|
|
1754
1754
|
* under `clientId` in `storage` (sessionStorage by default; in Node pass one), and send the
|