@spinajs/fs 2.0.481 → 2.0.484

package/lib/mjs/temp-cleanup-strategy.d.ts

@@ -0,0 +1,70 @@
+import { Log } from '@spinajs/log-common';
+import { CronJob } from 'cron';
+import { fs, IFsTempOptions } from './interfaces.js';
+/**
+ * Cleanup policy for temporary filesystems. Implement and register
+ * to customize which files are considered stale and how they are removed,
+ * then select it via `cleanupStrategy` option of fsTemp provider.
+ *
+ * Strategy also owns its schedule - scheduling mechanism ( interval, cron, ... )
+ * is strategy specific and implemented in `start` / `stop`.
+ *
+ * Strategies hold scheduling state per temp filesystem, so implementations
+ * must be registered with `@NewInstance()` - otherwise a single instance
+ * would be shared between all temp filesystems.
+ */
+export declare abstract class TempCleanupStrategy {
+    protected Logger: Log;
+    /**
+     * Performs single cleanup sweep on given filesystem.
+     *
+     * @param fs backend filesystem holding temp files
+     * @param options temp fs configuration ( maxFileAge etc. )
+     */
+    abstract cleanup(fs: fs, options: IFsTempOptions): Promise<void>;
+    /**
+     * Starts scheduled cleanup - how sweeps are scheduled is up to the strategy.
+     *
+     * @param fs backend filesystem holding temp files
+     * @param options temp fs configuration
+     */
+    abstract start(fs: fs, options: IFsTempOptions): void;
+    /**
+     * Stops scheduled cleanup. Safe to call multiple times.
+     */
+    abstract stop(): void;
+    /**
+     * Single sweep guarded against errors - remote backends can fail
+     * ( network etc. ), scheduler tick must never crash.
+     */
+    protected safeCleanup(fs: fs, options: IFsTempOptions): Promise<void>;
+}
+/**
+ * Default cleanup - deletes first level files older than `maxFileAge` seconds,
+ * checked every `cleanupInterval` milliseconds.
+ *
+ * File age is taken from CreationTime when valid, otherwise from ModifiedTime -
+ * remote backends often lack creation time ( s3 reports epoch, ftp reports none ).
+ * Files with no usable timestamp are skipped. It does not check files recursively
+ * in subdirectories.
+ */
+export declare class MaxAgeTempCleanupStrategy extends TempCleanupStrategy {
+    /**
+     * timer instance used by interval-based scheduling
+     */
+    protected cleanupTimer: NodeJS.Timeout | null;
+    start(fs: fs, options: IFsTempOptions): void;
+    stop(): void;
+    cleanup(fs: fs, options: IFsTempOptions): Promise<void>;
+}
+/**
+ * Same sweep as MaxAgeTempCleanupStrategy ( `maxFileAge` still applies ),
+ * but scheduled by cron expression from `cleanupCronExpression` option
+ * instead of fixed interval. Expression is required - creation fails without it.
+ */
+export declare class CronTempCleanupStrategy extends MaxAgeTempCleanupStrategy {
+    protected cronJob: CronJob | null;
+    start(fs: fs, options: IFsTempOptions): void;
+    stop(): void;
+}
+//# sourceMappingURL=temp-cleanup-strategy.d.ts.map

package/lib/mjs/temp-cleanup-strategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"temp-cleanup-strategy.d.ts","sourceRoot":"","sources":["../../src/temp-cleanup-strategy.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAYrD;;;;;;;;;;;GAWG;AACH,8BAAsB,mBAAmB;IAEvC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB;;;;;OAKG;aACa,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAEvE;;;;;OAKG;aACa,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI;IAE5D;;OAEG;aACa,IAAI,IAAI,IAAI;IAE5B;;;OAGG;cACa,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAO5E;AAED;;;;;;;;GAQG;AACH,qBAEa,yBAA0B,SAAQ,mBAAmB;IAChE;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAQ;IAE9C,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI;IAS5C,IAAI,IAAI,IAAI;IAON,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAgCrE;AAED;;;;GAIG;AACH,qBAEa,uBAAwB,SAAQ,yBAAyB;IACpE,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAQ;IAElC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI;IAkC5C,IAAI,IAAI,IAAI;CAMpB"}

