@archont561/qgis-sdk 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,106 +1,73 @@
+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 { HostInvokeOptions2, AlgorithmInfo2, AlgorithmSummary2, FileRef2, OutputInfo2, ParameterInfo2, ProviderInfo2, RunOutput2, RunResult2, VectorLayerInfo2, HostOperations2 } from "./shared/chunk-7tgzmz0m.js";
+import { OperationShape2, StreamShape2, OperationMap2, StreamMap2, BridgeSchema2, OperationsOf2, StreamsOf2, defineBridgeSchema2, QgisSdkOptions2, StreamHandlers2, StreamHandle2, OperationMethod2, StreamMethod2, QgisSdkHostTheme2, QgisSdkHost2, QgisSdkCore2, OperationTree2, StreamTree2, QGIS_SDK_MEMBERS2, QgisSdk2 } from "./shared/chunk-a33y575v.js";
+import { DeclaredSchema2, ValidateOptions2, ContractDirection2, SerializedContractError2, QgisSdkContractError2, validateAgainstSchema2, QgisSdkStoreError2, StoreListener2, Store2, OperationState2, Operation2, OperationStore2, StreamTerminalLike2, StreamHandleLike2, StreamHandlersLike2, Stream2, StreamState2, stableKey2, StreamStore2, FormFieldKind2, FormField2, labelFor2, schemaFields2, FormValues2, FormState2, FormOptions2, FormStore2, formStore2, HostQueryState2, HostQueryLoader2, HostQueryStore2, LayersQueryOptions2, layersQuery2, layerFieldsQuery2 } from "./shared/chunk-3zscfm3y.js";
+import { QgisSdkError2 } from "./shared/chunk-pdj2fxjb.js";
+/** A layer input: the id of a layer the host owns, or a ref the view holds. */
+type LayerRef = string | FileRef2;
+/** Where an output goes: a writable ref, or `null` to let the host allocate one. */
+type Destination = FileRef2 | null;
+/** `"xmin,xmax,ymin,ymax [crs]"` as QGIS writes it, or the four numbers. */
+type Extent = string | readonly [number, number, number, number];
+/** `"x,y [crs]"` or the two numbers. */
+type PointValue = string | readonly [number, number];
+/** `[lower, upper]`. */
+type RangeValue = readonly [number, number];
 /**
-* Public 0.1.0 contract, wire-limit, and error primitives for the QGIS SDK bridge.
-*
-* Mirrors the QGIS-free `qgis_sdk.models` and `qgis_sdk.declarations`
-* (`schema_version = 1`) contracts without importing browser or Qt globals.
-*/
-declare const MAX_SAFE_INTEGER: number;
-declare const MIN_SAFE_INTEGER: number;
-declare const PLUGIN_DESCRIPTION_SCHEMA_VERSION: 1;
-type ValidationDirection = "request" | "result";
-interface SerializedValidationIssue {
-	readonly path: (string | number)[];
-	readonly code: string;
-}
-interface SerializedContractValidationError {
-	readonly code: string;
-	readonly direction: ValidationDirection;
-	readonly issues: SerializedValidationIssue[];
-}
-interface ActionDescription {
-	readonly id: string;
-	readonly title: string;
-	readonly handler: string;
-	readonly request: Readonly<Record<string, unknown>>;
-	readonly result: Readonly<Record<string, unknown>>;
-}
-/** The event kinds a stream may declare; the frame carries the same three. */
-type StreamEventKind = "data" | "progress" | "state";
-/**
-* A declared stream (decision-28): a request in, one payload schema per
-* declared event kind out. There is no `result`: the reply to a subscription is
-* the protocol's acknowledgement, not something an author declares.
-*/
-interface StreamDescription {
-	readonly id: string;
-	readonly title: string;
-	readonly handler: string;
-	readonly request: Readonly<Record<string, unknown>>;
-	readonly events: Readonly<Partial<Record<StreamEventKind, Readonly<Record<string, unknown>>>>>;
-}
-interface PluginDescription {
-	readonly schema_version: 1;
-	readonly id: string;
-	readonly title: string;
-	readonly actions: readonly ActionDescription[];
-	/** Declared streams; a description from a host that predates them is empty. */
-	readonly streams: readonly StreamDescription[];
-}
-/**
-* Return whether `value` is a finite integer within the JavaScript-safe wire range.
-*/
-declare function isSafeJsonInteger(value: unknown): value is number;
-/**
-* Base class for expected SDK errors across the bridge boundary.
-*/
-declare class QgisSdkError extends Error {
-	readonly code: string;
-	constructor(message: string, code?: string);
-}
-/**
-* An operation attempted to use an already disposed owner scope.
+* What a generated `AlgorithmRegistry` is: params and result per algorithm id.
+* Spelled as a mapped constraint over the registry itself so an `interface`
+* (which has no implicit index signature) satisfies it.
 */
