@casual-simulation/causal-tree-store-browser - npm Package Versions

V2.0.30

Date: 1/14/2022

:wrench: Plumbing Changes

• Replaced socket.io with native WebSockets.
  • The possible options for CAUSAL_REPO_CONNECTION_PROTOCOL are now websocket and apiary-aws.
  • Since the introduction of apiary-aws, we've used native WebSockets for more connections. As such, it should be safe to use native WebSockets in place of socket.io.
  • This means we have fewer depenencies to keep up with and fewer potential bugs.
  • Additionally it means that we save a little bit on our output code bundle size.

:bug: Bug Fixes

• Fixed an issue where deleting all the text from a menu item would show the menuItemText tag value instead of the (empty) menuItemText tag mask value.
  • This change causes CasualOS to use false for the menuItemText tempLocal tag mask when a normal tag value is present for menuItemText. If the bot has no tag value for menuItemText, then null is used.
• Fixed an issue where CasualOS could sometimes miss events during initialization.
  • This bug most likely affected portals that are configurable by a config bot (e.g. gridPortal) but could have also affected other parts of the CasualOS system.
  • This bug also was very rare. We only saw it once in our testing.
• Fixed an issue with custom apps where calling os.registerApp() multiple times would cause the app to be destroyed and re-created.
  • This caused issues with retaining focus and made the user experience generally poor.
• Fixed an issue with custom apps where a the value attribute could not be overridden on input elements.
  • Now it is possible to specify what the value should be and it will be properly synced.

V2.0.22

Date: 1/3/2022

:boom: Breaking Changes

• Removed the following functions:
  • os.publishRecord()
  • os.getRecords()
  • os.destroyRecord()
  • byAuthID()
  • withAuthToken()
  • byAddress()
  • byPrefix()

:rocket: Improvements

• Implemented the next version of records.
  • This version replaces the old API (os.publishRecord()) and introduces a new paradigm.
  • The first major change is that records now represent multiple pieces of data.
  • os.getPublicRecordKey(recordName) has been added as a way to retrieve a key that can be used to write data and files to a public record.
  • os.recordData(recordKey, address, data) can be used to store a piece of data at an address inside a record. This data can later be retrieved with os.getData(recordKeyOrName, address).
  • os.getData(recordKeyOrName, address) can be used to retrieve data that was stored in a record.
  • os.recordFile(recordKey, data, options?) can be used to store a file inside a record. Files can be any size and can be accessed via webhook() or os.getFile(url).
  • os.getFile(urlOrRecordFileResult) can be used to easily retrieve a file.
  • os.isRecordKey(value) is useful for determining if a value represents a record key.
  • See the documentation for more information.
• Updated Material Icons to the latest publicly available version.

V2.0.14

Date: 10/29/2021

:rocket: Improvements

• Improved the local space to delete the oldest inst when localStorage is full.
• Added the pointerPixelX and pointerPixelY tags to the gridPortalBot to track the mouse pointer position on the screen.
• Improved the records system to be able to store records larger than 300KB in size.
  • Records larger than 300KB will be placed in an S3 bucket.
  • Records stored in S3 will now have a dataURL instead of data that points to where the record can be downloaded from.

:bug: Bug Fixes

• Fixed an issue where the built-in portal bots would cause all scripts to be recompiled.
• Fixed an issue where functions that retrieve data from portal bots (like os.getFocusPoint()) would always return null data.
• Fixed an issue where the .getMoreRecords() function did not work.

V2.0.12

Date: 10/8/2021

:rocket: Improvements

• Added the os.createDebugger(options?) function.
  • os.createDebugger() can be used to create a separate sandbox area where bots can be tested without causing external effects.
  • This is useful for automated testing scenarios where you want to validate how a script works (e.g. that a toast is shown) without actually performing the script results (i.e. actually showing the toast).
  • Works by returning an object that contains a separate set of actions (like create() and getBots()) that can be used like normal. For example:

    const debug = os.createDebugger();
    const debugBot = debug.create({ home: true, color: 'red' });
    

    Creates a bot that is contained in the debugger. Therefore, scripts on the debugBot will only affect bots that were created in the debugger.
  • See the documentation for more information.
