wip

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>

plugins/scaffolder-node/api-report.md

@@ -64,19 +64,6 @@ export function addFiles(options: {
   logger?: Logger | undefined;
 }): Promise<void>;
 
-// @public
-export type CheckpointRecord =
-  | {
-      key: string;
-      status: 'success';
-      value: JsonValue;
-    }
-  | {
-      key: string;
-      status: 'failed';
-      reason: string;
-    };
-
 // @public (undocumented)
 export function cloneRepo(options: {
   url: string;
@@ -362,9 +349,19 @@ export interface TaskContext {
   // (undocumented)
   emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
   // (undocumented)
-  getCheckpoints?(): Promise<
+  getTaskState?(): Promise<
     | {
-        state: TaskState;
+        state: {
+          [key: string]:
+            | {
+                status: 'failed';
+                reason: string;
+              }
+            | {
+                status: 'success';
+                value: JsonValue;
+              };
+        };
       }
     | undefined
   >;
@@ -377,9 +374,31 @@ export interface TaskContext {
   // (undocumented)
   spec: TaskSpec;
   // (undocumented)
-  state?: TaskState;
+  state?: {
+    [key: string]:
+      | {
+          status: 'failed';
+          reason: string;
+        }
+      | {
+          status: 'success';
+          value: JsonValue;
+        };
+  };
   // (undocumented)
-  updateCheckpoint?(options: CheckpointRecord): Promise<void>;
+  updateCheckpoint?(
+    options:
+      | {
+          key: string;
+          status: 'success';
+          value: JsonValue;
+        }
+      | {
+          key: string;
+          status: 'failed';
+          reason: string;
+        },
+  ): Promise<void>;
 }
 
 // @public

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

@@ -26,5 +26,4 @@ export type {
   TaskEventType,
   TaskState,
   TaskStatus,
-  CheckpointRecord,
 } from './types';

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

@@ -26,24 +26,6 @@ export type TaskSecrets = Record<string, string> & {
   backstageToken?: string;
 };
 
-/**
- * The record passed to TaskBroker for updating a checkpoint.
- * Parameters to store the result of the executed checkpoint
- *
- * @public
- */
-export type CheckpointRecord =
-  | {
-      key: string;
-      status: 'success';
-      value: JsonValue;
-    }
-  | {
-      key: string;
-      status: 'failed';
-      reason: string;
-    };
-
 /**
  * The state of all task's checkpoints
  *
@@ -142,7 +124,14 @@ export interface TaskContext {
   cancelSignal: AbortSignal;
   spec: TaskSpec;
   secrets?: TaskSecrets;
-  state?: TaskState;
+  state?: {
+    [key: string]:
+      | { status: 'failed'; reason: string }
+      | {
+          status: 'success';
+          value: JsonValue;
+        };
+  };
   createdBy?: string;
   done: boolean;
   isDryRun?: boolean;
@@ -151,9 +140,33 @@ export interface TaskContext {
 
   emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
 
-  getCheckpoints?(): Promise<{ state: TaskState } | undefined>;
+  getTaskState?(): Promise<
+    | {
+        state: {
+          [key: string]:
+            | { status: 'failed'; reason: string }
+            | {
+                status: 'success';
+                value: JsonValue;
+              };
+        };
+      }
+    | undefined
+  >;
 
-  updateCheckpoint?(options: CheckpointRecord): Promise<void>;
+  updateCheckpoint?(
+    options:
+      | {
+          key: string;
+          status: 'success';
+          value: JsonValue;
+        }
+      | {
+          key: string;
+          status: 'failed';
+          reason: string;
+        },
+  ): Promise<void>;
 
   getWorkspaceName(): Promise<string>;
 }