oorja 2.2.0 → 2.3.0

package/README.md

@@ -83,20 +83,20 @@ DESCRIPTION
   Display help for oorja.
 ```
 
-## `oorja teletype [SPACE_URL]`
+## `oorja teletype [STREAM_KEY]`
 
 Launch a terminal streaming session in oorja.
 
 ```
 USAGE
-  $ oorja teletype [SPACE_URL] [-h] [-s <value>] [-m] [-n]
+  $ oorja teletype [STREAM_KEY] [-h] [-s <value>] [-m] [-n]
 
 FLAGS
   -h, --help           Show CLI help.
   -m, --multiplex      Allows users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust space
                        participants. Off by default
   -n, --new_space      Create new space
-  -s, --shell=<value>  [default: /usr/bin/zsh] shell to use. e.g. bash, fish
+  -s, --shell=<value>  [default: /usr/bin/bash] shell to use. e.g. bash, fish
 
 DESCRIPTION
   Launch a terminal streaming session in oorja.
@@ -108,8 +108,8 @@ EXAMPLES
   $ teletype
   Will prompt to choose streaming destination - existing space or create a new one.
 
-  $ teletype 'https://oorja.io/spaces?id=foo#key'
-  Will stream to the space specified by secret link, you must have joined the space before streaming.
+  $ teletype $stream-key
+  Will stream to the space specified by secret link.
 
   $ teletype -m
   Will also allow participants to write to your terminal!

package/dist/commands/teletype/index.js

@@ -1,13 +1,14 @@
 import inquirer from 'inquirer';
 import { Command, Flags, Args } from '@oclif/core';
 import ora from 'ora';
-import { hostname } from 'os';
+import { hostname, platform } from 'os';
 import chalk from 'chalk';
 import { Config, STREAM_KEY_SAMPLE } from '../../lib/config.js';
 import { App, parseStreamKey } from '../../lib/oorja/index.js';
 import { printExitMessage, promptStreamKey } from '../../lib/utils.js';
 import { Unauthorized } from '../../lib/connect/errors.js';
 import { exit } from '../../lib/exit.js';
