@onlyworlds/sdk 4.132.1 → 4.132.3

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 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.34.0-dist.106** (canonical 00.34.00).
3
+ **Current as of**: SDK **4.x** · schema-dist **v0.34.0-dist.107** (canonical 00.34.00).
4
4
  This line is asserted by `codegen:check` in CI — if the pin moves and this file is not
5
5
  re-read against it, the check fails rather than letting this document rot quietly.
6
6
 
package/CHANGELOG.md CHANGED
@@ -5,6 +5,24 @@ earlier history lives in git log only.
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [4.132.3] - 2026-11-04
9
+
10
+ ### Changed
11
+
12
+ - `openersFor`'s refusal of a bad `element_types` lists the 22 type words in the standard's own order, as the Python package and the game SDKs do (the message only; what is refused is unchanged).
13
+ - `me()` has a doc comment: what `GET /me` answers, that the client's PIN is sent there (the connection test), and that an account token is refused before sending.
14
+ - The doc comments of `agent`, `setMyLenses`, `setMemberLenses`, `createWorldLink`, `members`, `ask` and `allowance` name the server as onlyworlds.com or the server.
15
+
16
+ ### Tests
17
+
18
+ - The openers fixture gains three refusals of `element_types` (103 cases): a type word given twice, a word in another case, and a word that is no string. The same bytes as the Python package's copy.
19
+
20
+ ## [4.132.2] - 2026-11-03
21
+
22
+ ### Changed
23
+
24
+ - The schema pin moves to schema-dist `v0.34.0-dist.107` (canonical `00.34.00` unchanged, so `ONLYWORLDS_VERSION` is the same). Two profile sentences changed and no fixture: the charter profile names what open means to a public reader (the World's `public_read`), and the map-space profile's whole-number range sentence is dated. No reader changed.
25
+
8
26
  ## [4.132.1] - 2026-11-03
9
27
 
10
28
  ### Changed
package/SCHEMA.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OnlyWorlds Schema Reference
2
2
 
3
- **Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.34.0-dist.106** — canonical schema **00.34.00**, published 2026-11-02.
3
+ **Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.34.0-dist.107** — canonical schema **00.34.00**, published 2026-11-03.
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.
@@ -13,6 +13,7 @@ function refuseUnknownOptions(fn, opts, keys, after = "") {
13
13
 
14
14
  // src/v2/types.generated.ts
15
15
  var ELEMENT_TYPES = ["ability", "character", "collective", "construct", "creature", "event", "family", "institution", "language", "law", "location", "map", "marker", "narrative", "object", "phenomenon", "pin", "relation", "species", "title", "trait", "zone"];
16
+ var STANDARD_TYPE_ORDER = ["ability", "collective", "character", "construct", "creature", "event", "family", "institution", "language", "law", "location", "map", "marker", "narrative", "object", "phenomenon", "pin", "relation", "species", "title", "trait", "zone"];
16
17
  var ONLYWORLDS_VERSION = "00.34.00";
17
18
  var ELEMENT_GROUPS = {
18
19
  ability: "amber",
@@ -1360,7 +1361,7 @@ function openersFor(tools, kind, address, surface, options = {}) {
1360
1361
  if (elementDoor === null && skips.length > 0) fail(`tool ${r.id}: open.element_skips names what an element door leaves out, and the row has none`);
1361
1362
  const types = o.element_types === void 0 ? null : o.element_types;
1362
1363
  if (types !== null && (!Array.isArray(types) || types.length === 0 || new Set(types).size !== types.length || types.some((t) => !ELEMENT_TYPES.includes(t)))) {
1363
- fail(`tool ${r.id}: open.element_types is null or a non-empty list of distinct type words (${ELEMENT_TYPES.join(", ")}); got ${JSON.stringify(o.element_types)}`);
1364
+ fail(`tool ${r.id}: open.element_types is null or a non-empty list of distinct type words (${STANDARD_TYPE_ORDER.join(", ")}); got ${JSON.stringify(o.element_types)}`);
1364
1365
  }
1365
1366
  if (elementDoor === null && types !== null) fail(`tool ${r.id}: open.element_types names what an element door opens, and the row has none`);
1366
1367
  if (r.rung !== "listed") continue;
package/dist/index.d.ts CHANGED
@@ -3111,7 +3111,7 @@ interface OwMember {
3111
3111
  x_served_trimmed?: 'lenses'[];
3112
3112
  [k: string]: unknown;
3113
3113
  }
3114
- /** GET /account/allowance: the account's token rating and what is left of it today (keel 872431f, 2026-10-14). */
3114
+ /** GET /account/allowance: the account's token rating and what is left of it today. */
3115
3115
  interface OwAllowance {
3116
3116
  /** The account's token rating: its daily budget in tokens. */
3117
3117
  token_rating: number;
@@ -3875,8 +3875,8 @@ interface OwClientConfig {
3875
3875
  fetch?: typeof globalThis.fetch;
3876
3876
  /**
3877
3877
  * Declare this client an AI agent: every element write (create, upsert, patch, delete,
3878
- * editLinks, bulk) carries `X-OW-Agent`, the operations keel declares it on, and keel
3879
- * records its writes as agent-made (`changed_via: 'declared'`; keel stores that the header
3878
+ * editLinks, bulk) carries `X-OW-Agent`, the operations the API document declares it on, and onlyworlds.com
3879
+ * records its writes as agent-made (`changed_via: 'declared'`; the server stores that the header
3880
3880
  * was there, never its value). Off by default, and it must stay off in a tool people use:
3881
3881
  * it describes the caller, so only the caller can set it. An agent seat's key is recorded
3882
3882
  * as an agent without it.
@@ -4416,7 +4416,7 @@ declare class OwV2Client {
4416
4416
  setMyCharacter(character: string | null): Promise<OwMe>;
4417
4417
  /**
4418
4418
  * PUT /me/lenses -- choose the lenses this key's holder starts with: lens ids in order, 0 to 20,
4419
- * repeats dropped by keel; an empty list is a choice too (the draught then adds no frame), and keeps
4419
+ * repeats dropped by the server; an empty list is a choice too (the draught then adds no frame), and keeps
4420
4420
  * a seat off its Titles' lenses. `null` goes back to never chosen: a seat playing a Character then
4421
4421
  * starts with its Titles' lenses (`lenses_from` says where a list comes from); on the owner's own
4422
4422
  * keys `null` is the empty list. Any write
@@ -4448,11 +4448,19 @@ declare class OwV2Client {
4448
4448
  resolve?: boolean;
4449
4449
  readAs?: string;
4450
4450
  }): Promise<OwWorldLenses>;
4451
+ /**
4452
+ * GET /me -- who this key is in its world: the world, the key's scope, kind and role, its
4453
+ * membership and Character, the lenses it starts with, the world's reading aids, and the front
4454
+ * door (`front_door`: the sponsor and their Character, your own Character, the Charter and the
4455
+ * Objects it names, the seats you sponsor). The client's PIN is sent here when it has one, so a
4456
+ * wrong PIN shows on this call first, which makes it the connection test. An account token is
4457
+ * refused before sending: it is not a member of one world.
4458
+ */
4451
4459
  me(): Promise<OwMe>;
4452
4460
  /**
4453
4461
  * GET /members -- the world's roster: each member's id (null for the owner), kind, role,
4454
4462
  * Character and status (`removed` rows stay, so their elements keep `created_by`). Returns
4455
- * the rows; keel sends them as `{ data }` with no paging. A world key reads its own world's
4463
+ * the rows; the server sends them as `{ data }` with no paging. A world key reads its own world's
4456
4464
  * roster and sends no `world`. An account token reads the roster of the world the client's
4457
4465
  * `world` names (`world=<id>`, the Bearer token, no PIN), with the token's grant there: the
4458
4466
  * owner's token as the owner, a member's as its own member key; a world where it has none is a
@@ -4901,7 +4909,7 @@ declare class OwV2Client {
4901
4909
  * POST /account/worlds/{worldId}/links -- a new invite link for a world this client's
4902
4910
  * `ow_a_` token owns: `reader` is required (`person`, accepted with acceptJoin;
4903
4911
  * `agent`, redeemed at POST /join; `player`, a friend with no account, redeemed with
4904
- * redeemJoin for a read key); `role`, when left out, is keel's default: guest for a
4912
+ * redeemJoin for a read key); `role`, when left out, is the server's default: guest for a
4905
4913
  * person link, contributor for an agent link (a player link is guest, and refuses any other), `days` (1, 7 or 30) to 7; `withCharacter` (agent links
4906
4914
  * only) to true; `character` (player links only) a Character's id or `new` (the default):
4907
4915
  * whoever opens the link first reads as it, until removed. `preview` (person and player links)
@@ -4985,7 +4993,7 @@ declare class OwV2Client {
4985
4993
  removeSeat(worldId: string, seatId: string): Promise<void>;
4986
4994
  /**
4987
4995
  * PATCH /account/worlds/{worldId}/members/{memberId} with `lenses` alone -- set the lenses a row
4988
- * starts with: lens ids in order, 0 to 20, repeats dropped by keel; an empty list is a choice too,
4996
+ * starts with: lens ids in order, 0 to 20, repeats dropped by the server; an empty list is a choice too,
4989
4997
  * and keeps a seat off its Titles' lenses, while `null` puts the row back to never chosen (a seat
4990
4998
  * playing a Character then starts with its Titles' lenses; for `'owner'`, `null` is the empty list).
4991
4999
  * A member sets its own row (any role), an agent's or a player's seat it answers for (its sponsor),
@@ -5193,7 +5201,7 @@ declare class OwV2Client {
5193
5201
  completeSignIn(opts: OwSignInComplete): Promise<OwSignInResult>;
5194
5202
  /**
5195
5203
  * POST /account/ask -- a question about a world the account owns or is in, answered by
5196
- * keel's AI proxy from `context` only (build it with buildAskContext from the elements
5204
+ * onlyworlds.com's AI proxy from `context` only (build it with buildAskContext from the elements
5197
5205
  * the user sees; it leaves proposed, hidden and room elements out unless asked). The answer is "The world doesn't say." when the context does not hold
5198
5206
  * it. Needs the client's `ow_a_` token (a world key is a TypeError before sending).
5199
5207
  * Once the day's token rating is spent, an account that saved its own AI key on its account page is
@@ -5229,7 +5237,7 @@ declare class OwV2Client {
5229
5237
  }): Promise<OwSortAnswer>;
5230
5238
  /**
5231
5239
  * GET /account/allowance -- the account's token rating, the one daily meter ask, sort and
5232
- * the Council spend from (keel 872431f): the rating, what is used and left today, and
5240
+ * the Council spend from: the rating, what is used and left today, and
5233
5241
  * when it resets (the next midnight UTC), and `own_key` (`{provider}` when the account saved its own
5234
5242
  * AI key, which ask and sort use once the rating is spent; else null). Spends nothing. Needs the
5235
5243
  * client's `ow_a_` token.
package/dist/index.js CHANGED
@@ -42,7 +42,7 @@ import {
42
42
  trimWhiteSpace,
43
43
  typeWord,
44
44
  unknownKey
45
- } from "./chunk-3W5DADHM.js";
45
+ } from "./chunk-BHO3TVAN.js";
46
46
 
47
47
  // src/v2/keyed-id.ts
48
48
  var KEYED_IDS = "0199b6a0-6f0e-7c2a-9d1e-3b5c7a8e4f21";
@@ -791,7 +791,7 @@ var OwV2Client = class {
791
791
  }
792
792
  /**
793
793
  * PUT /me/lenses -- choose the lenses this key's holder starts with: lens ids in order, 0 to 20,
794
- * repeats dropped by keel; an empty list is a choice too (the draught then adds no frame), and keeps
794
+ * repeats dropped by the server; an empty list is a choice too (the draught then adds no frame), and keeps
795
795
  * a seat off its Titles' lenses. `null` goes back to never chosen: a seat playing a Character then
796
796
  * starts with its Titles' lenses (`lenses_from` says where a list comes from); on the owner's own
797
797
  * keys `null` is the empty list. Any write
@@ -832,6 +832,14 @@ var OwV2Client = class {
832
832
  const query = buildQuery({ resolve: opts.resolve, read_as: opts.readAs });
833
833
  return this.request("GET", `/world/${seg("worldId", worldId)}/lenses`, { query, accountToken: "path" });
834
834
  }
835
+ /**
836
+ * GET /me -- who this key is in its world: the world, the key's scope, kind and role, its
837
+ * membership and Character, the lenses it starts with, the world's reading aids, and the front
838
+ * door (`front_door`: the sponsor and their Character, your own Character, the Charter and the
839
+ * Objects it names, the seats you sponsor). The client's PIN is sent here when it has one, so a
840
+ * wrong PIN shows on this call first, which makes it the connection test. An account token is
841
+ * refused before sending: it is not a member of one world.
842
+ */
835
843
  async me() {
836
844
  if (this.keyKind === "account") {
837
845
  throw new TypeError("me needs a world key: an account token is not a member of one world");
@@ -841,7 +849,7 @@ var OwV2Client = class {
841
849
  /**
842
850
  * GET /members -- the world's roster: each member's id (null for the owner), kind, role,
843
851
  * Character and status (`removed` rows stay, so their elements keep `created_by`). Returns
844
- * the rows; keel sends them as `{ data }` with no paging. A world key reads its own world's
852
+ * the rows; the server sends them as `{ data }` with no paging. A world key reads its own world's
845
853
  * roster and sends no `world`. An account token reads the roster of the world the client's
846
854
  * `world` names (`world=<id>`, the Bearer token, no PIN), with the token's grant there: the
847
855
  * owner's token as the owner, a member's as its own member key; a world where it has none is a
@@ -1572,7 +1580,7 @@ var OwV2Client = class {
1572
1580
  * POST /account/worlds/{worldId}/links -- a new invite link for a world this client's
1573
1581
  * `ow_a_` token owns: `reader` is required (`person`, accepted with acceptJoin;
1574
1582
  * `agent`, redeemed at POST /join; `player`, a friend with no account, redeemed with
1575
- * redeemJoin for a read key); `role`, when left out, is keel's default: guest for a
1583
+ * redeemJoin for a read key); `role`, when left out, is the server's default: guest for a
1576
1584
  * person link, contributor for an agent link (a player link is guest, and refuses any other), `days` (1, 7 or 30) to 7; `withCharacter` (agent links
1577
1585
  * only) to true; `character` (player links only) a Character's id or `new` (the default):
1578
1586
  * whoever opens the link first reads as it, until removed. `preview` (person and player links)
@@ -1694,7 +1702,7 @@ var OwV2Client = class {
1694
1702
  }
1695
1703
  /**
1696
1704
  * PATCH /account/worlds/{worldId}/members/{memberId} with `lenses` alone -- set the lenses a row
1697
- * starts with: lens ids in order, 0 to 20, repeats dropped by keel; an empty list is a choice too,
1705
+ * starts with: lens ids in order, 0 to 20, repeats dropped by the server; an empty list is a choice too,
1698
1706
  * and keeps a seat off its Titles' lenses, while `null` puts the row back to never chosen (a seat
1699
1707
  * playing a Character then starts with its Titles' lenses; for `'owner'`, `null` is the empty list).
1700
1708
  * A member sets its own row (any role), an agent's or a player's seat it answers for (its sponsor),
@@ -2040,7 +2048,7 @@ var OwV2Client = class {
2040
2048
  // -- Ask your world -------------------------------------------
2041
2049
  /**
2042
2050
  * POST /account/ask -- a question about a world the account owns or is in, answered by
2043
- * keel's AI proxy from `context` only (build it with buildAskContext from the elements
2051
+ * onlyworlds.com's AI proxy from `context` only (build it with buildAskContext from the elements
2044
2052
  * the user sees; it leaves proposed, hidden and room elements out unless asked). The answer is "The world doesn't say." when the context does not hold
2045
2053
  * it. Needs the client's `ow_a_` token (a world key is a TypeError before sending).
2046
2054
  * Once the day's token rating is spent, an account that saved its own AI key on its account page is
@@ -2084,7 +2092,7 @@ var OwV2Client = class {
2084
2092
  }
2085
2093
  /**
2086
2094
  * GET /account/allowance -- the account's token rating, the one daily meter ask, sort and
2087
- * the Council spend from (keel 872431f): the rating, what is used and left today, and
2095
+ * the Council spend from: the rating, what is used and left today, and
2088
2096
  * when it resets (the next midnight UTC), and `own_key` (`{provider}` when the account saved its own
2089
2097
  * AI key, which ask and sort use once the rating is spent; else null). Spends nothing. Needs the
2090
2098
  * client's `ow_a_` token.
package/dist/waymark.js CHANGED
@@ -6,7 +6,7 @@ import {
6
6
  openersFor,
7
7
  refuseUnknownOptions,
8
8
  typeWord
9
- } from "./chunk-3W5DADHM.js";
9
+ } from "./chunk-BHO3TVAN.js";
10
10
 
11
11
  // src/waymark/glyphs.ts
12
12
  var MARK_PATH = "M48.8 0.0 43.8 0.4 39.0 1.2 36.0 2.0 33.2 2.9 29.3 4.5 24.8 6.8 20.6 9.5 17.0 12.4 13.6 15.7 10.4 19.4 7.8 23.1 5.8 26.6 4.5 29.3 3.3 32.1 1.8 36.8 0.8 41.2 0.1 46.3 0.0 51.1 0.4 56.2 1.2 61.0 2.0 63.9 2.9 66.8 4.5 70.7 6.8 75.2 9.5 79.4 12.4 82.9 15.7 86.3 19.4 89.5 23.1 92.1 26.6 94.2 29.3 95.5 32.1 96.7 36.8 98.2 41.2 99.2 46.3 99.8 51.1 100.0 56.2 99.6 61.0 98.8 63.9 98.0 66.8 97.1 70.7 95.5 75.2 93.2 79.4 90.4 82.9 87.6 86.3 84.3 89.5 80.5 92.1 76.9 94.2 73.4 95.5 70.7 96.7 67.9 98.2 63.2 99.2 58.7 99.8 53.7 100.0 48.8 99.6 43.8 98.6 38.4 97.1 33.2 95.5 29.3 93.2 24.8 90.4 20.6 87.6 17.0 84.3 13.6 80.5 10.4 76.9 7.8 73.4 5.8 70.7 4.5 67.9 3.3 63.2 1.8 58.7 0.8 53.7 0.1ZM77.5 80.7 74.1 83.4 70.7 85.7 67.0 87.5 64.5 88.6 64.1 88.7 65.7 86.3 67.1 83.9 68.7 80.7 69.9 77.6 72.7 78.5 73.0 78.4ZM22.5 80.7 25.6 79.0 27.3 78.3 30.0 77.6 31.3 80.7 32.8 83.9 34.2 86.3 35.9 88.7 32.9 87.5 29.3 85.7 25.8 83.4ZM51.2 74.5 55.1 74.7 59.9 75.2 64.2 76.0 67.5 76.9 66.0 80.5 64.2 84.0 62.0 87.4 59.6 90.1 55.1 90.9 52.2 91.2 51.2 91.1ZM48.7 74.5 48.8 91.1 47.7 91.2 44.9 90.9 40.3 90.1 38.2 87.8 36.3 85.0 34.2 81.2 32.5 77.0 35.8 76.0 40.5 75.2 44.5 74.7ZM91.1 51.2 91.1 52.9 90.8 56.3 90.1 59.7 89.3 62.5 88.5 64.8 87.2 67.7 85.7 70.7 83.9 73.4 82.0 75.9 79.4 78.9 76.3 77.2 73.8 76.1 76.2 68.8 77.8 62.7 78.7 56.8 79.0 51.2ZM55.8 51.2 67.7 51.2 67.6 55.1 67.2 59.0 66.7 61.5 65.7 65.0 61.0 64.2 55.7 63.6ZM32.5 51.2 44.5 51.2 44.4 63.6 39.7 64.1 34.5 65.0 33.5 61.3 32.9 58.1 32.5 54.2ZM8.8 51.2 21.0 51.2 21.0 53.3 21.4 56.6 22.7 64.0 23.8 68.4 25.0 72.1 26.6 75.9 23.7 77.2 20.6 78.9 18.5 76.7 16.5 74.1 14.8 71.5 13.4 69.1 12.1 66.3 11.0 63.6 10.1 60.5 9.4 57.3 8.9 53.5 8.8 51.3ZM36.2 27.0 39.5 27.5 44.5 28.2 44.4 48.8 32.4 48.7 32.8 44.5 33.6 39.1 35.0 32.0ZM63.9 26.9 65.2 32.1 66.6 39.2 67.4 44.8 67.7 48.7 55.8 48.8 55.7 28.1 60.5 27.5ZM74.8 23.4 76.9 22.5 79.4 21.1 82.0 24.0 84.8 27.8 86.2 30.3 87.5 32.9 88.6 35.4 89.5 38.1 90.3 41.2 90.8 44.0 91.1 47.0 91.1 48.8 79.0 48.7 78.7 44.6 78.0 39.3 76.5 31.2 74.7 23.5ZM25.5 23.5 25.5 23.7 24.5 26.8 23.7 30.2 22.4 36.6 21.5 42.5 21.1 48.7 8.8 48.8 8.8 47.0 9.2 43.7 9.8 40.8 10.5 38.1 11.5 35.2 12.4 32.9 13.8 30.2 15.2 27.8 17.9 24.0 20.6 21.1 23.1 22.5ZM64.1 11.3 67.0 12.4 70.7 14.3 74.1 16.5 77.5 19.3 75.6 20.3 73.2 21.5 70.0 22.6 68.7 19.2 67.1 16.1 65.7 13.6ZM35.9 11.3 34.2 13.6 32.8 16.1 31.3 19.2 30.0 22.5 27.9 21.9 26.4 21.3 22.5 19.3 25.8 16.5 29.3 14.3 32.9 12.4 35.4 11.4ZM51.2 8.8 52.2 8.8 55.1 9.0 59.6 9.9 61.7 12.2 64.2 16.0 66.0 19.5 67.6 23.3 64.3 24.3 59.4 25.2 56.2 25.6 51.2 25.5ZM48.8 8.8 48.7 25.5 44.2 25.6 40.6 25.2 36.4 24.5 32.4 23.2 33.9 19.5 35.7 16.0 38.2 12.2 40.3 9.9 44.9 9.0 47.7 8.8Z";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onlyworlds/sdk",
3
- "version": "4.132.1",
3
+ "version": "4.132.3",
4
4
  "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
5
5
  "type": "module",
6
6
  "exports": {