@shisho/plugin-sdk 0.0.52 → 0.1.1

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/metadata.d.ts

@@ -18,7 +18,10 @@ export interface ParsedIdentifier {
 export interface ParsedChapter {
   /** Chapter title. */
   title: string;
-  /** CBZ: 0-indexed page number. */
+  /**
+   * CBZ and PDF: 0-indexed page number. A chapter with a negative value is
+   * dropped, along with its children, when Shisho stores chapters on scan.
+   */
   startPage?: number;
   /** M4B: milliseconds from start. */
   startTimestampMs?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisho/plugin-sdk",
-  "version": "0.0.52",
+  "version": "0.1.1",
   "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",