@nocobase/app-plugin-mail 0.0.0-stage → 1.0.0-beta.8

package/dist/client/contracts/composer.d.ts

@@ -0,0 +1,68 @@
+import type { MailAccountView, MailIdentity, MailMessage, MailOutboundAttachmentView, MailProviderView, MailPublicError } from '../../shared/mail.js';
+/** Safe variables available when a saved mail template is applied. */
+export type MailTemplateVariables = Readonly<Record<string, unknown>>;
+export interface MailForwardQuote {
+    readonly kind?: 'reply' | 'forward';
+    readonly id: string;
+    readonly accountId: string;
+    readonly attachments: MailMessage['attachments'];
+    readonly html: string;
+    readonly text: string;
+}
+/** Editable values and reply/forward context for one composer session. */
+export interface MailComposerState {
+    readonly mode: 'new' | 'reply' | 'forward' | 'edit';
+    readonly relatedMessageId?: string;
+    readonly forwardBodyIncluded?: boolean;
+    readonly forwardQuote?: MailForwardQuote;
+    readonly removedForwardQuote?: MailForwardQuote;
+    readonly draftMessageId?: string;
+    readonly fromAddress?: string;
+    readonly to: string;
+    readonly cc: string;
+    readonly bcc: string;
+    readonly subject: string;
+    readonly text: string;
+    readonly html: string;
+    readonly scheduledAt: string;
+    readonly draftConflict?: MailMessage['draftConflict'];
+    readonly draftRevision?: number;
+    readonly draftSource?: MailMessage['draftSource'];
+}
+/** Short name used by the Mail-owned composer implementation. */
+export type ComposerState = MailComposerState;
+/** Initial state for a new message. */
+export declare const EMPTY_MAIL_COMPOSER: MailComposerState;
+export interface MailComposerRequest {
+    readonly accountId: string;
+    readonly value: MailComposerState;
+    readonly attachments: MailMessage['attachments'];
+    readonly uploads?: readonly MailOutboundAttachmentView[];
+}
+export type MailComposerCompletionResult = 'accepted' | 'scheduled' | 'draft' | 'unknown' | 'failed' | 'partial' | (string & {});
+/** Inputs shared by the embedded and account-aware workspace composers. */
+export interface MailComposerProps {
+    readonly allowBulkSend?: boolean;
+    readonly senderSelection?: {
+        readonly identityId?: string;
+        readonly options: readonly {
+            readonly accountId: string;
+            readonly identity: MailIdentity;
+        }[];
+        readonly onChange: (accountId: string, identityId: string) => void;
+    };
+    readonly request: MailComposerRequest;
+    readonly accounts: readonly MailAccountView[];
+    readonly providers: readonly MailProviderView[];
+    readonly templateVariables?: MailTemplateVariables;
+    readonly onClose: () => void;
+    readonly onComplete: (result: MailComposerCompletionResult, rejectedRecipients?: readonly string[], error?: MailPublicError) => void;
+}
+export interface MailComposerComponentProps extends MailComposerProps {
+    readonly inline?: boolean;
+    readonly active?: boolean;
+}
+export interface MailWorkspaceComposerProps extends MailComposerProps {
+    readonly onSelectAccount: (accountId: string) => void;
+}
+//# sourceMappingURL=composer.d.ts.map

package/dist/client/contracts/composer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composer.d.ts","sourceRoot":"","sources":["../../../client/contracts/composer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,WAAW,EACX,0BAA0B,EAC1B,gBAAgB,EAChB,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAE9B,sEAAsE;AACtE,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,0EAA0E;AAC1E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACpD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IACzC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,gBAAgB,CAAC;IAChD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IACtD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;CACnD;AAED,iEAAiE;AACjE,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC;AAE9C,uCAAuC;AACvC,eAAO,MAAM,mBAAmB,EAAE,iBAShC,CAAC;AAEH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,0BAA0B,EAAE,CAAC;CAC1D;AAED,MAAM,MAAM,4BAA4B,GACpC,UAAU,GACV,WAAW,GACX,OAAO,GACP,SAAS,GACT,QAAQ,GACR,SAAS,GACT,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,eAAe,CAAC,EAAE;QACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS;YACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;YAC3B,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;SACjC,EAAE,CAAC;QACJ,QAAQ,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;KACpE,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,SAAS,eAAe,EAAE,CAAC;IAC9C,QAAQ,CAAC,SAAS,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAChD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IACnD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,CACnB,MAAM,EAAE,4BAA4B,EACpC,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,EACtC,KAAK,CAAC,EAAE,eAAe,KACpB,IAAI,CAAC;CACX;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,QAAQ,CAAC,eAAe,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACvD"}

package/dist/client/contracts/composer.js

@@ -0,0 +1,12 @@
+/** Initial state for a new message. */
+export const EMPTY_MAIL_COMPOSER = Object.freeze({
+    mode: 'new',
+    to: '',
+    cc: '',
+    bcc: '',
+    subject: '',
+    text: '',
+    html: '',
+    scheduledAt: '',
+});
+//# sourceMappingURL=composer.js.map

package/dist/client/contracts/composer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"composer.js","sourceRoot":"","sources":["../../../client/contracts/composer.ts"],"names":[],"mappings":"AA6CA,uCAAuC;AACvC,MAAM,CAAC,MAAM,mBAAmB,GAAsB,MAAM,CAAC,MAAM,CAAC;IAClE,IAAI,EAAE,KAAK;IACX,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,GAAG,EAAE,EAAE;IACP,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,WAAW,EAAE,EAAE;CAChB,CAAC,CAAC"}

package/dist/client/hooks/use-mail-composer.d.ts

