@query-farm/vgi-rpc 0.1.0

package/LICENSE.md

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025-2026, Query.Farm LLC - https://query.farm
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,332 @@
+# vgi-rpc
+
+TypeScript server library for the [vgi-rpc](https://github.com/rustyconover/vgi-rpc) framework. Implements RPC servers that communicate over stdin/stdout using [Apache Arrow](https://arrow.apache.org/) IPC serialization.
+
+Define RPC methods with Arrow-typed schemas, serve them over stdin/stdout, and interact with them using the Python `vgi-rpc` CLI or any vgi-rpc client. Unlike JSON-over-HTTP, structured data stays in Arrow columnar format for efficient transfer.
+
+**Key features:**
+
+- **Three method types** — unary (request-response), producer (server-streaming), and exchange (bidirectional-streaming)
+- **Apache Arrow IPC wire format** — efficient columnar serialization compatible with the Python vgi-rpc framework
+- **Schema shorthand** — declare schemas with `{ name: str, count: int }` instead of manual `Schema`/`Field` construction
+- **Fluent protocol builder** — chain `.unary()`, `.producer()`, `.exchange()` calls to define your service
+- **Type-safe streaming state** — generic `<S>` parameter threads state types through init and produce/exchange functions
+- **Runtime introspection** — opt-in `__describe__` method for dynamic service discovery via the CLI
+- **Result validation** — missing required fields in handler results throw descriptive errors at emit time
+- **Three client transports** — HTTP, subprocess, and raw pipe, all sharing a unified `RpcClient` interface
+
+## Installation
+
+```bash
+bun add vgi-rpc
+```
+
+Requires [Bun](https://bun.sh/) runtime.
+
+## Quick Start
+
+```typescript
+import { Protocol, VgiRpcServer, str, float } from "vgi-rpc";
+
+const protocol = new Protocol("Calculator");
+
+protocol.unary("add", {
+  params: { a: float, b: float },
+  result: { result: float },
+  handler: async ({ a, b }) => ({ result: a + b }),
+  doc: "Add two numbers.",
+});
+
+protocol.unary("greet", {
+  params: { name: str },
+  result: { result: str },
+  handler: async ({ name }) => ({ result: `Hello, ${name}!` }),
+  doc: "Greet someone by name.",
+});
+
+const server = new VgiRpcServer(protocol, { enableDescribe: true });
+server.run();
+```
+
+## Client
+
+Connect to any vgi-rpc server programmatically:
+
+```typescript
+import { httpConnect, subprocessConnect } from "vgi-rpc";
+
+// HTTP transport
+const client = httpConnect("http://localhost:8080");
+const result = await client.call("add", { a: 2, b: 3 });
+console.log(result); // { result: 5 }
+client.close();
+
+// Subprocess transport (spawns server, communicates over pipes)
+const client2 = subprocessConnect(["bun", "run", "server.ts"]);
+const result2 = await client2.call("greet", { name: "World" });
+console.log(result2); // { result: "Hello, World!" }
+client2.close();
+```
+
+All transports share the same `RpcClient` interface: `call()`, `stream()`, `describe()`, `close()`.
+
+## Testing with the Python CLI
+
+Test it with the Python CLI:
+
+```bash
+# Describe the service
+vgi-rpc --cmd "bun run server.ts" describe
+
+# Call a method
+vgi-rpc --cmd "bun run server.ts" call add a=1.0 b=2.0
+# {"result": 3.0}
+
+vgi-rpc --cmd "bun run server.ts" call greet name=World
+# {"result": "Hello, World!"}
+```
+
+## Defining Methods
+
+### Unary
+
+Single request, single response:
+
+```typescript
+protocol.unary("add", {
+  params: { a: float, b: float },
+  result: { result: float },
+  handler: async ({ a, b }) => ({ result: a + b }),
+  doc: "Add two numbers.",
+  defaults: { b: 1.0 },
+});
+```
+
+The handler receives parsed parameters and returns a record matching the result schema. The optional `defaults` field provides default values for omitted parameters.
+
+### Producer (Server Streaming)
+
+The server produces multiple output batches. The generic `<S>` parameter infers state types from the `init` return value:
+
+```typescript
+protocol.producer<{ limit: number; current: number }>("count", {
+  params: { limit: int32, batch_size: int32 },
+  outputSchema: { n: int32, n_squared: int32 },
+  init: async ({ limit, batch_size }) => ({
+    limit,
+    current: 0,
+    batchSize: batch_size,
+  }),
+  produce: async (state, out) => {
+    if (state.current >= state.limit) {
+      out.finish();
+      return;
+    }
+    out.emitRow({ n: state.current, n_squared: state.current ** 2 });
+    state.current++;
+  },
+  doc: "Count from 0 to limit-1.",
+  defaults: { batch_size: 1 },
+});
+```
+
+`produce` is called repeatedly. Call `out.finish()` to end the stream. Mutate `state` in-place between calls.
+
+### Exchange (Bidirectional Streaming)
+
+Client sends batches, server responds one output batch per input batch:
+
+```typescript
+protocol.exchange<{ factor: number }>("scale", {
+  params: { factor: float },
+  inputSchema: { value: float },
+  outputSchema: { value: float },
+  init: async ({ factor }) => ({ factor }),
+  exchange: async (state, input, out) => {
+    const value = input.getChildAt(0)?.get(0) as number;
+    out.emitRow({ value: value * state.factor });
+  },
+  doc: "Scale input values by a factor.",
+});
+```
+
+### Stream Headers
+
+Producer and exchange methods can send a one-time header before the data stream:
+
+```typescript
+protocol.producer<{ count: number; current: number }>("produce_with_header", {
+  params: { count: int },
+  outputSchema: { index: int, value: int },
+  headerSchema: { total_expected: int, description: str },
+  headerInit: (params) => ({
+    total_expected: params.count,
+    description: `producing ${params.count} batches`,
+  }),
+  init: ({ count }) => ({ count, current: 0 }),
+  produce: (state, out) => {
+    if (state.current >= state.count) {
+      out.finish();
+      return;
+    }
+    out.emitRow({ index: state.current, value: state.current * 10 });
+    state.current++;
+  },
+});
+```
+
+## Schema Shorthand
+
+Declare schemas using convenient type singletons instead of manual `Schema`/`Field` construction:
+
+```typescript
+import { str, bytes, int, int32, float, float32, bool } from "vgi-rpc";
+
+// Shorthand
+protocol.unary("echo", {
+  params: { name: str, count: int, value: float },
+  result: { result: str },
+  handler: ({ name }) => ({ result: name }),
+});
+
+// Equivalent verbose form
+import { Schema, Field, Utf8, Int64, Float64 } from "apache-arrow";
+
+protocol.unary("echo", {
+  params: new Schema([
+    new Field("name", new Utf8(), false),
+    new Field("count", new Int64(), false),
+    new Field("value", new Float64(), false),
+  ]),
+  result: new Schema([new Field("result", new Utf8(), false)]),
+  handler: ({ name }) => ({ result: name }),
+});
+```
+
+### Type singletons
+
+| Singleton | Arrow Type | Python equivalent |
+|-----------|-----------|-------------------|
+| `str` | Utf8 | `str` |
+| `bytes` | Binary | `bytes` |
+| `int` | Int64 | `int` |
+| `int32` | Int32 | `Annotated[int, ArrowType(pa.int32())]` |
+| `float` | Float64 | `float` |
+| `float32` | Float32 | `Annotated[float, ArrowType(pa.float32())]` |
+| `bool` | Bool | `bool` |
+
+For complex types (List, Map, Dictionary, nullable fields), use the full `Schema`/`Field` constructors from `apache-arrow`.
+
+## Emitting Output
+
+The `OutputCollector` provides three ways to emit data:
+
+```typescript
+// Column arrays — most efficient for multi-row batches
+out.emit({ name: ["alice", "bob"], value: [1.0, 2.0] });
+
+// Single-row convenience
+out.emitRow({ name: "alice", value: 1.0 });
+
+// Pre-built RecordBatch
+out.emit(batch);
+```
+
+Int64 columns automatically coerce JavaScript Numbers to BigInt.
+
+## Client-Directed Logging
+
+Handler functions can emit log messages that travel over the wire to the client:
+
+```typescript
+protocol.unary("process", {
+  params: { data: str },
+  result: { result: str },
+  handler: (params, ctx) => {
+    ctx.clientLog("INFO", `Processing: ${params.data}`);
+    ctx.clientLog("DEBUG", "Transform complete", { detail: "extra info" });
+    return { result: params.data.toUpperCase() };
+  },
+});
+```
+
+In streaming methods, use `out.clientLog()`:
+
+```typescript
+produce: (state, out) => {
+  out.clientLog("INFO", `Producing batch ${state.current}`);
+  out.emitRow({ value: state.current });
+  state.current++;
+},
+```
+
+## Error Handling
+
+Exceptions thrown in handlers are propagated to the client as `RpcError`:
+
+```typescript
+handler: async ({ a, b }) => {
+  if (b === 0) throw new Error("Division by zero");
+  return { result: a / b };
+},
+```
+
+Errors are transmitted as zero-row Arrow batches with `EXCEPTION`-level metadata. The transport remains clean for subsequent requests.
+
+## Testing with the Python CLI
+
+The [vgi-rpc CLI](https://github.com/rustyconover/vgi-rpc) can introspect and call methods on any TypeScript server:
+
+```bash
+pip install vgi-rpc[cli]
+
+# Describe the service
+vgi-rpc --cmd "bun run examples/calculator.ts" describe
+
+# Unary call
+vgi-rpc --cmd "bun run examples/calculator.ts" call add a=2.0 b=3.0
+
+# Producer stream
+vgi-rpc --cmd "bun run examples/streaming.ts" call count limit=5 --format table
+
+# Exchange stream
+vgi-rpc --cmd "bun run examples/streaming.ts" call scale factor=2.0
+```
+
+## Wire Protocol Compatibility
+
+This library implements the same wire protocol as the Python [vgi-rpc](https://github.com/rustyconover/vgi-rpc) framework:
+
+- Multiple sequential Arrow IPC streams on stdin/stdout
+- Request batches carry method name and version in batch metadata
+- Lockstep streaming: one output batch per input batch
+- Zero-row batches for log messages and errors
+- `__describe__` introspection method for cross-language service discovery
+
+See the Python README's [Wire Protocol Specification](https://github.com/rustyconover/vgi-rpc#wire-protocol-specification) for the full protocol details.
+
+## Examples
+
+| Example | Description |
+|---------|-------------|
+| [`calculator.ts`](examples/calculator.ts) | Unary methods: add, multiply, divide |
+| [`greeter.ts`](examples/greeter.ts) | String parameters and results |
+| [`streaming.ts`](examples/streaming.ts) | Producer and exchange stream patterns |
+| [`conformance.ts`](examples/conformance.ts) | 46-method reference service for wire-protocol conformance testing |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run tests
+bun test
+
+# Build (types + bundle)
+bun run build
+```
+
+## License
+
+Copyright 2026 Query.Farm LLC [https://query.farm](https://query.farm). All rights reserved. See [LICENSE.md](LICENSE.md).

package/dist/client/connect.d.ts

@@ -0,0 +1,10 @@
+import { type ServiceDescription } from "./introspect.js";
+import type { HttpConnectOptions, StreamSession } from "./types.js";
+export interface RpcClient {
+    call(method: string, params?: Record<string, any>): Promise<Record<string, any> | null>;
+    stream(method: string, params?: Record<string, any>): Promise<StreamSession>;
+    describe(): Promise<ServiceDescription>;
+    close(): void;
+}
+export declare function httpConnect(baseUrl: string, options?: HttpConnectOptions): RpcClient;
+//# sourceMappingURL=connect.d.ts.map

package/dist/client/connect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../src/client/connect.ts"],"names":[],"mappings":"AAaA,OAAO,EAAmC,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE3F,OAAO,KAAK,EAAE,kBAAkB,EAAc,aAAa,EAAE,MAAM,YAAY,CAAC;AAKhF,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACxF,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7E,QAAQ,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACxC,KAAK,IAAI,IAAI,CAAC;CACf;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,kBAAkB,GAC3B,SAAS,CAuRX"}

package/dist/client/index.d.ts

@@ -0,0 +1,6 @@
+export { httpConnect, type RpcClient } from "./connect.js";
+export { httpIntrospect, parseDescribeResponse, type ServiceDescription, type MethodInfo } from "./introspect.js";
+export { HttpStreamSession } from "./stream.js";
+export { pipeConnect, subprocessConnect, PipeStreamSession } from "./pipe.js";
+export { type HttpConnectOptions, type LogMessage, type StreamSession, type PipeConnectOptions, type SubprocessConnectOptions, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,KAAK,kBAAkB,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9E,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,GAC9B,MAAM,YAAY,CAAC"}

package/dist/client/introspect.d.ts

@@ -0,0 +1,30 @@
+import { RecordBatch, type Schema } from "apache-arrow";
+import type { LogMessage } from "./types.js";
+export interface MethodInfo {
+    name: string;
+    type: "unary" | "stream";
+    paramsSchema: Schema;
+    resultSchema: Schema;
+    inputSchema?: Schema;
+    outputSchema?: Schema;
+    headerSchema?: Schema;
+    doc?: string;
+    paramTypes?: Record<string, string>;
+    defaults?: Record<string, any>;
+}
+export interface ServiceDescription {
+    protocolName: string;
+    methods: MethodInfo[];
+}
+/**
+ * Parse a __describe__ response from batches into a ServiceDescription.
+ * Reusable across transports (HTTP, pipe, subprocess).
+ */
+export declare function parseDescribeResponse(batches: RecordBatch[], onLog?: (msg: LogMessage) => void): Promise<ServiceDescription>;
+/**
+ * Send a __describe__ request and return a ServiceDescription.
+ */
+export declare function httpIntrospect(baseUrl: string, options?: {
+    prefix?: string;
+}): Promise<ServiceDescription>;
+//# sourceMappingURL=introspect.d.ts.map

package/dist/client/introspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.d.ts","sourceRoot":"","sources":["../../src/client/introspect.ts"],"names":[],"mappings":"AAGA,OAAO,EAAqB,WAAW,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAS3E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AASD;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,WAAW,EAAE,EACtB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,GAChC,OAAO,CAAC,kBAAkB,CAAC,CAoE7B;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,OAAO,CAAC,kBAAkB,CAAC,CAe7B"}

package/dist/client/ipc.d.ts

@@ -0,0 +1,34 @@
+import { RecordBatch, Schema, DataType } from "apache-arrow";
+import { IpcStreamReader } from "../wire/reader.js";
+import type { LogMessage } from "./types.js";
+/** Infer an Arrow DataType from a JS value. */
+export declare function inferArrowType(value: any): DataType;
+/**
+ * Build a 1-row Arrow IPC request batch with method metadata.
+ */
+export declare function buildRequestIpc(schema: Schema, params: Record<string, any>, method: string): Uint8Array;
+/**
+ * Read schema + all batches from an IPC stream body.
+ */
+export declare function readResponseBatches(body: Uint8Array): Promise<{
+    schema: Schema;
+    batches: RecordBatch[];
+}>;
+/**
+ * Check if a zero-row batch carries log/error metadata.
+ * If EXCEPTION → throw RpcError.
+ * If other level → call onLog.
+ * Returns true if the batch was consumed as a log/error.
+ */
+export declare function dispatchLogOrError(batch: RecordBatch, onLog?: (msg: LogMessage) => void): boolean;
+/**
+ * Extract all rows from a batch as Record<string, any>[].
+ * Converts BigInt to Number when safe.
+ */
+export declare function extractBatchRows(batch: RecordBatch): Record<string, any>[];
+/**
+ * Read sequential IPC streams from a response body.
+ * Returns an IpcStreamReader for reading header + data streams.
+ */
+export declare function readSequentialStreams(body: Uint8Array): Promise<IpcStreamReader>;
+//# sourceMappingURL=ipc.d.ts.map

package/dist/client/ipc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipc.d.ts","sourceRoot":"","sources":["../../src/client/ipc.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,WAAW,EAEX,MAAM,EACN,QAAQ,EAST,MAAM,cAAc,CAAC;AAWtB,OAAO,EAAE,eAAe,EAAsB,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,+CAA+C;AAC/C,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,QAAQ,CAOnD;AAyCD;;GAEG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,MAAM,EAAE,MAAM,GACb,UAAU,CAgCZ;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,UAAU,GACf,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,EAAE,CAAA;CAAE,CAAC,CASrD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,WAAW,EAClB,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,GAChC,OAAO,CAqCT;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAoB1E;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,eAAe,CAAC,CAQ1B"}