feat(interfaces): FindSubpathOptions

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

Author: unicornware

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

@@ -11,6 +11,7 @@
   "{@linkcode ExportStatement}": "/api/interfaces#exportstatement",
   "{@linkcode Exports}": "https://github.com/flex-development/pkg-types/blob/2.0.0/src/types/exports.ts",
   "{@linkcode Ext}": "https://github.com/flex-development/pathe/blob/main/src/types/ext.ts",
+  "{@linkcode FindSubpathOptions}": "/api/interfaces#findsubpathoptions",
   "{@linkcode Format}": "/api/enums#format",
   "{@linkcode GetFormatOptions}": "/api/interfaces#getformatoptions",
   "{@linkcode GetSourceOptions}": "/api/interfaces#getsourceoptions",

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

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - FindSubpathOptions
+ * @module mlly/interfaces/tests/unit-d/FindSubpathOptions
+ */
+
+import type { ModuleId } from '#src/types'
+import type TestSubject from '../options-find-subpath'
+
+describe('unit-d:interfaces/FindSubpathOptions', () => {
+  it('should match [condition?: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('condition')
+      .toEqualTypeOf<string | undefined>()
+  })
+
+  it('should match [conditions?: Set<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('conditions')
+      .toEqualTypeOf<Set<string> | undefined>()
+  })
+
+  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

@@ -6,6 +6,7 @@
 export type { default as ImportAssertions } from './import-assertions'
 export type { default as DynamicImport } from './import-dynamic'
 export type { default as StaticImport } from './import-static'
+export type { default as FindSubpathOptions } from './options-find-subpath'
 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'

src/interfaces/options-find-subpath.ts

@@ -0,0 +1,56 @@
+/**
+ * @file Interfaces - FindSubpathOptions
+ * @module mlly/interfaces/FindSubpathOptions
+ */
+
+import type { ModuleId } from '#src/types'
+
+/**
+ * Subpath search options.
+ *
+ * @see {@linkcode ModuleId}
+ */
+interface FindSubpathOptions {
+  /**
+   * Export condition to apply.
+   *
+   * @see https://nodejs.org/api/packages.html#conditional-exports
+   *
+   * @default 'default'
+   */
+  condition?: string | undefined
+
+  /**
+   * Export conditions.
+   *
+   * **Note**: Should be sorted by priority.
+   *
+   * @see https://nodejs.org/api/packages.html#conditional-exports
+   *
+   * @default CONDITIONS
+   */
+  conditions?: Set<string> | undefined
+
+  /**
+   * URL of directory containing relevant `package.json` file.
+   */
+  dir: ModuleId
+
+  /**
+   * Package [`imports`][1] hint.
+   *
+   * [1]: https://nodejs.org/api/packages.html#imports
+   *
+   * @default false
+   */
+  internal?: boolean | undefined
+
+  /**
+   * URL of module to resolve from.
+   *
+   * **Note**: Used for error reporting only.
+   */
+  parent: ModuleId
+}
+
+export type { FindSubpathOptions as default }