@backstage/plugin-scaffolder-backend 0.15.21 → 0.15.23

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export { TaskSpec, TaskSpecV1beta2, TaskSpecV1beta3, TemplateMetadata } from '@b
 import { UrlReader, ContainerRunner, PluginDatabaseManager } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
 import { createPullRequest } from 'octokit-plugin-create-pull-request';
-import { Octokit } from '@octokit/rest';
+import { Octokit } from 'octokit';
 export { createFetchCookiecutterAction } from '@backstage/plugin-scaffolder-backend-module-cookiecutter';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import { Knex } from 'knex';
@@ -26,12 +26,31 @@ declare function createCatalogRegisterAction(options: {
 
 declare function createCatalogWriteAction(): TemplateAction<any>;
 
+/**
+ * A catalog client tailored for reading out entity data from the catalog.
+ */
+declare class CatalogEntityClient {
+    private readonly catalogClient;
+    constructor(catalogClient: CatalogApi);
+    /**
+     * Looks up a single template using a template name.
+     *
+     * Throws a NotFoundError or ConflictError if 0 or multiple templates are found.
+     */
+    findTemplate(templateName: string, options?: {
+        token?: string;
+    }): Promise<TemplateEntityV1beta2>;
+}
+
+declare type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
+
 declare const createBuiltinActions: (options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
     catalogClient: CatalogApi;
     containerRunner?: ContainerRunner;
     config: Config;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
 }) => TemplateAction<any>[];
 
 /**
@@ -48,6 +67,7 @@ declare function createFetchPlainAction(options: {
 declare function createFetchTemplateAction(options: {
     reader: UrlReader;
     integrations: ScmIntegrations;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
 }): TemplateAction<any>;
 
 declare function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
@@ -101,6 +121,7 @@ declare type ClientFactoryInput = {
     host: string;
     owner: string;
     repo: string;
+    token?: string;
 };
 interface CreateGithubPullRequestActionOptions {
     integrations: ScmIntegrationRegistry;
@@ -148,7 +169,9 @@ declare class OctokitProvider {
      *
      * @param repoUrl - Repository URL
      */
-    getOctokit(repoUrl: string): Promise<OctokitIntegration>;
+    getOctokit(repoUrl: string, options?: {
+        token?: string;
+    }): Promise<OctokitIntegration>;
 }
 
 declare type RunCommandOptions = {
@@ -441,6 +464,7 @@ declare type CreateWorkerOptions = {
     integrations: ScmIntegrations;
     workingDirectory: string;
     logger: Logger;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
 };
 /**
  * TaskWorker
@@ -470,25 +494,10 @@ interface RouterOptions {
     taskWorkers?: number;
     containerRunner?: ContainerRunner;
     taskBroker?: TaskBroker;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
-/**
- * A catalog client tailored for reading out entity data from the catalog.
- */
-declare class CatalogEntityClient {
-    private readonly catalogClient;
-    constructor(catalogClient: CatalogApi);
-    /**
-     * Looks up a single template using a template name.
-     *
-     * Throws a NotFoundError or ConflictError if 0 or multiple templates are found.
-     */
-    findTemplate(templateName: string, options?: {
-        token?: string;
-    }): Promise<TemplateEntityV1beta2>;
-}
-
 /** @public */
 declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     private readonly validators;
@@ -496,4 +505,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, fetchContents, runCommand };
+export { ActionContext, CatalogEntityClient, CompletedTaskState, CreateWorkerOptions, DatabaseTaskStore, DispatchResult, OctokitProvider, RouterOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, Status, TaskBroker, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskState, TaskStore, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, fetchContents, runCommand };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.15.21",
+  "version": "0.15.23",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -31,19 +31,18 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.4",
+    "@backstage/backend-common": "^0.10.6",
     "@backstage/catalog-client": "^0.5.5",
     "@backstage/catalog-model": "^0.9.10",
     "@backstage/config": "^0.1.13",
     "@backstage/errors": "^0.2.0",
     "@backstage/integration": "^0.7.2",
-    "@backstage/plugin-catalog-backend": "^0.21.0",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.9",
+    "@backstage/plugin-catalog-backend": "^0.21.2",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.10",
     "@backstage/plugin-scaffolder-common": "^0.1.3",
     "@backstage/types": "^0.1.1",
     "@gitbeaker/core": "^34.6.0",
-    "@gitbeaker/node": "^34.6.0",
-    "@octokit/rest": "^18.5.3",
+    "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^9.14.1",
     "@types/express": "^4.17.6",
     "azure-devops-node-api": "^11.0.1",
@@ -66,6 +65,7 @@
     "morgan": "^1.10.0",
     "node-fetch": "^2.6.1",
     "nunjucks": "^3.2.3",
+    "octokit": "^1.7.1",
     "octokit-plugin-create-pull-request": "^3.10.0",
     "uuid": "^8.2.0",
     "vm2": "^3.9.5",
@@ -73,8 +73,8 @@
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.12.0",
-    "@backstage/test-utils": "^0.2.3",
+    "@backstage/cli": "^0.13.1",
+    "@backstage/test-utils": "^0.2.4",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -95,5 +95,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "600d6e3c854bbfb12a0078ca6f726d1c0d1fea0b"
+  "gitHead": "f944a625c4a8ec7f6a6237502691da9209ce6b14"
 }