@shinsou/plugin 0.0.0-stage → 0.1.0

package/package.json

@@ -1,6 +1,53 @@
 {
   "name": "@shinsou/plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Shinsou X 套件作者工具：金鑰、建置、檢查、測試、開發伺服器與簽章發佈。",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aluo96078/shinsou-plugin-cli.git"
+  },
+  "homepage": "https://github.com/aluo96078/shinsou-plugin-cli#readme",
+  "bugs": {
+    "url": "https://github.com/aluo96078/shinsou-plugin-cli/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "bin": {
+    "shinsou-plugin": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "data",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "prepare": "node scripts/build.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import tsx --test test/*.test.ts",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "dependencies": {
+    "@noble/ciphers": "^2.4.0",
+    "@noble/ed25519": "^3.2.0",
+    "@noble/hashes": "^2.4.0",
+    "esbuild": "^0.28.2",
+    "node-html-parser": "^9.0.7",
+    "qrcode-terminal": "^0.12.0",
+    "quickjs-emscripten": "^0.32.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.5",
+    "@types/qrcode-terminal": "^0.12.2",
+    "cbor-x": "^1.6.9",
+    "tsx": "^4.23.15",
+    "typescript": "~5.9.0"
+  }
+}

package/templates/async/src/index.js

@@ -0,0 +1,50 @@
+// Async (JSON API) template: hooks may return Promises and use the non-blocking bridge.net.fetch.
+// Modules are allowed: build bundles imports into one script.
+import { toManga } from "./mapping.js";
+
+var API = "https://api.example.com";
+
+async function getJson(path) {
+  var res = await bridge.net.fetch(API + path, { method: "GET", headers: { Accept: "application/json" } });
+  if (res.status !== 200) throw new Error("SHINSOU_SOURCE_HTTP_UNAVAILABLE");
+  return JSON.parse(res.body);
+}
+
+var source = {
+  baseUrl: "https://example.com",
+  supportsLatest: false,
+
+  getPopularManga: async function (page) {
+    var data = await getJson("/titles?sort=popular&page=" + page);
+    return new MangasPage(data.items.map(toManga), data.hasNext);
+  },
+
+  getSearchManga: async function (page, query) {
+    var data = await getJson("/titles?q=" + encodeURIComponent(query) + "&page=" + page);
+    return new MangasPage(data.items.map(toManga), data.hasNext);
+  },
+
+  getMangaDetails: async function (manga) {
+    var data = await getJson("/titles/" + encodeURIComponent(manga.url));
+    var m = toManga(data);
+    m.description = data.description || null;
+    m.initialized = true;
+    return m;
+  },
+
+  getChapterList: async function (manga) {
+    var data = await getJson("/titles/" + encodeURIComponent(manga.url) + "/chapters");
+    return data.items.map(function (c) {
+      var ch = SChapter.create();
+      ch.url = c.id;
+      ch.name = c.title;
+      ch.chapterNumber = c.number;
+      return ch;
+    });
+  },
+
+  getPageList: async function (chapter) {
+    var data = await getJson("/chapters/" + encodeURIComponent(chapter.url) + "/pages");
+    return data.pages.map(function (url, i) { return new Page(i, "", url); });
+  }
+};

package/templates/async/src/mapping.js

@@ -0,0 +1,7 @@
+export function toManga(item) {
+  var m = SManga.create();
+  m.url = String(item.id);
+  m.title = item.title;
+  m.thumbnailUrl = item.cover || null;
+  return m;
+}

package/templates/async/test/cases.json

@@ -0,0 +1,4 @@
+[
+  { "name": "popular-page-1", "hook": "getPopularManga", "args": [1], "expect": { "path": "mangas", "minItems": 1, "matches": { "0.title": "Async Sample", "0.url": "42" } } },
+  { "name": "pages", "hook": "getPageList", "args": [{ "url": "c1" }], "expect": { "minItems": 2 } }
+]

package/templates/async/test/fixtures/sample.json

@@ -0,0 +1,10 @@
+[
+  {
+    "request": { "method": "GET", "url": "https://api.example.com/titles?sort=popular&page=1" },
+    "response": { "status": 200, "headers": { "content-type": "application/json" }, "body": "{\"items\":[{\"id\":42,\"title\":\"Async Sample\",\"cover\":\"https://cdn.example.com/42.jpg\"}],\"hasNext\":false}" }
+  },
+  {
+    "request": { "method": "GET", "url": "https://api.example.com/chapters/c1/pages" },
+    "response": { "status": 200, "body": "{\"pages\":[\"https://cdn.example.com/c1/1.jpg\",\"https://cdn.example.com/c1/2.jpg\"]}" }
+  }
+]

