@spinajs/fs-s3 2.0.179 → 2.0.181

package/lib/cjs/config.d.ts

@@ -0,0 +1,13 @@
+declare const fs: {
+    fs: {
+        providers: {
+            service: string;
+            name: string;
+            basePath: string;
+            cleanupInterval: number;
+            maxFileAge: number;
+        }[];
+    };
+};
+export default fs;
+//# sourceMappingURL=config.d.ts.map

package/lib/cjs/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,EAAE;;;;;;;;;;CAmBP,CAAC;AAEF,eAAe,EAAE,CAAC"}

package/lib/cjs/config.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+function dir(path) {
+    return (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.cwd(), path)));
+}
+const fs = {
+    fs: {
+        providers: [
+            /**
+             * provide temporary fs access for s3 files
+             */
+            {
+                service: 'fsNativeTemp',
+                name: 'fs-temp-s3',
+                basePath: dir('./../fs/temp-s3'),
+                // in ms
+                cleanupInterval: 3600 * 1000,
+                // in seconds
+                maxFileAge: 24 * 3600, // 1 day for temp files
+            },
+        ],
+    },
+};
+exports.default = fs;
+//# sourceMappingURL=config.js.map

package/lib/cjs/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;AAAA,+BAAgD;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,OAAO,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,EAAE,GAAG;IACT,EAAE,EAAE;QACF,SAAS,EAAE;YACT;;eAEG;YACH;gBACE,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,YAAY;gBAClB,QAAQ,EAAE,GAAG,CAAC,iBAAiB,CAAC;gBAEhC,QAAQ;gBACR,eAAe,EAAE,IAAI,GAAG,IAAI;gBAE5B,aAAa;gBACb,UAAU,EAAE,EAAE,GAAG,IAAI,EAAE,uBAAuB;aAC/C;SACF;KACF;CACF,CAAC;AAEF,kBAAe,EAAE,CAAC"}

package/lib/cjs/index.d.ts