package/lib/mjs/temp-cleanup-strategy.js

@@ -0,0 +1,153 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Injectable, NewInstance } from '@spinajs/di';
+import { InvalidOption } from '@spinajs/exceptions';
+import { Log, Logger } from '@spinajs/log-common';
+import { CronJob } from 'cron';
+import { DateTime } from 'luxon';
+/**
+ * Default file age for temp files in seconds
+ */
+const DEFAULT_FILE_AGE = 60 * 60;
+/**
+ * Default cleanup interval in milliseconds
+ */
+const DEFAULT_CLEANUP_INTERVAL = 10 * 60 * 1000;
+/**
+ * Cleanup policy for temporary filesystems. Implement and register
+ * to customize which files are considered stale and how they are removed,
+ * then select it via `cleanupStrategy` option of fsTemp provider.
+ *
+ * Strategy also owns its schedule - scheduling mechanism ( interval, cron, ... )
+ * is strategy specific and implemented in `start` / `stop`.
+ *
+ * Strategies hold scheduling state per temp filesystem, so implementations
+ * must be registered with `@NewInstance()` - otherwise a single instance
+ * would be shared between all temp filesystems.
+ */
+export class TempCleanupStrategy {
+    /**
+     * Single sweep guarded against errors - remote backends can fail
+     * ( network etc. ), scheduler tick must never crash.
+     */
+    async safeCleanup(fs, options) {
+        try {
+            await this.cleanup(fs, options);
+        }
+        catch (err) {
+            this.Logger.warn(`Cleanup of temporary files system ${options.name} failed: ${err.message}`);
+        }
+    }
+}
+__decorate([
+    Logger('fs'),
+    __metadata("design:type", Log)
+], TempCleanupStrategy.prototype, "Logger", void 0);
+/**
+ * Default cleanup - deletes first level files older than `maxFileAge` seconds,
+ * checked every `cleanupInterval` milliseconds.
+ *
+ * File age is taken from CreationTime when valid, otherwise from ModifiedTime -
+ * remote backends often lack creation time ( s3 reports epoch, ftp reports none ).
+ * Files with no usable timestamp are skipped. It does not check files recursively
+ * in subdirectories.
+ */
+let MaxAgeTempCleanupStrategy = class MaxAgeTempCleanupStrategy extends TempCleanupStrategy {
+    constructor() {
+        super(...arguments);
+        /**
+         * timer instance used by interval-based scheduling
+         */
+        this.cleanupTimer = null;
+    }
+    start(fs, options) {
+        // never leak a previous timer on repeated start
+        this.stop();
+        this.cleanupTimer = setInterval(() => {
+            void this.safeCleanup(fs, options);
+        }, options.cleanupInterval ?? DEFAULT_CLEANUP_INTERVAL);
+    }
+    stop() {
+        if (this.cleanupTimer) {
+            clearInterval(this.cleanupTimer);
+            this.cleanupTimer = null;
+        }
+    }
+    async cleanup(fs, options) {
+        const files = await fs.list('/');
+        const now = DateTime.now();
+        const maxFileAge = options.maxFileAge ?? DEFAULT_FILE_AGE;
+        // s3 fills missing times with DateTime.min() - treat epoch-or-older as "no data"
+        const valid = (t) => !!t && t.isValid && t.toMillis() > 0;
+        for (const f of files) {
+            // per-file guard - one failing stat/rm must not abort whole sweep
+            try {
+                const stat = await fs.stat(f);
+                const ts = valid(stat.CreationTime) ? stat.CreationTime : stat.ModifiedTime;
+                if (!valid(ts)) {
+                    continue;
+                }
+                if (now.diff(ts, 'seconds').seconds > maxFileAge) {
+                    this.Logger.trace(`Temp file at path ${f} is older than ${maxFileAge} seconds, ( CreatedAt: ${ts.toFormat('dd/MM/yyyy HH:mm:ss')} ), deleting...`);
+                    await fs.rm(f);
+                }
+            }
+            catch (err) {
+                this.Logger.warn(`Cleanup of temp file ${f} on fs ${fs.Name} failed: ${err.message}`);
+            }
+        }
+    }
+};
+MaxAgeTempCleanupStrategy = __decorate([
+    Injectable(TempCleanupStrategy),
+    NewInstance()
+], MaxAgeTempCleanupStrategy);
+export { MaxAgeTempCleanupStrategy };
+/**
+ * Same sweep as MaxAgeTempCleanupStrategy ( `maxFileAge` still applies ),
+ * but scheduled by cron expression from `cleanupCronExpression` option
+ * instead of fixed interval. Expression is required - creation fails without it.
+ */
+let CronTempCleanupStrategy = class CronTempCleanupStrategy extends MaxAgeTempCleanupStrategy {
+    constructor() {
+        super(...arguments);
+        this.cronJob = null;
+    }
+    start(fs, options) {
+        if (!options.cleanupCronExpression) {
+            throw new InvalidOption(`Temp filesystem ${options.name} uses CronTempCleanupStrategy but 'cleanupCronExpression' option is not set`);
+        }
+        if (options.cleanupInterval) {
+            this.Logger.warn(`Temp filesystem ${options.name} sets 'cleanupInterval' but CronTempCleanupStrategy ignores it, schedule is driven by 'cleanupCronExpression'`);
+        }
+        this.stop();
+        // CronJob ctor throws on invalid expression - wrap for a clearer error
+        try {
+            this.cronJob = new CronJob(options.cleanupCronExpression, () => {
+                void this.safeCleanup(fs, options);
+            }, null, true);
+        }
+        catch (err) {
+            throw new InvalidOption(`Temp filesystem ${options.name} has invalid cron expression '${options.cleanupCronExpression}': ${err.message}`);
+        }
+    }
+    stop() {
+        if (this.cronJob) {
+            this.cronJob.stop();
+            this.cronJob = null;
+        }
+    }
+};
+CronTempCleanupStrategy = __decorate([
+    Injectable(TempCleanupStrategy),
+    NewInstance()
+], CronTempCleanupStrategy);
+export { CronTempCleanupStrategy };
+//# sourceMappingURL=temp-cleanup-strategy.js.map

