@onlyworlds/sdk 4.7.1 → 4.7.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 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.30.2-dist.16** (canonical 00.30.02).
3
+ **Current as of**: SDK **4.x** · schema-dist **v0.31.0-dist.18** (canonical 00.31.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,19 @@ earlier history lives in git log only.
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [4.7.2] — 2026-10-09
9
+
10
+ ### Changed
11
+ - **README first run** finds Admiral Fluffington by name (the demo world's default list order moves with every edit, so "the first three" could not be promised); the npm page shows the corrected output.
12
+ - **Schema repinned `v0.30.2-dist.16` → `v0.31.0-dist.18`** (canonical **00.31.00**).
13
+ `ONLYWORLDS_VERSION` is now `'00.31.00'`. The World gains three optional free-text settings,
14
+ `length_unit`, `mass_unit` and `distance_unit`; the nine element fields that promised "world
15
+ LENGTH / MASS / DISTANCE units" now name them in their descriptions (Ability `range`, Character
16
+ and Creature `height` and `weight`, Creature `speed`, Location `elevation`, Object and Species
17
+ `weight`). No element field shape and no `FIELD_SCHEMA` entry changed. The world body is not
18
+ typed per field (`OwWorldMeta` is open), so `getWorld` returns the three keys and `patchWorld`
19
+ sends them with no code change; a test says so.
20
+
8
21
  ## [4.7.1] — 2026-10-08
9
22
 
10
23
  ### Changed
package/README.md CHANGED
@@ -20,15 +20,13 @@ import { OwV2Client } from '@onlyworlds/sdk';
20
20
 
21
21
  const client = new OwV2Client({ apiKey: '0000000001' });
22
22
  console.log((await client.getWorld()).name);
23
- const { data } = await client.list('character', { limit: 3 });
23
+ const { data } = await client.list('character', { filter: { name__icontains: 'fluffington' } });
24
24
  for (const c of data) console.log(' ', c.name);
25
25
  ```
26
26
 
27
27
  ```
28
28
  Moppetopia
29
- Admiral Splashworth
30
29
  Admiral Fluffington
31
- Captain Snoot
32
30
  ```
33
31
 
34
32
  ## Your own world
package/SCHEMA.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OnlyWorlds Schema Reference
2
2
 
3
- **Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.30.2-dist.16** — canonical schema **00.30.02**, published 2026-10-08.
3
+ **Source**: https://github.com/OnlyWorlds/schema-dist @ **v0.31.0-dist.18** — canonical schema **00.31.00**, published 2026-10-09.
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.
@@ -24,7 +24,7 @@ Families (colour semantics; icon carries the type): agents · world · abstract
24
24
  - `activation` (text) — Method or conditions under which the ability is activated
25
25
  - `duration` (integer) — Length of time the ability remains active or its effects persist, measured in TIME units
26
26
  - `potency` (integer) — Relative measure of the ability's inherent potency or force, used for scaling or comparison purposes
27
- - `range` (integer) — Effective reach or distance at which the ability can be used, measured in DISTANCE units
27
+ - `range` (integer) — Effective reach or distance at which the ability can be used, in the world's distance unit (World distance_unit)
28
28
  - `effects` (multi link → phenomenon) — Phenomena that result from the ability's use, such as environmental changes or sensory effects
29
29
  - `challenges` (text) — Describes specific difficulties or constraints that make the ability hard to master or use effectively
30
30
  - `talents` (multi link → trait) — Traits that naturally enhance or improve performance with this ability
@@ -47,8 +47,8 @@ Families (colour semantics; icon carries the type): agents · world · abstract
47
47
 
48
48
  - `physicality` (text) — The character's visible physical features and body attributes
49
49
  - `mentality` (text) — The character's mindset, emotional tone, and style of thinking
50
- - `height` (integer) — The character's approximate or exact height, using world LENGTH units
51
- - `weight` (integer) — The character's approximate or exact weight, using world MASS units
50
+ - `height` (integer) — The character's approximate or exact height, in the world's length unit (World length_unit)
51
+ - `weight` (integer) — The character's approximate or exact weight, in the world's mass unit (World mass_unit)
52
52
  - `species` (multi link → species) — Species the character might belong to
53
53
  - `traits` (multi link → trait) — Traits for notable behavioral, physical, or systemic characteristics
54
54
  - `abilities` (multi link → ability) — Abilities the character might perform, control, or invoke
@@ -164,8 +164,8 @@ Families (colour semantics; icon carries the type): agents · world · abstract
164
164
  ### Biology
165
165
 
166
166
  - `appearance` (text) — Visual description of the creature
167
- - `weight` (integer) — Approximate or exact weight of the creature, using world MASS units
168
- - `height` (integer) — Approximate height of the creature, using the world's defined LENGTH units
167
+ - `weight` (integer) — Approximate or exact weight of the creature, in the world's mass unit (World mass_unit)
168
+ - `height` (integer) — Approximate height of the creature, in the world's length unit (World length_unit)
169
169
  - `species` (multi link → species) — Species this creature belongs to
170
170
 
171
171
  ### Behavior
@@ -188,7 +188,7 @@ Families (colour semantics; icon carries the type): agents · world · abstract
188
188
  - `challenge_rating` (integer) — Difficulty or threat level of the creature in a gameplay context
189
189
  - `hit_points` (integer) — Total health or durability value in combat
190
190
  - `armor_class` (integer) — Defense rating against physical attacks or effects
191
- - `speed` (integer) — Typical movement speed, measured in the world's DISTANCE unit per round
191
+ - `speed` (integer) — Typical movement speed, in the world's distance unit (World distance_unit) per round
192
192
  - `actions` (multi link → ability) — Combat or tactical abilities the creature can perform or use
193
193
 
194
194
 
@@ -359,7 +359,7 @@ Families (colour semantics; icon carries the type): agents · world · abstract
359
359
  ### Defense
360
360
 
361
361
  - `defensibility` (text) — Qualities of natural, constructed, and implemented defenses at the location
362
- - `elevation` (integer) — Height or elevation of the location relative to surrounding terrain, defined in world DISTANCE units
362
+ - `elevation` (integer) — Height or elevation of the location relative to surrounding terrain, in the world's distance unit (World distance_unit)
363
363
  - `fighters` (multi link → construct) — Military units or forces responsible for defending the location
364
364
  - `defensive_objects` (multi link → object) — Objects or installations for defending the location
365
365
 
@@ -435,7 +435,7 @@ Families (colour semantics; icon carries the type): agents · world · abstract
435
435
  ### Form
436
436
 
437
437
  - `aesthetics` (text) — Appearance, design, or visual presentation of the object
438
- - `weight` (integer) — Approximate or exact mass of the object, defined by world MASS units
438
+ - `weight` (integer) — Approximate or exact mass of the object, in the world's mass unit (World mass_unit)
439
439
  - `amount` (integer) — The number of identical units in this object entry
440
440
  - `parent_object` (single link → object) — Larger object that this one is part of or contained within
441
441
  - `materials` (multi link → construct) — The physical matter that constitutes the object
@@ -527,7 +527,7 @@ Families (colour semantics; icon carries the type): agents · world · abstract
527
527
 
528
528
  - `appearance` (text) — Typical physical or form features of the species
529
529
  - `life_span` (integer) — Average or typical life expectancy of an individual, defined in world TIME units
530
- - `weight` (integer) — Average or typical adult weight, defined in world MASS units
530
+ - `weight` (integer) — Average or typical adult weight, in the world's mass unit (World mass_unit)
531
531
  - `nourishment` (multi link → species) — Other species consumed as food sources
532
532
  - `reproduction` (multi link → construct) — Reproductive method(s) of the species
533
533
  - `adaptations` (multi link → ability) — Special physiological or evolutionary abilities
package/dist/index.d.ts CHANGED
@@ -33,7 +33,7 @@ type ElementType = 'ability' | 'character' | 'collective' | 'construct' | 'creat
33
33
  declare const ELEMENT_TYPES: ElementType[];
34
34
  /** Canonical OnlyWorlds schema version. Source: the `canonical:` value of the pinned
35
35
  * distribution's VERSION file (see the provenance block at the top of this file). */
36
- declare const ONLYWORLDS_VERSION: "00.30.02";
36
+ declare const ONLYWORLDS_VERSION: "00.31.00";
37
37
  /** The four semantic families (colour carries the family; ELEMENT_ICONS carries the type). */
38
38
  type ElementFamily = 'agents' | 'world' | 'abstract' | 'temporal';
39
39
  /** Per-type semantic family. Source: the distribution's `presentation.json` sidecar
package/dist/index.js CHANGED
@@ -433,7 +433,7 @@ function buildQuery(params) {
433
433
 
434
434
  // src/v2/types.generated.ts
435
435
  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"];
436
- var ONLYWORLDS_VERSION = "00.30.02";
436
+ var ONLYWORLDS_VERSION = "00.31.00";
437
437
  var ELEMENT_FAMILIES = {
438
438
  ability: "abstract",
439
439
  character: "agents",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onlyworlds/sdk",
3
- "version": "4.7.1",
3
+ "version": "4.7.2",
4
4
  "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
5
5
  "type": "module",
6
6
  "exports": {