@company-semantics/contracts 0.39.0 → 0.41.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@company-semantics/contracts",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "private": false,
   "repository": {
     "type": "git",

package/src/identity/README.md

@@ -8,22 +8,27 @@ TypeScript types and functions for user identity and display name resolution.
 
 - Types with minimal runtime code (pure functions only, no side effects)
 - No external dependencies (contracts policy)
-- `preferredName` is assistant-facing only, not user-edited label
-- `fullName` is user-editable override of derived firstName + lastName
+- `fullName` is the only stored name field (no firstName/lastName)
+- `preferredName` is assistant-facing only, always user-editable
+- `fullName` is user-editable only when `nameSource === 'self'`
+- `fullName` is read-only when `nameSource === 'sso'` (managed by organization)
 - `displayName` is NEVER stored — always derived at read time via `resolveDisplayName()`
 - `resolveDisplayName()` is the ONLY approved way to determine assistant addressing
+- Display name fallback: `preferredName ?? extractFirstWord(fullName)`
 
 ## Public API
 
 ### Types
 
 - `ISODateString` — ISO 8601 date-time string alias
-- `UserIdentity` — User identity with name fields and timestamps
+- `NameSource` — `'self' | 'sso'` indicating name data source
+- `UserIdentity` — User identity with name fields, source, and timestamps
 
 ### Functions
 
-- `deriveFullName(firstName, lastName?)` — Derive full name from components
-- `resolveDisplayName(identity)` — Get display name (preferredName or firstName)
+- `extractFirstWord(fullName)` — Extract first word from full name
+- `resolveDisplayName(identity)` — Get display name (preferredName or first word of fullName)
+- `deriveFullName(firstName, lastName?)` — **[DEPRECATED]** Kept for migration only
 
 ## Dependencies
 

package/src/identity/avatar.ts

@@ -0,0 +1,120 @@
+/**
+ * Avatar Resolution Functions
+ *
+ * Canonical functions for resolving user avatars.
+ * Determines whether to use Slack profile photo or initials fallback.
+ *
+ * @see ADR-BE-063 for design rationale
+ */
+
+import type { UserIdentity } from './types';
+import { extractFirstWord } from './display-name';
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/**
+ * Source of the resolved avatar.
+ * - 'slack': Using Slack profile photo
+ * - 'initials': Using generated initials (fallback)
+ */
+export type AvatarSource = 'slack' | 'initials';
+
+/**
+ * Resolved avatar for UI rendering.
+ *
+ * INVARIANT: initials is ALWAYS populated, regardless of source.
+ * This prevents UI regressions if Slack avatar fails to load.
+ */
+export interface ResolvedAvatar {
+  /** Source of the avatar (slack or initials) */
+  source: AvatarSource;
+
+  /** Slack profile image URL (present only if source === 'slack') */
+  url?: string;
+
+  /**
+   * User initials for fallback display.
+   * REQUIRED - always populated to ensure graceful degradation.
+   */
+  initials: string;
+}
+
+// =============================================================================
+// Helper Functions
+// =============================================================================
+
+/**
+ * Generate initials from a full name.
+ *
+ * Takes the first letter of the first word and optionally the last word.
+ * Always returns uppercase initials (1-2 characters).
+ *
+ * @param fullName - The user's full name
+ * @returns Uppercase initials (e.g., "IH" for "Ian Heidt", "M" for "Madonna")
+ *
+ * @example
+ * generateInitials("Ian Heidt")      // "IH"
+ * generateInitials("Madonna")        // "M"
+ * generateInitials("Mary Jane Doe")  // "MD"
+ * generateInitials("")               // ""
+ */
+export function generateInitials(fullName: string): string {
+  const trimmed = fullName.trim();
+  if (!trimmed) return '';
+
+  const words = trimmed.split(/\s+/);
+  const firstInitial = words[0]?.[0]?.toUpperCase() ?? '';
+
+  if (words.length === 1) {
+    return firstInitial;
+  }
+
+  const lastInitial = words[words.length - 1]?.[0]?.toUpperCase() ?? '';
+  return `${firstInitial}${lastInitial}`;
+}
+
+// =============================================================================
+// Avatar Resolution
+// =============================================================================
+
+/**
+ * Resolve avatar from user identity.
+ *
+ * This is the ONLY approved way to determine which avatar to display.
+ * Returns a ResolvedAvatar with source, optional URL, and required initials.
+ *
+ * INVARIANT: initials is ALWAYS populated, regardless of source.
+ * This ensures the UI always has a fallback if the Slack image fails to load.
+ *
+ * @param identity - Object with slackAvatarUrl and fullName fields
+ * @returns ResolvedAvatar with source, url (if slack), and initials
+ *
+ * @example
+ * // Slack avatar available
+ * resolveAvatar({ slackAvatarUrl: "https://...", fullName: "Ian Heidt" })
+ * // { source: 'slack', url: 'https://...', initials: 'IH' }
+ *
+ * // No Slack avatar (initials fallback)
+ * resolveAvatar({ fullName: "Ian Heidt" })
+ * // { source: 'initials', initials: 'IH' }
+ */
+export function resolveAvatar(
+  identity: Pick<UserIdentity, 'slackAvatarUrl' | 'fullName'>
+): ResolvedAvatar {
+  const initials = generateInitials(identity.fullName);
+
+  if (identity.slackAvatarUrl) {
+    return {
+      source: 'slack',
+      url: identity.slackAvatarUrl,
+      initials,
+    };
+  }
+
+  return {
+    source: 'initials',
+    initials,
+  };
+}

package/src/identity/display-name.ts

@@ -4,30 +4,32 @@
  * Canonical functions for deriving and resolving user display names.
  * These are the ONLY approved ways to handle display name logic.
  *
- * @see DECISIONS.md ADR-2026-01-020 for design rationale
+ * @see ADR-CONT-032 for design rationale
  */
 
 import type { UserIdentity } from './types';
 
 // =============================================================================
-// Full Name Derivation
+// Helper Functions
 // =============================================================================
 
 /**
- * Derive fullName from firstName and lastName.
+ * Extract the first word from a full name.
+ * Used as fallback when preferredName is not set.
  *
- * Invariant: fullName MUST be derived automatically unless explicitly provided.
- *
- * @param firstName - User's first name (required)
- * @param lastName - User's last name (optional)
- * @returns Combined full name
+ * @param fullName - The user's full name
+ * @returns The first word (before first space), or entire string if no spaces
  *
  * @example
- * deriveFullName("Ian", "Heidt")  // "Ian Heidt"
- * deriveFullName("Ian")           // "Ian"
+ * extractFirstWord("Ian Heidt")     // "Ian"
+ * extractFirstWord("Madonna")       // "Madonna"
+ * extractFirstWord("Mary Jane")     // "Mary"
+ * extractFirstWord("")              // ""
  */
-export function deriveFullName(firstName: string, lastName?: string): string {
-  return lastName ? `${firstName} ${lastName}` : firstName;
+export function extractFirstWord(fullName: string): string {
+  const trimmed = fullName.trim();
+  const spaceIndex = trimmed.indexOf(' ');
+  return spaceIndex === -1 ? trimmed : trimmed.slice(0, spaceIndex);
 }
 
 // =============================================================================
@@ -42,19 +44,32 @@ export function deriveFullName(firstName: string, lastName?: string): string {
  *
  * Invariants:
  * - preferredName overrides if present and non-empty
- * - Falls back to firstName (never blank)
+ * - Falls back to first word of fullName (never blank if fullName is set)
  * - displayName is NEVER stored, always derived at read time
  *
- * @param identity - Object with preferredName and firstName fields
+ * @param identity - Object with preferredName and fullName fields
  * @returns The resolved display name
  *
  * @example
- * resolveDisplayName({ firstName: "Ian", preferredName: "Heidt" })  // "Heidt"
- * resolveDisplayName({ firstName: "Ian", preferredName: "" })       // "Ian"
- * resolveDisplayName({ firstName: "Ian" })                          // "Ian"
+ * resolveDisplayName({ fullName: "Ian Heidt", preferredName: "Heidt" })  // "Heidt"
+ * resolveDisplayName({ fullName: "Ian Heidt", preferredName: "" })       // "Ian"
+ * resolveDisplayName({ fullName: "Ian Heidt" })                          // "Ian"
+ * resolveDisplayName({ fullName: "Madonna" })                            // "Madonna"
  */
 export function resolveDisplayName(
-  identity: Pick<UserIdentity, 'preferredName' | 'firstName'>
+  identity: Pick<UserIdentity, 'preferredName' | 'fullName'>
 ): string {
-  return identity.preferredName?.trim() || identity.firstName;
+  return identity.preferredName?.trim() || extractFirstWord(identity.fullName);
+}
+
+// =============================================================================
+// Deprecated Functions
+// =============================================================================
+
+/**
+ * @deprecated Use fullName directly. firstName/lastName are no longer stored.
+ * This function is retained for migration compatibility only.
+ */
+export function deriveFullName(firstName: string, lastName?: string): string {
+  return lastName ? `${firstName} ${lastName}` : firstName;
 }

package/src/identity/index.ts

@@ -6,7 +6,18 @@
  */
 
 // Types
-export type { ISODateString, UserIdentity } from './types';
+export type { ISODateString, NameSource, UserIdentity } from './types';
 
-// Functions
-export { deriveFullName, resolveDisplayName } from './display-name';
+// Functions - Display Name
+export {
+  extractFirstWord,
+  resolveDisplayName,
+  /** @deprecated Use fullName directly */
+  deriveFullName,
+} from './display-name';
+
+// Types - Avatar
+export type { AvatarSource, ResolvedAvatar } from './avatar';
+
+// Functions - Avatar
+export { generateInitials, resolveAvatar } from './avatar';

package/src/identity/types.ts

@@ -3,7 +3,7 @@
  *
  * Canonical vocabulary for user identity across Company Semantics.
  *
- * @see DECISIONS.md ADR-2026-01-020 for design rationale
+ * @see ADR-CONT-032 for design rationale
  */
 
 // =============================================================================
@@ -16,6 +16,19 @@
  */
 export type ISODateString = string;
 
+// =============================================================================
+// Name Source
+// =============================================================================
+
+/**
+ * Source of the user's name data.
+ * Determines who controls the fullName field.
+ *
+ * - 'self': User-provided (editable by user)
+ * - 'sso': SSO/IdP-provided (read-only, managed by organization)
+ */
+export type NameSource = 'self' | 'sso';
+
 // =============================================================================
 // User Identity
 // =============================================================================
@@ -25,38 +38,59 @@ export type ISODateString = string;
  * Represents the canonical identity vocabulary for a user.
  *
  * Invariants:
- * - firstName is required (always addressable)
- * - lastName is optional (single-name users exist globally)
- * - fullName is STORED (derived by default, user-editable)
- * - preferredName is STORED (assistant-only addressing)
+ * - fullName is the only stored name field (no firstName/lastName)
+ * - preferredName is optional and always user-controlled
+ * - nameSource determines whether fullName is user-editable
  * - displayName is NEVER stored (derived at read time via resolveDisplayName)
  */
 export type UserIdentity = {
   /** Unique user identifier */
   userId: string;
 
-  /** User's first name (required) */
-  firstName: string;
-
-  /** User's last name (optional) */
-  lastName?: string;
-
   /**
    * Full name for display in UI, exports, and audit logs.
-   * Derived by default from firstName + lastName, but user-editable.
+   * Editable when nameSource === 'self', read-only when nameSource === 'sso'.
    */
   fullName: string;
 
   /**
    * Preferred name for AI assistant to use.
-   * Assistant-only field; may differ from firstName.
-   * If not set, assistant falls back to firstName via resolveDisplayName().
+   * Always user-editable regardless of nameSource.
+   * If not set, assistant falls back to first word of fullName via resolveDisplayName().
    */
   preferredName?: string;
 
+  /**
+   * Source of the name data.
+   * Determines whether fullName is editable by the user.
+   */
+  nameSource: NameSource;
+
   /** When the identity was created */
   createdAt: ISODateString;
 
   /** When the identity was last updated */
   updatedAt: ISODateString;
+
+  // ==========================================================================
+  // Slack Avatar Fields (ADR-BE-063)
+  // ==========================================================================
+
+  /**
+   * Slack user ID (set when Slack is connected and email matches).
+   * Used for efficient lookups in user_change event handling.
+   */
+  slackUserId?: string;
+
+  /**
+   * Slack profile image URL (synced from Slack events).
+   * May be undefined if Slack not connected or email mismatch.
+   */
+  slackAvatarUrl?: string;
+
+  /**
+   * When the Slack avatar was last synced.
+   * Used for debugging and audit purposes.
+   */
+  slackAvatarLastSyncedAt?: ISODateString;
 };

package/src/index.ts

@@ -105,9 +105,9 @@ export { COMPATIBILITY } from './compatibility'
 export type { Compatibility, Deprecation } from './compatibility'
 
 // User identity types and functions
-// @see ADR-2026-01-020 for design rationale
-export type { ISODateString, UserIdentity } from './identity/index'
-export { deriveFullName, resolveDisplayName } from './identity/index'
+// @see ADR-CONT-032 for design rationale
+export type { ISODateString, NameSource, UserIdentity } from './identity/index'
+export { extractFirstWord, resolveDisplayName, deriveFullName } from './identity/index'
 
 // Auth domain types
 export { OTPErrorCode } from './auth/index'