oorja 2.5.2 → 2.5.4

package/README.md

@@ -71,7 +71,7 @@ Launch a terminal streaming session in SupaKit.
 
 ```
 USAGE
-  $ oorja teletype [STREAMKEY] [-h] [-s <value>] [-m] [-n]
+  $ oorja teletype [STREAMKEY] [-h] [-s <value>] [-m] [-n] [--anonymous] [--ci-debug]
 
 FLAGS
   -h, --help           Show CLI help.
@@ -79,6 +79,8 @@ FLAGS
                        participants. Off by default
   -n, --new            Create a new space
   -s, --shell=<value>  shell to use. e.g. bash, fish
+      --anonymous      Create an anonymous session without prompting for sign-in.
+      --ci-debug       Create a new anonymous writable bash stream for CI debugging.
 
 DESCRIPTION
   Launch a terminal streaming session in SupaKit.
@@ -96,6 +98,9 @@ EXAMPLES
 
   $ teletype -m
   Will also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.
+
+  $ teletype --ci-debug
+  Creates a new anonymous stream without prompting for sign-in. Useful for CI debug sessions you want to control from the link.
 ```
 
 ## `oorja signout`

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

@@ -9,6 +9,8 @@ export default class TeleTypeCommand extends Command {
         shell: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         multiplex: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         new: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        anonymous: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'ci-debug': 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

@@ -26,6 +26,10 @@ you share your stream-keys with others.
         `${chalk.blueBright('$ teletype -m')}
 Will also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.
 
+`,
+        `${chalk.blueBright('$ teletype --ci-debug')}
+Creates a new anonymous stream without prompting for sign-in. Useful for CI debug sessions you want to control from the link.
+
 `,
     ];
     static flags = {
@@ -46,21 +50,33 @@ Will also allow participants to write to your terminal! Collaboration mode must
             description: 'Create a new space',
             default: false,
         }),
+        anonymous: Flags.boolean({
+            description: 'Create an anonymous session without prompting for sign-in.',
+            default: false,
+        }),
+        'ci-debug': Flags.boolean({
+            aliases: ['ci'],
+            description: 'Create a new anonymous writable bash stream for CI debugging.',
+            default: false,
+        }),
     };
     static args = {
         streamKey: Args.string({}),
     };
     async run() {
-        const { args, flags: { shell: selectedShell, multiplex, new: createNewSpace }, } = await this.parse(TeleTypeCommand);
-        const shell = selectedShell || DEFAULT_SHELL;
+        const { args, flags: { shell: selectedShell, multiplex, new: createNewSpace, anonymous, 'ci-debug': ciDebug }, } = await this.parse(TeleTypeCommand);
+        const shell = selectedShell || (ciDebug ? 'bash' : DEFAULT_SHELL);
+        const shouldCreateNewSpace = createNewSpace || ciDebug;
+        const shouldUseAnonymousAuth = anonymous || ciDebug;
+        const shouldMultiplex = multiplex || ciDebug;
         const config = new Config(this.config.configDir);
         const app = new App(config);
         if (args.streamKey) {
-            await this.streamUsingStreamKey(app, { shell, multiplex, streamKey: args.streamKey });
+            await this.streamUsingStreamKey(app, { shell, multiplex: shouldMultiplex, streamKey: args.streamKey });
             exit(0);
         }
-        if (createNewSpace) {
-            await this.createRoomAndStream(app, { shell, multiplex });
+        if (shouldCreateNewSpace) {
+            await this.createRoomAndStream(app, { shell, multiplex: shouldMultiplex, anonymous: shouldUseAnonymousAuth });
             exit(0);
         }
         console.log('(use -h for description and options) \n');
@@ -77,10 +93,10 @@ Will also allow participants to write to your terminal! Collaboration mode must
         ]);
         switch (answer) {
             case STREAM_USING_STREAM_KEY:
-                await this.streamUsingStreamKey(app, { shell, multiplex });
+                await this.streamUsingStreamKey(app, { shell, multiplex: shouldMultiplex });
                 break;
             case STREAM_TO_NEW_SPACE:
-                await this.createRoomAndStream(app, { shell, multiplex });
+                await this.createRoomAndStream(app, { shell, multiplex: shouldMultiplex, anonymous: shouldUseAnonymousAuth });
                 break;
         }
         exit(0);
@@ -92,13 +108,13 @@ Will also allow participants to write to your terminal! Collaboration mode must
             exit();
         }
         const streamKeyStruct = parseStreamKey(streamKey);
-        const oorja = await app.init(streamKeyStruct);
+        const oorja = await app.init({ streamKey: streamKeyStruct });
         const roomKey = oorja.getRoomKey(streamKeyStruct);
         this.clearstdin();
         await oorja.teletype({ roomKey, ...options, process });
     }
