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  /**73   * Entry type. As of v2.11.0 passkeys are stored on `type:"login"` entries74   * via the `passkey` sub-object — `"passkey"` here is a legacy value still75   * accepted on read but rewritten to `"login"` on next vault save.76   */77  type?: "login" | "note" | "passkey" | "card";78  title: string;79  username?: string; // only for login entries80  email?: string; // separate email address — for sites that require both a username and an email81  password?: string; // only for login entries82  url?: string; // only for login entries83  /**84   * Additional sites this entry should match for autofill. Login entries only.85   * Each value is a full origin or URL (e.g. `https://login.foo.com`).86   * The vault domain index keys against the hostname of every entry in this87   * list, in addition to `url`.88   */89  additionalUrls?: string[];90  totp?: string; // base32 seed, stored encrypted — only for login entries91  /**92   * Optional TOTP parameters parsed from an otpauth:// URI. Absent fields fall93   * back to RFC defaults (SHA-1 / 6 digits / 30-second period), so legacy entries94   * carrying only a bare `totp` seed keep generating identical codes95   * (PCH-01-019). Login entries only.96   */97  totpAlgorithm?: "SHA1" | "SHA256" | "SHA512";98  totpDigits?: number;99  totpPeriod?: number;100  notes?: string;101  breach?: number; // HIBP exposure count; 0 or undefined = clean — only for login entries102  /**103   * When the password field was last changed. Set on first-write of `password`104   * and refreshed on every subsequent change. Defaults to `createdAt` when105   * legacy entries are read by the advanced health analyser.106   */107  passwordChangedAt?: number;108  /**109   * Previously-used passwords for this entry, newest first. A snapshot of the110   * old password is pushed here automatically whenever the password changes111   * (see `updateEntry` in vault.ts). Capped at PASSWORD_HISTORY_MAX. Lets the112   * user reveal, copy, or restore a password they used before — handy when a113   * site rejects a rotation or an old credential resurfaces.114   */115  passwordHistory?: PasswordHistoryItem[];116  canary?: Canary;117  createdAt: number; // Date.now()118  modifiedAt: number;119  deletedAt?: number;120  tags?: string[];121  /** Passkey credential attached to this entry, if any. */122  passkey?: PasskeyData;123  // ── Legacy passkey flat fields (pre-v2.11.0). Populated by vault read124  // migration so that the old import/sanitize paths keep typing; new code125  // should always read `entry.passkey?.*` instead. The migration drops these126  // on next vault save. Do not introduce new readers of these fields.127  rpId?: string;128  rpName?: string;129  credentialId?: string;130  publicKeyCose?: string;131  privateKeyJwk?: JsonWebKey;132  userHandle?: string;133  userName?: string;134  userDisplayName?: string;135  algorithm?: -7 | -8;136  signCount?: number;137  aaguid?: string;138  backupEligible?: boolean;139  backupState?: boolean;140  lastUsedAt?: number;141  browser?: "chrome" | "firefox";142  transports?: string[];143  // Card entry fields144  cardholderName?: string;145  cardNumber?: string;       // full PAN, stored encrypted in vault146  expMonth?: string;147  expYear?: string;148  cvc?: string;149  cardNickname?: string;150  network?: CardNetwork;151  last4?: string;152}153154/**155 * Returns true when an entry has a passkey credential attached. After v2.11.0156 * migration this is the canonical check; pre-migration entries with a flat157 * `rpId`/`credentialId` shape get rewritten by the vault read pass before158 * any consumer sees them.159 */160export function hasPasskey(entry: VaultEntry): boolean {161  return entry.passkey !== undefined && entry.passkey.credentialId.length > 0;162}163164/**165 * Returns true when an entry is "passkey-only" — has a passkey credential166 * but no password to fill into a form. Login fields hide for these entries167 * and the inline autofill selector filters them out (signing in via the168 * passkey is a separate WebAuthn flow). Username may still be populated169 * (the migration mirrors passkey.userName onto the entry's username so the170 * domain-index/search keep working) and is not part of this discriminator.171 */172export function isPasskeyOnly(entry: VaultEntry): boolean {173  // An entry is "passkey only" when it holds SOLELY a passkey credential —174  // no password, no TOTP, and no dedicated email. Username is intentionally175  // excluded (the migration copies passkey.userName onto username for search).176  // Entries with passkey + TOTP or passkey + email are NOT passkey-only: they177  // carry fillable credentials and must show the full login-fields UI.178  return hasPasskey(entry) && !entry.password && !entry.totp && !entry.email;179}180181export interface LegacyVaultEntry {182  id: string;183  title: string;184  username: string;185  password: string;186  url: string;187  totp?: string;188  totpAlgorithm?: "SHA1" | "SHA256" | "SHA512";189  totpDigits?: number;190  totpPeriod?: number;191  notes?: string;192  breach?: number;193  created: number;194  updated: number;195  deletedAt?: number;196}197198export interface CardEntry extends VaultEntry {199  type: "card";200  cardholderName: string;201  cardNumber: string;202  expMonth: string;203  expYear: string;204  cvc: string;205}206207208export interface PendingPasskeyRequest {209  requestId: number;210  type: "create" | "get";211  rpId: string;212  rpName: string;213  userName: string;214  userDisplayName?: string;215  /**216   * Firefox path: when present, the popup performs the navigator.credentials217   * call itself rather than completing a chrome.webAuthenticationProxy218   * request. Absent for Chrome (the existing webAuthenticationProxy flow).219   */220  browser?: "chrome" | "firefox";221  /** Firefox create: base64url challenge minted by the popup-context flow. */222  challenge?: string;223  /** Firefox create: base64url user handle. Generated if absent. */224  userHandle?: string;225}226227export interface PasskeyProviderState {228  supported: boolean;229  enabled: boolean;230  attached: boolean;231  browserLabel: string;232  statusLabel: string;233  conflict?: string;234}235236export interface StoredVault {237  version: 1; // AAD for AES-GCM --- prevents downgrade238  salt: string; // hex --- 16 bytes, CSPRNG, stored not secret239  nonce: string; // hex --- 12 bytes, CSPRNG, fresh per write240  ciphertext: string; // hex --- AES-256-GCM output241  tag: string; // hex --- 16-byte GCM auth tag242  // Recovery escrow: root key wrapped under recovery words via AES-256-GCM.243  // Absent on vaults created before v2.12 (migrateToRecovery adds them on first unlock).244  recovery_salt?: string; // hex --- 16 bytes, CSPRNG, HKDF salt for recovery key245  recovery_wrapped_root_key?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key246  recovery_nonce?: string; // hex --- 12 bytes, fresh nonce for the above247  recovery_tag?: string; // hex --- 16-byte GCM auth tag for the above248  // Second wrapping of the same root key under the password-derived key.249  // Lets unlock() recover the rootKey bytes without the user's recovery250  // words, so GET_RECOVERY_WORDS works across lock/unlock cycles. Refreshed251  // on every password change so the words stay valid (H2/COR-006).252  pw_root_ciphertext?: string; // hex --- AES-256-GCM ciphertext of 32-byte root key (hex-encoded)253  pw_root_nonce?: string; // hex --- 12-byte nonce254  pw_root_tag?: string; // hex --- 16-byte GCM auth tag255}256257// Background-bound message types — sent from popup/content scripts,258// handled in src/background/messages.ts. Everything in this group must259// have a matching case in that file's switch statement.260export type MessageType =261  | "GET_SYNC_ALERTS"262  | "CLEAR_CLIPBOARD"263  | "GET_PENDING_VOUCHED_DEVICES"264  | "CONFIRM_VOUCHED_DEVICE"265  | "REJECT_VOUCHED_DEVICE"266  | "VOUCHED_DEVICE_PENDING"267  | "ROTATE_SYNC_IDENTITY"268  | "DEVICE_KEY_ROTATED"269  | "UNLOCK"270  | "LOCK"271  | "IS_UNLOCKED"272  | "HAS_VAULT"273  | "GET_ENTRIES"274  | "ADD_ENTRY"275  | "BATCH_ADD_ENTRIES"276  | "RESTORE_ENTRIES"277  | "CLEAR_VAULT_ENTRIES"278  | "UPDATE_ENTRY"279  | "ADD_ADDITIONAL_URL"280  | "DELETE_ENTRY"281  | "AUTOFILL_QUERY"282  | "COPY"283  | "CREATE_VAULT"284  | "CREATE_VAULT_FROM_ROOT_KEY"285  | "GET_ENTRY_FOR_FILL"286  | "GET_ENTRY_FOR_EDIT"287  | "CHECK_ALL_BREACHES"288  | "GET_SETTINGS"289  | "UPDATE_SETTINGS"290  | "FIRE_CANARY_PING"291  | "ACTIVATE_LICENSE"292  | "GET_LICENSE"293  | "GET_LICENSE_KEY"294  | "IS_DURESS_ENABLED"295  | "SETUP_DURESS"296  | "DISABLE_DURESS"297  | "VERIFY_MAIN_PASSWORD"298  | "CHANGE_PASSWORD"299  | "GET_SITE_PASSWORD_POLICY"300  | "GET_LOCAL_IDENTITY"301  | "GET_ADOPTION_MATERIAL"302  | "COMPLETE_PAIRING"303  | "LIST_PAIRED_DEVICES"304  | "UNPAIR_DEVICE"305  | "RENAME_LOCAL_DEVICE"306  // Relay pairing. START/CONFIRM/CANCEL are popup→bg requests handled in the307  // switch; ADOPTION_SOURCE_SAS / ADOPTION_SOURCE_RESULT are bg→popup pushes.308  | "START_ADOPTION_SOURCE"309  | "START_ADOPTION_RECEIVER"310  | "CANCEL_ADOPTION_SOURCE"311  | "RECEIVER_SAS_DECISION"312  | "ADOPTION_SOURCE_SAS"313  | "ADOPTION_SOURCE_RESULT"314  | "TRIGGER_SYNC"315  | "GET_SYNC_STATE"316  | "GET_SYNC_SETTINGS"317  | "SET_SYNC_SETTINGS"318  | "GET_PENDING_PASSKEY"319  | "APPROVE_PASSKEY"320  | "DENY_PASSKEY"321  | "GET_PASSKEY_PROVIDER_STATE"322  | "SET_PASSKEY_PROVIDER_ENABLED"323  | "GET_DELETED_ENTRIES"324  | "RESTORE_ENTRY"325  | "PURGE_ENTRY"326  | "PURGE_EXPIRED_TRASH"327  | "GET_VAULT_HISTORY"328  | "RESTORE_VAULT_SNAPSHOT"329  | "COUNT_DUPLICATES"330  | "DEDUPLICATE_ENTRIES"331  | "RECORD_MANUAL_SUMMON"332  | "DECLINE_CARD_SAVE"333  | "IS_CARD_DECLINED"334  | "GET_VAULT_STATUS"335  | "GET_ADVANCED_HEALTH_REPORT"336  | "DEACTIVATE_LICENSE"337  | "GET_IDENTITIES"338  | "DESTROY_VAULT"339  | "INITIATE_FIREFOX_PASSKEY_CREATE"340  | "COMPLETE_FIREFOX_PASSKEY_CREATE"341  | "PASSKEY_OFFER_DECLINE"342  | "GET_PASSKEY_OFFER_DECLINED"343  | "GET_PASSKEY_FOR_DOMAIN"344  // Firefox content-script proxy path (v2.12.0). Sent FROM the page-world345  // monkey-patch through the extension-world relay TO the background. See346  // src/shared/passkey-flags.ts for removal conditions.347  | "PASSKEY_HAS_CREDENTIALS"348  | "PASSKEY_CREATE"349  | "PASSKEY_GET"350  // Android / iOS message types — activate only when Capacitor.isNativePlatform() is true.351  | "UNLOCK_WITH_KEY"352  | "GET_DERIVED_KEY"353  // Recovery word messages354  | "VALIDATE_RECOVERY_WORDS"355  | "RECOVER_WITH_WORDS"356  | "GET_RECOVERY_WORDS"357  | "GET_IDENTITY_SUGGESTIONS"358  | "TOUCH_AUTO_LOCK"359  | "POPULATE_INLINE_VAULT"360  | "SAVE_NOTE"361  | "DELETE_NOTE"362  | "GET_NOTES"363  | "SEARCH_VAULT"364  | "ML_INIT"365  | "ML_PREDICT_BATCH"366  // Content-script-bound message types — sent BY the background TO content367  // scripts. They never reach messages.ts's switch. Kept in this union so368  // existing call sites type-check; do not add cases for them in the369  // background handler.370  | "PING"            // background → content: liveness probe371  | "SUMMON_AUTOFILL" // background → content: open the in-page palette372  | "VAULT_LOCKED"    // background → content/popup: vault just locked373  | "VAULT_UNLOCKED"  // background → content/popup: vault just unlocked374  | "PRO_GATE_TRIGGERED" // background → popup: a Pro feature was attempted on free375  | "PASSKEY_PRO_GATE" // background → content: show passkey Pro gate in inline popup376  | "OPEN_PRO_GATE" // content → background: open popup and navigate to License section377  | "OPEN_POPUP" // content → background: open the extension popup (e.g. to unlock)378  | "SHOW_PASSKEY_TOAST"    // background → content tab: show passkey auth toast379  | "DISMISS_PASSKEY_TOAST" // background → content tab: dismiss passkey auth toast380  | "PASSKEY_AUTH_RESPONSE" // content → background: user approved or denied the toast381  | "SHOULD_PLAY_CELEBRATION"382  | "MARK_CELEBRATION_PLAYED"383  // Peach Codex (v2.42.0). Generation runs in the popup — the SW only384  // sources vault data and applies the restored slots.385  | "GET_CODEX_VAULT_DATA"386  | "ESTIMATE_CODEX_PAGES"387  | "GENERATE_CODEX"388  | "RESTORE_FROM_CODEX";389390export type ProFeature =391  | "sync"392  | "passkeys"393  | "advanced_health"394  | "ios_app"395  | "codex"396  | "canary_entry"397  | "duress_vault";398399/**400 * License export shape included in PeachScript and encrypted JSON backups.401 * `celebrationPlayed` is intentionally absent — a new device deserves the moment.402 */403export interface PeachLicenseExport {404  key: string;405  activatedAt?: number;406}407408export interface AdvancedHealthEntryReport {409  id: string;410  title: string;411  domain: string;412  url?: string;413  score: number;414  ageDays: number;415  reasons: string[];416  factors: {417    breached: boolean;418    breachCount: number;419    reused: boolean;420    aged: boolean;421    weak: boolean;422    missingTotpOnSensitive: boolean;423  };424}425426export interface AdvancedHealthReport {427  vaultScore: number;428  generatedAt: number;429  entryCount: number;430  reusedGroups: number;431  agedCount: number;432  remediation: AdvancedHealthEntryReport[];433}434435export const ACCENT_COLORS = [436  { name: "peach",    hex: "#F49C70" },437  { name: "rose",     hex: "#FF8AA6" },438  { name: "plum",     hex: "#D597F2" },439  { name: "lavender", hex: "#A6A8FF" },440  { name: "sky",      hex: "#5BC8EE" },441  { name: "mint",     hex: "#5EE0B0" },442  { name: "sage",     hex: "#B5D870" },443  { name: "butter",   hex: "#FFD45A" },444  { name: "sand",     hex: "#EDBC85" },445  { name: "clay",     hex: "#F08660" },446  { name: "slate",    hex: "#80BEDE" },447  { name: "stone",    hex: "#C8B8A8" },448] as const;449450export type AccentColorName = typeof ACCENT_COLORS[number]["name"];451452export interface SavedIdentity {453  value: string;454  type: "email" | "username";455  lastUsed: number;456  useCount: number;457  exampleDomain?: string;458}459460export interface PasswordPolicy {461  minLength?: number;462  maxLength?: number;463  requiresUppercase?: boolean;464  requiresLowercase?: boolean;465  requiresNumbers?: boolean;466  requiresSymbols?: boolean;467  forbidsSymbols?: boolean;468  allowedSymbols?: string;469  /** Characters the site explicitly disallows. Filtered from every pool before generation. */470  forbiddenChars?: string;471}472473/**474 * A single vault history snapshot. The `vault_a` and `vault_b` fields are the475 * raw encrypted blobs from chrome.storage.local — already AES-256-GCM476 * protected by the master password, so storing them in history adds no477 * security surface.478 *479 * Snapshots are taken BEFORE every vault write so the saved blob represents480 * what is about to be lost, not what was just written. The reason field481 * documents the trigger so the UI can render "saved" / "synced" / "imported"482 * / "restored" labels next to each row.483 */484export interface VaultSnapshot {485  id: string;486  savedAt: number;487  reason: "local_save" | "sync_received" | "import" | "restore";488  vault_a: string;489  vault_b: string;490  /**491   * Coarse size bucket (ceiling) of active entries when the snapshot was taken;492   * null if vault was locked or in decoy mode. PCH-01-023: bucketed, not exact,493   * so the plaintext value cannot leak vault size or per-write deltas. UI should494   * render it as "up to N", never as an exact count.495   */496  entryCount: number | null;497}498499export interface VaultHistory {500  /** Newest first; capped at HISTORY_MAX (10). */501  snapshots: VaultSnapshot[];502}503504export interface Message {505  type: MessageType;506  payload?: unknown;507}508509// Canonical snake_case error codes returned by message handlers. Keep this510// union the authoritative catalogue — new handlers must reuse an entry or511// add one here. Free-form strings still appear (network/operation failures512// surface their raw .message), so error stays string at runtime; the union513// is the documented set callers should switch on.514export type ErrorCode =515  | "vault_locked"516  | "vault_corrupted"517  | "no_vault"518  | "entry_not_found"519  | "invalid_payload"520  | "invalid_message"521  | "invalid_sender"522  | "wrong_passphrase"523  | "incorrect_current_password"524  | "recovery_not_setup"525  | "android_only"526  | "not_available"527  | "pro_required"528  | "pairing_not_verified"529  | "sync_rejected_unpaired_initiator"530  | "vault_not_applied"531  | "url_required"532  | "domain_required"533  | "rpid_required"534  | "rpid_and_username_required"535  | "publickeyhex_required"536  | "missing_payload"537  | "login_entries_only"538  | "passkey_not_fillable"539  | "invalid_webhook_url"540  | "invalid_feedback_endpoint"541  | "message_empty"542  | "network_error"543  | "operation_failed"544  | "adopt_invalid_root_key"545  | "adopt_vault_id_mismatch"546  | "unknown_message_type";547548export interface MessageResponse {549  ok: boolean;550  data?: unknown;551  error?: string;552  vaultId?: string;553  unlocked?: boolean;554  // Set on UNLOCK responses when the vault decrypted but failed schema555  // validation (M7/COR-007). The popup may offer a history-restore flow.556  canRestoreFromHistory?: boolean;557  // Set on COPY responses: the effective clipboard auto-clear delay in seconds,558  // so the content script's TOTP toast can advertise the real configured time.559  clearSeconds?: number;560}