package/templates/common/.github/workflows/shinsou-refresh.yml

@@ -0,0 +1,42 @@
+# Re-signs publisher-revocations.json before it expires (default lifetime: 30 days).
+# The app refuses new installs and updates from a publisher whose revocations have expired
+# (ADR-0002 D8), so this must keep running.
+#
+# Secrets:
+#   SHINSOU_PLUGIN_KEY         the full JSON of ~/.config/shinsou-plugin/keys/<name>.json
+#   SHINSOU_PLUGIN_PASSPHRASE  its passphrase (only if the key is encrypted)
+name: Refresh Shinsou revocations
+
+on:
+  schedule:
+    - cron: "17 3 * * 1" # every Monday 03:17 UTC
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: shinsou-sign
+  cancel-in-progress: false
+
+jobs:
+  refresh:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm ci
+      - name: Re-sign revocations
+        env:
+          SHINSOU_PLUGIN_KEY: ${{ secrets.SHINSOU_PLUGIN_KEY }}
+          SHINSOU_PLUGIN_PASSPHRASE: ${{ secrets.SHINSOU_PLUGIN_PASSPHRASE }}
+        run: npx shinsou-plugin refresh --key "$(node -p 'JSON.parse(process.env.SHINSOU_PLUGIN_KEY).name')"
+      - name: Commit the new signature and sequence
+        run: |
+          git config user.name "shinsou-refresh"
+          git config user.email "shinsou-refresh@users.noreply.github.com"
+          git add .shinsou/state.json public
+          git diff --cached --quiet || git commit -m "chore: refresh publisher revocations"
+          git push

package/templates/common/gitignore

@@ -0,0 +1,3 @@
+node_modules/
+build/
+# public/ holds the signed repository you publish; commit it if you publish from this repo.

package/templates/manga/src/index.js

@@ -0,0 +1,75 @@
+// Manga source template. `var source` must stay a top-level declaration: the host looks it up by name.
+// Network access is limited to the exact origins in shinsou.plugin.json (sources[].requestOrigins).
+
+var BASE = "https://example.com";
+
+function absolute(url) {
+  return url.indexOf("http") === 0 ? url : BASE + url;
+}
+
+var source = {
+  baseUrl: BASE,
+  supportsLatest: true,
+
+  getPopularManga: function (page) {
+    var html = bridge.httpGet(BASE + "/popular?page=" + page);
+    if (!html) return new MangasPage([], false);
+    var doc = Jsoup.parse(html, BASE);
+    var mangas = doc.select(".manga-item").map(function (el) {
+      var m = SManga.create();
+      m.url = el.selectFirst("a").attr("href");
+      m.title = el.selectFirst(".title").text();
+      m.thumbnailUrl = el.selectFirst("img").absUrl("src");
+      return m;
+    });
+    return new MangasPage(mangas, doc.selectFirst("a.next") !== null);
+  },
+
+  getLatestUpdates: function (page) {
+    return this.getPopularManga(page);
+  },
+
+  getSearchManga: function (page, query, filters) {
+    var html = bridge.httpGet(BASE + "/search?q=" + encodeURIComponent(query) + "&page=" + page);
+    if (!html) return new MangasPage([], false);
+    var doc = Jsoup.parse(html, BASE);
+    var mangas = doc.select(".manga-item").map(function (el) {
+      var m = SManga.create();
+      m.url = el.selectFirst("a").attr("href");
+      m.title = el.selectFirst(".title").text();
+      return m;
+    });
+    return new MangasPage(mangas, false);
+  },
+
+  getMangaDetails: function (manga) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(manga.url)) || "", BASE);
+    manga.description = doc.select(".description").text();
+    manga.author = doc.select(".author").text();
+    manga.status = SManga.ONGOING;
+    manga.initialized = true;
+    return manga;
+  },
+
+  getChapterList: function (manga) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(manga.url)) || "", BASE);
+    return doc.select(".chapter-list a").map(function (el) {
+      var ch = SChapter.create();
+      ch.url = el.attr("href");
+      ch.name = el.text();
+      return ch;
+    });
+  },
+
+  getPageList: function (chapter) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(chapter.url)) || "", BASE);
+    return doc.select(".page-img img").map(function (img, i) {
+      var url = img.absUrl("data-src") || img.absUrl("src");
+      return new Page(i, "", url);
+    });
+  },
+
+  getFilterList: function () {
+    return [];
+  }
+};

