made-market 0.1.0 → 0.1.2

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.
Files changed (49) hide show
  1. package/README.md +17 -56
  2. package/bin/made-market.mjs +75 -23
  3. package/{tools/lib → lib}/market.mjs +7 -0
  4. package/package.json +9 -19
  5. package/registry/index.json +11 -11
  6. package/src/init.mjs +257 -0
  7. package/{tools → src}/install.mjs +14 -7
  8. package/{tools → src}/publish.mjs +2 -2
  9. package/docs/BACKEND.md +0 -189
  10. package/docs/INSTALL.md +0 -95
  11. package/docs/PUBLISH.md +0 -127
  12. package/docs/SPEC.md +0 -119
  13. package/server/auth.mjs +0 -121
  14. package/server/db.mjs +0 -485
  15. package/server/errors.mjs +0 -7
  16. package/server/server.mjs +0 -210
  17. package/server/service.mjs +0 -254
  18. package/server/store.mjs +0 -97
  19. package/site/glyphs.js +0 -22
  20. package/site/index.html +0 -158
  21. package/site/market.css +0 -915
  22. package/site/market.js +0 -521
  23. package/site/packages/alarm-clock-1.0.0.tar.gz +0 -0
  24. package/site/packages/bamboo-1.0.0.tar.gz +0 -0
  25. package/site/packages/demo-echo-1.0.0.tar.gz +0 -0
  26. package/site/packages/graphite-1.0.0.tar.gz +0 -0
  27. package/site/packages/key-chime-1.0.0.tar.gz +0 -0
  28. package/site/packages/ocean-1.0.0.tar.gz +0 -0
  29. package/site/packages/ollama-agent-1.0.0.tar.gz +0 -0
  30. package/site/packages/shell-agent-1.0.0.tar.gz +0 -0
  31. package/site/packages/sunset-1.0.0.tar.gz +0 -0
  32. package/site/packages/theme-cycler-1.0.0.tar.gz +0 -0
  33. package/site/packages/webhook-notify-1.0.0.tar.gz +0 -0
  34. package/site/registry.js +0 -813
  35. package/tools/build.mjs +0 -79
  36. package/tools/gen-assets.mjs +0 -67
  37. package/tools/lib/assets.mjs +0 -198
  38. package/tools/lib/oss.mjs +0 -75
  39. package/tools/new.mjs +0 -126
  40. package/tools/publish-oss.mjs +0 -119
  41. package/tools/serve.mjs +0 -63
  42. package/tools/validate.mjs +0 -44
  43. /package/{tools/lib → lib}/glyphs.mjs +0 -0
  44. /package/{tools/lib → lib}/icon.mjs +0 -0
  45. /package/{tools/lib → lib}/pack.mjs +0 -0
  46. /package/{tools/lib → lib}/plugin.mjs +0 -0
  47. /package/{tools/lib → lib}/tar.mjs +0 -0
  48. /package/{tools/lib → lib}/theme.mjs +0 -0
  49. /package/{tools → src}/account.mjs +0 -0
