@theholocron/sentry-client 1.58.0-alpha.3 → 1.58.0-alpha.8

package/dist/index.d.mts

@@ -1,6 +1,8 @@
 import "@theholocron/http-client";
 import { ErrorSink, Logger } from "@theholocron/observability/core";
+/** Options for `createSentryClient()` and `createSentryRestClient()`. */
 interface SentryClientOptions {
+  /** Sentry auth token. */
   token: string;
   /** Override base URL for testing. Defaults to https://sentry.io/api/0 */
   baseUrl?: string;
@@ -11,32 +13,53 @@ interface SentryClientOptions {
   /** Reports transport failures and unexpected 5xx. Defaults to a no-op. */
   errors?: ErrorSink;
 }
+/** A Sentry organization. */
 interface SentryOrganization {
+  /** The organization id. */
   id: string;
+  /** The organization slug used in API paths. */
   slug: string;
+  /** The organization's display name. */
   name: string;
 }
+/** A Sentry project. */
 interface SentryProject {
+  /** The project id. */
   id: string;
+  /** The project slug used in API paths. */
   slug: string;
+  /** The project's display name. */
   name: string;
+  /** The platform identifier, or `null` when none is set. */
   platform: string | null;
 }
+/** The DSN URLs of a client key. */
 interface SentryKeyDsn {
+  /** The DSN to give an SDK; it carries only the public key. */
   public: string;
+  /** The DSN that includes the secret key. */
   secret: string;
   /** Content Security Policy endpoint. */
   csp: string;
 }
+/** A client key (DSN) of a project. */
 interface SentryKey {
+  /** The key id. */
   id: string;
+  /** The key's label. */
   label: string;
+  /** The public key. */
   public: string;
+  /** The secret key. */
   secret: string;
+  /** The DSN URLs built from the key. */
   dsn: SentryKeyDsn;
 }
+/** Input for `projects.create()`. */
 interface CreateSentryProjectInput {
+  /** The project name. */
   name: string;
+  /** The platform identifier, e.g. `node`; omitted, none is sent. */
   platform?: string;
 }
 /**
@@ -44,64 +67,102 @@ interface CreateSentryProjectInput {
  * integration has, so it is absent for a token with fewer. It signs the webhooks Sentry sends to `webhookUrl`.
  */
 interface SentryApp {
+  /** The integration's name. */
   name: string;
+  /** The integration's slug. */
   slug: string;
+  /** The integration's UUID. */
   uuid: string;
+  /** The integration's status as Sentry reports it. */
   status: string;
+  /** The scopes the integration holds. */
   scopes: string[];
+  /** Where Sentry sends webhooks, or `null` for none. */
   webhookUrl: string | null;
+  /** Whether the integration is offered as an action in alert rules. */
   isAlertable: boolean;
+  /** The OAuth client id; present only when the token may see it. */
   clientId?: string;
+  /** The secret that signs webhooks; present only when the token may see it. */
   clientSecret?: string;
 }
+/** Input for `sentryApps.create()` and `sentryApps.update()`. */
 interface SentryAppInput {
+  /** The integration's name. */
   name: string;
   /** What the integration may read or write, e.g. `event:read`. The token making the call must hold each. */
   scopes: string[];
+  /** Where Sentry sends webhooks; `null` or omitted for none. */
   webhookUrl?: string | null;
   /** Offer the integration as an action in alert rules. */
   isAlertable?: boolean;
 }
 /** An integration installed on the organization. For an internal one this happens when it is created. */
 interface SentryAppInstallation {
+  /** The installation's UUID. */
   uuid: string;
+  /** The installation's status as Sentry reports it. */
   status: string;
+  /** The installed integration. */
   app: {
+    /** The integration's UUID. */
     uuid: string;
+    /** The integration's slug. */
     slug: string;
+    /** The numeric integration id that alert actions point at. */
     sentryAppId: number;
   };
 }
+/** A condition of a workflow trigger or action filter. */
 interface SentryWorkflowCondition {
+  /** The condition type. */
   type: string;
+  /** What the condition compares against; its shape depends on `type`. */
   comparison: unknown;
+  /** The result the condition produces when it holds; its shape depends on `type`. */
   conditionResult: unknown;
 }
+/** An action a workflow runs, such as notifying a channel. */
 interface SentryWorkflowAction {
+  /** The action type. */
   type: string;
+  /** The action's settings; their shape depends on `type`. */
   config: Record<string, unknown>;
+  /** Extra data for the action; its shape depends on `type`. */
   data: Record<string, unknown>;
 }
+/** A group of conditions with the actions to run when they hold. */
 interface SentryWorkflowActionFilter {
+  /** How `conditions` combine. */
   logicType: string;
+  /** The conditions to test. */
   conditions: SentryWorkflowCondition[];
+  /** The actions to run. */
   actions: SentryWorkflowAction[];
 }
 /** What a workflow (an alert rule in Sentry's Monitors → Alerts) is made of, as sent when creating or updating one. */
 interface SentryWorkflowInput {
+  /** The workflow's name. */
   name: string;
+  /** Whether the workflow is active. */
   enabled: boolean;
+  /** The environment it is limited to, or `null` for all. */
   environment: string | null;
   /** `frequency` is minutes between notifications for one issue. */
   config: {
+    /** Minutes between notifications for one issue. */
     frequency: number;
   };
   /** The detectors it is attached to; an issue stream detector per project covers that project's issues. */
   detectorIds: string[];
+  /** The conditions that start the workflow. */
   triggers: {
+    /** How `conditions` combine. */
     logicType: string;
+    /** The conditions to test. */
     conditions: SentryWorkflowCondition[];
   };
+  /** The condition groups with the actions each runs. */
   actionFilters: SentryWorkflowActionFilter[];
 }
 /** A condition or action as a read returns it: the same shape, with the id Sentry gave it. */
@@ -112,12 +173,17 @@ type SentryWorkflowActionRead = SentryWorkflowAction & {
   id?: string;
 };
 interface SentryWorkflow extends SentryWorkflowInput {
+  /** The workflow id. */
   id: string;
   triggers: {
+    /** The id Sentry gave the trigger group. */
     id?: string;
+    /** How `conditions` combine. */
     logicType: string;
+    /** The trigger conditions, with the ids Sentry gave them. */
     conditions: SentryWorkflowConditionRead[];
   };
+  /** The condition groups with the actions each runs, with the ids Sentry gave them. */
   actionFilters: Array<{
     id?: string;
     logicType: string;
@@ -125,15 +191,20 @@ interface SentryWorkflow extends SentryWorkflowInput {
     actions: SentryWorkflowActionRead[];
   }>;
 }
+/** A detector: what a workflow is attached to. */
 interface SentryDetector {
+  /** The detector id. */
   id: string;
   /** Null for an "all projects" detector. */
   projectId: string | null;
+  /** The detector's name. */
   name: string;
   /** `issue_stream` receives every issue of its project; `error` is the error monitor. */
   type: string;
+  /** The ids of the workflows attached to it. */
   workflowIds: string[];
 }
+/** Create a Sentry client with `auth`, `projects`, `sentryApps` and `workflows` groups, all sharing one REST client built from `opts`. */
 export declare function createSentryClient(opts: SentryClientOptions): {
   auth: {
     organizations: () => Promise<SentryOrganization[]>;
@@ -161,5 +232,6 @@ export declare function createSentryClient(opts: SentryClientOptions): {
     detectors: (org: string) => Promise<SentryDetector[]>;
   };
 };
+/** The client `createSentryClient()` returns. */
 export type SentryClient = ReturnType<typeof createSentryClient>;
 export type { CreateSentryProjectInput, SentryApp, SentryAppInput, SentryAppInstallation, SentryClientOptions, SentryDetector, SentryKey, SentryKeyDsn, SentryOrganization, SentryProject, SentryWorkflow, SentryWorkflowAction, SentryWorkflowActionFilter, SentryWorkflowCondition, SentryWorkflowInput };

package/dist/index.mjs

@@ -111,6 +111,7 @@ function workflows(rest) {
 	};
 }
 // src/index.ts
+/** Create a Sentry client with `auth`, `projects`, `sentryApps` and `workflows` groups, all sharing one REST client built from `opts`. */
 function createSentryClient(opts) {
 	const rest = createSentryRestClient(opts);
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/sentry-client",
-  "version": "1.58.0-alpha.3",
+  "version": "1.58.0-alpha.8",
   "description": "A TypeScript client for the Sentry management API",
   "keywords": [
     "sentry",
@@ -32,23 +32,23 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/observability": "^0.6.1-alpha.1",
-    "@theholocron/http-client": "^1.58.0-alpha.3"
+    "@theholocron/observability": "^0.7.0-alpha.1",
+    "@theholocron/http-client": "^1.58.0-alpha.8"
   },
   "devDependencies": {
     "@types/node": "^26",
     "@vitest/coverage-v8": "^5.0.5",
-    "@vitest/eslint-plugin": "^1.6.27",
-    "eslint": "^10.8.1",
-    "eslint-plugin-n": "^18.3.0",
-    "globals": "^17.11.0",
-    "tsdown": "^0.23.3",
+    "@vitest/eslint-plugin": "^1.6.28",
+    "eslint": "^10.14.0",
+    "eslint-plugin-n": "^18.5.0",
+    "globals": "^17.14.0",
+    "tsdown": "^0.23.4",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3"
+    "@theholocron/eslint-config": "^8.9.0-alpha.8",
+    "@theholocron/tsconfig": "^8.9.0-alpha.8",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.8",
+    "@theholocron/vitest-config": "^8.9.0-alpha.8"
   },
   "engines": {
     "node": ">=22.0.0"
@@ -57,10 +57,10 @@
     "access": "public"
   },
   "scripts": {
-    "delivery.build": "tsdown && node ../scripts/check-bundle-size.mjs",
-    "sourceQuality.staticAnalysis": "eslint .",
+    "build": "tsdown && node ../scripts/check-bundle-size.mjs",
+    "lint:code": "eslint .",
+    "test:unit": "vitest run --coverage",
     "test:watch": "vitest",
-    "verification.typeSafety": "tsc --noEmit",
-    "verification.unitTests": "vitest run"
+    "typecheck": "tsc --noEmit"
   }
 }