package/templates/manga/test/cases.json

@@ -0,0 +1,10 @@
+[
+  { "name": "popular-page-1", "hook": "getPopularManga", "args": [1], "expect": { "path": "mangas", "minItems": 2, "snapshot": true } },
+  {
+    "name": "chapters",
+    "hook": "getChapterList",
+    "args": [{ "url": "/manga/1", "title": "Sample" }],
+    "expect": { "minItems": 2, "matches": { "0": { "url": "/manga/1/chapter/1", "name": "Chapter 1", "scanlator": null, "dateUpload": 0, "chapterNumber": -1 } } }
+  },
+  { "name": "pages", "hook": "getPageList", "args": [{ "url": "/manga/1/chapter/1" }], "expect": { "minItems": 2, "matches": { "0.imageUrl": "https://example.com/img/1.jpg" } } }
+]

package/templates/manga/test/fixtures/sample.json

@@ -0,0 +1,18 @@
+[
+  {
+    "request": { "method": "GET", "url": "https://example.com/popular?page=1" },
+    "response": {
+      "status": 200,
+      "headers": { "content-type": "text/html; charset=utf-8" },
+      "body": "<div class=\"manga-item\"><a href=\"/manga/1\"><img src=\"/cover/1.jpg\"><span class=\"title\">範例漫畫一</span></a></div><div class=\"manga-item\"><a href=\"/manga/2\"><img src=\"/cover/2.jpg\"><span class=\"title\">Sample Two</span></a></div><a class=\"next\" href=\"?page=2\">next</a>"
+    }
+  },
+  {
+    "request": { "method": "GET", "url": "https://example.com/manga/1" },
+    "response": { "status": 200, "body": "<p class=\"description\">A sample.</p><p class=\"author\">Someone</p><div class=\"chapter-list\"><a href=\"/manga/1/chapter/1\">Chapter 1</a><a href=\"/manga/1/chapter/2\">Chapter 2</a></div>" }
+  },
+  {
+    "request": { "method": "GET", "url": "https://example.com/manga/1/chapter/1" },
+    "response": { "status": 200, "body": "<div class=\"page-img\"><img data-src=\"/img/1.jpg\"><img data-src=\"/img/2.jpg\"></div>" }
+  }
+]

package/templates/mixed/src/index.js

