oorja 1.9.0 → 1.11.3

package/README.md

@@ -1,12 +1,13 @@
 TeleType
 =====
 
-cli tool that allows you to share your terminal online conveniently. Check out [teletype.oorja.io](https://teletype.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 [oorja.io](https://oorja.io) - 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)
 [![Follow](https://img.shields.io/twitter/follow/oorja_app?style=social)](https://twitter.com/oorja_app)
 
+
 <p align="center">
   <img width="600" src="https://teletype.oorja.io/images/cli-demo.svg">
 </p>
@@ -17,6 +18,8 @@ cli tool that allows you to share your terminal online conveniently. Check out [
 
 Your stream can be view-only or collaboration enabled (command-line flag).
 
+
+
 <!-- toc -->
 * [Install and stream!](#install-and-stream)
 * [Commands](#commands)
@@ -24,7 +27,7 @@ Your stream can be view-only or collaboration enabled (command-line flag).
 
 # Install and stream!
 
-- You'll need Node 18.17.1 >. CLI is available via npm. <br />
+- You'll need Node 18.18.0 >. CLI is available via npm. <br />
   <a href="https://nodejs.org/en/download/" target="_blank">
   You can setup node/npm from here.
   </a> 
@@ -47,23 +50,46 @@ 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 [teletype.oorja.io](https://teletype.oorja.io) which is a privacy focussed collaboration tool with more features like voice, notes, and chat - [privacy policy](https://teletype.oorja.io/privacy_policy).
+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).
 TLDR: Nothing stored on servers. Your data is end-to-end encrypted, synced between browsers (and cli) 🍻. No prying eyes. 
 
 Like it ? [follow or tweet, tell your colleagues](https://twitter.com/oorja_app) 👩🏻‍💻
 
-Love it ? [please subscribe](https://teletype.oorja.io/subscription) 🖖
+Love it ? [please subscribe](https://oorja.io/pricing) 🖖
 
 Feel free to open [issues](https://github.com/akshaykmr/TeleType/issues) for bugs, improvements, app-discussions, and anything else really.
 
-More ways to [contact](https://teletype.oorja.io/contact).
+More ways to [contact](https://oorja.io/contact).
 
 
 # Commands
-
+<!-- commands-disabled-->
+* [`oorja help [COMMAND]`](#oorja-help-command)
 * [`oorja teletype [ROOM]`](#oorja-teletype-room)
+* [`oorja tty [ROOM]`](#oorja-tty-room)
+* [`oorja conf [KEY] [VALUE]`](#oorja-conf-key-value)
 * [`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.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
+
 
 ## `oorja teletype [ROOM]`
 
@@ -71,54 +97,72 @@ Launch a terminal streaming session in oorja.
 
 ```
 USAGE
-  $ oorja teletype [ROOM]
-
-OPTIONS
-  -h, --help         show CLI help
+  $ oorja teletype [ROOM] [-h] [-s <value>] [-m] [-n]
 
-  -m, --multiplex    allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room
-                     participants. Off by default
+FLAGS
+  -h, --help           Show CLI help.
+  -m, --multiplex      Allows room users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust room
+                       participants. Off by default
+  -n, --new_room       Create new room
+  -s, --shell=<value>  [default: /usr/bin/zsh] shell to use. e.g. bash, fish
 
-  -s, --shell=shell  [default: /usr/bin/fish] shell to use. e.g. bash, fish
+DESCRIPTION
+  Launch a terminal streaming session in oorja.
 
 ALIASES
   $ oorja tty
 
 EXAMPLES
   $ 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.
 
   $ teletype 'https://oorja.io/rooms?id=foo#key'
-  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.
 
-
-  $ teletype -m 'https://oorja.io/rooms?id=foo#key'
+  $ teletype -m
   Will also allow room participants to write to your terminal!
 ```
 
+_See code: [src/commands/teletype/index.ts](https://github.com/akshaykmr/teletype/blob/v1.11.2/src/commands/teletype/index.ts)_
+
 ## `oorja signout`
 
-sign-out and clear saved access token from any prior login. By default cli
-saves the token for any signed-in user (anonymous tokens aren't remembered).
-Any new command will ask for a token again after sign-out.
+Sign-out of oorja. Clears saved auth-token
 
 ```
 USAGE
   $ oorja signout
+
+DESCRIPTION
+  Sign-out of oorja. Clears saved auth-token
 ```
 
-## `oorja help [COMMAND]`
+_See code: [src/commands/signout.ts](https://github.com/akshaykmr/teletype/blob/v1.11.2/src/commands/signout.ts)_
 
-display help for oorja
+## `oorja conf [KEY] [VALUE]`
+
+manage configuration (for setting access tokens and env vars)
 
 ```
 USAGE
-  $ oorja help [COMMAND]
+  $ oorja conf [KEY] [VALUE] [-h] [-k <value>] [-v <value>] [-d] [-p <value>] [-n <value>] [-d <value>]
 
 ARGUMENTS
-  COMMAND  command to show help for
-
-OPTIONS
-  --all  see all commands in CLI
+  KEY    key of the config
+  VALUE  value of the config
+
+FLAGS
+  -d, --cwd=<value>      config file location
+  -d, --delete           delete?
+  -h, --help             show CLI help
+  -k, --key=<value>      key of the config
+  -n, --name=<value>     config file name
+  -p, --project=<value>  project name
+  -v, --value=<value>    value of the config
+
+DESCRIPTION
+  manage configuration
 ```
+
+_See code: [conf-cli](https://github.com/natzcam/conf-cli/blob/v0.1.9/src/commands/conf.ts)_
+<!-- commandsstop-disabled -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --trace-warnings --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/bin/teletype.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+process.argv.splice(2, 0, 'teletype')
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/signout.js

@@ -1,14 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignOut = void 0;
-const core_1 = require("@oclif/core");
-const config_1 = require("../lib/config");
-class SignOut extends core_1.Command {
+import { Command } from "@oclif/core";
+import { determineENV, setENVAccessToken } from "../lib/config.js";
+export class SignOut extends Command {
+    static description = `Sign-out of oorja. Clears saved auth-token`;
     async run() {
-        const env = (0, config_1.determineENV)();
-        (0, config_1.setENVAccessToken)(env, "");
+        const env = determineENV();
+        setENVAccessToken(env, "");
         console.log("Sign-out complete");
     }
 }
-exports.SignOut = SignOut;
-SignOut.description = `Sign-out of oorja. Clears saved auth-token`;

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

@@ -4,13 +4,13 @@ export default class TeleTypeCommand extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
-        shell: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        multiplex: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        new_room: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        shell: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        multiplex: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        new_room: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static args: {
-        room: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+        room: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
     run(): Promise<void>;
     private streamToLink;

package/dist/commands/teletype/index.js

@@ -1,15 +1,50 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const { Select } = require("enquirer");
-const core_1 = require("@oclif/core");
-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");
+import inquirer from 'inquirer';
+import { Command, Flags, Args } from "@oclif/core";
+import ora from "ora";
+import * as os from "os";
+import chalk from "chalk";
+import { ROOM_LINK_SAMPLE } from "../../lib/config.js";
+import { getApp } from "../../lib/oorja/index.js";
+import { promptRoomLink } from "../../lib/utils.js";
 const DEFAULT_SHELL = os.platform() === "win32" ? "powershell.exe" : process.env.SHELL || "bash";
-class TeleTypeCommand extends core_1.Command {
+export default class TeleTypeCommand extends Command {
+    static aliases = ["tty"];
+    static description = `Launch a terminal streaming session in oorja.`;
+    static examples = [
+        `${chalk.blueBright("$ teletype")}
+Will prompt to choose streaming destination - existing room or create a new one.
+
+`,
+        `${chalk.blueBright(`$ teletype '${ROOM_LINK_SAMPLE}'`)}
+Will stream to the room specified by secret link, you must have joined the room before streaming.
+
+`,
+        `${chalk.blueBright("$ teletype -m")}
+Will also allow room participants to write to your terminal!
+
+`,
+    ];
+    static flags = {
+        help: Flags.help({ char: "h" }),
+        shell: Flags.string({
+            char: "s",
+            description: "shell to use. e.g. bash, fish",
+            default: DEFAULT_SHELL,
+        }),
+        multiplex: 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",
+            default: false,
+        }),
+        new_room: Flags.boolean({
+            char: "n",
+            description: "Create new room",
+            default: false,
+        }),
+    };
+    static args = {
+        room: Args.string({})
+    };
     async run() {
         const { args, flags: { shell, multiplex, new_room }, } = await this.parse(TeleTypeCommand);
         if (args.room) {
@@ -24,11 +59,14 @@ class TeleTypeCommand extends core_1.Command {
         // room not known, prompt
         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();
+        const { answer } = await inquirer.prompt([
+            {
+                type: 'list',
+                name: 'answer',
+                message: 'Choose streaming destination',
+                choices: [NEW, ROOM],
+            }
+        ]);
         switch (answer) {
             case ROOM:
                 await this.streamToLink({ shell, multiplex });
@@ -40,18 +78,18 @@ class TeleTypeCommand extends core_1.Command {
         process.exit(0);
     }
     async streamToLink(options) {
-        const roomLink = options.roomLink || (await (0, utils_1.promptRoomLink)());
+        const roomLink = options.roomLink || (await promptRoomLink());
         if (!roomLink) {
             console.log(chalk.redBright("Room link not provided :("));
             process.exit();
         }
-        const app = await (0, oorja_1.getApp)({ roomLink });
+        const app = await getApp({ roomLink });
         const roomKey = app.getRoomKey(roomLink);
         this.clearstdin();
         await app.teletype({ roomKey, ...options, process });
     }
     async createRoomAndStream({ shell, multiplex, }) {
-        const app = await (0, oorja_1.getApp)();
+        const app = await getApp();
         const spinner = ora({
             text: chalk.bold("Creating room with TeleType app"),
             discardStdin: false,
@@ -87,41 +125,3 @@ class TeleTypeCommand extends core_1.Command {
         process.stdin.resume(); // FIXME: investigate weird quirk. stdin hangs if this is not present
     }
 }
-exports.default = TeleTypeCommand;
-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.
-
-`,
-    `${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.
-
-`,
-    `${chalk.blueBright("$ teletype -m")}
-Will also allow room participants to write to your terminal!
-
-`,
-];
-TeleTypeCommand.flags = {
-    help: core_1.Flags.help({ char: "h" }),
-    shell: core_1.Flags.string({
-        char: "s",
-        description: "shell to use. e.g. bash, fish",
-        default: DEFAULT_SHELL,
-    }),
-    multiplex: core_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",
-        default: false,
-    }),
-    new_room: core_1.Flags.boolean({
-        char: "n",
-        description: "Create new room",
-        default: false,
-    }),
-};
-TeleTypeCommand.args = {
-    room: core_1.Args.string({})
-};

package/dist/index.js

@@ -1,5 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-var core_1 = require("@oclif/core");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
+export { run } from '@oclif/core';

package/dist/lib/config.d.ts

@@ -1,6 +1,8 @@
+/// <reference types="node" resolution-mode="require"/>
 import { URL } from "url";
-export declare const CLI_VERSION = 1.9;
-export declare const config: any;
+export declare const CLI_VERSION = 1.91;
+import Conf from "conf";
+export declare const config: Conf<string>;
 export type env = "staging" | "local" | "prod" | "prod-teletype";
 export type SuryaConfig = {
     host: string;

package/dist/lib/config.js

@@ -1,14 +1,27 @@
-"use strict";
-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.90;
-const Conf = require("conf");
-exports.config = new Conf({
+import chalk from "chalk";
+export const CLI_VERSION = 1.91;
+import Conf from "conf";
+export const config = new Conf({
     projectName: "oorja",
-    projectVersion: exports.CLI_VERSION,
+    schema: {
+        "env": {
+            type: 'string'
+        },
+        "staging-access-token": {
+            type: 'string'
+        },
+        "local-access-token": {
+            type: 'string'
+        },
+        "prod-access-token": {
+            type: 'string'
+        },
+        "prod-teletype-access-token": {
+            type: 'string'
+        },
+    }
 });
-const getSuryaConfig = (env) => {
+export const getSuryaConfig = (env) => {
     const getHost = (env) => {
         switch (env) {
             case "local":
@@ -22,16 +35,15 @@ const getSuryaConfig = (env) => {
     };
     return {
         host: getHost(env),
-        token: (0, exports.getENVAccessToken)(env),
+        token: getENVAccessToken(env),
         enableTLS: env !== "local",
     };
 };
-exports.getSuryaConfig = getSuryaConfig;
-exports.ROOM_LINK_SAMPLE = "https://oorja.io/rooms?id=foo#key";
-exports.INVALID_ROOM_LINK_MESSAGE = `${chalk.redBright("invalid url ")}🤔. It should look like: ${chalk.blue(exports.ROOM_LINK_SAMPLE)}`;
-const determineENV = (roomURL) => {
+export const ROOM_LINK_SAMPLE = "https://oorja.io/rooms?id=foo#key";
+export const INVALID_ROOM_LINK_MESSAGE = `${chalk.redBright("invalid url ")}🤔. It should look like: ${chalk.blue(ROOM_LINK_SAMPLE)}`;
+export const determineENV = (roomURL) => {
     if (!roomURL)
-        return exports.config.get("env") || "prod-teletype";
+        return config.get("env") || "prod-teletype";
     switch (roomURL.host) {
         case "oorja.io":
             return "prod";
@@ -42,20 +54,17 @@ const determineENV = (roomURL) => {
         case "localhost:3000":
             return "local";
         default:
-            console.error(exports.INVALID_ROOM_LINK_MESSAGE);
+            console.error(INVALID_ROOM_LINK_MESSAGE);
             process.exit(1);
     }
 };
-exports.determineENV = determineENV;
-const getENVAccessToken = (env) => {
-    return exports.config.get(`${env}-access-token`);
+export const getENVAccessToken = (env) => {
+    return config.get(`${env}-access-token`) || "";
 };
-exports.getENVAccessToken = getENVAccessToken;
-const setENVAccessToken = (env, token) => {
-    exports.config.set(`${env}-access-token`, token);
+export const setENVAccessToken = (env, token) => {
+    config.set(`${env}-access-token`, token);
 };
-exports.setENVAccessToken = setENVAccessToken;
-const getoorjaConfig = (env) => {
+export const getoorjaConfig = (env) => {
     let host;
     switch (env) {
         case "local":
@@ -76,4 +85,3 @@ const getoorjaConfig = (env) => {
         enableTLS: env !== "local",
     };
 };
-exports.getoorjaConfig = getoorjaConfig;

package/dist/lib/encryption.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-import { RoomKey } from "./surya/types";
+/// <reference types="node" resolution-mode="require"/>
+import { RoomKey } from "./surya/types.js";
 export type EncryptedPayload = {
     iv: Buffer | Uint8Array;
     data: Buffer | Uint8Array;

package/dist/lib/encryption.js

@@ -1,40 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.decrypt = exports.encrypt = exports.importKey = exports.exportKey = exports.createRoomKey = void 0;
-const crypto = require("crypto");
-const msgpack_1 = require("@msgpack/msgpack");
+import * as crypto from "crypto";
+import { encode, decode } from "@msgpack/msgpack";
 const ALG = "aes-128-gcm";
 const KEY_SIZE = 16; // 128 bit AES
 const AUTH_TAG_LEN = 16;
-const createRoomKey = (roomId) => ({
+export const createRoomKey = (roomId) => ({
     roomId,
     key: createAESEncryptionKey(),
 });
-exports.createRoomKey = createRoomKey;
 const createAESEncryptionKey = () => crypto.randomBytes(KEY_SIZE);
-const exportKey = (key) => key.toString("base64");
-exports.exportKey = exportKey;
-const importKey = (exportedKey) => Buffer.from(exportedKey, "base64");
-exports.importKey = importKey;
+export const exportKey = (key) => key.toString("base64");
+export const importKey = (exportedKey) => Buffer.from(exportedKey, "base64");
 const createIV = () => crypto.randomBytes(16);
-const encrypt = (data, roomKey) => {
+export const encrypt = (data, roomKey) => {
     const iv = createIV();
     const cipher = crypto.createCipheriv(ALG, roomKey.key, iv);
     return {
         iv,
         data: Buffer.concat([
-            cipher.update((0, msgpack_1.encode)(data)),
+            cipher.update(encode(data)),
             cipher.final(),
             cipher.getAuthTag(),
         ]),
     };
 };
-exports.encrypt = encrypt;
-const decrypt = (payload, roomKey) => {
+export const decrypt = (payload, roomKey) => {
     const data = payload.data.slice(0, payload.data.length - AUTH_TAG_LEN);
     const authTag = payload.data.slice(payload.data.length - AUTH_TAG_LEN);
     const decipher = crypto.createDecipheriv(ALG, roomKey.key, payload.iv);
     decipher.setAuthTag(authTag);
-    return (0, msgpack_1.decode)(Buffer.concat([decipher.update(data), decipher.final()]));
+    return decode(Buffer.concat([decipher.update(data), decipher.final()]));
 };
-exports.decrypt = decrypt;

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

@@ -1,7 +1,7 @@
-import { oorjaConfig } from "../config";
-import { User, RoomKey } from "../surya/types";
-import { TeletypeOptions } from "../teletype";
-import { CreateRoomOptions, SuryaClient } from "../surya";
+import { oorjaConfig } from "../config.js";
+import { User, RoomKey } from "../surya/types.js";
+import { TeletypeOptions } from "../teletype/index.js";
+import { CreateRoomOptions, SuryaClient } from "../surya/index.js";
 export declare class InvalidRoomLink extends Error {
 }
 declare class OORJA {
@@ -10,7 +10,7 @@ declare class OORJA {
     user: User;
     constructor(config: oorjaConfig, suryaClient: SuryaClient, user: User);
     createRoom: (options: CreateRoomOptions) => Promise<{
-        room: import("../surya/types").Room;
+        room: import("../surya/types.js").Room;
         roomKey: RoomKey;
     }>;
     linkForRoom: (roomKey: RoomKey) => string;