paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

chore: remove deprecated types and making breaking changes

Browse Source 
Signed-off-by: benjdlambert <ben@blam.sh>
This commit is contained in:
benjdlambert
2025-09-23 15:49:58 +02:00
parent 56d856b8ab
commit 6ea23c9c6d
10 changed files with 24 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-node/report.api.md
+4 -9
View File
@@ -356,7 +356,7 @@ export type SerializedTaskEvent = {
// @public
export interface TaskBroker {
// (undocumented)
cancel?(taskId: string): Promise<void>;
cancel(taskId: string): Promise<void>;
// (undocumented)
claim(): Promise<TaskContext>;
// (undocumented)
@@ -370,7 +370,7 @@ export interface TaskBroker {
// (undocumented)
get(taskId: string): Promise<SerializedTask>;
// (undocumented)
list?(options?: {
list(options?: {
filters?: {
createdBy?: string | string[];
status?: TaskStatus | TaskStatus[];
@@ -388,15 +388,10 @@ export interface TaskBroker {
tasks: SerializedTask[];
totalTasks?: number;
}>;
// @deprecated (undocumented)
list?(options: { createdBy?: string; status?: TaskStatus }): Promise<{
tasks: SerializedTask[];
totalTasks?: number;
}>;
// (undocumented)
recoverTasks?(): Promise<void>;
recoverTasks(): Promise<void>;
// (undocumented)
retry?(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
retry(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
// (undocumented)
vacuumTasks(options: { timeoutS: number }): Promise<void>;
}
plugins/scaffolder-node/src/tasks/types.ts
+4 -12
View File
@@ -177,13 +177,13 @@ export interface TaskContext {
* @public
*/
export interface TaskBroker {
cancel?(taskId: string): Promise<void>;
cancel(taskId: string): Promise<void>;
retry?(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
retry(options: { secrets?: TaskSecrets; taskId: string }): Promise<void>;
claim(): Promise<TaskContext>;
recoverTasks?(): Promise<void>;
recoverTasks(): Promise<void>;
dispatch(
options: TaskBrokerDispatchOptions,
@@ -198,7 +198,7 @@ export interface TaskBroker {
get(taskId: string): Promise<SerializedTask>;
list?(options?: {
list(options?: {
filters?: {
createdBy?: string | string[];
status?: TaskStatus | TaskStatus[];
@@ -210,12 +210,4 @@ export interface TaskBroker {
order?: { order: 'asc' | 'desc'; field: string }[];
permissionFilters?: PermissionCriteria<TaskFilters>;
}): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>;
/**
* @deprecated Make sure to pass `createdBy` and `status` in the `filters` parameter instead
*/
list?(options: {
createdBy?: string;
status?: TaskStatus;
}): Promise<{ tasks: SerializedTask[]; totalTasks?: number }>;
}