feat(errors): ERR_INVALID_FILE_URL_PATH

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

README.md

@@ -155,6 +155,7 @@ This package exports the following identifiers:
   - `ERR_INVALID_ARG_TYPE`
   - `ERR_INVALID_ARG_VALUE`
   - `ERR_INVALID_FILE_URL_HOST`
+  - `ERR_INVALID_FILE_URL_PATH`
   - `ERR_INVALID_MODULE_SPECIFIER`
   - `ERR_INVALID_PACKAGE_CONFIG`
   - `ERR_INVALID_PACKAGE_TARGET`

src/__snapshots__/errors.integration.snap

@@ -24,6 +24,8 @@ exports[`integration:errors > ERR_INVALID_ARG_VALUE > #toString > should return
 
 exports[`integration:errors > ERR_INVALID_FILE_URL_HOST > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_FILE_URL_HOST]: File URL host must be "localhost" or empty on darwin`;
 
+exports[`integration:errors > ERR_INVALID_FILE_URL_PATH > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_FILE_URL_PATH]: File URL path must not include encoded \\ or / characters`;
+
 exports[`integration:errors > ERR_INVALID_MODULE_SPECIFIER > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_MODULE_SPECIFIER]: Invalid module '@flex-development%2Fpathe' is not a valid package name imported from \${process.cwd()}/scratch.ts`;
 
 exports[`integration:errors > ERR_INVALID_PACKAGE_CONFIG > #toString > should return string representation of error 1`] = `Error [ERR_INVALID_PACKAGE_CONFIG]: Invalid package config \${process.cwd()}/node_modules/@flex-development/pathe/package.json while importing file://\${process.cwd()}/loader.mjs. "exports" cannot contain some keys starting with '.' and some not. The exports object must either be an object of package subpath keys or an object of main entry condition name keys only.`;

src/__snapshots__/index.e2e.snap

