@shisho/plugin-sdk 0.1.0 → 0.2.0

package/README.md

@@ -13,7 +13,7 @@ npm install --save-dev @shisho/plugin-sdk
 The types provide autocompletion for:
 
 - **`shisho.*`** - Host APIs (log, config, http, fs, archive, xml, ffmpeg)
-- **`plugin`** - Hook structure (inputConverter, fileParser, metadataEnricher, outputGenerator)
+- **`plugin`** - Hook structure (inputConverter, fileParser, metadataEnricher)
 - **Hook contexts** - Typed `context` parameters for each hook method
 - **Return types** - `ParsedMetadata`, `ConvertResult`, `SearchResponse`, etc.
 

package/hooks.d.ts

@@ -62,49 +62,6 @@ export interface SearchResponse {
   results: ParsedMetadata[];
 }
 
-/** Book metadata passed to output-generator hooks. */
-export interface OutputBookContext {
-  id?: number;
-  title?: string;
-  subtitle?: string;
-  description?: string;
-  authors?: Array<{ name: string; role?: string }>;
-  series?: Array<{ name: string; number?: number }>;
-  genres?: string[];
-  tags?: string[];
-}
-
-/** File metadata passed to output-generator hooks. */
-export interface OutputFileContext {
-  id?: number;
-  filepath?: string;
-  fileType?: string;
-  fileRole?: string;
-  filesizeBytes?: number;
-  name?: string;
-  url?: string;
-  publisher?: string;
-  releaseDate?: string;
-  narrators?: string[];
-  identifiers?: Array<{ type: string; value: string }>;
-}
-
-/** Context passed to outputGenerator.generate(). */
-export interface OutputGeneratorContext {
-  /** Path to the source book file. */
-  sourcePath: string;
-  /** Path where the output file should be written. */
-  destPath: string;
-  book: OutputBookContext;
-  file: OutputFileContext;
-}
-
-/** Context passed to outputGenerator.fingerprint(). */
-export interface FingerprintContext {
-  book: OutputBookContext;
-  file: OutputFileContext;
-}
-
 /** Input converter hook. */
 export interface InputConverterHook {
   convert(context: InputConverterContext): ConvertResult;
@@ -121,18 +78,11 @@ export interface MetadataEnricherHook {
   search(context: SearchContext): SearchResponse;
 }
 
-/** Output generator hook. */
-export interface OutputGeneratorHook {
-  generate(context: OutputGeneratorContext): void;
-  fingerprint(context: FingerprintContext): string;
-}
-
 /** The global plugin object created by main.js. */
 export interface ShishoPlugin {
   inputConverter?: InputConverterHook;
   fileParser?: FileParserHook;
   metadataEnricher?: MetadataEnricherHook;
-  outputGenerator?: OutputGeneratorHook;
 
   /**
    * Optional lifecycle hook called before the plugin is uninstalled.

package/host-api.d.ts

@@ -130,9 +130,23 @@ export interface ShishoFS {
   readFile(path: string): ArrayBuffer;
   /** Read file contents as UTF-8 string. */
   readTextFile(path: string): string;
-  /** Write ArrayBuffer data to a file. */
+  /**
+   * Write ArrayBuffer data to a file.
+   *
+   * A new file is created with mode 0600 inside the plugin's own directory,
+   * `shisho.dataDir`, or `tempDir()`, and 0644 at any other permitted path
+   * (hook-provided paths and paths allowed by `fileAccess: "readwrite"`).
+   * The umask still applies. Overwriting an existing file keeps its mode.
+   */
   writeFile(path: string, data: ArrayBuffer): void;
-  /** Write string content to a file. */
+  /**
+   * Write string content to a file as UTF-8.
+   *
+   * New files get the same mode as `writeFile`: 0600 inside the plugin's own
+   * directory, `shisho.dataDir`, or `tempDir()`, and 0644 at any other
+   * permitted path. The umask still applies. Overwriting an existing file
+   * keeps its mode.
+   */
   writeTextFile(path: string, content: string): void;
   /** Check if a path exists. */
   exists(path: string): boolean;

package/manifest.d.ts

@@ -18,17 +18,6 @@ export interface FileParserCap {
   mimeTypes?: string[];
 }
 
-/** Output generator capability declaration. */
-export interface OutputGeneratorCap {
-  description?: string;
-  /** Unique format identifier (e.g., "mobi"). */
-  id: string;
-  /** Display name (e.g., "MOBI"). */
-  name: string;
-  /** Source file types this generator can convert from. */
-  sourceTypes: string[];
-}
-
 /** Valid metadata field names for enricher declarations. */
 export type MetadataField =
   | "title"
@@ -102,7 +91,6 @@ export interface ShellAccessCap {
 export interface Capabilities {
   inputConverter?: InputConverterCap;
   fileParser?: FileParserCap;
-  outputGenerator?: OutputGeneratorCap;
   metadataEnricher?: MetadataEnricherCap;
   identifierTypes?: IdentifierTypeCap[];
   httpAccess?: HTTPAccessCap;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisho/plugin-sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "TypeScript SDK for Shisho plugin development — types, host API declarations, and test utilities",
   "homepage": "https://github.com/shishobooks/shisho/blob/master/packages/plugin-sdk/README.md",
   "types": "index.d.ts",

package/testing/type-contract.ts

@@ -1,4 +1,4 @@
-import type { OutputGeneratorContext, ParsedMetadata } from "../index";
+import type { ParsedMetadata } from "../index";
 
 type Equal<Left, Right> =
   (<Type>() => Type extends Left ? 1 : 2) extends <Type>() => Type extends Right
@@ -12,19 +12,4 @@ type SeriesNumberEndContract = Expect<
   Equal<ParsedMetadata["seriesNumberEnd"], number | undefined>
 >;
 
-type OutputSeriesContract = Expect<
-  Equal<
-    OutputGeneratorContext["book"]["series"],
-    Array<{ name: string; number?: number }> | undefined
-  >
->;
-
-type OutputFilepathContract = Expect<
-  Equal<OutputGeneratorContext["file"]["filepath"], string | undefined>
->;
-
-export type {
-  OutputFilepathContract,
-  OutputSeriesContract,
-  SeriesNumberEndContract,
-};
+export type { SeriesNumberEndContract };