@onlyworlds/sdk 4.23.0 → 4.24.0

package/CHANGELOG.md

@@ -5,6 +5,25 @@ earlier history lives in git log only.
 
 ## [Unreleased]
 
+## [4.24.0] — 2026-10-15
+
+### Added
+- **A world's invite links** (keel C1, 48c10d4), on the owner's account token (`ow_a_`):
+  `createWorldLink(worldId, { reader, role?, days?, inviterName?, withCharacter? })` answers the
+  new link with its `code`, `link` and the one `line` to send (the code is in this answer only:
+  keel keeps a hash); `listWorldLinks(worldId)` the links without codes, each with its `status`
+  and `uses`; `revokeWorldLink(worldId, linkId)`. Types `OwWorldLink`, `OwCreatedWorldLink`. A
+  non-owner, and a world that doesn't exist, get 404; a world key is a TypeError before sending.
+  For Lantern's Invite someone (Temper, h29 #5152).
+
+### Changed
+- `acceptJoin`'s doc comment and the README: accepting needs no account PIN for any role (keel
+  #297, ed73c90), so its refusals are 404 and 409 `already_member`; `pin_required` now belongs to
+  minting a write key for the membership. `isPinRequired` stays.
+- Doc comments say "token rating" for the account's daily budget (`ask`, `sort`, `allowance`,
+  `OwAllowance`, the answers' `token_rating`), as the README did in 4.23.0; the docs site's
+  generated reference reads them. No code change.
+
 ## [4.23.0] — 2026-10-14
 
 ### Deprecated

package/README.md

