@dxfeed/dxlink-console-rpc 0.0.0-stage → 0.10.0

package/build/index.d.mts

@@ -0,0 +1,56 @@
+import * as _dxfeed_dxlink_console_core from '@dxfeed/dxlink-console-core';
+import { DescService, DescMethod, Message, FileRegistry } from '@bufbuild/protobuf';
+
+interface RpcChannelPluginOptions {
+    /**
+     * Descriptor-set endpoint the request form starts with.
+     *
+     * Supplied at composition rather than read from the console profile, which is why neither
+     * the channels area nor the profile has to know that descriptor sets exist.
+     */
+    descriptorSetUrl?: string;
+    /**
+     * Pin that endpoint: the field renders read-only, as a locked WebSocket URL does.
+     *
+     * Belongs here rather than in the profile's `locked` list for the same reason as the URL
+     * itself — it is this service's setting, and core has no vocabulary for it.
+     */
+    locked?: boolean;
+}
+/** The RPC service: call a method from a protobuf descriptor set. */
+declare const rpcChannelPlugin: ({ descriptorSetUrl, locked, }?: RpcChannelPluginOptions) => _dxfeed_dxlink_console_core.ErasedChannelPlugin;
+
+/** Config an RPC channel is opened with. */
+interface RpcConfig {
+    service: DescService;
+    method: DescMethod;
+    /**
+     * The request to open the channel with, already parsed against `method.input`.
+     *
+     * Parsing happens in the request form, where a malformed request can still be corrected;
+     * by the time a channel is opened the message is known to be valid.
+     */
+    request: Message;
+}
+/**
+ * RPC channel-request parameters.
+ *
+ * The registry is held here rather than re-fetched per dialog open, so a descriptor set is
+ * loaded once and several channels can be opened against it.
+ */
+interface RpcRequest {
+    /** Descriptor-set endpoint, kept between opens. */
+    url: string;
+    /** Registry built from the loaded descriptor set; null until one is loaded. */
+    registry: FileRegistry | null;
+    /** Where the loaded registry came from — a URL or a file name. */
+    source: string | null;
+    /** Fully qualified name of the selected service. */
+    serviceName: string;
+    /** ECMAScript name of the selected method, as `DescService.method` keys it. */
+    methodName: string;
+    /** The request message being edited, as protobuf-JSON. */
+    json: string;
+}
+
+export { type RpcChannelPluginOptions, type RpcConfig, type RpcRequest, rpcChannelPlugin };

package/build/index.d.ts

@@ -0,0 +1,56 @@
+import * as _dxfeed_dxlink_console_core from '@dxfeed/dxlink-console-core';
+import { DescService, DescMethod, Message, FileRegistry } from '@bufbuild/protobuf';
+
+interface RpcChannelPluginOptions {
+    /**
+     * Descriptor-set endpoint the request form starts with.
+     *
+     * Supplied at composition rather than read from the console profile, which is why neither
+     * the channels area nor the profile has to know that descriptor sets exist.
+     */
+    descriptorSetUrl?: string;
+    /**
+     * Pin that endpoint: the field renders read-only, as a locked WebSocket URL does.
+     *
+     * Belongs here rather than in the profile's `locked` list for the same reason as the URL
+     * itself — it is this service's setting, and core has no vocabulary for it.
+     */
+    locked?: boolean;
+}
+/** The RPC service: call a method from a protobuf descriptor set. */
+declare const rpcChannelPlugin: ({ descriptorSetUrl, locked, }?: RpcChannelPluginOptions) => _dxfeed_dxlink_console_core.ErasedChannelPlugin;
+
+/** Config an RPC channel is opened with. */
+interface RpcConfig {
+    service: DescService;
+    method: DescMethod;
+    /**
+     * The request to open the channel with, already parsed against `method.input`.
+     *
+     * Parsing happens in the request form, where a malformed request can still be corrected;
+     * by the time a channel is opened the message is known to be valid.
+     */
+    request: Message;
+}
+/**
+ * RPC channel-request parameters.
+ *
+ * The registry is held here rather than re-fetched per dialog open, so a descriptor set is
+ * loaded once and several channels can be opened against it.
+ */
+interface RpcRequest {
+    /** Descriptor-set endpoint, kept between opens. */
+    url: string;
+    /** Registry built from the loaded descriptor set; null until one is loaded. */
+    registry: FileRegistry | null;
+    /** Where the loaded registry came from — a URL or a file name. */
+    source: string | null;
+    /** Fully qualified name of the selected service. */
+    serviceName: string;
+    /** ECMAScript name of the selected method, as `DescService.method` keys it. */
+    methodName: string;
+    /** The request message being edited, as protobuf-JSON. */
+    json: string;
+}
+
+export { type RpcChannelPluginOptions, type RpcConfig, type RpcRequest, rpcChannelPlugin };