@theholocron/holocron-plugin-sentry 5.0.0-alpha.277 → 5.0.0-alpha.279

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { AuthError, EnsureRelayInput, EnsureRelayResult, Errors, InspectRelayInput, PluginToken, RelayState, ResolveTokenInput, VerifyTokenFailure, VerifyTokenResult, VerifyTokenResult as VerifyTokenResult$1, VerifyTokenSuccess } from "@theholocron/cli";
 import { SentryClient, SentryClientOptions, createSentryClient } from "@theholocron/sentry-client";
+/** Resolves the Sentry token from `--token`, `HOLOCRON_SENTRY_TOKEN`, `SENTRY_AUTH_TOKEN` or the keyring, and throws an `AuthError` when none is set. */
 export declare const resolveToken: import("@theholocron/cli").TokenResolver;
 /**
  * The token for the Comlink relay: an integration, its client secret and an alert rule need more than the general token
@@ -13,18 +14,22 @@ export declare const resolveComlinkToken: import("@theholocron/cli").FeatureReso
 export declare function resolveRelayToken(input?: ResolveTokenInput): string;
 /** Every token this plugin takes, for `holocron doctor tokens`: the general one and the Comlink relay's own. */
 export declare const tokens: PluginToken[];
+/** Options for the Sentry `errors` capability. */
 interface SentryErrorsOptions {
   /** Sentry organization slug. Required for `whoami` and `ensureProject`. */
   org?: string;
   /** Default team slug for project creation. Defaults to org slug. */
   team?: string;
 }
