@postman-cse/onboarding-bootstrap 0.9.1 → 0.11.0

package/src/lib/postman/internal-integration-adapter.ts

@@ -9,6 +9,13 @@ export interface GovernanceAssociation {
   systemEnvId: string;
 }
 
+export interface SpecificationCollectionLink {
+  collectionId: string;
+  syncOptions?: {
+    syncExamples: boolean;
+  };
+}
+
 export interface InternalIntegrationAdapterOptions {
   accessToken: string;
   backend: string;
@@ -32,6 +39,14 @@ export interface InternalIntegrationAdapter {
     workspaceId: string,
     repoUrl: string
   ): Promise<void>;
+  linkCollectionsToSpecification(
+    specificationId: string,
+    collections: SpecificationCollectionLink[]
+  ): Promise<void>;
+  syncCollection(
+    specificationId: string,
+    collectionId: string
+  ): Promise<void>;
 }
 
 class BifrostInternalIntegrationAdapter implements InternalIntegrationAdapter {
@@ -53,6 +68,33 @@ class BifrostInternalIntegrationAdapter implements InternalIntegrationAdapter {
     ).replace(/\/+$/, '');
   }
 
+  private async proxyRequest(
+    service: string,
+    method: string,
+    requestPath: string,
+    body?: unknown
+  ): Promise<Response> {
+    const url = 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy';
+    const headers: Record<string, string> = {
+      'Content-Type': 'application/json',
+      'x-access-token': this.accessToken
+    };
+    if (this.teamId) {
+      headers['x-entity-team-id'] = this.teamId;
+    }
+
+    return this.fetchImpl(url, {
+      method: 'POST',
+      headers,
+      body: JSON.stringify({
+        service,
+        method,
+        path: requestPath,
+        ...(body !== undefined ? { body } : {})
+      })
+    });
+  }
+
   async assignWorkspaceToGovernanceGroup(
     workspaceId: string,
     domain: string,
@@ -168,14 +210,6 @@ class BifrostInternalIntegrationAdapter implements InternalIntegrationAdapter {
     workspaceId: string,
     repoUrl: string
   ): Promise<void> {
-    const url = 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy';
-    const headers: Record<string, string> = {
-      'Content-Type': 'application/json',
-      'x-access-token': this.accessToken
-    };
-    if (this.teamId) {
-      headers['x-entity-team-id'] = this.teamId;
-    }
     const payload = {
       service: 'workspaces',
       method: 'POST',
@@ -187,11 +221,12 @@ class BifrostInternalIntegrationAdapter implements InternalIntegrationAdapter {
       }
     };
 
-    const response = await this.fetchImpl(url, {
-      method: 'POST',
-      headers,
-      body: JSON.stringify(payload)
-    });
+    const response = await this.proxyRequest(
+      payload.service,
+      payload.method,
+      payload.path,
+      payload.body
+    );
 
     if (response.ok) return;
 
@@ -215,31 +250,82 @@ class BifrostInternalIntegrationAdapter implements InternalIntegrationAdapter {
 
     throw await HttpError.fromResponse(response, {
       method: 'POST',
-      requestHeaders: headers,
+      requestHeaders: {
+        'Content-Type': 'application/json',
+        'x-access-token': this.accessToken,
+        ...(this.teamId ? { 'x-entity-team-id': this.teamId } : {})
+      },
       secretValues: [this.accessToken],
-      url
+      url: 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy'
     });
   }
 
-  private async getWorkspaceGitRepoUrl(workspaceId: string): Promise<string | null> {
-    const url = 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy';
-    const headers: Record<string, string> = {
-      'Content-Type': 'application/json',
-      'x-access-token': this.accessToken
-    };
-    if (this.teamId) {
-      headers['x-entity-team-id'] = this.teamId;
+  async linkCollectionsToSpecification(
+    specificationId: string,
+    collections: SpecificationCollectionLink[]
+  ): Promise<void> {
+    if (collections.length === 0) {
+      return;
     }
 
-    const response = await this.fetchImpl(url, {
+    const response = await this.proxyRequest(
+      'specification',
+      'put',
+      `/specifications/${specificationId}/collections`,
+      collections.map((collection) => ({
+        collectionId: collection.collectionId,
+        ...(collection.syncOptions ? { syncOptions: collection.syncOptions } : {})
+      }))
+    );
+
+    if (response.ok) {
+      return;
+    }
+
+    throw await HttpError.fromResponse(response, {
       method: 'POST',
-      headers,
-      body: JSON.stringify({
-        service: 'workspaces',
-        method: 'GET',
-        path: `/workspaces/${workspaceId}/filesystem`
-      })
+      requestHeaders: {
+        'Content-Type': 'application/json',
+        'x-access-token': this.accessToken,
+        ...(this.teamId ? { 'x-entity-team-id': this.teamId } : {})
+      },
+      secretValues: [this.accessToken],
+      url: 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy'
     });
+  }
+
+  async syncCollection(
+    specificationId: string,
+    collectionId: string
+  ): Promise<void> {
+    const response = await this.proxyRequest(
+      'specification',
+      'post',
+      `/specifications/${specificationId}/collections/${collectionId}/sync`
+    );
+
+    if (response.ok) {
+      return;
+    }
+
+    throw await HttpError.fromResponse(response, {
+      method: 'POST',
+      requestHeaders: {
+        'Content-Type': 'application/json',
+        'x-access-token': this.accessToken,
+        ...(this.teamId ? { 'x-entity-team-id': this.teamId } : {})
+      },
+      secretValues: [this.accessToken],
+      url: 'https://bifrost-premium-https-v4.gw.postman.com/ws/proxy'
+    });
+  }
+
+  private async getWorkspaceGitRepoUrl(workspaceId: string): Promise<string | null> {
+    const response = await this.proxyRequest(
+      'workspaces',
+      'GET',
+      `/workspaces/${workspaceId}/filesystem`
+    );
 
     if (response.status === 404) return null;
     if (!response.ok) return null;

package/src/lib/postman/postman-assets-client.ts

@@ -110,6 +110,21 @@ export class PostmanAssetsClient {
     return undefined;
   }
 
+  async getTeams(): Promise<Array<{ id: number; name: string; handle: string; organizationId?: number }>> {
+    const data = await this.request('/teams');
+    const teams = data?.data ?? [];
+    return Array.isArray(teams)
+      ? teams
+          .filter((t: any) => t?.id && t?.name)
+          .map((t: any) => ({
+            id: Number(t.id),
+            name: String(t.name),
+            handle: String(t.handle || ''),
+            ...(t.organizationId != null ? { organizationId: Number(t.organizationId) } : {})
+          }))
+      : [];
+  }
+
   private async request(
     path: string,
     init: RequestInit = {}
@@ -144,13 +159,14 @@ export class PostmanAssetsClient {
     }
   }
 
-  async createWorkspace(name: string, about: string): Promise<{ id: string }> {
+  async createWorkspace(name: string, about: string, targetTeamId?: number): Promise<{ id: string }> {
     return retry(async () => {
       const payload = {
         workspace: {
           about,
           name,
-          type: 'team'
+          type: 'team',
+          ...(targetTeamId != null && !Number.isNaN(targetTeamId) ? { teamId: targetTeamId } : {})
         }
       };
       let created: FetchResult;
@@ -162,7 +178,9 @@ export class PostmanAssetsClient {
       } catch (err) {
         if (err instanceof Error && err.message.includes('Only personal workspaces')) {
           throw new Error(
-            'Workspace creation failed: Your team may have Org Mode enabled. Org-level workspaces require a different API request schema which is currently unsupported in this alpha version.'
+            'Workspace creation failed: This may be an Org-mode account that requires a workspace-team-id input. ' +
+            'The Postman API does not allow creating team workspaces at the organization level. ' +
+            'Use the workspace-team-id input to specify which sub-team should own this workspace.'
           );
         }
         throw err;
@@ -184,7 +202,12 @@ export class PostmanAssetsClient {
       return {
         id: workspaceId
       };
-    }, { maxAttempts: 3, delayMs: 2000 });
+    }, {
+      maxAttempts: 3,
+      delayMs: 2000,
+      shouldRetry: (err) =>
+        !(err instanceof Error && err.message.includes('workspace-team-id'))
+    });
   }
 
   async listWorkspaces(): Promise<Array<{ id: string; name: string; type: string }>> {