@backstage/plugin-scaffolder-backend 1.13.0-next.1 → 1.13.0-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +1 -1
- package/dist/alpha.d.ts +2 -2
- package/dist/cjs/{ScaffolderEntitiesProcessor-9c517d79.cjs.js → ScaffolderEntitiesProcessor-b5a2b352.cjs.js} +15 -6
- package/dist/cjs/ScaffolderEntitiesProcessor-b5a2b352.cjs.js.map +1 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.d.ts +26 -27
- package/package.json +15 -15
- package/dist/cjs/ScaffolderEntitiesProcessor-9c517d79.cjs.js.map +0 -1
package/dist/index.cjs.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
|
-
var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-
|
|
5
|
+
var ScaffolderEntitiesProcessor = require('./cjs/ScaffolderEntitiesProcessor-b5a2b352.cjs.js');
|
|
6
6
|
var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
|
|
7
7
|
require('@backstage/catalog-model');
|
|
8
8
|
require('@backstage/errors');
|
package/dist/index.d.ts
CHANGED
|
@@ -49,9 +49,7 @@ declare function createCatalogRegisterAction(options: {
|
|
|
49
49
|
* @public
|
|
50
50
|
*/
|
|
51
51
|
declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
|
|
52
|
-
entity:
|
|
53
|
-
[k: string]: unknown;
|
|
54
|
-
};
|
|
52
|
+
entity: Record<string, any>;
|
|
55
53
|
filePath?: string | undefined;
|
|
56
54
|
}, _backstage_types.JsonObject>;
|
|
57
55
|
|
|
@@ -72,9 +70,9 @@ declare function createFetchCatalogEntityAction(options: {
|
|
|
72
70
|
}>;
|
|
73
71
|
|
|
74
72
|
/** @public */
|
|
75
|
-
|
|
73
|
+
type TemplateFilter = (...args: JsonValue[]) => JsonValue | undefined;
|
|
76
74
|
/** @public */
|
|
77
|
-
|
|
75
|
+
type TemplateGlobal = ((...args: JsonValue[]) => JsonValue | undefined) | JsonValue;
|
|
78
76
|
|
|
79
77
|
/**
|
|
80
78
|
* The options passed to {@link createBuiltinActions}
|
|
@@ -407,7 +405,7 @@ declare function createPublishGithubAction(options: {
|
|
|
407
405
|
}, _backstage_types.JsonObject>;
|
|
408
406
|
|
|
409
407
|
/** @public */
|
|
410
|
-
|
|
408
|
+
type OctokitWithPullRequestPluginClient = Octokit & {
|
|
411
409
|
createPullRequest(options: createPullRequest.Options): Promise<{
|
|
412
410
|
data: {
|
|
413
411
|
html_url: string;
|
|
@@ -419,7 +417,7 @@ declare type OctokitWithPullRequestPluginClient = Octokit & {
|
|
|
419
417
|
* The options passed to the client factory function.
|
|
420
418
|
* @public
|
|
421
419
|
*/
|
|
422
|
-
|
|
420
|
+
type CreateGithubPullRequestClientFactoryInput = {
|
|
423
421
|
integrations: ScmIntegrationRegistry;
|
|
424
422
|
githubCredentialsProvider?: GithubCredentialsProvider;
|
|
425
423
|
host: string;
|
|
@@ -460,6 +458,7 @@ declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRe
|
|
|
460
458
|
token?: string | undefined;
|
|
461
459
|
reviewers?: string[] | undefined;
|
|
462
460
|
teamReviewers?: string[] | undefined;
|
|
461
|
+
commitMessage?: string | undefined;
|
|
463
462
|
}, _backstage_types.JsonObject>;
|
|
464
463
|
|
|
465
464
|
/**
|
|
@@ -654,7 +653,7 @@ declare function createGithubWebhookAction(options: {
|
|
|
654
653
|
}, _backstage_types.JsonObject>;
|
|
655
654
|
|
|
656
655
|
/** @public */
|
|
657
|
-
|
|
656
|
+
type RunCommandOptions = {
|
|
658
657
|
/** command to run */
|
|
659
658
|
command: string;
|
|
660
659
|
/** arguments to pass the command */
|
|
@@ -687,19 +686,19 @@ declare class TemplateActionRegistry {
|
|
|
687
686
|
*
|
|
688
687
|
* @public
|
|
689
688
|
*/
|
|
690
|
-
|
|
689
|
+
type TaskStatus = 'cancelled' | 'completed' | 'failed' | 'open' | 'processing';
|
|
691
690
|
/**
|
|
692
691
|
* The state of a completed task.
|
|
693
692
|
*
|
|
694
693
|
* @public
|
|
695
694
|
*/
|
|
696
|
-
|
|
695
|
+
type TaskCompletionState = 'failed' | 'completed';
|
|
697
696
|
/**
|
|
698
697
|
* SerializedTask
|
|
699
698
|
*
|
|
700
699
|
* @public
|
|
701
700
|
*/
|
|
702
|
-
|
|
701
|
+
type SerializedTask = {
|
|
703
702
|
id: string;
|
|
704
703
|
spec: TaskSpec;
|
|
705
704
|
status: TaskStatus;
|
|
@@ -713,13 +712,13 @@ declare type SerializedTask = {
|
|
|
713
712
|
*
|
|
714
713
|
* @public
|
|
715
714
|
*/
|
|
716
|
-
|
|
715
|
+
type TaskEventType = 'completion' | 'log' | 'cancelled';
|
|
717
716
|
/**
|
|
718
717
|
* SerializedTaskEvent
|
|
719
718
|
*
|
|
720
719
|
* @public
|
|
721
720
|
*/
|
|
722
|
-
|
|
721
|
+
type SerializedTaskEvent = {
|
|
723
722
|
id: number;
|
|
724
723
|
taskId: string;
|
|
725
724
|
body: JsonObject;
|
|
@@ -731,7 +730,7 @@ declare type SerializedTaskEvent = {
|
|
|
731
730
|
*
|
|
732
731
|
* @public
|
|
733
732
|
*/
|
|
734
|
-
|
|
733
|
+
type TaskBrokerDispatchResult = {
|
|
735
734
|
taskId: string;
|
|
736
735
|
};
|
|
737
736
|
/**
|
|
@@ -740,7 +739,7 @@ declare type TaskBrokerDispatchResult = {
|
|
|
740
739
|
*
|
|
741
740
|
* @public
|
|
742
741
|
*/
|
|
743
|
-
|
|
742
|
+
type TaskBrokerDispatchOptions = {
|
|
744
743
|
spec: TaskSpec;
|
|
745
744
|
secrets?: TaskSecrets$1;
|
|
746
745
|
createdBy?: string;
|
|
@@ -791,7 +790,7 @@ interface TaskBroker {
|
|
|
791
790
|
*
|
|
792
791
|
* @public
|
|
793
792
|
*/
|
|
794
|
-
|
|
793
|
+
type TaskStoreEmitOptions<TBody = JsonObject> = {
|
|
795
794
|
taskId: string;
|
|
796
795
|
body: TBody;
|
|
797
796
|
};
|
|
@@ -800,7 +799,7 @@ declare type TaskStoreEmitOptions<TBody = JsonObject> = {
|
|
|
800
799
|
*
|
|
801
800
|
* @public
|
|
802
801
|
*/
|
|
803
|
-
|
|
802
|
+
type TaskStoreListEventsOptions = {
|
|
804
803
|
taskId: string;
|
|
805
804
|
after?: number | undefined;
|
|
806
805
|
};
|
|
@@ -809,14 +808,14 @@ declare type TaskStoreListEventsOptions = {
|
|
|
809
808
|
*
|
|
810
809
|
* @public
|
|
811
810
|
*/
|
|
812
|
-
|
|
811
|
+
type TaskStoreShutDownTaskOptions = {
|
|
813
812
|
taskId: string;
|
|
814
813
|
};
|
|
815
814
|
/**
|
|
816
815
|
* The options passed to {@link TaskStore.createTask}
|
|
817
816
|
* @public
|
|
818
817
|
*/
|
|
819
|
-
|
|
818
|
+
type TaskStoreCreateTaskOptions = {
|
|
820
819
|
spec: TaskSpec;
|
|
821
820
|
createdBy?: string;
|
|
822
821
|
secrets?: TaskSecrets$1;
|
|
@@ -825,7 +824,7 @@ declare type TaskStoreCreateTaskOptions = {
|
|
|
825
824
|
* The response from {@link TaskStore.createTask}
|
|
826
825
|
* @public
|
|
827
826
|
*/
|
|
828
|
-
|
|
827
|
+
type TaskStoreCreateTaskResult = {
|
|
829
828
|
taskId: string;
|
|
830
829
|
};
|
|
831
830
|
/**
|
|
@@ -868,7 +867,7 @@ interface TaskStore {
|
|
|
868
867
|
*
|
|
869
868
|
* @public
|
|
870
869
|
*/
|
|
871
|
-
|
|
870
|
+
type DatabaseTaskStoreOptions = {
|
|
872
871
|
database: PluginDatabaseManager | Knex;
|
|
873
872
|
};
|
|
874
873
|
/**
|
|
@@ -968,7 +967,7 @@ interface CurrentClaimedTask {
|
|
|
968
967
|
*
|
|
969
968
|
* @public
|
|
970
969
|
*/
|
|
971
|
-
|
|
970
|
+
type CreateWorkerOptions = {
|
|
972
971
|
taskBroker: TaskBroker;
|
|
973
972
|
actionRegistry: TemplateActionRegistry;
|
|
974
973
|
integrations: ScmIntegrations;
|
|
@@ -1009,7 +1008,7 @@ declare class TaskWorker {
|
|
|
1009
1008
|
*
|
|
1010
1009
|
* @public
|
|
1011
1010
|
*/
|
|
1012
|
-
|
|
1011
|
+
type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, TParams>;
|
|
1013
1012
|
/**
|
|
1014
1013
|
* RouterOptions
|
|
1015
1014
|
*
|
|
@@ -1058,21 +1057,21 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
|
|
|
1058
1057
|
* @public
|
|
1059
1058
|
* @deprecated Import from {@link @backstage/plugin-scaffolder-node#ActionContext} instead
|
|
1060
1059
|
*/
|
|
1061
|
-
|
|
1060
|
+
type ActionContext<TInput extends JsonObject> = ActionContext$1<TInput>;
|
|
1062
1061
|
/**
|
|
1063
1062
|
* @public
|
|
1064
1063
|
* @deprecated Use `createTemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
|
1065
1064
|
*/
|
|
1066
|
-
declare const createTemplateAction: <TInputParams extends JsonObject = JsonObject, TOutputParams extends JsonObject = JsonObject, TInputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TOutputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TActionInput = TInputSchema extends zod.ZodType<any, any, infer IReturn> ? IReturn : TInputParams, TActionOutput = TOutputSchema extends zod.ZodType<any, any, infer IReturn_1> ? IReturn_1 : TOutputParams>(action: _backstage_plugin_scaffolder_node.TemplateActionOptions<TActionInput, TActionOutput, TInputSchema, TOutputSchema>) => TemplateAction$1<TActionInput, TActionOutput>;
|
|
1065
|
+
declare const createTemplateAction: <TInputParams extends JsonObject = JsonObject, TOutputParams extends JsonObject = JsonObject, TInputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TOutputSchema extends zod.ZodType<any, zod.ZodTypeDef, any> | jsonschema.Schema = {}, TActionInput extends JsonObject = TInputSchema extends zod.ZodType<any, any, infer IReturn> ? IReturn : TInputParams, TActionOutput extends JsonObject = TOutputSchema extends zod.ZodType<any, any, infer IReturn_1> ? IReturn_1 : TOutputParams>(action: _backstage_plugin_scaffolder_node.TemplateActionOptions<TActionInput, TActionOutput, TInputSchema, TOutputSchema>) => TemplateAction$1<TActionInput, TActionOutput>;
|
|
1067
1066
|
/**
|
|
1068
1067
|
* @public
|
|
1069
1068
|
* @deprecated Use `TaskSecrets` from `@backstage/plugin-scaffolder-node` instead
|
|
1070
1069
|
*/
|
|
1071
|
-
|
|
1070
|
+
type TaskSecrets = TaskSecrets$1;
|
|
1072
1071
|
/**
|
|
1073
1072
|
* @public
|
|
1074
1073
|
* @deprecated Use `TemplateAction` from `@backstage/plugin-scaffolder-node` instead
|
|
1075
1074
|
*/
|
|
1076
|
-
|
|
1075
|
+
type TemplateAction<TInput extends JsonObject> = TemplateAction$1<TInput>;
|
|
1077
1076
|
|
|
1078
1077
|
export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskStoreShutDownTaskOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, TemplateGlobal, TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubRepoCreateAction, createGithubRepoPushAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishBitbucketCloudAction, createPublishBitbucketServerAction, createPublishGerritAction, createPublishGerritReviewAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, createWaitAction, executeShellCommand, fetchContents };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-backend",
|
|
3
3
|
"description": "The Backstage backend plugin that helps you create new things",
|
|
4
|
-
"version": "1.13.0-next.
|
|
4
|
+
"version": "1.13.0-next.3",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -44,22 +44,22 @@
|
|
|
44
44
|
"build:assets": "node scripts/build-nunjucks.js"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@backstage/backend-common": "^0.18.4-next.
|
|
48
|
-
"@backstage/backend-plugin-api": "^0.5.1-next.
|
|
49
|
-
"@backstage/backend-tasks": "^0.5.1-next.
|
|
50
|
-
"@backstage/catalog-client": "^1.4.
|
|
51
|
-
"@backstage/catalog-model": "^1.
|
|
47
|
+
"@backstage/backend-common": "^0.18.4-next.2",
|
|
48
|
+
"@backstage/backend-plugin-api": "^0.5.1-next.2",
|
|
49
|
+
"@backstage/backend-tasks": "^0.5.1-next.2",
|
|
50
|
+
"@backstage/catalog-client": "^1.4.1-next.1",
|
|
51
|
+
"@backstage/catalog-model": "^1.3.0-next.0",
|
|
52
52
|
"@backstage/config": "^1.0.7",
|
|
53
53
|
"@backstage/errors": "^1.1.5",
|
|
54
54
|
"@backstage/integration": "^1.4.4-next.0",
|
|
55
|
-
"@backstage/plugin-auth-node": "^0.2.13-next.
|
|
56
|
-
"@backstage/plugin-catalog-backend": "^1.
|
|
57
|
-
"@backstage/plugin-catalog-common": "^1.0.13-next.
|
|
58
|
-
"@backstage/plugin-catalog-node": "^1.3.5-next.
|
|
55
|
+
"@backstage/plugin-auth-node": "^0.2.13-next.2",
|
|
56
|
+
"@backstage/plugin-catalog-backend": "^1.9.0-next.3",
|
|
57
|
+
"@backstage/plugin-catalog-common": "^1.0.13-next.1",
|
|
58
|
+
"@backstage/plugin-catalog-node": "^1.3.5-next.3",
|
|
59
59
|
"@backstage/plugin-permission-common": "^0.7.5-next.0",
|
|
60
|
-
"@backstage/plugin-permission-node": "^0.7.7-next.
|
|
61
|
-
"@backstage/plugin-scaffolder-common": "^1.2.7-next.
|
|
62
|
-
"@backstage/plugin-scaffolder-node": "^0.1.2-next.
|
|
60
|
+
"@backstage/plugin-permission-node": "^0.7.7-next.2",
|
|
61
|
+
"@backstage/plugin-scaffolder-common": "^1.2.7-next.2",
|
|
62
|
+
"@backstage/plugin-scaffolder-node": "^0.1.2-next.3",
|
|
63
63
|
"@backstage/types": "^1.0.2",
|
|
64
64
|
"@gitbeaker/core": "^35.6.0",
|
|
65
65
|
"@gitbeaker/node": "^35.1.0",
|
|
@@ -97,8 +97,8 @@
|
|
|
97
97
|
"zod": "^3.21.4"
|
|
98
98
|
},
|
|
99
99
|
"devDependencies": {
|
|
100
|
-
"@backstage/backend-test-utils": "^0.1.36-next.
|
|
101
|
-
"@backstage/cli": "^0.22.6-next.
|
|
100
|
+
"@backstage/backend-test-utils": "^0.1.36-next.2",
|
|
101
|
+
"@backstage/cli": "^0.22.6-next.3",
|
|
102
102
|
"@types/command-exists": "^1.2.0",
|
|
103
103
|
"@types/fs-extra": "^9.0.1",
|
|
104
104
|
"@types/git-url-parse": "^9.0.0",
|