@@ -119,7 +119,18 @@ const invite = await client.previewJoin(code);   // who invites, which world, wh
 const membership = await account.acceptJoin(code); // account = a client with an ow_a_ token
 ```
 
-A bad code (unknown, used, revoked, expired) is one 404 (`err.isNotFound`). Accepting can answer `err.isAlreadyMember` or `err.isPinRequired` (set a PIN first); a refusal never uses up the code.
+A bad code (unknown, used, revoked, expired) is one 404 (`err.isNotFound`). Accepting can answer `err.isAlreadyMember`; it needs no account PIN, though a write key for the new membership waits for one. A refusal never uses up the code.
+
+The owner makes, lists and revokes the links with the account token (since 4.24.0). The code comes back once, in the answer that makes it:
+
+```typescript
+const made = await account.createWorldLink(worldId, { reader: 'person', role: 'contributor', days: 7 });
+// made.line: the one line to send (who invites, to which world, the link); made.code: the ow_j_ code
+const links = await account.listWorldLinks(worldId);  // no codes: status pending | used | revoked | expired
+await account.revokeWorldLink(worldId, made.id);
+```
+
+`reader: 'agent'` makes a link an AI agent redeems for a seat instead. Anyone but the owner gets a 404.
 
 Once in, a world key can ask who it is and who else is there (since 4.22.0):
 

package/dist/index.d.ts

@@ -2014,7 +2014,7 @@ interface OwAskAnswer {
     remaining: number;
     /** The account's tokens left today after this call (since keel a6244db, 2026-10-14). */
     tokens_remaining: number;
-    /** The account's daily allowance in tokens, one meter with the Council (since keel a6244db). */
+    /** The account's token rating: its daily budget in tokens, one meter with the Council (since keel a6244db). */
     token_rating: number;
     [k: string]: unknown;
 }
@@ -2096,11 +2096,11 @@ interface OwSortAnswer {
         output_tokens: number;
     };
     /** How many more calls of this one's size fit in what the account has left today; ask and
-     *  sort spend from one allowance. */
+     *  sort spend from one token rating. */
     remaining: number;
     /** The account's tokens left today after this call (since keel a6244db, 2026-10-14). */
     tokens_remaining: number;
-    /** The account's daily allowance in tokens, one meter with the Council (since keel a6244db). */
+    /** The account's token rating: its daily budget in tokens, one meter with the Council (since keel a6244db). */
     token_rating: number;
     [k: string]: unknown;
 }
@@ -2135,15 +2135,15 @@ interface OwMember {
     name?: string;
     [k: string]: unknown;
 }
-/** GET /account/allowance: the account's daily AI allowance (keel 872431f, 2026-10-14). */
+/** GET /account/allowance: the account's token rating and what is left of it today (keel 872431f, 2026-10-14). */
 interface OwAllowance {
-    /** The account's daily allowance in tokens. */
+    /** The account's token rating: its daily budget in tokens. */
     token_rating: number;
     /** Tokens spent today (UTC); may pass the rating by the size of the last call. */
     tokens_used_today: number;
     /** Tokens left today, never below 0. */
     tokens_remaining: number;
-    /** When the allowance resets: the next midnight UTC (ISO 8601). */
+    /** When the day's tokens reset: the next midnight UTC (ISO 8601). */
     resets_at: string;
     [k: string]: unknown;
 }
@@ -2166,6 +2166,39 @@ interface OwJoinPreview {
     expires_at: string;
     [k: string]: unknown;
 }
+/** One of a world's invite links, as GET /account/worlds/{id}/links lists it (keel C1, 48c10d4). */
+interface OwWorldLink {
+    /** The link's id: revokeWorldLink takes it. */
+    id: string;
+    /** `person`: accepted signed in, with acceptJoin. `agent`: redeemed by an AI agent at POST /join. */
+    reader: 'person' | 'agent';
+    role: OwMemberRole;
+    /** The name the owner gave an agent link on the website, or empty. */
+    label: string;
+    /** The name the link is signed with, or empty (the invite line then reads "Someone"). */
+    inviter_name: string;
+    /** Whether redeeming gives the agent a Character of its own. Always false on a person link. */
+    with_character: boolean;
+    /** The code's last four characters, to tell links apart. */
+    last4: string;
+    /** ISO 8601, UTC. */
+    created_at: string;
+    /** ISO 8601, UTC. */
+    expires_at: string;
+    /** 0 or 1: a link works once. */
+    uses: number;
+    status: 'pending' | 'used' | 'revoked' | 'expired';
+    [k: string]: unknown;
+}
+/** POST /account/worlds/{id}/links: the new link, with its code. The code is in this answer only: keel keeps a hash. */
+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 `#`. */
+    link: string;
+    /** The one line to send: who invites, to which world, and the link. */
+    line: string;
+}
 /** POST /account/join: the new membership (the same row as accepting an email invite). */
 interface OwJoinedMembership {
     /** The membership's id. */
@@ -2612,18 +2645,46 @@ declare class OwV2Client {
     /**
      * POST /account/join -- accept an invite link's code as the account this client's
      * `ow_a_` token belongs to: 201 with the new membership. Refusals: 404 `not_found`
-     * (every bad code, and a code made for an AI agent), 409 `already_member`
-     * (`err.isAlreadyMember`) and 409 `pin_required` (`err.isPinRequired`: the account
-     * has no PIN yet). A refusal never spends the code. A world key here is a TypeError
-     * before anything is sent.
+     * (every bad code, and a code made for an AI agent) and 409 `already_member`
+     * (`err.isAlreadyMember`). Accepting needs no account PIN, for any role (keel #297,
+     * ed73c90); a write key for the membership waits for one (`pin_required`). A refusal
+     * never spends the code. A world key here is a TypeError before anything is sent.
      */
     acceptJoin(code: string): Promise<OwJoinedMembership>;
+    /**
+     * POST /account/worlds/{worldId}/links -- a new invite link for a world this client's
+     * `ow_a_` token owns (keel C1): `reader` is required (`person`, accepted with acceptJoin;
+     * `agent`, redeemed at POST /join); `role` defaults to contributor, `days` (1, 7 or 30)
+     * to 7; `withCharacter` (agent links only) to true. 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.
+     */
+    createWorldLink(worldId: string, opts: {
+        reader: 'person' | 'agent';
+        role?: OwMemberRole;
+        days?: 1 | 7 | 30;
+        inviterName?: string;
+        withCharacter?: boolean;
+    }): Promise<OwCreatedWorldLink>;
+    /**
+     * GET /account/worlds/{worldId}/links -- the world's invite links, without their codes:
+     * each with its status (pending, used, revoked or expired) and uses. Owner only, as
+     * createWorldLink. Needs the client's `ow_a_` token.
+     */
+    listWorldLinks(worldId: string): Promise<OwWorldLink[]>;
+    /**
+     * DELETE /account/worlds/{worldId}/links/{linkId} -- revoke a link: its code no longer
+     * works. A used, revoked or expired link answers the same and stays as it was; whoever
+     * joined with it stays a member (remove them from the roster). Owner only, as
+     * createWorldLink. Needs the client's `ow_a_` token.
+     */
+    revokeWorldLink(worldId: string, linkId: string): Promise<void>;
     /**
      * POST /account/ask -- a question about a world the account owns or is in, answered by
      * keel's AI proxy from `context` only (build it with buildAskContext from the elements
      * the user sees). The answer is "The world doesn't say." when the context does not hold
      * it. Needs the client's `ow_a_` token (a world key is a TypeError before sending).
-     * Refusals: 429 `quota_exceeded` (`err.isQuotaExceeded`, the account's daily allowance;
+     * Refusals: 429 `quota_exceeded` (`err.isQuotaExceeded`, the account's token rating used up for the day;
      * Retry-After runs to midnight UTC), 503 `ask_unavailable` (`err.isAskUnavailable`:
      * switched off, or paused for the day), 502 `ask_failed` (`err.isAskFailed`); none of
      * them counts. 422 for a question over 500 characters or context past its limits.
@@ -2639,7 +2700,7 @@ declare class OwV2Client {
      * lookupWorld's hits), sorted by the same proxy as ask into rows to review: `make`, `add_to`,
      * `link`, `ask`. Nothing is written; the app applies what the user accepts. Every id in a
      * row is from the slice; keel moves any other row to `not_proposed` with its reason.
-     * The same account token, allowance (it spends the tokens it uses) and refusals as ask. 422
+     * The same account token, token rating (it spends the tokens it uses) and refusals as ask. 422
      * names the param: notes 1 to 8, each up to 4,000 characters and 16,000 in all (text
      * only), at most four pictures, each uploaded into this world; slice up to 100, names up
      * to 200 characters, anchors up to 120.
@@ -2650,7 +2711,7 @@ declare class OwV2Client {
         slice: OwSortRef[];
     }): Promise<OwSortAnswer>;
     /**
-     * GET /account/allowance -- the account's daily AI allowance, the one meter ask, sort and
+     * GET /account/allowance -- the account's token rating, the one daily meter ask, sort and
      * the Council spend from (keel 872431f): the rating, what is used and left today, and
      * when it resets (the next midnight UTC). Spends nothing. Needs the client's `ow_a_` token.
      */
@@ -3617,4 +3678,4 @@ declare class TokenResource {
     getEncryptionInfo(): Promise<EncryptionInfo>;
 }
 
-export { ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, ELEMENT_FAMILIES, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_SCHEMA, type FieldInfo, type FieldType, GameTier, type ListParams, ONLYWORLDS_VERSION, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangesPage, type OwClientConfig, type OwElement, type OwElementBase, type OwErrorBody, type OwJoinPreview, type OwJoinedMembership, type OwKeyKind, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberRole, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, OwPreconditionFailedError, type OwPreparedPhoto, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, type OwUploadedImage, OwV2Client, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldIndex, type OwWorldMeta, PHOTO_MAX_BYTES, PHOTO_TYPES, type ParseError, type ParseOptions, type ParseResult, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, type SectionInfo, type StepBreakdown, type TokenConsumeParams, type TokenConsumeResponse, TokenResource, type TokenStatus, type TokenTransport, WORLD_FILE_MAX_BYTES, WORLD_FILE_MAX_ENTRIES, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, isDemoKey, isLeapYear, isParseError, kindCanWrite, lookupWorld, monthStartSteps, parseDate, parseErrorEnvelope, pinExpectation, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readWorldFile, renderElement, resolveCalendarLens, resolveEraDomains, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
+export { ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, ELEMENT_FAMILIES, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_SCHEMA, type FieldInfo, type FieldType, GameTier, type ListParams, ONLYWORLDS_VERSION, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangesPage, type OwClientConfig, type OwCreatedWorldLink, type OwElement, type OwElementBase, type OwErrorBody, type OwJoinPreview, type OwJoinedMembership, type OwKeyKind, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberRole, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, OwPreconditionFailedError, type OwPreparedPhoto, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, type OwUploadedImage, OwV2Client, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, PHOTO_MAX_BYTES, PHOTO_TYPES, type ParseError, type ParseOptions, type ParseResult, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, type SectionInfo, type StepBreakdown, type TokenConsumeParams, type TokenConsumeResponse, TokenResource, type TokenStatus, type TokenTransport, WORLD_FILE_MAX_BYTES, WORLD_FILE_MAX_ENTRIES, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, isDemoKey, isLeapYear, isParseError, kindCanWrite, lookupWorld, monthStartSteps, parseDate, parseErrorEnvelope, pinExpectation, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readWorldFile, renderElement, resolveCalendarLens, resolveEraDomains, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };

package/dist/index.js

@@ -489,10 +489,10 @@ var OwV2Client = class {
   /**
    * POST /account/join -- accept an invite link's code as the account this client's
    * `ow_a_` token belongs to: 201 with the new membership. Refusals: 404 `not_found`
-   * (every bad code, and a code made for an AI agent), 409 `already_member`
-   * (`err.isAlreadyMember`) and 409 `pin_required` (`err.isPinRequired`: the account
-   * has no PIN yet). A refusal never spends the code. A world key here is a TypeError
-   * before anything is sent.
+   * (every bad code, and a code made for an AI agent) and 409 `already_member`
+   * (`err.isAlreadyMember`). Accepting needs no account PIN, for any role (keel #297,
+   * ed73c90); a write key for the membership waits for one (`pin_required`). A refusal
+   * never spends the code. A world key here is a TypeError before anything is sent.
    */
   async acceptJoin(code) {
     if (this.keyKind !== "account") {
@@ -500,13 +500,56 @@ var OwV2Client = class {
     }
     return this.request("POST", "/account/join", { body: { code } });
   }
+  /**
+   * POST /account/worlds/{worldId}/links -- a new invite link for a world this client's
+   * `ow_a_` token owns (keel C1): `reader` is required (`person`, accepted with acceptJoin;
+   * `agent`, redeemed at POST /join); `role` defaults to contributor, `days` (1, 7 or 30)
+   * to 7; `withCharacter` (agent links only) to true. 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.
+   */
+  async createWorldLink(worldId, opts) {
+    if (this.keyKind !== "account") {
+      throw new TypeError("createWorldLink needs an account token (ow_a_): only the world's owner makes links");
+    }
+    const body = { reader: opts.reader };
+    if (opts.role !== void 0) body.role = opts.role;
+    if (opts.days !== void 0) body.days = opts.days;
+    if (opts.inviterName !== void 0) body.inviter_name = opts.inviterName;
+    if (opts.withCharacter !== void 0) body.with_character = opts.withCharacter;
+    return this.request("POST", `/account/worlds/${encodeURIComponent(worldId)}/links`, { body });
+  }
+  /**
+   * GET /account/worlds/{worldId}/links -- the world's invite links, without their codes:
+   * each with its status (pending, used, revoked or expired) and uses. Owner only, as
+   * createWorldLink. Needs the client's `ow_a_` token.
+   */
+  async listWorldLinks(worldId) {
+    if (this.keyKind !== "account") {
+      throw new TypeError("listWorldLinks needs an account token (ow_a_): only the world's owner sees its links");
+    }
+    const page = await this.request("GET", `/account/worlds/${encodeURIComponent(worldId)}/links`);
+    return page.data;
+  }
+  /**
+   * DELETE /account/worlds/{worldId}/links/{linkId} -- revoke a link: its code no longer
+   * works. A used, revoked or expired link answers the same and stays as it was; whoever
+   * joined with it stays a member (remove them from the roster). Owner only, as
+   * createWorldLink. Needs the client's `ow_a_` token.
+   */
+  async revokeWorldLink(worldId, linkId) {
+    if (this.keyKind !== "account") {
+      throw new TypeError("revokeWorldLink needs an account token (ow_a_): only the world's owner revokes links");
+    }
+    await this.request("DELETE", `/account/worlds/${encodeURIComponent(worldId)}/links/${encodeURIComponent(linkId)}`);
+  }
   // -- Ask your world (keel #159) -------------------------------------------
   /**
    * POST /account/ask -- a question about a world the account owns or is in, answered by
    * keel's AI proxy from `context` only (build it with buildAskContext from the elements
    * the user sees). The answer is "The world doesn't say." when the context does not hold
    * it. Needs the client's `ow_a_` token (a world key is a TypeError before sending).
-   * Refusals: 429 `quota_exceeded` (`err.isQuotaExceeded`, the account's daily allowance;
+   * Refusals: 429 `quota_exceeded` (`err.isQuotaExceeded`, the account's token rating used up for the day;
    * Retry-After runs to midnight UTC), 503 `ask_unavailable` (`err.isAskUnavailable`:
    * switched off, or paused for the day), 502 `ask_failed` (`err.isAskFailed`); none of
    * them counts. 422 for a question over 500 characters or context past its limits.
@@ -525,7 +568,7 @@ var OwV2Client = class {
    * lookupWorld's hits), sorted by the same proxy as ask into rows to review: `make`, `add_to`,
    * `link`, `ask`. Nothing is written; the app applies what the user accepts. Every id in a
    * row is from the slice; keel moves any other row to `not_proposed` with its reason.
-   * The same account token, allowance (it spends the tokens it uses) and refusals as ask. 422
+   * The same account token, token rating (it spends the tokens it uses) and refusals as ask. 422
    * names the param: notes 1 to 8, each up to 4,000 characters and 16,000 in all (text
    * only), at most four pictures, each uploaded into this world; slice up to 100, names up
    * to 200 characters, anchors up to 120.
@@ -539,7 +582,7 @@ var OwV2Client = class {
     });
   }
   /**
-   * GET /account/allowance -- the account's daily AI allowance, the one meter ask, sort and
+   * GET /account/allowance -- the account's token rating, the one daily meter ask, sort and
    * the Council spend from (keel 872431f): the rating, what is used and left today, and
    * when it resets (the next midnight UTC). Spends nothing. Needs the client's `ow_a_` token.
    */

package/package.json

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