@miradorlabs/web-grpc 2.22.0 → 2.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miradorlabs/web-grpc",
-  "version": "2.22.0",
+  "version": "2.24.0",
   "description": "Generated gRPC (grpc-js) client stubs for the Mirador web gateway.",
   "main": "index.js",
   "types": "index.d.ts",

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

@@ -665,6 +665,18 @@ export interface Dashboard {
   updatedAt: Date | undefined;
 }
 
+/**
+ * WidgetQuery is one query in a widget. Today the only query language is PromQL
+ * (the native `histogram_quantile(q, rate(m[w]))` and classic
+ * `histogram_quantile(q, sum by (le)(rate(m_bucket[w])))` histogram idioms are
+ * the same language — the metric store serves both series shapes). The oneof
+ * leaves room for other query types (a structured builder, log/trace queries)
+ * without reshaping the widget.
+ */
+export interface WidgetQuery {
+  promql?: string | undefined;
+}
+
 export interface Widget {
   /**
    * Client-generated, [A-Za-z0-9_-]{1,64}, unique within the dashboard — the
@@ -677,11 +689,13 @@ export interface Widget {
     | GridPos
     | undefined;
   /**
-   * Data queries. TIMESERIES 1-4 (one plotted series set per query), STAT and
-   * PIE exactly 1, TABLE 1-4 (one column per query), MARKDOWN none.
-   * STAT, PIE, and TABLE queries run with a single whole-range bucket.
+   * Queries. TIMESERIES 1-4 (one plotted series set per query, evaluated as a
+   * range query over the effective window), STAT and PIE exactly 1, TABLE 1-4
+   * (one column per query). MARKDOWN none. STAT/PIE/TABLE evaluate the query
+   * instantly at the range end (write range aggregation into the PromQL, e.g.
+   * sum(rate(m[1h]))).
    */
-  queries: MetricQuery[];
+  queries: WidgetQuery[];
   /** UNSPECIFIED = follow the view (stream override or dashboard default). */
   timeWindow: AnalyticsTimeWindow;
   /** UNSPECIFIED = server-derived from the effective range. TIMESERIES only. */
@@ -3258,6 +3272,64 @@ export const Dashboard: MessageFns<Dashboard> = {
   },
 };
 
