@bumail/queue 0.1.0

package/dist/dsn/build.d.ts

@@ -0,0 +1,35 @@
+import { type DsnKind, type DsnRecipient } from './fields';
+export type { DsnKind, DsnRecipient } from './fields';
+/** What a DSN says, about which message, to whom. */
+export interface DsnInput {
+    readonly kind: DsnKind;
+    /** This server's public name: the Reporting-MTA, and the Message-ID's domain. */
+    readonly reportingMta: string;
+    /** The DSN's From: the postmaster's address. */
+    readonly from: string;
+    /** The original's sender, to whom the DSN goes. */
+    readonly to: string;
+    /** When the original was enqueued. */
+    readonly arrival: Date;
+    /** When the DSN is written. */
+    readonly date: Date;
+    readonly recipients: readonly DsnRecipient[];
+    /** With `delayed`: when the queue gives up. */
+    readonly willRetryUntil?: Date;
+    /** The original message, as enqueued. */
+    readonly original: Uint8Array;
+    readonly returnContent: 'headers' | 'full';
+    /** The most bytes of the original returned. */
+    readonly maxReturn: number;
+}
+/**
+ * A delivery status notification (RFC 3464): a `multipart/report`
+ * (RFC 6522) of `report-type=delivery-status` holding the text a person
+ * reads, the `message/delivery-status` fields a program reads, and the
+ * original's header fields (or the whole original, when asked and small
+ * enough), bounded by `maxReturn`. Nothing from the remote server or the
+ * envelope reaches a header field raw: control characters, CR and LF are
+ * taken out first.
+ */
+export declare function buildDsn(input: DsnInput): Uint8Array;
+//# sourceMappingURL=build.d.ts.map

package/dist/dsn/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/dsn/build.ts"],"names":[],"mappings":"AAQA,OAAO,EACN,KAAK,OAAO,EACZ,KAAK,YAAY,EAGjB,MAAM,UAAU,CAAC;AAElB,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEtD,qDAAqD;AACrD,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,iFAAiF;IACjF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAC;IAC7C,+CAA+C;IAC/C,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,CAAC;IAC3C,+CAA+C;IAC/C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3B;AAkFD;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,CAwCpD"}

package/dist/dsn/content.d.ts

@@ -0,0 +1,18 @@
+/** The part of a DSN that returns the original message (RFC 3464 §2, RFC 6522 §3). */
+/** RFC 5322 §2.1.1: a line is at most 998 characters, its CRLF aside. */
+export declare const MAX_LINE = 998;
+export interface Returned {
+    /** `text/rfc822-headers` or `message/rfc822`. */
+    readonly type: string;
+    /** Lines ending in CRLF, the last one included. */
+    readonly body: Uint8Array;
+    /** It holds a byte past ASCII: the part says `8bit`. */
+    readonly eightBit: boolean;
+}
+/**
+ * The original as a DSN returns it: the whole message when asked and it
+ * fits `max` bytes, else its header fields, cut after the last whole line
+ * that fits. Never more than `max` bytes.
+ */
+export declare function returned(original: Uint8Array, mode: 'headers' | 'full', max: number): Returned;
+//# sourceMappingURL=content.d.ts.map

package/dist/dsn/content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../src/dsn/content.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAKtF,yEAAyE;AACzE,eAAO,MAAM,QAAQ,MAAM,CAAC;AA0D5B,MAAM,WAAW,QAAQ;IACxB,iDAAiD;IACjD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CACvB,QAAQ,EAAE,UAAU,EACpB,IAAI,EAAE,SAAS,GAAG,MAAM,EACxB,GAAG,EAAE,MAAM,GACT,QAAQ,CAYV"}

package/dist/dsn/fields.d.ts

