@storecraft/database-postgres 1.0.1

package/README.md

@@ -0,0 +1,90 @@
+# Storecraft `Postgres` driver
+
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
+Official `Postgres` driver for `StoreCraft` using `pg` package.
+
+```bash
+npm i @storecraft/database-postgres
+```
+
+## usage
+
+```js
+import 'dotenv/config';
+import http from "node:http";
+
+import { App } from '@storecraft/core'
+import { NodePlatform } from '@storecraft/platforms/node';
+import { Postgres } from '@storecraft/database-postgres';
+import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js'
+import { NodeLocalStorage } from '@storecraft/storage-local/node'
+
+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())
+.withDatabase(
+  new Postgres({
+    pool_config: {
+      host: process.env.POSTGRES_HOST,
+      port: parseInt(process.env.POSTGRES_PORT),
+      user: process.env.POSTGRES_USER,
+      password: process.env.POSTGRES_PASSWORD,
+    }
+  })
+)
+.withStorage(new NodeLocalStorage(join(homedir(), 'tomer')))
+
+await app.init();
+await migrateToLatest(app.db, false);
+ 
+const server = http.createServer(app.handler).listen(
+  8000,
+  () => {
+    console.log(`Server is running on http://localhost:8000`);
+  }
+); 
+
+```
+
+## Testing Locally
+
+1. First setup a `postgres` server
+
+```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
+```
+
+2. create Environment
+
+create `.env` file with
+
+```bash
+POSTGRES_USER='user'
+POSTGRES_PASSWORD='password'
+POSTGRES_PORT=5432
+POSTGRES_HOST='localhost'
+```
+
+3. Run `tests/runner.test.js`
+
+```bash
+npm run database-postgres:test
+```
+
+
+```text
+Author: Tomer Shalev <tomer.shalev@gmail.com>
+```

package/index.js

@@ -0,0 +1,30 @@
+import { SQL } from '@storecraft/database-sql-base';
+import { PostgresDialect } from 'kysely';
+import pg from 'pg';
+
+/**
+ * @description `postgres` driver for storecraft using the `pg` driver
+ * 
+ */
+export class Postgres extends SQL {
+
+  /**
+   * 
+   * @param {import('./types.public.d.ts').Config} [config] config 
+   */
+  constructor(config) {
+    super(
+      {
+        dialect_type: 'POSTGRES',
+        dialect: new PostgresDialect(
+          {
+            pool: new pg.Pool(config.pool_config),
+            cursor: config.cursor
+          }
+        ),
+      }
+    );
+
+  }
+
+}

package/migrate.js

@@ -0,0 +1,5 @@
+export { migrateToLatest } from '@storecraft/database-sql-base/migrate.js';
+
+
+
+

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@storecraft/database-postgres",
+  "version": "1.0.1",
+  "description": "Official Postgres Database driver for storecraft",
+  "license": "MIT",
+  "author": "Tomer Shalev (https://github.com/store-craft)",
+  "homepage": "https://github.com/store-craft/storecraft",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/store-craft/storecraft.git",
+    "directory": "packages/databases/database-postgres"
+  },
+  "keywords": [
+    "commerce",
+    "dashboard",
+    "code",
+    "storecraft"
+  ],
+  "type": "module",
+  "main": "index.js",
+  "types": "types.public.d.ts",
+  "scripts": {
+    "database-postgres:test": "node ./tests/runner.test.js",
+    "database-postgres:publish": "npm publish --access public"
+  },
+  "dependencies": {
+    "@storecraft/core": "^1.0.0",
+    "@storecraft/database-sql-base": "^1.0.0",
+    "pg": "^8.11.3"
+  },
+  "devDependencies": {
+    "@storecraft/platforms": "^1.0.0",
+    "@storecraft/test-runner": "^1.0.0",
+    "@types/pg": "^8.11.2",
+    "@types/node": "^20.11.0",
+    "dotenv": "^16.3.1",
+    "uvu": "^0.5.6"
+  }
+}

package/tests/runner.test.js

@@ -0,0 +1,96 @@
+import { App } from '@storecraft/core';
+import { Postgres } from '@storecraft/database-postgres';
+import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js';
+import { NodePlatform } from '@storecraft/platforms/node';
+import  { api_index } from '@storecraft/test-runner'
+
+export const create_app = async () => {
+
+  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())
+  .withDatabase(
+    new Postgres({
+      pool_config: {
+        host: process.env.POSTGRES_HOST,
+        port: parseInt(process.env.POSTGRES_PORT),
+        user: process.env.POSTGRES_USER,
+        password: process.env.POSTGRES_PASSWORD,
+      }
+    })
+  );
+  
+  await app.init();
+  await migrateToLatest(app.db, false);
+
+  return app;
+}
+
+async function test() {
+  const app = await create_app();
+
+  Object.entries(api_index).slice(0, -1).forEach(
+    ([name, runner]) => {
+      runner.create(app).run();
+    }
+  );
+  const last_test = Object.values(api_index).at(-1).create(app);
+  last_test.after(async () => { await app.db.disconnect() });
+  last_test.run();
+}
+
+test();
+
+async function test2() {
+  const app = await create_app();
+
+  api_index.api_auth_test.create(app).run();
+
+  api_index.api_tags_crud_test.create(app).run();
+  api_index.api_tags_list_test.create(app).run();
+
+  api_index.api_collections_crud_test.create(app).run();
+  api_index.api_collections_list_test.create(app).run();
+  api_index.api_collections_products_test.create(app).run();
+
+  api_index.api_products_crud_test.create(app).run();
+  api_index.api_products_collections_test.create(app).run();
+  api_index.api_products_list_test.create(app).run();
+  api_index.api_products_discounts_test.create(app).run();
+  api_index.api_products_variants_test.create(app).run();
+
+  api_index.api_shipping_crud_test.create(app).run();
+  api_index.api_shipping_list_test.create(app).run();
+
+  api_index.api_posts_crud_test.create(app).run();
+  api_index.api_posts_list_test.create(app).run();
+
+  api_index.api_customers_crud_test.create(app).run();
+  api_index.api_customers_list_test.create(app).run();
+
+  api_index.api_orders_crud_test.create(app).run();
+  api_index.api_orders_list_test.create(app).run();
+
+  api_index.api_storefronts_crud_test.create(app).run();
+  api_index.api_storefronts_list_test.create(app).run();
+  api_index.api_storefronts_all_connections_test.create(app).run();
+
+  api_index.api_notifications_crud_test.create(app).run();
+  api_index.api_notifications_list_test.create(app).run();
+
+  api_index.api_images_crud_test.create(app).run();
+  api_index.api_images_list_test.create(app).run();
+
+  api_index.api_discounts_crud_test.create(app).run();
+  api_index.api_discounts_list_test.create(app).run();
+  api_index.api_discounts_products_test.create(app).run();
+
+
+}
+
+// test2();

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "allowJs": true,
+    "maxNodeModuleJsDepth": 10,
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "composite": true,
+  },
+  "include": [
+    "*.js", 
+    "src/*", 
+    "migrations.sqlite/*", 
+    "migrations.postgres/*", 
+    "migrations.mysql/*", 
+    "test/*.js"
+  ]
+}

package/types.public.d.ts

@@ -0,0 +1,33 @@
+import { PostgresCursorConstructor } from 'kysely';
+import { PoolConfig } from 'pg';
+
+export { Postgres } from './index.js';
+
+/**
+ * @description The `postgres` config
+ */
+export type Config = {
+
+  /**
+   * @description A postgres Pool instance or a function that returns one.
+   *
+   * If a function is provided, it's called once when the first query is executed.
+   *
+   * https://node-postgres.com/apis/pool
+   */
+  pool_config: PoolConfig;
+  
+  /**
+   * @description https://github.com/brianc/node-postgres/tree/master/packages/pg-cursor
+   * ```ts
+   * import Cursor from 'pg-cursor'
+   * // or
+   * import * as Cursor from 'pg-cursor'
+   *
+   * new PostgresDialect({
+   *  cursor: Cursor
+   * })
+   * ```
+   */
+  cursor?: PostgresCursorConstructor;  
+}