types.ts

1/**2 * types.ts — cross-boundary types and the `MessageType` union.3 *4 * `MessageType` mixes background-bound and content-script-bound messages.5 * Background-bound types have a case in `src/background/messages.ts`.6 * Content-script-bound types (PING, SUMMON_AUTOFILL, VAULT_LOCKED,7 * RESTART_AUTO_LOCK, etc.) are sent *to* content scripts or the popup and8 * have no handler in messages.ts by design — that absence is not a missing9 * handler. Add new cross-boundary types here, not inline in call sites.10 */1112export interface ManualSummonRecord {13  firstSummonedAt: number;14  summonCount: number;15  lastSummonedAt: number;16}1718export interface Canary {19  webhookUrl: string;20  label?: string;21  lastPinged?: number;22  pingCount?: number;23}2425export type CardNetwork = "visa" | "mastercard" | "amex" | "discover" | "unknown";2627/**28 * Passkey credential data attached to a VaultEntry. New in v2.11.0 — passkeys29 * are no longer a separate entry type; instead they hang off any login entry.30 * A passkey-only entry is a `type:"login"` entry with no username/password31 * but a `passkey` sub-object set. A login that ALSO has a passkey is just a32 * normal login with `passkey` populated.33 *34 * privateKeyJwk is present only on Chrome-created passkeys, where Peach is35 * the authenticator. Firefox-created passkeys delegate to the platform36 * authenticator, so the field is absent — `browser` distinguishes the two.37 */38export interface PasskeyData {39  rpId: string;40  rpName: string;41  credentialId: string;42  publicKeyCose: string;43  privateKeyJwk?: JsonWebKey;44  userHandle: string;45  userName: string;46  userDisplayName: string;47  algorithm: -7 | -8;48  signCount: number;49  aaguid: string;50  backupEligible: boolean;51  backupState: boolean;52  lastUsedAt?: number;53  browser?: "chrome" | "firefox";54  transports?: string[];55  /** When the credential was first registered with Peach. */56  createdAt: number;57}5859/** One past password kept in an entry's {@link VaultEntry.passwordHistory}. */60export interface PasswordHistoryItem {61  /** The old password value, replaced by a newer one. */62  password: string;63  /**64   * When this password stopped being current — i.e. the `passwordChangedAt`65   * (or `createdAt`) it carried at the moment it was swapped out.66   */67  changedAt: number;68}6970export interface VaultEntry {71  id: string; // crypto.randomUUID()72  /** Entry type. Passkey credentials are carried in the nested `passkey` field. */73  type?: "login" | "note" | "passkey" | "card";74  title: string;75  username?: string; // only for login entries76  email?: string; // separate email address — for sites that require both a username and an email77  password?: string; // only for login entries78  url?: string; // only for login entries79  /**80   * Additional sites this entry should match for autofill. Login entries only.81   * Each value is a full origin or URL (e.g. `https://login.foo.com`).82   * The vault domain index keys against the hostname of every entry in this83   * list, in addition to `url`.84   */85  additionalUrls?: string[];86  totp?: string; // base32 seed, stored encrypted — only for login entries87  /**88   * Optional TOTP parameters parsed from an otpauth:// URI. Absent fields fall89   * back to RFC defaults (SHA-1 / 6 digits / 30-second period). Login entries only.90   */91  totpAlgorithm?: "SHA1" | "SHA256" | "SHA512";92  totpDigits?: number;93  totpPeriod?: number;94  notes?: string;95  breach?: number; // HIBP exposure count; 0 or undefined = clean — only for login entries96  /**97   * When the password field was last changed. Set on first-write of `password`98   * and refreshed on every subsequent change.99   */100  passwordChangedAt?: number;101  /**102   * Previously-used passwords for this entry, newest first. A snapshot of the103   * old password is pushed here automatically whenever the password changes104   * (see `updateEntry` in vault.ts). Capped at PASSWORD_HISTORY_MAX. Lets the105   * user reveal, copy, or restore a password they used before — handy when a106   * site rejects a rotation or an old credential resurfaces.107   */108  passwordHistory?: PasswordHistoryItem[];109  canary?: Canary;110  createdAt: number; // Date.now()111  modifiedAt: number;112  deletedAt?: number;113  tags?: string[];114  /** Passkey credential attached to this entry, if any. */115  passkey?: PasskeyData;116  // Card entry fields117  cardholderName?: string;118  cardNumber?: string;       // full PAN, stored encrypted in vault119  expMonth?: string;120  expYear?: string;121  cvc?: string;122  cardNickname?: string;123  network?: CardNetwork;124  last4?: string;125}126127/** Returns true when an entry has a passkey credential attached. */128export function hasPasskey(entry: VaultEntry): boolean {129  return entry.passkey !== undefined && entry.passkey.credentialId.length > 0;130}131132/** Returns true when an entry is passkey-only and has no password to fill. */133export function isPasskeyOnly(entry: VaultEntry): boolean {134  // An entry is "passkey only" when it holds SOLELY a passkey credential —135  // no password, no TOTP, and no dedicated email. Username is intentionally136  // excluded because it is useful for searching passkey credentials.137  // Entries with passkey + TOTP or passkey + email are NOT passkey-only: they138  // carry fillable credentials and must show the full login-fields UI.139  return hasPasskey(entry) && !entry.password && !entry.totp && !entry.email;140}141142export interface PendingPasskeyRequest {143  requestId: number;144  type: "create" | "get";145  rpId: string;146  rpName: string;147  userName: string;148  userDisplayName?: string;149  /**150   * Firefox path: when present, the popup performs the navigator.credentials151   * call itself rather than completing a chrome.webAuthenticationProxy152   * request. Absent for Chrome (the existing webAuthenticationProxy flow).153   */154  browser?: "chrome" | "firefox";155  /** Firefox create: base64url challenge minted by the popup-context flow. */156  challenge?: string;157  /** Firefox create: base64url user handle. Generated if absent. */158  userHandle?: string;159}160161export interface PasskeyProviderState {162  supported: boolean;163  enabled: boolean;164  attached: boolean;165  browserLabel: string;166  statusLabel: string;167  conflict?: string;168}169170export interface StoredVault {171  version: 1; // AAD for AES-GCM --- prevents downgrade172  salt: string; // hex --- 16 bytes, CSPRNG, stored not secret173  nonce: string; // hex --- 12 bytes, CSPRNG, fresh per write174  ciphertext: string; // hex --- AES-256-GCM output175  tag: string; // hex --- 16-byte GCM auth tag176  // Recovery escrow: root key wrapped under recovery words via AES-256-GCM.177  recovery_salt?: string; // hex --- 16 bytes, CSPRNG, HKDF salt for recovery key178  recovery_wrapped_root_key?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key179  recovery_nonce?: string; // hex --- 12 bytes, fresh nonce for the above180  recovery_tag?: string; // hex --- 16-byte GCM auth tag for the above181  // Second wrapping of the same root key under the password-derived key.182  // Lets unlock() recover the rootKey bytes without the user's recovery183  // words, so GET_RECOVERY_WORDS works across lock/unlock cycles. Refreshed184  // on every password change so the words stay valid (H2/COR-006).185  pw_root_ciphertext?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key (hex-encoded)186  pw_root_nonce?: string; // hex --- 12-byte nonce187  pw_root_tag?: string; // hex --- 16-byte GCM auth tag188}189190// Background-bound message types — sent from popup/content scripts,191// handled in src/background/messages.ts. Everything in this group must192// have a matching case in that file's switch statement.193export type MessageType =194  | "GET_SYNC_ALERTS"195  | "CLEAR_CLIPBOARD"196  | "GET_PENDING_VOUCHED_DEVICES"197  | "CONFIRM_VOUCHED_DEVICE"198  | "REJECT_VOUCHED_DEVICE"199  | "VOUCHED_DEVICE_PENDING"200  | "ROTATE_SYNC_IDENTITY"201  | "DEVICE_KEY_ROTATED"202  | "UNLOCK"203  | "UNLOCK_WITH_PIN"204  | "LOCK"205  | "IS_UNLOCKED"206  | "HAS_VAULT"207  | "GET_ENTRIES"208  | "ADD_ENTRY"209  | "BATCH_ADD_ENTRIES"210  | "RESTORE_ENTRIES"211  | "CLEAR_VAULT_ENTRIES"212  | "UPDATE_ENTRY"213  | "ADD_ADDITIONAL_URL"214  | "DELETE_ENTRY"215  | "AUTOFILL_QUERY"216  | "COPY"217  | "CREATE_VAULT"218  | "CREATE_VAULT_FROM_ROOT_KEY"219  | "GET_ENTRY_FOR_FILL"220  | "GET_ENTRY_FOR_EDIT"221  | "CHECK_ALL_BREACHES"222  | "GET_SETTINGS"223  | "UPDATE_SETTINGS"224  | "SETUP_PIN"225  | "DISABLE_PIN"226  | "FIRE_CANARY_PING"227  | "ACTIVATE_LICENSE"228  | "GET_LICENSE"229  | "GET_LICENSE_KEY"230  | "IS_DURESS_ENABLED"231  | "SETUP_DURESS"232  | "DISABLE_DURESS"233  | "VERIFY_MAIN_PASSWORD"234  | "CHANGE_PASSWORD"235  | "GET_SITE_PASSWORD_POLICY"236  | "GET_LOCAL_IDENTITY"237  | "LIST_PAIRED_DEVICES"238  | "RENAME_PAIRED_DEVICE"239  | "UNPAIR_DEVICE"240  | "RENAME_LOCAL_DEVICE"241  // Relay pairing. START/CONFIRM/CANCEL are popup→bg requests handled in the242  // switch; ADOPTION_SOURCE_SAS / ADOPTION_SOURCE_RESULT are bg→popup pushes.243  | "START_ADOPTION_SOURCE"244  | "START_ADOPTION_RECEIVER"245  | "CANCEL_ADOPTION_SOURCE"246  | "SOURCE_SAS_DECISION"247  | "ADOPTION_SOURCE_SAS"248  | "ADOPTION_SOURCE_RESULT"249  | "TRIGGER_SYNC"250  | "GET_SYNC_STATE"251  | "GET_SYNC_SETTINGS"252  | "SET_SYNC_SETTINGS"253  | "GET_PENDING_PASSKEY"254  | "APPROVE_PASSKEY"255  | "DENY_PASSKEY"256  | "GET_PASSKEY_PROVIDER_STATE"257  | "SET_PASSKEY_PROVIDER_ENABLED"258  | "GET_DELETED_ENTRIES"259  | "RESTORE_ENTRY"260  | "PURGE_ENTRY"261  | "PURGE_EXPIRED_TRASH"262  | "GET_VAULT_HISTORY"263  | "RESTORE_VAULT_SNAPSHOT"264  | "COUNT_DUPLICATES"265  | "DEDUPLICATE_ENTRIES"266  | "RECORD_MANUAL_SUMMON"267  | "DECLINE_CARD_SAVE"268  | "IS_CARD_DECLINED"269  | "GET_VAULT_STATUS"270  | "GET_ADVANCED_HEALTH_REPORT"271  | "DEACTIVATE_LICENSE"272  | "GET_IDENTITIES"273  | "DESTROY_VAULT"274  | "INITIATE_FIREFOX_PASSKEY_CREATE"275  | "COMPLETE_FIREFOX_PASSKEY_CREATE"276  | "PASSKEY_OFFER_DECLINE"277  | "GET_PASSKEY_OFFER_DECLINED"278  | "GET_PASSKEY_FOR_DOMAIN"279  // Firefox content-script proxy path (v2.12.0). Sent FROM the page-world280  // monkey-patch through the extension-world relay TO the background. See281  // src/shared/passkey-flags.ts for removal conditions.282  | "PASSKEY_HAS_CREDENTIALS"283  | "PASSKEY_CREATE"284  | "PASSKEY_GET"285  // Recovery word messages286  | "VALIDATE_RECOVERY_WORDS"287  | "RECOVER_WITH_WORDS"288  | "GET_RECOVERY_WORDS"289  | "GET_IDENTITY_SUGGESTIONS"290  | "TOUCH_AUTO_LOCK"291  | "SAVE_NOTE"292  | "DELETE_NOTE"293  | "GET_NOTES"294  | "SEARCH_VAULT"295  | "ML_INIT"296  | "ML_PREDICT_BATCH"297  // Content-script-bound message types — sent BY the background TO content298  // scripts. They never reach messages.ts's switch. Kept in this union so299  // existing call sites type-check; do not add cases for them in the300  // background handler.301  | "PING"            // background → content: liveness probe302  | "SUMMON_AUTOFILL" // background → content: open the in-page palette303  | "VAULT_LOCKED"    // background → content/popup: vault just locked304  | "VAULT_UNLOCKED"  // background → content/popup: vault just unlocked305  | "PRO_GATE_TRIGGERED" // background → popup: a Pro feature was attempted on free306  | "PASSKEY_PRO_GATE" // background → content: show passkey Pro gate in inline popup307  | "OPEN_PRO_GATE" // content → background: open popup and navigate to License section308  | "OPEN_POPUP" // content → background: open the extension popup (e.g. to unlock)309  | "OPEN_DETACHED_POPUP" // popup → background: open the popup HTML in a standalone window (file-picker flows)310  | "SHOW_PASSKEY_TOAST"    // background → content tab: show passkey auth toast311  | "DISMISS_PASSKEY_TOAST" // background → content tab: dismiss passkey auth toast312  | "PASSKEY_AUTH_RESPONSE" // content → background: user approved or denied the toast313  | "SHOULD_PLAY_CELEBRATION"314  | "MARK_CELEBRATION_PLAYED"315  // Peach Codex (v2.42.0). Generation runs in the popup — the SW only316  // sources vault data and applies the restored slots.317  | "GET_CODEX_VAULT_DATA"318  | "ESTIMATE_CODEX_PAGES"319  | "GENERATE_CODEX"320  | "RESTORE_FROM_CODEX";321322export type ProFeature =323  | "sync"324  | "passkeys"325  | "advanced_health"326  | "ios_app"327  | "codex"328  | "canary_entry"329  | "duress_vault";330331/**332 * License export shape included in PeachScript and encrypted JSON backups.333 * `celebrationPlayed` is intentionally absent — a new device deserves the moment.334 */335export interface PeachLicenseExport {336  key: string;337  activatedAt?: number;338}339340export interface AdvancedHealthEntryReport {341  id: string;342  title: string;343  domain: string;344  url?: string;345  score: number;346  ageDays: number;347  reasons: string[];348  factors: {349    breached: boolean;350    breachCount: number;351    reused: boolean;352    aged: boolean;353    weak: boolean;354    missingTotpOnSensitive: boolean;355  };356}357358export interface AdvancedHealthReport {359  vaultScore: number;360  generatedAt: number;361  entryCount: number;362  reusedGroups: number;363  agedCount: number;364  remediation: AdvancedHealthEntryReport[];365}366367export const ACCENT_COLORS = [368  { name: "peach",    hex: "#F49C70" },369  { name: "rose",     hex: "#FF8AA6" },370  { name: "plum",     hex: "#D597F2" },371  { name: "lavender", hex: "#A6A8FF" },372  { name: "sky",      hex: "#5BC8EE" },373  { name: "mint",     hex: "#5EE0B0" },374  { name: "sage",     hex: "#B5D870" },375  { name: "butter",   hex: "#FFD45A" },376  { name: "sand",     hex: "#EDBC85" },377  { name: "clay",     hex: "#F08660" },378  { name: "slate",    hex: "#80BEDE" },379  { name: "stone",    hex: "#C8B8A8" },380] as const;381382export type AccentColorName = typeof ACCENT_COLORS[number]["name"];383384export interface SavedIdentity {385  value: string;386  type: "email" | "username";387  lastUsed: number;388  useCount: number;389  exampleDomain?: string;390}391392export interface PasswordPolicy {393  minLength?: number;394  maxLength?: number;395  requiresUppercase?: boolean;396  requiresLowercase?: boolean;397  requiresNumbers?: boolean;398  requiresSymbols?: boolean;399  forbidsSymbols?: boolean;400  allowedSymbols?: string;401  /** Characters the site explicitly disallows. Filtered from every pool before generation. */402  forbiddenChars?: string;403}404405/**406 * A single vault history snapshot. The `vault_a` and `vault_b` fields are the407 * raw encrypted blobs from chrome.storage.local — already AES-256-GCM408 * protected by the master password, so storing them in history adds no409 * security surface.410 *411 * Snapshots are taken BEFORE every vault write so the saved blob represents412 * what is about to be lost, not what was just written. The reason field413 * documents the trigger so the UI can render "saved" / "synced" / "imported"414 * / "restored" labels next to each row.415 */416export interface VaultSnapshot {417  id: string;418  savedAt: number;419  reason: "local_save" | "sync_received" | "import" | "restore";420  vault_a: string;421  vault_b: string;422  /**423   * Coarse size bucket (ceiling) of active entries when the snapshot was taken;424   * null if vault was locked or in decoy mode. PCH-01-023: bucketed, not exact,425   * so the plaintext value cannot leak vault size or per-write deltas. UI should426   * render it as "up to N", never as an exact count.427   */428  entryCount: number | null;429}430431export interface VaultHistory {432  /** Newest first; capped at HISTORY_MAX (10). */433  snapshots: VaultSnapshot[];434}435436export interface Message {437  type: MessageType;438  payload?: unknown;439}440441export interface MessageResponse {442  ok: boolean;443  data?: unknown;444  error?: string;445  vaultId?: string;446  unlocked?: boolean;447  // Set on UNLOCK responses when the vault decrypted but failed schema448  // validation (M7/COR-007). The popup may offer a history-restore flow.449  canRestoreFromHistory?: boolean;450  // Set on COPY responses: the effective clipboard auto-clear delay in seconds,451  // so the content script's TOTP toast can advertise the real configured time.452  clearSeconds?: number;453}