@miradorlabs/web-grpc 3.13.0 → 3.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miradorlabs/web-grpc",
-  "version": "3.13.0",
+  "version": "3.14.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

@@ -25,23 +25,24 @@ import {
 export const protobufPackage = "gateway.web.v1";
 
 /**
- * SessionSort ranks the conversation catalog (RECENCY = max last activity; the rest
- * are summed conversation totals).
+ * SessionSort ranks the conversation catalog, descending. Unspecified is RECENCY. RECENCY is the last activity;
+ * the rest are summed conversation totals. source_system, then session_id, breaks ties.
  */
 export enum SessionSort {
-  SESSION_SORT_RECENCY = 0,
+  SESSION_SORT_UNSPECIFIED = 0,
   SESSION_SORT_COST = 1,
   SESSION_SORT_TOKENS = 2,
   SESSION_SORT_TURNS = 3,
   SESSION_SORT_TOOLS = 4,
+  SESSION_SORT_RECENCY = 5,
   UNRECOGNIZED = -1,
 }
 
 export function sessionSortFromJSON(object: any): SessionSort {
   switch (object) {
     case 0:
-    case "SESSION_SORT_RECENCY":
-      return SessionSort.SESSION_SORT_RECENCY;
+    case "SESSION_SORT_UNSPECIFIED":
+      return SessionSort.SESSION_SORT_UNSPECIFIED;
     case 1:
     case "SESSION_SORT_COST":
       return SessionSort.SESSION_SORT_COST;
@@ -54,6 +55,9 @@ export function sessionSortFromJSON(object: any): SessionSort {
     case 4:
     case "SESSION_SORT_TOOLS":
       return SessionSort.SESSION_SORT_TOOLS;
+    case 5:
+    case "SESSION_SORT_RECENCY":
+      return SessionSort.SESSION_SORT_RECENCY;
     case -1:
     case "UNRECOGNIZED":
     default:
@@ -63,8 +67,8 @@ export function sessionSortFromJSON(object: any): SessionSort {
 
 export function sessionSortToJSON(object: SessionSort): string {
   switch (object) {
-    case SessionSort.SESSION_SORT_RECENCY:
-      return "SESSION_SORT_RECENCY";
+    case SessionSort.SESSION_SORT_UNSPECIFIED:
+      return "SESSION_SORT_UNSPECIFIED";
     case SessionSort.SESSION_SORT_COST:
       return "SESSION_SORT_COST";
     case SessionSort.SESSION_SORT_TOKENS:
@@ -73,6 +77,8 @@ export function sessionSortToJSON(object: SessionSort): string {
       return "SESSION_SORT_TURNS";
     case SessionSort.SESSION_SORT_TOOLS:
       return "SESSION_SORT_TOOLS";
+    case SessionSort.SESSION_SORT_RECENCY:
+      return "SESSION_SORT_RECENCY";
     case SessionSort.UNRECOGNIZED:
     default:
       return "UNRECOGNIZED";
@@ -778,19 +784,57 @@ export function aIEntitlementRoleToJSON(object: AIEntitlementRole): string {
 export interface ListSessionsRequest {
   organizationId: string;
   projectId: string;
-  /**
-   * Structured filter, built directly by the frontend (AIP-160 is a REST
-   * api-gateway concern and never reaches this proto).
-   */
+  /** Built directly by the frontend (AIP-160 is a REST api-gateway concern and never reaches this proto). */
   filter:
-    | AISessionFilter
+    | SessionFilter
     | undefined;
+  /** Ranking; unspecified is SESSION_SORT_RECENCY. */
+  sort: SessionSort;
   /** 1-indexed page; server default when 0. */
   page: number;
   /** 1..1000; server default when 0. */
   perPage: number;
-  /** Ranking; SESSION_SORT_RECENCY when unset. */
-  sort: SessionSort;
+}
+
+/**
+ * SessionFilter narrows ListSessions. Fields AND; a repeated field matches any of its values; an unset or
+ * empty field does not filter. search, search_principals and search_stored_names are one search: a session
+ * matches it when any of them does. It takes ids and stored names, never display names: the caller resolves
+ * those (principal labels, ReferenceGatewayService display names). clients, principals, search_principals and
+ * search_stored_names hold at most 500 entries each.
+ */
+export interface SessionFilter {
+  /** Exact source systems. */
+  sourceSystems: string[];
+  /** A user id or api key id on any of the conversation's events. */
+  userIds: string[];
+  apiKeyIds: string[];
+  /**
+   * Stored model, provider and effort names on any of the conversation's calls; "" in efforts matches a call
+   * that reported no effort.
+   */
+  models: string[];
+  providers: string[];
+  /** Conversations active at or after this instant (the period selector). */
+  activeAfter: Date | undefined;
+  efforts: string[];
+  /** The conversation's client apps. */
+  clients: string[];
+  /**
+   * The conversation's actor (its user id, else its api key id, as the summary shows it). A user matches its
+   * user id, an api key only a conversation with no user id, an empty id one with neither; each on its source
+   * system when one is given.
+   */
+  principals: DailyActivityPrincipal[];
+  /**
+   * Case-insensitive substring of the session id, provider session id, title, source system, actor user id
+   * and api key id, or any stored model, provider, effort, client, client version or repository.
+   */
+  search: string;
+  /** Principals whose label the caller matched to the search text, matched by principals' rule. */
+  searchPrincipals: DailyActivityPrincipal[];
+  /** Stored model, provider or effort names whose display name the caller matched to the search text. */
+  searchStoredNames: string[];
 }
 
 /**
@@ -817,14 +861,16 @@ export interface ListSessionsResponse {
   pagination: SessionPagination | undefined;
 }
 
-/**
- * SessionPagination describes the returned page; total / total_pages are best-effort
- * (a second count query), weakly consistent with the page.
- */
+/** SessionPagination describes the returned page. */
 export interface SessionPagination {
   page: number;
   perPage: number;
-  total: number;
+  /**
+   * The conversations matching the filter. A short non-empty (or first) page is the tail and counts itself; a
+   * full page, or an empty one past the first, runs a second count query, weakly consistent with the page
+   * under concurrent writes. total_pages follows from it.
+   */
+  totalCount: number;
   totalPages: number;
 }
 
@@ -885,7 +931,7 @@ export interface AISessionSummary {
 export interface StreamSessionsRequest {
   organizationId: string;
   projectId: string;
-  /** Same structured filter as ListSessions. */
+  /** ListSessions' conversation fields; clients, principals and search are ListSessions-only. */
   filter:
     | AISessionFilter
     | undefined;
@@ -1429,7 +1475,9 @@ export interface DailyActivityRequest_Filter {
 
 /** DailyActivityPrincipal is one user id or api key, as one source system reported it (empty = any source). */
 export interface DailyActivityPrincipal {
+  /** USER or API_KEY; anything else is rejected. */
   kind: AIPrincipalKind;
+  /** Empty selects work that recorded neither a user id nor an api key. */
   id: string;
   sourceSystem: string;
 }
@@ -1987,7 +2035,7 @@ export interface EntitlementWindow {
 }
 
 function createBaseListSessionsRequest(): ListSessionsRequest {
-  return { organizationId: "", projectId: "", filter: undefined, page: 0, perPage: 0, sort: 0 };
+  return { organizationId: "", projectId: "", filter: undefined, sort: 0, page: 0, perPage: 0 };
 }
 
 export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
@@ -1999,7 +2047,10 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
       writer.uint32(18).string(message.projectId);
     }
     if (message.filter !== undefined) {
-      AISessionFilter.encode(message.filter, writer.uint32(26).fork()).join();
+      SessionFilter.encode(message.filter, writer.uint32(26).fork()).join();
+    }
+    if (message.sort !== 0) {
+      writer.uint32(48).int32(message.sort);
     }
     if (message.page !== 0) {
       writer.uint32(32).int32(message.page);
@@ -2007,9 +2058,6 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
     if (message.perPage !== 0) {
       writer.uint32(40).int32(message.perPage);
     }
-    if (message.sort !== 0) {
-      writer.uint32(48).int32(message.sort);
-    }
     return writer;
   },
 
@@ -2047,7 +2095,15 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
               break;
             }
 
-            message.filter = AISessionFilter.decode(reader, reader.uint32());
+            message.filter = SessionFilter.decode(reader, reader.uint32());
+            continue;
+          }
+          case 6: {
+            if (tag !== 48) {
+              break;
+            }
+
+            message.sort = reader.int32() as any;
             continue;
           }
           case 4: {
@@ -2066,14 +2122,6 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
             message.perPage = reader.int32();
             continue;
           }
-          case 6: {
-            if (tag !== 48) {
-              break;
-            }
-
-            message.sort = reader.int32() as any;
-            continue;
-          }
         }
         if ((tag & 7) === 4 || tag === 0) {
           break;
@@ -2098,14 +2146,14 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
         : isSet(object.project_id)
         ? globalThis.String(object.project_id)
         : "",
-      filter: isSet(object.filter) ? AISessionFilter.fromJSON(object.filter) : undefined,
+      filter: isSet(object.filter) ? SessionFilter.fromJSON(object.filter) : undefined,
+      sort: isSet(object.sort) ? sessionSortFromJSON(object.sort) : 0,
       page: isSet(object.page) ? globalThis.Number(object.page) : 0,
       perPage: isSet(object.perPage)
         ? globalThis.Number(object.perPage)
         : isSet(object.per_page)
         ? globalThis.Number(object.per_page)
         : 0,
-      sort: isSet(object.sort) ? sessionSortFromJSON(object.sort) : 0,
     };
   },
 
@@ -2118,7 +2166,10 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
       obj.projectId = message.projectId;
     }
     if (message.filter !== undefined) {
-      obj.filter = AISessionFilter.toJSON(message.filter);
+      obj.filter = SessionFilter.toJSON(message.filter);
+    }
+    if (message.sort !== 0) {
+      obj.sort = sessionSortToJSON(message.sort);
     }
     if (message.page !== 0) {
       obj.page = Math.round(message.page);
@@ -2126,9 +2177,6 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
     if (message.perPage !== 0) {
       obj.perPage = Math.round(message.perPage);
     }
-    if (message.sort !== 0) {
-      obj.sort = sessionSortToJSON(message.sort);
-    }
     return obj;
   },
 
@@ -2140,11 +2188,299 @@ export const ListSessionsRequest: MessageFns<ListSessionsRequest> = {
     message.organizationId = object.organizationId ?? "";
     message.projectId = object.projectId ?? "";
     message.filter = (object.filter !== undefined && object.filter !== null)
-      ? AISessionFilter.fromPartial(object.filter)
+      ? SessionFilter.fromPartial(object.filter)
       : undefined;
+    message.sort = object.sort ?? 0;
     message.page = object.page ?? 0;
     message.perPage = object.perPage ?? 0;
-    message.sort = object.sort ?? 0;
+    return message;
+  },
+};
+
+function createBaseSessionFilter(): SessionFilter {
+  return {
+    sourceSystems: [],
+    userIds: [],
+    apiKeyIds: [],
+    models: [],
+    providers: [],
+    activeAfter: undefined,
+    efforts: [],
+    clients: [],
+    principals: [],
+    search: "",
+    searchPrincipals: [],
+    searchStoredNames: [],
+  };
+}
+
+export const SessionFilter: MessageFns<SessionFilter> = {
+  encode(message: SessionFilter, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    for (const v of message.sourceSystems) {
+      writer.uint32(10).string(v!);
+    }
+    for (const v of message.userIds) {
+      writer.uint32(18).string(v!);
+    }
+    for (const v of message.apiKeyIds) {
+      writer.uint32(26).string(v!);
+    }
+    for (const v of message.models) {
+      writer.uint32(34).string(v!);
+    }
+    for (const v of message.providers) {
+      writer.uint32(42).string(v!);
+    }
+    if (message.activeAfter !== undefined) {
+      Timestamp.encode(toTimestamp(message.activeAfter), writer.uint32(50).fork()).join();
+    }
+    for (const v of message.efforts) {
+      writer.uint32(58).string(v!);
+    }
+    for (const v of message.clients) {
+      writer.uint32(66).string(v!);
+    }
+    for (const v of message.principals) {
+      DailyActivityPrincipal.encode(v!, writer.uint32(74).fork()).join();
+    }
+    if (message.search !== "") {
+      writer.uint32(82).string(message.search);
+    }
+    for (const v of message.searchPrincipals) {
+      DailyActivityPrincipal.encode(v!, writer.uint32(90).fork()).join();
+    }
+    for (const v of message.searchStoredNames) {
+      writer.uint32(98).string(v!);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): SessionFilter {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const previousRecursionDepth = (reader as any).__tsProtoDecodeDepth ?? 0;
+    if (previousRecursionDepth >= 100) {
+      throw new globalThis.Error("protobuf decode recursion limit exceeded");
+    }
+    (reader as any).__tsProtoDecodeDepth = previousRecursionDepth + 1;
+    try {
+      const end = length === undefined ? reader.len : reader.pos + length;
+      const message = createBaseSessionFilter();
+      while (reader.pos < end) {
+        const tag = reader.uint32();
+        switch (tag >>> 3) {
+          case 1: {
+            if (tag !== 10) {
+              break;
+            }
+
+            message.sourceSystems.push(reader.string());
+            continue;
+          }
+          case 2: {
+            if (tag !== 18) {
+              break;
+            }
+
+            message.userIds.push(reader.string());
+            continue;
+          }
+          case 3: {
+            if (tag !== 26) {
+              break;
+            }
+
+            message.apiKeyIds.push(reader.string());
+            continue;
+          }
+          case 4: {
+            if (tag !== 34) {
+              break;
+            }
+
+            message.models.push(reader.string());
+            continue;
+          }
+          case 5: {
+            if (tag !== 42) {
+              break;
+            }
+
+            message.providers.push(reader.string());
+            continue;
+          }
+          case 6: {
+            if (tag !== 50) {
+              break;
+            }
+
+            message.activeAfter = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+            continue;
+          }
+          case 7: {
+            if (tag !== 58) {
+              break;
+            }
+
+            message.efforts.push(reader.string());
+            continue;
+          }
+          case 8: {
+            if (tag !== 66) {
+              break;
+            }
+
+            message.clients.push(reader.string());
+            continue;
+          }
+          case 9: {
+            if (tag !== 74) {
+              break;
+            }
+
+            message.principals.push(DailyActivityPrincipal.decode(reader, reader.uint32()));
+            continue;
+          }
+          case 10: {
+            if (tag !== 82) {
+              break;
+            }
+
+            message.search = reader.string();
+            continue;
+          }
+          case 11: {
+            if (tag !== 90) {
+              break;
+            }
+
+            message.searchPrincipals.push(DailyActivityPrincipal.decode(reader, reader.uint32()));
+            continue;
+          }
+          case 12: {
+            if (tag !== 98) {
+              break;
+            }
+
+            message.searchStoredNames.push(reader.string());
+            continue;
+          }
+        }
+        if ((tag & 7) === 4 || tag === 0) {
+          break;
+        }
+        reader.skip(tag & 7);
+      }
+      return message;
+    } finally {
+      (reader as any).__tsProtoDecodeDepth = previousRecursionDepth;
+    }
+  },
+
+  fromJSON(object: any): SessionFilter {
+    return {
+      sourceSystems: globalThis.Array.isArray(object?.sourceSystems)
+        ? object.sourceSystems.map((e: any) => globalThis.String(e))
+        : globalThis.Array.isArray(object?.source_systems)
+        ? object.source_systems.map((e: any) => globalThis.String(e))
+        : [],
+      userIds: globalThis.Array.isArray(object?.userIds)
+        ? object.userIds.map((e: any) => globalThis.String(e))
+        : globalThis.Array.isArray(object?.user_ids)
+        ? object.user_ids.map((e: any) => globalThis.String(e))
+        : [],
+      apiKeyIds: globalThis.Array.isArray(object?.apiKeyIds)
+        ? object.apiKeyIds.map((e: any) => globalThis.String(e))
+        : globalThis.Array.isArray(object?.api_key_ids)
+        ? object.api_key_ids.map((e: any) => globalThis.String(e))
+        : [],
+      models: globalThis.Array.isArray(object?.models) ? object.models.map((e: any) => globalThis.String(e)) : [],
+      providers: globalThis.Array.isArray(object?.providers)
+        ? object.providers.map((e: any) => globalThis.String(e))
+        : [],
+      activeAfter: isSet(object.activeAfter)
+        ? fromJsonTimestamp(object.activeAfter)
+        : isSet(object.active_after)
+        ? fromJsonTimestamp(object.active_after)
+        : undefined,
+      efforts: globalThis.Array.isArray(object?.efforts)
+        ? object.efforts.map((e: any) => globalThis.String(e))
+        : [],
+      clients: globalThis.Array.isArray(object?.clients) ? object.clients.map((e: any) => globalThis.String(e)) : [],
+      principals: globalThis.Array.isArray(object?.principals)
+        ? object.principals.map((e: any) => DailyActivityPrincipal.fromJSON(e))
+        : [],
+      search: isSet(object.search) ? globalThis.String(object.search) : "",
+      searchPrincipals: globalThis.Array.isArray(object?.searchPrincipals)
+        ? object.searchPrincipals.map((e: any) => DailyActivityPrincipal.fromJSON(e))
+        : globalThis.Array.isArray(object?.search_principals)
+        ? object.search_principals.map((e: any) => DailyActivityPrincipal.fromJSON(e))
+        : [],
+      searchStoredNames: globalThis.Array.isArray(object?.searchStoredNames)
+        ? object.searchStoredNames.map((e: any) => globalThis.String(e))
+        : globalThis.Array.isArray(object?.search_stored_names)
+        ? object.search_stored_names.map((e: any) => globalThis.String(e))
+        : [],
+    };
+  },
+
+  toJSON(message: SessionFilter): unknown {
+    const obj: any = {};
+    if (message.sourceSystems?.length) {
+      obj.sourceSystems = message.sourceSystems;
+    }
+    if (message.userIds?.length) {
+      obj.userIds = message.userIds;
+    }
+    if (message.apiKeyIds?.length) {
+      obj.apiKeyIds = message.apiKeyIds;
+    }
+    if (message.models?.length) {
+      obj.models = message.models;
+    }
+    if (message.providers?.length) {
+      obj.providers = message.providers;
+    }
+    if (message.activeAfter !== undefined) {
+      obj.activeAfter = message.activeAfter.toISOString();
+    }
+    if (message.efforts?.length) {
+      obj.efforts = message.efforts;
+    }
+    if (message.clients?.length) {
+      obj.clients = message.clients;
+    }
+    if (message.principals?.length) {
+      obj.principals = message.principals.map((e) => DailyActivityPrincipal.toJSON(e));
+    }
+    if (message.search !== "") {
+      obj.search = message.search;
+    }
+    if (message.searchPrincipals?.length) {
+      obj.searchPrincipals = message.searchPrincipals.map((e) => DailyActivityPrincipal.toJSON(e));
+    }
+    if (message.searchStoredNames?.length) {
+      obj.searchStoredNames = message.searchStoredNames;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<SessionFilter>, I>>(base?: I): SessionFilter {
+    return SessionFilter.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<SessionFilter>, I>>(object: I): SessionFilter {
+    const message = createBaseSessionFilter();
+    message.sourceSystems = object.sourceSystems?.map((e) => e) || [];
+    message.userIds = object.userIds?.map((e) => e) || [];
+    message.apiKeyIds = object.apiKeyIds?.map((e) => e) || [];
+    message.models = object.models?.map((e) => e) || [];
+    message.providers = object.providers?.map((e) => e) || [];
+    message.activeAfter = object.activeAfter ?? undefined;
+    message.efforts = object.efforts?.map((e) => e) || [];
+    message.clients = object.clients?.map((e) => e) || [];
+    message.principals = object.principals?.map((e) => DailyActivityPrincipal.fromPartial(e)) || [];
+    message.search = object.search ?? "";
+    message.searchPrincipals = object.searchPrincipals?.map((e) => DailyActivityPrincipal.fromPartial(e)) || [];
+    message.searchStoredNames = object.searchStoredNames?.map((e) => e) || [];
     return message;
   },
 };
@@ -2440,7 +2776,7 @@ export const ListSessionsResponse: MessageFns<ListSessionsResponse> = {
 };
 
 function createBaseSessionPagination(): SessionPagination {
-  return { page: 0, perPage: 0, total: 0, totalPages: 0 };
+  return { page: 0, perPage: 0, totalCount: 0, totalPages: 0 };
 }
 
 export const SessionPagination: MessageFns<SessionPagination> = {
@@ -2451,8 +2787,8 @@ export const SessionPagination: MessageFns<SessionPagination> = {
     if (message.perPage !== 0) {
       writer.uint32(16).int32(message.perPage);
     }
-    if (message.total !== 0) {
-      writer.uint32(24).int64(message.total);
+    if (message.totalCount !== 0) {
+      writer.uint32(24).int64(message.totalCount);
     }
     if (message.totalPages !== 0) {
       writer.uint32(32).int32(message.totalPages);
@@ -2494,7 +2830,7 @@ export const SessionPagination: MessageFns<SessionPagination> = {
               break;
             }
 
-            message.total = longToNumber(reader.int64());
+            message.totalCount = longToNumber(reader.int64());
             continue;
           }
           case 4: {
@@ -2525,7 +2861,11 @@ export const SessionPagination: MessageFns<SessionPagination> = {
         : isSet(object.per_page)
         ? globalThis.Number(object.per_page)
         : 0,
-      total: isSet(object.total) ? globalThis.Number(object.total) : 0,
+      totalCount: isSet(object.totalCount)
+        ? globalThis.Number(object.totalCount)
+        : isSet(object.total_count)
+        ? globalThis.Number(object.total_count)
+        : 0,
       totalPages: isSet(object.totalPages)
         ? globalThis.Number(object.totalPages)
         : isSet(object.total_pages)
@@ -2542,8 +2882,8 @@ export const SessionPagination: MessageFns<SessionPagination> = {
     if (message.perPage !== 0) {
       obj.perPage = Math.round(message.perPage);
     }
-    if (message.total !== 0) {
-      obj.total = Math.round(message.total);
+    if (message.totalCount !== 0) {
+      obj.totalCount = Math.round(message.totalCount);
     }
     if (message.totalPages !== 0) {
       obj.totalPages = Math.round(message.totalPages);
@@ -2558,7 +2898,7 @@ export const SessionPagination: MessageFns<SessionPagination> = {
     const message = createBaseSessionPagination();
     message.page = object.page ?? 0;
     message.perPage = object.perPage ?? 0;
-    message.total = object.total ?? 0;
+    message.totalCount = object.totalCount ?? 0;
     message.totalPages = object.totalPages ?? 0;
     return message;
   },

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

@@ -3,6 +3,7 @@
 'use strict';
 var grpc = require('@grpc/grpc-js');
 var proto_gateway_web_v1_ai_gateway_pb = require('../../../../proto/gateway/web/v1/ai_gateway_pb.js');
+var google_api_field_behavior_pb = require('../../../../google/api/field_behavior_pb.js');
 var google_protobuf_duration_pb = require('google-protobuf/google/protobuf/duration_pb.js');
 var google_protobuf_timestamp_pb = require('google-protobuf/google/protobuf/timestamp_pb.js');
 var proto_gateway_common_v1_status_pb = require('../../../../proto/gateway/common/v1/status_pb.js');