@@ -0,0 +1,138 @@
+// Mixed package: one script, two sources with their own contentKinds (shinsou.plugin.json).
+//   - manga source: IMAGE_SEQUENCE  → getPageList returns image pages
+//   - novel source: PLAIN_TEXT      → getChapterText returns the chapter text string
+// `var sources` must stay a top-level declaration. Each entry's `id` must equal the sourceId in
+// shinsou.plugin.json (init filled them in): the host selects a source by exact id, never by position.
+
+var MANGA_BASE = "https://example.com";
+var NOVEL_BASE = "https://novel.example.com";
+
+function absolute(base, url) {
+  return url.indexOf("http") === 0 ? url : base + url;
+}
+
+var mangaSource = {
+  id: "__MANGA_SOURCE_ID__",
+  baseUrl: MANGA_BASE,
+  supportsLatest: true,
+
+  getPopularManga: function (page) {
+    var html = bridge.httpGet(MANGA_BASE + "/popular?page=" + page);
+    if (!html) return new MangasPage([], false);
+    var doc = Jsoup.parse(html, MANGA_BASE);
+    var mangas = doc.select(".manga-item").map(function (el) {
+      var m = SManga.create();
+      m.url = el.selectFirst("a").attr("href");
+      m.title = el.selectFirst(".title").text();
+      m.thumbnailUrl = el.selectFirst("img").absUrl("src");
+      return m;
+    });
+    return new MangasPage(mangas, doc.selectFirst("a.next") !== null);
+  },
+
+  getLatestUpdates: function (page) {
+    return this.getPopularManga(page);
+  },
+
+  getSearchManga: function (page, query, filters) {
+    var html = bridge.httpGet(MANGA_BASE + "/search?q=" + encodeURIComponent(query) + "&page=" + page);
+    if (!html) return new MangasPage([], false);
+    var doc = Jsoup.parse(html, MANGA_BASE);
+    var mangas = doc.select(".manga-item").map(function (el) {
+      var m = SManga.create();
+      m.url = el.selectFirst("a").attr("href");
+      m.title = el.selectFirst(".title").text();
+      return m;
+    });
+    return new MangasPage(mangas, false);
+  },
+
+  getMangaDetails: function (manga) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(MANGA_BASE, manga.url)) || "", MANGA_BASE);
+    manga.description = doc.select(".description").text();
+    manga.author = doc.select(".author").text();
+    manga.status = SManga.ONGOING;
+    manga.initialized = true;
+    return manga;
+  },
+
+  getChapterList: function (manga) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(MANGA_BASE, manga.url)) || "", MANGA_BASE);
+    return doc.select(".chapter-list a").map(function (el) {
+      var ch = SChapter.create();
+      ch.url = el.attr("href");
+      ch.name = el.text();
+      return ch;
+    });
+  },
+
+  getPageList: function (chapter) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(MANGA_BASE, chapter.url)) || "", MANGA_BASE);
+    return doc.select(".page-img img").map(function (img, i) {
+      var url = img.absUrl("data-src") || img.absUrl("src");
+      return new Page(i, "", url);
+    });
+  },
+
+  getFilterList: function () {
+    return [];
+  }
+};
+
+function listBooks(path) {
+  var html = bridge.httpGet(NOVEL_BASE + path);
+  if (!html) return new MangasPage([], false);
+  var doc = Jsoup.parse(html, NOVEL_BASE);
+  var books = doc.select(".book").map(function (el) {
+    var m = SManga.create();
+    m.url = el.selectFirst("a").attr("href");
+    m.title = el.selectFirst("a").text();
+    m.author = el.select(".author").text() || null;
+    return m;
+  });
+  return new MangasPage(books, doc.selectFirst("a.next") !== null);
+}
+
+var novelSource = {
+  id: "__NOVEL_SOURCE_ID__",
+  baseUrl: NOVEL_BASE,
+  supportsLatest: true,
+
+  getPopularManga: function (page) {
+    return listBooks("/rank?page=" + page);
+  },
+
+  getLatestUpdates: function (page) {
+    return listBooks("/latest?page=" + page);
+  },
+
+  getSearchManga: function (page, query, filters) {
+    return listBooks("/search?q=" + encodeURIComponent(query) + "&page=" + page);
+  },
+
+  getMangaDetails: function (book) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(NOVEL_BASE, book.url)) || "", NOVEL_BASE);
+    book.description = doc.select(".intro").text();
+    book.initialized = true;
+    return book;
+  },
+
+  getChapterList: function (book) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(NOVEL_BASE, book.url)) || "", NOVEL_BASE);
+    return doc.select(".toc a").map(function (el) {
+      var ch = SChapter.create();
+      ch.url = el.attr("href");
+      ch.name = el.text();
+      return ch;
+    });
+  },
+
+  // Returns the chapter text itself: paragraphs separated by a blank line.
+  getChapterText: function (chapter) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(NOVEL_BASE, chapter.url)) || "", NOVEL_BASE);
+    var paragraphs = doc.select(".content p").map(function (p) { return p.text(); });
+    return paragraphs.join("\n\n");
+  }
+};
+
+var sources = [mangaSource, novelSource];

package/templates/mixed/test/cases.json

@@ -0,0 +1,6 @@
+[
+  { "name": "manga-popular", "hook": "getPopularManga", "args": [1], "sourceId": "__MANGA_SOURCE_ID__", "expect": { "path": "mangas", "minItems": 2, "matches": { "0.title": "範例漫畫一" } } },
+  { "name": "manga-pages", "hook": "getPageList", "args": [{ "url": "/manga/1/chapter/1" }], "sourceId": "__MANGA_SOURCE_ID__", "expect": { "minItems": 2, "matches": { "0.imageUrl": "https://example.com/img/1.jpg" } } },
+  { "name": "novel-rank", "hook": "getPopularManga", "args": [1], "sourceId": "__NOVEL_SOURCE_ID__", "expect": { "path": "mangas", "minItems": 1, "matches": { "0.title": "範例小說" } } },
+  { "name": "novel-chapter-text", "hook": "getChapterText", "args": [{ "url": "/book/1/1.html" }], "sourceId": "__NOVEL_SOURCE_ID__", "expect": { "equals": "第一段。\n\n第二段。" } }
+]

package/templates/mixed/test/fixtures/sample.json

