fix: recreate Postman collections on publish instead of PUT update

Author: aamarfii

scripts/postman-publish-lib.ts

@@ -71,7 +71,9 @@ export function writeMapping(mapping: PublishMapping): void {
 export function listCollectionFiles(): string[] {
   return fs
     .readdirSync(postmanDir)
-    .filter((filename) => filename.endsWith('.json') && !filename.startsWith('.'))
+    .filter(
+      (filename) => filename.endsWith('.json') && !filename.startsWith('.'),
+    )
     .sort();
 }
 
@@ -81,6 +83,20 @@ export function loadLocalCollection(filename: string): PostmanCollection {
   ) as PostmanCollection;
 }
 
+export async function deleteCollection(
+  apiKey: string,
+  uid: string,
+): Promise<void> {
+  const response = await postmanFetch(apiKey, `/collections/${uid}`, {
+    method: 'DELETE',
+  });
+  const body = await readJson(response);
+  if (response.status === 404) {
+    return;
+  }
+  assertOk(response, body, `DELETE /collections/${uid}`);
+}
+
 export function collectionKeyFromFilename(filename: string): string {
   return path.basename(filename, '.json');
 }
@@ -103,11 +119,17 @@ export async function readJson(response: Response): Promise<unknown> {
   try {
     return text ? JSON.parse(text) : {};
   } catch {
-    throw new Error(`Invalid JSON from Postman API (${response.status}): ${text.slice(0, 500)}`);
+    throw new Error(
+      `Invalid JSON from Postman API (${response.status}): ${text.slice(0, 500)}`,
+    );
   }
 }
 
