@spinajs/fs 2.0.180 → 2.0.182

package/lib/mjs/interfaces.d.ts

@@ -1,158 +1,181 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { AsyncService, IInstanceCheck, IMappableService } from '@spinajs/di';
-import { ReadStream, WriteStream } from 'fs';
-import { DateTime } from 'luxon';
-import { PassThrough } from 'stream';
-export interface IProviderConfiguration {
-    name: string;
-    service: string;
-}
-export interface IFsConfiguration {
-    defaultProvider: string;
-    providers: IProviderConfiguration[];
-}
-export interface IStat {
-    IsDirectory?: boolean;
-    IsFile?: boolean;
-    Size?: number;
-    AccessTime?: DateTime;
-    ModifiedTime?: DateTime;
-    CreationTime?: DateTime;
-    AdditionalData?: unknown;
-}
-export interface IFileInfo {
-    /**
-     * Size in bytes
-     */
-    FileSize: number;
-    Height?: number;
-    Width?: number;
-    Duration?: number;
-    FrameCount?: number;
-    FrameRate?: number;
-    Bitrate?: number;
-    Codec?: string;
-    LineCount?: number;
-    Encoding?: string;
-    MimeType?: string;
-    WordCount?: number;
-    AccessDate?: DateTime;
-    ModificationDate?: DateTime;
-    CreationDate?: DateTime;
-    /**
-     * Raw unprocessed data obtained from file info
-     */
-    Raw?: {};
-}
-export interface IFsLocalOptions {
-    /**
-     * Full path to local directory where files are hold.
-     * All paths will be relative to this directory
-     */
-    basePath: string;
-    /**
-     * Instance name of this filesystem. Used to share fs instances.
-     */
-    name: string;
-}
-export interface IFsLocalTempOptions extends IFsLocalOptions {
-    /**
-     * Should cleanup of old temp files be enabled
-     */
-    cleanup: boolean;
-    /**
-     * Cleanup interval in seconds
-     * Default is 10 minutes
-     */
-    cleanupInterval: number;
-    /**
-     * Max temp file age in seconds. Older thant this will be deleted.
-     * Default is 1 hour
-     */
-    maxFileAge: number;
-}
-export interface IZipResult {
-    asFilePath(): string;
-    asStream(): ReadStream;
-    asBase64(): string;
-}
-export declare abstract class fs extends AsyncService implements IMappableService, IInstanceCheck {
-    get ServiceName(): string;
-    __checkInstance__(creationOptions: any): boolean;
-    abstract Name: string;
-    /**
-     * Downloads file to local storage and returns path to it.
-     * If used on local storage provider eg. hard drive it only returns full path to file
-     *
-     * On remote storage provivers eg. amazon s3 - it tries to download it to local disk first and returns
-     * full path.
-     *
-     * Returns local path to file
-     *
-     * @param path path to download
-     */
-    abstract download(path: string): Promise<string>;
-    /**
-     * Copies local file into fs
-     *
-     * @param srcPath source path ( full absolute path eg. file from local disk )
-     * @param destPath dest path ( relative to base path of provider )
-     */
-    abstract upload(srcPath: string, destPath?: string): Promise<void>;
-    /**
-     *
-     * Returns full LOCAL path to file
-     *
-     * @param path path to resolve
-     */
-    abstract resolvePath(path: string): string;
-    abstract read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
-    abstract readStream(path: string, encoding?: BufferEncoding): Promise<ReadStream>;
-    abstract write(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
-    abstract writeStream(path: string, encoding?: BufferEncoding): Promise<WriteStream | PassThrough>;
-    abstract writeStream(path: string, readStream: ReadStream, encoding?: BufferEncoding): Promise<WriteStream | PassThrough | void>;
-    abstract exists(path: string): Promise<boolean>;
-    abstract dirExists(path: string): Promise<boolean>;
-    abstract copy(path: string, dest: string): Promise<void>;
-    abstract move(oldPath: string, newPath: string): Promise<void>;
-    abstract rename(oldPath: string, newPath: string): Promise<void>;
-    abstract unlink(path: string, downloaded?: boolean): Promise<void>;
-    abstract rm(path: string): Promise<void>;
-    abstract mkdir(path: string): Promise<void>;
-    abstract stat(path: string): Promise<IStat>;
-    abstract list(path: string): Promise<string[]>;
-    abstract tmppath(): string;
-    abstract append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
-    /**
-     *
-     * Compress specified file or dir in provided path. If
-     * Dir is compressed recursively
-     *
-     * @param path - path to zip
-     */
-    abstract zip(path: string): Promise<IZipResult>;
-    /**
-     * Decompress given file to destination path
-     *
-     * @param path path to zip file
-     * @param destPath path to destination dir
-     */
-    abstract unzip(srcPath: string, destPath: string): Promise<void>;
-    tmpname(): string;
-}
-/**
- * File information service, obtain file props, metadata etc.
- * Eg. movie resolution, image, codec etc. if possible
- */
-export declare abstract class FileInfoService {
-    abstract getInfo(pathToFile: string): Promise<IFileInfo>;
-}
-/**
- * File hasher, to create unique hash for file
- */
-export declare abstract class FileHasher {
-    abstract hash(pathToFile: string): Promise<string>;
-}
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { AsyncService, IInstanceCheck, IMappableService } from '@spinajs/di';
+import { ReadStream, WriteStream } from 'fs';
+import { DateTime } from 'luxon';
+import { PassThrough } from 'stream';
+export interface IProviderConfiguration {
+    name: string;
+    service: string;
+}
+export interface IFsConfiguration {
+    defaultProvider: string;
+    providers: IProviderConfiguration[];
+}
+export interface IStat {
+    IsDirectory?: boolean;
+    IsFile?: boolean;
+    Size?: number;
+    AccessTime?: DateTime;
+    ModifiedTime?: DateTime;
+    CreationTime?: DateTime;
+    AdditionalData?: unknown;
+}
+export interface IFileInfo {
+    /**
+     * Size in bytes
+     */
+    FileSize: number;
+    Height?: number;
+    Width?: number;
+    Duration?: number;
+    FrameCount?: number;
+    FrameRate?: number;
+    Bitrate?: number;
+    Codec?: string;
+    LineCount?: number;
+    Encoding?: string;
+    MimeType?: string;
+    WordCount?: number;
+    AccessDate?: DateTime;
+    ModificationDate?: DateTime;
+    CreationDate?: DateTime;
+    /**
+     * Raw unprocessed data obtained from file info
+     */
+    Raw?: {};
+}
+export interface IFsLocalOptions {
+    /**
+     * Full path to local directory where files are hold.
+     * All paths will be relative to this directory
+     *
+     * If path is not provided, it will behave like normal nodejs fs functions
+     */
+    basePath?: string;
+    /**
+     * Instance name of this filesystem. Used to share fs instances.
+     */
+    name: string;
+}
+export interface IFsLocalTempOptions extends IFsLocalOptions {
+    /**
+     * Should cleanup of old temp files be enabled
+     */
+    cleanup: boolean;
+    /**
+     * Cleanup interval in seconds
+     * Default is 10 minutes
+     */
+    cleanupInterval: number;
+    /**
+     * Max temp file age in seconds. Older thant this will be deleted.
+     * Default is 1 hour
+     */
+    maxFileAge: number;
+}
+export interface IZipResult {
+    /**
+     * Destination filesystem ( default is fs-temp for zipped files)
+     */
+    fs: fs;
+    asFilePath(): string;
+    asStream(): ReadStream;
+    asBase64(): string;
+    unlink(): void;
+}
+export declare abstract class fs extends AsyncService implements IMappableService, IInstanceCheck {
+    get ServiceName(): string;
+    __checkInstance__(creationOptions: any): boolean;
+    abstract Name: string;
+    /**
+     * Downloads file to local storage and returns path to it.
+     * If used on local storage provider eg. hard drive it only returns full path to file
+     *
+     * On remote storage provivers eg. amazon s3 - it tries to download it to local disk first and returns
+     * full path.
+     *
+     * Returns local path to file
+     *
+     * @param path path to download
+     */
+    abstract download(path: string): Promise<string>;
+    /**
+     * Copies local file into fs
+     *
+     * @param srcPath source path ( full absolute path eg. file from local disk )
+     * @param destPath dest path ( relative to base path of provider )
+     */
+    abstract upload(srcPath: string, destPath?: string): Promise<void>;
+    /**
+   *
+   * Returns hash of file
+   *
+   * @param srcPath file to calculate hash
+   * @param algo optional hash alghoritm, default is md5
+   */
+    hash(path: string, algo?: string): Promise<string>;
+    /**
+     *
+     * Returns full LOCAL path to file
+     *
+     * @param path path to resolve
+     */
+    abstract resolvePath(path: string): string;
+    abstract read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    abstract readStream(path: string, encoding?: BufferEncoding): Promise<NodeJS.ReadableStream>;
+    abstract write(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    abstract writeStream(path: string, encoding?: BufferEncoding): Promise<WriteStream | PassThrough>;
+    abstract writeStream(path: string, readStream: NodeJS.ReadableStream | BufferEncoding, encoding?: BufferEncoding): Promise<WriteStream | PassThrough>;
+    abstract exists(path: string): Promise<boolean>;
+    abstract dirExists(path: string): Promise<boolean>;
+    abstract copy(path: string, dest: string, dstFs?: fs): Promise<void>;
+    abstract move(oldPath: string, newPath: string, dstFs?: fs): Promise<void>;
+    abstract rename(oldPath: string, newPath: string): Promise<void>;
+    abstract rm(path: string): Promise<void>;
+    abstract mkdir(path: string): Promise<void>;
+    abstract stat(path: string): Promise<IStat>;
+    abstract list(path: string): Promise<string[]>;
+    abstract tmppath(): string;
+    abstract append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    /**
+     *
+     * Compress specified file or dir in provided path. If
+     * Dir is compressed recursively
+     *
+     * @param path - path to zip
+     * @param dstFile - destination file name
+     */
+    abstract zip(path: string | string[], dstFs?: fs, dstFile?: string): Promise<IZipResult>;
+    /**
+     * Decompress given file to destination path
+     *
+     * @param path path to zip file
+     * @param destPath path to destination dir
+     */
+    abstract unzip(srcPath: string, destPath: string, dstFs?: fs): Promise<void>;
+    /**
+     *
+     * Checks if given path is dir
+     *
+     * @param path path to check
+     */
+    abstract isDir(path: string): Promise<boolean>;
+    tmpname(): string;
+}
+/**
+ * File information service, obtain file props, metadata etc.
+ * Eg. movie resolution, image, codec etc. if possible
+ */
+export declare abstract class FileInfoService {
+    abstract getInfo(pathToFile: string): Promise<IFileInfo>;
+}
+/**
+ * File hasher, to create unique hash for file
+ */
+export declare abstract class FileHasher {
+    abstract hash(pathToFile: string): Promise<string>;
+}
 //# sourceMappingURL=interfaces.d.ts.map

package/lib/mjs/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;AACA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGrC,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,sBAAsB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,KAAK;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IAEH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC;CACV;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,IAAI,MAAM,CAAC;IACrB,QAAQ,IAAI,UAAU,CAAC;IACvB,QAAQ,IAAI,MAAM,CAAC;CACpB;AAED,8BAAsB,EAAG,SAAQ,YAAa,YAAW,gBAAgB,EAAE,cAAc;IACvF,IAAW,WAAW,WAErB;IAGM,iBAAiB,CAAC,eAAe,EAAE,GAAG,GAAG,OAAO;IAKvD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;;;;;;;OAUG;aACa,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEvD;;;;;OAKG;aACa,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAG1E;;;;;OAKG;aACa,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;aACjC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;aACvE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;aACxE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;aACpF,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;aACxF,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,UAAU,EACtB,QAAQ,CAAC,EAAE,cAAc,GACxB,OAAO,CAAC,WAAW,GAAG,WAAW,GAAG,IAAI,CAAC;aAC5B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;aACtC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;aACzC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAC/C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aACrD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aACvD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;aACzD,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAC/B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAClC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;aAClC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;aACrC,OAAO,IAAI,MAAM;aACjB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IACrG;;;;;;OAMG;aACa,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAEtD;;;;;OAKG;aACa,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhE,OAAO;CAGf;AAED;;;GAGG;AACH,8BAAsB,eAAe;aACnB,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAChE;AAED;;GAEG;AACH,8BAAsB,UAAU;aACd,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAC1D"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;;AACA,OAAO,EAAE,YAAY,EAAM,cAAc,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGrC,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,sBAAsB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,KAAK;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IAEH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAC5B,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,CAAC;CACV;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,EAAE,CAAC;IAGP,UAAU,IAAI,MAAM,CAAC;IAGrB,QAAQ,IAAI,UAAU,CAAC;IAGvB,QAAQ,IAAI,MAAM,CAAC;IAGnB,MAAM,IAAI,IAAI,CAAC;CAChB;AAED,8BAAsB,EAAG,SAAQ,YAAa,YAAW,gBAAgB,EAAE,cAAc;IACvF,IAAW,WAAW,WAErB;IAGM,iBAAiB,CAAC,eAAe,EAAE,GAAG,GAAG,OAAO;IAKvD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;;;;;;;OAUG;aACa,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEvD;;;;;OAKG;aACa,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEvE;;;;;;KAMC;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAK/D;;;;;OAKG;aACa,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;aACjC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;aACvE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;aACnF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;aACpF,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;aACxF,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,CAAC,cAAc,GAAG,cAAc,EAClD,QAAQ,CAAC,EAAE,cAAc,GACxB,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;aACrB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;aACtC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;aACzC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;aAC3D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;aACjE,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aACvD,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAC/B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAClC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;aAClC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;aACrC,OAAO,IAAI,MAAM;aACjB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IACrG;;;;;;;OAOG;aACa,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAE/F;;;;;OAKG;aACa,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnF;;;;;OAKG;aACa,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAE9C,OAAO;CAGf;AAED;;;GAGG;AACH,8BAAsB,eAAe;aACnB,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAChE;AAED;;GAEG;AACH,8BAAsB,UAAU;aACd,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAC1D"}

package/lib/mjs/interfaces.js

@@ -1,28 +1,39 @@
-/* eslint-disable security/detect-non-literal-fs-filename */
-import { AsyncService } from '@spinajs/di';
-import { v4 as uuidv4 } from 'uuid';
-export class fs extends AsyncService {
-    get ServiceName() {
-        return this.Name;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    __checkInstance__(creationOptions) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        return this.Name === creationOptions[0].name;
-    }
-    tmpname() {
-        return uuidv4();
-    }
-}
-/**
- * File information service, obtain file props, metadata etc.
- * Eg. movie resolution, image, codec etc. if possible
- */
-export class FileInfoService {
-}
-/**
- * File hasher, to create unique hash for file
- */
-export class FileHasher {
-}
+/* eslint-disable security/detect-non-literal-fs-filename */
+import { AsyncService, DI } from '@spinajs/di';
+import { v4 as uuidv4 } from 'uuid';
+export class fs extends AsyncService {
+    get ServiceName() {
+        return this.Name;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    __checkInstance__(creationOptions) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        return this.Name === creationOptions[0].name;
+    }
+    /**
+   *
+   * Returns hash of file
+   *
+   * @param srcPath file to calculate hash
+   * @param algo optional hash alghoritm, default is md5
+   */
+    async hash(path, algo) {
+        const hasher = DI.resolve(FileHasher, [algo]);
+        return hasher.hash(this.resolvePath(path));
+    }
+    tmpname() {
+        return uuidv4();
+    }
+}
+/**
+ * File information service, obtain file props, metadata etc.
+ * Eg. movie resolution, image, codec etc. if possible
+ */
+export class FileInfoService {
+}
+/**
+ * File hasher, to create unique hash for file
+ */
+export class FileHasher {
+}
 //# sourceMappingURL=interfaces.js.map

package/lib/mjs/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,OAAO,EAAE,YAAY,EAAoC,MAAM,aAAa,CAAC;AAI7E,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AA0FpC,MAAM,OAAgB,EAAG,SAAQ,YAAY;IAC3C,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,8DAA8D;IACvD,iBAAiB,CAAC,eAAoB;QAC3C,sEAAsE;QACtE,OAAO,IAAI,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IAuEM,OAAO;QACZ,OAAO,MAAM,EAAE,CAAC;IAClB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,eAAe;CAEpC;AAED;;GAEG;AACH,MAAM,OAAgB,UAAU;CAE/B"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,OAAO,EAAE,YAAY,EAAE,EAAE,EAAoC,MAAM,aAAa,CAAC;AAIjF,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAyGpC,MAAM,OAAgB,EAAG,SAAQ,YAAY;IAC3C,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,8DAA8D;IACvD,iBAAiB,CAAC,eAAoB;QAC3C,sEAAsE;QACtE,OAAO,IAAI,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IAyBC;;;;;;KAMC;IACI,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,IAAa;QAC3C,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,CAAa,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAuDM,OAAO;QACZ,OAAO,MAAM,EAAE,CAAC;IAClB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,eAAe;CAEpC;AAED;;GAEG;AACH,MAAM,OAAgB,UAAU;CAE/B"}

