qgis-sdk 0.5.0 → 0.6.0

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.
Files changed (2) hide show
  1. package/README.md +10 -14
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,17 +1,13 @@
1
1
  # @archont561/qgis-sdk
2
2
 
3
- **The TypeScript SDK for QGIS plugin interfaces hosted in `QWebEngineView`:
4
- one typed object over the plugin's own declarations.**
5
-
6
- The page side of [`qgis-sdk`](https://pypi.org/project/qgis-sdk/). A page
7
- builds `QgisSdk` from the schema `qgis-sdk bridge generate` renders from the
8
- plugin's Python declarations and gets one typed method per action and
9
- stream, the curated host namespaces (`layers`, `project`, `files`,
10
- `algorithms`, ...), framework-free stores and React, Vue and Svelte
11
- bindings over them, and a scripted harness for tests. Every exported error
12
- begins with `QgisSdk` and carries a stable wire `code`.
13
-
14
- > Status: `0.5.0`, experimental `0.x`. Published as
3
+ **Bring typed QGIS plugin actions to your web UI.**
4
+
5
+ Build a `QgisSdk` client from your Python plugin's generated schema, call
6
+ its actions and streams, and use granted host services. Framework-free stores
7
+ and React, Vue and Svelte bindings help build interfaces in `QWebEngineView`;
8
+ a scripted host lets you test them without QGIS.
9
+
10
+ > Status: `0.6.0`, experimental `0.x`. Published as
15
11
  > `@archont561/qgis-sdk-bridge` through `0.2.0`; this name continues from
16
12
  > `0.3.0`, and `qgis-sdk` on npm is its unscoped alias. `./host`, `./react`,
17
13
  > `./vue`, `./svelte` and `./testing` are opt-in entry points.
@@ -44,13 +40,13 @@ composables and the Svelte stores; `./testing` scripts a host without QGIS.
44
40
 
45
41
  ## Documentation
46
42
 
47
- - [TypeScript package guide](https://github.com/Archont561/qgis-sdk/blob/main/backlog/docs/guides/doc-13%20-%20qgis-sdk-TypeScript-package-guide.md) -
43
+ - [TypeScript package guide](https://archont561.github.io/qgis-sdk/typescript/) -
48
44
  exports, `QgisSdk`, the transport client, host namespaces, streams, the
49
45
  stores, the React, Vue and Svelte bindings, Processing from a page and
50
46
  testing against a scripted host.
51
47
  - [`@archont561/qgis-sdk-ui`](https://github.com/Archont561/qgis-sdk/tree/main/packages/qgis-sdk-ui) -
52
48
  the web components on these stores.
53
- - [Python package guide](https://github.com/Archont561/qgis-sdk/blob/main/backlog/docs/guides/doc-12%20-%20qgis-sdk-Python-package-guide.md) -
49
+ - [Python package guide](https://archont561.github.io/qgis-sdk/python/) -
54
50
  the host half of every surface above.
55
51
 
56
52
  ## License
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "qgis-sdk",
3
- "version": "0.5.0",
4
- "description": "Unscoped alias of @archont561/qgis-sdk, the TypeScript SDK for QGIS plugin interfaces hosted in QWebEngineView.",
3
+ "version": "0.6.0",
4
+ "description": "Typed QGIS plugin actions for your web UI. Alias of @archont561/qgis-sdk.",
5
5
  "license": "MIT",
6
6
  "type": "module",
7
7
  "main": "./index.js",
@@ -61,7 +61,7 @@
61
61
  "test": "bun test"
62
62
  },
63
63
  "dependencies": {
64
- "@archont561/qgis-sdk": "0.5.0"
64
+ "@archont561/qgis-sdk": "0.6.0"
65
65
  },
66
66
  "peerDependencies": {
67
67
  "react": ">=18",