feat(models): ERR_PACKAGE_IMPORT_NOT_DEFINED

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

Author: unicornware

src/models/__tests__/err-package-import-not-defined.spec.ts

@@ -0,0 +1,56 @@
+/**
+ * @file Unit Tests - ERR_PACKAGE_IMPORT_NOT_DEFINED
+ * @module errnode/models/tests/unit/ERR_PACKAGE_IMPORT_NOT_DEFINED
+ */
+
+import { ErrorCode } from '#src/enums'
+import TestSubject from '../err-package-import-not-defined'
+
+describe('unit:models/ERR_PACKAGE_IMPORT_NOT_DEFINED', () => {
+  let base: string
+  let dir: string
+  let message: string
+  let specifier: string
+
+  beforeEach(() => {
+    base = import.meta.url
+    dir = process.cwd()
+    specifier = '#src'
+    message = `Package import specifier '${specifier}' is not defined`
+  })
+
+  it('should return TypeError instance', () => {
+    // Act
+    const result = new TestSubject(specifier, base)
+
+    // Expect
+    expect(result).to.be.instanceof(TypeError)
+    expect(result).to.have.property('name').equal('TypeError')
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(specifier, base))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_PACKAGE_IMPORT_NOT_DEFINED)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [specifier, base, undefined, `${message} imported from ${base}`],
+      [
+        specifier,
+        base,
+        dir,
+        `${message} in package ${dir}package.json imported from ${base}`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([specifier, base, dir, expected]) => {
+      expect(new TestSubject(specifier, base, dir))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-package-import-not-defined.ts

@@ -0,0 +1,62 @@
+/**
+ * @file Error Models - ERR_PACKAGE_IMPORT_NOT_DEFINED
+ * @module errnode/models/ERR_PACKAGE_IMPORT_NOT_DEFINED
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1514-L1516
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+
+/**
+ * `ERR_PACKAGE_IMPORT_NOT_DEFINED` model.
+ *
+ * Thrown when a `package.json` [`"imports"`][1] field does not define the given
+ * internal package specifier mapping.
+ *
+ * [1]: https://nodejs.org/api/packages.html#imports
+ *
+ * @see https://nodejs.org/api/errors.html#err_package_import_not_defined
+ *
+ * @class
+ *
+ * @param {string} specifier - Package import specifier that is not defined
+ * @param {string} base - Id of module `specifier` was imported from
+ * @param {string?} [dir=''] - Directory containing `package.json` file
+ * @return {NodeError<TypeError>} `TypeError` instance
+ */
+const ERR_PACKAGE_IMPORT_NOT_DEFINED: NodeErrorConstructor<
+  TypeErrorConstructor,
+  MessageFn<[string, string, string?]>
+> = createNodeError(
+  ErrorCode.ERR_PACKAGE_IMPORT_NOT_DEFINED,
+  TypeError,
+  /**
+   * Creates a [`ERR_PACKAGE_IMPORT_NOT_DEFINED`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_package_import_not_defined
+   *
+   * @param {string} specifier - Package import specifier that is not defined
+   * @param {string} base - Id of module `specifier` was imported from
+   * @param {string?} [dir=''] - Directory containing `package.json` file
+   * @return {string} Error message
+   */
+  (specifier: string, base: string, dir: string = ''): string => {
+    /**
+     * Error message.
+     *
+     * @var {string} message
+     */
+    let message: string = `Package import specifier '${specifier}' is not defined`
+
+    // add package.json location
+    if (dir) message += ` in package ${dir}package.json`
+
+    // add import location
+    message += ` imported from ${base}`
+
+    return message
+  }
+)
+
+export default ERR_PACKAGE_IMPORT_NOT_DEFINED

src/models/index.ts

@@ -19,6 +19,7 @@ export { default as ERR_MISSING_OPTION } from './err-missing-option'
 export { default as ERR_MODULE_NOT_FOUND } from './err-module-not-found'
 export { default as ERR_NETWORK_IMPORT_DISALLOWED } from './err-network-import-disallowed'
 export { default as ERR_OPERATION_FAILED } from './err-operation-failed'
+export { default as ERR_PACKAGE_IMPORT_NOT_DEFINED } from './err-package-import-not-defined'
 export { default as ERR_UNHANDLED_ERROR } from './err-unhandled-error'
 export { default as ERR_UNKNOWN_ENCODING } from './err-unknown-encoding'
 export { default as ERR_UNKNOWN_FILE_EXTENSION } from './err-unknown-file-extension'