@nodaro/sdk 2.34.0 → 2.39.0

package/dist/entries/trends.d.ts

@@ -0,0 +1,295 @@
+import { N as NodaroClientCore } from '../developer-apps-zSQXWmEG.js';
+import '@nodaro/shared/apps';
+import '@nodaro/shared/organizations';
+
+/** What a slot holds. */
+type TrendSlotKind = "person" | "location" | "product" | "pet";
+/** A chip: make this trait anew from your pictures (`"new"`), or keep the clip's (`"original"`). */
+type TrendChoice = "new" | "original";
+/**
+ * The chips a slot can take, by its kind: a person `body` / `outfit` / `hair`,
+ * a pet `body` / `coat`, a product `shape` / `finish`, a location none.
+ */
+interface TrendChips {
+    body?: TrendChoice;
+    outfit?: TrendChoice;
+    hair?: TrendChoice;
+    coat?: TrendChoice;
+    shape?: TrendChoice;
+    finish?: TrendChoice;
+}
+type TrendResolution = "480p" | "720p" | "1080p";
+/** A trend in the catalog (`list()`). Text is in the resolved locale. */
+interface TrendCard {
+    id: string;
+    slug: string;
+    name: string;
+    description?: string;
+    tags: string[];
+    /** e.g. `"trending"`, `"new"`. */
+    badges: string[];
+    /** The trend's first example (never the clip it recasts). */
+    cover: {
+        videoUrl: string;
+        posterUrl?: string;
+        width: number;
+        height: number;
+    };
+    /** How many slots of each kind the trend has. */
+    needs: Record<TrendSlotKind, number>;
+    /** The length of a full run, in seconds. */
+    durationSec: number;
+    isFavorite: boolean;
+}
+/** One slot of a trend: what it asks you for. */
+interface TrendDetailSlot {
+    /** The key to fill in {@link TrendRunRequest.slots}, and to mention in `details` as `{slot:<key>}`. */
+    key: string;
+    label: string;
+    kind: TrendSlotKind;
+    /** A required slot needs pictures; an optional one left empty takes the chosen example's. */
+    required: boolean;
+    hint?: string;
+    /** The chips this slot starts with (only its kind's own). */
+    defaults?: TrendChips;
+}
+/** A finished run shown on a trend's page, with the pictures it used per slot. */
+interface TrendExample {
+    videoUrl: string;
+    posterUrl?: string;
+    width: number;
+    height: number;
+    /** Slot key → the pictures this example used for it. */
+    slots: Record<string, string[]>;
+}
+/** A trend's page (`get()`). */
+interface TrendDetail extends TrendCard {
+    /** The published version this page shows. */
+    version: number;
+    /** `4` when the trend offers a 4-second preview run, else `null`. */
+    previewSec: 4 | null;
+    resolutions: TrendResolution[];
+    slots: TrendDetailSlot[];
+    examples: TrendExample[];
+}
+/** What you put in one slot of a run: 1–3 pictures, and the chips of the slot's kind. */
+interface TrendRunSlot extends TrendChips {
+    images?: string[];
+}
+/** The body of `estimate()` and `run()`. */
+interface TrendRunRequest {
+    /**
+     * Slot key → what you put in it. Every required slot needs pictures; an
+     * optional slot left out takes the chosen example's. 1–3 pictures per slot.
+     */
+    slots: Record<string, TrendRunSlot>;
+    /** 1-based example whose pictures fill the optional slots you leave empty. Default 1. */
+    example?: number;
+    /** Your own words, at most 1,000 characters. Mention a slot as `{slot:<key>}`. */
+    details?: string;
+    /** `true` runs a 4-second preview (only when the trend's `previewSec` is `4`). */
+    preview?: boolean;
+    /** Default `"480p"`. */
+    resolution?: TrendResolution;
+    /** A draft run, only at 480p. Default `true` at 480p. */
+    draft?: boolean;
+    /**
+     * A generation session of yours. Accepted (and checked: one you may not use
+     * is a 404), but not yet applied: trend runs are not filed into sessions yet.
+     */
+    sessionId?: string;
+    /** Accepted, but not used by the run today. */
+    projectId?: string;
+    /**
+     * A full run's own preview: the `jobId` of a completed preview run of this
+     * trend that you started. When the trend masks faces only as needed and that
+     * preview needed it, the full run masks them from the start (the quote
+     * includes it). Any other job is ignored, without an error. Must be a uuid
+     * (else 400 `validation_error`).
+     */
+    previewJobId?: string;
+    /**
+     * `run()`: your client app's slug (e.g. `"tools"`: lowercase letters,
+     * digits and `-`, 1–40 characters, starting with a letter or digit), as on
+     * any job: the run's job carries it as `input_data.origin`, so
+     * `client.jobs.list({ origin })` finds it. Not a slug is a 400
+     * `validation_error`; without it the run has no origin. `estimate()`
+     * ignores it.
+     */
+    origin?: string;
+}
+/** What a run would cost, in credits (`estimate()`). */
+interface TrendEstimate {
+    /** The charge the run is expected to come to. */
+    expectedCredits: number;
+    /** What is reserved when the run starts; the run is charged what it actually costs. */
+    holdCredits: number;
+    /**
+     * The parts of the quote, by name. With `maskingCredits`, `masking` is
+     * listed here too but is not part of `holdCredits` or `expectedCredits`.
+     */
+    breakdown: Record<string, number>;
+    /**
+     * Only for a trend that masks faces only as needed: the extra credits
+     * charged if the video model refuses the clip and the run is retried with
+     * the faces masked. Not included in `expectedCredits` or `holdCredits`.
+     */
+    maskingCredits?: number;
+}
+/** Per-call options for {@link TrendsResource.run}. */
+interface TrendRunOptions {
+    /**
+     * Sent as the `Idempotency-Key` header, unchanged (an empty string sends no
+     * header). The server takes 8–200 characters and answers 400 for any other
+     * length. Reuse it when retrying the same run.
+     */
+    idempotencyKey?: string;
+}
+/** One slot of a past run, as it was run. Labels are English. */
+interface TrendRunDisplaySlot extends TrendChips {
+    key: string;
+    label: string;
+    kind: TrendSlotKind;
+    images: string[];
+    /** `true` when the slot was left empty and the example's pictures filled it. */
+    fromExample: boolean;
+}
+/**
+ * One of your trend runs (`runs()`, `getRun()`). Stays readable after the
+ * trend moves on or is unpublished.
+ *
+ * A Full Quality version of a draft is a run of its own, with its own status,
+ * result and charge: `fullQualityOf` names the draft it was made from, and it
+ * stays listed after that draft is deleted.
+ */
+interface TrendRun {
+    jobId: string;
+    status: string;
+    progress: number | null;
+    /**
+     * Why a failed or cancelled run did not finish; `null` otherwise. `code` is
+     * `safety-block` or `policy-block` when the job was blocked, `credits` when
+     * it ran out of credits partway (it was refunded: ask the person to top up,
+     * then run it again), else `cancelled` or `failed`. `message` is the same
+     * fixed sentence for every code — branch on `code`, not on the text.
+     */
+    error: {
+        code?: string;
+        message: string;
+    } | null;
+    createdAt: string;
+    completedAt: string | null;
+    /** The trend and version it ran (name in English). */
+    trend: {
+        id: string;
+        slug: string;
+        version: number;
+        name: string;
+    };
+    /** The 1-based example used for empty optional slots. */
+    example: number;
+    slots: TrendRunDisplaySlot[];
+    details?: string;
+    preview: boolean;
+    resolution: string;
+    draft: boolean;
+    /** The result, once completed. */
+    videoUrl: string | null;
+    posterUrl: string | null;
+    creditsCharged: number | null;
+    /** A Full Quality version: the job id of the draft run it was made from. `null` for any other run. */
+    fullQualityOf: string | null;
+    /**
+     * A draft's newest Full Quality try, if one was started: a pointer only,
+     * to know an upgrade exists and how it is going. Its video and charge are on
+     * that run, listed on its own (its `fullQualityOf` is this run's `jobId`) —
+     * read it there (`getRun(fullQuality.jobId)`). Older tries of the draft (a
+     * failed or cancelled one tried again) are not listed by `runs()`;
+     * `getRun()` still reads one by its id.
+     */
+    fullQuality: {
+        jobId: string;
+        status: string;
+    } | null;
+    /** Until when a completed draft can be redone in Full Quality; `null` otherwise. */
+    fullQualityUntil: string | null;
+}
+interface ListTrendsParams {
+    /** Search text. */
+    q?: string;
+    tag?: string;
+    /** `true` lists only your favorites. */
+    favorites?: boolean;
+    /** A platform language for names and descriptions; default your profile's, then English. */
+    locale?: string;
+    /** The previous page's `next`. */
+    cursor?: string;
+    /** Page size, 1–60 (server default 30). */
+    limit?: number;
+}
+interface ListTrendRunsParams {
+    /** Only runs of this trend (its slug). */
+    trend?: string;
+    /** The previous page's `next`. */
+    cursor?: string;
+    /** Page size, 1–60 (server default 30). */
+    limit?: number;
+}
+/** A tag in use on the published catalog (`tags()`). */
+interface TrendTag {
+    /** The tag itself: pass it as `list({ tag })`. */
+    tag: string;
+    /** The tag's label in the resolved locale; the tag itself when it has none. */
+    label: string;
+    /** How many published trends carry it. */
+    count: number;
+}
+interface TrendPage<T> {
+    data: T[];
+    /** Pass back as `cursor` for the next page; `null` on the last one. */
+    next: string | null;
+}
+declare class TrendsResource {
+    private client;
+    constructor(client: NodaroClientCore);
+    /** The published catalog in its curated order (`GET /v1/trends`), a page at a time. */
+    list(params?: ListTrendsParams): Promise<TrendPage<TrendCard>>;
+    /** A published trend's page (`GET /v1/trends/:slug`). */
+    get(slug: string, params?: {
+        locale?: string;
+    }): Promise<TrendDetail>;
+    /** Quote a run before starting it (`POST /v1/trends/:slug/estimate`); spends nothing. */
+    estimate(slug: string, request: TrendRunRequest): Promise<TrendEstimate>;
+    /**
+     * Start a run (`POST /v1/trends/:slug/runs`, 202). Returns the job to follow.
+     * With `options.idempotencyKey` (sent as the `Idempotency-Key` header) a
+     * repeat with the same key answers with the first run's `jobId`.
+     */
+    run(slug: string, request: TrendRunRequest, options?: TrendRunOptions): Promise<{
+        jobId: string;
+    }>;
+    /**
+     * Your trend runs, newest first (`GET /v1/trends/runs`). A Full Quality
+     * version of a draft is listed as its own run (`fullQualityOf`).
+     */
+    runs(params?: ListTrendRunsParams): Promise<TrendPage<TrendRun>>;
+    /**
+     * One of your trend runs by its job id (`GET /v1/trends/runs/:jobId`), in
+     * the same shape as `runs()`. A job that is not your own trend run is a
+     * `NotFoundError`.
+     */
+    getRun(jobId: string): Promise<TrendRun>;
+    /**
+     * The tags in use on the published catalog, each with its label in the
+     * resolved locale (`GET /v1/trends/tags`), most used first.
+     */
+    tags(params?: {
+        locale?: string;
+    }): Promise<TrendTag[]>;
+    /** Add a trend to your favorites (`PUT /v1/trends/:slug/favorite`). */
+    favorite(slug: string): Promise<void>;
+    /** Remove a trend from your favorites (`DELETE /v1/trends/:slug/favorite`). */
+    unfavorite(slug: string): Promise<void>;
+}
+
+export { type ListTrendRunsParams, type ListTrendsParams, type TrendCard, type TrendChips, type TrendChoice, type TrendDetail, type TrendDetailSlot, type TrendEstimate, type TrendExample, type TrendPage, type TrendResolution, type TrendRun, type TrendRunDisplaySlot, type TrendRunOptions, type TrendRunRequest, type TrendRunSlot, type TrendSlotKind, type TrendTag, TrendsResource };