@@ -0,0 +1,52 @@
+import type { Dispatch, SetStateAction, RefObject } from 'react';
+import { useTranslation } from '@nocobase/i18n/client';
+import { type ComposerRecoverySnapshot } from '../lib/mail-composer-state.js';
+import type { ComposerState, MailComposerProps } from '../contracts/composer.js';
+import { type MailIdentity, type MailMessage, type MailOutboundAttachmentView, type MailSignature, type MailTemplate } from '../mail-client.js';
+export declare function useMailComposer({ request, allowBulkSend, senderSelection, accounts, providers, onClose, onComplete, }: MailComposerProps): MailComposerController;
+export interface MailComposerController {
+    readonly restoreDraft: () => void;
+    readonly discardRecovery: () => void;
+    readonly t: ReturnType<typeof useTranslation>['t'];
+    readonly error: string | undefined;
+    readonly composer: ComposerState | undefined;
+    readonly setComposer: Dispatch<SetStateAction<ComposerState | undefined>>;
+    readonly composerAccountId: string;
+    readonly identityId: string;
+    readonly setIdentityId: (id: string) => void;
+    readonly ccVisible: boolean;
+    readonly setCcVisible: Dispatch<SetStateAction<boolean>>;
+    readonly bccVisible: boolean;
+    readonly setBccVisible: Dispatch<SetStateAction<boolean>>;
+    readonly scheduleEnabled: boolean;
+    readonly setScheduleEnabled: Dispatch<SetStateAction<boolean>>;
+    readonly signatures: readonly MailSignature[];
+    readonly signatureId: string;
+    readonly setSignatureId: Dispatch<SetStateAction<string>>;
+    readonly sending: boolean;
+    readonly autoSaving: boolean;
+    readonly draftSaveStatus: 'idle' | 'saving' | 'saved' | 'failed';
+    readonly setDraftSaveStatus: Dispatch<SetStateAction<'idle' | 'saving' | 'saved' | 'failed'>>;
+    readonly recoveryOffer: ComposerRecoverySnapshot | undefined;
+    readonly templates: readonly MailTemplate[];
+    readonly uploading: boolean;
+    readonly composeAttachments: readonly MailOutboundAttachmentView[];
+    readonly setComposeAttachments: Dispatch<SetStateAction<readonly MailOutboundAttachmentView[]>>;
+    readonly retainedAttachments: MailMessage['attachments'];
+    readonly setRetainedAttachments: Dispatch<SetStateAction<MailMessage['attachments']>>;
+    readonly attachmentInputRef: RefObject<HTMLInputElement | null>;
+    readonly sendableComposerIdentities: MailIdentity[];
+    readonly composerCanSend: boolean;
+    readonly composerCanDraft: boolean;
+    readonly closeComposer: (force?: boolean) => void;
+    readonly saveComposer: (closeAfterSave?: boolean) => void;
+    readonly sendComposer: (mode?: 'normal' | 'bulk') => void;
+    readonly uploadInlineImage: (file: File) => Promise<{
+        cid: string;
+        src: string;
+    }>;
+    readonly uploadComposerAttachments: (files: FileList | null) => void;
+    readonly composerHasRequiredContent: boolean;
+    readonly composerHasUnsavedChanges: boolean;
+}
+//# sourceMappingURL=use-mail-composer.d.ts.map

package/dist/client/hooks/use-mail-composer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-mail-composer.d.ts","sourceRoot":"","sources":["../../../client/hooks/use-mail-composer.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAUL,KAAK,wBAAwB,EAC9B,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,0BAA0B,EAC/B,KAAK,aAAa,EAClB,KAAK,YAAY,EAClB,MAAM,mBAAmB,CAAC;AAK3B,wBAAgB,eAAe,CAAC,EAC9B,OAAO,EACP,aAAqB,EACrB,eAAe,EACf,QAAQ,EACR,SAAS,EACT,OAAO,EACP,UAAU,GACX,EAAE,iBAAiB,GAAG,sBAAsB,CAuxB5C;AAeD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,IAAI,CAAC;IACrC,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC;IACnD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,SAAS,CAAC;IAC7C,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,cAAc,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC,CAAC;IAC1E,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACzD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1D,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,QAAQ,CAAC,UAAU,EAAE,SAAS,aAAa,EAAE,CAAC;IAC9C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IACjE,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,CACnC,cAAc,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC,CACvD,CAAC;IACF,QAAQ,CAAC,aAAa,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC7D,QAAQ,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,CAAC;IAC5C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,kBAAkB,EAAE,SAAS,0BAA0B,EAAE,CAAC;IACnE,QAAQ,CAAC,qBAAqB,EAAE,QAAQ,CACtC,cAAc,CAAC,SAAS,0BAA0B,EAAE,CAAC,CACtD,CAAC;IACF,QAAQ,CAAC,mBAAmB,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IACzD,QAAQ,CAAC,sBAAsB,EAAE,QAAQ,CACvC,cAAc,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAC3C,CAAC;IACF,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAChE,QAAQ,CAAC,0BAA0B,EAAE,YAAY,EAAE,CAAC;IACpD,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,QAAQ,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAClD,QAAQ,CAAC,YAAY,EAAE,CAAC,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1D,QAAQ,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,KAAK,IAAI,CAAC;IAC1D,QAAQ,CAAC,iBAAiB,EAAE,CAC1B,IAAI,EAAE,IAAI,KACP,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3C,QAAQ,CAAC,yBAAyB,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,KAAK,IAAI,CAAC;IACrE,QAAQ,CAAC,0BAA0B,EAAE,OAAO,CAAC;IAC7C,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC;CAC7C"}