-    async createRoomAndStream(app, { shell, multiplex }) {
-        const oorja = await app.init();
+    async createRoomAndStream(app, { shell, multiplex, anonymous }) {
+        const oorja = await app.init({ authMode: anonymous ? 'anonymous' : 'prompt' });
         const spinner = ora({
             text: chalk.bold('Creating space with TeleType app'),
             discardStdin: false,
@@ -131,6 +147,9 @@ Will also allow participants to write to your terminal! Collaboration mode must
         spinner.succeed(chalk.bold('Space created')).clear();
         const link = oorja.linkForRoom(roomKey, inviteCode);
         console.log(`\n${chalk.bold(chalk.blueBright(link))}\n`);
+        if (anonymous && multiplex) {
+            console.log(chalk.yellowBright('Anyone with this link can access and write to this shell. Share it carefully.'));
+        }
         console.log(chalk.bold("^^ You'll be streaming here ^^"));
         this.clearstdin();
         return await oorja.teletype({ roomKey, shell, multiplex, process });

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

@@ -5,6 +5,11 @@ import { CreateRoomOptions, ConnectClient } from 'oorja/lib/connect/index';
 import { Future } from 'oorja/lib/utils';
 export declare class InvalidRoomLink extends Error {
 }
+export type AuthMode = 'prompt' | 'anonymous';
+type AppInitOptions = {
+    streamKey?: StreamKey;
+    authMode?: AuthMode;
+};
 export declare class OORJA {
     private config;
     private connectClient;
@@ -31,7 +36,7 @@ export declare class App {
     connectionCheckFuture: Future<void>;
     private connectClient;
     constructor(config: Config);
-    init: (streamKey?: StreamKey) => Promise<OORJA>;
+    init: (options?: AppInitOptions) => Promise<OORJA>;
     private establishConnection;
     private tryResumeSession;
     private socketConnect;

package/dist/lib/oorja/index.js

@@ -2,7 +2,7 @@ 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 { createAnonymousSession, promptAuth, validateCliVersion } from 'oorja/lib/oorja/preflight';
 import { getRegion } from 'oorja/lib/oorja/client';
 import ora from 'ora';
 import { Future, printExitMessage } from 'oorja/lib/utils';
@@ -85,7 +85,8 @@ export class App {
         this.establishConnection();
         this.connectionCheckFuture = new Future();
     }
-    init = async (streamKey) => {
+    init = async (options = {}) => {
+        const { streamKey } = options;
         let spinner = ora({
             text: 'Checking connectivity..',
             discardStdin: true,
@@ -98,13 +99,16 @@ export class App {
         }
         spinner.succeed('Online');
         const oorjaConfig = getoorjaConfig(this.config.getEnv());
-        const isControlledMode = this.config.hasInjectedAccessToken();
+        const authMode = options.authMode || 'prompt';
+        const isControlledMode = authMode !== 'anonymous' && this.config.hasInjectedAccessToken();
         let user = undefined;
         try {
             if (!streamKey) {
-                user = await this.tryResumeSession(isControlledMode);
+                user = authMode === 'anonymous' ? undefined : await this.tryResumeSession(isControlledMode);
                 if (!user) {
-                    const token = await promptAuth(this.connectClient, linkForTokenGen(oorjaConfig));
+                    const token = authMode === 'anonymous'
+                        ? await createAnonymousSession(this.connectClient)
+                        : await promptAuth(this.connectClient, linkForTokenGen(oorjaConfig));
                     if (!token) {
                         printExitMessage('Token not provided :(');
                         exit(12);

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

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

package/dist/lib/oorja/preflight.js

@@ -12,6 +12,11 @@ const promptToken = () => inquirer
     },
 ])
     .then((answers) => answers.accessToken);
+export const createAnonymousSession = async (connectClient) => {
+    console.log('Creating anonymous user...');
+    connectClient.setAccessToken('');
+    return connectClient.createAnonymousUser();
+};
 export const promptAuth = async (connectClient, generateTokenLink) => {
     const ANON = 'Proceed as an anonymous user';
     const SIGN_IN = 'Sign in with SupaKit';
@@ -26,8 +31,7 @@ export const promptAuth = async (connectClient, generateTokenLink) => {
     ]);
     switch (answer) {
         case ANON:
-            console.log('Creating anonymous user...');
-            return connectClient.createAnonymousUser();
+            return createAnonymousSession(connectClient);
         case SIGN_IN:
             console.log(`You can sign-in and generate your token here: ${chalk.blue(generateTokenLink)}`);
             return promptToken();

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

@@ -1,4 +1,5 @@
 import { IPty } from 'node-pty';
+export declare const DEFAULT_DIMENSIONS: dimensions;
 export declare const initScreen: (username: string, hostname: string, shell: string, multiplexed: boolean) => void;
 export type dimensions = {
     rows: number;

package/dist/lib/teletype/auxiliary.js

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import termSize from 'terminal-size';
+export const DEFAULT_DIMENSIONS = { rows: 24, cols: 80 };
 export const initScreen = (username, hostname, shell, multiplexed) => {
     console.log(chalk.bold(chalk.blueBright('TeleType')));
     if (multiplexed) {
@@ -11,6 +12,9 @@ To terminate stream run ${chalk.yellowBright('exit')} or press ${chalk.yellowBri
 };
 export const getDimensions = () => {
     const { rows, columns } = termSize();
+    if (!Number.isFinite(rows) || !Number.isFinite(columns) || rows < 1 || columns < 1) {
+        return DEFAULT_DIMENSIONS;
+    }
     return { rows, cols: columns };
 };
 export const areDimensionEqual = (a, b) => {
@@ -18,6 +22,9 @@ export const areDimensionEqual = (a, b) => {
 };
 export const resizeBestFit = (term, userDimensions, shouldClearScreen = false) => {
     const allViewports = Object.values(userDimensions);
+    if (allViewports.length === 0) {
+        return;
+    }
     const minrows = Math.min(...allViewports.map((d) => d.rows));
     const mincols = Math.min(...allViewports.map((d) => d.cols));
     term.resize(mincols, minrows);

package/dist/lib/teletype/index.js

@@ -1,6 +1,6 @@
 import { spawn } from 'node-pty';
 import * as os from 'os';
-import { getDimensions, initScreen, areDimensionEqual, resizeBestFit } from 'oorja/lib/teletype/auxiliary';
+import { DEFAULT_DIMENSIONS, getDimensions, initScreen, areDimensionEqual, resizeBestFit, } from 'oorja/lib/teletype/auxiliary';
 import chalk from 'chalk';
 import { Unauthorized } from 'oorja/lib/connect/errors';
 import { encrypt, decrypt } from 'oorja/lib/encryption';
@@ -17,9 +17,7 @@ export class TeletypeSession {
     options;
     username = os.userInfo().username;
     hostname = os.hostname();
-    userDimensions = {
-        [SELF]: getDimensions(),
-    };
+    userDimensions = {};
     channel;
     term;
     sessionCount = 0;
@@ -50,7 +48,11 @@ export class TeletypeSession {
     });
     startTerm = () => {
         const { stdin, stdout } = this.options.process;
-        const dimensions = this.userDimensions[SELF];
+        const shouldReadLocalStdin = stdin.isTTY && typeof stdin.setRawMode === 'function';
+        const dimensions = shouldReadLocalStdin ? getDimensions() : DEFAULT_DIMENSIONS;
+        if (shouldReadLocalStdin) {
+            this.userDimensions[SELF] = dimensions;
+        }
         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',
@@ -61,6 +63,9 @@ export class TeletypeSession {
         });
         this.ptyFuture.promise.then(() => {
             initScreen(this.username, this.hostname, this.options.shell, this.options.multiplex);
+            if (!shouldReadLocalStdin) {
+                return;
+            }
             if (this.options.shell.endsWith('bash')) {
                 stdout.write('Adjusting shell prompt to show streaming indicator\n');
                 this.term.write("export PS1='📡 [streaming] '$PS1\n");
@@ -102,22 +107,29 @@ export class TeletypeSession {
             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);
+        if (shouldReadLocalStdin) {
+            stdin.setEncoding('utf8');
+            stdin.setRawMode(true);
+            stdin.on('data', stdinDataHandler);
+        }
         this.cleanupShell = ({ killTerm = true } = {}) => {
             clearInterval(dimensionPoll);
             ptyDataSubscription.dispose();
             ptyExitSubscription.dispose();
-            stdin.off('data', stdinDataHandler);
-            stdin.setRawMode(false);
+            if (shouldReadLocalStdin) {
+                stdin.off('data', stdinDataHandler);
+                stdin.setRawMode(false);
+            }
             if (killTerm) {
                 this.term.kill();
             }
         };
     };
     reEvaluateOwnDimensions = () => {
+        if (!this.userDimensions[SELF]) {
+            return;
+        }
         const lastKnown = this.userDimensions[SELF];
         const latest = getDimensions();
         if (areDimensionEqual(lastKnown, latest)) {

package/oclif.manifest.json

@@ -33,7 +33,8 @@
       "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 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"
+        "\u001b[94m$ teletype -m\u001b[39m\nWill also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.\n\n",
+        "\u001b[94m$ teletype --ci-debug\u001b[39m\nCreates a new anonymous stream without prompting for sign-in. Useful for CI debug sessions you want to control from the link.\n\n"
       ],
       "flags": {
         "help": {
@@ -69,6 +70,21 @@
           "name": "new",
           "allowNo": false,
           "type": "boolean"
+        },
+        "anonymous": {
+          "description": "Create an anonymous session without prompting for sign-in.",
+          "name": "anonymous",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "ci-debug": {
+          "aliases": [
+            "ci"
+          ],
+          "description": "Create a new anonymous writable bash stream for CI debugging.",
+          "name": "ci-debug",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -89,5 +105,5 @@
       ]
     }
   },
-  "version": "2.5.2"
+  "version": "2.5.4"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oorja",
   "description": "stream terminals to the web and more.",
-  "version": "2.5.2",
+  "version": "2.5.4",
   "packageManager": "pnpm@11.5.2",
   "keywords": [
     "teletype",