@miradorlabs/web-grpc 1.0.0 → 1.1.0

package/README.md

@@ -1,5 +1,5 @@
 # @miradorlabs/web-grpc
 
-Generated gRPC stubs for the Mirador `proto/gateway/web` gateway.
+Generated gRPC (grpc-js) client stubs for the Mirador web gateway.
 
-This package is **SDK plumbing**. You almost certainly want `@miradorlabs/web-sdk` or `@miradorlabs/nodejs-sdk` instead.
+Generated from the Mirador gateway protobuf definitions. Part of the [Mirador](https://github.com/miradorlabs) SDK toolchain.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@miradorlabs/web-grpc",
-  "version": "1.0.0",
-  "description": "Generated gRPC stubs for the Mirador proto/gateway/web gateway. SDK plumbing — you probably want @miradorlabs/web-sdk or @miradorlabs/nodejs-sdk.",
+  "version": "1.1.0",
+  "description": "Generated gRPC (grpc-js) client stubs for the Mirador web gateway.",
   "main": "index.js",
   "types": "index.d.ts",
   "license": "Apache-2.0",

package/proto/gateway/web/v1/trace_gateway.ts

@@ -204,6 +204,8 @@ export enum TraceEventType {
   TRACE_EVENT_TYPE_RELAY_NOT_FOUND = 52,
   TRACE_EVENT_TYPE_RULE_MATCH_ADDED = 53,
   TRACE_EVENT_TYPE_CANTON_TRANSACTION = 54,
+  TRACE_EVENT_TYPE_SPAN_STARTED = 55,
+  TRACE_EVENT_TYPE_SPAN_ENDED = 56,
   UNRECOGNIZED = -1,
 }
 
@@ -338,6 +340,12 @@ export function traceEventTypeFromJSON(object: any): TraceEventType {
     case 54:
     case "TRACE_EVENT_TYPE_CANTON_TRANSACTION":
       return TraceEventType.TRACE_EVENT_TYPE_CANTON_TRANSACTION;
+    case 55:
+    case "TRACE_EVENT_TYPE_SPAN_STARTED":
+      return TraceEventType.TRACE_EVENT_TYPE_SPAN_STARTED;
+    case 56:
+    case "TRACE_EVENT_TYPE_SPAN_ENDED":
+      return TraceEventType.TRACE_EVENT_TYPE_SPAN_ENDED;
     case -1:
     case "UNRECOGNIZED":
     default:
@@ -433,6 +441,10 @@ export function traceEventTypeToJSON(object: TraceEventType): string {
       return "TRACE_EVENT_TYPE_RULE_MATCH_ADDED";
     case TraceEventType.TRACE_EVENT_TYPE_CANTON_TRANSACTION:
       return "TRACE_EVENT_TYPE_CANTON_TRANSACTION";
+    case TraceEventType.TRACE_EVENT_TYPE_SPAN_STARTED:
+      return "TRACE_EVENT_TYPE_SPAN_STARTED";
+    case TraceEventType.TRACE_EVENT_TYPE_SPAN_ENDED:
+      return "TRACE_EVENT_TYPE_SPAN_ENDED";
     case TraceEventType.UNRECOGNIZED:
     default:
       return "UNRECOGNIZED";
@@ -1500,6 +1512,8 @@ export interface TraceEventEnvelope {
   source: EventSource;
   /** Category of the event (lifecycle, event, metadata) */
   category: TraceEventCategory;
+  /** Span this event belongs to ("" = trace-level) */
+  spanId: string;
   traceStarted?: TraceStarted | undefined;
   traceFinished?: TraceFinished | undefined;
   infoEventAdded?: InfoEventAdded | undefined;
@@ -1542,6 +1556,36 @@ export interface TraceEventEnvelope {
   relayNotFound?: RelayNotFound | undefined;
   ruleMatchAdded?: RuleMatchAdded | undefined;
   cantonTxAdded?: CantonTxAdded | undefined;
+  spanStarted?: SpanStarted | undefined;
+  spanEnded?: SpanEnded | undefined;
+}
+
+/** SpanStarted is emitted when a span opens. */
+export interface SpanStarted {
+  /** the span that opened; same value as the envelope span_id (field 13) */
+  spanId: string;
+  /** empty/unset = root span */
+  parentSpanId?: string | undefined;
+  name: string;
+  startTime: Date | undefined;
+  attributes: { [key: string]: string };
+}
+
+export interface SpanStarted_AttributesEntry {
+  key: string;
+  value: string;
+}
+
+/** SpanEnded is emitted when a span closes. */
+export interface SpanEnded {
+  /** the span that closed; same value as the envelope span_id (field 13) */
+  spanId: string;
+  endTime:
+    | Date
+    | undefined;
+  /** OTLP span status: UNSET / OK / ERROR */
+  statusCode?: string | undefined;
+  statusMessage?: string | undefined;
 }
 
 /** RuleMatchAdded is emitted when an automation rule match is stamped onto a trace. */
@@ -6349,6 +6393,7 @@ function createBaseTraceEventEnvelope(): TraceEventEnvelope {
     traceTimestamp: undefined,
     source: 0,
     category: 0,
+    spanId: "",
     traceStarted: undefined,
     traceFinished: undefined,
     infoEventAdded: undefined,
@@ -6391,6 +6436,8 @@ function createBaseTraceEventEnvelope(): TraceEventEnvelope {
     relayNotFound: undefined,
     ruleMatchAdded: undefined,
     cantonTxAdded: undefined,
+    spanStarted: undefined,
+    spanEnded: undefined,
   };
 }
 
@@ -6426,6 +6473,9 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     if (message.category !== 0) {
       writer.uint32(88).int32(message.category);
     }
+    if (message.spanId !== "") {
+      writer.uint32(106).string(message.spanId);
+    }
     if (message.traceStarted !== undefined) {
       TraceStarted.encode(message.traceStarted, writer.uint32(162).fork()).join();
     }
@@ -6552,6 +6602,12 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     if (message.cantonTxAdded !== undefined) {
       CantonTxAdded.encode(message.cantonTxAdded, writer.uint32(514).fork()).join();
     }
+    if (message.spanStarted !== undefined) {
+      SpanStarted.encode(message.spanStarted, writer.uint32(522).fork()).join();
+    }
+    if (message.spanEnded !== undefined) {
+      SpanEnded.encode(message.spanEnded, writer.uint32(530).fork()).join();
+    }
     return writer;
   },
 
@@ -6642,6 +6698,14 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
           message.category = reader.int32() as any;
           continue;
         }
+        case 13: {
+          if (tag !== 106) {
+            break;
+          }
+
+          message.spanId = reader.string();
+          continue;
+        }
         case 20: {
           if (tag !== 162) {
             break;
@@ -6978,6 +7042,22 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
           message.cantonTxAdded = CantonTxAdded.decode(reader, reader.uint32());
           continue;
         }
+        case 65: {
+          if (tag !== 522) {
+            break;
+          }
+
+          message.spanStarted = SpanStarted.decode(reader, reader.uint32());
+          continue;
+        }
+        case 66: {
+          if (tag !== 530) {
+            break;
+          }
+
+          message.spanEnded = SpanEnded.decode(reader, reader.uint32());
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -7023,6 +7103,11 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
         : undefined,
       source: isSet(object.source) ? eventSourceFromJSON(object.source) : 0,
       category: isSet(object.category) ? traceEventCategoryFromJSON(object.category) : 0,
+      spanId: isSet(object.spanId)
+        ? globalThis.String(object.spanId)
+        : isSet(object.span_id)
+        ? globalThis.String(object.span_id)
+        : "",
       traceStarted: isSet(object.traceStarted)
         ? TraceStarted.fromJSON(object.traceStarted)
         : isSet(object.trace_started)
@@ -7233,6 +7318,16 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
         : isSet(object.canton_tx_added)
         ? CantonTxAdded.fromJSON(object.canton_tx_added)
         : undefined,
+      spanStarted: isSet(object.spanStarted)
+        ? SpanStarted.fromJSON(object.spanStarted)
+        : isSet(object.span_started)
+        ? SpanStarted.fromJSON(object.span_started)
+        : undefined,
+      spanEnded: isSet(object.spanEnded)
+        ? SpanEnded.fromJSON(object.spanEnded)
+        : isSet(object.span_ended)
+        ? SpanEnded.fromJSON(object.span_ended)
+        : undefined,
     };
   },
 
@@ -7268,6 +7363,9 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     if (message.category !== 0) {
       obj.category = traceEventCategoryToJSON(message.category);
     }
+    if (message.spanId !== "") {
+      obj.spanId = message.spanId;
+    }
     if (message.traceStarted !== undefined) {
       obj.traceStarted = TraceStarted.toJSON(message.traceStarted);
     }
@@ -7394,6 +7492,12 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     if (message.cantonTxAdded !== undefined) {
       obj.cantonTxAdded = CantonTxAdded.toJSON(message.cantonTxAdded);
     }
+    if (message.spanStarted !== undefined) {
+      obj.spanStarted = SpanStarted.toJSON(message.spanStarted);
+    }
+    if (message.spanEnded !== undefined) {
+      obj.spanEnded = SpanEnded.toJSON(message.spanEnded);
+    }
     return obj;
   },
 
@@ -7412,6 +7516,7 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     message.traceTimestamp = object.traceTimestamp ?? undefined;
     message.source = object.source ?? 0;
     message.category = object.category ?? 0;
+    message.spanId = object.spanId ?? "";
     message.traceStarted = (object.traceStarted !== undefined && object.traceStarted !== null)
       ? TraceStarted.fromPartial(object.traceStarted)
       : undefined;
@@ -7544,6 +7649,373 @@ export const TraceEventEnvelope: MessageFns<TraceEventEnvelope> = {
     message.cantonTxAdded = (object.cantonTxAdded !== undefined && object.cantonTxAdded !== null)
       ? CantonTxAdded.fromPartial(object.cantonTxAdded)
       : undefined;
+    message.spanStarted = (object.spanStarted !== undefined && object.spanStarted !== null)
+      ? SpanStarted.fromPartial(object.spanStarted)
+      : undefined;
+    message.spanEnded = (object.spanEnded !== undefined && object.spanEnded !== null)
+      ? SpanEnded.fromPartial(object.spanEnded)
+      : undefined;
+    return message;
+  },
+};
+
+function createBaseSpanStarted(): SpanStarted {
+  return { spanId: "", parentSpanId: undefined, name: "", startTime: undefined, attributes: {} };
+}
+
+export const SpanStarted: MessageFns<SpanStarted> = {
+  encode(message: SpanStarted, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.spanId !== "") {
+      writer.uint32(10).string(message.spanId);
+    }
+    if (message.parentSpanId !== undefined) {
+      writer.uint32(18).string(message.parentSpanId);
+    }
+    if (message.name !== "") {
+      writer.uint32(26).string(message.name);
+    }
+    if (message.startTime !== undefined) {
+      Timestamp.encode(toTimestamp(message.startTime), writer.uint32(34).fork()).join();
+    }
+    globalThis.Object.entries(message.attributes).forEach(([key, value]: [string, string]) => {
+      SpanStarted_AttributesEntry.encode({ key: key as any, value }, writer.uint32(42).fork()).join();
+    });
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): SpanStarted {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSpanStarted();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.spanId = reader.string();
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+
+          message.parentSpanId = reader.string();
+          continue;
+        }
+        case 3: {
+          if (tag !== 26) {
+            break;
+          }
+
+          message.name = reader.string();
+          continue;
+        }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+
+          message.startTime = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+          continue;
+        }
+        case 5: {
+          if (tag !== 42) {
+            break;
+          }
+
+          const entry5 = SpanStarted_AttributesEntry.decode(reader, reader.uint32());
+          if (entry5.value !== undefined) {
+            message.attributes[entry5.key] = entry5.value;
+          }
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): SpanStarted {
+    return {
+      spanId: isSet(object.spanId)
+        ? globalThis.String(object.spanId)
+        : isSet(object.span_id)
+        ? globalThis.String(object.span_id)
+        : "",
+      parentSpanId: isSet(object.parentSpanId)
+        ? globalThis.String(object.parentSpanId)
+        : isSet(object.parent_span_id)
+        ? globalThis.String(object.parent_span_id)
+        : undefined,
+      name: isSet(object.name) ? globalThis.String(object.name) : "",
+      startTime: isSet(object.startTime)
+        ? fromJsonTimestamp(object.startTime)
+        : isSet(object.start_time)
+        ? fromJsonTimestamp(object.start_time)
+        : undefined,
+      attributes: isObject(object.attributes)
+        ? (globalThis.Object.entries(object.attributes) as [string, any][]).reduce(
+          (acc: { [key: string]: string }, [key, value]: [string, any]) => {
+            acc[key] = globalThis.String(value);
+            return acc;
+          },
+          {},
+        )
+        : {},
+    };
+  },
+
+  toJSON(message: SpanStarted): unknown {
+    const obj: any = {};
+    if (message.spanId !== "") {
+      obj.spanId = message.spanId;
+    }
+    if (message.parentSpanId !== undefined) {
+      obj.parentSpanId = message.parentSpanId;
+    }
+    if (message.name !== "") {
+      obj.name = message.name;
+    }
+    if (message.startTime !== undefined) {
+      obj.startTime = message.startTime.toISOString();
+    }
+    if (message.attributes) {
+      const entries = globalThis.Object.entries(message.attributes) as [string, string][];
+      if (entries.length > 0) {
+        obj.attributes = {};
+        entries.forEach(([k, v]) => {
+          obj.attributes[k] = v;
+        });
+      }
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<SpanStarted>, I>>(base?: I): SpanStarted {
+    return SpanStarted.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<SpanStarted>, I>>(object: I): SpanStarted {
+    const message = createBaseSpanStarted();
+    message.spanId = object.spanId ?? "";
+    message.parentSpanId = object.parentSpanId ?? undefined;
+    message.name = object.name ?? "";
+    message.startTime = object.startTime ?? undefined;
+    message.attributes = (globalThis.Object.entries(object.attributes ?? {}) as [string, string][]).reduce(
+      (acc: { [key: string]: string }, [key, value]: [string, string]) => {
+        if (value !== undefined) {
+          acc[key] = globalThis.String(value);
+        }
+        return acc;
+      },
+      {},
+    );
+    return message;
+  },
+};
+
+function createBaseSpanStarted_AttributesEntry(): SpanStarted_AttributesEntry {
+  return { key: "", value: "" };
+}
+
+export const SpanStarted_AttributesEntry: MessageFns<SpanStarted_AttributesEntry> = {
+  encode(message: SpanStarted_AttributesEntry, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.key !== "") {
+      writer.uint32(10).string(message.key);
+    }
+    if (message.value !== "") {
+      writer.uint32(18).string(message.value);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): SpanStarted_AttributesEntry {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSpanStarted_AttributesEntry();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.key = reader.string();
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+
+          message.value = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): SpanStarted_AttributesEntry {
+    return {
+      key: isSet(object.key) ? globalThis.String(object.key) : "",
+      value: isSet(object.value) ? globalThis.String(object.value) : "",
+    };
+  },
+
+  toJSON(message: SpanStarted_AttributesEntry): unknown {
+    const obj: any = {};
+    if (message.key !== "") {
+      obj.key = message.key;
+    }
+    if (message.value !== "") {
+      obj.value = message.value;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<SpanStarted_AttributesEntry>, I>>(base?: I): SpanStarted_AttributesEntry {
+    return SpanStarted_AttributesEntry.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<SpanStarted_AttributesEntry>, I>>(object: I): SpanStarted_AttributesEntry {
+    const message = createBaseSpanStarted_AttributesEntry();
+    message.key = object.key ?? "";
+    message.value = object.value ?? "";
+    return message;
+  },
+};
+
+function createBaseSpanEnded(): SpanEnded {
+  return { spanId: "", endTime: undefined, statusCode: undefined, statusMessage: undefined };
+}
+
+export const SpanEnded: MessageFns<SpanEnded> = {
+  encode(message: SpanEnded, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.spanId !== "") {
+      writer.uint32(10).string(message.spanId);
+    }
+    if (message.endTime !== undefined) {
+      Timestamp.encode(toTimestamp(message.endTime), writer.uint32(18).fork()).join();
+    }
+    if (message.statusCode !== undefined) {
+      writer.uint32(26).string(message.statusCode);
+    }
+    if (message.statusMessage !== undefined) {
+      writer.uint32(34).string(message.statusMessage);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): SpanEnded {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseSpanEnded();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.spanId = reader.string();
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+
+          message.endTime = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+          continue;
+        }
+        case 3: {
+          if (tag !== 26) {
+            break;
+          }
+
+          message.statusCode = reader.string();
+          continue;
+        }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+
+          message.statusMessage = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): SpanEnded {
+    return {
+      spanId: isSet(object.spanId)
+        ? globalThis.String(object.spanId)
+        : isSet(object.span_id)
+        ? globalThis.String(object.span_id)
+        : "",
+      endTime: isSet(object.endTime)
+        ? fromJsonTimestamp(object.endTime)
+        : isSet(object.end_time)
+        ? fromJsonTimestamp(object.end_time)
+        : undefined,
+      statusCode: isSet(object.statusCode)
+        ? globalThis.String(object.statusCode)
+        : isSet(object.status_code)
+        ? globalThis.String(object.status_code)
+        : undefined,
+      statusMessage: isSet(object.statusMessage)
+        ? globalThis.String(object.statusMessage)
+        : isSet(object.status_message)
+        ? globalThis.String(object.status_message)
+        : undefined,
+    };
+  },
+
+  toJSON(message: SpanEnded): unknown {
+    const obj: any = {};
+    if (message.spanId !== "") {
+      obj.spanId = message.spanId;
+    }
+    if (message.endTime !== undefined) {
+      obj.endTime = message.endTime.toISOString();
+    }
+    if (message.statusCode !== undefined) {
+      obj.statusCode = message.statusCode;
+    }
+    if (message.statusMessage !== undefined) {
+      obj.statusMessage = message.statusMessage;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<SpanEnded>, I>>(base?: I): SpanEnded {
+    return SpanEnded.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<SpanEnded>, I>>(object: I): SpanEnded {
+    const message = createBaseSpanEnded();
+    message.spanId = object.spanId ?? "";
+    message.endTime = object.endTime ?? undefined;
+    message.statusCode = object.statusCode ?? undefined;
+    message.statusMessage = object.statusMessage ?? undefined;
     return message;
   },
 };