refactor(src): strip all TSDoc comments (docs move to Nextra)

Removed all 555 /** */ doc-comment blocks from src/** (85 files) ahead of the
dedicated Nextra documentation site. Code is now comment-free; typecheck, audits,
and the full unit suite pass unchanged (behaviour is identical — comments are
inert). The audit-comments policy is unchanged (it already permits zero comments).

Author: zeative

src/auth/adapters/convex.ts

@@ -3,21 +3,12 @@ import type { AuthenticationCreds, SignalDataSet } from 'baileys'
 import { ConvexKv, type ConvexKvOptions, type ConvexKvRow } from '../../types/convex.js'
 import type { AuthCredsStore, AuthStore, AuthStoreBundle, AuthStoreKey, AuthStoreValue } from '../types.js'
 
-/** Constructor input for {@link ConvexAuthStore}. */
 export type ConvexAuthStoreOptions = ConvexKvOptions
 
 const CREDS_KEY = 'creds'
 const SIGNAL_PREFIX = 'signal:'
 const signalKey = (type: string, id: string): string => `${SIGNAL_PREFIX}${type}:${id}`
 
-/**
- * Convex-backed `AuthStoreBundle`. Persists the credentials blob and signal keys
- * as `BufferJSON`-serialized rows in the user-deployed `zaileys_kv` table, reached
- * through a {@link ConvexKv} client (`url` XOR `client`).
- *
- * Requires the `zaileys_kv` schema + functions to be deployed in the Convex project
- * (see the template under `docs/convex/`). `convex` is an optional peer dependency.
- */
 export class ConvexAuthStore implements AuthStoreBundle {
   readonly creds: AuthCredsStore
   readonly signal: AuthStore

src/auth/adapters/file.ts

@@ -12,9 +12,7 @@ import type {
   AuthStoreValue,
 } from '../types.js'
 
-/** Optional constructor input for {@link FileAuthStore}. */
 export interface FileAuthStoreOptions {
-  /** Root directory for persistence. Defaults to `./.zaileys/auth`. */
   basePath?: string
 }
 
@@ -26,10 +24,6 @@ const encodeFilename = (id: string): string =>
 const isENOENT = (err: unknown): boolean =>
   typeof err === 'object' && err !== null && (err as { code?: string }).code === 'ENOENT'
 
-/**
- * Disk-backed `AuthStoreBundle` using atomic write-then-rename for crash safety.
- * Default zero-config layout under `./.zaileys/auth/`.
- */
 export class FileAuthStore implements AuthStoreBundle {
   private readonly basePath: string
   private closed = false
@@ -38,7 +32,6 @@ export class FileAuthStore implements AuthStoreBundle {
     this.basePath = options?.basePath ?? DEFAULT_BASE_PATH
   }
 
-  /** Signal-key store view persisting one JSON file per id under `signal/<type>/`. */
   readonly signal: AuthStore = {
     read: async <K extends AuthStoreKey>(
       type: K,
@@ -114,7 +107,6 @@ export class FileAuthStore implements AuthStoreBundle {
     },
   }
 
-  /** Credential store view persisting `creds.json` at the base directory. */
   readonly creds: AuthCredsStore = {
     readCreds: async (): Promise<AuthenticationCreds | undefined> => {
       this.assertOpen()

src/auth/adapters/memory.ts

@@ -8,16 +8,11 @@ import type {
   AuthStoreValue,
 } from '../types.js'
 
-/**
- * In-process `AuthStoreBundle` backed by JS `Map` instances.
- * Ideal for tests and ephemeral scripts; data is lost on process exit.
- */
 export class MemoryAuthStore implements AuthStoreBundle {
   private credsBlob: AuthenticationCreds | undefined
   private readonly signalMap: Map<AuthStoreKey, Map<string, unknown>> = new Map()
   private closed = false
 
-  /** Signal-key store view backed by the shared in-process map. */
   readonly signal: AuthStore = {
     read: async <K extends AuthStoreKey>(
       type: K,
@@ -71,7 +66,6 @@ export class MemoryAuthStore implements AuthStoreBundle {
     },
   }
 
-  /** Credential store view sharing closure state with {@link MemoryAuthStore.signal}. */
   readonly creds: AuthCredsStore = {
     readCreds: async (): Promise<AuthenticationCreds | undefined> => {
       this.assertOpen()

src/auth/adapters/postgres.ts

@@ -10,13 +10,9 @@ import type {
   AuthStoreValue,
 } from '../types.js'
 
-/** Constructor input for {@link PostgresAuthStore}. XOR between `pool` and `connectionString`. */
 export interface PostgresAuthStoreOptions {
-  /** Caller-owned pg `Pool`. Adapter will NOT end it on close. */
   pool?: Pool
-  /** Connection string for an adapter-owned pool. Adapter ends it on close. */
   connectionString?: string
-  /** Optional `max` pool size when adapter creates the pool. */
   max?: number
 }
 
@@ -44,10 +40,6 @@ const CREATE_CREDS_SQL =
 const CREATE_SIGNAL_SQL =
   'CREATE TABLE IF NOT EXISTS zaileys_auth_signal (type text NOT NULL, id text NOT NULL, data bytea NOT NULL, PRIMARY KEY(type, id))'
 
-/**
- * Postgres-backed `AuthStoreBundle` over node-postgres.
- * Schema auto-migrates idempotently on first method call.
- */
 export class PostgresAuthStore implements AuthStoreBundle {
   private readonly externalPool: Pool | undefined
   private readonly connectionString: string | undefined
@@ -116,7 +108,6 @@ export class PostgresAuthStore implements AuthStoreBundle {
     }
   }
 
-  /** Signal-key store view over `zaileys_auth_signal`. */
   readonly signal: AuthStore = {
     read: async <K extends AuthStoreKey>(
       type: K,
@@ -245,7 +236,6 @@ export class PostgresAuthStore implements AuthStoreBundle {
     },
   }
 
-  /** Credential store view over `zaileys_auth_creds`. */
   readonly creds: AuthCredsStore = {
     readCreds: async (): Promise<AuthenticationCreds | undefined> => {
       const pool = await this.ensureReady()

src/auth/adapters/redis.ts

@@ -10,13 +10,9 @@ import type {
   AuthStoreValue,
 } from '../types.js'
 
-/** Optional constructor input for {@link RedisAuthStore}. */
 export interface RedisAuthStoreOptions {
-  /** Pre-connected node-redis v4 client (caller owns lifecycle). */
   client?: RedisClientType
-  /** Connection URL; adapter creates and owns the client. */
   url?: string
-  /** Namespace prefix isolating keys. Defaults to `'zaileys'`. */
   namespace?: string
 }
 
@@ -41,11 +37,6 @@ const isPeerMissingError = (err: unknown): boolean => {
   return code === 'ERR_MODULE_NOT_FOUND' || code === 'MODULE_NOT_FOUND'
 }
 
-/**
- * Redis-backed `AuthStoreBundle` using node-redis v4.
- * Accepts EITHER a pre-connected `client` OR a `url` (XOR); throws on both.
- * Adapter owns the client lifecycle only when constructed with `url`.
- */
 export class RedisAuthStore implements AuthStoreBundle {
   private readonly namespace: string
   private readonly externalClient: RedisClientType | undefined
@@ -72,7 +63,6 @@ export class RedisAuthStore implements AuthStoreBundle {
     this.url = options.url
   }
 
-  /** Signal-key store view backed by per-id Redis strings and a SET index per type. */
   readonly signal: AuthStore = {
     read: async <K extends AuthStoreKey>(
       type: K,
@@ -147,7 +137,6 @@ export class RedisAuthStore implements AuthStoreBundle {
     },
   }
 
-  /** Credential store view persisting a single Redis string under `<ns>:auth:creds`. */
   readonly creds: AuthCredsStore = {
     readCreds: async (): Promise<AuthenticationCreds | undefined> => {
       this.assertOpen()

src/auth/adapters/sqlite.ts

@@ -28,11 +28,8 @@ type RawDriverCtor = new (
   options?: { readonly?: boolean },
 ) => DatabaseInstance
 
-/** Optional constructor input for {@link SqliteAuthStore}. */
 export interface SqliteAuthStoreOptions {
-  /** Path on disk, or `':memory:'` for an ephemeral connection. */
   database: string | Buffer
-  /** Open the database read-only. */
   readonly?: boolean
 }
 
@@ -76,10 +73,6 @@ const chunked = <T,>(items: readonly T[], size: number): T[][] => {
   return out
 }
 
-/**
- * SQLite-backed `AuthStoreBundle` using `better-sqlite3` with WAL pragmas.
- * Schema migrates idempotently on first use; supports `:memory:` mode.
- */
 export class SqliteAuthStore implements AuthStoreBundle {
   private readonly options: SqliteAuthStoreOptions
   private db: DatabaseInstance | null = null
@@ -91,7 +84,6 @@ export class SqliteAuthStore implements AuthStoreBundle {
     this.options = options
   }
 
-  /** Credential persistence view backed by the `auth_creds` table. */
   readonly creds: AuthCredsStore = {
     readCreds: async (): Promise<AuthenticationCreds | undefined> => {
       const prep = await this.ensureReady()
@@ -110,7 +102,6 @@ export class SqliteAuthStore implements AuthStoreBundle {
     },
   }
 
-  /** Signal-key store view backed by the `auth_signal` table. */
   readonly signal: AuthStore = {
     read: async <K extends AuthStoreKey>(
       type: K,

src/auth/cache.ts

@@ -7,13 +7,6 @@ import type {
   AuthStoreValue,
 } from './types.js'
 
-/**
- * Optional inputs for {@link makeCacheableAuthStore}.
- *
- * `cacheSize` and `cacheTtlSeconds` are reserved for a future iteration —
- * Phase 3 will surface them via the Client `cacheSignal` option. Today the
- * wrapper relies on Baileys' internal NodeCache defaults.
- */
 export interface CacheableAuthStoreOptions {
   logger?: {
     trace?: (msg: unknown) => void
@@ -26,14 +19,6 @@ export interface CacheableAuthStoreOptions {
   cacheTtlSeconds?: number
 }
 
-/**
- * Wrap an {@link AuthStoreBundle} so signal reads hit an LRU cache (Baileys'
- * `makeCacheableSignalKeyStore`). The creds half passes through untouched —
- * caching there has no payoff. Delete invalidates the cache via `set(nulls)`.
- *
- * NOTE: `cacheSize` / `cacheTtlSeconds` options are not yet honoured; Phase 3
- * Client config will own that surface (see plan-007 hand-off in SUMMARY).
- */
 export function makeCacheableAuthStore(
   bundle: AuthStoreBundle,
   options?: CacheableAuthStoreOptions,

src/auth/types.ts

@@ -1,59 +1,26 @@
 import type { AuthenticationCreds, SignalDataSet, SignalDataTypeMap } from 'baileys'
 
-/** Discriminator union for every Baileys signal category. */
 export type AuthStoreKey = keyof SignalDataTypeMap
 
-/** Resolved value type for a given signal category. */
 export type AuthStoreValue<K extends AuthStoreKey> = SignalDataTypeMap[K]
 
-/**
- * Pluggable signal-key store mirroring Baileys' `SignalKeyStore` shape.
- * After {@link AuthStore.close} resolves every other method MUST throw
- * `ZaileysStoreError` with code `STORE_CLOSED`.
- */
 export interface AuthStore {
-  /**
-   * Look up signal values by id within a single category.
-   * @param type Signal category to read.
-   * @param ids Identifiers to fetch.
-   * @returns Map keyed by id; missing ids resolve to `undefined`.
-   */
   read<K extends AuthStoreKey>(
     type: K,
     ids: readonly string[],
   ): Promise<{ [id: string]: AuthStoreValue<K> | undefined }>
-  /**
-   * Persist a partial signal map. `null` values delete the matching id.
-   * @param data Baileys `SignalDataSet` payload (full or partial).
-   */
   write(data: SignalDataSet): Promise<void>
-  /**
-   * Remove ids from a category.
-   * @param type Signal category.
-   * @param ids Identifiers to drop.
-   */
   delete<K extends AuthStoreKey>(type: K, ids: readonly string[]): Promise<void>
-  /** Wipe every signal category (used on 401/410 auto-cleanup). */
   clear(): Promise<void>
-  /** Release backing resources; idempotent. */
   close(): Promise<void>
 }
 
-/**
- * Credential persistence for the long-lived `AuthenticationCreds` blob.
- * After {@link AuthCredsStore} sibling close every method MUST throw
- * `ZaileysStoreError` with code `STORE_CLOSED`.
- */
 export interface AuthCredsStore {
-  /** Load persisted creds; resolves `undefined` when none exist. */
   readCreds(): Promise<AuthenticationCreds | undefined>
-  /** Persist creds atomically. */
   writeCreds(creds: AuthenticationCreds): Promise<void>
-  /** Remove persisted creds. */
   deleteCreds(): Promise<void>
 }
 
-/** Composite bundle handed to the Client to satisfy Baileys auth wiring. */
 export interface AuthStoreBundle {
   readonly creds: AuthCredsStore
   readonly signal: AuthStore

src/automation/broadcast.ts

@@ -3,15 +3,6 @@ import { RateLimiter, type RateLimiterClock } from './rate-limiter.js'
 import { TaskQueue } from './queue.js'
 import type { BroadcastOptions, BroadcastResult } from './types.js'
 
-/**
- * Dependencies for {@link runBroadcast}. Decoupled from `Client` so the core is
- * testable with a mock `sendTo` and an injected limiter/clock.
- *
- * - `sendTo` mirrors `client.send`: a jid in, a fresh `MessageBuilder<'init'>` out.
- * - `limiter` is optional; when omitted one is built from `options.rateLimitPerSec`.
- * - `now`/`sleep` are injectable timing primitives forwarded to the limiter and
- *   retry backoff for fake-timer determinism in tests.
- */
 export type BroadcastDeps = {
   sendTo: (jid: string) => MessageBuilder<'init'>
   limiter?: RateLimiter
@@ -22,18 +13,6 @@ export type BroadcastDeps = {
 const toError = (value: unknown): Error =>
   value instanceof Error ? value : new Error(typeof value === 'string' ? value : String(value))
 
-/**
- * Send one message per jid, paced by a {@link RateLimiter} and isolated so a
- * single recipient failure never halts the run.
- *
- * For each jid: a rate-limit token is acquired, then `build(deps.sendTo(jid))`
- * is dispatched. When `options.retry` is supplied the per-recipient send is
- * wrapped in a {@link TaskQueue} retry loop; otherwise it runs once. Successes
- * land in `result.sent`, failures (after retries) in `result.failed` with the
- * causing error. `onProgress(done, total, jid, ok)` fires after each recipient
- * resolves. The invariant `sent.length + failed.length === jids.length` always
- * holds. An empty `jids` array resolves immediately with empty arrays.
- */
 export async function runBroadcast(
   jids: string[],
   build: (b: MessageBuilder<'init'>) => MessageBuilder<'content-set'>,

src/automation/errors.ts

@@ -1,13 +1,3 @@
-/**
- * Discriminated error codes for {@link ZaileysAutomationError}.
- *
- * - `NOT_CONNECTED` — an automation helper was used while the client socket is absent.
- * - `RATE_LIMIT_INVALID` — a rate-limiter option (e.g. `perSec`) failed validation.
- * - `TASK_FAILED` — a queued task exhausted its retries.
- * - `SCHEDULE_INVALID` — a scheduled-send argument (date/recipient) failed validation.
- * - `STORE_UNAVAILABLE` — schedule persistence was requested without a backing store.
- * - `PRESENCE_FAILED` — the underlying presence update rejected.
- */
 export type AutomationErrorCode =
   | 'NOT_CONNECTED'
   | 'RATE_LIMIT_INVALID'
@@ -16,11 +6,6 @@ export type AutomationErrorCode =
   | 'STORE_UNAVAILABLE'
   | 'PRESENCE_FAILED'
 
-/**
- * Typed error thrown by the automation utilities (rate limiter, queue, broadcast,
- * schedule, presence). The `code` field is the contract surface for callers; keep
- * raw payloads out of `message` and `cause`.
- */
 export class ZaileysAutomationError extends Error {
   readonly code: AutomationErrorCode
   override readonly cause?: unknown