@rsdk/nats.object-storage 5.4.0-next.2

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [5.4.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.4.0-next.1...v5.4.0-next.2) (2024-11-25)
+
+### Features
+
+* **nats:** nats transport/kv/os + examples + docs ([#306](https://github.com/R-Vision/rsdk/issues/306)) ([de67eed](https://github.com/R-Vision/rsdk/commit/de67eed8b4cb17ec9d359067eae1e0c35d6cc736))

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE = "nats-object-storages";

package/dist/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE = void 0;
+exports.NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE = 'nats-object-storages';
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,wCAAwC,GAAG,sBAAsB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { NatsObjectStorageService } from './nats-object-storage.service';
+export { WatchObjectStorage, type ObjectStorageWatcher, } from './watch-object-storage.decorator';
+export { NatsObjectStorageModule } from './nats-object-storage.module';
+export { ObjectStorage } from './object-storage';
+export * from './inject-object-storage-service.decorator';

package/dist/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectStorage = exports.NatsObjectStorageModule = exports.WatchObjectStorage = exports.NatsObjectStorageService = void 0;
+var nats_object_storage_service_1 = require("./nats-object-storage.service");
+Object.defineProperty(exports, "NatsObjectStorageService", { enumerable: true, get: function () { return nats_object_storage_service_1.NatsObjectStorageService; } });
+var watch_object_storage_decorator_1 = require("./watch-object-storage.decorator");
+Object.defineProperty(exports, "WatchObjectStorage", { enumerable: true, get: function () { return watch_object_storage_decorator_1.WatchObjectStorage; } });
+var nats_object_storage_module_1 = require("./nats-object-storage.module");
+Object.defineProperty(exports, "NatsObjectStorageModule", { enumerable: true, get: function () { return nats_object_storage_module_1.NatsObjectStorageModule; } });
+var object_storage_1 = require("./object-storage");
+Object.defineProperty(exports, "ObjectStorage", { enumerable: true, get: function () { return object_storage_1.ObjectStorage; } });
+__exportStar(require("./inject-object-storage-service.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,6EAAyE;AAAhE,uIAAA,wBAAwB,OAAA;AACjC,mFAG0C;AAFxC,oIAAA,kBAAkB,OAAA;AAGpB,2EAAuE;AAA9D,qIAAA,uBAAuB,OAAA;AAChC,mDAAiD;AAAxC,+GAAA,aAAa,OAAA;AACtB,4EAA0D"}

package/dist/inject-object-storage-service.decorator.d.ts

@@ -0,0 +1,2 @@
+export declare const InjectObjectStorageService: (connectionName?: string) => ParameterDecorator;
+export declare const InjectNatsObjectStorage: (bucketName: string, connectionName?: string) => ParameterDecorator;

package/dist/inject-object-storage-service.decorator.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectNatsObjectStorage = exports.InjectObjectStorageService = void 0;
+const common_1 = require("@nestjs/common");
+const metadata_1 = require("@rsdk/metadata");
+const nats_object_storage_module_generator_1 = require("./nats-object-storage-module.generator");
+const tokens_fn_1 = require("./tokens.fn");
+const InjectObjectStorageService = (connectionName) => (0, common_1.Inject)((0, tokens_fn_1.createObjectStorageServiceToken)(connectionName));
+exports.InjectObjectStorageService = InjectObjectStorageService;
+const InjectNatsObjectStorage = (bucketName, connectionName) => {
+    return (target, propertyKey, parameterIndex) => {
+        (0, common_1.Inject)((0, tokens_fn_1.createObjectStorageToken)(bucketName, connectionName))(target, propertyKey, parameterIndex);
+        const key = `nats-kv:${bucketName}${connectionName ? `:${connectionName}` : ''}`;
+        const moduleDefinition = nats_object_storage_module_generator_1.NatsObjectStorageModuleGenerator.createClientModuleDefinition(target, bucketName, connectionName);
+        metadata_1.RsdkMetadata.setWithScope(target, metadata_1.PLATFORM_RAW_GLOBAL_METADATA_SCOPE, key, moduleDefinition, true);
+    };
+};
+exports.InjectNatsObjectStorage = InjectNatsObjectStorage;
+//# sourceMappingURL=inject-object-storage-service.decorator.js.map

package/dist/inject-object-storage-service.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inject-object-storage-service.decorator.js","sourceRoot":"","sources":["../src/inject-object-storage-service.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,6CAGwB;AAExB,iGAA0F;AAC1F,2CAGqB;AAEd,MAAM,0BAA0B,GAAG,CACxC,cAAuB,EACH,EAAE,CACtB,IAAA,eAAM,EAAC,IAAA,2CAA+B,EAAC,cAAc,CAAC,CAAC,CAAC;AAH7C,QAAA,0BAA0B,8BAGmB;AAEnD,MAAM,uBAAuB,GAAG,CACrC,UAAkB,EAClB,cAAuB,EACH,EAAE;IACtB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;QAC7C,IAAA,eAAM,EAAC,IAAA,oCAAwB,EAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAC1D,MAAM,EACN,WAAW,EACX,cAAc,CACf,CAAC;QAEF,MAAM,GAAG,GAAG,WAAW,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACjF,MAAM,gBAAgB,GACpB,uEAAgC,CAAC,4BAA4B,CAC3D,MAAM,EACN,UAAU,EACV,cAAc,CACf,CAAC;QAEJ,uBAAY,CAAC,YAAY,CACvB,MAAM,EACN,6CAAkC,EAClC,GAAG,EACH,gBAAgB,EAChB,IAAI,CACL,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,uBAAuB,2BA2BlC"}

package/dist/nats-object-storage-module.generator.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+export declare class NatsObjectStorageModuleGenerator {
+    static createClientModuleDefinition(target: object, bucketName: string, connectionName?: string): DynamicModule;
+    private static createClientProvider;
+}

package/dist/nats-object-storage-module.generator.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NatsObjectStorageModuleGenerator = void 0;
+const metadata_1 = require("@rsdk/metadata");
+const constants_1 = require("./constants");
+const nats_object_storage_module_1 = require("./nats-object-storage.module");
+const tokens_fn_1 = require("./tokens.fn");
+class NatsObjectStorageModuleGenerator {
+    static createClientModuleDefinition(target, bucketName, connectionName) {
+        const provider = NatsObjectStorageModuleGenerator.createClientProvider(bucketName, connectionName);
+        const moduleDefinition = {
+            global: true,
+            imports: [nats_object_storage_module_1.NatsObjectStorageModule.forFeature(connectionName)],
+            module: NatsObjectStorageModuleGenerator,
+            providers: [provider],
+            exports: [provider],
+        };
+        metadata_1.RsdkMetadata.add(target, { bucketName, connectionName }, constants_1.NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE);
+        return moduleDefinition;
+    }
+    static createClientProvider(bucketName, connectionName) {
+        return {
+            provide: (0, tokens_fn_1.createObjectStorageToken)(bucketName, connectionName),
+            inject: [(0, tokens_fn_1.createObjectStorageServiceToken)(connectionName)],
+            useFactory: (service) => service.create({ bucketName, onlyExists: true }),
+        };
+    }
+}
+exports.NatsObjectStorageModuleGenerator = NatsObjectStorageModuleGenerator;
+//# sourceMappingURL=nats-object-storage-module.generator.js.map

package/dist/nats-object-storage-module.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nats-object-storage-module.generator.js","sourceRoot":"","sources":["../src/nats-object-storage-module.generator.ts"],"names":[],"mappings":";;;AACA,6CAA8C;AAE9C,2CAAuE;AACvE,6EAAuE;AAGvE,2CAGqB;AAErB,MAAa,gCAAgC;IAC3C,MAAM,CAAC,4BAA4B,CACjC,MAAc,EACd,UAAkB,EAClB,cAAuB;QAEvB,MAAM,QAAQ,GAAG,gCAAgC,CAAC,oBAAoB,CACpE,UAAU,EACV,cAAc,CACf,CAAC;QAEF,MAAM,gBAAgB,GAAkB;YACtC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,oDAAuB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAC7D,MAAM,EAAE,gCAAgC;YACxC,SAAS,EAAE,CAAC,QAAQ,CAAC;YACrB,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;QAEF,uBAAY,CAAC,GAAG,CACd,MAAM,EACN,EAAE,UAAU,EAAE,cAAc,EAAE,EAC9B,oDAAwC,CACzC,CAAC;QAEF,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,UAAkB,EAClB,cAAuB;QAEvB,OAAO;YACL,OAAO,EAAE,IAAA,oCAAwB,EAAC,UAAU,EAAE,cAAc,CAAC;YAC7D,MAAM,EAAE,CAAC,IAAA,2CAA+B,EAAC,cAAc,CAAC,CAAC;YACzD,UAAU,EAAE,CAAC,OAAiC,EAA0B,EAAE,CACxE,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SACnD,CAAC;IACJ,CAAC;CACF;AAvCD,4EAuCC"}

package/dist/nats-object-storage.module.d.ts

@@ -0,0 +1,9 @@
+import type { DynamicModule, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { WatchObjectStorageService } from './watch-object-storage.service';
+export declare class NatsObjectStorageModule implements OnModuleInit, OnModuleDestroy {
+    private readonly watchService;
+    constructor(watchService: WatchObjectStorageService);
+    static forFeature(connectionName?: string): DynamicModule;
+    onModuleInit(): Promise<void>;
+    onModuleDestroy(): Promise<void>;
+}

package/dist/nats-object-storage.module.js

@@ -0,0 +1,63 @@
+"use strict";
+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);
+};
+var NatsObjectStorageModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NatsObjectStorageModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const nats_common_1 = require("@rsdk/nats.common");
+const nats_object_storage_service_1 = require("./nats-object-storage.service");
+const tokens_fn_1 = require("./tokens.fn");
+const watch_object_storage_service_1 = require("./watch-object-storage.service");
+let NatsObjectStorageModule = NatsObjectStorageModule_1 = class NatsObjectStorageModule {
+    watchService;
+    constructor(watchService) {
+        this.watchService = watchService;
+    }
+    static forFeature(connectionName) {
+        const clientProvider = {
+            provide: (0, tokens_fn_1.createObjectStorageServiceToken)(connectionName),
+            useClass: nats_object_storage_service_1.NatsObjectStorageService,
+        };
+        return {
+            module: NatsObjectStorageModule_1,
+            providers: [
+                {
+                    provide: nats_common_1.NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE,
+                    useExisting: connectionName
+                        ? (0, nats_common_1.createNatsClientToken)(connectionName)
+                        : nats_common_1.NATS_CLIENT_INJECTION_TOKEN,
+                },
+                {
+                    provide: 'CONNECTION_NAME',
+                    useFactory: () => connectionName,
+                },
+                clientProvider,
+            ],
+            exports: [clientProvider],
+        };
+    }
+    async onModuleInit() {
+        await this.watchService?.runWatches();
+    }
+    async onModuleDestroy() {
+        await this.watchService?.stopWatches();
+    }
+};
+exports.NatsObjectStorageModule = NatsObjectStorageModule;
+exports.NatsObjectStorageModule = NatsObjectStorageModule = NatsObjectStorageModule_1 = __decorate([
+    (0, common_1.Module)({
+        imports: [core_1.DiscoveryModule],
+        providers: [nats_object_storage_service_1.NatsObjectStorageService, watch_object_storage_service_1.WatchObjectStorageService],
+    }),
+    __metadata("design:paramtypes", [watch_object_storage_service_1.WatchObjectStorageService])
+], NatsObjectStorageModule);
+//# sourceMappingURL=nats-object-storage.module.js.map

package/dist/nats-object-storage.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nats-object-storage.module.js","sourceRoot":"","sources":["../src/nats-object-storage.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAMA,2CAAwC;AACxC,uCAA+C;AAC/C,mDAI2B;AAE3B,+EAAyE;AACzE,2CAA8D;AAC9D,iFAA2E;AAMpE,IAAM,uBAAuB,+BAA7B,MAAM,uBAAuB;IACL;IAA7B,YAA6B,YAAuC;QAAvC,iBAAY,GAAZ,YAAY,CAA2B;IAAG,CAAC;IAEjE,MAAM,CAAC,UAAU,CAAC,cAAuB;QAC9C,MAAM,cAAc,GAAa;YAC/B,OAAO,EAAE,IAAA,2CAA+B,EAAC,cAAc,CAAC;YACxD,QAAQ,EAAE,sDAAwB;SACnC,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,yBAAuB;YAC/B,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,qDAAuC;oBAChD,WAAW,EAAE,cAAc;wBACzB,CAAC,CAAC,IAAA,mCAAqB,EAAC,cAAc,CAAC;wBACvC,CAAC,CAAC,yCAA2B;iBAChC;gBACD;oBACE,OAAO,EAAE,iBAAiB;oBAC1B,UAAU,EAAE,GAAG,EAAE,CAAC,cAAc;iBACjC;gBACD,cAAc;aACf;YACD,OAAO,EAAE,CAAC,cAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,IAAI,CAAC,YAAY,EAAE,WAAW,EAAE,CAAC;IACzC,CAAC;CACF,CAAA;AAnCY,0DAAuB;kCAAvB,uBAAuB;IAJnC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAe,CAAC;QAC1B,SAAS,EAAE,CAAC,sDAAwB,EAAE,wDAAyB,CAAC;KACjE,CAAC;qCAE2C,wDAAyB;GADzD,uBAAuB,CAmCnC"}

package/dist/nats-object-storage.service.d.ts

@@ -0,0 +1,34 @@
+import { ILogger } from '@rsdk/logging';
+import { NatsConnection } from 'nats';
+import type { ObjectStoreOptions } from 'nats/lib/jetstream/types';
+import { ObjectStorage } from './object-storage';
+export declare class NatsObjectStorageService {
+    private readonly logger;
+    private readonly nats;
+    constructor(logger: ILogger, nats: NatsConnection);
+    /**
+     * Get or create object storage
+     */
+    create({ bucketName, domain, onlyExists, ...opts }: Partial<ObjectStoreOptions> & {
+        bucketName: string;
+        domain?: string;
+        onlyExists?: boolean;
+    }): Promise<ObjectStorage>;
+    /**
+     * Waits for the specified bucket to exist.
+     *
+     * @param bucketName - The name of the bucket to wait for.
+     * @param timeout - The maximum time to wait for the bucket to exist, in milliseconds. Defaults to infinity.
+     * @throws {InternalException} If the bucket does not exist within the specified timeout.
+     */
+    waitForBucketExists(bucketName: string, timeout?: number): Promise<void>;
+    /**
+     * Checks if a bucket exists.
+     *
+     * @param bucket - The name of the bucket to check.
+     * @returns A promise that resolves to a boolean indicating whether the bucket exists or not.
+     */
+    isBucketExists(bucket: string, opts?: {
+        domain?: string;
+    }): Promise<boolean>;
+}

package/dist/nats-object-storage.service.js

@@ -0,0 +1,99 @@
+"use strict";
+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);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NatsObjectStorageService = void 0;
+const common_1 = require("@nestjs/common");
+const common_2 = require("@rsdk/common");
+const core_1 = require("@rsdk/core");
+const nats_common_1 = require("@rsdk/nats.common");
+const object_storage_1 = require("./object-storage");
+let NatsObjectStorageService = class NatsObjectStorageService {
+    logger;
+    nats;
+    constructor(logger, nats) {
+        this.logger = logger;
+        this.nats = nats;
+    }
+    /**
+     * Get or create object storage
+     */
+    async create({ bucketName, domain, onlyExists, ...opts }) {
+        const jsOptions = domain ? { domain } : undefined;
+        const js = this.nats.jetstream(jsOptions);
+        try {
+            if (onlyExists && !(await this.isBucketExists(bucketName, jsOptions))) {
+                throw new core_1.NotFoundException(`Object storage bucket "${bucketName}" not found`);
+            }
+            const storage = await js.views.os(bucketName, opts);
+            this.logger.trace('Object storage initialized', {
+                connectionName: this.nats.info,
+                bucket: bucketName,
+            });
+            return new object_storage_1.ObjectStorage(storage);
+        }
+        catch (error) {
+            this.logger.error('Failed to get or create object storage', {
+                err: error,
+                bucket: bucketName,
+            });
+            throw error;
+        }
+    }
+    /**
+     * Waits for the specified bucket to exist.
+     *
+     * @param bucketName - The name of the bucket to wait for.
+     * @param timeout - The maximum time to wait for the bucket to exist, in milliseconds. Defaults to infinity.
+     * @throws {InternalException} If the bucket does not exist within the specified timeout.
+     */
+    async waitForBucketExists(bucketName, timeout = Number.POSITIVE_INFINITY) {
+        const start = Date.now();
+        while (true) {
+            if (await this.isBucketExists(bucketName)) {
+                this.logger.trace('Object storage bucket exists');
+                return;
+            }
+            if (timeout && Date.now() - start > timeout) {
+                throw new core_1.InternalException(`Bucket ${bucketName} does not exist`);
+            }
+            this.logger.trace('Object storage bucket does not exist, retry after 3 seconds...', {
+                bucketName,
+            });
+            await (0, common_2.delay)(common_2.Timespan.second(3));
+        }
+    }
+    /**
+     * Checks if a bucket exists.
+     *
+     * @param bucket - The name of the bucket to check.
+     * @returns A promise that resolves to a boolean indicating whether the bucket exists or not.
+     */
+    async isBucketExists(bucket, opts) {
+        try {
+            await this.nats.jetstream(opts).streams.get(`OBJ_${bucket}`);
+        }
+        catch {
+            return false;
+        }
+        return true;
+    }
+};
+exports.NatsObjectStorageService = NatsObjectStorageService;
+exports.NatsObjectStorageService = NatsObjectStorageService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, core_1.InjectLogger)(NatsObjectStorageService)),
+    __param(1, (0, common_1.Inject)(nats_common_1.NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE)),
+    __metadata("design:paramtypes", [Object, Object])
+], NatsObjectStorageService);
+//# sourceMappingURL=nats-object-storage.service.js.map