package/lib/mjs/temp-cleanup-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"temp-cleanup-strategy.js","sourceRoot":"","sources":["../../src/temp-cleanup-strategy.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC;;GAEG;AACH,MAAM,gBAAgB,GAAG,EAAE,GAAG,EAAE,CAAC;AAEjC;;GAEG;AACH,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEhD;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,mBAAmB;IAyBvC;;;OAGG;IACO,KAAK,CAAC,WAAW,CAAC,EAAM,EAAE,OAAuB;QACzD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,OAAO,CAAC,IAAI,YAAa,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC;CACF;AAlCW;IADT,MAAM,CAAC,IAAI,CAAC;8BACK,GAAG;mDAAC;AAoCxB;;;;;;;;GAQG;AAGI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,mBAAmB;IAA3D;;QACL;;WAEG;QACO,iBAAY,GAA0B,IAAI,CAAC;IAkDvD,CAAC;IAhDQ,KAAK,CAAC,EAAM,EAAE,OAAuB;QAC1C,gDAAgD;QAChD,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE;YACnC,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC,EAAE,OAAO,CAAC,eAAe,IAAI,wBAAwB,CAAC,CAAC;IAC1D,CAAC;IAEM,IAAI;QACT,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAM,EAAE,OAAuB;QAClD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;QAC3B,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,gBAAgB,CAAC;QAE1D,iFAAiF;QACjF,MAAM,KAAK,GAAG,CAAC,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAErE,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,kEAAkE;YAClE,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC9B,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;gBAE5E,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBAED,IAAI,GAAG,CAAC,IAAI,CAAC,EAAG,EAAE,SAAS,CAAC,CAAC,OAAO,GAAG,UAAU,EAAE,CAAC;oBAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qBAAqB,CAAC,kBAAkB,UAAU,0BAA0B,EAAG,CAAC,QAAQ,CACtF,qBAAqB,CACtB,iBAAiB,CACnB,CAAC;oBAEF,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACjB,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC,IAAI,YAAa,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;YACnG,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAA;AAtDY,yBAAyB;IAFrC,UAAU,CAAC,mBAAmB,CAAC;IAC/B,WAAW,EAAE;GACD,yBAAyB,CAsDrC;;AAED;;;;GAIG;AAGI,IAAM,uBAAuB,GAA7B,MAAM,uBAAwB,SAAQ,yBAAyB;IAA/D;;QACK,YAAO,GAAmB,IAAI,CAAC;IA0C3C,CAAC;IAxCQ,KAAK,CAAC,EAAM,EAAE,OAAuB;QAC1C,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;YACnC,MAAM,IAAI,aAAa,CACrB,mBAAmB,OAAO,CAAC,IAAI,6EAA6E,CAC7G,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,mBAAmB,OAAO,CAAC,IAAI,+GAA+G,CAC/I,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,uEAAuE;QACvE,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CACxB,OAAO,CAAC,qBAAqB,EAC7B,GAAG,EAAE;gBACH,KAAK,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACrC,CAAC,EACD,IAAI,EACJ,IAAI,CACL,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,aAAa,CACrB,mBAAmB,OAAO,CAAC,IAAI,iCAAiC,OAAO,CAAC,qBAAqB,MAC1F,GAAa,CAAC,OACjB,EAAE,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,IAAI;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACtB,CAAC;IACH,CAAC;CACF,CAAA;AA3CY,uBAAuB;IAFnC,UAAU,CAAC,mBAAmB,CAAC;IAC/B,WAAW,EAAE;GACD,uBAAuB,CA2CnC"}

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

