@casual-simulation/aux-common 3.1.35 → 3.2.0

package/runtime/AuxLibraryDefinitions.def

@@ -3329,7 +3329,7 @@ export interface RecordActionOptions {
     endpoint?: string;
 }
 
-export type GrantMarkerPermissionResponse =
+export type GrantMarkerPermissionResult =
     | GrantMarkerPermissionSuccess
     | GrantMarkerPermissionFailure;
 
@@ -7453,7 +7453,7 @@ export interface PauseTrigger extends PauseTriggerOptions {
 /**
  * Defines an interface for a possible pause trigger location.
  */
-export interface PossibleTriggerLocation {
+export interface PossiblePauseTriggerLocation {
     /**
      * The line number that the trigger would pause the debugger at.
      */
@@ -8671,7 +8671,7 @@ interface DebuggerBase {
      * @param botOrId The bot or bot ID.
      * @param tag The name of the tag that the trigger locations should be listed for.
      */
-    listCommonPauseTriggers(botOrId: Bot | string, tag: string): PossibleTriggerLocation[];
+    listCommonPauseTriggers(botOrId: Bot | string, tag: string): PossiblePauseTriggerLocation[];
 
     /**
      * Resumes the debugger execution from the given pause.
@@ -10664,7 +10664,7 @@ interface Os {
         marker: string,
         permission: object,
         options?: RecordActionOptions
-    ): Promise<GrantMarkerPermissionResponse>;
+    ): Promise<GrantMarkerPermissionResult>;
 
     /**
      * Revokes the given permission from the given marker in the given record.
@@ -10869,6 +10869,60 @@ interface Os {
      */
     getFile(urlOrRecordFileResult: string | RecordFileSuccess): Promise<any>;
 
+    /**
+     * Gets the data stored in the given public file.
+     * Only works for files that have the `publicRead` marker.
+     * If the file is not public, then this operation will fail.
+     * @param result The successful result of a os.recordFile() call.
+     * @param endpoint The endpoint that should be queried. Optional.
+     */
+    getPublicFile(result: RecordFileSuccess): Promise<any>;
+
+    /**
+     * Gets the data stored in the given public file.
+     * Only works for files that have the `publicRead` marker.
+     * If the file is not public, then this operation will fail.
+     * @param url The URL that the public file is stored at.
+     */
+    getPublicFile(url: string): Promise<any>;
+
+    /**
+     * Gets the data stored in the given public file.
+     * Only works for files that have the `publicRead` marker.
+     * If the file is not public, then this operation will fail.
+     * @param urlOrRecordFileResult The URL or the successful result of the record file operation.
+     */
+    getPublicFile(
+        urlOrRecordFileResult: string | RecordFileSuccess
+    ): Promise<string>;
+
+    /**
+     * Gets the data stored in the given private file.
+     * @param result The successful result of a os.recordFile() call.
+     * @param endpoint The endpoint that should be queried. Optional.
+     */
+    getPrivateFile(
+        result: RecordFileSuccess,
+        endpoint?: string
+    ): Promise<any>;
+
+    /**
+     * Gets the data stored in the given private file.
+     * @param url The URL that the public file is stored at.
+     * @param endpoint The endpoint that should be queried. Optional.
+     */
+    getPrivateFile(url: string, endpoint?: string): Promise<any>;
+
+    /**
+     * Gets the data stored in the given private file.
+     * @param urlOrRecordFileResult The URL or the successful result of the record file operation.
+     * @param endpoint The endpoint that should be queried. Optional.
+     */
+    getPrivateFile(
+        urlOrRecordFileResult: string | RecordFileSuccess,
+        endpoint?: string
+    ): Promise<string>;
+
     /**
      * Deletes the specified file using the given record key.
      * @param recordKey The key that should be used to delete the file.

package/runtime/AuxVersion.d.ts

@@ -1,5 +1,7 @@
 /**
  * Contains information about the version of AUX that is running.
+ * @dochash types/os
+ * @docname CasualOSVersion
  */
 export interface AuxVersion {
     /**