package/dist/nats-object-storage.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nats-object-storage.service.js","sourceRoot":"","sources":["../src/nats-object-storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAoD;AACpD,yCAA+C;AAC/C,qCAAgF;AAEhF,mDAA4E;AAI5E,qDAAiD;AAG1C,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IAGhB;IAEA;IAJnB,YAEmB,MAAe,EAEf,IAAoB;QAFpB,WAAM,GAAN,MAAM,CAAS;QAEf,SAAI,GAAJ,IAAI,CAAgB;IACpC,CAAC;IAEJ;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,EAClB,UAAU,EACV,MAAM,EACN,UAAU,EACV,GAAG,IAAI,EAKR;QACC,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAE1C,IAAI,CAAC;YACH,IAAI,UAAU,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBACtE,MAAM,IAAI,wBAAiB,CACzB,0BAA0B,UAAU,aAAa,CAClD,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAEpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;gBAC9C,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;gBAC9B,MAAM,EAAE,UAAU;aACnB,CAAC,CAAC;YAEH,OAAO,IAAI,8BAAa,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE;gBAC1D,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,UAAU;aACnB,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CACvB,UAAkB,EAClB,UAAkB,MAAM,CAAC,iBAAiB;QAE1C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEzB,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;gBAClD,OAAO;YACT,CAAC;YAED,IAAI,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;gBAC5C,MAAM,IAAI,wBAAiB,CAAC,UAAU,UAAU,iBAAiB,CAAC,CAAC;YACrE,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,gEAAgE,EAChE;gBACE,UAAU;aACX,CACF,CAAC;YACF,MAAM,IAAA,cAAK,EAAC,iBAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,MAAc,EACd,IAA0B;QAE1B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAnGY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,mBAAY,EAAC,wBAAwB,CAAC,CAAA;IAEtC,WAAA,IAAA,eAAM,EAAC,qDAAuC,CAAC,CAAA;;GAJvC,wBAAwB,CAmGpC"}

