@casual-simulation/causal-tree-client-socketio - npm Package Versions

Improvements

• Made the menu item count badge a lighter gray.
• Removed the item count badge from the menu.
• Removed the dropdown aspect of the menu.

Changes

• Made the menu item count badge a lighter gray.
• Removed the admin channel and admin-channel specific functionality.
  • This means that there are no more user account bots or channel bots.
    • You can login as anyone from any device without requiring additional authentication.
    • You can access any channel. No need to create a channel first. (because there are no channel bots anymore)
    • The connection counts are now stored in the config bot of the channel.
    • Connection limits no longer work since they were set on the channel bot in the admin channel.
    • Username whitelists and blacklists still work, but they rely on client-side script execution instead of server-side execution.
  • It also means there is no admin role. For now, everyone has admin permissions.
  • action.perform() now needs to be used to run actions on the server.
    • You can send an action to the server using the remote() function.
    • The server will receive the action in its onAnyAction() as that.action.type === "device"
    • onAnyAction() has to detect remove events and execute the inner action via action.perform(that.action.event).
  • The following functions have been removed:
    • server.grantRole()
    • server.revokeRole()
  • The following functions are not executed by default and require a custom onAnyAction() to handle them.
    • server.backupAsDownload()
    • server.backupToGithub()
    • server.shell()
  • server.backupAsDownload() has been updated to accept a "session selector" which determines which session the ZIP file should be sent to.
    • ex. server.backupAsDownload({ username: getTag(player.getBot(), "#aux._user") })
  • Removed the aux._lastEditedBy tag.
    • This tag was automatically set to the ID of the user whenever a bot was edited.
    • Currently, it is extra cruft that is not needed and could be easily implemented via onAnyAction().
• Centered the menu above the player inventory.
• Increased menu text size.
• Added in new camera range tags: aux.context.zoomable.min, aux.context.zoomable.max aux.context.pannable.min.x, aux.context.pannable.max.x, aux.context.pannable.min.y, aux.context.pannable.max.y.

Bug Fixes

• Removed hidden inventory dragging hitboxes when inventory is set to non-visible.

• Added onAnyAction() action tag to intercept and change actions before they are executed.
  • onAnyAction() runs for every action, including when a bot is created, changed, or deleted.
  • Every action is an object with a type property.
    • The type property is a string that indicates what the action does.
    • Here is a partial list of types:
      • add_bot: A bot should be added (i.e. created).
      • remove_bot: A bot should be removed (i.e. deleted).
      • update_bot: A bot should be updated.
      • apply_state: The given bot state should be applied. (i.e. a set of bots should be created/updated)
      • shout: A shout should be executed.
      • show_toast: A toast message should be shown on the device.
      • show_barcode: A barcode should be shown.
      • tween_to: The camera should be tweened to show a bot.
  • that is an object with the following properties:
    • action: The action that is going to be executed.
  • Forking a channel clears the onAnyAction() on the config bot.
    • This is so that you can recover from broken states and also gives the person who forked the AUX full control over the fork.
• Added two new script functions:
  • action.reject(action): Prevents the given action from being performed. Returns the rejection action.
  • action.perform(action): Adds the given action to the performance queue so it will be performed. This can be used to re-enable an action after it has been rejected (you can also reject the rejection action). Returns the action that will be performed.
• Added a local bot which is stored in the browser's local storage.
  • The local bot is a bot that is unique to the device and channel.
  • You can access the bot by querying for it: getBot("#id", "local").
• Renamed onShout() to onAnyListen().
• Added onListen() which is an alternative to onAnyListen() that is only called on the targeted bots.
• Added ability to set duration of toast, plater.toast("message", durationNum).
• Made the background for the menu label gray.

• Added tags to control panning, zooming, and rotating the main camera.
  • aux.context.pannable: Controls whether the main camera is able to be panned.
  • aux.context.zoomable: Controls whether the main camera is able to be zoomed.
  • aux.context.rotatable: Controls whether the main camera is able to be rotated.
• Added player.moveTo() to instantly tween the camera to a bot.
  • In the future, custom tween durations will be supported.
• Changed the low camera angle limit to 32 degrees from 10 degrees.
• onCombineExit action will now fire alongside the onCombine action.
• Newly created contexts will no longer be autoselected.
• Toast messages will now only remain on screen for 2 seconds.
• Added the ability to send webhooks from the server.
  • You can also tell the server to send a webhook via remote(webhook()).
  • This is useful for getting around CORS issues.

• Fixed player.tweenTo() to not change the zoom level when it is not specified.
• Tweens will now work better with the onPlayerEnterContext action.

