@kadanza/extension-sdk 0.0.10 → 0.0.13

package/README.md

@@ -10,8 +10,9 @@ Fill in `<APP_NAME>` and `<EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_
 > It is a React + Vite + TypeScript app that uses @kadanza/extension-sdk and runs embedded in Kadanza.
 >
 > Before writing code, read and follow these sources of truth:
+>
 > - How the host embeds you: https://github.com/kadanza-io/extension-sdk/blob/main/docs/embedding.md
-> - React setup and wiring: https://github.com/kadanza-io/extension-sdk/blob/main/docs/react.md
+> - React setup and wiring: https://github.com/kadanza-io/extension-sdk/blob/main/docs/react-guide.md
 > - SDK flows you must support: https://github.com/kadanza-io/extension-sdk/blob/main/docs/flows.md
 >
 > 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_
 > <EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_REQUIREMENTS_HERE>
 >
 > When done, verify against the docs:
+>
 > - Embedding constraints in embedding.md are respected
-> - Structure matches react.md
+> - Structure matches react-guide.md
 > - Required flows from flows.md are implemented
 > - The app requirements above are covered
 
@@ -30,9 +32,18 @@ Fill in `<APP_NAME>` and `<EXTENSION_BUILDERS_DESCRIBE_THEIR_ADDITIONAL_FEATURE_
 ### Install
 
 ```bash
+# Stable
 npm install @kadanza/extension-sdk
+
+# RC (shared testing channel on main)
+npm install @kadanza/extension-sdk@rc
+
+# Canary (feature-branch preview — see releasing docs)
+npm install @kadanza/extension-sdk@canary
 ```
 
+How we version and publish: [Releasing](docs/releasing.md).
+
 ### Usage
 
 ```ts
@@ -49,13 +60,14 @@ const { authToken, extensionDetails, designTokens } = await sdk.connect();
 
 Create and use the SDK once per app. Later `createExtensionSDK()` calls return the same instance.
 
-Check [Flows.md](/docs/flows.md) for all available flows. Building with React? See [Building a React extension](/docs/react.md).
+Check [Flows.md](/docs/flows.md) for all available flows. Building with React? See [Building a React extension](/docs/react-guide.md).
 
 ## Documentation
 
 - [Documentation folder](docs/) — This is were the important information is stored
 - [How Kadanza embeds an extension](docs/embedding.md) — Host iframe, allowed origins, and `tenantUrl`
-- [Building a React extension](docs/react.md) — Bootstrap the SDK in a React app
+- [Building a React extension](docs/react-guide.md) — Bootstrap a React app with the Extension SDK
+- [Releasing](docs/releasing.md) — Changesets, stable and RC publishes
 - [API reference](https://kadanza-io.github.io/extension-sdk/) — TypeDoc generated documentation describing all the small details, classes, interfaces, payloads...
 
 ## Local development
@@ -64,14 +76,17 @@ Check [Flows.md](/docs/flows.md) for all available flows. Building with React? S
 npm install
 ```
 
-| Command               | Description                                          |
-| --------------------- | ---------------------------------------------------- |
-| `npm run dev`         | Serve the playground for embedding in the parent app |
-| `npm run build`       | Emit `dist/` (ESM + CJS + types)                     |
-| `npm run preview`     | Preview the production playground build              |
-| `npm run docs`        | Generate HTML API docs under `docs/api/`             |
-| `npm run docs:check`  | Validate TypeDoc without writing output              |
-| `npm run check:types` | Check published package types with arethetypeswrong  |
+| Command                   | Description                                          |
+| ------------------------- | ---------------------------------------------------- |
+| `npm run dev`             | Serve the playground for embedding in the parent app |
+| `npm run build`           | Emit `dist/` (ESM + CJS + types)                     |
+| `npm run preview`         | Preview the production playground build              |
+| `npm run docs`            | Generate HTML API docs under `docs/api/`             |
+| `npm run docs:check`      | Validate TypeDoc without writing output              |
+| `npm run check:types`     | Check published package types with arethetypeswrong  |
+| `npm run changeset`       | Add a changeset for the next release                 |
+| `npm run release:rc:enter`| Enter RC prerelease mode on `main`                   |
+| `npm run release:rc:exit` | Exit RC prerelease mode                              |
 
 `npm run dev` serves the playground at `https://localhost:5000` (accept the
 self-signed certificate warning once). Use this HTTPS origin for the parent

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kadanza/extension-sdk",
-  "version": "0.0.10",
+  "version": "0.0.13",
   "description": "Helpers for building extensions",
   "keywords": [
     "kadanza",
@@ -36,6 +36,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc -p tsconfig.lib.json --noEmit && vite build",
@@ -43,9 +46,17 @@
     "docs": "typedoc",
     "docs:check": "typedoc --emit none",
     "check:types": "npx --yes @arethetypeswrong/cli --pack .",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "version-packages:snapshot": "changeset version --snapshot canary",
+    "release": "changeset publish",
+    "release:canary": "changeset publish --tag canary --no-git-tag",
+    "release:rc:enter": "changeset pre enter rc && node scripts/sync-rc-banner.mjs enter",
+    "release:rc:exit": "changeset pre exit && node scripts/sync-rc-banner.mjs exit",
     "prepublishOnly": "npm run build && npm run check:types"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.31.1",
     "@vitejs/plugin-basic-ssl": "^2.3.0",
     "typedoc": "^0.28.20",
     "typescript": "~6.0.2",