package/dist/object-storage.d.ts

@@ -0,0 +1,27 @@
+import type { ObjectInfo, ObjectResult, ObjectStore, ObjectStoreMeta, ObjectStorePutOpts, PurgeResponse } from 'nats';
+export declare class ObjectStorage {
+    private readonly storage;
+    constructor(storage: ObjectStore);
+    /**
+     * Возвращает метаданные и стрим с объектом
+     */
+    get(key: string): Promise<ObjectResult | null>;
+    /**
+     * Удаляет объект
+     */
+    delete(key: string): Promise<PurgeResponse>;
+    /**
+     * Загружает объект в хранилище
+     */
+    put(meta: ObjectStoreMeta, rs: ReadableStream<Uint8Array>, opts?: ObjectStorePutOpts): Promise<ObjectInfo>;
+    /**
+     * Возвращает массив всех объектов в хранилище
+     */
+    list(): Promise<ObjectInfo[]>;
+    /**
+     * Возвращает сырой object storage Nats. Используйте этот метод
+     * только в крайнем случае! Рекомендуется работать с оберткой
+     * для безопасного взаимодействия.
+     */
+    getRawStorage(): ObjectStore;
+}

package/dist/object-storage.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectStorage = void 0;
+class ObjectStorage {
+    storage;
+    constructor(storage) {
+        this.storage = storage;
+    }
+    /**
+     * Возвращает метаданные и стрим с объектом
+     */
+    get(key) {
+        return this.storage.get(key);
+    }
+    /**
+     * Удаляет объект
+     */
+    delete(key) {
+        return this.storage.delete(key);
+    }
+    /**
+     * Загружает объект в хранилище
+     */
+    put(meta, rs, opts) {
+        return this.storage.put(meta, rs, opts);
+    }
+    /**
+     * Возвращает массив всех объектов в хранилище
+     */
+    list() {
+        return this.storage.list();
+    }
+    /**
+     * Возвращает сырой object storage Nats. Используйте этот метод
+     * только в крайнем случае! Рекомендуется работать с оберткой
+     * для безопасного взаимодействия.
+     */
+    getRawStorage() {
+        return this.storage;
+    }
+}
+exports.ObjectStorage = ObjectStorage;
+//# sourceMappingURL=object-storage.js.map

