@backstage/plugin-scaffolder-backend 0.15.19 → 0.15.22

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ScmIntegrations, ScmIntegrationRegistry } from '@backstage/integration';
+import { ScmIntegrations, ScmIntegrationRegistry, GithubCredentialsProvider } from '@backstage/integration';
 import { CatalogApi } from '@backstage/catalog-client';
 import { Logger } from 'winston';
 import { Writable } from 'stream';
@@ -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, }: {
@@ -84,6 +104,7 @@ declare function createPublishFileAction(): TemplateAction<any>;
 declare function createPublishGithubAction(options: {
     integrations: ScmIntegrationRegistry;
     config: Config;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare type CreatePullRequestResponse = {
@@ -96,15 +117,17 @@ interface PullRequestCreator {
 }
 declare type ClientFactoryInput = {
     integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
     host: string;
     owner: string;
     repo: string;
 };
 interface CreateGithubPullRequestActionOptions {
     integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
     clientFactory?: (input: ClientFactoryInput) => Promise<PullRequestCreator>;
 }
-declare const createPublishGithubPullRequestAction: ({ integrations, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
+declare const createPublishGithubPullRequestAction: ({ integrations, githubCredentialsProvider, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
 
 declare function createPublishGitlabAction(options: {
     integrations: ScmIntegrationRegistry;
@@ -116,12 +139,14 @@ declare const createPublishGitlabMergeRequestAction: (options: {
 }) => TemplateAction<any>;
 
 declare function createGithubActionsDispatchAction(options: {
-    integrations: ScmIntegrationRegistry;
+    integrations: ScmIntegrations;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare function createGithubWebhookAction(options: {
     integrations: ScmIntegrationRegistry;
     defaultWebhookSecret?: string;
+    githubCredentialsProvider?: GithubCredentialsProvider;
 }): TemplateAction<any>;
 
 declare type OctokitIntegration = {
@@ -136,12 +161,12 @@ declare type OctokitIntegration = {
  */
 declare class OctokitProvider {
     private readonly integrations;
-    private readonly credentialsProviders;
-    constructor(integrations: ScmIntegrationRegistry);
+    private readonly githubCredentialsProvider;
+    constructor(integrations: ScmIntegrationRegistry, githubCredentialsProvider?: GithubCredentialsProvider);
     /**
      * gets standard Octokit client based on repository URL.
      *
-     * @param repoUrl Repository URL
+     * @param repoUrl - Repository URL
      */
     getOctokit(repoUrl: string): Promise<OctokitIntegration>;
 }
@@ -209,8 +234,10 @@ declare type SerializedTaskEvent = {
  *
  * @public
  */
-declare type TaskSecrets = {
-    token: string | undefined;
+declare type TaskSecrets = Record<string, string> & {
+    /** @deprecated Use `backstageToken` instead */
+    token?: string;
+    backstageToken?: string;
 };
 /**
  * DispatchResult
@@ -316,8 +343,10 @@ declare type ActionContext<Input extends InputBase> = {
     logStream: Writable;
     /**
      * User token forwarded from initial request, for use in subsequent api requests
+     * @deprecated use `secrets.backstageToken` instead
      */
     token?: string | undefined;
+    secrets?: TaskSecrets;
     workspacePath: string;
     input: Input;
     output(name: string, value: JsonValue): void;
@@ -432,6 +461,7 @@ declare type CreateWorkerOptions = {
     integrations: ScmIntegrations;
     workingDirectory: string;
     logger: Logger;
+    additionalTemplateFilters?: Record<string, TemplateFilter>;
 };
 /**
  * TaskWorker
@@ -461,25 +491,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;
@@ -487,4 +502,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.19",
+  "version": "0.15.22",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -31,18 +31,18 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.10.1",
-    "@backstage/catalog-client": "^0.5.3",
-    "@backstage/catalog-model": "^0.9.8",
-    "@backstage/config": "^0.1.11",
-    "@backstage/errors": "^0.1.5",
-    "@backstage/integration": "^0.7.0",
-    "@backstage/plugin-catalog-backend": "^0.19.4",
-    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.7",
-    "@backstage/plugin-scaffolder-common": "^0.1.2",
+    "@backstage/backend-common": "^0.10.5",
+    "@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.1",
+    "@backstage/plugin-scaffolder-backend-module-cookiecutter": "^0.1.9",
+    "@backstage/plugin-scaffolder-common": "^0.1.3",
     "@backstage/types": "^0.1.1",
     "@gitbeaker/core": "^34.6.0",
-    "@gitbeaker/node": "^34.6.0",
+    "@gitbeaker/node": "^35.1.0",
     "@octokit/rest": "^18.5.3",
     "@octokit/webhooks": "^9.14.1",
     "@types/express": "^4.17.6",
@@ -73,8 +73,8 @@
     "yaml": "^1.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.10.4",
-    "@backstage/test-utils": "^0.2.1",
+    "@backstage/cli": "^0.13.0",
+    "@backstage/test-utils": "^0.2.3",
     "@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": "4b2a8ed96ff427735c872a72c1864321ef698436"
+  "gitHead": "493394603a2c47ea1d141159af9bc7bb84fac9e5"
 }