@miradorlabs/web-grpc 3.36.1 → 3.38.0

package/package.json

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

@@ -551,6 +551,49 @@ export function aIResourceDimensionToJSON(object: AIResourceDimension): string {
   }
 }
 
+/**
+ * AIResourceRankingGroupBy mirrors telemetry.api.v1.AIResourceRankingGroupBy. Unspecified ranks the whole
+ * filtered set once.
+ */
+export enum AIResourceRankingGroupBy {
+  AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED = 0,
+  /**
+   * AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL - One ranking per principal on the source system that reported it, each what a request filtered to that principal's
+   * id and source returns: an event ranks under its user id and under its api key. Work that recorded neither ranks
+   * under an API_KEY principal with an empty id, which no filter selects alone (an empty api_key_ids entry also
+   * matches user-only work). SKILL / TOOL / COMMAND only.
+   */
+  AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL = 1,
+  UNRECOGNIZED = -1,
+}
+
+export function aIResourceRankingGroupByFromJSON(object: any): AIResourceRankingGroupBy {
+  switch (object) {
+    case 0:
+    case "AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED":
+      return AIResourceRankingGroupBy.AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED;
+    case 1:
+    case "AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL":
+      return AIResourceRankingGroupBy.AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return AIResourceRankingGroupBy.UNRECOGNIZED;
+  }
+}
+
+export function aIResourceRankingGroupByToJSON(object: AIResourceRankingGroupBy): string {
+  switch (object) {
+    case AIResourceRankingGroupBy.AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED:
+      return "AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED";
+    case AIResourceRankingGroupBy.AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL:
+      return "AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL";
+    case AIResourceRankingGroupBy.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
 export enum AIFileLifecycle {
   AI_FILE_LIFECYCLE_UNSPECIFIED = 0,
   AI_FILE_LIFECYCLE_UNLANDED = 1,
@@ -1918,12 +1961,21 @@ export interface ResourceRankingsRequest {
   projectId: string;
   filter: AISessionFilter | undefined;
   dimension: AIResourceDimension;
+  /** Splits the ranking into one top-limit list per group. Unspecified ranks the filtered set once. */
+  groupBy: AIResourceRankingGroupBy;
   timeWindow: AnalyticsTimeWindow;
+  /** Max rows, per group when group_by is set; 0 = the default 10, capped at 100. */
   limit: number;
 }
 
 export interface ResourceRankingsResponse {
-  status: ResponseStatus | undefined;
+  status:
+    | ResponseStatus
+    | undefined;
+  /**
+   * Ungrouped: count descending, then key. Grouped: by principal kind, id and source system, then count descending
+   * and key within each.
+   */
   rankings: ResourceRanking[];
   dimension: AIResourceDimension;
   windowStart: Date | undefined;
@@ -1936,6 +1988,11 @@ export interface ResourceRanking {
   count: number;
   priorCount: number;
   sessionCount: number;
+  /**
+   * The principal this row ranks under; set only when the request's group_by is PRINCIPAL. An event with both a user id
+   * and an api key ranks under each, unlike DailyActivity's one principal per row (user id, else api key).
+   */
+  principal: DailyActivityPrincipal | undefined;
 }
 
 export interface ModelActivityRequest {
@@ -1991,6 +2048,11 @@ export interface ModelActivityPrincipal {
   inputTokens: number;
   outputTokens: number;
   costUsd: number;
+  /**
+   * Subscription-facility slice of cost_usd, by each call's funding mode, so net = cost_usd − this per principal;
+   * absent (an older backend) means unavailable.
+   */
+  subscriptionCostUsd?: number | undefined;
 }
 
 export interface SessionUsageTrendRequest {
@@ -15258,7 +15320,7 @@ export const ProjectSessionRef: MessageFns<ProjectSessionRef> = {
 };
 
 function createBaseResourceRankingsRequest(): ResourceRankingsRequest {
-  return { organizationId: "", projectId: "", filter: undefined, dimension: 0, timeWindow: 0, limit: 0 };
+  return { organizationId: "", projectId: "", filter: undefined, dimension: 0, groupBy: 0, timeWindow: 0, limit: 0 };
 }
 
 export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
@@ -15275,6 +15337,9 @@ export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
     if (message.dimension !== 0) {
       writer.uint32(32).int32(message.dimension);
     }
+    if (message.groupBy !== 0) {
+      writer.uint32(56).int32(message.groupBy);
+    }
     if (message.timeWindow !== 0) {
       writer.uint32(40).int32(message.timeWindow);
     }
@@ -15329,6 +15394,14 @@ export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
             message.dimension = reader.int32() as any;
             continue;
           }
+          case 7: {
+            if (tag !== 56) {
+              break;
+            }
+
+            message.groupBy = reader.int32() as any;
+            continue;
+          }
           case 5: {
             if (tag !== 40) {
               break;
@@ -15371,6 +15444,11 @@ export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
         : "",
       filter: isSet(object.filter) ? AISessionFilter.fromJSON(object.filter) : undefined,
       dimension: isSet(object.dimension) ? aIResourceDimensionFromJSON(object.dimension) : 0,
+      groupBy: isSet(object.groupBy)
+        ? aIResourceRankingGroupByFromJSON(object.groupBy)
+        : isSet(object.group_by)
+        ? aIResourceRankingGroupByFromJSON(object.group_by)
+        : 0,
       timeWindow: isSet(object.timeWindow)
         ? analyticsTimeWindowFromJSON(object.timeWindow)
         : isSet(object.time_window)
@@ -15394,6 +15472,9 @@ export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
     if (message.dimension !== 0) {
       obj.dimension = aIResourceDimensionToJSON(message.dimension);
     }
+    if (message.groupBy !== 0) {
+      obj.groupBy = aIResourceRankingGroupByToJSON(message.groupBy);
+    }
     if (message.timeWindow !== 0) {
       obj.timeWindow = analyticsTimeWindowToJSON(message.timeWindow);
     }
@@ -15414,6 +15495,7 @@ export const ResourceRankingsRequest: MessageFns<ResourceRankingsRequest> = {
       ? AISessionFilter.fromPartial(object.filter)
       : undefined;
     message.dimension = object.dimension ?? 0;
+    message.groupBy = object.groupBy ?? 0;
     message.timeWindow = object.timeWindow ?? 0;
     message.limit = object.limit ?? 0;
     return message;
@@ -15593,7 +15675,7 @@ export const ResourceRankingsResponse: MessageFns<ResourceRankingsResponse> = {
 };
 
 function createBaseResourceRanking(): ResourceRanking {
-  return { key: "", count: 0, priorCount: 0, sessionCount: 0 };
+  return { key: "", count: 0, priorCount: 0, sessionCount: 0, principal: undefined };
 }
 
 export const ResourceRanking: MessageFns<ResourceRanking> = {
@@ -15610,6 +15692,9 @@ export const ResourceRanking: MessageFns<ResourceRanking> = {
     if (message.sessionCount !== 0) {
       writer.uint32(32).uint64(message.sessionCount);
     }
+    if (message.principal !== undefined) {
+      DailyActivityPrincipal.encode(message.principal, writer.uint32(42).fork()).join();
+    }
     return writer;
   },
 
@@ -15658,6 +15743,14 @@ export const ResourceRanking: MessageFns<ResourceRanking> = {
             message.sessionCount = longToNumber(reader.uint64());
             continue;
           }
+          case 5: {
+            if (tag !== 42) {
+              break;
+            }
+
+            message.principal = DailyActivityPrincipal.decode(reader, reader.uint32());
+            continue;
+          }
         }
         if ((tag & 7) === 4 || tag === 0) {
           break;
@@ -15684,6 +15777,7 @@ export const ResourceRanking: MessageFns<ResourceRanking> = {
         : isSet(object.session_count)
         ? globalThis.Number(object.session_count)
         : 0,
+      principal: isSet(object.principal) ? DailyActivityPrincipal.fromJSON(object.principal) : undefined,
     };
   },
 
@@ -15701,6 +15795,9 @@ export const ResourceRanking: MessageFns<ResourceRanking> = {
     if (message.sessionCount !== 0) {
       obj.sessionCount = Math.round(message.sessionCount);
     }
+    if (message.principal !== undefined) {
+      obj.principal = DailyActivityPrincipal.toJSON(message.principal);
+    }
     return obj;
   },
 
@@ -15713,6 +15810,9 @@ export const ResourceRanking: MessageFns<ResourceRanking> = {
     message.count = object.count ?? 0;
     message.priorCount = object.priorCount ?? 0;
     message.sessionCount = object.sessionCount ?? 0;
+    message.principal = (object.principal !== undefined && object.principal !== null)
+      ? DailyActivityPrincipal.fromPartial(object.principal)
+      : undefined;
     return message;
   },
 };
@@ -16501,7 +16601,17 @@ export const ModelActivity: MessageFns<ModelActivity> = {
 };
 
 function createBaseModelActivityPrincipal(): ModelActivityPrincipal {
-  return { kind: 0, id: "", sourceSystem: "", modelCalls: 0, sessions: 0, inputTokens: 0, outputTokens: 0, costUsd: 0 };
+  return {
+    kind: 0,
+    id: "",
+    sourceSystem: "",
+    modelCalls: 0,
+    sessions: 0,
+    inputTokens: 0,
+    outputTokens: 0,
+    costUsd: 0,
+    subscriptionCostUsd: undefined,
+  };
 }
 
 export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
@@ -16530,6 +16640,9 @@ export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
     if (message.costUsd !== 0) {
       writer.uint32(65).double(message.costUsd);
     }
+    if (message.subscriptionCostUsd !== undefined) {
+      writer.uint32(73).double(message.subscriptionCostUsd);
+    }
     return writer;
   },
 
@@ -16610,6 +16723,14 @@ export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
             message.costUsd = reader.double();
             continue;
           }
+          case 9: {
+            if (tag !== 73) {
+              break;
+            }
+
+            message.subscriptionCostUsd = reader.double();
+            continue;
+          }
         }
         if ((tag & 7) === 4 || tag === 0) {
           break;
@@ -16652,6 +16773,11 @@ export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
         : isSet(object.cost_usd)
         ? globalThis.Number(object.cost_usd)
         : 0,
+      subscriptionCostUsd: isSet(object.subscriptionCostUsd)
+        ? globalThis.Number(object.subscriptionCostUsd)
+        : isSet(object.subscription_cost_usd)
+        ? globalThis.Number(object.subscription_cost_usd)
+        : undefined,
     };
   },
 
@@ -16681,6 +16807,9 @@ export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
     if (message.costUsd !== 0) {
       obj.costUsd = floatToJson(message.costUsd);
     }
+    if (message.subscriptionCostUsd !== undefined) {
+      obj.subscriptionCostUsd = floatToJson(message.subscriptionCostUsd);
+    }
     return obj;
   },
 
@@ -16697,6 +16826,7 @@ export const ModelActivityPrincipal: MessageFns<ModelActivityPrincipal> = {
     message.inputTokens = object.inputTokens ?? 0;
     message.outputTokens = object.outputTokens ?? 0;
     message.costUsd = object.costUsd ?? 0;
+    message.subscriptionCostUsd = object.subscriptionCostUsd ?? undefined;
     return message;
   },
 };

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

@@ -49,6 +49,7 @@ goog.exportSymbol('proto.gateway.web.v1.AIGitOutcome', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AIModelPrice', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AIModelPriceFilter', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AIResourceDimension', null, global);
+goog.exportSymbol('proto.gateway.web.v1.AIResourceRankingGroupBy', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AISessionEvent', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AISessionEventEnvelope', null, global);
 goog.exportSymbol('proto.gateway.web.v1.AISessionEventEnvelope.FrameCase', null, global);
@@ -27009,6 +27010,7 @@ organizationId: jspb.Message.getFieldWithDefault(msg, 1, ""),
 projectId: jspb.Message.getFieldWithDefault(msg, 2, ""),
 filter: (f = msg.getFilter()) && proto.gateway.web.v1.AISessionFilter.toObject(includeInstance, f),
 dimension: jspb.Message.getFieldWithDefault(msg, 4, 0),
+groupBy: jspb.Message.getFieldWithDefault(msg, 7, 0),
 timeWindow: jspb.Message.getFieldWithDefault(msg, 5, 0),
 limit: jspb.Message.getFieldWithDefault(msg, 6, 0)
   };
@@ -27064,6 +27066,10 @@ proto.gateway.web.v1.ResourceRankingsRequest.deserializeBinaryFromReader = funct
       var value = /** @type {!proto.gateway.web.v1.AIResourceDimension} */ (reader.readEnum());
       msg.setDimension(value);
       break;
+    case 7:
+      var value = /** @type {!proto.gateway.web.v1.AIResourceRankingGroupBy} */ (reader.readEnum());
+      msg.setGroupBy(value);
+      break;
     case 5:
       var value = /** @type {!proto.gateway.web.v1.AnalyticsTimeWindow} */ (reader.readEnum());
       msg.setTimeWindow(value);
@@ -27130,6 +27136,13 @@ proto.gateway.web.v1.ResourceRankingsRequest.serializeBinaryToWriter = function(
       f
     );
   }
