@bilibili-notify/extension 0.0.0-stage → 0.1.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.mjs ADDED
@@ -0,0 +1,19 @@
1
+ import { n as ok, t as fail } from "./result-DVdiITy4.mjs";
2
+ // ../internal/lib/platform-descriptor.mjs
3
+ /** 中性的平台描述:名字就是平台名,目标按会话算、三种范围都给,地址叫法留空。每次造新的一份。 */
4
+ function neutralPlatformDescriptor(platform) {
5
+ return {
6
+ platform,
7
+ label: platform,
8
+ shortLabel: platform,
9
+ color: "#94a3b8",
10
+ targetKind: "session",
11
+ scopes: [
12
+ "group",
13
+ "private",
14
+ "channel"
15
+ ],
16
+ addressNouns: {}
17
+ };
18
+ }
19
+ export { fail, neutralPlatformDescriptor, ok };
package/package.json CHANGED
@@ -1,6 +1,40 @@
1
1
  {
2
2
  "name": "@bilibili-notify/extension",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "description": "Public contract and build helpers for bilibili-notify extensions",
4
+ "version": "0.1.0-alpha.1",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/Akokk0/bilibili-notify"
8
+ },
9
+ "author": {
10
+ "name": "Akokko",
11
+ "email": "admin@akokko.com"
12
+ },
13
+ "type": "module",
14
+ "files": [
15
+ "**/*.mjs",
16
+ "**/*.d.mts",
17
+ "README.md",
18
+ "DEVELOPMENT.md",
19
+ "AGENT_GUIDE.md",
20
+ "skills",
21
+ "LICENSE"
22
+ ],
23
+ "license": "MIT",
24
+ "types": "./index.d.mts",
25
+ "exports": {
26
+ ".": "./index.mjs",
27
+ "./build": "./build.mjs",
28
+ "./package.json": "./package.json"
29
+ },
30
+ "dependencies": {
31
+ "zod": "^4.4.3"
32
+ },
33
+ "engines": {
34
+ "node": ">=24.0.0"
35
+ },
36
+ "private": false,
37
+ "publishConfig": {
38
+ "access": "public"
39
+ }
6
40
  }
