mymx 0.3.8 → 0.3.9

package/dist/contract.d.ts

@@ -1,4 +1,4 @@
-import { EmailAddress, EmailAuth, EmailReceivedEvent, ParsedDataComplete, ParsedDataFailed, ParsedError, RawContentDownloadOnly, RawContentInline, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment } from "./types-B5aR2RnG.js";
+import { EmailAddress, EmailAuth, EmailReceivedEvent, ParsedDataComplete, ParsedDataFailed, ParsedError, RawContentDownloadOnly, RawContentInline, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment } from "./types-CNRE7-kR.js";
 import { SignResult, signWebhookPayload$1 as signWebhookPayload } from "./signing-Ecohrukk.js";
 
 //#region src/contract.d.ts

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AuthConfidence, AuthVerdict, DkimSignature, DkimSignatureResult, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment, WebhookEvent } from "./types-B5aR2RnG.js";
+import { AuthConfidence, AuthVerdict, DkimResult, DkimSignature, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, EventType, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION$1 as WEBHOOK_VERSION, WebhookAttachment, WebhookEvent } from "./types-CNRE7-kR.js";
 import { MYMX_CONFIRMED_HEADER$1 as MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER$1 as MYMX_SIGNATURE_HEADER, VerifyOptions, verifyWebhookSignature$1 as verifyWebhookSignature } from "./signing-Ecohrukk.js";
 import { MyMXWebhookError$1 as MyMXWebhookError, PAYLOAD_ERRORS$1 as PAYLOAD_ERRORS, RAW_EMAIL_ERRORS$1 as RAW_EMAIL_ERRORS, RawEmailDecodeError$1 as RawEmailDecodeError, RawEmailDecodeErrorCode, VERIFICATION_ERRORS$1 as VERIFICATION_ERRORS, WebhookErrorCode, WebhookPayloadError$1 as WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError$1 as WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError$1 as WebhookVerificationError, WebhookVerificationErrorCode } from "./errors-CSPHzZB_.js";
 
