@nodaro/sdk 2.68.1 → 2.68.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/dist/{chunk-NWSIWAPR.js → chunk-52V2G7SL.js} +4 -4
- package/dist/{chunk-NWSIWAPR.js.map → chunk-52V2G7SL.js.map} +1 -1
- package/dist/{chunk-YTERACRD.js → chunk-7UOEEYJ2.js} +3 -3
- package/dist/{chunk-YTERACRD.js.map → chunk-7UOEEYJ2.js.map} +1 -1
- package/dist/{chunk-A7WF66S5.cjs → chunk-CGSDEKJL.cjs} +3 -3
- package/dist/{chunk-A7WF66S5.cjs.map → chunk-CGSDEKJL.cjs.map} +1 -1
- package/dist/{chunk-ZXBKFJT5.cjs → chunk-PTH6ZUW3.cjs} +6 -6
- package/dist/{chunk-ZXBKFJT5.cjs.map → chunk-PTH6ZUW3.cjs.map} +1 -1
- package/dist/{chunk-BERWJFXS.cjs → chunk-PUD5U3EN.cjs} +2 -2
- package/dist/chunk-PUD5U3EN.cjs.map +1 -0
- package/dist/{chunk-ZK6OWTRR.js → chunk-U6LEZT5B.js} +2 -2
- package/dist/chunk-U6LEZT5B.js.map +1 -0
- package/dist/entries/characters.d.cts +1 -1
- package/dist/entries/characters.d.ts +1 -1
- package/dist/entries/client.cjs +8 -8
- package/dist/entries/client.d.cts +1 -1
- package/dist/entries/client.d.ts +1 -1
- package/dist/entries/client.js +3 -3
- package/dist/entries/core.cjs +5 -5
- package/dist/entries/core.js +1 -1
- package/dist/entries/creatures.d.cts +1 -1
- package/dist/entries/creatures.d.ts +1 -1
- package/dist/entries/jobs.cjs +2 -2
- package/dist/entries/jobs.d.cts +2 -1
- package/dist/entries/jobs.d.ts +2 -1
- package/dist/entries/jobs.js +1 -1
- package/dist/entries/locations.d.cts +1 -1
- package/dist/entries/locations.d.ts +1 -1
- package/dist/entries/nodes.d.cts +1 -1
- package/dist/entries/nodes.d.ts +1 -1
- package/dist/entries/objects.d.cts +1 -1
- package/dist/entries/objects.d.ts +1 -1
- package/dist/entries/scene3d.d.cts +2 -2
- package/dist/entries/scene3d.d.ts +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -3
- package/dist/{nodes-jZXX1czC.d.cts → nodes-BYgAjPlF.d.cts} +10 -3
- package/dist/{nodes-CIpUs2HP.d.ts → nodes-DC80OcWe.d.ts} +10 -3
- package/package.json +2 -2
- package/dist/chunk-BERWJFXS.cjs.map +0 -1
- package/dist/chunk-ZK6OWTRR.js.map +0 -1
package/dist/index.js
CHANGED
|
@@ -55,7 +55,7 @@ import './chunk-M6Y5TOYE.js';
|
|
|
55
55
|
import './chunk-KARJ7P7Y.js';
|
|
56
56
|
import './chunk-SUCHGNYT.js';
|
|
57
57
|
import './chunk-SLPD47SR.js';
|
|
58
|
-
export { NodaroClient, createClient } from './chunk-
|
|
58
|
+
export { NodaroClient, createClient } from './chunk-52V2G7SL.js';
|
|
59
59
|
export { WebhooksResource } from './chunk-YN6CBIIB.js';
|
|
60
60
|
export { WorkflowsResource } from './chunk-33HT46A3.js';
|
|
61
61
|
export { WorkspacesResource } from './chunk-Z5GLY4R3.js';
|
|
@@ -95,7 +95,7 @@ export { DeveloperAppsResource } from './chunk-65E3JBFZ.js';
|
|
|
95
95
|
export { CLIP_PACK_MAX_TARGET_SEC, CLIP_PACK_MIN_TARGET_SEC, EditResource, TRAILER_FORMATS, USE_CASE_NODE_TYPES } from './chunk-VGY3WBNY.js';
|
|
96
96
|
export { ExecutionsResource, OUTPUT_BEARING_NODE_STATUSES, nodeStateMayCarryOutput } from './chunk-22XXTB2R.js';
|
|
97
97
|
export { GalleryResource } from './chunk-MC77SD42.js';
|
|
98
|
-
export { JobsResource } from './chunk-
|
|
98
|
+
export { JobsResource } from './chunk-U6LEZT5B.js';
|
|
99
99
|
export { KEEPER_KINDS, KeepersResource } from './chunk-MQWZFWHE.js';
|
|
100
100
|
export { LibraryResource } from './chunk-GG7DOKTH.js';
|
|
101
101
|
export { CollectionsResource } from './chunk-4WRDR4GN.js';
|
|
@@ -104,7 +104,7 @@ export { CompetitorsResource } from './chunk-BU5A6K4C.js';
|
|
|
104
104
|
export { ContentRightsResource } from './chunk-HAS6PMQN.js';
|
|
105
105
|
export { CopilotResource } from './chunk-CCXY4ZJM.js';
|
|
106
106
|
import './chunk-SZ67PDKE.js';
|
|
107
|
-
export { CallbackAuth, NodaroClientCore, StaticTokenAuth, supabaseAuth } from './chunk-
|
|
107
|
+
export { CallbackAuth, NodaroClientCore, StaticTokenAuth, supabaseAuth } from './chunk-7UOEEYJ2.js';
|
|
108
108
|
export { AlreadyRunningError, AppRunVersionChangedError, CREDIT_CAP_CODES, ContinuationPreviewPendingError, ContinuationRefusedError, CreditCapExceededError, ForbiddenError, IMPORT_REFUSAL_CODES, ImportRefusedError, InsufficientCreditsError, JobAbortedError, JobBlockedError, JobFailedError, JobHeldError, JobTimeoutError, MODEL_UNAVAILABLE_CODES, ModelUnavailableError, NodaroError, NotFoundError, RateLimitedError, StorageExceededError, StudioOpError, StudioPreviewAppliedError, StudioPreviewUnavailable, UnauthorizedError, WorkflowConflictError, throwFromResponse } from './chunk-IJAJTVEW.js';
|
|
109
109
|
export { OBJECT_ASPECT_DEFAULTS as CREATURE_ASPECT_DEFAULTS, OBJECT_ASPECT_OPTIONS as CREATURE_ASPECT_OPTIONS, CREATURE_ASSET_TYPES, CREATURE_ATTACH_COLUMNS, CreaturesResource } from './chunk-HUYI5G3D.js';
|
|
110
110
|
export { CreditsResource } from './chunk-F3AV3TC7.js';
|
|
@@ -357,9 +357,16 @@ interface ImageToImageParams extends GenerationSessionParams {
|
|
|
357
357
|
/** 0–30: prompt adherence (taken by the models in `GUIDANCE_SCALE_SUPPORT`). */
|
|
358
358
|
guidanceScale?: number;
|
|
359
359
|
/**
|
|
360
|
-
* Inpainting mask — white = the area to change, black = keep
|
|
361
|
-
* model as its own mask
|
|
362
|
-
*
|
|
360
|
+
* Inpainting mask — white = the area to change, black = keep, aligned to
|
|
361
|
+
* `imageUrl`. Sent to the model as its own mask (in the form that model
|
|
362
|
+
* reads), so only the mask-capable image-to-image models use it (`I2I_MASK_SUPPORT`:
|
|
363
|
+
* `ideogram-edit`, `flux-fill`, `gpt-image-2-6-flare-i2i`,
|
|
364
|
+
* `gpt-image-2-6-sunburst-i2i`); others ignore it. On GPT Image 2.6 the rest
|
|
365
|
+
* of the picture is kept as it was: the source is pasted back outside the
|
|
366
|
+
* mask, and the result is the source's size: the run keeps the photo's
|
|
367
|
+
* shape and is rendered, and priced, at the size nearest the photo (both
|
|
368
|
+
* reported in `adjustments`). Not with a GIF or an SVG
|
|
369
|
+
* `outputFormat` (`400`). It costs nothing extra and is not an input image.
|
|
363
370
|
* For a mask on any image model, see `GenerateImageParams.maskUrl`.
|
|
364
371
|
*/
|
|
365
372
|
maskUrl?: string;
|
|
@@ -357,9 +357,16 @@ interface ImageToImageParams extends GenerationSessionParams {
|
|
|
357
357
|
/** 0–30: prompt adherence (taken by the models in `GUIDANCE_SCALE_SUPPORT`). */
|
|
358
358
|
guidanceScale?: number;
|
|
359
359
|
/**
|
|
360
|
-
* Inpainting mask — white = the area to change, black = keep
|
|
361
|
-
* model as its own mask
|
|
362
|
-
*
|
|
360
|
+
* Inpainting mask — white = the area to change, black = keep, aligned to
|
|
361
|
+
* `imageUrl`. Sent to the model as its own mask (in the form that model
|
|
362
|
+
* reads), so only the mask-capable image-to-image models use it (`I2I_MASK_SUPPORT`:
|
|
363
|
+
* `ideogram-edit`, `flux-fill`, `gpt-image-2-6-flare-i2i`,
|
|
364
|
+
* `gpt-image-2-6-sunburst-i2i`); others ignore it. On GPT Image 2.6 the rest
|
|
365
|
+
* of the picture is kept as it was: the source is pasted back outside the
|
|
366
|
+
* mask, and the result is the source's size: the run keeps the photo's
|
|
367
|
+
* shape and is rendered, and priced, at the size nearest the photo (both
|
|
368
|
+
* reported in `adjustments`). Not with a GIF or an SVG
|
|
369
|
+
* `outputFormat` (`400`). It costs nothing extra and is not an input image.
|
|
363
370
|
* For a mask on any image model, see `GenerateImageParams.maskUrl`.
|
|
364
371
|
*/
|
|
365
372
|
maskUrl?: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nodaro/sdk",
|
|
3
|
-
"version": "2.68.
|
|
3
|
+
"version": "2.68.2",
|
|
4
4
|
"description": "Typed REST client for the Nodaro API — workflows, jobs, executions, apps, characters, and more.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -337,7 +337,7 @@
|
|
|
337
337
|
"test:watch": "vitest"
|
|
338
338
|
},
|
|
339
339
|
"dependencies": {
|
|
340
|
-
"@nodaro/shared": "^3.
|
|
340
|
+
"@nodaro/shared": "^3.61.0",
|
|
341
341
|
"@nodaro/prompts": "^1.53.2"
|
|
342
342
|
},
|
|
343
343
|
"peerDependencies": {
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/resources/jobs.ts"],"names":[],"mappings":";;;AAmZA,SAAS,UAAU,KAAA,EAAmE;AACpF,EAAA,IAAI,KAAA,KAAU,QAAW,OAAO,MAAA;AAChC,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAA,GAAQ,KAAA,CAAM,KAAK,GAAG,CAAA;AAC3D;AAoCO,IAAM,eAAN,MAAmB;AAAA,EACxB,YAAoB,MAAA,EAA0B;AAA1B,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA,EAA2B;AAAA,EAA3B,MAAA;AAAA;AAAA,EAGpB,IAAI,EAAA,EAAoC;AACtC,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAQ,KAAA,EAAO,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAE,CAAA;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAA,CAAK,MAAA,GAAyB,EAAC,EAA0B;AACvD,IAAA,MAAM,EAAE,QAAQ,IAAA,EAAM,MAAA,EAAQ,WAAW,YAAA,EAAc,GAAG,MAAK,GAAI,MAAA;AACnE,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,OAAA,CAAsB,KAAA,EAAO,UAAA,EAAY;AAAA,MAC1D,KAAA,EAAO;AAAA,QACL,GAAG,IAAA;AAAA,QACH,MAAA,EAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,IAAA,EAAM,UAAU,IAAI,CAAA;AAAA,QACpB,MAAA,EAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,SAAA,EAAW,SAAA,KAAc,MAAA,GAAY,MAAA,GAAY,OAAO,SAAS,CAAA;AAAA,QACjE,YAAA,EAAc,eAAe,MAAA,GAAS;AAAA;AACxC,KACD,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,WAAW,MAAA,EAAqD;AAC9D,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAuB,MAAA,EAAQ,wBAAwB,EAAE,IAAA,EAAM,QAAQ,CAAA;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAK,IAAY,MAAA,EAAkD;AACjE,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAuB,KAAA,EAAO,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA,CAAA,EAAW;AAAA,MAC5F,IAAA,EAAM,EAAE,MAAA;AAAO,KAChB,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAA,CAAO,IAAY,KAAA,EAAgD;AACjE,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAyB,OAAA,EAAS,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAA,EAAI;AAAA,MACzF,IAAA,EAAM,EAAE,KAAA;AAAM,KACf,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,EAAA,EAAgD;AACxD,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,KAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA;AAAA,KACpC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAO,EAAA,EAAsC;AAC3C,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,MAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA;AAAA,KACpC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAA,CAAO,EAAA,EAAY,OAAA,GAAiC,EAAC,EAA6B;AAChF,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,QAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAA;AAAA,MAClC,OAAA,CAAQ,UAAU,EAAE,KAAA,EAAO,EAAE,OAAA,EAAS,MAAA,EAAO,EAAE,GAAI;AAAC,KACtD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAQ,EAAA,EAAwC;AAC9C,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAQ,MAAA,EAAQ,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,QAAA,CAAU,CAAA;AAAA,EACjF;AACF","file":"chunk-BERWJFXS.cjs","sourcesContent":["import type { NodaroClientCore } from \"../core.js\"\n\n/**\n * A job's lifecycle status. Hand-copied mirror of `JOB_STATUSES` in the\n * platform's `backend/src/lib/job-status.ts` — nothing links the two at build\n * time, so a new member has to be added here in the same change.\n *\n * `pending_review` is IN-FLIGHT, NOT TERMINAL: a job policy registered by the\n * deployment held the output for a human reviewer. Treat it like `processing`\n * in a `switch` — keep waiting, do not re-run — and it resolves to `completed`\n * (approved), `failed` (rejected, carrying an `error_hint` with\n * `kind: \"policy-block\"`) or `cancelled` (a held job is cancellable like any\n * in-flight job). `credit_status` reads `\"reserved\"` for the whole hold. Only\n * appears on deployments that register a job policy; `runAndWait` throws\n * {@link JobHeldError} on the first held tick rather than waiting it out.\n */\nexport type JobStatus =\n | \"pending\"\n | \"queued\"\n | \"processing\"\n | \"pending_review\"\n | \"completed\"\n | \"failed\"\n | \"cancelled\"\n\n/**\n * A PROVIDER's verdict: the model's own safety filter refused the output.\n * `class` distinguishes a deterministic block (copyright/likeness — retrying\n * the same request never helps) from `safety`, whose filter is known to be\n * non-deterministic for some models: `retried` says whether the worker\n * already spent its one extra attempt, and `suggestedProvider` — present\n * only when the catalog declares a fallback for the model that failed — is a\n * real model id the SAME prompt/references can be retried on.\n */\nexport type SafetyBlockHint = {\n kind: \"safety-block\"\n class: \"copyright\" | \"likeness\" | \"safety\"\n retried: boolean\n suggestedProvider?: string\n /**\n * Present when the provider named what it refused. `\"input_video\"`: the\n * input video itself; sending a different clip is the fix. `\"input_image\"`:\n * one of the input images, refused as possibly copyrighted (with\n * `class: \"copyright\"`); sending a different picture is the fix. `\"prompt\"`:\n * the provider's own words named the prompt; changing the prompt is the fix.\n * `\"audio\"`: the provider's own words blamed the generated audio, not the\n * picture. Treat an unknown value as absent.\n */\n subject?: \"input_video\" | \"input_image\" | \"prompt\" | \"audio\"\n}\n\n/**\n * A NODARO-side verdict, not a provider's: a job policy registered by the\n * deployment rejected the request (`hookPoint: \"request\"` — nothing ran, and\n * the call itself failed with {@link JobBlockedError}) or the finished output\n * (`hookPoint: \"result\"` — the result was blocked and never published).\n *\n * `reason` is USER-SAFE BY CONTRACT — the platform guarantees the policy's\n * machine text (scores, labels) never reaches it — so show it to the person\n * who made the request as-is. `policyId` identifies the deployment's policy,\n * not a Nodaro product feature. Only occurs on deployments that register a\n * job policy.\n */\nexport type PolicyBlockHint = {\n kind: \"policy-block\"\n policyId: string\n reason: string\n hookPoint: \"request\" | \"result\"\n}\n\n/**\n * The job ran out of credits partway: a step that reserves its own credits\n * (for example, the video a Cast Swap or trend run dispatches) was refused —\n * the balance could not cover it, or a plan or workspace cap was reached. The\n * job failed and its credits were refunded; ask the person to top up (or raise\n * the cap), then run it again.\n *\n * `code` is the refusal's own code, a lowercase snake_case token — for\n * example `insufficient_credits`, `free_video_limit`, `instance_cap_reached`,\n * `budget_exceeded`, `member_cap_exceeded` or `user_allowance_exceeded`. Treat\n * an unknown code like `insufficient_credits`.\n */\nexport type CreditsHint = {\n kind: \"credits\"\n code: string\n}\n\n/**\n * The provider refused the job's input video without naming a content-policy\n * class (its message is about the file, not a policy). Treat it like any\n * other failure — no fallback model is offered — except that the input to\n * change is known: send a different clip.\n */\nexport type InputRefusedHint = {\n kind: \"input-refused\"\n subject: \"input_video\"\n}\n\n/**\n * The job never got a slot to run in, so it did not run, and its credits were\n * refunded. `reason`: `timeout` — it waited longer than the platform's queue\n * timeout for one of the account's concurrency slots; `lost` — its place in\n * line was lost and could not be restored; `live-wait` — a synchronous call\n * could not get a slot within its wait limit. `waitedMinutes` is the whole\n * minutes it waited, rounded down. Run it again; treat an unknown `reason`\n * like `timeout`.\n */\nexport type QueueTimeoutHint = {\n kind: \"queue-timeout\"\n reason: \"timeout\" | \"lost\" | \"live-wait\"\n waitedMinutes: number\n}\n\n/**\n * The provider refused the request as it was sent, naming a fault of it (a\n * setting, a file's format or size, the prompt's length). The same request is\n * refused the same way, so do not run it again unchanged: change the input\n * images, the video, the prompt or the settings. Not a content-policy block. On a\n * job made of steps (a Nodaro Motion or trend run), one step's refusal.\n * `subject: \"input_video\"`: the provider's words name the input video as the\n * fault (its length or size, or no character found in it), so a different clip\n * is what can change.\n */\nexport type RequestRefusedHint = {\n kind: \"request-refused\"\n subject?: \"input_video\"\n}\n\n/**\n * A job's `jobs.error_hint` (migration 376) — a user-safe, machine-readable\n * failure verdict, so a caller can act on it without parsing `error_message`\n * prose. One column, several verdict sources; `kind` is the discriminant.\n *\n * HAND-COPIED MIRROR of `ErrorHint` in the platform's\n * `backend/src/lib/safety-block.ts` (which names this file in its own\n * comment). Nothing links the two at build time: a new arm there has to be\n * pasted here verbatim in the same change, with a changeset.\n * `packages/client/dist/index.d.ts` is REBUILT, never hand-edited.\n */\nexport type JobErrorHint = SafetyBlockHint | PolicyBlockHint | CreditsHint | InputRefusedHint | QueueTimeoutHint | RequestRefusedHint\n\n/**\n * The billing lifecycle of a job's credit reservation — `usage_logs.status`\n * for the job's `usage_log_id`. `null` when the job has no usage log (e.g. a\n * free run) or hasn't reserved credits yet.\n */\nexport type CreditStatus = \"reserved\" | \"committed\" | \"refunded\"\n\n/**\n * Where a job (or a workflow run) that is waiting for a free concurrency slot\n * stands in line — the `queue` field of a status read. Present ONLY while it\n * waits (a job's `status` is `queued`); absent on every other read, and when\n * the server could not read the line at that moment.\n *\n * HAND-COPIED MIRROR of `QueueInfo` in the platform's\n * `backend/src/lib/concurrency-lanes/queue-info.ts` (its `lane`, `reason` and\n * `upgradeHint` lists are `vocabulary.ts` there). Nothing links the two at\n * build time: a change there has to be pasted here in the same change, with a\n * changeset. Treat an unknown `lane` or `reason` like a known one you do not\n * special-case.\n */\nexport interface JobQueueInfo {\n /**\n * The kind of work it waits to run as: `provider` (a call to an AI\n * provider), `llm` (a text model call), `local` (processing on the\n * platform's servers) or `run` (a whole workflow run or pipeline).\n */\n lane: \"provider\" | \"llm\" | \"local\" | \"run\"\n /** Its place in line: `1` runs next. */\n position: number\n /** How many of that kind its line runs at once (`0` for a `server_busy` wait). */\n limit: number\n /** How many run in that line now (`0` for a `server_busy` wait). */\n running: number\n /**\n * `user_lane`: the line (yours, or the workspace's) is full. `provider_ceiling`:\n * the provider is busy across the platform. `server_busy`: the server is busy\n * across the platform.\n */\n reason: \"user_lane\" | \"provider_ceiling\" | \"server_busy\"\n /** How long it has waited so far, in whole seconds, from when it first started waiting for a slot. */\n waitedSeconds: number\n /**\n * What would let more run at once — set only when the line itself is full\n * (`reason: \"user_lane\"`): `\"plan\"`, a bigger plan; `\"workspace\"`, the\n * workspace's plan (the work is billed to a workspace). `null` otherwise.\n */\n upgradeHint: \"plan\" | \"workspace\" | null\n}\n\n/** A job owner's rating of their job — set with {@link JobsResource.rate}. */\nexport type JobRating = \"good\" | \"bad\"\n\n/**\n * The `rating` filter of {@link JobsResource.list}: one rating, any rating\n * (`\"rated\"`) or none (`\"unrated\"`).\n */\nexport type JobRatingFilter = JobRating | \"rated\" | \"unrated\"\n\n/**\n * Job record returned to non-admin SDK consumers. Field names are snake_case\n * to match the wire format (per the OpenAPI fix in Phase 1).\n *\n * Sensitive fields stripped server-side for non-admin callers:\n * `provider`, `provider_cost`, `display_cost`, `credits_actual`. USD\n * pricing is admin-only across api/sdk/mcp — non-admin consumers see\n * only the `credits` abstraction. Server-only nested job data (including\n * Recast's private remux base) is stripped for every caller, including admins.\n */\nexport interface Job {\n id: string\n status: JobStatus\n progress: number\n user_id: string\n input_data: unknown\n output_data: unknown\n error_message: string | null\n /** The provider's own words for a failure, as the server stored them with\n * links cut to their host and secrets removed; `null` when the failure had\n * no provider text (a platform refusal, a timeout, a queue wait that ran\n * out). Display it beside `error_message`; branch on `error_hint`, never on\n * these words. Absent on an older server. */\n error_detail?: string | null\n /** Present on a failed job the worker classified as a provider\n * content-policy block (`kind: \"safety-block\"`) or that a deployment's job\n * policy rejected (`kind: \"policy-block\"`); absent/null otherwise.\n * User-safe by construction — narrow on `kind` before reading the rest. */\n error_hint?: JobErrorHint | null\n /** PR9: the job's credit reservation lifecycle, derived server-side from\n * `usage_logs.status`. `null` when there is no usage log to report. Never\n * changes the meaning of `credits` (the reserved amount) below. */\n credit_status?: CreditStatus | null\n /** The credits the job itself HELD when it was accepted. Never changes — a\n * job can settle below it; read {@link Job.credits_charged} for what it cost. */\n credits: number | null\n /**\n * What the job actually cost once its hold settled, INCLUDING the steps it\n * ran: a job that runs other jobs for you (a Nodaro Motion run's reference\n * preparation, mask and video) is charged for each, and they are not listed\n * on their own. A step adds its charge once it settles. Can be lower than\n * {@link Job.credits_held} (the unused part goes back to the balance). `0`\n * when the run's own hold was refunded, plus any settled steps (a refunded\n * Nodaro Motion run whose reference and mask steps committed reads\n * `credit_status: \"refunded\"` with `credits_charged: 165`). `null` while the\n * job's own hold is still open (even when some steps have settled), when\n * nothing in the run was reserved, or when its steps could not be read for a\n * moment (unknown — never a lower figure). Sum this — not `credits` — to\n * total spend. Returned by `get()` and `list()`.\n */\n credits_charged?: number | null\n /** The run's hold: the job's own `credits` plus its steps' holds (equals `credits` for a job with no steps). */\n credits_held?: number | null\n /** What went back from `credits_held` once every hold in the run settled; `null` until then. */\n credits_released?: number | null\n job_type: string | null\n created_at: string\n started_at: string | null\n completed_at: string | null\n /**\n * Provenance: which kind of caller created the job — one of\n * `\"internal\" | \"mcp\" | \"app\" | \"cli\" | \"sdk\" | \"extension\" | \"web\" | \"api\"`.\n * `source_detail` narrows it (origin host, `extension/<name>` label,\n * `sdk/<version>`, MCP client name, developer-app id). Descriptive only;\n * lets a library view label or filter media by origin.\n */\n source?: string | null\n source_detail?: string | null\n /** The generation session this job was born in (the `sessionId` sent with\n * the generation request), or null. See `client.sessions`. */\n session_id?: string | null\n /**\n * With `list({ withSessions: true })`: every session that holds the job now,\n * each linkable — empty when it is in no session (General). Absent otherwise.\n */\n sessions?: JobSessionRef[]\n /**\n * When the job was deleted, on a job read from the Trash\n * (`client.trash.list()`). A deleted job is left out of every other read, so\n * this is otherwise absent or `null`.\n */\n deleted_at?: string | null\n /**\n * Whether the job's owner favorited it (`client.gallery.toggleFavorite`).\n * Returned by `get()` and `list()`. Absent from an older server, and when\n * the server could not read it for a moment — treat absent as unknown,\n * never as `false`.\n */\n favorited?: boolean\n /**\n * The owner's rating of the job ({@link JobsResource.rate}), or `null` when\n * unrated. Returned by `get()` and `list()`; absent like `favorited`.\n */\n rating?: JobRating | null\n /**\n * The owner's own name for the job ({@link JobsResource.rename}) — \"Wedding\n * toast, final\" — or `null` until named. One line of plain text, up to 120\n * characters. Returned wherever the job is: `get()`, `list()`, a session's\n * items, the Trash. Absent from an older server.\n */\n title?: string | null\n /**\n * Where the job stands in line while it waits for a free slot: present on\n * `get()` only while `status` is `queued` (never on `list()`). See\n * {@link JobQueueInfo}.\n */\n queue?: JobQueueInfo\n}\n\nexport interface CancelJobResult {\n success: true\n cancelled: number\n /**\n * `true` when the job could not be stopped because its provider call is\n * already running — a metered LLM job's call, an external provider task. It\n * finishes and is charged only what it used.\n */\n inFlight?: boolean\n}\n\n/**\n * The kind of caller that created a job (`Job.source`). Hand-copied mirror of\n * `JOB_SOURCES` in the platform's `backend/src/lib/job-source.ts`.\n */\nexport type JobSource = \"internal\" | \"mcp\" | \"app\" | \"cli\" | \"sdk\" | \"extension\" | \"web\" | \"api\"\n\nexport interface DeleteJobResult {\n success: true\n}\n\n/** A session that holds a job now (`Job.sessions`). */\nexport interface JobSessionRef {\n id: string\n title: string | null\n /** The session's project, or `null` when it has none. */\n projectId: string | null\n}\n\nexport interface ListJobsParams {\n /** One status or several (a job matching any of them). An unknown status is a 400. */\n status?: JobStatus | readonly JobStatus[]\n /** Exact match on `input_data.type` — the route that created the job\n * (`\"llm-structured\"`, `\"video-analysis\"`, …). One value or several (up to 20). */\n type?: string | readonly string[]\n /** Exact match on `input_data.origin` — the client app that sent it. */\n origin?: string\n /** The surface that created the job (`Job.source`): `\"mcp\"` lists what your\n * MCP clients (Claude, ChatGPT, …) made. One value or several. */\n source?: JobSource | readonly JobSource[]\n /** `true`: only jobs you favorited; `false`: only jobs you did not. */\n favorited?: boolean\n /** Your rating: `\"good\"`, `\"bad\"`, any (`\"rated\"`) or none (`\"unrated\"`). */\n rating?: JobRatingFilter\n /** The jobs of one generate-image batch (`count` / `models`) — its `batchId`. */\n batchId?: string\n /**\n * The jobs a session of this project holds now — or, `\"none\"`, a session\n * with no project. Each job once, however many sessions hold it. Not with\n * `inSession: false`.\n */\n projectId?: string | \"none\"\n /**\n * `false`: the jobs no session holds now (General), whatever session they\n * were born in. `true`: the jobs at least one session holds.\n */\n inSession?: boolean\n /** `true`: each job carries `sessions`, the sessions that hold it now. */\n withSessions?: boolean\n /** Page size, 1–100 (server default 50). */\n limit?: number\n /** The previous page's `next`. */\n cursor?: string\n}\n\n/** What {@link JobsResource.rate} answers: the job's rating now. */\nexport interface RateJobResult {\n data: { jobId: string; rating: JobRating | null }\n}\n\n/** What {@link JobsResource.rename} answers: the job's name now (`null` once cleared). */\nexport interface RenameJobResult {\n data: { jobId: string; title: string | null }\n}\n\n/**\n * {@link JobsResource.fromUpload}'s body: an image edited in the browser,\n * already stored with `client.uploads.upload`, and what it was made from.\n */\nexport interface JobFromUploadParams {\n /** The edited image's `assetId`, as `client.uploads.upload` returned it. */\n assetId: string\n /** The job whose image was edited. */\n sourceJobId?: string\n /** Which of `sourceJobId`'s images was edited, when it made several. Default: its `imageUrl`. */\n sourceImageUrl?: string\n /** The upload that was edited, when the source is not a job. Not with `sourceJobId`. */\n sourceAssetId?: string\n /** The editor's design state, stored with `client.uploads.uploadJson`, so the edit can be reopened. */\n editStateUrl?: string\n /** The generation session to file the job in. */\n sessionId?: string\n}\n\n/** A list filter value as the query string carries it: several are comma-separated. */\nfunction listParam(value: string | readonly string[] | undefined): string | undefined {\n if (value === undefined) return undefined\n return typeof value === \"string\" ? value : value.join(\",\")\n}\n\nexport interface ListJobsPage {\n /**\n * A page may hold fewer than `limit` rows — even none — and still carry a\n * `next`. Page on `next`, never on `data.length`.\n */\n data: Job[]\n /** Pass back as `cursor` for the next page; `null` on the last one. */\n next: string | null\n}\n\n/**\n * Lean job status returned by `GET /v1/jobs/:id/status`. Skips the\n * `input_data` JSONB and cost columns. Its `output_data` still goes\n * through the server-only nested-field redaction. Intended for poll loops that\n * only need progress/output/error, and when the job finished.\n */\nexport interface JobStatusResult {\n id: string\n status: JobStatus\n progress?: number\n output_data?: unknown\n error_message?: string | null\n /** See {@link Job.error_detail}. */\n error_detail?: string | null\n /** PR9: see {@link Job.error_hint}. */\n error_hint?: JobErrorHint | null\n /** PR9: see {@link Job.credit_status}. */\n credit_status?: CreditStatus | null\n /** When the job finished, on the server's clock; null until it has. */\n completed_at?: string | null\n /** Present only while `status` is `queued` (the job waits for a free slot). See {@link JobQueueInfo}. */\n queue?: JobQueueInfo\n}\n\nexport class JobsResource {\n constructor(private client: NodaroClientCore) {}\n\n /** Get a single job by ID. */\n get(id: string): Promise<{ data: Job }> {\n return this.client.request(\"GET\", `/v1/jobs/${encodeURIComponent(id)}`)\n }\n\n /**\n * Your jobs, newest first (`GET /v1/jobs`), cursor-paginated. `type` and\n * `origin` filter on the job's own `input_data`, which every job carries —\n * a client app lists its runs with `{ type: \"llm-structured\", origin: \"studio\" }`.\n * `status` and `type` take one value or a list; `favorited` and `rating`\n * filter on your own marks, `source` on the surface that created the job.\n * `projectId` / `inSession` filter on where the job is now (a project's\n * sessions, or General), and `withSessions` says which sessions each job is\n * in — for \"everything in this project\". Every filter combines with AND,\n * and each job carries `favorited` and `rating`. A deleted job is never\n * listed: read the Trash with `client.trash.list()`.\n */\n list(params: ListJobsParams = {}): Promise<ListJobsPage> {\n const { status, type, source, inSession, withSessions, ...rest } = params\n return this.client.request<ListJobsPage>(\"GET\", \"/v1/jobs\", {\n query: {\n ...rest,\n status: listParam(status),\n type: listParam(type),\n source: listParam(source),\n inSession: inSession === undefined ? undefined : String(inSession),\n withSessions: withSessions ? \"true\" : undefined,\n },\n })\n }\n\n /**\n * Record an image edited in the browser as a job (`POST /v1/jobs/from-upload`):\n * a completed, private, free `image-edit` job whose `output_data.imageUrl` is\n * the upload, linked to its source in `input_data` (`sourceJobId` /\n * `sourceAssetId`, `sourceImageUrl`). It then lists, rates, favorites and\n * files into a session like any image job. One upload is one job: the same\n * `assetId` again returns the same job. OAuth apps need the `assets:write`\n * scope. A deployment's job policy can refuse the image ({@link JobBlockedError}).\n */\n fromUpload(params: JobFromUploadParams): Promise<{ data: Job }> {\n return this.client.request<{ data: Job }>(\"POST\", \"/v1/jobs/from-upload\", { body: params })\n }\n\n /**\n * Rate one of your jobs `\"good\"` or `\"bad\"`, or clear the rating with\n * `null` (`PUT /v1/jobs/:id/rating`). Only the job's owner rates it — anyone\n * else's job is a `NotFoundError`. The rating reads back as `Job.rating`\n * and filters {@link list}. OAuth apps need the `assets:write` scope.\n */\n rate(id: string, rating: JobRating | null): Promise<RateJobResult> {\n return this.client.request<RateJobResult>(\"PUT\", `/v1/jobs/${encodeURIComponent(id)}/rating`, {\n body: { rating },\n })\n }\n\n /**\n * Name one of your jobs — \"Wedding toast, final\" on a picture, a clip, a\n * track or a speech take — or clear its name with `null` (`PATCH\n * /v1/jobs/:id`). Trimmed; one line of plain text, 1–120 characters, any\n * language: a longer or multi-line name is a `NodaroError`\n * (`validation_error`). Only the job's owner names it — anyone else's job is\n * a `NotFoundError`. Free; any job type and status, the Trash included;\n * nothing else about the job changes. The name reads back as `Job.title`\n * wherever the job is returned. OAuth apps need the `assets:write` scope.\n */\n rename(id: string, title: string | null): Promise<RenameJobResult> {\n return this.client.request<RenameJobResult>(\"PATCH\", `/v1/jobs/${encodeURIComponent(id)}`, {\n body: { title },\n })\n }\n\n /**\n * Get the lean status of a single job (poll-loop friendly).\n * Hits `GET /v1/jobs/:id/status` — returns only id/status/progress/\n * output_data/error_message, with far less wire/CPU cost than `get()`.\n * Same auth + ownership semantics as {@link get}.\n */\n getStatus(id: string): Promise<{ data: JobStatusResult }> {\n return this.client.request(\n \"GET\",\n `/v1/jobs/${encodeURIComponent(id)}/status`,\n )\n }\n\n /**\n * Cancel a job. Server route is `POST /v1/jobs/:jobId/cancel`.\n * Refunds any reserved credit holds. A running LLM job priced per model\n * (metered) whose call has already started answers\n * `{ success: true, cancelled: 0, inFlight: true }`: it finishes and is\n * charged only what it used. A job stopped before its call starts is\n * refunded, except for what an earlier attempt of the same job already used\n * (a retry after a billed attempt): that is charged.\n */\n cancel(id: string): Promise<CancelJobResult> {\n return this.client.request(\n \"POST\",\n `/v1/jobs/${encodeURIComponent(id)}/cancel`,\n )\n }\n\n /**\n * Delete a job: it goes to the Trash (`client.trash.list()`). It is left out\n * of every read from then on, stays restorable for 30 days ({@link restore},\n * back into the sessions it was in), and is then deleted for good, as a\n * delete always was (a copy saved to the Library stays). `{ forever: true }` deletes a job already in the Trash for good now;\n * on a live job it fails with a 409 `NodaroError` whose `code` is\n * `\"not_in_trash\"`. Only the job's owner (or an admin) may delete it; a job\n * that is still running keeps running — cancel it first when its worker\n * should stop ({@link cancel}). Nothing is refunded. OAuth apps need the\n * `assets:write` scope.\n */\n delete(id: string, options: { forever?: boolean } = {}): Promise<DeleteJobResult> {\n return this.client.request(\n \"DELETE\",\n `/v1/jobs/${encodeURIComponent(id)}`,\n options.forever ? { query: { forever: \"true\" } } : {},\n )\n }\n\n /**\n * Bring a deleted job back from the Trash: it reappears in every read and in\n * every session it was in. A job that is not in the Trash succeeds too.\n * OAuth apps need the `assets:write` scope.\n */\n restore(id: string): Promise<{ success: true }> {\n return this.client.request(\"POST\", `/v1/jobs/${encodeURIComponent(id)}/restore`)\n }\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/resources/jobs.ts"],"names":[],"mappings":";AAmZA,SAAS,UAAU,KAAA,EAAmE;AACpF,EAAA,IAAI,KAAA,KAAU,QAAW,OAAO,MAAA;AAChC,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAA,GAAQ,KAAA,CAAM,KAAK,GAAG,CAAA;AAC3D;AAoCO,IAAM,eAAN,MAAmB;AAAA,EACxB,YAAoB,MAAA,EAA0B;AAA1B,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA,EAA2B;AAAA,EAA3B,MAAA;AAAA;AAAA,EAGpB,IAAI,EAAA,EAAoC;AACtC,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAQ,KAAA,EAAO,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAE,CAAA;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAA,CAAK,MAAA,GAAyB,EAAC,EAA0B;AACvD,IAAA,MAAM,EAAE,QAAQ,IAAA,EAAM,MAAA,EAAQ,WAAW,YAAA,EAAc,GAAG,MAAK,GAAI,MAAA;AACnE,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,OAAA,CAAsB,KAAA,EAAO,UAAA,EAAY;AAAA,MAC1D,KAAA,EAAO;AAAA,QACL,GAAG,IAAA;AAAA,QACH,MAAA,EAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,IAAA,EAAM,UAAU,IAAI,CAAA;AAAA,QACpB,MAAA,EAAQ,UAAU,MAAM,CAAA;AAAA,QACxB,SAAA,EAAW,SAAA,KAAc,MAAA,GAAY,MAAA,GAAY,OAAO,SAAS,CAAA;AAAA,QACjE,YAAA,EAAc,eAAe,MAAA,GAAS;AAAA;AACxC,KACD,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,WAAW,MAAA,EAAqD;AAC9D,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAuB,MAAA,EAAQ,wBAAwB,EAAE,IAAA,EAAM,QAAQ,CAAA;AAAA,EAC5F;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAK,IAAY,MAAA,EAAkD;AACjE,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAuB,KAAA,EAAO,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA,CAAA,EAAW;AAAA,MAC5F,IAAA,EAAM,EAAE,MAAA;AAAO,KAChB,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAA,CAAO,IAAY,KAAA,EAAgD;AACjE,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAyB,OAAA,EAAS,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAA,EAAI;AAAA,MACzF,IAAA,EAAM,EAAE,KAAA;AAAM,KACf,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,EAAA,EAAgD;AACxD,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,KAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA;AAAA,KACpC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAO,EAAA,EAAsC;AAC3C,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,MAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,OAAA;AAAA,KACpC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAA,CAAO,EAAA,EAAY,OAAA,GAAiC,EAAC,EAA6B;AAChF,IAAA,OAAO,KAAK,MAAA,CAAO,OAAA;AAAA,MACjB,QAAA;AAAA,MACA,CAAA,SAAA,EAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,CAAA;AAAA,MAClC,OAAA,CAAQ,UAAU,EAAE,KAAA,EAAO,EAAE,OAAA,EAAS,MAAA,EAAO,EAAE,GAAI;AAAC,KACtD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAQ,EAAA,EAAwC;AAC9C,IAAA,OAAO,IAAA,CAAK,OAAO,OAAA,CAAQ,MAAA,EAAQ,YAAY,kBAAA,CAAmB,EAAE,CAAC,CAAA,QAAA,CAAU,CAAA;AAAA,EACjF;AACF","file":"chunk-ZK6OWTRR.js","sourcesContent":["import type { NodaroClientCore } from \"../core.js\"\n\n/**\n * A job's lifecycle status. Hand-copied mirror of `JOB_STATUSES` in the\n * platform's `backend/src/lib/job-status.ts` — nothing links the two at build\n * time, so a new member has to be added here in the same change.\n *\n * `pending_review` is IN-FLIGHT, NOT TERMINAL: a job policy registered by the\n * deployment held the output for a human reviewer. Treat it like `processing`\n * in a `switch` — keep waiting, do not re-run — and it resolves to `completed`\n * (approved), `failed` (rejected, carrying an `error_hint` with\n * `kind: \"policy-block\"`) or `cancelled` (a held job is cancellable like any\n * in-flight job). `credit_status` reads `\"reserved\"` for the whole hold. Only\n * appears on deployments that register a job policy; `runAndWait` throws\n * {@link JobHeldError} on the first held tick rather than waiting it out.\n */\nexport type JobStatus =\n | \"pending\"\n | \"queued\"\n | \"processing\"\n | \"pending_review\"\n | \"completed\"\n | \"failed\"\n | \"cancelled\"\n\n/**\n * A PROVIDER's verdict: the model's own safety filter refused the output.\n * `class` distinguishes a deterministic block (copyright/likeness — retrying\n * the same request never helps) from `safety`, whose filter is known to be\n * non-deterministic for some models: `retried` says whether the worker\n * already spent its one extra attempt, and `suggestedProvider` — present\n * only when the catalog declares a fallback for the model that failed — is a\n * real model id the SAME prompt/references can be retried on.\n */\nexport type SafetyBlockHint = {\n kind: \"safety-block\"\n class: \"copyright\" | \"likeness\" | \"safety\"\n retried: boolean\n suggestedProvider?: string\n /**\n * Present when the provider named what it refused. `\"input_video\"`: the\n * input video itself; sending a different clip is the fix. `\"input_image\"`:\n * one of the input images, refused as possibly copyrighted (with\n * `class: \"copyright\"`); sending a different picture is the fix. `\"prompt\"`:\n * the provider's own words named the prompt; changing the prompt is the fix.\n * `\"audio\"`: the provider's own words blamed the generated audio, not the\n * picture. Treat an unknown value as absent.\n */\n subject?: \"input_video\" | \"input_image\" | \"prompt\" | \"audio\"\n}\n\n/**\n * A NODARO-side verdict, not a provider's: a job policy registered by the\n * deployment rejected the request (`hookPoint: \"request\"` — nothing ran, and\n * the call itself failed with {@link JobBlockedError}) or the finished output\n * (`hookPoint: \"result\"` — the result was blocked and never published).\n *\n * `reason` is USER-SAFE BY CONTRACT — the platform guarantees the policy's\n * machine text (scores, labels) never reaches it — so show it to the person\n * who made the request as-is. `policyId` identifies the deployment's policy,\n * not a Nodaro product feature. Only occurs on deployments that register a\n * job policy.\n */\nexport type PolicyBlockHint = {\n kind: \"policy-block\"\n policyId: string\n reason: string\n hookPoint: \"request\" | \"result\"\n}\n\n/**\n * The job ran out of credits partway: a step that reserves its own credits\n * (for example, the video a Cast Swap or trend run dispatches) was refused —\n * the balance could not cover it, or a plan or workspace cap was reached. The\n * job failed and its credits were refunded; ask the person to top up (or raise\n * the cap), then run it again.\n *\n * `code` is the refusal's own code, a lowercase snake_case token — for\n * example `insufficient_credits`, `free_video_limit`, `instance_cap_reached`,\n * `budget_exceeded`, `member_cap_exceeded` or `user_allowance_exceeded`. Treat\n * an unknown code like `insufficient_credits`.\n */\nexport type CreditsHint = {\n kind: \"credits\"\n code: string\n}\n\n/**\n * The provider refused the job's input video without naming a content-policy\n * class (its message is about the file, not a policy). Treat it like any\n * other failure — no fallback model is offered — except that the input to\n * change is known: send a different clip.\n */\nexport type InputRefusedHint = {\n kind: \"input-refused\"\n subject: \"input_video\"\n}\n\n/**\n * The job never got a slot to run in, so it did not run, and its credits were\n * refunded. `reason`: `timeout` — it waited longer than the platform's queue\n * timeout for one of the account's concurrency slots; `lost` — its place in\n * line was lost and could not be restored; `live-wait` — a synchronous call\n * could not get a slot within its wait limit. `waitedMinutes` is the whole\n * minutes it waited, rounded down. Run it again; treat an unknown `reason`\n * like `timeout`.\n */\nexport type QueueTimeoutHint = {\n kind: \"queue-timeout\"\n reason: \"timeout\" | \"lost\" | \"live-wait\"\n waitedMinutes: number\n}\n\n/**\n * The provider refused the request as it was sent, naming a fault of it (a\n * setting, a file's format or size, the prompt's length). The same request is\n * refused the same way, so do not run it again unchanged: change the input\n * images, the video, the prompt or the settings. Not a content-policy block. On a\n * job made of steps (a Nodaro Motion or trend run), one step's refusal.\n * `subject: \"input_video\"`: the provider's words name the input video as the\n * fault (its length or size, or no character found in it), so a different clip\n * is what can change.\n */\nexport type RequestRefusedHint = {\n kind: \"request-refused\"\n subject?: \"input_video\"\n}\n\n/**\n * A job's `jobs.error_hint` (migration 376) — a user-safe, machine-readable\n * failure verdict, so a caller can act on it without parsing `error_message`\n * prose. One column, several verdict sources; `kind` is the discriminant.\n *\n * HAND-COPIED MIRROR of `ErrorHint` in the platform's\n * `backend/src/lib/safety-block.ts` (which names this file in its own\n * comment). Nothing links the two at build time: a new arm there has to be\n * pasted here verbatim in the same change, with a changeset.\n * `packages/client/dist/index.d.ts` is REBUILT, never hand-edited.\n */\nexport type JobErrorHint = SafetyBlockHint | PolicyBlockHint | CreditsHint | InputRefusedHint | QueueTimeoutHint | RequestRefusedHint\n\n/**\n * The billing lifecycle of a job's credit reservation — `usage_logs.status`\n * for the job's `usage_log_id`. `null` when the job has no usage log (e.g. a\n * free run) or hasn't reserved credits yet.\n */\nexport type CreditStatus = \"reserved\" | \"committed\" | \"refunded\"\n\n/**\n * Where a job (or a workflow run) that is waiting for a free concurrency slot\n * stands in line — the `queue` field of a status read. Present ONLY while it\n * waits (a job's `status` is `queued`); absent on every other read, and when\n * the server could not read the line at that moment.\n *\n * HAND-COPIED MIRROR of `QueueInfo` in the platform's\n * `backend/src/lib/concurrency-lanes/queue-info.ts` (its `lane`, `reason` and\n * `upgradeHint` lists are `vocabulary.ts` there). Nothing links the two at\n * build time: a change there has to be pasted here in the same change, with a\n * changeset. Treat an unknown `lane` or `reason` like a known one you do not\n * special-case.\n */\nexport interface JobQueueInfo {\n /**\n * The kind of work it waits to run as: `provider` (a call to an AI\n * provider), `llm` (a text model call), `local` (processing on the\n * platform's servers) or `run` (a whole workflow run or pipeline).\n */\n lane: \"provider\" | \"llm\" | \"local\" | \"run\"\n /** Its place in line: `1` runs next. */\n position: number\n /** How many of that kind its line runs at once (`0` for a `server_busy` wait). */\n limit: number\n /** How many run in that line now (`0` for a `server_busy` wait). */\n running: number\n /**\n * `user_lane`: the line (yours, or the workspace's) is full. `provider_ceiling`:\n * the provider is busy across the platform. `server_busy`: the server is busy\n * across the platform.\n */\n reason: \"user_lane\" | \"provider_ceiling\" | \"server_busy\"\n /** How long it has waited so far, in whole seconds, from when it first started waiting for a slot. */\n waitedSeconds: number\n /**\n * What would let more run at once — set only when the line itself is full\n * (`reason: \"user_lane\"`): `\"plan\"`, a bigger plan; `\"workspace\"`, the\n * workspace's plan (the work is billed to a workspace). `null` otherwise.\n */\n upgradeHint: \"plan\" | \"workspace\" | null\n}\n\n/** A job owner's rating of their job — set with {@link JobsResource.rate}. */\nexport type JobRating = \"good\" | \"bad\"\n\n/**\n * The `rating` filter of {@link JobsResource.list}: one rating, any rating\n * (`\"rated\"`) or none (`\"unrated\"`).\n */\nexport type JobRatingFilter = JobRating | \"rated\" | \"unrated\"\n\n/**\n * Job record returned to non-admin SDK consumers. Field names are snake_case\n * to match the wire format (per the OpenAPI fix in Phase 1).\n *\n * Sensitive fields stripped server-side for non-admin callers:\n * `provider`, `provider_cost`, `display_cost`, `credits_actual`. USD\n * pricing is admin-only across api/sdk/mcp — non-admin consumers see\n * only the `credits` abstraction. Server-only nested job data (including\n * Recast's private remux base) is stripped for every caller, including admins.\n */\nexport interface Job {\n id: string\n status: JobStatus\n progress: number\n user_id: string\n input_data: unknown\n output_data: unknown\n error_message: string | null\n /** The provider's own words for a failure, as the server stored them with\n * links cut to their host and secrets removed; `null` when the failure had\n * no provider text (a platform refusal, a timeout, a queue wait that ran\n * out). Display it beside `error_message`; branch on `error_hint`, never on\n * these words. Absent on an older server. */\n error_detail?: string | null\n /** Present on a failed job the worker classified as a provider\n * content-policy block (`kind: \"safety-block\"`) or that a deployment's job\n * policy rejected (`kind: \"policy-block\"`); absent/null otherwise.\n * User-safe by construction — narrow on `kind` before reading the rest. */\n error_hint?: JobErrorHint | null\n /** PR9: the job's credit reservation lifecycle, derived server-side from\n * `usage_logs.status`. `null` when there is no usage log to report. Never\n * changes the meaning of `credits` (the reserved amount) below. */\n credit_status?: CreditStatus | null\n /** The credits the job itself HELD when it was accepted. Never changes — a\n * job can settle below it; read {@link Job.credits_charged} for what it cost. */\n credits: number | null\n /**\n * What the job actually cost once its hold settled, INCLUDING the steps it\n * ran: a job that runs other jobs for you (a Nodaro Motion run's reference\n * preparation, mask and video) is charged for each, and they are not listed\n * on their own. A step adds its charge once it settles. Can be lower than\n * {@link Job.credits_held} (the unused part goes back to the balance). `0`\n * when the run's own hold was refunded, plus any settled steps (a refunded\n * Nodaro Motion run whose reference and mask steps committed reads\n * `credit_status: \"refunded\"` with `credits_charged: 165`). `null` while the\n * job's own hold is still open (even when some steps have settled), when\n * nothing in the run was reserved, or when its steps could not be read for a\n * moment (unknown — never a lower figure). Sum this — not `credits` — to\n * total spend. Returned by `get()` and `list()`.\n */\n credits_charged?: number | null\n /** The run's hold: the job's own `credits` plus its steps' holds (equals `credits` for a job with no steps). */\n credits_held?: number | null\n /** What went back from `credits_held` once every hold in the run settled; `null` until then. */\n credits_released?: number | null\n job_type: string | null\n created_at: string\n started_at: string | null\n completed_at: string | null\n /**\n * Provenance: which kind of caller created the job — one of\n * `\"internal\" | \"mcp\" | \"app\" | \"cli\" | \"sdk\" | \"extension\" | \"web\" | \"api\"`.\n * `source_detail` narrows it (origin host, `extension/<name>` label,\n * `sdk/<version>`, MCP client name, developer-app id). Descriptive only;\n * lets a library view label or filter media by origin.\n */\n source?: string | null\n source_detail?: string | null\n /** The generation session this job was born in (the `sessionId` sent with\n * the generation request), or null. See `client.sessions`. */\n session_id?: string | null\n /**\n * With `list({ withSessions: true })`: every session that holds the job now,\n * each linkable — empty when it is in no session (General). Absent otherwise.\n */\n sessions?: JobSessionRef[]\n /**\n * When the job was deleted, on a job read from the Trash\n * (`client.trash.list()`). A deleted job is left out of every other read, so\n * this is otherwise absent or `null`.\n */\n deleted_at?: string | null\n /**\n * Whether the job's owner favorited it (`client.gallery.toggleFavorite`).\n * Returned by `get()` and `list()`. Absent from an older server, and when\n * the server could not read it for a moment — treat absent as unknown,\n * never as `false`.\n */\n favorited?: boolean\n /**\n * The owner's rating of the job ({@link JobsResource.rate}), or `null` when\n * unrated. Returned by `get()` and `list()`; absent like `favorited`.\n */\n rating?: JobRating | null\n /**\n * The owner's own name for the job ({@link JobsResource.rename}) — \"Wedding\n * toast, final\" — or `null` until named. One line of plain text, up to 120\n * characters. Returned wherever the job is: `get()`, `list()`, a session's\n * items, the Trash. Absent from an older server.\n */\n title?: string | null\n /**\n * Where the job stands in line while it waits for a free slot: present on\n * `get()` only while `status` is `queued` (never on `list()`). See\n * {@link JobQueueInfo}.\n */\n queue?: JobQueueInfo\n}\n\nexport interface CancelJobResult {\n success: true\n cancelled: number\n /**\n * `true` when the job could not be stopped because its provider call is\n * already running — a metered LLM job's call, an external provider task. It\n * finishes and is charged only what it used.\n */\n inFlight?: boolean\n}\n\n/**\n * The kind of caller that created a job (`Job.source`). Hand-copied mirror of\n * `JOB_SOURCES` in the platform's `backend/src/lib/job-source.ts`.\n */\nexport type JobSource = \"internal\" | \"mcp\" | \"app\" | \"cli\" | \"sdk\" | \"extension\" | \"web\" | \"api\"\n\nexport interface DeleteJobResult {\n success: true\n}\n\n/** A session that holds a job now (`Job.sessions`). */\nexport interface JobSessionRef {\n id: string\n title: string | null\n /** The session's project, or `null` when it has none. */\n projectId: string | null\n}\n\nexport interface ListJobsParams {\n /** One status or several (a job matching any of them). An unknown status is a 400. */\n status?: JobStatus | readonly JobStatus[]\n /** Exact match on `input_data.type` — the route that created the job\n * (`\"llm-structured\"`, `\"video-analysis\"`, …). One value or several (up to 20). */\n type?: string | readonly string[]\n /** Exact match on `input_data.origin` — the client app that sent it. */\n origin?: string\n /** The surface that created the job (`Job.source`): `\"mcp\"` lists what your\n * MCP clients (Claude, ChatGPT, …) made. One value or several. */\n source?: JobSource | readonly JobSource[]\n /** `true`: only jobs you favorited; `false`: only jobs you did not. */\n favorited?: boolean\n /** Your rating: `\"good\"`, `\"bad\"`, any (`\"rated\"`) or none (`\"unrated\"`). */\n rating?: JobRatingFilter\n /** The jobs of one generate-image batch (`count` / `models`) — its `batchId`. */\n batchId?: string\n /**\n * The jobs a session of this project holds now — or, `\"none\"`, a session\n * with no project. Each job once, however many sessions hold it. Not with\n * `inSession: false`.\n */\n projectId?: string | \"none\"\n /**\n * `false`: the jobs no session holds now (General), whatever session they\n * were born in. `true`: the jobs at least one session holds.\n */\n inSession?: boolean\n /** `true`: each job carries `sessions`, the sessions that hold it now. */\n withSessions?: boolean\n /** Page size, 1–100 (server default 50). */\n limit?: number\n /** The previous page's `next`. */\n cursor?: string\n}\n\n/** What {@link JobsResource.rate} answers: the job's rating now. */\nexport interface RateJobResult {\n data: { jobId: string; rating: JobRating | null }\n}\n\n/** What {@link JobsResource.rename} answers: the job's name now (`null` once cleared). */\nexport interface RenameJobResult {\n data: { jobId: string; title: string | null }\n}\n\n/**\n * {@link JobsResource.fromUpload}'s body: an image edited in the browser,\n * already stored with `client.uploads.upload`, and what it was made from.\n */\nexport interface JobFromUploadParams {\n /** The edited image's `assetId`, as `client.uploads.upload` returned it. */\n assetId: string\n /** The job whose image was edited. */\n sourceJobId?: string\n /** Which of `sourceJobId`'s images was edited, when it made several. Default: its `imageUrl`. */\n sourceImageUrl?: string\n /** The upload that was edited, when the source is not a job. Not with `sourceJobId`. */\n sourceAssetId?: string\n /** The editor's design state, stored with `client.uploads.uploadJson`, so the edit can be reopened. */\n editStateUrl?: string\n /** The generation session to file the job in. */\n sessionId?: string\n}\n\n/** A list filter value as the query string carries it: several are comma-separated. */\nfunction listParam(value: string | readonly string[] | undefined): string | undefined {\n if (value === undefined) return undefined\n return typeof value === \"string\" ? value : value.join(\",\")\n}\n\nexport interface ListJobsPage {\n /**\n * A page may hold fewer than `limit` rows — even none — and still carry a\n * `next`. Page on `next`, never on `data.length`.\n */\n data: Job[]\n /** Pass back as `cursor` for the next page; `null` on the last one. */\n next: string | null\n}\n\n/**\n * Lean job status returned by `GET /v1/jobs/:id/status`. Skips the\n * `input_data` JSONB and cost columns. Its `output_data` still goes\n * through the server-only nested-field redaction. Intended for poll loops that\n * only need progress/output/error, and when the job finished.\n */\nexport interface JobStatusResult {\n id: string\n status: JobStatus\n progress?: number\n output_data?: unknown\n error_message?: string | null\n /** See {@link Job.error_detail}. */\n error_detail?: string | null\n /** PR9: see {@link Job.error_hint}. */\n error_hint?: JobErrorHint | null\n /** PR9: see {@link Job.credit_status}. */\n credit_status?: CreditStatus | null\n /** When the job finished, on the server's clock; null until it has. */\n completed_at?: string | null\n /** Present only while `status` is `queued` (the job waits for a free slot). See {@link JobQueueInfo}. */\n queue?: JobQueueInfo\n}\n\nexport class JobsResource {\n constructor(private client: NodaroClientCore) {}\n\n /** Get a single job by ID. */\n get(id: string): Promise<{ data: Job }> {\n return this.client.request(\"GET\", `/v1/jobs/${encodeURIComponent(id)}`)\n }\n\n /**\n * Your jobs, newest first (`GET /v1/jobs`), cursor-paginated. `type` and\n * `origin` filter on the job's own `input_data`, which every job carries —\n * a client app lists its runs with `{ type: \"llm-structured\", origin: \"studio\" }`.\n * `status` and `type` take one value or a list; `favorited` and `rating`\n * filter on your own marks, `source` on the surface that created the job.\n * `projectId` / `inSession` filter on where the job is now (a project's\n * sessions, or General), and `withSessions` says which sessions each job is\n * in — for \"everything in this project\". Every filter combines with AND,\n * and each job carries `favorited` and `rating`. A deleted job is never\n * listed: read the Trash with `client.trash.list()`.\n */\n list(params: ListJobsParams = {}): Promise<ListJobsPage> {\n const { status, type, source, inSession, withSessions, ...rest } = params\n return this.client.request<ListJobsPage>(\"GET\", \"/v1/jobs\", {\n query: {\n ...rest,\n status: listParam(status),\n type: listParam(type),\n source: listParam(source),\n inSession: inSession === undefined ? undefined : String(inSession),\n withSessions: withSessions ? \"true\" : undefined,\n },\n })\n }\n\n /**\n * Record an image edited in the browser as a job (`POST /v1/jobs/from-upload`):\n * a completed, private, free `image-edit` job whose `output_data.imageUrl` is\n * the upload, linked to its source in `input_data` (`sourceJobId` /\n * `sourceAssetId`, `sourceImageUrl`). It then lists, rates, favorites and\n * files into a session like any image job. One upload is one job: the same\n * `assetId` again returns the same job. OAuth apps need the `assets:write`\n * scope. A deployment's job policy can refuse the image ({@link JobBlockedError}).\n */\n fromUpload(params: JobFromUploadParams): Promise<{ data: Job }> {\n return this.client.request<{ data: Job }>(\"POST\", \"/v1/jobs/from-upload\", { body: params })\n }\n\n /**\n * Rate one of your jobs `\"good\"` or `\"bad\"`, or clear the rating with\n * `null` (`PUT /v1/jobs/:id/rating`). Only the job's owner rates it — anyone\n * else's job is a `NotFoundError`. The rating reads back as `Job.rating`\n * and filters {@link list}. OAuth apps need the `assets:write` scope.\n */\n rate(id: string, rating: JobRating | null): Promise<RateJobResult> {\n return this.client.request<RateJobResult>(\"PUT\", `/v1/jobs/${encodeURIComponent(id)}/rating`, {\n body: { rating },\n })\n }\n\n /**\n * Name one of your jobs — \"Wedding toast, final\" on a picture, a clip, a\n * track or a speech take — or clear its name with `null` (`PATCH\n * /v1/jobs/:id`). Trimmed; one line of plain text, 1–120 characters, any\n * language: a longer or multi-line name is a `NodaroError`\n * (`validation_error`). Only the job's owner names it — anyone else's job is\n * a `NotFoundError`. Free; any job type and status, the Trash included;\n * nothing else about the job changes. The name reads back as `Job.title`\n * wherever the job is returned. OAuth apps need the `assets:write` scope.\n */\n rename(id: string, title: string | null): Promise<RenameJobResult> {\n return this.client.request<RenameJobResult>(\"PATCH\", `/v1/jobs/${encodeURIComponent(id)}`, {\n body: { title },\n })\n }\n\n /**\n * Get the lean status of a single job (poll-loop friendly).\n * Hits `GET /v1/jobs/:id/status` — returns only id/status/progress/\n * output_data/error_message, with far less wire/CPU cost than `get()`.\n * Same auth + ownership semantics as {@link get}.\n */\n getStatus(id: string): Promise<{ data: JobStatusResult }> {\n return this.client.request(\n \"GET\",\n `/v1/jobs/${encodeURIComponent(id)}/status`,\n )\n }\n\n /**\n * Cancel a job. Server route is `POST /v1/jobs/:jobId/cancel`.\n * Refunds any reserved credit holds. A running LLM job priced per model\n * (metered) whose call has already started answers\n * `{ success: true, cancelled: 0, inFlight: true }`: it finishes and is\n * charged only what it used. A job stopped before its call starts is\n * refunded, except for what an earlier attempt of the same job already used\n * (a retry after a billed attempt): that is charged.\n */\n cancel(id: string): Promise<CancelJobResult> {\n return this.client.request(\n \"POST\",\n `/v1/jobs/${encodeURIComponent(id)}/cancel`,\n )\n }\n\n /**\n * Delete a job: it goes to the Trash (`client.trash.list()`). It is left out\n * of every read from then on, stays restorable for 30 days ({@link restore},\n * back into the sessions it was in), and is then deleted for good, as a\n * delete always was (a copy saved to the Library stays). `{ forever: true }` deletes a job already in the Trash for good now;\n * on a live job it fails with a 409 `NodaroError` whose `code` is\n * `\"not_in_trash\"`. Only the job's owner (or an admin) may delete it; a job\n * that is still running keeps running — cancel it first when its worker\n * should stop ({@link cancel}). Nothing is refunded. OAuth apps need the\n * `assets:write` scope.\n */\n delete(id: string, options: { forever?: boolean } = {}): Promise<DeleteJobResult> {\n return this.client.request(\n \"DELETE\",\n `/v1/jobs/${encodeURIComponent(id)}`,\n options.forever ? { query: { forever: \"true\" } } : {},\n )\n }\n\n /**\n * Bring a deleted job back from the Trash: it reappears in every read and in\n * every session it was in. A job that is not in the Trash succeeds too.\n * OAuth apps need the `assets:write` scope.\n */\n restore(id: string): Promise<{ success: true }> {\n return this.client.request(\"POST\", `/v1/jobs/${encodeURIComponent(id)}/restore`)\n }\n}\n"]}
|