@archont561/qgis-sdk 0.0.0 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QGIS SDK contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,55 @@
 # @archont561/qgis-sdk
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+**TypeScript client for QGIS plugin interfaces hosted in `QWebEngineView`.**
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+The companion to [`qgis-sdk`](https://pypi.org/project/qgis-sdk/): a correlated
+transport client with subscriptions, the curated host namespaces, and the
+contract a generated per-plugin client is built on. Every exported error begins
+with `QgisSdk` and carries a stable wire `code`.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+> Experimental. Published as `@archont561/qgis-sdk-bridge` through `0.2.0`;
+> `@archont561/qgis-sdk` continues from `0.3.0`. The root exports the
+> transport client, the error root and the description contract; `./host`,
+> `./react` and `./testing` are opt-in entry points.
 
-## Purpose
+## Installation
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@archont561/qgis-sdk`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```sh
+bun add @archont561/qgis-sdk
+npm install @archont561/qgis-sdk
+```
 
-## What is OIDC Trusted Publishing?
+## Example
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+```ts
+import { BridgeClient } from "@archont561/qgis-sdk";
+import { createHost } from "@archont561/qgis-sdk/host";
 
-## Setup Instructions
+const client = new BridgeClient({
+	send: (message) => channel.send(JSON.stringify(message)),
+	subscribe: (listener) => {
+		channel.onmessage = (text: string) => listener(JSON.parse(text));
+		return () => {
+			channel.onmessage = null;
+		};
+	},
+});
 
-To properly configure OIDC trusted publishing for this package:
+const host = createHost(client);
+const page = await host.layers.list({ limit: 20 });
+```
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+A plugin's own operations come from the client `qgis-sdk bridge generate`
+renders from its Python declarations.
 
-## DO NOT USE THIS PACKAGE
+## Documentation
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+- [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.
+- [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.
 
-## More Information
+## License
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+MIT

package/dist/bridge.d.ts

@@ -0,0 +1,2 @@
+import { StreamEventKind2, BRIDGE_PROTOCOL_VERSION2, MAX_CALL_ID_LENGTH2, BridgeFailure2, InvokeReply2, StreamTerminalKind2, BridgeStreamEvent2, BridgeStreamTerminal2, BridgeEventFrame2, BridgeTerminalFrame2, BridgeStreamFrame2, WireTransport2, BridgeClientOptions2, InvokeOptions2, QgisSdkBridgeProtocolError2, QgisSdkBridgeTimeoutError2, QgisSdkBridgeAbortedError2, QgisSdkBridgeClosedError2, QgisSdkBridgeSequenceError2, QgisSdkBridgeStreamEndedError2, QgisSdkBridgeRemoteError2, parseInvokeReply2, parseStreamFrame2, SubscriptionHandlers2, BridgeSubscription2, BridgeClient2 } from "./shared/chunk-wtv4vt4q.js";
+export { BRIDGE_PROTOCOL_VERSION2 as BRIDGE_PROTOCOL_VERSION, BridgeClient2 as BridgeClient, BridgeClientOptions2 as BridgeClientOptions, BridgeEventFrame2 as BridgeEventFrame, BridgeFailure2 as BridgeFailure, BridgeStreamEvent2 as BridgeStreamEvent, BridgeStreamFrame2 as BridgeStreamFrame, BridgeStreamTerminal2 as BridgeStreamTerminal, BridgeSubscription2 as BridgeSubscription, BridgeTerminalFrame2 as BridgeTerminalFrame, InvokeOptions2 as InvokeOptions, InvokeReply2 as InvokeReply, MAX_CALL_ID_LENGTH2 as MAX_CALL_ID_LENGTH, QgisSdkBridgeAbortedError2 as QgisSdkBridgeAbortedError, QgisSdkBridgeClosedError2 as QgisSdkBridgeClosedError, QgisSdkBridgeProtocolError2 as QgisSdkBridgeProtocolError, QgisSdkBridgeRemoteError2 as QgisSdkBridgeRemoteError, QgisSdkBridgeSequenceError2 as QgisSdkBridgeSequenceError, QgisSdkBridgeStreamEndedError2 as QgisSdkBridgeStreamEndedError, QgisSdkBridgeTimeoutError2 as QgisSdkBridgeTimeoutError, StreamEventKind2 as StreamEventKind, StreamTerminalKind2 as StreamTerminalKind, SubscriptionHandlers2 as SubscriptionHandlers, WireTransport2 as WireTransport, parseInvokeReply2 as parseInvokeReply, parseStreamFrame2 as parseStreamFrame };

package/dist/bridge.js

@@ -0,0 +1,31 @@
+import {
+  BRIDGE_PROTOCOL_VERSION2,
+  MAX_CALL_ID_LENGTH2,
+  QgisSdkBridgeProtocolError2,
+  QgisSdkBridgeTimeoutError2,
+  QgisSdkBridgeAbortedError2,
+  QgisSdkBridgeClosedError2,
+  QgisSdkBridgeSequenceError2,
+  QgisSdkBridgeStreamEndedError2,
+  QgisSdkBridgeRemoteError2,
+  parseInvokeReply2,
+  parseStreamFrame2,
+  BridgeClient2
+} from "./shared/chunk-8gawbn19.js";
+export {
+  BRIDGE_PROTOCOL_VERSION2 as BRIDGE_PROTOCOL_VERSION,
+  BridgeClient2 as BridgeClient,
+  MAX_CALL_ID_LENGTH2 as MAX_CALL_ID_LENGTH,
+  QgisSdkBridgeAbortedError2 as QgisSdkBridgeAbortedError,
+  QgisSdkBridgeClosedError2 as QgisSdkBridgeClosedError,
+  QgisSdkBridgeProtocolError2 as QgisSdkBridgeProtocolError,
+  QgisSdkBridgeRemoteError2 as QgisSdkBridgeRemoteError,
+  QgisSdkBridgeSequenceError2 as QgisSdkBridgeSequenceError,
+  QgisSdkBridgeStreamEndedError2 as QgisSdkBridgeStreamEndedError,
+  QgisSdkBridgeTimeoutError2 as QgisSdkBridgeTimeoutError,
+  parseInvokeReply2 as parseInvokeReply,
+  parseStreamFrame2 as parseStreamFrame
+};
+
+//# debugId=40AA08F7CCD69E0B64756E2164756E21
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFtdLAogICJzb3VyY2VzQ29udGVudCI6IFsKICBdLAogICJtYXBwaW5ncyI6ICIiLAogICJkZWJ1Z0lkIjogIjQwQUEwOEY3Q0NENjlFMEI2NDc1NkUyMTY0NzU2RTIxIiwKICAibmFtZXMiOiBbXQp9

package/dist/host.d.ts

@@ -0,0 +1,2 @@
+import { HOST_ID2, HOST_FINGERPRINT2, HOST_SCHEMA_VERSION2, HOST_OPERATIONS2, HostOperationId2, HostInvokeOptions2, HostClientLike2, HostStreamTerminal2, HostStreamHandlers2, HostStreamHandle2, QgisSdkHostContractError2, ExportRequest2, ExportResult2, FetchRequest2, FileRef2, HttpHeader2, IdPage2, LayerPage2, LayerRequest2, NetworkFetchData2, NotificationsInfoRequest2, OpenVectorRequest2, PageRequest2, SettingsGetRequest2, StylesApplyRequest2, VectorLayerInfo2, NetworkFetchEvent2, HostOperations2, createHost2 } from "./shared/chunk-khemhx86.js";
+export { ExportRequest2 as ExportRequest, ExportResult2 as ExportResult, FetchRequest2 as FetchRequest, FileRef2 as FileRef, HOST_FINGERPRINT2 as HOST_FINGERPRINT, HOST_ID2 as HOST_ID, HOST_OPERATIONS2 as HOST_OPERATIONS, HOST_SCHEMA_VERSION2 as HOST_SCHEMA_VERSION, HostClientLike2 as HostClientLike, HostInvokeOptions2 as HostInvokeOptions, HostOperationId2 as HostOperationId, HostOperations2 as HostOperations, HostStreamHandle2 as HostStreamHandle, HostStreamHandlers2 as HostStreamHandlers, HostStreamTerminal2 as HostStreamTerminal, HttpHeader2 as HttpHeader, IdPage2 as IdPage, LayerPage2 as LayerPage, LayerRequest2 as LayerRequest, NetworkFetchData2 as NetworkFetchData, NetworkFetchEvent2 as NetworkFetchEvent, NotificationsInfoRequest2 as NotificationsInfoRequest, OpenVectorRequest2 as OpenVectorRequest, PageRequest2 as PageRequest, QgisSdkHostContractError2 as QgisSdkHostContractError, SettingsGetRequest2 as SettingsGetRequest, StylesApplyRequest2 as StylesApplyRequest, VectorLayerInfo2 as VectorLayerInfo, createHost2 as createHost };

package/dist/host.js

@@ -0,0 +1,51 @@
+import {
+  HOST_ID2,
+  HOST_FINGERPRINT2,
+  HOST_SCHEMA_VERSION2,
+  HOST_OPERATIONS2,
+  QgisSdkHostContractError2,
+  ExportRequest2,
+  ExportResult2,
+  FetchRequest2,
+  FileRef2,
+  HttpHeader2,
+  IdPage2,
+  LayerPage2,
+  LayerRequest2,
+  NetworkFetchData2,
+  NotificationsInfoRequest2,
+  OpenVectorRequest2,
+  PageRequest2,
+  SettingsGetRequest2,
+  StylesApplyRequest2,
+  VectorLayerInfo2,
+  NetworkFetchEvent2,
+  createHost2
+} from "./shared/chunk-vqyymknv.js";
+export {
+  ExportRequest2 as ExportRequest,
+  ExportResult2 as ExportResult,
+  FetchRequest2 as FetchRequest,
+  FileRef2 as FileRef,
+  HOST_FINGERPRINT2 as HOST_FINGERPRINT,
+  HOST_ID2 as HOST_ID,
+  HOST_OPERATIONS2 as HOST_OPERATIONS,
+  HOST_SCHEMA_VERSION2 as HOST_SCHEMA_VERSION,
+  HttpHeader2 as HttpHeader,
+  IdPage2 as IdPage,
+  LayerPage2 as LayerPage,
+  LayerRequest2 as LayerRequest,
+  NetworkFetchData2 as NetworkFetchData,
+  NetworkFetchEvent2 as NetworkFetchEvent,
+  NotificationsInfoRequest2 as NotificationsInfoRequest,
+  OpenVectorRequest2 as OpenVectorRequest,
+  PageRequest2 as PageRequest,
+  QgisSdkHostContractError2 as QgisSdkHostContractError,
+  SettingsGetRequest2 as SettingsGetRequest,
+  StylesApplyRequest2 as StylesApplyRequest,
+  VectorLayerInfo2 as VectorLayerInfo,
+  createHost2 as createHost
+};
+
+//# debugId=5475A84EF80D664964756E2164756E21
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFtdLAogICJzb3VyY2VzQ29udGVudCI6IFsKICBdLAogICJtYXBwaW5ncyI6ICIiLAogICJkZWJ1Z0lkIjogIjU0NzVBODRFRjgwRDY2NDk2NDc1NkUyMTY0NzU2RTIxIiwKICAibmFtZXMiOiBbXQp9

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import { MAX_SAFE_INTEGER2, MIN_SAFE_INTEGER2, PLUGIN_DESCRIPTION_SCHEMA_VERSION2, ValidationDirection2, SerializedValidationIssue2, SerializedContractValidationError2, ActionDescription2, StreamEventKind2, StreamDescription2, PluginDescription2, isSafeJsonInteger2, QgisSdkDeclarationError2, QgisSdkValidationIssue2, QgisSdkContractValidationError2, parsePluginDescription2, BRIDGE_PROTOCOL_VERSION2, MAX_CALL_ID_LENGTH2, BridgeFailure2, InvokeReply2, StreamTerminalKind2, BridgeStreamEvent2, BridgeStreamTerminal2, BridgeEventFrame2, BridgeTerminalFrame2, BridgeStreamFrame2, WireTransport2, BridgeClientOptions2, InvokeOptions2, QgisSdkBridgeProtocolError2, QgisSdkBridgeTimeoutError2, QgisSdkBridgeAbortedError2, QgisSdkBridgeClosedError2, QgisSdkBridgeSequenceError2, QgisSdkBridgeStreamEndedError2, QgisSdkBridgeRemoteError2, parseInvokeReply2, parseStreamFrame2, SubscriptionHandlers2, BridgeSubscription2, BridgeClient2 } from "./shared/chunk-wtv4vt4q.js";
+import "./shared/chunk-khemhx86.js";
+import { OperationShape2, StreamShape2, OperationMap2, StreamMap2, BridgeSchema2, OperationsOf2, StreamsOf2, defineBridgeSchema2 } from "./shared/chunk-jjx14tgd.js";
+import { QgisSdkOptions2, StreamHandlers2, StreamHandle2, OperationMethod2, StreamMethod2, QgisSdkHost2, QgisSdkCore2, OperationTree2, StreamTree2, QGIS_SDK_MEMBERS2, QgisSdk2 } from "./shared/chunk-tmca1ynt.js";
+import { QgisSdkError2 } from "./shared/chunk-pdj2fxjb.js";
+/** One schema of the declared dialect, as the description carries it. */
+type DeclaredSchema = Readonly<Record<string, unknown>>;
+/** Options for {@link validateAgainstSchema}. */
+interface ValidateOptions {
+	/** Ignore properties the schema does not name (results and events). */
+	readonly allowUnknown?: boolean;
+	/** Where the value sits, prefixed to every issue's path. */
+	readonly path?: readonly (string | number)[];
+}
+/** Which side of a call a contract issue belongs to. */
+type ContractDirection = "request" | "result" | "event";
+/** The JSON form of {@link QgisSdkContractError}. */
+interface SerializedContractError {
+	readonly code: string;
+	readonly operation: string;
+	readonly direction: ContractDirection;
+	readonly issues: SerializedValidationIssue2[];
+}
+/**
+* An argument, a reply or an event does not match the declared contract.
+*
+* The code is the one both languages use for this category, so a page that
+* already matches `contract_validation_failed` needs no second branch.
+*/
+declare class QgisSdkContractError extends QgisSdkError2 {
+	readonly operation: string;
+	readonly direction: ContractDirection;
+	readonly issues: readonly QgisSdkValidationIssue2[];
+	constructor(operation: string, direction: ContractDirection, issues: readonly QgisSdkValidationIssue2[]);
+	toJSON(): SerializedContractError;
+}
+/**
+* Return every issue `value` has against `schema`; an empty array is a match.
+*
+* Throws {@link QgisSdkDeclarationError} when `schema` leaves the declared
+* dialect, because that is a fault in the declaration, never in the value.
+*/
+declare function validateAgainstSchema(value: unknown, schema: DeclaredSchema, options?: ValidateOptions): QgisSdkValidationIssue2[];
+/** The web view did not provide a usable channel. */
+declare class QgisSdkWebChannelError extends QgisSdkError2 {
+	constructor(message: string);
+}
+/** The transport {@link createWebChannelTransport} returns. */
+interface WebChannelTransport extends WireTransport2 {
+	/** Resolves once the channel object answered; rejects when it never will. */
+	readonly ready: Promise<void>;
+	/** Stop forwarding messages; sends after this throw. */
+	close(): void;
+}
+/** True inside a QGIS web view, where Qt injected its transport and script. */
+declare function insideQgis(): boolean;
+/**
+* Connect to the channel object `objectName` and return a transport on it.
+*
+* Throws {@link QgisSdkWebChannelError} synchronously outside a QGIS web view,
+* so a page learns in its first statement that it has no host to talk to.
+* Inside one, messages sent before the channel is ready are queued and
+* delivered in order once it is; `ready` rejects (and queued sends are
+* dropped) when the host registered no object under that name.
+*/
+declare function createWebChannelTransport(objectName?: string): WebChannelTransport;
+export { ActionDescription2 as ActionDescription, BRIDGE_PROTOCOL_VERSION2 as BRIDGE_PROTOCOL_VERSION, BridgeClient2 as BridgeClient, BridgeClientOptions2 as BridgeClientOptions, BridgeEventFrame2 as BridgeEventFrame, BridgeFailure2 as BridgeFailure, BridgeSchema2 as BridgeSchema, BridgeStreamEvent2 as BridgeStreamEvent, BridgeStreamFrame2 as BridgeStreamFrame, BridgeStreamTerminal2 as BridgeStreamTerminal, BridgeSubscription2 as BridgeSubscription, BridgeTerminalFrame2 as BridgeTerminalFrame, ContractDirection, DeclaredSchema, InvokeOptions2 as InvokeOptions, InvokeReply2 as InvokeReply, MAX_CALL_ID_LENGTH2 as MAX_CALL_ID_LENGTH, MAX_SAFE_INTEGER2 as MAX_SAFE_INTEGER, MIN_SAFE_INTEGER2 as MIN_SAFE_INTEGER, OperationMap2 as OperationMap, OperationMethod2 as OperationMethod, OperationShape2 as OperationShape, OperationTree2 as OperationTree, OperationsOf2 as OperationsOf, PLUGIN_DESCRIPTION_SCHEMA_VERSION2 as PLUGIN_DESCRIPTION_SCHEMA_VERSION, PluginDescription2 as PluginDescription, QGIS_SDK_MEMBERS2 as QGIS_SDK_MEMBERS, QgisSdk2 as QgisSdk, QgisSdkBridgeAbortedError2 as QgisSdkBridgeAbortedError, QgisSdkBridgeClosedError2 as QgisSdkBridgeClosedError, QgisSdkBridgeProtocolError2 as QgisSdkBridgeProtocolError, QgisSdkBridgeRemoteError2 as QgisSdkBridgeRemoteError, QgisSdkBridgeSequenceError2 as QgisSdkBridgeSequenceError, QgisSdkBridgeStreamEndedError2 as QgisSdkBridgeStreamEndedError, QgisSdkBridgeTimeoutError2 as QgisSdkBridgeTimeoutError, QgisSdkContractError, QgisSdkContractValidationError2 as QgisSdkContractValidationError, QgisSdkCore2 as QgisSdkCore, QgisSdkDeclarationError2 as QgisSdkDeclarationError, QgisSdkError2 as QgisSdkError, QgisSdkHost2 as QgisSdkHost, QgisSdkOptions2 as QgisSdkOptions, QgisSdkValidationIssue2 as QgisSdkValidationIssue, QgisSdkWebChannelError, SerializedContractError, SerializedContractValidationError2 as SerializedContractValidationError, SerializedValidationIssue2 as SerializedValidationIssue, StreamDescription2 as StreamDescription, StreamEventKind2 as StreamEventKind, StreamHandle2 as StreamHandle, StreamHandlers2 as StreamHandlers, StreamMap2 as StreamMap, StreamMethod2 as StreamMethod, StreamShape2 as StreamShape, StreamTerminalKind2 as StreamTerminalKind, StreamTree2 as StreamTree, StreamsOf2 as StreamsOf, SubscriptionHandlers2 as SubscriptionHandlers, ValidateOptions, ValidationDirection2 as ValidationDirection, WebChannelTransport, WireTransport2 as WireTransport, createWebChannelTransport, defineBridgeSchema2 as defineBridgeSchema, insideQgis, isSafeJsonInteger2 as isSafeJsonInteger, parseInvokeReply2 as parseInvokeReply, parsePluginDescription2 as parsePluginDescription, parseStreamFrame2 as parseStreamFrame, validateAgainstSchema };