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

package/dist/index.d.mts

@@ -1,23 +1,30 @@
 import { AuthError, ConnectionStringOptions, PluginToken, ResolveTokenInput, Storage, StorageBranch, VerifyTokenFailure, VerifyTokenResult, VerifyTokenResult as VerifyTokenResult$1, VerifyTokenSuccess } from "@theholocron/cli";
 import { NeonClient, NeonClient as NeonClient$1, NeonClientOptions, createNeonClient } from "@theholocron/neon-client";
+/** Resolves the Neon API key from `--token`, `HOLOCRON_NEON_API_KEY`, `NEON_API_KEY` or the keyring entry for `neon`, and throws `AuthError` when none is set. */
 export declare const resolveToken: import("@theholocron/cli").TokenResolver;
 /** Every token this plugin takes, for `holocron doctor tokens`. */
 export declare const tokens: PluginToken[];
 interface StorageOptions {
   projectId: string;
 }
+/** `storage` capability for Neon, bound to the single project named by the `projectId` option. */
 export declare class NeonStorage implements Storage {
   private readonly client;
   private readonly opts;
+  /** Capability key; always `"storage"`. */
   readonly key: "storage";
+  /** Provider name; always `"neon"`. */
   readonly providerName = "neon";
   constructor(client: () => NeonClient$1, opts: StorageOptions);
   getConnectionString(scope: string, options?: ConnectionStringOptions): Promise<string>;
+  /** Lists every branch of the bound project, mapped to `StorageBranch`. */
   listBranches(): Promise<StorageBranch[]>;
+  /** Creates a branch (optionally from the `from` parent branch id) with a read-write endpoint, so its connection string works at once. */
   createBranch(input: {
     name: string;
     from?: string;
   }): Promise<StorageBranch>;
+  /** Deletes the branch with the given id from the bound project. */
   destroyBranch(branch: string): Promise<void>;
   resetBranch(input: {
     branch: string;
@@ -38,7 +45,9 @@ interface VerifyTokenOptions {
   baseUrl?: string;
   fetch?: typeof fetch;
 }
+/** Checks a Neon API key by calling `/users/me` and reports who it belongs to, or why it was rejected. */
 export declare function verifyToken(token: string, opts?: VerifyTokenOptions): Promise<VerifyTokenResult$1>;
+/** Options for the Neon plugin: the token lookup inputs plus the project it is bound to. */
 export interface NeonPluginOptions extends ResolveTokenInput {
   /** Neon project id this plugin is bound to. Required. */
   projectId: string;
@@ -47,12 +56,18 @@ export interface NeonPluginOptions extends ResolveTokenInput {
   /** Override `fetch` for tests. */
   fetch?: typeof fetch;
 }
+/** Shared state for one Neon plugin instance: its options and a lazily created client. */
 export interface PluginContext {
+  /** The options the plugin was created with. */
   options: NeonPluginOptions;
+  /** Returns the memoized Neon client; the token is resolved on the first call, not at plugin load. */
   client: () => NeonClient;
 }
+/** Builds the plugin context from its options; throws when `projectId` is missing. */
 export declare function createContext(options: NeonPluginOptions): PluginContext;
+/** Builds the `storage` capability for the context's project. */
 export declare function storage(ctx: PluginContext): Storage;
+/** Creates the Neon plugin: its `connection` probe and the `storage` capability. */
 export declare function createPlugin(options: NeonPluginOptions): {
   name: string;
   probes: {

package/dist/index.mjs

@@ -2,6 +2,7 @@ import { AuthError, ProviderApiError, connectionProbe, createResolveToken } from
 import { createNeonClient } from "@theholocron/neon-client";
 import { errorMessage } from "@theholocron/misc-utils";
 // src/auth.ts
+/** Resolves the Neon API key from `--token`, `HOLOCRON_NEON_API_KEY`, `NEON_API_KEY` or the keyring entry for `neon`, and throws `AuthError` when none is set. */
 const resolveToken = createResolveToken({
 	envName: "HOLOCRON_NEON_API_KEY",
 	vendorEnvName: "NEON_API_KEY",
@@ -11,10 +12,13 @@ const resolveToken = createResolveToken({
 /** Every token this plugin takes, for `holocron doctor tokens`. */
 const tokens = [resolveToken.token];
 // src/capabilities/storage.ts
+/** `storage` capability for Neon, bound to the single project named by the `projectId` option. */
 var NeonStorage = class {
 	client;
 	opts;
+	/** Capability key; always `"storage"`. */
 	key = "storage";
+	/** Provider name; always `"neon"`. */
 	providerName = "neon";
 	constructor(client, opts) {
 		this.client = client;
@@ -31,10 +35,12 @@ var NeonStorage = class {
 		});
 		return uri;
 	}
+	/** Lists every branch of the bound project, mapped to `StorageBranch`. */
 	async listBranches() {
 		const { branches } = await this.client().branches.list(this.opts.projectId);
 		return branches.map(mapBranch);
 	}
+	/** Creates a branch (optionally from the `from` parent branch id) with a read-write endpoint, so its connection string works at once. */
 	async createBranch(input) {
 		const { branch } = await this.client().branches.create(this.opts.projectId, {
 			name: input.name,
@@ -43,6 +49,7 @@ var NeonStorage = class {
 		});
 		return mapBranch(branch);
 	}
+	/** Deletes the branch with the given id from the bound project. */
 	async destroyBranch(branch) {
 		await this.client().branches.destroy(this.opts.projectId, branch);
 	}
@@ -74,6 +81,7 @@ function mapBranch(raw) {
 	};
 }
 // src/verify-token.ts
+/** Checks a Neon API key by calling `/users/me` and reports who it belongs to, or why it was rejected. */
 async function verifyToken(token, opts = {}) {
 	const client = createNeonClient({
 		token,
@@ -94,6 +102,7 @@ async function verifyToken(token, opts = {}) {
 	}
 }
 // src/index.ts
+/** Builds the plugin context from its options; throws when `projectId` is missing. */
 function createContext(options) {
 	if (!options.projectId) throw new Error("@theholocron/holocron-plugin-neon requires `projectId` in options");
 	let client;
@@ -106,9 +115,11 @@ function createContext(options) {
 		})
 	};
 }
+/** Builds the `storage` capability for the context's project. */
 function storage(ctx) {
 	return new NeonStorage(ctx.client, { projectId: ctx.options.projectId });
 }
+/** Creates the Neon plugin: its `connection` probe and the `storage` capability. */
 function createPlugin(options) {
 	const ctx = createContext(options);
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-plugin-neon",
-  "version": "5.0.0-alpha.277",
+  "version": "5.0.0-alpha.279",
   "description": "Holocron plugin for Neon. Implements the storage capability against Neon's REST API — branch ops, connection strings, extensions.",
   "keywords": [
     "holocron",
@@ -40,19 +40,19 @@
     "tsx": "4.23.15",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/cli": "5.0.0-alpha.277",
-    "@theholocron/http-client": "^1.58.0-alpha.3",
+    "@theholocron/cli": "5.0.0-alpha.279",
+    "@theholocron/eslint-config": "^8.9.0-alpha.4",
     "@theholocron/neon-client": "^1.58.0-alpha.3",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
-    "@theholocron/misc-utils": "^1.16.1-alpha.2",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3"
+    "@theholocron/misc-utils": "^1.16.1-alpha.3",
+    "@theholocron/tsconfig": "^8.9.0-alpha.4",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.4",
+    "@theholocron/http-client": "^1.58.0-alpha.3",
+    "@theholocron/vitest-config": "^8.9.0-alpha.4"
   },
   "peerDependencies": {
     "@theholocron/misc-utils": "^1.16.0",
     "@theholocron/neon-client": "^1.43.1",
-    "@theholocron/cli": "5.0.0-alpha.277"
+    "@theholocron/cli": "5.0.0-alpha.279"
   },
   "peerDependenciesMeta": {
     "@theholocron/neon-client": {}