mielk-api 1.0.8 → 1.1.0

package/dist/back/index.d.ts

@@ -1,6 +1 @@
-import type { ApiStatus } from './types/types.js';
-import { PG_ERRORS } from './enums/PostgreErrorCodes.js';
-import { API_STATUS } from './enums/ApiStatus.js';
-export type { ApiStatus };
-export { PG_ERRORS };
-export { API_STATUS };
+export {};

package/dist/back/index.js

@@ -1,4 +1,7 @@
-import { PG_ERRORS } from './enums/PostgreErrorCodes.js';
-import { API_STATUS } from './enums/ApiStatus.js';
-export { PG_ERRORS };
-export { API_STATUS };
+// import type { ApiStatus } from '../http/types/ApiStatus.js';
+// import { PG_ERRORS } from '../db/PostgreErrorCodes.js';
+// import { API_STATUS } from '../http/ApiStatus.js';
+export {};
+// export type { ApiStatus }
+// export { PG_ERRORS }
+// export { API_STATUS }

package/dist/db/pg/connection/pool.d.ts

@@ -0,0 +1,4 @@
+import { Pool } from 'pg';
+import { DbConfig } from '../types/DbConfig.js';
+export declare const initDb: (dbConfig: DbConfig) => void;
+export declare function getPool(): Promise<Pool>;

package/dist/db/pg/connection/pool.js

@@ -0,0 +1,36 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Msg } from '../../../internal/messaging/messageTags.js';
+import { Pool } from 'pg';
+import { openSshTunnel } from './tunnel.js';
+let pool = null;
+let config = null;
+export const initDb = (dbConfig) => {
+    config = Object.assign({ max: 10, min: 0, idleTimeoutMillis: 30000, connectionTimeoutMillis: 10000 }, dbConfig);
+};
+export function getPool() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (pool)
+            return pool;
+        if (config === null)
+            throw new Error(Msg.connection.notInitialized);
+        if (!config.isProd) {
+            if (!config.ssh)
+                throw new Error(Msg.connection.sshOptionsNotSpecified);
+            const port = yield openSshTunnel(config.ssh, config.port);
+            config.port = port;
+        }
+        pool = new Pool(config);
+        pool.on('error', (err) => {
+            console.error(Msg.connection.postgreConnectionError, err);
+        });
+        return pool;
+    });
+}

package/dist/db/pg/connection/tunnel.d.ts

@@ -0,0 +1,2 @@
+import { SshOptions } from 'tunnel-ssh';
+export declare function openSshTunnel(sshOptions: SshOptions, dstPort: number): Promise<number>;

package/dist/db/pg/connection/tunnel.js

@@ -0,0 +1,30 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { createTunnel } from 'tunnel-ssh';
+import { Msg } from '../../../internal/messaging/messageTags.js';
+const tunnelOptions = {
+    autoClose: true,
+    reconnectOnError: true,
+};
+const serverOptions = {};
+export function openSshTunnel(sshOptions, dstPort) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const forwardOptions = { dstPort };
+            const [server] = yield createTunnel(tunnelOptions, serverOptions, sshOptions, forwardOptions);
+            const port = server.address().port;
+            return port;
+        }
+        catch (err) {
+            console.error(Msg.connection.sshTunnelFailed, err);
+            throw err;
+        }
+    });
+}

package/dist/db/pg/index.d.ts

@@ -0,0 +1,6 @@
+import { POSTGRE_ERRORS } from './static/PostgreErrorCodes.js';
+import { initDb, getPool } from './connection/pool.js';
+import type { DbConfig } from './types/DbConfig.js';
+export { POSTGRE_ERRORS };
+export { initDb, getPool };
+export type { DbConfig };

package/dist/db/pg/index.js

@@ -0,0 +1,4 @@
+import { POSTGRE_ERRORS } from './static/PostgreErrorCodes.js';
+import { initDb, getPool } from './connection/pool.js';
+export { POSTGRE_ERRORS };
+export { initDb, getPool };

package/dist/{back/enums → db/pg/static}/PostgreErrorCodes.d.ts