• Added the assert(condition, message?) and assertEqual(received, expected) functions.
  • These functions check that the given condition is true or that the values are equal to each other and throw an error if they are not.
  • They can be useful for automated testing.
  • See the documentation for examples.

:bug: Bug Fixes

• Fixed an issue where setting meetPortalAnchorPoint to left or right would not shift the gridPortal to the remaining space.

V2.0.11

Date: 10/1/2021

:boom: Breaking Changes

• Renamed server to inst.
  • This means that you should now configBot.tags.inst instead of configBot.tags.server.
  • It also means that you now should go to https://casualos.com?inst=my-aux instead of https://casualos.com?server=my-aux.
  • CasualOS will automatically replace server with inst on the first load so old links will continue to work.
• Renamed pagePortal to gridPortal
  • CasualOS will automatically replace pagePortal with gridPortal on first load (so old links will continue to work) but any scripts that change pagePortal will need to be updated to change gridPortal.
  • pagePortal on the configBot should now be gridPortal.
  • pagePortalBot is now gridPortalBot.
  • Some functions now should reference the bot portal instead of the page portal:
    • os.getCameraPosition('page') -> os.getCameraPosition('grid')
    • os.getCameraRotation('page') -> os.getCameraRotation('grid')
    • os.getFocusPoint('page') -> os.getFocusPoint('grid')
    • os.getPortalDimension('page') -> os.getPortalDimension('grid')
  • @onPortalChanged now uses gridPortal for that.portal.
• Renamed miniPortal to miniGridPortal
  • miniPortal on the configBot should now be miniGridPortal.
  • miniPortalBot should now be miniGridPortalBot.
  • Some functions now should reference the bot portal instead of the page portal:
    • os.getCameraPosition('mini') -> os.getCameraPosition('miniGrid')
    • os.getCameraRotation('mini') -> os.getCameraRotation('miniGrid')
    • os.getFocusPoint('mini') -> os.getFocusPoint('miniGrid')
    • os.getPortalDimension('mini') -> os.getPortalDimension('miniGrid')
  • @onPortalChanged now uses miniGridPortal for that.portal.
• Renamed some functions:
  • os.downloadServer() -> os.downloadInst()
  • os.loadServer() -> os.loadInst()
  • os.unloadServer() -> os.unloadInst()
  • os.getCurrentServer() -> os.getCurrentInst()
  • server.remotes() -> os.remotes()
  • server.serverRemoteCount() -> os.remoteCount()
  • server.servers() -> os.instances()
  • server.serverStatuses() -> os.instStatuses()
  • server.restoreHistoryMarkToServer() -> server.restoreHistoryMarkToInst().
  • Note that some functions have moved to the os namespace from the server namespace. This is because most server functions do not work on CasualOS.com and are only designed to work with a server-based system (which CasualOS.com is not). To clarify this, functions that work all the time are now in the os namespace while the others are in the server namespace.
• Renamed several listen tags:
  • @onServerJoined -> @onInstJoined
  • @onServerLeave -> @onInstLeave
  • @onServerStreaming -> @onInstStreaming
  • @onServerStreamLost -> @onInstStreamLost
  • @onServerAction -> @onAnyAction

:rocket: Improvements

• Updated the Privacy Policy, Terms of Service, and Acceptable Use Policy.
• Changed the meetPortal to use a custom Jitsi deployment.
• Improved os.enablePointOfView(center?) to take an additional argument that determines whether to use the device IMU to control the camera rotation while in POV mode.
  • The new function signature is os.enablePointOfView(center?, imu?).
  • e.g. os.enablePointOfView(undefined, true) will enable using the IMU for controlling the camera rotation.

:bug: Bug Fixes

• Fixed an issue where zooming on menu bots would trigger the browser-provided zoom functionality.
• Fixed an issue where copying an array from one tag to another tag caused CasualOS to break.
• Fixed an issue where editing a script via the sheet portal cells would temporarily break the code editor.