@waler/sdk 0.1.1 → 0.1.2

package/README.md

@@ -197,6 +197,33 @@ globals it does not own inside your app.
 Everything is typed. `ReadyPayload`, `ShellContext`, `SdkError`, `Capability`,
 `SdkEventMap` and the rest are exported from the package root.
 
+## Versioning and compatibility
+
+This package follows semver. A breaking change is a major, and what it replaces
+is deprecated first: the old member keeps working and the docs say what to use
+instead, until the major removes it. Pin what you install and upgrade when it
+suits you.
+
+That covers the package. It does not cover the shell, and the difference is the
+one thing worth understanding here.
+
+**Your app does not choose which shell loads it.** The shell is an installed
+application that may be older than your app, and several ages of it are in use at
+the same time. So a version comparison cannot help you — the shell is not a
+dependency you picked, it is the thing you are running inside of.
+
+Ask what it can do, never how old it is:
+
+```ts
+if (Waler.capabilities.has('scanBarcode')) await Waler.scanBarcode()
+else showManualEntryField()
+```
+
+The bridge is built so that this always has an answer. A method the shell does
+not know rejects with `UNSUPPORTED` instead of hanging, and an error code this
+package does not know reaches your `catch` unchanged. Neither is a promise about
+a period of time; both are how the bridge behaves, in every version.
+
 ## Requirements
 
 Any browser the shell supports. Node 20+ if you import it in a build step.

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** Kept in step with package.json by `pnpm version-packages`. */
-export declare const SDK_VERSION = "0.1.1";
+export declare const SDK_VERSION = "0.1.2";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** Kept in step with package.json by `pnpm version-packages`. */
-export const SDK_VERSION = '0.1.1';
+export const SDK_VERSION = '0.1.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waler/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "The surface a Waler app talks to the shell through.",
   "license": "MIT",
   "keywords": [
@@ -61,6 +61,7 @@
     "check:origins": "pnpm build && node tools/origin-check/serve.ts",
     "check:package": "pnpm build && publint && attw --pack . --profile esm-only",
     "verify:tarball": "node tools/verify-tarball.ts",
+    "check:changeset": "node tools/check-changeset.ts",
     "changeset": "changeset",
     "version-packages": "changeset version && node tools/sync-version.ts && prettier --write package.json CHANGELOG.md src/version.ts",
     "release": "pnpm check:package && changeset publish"