+function createBaseWidgetQuery(): WidgetQuery {
+  return { promql: undefined };
+}
+
+export const WidgetQuery: MessageFns<WidgetQuery> = {
+  encode(message: WidgetQuery, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.promql !== undefined) {
+      writer.uint32(10).string(message.promql);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): WidgetQuery {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseWidgetQuery();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.promql = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): WidgetQuery {
+    return { promql: isSet(object.promql) ? globalThis.String(object.promql) : undefined };
+  },
+
+  toJSON(message: WidgetQuery): unknown {
+    const obj: any = {};
+    if (message.promql !== undefined) {
+      obj.promql = message.promql;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<WidgetQuery>, I>>(base?: I): WidgetQuery {
+    return WidgetQuery.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<WidgetQuery>, I>>(object: I): WidgetQuery {
+    const message = createBaseWidgetQuery();
+    message.promql = object.promql ?? undefined;
+    return message;
+  },
+};
+
 function createBaseWidget(): Widget {
   return {
     id: "",
@@ -3287,7 +3359,7 @@ export const Widget: MessageFns<Widget> = {
       GridPos.encode(message.gridPos, writer.uint32(34).fork()).join();
     }
     for (const v of message.queries) {
-      MetricQuery.encode(v!, writer.uint32(42).fork()).join();
+      WidgetQuery.encode(v!, writer.uint32(42).fork()).join();
     }
     if (message.timeWindow !== 0) {
       writer.uint32(48).int32(message.timeWindow);
@@ -3348,7 +3420,7 @@ export const Widget: MessageFns<Widget> = {
             break;
           }
 
-          message.queries.push(MetricQuery.decode(reader, reader.uint32()));
+          message.queries.push(WidgetQuery.decode(reader, reader.uint32()));
           continue;
         }
         case 6: {
@@ -3402,7 +3474,7 @@ export const Widget: MessageFns<Widget> = {
         : isSet(object.grid_pos)
         ? GridPos.fromJSON(object.grid_pos)
         : undefined,
-      queries: globalThis.Array.isArray(object?.queries) ? object.queries.map((e: any) => MetricQuery.fromJSON(e)) : [],
+      queries: globalThis.Array.isArray(object?.queries) ? object.queries.map((e: any) => WidgetQuery.fromJSON(e)) : [],
       timeWindow: isSet(object.timeWindow)
         ? analyticsTimeWindowFromJSON(object.timeWindow)
         : isSet(object.time_window)
@@ -3437,7 +3509,7 @@ export const Widget: MessageFns<Widget> = {
       obj.gridPos = GridPos.toJSON(message.gridPos);
     }
     if (message.queries?.length) {
-      obj.queries = message.queries.map((e) => MetricQuery.toJSON(e));
+      obj.queries = message.queries.map((e) => WidgetQuery.toJSON(e));
     }
     if (message.timeWindow !== 0) {
       obj.timeWindow = analyticsTimeWindowToJSON(message.timeWindow);
@@ -3465,7 +3537,7 @@ export const Widget: MessageFns<Widget> = {
     message.gridPos = (object.gridPos !== undefined && object.gridPos !== null)
       ? GridPos.fromPartial(object.gridPos)
       : undefined;
-    message.queries = object.queries?.map((e) => MetricQuery.fromPartial(e)) || [];
+    message.queries = object.queries?.map((e) => WidgetQuery.fromPartial(e)) || [];
     message.timeWindow = object.timeWindow ?? 0;
     message.timeInterval = object.timeInterval ?? 0;
     message.timeseriesStyle = object.timeseriesStyle ?? 0;

package/proto/gateway/web/v1/metric_gateway_pb.js

@@ -78,6 +78,8 @@ goog.exportSymbol('proto.gateway.web.v1.TimeseriesStyle', null, global);
 goog.exportSymbol('proto.gateway.web.v1.UpdateDashboardRequest', null, global);
 goog.exportSymbol('proto.gateway.web.v1.UpdateDashboardResponse', null, global);
 goog.exportSymbol('proto.gateway.web.v1.Widget', null, global);
+goog.exportSymbol('proto.gateway.web.v1.WidgetQuery', null, global);
+goog.exportSymbol('proto.gateway.web.v1.WidgetQuery.QueryCase', null, global);
 goog.exportSymbol('proto.gateway.web.v1.WidgetQueryError', null, global);
 goog.exportSymbol('proto.gateway.web.v1.WidgetType', null, global);
 /**
@@ -563,6 +565,27 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.gateway.web.v1.Dashboard.displayName = 'proto.gateway.web.v1.Dashboard';
 }
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.gateway.web.v1.WidgetQuery = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, proto.gateway.web.v1.WidgetQuery.oneofGroups_);
+};
+goog.inherits(proto.gateway.web.v1.WidgetQuery, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.gateway.web.v1.WidgetQuery.displayName = 'proto.gateway.web.v1.WidgetQuery';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -6051,6 +6074,179 @@ proto.gateway.web.v1.Dashboard.prototype.hasUpdatedAt = function() {
 
 
 
+/**
+ * Oneof group definitions for this message. Each group defines the field
+ * numbers belonging to that group. When of these fields' value is set, all
+ * other fields in the group are cleared. During deserialization, if multiple
+ * fields are encountered for a group, only the last value seen will be kept.
+ * @private {!Array<!Array<number>>}
+ * @const
+ */
+proto.gateway.web.v1.WidgetQuery.oneofGroups_ = [[1]];
+
+/**
+ * @enum {number}
+ */
+proto.gateway.web.v1.WidgetQuery.QueryCase = {
+  QUERY_NOT_SET: 0,
+  PROMQL: 1
+};
+
+/**
+ * @return {proto.gateway.web.v1.WidgetQuery.QueryCase}
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.getQueryCase = function() {
+  return /** @type {proto.gateway.web.v1.WidgetQuery.QueryCase} */(jspb.Message.computeOneofCase(this, proto.gateway.web.v1.WidgetQuery.oneofGroups_[0]));
+};
+
+
+
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.toObject = function(opt_includeInstance) {
+  return proto.gateway.web.v1.WidgetQuery.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.gateway.web.v1.WidgetQuery} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.gateway.web.v1.WidgetQuery.toObject = function(includeInstance, msg) {
+  var f, obj = {
+promql: (f = jspb.Message.getField(msg, 1)) == null ? undefined : f
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.gateway.web.v1.WidgetQuery}
+ */
+proto.gateway.web.v1.WidgetQuery.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.gateway.web.v1.WidgetQuery;
+  return proto.gateway.web.v1.WidgetQuery.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.gateway.web.v1.WidgetQuery} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.gateway.web.v1.WidgetQuery}
+ */
+proto.gateway.web.v1.WidgetQuery.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setPromql(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.gateway.web.v1.WidgetQuery.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.gateway.web.v1.WidgetQuery} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.gateway.web.v1.WidgetQuery.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = /** @type {string} */ (jspb.Message.getField(message, 1));
+  if (f != null) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string promql = 1;
+ * @return {string}
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.getPromql = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.gateway.web.v1.WidgetQuery} returns this
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.setPromql = function(value) {
+  return jspb.Message.setOneofField(this, 1, proto.gateway.web.v1.WidgetQuery.oneofGroups_[0], value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.gateway.web.v1.WidgetQuery} returns this
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.clearPromql = function() {
+  return jspb.Message.setOneofField(this, 1, proto.gateway.web.v1.WidgetQuery.oneofGroups_[0], undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.gateway.web.v1.WidgetQuery.prototype.hasPromql = function() {
+  return jspb.Message.getField(this, 1) != null;
+};
+
+
+
 /**
  * List of repeated fields within this message type.
  * @private {!Array<number>}
@@ -6094,7 +6290,7 @@ name: jspb.Message.getFieldWithDefault(msg, 2, ""),
 type: jspb.Message.getFieldWithDefault(msg, 3, 0),
 gridPos: (f = msg.getGridPos()) && proto.gateway.web.v1.GridPos.toObject(includeInstance, f),
 queriesList: jspb.Message.toObjectList(msg.getQueriesList(),
-    proto.gateway.web.v1.MetricQuery.toObject, includeInstance),
+    proto.gateway.web.v1.WidgetQuery.toObject, includeInstance),
 timeWindow: jspb.Message.getFieldWithDefault(msg, 6, 0),
 timeInterval: jspb.Message.getFieldWithDefault(msg, 7, 0),
 timeseriesStyle: jspb.Message.getFieldWithDefault(msg, 8, 0),
@@ -6153,8 +6349,8 @@ proto.gateway.web.v1.Widget.deserializeBinaryFromReader = function(msg, reader)
       msg.setGridPos(value);
       break;
     case 5:
-      var value = new proto.gateway.web.v1.MetricQuery;
-      reader.readMessage(value,proto.gateway.web.v1.MetricQuery.deserializeBinaryFromReader);
+      var value = new proto.gateway.web.v1.WidgetQuery;
+      reader.readMessage(value,proto.gateway.web.v1.WidgetQuery.deserializeBinaryFromReader);
       msg.addQueries(value);
       break;
     case 6:
@@ -6236,7 +6432,7 @@ proto.gateway.web.v1.Widget.serializeBinaryToWriter = function(message, writer)
     writer.writeRepeatedMessage(
       5,
       f,
-      proto.gateway.web.v1.MetricQuery.serializeBinaryToWriter
+      proto.gateway.web.v1.WidgetQuery.serializeBinaryToWriter
     );
   }
   f = message.getTimeWindow();
@@ -6362,17 +6558,17 @@ proto.gateway.web.v1.Widget.prototype.hasGridPos = function() {
 
 
 /**
- * repeated MetricQuery queries = 5;
- * @return {!Array<!proto.gateway.web.v1.MetricQuery>}
+ * repeated WidgetQuery queries = 5;
+ * @return {!Array<!proto.gateway.web.v1.WidgetQuery>}
  */
 proto.gateway.web.v1.Widget.prototype.getQueriesList = function() {
-  return /** @type{!Array<!proto.gateway.web.v1.MetricQuery>} */ (
-    jspb.Message.getRepeatedWrapperField(this, proto.gateway.web.v1.MetricQuery, 5));
+  return /** @type{!Array<!proto.gateway.web.v1.WidgetQuery>} */ (
+    jspb.Message.getRepeatedWrapperField(this, proto.gateway.web.v1.WidgetQuery, 5));
 };
 
 
 /**
- * @param {!Array<!proto.gateway.web.v1.MetricQuery>} value
+ * @param {!Array<!proto.gateway.web.v1.WidgetQuery>} value
  * @return {!proto.gateway.web.v1.Widget} returns this
 */
 proto.gateway.web.v1.Widget.prototype.setQueriesList = function(value) {
@@ -6381,12 +6577,12 @@ proto.gateway.web.v1.Widget.prototype.setQueriesList = function(value) {
 
 
 /**
- * @param {!proto.gateway.web.v1.MetricQuery=} opt_value
+ * @param {!proto.gateway.web.v1.WidgetQuery=} opt_value
  * @param {number=} opt_index
- * @return {!proto.gateway.web.v1.MetricQuery}
+ * @return {!proto.gateway.web.v1.WidgetQuery}
  */
 proto.gateway.web.v1.Widget.prototype.addQueries = function(opt_value, opt_index) {
-  return jspb.Message.addToRepeatedWrapperField(this, 5, opt_value, proto.gateway.web.v1.MetricQuery, opt_index);
+  return jspb.Message.addToRepeatedWrapperField(this, 5, opt_value, proto.gateway.web.v1.WidgetQuery, opt_index);
 };