scaffolder-backend: move more types to -node

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/scaffolder-node/src/index.ts

@@ -22,6 +22,7 @@
 
 export * from './actions';
 export * from './tasks';
+export type { TemplateFilter, TemplateGlobal } from './types';
 export {
   scaffolderActionsExtensionPoint,
   type ScaffolderActionsExtensionPoint,

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

@@ -14,4 +14,15 @@
  * limitations under the License.
  */
 
-export { type TaskSecrets } from './types';
+export type {
+  TaskSecrets,
+  SerializedTask,
+  SerializedTaskEvent,
+  TaskBroker,
+  TaskBrokerDispatchOptions,
+  TaskBrokerDispatchResult,
+  TaskCompletionState,
+  TaskContext,
+  TaskEventType,
+  TaskStatus,
+} from './types';

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

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+import { TaskSpec } from '@backstage/plugin-scaffolder-common';
+import { JsonObject, Observable } from '@backstage/types';
+
 /**
  * TaskSecrets
  *
@@ -22,3 +25,124 @@
 export type TaskSecrets = Record<string, string> & {
   backstageToken?: string;
 };
+
+/**
+ * The status of each step of the Task
+ *
+ * @public
+ */
+export type TaskStatus =
+  | 'cancelled'
+  | 'completed'
+  | 'failed'
+  | 'open'
+  | 'processing';
+
+/**
+ * The state of a completed task.
+ *
+ * @public
+ */
+export type TaskCompletionState = 'failed' | 'completed';
+
+/**
+ * SerializedTask
+ *
+ * @public
+ */
+export type SerializedTask = {
+  id: string;
+  spec: TaskSpec;
+  status: TaskStatus;
+  createdAt: string;
+  lastHeartbeatAt?: string;
+  createdBy?: string;
+  secrets?: TaskSecrets;
+};
+
+/**
+ * TaskEventType
+ *
+ * @public
+ */
+export type TaskEventType = 'completion' | 'log' | 'cancelled';
+
+/**
+ * SerializedTaskEvent
+ *
+ * @public
+ */
+export type SerializedTaskEvent = {
+  id: number;
+  taskId: string;
+  body: JsonObject;
+  type: TaskEventType;
+  createdAt: string;
+};
+
+/**
+ * The result of {@link TaskBroker.dispatch}
+ *
+ * @public
+ */
+export type TaskBrokerDispatchResult = {
+  taskId: string;
+};
+
+/**
+ * The options passed to {@link TaskBroker.dispatch}
+ * Currently a spec and optional secrets
+ *
+ * @public
+ */
+export type TaskBrokerDispatchOptions = {
+  spec: TaskSpec;
+  secrets?: TaskSecrets;
+  createdBy?: string;
+};
+
+/**
+ * Task
+ *
+ * @public
+ */
+export interface TaskContext {
+  cancelSignal: AbortSignal;
+  spec: TaskSpec;
+  secrets?: TaskSecrets;
+  createdBy?: string;
+  done: boolean;
+  isDryRun?: boolean;
+
+  complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
+
+  emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
+
+  getWorkspaceName(): Promise<string>;
+}
+
+/**
+ * TaskBroker
+ *
+ * @public
+ */
+export interface TaskBroker {
+  cancel?(taskId: string): Promise<void>;
+
+  claim(): Promise<TaskContext>;
+
+  dispatch(
+    options: TaskBrokerDispatchOptions,
+  ): Promise<TaskBrokerDispatchResult>;
+
+  vacuumTasks(options: { timeoutS: number }): Promise<void>;
+
+  event$(options: {
+    taskId: string;
+    after: number | undefined;
+  }): Observable<{ events: SerializedTaskEvent[] }>;
+
+  get(taskId: string): Promise<SerializedTask>;
+
+  list?(options?: { createdBy?: string }): Promise<{ tasks: SerializedTask[] }>;
+}

plugins/scaffolder-node/src/types.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { JsonValue } from '@backstage/types';
+
+/** @public */
+export type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
+
+/** @public */
+export type TemplateGlobal =
+  | ((...args: JsonValue[]) => JsonValue | undefined)
+  | JsonValue;