@@ -0,0 +1,59 @@
+import { Log } from '@spinajs/log-common';
+import { WriteStream } from 'fs';
+import { PassThrough } from 'stream';
+import { fs, IFsTempOptions, IStat, IZipResult } from './interfaces.js';
+import { TempCleanupStrategy } from './temp-cleanup-strategy.js';
+/**
+ * Temp filesystem. Use it for creating and storing temporary files and dirs.
+ *
+ * It is a wrapper over any other registered fs provider - all file operations are
+ * delegated to backend fs selected by `provider` option, so temp files can live
+ * on local disk, s3, ftp etc. Backend must be a registered fs provider - creation
+ * fails otherwise.
+ *
+ * Old files are automatically deleted by configured TempCleanupStrategy
+ * ( default: first level files older than `maxFileAge` seconds ).
+ */
+export declare class fsTemp extends fs {
+    Options: IFsTempOptions;
+    protected Logger: Log;
+    /**
+     * Backend filesystem holding temp files. Registered and disposed
+     * independently - this wrapper does not own it.
+     */
+    protected Provider: fs;
+    /**
+     * Cleanup policy, selectable via `cleanupStrategy` option.
+     * Owns its own schedule ( interval, cron, ... ) via start / stop.
+     */
+    protected CleanupStrategy: TempCleanupStrategy;
+    get Name(): string;
+    constructor(Options: IFsTempOptions);
+    resolve(): Promise<void>;
+    dispose(): Promise<void>;
+    download(path: string): Promise<string>;
+    upload(srcPath: string, destPath?: string): Promise<void>;
+    hash(path: string, algo?: string): Promise<string>;
+    metadata(path: string): Promise<import("./interfaces.js").IFileInfo>;
+    resolvePath(path: string): string;
+    read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    readStream(path: string, encoding?: BufferEncoding): Promise<NodeJS.ReadableStream>;
+    write(path: string, data: string | Uint8Array, encoding?: BufferEncoding): Promise<void>;
+    writeStream(path: string, encoding?: BufferEncoding): Promise<WriteStream | PassThrough>;
+    writeStream(path: string, readStream: NodeJS.ReadableStream | BufferEncoding, encoding?: BufferEncoding): Promise<WriteStream | PassThrough>;
+    exists(path: string): Promise<boolean>;
+    dirExists(path: string): Promise<boolean>;
+    copy(path: string, dest: string, dstFs?: fs): Promise<void>;
+    move(oldPath: string, newPath: string, dstFs?: fs): Promise<void>;
+    rename(oldPath: string, newPath: string): Promise<void>;
+    rm(path: string): Promise<void>;
+    mkdir(path: string): Promise<void>;
+    stat(path: string): Promise<IStat>;
+    list(path: string): Promise<string[]>;
+    tmppath(): string;
+    append(path: string, data: string | Uint8Array, encoding?: BufferEncoding): Promise<void>;
+    zip(path: string | (string | string[])[], dstFs?: fs, dstFile?: string): Promise<IZipResult>;
+    unzip(srcPath: string, destPath?: string, dstFs?: fs): Promise<string>;
+    isDir(path: string): Promise<boolean>;
+}
+//# sourceMappingURL=temp-provider.d.ts.map

