@holo-js/mail 0.1.3

package/dist/contracts.d.ts

@@ -0,0 +1,320 @@
+import { HoloAppEnv, NormalizedHoloMailConfig } from '@holo-js/config';
+export { defineMailConfig } from '@holo-js/config';
+
+declare const MAIL_PRIORITY_VALUES: readonly ["high", "normal", "low"];
+declare const MAIL_ATTACHMENT_DISPOSITIONS: readonly ["attachment", "inline"];
+type MailJsonPrimitive = string | number | boolean | null;
+type MailJsonValue = MailJsonPrimitive | readonly MailJsonValue[] | {
+    readonly [key: string]: MailJsonValue;
+};
+interface MailJsonObject {
+    readonly [key: string]: MailJsonValue;
+}
+type MailPriority = (typeof MAIL_PRIORITY_VALUES)[number];
+type MailDelayValue = number | Date;
+type MailAttachmentDisposition = (typeof MAIL_ATTACHMENT_DISPOSITIONS)[number];
+type MailPreviewFormat = 'html' | 'json' | 'text';
+type MailContentSourceKind = 'text' | 'html' | 'markdown' | 'render';
+interface MailAddress {
+    readonly email: string;
+    readonly name?: string;
+}
+type MailAddressInput = string | {
+    readonly email: string;
+    readonly name?: string;
+};
+type MailRecipientsInput = MailAddressInput | readonly MailAddressInput[];
+interface MailRenderSource {
+    readonly view: string;
+    readonly props?: MailJsonObject;
+}
+interface MailViewRenderInput {
+    readonly view: string;
+    readonly props?: MailJsonObject;
+}
+interface MailQueueOptions {
+    readonly queued?: boolean;
+    readonly connection?: string;
+    readonly queue?: string;
+    readonly afterCommit?: boolean;
+}
+type MailAttachmentContent = string | Uint8Array;
+interface MailAttachmentBase {
+    readonly name?: string;
+    readonly contentType?: string;
+    readonly disposition?: MailAttachmentDisposition;
+    readonly contentId?: string;
+}
+interface MailPathAttachment extends MailAttachmentBase {
+    readonly path: string;
+}
+interface MailStorageAttachment extends MailAttachmentBase {
+    readonly storage: {
+        readonly path: string;
+        readonly disk?: string;
+    };
+}
+interface MailContentAttachment extends MailAttachmentBase {
+    readonly content: MailAttachmentContent;
+    readonly name: string;
+}
+interface MailResolvedAttachmentPayload extends MailAttachmentBase {
+    readonly path?: string;
+    readonly storage?: {
+        readonly path: string;
+        readonly disk?: string;
+    };
+    readonly content?: MailAttachmentContent;
+    readonly name?: string;
+}
+interface MailResolvableAttachment extends MailAttachmentBase {
+    readonly resolve: () => MailResolvedAttachmentPayload | Promise<MailResolvedAttachmentPayload>;
+}
+type MailAttachmentInput = MailPathAttachment | MailStorageAttachment | MailContentAttachment | MailResolvableAttachment;
+interface MailAttachmentHelperOptions extends MailAttachmentBase {
+    readonly disposition?: MailAttachmentDisposition;
+}
+interface MailStorageAttachmentHelperOptions extends MailAttachmentHelperOptions {
+    readonly disk?: string;
+}
+interface MailContentAttachmentHelperOptions extends MailAttachmentHelperOptions {
+    readonly name: string;
+}
+interface MailDefinitionInput {
+    readonly mailer?: string;
+    readonly from?: MailAddressInput;
+    readonly replyTo?: MailAddressInput;
+    readonly to: MailRecipientsInput;
+    readonly cc?: MailRecipientsInput;
+    readonly bcc?: MailRecipientsInput;
+    readonly subject: string;
+    readonly text?: string;
+    readonly html?: string;
+    readonly markdown?: string;
+    readonly render?: MailRenderSource;
+    readonly markdownWrapper?: string;
+    readonly attachments?: readonly MailAttachmentInput[];
+    readonly headers?: Readonly<Record<string, string>>;
+    readonly tags?: readonly string[];
+    readonly metadata?: MailJsonObject;
+    readonly priority?: MailPriority;
+    readonly queue?: boolean | MailQueueOptions;
+    readonly delay?: MailDelayValue;
+}
+type MailOverrideInput = Readonly<Partial<MailDefinitionInput>>;
+interface MailDefinition {
+    readonly mailer?: string;
+    readonly from?: MailAddress;
+    readonly replyTo?: MailAddress;
+    readonly to: readonly MailAddress[];
+    readonly cc: readonly MailAddress[];
+    readonly bcc: readonly MailAddress[];
+    readonly subject: string;
+    readonly text?: string;
+    readonly html?: string;
+    readonly markdown?: string;
+    readonly render?: Readonly<MailRenderSource>;
+    readonly markdownWrapper?: string;
+    readonly attachments: readonly MailAttachmentInput[];
+    readonly headers: Readonly<Record<string, string>>;
+    readonly tags: readonly string[];
+    readonly metadata?: MailJsonObject;
+    readonly priority?: MailPriority;
+    readonly queue?: boolean | Readonly<MailQueueOptions>;
+    readonly delay?: MailDelayValue;
+}
+interface MailAttachmentMetadata {
+    readonly source: 'path' | 'storage' | 'content' | 'resolve';
+    readonly name?: string;
+    readonly contentType?: string;
+    readonly disposition: MailAttachmentDisposition;
+    readonly contentId?: string;
+}
+interface MailAttachmentResolutionContext {
+    readonly queued: boolean;
+}
+interface ResolvedMailAttachment extends MailAttachmentMetadata {
+    readonly name: string;
+    readonly path?: string;
+    readonly storage?: {
+        readonly path: string;
+        readonly disk?: string;
+    };
+    readonly content?: MailAttachmentContent;
+}
+interface MailAttachmentResolutionPlan extends MailAttachmentMetadata {
+    readonly queuedSafe: boolean;
+    resolve(): Promise<ResolvedMailAttachment>;
+}
+interface ResolvedMail {
+    readonly from: MailAddress;
+    readonly replyTo: MailAddress;
+    readonly to: readonly MailAddress[];
+    readonly cc: readonly MailAddress[];
+    readonly bcc: readonly MailAddress[];
+    readonly subject: string;
+    readonly html?: string;
+    readonly text?: string;
+    readonly attachments: readonly ResolvedMailAttachment[];
+    readonly headers: Readonly<Record<string, string>>;
+    readonly tags: readonly string[];
+    readonly metadata?: MailJsonObject;
+    readonly priority?: MailPriority;
+}
+interface MailPreviewResult extends Omit<ResolvedMail, 'attachments'> {
+    readonly attachments: readonly MailAttachmentMetadata[];
+    readonly source: Readonly<{
+        readonly kind: MailContentSourceKind;
+        readonly markdown?: string;
+        readonly rawHtml?: string;
+        readonly render?: Readonly<MailRenderSource>;
+    }>;
+}
+interface MailSendResult {
+    readonly messageId: string;
+    readonly mailer: string;
+    readonly driver: string;
+    readonly queued: boolean;
+    readonly deferred?: boolean;
+    readonly providerMessageId?: string;
+    readonly provider?: Readonly<Record<string, unknown>>;
+}
+interface MailDriverExecutionContext {
+    readonly messageId: string;
+    readonly mailer: string;
+    readonly driver: string;
+    readonly queued: boolean;
+    readonly deferred?: boolean;
+}
+interface MailDriver<TResult extends MailSendResult = MailSendResult> {
+    send(mail: Readonly<ResolvedMail>, context: Readonly<MailDriverExecutionContext>): TResult | Promise<TResult>;
+}
+interface BuiltInMailDriverRegistry {
+    readonly preview: MailDriver;
+    readonly log: MailDriver;
+    readonly fake: MailDriver;
+    readonly smtp: MailDriver;
+}
+interface HoloMailDriverRegistry {
+}
+type MailDriverRegistry = BuiltInMailDriverRegistry & HoloMailDriverRegistry;
+type MailDriverName = Extract<keyof MailDriverRegistry, string>;
+interface MailSendOptions {
+    readonly mailer?: string;
+    readonly connection?: string;
+    readonly queue?: string;
+    readonly delay?: MailDelayValue;
+    readonly afterCommit?: boolean;
+}
+interface MailSendInput {
+    readonly mail: MailDefinition;
+    readonly attachments: readonly ResolvedMailAttachment[];
+    readonly options: Readonly<MailSendOptions>;
+}
+interface MailPreviewInput {
+    readonly mail: MailDefinition;
+}
+interface MailRenderPreviewInput extends MailPreviewInput {
+    readonly format: MailPreviewFormat;
+}
+interface MailPreviewPolicy {
+    readonly environment: HoloAppEnv;
+    readonly allowedEnvironments: readonly HoloAppEnv[];
+}
+interface MailViewRenderer {
+    (input: MailViewRenderInput): string | Promise<string>;
+}
+interface MailRuntimeBindings {
+    readonly config?: NormalizedHoloMailConfig;
+    readonly renderView?: MailViewRenderer;
+    send?(input: MailSendInput): MailSendResult | Promise<MailSendResult>;
+    preview?(input: MailPreviewInput): MailPreviewResult | Promise<MailPreviewResult>;
+    renderPreview?(input: MailRenderPreviewInput): Response | Promise<Response>;
+}
+interface RegisterMailDriverOptions {
+    readonly replaceExisting?: boolean;
+}
+interface RegisteredMailDriver<TDriver extends string = string> {
+    readonly name: TDriver;
+    readonly driver: MailDriver;
+}
+interface PendingMailSend<TResult = MailSendResult> extends PromiseLike<TResult> {
+    using(name: string): PendingMailSend<TResult>;
+    onConnection(name: string): PendingMailSend<TResult>;
+    onQueue(name: string): PendingMailSend<TResult>;
+    delay(value: MailDelayValue): PendingMailSend<TResult>;
+    afterCommit(): PendingMailSend<TResult>;
+    then<TResult1 = TResult, TResult2 = never>(onfulfilled?: ((value: TResult) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult1 = never>(onrejected?: ((reason: unknown) => TResult1 | PromiseLike<TResult1>) | null): Promise<TResult | TResult1>;
+    finally(onfinally?: (() => void) | null): Promise<TResult>;
+}
+declare function isObject(value: unknown): value is Record<string, unknown>;
+declare function normalizeOptionalString(value: string | undefined, label: string): string | undefined;
+declare function normalizeRequiredString(value: string, label: string): string;
+declare function normalizeDelayValue(value: MailDelayValue, label: string): MailDelayValue;
+declare function normalizeJsonValue(value: unknown, label: string): MailJsonValue;
+declare function normalizeHeaders(headers: Readonly<Record<string, string>> | undefined): Readonly<Record<string, string>>;
+declare function normalizeTags(tags: readonly string[] | undefined): readonly string[];
+declare function normalizeViewIdentifier(value: string, label: string): string;
+declare function isValidEmail(value: string): boolean;
+declare function normalizeAddress(input: MailAddressInput, label: string): MailAddress;
+declare function normalizeRecipients(value: MailRecipientsInput | undefined, label: string, required: boolean): readonly MailAddress[];
+declare function normalizePriority(value: MailPriority | undefined): MailPriority | undefined;
+declare function inferAttachmentName(value: MailAttachmentInput): string | undefined;
+declare function inferMimeTypeFromName(name: string | undefined): string | undefined;
+declare function inferAttachmentSource(value: MailAttachmentInput): MailAttachmentMetadata['source'];
+declare function createAttachmentMetadata(attachment: MailAttachmentInput): MailAttachmentMetadata;
+declare function normalizeAttachment(input: MailAttachmentInput, index: number): MailAttachmentInput;
+declare function normalizeAttachments(attachments: readonly MailAttachmentInput[] | undefined): readonly MailAttachmentInput[];
+declare function resolveNormalizedAttachment(attachment: MailAttachmentInput): ResolvedMailAttachment;
+declare function isAttachmentQueueSafe(attachment: MailAttachmentInput): boolean;
+declare function resolveAttachmentDefinition(attachment: MailAttachmentInput): Promise<MailAttachmentInput>;
+declare function createAttachmentResolutionPlan(attachment: MailAttachmentInput, context: MailAttachmentResolutionContext): MailAttachmentResolutionPlan;
+declare function createAttachmentResolutionPlans(attachments: readonly MailAttachmentInput[], context: MailAttachmentResolutionContext): readonly MailAttachmentResolutionPlan[];
+declare function normalizeRenderSource(render: MailRenderSource | undefined): Readonly<MailRenderSource> | undefined;
+declare function normalizeQueueOptions(value: boolean | MailQueueOptions | undefined): boolean | Readonly<MailQueueOptions> | undefined;
+declare function isMailDefinition(value: unknown): value is MailDefinition;
+declare function mergeMailDefinitionInputs(base: MailDefinition | MailDefinitionInput, overrides: MailOverrideInput | undefined): MailDefinitionInput;
+declare function normalizeMailDefinition(input: MailDefinition | MailDefinitionInput): MailDefinition;
+declare function defineMail<TMail extends MailDefinitionInput>(input: TMail): MailDefinition;
+declare function attachFromPath(path: string, options?: MailAttachmentHelperOptions): MailPathAttachment;
+declare function attachFromStorage(path: string, options?: MailStorageAttachmentHelperOptions): MailStorageAttachment;
+declare function attachContent(content: MailAttachmentContent, options: MailContentAttachmentHelperOptions): MailContentAttachment;
+declare const mailInternals: {
+    BUILT_IN_MAIL_DRIVERS: readonly ["preview", "log", "fake", "smtp"];
+    HOLO_MAIL_DEFINITION_MARKER: symbol;
+    MAIL_ATTACHMENT_DISPOSITIONS: readonly ["attachment", "inline"];
+    MAIL_PRIORITY_VALUES: readonly ["high", "normal", "low"];
+    attachContent: typeof attachContent;
+    attachFromPath: typeof attachFromPath;
+    attachFromStorage: typeof attachFromStorage;
+    createAttachmentMetadata: typeof createAttachmentMetadata;
+    createAttachmentResolutionPlan: typeof createAttachmentResolutionPlan;
+    createAttachmentResolutionPlans: typeof createAttachmentResolutionPlans;
+    inferMimeTypeFromName: typeof inferMimeTypeFromName;
+    inferAttachmentName: typeof inferAttachmentName;
+    inferAttachmentSource: typeof inferAttachmentSource;
+    isObject: typeof isObject;
+    isAttachmentQueueSafe: typeof isAttachmentQueueSafe;
+    isValidEmail: typeof isValidEmail;
+    mergeMailDefinitionInputs: typeof mergeMailDefinitionInputs;
+    normalizeAddress: typeof normalizeAddress;
+    normalizeAttachment: typeof normalizeAttachment;
+    normalizeAttachments: typeof normalizeAttachments;
+    normalizeDelayValue: typeof normalizeDelayValue;
+    normalizeHeaders: typeof normalizeHeaders;
+    normalizeJsonValue: typeof normalizeJsonValue;
+    normalizeMailDefinition: typeof normalizeMailDefinition;
+    normalizeOptionalString: typeof normalizeOptionalString;
+    normalizePriority: typeof normalizePriority;
+    normalizeQueueOptions: typeof normalizeQueueOptions;
+    normalizeRecipients: typeof normalizeRecipients;
+    normalizeRenderSource: typeof normalizeRenderSource;
+    normalizeRequiredString: typeof normalizeRequiredString;
+    resolveAttachmentDefinition: typeof resolveAttachmentDefinition;
+    resolveNormalizedAttachment: typeof resolveNormalizedAttachment;
+    normalizeTags: typeof normalizeTags;
+    normalizeViewIdentifier: typeof normalizeViewIdentifier;
+};
+
+export { type BuiltInMailDriverRegistry, type HoloMailDriverRegistry, type MailAddress, type MailAddressInput, type MailAttachmentBase, type MailAttachmentContent, type MailAttachmentDisposition, type MailAttachmentHelperOptions, type MailAttachmentInput, type MailAttachmentMetadata, type MailAttachmentResolutionContext, type MailAttachmentResolutionPlan, type MailContentAttachment, type MailContentAttachmentHelperOptions, type MailContentSourceKind, type MailDefinition, type MailDefinitionInput, type MailDelayValue, type MailDriver, type MailDriverExecutionContext, type MailDriverName, type MailDriverRegistry, type MailJsonObject, type MailJsonValue, type MailOverrideInput, type MailPathAttachment, type MailPreviewFormat, type MailPreviewInput, type MailPreviewPolicy, type MailPreviewResult, type MailPriority, type MailQueueOptions, type MailRecipientsInput, type MailRenderPreviewInput, type MailRenderSource, type MailResolvableAttachment, type MailResolvedAttachmentPayload, type MailRuntimeBindings, type MailSendInput, type MailSendOptions, type MailSendResult, type MailStorageAttachment, type MailStorageAttachmentHelperOptions, type MailViewRenderInput, type MailViewRenderer, type PendingMailSend, type RegisterMailDriverOptions, type RegisteredMailDriver, type ResolvedMail, type ResolvedMailAttachment, attachContent, attachFromPath, attachFromStorage, createAttachmentMetadata, createAttachmentResolutionPlan, createAttachmentResolutionPlans, defineMail, inferMimeTypeFromName, isAttachmentQueueSafe, isMailDefinition, mailInternals, mergeMailDefinitionInputs, normalizeMailDefinition, resolveAttachmentDefinition, resolveNormalizedAttachment };

package/dist/contracts.mjs

@@ -0,0 +1,36 @@
+import {
+  attachContent,
+  attachFromPath,
+  attachFromStorage,
+  createAttachmentMetadata,
+  createAttachmentResolutionPlan,
+  createAttachmentResolutionPlans,
+  defineMail,
+  defineMailConfig,
+  inferMimeTypeFromName,
+  isAttachmentQueueSafe,
+  isMailDefinition,
+  mailInternals,
+  mergeMailDefinitionInputs,
+  normalizeMailDefinition,
+  resolveAttachmentDefinition,
+  resolveNormalizedAttachment
+} from "./chunk-UB6ANQ2F.mjs";
+export {
+  attachContent,
+  attachFromPath,
+  attachFromStorage,
+  createAttachmentMetadata,
+  createAttachmentResolutionPlan,
+  createAttachmentResolutionPlans,
+  defineMail,
+  defineMailConfig,
+  inferMimeTypeFromName,
+  isAttachmentQueueSafe,
+  isMailDefinition,
+  mailInternals,
+  mergeMailDefinitionInputs,
+  normalizeMailDefinition,
+  resolveAttachmentDefinition,
+  resolveNormalizedAttachment
+};