@postman-cse/onboarding-repo-sync 1.0.1 → 1.0.3

package/README.md

@@ -1,12 +1,11 @@
-# Postman Repo Sync
+# Postman Onboarding: Repo Sync
 
-[![CI](https://github.com/postman-cs/postman-repo-sync-action/actions/workflows/ci.yml/badge.svg)](https://github.com/postman-cs/postman-repo-sync-action/actions/workflows/ci.yml)
-[![Release](https://img.shields.io/github/v/release/postman-cs/postman-repo-sync-action?sort=semver)](https://github.com/postman-cs/postman-repo-sync-action/releases)
-[![npm](https://img.shields.io/npm/v/%40postman-cse%2Fonboarding-repo-sync)](https://www.npmjs.com/package/@postman-cse/onboarding-repo-sync)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![CI](https://github.com/postman-cs/postman-repo-sync-action/actions/workflows/ci.yml/badge.svg)](https://github.com/postman-cs/postman-repo-sync-action/actions/workflows/ci.yml) [![Release](https://img.shields.io/github/v/release/postman-cs/postman-repo-sync-action?sort=semver)](https://github.com/postman-cs/postman-repo-sync-action/releases) [![npm](https://img.shields.io/npm/v/%40postman-cse%2Fonboarding-repo-sync)](https://www.npmjs.com/package/@postman-cse/onboarding-repo-sync) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 Exports Postman collections and environments into your repository and wires CI, mocks, and monitors around them.
 
+Part of the [Postman API Onboarding suite](https://github.com/postman-cs/postman-api-onboarding-action).
+
 ## Usage
 
 ```yaml
@@ -205,6 +204,18 @@ Deeper reference:
 
 ## Resources
 
+### The suite
+
+| Action | Role |
+| --- | --- |
+| [Postman API Onboarding](https://github.com/postman-cs/postman-api-onboarding-action) | Entry point: chains workspace bootstrap, repo sync, and optional Insights linking |
+| [Postman Onboarding: Service Token](https://github.com/postman-cs/postman-resolve-service-token-action) | Mints the service-account access token and team ID |
+| [Postman Onboarding: AWS Spec Discovery](https://github.com/postman-cs/postman-aws-spec-discovery-action) | Discovers and exports API specs from AWS services |
+| [Postman Onboarding: Workspace Bootstrap](https://github.com/postman-cs/postman-bootstrap-action) | Creates the workspace, uploads the spec, generates collections |
+| [Postman Onboarding: Smoke Flow](https://github.com/postman-cs/postman-smoke-flow-action) | Applies a curated flow.yaml to the Smoke collection |
+| [Postman Onboarding: Repo Sync](https://github.com/postman-cs/postman-repo-sync-action) | Exports artifacts into the repo and wires CI, mocks, and monitors |
+| [Postman Onboarding: Insights Linking](https://github.com/postman-cs/postman-insights-onboarding-action) | Links Insights discovered services to the workspace |
+
 - [postman-resolve-service-token-action](https://github.com/postman-cs/postman-resolve-service-token-action): mints a service-account access token and team ID.
 - [postman-api-onboarding-action](https://github.com/postman-cs/postman-api-onboarding-action): composite action that orchestrates the onboarding pipeline.
 - [postman-bootstrap-action](https://github.com/postman-cs/postman-bootstrap-action): workspace provisioning, spec upload, and collection generation.

package/action.yml

@@ -1,5 +1,5 @@
-name: Postman Repo Sync
-description: Export Postman collections and environments into your repo and wire CI, mocks, and monitors around them.
+name: 'Postman Onboarding: Repo Sync'
+description: Export Postman collections and environments into your repo with CI wiring. Part of the Postman API Onboarding suite.
 author: Postman
 branding:
   icon: refresh-cw

package/dist/action.cjs

@@ -9182,14 +9182,14 @@ var require_retry_agent = __commonJS({
         this.#options = options;
       }
       dispatch(opts, handler) {
-        const retry = new RetryHandler({
+        const retry2 = new RetryHandler({
           ...opts,
           retryOptions: this.#options
         }, {
           dispatch: this.#agent.dispatch.bind(this.#agent),
           handler
         });
-        return this.#agent.dispatch(opts, retry);
+        return this.#agent.dispatch(opts, retry2);
       }
       close() {
         return this.#agent.close();
@@ -25282,12 +25282,60 @@ var postmanRepoSyncActionContract = {
   }
 };
 
+// src/lib/retry.ts
+function sleep(delayMs) {
+  return new Promise((resolve3) => {
+    setTimeout(resolve3, delayMs);
+  });
+}
+function normalizeRetryOptions(options) {
+  return {
+    maxAttempts: Math.max(1, options.maxAttempts ?? 3),
+    delayMs: Math.max(0, options.delayMs ?? 2e3),
+    backoffMultiplier: Math.max(1, options.backoffMultiplier ?? 1),
+    maxDelayMs: options.maxDelayMs === void 0 ? Number.POSITIVE_INFINITY : Math.max(0, options.maxDelayMs),
+    onRetry: options.onRetry ?? (async () => void 0),
+    shouldRetry: options.shouldRetry ?? (() => true),
+    sleep: options.sleep ?? sleep
+  };
+}
+async function retry(operation, options = {}) {
+  const normalized = normalizeRetryOptions(options);
+  let nextDelayMs = normalized.delayMs;
+  for (let attempt = 1; attempt <= normalized.maxAttempts; attempt += 1) {
+    try {
+      return await operation();
+    } catch (error2) {
+      const shouldRetry = attempt < normalized.maxAttempts && normalized.shouldRetry(error2, {
+        attempt,
+        maxAttempts: normalized.maxAttempts
+      });
+      if (!shouldRetry) {
+        throw error2;
+      }
+      await normalized.onRetry({
+        attempt,
+        maxAttempts: normalized.maxAttempts,
+        delayMs: nextDelayMs,
+        error: error2
+      });
+      await normalized.sleep(nextDelayMs);
+      nextDelayMs = Math.min(
+        normalized.maxDelayMs,
+        Math.round(nextDelayMs * normalized.backoffMultiplier)
+      );
+    }
+  }
+  throw new Error("Retry exhausted without returning or throwing");
+}
+
 // src/lib/postman/postman-assets-client.ts
 var PostmanAssetsClient = class {
   apiKey;
   baseUrl;
   bifrostBaseUrl;
   fetchImpl;
+  retrySleep;
   constructor(options) {
     this.apiKey = String(options.apiKey || "").trim();
     this.baseUrl = String(options.baseUrl || POSTMAN_ENDPOINT_PROFILES.prod.apiBaseUrl).replace(
@@ -25298,6 +25346,7 @@ var PostmanAssetsClient = class {
       options.bifrostBaseUrl || POSTMAN_ENDPOINT_PROFILES.prod.bifrostBaseUrl
     ).replace(/\/+$/, "");
     this.fetchImpl = options.fetchImpl ?? fetch;
+    this.retrySleep = options.retrySleep;
     void (options.secretMasker ?? createSecretMasker([this.apiKey]));
   }
   getBaseUrl() {
@@ -25361,9 +25410,36 @@ var PostmanAssetsClient = class {
       })
     });
   }
+  /**
+   * Monitor and mock creation reference a collection that may have been
+   * created moments earlier; the Postman backend is eventually consistent
+   * and can reject the reference with a 400 "Unable to load collection"
+   * until the collection becomes visible. Retry only that specific 400 and
+   * 429 throttling: both guarantee nothing was created. A 5xx on these
+   * non-idempotent creates is ambiguous (the asset may exist server-side),
+   * so it is not retried to avoid duplicate mocks and monitors.
+   */
+  async requestWithCollectionRetry(path8, init) {
+    return retry(() => this.request(path8, init), {
+      maxAttempts: 5,
+      delayMs: 2e3,
+      backoffMultiplier: 2,
+      maxDelayMs: 15e3,
+      ...this.retrySleep ? { sleep: this.retrySleep } : {},
+      shouldRetry: (error2) => {
+        if (!(error2 instanceof HttpError)) {
+          return false;
+        }
+        if (error2.status === 429) {
+          return true;
+        }
+        return error2.status === 400 && /unable to load collection/i.test(error2.responseBody);
+      }
+    });
+  }
   async createMonitor(workspaceId, name, collectionUid, environmentUid, cronSchedule) {
     const effectiveCron = cronSchedule && cronSchedule.trim() ? cronSchedule.trim() : "0 0 * * 0";
-    const response = await this.request(`/monitors?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/monitors?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         monitor: {
@@ -25393,7 +25469,7 @@ var PostmanAssetsClient = class {
     return uid;
   }
   async createMock(workspaceId, name, collectionUid, environmentUid) {
-    const response = await this.request(`/mocks?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/mocks?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         mock: {

package/dist/cli.cjs

@@ -9183,14 +9183,14 @@ var require_retry_agent = __commonJS({
         this.#options = options;
       }
       dispatch(opts, handler) {
-        const retry = new RetryHandler({
+        const retry2 = new RetryHandler({
           ...opts,
           retryOptions: this.#options
         }, {
           dispatch: this.#agent.dispatch.bind(this.#agent),
           handler
         });
-        return this.#agent.dispatch(opts, retry);
+        return this.#agent.dispatch(opts, retry2);
       }
       close() {
         return this.#agent.close();
@@ -23385,12 +23385,60 @@ var postmanRepoSyncActionContract = {
   }
 };
 
+// src/lib/retry.ts
+function sleep(delayMs) {
+  return new Promise((resolve2) => {
+    setTimeout(resolve2, delayMs);
+  });
+}
+function normalizeRetryOptions(options) {
+  return {
+    maxAttempts: Math.max(1, options.maxAttempts ?? 3),
+    delayMs: Math.max(0, options.delayMs ?? 2e3),
+    backoffMultiplier: Math.max(1, options.backoffMultiplier ?? 1),
+    maxDelayMs: options.maxDelayMs === void 0 ? Number.POSITIVE_INFINITY : Math.max(0, options.maxDelayMs),
+    onRetry: options.onRetry ?? (async () => void 0),
+    shouldRetry: options.shouldRetry ?? (() => true),
+    sleep: options.sleep ?? sleep
+  };
+}
+async function retry(operation, options = {}) {
+  const normalized = normalizeRetryOptions(options);
+  let nextDelayMs = normalized.delayMs;
+  for (let attempt = 1; attempt <= normalized.maxAttempts; attempt += 1) {
+    try {
+      return await operation();
+    } catch (error) {
+      const shouldRetry = attempt < normalized.maxAttempts && normalized.shouldRetry(error, {
+        attempt,
+        maxAttempts: normalized.maxAttempts
+      });
+      if (!shouldRetry) {
+        throw error;
+      }
+      await normalized.onRetry({
+        attempt,
+        maxAttempts: normalized.maxAttempts,
+        delayMs: nextDelayMs,
+        error
+      });
+      await normalized.sleep(nextDelayMs);
+      nextDelayMs = Math.min(
+        normalized.maxDelayMs,
+        Math.round(nextDelayMs * normalized.backoffMultiplier)
+      );
+    }
+  }
+  throw new Error("Retry exhausted without returning or throwing");
+}
+
 // src/lib/postman/postman-assets-client.ts
 var PostmanAssetsClient = class {
   apiKey;
   baseUrl;
   bifrostBaseUrl;
   fetchImpl;
+  retrySleep;
   constructor(options) {
     this.apiKey = String(options.apiKey || "").trim();
     this.baseUrl = String(options.baseUrl || POSTMAN_ENDPOINT_PROFILES.prod.apiBaseUrl).replace(
@@ -23401,6 +23449,7 @@ var PostmanAssetsClient = class {
       options.bifrostBaseUrl || POSTMAN_ENDPOINT_PROFILES.prod.bifrostBaseUrl
     ).replace(/\/+$/, "");
     this.fetchImpl = options.fetchImpl ?? fetch;
+    this.retrySleep = options.retrySleep;
     void (options.secretMasker ?? createSecretMasker([this.apiKey]));
   }
   getBaseUrl() {
@@ -23464,9 +23513,36 @@ var PostmanAssetsClient = class {
       })
     });
   }
+  /**
+   * Monitor and mock creation reference a collection that may have been
+   * created moments earlier; the Postman backend is eventually consistent
+   * and can reject the reference with a 400 "Unable to load collection"
+   * until the collection becomes visible. Retry only that specific 400 and
+   * 429 throttling: both guarantee nothing was created. A 5xx on these
+   * non-idempotent creates is ambiguous (the asset may exist server-side),
+   * so it is not retried to avoid duplicate mocks and monitors.
+   */
+  async requestWithCollectionRetry(path4, init) {
+    return retry(() => this.request(path4, init), {
+      maxAttempts: 5,
+      delayMs: 2e3,
+      backoffMultiplier: 2,
+      maxDelayMs: 15e3,
+      ...this.retrySleep ? { sleep: this.retrySleep } : {},
+      shouldRetry: (error) => {
+        if (!(error instanceof HttpError)) {
+          return false;
+        }
+        if (error.status === 429) {
+          return true;
+        }
+        return error.status === 400 && /unable to load collection/i.test(error.responseBody);
+      }
+    });
+  }
   async createMonitor(workspaceId, name, collectionUid, environmentUid, cronSchedule) {
     const effectiveCron = cronSchedule && cronSchedule.trim() ? cronSchedule.trim() : "0 0 * * 0";
-    const response = await this.request(`/monitors?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/monitors?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         monitor: {
@@ -23496,7 +23572,7 @@ var PostmanAssetsClient = class {
     return uid;
   }
   async createMock(workspaceId, name, collectionUid, environmentUid) {
-    const response = await this.request(`/mocks?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/mocks?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         mock: {

package/dist/index.cjs

@@ -9183,14 +9183,14 @@ var require_retry_agent = __commonJS({
         this.#options = options;
       }
       dispatch(opts, handler) {
-        const retry = new RetryHandler({
+        const retry2 = new RetryHandler({
           ...opts,
           retryOptions: this.#options
         }, {
           dispatch: this.#agent.dispatch.bind(this.#agent),
           handler
         });
-        return this.#agent.dispatch(opts, retry);
+        return this.#agent.dispatch(opts, retry2);
       }
       close() {
         return this.#agent.close();
@@ -25297,12 +25297,60 @@ var postmanRepoSyncActionContract = {
   }
 };
 
+// src/lib/retry.ts
+function sleep(delayMs) {
+  return new Promise((resolve3) => {
+    setTimeout(resolve3, delayMs);
+  });
+}
+function normalizeRetryOptions(options) {
+  return {
+    maxAttempts: Math.max(1, options.maxAttempts ?? 3),
+    delayMs: Math.max(0, options.delayMs ?? 2e3),
+    backoffMultiplier: Math.max(1, options.backoffMultiplier ?? 1),
+    maxDelayMs: options.maxDelayMs === void 0 ? Number.POSITIVE_INFINITY : Math.max(0, options.maxDelayMs),
+    onRetry: options.onRetry ?? (async () => void 0),
+    shouldRetry: options.shouldRetry ?? (() => true),
+    sleep: options.sleep ?? sleep
+  };
+}
+async function retry(operation, options = {}) {
+  const normalized = normalizeRetryOptions(options);
+  let nextDelayMs = normalized.delayMs;
+  for (let attempt = 1; attempt <= normalized.maxAttempts; attempt += 1) {
+    try {
+      return await operation();
+    } catch (error2) {
+      const shouldRetry = attempt < normalized.maxAttempts && normalized.shouldRetry(error2, {
+        attempt,
+        maxAttempts: normalized.maxAttempts
+      });
+      if (!shouldRetry) {
+        throw error2;
+      }
+      await normalized.onRetry({
+        attempt,
+        maxAttempts: normalized.maxAttempts,
+        delayMs: nextDelayMs,
+        error: error2
+      });
+      await normalized.sleep(nextDelayMs);
+      nextDelayMs = Math.min(
+        normalized.maxDelayMs,
+        Math.round(nextDelayMs * normalized.backoffMultiplier)
+      );
+    }
+  }
+  throw new Error("Retry exhausted without returning or throwing");
+}
+
 // src/lib/postman/postman-assets-client.ts
 var PostmanAssetsClient = class {
   apiKey;
   baseUrl;
   bifrostBaseUrl;
   fetchImpl;
+  retrySleep;
   constructor(options) {
     this.apiKey = String(options.apiKey || "").trim();
     this.baseUrl = String(options.baseUrl || POSTMAN_ENDPOINT_PROFILES.prod.apiBaseUrl).replace(
@@ -25313,6 +25361,7 @@ var PostmanAssetsClient = class {
       options.bifrostBaseUrl || POSTMAN_ENDPOINT_PROFILES.prod.bifrostBaseUrl
     ).replace(/\/+$/, "");
     this.fetchImpl = options.fetchImpl ?? fetch;
+    this.retrySleep = options.retrySleep;
     void (options.secretMasker ?? createSecretMasker([this.apiKey]));
   }
   getBaseUrl() {
@@ -25376,9 +25425,36 @@ var PostmanAssetsClient = class {
       })
     });
   }
+  /**
+   * Monitor and mock creation reference a collection that may have been
+   * created moments earlier; the Postman backend is eventually consistent
+   * and can reject the reference with a 400 "Unable to load collection"
+   * until the collection becomes visible. Retry only that specific 400 and
+   * 429 throttling: both guarantee nothing was created. A 5xx on these
+   * non-idempotent creates is ambiguous (the asset may exist server-side),
+   * so it is not retried to avoid duplicate mocks and monitors.
+   */
+  async requestWithCollectionRetry(path8, init) {
+    return retry(() => this.request(path8, init), {
+      maxAttempts: 5,
+      delayMs: 2e3,
+      backoffMultiplier: 2,
+      maxDelayMs: 15e3,
+      ...this.retrySleep ? { sleep: this.retrySleep } : {},
+      shouldRetry: (error2) => {
+        if (!(error2 instanceof HttpError)) {
+          return false;
+        }
+        if (error2.status === 429) {
+          return true;
+        }
+        return error2.status === 400 && /unable to load collection/i.test(error2.responseBody);
+      }
+    });
+  }
   async createMonitor(workspaceId, name, collectionUid, environmentUid, cronSchedule) {
     const effectiveCron = cronSchedule && cronSchedule.trim() ? cronSchedule.trim() : "0 0 * * 0";
-    const response = await this.request(`/monitors?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/monitors?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         monitor: {
@@ -25408,7 +25484,7 @@ var PostmanAssetsClient = class {
     return uid;
   }
   async createMock(workspaceId, name, collectionUid, environmentUid) {
-    const response = await this.request(`/mocks?workspace=${workspaceId}`, {
+    const response = await this.requestWithCollectionRetry(`/mocks?workspace=${workspaceId}`, {
       method: "POST",
       body: JSON.stringify({
         mock: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postman-cse/onboarding-repo-sync",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Public customer preview Postman repo sync GitHub Action.",
   "type": "module",
   "main": "dist/index.cjs",