@crossworks/client-types 0.300.17 → 0.300.21

package/package.json

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

package/src/dto/grants.ts

@@ -10,8 +10,9 @@
  * panel. Every refusal is `{ error, code }` with 400, 403, 404 or 409; an
  * item or workspace the caller may not see answers 404, never 403.
  *
- * Pure: no imports.
+ * Pure: types only (a workspace chip's look comes from ./workspaces).
  */
+import type { WorkspaceLook } from './workspaces';
 
 /** A workspace as the panel names it. */
 export type GrantWorkspaceRef = { wsId: string; name: string };
@@ -189,8 +190,9 @@ export type GrantError = { error: string; code: GrantErrorCode };
 
 // ── Lists (W5b2 contract changes 5 and 14) ───────────────────────────────────
 
-/** A workspace chip on a list row. */
-export type ListWorkspace = { id: string; name: string };
+/** A workspace chip on a list row, with the workspace's look (its colour
+ *  and icon, WorkspaceLook) from a brain that has one. */
+export type ListWorkspace = WorkspaceLook & { id: string; name: string };
 
 /**
  * What the caller may do with an item, and what the item is (W6b fix round

package/src/dto/workspaces.ts

@@ -7,6 +7,7 @@
  * Every refusal is `{ error, code }` with 400, 403, 404 or 409. A workspace
  * or login the caller may not see answers 404, never 403.
  */
+import type { AppTint } from '../app-nav';
 
 /** The Admin areas (plan 1.4). An Admin workspace user has all of them
  *  unless a per-user switch turns one off (none can be switched off yet). */
@@ -20,8 +21,26 @@ export const WORKSPACE_AREAS: readonly WorkspaceArea[] = [
   'keys',
 ];
 
+/** What a workspace is, for its default icon: the Admin workspace, the
+ *  Team workspace, a login's private workspace, or any other. */
+export type WorkspaceKind = 'admin' | 'team' | 'private' | 'other';
+
+/**
+ * A workspace's look (task 5edc9149): on every workspace the brain lists
+ * (this list and screen, /api/shell's switcher list, and the chips of the
+ * lists and the tree). `color` is a tint key of the folder palette, `icon`
+ * an emoji or `lucide:<name>`, the folder vocabulary; null = the default:
+ * the neutral colour, and the client's default icon for `kind`. Absent from
+ * an older brain (read it as null and 'other').
+ */
+export type WorkspaceLook = {
+  color?: AppTint | null;
+  icon?: string | null;
+  kind?: WorkspaceKind;
+};
+
 /** One workspace as a list row and as the head of its screen. */
-export type Workspace = {
+export type Workspace = WorkspaceLook & {
   id: string;
   name: string;
   description: string;
@@ -112,15 +131,21 @@ export type WorkspaceLandingApp = {
   ready: boolean;
 };
 
-/** PATCH /api/workspaces/:id. Name and description: a Moderator or an Admin
- *  user. Contact and assistant: an Admin user (assistant: area
- *  'assistants'). The landing page (`landingAppId`): a Moderator of this
+/** PATCH /api/workspaces/:id. Name, description, colour and icon: a
+ *  Moderator or an Admin user (one rule: whoever may rename it sets its
+ *  look; the built-in workspaces keep their names but take a look). `color`
+ *  is a tint key (APP_TINTS), `icon` an emoji or `lucide:<name>` (400
+ *  `invalid` otherwise). null clears either; '' clears the icon too (the
+ *  folder field's rule), never the colour. Contact and assistant: an Admin
+ *  user (assistant: area 'assistants'). The landing page (`landingAppId`): a Moderator of this
  *  workspace only, to an app the workspace holds with a green published
  *  build (409 `landing_app_not_held` or `landing_app_not_ready`). `null`
  *  clears (the Built-in home). Answers the updated Workspace. */
 export type WorkspacePatchBody = {
   name?: string;
   description?: string;
+  color?: AppTint | null;
+  icon?: string | null;
   contactNodeId?: string | null;
   assistantId?: string | null;
   landingAppId?: string | null;
@@ -169,7 +194,7 @@ export type WorkspaceResourcePatchBody = { write: boolean };
 
 /** What /api/shell adds for the signed-in login: its live workspaces (for
  *  the switcher) and its Admin areas ([] when it is not an Admin user). */
-export type ShellWorkspace = {
+export type ShellWorkspace = WorkspaceLook & {
   id: string;
   name: string;
   isAdmin: boolean;

package/src/index.ts

@@ -193,8 +193,10 @@ export type {
   WorkspaceDetailResponse,
   WorkspaceError,
   WorkspaceErrorCode,
+  WorkspaceKind,
   WorkspaceLandingApp,
   WorkspaceListResponse,
+  WorkspaceLook,
   WorkspacePatchBody,
   WorkspaceResource,
   WorkspaceResourceAddBody,