package/dist/object-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-storage.js","sourceRoot":"","sources":["../src/object-storage.ts"],"names":[],"mappings":";;;AASA,MAAa,aAAa;IACK;IAA7B,YAA6B,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAG,CAAC;IAErD;;OAEG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,GAAG,CACR,IAAqB,EACrB,EAA8B,EAC9B,IAAyB;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AA3CD,sCA2CC"}

package/dist/tokens.fn.d.ts

@@ -0,0 +1,2 @@
+export declare const createObjectStorageServiceToken: (connectionName?: string) => string;
+export declare const createObjectStorageToken: (bucketName: string, connectionName?: string) => string;

package/dist/tokens.fn.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createObjectStorageToken = exports.createObjectStorageServiceToken = void 0;
+const createObjectStorageServiceToken = (connectionName) => `NATS_OBJECT_STORAGE_SERVICE${connectionName ? `_${connectionName}` : ''}`;
+exports.createObjectStorageServiceToken = createObjectStorageServiceToken;
+const createObjectStorageToken = (bucketName, connectionName) => `NATS_OBJECT_STORAGE_${bucketName}${connectionName ? `_${connectionName}` : ''}`;
+exports.createObjectStorageToken = createObjectStorageToken;
+//# sourceMappingURL=tokens.fn.js.map

package/dist/tokens.fn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.fn.js","sourceRoot":"","sources":["../src/tokens.fn.ts"],"names":[],"mappings":";;;AAAO,MAAM,+BAA+B,GAAG,CAC7C,cAAuB,EACf,EAAE,CACV,8BAA8B,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAHhE,QAAA,+BAA+B,mCAGiC;AAEtE,MAAM,wBAAwB,GAAG,CACtC,UAAkB,EAClB,cAAuB,EACf,EAAE,CACV,uBAAuB,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAJtE,QAAA,wBAAwB,4BAI8C"}

package/dist/watch-object-storage.decorator.d.ts

@@ -0,0 +1,23 @@
+import type { ObjectInfo } from 'nats';
+export type WatchConfig = {
+    bucket: string;
+    ignoreDeletes?: boolean;
+    includeHistory?: boolean;
+    connectionName?: string;
+};
+export interface ObjectStorageWatcher {
+    onDelete(entry: ObjectInfo | null): Promise<void>;
+    onPut(entry: ObjectInfo | null): Promise<void>;
+}
+/**
+ * Key used to mark class as a watcher for object storage.
+ */
+export declare const WATCH_NATS_OBJECT_STORAGE_KEY = "WATCH_NATS_OBJECT_STORAGE";
+/**
+ * Decorator used to mark class as a watcher for object storage.
+ * Needs to be used in conjunction with the `ObjectStorageWatcher` interface.
+ *
+ * @param {WatchConfig} config - The configuration for watching object storage.
+ * @returns {void}
+ */
+export declare const WatchObjectStorage: import("@nestjs/core").ReflectableDecorator<WatchConfig, WatchConfig>;

package/dist/watch-object-storage.decorator.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchObjectStorage = exports.WATCH_NATS_OBJECT_STORAGE_KEY = void 0;
+const core_1 = require("@nestjs/core");
+/**
+ * Key used to mark class as a watcher for object storage.
+ */
+exports.WATCH_NATS_OBJECT_STORAGE_KEY = 'WATCH_NATS_OBJECT_STORAGE';
+/**
+ * Decorator used to mark class as a watcher for object storage.
+ * Needs to be used in conjunction with the `ObjectStorageWatcher` interface.
+ *
+ * @param {WatchConfig} config - The configuration for watching object storage.
+ * @returns {void}
+ */
+exports.WatchObjectStorage = core_1.Reflector.createDecorator({
+    key: exports.WATCH_NATS_OBJECT_STORAGE_KEY,
+});
+//# sourceMappingURL=watch-object-storage.decorator.js.map

