@milaboratories/pl-drivers 1.12.7 → 1.12.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-drivers",
-  "version": "1.12.7",
+  "version": "1.12.9",
   "description": "Drivers and a low-level clients for log streaming, downloading and uploading files from and to pl",
   "files": [
     "dist/**/*",
@@ -29,24 +29,24 @@
     "undici": "~7.16.0",
     "zod": "~3.23.8",
     "@milaboratories/computable": "2.9.2",
-    "@milaboratories/pl-client": "2.18.5",
-    "@milaboratories/pl-tree": "1.9.6",
-    "@milaboratories/pl-model-common": "1.31.1",
+    "@milaboratories/pl-tree": "1.9.8",
+    "@milaboratories/ts-helpers": "1.8.1",
+    "@milaboratories/pl-client": "3.1.0",
     "@milaboratories/helpers": "1.14.1",
-    "@milaboratories/ts-helpers": "1.8.1"
+    "@milaboratories/pl-model-common": "1.31.1"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.7",
     "@types/node": "~24.5.2",
     "@types/tar-fs": "^2.0.4",
-    "@vitest/coverage-istanbul": "^4.0.18",
+    "@vitest/coverage-istanbul": "^4.1.3",
     "openapi-typescript": "^7.10.0",
     "typescript": "~5.9.3",
-    "vitest": "^4.0.18",
-    "@milaboratories/build-configs": "1.5.2",
+    "vitest": "^4.1.3",
     "@milaboratories/test-helpers": "1.2.1",
-    "@milaboratories/ts-builder": "1.3.0",
-    "@milaboratories/ts-configs": "1.2.2"
+    "@milaboratories/ts-configs": "1.2.3",
+    "@milaboratories/build-configs": "2.0.0",
+    "@milaboratories/ts-builder": "1.3.1"
   },
   "engines": {
     "node": ">=22"

package/src/clients/download.ts

@@ -147,6 +147,7 @@ export class ClientDownload {
         await client.POST("/v1/get-download-url", {
           body: {
             resourceId: id.toString(),
+            resourceSignature: "",
             isInternalUse: false,
           },
           headers: { ...createRTypeRoutingHeader(type) },

package/src/clients/logs.ts

@@ -57,6 +57,7 @@ export class ClientLogs {
       await client.POST("/v1/last-lines", {
         body: {
           resourceId: rId.toString(),
+          resourceSignature: "",
           lineCount: lineCount,
           offset: offsetBytes.toString(),
           search: searchStr ?? "",
@@ -103,6 +104,7 @@ export class ClientLogs {
       await client.POST("/v1/read/text", {
         body: {
           resourceId: rId.toString(),
+          resourceSignature: "",
           readLimit: lineCount.toString(),
           offset: offsetBytes.toString(),
           search: searchStr ?? "",

package/src/clients/ls_api.ts

@@ -55,6 +55,7 @@ export class ClientLs {
         await client.POST("/v1/list", {
           body: {
             resourceId: rInfo.id.toString(),
+            resourceSignature: "",
             location: path,
           },
           headers: { ...createRTypeRoutingHeader(rInfo.type) },

package/src/clients/progress.ts

@@ -62,7 +62,7 @@ export class ClientProgress {
     } else {
       const resp = (
         await client.POST("/v1/get-progress", {
-          body: { resourceId: id.toString() },
+          body: { resourceId: id.toString(), resourceSignature: "" },
           headers: { ...createRTypeRoutingHeader(type) },
         })
       ).data!.report;

package/src/clients/upload.ts

@@ -96,6 +96,7 @@ export class ClientUpload {
       await client.POST("/v1/upload/init", {
         body: {
           resourceId: id.toString(),
+          resourceSignature: "",
         },
         headers: { ...createRTypeRoutingHeader(type) },
       })
@@ -140,6 +141,7 @@ export class ClientUpload {
         await client.POST("/v1/upload/get-part-url", {
           body: {
             resourceId: id.toString(),
+            resourceSignature: "",
             partNumber: partNumber.toString(),
             uploadedPartSize: "0",
             isInternalUse: false,
@@ -217,11 +219,21 @@ export class ClientUpload {
     const client = this.wire.get();
 
     if (client instanceof UploadClient) {
-      await client.finalize({ resourceId: info.id }, addRTypeToMetadata(info.type, options));
+      await client.finalize(
+        {
+          resourceId: info.id,
+          checksumAlgorithm: UploadAPI_ChecksumAlgorithm.UNSPECIFIED,
+          checksum: new Uint8Array(0),
+        },
+        addRTypeToMetadata(info.type, options),
+      );
     } else {
       await client.POST("/v1/upload/finalize", {
         body: {
           resourceId: info.id.toString(),
+          resourceSignature: "",
+          checksumAlgorithm: 0,
+          checksum: "",
         },
         headers: { ...createRTypeRoutingHeader(info.type) },
       });
@@ -262,6 +274,7 @@ export class ClientUpload {
     await client.POST("/v1/upload/update-progress", {
       body: {
         resourceId: id.toString(),
+        resourceSignature: "",
         bytesProcessed: bytesProcessed.toString(),
       },
       headers: { ...createRTypeRoutingHeader(type) },

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

@@ -11,7 +11,7 @@ import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
  *
- * Download provides access to any data, that can be downloaded via network.
+ * Download provides access to any data that can be downloaded over the network.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Download
@@ -24,7 +24,7 @@ export interface IDownloadClient {
 }
 /**
  *
- * Download provides access to any data, that can be downloaded via network.
+ * Download provides access to any data that can be downloaded over the network.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.Download

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

@@ -30,9 +30,15 @@ export interface DownloadAPI_GetDownloadURL_Request {
      */
     resourceId: bigint;
     /**
-     * Pass `true` here if the blob will be downloaded from internal network,
-     * e.g. controllers could use this if they are trying to download something from internal network.
-     * For backward compatibility, by default pl treats all requests as from external network.
+     * Signature proving the caller is authorized to access this resource.
+     *
+     * @generated from protobuf field: optional bytes resource_signature = 3
+     */
+    resourceSignature?: Uint8Array;
+    /**
+     * Pass `true` here if the blob will be downloaded from the internal network,
+     * e.g. controllers could use this if they are trying to download something from the internal network.
+     * For backward compatibility, by default pl treats all requests as from the external network.
      *
      * @generated from protobuf field: bool is_internal_use = 2
      */
@@ -43,11 +49,11 @@ export interface DownloadAPI_GetDownloadURL_Request {
  */
 export interface DownloadAPI_GetDownloadURL_HTTPHeader {
     /**
-     * @generated from protobuf field: string Name = 1
+     * @generated from protobuf field: string name = 1
      */
     name: string;
     /**
-     * @generated from protobuf field: string Value = 2
+     * @generated from protobuf field: string value = 2
      */
     value: string;
 }
@@ -145,6 +151,7 @@ class DownloadAPI_GetDownloadURL_Request$Type extends MessageType<DownloadAPI_Ge
     constructor() {
         super("MiLaboratories.Controller.Shared.DownloadAPI.GetDownloadURL.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: "is_internal_use", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
         ]);
     }
@@ -164,6 +171,9 @@ class DownloadAPI_GetDownloadURL_Request$Type extends MessageType<DownloadAPI_Ge
                 case /* uint64 resource_id */ 1:
                     message.resourceId = reader.uint64().toBigInt();
                     break;
+                case /* optional bytes resource_signature */ 3:
+                    message.resourceSignature = reader.bytes();
+                    break;
                 case /* bool is_internal_use */ 2:
                     message.isInternalUse = reader.bool();
                     break;
@@ -185,6 +195,9 @@ class DownloadAPI_GetDownloadURL_Request$Type extends MessageType<DownloadAPI_Ge
         /* bool is_internal_use = 2; */
         if (message.isInternalUse !== false)
             writer.tag(2, WireType.Varint).bool(message.isInternalUse);
+        /* 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);
@@ -199,8 +212,8 @@ export const DownloadAPI_GetDownloadURL_Request = new DownloadAPI_GetDownloadURL
 class DownloadAPI_GetDownloadURL_HTTPHeader$Type extends MessageType<DownloadAPI_GetDownloadURL_HTTPHeader> {
     constructor() {
         super("MiLaboratories.Controller.Shared.DownloadAPI.GetDownloadURL.HTTPHeader", [
-            { no: 1, name: "Name", kind: "scalar", jsonName: "Name", T: 9 /*ScalarType.STRING*/ },
-            { no: 2, name: "Value", kind: "scalar", jsonName: "Value", T: 9 /*ScalarType.STRING*/ }
+            { no: 1, name: "name", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 2, name: "value", kind: "scalar", T: 9 /*ScalarType.STRING*/ }
         ]);
     }
     create(value?: PartialMessage<DownloadAPI_GetDownloadURL_HTTPHeader>): DownloadAPI_GetDownloadURL_HTTPHeader {
@@ -216,10 +229,10 @@ class DownloadAPI_GetDownloadURL_HTTPHeader$Type extends MessageType<DownloadAPI
         while (reader.pos < end) {
             let [fieldNo, wireType] = reader.tag();
             switch (fieldNo) {
-                case /* string Name */ 1:
+                case /* string name */ 1:
                     message.name = reader.string();
                     break;
-                case /* string Value */ 2:
+                case /* string value */ 2:
                     message.value = reader.string();
                     break;
                 default:
@@ -234,10 +247,10 @@ class DownloadAPI_GetDownloadURL_HTTPHeader$Type extends MessageType<DownloadAPI
         return message;
     }
     internalBinaryWrite(message: DownloadAPI_GetDownloadURL_HTTPHeader, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
-        /* string Name = 1; */
+        /* string name = 1; */
         if (message.name !== "")
             writer.tag(1, WireType.LengthDelimited).string(message.name);
-        /* string Value = 2; */
+        /* string value = 2; */
         if (message.value !== "")
             writer.tag(2, WireType.LengthDelimited).string(message.value);
         let u = options.writeUnknownFields;

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

@@ -11,10 +11,10 @@ import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
  *
- * LS provides access to lists of blobs (files, S3 objects and so on) is some storage.
- * This API allows clients to know, whan items are available in storages, that
- * the contorllers can access, providing clients with the ability to start indexation
- * on, say, existing sequence files from the corporate storage.
+ * LS provides access to lists of blobs (files, S3 objects and so on) in some storage.
+ * This API allows clients to know what items are available in storages that
+ * the controllers can access, providing clients with the ability to start indexing,
+ * say, existing sequence files from the corporate storage.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.LS
@@ -27,10 +27,10 @@ export interface ILSClient {
 }
 /**
  *
- * LS provides access to lists of blobs (files, S3 objects and so on) is some storage.
- * This API allows clients to know, whan items are available in storages, that
- * the contorllers can access, providing clients with the ability to start indexation
- * on, say, existing sequence files from the corporate storage.
+ * LS provides access to lists of blobs (files, S3 objects and so on) in some storage.
+ * This API allows clients to know what items are available in storages that
+ * the controllers can access, providing clients with the ability to start indexing,
+ * say, existing sequence files from the corporate storage.
  *
  *
  * @generated from protobuf service MiLaboratories.Controller.Shared.LS

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);