+  f = message.getGroupBy();
+  if (f !== 0.0) {
+    writer.writeEnum(
+      7,
+      f
+    );
+  }
   f = message.getTimeWindow();
   if (f !== 0.0) {
     writer.writeEnum(
@@ -27238,6 +27251,24 @@ proto.gateway.web.v1.ResourceRankingsRequest.prototype.setDimension = function(v
 };
 
 
+/**
+ * optional AIResourceRankingGroupBy group_by = 7;
+ * @return {!proto.gateway.web.v1.AIResourceRankingGroupBy}
+ */
+proto.gateway.web.v1.ResourceRankingsRequest.prototype.getGroupBy = function() {
+  return /** @type {!proto.gateway.web.v1.AIResourceRankingGroupBy} */ (jspb.Message.getFieldWithDefault(this, 7, 0));
+};
+
+
+/**
+ * @param {!proto.gateway.web.v1.AIResourceRankingGroupBy} value
+ * @return {!proto.gateway.web.v1.ResourceRankingsRequest} returns this
+ */
+proto.gateway.web.v1.ResourceRankingsRequest.prototype.setGroupBy = function(value) {
+  return jspb.Message.setProto3EnumField(this, 7, value);
+};
+
+
 /**
  * optional AnalyticsTimeWindow time_window = 5;
  * @return {!proto.gateway.web.v1.AnalyticsTimeWindow}
@@ -27703,7 +27734,8 @@ proto.gateway.web.v1.ResourceRanking.toObject = function(includeInstance, msg) {
 key: jspb.Message.getFieldWithDefault(msg, 1, ""),
 count: jspb.Message.getFieldWithDefault(msg, 2, 0),
 priorCount: jspb.Message.getFieldWithDefault(msg, 3, 0),
-sessionCount: jspb.Message.getFieldWithDefault(msg, 4, 0)
+sessionCount: jspb.Message.getFieldWithDefault(msg, 4, 0),
+principal: (f = msg.getPrincipal()) && proto.gateway.web.v1.DailyActivityPrincipal.toObject(includeInstance, f)
   };
 
   if (includeInstance) {
@@ -27756,6 +27788,11 @@ proto.gateway.web.v1.ResourceRanking.deserializeBinaryFromReader = function(msg,
       var value = /** @type {number} */ (reader.readUint64());
       msg.setSessionCount(value);
       break;
+    case 5:
+      var value = new proto.gateway.web.v1.DailyActivityPrincipal;
+      reader.readMessage(value,proto.gateway.web.v1.DailyActivityPrincipal.deserializeBinaryFromReader);
+      msg.setPrincipal(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -27813,6 +27850,14 @@ proto.gateway.web.v1.ResourceRanking.serializeBinaryToWriter = function(message,
       f
     );
   }
+  f = message.getPrincipal();
+  if (f != null) {
+    writer.writeMessage(
+      5,
+      f,
+      proto.gateway.web.v1.DailyActivityPrincipal.serializeBinaryToWriter
+    );
+  }
 };
 
 
@@ -27888,6 +27933,43 @@ proto.gateway.web.v1.ResourceRanking.prototype.setSessionCount = function(value)
 };
 
 