package/dist/watch-object-storage.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch-object-storage.decorator.js","sourceRoot":"","sources":["../src/watch-object-storage.decorator.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AAezC;;GAEG;AACU,QAAA,6BAA6B,GAAG,2BAA2B,CAAC;AAEzE;;;;;;GAMG;AACU,QAAA,kBAAkB,GAAG,gBAAS,CAAC,eAAe,CAAc;IACvE,GAAG,EAAE,qCAA6B;CACnC,CAAC,CAAC"}

package/dist/watch-object-storage.service.d.ts

@@ -0,0 +1,45 @@
+import { DiscoveryService } from '@nestjs/core';
+import { ILogger } from '@rsdk/logging';
+import type { ObjectInfo, ObjectStore } from 'nats';
+import { NatsObjectStorageService } from './nats-object-storage.service';
+export declare class WatchObjectStorageService {
+    private readonly logger;
+    private readonly discovery;
+    private readonly client;
+    private readonly connectionName?;
+    constructor(logger: ILogger, discovery: DiscoveryService, client: NatsObjectStorageService, connectionName?: string | undefined);
+    /**
+     * Runs the watches for the object storage service.
+     * Waits for buckets to exist and starts the watch operation for each bucket.
+     */
+    runWatches(): Promise<void>;
+    /**
+     * Stops all watches.
+     *
+     * @note This method is not implemented yet.
+     */
+    stopWatches(): Promise<void>;
+    /**
+     * Register watcher callback for object storage
+     */
+    watch(storage: ObjectStore, callback: (entry: ObjectInfo | null) => Promise<void>, opts?: {
+        ignoreDeletes?: boolean;
+        includeHistory?: boolean;
+    }): Promise<void>;
+    /**
+     * Runs the watch operation for the given metadata and watcher.
+     *
+     * @param config - The watch configuration.
+     * @param watcher - The ObjectStorageWatcher instance.
+     * @returns A Promise that resolves when the watch operation is complete.
+     */
+    private runWatch;
+    /**
+     * Discovers and returns an array of ObjectStorageWatcher instances
+     * along with their corresponding metadata.
+     *
+     * @returns An array of objects containing the ObjectStorageWatcher
+     * instance and its metadata.
+     */
+    private discoverWatchers;
+}

package/dist/watch-object-storage.service.js

@@ -0,0 +1,112 @@
+"use strict";
+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);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchObjectStorageService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const core_2 = require("@rsdk/core");
+const nats_object_storage_service_1 = require("./nats-object-storage.service");
+const watch_object_storage_decorator_1 = require("./watch-object-storage.decorator");
+let WatchObjectStorageService = class WatchObjectStorageService {
+    logger;
+    discovery;
+    client;
+    connectionName;
+    constructor(logger, discovery, client, connectionName) {
+        this.logger = logger;
+        this.discovery = discovery;
+        this.client = client;
+        this.connectionName = connectionName;
+    }
+    /**
+     * Runs the watches for the object storage service.
+     * Waits for buckets to exist and starts the watch operation for each bucket.
+     */
+    async runWatches() {
+        const watchers = await this.discoverWatchers();
+        await Promise.all(watchers.map(async ({ instance, metadata }) => {
+            await this.client.waitForBucketExists(metadata.bucket, 5000);
+            await this.runWatch(metadata, instance);
+            this.logger.info('Nats object storage watcher started', { metadata });
+        }));
+    }
+    /**
+     * Stops all watches.
+     *
+     * @note This method is not implemented yet.
+     */
+    async stopWatches() {
+        // TODO: Implement
+    }
+    /**
+     * Register watcher callback for object storage
+     */
+    async watch(storage, callback, opts) {
+        for await (const entry of await storage.watch(opts)) {
+            callback(entry).catch((error) => {
+                this.logger.error('Error processing object storage entry', {
+                    entry: entry,
+                    err: error,
+                });
+            });
+        }
+    }
+    /**
+     * Runs the watch operation for the given metadata and watcher.
+     *
+     * @param config - The watch configuration.
+     * @param watcher - The ObjectStorageWatcher instance.
+     * @returns A Promise that resolves when the watch operation is complete.
+     */
+    async runWatch({ bucket, ...options }, watcher) {
+        const storage = await this.client.create({ bucketName: bucket });
+        this.watch(storage.getRawStorage(), async (event) => {
+            if (!event)
+                return;
+            await (event.deleted ? watcher.onDelete(event) : watcher.onPut(event));
+        }, options);
+    }
+    /**
+     * Discovers and returns an array of ObjectStorageWatcher instances
+     * along with their corresponding metadata.
+     *
+     * @returns An array of objects containing the ObjectStorageWatcher
+     * instance and its metadata.
+     */
+    discoverWatchers() {
+        return this.discovery.getProviders().reduce((acc, watcher) => {
+            /**
+             * NOTE: This is a fix for TypeError in call .getMetadataByDecorator() above
+             * because some tokens are not instances of classes and have no constructor.
+             * */
+            const clsRef = watcher.instance?.constructor ?? watcher.metatype;
+            if (!clsRef) {
+                return acc;
+            }
+            const metadata = this.discovery.getMetadataByDecorator(watch_object_storage_decorator_1.WatchObjectStorage, watcher);
+            if (metadata && metadata.connectionName === this.connectionName) {
+                acc.push({ instance: watcher.instance, metadata });
+            }
+            return acc;
+        }, []);
+    }
+};
+exports.WatchObjectStorageService = WatchObjectStorageService;
+exports.WatchObjectStorageService = WatchObjectStorageService = __decorate([
+    __param(0, (0, core_2.InjectLogger)(WatchObjectStorageService)),
+    __param(3, (0, common_1.Inject)('CONNECTION_NAME')),
+    __metadata("design:paramtypes", [Object, core_1.DiscoveryService,
+        nats_object_storage_service_1.NatsObjectStorageService, String])
+], WatchObjectStorageService);
+//# sourceMappingURL=watch-object-storage.service.js.map

