@crossworks/client-types 0.232.290 → 0.232.292

package/package.json

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

package/src/dto/member-apps.ts

@@ -75,9 +75,31 @@ export type MemberChatArchiveMessage = {
   createdAt: string;
 };
 
-/** GET /api/team-admin/member-chats?login=&before= : every member login, and
- *  a window of the selected login's thread (null when there is no login). */
+/** The selected login's OLD team portal chat (member logins Phase 6): the
+ *  thread its contact had with the team code before the invite made it a
+ *  login. History only, for the admin: never part of the member's live
+ *  thread, never shown to the member, never in the agent's context. Show it
+ *  apart from `thread`, labelled as the portal history. */
+export type MemberChatPortalThread = {
+  /** The contact the login was invited from. */
+  contactId: string;
+  /** A window, ascending; `portalBefore` pages older. */
+  thread: MemberChatArchiveMessage[];
+  windowSize: number;
+};
+
+/** GET /api/team-admin/member-chats?login=&before=&portalBefore= : every
+ *  member login, and a window of the selected login's thread (null when
+ *  there is no login). */
 export type MemberChatsResponse = {
   members: MemberChatRow[];
-  selected: { loginId: string; thread: MemberChatArchiveMessage[]; windowSize: number } | null;
+  selected: {
+    loginId: string;
+    thread: MemberChatArchiveMessage[];
+    windowSize: number;
+    /** The login's old portal chat, separate from `thread`. Null (or absent,
+     *  from an older brain) when the login has no contact or the contact
+     *  never chatted on the portal. */
+    portalThread?: MemberChatPortalThread | null;
+  } | null;
 };

package/src/dto/member-invites.ts

@@ -0,0 +1,59 @@
+/**
+ * Member invites (member logins Phase 6): an admin invites a person, who
+ * opens the invite link, sets a password and becomes a MEMBER login.
+ *
+ * Admin: /api/team-admin/invites (create, list, revoke). Public, no session:
+ * /api/auth/invite/:code (preview) and /api/auth/invite/accept (redeem). The
+ * plaintext code is in the create response only, never in a list.
+ */
+
+/** Where an invite stands. A revoked invite is not listed. */
+export type MemberInviteState = 'open' | 'redeemed' | 'expired';
+
+/** One invite in GET /api/team-admin/invites (no code). */
+export type MemberInviteRow = {
+  id: string;
+  /** The contact it was made for; null for an email-only invite, or once
+   *  the contact is deleted. */
+  contactId: string | null;
+  /** The contact's current name; null when there is no contact. */
+  contactName: string | null;
+  /** The email the member login is created with (lower-cased). */
+  email: string;
+  displayName: string | null;
+  state: MemberInviteState;
+  createdAt: string;
+  expiresAt: string;
+  redeemedAt: string | null;
+  /** The member login the invite created. */
+  redeemedLoginId: string | null;
+  /** The admin login that made it; null once that login is deleted. */
+  createdBy: string | null;
+};
+
+/** GET /api/team-admin/invites: newest first. */
+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.
+ */
+export type MemberInviteCreated = {
+  invite: MemberInviteRow;
+  code: string;
+  linkPath: string;
+};
+
+/** GET /api/auth/invite/:code (public): who the invite is for, so the page
+ *  can greet them. Any code that cannot be redeemed is a uniform 404. */
+export type MemberInvitePreview = {
+  email: string;
+  displayName: string | null;
+  siteName: string | null;
+};
+
+/** POST /api/auth/invite/accept (public) { code, password, email? }: the
+ *  member login is created and the session cookie is set, as a login does.
+ *  Any failure about the code is a uniform 401. */
+export type MemberInviteAccepted = { ok: true; email: string };

package/src/index.ts

@@ -65,11 +65,20 @@ export type {
   MemberAppLevel,
   MemberAppList,
   MemberChatArchiveMessage,
+  MemberChatPortalThread,
   MemberChatRow,
   MemberChatsResponse,
   MemberHomeApp,
   MemberHomeData,
 } from './dto/member-apps';
+export type {
+  MemberInviteAccepted,
+  MemberInviteCreated,
+  MemberInviteList,
+  MemberInvitePreview,
+  MemberInviteRow,
+  MemberInviteState,
+} from './dto/member-invites';
 export type { MemberItemKind } from './member-kinds';
 
 // Types only at the root; the runtime constants (APP_TINTS, limits) are the