space-data-module-sdk 0.8.3 → 0.8.5

package/src/generated/orbpro/plugin/stream-invoke-request.js

@@ -0,0 +1,160 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from "flatbuffers";
+import { DrainPolicy } from "../manifest/drain-policy.js";
+import { TypedArenaBuffer } from "../stream/typed-arena-buffer.js";
+/**
+ * Generic stream-based method invocation request.
+ */
+export class StreamInvokeRequest {
+  constructor() {
+    this.bb = null;
+    this.bb_pos = 0;
+  }
+  __init(i, bb) {
+    this.bb_pos = i;
+    this.bb = bb;
+    return this;
+  }
+  static getRootAsStreamInvokeRequest(bb, obj) {
+    return (obj || new StreamInvokeRequest()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+  static getSizePrefixedRootAsStreamInvokeRequest(bb, obj) {
+    bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
+    return (obj || new StreamInvokeRequest()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+  methodId(optionalEncoding) {
+    const offset = this.bb.__offset(this.bb_pos, 4);
+    return this.bb.__string(this.bb_pos + offset, optionalEncoding);
+  }
+  /**
+   * Input FlatBuffer frames grouped as a vector of descriptors.
+   */
+  inputs(index, obj) {
+    const offset = this.bb.__offset(this.bb_pos, 6);
+    return offset
+      ? (obj || new TypedArenaBuffer()).__init(
+          this.bb.__indirect(
+            this.bb.__vector(this.bb_pos + offset) + index * 4,
+          ),
+          this.bb,
+        )
+      : null;
+  }
+  inputsLength() {
+    const offset = this.bb.__offset(this.bb_pos, 6);
+    return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+  }
+  /**
+   * Maximum number of output frames the caller is prepared to accept.
+   */
+  outputStreamCap() {
+    const offset = this.bb.__offset(this.bb_pos, 8);
+    return offset ? this.bb.readUint32(this.bb_pos + offset) : 0;
+  }
+  /**
+   * Drain policy requested for this call.
+   */
+  drainPolicy() {
+    const offset = this.bb.__offset(this.bb_pos, 10);
+    return offset
+      ? this.bb.readUint8(this.bb_pos + offset)
+      : DrainPolicy.DRAIN_UNTIL_YIELD;
+  }
+  static startStreamInvokeRequest(builder) {
+    builder.startObject(4);
+  }
+  static addMethodId(builder, methodIdOffset) {
+    builder.addFieldOffset(0, methodIdOffset, 0);
+  }
+  static addInputs(builder, inputsOffset) {
+    builder.addFieldOffset(1, inputsOffset, 0);
+  }
+  static createInputsVector(builder, data) {
+    builder.startVector(4, data.length, 4);
+    for (let i = data.length - 1; i >= 0; i--) {
+      builder.addOffset(data[i]);
+    }
+    return builder.endVector();
+  }
+  static startInputsVector(builder, numElems) {
+    builder.startVector(4, numElems, 4);
+  }
+  static addOutputStreamCap(builder, outputStreamCap) {
+    builder.addFieldInt32(2, outputStreamCap, 0);
+  }
+  static addDrainPolicy(builder, drainPolicy) {
+    builder.addFieldInt8(3, drainPolicy, DrainPolicy.DRAIN_UNTIL_YIELD);
+  }
+  static endStreamInvokeRequest(builder) {
+    const offset = builder.endObject();
+    builder.requiredField(offset, 4); // method_id
+    return offset;
+  }
+  static createStreamInvokeRequest(
+    builder,
+    methodIdOffset,
+    inputsOffset,
+    outputStreamCap,
+    drainPolicy,
+  ) {
+    StreamInvokeRequest.startStreamInvokeRequest(builder);
+    StreamInvokeRequest.addMethodId(builder, methodIdOffset);
+    StreamInvokeRequest.addInputs(builder, inputsOffset);
+    StreamInvokeRequest.addOutputStreamCap(builder, outputStreamCap);
+    StreamInvokeRequest.addDrainPolicy(builder, drainPolicy);
+    return StreamInvokeRequest.endStreamInvokeRequest(builder);
+  }
+  unpack() {
+    return new StreamInvokeRequestT(
+      this.methodId(),
+      this.bb.createObjList(this.inputs.bind(this), this.inputsLength()),
+      this.outputStreamCap(),
+      this.drainPolicy(),
+    );
+  }
+  unpackTo(_o) {
+    _o.methodId = this.methodId();
+    _o.inputs = this.bb.createObjList(
+      this.inputs.bind(this),
+      this.inputsLength(),
+    );
+    _o.outputStreamCap = this.outputStreamCap();
+    _o.drainPolicy = this.drainPolicy();
+  }
+}
+export class StreamInvokeRequestT {
+  constructor(
+    methodId = null,
+    inputs = [],
+    outputStreamCap = 0,
+    drainPolicy = DrainPolicy.DRAIN_UNTIL_YIELD,
+  ) {
+    this.methodId = methodId;
+    this.inputs = inputs;
+    this.outputStreamCap = outputStreamCap;
+    this.drainPolicy = drainPolicy;
+  }
+  pack(builder) {
+    const methodId =
+      this.methodId !== null ? builder.createString(this.methodId) : 0;
+    const inputs = StreamInvokeRequest.createInputsVector(
+      builder,
+      builder.createObjectOffsetList(this.inputs),
+    );
+    return StreamInvokeRequest.createStreamInvokeRequest(
+      builder,
+      methodId,
+      inputs,
+      this.outputStreamCap,
+      this.drainPolicy,
+    );
+  }
+}
+//# sourceMappingURL=stream-invoke-request.js.map

package/src/generated/orbpro/plugin/stream-invoke-request.ts

@@ -0,0 +1,211 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+
+import * as flatbuffers from "flatbuffers";
+
+import { DrainPolicy } from "../manifest/drain-policy.js";
+import {
+  TypedArenaBuffer,
+  TypedArenaBufferT,
+} from "../stream/typed-arena-buffer.js";
+
+/**
+ * Generic stream-based method invocation request.
+ */
+export class StreamInvokeRequest implements flatbuffers.IUnpackableObject<StreamInvokeRequestT> {
+  bb: flatbuffers.ByteBuffer | null = null;
+  bb_pos = 0;
+  __init(i: number, bb: flatbuffers.ByteBuffer): StreamInvokeRequest {
+    this.bb_pos = i;
+    this.bb = bb;
+    return this;
+  }
+
+  static getRootAsStreamInvokeRequest(
+    bb: flatbuffers.ByteBuffer,
+    obj?: StreamInvokeRequest,
+  ): StreamInvokeRequest {
+    return (obj || new StreamInvokeRequest()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+
+  static getSizePrefixedRootAsStreamInvokeRequest(
+    bb: flatbuffers.ByteBuffer,
+    obj?: StreamInvokeRequest,
+  ): StreamInvokeRequest {
+    bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
+    return (obj || new StreamInvokeRequest()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+
+  /**
+   * Stable target method identifier from PluginManifest.
+   */
+  methodId(): string;
+  methodId(optionalEncoding: flatbuffers.Encoding): string | Uint8Array;
+  methodId(optionalEncoding?: any): string | Uint8Array {
+    const offset = this.bb!.__offset(this.bb_pos, 4);
+    return this.bb!.__string(this.bb_pos + offset, optionalEncoding);
+  }
+
+  /**
+   * Input FlatBuffer frames grouped as a vector of descriptors.
+   */
+  inputs(index: number, obj?: TypedArenaBuffer): TypedArenaBuffer | null {
+    const offset = this.bb!.__offset(this.bb_pos, 6);
+    return offset
+      ? (obj || new TypedArenaBuffer()).__init(
+          this.bb!.__indirect(
+            this.bb!.__vector(this.bb_pos + offset) + index * 4,
+          ),
+          this.bb!,
+        )
+      : null;
+  }
+
+  inputsLength(): number {
+    const offset = this.bb!.__offset(this.bb_pos, 6);
+    return offset ? this.bb!.__vector_len(this.bb_pos + offset) : 0;
+  }
+
+  /**
+   * Maximum number of output frames the caller is prepared to accept.
+   */
+  outputStreamCap(): number {
+    const offset = this.bb!.__offset(this.bb_pos, 8);
+    return offset ? this.bb!.readUint32(this.bb_pos + offset) : 0;
+  }
+
+  /**
+   * Drain policy requested for this call.
+   */
+  drainPolicy(): DrainPolicy {
+    const offset = this.bb!.__offset(this.bb_pos, 10);
+    return offset
+      ? this.bb!.readUint8(this.bb_pos + offset)
+      : DrainPolicy.DRAIN_UNTIL_YIELD;
+  }
+
+  static startStreamInvokeRequest(builder: flatbuffers.Builder) {
+    builder.startObject(4);
+  }
+
+  static addMethodId(
+    builder: flatbuffers.Builder,
+    methodIdOffset: flatbuffers.Offset,
+  ) {
+    builder.addFieldOffset(0, methodIdOffset, 0);
+  }
+
+  static addInputs(
+    builder: flatbuffers.Builder,
+    inputsOffset: flatbuffers.Offset,
+  ) {
+    builder.addFieldOffset(1, inputsOffset, 0);
+  }
+
+  static createInputsVector(
+    builder: flatbuffers.Builder,
+    data: flatbuffers.Offset[],
+  ): flatbuffers.Offset {
+    builder.startVector(4, data.length, 4);
+    for (let i = data.length - 1; i >= 0; i--) {
+      builder.addOffset(data[i]!);
+    }
+    return builder.endVector();
+  }
+
+  static startInputsVector(builder: flatbuffers.Builder, numElems: number) {
+    builder.startVector(4, numElems, 4);
+  }
+
+  static addOutputStreamCap(
+    builder: flatbuffers.Builder,
+    outputStreamCap: number,
+  ) {
+    builder.addFieldInt32(2, outputStreamCap, 0);
+  }
+
+  static addDrainPolicy(
+    builder: flatbuffers.Builder,
+    drainPolicy: DrainPolicy,
+  ) {
+    builder.addFieldInt8(3, drainPolicy, DrainPolicy.DRAIN_UNTIL_YIELD);
+  }
+
+  static endStreamInvokeRequest(
+    builder: flatbuffers.Builder,
+  ): flatbuffers.Offset {
+    const offset = builder.endObject();
+    builder.requiredField(offset, 4); // method_id
+    return offset;
+  }
+
+  static createStreamInvokeRequest(
+    builder: flatbuffers.Builder,
+    methodIdOffset: flatbuffers.Offset,
+    inputsOffset: flatbuffers.Offset,
+    outputStreamCap: number,
+    drainPolicy: DrainPolicy,
+  ): flatbuffers.Offset {
+    StreamInvokeRequest.startStreamInvokeRequest(builder);
+    StreamInvokeRequest.addMethodId(builder, methodIdOffset);
+    StreamInvokeRequest.addInputs(builder, inputsOffset);
+    StreamInvokeRequest.addOutputStreamCap(builder, outputStreamCap);
+    StreamInvokeRequest.addDrainPolicy(builder, drainPolicy);
+    return StreamInvokeRequest.endStreamInvokeRequest(builder);
+  }
+
+  unpack(): StreamInvokeRequestT {
+    return new StreamInvokeRequestT(
+      this.methodId(),
+      this.bb!.createObjList<TypedArenaBuffer, TypedArenaBufferT>(
+        this.inputs.bind(this),
+        this.inputsLength(),
+      ),
+      this.outputStreamCap(),
+      this.drainPolicy(),
+    );
+  }
+
+  unpackTo(_o: StreamInvokeRequestT): void {
+    _o.methodId = this.methodId();
+    _o.inputs = this.bb!.createObjList<TypedArenaBuffer, TypedArenaBufferT>(
+      this.inputs.bind(this),
+      this.inputsLength(),
+    );
+    _o.outputStreamCap = this.outputStreamCap();
+    _o.drainPolicy = this.drainPolicy();
+  }
+}
+
+export class StreamInvokeRequestT implements flatbuffers.IGeneratedObject {
+  constructor(
+    public methodId: string | Uint8Array | null = null,
+    public inputs: TypedArenaBufferT[] = [],
+    public outputStreamCap: number = 0,
+    public drainPolicy: DrainPolicy = DrainPolicy.DRAIN_UNTIL_YIELD,
+  ) {}
+
+  pack(builder: flatbuffers.Builder): flatbuffers.Offset {
+    const methodId =
+      this.methodId !== null ? builder.createString(this.methodId!) : 0;
+    const inputs = StreamInvokeRequest.createInputsVector(
+      builder,
+      builder.createObjectOffsetList(this.inputs),
+    );
+
+    return StreamInvokeRequest.createStreamInvokeRequest(
+      builder,
+      methodId,
+      inputs,
+      this.outputStreamCap,
+      this.drainPolicy,
+    );
+  }
+}

package/src/generated/orbpro/plugin/stream-invoke-response.d.ts

@@ -0,0 +1,99 @@
+import * as flatbuffers from "flatbuffers";
+import {
+  TypedArenaBuffer,
+  TypedArenaBufferT,
+} from "../stream/typed-arena-buffer.js";
+/**
+ * Generic stream-based method invocation result.
+ */
+export declare class StreamInvokeResponse implements flatbuffers.IUnpackableObject<StreamInvokeResponseT> {
+  bb: flatbuffers.ByteBuffer | null;
+  bb_pos: number;
+  __init(i: number, bb: flatbuffers.ByteBuffer): StreamInvokeResponse;
+  static getRootAsStreamInvokeResponse(
+    bb: flatbuffers.ByteBuffer,
+    obj?: StreamInvokeResponse,
+  ): StreamInvokeResponse;
+  static getSizePrefixedRootAsStreamInvokeResponse(
+    bb: flatbuffers.ByteBuffer,
+    obj?: StreamInvokeResponse,
+  ): StreamInvokeResponse;
+  /**
+   * Output FlatBuffer frames produced by the method.
+   */
+  outputs(index: number, obj?: TypedArenaBuffer): TypedArenaBuffer | null;
+  outputsLength(): number;
+  /**
+   * Number of queued input frames still waiting upstream after this call.
+   */
+  backlogRemaining(): number;
+  /**
+   * True when the runtime yielded before fully draining the input backlog.
+   */
+  yielded(): boolean;
+  /**
+   * Error code (0 = success).
+   */
+  errorCode(): number;
+  /**
+   * Error message if `error_code != 0`.
+   */
+  errorMessage(): string | null;
+  errorMessage(
+    optionalEncoding: flatbuffers.Encoding,
+  ): string | Uint8Array | null;
+  static startStreamInvokeResponse(builder: flatbuffers.Builder): void;
+  static addOutputs(
+    builder: flatbuffers.Builder,
+    outputsOffset: flatbuffers.Offset,
+  ): void;
+  static createOutputsVector(
+    builder: flatbuffers.Builder,
+    data: flatbuffers.Offset[],
+  ): flatbuffers.Offset;
+  static startOutputsVector(
+    builder: flatbuffers.Builder,
+    numElems: number,
+  ): void;
+  static addBacklogRemaining(
+    builder: flatbuffers.Builder,
+    backlogRemaining: number,
+  ): void;
+  static addYielded(builder: flatbuffers.Builder, yielded: boolean): void;
+  static addErrorCode(builder: flatbuffers.Builder, errorCode: number): void;
+  static addErrorMessage(
+    builder: flatbuffers.Builder,
+    errorMessageOffset: flatbuffers.Offset,
+  ): void;
+  static endStreamInvokeResponse(
+    builder: flatbuffers.Builder,
+  ): flatbuffers.Offset;
+  static createStreamInvokeResponse(
+    builder: flatbuffers.Builder,
+    outputsOffset: flatbuffers.Offset,
+    backlogRemaining: number,
+    yielded: boolean,
+    errorCode: number,
+    errorMessageOffset: flatbuffers.Offset,
+  ): flatbuffers.Offset;
+  unpack(): StreamInvokeResponseT;
+  unpackTo(_o: StreamInvokeResponseT): void;
+}
+export declare class StreamInvokeResponseT
+  implements flatbuffers.IGeneratedObject
+{
+  outputs: TypedArenaBufferT[];
+  backlogRemaining: number;
+  yielded: boolean;
+  errorCode: number;
+  errorMessage: string | Uint8Array | null;
+  constructor(
+    outputs?: TypedArenaBufferT[],
+    backlogRemaining?: number,
+    yielded?: boolean,
+    errorCode?: number,
+    errorMessage?: string | Uint8Array | null,
+  );
+  pack(builder: flatbuffers.Builder): flatbuffers.Offset;
+}
+//# sourceMappingURL=stream-invoke-response.d.ts.map

package/src/generated/orbpro/plugin/stream-invoke-response.js

@@ -0,0 +1,175 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+import * as flatbuffers from "flatbuffers";
+import { TypedArenaBuffer } from "../stream/typed-arena-buffer.js";
+/**
+ * Generic stream-based method invocation result.
+ */
+export class StreamInvokeResponse {
+  constructor() {
+    this.bb = null;
+    this.bb_pos = 0;
+  }
+  __init(i, bb) {
+    this.bb_pos = i;
+    this.bb = bb;
+    return this;
+  }
+  static getRootAsStreamInvokeResponse(bb, obj) {
+    return (obj || new StreamInvokeResponse()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+  static getSizePrefixedRootAsStreamInvokeResponse(bb, obj) {
+    bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
+    return (obj || new StreamInvokeResponse()).__init(
+      bb.readInt32(bb.position()) + bb.position(),
+      bb,
+    );
+  }
+  /**
+   * Output FlatBuffer frames produced by the method.
+   */
+  outputs(index, obj) {
+    const offset = this.bb.__offset(this.bb_pos, 4);
+    return offset
+      ? (obj || new TypedArenaBuffer()).__init(
+          this.bb.__indirect(
+            this.bb.__vector(this.bb_pos + offset) + index * 4,
+          ),
+          this.bb,
+        )
+      : null;
+  }
+  outputsLength() {
+    const offset = this.bb.__offset(this.bb_pos, 4);
+    return offset ? this.bb.__vector_len(this.bb_pos + offset) : 0;
+  }
+  /**
+   * Number of queued input frames still waiting upstream after this call.
+   */
+  backlogRemaining() {
+    const offset = this.bb.__offset(this.bb_pos, 6);
+    return offset ? this.bb.readUint32(this.bb_pos + offset) : 0;
+  }
+  /**
+   * True when the runtime yielded before fully draining the input backlog.
+   */
+  yielded() {
+    const offset = this.bb.__offset(this.bb_pos, 8);
+    return offset ? !!this.bb.readInt8(this.bb_pos + offset) : false;
+  }
+  /**
+   * Error code (0 = success).
+   */
+  errorCode() {
+    const offset = this.bb.__offset(this.bb_pos, 10);
+    return offset ? this.bb.readInt32(this.bb_pos + offset) : 0;
+  }
+  errorMessage(optionalEncoding) {
+    const offset = this.bb.__offset(this.bb_pos, 12);
+    return offset
+      ? this.bb.__string(this.bb_pos + offset, optionalEncoding)
+      : null;
+  }
+  static startStreamInvokeResponse(builder) {
+    builder.startObject(5);
+  }
+  static addOutputs(builder, outputsOffset) {
+    builder.addFieldOffset(0, outputsOffset, 0);
+  }
+  static createOutputsVector(builder, data) {
+    builder.startVector(4, data.length, 4);
+    for (let i = data.length - 1; i >= 0; i--) {
+      builder.addOffset(data[i]);
+    }
+    return builder.endVector();
+  }
+  static startOutputsVector(builder, numElems) {
+    builder.startVector(4, numElems, 4);
+  }
+  static addBacklogRemaining(builder, backlogRemaining) {
+    builder.addFieldInt32(1, backlogRemaining, 0);
+  }
+  static addYielded(builder, yielded) {
+    builder.addFieldInt8(2, +yielded, +false);
+  }
+  static addErrorCode(builder, errorCode) {
+    builder.addFieldInt32(3, errorCode, 0);
+  }
+  static addErrorMessage(builder, errorMessageOffset) {
+    builder.addFieldOffset(4, errorMessageOffset, 0);
+  }
+  static endStreamInvokeResponse(builder) {
+    const offset = builder.endObject();
+    return offset;
+  }
+  static createStreamInvokeResponse(
+    builder,
+    outputsOffset,
+    backlogRemaining,
+    yielded,
+    errorCode,
+    errorMessageOffset,
+  ) {
+    StreamInvokeResponse.startStreamInvokeResponse(builder);
+    StreamInvokeResponse.addOutputs(builder, outputsOffset);
+    StreamInvokeResponse.addBacklogRemaining(builder, backlogRemaining);
+    StreamInvokeResponse.addYielded(builder, yielded);
+    StreamInvokeResponse.addErrorCode(builder, errorCode);
+    StreamInvokeResponse.addErrorMessage(builder, errorMessageOffset);
+    return StreamInvokeResponse.endStreamInvokeResponse(builder);
+  }
+  unpack() {
+    return new StreamInvokeResponseT(
+      this.bb.createObjList(this.outputs.bind(this), this.outputsLength()),
+      this.backlogRemaining(),
+      this.yielded(),
+      this.errorCode(),
+      this.errorMessage(),
+    );
+  }
+  unpackTo(_o) {
+    _o.outputs = this.bb.createObjList(
+      this.outputs.bind(this),
+      this.outputsLength(),
+    );
+    _o.backlogRemaining = this.backlogRemaining();
+    _o.yielded = this.yielded();
+    _o.errorCode = this.errorCode();
+    _o.errorMessage = this.errorMessage();
+  }
+}
+export class StreamInvokeResponseT {
+  constructor(
+    outputs = [],
+    backlogRemaining = 0,
+    yielded = false,
+    errorCode = 0,
+    errorMessage = null,
+  ) {
+    this.outputs = outputs;
+    this.backlogRemaining = backlogRemaining;
+    this.yielded = yielded;
+    this.errorCode = errorCode;
+    this.errorMessage = errorMessage;
+  }
+  pack(builder) {
+    const outputs = StreamInvokeResponse.createOutputsVector(
+      builder,
+      builder.createObjectOffsetList(this.outputs),
+    );
+    const errorMessage =
+      this.errorMessage !== null ? builder.createString(this.errorMessage) : 0;
+    return StreamInvokeResponse.createStreamInvokeResponse(
+      builder,
+      outputs,
+      this.backlogRemaining,
+      this.yielded,
+      this.errorCode,
+      errorMessage,
+    );
+  }
+}
+//# sourceMappingURL=stream-invoke-response.js.map