@ibm/ibmi-mcp-server 0.1.2 → 0.3.0

package/dist/storage/duckdbExample.js

@@ -1,197 +0,0 @@
-/**
- * @fileoverview Example script to demonstrate usage of the DuckDBService.
- * Creates a sample database, table, inserts data, queries it, and logs results.
- * Database files will be stored in the './duckdata/' directory.
- * @module storage/duckdbExample
- */
-import * as fs from "fs";
-import * as path from "path";
-import { DuckDBService } from "../services/duck-db/duckDBService.js";
-import { JsonRpcErrorCode } from "../types-global/errors.js";
-import { ErrorHandler, idGenerator, // Added idGenerator import
-logger, requestContextService, } from "../utils/index.js";
-const DUCKDB_DATA_DIR = path.resolve(process.cwd(), "duckdata");
-const DUCKDB_FILE_PATH = path.join(DUCKDB_DATA_DIR, "example.db");
-/**
- * Ensures that the directory for storing DuckDB files exists.
- * @param {RequestContext} context - The request context for logging.
- */
-function ensureDataDirectoryExists(context) {
-    if (!fs.existsSync(DUCKDB_DATA_DIR)) {
-        logger.info(context, `Data directory ${DUCKDB_DATA_DIR} does not exist. Creating...`);
-        try {
-            fs.mkdirSync(DUCKDB_DATA_DIR, { recursive: true });
-            logger.info(context, `Data directory ${DUCKDB_DATA_DIR} created.`);
-        }
-        catch (error) {
-            logger.error({
-                error: error,
-                ...context,
-            }, `Failed to create data directory ${DUCKDB_DATA_DIR}`);
-            // Re-throw as a critical error if directory creation fails
-            throw new Error(`Could not create DuckDB data directory: ${error instanceof Error ? error.message : String(error)}`);
-        }
-    }
-    else {
-        logger.debug(context, `Data directory ${DUCKDB_DATA_DIR} already exists.`);
-    }
-    // Ensure a fresh database file for the example by deleting it if it exists.
-    // This allows launchConfig settings like custom_user_agent to be applied on each run.
-    if (fs.existsSync(DUCKDB_FILE_PATH)) {
-        logger.info(context, `Existing DuckDB file ${DUCKDB_FILE_PATH} found. Deleting for a fresh example run...`);
-        try {
-            fs.unlinkSync(DUCKDB_FILE_PATH);
-            logger.info(context, `Successfully deleted ${DUCKDB_FILE_PATH}.`);
-        }
-        catch (error) {
-            logger.error({ error: error, ...context }, `Failed to delete existing DuckDB file ${DUCKDB_FILE_PATH}`);
-            // Re-throw as a critical error if deletion fails, as it will likely cause subsequent errors
-            throw new Error(`Could not delete existing DuckDB file: ${error instanceof Error ? error.message : String(error)}`);
-        }
-    }
-}
-async function runDuckDBExample() {
-    const operation = "runDuckDBExample";
-    const context = requestContextService.createRequestContext({ operation });
-    logger.notice(context, "Starting DuckDB example script...");
-    ensureDataDirectoryExists(context);
-    const service = new DuckDBService();
-    const config = {
-        dbPath: DUCKDB_FILE_PATH,
-        extensions: ["json"], // Example: include an extension
-        launchConfig: { custom_user_agent: "DuckDBExampleScript/1.0" },
-    };
-    try {
-        logger.info(context, `Initializing DuckDBService with path: ${config.dbPath}`);
-        await service.initialize(config);
-        logger.info(context, "DuckDBService initialized.");
-        // Create a table
-        const createTableSql = `
-      CREATE TABLE IF NOT EXISTS users (
-        id VARCHAR(6) PRIMARY KEY,
-        name VARCHAR NOT NULL,
-        email VARCHAR,
-        createdAt TIMESTAMP DEFAULT current_timestamp
-      );
-    `;
-        logger.info({
-            ...context,
-            sql: createTableSql,
-        }, "Creating 'users' table...");
-        await service.run(createTableSql);
-        logger.info(context, "'users' table created or already exists.");
-        // Insert data
-        const usersToInsert = [
-            { name: "Alice Wonderland", email: "alice@example.com" },
-            { name: "Bob The Builder", email: "bob@example.com" },
-            { name: "Charlie Chaplin", email: "charlie@example.com" },
-        ].map((user) => ({
-            id: idGenerator.generateRandomString(6), // Generate 6-digit alphanumeric ID directly
-            ...user,
-        }));
-        logger.info({
-            ...context,
-            users: usersToInsert.length,
-        }, "Inserting data into 'users' table...");
-        for (const user of usersToInsert) {
-            // Check if user already exists to prevent primary key constraint errors on re-runs
-            const existingUser = await service.query("SELECT id FROM users WHERE id = ?", [user.id]);
-            if (existingUser.rowCount === 0) {
-                await service.run("INSERT INTO users (id, name, email) VALUES (?, ?, ?)", [user.id, user.name, user.email]);
-                logger.debug(context, `Inserted user with ID: ${user.id}`);
-            }
-            else {
-                logger.debug(context, `User with ID: ${user.id} already exists. Skipping insertion.`);
-            }
-        }
-        logger.info(context, "Data insertion complete.");
-        // Query data
-        const querySql = "SELECT id, name, email, createdAt FROM users ORDER BY id;";
-        logger.info({ ...context, sql: querySql }, "Querying 'users' table...");
-        const result = await service.query(querySql);
-        logger.notice({
-            ...context,
-            rowCount: result.rowCount,
-            columnNames: result.columnNames,
-        }, "Query Results:");
-        result.rows.forEach((row, index) => {
-            logger.info({ ...context, rowData: row }, `Row ${index + 1}:`);
-        });
-        // Example of using an extension function (json)
-        // Use the ID of the first inserted user for the query
-        if (usersToInsert.length > 0) {
-            const firstUser = usersToInsert[0];
-            if (!firstUser) {
-                logger.warning(context, "Could not get the first user for JSON query example.");
-                return;
-            }
-            const firstUserId = firstUser.id;
-            const jsonQuerySql = "SELECT json_object('id', id, 'name', name, 'email', email) AS user_json FROM users WHERE id = ?;"; // Added email to json_object
-            logger.info({
-                ...context,
-                sql: jsonQuerySql,
-                userId: firstUserId,
-            }, "Querying with JSON extension function for a specific user...");
-            const jsonResult = await service.query(jsonQuerySql, [firstUserId]);
-            if (jsonResult.rowCount > 0) {
-                logger.info({
-                    ...context,
-                    jsonData: jsonResult.rows[0],
-                }, "JSON Query Result:");
-            }
-            else {
-                logger.warning(context, `Could not find user with ID ${firstUserId} for JSON query example.`); // Changed warn to warning
-            }
-        }
-        else {
-            logger.info(context, "Skipping JSON query example as no users were inserted.");
-        }
-    }
-    catch (error) {
-        // ErrorHandler.tryCatch is used within the service, so errors should be McpError
-        // If an error occurs outside service calls (e.g. directory creation), it might be a standard Error
-        logger.error({
-            error: error,
-            ...context,
-            isMcpError: error instanceof Object && "errorCode" in error, // Basic check
-        }, "An error occurred in the DuckDB example script");
-    }
-    finally {
-        logger.info(context, "Closing DuckDBService...");
-        // Wrap close in its own tryCatch as it might also throw
-        try {
-            await service.close();
-            logger.info(context, "DuckDBService closed.");
-        }
-        catch (closeError) {
-            logger.error({
-                error: closeError,
-                ...context,
-            }, "Failed to close DuckDBService");
-        }
-    }
-    logger.notice(context, "DuckDB example script finished.");
-}
-// Self-executing async function
-(async () => {
-    // Setup a global error handler for unhandled rejections or exceptions
-    // specific to this script's execution context.
-    const scriptContext = requestContextService.createRequestContext({
-        operation: "DuckDBExampleScript.main",
-    });
-    try {
-        await ErrorHandler.tryCatch(runDuckDBExample, {
-            operation: "runDuckDBExample.mainExecution",
-            context: scriptContext,
-            errorCode: JsonRpcErrorCode.InternalError, // Changed from SCRIPT_EXECUTION_ERROR
-            critical: true, // If the main example fails, it's critical for the script
-        });
-    }
-    catch (e) {
-        // This catch is for errors that ErrorHandler.tryCatch itself might rethrow
-        // or if ErrorHandler is bypassed.
-        logger.crit({ error: e, ...scriptContext }, "Unhandled critical error in DuckDB example script execution.");
-        process.exit(1); // Exit with error code
-    }
-})();
-//# sourceMappingURL=duckdbExample.js.map

