feat(models): ERR_INVALID_PACKAGE_TARGET

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

Author: unicornware

package.json

@@ -68,6 +68,7 @@
     "typecheck:watch": "vitest typecheck"
   },
   "dependencies": {
+    "@flex-development/pkg-types": "1.0.0",
     "@flex-development/tutils": "6.0.0-alpha.7",
     "node-inspect-extracted": "2.0.0"
   },
@@ -77,7 +78,6 @@
     "@commitlint/types": "17.0.0",
     "@faker-js/faker": "7.6.0",
     "@flex-development/mkbuild": "1.0.0-alpha.9",
-    "@flex-development/pkg-types": "1.0.0",
     "@graphql-eslint/eslint-plugin": "3.13.0",
     "@types/chai": "4.3.4",
     "@types/chai-string": "1.4.2",

src/models/__tests__/err-invalid-package-target.spec.ts

@@ -0,0 +1,74 @@
+/**
+ * @file Unit Tests - ERR_INVALID_PACKAGE_TARGET
+ * @module errnode/models/tests/unit/ERR_INVALID_PACKAGE_TARGET
+ */
+
+import { ErrorCode } from '#src/enums'
+import type pkg from '@flex-development/pkg-types'
+import TestSubject from '../err-invalid-package-target'
+
+describe('unit:models/ERR_INVALID_PACKAGE_TARGET', () => {
+  let base: string
+  let dir: string
+  let key: string
+  let target: pkg.Exports
+
+  beforeEach(() => {
+    base = import.meta.url
+    dir = process.cwd() + '/'
+    key = '.'
+    target = 'dist/index.mjs'
+  })
+
+  it('should return Error instance', () => {
+    // Act
+    const result = new TestSubject(dir, key, target)
+
+    // Expect
+    expect(result).to.be.instanceof(Error)
+    expect(result).to.have.property('name').equal('Error')
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(dir, key, target))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_INVALID_PACKAGE_TARGET)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [
+        dir,
+        key,
+        target,
+        undefined,
+        undefined,
+        `Invalid "exports" main target "${target}" defined in the package config ${dir}package.json; targets must start with "./"`
+      ],
+      [
+        dir,
+        key + '/utils',
+        'dist/utils.mjs',
+        undefined,
+        undefined,
+        `Invalid "exports" target "dist/utils.mjs" defined for './utils' in the package config ${dir}package.json; targets must start with "./"`
+      ],
+      [
+        '',
+        '#src',
+        'src/index.ts',
+        true,
+        base,
+        `Invalid "imports" target "src/index.ts" defined for '#src' in the package config package.json imported from ${base}`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([dir, key, target, internal, base, expected]) => {
+      expect(new TestSubject(dir, key, target, internal, base))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-invalid-package-target.ts

@@ -0,0 +1,101 @@
+/**
+ * @file Error Models - ERR_INVALID_PACKAGE_TARGET
+ * @module errnode/models/ERR_INVALID_PACKAGE_TARGET
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1331-L1346
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+import type pkg from '@flex-development/pkg-types'
+
+/**
+ * `ERR_INVALID_PACKAGE_TARGET` model.
+ *
+ * Thrown when a `package.json` [`"exports"`][1] or [`"imports"`][2] field
+ * contains an invalid target mapping value for the attempted module resolution.
+ *
+ * [1]: https://nodejs.org/api/packages.html#exports
+ * [2]: https://nodejs.org/api/packages.html#imports
+ *
+ * @see https://nodejs.org/api/errors.html#err_invalid_package_target
+ *
+ * @class
+ *
+ * @param {string} dir - Directory containing `package.json` file
+ * @param {string} key - `exports` or `imports` key
+ * @param {pkg.Exports} target - Invalid package target
+ * @param {boolean?} [internal=false] - `target` is package [`imports`][2]?
+ * @param {string?} [base=''] - Id of module package was imported from
+ * @return {NodeError} `Error` instance
+ */
+const ERR_INVALID_PACKAGE_TARGET: NodeErrorConstructor<
+  ErrorConstructor,
+  MessageFn<[string, string, pkg.Exports, boolean?, string?]>
+> = createNodeError(
+  ErrorCode.ERR_INVALID_PACKAGE_TARGET,
+  Error,
+  /**
+   * Creates a [`ERR_INVALID_PACKAGE_TARGET`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_invalid_package_target
+   * [2]: https://nodejs.org/api/packages.html#imports
+   *
+   * @param {string} dir - Directory containing `package.json` file
+   * @param {string} key - `exports` or `imports` key
+   * @param {pkg.Exports} target - Invalid package target
+   * @param {boolean?} [internal=false] - `target` is package [`imports`][2]?
+   * @param {string?} [base=''] - Id of module package was imported from
+   * @return {string} Error message
+   */
+  (
+    dir: string,
+    key: string,
+    target: pkg.Exports,
+    internal: boolean = false,
+    base: string = ''
+  ): string => {
+    /**
+     * [`"exports"`][1] main target check.
+     *
+     * [1]: https://nodejs.org/api/packages.html#exports
+     *
+     * @see https://nodejs.org/api/packages.html#subpath-exports
+     *
+     * @const {boolean} main
+     */
+    const main: boolean = !internal && key === '.'
+
+    /**
+     * Error message.
+     *
+     * @var {string} ret
+     */
+    let ret: string = `Invalid "${internal ? 'imports' : 'exports'}"`
+
+    // include if package target is main entry point
+    if (main) ret += ' main'
+
+    // add invalid package target
+    ret += ` target ${JSON.stringify(target)} defined`
+
+    // add key of invalid package target if target is not main entry point
+    if (!main) ret += ` for '${key}'`
+
+    // add package.json location
+    ret += ` in the package config ${dir}package.json`
+
+    // add import location
+    if (base) ret += ` imported from ${base}`
+
+    // add reason package target is invalid
+    ret +=
+      typeof target === 'string' && !internal && !target.startsWith('./')
+        ? '; targets must start with "./"'
+        : ''
+
+    return ret
+  }
+)
+
+export default ERR_INVALID_PACKAGE_TARGET

src/models/index.ts

@@ -15,6 +15,7 @@ export { default as ERR_INCOMPATIBLE_OPTION_PAIR } from './err-incompatible-opti
 export { default as ERR_INVALID_ARG_VALUE } from './err-invalid-arg-value'
 export { default as ERR_INVALID_MODULE_SPECIFIER } from './err-invalid-module-specifier'
 export { default as ERR_INVALID_PACKAGE_CONFIG } from './err-invalid-package-config'
+export { default as ERR_INVALID_PACKAGE_TARGET } from './err-invalid-package-target'
 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_MODULE_NOT_FOUND } from './err-module-not-found'