@milaboratories/pl-drivers 1.12.7 → 1.12.8

package/src/proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/lsapi/protocol.ts

@@ -22,53 +22,53 @@ export interface LsAPI {
  */
 export interface LsAPI_ListItem {
     /**
-     * name of the item in storage, without any prefixes
+     * Name of the item in storage, without any prefixes.
      *
      * @generated from protobuf field: string name = 1
      */
     name: string;
     /**
-     * size of item in bytes
-     * is always zero for directories (is_dir = true)
+     * Size of the item in bytes.
+     * Is always zero for directories (is_dir = true).
      *
      * @generated from protobuf field: uint64 size = 2
      */
     size: bigint;
     /**
-     * is_dir is true for item, that can have subitems.
+     * is_dir is true for an item that can have subitems.
      *
      * @generated from protobuf field: bool is_dir = 3
      */
     isDir: boolean;
     /**
-     * full_name is the name of item absolute to storage root.
-     * it is <directory> + <name>
+     * full_name is the full name of the item, relative to the storage root.
+     * It is <directory> + <name>.
      * The <delimiter>, used in names, is storage-specific and is NOT guaranteed to be '/'.
      *
      * @generated from protobuf field: string full_name = 10
      */
     fullName: string;
     /**
-     * directory, the item is located in. The value here is always a prefix of name:
+     * The directory the item is located in. The value here is always a prefix of name:
      * name.HasPrefix(directory) is always true.
      *
      * @generated from protobuf field: string directory = 11
      */
     directory: string;
     /**
-     * last_modified keeps the item last modification timestamp
+     * last_modified keeps the item's last modification timestamp.
      *
      * @generated from protobuf field: google.protobuf.Timestamp last_modified = 12
      */
     lastModified?: Timestamp;
     /**
-     * version of item in storage.
-     * When storage supports versioning or provides checksums for the data stored,
+     * Version of item in storage.
+     * When the storage supports versioning or provides checksums for the data stored,
      * the <version> field keeps that data.
-     * If not - it keeps the any simple combination of item attributes, that helps to
-     * detect if the contents of item has changed, e.g. <size>+<mtime>.
-     * Anyway, client should not try to interpret this field, but should provide it to the Platform
-     * in operations with given item (like BlobImportInternal) to help Platform with deduplication.
+     * If not, it keeps any simple combination of item attributes that helps to
+     * detect if the contents of the item have changed, e.g. <size>+<mtime>.
+     * Anyway, the client should not try to interpret this field, but should provide it to the Platform
+     * in operations with a given item (like BlobImportInternal) to help the Platform with deduplication.
      *
      * @generated from protobuf field: string version = 13
      */
@@ -90,8 +90,14 @@ export interface LsAPI_List_Request {
      */
     resourceId: bigint;
     /**
-     * location to list, absolute to storage root. Only items, that have <full_name> starting
-     * from <location> are included into list response.
+     * Signature proving the caller is authorized to access this resource.
+     *
+     * @generated from protobuf field: optional bytes resource_signature = 3
+     */
+    resourceSignature?: Uint8Array;
+    /**
+     * Location to list, relative to the storage root. Only items that have <full_name> starting
+     * with <location> are included in the list response.
      *
      * @generated from protobuf field: string location = 2
      */
@@ -102,7 +108,7 @@ export interface LsAPI_List_Request {
  */
 export interface LsAPI_List_Response {
     /**
-     * List of the full (absolute to storage root) names of items from storage.
+     * List of the full (relative to storage root) names of items from storage.
      * E.g., for 'fs' storage each name will consist of names of all directories, where the
      * item is located, and the item name itself.
      * The delimiter, used in names, is storage-specific and is NOT guaranteed to be '/'.
@@ -111,7 +117,7 @@ export interface LsAPI_List_Response {
      */
     items: LsAPI_ListItem[];
     /**
-     * delimiter is path separator, used in this storage. Client can use it to parse item names into parts,
+     * The delimiter is the path separator used in this storage. The client can use it to parse item names into parts,
      * to extract directory names.
      *
      * @generated from protobuf field: string delimiter = 2
@@ -293,6 +299,7 @@ class LsAPI_List_Request$Type extends MessageType<LsAPI_List_Request> {
     constructor() {
         super("MiLaboratories.Controller.Shared.LsAPI.List.Request", [
             { no: 1, name: "resource_id", kind: "scalar", T: 4 /*ScalarType.UINT64*/, L: 0 /*LongType.BIGINT*/ },
+            { no: 3, name: "resource_signature", kind: "scalar", opt: true, T: 12 /*ScalarType.BYTES*/ },
             { no: 2, name: "location", kind: "scalar", T: 9 /*ScalarType.STRING*/ }
         ]);
     }
@@ -312,6 +319,9 @@ class LsAPI_List_Request$Type extends MessageType<LsAPI_List_Request> {
                 case /* uint64 resource_id */ 1:
                     message.resourceId = reader.uint64().toBigInt();
                     break;
+                case /* optional bytes resource_signature */ 3:
+                    message.resourceSignature = reader.bytes();
+                    break;
                 case /* string location */ 2:
                     message.location = reader.string();
                     break;
@@ -333,6 +343,9 @@ class LsAPI_List_Request$Type extends MessageType<LsAPI_List_Request> {
         /* string location = 2; */
         if (message.location !== "")
             writer.tag(2, WireType.LengthDelimited).string(message.location);
+        /* optional bytes resource_signature = 3; */
+        if (message.resourceSignature !== undefined)
+            writer.tag(3, WireType.LengthDelimited).bytes(message.resourceSignature);
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);

package/src/proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.client.ts

@@ -14,7 +14,7 @@ import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
  *
- * Progress provides access to progress of any long-running process associated with resource.
+ * Progress provides access to the progress of any long-running process associated with a resource.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Progress
@@ -31,7 +31,7 @@ export interface IProgressClient {
 }
 /**
  *
- * Progress provides access to progress of any long-running process associated with resource.
+ * Progress provides access to the progress of any long-running process associated with a resource.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Progress

package/src/proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/progressapi/protocol.ts

@@ -57,6 +57,10 @@ export interface ProgressAPI_GetStatus_Request {
      * @generated from protobuf field: uint64 resource_id = 1
      */
     resourceId: bigint;
+    /**
+     * @generated from protobuf field: optional bytes resource_signature = 2
+     */
+    resourceSignature?: Uint8Array;
 }
 /**
  * @generated from protobuf message MiLaboratories.Controller.Shared.ProgressAPI.GetStatus.Response
@@ -80,6 +84,10 @@ export interface ProgressAPI_RealtimeStatus_Request {
      * @generated from protobuf field: uint64 resource_id = 1
      */
     resourceId: bigint;
+    /**
+     * @generated from protobuf field: optional bytes resource_signature = 3
+     */
+    resourceSignature?: Uint8Array;
     /**
      * @generated from protobuf field: google.protobuf.Duration update_interval = 2
      */
@@ -253,7 +261,8 @@ export const ProgressAPI_GetStatus = new ProgressAPI_GetStatus$Type();
 class ProgressAPI_GetStatus_Request$Type extends MessageType<ProgressAPI_GetStatus_Request> {
     constructor() {
         super("MiLaboratories.Controller.Shared.ProgressAPI.GetStatus.Request", [
-            { no: 1, name: "resource_id", kind: "scalar", T: 4 /*ScalarType.UINT64*/, L: 0 /*LongType.BIGINT*/ }
+            { no: 1, name: "resource_id", kind: "scalar", T: 4 /*ScalarType.UINT64*/, L: 0 /*LongType.BIGINT*/ },
+            { no: 2, name: "resource_signature", kind: "scalar", opt: true, T: 12 /*ScalarType.BYTES*/ }
         ]);
     }
     create(value?: PartialMessage<ProgressAPI_GetStatus_Request>): ProgressAPI_GetStatus_Request {
@@ -271,6 +280,9 @@ class ProgressAPI_GetStatus_Request$Type extends MessageType<ProgressAPI_GetStat
                 case /* uint64 resource_id */ 1:
                     message.resourceId = reader.uint64().toBigInt();
                     break;
+                case /* optional bytes resource_signature */ 2:
+                    message.resourceSignature = reader.bytes();
+                    break;
                 default:
                     let u = options.readUnknownField;
                     if (u === "throw")
@@ -286,6 +298,9 @@ class ProgressAPI_GetStatus_Request$Type extends MessageType<ProgressAPI_GetStat
         /* uint64 resource_id = 1; */
         if (message.resourceId !== 0n)
             writer.tag(1, WireType.Varint).uint64(message.resourceId);
+        /* optional bytes resource_signature = 2; */
+        if (message.resourceSignature !== undefined)
+            writer.tag(2, WireType.LengthDelimited).bytes(message.resourceSignature);
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
@@ -385,6 +400,7 @@ class ProgressAPI_RealtimeStatus_Request$Type extends MessageType<ProgressAPI_Re
     constructor() {
         super("MiLaboratories.Controller.Shared.ProgressAPI.RealtimeStatus.Request", [
             { no: 1, name: "resource_id", kind: "scalar", T: 4 /*ScalarType.UINT64*/, L: 0 /*LongType.BIGINT*/ },
+            { no: 3, name: "resource_signature", kind: "scalar", opt: true, T: 12 /*ScalarType.BYTES*/ },
             { no: 2, name: "update_interval", kind: "message", T: () => Duration }
         ]);
     }
@@ -403,6 +419,9 @@ class ProgressAPI_RealtimeStatus_Request$Type extends MessageType<ProgressAPI_Re
                 case /* uint64 resource_id */ 1:
                     message.resourceId = reader.uint64().toBigInt();
                     break;
+                case /* optional bytes resource_signature */ 3:
+                    message.resourceSignature = reader.bytes();
+                    break;
                 case /* google.protobuf.Duration update_interval */ 2:
                     message.updateInterval = Duration.internalBinaryRead(reader, reader.uint32(), options, message.updateInterval);
                     break;
@@ -424,6 +443,9 @@ class ProgressAPI_RealtimeStatus_Request$Type extends MessageType<ProgressAPI_Re
         /* google.protobuf.Duration update_interval = 2; */
         if (message.updateInterval)
             Duration.internalBinaryWrite(message.updateInterval, writer.tag(2, WireType.LengthDelimited).fork(), options).join();
+        /* optional bytes resource_signature = 3; */
+        if (message.resourceSignature !== undefined)
+            writer.tag(3, WireType.LengthDelimited).bytes(message.resourceSignature);
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);

package/src/proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/streamingapi/protocol.client.ts

@@ -6,65 +6,47 @@ import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
 import { Streaming } from "./protocol";
 import type { StreamingAPI_LastLines } from "./protocol";
 import type { StreamingAPI_ReadText } from "./protocol";
-import type { StreamingAPI_StreamText } from "./protocol";
-import type { StreamingAPI_ReadBinary } from "./protocol";
-import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import { stackIntercept } from "@protobuf-ts/runtime-rpc";
 import type { StreamingAPI_Response } from "./protocol";
-import type { StreamingAPI_StreamBinary } from "./protocol";
-import type { ServerStreamingCall } from "@protobuf-ts/runtime-rpc";
+import type { StreamingAPI_ReadBinary } from "./protocol";
+import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
  *
- * Streaming provides access to online data stream from item in storage. Whenever item is appended with data,
- * the caller receives this fresh data in stream from server.
+ * Streaming provides access to an online data stream from an item in storage. Whenever data is appended to an item,
+ * the caller receives this fresh data in a stream from the server.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Streaming
  */
 export interface IStreamingClient {
     /**
-     * StreamBinary provides stream of binary file. Each response message keeps
-     * one single chunk of binary data from data source. See StreamingAPI.Binary message
-     * for more info on available options.
-     *
-     * @generated from protobuf rpc: StreamBinary
-     */
-    streamBinary(input: StreamingAPI_StreamBinary, options?: RpcOptions): ServerStreamingCall<StreamingAPI_StreamBinary, StreamingAPI_Response>;
-    /**
-     * ReadBinary allows to read remote item in chunks using stream-like API.
-     * The difference to StreamBinary is that the client receives single response for each
-     * call and has to send new calls to the server to get fresh data from remote item.
-     * Each response (each chunk from server) keeps not more than 3.9MiB of data.
+     * ReadBinary allows reading a remote item in chunks using a stream-like API.
+     * The client receives a single response for each call and has to send new calls
+     * to the server to get fresh data from the remote item.
+     * Each response (each chunk from the server) contains no more than 3.9MiB of data.
      *
      * @generated from protobuf rpc: ReadBinary
      */
     readBinary(input: StreamingAPI_ReadBinary, options?: RpcOptions): UnaryCall<StreamingAPI_ReadBinary, StreamingAPI_Response>;
     /**
-     * StreamText provides stream of textual file, splitting the data by newline symbol.
-     * Each response message keeps one single line of text from data source.
-     *
-     * @generated from protobuf rpc: StreamText
-     */
-    streamText(input: StreamingAPI_StreamText, options?: RpcOptions): ServerStreamingCall<StreamingAPI_StreamText, StreamingAPI_Response>;
-    /**
-     * ReadBinary allows to read remote item in chunks using stream-like API.
-     * The difference to StreamBinary is that the client receives single response for each
-     * call and has to send new calls to the server to get fresh data from remote item.
-     * Each response (each chunk from server) keeps not more than 3.9MiB of data.
+     * ReadText allows reading a remote item in chunks using a stream-like API.
+     * The client receives a single response for each call and has to send new calls
+     * to the server to get fresh data from the remote item.
+     * Each response (each chunk from the server) contains no more than 3.9MiB of data.
      *
      * @generated from protobuf rpc: ReadText
      */
     readText(input: StreamingAPI_ReadText, options?: RpcOptions): UnaryCall<StreamingAPI_ReadText, StreamingAPI_Response>;
     /**
-     * LastLines provides single message with the last lines from data source.
-     * When search pattern is specified, the last lines matching the given pattern are returned.
-     * The lines are returned in reversed order, as server reads data source from the end.
-     * Consider it as equivalent to 'tac <file> | grep <search> | head -n <line_count>'
+     * LastLines provides a single message with the last lines from the data source.
+     * When a search pattern is specified, the last lines matching the given pattern are returned.
+     * The lines are returned in reverse order, as the server reads the data source from the end.
+     * Consider it equivalent to 'tac <file> | grep <search> | head -n <line_count>'
      * The <new_offset> returned in the response points to the _beginning_ of the last
-     * line found, so client can continue reading the file backwards in subsequent calls.
-     * This means, that use of this <new_offset> in ReadText() will return you the same line
-     * returned last in LastLines() data.
+     * line found, so the client can continue reading the file backwards in subsequent calls.
+     * This means that the use of this <new_offset> in ReadText() will return the last line
+     * returned in the LastLines() response.
      *
      * @generated from protobuf rpc: LastLines
      */
@@ -72,8 +54,8 @@ export interface IStreamingClient {
 }
 /**
  *
- * Streaming provides access to online data stream from item in storage. Whenever item is appended with data,
- * the caller receives this fresh data in stream from server.
+ * Streaming provides access to an online data stream from an item in storage. Whenever data is appended to an item,
+ * the caller receives this fresh data in a stream from the server.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Streaming
@@ -85,64 +67,43 @@ export class StreamingClient implements IStreamingClient, ServiceInfo {
     constructor(private readonly _transport: RpcTransport) {
     }
     /**
-     * StreamBinary provides stream of binary file. Each response message keeps
-     * one single chunk of binary data from data source. See StreamingAPI.Binary message
-     * for more info on available options.
-     *
-     * @generated from protobuf rpc: StreamBinary
-     */
-    streamBinary(input: StreamingAPI_StreamBinary, options?: RpcOptions): ServerStreamingCall<StreamingAPI_StreamBinary, StreamingAPI_Response> {
-        const method = this.methods[0], opt = this._transport.mergeOptions(options);
-        return stackIntercept<StreamingAPI_StreamBinary, StreamingAPI_Response>("serverStreaming", this._transport, method, opt, input);
-    }
-    /**
-     * ReadBinary allows to read remote item in chunks using stream-like API.
-     * The difference to StreamBinary is that the client receives single response for each
-     * call and has to send new calls to the server to get fresh data from remote item.
-     * Each response (each chunk from server) keeps not more than 3.9MiB of data.
+     * ReadBinary allows reading a remote item in chunks using a stream-like API.
+     * The client receives a single response for each call and has to send new calls
+     * to the server to get fresh data from the remote item.
+     * Each response (each chunk from the server) contains no more than 3.9MiB of data.
      *
      * @generated from protobuf rpc: ReadBinary
      */
     readBinary(input: StreamingAPI_ReadBinary, options?: RpcOptions): UnaryCall<StreamingAPI_ReadBinary, StreamingAPI_Response> {
-        const method = this.methods[1], opt = this._transport.mergeOptions(options);
+        const method = this.methods[0], opt = this._transport.mergeOptions(options);
         return stackIntercept<StreamingAPI_ReadBinary, StreamingAPI_Response>("unary", this._transport, method, opt, input);
     }
     /**
-     * StreamText provides stream of textual file, splitting the data by newline symbol.
-     * Each response message keeps one single line of text from data source.
-     *
-     * @generated from protobuf rpc: StreamText
-     */
-    streamText(input: StreamingAPI_StreamText, options?: RpcOptions): ServerStreamingCall<StreamingAPI_StreamText, StreamingAPI_Response> {
-        const method = this.methods[2], opt = this._transport.mergeOptions(options);
-        return stackIntercept<StreamingAPI_StreamText, StreamingAPI_Response>("serverStreaming", this._transport, method, opt, input);
-    }
-    /**
-     * ReadBinary allows to read remote item in chunks using stream-like API.
-     * The difference to StreamBinary is that the client receives single response for each
-     * call and has to send new calls to the server to get fresh data from remote item.
-     * Each response (each chunk from server) keeps not more than 3.9MiB of data.
+     * ReadText allows reading a remote item in chunks using a stream-like API.
+     * The client receives a single response for each call and has to send new calls
+     * to the server to get fresh data from the remote item.
+     * Each response (each chunk from the server) contains no more than 3.9MiB of data.
      *
      * @generated from protobuf rpc: ReadText
      */
     readText(input: StreamingAPI_ReadText, options?: RpcOptions): UnaryCall<StreamingAPI_ReadText, StreamingAPI_Response> {
-        const method = this.methods[3], opt = this._transport.mergeOptions(options);
+        const method = this.methods[1], opt = this._transport.mergeOptions(options);
         return stackIntercept<StreamingAPI_ReadText, StreamingAPI_Response>("unary", this._transport, method, opt, input);
     }
     /**
-     * LastLines provides single message with the last lines from data source.
-     * When search pattern is specified, the last lines matching the given pattern are returned.
-     * The lines are returned in reversed order, as server reads data source from the end.
-     * Consider it as equivalent to 'tac <file> | grep <search> | head -n <line_count>'
+     * LastLines provides a single message with the last lines from the data source.
+     * When a search pattern is specified, the last lines matching the given pattern are returned.
+     * The lines are returned in reverse order, as the server reads the data source from the end.
+     * Consider it equivalent to 'tac <file> | grep <search> | head -n <line_count>'
      * The <new_offset> returned in the response points to the _beginning_ of the last
-     * line found, so client can continue reading the file backwards in subsequent calls.
-     * This means, that use of this <new_offset> in ReadText() will return you the same line
-     * returned last in LastLines() data.
+     * line found, so the client can continue reading the file backwards in subsequent calls.
+     * This means that the use of this <new_offset> in ReadText() will return the last line
+     * returned in the LastLines() response.
      *
      * @generated from protobuf rpc: LastLines
      */
     lastLines(input: StreamingAPI_LastLines, options?: RpcOptions): UnaryCall<StreamingAPI_LastLines, StreamingAPI_Response> {
-        const method = this.methods[4], opt = this._transport.mergeOptions(options);
+        const method = this.methods[2], opt = this._transport.mergeOptions(options);
         return stackIntercept<StreamingAPI_LastLines, StreamingAPI_Response>("unary", this._transport, method, opt, input);
     }
 }