@crossworks/client-types 0.232.318 → 0.232.320

package/package.json

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

package/src/dto/client.ts

@@ -0,0 +1,125 @@
+/**
+ * The client API's wire shapes (client logins, Phase C2): what a CLIENT
+ * login's app reads from /api/client/*, and what an admin reads and writes
+ * about client logins in Team admin > Clients. A client reads items at
+ * client level only (the brain enforces it with row security). Client DTOs
+ * never carry a staff name or an author: clients see the brand name.
+ */
+import type { MemberItemKind } from '../member-kinds';
+
+/** GET /api/client/shell: who is signed in and the brain's brand. */
+export type ClientShell = {
+  role: 'client';
+  loginId: string;
+  displayName: string | null;
+  email: string;
+  /** Append as `?at=` to /api/client/files/* and /api/client/draws/* srcs. */
+  assetToken: string;
+  siteName: string | null;
+  colorTheme: string | null;
+  fontLogo: string | null;
+  fontTitle: string | null;
+  fontUi: string | null;
+  fontProse: string | null;
+  fontSize: string | null;
+  fontLogoSize: string | null;
+  fontTitleSize: string | null;
+  fontProseSize: string | null;
+  logoVersion: string | null;
+  logoDarkVersion: string | null;
+};
+
+/** One item in "Shared with you": an item at client level. */
+export type ClientSharedRow = {
+  id: string;
+  type: MemberItemKind;
+  title: string;
+  icon: string | null;
+  summary: string | null;
+  updatedAt: string;
+};
+
+/** GET /api/client/shared?kind=&q=&page= : newest first. */
+export type ClientSharedPage = {
+  items: ClientSharedRow[];
+  total: number;
+  page: number;
+  pageSize: number;
+};
+
+/** GET /api/client/shared/:id -> { item }. A page's doc and a note's text
+ *  come with every reference to something a client may not read replaced:
+ *  a mention chip or a link names "Private item" and points nowhere, an
+ *  embed of such an item is left out. */
+export type ClientSharedItem =
+  | (ClientSharedRow & { type: 'page'; doc: unknown })
+  | (ClientSharedRow & { type: 'note'; content: string })
+  | (ClientSharedRow & { type: 'table'; table: unknown })
+  | (ClientSharedRow & { type: 'draw' })
+  | (ClientSharedRow & {
+      type: 'file';
+      filename: string;
+      mimeType: string | null;
+      sizeBytes: number | null;
+    });
+
+/** The label a client sees instead of a reference it may not read. */
+export const CLIENT_PRIVATE_LABEL = 'Private item';
+
+// ── Admin side: Team admin > Clients ────────────────────────────────────────
+
+/** A sign-in link an admin issued (the code itself is shown once, at issue). */
+export type ClientSigninLinkRow = {
+  id: string;
+  createdAt: string;
+  expiresAt: string;
+};
+
+/** One client login, as Team admin > Clients lists it. */
+export type ClientLoginRow = {
+  id: string;
+  email: string;
+  displayName: string | null;
+  contactId: string | null;
+  disabled: boolean;
+  createdAt: string;
+  lastLoginAt: string | null;
+  /** The open (unused, unexpired, unrevoked) sign-in link, if any. */
+  openLink: ClientSigninLinkRow | null;
+  /** When a sign-in link of this login was last used. */
+  lastLinkUsedAt: string | null;
+};
+
+/** GET /api/team-admin/clients. `reportAcknowledged`: an admin has checked
+ *  "What clients see" and nothing went to client since; until then Add
+ *  client and Issue sign-in link are refused (409 `report-not-acknowledged`). */
+export type ClientLoginList = {
+  clients: ClientLoginRow[];
+  reportAcknowledged: boolean;
+};
+
+/** POST /api/team-admin/clients { email, displayName?, contactId? }
+ *  -> { client }. The login has no password: it signs in with a link. */
+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. */
+export type ClientSigninLinkCreated = {
+  link: ClientSigninLinkRow;
+  code: string;
+  path: string;
+};
+
+/** Why an admin's client action was refused (the 4xx `reason`). */
+export type ClientAdminRefusedReason =
+  | 'report-not-acknowledged'
+  | 'email-has-login'
+  | 'contact-not-found'
+  | 'contact-has-login'
+  | 'no-email'
+  | 'not-a-client';
+
+/** POST /api/auth/client-link { code, email } -> 200 { ok: true } and the
+ *  session cookie (30 days), or one uniform 401 for every failure. */
+export type ClientLinkSignIn = { ok: true };

package/src/dto/member.ts

@@ -39,7 +39,9 @@ export type MemberLibraryRow = {
   title: string;
   icon: string | null;
   summary: string | null;
-  audience: AccessLevel;
+  /** A member's Library holds team and client items (client logins,
+   *  decision 6): 'client' = a client login reads it too (the Client badge). */
+  audience: 'team' | 'client';
   updatedAt: string;
   /** A member wrote it and an admin accepted it (the member-authored badge).
    *  Absent from brains before 0.232.285. */

package/src/index.ts

@@ -96,6 +96,19 @@ export type {
 } from './dto/member-invites';
 export type { MemberItemKind } from './member-kinds';
 export type { LoginKind, LoginRefused, LoginRefusedReason } from './dto/logins';
+export type {
+  ClientAdminRefusedReason,
+  ClientLinkSignIn,
+  ClientLoginCreated,
+  ClientLoginList,
+  ClientLoginRow,
+  ClientSharedItem,
+  ClientSharedPage,
+  ClientSharedRow,
+  ClientShell,
+  ClientSigninLinkCreated,
+  ClientSigninLinkRow,
+} from './dto/client';
 
 // Types only at the root; the runtime constants (APP_TINTS, limits) are the
 // `@mantle/client-types/app-nav` subpath.