@storecraft/database-postgres 1.0.12 → 1.0.14

package/README.md

@@ -27,8 +27,6 @@ import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js'
 const app = new App(
   {
     auth_admins_emails: ['admin@sc.com'],
-    auth_secret_access_token: 'auth_secret_access_token',
-    auth_secret_refresh_token: 'auth_secret_refresh_token'
   }
 )
 .withPlatform(new NodePlatform())
@@ -56,16 +54,31 @@ const server = http.createServer(app.handler).listen(
 
 ```
 
+Storecraft will search the following `env` variables
+
+```bash
+POSTGRES_USER='admin'
+POSTGRES_PASSWORD='admin'
+POSTGRES_PORT=6432
+POSTGRES_HOST='localhost'
+```
+
+So, you can instantiate with empty config
+```ts
+.withDatabase(
+  new Postgres()
+)
+```
+
+
 ## Testing Locally
 
-1. First setup a `postgres` server
+1. First start a `postgres` server
+First, make sure you have `docker` installed,
+Then, run
 
-```zsh
-docker pull postgres
-docker run --name some-postgres -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admin \
-          -e PGDATA=/var/lib/postgresql/data/pgdata \
-	        -v $(pwd):/var/lib/postgresql/data \
-          -p 5432:5432 -d postgres
+```bash
+npm run database-postgres:docker-compose-up
 ```
 
 2. create Environment
@@ -73,9 +86,9 @@ docker run --name some-postgres -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admi
 create `.env` file with
 
 ```bash
-POSTGRES_USER='user'
-POSTGRES_PASSWORD='password'
-POSTGRES_PORT=5432
+POSTGRES_USER='admin'
+POSTGRES_PASSWORD='admin'
+POSTGRES_PORT=6432
 POSTGRES_HOST='localhost'
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-postgres",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "Official Postgres Database driver for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -29,6 +29,7 @@
     }
   },
   "scripts": {
+    "database-postgres:docker-compose-up": "docker compose -f ./tests/docker-compose.yml up -d ",
     "database-postgres:test": "node ./tests/runner.test.js",
     "test": "npm run database-postgres:test",
     "prepublishOnly": "npm version patch --force"

package/tests/docker-compose.yml

@@ -0,0 +1,23 @@
+services:
+  db:
+    image: postgres
+    container_name: test-postgres
+    restart: always
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    environment:
+      POSTGRES_USER: admin
+      POSTGRES_PASSWORD: admin
+    volumes:
+      - pgdata:/var/lib/postgresql/data 
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready"]
+      interval: 1s
+      timeout: 5s
+      retries: 10
+    ports:
+      - 6432:5432
+
+
+volumes:
+  pgdata:

package/tests/runner.test.js

@@ -11,7 +11,9 @@ export const create_app = async () => {
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
-      auth_secret_refresh_token: 'auth_secret_refresh_token'
+      auth_secret_refresh_token: 'auth_secret_refresh_token',
+      auth_secret_confirm_email_token: 'auth_secret_confirm_email_token',
+      auth_secret_forgot_password_token: 'auth_secret_forgot_password_token',
     }
   )
   .withPlatform(new NodePlatform())