diff --git a/package-lock.json b/package-lock.json index f21711e9..db42de9c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "starlight-page-actions": "0.7.1" }, "devDependencies": { - "@onlyworlds/sdk": "4.172.0", + "@onlyworlds/sdk": "4.173.0", "typescript": "5.9.3" } }, @@ -1685,9 +1685,9 @@ } }, "node_modules/@onlyworlds/sdk": { - "version": "4.172.0", - "resolved": "https://registry.npmjs.org/@onlyworlds/sdk/-/sdk-4.172.0.tgz", - "integrity": "sha512-pzwyG76Ts8o8tEMuThnKBoMK9dn/b6NAhxnDoKDdIP6vzujRIrTUMeX7TBFkNkIp6uUwnqOFs+6eNEju5TPKoA==", + "version": "4.173.0", + "resolved": "https://registry.npmjs.org/@onlyworlds/sdk/-/sdk-4.173.0.tgz", + "integrity": "sha512-0BgYNTX1aUiuCmLn3324xqT9I8vGXvEJEqoS6zu5Q4rdenI1J1otg+Kpv3+TX+7DdcQSvr+qRPD0whZLTzxILg==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 06b27bd2..aad2ffbf 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "starlight-page-actions": "0.7.1" }, "devDependencies": { - "@onlyworlds/sdk": "4.172.0", + "@onlyworlds/sdk": "4.173.0", "typescript": "5.9.3" }, "overrides": { diff --git a/src/content/docs/docs/changelog.md b/src/content/docs/docs/changelog.md index 1b15cea4..18c244f9 100644 --- a/src/content/docs/docs/changelog.md +++ b/src/content/docs/docs/changelog.md @@ -9,6 +9,7 @@ What changed on onlyworlds.com for everyone is on its own [Changelog](https://ww ## 2026-11-16 +- **[What a saved 3D layout does not place](/docs/development/typescript-readers#a-world-laid-out-in-3d): TypeScript SDK 4.173.0 and [Python](/docs/development/python) 0.131.0.** `unplacedByLinks3d` and `unplaced_by_links_3d` answer the ids of the graph's nodes that a saved `by-links-3d` layout map has no Pin for. The method's shared fixture gains eight cases and a suite of eight for this reading; no point of the method moves. - **[Your seat list](/docs/development/agents#making-a-seat) says whether each seat may change its Character.** `GET /api/v2/account/worlds/{world_id}/seats` serves `may_change_character`, `may_change_character_note` and `follows_sponsor` on every row, in the words of the owner's [members list](/docs/development/api/members#agent-seats). Where a seat's Character is kept from you, the row reads `character` `null`, `may_change_character` `false` and no note. TypeScript SDK 4.172.0 types the three on `listSeats()`'s rows. - **[A world laid out in 3D](/docs/development/typescript-readers#a-world-laid-out-in-3d): TypeScript SDK 4.171.1 and [Python](/docs/development/python) 0.130.1.** A Map whose width or height is under 0 no longer stops the layout: a width or height that is not over 0 makes the Map no plate, and the world is laid out by its links. A layout that hands earlier points back no longer works out the push between two elements that both stand still, so keeping a picture still costs less than laying it out from nothing; no point of any answer changes. The page now says how to count what is new: by the ids you did not hand back. - **[A world laid out in 3D](/docs/development/typescript-readers#a-world-laid-out-in-3d): TypeScript SDK 4.171.0's `layoutByLinks3d` and [Python](/docs/development/python) 0.130.0's `layout_by_links_3d`.** One method in both packages lays a whole graph out in three dimensions by its links, with the world's map as a flat plate, and held points keep a picture still as the world grows. Its word, `by-links-3d`, is the tool's own until its page in the standard is published. diff --git a/src/content/docs/docs/development/python.md b/src/content/docs/docs/development/python.md index 67a81da9..9b98a05e 100644 --- a/src/content/docs/docs/development/python.md +++ b/src/content/docs/docs/development/python.md @@ -176,7 +176,7 @@ It is schema-dist's own [folder checker](/docs/schema/folders#rules-for-tools), - **The map-space profile** (since 0.104.0): `map_space(elements)` reads a world's Maps, Zones, Markers and Pins as the [map-space profile](/docs/schema/profiles#map-space) defines, from the elements as the reader is served them. It returns `{maps, zones, pins, out}`: each Map's frame (`width`, `height`, `depth`, `z_max`, `scale` in metres per pixel from `x_metres_per_pixel`, `location`, `parent_map`; a missing `width` or `height` is measured from the Map's own placed points, with `extent: "points"`), one outline per Map a Zone has Markers on (its points in `order`, then by id, with `shape` `polygon` or `line`), each Pin's point with its element as `element_type` and `element_id`, and `out`, what the reading left aside counted by `no_point`, `no_markers`, `dangling` and `no_map`, a reason with nothing counted absent. `z` is an elevation, never a height. A number counts when it is whole by value (`2.0` reads as 2; a boolean or a fraction is no point), and a row without an id is ignored; since 0.104.1 (serial 106) two rows of one type with one id read as the last one served. Types `MapSpace`, `MapSpaceMap`, `MapSpaceOutline` and `MapSpacePin`. The npm SDK's `mapSpace` answers the same. - **The layout of a map** (since 0.110.0): `layout_of(map, maps, pins)` answers `{"layout", "ground", "hand"}` from a Map's `x_layout` and its Pins' `x_hand`, the TypeScript SDK's [`layoutOf`](/docs/development/typescript-readers#the-layout-of-a-map) with the same answer: the method or `None`, the served ground Map's id or `None`, and the ids of the Pins a new lay-out keeps (`x_hand` exactly `True`, never `1`; every Pin of a `"hand"` board), in code point order. - **A world's default picture** (since 0.127.0): `layout_by_kind(graph)` and `layout_around(graph, focus, steps=1)`, the TypeScript SDK's [`layoutByKind` and `layoutAround`](/docs/development/typescript-readers#a-worlds-default-picture), the same points to the bit. Since 0.129.0, `unplaced_by_kind(graph, placed)` and `unplaced_around(graph, focus, placed, steps=1)` answer the ids a saved layout Map has no Pin for, the same lists as the SDK's; the methods and that reading are the standard's [default layouts profile](/docs/schema/profiles#default-layouts), whose fixture both packages replay. -- **A world laid out in 3D** (since 0.130.0): `layout_by_links_3d(graph, elements=None, *, held=None, held_unit=None)`, the TypeScript SDK's [`layoutByLinks3d`](/docs/development/typescript-readers#a-world-laid-out-in-3d) with the same answer: the same points to the bit for a centre, a grouped element and a pinned one, within a billionth of a rest for the rest. `points` is one flat list, x, y, z a node. It is plain Python, so a world of several thousand elements takes minutes. +- **A world laid out in 3D** (since 0.130.0): `layout_by_links_3d(graph, elements=None, *, held=None, held_unit=None)`, the TypeScript SDK's [`layoutByLinks3d`](/docs/development/typescript-readers#a-world-laid-out-in-3d) with the same answer: the same points to the bit for a centre, a grouped element and a pinned one, within a billionth of a rest for the rest. `points` is one flat list, x, y, z a node. It is plain Python, so a world of several thousand elements takes minutes. `unplaced_by_links_3d(graph, placed)` (since 0.131.0) answers what a saved `by-links-3d` layout map does not place, as `unplacedByLinks3d` does. - **A layout along a route** (since 0.108.0): `trail_by_place(input)` lays a world out along a route on a ground map, the TypeScript SDK's [`trailByPlace`](/docs/development/typescript-readers#a-layout-along-a-route) with the same input and the same answer: a Map frame and one Pin per element in the standard's own fields (so `map_space` reads it back), the route, and the recipe it ran with. You hand it the places in travel order and what hangs where; it places them. `TRAIL_TIERS` is the default floors. - **A world's own words** (since 0.30.0): `type_word(world, element_type, supertype=None, many=False)` gives the word a world's `x_names` map prints for a type (*Employee* for Character in a work world), or `None` for the standard's name; a supertype's own word wins over the type's. The [names profile](https://github.com/OnlyWorlds/schema-dist/blob/main/profiles/names.md), schema-dist serial 48; its 29 shared test cases (the fixture every reader of the profile passes) are the package's test. - **The spine profile** (since 0.44.0): `read_spine_element(element_type, element)` reads one element of a world that maps a software ecosystem and returns a `SpineRead`: its kind (the closed list's spelling, `off-list`, or `free` for a Character, Institution or Collective), each `x_spine_*` key as read or `None`, the audience's primary, the probe's verb or `unsupported`, and `dropped`, every value it left out, each as `{"key", "value"}` with the value as the element held it (since 0.44.1), and `retires`, the retired row's id from `x_spine_retires` as given, on whatever element carries it (since 0.50.0; whether it sits on a Retirement Event and names a row is the doctor's to check). Trimmed and case-blind as the room profile defines it. `SPINE_KINDS` is the closed list. The [spine profile](https://github.com/OnlyWorlds/schema-dist/blob/main/profiles/spine.md), schema-dist serial 61; its 46 fixture cases are the package's test. The calendar the profile ships is checked with `onlyworlds.calendar` (since 0.68.0). diff --git a/src/content/docs/docs/development/typescript-readers.md b/src/content/docs/docs/development/typescript-readers.md index e3339713..bbdd8254 100644 --- a/src/content/docs/docs/development/typescript-readers.md +++ b/src/content/docs/docs/development/typescript-readers.md @@ -229,6 +229,8 @@ layout.points; // Float64Array: x, y, z of layout.ids[i] at 3 * i layout.centres; // the ids of the most linked elements, each the centre of a group ``` +`unplacedByLinks3d(graph, placed)` (since 4.173.0) answers what a saved `by-links-3d` layout map does not place: the ids of the graph's nodes that are not in `placed`, by id in code point order. The method places every node it is handed, of any type and with or without a link, so nothing else is left out. `placed` is the ids the Map's Pins stand for, a list or a Set, read as `unplacedByKind` reads it. + ## A layout along a route `trailByPlace(input)` lays a world out along a route on a ground map and answers a layout in the standard's own fields: a Map frame (`width`, `height`, `depth`) and one Pin per element, whole numbers in the Map's pixels, so `mapSpace` reads it back. It places and does not read: you hand it which elements are in, the order of travel and what hangs where, and it answers the same points for the same input. diff --git a/src/content/docs/docs/development/typescript.md b/src/content/docs/docs/development/typescript.md index 034ed3ee..a4ecf6c6 100644 --- a/src/content/docs/docs/development/typescript.md +++ b/src/content/docs/docs/development/typescript.md @@ -395,7 +395,7 @@ The package also ships `SCHEMA.md` (every field and its meaning, generated) and ## Reference -Generated from the types of `@onlyworlds/sdk` 4.172.0, the version these docs pin. The full declarations ship in the package (`dist/index.d.ts`), with `SCHEMA.md` and `AGENTS.md` beside them. +Generated from the types of `@onlyworlds/sdk` 4.173.0, the version these docs pin. The full declarations ship in the package (`dist/index.d.ts`), with `SCHEMA.md` and `AGENTS.md` beside them. ### Client options