@theholocron/holocron-plugin-postman 2.0.0-alpha.8 → 2.0.0

package/README.md

@@ -5,8 +5,10 @@ Postman plugin for [Holocron](../cli). Implements the **multi-cardinality**
 
 ## Install
 
+<!-- prettier-ignore -->
 ```bash
 pnpm add -D @theholocron/holocron-plugin-postman@alpha
+
 ```
 
 ## Why REST, not the CLI
@@ -29,24 +31,26 @@ Generate the key at <https://web.postman.co/settings/me/api-keys>.
 
 ## Config
 
+<!-- prettier-ignore -->
 ```jsonc
 {
-	"providers": {
-		"tooling": [
-			[
-				"postman",
-				{
-					"workspaceId": "00000000-0000-0000-0000-000000000000",
-					"specFile": "apps/api/openapi.json",
-					"specName": "Rando API",
-					"collectionName": "Rando API",
-					"envFiles": ["apps/api/postman-env-staging.json"],
-				},
-			],
-			"storybook",
-		],
-	},
+  "providers": {
+    "tooling": [
+      [
+        "postman",
+        {
+          "workspaceId": "00000000-0000-0000-0000-000000000000",
+          "specFile": "apps/api/openapi.json",
+          "specName": "Rando API",
+          "collectionName": "Rando API",
+          "envFiles": ["apps/api/postman-env-staging.json"],
+        },
+      ],
+      "storybook",
+    ],
+  },
 }
+
 ```
 
 - `workspaceId` (required) — Postman workspace id. Find via `holocron tooling postman workspaces`.

package/dist/index.d.mts

@@ -1,56 +1,8 @@
-import { Tooling, ToolingDoctorReport } from "@theholocron/cli";
+import { AuthError, ResolveTokenInput, Tooling, ToolingDoctorReport } from "@theholocron/cli";
+import { PostmanClient, PostmanClient as PostmanClient$1, PostmanCollection, PostmanEnvironment, PostmanPlanLimitError, PostmanSpec, PostmanUser, PostmanWorkspace, createPostmanClient, detectPlanLimit } from "@theholocron/postman-client";
 
 //#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 {
@@ -66,38 +18,13 @@ interface PostmanToolingOptions {
   /** Working repo root. Defaults to process.cwd(). */
   repoRoot?: string;
 }
-interface PostmanUser {
-  id: number;
-  username: string;
-  fullName: string;
-}
-interface PostmanWorkspace {
-  id: string;
-  name: string;
-  type: string;
-}
-interface PostmanCollection {
-  id: string;
-  uid: string;
-  name: string;
-}
-interface PostmanEnvironment {
-  id: string;
-  uid: string;
-  name: string;
-}
-interface PostmanSpec {
-  id: string;
-  name: string;
-  type: string;
-}
 declare class PostmanTooling implements Tooling {
-  private readonly rest;
+  private readonly client;
   readonly key: "tooling";
   readonly providerName = "postman";
   private readonly opts;
   private readonly repoRoot;
-  constructor(rest: PostmanRestClient, opts: PostmanToolingOptions);
+  constructor(client: PostmanClient$1, opts: PostmanToolingOptions);
   sync(): Promise<void>;
   doctor(): Promise<ToolingDoctorReport>;
   getMyself(): Promise<PostmanUser>;
@@ -144,34 +71,6 @@ declare class PostmanTooling implements Tooling {
   }): Promise<void>;
 }
 //#endregion
