@dismissible/nestjs-postgres-storage 0.0.2-canary.738340d.0

package/README.md

@@ -0,0 +1,211 @@
+# @dismissible/nestjs-postgres-storage
+
+PostgreSQL storage adapter for the Dismissible system using Prisma.
+
+> **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 a production-ready PostgreSQL storage adapter for the Dismissible system. It uses Prisma for database access and includes:
+
+- Persistent storage of dismissible items
+- Automatic database migrations via Prisma
+- Connection pooling and lifecycle management
+- Full TypeScript support
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-postgres-storage
+```
+
+You'll also need to install the peer dependencies:
+
+```bash
+npm install @dismissible/nestjs-storage @dismissible/nestjs-dismissible-item @dismissible/nestjs-logger prisma
+```
+
+## Prerequisites
+
+- PostgreSQL database (version 12 or higher)
+- Node.js 18 or higher
+
+## Getting Started
+
+### 1. Database Setup
+
+First, set up your PostgreSQL database connection string:
+
+```env
+DISMISSIBLE_POSTGRES_STORAGE_CONNECTION_STRING=postgresql://user:password@localhost:5432/dismissible
+```
+
+### 2. Database Migration
+
+Run Prisma migrations to set up the database schema:
+
+```bash
+# Generate Prisma client
+npx prisma generate --schema=node_modules/@dismissible/nestjs-postgres-storage/prisma/schema.prisma
+
+# Push schema to database (for development)
+npx prisma db push --schema=node_modules/@dismissible/nestjs-postgres-storage/prisma/schema.prisma
+
+# Or run migrations (for production)
+npx prisma migrate dev --schema=node_modules/@dismissible/nestjs-postgres-storage/prisma/schema.prisma
+```
+
+Alternatively, you can use the provided CLI tool:
+
+```bash
+npx dismissible-prisma generate
+npx dismissible-prisma migrate dev
+```
+
+### 3. Module Configuration
+
+Import and configure the module in your NestJS application:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { DismissibleModule } from '@dismissible/nestjs-dismissible';
+import { PostgresStorageModule } from '@dismissible/nestjs-postgres-storage';
+import { LoggerModule } from '@dismissible/nestjs-logger';
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({}),
+    PostgresStorageModule.forRoot({
+      connectionString: process.env.DISMISSIBLE_POSTGRES_STORAGE_CONNECTION_STRING!,
+    }),
+    DismissibleModule.forRoot({
+      storage: PostgresStorageModule,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### 4. Async Configuration
+
+You can also configure the module asynchronously:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { PostgresStorageModule } from '@dismissible/nestjs-postgres-storage';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot(),
+    PostgresStorageModule.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: (config: ConfigService) => ({
+        connectionString: config.get<string>('DISMISSIBLE_POSTGRES_STORAGE_CONNECTION_STRING')!,
+      }),
+      inject: [ConfigService],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## Database Schema
+
+The library uses Prisma to manage the database schema. The schema includes:
+
+- `DismissibleItem` table with fields:
+  - `id` (String, primary key)
+  - `userId` (String, indexed)
+  - `createdAt` (DateTime)
+  - `dismissedAt` (DateTime, nullable)
+  - `metadata` (Json, nullable)
+
+## API Reference
+
+### PostgresStorageModule
+
+#### `PostgresStorageModule.forRoot(options)`
+
+Configures the PostgreSQL storage module synchronously.
+
+**Options:**
+
+- `connectionString: string` - PostgreSQL connection string
+
+**Returns:** `DynamicModule`
+
+#### `PostgresStorageModule.forRootAsync(options)`
+
+Configures the PostgreSQL storage module asynchronously.
+
+**Options:**
+
+- `imports?: any[]` - Modules to import
+- `useFactory: (deps) => PostgresStorageModuleOptions` - Factory function
+- `inject?: any[]` - Dependencies to inject into the factory
+
+**Returns:** `DynamicModule`
+
+### PostgresStorageAdapter
+
+The adapter implements `IDismissibleStorage` and provides:
+
+- `get(userId, itemId)` - Retrieve an item
+- `create(item)` - Create a new item
+- `update(item)` - Update an existing item
+
+### PrismaService
+
+The service manages the Prisma client lifecycle:
+
+- Automatically connects on module initialization
+- Automatically disconnects on module destruction
+- Uses connection pooling via `pg` adapter
+
+## CLI Tool
+
+The package includes a CLI tool for Prisma operations:
+
+```bash
+# Generate Prisma client
+npx dismissible-prisma generate
+
+# Run migrations
+npx dismissible-prisma migrate dev
+
+# Push schema (development)
+npx dismissible-prisma db push
+
+# View database
+npx dismissible-prisma studio
+```
+
+## Environment Variables
+
+- `DISMISSIBLE_POSTGRES_STORAGE_CONNECTION_STRING` - PostgreSQL connection string (required)
+
+## Production Considerations
+
+1. **Connection Pooling**: The adapter uses `pg` connection pooling. Configure your pool size based on your application's needs.
+
+2. **Migrations**: Always use Prisma migrations in production:
+
+   ```bash
+   npx prisma migrate deploy --schema=node_modules/@dismissible/nestjs-postgres-storage/prisma/schema.prisma
+   ```
+
+3. **Monitoring**: Monitor database connections and query performance.
+
+4. **Backups**: Ensure regular database backups are in place.
+
+## Related Packages
+
+- `@dismissible/nestjs-dismissible` - Main dismissible service
+- `@dismissible/nestjs-storage` - Storage interface
+- `@dismissible/nestjs-dismissible-item` - Data models
+- `@dismissible/nestjs-logger` - Logging
+
+## License
+
+MIT

package/bin/dismissible-prisma.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+/**
+ * CLI helper for @dismissible/nestjs-postgres-storage
+ * Runs Prisma commands with the correct schema path.
+ *
+ * Usage:
+ *   npx dismissible-prisma generate
+ *   npx dismissible-prisma migrate dev
+ *   npx dismissible-prisma migrate deploy
+ *   npx dismissible-prisma db push
+ *   npx dismissible-prisma studio
+ */
+
+const { execSync } = require('child_process');
+const path = require('path');
+
+const schemaPath = path.join(__dirname, '..', 'prisma', 'schema.prisma');
+const args = process.argv.slice(2);
+
+if (args.length === 0) {
+  console.log(`
+@dismissible/nestjs-postgres-storage - Prisma CLI Helper
+
+Usage:
+  npx dismissible-prisma <command> [options]
+
+Commands:
+  generate          Generate Prisma Client
+  migrate dev       Create and apply migrations (development)
+  migrate deploy    Apply pending migrations (production)
+  migrate reset     Reset database and apply all migrations
+  db push           Push schema to database without migrations
+  db pull           Pull schema from database
+  studio            Open Prisma Studio
+
+Examples:
+  npx dismissible-prisma generate
+  npx dismissible-prisma migrate dev --name init
+  npx dismissible-prisma db push
+
+Schema location: ${schemaPath}
+`);
+  process.exit(0);
+}
+
+const command = `npx prisma ${args.join(' ')} --schema="${schemaPath}"`;
+
+console.log(`Running: ${command}\n`);
+
+try {
+  execSync(command, { stdio: 'inherit' });
+} catch (error) {
+  process.exit(error.status || 1);
+}

package/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'postgres-storage',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/postgres-storage',
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@dismissible/nestjs-postgres-storage",
+  "version": "0.0.2-canary.738340d.0",
+  "description": "PostgreSQL storage adapter for Dismissible using Prisma",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "bin": {
+    "dismissible-prisma": "./bin/dismissible-prisma.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    },
+    "./prisma/schema.prisma": "./prisma/schema.prisma"
+  },
+  "prisma": {
+    "schema": "prisma/schema.prisma"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@dismissible/nestjs-storage": "^0.0.2-canary.738340d.0",
+    "@dismissible/nestjs-dismissible-item": "^0.0.2-canary.738340d.0",
+    "@dismissible/nestjs-logger": "^0.0.2-canary.738340d.0",
+    "prisma": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    },
+    "@dismissible/nestjs-storage": {
+      "optional": false
+    },
+    "@dismissible/nestjs-dismissible-item": {
+      "optional": false
+    },
+    "@dismissible/nestjs-logger": {
+      "optional": false
+    },
+    "prisma": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@prisma/client": "^7.0.0",
+    "@prisma/adapter-pg": "^7.0.0",
+    "pg": "^8.13.0"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.11.10"
+  },
+  "keywords": [
+    "nestjs",
+    "dismissible",
+    "storage",
+    "postgres",
+    "prisma",
+    "adapter"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  }
+}

package/prisma/generated/prisma/browser.ts

@@ -0,0 +1,24 @@
+
+/* !!! This is code generated by Prisma. Do not edit directly. !!! */
+/* eslint-disable */
+// biome-ignore-all lint: generated file
+// @ts-nocheck 
+/*
+ * This file should be your main import to use Prisma-related types and utilities in a browser. 
+ * Use it to get access to models, enums, and input types.
+ * 
+ * This file does not contain a `PrismaClient` class, nor several other helpers that are intended as server-side only.
+ * See `client.ts` for the standard, server-side entry point.
+ *
+ * 🟢 You can import this file directly.
+ */
+
+import * as Prisma from './internal/prismaNamespaceBrowser'
+export { Prisma }
+export * as $Enums from './enums'
+export * from './enums';
+/**
+ * Model DismissibleItem
+ * 
+ */
+export type DismissibleItem = Prisma.DismissibleItemModel

package/prisma/generated/prisma/client.ts

@@ -0,0 +1,44 @@
+
+/* !!! This is code generated by Prisma. Do not edit directly. !!! */
+/* eslint-disable */
+// biome-ignore-all lint: generated file
+// @ts-nocheck 
+/*
+ * This file should be your main import to use Prisma. Through it you get access to all the models, enums, and input types.
+ * If you're looking for something you can import in the client-side of your application, please refer to the `browser.ts` file instead.
+ *
+ * 🟢 You can import this file directly.
+ */
+
+import * as process from 'node:process'
+import * as path from 'node:path'
+
+import * as runtime from "@prisma/client/runtime/client"
+import * as $Enums from "./enums"
+import * as $Class from "./internal/class"
+import * as Prisma from "./internal/prismaNamespace"
+
+export * as $Enums from './enums'
+export * from "./enums"
+/**
+ * ## Prisma Client
+ * 
+ * Type-safe database client for TypeScript
+ * @example
+ * ```
+ * const prisma = new PrismaClient()
+ * // Fetch zero or more DismissibleItems
+ * const dismissibleItems = await prisma.dismissibleItem.findMany()
+ * ```
+ * 
+ * Read more in our [docs](https://pris.ly/d/client).
+ */
+export const PrismaClient = $Class.getPrismaClientClass()
+export type PrismaClient<LogOpts extends Prisma.LogLevel = never, OmitOpts extends Prisma.PrismaClientOptions["omit"] = Prisma.PrismaClientOptions["omit"], ExtArgs extends runtime.Types.Extensions.InternalArgs = runtime.Types.Extensions.DefaultArgs> = $Class.PrismaClient<LogOpts, OmitOpts, ExtArgs>
+export { Prisma }
+
+/**
+ * Model DismissibleItem
+ * 
+ */
+export type DismissibleItem = Prisma.DismissibleItemModel