@onlyworlds/sdk 4.34.0 → 4.35.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ earlier history lives in git log only.
 
 ## [Unreleased]
 
+## [4.35.0] - 2026-10-20
+
+### Added
+
+- **`createWorldLink(worldId, { preview })`** and `preview` on `OwWorldLink` (keel #422 PR 1, 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.
+
 ## [4.34.0] - 2026-10-20
 
 ### Added

package/dist/index.d.ts

@@ -2249,6 +2249,8 @@ interface OwWorldLink {
     /** 0 or 1: a link works once. */
     uses: number;
     status: 'pending' | 'used' | 'revoked' | 'expired';
+    /** Whether the link shows the world's name and picture when it is pasted into a chat (keel #422): then the link is `/join/<world_id>#<code>`, else `/join#<code>`. Never on an agent link. */
+    preview?: boolean;
     /** A player link only: the Character the player reads as; null while a link for a fresh Character is unused. `name` is null if that Character was deleted (the redeem then makes a fresh one). */
     character?: {
         id: string;
@@ -2260,7 +2262,7 @@ interface OwWorldLink {
 interface OwCreatedWorldLink extends OwWorldLink {
     /** The `ow_j_` join code. Shown once; it can never be read again. */
     code: string;
-    /** The invite link: the /join page with the code after `#`. */
+    /** The invite link: the /join page (`/join/<world_id>` when `preview` is on) with the code after `#`. */
     link: string;
     /** The one line to send: who invites, to which world, and the link. */
     line: string;
@@ -3142,7 +3144,10 @@ declare class OwV2Client {
      * redeemJoin for a read key, keel #353); `role`, when left out, is keel's default: guest for a
      * 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
      * only) to true; `character` (player links only) a Character's id or `new` (the default):
-     * whoever opens the link first reads as it, until removed. 201 with the code, shown in this
+     * whoever opens the link first reads as it, until removed. `preview` (person and player links,
+     * keel #422) to false: true puts the world's id in the link's path, so a chat that unfurls it
+     * shows the world's name and picture (the code stays after `#`); true on an agent link is
+     * 422, param `preview`. 201 with the code, shown in this
      * answer only. Owner only: anyone else, and a world that doesn't exist, gets 404
      * `not_found` (`err.isNotFound`). A world key is a TypeError before anything is sent.
      */
@@ -3153,6 +3158,7 @@ declare class OwV2Client {
         inviterName?: string;
         withCharacter?: boolean;
         character?: string;
+        preview?: boolean;
     }): Promise<OwCreatedWorldLink>;
     /**
      * GET /account/worlds/{worldId}/links -- the world's invite links, without their codes:

package/dist/index.js

@@ -902,7 +902,10 @@ var OwV2Client = class {
    * redeemJoin for a read key, keel #353); `role`, when left out, is keel's default: guest for a
    * 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
    * only) to true; `character` (player links only) a Character's id or `new` (the default):
-   * whoever opens the link first reads as it, until removed. 201 with the code, shown in this
+   * whoever opens the link first reads as it, until removed. `preview` (person and player links,
+   * keel #422) to false: true puts the world's id in the link's path, so a chat that unfurls it
+   * shows the world's name and picture (the code stays after `#`); true on an agent link is
+   * 422, param `preview`. 201 with the code, shown in this
    * answer only. Owner only: anyone else, and a world that doesn't exist, gets 404
    * `not_found` (`err.isNotFound`). A world key is a TypeError before anything is sent.
    */
@@ -916,6 +919,7 @@ var OwV2Client = class {
     if (opts.inviterName !== void 0) body.inviter_name = opts.inviterName;
     if (opts.withCharacter !== void 0) body.with_character = opts.withCharacter;
     if (opts.character !== void 0) body.character = opts.character;
+    if (opts.preview !== void 0) body.preview = opts.preview;
     return this.request("POST", `/account/worlds/${encodeURIComponent(worldId)}/links`, { body });
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlyworlds/sdk",
-  "version": "4.34.0",
+  "version": "4.35.0",
   "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
   "type": "module",
   "exports": {