package/src/init.mjs ADDED
@@ -0,0 +1,257 @@
1
+ /**
2
+ * 脚手架:`npx made-market init <目录> --kind theme|control|agent`。
3
+ *
4
+ * 生成的就是一个能通过服务端校验、可直接 publish 的最小包——模板里每个
5
+ * 字段都带中文注释说明"这里填什么、有什么约束",开发者改掉占位文案就能上架。
6
+ * 资产(锁屏图/图标/提示音)给的是尺寸合法的占位二进制,替换成真图即可。
7
+ */
8
+ import fs from 'node:fs';
9
+ import path from 'node:path';
10
+ import { PACKAGE_DIR } from '../lib/plugin.mjs';
11
+ import { renderIcon } from '../lib/icon.mjs';
12
+
13
+ const THEME_NAME = /^[A-Za-z0-9_-]{1,64}$/;
14
+
15
+ /** 240×320 锁屏底图:深灰纯色 RGB565(0x2104 → 字节序 04 21)。 */
16
+ function placeholderRgb565(width, height) {
17
+ const buffer = Buffer.alloc(width * height * 2);
18
+ for (let i = 0; i < width * height; i++) buffer.writeUInt16LE(0x2104, i * 2);
19
+ return buffer;
20
+ }
21
+
22
+ /** 0.3 秒 16 kHz 16-bit 单声道静音 WAV(尺寸与格式合法,替换成真音频即可)。 */
23
+ function placeholderWav() {
24
+ const sampleRate = 16000;
25
+ const frames = Math.round(sampleRate * 0.3);
26
+ const pcm = Buffer.alloc(frames * 2);
27
+ const header = Buffer.alloc(44);
28
+ header.write('RIFF', 0, 'ascii');
29
+ header.writeUInt32LE(36 + pcm.length, 4);
30
+ header.write('WAVE', 8, 'ascii');
31
+ header.write('fmt ', 12, 'ascii');
32
+ header.writeUInt32LE(16, 16);
33
+ header.writeUInt16LE(1, 20); // PCM
34
+ header.writeUInt16LE(1, 22); // 单声道
35
+ header.writeUInt32LE(sampleRate, 24);
36
+ header.writeUInt32LE(sampleRate * 2, 28);
37
+ header.writeUInt16LE(2, 32);
38
+ header.writeUInt16LE(16, 34);
39
+ header.write('data', 36, 'ascii');
40
+ header.writeUInt32LE(pcm.length, 40);
41
+ return Buffer.concat([header, pcm]);
42
+ }
43
+
44
+ const THEME_COLORS = {
45
+ accent: '5B8DEF', btn_normal: '2E3A4E', btn_cancel: '3A4658', border: '6C8CC7',
46
+ text_primary: 'EDF3FF', text_secondary: 'B9C8E2', text_hint: '8395B4', text_accent: 'A8C6FF',
47
+ title: 'F2F7FF', bg_page: '141C29', bg_panel: '1D2836', bg_row: '263344', danger: 'D06A6A', lock_bg: '0F1620',
48
+ };
49
+
50
+ function themeMarketJson(id) {
51
+ return {
52
+ id,
53
+ kind: 'theme',
54
+ version: '0.1.0',
55
+ name: '我的主题',
56
+ nameEn: 'My Theme',
57
+ summary: '一句话简介(不超过 200 字节),会显示在市场目录里。',
58
+ summaryEn: 'One-line summary shown in the market listing.',
59
+ description: '详细描述:配色思路、锁屏图内容、提示音风格。支持多段。\n\n锁屏图为 240×320 的 RGB565(bg.bin),锁屏图标为 112×112(icon.bin),都随包提供,不需要刷固件。',
60
+ descriptionEn: 'Long description in English.',
61
+ author: '你的名字',
62
+ license: 'MIT',
63
+ tags: ['示例'],
64
+ glyph: 'palette',
65
+ highlights: ['14 项配色一次替换,圆屏上保持高对比'],
66
+ requires: { apiVersion: 1 },
67
+ changelog: [{ version: '0.1.0', notes: '首个版本', notesEn: 'First release' }],
68
+ };
69
+ }
70
+
71
+ function themeJson() {
72
+ return {
73
+ title: '我的主题',
74
+ colors: { ...THEME_COLORS },
75
+ sound: { file: 'chime.wav' },
76
+ lock: { icon: 'icon.bin', icon_w: 112, icon_h: 112, bg: 'bg.bin', bg_w: 240, bg_h: 320 },
77
+ };
78
+ }
79
+
80
+ function controlMarketJson(id, pluginId) {
81
+ return {
82
+ id,
83
+ kind: 'control',
84
+ version: '0.1.0',
85
+ pluginId,
86
+ name: '我的管控插件',
87
+ nameEn: 'My Control Plugin',
88
+ summary: '一句话简介:这个插件响应板子的什么事件、下发什么命令。',
89
+ summaryEn: 'One-line summary shown in the market listing.',
90
+ description: '详细描述工作方式。事件(events)与命令(commands)都只能用板侧公开清单里的名字,写别的设备不会执行。',
91
+ descriptionEn: 'Long description in English.',
92
+ author: '你的名字',
93
+ license: 'MIT',
94
+ tags: ['示例'],
95
+ glyph: 'terminal',
96
+ highlights: ['至少登记一个事件(管控插件的要求)'],
97
+ requires: { apiVersion: 1 },
98
+ changelog: [{ version: '0.1.0', notes: '首个版本', notesEn: 'First release' }],
99
+ };
100
+ }
101
+
102
+ function controlPluginMjs(pluginId) {
103
+ return `/**
104
+ * 管控插件模板:改掉 id/label,实现 onConnect / onEvent,就能发布。
105
+ *
106
+ * events 只能填板侧公开清单里的名字(boot.click / boot.double / boot.triple /
107
+ * boot.long);commands 只能填 caption.show / audio.play / theme.apply /
108
+ * volume.set / agent.select / session.* / voice.start / task.*。
109
+ * 语音通过 send({ name: 'audio.play' }, wav) 入队,send 在 onEvent 返回后仍有效。
110
+ */
111
+ export default {
112
+ apiVersion: 1,
113
+ kind: 'board-plugin',
114
+ id: '${pluginId}',
115
+ label: '我的插件',
116
+ events: ['boot.click'],
117
+ commands: ['caption.show'],
118
+ probe: (config) => {
119
+ // 健康探测:桥接器会显示 available / reason。
120
+ return { available: true, reason: '模板插件,尚未实现逻辑' };
121
+ },
122
+ onConnect({ deviceId, config, send }) {
123
+ // 设备连上来时触发(可选实现)。
124
+ },
125
+ onEvent({ event, deviceId, config, send }) {
126
+ if (event.name === 'boot.click') {
127
+ return { commands: [{ name: 'caption.show', fields: { text: '你好,码得!' } }] };
128
+ }
129
+ return null;
130
+ },
131
+ onDisconnect({ deviceId }) {
132
+ // 设备断开时触发(可选实现)。
133
+ },
134
+ };
135
+ `;
136
+ }
137
+
138
+ function controlPluginJson(pluginId) {
139
+ return {
140
+ id: pluginId,
141
+ settings: [],
142
+ };
143
+ }
144
+
145
+ function agentMarketJson(id, pluginId) {
146
+ return {
147
+ id,
148
+ kind: 'agent',
149
+ version: '0.1.0',
150
+ pluginId,
151
+ name: '我的 Agent 运行时',
152
+ nameEn: 'My Agent Runtime',
153
+ summary: '一句话简介:接的是哪个模型服务、怎么驱动码得。',
154
+ summaryEn: 'One-line summary shown in the market listing.',
155
+ description: '详细描述会话建立方式、模型接入与取消行为。',
156
+ descriptionEn: 'Long description in English.',
157
+ author: '你的名字',
158
+ license: 'MIT',
159
+ tags: ['示例'],
160
+ glyph: 'spark',
161
+ highlights: ['capabilities 需要覆盖 session / model / cancel / progress'],
162
+ requires: { apiVersion: 1 },
163
+ changelog: [{ version: '0.1.0', notes: '首个版本', notesEn: 'First release' }],
164
+ };
165
+ }
166
+
167
+ /** agent 模板的 capabilities:四个键写成一行字面量,静态扫描(scanPluginSource)才认得。 */
168
+ function agentPluginMjs(pluginId) {
169
+ return `/**
170
+ * agent 运行时模板:把云端模型会话接到码得。capabilities 静态扫描会检查
171
+ * session / model / cancel / progress 四个键是否齐全(缺了只是告警,但建议补全)。
172
+ * agent 包不接收板侧事件。
173
+ */
174
+ const createSession = async ({ deviceId, config }) => {
175
+ // 建立(或复用)一个模型会话,返回会话句柄。
176
+ return { id: \`demo-\${deviceId}\`, model: 'demo-model' };
177
+ };
178
+ const currentModel = async ({ config }) => 'demo-model';
179
+ const cancelTask = async () => { /* 取消当前任务 */ };
180
+ const reportProgress = ({ state }) => { /* 上报进度 */ };
181
+
182
+ export default {
183
+ apiVersion: 1,
184
+ kind: 'coding-agent',
185
+ id: '${pluginId}',
186
+ label: '我的 Agent',
187
+ capabilities: { session: createSession, model: currentModel, cancel: cancelTask, progress: reportProgress },
188
+ };
189
+ `;
190
+ }
191
+
192
+ function agentIconJson() {
193
+ // 与桥接器同一套 renderIcon:画一个 48×48 圆角方块占位图标(合法 indexed4)。
194
+ return renderIcon({ background: '#141C29', accent: '#5B8DEF', shapes: [[12, 12, 18, 18, '5B8DEF', 5]] });
195
+ }
196
+
197
+ const SCHEMAS = {
198
+ theme: {
199
+ label: '主题',
200
+ files(id) {
201
+ return [
202
+ { name: 'market.json', data: `${JSON.stringify(themeMarketJson(id), null, 2)}\n` },
203
+ { name: 'theme.json', data: `${JSON.stringify(themeJson(), null, 2)}\n` },
204
+ { name: 'bg.bin', data: placeholderRgb565(240, 320) },
205
+ { name: 'icon.bin', data: placeholderRgb565(112, 112) },
206
+ { name: 'chime.wav', data: placeholderWav() },
207
+ ];
208
+ },
209
+ },
210
+ control: {
211
+ label: '管控',
212
+ files(id) {
213
+ const pluginId = id.replace(/-/g, '_');
214
+ return [
215
+ { name: 'market.json', data: `${JSON.stringify(controlMarketJson(id, pluginId), null, 2)}\n` },
216
+ { name: 'plugin.mjs', data: controlPluginMjs(pluginId) },
217
+ { name: 'plugin.json', data: `${JSON.stringify(controlPluginJson(pluginId), null, 2)}\n` },
218
+ { name: 'settings.json', data: '{}\n' },
219
+ ];
220
+ },
221
+ },
222
+ agent: {
223
+ label: 'agent 运行时',
224
+ files(id) {
225
+ const pluginId = id.replace(/-/g, '_');
226
+ return [
227
+ { name: 'market.json', data: `${JSON.stringify(agentMarketJson(id, pluginId), null, 2)}\n` },
228
+ { name: 'plugin.mjs', data: agentPluginMjs(pluginId) },
229
+ { name: 'plugin.json', data: `${JSON.stringify({ id: pluginId, settings: [] }, null, 2)}\n` },
230
+ { name: 'icon.json', data: `${JSON.stringify(agentIconJson(), null, 2)}\n` },
231
+ ];
232
+ },
233
+ },
234
+ };
235
+
236
+ /**
237
+ * 生成脚手架。目录不存在则创建;已存在且非空时拒绝(除非 force)。
238
+ * @returns {string[]} 写入的文件路径列表
239
+ */
240
+ export function scaffold({ dir, kind, force = false }) {
241
+ const schema = SCHEMAS[kind];
242
+ if (!schema) throw new Error(`kind 必须是 theme / control / agent 之一`);
243
+ const id = path.basename(path.resolve(dir));
244
+ if (!PACKAGE_DIR.test(id)) throw new Error(`包目录名 ${id} 必须符合 ^[a-z0-9][a-z0-9_-]{0,39}$(它会成为包 ID)`);
245
+ if (kind === 'theme' && !THEME_NAME.test(id)) throw new Error(`主题目录名 ${id} 不符合 ^[A-Za-z0-9_-]{1,64}$`);
246
+ if (fs.existsSync(dir) && fs.readdirSync(dir).length && !force) {
247
+ throw new Error(`目录 ${dir} 不是空的;确认要覆盖就加 --force`);
248
+ }
249
+ fs.mkdirSync(dir, { recursive: true });
250
+ return schema.files(id).map((file) => {
251
+ const target = path.join(dir, file.name);
252
+ fs.writeFileSync(target, file.data);
253
+ return target;
254
+ });
255
+ }
256
+
257
+ export const SCAFFOLD_KINDS = Object.keys(SCHEMAS);
@@ -15,17 +15,24 @@ import fs from 'node:fs';
15
15
  import os from 'node:os';
