@kadanza/extension-sdk 0.0.5 → 0.0.6
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 +22 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,56 +1,47 @@
|
|
|
1
1
|
# @kadanza/extension-sdk
|
|
2
2
|
|
|
3
|
-
Helpers for building Kadanza extensions
|
|
3
|
+
Helpers for building Kadanza extensions
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Get started
|
|
6
|
+
|
|
7
|
+
### Install
|
|
6
8
|
|
|
7
9
|
```bash
|
|
8
10
|
npm install @kadanza/extension-sdk
|
|
9
11
|
```
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
### ESM
|
|
13
|
+
### Usage
|
|
14
14
|
|
|
15
15
|
```ts
|
|
16
|
+
// For ESM
|
|
16
17
|
import { createExtensionSDK, type IExtensionSDK } from "@kadanza/extension-sdk";
|
|
18
|
+
// For CommonJS
|
|
19
|
+
// const { createExtensionSDK } = require("@kadanza/extension-sdk");
|
|
17
20
|
|
|
18
21
|
const sdk: IExtensionSDK = createExtensionSDK();
|
|
19
22
|
|
|
23
|
+
// Handshake flow
|
|
20
24
|
const { authToken, extensionDetails, designTokens } = await sdk.connect();
|
|
21
|
-
|
|
22
|
-
sdk.onLoadPageSettings((settings) => {
|
|
23
|
-
// open settings UI with values from parent
|
|
24
|
-
console.log(settings);
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
const refreshed = await sdk.requestTokenRefresh();
|
|
28
|
-
console.log(refreshed.jwt);
|
|
29
|
-
|
|
30
|
-
await sdk.updatePageSettings({ setting1: 123 });
|
|
31
25
|
```
|
|
32
26
|
|
|
33
|
-
|
|
27
|
+
Check [Flows.md](/docs/flows.md) for all available flows.
|
|
34
28
|
|
|
35
|
-
|
|
36
|
-
const { createExtensionSDK } = require("@kadanza/extension-sdk");
|
|
29
|
+
## Documentation
|
|
37
30
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
sdk.connect().then(({ authToken }) => {
|
|
41
|
-
console.log(authToken.jwt);
|
|
42
|
-
});
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## API reference
|
|
46
|
-
|
|
47
|
-
Published docs: [GitHub Pages](https://kadanza-io.github.io/extension-sdk/)
|
|
31
|
+
- [Documentation folder](docs/) — This is were the important information is stored
|
|
32
|
+
- [API reference](https://kadanza-io.github.io/extension-sdk/) — TypeDoc generated documentation describing all the small details, classes, interfaces, payloads...
|
|
48
33
|
|
|
49
34
|
## Local development
|
|
50
35
|
|
|
51
36
|
```bash
|
|
52
37
|
npm install
|
|
53
|
-
npm run dev # Serve a playground/ setup. Use its URL for embedding in the main app
|
|
54
|
-
npm run build # emit dist/ (ESM + CJS + types)
|
|
55
|
-
npm run docs # generate HTML API docs under docs/api/
|
|
56
38
|
```
|
|
39
|
+
|
|
40
|
+
| Command | Description |
|
|
41
|
+
| --------------------- | ---------------------------------------------------- |
|
|
42
|
+
| `npm run dev` | Serve the playground for embedding in the parent app |
|
|
43
|
+
| `npm run build` | Emit `dist/` (ESM + CJS + types) |
|
|
44
|
+
| `npm run preview` | Preview the production playground build |
|
|
45
|
+
| `npm run docs` | Generate HTML API docs under `docs/api/` |
|
|
46
|
+
| `npm run docs:check` | Validate TypeDoc without writing output |
|
|
47
|
+
| `npm run check:types` | Check published package types with arethetypeswrong |
|