package/dist/storage/duckdbExample.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"duckdbExample.js","sourceRoot":"","sources":["../../src/storage/duckdbExample.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,WAAW,EAAE,2BAA2B;AACxC,MAAM,EAEN,qBAAqB,GACtB,MAAM,kBAAkB,CAAC;AAE1B,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;AAChE,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;AAElE;;;GAGG;AACH,SAAS,yBAAyB,CAAC,OAAuB;IACxD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,CACT,OAAO,EACP,kBAAkB,eAAe,8BAA8B,CAChE,CAAC;QACF,IAAI,CAAC;YACH,EAAE,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,eAAe,WAAW,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV;gBACE,KAAK,EAAE,KAAc;gBACrB,GAAG,OAAO;aACX,EACD,mCAAmC,eAAe,EAAE,CACrD,CAAC;YACF,2DAA2D;YAC3D,MAAM,IAAI,KAAK,CACb,2CAA2C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpG,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,kBAAkB,eAAe,kBAAkB,CAAC,CAAC;IAC7E,CAAC;IAED,4EAA4E;IAC5E,sFAAsF;IACtF,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,CACT,OAAO,EACP,wBAAwB,gBAAgB,6CAA6C,CACtF,CAAC;QACF,IAAI,CAAC;YACH,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,wBAAwB,gBAAgB,GAAG,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CACV,EAAE,KAAK,EAAE,KAAc,EAAE,GAAG,OAAO,EAAE,EACrC,yCAAyC,gBAAgB,EAAE,CAC5D,CAAC;YACF,4FAA4F;YAC5F,MAAM,IAAI,KAAK,CACb,0CAA0C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACnG,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB;IAC7B,MAAM,SAAS,GAAG,kBAAkB,CAAC;IACrC,MAAM,OAAO,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IAE1E,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,mCAAmC,CAAC,CAAC;IAE5D,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEnC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;IACpC,MAAM,MAAM,GAAwB;QAClC,MAAM,EAAE,gBAAgB;QACxB,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,gCAAgC;QACtD,YAAY,EAAE,EAAE,iBAAiB,EAAE,yBAAyB,EAAE;KAC/D,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,CAAC,IAAI,CACT,OAAO,EACP,yCAAyC,MAAM,CAAC,MAAM,EAAE,CACzD,CAAC;QACF,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;QAEnD,iBAAiB;QACjB,MAAM,cAAc,GAAG;;;;;;;KAOtB,CAAC;QACF,MAAM,CAAC,IAAI,CACT;YACE,GAAG,OAAO;YACV,GAAG,EAAE,cAAc;SACpB,EACD,2BAA2B,CAC5B,CAAC;QACF,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,0CAA0C,CAAC,CAAC;QAEjE,cAAc;QACd,MAAM,aAAa,GAAG;YACpB,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,mBAAmB,EAAE;YACxD,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,iBAAiB,EAAE;YACrD,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,qBAAqB,EAAE;SAC1D,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACf,EAAE,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,4CAA4C;YACrF,GAAG,IAAI;SACR,CAAC,CAAC,CAAC;QAEJ,MAAM,CAAC,IAAI,CACT;YACE,GAAG,OAAO;YACV,KAAK,EAAE,aAAa,CAAC,MAAM;SAC5B,EACD,sCAAsC,CACvC,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;YACjC,mFAAmF;YACnF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,KAAK,CACtC,mCAAmC,EACnC,CAAC,IAAI,CAAC,EAAE,CAAC,CACV,CAAC;YACF,IAAI,YAAY,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,OAAO,CAAC,GAAG,CACf,sDAAsD,EACtD,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CACjC,CAAC;gBACF,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,0BAA0B,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CACV,OAAO,EACP,iBAAiB,IAAI,CAAC,EAAE,sCAAsC,CAC/D,CAAC;YACJ,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;QAEjD,aAAa;QACb,MAAM,QAAQ,GACZ,2DAA2D,CAAC;QAC9D,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,2BAA2B,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CACX;YACE,GAAG,OAAO;YACV,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,EACD,gBAAgB,CACjB,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAA4B,EAAE,KAAa,EAAE,EAAE;YAClE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,OAAO,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,gDAAgD;QAChD,sDAAsD;QACtD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;YACnC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,OAAO,CACZ,OAAO,EACP,sDAAsD,CACvD,CAAC;gBACF,OAAO;YACT,CAAC;YACD,MAAM,WAAW,GAAG,SAAS,CAAC,EAAE,CAAC;YACjC,MAAM,YAAY,GAChB,kGAAkG,CAAC,CAAC,6BAA6B;YACnI,MAAM,CAAC,IAAI,CACT;gBACE,GAAG,OAAO;gBACV,GAAG,EAAE,YAAY;gBACjB,MAAM,EAAE,WAAW;aACpB,EACD,8DAA8D,CAC/D,CAAC;YACF,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YACpE,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,CAAC,IAAI,CACT;oBACE,GAAG,OAAO;oBACV,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC7B,EACD,oBAAoB,CACrB,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,OAAO,CACZ,OAAO,EACP,+BAA+B,WAAW,0BAA0B,CACrE,CAAC,CAAC,0BAA0B;YAC/B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CACT,OAAO,EACP,wDAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,iFAAiF;QACjF,mGAAmG;QACnG,MAAM,CAAC,KAAK,CACV;YACE,KAAK,EAAE,KAAc;YACrB,GAAG,OAAO;YACV,UAAU,EAAE,KAAK,YAAY,MAAM,IAAI,WAAW,IAAI,KAAK,EAAE,cAAc;SAC5E,EACD,gDAAgD,CACjD,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;QACjD,wDAAwD;QACxD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,UAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CACV;gBACE,KAAK,EAAE,UAAmB;gBAC1B,GAAG,OAAO;aACX,EACD,+BAA+B,CAChC,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAC;AAC5D,CAAC;AAED,gCAAgC;AAChC,CAAC,KAAK,IAAI,EAAE;IACV,sEAAsE;IACtE,+CAA+C;IAC/C,MAAM,aAAa,GAAG,qBAAqB,CAAC,oBAAoB,CAAC;QAC/D,SAAS,EAAE,0BAA0B;KACtC,CAAC,CAAC;IACH,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,QAAQ,CAAC,gBAAgB,EAAE;YAC5C,SAAS,EAAE,gCAAgC;YAC3C,OAAO,EAAE,aAAa;YACtB,SAAS,EAAE,gBAAgB,CAAC,aAAa,EAAE,sCAAsC;YACjF,QAAQ,EAAE,IAAI,EAAE,0DAA0D;SAC3E,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,2EAA2E;QAC3E,kCAAkC;QAClC,MAAM,CAAC,IAAI,CACT,EAAE,KAAK,EAAE,CAAU,EAAE,GAAG,aAAa,EAAE,EACvC,8DAA8D,CAC/D,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,uBAAuB;IAC1C,CAAC;AACH,CAAC,CAAC,EAAE,CAAC"}