@evenicanpm/portal-db 1.4.0

package/.env.example

@@ -0,0 +1,4 @@
+# Connects to local Strapi PostgreSQL database server
+# Ensure the database server is running and accessible at the specified URL
+# Adjust the credentials and database name as necessary
+DATABASE_URL=postgres://admin:admin@127.0.0.1:5432/strapi?sslmode=disable

package/README.md

@@ -0,0 +1,58 @@
+# e4-Admin-Database-Product
+
+This repository contains the database schema and PostgreSQL migration scripts for the admin panel.
+All database migrations are managed using [Dbmate](https://github.com/amacneil/dbmate), a lightweight, language-agnostic migration tool.
+
+## 🚀 Getting Started
+
+Make sure the following tools are installed:
+
+#### 1. PostgreSQL
+
+#### 2. Dbmate
+
+#### Install Dbmate on Linux (Ubuntu/Debian)
+
+```bash
+# Download the latest Dbmate binary
+curl -fsSL https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64 -o dbmate
+
+# Make it executable
+chmod +x dbmate
+
+# Move to a directory in your PATH
+sudo mv dbmate /usr/local/bin/
+
+# Check version
+dbmate --version
+```
+
+## Migrations
+
+#### 1. Create a new migration
+
+dbmate new <migration_name>
+This will generate a new migration file.
+Add both migrate:up and migrate:down scripts to the file.
+
+#### 2. Run migrations
+
+Make sure DATABASE_URL is added to .env file. Copy over from the .env.example file.
+
+```bash
+# To create the database (if it does not already exist) and run any pending migrations
+dbmate -e "DATABASE_URL" up
+
+# To run any pending migrations
+dbmate -e "DATABASE_URL" migrate
+
+# To roll back the most recent migration
+dbmate -e "DATABASE_URL" rollback or dbmate -e "DATABASE_URL" down
+```
+
+Alternatively, instead of reading DATABASE_URL from .env, you can specify the URL directly.
+Like this:
+
+```bash
+dbmate -u "postgres://username:password@host:port/database_name?sslmode=disable" up
+```

package/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "@evenicanpm/portal-db",
+	"version": "1.4.0",
+	"description": "",
+	"license": "ISC",
+	"author": "",
+	"type": "module",
+	"scripts": {
+		"kysely-codegen": "kysely-codegen",
+		"build": "npx tsc",
+		"format": "npx @biomejs/biome format --write ./src"
+	},
+	"exports": {
+		".": "./src/index.ts"
+	},
+	"types": "./dist/index.d.ts",
+	"devDependencies": {
+		"@types/pg": "^8.16.0",
+		"kysely-codegen": "^0.19.0",
+		"tsx": "^4.21.0",
+		"typedoc": "^0.28.15",
+		"typedoc-github-theme": "^0.3.1",
+		"typescript": "^5.6.3"
+	},
+	"dependencies": {
+		"kysely": "^0.28.10",
+		"pg": "^8.17.2"
+	},
+	"gitHead": "0614726ec6b7ce9564706514a6b756b390a13e96"
+}

package/src/db/db.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was generated by kysely-codegen.
+ * Please do not edit it manually.
+ */
+
+import type { ColumnType } from "kysely";
+
+export type Generated<T> =
+	T extends ColumnType<infer S, infer I, infer U>
+		? ColumnType<S, I | undefined, U>
+		: ColumnType<T, T | undefined, T>;
+
+export type JsonArray = JsonValue[];
+
+export type JsonObject = {
+	[x: string]: JsonValue | undefined;
+};
+
+export type JsonPrimitive = boolean | number | string | null;
+
+export type JsonValue = JsonArray | JsonObject | JsonPrimitive;
+
+export type Timestamp = ColumnType<Date, Date | string, Date | string>;
+
+export interface SchemaMigrations {
+	version: string;
+}
+
+export interface UdaViewconfig {
+	columns: Generated<JsonValue>;
+	createdat: Generated<Timestamp | null>;
+	id: Generated<number>;
+	resource_name: string;
+}
+
+export interface DB {
+	schema_migrations: SchemaMigrations;
+	"uda.viewconfig": UdaViewconfig;
+}

package/src/db/index.ts

