@kadanza/extension-sdk 0.0.11 → 0.0.13
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/README.md +21 -8
- package/package.json +12 -1
package/README.md
CHANGED
|
@@ -32,9 +32,18 @@ Fill in `<APP_NAME>` and `<EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_
|
|
|
32
32
|
### Install
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
+
# Stable
|
|
35
36
|
npm install @kadanza/extension-sdk
|
|
37
|
+
|
|
38
|
+
# RC (shared testing channel on main)
|
|
39
|
+
npm install @kadanza/extension-sdk@rc
|
|
40
|
+
|
|
41
|
+
# Canary (feature-branch preview — see releasing docs)
|
|
42
|
+
npm install @kadanza/extension-sdk@canary
|
|
36
43
|
```
|
|
37
44
|
|
|
45
|
+
How we version and publish: [Releasing](docs/releasing.md).
|
|
46
|
+
|
|
38
47
|
### Usage
|
|
39
48
|
|
|
40
49
|
```ts
|
|
@@ -58,6 +67,7 @@ Check [Flows.md](/docs/flows.md) for all available flows. Building with React? S
|
|
|
58
67
|
- [Documentation folder](docs/) — This is were the important information is stored
|
|
59
68
|
- [How Kadanza embeds an extension](docs/embedding.md) — Host iframe, allowed origins, and `tenantUrl`
|
|
60
69
|
- [Building a React extension](docs/react-guide.md) — Bootstrap a React app with the Extension SDK
|
|
70
|
+
- [Releasing](docs/releasing.md) — Changesets, stable and RC publishes
|
|
61
71
|
- [API reference](https://kadanza-io.github.io/extension-sdk/) — TypeDoc generated documentation describing all the small details, classes, interfaces, payloads...
|
|
62
72
|
|
|
63
73
|
## Local development
|
|
@@ -66,14 +76,17 @@ Check [Flows.md](/docs/flows.md) for all available flows. Building with React? S
|
|
|
66
76
|
npm install
|
|
67
77
|
```
|
|
68
78
|
|
|
69
|
-
| Command
|
|
70
|
-
|
|
|
71
|
-
| `npm run dev`
|
|
72
|
-
| `npm run build`
|
|
73
|
-
| `npm run preview`
|
|
74
|
-
| `npm run docs`
|
|
75
|
-
| `npm run docs:check`
|
|
76
|
-
| `npm run check:types`
|
|
79
|
+
| Command | Description |
|
|
80
|
+
| ------------------------- | ---------------------------------------------------- |
|
|
81
|
+
| `npm run dev` | Serve the playground for embedding in the parent app |
|
|
82
|
+
| `npm run build` | Emit `dist/` (ESM + CJS + types) |
|
|
83
|
+
| `npm run preview` | Preview the production playground build |
|
|
84
|
+
| `npm run docs` | Generate HTML API docs under `docs/api/` |
|
|
85
|
+
| `npm run docs:check` | Validate TypeDoc without writing output |
|
|
86
|
+
| `npm run check:types` | Check published package types with arethetypeswrong |
|
|
87
|
+
| `npm run changeset` | Add a changeset for the next release |
|
|
88
|
+
| `npm run release:rc:enter`| Enter RC prerelease mode on `main` |
|
|
89
|
+
| `npm run release:rc:exit` | Exit RC prerelease mode |
|
|
77
90
|
|
|
78
91
|
`npm run dev` serves the playground at `https://localhost:5000` (accept the
|
|
79
92
|
self-signed certificate warning once). Use this HTTPS origin for the parent
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kadanza/extension-sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.13",
|
|
4
4
|
"description": "Helpers for building extensions",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"kadanza",
|
|
@@ -36,6 +36,9 @@
|
|
|
36
36
|
"files": [
|
|
37
37
|
"dist"
|
|
38
38
|
],
|
|
39
|
+
"publishConfig": {
|
|
40
|
+
"access": "public"
|
|
41
|
+
},
|
|
39
42
|
"scripts": {
|
|
40
43
|
"dev": "vite",
|
|
41
44
|
"build": "tsc -p tsconfig.lib.json --noEmit && vite build",
|
|
@@ -43,9 +46,17 @@
|
|
|
43
46
|
"docs": "typedoc",
|
|
44
47
|
"docs:check": "typedoc --emit none",
|
|
45
48
|
"check:types": "npx --yes @arethetypeswrong/cli --pack .",
|
|
49
|
+
"changeset": "changeset",
|
|
50
|
+
"version-packages": "changeset version",
|
|
51
|
+
"version-packages:snapshot": "changeset version --snapshot canary",
|
|
52
|
+
"release": "changeset publish",
|
|
53
|
+
"release:canary": "changeset publish --tag canary --no-git-tag",
|
|
54
|
+
"release:rc:enter": "changeset pre enter rc && node scripts/sync-rc-banner.mjs enter",
|
|
55
|
+
"release:rc:exit": "changeset pre exit && node scripts/sync-rc-banner.mjs exit",
|
|
46
56
|
"prepublishOnly": "npm run build && npm run check:types"
|
|
47
57
|
},
|
|
48
58
|
"devDependencies": {
|
|
59
|
+
"@changesets/cli": "^2.31.1",
|
|
49
60
|
"@vitejs/plugin-basic-ssl": "^2.3.0",
|
|
50
61
|
"typedoc": "^0.28.20",
|
|
51
62
|
"typescript": "~6.0.2",
|