🤖 Merge PR DefinitelyTyped#72060 [@types/oracledb] Add traceHandlerBase class and other types introduced from oracledb@6.7.0 by @sudarshan12s

Author: sudarshan12s

types/oracledb/index.d.ts

@@ -4667,6 +4667,96 @@ declare namespace OracleDB {
     function startup(creds: DBCredentials, opts?: StartupOptions): Promise<void>;
     function startup(creds: DBCredentials, opts: StartupOptions, cb: (err: Error) => void): void;
     function startup(creds: DBCredentials, cb: (err: Error) => void): void;
+
+    /**
+     * Type representing the trace context object.
+     *
+     * @since 6.7.0
+     */
+    type TraceContext = Record<string, any>;
+
+    /**
+     * Base class for handling tracing.
+     *
+     * @since 6.7.0
+     */
+    class TraceHandlerBase {
+        constructor();
+
+        /**
+         * Checks if sending traces is enabled.
+         */
+        isEnabled(): boolean;
+
+        /**
+         * Enables sending traces.
+         */
+        enable(): void;
+
+        /**
+         * Disables sending traces.
+         */
+        disable(): void;
+
+        /**
+         * Called before invoking a public async method.
+         * @param traceContext  input/output trace context object.
+         */
+        onEnterFn(traceContext: TraceContext): void;
+
+        /**
+         * Called after invoking a public async method.
+         * @param traceContext input/output trace context object.
+         */
+        onExitFn(traceContext: TraceContext): void;
+
+        /**
+         * Called when a round trip is begun.
+         * @param traceContext input/output trace context object.
+         */
+        onBeginRoundTrip(traceContext: TraceContext): void;
+
+        /**
+         * Called when a round trip has ended.
+         * @param traceContext input/output trace context object.
+         */
+        onEndRoundTrip(traceContext: TraceContext): void;
+    }
+
+    /*
+     * Assigns a derived object that implements the hooks in the TraceHandlerBase class.
+     * If no argument is provided, it clears the previously assigned instance.
+     *
+     * @since 6.7.0
+     */
+    function setTraceInstance(obj?: TraceHandlerBase): void;
+
+    /*
+     * Retrieves the derived object that implements the hooks in the TraceHandlerBase class.
+     *
+     * @since 6.7.0
+     */
+    function getTraceInstance(): TraceHandlerBase | undefined;
+
+    /*
+     * Verify if Tracing is enabled.
+     *
+     * @since 6.7.0
+     */
+    function isEnabled(): boolean | undefined;
+
+    /**
+     * traceHandler property containing the TraceHandlerBase class.
+     *
+     * @since 6.7.0
+     */
+    interface traceHandler {
+        TraceHandlerBase: typeof TraceHandlerBase;
+        setTraceInstance(obj?: TraceHandlerBase): void;
+        getTraceInstance(): TraceHandlerBase | undefined;
+        isEnabled(): boolean | undefined;
+    }
+    const traceHandler: traceHandler;
 }
 
 export = OracleDB;

types/oracledb/oracledb-tests.ts

@@ -705,6 +705,10 @@ export const version6Tests = async (): Promise<void> => {
 
     console.log(defaultOracledb.DB_TYPE_VECTOR);
     console.log(defaultOracledb.JsonId);
+    console.log(defaultOracledb.traceHandler.TraceHandlerBase);
+    console.log(defaultOracledb.traceHandler.setTraceInstance());
+    console.log(defaultOracledb.traceHandler.getTraceInstance());
+    console.log(defaultOracledb.traceHandler.isEnabled());
 
     // pass random 12 byte value to JsonId which is generated
     // by DB for SODA document.