hyperspace-sdk-ts 3.0.9 → 3.1.0

package/README.md

@@ -1,6 +1,6 @@
 # HyperspaceDB TypeScript SDK
 
-Official TypeScript client for HyperspaceDB gRPC API (v3.0.0-alpha.2).
+Official TypeScript client for HyperspaceDB gRPC API v3.1.0.
 
 Use this SDK for:
 - collection lifecycle management
@@ -69,6 +69,19 @@ Create a new collection.
 
 Delete collection and all its data.
 
+### `listCollections()`
+
+Retrieve all active collections for the current tenant.
+Returns `Promise<CollectionInfo[]>`.
+
+```ts
+const collections = await client.listCollections();
+for (const col of collections) {
+  console.log(`${col.name}: dim=${col.dimension}, metric=${col.metric}, count=${col.count}`);
+}
+```
+
+
 ### `insert(id, vector, meta?, collection?, durability?)`
 
 Insert one vector. Accepts `number[]`, `Float32Array`, `Float64Array`.

package/dist/client.d.ts

@@ -26,6 +26,12 @@ export interface SearchResult {
         [key: string]: TypedMetadataValue;
     };
 }
+export interface CollectionInfo {
+    name: string;
+    count: number;
+    dimension: number;
+    metric: string;
+}
 export interface GraphNode {
     id: number;
     layer: number;
@@ -69,7 +75,7 @@ export declare class HyperspaceClient {
     constructor(host?: string, apiKey?: string, userId?: string);
     createCollection(name: string, dimension: number, metric: string): Promise<boolean>;
     deleteCollection(name: string): Promise<boolean>;
-    listCollections(): Promise<string[]>;
+    listCollections(): Promise<CollectionInfo[]>;
     delete(id: number, collection?: string): Promise<boolean>;
     insert(vector: number[] | Float32Array | Float64Array, id: number, meta?: {
         [key: string]: string;

package/dist/client.js

@@ -274,7 +274,13 @@ class HyperspaceClient {
             this.client.listCollections(req, this.metadata, (err, resp) => {
                 if (err)
                     return reject(err);
-                resolve(resp.getCollectionsList());
+                const list = resp.getCollectionsList().map(c => ({
+                    name: c.getName(),
+                    count: c.getCount(),
+                    dimension: c.getDimension(),
+                    metric: c.getMetric()
+                }));
+                resolve(list);
             });
         });
     }

package/dist/proto/hyperspace_pb.js

@@ -26,6 +26,7 @@ goog.exportSymbol('proto.hyperspace.BatchSearchRequest', null, global);
 goog.exportSymbol('proto.hyperspace.BatchSearchResponse', null, global);
 goog.exportSymbol('proto.hyperspace.CollectionStatsRequest', null, global);
 goog.exportSymbol('proto.hyperspace.CollectionStatsResponse', null, global);
+goog.exportSymbol('proto.hyperspace.CollectionSummary', null, global);
 goog.exportSymbol('proto.hyperspace.ConfigUpdate', null, global);
 goog.exportSymbol('proto.hyperspace.CreateCollectionOp', null, global);
 goog.exportSymbol('proto.hyperspace.CreateCollectionRequest', null, global);
@@ -284,6 +285,27 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.hyperspace.DeleteCollectionRequest.displayName = 'proto.hyperspace.DeleteCollectionRequest';
 }
+/**
+ * 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.hyperspace.CollectionSummary = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.hyperspace.CollectionSummary, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.hyperspace.CollectionSummary.displayName = 'proto.hyperspace.CollectionSummary';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -3150,6 +3172,226 @@ proto.hyperspace.DeleteCollectionRequest.prototype.setName = function(value) {
 
 
 
+
+
+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.hyperspace.CollectionSummary.prototype.toObject = function(opt_includeInstance) {
+  return proto.hyperspace.CollectionSummary.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.hyperspace.CollectionSummary} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.hyperspace.CollectionSummary.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    name: jspb.Message.getFieldWithDefault(msg, 1, ""),
+    count: jspb.Message.getFieldWithDefault(msg, 2, 0),
+    dimension: jspb.Message.getFieldWithDefault(msg, 3, 0),
+    metric: jspb.Message.getFieldWithDefault(msg, 4, "")
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.hyperspace.CollectionSummary}
+ */
+proto.hyperspace.CollectionSummary.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.hyperspace.CollectionSummary;
+  return proto.hyperspace.CollectionSummary.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.hyperspace.CollectionSummary} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.hyperspace.CollectionSummary}
+ */
+proto.hyperspace.CollectionSummary.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.setName(value);
+      break;
+    case 2:
+      var value = /** @type {number} */ (reader.readUint64());
+      msg.setCount(value);
+      break;
+    case 3:
+      var value = /** @type {number} */ (reader.readUint32());
+      msg.setDimension(value);
+      break;
+    case 4:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setMetric(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.hyperspace.CollectionSummary.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.hyperspace.CollectionSummary.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.hyperspace.CollectionSummary} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.hyperspace.CollectionSummary.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getName();
+  if (f.length > 0) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+  f = message.getCount();
+  if (f !== 0) {
+    writer.writeUint64(
+      2,
+      f
+    );
+  }
+  f = message.getDimension();
+  if (f !== 0) {
+    writer.writeUint32(
+      3,
+      f
+    );
+  }
+  f = message.getMetric();
+  if (f.length > 0) {
+    writer.writeString(
+      4,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string name = 1;
+ * @return {string}
+ */
+proto.hyperspace.CollectionSummary.prototype.getName = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.hyperspace.CollectionSummary} returns this
+ */
+proto.hyperspace.CollectionSummary.prototype.setName = function(value) {
+  return jspb.Message.setProto3StringField(this, 1, value);
+};
+
+
+/**
+ * optional uint64 count = 2;
+ * @return {number}
+ */
+proto.hyperspace.CollectionSummary.prototype.getCount = function() {
+  return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 2, 0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.CollectionSummary} returns this
+ */
+proto.hyperspace.CollectionSummary.prototype.setCount = function(value) {
+  return jspb.Message.setProto3IntField(this, 2, value);
+};
+
+
+/**
+ * optional uint32 dimension = 3;
+ * @return {number}
+ */
+proto.hyperspace.CollectionSummary.prototype.getDimension = function() {
+  return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 3, 0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.CollectionSummary} returns this
+ */
+proto.hyperspace.CollectionSummary.prototype.setDimension = function(value) {
+  return jspb.Message.setProto3IntField(this, 3, value);
+};
+
+
+/**
+ * optional string metric = 4;
+ * @return {string}
+ */
+proto.hyperspace.CollectionSummary.prototype.getMetric = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 4, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.hyperspace.CollectionSummary} returns this
+ */
+proto.hyperspace.CollectionSummary.prototype.setMetric = function(value) {
+  return jspb.Message.setProto3StringField(this, 4, value);
+};
+
+
+
 /**
  * List of repeated fields within this message type.
  * @private {!Array<number>}
@@ -3188,7 +3430,8 @@ proto.hyperspace.ListCollectionsResponse.prototype.toObject = function(opt_inclu
  */
 proto.hyperspace.ListCollectionsResponse.toObject = function(includeInstance, msg) {
   var f, obj = {
-    collectionsList: (f = jspb.Message.getRepeatedField(msg, 1)) == null ? undefined : f
+    collectionsList: jspb.Message.toObjectList(msg.getCollectionsList(),
+    proto.hyperspace.CollectionSummary.toObject, includeInstance)
   };
 
   if (includeInstance) {
@@ -3226,7 +3469,8 @@ proto.hyperspace.ListCollectionsResponse.deserializeBinaryFromReader = function(
     var field = reader.getFieldNumber();
     switch (field) {
     case 1:
-      var value = /** @type {string} */ (reader.readString());
+      var value = new proto.hyperspace.CollectionSummary;
+      reader.readMessage(value,proto.hyperspace.CollectionSummary.deserializeBinaryFromReader);
       msg.addCollections(value);
       break;
     default:
@@ -3260,39 +3504,41 @@ proto.hyperspace.ListCollectionsResponse.serializeBinaryToWriter = function(mess
   var f = undefined;
   f = message.getCollectionsList();
   if (f.length > 0) {
-    writer.writeRepeatedString(
+    writer.writeRepeatedMessage(
       1,
-      f
+      f,
+      proto.hyperspace.CollectionSummary.serializeBinaryToWriter
     );
   }
 };
 
 
 /**
- * repeated string collections = 1;
- * @return {!Array<string>}
+ * repeated CollectionSummary collections = 1;
+ * @return {!Array<!proto.hyperspace.CollectionSummary>}
  */
 proto.hyperspace.ListCollectionsResponse.prototype.getCollectionsList = function() {
-  return /** @type {!Array<string>} */ (jspb.Message.getRepeatedField(this, 1));
+  return /** @type{!Array<!proto.hyperspace.CollectionSummary>} */ (
+    jspb.Message.getRepeatedWrapperField(this, proto.hyperspace.CollectionSummary, 1));
 };
 
 
 /**
- * @param {!Array<string>} value
+ * @param {!Array<!proto.hyperspace.CollectionSummary>} value
  * @return {!proto.hyperspace.ListCollectionsResponse} returns this
- */
+*/
 proto.hyperspace.ListCollectionsResponse.prototype.setCollectionsList = function(value) {
-  return jspb.Message.setField(this, 1, value || []);
+  return jspb.Message.setRepeatedWrapperField(this, 1, value);
 };
 
 
 /**
- * @param {string} value
+ * @param {!proto.hyperspace.CollectionSummary=} opt_value
  * @param {number=} opt_index
- * @return {!proto.hyperspace.ListCollectionsResponse} returns this
+ * @return {!proto.hyperspace.CollectionSummary}
  */
-proto.hyperspace.ListCollectionsResponse.prototype.addCollections = function(value, opt_index) {
-  return jspb.Message.addToRepeatedField(this, 1, value, opt_index);
+proto.hyperspace.ListCollectionsResponse.prototype.addCollections = function(opt_value, opt_index) {
+  return jspb.Message.addToRepeatedWrapperField(this, 1, opt_value, proto.hyperspace.CollectionSummary, opt_index);
 };
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperspace-sdk-ts",
-  "version": "3.0.9",
+  "version": "3.1.0",
   "description": "Official TypeScript SDK for HyperspaceDB gRPC API",
   "main": "dist/client.js",
   "types": "dist/client.d.ts",
@@ -31,4 +31,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3"
   }
-}
+}