-//#region src/errors.d.ts
-/**
- * Postman-specific errors that callers might want to discriminate.
- */
-/**
- * Thrown when Postman returns a `limitReachedError` (e.g., a Free-tier
- * account hitting the "0 APIs" cap). Callers can render "upgrade
- * required" instead of dumping the raw API body.
- */
-declare class PostmanPlanLimitError extends Error {
-  /** Human-readable plan-limit message from Postman. */
-  readonly limitMessage: string;
-  /** Original response body (JSON or text). */
-  readonly body: string;
-  name: string;
-  constructor(/** Human-readable plan-limit message from Postman. */
-
-  limitMessage: string, /** Original response body (JSON or text). */
-
-  body: string);
-}
-/**
- * Inspect a Postman error body for the plan-limit shape. Returns the
- * limit message when matched; null otherwise (caller throws a generic
- * `ProviderApiError`).
- */
-declare function detectPlanLimit(body: string): string | null;
-//#endregion
 //#region src/verify-token.d.ts
 /**
  * `verifyToken` — plugin-level export used by `holocron auth set` +
@@ -204,7 +103,7 @@ interface PostmanPluginOptions extends ResolveTokenInput, PostmanToolingOptions
 }
 interface PluginContext {
   options: PostmanPluginOptions;
-  rest: PostmanRestClient;
+  client: PostmanClient;
 }
 declare function createContext(options: PostmanPluginOptions): PluginContext;
 declare function tooling(ctx: PluginContext): Tooling;
@@ -220,4 +119,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, type PostmanClient, PostmanPlanLimitError, PostmanPluginOptions, PostmanTooling, type ResolveTokenInput, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createContext, createPlugin, createPostmanClient, detectPlanLimit, resolveToken, tooling, verifyToken };

package/dist/index.mjs

@@ -1,28 +1,14 @@
-import { ProviderApiError, getToken } from "@theholocron/cli";
+import { AuthError, ProviderApiError, createResolveToken } from "@theholocron/cli";
 import { readFile } from "node:fs/promises";
 import { basename, resolve } from "node:path";
+import { PostmanPlanLimitError, createPostmanClient, detectPlanLimit } from "@theholocron/postman-client";
 //#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
 /**
@@ -48,13 +34,13 @@ function resolveToken(input = {}) {
 * reachability and returns a `ToolingDoctorReport`.
 */
 var PostmanTooling = class {
-	rest;
+	client;
 	key = "tooling";
 	providerName = "postman";
 	opts;
 	repoRoot;
-	constructor(rest, opts) {
-		this.rest = rest;
+	constructor(client, opts) {
+		this.client = client;
 		if (!opts.workspaceId) throw new Error("PostmanTooling requires `workspaceId` in options");
 		this.opts = opts;
 		this.repoRoot = opts.repoRoot ?? process.cwd();
@@ -128,200 +114,54 @@ var PostmanTooling = class {
 		}
 	}
 	async getMyself() {
-		const raw = await this.rest.request("/me");
-		return {
-			id: raw.user.id,
-			username: raw.user.username,
-			fullName: raw.user.fullName
-		};
+		return (await this.client.me.get()).user ?? {};
 	}
 	async listWorkspaces() {
-		return (await this.rest.request("/workspaces")).workspaces.map((w) => ({
-			id: w.id,
-			name: w.name,
-			type: w.type
-		}));
+		const { workspaces } = await this.client.workspaces.list();
+		return workspaces;
 	}
 	async findCollectionByName(input) {
-		const match = (await this.rest.request("/collections", { query: { workspace: input.workspaceId } })).collections.find((c) => c.name === input.name);
-		return match ? {
-			id: match.id,
-			uid: match.uid,
-			name: match.name
-		} : null;
+		const { collections } = await this.client.collections.list(input.workspaceId);
+		return collections.find((c) => c.name === input.name) ?? null;
 	}
 	async deleteCollection(uid) {
-		await this.rest.request(`/collections/${encodeURIComponent(uid)}`, { method: "DELETE" });
+		await this.client.collections.delete(uid);
 	}
 	async importOpenApi(input) {
-		const created = (await this.rest.request("/import/openapi", {
-			method: "POST",
-			query: { workspace: input.workspaceId },
-			body: {
-				type: "string",
-				input: typeof input.spec === "string" ? input.spec : JSON.stringify(input.spec)
-			}
-		})).collections[0];
+		const { collections } = await this.client.import.openapi(input.workspaceId, input.spec);
+		const created = collections[0];
 		if (!created) throw new ProviderApiError("Postman returned no collection on import — check the OpenAPI spec is well-formed", 500, void 0);
-		return {
-			id: created.id,
-			uid: created.uid,
-			name: created.name
-		};
+		return created;
 	}
 	async listEnvironments(input) {
-		return (await this.rest.request("/environments", { query: { workspace: input.workspaceId } })).environments.map((e) => ({
-			id: e.id,
-			uid: e.uid,
-			name: e.name
-		}));
+		const { environments } = await this.client.environments.list(input.workspaceId);
+		return environments;
 	}
 	async findEnvironmentByName(input) {
 		return (await this.listEnvironments(input)).find((e) => e.name === input.name) ?? null;
 	}
 	async createEnvironment(input) {
-		const raw = await this.rest.request("/environments", {
-			method: "POST",
-			query: { workspace: input.workspaceId },
-			body: { environment: input.environment }
-		});
-		return {
-			id: raw.environment.id,
-			uid: raw.environment.uid,
-			name: raw.environment.name
-		};
+		const { environment } = await this.client.environments.create(input.workspaceId, input.environment);
+		return environment;
 	}
 	async updateEnvironment(input) {
-		const raw = await this.rest.request(`/environments/${encodeURIComponent(input.uid)}`, {
-			method: "PUT",
-			body: { environment: input.environment }
-		});
-		return {
-			id: raw.environment.id,
-			uid: raw.environment.uid,
-			name: raw.environment.name
-		};
+		const { environment } = await this.client.environments.update(input.uid, input.environment);
+		return environment;
 	}
 	async findSpecByName(input) {
-		const match = (await this.rest.request("/specs", { query: { workspaceId: input.workspaceId } })).specs.find((s) => s.name === input.name);
-		return match ? {
-			id: match.id,
-			name: match.name,
-			type: match.type
-		} : null;
+		const { specs } = await this.client.specs.list(input.workspaceId);
+		return specs.find((s) => s.name === input.name) ?? null;
 	}
 	async createSpec(input) {
-		const raw = await this.rest.request("/specs", {
-			method: "POST",
-			query: { workspaceId: input.workspaceId },
-			body: {
-				name: input.name,
-				type: input.type ?? "OPENAPI:3.0",
-				files: [{
-					path: input.filePath ?? "index.json",
-					content: input.fileContent
-				}]
-			}
+		return this.client.specs.create(input.workspaceId, {
+			name: input.name,
+			type: input.type,
+			filePath: input.filePath,
+			fileContent: input.fileContent
 		});
-		return {
-			id: raw.id,
-			name: raw.name,
-			type: raw.type
-		};
 	}
 	async upsertSpecFile(input) {
-		await this.rest.request(`/specs/${encodeURIComponent(input.specId)}/files/${encodeURIComponent(input.filePath)}`, {
-			method: "PATCH",
-			body: { content: input.content }
-		});
-	}
-};
-//#endregion
-//#region src/errors.ts
-/**
-* Postman-specific errors that callers might want to discriminate.
-*/
-/**
-* Thrown when Postman returns a `limitReachedError` (e.g., a Free-tier
-* account hitting the "0 APIs" cap). Callers can render "upgrade
-* required" instead of dumping the raw API body.
-*/
-var PostmanPlanLimitError = class extends Error {
-	limitMessage;
-	body;
-	name = "PostmanPlanLimitError";
-	constructor(limitMessage, body) {
-		super(limitMessage);
-		this.limitMessage = limitMessage;
-		this.body = body;
-	}
-};
-/**
-* Inspect a Postman error body for the plan-limit shape. Returns the
-* limit message when matched; null otherwise (caller throws a generic
-* `ProviderApiError`).
-*/
-function detectPlanLimit(body) {
-	try {
-		const parsed = JSON.parse(body);
-		if (parsed.error?.name === "limitReachedError" && parsed.error.message) return parsed.error.message;
-	} catch {}
-	return null;
-}
-//#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);
-		}
-		if (res.status === 204) return void 0;
-		const text = await res.text();
-		if (!text) return void 0;
-		return JSON.parse(text);
+		await this.client.specs.updateFile(input.specId, input.filePath, input.content);
 	}
 };
 //#endregion
