@casual-simulation/aux-runtime 3.3.11-alpha.11060020867 → 3.3.11

package/runtime/AuxLibraryDefinitions.def

@@ -10727,6 +10727,22 @@ export interface ListWebhooksOptions extends RecordActionOptions {
 }
 
 
+/**
+ * Defines an interface that represents the options for a list action.
+ *
+ * @dochash types/records/notifications
+ * @docName ListNotificationsOptions
+ */
+export interface ListNotificationsOptions extends RecordActionOptions {
+    /**
+     * The order that items should be sorted in.
+     * - "ascending" means that the items should be sorted in alphebatically ascending order by address.
+     * - "descending" means that the items should be sorted in alphebatically descending order by address.
+     */
+    sort?: 'ascending' | 'descending';
+}
+
+
 export interface WebhookRecord extends CrudRecord {
     /**
      * The resource kind of the webhook target.
@@ -10766,6 +10782,209 @@ export interface WebhookRecord extends CrudRecord {
     userId?: string | null;
 }
 
+/**
+ * Defines a record that represents a notification.
+ * That is, a way for users to be notified of something.
+ */
+export interface NotificationRecord extends CrudRecord {
+    /**
+     * The description of the notification.
+     */
+    description: string | null;
+}
+
+export type SubscribeToNotificationResult =
+    | SubscribeToNotificationSuccess
+    | SubscribeToNotificationFailure;
+
+export interface SubscribeToNotificationSuccess {
+    success: true;
+
+    /**
+     * The ID of the subscription that was created.
+     */
+    subscriptionId: string;
+}
+
+export interface SubscribeToNotificationFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+}
+
+
+export type UnsubscribeToNotificationResult =
+    | UnsubscribeToNotificationSuccess
+    | UnsubscribeToNotificationFailure;
+
+export interface UnsubscribeToNotificationSuccess {
+    success: true;
+}
+
+export interface UnsubscribeToNotificationFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+}
+
+
+export type SendNotificationResult =
+    | SendNotificationSuccess
+    | SendNotificationFailure;
+
+export interface SendNotificationSuccess {
+    success: true;
+}
+
+export interface SendNotificationFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+}
+
+/**
+ * Defines an active subscription to a notification.
+ */
+export interface NotificationSubscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: string;
+
+    /**
+     * The name of the record that the subscription is for.
+     */
+    recordName: string;
+
+    /**
+     * The address of the notification in the record.
+     */
+    notificationAddress: string;
+
+    /**
+     * The ID of the user that is subscribed.
+     * If null, then notifications should only be sent to the specified push subscription.
+     */
+    userId: string | null;
+
+    /**
+     * The push subscription that the notification should be sent to.
+     * If null, then notifications should be sent to all push subscriptions for the user.
+     */
+    pushSubscriptionId: string | null;
+}
+
+export type ListSubscriptionsResult =
+    | ListSubscriptionsSuccess
+    | ListSubscriptionsFailure;
+
+export interface ListSubscriptionsSuccess {
+    success: true;
+
+    /**
+     * The list of subscriptions.
+     */
+    subscriptions: NotificationSubscription[];
+}
+
+export interface ListSubscriptionsFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+}
+
+
+export interface PushNotificationPayload {
+    /**
+     * The title of the push notification.
+     * 
+     * See https://web.dev/articles/push-notifications-display-a-notification#title_and_body_options
+     */
+    title: string;
+
+    /**
+     * The body of the push notification.
+     * 
+     * See https://web.dev/articles/push-notifications-display-a-notification#title_and_body_options for more information.
+     */
+    body?: string;
+
+    /**
+     * The URL to the icon that should displayed for the push notification.
+     * 
+     * See https://web.dev/articles/push-notifications-display-a-notification#icon for more information.
+     */
+    icon?: string;
+
+    /**
+     * The URL to the image that should be used for the badge of the push notification.
+     * 
+     * See https://web.dev/articles/push-notifications-display-a-notification#badge for more information.
+     */
+    badge?: string;
+
+    /**
+     * Whether the push notification should be silent.
+     */
+    silent?: boolean;
+
+    /**
+     * The tag for the notification.
+     * 
+     * See https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#tag
+     */
+    tag?: string;
+    /**
+     * The timestamp for the notification.
+     * 
+     * See https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#timestamp
+     */
+    timestamp?: number;
+
+    /**
+     * The action that should be performed when the notification is clicked.
+     */
+    action?: PushNotificationAction;
+
+    /**
+     * The actions that should be displayed on the notification.
+     */
+    actions?: PushNotificationActionOption[];
+}
+
+export type PushNotificationAction = PushNotificationOpenUrlAction | PushNotificationWebhookAction;
+
+export interface PushNotificationOpenUrlAction {
+    type: 'open_url';
+    url: string;
+}
+
+export interface PushNotificationWebhookAction {
+    type: 'webhook';
+    method: 'GET' | 'POST';
+    url: string;
+    headers?: Record<string, string>;
+}
+
+export interface PushNotificationActionOption {
+    title: string;
+    icon?: string;
+    action: PushNotificationAction;
+}
+
+/**
+ * Defines an interface that represents the options for sending a notification.
+ *
+ * @dochash types/records/notifications
+ * @docName SendNotificationOptions
+ */
+export interface SendNotificationOptions extends RecordActionOptions {
+    /**
+     * The topic that the notification is for.
+     * Topics can be used to replace existing notifications with a new notification.
+     */
+    topic?: string;
+}
 
 interface Ai {
     /**
@@ -12852,6 +13071,215 @@ interface Os {
         options?: ListWebhooksOptions
     ): Promise<CrudListItemsResult<WebhookRecord>>;
 
+    /**
+     * Creates or updates a [notification](glossary:notification-record) in the given record using the given options.
+     *
+     * Returns a promise that resolves with an object that contains whether the operation succeeded.
+     *
+     * @param recordName the name of the record.
+     * @param notification the notification that should be created or updated.
+     * @param options the options that should be used.
+     *
+     * @example Create a notification that anyone can subscribe to.
+     * await os.recordNotification('myRecord', {
+     *   address: 'notificationAddress',
+     *   description: 'my notification',
+     *   markers: ['publicRead']
+     * });
+     *
+     * @example Create a private notification.
+     * await os.recordNotification('myRecord', {
+     *   address: 'notificationAddress',
+     *   description: 'my notification',
+     *   markers: ['private']
+     * });
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.recordNotification
+     */
+    recordNotification(
+        recordName: string,
+        notification: NotificationRecord,
+        options?: RecordActionOptions
+    ): Promise<CrudRecordItemResult>;
+
+    /**
+     * Gets the [notification](glossary:notification-record) from the given record.
+     *
+     * Returns a promise that resolves with the notification data.
+     *
+     * @param recordName the name of the record.
+     * @param address the address of the notification.
+     * @param options the options to use.
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.getWebhook
+     */
+    getNotification(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions
+    ): Promise<CrudGetItemResult<NotificationRecord>>;
+
+    /**
+     * Deletes the [notification](glossary:notification-record) from the given record.
+     * @param recordName the name of the record.
+     * @param address the address of the notification.
+     * @param options the options to use.
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.eraseNotification
+     */
+    eraseNotification(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions
+    ): Promise<CrudEraseItemResult>;
+
+    /**
+     * Lists the notifications that are in the given record.
+     * @param recordName the name of the record.
+     * @param startingAddress the address after which items will be included in the list.
+     * Since items are ordered within the record by address, this can be used as way to iterate through all the webhooks items in a record.
+     * If omitted, then the list will start with the first item.
+     * @param options the options to use.
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.listNotifications
+     */
+    listNotifications(
+        recordName: string,
+        startingAddress?: string,
+        options?: ListNotificationsOptions
+    ): Promise<CrudListItemsResult<NotificationRecord>>;
+
+    /**
+     * Lists the webhooks that are in the given record.
+     * @param recordName the name of the record.
+     * @param marker The marker that needs to be assigned to the data items that should be included in the list.
+     * e.g. Using "publicRead" will return all data items with the "publicRead" marker.
+     * @param startingAddress the address after which items will be included in the list.
+     * Since items are ordered within the record by address, this can be used as way to iterate through all the webhooks items in a record.
+     * If omitted, then the list will start with the first item.
+     * @param options the options to use.
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.listNotificationsByMarker
+     */
+    listNotificationsByMarker(
+        recordName: string,
+        marker: string,
+        startingAddress?: string,
+        options?: ListNotificationsOptions
+    ): Promise<CrudListItemsResult<NotificationRecord>>;
+
+    /**
+     * Subscribes to the given notification in the given record.
+     *
+     * Returns a promise that resolves when the operation is complete.
+     *
+     * @param recordName the name of the record.
+     * @param address the address of the notification that should be subscribed to.
+     * @param options the options to use.
+     *
+     * @example Subscribe to a notification.
+     * await os.subscribeToNotification('myRecord', 'myNotificationAddress');
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.subscribeToNotification
+     */
+    subscribeToNotification(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions
+    ): Promise<SubscribeToNotificationResult>;
+
+    /**
+     * Unsubscribes from the given notification subscription.
+     *
+     * Returns a promise that resolves when the operation is complete.
+     *
+     * @param subscriptionId the ID of the subscription.
+     * @param options the options to use.
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.unsubscribeFromNotification
+     */
+    unsubscribeFromNotification(
+        subscriptionId: string,
+        options?: RecordActionOptions
+    ): Promise<UnsubscribeToNotificationResult>;
+
+    /**
+     * Sends a notification to all subscribers of the given notification in the given record.
+     *
+     * Returns a promise that resolves with the result of the operation.
+     *
+     * @param recordName the name of the record.
+     * @param address the address of the notification.
+     * @param payload the payload to send.
+     * @param options the options to use.
+     *
+     * @example Send a notification.
+     * await os.sendNotification('myRecord', 'myNotificationAddress', {
+     *     title: 'Hello',
+     *     body: 'This is your first notification!',
+     * });
+     *
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.sendNotification
+     */
+    sendNotification(
+        recordName: string,
+        address: string,
+        payload: PushNotificationPayload,
+        options?: SendNotificationOptions
+    ): Promise<SendNotificationResult>;
+
+    /**
+     * Gets the list of subscriptions for the given notification in the given record.
+     * 
+     * @param recordName the name of the record.
+     * @param address the address of the notification.
+     * @param options the options to use.
+     * 
+     * @example List notification subscriptions.
+     * const result = await os.listNotificationSubscriptions('myRecord', 'myNotificationAddress');
+     * 
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.listNotificationSubscriptions
+     */
+    listNotificationSubscriptions(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions
+    ): Promise<ListSubscriptionsResult>;
+
+    /**
+     * Gets the list of notification subscriptions for the current user.
+     * 
+     * @param options the options to use.
+     * 
+     * @example List the current user's notification subscriptions.
+     * const result = await os.listUserNotificationSubscriptions();
+     * 
+     * @dochash actions/os/records
+     * @docgroup 06-records
+     * @docname os.listUserNotificationSubscriptions
+     */
+    listUserNotificationSubscriptions(
+        options?: RecordActionOptions
+    ): Promise<ListSubscriptionsResult>;
+
     /**
      * Records the given data as a file.
      * @param recordKey The record that the file should be recorded in.

package/runtime/RecordsEvents.d.ts

@@ -1,8 +1,8 @@
-import type { AIChatMessage, PublicRecordKeyPolicy, RecordFileFailure, WebhookRecord } from '@casual-simulation/aux-records';
+import type { AIChatMessage, PublicRecordKeyPolicy, RecordFileFailure, WebhookRecord, NotificationRecord, PushNotificationPayload } from '@casual-simulation/aux-records';
 import type { RecordsClientActions } from '@casual-simulation/aux-records/RecordsClient';
 import { APPROVED_SYMBOL, AsyncAction, AvailablePermissions } from '@casual-simulation/aux-common';
 export type RecordsActions = RecordsAsyncActions;
-export type RecordsAsyncActions = RecordDataAction | GetRecordDataAction | ListRecordDataAction | ListRecordDataByMarkerAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | AIChatAction | AIChatStreamAction | AIGenerateImageAction | AIGenerateSkyboxAction | AIHumeGetAccessTokenAction | AISloydGenerateModelAction | ListUserStudiosAction | GetPublicRecordKeyAction | GrantRecordPermissionAction | RevokeRecordPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RecordsCallProcedureAction;
+export type RecordsAsyncActions = RecordDataAction | GetRecordDataAction | ListRecordDataAction | ListRecordDataByMarkerAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | AIChatAction | AIChatStreamAction | AIGenerateImageAction | AIGenerateSkyboxAction | AIHumeGetAccessTokenAction | AISloydGenerateModelAction | ListUserStudiosAction | GetPublicRecordKeyAction | GrantRecordPermissionAction | RevokeRecordPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RecordsCallProcedureAction | SubscribeToNotificationAction;
 /**
  * An event that is used to chat with an AI.
  */
@@ -436,11 +436,25 @@ export interface RecordsCallProcedureAction extends RecordsAction {
      */
     procedure: Partial<RecordsClientActions>;
 }
+/**
+ * Defines an event that attempts to subscribe to a notification.
+ */
+export interface SubscribeToNotificationAction extends RecordsAction {
+    type: 'subscribe_to_notification';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The address of the notification.
+     */
+    address: string;
+}
 /**
  * Defines an interface that represents the options for a list data action.
  *
- * @dochash types/records/data
- * @docName ListDataOptions
+ * @dochash types/records/webhooks
+ * @docName ListWebhooksOptions
  */
 export interface ListWebhooksOptions extends RecordActionOptions {
     /**
@@ -450,6 +464,33 @@ export interface ListWebhooksOptions extends RecordActionOptions {
      */
     sort?: 'ascending' | 'descending';
 }
+/**
+ * Defines an interface that represents the options for a list action.
+ *
+ * @dochash types/records/notifications
+ * @docName ListNotificationsOptions
+ */
+export interface ListNotificationsOptions extends RecordActionOptions {
+    /**
+     * The order that items should be sorted in.
+     * - "ascending" means that the items should be sorted in alphebatically ascending order by address.
+     * - "descending" means that the items should be sorted in alphebatically descending order by address.
+     */
+    sort?: 'ascending' | 'descending';
+}
+/**
+ * Defines an interface that represents the options for sending a notification.
+ *
+ * @dochash types/records/notifications
+ * @docName SendNotificationOptions
+ */
+export interface SendNotificationOptions extends RecordActionOptions {
+    /**
+     * The topic that the notification is for.
+     * Topics can be used to replace existing notifications with a new notification.
+     */
+    topic?: string;
+}
 export interface RecordFileActionOptions extends RecordActionOptions {
     /**
      * The markers that should be applied to the record.
@@ -1138,6 +1179,86 @@ export declare function listWebhooksByMarker(recordName: string, marker: string,
  * @param taskId The ID of the task.
  */
 export declare function eraseWebhook(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates a SubscribeToNotificationAction.
+ * @param recordName The name of the record.
+ * @param address The address of the notification to subscribe to.
+ * @param options The options that should be used for the action.
+ * @param taskId The ID of the async task.
+ */
+export declare function subscribeToNotification(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): SubscribeToNotificationAction;
+/**
+ * Creates an action that is able to unsubscribe from a notification.
+ * @param subscriptionId The ID of the subscription.
+ * @param options The options that should be used for the action.
+ * @param taskId The ID of the async task.
+ */
+export declare function unsubscribeFromNotification(subscriptionId: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that is able to record a notification.
+ * @param recordName The name of the record.
+ * @param item The item to record.
+ * @param options The options.
+ * @param taskId The ID of the async task.
+ */
+export declare function recordNotification(recordName: string, item: NotificationRecord, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that is able to get information about a notification.
+ * @param recordName The name of the record.
+ * @param address The address of the notification.
+ * @param options The options.
+ * @param taskId The ID of the async task.
+ */
+export declare function getNotification(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that is able to list the notifications in a record.
+ * @param recordName The name of the record.
+ * @param startingAddress The address that the list should start with.
+ * @param options The options.
+ * @param taskId The ID of the async task.
+ */
+export declare function listNotifications(recordName: string, startingAddress: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that is able to list the notifications in a record.
+ * @param recordName The name of the record.
+ * @param marker The marker.
+ * @param startingAddress The address that the list should start with.
+ * @param options The options.
+ * @param taskId The ID of the async task.
+ */
+export declare function listNotificationsByMarker(recordName: string, marker: string, startingAddress: string, options: ListNotificationsOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that is able to erase a notification.
+ * @param recordName The name of the record.
+ * @param address The address of the notification.
+ * @param options The options.
+ * @param taskId The ID of the async task.
+ */
+export declare function eraseNotification(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that can be used to send a notification.
+ * @param recordName The name of the record.
+ * @param address The address of the notification.
+ * @param payload The payload to send.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function sendNotification(recordName: string, address: string, payload: PushNotificationPayload, options: SendNotificationOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that can be used to list the notification subscriptions for a record.
+ * @param recordName The name of the record.
+ * @param address The address of the notification.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function listNotificationSubscriptions(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates an action that can be used to list the notification subscriptions a user.
+ * @param userId The ID of the user.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function listUserNotificationSubscriptions(options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
 /**
  * Creates a RecordFileAction.
  * @param recordKey The key that should be used to access the record.