oorja 1.4.1 → 1.5.1

package/README.md

@@ -26,11 +26,15 @@ Your stream can be view-only or collaboration enabled (command-line flag).
 
 - Prerequisite: [nodejs `12.13.0` or later](https://nodejs.org/en/download/)
 
-- **optional but highly recommend for successful install -> [npm install without sudo](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md)**
+- **optional but highly recommended for successful install -> [npm install without sudo](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md)**.
 - `npm install -g oorja`
 - `teletype`
 - `teletype -m`  (for collaboration mode)
 
+Misc: If you have issues installing on apple M1 or similar systems:
+- `sudo xcode-select --install`
+- `CXXFLAGS="--std=c++17" npm install -g oorja`
+
 **your stream is end-to-end encrypted**
 
 **PRO TIP:**

package/bin/oorja

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+require('@oclif/command').run()
+  .then(require('@oclif/command/flush'))
+  .catch(require('@oclif/errors/handle'))

package/lib/commands/signout.js

@@ -7,8 +7,8 @@ class SignOut extends command_1.Command {
     async run() {
         const env = config_1.determineENV();
         config_1.setENVAccessToken(env, "");
-        console.log("sign-out complete");
+        console.log("Sign-out complete");
     }
 }
 exports.SignOut = SignOut;
-SignOut.description = `sign-out of oorja. clears saved auth-token`;
+SignOut.description = `Sign-out of oorja. Clears saved auth-token`;

package/lib/commands/teletype/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const { Select, Input } = require("enquirer");
+const { Select } = require("enquirer");
 const command_1 = require("@oclif/command");
 const ora = require("ora");
 const os = require("os");
 const chalk = require("chalk");
 const config_1 = require("../../lib/config");
 const oorja_1 = require("../../lib/oorja");
+const utils_1 = require("../../lib/utils");
 const DEFAULT_SHELL = os.platform() === "win32" ? "powershell.exe" : process.env.SHELL || "bash";
 class TeleTypeCommand extends command_1.Command {
     async run() {
@@ -17,77 +18,63 @@ class TeleTypeCommand extends command_1.Command {
         }
         console.log("(use -h for description and options) \n");
         // room not known, prompt
-        const ROOM = "to an existing room (you have the room link)";
-        const NEW = "new room";
-        try {
-            const answer = await new Select({
-                name: "",
-                message: "Choose streaming destination",
-                choices: [NEW, ROOM],
-            }).run();
-            switch (answer) {
-                case ROOM:
-                    await this.streamToLink({ shell, multiplex });
-                    break;
-                case NEW:
-                    await this.createRoomAndStream({ shell, multiplex });
-                    break;
-            }
-        }
-        catch (e) {
-            process.exit(100);
+        const ROOM = "To an existing room (you have the room link)";
+        const NEW = "New room";
+        const answer = await new Select({
+            name: "",
+            message: "Choose streaming destination",
+            choices: [NEW, ROOM],
+        }).run();
+        switch (answer) {
+            case ROOM:
+                await this.streamToLink({ shell, multiplex });
+                break;
+            case NEW:
+                await this.createRoomAndStream({ shell, multiplex });
+                break;
         }
         process.exit(0);
     }
     async streamToLink(options) {
-        const roomLink = options.roomLink ||
-            (await new Input({
-                name: "room secret link",
-                message: "enter the room secret link. (click the share button in the room)",
-            }).run());
-        try {
-            const app = await oorja_1.getApp(roomLink);
-            const roomKey = app.getRoomKey(roomLink);
-            this.clearstdin();
-            await app.teletype(Object.assign(Object.assign({ roomKey }, options), { process }));
-        }
-        catch (e) {
-            if (e instanceof oorja_1.InvalidRoomLink) {
-                console.log(config_1.INVALID_ROOM_LINK_MESSAGE);
-                process.exit(3);
-            }
+        const roomLink = options.roomLink || (await utils_1.promptRoomLink());
+        if (!roomLink) {
+            console.log(chalk.redBright("Room link not provided :("));
+            process.exit();
         }
+        const app = await oorja_1.getApp({ roomLink });
+        const roomKey = app.getRoomKey(roomLink);
+        this.clearstdin();
+        await app.teletype(Object.assign(Object.assign({ roomKey }, options), { process }));
     }
     async createRoomAndStream({ shell, multiplex, }) {
         const app = await oorja_1.getApp();
         const spinner = ora({
-            text: chalk.bold("creating room with TeleType app"),
+            text: chalk.bold("Creating room with TeleType app"),
             discardStdin: false,
         }).start();
-        try {
-            const { roomKey } = await app.createRoom({
-                roomName: "-",
-                apps: {
-                    defaultFocus: "39",
-                    appList: [
-                        { appId: "39", config: {} },
-                        { appId: "31", config: {} },
-                        { appId: "40", config: {} },
-                        { appId: "100", config: {} },
-                    ],
-                },
-            });
-            spinner.succeed(chalk.bold("room created")).clear();
-            const link = app.linkForRoom(roomKey);
-            console.log(`\n${chalk.bold(chalk.blueBright(link))}\n`);
-            console.log(chalk.bold("^^ you'll be streaming here, share this link with your friends."));
-            this.clearstdin();
-            return await app.teletype({ roomKey, shell, multiplex, process });
-        }
-        catch (e) {
-            console.log("failed to create room.");
+        const { roomKey } = await app
+            .createRoom({
+            roomName: "-",
+            apps: {
+                defaultFocus: "39",
+                appList: [
+                    { appId: "39", config: {} },
+                    { appId: "31", config: {} },
+                    { appId: "40", config: {} },
+                    { appId: "100", config: {} },
+                ],
+            },
+        })
+            .catch((e) => {
+            console.log("Failed to create room.");
             process.exit(9);
-        }
+        });
+        spinner.succeed(chalk.bold("Room created")).clear();
+        const link = app.linkForRoom(roomKey);
+        console.log(`\n${chalk.bold(chalk.blueBright(link))}\n`);
+        console.log(chalk.bold("^^ You'll be streaming here, share this link with your friends."));
+        this.clearstdin();
+        return await app.teletype({ roomKey, shell, multiplex, process });
     }
     clearstdin() {
         process.stdin.read();
@@ -99,14 +86,14 @@ TeleTypeCommand.aliases = ["tty"];
 TeleTypeCommand.description = `Launch a terminal streaming session in oorja.`;
 TeleTypeCommand.examples = [
     `${chalk.blueBright("$ teletype")}
-will prompt to choose streaming destination - existing room or create a new one.
+Will prompt to choose streaming destination - existing room or create a new one.
 
 `,
     `${chalk.blueBright(`$ teletype '${config_1.ROOM_LINK_SAMPLE}'`)}
-will stream to the room specified by secret link, you must have joined the room before streaming.
+Will stream to the room specified by secret link, you must have joined the room before streaming.
 
 `,
-    `${chalk.blueBright(`$ teletype -m '${config_1.ROOM_LINK_SAMPLE}'`)}
+    `${chalk.blueBright("$ teletype -m")}
 Will also allow room participants to write to your terminal!
 
 `,
@@ -120,7 +107,7 @@ TeleTypeCommand.flags = {
     }),
     multiplex: command_1.flags.boolean({
         char: "m",
-        description: "allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room participants. Off by default",
+        description: "Allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room participants. Off by default",
         default: false,
     }),
 };

package/lib/lib/config.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { URL } from "url";
-export declare const CLI_VERSION = 1.4;
+export declare const CLI_VERSION = 1.5;
 export declare const config: any;
 export declare type env = "staging" | "local" | "prod" | "prod-teletype";
 export declare type SuryaConfig = {

package/lib/lib/config.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getoorjaConfig = exports.setENVAccessToken = exports.getENVAccessToken = exports.determineENV = exports.INVALID_ROOM_LINK_MESSAGE = exports.ROOM_LINK_SAMPLE = exports.getSuryaConfig = exports.config = exports.CLI_VERSION = void 0;
 const chalk = require("chalk");
-exports.CLI_VERSION = 1.4;
+exports.CLI_VERSION = 1.5;
 const Conf = require("conf");
 exports.config = new Conf({
     projectName: "oorja",

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

@@ -1,23 +1,23 @@
-import { env } from "../config";
+import { oorjaConfig } from "../config";
 import { User, RoomKey } from "../surya/types";
 import { TeletypeOptions } from "../teletype";
-import { CreateRoomOptions } from "../surya";
+import { CreateRoomOptions, SuryaClient } from "../surya";
 export declare class InvalidRoomLink extends Error {
 }
 declare class OORJA {
-    user: User | null;
-    private ready;
-    private config?;
-    initialize: (env: env) => Promise<this>;
+    private config;
+    private suryaClient;
+    user: User;
+    constructor(config: oorjaConfig, suryaClient: SuryaClient, user: User);
     createRoom: (options: CreateRoomOptions) => Promise<{
         room: import("../surya/types").Room;
         roomKey: RoomKey;
     }>;
     linkForRoom: (roomKey: RoomKey) => string;
     getRoomKey(roomLink: string): RoomKey;
-    linkForTokenGen: () => string;
-    teletype: (options: Omit<TeletypeOptions, "userId">) => Promise<unknown>;
-    private oorjaURL;
+    teletype: (options: Omit<TeletypeOptions, "userId" | "joinChannel">) => Promise<unknown>;
 }
-export declare const getApp: (roomLink?: string | undefined) => Promise<OORJA>;
+export declare const getApp: (options?: {
+    roomLink?: string;
+}) => Promise<OORJA>;
 export {};

package/lib/lib/oorja/index.js

@@ -3,30 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getApp = exports.InvalidRoomLink = void 0;
 const config_1 = require("../config");
 const teletype_1 = require("../teletype");
-const preflight_1 = require("./preflight");
 const surya_1 = require("../surya");
 const url_1 = require("url");
 const encryption_1 = require("../encryption");
+const preflight_1 = require("./preflight");
 class InvalidRoomLink extends Error {
 }
 exports.InvalidRoomLink = InvalidRoomLink;
 class OORJA {
-    constructor() {
-        // should capture domain related commands and queries
-        this.user = null;
-        this.ready = false;
-        this.initialize = (env) => {
-            if (this.ready)
-                throw "cannot reinit";
-            this.config = config_1.getoorjaConfig(env);
-            return preflight_1.preflightChecks(env, this.linkForTokenGen()).then((user) => {
-                this.user = user;
-                this.ready = true;
-                return this;
-            });
-        };
+    // should capture domain related commands and queries
+    constructor(config, suryaClient, user) {
+        this.config = config;
+        this.suryaClient = suryaClient;
+        this.user = user;
         this.createRoom = async (options) => {
-            const room = await surya_1.createRoom(options);
+            const room = await this.suryaClient.createRoom(options);
             const roomKey = encryption_1.createRoomKey(room.id);
             return {
                 room,
@@ -34,39 +25,72 @@ class OORJA {
             };
         };
         this.linkForRoom = (roomKey) => {
-            return `${this.oorjaURL()}/rooms?id=${roomKey.roomId}#${encryption_1.exportKey(roomKey.key)}`;
+            return `${oorjaURL(this.config)}/rooms?id=${roomKey.roomId}#${encryption_1.exportKey(roomKey.key)}`;
         };
-        this.linkForTokenGen = () => `${this.oorjaURL()}/access_token`;
-        this.teletype = (options) => teletype_1.teletypeApp(Object.assign({ userId: this.user.id }, options));
-        this.oorjaURL = () => {
-            const { host, enableTLS } = this.config;
-            return enableTLS ? `https://${host}` : `http://${host}`;
+        this.teletype = (options) => {
+            return teletype_1.teletypeApp(Object.assign({ userId: this.user.id, joinChannel: this.suryaClient.joinChannel }, options));
         };
     }
     getRoomKey(roomLink) {
-        const url = parseRoomLink(roomLink);
+        const url = parseRoomURL(roomLink);
         return {
             key: encryption_1.importKey(url.hash),
             roomId: url.searchParams.get("id"),
         };
     }
 }
-const parseRoomLink = (roomLink) => {
+const parseRoomURL = (roomLink) => {
     const url = new url_1.URL(roomLink);
-    if (!url.searchParams.get("id") || !url.hash)
-        throw new InvalidRoomLink();
+    if (!url.searchParams.get("id") || !url.hash) {
+        console.log(config_1.INVALID_ROOM_LINK_MESSAGE);
+        process.exit(3);
+    }
     return url;
 };
+const getRoomId = (roomURL) => {
+    const id = roomURL.searchParams.get("id");
+    return id || undefined;
+};
+const oorjaURL = (config) => {
+    const { host, enableTLS } = config;
+    return enableTLS ? `https://${host}` : `http://${host}`;
+};
+const linkForTokenGen = (config) => `${oorjaURL(config)}/access_token`;
+const init = async (env, options = {}) => {
+    const config = config_1.getoorjaConfig(env);
+    let suryaClient = new surya_1.SuryaClient(env);
+    await preflight_1.validateCliVersion(suryaClient);
+    let user = await preflight_1.resumeSession(env, suryaClient, options.roomId);
+    if (!user) {
+        let token = "";
+        if (options.roomId) {
+            token = await preflight_1.loginByRoomOTP(suryaClient, options.roomId);
+        }
+        else {
+            token = await preflight_1.promptAuth(suryaClient, linkForTokenGen(config));
+            if (!token) {
+                console.log("Token not provided :(");
+                process.exit(12);
+            }
+        }
+        config_1.setENVAccessToken(env, token);
+    }
+    await suryaClient.destroy();
+    suryaClient = new surya_1.SuryaClient(env);
+    user = await preflight_1.preflight(env, suryaClient);
+    return new OORJA(config, suryaClient, user);
+};
 let currentEnv;
 let oorja;
-exports.getApp = (roomLink) => {
-    const env = config_1.determineENV(roomLink ? parseRoomLink(roomLink) : undefined);
+exports.getApp = async (options = {}) => {
+    const { roomLink } = options;
+    const roomURL = roomLink ? parseRoomURL(roomLink) : undefined;
+    const env = config_1.determineENV(undefined);
     if (oorja) {
         if (env !== currentEnv) {
-            return Promise.reject("attempt to run different env in same session");
+            return Promise.reject("Attempt to run different env in same session");
         }
         return Promise.resolve(oorja);
     }
-    oorja = new OORJA();
-    return oorja.initialize(env);
+    return await init(env, { roomId: roomURL ? getRoomId(roomURL) : undefined });
 };

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

@@ -1,2 +1,9 @@
 import { env } from "../config";
-export declare const preflightChecks: (env: env, generateTokenLink: string) => Promise<import("../surya/types").User>;
+import { SuryaClient } from "../surya";
+import { User } from "../surya/types";
+export declare const promptRoomParticipantOTP: () => Promise<string>;
+export declare const promptAuth: (suryaClient: SuryaClient, generateTokenLink: string) => Promise<string>;
+export declare const loginByRoomOTP: (suryaClient: SuryaClient, roomId: string) => Promise<string>;
+export declare const validateCliVersion: (suryaClient: SuryaClient) => Promise<void>;
+export declare const resumeSession: (env: env, suryaClient: SuryaClient, roomId?: string | undefined) => Promise<User | null>;
+export declare const preflight: (env: env, suryaClient: SuryaClient) => Promise<User>;

package/lib/lib/oorja/preflight.js

@@ -1,71 +1,106 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.preflightChecks = void 0;
+exports.preflight = exports.resumeSession = exports.validateCliVersion = exports.loginByRoomOTP = exports.promptAuth = exports.promptRoomParticipantOTP = void 0;
 const chalk = require("chalk");
 const { Input, Select } = require("enquirer");
 const ora = require("ora");
 const config_1 = require("../config");
-const surya_1 = require("../surya");
 const errors_1 = require("../surya/errors");
 const promptToken = () => new Input({
     name: "Access Token",
     message: "Please enter your access token for authentication:",
 }).run();
-const promptAuth = async (env, generateTokenLink) => {
-    const HAS_TOKEN = "I have a token with me";
+exports.promptRoomParticipantOTP = () => new Input({
+    name: "OTP prompt",
+    message: "Please enter your OTP for authentication:",
+}).run();
+const OTP_HELP_MESSAGE = "You can generate OTP from the room, it's in the instruction steps";
+exports.promptAuth = async (suryaClient, generateTokenLink) => {
     const ANON = "Proceed as an anonymous user";
-    const SIGN_IN = "sign-in with oorja";
-    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 all participants\n`);
+    const SIGN_IN = "Sign-in with oorja";
+    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 new Select({
         message: "You need an access-token for authentication.\n ",
-        choices: [HAS_TOKEN, ANON, SIGN_IN],
+        choices: [ANON, SIGN_IN],
     }).run();
     switch (answer) {
-        case HAS_TOKEN:
-            return promptToken();
         case ANON:
-            console.log("creating anonymous user...");
-            return surya_1.createAnonymousUser(env);
+            console.log("Creating anonymous user...");
+            return suryaClient.createAnonymousUser();
         case SIGN_IN:
             console.log(`You can sign-in and generate your token here: ${chalk.blue(generateTokenLink)}`);
             return promptToken();
     }
-    throw Error("unexpected input");
+    throw Error("Unexpected input");
+};
+exports.loginByRoomOTP = async (suryaClient, roomId) => {
+    const otp = await exports.promptRoomParticipantOTP();
+    if (!otp) {
+        console.log("OTP not provided :(");
+        console.log(OTP_HELP_MESSAGE);
+        process.exit(213);
+    }
+    try {
+        return await suryaClient.accessTokenFromRoomParticipantOTP(roomId, otp);
+    }
+    catch (e) {
+        if (e instanceof errors_1.BadRequest) {
+            console.log(chalk.redBright("Invalid otp. It may have expired."));
+            console.log(OTP_HELP_MESSAGE);
+            process.exit();
+        }
+        throw e;
+    }
+};
+exports.validateCliVersion = async (suryaClient) => {
+    const manifest = await suryaClient.fetchCliManifest();
+    if (manifest.cliVersion > config_1.CLI_VERSION) {
+        console.log(chalk.redBright("Your oorja cli is outdated. Please run: npm update -g oorja"));
+        process.exit(1);
+    }
 };
-exports.preflightChecks = async (env, generateTokenLink) => {
-    const token = config_1.getENVAccessToken(env) || (await promptAuth(env, generateTokenLink)).trim();
-    if (!token) {
-        console.log("token not provided :(");
-        process.exit(12);
+exports.resumeSession = async (env, suryaClient, roomId) => {
+    const token = config_1.getENVAccessToken(env);
+    if (!token)
+        return null;
+    // try to validate authorization with existing token
+    try {
+        const user = await suryaClient.fetchSessionUser();
+        if (roomId) {
+            await suryaClient.fetchRoom(roomId);
+        }
+        return user;
     }
-    config_1.setENVAccessToken(env, token);
+    catch (e) {
+        if (e instanceof errors_1.Unauthorized) {
+            config_1.setENVAccessToken(env, "");
+            return null;
+        }
+        throw e;
+    }
+};
+exports.preflight = async (env, suryaClient) => {
     const spinner = ora({
-        text: "authenticating",
+        text: "Authenticating",
         discardStdin: false,
     }).start();
-    const suryaConfig = config_1.getSuryaConfig(env);
-    surya_1.initializeSurya(suryaConfig);
     try {
-        const manifest = await surya_1.fetchCliManifest();
-        if (manifest.cliVersion > config_1.CLI_VERSION) {
-            spinner.fail(chalk.yellowBright("your oorja cli is outdated. please run: npm update -g oorja"));
-            process.exit(1);
-        }
-        const user = await surya_1.fetchSessionUser();
-        spinner.succeed(`authenticated: Welcome ${user.name}`);
+        const user = await suryaClient.fetchSessionUser();
+        spinner.succeed(`Authenticated: Welcome ${user.name}`);
         if (user.profileType === "anon") {
             // don't persist tokens for anonymous users
             config_1.setENVAccessToken(env, "");
             console.log(chalk.yellowBright("You're an anonymous user. CLI will not remember the auth-token"));
         }
-        spinner.start("connecting..");
-        return surya_1.establishSocket(suryaConfig)
+        spinner.start("Connecting..");
+        return suryaClient
+            .establishSocket()
             .then(() => {
-            spinner.succeed("connected").clear();
+            spinner.succeed("Connected").clear();
             return user;
         })
             .catch((e) => {
-            spinner.fail("socket connection failure..");
+            spinner.fail("Socket connection failure..");
             throw e;
         });
     }
@@ -76,7 +111,7 @@ exports.preflightChecks = async (env, generateTokenLink) => {
             process.exit(33);
         }
         else {
-            spinner.fail("something went wrong :(");
+            spinner.fail("Something went wrong :(");
         }
         throw e;
     }

package/lib/lib/surya/errors.d.ts

@@ -1,4 +1,6 @@
-export declare class Unauthorized extends Error {
+export declare class ClientError extends Error {
 }
-export declare class BadRequest extends Error {
+export declare class Unauthorized extends ClientError {
+}
+export declare class BadRequest extends ClientError {
 }

package/lib/lib/surya/errors.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BadRequest = exports.Unauthorized = void 0;
-class Unauthorized extends Error {
+exports.BadRequest = exports.Unauthorized = exports.ClientError = void 0;
+class ClientError extends Error {
+}
+exports.ClientError = ClientError;
+class Unauthorized extends ClientError {
 }
 exports.Unauthorized = Unauthorized;
-class BadRequest extends Error {
+class BadRequest extends ClientError {
 }
 exports.BadRequest = BadRequest;

package/lib/lib/surya/index.d.ts

@@ -1,19 +1,27 @@
 import { User, RoomApps, Room, CliManifest } from "./types";
-import { SuryaConfig, env } from "../config";
+import { env } from "../config";
 import { Channel } from "./vendor/phoenix";
 export declare class SuryaError extends Error {
 }
-export declare const initializeSurya: (config: SuryaConfig) => void;
-export declare const fetchCliManifest: () => Promise<CliManifest>;
-export declare const fetchSessionUser: () => Promise<User>;
+export declare class SuryaClient {
+    private config;
+    private client;
+    private socket?;
+    constructor(env: env);
+    fetchCliManifest: () => Promise<CliManifest>;
+    fetchSessionUser: () => Promise<User>;
+    createRoom: ({ roomName, apps }: CreateRoomOptions) => Promise<Room>;
+    createAnonymousUser: () => Promise<string>;
+    accessTokenFromRoomParticipantOTP: (roomId: string, otp: string) => Promise<string>;
+    fetchRoom: (roomId: string) => Promise<Room>;
+    establishSocket: () => Promise<void>;
+    joinChannel: ({ channel, params, onJoin, onClose, onError, onMessage, handleSessionJoin, handleSessionLeave, }: JoinChannelOptions<any>) => Channel;
+    destroy: () => Promise<unknown>;
+}
 export declare type CreateRoomOptions = {
     roomName: string;
     apps: RoomApps;
 };
-export declare const createRoom: ({ roomName, apps, }: CreateRoomOptions) => Promise<Room>;
-export declare const createAnonymousUser: (env: env) => Promise<string>;
-export declare const fetchRoom: (roomId: string) => Promise<Room>;
-export declare const establishSocket: (config: SuryaConfig) => Promise<void>;
 export declare type JoinChannelOptions<T> = {
     channel: string;
     params: T;
@@ -24,4 +32,3 @@ export declare type JoinChannelOptions<T> = {
     handleSessionJoin: (session: string) => void;
     handleSessionLeave: (session: string) => void;
 };
-export declare const joinChannel: ({ channel, params, onJoin, onClose, onError, onMessage, handleSessionJoin, handleSessionLeave, }: JoinChannelOptions<any>) => Channel;

package/lib/lib/surya/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.joinChannel = exports.establishSocket = exports.fetchRoom = exports.createAnonymousUser = exports.createRoom = exports.fetchSessionUser = exports.fetchCliManifest = exports.initializeSurya = exports.SuryaError = void 0;
+exports.SuryaClient = exports.SuryaError = void 0;
 // backend api client
 const https = require("https");
 const axios_1 = require("axios");
@@ -13,23 +13,175 @@ const camelcaseKeys = require("camelcase-keys");
 class SuryaError extends Error {
 }
 exports.SuryaError = SuryaError;
-let client;
-let socket;
+class SuryaClient {
+    constructor(env) {
+        this.fetchCliManifest = async () => {
+            try {
+                const response = await this.client.get("/cli");
+                return camelcaseKeys(response.data);
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.fetchSessionUser = async () => {
+            try {
+                const response = await this.client.get("/session/user");
+                return resources_1.defaultParser(response.data.data);
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.createRoom = async ({ roomName, apps }) => {
+            const body = {
+                room: {
+                    apps,
+                    locked: false,
+                    name: roomName || "-",
+                },
+            };
+            try {
+                const response = await this.client.post("/rooms", body);
+                return resources_1.defaultParser(response.data.data);
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.createAnonymousUser = async () => {
+            try {
+                const response = await this.client.post("/session/anon");
+                return response.data.access_token;
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.accessTokenFromRoomParticipantOTP = async (roomId, otp) => {
+            try {
+                const response = await this.client.post("/access_tokens/from_room_participant_otp", {
+                    room_id: roomId,
+                    otp: otp,
+                });
+                return response.data.data.token;
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.fetchRoom = async (roomId) => {
+            try {
+                const response = await this.client.get(`/rooms/${roomId}`);
+                return resources_1.defaultParser(response.data.data);
+            }
+            catch (error) {
+                return handleError(error);
+            }
+        };
+        this.establishSocket = async () => {
+            const protocolPrefix = this.config.enableTLS ? `wss://` : `ws://`;
+            const host = this.config.host;
+            let encodeMessage = (rawdata, callback) => {
+                if (!rawdata)
+                    return;
+                return callback(msgpack_1.encode(rawdata));
+            };
+            let decodeMessage = (rawdata, callback) => {
+                if (!rawdata)
+                    return;
+                const data = new Uint8Array(rawdata);
+                return callback(msgpack_1.decode(data.buffer));
+            };
+            return new Promise((resolve, reject) => {
+                let initialConnection = false;
+                this.socket = new phoenix_1.Socket(`${protocolPrefix}${host}/socket`, {
+                    params: {
+                        access_token: this.config.token,
+                    },
+                    binaryType: "arraybuffer",
+                    encode: encodeMessage,
+                    decode: decodeMessage,
+                });
+                this.socket.onOpen(() => {
+                    initialConnection = true;
+                    resolve();
+                });
+                this.socket.onError(() => {
+                    if (!initialConnection) {
+                        reject();
+                        return;
+                    }
+                    console.error("connection error");
+                    process.exit(2);
+                });
+                // @ts-ignore
+                this.socket.connect();
+            });
+        };
+        this.joinChannel = ({ channel, params, onJoin, onClose, onError, onMessage, handleSessionJoin, handleSessionLeave, }) => {
+            if (!this.socket)
+                throw Error("no socket connection");
+            const chan = this.socket.channel(channel, params);
+            if (onError)
+                chan.onError(onError);
+            if (onClose)
+                chan.onClose(onClose);
+            let presences = [];
+            chan.on("new_msg", (msg) => {
+                onMessage(msg);
+            });
+            chan.on("presence_state", (response) => {
+                phoenix_1.Presence.syncState(presences, response, handleSessionJoin, undefined);
+                presences = response;
+            });
+            chan.on("presence_diff", (newPresence) => {
+                presences = phoenix_1.Presence.syncDiff(presences, newPresence, handleSessionJoin, handleSessionLeave);
+            });
+            chan
+                .join()
+                .receive("ok", () => {
+                if (onJoin)
+                    onJoin();
+            })
+                .receive("error", (resp) => {
+                if (resp && resp.reason === "unauthorized") {
+                    if (onError)
+                        onError(new errors_1.Unauthorized("unauthorized: user needs to join the room before a stream can be started."));
+                    return;
+                }
+                process.exit(3);
+            });
+            return chan;
+        };
+        this.destroy = async () => {
+            return new Promise((resolve) => {
+                if (this.socket) {
+                    this.socket.disconnect(resolve, 1000, "disconnecting surya client");
+                }
+                else {
+                    resolve(undefined);
+                }
+            });
+        };
+        const config = config_1.getSuryaConfig(env);
+        this.client = axios_1.default.create({
+            httpsAgent: new https.Agent({
+                minVersion: "TLSv1.2",
+                maxVersion: "TLSv1.2",
+            }),
+            baseURL: suryaBaseURL(config.host, config.enableTLS),
+            timeout: 5000,
+            responseType: "json",
+            headers: {
+                "x-access-token": config.token || "",
+            },
+        });
+        this.config = config;
+    }
+}
+exports.SuryaClient = SuryaClient;
 const suryaBaseURL = (host, tlsEnabled) => `${tlsEnabled ? "https" : "http"}://${host}/api/v1`;
-exports.initializeSurya = (config) => {
-    client = axios_1.default.create({
-        httpsAgent: new https.Agent({
-            minVersion: "TLSv1.2",
-            maxVersion: "TLSv1.2",
-        }),
-        baseURL: suryaBaseURL(config.host, config.enableTLS),
-        timeout: 5000,
-        responseType: "json",
-        headers: {
-            "x-access-token": config.token || "",
-        },
-    });
-};
 const handleError = (error) => {
     const { response } = error;
     if (response) {
@@ -42,131 +194,3 @@ const handleError = (error) => {
     }
     throw error;
 };
-exports.fetchCliManifest = async () => {
-    try {
-        const response = await client.get("/cli");
-        return camelcaseKeys(response.data);
-    }
-    catch (error) {
-        return handleError(error);
-    }
-};
-exports.fetchSessionUser = async () => {
-    try {
-        const response = await client.get("/session/user");
-        return resources_1.defaultParser(response.data.data);
-    }
-    catch (error) {
-        return handleError(error);
-    }
-};
-exports.createRoom = async ({ roomName, apps, }) => {
-    const body = {
-        room: {
-            apps,
-            locked: false,
-            name: roomName || "-",
-        },
-    };
-    try {
-        const response = await client.post("/rooms", body);
-        return resources_1.defaultParser(response.data.data);
-    }
-    catch (error) {
-        return handleError(error);
-    }
-};
-exports.createAnonymousUser = async (env) => {
-    const config = config_1.getSuryaConfig(env);
-    try {
-        const response = await axios_1.default.post(`${suryaBaseURL(config.host, config.enableTLS)}/session/anon`);
-        return response.data.access_token;
-    }
-    catch (error) {
-        return handleError(error);
-    }
-};
-exports.fetchRoom = async (roomId) => {
-    try {
-        const response = await client.get(`/rooms/${roomId}`);
-        return resources_1.defaultParser(response.data.data);
-    }
-    catch (error) {
-        return handleError(error);
-    }
-};
-exports.establishSocket = async (config) => {
-    const protocolPrefix = config.enableTLS ? `wss://` : `ws://`;
-    const host = config.host;
-    let encodeMessage = (rawdata, callback) => {
-        if (!rawdata)
-            return;
-        return callback(msgpack_1.encode(rawdata));
-    };
-    let decodeMessage = (rawdata, callback) => {
-        if (!rawdata)
-            return;
-        const data = new Uint8Array(rawdata);
-        return callback(msgpack_1.decode(data.buffer));
-    };
-    return new Promise((resolve, reject) => {
-        let initialConnection = false;
-        socket = new phoenix_1.Socket(`${protocolPrefix}${host}/socket`, {
-            params: {
-                access_token: config.token,
-            },
-            binaryType: "arraybuffer",
-            encode: encodeMessage,
-            decode: decodeMessage,
-        });
-        socket.onOpen(() => {
-            initialConnection = true;
-            resolve();
-        });
-        socket.onError(() => {
-            if (!initialConnection) {
-                reject();
-                return;
-            }
-            console.error("connection error");
-            process.exit(2);
-        });
-        // @ts-ignore
-        socket.connect();
-    });
-};
-exports.joinChannel = ({ channel, params, onJoin, onClose, onError, onMessage, handleSessionJoin, handleSessionLeave, }) => {
-    if (!socket)
-        throw Error("no socket connection");
-    const chan = socket.channel(channel, params);
-    if (onError)
-        chan.onError(onError);
-    if (onClose)
-        chan.onClose(onClose);
-    let presences = [];
-    chan.on("new_msg", (msg) => {
-        onMessage(msg);
-    });
-    chan.on("presence_state", (response) => {
-        phoenix_1.Presence.syncState(presences, response, handleSessionJoin, undefined);
-        presences = response;
-    });
-    chan.on("presence_diff", (newPresence) => {
-        presences = phoenix_1.Presence.syncDiff(presences, newPresence, handleSessionJoin, handleSessionLeave);
-    });
-    chan
-        .join()
-        .receive("ok", () => {
-        if (onJoin)
-            onJoin();
-    })
-        .receive("error", (resp) => {
-        if (resp && resp.reason === "unauthorized") {
-            if (onError)
-                onError(new errors_1.Unauthorized("unauthorized: user needs to join the room before a stream can be started."));
-            return;
-        }
-        process.exit(3);
-    });
-    return chan;
-};

package/lib/lib/teletype/auxiliary.js

@@ -8,7 +8,7 @@ exports.initScreen = (username, hostname, shell, multiplexed) => {
     if (multiplexed) {
         console.log(chalk.yellowBright("You have allowed room participants to write to your shell"));
     }
-    console.log(chalk.blue(`${chalk.bold(`${username}@${hostname}`)} spawning streaming shell: ${chalk.bold(`${shell}`)}`));
+    console.log(chalk.blue(`${chalk.bold(`${username}@${hostname}`)} Spawning streaming shell: ${chalk.bold(`${shell}`)}`));
     console.log(`Note: Your shell size may adjust for optimum viewing experience for all participants.\n
 This session is end-to-end encrypted.
 To terminate stream run ${chalk.yellowBright("exit")} or press ${chalk.yellowBright("ctrl-d")} \n`);

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

@@ -1,10 +1,13 @@
 /// <reference types="node" />
 import { RoomKey } from "../surya/types";
+import { JoinChannelOptions } from "../surya";
+import { Channel } from "../surya/vendor/phoenix";
 export declare type TeletypeOptions = {
     userId: string;
     roomKey: RoomKey;
     shell: string;
     multiplex: boolean;
     process: NodeJS.Process;
+    joinChannel: (options: JoinChannelOptions<any>) => Channel;
 };
-export declare const teletypeApp: (config: TeletypeOptions) => Promise<unknown>;
+export declare const teletypeApp: (options: TeletypeOptions) => Promise<unknown>;

package/lib/lib/teletype/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.teletypeApp = void 0;
 const node_pty_1 = require("node-pty");
 const os = require("os");
-const surya_1 = require("../surya");
 const auxiliary_1 = require("./auxiliary");
 const chalk = require("chalk");
 const errors_1 = require("../surya/errors");
@@ -15,7 +14,7 @@ var MessageType;
     MessageType["DIMENSIONS"] = "d";
 })(MessageType || (MessageType = {}));
 const SELF = "self";
-exports.teletypeApp = (config) => {
+exports.teletypeApp = (options) => {
     const username = os.userInfo().username;
     const hostname = os.hostname();
     const userDimensions = {};
@@ -31,25 +30,25 @@ exports.teletypeApp = (config) => {
         auxiliary_1.resizeBestFit(term, userDimensions);
     };
     return new Promise((resolve, reject) => {
-        const channel = surya_1.joinChannel({
-            channel: `teletype:${config.roomKey.roomId}`,
+        const channel = options.joinChannel({
+            channel: `teletype:${options.roomKey.roomId}`,
             params: {
                 username,
                 hostname,
-                multiplexed: config.multiplex,
+                multiplexed: options.multiplex,
             },
             onJoin: () => {
-                auxiliary_1.initScreen(username, hostname, config.shell, config.multiplex);
-                const stdin = config.process.stdin;
-                const stdout = config.process.stdout;
+                auxiliary_1.initScreen(username, hostname, options.shell, options.multiplex);
+                const stdin = options.process.stdin;
+                const stdout = options.process.stdout;
                 const dimensions = userDimensions[SELF];
-                term = node_pty_1.spawn(config.shell, [], {
+                term = node_pty_1.spawn(options.shell, [], {
                     name: "xterm-256color",
                     cols: dimensions.cols,
                     rows: dimensions.rows,
-                    cwd: config.process.cwd(),
+                    cwd: options.process.cwd(),
                     // @ts-ignore
-                    env: config.process.env,
+                    env: options.process.env,
                 });
                 // track own dimensions and keep it up to date
                 setInterval(reEvaluateOwnDimensions, 1000);
@@ -60,7 +59,7 @@ exports.teletypeApp = (config) => {
                     channel.push("new_msg", {
                         t: MessageType.OUT,
                         b: true,
-                        d: encryption_1.encrypt(d, config.roomKey),
+                        d: encryption_1.encrypt(d, options.roomKey),
                     });
                 });
                 term.on("exit", () => {
@@ -91,13 +90,13 @@ exports.teletypeApp = (config) => {
                         auxiliary_1.resizeBestFit(term, userDimensions);
                         break;
                     case MessageType.IN:
-                        const data = encryption_1.decrypt(d, config.roomKey);
+                        const data = encryption_1.decrypt(d, options.roomKey);
                         const userId = session.split(":")[0];
-                        if (config.multiplex) {
+                        if (options.multiplex) {
                             term.write(data);
                             return;
                         }
-                        if (userId === config.userId) {
+                        if (userId === options.userId) {
                             term.write(data);
                         }
                         else {

package/lib/lib/utils.d.ts

@@ -0,0 +1 @@
+export declare const promptRoomLink: () => Promise<string>;

package/lib/lib/utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptRoomLink = void 0;
+const { Input } = require("enquirer");
+exports.promptRoomLink = async () => {
+    return await new Input({
+        name: "room secret link",
+        message: "Enter the room secret link. (click the share button in the room)",
+    }).run();
+};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.4.1","commands":{"signout":{"id":"signout","description":"sign-out of oorja. clears saved auth-token","pluginName":"oorja","pluginType":"core","aliases":[],"flags":{},"args":[]},"teletype":{"id":"teletype","description":"Launch a terminal streaming session in oorja.","pluginName":"oorja","pluginType":"core","aliases":["tty"],"examples":["\u001b[94m$ teletype\u001b[39m\nwill prompt to choose streaming destination - existing room or create a new one.\n\n","\u001b[94m$ teletype 'https://oorja.io/rooms?id=foo#key'\u001b[39m\nwill stream to the room specified by secret link, you must have joined the room before streaming.\n\n","\u001b[94m$ teletype -m 'https://oorja.io/rooms?id=foo#key'\u001b[39m\nWill also allow room participants to write to your terminal!\n\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"shell":{"name":"shell","type":"option","char":"s","description":"shell to use. e.g. bash, fish","default":"/usr/bin/zsh"},"multiplex":{"name":"multiplex","type":"boolean","char":"m","description":"allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room participants. Off by default","allowNo":false}},"args":[{"name":"room"}]}}}
+{"version":"1.5.1","commands":{"signout":{"id":"signout","description":"Sign-out of oorja. Clears saved auth-token","pluginName":"oorja","pluginType":"core","aliases":[],"flags":{},"args":[]},"teletype":{"id":"teletype","description":"Launch a terminal streaming session in oorja.","pluginName":"oorja","pluginType":"core","aliases":["tty"],"examples":["\u001b[94m$ teletype\u001b[39m\nWill prompt to choose streaming destination - existing room or create a new one.\n\n","\u001b[94m$ teletype 'https://oorja.io/rooms?id=foo#key'\u001b[39m\nWill stream to the room specified by secret link, you must have joined the room before streaming.\n\n","\u001b[94m$ teletype -m\u001b[39m\nWill also allow room participants to write to your terminal!\n\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"shell":{"name":"shell","type":"option","char":"s","description":"shell to use. e.g. bash, fish","default":"/usr/bin/zsh"},"multiplex":{"name":"multiplex","type":"boolean","char":"m","description":"Allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room participants. Off by default","allowNo":false}},"args":[{"name":"room"}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oorja",
   "description": "stream terminals to the web and more.",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "author": "Akshay Kumar @akshaykmr",
   "bin": {
     "oorja": "./bin/run",
@@ -13,7 +13,7 @@
     "@oclif/command": "^1",
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^3",
-    "axios": "^0.19.2",
+    "axios": "^0.21.1",
     "camelcase-keys": "^6.2.2",
     "chalk": "^4.1.0",
     "conf-cli": "^0.1.9",
@@ -28,14 +28,14 @@
     "@oclif/dev-cli": "^1",
     "@types/node": "^10",
     "globby": "^10",
+    "prettier": "^2.0.5",
     "ts-node": "^8",
     "tslint": "^6.1.1",
     "tslint-config-airbnb": "^5.11.2",
     "tslint-config-prettier": "^1.18.0",
     "tslint-plugin-prettier": "^2.3.0",
     "tslint-react": "^4.2.0",
-    "typescript": "^3.3",
-    "prettier": "^2.0.5"
+    "typescript": "^3.3"
   },
   "engines": {
     "node": ">=10.4.0"