@upyo/core 0.2.0-dev.24 → 0.2.0

package/dist/address.cjs

@@ -128,7 +128,28 @@ function isValidDomainPart(domainPart) {
 		return false;
 	}
 }
+/**
+* Type guard function that checks if a given value is a valid email address.
+*
+* @example
+* ```ts
+* import { isEmailAddress } from "@upyo/core/address";
+*
+* const userInput = "user@example.com";
+* if (isEmailAddress(userInput)) {
+*   // TypeScript now knows userInput is EmailAddress type
+*   console.log(userInput); // Type: `${string}@${string}`
+* }
+* ```
+*
+* @param email The value to check
+* @returns `true` if the value is a valid email address, `false` otherwise
+*/
+function isEmailAddress(email) {
+	return typeof email === "string" && isValidEmail(email);
+}
 
 //#endregion
 exports.formatAddress = formatAddress;
+exports.isEmailAddress = isEmailAddress;
 exports.parseAddress = parseAddress;

package/dist/address.d.cts

@@ -1,4 +1,9 @@
 //#region src/address.d.ts
+/**
+ * A type alias for email address strings that must contain an @ symbol.
+ * @since 0.2.0
+ */
+type EmailAddress = `${string}@${string}`;
 /**
  * A pair of name (which is optional) and email address.
  */
@@ -10,7 +15,7 @@ interface Address {
   /**
    * The email address itself.
    */
-  readonly address: string;
+  readonly address: EmailAddress;
 }
 /**
  * Formats an address object into a string representation.  This function is
@@ -64,5 +69,23 @@ declare function formatAddress(address: Address): string;
  *          or `undefined` if the input is invalid.
  */
 declare function parseAddress(address: string): Address | undefined;
+/**
+ * Type guard function that checks if a given value is a valid email address.
+ *
+ * @example
+ * ```ts
+ * import { isEmailAddress } from "@upyo/core/address";
+ *
+ * const userInput = "user@example.com";
+ * if (isEmailAddress(userInput)) {
+ *   // TypeScript now knows userInput is EmailAddress type
+ *   console.log(userInput); // Type: `${string}@${string}`
+ * }
+ * ```
+ *
+ * @param email The value to check
+ * @returns `true` if the value is a valid email address, `false` otherwise
+ */
+declare function isEmailAddress(email: unknown): email is EmailAddress;
 //#endregion
-export { Address, formatAddress, parseAddress };
+export { Address, EmailAddress, formatAddress, isEmailAddress, parseAddress };

package/dist/address.d.ts

@@ -1,4 +1,9 @@
 //#region src/address.d.ts
+/**
+ * A type alias for email address strings that must contain an @ symbol.
+ * @since 0.2.0
+ */
+type EmailAddress = `${string}@${string}`;
 /**
  * A pair of name (which is optional) and email address.
  */
@@ -10,7 +15,7 @@ interface Address {
   /**
    * The email address itself.
    */
-  readonly address: string;
+  readonly address: EmailAddress;
 }
 /**
  * Formats an address object into a string representation.  This function is
@@ -64,5 +69,23 @@ declare function formatAddress(address: Address): string;
  *          or `undefined` if the input is invalid.
  */
 declare function parseAddress(address: string): Address | undefined;
+/**
+ * Type guard function that checks if a given value is a valid email address.
+ *
+ * @example
+ * ```ts
+ * import { isEmailAddress } from "@upyo/core/address";
+ *
+ * const userInput = "user@example.com";
+ * if (isEmailAddress(userInput)) {
+ *   // TypeScript now knows userInput is EmailAddress type
+ *   console.log(userInput); // Type: `${string}@${string}`
+ * }
+ * ```
+ *
+ * @param email The value to check
+ * @returns `true` if the value is a valid email address, `false` otherwise
+ */
+declare function isEmailAddress(email: unknown): email is EmailAddress;
 //#endregion
-export { Address, formatAddress, parseAddress };
+export { Address, EmailAddress, formatAddress, isEmailAddress, parseAddress };

package/dist/address.js

@@ -127,6 +127,26 @@ function isValidDomainPart(domainPart) {
 		return false;
 	}
 }
+/**
+* Type guard function that checks if a given value is a valid email address.
+*
+* @example
+* ```ts
+* import { isEmailAddress } from "@upyo/core/address";
+*
+* const userInput = "user@example.com";
+* if (isEmailAddress(userInput)) {
+*   // TypeScript now knows userInput is EmailAddress type
+*   console.log(userInput); // Type: `${string}@${string}`
+* }
+* ```
+*
+* @param email The value to check
+* @returns `true` if the value is a valid email address, `false` otherwise
+*/
+function isEmailAddress(email) {
+	return typeof email === "string" && isValidEmail(email);
+}
 
 //#endregion
-export { formatAddress, parseAddress };
+export { formatAddress, isEmailAddress, parseAddress };

package/dist/index.cjs

@@ -7,4 +7,5 @@ exports.comparePriority = require_priority.comparePriority;
 exports.createMessage = require_message.createMessage;
 exports.formatAddress = require_address.formatAddress;
 exports.isAttachment = require_attachment.isAttachment;
+exports.isEmailAddress = require_address.isEmailAddress;
 exports.parseAddress = require_address.parseAddress;

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-import { Address, formatAddress, parseAddress } from "./address.cjs";
+import { Address, EmailAddress, formatAddress, isEmailAddress, parseAddress } from "./address.cjs";
 import { Attachment, isAttachment } from "./attachment.cjs";
 import { Priority, comparePriority } from "./priority.cjs";
 import { ImmutableHeaders, Message, MessageConstructor, MessageContent, createMessage } from "./message.cjs";
 import { Receipt } from "./receipt.cjs";
 import { Transport, TransportOptions } from "./transport.cjs";
