@syncbridge/sqb 0.4.1

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) 2025 Panates (Panates Teknoloji Yatirim A.S.). All rights reserved.
+
+This software and associated documentation files (the "Software") are
+the proprietary property of Panates and are protected by copyright laws
+and international copyright treaties.
+
+Unauthorized copying, distribution, modification, reverse engineering,
+or use of this software, in whole or in part, is strictly prohibited
+without the express written permission of Panates.
+
+This Software is provided solely for use in accordance with the terms
+of a valid license agreement. Any unauthorized use may result in
+civil and/or criminal penalties.
+
+For licensing inquiries, please contact: info@panates.com

package/README.md

@@ -0,0 +1 @@
+# SyncBridge ICU Connectors

package/components/sqb-client.component.d.ts

@@ -0,0 +1,35 @@
+import '@sqb/oracle';
+import '@sqb/postgres';
+import { SqbClient } from '@sqb/connect';
+import { ComponentBase } from '@syncbridge/common';
+import { SqbClientPoolVariables, SqbClientVariables } from './sqb-client.variables.js';
+/**
+ * SqbClient component
+ */
+export declare class SqbClientComponent<TEvents extends SqbClientComponent.Events = SqbClientComponent.Events> extends ComponentBase<TEvents> {
+    protected _livenessTimer?: NodeJS.Timeout;
+    protected client: SqbClient;
+    values: SqbClientVariables;
+    protected _init(): Promise<void>;
+    protected _start(abortSignal: AbortSignal): Promise<void>;
+    protected _stop(): Promise<void>;
+    protected _terminate(): Promise<void>;
+    getClient(): SqbClient;
+    /**
+     * Test db connection health every 5 secs
+     * @protected
+     */
+    protected _liveness(): void;
+    protected _resetLiveness(): void;
+}
+/**
+ * @namespace
+ */
+export declare namespace SqbClientComponent {
+    interface Events extends ComponentBase.Events {
+    }
+    const Variables: typeof SqbClientVariables;
+    type Variables = SqbClientVariables;
+    const PoolVariables: typeof SqbClientPoolVariables;
+    type PoolVariables = SqbClientPoolVariables;
+}

package/components/sqb-client.component.js

