@caido/sdk-frontend 0.58.3-beta.0 → 0.58.3-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.58.3-beta.0",
+  "version": "0.58.3-beta.1",
   "description": "Typing for the Caido Frontend SDK",
   "author": "Caido Labs Inc. <dev@caido.io>",
   "repository": "https://github.com/caido/sdk-js/",

package/src/types/__generated__/graphql-sdk.d.ts

@@ -20628,6 +20628,110 @@ export type CreatedPluginEventSubscription = {
         eventName: string;
     };
 };
+export type PluginPackageDataFullFragment = {
+    key: string;
+    value?: unknown | undefined | null;
+    flags: {
+        exportable: boolean;
+    };
+    package: {
+        id: string;
+    };
+};
+export type PluginPackageDataQueryVariables = Exact<{
+    id: Scalars["ID"]["input"];
+    key: Scalars["String"]["input"];
+}>;
+export type PluginPackageDataQuery = {
+    pluginPackageData?: {
+        key: string;
+        value?: unknown | undefined | null;
+        flags: {
+            exportable: boolean;
+        };
+        package: {
+            id: string;
+        };
+    } | undefined | null;
+};
+export type DefinePluginPackageDataMutationVariables = Exact<{
+    id: Scalars["ID"]["input"];
+    input: DefinePluginPackageDataInput;
+}>;
+export type DefinePluginPackageDataMutation = {
+    definePluginPackageData: {
+        success: boolean;
+        error?: {
+            __typename: "OtherUserError";
+            code: string;
+        } | {
+            __typename: "UnknownIdUserError";
+            id: string;
+            code: string;
+        } | undefined | null;
+    };
+};
+export type SetPluginPackageDataMutationVariables = Exact<{
+    id: Scalars["ID"]["input"];
+    key: Scalars["String"]["input"];
+    data: Scalars["JSON"]["input"];
+}>;
+export type SetPluginPackageDataMutation = {
+    setPluginPackageData: {
+        success: boolean;
+        error?: {
+            __typename: "OtherUserError";
+            code: string;
+        } | {
+            __typename: "UnknownIdUserError";
+            id: string;
+            code: string;
+        } | undefined | null;
+    };
+};
+export type DeletePluginPackageDataMutationVariables = Exact<{
+    id: Scalars["ID"]["input"];
+    key: Scalars["String"]["input"];
+}>;
+export type DeletePluginPackageDataMutation = {
+    deletePluginPackageData: {
+        success: boolean;
+        error?: {
+            __typename: "OtherUserError";
+            code: string;
+        } | {
+            __typename: "UnknownIdUserError";
+            id: string;
+            code: string;
+        } | undefined | null;
+    };
+};
+export type UpdatedPluginPackageDataSubscriptionVariables = Exact<{
+    [key: string]: never;
+}>;
+export type UpdatedPluginPackageDataSubscription = {
+    updatedPluginPackageData: {
+        packageData: {
+            key: string;
+            value?: unknown | undefined | null;
+            flags: {
+                exportable: boolean;
+            };
+            package: {
+                id: string;
+            };
+        };
+    };
+};
+export type DeletedPluginPackageDataSubscriptionVariables = Exact<{
+    [key: string]: never;
+}>;
+export type DeletedPluginPackageDataSubscription = {
+    deletedPluginPackageData: {
+        packageId: string;
+        key: string;
+    };
+};
 export type ProjectFullFragment = {
     __typename: "Project";
     id: string;
@@ -123882,6 +123986,7 @@ export declare const WorkflowMetaFragmentDoc = "\n    fragment workflowMeta on W
 export declare const PluginWorkflowFullFragmentDoc = "\n    fragment pluginWorkflowFull on PluginWorkflow {\n  ...pluginMeta\n  name\n  workflow {\n    ...workflowMeta\n  }\n}\n    ";
 export declare const PluginPackageFullFragmentDoc = "\n    fragment pluginPackageFull on PluginPackage {\n  ...pluginPackageMeta\n  plugins {\n    ... on PluginFrontend {\n      ...pluginFrontendFull\n    }\n    ... on PluginBackend {\n      ...pluginBackendFull\n    }\n    ... on PluginWorkflow {\n      ...pluginWorkflowFull\n    }\n  }\n}\n    ";
 export declare const StorePluginPackageFullFragmentDoc = "\n    fragment storePluginPackageFull on StorePluginPackage {\n  author {\n    email\n    name\n    url\n  }\n  description\n  downloads\n  license\n  manifestId\n  name\n  repository\n  version\n  official\n  quality\n  readmeUrl\n  changelogUrl\n}\n    ";
+export declare const PluginPackageDataFullFragmentDoc = "\n    fragment pluginPackageDataFull on PluginPackageData {\n  key\n  value\n  flags {\n    exportable\n  }\n  package {\n    id\n  }\n}\n    ";
 export declare const ProjectConfigStreamFullFragmentDoc = "\n    fragment projectConfigStreamFull on ProjectConfigStream {\n  stripExtension\n}\n    ";
 export declare const ProjectConfigFullFragmentDoc = "\n    fragment projectConfigFull on ProjectConfig {\n  stream {\n    ...projectConfigStreamFull\n  }\n}\n    ";
 export declare const CurrentProjectFullFragmentDoc = "\n    fragment currentProjectFull on CurrentProject {\n  project {\n    ...projectFull\n  }\n  config {\n    ...projectConfigFull\n  }\n}\n    ";
@@ -124144,6 +124249,12 @@ export declare const CreatedPluginPackageDocument = "\n    subscription createdP
 export declare const DeletedPluginPackageDocument = "\n    subscription deletedPluginPackage {\n  deletedPluginPackage {\n    deletedPackageId\n  }\n}\n    ";
 export declare const UpdatedPluginDocument = "\n    subscription updatedPlugin {\n  updatedPlugin {\n    plugin {\n      ... on PluginFrontend {\n        ...pluginFrontendFull\n      }\n      ... on PluginBackend {\n        ...pluginBackendFull\n      }\n      ... on PluginWorkflow {\n        ...pluginWorkflowFull\n      }\n    }\n  }\n}\n    \n    fragment pluginFrontendFull on PluginFrontend {\n  ...pluginMeta\n  entrypoint\n  style\n  data\n  backend {\n    ...pluginBackendMeta\n  }\n}\n    \n\n    fragment pluginMeta on Plugin {\n  __typename\n  id\n  name\n  enabled\n  manifestId\n  package {\n    id\n  }\n}\n    \n\n    fragment pluginBackendMeta on PluginBackend {\n  __typename\n  id\n}\n    \n\n    fragment pluginBackendFull on PluginBackend {\n  ...pluginMeta\n  runtime\n  state {\n    error\n    running\n  }\n}\n    \n\n    fragment pluginWorkflowFull on PluginWorkflow {\n  ...pluginMeta\n  name\n  workflow {\n    ...workflowMeta\n  }\n}\n    \n\n    fragment workflowMeta on Workflow {\n  __typename\n  id\n  kind\n  name\n  enabled\n  global\n  readOnly\n}\n    ";
 export declare const CreatedPluginEventDocument = "\n    subscription createdPluginEvent {\n  createdPluginEvent {\n    pluginId\n    eventArgs\n    eventName\n  }\n}\n    ";
+export declare const PluginPackageDataDocument = "\n    query pluginPackageData($id: ID!, $key: String!) {\n  pluginPackageData(id: $id, key: $key) {\n    ...pluginPackageDataFull\n  }\n}\n    \n    fragment pluginPackageDataFull on PluginPackageData {\n  key\n  value\n  flags {\n    exportable\n  }\n  package {\n    id\n  }\n}\n    ";
+export declare const DefinePluginPackageDataDocument = "\n    mutation definePluginPackageData($id: ID!, $input: DefinePluginPackageDataInput!) {\n  definePluginPackageData(id: $id, input: $input) {\n    success\n    error {\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    ";
+export declare const SetPluginPackageDataDocument = "\n    mutation setPluginPackageData($id: ID!, $key: String!, $data: JSON!) {\n  setPluginPackageData(id: $id, key: $key, data: $data) {\n    success\n    error {\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    ";
+export declare const DeletePluginPackageDataDocument = "\n    mutation deletePluginPackageData($id: ID!, $key: String!) {\n  deletePluginPackageData(id: $id, key: $key) {\n    success\n    error {\n      ... on OtherUserError {\n        ...otherUserErrorFull\n      }\n      ... on UnknownIdUserError {\n        ...unknownIdUserErrorFull\n      }\n    }\n  }\n}\n    \n    fragment otherUserErrorFull on OtherUserError {\n  ...userErrorFull\n}\n    \n\n    fragment userErrorFull on UserError {\n  __typename\n  code\n}\n    \n\n    fragment unknownIdUserErrorFull on UnknownIdUserError {\n  ...userErrorFull\n  id\n}\n    ";
+export declare const UpdatedPluginPackageDataDocument = "\n    subscription updatedPluginPackageData {\n  updatedPluginPackageData {\n    packageData {\n      ...pluginPackageDataFull\n    }\n  }\n}\n    \n    fragment pluginPackageDataFull on PluginPackageData {\n  key\n  value\n  flags {\n    exportable\n  }\n  package {\n    id\n  }\n}\n    ";
+export declare const DeletedPluginPackageDataDocument = "\n    subscription deletedPluginPackageData {\n  deletedPluginPackageData {\n    packageId\n    key\n  }\n}\n    ";
 export declare const CreatedProjectDocument = "\n    subscription createdProject {\n  createdProject {\n    project {\n      ...projectFull\n    }\n  }\n}\n    \n    fragment projectFull on Project {\n  __typename\n  id\n  name\n  path\n  version\n  status\n  temporary\n  size\n  createdAt\n  updatedAt\n  readOnly\n  backups {\n    id\n  }\n}\n    ";
 export declare const UpdatedProjectDocument = "\n    subscription updatedProject {\n  updatedProject {\n    project {\n      ...projectFull\n    }\n  }\n}\n    \n    fragment projectFull on Project {\n  __typename\n  id\n  name\n  path\n  version\n  status\n  temporary\n  size\n  createdAt\n  updatedAt\n  readOnly\n  backups {\n    id\n  }\n}\n    ";
 export declare const DeletedProjectDocument = "\n    subscription deletedProject {\n  deletedProject {\n    deletedProjectId\n  }\n}\n    ";
@@ -124503,6 +124614,12 @@ export declare function getSdk<C>(requester: Requester<C>): {
     deletedPluginPackage(variables?: DeletedPluginPackageSubscriptionVariables, options?: C): AsyncIterable<DeletedPluginPackageSubscription>;
     updatedPlugin(variables?: UpdatedPluginSubscriptionVariables, options?: C): AsyncIterable<UpdatedPluginSubscription>;
     createdPluginEvent(variables?: CreatedPluginEventSubscriptionVariables, options?: C): AsyncIterable<CreatedPluginEventSubscription>;
+    pluginPackageData(variables: PluginPackageDataQueryVariables, options?: C): Promise<PluginPackageDataQuery>;
+    definePluginPackageData(variables: DefinePluginPackageDataMutationVariables, options?: C): Promise<DefinePluginPackageDataMutation>;
+    setPluginPackageData(variables: SetPluginPackageDataMutationVariables, options?: C): Promise<SetPluginPackageDataMutation>;
+    deletePluginPackageData(variables: DeletePluginPackageDataMutationVariables, options?: C): Promise<DeletePluginPackageDataMutation>;
+    updatedPluginPackageData(variables?: UpdatedPluginPackageDataSubscriptionVariables, options?: C): AsyncIterable<UpdatedPluginPackageDataSubscription>;
+    deletedPluginPackageData(variables?: DeletedPluginPackageDataSubscriptionVariables, options?: C): AsyncIterable<DeletedPluginPackageDataSubscription>;
     createdProject(variables?: CreatedProjectSubscriptionVariables, options?: C): AsyncIterable<CreatedProjectSubscription>;
     updatedProject(variables?: UpdatedProjectSubscriptionVariables, options?: C): AsyncIterable<UpdatedProjectSubscription>;
     deletedProject(variables?: DeletedProjectSubscriptionVariables, options?: C): AsyncIterable<DeletedProjectSubscription>;

package/src/types/index.d.ts

@@ -15,6 +15,7 @@ export type { HostedFile } from "./types/files";
 export { FilterSlot, type Filter, type FilterSlotContent, type CurrentFilterChangeEvent, } from "./types/filter";
 export type { HTTPQL, StreamQL, ID, ComponentDefinition, Selection, QueryInput, } from "./types/utils";
 export type { JSONValue, JSONCompatible } from "./types/json";
+export type { KVValue, KVEvents } from "./types/kv";
 export type { SlotContent, ButtonSlotContent, CustomSlotContent, CommandSlotContent, SlotContentPropsInternal, SlotContentProps, } from "./types/slots";
 export type { RequestViewModeOptions, RequestWritableViewModeProps, RequestReadableViewModeProps, RequestReadableViewModePropsInternal, RequestWritableViewModePropsInternal, RequestViewModeProps, RequestFull, RequestDraft, RequestMeta, } from "./types/request";
 export type { ResponseViewModePropsInternal, ResponseViewModeOptions, ResponseViewModeProps, ResponseFull, } from "./types/response";
@@ -31,6 +32,7 @@ export type { SelectedProjectChangeEvent } from "./types/projects";
 export type { CommandPaletteViewProps, CommandPaletteViewPropsInternal, } from "./types/commandPalette";
 export type { CommandPaletteView } from "./sdks/commandPalette";
 export type { LogSDK } from "./sdks/log";
+export type { KVSDK, KVDefineOptions } from "./sdks/kv";
 export type { API } from "./sdks";
 export { Routes } from "./types/navigation";
 export { type GlobalContext, type PageContext } from "./types/window";

package/src/types/sdks/index.d.ts

@@ -14,6 +14,7 @@ import type { FindingsSDK } from "./findings";
 import type { FooterSDK } from "./footer";
 import type { HTTPHistorySDK } from "./httpHistory";
 import type { InterceptSDK } from "./intercept";
+import type { KVSDK } from "./kv";
 import type { LogSDK } from "./log";
 import type { MatchReplaceSDK } from "./matchReplace";
 import type { MenuSDK } from "./menu";
@@ -102,6 +103,10 @@ export type API<T extends BackendEndpoints | BackendSpec = Record<string, never>
      * Utilities to interact with frontend-plugin storage.
      */
     storage: StorageSDK;
+    /**
+     * Utilities to interact with plugin package data (key-value store).
+     */
+    kv: KVSDK;
     /**
      * Utilities to interact with the plugin's static assets.
      */

package/src/types/sdks/kv.d.ts

@@ -0,0 +1,69 @@
+import type { KVEvents, KVValue } from "../types/kv";
+import type { ListenerHandle } from "../types/utils";
+/**
+ * Options for defining a key-value pair.
+ * @category KV
+ */
+export type KVDefineOptions = {
+    /**
+     * Whether the key-value pair is exportable.
+     *
+     * Usually this should be true for keys that are settings that you would want to
+     * transfer between Caido instances.
+     *
+     * @default false
+     */
+    exportable?: boolean | undefined;
+};
+/**
+ * The SDK for the key-value store.
+ *
+ * Plugin package data shared across frontend and backend surfaces of the same
+ * plugin package. Not per-user; separate from {@link StorageSDK}.
+ *
+ * @category KV
+ */
+export type KVSDK = {
+    /**
+     * Defines a new key-value pair. Only call this once per key.
+     * If the key is not defined, it will be created at first set with default options.
+     * Defining a key alone does not notify listeners.
+     *
+     * @param key The key to define.
+     * @param options The options for the key.
+     */
+    define: (key: string, options: KVDefineOptions) => Promise<void>;
+    /**
+     * Gets a value from the key-value store.
+     *
+     * @param key The key to get.
+     * @returns The stored value (including null) or undefined if the key is not defined.
+     */
+    get: <T extends KVValue>(key: string) => Promise<T | undefined>;
+    /**
+     * Sets a value in the key-value store.
+     *
+     * @param key The key to set.
+     * @param value The value to set.
+     */
+    set: <T extends KVValue>(key: string, value: T) => Promise<void>;
+    /**
+     * Deletes a key-value pair from the key-value store.
+     *
+     * No-op if the key is not defined.
+     *
+     * @param key The key to delete.
+     */
+    del: (key: string) => Promise<void>;
+    /**
+     * Registers a callback for when a key-value pair is set.
+     *
+     * Fires for writes from any surface of the plugin package, including the
+     * local writer.
+     *
+     * @param event The event to register for.
+     * @param callback The callback to register.
+     * @returns A handle to stop listening.
+     */
+    on: <E extends keyof KVEvents>(event: E, callback: KVEvents[E]) => ListenerHandle;
+};

package/src/types/types/kv.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents any valid value for the key-value store.
+ * It needs to be serializable to JSON.
+ * @category KV
+ */
+export type KVValue = string | number | boolean | KVValue[] | null | {
+    [key: string]: KVValue;
+};
+/**
+ * Represents the events that can be emitted by the key-value store.
+ * @category KV
+ */
+export type KVEvents = {
+    set: <T extends KVValue>(key: string, value: T) => Promise<void> | void;
+    delete: (key: string) => Promise<void> | void;
+};