oorja 2.4.0 → 2.5.2

package/README.md

@@ -1,7 +1,7 @@
 TeleType
 =====
 
-cli tool that allows you to share your terminal online conveniently. Check out [oorja.io](https://oorja.io) - show off mad cli-fu, help a colleague, teach, or troubleshoot.
+cli tool that allows you to share your terminal online conveniently. Check out [SupaKit](https://supakit.app) - show off mad cli-fu, help a colleague, teach, or troubleshoot.
 
 [![Version](https://img.shields.io/npm/v/oorja.svg)](https://npmjs.org/package/oorja)
 [![Downloads/week](https://img.shields.io/npm/dw/oorja.svg)](https://npmjs.org/package/oorja)
@@ -9,11 +9,11 @@ cli tool that allows you to share your terminal online conveniently. Check out [
 
 
 <p align="center">
-  <img width="600" src="https://oorja.io/images/cli-demo.svg">
+  <img width="600" src="https://supakit.app/images/cli-demo.svg">
 </p>
 
 <p align="center">
-  <img src="https://oorja.io/images/teletype-session.png">
+  <img src="https://supakit.app/images/teletype-session.png">
 </p>
 
 Your stream can be view-only or collaboration enabled (command-line flag).
@@ -49,82 +49,84 @@ Any participant in the room can stream their terminal(s) i.e there can be multip
 For options: `teletype -h` 
 
 **Note**
-This is the cli companion for [oorja.io](https://oorja.io) which is a privacy focussed collaboration tool with more features like voice, notes, and chat - [privacy policy](https://oorja.io/privacy-policy).
+This is the cli companion for [SupaKit](https://supakit.app) which is a privacy focussed collaboration tool with more features like voice, notes, and chat - [privacy policy](https://supakit.app/privacy-policy).
 TLDR: Your data is end-to-end encrypted, no prying eyes 🍻.
 
 Like it ? [follow or tweet, tell your colleagues](https://twitter.com/oorja_app) 👩🏻‍💻
 
 Open [issues](https://github.com/akshaykmr/TeleType/issues).
 
-More ways to [contact](https://oorja.io/contact).
+More ways to [contact](https://supakit.app/contact).
 
 
 # Commands
-<!-- commands-disabled -->
-* [`oorja help [COMMAND]`](#oorja-help-command)
-* [`oorja teletype [SPACE]`](#oorja-teletype-space)
+<!-- commands -->
+* [`oorja teletype [STREAMKEY]`](#oorja-teletype-streamkey)
 * [`oorja signout`](#oorja-signout)
+* [`oorja help [COMMAND]`](#oorja-help-command)
 
-## `oorja help [COMMAND]`
-
-Display help for oorja.
-
-```
-USAGE
-  $ oorja help [COMMAND...] [-n]
-
-ARGUMENTS
-  COMMAND...  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for oorja.
-```
-
-## `oorja teletype [STREAM_KEY]`
+## `oorja teletype [STREAMKEY]`
 
-Launch a terminal streaming session in oorja.
+Launch a terminal streaming session in SupaKit.
 
 ```
 USAGE
-  $ oorja teletype [STREAM_KEY] [-h] [-s <value>] [-m] [-n]
+  $ oorja teletype [STREAMKEY] [-h] [-s <value>] [-m] [-n]
 
 FLAGS
   -h, --help           Show CLI help.
   -m, --multiplex      Allows users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust space
                        participants. Off by default
-  -n, --new_space      Create new space
-  -s, --shell=<value>  [default: /usr/bin/bash] shell to use. e.g. bash, fish
+  -n, --new            Create a new space
+  -s, --shell=<value>  shell to use. e.g. bash, fish
 
 DESCRIPTION
-  Launch a terminal streaming session in oorja.
+  Launch a terminal streaming session in SupaKit.
 
 ALIASES
   $ oorja tty
 
 EXAMPLES
   $ teletype
-  Will prompt to choose streaming destination - existing space or create a new one.
+  Will prompt to choose streaming destination - either enter a stream key for an existing space or create a new space.
 
-  $ teletype $stream-key
-  Will stream to the space specified by secret link.
+  $ teletype 'sk-xxxx:space-id#encryption-secret'
+  Will stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at supakit.app), do not accept them from other people, nor should
+  you share your stream-keys with others.
 
   $ teletype -m
-  Will also allow participants to write to your terminal!
+  Will also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.
 ```
 
 ## `oorja signout`
 
-Sign-out of oorja. Clears saved auth-token
+Sign out of SupaKit. Clears saved auth-token
 
 ```
 USAGE
   $ oorja signout
 
 DESCRIPTION
-  Sign-out of oorja. Clears saved auth-token
+  Sign out of SupaKit. Clears saved auth-token
+```
+
+
+## `oorja help [COMMAND]`
+
+Display help for oorja.
+
+```
+USAGE
+  $ oorja help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for oorja.
 ```
 
-<!-- commandsstop-disabled -->
+<!-- commandsstop -->

package/dist/commands/signout.js

@@ -1,7 +1,7 @@
 import { Command } from '@oclif/core';
-import { Config } from '../lib/config.js';
+import { Config } from 'oorja/lib/config';
 export class SignOut extends Command {
-    static description = `Sign-out of oorja. Clears saved auth-token`;
+    static description = `Sign out of SupaKit. Clears saved auth-token`;
     async run() {
         const config = new Config(this.config.configDir);
         config.setAccessToken('');

package/dist/commands/teletype/index.d.ts

@@ -6,9 +6,9 @@ export default class TeleTypeCommand extends Command {
     static examples: string[];
     static flags: {
         help: import("@oclif/core/interfaces").BooleanFlag<void>;
-        shell: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        shell: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         multiplex: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        new_space: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        new: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     static args: {
         streamKey: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;

package/dist/commands/teletype/index.js

@@ -3,23 +3,23 @@ import { Command, Flags, Args } from '@oclif/core';
 import ora from 'ora';
 import { hostname, platform } from 'os';
 import chalk from 'chalk';
-import { Config, STREAM_KEY_SAMPLE } from '../../lib/config.js';
-import { App, parseStreamKey } from '../../lib/oorja/index.js';
-import { printExitMessage, promptStreamKey } from '../../lib/utils.js';
-import { Unauthorized } from '../../lib/connect/errors.js';
-import { exit } from '../../lib/exit.js';
+import { Config, STREAM_KEY_SAMPLE } from 'oorja/lib/config';
+import { App, parseStreamKey } from 'oorja/lib/oorja/index';
+import { printExitMessage, promptStreamKey } from 'oorja/lib/utils';
+import { Unauthorized } from 'oorja/lib/connect/errors';
+import { exit } from 'oorja/lib/exit';
 const DEFAULT_SHELL = platform() === 'win32' ? 'powershell.exe' : process.env.SHELL || 'bash';
 export default class TeleTypeCommand extends Command {
     static order = 1;
     static aliases = ['tty'];
-    static description = `Launch a terminal streaming session in oorja.`;
+    static description = `Launch a terminal streaming session in SupaKit.`;
     static examples = [
         `${chalk.blueBright('$ teletype')}
 Will prompt to choose streaming destination - either enter a stream key for an existing space or create a new space.
 
 `,
         `${chalk.blueBright(`$ teletype '${STREAM_KEY_SAMPLE}'`)}
-Will stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at oorja.io), do not accept them from other people, nor should
+Will stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at supakit.app), do not accept them from other people, nor should
 you share your stream-keys with others.
 
 `,
@@ -33,16 +33,17 @@ Will also allow participants to write to your terminal! Collaboration mode must
         shell: Flags.string({
             char: 's',
             description: 'shell to use. e.g. bash, fish',
-            default: DEFAULT_SHELL,
         }),
         multiplex: Flags.boolean({
             char: 'm',
             description: 'Allows users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust space participants. Off by default',
             default: false,
         }),
-        new_space: Flags.boolean({
+        new: Flags.boolean({
+            aliases: ['new-space', 'new_space'],
             char: 'n',
-            description: 'Create new space',
+            deprecateAliases: true,
+            description: 'Create a new space',
             default: false,
         }),
     };
@@ -50,14 +51,15 @@ Will also allow participants to write to your terminal! Collaboration mode must
         streamKey: Args.string({}),
     };
     async run() {
-        const { args, flags: { shell, multiplex, new_space }, } = await this.parse(TeleTypeCommand);
+        const { args, flags: { shell: selectedShell, multiplex, new: createNewSpace }, } = await this.parse(TeleTypeCommand);
+        const shell = selectedShell || DEFAULT_SHELL;
         const config = new Config(this.config.configDir);
         const app = new App(config);
         if (args.streamKey) {
             await this.streamUsingStreamKey(app, { shell, multiplex, streamKey: args.streamKey });
             exit(0);
         }
-        if (new_space) {
+        if (createNewSpace) {
             await this.createRoomAndStream(app, { shell, multiplex });
             exit(0);
         }
@@ -67,7 +69,7 @@ Will also allow participants to write to your terminal! Collaboration mode must
         const STREAM_TO_NEW_SPACE = 'New space';
         const { answer } = await inquirer.prompt([
             {
-                type: 'list',
+                type: 'select',
                 name: 'answer',
                 message: 'Choose streaming destination',
                 choices: [STREAM_TO_NEW_SPACE, STREAM_USING_STREAM_KEY],
@@ -121,7 +123,7 @@ Will also allow participants to write to your terminal! Collaboration mode must
                 printExitMessage('Failed to create space. Are you sure your access-token is valid?');
             }
             else {
-                printExitMessage('Failed to create space. Try again later or try updating your oorja-cli');
+                printExitMessage('Failed to create space. Try again later or update the CLI: npm update -g oorja');
             }
             exit(9);
             return Promise.reject();

package/dist/lib/config.d.ts

@@ -1,5 +1,7 @@
-export declare const CLI_VERSION = 2.8;
+export declare const CLI_VERSION = 2.9;
 export type env = 'local' | 'prod';
+export declare const SUPAKIT_ACCESS_TOKEN_ENV = "SUPAKIT_ACCESS_TOKEN";
+export declare const SUPAKIT_ENV_ENV = "SUPAKIT_ENV";
 export declare class Config {
     streamKeyAuth: boolean;
     private configPath;
@@ -9,6 +11,7 @@ export declare class Config {
     private saveConfig;
     getEnv: () => env;
     getAccessToken: () => string;
+    hasInjectedAccessToken: () => boolean;
     setAccessToken: (token: string) => void;
 }
 export type ConnectConfig = {

package/dist/lib/config.js

@@ -1,7 +1,15 @@
 import chalk from 'chalk';
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import path from 'path';
-export const CLI_VERSION = 2.8;
+export const CLI_VERSION = 2.9;
+export const SUPAKIT_ACCESS_TOKEN_ENV = 'SUPAKIT_ACCESS_TOKEN';
+export const SUPAKIT_ENV_ENV = 'SUPAKIT_ENV';
+const envFromValue = (value) => {
+    if (value === 'local' || value === 'prod') {
+        return value;
+    }
+    return undefined;
+};
 export class Config {
     streamKeyAuth = false;
     configPath;
@@ -38,11 +46,17 @@ export class Config {
         }
     }
     getEnv = () => {
-        return this.config['env'] || 'prod';
+        return envFromValue(process.env[SUPAKIT_ENV_ENV]) || envFromValue(this.config['env']) || 'prod';
     };
     getAccessToken = () => {
+        if (process.env[SUPAKIT_ACCESS_TOKEN_ENV]) {
+            return process.env[SUPAKIT_ACCESS_TOKEN_ENV];
+        }
         return this.config[`${this.getEnv()}-access-token`] || '';
     };
+    hasInjectedAccessToken = () => {
+        return Boolean(process.env[SUPAKIT_ACCESS_TOKEN_ENV]);
+    };
     setAccessToken = (token) => {
         this.config[`${this.getEnv()}-access-token`] = token;
         this.saveConfig();
@@ -73,7 +87,7 @@ export const getoorjaConfig = (env) => {
             host = 'localhost:3000';
             break;
         case 'prod':
-            host = 'oorja.io';
+            host = 'supakit.app';
             break;
     }
     return {

package/dist/lib/connect/index.d.ts

@@ -1,5 +1,5 @@
-import { User, RoomApps, Room, CliManifest, NewRoomInviteResponse } from './types.js';
-import { env } from '../config.js';
+import { User, RoomApps, Room, CliManifest, NewRoomInviteResponse } from 'oorja/lib/connect/types';
+import { env } from 'oorja/lib/config';
 import { Channel } from 'phoenix';
 export declare class ApiClientError extends Error {
 }

package/dist/lib/connect/index.js

@@ -2,13 +2,13 @@
 import { Encoder, Decoder } from '@msgpack/msgpack';
 const encoder = new Encoder();
 const decoder = new Decoder();
-import { defaultParser } from './resources.js';
-import { getConnectConfig } from '../config.js';
-import { Unauthorized, BadRequest } from './errors.js';
+import { defaultParser } from 'oorja/lib/connect/resources';
+import { getConnectConfig } from 'oorja/lib/config';
+import { Unauthorized, BadRequest } from 'oorja/lib/connect/errors';
 import { Socket, Presence } from 'phoenix';
 import camelcaseKeys from 'camelcase-keys';
-import { printExitMessage } from '../utils.js';
-import { exit } from '../exit.js';
+import { printExitMessage } from 'oorja/lib/utils';
+import { exit } from 'oorja/lib/exit';
 export class ApiClientError extends Error {
 }
 export class ConnectClient {

package/dist/lib/encryption.d.ts

@@ -1,4 +1,4 @@
-import { RoomKey } from './connect/types.js';
+import { RoomKey } from 'oorja/lib/connect/types';
 export type EncryptedPayload = {
     iv: Buffer | Uint8Array;
     data: Buffer | Uint8Array;

package/dist/lib/exit.d.ts

@@ -1 +1,2 @@
+export declare const CLI_OUTDATED_EXIT_CODE = 42;
 export declare function exit(exitCode?: number, streams?: any): void;

package/dist/lib/exit.js

@@ -8,11 +8,12 @@
  * Licensed under the MIT license.
  */
 'use strict';
+export const CLI_OUTDATED_EXIT_CODE = 42;
 export function exit(exitCode = 0, streams) {
     if (!streams) {
         streams = [process.stdout, process.stderr];
     }
-    var drainCount = 0;
+    let drainCount = 0;
     // Actually exit if all streams are drained.
     function tryToExit() {
         if (drainCount === streams.length) {

package/dist/lib/oorja/client.js

@@ -1,13 +1,13 @@
 import haversine from 'haversine-distance';
-import { printExitMessage } from '../utils.js';
-import { exit } from '../exit.js';
-import { geoMap } from './geoMap.js';
+import { printExitMessage } from 'oorja/lib/utils';
+import { exit } from 'oorja/lib/exit';
+import { geoMap } from 'oorja/lib/oorja/geoMap';
 export class OorjaClientError extends Error {
 }
 const _maybeError = (response) => {
     const { status } = response;
     if (status >= 400) {
-        throw new OorjaClientError('oorja network client error');
+        throw new OorjaClientError('SupaKit network client error');
     }
 };
 class Client {
@@ -26,7 +26,7 @@ class Client {
 }
 const _client = new Client();
 export const getRegion = async () => {
-    const response = await _client.get('https://oorja.io/nudge', {
+    const response = await _client.get('https://supakit.app/nudge', {
         method: 'GET',
     });
     if (response.status !== 200) {

package/dist/lib/oorja/index.d.ts

@@ -1,8 +1,8 @@
-import { oorjaConfig, Config } from '../config.js';
-import { RoomKey, UserProfile } from '../connect/types.js';
-import { TeletypeOptions } from '../teletype/index.js';
-import { CreateRoomOptions, ConnectClient } from '../connect/index.js';
-import { Future } from '../utils.js';
+import { oorjaConfig, Config } from 'oorja/lib/config';
+import { RoomKey, UserProfile } from 'oorja/lib/connect/types';
+import { TeletypeOptions } from 'oorja/lib/teletype/index';
+import { CreateRoomOptions, ConnectClient } from 'oorja/lib/connect/index';
+import { Future } from 'oorja/lib/utils';
 export declare class InvalidRoomLink extends Error {
 }
 export declare class OORJA {
@@ -11,13 +11,13 @@ export declare class OORJA {
     user: UserProfile;
     constructor(config: oorjaConfig, connectClient: ConnectClient, user: UserProfile);
     createRoom: (options: CreateRoomOptions) => Promise<{
-        room: import("../connect/types.js").Room;
+        room: import("oorja/lib/connect/types").Room;
         roomKey: RoomKey;
         inviteCode: string;
     }>;
     linkForRoom: (roomKey: RoomKey, inviteCode: string) => string;
     getRoomKey(streamKey: StreamKey): RoomKey;
-    teletype: (options: Omit<TeletypeOptions, "userId" | "joinChannel">) => Promise<unknown>;
+    teletype: (options: Omit<TeletypeOptions, "userId" | "joinChannel">) => Promise<null>;
 }
 type StreamKey = {
     roomId: string;

package/dist/lib/oorja/index.js

@@ -1,13 +1,13 @@
-import { getoorjaConfig, INVALID_STREAM_KEY_MESSAGE } from '../config.js';
-import { teletypeApp } from '../teletype/index.js';
-import { ConnectClient } from '../connect/index.js';
-import { importKey, createRoomKey, exportKey } from '../encryption.js';
-import { promptAuth, validateCliVersion } from './preflight.js';
-import { getRegion } from './client.js';
+import { getoorjaConfig, INVALID_STREAM_KEY_MESSAGE } from 'oorja/lib/config';
+import { TeletypeSession } from 'oorja/lib/teletype/index';
+import { ConnectClient } from 'oorja/lib/connect/index';
+import { importKey, createRoomKey, exportKey } from 'oorja/lib/encryption';
+import { promptAuth, validateCliVersion } from 'oorja/lib/oorja/preflight';
+import { getRegion } from 'oorja/lib/oorja/client';
 import ora from 'ora';
-import { Future, printExitMessage } from '../utils.js';
-import { Unauthorized } from '../connect/errors.js';
-import { exit } from '../exit.js';
+import { Future, printExitMessage } from 'oorja/lib/utils';
+import { Unauthorized } from 'oorja/lib/connect/errors';
+import { exit } from 'oorja/lib/exit';
 import chalk from 'chalk';
 export class InvalidRoomLink extends Error {
 }
@@ -41,11 +41,11 @@ export class OORJA {
         };
     }
     teletype = (options) => {
-        return teletypeApp({
+        return new TeletypeSession({
             userId: this.user.id,
             joinChannel: this.connectClient.joinChannel,
             ...options,
-        });
+        }).run();
     };
 }
 export const parseStreamKey = (streamKey) => {
@@ -98,10 +98,11 @@ export class App {
         }
         spinner.succeed('Online');
         const oorjaConfig = getoorjaConfig(this.config.getEnv());
+        const isControlledMode = this.config.hasInjectedAccessToken();
         let user = undefined;
         try {
             if (!streamKey) {
-                user = await this.tryResumeSession();
+                user = await this.tryResumeSession(isControlledMode);
                 if (!user) {
                     const token = await promptAuth(this.connectClient, linkForTokenGen(oorjaConfig));
                     if (!token) {
@@ -127,10 +128,14 @@ export class App {
             }
         }
         catch (e) {
-            this.config.setAccessToken('');
+            if (!isControlledMode) {
+                this.config.setAccessToken('');
+            }
             if (e instanceof Unauthorized) {
                 spinner.fail();
-                printExitMessage('Your access token failed authentication, resetting...');
+                printExitMessage(isControlledMode
+                    ? 'The provided access token failed authentication.'
+                    : 'Your access token failed authentication, resetting...');
                 exit(33);
                 return Promise.reject();
             }
@@ -156,14 +161,14 @@ export class App {
             await validateCliVersion(connectClient);
             this.connectClient = connectClient;
         }
-        catch (e) {
+        catch {
             this.connectionCheckFailed = true;
         }
         finally {
             this.connectionCheckFuture.resolve();
         }
     };
-    tryResumeSession = async () => {
+    tryResumeSession = async (isControlledMode) => {
         const personalAccessToken = this.config.getAccessToken();
         if (!personalAccessToken)
             return;
@@ -172,6 +177,9 @@ export class App {
         }
         catch (e) {
             if (e instanceof Unauthorized) {
+                if (isControlledMode) {
+                    throw e;
+                }
                 this.config.setAccessToken(''); // reset
                 return;
             }

package/dist/lib/oorja/preflight.d.ts

@@ -1,3 +1,3 @@
-import { ConnectClient } from '../connect/index.js';
+import { ConnectClient } from 'oorja/lib/connect/index';
 export declare const promptAuth: (connectClient: ConnectClient, generateTokenLink: string) => Promise<string>;
 export declare const validateCliVersion: (connectClient: ConnectClient) => Promise<void>;

package/dist/lib/oorja/preflight.js

@@ -1,8 +1,8 @@
 import chalk from 'chalk';
 import inquirer from 'inquirer';
-import { CLI_VERSION } from '../config.js';
-import { printExitMessage } from '../utils.js';
-import { exit } from '../exit.js';
+import { CLI_VERSION } from 'oorja/lib/config';
+import { printExitMessage } from 'oorja/lib/utils';
+import { CLI_OUTDATED_EXIT_CODE, exit } from 'oorja/lib/exit';
 const promptToken = () => inquirer
     .prompt([
     {
@@ -14,11 +14,11 @@ const promptToken = () => inquirer
     .then((answers) => answers.accessToken);
 export const promptAuth = async (connectClient, generateTokenLink) => {
     const ANON = 'Proceed as an anonymous user';
-    const SIGN_IN = 'Sign-in with oorja';
+    const SIGN_IN = 'Sign in with SupaKit';
     console.log(`\n${chalk.bold('PRO-TIP:')} If you sign-in, you can control your shell from the web-ui as well, without enabling collaboration mode for the other participants\n`);
     const { answer } = await inquirer.prompt([
         {
-            type: 'list',
+            type: 'select',
             name: 'answer',
             message: 'You need an access-token for authentication.\n ',
             choices: [ANON, SIGN_IN],
@@ -37,7 +37,7 @@ export const promptAuth = async (connectClient, generateTokenLink) => {
 export const validateCliVersion = async (connectClient) => {
     const manifest = await connectClient.fetchCliManifest();
     if (manifest.cliVersion > CLI_VERSION) {
-        printExitMessage(chalk.redBright('Your oorja cli is outdated. Please run: npm update -g oorja'));
-        exit(1);
+        printExitMessage(chalk.redBright('Your CLI is outdated. Please run: npm update -g oorja'));
+        exit(CLI_OUTDATED_EXIT_CODE);
     }
 };

package/dist/lib/teletype/index.d.ts

@@ -1,5 +1,5 @@
-import { RoomKey } from '../connect/types.js';
-import { JoinChannelOptions } from '../connect/index.js';
+import { RoomKey } from 'oorja/lib/connect/types';
+import { JoinChannelOptions } from 'oorja/lib/connect/index';
 import { Channel } from 'phoenix';
 export type TeletypeOptions = {
     userId: string;
@@ -14,5 +14,28 @@ type TeletypeChannelParams = {
     hostname: string;
     multiplexed: boolean;
 };
-export declare const teletypeApp: (options: TeletypeOptions) => Promise<unknown>;
+export declare class TeletypeSession {
+    private readonly options;
+    private readonly username;
+    private readonly hostname;
+    private readonly userDimensions;
+    private channel;
+    private term;
+    private sessionCount;
+    private ptyReady;
+    private readonly ptyFuture;
+    private stopped;
+    private cleanupShell;
+    private resolve?;
+    constructor(options: TeletypeOptions);
+    run: () => Promise<null>;
+    private startTerm;
+    private reEvaluateOwnDimensions;
+    private handleClose;
+    private handleError;
+    private handleMessage;
+    private handleSessionJoin;
+    private handleSessionLeave;
+    private stop;
+}
 export {};

package/dist/lib/teletype/index.js

@@ -1,11 +1,11 @@
 import { spawn } from 'node-pty';
 import * as os from 'os';
-import { getDimensions, initScreen, areDimensionEqual, resizeBestFit } from './auxiliary.js';
+import { getDimensions, initScreen, areDimensionEqual, resizeBestFit } from 'oorja/lib/teletype/auxiliary';
 import chalk from 'chalk';
-import { Unauthorized } from '../connect/errors.js';
-import { encrypt, decrypt } from '../encryption.js';
-import { Future, printExitMessage } from '../utils.js';
-import { exit } from '../exit.js';
+import { Unauthorized } from 'oorja/lib/connect/errors';
+import { encrypt, decrypt } from 'oorja/lib/encryption';
+import { Future, printExitMessage } from 'oorja/lib/utils';
+import { exit } from 'oorja/lib/exit';
 var MessageType;
 (function (MessageType) {
     MessageType["IN"] = "i";
@@ -13,139 +13,188 @@ var MessageType;
     MessageType["DIMENSIONS"] = "d";
 })(MessageType || (MessageType = {}));
 const SELF = 'self';
-export const teletypeApp = (options) => {
-    const username = os.userInfo().username;
-    const hostname = os.hostname();
-    const userDimensions = {};
-    userDimensions[SELF] = getDimensions();
-    let term;
-    const reEvaluateOwnDimensions = () => {
-        const lastKnown = userDimensions[SELF];
+export class TeletypeSession {
+    options;
+    username = os.userInfo().username;
+    hostname = os.hostname();
+    userDimensions = {
+        [SELF]: getDimensions(),
+    };
+    channel;
+    term;
+    sessionCount = 0;
+    ptyReady = false;
+    ptyFuture = new Future();
+    stopped = false;
+    cleanupShell = () => { };
+    resolve;
+    constructor(options) {
+        this.options = options;
+    }
+    run = () => new Promise((resolve) => {
+        this.resolve = resolve;
+        this.channel = this.options.joinChannel({
+            channel: `teletype:${this.options.roomKey.roomId}`,
+            params: {
+                username: this.username,
+                hostname: this.hostname,
+                multiplexed: this.options.multiplex,
+            },
+            onJoin: this.startTerm,
+            onClose: this.handleClose,
+            onError: this.handleError,
+            onMessage: this.handleMessage,
+            handleSessionJoin: this.handleSessionJoin,
+            handleSessionLeave: this.handleSessionLeave,
+        });
+    });
+    startTerm = () => {
+        const { stdin, stdout } = this.options.process;
+        const dimensions = this.userDimensions[SELF];
+        console.log(chalk.blue(`${chalk.bold(`${this.username}@${this.hostname}`)} Spawning streaming shell: ${chalk.bold(`${this.options.shell}`)}`));
+        this.term = spawn(this.options.shell, [], {
+            name: 'xterm-256color',
+            cols: dimensions.cols,
+            rows: dimensions.rows,
+            cwd: this.options.process.cwd(),
+            env: this.options.process.env,
+        });
+        this.ptyFuture.promise.then(() => {
+            initScreen(this.username, this.hostname, this.options.shell, this.options.multiplex);
+            if (this.options.shell.endsWith('bash')) {
+                stdout.write('Adjusting shell prompt to show streaming indicator\n');
+                this.term.write("export PS1='📡 [streaming] '$PS1\n");
+            }
+            if (this.options.shell.endsWith('zsh')) {
+                stdout.write('Adjusting shell prompt to show streaming indicator\n');
+                // FIXME: this doesnt work on macos (or its probably due to some conflict with powerlevel10k)
+                this.term.write("PROMPT='📡 [streaming] '$PROMPT\n");
+            }
+            if (this.options.shell.endsWith('fish')) {
+                stdout.write('Adjusting shell prompt to show streaming indicator\n');
+                this.term.write('functions -c fish_prompt __orig_fish_prompt; ' +
+                    "function fish_prompt; echo -n '📡 [streaming] '; __orig_fish_prompt; end\n");
+            }
+        });
+        // track own dimensions and keep it up to date
+        const dimensionPoll = setInterval(this.reEvaluateOwnDimensions, 1000);
+        const ptyDataSubscription = this.term.onData((d) => {
+            stdout.write(d);
+            if (!this.ptyReady) {
+                this.ptyReady = true;
+                setTimeout(() => {
+                    this.ptyFuture.resolve(true);
+                }, 100);
+            }
+            if (this.sessionCount < 2) {
+                // 1 sub for own channel session
+                // < 2 means no subscribers. no point pushing data.
+                return;
+            }
+            this.channel.push('new_msg', {
+                t: MessageType.OUT,
+                b: true,
+                d: encrypt(d, this.options.roomKey),
+            });
+        });
+        const ptyExitSubscription = this.term.onExit(() => {
+            console.log(chalk.blueBright('terminated shell stream to SupaKit. byee!'));
+            this.stop({ killTerm: false });
+            this.resolve?.(null);
+        });
+        stdin.setEncoding('utf8');
+        stdin.setRawMode(true);
+        const stdinDataHandler = (d) => this.term.write(d.toString('utf8'));
+        stdin.on('data', stdinDataHandler);
+        this.cleanupShell = ({ killTerm = true } = {}) => {
+            clearInterval(dimensionPoll);
+            ptyDataSubscription.dispose();
+            ptyExitSubscription.dispose();
+            stdin.off('data', stdinDataHandler);
+            stdin.setRawMode(false);
+            if (killTerm) {
+                this.term.kill();
+            }
+        };
+    };
+    reEvaluateOwnDimensions = () => {
+        const lastKnown = this.userDimensions[SELF];
         const latest = getDimensions();
         if (areDimensionEqual(lastKnown, latest)) {
             return;
         }
-        userDimensions[SELF] = latest;
-        resizeBestFit(term, userDimensions);
+        this.userDimensions[SELF] = latest;
+        resizeBestFit(this.term, this.userDimensions);
     };
-    return new Promise((resolve, reject) => {
-        let sessionCount = 0;
-        let ptyReady = false;
-        const ptyFuture = new Future();
-        const channel = options.joinChannel({
-            channel: `teletype:${options.roomKey.roomId}`,
-            params: {
-                username,
-                hostname,
-                multiplexed: options.multiplex,
-            },
-            onJoin: () => {
-                const stdin = options.process.stdin;
-                const stdout = options.process.stdout;
-                const dimensions = userDimensions[SELF];
-                console.log(chalk.blue(`${chalk.bold(`${username}@${hostname}`)} Spawning streaming shell: ${chalk.bold(`${options.shell}`)}`));
-                term = spawn(options.shell, [], {
-                    name: 'xterm-256color',
-                    cols: dimensions.cols,
-                    rows: dimensions.rows,
-                    cwd: options.process.cwd(),
-                    env: options.process.env,
-                });
-                ptyFuture.promise.then(() => {
-                    initScreen(username, hostname, options.shell, options.multiplex);
-                    if (options.shell.endsWith('bash')) {
-                        stdout.write('Adjusting shell prompt to show streaming indicator\n');
-                        term.write("export PS1='📡 [streaming] '$PS1\n");
-                    }
-                    if (options.shell.endsWith('zsh')) {
-                        stdout.write('Adjusting shell prompt to show streaming indicator\n');
-                        // FIXME: this doesnt work on macos (or its probably due to some conflict with powerlevel10k)
-                        term.write("PROMPT='📡 [streaming] '$PROMPT\n");
-                    }
-                    if (options.shell.endsWith('fish')) {
-                        stdout.write('Adjusting shell prompt to show streaming indicator\n');
-                        term.write('functions -c fish_prompt __orig_fish_prompt; ' +
-                            "function fish_prompt; echo -n '📡 [streaming] '; __orig_fish_prompt; end\n");
-                    }
-                });
-                // track own dimensions and keep it up to date
-                setInterval(reEvaluateOwnDimensions, 1000);
-                term.onData((d) => {
-                    stdout.write(d);
-                    if (!ptyReady) {
-                        ptyReady = true;
-                        setTimeout(() => {
-                            ptyFuture.resolve(true);
-                        }, 100);
-                    }
-                    if (sessionCount < 2) {
-                        // 1 sub for own channel session
-                        // < 2 means no subscribers. no point pushing data.
-                        return;
-                    }
-                    channel.push('new_msg', {
-                        t: MessageType.OUT,
-                        b: true,
-                        d: encrypt(d, options.roomKey),
-                    });
-                });
-                term.onExit(() => {
-                    console.log(chalk.blueBright('terminated shell stream to oorja. byee!'));
-                    resolve(null);
-                });
-                stdin.setEncoding('utf8');
-                stdin.setRawMode(true);
-                stdin.on('data', (d) => term.write(d.toString('utf8')));
-            },
-            onClose: () => {
-                printExitMessage(chalk.redBright('connection closed, terminated stream.'));
-                exit(3);
-            },
-            onError: (err) => {
-                if (err instanceof Unauthorized) {
-                    printExitMessage(chalk.redBright(err.message));
+    handleClose = () => {
+        if (this.stopped) {
+            return;
+        }
+        this.stop({ leaveChannel: false });
+        printExitMessage(chalk.redBright('connection closed, terminated stream.'));
+        exit(3);
+    };
+    handleError = (err) => {
+        this.stop({ leaveChannel: false });
+        if (err instanceof Unauthorized) {
+            printExitMessage(chalk.redBright(err.message));
+        }
+        else {
+            printExitMessage(chalk.redBright('connection error, terminated stream.'));
+        }
+        exit(4);
+    };
+    handleMessage = ({ from: { session }, t, d }) => {
+        switch (t) {
+            case MessageType.DIMENSIONS:
+                this.userDimensions[session] = d;
+                resizeBestFit(this.term, this.userDimensions, d.initial);
+                break;
+            case MessageType.IN: {
+                const data = decrypt(d, this.options.roomKey);
+                const userId = session.split(':')[0];
+                const userType = session.split(':')[2];
+                if (userType === 'task') {
+                    this.stop();
+                    printExitMessage(chalk.redBright(`unexpected input from user: ${userId} with task-token, terminating stream for safety. Please report this issue`));
+                    exit(5);
+                    return;
                 }
-                else {
-                    printExitMessage(chalk.redBright('connection error, terminated stream.'));
+                if (this.options.multiplex) {
+                    this.term.write(data);
+                    return;
                 }
-                exit(4);
-            },
-            onMessage: ({ from: { session }, t, d }) => {
-                switch (t) {
-                    case MessageType.DIMENSIONS:
-                        userDimensions[session] = d;
-                        resizeBestFit(term, userDimensions, d.initial);
-                        break;
-                    case MessageType.IN:
-                        const data = decrypt(d, options.roomKey);
-                        const userId = session.split(':')[0];
-                        const userType = session.split(':')[2];
-                        if (userType === 'task') {
-                            printExitMessage(chalk.redBright(`unexpected input from user: ${userId} with task-token, terminating stream for safety. Please report this issue`));
-                            exit(5);
-                            return;
-                        }
-                        if (options.multiplex) {
-                            term.write(data);
-                            return;
-                        }
-                        if (userId === options.userId) {
-                            term.write(data);
-                        }
-                        else {
-                            printExitMessage(chalk.redBright(`unexpected input from user: ${userId}, terminating stream for safety. Please report this issue`));
-                            exit(5);
-                        }
+                if (userId === this.options.userId) {
+                    this.term.write(data);
                 }
-            },
-            handleSessionJoin: (s) => {
-                sessionCount++;
-            },
-            handleSessionLeave: (s) => {
-                sessionCount -= 1;
-                s && delete userDimensions[s];
-                resizeBestFit(term, userDimensions);
-            },
-        });
-    });
-};
+                else {
+                    this.stop();
+                    printExitMessage(chalk.redBright(`unexpected input from user: ${userId}, terminating stream for safety. Please report this issue`));
+                    exit(5);
+                }
+                break;
+            }
+        }
+    };
+    handleSessionJoin = () => {
+        this.sessionCount++;
+    };
+    handleSessionLeave = (s) => {
+        this.sessionCount -= 1;
+        if (s) {
+            delete this.userDimensions[s];
+        }
+        resizeBestFit(this.term, this.userDimensions);
+    };
+    stop = ({ killTerm = true, leaveChannel = true } = {}) => {
+        if (this.stopped) {
+            return;
+        }
+        this.stopped = true;
+        this.cleanupShell({ killTerm });
+        this.cleanupShell = () => { };
+        if (leaveChannel) {
+            this.channel.leave(1000);
+        }
+    };
+}

package/oclif.manifest.json

@@ -3,7 +3,7 @@
     "signout": {
       "aliases": [],
       "args": {},
-      "description": "Sign-out of oorja. Clears saved auth-token",
+      "description": "Sign out of SupaKit. Clears saved auth-token",
       "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
@@ -29,10 +29,10 @@
           "name": "streamKey"
         }
       },
-      "description": "Launch a terminal streaming session in oorja.",
+      "description": "Launch a terminal streaming session in SupaKit.",
       "examples": [
         "\u001b[94m$ teletype\u001b[39m\nWill prompt to choose streaming destination - either enter a stream key for an existing space or create a new space.\n\n",
-        "\u001b[94m$ teletype 'sk-xxxx:space-id#encryption-secret'\u001b[39m\nWill stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at oorja.io), do not accept them from other people, nor should\nyou share your stream-keys with others.\n\n",
+        "\u001b[94m$ teletype 'sk-xxxx:space-id#encryption-secret'\u001b[39m\nWill stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at supakit.app), do not accept them from other people, nor should\nyou share your stream-keys with others.\n\n",
         "\u001b[94m$ teletype -m\u001b[39m\nWill also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.\n\n"
       ],
       "flags": {
@@ -47,7 +47,6 @@
           "char": "s",
           "description": "shell to use. e.g. bash, fish",
           "name": "shell",
-          "default": "/usr/bin/zsh",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -59,10 +58,15 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "new_space": {
+        "new": {
+          "aliases": [
+            "new-space",
+            "new_space"
+          ],
           "char": "n",
-          "description": "Create new space",
-          "name": "new_space",
+          "deprecateAliases": true,
+          "description": "Create a new space",
+          "name": "new",
           "allowNo": false,
           "type": "boolean"
         }
@@ -85,5 +89,5 @@
       ]
     }
   },
-  "version": "2.4.0"
+  "version": "2.5.2"
 }

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "oorja",
   "description": "stream terminals to the web and more.",
-  "version": "2.4.0",
+  "version": "2.5.2",
+  "packageManager": "pnpm@11.5.2",
   "keywords": [
     "teletype",
     "terminal",
@@ -15,7 +16,16 @@
   "license": "SEE LICENSE IN license.txt",
   "author": "Akshay Kumar",
   "type": "module",
-  "exports": "./lib/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./src/*.ts",
+      "default": "./dist/*.js"
+    }
+  },
   "types": "dist/index.d.ts",
   "bin": {
     "oorja": "./bin/run.js",
@@ -28,44 +38,51 @@
   ],
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
+    "docs:commands": "pnpm run build && pnpm run docs:commands:generate",
+    "docs:commands:generate": "oclif readme --no-aliases --no-source-links && node scripts/order-readme-commands.mjs",
     "lint": "eslint . --ext .ts",
-    "prepack": "yarn build && oclif manifest && oclif readme",
-    "postpack": "shx rm -f oclif.manifest.json",
-    "prepare": "yarn build",
-    "version": "oclif readme && git add README.md",
+    "prepack": "pnpm run build && oclif manifest && pnpm run docs:commands:generate",
+    "prepare": "pnpm run build",
+    "version": "pnpm run docs:commands && git add README.md",
     "format": "prettier --write ."
   },
   "oclif": {
     "bin": "oorja",
     "commands": "./dist/commands",
-    "dirname": "oorja"
+    "dirname": "oorja",
+    "plugins": [
+      "@oclif/plugin-help"
+    ]
   },
   "dependencies": {
-    "@msgpack/msgpack": "3.1.2",
-    "@oclif/core": "^4.5.3",
-    "@oclif/plugin-help": "^6.2.32",
-    "camelcase-keys": "^10.0.0",
+    "@msgpack/msgpack": "3.1.3",
+    "@oclif/core": "^4.11.4",
+    "@oclif/plugin-help": "^6.2.50",
+    "camelcase-keys": "^10.0.2",
     "chalk": "^5.6.2",
     "haversine-distance": "^1.2.4",
-    "inquirer": "^12.9.4",
-    "node-pty": "^1.0.0",
-    "ora": "^8.2.0",
-    "phoenix": "1.8.1",
-    "terminal-size": "^4.0.0"
+    "inquirer": "^14.0.2",
+    "node-pty": "^1.1.0",
+    "ora": "^9.4.0",
+    "phoenix": "1.8.7",
+    "terminal-size": "^4.0.1"
   },
   "devDependencies": {
+    "@eslint/js": "^9.35.0",
     "@oclif/prettier-config": "^0.2.1",
     "@types/inquirer": "^9.0.9",
     "@types/node": "^22.10.2",
     "@types/phoenix": "^1.6.6",
-    "eslint": "^9.35.0",
-    "eslint-config-oclif": "^6.0.102",
+    "eslint": "^9.39.4",
+    "eslint-config-oclif": "^6.0.167",
     "eslint-config-prettier": "^10.1.8",
-    "oclif": "^4.22.18",
-    "prettier": "^3.6.2",
+    "globals": "^17.6.0",
+    "oclif": "^4.23.10",
+    "prettier": "^3.8.3",
     "shx": "^0.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.60.1"
   },
   "engines": {
     "node": ">=22.10.0"