@crossworks/client-types 0.400.28 → 0.400.29

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/src/tree.ts CHANGED
@@ -111,24 +111,24 @@ export type TreeFolder = {
111
111
  depth: number;
112
112
  /** The parent folder; null at the top level. */
113
113
  parentId: string | null;
114
- /** DEPRECATED (W5b2): folder shares are frozen and grants decide who
114
+ /** DEPRECATED: folder shares are frozen and grants decide who
115
115
  * reads (`workspaces`). The brain's tree no longer sends it; a member's
116
116
  * own folder still sends null. */
117
117
  share?: TreeShareLevel | null;
118
- /** DEPRECATED (W5b2): no longer sent by the brain's tree. */
118
+ /** DEPRECATED: no longer sent by the brain's tree. */
119
119
  inherited?: TreeShareLevel | null;
120
120
  /** Made by Mantle (Auto-filed): the name is locked and it cannot be shared. */
121
121
  system: boolean;
122
122
  folderCount: number;
123
123
  itemCount: number;
124
- /** Asked with `?ws=<id>` (task f26a516e): the items in the folder that
124
+ /** Asked with `?ws=<id>`: the items in the folder that
125
125
  * the caller reads in its other workspaces and `ws` does not read. They
126
126
  * are not in `itemCount`; a client may still open the folder to say
127
127
  * where they are (TreeFolderPage `elsewhere`). Absent without `ws`, and
128
128
  * from a brain before it. */
129
129
  itemsElsewhere?: number;
130
130
  /** The workspaces that read the folder (ListChips): filled by the owner's
131
- * tree routes; empty in the member tree until W5c. */
131
+ * tree routes. */
132
132
  workspaces: ListWorkspace[];
133
133
  /** A live open public link exists. */
134
134
  hasLink: boolean;
@@ -165,18 +165,18 @@ export type TreeItem = {
165
165
  /** A short kind-specific token for the status slot: a file's extension, a
166
166
  * secret's kind, an event's start. Null when the kind has none. */
167
167
  subtype: string | null;
168
- /** DEPRECATED (W5b2): the tier levels are frozen and grants decide who
168
+ /** DEPRECATED: the tier levels are frozen and grants decide who
169
169
  * reads (`workspaces`, `hasLink`). The brain's tree no longer sends it. */
170
170
  level?: AccessLevel;
171
- /** DEPRECATED (W5b2): no longer sent. */
171
+ /** DEPRECATED: no longer sent. */
172
172
  inherited?: TreeShareLevel | null;
173
- /** DEPRECATED (W5b2): no longer sent. */
173
+ /** DEPRECATED: no longer sent. */
174
174
  embedded?: TreeShareLevel | null;
175
175
  state: TreeItemState | null;
176
176
  updatedAt: string;
177
177
  meta?: TreeItemMeta;
178
178
  /** The workspaces that read the item (ListChips): filled by the owner's
179
- * tree routes; empty in the member tree until W5c. */
179
+ * tree routes. */
180
180
  workspaces: ListWorkspace[];
181
181
  /** A live open public link exists (the "Public" pill). */
182
182
  hasLink: boolean;
@@ -215,7 +215,7 @@ export type TreeFolderPage = {
215
215
  * workspace reads; the folders stay (the way to them). */
216
216
  ws?: string;
217
217
  /** Asked with `?ws=<id>`, on the first page of a folder where `ws` reads
218
- * no item (task f26a516e): the caller's other workspaces that read items
218
+ * no item: the caller's other workspaces that read items
219
219
  * in this same folder, with how many, most first. Only workspaces the
220
220
  * caller is a user of, and only items its scope reads. Absent when there
221
221
  * are none, and from a brain before it. */
@@ -224,13 +224,12 @@ export type TreeFolderPage = {
224
224
 
225
225
  /** Narrowing for GET /api/tree/:kind/search (`ws=`, `tag=`), the tree's
226
226
  * filter menu. Both optional; together they both apply. A filtered search
227
- * lists items only, no folders. The level filter went with the levels
228
- * (W5b2). */
227
+ * lists items only, no folders. There is no level filter. */
229
228
  export type TreeFilter = {
230
229
  /** Only items this workspace reads (its id is in their read_ws). With
231
230
  * `across`, the switcher's workspace instead: its items come first. */
232
231
  ws?: string;
233
- /** `across=1` (task f26a516e): a search with a term looks in every
232
+ /** `across=1`: a search with a term looks in every
234
233
  * workspace the caller reads; `ws` then orders the items (its own
235
234
  * first) and narrows nothing, and the folders that match come too. Each
236
235
  * item names the workspace it opens in (`workspace`). An empty term (the
@@ -273,8 +272,8 @@ export type TreeMarkList = {
273
272
  items: Array<TreeItem & { crumbs: TreeCrumb[] }>;
274
273
  };
275
274
 
276
- /** One item a tree write would change (W5b2: in workspaces, from the
277
- * grants). A new item is compared with one at the kind's root (Admin). */
275
+ /** One item a tree write would change (in workspaces, from the grants). A
276
+ * new item is compared with one at the kind's root (Admin). */
278
277
  export type TreeWorkspaceChange = {
279
278
  /** '' for an item not made yet (a create or upload). */
280
279
  id: string;
@@ -283,7 +282,7 @@ export type TreeWorkspaceChange = {
283
282
  alsoVisibleTo: GrantWorkspaceRef[];
284
283
  /** The workspaces that would no longer read it. */
285
284
  removedFrom: GrantWorkspaceRef[];
286
- /** An item not made yet: the workspace it will be homed in (A0). */
285
+ /** An item not made yet: the workspace it will be homed in. */
287
286
  home?: GrantWorkspaceRef;
288
287
  /** An item not made yet: those of `alsoVisibleTo` that will read it but
289
288
  * not edit it (a folder's rows with Write off, the folder's own home
@@ -291,8 +290,8 @@ export type TreeWorkspaceChange = {
291
290
  readOnly?: GrantWorkspaceRef[];
292
291
  };
293
292
 
294
- /** A level change, as the member review's accept still lists it (until
295
- * W5c). The tree's own refusal lists TreeWorkspaceChange. */
293
+ /** A level change, as the member review's accept listed it. The tree's own
294
+ * refusal lists TreeWorkspaceChange. */
296
295
  export type TreeVisibilityChange = {
297
296
  id: string;
298
297
  title: string;
@@ -313,10 +312,10 @@ export type TreeVisibilityRefusal = {
313
312
  changes: TreeWorkspaceChange[];
314
313
  /** How many items change in all. */
315
314
  total: number;
316
- /** @deprecated Never sent since W5b2: embeds no longer open with what
315
+ /** @deprecated Never sent: embeds no longer open with what
317
316
  * embeds them (grants are never added for you). */
318
317
  alsoEmbeds?: TreeVisibilityChange[];
319
- /** @deprecated Never sent since W5b2. */
318
+ /** @deprecated Never sent. */
320
319
  embedsTotal?: number;
321
320
  /** @deprecated Never sent: an unreleased first form of `alsoEmbeds`, when
322
321
  * a share still lowered embeds for good. */
@@ -24,10 +24,10 @@ function flagOn(raw: string | undefined): boolean {
24
24
  /** Server-side master gate: the SSE/cancel routes exist and the POST turn route
25
25
  * goes non-blocking. Off only when `MANTLE_TURN_STREAMING` is explicitly falsy.
26
26
  * Honours the legacy name `NEXT_PUBLIC_MANTLE_TURN_STREAMING` when the new
27
- * one is unset, exactly as `env()` does (@mantle/config ENV_ALIASES): until
28
- * A10 #11 this reader ignored it while the replay buffer honoured it, so a
29
- * box setting only the legacy name to 0 served the stream routes with no
30
- * buffer behind them. The brain reads `feature('turnStreaming')`; this stays
27
+ * one is unset, exactly as `env()` does (@mantle/config ENV_ALIASES): the
28
+ * replay buffer honours it too, and a reader that ignored it would serve
29
+ * the stream routes with no buffer behind them on a box that sets only the
30
+ * legacy name to 0. The brain reads `feature('turnStreaming')`; this stays
31
31
  * for the published contract. */
32
32
  export function isTurnStreamingEnabled(): boolean {
33
33
  return flagOn(process.env.MANTLE_TURN_STREAMING ?? process.env.NEXT_PUBLIC_MANTLE_TURN_STREAMING);
@@ -1,13 +1,9 @@
1
1
  /**
2
- * Wire shapes for the owner Recall API (roadmap tasks 073b322d / 91c93428;
3
- * docs/recall.md in the mantle repo). Dates are ISO strings.
2
+ * Wire shapes for the owner Recall API (docs/recall.md in the mantle repo).
3
+ * Dates are ISO strings.
4
4
  *
5
5
  * A map is one `recall` item in the tree; its cards are rows written
6
- * directly, and a card's `id` is its own, NOT a page. (Page-built v1 maps,
7
- * compiled from a page tree, were retired in R5: the compile report, the
8
- * page state route and `lastCompileOk` went with them.)
9
- *
10
- * Plan: "PLAN: Recall v2, its own content type" (dev brain, task 5d6ce06a).
6
+ * directly, and a card's `id` is its own, NOT a page.
11
7
  *
12
8
  * Whether a brain can serve Recall at all is `features.recallV2` from
13
9
  * `GET /api/shell`, absent on a brain older than v2. Branch the SCREEN on