@@ -0,0 +1,22 @@
1
+ // ../internal/lib/result.mjs
2
+ function ok(value) {
3
+ return {
4
+ ok: true,
5
+ ...value
6
+ };
7
+ }
8
+ /**
9
+ * 失败的结果。没给的附加格不出现(不留值为 undefined 的键)。
10
+ * 码保留字面量,只会拒收的地方可以把失败那一支写成 `Failure & { code: "invalid" }`。
11
+ */
12
+ function fail(code, message, extras = {}) {
13
+ const failure = {
14
+ ok: false,
15
+ code,
16
+ message
17
+ };
18
+ if (extras.upstreamCode !== void 0) failure.upstreamCode = extras.upstreamCode;
19
+ if (extras.issues !== void 0) failure.issues = extras.issues;
20
+ return failure;
21
+ }
22
+ export { ok as n, fail as t };
@@ -0,0 +1,36 @@
1
+ ---
2
+ name: bn-extension-development
3
+ description: Develop and fix bilibili-notify extensions using the public SDK, in standalone projects or official workspace extensions. Use for sources, push adapters, ctx integration, packaging, and release dry-runs; not for changing the BN host itself.
4
+ ---
5
+
6
+ # BN 拓展开发
7
+
8
+ 在当前拓展工程中完成用户请求,保留项目已有的指引、能力范围和发行授权。此流程面向拓展,SDK 与创建器自身的 npm 发行属于各自的开发流程。
9
+
10
+ ## 定位契约
11
+
12
+ 从拓展工程根读取 `extension.json`、`package.json` 与 `README.md`,确认声明的是订阅来源、推送适配器还是两者,以及当前宿主兼容要求。先判断它是创建器生成的仓外工程,还是 BN 主仓 `extensions/<id>/` 中的官方拓展;命令与发行方式使用各自工程已定义的入口。
13
+
14
+ 读取该工程实际使用的 SDK 的 `AGENT_GUIDE.md`。仓外工程的入口是 `node_modules/@bilibili-notify/extension/AGENT_GUIDE.md`,workspace 工程读取本仓 SDK 对应文档。具体实现再查同一 SDK 的 `DEVELOPMENT.md`、`index.d.mts` 和 `build.d.mts`;仓外所需资料随包提供,不依赖私有 BN 主仓。依赖尚未安装时先执行 `vp install`,所用 API 以实际安装的 SDK 与宿主兼容范围为准。
15
+
16
+ ## 实现与验证
17
+
18
+ 1. 把请求转换为公开可观察的行为,明确正常结果、失败和停用后的表现。沿现有公开测试入口先复现或补刻画,再修改;测试使用合成输入和受控的上游响应。
19
+ 2. 订阅来源使用 `SourceDef`,推送适配器使用 `PlatformAdapterDef`;按已安装类型接线,副作用经 ctx。新增能力与当前清单声明对应,避免在契约之外接入宿主内部模块。
20
+ 3. 运行实际构建入口,核对具名 `activate`、从 schema 导出的清单字段和自包含产物。接口类型通过不代表上报载荷、收尾或重试行为正确,按改动验证这些行为。
21
+ 4. JS/TS 操作经 vp;执行项目脚本用 `vp run`,测试从 `vite-plus/test` 导入。创建器工程定向验证后运行已有的 `vp run verify`;其他工程按 `package.json` 和工程指引执行对应的 lint、格式、类型、测试、构建与 ZIP 校验。官方拓展使用主仓的包过滤和打包入口,不凭空添加 `verify` 脚本。
22
+
23
+ 需要宿主联调时,读 SDK 作者指南的“源码拓展联调”。优先复用用户指定且兼容的开发宿主;需要新实例时,按实际发行状态选可用版本,对应包已发布时使用 `vp dlx @bilibili-notify/bn@alpha dev`;尚不可用时使用用户提供的本地成品,或按 BN 主仓指引启动源码宿主。源码开发 BN 使用主仓 `vp run dev:apps`,不把“源码已实现”当成“npm 包已发布”。
24
+
25
+ 安装拓展依赖后,从拓展页挂载源码工程绝对路径;BN 负责加载 `src/index.ts`、监听和重载,工程无需先构建或单独启动。多个工程可挂到同一宿主。按改动核对预检失败保留旧实例、只重载对应项、解除不删除源码及停用语义。记录宿主版本和用途;结束时收掉自己新增的挂载和服务,保留用户原有实例及挂载。
26
+
27
+ ## 打包与发布
28
+
29
+ 仅做开发或打包时,以本地产物和验证结果交付。用户要求发行时,按工程类型读取对应流程:
30
+
31
+ - 仓外创建器工程使用 `.bn-extension/marketplace.json`;在 GitHub Actions 核对 `GITHUB_REPOSITORY`,在本地核对 `git remote get-url --push origin`,按 README 运行已有 `vp run release --tag v<清单版本> --dry-run`。
32
+ - BN 主仓的官方拓展使用主仓 `docs/agents/extension-marketplace.md`,无需创建 `.bn-extension/`;清单、更新记录与 `extension/<id>@<版本>` tag 对齐,沿官方工作流预检和发布。
33
+
34
+ dry-run 通过只证明本地校验与预览完成。真实发布按用户已授权的目标和版本执行;不要把“运行 dry-run”扩成发布授权。发布器负责版本 ZIP、校验值与固定索引的顺序;已有版本字节冲突时使用新版本,按文档接续中断任务。
35
+
36
+ 交付说明修改、实际执行的命令及结果,并区分本地夹具、真实上游、真实 GitHub Actions 和真实发行各自验过的范围。