@dismissible/nestjs-storage 0.0.1

package/README.md

@@ -0,0 +1,148 @@
+# @dismissible/nestjs-storage
+
+Storage interface and in-memory adapter for the Dismissible system.
+
+> **Part of the Dismissible API** - This library is part of the [Dismissible API](https://dismissible.io) ecosystem. Visit [dismissible.io](https://dismissible.io) for more information and documentation.
+
+## Overview
+
+This library provides:
+
+- `IDismissibleStorage` - Interface that all storage adapters must implement
+- `MemoryStorageAdapter` - In-memory storage implementation (useful for development and testing)
+- Storage abstraction layer for the Dismissible system
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-storage
+```
+
+## Getting Started
+
+### Using In-Memory Storage
+
+The in-memory storage adapter is useful for development, testing, or when you don't need persistence:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { StorageModule, MemoryStorageAdapter } from '@dismissible/nestjs-storage';
+import { LoggerModule } from '@dismissible/nestjs-logger';
+import { DismissibleItemModule } from '@dismissible/nestjs-dismissible-item';
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({}),
+    DismissibleItemModule,
+    StorageModule.forRoot({
+      adapter: MemoryStorageAdapter,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Implementing a Custom Storage Adapter
+
+You can implement your own storage adapter by implementing the `IDismissibleStorage` interface:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { IDismissibleStorage, DISMISSIBLE_STORAGE_ADAPTER } from '@dismissible/nestjs-storage';
+import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
+import { DISMISSIBLE_LOGGER, IDismissibleLogger } from '@dismissible/nestjs-logger';
+
+@Injectable()
+export class MyCustomStorageAdapter implements IDismissibleStorage {
+  constructor(@Inject(DISMISSIBLE_LOGGER) private readonly logger: IDismissibleLogger) {}
+
+  async get(userId: string, itemId: string): Promise<DismissibleItemDto | null> {
+    // Your implementation
+    this.logger.debug('Getting item', { userId, itemId });
+    // ...
+  }
+
+  async create(item: DismissibleItemDto): Promise<DismissibleItemDto> {
+    // Your implementation
+    this.logger.debug('Creating item', { itemId: item.id });
+    // ...
+  }
+
+  async update(item: DismissibleItemDto): Promise<DismissibleItemDto> {
+    // Your implementation
+    this.logger.debug('Updating item', { itemId: item.id });
+    // ...
+  }
+}
+
+// Register your adapter
+@Module({
+  providers: [
+    MyCustomStorageAdapter,
+    {
+      provide: DISMISSIBLE_STORAGE_ADAPTER,
+      useExisting: MyCustomStorageAdapter,
+    },
+  ],
+  exports: [DISMISSIBLE_STORAGE_ADAPTER],
+})
+export class MyStorageModule {}
+```
+
+## API Reference
+
+### IDismissibleStorage Interface
+
+```typescript
+interface IDismissibleStorage {
+  get(userId: string, itemId: string): Promise<DismissibleItemDto | null>;
+  create(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+  update(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+}
+```
+
+### MemoryStorageAdapter
+
+An in-memory implementation of `IDismissibleStorage`. Data is stored in a `Map` and will be lost when the application restarts.
+
+**Note:** This adapter is suitable for development and testing only. For production use, consider using `@dismissible/nestjs-postgres-storage` or implementing your own persistent storage adapter.
+
+### StorageModule
+
+#### `StorageModule.forRoot(options)`
+
+Configures the storage module with the provided adapter.
+
+**Options:**
+
+- `adapter: Type<IDismissibleStorage>` - The storage adapter class to use
+
+**Returns:** `DynamicModule`
+
+## Injection Token
+
+The storage adapter is provided via the `DISMISSIBLE_STORAGE_ADAPTER` injection token:
+
+```typescript
+import { Inject } from '@nestjs/common';
+import { DISMISSIBLE_STORAGE_ADAPTER, IDismissibleStorage } from '@dismissible/nestjs-storage';
+
+@Injectable()
+export class MyService {
+  constructor(
+    @Inject(DISMISSIBLE_STORAGE_ADAPTER)
+    private readonly storage: IDismissibleStorage,
+  ) {}
+}
+```
+
+## Related Packages
+
+- `@dismissible/nestjs-dismissible` - Main dismissible service (uses storage adapters)
+- `@dismissible/nestjs-postgres-storage` - PostgreSQL storage adapter implementation
+- `@dismissible/nestjs-dismissible-item` - Data models used by storage adapters
+- `@dismissible/nestjs-logger` - Logging used by storage adapters
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@dismissible/nestjs-storage",
+  "version": "0.0.1",
+  "description": "In-memory storage adapter for Dismissible",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "dependencies": {
+    "@dismissible/nestjs-logger": "^0.0.1",
+    "@dismissible/nestjs-dismissible-item": "^0.0.1"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    }
+  },
+  "keywords": [
+    "nestjs",
+    "dismissible",
+    "storage",
+    "storage",
+    "adapter"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DismissibleIo/dismissible-api"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './memory-storage.adapter';
+export * from './storage.interface';
+export * from './storage.module';

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./memory-storage.adapter"), exports);
+tslib_1.__exportStar(require("./storage.interface"), exports);
+tslib_1.__exportStar(require("./storage.module"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/storage/src/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,8DAAoC;AACpC,2DAAiC"}

package/src/memory-storage.adapter.d.ts

@@ -0,0 +1,29 @@
+import { IDismissibleLogger } from '@dismissible/nestjs-logger';
+import { IDismissibleStorage } from './storage.interface';
+import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
+/**
+ * In-memory storage provider for dismissible items.
+ * Suitable for development and testing; not for production use.
+ */
+export declare class MemoryStorageAdapter implements IDismissibleStorage {
+    private readonly logger;
+    private readonly storage;
+    constructor(logger: IDismissibleLogger);
+    /**
+     * Create a storage key from userId and itemId.
+     */
+    private createKey;
+    get(userId: string, itemId: string): Promise<DismissibleItemDto | null>;
+    create(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+    update(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+    /**
+     * Clear all stored items.
+     * Useful for testing.
+     */
+    clear(): void;
+    /**
+     * Get the number of stored items.
+     * Useful for testing/debugging.
+     */
+    get size(): number;
+}

package/src/memory-storage.adapter.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryStorageAdapter = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const nestjs_logger_1 = require("@dismissible/nestjs-logger");
+/**
+ * In-memory storage provider for dismissible items.
+ * Suitable for development and testing; not for production use.
+ */
+let MemoryStorageAdapter = class MemoryStorageAdapter {
+    constructor(logger) {
+        this.logger = logger;
+        this.storage = new Map();
+    }
+    /**
+     * Create a storage key from userId and itemId.
+     */
+    createKey(userId, itemId) {
+        return `${userId}:${itemId}`;
+    }
+    async get(userId, itemId) {
+        const key = this.createKey(userId, itemId);
+        this.logger.debug(`Storage get`, { userId, itemId, key });
+        const item = this.storage.get(key);
+        if (!item) {
+            this.logger.debug(`Storage miss`, { userId, itemId });
+            return null;
+        }
+        this.logger.debug(`Storage hit`, { userId, itemId });
+        return item;
+    }
+    async create(item) {
+        const key = this.createKey(item.userId, item.id);
+        this.logger.debug(`Storage create`, { userId: item.userId, itemId: item.id, key });
+        this.storage.set(key, item);
+        return item;
+    }
+    async update(item) {
+        const key = this.createKey(item.userId, item.id);
+        this.logger.debug(`Storage update`, { userId: item.userId, itemId: item.id, key });
+        this.storage.set(key, item);
+        return item;
+    }
+    /**
+     * Clear all stored items.
+     * Useful for testing.
+     */
+    clear() {
+        this.logger.debug(`Storage clear`, { previousSize: this.storage.size });
+        this.storage.clear();
+    }
+    /**
+     * Get the number of stored items.
+     * Useful for testing/debugging.
+     */
+    get size() {
+        return this.storage.size;
+    }
+};
+exports.MemoryStorageAdapter = MemoryStorageAdapter;
+exports.MemoryStorageAdapter = MemoryStorageAdapter = tslib_1.__decorate([
+    (0, common_1.Injectable)(),
+    tslib_1.__param(0, (0, common_1.Inject)(nestjs_logger_1.DISMISSIBLE_LOGGER)),
+    tslib_1.__metadata("design:paramtypes", [Object])
+], MemoryStorageAdapter);
+//# sourceMappingURL=memory-storage.adapter.js.map

package/src/memory-storage.adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-storage.adapter.js","sourceRoot":"","sources":["../../../../libs/storage/src/memory-storage.adapter.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,8DAAoF;AAIpF;;;GAGG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAG/B,YAAwC,MAA2C;QAA1B,WAAM,GAAN,MAAM,CAAoB;QAFlE,YAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;IAEqB,CAAC;IAEvF;;OAEG;IACK,SAAS,CAAC,MAAc,EAAE,MAAc;QAC9C,OAAO,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAc,EAAE,MAAc;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QAE1D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAwB;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAwB;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF,CAAA;AAzDY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;IAIE,mBAAA,IAAA,eAAM,EAAC,kCAAkB,CAAC,CAAA;;GAH5B,oBAAoB,CAyDhC"}

package/src/storage.interface.d.ts

@@ -0,0 +1,30 @@
+import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
+/**
+ * Injection token for the storage provider.
+ */
+export declare const DISMISSIBLE_STORAGE_ADAPTER: unique symbol;
+/**
+ * Interface for storage providers.
+ * Implementations handle the persistence of dismissible items.
+ */
+export interface IDismissibleStorage {
+    /**
+     * Retrieve an item by user ID and item ID.
+     * @param userId The user identifier
+     * @param itemId The item identifier
+     * @returns The item or null if not found
+     */
+    get(userId: string, itemId: string): Promise<DismissibleItemDto | null>;
+    /**
+     * Create a new item.
+     * @param item The item to create (contains userId and id)
+     * @returns The created item
+     */
+    create(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+    /**
+     * Update an existing item.
+     * @param item The item to update (contains userId and id)
+     * @returns The updated item
+     */
+    update(item: DismissibleItemDto): Promise<DismissibleItemDto>;
+}

package/src/storage.interface.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISMISSIBLE_STORAGE_ADAPTER = void 0;
+/**
+ * Injection token for the storage provider.
+ */
+exports.DISMISSIBLE_STORAGE_ADAPTER = Symbol('DISMISSIBLE_STORAGE_ADAPTER');
+//# sourceMappingURL=storage.interface.js.map

package/src/storage.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.interface.js","sourceRoot":"","sources":["../../../../libs/storage/src/storage.interface.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,2BAA2B,GAAG,MAAM,CAAC,6BAA6B,CAAC,CAAC"}

package/src/storage.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule, Type } from '@nestjs/common';
+export type IDismissibleStorageModuleOptions = {
+    storage?: Type<any> | DynamicModule;
+};
+export declare class StorageModule {
+}

package/src/storage.module.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const storage_interface_1 = require("./storage.interface");
+const memory_storage_adapter_1 = require("./memory-storage.adapter");
+let StorageModule = class StorageModule {
+};
+exports.StorageModule = StorageModule;
+exports.StorageModule = StorageModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        providers: [
+            {
+                provide: storage_interface_1.DISMISSIBLE_STORAGE_ADAPTER,
+                useClass: memory_storage_adapter_1.MemoryStorageAdapter,
+            },
+        ],
+        exports: [storage_interface_1.DISMISSIBLE_STORAGE_ADAPTER],
+    })
+], StorageModule);
+//# sourceMappingURL=storage.module.js.map

package/src/storage.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.module.js","sourceRoot":"","sources":["../../../../libs/storage/src/storage.module.ts"],"names":[],"mappings":";;;;AAAA,2CAA6D;AAC7D,2DAAkE;AAClE,qEAAgE;AAezD,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IATzB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,+CAA2B;gBACpC,QAAQ,EAAE,6CAAoB;aAC/B;SACF;QACD,OAAO,EAAE,CAAC,+CAA2B,CAAC;KACvC,CAAC;GACW,aAAa,CAAG"}