@@ -17,6 +17,7 @@ exports[`e2e:errnode > should expose public api 1`] = `
   "ERR_INVALID_ARG_TYPE",
   "ERR_INVALID_ARG_VALUE",
   "ERR_INVALID_FILE_URL_HOST",
+  "ERR_INVALID_FILE_URL_PATH",
   "ERR_INVALID_MODULE_SPECIFIER",
   "ERR_INVALID_PACKAGE_CONFIG",
   "ERR_INVALID_PACKAGE_TARGET",

src/__tests__/errors.integration.spec.ts

@@ -54,6 +54,11 @@ describe('integration:errors', () => {
     [codes.ERR_INVALID_ARG_TYPE, TypeError, 'ctor', 'Function', null],
     [codes.ERR_INVALID_ARG_VALUE, TypeError, 'address', 1],
     [codes.ERR_INVALID_FILE_URL_HOST, TypeError, 'darwin'],
+    [
+      codes.ERR_INVALID_FILE_URL_PATH,
+      TypeError,
+      'must not include encoded \\ or / characters'
+    ],
     [
       codes.ERR_INVALID_MODULE_SPECIFIER,
       TypeError,

src/errors/__tests__/err-invalid-file-url-path.spec-d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Type Tests - ERR_INVALID_FILE_URL_PATH
+ * @module errnode/errors/tests/unit-d/ERR_INVALID_FILE_URL_PATH
+ */
+
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type * as TestSubject from '../err-invalid-file-url-path'
+
+describe('unit-d:errors/ERR_INVALID_FILE_URL_PATH', () => {
+  describe('ERR_INVALID_FILE_URL_PATH', () => {
+    it('should be ErrInvalidFileUrlPathConstructor', () => {
+      expectTypeOf<typeof TestSubject.default>()
+        .toEqualTypeOf<TestSubject.ErrInvalidFileUrlPathConstructor>()
+    })
+  })
+
+  describe('ErrInvalidFileUrlPath', () => {
+    it('should extend NodeError<codes.ERR_INVALID_FILE_URL_PATH>', () => {
+      expectTypeOf<TestSubject.ErrInvalidFileUrlPath>()
+        .toMatchTypeOf<NodeError<codes.ERR_INVALID_FILE_URL_PATH>>()
+    })
+
+    it('should extend TypeError', () => {
+      expectTypeOf<TestSubject.ErrInvalidFileUrlPath>()
+        .toMatchTypeOf<TypeError>()
+    })
+  })
+
+  describe('ErrInvalidFileUrlPathConstructor', () => {
+    it('should match NodeErrorConstructor', () => {
+      // Arrange
+      type T = TestSubject.ErrInvalidFileUrlPath
+      type Args = TestSubject.ErrInvalidFileUrlPathArgs
+
+      // Expect
+      expectTypeOf<TestSubject.ErrInvalidFileUrlPathConstructor>()
+        .toMatchTypeOf<NodeErrorConstructor<T, Args>>()
+    })
+  })
+})

src/errors/err-invalid-file-url-path.ts

@@ -0,0 +1,75 @@
+/**
+ * @file Errors - ERR_INVALID_FILE_URL_PATH
+ * @module errnode/errors/ERR_INVALID_FILE_URL_PATH
+ * @see https://github.com/nodejs/node/blob/v22.8.0/lib/internal/errors.js#L1472
+ */
+
+import E from '#e'
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+
+/**
+ * `ERR_INVALID_FILE_URL_PATH` schema.
+ *
+ * @see {@linkcode NodeError}
+ * @see https://nodejs.org/api/errors.html#err_invalid_file_url_path
+ *
+ * @extends {NodeError<codes.ERR_INVALID_FILE_URL_PATH>}
+ * @extends {TypeError}
+ */
+interface ErrInvalidFileUrlPath
+  extends NodeError<codes.ERR_INVALID_FILE_URL_PATH>, TypeError {}
+
+/**
+ * `ERR_INVALID_FILE_URL_PATH` message arguments.
+ */
+type Args = [reason: string]
+
+/**
+ * `ERR_INVALID_FILE_URL_PATH` constructor.
+ *
+ * @see {@linkcode ErrInvalidFileUrlPath}
+ * @see {@linkcode NodeErrorConstructor}
+ *
+ * @extends {NodeErrorConstructor<ErrInvalidFileUrlPath,Args>}
+ */
+interface ErrInvalidFileUrlPathConstructor
+  extends NodeErrorConstructor<ErrInvalidFileUrlPath, Args> {
+  /**
+   * Create a new `ERR_INVALID_FILE_URL_PATH` error.
+   *
+   * @see {@linkcode ErrInvalidFileUrlPath}
+   *
+   * @param {string} reason
+   *  Reason for invalidity
+   * @return {ErrInvalidFileUrlPath}
+   */
+  new (reason: string): ErrInvalidFileUrlPath
+}
+
+/**
+ * `ERR_INVALID_FILE_URL_PATH` model.
+ *
+ * Thrown when a Node.js API that consumes `file:` URLs encountered a file URL
+ * with an incompatible path.
+ * The exact semantics for determining whether a path can be used is
+ * platform-dependent.
+ *
+ * @see {@linkcode ErrInvalidFileUrlPathConstructor}
+ *
+ * @type {ErrInvalidFileUrlPathConstructor}
+ *
+ * @class
+ */
+const ERR_INVALID_FILE_URL_PATH: ErrInvalidFileUrlPathConstructor = E(
+  codes.ERR_INVALID_FILE_URL_PATH,
+  TypeError,
+  'File URL path %s'
+)
+
+export {
+  ERR_INVALID_FILE_URL_PATH as default,
+  type ErrInvalidFileUrlPath,
+  type Args as ErrInvalidFileUrlPathArgs,
+  type ErrInvalidFileUrlPathConstructor
+}

src/errors/index.ts

@@ -76,6 +76,12 @@ export {
   type ErrInvalidFileUrlHostArgs,
   type ErrInvalidFileUrlHostConstructor
 } from './err-invalid-file-url-host'
+export {
+  default as ERR_INVALID_FILE_URL_PATH,
+  type ErrInvalidFileUrlPath,
+  type ErrInvalidFileUrlPathArgs,
+  type ErrInvalidFileUrlPathConstructor
+} from './err-invalid-file-url-path'
 export {
   default as ERR_INVALID_MODULE_SPECIFIER,
   type ErrInvalidModuleSpecifier,