@crossworks/client-types 0.232.329 → 0.232.334

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crossworks/client-types",
-  "version": "0.232.329",
+  "version": "0.232.334",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",

package/src/dto/access.ts

@@ -33,8 +33,15 @@ export type AccessLinkView = {
 /** GET /api/access/nodes/:id */
 /** Who wrote a brain item, when a member wrote it and an admin accepted it
  *  (member logins Phase 4): the member-authored badge. `name` is the login's
- *  display name ("A member" without one, "Removed member" once deleted). */
-export type MemberItemAuthor = { name: string; acceptedAt: string | null };
+ *  display name ("A member" without one, "A client" for a client without
+ *  one, "Removed member" once deleted). `role` (0.232.333 on) names the
+ *  author's role: show "Client", never "A member", for a client (client
+ *  logins audit B26); null once the login is deleted. */
+export type MemberItemAuthor = {
+  name: string;
+  acceptedAt: string | null;
+  role?: 'member' | 'client' | null;
+};
 
 export type AccessNodeView = {
   item: AccessItemView;

package/src/dto/client.ts

@@ -35,7 +35,9 @@ export type ClientSharedRow = {
   type: MemberItemKind;
   title: string;
   icon: string | null;
-  summary: string | null;
+  /** Never sent since 0.232.333 (it was built from the unredacted text); do
+   *  not show it. Optional only so older clients still compile. */
+  summary?: string | null;
   updatedAt: string;
 };
 
@@ -54,7 +56,7 @@ export type ClientSharedPage = {
 export type ClientSharedItem =
   | (ClientSharedRow & { type: 'page'; doc: unknown })
   | (ClientSharedRow & { type: 'note'; content: string })
-  | (ClientSharedRow & { type: 'table'; table: unknown })
+  | (ClientSharedRow & { type: 'table'; table: ClientSharedTable })
   | (ClientSharedRow & { type: 'draw' })
   | (ClientSharedRow & {
       type: 'file';
@@ -63,6 +65,39 @@ export type ClientSharedItem =
       sizeBytes: number | null;
     });
 
+/** One column of a client table: what the grid draws a header and a cell
+ *  with. No formula, no reference source, no options. */
+export type ClientSharedTableColumn = { id: string; name: string; type: string };
+
+/** One committed row of a client table. A cell that names an item the
+ *  client may not read (`/n/<id>`, `page:`, `media:`, `draw:`, `mention:`)
+ *  arrives as "Private item". */
+export type ClientSharedTableRow = {
+  id: string;
+  cells: Record<string, string | number | boolean | string[] | null>;
+};
+
+/** A client table (GET /api/client/shared/:id, type table): the committed
+ *  grid of one tab and nothing else about the table (no description, tags,
+ *  summary, visibility, level, app link or draft). The shape the member
+ *  reader draws (`data`, `docClipped`, `tabs`, `tabId`), so one viewer reads
+ *  both. `data` is a leading window when `docClipped`; `rowCount` is the
+ *  tab's true total. */
+export type ClientSharedTable = {
+  data: {
+    columns: ClientSharedTableColumn[];
+    rows: ClientSharedTableRow[];
+    /** Footer totals the owner set, by column id. */
+    aggregates?: Record<string, string>;
+  };
+  docClipped?: boolean;
+  /** The workbook's tabs in order (absent for a one-grid table). */
+  tabs?: { id: string; name: string; rows: number; columns: number }[];
+  /** Which tab `data` holds. */
+  tabId?: string | null;
+  rowCount?: number;
+};
+
 /** The label a client sees instead of a reference it may not read. */
 export const CLIENT_PRIVATE_LABEL = 'Private item';
 
@@ -104,7 +139,9 @@ export type ClientLoginCreated = { client: ClientLoginRow };
 
 /** POST /api/team-admin/clients/:id/signin-link -> the link, ONCE. `path` is
  *  the client-app path to hand the client (the code is its only secret);
- *  72 hours, one use. Any older open link of the login is revoked. */
+ *  72 hours, one use. Any older open link of the login is revoked. Since
+ *  0.232.333 the code rides in the fragment (`/client-signin#code=...`), so
+ *  it never reaches a server log; links issued before carry `?code=`. */
 export type ClientSigninLinkCreated = {
   link: ClientSigninLinkRow;
   code: string;
@@ -118,7 +155,10 @@ export type ClientAdminRefusedReason =
   | 'contact-not-found'
   | 'contact-has-login'
   | 'no-email'
-  | 'not-a-client';
+  | 'not-a-client'
+  /** A contact-linked client's email must be one of the contact's addresses
+   *  (the mail gates know the client by its contact; audit B26). */
+  | 'email-not-on-contact';
 
 /** POST /api/auth/client-link { code, email } -> 200 { ok: true } and the
  *  session cookie (30 days), or one uniform 401 for every failure. */
@@ -159,7 +199,28 @@ export type ClientSigninSender = {
   dailyCap: number;
   sentLast24h: number;
   capReached: boolean;
+  /** Codes actually handed to the mail server in the last 24 h (sentLast24h counted failed ones too; it now equals this). */
+  deliveredLast24h?: number;
+  /** Sends that failed in the last 24 h, and the newest failure. */
+  failedLast24h?: number;
+  lastFailure?: { at: string; reason: string } | null;
+  /** False when no email worker serves the code queue on this box: codes are then OFF whatever the sender. */
+  emailWorker?: boolean;
+  /** Requests that were skipped because a cap was hit in the last 24 h (per email, per address or brain-wide). */
+  capSkipsLast24h?: number;
+};
+
+/** GET /api/team-admin/clients/signin-sender/preview?accountId=<id>: what
+ *  choosing that account as the sender would do, before the admin confirms.
+ *  Choosing None (or another sender) later RESTORES the folders the choice
+ *  left out (the server remembers exactly which it added). */
+export type ClientSigninSenderPreview = {
+  /** The folders that choosing this sender will leave out of mail sync. Empty + canUse false = refused. */
+  sentFolders: string[];
+  canUse: boolean;
+  reason?: 'no-sent-folder' | 'folders-unreadable' | 'account-cannot-send';
 };
 
 /** Why an admin's sender choice was refused (the 4xx `reason`). */
-export type ClientSenderRefusedReason = 'account-not-found' | 'account-cannot-send';
+export type ClientSenderRefusedReason =
+  'account-not-found' | 'account-cannot-send' | 'no-sent-folder' | 'folders-unreadable';

package/src/dto/member-apps.ts

@@ -56,8 +56,13 @@ export type MemberChatRow = {
   name: string;
   email: string;
   /** False when the login is disabled or no longer a member (its old
-   *  thread still shows). */
+   *  thread still shows). Always false for a client: a client is never a
+   *  team member (client logins audit B26). */
   active: boolean;
+  /** The login's role, named (0.232.333 on): 'member' for the team; 'client'
+   *  for a client login with a chat thread, which is NOT a team member; absent
+   *  for a former member who is an admin now (its old thread still shows). */
+  role?: 'member' | 'client';
   lastMessageAt: string | null;
   lastMessageText: string | null;
   lastMessageDirection: 'inbound' | 'outbound' | null;

package/src/dto/member-invites.ts

@@ -37,7 +37,8 @@ export type MemberInviteList = { invites: MemberInviteRow[] };
 /**
  * POST /api/team-admin/invites (201). `code` and `linkPath` are shown ONCE:
  * only the code's hash is stored. `linkPath` is a client-app path
- * (`/invite?code=…`); prefix the client's origin to share it.
+ * (`/invite#code=...` since 0.232.333: the fragment never reaches a server
+ * log; `/invite?code=…` before); prefix the client's origin to share it.
  */
 export type MemberInviteCreated = {
   invite: MemberInviteRow;

package/src/dto/member.ts

@@ -6,6 +6,7 @@
  */
 import type { AccessLevel, MemberItemAuthor } from './access';
 import type { MemberItemKind } from '../member-kinds';
+export type { MemberItemFilter } from '../member-kinds';
 
 /** GET /api/member/shell */
 export type MemberShell = {
@@ -109,6 +110,8 @@ export type MemberSpaceItemRow = {
   returnedNote: string | null;
   /** The login that wrote it (team drafts show whose it is). */
   authorLoginId: string | null;
+  /** Brains from the item-list alignment release on. */
+  createdAt?: string;
   updatedAt: string;
 };
 
@@ -247,3 +250,69 @@ export type MemberAcceptedItem =
       sizeBytes: number | null;
       changedByAdmin?: boolean;
     });
+
+// ── One list of everything a member can see (item-list alignment) ───────
+
+/** Where a row of the one list comes from; it picks the item view that
+ *  opens it: `own` the member's editor, `team` a teammate's saved draft,
+ *  `library` the brain item, `accepted` the version this member wrote and an
+ *  admin accepted at a level above the Library's (admin or public). */
+export type MemberItemSource = 'own' | 'team' | 'library' | 'accepted';
+
+/** The small state pill a row wears beside its actions. Brain items (the
+ *  Library and accepted rows) wear none. */
+export type MemberItemPill = 'private' | 'draft' | 'submitted' | 'returned' | 'with-admin';
+
+/** One row of GET /api/member/items. */
+export type MemberItemRow = {
+  id: string;
+  type: MemberItemKind;
+  title: string;
+  icon: string | null;
+  summary: string | null;
+  updatedAt: string;
+  source: MemberItemSource;
+  pill: MemberItemPill | null;
+  /** The brain item's level (library and accepted rows); null on a draft. */
+  audience: AccessLevel | null;
+  /** A brain item a member wrote and an admin accepted: whose it is. */
+  author: MemberItemAuthor | null;
+  /** This member wrote it and an admin accepted it. */
+  byMe: boolean;
+  /** The personal-space row (own and team rows): sharing, review state, the
+   *  returned note, for the item view and the detail header. */
+  space: MemberSpaceItemRow | null;
+};
+
+/**
+ * GET /api/member/items?kind=&q=&state=&page= (brains from the item-list
+ * alignment release): the member's own items, teammates' shared drafts, the
+ * Library and their accepted items above it, in ONE list, newest first.
+ * `state` is a MemberItemFilter (default `all`). Absent on older brains: the
+ * client then falls back to the four source lists.
+ */
+export type MemberItemsPage = {
+  items: MemberItemRow[];
+  total: number;
+  page: number;
+  pageSize: number;
+};
+
+/**
+ * The calling admin's own private item as a row of a BRAIN list (item-list
+ * alignment): /api/pages, /api/notes, /api/tables, /api/draws and the files
+ * root and Recent lists, with `?state=all` or `?state=private`. The
+ * `private` key marks it (brain rows never carry it) and holds the space
+ * row the item view opens; the item itself is read and written through
+ * /api/admin/space. Private items have no tags and no parent: a tag filter
+ * or a sub-page level lists none.
+ */
+export type AdminPrivateListRow = {
+  id: string;
+  type: MemberItemKind;
+  title: string;
+  icon: string | null;
+  createdAt: string;
+  updatedAt: string;
+  private: AdminSpaceItemRow;
+};

package/src/index.ts

@@ -58,6 +58,7 @@ export type {
   ReviewAuthorView,
 } from './dto/review';
 export type {
+  AdminPrivateListRow,
   AdminSpaceItem,
   AdminSpaceItemRow,
   AdminSpaceList,
@@ -70,6 +71,11 @@ export type {
   MemberAcceptedRow,
   MemberChatMessage,
   MemberChatThread,
+  MemberItemFilter,
+  MemberItemPill,
+  MemberItemRow,
+  MemberItemSource,
+  MemberItemsPage,
   MemberLibraryItem,
   MemberLibraryKind,
   MemberLibraryPage,
@@ -118,6 +124,7 @@ export type {
   ClientCodeSignIn,
   ClientSigninSenderCandidate,
   ClientSigninSender,
+  ClientSigninSenderPreview,
   ClientSenderRefusedReason,
   ClientLoginCreated,
   ClientLoginList,
@@ -125,6 +132,9 @@ export type {
   ClientSharedItem,
   ClientSharedPage,
   ClientSharedRow,
+  ClientSharedTable,
+  ClientSharedTableColumn,
+  ClientSharedTableRow,
   ClientShell,
   ClientSigninLinkCreated,
   ClientSigninLinkRow,

package/src/member-kinds.ts

@@ -10,3 +10,37 @@ export type MemberItemKind = (typeof MEMBER_ITEM_KINDS)[number];
 export function isMemberItemKind(v: unknown): v is MemberItemKind {
   return typeof v === 'string' && (MEMBER_ITEM_KINDS as readonly string[]).includes(v);
 }
+
+/** The State filter of a member's one list (GET /api/member/items?state=):
+ *  `all`, one row pill, `brain` (the rows without a pill), or `by-me` (what
+ *  this member wrote and an admin accepted, at any level). A runtime constant
+ *  for the same reason as the kinds: the brain parses it, the client offers
+ *  it. */
+export const MEMBER_ITEM_FILTERS = [
+  'all',
+  'private',
+  'draft',
+  'submitted',
+  'returned',
+  'with-admin',
+  'brain',
+  'by-me',
+] as const;
+export type MemberItemFilter = (typeof MEMBER_ITEM_FILTERS)[number];
+
+export function isMemberItemFilter(v: unknown): v is MemberItemFilter {
+  return typeof v === 'string' && (MEMBER_ITEM_FILTERS as readonly string[]).includes(v);
+}
+
+/** Which items an ADMIN's brain list holds (`?state=` on /api/pages, /notes,
+ *  /tables, /draws and the files lists): `brain` (the default, as before),
+ *  `private` (the admin's own private items only) or `all` (both, merged in
+ *  the list's own order). */
+export const ADMIN_LIST_STATES = ['brain', 'private', 'all'] as const;
+export type AdminListState = (typeof ADMIN_LIST_STATES)[number];
+
+export function adminListStateOf(v: unknown): AdminListState {
+  return typeof v === 'string' && (ADMIN_LIST_STATES as readonly string[]).includes(v)
+    ? (v as AdminListState)
+    : 'brain';
+}