+/** The `errors` capability for Sentry: finds or creates a project and reports its DSN, and manages the Comlink relay. */
 export declare class SentryErrors implements Errors {
   private readonly client;
   private readonly opts;
   /** The client for the relay, made with the Comlink token (see `resolveRelayToken`). */
   private readonly relayClient;
+  /** The capability key, always `errors`. */
   readonly key: "errors";
+  /** The provider name, `sentry`. */
   readonly providerName = "sentry";
   constructor(client: () => SentryClient, opts: SentryErrorsOptions,
   /** The client for the relay, made with the Comlink token (see `resolveRelayToken`). */
@@ -38,6 +43,7 @@ export declare class SentryErrors implements Errors {
   whoami(): Promise<{
     org: string;
   } | null>;
+  /** Returns the public DSN of the project named `input.name` (matched by its slug), creating it when missing; needs `org`, and the new project uses `team` (default the org slug) and `platform` (default `node`). */
   ensureProject(input: {
     name: string;
     platform?: string;
@@ -56,7 +62,9 @@ interface VerifyTokenOptions {
   baseUrl?: string;
   fetch?: typeof fetch;
 }
+/** Checks a Sentry token by listing its organizations; the success subject is `org:` and the first organization's slug, the failure carries the error message. */
 export declare function verifyToken(token: string, opts?: VerifyTokenOptions): Promise<VerifyTokenResult$1>;
+/** Options for the Sentry plugin: token resolution, the organization and team, and test overrides. */
 export interface SentryPluginOptions extends ResolveTokenInput, SentryErrorsOptions {
   /**
    * Sentry organization slug. Optional at load time — the `errors` capability
@@ -66,16 +74,23 @@ export interface SentryPluginOptions extends ResolveTokenInput, SentryErrorsOpti
   org?: string;
   /** Override base URL for tests. */
   baseUrl?: string;
+  /** Override `fetch` for tests. */
   fetch?: typeof fetch;
 }
+/** What the plugin's capabilities share: the options and two lazily built clients. */
 export interface PluginContext {
+  /** The options the plugin was created with. */
   options: SentryPluginOptions;
+  /** Builds the Sentry client on first call and reuses it; the token is resolved then, not at plugin load. */
   client: () => SentryClient;
   /** The client for the Comlink relay: its own token (`sentry.comlink`), the general one only as a last resort. */
   relayClient: () => SentryClient;
 }
+/** Creates the shared context for the given options; no token is resolved until a client is first called. */
 export declare function createContext(options: SentryPluginOptions): PluginContext;
+/** Builds the `errors` capability from a plugin context, using the relay client for the Comlink relay. */
 export declare function errors(ctx: PluginContext): Errors;
+/** Creates the Sentry plugin: its probes, a `connection` probe and the `errors` capability. */
 export declare function createPlugin(options: SentryPluginOptions): {
   name: string;
   probes: {
@@ -85,5 +100,6 @@ export declare function createPlugin(options: SentryPluginOptions): {
     errors: () => Errors;
   };
 };
+/** One-line hint shown by `holocron auth set sentry` when no token is given or the token is rejected. */
 export declare const AUTH_HINT: string;
 export { AuthError, type ResolveTokenInput, type SentryClient, type SentryClientOptions, type SentryErrorsOptions, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createSentryClient };

package/dist/index.mjs

@@ -3,6 +3,7 @@ import { randomUUID } from "node:crypto";
 import { createSentryClient } from "@theholocron/sentry-client";
 import { errorMessage } from "@theholocron/misc-utils";
 // src/auth.ts
+/** Resolves the Sentry token from `--token`, `HOLOCRON_SENTRY_TOKEN`, `SENTRY_AUTH_TOKEN` or the keyring, and throws an `AuthError` when none is set. */
 const resolveToken = createResolveToken({
 	envName: "HOLOCRON_SENTRY_TOKEN",
 	vendorEnvName: "SENTRY_AUTH_TOKEN",
@@ -264,11 +265,14 @@ async function inspectSentryRelay(client, org, input) {
 	};
 }
 // src/capabilities/errors.ts
+/** The `errors` capability for Sentry: finds or creates a project and reports its DSN, and manages the Comlink relay. */
 var SentryErrors = class {
 	client;
 	opts;
 	relayClient;
+	/** The capability key, always `errors`. */
 	key = "errors";
+	/** The provider name, `sentry`. */
 	providerName = "sentry";
 	constructor(client, opts, relayClient = client) {
 		this.client = client;
@@ -291,6 +295,7 @@ var SentryErrors = class {
 		if (!this.opts.org) return null;
 		return { org: (await this.client().auth.getOrg(this.opts.org)).slug };
 	}
+	/** Returns the public DSN of the project named `input.name` (matched by its slug), creating it when missing; needs `org`, and the new project uses `team` (default the org slug) and `platform` (default `node`). */
 	async ensureProject(input) {
 		const org = this.requireOrg();
 		const slug = toSlug(input.name);
@@ -568,6 +573,7 @@ function sentryProbes(deps) {
 	};
 }
 // src/verify-token.ts
+/** Checks a Sentry token by listing its organizations; the success subject is `org:` and the first organization's slug, the failure carries the error message. */
 async function verifyToken(token, opts = {}) {
 	const client = createSentryClient({
 		token,
@@ -587,6 +593,7 @@ async function verifyToken(token, opts = {}) {
 	}
 }
 // src/index.ts
+/** Creates the shared context for the given options; no token is resolved until a client is first called. */
 function createContext(options) {
 	let client;
 	let relayClient;
@@ -604,12 +611,14 @@ function createContext(options) {
 		})
 	};
 }
+/** Builds the `errors` capability from a plugin context, using the relay client for the Comlink relay. */
 function errors(ctx) {
 	return new SentryErrors(ctx.client, {
 		org: ctx.options.org,
 		team: ctx.options.team
 	}, ctx.relayClient);
 }
+/** Creates the Sentry plugin: its probes, a `connection` probe and the `errors` capability. */
 function createPlugin(options) {
 	const ctx = createContext(options);
 	return {
@@ -634,5 +643,6 @@ function createPlugin(options) {
 		capabilities: { errors: () => errors(ctx) }
 	};
 }
+/** One-line hint shown by `holocron auth set sentry` when no token is given or the token is rejected. */
 const AUTH_HINT = "generate an auth token at https://sentry.io/settings/account/api/auth-tokens/ with project:read, project:write, and org:read scopes, then run: holocron auth set sentry <TOKEN>";
 export { AUTH_HINT, AuthError, SentryErrors, createContext, createPlugin, createSentryClient, errors, resolveComlinkToken, resolveRelayToken, resolveToken, tokens, verifyToken };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-plugin-sentry",
-  "version": "5.0.0-alpha.277",
+  "version": "5.0.0-alpha.279",
   "description": "Holocron plugin for Sentry. Implements the errors capability against Sentry's management API — project provisioning and DSN retrieval.",
   "keywords": [
     "errors",
@@ -41,19 +41,19 @@
     "tsx": "4.23.15",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/cli": "5.0.0-alpha.277",
+    "@theholocron/cli": "5.0.0-alpha.279",
+    "@theholocron/eslint-config": "^8.9.0-alpha.4",
     "@theholocron/http-client": "^1.58.0-alpha.3",
-    "@theholocron/misc-utils": "^1.16.1-alpha.2",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
+    "@theholocron/misc-utils": "^1.16.1-alpha.3",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.4",
     "@theholocron/sentry-client": "^1.58.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3"
+    "@theholocron/tsconfig": "^8.9.0-alpha.4",
+    "@theholocron/vitest-config": "^8.9.0-alpha.4"
   },
   "peerDependencies": {
     "@theholocron/misc-utils": "^1.16.0",
     "@theholocron/sentry-client": "^1.56.0",
-    "@theholocron/cli": "5.0.0-alpha.277"
+    "@theholocron/cli": "5.0.0-alpha.279"
   },
   "peerDependenciesMeta": {
     "@theholocron/sentry-client": {}