qgis-sdk 0.0.0 → 0.4.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.
- package/LICENSE +21 -0
- package/README.md +23 -35
- package/bridge.d.ts +1 -0
- package/bridge.js +1 -0
- package/host.d.ts +1 -0
- package/host.js +1 -0
- package/index.d.ts +1 -0
- package/index.js +1 -0
- package/package.json +62 -8
- package/react.d.ts +1 -0
- package/react.js +1 -0
- package/testing.d.ts +1 -0
- package/testing.js +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 QGIS SDK contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,45 +1,33 @@
|
|
|
1
|
-
# qgis-sdk
|
|
1
|
+
# qgis-sdk (npm)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Unscoped alias of [`@archont561/qgis-sdk`](https://www.npmjs.com/package/@archont561/qgis-sdk).**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Every entry point re-exports the scoped package at the exact same version:
|
|
6
|
+
`qgis-sdk`, `qgis-sdk/bridge`, `qgis-sdk/host`, `qgis-sdk/react` and
|
|
7
|
+
`qgis-sdk/testing`. There is no code of its own; pick whichever name reads
|
|
8
|
+
better in your project. The Python package of the same name is on
|
|
9
|
+
[PyPI](https://pypi.org/project/qgis-sdk/).
|
|
6
10
|
|
|
7
|
-
|
|
11
|
+
## Installation
|
|
8
12
|
|
|
9
|
-
|
|
13
|
+
```sh
|
|
14
|
+
bun add qgis-sdk
|
|
15
|
+
npm install qgis-sdk
|
|
16
|
+
```
|
|
10
17
|
|
|
11
|
-
|
|
12
|
-
1. Configure OIDC trusted publishing for the package name `qgis-sdk`
|
|
13
|
-
2. Enable secure, token-less publishing from CI/CD workflows
|
|
14
|
-
3. Establish provenance for packages published under this name
|
|
18
|
+
## Example
|
|
15
19
|
|
|
16
|
-
|
|
20
|
+
```ts
|
|
21
|
+
import { BridgeClient } from "qgis-sdk/bridge";
|
|
22
|
+
import { createHost } from "qgis-sdk/host";
|
|
23
|
+
```
|
|
17
24
|
|
|
18
|
-
|
|
25
|
+
## Documentation
|
|
19
26
|
|
|
20
|
-
|
|
27
|
+
- [TypeScript package guide](https://github.com/Archont561/qgis-sdk/blob/main/backlog/docs/guides/doc-13%20-%20qgis-sdk-TypeScript-package-guide.md) -
|
|
28
|
+
exports, the transport client, host namespaces, generated clients, streams,
|
|
29
|
+
the React bindings and testing against a scripted host.
|
|
21
30
|
|
|
22
|
-
|
|
31
|
+
## License
|
|
23
32
|
|
|
24
|
-
|
|
25
|
-
2. Configure the trusted publisher (e.g., GitHub Actions)
|
|
26
|
-
3. Specify the repository and workflow that should be allowed to publish
|
|
27
|
-
4. Use the configured workflow to publish your actual package
|
|
28
|
-
|
|
29
|
-
## DO NOT USE THIS PACKAGE
|
|
30
|
-
|
|
31
|
-
This package is a placeholder for OIDC configuration only. It:
|
|
32
|
-
- Contains no executable code
|
|
33
|
-
- Provides no functionality
|
|
34
|
-
- Should not be installed as a dependency
|
|
35
|
-
- Exists only for administrative purposes
|
|
36
|
-
|
|
37
|
-
## More Information
|
|
38
|
-
|
|
39
|
-
For more details about npm's trusted publishing feature, see:
|
|
40
|
-
- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
|
|
41
|
-
- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
**Maintained for OIDC setup purposes only**
|
|
33
|
+
MIT
|
package/bridge.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/bridge";
|
package/bridge.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/bridge";
|
package/host.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/host";
|
package/host.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/host";
|
package/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk";
|
package/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk";
|
package/package.json
CHANGED
|
@@ -1,10 +1,64 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
2
|
+
"name": "qgis-sdk",
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"description": "Unscoped alias of @archont561/qgis-sdk, the TypeScript SDK for QGIS plugin interfaces hosted in QWebEngineView.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./index.js",
|
|
8
|
+
"types": "./index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./index.d.ts",
|
|
12
|
+
"import": "./index.js",
|
|
13
|
+
"default": "./index.js"
|
|
14
|
+
},
|
|
15
|
+
"./bridge": {
|
|
16
|
+
"types": "./bridge.d.ts",
|
|
17
|
+
"import": "./bridge.js",
|
|
18
|
+
"default": "./bridge.js"
|
|
19
|
+
},
|
|
20
|
+
"./host": {
|
|
21
|
+
"types": "./host.d.ts",
|
|
22
|
+
"import": "./host.js",
|
|
23
|
+
"default": "./host.js"
|
|
24
|
+
},
|
|
25
|
+
"./react": {
|
|
26
|
+
"types": "./react.d.ts",
|
|
27
|
+
"import": "./react.js",
|
|
28
|
+
"default": "./react.js"
|
|
29
|
+
},
|
|
30
|
+
"./testing": {
|
|
31
|
+
"types": "./testing.d.ts",
|
|
32
|
+
"import": "./testing.js",
|
|
33
|
+
"default": "./testing.js"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
"files": [
|
|
37
|
+
"*.js",
|
|
38
|
+
"*.d.ts",
|
|
39
|
+
"README.md",
|
|
40
|
+
"LICENSE"
|
|
41
|
+
],
|
|
42
|
+
"repository": {
|
|
43
|
+
"type": "git",
|
|
44
|
+
"url": "git+https://github.com/Archont561/qgis-sdk.git",
|
|
45
|
+
"directory": "packages/qgis-sdk-alias"
|
|
46
|
+
},
|
|
47
|
+
"publishConfig": {
|
|
48
|
+
"access": "public"
|
|
49
|
+
},
|
|
50
|
+
"scripts": {
|
|
51
|
+
"test": "bun test"
|
|
52
|
+
},
|
|
53
|
+
"dependencies": {
|
|
54
|
+
"@archont561/qgis-sdk": "0.4.0"
|
|
55
|
+
},
|
|
56
|
+
"peerDependencies": {
|
|
57
|
+
"react": ">=18"
|
|
58
|
+
},
|
|
59
|
+
"peerDependenciesMeta": {
|
|
60
|
+
"react": {
|
|
61
|
+
"optional": true
|
|
62
|
+
}
|
|
63
|
+
}
|
|
10
64
|
}
|
package/react.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/react";
|
package/react.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/react";
|
package/testing.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/testing";
|
package/testing.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@archont561/qgis-sdk/testing";
|