-declare class QgisSdkScopeClosedError extends QgisSdkError {
-	constructor();
+type AlgorithmRegistryLike<R> = { readonly [K in keyof R] : {
+	readonly params: object;
+	readonly result: object;
+} };
+/** The part of a `QgisSdk` (or anything else) `runAlgorithm` needs. */
+interface AlgorithmHost {
+	readonly host: Pick<HostOperations2, "algorithms">;
 }
-/**
-* The selected runtime does not offer an explicitly requested capability.
-*/
-declare class QgisSdkUnsupportedCapabilityError extends QgisSdkError {
-	readonly capability: string;
-	constructor(capability: string);
+/** One run as the page sees it: the outputs by name, plus the reply as it crossed. */
+interface AlgorithmRun<Result extends object> {
+	readonly algorithm: string;
+	readonly outputs: Result;
+	readonly raw: RunResult2;
 }
 /**
-* A declaration cannot be represented or parsed in the versioned contract.
+* Run `id` with `params` through `qgis.host.algorithms.run` and reshape the
+* reply: a `vector` output becomes its `VectorLayerInfo`, a `file` output its
+* `FileRef`, a `value` output the scalar - keyed by output name, which is what
+* the generated `...Result` interfaces declare.
+*
+* Both type parameters are meant to be bound by the generated module's own
+* `runAlgorithm`; calling this one directly needs them spelled out.
 */
-declare class QgisSdkDeclarationError extends QgisSdkError {
+declare function runAlgorithm<
+	R extends AlgorithmRegistryLike<R>,
+	K extends keyof R & string
+>(qgis: AlgorithmHost, id: K, params: R[K]["params"], options?: HostInvokeOptions2): Promise<AlgorithmRun<R[K]["result"]>>;
+/** Unwrap a tagged output list into `{ [name]: layer | ref | value }`. */
+declare function outputsByName(outputs: readonly RunOutput2[]): Record<string, VectorLayerInfo2 | FileRef2 | string | number | boolean | null | undefined>;
+/** The web view did not provide a usable channel. */
+declare class QgisSdkWebChannelError extends QgisSdkError2 {
 	constructor(message: string);
 }
-/**
-* Safe, structured location and category for a rejected contract value.
-*/
-declare class QgisSdkValidationIssue {
-	readonly path: readonly (string | number)[];
-	readonly code: string;
-	constructor(path: readonly (string | number)[], code: string);
-	toJSON(): SerializedValidationIssue;
+/** 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;
 /**
-* A request or result did not satisfy its declared wire contract.
-*/
-declare class QgisSdkContractValidationError extends QgisSdkError {
-	readonly direction: ValidationDirection;
-	readonly issues: readonly QgisSdkValidationIssue[];
-	constructor(direction: ValidationDirection, issues: readonly QgisSdkValidationIssue[]);
-	toJSON(): SerializedContractValidationError;
-}
-/**
-* Return whether `value` is a non-null, non-array object: the shape every wire
-* envelope, description and event payload must have before its fields are read.
-*/
-declare function isPlainRecord(value: unknown): value is Record<string, unknown>;
-/**
-* Parse and validate a version 1 `PluginDescription` emitted by `describe_plugin`.
+* 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 parsePluginDescription(input: string | Readonly<Record<string, unknown>>): PluginDescription;
-export { ActionDescription, MAX_SAFE_INTEGER, MIN_SAFE_INTEGER, PLUGIN_DESCRIPTION_SCHEMA_VERSION, PluginDescription, QgisSdkContractValidationError, QgisSdkDeclarationError, QgisSdkError, QgisSdkScopeClosedError, QgisSdkUnsupportedCapabilityError, QgisSdkValidationIssue, SerializedContractValidationError, SerializedValidationIssue, StreamDescription, StreamEventKind, ValidationDirection, isPlainRecord, isSafeJsonInteger, parsePluginDescription };
+declare function createWebChannelTransport(objectName?: string): WebChannelTransport;
+export { ActionDescription2 as ActionDescription, AlgorithmHost, AlgorithmInfo2 as AlgorithmInfo, AlgorithmRegistryLike, AlgorithmRun, AlgorithmSummary2 as AlgorithmSummary, 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, ContractDirection2 as ContractDirection, DeclaredSchema2 as DeclaredSchema, Destination, Extent, FileRef2 as FileRef, FormField2 as FormField, FormFieldKind2 as FormFieldKind, FormOptions2 as FormOptions, FormState2 as FormState, FormStore2 as FormStore, FormValues2 as FormValues, HostInvokeOptions2 as HostInvokeOptions, HostQueryLoader2 as HostQueryLoader, HostQueryState2 as HostQueryState, HostQueryStore2 as HostQueryStore, InvokeOptions2 as InvokeOptions, InvokeReply2 as InvokeReply, LayerRef, LayersQueryOptions2 as LayersQueryOptions, MAX_CALL_ID_LENGTH2 as MAX_CALL_ID_LENGTH, MAX_SAFE_INTEGER2 as MAX_SAFE_INTEGER, MIN_SAFE_INTEGER2 as MIN_SAFE_INTEGER, Operation2 as Operation, OperationMap2 as OperationMap, OperationMethod2 as OperationMethod, OperationShape2 as OperationShape, OperationState2 as OperationState, OperationStore2 as OperationStore, OperationTree2 as OperationTree, OperationsOf2 as OperationsOf, OutputInfo2 as OutputInfo, PLUGIN_DESCRIPTION_SCHEMA_VERSION2 as PLUGIN_DESCRIPTION_SCHEMA_VERSION, ParameterInfo2 as ParameterInfo, PluginDescription2 as PluginDescription, PointValue, ProviderInfo2 as ProviderInfo, 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, QgisSdkContractError2 as QgisSdkContractError, QgisSdkContractValidationError2 as QgisSdkContractValidationError, QgisSdkCore2 as QgisSdkCore, QgisSdkDeclarationError2 as QgisSdkDeclarationError, QgisSdkError2 as QgisSdkError, QgisSdkHost2 as QgisSdkHost, QgisSdkHostTheme2 as QgisSdkHostTheme, QgisSdkOptions2 as QgisSdkOptions, QgisSdkStoreError2 as QgisSdkStoreError, QgisSdkValidationIssue2 as QgisSdkValidationIssue, QgisSdkWebChannelError, RangeValue, RunOutput2 as RunOutput, RunResult2 as RunResult, SerializedContractError2 as SerializedContractError, SerializedContractValidationError2 as SerializedContractValidationError, SerializedValidationIssue2 as SerializedValidationIssue, Store2 as Store, StoreListener2 as StoreListener, Stream2 as Stream, StreamDescription2 as StreamDescription, StreamEventKind2 as StreamEventKind, StreamHandle2 as StreamHandle, StreamHandleLike2 as StreamHandleLike, StreamHandlers2 as StreamHandlers, StreamHandlersLike2 as StreamHandlersLike, StreamMap2 as StreamMap, StreamMethod2 as StreamMethod, StreamShape2 as StreamShape, StreamState2 as StreamState, StreamStore2 as StreamStore, StreamTerminalKind2 as StreamTerminalKind, StreamTerminalLike2 as StreamTerminalLike, StreamTree2 as StreamTree, StreamsOf2 as StreamsOf, SubscriptionHandlers2 as SubscriptionHandlers, ValidateOptions2 as ValidateOptions, ValidationDirection2 as ValidationDirection, VectorLayerInfo2 as VectorLayerInfo, WebChannelTransport, WireTransport2 as WireTransport, createWebChannelTransport, defineBridgeSchema2 as defineBridgeSchema, formStore2 as formStore, insideQgis, isSafeJsonInteger2 as isSafeJsonInteger, labelFor2 as labelFor, layerFieldsQuery2 as layerFieldsQuery, layersQuery2 as layersQuery, outputsByName, parseInvokeReply2 as parseInvokeReply, parsePluginDescription2 as parsePluginDescription, parseStreamFrame2 as parseStreamFrame, runAlgorithm, schemaFields2 as schemaFields, stableKey2 as stableKey, validateAgainstSchema2 as validateAgainstSchema };