@milaboratories/pl-drivers 1.3.26 → 1.4.0

package/src/index.ts

@@ -3,9 +3,9 @@ export * from './clients/progress';
 export * from './clients/download';
 export * from './clients/ls_api';
 export * from './clients/logs';
-export * from './clients/helpers';
+export * from './clients/constructors';
 
-export * from './drivers/download_and_logs_blob';
+export * from './drivers/download_blob';
 export * from './drivers/upload';
 export * from './drivers/logs_stream';
 export * from './drivers/logs';

package/dist/drivers/download_and_logs_blob.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"download_and_logs_blob.d.ts","sourceRoot":"","sources":["../../src/drivers/download_and_logs_blob.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,aAAa,EACb,uBAAuB,EACvB,OAAO,EACR,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,cAAc,EACd,QAAQ,EAER,MAAM,EACN,YAAY,EACb,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAE,cAAc,EAA0C,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAS7C,OAAO,EACL,aAAa,EACb,YAAY,EACZ,WAAW,EAKX,gBAAgB,EAGjB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,YAAY,EACZ,UAAU,EACV,eAAe,EACf,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,0DAA0D;AAC1D,eAAO,MAAM,4BAA4B;;;;;;;;EAMvC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,aAAa,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAE9F,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;SAIK;IACL,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;SAGK;IACL,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;6DAC6D;AAC7D,qBAAa,cAAe,YAAW,UAAU;IAmB7C,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAE3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAtBzB,+DAA+D;IAC/D,OAAO,CAAC,YAAY,CAAwC;IAE5D;mCAC+B;IAC/B,OAAO,CAAC,KAAK,CAAuB;IAEpC,wDAAwD;IACxD,OAAO,CAAC,aAAa,CAAgB;IAErC,OAAO,CAAC,YAAY,CAAkD;IAEtE,OAAO,CAAC,aAAa,CAA+C;IACpE,OAAO,CAAC,eAAe,CAA+C;IAEtE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAGd,MAAM,EAAE,QAAQ,EAChB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,UAAU,EACvC,OAAO,EAAE,MAAM,EACE,MAAM,EAAE,MAAM,EAC/B,GAAG,EAAE,iBAAiB;IAQxB,gFAAgF;IAChF,iBAAiB,CACf,GAAG,EAAE,YAAY,GAAG,WAAW,EAC/B,GAAG,EAAE,aAAa,GACjB,sBAAsB,GAAG,SAAS;IACrC,iBAAiB,CACf,GAAG,EAAE,YAAY,GAAG,WAAW,GAC9B,uBAAuB,CAAC,sBAAsB,CAAC;IAkBlD,eAAe,CACb,GAAG,EAAE,4BAA4B,GAAG,WAAW,GAC9C,UAAU,CAAC,uBAAuB,CAAC;IACtC,eAAe,CACb,GAAG,EAAE,4BAA4B,GAAG,WAAW,EAC/C,GAAG,EAAE,aAAa,GACjB,uBAAuB;IAmBnB,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM;IAIvC,UAAU,CAAC,MAAM,EAAE,eAAe,GAAG,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAWxF,OAAO,CAAC,sBAAsB;IAwB9B,OAAO,CAAC,kBAAkB;YAaZ,YAAY;IAK1B,OAAO,CAAC,oBAAoB;IAoB5B;0DACsD;IACtD,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;IAC3F,WAAW,CACT,GAAG,EAAE,YAAY,GAAG,WAAW,EAC/B,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,aAAa,GACjB,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;IAmBjC,OAAO,CAAC,gBAAgB;IAyBxB;2DACuD;IACvD,cAAc,CACZ,GAAG,EAAE,YAAY,GAAG,WAAW,EAC/B,eAAe,EAAE,MAAM,GACtB,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;IACjC,cAAc,CACZ,GAAG,EAAE,YAAY,GAAG,WAAW,EAC/B,eAAe,EAAE,MAAM,EACvB,GAAG,EAAE,aAAa,GACjB,MAAM,GAAG,SAAS;IAyBrB,OAAO,CAAC,mBAAmB;IAyB3B;uBACmB;IACnB,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,GAAG,UAAU,CAAC,YAAY,CAAC;IACvE,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW,EAAE,GAAG,EAAE,aAAa,GAAG,YAAY;IAY/E,OAAO,CAAC,iBAAiB;IAInB,SAAS,CACb,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EAAE,kCAAkC;IACxD,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;IAiB1B,QAAQ,CACZ,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,oBAAoB,CAAC;YAiBlB,WAAW;IA0BzB,OAAO,CAAC,UAAU;YAQJ,mBAAmB;IAKjC,2CAA2C;IACrC,UAAU;IAShB,OAAO,CAAC,WAAW;CAGpB;AAkHD,qBAAa,QAAQ;IASjB,QAAQ,CAAC,cAAc,EAAE,cAAc;IACvC,QAAQ,CAAC,KAAK,EAAE,gBAAgB;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,MAAM,EAAE,eAAe;IAXlC,QAAQ,CAAC,OAAO,iBAAwB;IACxC,QAAQ,CAAC,MAAM,eAAsB;IACrC,QAAQ,CAAC,SAAS,kBAAyB;IAC3C,KAAK,EAAE,GAAG,GAAG,SAAS,CAAC;IACvB,IAAI,UAAS;IACb,SAAS,SAAK;gBAGH,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,eAAe;IAGlC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IAK7B,QAAQ;IAqCd,OAAO,IAAI,YAAY,CAAC,sBAAsB,CAAC,GAAG,SAAS;IAmB3D,OAAO,CAAC,OAAO;IAMf,KAAK,CAAC,MAAM,EAAE,MAAM;IAIpB,OAAO,CAAC,QAAQ;CAIjB"}

