@viu/emporix-sdk 3.3.1 → 3.4.1

package/CHANGELOG.md

@@ -1,5 +1,60 @@
 # @viu/emporix-sdk
 
+## 3.4.1
+
+### Patch Changes
+
+- [#325](https://github.com/viuteam/emporix-sdk/pull/325) [`10dc05f`](https://github.com/viuteam/emporix-sdk/commit/10dc05fb1faef990d45ff94615dfe745852165f9) Thanks [@viu-release-bot](https://github.com/apps/viu-release-bot)! - chore(sdk): sync generated types with upstream Emporix API specs
+  
+  Updated services: schema
+
+## 3.4.0
+
+### Minor Changes
+
+- [#320](https://github.com/viuteam/emporix-sdk/pull/320) [`5ec1c0b`](https://github.com/viuteam/emporix-sdk/commit/5ec1c0b1876679d381a48a43b8571309224d7c3a) Thanks [@amnael1](https://github.com/amnael1)! - feat(sdk): add import deleteSchedule and document the new run fields
+
+  Wraps the one operation Emporix added to the Import Service on 2026-09-01
+  ([api-references#509](https://github.com/emporix/api-references/pull/509)) and
+  documents the three request/response fields that came with it.
+  - `client.imports.deleteSchedule(configId)` — remove a configuration's schedule
+    so it runs only when triggered. **Idempotent, and deliberately not gated on
+    the configuration existing**: removing a schedule that is not there resolves
+    just the same, and unlike `setSchedule` the configuration need not still be
+    around. That asymmetry is the point — a schedule left behind by a deleted
+    configuration is precisely what needs removing. Resolves to `void` (`204`).
+
+  The other additions needed no new code, because this package's facade types
+  alias the generated ones — but they did need documenting, since none of them is
+  discoverable from a type:
+  - `triggerRun` accepts `sampleSize` (dry-run only, 1–100, default 25) and the
+    run comes back with `dryRunSample`: the mapped records the import _would_ have
+    written, so a mapping can be previewed without one. Absent on a normal run.
+  - `triggerRun` accepts `origin`, free text naming _what_ asked for the run, and
+    the run echoes it. `trigger` only records `MANUAL` or `SCHEDULED`, so without
+    `origin` a dashboard click and an integration scenario are indistinguishable
+    in the history. **Over 40 characters, or containing control characters, is
+    rejected rather than shortened** — a truncated label in an audit trail is
+    worse than a refused request.
+  - `setSchedule` now documents `400` and `404`. The `400` names the six-field
+    cron trap explicitly: the familiar five-field `"0 * * * *"` is not «hourly»,
+    it is invalid — and the service used to store it and then silently never fire
+    it. The SDK already required six fields, so this is now stated where the call
+    is made rather than only on the type.
+
+  `ImportRun`'s and `ImportRunInput`'s JSDoc were stale by one release and now
+  name every field, including the `duplicateKeys` / `unresolvedParents` source-feed
+  counters — a run can report `SUCCEEDED` with both non-zero, which is exactly why
+  they are worth reading.
+
+  With this the facade covers all 21 operations of the vendored spec.
+
+### Patch Changes
+
+- [#319](https://github.com/viuteam/emporix-sdk/pull/319) [`86d2f64`](https://github.com/viuteam/emporix-sdk/commit/86d2f64843980169ccb9c522f6f50184057c5f64) Thanks [@viu-release-bot](https://github.com/apps/viu-release-bot)! - chore(sdk): sync generated types with upstream Emporix API specs
+
+  Updated services: import-service
+
 ## 3.3.1
 
 ### Patch Changes

package/dist/index.cjs

@@ -1242,7 +1242,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "3.3.1";
+var version = "3.4.1";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -8133,7 +8133,19 @@ var ImportService = class {
     });
     return res ?? null;
   }
-  /** Create or replace a configuration's schedule. */
+  /**
+   * Create or replace a configuration's schedule.
+   *
+   * **`cron` is a six-field Spring expression** (`second minute hour
+   * day-of-month month day-of-week`). The familiar five-field `"0 * * * *"` is
+   * not «hourly» here, it is invalid, and the service answers `400` rather than
+   * storing it — which it used to do, leaving a schedule that silently never
+   * fired.
+   *
+   * A `404` means no configuration with that id, so there is nothing to
+   * schedule. Use {@link deleteSchedule} to clear a schedule that outlived its
+   * configuration.
+   */
   async setSchedule(configId, input, auth2 = SERVICE29) {
     return this.ctx.http.request({
       method: "PUT",
@@ -8142,11 +8154,50 @@ var ImportService = class {
       auth: auth2
     });
   }
+  /**
+   * Remove a configuration's schedule. It then runs only when triggered.
+   *
+   * **Idempotent, and deliberately not gated on the configuration existing.**
+   * Removing a schedule that is not there also resolves — and unlike
+   * {@link setSchedule}, this does not require the configuration to exist. That
+   * is the point: a schedule left behind by a deleted configuration is exactly
+   * what needs removing, so refusing those would leave them with no way out.
+   *
+   * The service answers `204`, so this resolves to `void` rather than to the
+   * removed schedule.
+   */
+  async deleteSchedule(configId, auth2 = SERVICE29) {
+    await this.ctx.http.request({
+      method: "DELETE",
+      path: `${this.base()}/configs/${encodeURIComponent(configId)}/schedule`,
+      auth: auth2
+    });
+  }
   /**
    * Trigger a run. `mode` defaults to `DELTA` server-side; `dryRun: true` maps
    * and validates without writing to the target.
    *
+   * 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
+   * `MANUAL` from `SCHEDULED`, so without it a dashboard click and an
+   * integration scenario are indistinguishable in the history. Note the service
+   * **rejects** an `origin` over 40 characters instead of shortening it.
+   *
    * Not retried on a 5xx: a POST that timed out may already have queued a run.
+   *
+   * @example
+   * ```ts
+   * // Preview the mapping without writing anything.
+   * const run = await client.imports.triggerRun(configId, {
+   *   dryRun: true,
+   *   sampleSize: 5,
+   *   origin: "Dashboard",
+   * });
+   * for (const row of run.dryRunSample ?? []) {
+   *   console.log(row.stream, row.targetType, row.key, row.fields);
+   * }
+   * ```
    */
   async triggerRun(configId, input = {}, auth2 = SERVICE29) {
     return this.ctx.http.request({