@bilibili-notify/extension 0.0.0-stage → 0.1.0-alpha.0
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/AGENT_GUIDE.md +34 -0
- package/DEVELOPMENT.md +137 -0
- package/LICENSE +21 -0
- package/README.md +45 -2
- package/build.d.mts +25 -0
- package/build.mjs +4430 -0
- package/index.d.mts +2222 -0
- package/index.mjs +19 -0
- package/package.json +37 -3
- package/result-DVdiITy4.mjs +22 -0
- package/skills/bn-extension-development/SKILL.md +31 -0
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
|
-
"
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"description": "Public contract and build helpers for bilibili-notify extensions",
|
|
4
|
+
"version": "0.1.0-alpha.0",
|
|
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,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bn-extension-development
|
|
3
|
+
description: Develop and fix standalone bilibili-notify extensions using the public SDK. Use for subscription sources, push adapters, ctx integration, extension 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`,确认声明的是订阅来源、推送适配器还是两者,以及当前宿主兼容要求。
|
|
13
|
+
|
|
14
|
+
读取已安装 SDK 的 `node_modules/@bilibili-notify/extension/AGENT_GUIDE.md`。具体实现再查同目录的 `DEVELOPMENT.md`、`index.d.mts` 和 `build.d.mts`;这些资料随包提供,不需要私有 BN 主仓。依赖尚未安装时先执行 `vp install`。
|
|
15
|
+
|
|
16
|
+
## 实现与验证
|
|
17
|
+
|
|
18
|
+
1. 把请求转换为公开可观察的行为,明确正常结果、失败和停用后的表现。沿现有公开测试入口先复现或补刻画,再修改;测试使用合成输入和受控的上游响应。
|
|
19
|
+
2. 订阅来源使用 `SourceDef`,推送适配器使用 `PlatformAdapterDef`;按已安装类型接线,副作用经 ctx。新增能力与当前清单声明对应,避免在契约之外接入宿主内部模块。
|
|
20
|
+
3. 运行实际构建入口,核对具名 `activate`、从 schema 导出的清单字段和自包含产物。接口类型通过不代表上报载荷、收尾或重试行为正确,按改动验证这些行为。
|
|
21
|
+
4. JS/TS 操作经 vp;执行项目脚本用 `vp run`。定向验证改动后运行 `vp run verify`,让 lint、格式、类型、测试、构建和 ZIP 校验共同通过。测试从 `vite-plus/test` 导入运行入口。
|
|
22
|
+
|
|
23
|
+
需要宿主联调时,读SDK作者指南的“源码拓展联调”。安装拓展依赖后,用`vp dlx @bilibili-notify/bn@alpha dev`启动专用开发宿主,从拓展页挂载源码工程绝对路径;BN负责加载src/index.ts、监听和重载,工程无需先构建或单独启动。多个工程挂到同一宿主。检查源码预检失败仍保留旧实例、修改只重载对应项、解除不删除源码及停用语义。记录所用宿主版本和用途,结束时收掉自己的挂载和服务。
|
|
24
|
+
|
|
25
|
+
## 打包与发布
|
|
26
|
+
|
|
27
|
+
仅做开发或打包时,以本地产物和验证结果交付。用户要求发行时,先读项目 README 的发布与恢复流程,核对 `.bn/marketplace.json`、清单版本和目标仓库,再运行 `vp run release --tag v<清单版本> --dry-run`。
|
|
28
|
+
|
|
29
|
+
dry-run 通过只证明本地校验与预览完成。真实发布按用户已授权的目标和版本执行;不要把“运行 dry-run”扩成发布授权。发布器负责版本 ZIP、校验值与固定索引的顺序;已有版本字节冲突时使用新版本,按文档接续中断任务。
|
|
30
|
+
|
|
31
|
+
交付说明修改、实际执行的命令及结果,并区分本地夹具、真实上游、真实 GitHub Actions 和真实发行各自验过的范围。
|