• Added the ability to send and receive webhooks.
  • Send webhooks using the following functions:
    • webhook(options) - options is an object that takes the following properties:
      • method - The HTTP Method that should be used for the request.
      • url - The URL that the request should be made to.
      • responseShout - (Optional) The shout that should happen when a response is received from the server.
      • headers - (Optional) The HTTP headers that should be sent with the request.
      • data - (Optional) The data that should be sent with the request.
    • webhook.post(url, data, options) - Sends a HTTP Post request.
      • url - The URL that the request should be made to.
      • data - (Optional) The data that should be sent with the request.
      • options - (Optional) An object that takes the following properties:
        • responseShout - (Optional) The shout that should happen when a response is received from the server.
        • headers - (Optional) The headers that should be sent with the request.
  • Receive webhooks by registering a handler for the onWebhook() action and send requests to https://auxplayer.com/{context}/{channel}/whatever-you-want.
    • onWebhook() is shouted to the channel that the request was made to and that is an object with the following properties:
      • method - The HTTP Method that the request was made with.
      • url - The URL that the request was made to.
      • data - The JSON data that the request included.
      • headers - The HTTP headers that were included with the request.
• Added the ability to spy on shouts and whispers via the onShout() event.
  • onShout() is executed on every bot whenever a shout or whisper happens.
    • It is useful for tracking what shouts are being made and modifying responses.
    • Also useful for providing default behaviors.
    • that is an object with the following properties:
      • name is the name of the action being shouted.
      • that is the argument which was provided for the shout.
      • targets is an array of bots that the shout was sent to.
      • listeners is an array of bots that ran a script for the shout.
      • responses is an array of responses that were returned from the listeners.
• Added events to notify scripts when channels become available.
  • The following events have been added:
    • onChannelSubscribed() - happens the first time a channel is loaded. Sent to every channel that is currently loaded.
    • onChannelUnsubscribed() - happens when a channel is unloaded. Sent to every channel that remains after the channel is unloaded.
    • onChannelStreaming() - happens when a channel is connected and fully synced. Sent to every channel that is currently loaded.
    • onChannelStreamLost() - happens when a channel is disconnected and may not be fully synced. Sent to every channel that is currently loaded.
    • For all events, that is an object with the following properties:
      • channel - The channel that the event is for.
  • The following events have been removed:
    • onConnected()
    • onDisconnected()
• Added in tags to change the state of the inventory's camera controls:
  • aux.context.inventory.pannable enables and disables the inventory's ability to pan, off by default.
  • aux.context.inventory.resizable enables and disables the inventory's drag to resize functionality, on by default.
  • aux.context.inventory.rotatable enables and disables the inventory's ability to rotate, on by default.
  • aux.context.inventory.zoomable enables and disables the inventory's ability to zoom, on by default.

• Resolved issue with the near cliiping plane for the sheet's minifile image.
• Resolved issues with the create empty bot button not functioning sometimes on mobile.

• Reworked the login functionality to use popups instead of dedicated pages.
  • The login page has been split into two popups:
    • The login popup (account selector).
    • The authorization popup (QR Scanner).
  • The login popup has the following functions:
    • It can be opened by the "Login/Logout" button in the menu.
    • It will display a list of accounts that can be used to login.
    • If no accounts are available, then a username box will be shown.
    • If accounts are available, a new account can be added by clicking the "+" button at the bottom of the list.
    • At any time, the user can close the popup to keep their current login.
    • They can also select the "Continue as Guest" option to login as a guest.
  • The authorization popup has the following functions:
    • It is opened automatically when the user needs to scan an account code.
    • It contains the QR Code scanner to scan the account code.
    • It also contains an input box to manually enter the code.
    • Closing the popup automatically logs the user in as a guest.
• Made the account QR Code blue.
• Added the ability to click the account QR Code to copy it to the clipboard.

• Fixed a couple communication issues between the server and client during login.
  • One such issue could potentially leave the client in state where future changes would not be synced to the server.

• Split the player inventory's resizing bar into two and placed them at the top corners of the inventory.
• Halved the inventory's gap spacing when on moble for a larger inventory.
• Improved the label textbox to resize to fix bot that have a high width value.
• The drop action tags: onDropInContext(), onAnyDropInContext(), onDropInInventory() and onAnyDropInInventory() now return the previous context the bots were in before the drop.
• Allow the context to set the player's default zoom with the tag aux.context.player.zoom and its rotation with the tags aux.context.player.rotation.x and aux.context.player.rotation.y.
• Changed the loading popup to have improved readability and removed wanted information from the player's loading popup.
• Added the ability to show and scan barcodes.
  • Barcodes can be shown via the player.showBarcode(code, format) function.
    • The format parameter accepts the following options:
      • code128 (Code 128) (default)
      • EAN
        • ean13 (EAN-13)
        • ean8 (EAN-8)
        • upc (UPC-A)
      • itf14 (ITF-14)
      • msi (MSI)
      • pharmacode (Pharmacode)
      • codabar (Codabar)
  • The barcode scanner can be opened via the player.openBarcodeScanner() function.
    • The following barcode types can be scanned:
      • Code 128
      • Code 39
      • Code 93
      • EAN-13
      • EAN-8
      • UPC-A
      • UPC-C
      • Codeabar
    • When a barcode is scanned the onBarcodeScanned() event will be sent containing the barcode that was detected.
    • Also supports onBarcodeScannerOpened() and onBarcodeScannerClosed().
