@kadanza/extension-sdk 0.0.10 → 0.0.11
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 +6 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,8 +10,9 @@ Fill in `<APP_NAME>` and `<EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_
|
|
|
10
10
|
> It is a React + Vite + TypeScript app that uses @kadanza/extension-sdk and runs embedded in Kadanza.
|
|
11
11
|
>
|
|
12
12
|
> Before writing code, read and follow these sources of truth:
|
|
13
|
+
>
|
|
13
14
|
> - How the host embeds you: https://github.com/kadanza-io/extension-sdk/blob/main/docs/embedding.md
|
|
14
|
-
> - React setup and wiring: https://github.com/kadanza-io/extension-sdk/blob/main/docs/react.md
|
|
15
|
+
> - React setup and wiring: https://github.com/kadanza-io/extension-sdk/blob/main/docs/react-guide.md
|
|
15
16
|
> - SDK flows you must support: https://github.com/kadanza-io/extension-sdk/blob/main/docs/flows.md
|
|
16
17
|
>
|
|
17
18
|
> Do not invent your own host communication, handshake, or API auth. Prefer the patterns and APIs described in those docs over improvising.
|
|
@@ -20,8 +21,9 @@ Fill in `<APP_NAME>` and `<EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_
|
|
|
20
21
|
> <EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_REQUIREMENTS_HERE>
|
|
21
22
|
>
|
|
22
23
|
> When done, verify against the docs:
|
|
24
|
+
>
|
|
23
25
|
> - Embedding constraints in embedding.md are respected
|
|
24
|
-
> - Structure matches react.md
|
|
26
|
+
> - Structure matches react-guide.md
|
|
25
27
|
> - Required flows from flows.md are implemented
|
|
26
28
|
> - The app requirements above are covered
|
|
27
29
|
|
|
@@ -49,13 +51,13 @@ const { authToken, extensionDetails, designTokens } = await sdk.connect();
|
|
|
49
51
|
|
|
50
52
|
Create and use the SDK once per app. Later `createExtensionSDK()` calls return the same instance.
|
|
51
53
|
|
|
52
|
-
Check [Flows.md](/docs/flows.md) for all available flows. Building with React? See [Building a React extension](/docs/react.md).
|
|
54
|
+
Check [Flows.md](/docs/flows.md) for all available flows. Building with React? See [Building a React extension](/docs/react-guide.md).
|
|
53
55
|
|
|
54
56
|
## Documentation
|
|
55
57
|
|
|
56
58
|
- [Documentation folder](docs/) — This is were the important information is stored
|
|
57
59
|
- [How Kadanza embeds an extension](docs/embedding.md) — Host iframe, allowed origins, and `tenantUrl`
|
|
58
|
-
- [Building a React extension](docs/react.md) — Bootstrap
|
|
60
|
+
- [Building a React extension](docs/react-guide.md) — Bootstrap a React app with the Extension SDK
|
|
59
61
|
- [API reference](https://kadanza-io.github.io/extension-sdk/) — TypeDoc generated documentation describing all the small details, classes, interfaces, payloads...
|
|
60
62
|
|
|
61
63
|
## Local development
|