@caido/sdk-frontend 0.46.1-beta.5 → 0.46.1-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.46.1-beta.5",
+  "version": "0.46.1-beta.6",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "license": "MIT",

package/src/types/index.d.ts

@@ -22,6 +22,7 @@ import type { SitemapSDK } from "./sitemap";
 import type { StorageSDK } from "./storage";
 import type { UISDK } from "./ui";
 import type { WindowSDK } from "./window";
+import type { WorkflowSDK } from "./workflows";
 export type { CommandContext } from "./commands";
 export type { MenuItem } from "./menu";
 export type { ReplayTab, ReplaySession, ReplayCollection } from "./replay";
@@ -31,6 +32,7 @@ export type { HTTPQL, ID } from "./utils";
 export type { MatchReplaceRule, MatchReplaceCollection, MatchReplaceSection, MatchReplaceSectionRequestBody, MatchReplaceSectionRequestFirstLine, MatchReplaceSectionRequestHeader, MatchReplaceSectionRequestMethod, MatchReplaceSectionRequestPath, MatchReplaceSectionRequestQuery, MatchReplaceSectionResponseBody, MatchReplaceSectionResponseFirstLine, MatchReplaceSectionResponseHeader, MatchReplaceSectionResponseStatusCode, MatchReplaceOperationStatusCode, MatchReplaceOperationStatusCodeUpdate, MatchReplaceOperationQuery, MatchReplaceOperationQueryRaw, MatchReplaceOperationQueryAdd, MatchReplaceOperationQueryRemove, MatchReplaceOperationQueryUpdate, MatchReplaceOperationPath, MatchReplaceOperationPathRaw, MatchReplaceOperationMethod, MatchReplaceOperationMethodUpdate, MatchReplaceOperationHeader, MatchReplaceOperationHeaderRaw, MatchReplaceOperationHeaderAdd, MatchReplaceOperationHeaderRemove, MatchReplaceOperationHeaderUpdate, MatchReplaceOperationBody, MatchReplaceOperationBodyRaw, MatchReplaceOperationFirstLine, MatchReplaceOperationFirstLineRaw, MatchReplaceReplacer, MatchReplaceReplacerTerm, MatchReplaceReplacerWorkflow, MatchReplaceMatcherName, MatchReplaceMatcherRaw, MatchReplaceMatcherRawFull, MatchReplaceMatcherRawRegex, MatchReplaceMatcherRawValue, } from "./matchReplace";
 export type { Scope } from "./scopes";
 export type { EnvironmentVariable } from "./environment";
+export type { Workflow, WorkflowKind } from "./workflows";
 /**
  * Utilities for frontend plugins.
  * @category SDK
@@ -132,4 +134,8 @@ export type API<T extends BackendEndpoints = Record<string, never>, E extends Ba
      * Utilities to interact with the runtime.
      */
     runtime: RuntimeSDK;
+    /**
+     * Utilities to interact with workflows.
+     */
+    workflows: WorkflowSDK;
 };

package/src/types/workflows.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Utilities to interact with workflows.
+ * @category Workflows
+ */
+export type WorkflowSDK = {
+    /**
+     * Get all workflows.
+     * @returns All workflows.
+     */
+    getWorkflows: () => Workflow[];
+};
+/**
+ * A workflow
+ * @category Workflows
+ */
+export type Workflow = {
+    id: string;
+    name: string;
+    description: string;
+    kind: WorkflowKind;
+};
+/**
+ * The kind of workflow.
+ * @category Workflows
+ */
+export type WorkflowKind = "Convert" | "Active" | "Passive";