package/dist/watch-object-storage.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch-object-storage.service.js","sourceRoot":"","sources":["../src/watch-object-storage.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,uCAAgD;AAChD,qCAA0C;AAI1C,+EAAyE;AAKzE,qFAAsE;AAEtE,IAAa,yBAAyB,GAAtC,MAAa,yBAAyB;IAGjB;IACA;IACA;IAEA;IANnB,YAEmB,MAAe,EACf,SAA2B,EAC3B,MAAgC,EAEhC,cAAuB;QAJvB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAkB;QAC3B,WAAM,GAAN,MAAM,CAA0B;QAEhC,mBAAc,GAAd,cAAc,CAAS;IACvC,CAAC;IAEJ;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE/C,MAAM,OAAO,CAAC,GAAG,CACf,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC7D,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,kBAAkB;IACpB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK,CAChB,OAAoB,EACpB,QAAqD,EACrD,IAGC;QAED,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE;oBACzD,KAAK,EAAE,KAAK;oBACZ,GAAG,EAAE,KAAK;iBACX,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CACpB,EAAE,MAAM,EAAE,GAAG,OAAO,EAAe,EACnC,OAA6B;QAE7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;QAEjE,IAAI,CAAC,KAAK,CACR,OAAO,CAAC,aAAa,EAAE,EACvB,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,CAAC,KAAK;gBAAE,OAAO;YAEnB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACzE,CAAC,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,gBAAgB;QAItB,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,MAAM,CACzC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YACf;;;iBAGK;YACL,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;YACjE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,GAAG,CAAC;YACb,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,CACpD,mDAAkB,EAClB,OAAO,CACR,CAAC;YAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;gBAChE,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAiE,CAClE,CAAC;IACJ,CAAC;CACF,CAAA;AAnHY,8DAAyB;oCAAzB,yBAAyB;IAEjC,WAAA,IAAA,mBAAY,EAAC,yBAAyB,CAAC,CAAA;IAIvC,WAAA,IAAA,eAAM,EAAC,iBAAiB,CAAC,CAAA;6CAFE,uBAAgB;QACnB,sDAAwB;GALxC,yBAAyB,CAmHrC"}

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config');

package/jest.config.unit.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.unit');

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@rsdk/nats.object-storage",
+  "version": "5.4.0-next.2",
+  "description": "Nats NestJS object storage",
+  "main": "dist/index.js",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "dependencies": {
+    "@nestjs-plugins/nestjs-nats-jetstream-transport": "^2.2.6",
+    "lodash": "^4.17.21",
+    "nats": "^2.28.0",
+    "typescript": "^5.3.2"
+  },
+  "peerDependencies": {
+    "@grpc/grpc-js": "^1.10.9",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.2.3",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/microservices": "^10.0.0",
+    "@opentelemetry/api": "1.9.0",
+    "@rsdk/actx": "*",
+    "@rsdk/autodoc.protocol": "*",
+    "@rsdk/common": "*",
+    "@rsdk/common.nestjs": "*",
+    "@rsdk/common.node": "*",
+    "@rsdk/core": "*",
+    "@rsdk/decorators": "*",
+    "@rsdk/logging": "*",
+    "@rsdk/metadata": "*",
+    "@rsdk/nats.common": "*",
+    "@rsdk/nest-tools": "*",
+    "reflect-metadata": "^0.1.12 || ^0.2.0",
+    "rxjs": "^7.8.1"
+  },
+  "nx": {},
+  "gitHead": "be4deac03b38b3f923a08116e1dc2b55838905b0"
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE = 'nats-object-storages';

package/src/index.ts

@@ -0,0 +1,8 @@
+export { NatsObjectStorageService } from './nats-object-storage.service';
+export {
+  WatchObjectStorage,
+  type ObjectStorageWatcher,
+} from './watch-object-storage.decorator';
+export { NatsObjectStorageModule } from './nats-object-storage.module';
+export { ObjectStorage } from './object-storage';
+export * from './inject-object-storage-service.decorator';

package/src/inject-object-storage-service.decorator.ts

@@ -0,0 +1,45 @@
+import { Inject } from '@nestjs/common';
+import {
+  PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+  RsdkMetadata,
+} from '@rsdk/metadata';
+
+import { NatsObjectStorageModuleGenerator } from './nats-object-storage-module.generator';
+import {
+  createObjectStorageServiceToken,
+  createObjectStorageToken,
+} from './tokens.fn';
+
+export const InjectObjectStorageService = (
+  connectionName?: string,
+): ParameterDecorator =>
+  Inject(createObjectStorageServiceToken(connectionName));
+
+export const InjectNatsObjectStorage = (
+  bucketName: string,
+  connectionName?: string,
+): ParameterDecorator => {
+  return (target, propertyKey, parameterIndex) => {
+    Inject(createObjectStorageToken(bucketName, connectionName))(
+      target,
+      propertyKey,
+      parameterIndex,
+    );
+
+    const key = `nats-kv:${bucketName}${connectionName ? `:${connectionName}` : ''}`;
+    const moduleDefinition =
+      NatsObjectStorageModuleGenerator.createClientModuleDefinition(
+        target,
+        bucketName,
+        connectionName,
+      );
+
+    RsdkMetadata.setWithScope(
+      target,
+      PLATFORM_RAW_GLOBAL_METADATA_SCOPE,
+      key,
+      moduleDefinition,
+      true,
+    );
+  };
+};

package/src/nats-object-storage-module.generator.ts

@@ -0,0 +1,52 @@
+import type { DynamicModule, FactoryProvider } from '@nestjs/common';
+import { RsdkMetadata } from '@rsdk/metadata';
+
+import { NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE } from './constants';
+import { NatsObjectStorageModule } from './nats-object-storage.module';
+import type { NatsObjectStorageService } from './nats-object-storage.service';
+import type { ObjectStorage } from './object-storage';
+import {
+  createObjectStorageServiceToken,
+  createObjectStorageToken,
+} from './tokens.fn';
+
+export class NatsObjectStorageModuleGenerator {
+  static createClientModuleDefinition(
+    target: object,
+    bucketName: string,
+    connectionName?: string,
+  ): DynamicModule {
+    const provider = NatsObjectStorageModuleGenerator.createClientProvider(
+      bucketName,
+      connectionName,
+    );
+
+    const moduleDefinition: DynamicModule = {
+      global: true,
+      imports: [NatsObjectStorageModule.forFeature(connectionName)],
+      module: NatsObjectStorageModuleGenerator,
+      providers: [provider],
+      exports: [provider],
+    };
+
+    RsdkMetadata.add(
+      target,
+      { bucketName, connectionName },
+      NATS_OBJECT_STORAGES_RSDK_METADATA_SCOPE,
+    );
+
+    return moduleDefinition;
+  }
+
+  private static createClientProvider(
+    bucketName: string,
+    connectionName?: string,
+  ): FactoryProvider {
+    return {
+      provide: createObjectStorageToken(bucketName, connectionName),
+      inject: [createObjectStorageServiceToken(connectionName)],
+      useFactory: (service: NatsObjectStorageService): Promise<ObjectStorage> =>
+        service.create({ bucketName, onlyExists: true }),
+    };
+  }
+}