@@ -1,4 +1,4 @@
-export declare const PG_ERRORS: {
+export declare const POSTGRE_ERRORS: {
     UNIQUE_VIOLATION: string;
     FOREIGN_KEY_VIOLATION: string;
 };

package/dist/{back/enums → db/pg/static}/PostgreErrorCodes.js

@@ -1,4 +1,4 @@
-export const PG_ERRORS = {
+export const POSTGRE_ERRORS = {
     UNIQUE_VIOLATION: '23505',
     FOREIGN_KEY_VIOLATION: '23503',
 };

package/dist/db/pg/types/DbConfig.d.ts

@@ -0,0 +1,14 @@
+import { SshOptions } from "tunnel-ssh";
+export interface DbConfig {
+    isProd: boolean;
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    database: string;
+    ssh?: SshOptions;
+    max?: number;
+    min?: number;
+    idleTimeoutMillis?: number;
+    connectionTimeoutMillis?: number;
+}

package/dist/{back/enums → http}/ApiStatus.d.ts

@@ -1,4 +1,4 @@
-import { ApiStatus } from "../types/types.js";
+import { ApiStatus } from "./types/ApiStatus.js";
 export declare const API_STATUS: {
     OK: ApiStatus;
     CREATED: ApiStatus;

package/dist/{back/enums → http}/ApiStatus.js

@@ -1,6 +1,6 @@
-import { Msg } from "../../internal/messaging/messageTags.js";
+import { Msg } from "../internal/messaging/messageTags.js";
 const createApiStatus = (success, code, defaultMessageTag) => ({ success, code, defaultMessageTag });
-const msg = Msg.ApiStatus;
+const msg = Msg.apiStatus;
 export const API_STATUS = {
     OK: createApiStatus(true, 200, msg.ok),
     CREATED: createApiStatus(true, 201, msg.created),

package/dist/http/index.d.ts

@@ -0,0 +1,7 @@
+import { ApiSuccess, ApiError, ApiErrorDetails } from '../http/types/ApiResponse.js';
+import type { ApiResponse } from '../http/types/ApiResponse.js';
+import type { ApiStatus } from './types/ApiStatus.js';
+import { API_STATUS } from './ApiStatus.js';
+export type { ApiStatus, ApiResponse };
+export { ApiError, ApiSuccess, ApiErrorDetails };
+export { API_STATUS };

package/dist/http/index.js

@@ -0,0 +1,2 @@
+import { API_STATUS } from './ApiStatus.js';
+export { API_STATUS };

package/dist/http/types/ApiResponse.d.ts

@@ -0,0 +1,14 @@
+export interface ApiSuccess<T> {
+    success: true;
+    data: T;
+}
+export interface ApiError {
+    success: false;
+    message: string;
+    params?: Record<string, string | number | Date | unknown | boolean>;
+}
+export interface ApiErrorDetails {
+    message: string;
+    params?: Record<string, string | number | Date | unknown | boolean>;
+}
+export type ApiResponse<T> = ApiSuccess<T> | ApiError;

package/dist/http/types/ApiResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/http/types/ApiStatus.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export * as back from './back/index.js';
-export * as front from './front/index.js';
+export * as pg from './db/pg/index.js';
+export * as mssql from './db/mssql/index.js';
+export * as http from './http/index.js';

package/dist/index.js

@@ -1,2 +1,3 @@
-export * as back from './back/index.js';
-export * as front from './front/index.js';
+export * as pg from './db/pg/index.js';
+export * as mssql from './db/mssql/index.js';
+export * as http from './http/index.js';

package/dist/internal/messaging/messageTags.d.ts

@@ -1,5 +1,5 @@
 export declare const Msg: {
-    ApiStatus: {
+    apiStatus: {
         ok: string;
         created: string;
         unauthorized: string;
@@ -8,4 +8,11 @@ export declare const Msg: {
         conflict: string;
         serverError: string;
     };
+    connection: {
+        notInitialized: string;
+        sshOptionsNotSpecified: string;
+        sshTunnelFailed: string;
+        postgreConnectionError: string;
+        unauthorizedRequest: string;
+    };
 };

package/dist/internal/messaging/messageTags.js

@@ -1,13 +1,21 @@
 const PARENT_FOLDER = 'api/';
-const API_STATUS_FOLDER = `${PARENT_FOLDER}/ApiStatus`;
+const ___API_STATUS___ = `${PARENT_FOLDER}/ApiStatus`;
+const ___CONNECTION___ = `${PARENT_FOLDER}/Connection`;
 export const Msg = {
-    ApiStatus: {
-        ok: `${API_STATUS_FOLDER}:ok`,
-        created: `${API_STATUS_FOLDER}:created`,
-        unauthorized: `${API_STATUS_FOLDER}:unauthorized`,
-        badRequest: `${API_STATUS_FOLDER}:badRequest`,
-        notFound: `${API_STATUS_FOLDER}:notFound`,
-        conflict: `${API_STATUS_FOLDER}:conflict`,
-        serverError: `${API_STATUS_FOLDER}:serverError`,
+    apiStatus: {
+        ok: `${___API_STATUS___}:ok`,
+        created: `${___API_STATUS___}:created`,
+        unauthorized: `${___API_STATUS___}:unauthorized`,
+        badRequest: `${___API_STATUS___}:badRequest`,
+        notFound: `${___API_STATUS___}:notFound`,
+        conflict: `${___API_STATUS___}:conflict`,
+        serverError: `${___API_STATUS___}:serverError`,
+    },
+    connection: {
+        notInitialized: `${___CONNECTION___}:notInitialized`,
+        sshOptionsNotSpecified: `${___CONNECTION___}:sshOptionsNotSpecified`,
+        sshTunnelFailed: `${___CONNECTION___}:sshTunnelFailed`, // ❌ SSH tunnel failed
+        postgreConnectionError: `${___CONNECTION___}:postgreConnectionError`, // Unexpected PostgreSQL error
+        unauthorizedRequest: `${___CONNECTION___}:unauthorizedRequest`
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mielk-api",
-	"version": "1.0.8",
+	"version": "1.1.0",
 	"keywords": [],
 	"author": "mielk",
 	"description": "Wrapper for API operations",
@@ -13,15 +13,20 @@
 			"import": "./dist/index.js",
 			"default": "./dist/index.js"
 		},
-		"./back": {
-			"types": "./dist/back/index.d.ts",
-			"import": "./dist/back/index.js",
-			"default": "./dist/back/index.js"
+		"./db-mssql": {
+			"types": "./dist/db/mssql/index.d.ts",
+			"import": "./dist/db/mssql/index.js",
+			"default": "./dist/db/mssql/index.js"
 		},
-		"./front": {
-			"types": "./dist/front/index.d.ts",
-			"import": "./dist/front/index.js",
-			"default": "./dist/front/index.js"
+		"./db-pg": {
+			"types": "./dist/db/pg/index.d.ts",
+			"import": "./dist/db/pg/index.js",
+			"default": "./dist/db/pg/index.js"
+		},
+		"./http": {
+			"types": "./dist/http/index.d.ts",
+			"import": "./dist/http/index.js",
+			"default": "./dist/http/index.js"
 		}
 	},
 	"scripts": {
@@ -44,6 +49,8 @@
 		"@babel/preset-env": "^7.25.8",
 		"@types/jest": "^30.0.0",
 		"@types/node": "^22.7.5",
+		"@types/pg": "^8.18.0",
+		"@types/tunnel-ssh": "^5.0.4",
 		"babel-jest": "^29.7.0",
 		"jest": "^30.3.0",
 		"jest-html-reporters": "^3.1.7",
@@ -56,6 +63,8 @@
 		"dist"
 	],
 	"dependencies": {
-		"mielk-fn": "^1.1.1"
+		"mielk-fn": "^1.1.1",
+		"pg": "^8.20.0",
+		"tunnel-ssh": "^5.2.0"
 	}
 }

package/dist/front/index.d.ts

@@ -1,4 +0,0 @@
-import { ApiSuccess, ApiError } from './types.js';
-import type { ApiResponse, ApiErrorDetails } from './types.js';
-export { ApiError, ApiSuccess };
-export type { ApiResponse, ApiErrorDetails };

package/dist/front/types.d.ts

@@ -1,13 +0,0 @@
-export interface ApiSuccess<T> {
-    success: true;
-    data: T;
-}
-export interface ApiError {
-    success: false;
-    details: ApiErrorDetails;
-}
-export type ApiResponse<T> = ApiSuccess<T> | ApiError;
-export type ApiErrorDetails = {
-    message: string;
-    params?: (string | number | Date | unknown | boolean)[];
-};