@casual-simulation/aux-common 3.0.9 → 3.0.10-alpha.2282886558

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -246,7 +246,6 @@ declare type ExtraActions =
246
246
  | EnableCustomDraggingAction
247
247
  | EnablePOVAction
248
248
  | SetAppOutputAction
249
- | MeetCommandAction
250
249
  | AddDropGridTargetsAction;
251
250
 
252
251
  /**
@@ -275,7 +274,8 @@ declare type AsyncActions =
275
274
  | GetGeolocationAction
276
275
  | ARSupportedAction
277
276
  | VRSupportedAction
278
- | OpenImageClassifierAction;
277
+ | OpenImageClassifierAction
278
+ | MeetCommandAction;
279
279
 
280
280
  /**
281
281
  * Defines an interface for actions that represent asynchronous tasks.
@@ -1854,7 +1854,7 @@ declare interface EnablePOVAction {
1854
1854
  /**
1855
1855
  * An event that is used to send a command to the Jitsi Meet API.
1856
1856
  */
1857
- declare interface MeetCommandAction {
1857
+ declare interface MeetCommandAction extends AsyncAction {
1858
1858
  type: 'meet_command',
1859
1859
 
1860
1860
  /**
@@ -3079,7 +3079,33 @@ export type NotLoggedInError = 'not_logged_in';
3079
3079
 
3080
3080
  export type RecordNotFoundError = 'record_not_found';
3081
3081
 
3082
+ /**
3083
+ * Defines a type that represents a policy that indicates which users are allowed to affect a record.
3084
+ *
3085
+ * True indicates that any user can edit the record.
3086
+ * An array of strings indicates the list of users that are allowed to edit the record.
3087
+ */
3088
+ export type RecordUserPolicyType = true | string[];
3082
3089
 
3090
+ /**
3091
+ * The options for data record actions.
3092
+ */
3093
+ export interface RecordDataOptions {
3094
+ /**
3095
+ * The HTTP Endpoint that should be queried.
3096
+ */
3097
+ endpoint?: string;
3098
+
3099
+ /**
3100
+ * The policy that should be used for updating the record.
3101
+ */
3102
+ updatePolicy?: RecordUserPolicyType;
3103
+
3104
+ /**
3105
+ * The policy that should be used for deleting the record.
3106
+ */
3107
+ deletePolicy?: RecordUserPolicyType;
3108
+ }
3083
3109
 
3084
3110
  export type RecordDataResult = RecordDataSuccess | RecordDataFailure;
3085
3111
 
@@ -6384,7 +6410,7 @@ declare global {
6384
6410
  * Creates a tag value that can be used to link to the given bots.
6385
6411
  * @param bots The bots that the link should point to.
6386
6412
  */
6387
- function createBotLink(...bots: (Bot | string | (Bot | string)[])[]): string;
6413
+ function getLink(...bots: (Bot | string | (Bot | string)[])[]): string;
6388
6414
 
6389
6415
  /**
6390
6416
  * Gets the list of bot links that are stored in this bot's tags.
@@ -7181,7 +7207,7 @@ interface Debugger {
7181
7207
  * Creates a tag value that can be used to link to the given bots.
7182
7208
  * @param bots The bots that the link should point to.
7183
7209
  */
7184
- createBotLink(...bots: (Bot | string | (Bot | string)[])[]): string;
7210
+ getLink(...bots: (Bot | string | (Bot | string)[])[]): string;
7185
7211
 
7186
7212
  /**
7187
7213
  * Gets the list of bot links that are stored in this bot's tags.
@@ -8035,6 +8061,23 @@ interface Os {
8035
8061
  */
8036
8062
  toast(message: string | number | boolean | object | Array<any> | null, duration?: number): ShowToastAction;
8037
8063
 
8064
+ /**
8065
+ * Shows a tooltip message to the user.
8066
+ * @param message The message to show.
8067
+ * @param pixelX The X coordinate that the tooltip should be shown at. If null, then the current pointer position will be used.
8068
+ * @param pixelY The Y coordinate that the tooltip should be shown at. If null, then the current pointer position will be used.
8069
+ * @param duration The duration that the tooltip should be shown in seconds.
8070
+ */
8071
+ tip(message: string | number | boolean | object | Array<any> | null, pixelX?: number, pixelY?: number, duration?: number): Promise<number>;
8072
+
8073
+ /**
8074
+ * Hides the given list of tips.
8075
+ * If no tip IDs are provided, then all tips will be hidden.
8076
+ * @param tipIds
8077
+ * @returns
8078
+ */
8079
+ hideTips(tipIds?: number | number[]): Promise<void>;
8080
+
8038
8081
  /**
8039
8082
  * Play the given url's audio.
8040
8083
  * Returns a promise that resolves with the sound ID when the sound starts playing.
@@ -8085,10 +8128,12 @@ interface Os {
8085
8128
  /**
8086
8129
  * Sends a command to the Jitsi Meet API.
8087
8130
  * See https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe/#commands for a list of commands.
8131
+ *
8132
+ * Returns a promise that resolves when the command has been executed.
8088
8133
  * @param command The name of the command to execute.
8089
8134
  * @param args The arguments for the command (if any).
8090
8135
  */
8091
- meetCommand(command: string, ...args: any[]): MeetCommandAction;
8136
+ meetCommand(command: string, ...args: any[]): Promise<void>;
8092
8137
 
8093
8138
  /**
8094
8139
  * Executes the given function from the Jitsi Meet API and returns a promise with the result.
@@ -8585,13 +8630,13 @@ interface Os {
8585
8630
  * @param recordKey The key that should be used to access the record.
8586
8631
  * @param address The address that the data should be stored at inside the record.
8587
8632
  * @param data The data that should be stored.
8588
- * @param endpoint The records endpoint that should be queried. Optional.
8633
+ * @param optionsOrEndpoint The options that should be used for recording the data. Alternatively, the records endpoint that should be queried. Optional.
8589
8634
  */
8590
8635
  recordData(
8591
8636
  recordKey: string,
8592
8637
  address: string,
8593
8638
  data: any,
8594
- endpoint?: string
8639
+ optionsOrEndpoint?: RecordDataOptions | string
8595
8640
  ): Promise<RecordDataResult>;
8596
8641
 
8597
8642
  /**
@@ -8629,13 +8674,13 @@ interface Os {
8629
8674
  * @param recordKey The key that should be used to access the record.
8630
8675
  * @param address The address that the data should be stored at inside the record.
8631
8676
  * @param data The data that should be stored.
8632
- * @param endpoint The records endpoint that should be queried. Optional.
8677
+ * @param optionsOrEndpoint The options that should be used for recording the data. Alternatively, the records endpoint that should be queried. Optional.
8633
8678
  */
8634
8679
  recordManualApprovalData(
8635
8680
  recordKey: string,
8636
8681
  address: string,
8637
8682
  data: any,
8638
- endpoint?: string
8683
+ optionsOrEndpoint?: RecordDataOptions | string
8639
8684
  ): Promise<RecordDataResult>;
8640
8685
 
8641
8686
  /**