@onlyworlds/sdk 4.81.0 → 4.82.0
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 +4 -3
- package/CHANGELOG.md +118 -104
- package/README.md +2 -2
- package/SCHEMA.md +1 -1
- package/dist/index.d.ts +30 -13
- 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
|
|
|
@@ -71,8 +71,9 @@ against live data). The v1 surface (`OnlyWorldsClient`, the `ElementType` enum)
|
|
|
71
71
|
- Who am I (since 4.22.0, a world key): `client.me()` is `{ world, scope, kind, role,
|
|
72
72
|
membership, character, front_door }` (`membership` is what `created_by` holds for what you
|
|
73
73
|
create; null for the owner); `front_door` (since 4.60.0) names who answers for your
|
|
74
|
-
seat (`sponsor`, `sponsor_character`), your Character,
|
|
75
|
-
|
|
74
|
+
seat (`sponsor`, `sponsor_character`), your Character, the AI and player seats you answer
|
|
75
|
+
for (`my_seats`, since 4.82.0: `{ id, kind, name, character }`, agent seats first), and the
|
|
76
|
+
world's Charter with up to five skill Objects: an agent reads `charter` first. `client.members()` is the roster's rows. An
|
|
76
77
|
account token is a TypeError.
|
|
77
78
|
- Signing in (no key needed): `new OwV2Client().signInWithPassword({ email, password,
|
|
78
79
|
tokenName })` (or `username`) mints an `ow_a_` account token named for the device and ends
|
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,20 @@ earlier history lives in git log only.
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased]
|
|
7
7
|
|
|
8
|
+
## [4.82.0] - 2026-10-26
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- **`front_door.my_seats`, and `OwMySeat`** (keel's front door, live 2026-10-26). `me()`, `setMyCharacter()` and an agent's `redeemJoin()` answer now list the live AI and player seats the key's holder answers for, agent seats first: each row is `{ id, kind, name, character }`, with `id` the seat's membership id as `members()` lists it, `kind` `'agent'` or `'player'`, `name` null when the seat has none, and `character` the Character it plays (null when it plays none the key can read). The list is empty for an AI or a player seat's own key and for anyone who answers for none; a seat made from a link for an email address is never listed. Types only: the client already passed the body through. Required on `OwFrontDoor`, as keel's document declares it; a hand-built `OwMe` or `OwAgentJoined` in a consumer's test needs the field.
|
|
13
|
+
- Tests: `me()` reads a front door with seats and one with an empty list through unchanged; the published `OwFrontDoor` declares its six keys in the document's order and `OwMySeat` its four.
|
|
14
|
+
- Test: `readMarkOf` takes the newest read mark wherever it stands in the list. The message profile's fixture lists the newer mark first, so a reader that kept the first mark that counts passed every case; the new test lists it last (and replays the fixture's case reversed), and fails on that reader. No reader changed.
|
|
15
|
+
|
|
16
|
+
## [4.81.1] - 2026-10-26
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- **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.
|
|
21
|
+
|
|
8
22
|
## [4.81.0] - 2026-10-26
|
|
9
23
|
|
|
10
24
|
### Added
|
|
@@ -83,7 +97,7 @@ earlier history lives in git log only.
|
|
|
83
97
|
|
|
84
98
|
### Added
|
|
85
99
|
|
|
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
|
|
100
|
+
- **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
101
|
|
|
88
102
|
## [4.73.0] - 2026-10-25
|
|
89
103
|
|
|
@@ -107,7 +121,7 @@ earlier history lives in git log only.
|
|
|
107
121
|
|
|
108
122
|
### Fixed
|
|
109
123
|
|
|
110
|
-
- **`OwElementBase.hidden`'s doc comment says what a create does with it.** It said a write ignores the mark. Since
|
|
124
|
+
- **`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
125
|
- 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
126
|
|
|
113
127
|
## [4.72.1] - 2026-10-24
|
|
@@ -131,14 +145,14 @@ earlier history lives in git log only.
|
|
|
131
145
|
|
|
132
146
|
- **`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
147
|
- **`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
|
|
148
|
+
- **`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
149
|
- 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
150
|
|
|
137
151
|
## [4.71.0] - 2026-10-24
|
|
138
152
|
|
|
139
153
|
### Added
|
|
140
154
|
|
|
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
|
|
155
|
+
- **`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
156
|
|
|
143
157
|
### Fixed
|
|
144
158
|
|
|
@@ -153,47 +167,47 @@ earlier history lives in git log only.
|
|
|
153
167
|
|
|
154
168
|
### Added
|
|
155
169
|
|
|
156
|
-
- **`writeWorldFile(files, topDir, { includeHidden: false })`** (folder spec §4.8, Skeld,
|
|
170
|
+
- **`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
171
|
- **`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
172
|
|
|
159
173
|
### Fixed
|
|
160
174
|
|
|
161
|
-
- **`draught`'s doc comment names `compact`** (4.69.0
|
|
175
|
+
- **`draught`'s doc comment names `compact`** (4.69.0), so the docs' generated reference row carries it.
|
|
162
176
|
- 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
177
|
|
|
164
178
|
## [4.69.0] - 2026-10-23
|
|
165
179
|
|
|
166
180
|
### Added
|
|
167
181
|
|
|
168
|
-
- **`draught(id, { compact: true })
|
|
182
|
+
- **`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
183
|
|
|
170
184
|
## [4.68.0] - 2026-10-23
|
|
171
185
|
|
|
172
186
|
### Fixed
|
|
173
187
|
|
|
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,
|
|
188
|
+
- **`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.
|
|
189
|
+
- **`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
190
|
|
|
177
191
|
## [4.67.0] - 2026-10-23
|
|
178
192
|
|
|
179
193
|
### Added
|
|
180
194
|
|
|
181
|
-
- **The draught's `room` and `proposed` components**: `OwDraughtComponent` is now keel's thirteen, in its order. `room`
|
|
195
|
+
- **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
196
|
|
|
183
197
|
### Fixed
|
|
184
198
|
|
|
185
|
-
- **`OwDraughtItem` nests the element**: keel has served each draught row as `{ via, circles?, her_links, grade, dated?, element }` since the route shipped
|
|
199
|
+
- **`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
200
|
- 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
201
|
|
|
188
202
|
## [4.66.0] - 2026-10-23
|
|
189
203
|
|
|
190
204
|
### Added
|
|
191
205
|
|
|
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** (
|
|
206
|
+
- **`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.
|
|
207
|
+
- **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
208
|
- **`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
209
|
- **`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
|
|
210
|
+
- **`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
211
|
|
|
198
212
|
### Changed
|
|
199
213
|
|
|
@@ -204,7 +218,7 @@ earlier history lives in git log only.
|
|
|
204
218
|
|
|
205
219
|
### Fixed
|
|
206
220
|
|
|
207
|
-
- **`patchWorld` takes a `getWorld()` body back again** (
|
|
221
|
+
- **`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
222
|
|
|
209
223
|
### Added
|
|
210
224
|
|
|
@@ -235,7 +249,7 @@ earlier history lives in git log only.
|
|
|
235
249
|
|
|
236
250
|
### Added
|
|
237
251
|
|
|
238
|
-
- **`typeWord(world, type, { supertype, many })`**, the names profile's reader (schema-dist `profiles/names.md
|
|
252
|
+
- **`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
253
|
- 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
254
|
|
|
241
255
|
### Changed
|
|
@@ -246,41 +260,41 @@ earlier history lives in git log only.
|
|
|
246
260
|
|
|
247
261
|
### Added
|
|
248
262
|
|
|
249
|
-
- **`delete(type, id, { ifMatch })`** (
|
|
263
|
+
- **`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
264
|
- 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
265
|
|
|
252
266
|
## [4.60.0] - 2026-10-22
|
|
253
267
|
|
|
254
268
|
### Added
|
|
255
269
|
|
|
256
|
-
- **`OwFrontDoor`, and `front_door` on `OwMe` and `OwAgentJoined`** (
|
|
270
|
+
- **`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
271
|
|
|
258
272
|
## [4.59.0] - 2026-10-22
|
|
259
273
|
|
|
260
274
|
### Changed
|
|
261
275
|
|
|
262
|
-
- **`API-Pin` is sent only where keel checks it** (Skeld's ruling,
|
|
276
|
+
- **`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
277
|
- 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
278
|
|
|
265
279
|
## [4.58.0] - 2026-10-22
|
|
266
280
|
|
|
267
281
|
### Added
|
|
268
282
|
|
|
269
|
-
- **The proposed change** (
|
|
283
|
+
- **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
284
|
- **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
285
|
- **Five codes**: `isStaleProposal` (`OwStaleProposalError` with `conflicts: [{ field, base, current }]` and `current`, parsed like the 412), `isOwnProposal`, `isProposedOnly`, `isTooManyOpen`, `isFieldNotVisible`.
|
|
272
286
|
- **`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
|
|
287
|
+
- 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
288
|
|
|
275
289
|
## [4.57.2] - 2026-10-22
|
|
276
290
|
|
|
277
291
|
### Changed
|
|
278
292
|
|
|
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
|
|
293
|
+
- **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
294
|
|
|
281
295
|
### Fixed
|
|
282
296
|
|
|
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 (
|
|
297
|
+
- **`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
298
|
|
|
285
299
|
## [4.57.1] - 2026-10-22
|
|
286
300
|
|
|
@@ -292,8 +306,8 @@ earlier history lives in git log only.
|
|
|
292
306
|
|
|
293
307
|
### Added
|
|
294
308
|
|
|
295
|
-
- **The conditional head poll** (
|
|
296
|
-
- **The public page on `OwWorldMeta`** (
|
|
309
|
+
- **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.
|
|
310
|
+
- **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
311
|
- **`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
312
|
|
|
299
313
|
### Changed
|
|
@@ -304,7 +318,7 @@ earlier history lives in git log only.
|
|
|
304
318
|
|
|
305
319
|
### Added
|
|
306
320
|
|
|
307
|
-
- **The client's name** (
|
|
321
|
+
- **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
322
|
- **`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
323
|
|
|
310
324
|
### Changed
|
|
@@ -316,7 +330,7 @@ earlier history lives in git log only.
|
|
|
316
330
|
|
|
317
331
|
### Added
|
|
318
332
|
|
|
319
|
-
- **The room profile** (schema-dist `profiles/room.md`, serial 45; Skeld's rulings,
|
|
333
|
+
- **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
334
|
|
|
321
335
|
### Changed
|
|
322
336
|
|
|
@@ -372,18 +386,18 @@ earlier history lives in git log only.
|
|
|
372
386
|
|
|
373
387
|
### Added
|
|
374
388
|
|
|
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
|
|
389
|
+
- `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.
|
|
390
|
+
- `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.
|
|
391
|
+
- `site` joins `OwWriteDoor`: a write or delete the owner made signed in on onlyworlds.com.
|
|
378
392
|
|
|
379
393
|
## [4.49.0] - 2026-10-22
|
|
380
394
|
|
|
381
395
|
### Changed
|
|
382
396
|
|
|
383
|
-
- **The world file follows Folder Format §4.7, the `.owworld` archive
|
|
397
|
+
- **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
398
|
- The reader parses the central directory itself (zip64 included) and runs every check on names, kinds, methods and sizes before it inflates anything.
|
|
385
399
|
- 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,
|
|
400
|
+
- 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
401
|
- 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
402
|
- 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
403
|
- 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 +415,50 @@ earlier history lives in git log only.
|
|
|
401
415
|
|
|
402
416
|
### Added
|
|
403
417
|
|
|
404
|
-
- `listHidden()`: `GET /world/hidden`, the world's hidden elements newest first as `OwHiddenRow[]` (`type`, `id`, `set_at`, `set_by
|
|
418
|
+
- `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
419
|
|
|
406
420
|
## [4.47.0] - 2026-10-22
|
|
407
421
|
|
|
408
422
|
### Added
|
|
409
|
-
- `draught(characterId, policy)`: `GET /character/{id}/context` (
|
|
423
|
+
- `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
424
|
- `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
425
|
|
|
412
426
|
## [4.46.0] - 2026-10-22
|
|
413
427
|
|
|
414
428
|
### Added
|
|
415
|
-
- **Sign in with OnlyWorlds** (
|
|
429
|
+
- **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
430
|
|
|
417
431
|
## [4.45.0] - 2026-10-22
|
|
418
432
|
|
|
419
433
|
### Added
|
|
420
|
-
- `hide(type, id)` and `unhide(type, id)`: the hidden mark's writes, `PUT` and `DELETE /{type}/{id}/hidden
|
|
434
|
+
- `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
435
|
- `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
436
|
|
|
423
437
|
## [4.44.0] - 2026-10-22
|
|
424
438
|
|
|
425
439
|
### Added
|
|
426
|
-
- `changes({ after })` and `changesAll(since, { after })
|
|
440
|
+
- `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
441
|
|
|
428
442
|
## [4.43.0] - 2026-10-22
|
|
429
443
|
|
|
430
444
|
### 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 (
|
|
445
|
+
- `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`.
|
|
446
|
+
- `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
447
|
|
|
434
448
|
## [4.42.4] - 2026-10-21
|
|
435
449
|
|
|
436
450
|
### 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 (
|
|
451
|
+
- **`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
452
|
|
|
439
453
|
## [4.42.3] - 2026-10-21
|
|
440
454
|
|
|
441
455
|
### 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,
|
|
456
|
+
- **`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.
|
|
457
|
+
- `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
458
|
|
|
445
459
|
## [4.42.2] - 2026-10-20
|
|
446
460
|
|
|
447
|
-
Two calendar reading fixes, found writing the `atlas_calendar` profile's conformance fixture (
|
|
461
|
+
Two calendar reading fixes, found writing the `atlas_calendar` profile's conformance fixture (2026-10-20).
|
|
448
462
|
|
|
449
463
|
### Fixed
|
|
450
464
|
- **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 +466,7 @@ Two calendar reading fixes, found writing the `atlas_calendar` profile's conform
|
|
|
452
466
|
|
|
453
467
|
## [4.42.1] - 2026-10-20
|
|
454
468
|
|
|
455
|
-
The calendar reader refuses what the `atlas_calendar` profile refuses (schema-dist `profiles/calendar.md`; Quillon's Unity read,
|
|
469
|
+
The calendar reader refuses what the `atlas_calendar` profile refuses (schema-dist `profiles/calendar.md`; Quillon's Unity read, 2026-10-20).
|
|
456
470
|
|
|
457
471
|
### Fixed
|
|
458
472
|
- **`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 +474,7 @@ The calendar reader refuses what the `atlas_calendar` profile refuses (schema-di
|
|
|
460
474
|
|
|
461
475
|
## [4.42.0] - 2026-10-20
|
|
462
476
|
|
|
463
|
-
Schema 00.32.02 (Skeld,
|
|
477
|
+
Schema 00.32.02 (Skeld, 2026-10-20): repinned to schema-dist v0.32.2-dist.29.
|
|
464
478
|
|
|
465
479
|
### Changed
|
|
466
480
|
- **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 +482,7 @@ Schema 00.32.02 (Skeld, OW Council h58 #8811): repinned to schema-dist v0.32.2-d
|
|
|
468
482
|
|
|
469
483
|
## [4.41.0] - 2026-10-20
|
|
470
484
|
|
|
471
|
-
A known-of stub's public fields
|
|
485
|
+
A known-of stub's public fields, live in production, and schema-dist v0.32.1-dist.28, which publishes them.
|
|
472
486
|
|
|
473
487
|
### Added
|
|
474
488
|
- **`PUBLIC_FIELDS`** (generated from the distribution's `presentation.json`, `types.<type>.public`): per element type,
|
|
@@ -488,7 +502,7 @@ A known-of stub's public fields (keel PR 117, keel #448), live in production, an
|
|
|
488
502
|
|
|
489
503
|
## [4.40.0] - 2026-10-20
|
|
490
504
|
|
|
491
|
-
The "known of" stub's client half
|
|
505
|
+
The "known of" stub's client half, live in production since 2026-10-20 13:47.
|
|
492
506
|
|
|
493
507
|
### Added
|
|
494
508
|
- **`known_of?: true`** on `OwElementBase` (generated; `SCHEMA.md` says it too): present, and true, only on a
|
|
@@ -507,10 +521,10 @@ The "known of" stub's client half (keel PR 113, B16; keel #421 §7g), live in pr
|
|
|
507
521
|
|
|
508
522
|
## [4.39.0] - 2026-10-20
|
|
509
523
|
|
|
510
|
-
The party link
|
|
524
|
+
The party link, live in production since 2026-10-20 13:15.
|
|
511
525
|
|
|
512
526
|
### Added
|
|
513
|
-
- The party link (
|
|
527
|
+
- The party link (for Lantern's pick screen, Temper): one player link for a
|
|
514
528
|
table of players. `createWorldLink(worldId, { reader: 'player', maxUses, characters })`, sent as `max_uses`
|
|
515
529
|
and `characters`: 2 to 50 uses, each player picking one Character from the owner's list, in its order; no
|
|
516
530
|
list, each player names a fresh Character after themselves. A table takes no `character`. A link for one
|
|
@@ -520,15 +534,15 @@ The party link (keel #422 PR 2, keel PR 110), live in production since 2026-10-2
|
|
|
520
534
|
`redeemJoin(code, { character })` sends the pick; with `name_required`, `name` alone. A pick a live seat
|
|
521
535
|
already plays is 422 `character_taken` (`err.isCharacterTaken`); a pick off the list, hidden or deleted
|
|
522
536
|
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
|
|
537
|
+
(`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
538
|
lost to another player is the one 404 (`err.isNotFound`).
|
|
525
539
|
|
|
526
540
|
### 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
|
|
541
|
+
- 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
542
|
|
|
529
543
|
## [4.38.0] - 2026-10-20
|
|
530
544
|
|
|
531
|
-
Schema 00.32.01 (
|
|
545
|
+
Schema 00.32.01 (Titus's word, 2026-10-20): repinned to schema-dist v0.32.1-dist.26.
|
|
532
546
|
|
|
533
547
|
### Changed
|
|
534
548
|
- **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 +550,22 @@ Schema 00.32.01 (the Captain's word, h55 #8395): repinned to schema-dist v0.32.1
|
|
|
536
550
|
|
|
537
551
|
## [4.37.0] - 2026-10-20
|
|
538
552
|
|
|
539
|
-
The hidden mark
|
|
553
|
+
The hidden mark, live in production since 2026-10-20 09:24; walked on staging with the mark on, 25 of 25.
|
|
540
554
|
|
|
541
555
|
### Added
|
|
542
|
-
- A `/changes` delete row's `reason` (`OwDeleteReason`: `deleted` | `hidden` | `out_of_view`; keel
|
|
556
|
+
- A `/changes` delete row's `reason` (`OwDeleteReason`: `deleted` | `hidden` | `out_of_view`; keel's hidden
|
|
543
557
|
mark): an element hidden from this reader leaves its copy as a deleted one does, and a GET of it answers 404,
|
|
544
558
|
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` (
|
|
559
|
+
- `viewAs` on `get`, `list` and `listAll`, sent as `as` (view as): the owner's key reads as a
|
|
546
560
|
member (a membership id), as a Character's guest (a Character id) or as the public (`'public'`). A member key
|
|
547
561
|
gets 403 `view_as_owner_only` (`err.isViewAsOwnerOnly`); an element hidden from that reader is 404, never 410;
|
|
548
562
|
an unknown value is 422. Until keel's hidden mark is on, keel answers 422 (an unknown parameter).
|
|
549
563
|
- `err.resyncReason` (`'role'` | `'view'` | `undefined`) and `OwResyncReason`: why `/changes` answered 409
|
|
550
|
-
`resync_required`, from the envelope's `reason` (
|
|
564
|
+
`resync_required`, from the envelope's `reason` (only while keel's hidden mark is on).
|
|
551
565
|
`epoch_reason` beside `epoch` on `OwChangesPage` and on `changesHead()`'s answer: why the epoch last moved.
|
|
552
566
|
|
|
553
567
|
### Changed
|
|
554
|
-
- The resync instruction adds the hidden mark's reasons to 4.36.1's keep (
|
|
568
|
+
- The resync instruction adds the hidden mark's reasons to 4.36.1's keep (Titus, 2026-10-20): after a
|
|
555
569
|
409 `resync_required`, walk again from the start; reason `role` (the key's own role or membership moved):
|
|
556
570
|
keep what the local copy holds that the walk no longer names; reason `view`, or a delete row with reason
|
|
557
571
|
`hidden`: drop it; no reason (keel's hidden mark off): keep it, a reset never empties a copy. A tool never
|
|
@@ -562,37 +576,37 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
562
576
|
|
|
563
577
|
### Changed
|
|
564
578
|
|
|
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 (
|
|
579
|
+
- `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
580
|
|
|
567
581
|
## [4.36.1] - 2026-10-20
|
|
568
582
|
|
|
569
583
|
### Changed
|
|
570
584
|
|
|
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
|
|
585
|
+
- 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
586
|
|
|
573
587
|
## [4.36.0] - 2026-10-20
|
|
574
588
|
|
|
575
589
|
### Changed
|
|
576
590
|
|
|
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,
|
|
591
|
+
- **`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
592
|
|
|
579
593
|
## [4.35.0] - 2026-10-20
|
|
580
594
|
|
|
581
595
|
### Added
|
|
582
596
|
|
|
583
|
-
- **`createWorldLink(worldId, { preview })`** and `preview` on `OwWorldLink` (
|
|
597
|
+
- **`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
598
|
|
|
585
599
|
## [4.34.0] - 2026-10-20
|
|
586
600
|
|
|
587
601
|
### Added
|
|
588
602
|
|
|
589
|
-
- **`fieldLabel(name)`** and **`FIELD_ACRONYMS`**: a field name as the words a tool shows, by the house rule (
|
|
603
|
+
- **`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
604
|
|
|
591
605
|
## [4.33.1] - 2026-10-19
|
|
592
606
|
|
|
593
607
|
### Fixed
|
|
594
608
|
- 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
|
|
609
|
+
`X-OW-Agent`, the one files route keel's document lists it on, so the file reads
|
|
596
610
|
`added_by.agent: true`. The other files routes and the upload host get no such header.
|
|
597
611
|
|
|
598
612
|
## [4.33.0] - 2026-10-19
|
|
@@ -600,12 +614,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
600
614
|
### Added
|
|
601
615
|
- `FILE_EXTENSIONS` (every extension a file on an element may end in, to its kind: keel's list, `.yml` and
|
|
602
616
|
`.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,
|
|
617
|
+
the SDK's instead of a copy (Atlas, 2026-10-19).
|
|
604
618
|
|
|
605
619
|
## [4.32.0] - 2026-10-19
|
|
606
620
|
|
|
607
621
|
### Added
|
|
608
|
-
- **Files on elements
|
|
622
|
+
- **Files on elements**, for Atlas's file list on an element:
|
|
609
623
|
- `listFiles(type, id)`: the element's files, newest first (`OwFileRow`: `id`, `name`, `kind`,
|
|
610
624
|
`size`, `label`, `added_by` with `name`, `membership` and `agent`, `added_at`), as keel sends them.
|
|
611
625
|
- `uploadFile(type, id, file, { name?, kind?, label?, ticket?, onProgress? })`: a ticket from the API,
|
|
@@ -632,7 +646,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
632
646
|
## [4.31.0] — 2026-10-18
|
|
633
647
|
|
|
634
648
|
### Added
|
|
635
|
-
- **Signing in with a password
|
|
649
|
+
- **Signing in with a password**: `signInWithPassword({ email | username, password, tokenName })`
|
|
636
650
|
turns an email address (or username) and password into a new account token (`ow_a_`) for this device,
|
|
637
651
|
named `tokenName`, the name the account's tokens page lists it under. It signs in at keel's sign-in service
|
|
638
652
|
(`{baseUrl}/auth/app/v1`), mints the token with that session at `POST /account/tokens`, then ends the
|
|
@@ -647,7 +661,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
647
661
|
account's worlds, revoked and read back as `key_revoked`).
|
|
648
662
|
|
|
649
663
|
### Changed
|
|
650
|
-
- `me()`'s doc names the player kind
|
|
664
|
+
- `me()`'s doc names the player kind.
|
|
651
665
|
|
|
652
666
|
## [4.30.1] — 2026-10-16
|
|
653
667
|
|
|
@@ -661,7 +675,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
661
675
|
## [4.30.0] — 2026-10-16
|
|
662
676
|
|
|
663
677
|
### Added
|
|
664
|
-
- **A friend with only a link
|
|
678
|
+
- **A friend with only a link**:
|
|
665
679
|
- `redeemJoin(code, { name?, agentName? })`: redeems a join code that needs no account, at `POST /join`,
|
|
666
680
|
sending no credential whatever key the client holds. The answer's `kind` tells the two apart:
|
|
667
681
|
`OwPlayerJoined` (a read key, `ow_r_`, no PIN, and the Character the player reads as) or
|
|
@@ -678,19 +692,19 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
678
692
|
## [4.29.0] — 2026-10-16
|
|
679
693
|
|
|
680
694
|
### Added
|
|
681
|
-
- `rekeySeat(worldId, seatId)
|
|
695
|
+
- `rekeySeat(worldId, seatId)`: a new key and secret for a seat whose AI lost
|
|
682
696
|
its own, by its sponsor or the world's owner. The old key and secret stop at once; the answer has
|
|
683
697
|
`createSeat`'s shape (`OwSeatCreated`: `key`, `pin`, `env`), shown once. No Idempotency-Key, by keel's
|
|
684
698
|
rule: if the answer is lost too, ask for another.
|
|
685
699
|
|
|
686
700
|
### Changed
|
|
687
701
|
- `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
|
|
702
|
+
- `OwApiError.param`'s doc: `API-Pin` on a 401 PIN refusal, not only a 422/400's field.
|
|
689
703
|
|
|
690
704
|
## [4.28.0] — 2026-10-16
|
|
691
705
|
|
|
692
706
|
### Added
|
|
693
|
-
- **Seats for your own AI
|
|
707
|
+
- **Seats for your own AI**, on an account token (`ow_a_`):
|
|
694
708
|
- `createSeat(worldId, { name, role?, character? })`: a seat for your own AI in a world you own or
|
|
695
709
|
belong to, with its own write key and `ow_s_` secret and no join link. You answer for it. `role` is at
|
|
696
710
|
most your own; `character` is `new` (default), `none`, or `mine` (it plays the Character you play).
|
|
@@ -709,7 +723,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
709
723
|
element's position in `items` (the ids the Python package mints), so the same key and items send the
|
|
710
724
|
same body from either client, and a resend after keel's 24-hour replay window rewrites the same
|
|
711
725
|
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 (
|
|
726
|
+
your items are not changed. Found by Quillon's parity audit of the Unity SDK (2026-10-16).
|
|
713
727
|
|
|
714
728
|
## [4.27.1] — 2026-10-16
|
|
715
729
|
|
|
@@ -720,12 +734,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
720
734
|
Python package mints), so the retry sends the same body and gets the first answer back. Without a key,
|
|
721
735
|
a fresh UUIDv7 as before; an id you pass is kept.
|
|
722
736
|
- `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 (
|
|
737
|
+
Quillon's parity audit of the Unity SDK (2026-10-16).
|
|
724
738
|
|
|
725
739
|
## [4.27.0] — 2026-10-16
|
|
726
740
|
|
|
727
741
|
### Added
|
|
728
|
-
- `OwApiError.isIdempotencyInFlight
|
|
742
|
+
- `OwApiError.isIdempotencyInFlight`: a request with the same Idempotency-Key is still
|
|
729
743
|
running (409 `idempotency_in_flight`, `retryAfter` 1). Nothing was written by this one; send again with
|
|
730
744
|
the same key and body after `retryAfter` and it replays the first answer. `isIdempotencyConflict` stays
|
|
731
745
|
the different-body case only. The client still does not retry for you.
|
|
@@ -733,7 +747,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
733
747
|
## [4.26.0] — 2026-10-15
|
|
734
748
|
|
|
735
749
|
### Added
|
|
736
|
-
- **The door of every write
|
|
750
|
+
- **The door of every write**. An opt-in
|
|
737
751
|
`agent: true` on `OwClientConfig` sends `X-OW-Agent` on every element write (create, upsert,
|
|
738
752
|
patch, delete, editLinks, bulk: the operations keel's document declares it on; never on reads,
|
|
739
753
|
account routes or the image edge); keel records such writes as `declared`, agent-made, and stores only that the header was
|
|
@@ -750,10 +764,10 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
750
764
|
- **`OwWorldMeta` types every field keel's `World` declares** (it named four): the description and
|
|
751
765
|
picture, the calendar (`time_format_names`, `time_format_equivalents`, `time_basic_unit`, the three
|
|
752
766
|
`time_range_*`), the three unit labels, `public_read`, `owner_character`, `created_at`, and new
|
|
753
|
-
**`agent_narrator_rule`** (
|
|
767
|
+
**`agent_narrator_rule`** (whether a Narrative written through an agent seat is
|
|
754
768
|
narrated by that seat's own Character; read-only, set on the world page). Past `id` and `name`
|
|
755
769
|
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.
|
|
770
|
+
`updated_at` and `created_at` read `string | null`, as the document says. The wire gate now
|
|
757
771
|
holds this type to `World` (it had held only the PATCH body). Council and Lantern type-check on it.
|
|
758
772
|
|
|
759
773
|
## [4.24.0] — 2026-10-15
|
|
@@ -765,11 +779,11 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
765
779
|
keel keeps a hash); `listWorldLinks(worldId)` the links without codes, each with its `status`
|
|
766
780
|
and `uses`; `revokeWorldLink(worldId, linkId)`. Types `OwWorldLink`, `OwCreatedWorldLink`. A
|
|
767
781
|
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,
|
|
782
|
+
For Lantern's Invite someone (Temper, 2026-10-15).
|
|
769
783
|
|
|
770
784
|
### Changed
|
|
771
|
-
- `acceptJoin`'s doc comment and the README: accepting needs no account PIN for any role
|
|
772
|
-
|
|
785
|
+
- `acceptJoin`'s doc comment and the README: accepting needs no account PIN for any role,
|
|
786
|
+
so its refusals are 404 and 409 `already_member`; `pin_required` now belongs to
|
|
773
787
|
minting a write key for the membership. `isPinRequired` stays.
|
|
774
788
|
- Doc comments say "token rating" for the account's daily budget (`ask`, `sort`, `allowance`,
|
|
775
789
|
`OwAllowance`, the answers' `token_rating`), as the README did in 4.23.0; the docs site's
|
|
@@ -781,14 +795,14 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
781
795
|
- **`TokenResource.consume()`, `getAccessKey()`, `revokeSession()`, `revokeAllSessions()`**: keel
|
|
782
796
|
serves none of these routes (each answers 404 `not_found` on production; `accounts/token_api.py`
|
|
783
797
|
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,
|
|
798
|
+
work (the Council's acts through keel's council proxy, Skeld's ruling, 2026-10-14), and
|
|
785
799
|
`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
|
|
800
|
+
any token route now says what keel serves instead of "an older server". Found by the wire
|
|
787
801
|
gate, which until now never drove this class (its routes are not in keel's document).
|
|
788
802
|
|
|
789
803
|
### Changed
|
|
790
|
-
- README and docs: "token rating" is the one word for the account's daily budget (
|
|
791
|
-
|
|
804
|
+
- README and docs: "token rating" is the one word for the account's daily budget (Titus,
|
|
805
|
+
2026-10-14). Names in the API (`allowance()`, `/account/allowance`) are unchanged.
|
|
792
806
|
|
|
793
807
|
## [4.22.0] — 2026-10-14
|
|
794
808
|
|
|
@@ -796,23 +810,23 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
796
810
|
- **`client.me()` and `client.members()`**: GET /me (who this world key is: world, scope, kind,
|
|
797
811
|
role, membership id, Character) and GET /members (the roster's rows, unwrapped from `{ data }`).
|
|
798
812
|
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
|
|
813
|
+
keel's declared schemas and held to them by the wire gate. An account token is a
|
|
800
814
|
TypeError before sending; the tests fail with that guard removed, or with the rows left
|
|
801
815
|
wrapped.
|
|
802
816
|
|
|
803
817
|
### Changed
|
|
804
818
|
- The calendar kernel is the SDK's own: Atlas 245aad3 deleted its `core/calendar.ts` and imports
|
|
805
|
-
this one (Temper,
|
|
819
|
+
this one (Temper, 2026-10-14), so the copy record (`src/calendar/SOURCES.json`) and the re-copy
|
|
806
820
|
script (`codegen/atlas-calendar.mjs`) are gone. A kernel change is an SDK release now. No code
|
|
807
821
|
change.
|
|
808
822
|
|
|
809
823
|
## [4.21.0] — 2026-10-14
|
|
810
824
|
|
|
811
825
|
### Added
|
|
812
|
-
- **`client.allowance()`**: GET /account/allowance (keel 872431f, Skeld
|
|
826
|
+
- **`client.allowance()`**: GET /account/allowance (keel 872431f, Skeld, 2026-10-14), the
|
|
813
827
|
account's daily AI allowance read without spending: `token_rating`, `tokens_used_today`,
|
|
814
828
|
`tokens_remaining`, `resets_at` (the next midnight UTC). Account token only, like ask and
|
|
815
|
-
sort. Type `OwAllowance`, held by
|
|
829
|
+
sort. Type `OwAllowance`, held by the wire gate to the route's declared schema, as
|
|
816
830
|
`OwAskAnswer`, `OwSortAnswer` and `OwJoinPreview` now are to theirs.
|
|
817
831
|
|
|
818
832
|
### Fixed
|
|
@@ -823,13 +837,13 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
823
837
|
|
|
824
838
|
### Added
|
|
825
839
|
- **World calendars**, Atlas's calendar code in the SDK so Lantern can name dates (Temper,
|
|
826
|
-
|
|
840
|
+
2026-10-14): `formatStep`, `formatYearLabel`, `breakdownStep`, `parseDate` and the rest of
|
|
827
841
|
Atlas's `src/core/calendar.ts` (Atlas 02d6a6d), plus `worldCalendars`,
|
|
828
842
|
`resolveCalendarLens` and `readCalendarValue` from its `calendar-lens.ts`, on any element
|
|
829
843
|
shape. `CALENDAR_FIELD` is `atlas_calendar`: Atlas owns the field, its meaning and its
|
|
830
|
-
writes, and other tools read it (Skeld,
|
|
844
|
+
writes, and other tools read it (Skeld, 2026-10-14).
|
|
831
845
|
- `src/calendar/calendar.ts` is Atlas's file byte for byte, recorded in
|
|
832
|
-
`src/calendar/SOURCES.json
|
|
846
|
+
`src/calendar/SOURCES.json`; `codegen/atlas-calendar.mjs` re-copies it
|
|
833
847
|
and ports Atlas's 48 kernel tests (TypeScript's transpiler, a five-matcher `test/expect.mjs`
|
|
834
848
|
over node:test). Watched failing: a planted `floorMod` edit failed two tests and the record
|
|
835
849
|
(EDITED); a lens edit failed its test. An app that imports none of it bundles none of it.
|
|
@@ -838,7 +852,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
838
852
|
|
|
839
853
|
### Added
|
|
840
854
|
- **`tokens_remaining` and `token_rating` on `OwAskAnswer` and `OwSortAnswer`**: since keel
|
|
841
|
-
a6244db (Skeld,
|
|
855
|
+
a6244db (Skeld, 2026-10-14) ask and sort spend from the account's daily token rating, one
|
|
842
856
|
meter with the Council. `remaining` stays a count of answers: how many more calls of this
|
|
843
857
|
size fit in what is left today (keel 504437b), never tokens. Typed from keel's code
|
|
844
858
|
(`accounts/ask.py`), since its OpenAPI document gives these answers no schema.
|
|
@@ -849,10 +863,10 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
849
863
|
each one by its own name: `x_eye_colour` reads `eye colour: grey`; an id in one is a link,
|
|
850
864
|
by name; a long value is cut like a description. `atlas_*` machinery stays out, and so do
|
|
851
865
|
object values (a tool's state). Lantern shows and edits custom fields now, so Ask can answer
|
|
852
|
-
what find already could (Temper,
|
|
866
|
+
what find already could (Temper, 2026-10-13). The trial's lookup
|
|
853
867
|
still skips them; parity holds on its ten questions, whose fixture has no custom text.
|
|
854
868
|
- 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,
|
|
869
|
+
apps that never call the lookup (451 bytes; Temper, 2026-10-14).
|
|
856
870
|
|
|
857
871
|
## [4.18.1] — 2026-10-12
|
|
858
872
|
|
|
@@ -866,13 +880,13 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
866
880
|
|
|
867
881
|
### Added
|
|
868
882
|
- **`client.sort({ worldId, notes, slice })`**: POST /account/sort, ask's sibling (Temper for
|
|
869
|
-
Lantern,
|
|
883
|
+
Lantern, 2026-10-12; Skeld's route). Notes as words or
|
|
870
884
|
`{ text, image_url }`; the slice is the app's own lookup. Rows of four kinds come back to
|
|
871
885
|
review (`make`, `add_to`, `link`, `ask` with an optional `then`) and `not_proposed` with
|
|
872
886
|
reasons; nothing is written. One allowance with `ask`, and the same refusals. Types
|
|
873
887
|
`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
|
|
888
|
+
keel PR #4 (90961fa, Skeld's final for the types), released once it was on keel
|
|
889
|
+
main and in production: verify-sdk-wire PASS 1,111 against production's document.
|
|
876
890
|
|
|
877
891
|
## [4.17.0] — 2026-10-12
|
|
878
892
|
|
|
@@ -881,7 +895,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
881
895
|
says which view epoch it ran under (a guest's integer; `null` for other keys or a keel
|
|
882
896
|
without the field) and the first poll after it needs no extra walk to learn it. Live on
|
|
883
897
|
Moppetopia: a full walk of 465 changes returns `{ cursor, head: 818, epoch: null }`. The first
|
|
884
|
-
tests of `changesAll`'s return value (Temper,
|
|
898
|
+
tests of `changesAll`'s return value (Temper, 2026-10-12).
|
|
885
899
|
|
|
886
900
|
## [4.16.0] — 2026-10-12
|
|
887
901
|
|
|
@@ -892,7 +906,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
892
906
|
`epoch` moved; nothing needs to read inside the cursor. `changesHead()` answers
|
|
893
907
|
`epoch: null` from a keel without the field. Checked live on Moppetopia (the head read and a
|
|
894
908
|
page both carry `epoch: null`). The wire gate now holds `OwChangesPage` and `OwBulkResponse`
|
|
895
|
-
to keel's `ChangesPage` and `BulkResult
|
|
909
|
+
to keel's `ChangesPage` and `BulkResult`, and failed on 4.15.0 for the missing
|
|
896
910
|
`epoch` before this release.
|
|
897
911
|
Published from tag `v4.16.0`; the workflow's read-back gave up before npm showed the
|
|
898
912
|
version, so the tarball (shasum `d08de22b`) was read back by hand against a build of the tag.
|
|
@@ -923,7 +937,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
923
937
|
## [4.13.0] — 2026-10-12
|
|
924
938
|
|
|
925
939
|
### Added
|
|
926
|
-
- **Ask your world
|
|
940
|
+
- **Ask your world.** `client.ask({ worldId, question, context })` sends a
|
|
927
941
|
question to keel's AI proxy with the account's `ow_a_` token (a world key is a `TypeError`
|
|
928
942
|
before sending) and returns `OwAskAnswer` (`answer`, `model`, `stop_reason`, `usage`,
|
|
929
943
|
`remaining`). The answer comes from `context` only, or is "The world doesn't say.".
|
|
@@ -935,12 +949,12 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
935
949
|
New getters: `isQuotaExceeded` (429; `retryAfter` runs to midnight UTC), `isAskUnavailable`
|
|
936
950
|
(503), `isAskFailed` (502). keel's document gives no request schema for `/account/ask`, so
|
|
937
951
|
the body (`world_id`, `question`, `context`) is read from keel's code (`accounts/ask.py`).
|
|
938
|
-
Not yet run live: no
|
|
952
|
+
Not yet run live: no account token was at hand to run it with.
|
|
939
953
|
|
|
940
954
|
## [4.12.0] — 2026-10-12
|
|
941
955
|
|
|
942
956
|
### Added
|
|
943
|
-
- **Joining a world by link
|
|
957
|
+
- **Joining a world by link.** `previewJoin(code)` reads what a join code holds
|
|
944
958
|
without using it (`OwJoinPreview`: `reader`, `world`, `invited_by`, `owner_character`,
|
|
945
959
|
`role`, `with_character`, `expires_at`) and sends no credential, whatever key the client
|
|
946
960
|
holds. `acceptJoin(code)` accepts an invite link as the account behind the client's `ow_a_`
|
|
@@ -961,7 +975,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
961
975
|
forms first, then name words, supertype and subtype, one link step in both directions, then
|
|
962
976
|
other text and numbers (always below any name hit). Each hit says why it matched.
|
|
963
977
|
`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 (
|
|
978
|
+
when one phrases the answer. Measured on two real worlds (a Lantern Ask trial):
|
|
965
979
|
the answer was in the first three results for 60 of 60 questions that name their subject
|
|
966
980
|
and 17 of 24 held-out questions that only describe it; this code returns the same top 8
|
|
967
981
|
as the trial's on all 100 questions. Names in any script are matched (Chinese and Japanese
|
|
@@ -1002,7 +1016,7 @@ The hidden mark (keel #421), live in production since 2026-10-20 09:24; walked o
|
|
|
1002
1016
|
## [4.9.0] — 2026-10-11
|
|
1003
1017
|
|
|
1004
1018
|
### Added
|
|
1005
|
-
- **Only if unchanged
|
|
1019
|
+
- **Only if unchanged.** `patch(type, id, partial, { ifMatch })` and
|
|
1006
1020
|
`editLinks(type, id, field, edit, { ifMatch })` send `If-Match: "<change_seq>"`: the write
|
|
1007
1021
|
lands only if the element is still at that `change_seq`. When it has moved, nothing is
|
|
1008
1022
|
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"];
|
|
@@ -2576,11 +2576,28 @@ interface OwFrontDoor {
|
|
|
2576
2576
|
sponsor_character: string | null;
|
|
2577
2577
|
/** Your own Character (the owner's: the world's `owner_character`), or null. */
|
|
2578
2578
|
my_character: string | null;
|
|
2579
|
+
/**
|
|
2580
|
+
* The live AI and player seats you answer for, agent seats first (since keel's front door of
|
|
2581
|
+
* 2026-10-26). Empty for an AI or a player seat's own key and for anyone who answers for none;
|
|
2582
|
+
* a seat made from a link for an email address is never listed.
|
|
2583
|
+
*/
|
|
2584
|
+
my_seats: OwMySeat[];
|
|
2579
2585
|
/** The world's Charter: the newest Law with supertype Charter made by the owner or a co-builder, or null. Every member may read it. */
|
|
2580
2586
|
charter: string | null;
|
|
2581
2587
|
/** The Objects the Charter's description names (by `ow://` link or id), in the order written, at most five; empty when none. */
|
|
2582
2588
|
charter_skill: string[];
|
|
2583
2589
|
}
|
|
2590
|
+
/** One seat you answer for, a row of `front_door.my_seats`. */
|
|
2591
|
+
interface OwMySeat {
|
|
2592
|
+
/** The seat's membership id, as `GET /members` lists it. */
|
|
2593
|
+
id: string;
|
|
2594
|
+
/** `agent` for an AI seat, `player` for a player seat. */
|
|
2595
|
+
kind: 'agent' | 'player';
|
|
2596
|
+
/** The seat's name, or null when it has none. */
|
|
2597
|
+
name: string | null;
|
|
2598
|
+
/** The Character the seat plays, or null when it plays none you can read. */
|
|
2599
|
+
character: string | null;
|
|
2600
|
+
}
|
|
2584
2601
|
/** One row of GET /members, the world's roster. */
|
|
2585
2602
|
interface OwMember {
|
|
2586
2603
|
/** The membership id (what `created_by` holds), or null for the owner. */
|
|
@@ -2662,7 +2679,7 @@ interface OwWorldLink {
|
|
|
2662
2679
|
uses: number;
|
|
2663
2680
|
/** A table is `pending` while `uses < max_uses` (and neither revoked nor expired), `used` once full. */
|
|
2664
2681
|
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
|
|
2682
|
+
/** 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
2683
|
minted_by: string | null;
|
|
2667
2684
|
/** 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
2685
|
preview?: boolean;
|
|
@@ -2761,7 +2778,7 @@ interface OwSignedIn {
|
|
|
2761
2778
|
* (`'collaborator'`, with `member_role` the membership's role). Keys by name and last four only,
|
|
2762
2779
|
* never the key; on a shared world only the member's own keys.
|
|
2763
2780
|
*/
|
|
2764
|
-
/** The draught's policy
|
|
2781
|
+
/** The draught's policy: what GET /character/{id}/context serves and how. */
|
|
2765
2782
|
interface OwDraughtPolicy {
|
|
2766
2783
|
/** Sections to serve; default every one but `messages`, `room` and `proposed`, each served only when named. */
|
|
2767
2784
|
components?: OwDraughtComponent[];
|
|
@@ -2808,7 +2825,7 @@ interface OwDraughtItem {
|
|
|
2808
2825
|
/** The element's body exactly as the list route serves it to the same reader. */
|
|
2809
2826
|
element: OwElement;
|
|
2810
2827
|
}
|
|
2811
|
-
/** One Character's context in one read, GET /character/{id}/context (
|
|
2828
|
+
/** One Character's context in one read, GET /character/{id}/context (the draught). */
|
|
2812
2829
|
/** The draught under `compact`: every section may be absent, and so may `cut` (nothing was cut). */
|
|
2813
2830
|
type OwDraughtCompact = Omit<OwDraught, 'cut'> & {
|
|
2814
2831
|
cut?: Record<string, number>;
|
|
@@ -3122,9 +3139,9 @@ interface OwFileDownload {
|
|
|
3122
3139
|
interface ListParams {
|
|
3123
3140
|
limit?: number;
|
|
3124
3141
|
cursor?: string;
|
|
3125
|
-
/** Only these ids (1 to 200), in the list's own order; one this key cannot see is simply absent
|
|
3142
|
+
/** Only these ids (1 to 200), in the list's own order; one this key cannot see is simply absent. */
|
|
3126
3143
|
ids?: string[];
|
|
3127
|
-
/** A membership id, or `'owner'` for the owner's own writes: only what that member created
|
|
3144
|
+
/** A membership id, or `'owner'` for the owner's own writes: only what that member created. */
|
|
3128
3145
|
createdBy?: string;
|
|
3129
3146
|
/** One-level stub expansion, e.g. ['friends', 'location']. */
|
|
3130
3147
|
expand?: string[];
|
|
@@ -3308,8 +3325,8 @@ declare class OwApiError extends Error {
|
|
|
3308
3325
|
*/
|
|
3309
3326
|
get isViewAsOwnerOnly(): boolean;
|
|
3310
3327
|
/**
|
|
3311
|
-
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of
|
|
3312
|
-
*
|
|
3328
|
+
* An element write carried `known_of` (422 `known_of_not_writable`, `param` known_of),
|
|
3329
|
+
* true or false: the key marks a stub and is never written. Drop it and send only
|
|
3313
3330
|
* the fields you mean. This client never sends it (`known_of` is stripped, a stub is a
|
|
3314
3331
|
* TypeError before sending), so it reaches you only through `request()`. `/bulk` never
|
|
3315
3332
|
* throws for it: the item's slot carries the code, and its siblings apply.
|
|
@@ -3546,7 +3563,7 @@ declare function pinExpectation(kind: OwKeyKind): 'never' | 'optional' | 'requir
|
|
|
3546
3563
|
|
|
3547
3564
|
/**
|
|
3548
3565
|
* Sign in with OnlyWorlds: OAuth 2.1's authorization code with PKCE (S256) for public clients
|
|
3549
|
-
* (
|
|
3566
|
+
* (live 2026-10-22).
|
|
3550
3567
|
*
|
|
3551
3568
|
* Two calls. `beginSignIn` mints `state` and a PKCE verifier, keeps them under the client id in a
|
|
3552
3569
|
* storage the page shares with its callback (sessionStorage by default), and hands back the
|
|
@@ -3677,7 +3694,7 @@ declare class OwV2Client {
|
|
|
3677
3694
|
/** GET /{type}/ -- one cursor page. */
|
|
3678
3695
|
list(type: ElementType | string, params?: ListParams): Promise<OwPage>;
|
|
3679
3696
|
/**
|
|
3680
|
-
* GET /character/{id}/context -- the draught
|
|
3697
|
+
* GET /character/{id}/context -- the draught: what one Character knows, as the
|
|
3681
3698
|
* recorded world holds it, in one read: her element, what she holds and sits in, her open work,
|
|
3682
3699
|
* how she works, the Events she was in, the Narratives she knows, everything else that names
|
|
3683
3700
|
* her, her sheet, what changed around her (`since`), and who plays whom; the world's name and
|
|
@@ -3812,7 +3829,7 @@ declare class OwV2Client {
|
|
|
3812
3829
|
* the cursor and walk from zero. For what the local copy holds that the walk no longer names,
|
|
3813
3830
|
* read err.resyncReason (while keel's hidden mark is on): `role`, keep it; `view`,
|
|
3814
3831
|
* drop it (as for a delete row with reason `hidden`). Without a reason, keep it (keel's own
|
|
3815
|
-
* words
|
|
3832
|
+
* words; sharing is forward-only). Never empty a copy on your own.
|
|
3816
3833
|
* Citizenship: heaviest route on the platform; default page size is polite.
|
|
3817
3834
|
* keel sends the cursor of a page at the head as a number (an empty page, for a key
|
|
3818
3835
|
* whose cursor carries no epoch); it is handed back as a string, like every cursor here.
|
|
@@ -5677,4 +5694,4 @@ declare class TokenResource {
|
|
|
5677
5694
|
getEncryptionInfo(): Promise<EncryptionInfo>;
|
|
5678
5695
|
}
|
|
5679
5696
|
|
|
5680
|
-
export { AGENT_DOORS, ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, ELEMENT_FAMILIES, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GameTier, type ListParams, MESSAGE_PAIR, ONLYWORLDS_VERSION, type OwAccountWorld, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAskContextOptions, type OwAskLeftOut, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtPolicy, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwHiddenRow, type OwJoinPreview, type OwJoined, type OwJoinedMembership, type OwKeyKind, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberRole, type OwMessageMember, type OwMintedKey, type OwNamesMap, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwProposal, type OwProposalAccepted, type OwProposalConflict, type OwProposalList, type OwProposalQuery, type OwProposalState, type OwProposeInput, type OwProposed, OwProposedError, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwSignInBegin, type OwSignInBegun, type OwSignInComplete, OwSignInError, type OwSignInReason, type OwSignInResult, type OwSignInStorage, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, OwStaleProposalError, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWorldOrigin, type OwWorldProducer, type OwWorldProposalList, type OwWorldProposalQuery, type OwWorldProposalRow, type OwWorldPublicPage, type OwWorldSource, type OwWriteDoor, type OwWriteWorldFileOptions, type OwWriteWorldFileReport, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, type SectionInfo, type StepBreakdown, type TokenConsumeParams, type TokenConsumeResponse, TokenResource, type TokenStatus, type TokenTransport, WORLD_FILE_MAX_BYTES, WORLD_FILE_MAX_ENTRIES, WORLD_FILE_MEDIA_TYPE, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, base64url, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, intercalaryInYear, isAddressedTo, isAgentDoor, isDemoKey, isKnownOf, isLeapYear, isMessage, isParseError, isRoomElement, isSentBy, isToEveryone, kindCanWrite, lookupWorld, monthStartSteps, nfc, parseDate, parseErrorEnvelope, pinExpectation, pkceChallenge, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, recipientsOf, renderElement, resolveCalendarLens, resolveEraDomains, senderStatus, simpleCaseFold, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
|
|
5697
|
+
export { AGENT_DOORS, ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, ELEMENT_FAMILIES, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GameTier, type ListParams, MESSAGE_PAIR, ONLYWORLDS_VERSION, type OwAccountWorld, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAskContextOptions, type OwAskLeftOut, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtPolicy, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwHiddenRow, type OwJoinPreview, type OwJoined, type OwJoinedMembership, type OwKeyKind, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberRole, type OwMessageMember, type OwMintedKey, type OwMySeat, type OwNamesMap, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwProposal, type OwProposalAccepted, type OwProposalConflict, type OwProposalList, type OwProposalQuery, type OwProposalState, type OwProposeInput, type OwProposed, OwProposedError, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwSignInBegin, type OwSignInBegun, type OwSignInComplete, OwSignInError, type OwSignInReason, type OwSignInResult, type OwSignInStorage, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, OwStaleProposalError, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWorldOrigin, type OwWorldProducer, type OwWorldProposalList, type OwWorldProposalQuery, type OwWorldProposalRow, type OwWorldPublicPage, type OwWorldSource, type OwWriteDoor, type OwWriteWorldFileOptions, type OwWriteWorldFileReport, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, type SectionInfo, type StepBreakdown, type TokenConsumeParams, type TokenConsumeResponse, TokenResource, type TokenStatus, type TokenTransport, WORLD_FILE_MAX_BYTES, WORLD_FILE_MAX_ENTRIES, WORLD_FILE_MEDIA_TYPE, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, base64url, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, intercalaryInYear, isAddressedTo, isAgentDoor, isDemoKey, isKnownOf, isLeapYear, isMessage, isParseError, isRoomElement, isSentBy, isToEveryone, kindCanWrite, lookupWorld, monthStartSteps, nfc, parseDate, parseErrorEnvelope, pinExpectation, pkceChallenge, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, recipientsOf, renderElement, resolveCalendarLens, resolveEraDomains, senderStatus, simpleCaseFold, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
|
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
|