@mercury-fw/kit 0.25.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/CHANGELOG.md +8 -0
- package/README.md +7 -0
- package/dist/index.d.ts +17 -0
- package/index.ts +17 -0
- package/package.json +38 -0
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# @mercury-fw/kit
|
|
2
|
+
|
|
3
|
+
What a [Mercury](https://github.com/lucabro81/mercury-fw) plugin author imports: the contract a tool plugin implements (`Plugin`, `PLUGIN_API_VERSION` and the types around them) and the one a channel implements (`ChannelPlugin`, `CHANNEL_API_VERSION`), in one place. It carries no runtime, so a plugin that depends on it doesn't pull the framework in.
|
|
4
|
+
|
|
5
|
+
A proper workflow for writing plugins, with an SDK on top of these contracts, is planned ([#27](https://github.com/lucabro81/mercury-fw/issues/27)).
|
|
6
|
+
|
|
7
|
+
MIT
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The plugin-authoring surface — one entry a plugin author imports from, instead
|
|
3
|
+
* of reaching into the individual contract packages. It re-exports the two
|
|
4
|
+
* contracts a plugin is written against: the tool-plugin contract
|
|
5
|
+
* (`@mercury-fw/plugin-types`) and the channel-plugin contract
|
|
6
|
+
* (`@mercury-fw/channel-types`).
|
|
7
|
+
*
|
|
8
|
+
* This is Mercury's `@nuxt/kit` equivalent, deliberately thin for now: today it
|
|
9
|
+
* is a pure re-export of the contracts. The richer plugin-tool SDK (#27) — the
|
|
10
|
+
* helpers for building a tool without hand-wiring the runtime context — will
|
|
11
|
+
* land here, so authors depend on one stable entry as it grows.
|
|
12
|
+
*
|
|
13
|
+
* Split of concern: `@mercury-fw/core` is what an *app* consumes to run an
|
|
14
|
+
* instance; `@mercury-fw/kit` is what a plugin *author* consumes to write one.
|
|
15
|
+
*/
|
|
16
|
+
export * from "@mercury-fw/plugin-types";
|
|
17
|
+
export * from "@mercury-fw/channel-types";
|
package/index.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The plugin-authoring surface — one entry a plugin author imports from, instead
|
|
3
|
+
* of reaching into the individual contract packages. It re-exports the two
|
|
4
|
+
* contracts a plugin is written against: the tool-plugin contract
|
|
5
|
+
* (`@mercury-fw/plugin-types`) and the channel-plugin contract
|
|
6
|
+
* (`@mercury-fw/channel-types`).
|
|
7
|
+
*
|
|
8
|
+
* This is Mercury's `@nuxt/kit` equivalent, deliberately thin for now: today it
|
|
9
|
+
* is a pure re-export of the contracts. The richer plugin-tool SDK (#27) — the
|
|
10
|
+
* helpers for building a tool without hand-wiring the runtime context — will
|
|
11
|
+
* land here, so authors depend on one stable entry as it grows.
|
|
12
|
+
*
|
|
13
|
+
* Split of concern: `@mercury-fw/core` is what an *app* consumes to run an
|
|
14
|
+
* instance; `@mercury-fw/kit` is what a plugin *author* consumes to write one.
|
|
15
|
+
*/
|
|
16
|
+
export * from "@mercury-fw/plugin-types";
|
|
17
|
+
export * from "@mercury-fw/channel-types";
|
package/package.json
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@mercury-fw/kit",
|
|
3
|
+
"version": "0.25.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/lucabro81/mercury-fw.git",
|
|
9
|
+
"directory": "packages/libs/kit"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"*.ts",
|
|
13
|
+
"dist",
|
|
14
|
+
"CHANGELOG.md"
|
|
15
|
+
],
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public"
|
|
18
|
+
},
|
|
19
|
+
"exports": {
|
|
20
|
+
".": {
|
|
21
|
+
"mercury-fw-source": "./index.ts",
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"default": "./index.ts"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"typecheck": "tsc --noEmit"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@mercury-fw/channel-types": "0.25.0",
|
|
31
|
+
"@mercury-fw/plugin-types": "0.25.0"
|
|
32
|
+
},
|
|
33
|
+
"devDependencies": {
|
|
34
|
+
"@mercury-fw/typescript-config": "*",
|
|
35
|
+
"@types/bun": "^1.4.0",
|
|
36
|
+
"typescript": "^6.0.3"
|
|
37
|
+
}
|
|
38
|
+
}
|