-export { Address, Attachment, ImmutableHeaders, Message, MessageConstructor, MessageContent, Priority, Receipt, Transport, TransportOptions, comparePriority, createMessage, formatAddress, isAttachment, parseAddress };
+export { Address, Attachment, EmailAddress, ImmutableHeaders, Message, MessageConstructor, MessageContent, Priority, Receipt, Transport, TransportOptions, comparePriority, createMessage, formatAddress, isAttachment, isEmailAddress, parseAddress };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Address, formatAddress, parseAddress } from "./address.js";
+import { Address, EmailAddress, formatAddress, isEmailAddress, parseAddress } from "./address.js";
 import { Attachment, isAttachment } from "./attachment.js";
 import { Priority, comparePriority } from "./priority.js";
 import { ImmutableHeaders, Message, MessageConstructor, MessageContent, createMessage } from "./message.js";
 import { Receipt } from "./receipt.js";
 import { Transport, TransportOptions } from "./transport.js";
-export { Address, Attachment, ImmutableHeaders, Message, MessageConstructor, MessageContent, Priority, Receipt, Transport, TransportOptions, comparePriority, createMessage, formatAddress, isAttachment, parseAddress };
+export { Address, Attachment, EmailAddress, ImmutableHeaders, Message, MessageConstructor, MessageContent, Priority, Receipt, Transport, TransportOptions, comparePriority, createMessage, formatAddress, isAttachment, isEmailAddress, parseAddress };

package/dist/index.js

@@ -1,6 +1,6 @@
-import { formatAddress, parseAddress } from "./address.js";
+import { formatAddress, isEmailAddress, parseAddress } from "./address.js";
 import { isAttachment } from "./attachment.js";
 import { createMessage } from "./message.js";
 import { comparePriority } from "./priority.js";
 
-export { comparePriority, createMessage, formatAddress, isAttachment, parseAddress };
+export { comparePriority, createMessage, formatAddress, isAttachment, isEmailAddress, parseAddress };

package/dist/message.d.cts

@@ -20,19 +20,19 @@ interface Message {
   /**
    * The email addresses of the recipient of the message.
    */
-  readonly recipients: Address[];
+  readonly recipients: readonly Address[];
   /**
    * The email addresses of the carbon copy (CC) recipients of the message.
    */
-  readonly ccRecipients: Address[];
+  readonly ccRecipients: readonly Address[];
   /**
    * The email addresses of the blind carbon copy (BCC) recipients of the message.
    */
-  readonly bccRecipients: Address[];
+  readonly bccRecipients: readonly Address[];
   /**
    * The email addresses of the reply-to recipients of the message.
    */
-  readonly replyRecipients: Address[];
+  readonly replyRecipients: readonly Address[];
   /**
    * The attachments included in the email message.  These are files that
    * are sent along with the email, such as documents, images, or other
@@ -40,7 +40,7 @@ interface Message {
    * object, which contains information about the attachment such as its
    * filename, content type, and content ID.
    */
-  readonly attachments: Attachment[];
+  readonly attachments: readonly Attachment[];
   /**
    * The subject of the email message.  This is typically a brief summary
    * of the content of the email, and is used to help the recipient identify
@@ -67,7 +67,7 @@ interface Message {
   /**
    * The tags associated with the email message.
    */
-  readonly tags: string[];
+  readonly tags: readonly string[];
   /**
    * The headers of the email message.  This is represented by
    * the {@link ImmutableHeaders} type, which is a supertype of

package/dist/message.d.ts

@@ -20,19 +20,19 @@ interface Message {
   /**
    * The email addresses of the recipient of the message.
    */
-  readonly recipients: Address[];
+  readonly recipients: readonly Address[];
   /**
    * The email addresses of the carbon copy (CC) recipients of the message.
    */
-  readonly ccRecipients: Address[];
+  readonly ccRecipients: readonly Address[];
   /**
    * The email addresses of the blind carbon copy (BCC) recipients of the message.
    */
-  readonly bccRecipients: Address[];
+  readonly bccRecipients: readonly Address[];
   /**
    * The email addresses of the reply-to recipients of the message.
    */
-  readonly replyRecipients: Address[];
+  readonly replyRecipients: readonly Address[];
   /**
    * The attachments included in the email message.  These are files that
    * are sent along with the email, such as documents, images, or other
@@ -40,7 +40,7 @@ interface Message {
    * object, which contains information about the attachment such as its
    * filename, content type, and content ID.
    */
-  readonly attachments: Attachment[];
+  readonly attachments: readonly Attachment[];
   /**
    * The subject of the email message.  This is typically a brief summary
    * of the content of the email, and is used to help the recipient identify
@@ -67,7 +67,7 @@ interface Message {
   /**
    * The tags associated with the email message.
    */
-  readonly tags: string[];
+  readonly tags: readonly string[];
   /**
    * The headers of the email message.  This is represented by
    * the {@link ImmutableHeaders} type, which is a supertype of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upyo/core",
-  "version": "0.2.0-dev.24+97755606",
+  "version": "0.2.0",
   "description": "Simple email sending library for Node.js, Deno, Bun, and edge functions",
   "keywords": [
     "email",