@devbie/fewbie-cli 1.7.0 → 1.8.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/dist/registry/build.js +9 -0
- package/dist/registry/build.js.map +1 -1
- package/dist/registry/contract.d.ts +3 -0
- package/dist/registry/contract.js +119 -0
- package/dist/registry/contract.js.map +1 -0
- package/dist/registry/store.js +27 -2
- package/dist/registry/store.js.map +1 -1
- package/dist/registry/types.d.ts +12 -0
- package/package.json +4 -2
package/dist/registry/build.js
CHANGED
|
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
exports.buildRegistry = buildRegistry;
|
|
7
7
|
const promises_1 = __importDefault(require("node:fs/promises"));
|
|
8
8
|
const node_path_1 = __importDefault(require("node:path"));
|
|
9
|
+
const contract_1 = require("./contract");
|
|
9
10
|
const SHADCN_ITEM_SCHEMA = "https://ui.shadcn.com/r/registry-item.json";
|
|
10
11
|
async function buildRegistry(sourceRoot, outputRoot) {
|
|
11
12
|
const entries = await promises_1.default.readdir(sourceRoot, { withFileTypes: true });
|
|
@@ -25,6 +26,7 @@ async function buildRegistry(sourceRoot, outputRoot) {
|
|
|
25
26
|
if (manifest.name !== entry.name) {
|
|
26
27
|
throw new Error(`Registry folder '${entry.name}' does not match item name '${manifest.name}'.`);
|
|
27
28
|
}
|
|
29
|
+
const contract = (0, contract_1.validateManifestContract)(manifest);
|
|
28
30
|
const files = await Promise.all(manifest.files.map(async (relative) => {
|
|
29
31
|
const resolved = node_path_1.default.resolve(itemDir, relative);
|
|
30
32
|
if (!resolved.startsWith(node_path_1.default.resolve(itemDir) + node_path_1.default.sep)) {
|
|
@@ -45,11 +47,18 @@ async function buildRegistry(sourceRoot, outputRoot) {
|
|
|
45
47
|
...(manifest.dependencies?.length ? { dependencies: manifest.dependencies } : {}),
|
|
46
48
|
...(manifest.registryDependencies?.length ? { registryDependencies: manifest.registryDependencies } : {}),
|
|
47
49
|
...(manifest.postInstall ? { postInstall: manifest.postInstall } : {}),
|
|
50
|
+
...(contract ? { "x-fewbie.contract": contract } : {}),
|
|
48
51
|
files,
|
|
49
52
|
};
|
|
50
53
|
const outDir = node_path_1.default.join(outputRoot, entry.name);
|
|
51
54
|
await promises_1.default.mkdir(outDir, { recursive: true });
|
|
52
55
|
await promises_1.default.writeFile(node_path_1.default.join(outDir, "item.json"), `${JSON.stringify(builtItem, null, 2)}\n`);
|
|
56
|
+
if (contract) {
|
|
57
|
+
await promises_1.default.writeFile(node_path_1.default.join(outDir, "contract.json"), `${JSON.stringify(contract, null, 2)}\n`);
|
|
58
|
+
}
|
|
59
|
+
else {
|
|
60
|
+
await promises_1.default.rm(node_path_1.default.join(outDir, "contract.json"), { force: true });
|
|
61
|
+
}
|
|
53
62
|
built.push(entry.name);
|
|
54
63
|
}
|
|
55
64
|
return built;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/registry/build.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/registry/build.ts"],"names":[],"mappings":";;;;;AAcA,sCAmEC;AAjFD,gEAAkC;AAClC,0DAA6B;AAE7B,yCAAsD;AAGtD,MAAM,kBAAkB,GAAG,4CAA4C,CAAC;AAQjE,KAAK,UAAU,aAAa,CAAC,UAAkB,EAAE,UAAkB;IACxE,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAAE,SAAS;QACnC,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,cAAc,GAAG,MAAM,kBAAE;aAC5B,MAAM,CAAC,YAAY,CAAC;aACpB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACtB,IAAI,CAAC,cAAc;YAAE,SAAS;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAqB,CAAC;QAEzF,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,CAAC,IAAI,+BAA+B,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC;QAClG,CAAC;QAGD,MAAM,QAAQ,GAAG,IAAA,mCAAwB,EAAC,QAAQ,CAAC,CAAC;QAEpD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACpC,MAAM,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAIjD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,mBAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,CAAC,IAAI,0CAA0C,QAAQ,EAAE,CAAC,CAAC;YAC5G,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAC5C,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,SAAS,GAAsB;YACnC,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjF,GAAG,CAAC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzG,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,KAAK;SACN,CAAC;QAEF,MAAM,MAAM,GAAG,mBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,kBAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,MAAM,kBAAE,CAAC,SAAS,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAG9F,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,kBAAE,CAAC,SAAS,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACnG,CAAC;aAAM,CAAC;YACN,MAAM,kBAAE,CAAC,EAAE,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ModuleContract, RegistryManifest } from "./types";
|
|
2
|
+
export declare function parseModuleContract(value: unknown, itemName: string): ModuleContract;
|
|
3
|
+
export declare function validateManifestContract(manifest: Pick<RegistryManifest, "name" | "files" | "contract">): ModuleContract | undefined;
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.parseModuleContract = parseModuleContract;
|
|
7
|
+
exports.validateManifestContract = validateManifestContract;
|
|
8
|
+
const semver_1 = __importDefault(require("semver"));
|
|
9
|
+
const cli_kit_1 = require("@devbie/cli-kit");
|
|
10
|
+
const ALLOWED_UI = new Set([
|
|
11
|
+
"accordion",
|
|
12
|
+
"alert",
|
|
13
|
+
"alert-dialog",
|
|
14
|
+
"avatar",
|
|
15
|
+
"badge",
|
|
16
|
+
"breadcrumb",
|
|
17
|
+
"button",
|
|
18
|
+
"calendar",
|
|
19
|
+
"card",
|
|
20
|
+
"checkbox",
|
|
21
|
+
"collapsible",
|
|
22
|
+
"command",
|
|
23
|
+
"dialog",
|
|
24
|
+
"dropdown-menu",
|
|
25
|
+
"form",
|
|
26
|
+
"input",
|
|
27
|
+
"label",
|
|
28
|
+
"popover",
|
|
29
|
+
"progress",
|
|
30
|
+
"radio-group",
|
|
31
|
+
"scroll-area",
|
|
32
|
+
"select",
|
|
33
|
+
"separator",
|
|
34
|
+
"sheet",
|
|
35
|
+
"skeleton",
|
|
36
|
+
"switch",
|
|
37
|
+
"table",
|
|
38
|
+
"tabs",
|
|
39
|
+
"textarea",
|
|
40
|
+
"toast",
|
|
41
|
+
"tooltip",
|
|
42
|
+
]);
|
|
43
|
+
const ALLOWED_STATES = ["loading", "error", "empty", "success", "ready"];
|
|
44
|
+
const PORT_METHOD = /^[A-Za-z_$][\w$]*$/;
|
|
45
|
+
function fail(itemName, message) {
|
|
46
|
+
throw new cli_kit_1.CliError(`Registry item '${itemName}': contract.${message}`);
|
|
47
|
+
}
|
|
48
|
+
function assertNonEmptyString(itemName, field, value) {
|
|
49
|
+
if (typeof value !== "string" || value.trim() === "") {
|
|
50
|
+
fail(itemName, `${field} must be a non-empty string.`);
|
|
51
|
+
}
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
function assertStringList(itemName, field, value) {
|
|
55
|
+
if (!Array.isArray(value) || value.length === 0) {
|
|
56
|
+
fail(itemName, `${field} must be a non-empty array of strings.`);
|
|
57
|
+
}
|
|
58
|
+
const seen = new Set();
|
|
59
|
+
for (const entry of value) {
|
|
60
|
+
if (typeof entry !== "string" || entry.trim() === "") {
|
|
61
|
+
fail(itemName, `${field} must contain non-empty strings.`);
|
|
62
|
+
}
|
|
63
|
+
if (seen.has(entry))
|
|
64
|
+
fail(itemName, `${field} contains duplicate '${entry}'.`);
|
|
65
|
+
seen.add(entry);
|
|
66
|
+
}
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
function parseModuleContract(value, itemName) {
|
|
70
|
+
if (value === null || typeof value !== "object" || Array.isArray(value)) {
|
|
71
|
+
fail(itemName, "must be an object.");
|
|
72
|
+
}
|
|
73
|
+
const raw = value;
|
|
74
|
+
const version = assertNonEmptyString(itemName, "version", raw.version);
|
|
75
|
+
if (semver_1.default.valid(version) === null) {
|
|
76
|
+
fail(itemName, `version '${version}' is not a valid semver version.`);
|
|
77
|
+
}
|
|
78
|
+
const framework = assertNonEmptyString(itemName, "framework", raw.framework);
|
|
79
|
+
if (semver_1.default.validRange(framework) === null) {
|
|
80
|
+
fail(itemName, `framework '${framework}' is not a valid semver range.`);
|
|
81
|
+
}
|
|
82
|
+
const entry = assertNonEmptyString(itemName, "entry", raw.entry);
|
|
83
|
+
const labels = assertStringList(itemName, "labels", raw.labels);
|
|
84
|
+
const ports = assertStringList(itemName, "ports", raw.ports);
|
|
85
|
+
for (const port of ports) {
|
|
86
|
+
if (!PORT_METHOD.test(port))
|
|
87
|
+
fail(itemName, `ports entry '${port}' is not a valid method name.`);
|
|
88
|
+
}
|
|
89
|
+
const ui = assertStringList(itemName, "ui", raw.ui);
|
|
90
|
+
for (const atom of ui) {
|
|
91
|
+
if (!ALLOWED_UI.has(atom))
|
|
92
|
+
fail(itemName, `ui entry '${atom}' is not an allowed shadcn primitive.`);
|
|
93
|
+
}
|
|
94
|
+
const states = assertStringList(itemName, "states", raw.states);
|
|
95
|
+
for (const state of states) {
|
|
96
|
+
if (!ALLOWED_STATES.includes(state)) {
|
|
97
|
+
fail(itemName, `states entry '${state}' must be one of ${ALLOWED_STATES.join(", ")}.`);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
return {
|
|
101
|
+
version,
|
|
102
|
+
framework,
|
|
103
|
+
entry,
|
|
104
|
+
labels,
|
|
105
|
+
ports,
|
|
106
|
+
ui,
|
|
107
|
+
states: states,
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
function validateManifestContract(manifest) {
|
|
111
|
+
if (manifest.contract === undefined)
|
|
112
|
+
return undefined;
|
|
113
|
+
const contract = parseModuleContract(manifest.contract, manifest.name);
|
|
114
|
+
if (!manifest.files.includes(contract.entry)) {
|
|
115
|
+
fail(manifest.name, `entry '${contract.entry}' must be one of the item's files (${manifest.files.join(", ")}).`);
|
|
116
|
+
}
|
|
117
|
+
return contract;
|
|
118
|
+
}
|
|
119
|
+
//# sourceMappingURL=contract.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/registry/contract.ts"],"names":[],"mappings":";;;;;AA8EA,kDA4CC;AAOD,4DAUC;AA3ID,oDAA4B;AAE5B,6CAA2C;AAW3C,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,WAAW;IACX,OAAO;IACP,cAAc;IACd,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,MAAM;IACN,UAAU;IACV,aAAa;IACb,SAAS;IACT,QAAQ;IACR,eAAe;IACf,MAAM;IACN,OAAO;IACP,OAAO;IACP,SAAS;IACT,UAAU;IACV,aAAa;IACb,aAAa;IACb,QAAQ;IACR,WAAW;IACX,OAAO;IACP,UAAU;IACV,QAAQ;IACR,OAAO;IACP,MAAM;IACN,UAAU;IACV,OAAO;IACP,SAAS;CACV,CAAC,CAAC;AAEH,MAAM,cAAc,GAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAExF,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEzC,SAAS,IAAI,CAAC,QAAgB,EAAE,OAAe;IAC7C,MAAM,IAAI,kBAAQ,CAAC,kBAAkB,QAAQ,eAAe,OAAO,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,oBAAoB,CAAC,QAAgB,EAAE,KAAa,EAAE,KAAc;IAC3E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,8BAA8B,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB,EAAE,KAAa,EAAE,KAAc;IACvE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,wCAAwC,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACrD,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,kCAAkC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,wBAAwB,KAAK,IAAI,CAAC,CAAC;QAC/E,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,KAAiB,CAAC;AAC3B,CAAC;AAGD,SAAgB,mBAAmB,CAAC,KAAc,EAAE,QAAgB;IAClE,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,IAAI,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IACvC,CAAC;IACD,MAAM,GAAG,GAAG,KAAgC,CAAC;IAE7C,MAAM,OAAO,GAAG,oBAAoB,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACvE,IAAI,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,EAAE,YAAY,OAAO,kCAAkC,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7E,IAAI,gBAAM,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;QAC1C,IAAI,CAAC,QAAQ,EAAE,cAAc,SAAS,gCAAgC,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,QAAQ,EAAE,gBAAgB,IAAI,+BAA+B,CAAC,CAAC;IACnG,CAAC;IAED,MAAM,EAAE,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACpD,KAAK,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,QAAQ,EAAE,aAAa,IAAI,uCAAuC,CAAC,CAAC;IACtG,CAAC;IAED,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAChE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAoB,CAAC,EAAE,CAAC;YACnD,IAAI,CAAC,QAAQ,EAAE,iBAAiB,KAAK,oBAAoB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO;QACP,SAAS;QACT,KAAK;QACL,MAAM;QACN,KAAK;QACL,EAAE;QACF,MAAM,EAAE,MAAuB;KAChC,CAAC;AACJ,CAAC;AAOD,SAAgB,wBAAwB,CACtC,QAA+D;IAE/D,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAEtD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,QAAQ,CAAC,KAAK,sCAAsC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
package/dist/registry/store.js
CHANGED
|
@@ -9,11 +9,29 @@ exports.loadItem = loadItem;
|
|
|
9
9
|
exports.resolveInstallSet = resolveInstallSet;
|
|
10
10
|
const promises_1 = __importDefault(require("node:fs/promises"));
|
|
11
11
|
const node_path_1 = __importDefault(require("node:path"));
|
|
12
|
+
const colorette_1 = require("colorette");
|
|
12
13
|
const cli_kit_1 = require("@devbie/cli-kit");
|
|
14
|
+
const contract_1 = require("./contract");
|
|
13
15
|
async function readItemFile(root, name) {
|
|
14
16
|
const raw = await promises_1.default.readFile(node_path_1.default.join(root, name, "item.json"), "utf8");
|
|
15
17
|
return JSON.parse(raw);
|
|
16
18
|
}
|
|
19
|
+
function warnMissingContract(name) {
|
|
20
|
+
console.warn((0, colorette_1.yellow)(`Registry item '${name}' has no contract; pinning is unavailable until the module ships one.`));
|
|
21
|
+
}
|
|
22
|
+
async function readBuiltContract(root, name, item) {
|
|
23
|
+
if (item["x-fewbie.contract"] !== undefined)
|
|
24
|
+
return item["x-fewbie.contract"];
|
|
25
|
+
const sidecar = node_path_1.default.join(root, name, "contract.json");
|
|
26
|
+
const raw = await promises_1.default.readFile(sidecar, "utf8").catch((error) => {
|
|
27
|
+
if (error.code === "ENOENT")
|
|
28
|
+
return undefined;
|
|
29
|
+
throw error;
|
|
30
|
+
});
|
|
31
|
+
if (raw === undefined)
|
|
32
|
+
return undefined;
|
|
33
|
+
return (0, contract_1.parseModuleContract)(JSON.parse(raw), name);
|
|
34
|
+
}
|
|
17
35
|
async function listRegistryItemNames(root) {
|
|
18
36
|
const entries = await promises_1.default.readdir(root, { withFileTypes: true });
|
|
19
37
|
const names = [];
|
|
@@ -46,6 +64,10 @@ async function loadItem(root, name) {
|
|
|
46
64
|
if (isBuilt(item)) {
|
|
47
65
|
for (const file of item.files)
|
|
48
66
|
assertProjectRelativeTarget(name, file.path);
|
|
67
|
+
const targets = item.files.map((f) => f.path);
|
|
68
|
+
const declared = await readBuiltContract(root, name, item);
|
|
69
|
+
if (declared === undefined)
|
|
70
|
+
warnMissingContract(name);
|
|
49
71
|
return {
|
|
50
72
|
manifest: {
|
|
51
73
|
name: item.name,
|
|
@@ -55,7 +77,8 @@ async function loadItem(root, name) {
|
|
|
55
77
|
dependencies: item.dependencies,
|
|
56
78
|
registryDependencies: item.registryDependencies,
|
|
57
79
|
postInstall: item.postInstall,
|
|
58
|
-
files:
|
|
80
|
+
files: targets,
|
|
81
|
+
contract: declared === undefined ? undefined : (0, contract_1.validateManifestContract)({ name, files: targets, contract: declared }),
|
|
59
82
|
},
|
|
60
83
|
files: item.files.map((f) => ({
|
|
61
84
|
target: f.path,
|
|
@@ -66,11 +89,13 @@ async function loadItem(root, name) {
|
|
|
66
89
|
const manifest = item;
|
|
67
90
|
for (const relative of manifest.files)
|
|
68
91
|
assertProjectRelativeTarget(name, relative);
|
|
92
|
+
if (manifest.contract === undefined)
|
|
93
|
+
warnMissingContract(name);
|
|
69
94
|
const files = manifest.files.map((relative) => ({
|
|
70
95
|
target: relative,
|
|
71
96
|
source: node_path_1.default.join(root, name, relative),
|
|
72
97
|
}));
|
|
73
|
-
return { manifest, files };
|
|
98
|
+
return { manifest: { ...manifest, contract: (0, contract_1.validateManifestContract)(manifest) }, files };
|
|
74
99
|
}
|
|
75
100
|
async function resolveInstallSet(root, names) {
|
|
76
101
|
const ordered = [];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/registry/store.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/registry/store.ts"],"names":[],"mappings":";;;;;AA6CA,sDAYC;AAGD,kDAEC;AAoBD,4BAoCC;AAMD,8CA+BC;AA3JD,gEAAkC;AAClC,0DAA6B;AAC7B,yCAAmC;AAEnC,6CAA2C;AAC3C,yCAA2E;AAU3E,KAAK,UAAU,YAAY,CAAC,IAAY,EAAE,IAAY;IACpD,MAAM,GAAG,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1E,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAyC,CAAC;AACjE,CAAC;AAGD,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,CAAC,IAAI,CAAC,IAAA,kBAAM,EAAC,kBAAkB,IAAI,uEAAuE,CAAC,CAAC,CAAC;AACtH,CAAC;AAMD,KAAK,UAAU,iBAAiB,CAC9B,IAAY,EACZ,IAAY,EACZ,IAAuB;IAEvB,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACtE,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACzE,MAAM,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;IACH,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,IAAA,8BAAmB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACpD,CAAC;AAGM,KAAK,UAAU,qBAAqB,CAAC,IAAY;IACtD,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAAE,SAAS;QACnC,MAAM,OAAO,GAAG,MAAM,kBAAE;aACrB,MAAM,CAAC,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;aAChD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;aAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACtB,IAAI,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;AACtB,CAAC;AAGM,KAAK,UAAU,mBAAmB,CAAC,IAAiC;IACzE,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,SAAS,OAAO,CAAC,IAA0C;IACzD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AACjG,CAAC;AAMD,SAAS,2BAA2B,CAAC,QAAgB,EAAE,MAAc;IACnE,IAAI,CAAC,MAAM,IAAI,mBAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,kBAAQ,CAChB,kBAAkB,QAAQ,qCAAqC,MAAM,KAAK;YACxE,uDAAuD,CAC1D,CAAC;IACJ,CAAC;AACH,CAAC;AAGM,KAAK,UAAU,QAAQ,CAAC,IAAY,EAAE,IAAY;IACvD,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAE5C,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;YAAE,2BAA2B,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,QAAQ,KAAK,SAAS;YAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACtD,OAAO;YACL,QAAQ,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;gBAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,KAAK,EAAE,OAAO;gBACd,QAAQ,EACN,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,mCAAwB,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;aAC9G;YACD,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC5B,MAAM,EAAE,CAAC,CAAC,IAAI;gBACd,OAAO,EAAE,CAAC,CAAC,OAAO;aACnB,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC;IACtB,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,KAAK;QAAE,2BAA2B,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnF,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS;QAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC9C,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC;KACxC,CAAC,CAAC,CAAC;IACJ,OAAO,EAAE,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,IAAA,mCAAwB,EAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAC5F,CAAC;AAMM,KAAK,UAAU,iBAAiB,CAAC,IAAY,EAAE,KAAe;IACnE,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAEnC,KAAK,UAAU,KAAK,CAAC,IAAY;QAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO;QAC3B,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,kBAAQ,CAAC,2CAA2C,IAAI,IAAI,CAAC,CAAC;QAC1E,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YAGjE,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACvD,MAAM,IAAI,kBAAQ,CAAC,kBAAkB,IAAI,iEAAiE,CAAC,CAAC;YAC9G,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QACH,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,oBAAoB,IAAI,EAAE,EAAE,CAAC;YAC7D,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;QACD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
|
package/dist/registry/types.d.ts
CHANGED
|
@@ -7,6 +7,16 @@ export interface RegistryFileEntry {
|
|
|
7
7
|
content: string;
|
|
8
8
|
type: RegistryItemType;
|
|
9
9
|
}
|
|
10
|
+
export type ModuleState = "loading" | "error" | "empty" | "success" | "ready";
|
|
11
|
+
export interface ModuleContract {
|
|
12
|
+
version: string;
|
|
13
|
+
framework: string;
|
|
14
|
+
entry: string;
|
|
15
|
+
labels: string[];
|
|
16
|
+
ports: string[];
|
|
17
|
+
ui: string[];
|
|
18
|
+
states: ModuleState[];
|
|
19
|
+
}
|
|
10
20
|
export interface RegistryManifest {
|
|
11
21
|
name: string;
|
|
12
22
|
type: RegistryItemType;
|
|
@@ -16,6 +26,7 @@ export interface RegistryManifest {
|
|
|
16
26
|
registryDependencies?: string[];
|
|
17
27
|
files: string[];
|
|
18
28
|
postInstall?: string;
|
|
29
|
+
contract?: ModuleContract;
|
|
19
30
|
}
|
|
20
31
|
export interface BuiltRegistryItem {
|
|
21
32
|
$schema: string;
|
|
@@ -27,4 +38,5 @@ export interface BuiltRegistryItem {
|
|
|
27
38
|
registryDependencies?: string[];
|
|
28
39
|
files: RegistryFileEntry[];
|
|
29
40
|
postInstall?: string;
|
|
41
|
+
"x-fewbie.contract"?: ModuleContract;
|
|
30
42
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devbie/fewbie-cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.8.0",
|
|
4
4
|
"description": "fewbie frontend framework CLI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "worldzhy",
|
|
@@ -31,10 +31,12 @@
|
|
|
31
31
|
"@devbie/cli-kit": "^1.0.0",
|
|
32
32
|
"@inquirer/prompts": "^7.5.0",
|
|
33
33
|
"colorette": "^2.0.20",
|
|
34
|
-
"commander": "^12.1.0"
|
|
34
|
+
"commander": "^12.1.0",
|
|
35
|
+
"semver": "^7.8.6"
|
|
35
36
|
},
|
|
36
37
|
"devDependencies": {
|
|
37
38
|
"@types/node": "^22.0.0",
|
|
39
|
+
"@types/semver": "^7.8.0",
|
|
38
40
|
"rimraf": "^6.1.4",
|
|
39
41
|
"tsx": "^4.19.0",
|
|
40
42
|
"typescript": "^5.9.3"
|