@@ -1,111 +1,137 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Log } from '@spinajs/log-common';
-import { fs, IStat, IZipResult } from '@spinajs/fs';
-import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3';
-import { ReadStream } from 'fs';
-export interface IS3Config {
-    bucket: string;
-    name: string;
-}
-/**
- * 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 fsS3 extends fs {
-    Options: IS3Config;
-    protected Logger: Log;
-    protected S3: S3Client;
-    protected AwsConfig: S3ClientConfig;
-    /**
-     * File system for temporary files
-     */
-    protected TempFs: fs;
-    /**
-     * 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: IS3Config);
-    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>;
-    /**
-     * 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>;
-    upload(srcPath: string, destPath?: string): Promise<void>;
-    writeStream(path: string, rStream?: ReadStream | BufferEncoding, encoding?: BufferEncoding): Promise<any>;
-    /**
-     * Checks if file existst
-     * @param path - path to check
-     */
-    exists(path: string): Promise<boolean>;
-    dirExists(): 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
-     *
-     */
-    mkdir(): 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" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Log } from '@spinajs/log-common';
+import { fs, IStat, IZipResult, FileInfoService } from '@spinajs/fs';
+import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3';
+import { Readable } from 'stream';
+export interface IS3Config {
+    bucket: string;
+    name: string;
+}
+/**
+ * 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 fsS3 extends fs {
+    Options: IS3Config;
+    protected Logger: Log;
+    protected S3: S3Client;
+    protected AwsConfig: S3ClientConfig;
+    /**
+     * File system for temporary files
+     */
+    protected TempFs: fs;
+    protected FileInfo: FileInfoService;
+    /**
+     * 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: IS3Config);
+    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>;
+    /**
+     * read all content of file
+     */
+    read(path: string, encoding: BufferEncoding): Promise<string | Buffer>;
+    /**
+     *
+     * @param path
+     * @param _encoding
+     * @returns
+     */
+    readStream(path: string, encoding?: BufferEncoding): Promise<Readable | NodeJS.ReadWriteStream>;
+    /**
+     * Write to file string or buffer
+     */
+    write(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    /**
+     * NOTE: append on s3 downloads file, appends to it, then uploads it again
+     * so it can be slow on large files
+     *
+     * @param path
+     * @param data
+     * @param encoding
+     */
+    append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    upload(srcPath: string, destPath?: string): Promise<void>;
+    /**
+     *
+     * Gets metadata of file in s3 bucket
+     *
+     * @param path path to file
+     * @returns
+     */
+    getMetadata(path: string): Promise<Record<string, string>>;
+    /**
+     *
+     * Returns writable stream for given path
+     *
+     * @param path file path ( relative to base path of provider)
+     * @param rStream readable stream, must be provided beforehand
+     * @param encoding optional stream encoding
+     */
+    writeStream(_path: string, _encoding?: BufferEncoding): Promise<any>;
+    /**
+     * Checks if file existst
+     * @param path - path to check
+     */
+    exists(path: string): Promise<boolean>;
+    dirExists(): Promise<boolean>;
+    /**
+     * Copy file 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 dir recursively & all contents inside
+     *
+     * @param path - dir to remove
+     */
+    rm(_path: string): Promise<void>;
+    /**
+     *
+     * Creates directory, recursively
+     *
+     */
+    mkdir(): Promise<void>;
+    isDir(_path: string): Promise<boolean>;
+    /**
+     * 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, _dstFs?: fs, _dstFile?: string): Promise<IZipResult>;
+    resolvePath(_path: string): string;
+}
 //# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAc,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAqG,MAAM,oBAAoB,CAAC;AAMjK,OAAO,EAA8C,UAAU,EAAE,MAAM,IAAI,CAAC;AAI5E,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,qBAEa,IAAK,SAAQ,EAAE;IAuBP,OAAO,EAAE,SAAS;IArBrC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IAGvB,SAAS,CAAC,SAAS,EAAE,cAAc,CAAC;IAEpC;;OAEG;IAEH,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;IAErB;;;OAGG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;gBAEkB,OAAO,EAAE,SAAS;IAIxB,OAAO;IAIpB;;;;;;OAMG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBpD;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc;IAS3C,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAK/D;;OAEG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAapE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAsCrF,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAWzC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,cAAc,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBtH;;;OAGG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM;IAiBnB,SAAS;IAMtB;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAU5C;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAKlD;;OAEG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIpD;;;;;OAKG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO;IAcpD;;;;;OAKG;IACU,EAAE,CAAC,KAAK,EAAE,MAAM;IAU7B;;;;OAIG;IACU,KAAK;IAIlB;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAoCxC,OAAO,IAAI,MAAM;IAIxB;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM;IAWxB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAI/B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IA6B5D,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAG1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAc,eAAe,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EACL,QAAQ,EACR,cAAc,EAMf,MAAM,oBAAoB,CAAC;AAO5B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGlC,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,qBAEa,IAAK,SAAQ,EAAE;IA0BP,OAAO,EAAE,SAAS;IAxBrC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC;IAGvB,SAAS,CAAC,SAAS,EAAE,cAAc,CAAC;IAEpC;;OAEG;IAEH,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;IAGrB,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC;IAEpC;;;OAGG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;gBAEkB,OAAO,EAAE,SAAS;IAIxB,OAAO;IAepB;;;;;;OAMG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBpD;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc;IASxD;;;;;OAKG;IACU,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAgB/D;;OAEG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAajF;;;;;;;OAOG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrF,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IA4BtD;;;;;;OAMG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM;IAWrC;;;;;;;OAOG;IACU,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF;;;OAGG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM;IAgBnB,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAI1C;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;IAkBxD;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;IAK9D;;OAEG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIpD;;;;;OAKG;IACU,EAAE,CAAC,KAAK,EAAE,MAAM;IAS7B;;;;OAIG;IACU,KAAK;IAIL,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInD;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAkCxC,OAAO,IAAI,MAAM;IAIxB;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM;IAWxB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAI/B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAI7E,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAS1C"}