@@ -0,0 +1,129 @@
+import { __decorate, __metadata } from "tslib";
+import '@sqb/oracle';
+import '@sqb/postgres';
+import { clearTimeout } from 'node:timers';
+import { SqbClient, SQBError } from '@sqb/connect';
+import { Component, ComponentBase, ServiceStatus } from '@syncbridge/common';
+import colors from 'ansi-colors';
+import { SqbClientPoolVariables, SqbClientVariables, } from './sqb-client.variables.js';
+/**
+ * SqbClient component
+ */
+let SqbClientComponent = class SqbClientComponent extends ComponentBase {
+    _livenessTimer;
+    async _init() {
+        await super._init();
+        this.client = new SqbClient({
+            dialect: this.values.dialect,
+            host: this.values.host,
+            port: this.values.port,
+            user: this.values.username,
+            password: this.values.password,
+            database: this.values.database,
+            schema: this.values.schema,
+            name: this.values.applicationName,
+            pool: this.values.pool,
+        });
+        this.client.on('error', (err) => {
+            if (err instanceof SQBError && this.logger?.level === 'debug') {
+                const query = err.request?.sql || String(err.query);
+                this.logger.debug(err.message +
+                    `\nSQL: ${colors.whiteBright(query)}\n${err.request?.params
+                        ? 'Params: \n   ' +
+                            Object.entries(err.request.params)
+                                .map(([key, value]) => `${colors.yellow(key)}: ${colors.yellowBright(String(value))}`)
+                                .join(`\n   `)
+                        : ''}`, {
+                    query,
+                    dialect: err.request?.dialect,
+                    params: err.request?.params,
+                });
+            }
+        });
+        this.client.on('acquire', () => {
+            this._resetLiveness();
+        });
+    }
+    async _start(abortSignal) {
+        await super._start(abortSignal);
+        const testConnection = () => {
+            if (!(this.status === ServiceStatus.started ||
+                this.status === ServiceStatus.unhealthy))
+                return;
+            this.logger?.trace(`Testing database connection`);
+            return this.client
+                .test()
+                .then(() => {
+                this.logger?.trace(`Database connection success`);
+                this.setStatus(ServiceStatus.started);
+            })
+                .catch(err => {
+                const timer = setTimeout(testConnection, 5000).unref();
+                abortSignal.addEventListener('abort', () => clearTimeout(timer));
+                const msg = `Database connection failed. ${err.message}`;
+                this.logger?.error(msg);
+                this.setStatus(ServiceStatus.unhealthy, msg);
+            });
+        };
+        await testConnection();
+    }
+    async _stop() {
+        clearTimeout(this._livenessTimer);
+        await this.client.close();
+    }
+    async _terminate() {
+        await this.client.close(0);
+    }
+    getClient() {
+        if (!this.client)
+            throw new Error('SqbClient component is not initialized');
+        return this.client;
+    }
+    /**
+     * Test db connection health every 5 secs
+     * @protected
+     */
+    _liveness() {
+        this.client
+            .test()
+            .then(() => {
+            this.setStatus(ServiceStatus.started);
+        })
+            .catch(err => {
+            if (this.status !== ServiceStatus.unhealthy) {
+                const msg = `Database connection failed. ${err.message}`;
+                this.logger?.error(msg);
+                this.setStatus(ServiceStatus.unhealthy, msg);
+            }
+        })
+            .finally(() => {
+            this._resetLiveness();
+        });
+    }
+    _resetLiveness() {
+        clearTimeout(this._livenessTimer);
+        this._livenessTimer = setTimeout(() => {
+            this._liveness();
+        }, 5000).unref();
+    }
+};
+__decorate([
+    Component.UseVariables(),
+    __metadata("design:type", SqbClientVariables)
+], SqbClientComponent.prototype, "values", void 0);
+SqbClientComponent = __decorate([
+    Component({
+        className: 'SqbClient',
+        displayName: 'SqbClient',
+        description: 'Database Connection Client',
+        tags: ['io', 'stream'],
+    })
+], SqbClientComponent);
+export { SqbClientComponent };
+/**
+ * @namespace
+ */
+(function (SqbClientComponent) {
+    SqbClientComponent.Variables = SqbClientVariables;
+    SqbClientComponent.PoolVariables = SqbClientPoolVariables;
+})(SqbClientComponent || (SqbClientComponent = {}));

package/components/sqb-client.variables.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Pool variables
+ */
+export declare class SqbClientPoolVariables {
+    acquireMaxRetries: number;
+    acquireRetryWait: number;
+    acquireTimeoutMillis: number;
+    fifo: boolean;
+    idleTimeoutMillis: number;
+    houseKeepInterval: number;
+    min: number;
+    minIdle: number;
+    max: number;
+    maxQueue: number;
+}
+/**
+ * Variables
+ */
+export declare class SqbClientVariables {
+    dialect: string;
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    database?: string;
+    schema?: string;
+    applicationName: string;
+    pool: SqbClientPoolVariables;
+}

package/components/sqb-client.variables.js

