feat(interfaces): ParseSubpathOptions

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

Author: unicornware

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

@@ -22,6 +22,7 @@
   "{@linkcode PackageJson}": "https://github.com/flex-development/pkg-types/blob/2.0.0/src/interfaces/package-json.ts",
   "{@linkcode PackageScope}": "/api/interfaces/#packagescope",
   "{@linkcode ParseModuleIdOptions}": "/api/interfaces/#parsemoduleidoptions",
+  "{@linkcode ParseSubpathOptions}": "/api/interfaces/#parsesubpathoptions",
   "{@linkcode ParsedModuleId}": "/api/interfaces/#parsedmoduleid",
   "{@linkcode Protocol}": "/api/types#protocol",
   "{@linkcode RESOLVE_EXTENSIONS}": "/api/#resolve-extensions",

src/interfaces/__tests__/options-parse-subpath.spec-d.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Type Tests - ParseSubpathOptions
+ * @module mlly/interfaces/tests/unit-d/ParseSubpathOptions
+ */
+
+import type { ModuleId } from '#src/types'
+import type TestSubject from '../options-parse-subpath'
+
+describe('unit-d:interfaces/ParseSubpathOptions', () => {
+  it('should match [dir: ModuleId]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('dir').toEqualTypeOf<ModuleId>()
+  })
+
+  it('should match [internal?: boolean]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('internal')
+      .toEqualTypeOf<boolean | undefined>()
+  })
+
+  it('should match [parent: ModuleId]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('parent')
+      .toEqualTypeOf<ModuleId>()
+  })
+})

src/interfaces/index.ts

@@ -9,6 +9,7 @@ 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 ParseSubpathOptions } from './options-parse-subpath'
 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-subpath.ts

@@ -0,0 +1,36 @@
+/**
+ * @file Interfaces - ParseSubpathOptions
+ * @module mlly/interfaces/ParseSubpathOptions
+ */
+
+import type { ModuleId } from '#src/types'
+
+/**
+ * Subpath parsing options.
+ *
+ * @see {@linkcode ModuleId}
+ */
+interface ParseSubpathOptions {
+  /**
+   * URL of directory containing relevant `package.json` file.
+   */
+  dir: ModuleId
+
+  /**
+   * Package [`imports`][1] hint.
+   *
+   * [1]: https://nodejs.org/api/packages.html#imports
+   *
+   * @default specifier.startsWith('#')
+   */
+  internal?: boolean | undefined
+
+  /**
+   * URL of module to resolve from.
+   *
+   * **Note**: Used for error reporting only.
+   */
+  parent: ModuleId
+}
+
+export type { ParseSubpathOptions as default }