@caido/sdk-frontend 0.42.1-beta.4 → 0.42.1-beta.6

package/src/types/files.d.ts

@@ -0,0 +1,60 @@
+/**
+ * SDK for interacting with the Files page.
+ * @category Files
+ */
+export type FilesSDK = {
+    /**
+     * Gets all hosted files.
+     * @returns The files.
+     */
+    getAll: () => HostedFile[];
+    /**
+     * Uploads a file to the host.
+     * @param file The file to upload.
+     * @returns The uploaded file.
+     */
+    create: (file: File) => Promise<HostedFile>;
+    /**
+     * Renames a file on the host.
+     * @param id The ID of the file to rename.
+     * @param name The new name of the file.
+     * @returns The renamed file.
+     */
+    rename: (id: string, name: string) => Promise<HostedFile>;
+    /**
+     * Deletes a file from the host.
+     * @param id The ID of the file to delete.
+     * @returns The deleted file.
+     */
+    delete: (id: string) => Promise<void>;
+};
+/**
+ * A hosted file.
+ * @category Files
+ */
+export type HostedFile = {
+    /**
+     * The ID of the file.
+     */
+    id: string;
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size: number;
+    /**
+     * The path of the file.
+     */
+    path: string;
+    /**
+     * The date the file was created.
+     */
+    createdAt: Date;
+    /**
+     * The date the file was updated.
+     */
+    updatedAt: Date;
+};

package/src/types/index.d.ts

@@ -14,9 +14,11 @@ import type { WindowSDK } from "./window";
 import type { ReplaySDK } from "./replay";
 import type { SearchSDK } from "./search";
 import type { HTTPHistorySDK } from "./httpHistory";
+import type { FilesSDK } from "./files";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
 export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
+export type { HostedFile } from "./files";
 /**
  * Utilities for frontend plugins.
  * @category SDK
@@ -86,4 +88,8 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with the HTTP History page.
      */
     httpHistory: HTTPHistorySDK;
+    /**
+     * Utilities to interact with files.
+     */
+    files: FilesSDK;
 };