linkam-db 1.0.5 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Link-AM
+
+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.

package/README.md

@@ -1 +1,81 @@
-# linkam-db
+# linkam-db
+
+A database wrapper for `knex` that simplifies database connection and querying. It includes built-in Oracle Instant Client, automatic camelCase conversion of query results, and credential management via `db.ini` configuration. Currently supports Oracle and PostgreSQL databases.
+
+## Features
+
+- Pre-bundled Oracle Instant Client 12.1
+- Automatic credential management via `db.ini`
+- Query result camelCase conversion
+- **PKG executable support** - Works in bundled Node.js executables
+
+## Installation
+
+```bash
+npm install linkam-db
+```
+
+## PKG Compatibility (v1.0.6+)
+
+When your application is bundled into a standalone executable using [`pkg`](https://github.com/yao-pkg/pkg), linkam-db automatically handles Oracle Client DLL extraction.
+
+### How It Works
+
+1. **Detection**: Checks for `process.pkg` environment
+2. **Extraction**: On first run, extracts Oracle Client DLLs from pkg's virtual filesystem to Windows temp directory
+3. **Caching**: DLLs remain in temp for subsequent runs (no extraction delay)
+4. **Loading**: Initializes `oracledb` with the real filesystem path (Windows requirement)
+
+### Why This Is Needed
+
+Windows `LoadLibrary()` API cannot load native DLLs from memory or virtual filesystems. PKG bundles assets into a virtual filesystem that JavaScript can read, but native DLLs must exist as physical files on disk.
+
+### Configuration
+
+No configuration needed! Just include linkam-db's assets in your pkg config:
+
+```json
+{
+  "pkg": {
+    "assets": [
+      "node_modules/linkam-db/instantclient_12_1/**/*",
+      "node_modules/oracledb/build/Release/*.node",
+      "node_modules/linkam-db/db.ini"
+    ]
+  }
+}
+```
+
+### Temp Directory Location
+
+DLLs are extracted to: `%TEMP%\linkam-db-oracle-client\instantclient_12_1`
+
+Example: `C:\Users\username\AppData\Local\Temp\linkam-db-oracle-client\instantclient_12_1`
+
+## Usage
+
+```javascript
+const db = require('linkam-db');
+
+async function example() {
+    const knex = await db.init('myDatabase');
+    
+    // Run raw SQL query
+    const results = await knex.raw('SELECT * FROM my_table WHERE id = ?', [123]);
+    
+    // Results are automatically converted to camelCase
+    console.log(results);
+}
+```
+
+## Database Configuration
+
+Create a `db.ini` file in your project root (copy from `node_modules/linkam-db/db.ini` as template):
+
+```ini
+[myDatabase]
+client = oracledb
+username = your_username
+password = your_password
+connectString = hostname:port/servicename
+```

package/index.js

@@ -5,7 +5,61 @@ const camelcase = require(`./camelcase`)
 const authorize = require(`./authorize`)
 const log = require(`linkam-logs`)
 
-const libDir = path.resolve(__dirname, `instantclient_12_1`)
+// Handle pkg executable - extract Oracle Client to real filesystem
+let libDir
+if (process.pkg) {
+    // When running in pkg, extract DLLs to temp directory
+    // Windows DLL loader can't load from pkg's virtual filesystem
+    const os = require('os')
+    const tempDir = path.join(os.tmpdir(), 'linkam-db-oracle-client', 'instantclient_12_1')
+    
+    // Extract DLLs if not already present
+    if (!fs.existsSync(tempDir)) {
+        log.info('Extracting Oracle Client libraries to temp directory...')
+        fs.mkdirSync(tempDir, { recursive: true })
+        
+        const sourceDir = path.resolve(__dirname, 'instantclient_12_1')
+        const files = fs.readdirSync(sourceDir)
+        
+        files.forEach(file => {
+            const sourcePath = path.join(sourceDir, file)
+            const targetPath = path.join(tempDir, file)
+            
+            const stats = fs.statSync(sourcePath)
+            if (stats.isDirectory()) {
+                // Copy directory recursively
+                copyDirSync(sourcePath, targetPath)
+            } else {
+                fs.copyFileSync(sourcePath, targetPath)
+            }
+        })
+        log.info(`Oracle Client extracted to: ${tempDir}`)
+    }
+    
+    libDir = tempDir
+} else {
+    // Normal execution - use __dirname
+    libDir = path.resolve(__dirname, `instantclient_12_1`)
+}
+
+// Helper function to copy directory recursively
+function copyDirSync(source, target) {
+    if (!fs.existsSync(target)) {
+        fs.mkdirSync(target, { recursive: true })
+    }
+    const files = fs.readdirSync(source)
+    files.forEach(file => {
+        const sourcePath = path.join(source, file)
+        const targetPath = path.join(target, file)
+        const stats = fs.statSync(sourcePath)
+        if (stats.isDirectory()) {
+            copyDirSync(sourcePath, targetPath)
+        } else {
+            fs.copyFileSync(sourcePath, targetPath)
+        }
+    })
+}
+
 oracledb.initOracleClient({ libDir: libDir })
 
 

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "linkam-db",
-  "version": "1.0.5",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Link-AM/linkam-db.git"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/Link-AM/linkam-db/issues"
-  },
-  "homepage": "https://github.com/Link-AM/linkam-db#readme",
-  "dependencies": {
-    "camelcase": "^6.2.0",
-    "knex": "^2.2.0",
-    "linkam-logs": "^1.0.1",
-    "oracledb": "^5.4.0",
-    "properties-reader": "^2.2.0"
-  }
-}
+{
+  "name": "linkam-db",
+  "version": "1.1.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Link-AM/linkam-db.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Link-AM/linkam-db/issues"
+  },
+  "homepage": "https://github.com/Link-AM/linkam-db#readme",
+  "dependencies": {
+    "camelcase": "^6.2.0",
+    "knex": "^2.2.0",
+    "linkam-logs": "^1.0.1",
+    "oracledb": "^5.4.0",
+    "properties-reader": "^2.2.0"
+  }
+}