@dismissible/nestjs-dismissible-item 0.0.2-canary.8976e84.0 → 0.0.2-canary.b0d8bfe.0

package/README.md

@@ -10,7 +10,6 @@ This library provides the foundational data structures for the Dismissible syste
 
 - `DismissibleItemDto` - The core data transfer object representing a dismissible item
 - `DismissibleItemFactory` - Factory for creating and manipulating dismissible items
-- `BaseMetadata` - Type definition for item metadata
 
 ## Installation
 
@@ -28,24 +27,14 @@ The `DismissibleItemDto` class represents a dismissible item with the following
 - `userId` - User identifier who owns the item
 - `createdAt` - Timestamp when the item was created
 - `dismissedAt` - Optional timestamp when the item was dismissed
-- `metadata` - Optional metadata object (type-safe with generics)
 
 ```typescript
-import { DismissibleItemDto, BaseMetadata } from '@dismissible/nestjs-dismissible-item';
+import { DismissibleItemDto } from '@dismissible/nestjs-dismissible-item';
 
-interface MyMetadata extends BaseMetadata {
-  version: number;
-  category: string;
-}
-
-const item: DismissibleItemDto<MyMetadata> = {
+const item: DismissibleItemDto = {
   id: 'welcome-banner',
   userId: 'user-123',
   createdAt: new Date(),
-  metadata: {
-    version: 2,
-    category: 'onboarding',
-  },
 };
 ```
 
@@ -98,12 +87,11 @@ export class MyService {
 The main data transfer object for dismissible items.
 
 ```typescript
-class DismissibleItemDto<TMetadata extends BaseMetadata = BaseMetadata> {
+class DismissibleItemDto {
   id: string;
   userId: string;
   createdAt: Date;
   dismissedAt?: Date;
-  metadata?: TMetadata;
 }
 ```
 

package/jest.config.ts

@@ -7,4 +7,21 @@ export default {
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
   coverageDirectory: '../../coverage/libs/dismissible-item',
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.spec.ts',
+    '!src/**/*.interface.ts',
+    '!src/**/*.dto.ts',
+    '!src/**/*.enum.ts',
+    '!src/**/index.ts',
+    '!src/**/*.module.ts',
+  ],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dismissible/nestjs-dismissible-item",
-  "version": "0.0.2-canary.8976e84.0",
+  "version": "0.0.2-canary.b0d8bfe.0",
   "description": "Dismissible item library",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -12,11 +12,23 @@
     }
   },
   "peerDependencies": {
-    "@nestjs/common": "^11.0.0"
+    "@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": [

package/project.json

@@ -31,7 +31,7 @@
         "passWithNoTests": true
       }
     },
-    "npm-publish": {
+    "publish": {
       "executor": "nx:run-commands",
       "options": {
         "command": "npm publish --access public",

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

@@ -13,41 +13,38 @@ describe('DismissibleItemFactory', () => {
       const item = factory.create({
         id: 'test-id',
         createdAt: new Date('2024-01-15T10:00:00.000Z'),
+        userId: 'test-user-id',
       });
 
       expect(item).toBeInstanceOf(DismissibleItemDto);
       expect(item.id).toBe('test-id');
       expect(item.createdAt).toEqual(new Date('2024-01-15T10:00:00.000Z'));
+      expect(item.userId).toBe('test-user-id');
     });
 
     it('should handle optional properties when undefined', () => {
       const item = factory.create({
         id: 'test-id',
         createdAt: new Date('2024-01-15T10:00:00.000Z'),
-        userId: undefined,
-        metadata: undefined,
+        userId: 'test-user-id',
         dismissedAt: undefined,
       });
 
       expect(item.id).toBe('test-id');
       expect(item.createdAt).toEqual(new Date('2024-01-15T10:00:00.000Z'));
-      expect(item.userId).toBeUndefined();
-      expect(item.metadata).toBeUndefined();
+      expect(item.userId).toBe('test-user-id');
       expect(item.dismissedAt).toBeUndefined();
     });
 
     it('should include optional properties when provided', () => {
-      const metadata = { version: 2, category: 'test' };
       const item = factory.create({
         id: 'test-id',
         createdAt: new Date('2024-01-15T10:00:00.000Z'),
         userId: 'user-123',
-        metadata,
         dismissedAt: new Date('2024-01-15T12:00:00.000Z'),
       });
 
       expect(item.userId).toBe('user-123');
-      expect(item.metadata).toEqual(metadata);
       expect(item.dismissedAt).toEqual(new Date('2024-01-15T12:00:00.000Z'));
     });
   });
@@ -58,7 +55,6 @@ describe('DismissibleItemFactory', () => {
         id: 'test-id',
         createdAt: new Date('2024-01-15T10:00:00.000Z'),
         userId: 'user-123',
-        metadata: { key: 'value' },
       });
 
       const cloned = factory.clone(original);
@@ -104,21 +100,5 @@ describe('DismissibleItemFactory', () => {
       expect(restored.userId).toBe(dismissed.userId);
       expect(restored.dismissedAt).toBeUndefined();
     });
-
-    it('should preserve metadata when restoring', () => {
-      const metadata = { key: 'value', count: 42 };
-      const dismissed = factory.create({
-        id: 'test-id',
-        createdAt: new Date('2024-01-15T10:00:00.000Z'),
-        userId: 'user-123',
-        metadata,
-        dismissedAt: new Date('2024-01-15T12:00:00.000Z'),
-      });
-
-      const restored = factory.createRestored(dismissed);
-
-      expect(restored.metadata).toEqual(metadata);
-      expect(restored.metadata).not.toBe(dismissed.metadata); // Different object reference
-    });
   });
 });

