@viu/emporix-sdk 4.2.0 → 4.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @viu/emporix-sdk
2
2
 
3
+ ## 4.2.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#372](https://github.com/viuteam/emporix-sdk/pull/372) [`b89a81a`](https://github.com/viuteam/emporix-sdk/commit/b89a81a9eed1cdbf781757d5e5f09820f6cb04af) Thanks [@amnael1](https://github.com/amnael1)! - docs(sdk): document published mappings and aborted import runs
8
+
9
+ The import types and `triggerRun` / `retryRun` now describe the Import Service change of 2026-09-28, which the types already carried: a run executes each stream's published mappings, a dry run checks the drafts with `mappings: "draft"`, and runs report `mappingVersions` and `dryRunPublished`. They also name the trap that came with it — a run refused for never-published mappings still resolves with `200` and only then finishes `ABORTED`, so read the run back before treating it as started.
10
+
3
11
  ## 4.2.0
4
12
 
5
13
  ### Minor Changes
package/dist/index.cjs CHANGED
@@ -1242,7 +1242,7 @@ var HttpClient = class {
1242
1242
  };
1243
1243
 
1244
1244
  // package.json
1245
- var version = "4.2.0";
1245
+ var version = "4.2.2";
1246
1246
 
1247
1247
  // src/version.ts
1248
1248
  var SDK_VERSION = version;
@@ -8577,6 +8577,19 @@ var ImportService = class {
8577
8577
  * `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
8578
8578
  * and note it takes ids where {@link getStreamOrder} reports names.
8579
8579
  *
8580
+ * A run executes each stream's **published** mappings. Publishing needs
8581
+ * `importtool.import_manage` and is not part of the public API, so it happens
8582
+ * in the Management Dashboard's Import Tool rather than through this SDK; a dry
8583
+ * run with `mappings: "draft"` checks unpublished changes first. A stream whose
8584
+ * mappings were never published is `ABORTED` in the run details, and the run
8585
+ * finishes `PARTIAL`.
8586
+ *
8587
+ * **A refused run still resolves.** When `streamIds` names such a stream, or
8588
+ * every enabled stream is in that state, the service answers `200` with the
8589
+ * run anyway, and the run then finishes `ABORTED` with a `message` naming the
8590
+ * streams. Read it back with {@link getRun}, or follow it with
8591
+ * {@link streamRun}, before treating a resolved call as a started import.
8592
+ *
8580
8593
  * Not retried on a 5xx: a POST that timed out may already have queued a run.
8581
8594
  *
8582
8595
  * @example
@@ -8819,7 +8832,8 @@ var ImportService = class {
8819
8832
  *
8820
8833
  * Returns a **new** run — the retry is its own run with `retry: true`, not a
8821
8834
  * mutation of the original. Poll it with {@link getRun} or follow it with
8822
- * {@link streamRun} exactly as you would a triggered run.
8835
+ * {@link streamRun} exactly as you would a triggered run. Like one, it runs the
8836
+ * published mappings and can finish `ABORTED`.
8823
8837
  *
8824
8838
  * Not retried on a 5xx, for the same reason {@link triggerRun} is not: a POST
8825
8839
  * that timed out may already have queued the retry.