@sourceregistry/node-ovsdb 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,124 @@
+# @sourceregistry/node-ovsdb
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Release to NPM](https://github.com/SourceRegistry/node-ovsdb/actions/workflows/publish-npm.yml/badge.svg)](https://github.com/SourceRegistry/node-ovsdb/actions/workflows/publish-npm.yml)
+
+A lightweight, typesafe TypeScript client for the Open vSwitch Database (OVSDB) Management Protocol, as defined in [RFC 7047](https://datatracker.ietf.org/doc/html/rfc7047).
+
+This library provides a low-level wrapper to interact with the OVSDB over a Unix socket, enabling programmatic configuration and management of Open vSwitch instances.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @sourceregistry/node-ovsdb
+```
+
+## Usage
+
+### Getting Started
+
+The primary class is `OVSDBClient`, which handles the connection to the OVSDB server (typically located at `/var/run/openvswitch/db.sock`).
+
+```typescript
+import { OVSDBClient } from '@sourceregistry/node-ovsdb';
+
+async function main() {
+  // Create a new client instance
+  const client = new OVSDBClient();
+
+  try {
+    // Connect to the OVSDB Unix socket
+    await client.connect();
+    console.log('Connected to OVSDB');
+
+    // Example: Get the list of available databases
+    const databases = await client.listDbs();
+    console.log('Databases:', databases);
+
+    // Example: Get the schema of the 'Open_vSwitch' database
+    const schema = await client.getSchema('Open_vSwitch');
+    console.log('OVS Version:', schema.version);
+
+    // Example: Perform a transaction to select all bridges
+    const operations = [
+      {
+        op: 'select',
+        table: 'Bridge',
+        where: [],
+        columns: ['name']
+      }
+    ];
+
+    const result = await client.transact('Open_vSwitch', operations);
+    console.log('Bridges:', result);
+
+  } catch (error) {
+    console.error('An error occurred:', error.message);
+  } finally {
+    // Always close the connection
+    client.close();
+  }
+}
+
+main();
+```
+
+### Using Async Disposable (Recommended)
+
+For guaranteed resource cleanup, use the client with the `using` statement (requires Node.js 18+ or the `--harmony-explicit-resource-management` flag):
+
+```typescript
+import { OVSDBClient } from '@sourceregistry/node-ovsdb';
+
+async function main() {
+  // The 'using' statement ensures the client is closed even if an error occurs
+  using client = new OVSDBClient();
+
+  await client.connect();
+  console.log('Connected to OVSDB');
+
+  const dbs = await client.listDbs();
+  console.log('Available databases:', dbs);
+}
+
+main();
+```
+
+### Core Methods
+
+The `OVSDBClient` class provides direct access to the core OVSDB RPC methods:
+
+- `connect()`: Establishes a connection to the Unix socket.
+- `listDbs()`: Retrieves the names of available databases.
+- `getSchema(dbName)`: Retrieves the schema for a specific database.
+- `transact(dbName, operations)`: Executes a series of database operations atomically.
+- `monitor(...)`: Subscribes to database change notifications.
+- `echo()`: Tests the connection liveness.
+- `close()`: Closes the connection.
+
+### Advanced: Entity Wrappers (Coming Soon)
+
+For higher-level operations (e.g., `createBridge`, `addPort`), consider building wrapper classes on top of `OVSDBClient`. A future version of this library may include these.
+
+## Development
+
+### Prerequisites
+
+- Node.js (v18 or higher recommended)
+
+### Scripts
+
+- `npm run dev`: Start the development server.
+- `npm run build`: Compile the TypeScript code and generate the distribution files in the `dist/` directory.
+- `npm run preview`: Preview the built application.
+- `npm run test`: Run the test suite with Vitest.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+## License
+
+This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for details.

package/dist/index.cjs.js

@@ -0,0 +1,4 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("net"),u=require("fs");class l{constructor(e={}){this.socket=null,this.requestId=1,this.pendingRequests=new Map,this.isConnected=!1,this.socketPath=e.socketPath||"/var/run/openvswitch/db.sock",this.timeout=e.timeout||5e3}connect(){return new Promise((e,r)=>{if(this.isConnected){e(this);return}if(!u.existsSync(this.socketPath)){r(new Error(`OVSDB socket not found: ${this.socketPath}`));return}this.socket=a.createConnection(this.socketPath);const t=setTimeout(()=>{this._cleanup(),r(new Error(`Connection timeout after ${this.timeout}ms`))},this.timeout);this.socket.on("connect",()=>{clearTimeout(t),this.isConnected=!0,e(this)}),this.socket.on("error",o=>{clearTimeout(t),this._cleanup(),r(o)}),this.socket.on("close",()=>{this._cleanup()}),this.socket.on("data",o=>{this._handleData(o)})})}request(e,r){return new Promise((t,o)=>{if(!this.isConnected){o(new Error("Not connected to OVSDB"));return}const s=this.requestId++,c=JSON.stringify({method:e,params:r,id:s})+`
+`,n=setTimeout(()=>{this.pendingRequests.delete(s),o(new Error(`Request timeout for method: ${e}`))},this.timeout);this.pendingRequests.set(s,{resolve:t,reject:o,timeoutId:n}),this.socket.write(c,i=>{i&&(clearTimeout(n),this.pendingRequests.delete(s),o(i))})})}async listDbs(){const e=await this.request("list_dbs",[]);if("error"in e&&e.error!==null)throw new Error(`RPC Error: ${e.error}`);const r=e.result;if("error"in r)throw new Error(`OVSDB Error: ${r.error}`);return r}async getSchema(e="Open_vSwitch"){const r=await this.request("get_schema",[e]);if("error"in r&&r.error!==null)throw new Error(`RPC Error: ${r.error}`);const t=r.result;if("error"in t)throw new Error(`OVSDB Error: ${t.error}`);return t}async transact(e,r){const t=await this.request("transact",[e,...r]);if("error"in t&&t.error!==null)throw new Error(`RPC Error: ${t.error}`);return t.result}async monitor(e,r,t){const o=await this.request("monitor",[e,r,t]);if("error"in o&&o.error!==null)throw new Error(`RPC Error: ${o.error}`);const s=o.result;if("error"in s)throw new Error(`OVSDB Error: ${s.error}`);return s}async monitorCancel(e){const r=await this.request("monitor_cancel",[e]);if("error"in r&&r.error!==null)throw new Error(`RPC Error: ${r.error}`);const t=r.result;if("error"in t)throw new Error(`OVSDB Error: ${t.error}`);return t}async echo(e="ping"){const r=await this.request("echo",Array.isArray(e)?e:[e]);if("error"in r&&r.error!==null)throw new Error(`RPC Error: ${r.error}`);const t=r.result;if("error"in t)throw new Error(`OVSDB Error: ${t.error}`);return t}async close(){await this[Symbol.asyncDispose]()}async[Symbol.asyncDispose](){if(this.isConnected){const e=new Promise(r=>{if(this.socket){if(this.socket.destroyed||this.socket.readyState==="closed"){r();return}this.socket.once("close",()=>{r()})}else r()});this._cleanup(),await e}}_cleanup(){this.isConnected=!1,this.socket&&(this.socket.destroy(),this.socket=null),this.pendingRequests.forEach(({reject:e,timeoutId:r})=>{clearTimeout(r),e(new Error("Connection closed"))}),this.pendingRequests.clear()}_handleData(e){e.toString().trim().split(`
+`).forEach(t=>{if(t)try{const o=JSON.parse(t);this._handleResponse(o)}catch(o){console.error("Failed to parse JSON:",o)}})}_handleResponse(e){if(typeof e!="object"||e===null||!("id"in e)){console.error("Invalid response format:",e);return}const r=e.id,t=this.pendingRequests.get(r);if(!t){this._handleNotification(e);return}this.pendingRequests.delete(r),clearTimeout(t.timeoutId),"error"in e&&e.error!==null?t.reject(new Error(`RPC Error: ${e.error}`)):t.resolve(e)}_handleNotification(e){if(typeof e!="object"||e===null||!("method"in e)){console.error("Invalid notification format:",e);return}const r=e.method;switch(r){case"update":console.log("Received update notification:",e.params[0]);break;case"locked":console.log("Received locked notification:",e.params[0]);break;case"stolen":console.log("Received stolen notification:",e.params[0]);break;default:console.log("Received notification:",r)}}}exports.OVSDBClient=l;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/index.ts"],"sourcesContent":["import {createConnection, Socket} from \"net\";\nimport {existsSync} from \"fs\";\n\nimport {\n    DatabaseOperation,\n    DatabaseSchema, EchoResponse,\n    GetSchemaResponse,\n    JsonValue,\n    ListDbsResponse, LockedNotification, MonitorCancelResponse, MonitorConfig, MonitorResponse, OvsdbResponse,\n    OvsdbResult, StolenNotification, TableUpdate,\n    TransactResponse, UpdateNotification\n} from \"./types\";\n\n/**\n * Options for configuring the OVSDBClient.\n */\nexport interface OvsdbClientOptions {\n    socketPath?: string;\n    timeout?: number;\n}\n\n/**\n * A lightweight, typesafe client for interacting with the OVSDB over a Unix socket.\n * Implements the AsyncDisposable interface for resource management.\n * No extra functionality should be added to this client than only interact with the low-level database functions of ovs\n */\nexport class OVSDBClient implements AsyncDisposable {\n    private readonly socketPath: string;\n    private readonly timeout: number;\n    private socket: Socket | null = null;\n    private requestId = 1;\n    private pendingRequests = new Map<number, {\n        resolve: (value: any) => void;\n        reject: (reason?: any) => void;\n        timeoutId: NodeJS.Timeout;\n    }>();\n    private isConnected = false;\n\n    /**\n     * Creates a new OVSDBClient instance.\n     * @param options - Configuration options for the client.\n     */\n    constructor(options: OvsdbClientOptions = {}) {\n        this.socketPath = options.socketPath || '/var/run/openvswitch/db.sock';\n        this.timeout = options.timeout || 5000;\n    }\n\n    /**\n     * Connects to the OVSDB Unix socket.\n     * @returns A promise that resolves when connected.\n     * @throws An error if the socket file does not exist or the connection fails.\n     */\n    public connect(): Promise<this> {\n        return new Promise((resolve, reject) => {\n            if (this.isConnected) {\n                resolve(this);\n                return;\n            }\n\n            if (!existsSync(this.socketPath)) {\n                reject(new Error(`OVSDB socket not found: ${this.socketPath}`));\n                return;\n            }\n\n            this.socket = createConnection(this.socketPath);\n\n            const timeoutId = setTimeout(() => {\n                this._cleanup();\n                reject(new Error(`Connection timeout after ${this.timeout}ms`));\n            }, this.timeout);\n\n            this.socket.on('connect', () => {\n                clearTimeout(timeoutId);\n                this.isConnected = true;\n                resolve(this);\n            });\n\n            this.socket.on('error', (err) => {\n                clearTimeout(timeoutId);\n                this._cleanup();\n                reject(err);\n            });\n\n            this.socket.on('close', () => {\n                this._cleanup();\n            });\n\n            this.socket.on('data', (data) => {\n                this._handleData(data);\n            });\n        });\n    }\n\n    /**\n     * Sends a JSON-RPC request to the OVSDB server.\n     * @param method - The RPC method name.\n     * @param params - The parameters for the RPC method.\n     * @returns A promise that resolves with the result.\n     * @throws An error if not connected, if the request times out, or if there is a network error.\n     */\n    public request<T>(method: string, params: JsonValue[]): Promise<T> {\n        return new Promise((resolve, reject) => {\n            if (!this.isConnected) {\n                reject(new Error('Not connected to OVSDB'));\n                return;\n            }\n\n            const id = this.requestId++;\n            const request = JSON.stringify({\n                method,\n                params,\n                id\n            }) + '\\n';\n\n            const timeoutId = setTimeout(() => {\n                this.pendingRequests.delete(id);\n                reject(new Error(`Request timeout for method: ${method}`));\n            }, this.timeout);\n\n            this.pendingRequests.set(id, {resolve, reject, timeoutId});\n\n            this.socket!.write(request, (err) => {\n                if (err) {\n                    clearTimeout(timeoutId);\n                    this.pendingRequests.delete(id);\n                    reject(err);\n                }\n            });\n        });\n    }\n\n    // --- Core OVSDB RPC Methods (Fixed to handle the response structure) ---\n\n    public async listDbs(): Promise<string[]> {\n        const response = await this.request<ListDbsResponse>('list_dbs', []);\n        // Check if the response is an error object\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        // Check if the OvsdbResult itself is an error\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async getSchema(dbName: string = 'Open_vSwitch'): Promise<DatabaseSchema> {\n        const response = await this.request<GetSchemaResponse>('get_schema', [dbName]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async transact(dbName: string, operations: DatabaseOperation[]): Promise<Array<OvsdbResult<unknown>>> {\n        const response = await this.request<TransactResponse>('transact', [dbName, ...operations]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        return response.result as Array<OvsdbResult<unknown>>;\n        // Note: The result here is already an array of OvsdbResult<unknown>.\n        // The caller is responsible for checking each element for errors.\n    }\n\n    public async monitor(dbName: string, monitorId: JsonValue, monitorRequests: Record<string, MonitorConfig[]>): Promise<Record<string, TableUpdate>> {\n        const response = await this.request<MonitorResponse>('monitor', [dbName, monitorId, monitorRequests as JsonValue]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async monitorCancel(monitorId: JsonValue): Promise<Record<string, never>> {\n        const response = await this.request<MonitorCancelResponse>('monitor_cancel', [monitorId]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async echo(payload: JsonValue = 'ping'): Promise<JsonValue[]> {\n        const response = await this.request<EchoResponse>('echo', Array.isArray(payload) ? payload : [payload]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    /**\n     * Closes the connection to the OVSDB server.\n     * @returns A promise that resolves when the connection is closed.\n     */\n    public async close(): Promise<void> {\n        await this[Symbol.asyncDispose]();\n    }\n\n    /**\n     * Implements the AsyncDisposable interface for use with 'using' statements.\n     * This method is called automatically when exiting a 'using' block.\n     * @returns A promise that resolves when cleanup is complete.\n     */\n    public async [Symbol.asyncDispose](): Promise<void> {\n        if (this.isConnected) {\n            const closePromise = new Promise<void>((resolve) => {\n                if (this.socket) {\n                    if (this.socket.destroyed || this.socket.readyState === 'closed') {\n                        resolve();\n                        return;\n                    }\n                    this.socket.once('close', () => {\n                        resolve();\n                    });\n                } else {\n                    resolve();\n                }\n            });\n\n            this._cleanup();\n            await closePromise;\n        }\n    }\n\n    /**\n     * Cleans up the connection and pending requests.\n     * @private\n     */\n    private _cleanup(): void {\n        this.isConnected = false;\n        if (this.socket) {\n            this.socket.destroy();\n            this.socket = null;\n        }\n        this.pendingRequests.forEach(({reject, timeoutId}) => {\n            clearTimeout(timeoutId);\n            reject(new Error('Connection closed'));\n        });\n        this.pendingRequests.clear();\n    }\n\n    /**\n     * Handles incoming data from the socket.\n     * @private\n     * @param data - The raw data received.\n     */\n    private _handleData(data: Buffer): void {\n        const messages = data.toString().trim().split('\\n');\n        messages.forEach(message => {\n            if (!message) return;\n            try {\n                const response = JSON.parse(message);\n                this._handleResponse(response);\n            } catch (err) {\n                console.error('Failed to parse JSON:', err);\n            }\n        });\n    }\n\n    /**\n     * Handles a parsed JSON-RPC response.\n     * @private\n     * @param response - The JSON-RPC response object.\n     */\n    private _handleResponse(response: JsonValue): void {\n        if (typeof response !== 'object' || response === null || !('id' in response)) {\n            console.error('Invalid response format:', response);\n            return;\n        }\n\n        const id = response.id as number;\n        const request = this.pendingRequests.get(id);\n\n        if (!request) {\n            // This is a notification (e.g., \"update\", \"locked\", \"stolen\")\n            this._handleNotification(response);\n            return;\n        }\n\n        this.pendingRequests.delete(id);\n        clearTimeout(request.timeoutId);\n\n        if ('error' in response && response.error !== null) {\n            request.reject(new Error(`RPC Error: ${response.error}`));\n        } else {\n            request.resolve((response as unknown as OvsdbResponse));\n        }\n    }\n\n    /**\n     * Handles JSON-RPC notifications (e.g., \"update\", \"locked\", \"stolen\").\n     * This can be overridden by subclasses or event listeners.\n     * @private\n     * @param notification - The notification object.\n     */\n    private _handleNotification(notification: JsonValue): void {\n        if (typeof notification !== 'object' || notification === null || !('method' in notification)) {\n            console.error('Invalid notification format:', notification);\n            return;\n        }\n\n        const method = (notification as { method: string }).method;\n\n        switch (method) {\n            case 'update':\n                console.log('Received update notification:', (notification as UpdateNotification).params[0]);\n                break;\n            case 'locked':\n                console.log('Received locked notification:', (notification as LockedNotification).params[0]);\n                break;\n            case 'stolen':\n                console.log('Received stolen notification:', (notification as StolenNotification).params[0]);\n                break;\n            default:\n                console.log('Received notification:', method);\n        }\n    }\n}\n\nexport * from \"./types\"\n"],"names":["OVSDBClient","options","resolve","reject","existsSync","createConnection","timeoutId","err","data","method","params","id","request","response","result","dbName","operations","monitorId","monitorRequests","payload","closePromise","message","notification"],"mappings":"uHA0BO,MAAMA,CAAuC,CAgBhD,YAAYC,EAA8B,GAAI,CAb9C,KAAQ,OAAwB,KAChC,KAAQ,UAAY,EACpB,KAAQ,oBAAsB,IAK9B,KAAQ,YAAc,GAOlB,KAAK,WAAaA,EAAQ,YAAc,+BACxC,KAAK,QAAUA,EAAQ,SAAW,GACtC,CAOO,SAAyB,CAC5B,OAAO,IAAI,QAAQ,CAACC,EAASC,IAAW,CACpC,GAAI,KAAK,YAAa,CAClBD,EAAQ,IAAI,EACZ,MACJ,CAEA,GAAI,CAACE,EAAAA,WAAW,KAAK,UAAU,EAAG,CAC9BD,EAAO,IAAI,MAAM,2BAA2B,KAAK,UAAU,EAAE,CAAC,EAC9D,MACJ,CAEA,KAAK,OAASE,mBAAiB,KAAK,UAAU,EAE9C,MAAMC,EAAY,WAAW,IAAM,CAC/B,KAAK,SAAA,EACLH,EAAO,IAAI,MAAM,4BAA4B,KAAK,OAAO,IAAI,CAAC,CAClE,EAAG,KAAK,OAAO,EAEf,KAAK,OAAO,GAAG,UAAW,IAAM,CAC5B,aAAaG,CAAS,EACtB,KAAK,YAAc,GACnBJ,EAAQ,IAAI,CAChB,CAAC,EAED,KAAK,OAAO,GAAG,QAAUK,GAAQ,CAC7B,aAAaD,CAAS,EACtB,KAAK,SAAA,EACLH,EAAOI,CAAG,CACd,CAAC,EAED,KAAK,OAAO,GAAG,QAAS,IAAM,CAC1B,KAAK,SAAA,CACT,CAAC,EAED,KAAK,OAAO,GAAG,OAASC,GAAS,CAC7B,KAAK,YAAYA,CAAI,CACzB,CAAC,CACL,CAAC,CACL,CASO,QAAWC,EAAgBC,EAAiC,CAC/D,OAAO,IAAI,QAAQ,CAACR,EAASC,IAAW,CACpC,GAAI,CAAC,KAAK,YAAa,CACnBA,EAAO,IAAI,MAAM,wBAAwB,CAAC,EAC1C,MACJ,CAEA,MAAMQ,EAAK,KAAK,YACVC,EAAU,KAAK,UAAU,CAC3B,OAAAH,EACA,OAAAC,EACA,GAAAC,CAAA,CACH,EAAI;AAAA,EAECL,EAAY,WAAW,IAAM,CAC/B,KAAK,gBAAgB,OAAOK,CAAE,EAC9BR,EAAO,IAAI,MAAM,+BAA+BM,CAAM,EAAE,CAAC,CAC7D,EAAG,KAAK,OAAO,EAEf,KAAK,gBAAgB,IAAIE,EAAI,CAAC,QAAAT,EAAS,OAAAC,EAAQ,UAAAG,EAAU,EAEzD,KAAK,OAAQ,MAAMM,EAAUL,GAAQ,CAC7BA,IACA,aAAaD,CAAS,EACtB,KAAK,gBAAgB,OAAOK,CAAE,EAC9BR,EAAOI,CAAG,EAElB,CAAC,CACL,CAAC,CACL,CAIA,MAAa,SAA6B,CACtC,MAAMM,EAAW,MAAM,KAAK,QAAyB,WAAY,CAAA,CAAE,EAEnE,GAAI,UAAWA,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,MAAMC,EAASD,EAAS,OAExB,GAAI,UAAWC,EACX,MAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE,EAElD,OAAOA,CACX,CAEA,MAAa,UAAUC,EAAiB,eAAyC,CAC7E,MAAMF,EAAW,MAAM,KAAK,QAA2B,aAAc,CAACE,CAAM,CAAC,EAC7E,GAAI,UAAWF,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,MAAMC,EAASD,EAAS,OACxB,GAAI,UAAWC,EACX,MAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE,EAElD,OAAOA,CACX,CAEA,MAAa,SAASC,EAAgBC,EAAuE,CACzG,MAAMH,EAAW,MAAM,KAAK,QAA0B,WAAY,CAACE,EAAQ,GAAGC,CAAU,CAAC,EACzF,GAAI,UAAWH,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,OAAOA,EAAS,MAGpB,CAEA,MAAa,QAAQE,EAAgBE,EAAsBC,EAAwF,CAC/I,MAAML,EAAW,MAAM,KAAK,QAAyB,UAAW,CAACE,EAAQE,EAAWC,CAA4B,CAAC,EACjH,GAAI,UAAWL,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,MAAMC,EAASD,EAAS,OACxB,GAAI,UAAWC,EACX,MAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE,EAElD,OAAOA,CACX,CAEA,MAAa,cAAcG,EAAsD,CAC7E,MAAMJ,EAAW,MAAM,KAAK,QAA+B,iBAAkB,CAACI,CAAS,CAAC,EACxF,GAAI,UAAWJ,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,MAAMC,EAASD,EAAS,OACxB,GAAI,UAAWC,EACX,MAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE,EAElD,OAAOA,CACX,CAEA,MAAa,KAAKK,EAAqB,OAA8B,CACjE,MAAMN,EAAW,MAAM,KAAK,QAAsB,OAAQ,MAAM,QAAQM,CAAO,EAAIA,EAAU,CAACA,CAAO,CAAC,EACtG,GAAI,UAAWN,GAAYA,EAAS,QAAU,KAC1C,MAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE,EAElD,MAAMC,EAASD,EAAS,OACxB,GAAI,UAAWC,EACX,MAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE,EAElD,OAAOA,CACX,CAMA,MAAa,OAAuB,CAChC,MAAM,KAAK,OAAO,YAAY,EAAA,CAClC,CAOA,MAAc,OAAO,YAAY,GAAmB,CAChD,GAAI,KAAK,YAAa,CAClB,MAAMM,EAAe,IAAI,QAAelB,GAAY,CAChD,GAAI,KAAK,OAAQ,CACb,GAAI,KAAK,OAAO,WAAa,KAAK,OAAO,aAAe,SAAU,CAC9DA,EAAA,EACA,MACJ,CACA,KAAK,OAAO,KAAK,QAAS,IAAM,CAC5BA,EAAA,CACJ,CAAC,CACL,MACIA,EAAA,CAER,CAAC,EAED,KAAK,SAAA,EACL,MAAMkB,CACV,CACJ,CAMQ,UAAiB,CACrB,KAAK,YAAc,GACf,KAAK,SACL,KAAK,OAAO,QAAA,EACZ,KAAK,OAAS,MAElB,KAAK,gBAAgB,QAAQ,CAAC,CAAC,OAAAjB,EAAQ,UAAAG,KAAe,CAClD,aAAaA,CAAS,EACtBH,EAAO,IAAI,MAAM,mBAAmB,CAAC,CACzC,CAAC,EACD,KAAK,gBAAgB,MAAA,CACzB,CAOQ,YAAYK,EAAoB,CACnBA,EAAK,SAAA,EAAW,KAAA,EAAO,MAAM;AAAA,CAAI,EACzC,QAAQa,GAAW,CACxB,GAAKA,EACL,GAAI,CACA,MAAMR,EAAW,KAAK,MAAMQ,CAAO,EACnC,KAAK,gBAAgBR,CAAQ,CACjC,OAASN,EAAK,CACV,QAAQ,MAAM,wBAAyBA,CAAG,CAC9C,CACJ,CAAC,CACL,CAOQ,gBAAgBM,EAA2B,CAC/C,GAAI,OAAOA,GAAa,UAAYA,IAAa,MAAQ,EAAE,OAAQA,GAAW,CAC1E,QAAQ,MAAM,2BAA4BA,CAAQ,EAClD,MACJ,CAEA,MAAMF,EAAKE,EAAS,GACdD,EAAU,KAAK,gBAAgB,IAAID,CAAE,EAE3C,GAAI,CAACC,EAAS,CAEV,KAAK,oBAAoBC,CAAQ,EACjC,MACJ,CAEA,KAAK,gBAAgB,OAAOF,CAAE,EAC9B,aAAaC,EAAQ,SAAS,EAE1B,UAAWC,GAAYA,EAAS,QAAU,KAC1CD,EAAQ,OAAO,IAAI,MAAM,cAAcC,EAAS,KAAK,EAAE,CAAC,EAExDD,EAAQ,QAASC,CAAqC,CAE9D,CAQQ,oBAAoBS,EAA+B,CACvD,GAAI,OAAOA,GAAiB,UAAYA,IAAiB,MAAQ,EAAE,WAAYA,GAAe,CAC1F,QAAQ,MAAM,+BAAgCA,CAAY,EAC1D,MACJ,CAEA,MAAMb,EAAUa,EAAoC,OAEpD,OAAQb,EAAA,CACJ,IAAK,SACD,QAAQ,IAAI,gCAAkCa,EAAoC,OAAO,CAAC,CAAC,EAC3F,MACJ,IAAK,SACD,QAAQ,IAAI,gCAAkCA,EAAoC,OAAO,CAAC,CAAC,EAC3F,MACJ,IAAK,SACD,QAAQ,IAAI,gCAAkCA,EAAoC,OAAO,CAAC,CAAC,EAC3F,MACJ,QACI,QAAQ,IAAI,yBAA0Bb,CAAM,CAAA,CAExD,CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+import { DatabaseOperation, DatabaseSchema, JsonValue, MonitorConfig, OvsdbResult, TableUpdate } from './types';
+/**
+ * Options for configuring the OVSDBClient.
+ */
+export interface OvsdbClientOptions {
+    socketPath?: string;
+    timeout?: number;
+}
+/**
+ * A lightweight, typesafe client for interacting with the OVSDB over a Unix socket.
+ * Implements the AsyncDisposable interface for resource management.
+ * No extra functionality should be added to this client than only interact with the low-level database functions of ovs
+ */
+export declare class OVSDBClient implements AsyncDisposable {
+    private readonly socketPath;
+    private readonly timeout;
+    private socket;
+    private requestId;
+    private pendingRequests;
+    private isConnected;
+    /**
+     * Creates a new OVSDBClient instance.
+     * @param options - Configuration options for the client.
+     */
+    constructor(options?: OvsdbClientOptions);
+    /**
+     * Connects to the OVSDB Unix socket.
+     * @returns A promise that resolves when connected.
+     * @throws An error if the socket file does not exist or the connection fails.
+     */
+    connect(): Promise<this>;
+    /**
+     * Sends a JSON-RPC request to the OVSDB server.
+     * @param method - The RPC method name.
+     * @param params - The parameters for the RPC method.
+     * @returns A promise that resolves with the result.
+     * @throws An error if not connected, if the request times out, or if there is a network error.
+     */
+    request<T>(method: string, params: JsonValue[]): Promise<T>;
+    listDbs(): Promise<string[]>;
+    getSchema(dbName?: string): Promise<DatabaseSchema>;
+    transact(dbName: string, operations: DatabaseOperation[]): Promise<Array<OvsdbResult<unknown>>>;
+    monitor(dbName: string, monitorId: JsonValue, monitorRequests: Record<string, MonitorConfig[]>): Promise<Record<string, TableUpdate>>;
+    monitorCancel(monitorId: JsonValue): Promise<Record<string, never>>;
+    echo(payload?: JsonValue): Promise<JsonValue[]>;
+    /**
+     * Closes the connection to the OVSDB server.
+     * @returns A promise that resolves when the connection is closed.
+     */
+    close(): Promise<void>;
+    /**
+     * Implements the AsyncDisposable interface for use with 'using' statements.
+     * This method is called automatically when exiting a 'using' block.
+     * @returns A promise that resolves when cleanup is complete.
+     */
+    [Symbol.asyncDispose](): Promise<void>;
+    /**
+     * Cleans up the connection and pending requests.
+     * @private
+     */
+    private _cleanup;
+    /**
+     * Handles incoming data from the socket.
+     * @private
+     * @param data - The raw data received.
+     */
+    private _handleData;
+    /**
+     * Handles a parsed JSON-RPC response.
+     * @private
+     * @param response - The JSON-RPC response object.
+     */
+    private _handleResponse;
+    /**
+     * Handles JSON-RPC notifications (e.g., "update", "locked", "stolen").
+     * This can be overridden by subclasses or event listeners.
+     * @private
+     * @param notification - The notification object.
+     */
+    private _handleNotification;
+}
+export * from './types';

package/dist/index.es.js

@@ -0,0 +1,221 @@
+import { createConnection as a } from "net";
+import { existsSync as h } from "fs";
+class m {
+  /**
+   * Creates a new OVSDBClient instance.
+   * @param options - Configuration options for the client.
+   */
+  constructor(r = {}) {
+    this.socket = null, this.requestId = 1, this.pendingRequests = /* @__PURE__ */ new Map(), this.isConnected = !1, this.socketPath = r.socketPath || "/var/run/openvswitch/db.sock", this.timeout = r.timeout || 5e3;
+  }
+  /**
+   * Connects to the OVSDB Unix socket.
+   * @returns A promise that resolves when connected.
+   * @throws An error if the socket file does not exist or the connection fails.
+   */
+  connect() {
+    return new Promise((r, e) => {
+      if (this.isConnected) {
+        r(this);
+        return;
+      }
+      if (!h(this.socketPath)) {
+        e(new Error(`OVSDB socket not found: ${this.socketPath}`));
+        return;
+      }
+      this.socket = a(this.socketPath);
+      const t = setTimeout(() => {
+        this._cleanup(), e(new Error(`Connection timeout after ${this.timeout}ms`));
+      }, this.timeout);
+      this.socket.on("connect", () => {
+        clearTimeout(t), this.isConnected = !0, r(this);
+      }), this.socket.on("error", (o) => {
+        clearTimeout(t), this._cleanup(), e(o);
+      }), this.socket.on("close", () => {
+        this._cleanup();
+      }), this.socket.on("data", (o) => {
+        this._handleData(o);
+      });
+    });
+  }
+  /**
+   * Sends a JSON-RPC request to the OVSDB server.
+   * @param method - The RPC method name.
+   * @param params - The parameters for the RPC method.
+   * @returns A promise that resolves with the result.
+   * @throws An error if not connected, if the request times out, or if there is a network error.
+   */
+  request(r, e) {
+    return new Promise((t, o) => {
+      if (!this.isConnected) {
+        o(new Error("Not connected to OVSDB"));
+        return;
+      }
+      const s = this.requestId++, c = JSON.stringify({
+        method: r,
+        params: e,
+        id: s
+      }) + `
+`, n = setTimeout(() => {
+        this.pendingRequests.delete(s), o(new Error(`Request timeout for method: ${r}`));
+      }, this.timeout);
+      this.pendingRequests.set(s, { resolve: t, reject: o, timeoutId: n }), this.socket.write(c, (i) => {
+        i && (clearTimeout(n), this.pendingRequests.delete(s), o(i));
+      });
+    });
+  }
+  // --- Core OVSDB RPC Methods (Fixed to handle the response structure) ---
+  async listDbs() {
+    const r = await this.request("list_dbs", []);
+    if ("error" in r && r.error !== null)
+      throw new Error(`RPC Error: ${r.error}`);
+    const e = r.result;
+    if ("error" in e)
+      throw new Error(`OVSDB Error: ${e.error}`);
+    return e;
+  }
+  async getSchema(r = "Open_vSwitch") {
+    const e = await this.request("get_schema", [r]);
+    if ("error" in e && e.error !== null)
+      throw new Error(`RPC Error: ${e.error}`);
+    const t = e.result;
+    if ("error" in t)
+      throw new Error(`OVSDB Error: ${t.error}`);
+    return t;
+  }
+  async transact(r, e) {
+    const t = await this.request("transact", [r, ...e]);
+    if ("error" in t && t.error !== null)
+      throw new Error(`RPC Error: ${t.error}`);
+    return t.result;
+  }
+  async monitor(r, e, t) {
+    const o = await this.request("monitor", [r, e, t]);
+    if ("error" in o && o.error !== null)
+      throw new Error(`RPC Error: ${o.error}`);
+    const s = o.result;
+    if ("error" in s)
+      throw new Error(`OVSDB Error: ${s.error}`);
+    return s;
+  }
+  async monitorCancel(r) {
+    const e = await this.request("monitor_cancel", [r]);
+    if ("error" in e && e.error !== null)
+      throw new Error(`RPC Error: ${e.error}`);
+    const t = e.result;
+    if ("error" in t)
+      throw new Error(`OVSDB Error: ${t.error}`);
+    return t;
+  }
+  async echo(r = "ping") {
+    const e = await this.request("echo", Array.isArray(r) ? r : [r]);
+    if ("error" in e && e.error !== null)
+      throw new Error(`RPC Error: ${e.error}`);
+    const t = e.result;
+    if ("error" in t)
+      throw new Error(`OVSDB Error: ${t.error}`);
+    return t;
+  }
+  /**
+   * Closes the connection to the OVSDB server.
+   * @returns A promise that resolves when the connection is closed.
+   */
+  async close() {
+    await this[Symbol.asyncDispose]();
+  }
+  /**
+   * Implements the AsyncDisposable interface for use with 'using' statements.
+   * This method is called automatically when exiting a 'using' block.
+   * @returns A promise that resolves when cleanup is complete.
+   */
+  async [Symbol.asyncDispose]() {
+    if (this.isConnected) {
+      const r = new Promise((e) => {
+        if (this.socket) {
+          if (this.socket.destroyed || this.socket.readyState === "closed") {
+            e();
+            return;
+          }
+          this.socket.once("close", () => {
+            e();
+          });
+        } else
+          e();
+      });
+      this._cleanup(), await r;
+    }
+  }
+  /**
+   * Cleans up the connection and pending requests.
+   * @private
+   */
+  _cleanup() {
+    this.isConnected = !1, this.socket && (this.socket.destroy(), this.socket = null), this.pendingRequests.forEach(({ reject: r, timeoutId: e }) => {
+      clearTimeout(e), r(new Error("Connection closed"));
+    }), this.pendingRequests.clear();
+  }
+  /**
+   * Handles incoming data from the socket.
+   * @private
+   * @param data - The raw data received.
+   */
+  _handleData(r) {
+    r.toString().trim().split(`
+`).forEach((t) => {
+      if (t)
+        try {
+          const o = JSON.parse(t);
+          this._handleResponse(o);
+        } catch (o) {
+          console.error("Failed to parse JSON:", o);
+        }
+    });
+  }
+  /**
+   * Handles a parsed JSON-RPC response.
+   * @private
+   * @param response - The JSON-RPC response object.
+   */
+  _handleResponse(r) {
+    if (typeof r != "object" || r === null || !("id" in r)) {
+      console.error("Invalid response format:", r);
+      return;
+    }
+    const e = r.id, t = this.pendingRequests.get(e);
+    if (!t) {
+      this._handleNotification(r);
+      return;
+    }
+    this.pendingRequests.delete(e), clearTimeout(t.timeoutId), "error" in r && r.error !== null ? t.reject(new Error(`RPC Error: ${r.error}`)) : t.resolve(r);
+  }
+  /**
+   * Handles JSON-RPC notifications (e.g., "update", "locked", "stolen").
+   * This can be overridden by subclasses or event listeners.
+   * @private
+   * @param notification - The notification object.
+   */
+  _handleNotification(r) {
+    if (typeof r != "object" || r === null || !("method" in r)) {
+      console.error("Invalid notification format:", r);
+      return;
+    }
+    const e = r.method;
+    switch (e) {
+      case "update":
+        console.log("Received update notification:", r.params[0]);
+        break;
+      case "locked":
+        console.log("Received locked notification:", r.params[0]);
+        break;
+      case "stolen":
+        console.log("Received stolen notification:", r.params[0]);
+        break;
+      default:
+        console.log("Received notification:", e);
+    }
+  }
+}
+export {
+  m as OVSDBClient
+};
+//# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es.js","sources":["../src/index.ts"],"sourcesContent":["import {createConnection, Socket} from \"net\";\nimport {existsSync} from \"fs\";\n\nimport {\n    DatabaseOperation,\n    DatabaseSchema, EchoResponse,\n    GetSchemaResponse,\n    JsonValue,\n    ListDbsResponse, LockedNotification, MonitorCancelResponse, MonitorConfig, MonitorResponse, OvsdbResponse,\n    OvsdbResult, StolenNotification, TableUpdate,\n    TransactResponse, UpdateNotification\n} from \"./types\";\n\n/**\n * Options for configuring the OVSDBClient.\n */\nexport interface OvsdbClientOptions {\n    socketPath?: string;\n    timeout?: number;\n}\n\n/**\n * A lightweight, typesafe client for interacting with the OVSDB over a Unix socket.\n * Implements the AsyncDisposable interface for resource management.\n * No extra functionality should be added to this client than only interact with the low-level database functions of ovs\n */\nexport class OVSDBClient implements AsyncDisposable {\n    private readonly socketPath: string;\n    private readonly timeout: number;\n    private socket: Socket | null = null;\n    private requestId = 1;\n    private pendingRequests = new Map<number, {\n        resolve: (value: any) => void;\n        reject: (reason?: any) => void;\n        timeoutId: NodeJS.Timeout;\n    }>();\n    private isConnected = false;\n\n    /**\n     * Creates a new OVSDBClient instance.\n     * @param options - Configuration options for the client.\n     */\n    constructor(options: OvsdbClientOptions = {}) {\n        this.socketPath = options.socketPath || '/var/run/openvswitch/db.sock';\n        this.timeout = options.timeout || 5000;\n    }\n\n    /**\n     * Connects to the OVSDB Unix socket.\n     * @returns A promise that resolves when connected.\n     * @throws An error if the socket file does not exist or the connection fails.\n     */\n    public connect(): Promise<this> {\n        return new Promise((resolve, reject) => {\n            if (this.isConnected) {\n                resolve(this);\n                return;\n            }\n\n            if (!existsSync(this.socketPath)) {\n                reject(new Error(`OVSDB socket not found: ${this.socketPath}`));\n                return;\n            }\n\n            this.socket = createConnection(this.socketPath);\n\n            const timeoutId = setTimeout(() => {\n                this._cleanup();\n                reject(new Error(`Connection timeout after ${this.timeout}ms`));\n            }, this.timeout);\n\n            this.socket.on('connect', () => {\n                clearTimeout(timeoutId);\n                this.isConnected = true;\n                resolve(this);\n            });\n\n            this.socket.on('error', (err) => {\n                clearTimeout(timeoutId);\n                this._cleanup();\n                reject(err);\n            });\n\n            this.socket.on('close', () => {\n                this._cleanup();\n            });\n\n            this.socket.on('data', (data) => {\n                this._handleData(data);\n            });\n        });\n    }\n\n    /**\n     * Sends a JSON-RPC request to the OVSDB server.\n     * @param method - The RPC method name.\n     * @param params - The parameters for the RPC method.\n     * @returns A promise that resolves with the result.\n     * @throws An error if not connected, if the request times out, or if there is a network error.\n     */\n    public request<T>(method: string, params: JsonValue[]): Promise<T> {\n        return new Promise((resolve, reject) => {\n            if (!this.isConnected) {\n                reject(new Error('Not connected to OVSDB'));\n                return;\n            }\n\n            const id = this.requestId++;\n            const request = JSON.stringify({\n                method,\n                params,\n                id\n            }) + '\\n';\n\n            const timeoutId = setTimeout(() => {\n                this.pendingRequests.delete(id);\n                reject(new Error(`Request timeout for method: ${method}`));\n            }, this.timeout);\n\n            this.pendingRequests.set(id, {resolve, reject, timeoutId});\n\n            this.socket!.write(request, (err) => {\n                if (err) {\n                    clearTimeout(timeoutId);\n                    this.pendingRequests.delete(id);\n                    reject(err);\n                }\n            });\n        });\n    }\n\n    // --- Core OVSDB RPC Methods (Fixed to handle the response structure) ---\n\n    public async listDbs(): Promise<string[]> {\n        const response = await this.request<ListDbsResponse>('list_dbs', []);\n        // Check if the response is an error object\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        // Check if the OvsdbResult itself is an error\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async getSchema(dbName: string = 'Open_vSwitch'): Promise<DatabaseSchema> {\n        const response = await this.request<GetSchemaResponse>('get_schema', [dbName]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async transact(dbName: string, operations: DatabaseOperation[]): Promise<Array<OvsdbResult<unknown>>> {\n        const response = await this.request<TransactResponse>('transact', [dbName, ...operations]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        return response.result as Array<OvsdbResult<unknown>>;\n        // Note: The result here is already an array of OvsdbResult<unknown>.\n        // The caller is responsible for checking each element for errors.\n    }\n\n    public async monitor(dbName: string, monitorId: JsonValue, monitorRequests: Record<string, MonitorConfig[]>): Promise<Record<string, TableUpdate>> {\n        const response = await this.request<MonitorResponse>('monitor', [dbName, monitorId, monitorRequests as JsonValue]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async monitorCancel(monitorId: JsonValue): Promise<Record<string, never>> {\n        const response = await this.request<MonitorCancelResponse>('monitor_cancel', [monitorId]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    public async echo(payload: JsonValue = 'ping'): Promise<JsonValue[]> {\n        const response = await this.request<EchoResponse>('echo', Array.isArray(payload) ? payload : [payload]);\n        if ('error' in response && response.error !== null) {\n            throw new Error(`RPC Error: ${response.error}`);\n        }\n        const result = response.result;\n        if ('error' in result) {\n            throw new Error(`OVSDB Error: ${result.error}`);\n        }\n        return result;\n    }\n\n    /**\n     * Closes the connection to the OVSDB server.\n     * @returns A promise that resolves when the connection is closed.\n     */\n    public async close(): Promise<void> {\n        await this[Symbol.asyncDispose]();\n    }\n\n    /**\n     * Implements the AsyncDisposable interface for use with 'using' statements.\n     * This method is called automatically when exiting a 'using' block.\n     * @returns A promise that resolves when cleanup is complete.\n     */\n    public async [Symbol.asyncDispose](): Promise<void> {\n        if (this.isConnected) {\n            const closePromise = new Promise<void>((resolve) => {\n                if (this.socket) {\n                    if (this.socket.destroyed || this.socket.readyState === 'closed') {\n                        resolve();\n                        return;\n                    }\n                    this.socket.once('close', () => {\n                        resolve();\n                    });\n                } else {\n                    resolve();\n                }\n            });\n\n            this._cleanup();\n            await closePromise;\n        }\n    }\n\n    /**\n     * Cleans up the connection and pending requests.\n     * @private\n     */\n    private _cleanup(): void {\n        this.isConnected = false;\n        if (this.socket) {\n            this.socket.destroy();\n            this.socket = null;\n        }\n        this.pendingRequests.forEach(({reject, timeoutId}) => {\n            clearTimeout(timeoutId);\n            reject(new Error('Connection closed'));\n        });\n        this.pendingRequests.clear();\n    }\n\n    /**\n     * Handles incoming data from the socket.\n     * @private\n     * @param data - The raw data received.\n     */\n    private _handleData(data: Buffer): void {\n        const messages = data.toString().trim().split('\\n');\n        messages.forEach(message => {\n            if (!message) return;\n            try {\n                const response = JSON.parse(message);\n                this._handleResponse(response);\n            } catch (err) {\n                console.error('Failed to parse JSON:', err);\n            }\n        });\n    }\n\n    /**\n     * Handles a parsed JSON-RPC response.\n     * @private\n     * @param response - The JSON-RPC response object.\n     */\n    private _handleResponse(response: JsonValue): void {\n        if (typeof response !== 'object' || response === null || !('id' in response)) {\n            console.error('Invalid response format:', response);\n            return;\n        }\n\n        const id = response.id as number;\n        const request = this.pendingRequests.get(id);\n\n        if (!request) {\n            // This is a notification (e.g., \"update\", \"locked\", \"stolen\")\n            this._handleNotification(response);\n            return;\n        }\n\n        this.pendingRequests.delete(id);\n        clearTimeout(request.timeoutId);\n\n        if ('error' in response && response.error !== null) {\n            request.reject(new Error(`RPC Error: ${response.error}`));\n        } else {\n            request.resolve((response as unknown as OvsdbResponse));\n        }\n    }\n\n    /**\n     * Handles JSON-RPC notifications (e.g., \"update\", \"locked\", \"stolen\").\n     * This can be overridden by subclasses or event listeners.\n     * @private\n     * @param notification - The notification object.\n     */\n    private _handleNotification(notification: JsonValue): void {\n        if (typeof notification !== 'object' || notification === null || !('method' in notification)) {\n            console.error('Invalid notification format:', notification);\n            return;\n        }\n\n        const method = (notification as { method: string }).method;\n\n        switch (method) {\n            case 'update':\n                console.log('Received update notification:', (notification as UpdateNotification).params[0]);\n                break;\n            case 'locked':\n                console.log('Received locked notification:', (notification as LockedNotification).params[0]);\n                break;\n            case 'stolen':\n                console.log('Received stolen notification:', (notification as StolenNotification).params[0]);\n                break;\n            default:\n                console.log('Received notification:', method);\n        }\n    }\n}\n\nexport * from \"./types\"\n"],"names":["OVSDBClient","options","resolve","reject","existsSync","createConnection","timeoutId","err","data","method","params","id","request","response","result","dbName","operations","monitorId","monitorRequests","payload","closePromise","message","notification"],"mappings":";;AA0BO,MAAMA,EAAuC;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBhD,YAAYC,IAA8B,IAAI;AAb9C,SAAQ,SAAwB,MAChC,KAAQ,YAAY,GACpB,KAAQ,sCAAsB,IAAA,GAK9B,KAAQ,cAAc,IAOlB,KAAK,aAAaA,EAAQ,cAAc,gCACxC,KAAK,UAAUA,EAAQ,WAAW;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,UAAyB;AAC5B,WAAO,IAAI,QAAQ,CAACC,GAASC,MAAW;AACpC,UAAI,KAAK,aAAa;AAClB,QAAAD,EAAQ,IAAI;AACZ;AAAA,MACJ;AAEA,UAAI,CAACE,EAAW,KAAK,UAAU,GAAG;AAC9B,QAAAD,EAAO,IAAI,MAAM,2BAA2B,KAAK,UAAU,EAAE,CAAC;AAC9D;AAAA,MACJ;AAEA,WAAK,SAASE,EAAiB,KAAK,UAAU;AAE9C,YAAMC,IAAY,WAAW,MAAM;AAC/B,aAAK,SAAA,GACLH,EAAO,IAAI,MAAM,4BAA4B,KAAK,OAAO,IAAI,CAAC;AAAA,MAClE,GAAG,KAAK,OAAO;AAEf,WAAK,OAAO,GAAG,WAAW,MAAM;AAC5B,qBAAaG,CAAS,GACtB,KAAK,cAAc,IACnBJ,EAAQ,IAAI;AAAA,MAChB,CAAC,GAED,KAAK,OAAO,GAAG,SAAS,CAACK,MAAQ;AAC7B,qBAAaD,CAAS,GACtB,KAAK,SAAA,GACLH,EAAOI,CAAG;AAAA,MACd,CAAC,GAED,KAAK,OAAO,GAAG,SAAS,MAAM;AAC1B,aAAK,SAAA;AAAA,MACT,CAAC,GAED,KAAK,OAAO,GAAG,QAAQ,CAACC,MAAS;AAC7B,aAAK,YAAYA,CAAI;AAAA,MACzB,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,QAAWC,GAAgBC,GAAiC;AAC/D,WAAO,IAAI,QAAQ,CAACR,GAASC,MAAW;AACpC,UAAI,CAAC,KAAK,aAAa;AACnB,QAAAA,EAAO,IAAI,MAAM,wBAAwB,CAAC;AAC1C;AAAA,MACJ;AAEA,YAAMQ,IAAK,KAAK,aACVC,IAAU,KAAK,UAAU;AAAA,QAC3B,QAAAH;AAAA,QACA,QAAAC;AAAA,QACA,IAAAC;AAAA,MAAA,CACH,IAAI;AAAA,GAECL,IAAY,WAAW,MAAM;AAC/B,aAAK,gBAAgB,OAAOK,CAAE,GAC9BR,EAAO,IAAI,MAAM,+BAA+BM,CAAM,EAAE,CAAC;AAAA,MAC7D,GAAG,KAAK,OAAO;AAEf,WAAK,gBAAgB,IAAIE,GAAI,EAAC,SAAAT,GAAS,QAAAC,GAAQ,WAAAG,GAAU,GAEzD,KAAK,OAAQ,MAAMM,GAAS,CAACL,MAAQ;AACjC,QAAIA,MACA,aAAaD,CAAS,GACtB,KAAK,gBAAgB,OAAOK,CAAE,GAC9BR,EAAOI,CAAG;AAAA,MAElB,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AAAA;AAAA,EAIA,MAAa,UAA6B;AACtC,UAAMM,IAAW,MAAM,KAAK,QAAyB,YAAY,CAAA,CAAE;AAEnE,QAAI,WAAWA,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,UAAMC,IAASD,EAAS;AAExB,QAAI,WAAWC;AACX,YAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE;AAElD,WAAOA;AAAA,EACX;AAAA,EAEA,MAAa,UAAUC,IAAiB,gBAAyC;AAC7E,UAAMF,IAAW,MAAM,KAAK,QAA2B,cAAc,CAACE,CAAM,CAAC;AAC7E,QAAI,WAAWF,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,UAAMC,IAASD,EAAS;AACxB,QAAI,WAAWC;AACX,YAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE;AAElD,WAAOA;AAAA,EACX;AAAA,EAEA,MAAa,SAASC,GAAgBC,GAAuE;AACzG,UAAMH,IAAW,MAAM,KAAK,QAA0B,YAAY,CAACE,GAAQ,GAAGC,CAAU,CAAC;AACzF,QAAI,WAAWH,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,WAAOA,EAAS;AAAA,EAGpB;AAAA,EAEA,MAAa,QAAQE,GAAgBE,GAAsBC,GAAwF;AAC/I,UAAML,IAAW,MAAM,KAAK,QAAyB,WAAW,CAACE,GAAQE,GAAWC,CAA4B,CAAC;AACjH,QAAI,WAAWL,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,UAAMC,IAASD,EAAS;AACxB,QAAI,WAAWC;AACX,YAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE;AAElD,WAAOA;AAAA,EACX;AAAA,EAEA,MAAa,cAAcG,GAAsD;AAC7E,UAAMJ,IAAW,MAAM,KAAK,QAA+B,kBAAkB,CAACI,CAAS,CAAC;AACxF,QAAI,WAAWJ,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,UAAMC,IAASD,EAAS;AACxB,QAAI,WAAWC;AACX,YAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE;AAElD,WAAOA;AAAA,EACX;AAAA,EAEA,MAAa,KAAKK,IAAqB,QAA8B;AACjE,UAAMN,IAAW,MAAM,KAAK,QAAsB,QAAQ,MAAM,QAAQM,CAAO,IAAIA,IAAU,CAACA,CAAO,CAAC;AACtG,QAAI,WAAWN,KAAYA,EAAS,UAAU;AAC1C,YAAM,IAAI,MAAM,cAAcA,EAAS,KAAK,EAAE;AAElD,UAAMC,IAASD,EAAS;AACxB,QAAI,WAAWC;AACX,YAAM,IAAI,MAAM,gBAAgBA,EAAO,KAAK,EAAE;AAElD,WAAOA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAa,QAAuB;AAChC,UAAM,KAAK,OAAO,YAAY,EAAA;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAc,OAAO,YAAY,IAAmB;AAChD,QAAI,KAAK,aAAa;AAClB,YAAMM,IAAe,IAAI,QAAc,CAAClB,MAAY;AAChD,YAAI,KAAK,QAAQ;AACb,cAAI,KAAK,OAAO,aAAa,KAAK,OAAO,eAAe,UAAU;AAC9D,YAAAA,EAAA;AACA;AAAA,UACJ;AACA,eAAK,OAAO,KAAK,SAAS,MAAM;AAC5B,YAAAA,EAAA;AAAA,UACJ,CAAC;AAAA,QACL;AACI,UAAAA,EAAA;AAAA,MAER,CAAC;AAED,WAAK,SAAA,GACL,MAAMkB;AAAA,IACV;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMQ,WAAiB;AACrB,SAAK,cAAc,IACf,KAAK,WACL,KAAK,OAAO,QAAA,GACZ,KAAK,SAAS,OAElB,KAAK,gBAAgB,QAAQ,CAAC,EAAC,QAAAjB,GAAQ,WAAAG,QAAe;AAClD,mBAAaA,CAAS,GACtBH,EAAO,IAAI,MAAM,mBAAmB,CAAC;AAAA,IACzC,CAAC,GACD,KAAK,gBAAgB,MAAA;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,YAAYK,GAAoB;AAEpC,IADiBA,EAAK,SAAA,EAAW,KAAA,EAAO,MAAM;AAAA,CAAI,EACzC,QAAQ,CAAAa,MAAW;AACxB,UAAKA;AACL,YAAI;AACA,gBAAMR,IAAW,KAAK,MAAMQ,CAAO;AACnC,eAAK,gBAAgBR,CAAQ;AAAA,QACjC,SAASN,GAAK;AACV,kBAAQ,MAAM,yBAAyBA,CAAG;AAAA,QAC9C;AAAA,IACJ,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,gBAAgBM,GAA2B;AAC/C,QAAI,OAAOA,KAAa,YAAYA,MAAa,QAAQ,EAAE,QAAQA,IAAW;AAC1E,cAAQ,MAAM,4BAA4BA,CAAQ;AAClD;AAAA,IACJ;AAEA,UAAMF,IAAKE,EAAS,IACdD,IAAU,KAAK,gBAAgB,IAAID,CAAE;AAE3C,QAAI,CAACC,GAAS;AAEV,WAAK,oBAAoBC,CAAQ;AACjC;AAAA,IACJ;AAEA,SAAK,gBAAgB,OAAOF,CAAE,GAC9B,aAAaC,EAAQ,SAAS,GAE1B,WAAWC,KAAYA,EAAS,UAAU,OAC1CD,EAAQ,OAAO,IAAI,MAAM,cAAcC,EAAS,KAAK,EAAE,CAAC,IAExDD,EAAQ,QAASC,CAAqC;AAAA,EAE9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,oBAAoBS,GAA+B;AACvD,QAAI,OAAOA,KAAiB,YAAYA,MAAiB,QAAQ,EAAE,YAAYA,IAAe;AAC1F,cAAQ,MAAM,gCAAgCA,CAAY;AAC1D;AAAA,IACJ;AAEA,UAAMb,IAAUa,EAAoC;AAEpD,YAAQb,GAAA;AAAA,MACJ,KAAK;AACD,gBAAQ,IAAI,iCAAkCa,EAAoC,OAAO,CAAC,CAAC;AAC3F;AAAA,MACJ,KAAK;AACD,gBAAQ,IAAI,iCAAkCA,EAAoC,OAAO,CAAC,CAAC;AAC3F;AAAA,MACJ,KAAK;AACD,gBAAQ,IAAI,iCAAkCA,EAAoC,OAAO,CAAC,CAAC;AAC3F;AAAA,MACJ;AACI,gBAAQ,IAAI,0BAA0Bb,CAAM;AAAA,IAAA;AAAA,EAExD;AACJ;"}

package/dist/types/index.d.ts

@@ -0,0 +1,222 @@
+/**
+ * A JSON value of any type.
+ */
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+/**
+ * An error object as defined in RFC 7047, Section 3.1.
+ */
+export interface OvsdbError {
+    error: string;
+    details: string | null;
+    [key: string]: JsonValue;
+}
+/**
+ * A result that can be either a success value or an error.
+ */
+export type OvsdbResult<T> = T | OvsdbError;
+/**
+ * The response to an RPC request as defined in RFC 7047, Section 4.1.
+ */
+export interface OvsdbResponse<T = JsonValue> {
+    result: OvsdbResult<T>;
+    error: null;
+    id: JsonValue;
+}
+/**
+ * A monitor request configuration as defined in RFC 7047, Section 4.1.5.
+ * Renamed from 'MonitorRequest' to avoid conflict with the top-level request.
+ */
+export interface MonitorConfig {
+    columns?: string[];
+    select?: {
+        initial?: boolean;
+        insert?: boolean;
+        delete?: boolean;
+        modify?: boolean;
+    };
+}
+/**
+ * The request for the 'list_dbs' method.
+ */
+export type ListDbsRequest = {
+    method: 'list_dbs';
+    params: [];
+    id: JsonValue;
+};
+/**
+ * The response for the 'list_dbs' method.
+ */
+export type ListDbsResponse = OvsdbResponse<string[]>;
+/**
+ * The request for the 'get_schema' method.
+ */
+export type GetSchemaRequest = {
+    method: 'get_schema';
+    params: [string];
+    id: JsonValue;
+};
+/**
+ * The response for the 'get_schema' method.
+ */
+export type GetSchemaResponse = OvsdbResponse<DatabaseSchema>;
+/**
+ * The request for the 'transact' method.
+ */
+export type TransactRequest = {
+    method: 'transact';
+    params: [string, DatabaseOperation[]];
+    id: JsonValue;
+};
+/**
+ * The response for the 'transact' method.
+ */
+export type TransactResponse = OvsdbResponse<Array<OvsdbResult<unknown>>>;
+/**
+ * The request for the 'monitor' method.
+ */
+export type MonitorRequest = {
+    method: 'monitor';
+    params: [string, JsonValue, Record<string, MonitorConfig[]>];
+    id: JsonValue;
+};
+/**
+ * The response for the 'monitor' method.
+ */
+export type MonitorResponse = OvsdbResponse<Record<string, TableUpdate>>;
+/**
+ * The request for the 'monitor_cancel' method.
+ */
+export type MonitorCancelRequest = {
+    method: 'monitor_cancel';
+    params: [JsonValue];
+    id: JsonValue;
+};
+/**
+ * The response for the 'monitor_cancel' method.
+ */
+export type MonitorCancelResponse = OvsdbResponse<Record<string, never>>;
+/**
+ * The request for the 'echo' method.
+ */
+export type EchoRequest = {
+    method: 'echo';
+    params: JsonValue[];
+    id: JsonValue;
+};
+/**
+ * The response for the 'echo' method.
+ */
+export type EchoResponse = OvsdbResponse<JsonValue[]>;
+/**
+ * The notification for the 'update' method.
+ */
+export type UpdateNotification = {
+    method: 'update';
+    params: [JsonValue, Record<string, TableUpdate>];
+    id: null;
+};
+/**
+ * The notification for the 'locked' method.
+ */
+export type LockedNotification = {
+    method: 'locked';
+    params: [string];
+    id: null;
+};
+/**
+ * The notification for the 'stolen' method.
+ */
+export type StolenNotification = {
+    method: 'stolen';
+    params: [string];
+    id: null;
+};
+export interface DatabaseSchema {
+    name: string;
+    version: string;
+    cksum?: string;
+    tables: Record<string, TableSchema>;
+}
+export interface TableSchema {
+    columns: Record<string, ColumnSchema>;
+    maxRows?: number;
+    isRoot?: boolean;
+    indexes?: string[][];
+}
+export interface ColumnSchema {
+    type: Type;
+    ephemeral?: boolean;
+    mutable?: boolean;
+}
+export type Type = AtomicType | {
+    key: BaseType;
+    value?: BaseType;
+    min?: number;
+    max?: number | 'unlimited';
+};
+export type AtomicType = 'integer' | 'real' | 'boolean' | 'string' | 'uuid';
+export type BaseType = AtomicType | {
+    type: AtomicType;
+    enum?: JsonValue;
+    minInteger?: number;
+    maxInteger?: number;
+    minReal?: number;
+    maxReal?: number;
+    minLength?: number;
+    maxLength?: number;
+    refTable?: string;
+    refType?: 'strong' | 'weak';
+};
+export type TableUpdate = Record<string, RowUpdate>;
+export interface RowUpdate {
+    old?: Record<string, JsonValue>;
+    new?: Record<string, JsonValue>;
+}
+export type DatabaseOperation = {
+    op: 'insert';
+    table: string;
+    row: Record<string, JsonValue>;
+    uuidName?: string;
+} | {
+    op: 'select';
+    table: string;
+    where: Condition[];
+    columns?: string[];
+} | {
+    op: 'update';
+    table: string;
+    where: Condition[];
+    row: Record<string, JsonValue>;
+} | {
+    op: 'mutate';
+    table: string;
+    where: Condition[];
+    mutations: Mutation[];
+} | {
+    op: 'delete';
+    table: string;
+    where: Condition[];
+} | {
+    op: 'wait';
+    timeout?: number;
+    table: string;
+    where: Condition[];
+    columns: string[];
+    until: '==' | '!=';
+    rows: Record<string, JsonValue>[];
+} | {
+    op: 'commit';
+    durable: boolean;
+} | {
+    op: 'abort';
+} | {
+    op: 'comment';
+    comment: string;
+} | {
+    op: 'assert';
+    lock: string;
+};
+export type Condition = [string, string, JsonValue];
+export type Mutation = [string, string, JsonValue];

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@sourceregistry/node-ovsdb",
+  "version": "1.0.0",
+  "description": "Open vSwitch Database Management Protocol typescript client",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "test": "vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SourceRegistry/node-ovsdb.git"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.3",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/release-notes-generator": "^14.0.3",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/npm": "^12.0.2",
+    "@semantic-release/git": "^10.0.1"
+  },
+  "keywords": [
+    "networking",
+    "ovs",
+    "Open vSwitch",
+    "RFC7047",
+    "ISSN2070-1721 "
+  ],
+  "author": "A.P.A. Slaa (a.p.a.slaa@projectsource.nl)",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/SourceRegistry/node-ovsdb/issues"
+  },
+  "homepage": "https://github.com/SourceRegistry/node-ovsdb#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer"
+      ],
+      [
+        "@semantic-release/release-notes-generator"
+      ],
+      [
+        "@semantic-release/changelog"
+      ],
+      [
+        "@semantic-release/npm"
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json",
+            "CHANGELOG.md"
+          ],
+          "message": "node-ovsdb(release): 🚀 ${nextRelease.version} \n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  }
+}