@meistrari/tela-sdk-js 2.10.0 → 2.11.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/README.md +8 -2
- package/dist/index.cjs +5 -5
- package/dist/index.d.cts +29 -3
- package/dist/index.d.mts +29 -3
- package/dist/index.d.ts +29 -3
- package/dist/index.mjs +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -636,11 +636,16 @@ const { data, meta } = await tela.tasks.list({
|
|
|
636
636
|
status: ['validating', 'completed'],
|
|
637
637
|
tags: 'product:my-app',
|
|
638
638
|
createdAtSince: new Date('2024-01-01'),
|
|
639
|
+
excludeInputOutputColumns: true, // omit raw input/input content/original output
|
|
639
640
|
orderBy: ['createdAt'],
|
|
640
641
|
order: 'desc',
|
|
641
642
|
limit: 50,
|
|
642
643
|
})
|
|
643
644
|
|
|
645
|
+
// Lean list rows still include outputContent and flattened inputFiles.
|
|
646
|
+
// Fetch a single task when you need raw input or original output payloads.
|
|
647
|
+
const fullTask = await tela.tasks.get(data[0].id)
|
|
648
|
+
|
|
644
649
|
// Mutations
|
|
645
650
|
await tela.tasks.rename('task-id', 'New name')
|
|
646
651
|
await tela.tasks.approve('task-id') // sets status: 'completed'
|
|
@@ -686,7 +691,7 @@ const uiStatus = normalizeTaskStatus(task.status)
|
|
|
686
691
|
// 'failed' | 'cancelled' → 'failed'
|
|
687
692
|
```
|
|
688
693
|
|
|
689
|
-
The full `Task`, `TaskInputFile`, `TaskListQuery`, `TaskUpdatePayload`, and `TaskStatus` types are exported from the package root, so you don't need to type any task-related responses by hand.
|
|
694
|
+
The full `Task`, `TaskListItem`, `TaskInputFile`, `TaskListQuery`, `TaskUpdatePayload`, and `TaskStatus` types are exported from the package root, so you don't need to type any task-related responses by hand.
|
|
690
695
|
|
|
691
696
|
### Vault API
|
|
692
697
|
|
|
@@ -1199,5 +1204,6 @@ When you execute a canvas using `applicationId`, it creates a task in the applic
|
|
|
1199
1204
|
|
|
1200
1205
|
If you encounter issues during migration, please:
|
|
1201
1206
|
- Check the [examples](./examples/) directory for updated usage patterns
|
|
1202
|
-
- Review the [API documentation](
|
|
1207
|
+
- Review the [API documentation](https://sdk-js.tela.tools/)
|
|
1208
|
+
- Generate the API reference locally with `bun run docs` when checking changes
|
|
1203
1209
|
- Open an issue at [GitHub Issues](https://github.com/meistrari/tela-sdk-js/issues)
|
package/dist/index.cjs
CHANGED
|
@@ -23,7 +23,7 @@ const changeCase__namespace = /*#__PURE__*/_interopNamespaceCompat(changeCase);
|
|
|
23
23
|
const z__default = /*#__PURE__*/_interopDefaultCompat(z);
|
|
24
24
|
const Emittery__default = /*#__PURE__*/_interopDefaultCompat(Emittery);
|
|
25
25
|
|
|
26
|
-
const version = "2.
|
|
26
|
+
const version = "2.11.0";
|
|
27
27
|
|
|
28
28
|
var __defProp$a = Object.defineProperty;
|
|
29
29
|
var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
@@ -3937,6 +3937,7 @@ const TaskListFilters = z__default.looseObject({
|
|
|
3937
3937
|
const TaskListOptions = z__default.looseObject({
|
|
3938
3938
|
limit: z__default.number().optional(),
|
|
3939
3939
|
offset: z__default.number().optional(),
|
|
3940
|
+
excludeInputOutputColumns: z__default.boolean().optional(),
|
|
3940
3941
|
order: z__default.object({
|
|
3941
3942
|
by: z__default.enum(["createdAt", "updatedAt", "approvedAt", "status", "reference", "name"]),
|
|
3942
3943
|
direction: z__default.enum(["asc", "desc"])
|
|
@@ -4239,6 +4240,7 @@ class Workstation {
|
|
|
4239
4240
|
async *iterateTasks({ filters, options }) {
|
|
4240
4241
|
let rawQuery;
|
|
4241
4242
|
let hasMore = true;
|
|
4243
|
+
const validatedOptions = TaskListOptions.optional().parse(options);
|
|
4242
4244
|
while (hasMore) {
|
|
4243
4245
|
const { tasks, meta } = await this.listTasks({
|
|
4244
4246
|
filters,
|
|
@@ -4251,7 +4253,8 @@ class Workstation {
|
|
|
4251
4253
|
if (meta.links.next !== null) {
|
|
4252
4254
|
rawQuery = {
|
|
4253
4255
|
...meta.links.next,
|
|
4254
|
-
objectLinks: true
|
|
4256
|
+
objectLinks: true,
|
|
4257
|
+
...validatedOptions?.excludeInputOutputColumns !== void 0 ? { excludeInputOutputColumns: validatedOptions.excludeInputOutputColumns } : {}
|
|
4255
4258
|
};
|
|
4256
4259
|
} else {
|
|
4257
4260
|
hasMore = false;
|
|
@@ -4305,9 +4308,6 @@ class Tasks {
|
|
|
4305
4308
|
...NO_TRANSFORM
|
|
4306
4309
|
});
|
|
4307
4310
|
}
|
|
4308
|
-
/**
|
|
4309
|
-
* Lists tasks with optional filters and pagination.
|
|
4310
|
-
*/
|
|
4311
4311
|
async list(query = {}) {
|
|
4312
4312
|
const serialized = serializeTaskListQuery(query);
|
|
4313
4313
|
return this.client.get("/task", {
|
package/dist/index.d.cts
CHANGED
|
@@ -3277,6 +3277,7 @@ type TaskListFilters = z.input<typeof TaskListFilters>;
|
|
|
3277
3277
|
declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
3278
3278
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
3279
3279
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
3280
|
+
excludeInputOutputColumns: z.ZodOptional<z.ZodBoolean>;
|
|
3280
3281
|
order: z.ZodOptional<z.ZodObject<{
|
|
3281
3282
|
by: z.ZodEnum<{
|
|
3282
3283
|
name: "name";
|
|
@@ -3294,12 +3295,14 @@ declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
|
3294
3295
|
}, z.core.$loose>, z.ZodTransform<{
|
|
3295
3296
|
limit?: number | undefined;
|
|
3296
3297
|
offset?: number | undefined;
|
|
3298
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3297
3299
|
orderBy: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt" | undefined;
|
|
3298
3300
|
orderDirection: "asc" | "desc" | undefined;
|
|
3299
3301
|
}, {
|
|
3300
3302
|
[x: string]: unknown;
|
|
3301
3303
|
limit?: number | undefined;
|
|
3302
3304
|
offset?: number | undefined;
|
|
3305
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3303
3306
|
order?: {
|
|
3304
3307
|
by: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt";
|
|
3305
3308
|
direction: "asc" | "desc";
|
|
@@ -3340,6 +3343,8 @@ type LinkParams = {
|
|
|
3340
3343
|
limit: number;
|
|
3341
3344
|
/** Starting offset for the page */
|
|
3342
3345
|
offset: number;
|
|
3346
|
+
/** Whether heavy input/output columns are omitted from task rows */
|
|
3347
|
+
excludeInputOutputColumns?: boolean;
|
|
3343
3348
|
};
|
|
3344
3349
|
/**
|
|
3345
3350
|
* Navigation links for paginated task lists.
|
|
@@ -3663,6 +3668,16 @@ interface Task<TOutput = unknown> {
|
|
|
3663
3668
|
updatedAt: string;
|
|
3664
3669
|
deletedAt: string | null;
|
|
3665
3670
|
}
|
|
3671
|
+
/**
|
|
3672
|
+
* A lean task row returned when `excludeInputOutputColumns` is enabled.
|
|
3673
|
+
*
|
|
3674
|
+
* The API omits `rawInput`, `inputContent`, and `originalOutputContent` from
|
|
3675
|
+
* each row, while still returning the current `outputContent` and flattened
|
|
3676
|
+
* `inputFiles`. Fetch the task by id to retrieve the full task payload.
|
|
3677
|
+
*/
|
|
3678
|
+
type TaskListItem<TOutput = unknown> = Omit<Task<TOutput>, 'inputContent' | 'originalOutputContent' | 'rawInput'> & {
|
|
3679
|
+
inputFiles: Array<TaskInputFile>;
|
|
3680
|
+
};
|
|
3666
3681
|
/**
|
|
3667
3682
|
* Payload accepted by `tasks.update()`.
|
|
3668
3683
|
*
|
|
@@ -3705,14 +3720,22 @@ interface TaskListQuery {
|
|
|
3705
3720
|
order?: 'asc' | 'desc';
|
|
3706
3721
|
limit?: number;
|
|
3707
3722
|
offset?: number;
|
|
3723
|
+
/**
|
|
3724
|
+
* Omits raw input, normalized input content, and original output columns
|
|
3725
|
+
* from each listed task. The list rows still include the current
|
|
3726
|
+
* `outputContent` and flattened `inputFiles`.
|
|
3727
|
+
*
|
|
3728
|
+
* Use `tasks.get(id)` when you need the full task detail, including raw
|
|
3729
|
+
* input and original output payloads.
|
|
3730
|
+
*/
|
|
3708
3731
|
excludeInputOutputColumns?: boolean;
|
|
3709
3732
|
}
|
|
3710
3733
|
type TaskOrderBy = 'name' | 'reference' | 'approvedAt' | 'createdAt' | 'updatedAt' | 'id' | 'status' | 'approvedBy' | 'createdBy';
|
|
3711
3734
|
/**
|
|
3712
3735
|
* Paginated response wrapper.
|
|
3713
3736
|
*/
|
|
3714
|
-
interface TaskListResult<TOutput = unknown> {
|
|
3715
|
-
data: Array<
|
|
3737
|
+
interface TaskListResult<TOutput = unknown, TItem extends Task<TOutput> | TaskListItem<TOutput> = Task<TOutput>> {
|
|
3738
|
+
data: Array<TItem>;
|
|
3716
3739
|
meta: {
|
|
3717
3740
|
totalCount?: number;
|
|
3718
3741
|
limit?: number;
|
|
@@ -3836,6 +3859,9 @@ declare class Tasks {
|
|
|
3836
3859
|
/**
|
|
3837
3860
|
* Lists tasks with optional filters and pagination.
|
|
3838
3861
|
*/
|
|
3862
|
+
list<TOutput = unknown>(query: TaskListQuery & {
|
|
3863
|
+
excludeInputOutputColumns: true;
|
|
3864
|
+
}): Promise<TaskListResult<TOutput, TaskListItem<TOutput>>>;
|
|
3839
3865
|
list<TOutput = unknown>(query?: TaskListQuery): Promise<TaskListResult<TOutput>>;
|
|
3840
3866
|
/**
|
|
3841
3867
|
* Updates one or more fields of a task.
|
|
@@ -4254,4 +4280,4 @@ declare class TelaSDK extends BaseClient {
|
|
|
4254
4280
|
*/
|
|
4255
4281
|
declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
|
|
4256
4282
|
|
|
4257
|
-
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
|
4283
|
+
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
package/dist/index.d.mts
CHANGED
|
@@ -3277,6 +3277,7 @@ type TaskListFilters = z.input<typeof TaskListFilters>;
|
|
|
3277
3277
|
declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
3278
3278
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
3279
3279
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
3280
|
+
excludeInputOutputColumns: z.ZodOptional<z.ZodBoolean>;
|
|
3280
3281
|
order: z.ZodOptional<z.ZodObject<{
|
|
3281
3282
|
by: z.ZodEnum<{
|
|
3282
3283
|
name: "name";
|
|
@@ -3294,12 +3295,14 @@ declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
|
3294
3295
|
}, z.core.$loose>, z.ZodTransform<{
|
|
3295
3296
|
limit?: number | undefined;
|
|
3296
3297
|
offset?: number | undefined;
|
|
3298
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3297
3299
|
orderBy: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt" | undefined;
|
|
3298
3300
|
orderDirection: "asc" | "desc" | undefined;
|
|
3299
3301
|
}, {
|
|
3300
3302
|
[x: string]: unknown;
|
|
3301
3303
|
limit?: number | undefined;
|
|
3302
3304
|
offset?: number | undefined;
|
|
3305
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3303
3306
|
order?: {
|
|
3304
3307
|
by: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt";
|
|
3305
3308
|
direction: "asc" | "desc";
|
|
@@ -3340,6 +3343,8 @@ type LinkParams = {
|
|
|
3340
3343
|
limit: number;
|
|
3341
3344
|
/** Starting offset for the page */
|
|
3342
3345
|
offset: number;
|
|
3346
|
+
/** Whether heavy input/output columns are omitted from task rows */
|
|
3347
|
+
excludeInputOutputColumns?: boolean;
|
|
3343
3348
|
};
|
|
3344
3349
|
/**
|
|
3345
3350
|
* Navigation links for paginated task lists.
|
|
@@ -3663,6 +3668,16 @@ interface Task<TOutput = unknown> {
|
|
|
3663
3668
|
updatedAt: string;
|
|
3664
3669
|
deletedAt: string | null;
|
|
3665
3670
|
}
|
|
3671
|
+
/**
|
|
3672
|
+
* A lean task row returned when `excludeInputOutputColumns` is enabled.
|
|
3673
|
+
*
|
|
3674
|
+
* The API omits `rawInput`, `inputContent`, and `originalOutputContent` from
|
|
3675
|
+
* each row, while still returning the current `outputContent` and flattened
|
|
3676
|
+
* `inputFiles`. Fetch the task by id to retrieve the full task payload.
|
|
3677
|
+
*/
|
|
3678
|
+
type TaskListItem<TOutput = unknown> = Omit<Task<TOutput>, 'inputContent' | 'originalOutputContent' | 'rawInput'> & {
|
|
3679
|
+
inputFiles: Array<TaskInputFile>;
|
|
3680
|
+
};
|
|
3666
3681
|
/**
|
|
3667
3682
|
* Payload accepted by `tasks.update()`.
|
|
3668
3683
|
*
|
|
@@ -3705,14 +3720,22 @@ interface TaskListQuery {
|
|
|
3705
3720
|
order?: 'asc' | 'desc';
|
|
3706
3721
|
limit?: number;
|
|
3707
3722
|
offset?: number;
|
|
3723
|
+
/**
|
|
3724
|
+
* Omits raw input, normalized input content, and original output columns
|
|
3725
|
+
* from each listed task. The list rows still include the current
|
|
3726
|
+
* `outputContent` and flattened `inputFiles`.
|
|
3727
|
+
*
|
|
3728
|
+
* Use `tasks.get(id)` when you need the full task detail, including raw
|
|
3729
|
+
* input and original output payloads.
|
|
3730
|
+
*/
|
|
3708
3731
|
excludeInputOutputColumns?: boolean;
|
|
3709
3732
|
}
|
|
3710
3733
|
type TaskOrderBy = 'name' | 'reference' | 'approvedAt' | 'createdAt' | 'updatedAt' | 'id' | 'status' | 'approvedBy' | 'createdBy';
|
|
3711
3734
|
/**
|
|
3712
3735
|
* Paginated response wrapper.
|
|
3713
3736
|
*/
|
|
3714
|
-
interface TaskListResult<TOutput = unknown> {
|
|
3715
|
-
data: Array<
|
|
3737
|
+
interface TaskListResult<TOutput = unknown, TItem extends Task<TOutput> | TaskListItem<TOutput> = Task<TOutput>> {
|
|
3738
|
+
data: Array<TItem>;
|
|
3716
3739
|
meta: {
|
|
3717
3740
|
totalCount?: number;
|
|
3718
3741
|
limit?: number;
|
|
@@ -3836,6 +3859,9 @@ declare class Tasks {
|
|
|
3836
3859
|
/**
|
|
3837
3860
|
* Lists tasks with optional filters and pagination.
|
|
3838
3861
|
*/
|
|
3862
|
+
list<TOutput = unknown>(query: TaskListQuery & {
|
|
3863
|
+
excludeInputOutputColumns: true;
|
|
3864
|
+
}): Promise<TaskListResult<TOutput, TaskListItem<TOutput>>>;
|
|
3839
3865
|
list<TOutput = unknown>(query?: TaskListQuery): Promise<TaskListResult<TOutput>>;
|
|
3840
3866
|
/**
|
|
3841
3867
|
* Updates one or more fields of a task.
|
|
@@ -4254,4 +4280,4 @@ declare class TelaSDK extends BaseClient {
|
|
|
4254
4280
|
*/
|
|
4255
4281
|
declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
|
|
4256
4282
|
|
|
4257
|
-
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
|
4283
|
+
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
package/dist/index.d.ts
CHANGED
|
@@ -3277,6 +3277,7 @@ type TaskListFilters = z.input<typeof TaskListFilters>;
|
|
|
3277
3277
|
declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
3278
3278
|
limit: z.ZodOptional<z.ZodNumber>;
|
|
3279
3279
|
offset: z.ZodOptional<z.ZodNumber>;
|
|
3280
|
+
excludeInputOutputColumns: z.ZodOptional<z.ZodBoolean>;
|
|
3280
3281
|
order: z.ZodOptional<z.ZodObject<{
|
|
3281
3282
|
by: z.ZodEnum<{
|
|
3282
3283
|
name: "name";
|
|
@@ -3294,12 +3295,14 @@ declare const TaskListOptions: z.ZodPipe<z.ZodObject<{
|
|
|
3294
3295
|
}, z.core.$loose>, z.ZodTransform<{
|
|
3295
3296
|
limit?: number | undefined;
|
|
3296
3297
|
offset?: number | undefined;
|
|
3298
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3297
3299
|
orderBy: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt" | undefined;
|
|
3298
3300
|
orderDirection: "asc" | "desc" | undefined;
|
|
3299
3301
|
}, {
|
|
3300
3302
|
[x: string]: unknown;
|
|
3301
3303
|
limit?: number | undefined;
|
|
3302
3304
|
offset?: number | undefined;
|
|
3305
|
+
excludeInputOutputColumns?: boolean | undefined;
|
|
3303
3306
|
order?: {
|
|
3304
3307
|
by: "name" | "status" | "reference" | "approvedAt" | "createdAt" | "updatedAt";
|
|
3305
3308
|
direction: "asc" | "desc";
|
|
@@ -3340,6 +3343,8 @@ type LinkParams = {
|
|
|
3340
3343
|
limit: number;
|
|
3341
3344
|
/** Starting offset for the page */
|
|
3342
3345
|
offset: number;
|
|
3346
|
+
/** Whether heavy input/output columns are omitted from task rows */
|
|
3347
|
+
excludeInputOutputColumns?: boolean;
|
|
3343
3348
|
};
|
|
3344
3349
|
/**
|
|
3345
3350
|
* Navigation links for paginated task lists.
|
|
@@ -3663,6 +3668,16 @@ interface Task<TOutput = unknown> {
|
|
|
3663
3668
|
updatedAt: string;
|
|
3664
3669
|
deletedAt: string | null;
|
|
3665
3670
|
}
|
|
3671
|
+
/**
|
|
3672
|
+
* A lean task row returned when `excludeInputOutputColumns` is enabled.
|
|
3673
|
+
*
|
|
3674
|
+
* The API omits `rawInput`, `inputContent`, and `originalOutputContent` from
|
|
3675
|
+
* each row, while still returning the current `outputContent` and flattened
|
|
3676
|
+
* `inputFiles`. Fetch the task by id to retrieve the full task payload.
|
|
3677
|
+
*/
|
|
3678
|
+
type TaskListItem<TOutput = unknown> = Omit<Task<TOutput>, 'inputContent' | 'originalOutputContent' | 'rawInput'> & {
|
|
3679
|
+
inputFiles: Array<TaskInputFile>;
|
|
3680
|
+
};
|
|
3666
3681
|
/**
|
|
3667
3682
|
* Payload accepted by `tasks.update()`.
|
|
3668
3683
|
*
|
|
@@ -3705,14 +3720,22 @@ interface TaskListQuery {
|
|
|
3705
3720
|
order?: 'asc' | 'desc';
|
|
3706
3721
|
limit?: number;
|
|
3707
3722
|
offset?: number;
|
|
3723
|
+
/**
|
|
3724
|
+
* Omits raw input, normalized input content, and original output columns
|
|
3725
|
+
* from each listed task. The list rows still include the current
|
|
3726
|
+
* `outputContent` and flattened `inputFiles`.
|
|
3727
|
+
*
|
|
3728
|
+
* Use `tasks.get(id)` when you need the full task detail, including raw
|
|
3729
|
+
* input and original output payloads.
|
|
3730
|
+
*/
|
|
3708
3731
|
excludeInputOutputColumns?: boolean;
|
|
3709
3732
|
}
|
|
3710
3733
|
type TaskOrderBy = 'name' | 'reference' | 'approvedAt' | 'createdAt' | 'updatedAt' | 'id' | 'status' | 'approvedBy' | 'createdBy';
|
|
3711
3734
|
/**
|
|
3712
3735
|
* Paginated response wrapper.
|
|
3713
3736
|
*/
|
|
3714
|
-
interface TaskListResult<TOutput = unknown> {
|
|
3715
|
-
data: Array<
|
|
3737
|
+
interface TaskListResult<TOutput = unknown, TItem extends Task<TOutput> | TaskListItem<TOutput> = Task<TOutput>> {
|
|
3738
|
+
data: Array<TItem>;
|
|
3716
3739
|
meta: {
|
|
3717
3740
|
totalCount?: number;
|
|
3718
3741
|
limit?: number;
|
|
@@ -3836,6 +3859,9 @@ declare class Tasks {
|
|
|
3836
3859
|
/**
|
|
3837
3860
|
* Lists tasks with optional filters and pagination.
|
|
3838
3861
|
*/
|
|
3862
|
+
list<TOutput = unknown>(query: TaskListQuery & {
|
|
3863
|
+
excludeInputOutputColumns: true;
|
|
3864
|
+
}): Promise<TaskListResult<TOutput, TaskListItem<TOutput>>>;
|
|
3839
3865
|
list<TOutput = unknown>(query?: TaskListQuery): Promise<TaskListResult<TOutput>>;
|
|
3840
3866
|
/**
|
|
3841
3867
|
* Updates one or more fields of a task.
|
|
@@ -4254,4 +4280,4 @@ declare class TelaSDK extends BaseClient {
|
|
|
4254
4280
|
*/
|
|
4255
4281
|
declare function createTelaClient(opts: TelaSDKOptions): TelaSDK;
|
|
4256
4282
|
|
|
4257
|
-
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
|
4283
|
+
export { APIError, AuthenticationError, AuthorizationError, BadRequestError, BaseClient, type BaseClientOptions, type BaseTelaFileOptions, BatchExecutionFailedError, ConflictApiKeyAndJWTError, ConflictAuthMethodsError, ConflictError, ConnectionError, ConnectionTimeout, EmptyFileError, ExecutionFailedError, ExecutionNotStartedError, FileUploadError, type HTTPMethods, InternalServerError, InvalidExecutionModeError, InvalidFileURL, MissingApiKeyOrJWTError, MissingAuthError, type NormalizedTaskStatus, NotFoundError, RateLimitError, type RequestOptions, type SchemaBuilder, type Task, type TaskDeleteBulkResult, type TaskDeleteResult, TaskFailedError, type TaskInputContent, type TaskInputFile, type TaskListItem, type TaskListQuery, type TaskListResult, type TaskOrderBy, type TaskOutputContent, type TaskRerunResult, type TaskStatus, type TaskUndoApprovalBulkResult, type TaskUpdatePayload, Tasks, TelaError, TelaFile, type TelaFileInput, type TelaFileOptions, type TelaFileOptionsWithMimeType, TelaFileSchema, TelaSDK, type TelaSDKOptions, UnprocessableEntityError, UserAbortError, Vault, createTelaClient, extractTaskOutput, isTelaFile, isTelaFileArray, normalizeTaskStatus, toError };
|
package/dist/index.mjs
CHANGED
|
@@ -3,7 +3,7 @@ import { Minimatch } from 'minimatch';
|
|
|
3
3
|
import z, { z as z$1, ZodError } from 'zod';
|
|
4
4
|
import Emittery from 'emittery';
|
|
5
5
|
|
|
6
|
-
const version = "2.
|
|
6
|
+
const version = "2.11.0";
|
|
7
7
|
|
|
8
8
|
var __defProp$a = Object.defineProperty;
|
|
9
9
|
var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
|
|
@@ -3917,6 +3917,7 @@ const TaskListFilters = z.looseObject({
|
|
|
3917
3917
|
const TaskListOptions = z.looseObject({
|
|
3918
3918
|
limit: z.number().optional(),
|
|
3919
3919
|
offset: z.number().optional(),
|
|
3920
|
+
excludeInputOutputColumns: z.boolean().optional(),
|
|
3920
3921
|
order: z.object({
|
|
3921
3922
|
by: z.enum(["createdAt", "updatedAt", "approvedAt", "status", "reference", "name"]),
|
|
3922
3923
|
direction: z.enum(["asc", "desc"])
|
|
@@ -4219,6 +4220,7 @@ class Workstation {
|
|
|
4219
4220
|
async *iterateTasks({ filters, options }) {
|
|
4220
4221
|
let rawQuery;
|
|
4221
4222
|
let hasMore = true;
|
|
4223
|
+
const validatedOptions = TaskListOptions.optional().parse(options);
|
|
4222
4224
|
while (hasMore) {
|
|
4223
4225
|
const { tasks, meta } = await this.listTasks({
|
|
4224
4226
|
filters,
|
|
@@ -4231,7 +4233,8 @@ class Workstation {
|
|
|
4231
4233
|
if (meta.links.next !== null) {
|
|
4232
4234
|
rawQuery = {
|
|
4233
4235
|
...meta.links.next,
|
|
4234
|
-
objectLinks: true
|
|
4236
|
+
objectLinks: true,
|
|
4237
|
+
...validatedOptions?.excludeInputOutputColumns !== void 0 ? { excludeInputOutputColumns: validatedOptions.excludeInputOutputColumns } : {}
|
|
4235
4238
|
};
|
|
4236
4239
|
} else {
|
|
4237
4240
|
hasMore = false;
|
|
@@ -4285,9 +4288,6 @@ class Tasks {
|
|
|
4285
4288
|
...NO_TRANSFORM
|
|
4286
4289
|
});
|
|
4287
4290
|
}
|
|
4288
|
-
/**
|
|
4289
|
-
* Lists tasks with optional filters and pagination.
|
|
4290
|
-
*/
|
|
4291
4291
|
async list(query = {}) {
|
|
4292
4292
|
const serialized = serializeTaskListQuery(query);
|
|
4293
4293
|
return this.client.get("/task", {
|