@@ -0,0 +1,162 @@
+import { __decorate, __metadata } from "tslib";
+import { AdapterRegistry } from '@sqb/connect';
+import { DefineVariable, VariableType } from '@syncbridge/common';
+/**
+ * Pool variables
+ */
+export class SqbClientPoolVariables {
+}
+__decorate([
+    DefineVariable({
+        label: 'Acquire max retries',
+        description: 'Maximum number that Pool will try to create a resource before returning the error',
+        default: 0,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "acquireMaxRetries", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Acquire retry wait',
+        description: 'Time in millis that Pool will wait after each tries',
+        default: 2000,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "acquireRetryWait", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Acquire timeout millis',
+        description: 'Time in millis an acquire call will wait for a resource before timing out',
+        default: 0,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "acquireTimeoutMillis", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Fifo',
+        description: 'If true resources will be allocated first-in-first-out order. resources will be allocated last-in-first-out order',
+        default: true,
+    }),
+    __metadata("design:type", Boolean)
+], SqbClientPoolVariables.prototype, "fifo", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Idle timeout',
+        description: 'The minimum amount of time in millis that an resource may sit idle in the Pool',
+        default: 30000,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "idleTimeoutMillis", void 0);
+__decorate([
+    DefineVariable({
+        label: 'House keep interval',
+        description: 'Time period in millis that Pool will make a cleanup',
+        default: 1000,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "houseKeepInterval", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Min',
+        description: 'Minimum number of resources that Pool will keep',
+        default: 0,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "min", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Min idle',
+        description: 'Minimum number of resources that Pool will keep in idle state',
+        default: 0,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "minIdle", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Max',
+        description: 'Maximum number of resources that Pool will create',
+        default: 30,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "max", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Max queue',
+        description: 'Maximum number of request that Pool will accept',
+        default: 1000,
+    }),
+    __metadata("design:type", Number)
+], SqbClientPoolVariables.prototype, "maxQueue", void 0);
+/**
+ * Variables
+ */
+export class SqbClientVariables {
+}
+__decorate([
+    DefineVariable({
+        type: VariableType.Enum,
+        label: 'Dialect',
+        description: 'Database dialect',
+        enumValues: Array.from(AdapterRegistry.items()).map(x => x.dialect),
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "dialect", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Host',
+        description: 'Database server address or url',
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "host", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Port',
+        description: 'Database listener port number',
+        minValue: 1,
+        maxValue: 65535,
+    }),
+    __metadata("design:type", Number)
+], SqbClientVariables.prototype, "port", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Username',
+        description: 'Database username',
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "username", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Password',
+        description: 'Database password',
+        type: VariableType.Secret,
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "password", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Database name',
+        description: 'Database name to be connected to',
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "database", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Database schema',
+        description: 'Database schema to be connected to',
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "schema", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Application Name',
+        description: 'Name of the application to be set to database sessions. This is used for debugging purposes',
+        default: 'syncbridge',
+    }),
+    __metadata("design:type", String)
+], SqbClientVariables.prototype, "applicationName", void 0);
+__decorate([
+    DefineVariable({
+        label: 'Pooling',
+        description: 'Pooling options',
+    }),
+    __metadata("design:type", SqbClientPoolVariables)
+], SqbClientVariables.prototype, "pool", void 0);

package/components.d.ts

@@ -0,0 +1 @@
+export * from './components/sqb-client.component.js';

package/components.js

@@ -0,0 +1 @@
+export * from './components/sqb-client.component.js';

package/constants.d.ts

@@ -0,0 +1,4 @@
+import { AuthorMetadata } from '@syncbridge/common';
+export declare const version = "1";
+export declare const noOp: () => undefined;
+export declare const panatesAuthor: AuthorMetadata;

package/constants.js

@@ -0,0 +1,7 @@
+export const version = '0.4.1';
+export const noOp = () => undefined;
+export const panatesAuthor = {
+    name: 'Panates Technology AS',
+    email: 'info@panates.com',
+    url: 'https://www.panates.com',
+};

package/index.d.ts

@@ -0,0 +1,5 @@
+import * as components from './components.js';
+export { components };
+export * from './components.js';
+declare const cfg: import("@syncbridge/common").IExtensionPackage;
+export default cfg;

package/index.js

@@ -0,0 +1,9 @@
+import { makeExtensionPackage } from '@syncbridge/common';
+import * as components from './components.js';
+export { components };
+export * from './components.js';
+const cfg = makeExtensionPackage({
+    processors: [],
+    components: Object.values(components),
+});
+export default cfg;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@syncbridge/sqb",
+  "version": "0.4.1",
+  "description": "SyncBridge SQB database connection components",
+  "author": "Panates Inc",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@sqb/connect": "^4.19.6",
+    "@sqb/oracle": "^4.21.1",
+    "@sqb/postgres": "^4.21.1",
+    "ansi-colors": "^4.1.3",
+    "node-events-async": "^1.5.0",
+    "oracledb": "^6.10.0"
+  },
+  "peerDependencies": {
+    "@syncbridge/common": "^0.4.1",
+    "@syncbridge/builtins": "^0.4.1",
+    "@sqb/builder": ">=4.19.6 <5",
+    "@sqb/connect": ">=4.19.6 <5"
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}