@scenario-labs/sdk 0.3.0 → 1.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/CHANGELOG.md +30 -0
- package/README.md +40 -8
- package/client.d.mts +36 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +36 -16
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +153 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +153 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +276 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +263 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +5 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts +5 -1
- package/index.d.ts.map +1 -1
- package/index.js +14 -1
- package/index.js.map +1 -1
- package/index.mjs +5 -1
- package/index.mjs.map +1 -1
- package/lib/asset.d.mts +55 -0
- package/lib/asset.d.mts.map +1 -0
- package/lib/asset.d.ts +55 -0
- package/lib/asset.d.ts.map +1 -0
- package/lib/asset.js +60 -0
- package/lib/asset.js.map +1 -0
- package/lib/asset.mjs +54 -0
- package/lib/asset.mjs.map +1 -0
- package/lib/job.d.mts +13 -1
- package/lib/job.d.mts.map +1 -1
- package/lib/job.d.ts +13 -1
- package/lib/job.d.ts.map +1 -1
- package/lib/job.js +18 -1
- package/lib/job.js.map +1 -1
- package/lib/job.mjs +16 -0
- package/lib/job.mjs.map +1 -1
- package/lib/models.d.mts +34 -2
- package/lib/models.d.mts.map +1 -1
- package/lib/models.d.ts +34 -2
- package/lib/models.d.ts.map +1 -1
- package/lib/models.js +39 -2
- package/lib/models.js.map +1 -1
- package/lib/models.mjs +37 -1
- package/lib/models.mjs.map +1 -1
- package/lib/scenario.d.mts +14 -0
- package/lib/scenario.d.mts.map +1 -1
- package/lib/scenario.d.ts +14 -0
- package/lib/scenario.d.ts.map +1 -1
- package/lib/scenario.js +14 -0
- package/lib/scenario.js.map +1 -1
- package/lib/scenario.mjs +14 -0
- package/lib/scenario.mjs.map +1 -1
- package/lib/upload.d.mts +143 -0
- package/lib/upload.d.mts.map +1 -0
- package/lib/upload.d.ts +143 -0
- package/lib/upload.d.ts.map +1 -0
- package/lib/upload.js +242 -0
- package/lib/upload.js.map +1 -0
- package/lib/upload.mjs +203 -0
- package/lib/upload.mjs.map +1 -0
- package/lib/workflow.d.mts +13 -2
- package/lib/workflow.d.mts.map +1 -1
- package/lib/workflow.d.ts +13 -2
- package/lib/workflow.d.ts.map +1 -1
- package/lib/workflow.js +17 -4
- package/lib/workflow.js.map +1 -1
- package/lib/workflow.mjs +17 -4
- package/lib/workflow.mjs.map +1 -1
- package/lib/workflow_import_validator.d.mts +40 -0
- package/lib/workflow_import_validator.d.mts.map +1 -0
- package/lib/workflow_import_validator.d.ts +40 -0
- package/lib/workflow_import_validator.d.ts.map +1 -0
- package/lib/workflow_import_validator.js +69 -0
- package/lib/workflow_import_validator.js.map +1 -0
- package/lib/workflow_import_validator.mjs +64 -0
- package/lib/workflow_import_validator.mjs.map +1 -0
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/assets/assets.d.mts +646 -669
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +646 -669
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js +3 -2
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs +3 -2
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/assets/index.d.mts +1 -1
- package/resources/assets/index.d.mts.map +1 -1
- package/resources/assets/index.d.ts +1 -1
- package/resources/assets/index.d.ts.map +1 -1
- package/resources/assets/index.js.map +1 -1
- package/resources/assets/index.mjs.map +1 -1
- package/resources/assets/public.d.mts +12 -12
- package/resources/assets/public.d.mts.map +1 -1
- package/resources/assets/public.d.ts +12 -12
- package/resources/assets/public.d.ts.map +1 -1
- package/resources/collections/collections.d.mts +38 -49
- package/resources/collections/collections.d.mts.map +1 -1
- package/resources/collections/collections.d.ts +38 -49
- package/resources/collections/collections.d.ts.map +1 -1
- package/resources/collections/collections.js +5 -1
- package/resources/collections/collections.js.map +1 -1
- package/resources/collections/collections.mjs +5 -1
- package/resources/collections/collections.mjs.map +1 -1
- package/resources/collections/index.d.mts +1 -1
- package/resources/collections/index.d.mts.map +1 -1
- package/resources/collections/index.d.ts +1 -1
- package/resources/collections/index.d.ts.map +1 -1
- package/resources/collections/index.js.map +1 -1
- package/resources/collections/index.mjs.map +1 -1
- package/resources/generate.d.mts +1027 -242
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +1027 -242
- package/resources/generate.d.ts.map +1 -1
- package/resources/generate.js +7 -0
- package/resources/generate.js.map +1 -1
- package/resources/generate.mjs +7 -0
- package/resources/generate.mjs.map +1 -1
- package/resources/index.d.mts +8 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/jobs.d.mts +369 -380
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +369 -380
- package/resources/jobs.d.ts.map +1 -1
- package/resources/jobs.js +2 -1
- package/resources/jobs.js.map +1 -1
- package/resources/jobs.mjs +2 -1
- package/resources/jobs.mjs.map +1 -1
- package/resources/models/description.d.mts +2 -2
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +2 -2
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +4 -4
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +4 -4
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/index.d.mts +1 -1
- package/resources/models/index.d.mts.map +1 -1
- package/resources/models/index.d.ts +1 -1
- package/resources/models/index.d.ts.map +1 -1
- package/resources/models/index.js.map +1 -1
- package/resources/models/index.mjs.map +1 -1
- package/resources/models/models.d.mts +845 -856
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +845 -856
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js +2 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs +2 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/models/train.d.mts +2 -2
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +2 -2
- package/resources/models/train.d.ts.map +1 -1
- package/resources/search.d.mts +215 -295
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +215 -295
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +9 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +9 -2
- package/resources/search.mjs.map +1 -1
- package/resources/tags.d.mts +23 -35
- package/resources/tags.d.mts.map +1 -1
- package/resources/tags.d.ts +23 -35
- package/resources/tags.d.ts.map +1 -1
- package/resources/tags.js +2 -1
- package/resources/tags.js.map +1 -1
- package/resources/tags.mjs +2 -1
- package/resources/tags.mjs.map +1 -1
- package/resources/usages.d.mts +3 -3
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +3 -3
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +688 -704
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +688 -704
- package/resources/workflows.d.ts.map +1 -1
- package/resources/workflows.js +5 -1
- package/resources/workflows.js.map +1 -1
- package/resources/workflows.mjs +5 -1
- package/resources/workflows.mjs.map +1 -1
- package/src/client.ts +107 -2
- package/src/core/pagination.ts +497 -0
- package/src/index.ts +11 -1
- package/src/lib/asset.ts +85 -0
- package/src/lib/job.ts +28 -1
- package/src/lib/models.ts +62 -2
- package/src/lib/scenario.ts +14 -0
- package/src/lib/upload.ts +344 -0
- package/src/lib/workflow.ts +29 -4
- package/src/lib/workflow_import_validator.ts +104 -0
- package/src/pagination.ts +2 -0
- package/src/resources/assets/assets.ts +930 -909
- package/src/resources/assets/index.ts +2 -0
- package/src/resources/assets/public.ts +17 -7
- package/src/resources/collections/collections.ts +45 -54
- package/src/resources/collections/index.ts +1 -0
- package/src/resources/generate.ts +1227 -136
- package/src/resources/index.ts +11 -1
- package/src/resources/jobs.ts +613 -622
- package/src/resources/models/description.ts +4 -0
- package/src/resources/models/examples.ts +8 -0
- package/src/resources/models/index.ts +1 -0
- package/src/resources/models/models.ts +1066 -1064
- package/src/resources/models/train.ts +4 -0
- package/src/resources/search.ts +239 -327
- package/src/resources/tags.ts +32 -39
- package/src/resources/usages.ts +5 -0
- package/src/resources/workflows.ts +850 -864
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/lib/upload.js
ADDED
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
+
var ownKeys = function(o) {
|
|
20
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
+
var ar = [];
|
|
22
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
+
return ar;
|
|
24
|
+
};
|
|
25
|
+
return ownKeys(o);
|
|
26
|
+
};
|
|
27
|
+
return function (mod) {
|
|
28
|
+
if (mod && mod.__esModule) return mod;
|
|
29
|
+
var result = {};
|
|
30
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
+
__setModuleDefault(result, mod);
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
})();
|
|
35
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
+
exports.EnhancedUploads = exports.Upload = exports.UploadMethods = void 0;
|
|
37
|
+
exports.enhanceUpload = enhanceUpload;
|
|
38
|
+
const uploads_1 = require("../resources/uploads.js");
|
|
39
|
+
// AWS S3 multipart upload limits.
|
|
40
|
+
const MIN_PART_SIZE = 6000000; // 6 MB (spec minimum is 5 MiB; a bit over to be safe)
|
|
41
|
+
const MAX_PART_SIZE = 5368709120; // 5 GiB
|
|
42
|
+
const MAX_PARTS = 10000;
|
|
43
|
+
const MAX_FILE_SIZE = 5497558138880; // 5 TiB
|
|
44
|
+
// `validated` is intermediate — the server has validated the upload but
|
|
45
|
+
// hasn't created the asset/model yet, so `entityId` isn't populated.
|
|
46
|
+
// Real terminals are `imported` (asset/model created), `complete`, and
|
|
47
|
+
// `failed`. Everything else means "keep polling".
|
|
48
|
+
const TERMINAL_STATUSES = new Set(['complete', 'failed', 'imported']);
|
|
49
|
+
/** Upload methods added on top of the original upload fields. */
|
|
50
|
+
class UploadMethods {
|
|
51
|
+
/**
|
|
52
|
+
* Poll until the upload has been processed into an entity (asset or model),
|
|
53
|
+
* or reaches a terminal state (`imported`, `complete`, `failed`). Resolves
|
|
54
|
+
* with the latest upload data so you can read `entityId`, `status`, or
|
|
55
|
+
* `errorMessage` without a follow-up retrieve.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const res = await client.uploads.retrieve(uploadId);
|
|
60
|
+
* const done = await res.upload.wait();
|
|
61
|
+
* if (done.status === 'failed') throw new Error(done.errorMessage);
|
|
62
|
+
* console.log(done.entityId);
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
async wait(options) {
|
|
66
|
+
const final = await pollUntilImported(() => this._client.uploads.retrieve(this.id), options?.intervalMs ?? 2000, options?.timeoutMs ?? 300000);
|
|
67
|
+
return UploadMethods.from(this._client, final.upload);
|
|
68
|
+
}
|
|
69
|
+
/** @internal Create an Upload from raw upload data. */
|
|
70
|
+
static from(client, data) {
|
|
71
|
+
const upload = Object.assign(Object.create(UploadMethods.prototype), data);
|
|
72
|
+
Object.defineProperty(upload, '_client', { value: client, enumerable: false });
|
|
73
|
+
return upload;
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
exports.UploadMethods = UploadMethods;
|
|
77
|
+
exports.Upload = UploadMethods;
|
|
78
|
+
/**
|
|
79
|
+
* @internal Wrap `_thenUnwrap` to replace `response.upload` with an enhanced Upload.
|
|
80
|
+
*/
|
|
81
|
+
function enhanceUpload(client, promise) {
|
|
82
|
+
return promise._thenUnwrap((data) => ({
|
|
83
|
+
...data,
|
|
84
|
+
upload: exports.Upload.from(client, data.upload),
|
|
85
|
+
}));
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Enhanced Uploads resource.
|
|
89
|
+
* All original methods (`create`, `retrieve`, `triggerAction`) are inherited,
|
|
90
|
+
* with each response's `upload` field enriched with a `.wait()` helper.
|
|
91
|
+
* Adds `uploadFile()` — a one-call wrapper around the 4-step upload flow:
|
|
92
|
+
* init → PUT parts to S3 → trigger complete → poll until imported.
|
|
93
|
+
*/
|
|
94
|
+
class EnhancedUploads extends uploads_1.Uploads {
|
|
95
|
+
create(body, options) {
|
|
96
|
+
return enhanceUpload(this._client, super.create(body, options));
|
|
97
|
+
}
|
|
98
|
+
retrieve(uploadID, options) {
|
|
99
|
+
return enhanceUpload(this._client, super.retrieve(uploadID, options));
|
|
100
|
+
}
|
|
101
|
+
triggerAction(uploadID, body, options) {
|
|
102
|
+
return enhanceUpload(this._client, super.triggerAction(uploadID, body, options));
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Upload a file end-to-end. Computes an optimal part size (within AWS's
|
|
106
|
+
* 5 MiB / 5 GiB / 10,000-part bounds), uploads all parts in parallel,
|
|
107
|
+
* triggers completion, polls until the server has validated and imported
|
|
108
|
+
* the file, and returns the resolved entity.
|
|
109
|
+
*
|
|
110
|
+
* The returned type narrows on `kind`: `'model'` returns a Model,
|
|
111
|
+
* everything else returns an Asset.
|
|
112
|
+
*
|
|
113
|
+
* @example
|
|
114
|
+
* ```ts
|
|
115
|
+
* // From a file path (Node)
|
|
116
|
+
* const { asset } = await client.uploads.uploadFile({
|
|
117
|
+
* file: './photo.jpg',
|
|
118
|
+
* fileName: 'photo.jpg',
|
|
119
|
+
* contentType: 'image/jpeg',
|
|
120
|
+
* kind: 'image',
|
|
121
|
+
* });
|
|
122
|
+
* console.log(asset.id, asset.url);
|
|
123
|
+
*
|
|
124
|
+
* // Or from bytes / Blob — anything you already have in memory
|
|
125
|
+
* await client.uploads.uploadFile({
|
|
126
|
+
* file: new Blob([pngBytes], { type: 'image/png' }),
|
|
127
|
+
* fileName: 'generated.png',
|
|
128
|
+
* contentType: 'image/png',
|
|
129
|
+
* kind: 'image',
|
|
130
|
+
* });
|
|
131
|
+
* ```
|
|
132
|
+
*/
|
|
133
|
+
async uploadFile(params, options) {
|
|
134
|
+
const bytes = await normalizeToBytes(params.file);
|
|
135
|
+
const fileSize = bytes.byteLength;
|
|
136
|
+
if (fileSize === 0) {
|
|
137
|
+
throw new Error('Cannot upload an empty file');
|
|
138
|
+
}
|
|
139
|
+
if (fileSize > MAX_FILE_SIZE) {
|
|
140
|
+
throw new Error(`File size (${fileSize} bytes) exceeds the maximum allowed size of ${MAX_FILE_SIZE} bytes (5 TiB)`);
|
|
141
|
+
}
|
|
142
|
+
// Pick the smallest legal part size that fits within MAX_PARTS.
|
|
143
|
+
const requiredPartSize = Math.ceil(fileSize / MAX_PARTS);
|
|
144
|
+
const partSize = Math.max(MIN_PART_SIZE, requiredPartSize);
|
|
145
|
+
if (partSize > MAX_PART_SIZE) {
|
|
146
|
+
throw new Error(`File size (${fileSize} bytes) requires a part size of ${partSize} bytes, ` +
|
|
147
|
+
`which exceeds the maximum part size of ${MAX_PART_SIZE} bytes (5 GiB)`);
|
|
148
|
+
}
|
|
149
|
+
const partsCount = Math.max(1, Math.ceil(fileSize / partSize));
|
|
150
|
+
// Step 1 — init upload session and receive presigned S3 URLs.
|
|
151
|
+
const createBody = {
|
|
152
|
+
fileName: params.fileName,
|
|
153
|
+
fileSize,
|
|
154
|
+
contentType: params.contentType,
|
|
155
|
+
kind: params.kind,
|
|
156
|
+
parts: partsCount,
|
|
157
|
+
...(params.kind !== 'model' && params.assetOptions ? { assetOptions: params.assetOptions } : {}),
|
|
158
|
+
};
|
|
159
|
+
const createRes = await this.create(createBody, options);
|
|
160
|
+
const session = createRes.upload;
|
|
161
|
+
const uploadId = session.id;
|
|
162
|
+
const parts = session.parts;
|
|
163
|
+
if (parts?.length !== partsCount) {
|
|
164
|
+
throw new Error(`Expected ${partsCount} presigned part URL(s), got ${parts?.length ?? 0}`);
|
|
165
|
+
}
|
|
166
|
+
// Step 2 — PUT each chunk to its presigned S3 URL, with a concurrency cap.
|
|
167
|
+
const concurrency = Math.max(1, params.partConcurrency ?? 4);
|
|
168
|
+
await uploadPartsWithConcurrency(bytes, parts, partSize, concurrency);
|
|
169
|
+
// Step 3 — tell the server all parts are uploaded.
|
|
170
|
+
await this.triggerAction(uploadId, { action: 'complete' }, options);
|
|
171
|
+
// Step 4 — poll until the upload has been processed into an entity.
|
|
172
|
+
const final = await pollUntilImported(() => this.retrieve(uploadId, options), params.pollIntervalMs ?? 2000, params.pollTimeoutMs ?? 300000);
|
|
173
|
+
if (final.upload.status === 'failed') {
|
|
174
|
+
throw new Error(`Upload ${uploadId} failed: ${final.upload.errorMessage ?? '<no error message>'}`);
|
|
175
|
+
}
|
|
176
|
+
const entityId = final.upload.entityId;
|
|
177
|
+
if (!entityId) {
|
|
178
|
+
throw new Error(`Upload ${uploadId} reached status "${final.upload.status}" but has no entityId`);
|
|
179
|
+
}
|
|
180
|
+
// Fetch and return the resolved entity (narrowed by kind).
|
|
181
|
+
if (params.kind === 'model') {
|
|
182
|
+
const model = await this._client.models.retrieve(entityId);
|
|
183
|
+
return model;
|
|
184
|
+
}
|
|
185
|
+
const asset = await this._client.assets.retrieve(entityId);
|
|
186
|
+
return asset;
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
exports.EnhancedUploads = EnhancedUploads;
|
|
190
|
+
// ─────────────────────── helpers ───────────────────────
|
|
191
|
+
async function normalizeToBytes(input) {
|
|
192
|
+
if (typeof input === 'string') {
|
|
193
|
+
// Dynamic import so browser bundlers don't pull in node:fs.
|
|
194
|
+
const { readFile } = await Promise.resolve().then(() => __importStar(require('node:fs/promises')));
|
|
195
|
+
return new Uint8Array(await readFile(input));
|
|
196
|
+
}
|
|
197
|
+
if (input instanceof Uint8Array) {
|
|
198
|
+
return input;
|
|
199
|
+
}
|
|
200
|
+
if (typeof Blob !== 'undefined' && input instanceof Blob) {
|
|
201
|
+
return new Uint8Array(await input.arrayBuffer());
|
|
202
|
+
}
|
|
203
|
+
throw new Error('uploadFile: unsupported input type — expected a path string, Uint8Array, or Blob');
|
|
204
|
+
}
|
|
205
|
+
async function uploadPartsWithConcurrency(bytes, parts, partSize, concurrency) {
|
|
206
|
+
// Sort by part number so slicing lines up with the presigned URL order.
|
|
207
|
+
const sorted = [...parts].sort((a, b) => a.number - b.number);
|
|
208
|
+
let nextIndex = 0;
|
|
209
|
+
const workers = Array.from({ length: concurrency }, () => worker());
|
|
210
|
+
await Promise.all(workers);
|
|
211
|
+
async function worker() {
|
|
212
|
+
while (true) {
|
|
213
|
+
const i = nextIndex++;
|
|
214
|
+
if (i >= sorted.length)
|
|
215
|
+
return;
|
|
216
|
+
const part = sorted[i];
|
|
217
|
+
if (!part)
|
|
218
|
+
continue;
|
|
219
|
+
const start = i * partSize;
|
|
220
|
+
const end = Math.min(bytes.byteLength, start + partSize);
|
|
221
|
+
const chunk = bytes.subarray(start, end);
|
|
222
|
+
const res = await fetch(part.url, { method: 'PUT', body: chunk });
|
|
223
|
+
if (!res.ok) {
|
|
224
|
+
throw new Error(`Failed to upload part ${part.number}/${sorted.length}: ${res.status} ${res.statusText}`);
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
async function pollUntilImported(retrieve, intervalMs, timeoutMs) {
|
|
230
|
+
const deadline = Date.now() + timeoutMs;
|
|
231
|
+
while (Date.now() < deadline) {
|
|
232
|
+
const res = await retrieve();
|
|
233
|
+
const { status } = res.upload;
|
|
234
|
+
// Return as soon as we have an entityId OR the upload reached a terminal state.
|
|
235
|
+
if (res.upload.entityId || TERMINAL_STATUSES.has(status)) {
|
|
236
|
+
return res;
|
|
237
|
+
}
|
|
238
|
+
await new Promise((r) => setTimeout(r, intervalMs));
|
|
239
|
+
}
|
|
240
|
+
throw new Error(`Upload did not reach a terminal status within ${timeoutMs / 1000}s`);
|
|
241
|
+
}
|
|
242
|
+
//# sourceMappingURL=upload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload.js","sourceRoot":"","sources":["../src/lib/upload.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqIA,sCAQC;AA1ID,qDAO8B;AAsD9B,kCAAkC;AAClC,MAAM,aAAa,GAAG,OAAS,CAAC,CAAC,sDAAsD;AACvF,MAAM,aAAa,GAAG,UAAa,CAAC,CAAC,QAAQ;AAC7C,MAAM,SAAS,GAAG,KAAM,CAAC;AACzB,MAAM,aAAa,GAAG,aAAiB,CAAC,CAAC,QAAQ;AAIjD,wEAAwE;AACxE,qEAAqE;AACrE,uEAAuE;AACvE,kDAAkD;AAClD,MAAM,iBAAiB,GAAsB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AASzF,iEAAiE;AACjE,MAAa,aAAa;IAGxB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAe,OAA2B;QAClD,MAAM,KAAK,GAAG,MAAM,iBAAiB,CACnC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAC5C,OAAO,EAAE,UAAU,IAAI,IAAK,EAC5B,OAAO,EAAE,SAAS,IAAI,MAAO,CAC9B,CAAC;QACF,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,IAAI,CAAC,MAAgB,EAAE,IAAsC;QAClE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,CAAW,CAAC;QACrF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAhCD,sCAgCC;AAIY,QAAA,MAAM,GAAG,aAAa,CAAC;AAQpC;;GAEG;AACH,SAAgB,aAAa,CAC3B,MAAgB,EAChB,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,MAAM,EAAE,cAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAA0C,CAAC;KAC7E,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAa,eAAgB,SAAQ,iBAAO;IACjC,MAAM,CACb,IAAwB,EACxB,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAEQ,QAAQ,CACf,QAAgB,EAChB,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAEQ,aAAa,CACpB,QAAgB,EAChB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,UAAU,CACd,MAA2B,EAC3B,OAAwB;QAExB,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC;QAElC,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,QAAQ,GAAG,aAAa,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,cAAc,QAAQ,+CAA+C,aAAa,gBAAgB,CACnG,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAC3D,IAAI,QAAQ,GAAG,aAAa,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,cAAc,QAAQ,mCAAmC,QAAQ,UAAU;gBACzE,0CAA0C,aAAa,gBAAgB,CAC1E,CAAC;QACJ,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC;QAE/D,8DAA8D;QAC9D,MAAM,UAAU,GAAuB;YACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ;YACR,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,UAAU;YACjB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjG,CAAC;QACF,MAAM,SAAS,GAAyB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,IAAI,KAAK,EAAE,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,+BAA+B,KAAK,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,2EAA2E;QAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC;QAC7D,MAAM,0BAA0B,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEtE,mDAAmD;QACnD,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpE,oEAAoE;QACpE,MAAM,KAAK,GAAG,MAAM,iBAAiB,CACnC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,EACtC,MAAM,CAAC,cAAc,IAAI,IAAK,EAC9B,MAAM,CAAC,aAAa,IAAI,MAAO,CAChC,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,YAAY,KAAK,CAAC,MAAM,CAAC,YAAY,IAAI,oBAAoB,EAAE,CAAC,CAAC;QACrG,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,oBAAoB,KAAK,CAAC,MAAM,CAAC,MAAM,uBAAuB,CAAC,CAAC;QACpG,CAAC;QAED,2DAA2D;QAC3D,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC3D,OAAO,KAAwB,CAAC;QAClC,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3D,OAAO,KAAwB,CAAC;IAClC,CAAC;CACF;AA9HD,0CA8HC;AAED,0DAA0D;AAE1D,KAAK,UAAU,gBAAgB,CAAC,KAAsB;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,4DAA4D;QAC5D,MAAM,EAAE,QAAQ,EAAE,GAAG,wDAAa,kBAAkB,GAAC,CAAC;QACtD,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QACzD,OAAO,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;AACtG,CAAC;AAED,KAAK,UAAU,0BAA0B,CACvC,KAAiB,EACjB,KAA8D,EAC9D,QAAgB,EAChB,WAAmB;IAEnB,wEAAwE;IACxE,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAE9D,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3B,KAAK,UAAU,MAAM;QACnB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM;gBAAE,OAAO;YAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACzC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YAClE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CACzF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,QAA+C,EAC/C,UAAkB,EAClB,SAAiB;IAEjB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;IACxC,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,QAAQ,EAAE,CAAC;QAC7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QAC9B,gFAAgF;QAChF,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACzD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,iDAAiD,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;AACxF,CAAC"}
|
package/lib/upload.mjs
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
import { Uploads, } from "../resources/uploads.mjs";
|
|
2
|
+
// AWS S3 multipart upload limits.
|
|
3
|
+
const MIN_PART_SIZE = 6000000; // 6 MB (spec minimum is 5 MiB; a bit over to be safe)
|
|
4
|
+
const MAX_PART_SIZE = 5368709120; // 5 GiB
|
|
5
|
+
const MAX_PARTS = 10000;
|
|
6
|
+
const MAX_FILE_SIZE = 5497558138880; // 5 TiB
|
|
7
|
+
// `validated` is intermediate — the server has validated the upload but
|
|
8
|
+
// hasn't created the asset/model yet, so `entityId` isn't populated.
|
|
9
|
+
// Real terminals are `imported` (asset/model created), `complete`, and
|
|
10
|
+
// `failed`. Everything else means "keep polling".
|
|
11
|
+
const TERMINAL_STATUSES = new Set(['complete', 'failed', 'imported']);
|
|
12
|
+
/** Upload methods added on top of the original upload fields. */
|
|
13
|
+
export class UploadMethods {
|
|
14
|
+
/**
|
|
15
|
+
* Poll until the upload has been processed into an entity (asset or model),
|
|
16
|
+
* or reaches a terminal state (`imported`, `complete`, `failed`). Resolves
|
|
17
|
+
* with the latest upload data so you can read `entityId`, `status`, or
|
|
18
|
+
* `errorMessage` without a follow-up retrieve.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const res = await client.uploads.retrieve(uploadId);
|
|
23
|
+
* const done = await res.upload.wait();
|
|
24
|
+
* if (done.status === 'failed') throw new Error(done.errorMessage);
|
|
25
|
+
* console.log(done.entityId);
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
async wait(options) {
|
|
29
|
+
const final = await pollUntilImported(() => this._client.uploads.retrieve(this.id), options?.intervalMs ?? 2000, options?.timeoutMs ?? 300000);
|
|
30
|
+
return UploadMethods.from(this._client, final.upload);
|
|
31
|
+
}
|
|
32
|
+
/** @internal Create an Upload from raw upload data. */
|
|
33
|
+
static from(client, data) {
|
|
34
|
+
const upload = Object.assign(Object.create(UploadMethods.prototype), data);
|
|
35
|
+
Object.defineProperty(upload, '_client', { value: client, enumerable: false });
|
|
36
|
+
return upload;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
export const Upload = UploadMethods;
|
|
40
|
+
/**
|
|
41
|
+
* @internal Wrap `_thenUnwrap` to replace `response.upload` with an enhanced Upload.
|
|
42
|
+
*/
|
|
43
|
+
export function enhanceUpload(client, promise) {
|
|
44
|
+
return promise._thenUnwrap((data) => ({
|
|
45
|
+
...data,
|
|
46
|
+
upload: Upload.from(client, data.upload),
|
|
47
|
+
}));
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Enhanced Uploads resource.
|
|
51
|
+
* All original methods (`create`, `retrieve`, `triggerAction`) are inherited,
|
|
52
|
+
* with each response's `upload` field enriched with a `.wait()` helper.
|
|
53
|
+
* Adds `uploadFile()` — a one-call wrapper around the 4-step upload flow:
|
|
54
|
+
* init → PUT parts to S3 → trigger complete → poll until imported.
|
|
55
|
+
*/
|
|
56
|
+
export class EnhancedUploads extends Uploads {
|
|
57
|
+
create(body, options) {
|
|
58
|
+
return enhanceUpload(this._client, super.create(body, options));
|
|
59
|
+
}
|
|
60
|
+
retrieve(uploadID, options) {
|
|
61
|
+
return enhanceUpload(this._client, super.retrieve(uploadID, options));
|
|
62
|
+
}
|
|
63
|
+
triggerAction(uploadID, body, options) {
|
|
64
|
+
return enhanceUpload(this._client, super.triggerAction(uploadID, body, options));
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Upload a file end-to-end. Computes an optimal part size (within AWS's
|
|
68
|
+
* 5 MiB / 5 GiB / 10,000-part bounds), uploads all parts in parallel,
|
|
69
|
+
* triggers completion, polls until the server has validated and imported
|
|
70
|
+
* the file, and returns the resolved entity.
|
|
71
|
+
*
|
|
72
|
+
* The returned type narrows on `kind`: `'model'` returns a Model,
|
|
73
|
+
* everything else returns an Asset.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* // From a file path (Node)
|
|
78
|
+
* const { asset } = await client.uploads.uploadFile({
|
|
79
|
+
* file: './photo.jpg',
|
|
80
|
+
* fileName: 'photo.jpg',
|
|
81
|
+
* contentType: 'image/jpeg',
|
|
82
|
+
* kind: 'image',
|
|
83
|
+
* });
|
|
84
|
+
* console.log(asset.id, asset.url);
|
|
85
|
+
*
|
|
86
|
+
* // Or from bytes / Blob — anything you already have in memory
|
|
87
|
+
* await client.uploads.uploadFile({
|
|
88
|
+
* file: new Blob([pngBytes], { type: 'image/png' }),
|
|
89
|
+
* fileName: 'generated.png',
|
|
90
|
+
* contentType: 'image/png',
|
|
91
|
+
* kind: 'image',
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
async uploadFile(params, options) {
|
|
96
|
+
const bytes = await normalizeToBytes(params.file);
|
|
97
|
+
const fileSize = bytes.byteLength;
|
|
98
|
+
if (fileSize === 0) {
|
|
99
|
+
throw new Error('Cannot upload an empty file');
|
|
100
|
+
}
|
|
101
|
+
if (fileSize > MAX_FILE_SIZE) {
|
|
102
|
+
throw new Error(`File size (${fileSize} bytes) exceeds the maximum allowed size of ${MAX_FILE_SIZE} bytes (5 TiB)`);
|
|
103
|
+
}
|
|
104
|
+
// Pick the smallest legal part size that fits within MAX_PARTS.
|
|
105
|
+
const requiredPartSize = Math.ceil(fileSize / MAX_PARTS);
|
|
106
|
+
const partSize = Math.max(MIN_PART_SIZE, requiredPartSize);
|
|
107
|
+
if (partSize > MAX_PART_SIZE) {
|
|
108
|
+
throw new Error(`File size (${fileSize} bytes) requires a part size of ${partSize} bytes, ` +
|
|
109
|
+
`which exceeds the maximum part size of ${MAX_PART_SIZE} bytes (5 GiB)`);
|
|
110
|
+
}
|
|
111
|
+
const partsCount = Math.max(1, Math.ceil(fileSize / partSize));
|
|
112
|
+
// Step 1 — init upload session and receive presigned S3 URLs.
|
|
113
|
+
const createBody = {
|
|
114
|
+
fileName: params.fileName,
|
|
115
|
+
fileSize,
|
|
116
|
+
contentType: params.contentType,
|
|
117
|
+
kind: params.kind,
|
|
118
|
+
parts: partsCount,
|
|
119
|
+
...(params.kind !== 'model' && params.assetOptions ? { assetOptions: params.assetOptions } : {}),
|
|
120
|
+
};
|
|
121
|
+
const createRes = await this.create(createBody, options);
|
|
122
|
+
const session = createRes.upload;
|
|
123
|
+
const uploadId = session.id;
|
|
124
|
+
const parts = session.parts;
|
|
125
|
+
if (parts?.length !== partsCount) {
|
|
126
|
+
throw new Error(`Expected ${partsCount} presigned part URL(s), got ${parts?.length ?? 0}`);
|
|
127
|
+
}
|
|
128
|
+
// Step 2 — PUT each chunk to its presigned S3 URL, with a concurrency cap.
|
|
129
|
+
const concurrency = Math.max(1, params.partConcurrency ?? 4);
|
|
130
|
+
await uploadPartsWithConcurrency(bytes, parts, partSize, concurrency);
|
|
131
|
+
// Step 3 — tell the server all parts are uploaded.
|
|
132
|
+
await this.triggerAction(uploadId, { action: 'complete' }, options);
|
|
133
|
+
// Step 4 — poll until the upload has been processed into an entity.
|
|
134
|
+
const final = await pollUntilImported(() => this.retrieve(uploadId, options), params.pollIntervalMs ?? 2000, params.pollTimeoutMs ?? 300000);
|
|
135
|
+
if (final.upload.status === 'failed') {
|
|
136
|
+
throw new Error(`Upload ${uploadId} failed: ${final.upload.errorMessage ?? '<no error message>'}`);
|
|
137
|
+
}
|
|
138
|
+
const entityId = final.upload.entityId;
|
|
139
|
+
if (!entityId) {
|
|
140
|
+
throw new Error(`Upload ${uploadId} reached status "${final.upload.status}" but has no entityId`);
|
|
141
|
+
}
|
|
142
|
+
// Fetch and return the resolved entity (narrowed by kind).
|
|
143
|
+
if (params.kind === 'model') {
|
|
144
|
+
const model = await this._client.models.retrieve(entityId);
|
|
145
|
+
return model;
|
|
146
|
+
}
|
|
147
|
+
const asset = await this._client.assets.retrieve(entityId);
|
|
148
|
+
return asset;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
// ─────────────────────── helpers ───────────────────────
|
|
152
|
+
async function normalizeToBytes(input) {
|
|
153
|
+
if (typeof input === 'string') {
|
|
154
|
+
// Dynamic import so browser bundlers don't pull in node:fs.
|
|
155
|
+
const { readFile } = await import('node:fs/promises');
|
|
156
|
+
return new Uint8Array(await readFile(input));
|
|
157
|
+
}
|
|
158
|
+
if (input instanceof Uint8Array) {
|
|
159
|
+
return input;
|
|
160
|
+
}
|
|
161
|
+
if (typeof Blob !== 'undefined' && input instanceof Blob) {
|
|
162
|
+
return new Uint8Array(await input.arrayBuffer());
|
|
163
|
+
}
|
|
164
|
+
throw new Error('uploadFile: unsupported input type — expected a path string, Uint8Array, or Blob');
|
|
165
|
+
}
|
|
166
|
+
async function uploadPartsWithConcurrency(bytes, parts, partSize, concurrency) {
|
|
167
|
+
// Sort by part number so slicing lines up with the presigned URL order.
|
|
168
|
+
const sorted = [...parts].sort((a, b) => a.number - b.number);
|
|
169
|
+
let nextIndex = 0;
|
|
170
|
+
const workers = Array.from({ length: concurrency }, () => worker());
|
|
171
|
+
await Promise.all(workers);
|
|
172
|
+
async function worker() {
|
|
173
|
+
while (true) {
|
|
174
|
+
const i = nextIndex++;
|
|
175
|
+
if (i >= sorted.length)
|
|
176
|
+
return;
|
|
177
|
+
const part = sorted[i];
|
|
178
|
+
if (!part)
|
|
179
|
+
continue;
|
|
180
|
+
const start = i * partSize;
|
|
181
|
+
const end = Math.min(bytes.byteLength, start + partSize);
|
|
182
|
+
const chunk = bytes.subarray(start, end);
|
|
183
|
+
const res = await fetch(part.url, { method: 'PUT', body: chunk });
|
|
184
|
+
if (!res.ok) {
|
|
185
|
+
throw new Error(`Failed to upload part ${part.number}/${sorted.length}: ${res.status} ${res.statusText}`);
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
async function pollUntilImported(retrieve, intervalMs, timeoutMs) {
|
|
191
|
+
const deadline = Date.now() + timeoutMs;
|
|
192
|
+
while (Date.now() < deadline) {
|
|
193
|
+
const res = await retrieve();
|
|
194
|
+
const { status } = res.upload;
|
|
195
|
+
// Return as soon as we have an entityId OR the upload reached a terminal state.
|
|
196
|
+
if (res.upload.entityId || TERMINAL_STATUSES.has(status)) {
|
|
197
|
+
return res;
|
|
198
|
+
}
|
|
199
|
+
await new Promise((r) => setTimeout(r, intervalMs));
|
|
200
|
+
}
|
|
201
|
+
throw new Error(`Upload did not reach a terminal status within ${timeoutMs / 1000}s`);
|
|
202
|
+
}
|
|
203
|
+
//# sourceMappingURL=upload.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upload.mjs","sourceRoot":"","sources":["../src/lib/upload.ts"],"names":[],"mappings":"OAGO,EACL,OAAO,GAMR;AAsDD,kCAAkC;AAClC,MAAM,aAAa,GAAG,OAAS,CAAC,CAAC,sDAAsD;AACvF,MAAM,aAAa,GAAG,UAAa,CAAC,CAAC,QAAQ;AAC7C,MAAM,SAAS,GAAG,KAAM,CAAC;AACzB,MAAM,aAAa,GAAG,aAAiB,CAAC,CAAC,QAAQ;AAIjD,wEAAwE;AACxE,qEAAqE;AACrE,uEAAuE;AACvE,kDAAkD;AAClD,MAAM,iBAAiB,GAAsB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AASzF,iEAAiE;AACjE,MAAM,OAAO,aAAa;IAGxB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAe,OAA2B;QAClD,MAAM,KAAK,GAAG,MAAM,iBAAiB,CACnC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAC5C,OAAO,EAAE,UAAU,IAAI,IAAK,EAC5B,OAAO,EAAE,SAAS,IAAI,MAAO,CAC9B,CAAC;QACF,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,uDAAuD;IACvD,MAAM,CAAC,IAAI,CAAC,MAAgB,EAAE,IAAsC;QAClE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,IAAI,CAAW,CAAC;QACrF,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAID,MAAM,CAAC,MAAM,MAAM,GAAG,aAAa,CAAC;AAQpC;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAgB,EAChB,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAA0C,CAAC;KAC7E,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,eAAgB,SAAQ,OAAO;IACjC,MAAM,CACb,IAAwB,EACxB,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAEQ,QAAQ,CACf,QAAgB,EAChB,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAEQ,aAAa,CACpB,QAAgB,EAChB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,UAAU,CACd,MAA2B,EAC3B,OAAwB;QAExB,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC;QAElC,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,QAAQ,GAAG,aAAa,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,cAAc,QAAQ,+CAA+C,aAAa,gBAAgB,CACnG,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;QAC3D,IAAI,QAAQ,GAAG,aAAa,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,cAAc,QAAQ,mCAAmC,QAAQ,UAAU;gBACzE,0CAA0C,aAAa,gBAAgB,CAC1E,CAAC;QACJ,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC;QAE/D,8DAA8D;QAC9D,MAAM,UAAU,GAAuB;YACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ;YACR,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,UAAU;YACjB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjG,CAAC;QACF,MAAM,SAAS,GAAyB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,IAAI,KAAK,EAAE,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,+BAA+B,KAAK,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,2EAA2E;QAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC;QAC7D,MAAM,0BAA0B,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEtE,mDAAmD;QACnD,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpE,oEAAoE;QACpE,MAAM,KAAK,GAAG,MAAM,iBAAiB,CACnC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,EACtC,MAAM,CAAC,cAAc,IAAI,IAAK,EAC9B,MAAM,CAAC,aAAa,IAAI,MAAO,CAChC,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,YAAY,KAAK,CAAC,MAAM,CAAC,YAAY,IAAI,oBAAoB,EAAE,CAAC,CAAC;QACrG,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,oBAAoB,KAAK,CAAC,MAAM,CAAC,MAAM,uBAAuB,CAAC,CAAC;QACpG,CAAC;QAED,2DAA2D;QAC3D,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC3D,OAAO,KAAwB,CAAC;QAClC,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3D,OAAO,KAAwB,CAAC;IAClC,CAAC;CACF;AAED,0DAA0D;AAE1D,KAAK,UAAU,gBAAgB,CAAC,KAAsB;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,4DAA4D;QAC5D,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACtD,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QACzD,OAAO,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;AACtG,CAAC;AAED,KAAK,UAAU,0BAA0B,CACvC,KAAiB,EACjB,KAA8D,EAC9D,QAAgB,EAChB,WAAmB;IAEnB,wEAAwE;IACxE,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAE9D,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAE3B,KAAK,UAAU,MAAM;QACnB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,SAAS,EAAE,CAAC;YACtB,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM;gBAAE,OAAO;YAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACzC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YAClE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CACzF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,QAA+C,EAC/C,UAAkB,EAClB,SAAiB;IAEjB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;IACxC,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,QAAQ,EAAE,CAAC;QAC7B,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QAC9B,gFAAgF;QAChF,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACzD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,iDAAiD,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;AACxF,CAAC"}
|
package/lib/workflow.d.mts
CHANGED
|
@@ -2,21 +2,25 @@ import type { APIPromise } from "../core/api-promise.mjs";
|
|
|
2
2
|
import type { RequestOptions } from "../internal/request-options.mjs";
|
|
3
3
|
import { Workflows, type WorkflowApproveUserParams, type WorkflowApproveUserResponse, type WorkflowRetrieveResponse, type WorkflowRunParams, type WorkflowRunResponse } from "../resources/workflows.mjs";
|
|
4
4
|
import { type WithJob } from "./job.mjs";
|
|
5
|
+
import type { Scenario } from "./scenario.mjs";
|
|
5
6
|
type DefinitionFlow = WorkflowRetrieveResponse.Workflow.Flow;
|
|
6
7
|
type NodeType = DefinitionFlow['type'];
|
|
7
8
|
/**
|
|
8
9
|
* Enhanced workflow object with helper methods.
|
|
9
|
-
* Has all original workflow fields plus `findNode()`, `getNodesByType()
|
|
10
|
+
* Has all original workflow fields plus `findNode()`, `getNodesByType()`,
|
|
11
|
+
* `validate()`, and `run()`.
|
|
10
12
|
*
|
|
11
13
|
* @example
|
|
12
14
|
* ```ts
|
|
13
15
|
* const response = await client.workflows.retrieve(workflowId);
|
|
14
16
|
* response.workflow.findNode('final_image');
|
|
15
17
|
* response.workflow.getNodesByType('custom-model');
|
|
18
|
+
* const gen = await response.workflow.run({ body: { prompt: '...' } });
|
|
16
19
|
* response.workflow.name; // original fields still work
|
|
17
20
|
* ```
|
|
18
21
|
*/
|
|
19
22
|
export declare class WorkflowEntity {
|
|
23
|
+
/** @internal */ readonly _client: Scenario;
|
|
20
24
|
/** Find a node in the workflow definition by ID. */
|
|
21
25
|
findNode(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow, nodeId: string): DefinitionFlow | undefined;
|
|
22
26
|
/** Get all nodes of a specific type from the workflow definition. */
|
|
@@ -26,8 +30,15 @@ export declare class WorkflowEntity {
|
|
|
26
30
|
* Throws an `Error` with a human-readable message on the first violation found.
|
|
27
31
|
*/
|
|
28
32
|
validate(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow): void;
|
|
33
|
+
/**
|
|
34
|
+
* Run this workflow. Shortcut for
|
|
35
|
+
* `client.workflows.run(this.id, params)`.
|
|
36
|
+
*
|
|
37
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
38
|
+
*/
|
|
39
|
+
run(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow, params: WorkflowRunParams, options?: RequestOptions): APIPromise<WithJob<WorkflowRunResponse>>;
|
|
29
40
|
/** @internal Create a WorkflowEntity from raw workflow data. */
|
|
30
|
-
static from(data: WorkflowRetrieveResponse.Workflow): WorkflowRetrieveResponse.Workflow & WorkflowEntity;
|
|
41
|
+
static from(client: Scenario, data: WorkflowRetrieveResponse.Workflow): WorkflowRetrieveResponse.Workflow & WorkflowEntity;
|
|
31
42
|
}
|
|
32
43
|
/** Enhanced retrieve response with workflow entity methods. */
|
|
33
44
|
export type EnhancedWorkflowRetrieveResponse = Omit<WorkflowRetrieveResponse, 'workflow'> & {
|
package/lib/workflow.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflow.d.mts","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,SAAS,EACT,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;OACM,EAAE,KAAK,OAAO,EAAc;
|
|
1
|
+
{"version":3,"file":"workflow.d.mts","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,SAAS,EACT,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;OACM,EAAE,KAAK,OAAO,EAAc;OAG5B,KAAK,EAAE,QAAQ,EAAE;AAExB,KAAK,cAAc,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC;AAC7D,KAAK,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAEvC;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAc;IACzB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD,oDAAoD;IACpD,QAAQ,CACN,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EACxD,MAAM,EAAE,MAAM,GACb,cAAc,GAAG,SAAS;IAI7B,qEAAqE;IACrE,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,cAAc,EAAE;IAI1G;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,GAAG,IAAI;IAIxE;;;;;OAKG;IACH,GAAG,CACD,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EACxD,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3C,gEAAgE;IAChE,MAAM,CAAC,IAAI,CACT,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,wBAAwB,CAAC,QAAQ,GACtC,wBAAwB,CAAC,QAAQ,GAAG,cAAc;CAKtD;AAED,+DAA+D;AAC/D,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG;IAC1F,QAAQ,EAAE,wBAAwB,CAAC,QAAQ,GAAG,cAAc,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;OAGG;IACM,QAAQ,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAO/C,8EAA8E;IACrE,GAAG,CACV,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3C,4FAA4F;IACnF,WAAW,CAClB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAGpD"}
|
package/lib/workflow.d.ts
CHANGED
|
@@ -2,21 +2,25 @@ import type { APIPromise } from "../core/api-promise.js";
|
|
|
2
2
|
import type { RequestOptions } from "../internal/request-options.js";
|
|
3
3
|
import { Workflows, type WorkflowApproveUserParams, type WorkflowApproveUserResponse, type WorkflowRetrieveResponse, type WorkflowRunParams, type WorkflowRunResponse } from "../resources/workflows.js";
|
|
4
4
|
import { type WithJob } from "./job.js";
|
|
5
|
+
import type { Scenario } from "./scenario.js";
|
|
5
6
|
type DefinitionFlow = WorkflowRetrieveResponse.Workflow.Flow;
|
|
6
7
|
type NodeType = DefinitionFlow['type'];
|
|
7
8
|
/**
|
|
8
9
|
* Enhanced workflow object with helper methods.
|
|
9
|
-
* Has all original workflow fields plus `findNode()`, `getNodesByType()
|
|
10
|
+
* Has all original workflow fields plus `findNode()`, `getNodesByType()`,
|
|
11
|
+
* `validate()`, and `run()`.
|
|
10
12
|
*
|
|
11
13
|
* @example
|
|
12
14
|
* ```ts
|
|
13
15
|
* const response = await client.workflows.retrieve(workflowId);
|
|
14
16
|
* response.workflow.findNode('final_image');
|
|
15
17
|
* response.workflow.getNodesByType('custom-model');
|
|
18
|
+
* const gen = await response.workflow.run({ body: { prompt: '...' } });
|
|
16
19
|
* response.workflow.name; // original fields still work
|
|
17
20
|
* ```
|
|
18
21
|
*/
|
|
19
22
|
export declare class WorkflowEntity {
|
|
23
|
+
/** @internal */ readonly _client: Scenario;
|
|
20
24
|
/** Find a node in the workflow definition by ID. */
|
|
21
25
|
findNode(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow, nodeId: string): DefinitionFlow | undefined;
|
|
22
26
|
/** Get all nodes of a specific type from the workflow definition. */
|
|
@@ -26,8 +30,15 @@ export declare class WorkflowEntity {
|
|
|
26
30
|
* Throws an `Error` with a human-readable message on the first violation found.
|
|
27
31
|
*/
|
|
28
32
|
validate(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow): void;
|
|
33
|
+
/**
|
|
34
|
+
* Run this workflow. Shortcut for
|
|
35
|
+
* `client.workflows.run(this.id, params)`.
|
|
36
|
+
*
|
|
37
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
38
|
+
*/
|
|
39
|
+
run(this: WorkflowEntity & WorkflowRetrieveResponse.Workflow, params: WorkflowRunParams, options?: RequestOptions): APIPromise<WithJob<WorkflowRunResponse>>;
|
|
29
40
|
/** @internal Create a WorkflowEntity from raw workflow data. */
|
|
30
|
-
static from(data: WorkflowRetrieveResponse.Workflow): WorkflowRetrieveResponse.Workflow & WorkflowEntity;
|
|
41
|
+
static from(client: Scenario, data: WorkflowRetrieveResponse.Workflow): WorkflowRetrieveResponse.Workflow & WorkflowEntity;
|
|
31
42
|
}
|
|
32
43
|
/** Enhanced retrieve response with workflow entity methods. */
|
|
33
44
|
export type EnhancedWorkflowRetrieveResponse = Omit<WorkflowRetrieveResponse, 'workflow'> & {
|
package/lib/workflow.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,SAAS,EACT,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;OACM,EAAE,KAAK,OAAO,EAAc;
|
|
1
|
+
{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,SAAS,EACT,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;OACM,EAAE,KAAK,OAAO,EAAc;OAG5B,KAAK,EAAE,QAAQ,EAAE;AAExB,KAAK,cAAc,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC;AAC7D,KAAK,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAEvC;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAc;IACzB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD,oDAAoD;IACpD,QAAQ,CACN,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EACxD,MAAM,EAAE,MAAM,GACb,cAAc,GAAG,SAAS;IAI7B,qEAAqE;IACrE,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,cAAc,EAAE;IAI1G;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,GAAG,IAAI;IAIxE;;;;;OAKG;IACH,GAAG,CACD,IAAI,EAAE,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EACxD,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3C,gEAAgE;IAChE,MAAM,CAAC,IAAI,CACT,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,wBAAwB,CAAC,QAAQ,GACtC,wBAAwB,CAAC,QAAQ,GAAG,cAAc;CAKtD;AAED,+DAA+D;AAC/D,MAAM,MAAM,gCAAgC,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG;IAC1F,QAAQ,EAAE,wBAAwB,CAAC,QAAQ,GAAG,cAAc,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;OAGG;IACM,QAAQ,CACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAO/C,8EAA8E;IACrE,GAAG,CACV,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3C,4FAA4F;IACnF,WAAW,CAClB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAGpD"}
|
package/lib/workflow.js
CHANGED
|
@@ -6,13 +6,15 @@ const job_1 = require("./job.js");
|
|
|
6
6
|
const workflow_validator_1 = require("./workflow_validator.js");
|
|
7
7
|
/**
|
|
8
8
|
* Enhanced workflow object with helper methods.
|
|
9
|
-
* Has all original workflow fields plus `findNode()`, `getNodesByType()
|
|
9
|
+
* Has all original workflow fields plus `findNode()`, `getNodesByType()`,
|
|
10
|
+
* `validate()`, and `run()`.
|
|
10
11
|
*
|
|
11
12
|
* @example
|
|
12
13
|
* ```ts
|
|
13
14
|
* const response = await client.workflows.retrieve(workflowId);
|
|
14
15
|
* response.workflow.findNode('final_image');
|
|
15
16
|
* response.workflow.getNodesByType('custom-model');
|
|
17
|
+
* const gen = await response.workflow.run({ body: { prompt: '...' } });
|
|
16
18
|
* response.workflow.name; // original fields still work
|
|
17
19
|
* ```
|
|
18
20
|
*/
|
|
@@ -32,9 +34,20 @@ class WorkflowEntity {
|
|
|
32
34
|
validate() {
|
|
33
35
|
(0, workflow_validator_1.validateWorkflowFlow)(this.flow);
|
|
34
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* Run this workflow. Shortcut for
|
|
39
|
+
* `client.workflows.run(this.id, params)`.
|
|
40
|
+
*
|
|
41
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
42
|
+
*/
|
|
43
|
+
run(params, options) {
|
|
44
|
+
return this._client.workflows.run(this.id, params, options);
|
|
45
|
+
}
|
|
35
46
|
/** @internal Create a WorkflowEntity from raw workflow data. */
|
|
36
|
-
static from(data) {
|
|
37
|
-
|
|
47
|
+
static from(client, data) {
|
|
48
|
+
const entity = Object.assign(Object.create(WorkflowEntity.prototype), data);
|
|
49
|
+
Object.defineProperty(entity, '_client', { value: client, enumerable: false });
|
|
50
|
+
return entity;
|
|
38
51
|
}
|
|
39
52
|
}
|
|
40
53
|
exports.WorkflowEntity = WorkflowEntity;
|
|
@@ -51,7 +64,7 @@ class EnhancedWorkflows extends workflows_1.Workflows {
|
|
|
51
64
|
retrieve(workflowID, options) {
|
|
52
65
|
return super.retrieve(workflowID, options)._thenUnwrap((data) => ({
|
|
53
66
|
...data,
|
|
54
|
-
workflow: WorkflowEntity.from(data.workflow),
|
|
67
|
+
workflow: WorkflowEntity.from(this._client, data.workflow),
|
|
55
68
|
}));
|
|
56
69
|
}
|
|
57
70
|
/** Run a workflow. Returns an enhanced response where `job` has `.wait()`. */
|
package/lib/workflow.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":";;;AAEA,yDAOgC;AAChC,kCAAiD;AACjD,gEAA4D;
|
|
1
|
+
{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../src/lib/workflow.ts"],"names":[],"mappings":";;;AAEA,yDAOgC;AAChC,kCAAiD;AACjD,gEAA4D;AAO5D;;;;;;;;;;;;;GAaG;AACH,MAAa,cAAc;IAGzB,oDAAoD;IACpD,QAAQ,CAEN,MAAc;QAEd,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,qEAAqE;IACrE,cAAc,CAA2D,IAAc;QACrF,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,IAAA,yCAAoB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAED,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,gEAAgE;IAChE,MAAM,CAAC,IAAI,CACT,MAAgB,EAChB,IAAuC;QAEvC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5E,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/CD,wCA+CC;AAOD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,qBAAS;IAC9C;;;OAGG;IACM,QAAQ,CACf,UAAkB,EAClB,OAAwB;QAExB,OAAO,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAChE,GAAG,IAAI;YACP,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAmB,EAAE,IAAI,CAAC,QAAQ,CAAC;SACvE,CAAC,CAAC,CAAC;IACN,CAAC;IAED,8EAA8E;IACrE,GAAG,CACV,UAAkB,EAClB,MAAyB,EACzB,OAAwB;QAExB,OAAO,IAAA,gBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACnF,WAAW,CAClB,UAAkB,EAClB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAA,gBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAChF,CAAC;CACF;AAhCD,8CAgCC"}
|