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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-frontend",
-  "version": "0.56.1-beta.0",
+  "version": "0.56.1-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/sdks/backend.d.ts

@@ -1,11 +1,17 @@
-import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import { type BackendEndpoints, type BackendEvents, type BackendSpec } from "../types/backend";
 import type { PromisifiedReturnType } from "../types/utils";
+type ResolvedAPI<T> = T extends {
+    api: infer A;
+} ? A : T;
+type ResolvedEvents<T, E> = T extends {
+    events: infer A;
+} ? A : E;
 /**
  * Utilities to interact with the backend plugin.
  * @category Backend
  */
-export type BackendSDK<T extends BackendEndpoints, E extends BackendEvents> = {
-    [K in keyof T]: (...args: Parameters<T[K]>) => PromisifiedReturnType<T[K]>;
+export type BackendSDK<T extends BackendEndpoints | BackendSpec, E extends BackendEvents> = {
+    [K in keyof ResolvedAPI<T>]: (...args: Parameters<ResolvedAPI<T>[K]>) => PromisifiedReturnType<ResolvedAPI<T>[K]>;
 } & {
     /**
      * Subscribe to a backend event.
@@ -13,7 +19,8 @@ export type BackendSDK<T extends BackendEndpoints, E extends BackendEvents> = {
      * @param callback The callback to call when the event is emitted.
      * @returns An object with a `stop` method that can be called to stop listening to the event.
      */
-    onEvent: <K extends keyof E>(event: K, callback: E[K]) => {
+    onEvent: <K extends keyof ResolvedEvents<T, E>>(event: K, callback: ResolvedEvents<T, E>[K]) => {
         stop: () => void;
     };
 };
+export {};

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

@@ -1,6 +1,6 @@
 import type { Sdk as GraphqlSDK } from "../__generated__/graphql-sdk";
 import type { _AnalyticsSDK } from "../private/analytics";
-import { type BackendEndpoints, type BackendEvents } from "../types/backend";
+import { type BackendEndpoints, type BackendEvents, type BackendSpec } from "../types/backend";
 import type { AiSDK } from "./ai";
 import type { AssetsSDK } from "./assets";
 import type { AutomateSDK } from "./automate";
@@ -36,7 +36,7 @@ import type { WorkflowSDK } from "./workflows";
  * Utilities for frontend plugins.
  * @category SDK
  */
-export type API<T extends BackendEndpoints = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
+export type API<T extends BackendEndpoints | BackendSpec = Record<string, never>, E extends BackendEvents = Record<string, never>> = {
     /**
      * Utilities to interact with the GraphQL API.
      */

package/src/types/types/backend.d.ts

@@ -12,3 +12,11 @@ export type BackendEndpoints = {
 export type BackendEvents = {
     [key: string]: (...args: any[]) => void;
 };
+/**
+ * A specification for the backend plugin.
+ * @category Backend
+ */
+export type BackendSpec = {
+    api: BackendEndpoints;
+    events: BackendEvents;
+};