@theholocron/holocron-plugin-postman 2.0.0-alpha.51 → 2.0.0-alpha.52

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { AuthError, ResolveTokenInput, RestClient, RestClient as RestClient$1, 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
 declare const resolveToken: (input?: import("@theholocron/http-client").ResolveTokenInput) => string;
@@ -17,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: RestClient, opts: PostmanToolingOptions);
+  constructor(client: PostmanClient$1, opts: PostmanToolingOptions);
   sync(): Promise<void>;
   doctor(): Promise<ToolingDoctorReport>;
   getMyself(): Promise<PostmanUser>;
@@ -95,41 +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/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` +
@@ -162,7 +103,7 @@ interface PostmanPluginOptions extends ResolveTokenInput, PostmanToolingOptions
 }
 interface PluginContext {
   options: PostmanPluginOptions;
-  rest: RestClient;
+  client: PostmanClient;
 }
 declare function createContext(options: PostmanPluginOptions): PluginContext;
 declare function tooling(ctx: PluginContext): Tooling;
@@ -178,4 +119,4 @@ declare function createPlugin(options: PostmanPluginOptions): {
  */
 declare const AUTH_HINT: string;
 //#endregion
-export { AUTH_HINT, AuthError, PluginContext, PostmanPlanLimitError, PostmanPluginOptions, PostmanTooling, type ResolveTokenInput, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, createContext, createPlugin, createPostmanRestClient, 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,6 +1,7 @@
-import { AuthError, ProviderApiError, createResolveToken, createRestClient } 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
 const resolveToken = createResolveToken({
 	envName: "HOLOCRON_POSTMAN_API_KEY",
@@ -33,13 +34,13 @@ const resolveToken = createResolveToken({
 * 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();
@@ -113,176 +114,57 @@ 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 }
-		});
+		await this.client.specs.updateFile(input.specId, input.filePath, 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
-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;
-		}
-	};
-}
-//#endregion
 //#region src/verify-token.ts
 /**
 * `verifyToken` — plugin-level export used by `holocron auth set` +
@@ -290,13 +172,13 @@ function createPostmanRestClient(opts) {
 * authenticated user).
 */
 async function verifyToken(token, opts = {}) {
-	const rest = createPostmanRestClient({
+	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")}`
@@ -314,7 +196,7 @@ function createContext(options) {
 	if (!options.workspaceId) throw new Error("@theholocron/holocron-plugin-postman requires `workspaceId` in options");
 	return {
 		options,
-		rest: createPostmanRestClient({
+		client: createPostmanClient({
 			token: resolveToken(options),
 			baseUrl: options.baseUrl,
 			fetch: options.fetch
@@ -328,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);
@@ -343,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, PostmanTooling, createContext, createPlugin, createPostmanRestClient, 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.51",
+  "version": "2.0.0-alpha.52",
   "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,9 +21,16 @@
     }
   },
   "peerDependencies": {
-    "@theholocron/cli": "2.0.0-alpha.51"
+    "@theholocron/postman-client": "^0.10.0",
+    "@theholocron/cli": "2.0.0-alpha.52"
+  },
+  "peerDependenciesMeta": {
+    "@theholocron/postman-client": {
+      "optional": false
+    }
   },
   "devDependencies": {
+    "@theholocron/postman-client": "^0.10.0",
     "@types/node": "^26",
     "@theholocron/eslint-config": "^7.0.0",
     "@theholocron/tsconfig": "^7.0.0",
@@ -37,7 +44,7 @@
     "tsx": "^4.22.4",
     "typescript": "^5.9.3",
     "vitest": "^4.1.10",
-    "@theholocron/cli": "2.0.0-alpha.51"
+    "@theholocron/cli": "2.0.0-alpha.52"
   },
   "publishConfig": {
     "access": "public"