@nodaro/sdk 1.29.0 → 2.1.0
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/index.cjs +380 -26
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +622 -7
- package/dist/index.d.ts +622 -7
- package/dist/index.js +361 -12
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CollaboratorRole, GenericNode, GenericEdge, WorkflowExport, WorkflowImportReport, WorkflowVisibility, ConnectedReference, DescribedReference,
|
|
1
|
+
import { CollaboratorRole, GenericNode, GenericEdge, WorkflowExport, WorkflowImportReport, WorkflowVisibility, Scene3DReference, Scene3DPlan, Scene3DEditOperation, Scene3DV2EditOperation, Scene3DJobOutputAny, Scene3DPlanV2, ModelInputAdjustment, ConnectedReference, DescribedReference, Scene3DAssetRef, TtsProvider, EntityStyle, CharacterAspectRatio, CharacterAttachColumn, LocationAssetType, LocationAttachColumn, SurroundDirection, ObjectAssetType, ObjectAttachColumn, ObjectAspectRatio, CreatureAttachColumn, PipelineInput, PipelineStatus, PipelineMode, PipelineStageName, SubGateName, ChatEnabledStage, ProposedChange, ReduceStrategyId, ReduceMeta, Voice, VoiceLibraryParams, VoiceLibraryResponse, VoiceClone, AudioFxPreset, BrowseCommunityParams, BrowseCommunityResult, CommunityCard, CommunityFullDetail, CommunityEntityType, CloneListingResult, FavoriteListingResult, CommunityReportReason, ReportListingResult, PublishListingParams, PublishListingResult, SharedListing, OrganizationView, OrgKind, OrgSettings, OrgPage, OrgMemberView, MemberStatus, WorkspaceRole, InvitationDelivery, InvitationState, InvitationView, InvitationPreview, OrgAuditEntry, UsageQuery, UsageReport, UsageLogEntry, WorkspaceSummary, WorkspaceView, WorkspaceSettings, WorkspaceMemberView, JoinCodeView, MeOrganizations } from '@nodaro/shared';
|
|
2
2
|
export { AudioFxPreset, BrowseCommunityParams, BrowseCommunityResult, CHARACTER_ASPECT_DEFAULTS, CHARACTER_ASPECT_OPTIONS, CHARACTER_STYLES, OBJECT_ASPECT_DEFAULTS as CREATURE_ASPECT_DEFAULTS, OBJECT_ASPECT_OPTIONS as CREATURE_ASPECT_OPTIONS, CREATURE_ATTACH_COLUMNS, CharacterAspectRatio, CloneListingResult, CommunityCard, CommunityEntityType, CommunityReportReason, CommunitySort, ConnectedReference, ObjectAspectRatio as CreatureAspectRatio, CreatureAttachColumn, DescribedReference, EntityStyle, FavoriteListingResult, GenericEdge, GenericNode, InvitationDelivery, InvitationPreview, InvitationState, InvitationView, JoinCodeView, LOCATION_ASSET_TYPES, LOCATION_ATTACH_COLUMNS, LocationAssetType, LocationAttachColumn, MeOrganizations, MemberStatus, OBJECT_ASPECT_DEFAULTS, OBJECT_ASPECT_OPTIONS, OBJECT_ASSET_TYPES, OBJECT_ATTACH_COLUMNS, ObjectAspectRatio, ObjectAssetType, ObjectAttachColumn, OrgAuditEntry, OrgErrorCode, OrgKind, OrgMemberView, OrgPage, OrgRole, OrgSettings, OrgStatus, OrganizationSummary, OrganizationView, PROMPT_PREFIX_KEY, PROMPT_SUFFIX_KEY, PipelineStageName, PromptAffixFields, PublishListingParams, PublishListingResult, ReduceMeta, ReduceStrategyId, ReportListingResult, SURROUND_DIRECTIONS, SharedListing, SharedVoice, SurroundDirection, USAGE_GROUP_BYS, UsageGroupBy, UsageLogEntry, UsageQuery, UsageReport, UsageReportRow, UsageReportTotals, UsageVarianceRow, Voice, VoiceClone, VoiceLibraryParams, VoiceLibraryResponse, WORKSPACE_HEADER, WorkflowExport, WorkflowExportCharacter, WorkflowExportLocation, WorkflowExportObject, WorkspaceMemberView, WorkspaceRole, WorkspaceSettings, WorkspaceSummary, WorkspaceView } from '@nodaro/shared';
|
|
3
3
|
import { DirectionFields, SubjectFields, PersonValue, WizardNodeContext, WizardQuestion, WizardSelection, RecommendedModel, FactoryPreset } from '@nodaro/prompts';
|
|
4
4
|
export { PEOPLE, PERSON_DIMENSION_LABELS, PERSON_DIMENSION_ORDER, PersonValue, RecommendedModel, WizardNodeContext, WizardOption, WizardQuestion, WizardSelection, buildPersonHints } from '@nodaro/prompts';
|
|
@@ -648,6 +648,77 @@ declare class ExecutionsResource {
|
|
|
648
648
|
}>;
|
|
649
649
|
}
|
|
650
650
|
|
|
651
|
+
/** Reuse newRevisionId for transport retries of the same immutable edit. */
|
|
652
|
+
interface RetainedScene3DEditParams {
|
|
653
|
+
newRevisionId: string;
|
|
654
|
+
expectedContentHash: string;
|
|
655
|
+
operations: readonly Scene3DV2EditOperation[];
|
|
656
|
+
lockedObjectIds?: readonly string[];
|
|
657
|
+
}
|
|
658
|
+
interface RetainedScene3DEditResult {
|
|
659
|
+
scenePlan: Scene3DPlanV2;
|
|
660
|
+
changeSummary: string;
|
|
661
|
+
}
|
|
662
|
+
type Scene3DAuthoringEngine = "basic" | "blender-cloud" | "blender-local";
|
|
663
|
+
interface Scene3DCapabilities {
|
|
664
|
+
basic: {
|
|
665
|
+
available: boolean;
|
|
666
|
+
sceneSchemaVersions: number[];
|
|
667
|
+
};
|
|
668
|
+
advanced: null | {
|
|
669
|
+
version: string;
|
|
670
|
+
engines: Array<Exclude<Scene3DAuthoringEngine, "basic">>;
|
|
671
|
+
sceneSchemaVersions: number[];
|
|
672
|
+
maxRepairPasses: number;
|
|
673
|
+
};
|
|
674
|
+
}
|
|
675
|
+
interface Scene3DEngineParams {
|
|
676
|
+
/** Basic is the default. Discover optional engines through scene3d.capabilities(). */
|
|
677
|
+
engine?: Scene3DAuthoringEngine;
|
|
678
|
+
acceptedSceneSchemaVersions?: readonly number[];
|
|
679
|
+
localConnectionId?: string;
|
|
680
|
+
quoteId?: string;
|
|
681
|
+
maxRepairPasses?: number;
|
|
682
|
+
}
|
|
683
|
+
/** Structured authoring inputs; reference roles are interpreted by the platform. */
|
|
684
|
+
interface GenerateScene3DParams extends Record<string, unknown>, Scene3DEngineParams {
|
|
685
|
+
prompt: string;
|
|
686
|
+
durationSeconds?: number;
|
|
687
|
+
fps?: number;
|
|
688
|
+
aspectRatio?: string;
|
|
689
|
+
references?: readonly Scene3DReference[];
|
|
690
|
+
llmModel?: string;
|
|
691
|
+
reasoningEffort?: string;
|
|
692
|
+
workflowId?: string;
|
|
693
|
+
nodeId?: string;
|
|
694
|
+
}
|
|
695
|
+
/** Editing creates a new revision and never mutates the supplied scene. */
|
|
696
|
+
interface EditScene3DParams extends Record<string, unknown>, Scene3DEngineParams {
|
|
697
|
+
scenePlan: Scene3DPlan;
|
|
698
|
+
expectedRevisionId: string;
|
|
699
|
+
/** Replace the complete reference set, including clearing it with an empty list. Default: merge by id. */
|
|
700
|
+
replaceReferences?: boolean;
|
|
701
|
+
/** Supply an instruction or deterministic operations, never both. */
|
|
702
|
+
prompt?: string;
|
|
703
|
+
operations?: readonly (Scene3DEditOperation | Scene3DV2EditOperation)[];
|
|
704
|
+
references?: readonly Scene3DReference[];
|
|
705
|
+
lockedObjectIds?: readonly string[];
|
|
706
|
+
selectedObjectIds?: readonly string[];
|
|
707
|
+
llmModel?: string;
|
|
708
|
+
reasoningEffort?: string;
|
|
709
|
+
workflowId?: string;
|
|
710
|
+
nodeId?: string;
|
|
711
|
+
}
|
|
712
|
+
/** Render the exact scene revision through the existing render-video node. */
|
|
713
|
+
interface RenderScene3DParams extends Record<string, unknown> {
|
|
714
|
+
planType: "3d-scene";
|
|
715
|
+
plan: Scene3DPlan;
|
|
716
|
+
workflowId?: string;
|
|
717
|
+
nodeId?: string;
|
|
718
|
+
}
|
|
719
|
+
/** Preserve the shared wire contract while allowing additive job metadata. */
|
|
720
|
+
type Scene3DJobOutput = Readonly<Scene3DJobOutputAny> & Readonly<Record<string, unknown>>;
|
|
721
|
+
|
|
651
722
|
type NodeCategory = "input" | "parameter" | "ai-image" | "ai-video" | "ai-audio" | "ai-text" | "processing" | "composition" | "trigger" | "output" | "control" | "entity" | "utility";
|
|
652
723
|
type OutputType = "text" | "image" | "video" | "audio" | "data" | "none";
|
|
653
724
|
/**
|
|
@@ -893,9 +964,9 @@ declare class NodesResource {
|
|
|
893
964
|
}>;
|
|
894
965
|
/**
|
|
895
966
|
* Run a single node directly without wrapping it in a workflow. Posts
|
|
896
|
-
* `params` as the request body to
|
|
897
|
-
*
|
|
898
|
-
*
|
|
967
|
+
* `params` as the request body to the node's API route. Most use
|
|
968
|
+
* `POST /v1/<type>`; scene authoring uses `/v1/3d-scene/generate|edit`,
|
|
969
|
+
* and render-video with a planType uses `/v1/render-video/plan`.
|
|
899
970
|
*
|
|
900
971
|
* This is the SDK equivalent of the MCP server's verb tools — and the
|
|
901
972
|
* path the Nodaro CLI uses for `nodaro nodes run <type>`.
|
|
@@ -910,6 +981,9 @@ declare class NodesResource {
|
|
|
910
981
|
* @param params Request body. Field names must match the node's
|
|
911
982
|
* `inputSchema` (see `get(type).inputSchema`).
|
|
912
983
|
*/
|
|
984
|
+
run(type: "generate-3d-scene", params: GenerateScene3DParams): Promise<RunNodeResult>;
|
|
985
|
+
run(type: "edit-3d-scene", params: EditScene3DParams): Promise<RunNodeResult>;
|
|
986
|
+
run(type: "render-video", params: RenderScene3DParams): Promise<RunNodeResult>;
|
|
913
987
|
run(type: "generate-image", params?: GenerateImageParams): Promise<RunNodeResult>;
|
|
914
988
|
run(type: "generate-video", params?: GenerateVideoParams): Promise<RunNodeResult>;
|
|
915
989
|
run(type: "text-to-video", params: TextToVideoParams): Promise<RunNodeResult>;
|
|
@@ -942,11 +1016,14 @@ declare class NodesResource {
|
|
|
942
1016
|
* @param params Request body — field names match the node's `inputSchema`.
|
|
943
1017
|
* @param opts `signal` / `onProgress` / `pollMs` / `maxMs`.
|
|
944
1018
|
*/
|
|
1019
|
+
runAndWait(type: "generate-3d-scene", params: GenerateScene3DParams, options?: RunAndWaitOptions): Promise<Scene3DJobOutput>;
|
|
1020
|
+
runAndWait(type: "edit-3d-scene", params: EditScene3DParams, options?: RunAndWaitOptions): Promise<Scene3DJobOutput>;
|
|
1021
|
+
runAndWait(type: "render-video", params: RenderScene3DParams, options?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
945
1022
|
runAndWait(type: "generate-image", params?: GenerateImageParams, opts?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
946
1023
|
runAndWait(type: "generate-video", params?: GenerateVideoParams, opts?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
947
1024
|
runAndWait(type: "text-to-video", params: TextToVideoParams, opts?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
948
1025
|
runAndWait(type: "assemble-narrated-video", params?: AssembleNarratedVideoParams, opts?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
949
|
-
runAndWait(type:
|
|
1026
|
+
runAndWait<T extends string>(type: T, params?: Record<string, unknown>, opts?: RunAndWaitOptions): Promise<T extends "generate-3d-scene" | "edit-3d-scene" ? Scene3DJobOutput : NodeJobOutput>;
|
|
950
1027
|
/**
|
|
951
1028
|
* Fan out N async runs of the same node `type` to completion concurrently —
|
|
952
1029
|
* the candidate-grid path (generate N stills/clips in parallel). Each runs
|
|
@@ -968,6 +1045,30 @@ declare class NodesResource {
|
|
|
968
1045
|
private pollJob;
|
|
969
1046
|
}
|
|
970
1047
|
|
|
1048
|
+
/** Scene authoring and render-only export through the same platform nodes. */
|
|
1049
|
+
declare class Scene3DResource {
|
|
1050
|
+
private client;
|
|
1051
|
+
constructor(client: NodaroClient);
|
|
1052
|
+
capabilities(): Promise<Scene3DCapabilities>;
|
|
1053
|
+
/** Persist deterministic overlays without an LLM or a generation charge. */
|
|
1054
|
+
applyEdits(revisionId: string, params: RetainedScene3DEditParams): Promise<RetainedScene3DEditResult>;
|
|
1055
|
+
/** Asset access is scoped to an exact retained revision, with fresh authentication. */
|
|
1056
|
+
assetBytes(revisionId: string, asset: Scene3DAssetRef, options?: {
|
|
1057
|
+
signal?: AbortSignal;
|
|
1058
|
+
}): Promise<ArrayBuffer>;
|
|
1059
|
+
/** The editable native file has its own authorization lane. */
|
|
1060
|
+
sourceBytes(revisionId: string, options?: {
|
|
1061
|
+
signal?: AbortSignal;
|
|
1062
|
+
}): Promise<ArrayBuffer>;
|
|
1063
|
+
generate(params: GenerateScene3DParams): Promise<RunNodeResult>;
|
|
1064
|
+
generateAndWait(params: GenerateScene3DParams, options?: RunAndWaitOptions): Promise<Scene3DJobOutput>;
|
|
1065
|
+
edit(params: EditScene3DParams): Promise<RunNodeResult>;
|
|
1066
|
+
editAndWait(params: EditScene3DParams, options?: RunAndWaitOptions): Promise<Scene3DJobOutput>;
|
|
1067
|
+
/** Uses the supplied immutable revision; never starts authoring or a rebuild. */
|
|
1068
|
+
render(params: RenderScene3DParams): Promise<RunNodeResult>;
|
|
1069
|
+
renderAndWait(params: RenderScene3DParams, options?: RunAndWaitOptions): Promise<NodeJobOutput>;
|
|
1070
|
+
}
|
|
1071
|
+
|
|
971
1072
|
/**
|
|
972
1073
|
* OAuth scopes that a developer app may request. Mirrors
|
|
973
1074
|
* `backend/src/lib/scopes.ts#ALL_SCOPES`.
|
|
@@ -5442,6 +5543,481 @@ declare class RecastResource {
|
|
|
5442
5543
|
resolveGate(recastId: string, input: ResolveRecastGateInput): Promise<Record<string, unknown>>;
|
|
5443
5544
|
}
|
|
5444
5545
|
|
|
5546
|
+
/**
|
|
5547
|
+
* Studio productions — `/v1/studio/productions`.
|
|
5548
|
+
*
|
|
5549
|
+
* A production is a Nodaro workflow whose `settings.studio` holds the shots:
|
|
5550
|
+
* each shot a framed still, an optional animated clip, and the plan, looks,
|
|
5551
|
+
* cast bindings and voice that made them. These routes are the platform's own
|
|
5552
|
+
* reader and writer of that document, so an agent, a script and the studio app
|
|
5553
|
+
* are looking at ONE production rather than three opinions about one row.
|
|
5554
|
+
*
|
|
5555
|
+
* Two rules run through the whole surface:
|
|
5556
|
+
*
|
|
5557
|
+
* - **Every change is an OPERATION** ({@link StudioProductionsResource.ops}),
|
|
5558
|
+
* addressed by stable key — a shot id, a role slug, a result's job id or url
|
|
5559
|
+
* — and never by position. That is what lets two writers hold the same
|
|
5560
|
+
* production open: a batch composed against a slightly older version still
|
|
5561
|
+
* applies correctly to the newest one, and the response says whether it was
|
|
5562
|
+
* rebased.
|
|
5563
|
+
* - **Generation is run-then-poll.** A still or clip run returns job ids and
|
|
5564
|
+
* records a marker on the production; the results land when anyone — your
|
|
5565
|
+
* poll, the app, a later {@link StudioProductionsResource.reconcile} —
|
|
5566
|
+
* reports the finished job. Nothing waits minutes inside a request.
|
|
5567
|
+
*
|
|
5568
|
+
* Reads are `detail: "summary"` by default (counts and the active urls);
|
|
5569
|
+
* `detail: "full"` adds every result with the context that regenerates it.
|
|
5570
|
+
*
|
|
5571
|
+
* **The ENVELOPES are typed here; the production DOCUMENT is not.** A view, a
|
|
5572
|
+
* summary, a shot and an operation are open JSON on this surface
|
|
5573
|
+
* ({@link StudioProduction}, `ops: unknown[]`) — their field-level types ship
|
|
5574
|
+
* with the studio app, which is the one consumer that narrows them, and a
|
|
5575
|
+
* second spelling of that vocabulary in the SDK would drift from it the first
|
|
5576
|
+
* time either grew. Everything a caller branches on — `version`, `rebased`,
|
|
5577
|
+
* `receipts`, `warnings`, a quote's `credits`, a run's `jobIds` — is typed.
|
|
5578
|
+
*
|
|
5579
|
+
* Cloud edition only: these routes 404 on deployments that do not serve them.
|
|
5580
|
+
* Feature-detect once with `list()` — a deployment without them 404s that too,
|
|
5581
|
+
* where a deployment with them answers an empty page.
|
|
5582
|
+
*/
|
|
5583
|
+
/**
|
|
5584
|
+
* A production, a summary, a shot, a receipt's target: open JSON.
|
|
5585
|
+
*
|
|
5586
|
+
* Deliberately not narrowed here — see the note at the top of this module.
|
|
5587
|
+
*/
|
|
5588
|
+
type StudioProduction = Record<string, unknown>;
|
|
5589
|
+
/** How much of a production a read returns. */
|
|
5590
|
+
type StudioProductionDetail = "summary" | "full";
|
|
5591
|
+
/** One thing wrong with a plan, addressed at the field that is wrong. */
|
|
5592
|
+
interface StudioPlanIssue {
|
|
5593
|
+
path: string;
|
|
5594
|
+
message: string;
|
|
5595
|
+
hint?: string;
|
|
5596
|
+
}
|
|
5597
|
+
/** `GET …/skill` — the authoring skill, rendered at request time from what is live. */
|
|
5598
|
+
interface StudioSkillResponse {
|
|
5599
|
+
/** The authoring guide. */
|
|
5600
|
+
skill: string;
|
|
5601
|
+
/** Every picker, model and enum, in full. */
|
|
5602
|
+
catalog: string;
|
|
5603
|
+
/** The strict JSON Schema a plan is validated against. */
|
|
5604
|
+
schema: Record<string, unknown>;
|
|
5605
|
+
/** The operating guide: the tool map, the loops, the rules. */
|
|
5606
|
+
operating: string;
|
|
5607
|
+
/** The versions the three were rendered from — bare semver, no package names. */
|
|
5608
|
+
generatedFrom: {
|
|
5609
|
+
prompts: string;
|
|
5610
|
+
shared: string;
|
|
5611
|
+
codec: string;
|
|
5612
|
+
};
|
|
5613
|
+
}
|
|
5614
|
+
interface StudioValidatePlanResponse {
|
|
5615
|
+
valid: boolean;
|
|
5616
|
+
errors: StudioPlanIssue[];
|
|
5617
|
+
warnings: StudioPlanIssue[];
|
|
5618
|
+
summary?: {
|
|
5619
|
+
name?: string;
|
|
5620
|
+
scenes: number;
|
|
5621
|
+
shots: number;
|
|
5622
|
+
cast: number;
|
|
5623
|
+
/** Cast entries that matched a row in the caller's library. */
|
|
5624
|
+
bound: number;
|
|
5625
|
+
};
|
|
5626
|
+
}
|
|
5627
|
+
interface StudioListProductionsResponse {
|
|
5628
|
+
data: StudioProduction[];
|
|
5629
|
+
nextCursor?: string;
|
|
5630
|
+
}
|
|
5631
|
+
/** What a create or an import did, in the words a receipt would use. */
|
|
5632
|
+
interface StudioImportSummary {
|
|
5633
|
+
shotsAdded: number;
|
|
5634
|
+
castEnrolled: number;
|
|
5635
|
+
/** Cast entries that resolved to a row in the caller's library. */
|
|
5636
|
+
castBound: number;
|
|
5637
|
+
}
|
|
5638
|
+
interface StudioProductionResponse {
|
|
5639
|
+
production: StudioProduction;
|
|
5640
|
+
warnings?: StudioPlanIssue[];
|
|
5641
|
+
summary?: StudioImportSummary;
|
|
5642
|
+
}
|
|
5643
|
+
interface StudioCreateProductionRequest {
|
|
5644
|
+
name?: string;
|
|
5645
|
+
plan?: Record<string, unknown>;
|
|
5646
|
+
}
|
|
5647
|
+
/** The caller's own retry token — 8–128 chars of `A-Za-z0-9_.:-`, never derived. */
|
|
5648
|
+
type StudioClientRequestId = string;
|
|
5649
|
+
/**
|
|
5650
|
+
* A batch of operations, applied atomically.
|
|
5651
|
+
*
|
|
5652
|
+
* `ops` is `unknown[]`: the operation union is the studio app's vocabulary and
|
|
5653
|
+
* the route validates it, refusing the whole batch with the offending index.
|
|
5654
|
+
* The served operating guide is the runtime reference for what an operation
|
|
5655
|
+
* looks like.
|
|
5656
|
+
*/
|
|
5657
|
+
interface StudioOpsRequest {
|
|
5658
|
+
/** Applied in order. At most 100 per request. */
|
|
5659
|
+
ops: unknown[];
|
|
5660
|
+
/**
|
|
5661
|
+
* The version the batch was composed against. INFORMATIONAL by default: the
|
|
5662
|
+
* operations address by stable KEY, so a batch built on a slightly older
|
|
5663
|
+
* document still applies exactly to the newest one, and the response says
|
|
5664
|
+
* `rebased: true`. Omitting it means "apply to whatever is there".
|
|
5665
|
+
*/
|
|
5666
|
+
baseVersion?: number;
|
|
5667
|
+
/**
|
|
5668
|
+
* Refuse to rebase. With `strict: true` a `baseVersion` older than the stored
|
|
5669
|
+
* one is a 409 `workflow_conflict` carrying the current production, instead
|
|
5670
|
+
* of a rebased apply — for the rare "replace exactly what I read" intent.
|
|
5671
|
+
*/
|
|
5672
|
+
strict?: boolean;
|
|
5673
|
+
/** Your own token for this batch, so a transport retry is not applied twice. */
|
|
5674
|
+
clientRequestId?: StudioClientRequestId;
|
|
5675
|
+
}
|
|
5676
|
+
/**
|
|
5677
|
+
* One line of what an operation did, in the words a change log would use.
|
|
5678
|
+
*
|
|
5679
|
+
* Past tense, the target named the way the user sees it, the side effect in a
|
|
5680
|
+
* trailing parenthetical: `Deleted take 2 of Shot 1 (in the bin).`
|
|
5681
|
+
*/
|
|
5682
|
+
interface StudioOpsReceipt {
|
|
5683
|
+
/** The operation this line reports, by name. */
|
|
5684
|
+
op: string;
|
|
5685
|
+
/** Past tense, naming the target the way a person would. */
|
|
5686
|
+
summary: string;
|
|
5687
|
+
/** Ids the operation MINTED — never ids the caller supplied. */
|
|
5688
|
+
ids?: string[];
|
|
5689
|
+
}
|
|
5690
|
+
/** What a batch produced. Adopt `production` whole; do not merge into it. */
|
|
5691
|
+
interface StudioOpsResponse {
|
|
5692
|
+
/** The canonical production AFTER the batch. */
|
|
5693
|
+
production: StudioProduction;
|
|
5694
|
+
/** The version the batch produced. Carry it as the next `baseVersion`. */
|
|
5695
|
+
version: number;
|
|
5696
|
+
/** True when the batch was applied to a newer document than it named. */
|
|
5697
|
+
rebased: boolean;
|
|
5698
|
+
/** One per operation, in order. */
|
|
5699
|
+
receipts: StudioOpsReceipt[];
|
|
5700
|
+
/**
|
|
5701
|
+
* Things worth saying that are not failures — an operation that changed
|
|
5702
|
+
* nothing, a rename that rewrote four prompts. A warning never rejects a
|
|
5703
|
+
* batch; a refusal does.
|
|
5704
|
+
*/
|
|
5705
|
+
warnings: string[];
|
|
5706
|
+
}
|
|
5707
|
+
/** What landing the finished jobs did. */
|
|
5708
|
+
interface StudioReconcileResponse {
|
|
5709
|
+
/** Job ids whose media is now on the production. */
|
|
5710
|
+
landed: string[];
|
|
5711
|
+
/** Job ids still running — their markers stay; call again later. */
|
|
5712
|
+
pending: string[];
|
|
5713
|
+
/** Job ids that failed or were cancelled; their markers are cleared. */
|
|
5714
|
+
failed: string[];
|
|
5715
|
+
/** One line per landing that had something to say. */
|
|
5716
|
+
warnings: string[];
|
|
5717
|
+
/** The production after the landings. */
|
|
5718
|
+
production: StudioProduction;
|
|
5719
|
+
/** Its version — unchanged when nothing landed. */
|
|
5720
|
+
version: number;
|
|
5721
|
+
}
|
|
5722
|
+
/** `POST …/:id/describe` — a Director run that will land as scenes. */
|
|
5723
|
+
interface StudioDescribeRequest {
|
|
5724
|
+
brief: string;
|
|
5725
|
+
llmModel: string;
|
|
5726
|
+
/** `"append"` adds the drafted scenes; `"replace"` rewrites the film. */
|
|
5727
|
+
mode?: "append" | "replace";
|
|
5728
|
+
label?: string;
|
|
5729
|
+
clientRequestId?: StudioClientRequestId;
|
|
5730
|
+
}
|
|
5731
|
+
/**
|
|
5732
|
+
* `POST …/:id/generate` — one framing or directing run for one shot.
|
|
5733
|
+
*
|
|
5734
|
+
* `overrides` is what the CALL owns over what the shot's plan says: the model,
|
|
5735
|
+
* the prose, the aspect, the direction ids. Open JSON, because the request
|
|
5736
|
+
* builders' own option types are the contract and they ship with the studio.
|
|
5737
|
+
*/
|
|
5738
|
+
interface StudioGenerateRequest {
|
|
5739
|
+
kind: "still" | "clip";
|
|
5740
|
+
shotId: string;
|
|
5741
|
+
/** Candidates to fan out (stills); the builder clamps it to the catalog's range. */
|
|
5742
|
+
count?: number;
|
|
5743
|
+
/** The directing input mode for a clip; absent ⇒ derived from the inputs. */
|
|
5744
|
+
mode?: "start" | "references";
|
|
5745
|
+
/** Price the run and return; nothing is submitted and nothing is written. */
|
|
5746
|
+
dryRun?: boolean;
|
|
5747
|
+
clientRequestId?: StudioClientRequestId;
|
|
5748
|
+
overrides?: Record<string, unknown>;
|
|
5749
|
+
}
|
|
5750
|
+
/** Which video route a directing run went to — chosen from the inputs, never asked for. */
|
|
5751
|
+
type StudioVideoLane = "generate-video" | "text-to-video";
|
|
5752
|
+
/** `dryRun: true` — what this run would cost, and nothing else. */
|
|
5753
|
+
interface StudioGenerateEstimate {
|
|
5754
|
+
dryRun: true;
|
|
5755
|
+
provider: string;
|
|
5756
|
+
count: number;
|
|
5757
|
+
/** `null` when the model is unpriced or the instance runs without credits. */
|
|
5758
|
+
credits: number | null;
|
|
5759
|
+
lane?: StudioVideoLane;
|
|
5760
|
+
}
|
|
5761
|
+
/**
|
|
5762
|
+
* A started (or already-started) run.
|
|
5763
|
+
*
|
|
5764
|
+
* `deduped` means the same `clientRequestId` came back and the job ids were
|
|
5765
|
+
* answered from the production's own markers — nothing was submitted and
|
|
5766
|
+
* nothing was charged, so `production` is absent.
|
|
5767
|
+
*/
|
|
5768
|
+
interface StudioGenerateResponse {
|
|
5769
|
+
jobIds: string[];
|
|
5770
|
+
lane?: StudioVideoLane;
|
|
5771
|
+
deduped?: true;
|
|
5772
|
+
production?: StudioProduction;
|
|
5773
|
+
receipts?: StudioOpsReceipt[];
|
|
5774
|
+
warnings?: string[];
|
|
5775
|
+
}
|
|
5776
|
+
/** `POST …/:id/frame` — a still pulled out of the shot's clip. */
|
|
5777
|
+
interface StudioFrameRequest {
|
|
5778
|
+
shotId: string;
|
|
5779
|
+
mode?: "first" | "last" | "timestamp";
|
|
5780
|
+
/** Seconds, when `mode` is `"timestamp"`. */
|
|
5781
|
+
timestamp?: number;
|
|
5782
|
+
/** Where the grabbed image lands. `"new-shot"` inserts a shot after this one. */
|
|
5783
|
+
target?: "new-shot" | "start-frame" | "end-frame" | "still";
|
|
5784
|
+
clientRequestId?: StudioClientRequestId;
|
|
5785
|
+
}
|
|
5786
|
+
/** `POST …/:id/voice` — synthesize a shot's spoken line and record it. */
|
|
5787
|
+
interface StudioVoiceRequest {
|
|
5788
|
+
shotId: string;
|
|
5789
|
+
text: string;
|
|
5790
|
+
voiceId?: string;
|
|
5791
|
+
voiceType?: "premade" | "custom" | "library";
|
|
5792
|
+
ttsProvider?: string;
|
|
5793
|
+
/** The delivery levers; the text-to-speech route owns their bounds. */
|
|
5794
|
+
delivery?: Record<string, number>;
|
|
5795
|
+
clientRequestId?: StudioClientRequestId;
|
|
5796
|
+
}
|
|
5797
|
+
/** `POST …/:id/revoice` — recast the voices of the shot's active clip. */
|
|
5798
|
+
interface StudioRevoiceRequest {
|
|
5799
|
+
shotId: string;
|
|
5800
|
+
/** The speaker-ordered recast plan, forwarded to the voice route verbatim. */
|
|
5801
|
+
plan: Record<string, unknown>;
|
|
5802
|
+
clientRequestId?: StudioClientRequestId;
|
|
5803
|
+
}
|
|
5804
|
+
/** `POST …/:id/music` — the film's soundtrack. */
|
|
5805
|
+
interface StudioMusicRequest {
|
|
5806
|
+
prompt: string;
|
|
5807
|
+
duration?: number;
|
|
5808
|
+
instrumental?: boolean;
|
|
5809
|
+
vocalGender?: string;
|
|
5810
|
+
model?: string;
|
|
5811
|
+
clientRequestId?: StudioClientRequestId;
|
|
5812
|
+
}
|
|
5813
|
+
/**
|
|
5814
|
+
* What a route that finished its work answers with: the production as it now
|
|
5815
|
+
* stands, plus whatever that route produced.
|
|
5816
|
+
*
|
|
5817
|
+
* `jobId` is present on the routes that only STARTED something (a revoice, a
|
|
5818
|
+
* soundtrack, a draft) — the result lands through its marker.
|
|
5819
|
+
*/
|
|
5820
|
+
interface StudioMediaResponse {
|
|
5821
|
+
production: StudioProduction;
|
|
5822
|
+
/** The grabbed frame's url, on the frame route. */
|
|
5823
|
+
url?: string;
|
|
5824
|
+
jobId?: string;
|
|
5825
|
+
receipts?: StudioOpsReceipt[];
|
|
5826
|
+
warnings?: string[];
|
|
5827
|
+
}
|
|
5828
|
+
/**
|
|
5829
|
+
* `GET …/:id/export-plan` — the ordered steps an export would run.
|
|
5830
|
+
*
|
|
5831
|
+
* The caller runs them with the verbs that already exist; a route that chained
|
|
5832
|
+
* three minutes-long jobs is the long-lived request every client times out on.
|
|
5833
|
+
*/
|
|
5834
|
+
interface StudioExportPlanResponse {
|
|
5835
|
+
/** False when the production has fewer than two clips — nothing to stitch. */
|
|
5836
|
+
canExport: boolean;
|
|
5837
|
+
steps: StudioExportStep[];
|
|
5838
|
+
/** The step whose output IS the film, or `null` when nothing can run. */
|
|
5839
|
+
resultStepId: string | null;
|
|
5840
|
+
/** Total credits, or `null` when ANY step is unpriced (a partial sum understates). */
|
|
5841
|
+
estimate: number | null;
|
|
5842
|
+
/** The credit models with no price, each named once, in step order. */
|
|
5843
|
+
unpriced: string[];
|
|
5844
|
+
}
|
|
5845
|
+
interface StudioExportStep {
|
|
5846
|
+
/** Stable within one plan and derived from the production, never minted. */
|
|
5847
|
+
id: string;
|
|
5848
|
+
label: string;
|
|
5849
|
+
/** The node this step runs — `merge-video-audio`, `combine-videos`, `video-upscale`. */
|
|
5850
|
+
node: string;
|
|
5851
|
+
creditModel: string;
|
|
5852
|
+
credits: number | null;
|
|
5853
|
+
params: Record<string, unknown>;
|
|
5854
|
+
}
|
|
5855
|
+
/** `POST …/:id/clone` — a copy, which always starts private and visible. */
|
|
5856
|
+
interface StudioCloneRequest {
|
|
5857
|
+
name?: string;
|
|
5858
|
+
}
|
|
5859
|
+
/** Either arm of a generation reply: the quote, or the run that started. */
|
|
5860
|
+
type StudioGenerateResult = StudioGenerateEstimate | StudioGenerateResponse;
|
|
5861
|
+
/** True when a generation reply is the `dryRun` QUOTE rather than a started run. */
|
|
5862
|
+
declare function isStudioGenerateEstimate(result: StudioGenerateResult): result is StudioGenerateEstimate;
|
|
5863
|
+
/** What a `generateStill` / `generateClip` call decides, beyond `kind` and the shot. */
|
|
5864
|
+
type StudioGenerateOptions = Omit<StudioGenerateRequest, "kind" | "shotId">;
|
|
5865
|
+
/**
|
|
5866
|
+
* A route that only STARTED something — a draft, a revoice, a soundtrack. Its
|
|
5867
|
+
* `jobId` is always there, which is what makes `const { jobId } = await …` and
|
|
5868
|
+
* a poll the honest next line.
|
|
5869
|
+
*
|
|
5870
|
+
* `StudioMediaResponse` leaves `jobId` optional because the routes that FINISH
|
|
5871
|
+
* their work (a frame, a voiceover) share the shape and have no job to name.
|
|
5872
|
+
*/
|
|
5873
|
+
type StudioJobStartedResponse = StudioMediaResponse & {
|
|
5874
|
+
jobId: string;
|
|
5875
|
+
};
|
|
5876
|
+
interface ListStudioProductionsOptions {
|
|
5877
|
+
limit?: number;
|
|
5878
|
+
/** From a previous page's `nextCursor`. */
|
|
5879
|
+
cursor?: string;
|
|
5880
|
+
/** Include the rows the dashboard hides. Off by default. */
|
|
5881
|
+
includeArchived?: boolean;
|
|
5882
|
+
}
|
|
5883
|
+
interface GetProductionOptions {
|
|
5884
|
+
detail?: StudioProductionDetail;
|
|
5885
|
+
/** Read ONE shot — the cheap way to re-read after a generation. */
|
|
5886
|
+
shotId?: string;
|
|
5887
|
+
}
|
|
5888
|
+
interface StudioExportPlanOptions {
|
|
5889
|
+
/** Plan the 4K finish too. Expensive, so it is always explicit. */
|
|
5890
|
+
upscale?: boolean;
|
|
5891
|
+
}
|
|
5892
|
+
/** `client.studio.productions` — see the note at the top of this module. */
|
|
5893
|
+
declare class StudioProductionsResource {
|
|
5894
|
+
private client;
|
|
5895
|
+
constructor(client: NodaroClient);
|
|
5896
|
+
private path;
|
|
5897
|
+
/**
|
|
5898
|
+
* The authoring guide, the full catalog, the plan's JSON Schema and the
|
|
5899
|
+
* operating guide — rendered server-side from the version that is live, so
|
|
5900
|
+
* they describe the platform you are actually talking to. Free.
|
|
5901
|
+
*/
|
|
5902
|
+
skill(): Promise<StudioSkillResponse>;
|
|
5903
|
+
/**
|
|
5904
|
+
* Check a plan before it becomes anything. Free, persists nothing, and
|
|
5905
|
+
* resolves cast names against YOUR library — loop on `errors` until
|
|
5906
|
+
* `valid: true`, then `create({ plan })`.
|
|
5907
|
+
*/
|
|
5908
|
+
validatePlan(plan: Record<string, unknown>): Promise<StudioValidatePlanResponse>;
|
|
5909
|
+
/** Your productions, newest first. Archived rows are hidden unless asked for. */
|
|
5910
|
+
list(opts?: ListStudioProductionsOptions): Promise<StudioListProductionsResponse>;
|
|
5911
|
+
/**
|
|
5912
|
+
* One production. A pure read — it never lands a finished job, so call
|
|
5913
|
+
* {@link reconcile} first if you are waiting on one.
|
|
5914
|
+
*/
|
|
5915
|
+
get(productionId: string, opts?: GetProductionOptions): Promise<StudioProduction>;
|
|
5916
|
+
/**
|
|
5917
|
+
* The ordered steps that assemble the film, with what they will cost. Run
|
|
5918
|
+
* them yourself with the ordinary verbs — nothing here blocks for minutes,
|
|
5919
|
+
* and nothing here spends.
|
|
5920
|
+
*/
|
|
5921
|
+
exportPlan(productionId: string, opts?: StudioExportPlanOptions): Promise<StudioExportPlanResponse>;
|
|
5922
|
+
/** A new production, optionally landed from a plan in the same call. */
|
|
5923
|
+
create(input?: StudioCreateProductionRequest): Promise<StudioProductionResponse>;
|
|
5924
|
+
/**
|
|
5925
|
+
* Apply a batch of operations. Atomic: one bad operation refuses the whole
|
|
5926
|
+
* batch with a `StudioOpError` naming its index, and nothing is written. On
|
|
5927
|
+
* success adopt `production` wholesale and carry `version` forward as the
|
|
5928
|
+
* next `baseVersion`.
|
|
5929
|
+
*/
|
|
5930
|
+
ops(productionId: string, input: StudioOpsRequest): Promise<StudioOpsResponse>;
|
|
5931
|
+
/**
|
|
5932
|
+
* Land every generation that has finished since you last looked, and report
|
|
5933
|
+
* what is still running. The one call that turns finished jobs into results
|
|
5934
|
+
* without a browser open. It writes only when something actually landed.
|
|
5935
|
+
*/
|
|
5936
|
+
reconcile(productionId: string): Promise<StudioReconcileResponse>;
|
|
5937
|
+
/** Add a plan's scenes to a production that already exists. */
|
|
5938
|
+
importPlan(productionId: string, plan: Record<string, unknown>, opts?: {
|
|
5939
|
+
mode?: "append";
|
|
5940
|
+
}): Promise<StudioProductionResponse>;
|
|
5941
|
+
/**
|
|
5942
|
+
* Turn a brief into scenes. The run is a platform job: poll it, and its
|
|
5943
|
+
* scenes land through {@link reconcile}. The production comes back with the
|
|
5944
|
+
* run recorded on it as a pending draft.
|
|
5945
|
+
*/
|
|
5946
|
+
describe(productionId: string, input: StudioDescribeRequest): Promise<StudioJobStartedResponse>;
|
|
5947
|
+
/**
|
|
5948
|
+
* Frame or animate one shot.
|
|
5949
|
+
*
|
|
5950
|
+
* The request is assembled server-side from the shot's own plan, looks and
|
|
5951
|
+
* bound references, so a scripted run and a press of the button in the app
|
|
5952
|
+
* produce the same media; `overrides` changes THIS run without changing the
|
|
5953
|
+
* shot. Prefer {@link generateStill} / {@link generateClip}, which say which
|
|
5954
|
+
* kind they mean.
|
|
5955
|
+
*
|
|
5956
|
+
* `dryRun: true` returns the quote and writes nothing — narrow the reply with
|
|
5957
|
+
* {@link isStudioGenerateEstimate}.
|
|
5958
|
+
*/
|
|
5959
|
+
generate(productionId: string, input: StudioGenerateRequest & {
|
|
5960
|
+
dryRun: true;
|
|
5961
|
+
}): Promise<StudioGenerateEstimate>;
|
|
5962
|
+
generate(productionId: string, input: StudioGenerateRequest): Promise<StudioGenerateResult>;
|
|
5963
|
+
/**
|
|
5964
|
+
* Frame a shot: submit `count` candidates and record a pending marker for
|
|
5965
|
+
* each. Results ACCUMULATE — a generate never replaces what is there.
|
|
5966
|
+
*
|
|
5967
|
+
* `clientRequestId` makes a retry safe: the same token answers with the jobs
|
|
5968
|
+
* the first call started (`deduped: true`) and submits nothing. Never retry a
|
|
5969
|
+
* spend without it.
|
|
5970
|
+
*/
|
|
5971
|
+
generateStill(productionId: string, shotId: string, opts: StudioGenerateOptions & {
|
|
5972
|
+
dryRun: true;
|
|
5973
|
+
}): Promise<StudioGenerateEstimate>;
|
|
5974
|
+
generateStill(productionId: string, shotId: string, opts?: StudioGenerateOptions): Promise<StudioGenerateResult>;
|
|
5975
|
+
/**
|
|
5976
|
+
* Animate a shot. The LANE is chosen from the shot's inputs (a start frame,
|
|
5977
|
+
* references, a prompt) — never passed in — and reported back as `lane`.
|
|
5978
|
+
*/
|
|
5979
|
+
generateClip(productionId: string, shotId: string, opts: StudioGenerateOptions & {
|
|
5980
|
+
dryRun: true;
|
|
5981
|
+
}): Promise<StudioGenerateEstimate>;
|
|
5982
|
+
generateClip(productionId: string, shotId: string, opts?: StudioGenerateOptions): Promise<StudioGenerateResult>;
|
|
5983
|
+
/**
|
|
5984
|
+
* Extract a frame from a shot's active clip and put it where `target` says —
|
|
5985
|
+
* a new shot after this one (the default), this shot's sticky start or end
|
|
5986
|
+
* frame, or another still of the same shot. Seconds, not minutes: this one
|
|
5987
|
+
* waits for the job and answers with the changed production.
|
|
5988
|
+
*/
|
|
5989
|
+
frame(productionId: string, input: StudioFrameRequest): Promise<StudioMediaResponse>;
|
|
5990
|
+
/** Synthesize a shot's spoken line and record it. Waits for the job. */
|
|
5991
|
+
voice(productionId: string, input: StudioVoiceRequest): Promise<StudioMediaResponse>;
|
|
5992
|
+
/**
|
|
5993
|
+
* Recast the voices of a shot's active clip. Minutes of work, so it answers
|
|
5994
|
+
* `jobId` and the new clip lands as a result through its own marker.
|
|
5995
|
+
*/
|
|
5996
|
+
revoice(productionId: string, input: StudioRevoiceRequest): Promise<StudioJobStartedResponse>;
|
|
5997
|
+
/** Score the film. The finished track lands through its pending marker. */
|
|
5998
|
+
music(productionId: string, input: StudioMusicRequest): Promise<StudioJobStartedResponse>;
|
|
5999
|
+
/**
|
|
6000
|
+
* Open the share-by-link read. Deliberately its own route rather than an
|
|
6001
|
+
* operation: who may see the work is decided by the owner, never as a side
|
|
6002
|
+
* effect of a batch that was editing something else.
|
|
6003
|
+
*/
|
|
6004
|
+
share(productionId: string): Promise<StudioProduction>;
|
|
6005
|
+
/** Close it again. Sharing is opt-in AND reversible. */
|
|
6006
|
+
unshare(productionId: string): Promise<StudioProduction>;
|
|
6007
|
+
/**
|
|
6008
|
+
* Copy a production you own or can see into your own Studio project. The
|
|
6009
|
+
* copy starts PRIVATE and visible — sharing and archiving never travel — and
|
|
6010
|
+
* it is copied through YOUR view of the source, so somebody else's bin does
|
|
6011
|
+
* not come with it.
|
|
6012
|
+
*/
|
|
6013
|
+
clone(productionId: string, input?: StudioCloneRequest): Promise<StudioProduction>;
|
|
6014
|
+
}
|
|
6015
|
+
/** `client.studio` — the studio's own surface on the platform. */
|
|
6016
|
+
declare class StudioResource {
|
|
6017
|
+
readonly productions: StudioProductionsResource;
|
|
6018
|
+
constructor(client: NodaroClient);
|
|
6019
|
+
}
|
|
6020
|
+
|
|
5445
6021
|
/**
|
|
5446
6022
|
* The community-listing types are the single source of truth in
|
|
5447
6023
|
* `@nodaro/shared` (re-used by the backend, frontend, and CLI). Re-export them
|
|
@@ -6027,6 +6603,7 @@ declare class NodaroClient {
|
|
|
6027
6603
|
readonly videoPro: VideoProResource;
|
|
6028
6604
|
readonly executions: ExecutionsResource;
|
|
6029
6605
|
readonly nodes: NodesResource;
|
|
6606
|
+
readonly scene3d: Scene3DResource;
|
|
6030
6607
|
readonly developerApps: DeveloperAppsResource;
|
|
6031
6608
|
readonly oauth: OAuthResource;
|
|
6032
6609
|
readonly apps: AppsResource;
|
|
@@ -6050,6 +6627,7 @@ declare class NodaroClient {
|
|
|
6050
6627
|
readonly models: ModelsResource;
|
|
6051
6628
|
readonly shots: ShotsResource;
|
|
6052
6629
|
readonly recast: RecastResource;
|
|
6630
|
+
readonly studio: StudioResource;
|
|
6053
6631
|
readonly community: CommunityResource;
|
|
6054
6632
|
readonly templates: TemplatesResource;
|
|
6055
6633
|
readonly tutorials: TutorialsResource;
|
|
@@ -6078,6 +6656,10 @@ declare class NodaroClient {
|
|
|
6078
6656
|
* ({@link request}) and the text path ({@link requestText}) go through here.
|
|
6079
6657
|
*/
|
|
6080
6658
|
private send;
|
|
6659
|
+
/** Authenticated, bounded binary reads through the normal timeout/error transport. */
|
|
6660
|
+
requestBytes(method: string, path: string, options: RequestOptions & {
|
|
6661
|
+
maxBytes: number;
|
|
6662
|
+
}): Promise<ArrayBuffer>;
|
|
6081
6663
|
request<T>(method: string, path: string, options?: RequestOptions): Promise<T>;
|
|
6082
6664
|
/**
|
|
6083
6665
|
* Like {@link request}, for endpoints that answer text (CSV exports). Errors
|
|
@@ -6142,7 +6724,39 @@ declare class WorkflowConflictError extends NodaroError {
|
|
|
6142
6724
|
readonly currentUpdatedAt?: string | undefined;
|
|
6143
6725
|
readonly currentVersion?: number | undefined;
|
|
6144
6726
|
readonly currentRecord?: Record<string, unknown> | undefined;
|
|
6145
|
-
constructor(message?: string, currentUpdatedAt?: string | undefined, currentVersion?: number | undefined, currentRecord?: Record<string, unknown> | undefined
|
|
6727
|
+
constructor(message?: string, currentUpdatedAt?: string | undefined, currentVersion?: number | undefined, currentRecord?: Record<string, unknown> | undefined,
|
|
6728
|
+
/**
|
|
6729
|
+
* The wire code this conflict actually arrived with.
|
|
6730
|
+
*
|
|
6731
|
+
* `production_busy` is the studio production routes' own 409: the row
|
|
6732
|
+
* changed under a read-modify-write and the server exhausted its retries.
|
|
6733
|
+
* It is the same situation and the same remedy — re-read and apply again —
|
|
6734
|
+
* so it is the same ERROR, and a caller catching `WorkflowConflictError`
|
|
6735
|
+
* handles both. The code stays truthful because a caller that logs or
|
|
6736
|
+
* branches on it should see what the server said, not what the class is
|
|
6737
|
+
* usually called.
|
|
6738
|
+
*/
|
|
6739
|
+
code?: WorkflowConflictCode);
|
|
6740
|
+
}
|
|
6741
|
+
/** The 409 codes that mean "somebody else wrote first; re-read and retry". */
|
|
6742
|
+
type WorkflowConflictCode = "workflow_conflict" | "production_busy";
|
|
6743
|
+
/**
|
|
6744
|
+
* A studio operation batch was refused, and the error names WHICH operation
|
|
6745
|
+
* (`opIndex`, zero-based) was wrong. Nothing in the batch was written: a batch
|
|
6746
|
+
* applies atomically or not at all, so fix that one operation and send the
|
|
6747
|
+
* whole batch again.
|
|
6748
|
+
*
|
|
6749
|
+
* Selected by SHAPE — any 4xx carrying a numeric `opIndex` — not by a list of
|
|
6750
|
+
* codes, so a new refusal reason (`op_invalid`, `op_target_missing`, whatever
|
|
6751
|
+
* the server adds next) reaches the caller as this error without an SDK
|
|
6752
|
+
* release. `code` is whatever the server sent.
|
|
6753
|
+
*/
|
|
6754
|
+
declare class StudioOpError extends NodaroError {
|
|
6755
|
+
/** Zero-based index into the `ops` array that was sent. */
|
|
6756
|
+
readonly opIndex: number;
|
|
6757
|
+
constructor(message: string, code: string, status: number,
|
|
6758
|
+
/** Zero-based index into the `ops` array that was sent. */
|
|
6759
|
+
opIndex: number);
|
|
6146
6760
|
}
|
|
6147
6761
|
/**
|
|
6148
6762
|
* HTTP 422 `job_blocked`. A job policy registered by this deployment refused
|
|
@@ -6221,9 +6835,10 @@ interface ApiErrorBody {
|
|
|
6221
6835
|
required?: number;
|
|
6222
6836
|
available?: number;
|
|
6223
6837
|
limitBytes?: number;
|
|
6838
|
+
opIndex?: number;
|
|
6224
6839
|
[key: string]: unknown;
|
|
6225
6840
|
};
|
|
6226
6841
|
}
|
|
6227
6842
|
declare function throwFromResponse(status: number, body: ApiErrorBody): never;
|
|
6228
6843
|
|
|
6229
|
-
export { type AccessTokenResponse, type AnalyzeInput, type AnalyzeResult, type AppRun, type AppRunResult, type ApplyChatProposalResult, type ApproveCreatureMainImageResult, type ApproveMainImageResult, type ApproveObjectMainImageResult, type ApprovePortraitResult, AppsResource, AudioResource, type Auth, type BranchPipelineInput, type BranchPipelineResult, type BrowseTemplatesParams, type BrowseTemplatesResult, CREATURE_ASSET_TYPES, CallbackAuth, type CancelExecutionParams, type CancelJobResult, CatalogsResource, type Character, type CharacterDetail, type CharacterUsage, CharactersResource, type ChatStageResult, type ChatTurn, type ClientOptions, type CloneTemplateParams, type CloneTemplateResult, CommunityResource, type ContinueVideoProResult, type CreateCreatureInput, type CreateDeveloperAppInput, type CreateDeveloperAppResult, type CreateLocationInput, type CreateObjectInput, type CreateOrgInput, type CreateProjectInput, type CreateRecastInput, type CreateShotInput, type CreateWorkflowInput, type CreateWorkspaceInput, type Creature, type CreatureAssetType, type CreatureDetail, type CreatureReferencePhoto, type CreatureReferencePhotoKind, CreaturesResource, type CreditStatus, CreditsResource, type DeleteAppRunResult, type DeleteJobResult, type DeveloperApp, type DeveloperAppScope, type DeveloperAppStatus, DeveloperAppsResource, type DownloadVideoProgress, type DubbingInput, type DuplicateCharacterInput, type EnhanceInput, type EstimateRecastInput, type EstimateRecastRescoreInput, type ExchangeCodeInput, type ExecutionStatus, type ExecutionTriggerType, ExecutionsResource, type FactoryPresetsResult, ForbiddenError, type GenerateAssetInput, type GenerateCharacterInput, type GenerateCharacterResult, type GenerateCreatureAssetInput, type GenerateCreatureAssetResult, type GenerateCreatureInput, type GenerateCreatureMotionInput, type GenerateCreatureMotionResult, type GenerateCreatureResult, type GenerateImageParams, type GenerateInput, type GenerateLocationAssetInput, type GenerateLocationInput, type GenerateLocationResult, type GenerateMotionInput, type GenerateObjectAssetInput, type GenerateObjectAssetResult, type GenerateObjectInput, type GenerateObjectMotionInput, type GenerateObjectMotionResult, type GenerateObjectResult, type GenerateSurroundContinuationInput, type GenerateVideoParams, type GetPickerCatalogOptions, InsufficientCreditsError, type InviteInput, type Job, JobAbortedError, JobBlockedError, type JobErrorHint, JobFailedError, JobHeldError, type JobStatus, type JobStatusResult, JobTimeoutError, JobsResource, type LibraryAsset, LibraryResource, type ListAppRunsParams, type ListAppsParams, type ListAppsResult, type ListCharactersParams, type ListCharactersResult, type ListCreaturesParams, type ListExecutionsForWorkflowParams, type ListExecutionsPage, type ListInvitationsOptions, type ListJobsPage, type ListJobsParams, type ListLibraryParams, type ListLibraryResult, type ListLocationsParams, type ListModelsOptions, type ListObjectsParams, type ListWorkflowsParams, LlmResource, type LlmStructuredInput, type LlmStructuredJobInput, type LlmStructuredJobOutput, type LlmStructuredResult, type Location, type LocationDetail, type LocationReferencePhoto, type LocationReferencePhotoKind, LocationsResource, type MediaProcessInput, type MediaProcessResult, MediaResource, type ModelCostsResult, type ModelSummary, type ModelsListResult, ModelsResource, NodaroClient, NodaroError, type NodeCategory, type NodeDescriptor, type NodeExecutionState, type NodeInputField, type NodeInputSchema, type NodeJobOutput, type NodePreset, type NodePresetGroup, NodesResource, NotFoundError, type OAuthAppInfo, OAuthResource, type Object$1 as Object, type ObjectCategory, type ObjectDetail, type ObjectReferencePhoto, type ObjectReferencePhotoKind, ObjectsResource, OrganizationsResource, type OutputType, type PickerCatalog, type PickerCatalogSummary, PickerCatalogsResource, type PickerDimension, type PickerOption, PipelinesResource, type PolicyBlockHint, PresetsResource, type Project, type ProjectedCatalog, type ProjectedCatalogDimension, type ProjectedCatalogOption, ProjectsResource, PromptHelperResource, type PromptResult, type PublishedApp, type PublishedAppDetail, RateLimitedError, type RecaptionCreatureResult, type RecaptionLocationResult, type RecaptionObjectResult, type RecaptionResult, type RecastAudioLayerName, type RecastAudioManifestV1, type RecastAudioMix, type RecastAudioMixControl, type RecastAudioSectionReplacement, type RecastEstimate, type RecastRescoreOperation, type RecastRescoreQuote, type RecastRescoreReplacement, type RecastRescoreRequestV2, type RecastRescoreResponse, RecastResource, type RecastRunSnapshot, type RecastScriptImportResult, type RecastScriptValidation, type RecastScriptValidationError, type ReduceInput, ReduceResource, type ReduceResult, type ReferencePhoto, type ReferencePhotoKind, type ResolveRecastGateInput, type RotateSecretResult, type RunAndWaitOptions, type RunAppOptions, type RunManyResult, type RunNodeAdjustment, type RunNodeResult, type RunWorkflowParams, type RunWorkflowResult, type SafetyBlockHint, type Shot, type ShotEntityRef, type ShotMode, ShotsResource, StaticTokenAuth, type StopVideoProResult, StorageExceededError, type StructuredReferenceParams, type Template, type TemplateBrowseCard, type TemplateSort, TemplatesResource, type TextToVideoParams, type TutorialCategory, type TutorialFlowItem, type TutorialVideoItem, TutorialsResource, UnauthorizedError, type UpdateCreatureInput, type UpdateCreatureResult, type UpdateDeveloperAppInput, type UpdateLocationInput, type UpdateLocationResult, type UpdateObjectInput, type UpdateObjectResult, type UpdateProjectInput, type UpdateShotInput, type UpdateWorkflowInput, type UploadResult, UploadsResource, type UpsertCharacterInput, type UpsertCharacterResult, type UpsertCreatureInput, type UpsertCreatureResult, type UpsertObjectInput, type UpsertObjectResult, type UserBalance, type UserIdentity, type VcpAnalysis, type VcpAnalysisSpeaker, type VcpAnalyzeInput, type VcpExportInput, type VcpExportTrack, type VideoMetadata, VideoProResource, type VoiceChangerProInput, type VoiceChangerProVoice, type VoiceDesignInput, type VoiceRemixInput, VoicesResource, type Workflow, WorkflowConflictError, type WorkflowExecution, type WorkflowExecutionSummary, WorkflowsResource, WorkspacesResource, buildPersonSeedPrompt, createClient, supabaseAuth, throwFromResponse };
|
|
6844
|
+
export { type AccessTokenResponse, type AnalyzeInput, type AnalyzeResult, type AppRun, type AppRunResult, type ApplyChatProposalResult, type ApproveCreatureMainImageResult, type ApproveMainImageResult, type ApproveObjectMainImageResult, type ApprovePortraitResult, AppsResource, AudioResource, type Auth, type BranchPipelineInput, type BranchPipelineResult, type BrowseTemplatesParams, type BrowseTemplatesResult, CREATURE_ASSET_TYPES, CallbackAuth, type CancelExecutionParams, type CancelJobResult, CatalogsResource, type Character, type CharacterDetail, type CharacterUsage, CharactersResource, type ChatStageResult, type ChatTurn, type ClientOptions, type CloneTemplateParams, type CloneTemplateResult, CommunityResource, type ContinueVideoProResult, type CreateCreatureInput, type CreateDeveloperAppInput, type CreateDeveloperAppResult, type CreateLocationInput, type CreateObjectInput, type CreateOrgInput, type CreateProjectInput, type CreateRecastInput, type CreateShotInput, type CreateWorkflowInput, type CreateWorkspaceInput, type Creature, type CreatureAssetType, type CreatureDetail, type CreatureReferencePhoto, type CreatureReferencePhotoKind, CreaturesResource, type CreditStatus, CreditsResource, type DeleteAppRunResult, type DeleteJobResult, type DeveloperApp, type DeveloperAppScope, type DeveloperAppStatus, DeveloperAppsResource, type DownloadVideoProgress, type DubbingInput, type DuplicateCharacterInput, type EditScene3DParams, type EnhanceInput, type EstimateRecastInput, type EstimateRecastRescoreInput, type ExchangeCodeInput, type ExecutionStatus, type ExecutionTriggerType, ExecutionsResource, type FactoryPresetsResult, ForbiddenError, type GenerateAssetInput, type GenerateCharacterInput, type GenerateCharacterResult, type GenerateCreatureAssetInput, type GenerateCreatureAssetResult, type GenerateCreatureInput, type GenerateCreatureMotionInput, type GenerateCreatureMotionResult, type GenerateCreatureResult, type GenerateImageParams, type GenerateInput, type GenerateLocationAssetInput, type GenerateLocationInput, type GenerateLocationResult, type GenerateMotionInput, type GenerateObjectAssetInput, type GenerateObjectAssetResult, type GenerateObjectInput, type GenerateObjectMotionInput, type GenerateObjectMotionResult, type GenerateObjectResult, type GenerateScene3DParams, type GenerateSurroundContinuationInput, type GenerateVideoParams, type GetPickerCatalogOptions, type GetProductionOptions, InsufficientCreditsError, type InviteInput, type Job, JobAbortedError, JobBlockedError, type JobErrorHint, JobFailedError, JobHeldError, type JobStatus, type JobStatusResult, JobTimeoutError, JobsResource, type LibraryAsset, LibraryResource, type ListAppRunsParams, type ListAppsParams, type ListAppsResult, type ListCharactersParams, type ListCharactersResult, type ListCreaturesParams, type ListExecutionsForWorkflowParams, type ListExecutionsPage, type ListInvitationsOptions, type ListJobsPage, type ListJobsParams, type ListLibraryParams, type ListLibraryResult, type ListLocationsParams, type ListModelsOptions, type ListObjectsParams, type ListStudioProductionsOptions, type ListWorkflowsParams, LlmResource, type LlmStructuredInput, type LlmStructuredJobInput, type LlmStructuredJobOutput, type LlmStructuredResult, type Location, type LocationDetail, type LocationReferencePhoto, type LocationReferencePhotoKind, LocationsResource, type MediaProcessInput, type MediaProcessResult, MediaResource, type ModelCostsResult, type ModelSummary, type ModelsListResult, ModelsResource, NodaroClient, NodaroError, type NodeCategory, type NodeDescriptor, type NodeExecutionState, type NodeInputField, type NodeInputSchema, type NodeJobOutput, type NodePreset, type NodePresetGroup, NodesResource, NotFoundError, type OAuthAppInfo, OAuthResource, type Object$1 as Object, type ObjectCategory, type ObjectDetail, type ObjectReferencePhoto, type ObjectReferencePhotoKind, ObjectsResource, OrganizationsResource, type OutputType, type PickerCatalog, type PickerCatalogSummary, PickerCatalogsResource, type PickerDimension, type PickerOption, PipelinesResource, type PolicyBlockHint, PresetsResource, type Project, type ProjectedCatalog, type ProjectedCatalogDimension, type ProjectedCatalogOption, ProjectsResource, PromptHelperResource, type PromptResult, type PublishedApp, type PublishedAppDetail, RateLimitedError, type RecaptionCreatureResult, type RecaptionLocationResult, type RecaptionObjectResult, type RecaptionResult, type RecastAudioLayerName, type RecastAudioManifestV1, type RecastAudioMix, type RecastAudioMixControl, type RecastAudioSectionReplacement, type RecastEstimate, type RecastRescoreOperation, type RecastRescoreQuote, type RecastRescoreReplacement, type RecastRescoreRequestV2, type RecastRescoreResponse, RecastResource, type RecastRunSnapshot, type RecastScriptImportResult, type RecastScriptValidation, type RecastScriptValidationError, type ReduceInput, ReduceResource, type ReduceResult, type ReferencePhoto, type ReferencePhotoKind, type RenderScene3DParams, type ResolveRecastGateInput, type RetainedScene3DEditParams, type RetainedScene3DEditResult, type RotateSecretResult, type RunAndWaitOptions, type RunAppOptions, type RunManyResult, type RunNodeAdjustment, type RunNodeResult, type RunWorkflowParams, type RunWorkflowResult, type SafetyBlockHint, type Scene3DAuthoringEngine, type Scene3DCapabilities, type Scene3DJobOutput, Scene3DResource, type Shot, type ShotEntityRef, type ShotMode, ShotsResource, StaticTokenAuth, type StopVideoProResult, StorageExceededError, type StructuredReferenceParams, type StudioClientRequestId, type StudioCloneRequest, type StudioCreateProductionRequest, type StudioDescribeRequest, type StudioExportPlanOptions, type StudioExportPlanResponse, type StudioExportStep, type StudioFrameRequest, type StudioGenerateEstimate, type StudioGenerateOptions, type StudioGenerateRequest, type StudioGenerateResponse, type StudioGenerateResult, type StudioImportSummary, type StudioJobStartedResponse, type StudioListProductionsResponse, type StudioMediaResponse, type StudioMusicRequest, StudioOpError, type StudioOpsReceipt, type StudioOpsRequest, type StudioOpsResponse, type StudioPlanIssue, type StudioProduction, type StudioProductionDetail, type StudioProductionResponse, StudioProductionsResource, type StudioReconcileResponse, StudioResource, type StudioRevoiceRequest, type StudioSkillResponse, type StudioValidatePlanResponse, type StudioVideoLane, type StudioVoiceRequest, type Template, type TemplateBrowseCard, type TemplateSort, TemplatesResource, type TextToVideoParams, type TutorialCategory, type TutorialFlowItem, type TutorialVideoItem, TutorialsResource, UnauthorizedError, type UpdateCreatureInput, type UpdateCreatureResult, type UpdateDeveloperAppInput, type UpdateLocationInput, type UpdateLocationResult, type UpdateObjectInput, type UpdateObjectResult, type UpdateProjectInput, type UpdateShotInput, type UpdateWorkflowInput, type UploadResult, UploadsResource, type UpsertCharacterInput, type UpsertCharacterResult, type UpsertCreatureInput, type UpsertCreatureResult, type UpsertObjectInput, type UpsertObjectResult, type UserBalance, type UserIdentity, type VcpAnalysis, type VcpAnalysisSpeaker, type VcpAnalyzeInput, type VcpExportInput, type VcpExportTrack, type VideoMetadata, VideoProResource, type VoiceChangerProInput, type VoiceChangerProVoice, type VoiceDesignInput, type VoiceRemixInput, VoicesResource, type Workflow, type WorkflowConflictCode, WorkflowConflictError, type WorkflowExecution, type WorkflowExecutionSummary, WorkflowsResource, WorkspacesResource, buildPersonSeedPrompt, createClient, isStudioGenerateEstimate, supabaseAuth, throwFromResponse };
|