@onlyworlds/sdk 4.133.1 → 4.133.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/CHANGELOG.md +11 -0
- package/SCHEMA.md +1 -1
- package/dist/index.d.ts +14 -10
- package/dist/index.js +13 -9
- 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.34.0-dist.
|
|
3
|
+
**Current as of**: SDK **4.x** · schema-dist **v0.34.0-dist.109** (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,17 @@ earlier history lives in git log only.
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased]
|
|
7
7
|
|
|
8
|
+
## [4.133.2] - 2026-11-08
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- Schema repinned to schema-dist `v0.34.0-dist.109` (canonical 00.34.00 unchanged, no field moved). The calendar profile now refuses an era whose `year_base` is present and not 0 or 1, as its field table always said, and its fixture gains `refuse-year-base-five` (77 cases, 43 refusals). The calendar reader already refused such an era; the replayed fixture now holds it.
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
|
|
16
|
+
- `mintWorldKey`'s comment said that without `keep`, revoking the token takes the keys it minted. That holds for a token a tool got through Sign in with OnlyWorlds; a token from `signInWithPassword` or one made by hand never takes its keys, as `revokeAccountToken`'s comment already said. Words only.
|
|
17
|
+
- `createAccountWorld`'s comments said an account with a PIN must leave `pin` out (a 422) and that the route takes no Idempotency-Key. Since 2026-11-07 the server checks a `pin` sent by an account that has one before it makes the world (a wrong one is a 401 with `param: 'pin'`, nothing made) and takes an Idempotency-Key, whose replay answers the world without its key. The call is unchanged: it sends `pin` as given and no Idempotency-Key. Words only.
|
|
18
|
+
|
|
8
19
|
## [4.133.1] - 2026-11-06
|
|
9
20
|
|
|
10
21
|
### 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.
|
|
3
|
+
**Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.34.0-dist.109** — canonical schema **00.34.00**, published 2026-11-07.
|
|
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
|
@@ -3533,7 +3533,7 @@ interface OwAccountWorld {
|
|
|
3533
3533
|
interface OwCreateAccountWorldInput {
|
|
3534
3534
|
/** The world's name: 1 to 255 characters, not blank (keel trims it). */
|
|
3535
3535
|
name: string;
|
|
3536
|
-
/**
|
|
3536
|
+
/** The account PIN, 4 digits. An account with no PIN yet must send one (1000-9999), which becomes the account PIN; an account with a PIN may send it to have it checked before the world is made (wrong: 401 with `param: 'pin'`, nothing made), or leave it out. */
|
|
3537
3537
|
pin?: string | number;
|
|
3538
3538
|
/** A name for the world's write key, as the website's key list shows it: 1 to 80 characters, trimmed. Left out or null: no name. */
|
|
3539
3539
|
keyName?: string | null;
|
|
@@ -5108,18 +5108,20 @@ declare class OwV2Client {
|
|
|
5108
5108
|
listAccountWorlds(): Promise<OwAccountWorld[]>;
|
|
5109
5109
|
/**
|
|
5110
5110
|
* POST /account/worlds -- make a world on the account, with its one write key. `name` is required
|
|
5111
|
-
* (1 to 255 characters, not blank; keel trims it). `pin`
|
|
5112
|
-
*
|
|
5113
|
-
*
|
|
5114
|
-
*
|
|
5115
|
-
* `pin`
|
|
5111
|
+
* (1 to 255 characters, not blank; keel trims it). `pin` is the account PIN, 4 digits. An account
|
|
5112
|
+
* with no PIN must send one (1000-9999): it becomes the account PIN and the write wall on every
|
|
5113
|
+
* world of the account; left out, a 422 with `param: 'pin'` (`err.param`) and nothing made. An
|
|
5114
|
+
* account with a PIN may send it to have it checked before the world is made: a wrong one is a 401
|
|
5115
|
+
* `invalid_credentials` with `param: 'pin'` and nothing made, counted toward the same lockout as a
|
|
5116
|
+
* write's PIN (then 429 `rate_limited`); left out, the world takes the account's PIN. So a tool
|
|
5117
|
+
* that holds the person's PIN can always send it. `keyName` names the write key as the website's key
|
|
5116
5118
|
* list shows it (1 to 80 characters, trimmed; null or left out: no name). `source` and `producer`
|
|
5117
5119
|
* are the folder format's provenance lines (spec 4.2), each an object or null, from a tool that
|
|
5118
5120
|
* makes the world from a folder: kept on the World as given, served by getWorld() as `origin`.
|
|
5119
5121
|
* Only the keys given are sent, `keyName` as `key_name`. 201: the world's row, as
|
|
5120
|
-
* listAccountWorlds lists it, with the full write key once in `key`. Account token only
|
|
5121
|
-
* Idempotency-Key (keel
|
|
5122
|
-
* listAccountWorlds, and mintWorldKey gives it a key.
|
|
5122
|
+
* listAccountWorlds lists it, with the full write key once in `key`. Account token only. Sends no
|
|
5123
|
+
* Idempotency-Key (keel takes one since 2026-11-07, and a replay answers the world without `key`):
|
|
5124
|
+
* if the answer is lost, the world is in listAccountWorlds, and mintWorldKey gives it a key.
|
|
5123
5125
|
*/
|
|
5124
5126
|
createAccountWorld(opts: OwCreateAccountWorldInput): Promise<OwCreatedAccountWorld>;
|
|
5125
5127
|
/**
|
|
@@ -5131,7 +5133,9 @@ declare class OwV2Client {
|
|
|
5131
5133
|
* token only; no Idempotency-Key. `keep: true` keeps the key across a sign-out: revoking the token
|
|
5132
5134
|
* that minted it leaves it live (a tool that stores a key on the device passes it), while
|
|
5133
5135
|
* disconnecting the tool, or a replayed sign-in code, still takes it; the answer says `kept`.
|
|
5134
|
-
* Without it, revoking
|
|
5136
|
+
* Without it, revoking a token a tool got through Sign in with OnlyWorlds revokes the keys it minted,
|
|
5137
|
+
* unless the person holds another live token of the same tool; a token made by hand or by a password
|
|
5138
|
+
* sign-in (signInWithPassword), or one of a tool that asks each time, never takes its keys.
|
|
5135
5139
|
*/
|
|
5136
5140
|
mintWorldKey(worldId: string, opts?: {
|
|
5137
5141
|
scope?: 'read' | 'write';
|
package/dist/index.js
CHANGED
|
@@ -1903,18 +1903,20 @@ var OwV2Client = class {
|
|
|
1903
1903
|
}
|
|
1904
1904
|
/**
|
|
1905
1905
|
* POST /account/worlds -- make a world on the account, with its one write key. `name` is required
|
|
1906
|
-
* (1 to 255 characters, not blank; keel trims it). `pin`
|
|
1907
|
-
*
|
|
1908
|
-
*
|
|
1909
|
-
*
|
|
1910
|
-
* `pin`
|
|
1906
|
+
* (1 to 255 characters, not blank; keel trims it). `pin` is the account PIN, 4 digits. An account
|
|
1907
|
+
* with no PIN must send one (1000-9999): it becomes the account PIN and the write wall on every
|
|
1908
|
+
* world of the account; left out, a 422 with `param: 'pin'` (`err.param`) and nothing made. An
|
|
1909
|
+
* account with a PIN may send it to have it checked before the world is made: a wrong one is a 401
|
|
1910
|
+
* `invalid_credentials` with `param: 'pin'` and nothing made, counted toward the same lockout as a
|
|
1911
|
+
* write's PIN (then 429 `rate_limited`); left out, the world takes the account's PIN. So a tool
|
|
1912
|
+
* that holds the person's PIN can always send it. `keyName` names the write key as the website's key
|
|
1911
1913
|
* list shows it (1 to 80 characters, trimmed; null or left out: no name). `source` and `producer`
|
|
1912
1914
|
* are the folder format's provenance lines (spec 4.2), each an object or null, from a tool that
|
|
1913
1915
|
* makes the world from a folder: kept on the World as given, served by getWorld() as `origin`.
|
|
1914
1916
|
* Only the keys given are sent, `keyName` as `key_name`. 201: the world's row, as
|
|
1915
|
-
* listAccountWorlds lists it, with the full write key once in `key`. Account token only
|
|
1916
|
-
* Idempotency-Key (keel
|
|
1917
|
-
* listAccountWorlds, and mintWorldKey gives it a key.
|
|
1917
|
+
* listAccountWorlds lists it, with the full write key once in `key`. Account token only. Sends no
|
|
1918
|
+
* Idempotency-Key (keel takes one since 2026-11-07, and a replay answers the world without `key`):
|
|
1919
|
+
* if the answer is lost, the world is in listAccountWorlds, and mintWorldKey gives it a key.
|
|
1918
1920
|
*/
|
|
1919
1921
|
async createAccountWorld(opts) {
|
|
1920
1922
|
only("createAccountWorld", opts, ["name", "pin", "keyName", "source", "producer"]);
|
|
@@ -1940,7 +1942,9 @@ var OwV2Client = class {
|
|
|
1940
1942
|
* token only; no Idempotency-Key. `keep: true` keeps the key across a sign-out: revoking the token
|
|
1941
1943
|
* that minted it leaves it live (a tool that stores a key on the device passes it), while
|
|
1942
1944
|
* disconnecting the tool, or a replayed sign-in code, still takes it; the answer says `kept`.
|
|
1943
|
-
* Without it, revoking
|
|
1945
|
+
* Without it, revoking a token a tool got through Sign in with OnlyWorlds revokes the keys it minted,
|
|
1946
|
+
* unless the person holds another live token of the same tool; a token made by hand or by a password
|
|
1947
|
+
* sign-in (signInWithPassword), or one of a tool that asks each time, never takes its keys.
|
|
1944
1948
|
*/
|
|
1945
1949
|
async mintWorldKey(worldId, opts = {}) {
|
|
1946
1950
|
only("mintWorldKey", opts, ["scope", "name", "keep"]);
|