-export function assertOk(response: Response, body: unknown, context: string): void {
+export function assertOk(
+  response: Response,
+  body: unknown,
+  context: string,
+): void {
   if (response.ok) {
     return;
   }
@@ -120,7 +142,9 @@ export function workspaceOverviewUrl(teamDomain: string, slug: string): string {
   return `https://www.postman.com/${teamDomain}/${slug}/overview`;
 }
 
-export function countRequests(items: PostmanCollectionItem[] | undefined): number {
+export function countRequests(
+  items: PostmanCollectionItem[] | undefined,
+): number {
   if (!items) {
     return 0;
   }
@@ -136,7 +160,9 @@ export function countRequests(items: PostmanCollectionItem[] | undefined): numbe
   return count;
 }
 
-export function collectRequestPaths(items: PostmanCollectionItem[] | undefined): string[] {
+export function collectRequestPaths(
+  items: PostmanCollectionItem[] | undefined,
+): string[] {
   if (!items) {
     return [];
   }
@@ -185,7 +211,10 @@ export function fingerprintCollection(collection: PostmanCollection): string {
     },
     paths: collectRequestPaths(collection.item),
   };
-  return crypto.createHash('sha256').update(JSON.stringify(payload)).digest('hex');
+  return crypto
+    .createHash('sha256')
+    .update(JSON.stringify(payload))
+    .digest('hex');
 }
 
 export function collectBaseUrls(collection: PostmanCollection): string[] {

scripts/publish-to-postman.ts

@@ -8,6 +8,7 @@ import {
   WORKSPACE_SLUG,
   assertOk,
   collectionKeyFromFilename,
+  deleteCollection,
   listCollectionFiles,
   loadLocalCollection,
   postmanDir,
@@ -59,7 +60,10 @@ async function getTeamDomain(apiKey: string): Promise<string> {
   return teamDomain;
 }
 
-async function createWorkspace(apiKey: string, teamDomain: string): Promise<WorkspaceResponse['workspace']> {
+async function createWorkspace(
+  apiKey: string,
+  teamDomain: string,
+): Promise<WorkspaceResponse['workspace']> {
   const createPublic = async () => {
     const response = await postmanFetch(apiKey, '/workspaces', {
       method: 'POST',
@@ -103,7 +107,8 @@ async function createWorkspace(apiKey: string, teamDomain: string): Promise<Work
   }
 
   const workspace = body.workspace;
-  const workspaceType = (workspace.type as 'public' | 'team' | 'personal') ?? 'team';
+  const workspaceType =
+    (workspace.type as 'public' | 'team' | 'personal') ?? 'team';
   return {
     ...workspace,
     slug: workspace.slug ?? WORKSPACE_SLUG,
@@ -117,7 +122,10 @@ async function ensureWorkspace(
 ): Promise<NonNullable<ReturnType<typeof readMapping>['workspace']>> {
   const mapping = readMapping();
   if (mapping.workspace?.id) {
-    const response = await postmanFetch(apiKey, `/workspaces/${mapping.workspace.id}`);
+    const response = await postmanFetch(
+      apiKey,
+      `/workspaces/${mapping.workspace.id}`,
+    );
     const body = (await readJson(response)) as WorkspaceResponse;
     if (response.ok) {
       return mapping.workspace;
@@ -134,7 +142,10 @@ async function ensureWorkspace(
     slug: workspace.slug ?? WORKSPACE_SLUG,
     teamDomain,
     type: (workspace.type as 'public' | 'team' | 'personal') ?? 'team',
-    overviewUrl: workspaceOverviewUrl(teamDomain, workspace.slug ?? WORKSPACE_SLUG),
+    overviewUrl: workspaceOverviewUrl(
+      teamDomain,
+      workspace.slug ?? WORKSPACE_SLUG,
+    ),
   };
 }
 
@@ -143,32 +154,19 @@ async function createCollection(
   workspaceId: string,
   collection: unknown,
 ): Promise<CollectionResponse['collection']> {
-  const response = await postmanFetch(apiKey, `/collections?workspace=${workspaceId}`, {
-    method: 'POST',
-    body: JSON.stringify({ collection }),
-  });
+  const response = await postmanFetch(
+    apiKey,
+    `/collections?workspace=${workspaceId}`,
+    {
+      method: 'POST',
+      body: JSON.stringify({ collection }),
+    },
+  );
   const body = (await readJson(response)) as CollectionResponse;
   assertOk(response, body, 'POST /collections');
   return body.collection;
 }
 
-async function updateCollection(
-  apiKey: string,
-  uid: string,
-  collection: unknown,
-): Promise<CollectionResponse['collection']> {
-  const response = await postmanFetch(apiKey, `/collections/${uid}`, {
-    method: 'PUT',
-    body: JSON.stringify({ collection }),
-  });
-  const body = (await readJson(response)) as CollectionResponse;
-  if (response.status === 404) {
-    throw new Error('COLLECTION_NOT_FOUND');
-  }
-  assertOk(response, body, `PUT /collections/${uid}`);
-  return body.collection;
-}
-
 async function publishCollectionFile(
   apiKey: string,
   workspaceId: string,
@@ -187,26 +185,24 @@ async function publishCollectionFile(
   const localCollection = loadLocalCollection(filename);
   const existing = mapping.collections[key];
 
-  console.log(`Publishing ${filename} (${(fileSize / (1024 * 1024)).toFixed(2)} MB)...`);
+  console.log(
+    `Publishing ${filename} (${(fileSize / (1024 * 1024)).toFixed(2)} MB)...`,
+  );
 
-  let published: CollectionResponse['collection'];
   if (existing?.uid) {
-    try {
-      published = await updateCollection(apiKey, existing.uid, localCollection);
-      console.log(`Updated collection ${published.name} (${published.uid}).`);
-    } catch (error) {
-      if (!(error instanceof Error) || error.message !== 'COLLECTION_NOT_FOUND') {
-        throw error;
-      }
-      console.warn(`Mapped UID ${existing.uid} missing in Postman; creating a new collection.`);
-      published = await createCollection(apiKey, workspaceId, localCollection);
-      console.log(`Created replacement collection ${published.name} (${published.uid}).`);
-    }
-  } else {
-    published = await createCollection(apiKey, workspaceId, localCollection);
-    console.log(`Created collection ${published.name} (${published.uid}).`);
+    console.log(
+      `Deleting previous collection ${existing.name} (${existing.uid})...`,
+    );
+    await deleteCollection(apiKey, existing.uid);
   }
 
+  const published = await createCollection(
+    apiKey,
+    workspaceId,
+    localCollection,
+  );
+  console.log(`Created collection ${published.name} (${published.uid}).`);
+
   mapping.collections[key] = {
     uid: published.uid,
     name: published.name,
@@ -221,17 +217,26 @@ async function main(): Promise<void> {
 
   const files = listCollectionFiles();
   if (files.length === 0) {
-    throw new Error('No Postman collections found in postman/. Run npm run build first.');
+    throw new Error(
+      'No Postman collections found in postman/. Run npm run build first.',
+    );
   }
 
   for (const filename of files) {
-    await publishCollectionFile(apiKey, mapping.workspace!.id, filename, mapping);
+    await publishCollectionFile(
+      apiKey,
+      mapping.workspace!.id,
+      filename,
+      mapping,
+    );
   }
 
   writeMapping(mapping);
 
   console.log('\nPublish complete.');
-  console.log(`Workspace: ${mapping.workspace.name} (${mapping.workspace.type})`);
+  console.log(
+    `Workspace: ${mapping.workspace.name} (${mapping.workspace.type})`,
+  );
   console.log(`Overview:  ${mapping.workspace.overviewUrl}`);
   console.log(`Collections: ${Object.keys(mapping.collections).length}`);
   console.log(`Mapping:   postman/.postman-publish.json`);