chore: fix the types and update the api-report

Signed-off-by: blam <ben@blam.sh>

.changeset/gentle-ghosts-love.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': minor
+---
+
+breaking

.changeset/tender-apricots-fetch.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-scaffolder-backend': patch
+---
+
+smaller

plugins/scaffolder-backend/api-report.md

@@ -50,8 +50,8 @@ export type ActionContext<Input extends JsonObject> = {
   templateInfo?: TemplateInfo;
 };
 
-// @public
-export type CompletedTaskState = 'failed' | 'completed';
+// @public @deprecated
+export type CompletedTaskState = TaskCompletionState;
 
 // Warning: (ae-missing-release-tag) "createBuiltinActions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -315,7 +315,6 @@ export type CreateWorkerOptions = {
 
 // @public
 export class DatabaseTaskStore implements TaskStore {
-  constructor(options: DatabaseTaskStoreOptions);
   // (undocumented)
   claimTask(): Promise<SerializedTask | undefined>;
   // (undocumented)
@@ -325,7 +324,7 @@ export class DatabaseTaskStore implements TaskStore {
     eventBody,
   }: {
     taskId: string;
-    status: Status;
+    status: TaskStatus;
     eventBody: JsonObject;
   }): Promise<void>;
   // Warning: (ae-forgotten-export) The symbol "DatabaseTaskStoreOptions" needs to be exported by the entry point index.d.ts
@@ -334,11 +333,8 @@ export class DatabaseTaskStore implements TaskStore {
   static create(options: DatabaseTaskStoreOptions): Promise<DatabaseTaskStore>;
   // (undocumented)
   createTask(
-    spec: TaskSpec,
-    secrets?: TaskSecrets,
-  ): Promise<{
-    taskId: string;
-  }>;
+    options: TaskStoreCreateTaskOptions,
+  ): Promise<TaskStoreCreateTaskResult>;
   // (undocumented)
   emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
   // (undocumented)
@@ -357,10 +353,8 @@ export class DatabaseTaskStore implements TaskStore {
   }>;
 }
 
-// @public
-export type DispatchResult = {
-  taskId: string;
-};
+// @public @deprecated
+export type DispatchResult = TaskBrokerDispatchResult;
 
 // Warning: (ae-missing-release-tag) "fetchContents" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -449,7 +443,7 @@ export class ScaffolderEntitiesProcessor implements CatalogProcessor {
 export type SerializedTask = {
   id: string;
   spec: TaskSpec;
-  status: Status;
+  status: TaskStatus;
   createdAt: string;
   lastHeartbeatAt?: string;
   secrets?: TaskSecrets;
@@ -464,20 +458,17 @@ export type SerializedTaskEvent = {
   createdAt: string;
 };
 
-// @public
-export type Status =
-  | 'open'
-  | 'processing'
-  | 'failed'
-  | 'cancelled'
-  | 'completed';
+// @public @deprecated
+export type Status = TaskStatus;
 
 // @public
 export interface TaskBroker {
   // (undocumented)
   claim(): Promise<TaskContext>;
   // (undocumented)
-  dispatch(spec: TaskSpec, secrets?: TaskSecrets): Promise<DispatchResult>;
+  dispatch(
+    options: TaskBrokerDispatchOptions,
+  ): Promise<TaskBrokerDispatchResult>;
   // (undocumented)
   get(taskId: string): Promise<SerializedTask>;
   // (undocumented)
@@ -499,10 +490,24 @@ export interface TaskBroker {
   vacuumTasks(timeoutS: { timeoutS: number }): Promise<void>;
 }
 
+// @public
+export type TaskBrokerDispatchOptions = {
+  spec: TaskSpec;
+  secrets?: TaskSecrets;
+};
+
+// @public
+export type TaskBrokerDispatchResult = {
+  taskId: string;
+};
+
+// @public
+export type TaskCompletionState = 'failed' | 'completed';
+
 // @public
 export interface TaskContext {
   // (undocumented)
-  complete(result: CompletedTaskState, metadata?: JsonValue): Promise<void>;
+  complete(result: TaskCompletionState, metadata?: JsonValue): Promise<void>;
   // (undocumented)
   done: boolean;
   // (undocumented)
@@ -521,7 +526,7 @@ export type TaskEventType = 'completion' | 'log';
 // @public
 export class TaskManager implements TaskContext {
   // (undocumented)
-  complete(result: CompletedTaskState, metadata?: JsonObject): Promise<void>;
+  complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
   // (undocumented)
   static create(
     state: TaskState,
@@ -561,6 +566,14 @@ export interface TaskState {
   taskId: string;
 }
 
+// @public
+export type TaskStatus =
+  | 'open'
+  | 'processing'
+  | 'failed'
+  | 'cancelled'
+  | 'completed';
+
 // @public
 export interface TaskStore {
   // (undocumented)
@@ -568,16 +581,13 @@ export interface TaskStore {
   // (undocumented)
   completeTask(options: {
     taskId: string;
-    status: Status;
+    status: TaskStatus;
     eventBody: JsonObject;
   }): Promise<void>;
   // (undocumented)
   createTask(
-    task: TaskSpec,
-    secrets?: TaskSecrets,
-  ): Promise<{
-    taskId: string;
-  }>;
+    options: TaskStoreCreateTaskOptions,
+  ): Promise<TaskStoreCreateTaskResult>;
   // (undocumented)
   emitLogEvent({ taskId, body }: TaskStoreEmitOptions): Promise<void>;
   // (undocumented)
@@ -596,6 +606,17 @@ export interface TaskStore {
   }>;
 }
 
+// @public
+export type TaskStoreCreateTaskOptions = {
+  spec: TaskSpec;
+  secrets?: TaskSecrets;
+};
+
+// @public
+export type TaskStoreCreateTaskResult = {
+  taskId: string;
+};
+
 // @public
 export type TaskStoreEmitOptions = {
   taskId: string;

plugins/scaffolder-backend/src/scaffolder/tasks/index.ts

@@ -38,5 +38,7 @@ export type {
   DispatchResult,
   TaskBrokerDispatchResult,
   TaskBrokerDispatchOptions,
+  TaskStoreCreateTaskOptions,
+  TaskStoreCreateTaskResult,
   TemplateMetadata,
 } from './types';

plugins/scaffolder-backend/src/scaffolder/tasks/types.ts

@@ -131,6 +131,8 @@ export type TaskBrokerDispatchOptions = {
 
 /**
  * DispatchResult
+ *
+ * @public
  * @deprecated use TaskBrokerDispatchResult instead
  */
 export type DispatchResult = TaskBrokerDispatchResult;