@olane/o-client-limited 0.7.12-alpha.51

package/LICENSE

@@ -0,0 +1,34 @@
+# Dual License: MIT OR Apache-2.0
+
+Copyright (c) 2025 Olane Inc.
+
+Olane OS is dual-licensed under your choice of either:
+
+- **MIT License** (LICENSE-MIT or https://opensource.org/licenses/MIT)
+- **Apache License, Version 2.0** (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
+
+## Why Dual Licensing?
+
+Dual licensing provides developers with flexibility when integrating Olane OS into their projects:
+
+- **Choose MIT**: If you prefer a simple, permissive license without patent provisions
+- **Choose Apache 2.0**: If you desire explicit patent protection and other features of the Apache license
+
+You may choose either license to govern your use of this software.
+
+## License Terms
+
+### MIT License
+The MIT license is very permissive and allows users to do almost anything with the software, including using, copying, modifying, merging, publishing, distributing, and selling it. The primary requirement is that the original copyright and license notice must be included in all copies of the software.
+
+See LICENSE-MIT for the full license text.
+
+### Apache License 2.0
+The Apache License 2.0 is also a permissive free software license. It grants users the right to use, modify, and distribute the software. It also includes provisions regarding patent grants, which are not present in the MIT license.
+
+See LICENSE-APACHE for the full license text.
+
+## Contributing
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual-licensed as above, without any additional terms or conditions.
+

package/README.md

@@ -0,0 +1,3 @@
+# Limited Client
+
+Re-use connections + streams for libp2p.

package/dist/src/connection/index.d.ts

@@ -0,0 +1,3 @@
+export * from './o-limited-connection.js';
+export * from './o-limited-connection-manager.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/connection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC"}

package/dist/src/connection/index.js

@@ -0,0 +1,2 @@
+export * from './o-limited-connection.js';
+export * from './o-limited-connection-manager.js';

package/dist/src/connection/o-limited-connection-manager.d.ts

@@ -0,0 +1,11 @@
+import { oNodeConnectionManager } from '@olane/o-node';
+import { oConnectionConfig } from '@olane/o-core';
+import { oLimitedConnection } from './o-limited-connection.js';
+export declare class oLimitedConnectionManager extends oNodeConnectionManager {
+    private readonly _token?;
+    /**
+     * Override connect to return oPrivateConnection with _token injected
+     */
+    connect(config: oConnectionConfig): Promise<oLimitedConnection>;
+}
+//# sourceMappingURL=o-limited-connection-manager.d.ts.map

package/dist/src/connection/o-limited-connection-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o-limited-connection-manager.d.ts","sourceRoot":"","sources":["../../../src/connection/o-limited-connection-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,qBAAa,yBAA0B,SAAQ,sBAAsB;IACnE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAS;IAEjC;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CA4BtE"}

package/dist/src/connection/o-limited-connection-manager.js

@@ -0,0 +1,29 @@
+import { oNodeConnectionManager } from '@olane/o-node';
+import { oLimitedConnection } from './o-limited-connection.js';
+export class oLimitedConnectionManager extends oNodeConnectionManager {
+    /**
+     * Override connect to return oPrivateConnection with _token injected
+     */
+    async connect(config) {
+        const { address, nextHopAddress, callerAddress } = config;
+        // First time setup connection
+        try {
+            const p2pConnection = await this.getOrCreateConnection(nextHopAddress, address);
+            const connection = new oLimitedConnection({
+                nextHopAddress: nextHopAddress,
+                address: address,
+                p2pConnection: p2pConnection,
+                callerAddress: callerAddress,
+                runOnLimitedConnection: this.config.runOnLimitedConnection ?? false,
+            });
+            return connection;
+        }
+        catch (error) {
+            this.logger.error(`[${callerAddress?.toString() || 'unknown'}] Error connecting to address! Next hop:` +
+                nextHopAddress +
+                ' With Address:' +
+                address.toString(), error);
+            throw error;
+        }
+    }
+}

package/dist/src/connection/o-limited-connection.d.ts

@@ -0,0 +1,7 @@
+import { Stream } from '@olane/o-config';
+import { oNodeConnection } from '@olane/o-node';
+export declare class oLimitedConnection extends oNodeConnection {
+    getOrCreateStream(): Promise<Stream>;
+    postTransmit(stream: Stream): Promise<void>;
+}
+//# sourceMappingURL=o-limited-connection.d.ts.map

package/dist/src/connection/o-limited-connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o-limited-connection.d.ts","sourceRoot":"","sources":["../../../src/connection/o-limited-connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAQzC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,qBAAa,kBAAmB,SAAQ,eAAe;IAC/C,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAqBpC,YAAY,CAAC,MAAM,EAAE,MAAM;CAGlC"}

package/dist/src/connection/o-limited-connection.js

@@ -0,0 +1,21 @@
+import { oError, oErrorCodes, } from '@olane/o-core';
+import { oNodeConnection } from '@olane/o-node';
+export class oLimitedConnection extends oNodeConnection {
+    async getOrCreateStream() {
+        if (this.p2pConnection.status !== 'open') {
+            throw new oError(oErrorCodes.INVALID_STATE, 'Connection not open');
+        }
+        // check if we have an open stream
+        const stream = this.p2pConnection.streams.find((stream) => stream.status === 'open');
+        if (stream) {
+            this.logger.debug('Reusing existing stream for address: ' +
+                this.nextHopAddress.toString());
+            return stream;
+        }
+        this.logger.debug('Creating new stream for address: ' + this.nextHopAddress.toString());
+        return super.getOrCreateStream();
+    }
+    async postTransmit(stream) {
+        // do nothing as we don't want to close the stream
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './o-limited.tool.js';
+export * from './connection/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './o-limited.tool.js';
+export * from './connection/index.js';

package/dist/src/o-limited.tool.d.ts

@@ -0,0 +1,5 @@
+import { oNodeTool } from '@olane/o-node';
+export declare class oLimitedTool extends oNodeTool {
+    initConnectionManager(): Promise<void>;
+}
+//# sourceMappingURL=o-limited.tool.d.ts.map

package/dist/src/o-limited.tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o-limited.tool.d.ts","sourceRoot":"","sources":["../../src/o-limited.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C,qBAAa,YAAa,SAAQ,SAAS;IACnC,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7C"}

package/dist/src/o-limited.tool.js

@@ -0,0 +1,12 @@
+import { oNodeTool } from '@olane/o-node';
+import { oLimitedConnectionManager } from './connection/o-limited-connection-manager.js';
+export class oLimitedTool extends oNodeTool {
+    async initConnectionManager() {
+        this.connectionManager = new oLimitedConnectionManager({
+            p2pNode: this.p2pNode,
+            defaultReadTimeoutMs: this.config.connectionTimeouts?.readTimeoutMs,
+            defaultDrainTimeoutMs: this.config.connectionTimeouts?.drainTimeoutMs,
+            runOnLimitedConnection: this.config.runOnLimitedConnection ?? false,
+        });
+    }
+}

package/dist/test/method.spec.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=method.spec.d.ts.map

package/dist/test/method.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"method.spec.d.ts","sourceRoot":"","sources":["../../test/method.spec.ts"],"names":[],"mappings":""}

package/dist/test/method.spec.js

@@ -0,0 +1,29 @@
+"use strict";
+// import { oAddress, NodeState, oRequest } from '@olane/o-core';
+// import { oVirtualTool } from '../src/virtual.tool.js';
+// import { expect } from 'chai';
+// describe('o-tool @methods', () => {
+//   it('should call the hello_world method', async () => {
+//     const node = new oVirtualTool({
+//       address: new oAddress('o://test'),
+//       leader: null,
+//       parent: null,
+//     });
+//     await node.start();
+//     expect(node.state).to.equal(NodeState.RUNNING);
+//     // call the tool
+//     const req = new oRequest({
+//       method: 'hello_world',
+//       id: '123',
+//       params: {
+//         _connectionId: '123',
+//         _requestMethod: 'hello_world',
+//       },
+//     });
+//     const data = await node.callMyTool(req);
+//     expect(data.message).to.equal('Hello, world!');
+//     // stop the node
+//     await node.stop();
+//     expect(node.state).to.equal(NodeState.STOPPED);
+//   });
+// });

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@olane/o-client-limited",
+  "version": "0.7.12-alpha.51",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "aegir test",
+    "test:node": "aegir test -t node",
+    "test:browser": "aegir test -t browser",
+    "build": "tsc",
+    "deep:clean": "rm -rf node_modules && rm package-lock.json",
+    "start:prod": "node dist/index.js",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src/**/*.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/olane-labs/olane.git"
+  },
+  "author": "oLane Inc.",
+  "license": "(MIT OR Apache-2.0)",
+  "description": "oLane client limited connection manager",
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.29.0",
+    "@tsconfig/node20": "^20.1.6",
+    "@types/jest": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.34.1",
+    "@typescript-eslint/parser": "^8.34.1",
+    "aegir": "^47.0.21",
+    "eslint": "^9.29.0",
+    "eslint-config-prettier": "^10.1.6",
+    "eslint-plugin-prettier": "^5.5.0",
+    "globals": "^16.2.0",
+    "jest": "^30.0.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "tsx": "^4.20.3",
+    "typescript": "5.4.5"
+  },
+  "dependencies": {
+    "@olane/o-config": "0.7.12-alpha.51",
+    "@olane/o-core": "0.7.12-alpha.51",
+    "@olane/o-lane": "0.7.12-alpha.51",
+    "@olane/o-protocol": "0.7.12-alpha.51",
+    "@olane/o-tool": "0.7.12-alpha.51",
+    "debug": "^4.4.1",
+    "dotenv": "^16.5.0"
+  },
+  "gitHead": "b877e1e95a2bf32845ec30072eb72422fd25aba7"
+}