package/lib/mjs/temp-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"temp-provider.d.ts","sourceRoot":"","sources":["../../src/temp-provider.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAA6B,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAE5F;;;;;;;;;;GAUG;AACH,qBAEa,MAAO,SAAQ,EAAE;IAoBT,OAAO,EAAE,cAAc;IAlB1C,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC;IAEvB;;;OAGG;IACH,SAAS,CAAC,eAAe,EAAE,mBAAmB,CAAC;IAE/C,IAAW,IAAI,IAAI,MAAM,CAExB;gBAEkB,OAAO,EAAE,cAAc;IAQ7B,OAAO;IA0CP,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAK9B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,QAAQ,CAAC,IAAI,EAAE,MAAM;IAI3B,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIjC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAIvE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;IAInF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxF,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IACxF,WAAW,CAChB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,CAAC,cAAc,GAAG,cAAc,EAClD,QAAQ,CAAC,EAAE,cAAc,GACxB,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;IAS9B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIlC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAIrC,OAAO,IAAI,MAAM;IAIjB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzF,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAM5F,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAItE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAG7C"}

package/lib/mjs/temp-provider.js

@@ -0,0 +1,147 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { IOFail } from '@spinajs/exceptions';
+import { DI, Injectable, PerInstanceCheck, ResolveException } from '@spinajs/di';
+import { Log, Logger } from '@spinajs/log-common';
+import { fs } from './interfaces.js';
+import { MaxAgeTempCleanupStrategy, TempCleanupStrategy } from './temp-cleanup-strategy.js';
+/**
+ * Temp filesystem. Use it for creating and storing temporary files and dirs.
+ *
+ * It is a wrapper over any other registered fs provider - all file operations are
+ * delegated to backend fs selected by `provider` option, so temp files can live
+ * on local disk, s3, ftp etc. Backend must be a registered fs provider - creation
+ * fails otherwise.
+ *
+ * Old files are automatically deleted by configured TempCleanupStrategy
+ * ( default: first level files older than `maxFileAge` seconds ).
+ */
+let fsTemp = class fsTemp extends fs {
+    get Name() {
+        return this.Options.name;
+    }
+    constructor(Options) {
+        super();
+        this.Options = Options;
+        if (!this.Options) {
+            throw new IOFail('Options for fs provider not provided, cannot create fs provider instance');
+        }
+    }
+    async resolve() {
+        await super.resolve();
+        if (!this.Options.provider) {
+            throw new ResolveException(`Temp filesystem ${this.Options.name} has no backend fs configured, set 'provider' option to name of registered fs provider`);
+        }
+        if (this.Options.provider === this.Options.name) {
+            throw new ResolveException(`Temp filesystem ${this.Options.name} cannot use itself as backend fs`);
+        }
+        // throws ResolveException when backend fs is not registered
+        this.Provider = DI.resolve('__file_provider__', [this.Options.provider]);
+        const strategies = DI.RootContainer.Registry.getTypes(TempCleanupStrategy);
+        const strategyName = this.Options.cleanupStrategy ?? MaxAgeTempCleanupStrategy.name;
+        const strategyType = strategies.find((x) => x.name === strategyName);
+        if (!strategyType) {
+            throw new ResolveException(`Temp cleanup strategy ${strategyName} not registered, make sure it is imported and registered in DI container`);
+        }
+        this.CleanupStrategy = await DI.resolve(strategyType);
+        if (!this.Options.cleanup) {
+            this.Logger.info(`Cleanup for temporary files system ${this.Options.name} set to false. Check configuration file if you want to automatically clenaup temporary files.`);
+            return;
+        }
+        this.Logger.info(`Starting cleanup for temporary files system ${this.Options.name}, backend: ${this.Options.provider}, strategy: ${strategyName}, interval: ${this.Options.cleanupInterval}, cron: ${this.Options.cleanupCronExpression}, max file age: ${this.Options.maxFileAge}`);
+        this.CleanupStrategy.start(this.Provider, this.Options);
+    }
+    async dispose() {
+        // backend fs is a separately registered provider - do not dispose it here
+        this.CleanupStrategy?.stop();
+    }
+    download(path) {
+        return this.Provider.download(path);
+    }
+    upload(srcPath, destPath) {
+        return this.Provider.upload(srcPath, destPath);
+    }
+    async hash(path, algo) {
+        return this.Provider.hash(path, algo);
+    }
+    async metadata(path) {
+        return this.Provider.metadata(path);
+    }
+    resolvePath(path) {
+        return this.Provider.resolvePath(path);
+    }
+    read(path, encoding) {
+        return this.Provider.read(path, encoding);
+    }
+    readStream(path, encoding) {
+        return this.Provider.readStream(path, encoding);
+    }
+    write(path, data, encoding) {
+        return this.Provider.write(path, data, encoding);
+    }
+    writeStream(path, rStream, encoding) {
+        return this.Provider.writeStream(path, rStream, encoding);
+    }
+    exists(path) {
+        return this.Provider.exists(path);
+    }
+    dirExists(path) {
+        return this.Provider.dirExists(path);
+    }
+    copy(path, dest, dstFs) {
+        return this.Provider.copy(path, dest, dstFs);
+    }
+    move(oldPath, newPath, dstFs) {
+        return this.Provider.move(oldPath, newPath, dstFs);
+    }
+    rename(oldPath, newPath) {
+        return this.Provider.rename(oldPath, newPath);
+    }
+    rm(path) {
+        return this.Provider.rm(path);
+    }
+    mkdir(path) {
+        return this.Provider.mkdir(path);
+    }
+    stat(path) {
+        return this.Provider.stat(path);
+    }
+    list(path) {
+        return this.Provider.list(path);
+    }
+    tmppath() {
+        return this.Provider.tmppath();
+    }
+    append(path, data, encoding) {
+        return this.Provider.append(path, data, encoding);
+    }
+    zip(path, dstFs, dstFile) {
+        // default archive destination to this temp fs, not the backend - keeps
+        // IZipResult.fs pointing at temp fs name and avoids hardcoded 'fs-temp' fallback
+        return this.Provider.zip(path, dstFs ?? this, dstFile);
+    }
+    unzip(srcPath, destPath, dstFs) {
+        return this.Provider.unzip(srcPath, destPath, dstFs ?? this);
+    }
+    isDir(path) {
+        return this.Provider.isDir(path);
+    }
+};
+__decorate([
+    Logger('fs'),
+    __metadata("design:type", Log)
+], fsTemp.prototype, "Logger", void 0);
+fsTemp = __decorate([
+    Injectable('fs'),
+    PerInstanceCheck(),
+    __metadata("design:paramtypes", [Object])
+], fsTemp);
+export { fsTemp };
+//# sourceMappingURL=temp-provider.js.map

