frontacles 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -8,11 +8,35 @@ Nothing for now.
 
 <!-- ⚠️ Before a new release, make sure the documentation doesn't contain any **unreleased** mention.  -->
 
-Compare with [last published version](https://github.com/frontacles/frontacles/compare/0.2.0...main).
+Compare with [last published version](https://github.com/frontacles/frontacles/compare/0.2.2...main).
 
-## v1.4.0 (2025-02-28)
+## v0.2.2 (2025-03-01)
 
-Compare with [previous version](https://github.com/frontacles/frontacles/compare/dda10c3...0.2).
+Compare with [last published version](https://github.com/frontacles/frontacles/compare/0.2.1...0.2.2).
+
+### Breaking
+
+- Make `Email.username` and `Email.hostname` mutable to follow `URL.username` and `URL.hostname` behavior.
+
+### Improved
+
+- Override documentation inherited from `URL` for `Email.username` and `Email.hostname`.
+
+## v0.2.1 (2025-02-28)
+
+Compare with [previous version](https://github.com/frontacles/frontacles/compare/0.2.0...0.2.1).
+
+### Breaking
+
+- Rename `Email.host` into `Email.hostname` to better match `URL`.
+
+### Improved
+
+- `Email` is now a couple of bytes lighter.
+
+## v0.2.0 (2025-02-28)
+
+Compare with [previous version](https://github.com/frontacles/frontacles/compare/dda10c3...0.2.0).
 
 ### New
 

package/README.md

@@ -7,7 +7,7 @@ Cool utilities for front-end development (and potentially for Node).
 
 ## Email
 
-A class to instantiate an `Email` object or validate emails.
+A class to instantiate an `Email` object or validate emails. It’s only [221 B compressed](https://bundlejs.com/?q=frontacles&treeshake=[{Email}]&config={%22compression%22%3A%22brotli%22}&bundle).
 
 Unlike most libraries using [RegEx for emails](https://github.com/colinhacks/zod/blob/e2b9a5f9ac67d13ada61cd8e4b1385eb850c7592/src/types.ts#L648-L663) (and prone to [bugs](https://github.com/colinhacks/zod/issues/3913)), Frontacles `Email` class relies on the same mechanism as your browser to validate email addresses, making it robust, and very likely RFC compliant.
 
@@ -17,18 +17,23 @@ import { Email } from 'frontacles/url/email'
 const email = new Email('someone@domain.tld')
 ```
 
-Get the username and the host separately.
+Get or set the username and the hostname separately.
 
 ```js
 email.username // 'someone'
-email.host // 'domain.tld'
+email.hostname // 'domain.tld'
+
+email.hostname = 'newdomain.tld' // ✅ domain migrated
+
+// destructuring also works
+const { username, hostname } = new Email('someone@domain.tld')
 ```
 
 Turn the email object into a string by using it along another string, or use `toString`.
 
 ```js
-console.log(`email: ${email}`) // 'email: someone@domain.tld'
-console.log(email.toString()) // 'someone@domain.tld'
+console.log(`email: ${email}`) // 'email: someone@newdomain.tld'
+console.log(email.toString()) // 'someone@newdomain.tld'
 ```
 
 Validate that a string is a valid email address. It passes the complete Zod test suites, and beyond.
@@ -53,3 +58,27 @@ const alsoEmail = new Email(email) // ✅ a new Email object!
 
 Email.canParse(email) // ✅ true
 ```
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/frontacles/frontacles/blob/main/CHANGELOG.md) or the [releases](https://github.com/frontacles/frontacles/releases).
+
+## Browser and tooling support
+
+`frontacles` is provided [as module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#browser_compatibility) for [modern browsers usage](https://github.com/frontacles/frontacles/blob/main/browserslist) with standard JavaScript syntax:
+- it is up to you to transpile it for legacy browsers;
+- you can’t import it using `require('frontacles')`.
+
+[Read more about ESModules](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+## Security
+
+See the [security policy](https://github.com/frontacles/frontacles/blob/main/SECURITY.md).
+
+## Contributing
+
+See the [contributing guidelines](https://github.com/frontacles/frontacles/blob/main/CONTRIBUTING.md).
+
+## License
+
+The _datetime-attribute_ package is open-sourced software licensed under the [DWTFYWTPL](https://github.com/frontacles/frontacles/blob/main/LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "frontacles",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Front-end utilities for artisans",
   "type": "module",
   "sideEffects": false,
@@ -16,6 +16,7 @@
   },
   "scripts": {
     "types": "tsc && dts-bundle-generator --silent --no-banner=true -o types/index.d.ts types-transitive/index.d.ts",
+    "posttypes": "node scripts/inject-jsdoc.mjs",
     "test": "vitest run",
     "test:types": "npm exec tsd",
     "test:ui": "vitest --ui --coverage.enabled --coverage.exclude=types",

package/src/url/email.js

@@ -2,7 +2,6 @@
 export class Email extends URL {
 
   /**
-   *
    * @param {string|Email} address An email address like `someone@domain.tld`.
    */
   constructor(address) {
@@ -13,26 +12,8 @@ export class Email extends URL {
     }
   }
 
-  /**
-   * The domain name and extension of the email.
-   *
-   * In `username@domain.tld`, it is `domain.tld`.
-   */
-  get host() {
-    return super.host
-  }
-
-  /**
-   * The username of the email.
-   *
-   * In `username@domain.tld`, it is `username`.
-   */
-  get username() {
-    return super.username
-  }
-
   toJSON () {
-    return `${this.username}@${this.host}`
+    return this.toString()
   }
 
   /**
@@ -41,18 +22,16 @@ export class Email extends URL {
    * situation where type casting to string is involved (`console.log`…).
    */
   toString () {
-    return `${this.username}@${this.host}`
+    return `${this.username}@${this.hostname}`
   }
 
   /**
-   * Recompose the email address and compare it to the input. We also make sure
-   * there is no port since `someone@domain.tld:3000` is valid for the `URL`
-   * constructor but adds `:{port}` to `this.host` (`domain.tld:3000`).
+   * Recompose the email address and compare it to the input.
    *
    * @param {string} address
    */
   #validate (address) {
-    return `${this.username}@${this.host}` == address && !this.port
+    return this.toString() == address
   }
 
   /**

package/types/index.d.ts

@@ -1,28 +1,27 @@
 export function round(number: number, precision?: number): number;
 export class Email extends URL {
 	/**
-	 * Whether or not an email address is parsable and valid.
+	 * The domain name and extension of the email.
 	 *
-	 * @param {any|Email} address
+	 * In `username@domain.tld`, it is `domain.tld`.
 	 */
-	static canParse(address: any | Email): boolean;
+	declare hostname: string;
 	/**
+	 * The username of the email.
 	 *
-	 * @param {string|Email} address An email address like `someone@domain.tld`.
+	 * In `username@domain.tld`, it is `username`.
 	 */
-	constructor(address: string | Email);
+	declare username: string;
 	/**
-	 * The domain name and extension of the email.
+	 * Whether or not an email address is parsable and valid.
 	 *
-	 * In `username@domain.tld`, it is `domain.tld`.
+	 * @param {any|Email} address
 	 */
-	get host(): string;
+	static canParse(address: any | Email): boolean;
 	/**
-	 * The username of the email.
-	 *
-	 * In `username@domain.tld`, it is `username`.
+	 * @param {string|Email} address An email address like `someone@domain.tld`.
 	 */
-	get username(): string;
+	constructor(address: string | Email);
 	#private;
 }