@dismissible/nestjs-dismissible-item 0.0.1

package/README.md

@@ -0,0 +1,119 @@
+# @dismissible/nestjs-dismissible-item
+
+Core data models and factory for dismissible items in NestJS applications.
+
+> **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 the foundational data structures for the Dismissible system:
+
+- `DismissibleItemDto` - The core data transfer object representing a dismissible item
+- `DismissibleItemFactory` - Factory for creating and manipulating dismissible items
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-dismissible-item
+```
+
+## Getting Started
+
+### Basic Usage
+
+The `DismissibleItemDto` class represents a dismissible item with the following properties:
+
+- `id` - Unique identifier for the item
+- `userId` - User identifier who owns the item
+- `createdAt` - Timestamp when the item was created
+- `dismissedAt` - Optional timestamp when the item was dismissed
+
+```typescript
+import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
+
+const item: DismissibleItemDto = {
+  id: 'welcome-banner',
+  userId: 'user-123',
+  createdAt: new Date(),
+};
+```
+
+### Using the Factory
+
+The `DismissibleItemFactory` provides methods for creating and manipulating items:
+
+```typescript
+import { Module } from '@nestjs/common';
+import {
+  DismissibleItemModule,
+  DismissibleItemFactory,
+} from '@dismissible/nestjs-dismissible-item';
+
+@Module({
+  imports: [DismissibleItemModule],
+})
+export class AppModule {}
+
+// In your service
+import { Injectable } from '@nestjs/common';
+import { DismissibleItemFactory, DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
+
+@Injectable()
+export class MyService {
+  constructor(private readonly itemFactory: DismissibleItemFactory) {}
+
+  createItem(): DismissibleItemDto {
+    return this.itemFactory.create({
+      id: 'welcome-banner',
+      userId: 'user-123',
+      createdAt: new Date(),
+    });
+  }
+
+  dismissItem(item: DismissibleItemDto): DismissibleItemDto {
+    return this.itemFactory.createDismissed(item, new Date());
+  }
+
+  restoreItem(item: DismissibleItemDto): DismissibleItemDto {
+    return this.itemFactory.createRestored(item);
+  }
+}
+```
+
+## API Reference
+
+### DismissibleItemDto
+
+The main data transfer object for dismissible items.
+
+```typescript
+class DismissibleItemDto {
+  id: string;
+  userId: string;
+  createdAt: Date;
+  dismissedAt?: Date;
+}
+```
+
+### DismissibleItemFactory
+
+Factory for creating and manipulating dismissible items.
+
+#### Methods
+
+- `create(options)` - Create a new item from options
+- `clone(item)` - Create a clone of an existing item
+- `createDismissed(item, dismissedAt)` - Create a dismissed version of an item
+- `createRestored(item)` - Create a restored (non-dismissed) version of an item
+
+## Related Packages
+
+This library is typically used alongside other Dismissible packages:
+
+- `@dismissible/nestjs-dismissible` - Main dismissible service and module
+- `@dismissible/nestjs-storage` - Storage interface and adapters
+- `@dismissible/nestjs-postgres-storage` - PostgreSQL storage adapter
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@dismissible/nestjs-dismissible-item",
+  "version": "0.0.1",
+  "description": "Dismissible item library",
+  "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"
+  ],
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/swagger": "^11.0.0",
+    "class-validator": "^0.14.0",
+    "class-transformer": "^0.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    },
+    "@nestjs/swagger": {
+      "optional": false
+    },
+    "class-validator": {
+      "optional": false
+    },
+    "class-transformer": {
+      "optional": false
+    }
+  },
+  "keywords": [
+    "nestjs",
+    "dismissible",
+    "dismissible-item"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DismissibleIo/dismissible-api"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/dismissible-item.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Represents a dismissible item in the system.
+ */
+export declare class DismissibleItemDto {
+    id: string;
+    userId: string;
+    createdAt: Date;
+    dismissedAt?: Date;
+}

package/src/dismissible-item.factory.d.ts

@@ -0,0 +1,34 @@
+import { DismissibleItemDto } from './dismissible-item';
+/**
+ * Options for creating a dismissible item.
+ */
+export interface ICreateDismissibleItemOptions {
+    id: string;
+    createdAt: Date;
+    userId: string;
+    dismissedAt?: Date;
+}
+/**
+ * Factory for creating DismissibleItemDto instances.
+ * Uses class-transformer to ensure proper class instantiation.
+ */
+export declare class DismissibleItemFactory {
+    /**
+     * Create a new DismissibleItemDto instance from the provided options.
+     * Uses plainToInstance to ensure the result is a proper class instance.
+     */
+    create(options: ICreateDismissibleItemOptions): DismissibleItemDto;
+    /**
+     * Create a clone of an existing DismissibleItemDto.
+     */
+    clone(item: DismissibleItemDto): DismissibleItemDto;
+    /**
+     * Create a dismissed version of an existing item.
+     */
+    createDismissed(item: DismissibleItemDto, dismissedAt: Date): DismissibleItemDto;
+    /**
+     * Create a restored (non-dismissed) version of an existing item.
+     * Removes the dismissedAt property.
+     */
+    createRestored(item: DismissibleItemDto): DismissibleItemDto;
+}

package/src/dismissible-item.factory.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DismissibleItemFactory = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const class_transformer_1 = require("class-transformer");
+const dismissible_item_1 = require("./dismissible-item");
+/**
+ * Factory for creating DismissibleItemDto instances.
+ * Uses class-transformer to ensure proper class instantiation.
+ */
+let DismissibleItemFactory = class DismissibleItemFactory {
+    /**
+     * Create a new DismissibleItemDto instance from the provided options.
+     * Uses plainToInstance to ensure the result is a proper class instance.
+     */
+    create(options) {
+        return (0, class_transformer_1.plainToInstance)(dismissible_item_1.DismissibleItemDto, options, {
+            excludeExtraneousValues: false,
+            enableImplicitConversion: true,
+        });
+    }
+    /**
+     * Create a clone of an existing DismissibleItemDto.
+     */
+    clone(item) {
+        return this.create({
+            id: item.id,
+            createdAt: item.createdAt,
+            userId: item.userId,
+            dismissedAt: item.dismissedAt,
+        });
+    }
+    /**
+     * Create a dismissed version of an existing item.
+     */
+    createDismissed(item, dismissedAt) {
+        return this.create({
+            id: item.id,
+            createdAt: item.createdAt,
+            userId: item.userId,
+            dismissedAt,
+        });
+    }
+    /**
+     * Create a restored (non-dismissed) version of an existing item.
+     * Removes the dismissedAt property.
+     */
+    createRestored(item) {
+        return this.create({
+            id: item.id,
+            createdAt: item.createdAt,
+            userId: item.userId,
+            dismissedAt: undefined,
+        });
+    }
+};
+exports.DismissibleItemFactory = DismissibleItemFactory;
+exports.DismissibleItemFactory = DismissibleItemFactory = tslib_1.__decorate([
+    (0, common_1.Injectable)()
+], DismissibleItemFactory);
+//# sourceMappingURL=dismissible-item.factory.js.map

package/src/dismissible-item.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dismissible-item.factory.js","sourceRoot":"","sources":["../../../../libs/dismissible-item/src/dismissible-item.factory.ts"],"names":[],"mappings":";;;;AAAA,2CAA4C;AAC5C,yDAAoD;AACpD,yDAAwD;AAYxD;;;GAGG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IACjC;;;OAGG;IACH,MAAM,CAAC,OAAsC;QAC3C,OAAO,IAAA,mCAAe,EAAC,qCAAkB,EAAE,OAAO,EAAE;YAClD,uBAAuB,EAAE,KAAK;YAC9B,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAwB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,IAAwB,EAAE,WAAiB;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,IAAwB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,WAAW,EAAE,SAAS;SACvB,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAhDY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,mBAAU,GAAE;GACA,sBAAsB,CAgDlC"}

package/src/dismissible-item.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DismissibleItemDto = void 0;
+const tslib_1 = require("tslib");
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+/**
+ * Represents a dismissible item in the system.
+ */
+class DismissibleItemDto {
+}
+exports.DismissibleItemDto = DismissibleItemDto;
+tslib_1.__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'Unique identifier for the item',
+        example: 'welcome-banner-v2',
+    }),
+    (0, class_validator_1.IsString)(),
+    tslib_1.__metadata("design:type", String)
+], DismissibleItemDto.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'User identifier who created the item',
+        example: 'user-123',
+    }),
+    (0, class_validator_1.IsString)(),
+    tslib_1.__metadata("design:type", String)
+], DismissibleItemDto.prototype, "userId", void 0);
+tslib_1.__decorate([
+    (0, swagger_1.ApiProperty)({
+        description: 'When the item was created',
+        example: '2024-01-15T10:30:00.000Z',
+    }),
+    (0, class_validator_1.IsDate)(),
+    (0, class_transformer_1.Type)(() => Date),
+    tslib_1.__metadata("design:type", Date)
+], DismissibleItemDto.prototype, "createdAt", void 0);
+tslib_1.__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        description: 'When the item was dismissed, if applicable',
+        example: '2024-01-15T12:00:00.000Z',
+    }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsDate)(),
+    (0, class_transformer_1.Type)(() => Date),
+    tslib_1.__metadata("design:type", Date)
+], DismissibleItemDto.prototype, "dismissedAt", void 0);
+//# sourceMappingURL=dismissible-item.js.map

package/src/dismissible-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dismissible-item.js","sourceRoot":"","sources":["../../../../libs/dismissible-item/src/dismissible-item.ts"],"names":[],"mappings":";;;;AAAA,6CAAmE;AACnE,qDAA+D;AAC/D,yDAAyC;AAEzC;;GAEG;AACH,MAAa,kBAAkB;CA+B9B;AA/BD,gDA+BC;AAzBC;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,gCAAgC;QAC7C,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IACD,IAAA,0BAAQ,GAAE;;8CACC;AAOZ;IALC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,sCAAsC;QACnD,OAAO,EAAE,UAAU;KACpB,CAAC;IACD,IAAA,0BAAQ,GAAE;;kDACK;AAQhB;IANC,IAAA,qBAAW,EAAC;QACX,WAAW,EAAE,2BAA2B;QACxC,OAAO,EAAE,0BAA0B;KACpC,CAAC;IACD,IAAA,wBAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;sCACL,IAAI;qDAAC;AASjB;IAPC,IAAA,6BAAmB,EAAC;QACnB,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,0BAA0B;KACpC,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,wBAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC;sCACH,IAAI;uDAAC"}

package/src/dismissible-item.module.d.ts

@@ -0,0 +1,2 @@
+export declare class DismissibleItemModule {
+}

package/src/dismissible-item.module.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DismissibleItemModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const dismissible_item_factory_1 = require("./dismissible-item.factory");
+let DismissibleItemModule = class DismissibleItemModule {
+};
+exports.DismissibleItemModule = DismissibleItemModule;
+exports.DismissibleItemModule = DismissibleItemModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        providers: [dismissible_item_factory_1.DismissibleItemFactory],
+        exports: [dismissible_item_factory_1.DismissibleItemFactory],
+    })
+], DismissibleItemModule);
+//# sourceMappingURL=dismissible-item.module.js.map

package/src/dismissible-item.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dismissible-item.module.js","sourceRoot":"","sources":["../../../../libs/dismissible-item/src/dismissible-item.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAwC;AACxC,yEAAoE;AAM7D,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;CAAG,CAAA;AAAxB,sDAAqB;gCAArB,qBAAqB;IAJjC,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,iDAAsB,CAAC;QACnC,OAAO,EAAE,CAAC,iDAAsB,CAAC;KAClC,CAAC;GACW,qBAAqB,CAAG"}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './dismissible-item';
+export * from './dismissible-item.factory';
+export * from './dismissible-item.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("./dismissible-item"), exports);
+tslib_1.__exportStar(require("./dismissible-item.factory"), exports);
+tslib_1.__exportStar(require("./dismissible-item.module"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/dismissible-item/src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,qEAA2C;AAC3C,oEAA0C"}