@miradorlabs/web-grpc 2.26.1 → 2.28.0

package/package.json

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

@@ -1734,22 +1734,22 @@ export interface StreamTraceMetadataRequest {
 }
 
 /**
- * TraceMetadataEnvelope wraps metadata stream events
- * First message is always a snapshot, followed by incremental updates
+ * Every event is a complete replacement snapshot. Consumers must replace their
+ * local catalogue on every snapshot so expiry and truncation remain exact.
  */
 export interface TraceMetadataEnvelope {
-  snapshot?: MetadataSnapshot | undefined;
-  update?: MetadataUpdate | undefined;
+  snapshot: MetadataSnapshot | undefined;
 }
 
-/**
- * MetadataSnapshot contains the full metadata state for initial load
- * Two shapes: attributes (all key/values), tags (all unique tags)
- */
+/** MetadataSnapshot contains the complete bounded state for its reported window. */
 export interface MetadataSnapshot {
   /** all key -> unique values */
   attributes: { [key: string]: AttributeValues };
   tags: string[];
+  rangeStart?: Date | undefined;
+  rangeEnd?: Date | undefined;
+  attributesTruncated: boolean;
+  tagsTruncated: boolean;
 }
 
 export interface MetadataSnapshot_AttributesEntry {
@@ -1757,21 +1757,10 @@ export interface MetadataSnapshot_AttributesEntry {
   value: AttributeValues | undefined;
 }
 
-/** MetadataUpdate contains incremental metadata changes */
-export interface MetadataUpdate {
-  /** new key/values */
-  addedAttributes: { [key: string]: AttributeValues };
-  addedTags: string[];
-}
-
-export interface MetadataUpdate_AddedAttributesEntry {
-  key: string;
-  value: AttributeValues | undefined;
-}
-
 /** AttributeValues holds unique values for an attribute key */
 export interface AttributeValues {
   values: string[];
+  valuesTruncated: boolean;
 }
 
 export interface DeleteTraceRequest {
@@ -4909,7 +4898,7 @@ export const StreamTraceMetadataRequest: MessageFns<StreamTraceMetadataRequest>
 };
 
 function createBaseTraceMetadataEnvelope(): TraceMetadataEnvelope {
-  return { snapshot: undefined, update: undefined };
+  return { snapshot: undefined };
 }
 
 export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
@@ -4917,9 +4906,6 @@ export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
     if (message.snapshot !== undefined) {
       MetadataSnapshot.encode(message.snapshot, writer.uint32(10).fork()).join();
     }
-    if (message.update !== undefined) {
-      MetadataUpdate.encode(message.update, writer.uint32(18).fork()).join();
-    }
     return writer;
   },
 
@@ -4938,14 +4924,6 @@ export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
           message.snapshot = MetadataSnapshot.decode(reader, reader.uint32());
           continue;
         }
-        case 2: {
-          if (tag !== 18) {
-            break;
-          }
-
-          message.update = MetadataUpdate.decode(reader, reader.uint32());
-          continue;
-        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -4956,10 +4934,7 @@ export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
   },
 
   fromJSON(object: any): TraceMetadataEnvelope {
-    return {
-      snapshot: isSet(object.snapshot) ? MetadataSnapshot.fromJSON(object.snapshot) : undefined,
-      update: isSet(object.update) ? MetadataUpdate.fromJSON(object.update) : undefined,
-    };
+    return { snapshot: isSet(object.snapshot) ? MetadataSnapshot.fromJSON(object.snapshot) : undefined };
   },
 
   toJSON(message: TraceMetadataEnvelope): unknown {
@@ -4967,9 +4942,6 @@ export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
     if (message.snapshot !== undefined) {
       obj.snapshot = MetadataSnapshot.toJSON(message.snapshot);
     }
-    if (message.update !== undefined) {
-      obj.update = MetadataUpdate.toJSON(message.update);
-    }
     return obj;
   },
 
