@miradorlabs/web-grpc 2.36.0 → 2.37.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miradorlabs/web-grpc",
-  "version": "2.36.0",
+  "version": "2.37.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/derived_metric_gateway.ts

@@ -171,11 +171,14 @@ export interface DerivedMetric {
 export interface DerivedMetricProgram {
   /**
    * Selects which finished traces CONTRIBUTE -- eligibility, never success. A success condition here
-   * would emit only the good traces and leave any ratio over them at 100% forever. Immutable after
-   * create; empty matches every finished trace.
+   * would emit only the good traces and leave any ratio over them at 100% forever. Editable in place
+   * via UpdateDerivedMetric (forward-only); empty matches every finished trace.
    */
   populationExpression: string;
-  /** Evaluates to a number, or to an empty optional meaning no sample. */
+  /**
+   * Evaluates to a number, or to an empty optional meaning no sample. Editable in place via
+   * UpdateDerivedMetric (forward-only).
+   */
   valueExpression: string;
   /**
    * Trace attribute keys stamped onto every emitted point, so any dashboard widget can group or
@@ -234,14 +237,19 @@ export interface UpdateDerivedMetricRequest {
 
 export interface UpdateDerivedMetricRequest_DerivedMetricUpdates {
   displayName?: string | undefined;
-  description?:
-    | string
+  description?: string | undefined;
+  enabled?:
+    | boolean
     | undefined;
   /**
-   * The measurement (population, value, dimensions, unit, slug) is immutable -- changing it
-   * means a new metric.
+   * population_expression and value_expression are editable in place (the slug, and therefore the
+   * series identity, is preserved). Editing is forward-only: new finished traces derive under the
+   * new program immediately; already-emitted points are only corrected if their trace re-settles.
+   * dimensions, unit and slug stay immutable -- changing those rewrites series identity, so they
+   * still mean a new metric. optional so unset != cleared (an empty population matches every trace).
    */
-  enabled?: boolean | undefined;
+  populationExpression?: string | undefined;
+  valueExpression?: string | undefined;
 }
 
 export interface UpdateDerivedMetricResponse {
@@ -1564,7 +1572,13 @@ export const UpdateDerivedMetricRequest: MessageFns<UpdateDerivedMetricRequest>
 };
 
 function createBaseUpdateDerivedMetricRequest_DerivedMetricUpdates(): UpdateDerivedMetricRequest_DerivedMetricUpdates {
-  return { displayName: undefined, description: undefined, enabled: undefined };
+  return {
+    displayName: undefined,
+    description: undefined,
+    enabled: undefined,
+    populationExpression: undefined,
+    valueExpression: undefined,
+  };
 }
 
 export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
@@ -1583,6 +1597,12 @@ export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
     if (message.enabled !== undefined) {
       writer.uint32(24).bool(message.enabled);
     }
+    if (message.populationExpression !== undefined) {
+      writer.uint32(34).string(message.populationExpression);
+    }
+    if (message.valueExpression !== undefined) {
+      writer.uint32(42).string(message.valueExpression);
+    }
     return writer;
   },
 
@@ -1623,6 +1643,22 @@ export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
             message.enabled = reader.bool();
             continue;
           }
+          case 4: {
+            if (tag !== 34) {
+              break;
+            }
+
+            message.populationExpression = reader.string();
+            continue;
+          }
+          case 5: {
+            if (tag !== 42) {
+              break;
+            }
+
+            message.valueExpression = reader.string();
+            continue;
+          }
         }
         if ((tag & 7) === 4 || tag === 0) {
           break;
@@ -1644,6 +1680,16 @@ export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
         : undefined,
       description: isSet(object.description) ? globalThis.String(object.description) : undefined,
       enabled: isSet(object.enabled) ? globalThis.Boolean(object.enabled) : undefined,
+      populationExpression: isSet(object.populationExpression)
+        ? globalThis.String(object.populationExpression)
+        : isSet(object.population_expression)
+        ? globalThis.String(object.population_expression)
+        : undefined,
+      valueExpression: isSet(object.valueExpression)
+        ? globalThis.String(object.valueExpression)
+        : isSet(object.value_expression)
+        ? globalThis.String(object.value_expression)
+        : undefined,
     };
   },
 
@@ -1658,6 +1704,12 @@ export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
     if (message.enabled !== undefined) {
       obj.enabled = message.enabled;
     }
+    if (message.populationExpression !== undefined) {
+      obj.populationExpression = message.populationExpression;
+    }
+    if (message.valueExpression !== undefined) {
+      obj.valueExpression = message.valueExpression;
+    }
     return obj;
   },
 
@@ -1673,6 +1725,8 @@ export const UpdateDerivedMetricRequest_DerivedMetricUpdates: MessageFns<
     message.displayName = object.displayName ?? undefined;
     message.description = object.description ?? undefined;
     message.enabled = object.enabled ?? undefined;
+    message.populationExpression = object.populationExpression ?? undefined;
+    message.valueExpression = object.valueExpression ?? undefined;
     return message;
   },
 };

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

@@ -2755,7 +2755,9 @@ proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.toObject =
   var f, obj = {
 displayName: (f = jspb.Message.getField(msg, 1)) == null ? undefined : f,
 description: (f = jspb.Message.getField(msg, 2)) == null ? undefined : f,
-enabled: (f = jspb.Message.getBooleanField(msg, 3)) == null ? undefined : f
+enabled: (f = jspb.Message.getBooleanField(msg, 3)) == null ? undefined : f,
+populationExpression: (f = jspb.Message.getField(msg, 4)) == null ? undefined : f,
+valueExpression: (f = jspb.Message.getField(msg, 5)) == null ? undefined : f
   };
 
   if (includeInstance) {
@@ -2804,6 +2806,14 @@ proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.deserialize
       var value = /** @type {boolean} */ (reader.readBool());
       msg.setEnabled(value);
       break;
+    case 4:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setPopulationExpression(value);
+      break;
+    case 5:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setValueExpression(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -2854,6 +2864,20 @@ proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.serializeBi
       f
     );
   }
+  f = /** @type {string} */ (jspb.Message.getField(message, 4));
+  if (f != null) {
+    writer.writeString(
+      4,
+      f
+    );
+  }
+  f = /** @type {string} */ (jspb.Message.getField(message, 5));
+  if (f != null) {
+    writer.writeString(
+      5,
+      f
+    );
+  }
 };
 
 
@@ -2965,6 +2989,78 @@ proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.h
 };
 
 
+/**
+ * optional string population_expression = 4;
+ * @return {string}
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.getPopulationExpression = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 4, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates} returns this
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.setPopulationExpression = function(value) {
+  return jspb.Message.setField(this, 4, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates} returns this
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.clearPopulationExpression = function() {
+  return jspb.Message.setField(this, 4, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.hasPopulationExpression = function() {
+  return jspb.Message.getField(this, 4) != null;
+};
+
+
+/**
+ * optional string value_expression = 5;
+ * @return {string}
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.getValueExpression = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 5, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates} returns this
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.setValueExpression = function(value) {
+  return jspb.Message.setField(this, 5, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates} returns this
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.clearValueExpression = function() {
+  return jspb.Message.setField(this, 5, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.gateway.web.v1.UpdateDerivedMetricRequest.DerivedMetricUpdates.prototype.hasValueExpression = function() {
+  return jspb.Message.getField(this, 5) != null;
+};
+
+
 /**
  * optional string organization_id = 1;
  * @return {string}