@crossworks/client-types 0.232.333 → 0.232.335

package/package.json

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

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,

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';
+}