@wirecat/cli-core 0.20.0 → 0.262.0

package/dist/store/sqlite/emails.d.ts

@@ -0,0 +1,206 @@
+import type { Message } from "../../domain/models.js";
+import type { Attachment, Metadata } from "../../meetings/index.js";
+import type { Stemmer, Stemmers } from "../../search/stem.js";
+import type { CacheDatabase } from "../driver.js";
+import type { ConversationSummary, StoredHit } from "../store.js";
+import { type AttachmentInput } from "./meetings.js";
+import type { StoreContext } from "./open.js";
+export interface EmailAddress {
+    address: string;
+    name: string | null;
+}
+export interface MailboxInput {
+    externalId: string;
+    name: string;
+    kind: string | null;
+}
+/** One email to save. A field left out keeps what was stored; the recipients are replaced when any role is given. */
+export interface EmailInput {
+    /** The Message-ID header. */
+    externalId: string;
+    subject: string | null;
+    from: EmailAddress | null;
+    to?: EmailAddress[];
+    cc?: EmailAddress[];
+    bcc?: EmailAddress[];
+    replyTo?: EmailAddress[];
+    sentAt: number | null;
+    receivedAt?: number | null;
+    inReplyTo?: string | null;
+    references?: string[] | null;
+    bodyText: string | null;
+    bodyHtml?: string | null;
+    snippet?: string | null;
+    outgoing?: boolean | null;
+    read?: boolean | null;
+    flagged?: boolean | null;
+    draft?: boolean | null;
+    size?: number | null;
+    headers?: Metadata;
+    metadata?: Metadata;
+    /** Added to the mailboxes the email is already in; one scan sees one folder, so none is taken away. */
+    mailboxes?: MailboxInput[];
+    /** Replaced when given; the text is word-indexed. */
+    attachments?: AttachmentInput[];
+}
+export interface ThreadSave {
+    accountId: number;
+    externalId: string;
+    /** Without it, a new thread takes its first email's subject, without Re: and Fwd:. */
+    subject?: string | null;
+    metadata?: Metadata;
+    emails: EmailInput[];
+    now: number;
+}
+export interface EmailThread {
+    id: number;
+    accountId: number;
+    externalId: string;
+    subject: string | null;
+    lastEmailAt: number | null;
+    emailsCount: number;
+    metadata: Metadata;
+    createdAt: number;
+    updatedAt: number;
+    deletedAt: number | null;
+}
+export interface EmailRecipient {
+    identityId: number | null;
+    address: string;
+    name: string | null;
+    role: "to" | "cc" | "bcc" | "reply_to";
+    position: number;
+}
+export interface Mailbox {
+    id: number;
+    accountId: number;
+    externalId: string;
+    name: string;
+    kind: string | null;
+}
+export type EmailAttachment = Omit<Attachment, "attachableType"> & {
+    attachableType: "email";
+};
+export interface Email {
+    id: number;
+    accountId: number;
+    emailThreadId: number;
+    externalId: string;
+    subject: string | null;
+    fromIdentityId: number | null;
+    fromAddress: string | null;
+    fromName: string | null;
+    sentAt: number | null;
+    receivedAt: number | null;
+    inReplyTo: string | null;
+    references: string[] | null;
+    bodyText: string | null;
+    bodyHtml: string | null;
+    snippet: string | null;
+    outgoing: boolean | null;
+    read: boolean | null;
+    flagged: boolean | null;
+    draft: boolean | null;
+    size: number | null;
+    headers: Metadata;
+    metadata: Metadata;
+    recipients: EmailRecipient[];
+    mailboxes: Mailbox[];
+    attachments: EmailAttachment[];
+    createdAt: number;
+    updatedAt: number;
+    deletedAt: number | null;
+}
+export interface ThreadDetails {
+    thread: EmailThread;
+    /** Oldest first. */
+    emails: Email[];
+}
+/** An email and the thread it is in, as a conversation hit shows them. */
+export interface EmailInThread {
+    emailId: number;
+    externalId: string;
+    threadExternalId: string;
+    /** The thread's first email, and its first and last time. */
+    threadFirstExternalId: string;
+    threadFirstAt: number | null;
+    threadLastAt: number | null;
+    threadEmails: number;
+    threadSenders: number;
+}
+export interface EmailVectorHit extends EmailInThread {
+    score: number;
+}
+/** A thread as a conversation: the summary `search conversations` and `related` answer for an email. */
+export declare const threadConversation: (place: EmailInThread, builtAt: number) => ConversationSummary;
+export interface MailFilter {
+    accountId?: number;
+    includeDeleted?: boolean;
+    limit?: number;
+    offset?: number;
+}
+export interface EmailFilter extends MailFilter {
+    threadExternalId?: string;
+    /** An address in From, To, Cc, Bcc or Reply-To. */
+    participant?: string;
+    /** A mailbox's external id. */
+    mailbox?: string;
+    /** On the received time, or the sent time when that is unknown: IMAP's SINCE counts by the received day. */
+    since?: number;
+    /** Exclusive. */
+    until?: number;
+}
+/** Mail in tables of its own: threads, emails, recipients and mailboxes, keyed by account and Message-ID. */
+export interface MailStore {
+    saveThread(input: ThreadSave): Promise<ThreadDetails>;
+    /** Newest activity first. */
+    threads(filter?: MailFilter): Promise<EmailThread[]>;
+    thread(id: number): Promise<ThreadDetails | null>;
+    email(accountId: number, externalId: string): Promise<Email | null>;
+    /** Newest first. */
+    emails(filter?: EmailFilter): Promise<Email[]>;
+    mailboxes(accountId: number): Promise<Mailbox[]>;
+    /**
+     * Sets each email's membership among the `scanned` mailboxes to the ones it was found in; membership outside
+     * `scanned` stays, since a scan proves nothing about a folder it did not read. Answers how many emails it found.
+     */
+    setMailboxes(accountId: number, scanned: MailboxInput[], found: ReadonlyMap<string, string[]>, now: number): Promise<number>;
+    /**
+     * Read and flagged as the source shows them now, for emails already stored; a flag left out stays. Answers how
+     * many emails changed.
+     */
+    setFlags(accountId: number, flags: ReadonlyMap<string, {
+        read?: boolean;
+        flagged?: boolean;
+    }>, now: number): Promise<number>;
+    /** Marks emails gone at the source and drops their text; saving one again brings it back. Answers how many changed. */
+    markDeleted(accountId: number, externalIds: string[], now: number): Promise<number>;
+    /** Every word of the query, as a prefix, in the subject or body; newest first. */
+    search(query: string, filter?: Omit<EmailFilter, "includeDeleted">): Promise<Email[]>;
+    /** Text pieces of live emails with no vector of `model`, by content hash, for an embedder to fill. */
+    chunksToEmbed(model: string, options: {
+        after?: string;
+        limit: number;
+    }): Promise<{
+        hash: string;
+        text: string;
+    }[]>;
+    /** Live emails of one account by Message-ID, each placed in its thread; an unknown one is left out. */
+    inThreads(accountId: number, externalIds: string[]): Promise<EmailInThread[]>;
+    /** A thread's live emails, oldest first, as search hits: whole text, people, labels and locator. */
+    threadHits(accountId: number, threadExternalId: string): Promise<StoredHit[]>;
+    /** The emails of one account nearest in meaning to `query`, each by its best chunk, best first. */
+    nearest(model: string, query: Float32Array, options: {
+        accountId: number;
+        limit: number;
+        threadExternalId?: string;
+        since?: number;
+    }): Promise<EmailVectorHit[]>;
+}
+/** An email as a message of its thread, the shape mail had when it was stored as messages. */
+export declare const messageOfEmail: (email: Email, thread: string) => Message;
+/** Emails as search hits, in the order of `pks`: the thread is the chat, so a hit's locator is the one mail had as messages. */
+export declare const emailHitsByPk: (database: CacheDatabase, pks: number[]) => StoredHit[];
+export declare const drainEmailIndex: (database: CacheDatabase, stemmerFor: (stemmers: Stemmers) => Stemmer) => number;
+export declare const mailStoreOver: ({ database, orm }: Pick<StoreContext, "database" | "orm">, stemmerFor?: (stemmers: Stemmers) => Stemmer) => MailStore;
+//# sourceMappingURL=emails.d.ts.map

