feat(interfaces): ParseModuleIdOptions

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

Author: unicornware

docs/.vitepress/theme/comments/link-replacements.json

@@ -21,6 +21,7 @@
   "{@linkcode NodeError}": "https://github.com/flex-development/errnode/blob/1.2.0/src/types/node-error.ts",
   "{@linkcode PackageJson}": "https://github.com/flex-development/pkg-types/blob/2.0.0/src/interfaces/package-json.ts",
   "{@linkcode PackageScope}": "/api/interfaces/#packagescope",
+  "{@linkcode ParsedModuleIdOptions}": "/api/interfaces/#parsedmoduleidoptions",
   "{@linkcode Protocol}": "/api/types#protocol",
   "{@linkcode RESOLVE_EXTENSIONS}": "/api/#resolve-extensions",
   "{@linkcode RequestInit}": "https://github.com/node-fetch/node-fetch/blob/v3.3.0/@types/index.d.ts#L71-L112",

src/interfaces/__tests__/options-parse-module-id.spec-d.ts

@@ -0,0 +1,32 @@
+/**
+ * @file Type Tests - ParseModuleIdOptions
+ * @module mlly/interfaces/tests/unit-d/ParseModuleIdOptions
+ */
+
+import type { ModuleId } from '#src/types'
+import type { KeysRequired } from '@flex-development/tutils'
+import type TestSubject from '../options-parse-module-id'
+
+describe('unit-d:interfaces/ParseModuleIdOptions', () => {
+  it('should allow empty object', () => {
+    expectTypeOf<KeysRequired<TestSubject>>().toBeNever()
+  })
+
+  it('should match [internal?: boolean]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('internal')
+      .toEqualTypeOf<boolean | undefined>()
+  })
+
+  it('should match [parent?: ModuleId]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('parent')
+      .toEqualTypeOf<ModuleId | undefined>()
+  })
+
+  it('should match [pkgname?: boolean]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('pkgname')
+      .toEqualTypeOf<boolean | undefined>()
+  })
+})

src/interfaces/index.ts

@@ -8,6 +8,7 @@ export type { default as DynamicImport } from './import-dynamic'
 export type { default as StaticImport } from './import-static'
 export type { default as GetFormatOptions } from './options-get-format'
 export type { default as GetSourceOptions } from './options-get-source'
+export type { default as ParseModuleIdOptions } from './options-parse-module-id'
 export type { default as ResolveOptions } from './options-resolve'
 export type { default as ResolveAliasOptions } from './options-resolve-alias'
 export type { default as PackageScope } from './package-scope'

src/interfaces/options-parse-module-id.ts

@@ -0,0 +1,38 @@
+/**
+ * @file Interfaces - ParseModuleIdOptions
+ * @module mlly/interfaces/ParseModuleIdOptions
+ */
+
+import type { ModuleId } from '#src/types'
+
+/**
+ * Module id parsing options.
+ *
+ * @see {@linkcode ModuleId}
+ */
+interface ParseModuleIdOptions {
+  /**
+   * Ensure module id is a valid internal specifier, syntactically.
+   *
+   * @see https://nodejs.org/api/packages.html#subpath-imports
+   *
+   * @default id instanceof URL ? false : id.startsWith('#')
+   */
+  internal?: boolean | undefined
+
+  /**
+   * URL of module to resolve from.
+   *
+   * **Note**: Used for error reporting only.
+   *
+   * @default undefined
+   */
+  parent?: ModuleId | undefined
+
+  /**
+   * Ensure module id begins with a valid package name.
+   */
+  pkgname?: boolean | undefined
+}
+
+export type { ParseModuleIdOptions as default }