@nodaro/sdk 2.21.1 → 2.24.0

package/dist/index.js

@@ -1027,10 +1027,14 @@ var CharactersResource = class {
   /**
    * Fetch a single character including in-flight portrait / asset job state.
    * Soft-deleted (archived) rows are returned by id intentionally so canvas
-   * nodes that hold a stale `characterDbId` keep loading.
+   * nodes that hold a stale `characterDbId` keep loading. Pass
+   * `{ candidates: "all" }` to also get the current portrait's own take in
+   * `previousCandidates` (flagged `isPortrait: true`).
    */
-  get(id) {
-    return this.client.request("GET", `/v1/characters/${encodeURIComponent(id)}`);
+  get(id, options = {}) {
+    const query = {};
+    if (options.candidates) query.candidates = options.candidates;
+    return this.client.request("GET", `/v1/characters/${encodeURIComponent(id)}`, { query });
   }
   /**
    * Create or update a character. Omit `id` to create; supply it to update
@@ -1101,8 +1105,8 @@ var CharactersResource = class {
    * is enqueued — mid-batch failures roll back atomically.
    *
    * When `attachToCharacterId` is set, the worker writes the result directly
-   * to the row's `source_image_url`; otherwise you must call
-   * `approvePortrait()` after picking a candidate.
+   * to the row's `source_image_url` (unless `attachPortrait: false`);
+   * otherwise you must call `approvePortrait()` after picking a candidate.
    */
   generate(input) {
     return this.client.request("POST", "/v1/generate-character", { body: input });
@@ -2425,6 +2429,32 @@ var MediaResource = class {
   videoOverlay(input) {
     return this.client.request("POST", "/v1/video-overlay", { body: input });
   }
+  /**
+   * Track a subject described in plain text through a video and get a
+   * black-and-white MASK VIDEO back (`POST /v1/video-mask`, SAM 3.1 by default,
+   * or `provider: "sam-3"` at half the price) — white = the subject. Clips up
+   * to 5 minutes at 30 fps (a faster clip counts
+   * proportionally longer), priced by the clip's length. Poll
+   * `jobs.get(jobId)`: the output carries `videoUrl` (the mask), `width`,
+   * `height`, `frames` and `coverage` (the fraction of pixels selected). Feed
+   * the mask to {@link MediaResource.maskComposite}.
+   */
+  videoMask(input) {
+    return this.client.request("POST", "/v1/video-mask", { body: input });
+  }
+  /**
+   * Place a foreground video over a background video through a mask video
+   * (`POST /v1/mask-composite`; white = foreground) — local FFmpeg, no AI.
+   * The result follows the foreground's size, frame rate and length; the
+   * background is fitted (`backgroundFit`, default cover) and loops when
+   * shorter; the mask holds its last frame when shorter. Optional
+   * `invertMask`, `feather` (0–20 px), `grow` (−10–10 px) and `audioSource`
+   * (foreground / background / mix / none). Priced per started 5 seconds of
+   * the result (foreground up to 300 s). Poll `jobs.get(jobId)` for `videoUrl`.
+   */
+  maskComposite(input) {
+    return this.client.request("POST", "/v1/mask-composite", { body: input });
+  }
   /**
    * Probe a social video's metadata (`POST /v1/video-metadata`) — duration,
    * dimensions, title, live status — WITHOUT downloading it. A direct read, not a
@@ -2496,6 +2526,16 @@ var AudioResource = class {
   adjustVolume(input) {
     return this.client.request("POST", "/v1/adjust-volume", { body: input });
   }
+  /**
+   * Shift pitch and/or change tempo with Rubber Band (`POST /v1/pitch-tempo`):
+   * `semitones` −12…+12 (default 0), `tempo` 0.5…2 with the pitch kept
+   * (default 1; fixed at 1 for a video), `preserveFormants` (default true).
+   * Provide exactly one of `audioUrl` or `videoUrl` — a video keeps its picture.
+   * Input up to 30 minutes, priced per started minute.
+   */
+  pitchTempo(input) {
+    return this.client.request("POST", "/v1/pitch-tempo", { body: input });
+  }
   /**
    * Concatenate audio segments end-to-end (`POST /v1/combine-audio`). Each
    * segment is a `url` with an optional `[startTime, endTime]` sub-range.
@@ -2724,10 +2764,44 @@ var CollectionsResource = class {
   async delete(id) {
     await this.client.request("DELETE", `/v1/collections/${encodeURIComponent(id)}`);
   }
-  /** `GET /v1/collections/:id/records` → the records, newest first. Narrow with `q` (words) and `since` (ISO); page with `cursor` / `limit` (1-100, default 50). */
+  /**
+   * `GET /v1/collections/:id/records` → the records, newest first (`order: "oldest"`
+   * flips it). Narrow with `q` (words), `since` / `until` (ISO) and `usage`
+   * (`all`, `unused` — not used yet — or `used`); page with `cursor` / `limit`
+   * (1-100, default 50). Each record carries `usedAt` / `usedBy`, and its
+   * `source` the saving workflow's name and project when it is yours.
+   */
   records(id, params = {}) {
     return this.client.request("GET", `/v1/collections/${encodeURIComponent(id)}/records`, {
-      query: { q: params.q, since: params.since, cursor: params.cursor, limit: params.limit }
+      query: {
+        q: params.q,
+        since: params.since,
+        until: params.until,
+        usage: params.usage,
+        status: params.status,
+        order: params.order,
+        cursor: params.cursor,
+        offset: params.offset,
+        limit: params.limit
+      }
+    });
+  }
+  /** `POST /v1/collections/:id/records/:recordId/restore` → bring a record back from the Trash; the record. */
+  restoreRecord(id, recordId) {
+    return this.client.request("POST", `/v1/collections/${encodeURIComponent(id)}/records/${encodeURIComponent(recordId)}/restore`);
+  }
+  /** `POST /v1/collections/:id/records/bulk` → move up to 100 records to the Trash, bring them back, or delete records already in the Trash for good, in one call. */
+  bulkRecords(id, input) {
+    return this.client.request("POST", `/v1/collections/${encodeURIComponent(id)}/records/bulk`, { body: input });
+  }
+  /**
+   * `PATCH /v1/collections/:id/records/:recordId` → mark a record used (or not
+   * used again). `source` says who is marking it (defaults to the API). A
+   * server before the usage release answers `503 not_available`.
+   */
+  setUsed(id, recordId, used, source) {
+    return this.client.request("PATCH", `/v1/collections/${encodeURIComponent(id)}/records/${encodeURIComponent(recordId)}`, {
+      body: { used, ...source ? { source } : {} }
     });
   }
   /**
@@ -2743,17 +2817,22 @@ var CollectionsResource = class {
       ...opts.idempotencyKey ? { headers: { "Idempotency-Key": opts.idempotencyKey } } : {}
     });
   }
-  /** `DELETE /v1/collections/:id/records/:recordId` → remove one record. */
+  /**
+   * `DELETE /v1/collections/:id/records/:recordId` → the record moves to the
+   * collection's Trash (`restoreRecord` brings it back; `deleteRecordForever`
+   * removes it for good).
+   */
   async deleteRecord(id, recordId) {
-    await this.client.request(
-      "DELETE",
-      `/v1/collections/${encodeURIComponent(id)}/records/${encodeURIComponent(recordId)}`
-    );
+    await this.client.request("DELETE", `/v1/collections/${encodeURIComponent(id)}/records/${encodeURIComponent(recordId)}`);
+  }
+  /** `DELETE /v1/collections/:id/records/:recordId/permanent` → a record already in the Trash is deleted for good (`409 not_in_trash` for a live one). */
+  async deleteRecordForever(id, recordId) {
+    await this.client.request("DELETE", `/v1/collections/${encodeURIComponent(id)}/records/${encodeURIComponent(recordId)}/permanent`);
   }
-  /** `GET /v1/collections/:id/export` → the whole collection as CSV (default) or JSON text, newest first; `since` and `q` narrow it. */
+  /** `GET /v1/collections/:id/export` → the whole collection as CSV (default) or JSON text, newest first; `since`, `until`, `usage` and `q` narrow it. */
   export(id, params = {}) {
     return this.client.requestText("GET", `/v1/collections/${encodeURIComponent(id)}/export`, {
-      query: { format: params.format, since: params.since, q: params.q }
+      query: { format: params.format, since: params.since, until: params.until, usage: params.usage, q: params.q }
     });
   }
 };
@@ -3975,7 +4054,7 @@ var EditResource = class {
     return remapTranscriptThroughEdl(edl, transcript);
   }
 };
-var SDK_VERSION = "2.21.1" ;
+var SDK_VERSION = "2.24.0" ;
 var CLIENT_HEADER = "X-Nodaro-Client";
 var isBrowser = () => typeof window !== "undefined" && typeof window.document !== "undefined";
 var NodaroClient = class _NodaroClient {