@webiny/api-mailer 0.0.0-unstable.5e7233243f → 0.0.0-unstable.fcdad0bc61

package/types.d.ts

@@ -1,59 +1,149 @@
-import { Context } from "@webiny/api/types";
+import { CmsContext } from "@webiny/api-headless-cms/types";
 import { Topic } from "@webiny/pubsub/types";
-export interface MailerContextObjectSendParams {
-    data: MailerSendData;
-}
-export declare type MailerSetterParams = Mailer | (() => Promise<Mailer>);
-export interface MailerSetter {
-    (mailer: MailerSetterParams): void;
-}
-export interface MailerContextObject {
-    onBeforeSend: Topic<OnBeforeMailerSendParams>;
-    onAfterSend: Topic<OnAfterMailerSendParams>;
-    onError: Topic<OnErrorMailerParams>;
-    setMailer: MailerSetter;
-    getMailer: <T extends Mailer = Mailer>() => Promise<T>;
-    send: <T>(params: MailerContextObjectSendParams) => Promise<MailerSendResponse<T>>;
-}
-export interface MailerContext extends Context {
-    mailer: MailerContextObject;
+export interface MailerTransporterContext<T extends Transport = Transport> {
+    onTransportBeforeSend: Topic<OnTransportBeforeSendParams>;
+    onTransportAfterSend: Topic<OnTransportAfterSendParams>;
+    onTransportError: Topic<OnTransportErrorParams>;
+    getTransport: () => Promise<T | null>;
+    sendMail: <D>(data: TransportSendData) => Promise<TransportSendResponse<D>>;
+}
+export interface MailerSettingsCreateParams {
+    input: Partial<TransportSettings>;
+}
+export interface MailerSettingsUpdateParams {
+    input: Partial<TransportSettings>;
+    original?: ExtendedTransportSettings | null;
+}
+export interface MailerSettingsSaveParams {
+    input: Partial<TransportSettings>;
+}
+export interface OnSettingsBeforeGetTopicParams {
+    tenant: string;
+}
+export interface OnSettingsAfterGetTopicParams {
+    tenant: string;
+    settings: TransportSettings | null;
+}
+export interface OnSettingsGetErrorTopicParams {
+    tenant: string;
+    error: Error;
 }
-export interface MailerConfig<T extends Mailer = Mailer> {
-    mailer?: T;
+export interface OnSettingsBeforeCreateTopicParams {
+    settings: TransportSettings;
 }
-export interface OnBeforeMailerSendParams {
-    data: MailerSendData;
+export interface OnSettingsAfterCreateTopicParams {
+    settings: TransportSettings;
 }
-export interface OnAfterMailerSendParams {
-    data: MailerSendData;
+export interface OnSettingsCreateErrorTopicParams {
+    settings: TransportSettings;
+    error: Error;
+}
+export interface OnSettingsBeforeUpdateTopicParams {
+    settings: TransportSettings;
+    original: TransportSettings;
 }
-export interface OnErrorMailerParams {
+export interface OnSettingsAfterUpdateTopicParams {
+    original: TransportSettings;
+    settings: TransportSettings;
+}
+export interface OnSettingsUpdateErrorTopicParams {
+    original: TransportSettings;
+    settings: TransportSettings;
     error: Error;
-    data: MailerSendData;
+}
+export interface ExtendedTransportSettings extends TransportSettings {
+    id: string;
+}
+export interface MailerSettingsContext {
+    getSettings: () => Promise<ExtendedTransportSettings | null>;
+    /**
+     * Method should not be used outside of mailer
+     * @internal
+     */
+    createSettings: (params: MailerSettingsCreateParams) => Promise<TransportSettings>;
+    /**
+     * Method should not be used outside of mailer
+     * @internal
+     */
+    updateSettings: (params: MailerSettingsUpdateParams) => Promise<TransportSettings>;
+    /**
+     * Use to store the settings data.
+     */
+    saveSettings: (params: MailerSettingsSaveParams) => Promise<TransportSettings>;
+    /**
+     * Lifecycle events
+     */
+    onSettingsBeforeGet: Topic<OnSettingsBeforeGetTopicParams>;
+    onSettingsAfterGet: Topic<OnSettingsAfterGetTopicParams>;
+    onSettingsGetError: Topic<OnSettingsGetErrorTopicParams>;
+    onSettingsBeforeCreate: Topic<OnSettingsBeforeCreateTopicParams>;
+    onSettingsAfterCreate: Topic<OnSettingsAfterCreateTopicParams>;
+    onSettingsCreateError: Topic<OnSettingsCreateErrorTopicParams>;
+    onSettingsBeforeUpdate: Topic<OnSettingsBeforeUpdateTopicParams>;
+    onSettingsAfterUpdate: Topic<OnSettingsAfterUpdateTopicParams>;
+    onSettingsUpdateError: Topic<OnSettingsUpdateErrorTopicParams>;
+}
+export interface MailerContextObject<T extends Transport = Transport> extends MailerTransporterContext<T>, MailerSettingsContext {
+}
+export interface MailerContext extends CmsContext {
+    mailer: MailerContextObject;
+}
+export interface OnTransportBeforeSendParams {
+    data: TransportSendData;
+    transport: Transport;
+}
+export interface OnTransportAfterSendParams {
+    data: TransportSendData;
+    transport: Transport;
+}
+export interface OnTransportErrorParams {
+    error: Error;
+    data: TransportSendData;
+    transport: Transport;
 }
 /**
  * Interface to implement the actual mailer.
  */
-export interface MailerSendResponse<T = any> {
+export interface TransportSendResponse<T = any> {
     result: T | null;
     error: {
         message: string;
         code: string;
-        data: {
+        data?: {
             [key: string]: any;
         };
     } | null;
 }
-export interface MailerSendData {
+interface TransportSendToData {
     to: string[];
-    from: string;
+}
+interface TransportSendCcData {
+    cc: string[];
+}
+interface TransportSendBccData {
+    bcc: string[];
+}
+interface BaseTransportSendData {
+    to?: string[];
+    cc?: string[];
+    bcc?: string[];
+    from?: string;
     subject: string;
     text: string;
     html?: string;
     replyTo?: string;
-    cc?: string[];
-    bcc?: string[];
 }
-export interface Mailer<T = any> {
-    send: (params: MailerSendData) => Promise<MailerSendResponse<T>>;
+export declare type TransportSendData = BaseTransportSendData & (TransportSendToData | TransportSendBccData | TransportSendCcData);
+export interface Transport<T = any> {
+    name: string;
+    send: (params: TransportSendData) => Promise<TransportSendResponse<T>>;
+}
+export interface TransportSettings {
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    from: string;
+    replyTo?: string;
 }
+export {};

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { Context } from \"@webiny/api/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\n\nexport interface MailerContextObjectSendParams {\n    data: MailerSendData;\n}\n\nexport type MailerSetterParams = Mailer | (() => Promise<Mailer>);\n\nexport interface MailerSetter {\n    (mailer: MailerSetterParams): void;\n}\n\nexport interface MailerContextObject {\n    onBeforeSend: Topic<OnBeforeMailerSendParams>;\n    onAfterSend: Topic<OnAfterMailerSendParams>;\n    onError: Topic<OnErrorMailerParams>;\n    setMailer: MailerSetter;\n    getMailer: <T extends Mailer = Mailer>() => Promise<T>;\n    send: <T>(params: MailerContextObjectSendParams) => Promise<MailerSendResponse<T>>;\n}\nexport interface MailerContext extends Context {\n    mailer: MailerContextObject;\n}\n\nexport interface MailerConfig<T extends Mailer = Mailer> {\n    mailer?: T;\n}\n\nexport interface OnBeforeMailerSendParams {\n    data: MailerSendData;\n}\nexport interface OnAfterMailerSendParams {\n    data: MailerSendData;\n}\nexport interface OnErrorMailerParams {\n    error: Error;\n    data: MailerSendData;\n}\n\n/**\n * Interface to implement the actual mailer.\n */\nexport interface MailerSendResponse<T = any> {\n    result: T | null;\n    error: {\n        message: string;\n        code: string;\n        data: {\n            [key: string]: any;\n        };\n    } | null;\n}\n\nexport interface MailerSendData {\n    to: string[];\n    from: string;\n    subject: string;\n    text: string;\n    html?: string;\n    replyTo?: string;\n    cc?: string[];\n    bcc?: string[];\n}\nexport interface Mailer<T = any> {\n    send: (params: MailerSendData) => Promise<MailerSendResponse<T>>;\n}\n"],"mappings":""}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { CmsContext } from \"@webiny/api-headless-cms/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\n\nexport interface MailerTransporterContext<T extends Transport = Transport> {\n    onTransportBeforeSend: Topic<OnTransportBeforeSendParams>;\n    onTransportAfterSend: Topic<OnTransportAfterSendParams>;\n    onTransportError: Topic<OnTransportErrorParams>;\n    getTransport: () => Promise<T | null>;\n    sendMail: <D>(data: TransportSendData) => Promise<TransportSendResponse<D>>;\n}\n\nexport interface MailerSettingsCreateParams {\n    input: Partial<TransportSettings>;\n}\nexport interface MailerSettingsUpdateParams {\n    input: Partial<TransportSettings>;\n    original?: ExtendedTransportSettings | null;\n}\n\nexport interface MailerSettingsSaveParams {\n    input: Partial<TransportSettings>;\n}\n\nexport interface OnSettingsBeforeGetTopicParams {\n    tenant: string;\n}\n\nexport interface OnSettingsAfterGetTopicParams {\n    tenant: string;\n    settings: TransportSettings | null;\n}\n\nexport interface OnSettingsGetErrorTopicParams {\n    tenant: string;\n    error: Error;\n}\n\nexport interface OnSettingsBeforeCreateTopicParams {\n    settings: TransportSettings;\n}\n\nexport interface OnSettingsAfterCreateTopicParams {\n    settings: TransportSettings;\n}\n\nexport interface OnSettingsCreateErrorTopicParams {\n    settings: TransportSettings;\n    error: Error;\n}\n\nexport interface OnSettingsBeforeUpdateTopicParams {\n    settings: TransportSettings;\n    original: TransportSettings;\n}\n\nexport interface OnSettingsAfterUpdateTopicParams {\n    original: TransportSettings;\n    settings: TransportSettings;\n}\n\nexport interface OnSettingsUpdateErrorTopicParams {\n    original: TransportSettings;\n    settings: TransportSettings;\n    error: Error;\n}\n\nexport interface ExtendedTransportSettings extends TransportSettings {\n    id: string;\n}\n\nexport interface MailerSettingsContext {\n    getSettings: () => Promise<ExtendedTransportSettings | null>;\n    /**\n     * Method should not be used outside of mailer\n     * @internal\n     */\n    createSettings: (params: MailerSettingsCreateParams) => Promise<TransportSettings>;\n    /**\n     * Method should not be used outside of mailer\n     * @internal\n     */\n    updateSettings: (params: MailerSettingsUpdateParams) => Promise<TransportSettings>;\n    /**\n     * Use to store the settings data.\n     */\n    saveSettings: (params: MailerSettingsSaveParams) => Promise<TransportSettings>;\n    /**\n     * Lifecycle events\n     */\n    onSettingsBeforeGet: Topic<OnSettingsBeforeGetTopicParams>;\n    onSettingsAfterGet: Topic<OnSettingsAfterGetTopicParams>;\n    onSettingsGetError: Topic<OnSettingsGetErrorTopicParams>;\n    onSettingsBeforeCreate: Topic<OnSettingsBeforeCreateTopicParams>;\n    onSettingsAfterCreate: Topic<OnSettingsAfterCreateTopicParams>;\n    onSettingsCreateError: Topic<OnSettingsCreateErrorTopicParams>;\n    onSettingsBeforeUpdate: Topic<OnSettingsBeforeUpdateTopicParams>;\n    onSettingsAfterUpdate: Topic<OnSettingsAfterUpdateTopicParams>;\n    onSettingsUpdateError: Topic<OnSettingsUpdateErrorTopicParams>;\n}\n\nexport interface MailerContextObject<T extends Transport = Transport>\n    extends MailerTransporterContext<T>,\n        MailerSettingsContext {}\nexport interface MailerContext extends CmsContext {\n    mailer: MailerContextObject;\n}\n\nexport interface OnTransportBeforeSendParams {\n    data: TransportSendData;\n    transport: Transport;\n}\nexport interface OnTransportAfterSendParams {\n    data: TransportSendData;\n    transport: Transport;\n}\nexport interface OnTransportErrorParams {\n    error: Error;\n    data: TransportSendData;\n    transport: Transport;\n}\n\n/**\n * Interface to implement the actual mailer.\n */\nexport interface TransportSendResponse<T = any> {\n    result: T | null;\n    error: {\n        message: string;\n        code: string;\n        data?: {\n            [key: string]: any;\n        };\n    } | null;\n}\n\ninterface TransportSendToData {\n    to: string[];\n}\ninterface TransportSendCcData {\n    cc: string[];\n}\ninterface TransportSendBccData {\n    bcc: string[];\n}\n\ninterface BaseTransportSendData {\n    to?: string[];\n    cc?: string[];\n    bcc?: string[];\n    from?: string;\n    subject: string;\n    text: string;\n    html?: string;\n    replyTo?: string;\n}\n\nexport type TransportSendData = BaseTransportSendData &\n    (TransportSendToData | TransportSendBccData | TransportSendCcData);\nexport interface Transport<T = any> {\n    name: string;\n    send: (params: TransportSendData) => Promise<TransportSendResponse<T>>;\n}\n\nexport interface TransportSettings {\n    host: string;\n    port: number;\n    user: string;\n    password: string;\n    from: string;\n    replyTo?: string;\n}\n"],"mappings":""}