@samet-digital/be-oracle-common 1.0.2

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2025 Samet Global
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Web: https://sametglobal.com
+Responsible: Mustafa Yelmer (mustafay@samet.com.tr)

package/README.md

@@ -0,0 +1,114 @@
+```
+ ▗▄▖ ▗▄▄▖  ▗▄▖  ▗▄▄▖▗▖   ▗▄▄▄▖     ▗▄▄▖ ▗▄▖ ▗▖  ▗▖▗▖  ▗▖ ▗▄▖ ▗▖  ▗▖
+▐▌ ▐▌▐▌ ▐▌▐▌ ▐▌▐▌   ▐▌   ▐▌       ▐▌   ▐▌ ▐▌▐▛▚▞▜▌▐▛▚▞▜▌▐▌ ▐▌▐▛▚▖▐▌
+▐▌ ▐▌▐▛▀▚▖▐▛▀▜▌▐▌   ▐▌   ▐▛▀▀▘    ▐▌   ▐▌ ▐▌▐▌  ▐▌▐▌  ▐▌▐▌ ▐▌▐▌ ▝▜▌
+▝▚▄▞▘▐▌ ▐▌▐▌ ▐▌▝▚▄▄▖▐▙▄▄▖▐▙▄▄▖    ▝▚▄▄▖▝▚▄▞▘▐▌  ▐▌▐▌  ▐▌▝▚▄▞▘▐▌  ▐▌
+```
+- `EN`: It should be used by another oracle based component, don't use directly!
+- `TR`: Bu bileşeni sadece oracle'a bağlanan başka bir bileşen kullanmalıdır, direkt kullanmayınız.
+
+## Usage
+- `EN`: How to add into your project?
+- `TR`: Projene nasıl eklersin?
+
+```shell
+npm i @samet-digital/be-oracle-common
+```
+
+## Environments
+> @see [Config](./src/config/oracle-common.config.ts)
+>
+| Name                             | Type    | Default                                     | Required |
+|----------------------------------|---------|---------------------------------------------|----------|
+| `ORA_USER`                       | string  | _fake_user_                                 | false    |
+| `ORA_PASS`                       | string  | _fake_pass_                                 | false    |
+| `ORA_HOST`                       | string  | _localhost_                                 | false    |
+| `ORA_PORT`                       | integer | _1521_                                      | false    |
+| `ORA_SID`                        | boolean | _fake_sid_                                  | false    |
+| `ORA_DIR`                        | string  | _C://projects/samet-digital/instant-client_ | false    |
+| `ORA_ACQUIRE_CONNECTION_TIMEOUT` | integer | _10_000_                                    | false    |
+| `ORA_USE_NULL_AS_DEFAULT`        | boolean | _true_                                      | false    |
+| `ORA_POOL_MIN`                   | integer | _2_                                         | false    |
+| `ORA_POOL_MAX`                   | integer | _10_                                        | false    |
+| `ORA_POOL_IDLE_TIMEOUT_MILLIS`   | integer | _60_000_                                    | false    |
+
+## Contents
+- [oracleCommonConfig](./src/config/oracle-common.config.ts) : Oracle connection defaults
+- [oracleClient](./src/client/oracle.client.ts) : Oracle client for connection
+
+## Development
+> You can start to develop on it
+>
+### Step 1
+- `EN`: Go to your project folder
+- `TR`: Bilgisayarında proje klasörüne git
+```shell
+# Windows
+cd C:\\projects\samet-digital
+```
+```shell
+# Mac
+cd /Users/{user}/projects/samet-digital
+```
+
+### Step 2
+- `EN`: Clone the project
+- `TR`: Projeyi bilgisiyarına çek
+```shell
+git clone https://github.com/samet-digital/oracle-common.git -b development
+```
+
+## Dependencies
+- [base-common](https://github.com/samet-digital/base-common) - `samet-digital`
+- [oracledb](https://github.com/oracle/node-oracledb) - `oracle`
+
+## Commands
+```shell
+# Collects all dependencies
+npm i
+
+# Builds project dist (TS -> JS, src -> dist)
+npm run build
+
+# Publishes component on http://npmjs.com/
+npm run publish:public
+
+# Clears `dist` and `coverage` folders
+npm run clear
+
+# Clear `node_modules` folder
+npm run clear:nm
+
+# Validates lint for only errors @see (./eslint.config.mjs) for rules
+npm run lint
+
+# Validates lint with warnings
+npm run lint:verbose
+
+# Runs test cases
+npm run test
+
+# Exports coverage report, @see (./coverage/lcov-report/index.html)
+npm run coverage
+
+# Finds outdated/legacy dependencies
+npm outdated
+```
+
+## Standards
+```diff
++ language: TS 
++ lint: eslint
++ inspections: intelli-j code inspections
++ ddd: domain driven development
++ edd: exception driven development
+! tdd: test driven development
++ ldd: log driven development
++ ddd: document driven development
+```
+
+## History
+| Date       | Developer      | Info         | Ticket         |
+|------------|----------------|--------------|----------------|
+| 2025-08-12 | Mustafa Yelmer | _Created_    | ~~[none](./)~~ |
+| 2025-08-14 | Mustafa Yelmer | _Documented_ | ~~[none](./)~~ |

package/dist/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './oracle.client';
+export * from './index.types';

package/dist/client/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./oracle.client"), exports);
+__exportStar(require("./index.types"), exports);

package/dist/client/index.types.d.ts

@@ -0,0 +1,19 @@
+import oracledb from "oracledb";
+/**
+ * Handles oracle connection
+ * */
+export interface OracleClientLike {
+    /**
+     * Native oracle instance
+     * */
+    readonly native: OracleDb;
+    /**
+     * Initializes oracle instant client
+     * */
+    initialize(libDir: string): void;
+    /**
+     * Is oracle instant client already initialized?
+     * */
+    get isInitialized(): boolean;
+}
+export type OracleDb = typeof oracledb;

package/dist/client/index.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client/oracle.client.d.ts

@@ -0,0 +1,2 @@
+import { OracleClientLike } from "./index.types";
+export declare const oracleClient: OracleClientLike;

package/dist/client/oracle.client.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oracleClient = void 0;
+const oracledb_1 = __importDefault(require("oracledb"));
+/** {@inheritDoc} */
+class OracleClient {
+    constructor() {
+        /** {@inheritDoc} */
+        this.native = oracledb_1.default;
+    }
+    /** {@inheritDoc} */
+    get isInitialized() {
+        return this._initialized;
+    }
+    /** {@inheritDoc} */
+    initialize(libDir) {
+        if (!this._initialized) {
+            this.native.initOracleClient({ libDir });
+        }
+        this._initialized = true;
+    }
+}
+exports.oracleClient = new OracleClient();

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export * from './oracle-common.config';

package/dist/config/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./oracle-common.config"), exports);

package/dist/config/index.types.d.ts

@@ -0,0 +1,37 @@
+import { EnvBase } from "@leyyo/env";
+export type OracleCommonConfKeys = keyof OracleCommonConf;
+export interface OracleCommonConf extends EnvBase {
+    /**
+     * Oracle local client folder
+     * */
+    readonly ORA_DIR: string;
+    /**
+     * DB port number
+     * */
+    readonly ORA_PORT: number;
+    /**
+     * Timeout for acquiring a new connection from pool
+     * */
+    readonly ORA_ACQUIRE_CONNECTION_TIMEOUT: number;
+    /**
+     * Binds values as null in spite of undefined
+     * */
+    readonly ORA_USE_NULL_AS_DEFAULT: boolean;
+    /**
+     * Minimum connections in the pool
+     * */
+    readonly ORA_POOL_MIN: number;
+    /**
+     * Maximum connections in the pool
+     * */
+    readonly ORA_POOL_MAX: number;
+    /**
+     * Idle timeout to clear unused connections in the pool
+     * */
+    readonly ORA_POOL_IDLE_TIMEOUT_MILLIS: number;
+}
+type Rename<P, E extends string> = `${string & E}_${string & P}`;
+export type OracleConf<E extends string> = {
+    readonly [P in keyof OracleCommonConf as Rename<P, E>]: OracleCommonConf[P];
+};
+export {};

package/dist/config/index.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config/oracle-common.config.d.ts

@@ -0,0 +1,2 @@
+import type { OracleCommonConf } from "./index.types";
+export declare const oracleCommonConfig: import("@leyyo/env").EnvPackageLike<OracleCommonConf>;

package/dist/config/oracle-common.config.js

@@ -0,0 +1,65 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oracleCommonConfig = void 0;
+const os = __importStar(require("node:os"));
+const env_1 = require("@leyyo/env");
+const common_1 = require("@leyyo/common");
+const getLibraryFolder = () => {
+    let user;
+    try {
+        user = os.userInfo().username;
+    }
+    catch (_e) {
+        user = 'samet';
+    }
+    switch (process.platform) {
+        case 'win32':
+            return `C://projects/samet-digital/instant-client`;
+        case 'darwin':
+            return `/Users/${user}/projects/samet-digital/instant-client`;
+        default:
+            return `/home/${user}/projects/samet-digital/instant-client`;
+    }
+};
+// noinspection JSUnusedGlobalSymbols
+exports.oracleCommonConfig = env_1.envCore.pck('OracleCommon')
+    .field('ORA_DIR').assert(v => common_1.$assert.text(v, { field: 'ORA_DIR' })).def(getLibraryFolder()).end()
+    .field('ORA_PORT').assert(v => common_1.$assert.positiveIntegerOptional(v, { field: 'ORA_PORT' })).def(1521).end()
+    .field('ORA_ACQUIRE_CONNECTION_TIMEOUT').assert(v => common_1.$assert.positiveIntegerOptional(v, { field: 'ORA_ACQUIRE_CONNECTION_TIMEOUT' })).def(10000).end()
+    .field('ORA_USE_NULL_AS_DEFAULT').assert(v => common_1.$assert.booleanOptional(v, { field: 'ORA_USE_NULL_AS_DEFAULT' })).def(true).end()
+    .field('ORA_POOL_MIN').assert(v => common_1.$assert.positiveIntegerOptional(v, { field: 'ORA_POOL_MIN' })).def(2).end()
+    .field('ORA_POOL_MAX').assert(v => common_1.$assert.positiveIntegerOptional(v, { field: 'ORA_POOL_MAX' })).def(10).end()
+    .field('ORA_POOL_IDLE_TIMEOUT_MILLIS').assert(v => common_1.$assert.nonNegativeIntegerOptional(v, { field: 'ORA_POOL_IDLE_TIMEOUT_MILLIS' })).def(60000).end();

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './client';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
+__exportStar(require("./client"), exports);

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@samet-digital/be-oracle-common",
+  "version": "1.0.2",
+  "description": "Oracle common component",
+  "keywords": [
+    "samet"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/samet-digital/be-oracle-common.git"
+  },
+  "bugs": {
+    "email": "mustafay@samet.com.tr",
+    "url": "https://https://github.com/samet-digital/be-oracle-common/issues"
+  },
+  "homepage": "https://https://github.com/samet-digital/be-oracle-common#readme",
+  "author": {
+    "name": "Mustafa Yelmer",
+    "email": "mustafay@samet.com.tr"
+  },
+  "main": "dist/index.js",
+  "type": "commonjs",
+  "scripts": {
+    "clear": "rimraf dist && rimraf coverage",
+    "clear:nm": "rimraf node_modules && npm run clear",
+    "lint": "eslint src/**/*.ts --quiet",
+    "lint:verbose": "eslint src/**/*.ts",
+    "asset": "node -r ts-node/register commands/assets.ts",
+    "build": "npm run clear && tsc && npm run asset",
+    "test": "jest --config=jest.json --detectOpenHandles",
+    "coverage": "rimraf coverage && jest --config=jest.json --coverage --coverageDirectory=coverage",
+    "sample": "node -r ts-node/register src/sample.ts",
+    "publish:public": "npm run build && npm publish -access=public"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/preset-env": "^7.28.0",
+    "@babel/preset-typescript": "^7.27.1",
+    "@eslint/js": "^9.33.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.2.1",
+    "@types/oracledb": "^6.9.1",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
+    "eslint": "^9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^54.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "test": "^3.3.0",
+    "ts-jest": "^29.4.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.39.1"
+  },
+  "overrides": {
+    "eslint-config-standard": {
+      "eslint": "^9.33.0"
+    }
+  },
+  "dependencies": {
+    "@leyyo/common": "^1.0.10",
+    "@leyyo/env": "^1.0.2",
+    "@samet-digital/base-common": "^1.0.2",
+    "oracledb": "^6.8.0"
+  }
+}