mcp-databnf 1.1.1 → 2.1.0

package/dist/bnf/client.d.ts

@@ -18,10 +18,10 @@ interface Config {
     logLevel: LogLevel;
 }
 interface Logger {
-    debug(message: string): void;
-    info(message: string): void;
-    warn(message: string): void;
-    error(message: string): void;
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
 }
 
 /** The shapes the access layer produces. Nothing here knows about MCP. */
@@ -244,17 +244,6 @@ interface Page<T> {
     indexWindowFull?: boolean | null;
 }
 
-/** How a piece of caller text became the terms the index was given. */
-interface SearchReading {
-    /** The words the text was cut into, each one quoted into the query. */
-    words: string[];
-    /** The terms the index requires, after it splits inside a word. */
-    terms: string[];
-    /** The characters that marked nothing and were removed before the cutting. */
-    invisible: string[];
-    /** The visible characters that reached no term. */
-    setAside: string[];
-}
 type EntityKind = "ark" | "temp-work";
 interface EntityId {
     kind: EntityKind;
@@ -265,6 +254,16 @@ interface EntityId {
     /** The page a person can open. */
     pageUrl: string;
 }
+/**
+ * Read an identifier a caller wrote, in any of the forms they see.
+ *
+ * Rows carry `http://data.bnf.fr/ark:/12148/cb119219976#about`, prose carries
+ * `cb119219976`, and a browser carries `https://data.bnf.fr/ark:/12148/cb119219976`.
+ * All three name one record. Anything else is refused rather than guessed at,
+ * because an identifier built from a guess sends the next call to a record that
+ * does not exist and the answer reads as an absence.
+ */
+declare function parseEntityId(input: string): EntityId;
 
 /**
  * The one place that talks to data.bnf.fr.
@@ -318,7 +317,6 @@ declare class BnfClient {
     /** The deadline one query is given, which callers report rather than guess. */
     get timeoutMs(): number;
     /** The one address this client sends anything to. */
-    get endpoint(): string;
     /**
      * `cacheKey` is stated rather than taken from the query, because two reads of
      * one query can produce different values: a list cut to five rows is not the
@@ -328,24 +326,7 @@ declare class BnfClient {
     private read;
     private fetchAndParse;
     /** Read an identifier a caller wrote, refusing anything this dataset cannot address. */
-    identify(input: string): EntityId;
     /** The words a search will actually look for, which a tool reports back. */
-    words(input: string): string[];
-    /**
-     * The terms the index requires, which is what a row's presence rests on.
-     *
-     * The index splits inside a word at an apostrophe and at a hyphen, so a word
-     * a caller wrote as one can reach it as two, each required on its own.
-     */
-    indexTerms(words: readonly string[]): string[];
-    /**
-     * How a piece of caller text became the terms the search was run with.
-     *
-     * A tool reports the reading back, so the same reading has to be the one the
-     * query was built from: the words, the terms the index makes of them, and
-     * the characters that reached neither.
-     */
-    searchReading(input: string): SearchReading;
     searchAuthors(name: string, limit: number, offset: number): Promise<Read<Page<AuthorSummary>>>;
     getAuthor(id: EntityId): Promise<Read<AuthorDetail>>;
     /**
@@ -375,4 +356,4 @@ declare class BnfClient {
     types(id: EntityId): Promise<Read<string[]>>;
 }
 
-export { BnfClient, type ClientOptions, type Read };
+export { BnfClient, type ClientOptions, type EntityId, type EntityKind, type Read, parseEntityId };