@caspertech/node-metaverse 0.5.37 → 0.5.50

package/examples/Inventory/Inventory.ts

@@ -1,150 +1,156 @@
-import { ExampleBot } from '../ExampleBot';
-import { InventoryFolder } from '../../lib/classes/InventoryFolder';
-import { FolderType } from '../../lib/enums/FolderType';
-import { InventoryItem } from '../../lib/classes/InventoryItem';
-import { LLLindenText } from '../../lib/classes/LLLindenText';
-import { AssetType } from '../../lib/enums/AssetType';
-import { InventoryType } from '../../lib/enums/InventoryType';
-import { PermissionMask } from '../../lib/enums/PermissionMask';
-import { InventoryResponseEvent } from '../../lib/events/InventoryResponseEvent';
-import { InventoryOfferedEvent } from '../../lib/events/InventoryOfferedEvent';
-
-class Inventory extends ExampleBot
-{
-    async onConnected(): Promise<void>
-    {
-        this.bot.clientEvents.onInventoryOffered.subscribe(this.onInventoryOffered.bind(this));
-        this.bot.clientEvents.onInventoryResponse.subscribe(this.onInventoryResponse.bind(this));
-
-        // Get the root inventory folder
-        const rootFolder = this.bot.clientCommands.inventory.getInventoryRoot();
-
-        // Populate the root folder
-        await rootFolder.populate(false);
-
-        const exampleFolderName = 'node-metaverse example';
-        const exampleNotecardName = 'Example Notecard';
-        const exampleScriptName = 'Example script';
-
-        let exampleFolder: InventoryFolder | undefined = undefined;
-        for (const childFolder of rootFolder.folders)
-        {
-            if (childFolder.name === exampleFolderName)
-            {
-                exampleFolder = childFolder;
-                await exampleFolder.populate(false);
-                break;
-            }
-        }
-
-        // Our folder doesnt' seem to exist, so create it
-        if (exampleFolder === undefined)
-        {
-            exampleFolder = await rootFolder.createFolder(exampleFolderName, FolderType.None);
-        }
-
-        // See if we've already made our test notecard to avoid clutter..
-        let exampleNotecard: InventoryItem | undefined = undefined;
-        for (const childItem of exampleFolder.items)
-        {
-            if (childItem.name === exampleNotecardName)
-            {
-                exampleNotecard = childItem;
-                break;
-            }
-        }
-
-        // Create the notecard
-        if (exampleNotecard === undefined)
-        {
-            const notecard = new LLLindenText();
-            notecard.body = 'This is a notecard I made all by myself at ' + new Date().toString();
-            exampleNotecard = await exampleFolder.uploadAsset(AssetType.Notecard, InventoryType.Notecard, notecard.toAsset(), exampleNotecardName, 'This is an example notecard');
-        }
-
-        // Set notecard to transfer only
-
-        exampleNotecard.permissions.nextOwnerMask = PermissionMask.Transfer | PermissionMask.Modify;
-        await exampleNotecard.update();
-
-        let exampleScript = exampleFolder.items.find(f => f.name === exampleScriptName);
-        if (exampleScript === undefined)
-        {
-            exampleScript = await exampleFolder.uploadAsset(
-                AssetType.LSLText,
-                InventoryType.LSL,
-                Buffer.from(
-                    'default { touch_start(integer total_number) {  llSay(0, "Hello, world!"); } } '
-                    , 'utf-8'
-                ),
-                'Script',
-                ''
-            );
-        }
-
-        // Give the notecard to our owner
-        await this.bot.clientCommands.comms.giveInventory(this.masterAvatar, exampleNotecard);
-
-        // Enumerate library
-        const folders = this.bot.clientCommands.inventory.getLibraryRoot().getChildFolders();
-        for (const folder of folders)
-        {
-            await this.iterateFolder(folder, '[ROOT]');
-        }
-        console.log('Done iterating through library');
-    }
-
-    async onInventoryResponse(response: InventoryResponseEvent): Promise<void>
-    {
-        if (response.accepted)
-        {
-            console.log(response.fromName + ' accepted your inventory offer');
-        }
-        else
-        {
-            console.log(response.fromName + ' declined your inventory offer');
-        }
-    }
-
-    async iterateFolder(folder: InventoryFolder, prefix: string): Promise<void>
-    {
-        console.log(prefix + ' [' + folder.name + ']');
-        await folder.populate(false);
-
-        for (const subFolder of folder.folders)
-        {
-            await this.iterateFolder(subFolder, prefix + ' [' + folder.name + ']');
-        }
-
-        for (const item of folder.items)
-        {
-            console.log(prefix + ' [' + folder.name + ']' + ': ' + item.name);
-
-            if (item.name === 'anim SMOOTH')
-            {
-                // Send this to our master av
-
-            }
-        }
-    }
-
-    async onInventoryOffered(event: InventoryOfferedEvent): Promise<void>
-    {
-        if (event.from.toString() === this.masterAvatar)
-        {
-            console.log('Accepting inventory offer from ' + event.fromName);
-            this.bot.clientCommands.inventory.acceptInventoryOffer(event).then(() =>
-            {
-            });
-        }
-        else
-        {
-            console.log('Rejecting inventory offer from ' + event.fromName);
-            this.bot.clientCommands.inventory.rejectInventoryOffer(event).then(() =>
-            {
-            });
-        }
-    }
-}
-
-new Inventory().run().then(() => {}).catch((err) => { console.error(err) });
+import { ExampleBot } from '../ExampleBot';
+import { InventoryFolder } from '../../lib/classes/InventoryFolder';
+import { FolderType } from '../../lib/enums/FolderType';
+import { InventoryItem } from '../../lib/classes/InventoryItem';
+import { LLLindenText } from '../../lib/classes/LLLindenText';
+import { AssetType } from '../../lib/enums/AssetType';
+import { InventoryType } from '../../lib/enums/InventoryType';
+import { PermissionMask } from '../../lib/enums/PermissionMask';
+import { InventoryResponseEvent } from '../../lib/events/InventoryResponseEvent';
+import { InventoryOfferedEvent } from '../../lib/events/InventoryOfferedEvent';
+
+class Inventory extends ExampleBot
+{
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onInventoryOffered.subscribe(this.onInventoryOffered.bind(this));
+        this.bot.clientEvents.onInventoryResponse.subscribe(this.onInventoryResponse.bind(this));
+
+        // Get the root inventory folder
+        const rootFolder = this.bot.clientCommands.inventory.getInventoryRoot();
+
+        // Populate the root folder
+        await rootFolder.populate(false);
+
+        const exampleFolderName = 'node-metaverse example';
+        const exampleNotecardName = 'Example Notecard';
+        const exampleScriptName = 'Example script';
+
+        let exampleFolder: InventoryFolder | undefined = undefined;
+        for (const childFolder of rootFolder.folders)
+        {
+            if (childFolder.name === exampleFolderName)
+            {
+                exampleFolder = childFolder;
+                await exampleFolder.populate(false);
+                break;
+            }
+        }
+
+        // Our folder doesnt' seem to exist, so create it
+        if (exampleFolder === undefined)
+        {
+            exampleFolder = await rootFolder.createFolder(exampleFolderName, FolderType.None);
+        }
+
+        // See if we've already made our test notecard to avoid clutter..
+        let exampleNotecard: InventoryItem | undefined = undefined;
+        for (const childItem of exampleFolder.items)
+        {
+            if (childItem.name === exampleNotecardName)
+            {
+                exampleNotecard = childItem;
+                break;
+            }
+        }
+
+        // Create the notecard
+        if (exampleNotecard === undefined)
+        {
+            const notecard = new LLLindenText();
+            notecard.body = 'This is a notecard I made all by myself at ' + new Date().toString();
+            exampleNotecard = await exampleFolder.uploadAsset(AssetType.Notecard, InventoryType.Notecard, notecard.toAsset(), exampleNotecardName, 'This is an example notecard');
+        }
+
+        // Set notecard to transfer only
+
+        exampleNotecard.permissions.nextOwnerMask = PermissionMask.Transfer | PermissionMask.Modify;
+        await exampleNotecard.update();
+
+        let exampleScript = exampleFolder.items.find(f => f.name === exampleScriptName);
+        if (exampleScript === undefined)
+        {
+            exampleScript = await exampleFolder.uploadAsset(
+                AssetType.LSLText,
+                InventoryType.LSL,
+                Buffer.from(
+                    'default { touch_start(integer total_number) {  llSay(0, "Hello, world!"); } } '
+                    , 'utf-8'
+                ),
+                'Script',
+                ''
+            );
+        }
+
+        // Give the notecard to our owner
+        await this.bot.clientCommands.comms.giveInventory(this.masterAvatar, exampleNotecard);
+
+        // Enumerate library
+        const folders = this.bot.clientCommands.inventory.getLibraryRoot().getChildFolders();
+        for (const folder of folders)
+        {
+            await this.iterateFolder(folder, '[ROOT]');
+        }
+        console.log('Done iterating through library');
+    }
+
+    async onInventoryResponse(response: InventoryResponseEvent): Promise<void>
+    {
+        if (response.accepted)
+        {
+            console.log(response.fromName + ' accepted your inventory offer');
+        }
+        else
+        {
+            console.log(response.fromName + ' declined your inventory offer');
+        }
+    }
+
+    async iterateFolder(folder: InventoryFolder, prefix: string): Promise<void>
+    {
+        console.log(prefix + ' [' + folder.name + ']');
+        await folder.populate(false);
+
+        for (const subFolder of folder.folders)
+        {
+            await this.iterateFolder(subFolder, prefix + ' [' + folder.name + ']');
+        }
+
+        for (const item of folder.items)
+        {
+            console.log(prefix + ' [' + folder.name + ']' + ': ' + item.name);
+
+            if (item.name === 'anim SMOOTH')
+            {
+                // Send this to our master av
+
+            }
+        }
+    }
+
+    async onInventoryOffered(event: InventoryOfferedEvent): Promise<void>
+    {
+        if (event.from.toString() === this.masterAvatar)
+        {
+            console.log('Accepting inventory offer from ' + event.fromName);
+            this.bot.clientCommands.inventory.acceptInventoryOffer(event).then(() =>
+            {
+            });
+        }
+        else
+        {
+            console.log('Rejecting inventory offer from ' + event.fromName);
+            this.bot.clientCommands.inventory.rejectInventoryOffer(event).then(() =>
+            {
+            });
+        }
+    }
+}
+
+new Inventory().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});