package/dist/entries/trends.js

@@ -0,0 +1,4 @@
+import '../chunk-YCVRQZT3.js';
+export { TrendsResource } from '../chunk-QGOEQGAE.js';
+//# sourceMappingURL=trends.js.map
+//# sourceMappingURL=trends.js.map

package/dist/entries/trends.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"trends.js"}

package/dist/entries/tutorials.cjs

@@ -1,13 +1,13 @@
 'use strict';
 
 require('../chunk-VLCNNA76.cjs');
-var chunkBRV7Z4GD_cjs = require('../chunk-BRV7Z4GD.cjs');
+var chunkFHVNTS4E_cjs = require('../chunk-FHVNTS4E.cjs');
 
 
 
 Object.defineProperty(exports, "TutorialsResource", {
   enumerable: true,
-  get: function () { return chunkBRV7Z4GD_cjs.TutorialsResource; }
+  get: function () { return chunkFHVNTS4E_cjs.TutorialsResource; }
 });
 //# sourceMappingURL=tutorials.cjs.map
 //# sourceMappingURL=tutorials.cjs.map

package/dist/entries/tutorials.d.cts

@@ -33,6 +33,10 @@ interface TutorialFlowItem {
     complexity: string;
     /** The listed price; when `estimatedPerMinuteCredits` is above 0, its fixed part. */
     estimatedCredits: number;
+    /** The listed price holds a metered LLM call's ESTIMATE (its model's typical
+     *  call, charged its actual usage per token): show it `~N`. Absent for a
+     *  fixed price, and on a deployment running the tier-pricing rollback. */
+    estimatedCreditsIsEstimate?: true;
     /** Credits per minute of the recording the template is given (see `TemplateBrowseCard`); 0 or absent when none. */
     estimatedPerMinuteCredits?: number;
     nodeTypesUsed: string[];

package/dist/entries/tutorials.d.ts

@@ -33,6 +33,10 @@ interface TutorialFlowItem {
     complexity: string;
     /** The listed price; when `estimatedPerMinuteCredits` is above 0, its fixed part. */
     estimatedCredits: number;
+    /** The listed price holds a metered LLM call's ESTIMATE (its model's typical
+     *  call, charged its actual usage per token): show it `~N`. Absent for a
+     *  fixed price, and on a deployment running the tier-pricing rollback. */
+    estimatedCreditsIsEstimate?: true;
     /** Credits per minute of the recording the template is given (see `TemplateBrowseCard`); 0 or absent when none. */
     estimatedPerMinuteCredits?: number;
     nodeTypesUsed: string[];

package/dist/entries/tutorials.js

@@ -1,4 +1,4 @@
 import '../chunk-VT237QF2.js';
-export { TutorialsResource } from '../chunk-DPSMVOM3.js';
+export { TutorialsResource } from '../chunk-YSZM3N7Q.js';
 //# sourceMappingURL=tutorials.js.map
 //# sourceMappingURL=tutorials.js.map

package/dist/entries/uploads.cjs

@@ -1,13 +1,13 @@
 'use strict';
 
 require('../chunk-ZE5RISBZ.cjs');
-var chunkZQQABQMH_cjs = require('../chunk-ZQQABQMH.cjs');
+var chunkJTOEHQQJ_cjs = require('../chunk-JTOEHQQJ.cjs');
 
 
 
 Object.defineProperty(exports, "UploadsResource", {
   enumerable: true,
-  get: function () { return chunkZQQABQMH_cjs.UploadsResource; }
+  get: function () { return chunkJTOEHQQJ_cjs.UploadsResource; }
 });
 //# sourceMappingURL=uploads.cjs.map
 //# sourceMappingURL=uploads.cjs.map

package/dist/entries/uploads.d.cts

@@ -39,6 +39,19 @@ declare class UploadsResource {
      * errors on the usual statuses.
      */
     upload(file: File): Promise<UploadResult>;
+    /**
+     * Store a JSON document (`POST /v1/upload-json`, up to 25 MB) and get its
+     * public URL — e.g. an image editor's design state, passed to
+     * `client.jobs.fromUpload` as `editStateUrl` so the edit can be reopened.
+     * The URL is unguessable but public: never store a secret in it. Creates no
+     * library item.
+     */
+    uploadJson(json: Record<string, unknown> | readonly unknown[]): Promise<UploadJsonResult>;
+}
+/** Result of {@link UploadsResource.uploadJson}. */
+interface UploadJsonResult {
+    /** Public URL of the stored JSON document. */
+    readonly url: string;
 }
 
-export { type UploadResult, UploadsResource };
+export { type UploadJsonResult, type UploadResult, UploadsResource };

package/dist/entries/uploads.d.ts

@@ -39,6 +39,19 @@ declare class UploadsResource {
      * errors on the usual statuses.
      */
     upload(file: File): Promise<UploadResult>;
+    /**
+     * Store a JSON document (`POST /v1/upload-json`, up to 25 MB) and get its
+     * public URL — e.g. an image editor's design state, passed to
+     * `client.jobs.fromUpload` as `editStateUrl` so the edit can be reopened.
+     * The URL is unguessable but public: never store a secret in it. Creates no
+     * library item.
+     */
+    uploadJson(json: Record<string, unknown> | readonly unknown[]): Promise<UploadJsonResult>;
+}
+/** Result of {@link UploadsResource.uploadJson}. */
+interface UploadJsonResult {
+    /** Public URL of the stored JSON document. */
+    readonly url: string;
 }
 
-export { type UploadResult, UploadsResource };
+export { type UploadJsonResult, type UploadResult, UploadsResource };

package/dist/entries/uploads.js

@@ -1,4 +1,4 @@
 import '../chunk-CGNVHN4V.js';
-export { UploadsResource } from '../chunk-T3SYREY4.js';
+export { UploadsResource } from '../chunk-WY4QRJZW.js';
 //# sourceMappingURL=uploads.js.map
 //# sourceMappingURL=uploads.js.map

package/dist/entries/workflows.cjs

@@ -1,13 +1,13 @@
 'use strict';
 
 require('../chunk-45CK55BH.cjs');
-var chunkVGWOIWRQ_cjs = require('../chunk-VGWOIWRQ.cjs');
+var chunkVHSMOBU7_cjs = require('../chunk-VHSMOBU7.cjs');
 
 
 
 Object.defineProperty(exports, "WorkflowsResource", {
   enumerable: true,
-  get: function () { return chunkVGWOIWRQ_cjs.WorkflowsResource; }
+  get: function () { return chunkVHSMOBU7_cjs.WorkflowsResource; }
 });
 //# sourceMappingURL=workflows.cjs.map
 //# sourceMappingURL=workflows.cjs.map

package/dist/entries/workflows.d.cts

@@ -196,6 +196,12 @@ interface RenderFinalQuote {
     inputOverrides: Record<string, Record<string, unknown>>;
     /** Estimated credits; `null` in an edition without credits. */
     estimatedCredits: number | null;
+    /**
+     * Present (`true`) when `estimatedCredits` includes an LLM node's estimate:
+     * an LLM call is charged its actual usage after it runs, so show `~N`.
+     * Absent for a fixed price.
+     */
+    estimatedCreditsIsEstimate?: true;
     /**
      * Whether the payer can cover `estimatedCredits`; `null` in an edition
      * without credits. When `false`, {@link WorkflowsResource.renderFinal} is

package/dist/entries/workflows.d.ts

@@ -196,6 +196,12 @@ interface RenderFinalQuote {
     inputOverrides: Record<string, Record<string, unknown>>;
     /** Estimated credits; `null` in an edition without credits. */
     estimatedCredits: number | null;
+    /**
+     * Present (`true`) when `estimatedCredits` includes an LLM node's estimate:
+     * an LLM call is charged its actual usage after it runs, so show `~N`.
+     * Absent for a fixed price.
+     */
+    estimatedCreditsIsEstimate?: true;
     /**
      * Whether the payer can cover `estimatedCredits`; `null` in an edition
      * without credits. When `false`, {@link WorkflowsResource.renderFinal} is

package/dist/entries/workflows.js

@@ -1,4 +1,4 @@
 import '../chunk-PGYQ754I.js';
-export { WorkflowsResource } from '../chunk-ZXJQSFIA.js';
+export { WorkflowsResource } from '../chunk-JUON5NXA.js';
 //# sourceMappingURL=workflows.js.map
 //# sourceMappingURL=workflows.js.map