@@ -332,12 +172,13 @@ 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 client = createPostmanClient({
+		token,
+		baseUrl: opts.baseUrl,
+		fetch: opts.fetch
+	});
 	try {
-		const res = await rest.request("/me");
+		const res = await client.me.get();
 		return {
 			ok: true,
 			subject: `user @ ${res?.user?.email ?? res?.user?.username ?? res?.user?.fullName ?? String(res?.user?.id ?? "unknown")}`
@@ -353,12 +194,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)
+		client: createPostmanClient({
+			token: resolveToken(options),
+			baseUrl: options.baseUrl,
+			fetch: options.fetch
+		})
 	};
 }
 function tooling(ctx) {
@@ -368,7 +210,7 @@ function tooling(ctx) {
 	if (ctx.options.collectionName !== void 0) opts.collectionName = ctx.options.collectionName;
 	if (ctx.options.envFiles !== void 0) opts.envFiles = ctx.options.envFiles;
 	if (ctx.options.repoRoot !== void 0) opts.repoRoot = ctx.options.repoRoot;
-	return new PostmanTooling(ctx.rest, opts);
+	return new PostmanTooling(ctx.client, opts);
 }
 function createPlugin(options) {
 	const ctx = createContext(options);
@@ -383,4 +225,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, createPostmanClient, detectPlanLimit, resolveToken, tooling, verifyToken };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-plugin-postman",
-  "version": "2.0.0-alpha.8",
+  "version": "2.0.0",
   "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,19 +21,31 @@
     }
   },
   "peerDependencies": {
-    "@theholocron/cli": "2.0.0-alpha.8"
+    "@theholocron/postman-client": "^1.1.0",
+    "@theholocron/cli": "2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@theholocron/postman-client": {
+      "optional": false
+    }
   },
   "devDependencies": {
-    "@theholocron/tsconfig": "^4.1.0",
-    "@tsconfig/node-lts": "^24.0.0",
-    "@vitest/coverage-v8": "^3.2.6",
-    "eslint": "^9.36.0",
-    "globals": "^16.5.0",
-    "typescript": "^5.9.3",
-    "vitest": "^3.2.6",
+    "@theholocron/eslint-config": "^7.3.0",
+    "@theholocron/postman-client": "^1.1.0",
+    "@theholocron/tsconfig": "^7.3.0",
+    "@theholocron/tsdown-config": "^7.3.0",
+    "@theholocron/vitest-config": "^7.3.0",
+    "@types/node": "^26",
+    "@vitest/coverage-v8": "^4.1.10",
+    "@vitest/eslint-plugin": "^1.6.23",
+    "eslint": "^10.7.0",
+    "eslint-plugin-n": "^18.2.2",
+    "globals": "^17.7.0",
     "tsdown": "^0.22.3",
     "tsx": "^4.22.4",
-    "@theholocron/cli": "2.0.0-alpha.8"
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.10",
+    "@theholocron/cli": "2.0.0"
   },
   "publishConfig": {
     "access": "public"