@crossworks/client-types 0.232.254 → 0.232.257

package/package.json

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

package/src/dto/access.ts

@@ -0,0 +1,55 @@
+/**
+ * The Access control's wire shapes (`/api/access/nodes/:id`). One level
+ * system: admin > team > client > public. A caller sees what is at or below
+ * its level. The level is the truth and the item's share link follows it:
+ * none at admin, a team-only link at team (the team workspace opens items
+ * through it), an open link at client and public. See docs/access-levels.md.
+ */
+import type { ShareMode } from './rows';
+
+/** Highest first: the order the control shows them in. */
+export const ACCESS_LEVELS = ['admin', 'team', 'client', 'public'] as const;
+export type AccessLevel = (typeof ACCESS_LEVELS)[number];
+
+/** One item as the Access control lists it (the item itself or its closure). */
+export type AccessItemView = {
+  id: string;
+  type: string;
+  title: string;
+  audience: AccessLevel;
+};
+
+/** The item's link. `path` is server-relative (`/s/<token>`). */
+export type AccessLinkView = {
+  id: string;
+  token: string;
+  path: string;
+  mode: ShareMode;
+  /** Page links only: sub-pages are shared with it. */
+  cascade: boolean;
+};
+
+/** GET /api/access/nodes/:id */
+export type AccessNodeView = {
+  item: AccessItemView;
+  /** What the item's link or embeds need: a page's files and drawings, a
+   *  folder's contents, a drawing's images. Each carries its own level. */
+  closure: AccessItemView[];
+  share: AccessLinkView | null;
+  /** Descendant pages (pages only; 0 otherwise). */
+  childCount: number;
+  /** Only workspace kinds go below admin (tasks, events, … are admin only). */
+  canLower: boolean;
+  /** Whether the item can carry a link (a folder only under `files`). */
+  canLink: boolean;
+};
+
+/** PATCH /api/access/nodes/:id { audience, withClosure? } */
+export type AccessNodeUpdate = {
+  item: AccessItemView;
+  /** Closure items lowered with it (only when `withClosure`). */
+  lowered: AccessItemView[];
+  /** Closure items still above the new level (when not `withClosure`). */
+  stillAbove: AccessItemView[];
+  share: AccessLinkView | null;
+};

package/src/dto/rows.ts

@@ -11,6 +11,7 @@
  */
 
 import type { AppNav, AppOpenStat, AppTint } from '../app-nav';
+import type { AccessLevel } from './access';
 
 // ── Row/DTO shapes moved from the server packages (jackdaw split P0) ─────────
 // Sources: @mantle/content, @mantle/email, @mantle/microsoft, @mantle/runtime/agent
@@ -128,6 +129,8 @@ export type PageRow = {
   summary: string | null;
   visibility: PageVisibility;
   width: PageWidth;
+  /** Access level (admin > team > client > public); the owner UI's badge. */
+  audience: AccessLevel;
   createdAt: string;
   updatedAt: string;
 };
@@ -170,6 +173,8 @@ export type AppRow = {
   shareMode: ShareMode | null;
   /** Whether this app is the designated Team Hub (prefs.teamHubAppId). */
   isHub: boolean;
+  /** Access level (admin > team > client > public); the owner UI's badge. */
+  audience: AccessLevel;
   createdAt: string;
   updatedAt: string;
 };

package/src/index.ts

@@ -32,6 +32,14 @@ export * from './dto/turns';
 export * from './dto/rows';
 export * from './dto/views';
 export * from './dto/recall';
+// Types only; ACCESS_LEVELS (runtime) is the `@mantle/client-types/dto/access` subpath.
+export type {
+  AccessItemView,
+  AccessLevel,
+  AccessLinkView,
+  AccessNodeUpdate,
+  AccessNodeView,
+} from './dto/access';
 
 // Types only at the root; the runtime constants (APP_TINTS, limits) are the
 // `@mantle/client-types/app-nav` subpath.