@caido/sdk-workflow 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Caido Labs Inc.
+
+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,47 @@
+<div align="center">
+  <img width="1000" alt="image" src="https://user-images.githubusercontent.com/6225588/211916659-567751d1-0225-402b-9141-4145c18b0834.png">
+
+  <br />
+  <br />
+  <a href="https://caido.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://dashboard.caido.io/">Dashboard</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://docs.caido.io/" target="_blank">Docs</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://links.caido.io/roadmap">Roadmap</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://github.com/caido/caido/tree/main/brand">Branding</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://links.caido.io/www-discord" target="_blank">Discord</a>
+  <br />
+  <hr />
+</div>
+
+## 👋 Frontend SDK
+
+[![NPM Version](https://img.shields.io/npm/v/@caido/sdk-workflow?style=for-the-badge)](https://www.npmjs.com/package/@caido/sdk-workflow)
+
+This is repository for the Caido workflow SDK.
+
+You usually don't need to use this package directly since typing is already included in the runtime.
+
+But this can be useful if you want to write to code externally in Typescript and built it to JS.
+
+```typescript
+import { PassiveInput, SDK, Data } from "./typing";
+
+export async function run(
+  input: PassiveInput,
+  sdk: SDK,
+): Promise<Data | undefined> {
+  if (input.request) {
+    sdk.console.log(input.request.getMethod());
+  }
+  return;
+}
+```
+
+## 💚 Community
+
+Come join our [Discord](https://links.caido.io/www-discord) community and connect with other Caido users! We'd love to have you as part of the conversation and help with any questions you may have.

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@caido/sdk-workflow",
+  "version": "0.0.1",
+  "description": "Typing for the Caido Workflow SDK",
+  "author": "Caido Labs Inc. <dev@caido.io>",
+  "license": "MIT",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/*"
+  ]
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./typing";

package/src/typing.d.ts

@@ -0,0 +1,199 @@
+/**
+ * Console interface for logging.
+ *
+ * Currently logs are only available in the backend logs.
+ * See https://docs.caido.io/report_bug.html#1-backend-logs
+ */
+export declare type Console = {
+  debug(message: any): void;
+  log(message: any): void;
+  warn(message: any): void;
+  error(message: any): void;
+};
+
+/**
+ * The body of a Request or Response.
+ *
+ * Calling `to<FORMAT>` will try to convert the body to the desired format.
+ */
+export declare class Body {
+  /**
+   * Parse the body as a string.
+   *
+   * Unprintable characters will be replaced with `�`.
+   */
+  toText(): string;
+  /**
+   * Try to parse the body as JSON.
+   *
+   * @throws {SyntaxError} If the body is not valid JSON.
+   */
+  toJson(): any;
+  /**
+   * Get the raw body as an array of bytes.
+   */
+  toRaw(): Uint8Array;
+}
+
+/**
+ * A saved immutable Request.
+ *
+ * To modify, use `toSpec` to get a `RequestSpec` object.
+ */
+export declare type Request = {
+  getId(): ID;
+  getHost(): string;
+  getPort(): number;
+  getTls(): boolean;
+  getMethod(): string;
+  getPath(): string;
+  getQuery(): string;
+  getHeader(name: string): Array<string> | undefined;
+  getBody(): Body | undefined;
+  toSpec(): RequestSpec;
+};
+
+/**
+ * A mutable Request not yet sent.
+ */
+export declare class RequestSpec {
+  getHost(): string;
+  setHost(host: string): void;
+  getPort(): number;
+  setPort(port: number): void;
+  getTls(): boolean;
+  setTls(tls: boolean): void;
+  getMethod(): string;
+  setMethod(method: string): void;
+  getPath(): string;
+  setPath(path: string): void;
+  getQuery(): string;
+  setQuery(query: string): void;
+  getHeader(name: string): Array<string> | undefined;
+  setHeader(name: string, value: string): void;
+  getBody(): Body | undefined;
+  setBody(body: Body | Bytes): void;
+}
+
+/**
+ * An immutable saved Response.
+ */
+export declare type Response = {
+  getId(): ID;
+  getCode(): number;
+  getHeader(name: string): Array<string> | undefined;
+  getBody(): Body | undefined;
+};
+
+/**
+ * An immutable saved Request and Response pair.
+ */
+export declare type RequestReponse = {
+  request: Request;
+  response: Response;
+};
+
+/**
+ * The SDK for the Requests service.
+ */
+export declare type RequestsSDK = {
+  /**
+   * Sends a request.
+   *
+   * This respects the upstream proxy settings.
+   *
+   * @throws {Error} If the request cannot be sent.
+   *
+   * @example
+   * const spec = new RequestSpec("https://example.com");
+   * sdk.send(request)
+   *   .then((res) => {
+   *     console.log(res.request.getId());
+   *     console.log(res.response.getCode());
+   *   })
+   *   .catch((err) => {
+   *     console.error(err);
+   *   });
+   */
+  send(request: RequestSpec): Promise<RequestReponse>;
+};
+
+/**
+ * A saved immutable Finding.
+ *
+ * To modify, use `toSpec` to get a `FindingSpec` object.
+ */
+export declare type Finding = {
+  getId(): ID;
+  getTitle(): string;
+  getDescription(): string | undefined;
+  getReporter(): string;
+};
+
+/**
+ * A mutable Finding not yet created.
+ */
+export declare type FindingSpec = {
+  title: string;
+  description?: string | undefined;
+  reporter: string;
+  request: Request;
+};
+
+/**
+ * The SDK for the Findings service.
+ */
+export declare type FindingsSDK = {
+  /**
+   * Creates a new Finding.
+   *
+   * @throws {Error} If the request cannot be saved.
+   *
+   * @example
+   * sdk.findings.create({
+   *   title: "Title",
+   *   description: "Description",
+   *   reporter: "Reporter",
+   *   request,
+   * });
+   */
+  create(spec: FindingSpec): Promise<Finding>;
+};
+
+export declare type PassiveInput = {
+  request: Request | undefined;
+  response: Response | undefined;
+};
+export declare type ConvertInput = Array<number>;
+
+export declare type ID = string;
+export declare type Data = Bytes;
+export declare type Decision = boolean;
+export declare type Bytes = string | Array<number> | Uint8Array;
+export declare type MaybePromise<T> = T | Promise<T>;
+
+/**
+ * The SDK object available to all scripts.
+ */
+export declare type SDK = {
+  /**
+   * The console.
+   *
+   * This is currently the same as the global `console`.
+   */
+  console: Console;
+  /**
+   * The SDK for the Findings service.
+   */
+  findings: FindingsSDK;
+  /**
+   * The SDK for the Requests services
+   */
+  requests: RequestsSDK;
+  /**
+   * Converts bytes to a string.
+   *
+   * Unprintable characters will be replaced with `�`.
+   */
+  asString(array: Bytes): string;
+};