0.45.2-beta.0

Author: caidobot

packages/sdk-frontend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "v0.45.1",
+  "version": "0.45.2-beta.0",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <[email protected]>",
   "license": "MIT",

packages/sdk-frontend/src/types/assets.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Utilities to interact with the plugin's static assets.
+ * @category Files
+ */
+export type AssetsSDK = {
+    /**
+     * Get a file from the assets folder.
+     * @returns The asset file.
+     */
+    get: (path: string) => Promise<Asset>;
+};
+/**
+ * A static asset.
+ * @category Files
+ */
+type Asset = {
+    asReadableStream: () => ReadableStream;
+    asArrayBuffer: () => Promise<ArrayBuffer>;
+    asString: () => Promise<string>;
+    asJson: <T = unknown>() => Promise<T>;
+};
+export {};

packages/sdk-frontend/src/types/index.d.ts

@@ -1,4 +1,5 @@
 import type { Sdk as GraphqlSDK } from "./__generated__/graphql-sdk";
+import type { AssetsSDK } from "./assets";
 import type { BackendEndpoints, BackendEvents, BackendSDK } from "./backend";
 import type { CommandPaletteSDK } from "./commandPalette";
 import type { CommandsSDK } from "./commands";
@@ -74,6 +75,10 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with frontend-plugin storage.
      */
     storage: StorageSDK;
+    /**
+     * Utilities to interact with the plugin's static assets.
+     */
+    assets: AssetsSDK;
     /**
      * Utilities to interact with shortcuts.
      */