@@ -4981,15 +4953,19 @@ export const TraceMetadataEnvelope: MessageFns<TraceMetadataEnvelope> = {
     message.snapshot = (object.snapshot !== undefined && object.snapshot !== null)
       ? MetadataSnapshot.fromPartial(object.snapshot)
       : undefined;
-    message.update = (object.update !== undefined && object.update !== null)
-      ? MetadataUpdate.fromPartial(object.update)
-      : undefined;
     return message;
   },
 };
 
 function createBaseMetadataSnapshot(): MetadataSnapshot {
-  return { attributes: {}, tags: [] };
+  return {
+    attributes: {},
+    tags: [],
+    rangeStart: undefined,
+    rangeEnd: undefined,
+    attributesTruncated: false,
+    tagsTruncated: false,
+  };
 }
 
 export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
@@ -5000,6 +4976,18 @@ export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
     for (const v of message.tags) {
       writer.uint32(18).string(v!);
     }
+    if (message.rangeStart !== undefined) {
+      Timestamp.encode(toTimestamp(message.rangeStart), writer.uint32(26).fork()).join();
+    }
+    if (message.rangeEnd !== undefined) {
+      Timestamp.encode(toTimestamp(message.rangeEnd), writer.uint32(34).fork()).join();
+    }
+    if (message.attributesTruncated !== false) {
+      writer.uint32(40).bool(message.attributesTruncated);
+    }
+    if (message.tagsTruncated !== false) {
+      writer.uint32(48).bool(message.tagsTruncated);
+    }
     return writer;
   },
 
@@ -5029,6 +5017,38 @@ export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
           message.tags.push(reader.string());
           continue;
         }
+        case 3: {
+          if (tag !== 26) {
+            break;
+          }
+
+          message.rangeStart = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+          continue;
+        }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+
+          message.rangeEnd = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+          continue;
+        }
+        case 5: {
+          if (tag !== 40) {
+            break;
+          }
+
+          message.attributesTruncated = reader.bool();
+          continue;
+        }
+        case 6: {
+          if (tag !== 48) {
+            break;
+          }
+
+          message.tagsTruncated = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -5050,6 +5070,26 @@ export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
         )
         : {},
       tags: globalThis.Array.isArray(object?.tags) ? object.tags.map((e: any) => globalThis.String(e)) : [],
+      rangeStart: isSet(object.rangeStart)
+        ? fromJsonTimestamp(object.rangeStart)
+        : isSet(object.range_start)
+        ? fromJsonTimestamp(object.range_start)
+        : undefined,
+      rangeEnd: isSet(object.rangeEnd)
+        ? fromJsonTimestamp(object.rangeEnd)
+        : isSet(object.range_end)
+        ? fromJsonTimestamp(object.range_end)
+        : undefined,
+      attributesTruncated: isSet(object.attributesTruncated)
+        ? globalThis.Boolean(object.attributesTruncated)
+        : isSet(object.attributes_truncated)
+        ? globalThis.Boolean(object.attributes_truncated)
+        : false,
+      tagsTruncated: isSet(object.tagsTruncated)
+        ? globalThis.Boolean(object.tagsTruncated)
+        : isSet(object.tags_truncated)
+        ? globalThis.Boolean(object.tags_truncated)
+        : false,
     };
   },
 
@@ -5067,6 +5107,18 @@ export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
     if (message.tags?.length) {
       obj.tags = message.tags;
     }
+    if (message.rangeStart !== undefined) {
+      obj.rangeStart = message.rangeStart.toISOString();
+    }
+    if (message.rangeEnd !== undefined) {
+      obj.rangeEnd = message.rangeEnd.toISOString();
+    }
+    if (message.attributesTruncated !== false) {
+      obj.attributesTruncated = message.attributesTruncated;
+    }
+    if (message.tagsTruncated !== false) {
+      obj.tagsTruncated = message.tagsTruncated;
+    }
     return obj;
   },
 
@@ -5085,6 +5137,10 @@ export const MetadataSnapshot: MessageFns<MetadataSnapshot> = {
       {},
     );
     message.tags = object.tags?.map((e) => e) || [];
+    message.rangeStart = object.rangeStart ?? undefined;
+    message.rangeEnd = object.rangeEnd ?? undefined;
+    message.attributesTruncated = object.attributesTruncated ?? false;
+    message.tagsTruncated = object.tagsTruncated ?? false;
     return message;
   },
 };