+/**
+ * optional DailyActivityPrincipal principal = 5;
+ * @return {?proto.gateway.web.v1.DailyActivityPrincipal}
+ */
+proto.gateway.web.v1.ResourceRanking.prototype.getPrincipal = function() {
+  return /** @type{?proto.gateway.web.v1.DailyActivityPrincipal} */ (
+    jspb.Message.getWrapperField(this, proto.gateway.web.v1.DailyActivityPrincipal, 5));
+};
+
+
+/**
+ * @param {?proto.gateway.web.v1.DailyActivityPrincipal|undefined} value
+ * @return {!proto.gateway.web.v1.ResourceRanking} returns this
+*/
+proto.gateway.web.v1.ResourceRanking.prototype.setPrincipal = function(value) {
+  return jspb.Message.setWrapperField(this, 5, value);
+};
+
+
+/**
+ * Clears the message field making it undefined.
+ * @return {!proto.gateway.web.v1.ResourceRanking} returns this
+ */
+proto.gateway.web.v1.ResourceRanking.prototype.clearPrincipal = function() {
+  return this.setPrincipal(undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.gateway.web.v1.ResourceRanking.prototype.hasPrincipal = function() {
+  return jspb.Message.getField(this, 5) != null;
+};
+
+
 
 /**
  * List of repeated fields within this message type.
@@ -29455,7 +29537,8 @@ modelCalls: jspb.Message.getFieldWithDefault(msg, 4, 0),
 sessions: jspb.Message.getFieldWithDefault(msg, 5, 0),
 inputTokens: jspb.Message.getFieldWithDefault(msg, 6, 0),
 outputTokens: jspb.Message.getFieldWithDefault(msg, 7, 0),
-costUsd: jspb.Message.getFloatingPointFieldWithDefault(msg, 8, 0.0)
+costUsd: jspb.Message.getFloatingPointFieldWithDefault(msg, 8, 0.0),
+subscriptionCostUsd: (f = jspb.Message.getOptionalFloatingPointField(msg, 9)) == null ? undefined : f
   };
 
   if (includeInstance) {
@@ -29524,6 +29607,10 @@ proto.gateway.web.v1.ModelActivityPrincipal.deserializeBinaryFromReader = functi
       var value = /** @type {number} */ (reader.readDouble());
       msg.setCostUsd(value);
       break;
+    case 9:
+      var value = /** @type {number} */ (reader.readDouble());
+      msg.setSubscriptionCostUsd(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -29609,6 +29696,13 @@ proto.gateway.web.v1.ModelActivityPrincipal.serializeBinaryToWriter = function(m
       f
     );
   }
+  f = /** @type {number} */ (jspb.Message.getField(message, 9));
+  if (f != null) {
+    writer.writeDouble(
+      9,
+      f
+    );
+  }
 };
 
 
@@ -29756,6 +29850,42 @@ proto.gateway.web.v1.ModelActivityPrincipal.prototype.setCostUsd = function(valu
 };
 
 
+/**
+ * optional double subscription_cost_usd = 9;
+ * @return {number}
+ */
+proto.gateway.web.v1.ModelActivityPrincipal.prototype.getSubscriptionCostUsd = function() {
+  return /** @type {number} */ (jspb.Message.getFloatingPointFieldWithDefault(this, 9, 0.0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.gateway.web.v1.ModelActivityPrincipal} returns this
+ */
+proto.gateway.web.v1.ModelActivityPrincipal.prototype.setSubscriptionCostUsd = function(value) {
+  return jspb.Message.setField(this, 9, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.gateway.web.v1.ModelActivityPrincipal} returns this
+ */
+proto.gateway.web.v1.ModelActivityPrincipal.prototype.clearSubscriptionCostUsd = function() {
+  return jspb.Message.setField(this, 9, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.gateway.web.v1.ModelActivityPrincipal.prototype.hasSubscriptionCostUsd = function() {
+  return jspb.Message.getField(this, 9) != null;
+};
+
+
 
 /**
  * List of repeated fields within this message type.
@@ -41369,6 +41499,14 @@ proto.gateway.web.v1.AIResourceDimension = {
   AI_RESOURCE_DIMENSION_COMMAND: 5
 };
 
+/**
+ * @enum {number}
+ */
+proto.gateway.web.v1.AIResourceRankingGroupBy = {
+  AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED: 0,
+  AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL: 1
+};
+
 /**
  * @enum {number}
  */