@backstage/plugin-scaffolder-node 0.11.1 → 0.12.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.12.0-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.18.1-next.1
+  - @backstage/backend-plugin-api@1.4.4-next.0
+  - @backstage/plugin-permission-common@0.9.2-next.0
+  - @backstage/plugin-scaffolder-common@1.7.2-next.1
+
+## 0.12.0-next.0
+
+### Minor Changes
+
+- 9b81a90: **BREAKING** - Marking optional fields as required in the `TaskBroker`, these can be fixed with a no-op `() => void` if you don't want to implement the functions.
+
+  - `cancel`, `recoverTasks` and `retry` are the required methods on the `TaskBroker` interface.
+
+  **NOTE**: If you're affected by this breaking change, please reach out to us in an issue as we're thinking about completely removing the `TaskBroker` extension point soon and would like to hear your use cases for the upcoming re-architecture of the `scaffolder-backend` plugin.
+
+### Patch Changes
+
+- c8aa210: **BREAKING ALPHA**: We've moved the `scaffolderActionsExtensionPoint` from `/alpha` to the main export.
+
+  ```tsx
+  // before
+  import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
+
+  // after
+  import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';
+  ```
+
+- 6e2bda7: **DEPRECATION**: We're going to be working on refactoring a lot of the internals of the Scaffolder backend plugin, and with that comes a lot of deprecations and removals for public types that are making these things hard.
+
+  If you're using these types, please reach out to us either on Discord or a GitHub issue with your use cases.
+
+  - `SerializedTask`, `SerializedTaskEvent`, `TaskBroker`, `TaskContext`, `TaskBrokerDispatchOptions`, `TaskBrokerDispatchResult`, `TaskCompletionState`, `TaskEventType`, `TaskFilter`, `TaskFilters`, `TaskStatus` are the types that have now been marked as deprecated, and will be removed in a future release.
+
+- Updated dependencies
+  - @backstage/integration@1.18.1-next.0
+  - @backstage/plugin-scaffolder-common@1.7.2-next.0
+  - @backstage/backend-plugin-api@1.4.3
+  - @backstage/catalog-model@1.7.5
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/plugin-permission-common@0.9.1
+
 ## 0.11.1
 
 ### Patch Changes

package/dist/alpha.cjs.js

@@ -5,9 +5,6 @@ var serializer = require('./tasks/serializer.cjs.js');
 var createTemplateFilter = require('./alpha/filters/createTemplateFilter.cjs.js');
 var createTemplateGlobal = require('./alpha/globals/createTemplateGlobal.cjs.js');
 
-const scaffolderActionsExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "scaffolder.actions"
-});
 const scaffolderTaskBrokerExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "scaffolder.taskBroker"
 });
@@ -26,7 +23,6 @@ exports.serializeWorkspace = serializer.serializeWorkspace;
 exports.createTemplateFilter = createTemplateFilter.createTemplateFilter;
 exports.createTemplateGlobalFunction = createTemplateGlobal.createTemplateGlobalFunction;
 exports.createTemplateGlobalValue = createTemplateGlobal.createTemplateGlobalValue;
