@prose-reader/metadata-fetcher 1.341.0 → 1.342.0

package/dist/types/provider.d.ts

@@ -1,5 +1,5 @@
 import { ResolvedMetadata } from '@prose-reader/archive-reader';
-export type MetadataIdentifier = NonNullable<ResolvedMetadata["identifiers"]>[number];
+import { FetchMetadataInput } from './fetchMetadataInput.ts';
 export type MetadataProviderContext = {
     /**
      * How many candidates the caller will keep. A hint for the provider's own
@@ -27,28 +27,24 @@ export type MetadataCandidate = {
 };
 /**
  * A pluggable metadata source. Implementing one is: pick a stable `id`, read
- * the terms you can search on out of the metadata, return normalized
+ * the terms you can search on out of the compact input, return normalized
  * candidates.
  *
- * Both sides of a lookup speak {@link ResolvedMetadata} — what the book said
- * going in, what the catalog says coming back. There is no separate query
- * shape to learn: the vocabulary is already sparse by contract (`field !==
- * undefined` is a reliable presence check) and already carries everything a
- * catalog could key on, down to the format-scoped corners. `metadataAuthors`
- * is exported for the one derivation that needs the role vocabulary.
+ * Inputs contain only fields understood for lookup and matching. Returned
+ * candidates remain rich {@link ResolvedMetadata} entities.
  *
  * ```ts
- * import { type MetadataProvider, metadataAuthors } from "@prose-reader/metadata-fetcher"
+ * import { type MetadataProvider } from "@prose-reader/metadata-fetcher"
  *
  * const myProvider: MetadataProvider = {
  *   id: "myCatalog",
  *   name: "My Catalog",
- *   search: async (metadata, { limit, signal }) => {
- *     if (metadata.title === undefined) return []
+ *   search: async (input, { limit, signal }) => {
+ *     if (input.title === undefined) return []
  *
  *     const response = await fetch(
- *       `https://example.com/search?q=${encodeURIComponent(metadata.title)}` +
- *         `&author=${encodeURIComponent(metadataAuthors(metadata)[0] ?? "")}`,
+ *       `https://example.com/search?q=${encodeURIComponent(input.title)}` +
+ *         `&author=${encodeURIComponent(input.authors?.[0] ?? "")}`,
  *       { signal },
  *     )
  *     const { results } = await response.json()
@@ -72,5 +68,5 @@ export type MetadataProvider = {
      * nothing to search on, or nothing found. Throwing is allowed — a failing
      * provider never fails the fetch, it lands in `failedProviders`.
      */
-    readonly search: (metadata: ResolvedMetadata, context: MetadataProviderContext) => Promise<ReadonlyArray<MetadataCandidate>>;
+    readonly search: (input: FetchMetadataInput, context: MetadataProviderContext) => Promise<ReadonlyArray<MetadataCandidate>>;
 };

package/dist/utils/hasSearchTerms.d.ts

@@ -1,7 +1,7 @@
-import { ResolvedMetadata } from '@prose-reader/archive-reader';
+import { FetchMetadataInput } from '../types/fetchMetadataInput.ts';
 /**
  * Whether a catalog has anything to go on, so a lookup with nothing to ask
  * about costs no round trip. Publication details, a language, or a page count
  * narrow a search but cannot start one.
  */
-export declare const hasSearchTerms: (metadata: ResolvedMetadata) => boolean;
+export declare const hasSearchTerms: (input: FetchMetadataInput) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/metadata-fetcher",
-  "version": "1.341.0",
+  "version": "1.342.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -29,9 +29,9 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@prose-reader/archive-reader": "^1.341.0",
-    "@prose-reader/shared": "^1.341.0",
+    "@prose-reader/archive-reader": "^1.342.0",
+    "@prose-reader/shared": "^1.342.0",
     "xmldoc": "^2.0.0"
   },
-  "gitHead": "620bf290b88f12f2313f7b19aa4d4abdcf124ef1"
+  "gitHead": "99cc96dab3e29677ab017246bbad836b54720284"
 }