@onlyworlds/sdk 4.125.0 → 4.126.0

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 CHANGED
@@ -223,7 +223,9 @@ against live data). The v1 surface (`OnlyWorldsClient`, the `ElementType` enum)
223
223
  address in a field is text: never fetch it to show what it names.
224
224
  - To offer a world or an element in other tools, `openersFor(TOOLS, kind, address, surface)` gives
225
225
  the "Open with" rows in order, each `{ id, name, href, state }` with its word ("Sign in to Atlas
226
- first") or null. Draw them as given; never word a row yourself.
226
+ first") or null. Draw them as given; never word a row yourself. For an element, pass it as served
227
+ (`openersFor(TOOLS, 'element', address, surface, { element })`): a tool that cannot open it (a
228
+ room, hidden or proposed element, map space, a reading aid) then has no row.
227
229
  - A string holding an unpaired surrogate (text cut mid-emoji) is a 422 naming the field.
228
230
  Slice strings by code point, not by UTF-16 unit.
229
231
  - Colour carries the element's colour group (`elementColor(type, mode)`, `groupOf(type)`: `blue`,
package/CHANGELOG.md CHANGED
@@ -5,6 +5,18 @@ earlier history lives in git log only.
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [4.126.0] - 2026-11-01
9
+
10
+ ### Added
11
+
12
+ - **`openersFor(tools, kind, address, surface, { element })`: no row for a tool that cannot open the element.** The tools list's `open` now says what a tool's element door does not open, `element_skips`, in the graph reader's words: `room`, `hidden`, `proposed`, `map_space` (a Map, Pin or Marker; a Zone is content) and `reading_aid`. Given the element as served, `openersFor` leaves out a row whose door skips a mark the element carries, each mark read by the readers `worldGraph` uses (`isRoomElement`, the hidden mark, `handsOnAsProposed`, the type, the reading aids), so the menu and the graph give one answer; a test holds the two equal on every element of the lens fixture's worlds. Without `element` every row is there, as before. A world's menu takes no element. Refused by name: an unknown options key, an element for a world's menu or naming another id than the address, a skip word outside the list's, and skips on a row with no element door. The shared openers fixture gains 25 cases (90 in all), the same bytes as the Python package's.
13
+ - **`mountWaymark` passes its `element` through**, so the Waymark's Open with rows follow the same rule with no change on the page.
14
+ - **`OwOpenersOptions`, `OwElementMark`**, and `OwToolOpen.element_skips`.
15
+
16
+ ### Changed
17
+
18
+ - **`TOOLS` repinned** at the tools list's 6da4d55: each row carries `element_skips` (Little Lens skips room, hidden, proposed and map space; Atlas and Lantern none until their doors are walked).
19
+
8
20
  ## [4.125.0] - 2026-11-01
9
21
 
10
22
  ### Added
@@ -318,7 +330,7 @@ earlier history lives in git log only.
318
330
 
319
331
  ### Added
320
332
 
321
- - **Sign in with OnlyWorlds from a native app** (RFC 8252). A tool registered as native lists a loopback return without a port (`http://127.0.0.1/<path>` or `http://[::1]/<path>`) or its own scheme (`obsidian://onlyworlds-signin`). `signInWithOnlyWorlds` now takes, beside an `https:` address, the loopback address with the port the app bound for this sign-in (`http://127.0.0.1:53682/onlyworlds-signin`, 1 to 65535, written plainly), which the server matches against the portless one, and a custom scheme exactly as registered (lower-case, not `http`, `https`, `javascript`, `data` or `file`, something after `://`). It refuses `localhost`, a loopback without its port, and on any form userinfo, a query, a fragment and a dot segment (and an `https:` address with an upper-case host or no path, which it took before), with a TypeError naming the forms it takes: the server would refuse each of them at authorize. Whether the tool is registered as native is the server's to check; the SDK does not read the client list. A native app opens the authorize URL in the system browser through `navigate`, and passes the address its loopback server or scheme handler received to `completeSignIn` as `url`.
333
+ - **Sign in with OnlyWorlds from a native app** (RFC 8252). A tool registered as native lists a loopback return without a port (`http://` and the IPv4 or the IPv6 loopback address with a path) or its own scheme (`obsidian://onlyworlds-signin`). `signInWithOnlyWorlds` now takes, beside an `https:` address, the loopback address with the port the app bound for this sign-in (the same form with a port from 1 to 65535, written plainly), which the server matches against the portless one, and a custom scheme exactly as registered (lower-case, not `http`, `https`, `javascript`, `data` or `file`, something after `://`). It refuses `localhost`, a loopback without its port, and on any form userinfo, a query, a fragment and a dot segment (and an `https:` address with an upper-case host or no path, which it took before), with a TypeError naming the forms it takes: the server would refuse each of them at authorize. Whether the tool is registered as native is the server's to check; the SDK does not read the client list. A native app opens the authorize URL in the system browser through `navigate`, and passes the address its loopback server or scheme handler received to `completeSignIn` as `url`.
322
334
 
323
335
  ### Fixed
324
336
 
package/README.md CHANGED
@@ -467,10 +467,12 @@ The rows of an "Open with" menu for a world or one of its elements: the site's p
467
467
  ```typescript
468
468
  import { openersFor, parseOwLink, TOOLS } from '@onlyworlds/sdk';
469
469
 
470
- const rows = openersFor(TOOLS, 'element', parseOwLink(link), { audience: 'member', signedIn: false, tool: 'mytool' });
470
+ const rows = openersFor(TOOLS, 'element', parseOwLink(link), { audience: 'member', signedIn: false, tool: 'mytool' }, { element });
471
471
  // [{ id: 'onlyworlds', name: 'onlyworlds.com', href, state: null }, { id: 'atlas', name: 'Atlas', href, state: 'Sign in to Atlas first' }, ...]
472
472
  ```
473
473
 
474
+ Pass the element as you were served it (`{ element }`): a tool whose element door does not open what it carries (a room element, a hidden or proposed one, a Map, Pin or Marker, a reading aid: the list's `open.element_skips`, each read as `worldGraph` reads it) has no row, rather than a link to a page that cannot open it. Without it, every row is there.
475
+
474
476
  `surface` says what the page knows and nothing is guessed: `audience` (`member` or `public`; the public sees only rows that need nothing first), `signedIn` (`null` when the page cannot know, and then no row says so), `browser` (false in a desktop app), `phone`, `online` (false with no connection: every row whose link is a web address then says "Needs a connection"), and `tool`, the page's own client name, whose row says "You are here". Draw the rows as given; the words are decided here, so every surface says the same.
475
477
 
476
478
  ### The Waymark: Open with, beside a name
@@ -1039,6 +1039,36 @@ function readingAidOf(element) {
1039
1039
  return AID_BY_KEY.get(`${fold(el.type)}/${fold(el.supertype)}`) ?? null;
1040
1040
  }
1041
1041
 
1042
+ // src/review.ts
1043
+ var PROPOSED_MARK = "x_review_proposed";
1044
+ var DAY = /^[0-9]{4}-[0-9]{2}-[0-9]{2}$/;
1045
+ function todayDay() {
1046
+ return (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
1047
+ }
1048
+ function isPresent(v) {
1049
+ if (v === void 0 || v === null) return false;
1050
+ if (typeof v === "string") return trimWhiteSpace(v) !== "";
1051
+ if (Array.isArray(v)) return v.length > 0;
1052
+ if (typeof v === "object") return Object.keys(v).length > 0;
1053
+ return true;
1054
+ }
1055
+ function proposedMarkOf(element, today) {
1056
+ if (today !== void 0 && (typeof today !== "string" || !DAY.test(today))) {
1057
+ throw new TypeError(`proposedMarkOf: today is a day as YYYY-MM-DD; got ${JSON.stringify(today) ?? String(today)}.`);
1058
+ }
1059
+ if (!element || typeof element !== "object") return null;
1060
+ const v = element[PROPOSED_MARK];
1061
+ if (!isPresent(v) || typeof v !== "object" || Array.isArray(v)) return null;
1062
+ const m = v;
1063
+ const by = typeof m.by === "string" && trimWhiteSpace(m.by) ? trimWhiteSpace(m.by) : null;
1064
+ const expires = typeof m.expires === "string" && DAY.test(trimWhiteSpace(m.expires)) ? trimWhiteSpace(m.expires) : null;
1065
+ return { by, expires, lapsed: expires !== null && expires <= (today ?? todayDay()) };
1066
+ }
1067
+ function handsOnAsProposed(element) {
1068
+ if (!element || typeof element !== "object") return false;
1069
+ return isPresent(element[PROPOSED_MARK]);
1070
+ }
1071
+
1042
1072
  // src/names.ts
1043
1073
  var SLUGS = new Set(ELEMENT_TYPES);
1044
1074
  var OPTION_KEYS = ["supertype", "many"];
@@ -1233,7 +1263,24 @@ function parseOwLink(text) {
1233
1263
  return { form, world, worldIsSlug, type, id, lens, moment, canonical };
1234
1264
  }
1235
1265
 
1266
+ // src/marks.ts
1267
+ var ELEMENT_MARKS = ["room", "hidden", "proposed", "map_space", "reading_aid"];
1268
+ var MAP_SPACE = /* @__PURE__ */ new Set(["map", "pin", "marker"]);
1269
+ function isHiddenMark(el) {
1270
+ return el.hidden !== void 0 && el.hidden !== null && el.hidden !== false;
1271
+ }
1272
+ function marksOf(el) {
1273
+ const out = [];
1274
+ if (isRoomElement(el)) out.push("room");
1275
+ if (isHiddenMark(el)) out.push("hidden");
1276
+ if (handsOnAsProposed(el)) out.push("proposed");
1277
+ if (typeof el.type === "string" && MAP_SPACE.has(fold(el.type))) out.push("map_space");
1278
+ if (readingAidKey(el) !== null) out.push("reading_aid");
1279
+ return out;
1280
+ }
1281
+
1236
1282
  // src/openers.ts
1283
+ var OPTION_KEYS2 = ["element"];
1237
1284
  var SURFACE_KEYS = ["tool", "audience", "signedIn", "browser", "phone", "online"];
1238
1285
  var NEEDS = ["account", "device", null];
1239
1286
  var PLACEHOLDER = /\{(world|type|id)\}/g;
@@ -1252,7 +1299,7 @@ function templateOf(row, key, v) {
1252
1299
  if (NO_APP.includes(scheme)) fail(`tool ${row}: open.${key} is a ${scheme}: link, which opens no app`);
1253
1300
  return v;
1254
1301
  }
1255
- function openersFor(tools, kind, address, surface) {
1302
+ function openersFor(tools, kind, address, surface, options = {}) {
1256
1303
  if (!Array.isArray(tools)) fail("tools is the tools list's rows, an array");
1257
1304
  if (kind !== "world" && kind !== "element") fail(`kind is 'world' or 'element'; got ${JSON.stringify(kind)}`);
1258
1305
  if (address === null || typeof address !== "object" || Array.isArray(address)) {
@@ -1276,6 +1323,16 @@ function openersFor(tools, kind, address, surface) {
1276
1323
  if (typeof browser !== "boolean") fail("surface.browser is a boolean");
1277
1324
  if (typeof phone !== "boolean") fail("surface.phone is a boolean");
1278
1325
  if (typeof online !== "boolean") fail("surface.online is a boolean");
1326
+ if (options === null || typeof options !== "object" || Array.isArray(options)) fail("the options are an object ({ element })");
1327
+ refuseUnknownOptions("openersFor", options, OPTION_KEYS2);
1328
+ const element = options.element ?? null;
1329
+ if (element !== null) {
1330
+ if (typeof element !== "object" || Array.isArray(element)) fail("options.element is the element as served, an object, or null");
1331
+ if (kind !== "element") fail("options.element is for an element's menu; a world's menu takes none");
1332
+ const eid = element.id;
1333
+ if (typeof eid !== "string" || eid.toLowerCase() !== id) fail("options.element is the element the address names: its id differs");
1334
+ }
1335
+ const marks = element === null ? [] : marksOf(element);
1279
1336
  const values = { world, type, id };
1280
1337
  const fill = (template) => template.replace(PLACEHOLDER, (_, n) => values[n]);
1281
1338
  const offline = (href) => !online && WEB.test(href);
@@ -1294,10 +1351,16 @@ function openersFor(tools, kind, address, surface) {
1294
1351
  const elementDoor = templateOf(r.id, "element", o.element);
1295
1352
  const needs = o.needs === void 0 ? null : o.needs;
1296
1353
  if (!NEEDS.includes(needs)) fail(`tool ${r.id}: open.needs is 'account', 'device' or null; got ${JSON.stringify(needs)}`);
1354
+ const skips = o.element_skips === void 0 || o.element_skips === null ? [] : o.element_skips;
1355
+ if (!Array.isArray(skips) || skips.some((s) => !ELEMENT_MARKS.includes(s))) {
1356
+ fail(`tool ${r.id}: open.element_skips is a list of ${ELEMENT_MARKS.join(", ")}; got ${JSON.stringify(o.element_skips)}`);
1357
+ }
1358
+ if (elementDoor === null && skips.length > 0) fail(`tool ${r.id}: open.element_skips names what an element door leaves out, and the row has none`);
1297
1359
  if (r.rung !== "listed") continue;
1298
1360
  if (audience === "public" && needs !== null) continue;
1299
1361
  const template = kind === "element" ? elementDoor ?? worldDoor : worldDoor;
1300
1362
  if (template === null) continue;
1363
+ if (kind === "element" && marks.some((m) => skips.includes(m))) continue;
1301
1364
  const href = fill(template);
1302
1365
  let state = null;
1303
1366
  if (tool !== null && r.client === tool) state = "You are here";
@@ -1322,7 +1385,8 @@ var TOOLS = [
1322
1385
  "open": {
1323
1386
  "world": "https://atlas.onlyworlds.com/#/open/{world}",
1324
1387
  "element": "https://atlas.onlyworlds.com/#/open/{world}/element/{id}",
1325
- "needs": "account"
1388
+ "needs": "account",
1389
+ "element_skips": []
1326
1390
  }
1327
1391
  },
1328
1392
  {
@@ -1334,7 +1398,8 @@ var TOOLS = [
1334
1398
  "open": {
1335
1399
  "world": "https://lantern.onlyworlds.com/#/open/{world}",
1336
1400
  "element": "https://lantern.onlyworlds.com/#/open/{world}/element/{id}",
1337
- "needs": "account"
1401
+ "needs": "account",
1402
+ "element_skips": []
1338
1403
  }
1339
1404
  },
1340
1405
  {
@@ -1346,7 +1411,13 @@ var TOOLS = [
1346
1411
  "open": {
1347
1412
  "world": "https://little-lens.onlyworlds.com/#/open/{world}",
1348
1413
  "element": "https://little-lens.onlyworlds.com/#/open/{world}/element/{id}",
1349
- "needs": null
1414
+ "needs": null,
1415
+ "element_skips": [
1416
+ "room",
1417
+ "hidden",
1418
+ "proposed",
1419
+ "map_space"
1420
+ ]
1350
1421
  }
1351
1422
  }
1352
1423
  ];
@@ -1475,6 +1546,11 @@ export {
1475
1546
  readingAidKey,
1476
1547
  isCharterElement,
1477
1548
  readingAidOf,
1549
+ PROPOSED_MARK,
1550
+ proposedMarkOf,
1551
+ handsOnAsProposed,
1552
+ MAP_SPACE,
1553
+ isHiddenMark,
1478
1554
  typeWord,
1479
1555
  OwAddressError,
1480
1556
  elementAddress,
package/dist/index.d.ts CHANGED
@@ -160,8 +160,8 @@ type FieldType = 'text' | 'integer'
160
160
  * this repository. It was meant to surface the schema's `maximum:` constraint,
161
161
  * and that constraint is **advisory**: keel declares no `MaxValueValidator` and
162
162
  * the wire stores `charisma: 9999` against a `maximum: 100` field (201, verbatim).
163
- * The canonical schema walk therefore stays silent on bounds permanently, so
164
- * there is no source to wire this to and no promise it could keep. A public type
163
+ * The walk's schema.json carries the bounds as display data (a slider's range),
164
+ * never as a rule, so this type would promise what no field keeps. A public type
165
165
  * member meaning "hint the wire ignores" is one consumers read as validation.
166
166
  */
167
167
  | 'integer_max' | 'single_link' | 'multi_link';
@@ -5750,6 +5750,14 @@ declare function elementAddress(address: OwAddress | OwAddressReading): string;
5750
5750
  */
5751
5751
  declare function parseOwLink(text: string): OwAddressReading;
5752
5752
 
5753
+ /** One reason a lore view leaves an element out, as the graph section names it. */
5754
+ type OwElementMark = 'room' | 'hidden' | 'proposed' | 'map_space' | 'reading_aid';
5755
+
5756
+ /** What `openersFor` takes beside the surface. */
5757
+ interface OwOpenersOptions {
5758
+ /** The element the menu is for, as the surface was served it (the API's body, the mark flat on it): a row whose door skips what it carries is not there. Absent or null: every row, as before 4.126.0. */
5759
+ element?: Record<string, unknown> | null;
5760
+ }
5753
5761
  /** What a person must have before a tool's link works: signed in to the tool (`account`), or the world already in the tool on this device (`device`). */
5754
5762
  type OwToolNeeds = 'account' | 'device';
5755
5763
  /** A tool's `open` in the tools list: its link templates and what they need first. */
@@ -5760,6 +5768,8 @@ interface OwToolOpen {
5760
5768
  element: string | null;
5761
5769
  /** What the person needs first; null for nothing, which is the one kind of row a public page offers. */
5762
5770
  needs: OwToolNeeds | null;
5771
+ /** What the element door does not open, in the graph section's words; [] or absent: it opens every element (a list older than the key has none). */
5772
+ element_skips?: readonly OwElementMark[];
5763
5773
  }
5764
5774
  /** The keys of one tools list row that `openersFor` reads; a row straight from `tools.json` carries more, and they are ignored. */
5765
5775
  interface OwTool {
@@ -5813,7 +5823,10 @@ interface OwOpener {
5813
5823
  * what `elementAddress` takes, with the world's id. A lens and a moment on it ride on no href.
5814
5824
  *
5815
5825
  * A row with `open: null`, or with no door for this kind, is not there. On an element, a tool with only
5816
- * a world door is a row to its world door that says "Opens the world". For the `public` audience only
5826
+ * a world door is a row to its world door that says "Opens the world". On an element given as
5827
+ * `options.element`, a row whose `open.element_skips` names a mark the element carries (room, hidden,
5828
+ * proposed, map space, a reading aid, each read as `worldGraph` reads it) is not there: its door cannot
5829
+ * open it. A world door alone opens the world, so it stays. For the `public` audience only
5817
5830
  * rows whose `open.needs` is null are there: a row that needs anything does not exist for the public.
5818
5831
  *
5819
5832
  * Each row's `state`, the first that holds: "You are here" for the surface's own tool (its `client` is
@@ -5830,10 +5843,11 @@ interface OwOpener {
5830
5843
  * and a slug or anything else for the world's id (`bad_world`); and an address without a world
5831
5844
  * (`no_world`), the text form inside a world included, since every row needs one. A TypeError names the
5832
5845
  * rest: a `kind` that is neither, an element's openers asked of an address with no element, an unknown
5833
- * key on the address or the surface, a missing or unknown `audience`, a surface value of the wrong type,
5834
- * a tools row that is not one (a `needs` outside the list's format included).
5846
+ * key on the address, the surface or the options, a missing or unknown `audience`, a surface value of the
5847
+ * wrong type, an element given for a world's menu or naming another element than the address, a tools row
5848
+ * that is not one (a `needs` or an `element_skips` word outside the list's format included).
5835
5849
  */
5836
- declare function openersFor(tools: readonly OwTool[], kind: OwOpenerKind, address: OwAddress | OwAddressReading, surface: OwOpenerSurface): OwOpener[];
5850
+ declare function openersFor(tools: readonly OwTool[], kind: OwOpenerKind, address: OwAddress | OwAddressReading, surface: OwOpenerSurface, options?: OwOpenersOptions): OwOpener[];
5837
5851
 
5838
5852
  /** The OnlyWorlds tools list's rows (format 1), in the list's order, as of this release: the keys openersFor reads. */
5839
5853
  declare const TOOLS: readonly OwTool[];
@@ -6993,4 +7007,4 @@ declare class TokenResource {
6993
7007
  getEncryptionInfo(): Promise<EncryptionInfo>;
6994
7008
  }
6995
7009
 
6996
- export { AGENT_DOORS, ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, CHARTER_PAIRS, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, DATE_FIELD, ELEMENT_FAMILIES, ELEMENT_GROUPS, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementGroup, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GROUP_COLORS, GROUP_ORDER, GameTier, type ListParams, MESSAGE_PAIR, NOTE_PAIR, ONLYWORLDS_VERSION, type OwAccountToken, type OwAccountWorld, type OwAddress, OwAddressError, type OwAddressForm, type OwAddressReading, type OwAddressReason, type OwAddressingOptions, 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 OwCharterWorld, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDoor, type OwDragField, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtLens, type OwDraughtPolicy, type OwEdited, type OwElement, type OwElementBase, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwGraphCutReason, type OwGraphEdge, type OwGraphMark, type OwGraphNode, type OwGraphOptions, type OwHiddenRow, type OwJoinPreview, type OwJoined, type OwJoinedMembership, type OwKeyKind, type OwLensCutReason, type OwLensMail, type OwLensOptions, type OwLensReader, type OwLensReading, type OwLensWorld, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberLenses, type OwMemberRole, type OwMessageMember, type OwMintedKey, type OwMySeat, type OwNamesMap, OwNetworkError, type OwOpener, type OwOpenerKind, type OwOpenerState, type OwOpenerSurface, 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 OwProposedMark, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwReadingAids, type OwReadingAidsCharter, type OwReadingAidsDomain, type OwReadingAidsGuide, type OwReadingAidsHub, type OwRecord, type OwRecordMark, type OwRecordStory, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwServedReadingAids, 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 OwStrand, type OwStrandSlot, type OwStrandWorld, type OwTool, type OwToolNeeds, type OwToolOpen, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldGraph, type OwWorldIndex, type OwWorldLens, type OwWorldLensReading, type OwWorldLenses, 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, PROPOSED_MARK, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, RECORD_FIELD, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, STRAND_FIELD, type SectionInfo, type StepBreakdown, TOOLS, 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, charterOf, dateOf, degreeOf, detectKeyKind, displayYear, domainsOf, doorWhere, doorsOf, dragField, draughtText, editedBy, elementAddress, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, groupOf, handsOnAsProposed, hasUnseenRecipients, intercalaryInYear, isAddressedTo, isAgentDoor, isCharterElement, isDemoKey, isKnownOf, isLeapYear, isLens, isMessage, isNote, isParseError, isRoomElement, isSentBy, isTemplate, isToEveryone, kindCanWrite, lensesInUse, lookupWorld, monthStartSteps, nfc, noteOf, openersFor, outDegreeOf, parseDate, parseErrorEnvelope, parseOwLink, pinExpectation, pkceChallenge, planPhoto, preparePhoto, proposedMarkOf, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, readingAidOf, recipientsOf, recordMarkOf, recordsOf, renderElement, resolveCalendar, resolveCalendarLens, resolveEraDomains, resolveLens, senderStatus, simpleCaseFold, strandOf, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, worldGraph, writeWorldFile, yearLength, yearStartStep };
7010
+ export { AGENT_DOORS, ASK_LIMITS, type AccessKeyResponse, CALENDAR_FIELD, CALENDAR_SUPERTYPE, CHARTER_PAIRS, type CalendarConfig, type CalendarEra, type CalendarIntercalary, type CalendarMonths, type CalendarWeek, DATE_FIELD, ELEMENT_FAMILIES, ELEMENT_GROUPS, ELEMENT_ICONS, ELEMENT_LABELS, ELEMENT_SECTIONS, ELEMENT_TYPES, type ElementFamily, type ElementGroup, type ElementType, type EncryptionInfo, type EraDomain, FAMILY_COLORS, FAMILY_ORDER, FIELD_ACRONYMS, FIELD_SCHEMA, FILE_EXTENSIONS, type FieldInfo, type FieldType, GROUP_COLORS, GROUP_ORDER, GameTier, type ListParams, MESSAGE_PAIR, NOTE_PAIR, ONLYWORLDS_VERSION, type OwAccountToken, type OwAccountWorld, type OwAddress, OwAddressError, type OwAddressForm, type OwAddressReading, type OwAddressReason, type OwAddressingOptions, 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 OwCharterWorld, type OwClientConfig, type OwCreateAccountWorldInput, type OwCreatedAccountWorld, type OwCreatedWorldLink, type OwDeleteReason, type OwDoor, type OwDragField, type OwDraught, type OwDraughtCompact, type OwDraughtComponent, type OwDraughtItem, type OwDraughtLens, type OwDraughtPolicy, type OwEdited, type OwElement, type OwElementBase, type OwElementMark, type OwErrorBody, type OwFileAddedBy, type OwFileDownload, type OwFileKind, type OwFileRow, type OwFileTicket, type OwFrontDoor, type OwGraphCutReason, type OwGraphEdge, type OwGraphMark, type OwGraphNode, type OwGraphOptions, type OwHiddenRow, type OwJoinPreview, type OwJoined, type OwJoinedMembership, type OwKeyKind, type OwLensCutReason, type OwLensMail, type OwLensOptions, type OwLensReader, type OwLensReading, type OwLensWorld, type OwLinkEdit, type OwLookupElement, type OwLookupHit, type OwLookupLink, type OwLookupOptions, type OwLookupReason, type OwMe, type OwMediaTicket, type OwMember, type OwMemberLenses, type OwMemberRole, type OwMessageMember, type OwMintedKey, type OwMySeat, type OwNamesMap, OwNetworkError, type OwOpener, type OwOpenerKind, type OwOpenerState, type OwOpenerSurface, type OwOpenersOptions, 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 OwProposedMark, type OwProposedNewElement, type OwReadWorldFile, type OwReadWorldFileOptions, type OwReadingAids, type OwReadingAidsCharter, type OwReadingAidsDomain, type OwReadingAidsGuide, type OwReadingAidsHub, type OwRecord, type OwRecordMark, type OwRecordStory, type OwRemovalTicket, type OwRemovedImage, type OwRenderOptions, type OwResyncReason, type OwReviewInput, type OwReviewed, type OwSeat, type OwSeatCreated, type OwSender, type OwSenderStatus, type OwServedReadingAids, 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 OwStrand, type OwStrandSlot, type OwStrandWorld, type OwTool, type OwToolNeeds, type OwToolOpen, type OwUploadedFile, type OwUploadedImage, OwV2Client, type OwWordPair, type OwWorldFileEntry, OwWorldFileError, type OwWorldFileReason, type OwWorldFileRow, type OwWorldFiles, type OwWorldGraph, type OwWorldIndex, type OwWorldLens, type OwWorldLensReading, type OwWorldLenses, 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, PROPOSED_MARK, PUBLIC_FIELDS, type ParseError, type ParseOptions, type ParseResult, RECORD_FIELD, REVIEW_PROPOSED_LABEL, ROOM_PAIRS, type RevokeAllSessionsResponse, type RevokeSessionResponse, SPATIAL_TYPES, STRAND_FIELD, type SectionInfo, type StepBreakdown, TOOLS, 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, charterOf, dateOf, degreeOf, detectKeyKind, displayYear, domainsOf, doorWhere, doorsOf, dragField, draughtText, editedBy, elementAddress, elementColor, eraForStep, errorFromResponse, familyOf, fieldLabel, fileKindOf, floorDiv, floorMod, formatDuration, formatMidLabel, formatStep, formatYearLabel, getElementIcon, getElementLabel, groupOf, handsOnAsProposed, hasUnseenRecipients, intercalaryInYear, isAddressedTo, isAgentDoor, isCharterElement, isDemoKey, isKnownOf, isLeapYear, isLens, isMessage, isNote, isParseError, isRoomElement, isSentBy, isTemplate, isToEveryone, kindCanWrite, lensesInUse, lookupWorld, monthStartSteps, nfc, noteOf, openersFor, outDegreeOf, parseDate, parseErrorEnvelope, parseOwLink, pinExpectation, pkceChallenge, planPhoto, preparePhoto, proposedMarkOf, readCalendarConfig, readCalendarValue, readMarkOf, readWorldFile, readingAidOf, recipientsOf, recordMarkOf, recordsOf, renderElement, resolveCalendar, resolveCalendarLens, resolveEraDomains, resolveLens, senderStatus, simpleCaseFold, strandOf, threadOf, typeWord, unreadFor, validateCalendarConfig, weekdayForStep, worldCalendars, worldGraph, writeWorldFile, yearLength, yearStartStep };
package/dist/index.js CHANGED
@@ -9,11 +9,13 @@ import {
9
9
  FIELD_SCHEMA,
10
10
  GROUP_COLORS,
11
11
  GROUP_ORDER,
12
+ MAP_SPACE,
12
13
  MESSAGE_PAIR,
13
14
  MESSAGE_READ_MARK,
14
15
  NOTE_PAIR,
15
16
  ONLYWORLDS_VERSION,
16
17
  OwAddressError,
18
+ PROPOSED_MARK,
17
19
  PUBLIC_FIELDS,
18
20
  READING_AID_KEYS,
19
21
  REVIEW_PROPOSED_LABEL,
@@ -24,12 +26,15 @@ import {
24
26
  doorsOf,
25
27
  elementAddress,
26
28
  fold,
29
+ handsOnAsProposed,
27
30
  isAgentDoor,
28
31
  isCharterElement,
32
+ isHiddenMark,
29
33
  isKnownOf,
30
34
  isRoomElement,
31
35
  openersFor,
32
36
  parseOwLink,
37
+ proposedMarkOf,
33
38
  readingAidKey,
34
39
  readingAidOf,
35
40
  refuseUnknownOptions,
@@ -37,7 +42,7 @@ import {
37
42
  trimWhiteSpace,
38
43
  typeWord,
39
44
  unknownKey
40
- } from "./chunk-LSZNKRXL.js";
45
+ } from "./chunk-EVHGSTUB.js";
41
46
 
42
47
  // src/v2/keyed-id.ts
43
48
  var KEYED_IDS = "0199b6a0-6f0e-7c2a-9d1e-3b5c7a8e4f21";
@@ -2497,36 +2502,6 @@ function getElementLabel(elementType) {
2497
2502
  return ELEMENT_LABELS[elementType];
2498
2503
  }
2499
2504
 
2500
- // src/review.ts
2501
- var PROPOSED_MARK = "x_review_proposed";
2502
- var DAY = /^[0-9]{4}-[0-9]{2}-[0-9]{2}$/;
2503
- function todayDay() {
2504
- return (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
2505
- }
2506
- function isPresent(v) {
2507
- if (v === void 0 || v === null) return false;
2508
- if (typeof v === "string") return trimWhiteSpace(v) !== "";
2509
- if (Array.isArray(v)) return v.length > 0;
2510
- if (typeof v === "object") return Object.keys(v).length > 0;
2511
- return true;
2512
- }
2513
- function proposedMarkOf(element, today) {
2514
- if (today !== void 0 && (typeof today !== "string" || !DAY.test(today))) {
2515
- throw new TypeError(`proposedMarkOf: today is a day as YYYY-MM-DD; got ${JSON.stringify(today) ?? String(today)}.`);
2516
- }
2517
- if (!element || typeof element !== "object") return null;
2518
- const v = element[PROPOSED_MARK];
2519
- if (!isPresent(v) || typeof v !== "object" || Array.isArray(v)) return null;
2520
- const m = v;
2521
- const by = typeof m.by === "string" && trimWhiteSpace(m.by) ? trimWhiteSpace(m.by) : null;
2522
- const expires = typeof m.expires === "string" && DAY.test(trimWhiteSpace(m.expires)) ? trimWhiteSpace(m.expires) : null;
2523
- return { by, expires, lapsed: expires !== null && expires <= (today ?? todayDay()) };
2524
- }
2525
- function handsOnAsProposed(element) {
2526
- if (!element || typeof element !== "object") return false;
2527
- return isPresent(element[PROPOSED_MARK]);
2528
- }
2529
-
2530
2505
  // src/message.ts
2531
2506
  var ADDRESSING_KEYS = ["keyless"];
2532
2507
  var isBody = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
@@ -2693,7 +2668,7 @@ function threadOf(messages, rootId) {
2693
2668
  };
2694
2669
  return inCreatedOrder(messages.filter((m) => isBody(m) && !isNote(m) && reaches(m)));
2695
2670
  }
2696
- var isHiddenMark = (value) => value !== void 0 && value !== null && value !== false;
2671
+ var isHiddenMark2 = (value) => value !== void 0 && value !== null && value !== false;
2697
2672
  function noteOf(narratives, characterId, members) {
2698
2673
  if (!Array.isArray(narratives) || typeof characterId !== "string" || characterId === "") return null;
2699
2674
  let line = null;
@@ -2703,7 +2678,7 @@ function noteOf(narratives, characterId, members) {
2703
2678
  const note = el;
2704
2679
  const id = idOf(note);
2705
2680
  if (typeof id !== "string" || id === "" || note.narrator !== characterId) continue;
2706
- if (isHiddenMark(note.hidden) || proposedMarkOf(note) !== null || !isOwnHand(note, characterId, members)) continue;
2681
+ if (isHiddenMark2(note.hidden) || proposedMarkOf(note) !== null || !isOwnHand(note, characterId, members)) continue;
2707
2682
  const key = timeKey(note.created_at);
2708
2683
  if (line === null || (key !== null ? lineKey === null || compareKeys(key, lineKey) >= 0 : lineKey === null)) {
2709
2684
  line = id;
@@ -2940,7 +2915,7 @@ var Reading = class {
2940
2915
  this.byId.set(el.id, el);
2941
2916
  this.typeOf.set(el.id, type);
2942
2917
  this.order.push(el.id);
2943
- if (el.hidden !== void 0 && el.hidden !== null && el.hidden !== false) hidden.add(el.id);
2918
+ if (isHiddenMark(el)) hidden.add(el.id);
2944
2919
  if (isRoomElement(el)) this.room.add(el.id);
2945
2920
  const aid = readingAidKey(el);
2946
2921
  if (aid !== null) this.aid.set(el.id, aid);
@@ -3614,7 +3589,6 @@ function recordsOf(characterId, elements) {
3614
3589
  // src/graph.ts
3615
3590
  var GRAPH_OPTION_KEYS = ["lens", "asOf", "clock", "rooms", "hidden", "proposed", "mapSpace"];
3616
3591
  var DECLARED_LINKS = ["x_lens_leads_to", "x_spine_depends_on"];
3617
- var MAP_SPACE = /* @__PURE__ */ new Set(["map", "pin", "marker"]);
3618
3592
  var GRAPH_REASONS = [...CUT_REASONS, "room", "hidden", "proposed", "map_space", "reading_aid", "outside_lens"];
3619
3593
  var GRAPH_OWNER_ONLY = /* @__PURE__ */ new Set([...OWNER_ONLY, "hidden", "proposed"]);
3620
3594
  function flag(opts, key) {
package/dist/waymark.d.ts CHANGED
@@ -1,3 +1,6 @@
1
+ /** One reason a lore view leaves an element out, as the graph section names it. */
2
+ type OwElementMark = 'room' | 'hidden' | 'proposed' | 'map_space' | 'reading_aid';
3
+
1
4
  /** What a person must have before a tool's link works: signed in to the tool (`account`), or the world already in the tool on this device (`device`). */
2
5
  type OwToolNeeds = 'account' | 'device';
3
6
  /** A tool's `open` in the tools list: its link templates and what they need first. */
@@ -8,6 +11,8 @@ interface OwToolOpen {
8
11
  element: string | null;
9
12
  /** What the person needs first; null for nothing, which is the one kind of row a public page offers. */
10
13
  needs: OwToolNeeds | null;
14
+ /** What the element door does not open, in the graph section's words; [] or absent: it opens every element (a list older than the key has none). */
15
+ element_skips?: readonly OwElementMark[];
11
16
  }
12
17
  /** The keys of one tools list row that `openersFor` reads; a row straight from `tools.json` carries more, and they are ignored. */
13
18
  interface OwTool {
package/dist/waymark.js CHANGED
@@ -6,7 +6,7 @@ import {
6
6
  openersFor,
7
7
  refuseUnknownOptions,
8
8
  typeWord
9
- } from "./chunk-LSZNKRXL.js";
9
+ } from "./chunk-EVHGSTUB.js";
10
10
 
11
11
  // src/waymark/glyphs.ts
12
12
  var MARK_PATH = "M48.8 0.0 43.8 0.4 39.0 1.2 36.0 2.0 33.2 2.9 29.3 4.5 24.8 6.8 20.6 9.5 17.0 12.4 13.6 15.7 10.4 19.4 7.8 23.1 5.8 26.6 4.5 29.3 3.3 32.1 1.8 36.8 0.8 41.2 0.1 46.3 0.0 51.1 0.4 56.2 1.2 61.0 2.0 63.9 2.9 66.8 4.5 70.7 6.8 75.2 9.5 79.4 12.4 82.9 15.7 86.3 19.4 89.5 23.1 92.1 26.6 94.2 29.3 95.5 32.1 96.7 36.8 98.2 41.2 99.2 46.3 99.8 51.1 100.0 56.2 99.6 61.0 98.8 63.9 98.0 66.8 97.1 70.7 95.5 75.2 93.2 79.4 90.4 82.9 87.6 86.3 84.3 89.5 80.5 92.1 76.9 94.2 73.4 95.5 70.7 96.7 67.9 98.2 63.2 99.2 58.7 99.8 53.7 100.0 48.8 99.6 43.8 98.6 38.4 97.1 33.2 95.5 29.3 93.2 24.8 90.4 20.6 87.6 17.0 84.3 13.6 80.5 10.4 76.9 7.8 73.4 5.8 70.7 4.5 67.9 3.3 63.2 1.8 58.7 0.8 53.7 0.1ZM77.5 80.7 74.1 83.4 70.7 85.7 67.0 87.5 64.5 88.6 64.1 88.7 65.7 86.3 67.1 83.9 68.7 80.7 69.9 77.6 72.7 78.5 73.0 78.4ZM22.5 80.7 25.6 79.0 27.3 78.3 30.0 77.6 31.3 80.7 32.8 83.9 34.2 86.3 35.9 88.7 32.9 87.5 29.3 85.7 25.8 83.4ZM51.2 74.5 55.1 74.7 59.9 75.2 64.2 76.0 67.5 76.9 66.0 80.5 64.2 84.0 62.0 87.4 59.6 90.1 55.1 90.9 52.2 91.2 51.2 91.1ZM48.7 74.5 48.8 91.1 47.7 91.2 44.9 90.9 40.3 90.1 38.2 87.8 36.3 85.0 34.2 81.2 32.5 77.0 35.8 76.0 40.5 75.2 44.5 74.7ZM91.1 51.2 91.1 52.9 90.8 56.3 90.1 59.7 89.3 62.5 88.5 64.8 87.2 67.7 85.7 70.7 83.9 73.4 82.0 75.9 79.4 78.9 76.3 77.2 73.8 76.1 76.2 68.8 77.8 62.7 78.7 56.8 79.0 51.2ZM55.8 51.2 67.7 51.2 67.6 55.1 67.2 59.0 66.7 61.5 65.7 65.0 61.0 64.2 55.7 63.6ZM32.5 51.2 44.5 51.2 44.4 63.6 39.7 64.1 34.5 65.0 33.5 61.3 32.9 58.1 32.5 54.2ZM8.8 51.2 21.0 51.2 21.0 53.3 21.4 56.6 22.7 64.0 23.8 68.4 25.0 72.1 26.6 75.9 23.7 77.2 20.6 78.9 18.5 76.7 16.5 74.1 14.8 71.5 13.4 69.1 12.1 66.3 11.0 63.6 10.1 60.5 9.4 57.3 8.9 53.5 8.8 51.3ZM36.2 27.0 39.5 27.5 44.5 28.2 44.4 48.8 32.4 48.7 32.8 44.5 33.6 39.1 35.0 32.0ZM63.9 26.9 65.2 32.1 66.6 39.2 67.4 44.8 67.7 48.7 55.8 48.8 55.7 28.1 60.5 27.5ZM74.8 23.4 76.9 22.5 79.4 21.1 82.0 24.0 84.8 27.8 86.2 30.3 87.5 32.9 88.6 35.4 89.5 38.1 90.3 41.2 90.8 44.0 91.1 47.0 91.1 48.8 79.0 48.7 78.7 44.6 78.0 39.3 76.5 31.2 74.7 23.5ZM25.5 23.5 25.5 23.7 24.5 26.8 23.7 30.2 22.4 36.6 21.5 42.5 21.1 48.7 8.8 48.8 8.8 47.0 9.2 43.7 9.8 40.8 10.5 38.1 11.5 35.2 12.4 32.9 13.8 30.2 15.2 27.8 17.9 24.0 20.6 21.1 23.1 22.5ZM64.1 11.3 67.0 12.4 70.7 14.3 74.1 16.5 77.5 19.3 75.6 20.3 73.2 21.5 70.0 22.6 68.7 19.2 67.1 16.1 65.7 13.6ZM35.9 11.3 34.2 13.6 32.8 16.1 31.3 19.2 30.0 22.5 27.9 21.9 26.4 21.3 22.5 19.3 25.8 16.5 29.3 14.3 32.9 12.4 35.4 11.4ZM51.2 8.8 52.2 8.8 55.1 9.0 59.6 9.9 61.7 12.2 64.2 16.0 66.0 19.5 67.6 23.3 64.3 24.3 59.4 25.2 56.2 25.6 51.2 25.5ZM48.8 8.8 48.7 25.5 44.2 25.6 40.6 25.2 36.4 24.5 32.4 23.2 33.9 19.5 35.7 16.0 38.2 12.2 40.3 9.9 44.9 9.0 47.7 8.8Z";
@@ -110,7 +110,7 @@ function mountWaymark(target, options) {
110
110
  const isPublic = reader === "public";
111
111
  const kind = element === null ? "world" : "element";
112
112
  const address = element === null ? { form: "human", world: world.id } : { form: "human", world: world.id, type: element.type, id: element.id };
113
- const rowsFor = (online) => openersFor(tools, kind, address, { tool, audience: isPublic ? "public" : "member", signedIn, browser, phone, online });
113
+ const rowsFor = (online) => openersFor(tools, kind, address, { tool, audience: isPublic ? "public" : "member", signedIn, browser, phone, online }, { element });
114
114
  const rowsOnline = rowsFor(true);
115
115
  const rowsOffline = rowsFor(false);
116
116
  const throughLenses = isPublic ? [] : [...lenses ?? []];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onlyworlds/sdk",
3
- "version": "4.125.0",
3
+ "version": "4.126.0",
4
4
  "description": "TypeScript SDK for the OnlyWorlds API - build world-building applications with type safety",
5
5
  "type": "module",
6
6
  "exports": {