package/src/nats-object-storage.module.ts

@@ -0,0 +1,58 @@
+import type {
+  DynamicModule,
+  OnModuleDestroy,
+  OnModuleInit,
+  Provider,
+} from '@nestjs/common';
+import { Module } from '@nestjs/common';
+import { DiscoveryModule } from '@nestjs/core';
+import {
+  createNatsClientToken,
+  NATS_CLIENT_INJECTION_TOKEN,
+  NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE,
+} from '@rsdk/nats.common';
+
+import { NatsObjectStorageService } from './nats-object-storage.service';
+import { createObjectStorageServiceToken } from './tokens.fn';
+import { WatchObjectStorageService } from './watch-object-storage.service';
+
+@Module({
+  imports: [DiscoveryModule],
+  providers: [NatsObjectStorageService, WatchObjectStorageService],
+})
+export class NatsObjectStorageModule implements OnModuleInit, OnModuleDestroy {
+  constructor(private readonly watchService: WatchObjectStorageService) {}
+
+  public static forFeature(connectionName?: string): DynamicModule {
+    const clientProvider: Provider = {
+      provide: createObjectStorageServiceToken(connectionName),
+      useClass: NatsObjectStorageService,
+    };
+
+    return {
+      module: NatsObjectStorageModule,
+      providers: [
+        {
+          provide: NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE,
+          useExisting: connectionName
+            ? createNatsClientToken(connectionName)
+            : NATS_CLIENT_INJECTION_TOKEN,
+        },
+        {
+          provide: 'CONNECTION_NAME',
+          useFactory: () => connectionName,
+        },
+        clientProvider,
+      ],
+      exports: [clientProvider],
+    };
+  }
+
+  async onModuleInit(): Promise<void> {
+    await this.watchService?.runWatches();
+  }
+
+  async onModuleDestroy(): Promise<void> {
+    await this.watchService?.stopWatches();
+  }
+}

package/src/nats-object-storage.service.ts

@@ -0,0 +1,111 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { delay, Timespan } from '@rsdk/common';
+import { InjectLogger, InternalException, NotFoundException } from '@rsdk/core';
+import { ILogger } from '@rsdk/logging';
+import { NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE } from '@rsdk/nats.common';
+import { NatsConnection } from 'nats';
+import type { ObjectStoreOptions } from 'nats/lib/jetstream/types';
+
+import { ObjectStorage } from './object-storage';
+
+@Injectable()
+export class NatsObjectStorageService {
+  constructor(
+    @InjectLogger(NatsObjectStorageService)
+    private readonly logger: ILogger,
+    @Inject(NATS_CLIENT_INJECTION_TOKEN_FOR_PACKAGE)
+    private readonly nats: NatsConnection,
+  ) {}
+
+  /**
+   * Get or create object storage
+   */
+  public async create({
+    bucketName,
+    domain,
+    onlyExists,
+    ...opts
+  }: Partial<ObjectStoreOptions> & {
+    bucketName: string;
+    domain?: string;
+    onlyExists?: boolean;
+  }): Promise<ObjectStorage> {
+    const jsOptions = domain ? { domain } : undefined;
+    const js = this.nats.jetstream(jsOptions);
+
+    try {
+      if (onlyExists && !(await this.isBucketExists(bucketName, jsOptions))) {
+        throw new NotFoundException(
+          `Object storage bucket "${bucketName}" not found`,
+        );
+      }
+
+      const storage = await js.views.os(bucketName, opts);
+
+      this.logger.trace('Object storage initialized', {
+        connectionName: this.nats.info,
+        bucket: bucketName,
+      });
+
+      return new ObjectStorage(storage);
+    } catch (error) {
+      this.logger.error('Failed to get or create object storage', {
+        err: error,
+        bucket: bucketName,
+      });
+      throw error;
+    }
+  }
+
+  /**
+   * Waits for the specified bucket to exist.
+   *
+   * @param bucketName - The name of the bucket to wait for.
+   * @param timeout - The maximum time to wait for the bucket to exist, in milliseconds. Defaults to infinity.
+   * @throws {InternalException} If the bucket does not exist within the specified timeout.
+   */
+  async waitForBucketExists(
+    bucketName: string,
+    timeout: number = Number.POSITIVE_INFINITY,
+  ): Promise<void> {
+    const start = Date.now();
+
+    while (true) {
+      if (await this.isBucketExists(bucketName)) {
+        this.logger.trace('Object storage bucket exists');
+        return;
+      }
+
+      if (timeout && Date.now() - start > timeout) {
+        throw new InternalException(`Bucket ${bucketName} does not exist`);
+      }
+
+      this.logger.trace(
+        'Object storage bucket does not exist, retry after 3 seconds...',
+        {
+          bucketName,
+        },
+      );
+      await delay(Timespan.second(3));
+    }
+  }
+
+  /**
+   * Checks if a bucket exists.
+   *
+   * @param bucket - The name of the bucket to check.
+   * @returns A promise that resolves to a boolean indicating whether the bucket exists or not.
+   */
+  async isBucketExists(
+    bucket: string,
+    opts?: { domain?: string },
+  ): Promise<boolean> {
+    try {
+      await this.nats.jetstream(opts).streams.get(`OBJ_${bucket}`);
+    } catch {
+      return false;
+    }
+
+    return true;
+  }
+}

package/src/object-storage.ts

@@ -0,0 +1,53 @@
+import type {
+  ObjectInfo,
+  ObjectResult,
+  ObjectStore,
+  ObjectStoreMeta,
+  ObjectStorePutOpts,
+  PurgeResponse,
+} from 'nats';
+
+export class ObjectStorage {
+  constructor(private readonly storage: ObjectStore) {}
+
+  /**
+   * Возвращает метаданные и стрим с объектом
+   */
+  public get(key: string): Promise<ObjectResult | null> {
+    return this.storage.get(key);
+  }
+
+  /**
+   * Удаляет объект
+   */
+  public delete(key: string): Promise<PurgeResponse> {
+    return this.storage.delete(key);
+  }
+
+  /**
+   * Загружает объект в хранилище
+   */
+  public put(
+    meta: ObjectStoreMeta,
+    rs: ReadableStream<Uint8Array>,
+    opts?: ObjectStorePutOpts,
+  ): Promise<ObjectInfo> {
+    return this.storage.put(meta, rs, opts);
+  }
+
+  /**
+   * Возвращает массив всех объектов в хранилище
+   */
+  public list(): Promise<ObjectInfo[]> {
+    return this.storage.list();
+  }
+
+  /**
+   * Возвращает сырой object storage Nats. Используйте этот метод
+   * только в крайнем случае! Рекомендуется работать с оберткой
+   * для безопасного взаимодействия.
+   */
+  public getRawStorage(): ObjectStore {
+    return this.storage;
+  }
+}

