@casual-simulation/aux-records - npm Package Versions

V3.2.16

Date: 2/23/2024

:rocket: Features

• Added the formLDrawPartsAddress to set the address that LDraw parts should be loaded from.
• Updated the policies.
• Added the ability to configure CasualOS to support Google AI for ai.chat().
• Added the ability to include image data in ai.chat() requests.
  • ai.chat() messages now support accepting an array of content which can either represent text or image data.

:bug: Bug Fixes

• Fixed an issue where percent-based sizing of custom apps was broken due to a change made in v3.2.14.
• Fixed an issue where bots stored in local insts might not receive the @onInstJoined shout.
• Fixed an issue where POV mode would start with the camera facing down when IMU support is disabled.
• Fixed an issue where ai.chat() would not actually honor any options.

V3.2.15

Date: 2/20/2024

:rocket: Features

• Added the ldraw and ldrawText subforms.
  • When paired with #form = "mesh", they both allow rendering a LDraw file as the bot's form.
  • ldraw - Renders the LDraw URL stored in #formAddress
  • ldrawText - Renders the LDraw text stored in #formAddress
• Added the os.ldrawCountAddressBuildSteps(address) and os.ldrawCountTextBuildSteps(text) functions.
  • os.ldrawCountAddressBuildSteps(address) counts and returns the number of build steps that are in the LDraw file at the given URL. Returns a promise that resolves with the number of build steps that the file has.
  • os.ldrawCountTextBuildSteps(text) counts and returns the number of build steps that are in the given LDraw text. Returns a promise that resolves with the number of build steps that the file has.
• Improved os.showUploadFiles() to return .mpd and .ldr files as text.
  • This makes it easier for users to work with LDraw files.

:bug: Bug Fixes

• Fixed an issue where public and local insts could not publish records.

V3.2.14

Date: 2/19/2024

:boom: Breaking Changes

• Changed how os.listData() works to require data.list access for the account marker instead of for each item individually.
  • This means that os.listData() will continue to work for users that have a record key or are admins (record owner or member of a studio), but it will no longer be possible to list publicRead data items through this function.
  • Instead, use the new os.listDataByMarker() function to list data based on a marker.
  • The reason for this change is to make the API more predictable. Previously, it was possible for os.listData() to return no results even if there were items after the given address. This is because a fixed number of items would be retrieved from the database and then checked to see if the user has access to it. If the user did not have access to any items, then an empty list would be returned, even if there are items that the user does have access to later in the database.
• Changed os.listData() to throw a CausualOSError if the user is not authorized to list items.
  • Previously, an empty list would be returned. Now, an empty list is only returned if there are no items.
• Removed os.grantRecordMarkerPermission() and os.revokeRecordMarkerPermission().
  • These functions have been replaced by os.grantPermission() and os.revokePermission().
• Changed os.getCurrentInst() to always return the name of the inst that the bot exists in, instead of the first inst that was loaded into the session.

:rocket: Features

• Added the ability to organize records within a given marker.
  • Markers can be formatted as root:path.
    • root is known as the "root marker" and is what determines the security of a resource.
    • path is known as the "path marker" and is used to organize the resource.
  • It is still possible to format markers regularly. In this case, the marker doesn't have a path and is just a root.
    • All existing markers are treated this way.
  • For example, the markers secret and secret:documents both have the same root marker: secret.
    • This means that users need access to the secret root marker in order to access resources with either of these markers.
    • secret:documents has a path marker of documents, which means that it is organized separately from other markers.
  • The os.listDataByMarker() function is able to take advantage of this feature.
    • Calling os.listDataByMarker(recordName, "secret:photos") will only return data records with secret:photos, while calling os.listDataByMarker(recordName, "secret:documents") will only return data records with secret:documents.
• Added os.grantPermission(recordName, permission, options?) and os.revokePermission(recordName, permissionId, options?).
  • os.grantPermission() creates a permission that grants the ability to perform an action (or set of actions) on a marker or resource to a user, inst, or role.
  • os.revokePermission() deletes the permission with the given ID.
• Added the os.listDataByMarker(recordName, marker, startingAddress?, options?) function.
  • Useful for only listing data that has the given marker. Returns a promise that resolves with the total number of items that match the marker and up to 10 items.
  • Items are listed based on whether they exactly match one of the markers that are applied to the data items.
    • This means that secret:documents will match secret:documents, but listing by secret will not list secret:documents.
• Added WebXR support for Apple Vision Pro.
  • A dialog will appear on Safari asking if you want to enter XR when trying to enable AR/VR through CasualOS. This is an extra security measure enforced by Safari.
  • visionOS currently only supports immersive-vr mode of WebXR sessions.
  • Added pinch select gesture detection for. This allows for pointer-based bot interaction on the Vision Pro since Safari does not implement select events while hand tracking in WebXR.
