qgis-sdk 0.4.0 → 0.5.0

package/README.md

@@ -1,32 +1,57 @@
-# qgis-sdk (npm)
+# @archont561/qgis-sdk
 
-**Unscoped alias of [`@archont561/qgis-sdk`](https://www.npmjs.com/package/@archont561/qgis-sdk).**
+**The TypeScript SDK for QGIS plugin interfaces hosted in `QWebEngineView`:
+one typed object over the plugin's own declarations.**
 
-Every entry point re-exports the scoped package at the exact same version:
-`qgis-sdk`, `qgis-sdk/bridge`, `qgis-sdk/host`, `qgis-sdk/react` and
-`qgis-sdk/testing`. There is no code of its own; pick whichever name reads
-better in your project. The Python package of the same name is on
-[PyPI](https://pypi.org/project/qgis-sdk/).
+The page side of [`qgis-sdk`](https://pypi.org/project/qgis-sdk/). A page
+builds `QgisSdk` from the schema `qgis-sdk bridge generate` renders from the
+plugin's Python declarations and gets one typed method per action and
+stream, the curated host namespaces (`layers`, `project`, `files`,
+`algorithms`, ...), framework-free stores and React, Vue and Svelte
+bindings over them, and a scripted harness for tests. Every exported error
+begins with `QgisSdk` and carries a stable wire `code`.
+
+> Status: `0.5.0`, experimental `0.x`. Published as
+> `@archont561/qgis-sdk-bridge` through `0.2.0`; this name continues from
+> `0.3.0`, and `qgis-sdk` on npm is its unscoped alias. `./host`, `./react`,
+> `./vue`, `./svelte` and `./testing` are opt-in entry points.
 
 ## Installation
 
 ```sh
-bun add qgis-sdk
-npm install qgis-sdk
+bun add @archont561/qgis-sdk        # or its unscoped alias: bun add qgis-sdk
+npm install @archont561/qgis-sdk    # or: npm install qgis-sdk
 ```
 
+`qgis-sdk` on npm re-exports every entry point of `@archont561/qgis-sdk`
+at the same version; the two names share this README.
+
 ## Example
 
 ```ts
-import { BridgeClient } from "qgis-sdk/bridge";
-import { createHost } from "qgis-sdk/host";
+import { QgisSdk, formStore } from "@archont561/qgis-sdk";
+import schema from "./bridge.schema"; // qgis-sdk bridge generate
+
+const qgis = QgisSdk.fromBridgeSchema(schema);
+const buffered = await qgis.buffer({ layer_id, distance: 25 }); // typed by the schema
+const layers = await qgis.host.layers.list({ limit: 20 });        // a granted host namespace
+
+const form = formStore(qgis, "buffer"); // fields from the action's schema; drives <qgis-form>
 ```
 
+The same stores back `useForm`/`useOperation` in `./react`, the Vue
+composables and the Svelte stores; `./testing` scripts a host without QGIS.
+
 ## Documentation
 
 - [TypeScript package guide](https://github.com/Archont561/qgis-sdk/blob/main/backlog/docs/guides/doc-13%20-%20qgis-sdk-TypeScript-package-guide.md) -
-  exports, the transport client, host namespaces, generated clients, streams,
-  the React bindings and testing against a scripted host.
+  exports, `QgisSdk`, the transport client, host namespaces, streams, the
+  stores, the React, Vue and Svelte bindings, Processing from a page and
+  testing against a scripted host.
+- [`@archont561/qgis-sdk-ui`](https://github.com/Archont561/qgis-sdk/tree/main/packages/qgis-sdk-ui) -
+  the web components on these stores.
+- [Python package guide](https://github.com/Archont561/qgis-sdk/blob/main/backlog/docs/guides/doc-12%20-%20qgis-sdk-Python-package-guide.md) -
+  the host half of every surface above.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "qgis-sdk",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Unscoped alias of @archont561/qgis-sdk, the TypeScript SDK for QGIS plugin interfaces hosted in QWebEngineView.",
 	"license": "MIT",
 	"type": "module",
@@ -27,6 +27,16 @@
 			"import": "./react.js",
 			"default": "./react.js"
 		},
+		"./vue": {
+			"types": "./vue.d.ts",
+			"import": "./vue.js",
+			"default": "./vue.js"
+		},
+		"./svelte": {
+			"types": "./svelte.d.ts",
+			"import": "./svelte.js",
+			"default": "./svelte.js"
+		},
 		"./testing": {
 			"types": "./testing.d.ts",
 			"import": "./testing.js",
@@ -51,14 +61,22 @@
 		"test": "bun test"
 	},
 	"dependencies": {
-		"@archont561/qgis-sdk": "0.4.0"
+		"@archont561/qgis-sdk": "0.5.0"
 	},
 	"peerDependencies": {
-		"react": ">=18"
+		"react": ">=18",
+		"svelte": ">=5",
+		"vue": ">=3.4"
 	},
 	"peerDependenciesMeta": {
 		"react": {
 			"optional": true
+		},
+		"svelte": {
+			"optional": true
+		},
+		"vue": {
+			"optional": true
 		}
 	}
 }

package/svelte.d.ts

@@ -0,0 +1 @@
+export * from "@archont561/qgis-sdk/svelte";

package/svelte.js

@@ -0,0 +1 @@
+export * from "@archont561/qgis-sdk/svelte";

package/vue.d.ts

@@ -0,0 +1 @@
+export * from "@archont561/qgis-sdk/vue";

package/vue.js

@@ -0,0 +1 @@
+export * from "@archont561/qgis-sdk/vue";