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

Added ai.chat.allowedModels feature to enforce model usage limits, restricting access to specific models based on configuration.

Added shared documents.

• Shared documents utilize insts to be able to share data without using bots and tags.

• Additionally, shared documents can be loaded and unloaded at will.

• The following functions have been added:

  • os.getSharedDocument(name) - Gets a document that is stored in the current inst.
  • os.getSharedDocument(recordName, inst, name) - Gets a document that is stored in the specified inst.
  • os.getLocalDocument(name) - Gets a document that is stored on this device.
  • os.getMemoryDocument() - Gets a document that is stored in memory and cleared upon refresh.

• Usage:

  // Get a document stored in this inst named "test"
  const doc = await os.getSharedDocument('test');
  
  // maps work like the Map type (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)
  const inventory = doc.getMap<number>('inventory');
  
  inventory.set('spoons', 2);
  inventory.set('forks', 3);
  os.log('Number of spoons: ' + inventory.get('spoons'));
  
  // arrays work like regular JavaScript arrays:
  const shoppingList = doc.getArray<string>('shoppingList');
  shoppingList.push('cereal', 'milk', 'eggs');
  
  os.log('Shopping list:', inventory.toArray());
  
  // Text is a special type that makes it easy to work with long strings
  const blogPost = doc.getText('blogPost');
  
  blogPost.insert(0, 'Hello, world!');
  
  os.log('Blog Post:\n', blogPost.toString());
  

• This will make it much easier for us to moderate content and help ensure that we're creating safe platforms.

• When enabled, webhook records make it possible to run AUX code inside a server.
• Webhook records work using a request/response model.
  • When a request is made to execute the webhook, it grabs the configured target AUX file from another record and then executes it.
• A webhook gets its state from one of 3 different targets:
  • data: The webhook will use the bots from a data record.
  • file: The webhook will use the bots from a file record.
  • inst: The webhook will use the bots from an inst record.
    • Only supports reading from insts for now.
• Webhooks are secured by markers, just like regular records.
  • publicRead: The publicRead marker can be used to allow anyone to execute the webhook.
  • private: The private marker can be used to only allow the record members to execute the webhook.
  • The following actions are allowed for webhooks:
    • create
    • read
    • update
    • delete
    • list
    • run
• Webhooks have their own user ID.
  • By default, webhooks don't have access to anything except public records.
  • To allow webhooks to access other records, they need to be granted access to those resources.
  • You can find a webhook's user ID by calling os.getWebhook() or by inspecting the webhook through the admin panel.
• Additionally, the following functions have been added:
  • os.recordWebhook(recordName, webhook)
  • os.getWebhook(recordName, address)
  • os.runWebhook(recordName, address, input)
  • os.listWebhooks(recordName, address?)
  • os.listWebhooksByMarker(recordName, marker, address?)
  • os.eraseWebhook(recordName, address)
• Webhooks have the following limitations:
  • 15 seconds maximum runtime (including lambda cold start and initialization).
  • Most OS functions do nothing. (os.toast(), os.showInput(), etc.)
    • The most notable exception to this are records-related actions (os.recordData()).
  • Webhooks do not automatically install abCore. They only use the bots that are stored in the target.
  • Webhooks always act like static insts.
    • This means that any changes made to bots in the webhook are erased after the webhook finishes.

• When enabled, notification records make it easy to send push notifications to users.
• They work based on a subscription model:
  1. Notifier creates a notification record.
  2. User subscribes to a notification with os.subscribeToNotification(recordName, address).
  3. Notifier can send notifications to all subscriptions using os.sendNotification().
• Notifications are secured by markers, just like regular records.
  • publicRead: The publicRead marker can be used to allow anyone to read and subscribe to a notification.
  • The following actions are allowed for notifications:
    • create
    • read
    • update
    • delete
    • list
    • subscribe
    • unsubscribe
    • listSubscriptions
    • send
• After login, if a user is subscribed to a notification but their current device is not registered for notifications, then they will be prompted to register the device for notifications.
• Additionally, device registrations are stored separately from subscriptions so registering a device for an account will cause the device to receive notifications for all subscriptions the user has.
• Finally, the following functions have been added:
  • os.recordNotification(recordName, notification)
  • os.getNotification(recordName, address)
  • os.eraseNotification(recordName, address)
  • os.listNotifications(recordName, address?)
  • os.listNotificationsByMarker(recordName, marker, address?)
  • os.subscribeToNotification(recordName, address)
  • os.unsubscribeFromNotification(recordName, address)
  • os.sendNotification(recordName, address, payload)
  • os.listNotificationSubscriptions(recordName, address)
  • os.listUserNotificationSubscriptions()

• Supports loading meshes stored in the Three.js JSON Object Scene format.
• Works similarly to gltf, but it uses ObjectLoader to load meshes from the URL specified in the formAddress tag.