• Categorized tags to seperate documentation pages.
• Added the ability to support domain-level isolation for insts.
  • The VM_ORIGIN environment variable can now be configured to tell CasualOS to load insts into a unique HTTP Origin so that insts are isolated from each other.
  • VM_ORIGIN is The HTTP Origin that should be used to load the inst virtual machine. Useful for securely isolating insts from each other and from the frontend. Supports {{inst}} to customize the origin based on the inst that is being loaded. For example setting VM_ORIGIN to https://{{inst}}.example.com will cause ?staticInst=myInst to load inside https://myInst.example.com. Defaults to null, which means that no special origin is used.
• Added the ability to request access to private insts that the user does not have permissions for.
• Added the ability to customize the MIME type and bitrate of recordings made with experiment.beginRecording() and experiment.endRecording().
• Added the ability to track rate limits for the WebSocket API separately from the HTTP API.
  • The websocketRateLimit property on the SERVER_CONFIG controls the websockets rate limits. If not specified, then the options from rateLimit will be used for websockets and HTTP.
  • Additionally, the websocketRateLimitPrefix in redis controls the namespace that values are stored at in Redis. If not specified, then the rateLimitPrefix will be used for both.
• Added the os.getRecordsEndpoint() function to get the default records endpoint.
  • Records actions, like os.recordData(), os.getData(), os.recordFile(), etc. can be passed an endpoint which specifies which backend should be used for the request.
  • If no endpoint is specified, then a default is used.
  • os.getRecordsEndpoint() returns a promise that resolves to the endpoint that is used by default.
• Added the os.showAccountInfo() function to show the "Account Information" dialog for users who are logged in.
• Implemented ArrayBuffer support for bytes.toBase64String() and bytes.toBase64Url() functions.

:bug: Bug Fixes

• Fixed an issuse where os.showUploadFiles() dialog cuts off the "Upload" button when a lot of files are added.
• Fixed an issue where fingers would trigger click interactions while dragging a bot with the same hand.
• Fixed an issue where portalBackgroundAddress would render over miniMapPortalBot.
• Fixed an issue where .click(), .focus(), and .blur() methods would not work on custom app HTML elements.
• Fixed an issue where os.unregisterApp() would not trigger Preact cleanup code.
• Fixed an issue where os.unloadInst() would not work when going from 2 instances to 1 instance.
• Fixed an issue where menuPortal items would remain even if their inst was unloaded.
• Fixed an issue where it was possible to have multiple login attempts at once by calling os.requestAuthBot() multiple times without waiting for one to complete.
• Fixed some issues with experiment.beginRecording() and experiment.endRecording() where recording the screen with audio might fail in some cases.

V3.2.13

Date: 2/5/2024

:rocket: Features

• Improved diagnostics for VR and AR features.

:bug: Bug Fixes

• Fixed an issue where ai.generateSkybox() would fail if an instances array was provided.

V3.2.12

Date: 2/2/2024

:boom: Breaking Changes

• Removed the ability to create avatars with ReadyPlayerMe.

:rocket: Features

• Added POST /api/v2/ai/skybox character limit prompt to match BlockadeLabs limit of 600 characters.
• Added comID
  • comID is a set of features that allows studios to customize CasualOS based on their comID.
  • Studios can get a comID by obtaining a subscription that grants the comId feature to them.
  • Once a Studio has the feature, they can request the comID that they want from the Studio settings page.
  • They can also provide the following additional settings:
    • studio.name - The name of the Studio.
    • comID - The comID for the Studio. Studio admins can request a new comID for their studio.
    • comID.logoURL - The URL of the logo that should be displayed for the Studio and comID.
    • comID.allowedStudioCreators - The kinds of users that are allowed to create Studios within the comID. Possible options are "anyone" and "only-members".
    • comID.ab1BootstrapURL - The URL that specifies where the custom ab1 bootstrapper should be loaded from. If none is specified, then the default ab1 is loaded.
    • comID.allowedBiosOptions - The list of allowed BIOS options that can be presented to users. If none are specified, then the default list is used.
    • comID.defaultBiosOption - The BIOS option that is selected in the BIOS by default. If none is specified, then the default is used.
    • comID.automaticBiosOption - The BIOS option that will be automatically executed instead of displaying the BIOS. If none is specified, then the default is used.
    • comID.jitsiAppName - The name of the Jitsi App that should be used for the meetPortal. If none is specified, then the default is used.
    • comID.what3WordsApiKey - The API Key that should be used for os.convertGeolocationToWhat3Words(). If none is specified, then the default is used.
  • Setting comId or comID in the query tells CasualOS to use the settings that were configured on the related Studio settings page. Additionally, the logo of the studio will be displayed on the loading screens and BIOS.
• Added some messaging to the sign up pages to inform users that valid emails are required in order to completely setup their accounts.

:bug: Bug Fixes

• Fixed an issue where os.startFormAnimation() does not support starting paused animations with an initialTime greater than 0.