@@ -5171,201 +5227,8 @@ export const MetadataSnapshot_AttributesEntry: MessageFns<MetadataSnapshot_Attri
   },
 };
 
-function createBaseMetadataUpdate(): MetadataUpdate {
-  return { addedAttributes: {}, addedTags: [] };
-}
-
-export const MetadataUpdate: MessageFns<MetadataUpdate> = {
-  encode(message: MetadataUpdate, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
-    globalThis.Object.entries(message.addedAttributes).forEach(([key, value]: [string, AttributeValues]) => {
-      MetadataUpdate_AddedAttributesEntry.encode({ key: key as any, value }, writer.uint32(10).fork()).join();
-    });
-    for (const v of message.addedTags) {
-      writer.uint32(18).string(v!);
-    }
-    return writer;
-  },
-
-  decode(input: BinaryReader | Uint8Array, length?: number): MetadataUpdate {
-    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
-    const end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseMetadataUpdate();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1: {
-          if (tag !== 10) {
-            break;
-          }
-
-          const entry1 = MetadataUpdate_AddedAttributesEntry.decode(reader, reader.uint32());
-          if (entry1.value !== undefined) {
-            message.addedAttributes[entry1.key] = entry1.value;
-          }
-          continue;
-        }
-        case 2: {
-          if (tag !== 18) {
-            break;
-          }
-
-          message.addedTags.push(reader.string());
-          continue;
-        }
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skip(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): MetadataUpdate {
-    return {
-      addedAttributes: isObject(object.addedAttributes)
-        ? (globalThis.Object.entries(object.addedAttributes) as [string, any][]).reduce(
-          (acc: { [key: string]: AttributeValues }, [key, value]: [string, any]) => {
-            acc[key] = AttributeValues.fromJSON(value);
-            return acc;
-          },
-          {},
-        )
-        : isObject(object.added_attributes)
-        ? (globalThis.Object.entries(object.added_attributes) as [string, any][]).reduce(
-          (acc: { [key: string]: AttributeValues }, [key, value]: [string, any]) => {
-            acc[key] = AttributeValues.fromJSON(value);
-            return acc;
-          },
-          {},
-        )
-        : {},
-      addedTags: globalThis.Array.isArray(object?.addedTags)
-        ? object.addedTags.map((e: any) => globalThis.String(e))
-        : globalThis.Array.isArray(object?.added_tags)
-        ? object.added_tags.map((e: any) => globalThis.String(e))
-        : [],
-    };
-  },
-
-  toJSON(message: MetadataUpdate): unknown {
-    const obj: any = {};
-    if (message.addedAttributes) {
-      const entries = globalThis.Object.entries(message.addedAttributes) as [string, AttributeValues][];
-      if (entries.length > 0) {
-        obj.addedAttributes = {};
-        entries.forEach(([k, v]) => {
-          obj.addedAttributes[k] = AttributeValues.toJSON(v);
-        });
-      }
-    }
-    if (message.addedTags?.length) {
-      obj.addedTags = message.addedTags;
-    }
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<MetadataUpdate>, I>>(base?: I): MetadataUpdate {
-    return MetadataUpdate.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<MetadataUpdate>, I>>(object: I): MetadataUpdate {
-    const message = createBaseMetadataUpdate();
-    message.addedAttributes = (globalThis.Object.entries(object.addedAttributes ?? {}) as [string, AttributeValues][])
-      .reduce((acc: { [key: string]: AttributeValues }, [key, value]: [string, AttributeValues]) => {
-        if (value !== undefined) {
-          acc[key] = AttributeValues.fromPartial(value);
-        }
-        return acc;
-      }, {});
-    message.addedTags = object.addedTags?.map((e) => e) || [];
-    return message;
-  },
-};
-
-function createBaseMetadataUpdate_AddedAttributesEntry(): MetadataUpdate_AddedAttributesEntry {
-  return { key: "", value: undefined };
-}
-
-export const MetadataUpdate_AddedAttributesEntry: MessageFns<MetadataUpdate_AddedAttributesEntry> = {
-  encode(message: MetadataUpdate_AddedAttributesEntry, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
-    if (message.key !== "") {
-      writer.uint32(10).string(message.key);
-    }
-    if (message.value !== undefined) {
-      AttributeValues.encode(message.value, writer.uint32(18).fork()).join();
-    }
-    return writer;
-  },
-
-  decode(input: BinaryReader | Uint8Array, length?: number): MetadataUpdate_AddedAttributesEntry {
-    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
-    const end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseMetadataUpdate_AddedAttributesEntry();
-    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 = AttributeValues.decode(reader, reader.uint32());
-          continue;
-        }
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skip(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): MetadataUpdate_AddedAttributesEntry {
-    return {
-      key: isSet(object.key) ? globalThis.String(object.key) : "",
-      value: isSet(object.value) ? AttributeValues.fromJSON(object.value) : undefined,
-    };
-  },
-
-  toJSON(message: MetadataUpdate_AddedAttributesEntry): unknown {
-    const obj: any = {};
-    if (message.key !== "") {
-      obj.key = message.key;
-    }
-    if (message.value !== undefined) {
-      obj.value = AttributeValues.toJSON(message.value);
-    }
-    return obj;
-  },
-
-  create<I extends Exact<DeepPartial<MetadataUpdate_AddedAttributesEntry>, I>>(
-    base?: I,
-  ): MetadataUpdate_AddedAttributesEntry {
-    return MetadataUpdate_AddedAttributesEntry.fromPartial(base ?? ({} as any));
-  },
-  fromPartial<I extends Exact<DeepPartial<MetadataUpdate_AddedAttributesEntry>, I>>(
-    object: I,
-  ): MetadataUpdate_AddedAttributesEntry {
-    const message = createBaseMetadataUpdate_AddedAttributesEntry();
-    message.key = object.key ?? "";
-    message.value = (object.value !== undefined && object.value !== null)
-      ? AttributeValues.fromPartial(object.value)
-      : undefined;
-    return message;
-  },
-};
-
 function createBaseAttributeValues(): AttributeValues {
-  return { values: [] };
+  return { values: [], valuesTruncated: false };
 }
 
 export const AttributeValues: MessageFns<AttributeValues> = {
@@ -5373,6 +5236,9 @@ export const AttributeValues: MessageFns<AttributeValues> = {
     for (const v of message.values) {
       writer.uint32(10).string(v!);
     }
+    if (message.valuesTruncated !== false) {
+      writer.uint32(16).bool(message.valuesTruncated);
+    }
     return writer;
   },
 
@@ -5391,6 +5257,14 @@ export const AttributeValues: MessageFns<AttributeValues> = {
           message.values.push(reader.string());
           continue;
         }
+        case 2: {
+          if (tag !== 16) {
+            break;
+          }
+
+          message.valuesTruncated = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -5403,6 +5277,11 @@ export const AttributeValues: MessageFns<AttributeValues> = {
   fromJSON(object: any): AttributeValues {
     return {
       values: globalThis.Array.isArray(object?.values) ? object.values.map((e: any) => globalThis.String(e)) : [],
+      valuesTruncated: isSet(object.valuesTruncated)
+        ? globalThis.Boolean(object.valuesTruncated)
+        : isSet(object.values_truncated)
+        ? globalThis.Boolean(object.values_truncated)
+        : false,
     };
   },
 
@@ -5411,6 +5290,9 @@ export const AttributeValues: MessageFns<AttributeValues> = {
     if (message.values?.length) {
       obj.values = message.values;
     }
+    if (message.valuesTruncated !== false) {
+      obj.valuesTruncated = message.valuesTruncated;
+    }
     return obj;
   },
 
@@ -5420,6 +5302,7 @@ export const AttributeValues: MessageFns<AttributeValues> = {
   fromPartial<I extends Exact<DeepPartial<AttributeValues>, I>>(object: I): AttributeValues {
     const message = createBaseAttributeValues();
     message.values = object.values?.map((e) => e) || [];
+    message.valuesTruncated = object.valuesTruncated ?? false;
     return message;
   },
 };