@skrillex1224/chrome-article-publish-extension 1.0.0

package/README.md

@@ -0,0 +1,226 @@
+# @skrillex1224/chrome-article-publish-extension
+
+Direct article publishing adapters for Chrome extensions. The package runs in a Manifest V3 extension context and reuses the user's logged-in browser sessions.
+
+## What It Exposes
+
+- `checkAuth(request)`: check whether the current extension browser profile is logged in to a platform.
+- `publish(request)`: publish or submit an article through the platform's public frontend API behavior.
+- `getStatus(request)`: query the platform's official management/detail/status source with the `statusRef` returned by `publish()`.
+- `createExtensionRuntime(config?)`: Chrome extension runtime implementation used by the three methods.
+
+The host extension owns UI, local task state, retry buttons, storage, and polling cadence.
+
+## Supported Platforms
+
+| id | Platform | Notes |
+|---|---|---|
+| `bilibili` | Bilibili Opus | Supports cover and structured Opus payload. Tables degrade to readable text. |
+| `weixin` | WeChat Official Account | Supports cover, body images, summary, and security QR events. |
+| `douyin` | Douyin image-text | Renders Markdown into image cards, then publishes image-text notes. |
+| `cnblogs` | Cnblogs | Supports article publish, tags, cover metadata. |
+| `juejin` | Juejin | Supports cover and real tag ids when the account is eligible. |
+| `baijiahao` | Baijiahao | Resolves public URLs from official page data after management status says published. |
+| `csdn` | CSDN | Supports cover/tags; account daily quota can block publish. |
+| `51cto` | 51CTO | Supports cover/tags/category mapping. |
+| `sohu` | Sohu | Publish/status works; platform policy can reject content. |
+| `netease` | Netease | Publish/status works; muted accounts cannot pass live publish. |
+| `toutiao` | Toutiao | Uses current creator management feed for status. |
+| `tencent` | Tencent Content Platform | Uses official frontend publish service and management list. |
+
+## Install
+
+```bash
+npm install @skrillex1224/chrome-article-publish-extension
+```
+
+## Chrome Extension Requirements
+
+Your host extension needs the browser capabilities the adapters use:
+
+```json
+{
+  "permissions": [
+    "storage",
+    "unlimitedStorage",
+    "cookies",
+    "declarativeNetRequest",
+    "declarativeNetRequestWithHostAccess",
+    "scripting",
+    "tabs",
+    "downloads"
+  ],
+  "host_permissions": ["http://*/*", "https://*/*"],
+  "background": { "type": "module" }
+}
+```
+
+The user must log in to each target platform in the same Chrome profile that runs the extension.
+
+## Usage
+
+```ts
+import {
+  checkAuth,
+  createExtensionRuntime,
+  getStatus,
+  publish,
+} from '@skrillex1224/chrome-article-publish-extension'
+
+const runtime = createExtensionRuntime({ timeout: 120_000 })
+
+const auth = await checkAuth({ platform: 'bilibili', runtime })
+if (!auth.isAuthenticated) {
+  throw new Error(auth.error || 'Not authenticated')
+}
+
+const result = await publish({
+  platform: 'bilibili',
+  runtime,
+  article: {
+    title: 'My article',
+    markdown: '# Heading\n\nArticle body.',
+    summary: 'Short summary',
+    cover: 'https://example.com/cover.jpg',
+    tags: ['tag-a', 'tag-b'],
+  },
+  async onEvent(event) {
+    if (event.type === 'security_check') {
+      console.log(event.method, event.url, event.expiresAt)
+    }
+  },
+})
+
+if (result.state === 'failed') {
+  throw new Error(result.error.message)
+}
+
+const status = await getStatus({
+  platform: 'bilibili',
+  runtime,
+  statusRef: result.statusRef,
+})
+
+console.log(status.state, status.postUrl, status.message)
+```
+
+## API
+
+### `checkAuth(request)`
+
+```ts
+type CheckAuthRequest = {
+  platform: string
+  runtime: RuntimeInterface
+}
+
+type AuthResult = {
+  isAuthenticated: boolean
+  username?: string
+  userId?: string
+  avatar?: string
+  error?: string
+}
+```
+
+Use this before showing a platform as ready to publish.
+
+### `publish(request)`
+
+```ts
+type PublishRequest = {
+  platform: string
+  runtime: RuntimeInterface
+  article: Article | PublishArticleInput
+  onEvent?: (event: PublishEvent) => void | Promise<void>
+  options?: {
+    onImageProgress?: (current: number, total: number) => void
+  }
+}
+
+type PublishArticleInput = {
+  title: string
+  description?: string
+  body?: string
+  content?: string
+  markdown?: string
+  html?: string
+  cover?: string
+  tags?: string[]
+  category?: string
+  source?: { url: string; platform: string }
+}
+```
+
+`publish()` returns only:
+
+```ts
+type PublishResult =
+  | {
+      platform: string
+      state: 'succeeded'
+      statusRef: PublishStatusRef
+      postId?: string
+      postUrl?: string
+      timestamp: number
+    }
+  | {
+      platform: string
+      state: 'failed'
+      error: { message: string; code?: string }
+      timestamp: number
+    }
+```
+
+If a platform needs QR, CAPTCHA, or a manual security check, `publish()` emits `onEvent({ type: 'security_check', ... })` and waits until the platform flow completes or times out.
+
+### `getStatus(request)`
+
+```ts
+type GetStatusRequest = {
+  platform: string
+  runtime: RuntimeInterface
+  statusRef: PublishStatusRef
+}
+
+type PublishStatusResult = {
+  platform: string
+  state: 'published' | 'reviewing' | 'rejected' | 'not_found' | 'unknown'
+  message?: string
+  postUrl?: string
+  checkedAt: number
+}
+```
+
+Store `statusRef` exactly as returned by `publish()`. Do not parse it in the host UI.
+
+## Runtime
+
+```ts
+const runtime = createExtensionRuntime({
+  timeout: 120_000,
+})
+```
+
+`timeout` controls extension `fetch()` timeout in milliseconds. Keep it higher for platforms that upload images or generated Markdown cards.
+
+## Testing In A Host Extension
+
+After loading the built extension in Chrome with remote debugging enabled:
+
+```bash
+CDP_URL=http://127.0.0.1:9224 \
+EXTENSION_ID=<your-extension-id> \
+node scripts/e2e-check-auth.mjs
+```
+
+The script sends `GET_PLATFORMS` and `CHECK_AUTH` through `chrome.runtime.sendMessage` and prints one row per platform.
+
+## Not Included
+
+- No UI framework.
+- No task database.
+- No retry scheduler.
+- No cross-profile cookie copying.
+- No platform button-click publishing.
+- No compatibility with Wechatsync's old public result shape.