package/dist/drivers/helpers/ls_list_entry.d.ts

@@ -1,44 +0,0 @@
-import { MiLogger, Signer } from '@milaboratories/ts-helpers';
-import { Timestamp } from '../../proto/google/protobuf/timestamp';
-import { Dirent, Stats } from 'node:fs';
-import { ImportFileHandleIndexData, ImportFileHandleUploadData } from '../types';
-import * as sdk from '@milaboratories/pl-model-common';
-/** A duck-typing interface for grpc results. */
-export interface ListResponse {
-    items: ListItem[];
-    delimiter: string;
-}
-/** @deprecated */
-export interface ListItem {
-    isDir: boolean;
-    name: string;
-    fullName: string;
-    lastModified?: Timestamp;
-    size: bigint;
-    directory: string;
-}
-/** @deprecated */
-export declare function toLsEntries(info: {
-    storageName: string;
-    list: ListResponse;
-    signer: Signer;
-    remote: boolean;
-}): sdk.ListFilesResult;
-/** @deprecated */
-export declare function toFileHandle(info: {
-    storageName: string;
-    item: ListItem;
-    signer: Signer;
-    remote: boolean;
-}): sdk.ImportFileHandle;
-export declare function createIndexImportHandle(storageName: string, path: string): sdk.ImportFileHandleIndex;
-export declare function createUploadImportHandle(localPath: string, signer: Signer, sizeBytes: bigint, modificationTimeSeconds: bigint): sdk.ImportFileHandleUpload;
-export declare function parseUploadHandle(handle: sdk.ImportFileHandleUpload): ImportFileHandleUploadData;
-export declare function parseIndexHandle(handle: sdk.ImportFileHandleIndex): ImportFileHandleIndexData;
-export declare function toListItem(logger: MiLogger, info: {
-    directory: string;
-    fullName: string;
-    dirent: Dirent;
-    stat: Stats;
-}): ListItem | undefined;
-//# sourceMappingURL=ls_list_entry.d.ts.map

package/dist/drivers/helpers/ls_list_entry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ls_list_entry.d.ts","sourceRoot":"","sources":["../../../src/drivers/helpers/ls_list_entry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAY,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,GAAG,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAEjF,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,kBAAkB;AAClB,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kBAAkB;AAClB,wBAAgB,WAAW,CAAC,IAAI,EAAE;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,GAAG,CAAC,eAAe,CAOtB;AA2BD,kBAAkB;AAClB,wBAAgB,YAAY,CAAC,IAAI,EAAE;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,GAAG,CAAC,gBAAgB,CAWvB;AAED,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,GACX,GAAG,CAAC,qBAAqB,CAO3B;AAED,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,uBAAuB,EAAE,MAAM,GAC9B,GAAG,CAAC,sBAAsB,CAS5B;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,sBAAsB,GAAG,0BAA0B,CAKhG;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,qBAAqB,GAAG,yBAAyB,CAG7F;AAED,wBAAgB,UAAU,CACxB,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE;IACJ,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,KAAK,CAAC;CACb,GACA,QAAQ,GAAG,SAAS,CAiBtB"}

package/src/drivers/helpers/ls_list_entry.test.ts

@@ -1,55 +0,0 @@
-import { ConsoleLoggerAdapter, HmacSha256Signer } from '@milaboratories/ts-helpers';
-import { parseUploadHandle, toFileHandle, toListItem } from './ls_list_entry';
-import type { Dirent, Stats } from 'node:fs';
-import { ImportFileHandleUpload } from '@milaboratories/pl-model-common';
-
-test('toFileHandle should ok when encode data for UploadBlob', () => {
-  const signer = new HmacSha256Signer('abc');
-
-  const handle = toFileHandle({
-    storageName: 'library',
-    signer,
-    remote: false,
-    item: {
-      directory: 'C:\\programFiles\\',
-      name: 'file.txt',
-      size: 20n,
-      isDir: false,
-      fullName: 'C:\\programFiles\\file.txt',
-      lastModified: { seconds: 150n, nanos: 260 }
-    }
-  }) as ImportFileHandleUpload;
-  const got = parseUploadHandle(handle);
-
-  expect(got.modificationTime).toEqual('150');
-  expect(got.localPath).toEqual('C:\\programFiles\\file.txt');
-  expect(got.pathSignature).not.toHaveLength(0);
-  expect(got.sizeBytes).toEqual('20');
-});
-
-test('toListItem should ok', () => {
-  const got = toListItem(new ConsoleLoggerAdapter(), {
-    fullName: 'C:\\programFiles\\file.txt',
-    dirent: {
-      isFile: () => true,
-      isDirectory: () => false,
-      name: 'file.txt'
-    } as Dirent,
-    directory: 'C:\\programFiles\\',
-    stat: {
-      mtimeMs: 150000,
-      size: 20
-    } as Stats
-  });
-
-  expect(got).toMatchObject({
-    isDir: false,
-    name: 'file.txt',
-    fullName: 'C:\\programFiles\\file.txt',
-    lastModified: {
-      seconds: 150n,
-      nanos: 0
-    },
-    size: 20n
-  });
-});

