feat(models): ERR_INVALID_MODULE_SPECIFIER

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

Author: unicornware

src/models/__tests__/err-invalid-module-specifier.spec.ts

@@ -0,0 +1,47 @@
+/**
+ * @file Unit Tests - ERR_INVALID_MODULE_SPECIFIER
+ * @module errnode/models/tests/unit/ERR_INVALID_MODULE_SPECIFIER
+ */
+
+import { ErrorCode } from '#src/enums'
+import TestSubject from '../err-invalid-module-specifier'
+
+describe('unit:models/ERR_INVALID_MODULE_SPECIFIER', () => {
+  let base: string
+  let message: string
+  let reason: string
+  let request: string
+
+  beforeEach(() => {
+    base = import.meta.url
+    reason = 'empty import specifier'
+    request = '#'
+    message = `Invalid module '${request}'`
+  })
+
+  it('should return TypeError instance', () => {
+    expect(new TestSubject(request, reason)).to.be.instanceof(TypeError)
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(request, reason))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_INVALID_MODULE_SPECIFIER)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [request, undefined, undefined, message],
+      [request, reason, undefined, `${message} ${reason}`],
+      [request, reason, base, `${message} ${reason} imported from ${base}`]
+    ]
+
+    // Act + Expect
+    cases.forEach(([request, reason, base, expected]) => {
+      expect(new TestSubject(request, reason, base))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-invalid-module-specifier.ts

@@ -0,0 +1,57 @@
+/**
+ * @file Error Models - ERR_INVALID_MODULE_SPECIFIER
+ * @module errnode/models/ERR_INVALID_MODULE_SPECIFIER
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1323-L1326
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+
+/**
+ * `ERR_INVALID_MODULE_SPECIFIER` model.
+ *
+ * Thrown when an imported module string is an invalid URL, package name, or
+ * package subpath specifier.
+ *
+ * @see https://nodejs.org/api/errors.html#err_invalid_module_specifier
+ *
+ * @class
+ *
+ * @param {string} request - Invalid module specifier
+ * @param {string?} [reason=''] - Reason `request` is invalid
+ * @param {string?} [base=''] - Id of module `request` was imported from
+ * @return {NodeError<TypeError>} `TypeError` instance
+ */
+const ERR_INVALID_MODULE_SPECIFIER: NodeErrorConstructor<
+  TypeErrorConstructor,
+  MessageFn<[string, string?, string?]>
+> = createNodeError(
+  ErrorCode.ERR_INVALID_MODULE_SPECIFIER,
+  TypeError,
+  /**
+   * Creates an [`ERR_INVALID_MODULE_SPECIFIER`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_invalid_module_specifier
+   *
+   * @param {string} request - Invalid module specifier
+   * @param {string?} [reason=''] - Reason `request` is invalid
+   * @param {string?} [base=''] - Id of module `request` was imported from
+   * @return {string} Error message
+   */
+  (request: string, reason: string = '', base: string = ''): string => {
+    /**
+     * Error message.
+     *
+     * @var {string} message
+     */
+    let message: string = `Invalid module '${request}' ${reason}`.trimEnd()
+
+    // add details regarding where error occurred
+    if (base) message += ` imported from ${base}`
+
+    return message
+  }
+)
+
+export default ERR_INVALID_MODULE_SPECIFIER

src/models/index.ts

@@ -12,6 +12,7 @@ export { default as ERR_IMPORT_ASSERTION_TYPE_FAILED } from './err-import-assert
 export { default as ERR_IMPORT_ASSERTION_TYPE_MISSING } from './err-import-assertion-type-missing'
 export { default as ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED } from './err-import-assertion-type-unsupported'
 export { default as ERR_INCOMPATIBLE_OPTION_PAIR } from './err-incompatible-option-pair'
+export { default as ERR_INVALID_MODULE_SPECIFIER } from './err-invalid-module-specifier'
 export { default as ERR_METHOD_NOT_IMPLEMENTED } from './err-method-not-implemented'
 export { default as ERR_MISSING_OPTION } from './err-missing-option'
 export { default as ERR_NETWORK_IMPORT_DISALLOWED } from './err-network-import-disallowed'