package/src/dismissible-item.factory.ts

@@ -1,15 +1,14 @@
 import { Injectable } from '@nestjs/common';
 import { plainToInstance } from 'class-transformer';
-import { BaseMetadata, DismissibleItemDto } from './dismissible-item';
+import { DismissibleItemDto } from './dismissible-item';
 
 /**
  * Options for creating a dismissible item.
  */
-export interface ICreateDismissibleItemOptions<TMetadata extends BaseMetadata> {
+export interface ICreateDismissibleItemOptions {
   id: string;
   createdAt: Date;
-  userId?: string;
-  metadata?: TMetadata;
+  userId: string;
   dismissedAt?: Date;
 }
 
@@ -23,10 +22,8 @@ export class DismissibleItemFactory {
    * Create a new DismissibleItemDto instance from the provided options.
    * Uses plainToInstance to ensure the result is a proper class instance.
    */
-  create<TMetadata extends BaseMetadata = BaseMetadata>(
-    options: ICreateDismissibleItemOptions<TMetadata>,
-  ): DismissibleItemDto<TMetadata> {
-    return plainToInstance(DismissibleItemDto<TMetadata>, options, {
+  create(options: ICreateDismissibleItemOptions): DismissibleItemDto {
+    return plainToInstance(DismissibleItemDto, options, {
       excludeExtraneousValues: false,
       enableImplicitConversion: true,
     });
@@ -35,14 +32,11 @@ export class DismissibleItemFactory {
   /**
    * Create a clone of an existing DismissibleItemDto.
    */
-  clone<TMetadata extends BaseMetadata = BaseMetadata>(
-    item: DismissibleItemDto<TMetadata>,
-  ): DismissibleItemDto<TMetadata> {
+  clone(item: DismissibleItemDto): DismissibleItemDto {
     return this.create({
       id: item.id,
       createdAt: item.createdAt,
       userId: item.userId,
-      metadata: item.metadata,
       dismissedAt: item.dismissedAt,
     });
   }
@@ -50,15 +44,11 @@ export class DismissibleItemFactory {
   /**
    * Create a dismissed version of an existing item.
    */
-  createDismissed<TMetadata extends BaseMetadata = BaseMetadata>(
-    item: DismissibleItemDto<TMetadata>,
-    dismissedAt: Date,
-  ): DismissibleItemDto<TMetadata> {
+  createDismissed(item: DismissibleItemDto, dismissedAt: Date): DismissibleItemDto {
     return this.create({
       id: item.id,
       createdAt: item.createdAt,
       userId: item.userId,
-      metadata: item.metadata,
       dismissedAt,
     });
   }
@@ -67,14 +57,11 @@ export class DismissibleItemFactory {
    * Create a restored (non-dismissed) version of an existing item.
    * Removes the dismissedAt property.
    */
-  createRestored<TMetadata extends BaseMetadata = BaseMetadata>(
-    item: DismissibleItemDto<TMetadata>,
-  ): DismissibleItemDto<TMetadata> {
+  createRestored(item: DismissibleItemDto): DismissibleItemDto {
     return this.create({
       id: item.id,
       createdAt: item.createdAt,
       userId: item.userId,
-      metadata: item.metadata,
       dismissedAt: undefined,
     });
   }

package/src/dismissible-item.ts

@@ -1,17 +1,11 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { IsString, IsDate, IsOptional, IsObject } from 'class-validator';
+import { IsString, IsDate, IsOptional } from 'class-validator';
 import { Type } from 'class-transformer';
 
-/**
- * Base metadata type for dismissible items.
- * Can be extended with custom metadata fields.
- */
-export type BaseMetadata = Record<string, unknown>;
-
 /**
  * Represents a dismissible item in the system.
  */
-export class DismissibleItemDto<TMetadata extends BaseMetadata = BaseMetadata> {
+export class DismissibleItemDto {
   @ApiProperty({
     description: 'Unique identifier for the item',
     example: 'welcome-banner-v2',
@@ -42,14 +36,4 @@ export class DismissibleItemDto<TMetadata extends BaseMetadata = BaseMetadata> {
   @IsDate()
   @Type(() => Date)
   dismissedAt?: Date;
-
-  @ApiPropertyOptional({
-    description: 'Optional metadata associated with the item',
-    example: { version: 2, category: 'promotional' },
-    type: 'object',
-    additionalProperties: true,
-  })
-  @IsOptional()
-  @IsObject()
-  metadata?: TMetadata;
 }

package/tsconfig.json

@@ -5,6 +5,9 @@
   "references": [
     {
       "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
     }
   ],
   "compilerOptions": {

package/tsconfig.spec.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["node", "jest"],
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "ES2021"
+  },
+  "include": ["src/**/*.spec.ts", "src/**/*.test.ts"]
+}