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

V2.0.31

Date: 1/20/2022

:rocket: Improvements

• Added the os.eraseData(recordKey, address) function to allow deleting data records.
  • recordKey is the key that should be used to access the record.
  • address is the address of the data inside the record that should be deleted.
• Added the os.eraseFile(recordKey, urlOrRecordFileResult) function to allow deleting file records.
  • recordKey is the key that should be used to access the record.
  • urlOrRecordFileResult is the URL that the file is stored at. It can also be the result of a os.recordFile() call.
• Added the os.recordManualApprovalData(recordKey, address, data), os.getManualApprovalData(recordName, address), and os.eraseManualApprovalData(recordKey, address) functions.
  • These work the same as os.recordData(), os.getData(), and os.eraseData() except that they read & write data records that require the user to confirm that they want to read/write the data.
  • One thing to note is that manual approval data records use a different pool of addresses than normal data records. This means that data which is stored using os.recordManualApprovalData() cannot be retrieved using os.getData() (i.e. you must use os.getManualApprovalData()).

:bug: Bug Fixes

• Fixed an issue where trying to save a bot using os.recordData() or os.recordFile() would produce an error.

V2.0.28

Date: 1/5/2022

:boom: Breaking Changes

• Changed the auth and records features to default to disabled unless the the AUTH_ORIGIN and RECORDS_ORIGIN environment variables are specified during build.

:rocket: Improvements

• Added the links global variable to the code editor autocomplete list.
• Added the masks global variable to the code editor autocomplete list.
• Improved os.showUploadFiles() to include the mimeType of the files that were uploaded.
  • This makes it easier to upload files with os.recordFile().
• Added the os.beginAudioRecording(options?) and os.endAudioRecording() functions.
  • They replace the experiment.beginAudioRecording() and experiment.endAudioRecording() functions.
  • Additionally, they now trigger the following listeners:
    • @onBeginAudioRecording - Called when recording starts.
    • @onEndAudioRecording - Called when recording ends.
    • @onAudioChunk - Called when a piece of audio is available if streaming is enabled via the options.
  • options is an object and supports the following properties:
    • stream - Whether to stream audio samples using @onAudioChunk.
    • mimeType - The MIME type that should be used to stream audio.
    • sampleRate - The number of audio samples that should be taken per second (Hz). Only supported on raw audio types (audio/x-raw).
  • See the documentation for more information and examples.

Bug Fixes

• Fixed an issue where the "remove tag" (X) buttons on empty tags in the sheet portal were always hidden.

V2.0.27

Date: 1/4/2022

:bug: Bug Fixes

• Fixed another issue where file records could not be uploaded due more issues with signature calculations.

V2.0.23

Date: 1/4/2022

:bug: Bug Fixes

• Fixed an issue where file records could not be uploaded due to an issue with signature calculation.

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.