16
16
  import path from 'node:path';
17
17
  import zlib from 'node:zlib';
18
- import { KINDS, ROOT, sha256 } from './lib/market.mjs';
19
- import { extractTar } from './lib/tar.mjs';
18
+ import { KINDS, PKG_ROOT, ROOT, sha256 } from '../lib/market.mjs';
19
+ import { extractTar } from '../lib/tar.mjs';
20
20
 
21
- const BUNDLED_REGISTRY = path.join(ROOT, 'registry', 'index.json');
21
+ /** 自带索引:仓库里是 cli/registry/(build 生成物),发布包里就是包根下的 registry/。 */
22
+ const BUNDLED_REGISTRY = path.join(PKG_ROOT, 'registry', 'index.json');
23
+
24
+ /** 官方市场:install/list/search 不带参数时的默认来源。 */
25
+ export const DEFAULT_SERVER = 'https://made-market.link';
22
26
 
23
27
  /**
24
- * 默认远端索引:显式 --registry > 环境变量 MADE_MARKET_REGISTRY > 包内自带索引。
25
- * 桥接包发布到 OSS 后,把 OSS 索引地址写进环境变量或作为 --registry 传入即可。
28
+ * 索引来源:显式 --registry > $MADE_MARKET_REGISTRY > $MADE_MARKET_SERVER > 官方市场。
29
+ * 全部指向远端;远端不可用时 loadRegistry 自动回落包内自带索引(离线可用)。
26
30
  */