package/src/tokens.fn.ts

@@ -0,0 +1,10 @@
+export const createObjectStorageServiceToken = (
+  connectionName?: string,
+): string =>
+  `NATS_OBJECT_STORAGE_SERVICE${connectionName ? `_${connectionName}` : ''}`;
+
+export const createObjectStorageToken = (
+  bucketName: string,
+  connectionName?: string,
+): string =>
+  `NATS_OBJECT_STORAGE_${bucketName}${connectionName ? `_${connectionName}` : ''}`;

package/src/watch-object-storage.decorator.ts

@@ -0,0 +1,30 @@
+import { Reflector } from '@nestjs/core';
+import type { ObjectInfo } from 'nats';
+
+export type WatchConfig = {
+  bucket: string;
+  ignoreDeletes?: boolean;
+  includeHistory?: boolean;
+  connectionName?: string;
+};
+
+export interface ObjectStorageWatcher {
+  onDelete(entry: ObjectInfo | null): Promise<void>;
+  onPut(entry: ObjectInfo | null): Promise<void>;
+}
+
+/**
+ * Key used to mark class as a watcher for object storage.
+ */
+export const WATCH_NATS_OBJECT_STORAGE_KEY = 'WATCH_NATS_OBJECT_STORAGE';
+
+/**
+ * Decorator used to mark class as a watcher for object storage.
+ * Needs to be used in conjunction with the `ObjectStorageWatcher` interface.
+ *
+ * @param {WatchConfig} config - The configuration for watching object storage.
+ * @returns {void}
+ */
+export const WatchObjectStorage = Reflector.createDecorator<WatchConfig>({
+  key: WATCH_NATS_OBJECT_STORAGE_KEY,
+});

package/src/watch-object-storage.service.ts

@@ -0,0 +1,129 @@
+import { Inject } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
+import { InjectLogger } from '@rsdk/core';
+import { ILogger } from '@rsdk/logging';
+import type { ObjectInfo, ObjectStore } from 'nats';
+
+import { NatsObjectStorageService } from './nats-object-storage.service';
+import type {
+  ObjectStorageWatcher,
+  WatchConfig,
+} from './watch-object-storage.decorator';
+import { WatchObjectStorage } from './watch-object-storage.decorator';
+
+export class WatchObjectStorageService {
+  constructor(
+    @InjectLogger(WatchObjectStorageService)
+    private readonly logger: ILogger,
+    private readonly discovery: DiscoveryService,
+    private readonly client: NatsObjectStorageService,
+    @Inject('CONNECTION_NAME')
+    private readonly connectionName?: string,
+  ) {}
+
+  /**
+   * Runs the watches for the object storage service.
+   * Waits for buckets to exist and starts the watch operation for each bucket.
+   */
+  public async runWatches(): Promise<void> {
+    const watchers = await this.discoverWatchers();
+
+    await Promise.all(
+      watchers.map(async ({ instance, metadata }) => {
+        await this.client.waitForBucketExists(metadata.bucket, 5000);
+        await this.runWatch(metadata, instance);
+        this.logger.info('Nats object storage watcher started', { metadata });
+      }),
+    );
+  }
+
+  /**
+   * Stops all watches.
+   *
+   * @note This method is not implemented yet.
+   */
+  public async stopWatches(): Promise<void> {
+    // TODO: Implement
+  }
+
+  /**
+   * Register watcher callback for object storage
+   */
+  public async watch(
+    storage: ObjectStore,
+    callback: (entry: ObjectInfo | null) => Promise<void>,
+    opts?: {
+      ignoreDeletes?: boolean;
+      includeHistory?: boolean;
+    },
+  ): Promise<void> {
+    for await (const entry of await storage.watch(opts)) {
+      callback(entry).catch((error) => {
+        this.logger.error('Error processing object storage entry', {
+          entry: entry,
+          err: error,
+        });
+      });
+    }
+  }
+
+  /**
+   * Runs the watch operation for the given metadata and watcher.
+   *
+   * @param config - The watch configuration.
+   * @param watcher - The ObjectStorageWatcher instance.
+   * @returns A Promise that resolves when the watch operation is complete.
+   */
+  private async runWatch(
+    { bucket, ...options }: WatchConfig,
+    watcher: ObjectStorageWatcher,
+  ): Promise<void> {
+    const storage = await this.client.create({ bucketName: bucket });
+
+    this.watch(
+      storage.getRawStorage(),
+      async (event) => {
+        if (!event) return;
+
+        await (event.deleted ? watcher.onDelete(event) : watcher.onPut(event));
+      },
+      options,
+    );
+  }
+
+  /**
+   * Discovers and returns an array of ObjectStorageWatcher instances
+   * along with their corresponding metadata.
+   *
+   * @returns An array of objects containing the ObjectStorageWatcher
+   * instance and its metadata.
+   */
+  private discoverWatchers(): {
+    instance: ObjectStorageWatcher;
+    metadata: WatchConfig;
+  }[] {
+    return this.discovery.getProviders().reduce(
+      (acc, watcher) => {
+        /**
+         * NOTE: This is a fix for TypeError in call .getMetadataByDecorator() above
+         * because some tokens are not instances of classes and have no constructor.
+         * */
+        const clsRef = watcher.instance?.constructor ?? watcher.metatype;
+        if (!clsRef) {
+          return acc;
+        }
+
+        const metadata = this.discovery.getMetadataByDecorator(
+          WatchObjectStorage,
+          watcher,
+        );
+
+        if (metadata && metadata.connectionName === this.connectionName) {
+          acc.push({ instance: watcher.instance, metadata });
+        }
+        return acc;
+      },
+      [] as { instance: ObjectStorageWatcher; metadata: WatchConfig }[],
+    );
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.test.e2e.ts",
+    "**/*.test.manual-e2e.ts",
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  }
+}