@onlyworlds/sdk 4.113.0 → 4.114.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/dist/index.d.ts CHANGED
@@ -5188,7 +5188,7 @@ interface OwLensReader {
5188
5188
  /** The world snapshot a lens is resolved over: the elements as the owner is served them. */
5189
5189
  interface OwLensWorld {
5190
5190
  elements: readonly object[];
5191
- /** Ids the hidden mark keeps from every reader but the owner, beside each element's own `hidden`. */
5191
+ /** Ids the hidden mark keeps from every reader but the owner, beside each element's own `hidden`; the two are one mark, and a full row of an element under it carries `hidden: true`. */
5192
5192
  hidden?: readonly string[] | null;
5193
5193
  /** The world's members list (`client.members()`), which proves a message's sender for the mail rule. */
5194
5194
  members?: readonly OwMessageMember[] | null;
@@ -5231,7 +5231,12 @@ interface OwLensMail {
5231
5231
  interface OwLensReading {
5232
5232
  /** The kept elements' ids, in the profile's order. */
5233
5233
  kept: string[];
5234
- /** The kept elements as `show` makes them, in the same order; an anchor's row carries its `note`. */
5234
+ /**
5235
+ * The kept elements as `show` makes them, in the same order; an anchor's row carries its `note`, and only an anchor
5236
+ * the reader can see: a note on one it cannot see (an id of another type than its field's too) goes with the
5237
+ * anchor, though another path keeps the element. Under `full` a row is the body as served to this reader, so the
5238
+ * owner's row of a hidden element carries `hidden: true`; a `name` or `first_line` row never carries it.
5239
+ */
5235
5240
  rows: Record<string, unknown>[];
5236
5241
  /** The cut, counted by reason; a reason with no count is absent, and a reader that is not the owner never carries the owner's two. */
5237
5242
  cut: Partial<Record<OwLensCutReason, number>>;
@@ -5292,7 +5297,9 @@ declare function lensesInUse(membership: readonly string[] | null | undefined, x
5292
5297
  * hopped on from, only when `types` names its pair, while one the lens names as an anchor is kept and
5293
5298
  * followed; anchors first in link order, then by type in the schema's order, newest first, then by id;
5294
5299
  * an anchor the reader cannot see (an id naming no element, or one of another type than its field's, too)
5295
- * is skipped and counted for the owner (`anchor_not_visible`); a template resolves to nothing; the fence is `as_of` on
5300
+ * is skipped and counted for the owner (`anchor_not_visible`, before any other reason), while for any other reader
5301
+ * it is not there at all, so a child lens's cut of the same element counts under the child's reason; a template
5302
+ * resolves to nothing; the fence is `as_of` on
5296
5303
  * each element's own date; `changed_within` cuts what a hop or a filter reaches that changed longer ago
5297
5304
  * than that many days before `clock` (`stale`), never an anchor. A value outside the profile's table makes
5298
5305
  * the lens unreadable: `unreadable` names the key and nothing is resolved.
@@ -5791,12 +5798,6 @@ interface OwReadWorldFileOptions {
5791
5798
  /** Leave a file out of `files` (a path relative to the world's folder). It is still checked and counted. */
5792
5799
  skip?: (path: string) => boolean;
5793
5800
  }
5794
- /**
5795
- * Simple case folding (Unicode 15.1, CaseFolding.txt C and S), code point by
5796
- * code point: what OW-18 applies after NFC. A code point the table does not
5797
- * map folds to itself.
5798
- */
5799
- declare function simpleCaseFold(text: string): string;
5800
5801
  /**
5801
5802
  * Read a world file. Throws `OwWorldFileError` saying why, having returned
5802
5803
  * nothing; the caller writes only what this returns. An unknown option is a
@@ -5898,6 +5899,13 @@ declare function writeWorldFile(files: OwWorldFileEntry[], topDir: string, opts?
5898
5899
  */
5899
5900
  declare function nfc(text: string): string;
5900
5901
 
5902
+ /**
5903
+ * Simple case folding (Unicode 15.1, CaseFolding.txt C and S), code point by
5904
+ * code point: what OW-18 applies after NFC. A code point the table does not
5905
+ * map folds to itself.
5906
+ */
5907
+ declare function simpleCaseFold(text: string): string;
5908
+
5901
5909
  /**
5902
5910
  * World lookup: find the elements a plain-language question is about, in a
5903
5911
  * world held in memory, with no model and no network. Ported from the