@caido/sdk-frontend 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Caido
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# sdk-frontend
+SDK definition for the Caido Frontend

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@caido/sdk-frontend",
+  "version": "0.0.1",
+  "description": "Typing for the Caido Frontend SDK",
+  "author": "Caido Labs Inc. <dev@caido.io>",
+  "license": "MIT",
+  "types": "./src/index.d.ts",
+  "main": "./src/index.js",
+  "module": "./src/index.js",
+  "scripts": {
+    "publish": "npm publish --access public"
+  },
+  "files": [
+    "src/*"
+  ]
+}

package/src/index.d.ts

@@ -0,0 +1,11 @@
+import { API } from "./types";
+
+declare global {
+  interface Window {
+    Caido: API;
+  }
+}
+
+declare const Caido: API;
+
+export { Caido };

package/src/index.js

@@ -0,0 +1 @@
+export const Caido = window.Caido;

package/src/types/commands.d.ts

@@ -0,0 +1,28 @@
+export type Commands = {
+  register: (id: string, options: CommandOptions) => void;
+};
+
+type CommandOptions = {
+  name: string;
+  run: (context: CommandContext) => void;
+  group?: string;
+  when?: (context: CommandContext) => boolean;
+};
+
+type CommandContextBase = {
+  type: "BaseContext";
+};
+
+type CommandContextRequestRow = {
+  type: "RequestRowContext";
+  request: {
+    id: string;
+    host: string;
+    port: number;
+    path: string;
+    query: string;
+    isTls: boolean;
+  };
+};
+
+export type CommandContext = CommandContextBase | CommandContextRequestRow;

package/src/types/index.d.ts

@@ -0,0 +1,49 @@
+import type { Commands } from "./commands";
+import type { Menu } from "./menu";
+import type { Scopes } from "./scopes";
+import type { UI } from "./ui";
+
+export type { CommandContext } from "./commands";
+
+export type API = {
+  ui: UI;
+  scopes: Scopes;
+  commands: Commands;
+  menu: Menu;
+
+  navigation: {
+    goTo: (path: string) => void;
+    addPage: (path: string, options: PageOptions) => void;
+  };
+
+  shortcuts: {
+    register: (commandId: string, keys: string[]) => void;
+  };
+
+  commandPalette: {
+    register: (commandId: string) => void;
+  };
+
+  sidebar: {
+    registerItem: (
+      name: string,
+      path: string,
+      options?: SidebarItemOptions
+    ) => SidebarItem;
+  };
+};
+
+type PageOptions = {
+  body: HTMLElement;
+  topbar?: HTMLElement;
+};
+
+type SidebarItemOptions = {
+  icon?: string;
+  group?: string;
+  isExternal?: boolean;
+};
+
+type SidebarItem = {
+  setCount: (count: number) => void;
+};

package/src/types/menu.d.ts

@@ -0,0 +1,13 @@
+type MenuId = "RequestRow";
+
+export type Menu = {
+  registerItem: (
+    menuId: MenuId,
+    commandId: string,
+    options?: MenuOptions,
+  ) => void;
+};
+
+type MenuOptions = {
+  leadingIcon?: string;
+};

package/src/types/scopes.d.ts

@@ -0,0 +1,28 @@
+export type Scopes = {
+  getScopes: () => Scope[];
+  createScope: (options: CreateScopeOptions) => Promise<Scope | undefined>;
+  updateScope: (
+    id: string,
+    options: UpdateScopeOptions,
+  ) => Promise<Scope | undefined>;
+  deleteScope: (id: string) => Promise<boolean>;
+};
+
+type Scope = {
+  id: string;
+  name: string;
+  allowlist: string[];
+  denylist: string[];
+};
+
+type CreateScopeOptions = {
+  name: string;
+  allowlist: string[];
+  denylist: string[];
+};
+
+type UpdateScopeOptions = {
+  name?: string;
+  allowlist?: string[];
+  denylist?: string[];
+};

package/src/types/ui.d.ts

@@ -0,0 +1,25 @@
+export type UI = {
+  button: (options?: ButtonOptions) => HTMLElement;
+  card: (options?: CardOptions) => HTMLElement;
+  well: (options?: WellOptions) => HTMLElement;
+};
+
+type ButtonOptions = {
+  variant?: "primary" | "secondary" | "tertiary";
+  label?: string;
+  leadingIcon?: string;
+  trailingIcon?: string;
+  size?: "small" | "medium" | "large";
+};
+
+type CardOptions = {
+  header?: HTMLElement;
+  body?: HTMLElement;
+  footer?: HTMLElement;
+};
+
+type WellOptions = {
+  header?: HTMLElement;
+  body?: HTMLElement;
+  footer?: HTMLElement;
+};