@shisho/plugin-types 0.0.19 → 0.0.21

package/README.md

@@ -15,7 +15,7 @@ The types provide autocompletion for:
 - **`shisho.*`** - Host APIs (log, config, http, fs, archive, xml, ffmpeg)
 - **`plugin`** - Hook structure (inputConverter, fileParser, metadataEnricher, outputGenerator)
 - **Hook contexts** - Typed `context` parameters for each hook method
-- **Return types** - `ParsedMetadata`, `ConvertResult`, `EnrichmentResult`, etc.
+- **Return types** - `ParsedMetadata`, `ConvertResult`, `SearchResponse`, etc.
 
 ### TypeScript
 
@@ -23,10 +23,10 @@ If you write your plugin in TypeScript (and compile to JavaScript for deployment
 
 ```typescript
 import type {
-  EnrichmentResult,
   FileParserContext,
-  MetadataEnricherContext,
   ParsedMetadata,
+  SearchContext,
+  SearchResponse,
   ShishoPlugin,
 } from "@shisho/plugin-types";
 
@@ -43,16 +43,20 @@ const plugin: ShishoPlugin = {
   },
 
   metadataEnricher: {
-    enrich(context: MetadataEnricherContext): EnrichmentResult {
+    search(context: SearchContext): SearchResponse {
       const apiKey = shisho.config.get("apiKey");
       const resp = shisho.http.fetch(
-        `https://api.example.com/lookup?title=${context.book.title}`,
+        `https://api.example.com/search?q=${context.query}`,
         { method: "GET" },
       );
-      const data = resp.json() as { description: string };
+      const data = resp.json() as {
+        results: Array<{ title: string; description: string }>;
+      };
       return {
-        modified: true,
-        metadata: { description: data.description },
+        results: data.results.map((r) => ({
+          title: r.title,
+          description: r.description,
+        })),
       };
     },
   },
@@ -80,17 +84,18 @@ var plugin = (function () {
     },
 
     metadataEnricher: {
-      /** @param {MetadataEnricherContext} context @returns {EnrichmentResult} */
-      enrich: function (context) {
+      /** @param {SearchContext} context @returns {SearchResponse} */
+      search: function (context) {
         var apiKey = shisho.config.get("apiKey");
         var resp = shisho.http.fetch(
-          "https://api.example.com/lookup?title=" + context.book.title,
+          "https://api.example.com/search?q=" + context.query,
           { method: "GET" },
         );
         var data = resp.json();
         return {
-          modified: true,
-          metadata: { description: data.description },
+          results: data.results.map(function (r) {
+            return { title: r.title, description: r.description };
+          }),
         };
       },
     },

package/hooks.d.ts

@@ -1,4 +1,4 @@
-import { ParsedMetadata } from "./metadata";
+import { ParsedAuthor, ParsedMetadata } from "./metadata";
 
 /** Context passed to inputConverter.convert(). */
 export interface InputConverterContext {
@@ -51,14 +51,21 @@ export interface SearchContext {
 /** A single search result from metadataEnricher.search(). */
 export interface SearchResult {
   title: string;
-  authors?: string[];
+  authors?: ParsedAuthor[];
   description?: string;
   imageUrl?: string;
   releaseDate?: string;
   publisher?: string;
+  imprint?: string;
+  url?: string;
+  coverUrl?: string;
+  subtitle?: string;
+  series?: string;
+  seriesNumber?: number;
+  genres?: string[];
+  tags?: string[];
+  narrators?: string[];
   identifiers?: Array<{ type: string; value: string }>;
-  /** Opaque data passed back to enrich(). Use this to store internal IDs. */
-  providerData?: unknown;
 }
 
 /** Result returned from metadataEnricher.search(). */
@@ -66,38 +73,6 @@ export interface SearchResponse {
   results: SearchResult[];
 }
 
-/** Context passed to metadataEnricher.enrich(). */
-export interface EnrichContext {
-  /** The selected search result's providerData. */
-  selectedResult: unknown;
-  /** Current book state from the database. */
-  book: {
-    id?: number;
-    title?: string;
-    subtitle?: string;
-    description?: string;
-    series?: Array<{ name: string; number?: number }>;
-    authors?: Array<{ name: string; role?: string }>;
-    genres?: string[];
-    tags?: string[];
-    identifiers?: Array<{ type: string; value: string }>;
-    publisher?: string;
-  };
-  /** File information. */
-  file: {
-    fileType?: string;
-    filePath?: string;
-  };
-}
-
-/** Result returned from metadataEnricher.enrich(). */
-export interface EnrichmentResult {
-  /** Whether metadata was modified. */
-  modified: boolean;
-  /** Updated metadata (only used if modified is true). */
-  metadata?: ParsedMetadata;
-}
-
 /** Context passed to outputGenerator.generate(). */
 export interface OutputGeneratorContext {
   /** Path to the source book file. */
@@ -154,8 +129,6 @@ export interface FileParserHook {
 export interface MetadataEnricherHook {
   /** Search for candidate results from external sources. */
   search(context: SearchContext): SearchResponse;
-  /** Enrich metadata from a selected search result. */
-  enrich(context: EnrichContext): EnrichmentResult;
 }
 
 /** Output generator hook. */

package/metadata.d.ts

@@ -46,6 +46,8 @@ export interface ParsedMetadata {
   releaseDate?: string;
   /** MIME type of cover image (e.g., "image/jpeg"). */
   coverMimeType?: string;
+  /** Public URL for cover image. Server downloads at apply time. Lower precedence than coverData. Domain must be in httpAccess.domains. */
+  coverUrl?: string;
   /** Cover image data as ArrayBuffer. */
   coverData?: ArrayBuffer;
   /** 0-indexed page number for CBZ cover. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisho/plugin-types",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "TypeScript type definitions for Shisho plugin development",
   "homepage": "https://github.com/shishobooks/shisho/blob/master/packages/plugin-types/README.md",
   "types": "index.d.ts",