+const DEFAULT_SHELL = platform() === 'win32' ? 'powershell.exe' : process.env.SHELL || 'bash';
 export default class TeleTypeCommand extends Command {
     static order = 1;
     static aliases = ['tty'];
@@ -32,7 +33,7 @@ Will also allow participants to write to your terminal! Collaboration mode must
         shell: Flags.string({
             char: 's',
             description: 'shell to use. e.g. bash, fish',
-            default: 'bash',
+            default: DEFAULT_SHELL,
         }),
         multiplex: Flags.boolean({
             char: 'm',
@@ -101,7 +102,7 @@ Will also allow participants to write to your terminal! Collaboration mode must
             discardStdin: false,
         }).start();
         const now = new Date();
-        const { roomKey } = await oorja
+        const { roomKey, inviteCode } = await oorja
             .createRoom({
             roomName: `Teletype session - ${hostname()} @ ${now.getHours()}:${now.getMinutes().toString().padStart(2, '0')}`,
             apps: {
@@ -126,7 +127,7 @@ Will also allow participants to write to your terminal! Collaboration mode must
             return Promise.reject();
         });
         spinner.succeed(chalk.bold('Space created')).clear();
-        const link = oorja.linkForRoom(roomKey);
+        const link = oorja.linkForRoom(roomKey, inviteCode);
         console.log(`\n${chalk.bold(chalk.blueBright(link))}\n`);
         console.log(chalk.bold("^^ You'll be streaming here ^^"));
         this.clearstdin();

package/dist/lib/config.d.ts

@@ -1,4 +1,4 @@
-export declare const CLI_VERSION = 2.7;
+export declare const CLI_VERSION = 2.8;
 export type env = 'local' | 'prod';
 export declare class Config {
     streamKeyAuth: boolean;

package/dist/lib/config.js

@@ -1,7 +1,7 @@
 import chalk from 'chalk';
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import path from 'path';
-export const CLI_VERSION = 2.7;
+export const CLI_VERSION = 2.8;
 export class Config {
     streamKeyAuth = false;
     configPath;

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

@@ -1,4 +1,4 @@
-import { User, RoomApps, Room, CliManifest } from './types.js';
+import { User, RoomApps, Room, CliManifest, NewRoomInviteResponse } from './types.js';
 import { env } from '../config.js';
 import { Channel } from 'phoenix';
 export declare class ApiClientError extends Error {
@@ -16,6 +16,9 @@ export declare class ConnectClient {
     fetchCliManifest: () => Promise<CliManifest>;
     fetchSessionUser: (v2?: boolean) => Promise<User>;
     createRoom: ({ roomName, apps }: CreateRoomOptions) => Promise<Room>;
+    createInviteCode: ({ roomId }: {
+        roomId: string;
+    }) => Promise<NewRoomInviteResponse>;
     createAnonymousUser: () => Promise<string>;
     fetchRoom: (roomId: string) => Promise<Room>;
     establishSocket: () => Promise<void>;

package/dist/lib/connect/index.js

@@ -100,6 +100,22 @@ export class ConnectClient {
             return handleError(error);
         }
     };
+    createInviteCode = async ({ roomId }) => {
+        const body = {
+            participant_access: 'can_edit',
+        };
+        try {
+            const response = await this._fetch(`/v1/rooms/${roomId}/invites`, {
+                method: 'POST',
+                body: JSON.stringify(body),
+            });
+            const data = await response.json();
+            return defaultParser(data);
+        }
+        catch (error) {
+            return handleError(error);
+        }
+    };
     createAnonymousUser = async () => {
         try {
             const response = await this._fetch('/v1/session/anon', { method: 'POST' });

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

@@ -34,7 +34,17 @@ export type RoomKey = {
     roomId: string;
     key: Buffer;
 };
-export type Hash<T> = {
-    [key: string]: T;
+export type ParticipantAccess = 'full_access' | 'can_edit' | 'can_view';
+export type RoomInvite = {
+    id: string;
+    creatorId: string;
+    insertedAt: string;
+    inviteCode: string;
+    participantAccess: ParticipantAccess;
+    roomId: string;
+};
+export type NewRoomInviteResponse = {
+    allInvites: RoomInvite[];
+    data: RoomInvite;
 };
 export {};

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

@@ -13,8 +13,9 @@ export declare class OORJA {
     createRoom: (options: CreateRoomOptions) => Promise<{
         room: import("../connect/types.js").Room;
         roomKey: RoomKey;
+        inviteCode: string;
     }>;
-    linkForRoom: (roomKey: RoomKey) => string;
+    linkForRoom: (roomKey: RoomKey, inviteCode: string) => string;
     getRoomKey(streamKey: StreamKey): RoomKey;
     teletype: (options: Omit<TeletypeOptions, "userId" | "joinChannel">) => Promise<unknown>;
 }

package/dist/lib/oorja/index.js

@@ -24,13 +24,15 @@ export class OORJA {
     createRoom = async (options) => {
         const room = await this.connectClient.createRoom(options);
         const roomKey = createRoomKey(room.id);
+        const { data: { inviteCode }, } = await this.connectClient.createInviteCode({ roomId: room.id });
         return {
             room,
             roomKey,
+            inviteCode,
         };
     };
-    linkForRoom = (roomKey) => {
-        return `${oorjaURL(this.config)}/rooms?id=${roomKey.roomId}#${exportKey(roomKey.key)}`;
+    linkForRoom = (roomKey, inviteCode) => {
+        return `${oorjaURL(this.config)}/rooms?id=${roomKey.roomId}&inviteCode=${inviteCode}#${exportKey(roomKey.key)}`;
     };
     getRoomKey(streamKey) {
         return {

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

@@ -1,5 +1,4 @@
 import { IPty } from 'node-pty';
-import { Hash } from '../connect/types.js';
 export declare const initScreen: (username: string, hostname: string, shell: string, multiplexed: boolean) => void;
 export type dimensions = {
     rows: number;
@@ -7,4 +6,4 @@ export type dimensions = {
 };
 export declare const getDimensions: () => dimensions;
 export declare const areDimensionEqual: (a: dimensions, b: dimensions) => boolean;
-export declare const resizeBestFit: (term: IPty, userDimensions: Hash<dimensions>, shouldClearScreen?: boolean) => void;
+export declare const resizeBestFit: (term: IPty, userDimensions: Record<string, dimensions>, shouldClearScreen?: boolean) => void;

package/oclif.manifest.json

@@ -47,7 +47,7 @@
           "char": "s",
           "description": "shell to use. e.g. bash, fish",
           "name": "shell",
-          "default": "bash",
+          "default": "/usr/bin/zsh",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -85,5 +85,5 @@
       ]
     }
   },
-  "version": "2.2.0"
+  "version": "2.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oorja",
   "description": "stream terminals to the web and more.",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "keywords": [
     "teletype",
     "terminal",