package/examples/MFA/MFA.ts

@@ -0,0 +1,55 @@
+import { Logger } from '../../lib/classes/Logger';
+import { LoginError } from '../../lib/classes/LoginError';
+import { ExampleBot } from '../ExampleBot';
+import * as readline from 'readline';
+import * as fs from 'fs';
+
+class MFA extends ExampleBot
+{
+    public async login(): Promise<void>
+    {
+        try
+        {
+            await super.login();
+        }
+        catch (e: unknown)
+        {
+            if (e instanceof LoginError)
+            {
+                if (e.reason === 'mfa_challenge')
+                {
+                    const rl = readline.createInterface({
+                        input: process.stdin,
+                        output: process.stdout
+                    });
+                    rl.question('Please enter authenticator code for ' + String(this.firstName) + ' ' + String(this.lastName) + '\n# ', (code) =>
+                    {
+                        this.bot.loginParameters.token = code;
+                        void this.login();
+                    });
+                    return;
+                }
+            }
+            Logger.Error(e);
+        }
+    }
+
+    public async onConnected(): Promise<void>
+    {
+        if (this.loginResponse && this.loginResponse.mfaHash)
+        {
+            // Store MFA hash in our login credentials for next time
+            this.loginParameters.mfa_hash = this.loginResponse.mfaHash;
+            delete this.loginParameters.token;
+            await fs.promises.writeFile(this.loginParamsJsonFile, JSON.stringify(this.loginParameters, null, 4));
+        }
+    }
+}
+
+new MFA().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});

