@onlyworlds/sdk 4.44.0 → 4.45.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ earlier history lives in git log only.
 
 ## [Unreleased]
 
+## [4.45.0] - 2026-10-22
+
+### Added
+- `hide(type, id)` and `unhide(type, id)`: the hidden mark's writes, `PUT` and `DELETE /{type}/{id}/hidden` (keel #421), for the parlor (Temper, h66 #9720). 204; the element's body and `change_seq` do not move.
+- `listAccountWorlds()` (`GET /account/worlds`, `OwAccountWorld[]`: owned and shared worlds with their keys by name and last four) and `mintWorldKey(worldId, { scope, name })` (`POST /account/worlds/{id}/keys`, `OwMintedKey` with the full key once), the two account routes Atlas and the parlor hand-rolled. Account token only.
+
 ## [4.44.0] - 2026-10-22
 
 ### Added

package/dist/index.d.ts

@@ -2426,6 +2426,39 @@ interface OwSignedIn {
     last4: string;
 }
 /** One live agent seat, as GET /account/worlds/{id}/seats lists it (keel #355, D106). No key or secret. */
+/**
+ * One world of the account, from GET /account/worlds: owned (`role: 'owner'`) or shared
+ * (`'collaborator'`, with `member_role` the membership's role). Keys by name and last four only,
+ * never the key; on a shared world only the member's own keys (keel H8).
+ */
+interface OwAccountWorld {
+    id: string;
+    name: string;
+    role: 'owner' | 'collaborator';
+    member_role?: OwMemberRole;
+    public_read: boolean;
+    keys: Array<{
+        name: string;
+        last4: string;
+        scope: 'READ' | 'WRITE';
+        revoked: boolean;
+    }>;
+}
+/**
+ * A world key as minted by POST /account/worlds/{id}/keys: the row the account's key list shows,
+ * plus the full key once in `key` (never shown again). A member's key carries its `member` label
+ * (keel D72); an owner's row has no such field.
+ */
+interface OwMintedKey {
+    id: string;
+    name: string;
+    last4: string;
+    scope: 'READ' | 'WRITE';
+    last_used_at: string | null;
+    revoked: boolean;
+    key: string;
+    member?: Record<string, unknown>;
+}
 interface OwSeat {
     /** The seat's membership id: removeSeat takes it, and GET /members names the seat by it. */
     id: string;
@@ -3427,6 +3460,32 @@ declare class OwV2Client {
      * goes with it, any other stays. Needs the client's `ow_a_` token.
      */
     removeSeat(worldId: string, seatId: string): Promise<void>;
+    /**
+     * PUT /{type}/{id}/hidden -- hide an element (keel #421). The owner's key or a co-builder's
+     * (a person's or a seat's) with its PIN; hiding a hidden element again changes nothing, and
+     * the element's body and `change_seq` do not move. Hidden, it is seen only by the owner, the
+     * co-builders and the member who created it; to every other key it is a 404, left out of
+     * lists, search, counts and the link arrays that name it. 204, no body. No Idempotency-Key.
+     */
+    hide(type: ElementType | string, id: string): Promise<void>;
+    /** DELETE /{type}/{id}/hidden -- clear the mark; an element that is not hidden stays as it is. 204. */
+    unhide(type: ElementType | string, id: string): Promise<void>;
+    /**
+     * GET /account/worlds -- every world the account owns or is a member of, with its keys by
+     * name and last four (a member sees only their own keys on a shared world). Account token only.
+     */
+    listAccountWorlds(): Promise<OwAccountWorld[]>;
+    /**
+     * POST /account/worlds/{id}/keys -- mint a world key, `scope` `'write'` (the default) or
+     * `'read'`, `name` as the key list shows it (at most 255 characters). The full key comes back
+     * once in `key`. The owner mints a world key; a member mints their own member key, 409
+     * `pin_required` (`err.isPinRequired`) for a write key while the account has no PIN. Account
+     * token only; no Idempotency-Key.
+     */
+    mintWorldKey(worldId: string, opts?: {
+        scope?: 'read' | 'write';
+        name?: string;
+    }): Promise<OwMintedKey>;
     /**
      * 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
@@ -4469,4 +4528,4 @@ declare class TokenResource {
     getEncryptionInfo(): Promise<EncryptionInfo>;
 }
 
-export { AGENT_DOORS, 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_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GameTier, type ListParams, ONLYWORLDS_VERSION, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreatedWorldLink, type OwDeleteReason, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwJoinPreview, type OwJoined, 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, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwSeat, type OwSeatCreated, OwSignInError, type OwSignInReason, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWriteDoor, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, 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, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, isAgentDoor, isDemoKey, isKnownOf, isLeapYear, isParseError, kindCanWrite, lookupWorld, monthStartSteps, parseDate, parseErrorEnvelope, pinExpectation, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readWorldFile, renderElement, resolveCalendarLens, resolveEraDomains, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
+export { AGENT_DOORS, 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_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GameTier, type ListParams, ONLYWORLDS_VERSION, type OwAccountWorld, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreatedWorldLink, type OwDeleteReason, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwJoinPreview, type OwJoined, type OwJoinedMembership, type OwKeyKind, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberRole, type OwMintedKey, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwSeat, type OwSeatCreated, OwSignInError, type OwSignInReason, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWriteDoor, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, 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, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, isAgentDoor, isDemoKey, isKnownOf, 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

@@ -1134,6 +1134,49 @@ var OwV2Client = class {
     }
     await this.request("DELETE", `/account/worlds/${encodeURIComponent(worldId)}/seats/${encodeURIComponent(seatId)}`);
   }
+  // -- The hidden mark (keel #421) ------------------------------------------
+  /**
+   * PUT /{type}/{id}/hidden -- hide an element (keel #421). The owner's key or a co-builder's
+   * (a person's or a seat's) with its PIN; hiding a hidden element again changes nothing, and
+   * the element's body and `change_seq` do not move. Hidden, it is seen only by the owner, the
+   * co-builders and the member who created it; to every other key it is a 404, left out of
+   * lists, search, counts and the link arrays that name it. 204, no body. No Idempotency-Key.
+   */
+  async hide(type, id) {
+    await this.request("PUT", `/${type}/${id}/hidden`, { write: true, body: {}, allowEmpty: true });
+  }
+  /** DELETE /{type}/{id}/hidden -- clear the mark; an element that is not hidden stays as it is. 204. */
+  async unhide(type, id) {
+    await this.request("DELETE", `/${type}/${id}/hidden`, { write: true, allowEmpty: true });
+  }
+  // -- The account's worlds and keys (account token) -----------------------
+  /**
+   * GET /account/worlds -- every world the account owns or is a member of, with its keys by
+   * name and last four (a member sees only their own keys on a shared world). Account token only.
+   */
+  async listAccountWorlds() {
+    if (this.keyKind !== "account") {
+      throw new TypeError("listAccountWorlds needs an account token (ow_a_)");
+    }
+    const page = await this.request("GET", "/account/worlds");
+    return page.data;
+  }
+  /**
+   * POST /account/worlds/{id}/keys -- mint a world key, `scope` `'write'` (the default) or
+   * `'read'`, `name` as the key list shows it (at most 255 characters). The full key comes back
+   * once in `key`. The owner mints a world key; a member mints their own member key, 409
+   * `pin_required` (`err.isPinRequired`) for a write key while the account has no PIN. Account
+   * token only; no Idempotency-Key.
+   */
+  async mintWorldKey(worldId, opts = {}) {
+    if (this.keyKind !== "account") {
+      throw new TypeError("mintWorldKey needs an account token (ow_a_)");
+    }
+    const body = {};
+    if (opts.scope !== void 0) body.scope = opts.scope;
+    if (opts.name !== void 0) body.name = opts.name;
+    return this.request("POST", `/account/worlds/${encodeURIComponent(worldId)}/keys`, { write: true, body });
+  }
   // -- Ask your world (keel #159) -------------------------------------------
   /**
    * POST /account/ask -- a question about a world the account owns or is in, answered by

package/package.json

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