@@ -0,0 +1,22 @@
+[
+  {
+    "request": { "method": "GET", "url": "https://example.com/popular?page=1" },
+    "response": {
+      "status": 200,
+      "headers": { "content-type": "text/html; charset=utf-8" },
+      "body": "<div class=\"manga-item\"><a href=\"/manga/1\"><img src=\"/cover/1.jpg\"><span class=\"title\">範例漫畫一</span></a></div><div class=\"manga-item\"><a href=\"/manga/2\"><img src=\"/cover/2.jpg\"><span class=\"title\">Sample Two</span></a></div><a class=\"next\" href=\"?page=2\">next</a>"
+    }
+  },
+  {
+    "request": { "method": "GET", "url": "https://example.com/manga/1/chapter/1" },
+    "response": { "status": 200, "body": "<div class=\"page-img\"><img data-src=\"/img/1.jpg\"><img data-src=\"/img/2.jpg\"></div>" }
+  },
+  {
+    "request": { "method": "GET", "url": "https://novel.example.com/rank?page=1" },
+    "response": { "status": 200, "body": "<div class=\"book\"><a href=\"/book/1\">範例小說</a><span class=\"author\">作者</span></div>" }
+  },
+  {
+    "request": { "method": "GET", "url": "https://novel.example.com/book/1/1.html" },
+    "response": { "status": 200, "body": "<div class=\"content\"><p>第一段。</p><p>第二段。</p></div>" }
+  }
+]

package/templates/novel/src/index.js

@@ -0,0 +1,64 @@
+// Novel source template. A PLAIN_TEXT source is a text source when the script defines
+// getChapterText(chapter) returning the chapter text as one string (up to 4 MiB).
+// `var source` must stay a top-level declaration: the host looks it up by name.
+
+var BASE = "https://example.com";
+
+function absolute(url) {
+  return url.indexOf("http") === 0 ? url : BASE + url;
+}
+
+function listBooks(path) {
+  var html = bridge.httpGet(BASE + path);
+  if (!html) return new MangasPage([], false);
+  var doc = Jsoup.parse(html, BASE);
+  var books = doc.select(".book").map(function (el) {
+    var m = SManga.create();
+    m.url = el.selectFirst("a").attr("href");
+    m.title = el.selectFirst("a").text();
+    m.author = el.select(".author").text() || null;
+    return m;
+  });
+  return new MangasPage(books, doc.selectFirst("a.next") !== null);
+}
+
+var source = {
+  baseUrl: BASE,
+  supportsLatest: true,
+
+  getPopularManga: function (page) {
+    return listBooks("/rank?page=" + page);
+  },
+
+  getLatestUpdates: function (page) {
+    return listBooks("/latest?page=" + page);
+  },
+
+  getSearchManga: function (page, query, filters) {
+    return listBooks("/search?q=" + encodeURIComponent(query) + "&page=" + page);
+  },
+
+  getMangaDetails: function (book) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(book.url)) || "", BASE);
+    book.description = doc.select(".intro").text();
+    book.initialized = true;
+    return book;
+  },
+
+  getChapterList: function (book) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(book.url)) || "", BASE);
+    return doc.select(".toc a").map(function (el) {
+      var ch = SChapter.create();
+      ch.url = el.attr("href");
+      ch.name = el.text();
+      return ch;
+    });
+  },
+
+  // Returns the chapter text itself: paragraphs separated by a blank line.
+  getChapterText: function (chapter) {
+    var doc = Jsoup.parse(bridge.httpGet(absolute(chapter.url)) || "", BASE);
+    var paragraphs = doc.select(".content p").map(function (p) { return p.text(); });
+    return paragraphs.join("\n\n");
+  }
+};

package/templates/novel/test/cases.json

@@ -0,0 +1,4 @@
+[
+  {"name": "rank-page-1", "hook": "getPopularManga", "args": [1], "expect": {"path": "mangas", "minItems": 1, "matches": {"0.title": "範例小說"}}},
+  {"name": "chapter-text", "hook": "getChapterText", "args": [{"url": "/book/1/1.html"}], "expect": {"equals": "第一段。\n\n第二段。"}}
+]

package/templates/novel/test/fixtures/sample.json

@@ -0,0 +1,10 @@
+[
+  {
+    "request": { "method": "GET", "url": "https://example.com/rank?page=1" },
+    "response": { "status": 200, "body": "<div class=\"book\"><a href=\"/book/1\">範例小說</a><span class=\"author\">作者</span></div>" }
+  },
+  {
+    "request": { "method": "GET", "url": "https://example.com/book/1/1.html" },
+    "response": { "status": 200, "body": "<div class=\"content\"><p>第一段。</p><p>第二段。</p></div>" }
+  }
+]