feat(models): ERR_PACKAGE_PATH_NOT_EXPORTED

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

Author: unicornware

src/models/__tests__/err-package-path-not-exported.spec.ts

@@ -0,0 +1,71 @@
+/**
+ * @file Unit Tests - ERR_PACKAGE_PATH_NOT_EXPORTED
+ * @module errnode/models/tests/unit/ERR_PACKAGE_PATH_NOT_EXPORTED
+ */
+
+import { ErrorCode } from '#src/enums'
+import TestSubject from '../err-package-path-not-exported'
+
+describe('unit:models/ERR_PACKAGE_PATH_NOT_EXPORTED', () => {
+  let base: string
+  let dir: string
+  let subpath: string
+
+  beforeEach(() => {
+    base = import.meta.url
+    dir = process.cwd() + 'node_modules/@flex-development/errnode/'
+    subpath = '.'
+  })
+
+  it('should return Error instance', () => {
+    // Act
+    const result = new TestSubject(dir, subpath)
+
+    // Expect
+    expect(result).to.be.instanceof(Error)
+    expect(result).to.have.property('name').equal('Error')
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(dir, subpath))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_PACKAGE_PATH_NOT_EXPORTED)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [
+        dir,
+        subpath,
+        undefined,
+        `No 'exports' main defined in ${dir}package.json`
+      ],
+      [
+        dir,
+        subpath,
+        base,
+        `No 'exports' main defined in ${dir}package.json imported from ${base}`
+      ],
+      [
+        dir,
+        subpath + '/internal/format-message',
+        undefined,
+        `Package subpath '${subpath}/internal/format-message' is not defined by 'exports' in ${dir}package.json`
+      ],
+      [
+        dir,
+        subpath + '/utils/create-node-error',
+        base,
+        `Package subpath '${subpath}/utils/create-node-error' is not defined by 'exports' in ${dir}package.json imported from ${base}`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([dir, subpath, base, expected]) => {
+      expect(new TestSubject(dir, subpath, base))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-package-path-not-exported.ts

@@ -0,0 +1,65 @@
+/**
+ * @file Error Models - ERR_PACKAGE_PATH_NOT_EXPORTED
+ * @module errnode/models/ERR_PACKAGE_PATH_NOT_EXPORTED
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1518-L1524
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+
+/**
+ * `ERR_PACKAGE_PATH_NOT_EXPORTED` model.
+ *
+ * Thrown when a `package.json` [`"exports"`][1] field does not export a
+ * requested subpath.
+ *
+ * [1]: https://nodejs.org/api/packages.html#exports
+ *
+ * @see https://nodejs.org/api/errors.html#err_package_path_not_exported
+ *
+ * @class
+ *
+ * @param {string} dir - Directory containing `package.json` file
+ * @param {string} subpath - Invalid subpath
+ * @param {string?} [base=''] - Id of module `subpath` was imported from
+ * @return {NodeError} `Error` instance
+ */
+const ERR_PACKAGE_PATH_NOT_EXPORTED: NodeErrorConstructor<
+  ErrorConstructor,
+  [string, string, string?]
+> = createNodeError(
+  ErrorCode.ERR_PACKAGE_PATH_NOT_EXPORTED,
+  Error,
+  /**
+   * Creates an [`ERR_PACKAGE_PATH_NOT_EXPORTED`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_package_path_not_exported
+   *
+   * @param {string} dir - Directory containing `package.json` file
+   * @param {string} subpath - Invalid subpath
+   * @param {string?} [base=''] - Id of module `subpath` was imported from
+   * @return {string} Error message
+   */
+  (dir: string, subpath: string, base: string = ''): string => {
+    /**
+     * Error message.
+     *
+     * @var {string} message
+     */
+    let message: string =
+      subpath === '.'
+        ? "No 'exports' main defined in"
+        : `Package subpath '${subpath}' is not defined by 'exports' in`
+
+    // add package.json location
+    message += ` ${dir}package.json`
+
+    // add import location
+    if (base) message += ` imported from ${base}`
+
+    return message
+  }
+)
+
+export default ERR_PACKAGE_PATH_NOT_EXPORTED

src/models/index.ts

@@ -20,6 +20,7 @@ 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_PACKAGE_PATH_NOT_EXPORTED } from './err-package-path-not-exported'
 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'