@veltrosecurity/sdk 0.35.4 → 0.37.4

package/README.md

@@ -1,7 +1,7 @@
 # @veltrosecurity/sdk
 
 TypeScript client for the [Veltro](https://github.com/veltrosecurity/veltro)
-security operations suite: **VectorFlow** (telemetry pipelines), **CHAD**
+security operations suite: **VectorFlow** (telemetry pipelines), **Sigmatic**
 (detection) and **Warden** (SOAR / cases).
 
 - No runtime dependencies — the transport is `fetch` (Node ≥ 22, Bun, Deno,
@@ -29,10 +29,12 @@ const cases = await suite.warden.cases.list({ params: { limit: 25, status: "open
 const pipelines = await suite.vectorflow.pipelines.list();
 ```
 
-The gateway serves CHAD at `/chad`, Warden at `/warden` and VectorFlow at
+The gateway serves Sigmatic at `/sigmatic`, Warden at `/warden` and VectorFlow at
 `/vectorflow`, and exchanges the identity session cookie for a short-lived
 request assertion toward each product — one login reaches all three.
 
+The published SDK still uses `ChadClient` and `suite.chad` for Sigmatic.
+
 VectorFlow's REST v1 accepts **only** an environment-scoped service-account key;
 a suite client built without one throws `MissingCredentialError` at the call
 site instead of sending a credential VectorFlow will reject.
@@ -41,13 +43,13 @@ site instead of sending a credential VectorFlow will reject.
 
 Create a personal access token (`vmcp_…`) in the suite and send it as a bearer
 to the product's gateway prefix. Identity turns it into the request assertion
-the product checks, so the same token works for CHAD and Warden:
+the product checks, so the same token works for Sigmatic and Warden:
 
 ```ts
 import { ChadClient, WardenClient, BearerToken } from "@veltrosecurity/sdk";
 
-const chad = new ChadClient("https://soc.example.com/chad", { auth: new BearerToken(pat) });
-await chad.rules.list();
+const sigmatic = new ChadClient("https://soc.example.com/sigmatic", { auth: new BearerToken(pat) });
+await sigmatic.rules.list();
 
 const warden = new WardenClient("https://soc.example.com/warden", {
   auth: new BearerToken(pat),
@@ -60,7 +62,7 @@ VectorFlow's `/api/v1` still wants its service-account key, so pass
 
 ## Example
 
-[`examples/triage.ts`](examples/triage.ts) lists open Warden cases and new critical or high CHAD alerts
+[`examples/triage.ts`](examples/triage.ts) lists open Warden cases and new critical or high Sigmatic alerts
 with a personal access token from `VELTRO_TOKEN`. It's read-only and isn't
 part of the published package.
 
@@ -113,7 +115,7 @@ attributes the identity authority set are all honoured.
 
 | Product | Resources | Operations | Generated from |
 | --- | --- | --- | --- |
-| CHAD | 52 | 365 | CHAD 0.43.2 OpenAPI |
+| Sigmatic | 52 | 365 | CHAD 0.43.2 OpenAPI |
 | Warden | 27 | 123 | Warden 0.11.7 OpenAPI |
 | VectorFlow | 9 | 41 | VectorFlow REST API 2.0.0 |
 

package/dist/index.cjs

@@ -31,6 +31,7 @@ __export(index_exports, {
   Resource: () => Resource,
   SESSION_COOKIE_PREFIX: () => SESSION_COOKIE_PREFIX,
   SUITE_PREFIXES: () => SUITE_PREFIXES,
+  SigmaticClient: () => SigmaticClient,
   SuiteSession: () => SuiteSession,
   Transport: () => Transport,
   VERSION: () => VERSION,
@@ -53,7 +54,7 @@ var DEFAULT_MAX_RESPONSE_BYTES = 32 * 1024 * 1024;
 var DEFAULT_RETRIES = 2;
 var RETRY_STATUSES = /* @__PURE__ */ new Set([429, 502, 503, 504]);
 var RETRY_METHODS = /* @__PURE__ */ new Set(["GET", "HEAD", "OPTIONS", "PUT", "DELETE"]);
-var USER_AGENT = "veltro-sdk/0.35.4 (+https://github.com/veltrosecurity/veltro)";
+var USER_AGENT = "veltro-sdk/0.37.4 (+https://github.com/veltrosecurity/veltro)";
 var VeltroError = class extends Error {
   constructor(message) {
     super(message);
@@ -1340,6 +1341,10 @@ var ChadHealth = class extends Resource {
   listIndex(options = {}) {
     return this.request("GET", "/api/health/indices", options);
   }
+  /** GET /api/health/ready — Strict dependency readiness. */
+  readiness(options = {}) {
+    return this.request("GET", "/api/health/ready", options);
+  }
   /** POST /api/health/test/{service_type} — Test Service Health. */
   testService(serviceType, options = {}) {
     return this.request("POST", `/api/health/test/${quoteSegment(serviceType)}`, options);
@@ -2872,9 +2877,9 @@ var WardenDiagnostics = class extends Resource {
   }
 };
 var WardenEvents = class extends Resource {
-  /** POST /api/events/chad — Accept one CHAD alert-delivery envelope. */
-  chad(options = {}) {
-    return this.request("POST", "/api/events/chad", options);
+  /** POST /api/events/sigmatic — Accept one Sigmatic alert-delivery envelope. */
+  sigmatic(options = {}) {
+    return this.request("POST", "/api/events/sigmatic", options);
   }
 };
 var WardenIntakeRules = class extends Resource {
@@ -3419,6 +3424,7 @@ var WardenResources = class {
 // src/client.ts
 var SUITE_PREFIXES = {
   chad: "/chad",
+  sigmatic: "/sigmatic",
   warden: "/warden",
   vectorflow: "/vectorflow"
 };
@@ -3442,6 +3448,8 @@ var ChadClient = class extends ChadResources {
     this.baseUrl = transport.baseUrl;
   }
 };
+var SigmaticClient = class extends ChadClient {
+};
 var WardenClient = class extends WardenResources {
   baseUrl;
   constructor(baseUrl, options = {}) {
@@ -3487,6 +3495,7 @@ var VeltroClient = class _VeltroClient {
   baseUrl;
   session;
   chad;
+  sigmatic;
   warden;
   vectorflow;
   constructor(baseUrl, options = {}) {
@@ -3494,6 +3503,7 @@ var VeltroClient = class _VeltroClient {
     this.baseUrl = baseUrl.replace(/\/+$/, "");
     this.session = options.session;
     const chadAuth = options.chadAuth ?? options.session;
+    const sigmaticAuth = options.sigmaticAuth ?? options.session;
     const wardenAuth = options.wardenAuth ?? options.session;
     const vectorflowAuth = options.vectorflowAuth ?? (options.vectorflowKey ? new BearerToken(options.vectorflowKey) : void 0);
     const shared = {
@@ -3508,6 +3518,13 @@ var VeltroClient = class _VeltroClient {
       "chad",
       "no credential: pass a suite session (VeltroClient.login) or chadAuth: new BearerToken(<personal access token>)"
     );
+    this.sigmatic = sigmaticAuth ? new SigmaticClient(`${this.baseUrl}${SUITE_PREFIXES.sigmatic}`, {
+      auth: sigmaticAuth,
+      ...shared
+    }) : unavailable(
+      "sigmatic",
+      "no credential: pass a suite session (VeltroClient.login) or sigmaticAuth: new BearerToken(<personal access token>)"
+    );
     this.warden = wardenAuth ? new WardenClient(`${this.baseUrl}${SUITE_PREFIXES.warden}`, {
       auth: wardenAuth,
       ...shared
@@ -3535,7 +3552,7 @@ var VeltroClient = class _VeltroClient {
 };
 
 // src/index.ts
-var VERSION = "0.35.4";
+var VERSION = "0.37.4";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BearerToken,
@@ -3549,6 +3566,7 @@ var VERSION = "0.35.4";
   Resource,
   SESSION_COOKIE_PREFIX,
   SUITE_PREFIXES,
+  SigmaticClient,
   SuiteSession,
   Transport,
   VERSION,