package/src/drivers/helpers/ls_list_entry.ts

@@ -1,147 +0,0 @@
-import { MiLogger, notEmpty, Signer } from '@milaboratories/ts-helpers';
-import * as sdk from '@milaboratories/pl-model-common';
-import { Timestamp } from '../../proto/google/protobuf/timestamp';
-import { Dirent, Stats } from 'node:fs';
-import { z } from 'zod';
-import { ImportFileHandleIndexData, ImportFileHandleUploadData } from '../types';
-
-/** A duck-typing interface for grpc results. */
-export interface ListResponse {
-  items: ListItem[];
-  delimiter: string;
-}
-/** @deprecated */
-export interface ListItem {
-  isDir: boolean;
-  name: string;
-  fullName: string;
-  lastModified?: Timestamp;
-  size: bigint;
-  directory: string;
-}
-
-/** @deprecated */
-export function toLsEntries(info: {
-  storageName: string;
-  list: ListResponse;
-  signer: Signer;
-  remote: boolean;
-}): sdk.ListFilesResult {
-  const parent = info.list.items.length > 0 ? info.list.items[0]?.directory : undefined;
-
-  return {
-    parent: parent,
-    entries: info.list.items.map((item) => toLsEntry(item, info))
-  };
-}
-
-/** @deprecated */
-function toLsEntry(
-  item: ListItem,
-  info: {
-    storageName: string;
-    list: ListResponse;
-    signer: Signer;
-    remote: boolean;
-  }
-): sdk.LsEntry {
-  if (item.isDir)
-    return {
-      type: 'dir',
-      name: item.name,
-      fullPath: item.fullName
-    };
-
-  return {
-    type: 'file',
-    name: item.name,
-    fullPath: item.fullName,
-    handle: toFileHandle({ item: item, ...info })
-  };
-}
-
-/** @deprecated */
-export function toFileHandle(info: {
-  storageName: string;
-  item: ListItem;
-  signer: Signer;
-  remote: boolean;
-}): sdk.ImportFileHandle {
-  if (info.remote) {
-    return createIndexImportHandle(info.storageName, info.item.fullName);
-  }
-
-  return createUploadImportHandle(
-    info.item.fullName,
-    info.signer,
-    info.item.size,
-    notEmpty(info.item.lastModified).seconds
-  );
-}
-
-export function createIndexImportHandle(
-  storageName: string,
-  path: string
-): sdk.ImportFileHandleIndex {
-  const data: ImportFileHandleIndexData = {
-    storageId: storageName,
-    path: path
-  };
-
-  return `index://index/${encodeURIComponent(JSON.stringify(data))}`;
-}
-
-export function createUploadImportHandle(
-  localPath: string,
-  signer: Signer,
-  sizeBytes: bigint,
-  modificationTimeSeconds: bigint
-): sdk.ImportFileHandleUpload {
-  const data: ImportFileHandleUploadData = {
-    localPath,
-    pathSignature: signer.sign(localPath),
-    sizeBytes: String(sizeBytes),
-    modificationTime: String(modificationTimeSeconds)
-  };
-
-  return `upload://upload/${encodeURIComponent(JSON.stringify(data))}`;
-}
-
-export function parseUploadHandle(handle: sdk.ImportFileHandleUpload): ImportFileHandleUploadData {
-  const url = new URL(handle);
-  return ImportFileHandleUploadData.parse(
-    JSON.parse(decodeURIComponent(url.pathname.substring(1)))
-  );
-}
-
-export function parseIndexHandle(handle: sdk.ImportFileHandleIndex): ImportFileHandleIndexData {
-  const url = new URL(handle);
-  return ImportFileHandleIndexData.parse(JSON.parse(decodeURIComponent(url.pathname.substring(1))));
-}
-
-export function toListItem(
-  logger: MiLogger,
-  info: {
-    directory: string;
-    fullName: string;
-    dirent: Dirent;
-    stat: Stats;
-  }
-): ListItem | undefined {
-  if (!(info.dirent.isFile() || info.dirent.isDirectory())) {
-    logger.warn(`tried to get non-dir and non-file ${info.dirent.name}, skip it`);
-    return;
-  }
-
-  return {
-    directory: info.directory,
-    isDir: info.dirent.isDirectory(),
-    name: info.dirent.name,
-    fullName: info.fullName,
-    lastModified: {
-      seconds: BigInt(Math.floor(info.stat.mtimeMs / 1000)),
-      nanos: 0
-    },
-    size: BigInt(info.stat.size)
-  };
-}