package/lib/mjs/local-provider.d.ts

@@ -1,101 +1,97 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { ReadStream } from 'fs';
-import { fs, IFsLocalOptions, IStat, IZipResult } from './interfaces.js';
-import { Log } from '@spinajs/log-common';
-/**
- * Abstract layer for file operations.
- * Basic implementation is just wrapper for native node fs functions
- *
- * It allows to wrap other libs eg. aws s3, ftp
- * and inject it into code without changing logic that use them.
- *
- * TODO: map errors to some kind of common errors shared with other implementations
- */
-export declare class fsNative<T extends IFsLocalOptions> extends fs {
-    Options: T;
-    protected Logger: Log;
-    /**
-     * Name of provider. We can have multiple providers of the same type but with different options.
-     * Also used in InjectService decorator for mapping
-     */
-    get Name(): string;
-    constructor(Options: T);
-    resolve(): Promise<void>;
-    /**
-     *
-     * Tries to download file to local filesystem, then returns local filesystem path.
-     * Native implementation simply returns local path and does nothing.
-     *
-     * @param path - file to download
-     */
-    download(path: string): Promise<string>;
-    upload(srcPath: string, destPath?: string): Promise<void>;
-    /**
-     * read all content of file
-     */
-    read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
-    readStream(path: string, encoding?: BufferEncoding): Promise<ReadStream>;
-    /**
-     * Write to file string or buffer
-     */
-    write(path: string, data: string | Buffer, encoding: BufferEncoding): Promise<void>;
-    append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
-    writeStream(path: string, rStream?: BufferEncoding | ReadStream, encoding?: BufferEncoding): Promise<import("fs").WriteStream>;
-    /**
-     * Checks if file existst
-     * @param path - path to check
-     */
-    exists(path: string): Promise<boolean>;
-    dirExists(path: string): Promise<boolean>;
-    /**
-     * Copy file to another location
-     * @param path - src path
-     * @param dest - dest path
-     */
-    copy(path: string, dest: string): Promise<void>;
-    /**
-     * Copy file to another location and deletes src file
-     */
-    move(oldPath: string, newPath: string): Promise<void>;
-    /**
-     * Change name of a file
-     */
-    rename(oldPath: string, newPath: string): Promise<void>;
-    /**
-     * Deletes file permanently
-     *
-     * @param path - path to file that will be deleted
-     * @param onlyTemp - remote filesystems need to download file before, if so, calling unlink with this flag removes only local temp file after we finished processing
-     */
-    unlink(path: string, onlyTemp?: boolean): Promise<void>;
-    /**
-     *
-     * Deletes dir recursively & all contents inside
-     *
-     * @param path - dir to remove
-     */
-    rm(path: string): Promise<void>;
-    /**
-     *
-     * Creates directory, recursively
-     *
-     * @param path - directory to create
-     */
-    mkdir(path: string): Promise<void>;
-    /**
-     * Returns file statistics, not all fields may be accesible
-     */
-    stat(path: string): Promise<IStat>;
-    tmppath(): string;
-    /**
-     * List content of directory
-     *
-     * @param path - path to directory
-     */
-    list(path: string): Promise<string[]>;
-    unzip(path: string, destPath: string): Promise<void>;
-    zip(path: string, zName?: string): Promise<IZipResult>;
-    resolvePath(path: string): string;
-}
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { ReadStream } from 'fs';
+import { fs, IFsLocalOptions, IStat, IZipResult } from './interfaces.js';
+import { Log } from '@spinajs/log-common';
+/**
+ * Abstract layer for file operations.
+ * Basic implementation is just wrapper for native node fs functions
+ *
+ * It allows to wrap other libs eg. aws s3, ftp
+ * and inject it into code without changing logic that use them.
+ *
+ * TODO: map errors to some kind of common errors shared with other implementations
+ */
+export declare class fsNative<T extends IFsLocalOptions> extends fs {
+    Options: T;
+    protected Logger: Log;
+    /**
+     * Name of provider. We can have multiple providers of the same type but with different options.
+     * Also used in InjectService decorator for mapping
+     */
+    get Name(): string;
+    constructor(Options: T);
+    resolve(): Promise<void>;
+    /**
+     *
+     * Tries to download file to local filesystem, then returns local filesystem path.
+     * Native implementation simply returns local path and does nothing.
+     *
+     * @param path - file to download
+     */
+    download(path: string): Promise<string>;
+    upload(srcPath: string, destPath?: string): Promise<void>;
+    /**
+     * read all content of file
+     */
+    read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    readStream(path: string, encoding?: BufferEncoding): Promise<ReadStream>;
+    /**
+     * Write to file string or buffer
+     */
+    write(path: string, data: string | Buffer, encoding: BufferEncoding): Promise<void>;
+    append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    writeStream(path: string, rStream?: BufferEncoding | NodeJS.ReadStream, encoding?: BufferEncoding): Promise<import("fs").WriteStream>;
+    /**
+     * Checks if file existst
+     * @param path - path to check
+     */
+    exists(path: string): Promise<boolean>;
+    dirExists(path: string): Promise<boolean>;
+    /**
+     * Copy file or dir to another location
+     * @param path - src path
+     * @param dest - dest path
+     */
+    copy(path: string, dest: string, dstFs?: fs): Promise<void>;
+    /**
+     * Copy file to another location and deletes src file
+     */
+    move(oldPath: string, newPath: string, dstFs?: fs): Promise<void>;
+    /**
+     * Change name of a file
+     */
+    rename(oldPath: string, newPath: string): Promise<void>;
+    /**
+     *
+     * Deletes file OR
+     * Deletes dir recursively & all contents inside
+     *
+     * @param path - dir to remove
+     */
+    rm(path: string): Promise<void>;
+    /**
+     *
+     * Creates directory, recursively
+     *
+     * @param path - directory to create
+     */
+    mkdir(path: string): Promise<void>;
+    /**
+     * Returns file statistics, not all fields may be accesible
+     */
+    stat(path: string): Promise<IStat>;
+    tmppath(): string;
+    /**
+     * List content of directory
+     *
+     * @param path - path to directory
+     */
+    list(path: string): Promise<string[]>;
+    unzip(path: string, destPath?: string, dstFs?: fs): Promise<void>;
+    isDir(path: string): Promise<boolean>;
+    zip(path: string | string[], dstFs?: fs, dstFile?: string): Promise<IZipResult>;
+    resolvePath(path: string): string;
+}
 //# sourceMappingURL=local-provider.d.ts.map