@thezelijah/majik-message 1.1.1 → 1.1.3

package/dist/core/database/thread/majik-message-thread.d.ts

@@ -0,0 +1,166 @@
+import { ThreadStatus } from "./enums";
+import { ISODateString, MajikMessageAccountID, MajikMessagePublicKey, MajikMessageThreadID } from "../../types";
+import { MajikUserID } from "@thezelijah/majik-user";
+import { MajikMessageMailJSON } from "./mail/majik-message-mail";
+import { MajikMessageIdentity } from "../system/identity";
+export interface ThreadMetadata {
+    title?: string;
+    subject?: string;
+    tags?: string[];
+    category?: string;
+    priority?: "low" | "medium" | "high" | "urgent";
+    lastActivity?: ISODateString;
+    messageCount?: number;
+}
+export interface DeletionApproval {
+    publicKey: string;
+    approvalHash: string;
+    timestamp: Date;
+}
+export interface MajikMessageThreadAnalytics {
+    threadID: MajikMessageThreadID;
+    owner: MajikMessageAccountID;
+    userID: MajikUserID;
+    participantCount: number;
+    messageCount: number;
+    status: ThreadStatus;
+    createdAt: string;
+    lastActivity: string | undefined;
+    duration: number;
+    tags: string[];
+    category: string | undefined;
+    priority: string | undefined;
+    starred: boolean;
+    deletionStatus: {
+        isPendingDeletion: boolean;
+        isMarkedForDeletion: boolean;
+        approvalProgress: number;
+        approvedCount: number;
+        totalParticipants: number;
+    };
+}
+export interface MajikMessageThreadSummary {
+    id: MajikMessageThreadID;
+    participants: MajikMessagePublicKey[];
+    participant_count: number;
+    latest_message: MajikMessageMailJSON;
+    latest_message_timestamp: ISODateString;
+    total_messages: number;
+    unread_count: number;
+    has_unread: boolean;
+    starred: boolean;
+}
+export interface MajikMessageThreadJSON {
+    id: MajikMessageThreadID;
+    user_id: MajikUserID;
+    owner: MajikMessageAccountID;
+    metadata: ThreadMetadata;
+    timestamp: ISODateString;
+    participants: string[];
+    status: ThreadStatus;
+    hash: string;
+    deletion_approvals: DeletionApproval[];
+    starred: boolean;
+}
+export declare class MajikThreadError extends Error {
+    code: string;
+    constructor(message: string, code: string);
+}
+export declare class ValidationError extends MajikThreadError {
+    constructor(message: string);
+}
+export declare class OperationNotAllowedError extends MajikThreadError {
+    constructor(message: string);
+}
+export declare class MajikMessageThread {
+    private readonly _id;
+    private readonly _userID;
+    private readonly _owner;
+    private _metadata;
+    private readonly _timestamp;
+    private readonly _participants;
+    private _status;
+    private readonly _hash;
+    private _deletionApprovals;
+    private _starred;
+    private constructor();
+    get id(): MajikMessageThreadID;
+    get userID(): MajikUserID;
+    get owner(): MajikMessagePublicKey;
+    get metadata(): Readonly<ThreadMetadata>;
+    get timestamp(): Date;
+    get participants(): readonly MajikMessagePublicKey[];
+    get status(): ThreadStatus;
+    get hash(): string;
+    get deletionApprovals(): readonly DeletionApproval[];
+    get starred(): boolean;
+    static create(userID: MajikUserID, owner: MajikMessageIdentity, participants: MajikMessagePublicKey[], metadata?: ThreadMetadata): MajikMessageThread;
+    /**
+     * Stars the thread for the user
+     */
+    star(): void;
+    /**
+     * Unstars the thread for the user
+     */
+    unstar(): void;
+    /**
+     * Toggles the starred status of the thread
+     * @returns The new starred state
+     */
+    toggleStar(): boolean;
+    private static generateHash;
+    private static generateApprovalHash;
+    validate(): boolean;
+    close(): void;
+    requestDeletion(publicKey: string): void;
+    private updateDeletionStatus;
+    revokeDeletionRequest(publicKey: string): void;
+    canBeDeleted(): boolean;
+    getDeletionProgress(): {
+        approved: number;
+        total: number;
+        percentage: number;
+    };
+    /**
+     * Verifies that all deletion approvals have valid hashes and all participants have approved
+     * @returns true if all approvals are valid and complete, false otherwise
+     */
+    verifyDeletionApprovals(): boolean;
+    /**
+     * Get detailed verification status of deletion approvals
+     * @returns Detailed information about approval validity
+     */
+    getDeletionApprovalStatus(): {
+        isValid: boolean;
+        allParticipantsApproved: boolean;
+        invalidApprovals: string[];
+        missingApprovals: string[];
+        duplicateApprovals: string[];
+    };
+    updateMetadata(metadata: Partial<ThreadMetadata>): void;
+    toJSON(): MajikMessageThreadJSON;
+    static fromJSON(json: MajikMessageThreadJSON | string): MajikMessageThread;
+    isOwner(publicKey: string): boolean;
+    isParticipant(publicKey: string): boolean;
+    toString(): string;
+    /**
+     * Deduplicates and sorts participants to ensure consistent ordering
+     */
+    private static normalizeParticipants;
+    /**
+     * Exports the thread with finalized metadata for analytics and archival purposes.
+     * This method updates metadata with actual counts and stats, sets lastActivity,
+     * and optionally closes the thread if no deletion is pending.
+     *
+     * @param messageCount - The actual number of messages in this thread
+     * @param additionalTags - Optional tags to add to existing tags
+     * @param autoClose - Whether to automatically close the thread (default: true)
+     * @returns MajikMessageThreadJSON with updated metadata
+     */
+    exportFinalStats(messageCount: number, additionalTags?: string[], autoClose?: boolean): MajikMessageThreadJSON;
+    /**
+     * Exports analytics-ready data for the thread
+     * @returns Object with analytics metadata
+     */
+    getAnalyticsData(): MajikMessageThreadAnalytics;
+}