package/lib/mjs/temp-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"temp-provider.js","sourceRoot":"","sources":["../../src/temp-provider.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACjF,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,EAAE,EAAE,EAAqC,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAE5F;;;;;;;;;;GAUG;AAGI,IAAM,MAAM,GAAZ,MAAM,MAAO,SAAQ,EAAE;IAgB5B,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,YAAmB,OAAuB;QACxC,KAAK,EAAE,CAAC;QADS,YAAO,GAAP,OAAO,CAAgB;QAGxC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,MAAM,CAAC,0EAA0E,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QAEtB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,gBAAgB,CACxB,mBAAmB,IAAI,CAAC,OAAO,CAAC,IAAI,wFAAwF,CAC7H,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAChD,MAAM,IAAI,gBAAgB,CAAC,mBAAmB,IAAI,CAAC,OAAO,CAAC,IAAI,kCAAkC,CAAC,CAAC;QACrG,CAAC;QAED,4DAA4D;QAC5D,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,OAAO,CAAK,mBAAmB,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE7E,MAAM,UAAU,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC3E,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,yBAAyB,CAAC,IAAI,CAAC;QACpF,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;QAErE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,gBAAgB,CACxB,yBAAyB,YAAY,0EAA0E,CAChH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,MAAM,EAAE,CAAC,OAAO,CAAsB,YAAY,CAAC,CAAC;QAE3E,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sCAAsC,IAAI,CAAC,OAAO,CAAC,IAAI,+FAA+F,CACvJ,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,+CAA+C,IAAI,CAAC,OAAO,CAAC,IAAI,cAAc,IAAI,CAAC,OAAO,CAAC,QAAQ,eAAe,YAAY,eAAe,IAAI,CAAC,OAAO,CAAC,eAAe,WAAW,IAAI,CAAC,OAAO,CAAC,qBAAqB,mBAAmB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CACnQ,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,0EAA0E;QAC1E,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC;IAC/B,CAAC;IAEM,QAAQ,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAEM,MAAM,CAAC,OAAe,EAAE,QAAiB;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,IAAa;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAEM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAEM,IAAI,CAAC,IAAY,EAAE,QAAyB;QACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,IAAY,EAAE,QAAyB;QACvD,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,IAAY,EAAE,IAAyB,EAAE,QAAyB;QAC7E,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAQM,WAAW,CAChB,IAAY,EACZ,OAAgD,EAChD,QAAyB;QAEzB,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,OAAiD,EAAE,QAAQ,CAAC,CAAC;IACtG,CAAC;IAEM,MAAM,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAEM,IAAI,CAAC,IAAY,EAAE,IAAY,EAAE,KAAU;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEM,IAAI,CAAC,OAAe,EAAE,OAAe,EAAE,KAAU;QACtD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAEM,MAAM,CAAC,OAAe,EAAE,OAAe;QAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAEM,EAAE,CAAC,IAAY;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,IAAI,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAEM,IAAI,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,IAAY,EAAE,IAAyB,EAAE,QAAyB;QAC9E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,GAAG,CAAC,IAAoC,EAAE,KAAU,EAAE,OAAgB;QAC3E,uEAAuE;QACvE,iFAAiF;QACjF,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAEM,KAAK,CAAC,OAAe,EAAE,QAAiB,EAAE,KAAU;QACzD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF,CAAA;AAhLW;IADT,MAAM,CAAC,IAAI,CAAC;8BACK,GAAG;sCAAC;AAFX,MAAM;IAFlB,UAAU,CAAC,IAAI,CAAC;IAChB,gBAAgB,EAAE;;GACN,MAAM,CAkLlB"}