-exports.scaffolderActionsExtensionPoint = scaffolderActionsExtensionPoint;
 exports.scaffolderAutocompleteExtensionPoint = scaffolderAutocompleteExtensionPoint;
 exports.scaffolderTaskBrokerExtensionPoint = scaffolderTaskBrokerExtensionPoint;
 exports.scaffolderTemplatingExtensionPoint = scaffolderTemplatingExtensionPoint;

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha/index.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  TaskBroker,\n  TemplateAction,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport { CreatedTemplateFilter } from './filters';\nimport { CreatedTemplateGlobal } from './globals';\n\nexport * from '../tasks/alpha';\nexport * from './filters';\nexport * from './globals';\nexport * from './types';\nexport * from './checkpoints';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any, any, any>[]): void;\n}\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport const scaffolderActionsExtensionPoint =\n  createExtensionPoint<ScaffolderActionsExtensionPoint>({\n    id: 'scaffolder.actions',\n  });\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport interface ScaffolderTaskBrokerExtensionPoint {\n  setTaskBroker(taskBroker: TaskBroker): void;\n}\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport const scaffolderTaskBrokerExtensionPoint =\n  createExtensionPoint<ScaffolderTaskBrokerExtensionPoint>({\n    id: 'scaffolder.taskBroker',\n  });\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport interface ScaffolderTemplatingExtensionPoint {\n  addTemplateFilters(\n    filters: Record<string, TemplateFilter> | CreatedTemplateFilter<any, any>[],\n  ): void;\n\n  addTemplateGlobals(\n    globals: Record<string, TemplateGlobal> | CreatedTemplateGlobal[],\n  ): void;\n}\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport const scaffolderTemplatingExtensionPoint =\n  createExtensionPoint<ScaffolderTemplatingExtensionPoint>({\n    id: 'scaffolder.templating',\n  });\n\n/**\n * Autocomplete handler for the scaffolder.\n * @alpha\n */\nexport type AutocompleteHandler = ({\n  resource,\n  token,\n  context,\n}: {\n  resource: string;\n  token: string;\n  context: Record<string, string>;\n}) => Promise<{ results: { title?: string; id: string }[] }>;\n\n/**\n * Extension point for adding autocomplete handler providers\n * @alpha\n */\nexport interface ScaffolderAutocompleteExtensionPoint {\n  addAutocompleteProvider({\n    id,\n    handler,\n  }: {\n    id: string;\n    handler: AutocompleteHandler;\n  }): void;\n}\n\n/**\n * Extension point for adding autocomplete handlers.\n *\n * @alpha\n */\nexport const scaffolderAutocompleteExtensionPoint =\n  createExtensionPoint<ScaffolderAutocompleteExtensionPoint>({\n    id: 'scaffolder.autocomplete',\n  });\n\n/**\n * This provider has to be implemented to make it possible to serialize/deserialize scaffolder workspace.\n *\n * @alpha\n */\nexport interface WorkspaceProvider {\n  serializeWorkspace({\n    path,\n    taskId,\n  }: {\n    path: string;\n    taskId: string;\n  }): Promise<void>;\n\n  cleanWorkspace(options: { taskId: string }): Promise<void>;\n\n  rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void>;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport interface ScaffolderWorkspaceProviderExtensionPoint {\n  addProviders(providers: Record<string, WorkspaceProvider>): void;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport const scaffolderWorkspaceProviderExtensionPoint =\n  createExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>({\n    id: 'scaffolder.workspace.provider',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;;AA8CO,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAA,CAAgE;AAAA,EAC9D,EAAA,EAAI;AACN,CAAC;;;;;;;;;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha/index.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  TaskBroker,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport { CreatedTemplateFilter } from './filters';\nimport { CreatedTemplateGlobal } from './globals';\n\nexport * from '../tasks/alpha';\nexport * from './filters';\nexport * from './globals';\nexport * from './types';\nexport * from './checkpoints';\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\n */\nexport interface ScaffolderTaskBrokerExtensionPoint {\n  setTaskBroker(taskBroker: TaskBroker): void;\n}\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\n */\nexport const scaffolderTaskBrokerExtensionPoint =\n  createExtensionPoint<ScaffolderTaskBrokerExtensionPoint>({\n    id: 'scaffolder.taskBroker',\n  });\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport interface ScaffolderTemplatingExtensionPoint {\n  addTemplateFilters(\n    filters: Record<string, TemplateFilter> | CreatedTemplateFilter<any, any>[],\n  ): void;\n\n  addTemplateGlobals(\n    globals: Record<string, TemplateGlobal> | CreatedTemplateGlobal[],\n  ): void;\n}\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport const scaffolderTemplatingExtensionPoint =\n  createExtensionPoint<ScaffolderTemplatingExtensionPoint>({\n    id: 'scaffolder.templating',\n  });\n\n/**\n * Autocomplete handler for the scaffolder.\n * @alpha\n */\nexport type AutocompleteHandler = ({\n  resource,\n  token,\n  context,\n}: {\n  resource: string;\n  token: string;\n  context: Record<string, string>;\n}) => Promise<{ results: { title?: string; id: string }[] }>;\n\n/**\n * Extension point for adding autocomplete handler providers\n * @alpha\n */\nexport interface ScaffolderAutocompleteExtensionPoint {\n  addAutocompleteProvider({\n    id,\n    handler,\n  }: {\n    id: string;\n    handler: AutocompleteHandler;\n  }): void;\n}\n\n/**\n * Extension point for adding autocomplete handlers.\n *\n * @alpha\n */\nexport const scaffolderAutocompleteExtensionPoint =\n  createExtensionPoint<ScaffolderAutocompleteExtensionPoint>({\n    id: 'scaffolder.autocomplete',\n  });\n\n/**\n * This provider has to be implemented to make it possible to serialize/deserialize scaffolder workspace.\n *\n * @alpha\n */\nexport interface WorkspaceProvider {\n  serializeWorkspace({\n    path,\n    taskId,\n  }: {\n    path: string;\n    taskId: string;\n  }): Promise<void>;\n\n  cleanWorkspace(options: { taskId: string }): Promise<void>;\n\n  rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void>;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport interface ScaffolderWorkspaceProviderExtensionPoint {\n  addProviders(providers: Record<string, WorkspaceProvider>): void;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport const scaffolderWorkspaceProviderExtensionPoint =\n  createExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>({\n    id: 'scaffolder.workspace.provider',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;;AA+CO,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAA,CAAgE;AAAA,EAC9D,EAAA,EAAI;AACN,CAAC;;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,5 +1,5 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { TemplateAction, TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-node';
+import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-node';
 import { z } from 'zod';
 import { JsonValue } from '@backstage/types';
 export { T as TemplateFilter, a as TemplateGlobal } from './types/types.d-C0fXdKnD.js';
@@ -151,24 +151,11 @@ type CheckpointContext<T extends JsonValue | void = JsonValue> = {
     fn: () => Promise<T> | T;
 };
 
-/**
- * Extension point for managing scaffolder actions.
- *
- * @alpha
- */
-interface ScaffolderActionsExtensionPoint {
-    addActions(...actions: TemplateAction<any, any, any>[]): void;
-}
-/**
- * Extension point for managing scaffolder actions.
- *
- * @alpha
- */
-declare const scaffolderActionsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderActionsExtensionPoint>;
 /**
  * Extension point for replacing the scaffolder task broker.
  *
  * @alpha
+ * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.
  */
 interface ScaffolderTaskBrokerExtensionPoint {
     setTaskBroker(taskBroker: TaskBroker): void;
@@ -177,6 +164,7 @@ interface ScaffolderTaskBrokerExtensionPoint {
  * Extension point for replacing the scaffolder task broker.
  *
  * @alpha
+ * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.
  */
 declare const scaffolderTaskBrokerExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderTaskBrokerExtensionPoint>;
 /**
@@ -257,4 +245,4 @@ interface ScaffolderWorkspaceProviderExtensionPoint {
  */
 declare const scaffolderWorkspaceProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>;
 
-export { type AutocompleteHandler, type CheckpointContext, type CheckpointState, type CheckpointStateValue, type CheckpointStatus, type CreatedTemplateFilter, type CreatedTemplateGlobal, type CreatedTemplateGlobalFunction, type CreatedTemplateGlobalValue, type ScaffolderActionsExtensionPoint, type ScaffolderAutocompleteExtensionPoint, type ScaffolderTaskBrokerExtensionPoint, type ScaffolderTemplatingExtensionPoint, type ScaffolderWorkspaceProviderExtensionPoint, type TemplateFilterExample, type TemplateGlobalFunctionExample, type UpdateTaskCheckpointOptions, type WorkspaceProvider, type ZodFunctionSchema, createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderActionsExtensionPoint, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };
+export { type AutocompleteHandler, type CheckpointContext, type CheckpointState, type CheckpointStateValue, type CheckpointStatus, type CreatedTemplateFilter, type CreatedTemplateGlobal, type CreatedTemplateGlobalFunction, type CreatedTemplateGlobalValue, type ScaffolderAutocompleteExtensionPoint, type ScaffolderTaskBrokerExtensionPoint, type ScaffolderTemplatingExtensionPoint, type ScaffolderWorkspaceProviderExtensionPoint, type TemplateFilterExample, type TemplateGlobalFunctionExample, type UpdateTaskCheckpointOptions, type WorkspaceProvider, type ZodFunctionSchema, createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };

package/dist/extensions.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const scaffolderActionsExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "scaffolder.actions"
+});
+
+exports.scaffolderActionsExtensionPoint = scaffolderActionsExtensionPoint;
+//# sourceMappingURL=extensions.cjs.js.map

package/dist/extensions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { TemplateAction } from './actions';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @public\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any, any, any>[]): void;\n}\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @public\n */\nexport const scaffolderActionsExtensionPoint =\n  createExtensionPoint<ScaffolderActionsExtensionPoint>({\n    id: 'scaffolder.actions',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AAgCO,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;;;;"}

package/dist/index.cjs.js

@@ -7,6 +7,7 @@ var gitHelpers = require('./actions/gitHelpers.cjs.js');
 var util = require('./actions/util.cjs.js');
 var serializeDirectoryContents = require('./files/serializeDirectoryContents.cjs.js');
 var deserializeDirectoryContents = require('./files/deserializeDirectoryContents.cjs.js');
+var extensions = require('./extensions.cjs.js');
 
 
 
@@ -25,4 +26,5 @@ exports.isNotGitDirectoryOrContents = util.isNotGitDirectoryOrContents;
 exports.parseRepoUrl = util.parseRepoUrl;
 exports.serializeDirectoryContents = serializeDirectoryContents.serializeDirectoryContents;
 exports.deserializeDirectoryContents = deserializeDirectoryContents.deserializeDirectoryContents;
+exports.scaffolderActionsExtensionPoint = extensions.scaffolderActionsExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { JsonObject, Observable, JsonValue, Expand } from '@backstage/types';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackstageCredentials, LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';
 import { PermissionCriteria } from '@backstage/plugin-permission-common';
 import { TaskSpec, TemplateInfo } from '@backstage/plugin-scaffolder-common';
@@ -23,18 +24,24 @@ type TaskSecrets = Record<string, string> & {
  * The status of each step of the Task
  *
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type TaskStatus = 'cancelled' | 'completed' | 'failed' | 'open' | 'processing' | 'skipped';
 /**
  * The state of a completed task.
  *
  * @public
+ * @deprecated this interface is planned to be removed.
+ * Please reach out to us in an issue if you're using this interface and your use cases.
  */
 type TaskCompletionState = 'failed' | 'completed';
 /**
  * SerializedTask
  *
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type SerializedTask = {
     id: string;
@@ -50,12 +57,16 @@ type SerializedTask = {
  * TaskEventType
  *
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type TaskEventType = 'completion' | 'log' | 'cancelled' | 'recovered';
 /**
  * SerializedTaskEvent
  *
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type SerializedTaskEvent = {
     id: number;
@@ -73,6 +84,8 @@ type SerializedTaskEvent = {
  * The result of {@link TaskBroker.dispatch}
  *
  * @public
+ * @deprecated this interface is planned to be removed.
+ * Please reach out to us in an issue if you're using this interface and your use cases.
  */
 type TaskBrokerDispatchResult = {
     taskId: string;
@@ -82,6 +95,8 @@ type TaskBrokerDispatchResult = {
  * Currently a spec and optional secrets
  *
  * @public
+ * @deprecated this interface is planned to be removed.
+ * Please reach out to us in an issue if you're using this interface and your use cases.
  */
 type TaskBrokerDispatchOptions = {
     spec: TaskSpec;
@@ -91,6 +106,8 @@ type TaskBrokerDispatchOptions = {
 /**
  * TaskFilter
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type TaskFilter = {
     key: string;
@@ -99,6 +116,8 @@ type TaskFilter = {
 /**
  * TaskFilters
  * @public
+ * @deprecated this type is planned to be removed.
+ * Please reach out to us in an issue if you're using this type and your use cases.
  */
 type TaskFilters = {
     anyOf: TaskFilter[];
@@ -108,9 +127,12 @@ type TaskFilters = {
     not: TaskFilter;
 } | TaskFilter;
 /**
- * Task
+ * TaskContext
  *
  * @public
+ *
+ * @deprecated this interface is planned to be removed.
+ * Please reach out to us in an issue if you're using this interface and your use cases.
  */
 interface TaskContext {
     taskId?: string;
@@ -141,15 +163,17 @@ interface TaskContext {
  * TaskBroker
  *
  * @public
+ * @deprecated this interface is planned to be removed.
+ * Please reach out to us in an issue if you're using this interface and your use cases.
  */
 interface TaskBroker {
-    cancel?(taskId: string): Promise<void>;
-    retry?(options: {
+    cancel(taskId: string): Promise<void>;
+    retry(options: {
         secrets?: TaskSecrets;
         taskId: string;
     }): Promise<void>;
     claim(): Promise<TaskContext>;
-    recoverTasks?(): Promise<void>;
+    recoverTasks(): Promise<void>;
     dispatch(options: TaskBrokerDispatchOptions): Promise<TaskBrokerDispatchResult>;
     vacuumTasks(options: {
         timeoutS: number;
@@ -161,7 +185,7 @@ interface TaskBroker {
         events: SerializedTaskEvent[];
     }>;
     get(taskId: string): Promise<SerializedTask>;
-    list?(options?: {
+    list(options?: {
         filters?: {
             createdBy?: string | string[];
             status?: TaskStatus | TaskStatus[];
@@ -179,16 +203,6 @@ interface TaskBroker {
         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;
-    }>;
 }
 
 /**
@@ -557,4 +571,19 @@ declare function serializeDirectoryContents(sourcePath: string, options?: {
  */
 declare function deserializeDirectoryContents(targetPath: string, files: SerializedFile[]): Promise<void>;
 
-export { type ActionContext, type ExecuteShellCommandOptions, type SerializedFile, type SerializedTask, type SerializedTaskEvent, type TaskBroker, type TaskBrokerDispatchOptions, type TaskBrokerDispatchResult, type TaskCompletionState, type TaskContext, type TaskEventType, type TaskFilter, type TaskFilters, type TaskSecrets, type TaskStatus, type TemplateAction, type TemplateActionOptions, type TemplateExample, addFiles, cloneRepo, commitAndPushBranch, commitAndPushRepo, createBranch, createTemplateAction, deserializeDirectoryContents, executeShellCommand, fetchContents, fetchFile, getRepoSourceDirectory, initRepoAndPush, isNotGitDirectoryOrContents, parseRepoUrl, serializeDirectoryContents };
+/**
+ * Extension point for managing scaffolder actions.
+ *
+ * @public
+ */
+interface ScaffolderActionsExtensionPoint {
+    addActions(...actions: TemplateAction<any, any, any>[]): void;
+}
+/**
+ * Extension point for managing scaffolder actions.
+ *
+ * @public
+ */
+declare const scaffolderActionsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderActionsExtensionPoint>;
+
+export { type ActionContext, type ExecuteShellCommandOptions, type ScaffolderActionsExtensionPoint, type SerializedFile, type SerializedTask, type SerializedTaskEvent, type TaskBroker, type TaskBrokerDispatchOptions, type TaskBrokerDispatchResult, type TaskCompletionState, type TaskContext, type TaskEventType, type TaskFilter, type TaskFilters, type TaskSecrets, type TaskStatus, type TemplateAction, type TemplateActionOptions, type TemplateExample, addFiles, cloneRepo, commitAndPushBranch, commitAndPushRepo, createBranch, createTemplateAction, deserializeDirectoryContents, executeShellCommand, fetchContents, fetchFile, getRepoSourceDirectory, initRepoAndPush, isNotGitDirectoryOrContents, parseRepoUrl, scaffolderActionsExtensionPoint, serializeDirectoryContents };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.11.1",
+  "version": "0.12.0-next.1",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -62,13 +62,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.4.3",
-    "@backstage/catalog-model": "^1.7.5",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/integration": "^1.18.0",
-    "@backstage/plugin-permission-common": "^0.9.1",
-    "@backstage/plugin-scaffolder-common": "^1.7.1",
-    "@backstage/types": "^1.2.2",
+    "@backstage/backend-plugin-api": "1.4.4-next.0",
+    "@backstage/catalog-model": "1.7.5",
+    "@backstage/errors": "1.2.7",
+    "@backstage/integration": "1.18.1-next.1",
+    "@backstage/plugin-permission-common": "0.9.2-next.0",
+    "@backstage/plugin-scaffolder-common": "1.7.2-next.1",
+    "@backstage/types": "1.2.2",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
@@ -84,9 +84,9 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.9.0",
-    "@backstage/cli": "^0.34.2",
-    "@backstage/config": "^1.3.3",
+    "@backstage/backend-test-utils": "1.9.1-next.1",
+    "@backstage/cli": "0.34.4-next.1",
+    "@backstage/config": "1.3.4-next.0",
     "@types/lodash": "^4.14.151"
   }
 }