@@ -0,0 +1,38 @@
+import type { Diagnostic } from '../contract/types';
+/** One recipient a DSN reports on. */
+export interface DsnRecipient {
+    readonly address: string;
+    readonly reply?: Diagnostic;
+    /** When it was last tried. */
+    readonly lastAttempt: Date;
+}
+export type DsnKind = 'delayed' | 'failed';
+/** What a delivery-status part reports: who reports, on what, and each recipient. */
+export interface StatusReport {
+    readonly kind: DsnKind;
+    /** This server's name. */
+    readonly reportingMta: string;
+    /** When the message was enqueued. */
+    readonly arrival: Date;
+    readonly recipients: readonly DsnRecipient[];
+    /** With `delayed`: when the queue gives up. */
+    readonly willRetryUntil?: Date;
+}
+/**
+ * An address as a delivery-status field types it: `rfc822; addr` when it
+ * is ASCII; otherwise `utf-8;` with each non-ASCII character as
+ * `\x{HEX}` (RFC 6533 §3, utf-8-addr-xtext), so the part stays 7-bit,
+ * cut at 900 characters so it always fits a header line.
+ */
+export declare function typedAddress(address: string): string;
+/**
+ * The status (RFC 3463) of a recipient: the reply's enhanced code; else
+ * its class from the reply code; else, with nothing at all, the kind's.
+ */
+export declare function statusOf(kind: DsnKind, reply?: Diagnostic): string;
+/**
+ * The body of a `message/delivery-status` part (RFC 3464 §2.1): the
+ * per-message fields, then each recipient's, a blank line between, CRLF.
+ */
+export declare function deliveryStatus(report: StatusReport): string;
+//# sourceMappingURL=fields.d.ts.map

package/dist/dsn/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/dsn/fields.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGpD,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B,8BAA8B;IAC9B,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;CAC3B;AAED,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE3C,qFAAqF;AACrF,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,0BAA0B;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,qCAAqC;IACrC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAC;IAC7C,+CAA+C;IAC/C,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;CAC/B;AAQD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAapD;AAMD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,MAAM,CAMlE;AA8BD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAS3D"}

package/dist/errors.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Why the queue or a store refused a call. `INVALID`: an option or an
+ * argument it cannot take. `MESSAGE_TOO_BIG`, `TOO_MANY_RECIPIENTS` and
+ * `QUEUE_FULL`: a limit `enqueue` enforces. `CLOSED`: a store used after
+ * `close()`. `LEASE_LOST`: given to the `error` event when another worker
+ * took an item before its outcome was recorded.
+ */
+export type QueueErrorCode = 'INVALID' | 'MESSAGE_TOO_BIG' | 'TOO_MANY_RECIPIENTS' | 'QUEUE_FULL' | 'CLOSED' | 'LEASE_LOST';
+/** Thrown by the queue and by every store, whichever answers the contract, with the same codes. */
+export declare class QueueError extends Error {
+    readonly name = "QueueError";
+    readonly code: QueueErrorCode;
+    constructor(code: QueueErrorCode, message: string);
+}
+/** `INVALID`, for an option or an argument. */
+export declare const invalid: (message: string) => QueueError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GACvB,SAAS,GACT,iBAAiB,GACjB,qBAAqB,GACrB,YAAY,GACZ,QAAQ,GACR,YAAY,CAAC;AAEhB,mGAAmG;AACnG,qBAAa,UAAW,SAAQ,KAAK;IACpC,SAAkB,IAAI,gBAAgB;IACtC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;gBAElB,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM;CAIjD;AAED,+CAA+C;AAC/C,eAAO,MAAM,OAAO,GAAI,SAAS,MAAM,eAAuC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export type { QueueStore } from './contract/queue-store';
+export type { AddOptions, AttemptResult, ClaimRequest, Diagnostic, FinalStatus, Lease, NewQueueItem, QueueItem, QueueListOptions, RecipientState, RecipientStatus, RecipientUpdate, } from './contract/types';
+export { QueueError, type QueueErrorCode } from './errors';
+export type { MessageSource, QueueEnvelope } from './queue/envelope';
+export type { DeferredEvent, DsnEvent, QueueErrorEvent, QueueEvents, QueueListener, RecipientEvent, } from './queue/events';
+export type { Clock, DsnOptions, QueueLimits, QueueOptions, RetrySchedule, Route, Sender, Smarthost, } from './queue/options';
+export { createQueue, type Queue } from './queue/queue';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EACX,UAAU,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,WAAW,EACX,KAAK,EACL,YAAY,EACZ,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,eAAe,GACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,UAAU,CAAC;AAC3D,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACrE,YAAY,EACX,aAAa,EACb,QAAQ,EACR,eAAe,EACf,WAAW,EACX,aAAa,EACb,cAAc,GACd,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACX,KAAK,EACL,UAAU,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACb,KAAK,EACL,MAAM,EACN,SAAS,GACT,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,KAAK,KAAK,EAAE,MAAM,eAAe,CAAC"}