@viu/emporix-sdk 4.6.2 → 4.6.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @viu/emporix-sdk
 
+## 4.6.4
+
+### Patch Changes
+
+- [#411](https://github.com/viuteam/emporix-sdk/pull/411) [`bb55ec1`](https://github.com/viuteam/emporix-sdk/commit/bb55ec13a8cf45574d217cf1dffe34dcca7b0353) Thanks [@amnael1](https://github.com/amnael1)! - docs(sdk): sync the import service spec for queued import runs
+  
+  Emporix now queues import runs. `client.imports.triggerRun` and `retryRun` return the run `QUEUED` instead of `RUNNING`, answer `409` while the configuration already has a run `QUEUED`, `RUNNING` or `RESUMABLE`, and no longer answer `429` when `maxConcurrentImports` is reached — the run waits instead. `ImportRun` gains the `RESUMABLE` status, `executionStartedAt`, `queueWaitingFor`, `queuePosition`, `supersededRequests` and `lastRequestedAt`; `startedAt` now means when the run was requested, and `mappingVersions` is absent while a run is queued. `cancelRun` stops a `RESUMABLE` run only with `force: true`. Code that waits for `RUNNING` after triggering a run must accept `QUEUED` too.
+
+## 4.6.3
+
+### Patch Changes
+
+- [#408](https://github.com/viuteam/emporix-sdk/pull/408) [`a9d5398`](https://github.com/viuteam/emporix-sdk/commit/a9d5398a72c196bfe0789d1213e2b14601218ad0) Thanks [@viu-release-bot](https://github.com/apps/viu-release-bot)! - chore(sdk): sync generated types with upstream Emporix API specs
+  
+  Updated services: schema
+
 ## 4.6.2
 
 ### Patch Changes

package/dist/index.cjs

@@ -1244,7 +1244,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "4.6.2";
+var version = "4.6.4";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -8810,6 +8810,12 @@ var ImportService = class {
    * Trigger a run. `mode` defaults to `DELTA` server-side; `dryRun: true` maps
    * and validates without writing to the target.
    *
+   * **The run comes back `QUEUED`, not `RUNNING`.** It starts when a worker is
+   * free, usually within moments, or after one of the tenant's runs finishes when
+   * `maxConcurrentImports` are already executing — no `429` any more. A
+   * configuration holds at most one executing and one queued run: while it has a
+   * run `QUEUED`, `RUNNING` or `RESUMABLE`, this call answers `409`.
+   *
    * A dry run can also hand back what it *would* have written: pass
    * `sampleSize` (1–100, default 25) and read the run's `dryRunSample`. Set
    * `origin` to name what asked for the run — `trigger` only distinguishes
@@ -8902,6 +8908,9 @@ var ImportService = class {
    * with `accepted: false` when the run is unknown or already finished — that is
    * a result, not an error. A state conflict may instead come back as a `409`,
    * which does throw.
+   *
+   * A `QUEUED` run is cancelled at once, with or without `force`. A `RESUMABLE`
+   * run stops only with `force: true`; without it the call answers `409`.
    */
   async cancelRun(runId, opts = {}, auth2 = SERVICE30) {
     const query = {};
@@ -9059,7 +9068,9 @@ var ImportService = class {
     });
   }
   /**
-   * The tenant's import limits and current consumption.
+   * The tenant's import limits and current consumption. `maxConcurrentImports`
+   * caps executing runs only: a run beyond it waits `QUEUED` instead of being
+   * rejected.
    *
    * **Preview upstream**: the contract may change without a major bump.
    */
@@ -9075,8 +9086,10 @@ var ImportService = class {
    *
    * Returns a **new** run — the retry is its own run with `retry: true`, not a
    * mutation of the original. Poll it with {@link getRun} or follow it with
-   * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
-   * published mappings and can finish `ABORTED`.
+   * {@link streamRun} exactly as you would a triggered run. Like one, it comes
+   * back `QUEUED`, answers `409` while the configuration has a run `QUEUED`,
+   * `RUNNING` or `RESUMABLE`, runs the published mappings and can finish
+   * `ABORTED`.
    *
    * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
    * that timed out may already have queued the retry.