Add categories

package.json

@@ -4,7 +4,7 @@
   "devDependencies": {
     "typescript": "5.6.2",
     "typedoc": "0.26.7",
-    "typedoc-plugin-markdown": "4.2.8",
+    "typedoc-plugin-markdown": "4.2.9",
     "typedoc-plugin-missing-exports": "3.0.0"
   }
 }

packages/sdk-backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-backend",
-  "version": "0.41.1-beta.0",
+  "version": "0.41.1-beta.1",
   "description": "Typing for the Caido Backend SDK",
   "author": "Caido Labs Inc. <[email protected]>",
   "license": "MIT",
@@ -12,7 +12,7 @@
     "documentation": "typedoc"
   },
   "dependencies": {
-    "@caido/quickjs-types": "0.8.1",
-    "@caido/sdk-shared": "0.1.0"
+    "@caido/quickjs-types": "0.8.2",
+    "@caido/sdk-shared": "0.1.1"
   }
 }

packages/sdk-backend/src/typing.d.ts

@@ -6,10 +6,12 @@ declare module "caido:plugin" {
     RequestsSDK,
     Request,
     Response,
+    ReplaySDK,
   } from "caido:utils";
 
   /**
    * The SDK for the API RPC service.
+   * @category APISDK
    */
   export type APISDK<API = {}, Events = {}> = {
     /**
@@ -36,6 +38,7 @@ declare module "caido:plugin" {
 
   /**
    * The SDK for the API RPC service.
+   * @category EventsSDK
    */
   export type EventsSDK<API = {}, Events = {}> = {
     /**
@@ -73,6 +76,7 @@ declare module "caido:plugin" {
 
   /**
    * The SDK for metadata information about the plugin.
+   * @category MetaSDK
    */
   export type MetaSDK = {
     /**
@@ -89,6 +93,7 @@ declare module "caido:plugin" {
 
   /**
    * The SDK object available to all scripts.
+   * @category SDK
    */
   export interface SDK<API = {}, Events = {}> {
     /**
@@ -102,9 +107,13 @@ declare module "caido:plugin" {
      */
     findings: FindingsSDK;
     /**
-     * The SDK for the Requests services
+     * The SDK for the Requests service.
      */
     requests: RequestsSDK;
+    /**
+     * The SDK for the Replay service.
+     */
+    replay: ReplaySDK;
     /**
      * The SDK for the API RPC service.
      */

packages/sdk-backend/typedoc.json

@@ -1,4 +1,16 @@
 {
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/typing.d.ts"]
+  "entryPoints": ["src/typing.d.ts"],
+  "externalPattern": ["**/node_modules/typescript/**"],
+  "categoryOrder": [
+    "SDK",
+    "MetaSDK",
+    "APISDK",
+    "EventsSDK",
+    "RequestsSDK",
+    "FindingsSDK",
+    "ReplaySDK",
+    "Shared",
+    "*"
+  ]
 }

packages/sdk-frontend/typedoc.json

@@ -1,5 +1,5 @@
 {
   "extends": ["../../typedoc.base.json"],
   "entryPoints": ["src/index.d.ts"],
-  "excludeExternals": true
+  "exclude": ["src/types/__generated__/graphql-sdk.d.ts"]
 }

packages/sdk-workflow/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caido/sdk-workflow",
-  "version": "0.41.1-beta.0",
+  "version": "0.41.1-beta.1",
   "description": "Typing for the Caido Workflow SDK",
   "author": "Caido Labs Inc. <[email protected]>",
   "license": "MIT",
@@ -12,6 +12,6 @@
     "documentation": "typedoc"
   },
   "dependencies": {
-    "@caido/quickjs-types": "0.8.1"
+    "@caido/quickjs-types": "0.8.2"
   }
 }

packages/sdk-workflow/src/typing.d.ts

@@ -5,27 +5,47 @@ declare module "caido:workflow" {
     RequestsSDK,
     Request,
     Response,
+    ReplaySDK,
   } from "caido:utils";
 
+  /**
+   * The input for the HTTP Javascript Nodes
+   * @category Data
+   */
   export type HttpInput = {
     request: Request | undefined;
     response: Response | undefined;
   };
   /**
    * @deprecated Use HttpInput instead.
+   * @category Data
    */
   export type PassiveInput = HttpInput;
+  /**
+   * The input for the Javascript Nodes.
+   * @category Data
+   */
   export type BytesInput = Array<number>;
   /**
    * @deprecated Use BytesInput instead.
+   * @category Data
    */
   export type ConvertInput = BytesInput;
 
+  /**
+   * The output for the Javascript Nodes.
+   * @category Data
+   */
   export type Data = Bytes;
+  /**
+   * The output for the If/Else Javascript Nodes.
+   * @category Data
+   */
   export type Decision = boolean;
 
   /**
    * The SDK object available to all scripts.
+   * @category SDK
    */
   export type SDK = {
     /**
@@ -39,9 +59,13 @@ declare module "caido:workflow" {
      */
     findings: FindingsSDK;
     /**
-     * The SDK for the Requests services
+     * The SDK for the Requests service.
      */
     requests: RequestsSDK;
+    /**
+     * The SDK for the Replay service.
+     */
+    replay: ReplaySDK;
     /**
      * Converts bytes to a string.
      *

packages/sdk-workflow/typedoc.json

@@ -1,4 +1,14 @@
 {
   "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/typing.d.ts"]
+  "entryPoints": ["src/typing.d.ts"],
+  "externalPattern": ["**/node_modules/typescript/**"],
+  "categoryOrder": [
+    "SDK",
+    "Data",
+    "RequestsSDK",
+    "FindingsSDK",
+    "ReplaySDK",
+    "Shared",
+    "*"
+  ]
 }

typedoc.base.json

@@ -5,12 +5,14 @@
     "./scripts/documentation.mjs"
   ],
   "cleanOutputDir": true,
-  "outputFileStrategy": "members",
+  "outputFileStrategy": "modules",
   "entryFileName": "index",
   "readme": "none",
   "disableSources": true,
+  "excludeExternals": true,
   "placeInternalsInOwningModule": true,
   "hidePageHeader": true,
+  "expandParameters": true,
   "parametersFormat": "table",
   "indexFormat": "table"
 }