27
31
  export function resolveRegistry(explicit = '') {
28
- return explicit || process.env.MADE_MARKET_REGISTRY || BUNDLED_REGISTRY;
32
+ if (explicit) return explicit;
33
+ if (process.env.MADE_MARKET_REGISTRY) return process.env.MADE_MARKET_REGISTRY;
34
+ const server = (process.env.MADE_MARKET_SERVER || DEFAULT_SERVER).replace(/\/+$/, '');
35
+ return `${server}/registry/index.json`;
29
36
  }
30
37
 
31
38
  /** 包目录根:--home > MADE_HOME > ~/made。与桥接器 packagesHome() 保持同一套规则。 */
@@ -53,7 +60,7 @@ const usage = `用法:node tools/install.mjs <包 ID…> [选项]
53
60
 
54
61
  选项
55
62
  --home <目录> 包目录根,默认 $MADE_HOME 或 ~/made
56
- --registry <路径|URL> 索引来源。默认优先 $MADE_MARKET_REGISTRY(远端),不可用或未设置时用包内自带索引(离线可用)
63
+ --registry <路径|URL> 索引来源。默认官方市场实时索引($MADE_MARKET_REGISTRY / $MADE_MARKET_SERVER 可覆盖),远端不可用时回落包内自带索引(离线可装示例包)
57
64
  --force 目标目录已存在时覆盖
58
65
  --dry-run 只校验并列出将要写入的文件
59
66
  --list 列出索引里的全部包
@@ -9,8 +9,8 @@
9
9
  import fs from 'node:fs';
10
10
  import path from 'node:path';
11
11
  import { loadCredentials } from './account.mjs';
12
- import { KINDS, validatePackage } from './lib/market.mjs';
13
- import { packPackage } from './lib/pack.mjs';
12
+ import { KINDS, validatePackage } from '../lib/market.mjs';
13
+ import { packPackage } from '../lib/pack.mjs';
14
14
 
15
15
  export function resolvePublishArgs(dir, options = {}) {
16
16
  // 登录凭证兜底:一次 login,publish 不再需要重复给 token
package/docs/BACKEND.md DELETED
@@ -1,189 +0,0 @@
1
- # 上传分发服务
2
-
3
- 用户自己上传包的后端。**"CI 过审即上架"的那道 CI 就是这个服务**:归档在服务端解包、
4
- 复用与 `tools/validate.mjs` 完全相同的规则校验,过不了就永远进不了索引。
5
-
6
- ## 形态
7
-
8
- 一个**无依赖的 Node HTTP 服务**(`node:http`,无 npm 依赖,连 PG 客户端都是自带的):
9
-
10
- ```
11
- server/
12
- ├── server.mjs HTTP 路由:上传 / 索引 / 归档下载 / 版本查询 / 搜索
13
- ├── service.mjs 发布流水线:校验 → 入库 → 同步索引(核心逻辑,测试直接驱动)
14
- ├── store.mjs 存储驱动:local(开发/测试)| oss(生产,阿里云)—— 事实源
15
- └── db.mjs Postgres 派生索引:零依赖线协议客户端(SCRAM-SHA-256)+ 表结构 + 查询
16
- ```
17
-
18
- 事实源与索引的分工:
19
-
20
- - **存储(local/oss)里的 manifests 是唯一事实源**,每条事实一个不可变对象,随时可以从它全量重建任何派生数据;
21
- - **Postgres 是派生索引**:发布时同步一行版本事实,搜索/查询/统计走 SQL。索引库没配、断了、报错,服务都自动回落到存储路径照常工作,修好后用 `rebuild-from-store` 补数据。
22
-
23
- ## 接口
24
-
25
- | 方法 | 路径 | 说明 |
26
- | --- | --- | --- |
27
- | `POST` | `/api/register` | 注册账号 `{name, password, displayName?}` → `{token}`,注册即登录 |
28
- | `POST` | `/api/login` | 登录 `{name, password}` → `{token}`(90 天会话) |
29
- | `GET` | `/api/me` | 当前登录的账号(Bearer 会话 token) |
30
- | `POST` | `/api/logout` | 吊销当前会话 |
31
- | `POST` | `/api/packages` | 发布一个包。Bearer = **登录会话**(或服务令牌),body = tar.gz(**带** market.json) |
32
- | `GET` | `/registry/index.json` | 公开索引(有 PG 从索引库拼装,没有则从 manifests 重建),与 CLI/站点约定完全一致 |
33
- | `GET` | `/packages/<归档名>` | 归档下载。oss 存储 302 跳公共读直链(客户端直连 OSS,服务不经手流量);local 存储由服务读文件返回 |
34
- | `GET` | `/api/packages/<id>` | 一个包的全部版本(install API 模式按这个直查,不拉全量索引) |
35
- | `GET` | `/api/search?q=&kind=&limit=` | 搜索:包名/英文名/简介/标签/创建人 ILIKE,kind 过滤 |
36
- | `GET` | `/` | 状态(含索引层 postgres/store) |
37
-
38
- **鉴权边界一句话:发布要登录,下载永远匿名。** 索引、搜索、版本查询、归档下载
39
- 都不需要任何凭证;只有 `POST /api/packages` 检查 Bearer。
40
-
41
- ## 发布流水线(服务端,上传方无法绕过)
42
-
43
- 1. 归档 ≤ 10 MB,gunzip + 解 tar,条目路径检查(拒绝 `..` / 绝对路径);
44
- 2. 读 `market.json`:id / kind / version 合法性;
45
- 3. **服务端校验**:`validatePackage` —— 与 `npm run validate` 同一套规则,
46
- 含 plugin.json 逐字段规范、主题资产存在性与尺寸、WAV 格式、indexed4 图标;
47
- 4. **版本不可变**:同 id + version 已存在即 409,只能提升版本重新发布;
48
- 5. 服务端**重新打包**(剥离 market.json),sha256 以服务端算的为准,不信任上传方;
49
- 6. 写入 `packages/<id>-<version>.tar.gz` 与 `manifests/<id>/<version>.json`,同步 PG 索引,刷新存储索引。
50
-
51
- 每次发布记录两个人:**`createdBy` = 该包首个版本的发布者(创建人,跨版本固定)**、
52
- `publishedBy` = 本版本的发布者。两者都进 manifest、公开索引、PG 搜索结果,可追溯。
53
-
54
- ## 存储是事实源,PG 是派生索引
55
-
56
- 存储(local/oss)里的对象布局不变:
57
-
58
- ```
59
- packages/<id>-<version>.tar.gz 归档本体(分发,不含 market.json)
60
- manifests/<id>/<version>.json 版本清单 = 索引条目 + createdBy/publishedBy/publishedAt(事实)
61
- registry/index.json 兼容用的公开索引快照(发布时刷新)
62
- users/<名>.json 账号:scrypt 加盐口令散列,不含明文
63
- sessions/<token>.json 登录会话:user + expiresAt(吊销 = 覆盖为 revoked 记录)
64
- access/tokens.json 服务令牌(CI/管理员兜底通道,可选,也可用环境变量)
65
- ```
66
-
67
- 配了 `DATABASE_URL` 时,PG 里有两张表:
68
-
69
- ```
70
- packages 每包一行:kind/name/summary/tags + latest_version/total_versions(搜索摘要)
71
- versions 每版本一行:entry = 整条 manifest(jsonb),version_key = 可数值排序的 bigint
72
- ```
73
-
74
- - `versions.entry` 与存储里的 manifest 一字不差——**PG 丢了可以从 manifests 全量重建,存储坏了以 PG 为准读,两条腿互为备份**;
75
- - 发布只写受影响的行,不再全量扫描,10 万包规模下发布仍是 O(1);
76
- - 搜索/未来登录、审核流、下载统计都在这层做,OSS 只管存放。
77
-
78
- 规模化路径:几千包以内不配 `DATABASE_URL` 也完全够用;包量上万或要上账号体系时加一行环境变量即可,客户端接口不变。
79
-
80
- ## PG 客户端为什么是自带的
81
-
82
- 延续仓库零 npm 依赖的原则,`db.mjs` 内置了最小 Postgres 线协议实现:
83
- 协议 3.0 握手、SCRAM-SHA-256(RFC 7677,测试含密钥推导交叉验证)、md5/明文/信任兜底、
84
- 简单查询协议、带断线重连的小连接池。**无 TLS**:仅限内网/同机部署,公网请套反向代理。
85
-
86
- ## 账号与登录
87
-
88
- 发布必须先登录;账号直接存进存储驱动(与 manifests 同一套事实源,local/OSS 通用,
89
- 不依赖 PG),口令用 scrypt 加盐散列,会话 90 天有效。
90
-
91
- ```sh
92
- npx made-market register alice --server https://market.example.com
93
- # 或:login(已有账号)。凭证存 <home>/credentials.json(0600)
94
- npx made-market publish ./my-theme --server https://market.example.com
95
- # 登录过就不再需要 --token
96
- npx made-market whoami # 看当前账号
97
- npx made-market logout # 吊销服务端会话并删除本地凭证
98
- ```
99
-
100
- 会话 token 只用于**上传**;下载和索引是公开的。
101
-
102
- ## 服务令牌(CI / 管理员兜底)
103
-
104
- 自动化通道可以不走账号,用预签的服务令牌,两个来源(可并用):
105
-
106
- - 环境变量 `MADE_MARKET_TOKENS=name:token,name:token`(重启生效);
107
- - 存储里的 `access/tokens.json`:`[{"name":"alice","token":"…"}]`(写入即生效)。
108
-
109
- 服务令牌发布的包,创建人/发布者记录为令牌名(如 `ci-bot`)。生成一个随机令牌:
110
-
111
- ```sh
112
- openssl rand -hex 24
113
- ```
114
-
115
- ## 部署
116
-
117
- 配置全部走环境变量:
118
-
119
- ```sh
120
- PORT=8787 # 监听端口
121
- MADE_MARKET_STORE=oss # local | oss
122
- MADE_MARKET_PUBLIC_URL=https://market.example.com # 对外基地址(写进索引 registryUrl)
123
- MADE_MARKET_TOKENS=alice:…,bob:… # 发布 token
124
- DATABASE_URL=postgres://made:…@pg:5432/made_market # 可选:PG 派生索引
125
- OSS_REGION=oss-cn-hangzhou # 以下为 oss 驱动所需
126
- OSS_BUCKET=made-market
127
- OSS_ACCESS_KEY_ID=…
128
- OSS_ACCESS_KEY_SECRET=…
129
- OSS_PREFIX= # 可选,key 前缀
130
- ```
131
-
132
- 直接跑(Node ≥ 22,无依赖):
133
-
134
- ```sh
135
- node server/server.mjs
136
- ```
137
-
138
- 或 Docker(PG 一起起:`docker compose up -d`,见 `docker-compose.yml`):
139
-
140
- ```sh
141
- docker build -t made-market-server .
142
- docker run -d -p 8787:8787 --env-file server.env made-market-server
143
- ```
144
-
145
- **安全提示**:OSS AccessKey 与数据库口令只放在服务端环境变量里,绝不进前端代码、仓库或
146
- `site/`——静态站点托管(GitHub Pages / OSS 静态托管)上的任何文件都是公开的。
147
-
148
- ## 索引自愈
149
-
150
- ```sh
151
- # 从存储 manifests 全量重建 PG 索引(换库、丢库、补数据都走这里)
152
- DATABASE_URL=postgres://… npx made-market rebuild-from-store
153
- ```
154
-
155
- ## 客户端怎么接
156
-
157
- 服务上线后,它就是一个普通的索引来源,三种接法任选:
158
-
159
- ```sh
160
- # 单次安装(拉全量索引)
161
- npx made-market install alarm-clock --registry https://market.example.com/registry/index.json
162
-
163
- # 大市场推荐:按包直查 API,不拉全量索引
164
- npx made-market install alarm-clock --server https://market.example.com
165
-
166
- # 设为默认下载源(服务优先,断网回落包内快照)
167
- export MADE_MARKET_REGISTRY=https://market.example.com/registry/index.json
168
-
169
- # 上传(作者侧):先注册/登录一次,之后 publish 不再需要凭证参数
170
- npx made-market register me --server https://market.example.com
171
- npx made-market publish ./my-theme --server https://market.example.com
172
- ```
173
-
174
- ## 本地开发
175
-
176
- ```sh
177
- docker compose up -d # 起 PG
178
- DATABASE_URL=postgres://made:made@127.0.0.1:5432/made_market \
179
- node server/server.mjs &
180
- npx made-market register me --server http://127.0.0.1:8787 --password dev123
181
- npx made-market publish packages/themes/sunset --server http://127.0.0.1:8787
182
- curl -s 'http://127.0.0.1:8787/api/search?q=日落'
183
- ```
184
-
185
- `local` 驱动的数据落在 `./data/`(已 gitignore)。测试覆盖:SCRAM/协议单元测试、
186
- 口令散列与会话生命周期、发布鉴权(未登录 401 / 登录可发 / 创建人跨版本固定 / 下载匿名)、
187
- CLI 账号链路(register → publish 免 token → whoami → logout)、真实 PG 集成测试
188
- (设 `DATABASE_URL` 启用,未设自动跳过)、无 PG 时服务全链路、索引库故障自动回落存储、
189
- rebuild-from-store CLI 端到端。
package/docs/INSTALL.md DELETED
@@ -1,95 +0,0 @@
1
- # 安装市场包
2
-
3
- 市场只发包,安装就是下载、校验、落盘到**一个固定目录**。桥接器每次启动自己扫这个目录,所以不需要登记,也不需要把包和配置文件放在一起。
4
-
5
- ## 一条命令
6
-
7
- ```sh
8
- npx made-market install <包 ID>
9
- ```
10
-
11
- 装到 `~/made`:
12
-
13
- - 主题包 → `~/made/themes/<dir>/`
14
- - 管控包、agent 包 → `~/made/plugins/<dir>/`
15
-
16
- 装完重启桥接器即可生效。也可以一次装多个:
17
-
18
- ```sh
19
- npx made-market install sunset alarm-clock demo-echo
20
- ```
21
-
22
- 常用命令与参数:
23
-
24
- ```sh
25
- npx made-market list # 列出全部包
26
- npx made-market search 主题 # 搜索
27
- npx made-market info sunset # 看详情:文件、校验和、安装位置
28
- npx made-market install sunset --dry-run # 只校验,不落盘
29
- ```
30
-
31
- | 参数 | 说明 |
32
- | --- | --- |
33
- | `--home <目录>` | 包目录根。默认 `$MADE_HOME`,再默认 `~/made` |
34
- | `--registry <路径或 URL>` | 指定索引来源。默认优先 `$MADE_MARKET_REGISTRY`(OSS 公开索引),不可达时自动回落到包内自带索引(离线可用) |
35
- | `--kind theme\|control\|agent` | 只列某一类(配合 `list` / `search`) |
36
- | `--json` | 以 JSON 输出,便于脚本消费 |
37
- | `--force` | 目标目录已存在时覆盖 |
38
- | `--dry-run` | 只校验和展示将要写入的文件,不落盘 |
39
-
40
- **包从哪里下载**:索引解析顺序是 `--registry` > `$MADE_MARKET_REGISTRY` > 包内自带快照,归档永远从索引进驻的同一位置按约定取(`<根>/registry/index.json` ↔ `<根>/packages/`)。权威分发源是 OSS,设一次环境变量即可:
41
-
42
- ```sh
43
- export MADE_MARKET_REGISTRY=https://<bucket>.<region>.aliyuncs.com/registry/index.json
44
- ```
45
-
46
- 每个归档的 `sha256` 都记录在索引里,安装前逐字节核对,改过一个字节都会拒绝。
47
-
48
- 安装工具**不执行**任何插件代码,也不写入任何密钥。
49
-
50
- ## 包目录在哪
51
-
52
- 固定的用户目录,桥接器启动时扫描 `<home>/plugins` 与 `<home>/themes`:
53
-
54
- | 优先级 | 目录 | 谁写 |
55
- | --- | --- | --- |
56
- | 1(被覆盖) | `bridge/builtin/plugins/`、`bridge/builtin/themes/` | 随桥接器代码发布,只读 |
57
- | 2(覆盖上面) | `~/made/plugins/`、`~/made/themes/` | 市场安装,以及你自己放进去的包 |
58
-
59
- **同名时 `~/made` 覆盖内置**。所以在 `~/made/plugins/` 放一个和内置同名的目录,就能本地顶掉内置那版。
60
-
61
- 改根目录的两种办法,优先级从高到低:命令行 `--home`、环境变量 `MADE_HOME`、桥接器 `config.local.json` 里的 `madeHome`、默认 `~/made`。
62
-
63
- ## 不用 npx 的两种装法
64
-
65
- 仓库内直接跑(开发时用):
66
-
67
- ```sh
68
- node tools/install.mjs alarm-clock --home ~/made
69
- ```
70
-
71
- 手动解包:从站点下载 `<id>-<version>.tar.gz`,解开覆盖到目标目录即可。
72
-
73
- ```sh
74
- mkdir -p ~/made/themes/sunset
75
- tar -xzf sunset-1.0.0.tar.gz -C ~/made/themes/sunset
76
- ```
77
-
78
- 归档里只有桥接器需要的文件,没有 `market.json`,可以直接解开覆盖。
79
-
80
- ## 卸载
81
-
82
- 在桥接器工作台的「插件」页点移除,或直接删掉目录:
83
-
84
- ```sh
85
- rm -rf ~/made/themes/sunset
86
- rm -rf ~/made/plugins/alarm-clock
87
- ```
88
-
89
- 内置包不能从工作台移除——它跟代码走。要停用就在工作台点停用,要覆盖就放同名目录到 `~/made`。
90
-
91
- 桥接器重启后生效。已下发的主题需要码得重新拉取才会回退。
92
-
93
- ## 安全
94
-
95
- 插件是本机 JavaScript,拥有桥接器进程的权限。**只安装你信任的代码。**市场侧能做的是:静态校验、公开源码、逐文件校验和(归档 sha256 + 每个文件的 sha256)。管控插件调用外部 hook 用的地址与密钥应当留在桥接器本机配置里,不要写进包。