package/examples/Money/Money.ts

@@ -1,57 +1,63 @@
-import { ExampleBot } from '../ExampleBot';
-import { BalanceUpdatedEvent } from '../../lib/events/BalanceUpdatedEvent';
-import { AvatarQueryResult } from '../../lib/classes/public/AvatarQueryResult';
-import { MoneyTransactionType } from '../../lib/enums/MoneyTransactionType';
-
-class Money extends ExampleBot
-{
-    private balance = 0;
-
-    async onConnected()
-    {
-        this.bot.clientEvents.onBalanceUpdated.subscribe(this.onBalanceUpdated.bind(this));
-        try
-        {
-            this.balance = await this.bot.clientCommands.grid.getBalance();
-            console.log('Balance is L$' + this.balance);
-            await this.bot.clientCommands.grid.payAvatar('d1cd5b71-6209-4595-9bf0-771bf689ce00', 1, 'This is a gift for being so awesome!');
-            console.log('Payment success');
-        }
-        catch (error)
-        {
-            console.log('Payment failed');
-        }
-    }
-
-    async onBalanceUpdated(evt: BalanceUpdatedEvent)
-    {
-        this.balance = evt.balance;
-        if (evt.transaction.from.equals(this.bot.agentID()))
-        {
-            if (evt.transaction.toGroup)
-            {
-                console.log('You paid a group L$' + evt.transaction.amount);
-            }
-            else
-            {
-                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.to) as AvatarQueryResult;
-                console.log('You paid L$' + evt.transaction.amount + ' to ' + result.getName()+ ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
-            }
-        }
-        else
-        {
-            if (evt.transaction.fromGroup)
-            {
-                console.log('A group paid you L$' + evt.transaction.amount);
-            }
-            else
-            {
-                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.from) as AvatarQueryResult;
-                console.log(result.getName() + ' paid you L$' + evt.transaction.amount + ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
-            }
-        }
-        console.log('Balance updated (New balance L$' + evt.balance + ')');
-    }
-}
-
-new Money().run().then(() => {}).catch((err) => { console.error(err) });
+import { ExampleBot } from '../ExampleBot';
+import { BalanceUpdatedEvent } from '../../lib/events/BalanceUpdatedEvent';
+import { AvatarQueryResult } from '../../lib/classes/public/AvatarQueryResult';
+import { MoneyTransactionType } from '../../lib/enums/MoneyTransactionType';
+
+class Money extends ExampleBot
+{
+    private balance = 0;
+
+    async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onBalanceUpdated.subscribe(this.onBalanceUpdated.bind(this));
+        try
+        {
+            this.balance = await this.bot.clientCommands.grid.getBalance();
+            console.log('Balance is L$' + this.balance);
+            await this.bot.clientCommands.grid.payAvatar('d1cd5b71-6209-4595-9bf0-771bf689ce00', 1, 'This is a gift for being so awesome!');
+            console.log('Payment success');
+        }
+        catch (error)
+        {
+            console.log('Payment failed');
+        }
+    }
+
+    async onBalanceUpdated(evt: BalanceUpdatedEvent): Promise<void>
+    {
+        this.balance = evt.balance;
+        if (evt.transaction.from.equals(this.bot.agentID()))
+        {
+            if (evt.transaction.toGroup)
+            {
+                console.log('You paid a group L$' + evt.transaction.amount);
+            }
+            else
+            {
+                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.to) as AvatarQueryResult;
+                console.log('You paid L$' + evt.transaction.amount + ' to ' + result.getName() + ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
+            }
+        }
+        else
+        {
+            if (evt.transaction.fromGroup)
+            {
+                console.log('A group paid you L$' + evt.transaction.amount);
+            }
+            else
+            {
+                const result = await this.bot.clientCommands.grid.avatarKey2Name(evt.transaction.from) as AvatarQueryResult;
+                console.log(result.getName() + ' paid you L$' + evt.transaction.amount + ' "' + evt.transaction.description + '" (' + MoneyTransactionType[evt.transaction.type] + ')');
+            }
+        }
+        console.log('Balance updated (New balance L$' + evt.balance + ')');
+    }
+}
+
+new Money().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});