@@ -0,0 +1,48 @@
+// packages/uda-billing/src/db.ts
+
+import { Kysely, type PostgresDialect, sql } from "kysely";
+import type { DB, JsonValue } from "./db";
+
+/**
+ *  Portal service for view config db related queries
+ * @param dialect
+ * @returns
+ */
+const createPortalService = (dialect: PostgresDialect) => {
+	const db = new Kysely<DB>({ dialect });
+	return {
+		find: async (input: { resourceKey: string }) => {
+			return await db
+				.selectFrom("uda.viewconfig")
+				.selectAll()
+				.where("resource_name", "=", input?.resourceKey)
+				.executeTakeFirst();
+		},
+		findAll: async () => {
+			return await db
+				.selectFrom("uda.viewconfig")
+				.selectAll()
+				.orderBy("resource_name", "asc")
+				.execute();
+		},
+		upsert: async (input: { resourceKey: string; columns: JsonValue }) => {
+			const columnsJson = JSON.stringify(input.columns);
+			return await db
+				.insertInto("uda.viewconfig")
+				.values({
+					resource_name: input.resourceKey,
+					columns: sql`${columnsJson}::jsonb`,
+				})
+				.onConflict((oc) =>
+					oc.column("resource_name").doUpdateSet({
+						columns: sql`${columnsJson}::jsonb`,
+					}),
+				)
+				.returningAll()
+				.executeTakeFirst();
+		},
+	};
+};
+
+export { createPortalService as portalService };
+export type { DB };

package/src/db/migrations/20260122010359_uda.sql

@@ -0,0 +1,63 @@
+-- migrate:up
+CREATE SCHEMA IF NOT EXISTS uda;
+
+CREATE TABLE uda.viewconfig (
+  id SERIAL PRIMARY KEY,
+  resource_name text NOT NULL UNIQUE,
+  columns jsonb NOT NULL DEFAULT '[]',
+  createdat timestamptz DEFAULT now()
+);
+
+-- Seed Data
+INSERT INTO uda.viewconfig (resource_name, columns)
+VALUES (
+  'invoice',
+  '{
+    "Columns": [
+      {"Label":"Document ID","Data":"id","DataType":"numeric","DisplayOrder":1,"IsSearchable":false,"ColumnOrder":1},
+      {"Label":"Title","Data":"Title","DataType":"String","DisplayOrder":2,"IsSearchable":true,"ColumnOrder":2},
+      {
+      "Label": "Status",
+      "Data": "Status",
+      "DataType": "String",
+      "DisplayOrder": 3,
+      "IsSearchable": false,
+      "ColumnOrder": 3,
+      "IsFilterable": true,
+      "Filters": [
+        {
+          "FilterOptions": [
+            {"value": 2, "label": "Overdue"},
+            {"value": 0, "label": "Paid"},
+            {"value": 1, "label": "Due"}
+          ],
+          "FilterOperation": "eq",
+          "FilterType": "select"
+        }
+      ]
+    },
+      {"Label":"Created Date","Data":"created","DataType":"datetime","DataMask":"MM/DD/YYYY","IsSearchable":false,"DisplayOrder":3,"ColumnOrder":3},
+      {"Label":"Document Type","Data":"document_type","DataType":"String","DisplayOrder":4,"IsSearchable":false,"ColumnOrder":4}
+    ],
+    "Actions": [
+        { "Name": "Download", "Type": "download", "IdField": "id" }
+      ]
+  }'
+);
+
+
+INSERT INTO uda.viewconfig (resource_name, columns)
+VALUES (
+  'statement',
+  '[
+    {"Label": "Statement ID", "Data": "statement_id", "DataType": "numeric", "DisplayOrder": 1, "ColumnOrder": 1},
+    {"Label": "Statement Date", "Data": "statement_date", "DataType": "datetime", "DataMask": "MM/DD/YYYY", "DisplayOrder": 2, "ColumnOrder": 2},
+    {"Label": "Customer Name", "Data": "customer_name", "DataType": "String", "DisplayOrder": 3, "IsSearchable": true, "ColumnOrder": 3},
+    {"Label": "Account Number", "Data": "account_number", "DataType": "String", "DisplayOrder": 4, "ColumnOrder": 4},
+    {"Label": "Balance Due", "Data": "balance_due", "DataType": "currency", "DisplayOrder": 5, "ColumnOrder": 5},
+    {"Label": "Statement Period", "Data": "statement_period", "DataType": "String", "DisplayOrder": 6, "ColumnOrder": 6},
+    {"Label": "Status", "Data": "status", "DataType": "String", "DisplayOrder": 7, "ColumnOrder": 7}
+  ]'
+);
+-- migrate:down
+DROP TABLE IF EXISTS uda.viewconfig;

package/src/index.ts

@@ -0,0 +1 @@
+export { type DB, portalService } from "./db";

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+	"compilerOptions": {
+		"target": "ES6",
+		"useDefineForClassFields": true,
+		"lib": ["ES2022", "DOM", "DOM.Iterable"],
+		"module": "ESNext",
+		"sourceMap": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"declaration": true,
+		"preserveSymlinks": true,
+		"moduleResolution": "node",
+		"resolveJsonModule": true,
+		"isolatedModules": true,
+		"emitDeclarationOnly": true,
+		"jsx": "preserve",
+		"strict": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noFallthroughCasesInSwitch": true,
+		"allowJs": true,
+		"forceConsistentCasingInFileNames": true,
+		"incremental": true,
+		"baseUrl": "./",
+		"outDir": "./dist"
+	},
+	"include": ["src"]
+}