package/dist/store/sqlite/emails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emails.d.ts","sourceRoot":"","sources":["../../../src/store/sqlite/emails.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAA0B,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAY,MAAM,cAAc,CAAA;AAE3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGjE,OAAO,EAAE,KAAK,eAAe,EAA4C,MAAM,eAAe,CAAA;AAE9F,OAAO,KAAK,EAAO,YAAY,EAAE,MAAM,WAAW,CAAA;AAOlD,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,qHAAqH;AACrH,MAAM,WAAW,UAAU;IACzB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,IAAI,EAAE,YAAY,GAAG,IAAI,CAAA;IACzB,EAAE,CAAC,EAAE,YAAY,EAAE,CAAA;IACnB,EAAE,CAAC,EAAE,YAAY,EAAE,CAAA;IACnB,GAAG,CAAC,EAAE,YAAY,EAAE,CAAA;IACpB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,uGAAuG;IACvG,SAAS,CAAC,EAAE,YAAY,EAAE,CAAA;IAC1B,qDAAqD;IACrD,WAAW,CAAC,EAAE,eAAe,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,QAAQ,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,UAAU,CAAA;IACtC,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,GAAG;IAAE,cAAc,EAAE,OAAO,CAAA;CAAE,CAAA;AAE9F,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAA;IACxB,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;IACpB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,EAAE,QAAQ,CAAA;IACjB,QAAQ,EAAE,QAAQ,CAAA;IAClB,UAAU,EAAE,cAAc,EAAE,CAAA;IAC5B,SAAS,EAAE,OAAO,EAAE,CAAA;IACpB,WAAW,EAAE,eAAe,EAAE,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAA;IACnB,oBAAoB;IACpB,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB;AAED,0EAA0E;AAC1E,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,6DAA6D;IAC7D,qBAAqB,EAAE,MAAM,CAAA;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,wGAAwG;AACxG,eAAO,MAAM,kBAAkB,UAAW,aAAa,WAAW,MAAM,KAAG,mBAUzE,CAAA;AA2BF,MAAM,WAAW,UAAU;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,4GAA4G;IAC5G,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,6GAA6G;AAC7G,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IACrD,6BAA6B;IAC7B,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IACpD,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IACjD,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;IACnE,oBAAoB;IACpB,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IAC9C,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAChD;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,YAAY,EAAE,EACvB,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EACpC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB;;;OAGG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,EACjE,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,uHAAuH;IACvH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IACnF,kFAAkF;IAClF,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IACrF,sGAAsG;IACtG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC,CAAA;IACnH,uGAAuG;IACvG,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;IAC7E,oGAAoG;IACpG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAC7E,mGAAmG;IACnG,OAAO,CACL,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,YAAY,EACnB,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACvF,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;CAC7B;AAsdD,8FAA8F;AAC9F,eAAO,MAAM,cAAc,UAAW,KAAK,UAAU,MAAM,KAAG,OA0B7D,CAAA;AAqCD,gIAAgI;AAChI,eAAO,MAAM,aAAa,aAAc,aAAa,OAAO,MAAM,EAAE,KAAG,SAAS,EA2B/E,CAAA;AASD,eAAO,MAAM,eAAe,aAAc,aAAa,cAAc,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,KAAG,MA+DtG,CAAA;AAED,eAAO,MAAM,aAAa,sBACL,IAAI,CAAC,YAAY,EAAE,UAAU,GAAG,KAAK,CAAC,eAC7C,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,KAC1C,SAwND,CAAA"}