@theholocron/holocron-plugin-postman 2.0.0-alpha.20 → 2.0.0-alpha.21

package/dist/index.d.mts

@@ -1,56 +1,7 @@
-import { Tooling, ToolingDoctorReport } from "@theholocron/cli";
+import { AuthError, ResolveTokenInput, RestClient, RestClient as RestClient$1, Tooling, ToolingDoctorReport } from "@theholocron/cli";
 
 //#region src/auth.d.ts
-/**
- * Token resolution for the Postman plugin.
- *
- * Resolution order (matches the standard 4-step precedence set by
- * `.notes/tech-auth-bootstrap.spec.md`):
- *   1. explicit `cliToken` argument (from `--token` flag)
- *   2. HOLOCRON_POSTMAN_API_KEY env var (preferred — explicit intent)
- *   3. POSTMAN_API_KEY env var (Postman's own default)
- *   4. keyring (com.theholocron.cli / "postman")
- *   5. AuthError naming all four options + the bootstrap hint
- */
-declare class AuthError extends Error {
-  name: string;
-}
-interface ResolveTokenInput {
-  /** From `--token` CLI flag. */
-  cliToken?: string;
-  /** Env vars; passed in for testability. Defaults to `process.env`. */
-  env?: NodeJS.ProcessEnv;
-  /** Keyring lookup fn; passed in for testability. Defaults to `getToken(provider)`. */
-  keyring?: (provider: string) => string | null;
-}
-declare function resolveToken(input?: ResolveTokenInput): string;
-//#endregion
-//#region src/rest.d.ts
-/**
- * Thin REST wrapper around api.getpostman.com.
- *
- * Same pattern as the github / vercel / neon / clerk REST clients —
- * the Postman API uses `x-api-key` (not bearer) for auth, but
- * otherwise the shape's identical: JSON only, transport-failure
- * wrapping with `status: 0`.
- */
-interface RestClientOptions {
-  token: string;
-  fetch?: typeof fetch;
-  baseUrl?: string;
-}
-interface RequestOptions {
-  method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
-  body?: unknown;
-  query?: Record<string, string>;
-}
-declare class PostmanRestClient {
-  private readonly token;
-  private readonly fetchImpl;
-  readonly baseUrl: string;
-  constructor(opts: RestClientOptions);
-  request<T>(path: string, opts?: RequestOptions): Promise<T>;
-}
+declare const resolveToken: (input?: import("@theholocron/http-client").ResolveTokenInput) => string;
 //#endregion
 //#region src/capabilities/tooling.d.ts
 interface PostmanToolingOptions {
@@ -97,7 +48,7 @@ declare class PostmanTooling implements Tooling {
   readonly providerName = "postman";
   private readonly opts;
   private readonly repoRoot;
-  constructor(rest: PostmanRestClient, opts: PostmanToolingOptions);
+  constructor(rest: RestClient, opts: PostmanToolingOptions);
   sync(): Promise<void>;
   doctor(): Promise<ToolingDoctorReport>;
   getMyself(): Promise<PostmanUser>;
@@ -172,6 +123,13 @@ declare class PostmanPlanLimitError extends Error {
  */
 declare function detectPlanLimit(body: string): string | null;
 //#endregion
+//#region src/rest.d.ts
+declare function createPostmanRestClient(opts: {
+  token: string;
+  baseUrl?: string;
+  fetch?: typeof fetch;
+}): RestClient$1;
+//#endregion
 //#region src/verify-token.d.ts
 /**
  * `verifyToken` — plugin-level export used by `holocron auth set` +
@@ -204,7 +162,7 @@ interface PostmanPluginOptions extends ResolveTokenInput, PostmanToolingOptions
 }
 interface PluginContext {
   options: PostmanPluginOptions;
-  rest: PostmanRestClient;
+  rest: RestClient;
 }
 declare function createContext(options: PostmanPluginOptions): PluginContext;
 declare function tooling(ctx: PluginContext): Tooling;
@@ -220,4 +178,4 @@ declare function createPlugin(options: PostmanPluginOptions): {
  */
 declare const AUTH_HINT: string;
 //#endregion
-export { AUTH_HINT, AuthError, PluginContext, PostmanPlanLimitError, PostmanPluginOptions, PostmanRestClient, PostmanTooling, ResolveTokenInput, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createContext, createPlugin, detectPlanLimit, resolveToken, tooling, verifyToken };
+export { AUTH_HINT, AuthError, PluginContext, PostmanPlanLimitError, PostmanPluginOptions, PostmanTooling, type ResolveTokenInput, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createContext, createPlugin, createPostmanRestClient, detectPlanLimit, resolveToken, tooling, verifyToken };

package/dist/index.mjs

@@ -1,28 +1,13 @@
-import { ProviderApiError, getToken } from "@theholocron/cli";
+import { AuthError, ProviderApiError, createResolveToken, createRestClient } from "@theholocron/cli";
 import { readFile } from "node:fs/promises";
 import { basename, resolve } from "node:path";
 //#region src/auth.ts
-/**
-* Token resolution for the Postman plugin.
-*
-* Resolution order (matches the standard 4-step precedence set by
-* `.notes/tech-auth-bootstrap.spec.md`):
-*   1. explicit `cliToken` argument (from `--token` flag)
-*   2. HOLOCRON_POSTMAN_API_KEY env var (preferred — explicit intent)
-*   3. POSTMAN_API_KEY env var (Postman's own default)
-*   4. keyring (com.theholocron.cli / "postman")
-*   5. AuthError naming all four options + the bootstrap hint
-*/
-var AuthError = class extends Error {
-	name = "AuthError";
-};
-function resolveToken(input = {}) {
-	const env = input.env ?? process.env;
-	const keyring = input.keyring ?? getToken;
-	const token = input.cliToken || env["HOLOCRON_POSTMAN_API_KEY"] || env["POSTMAN_API_KEY"] || keyring("postman");
-	if (!token) throw new AuthError("no Postman API key found. Pass --token <KEY>, set HOLOCRON_POSTMAN_API_KEY / POSTMAN_API_KEY, or run: holocron auth set postman <KEY>");
-	return token;
-}
+const resolveToken = createResolveToken({
+	envName: "HOLOCRON_POSTMAN_API_KEY",
+	vendorEnvName: "POSTMAN_API_KEY",
+	keyringService: "postman",
+	errorMessage: "no Postman API key found. Pass --token <KEY>, set HOLOCRON_POSTMAN_API_KEY / POSTMAN_API_KEY, or run: holocron auth set postman <KEY>"
+});
 //#endregion
 //#region src/capabilities/tooling.ts
 /**
@@ -270,60 +255,33 @@ function detectPlanLimit(body) {
 }
 //#endregion
 //#region src/rest.ts
-/**
-* Thin REST wrapper around api.getpostman.com.
-*
-* Same pattern as the github / vercel / neon / clerk REST clients —
-* the Postman API uses `x-api-key` (not bearer) for auth, but
-* otherwise the shape's identical: JSON only, transport-failure
-* wrapping with `status: 0`.
-*/
-var PostmanRestClient = class {
-	token;
-	fetchImpl;
-	baseUrl;
-	constructor(opts) {
-		this.token = opts.token;
-		this.fetchImpl = opts.fetch ?? globalThis.fetch;
-		let url = opts.baseUrl ?? "https://api.getpostman.com";
-		while (url.endsWith("/")) url = url.slice(0, -1);
-		this.baseUrl = url;
-	}
-	async request(path, opts = {}) {
-		const url = new URL(`${this.baseUrl}${path.startsWith("/") ? path : "/" + path}`);
-		for (const [k, v] of Object.entries(opts.query ?? {})) url.searchParams.set(k, v);
-		const fullUrl = url.toString();
-		const headers = {
-			"x-api-key": this.token,
-			accept: "application/json"
-		};
-		const init = {
-			method: opts.method ?? "GET",
-			headers
-		};
-		if (opts.body !== void 0) {
-			headers["content-type"] = "application/json";
-			init.body = JSON.stringify(opts.body);
-		}
-		let res;
-		try {
-			res = await this.fetchImpl(fullUrl, init);
-		} catch (err) {
-			const detail = err instanceof Error ? `${err.name}: ${err.message}` : String(err);
-			throw new ProviderApiError(`Postman ${init.method} ${path} failed: ${detail}`, 0, void 0);
-		}
-		if (!res.ok) {
-			const body = await res.text().catch(() => "");
-			const limit = detectPlanLimit(body);
-			if (limit) throw new PostmanPlanLimitError(limit, body);
-			throw new ProviderApiError(`Postman ${init.method} ${path} → ${res.status}`, res.status, body);
+function createPostmanRestClient(opts) {
+	const base = createRestClient({
+		baseUrl: opts.baseUrl ?? "https://api.getpostman.com",
+		token: opts.token,
+		tokenScheme: "apikey",
+		apiKeyHeader: "x-api-key",
+		vendor: "Postman",
+		fetch: opts.fetch
+	});
+	return {
+		baseUrl: base.baseUrl,
+		async request(path, reqOpts) {
+			let res;
+			try {
+				res = await base.request(path, reqOpts);
+			} catch (err) {
+				const details = err.details;
+				if (typeof details === "string") {
+					const limit = detectPlanLimit(details);
+					if (limit) throw new PostmanPlanLimitError(limit, details);
+				}
+				throw err;
+			}
+			return res;
 		}
-		if (res.status === 204) return void 0;
-		const text = await res.text();
-		if (!text) return void 0;
-		return JSON.parse(text);
-	}
-};
+	};
+}
 //#endregion
 //#region src/verify-token.ts
 /**
@@ -332,10 +290,11 @@ var PostmanRestClient = class {
 * authenticated user).
 */
 async function verifyToken(token, opts = {}) {
-	const restOpts = { token };
-	if (opts.baseUrl !== void 0) restOpts.baseUrl = opts.baseUrl;
-	if (opts.fetch !== void 0) restOpts.fetch = opts.fetch;
-	const rest = new PostmanRestClient(restOpts);
+	const rest = createPostmanRestClient({
+		token,
+		baseUrl: opts.baseUrl,
+		fetch: opts.fetch
+	});
 	try {
 		const res = await rest.request("/me");
 		return {
@@ -353,12 +312,13 @@ async function verifyToken(token, opts = {}) {
 //#region src/index.ts
 function createContext(options) {
 	if (!options.workspaceId) throw new Error("@theholocron/holocron-plugin-postman requires `workspaceId` in options");
-	const restOpts = { token: resolveToken(options) };
-	if (options.baseUrl !== void 0) restOpts.baseUrl = options.baseUrl;
-	if (options.fetch !== void 0) restOpts.fetch = options.fetch;
 	return {
 		options,
-		rest: new PostmanRestClient(restOpts)
+		rest: createPostmanRestClient({
+			token: resolveToken(options),
+			baseUrl: options.baseUrl,
+			fetch: options.fetch
+		})
 	};
 }
 function tooling(ctx) {
@@ -383,4 +343,4 @@ function createPlugin(options) {
 */
 const AUTH_HINT = "generate a Postman API key at https://postman.co/settings/me/api-keys, then run: holocron auth set postman <KEY>";
 //#endregion
-export { AUTH_HINT, AuthError, PostmanPlanLimitError, PostmanRestClient, PostmanTooling, createContext, createPlugin, detectPlanLimit, resolveToken, tooling, verifyToken };
+export { AUTH_HINT, AuthError, PostmanPlanLimitError, PostmanTooling, createContext, createPlugin, createPostmanRestClient, detectPlanLimit, resolveToken, tooling, verifyToken };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-plugin-postman",
-  "version": "2.0.0-alpha.20",
+  "version": "2.0.0-alpha.21",
   "description": "Holocron plugin for Postman. Implements the tooling capability against Postman's REST API — workspace + collection + spec + environment sync.",
   "homepage": "https://github.com/theholocron/holocron/tree/main/packages/holocron-plugin-postman#readme",
   "bugs": "https://github.com/theholocron/holocron/issues",
@@ -21,13 +21,14 @@
     }
   },
   "peerDependencies": {
-    "@theholocron/cli": "2.0.0-alpha.20"
+    "@theholocron/cli": "2.0.0-alpha.21"
   },
   "devDependencies": {
-    "@theholocron/eslint-config": "^5.1.2",
-    "@theholocron/tsconfig": "^5.1.2",
-    "@tsconfig/node-lts": "^24.0.0",
-    "@vitest/coverage-v8": "^3.2.6",
+    "@types/node": "^26",
+    "@theholocron/eslint-config": "^5.2.0",
+    "@theholocron/tsconfig": "^6.0.0",
+    "@theholocron/tsdown-config": "^5.1.2",
+    "@theholocron/vitest-config": "^5.2.0",
     "@vitest/eslint-plugin": "^1.6.23",
     "eslint": "^10.7.0",
     "eslint-plugin-n": "^18.2.2",
@@ -35,8 +36,8 @@
     "tsdown": "^0.22.3",
     "tsx": "^4.22.4",
     "typescript": "^5.9.3",
-    "vitest": "^3.2.6",
-    "@theholocron/cli": "2.0.0-alpha.20"
+    "vitest": "^4.1.10",
+    "@theholocron/cli": "2.0.0-alpha.21"
   },
   "publishConfig": {
     "access": "public"