@devbookhq/sdk - npm Package Compare versions

Comparing version 2.3.17 to 2.3.18

dist/cjs/index.d.ts

 export { default as Session } from './session';
 export type { SessionOpts, } from './session';
-export { CodeSnippetExecState, OutType, } from './session/codeSnippet';
-export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OutResponse, OutStdoutResponse, OutStderrResponse, OpenedPort, EnvVars } from './session/codeSnippet';
+export { CodeSnippetExecState, } from './session/codeSnippet';
+export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OpenedPort, } from './session/codeSnippet';
+export type { OutResponse, OutStderrResponse, OutStdoutResponse, } from './session/out';
+export { OutType, } from './session/out';
 export type { TerminalManager, TerminalSession, ChildProcess, } from './session/terminal';
 export type { FilesystemManager, FileInfo, } from './session/filesystem';
+export type { Process, ProcessManager, } from './session/process';
+export type { EnvVars, } from './session/envVars';
 export { default as api } from './api';
 export type { components, paths, } from './api';

dist/cjs/index.js

@@ -1,2 +0,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var s=require("rpc-websocket-client");require("cross-fetch/polyfill");var i=require("openapi-typescript-fetch");function e(s,i,e,t){return new(e||(e=Promise))((function(o,n){function r(s){try{c(t.next(s))}catch(s){n(s)}}function l(s){try{c(t.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof e?i:new e((function(s){s(i)}))).then(r,l)}c((t=t.apply(s,i||[])).next())}))}const t=i.Fetcher.for();function o(s){return new Promise((i=>setTimeout(i,s)))}t.configure({baseUrl:"https://ondevbook.com"});class n{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const r=t.path("/sessions").method("post").create({api_key:!0}),l=t.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});var c,h;exports.CodeSnippetExecState=void 0,(c=exports.CodeSnippetExecState||(exports.CodeSnippetExecState={})).Running="Running",c.Stopped="Stopped",exports.OutType=void 0,(h=exports.OutType||(exports.OutType={})).Stdout="Stdout",h.Stderr="Stderr";exports.Session=class extends class{constructor(i){this.opts=i,this.isOpen=!1,this.rpc=new s.RpcWebSocketClient,this.subscribers=[],this.logger=new n("Session",i.debug),this.logger.log(`Session for code snippet "${i.id}" initialized`)}call(s,i){return e(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return e(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...t){return e(this,void 0,void 0,(function*(){const e=yield this.call(`${s}_subscribe`,t);if("string"!=typeof e)throw new Error(`Cannot subscribe to ${s} with params ${t}. Expected response to be a subscription ID, instead got ${JSON.stringify(e)}`);return this.subscribers.push({subscriptionID:e,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${t}" with id "${e}"`),e}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,t;return e(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(t=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===t||t.call(i),this.logger.log("Disconected from the session")}}))}open(){return e(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield r({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof r.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,t,n=!1;const l=new Promise(((s,e)=>{i=()=>{n||(n=!0,s())},t=()=>{n||(n=!0,e())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>e(this,void 0,void 0,(function*(){var e,n,r,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(n=(e=this.opts).onDisconnect)||void 0===n||n.call(e),yield o(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(r=this.opts).onReconnect)||void 0===l||l.call(r),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==t||t()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield l}))}handleNotification(s){this.subscribers.filter((i=>{var e;return i.subscriptionID===(null===(e=s.params)||void 0===e?void 0:e.subscription)})).forEach((i=>{var e;return i.handler(null===(e=s.params)||void 0===e?void 0:e.result)}))}refresh(s){return e(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield o(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield l({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof l.Error){const e=i.getActualType();if(404===e.status)return void this.logger.error(`Error refreshing session - (${e.status}): ${e.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${e.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,t,o,n;return e(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStderr)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(o=this.codeSnippetOpts)||void 0===o?void 0:o.onStdout)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe("codeSnippet",this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>e(this,void 0,void 0,(function*(){var e,t;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(t=null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStateChange)||void 0===t||t.call(e,o),this.logger.log("Started running code",s),o})),stop:()=>e(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const e=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,e),this.logger.log("Stopped running code"),e}))},this.filesystem={listAllFiles:s=>e(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>e(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>e(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>e(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>e(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,t,o)=>e(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[o||"",t.cols,t.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const r=yield this.subscribe("terminal",s,"onData",n),l=i?yield this.subscribe("terminal",i,"onChildProcessesChange",n):void 0;return{terminalID:n,destroy:()=>e(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>e(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>e(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))}}))}},exports.api=t;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var s=require("rpc-websocket-client");require("cross-fetch/polyfill");var i=require("openapi-typescript-fetch");function t(s,i,t,e){return new(t||(t=Promise))((function(o,n){function r(s){try{c(e.next(s))}catch(s){n(s)}}function l(s){try{c(e.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof t?i:new t((function(s){s(i)}))).then(r,l)}c((e=e.apply(s,i||[])).next())}))}const e=i.Fetcher.for();function o(s){return new Promise((i=>setTimeout(i,s)))}e.configure({baseUrl:"https://ondevbook.com"});class n{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const r=e.path("/sessions").method("post").create({api_key:!0}),l=e.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});var c;exports.CodeSnippetExecState=void 0,(c=exports.CodeSnippetExecState||(exports.CodeSnippetExecState={})).Running="Running",c.Stopped="Stopped";var h;exports.OutType=void 0,(h=exports.OutType||(exports.OutType={})).Stdout="Stdout",h.Stderr="Stderr",exports.Session=class extends class{constructor(i){this.opts=i,this.isOpen=!1,this.rpc=new s.RpcWebSocketClient,this.subscribers=[],this.logger=new n("Session",i.debug),this.logger.log(`Session for code snippet "${i.id}" initialized`)}call(s,i){return t(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return t(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...e){return t(this,void 0,void 0,(function*(){const t=yield this.call(`${s}_subscribe`,e);if("string"!=typeof t)throw new Error(`Cannot subscribe to ${s} with params ${e}. Expected response to be a subscription ID, instead got ${JSON.stringify(t)}`);return this.subscribers.push({subscriptionID:t,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${e}" with id "${t}"`),t}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,e;return t(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(e=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===e||e.call(i),this.logger.log("Disconected from the session")}}))}open(){return t(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield r({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof r.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,e,n=!1;const l=new Promise(((s,t)=>{i=()=>{n||(n=!0,s())},e=()=>{n||(n=!0,t())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>t(this,void 0,void 0,(function*(){var t,n,r,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(n=(t=this.opts).onDisconnect)||void 0===n||n.call(t),yield o(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(r=this.opts).onReconnect)||void 0===l||l.call(r),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==e||e()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield l}))}handleNotification(s){this.subscribers.filter((i=>{var t;return i.subscriptionID===(null===(t=s.params)||void 0===t?void 0:t.subscription)})).forEach((i=>{var t;return i.handler(null===(t=s.params)||void 0===t?void 0:t.result)}))}refresh(s){return t(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield o(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield l({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof l.Error){const t=i.getActualType();if(404===t.status)return void this.logger.error(`Error refreshing session - (${t.status}): ${t.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${t.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,e,o,n;return t(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStderr)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(o=this.codeSnippetOpts)||void 0===o?void 0:o.onStdout)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe("codeSnippet",this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>t(this,void 0,void 0,(function*(){var t,e;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(e=null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStateChange)||void 0===e||e.call(t,o),this.logger.log("Started running code",s),o})),stop:()=>t(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const t=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,t),this.logger.log("Stopped running code"),t}))},this.filesystem={listAllFiles:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,e,o)=>t(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[o||"",e.cols,e.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const[r,l]=yield Promise.all([this.subscribe("terminal",s,"onData",n),i?this.subscribe("terminal",i,"onChildProcessesChange",n):void 0]);return{terminalID:n,destroy:()=>t(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>t(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))},this.process={start:(s,i,e,o={},n="/",r)=>t(this,void 0,void 0,(function*(){try{const l=yield this.call("process_start",[r||"",s,o,n]);if("string"!=typeof l)throw new Error("Cannot start process");const[c,h]=yield Promise.all([i?this.subscribe("process",i,"onStdout",l):void 0,e?this.subscribe("process",e,"onStderr",l):void 0]);return{processID:l,kill:()=>t(this,void 0,void 0,(function*(){yield Promise.all([c?this.unsubscribe(c):void 0,h?this.unsubscribe(h):void 0,this.call("terminal_kill",[l])])})),sendStdin:s=>t(this,void 0,void 0,(function*(){yield this.call("process_stdin",[l,s])}))}}catch(s){throw this.logger.error(s),new Error("Error starting process",s)}}))}}))}},exports.api=e;
 //# sourceMappingURL=index.js.map

dist/cjs/session/codeSnippet.d.ts

@@ -0,1 +1,3 @@
+import { OutStderrResponse, OutStdoutResponse } from './out';
+import { EnvVars } from './envVars';
 export declare const codeSnippetMethod = "codeSnippet";
@@ -6,20 +8,2 @@ export declare enum CodeSnippetExecState {
 }
-export declare enum OutType {
-    Stdout = "Stdout",
-    Stderr = "Stderr"
-}
-export declare type EnvVars = {
-    [key: string]: string;
-};
-export interface OutResponse {
-    type: OutType;
-    timestamp: number;
-    line: string;
-}
-export interface OutStdoutResponse extends OutResponse {
-    type: OutType.Stdout;
-}
-export interface OutStderrResponse extends OutResponse {
-    type: OutType.Stderr;
-}
 export interface OpenedPort {
@@ -26,0 +10,0 @@ State: string;

dist/cjs/session/index.d.ts

@@ -5,2 +5,3 @@ import SessionConnection, { SessionConnectionOpts } from './sessionConnection';
 import { FilesystemManager } from './filesystem';
+import { ProcessManager } from './process';
 export interface CodeSnippetOpts {
@@ -20,2 +21,3 @@ onStateChange?: CodeSnippetStateHandler;
     filesystem?: FilesystemManager;
+    process?: ProcessManager;
     constructor(opts: SessionOpts);
@@ -22,0 +24,0 @@ open(): Promise<void>;

dist/cjs/session/sessionConnection.d.ts

@@ -27,4 +27,22 @@ import { components } from '../api';
     protected subscribe(method: string, handler: SubscriptionHandler, ...params: any): Promise<string>;
+    /**
+     * Get the hostname for the session or for the specified session's port.
+     *
+     * `getHostname` method requires `this` context - you may need to bind it.
+     *
+     * @param port specify if you want to connect to a specific port of the session
+     * @returns hostname of the session or session's port
+     */
     getHostname(port?: number): string;
+    /**
+     * Close the connection to the session
+     *
+     * `close` method requires `this` context - you may need to bind it.
+     */
     close(): Promise<void>;
+    /**
+     * Open a connection to a new session
+     *
+     * `open` method requires `this` context - you may need to bind it.
+     */
     open(): Promise<void>;
@@ -31,0 +49,0 @@ private handleNotification;

dist/esm/index.d.ts

 export { default as Session } from './session';
 export type { SessionOpts, } from './session';
-export { CodeSnippetExecState, OutType, } from './session/codeSnippet';
-export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OutResponse, OutStdoutResponse, OutStderrResponse, OpenedPort, EnvVars } from './session/codeSnippet';
+export { CodeSnippetExecState, } from './session/codeSnippet';
+export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OpenedPort, } from './session/codeSnippet';
+export type { OutResponse, OutStderrResponse, OutStdoutResponse, } from './session/out';
+export { OutType, } from './session/out';
 export type { TerminalManager, TerminalSession, ChildProcess, } from './session/terminal';
 export type { FilesystemManager, FileInfo, } from './session/filesystem';
+export type { Process, ProcessManager, } from './session/process';
+export type { EnvVars, } from './session/envVars';
 export { default as api } from './api';
 export type { components, paths, } from './api';

dist/esm/index.js

@@ -1,2 +0,2 @@
-import{RpcWebSocketClient as s}from"rpc-websocket-client";import"cross-fetch/polyfill";import{Fetcher as i}from"openapi-typescript-fetch";function t(s,i,t,e){return new(t||(t=Promise))((function(o,n){function r(s){try{c(e.next(s))}catch(s){n(s)}}function l(s){try{c(e.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof t?i:new t((function(s){s(i)}))).then(r,l)}c((e=e.apply(s,i||[])).next())}))}const e=i.for();function o(s){return new Promise((i=>setTimeout(i,s)))}e.configure({baseUrl:"https://ondevbook.com"});class n{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const r=e.path("/sessions").method("post").create({api_key:!0}),l=e.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});var c,h;!function(s){s.Running="Running",s.Stopped="Stopped"}(c||(c={})),function(s){s.Stdout="Stdout",s.Stderr="Stderr"}(h||(h={}));class d extends class{constructor(i){this.opts=i,this.isOpen=!1,this.rpc=new s,this.subscribers=[],this.logger=new n("Session",i.debug),this.logger.log(`Session for code snippet "${i.id}" initialized`)}call(s,i){return t(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return t(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...e){return t(this,void 0,void 0,(function*(){const t=yield this.call(`${s}_subscribe`,e);if("string"!=typeof t)throw new Error(`Cannot subscribe to ${s} with params ${e}. Expected response to be a subscription ID, instead got ${JSON.stringify(t)}`);return this.subscribers.push({subscriptionID:t,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${e}" with id "${t}"`),t}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,e;return t(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(e=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===e||e.call(i),this.logger.log("Disconected from the session")}}))}open(){return t(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield r({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof r.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,e,n=!1;const l=new Promise(((s,t)=>{i=()=>{n||(n=!0,s())},e=()=>{n||(n=!0,t())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>t(this,void 0,void 0,(function*(){var t,n,r,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(n=(t=this.opts).onDisconnect)||void 0===n||n.call(t),yield o(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(r=this.opts).onReconnect)||void 0===l||l.call(r),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==e||e()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield l}))}handleNotification(s){this.subscribers.filter((i=>{var t;return i.subscriptionID===(null===(t=s.params)||void 0===t?void 0:t.subscription)})).forEach((i=>{var t;return i.handler(null===(t=s.params)||void 0===t?void 0:t.result)}))}refresh(s){return t(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield o(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield l({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof l.Error){const t=i.getActualType();if(404===t.status)return void this.logger.error(`Error refreshing session - (${t.status}): ${t.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${t.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,e,o,n;return t(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStderr)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(o=this.codeSnippetOpts)||void 0===o?void 0:o.onStdout)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe("codeSnippet",this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>t(this,void 0,void 0,(function*(){var t,e;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(e=null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStateChange)||void 0===e||e.call(t,o),this.logger.log("Started running code",s),o})),stop:()=>t(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const t=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,t),this.logger.log("Stopped running code"),t}))},this.filesystem={listAllFiles:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,e,o)=>t(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[o||"",e.cols,e.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const r=yield this.subscribe("terminal",s,"onData",n),l=i?yield this.subscribe("terminal",i,"onChildProcessesChange",n):void 0;return{terminalID:n,destroy:()=>t(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>t(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))}}))}}export{c as CodeSnippetExecState,h as OutType,d as Session,e as api};
+import{RpcWebSocketClient as s}from"rpc-websocket-client";import"cross-fetch/polyfill";import{Fetcher as i}from"openapi-typescript-fetch";function t(s,i,t,e){return new(t||(t=Promise))((function(o,n){function r(s){try{c(e.next(s))}catch(s){n(s)}}function l(s){try{c(e.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof t?i:new t((function(s){s(i)}))).then(r,l)}c((e=e.apply(s,i||[])).next())}))}const e=i.for();function o(s){return new Promise((i=>setTimeout(i,s)))}e.configure({baseUrl:"https://ondevbook.com"});class n{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const r=e.path("/sessions").method("post").create({api_key:!0}),l=e.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});var c;!function(s){s.Running="Running",s.Stopped="Stopped"}(c||(c={}));class h extends class{constructor(i){this.opts=i,this.isOpen=!1,this.rpc=new s,this.subscribers=[],this.logger=new n("Session",i.debug),this.logger.log(`Session for code snippet "${i.id}" initialized`)}call(s,i){return t(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return t(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...e){return t(this,void 0,void 0,(function*(){const t=yield this.call(`${s}_subscribe`,e);if("string"!=typeof t)throw new Error(`Cannot subscribe to ${s} with params ${e}. Expected response to be a subscription ID, instead got ${JSON.stringify(t)}`);return this.subscribers.push({subscriptionID:t,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${e}" with id "${t}"`),t}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,e;return t(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(e=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===e||e.call(i),this.logger.log("Disconected from the session")}}))}open(){return t(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield r({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof r.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,e,n=!1;const l=new Promise(((s,t)=>{i=()=>{n||(n=!0,s())},e=()=>{n||(n=!0,t())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>t(this,void 0,void 0,(function*(){var t,n,r,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(n=(t=this.opts).onDisconnect)||void 0===n||n.call(t),yield o(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(r=this.opts).onReconnect)||void 0===l||l.call(r),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==e||e()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield l}))}handleNotification(s){this.subscribers.filter((i=>{var t;return i.subscriptionID===(null===(t=s.params)||void 0===t?void 0:t.subscription)})).forEach((i=>{var t;return i.handler(null===(t=s.params)||void 0===t?void 0:t.result)}))}refresh(s){return t(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield o(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield l({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof l.Error){const t=i.getActualType();if(404===t.status)return void this.logger.error(`Error refreshing session - (${t.status}): ${t.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${t.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,e,o,n;return t(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStderr)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(o=this.codeSnippetOpts)||void 0===o?void 0:o.onStdout)?this.subscribe("codeSnippet",this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe("codeSnippet",this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>t(this,void 0,void 0,(function*(){var t,e;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(e=null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStateChange)||void 0===e||e.call(t,o),this.logger.log("Started running code",s),o})),stop:()=>t(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const t=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,t),this.logger.log("Stopped running code"),t}))},this.filesystem={listAllFiles:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>t(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,e,o)=>t(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[o||"",e.cols,e.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const[r,l]=yield Promise.all([this.subscribe("terminal",s,"onData",n),i?this.subscribe("terminal",i,"onChildProcessesChange",n):void 0]);return{terminalID:n,destroy:()=>t(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>t(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>t(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))},this.process={start:(s,i,e,o={},n="/",r)=>t(this,void 0,void 0,(function*(){try{const l=yield this.call("process_start",[r||"",s,o,n]);if("string"!=typeof l)throw new Error("Cannot start process");const[c,h]=yield Promise.all([i?this.subscribe("process",i,"onStdout",l):void 0,e?this.subscribe("process",e,"onStderr",l):void 0]);return{processID:l,kill:()=>t(this,void 0,void 0,(function*(){yield Promise.all([c?this.unsubscribe(c):void 0,h?this.unsubscribe(h):void 0,this.call("terminal_kill",[l])])})),sendStdin:s=>t(this,void 0,void 0,(function*(){yield this.call("process_stdin",[l,s])}))}}catch(s){throw this.logger.error(s),new Error("Error starting process",s)}}))}}))}}var d;!function(s){s.Stdout="Stdout",s.Stderr="Stderr"}(d||(d={}));export{c as CodeSnippetExecState,d as OutType,h as Session,e as api};
 //# sourceMappingURL=index.js.map

dist/esm/session/codeSnippet.d.ts

@@ -0,1 +1,3 @@
+import { OutStderrResponse, OutStdoutResponse } from './out';
+import { EnvVars } from './envVars';
 export declare const codeSnippetMethod = "codeSnippet";
@@ -6,20 +8,2 @@ export declare enum CodeSnippetExecState {
 }
-export declare enum OutType {
-    Stdout = "Stdout",
-    Stderr = "Stderr"
-}
-export declare type EnvVars = {
-    [key: string]: string;
-};
-export interface OutResponse {
-    type: OutType;
-    timestamp: number;
-    line: string;
-}
-export interface OutStdoutResponse extends OutResponse {
-    type: OutType.Stdout;
-}
-export interface OutStderrResponse extends OutResponse {
-    type: OutType.Stderr;
-}
 export interface OpenedPort {
@@ -26,0 +10,0 @@ State: string;

dist/esm/session/index.d.ts

@@ -5,2 +5,3 @@ import SessionConnection, { SessionConnectionOpts } from './sessionConnection';
 import { FilesystemManager } from './filesystem';
+import { ProcessManager } from './process';
 export interface CodeSnippetOpts {
@@ -20,2 +21,3 @@ onStateChange?: CodeSnippetStateHandler;
     filesystem?: FilesystemManager;
+    process?: ProcessManager;
     constructor(opts: SessionOpts);
@@ -22,0 +24,0 @@ open(): Promise<void>;

dist/esm/session/sessionConnection.d.ts

@@ -27,4 +27,22 @@ import { components } from '../api';
     protected subscribe(method: string, handler: SubscriptionHandler, ...params: any): Promise<string>;
+    /**
+     * Get the hostname for the session or for the specified session's port.
+     *
+     * `getHostname` method requires `this` context - you may need to bind it.
+     *
+     * @param port specify if you want to connect to a specific port of the session
+     * @returns hostname of the session or session's port
+     */
     getHostname(port?: number): string;
+    /**
+     * Close the connection to the session
+     *
+     * `close` method requires `this` context - you may need to bind it.
+     */
     close(): Promise<void>;
+    /**
+     * Open a connection to a new session
+     *
+     * `open` method requires `this` context - you may need to bind it.
+     */
     open(): Promise<void>;
@@ -31,0 +49,0 @@ private handleNotification;

dist/umd/index.d.ts

 export { default as Session } from './session';
 export type { SessionOpts, } from './session';
-export { CodeSnippetExecState, OutType, } from './session/codeSnippet';
-export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OutResponse, OutStdoutResponse, OutStderrResponse, OpenedPort, EnvVars } from './session/codeSnippet';
+export { CodeSnippetExecState, } from './session/codeSnippet';
+export type { CodeSnippetManager, CodeSnippetStateHandler, CodeSnippetStderrHandler, CodeSnippetStdoutHandler, CodeSnippetSubscriptionHandler, CodeSnippetSubscriptionHandlerType, OpenedPort, } from './session/codeSnippet';
+export type { OutResponse, OutStderrResponse, OutStdoutResponse, } from './session/out';
+export { OutType, } from './session/out';
 export type { TerminalManager, TerminalSession, ChildProcess, } from './session/terminal';
 export type { FilesystemManager, FileInfo, } from './session/filesystem';
+export type { Process, ProcessManager, } from './session/process';
+export type { EnvVars, } from './session/envVars';
 export { default as api } from './api';
 export type { components, paths, } from './api';

dist/umd/index.js

@@ -1,2 +0,2 @@
-!function(s,i){"object"==typeof exports&&"undefined"!=typeof module?i(exports,require("rpc-websocket-client"),require("cross-fetch/polyfill"),require("openapi-typescript-fetch")):"function"==typeof define&&define.amd?define(["exports","rpc-websocket-client","cross-fetch/polyfill","openapi-typescript-fetch"],i):i((s="undefined"!=typeof globalThis?globalThis:s||self)["@devbookhq/sdk"]={},s.rpcWebsocketClient,null,s.openapiTypescriptFetch)}(this,(function(s,i,e,t){"use strict";function o(s,i,e,t){return new(e||(e=Promise))((function(o,n){function r(s){try{c(t.next(s))}catch(s){n(s)}}function l(s){try{c(t.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof e?i:new e((function(s){s(i)}))).then(r,l)}c((t=t.apply(s,i||[])).next())}))}const n=t.Fetcher.for();function r(s){return new Promise((i=>setTimeout(i,s)))}n.configure({baseUrl:"https://ondevbook.com"});class l{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const c=n.path("/sessions").method("post").create({api_key:!0}),h=n.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});const d="codeSnippet";var a,p;s.CodeSnippetExecState=void 0,(a=s.CodeSnippetExecState||(s.CodeSnippetExecState={})).Running="Running",a.Stopped="Stopped",s.OutType=void 0,(p=s.OutType||(s.OutType={})).Stdout="Stdout",p.Stderr="Stderr";const u="terminal";s.Session=class extends class{constructor(s){this.opts=s,this.isOpen=!1,this.rpc=new i.RpcWebSocketClient,this.subscribers=[],this.logger=new l("Session",s.debug),this.logger.log(`Session for code snippet "${s.id}" initialized`)}call(s,i){return o(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return o(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...e){return o(this,void 0,void 0,(function*(){const t=yield this.call(`${s}_subscribe`,e);if("string"!=typeof t)throw new Error(`Cannot subscribe to ${s} with params ${e}. Expected response to be a subscription ID, instead got ${JSON.stringify(t)}`);return this.subscribers.push({subscriptionID:t,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${e}" with id "${t}"`),t}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,e;return o(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(e=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===e||e.call(i),this.logger.log("Disconected from the session")}}))}open(){return o(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield c({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof c.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,e,t=!1;const n=new Promise(((s,o)=>{i=()=>{t||(t=!0,s())},e=()=>{t||(t=!0,o())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>o(this,void 0,void 0,(function*(){var t,o,n,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(o=(t=this.opts).onDisconnect)||void 0===o||o.call(t),yield r(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(n=this.opts).onReconnect)||void 0===l||l.call(n),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==e||e()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield n}))}handleNotification(s){this.subscribers.filter((i=>{var e;return i.subscriptionID===(null===(e=s.params)||void 0===e?void 0:e.subscription)})).forEach((i=>{var e;return i.handler(null===(e=s.params)||void 0===e?void 0:e.result)}))}refresh(s){return o(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield r(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield h({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof h.Error){const e=i.getActualType();if(404===e.status)return void this.logger.error(`Error refreshing session - (${e.status}): ${e.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${e.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,e,t,n;return o(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe(d,this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStderr)?this.subscribe(d,this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStdout)?this.subscribe(d,this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe(d,this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>o(this,void 0,void 0,(function*(){var e,t;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(t=null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStateChange)||void 0===t||t.call(e,o),this.logger.log("Started running code",s),o})),stop:()=>o(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const e=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,e),this.logger.log("Stopped running code"),e}))},this.filesystem={listAllFiles:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>o(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,e,t)=>o(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[t||"",e.cols,e.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const r=yield this.subscribe(u,s,"onData",n),l=i?yield this.subscribe(u,i,"onChildProcessesChange",n):void 0;return{terminalID:n,destroy:()=>o(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>o(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>o(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))}}))}},s.api=n,Object.defineProperty(s,"__esModule",{value:!0})}));
+!function(s,i){"object"==typeof exports&&"undefined"!=typeof module?i(exports,require("rpc-websocket-client"),require("cross-fetch/polyfill"),require("openapi-typescript-fetch")):"function"==typeof define&&define.amd?define(["exports","rpc-websocket-client","cross-fetch/polyfill","openapi-typescript-fetch"],i):i((s="undefined"!=typeof globalThis?globalThis:s||self)["@devbookhq/sdk"]={},s.rpcWebsocketClient,null,s.openapiTypescriptFetch)}(this,(function(s,i,e,t){"use strict";function o(s,i,e,t){return new(e||(e=Promise))((function(o,n){function r(s){try{c(t.next(s))}catch(s){n(s)}}function l(s){try{c(t.throw(s))}catch(s){n(s)}}function c(s){var i;s.done?o(s.value):(i=s.value,i instanceof e?i:new e((function(s){s(i)}))).then(r,l)}c((t=t.apply(s,i||[])).next())}))}const n=t.Fetcher.for();function r(s){return new Promise((i=>setTimeout(i,s)))}n.configure({baseUrl:"https://ondevbook.com"});class l{constructor(s,i=!1){this.logID=s,this.isEnabled=i}id(){return"function"==typeof this.logID?this.logID():this.logID}log(...s){this.isEnabled&&console.log(`[${this.id()}]`,...s)}error(...s){console.error(`[${this.id()} ERROR]`,...s)}}const c=n.path("/sessions").method("post").create({api_key:!0}),h=n.path("/sessions/{sessionID}/refresh").method("post").create({api_key:!0});const d="codeSnippet";var a;s.CodeSnippetExecState=void 0,(a=s.CodeSnippetExecState||(s.CodeSnippetExecState={})).Running="Running",a.Stopped="Stopped";const p="terminal",u="process";var g;s.OutType=void 0,(g=s.OutType||(s.OutType={})).Stdout="Stdout",g.Stderr="Stderr",s.Session=class extends class{constructor(s){this.opts=s,this.isOpen=!1,this.rpc=new i.RpcWebSocketClient,this.subscribers=[],this.logger=new l("Session",s.debug),this.logger.log(`Session for code snippet "${s.id}" initialized`)}call(s,i){return o(this,void 0,void 0,(function*(){return this.rpc.call(s,i)}))}unsubscribe(s){return o(this,void 0,void 0,(function*(){const i=this.subscribers.find((i=>i.subscriptionID===s));i&&(yield this.call(`${i.method}_unsubscribe`,[null==i?void 0:i.subscriptionID]),this.subscribers=this.subscribers.filter((s=>s!==i)),this.logger.log(`Unsubscribed from "${i.method}"`))}))}subscribe(s,i,...e){return o(this,void 0,void 0,(function*(){const t=yield this.call(`${s}_subscribe`,e);if("string"!=typeof t)throw new Error(`Cannot subscribe to ${s} with params ${e}. Expected response to be a subscription ID, instead got ${JSON.stringify(t)}`);return this.subscribers.push({subscriptionID:t,handler:i,method:s}),this.logger.log(`Subscribed to "${s}_${e}" with id "${t}"`),t}))}getHostname(s){if(!this.isOpen||!this.session)throw new Error("Session is not active");const i=`${this.session.sessionID}-${this.session.clientID}.ondevbook.com`;return s?`${s}-${i}`:i}close(){var s,i,e;return o(this,void 0,void 0,(function*(){if(this.isOpen){this.logger.log("Closing",this.session),this.isOpen=!1,this.logger.log("Unsubscribing...");(yield Promise.allSettled(this.subscribers.map((s=>this.unsubscribe(s.subscriptionID))))).forEach((s=>{"rejected"===s.status&&this.logger.log(`Failed to unsubscribe: "${s.reason}"`)})),null===(s=this.rpc.ws)||void 0===s||s.close(),null===(e=null===(i=this.opts)||void 0===i?void 0:i.onClose)||void 0===e||e.call(i),this.logger.log("Disconected from the session")}}))}open(){return o(this,void 0,void 0,(function*(){if(this.isOpen||this.session)throw new Error("Session connect was already called");this.isOpen=!0;try{const s=yield c({codeSnippetID:this.opts.id,editEnabled:this.opts.editEnabled,api_key:this.opts.apiKey});this.session=s.data,this.logger.log("Aquired session:",this.session),this.refresh(this.session.sessionID)}catch(s){if(s instanceof c.Error){const i=s.getActualType();if(400===i.status)throw new Error(`Error creating session - (${i.status}) bad request: ${i.data.message}`);if(401===i.status)throw new Error(`Error creating session - (${i.status}) unauthenticated (you need to be authenticated to start an session with persistent edits): ${i.data.message}`);if(500===i.status)throw new Error(`Error creating session - (${i.status}) server error: ${i.data.message}`);throw s}}if(!this.session)throw new Error("Session is not defined");const s=`wss://${this.getHostname(8010)}/ws`;this.rpc.onError((s=>{this.logger.log("Error in WS session:",this.session,s)}));let i,e,t=!1;const n=new Promise(((s,o)=>{i=()=>{t||(t=!0,s())},e=()=>{t||(t=!0,o())}}));this.rpc.onOpen((()=>{this.logger.log("Connected to session:",this.session),null==i||i()})),this.rpc.onClose((i=>o(this,void 0,void 0,(function*(){var t,o,n,l;if(this.logger.log("Closing WS connection to session:",this.session,i),this.isOpen){null===(o=(t=this.opts).onDisconnect)||void 0===o||o.call(t),yield r(100),this.logger.log("Reconnecting to session:",this.session);try{yield this.rpc.connect(s),null===(l=(n=this.opts).onReconnect)||void 0===l||l.call(n),this.logger.log("Reconnected to session:",this.session)}catch(s){this.logger.log("Failed reconnecting to session:",this.session,s)}}else null==e||e()})))),this.rpc.onNotification.push(this.handleNotification.bind(this));try{this.logger.log("Connection to session:",this.session),yield this.rpc.connect(s)}catch(s){this.logger.log("Error connecting to session",this.session,s)}yield n}))}handleNotification(s){this.subscribers.filter((i=>{var e;return i.subscriptionID===(null===(e=s.params)||void 0===e?void 0:e.subscription)})).forEach((i=>{var e;return i.handler(null===(e=s.params)||void 0===e?void 0:e.result)}))}refresh(s){return o(this,void 0,void 0,(function*(){this.logger.log(`Started refreshing session "${s}"`);try{for(;;){if(!this.isOpen)return void this.logger.log("Cannot refresh session - it was closed",this.session);yield r(5e3);try{this.logger.log(`Refreshed session "${s}"`),yield h({sessionID:s,api_key:this.opts.apiKey})}catch(i){if(i instanceof h.Error){const e=i.getActualType();if(404===e.status)return void this.logger.error(`Error refreshing session - (${e.status}): ${e.data.message}`);this.logger.error(`Refreshing session "${s}" failed - (${e.status})`)}}}}finally{this.logger.log(`Stopped refreshing session "${s}"`),this.close()}}))}}{constructor(s){super(s),this.codeSnippetOpts=s.codeSnippet}open(){const s=Object.create(null,{open:{get:()=>super.open}});var i,e,t,n;return o(this,void 0,void 0,(function*(){yield s.open.call(this),yield Promise.all([(null===(i=this.codeSnippetOpts)||void 0===i?void 0:i.onStateChange)?this.subscribe(d,this.codeSnippetOpts.onStateChange,"state"):Promise.resolve(),(null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStderr)?this.subscribe(d,this.codeSnippetOpts.onStderr,"stderr"):Promise.resolve(),(null===(t=this.codeSnippetOpts)||void 0===t?void 0:t.onStdout)?this.subscribe(d,this.codeSnippetOpts.onStdout,"stdout"):Promise.resolve(),(null===(n=this.codeSnippetOpts)||void 0===n?void 0:n.onScanPorts)?this.subscribe(d,this.codeSnippetOpts.onScanPorts,"scanOpenedPorts"):Promise.resolve()]),this.codeSnippet={run:(s,i={})=>o(this,void 0,void 0,(function*(){var e,t;if(!this.isOpen||!this.session)throw new Error("Session is not active");const o=yield this.call("codeSnippet_run",[s,i]);return null===(t=null===(e=this.codeSnippetOpts)||void 0===e?void 0:e.onStateChange)||void 0===t||t.call(e,o),this.logger.log("Started running code",s),o})),stop:()=>o(this,void 0,void 0,(function*(){var s,i;if(!this.isOpen||!this.session)throw new Error("Session is not active");const e=yield this.call("codeSnippet_stop");return null===(i=null===(s=this.codeSnippetOpts)||void 0===s?void 0:s.onStateChange)||void 0===i||i.call(s,e),this.logger.log("Stopped running code"),e}))},this.filesystem={listAllFiles:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_listAllFiles",[s])})),removeFile:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_removeFile",[s])})),writeFile:(s,i)=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");yield this.call("filesystem_writeFile",[s,i])})),readFile:s=>o(this,void 0,void 0,(function*(){if(!this.isOpen||!this.session)throw new Error("Session is not active");return yield this.call("filesystem_readFile",[s])}))},this.terminal={killProcess:s=>o(this,void 0,void 0,(function*(){yield this.call("terminal_killProcess",[s])})),createSession:(s,i,e,t)=>o(this,void 0,void 0,(function*(){try{const n=yield this.call("terminal_start",[t||"",e.cols,e.rows]);if("string"!=typeof n)throw new Error("Cannot initialize terminal");const[r,l]=yield Promise.all([this.subscribe(p,s,"onData",n),i?this.subscribe(p,i,"onChildProcessesChange",n):void 0]);return{terminalID:n,destroy:()=>o(this,void 0,void 0,(function*(){yield this.unsubscribe(r),l&&(yield this.unsubscribe(l)),yield this.call("terminal_destroy",[n])})),sendData:s=>o(this,void 0,void 0,(function*(){yield this.call("terminal_data",[n,s])})),resize:({cols:s,rows:i})=>o(this,void 0,void 0,(function*(){yield this.call("terminal_resize",[n,s,i])}))}}catch(s){throw this.logger.error(s),new Error("Error starting terminal session",s)}}))},this.process={start:(s,i,e,t={},n="/",r)=>o(this,void 0,void 0,(function*(){try{const l=yield this.call("process_start",[r||"",s,t,n]);if("string"!=typeof l)throw new Error("Cannot start process");const[c,h]=yield Promise.all([i?this.subscribe(u,i,"onStdout",l):void 0,e?this.subscribe(u,e,"onStderr",l):void 0]);return{processID:l,kill:()=>o(this,void 0,void 0,(function*(){yield Promise.all([c?this.unsubscribe(c):void 0,h?this.unsubscribe(h):void 0,this.call("terminal_kill",[l])])})),sendStdin:s=>o(this,void 0,void 0,(function*(){yield this.call("process_stdin",[l,s])}))}}catch(s){throw this.logger.error(s),new Error("Error starting process",s)}}))}}))}},s.api=n,Object.defineProperty(s,"__esModule",{value:!0})}));
 //# sourceMappingURL=index.js.map

dist/umd/session/codeSnippet.d.ts

@@ -0,1 +1,3 @@
+import { OutStderrResponse, OutStdoutResponse } from './out';
+import { EnvVars } from './envVars';
 export declare const codeSnippetMethod = "codeSnippet";
@@ -6,20 +8,2 @@ export declare enum CodeSnippetExecState {
 }
-export declare enum OutType {
-    Stdout = "Stdout",
-    Stderr = "Stderr"
-}
-export declare type EnvVars = {
-    [key: string]: string;
-};
-export interface OutResponse {
-    type: OutType;
-    timestamp: number;
-    line: string;
-}
-export interface OutStdoutResponse extends OutResponse {
-    type: OutType.Stdout;
-}
-export interface OutStderrResponse extends OutResponse {
-    type: OutType.Stderr;
-}
 export interface OpenedPort {
@@ -26,0 +10,0 @@ State: string;

dist/umd/session/index.d.ts

@@ -5,2 +5,3 @@ import SessionConnection, { SessionConnectionOpts } from './sessionConnection';
 import { FilesystemManager } from './filesystem';
+import { ProcessManager } from './process';
 export interface CodeSnippetOpts {
@@ -20,2 +21,3 @@ onStateChange?: CodeSnippetStateHandler;
     filesystem?: FilesystemManager;
+    process?: ProcessManager;
     constructor(opts: SessionOpts);
@@ -22,0 +24,0 @@ open(): Promise<void>;

dist/umd/session/sessionConnection.d.ts

@@ -27,4 +27,22 @@ import { components } from '../api';
     protected subscribe(method: string, handler: SubscriptionHandler, ...params: any): Promise<string>;
+    /**
+     * Get the hostname for the session or for the specified session's port.
+     *
+     * `getHostname` method requires `this` context - you may need to bind it.
+     *
+     * @param port specify if you want to connect to a specific port of the session
+     * @returns hostname of the session or session's port
+     */
     getHostname(port?: number): string;
+    /**
+     * Close the connection to the session
+     *
+     * `close` method requires `this` context - you may need to bind it.
+     */
     close(): Promise<void>;
+    /**
+     * Open a connection to a new session
+     *
+     * `open` method requires `this` context - you may need to bind it.
+     */
     open(): Promise<void>;
@@ -31,0 +49,0 @@ private handleNotification;

package.json

 {
   "name": "@devbookhq/sdk",
-  "version": "2.3.17",
+  "version": "2.3.18",
   "description": "Devbook allows visitors of your docs to interact with and execute any code snippet or shell command in a private VM",
@@ -31,12 +31,12 @@ "homepage": "https://usedevbook.com",
     "@rollup/plugin-node-resolve": "^13.3.0",
-    "@types/node": "^18.6.3",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
-    "eslint": "^8.21.0",
+    "@types/node": "^18.7.8",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "eslint": "^8.22.0",
     "openapi-typescript": "^5.4.1",
-    "rollup": "^2.77.2",
+    "rollup": "^2.78.1",
     "rollup-plugin-auto-external": "^2.0.0",
     "rollup-plugin-polyfill-node": "^0.10.2",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.32.1",
+    "rollup-plugin-typescript2": "^0.33.0",
     "typescript": "^4.7.4"
@@ -67,2 +67,2 @@ },
   }
-}
+}

No alert changes

Improved metrics

Total package byte prevSize

181275

11.06%

Number of package files

51

21.43%

Lines of code

1518

8.35%

No dependency changes