• Added menus back to AUXPlayer.
• Added byMod() as an additional way to query bots.
  • Convienent way to query bots by multiple tags at once.
  • Usage:
    • getBots(byMod({ "aux.color": "red", "aux.scale": 2 })) gets all the bots with aux.color set to "red" and aux.scale set to 2.
    • getBots(byMod({ "aux.color": null, "aux.label": "Hi!" })) gets all the bots without an aux.color but with aux.label set to "Hi!".

• Resolved issue with new contexts adding an incorrect tag to the sheet.
• Changed the dynamic aspect ratio to a stable one for the inventory scaling.

• Added the onPointerUp() action tag to fire on button release.

• Resolved issue where creating a new tag on one bot, deselecting all bots and attempting to add that same tag to a different bot resulted in a warning.
• Resolved issue stopping VR from functioning on Occulus Quest.

• Improved the server.shell() command to output a bot to the aux.finishedTasks channel with the results of the command.
• Added the ability to backup channels to Github using Gists.
  • You can trigger a backup by running server.backupToGithub(token) as an admin from the admin channel.
  • The token parameter should be replaced with a string containing a personal access token from the account you want the backup to upload to.
  • During upload a bot will be added to the aux.runningTasks context with a progress bar indicating the status of the operation.
  • When the task is completed the bot will be moved to the aux.finishedTasks context and will contain tags indicating the result of the operation.
  • After finishing the bot will contain a link to the uploaded data.
• Added the ability to backup channels as a zip file.
  • Triggered by running server.backupAsDownload() as an admin from the admin channel.
  • Similar to the Github backup but the zip file is downloaded to your device.
• setTag function will now accept an array of bots as it's first paramater.
• Removed the white circle background from the player's menu button.
• Changed Fork/Upload/Download AUX to Fork/Upload/Download Channel.
• Updated connection message.
• Allow the deselection of files by clicking on the bot in the sheet during multiselection.
• Greatly improved the performance of dragging stacks of bots in AUXPlayer.
• Added the onCombineEnter() and onCombineExit() action tags to fire on all bots being interacted with during a drag operation with combine action tags involved.

• Removed mouse pointer change on player inventory side bars.
• Made the multiselect button ui consistant colors.
• Made the multiselect button hide itself in multiselect mode.
• aux.label will now accept numbers as a tag value.
• Further restrict the add tag setup to stop unwanted warning popups.
• Fixed to let admin users be designers even if the designers list says otherwise.

• Increased the Socket.io ping interval and timeout values to better support sending large causal trees.
• Updated aux.inventory.height to aux.context.inventory.height.
• Removed the raise and lower option in the context dropdwon menu.
• Changed player menu's Add Channel to Subscribe to Channel.
• Set mobile and desktop's default player inventory height to be consistent.
• Added a basic console that can be used to view logs from scripts and formulas.
  • The console can be opened via the player.openDevConsole() script function.
• Changed the toggle size button's image.
• Moved multiselection button to the top right, added new icon for the button.
• Added bot image to top of sheet.
• Removed deslection button, the minus icon, from the sheets.
• Changed destroy bot button text to the trash can icon.
• Allow the user to drag bots from the bot image at the top of the sheet section.

• Improved centering of loading popup's powered by CasualOS text.
• Fixed an issue that would cause player.currentContext() to not update until after the onPlayerContextEnter() event was fired.
• Fixed some issues with the login flow for AUXPlayer.

• Added the ability for shouts and whispers to return values.
  • shout() returns a list of results from every bot that ran a script for the shout ordered by bot ID.
  • whisper() returns a list of results from every bot that ran a script for the whisper ordered by the input bot array.
  • To return a value from a shout/whisper handler, use return statements. For example, to return 10 from a shout you would simply write return 10.
• Changed the tag suggestion list to only show when there are tags that match the input.
• Changed the create surface popup's header text to read: Create Context from Selection.
• Added show surface checkbox to the create context popup.
• Removed the text on the sheet's bottom left add tag button.
• Added the phrase powered by CasualOS to bthe hamburger menu and loading popup.
• Removed Unselect All from the sheets.

• Fixed an issue that would let users load the admin channel because no file specified session limits for it.
• Fixed an issue that would cause formulas which contained indexer expressions to fail.
• Fixed the server to not overwrite broke Causal Trees.
• Stopped incorrect empty tag warning when attempting to add in a new tag.
• Fixed there not being a visible right bar on the player inventory.
• Fixed dependency tracking for formulas which get bots by ID. (like getBots("id"))