@@ -561,7 +561,7 @@ declare const emailReceivedEventJsonSchema: {
           readonly description: "The DKIM selector used to locate the public key (s= tag). Combined with the domain to form the DNS lookup: `selector._domainkey.domain`";
         };
         readonly result: {
-          readonly $ref: "#/definitions/DkimSignatureResult";
+          readonly $ref: "#/definitions/DkimResult";
           readonly description: "Verification result for this specific signature.";
         };
         readonly aligned: {
@@ -581,7 +581,7 @@ declare const emailReceivedEventJsonSchema: {
       readonly additionalProperties: false;
       readonly description: "Details about a single DKIM signature found in the email.\n\nAn email may have multiple DKIM signatures (e.g., one from the sending domain and one from the ESP). Each signature is verified independently.";
     };
-    readonly DkimSignatureResult: {
+    readonly DkimResult: {
       readonly type: "string";
       readonly enum: ["pass", "fail", "temperror", "permerror"];
       readonly description: "DKIM signature verification result for a single signature.";
@@ -927,4 +927,4 @@ declare function decodeRawEmail(event: EmailReceivedEvent, options?: DecodeRawEm
 declare function verifyRawEmailDownload(downloaded: Buffer | ArrayBuffer | Uint8Array, event: EmailReceivedEvent): Buffer;
 
 //#endregion
-export { AuthConfidence, AuthVerdict, DecodeRawEmailOptions, DkimSignature, DkimSignatureResult, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, HandleWebhookOptions, KnownWebhookEvent, MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RAW_EMAIL_ERRORS, RawContent, RawContentDownloadOnly, RawContentInline, RawEmailDecodeError, RawEmailDecodeErrorCode, SpfResult, UnknownEvent, VERIFICATION_ERRORS, ValidateEmailAuthResult, VerifyOptions, WEBHOOK_VERSION, WebhookAttachment, WebhookErrorCode, WebhookEvent, WebhookHeaders, WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError, WebhookVerificationErrorCode, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };
+export { AuthConfidence, AuthVerdict, DecodeRawEmailOptions, DkimResult, DkimSignature, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, EventType, HandleWebhookOptions, KnownWebhookEvent, MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RAW_EMAIL_ERRORS, RawContent, RawContentDownloadOnly, RawContentInline, RawEmailDecodeError, RawEmailDecodeErrorCode, SpfResult, UnknownEvent, VERIFICATION_ERRORS, ValidateEmailAuthResult, VerifyOptions, WEBHOOK_VERSION, WebhookAttachment, WebhookErrorCode, WebhookEvent, WebhookHeaders, WebhookPayloadError, WebhookPayloadErrorCode, WebhookValidationError, WebhookValidationErrorCode, WebhookVerificationError, WebhookVerificationErrorCode, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };

package/dist/index.js

@@ -615,7 +615,7 @@ const emailReceivedEventJsonSchema = {
 					"description": "The DKIM selector used to locate the public key (s= tag). Combined with the domain to form the DNS lookup: `selector._domainkey.domain`"
 				},
 				"result": {
-					"$ref": "#/definitions/DkimSignatureResult",
+					"$ref": "#/definitions/DkimResult",
 					"description": "Verification result for this specific signature."
 				},
 				"aligned": {
@@ -642,7 +642,7 @@ const emailReceivedEventJsonSchema = {
 			"additionalProperties": false,
 			"description": "Details about a single DKIM signature found in the email.\n\nAn email may have multiple DKIM signatures (e.g., one from the sending domain and one from the ESP). Each signature is verified independently."
 		},
-		"DkimSignatureResult": {
+		"DkimResult": {
 			"type": "string",
 			"enum": [
 				"pass",
@@ -655,6 +655,51 @@ const emailReceivedEventJsonSchema = {
 	}
 };
 
+//#endregion
+//#region src/types.ts
+const EventType = { EmailReceived: "email.received" };
+const SpfResult = {
+	Pass: "pass",
+	Fail: "fail",
+	Softfail: "softfail",
+	Neutral: "neutral",
+	None: "none",
+	Temperror: "temperror",
+	Permerror: "permerror"
+};
+const DmarcResult = {
+	Pass: "pass",
+	Fail: "fail",
+	None: "none",
+	Temperror: "temperror",
+	Permerror: "permerror"
+};
+const DmarcPolicy = {
+	Reject: "reject",
+	Quarantine: "quarantine",
+	None: "none"
+};
+const DkimResult = {
+	Pass: "pass",
+	Fail: "fail",
+	Temperror: "temperror",
+	Permerror: "permerror"
+};
+const AuthVerdict = {
+	Legit: "legit",
+	Suspicious: "suspicious",
+	Unknown: "unknown"
+};
+const AuthConfidence = {
+	High: "high",
+	Medium: "medium",
+	Low: "low"
+};
+const ParsedStatus = {
+	Complete: "complete",
+	Failed: "failed"
+};
+
 //#endregion
 //#region src/auth.ts
 /**
@@ -1184,4 +1229,4 @@ function verifyRawEmailDownload(downloaded, event) {
 }
 
 //#endregion
-export { MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, RAW_EMAIL_ERRORS, RawEmailDecodeError, VERIFICATION_ERRORS, WEBHOOK_VERSION, WebhookPayloadError, WebhookValidationError, WebhookVerificationError, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };
+export { AuthConfidence, AuthVerdict, DkimResult, DmarcPolicy, DmarcResult, EventType, MYMX_CONFIRMED_HEADER, MYMX_SIGNATURE_HEADER, MyMXWebhookError, PAYLOAD_ERRORS, ParsedStatus, RAW_EMAIL_ERRORS, RawEmailDecodeError, SpfResult, VERIFICATION_ERRORS, WEBHOOK_VERSION, WebhookPayloadError, WebhookValidationError, WebhookVerificationError, confirmedHeaders, decodeRawEmail, emailReceivedEventJsonSchema, getDownloadTimeRemaining, handleWebhook, isDownloadExpired, isEmailReceivedEvent, isRawIncluded, parseWebhookEvent, validateEmailAuth, verifyRawEmailDownload, verifyWebhookSignature };

package/dist/{types-B5aR2RnG.d.ts → types-CNRE7-kR.d.ts}

@@ -289,6 +289,13 @@ interface RawContentDownloadOnly {
  * ```
  */
 type RawContent = RawContentInline | RawContentDownloadOnly;
+declare const EventType: {
+  readonly EmailReceived: "email.received";
+};
+/**
+ * Webhook event type.
+ */
+type EventType = (typeof EventType)[keyof typeof EventType];
 /**
  * Webhook payload for the `email.received` event.
  *
@@ -472,18 +479,39 @@ interface EmailReceivedEvent {
     auth: EmailAuth;
   };
 }
+declare const SpfResult: {
+  readonly Pass: "pass";
+  readonly Fail: "fail";
+  readonly Softfail: "softfail";
+  readonly Neutral: "neutral";
+  readonly None: "none";
+  readonly Temperror: "temperror";
+  readonly Permerror: "permerror";
+};
 /**
  * SPF verification result.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc7208
  */
-type SpfResult = "pass" | "fail" | "softfail" | "neutral" | "none" | "temperror" | "permerror";
+type SpfResult = (typeof SpfResult)[keyof typeof SpfResult];
+declare const DmarcResult: {
+  readonly Pass: "pass";
+  readonly Fail: "fail";
+  readonly None: "none";
+  readonly Temperror: "temperror";
+  readonly Permerror: "permerror";
+};
 /**
  * DMARC verification result.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc7489
  */
-type DmarcResult = "pass" | "fail" | "none" | "temperror" | "permerror";
+type DmarcResult = (typeof DmarcResult)[keyof typeof DmarcResult];
+declare const DmarcPolicy: {
+  readonly Reject: "reject";
+  readonly Quarantine: "quarantine";
+  readonly None: "none";
+};
 /**
  * DMARC policy action specified in the domain's DMARC record.
  *
@@ -492,11 +520,21 @@ type DmarcResult = "pass" | "fail" | "none" | "temperror" | "permerror";
  * - `none`: The domain owner is only monitoring (no action requested)
  * - `null`: No DMARC policy was found for the domain
  */
-type DmarcPolicy = "reject" | "quarantine" | "none" | null;
+type DmarcPolicy = (typeof DmarcPolicy)[keyof typeof DmarcPolicy] | null;
+declare const DkimResult: {
+  readonly Pass: "pass";
+  readonly Fail: "fail";
+  readonly Temperror: "temperror";
+  readonly Permerror: "permerror";
+};
 /**
  * DKIM signature verification result for a single signature.
  */
-type DkimSignatureResult = "pass" | "fail" | "temperror" | "permerror";
+type DkimResult = (typeof DkimResult)[keyof typeof DkimResult];
+/**
+ * @deprecated Use `DkimResult` instead. This alias is for backwards compatibility.
+ */
+
 /**
  * Details about a single DKIM signature found in the email.
  *
@@ -517,7 +555,7 @@ interface DkimSignature {
   /**
    * Verification result for this specific signature.
    */
-  result: DkimSignatureResult;
+  result: DkimResult;
   /**
    * Whether this signature's domain aligns with the From: domain (for DMARC).
    *
@@ -621,6 +659,11 @@ interface EmailAuth {
    */
   dkimSignatures: DkimSignature[];
 }
+declare const AuthVerdict: {
+  readonly Legit: "legit";
+  readonly Suspicious: "suspicious";
+  readonly Unknown: "unknown";
+};
 /**
  * Overall verdict from email authentication validation.
  *
@@ -628,7 +671,12 @@ interface EmailAuth {
  * - `suspicious`: Evidence suggests the email may be spoofed
  * - `unknown`: Not enough information to determine authenticity
  */
-type AuthVerdict = "legit" | "suspicious" | "unknown";
+type AuthVerdict = (typeof AuthVerdict)[keyof typeof AuthVerdict];
+declare const AuthConfidence: {
+  readonly High: "high";
+  readonly Medium: "medium";
+  readonly Low: "low";
+};
 /**
  * Confidence level for the authentication verdict.
  *
@@ -636,7 +684,7 @@ type AuthVerdict = "legit" | "suspicious" | "unknown";
  * - `medium`: Good evidence but with caveats (SPF-only alignment)
  * - `low`: Weak evidence (missing authentication or unclear results)
  */
-type AuthConfidence = "high" | "medium" | "low";
+type AuthConfidence = (typeof AuthConfidence)[keyof typeof AuthConfidence];
 /**
  * Result of validating email authentication.
  *
@@ -720,8 +768,12 @@ type KnownWebhookEvent = EmailReceivedEvent;
  * for known events and forward-compatibility for unknown events.
  */
 type WebhookEvent = KnownWebhookEvent | UnknownEvent;
+declare const ParsedStatus: {
+  readonly Complete: "complete";
+  readonly Failed: "failed";
+};
 /**
  * Possible values for the `status` field in {@link ParsedData}.
  */
-type ParsedStatus = "complete" | "failed"; //#endregion
-export { AuthConfidence, AuthVerdict, DkimSignature, DkimSignatureResult, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION as WEBHOOK_VERSION$1, WebhookAttachment, WebhookEvent };
+type ParsedStatus = (typeof ParsedStatus)[keyof typeof ParsedStatus]; //#endregion
+export { AuthConfidence, AuthVerdict, DkimResult, DkimSignature, DmarcPolicy, DmarcResult, EmailAddress, EmailAuth, EmailReceivedEvent, EventType, KnownWebhookEvent, ParsedData, ParsedDataComplete, ParsedDataFailed, ParsedError, ParsedStatus, RawContent, RawContentDownloadOnly, RawContentInline, SpfResult, UnknownEvent, ValidateEmailAuthResult, WEBHOOK_VERSION as WEBHOOK_VERSION$1, WebhookAttachment, WebhookEvent };

package/dist/zod.d.ts

@@ -1,4 +1,4 @@
-import { EmailReceivedEvent } from "./types-B5aR2RnG.js";
+import { EmailReceivedEvent } from "./types-CNRE7-kR.js";
 import { WebhookValidationError$1 as WebhookValidationError, WebhookValidationErrorCode } from "./errors-CSPHzZB_.js";
 import { z } from "zod";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mymx",
-  "version": "0.3.8",
+  "version": "0.3.9",
   "description": "Official MyMX Node.js SDK for webhook signature verification",
   "type": "module",
   "module": "./dist/index.js",