feat(models): ERR_UNSUPPORTED_ESM_URL_SCHEME

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

package.json

@@ -143,6 +143,14 @@
   "bundleDependencies": [
     "node-inspect-extracted"
   ],
+  "peerDependencies": {
+    "@types/node": ">=14"
+  },
+  "peerDependenciesMeta": {
+    "@types/node": {
+      "optional": true
+    }
+  },
   "resolutions": {
     "@ardatan/sync-fetch": "larsgw/sync-fetch#head=worker_threads",
     "@flex-development/tutils": "6.0.0-alpha.7",

src/models/__tests__/err-unsupported-esm-url-scheme.spec.ts

@@ -0,0 +1,61 @@
+/**
+ * @file Unit Tests - ERR_UNSUPPORTED_ESM_URL_SCHEME
+ * @module errnode/models/tests/unit/ERR_UNSUPPORTED_ESM_URL_SCHEME
+ */
+
+import { ErrorCode } from '#src/enums'
+import formatList from '#src/internal/format-list'
+import { URL } from 'node:url'
+import TestSubject from '../err-unsupported-esm-url-scheme'
+
+describe('unit:models/ERR_UNSUPPORTED_ESM_URL_SCHEME', () => {
+  let schemes: string
+  let supported: string[]
+  let url: URL
+
+  beforeEach(() => {
+    supported = ['data', 'file']
+    url = new URL('dist/index.mjs', 'https://example.com/')
+    schemes = formatList(supported)
+  })
+
+  it('should return Error instance', () => {
+    // Act
+    const result = new TestSubject(url, supported)
+
+    // Expect
+    expect(result).to.be.instanceof(Error)
+    expect(result).to.have.property('name').equal('Error')
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(url, supported))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_UNSUPPORTED_ESM_URL_SCHEME)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [
+        url,
+        supported,
+        undefined,
+        `Only URLs with a scheme in: ${schemes} are supported by the default ESM loader. Received protocol '${url.protocol}'`
+      ],
+      [
+        new URL('dist/index.mjs', 'c://'),
+        supported,
+        true,
+        `Only URLs with a scheme in: ${schemes} are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([url, supported, windows, expected]) => {
+      expect(new TestSubject(url, supported, windows))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-unsupported-esm-url-scheme.ts

@@ -0,0 +1,71 @@
+/**
+ * @file Error Models - ERR_UNSUPPORTED_ESM_URL_SCHEME
+ * @module errnode/models/ERR_UNSUPPORTED_ESM_URL_SCHEME
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1698-L1706
+ */
+
+import { ErrorCode } from '#src/enums'
+import formatList from '#src/internal/format-list'
+import type { NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+import type { URL } from 'node:url'
+
+/**
+ * `ERR_UNSUPPORTED_ESM_URL_SCHEME` model.
+ *
+ * Thrown when an unsupported URL scheme is used in an `import` statement. URL
+ * schemes other than `file` and `data` are unsupported.
+ *
+ * @see https://nodejs.org/api/errors.html#err_unsupported_esm_url_scheme
+ *
+ * @class
+ *
+ * @param {URL} url - URL containing unsupported scheme
+ * @param {string[]} supported - Supported URL schemes
+ * @param {boolean?} [windows=false] - Windows operating system?
+ * @return {NodeError} `Error` instance
+ */
+const ERR_UNSUPPORTED_ESM_URL_SCHEME: NodeErrorConstructor<
+  ErrorConstructor,
+  [URL, string[], boolean?]
+> = createNodeError(
+  ErrorCode.ERR_UNSUPPORTED_ESM_URL_SCHEME,
+  Error,
+  /**
+   * Creates an [`ERR_UNSUPPORTED_ESM_URL_SCHEME`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_unsupported_esm_url_scheme
+   *
+   * @param {URL} url - URL containing unsupported scheme
+   * @param {string[]} supported - Supported URL schemes
+   * @param {boolean?} [windows=false] - Windows operating system?
+   * @return {string} Error message
+   */
+  (url: URL, supported: string[], windows: boolean = false): string => {
+    /**
+     * Supported URL schemes.
+     *
+     * @const {string} schemes
+     */
+    const schemes: string = formatList(supported)
+
+    /**
+     * Error message.
+     *
+     * @var {string} message
+     */
+    let message: string = `Only URLs with a scheme in: ${schemes} are supported by the default ESM loader`
+
+    // add additional error details if operating system is windows
+    if (windows && url.protocol.length === 2) {
+      message += '. On Windows, absolute paths must be valid file:// URLs'
+    }
+
+    // add url scheme provided by user
+    message += `. Received protocol '${url.protocol}'`
+
+    return message
+  }
+)
+
+export default ERR_UNSUPPORTED_ESM_URL_SCHEME

src/models/index.ts

@@ -26,3 +26,4 @@ export { default as ERR_UNKNOWN_ENCODING } from './err-unknown-encoding'
 export { default as ERR_UNKNOWN_FILE_EXTENSION } from './err-unknown-file-extension'
 export { default as ERR_UNKNOWN_MODULE_FORMAT } from './err-unknown-module-format'
 export { default as ERR_UNSUPPORTED_DIR_IMPORT } from './err-unsupported-dir-import'
+export { default as ERR_UNSUPPORTED_ESM_URL_SCHEME } from './err-unsupported-esm-url-scheme'

yarn.lock

@@ -1063,6 +1063,11 @@ __metadata:
     vitest: "npm:0.26.2"
     vitest-github-actions-reporter: "npm:0.9.0"
     yaml-eslint-parser: "npm:1.1.0"
+  peerDependencies:
+    "@types/node": ">=14"
+  peerDependenciesMeta:
+    "@types/node":
+      optional: true
   languageName: unknown
   linkType: soft