oorja 1.7.5 → 1.7.6

package/README.md

@@ -24,11 +24,13 @@ Your stream can be view-only or collaboration enabled (command-line flag).
 
 # Install and stream!
 
-- You'll need Node 16. CLI is available via npm. <br />
+- You'll need Node 18.17.1 >. CLI is available via npm. <br />
   <a href="https://nodejs.org/en/download/" target="_blank">
   You can setup node/npm from here.
-  </a> **Only Node 16 is supported**
-- **optional but highly recommended for successful install -> [npm install without sudo](https://github.com/sindresorhus/guides/blob/master/npm-global-without-sudo.md)**.
+  </a> 
+- Package does fail on some systems because of node-pty compilation failures. I'm thinking it's better to package the whole thing
+as a binary in future releases (i.e. not available via npm but via a script or manual install).
+
 - `npm install -g oorja`
 - `teletype`
 - `teletype -m`  (for collaboration mode)

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node --trace-warnings
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/oorja

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

package/bin/teletype

@@ -2,6 +2,6 @@
 
 process.argv.splice(2, 0, 'teletype')
 
-require('@oclif/command').run()
-  .then(require('@oclif/command/flush'))
-  .catch(require('@oclif/errors/handle'))
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/{lib → dist}/commands/signout.d.ts

@@ -1,4 +1,4 @@
-import { Command } from "@oclif/command";
+import { Command } from "@oclif/core";
 export declare class SignOut extends Command {
     static description: string;
     run(): Promise<void>;

package/{lib → dist}/commands/signout.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignOut = void 0;
-const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
 const config_1 = require("../lib/config");
-class SignOut extends command_1.Command {
+class SignOut extends core_1.Command {
     async run() {
         const env = (0, config_1.determineENV)();
         (0, config_1.setENVAccessToken)(env, "");

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

@@ -0,0 +1,19 @@
+import { Command } from "@oclif/core";
+export default class TeleTypeCommand extends Command {
+    static aliases: string[];
+    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>;
+    };
+    static args: {
+        room: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    private streamToLink;
+    private createRoomAndStream;
+    private clearstdin;
+}

package/{lib → dist}/commands/teletype/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const { Select } = require("enquirer");
-const command_1 = require("@oclif/command");
+const core_1 = require("@oclif/core");
 const ora = require("ora");
 const os = require("os");
 const chalk = require("chalk");
@@ -9,9 +9,9 @@ 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 {
+class TeleTypeCommand extends core_1.Command {
     async run() {
-        const { args, flags: { shell, multiplex, new_room }, } = this.parse(TeleTypeCommand);
+        const { args, flags: { shell, multiplex, new_room }, } = await this.parse(TeleTypeCommand);
         if (args.room) {
             await this.streamToLink({ shell, multiplex, roomLink: args.room });
             process.exit(0);
@@ -48,7 +48,7 @@ class TeleTypeCommand extends command_1.Command {
         const app = await (0, oorja_1.getApp)({ roomLink });
         const roomKey = app.getRoomKey(roomLink);
         this.clearstdin();
-        await app.teletype(Object.assign(Object.assign({ roomKey }, options), { process }));
+        await app.teletype({ roomKey, ...options, process });
     }
     async createRoomAndStream({ shell, multiplex, }) {
         const app = await (0, oorja_1.getApp)();
@@ -105,21 +105,23 @@ Will also allow room participants to write to your terminal!
 `,
 ];
 TeleTypeCommand.flags = {
-    help: command_1.flags.help({ char: "h" }),
-    shell: command_1.flags.string({
+    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: command_1.flags.boolean({
+    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: command_1.flags.boolean({
+    new_room: core_1.Flags.boolean({
         char: "n",
         description: "Create new room",
         default: false,
     }),
 };
-TeleTypeCommand.args = [{ name: "room" }];
+TeleTypeCommand.args = {
+    room: core_1.Args.string({})
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/{lib/lib → dist}/index.js

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

package/{lib → dist}/lib/config.d.ts

@@ -1,5 +1,5 @@
 import { URL } from "url";
-export declare const CLI_VERSION = 1.73;
+export declare const CLI_VERSION = 1.76;
 export declare const config: any;
 export type env = "staging" | "local" | "prod" | "prod-teletype";
 export type SuryaConfig = {

package/{lib → dist}/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.73;
+exports.CLI_VERSION = 1.76;
 const Conf = require("conf");
 exports.config = new Conf({
     projectName: "oorja",
@@ -14,6 +14,7 @@ const getSuryaConfig = (env) => {
             case "local":
                 return "localhost:4000";
             case "staging":
+                return "surya-staging.oorja.io";
             case "prod":
             case "prod-teletype":
                 return "surya.oorja.io";

package/{lib → dist}/lib/oorja/index.js

@@ -28,7 +28,11 @@ class OORJA {
             return `${oorjaURL(this.config)}/rooms?id=${roomKey.roomId}#${(0, encryption_1.exportKey)(roomKey.key)}`;
         };
         this.teletype = (options) => {
-            return (0, teletype_1.teletypeApp)(Object.assign({ userId: this.user.id, joinChannel: this.suryaClient.joinChannel }, options));
+            return (0, teletype_1.teletypeApp)({
+                userId: this.user.id,
+                joinChannel: this.suryaClient.joinChannel,
+                ...options,
+            });
         };
     }
     getRoomKey(roomLink) {

package/{lib → dist}/lib/surya/vendor/phoenix/constants.d.ts

@@ -1,6 +1,6 @@
-export declare const globalSelf: any;
-export declare const phxWindow: any;
-export declare const global: any;
+export declare const globalSelf: (Window & typeof globalThis) | null;
+export declare const phxWindow: (Window & typeof globalThis) | null;
+export declare const global: {};
 export declare const DEFAULT_VSN = "2.0.0";
 export declare const SOCKET_STATES: {
     connecting: number;

package/{lib → dist}/lib/surya/vendor/phoenix/socket.d.ts

@@ -180,7 +180,7 @@ export default class Socket {
     /**
      * @returns {string}
      */
-    connectionState(): "closed" | "connecting" | "open" | "closing";
+    connectionState(): "open" | "closed" | "connecting" | "closing";
     /**
      * @returns {boolean}
      */

package/{lib → dist}/lib/teletype/index.js

@@ -52,7 +52,7 @@ const teletypeApp = (options) => {
                 });
                 // track own dimensions and keep it up to date
                 setInterval(reEvaluateOwnDimensions, 1000);
-                term.on("data", (d) => {
+                term.onData((d) => {
                     stdout.write(d);
                     // revisit: is it worth having one letter names, instead of something descriptive
                     // does it really save bytes?
@@ -62,13 +62,13 @@ const teletypeApp = (options) => {
                         d: (0, encryption_1.encrypt)(d, options.roomKey),
                     });
                 });
-                term.on("exit", () => {
+                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));
+                stdin.on("data", (d) => term.write(d.toString("utf8")));
             },
             onClose: () => {
                 console.log(chalk.redBright("connection closed, terminated stream."));

package/oclif.manifest.json

@@ -1 +1,68 @@
-{"version":"1.7.5","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},"new_room":{"name":"new_room","type":"boolean","char":"n","description":"Create new room","allowNo":false}},"args":[{"name":"room"}]}}}
+{
+  "version": "1.7.6",
+  "commands": {
+    "signout": {
+      "id": "signout",
+      "description": "Sign-out of oorja. Clears saved auth-token",
+      "strict": true,
+      "pluginName": "oorja",
+      "pluginAlias": "oorja",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "teletype": {
+      "id": "teletype",
+      "description": "Launch a terminal streaming session in oorja.",
+      "strict": true,
+      "pluginName": "oorja",
+      "pluginAlias": "oorja",
+      "pluginType": "core",
+      "aliases": [
+        "tty"
+      ],
+      "examples": [
+        "$ teletype\nWill prompt to choose streaming destination - existing room or create a new one.\n\n",
+        "$ teletype 'https://oorja.io/rooms?id=foo#key'\nWill stream to the room specified by secret link, you must have joined the room before streaming.\n\n",
+        "$ teletype -m\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",
+          "multiple": false,
+          "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
+        },
+        "new_room": {
+          "name": "new_room",
+          "type": "boolean",
+          "char": "n",
+          "description": "Create new room",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "room": {
+          "name": "room"
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oorja",
   "description": "stream terminals to the web and more.",
-  "version": "1.7.5",
+  "version": "1.7.6",
   "author": "Akshay Kumar @akshaykmr",
   "bin": {
     "oorja": "./bin/run",
@@ -10,44 +10,45 @@
   "bugs": "https://github.com/akshaykmr/TeleType/issues",
   "dependencies": {
     "@msgpack/msgpack": "^2.8.0",
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
-    "@oclif/plugin-help": "^3",
-    "axios": "^1.2",
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^3.4.0",
+    "axios": "^1.5.0",
     "camelcase-keys": "^6.2.2",
-    "chalk": "^4",
-    "conf-cli": "^0.1.9",
-    "enquirer": "^2.3.6",
-    "node-pty": "^0.10.1",
+
+    "chalk": "^4.1.2",
     "ora": "^4",
+
+    "conf-cli": "^0.1.9",
+    "enquirer": "^2.4.1",
+    "node-pty": "^1.0.0",
     "term-size": "^2.2.0",
-    "tslib": "^1",
-    "ws": "^8.11"
+    "tslib": "^2.6.2",
+    "ws": "^8.14.1"
   },
   "devDependencies": {
-    "@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": "^4.9.4",
-    "aws-sdk": "2.1282"
+    "@types/node": "^16.18.50",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "oclif": "^3.15.0",
+    "prettier": "^3.0.3",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.2",
+    "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=16.0.0 <17.0.0"
+    "node": ">=18.17.1"
   },
   "files": [
     "/bin",
-    "/lib",
+    "/dist",
     "/npm-shrinkwrap.json",
     "/oclif.manifest.json"
   ],
-  "homepage": "https://teletype.oorja.io",
+  "homepage": "https://oorja.io",
   "keywords": [
     "teletype",
     "terminal",
@@ -56,32 +57,27 @@
     "cli"
   ],
   "license": "SEE LICENSE IN license.txt",
-  "main": "lib/index.js",
+  "main": "dist/index.js",
   "oclif": {
-    "commands": "./lib/commands",
+    "commands": "./dist/commands",
     "bin": "oorja",
     "plugins": [
       "@oclif/plugin-help",
+      "@oclif/plugin-plugins",
       "conf-cli"
-    ],
-    "update": {
-      "s3": {
-        "host": "https://cli-dist-a327765.s3.amazonaws.com",
-        "bucket": "cli-dist-a327765"
-      }
-    }
+    ]
   },
   "repository": "akshaykmr/TeleType",
   "scripts": {
-    "postpack": "rm -f oclif.manifest.json",
-    "prepack": "rm -rf lib && tsc --skipLibCheck true && oclif-dev manifest && oclif-dev readme",
-    "test": "echo NO TESTS",
-    "version": "oclif-dev readme && git add README.md",
-    "lint": "tslint -p ./tsconfig.json -t stylish",
-    "lint-fix": "tslint -p ./tsconfig.json -t stylish --fix",
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md",
     "prettier": "prettier --write './**/*.{ts,tsx,js,css,html}'"
   },
-  "types": "lib/index.d.ts",
+  "types": "dist/index.d.ts",
   "optionalDependencies": {
     "bufferutil": "^4.0.1",
     "utf-8-validate": "^5.0.2"

package/NOTICE.txt

@@ -1,5 +0,0 @@
-oorja | teletype
-Copyright 2020 akshay@oorja.io
-
-This product includes software developed for https://oorja.io
-a realtime-collaboration app. see license.txt for details

package/bin/run

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

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

@@ -1,19 +0,0 @@
-import { Command, flags } from "@oclif/command";
-export default class TeleTypeCommand extends Command {
-    static aliases: string[];
-    static description: string;
-    static examples: string[];
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-        shell: flags.IOptionFlag<string>;
-        multiplex: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-        new_room: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
-    };
-    static args: {
-        name: string;
-    }[];
-    run(): Promise<void>;
-    private streamToLink;
-    private createRoomAndStream;
-    private clearstdin;
-}

package/lib/lib/index.d.ts

@@ -1 +0,0 @@
-export { run } from "@oclif/command";