package/examples/Region/Agents.ts

@@ -1,75 +1,81 @@
-import { ExampleBot } from '../ExampleBot';
-import { Avatar } from '../../lib/classes/public/Avatar';
-import { Subscription } from 'rxjs';
-
-class Region extends ExampleBot
-{
-    private subscriptions: {[key: string]: {
-        onMovedSubscription: Subscription;
-        onTitleSubscription: Subscription;
-        onLeftRegionSubscription: Subscription;
-        onVisibleSubscription: Subscription;
-    }};
-
-    async onConnected()
-    {
-        this.bot.clientEvents.onAvatarEnteredRegion.subscribe(this.onAvatarEntered.bind(this));
-
-        const avs = this.bot.clientCommands.region.getAvatarsInRegion();
-        for (const av of avs)
-        {
-            this.onAvatarEntered(av);
-        }
-    }
-
-    onAvatarEntered(av: Avatar)
-    {
-        console.log(av.getName() + ' entered the region (' + ((av.isVisible) ? 'visible' : 'invisible') + ')');
-        const avatarKey = av.getKey().toString();
-        this.unsubscribe(avatarKey);
-        this.subscriptions[avatarKey] = {
-            onLeftRegionSubscription: av.onLeftRegion.subscribe(this.onAvatarLeft.bind(this)),
-            onMovedSubscription: av.onMoved.subscribe(this.onAvatarMoved.bind(this)),
-            onTitleSubscription: av.onTitleChanged.subscribe(this.onTitleChanged.bind(this)),
-            onVisibleSubscription: av.onVisibleChanged.subscribe(this.onAvatarVisible.bind(this))
-        }
-    }
-
-    private unsubscribe(key: string)
-    {
-        const sub = this.subscriptions[key];
-        if (sub === undefined)
-        {
-            return;
-        }
-        delete this.subscriptions[key];
-
-        sub.onVisibleSubscription.unsubscribe();
-        sub.onMovedSubscription.unsubscribe();
-        sub.onTitleSubscription.unsubscribe();
-        sub.onLeftRegionSubscription.unsubscribe();
-    }
-
-    onAvatarLeft(av: Avatar)
-    {
-        console.log(av.getName() + ' left the region');
-        this.unsubscribe(av.getKey().toString());
-    }
-
-    onAvatarMoved(av: Avatar)
-    {
-        console.log(av.getName() + ' moved, position: ' + av.position.toString());
-    }
-
-    onTitleChanged(av: Avatar)
-    {
-        console.log(av.getName() + ' changed their title to: ' + av.getTitle());
-    }
-
-    onAvatarVisible(av: Avatar)
-    {
-        console.log(av.getName() + ' is now ' + (av.isVisible ? 'visible' : 'invisible'));
-    }
-}
-
-new Region().run().then(() => {}).catch((err) => { console.error(err) });
+import { ExampleBot } from '../ExampleBot';
+import { Avatar } from '../../lib/classes/public/Avatar';
+import { Subscription } from 'rxjs';
+
+class Region extends ExampleBot
+{
+    private subscriptions: { [key: string]: {
+        onMovedSubscription: Subscription;
+        onTitleSubscription: Subscription;
+        onLeftRegionSubscription: Subscription;
+        onVisibleSubscription: Subscription;
+    } } = {};
+
+    public async onConnected(): Promise<void>
+    {
+        this.bot.clientEvents.onAvatarEnteredRegion.subscribe(this.onAvatarEntered.bind(this));
+
+        const avs = this.bot.clientCommands.region.getAvatarsInRegion();
+        for (const av of avs)
+        {
+            this.onAvatarEntered(av);
+        }
+    }
+
+    private onAvatarEntered(av: Avatar): void
+    {
+        console.log(av.getName() + ' entered the region (' + ((av.isVisible) ? 'visible' : 'invisible') + ')');
+        const avatarKey = av.getKey().toString();
+        this.unsubscribe(avatarKey);
+        this.subscriptions[avatarKey] = {
+            onLeftRegionSubscription: av.onLeftRegion.subscribe(this.onAvatarLeft.bind(this)),
+            onMovedSubscription: av.onMoved.subscribe(this.onAvatarMoved.bind(this)),
+            onTitleSubscription: av.onTitleChanged.subscribe(this.onTitleChanged.bind(this)),
+            onVisibleSubscription: av.onVisibleChanged.subscribe(this.onAvatarVisible.bind(this))
+        }
+    }
+
+    private unsubscribe(key: string): void
+    {
+        const sub = this.subscriptions[key];
+        if (sub === undefined)
+        {
+            return;
+        }
+        delete this.subscriptions[key];
+
+        sub.onVisibleSubscription.unsubscribe();
+        sub.onMovedSubscription.unsubscribe();
+        sub.onTitleSubscription.unsubscribe();
+        sub.onLeftRegionSubscription.unsubscribe();
+    }
+
+    private onAvatarLeft(av: Avatar): void
+    {
+        console.log(av.getName() + ' left the region');
+        this.unsubscribe(av.getKey().toString());
+    }
+
+    private onAvatarMoved(av: Avatar): void
+    {
+        console.log(av.getName() + ' moved, position: ' + av.position.toString());
+    }
+
+    private onTitleChanged(av: Avatar): void
+    {
+        console.log(av.getName() + ' changed their title to: ' + av.getTitle());
+    }
+
+    private onAvatarVisible(av: Avatar): void
+    {
+        console.log(av.getName() + ' is now ' + (av.isVisible ? 'visible' : 'invisible'));
+    }
+}
+
+new Region().run().then(() =>
+{
+
+}).catch((err) =>
+{
+    console.error(err);
+});