@onlyworlds/sdk 4.81.1 → 4.82.1
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 +3 -2
- package/CHANGELOG.md +14 -0
- package/dist/index.d.ts +24 -4
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -71,8 +71,9 @@ against live data). The v1 surface (`OnlyWorldsClient`, the `ElementType` enum)
|
|
|
71
71
|
- Who am I (since 4.22.0, a world key): `client.me()` is `{ world, scope, kind, role,
|
|
72
72
|
membership, character, front_door }` (`membership` is what `created_by` holds for what you
|
|
73
73
|
create; null for the owner); `front_door` (since 4.60.0) names who answers for your
|
|
74
|
-
seat (`sponsor`, `sponsor_character`), your Character,
|
|
75
|
-
|
|
74
|
+
seat (`sponsor`, `sponsor_character`), your Character, the AI and player seats you answer
|
|
75
|
+
for (`my_seats`, since 4.82.0: `{ id, kind, name, character }`, agent seats first), and the
|
|
76
|
+
world's Charter with up to five skill Objects: an agent reads `charter` first. `client.members()` is the roster's rows. An
|
|
76
77
|
account token is a TypeError.
|
|
77
78
|
- Signing in (no key needed): `new OwV2Client().signInWithPassword({ email, password,
|
|
78
79
|
tokenName })` (or `username`) mints an `ow_a_` account token named for the device and ends
|
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,20 @@ earlier history lives in git log only.
|
|
|
5
5
|
|
|
6
6
|
## [Unreleased]
|
|
7
7
|
|
|
8
|
+
## [4.82.1] - 2026-10-26
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- **The draught's words follow keel's 2026-10-26 change.** Under `compact: true` every element body in the packet now leaves out each field whose value is `null`, `""`, `[]` or `{}` (`id`, `type` and `name` always stay; `0` and `false` are values and stay), so a compact body is the list route's body less its empty fields, not byte for byte the same. And a Message without the room mark is placed as any Narrative unless `messages` is named, when it is in `messages` and no other section; a room-marked Message is in `messages` or nowhere. The doc comments on `draught()`, `OwDraughtItem.element` and `OwDraughtCompact` said the body was the list route's exactly; they now say both rules. Types only in words: `OwElement` already lets every field but `id`, `type` and `name` be absent, so no type changed.
|
|
13
|
+
|
|
14
|
+
## [4.82.0] - 2026-10-26
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- **`front_door.my_seats`, and `OwMySeat`** (keel's front door, live 2026-10-26). `me()`, `setMyCharacter()` and an agent's `redeemJoin()` answer now list the live AI and player seats the key's holder answers for, agent seats first: each row is `{ id, kind, name, character }`, with `id` the seat's membership id as `members()` lists it, `kind` `'agent'` or `'player'`, `name` null when the seat has none, and `character` the Character it plays (null when it plays none the key can read). The list is empty for an AI or a player seat's own key and for anyone who answers for none; a seat made from a link for an email address is never listed. Types only: the client already passed the body through. Required on `OwFrontDoor`, as keel's document declares it; a hand-built `OwMe` or `OwAgentJoined` in a consumer's test needs the field.
|
|
19
|
+
- Tests: `me()` reads a front door with seats and one with an empty list through unchanged; the published `OwFrontDoor` declares its six keys in the document's order and `OwMySeat` its four.
|
|
20
|
+
- Test: `readMarkOf` takes the newest read mark wherever it stands in the list. The message profile's fixture lists the newer mark first, so a reader that kept the first mark that counts passed every case; the new test lists it last (and replays the fixture's case reversed), and fails on that reader. No reader changed.
|
|
21
|
+
|
|
8
22
|
## [4.81.1] - 2026-10-26
|
|
9
23
|
|
|
10
24
|
### Changed
|
package/dist/index.d.ts
CHANGED
|
@@ -2576,11 +2576,28 @@ interface OwFrontDoor {
|
|
|
2576
2576
|
sponsor_character: string | null;
|
|
2577
2577
|
/** Your own Character (the owner's: the world's `owner_character`), or null. */
|
|
2578
2578
|
my_character: string | null;
|
|
2579
|
+
/**
|
|
2580
|
+
* The live AI and player seats you answer for, agent seats first (since keel's front door of
|
|
2581
|
+
* 2026-10-26). Empty for an AI or a player seat's own key and for anyone who answers for none;
|
|
2582
|
+
* a seat made from a link for an email address is never listed.
|
|
2583
|
+
*/
|
|
2584
|
+
my_seats: OwMySeat[];
|
|
2579
2585
|
/** The world's Charter: the newest Law with supertype Charter made by the owner or a co-builder, or null. Every member may read it. */
|
|
2580
2586
|
charter: string | null;
|
|
2581
2587
|
/** The Objects the Charter's description names (by `ow://` link or id), in the order written, at most five; empty when none. */
|
|
2582
2588
|
charter_skill: string[];
|
|
2583
2589
|
}
|
|
2590
|
+
/** One seat you answer for, a row of `front_door.my_seats`. */
|
|
2591
|
+
interface OwMySeat {
|
|
2592
|
+
/** The seat's membership id, as `GET /members` lists it. */
|
|
2593
|
+
id: string;
|
|
2594
|
+
/** `agent` for an AI seat, `player` for a player seat. */
|
|
2595
|
+
kind: 'agent' | 'player';
|
|
2596
|
+
/** The seat's name, or null when it has none. */
|
|
2597
|
+
name: string | null;
|
|
2598
|
+
/** The Character the seat plays, or null when it plays none you can read. */
|
|
2599
|
+
character: string | null;
|
|
2600
|
+
}
|
|
2584
2601
|
/** One row of GET /members, the world's roster. */
|
|
2585
2602
|
interface OwMember {
|
|
2586
2603
|
/** The membership id (what `created_by` holds), or null for the owner. */
|
|
@@ -2805,11 +2822,11 @@ interface OwDraughtItem {
|
|
|
2805
2822
|
grade: 'whole' | 'known_of';
|
|
2806
2823
|
/** In `events` and `knowledge`: false when it carries no date (ranked after the dated). */
|
|
2807
2824
|
dated?: boolean;
|
|
2808
|
-
/** The element's body
|
|
2825
|
+
/** The element's body as the list route serves it to the same reader; under `compact`, less each field that is null, "", [] or {} (`id`, `type` and `name` always stay): read a missing field as empty. */
|
|
2809
2826
|
element: OwElement;
|
|
2810
2827
|
}
|
|
2811
2828
|
/** One Character's context in one read, GET /character/{id}/context (the draught). */
|
|
2812
|
-
/** The draught under `compact`: every section may be absent, and so may `cut` (nothing was cut). */
|
|
2829
|
+
/** The draught under `compact`: every section may be absent, and so may `cut` (nothing was cut); each element body leaves out its empty fields, `id`, `type` and `name` kept. */
|
|
2813
2830
|
type OwDraughtCompact = Omit<OwDraught, 'cut'> & {
|
|
2814
2831
|
cut?: Record<string, number>;
|
|
2815
2832
|
};
|
|
@@ -3689,7 +3706,10 @@ declare class OwV2Client {
|
|
|
3689
3706
|
* 404). `asOf` is a filter on the elements' own dates, not time travel. A `cut` that is not
|
|
3690
3707
|
* empty means the serving is partial (`cut.proposed` also counts proposed elements left out because
|
|
3691
3708
|
* the component was not named). `compact: true` leaves out every empty section and an empty `cut`,
|
|
3692
|
-
* the frame and every null kept,
|
|
3709
|
+
* the frame and every null kept, and leaves out each element body's empty fields (`null`, `""`,
|
|
3710
|
+
* `[]`, `{}`; `id`, `type` and `name` always stay), answered as `OwDraughtCompact`. A Message
|
|
3711
|
+
* without the room mark is placed as any Narrative unless `messages` is named, when it is there
|
|
3712
|
+
* and in no other section; a room-marked Message is in `messages` or nowhere. Served
|
|
3693
3713
|
* `Cache-Control: private, no-store`.
|
|
3694
3714
|
*/
|
|
3695
3715
|
draught(characterId: string, policy?: OwDraughtPolicy & {
|
|
@@ -5677,4 +5697,4 @@ declare class TokenResource {
|
|
|
5677
5697
|
getEncryptionInfo(): Promise<EncryptionInfo>;
|
|
5678
5698
|
}
|
|
5679
5699
|
|
|
5680
|
-
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, MESSAGE_PAIR, ONLYWORLDS_VERSION, type OwAccountWorld, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAskContextOptions, type OwAskLeftOut, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtPolicy, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwHiddenRow, 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 OwMessageMember, type OwMintedKey, type OwNamesMap, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwProposal, type OwProposalAccepted, type OwProposalConflict, type OwProposalList, type OwProposalQuery, type OwProposalState, type OwProposeInput, type OwProposed, OwProposedError, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwSignInBegin, type OwSignInBegun, type OwSignInComplete, OwSignInError, type OwSignInReason, type OwSignInResult, type OwSignInStorage, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, OwStaleProposalError, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWorldOrigin, type OwWorldProducer, type OwWorldProposalList, type OwWorldProposalQuery, type OwWorldProposalRow, type OwWorldPublicPage, type OwWorldSource, type OwWriteDoor, type OwWriteWorldFileOptions, type OwWriteWorldFileReport, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, 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, WORLD_FILE_MEDIA_TYPE, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, base64url, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, intercalaryInYear, isAddressedTo, isAgentDoor, isDemoKey, isKnownOf, isLeapYear, isMessage, isParseError, isRoomElement, isSentBy, isToEveryone, kindCanWrite, lookupWorld, monthStartSteps, nfc, parseDate, parseErrorEnvelope, pinExpectation, pkceChallenge, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, recipientsOf, renderElement, resolveCalendarLens, resolveEraDomains, senderStatus, simpleCaseFold, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
|
|
5700
|
+
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, MESSAGE_PAIR, ONLYWORLDS_VERSION, type OwAccountWorld, type OwAgentJoined, type OwAllowance, OwApiError, type OwAskAnswer, type OwAskContext, type OwAskContextOptions, type OwAskLeftOut, type OwAuthErrorCode, type OwBulkItem, type OwBulkItemResult, type OwBulkResponse, type OwCalendarElement, type OwChange, type OwChangeDelete, type OwChangeUpsert, type OwChangesPage, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtPolicy, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwHiddenRow, 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 OwMessageMember, type OwMintedKey, type OwMySeat, type OwNamesMap, OwNetworkError, type OwPage, type OwPhotoOptions, type OwPhotoPlan, type OwPlayerJoined, OwPreconditionFailedError, type OwPreparedPhoto, type OwProposal, type OwProposalAccepted, type OwProposalConflict, type OwProposalList, type OwProposalQuery, type OwProposalState, type OwProposeInput, type OwProposed, OwProposedError, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwSignInBegin, type OwSignInBegun, type OwSignInComplete, OwSignInError, type OwSignInReason, type OwSignInResult, type OwSignInStorage, type OwSignedIn, type OwSortAddToRow, type OwSortAnswer, type OwSortAskRow, type OwSortLinkRow, type OwSortMakeRow, type OwSortNote, type OwSortRef, type OwSortRow, OwStaleProposalError, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldIndex, type OwWorldLink, type OwWorldMeta, type OwWorldOrigin, type OwWorldProducer, type OwWorldProposalList, type OwWorldProposalQuery, type OwWorldProposalRow, type OwWorldPublicPage, type OwWorldSource, type OwWriteDoor, type OwWriteWorldFileOptions, type OwWriteWorldFileReport, PHOTO_MAX_BYTES, PHOTO_TYPES, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, 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, WORLD_FILE_MEDIA_TYPE, type WorldCalendar, absYearForEraYear, absoluteYear, approxYearLength, base64url, breakdownStep, buildAskContext, buildWorldIndex, detectKeyKind, displayYear, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, intercalaryInYear, isAddressedTo, isAgentDoor, isDemoKey, isKnownOf, isLeapYear, isMessage, isParseError, isRoomElement, isSentBy, isToEveryone, kindCanWrite, lookupWorld, monthStartSteps, nfc, parseDate, parseErrorEnvelope, pinExpectation, pkceChallenge, planPhoto, preparePhoto, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, recipientsOf, renderElement, resolveCalendarLens, resolveEraDomains, senderStatus, simpleCaseFold, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, writeWorldFile, yearLength, yearStartStep };
|