@backstage/plugin-scaffolder-backend-module-gitlab 0.5.1-next.0 → 0.6.0-next.2

package/dist/actions/gitlabProjectAccessTokenCreate.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var rest = require('@gitbeaker/rest');
+var luxon = require('luxon');
+var zod = require('zod');
+var util = require('../util.cjs.js');
+var gitlabProjectAccessTokenCreate_examples = require('./gitlabProjectAccessTokenCreate.examples.cjs.js');
+
+const createGitlabProjectAccessTokenAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectAccessToken:create",
+    examples: gitlabProjectAccessTokenCreate_examples.examples,
+    schema: {
+      input: zod.z.object({
+        projectId: zod.z.union([zod.z.number(), zod.z.string()], {
+          description: "Project ID/Name(slug) of the Gitlab Project"
+        }),
+        token: zod.z.string({
+          description: "The token to use for authorization to GitLab"
+        }).optional(),
+        name: zod.z.string({ description: "Name of Access Key" }).optional(),
+        repoUrl: zod.z.string({ description: "URL to gitlab instance" }),
+        accessLevel: zod.z.number({
+          description: "Access Level of the Token, 10 (Guest), 20 (Reporter), 30 (Developer), 40 (Maintainer), and 50 (Owner)"
+        }).optional(),
+        scopes: zod.z.string({
+          description: "Scopes for a project access token"
+        }).array().optional(),
+        expiresAt: zod.z.string({
+          description: "Expiration date of the access token in ISO format (YYYY-MM-DD). If Empty, it will set to the maximum of 365 days."
+        }).optional()
+      }),
+      output: zod.z.object({
+        access_token: zod.z.string({ description: "Access Token" })
+      })
+    },
+    async handler(ctx) {
+      ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+      const {
+        projectId,
+        name = "tokenname",
+        accessLevel = 40,
+        scopes = ["read_repository"],
+        expiresAt
+      } = ctx.input;
+      const { token, integrationConfig } = util.getToken(ctx.input, integrations);
+      if (!integrationConfig.config.token && token) {
+        throw new errors.InputError(
+          `No token available for host ${integrationConfig.config.baseUrl}`
+        );
+      }
+      let api;
+      if (!ctx.input.token) {
+        api = new rest.Gitlab({
+          host: integrationConfig.config.baseUrl,
+          token
+        });
+      } else {
+        api = new rest.Gitlab({
+          host: integrationConfig.config.baseUrl,
+          oauthToken: token
+        });
+      }
+      const response = await api.ProjectAccessTokens.create(
+        projectId,
+        name,
+        scopes,
+        {
+          expiresAt: expiresAt || luxon.DateTime.now().plus({ days: 365 }).toISODate(),
+          accessLevel
+        }
+      );
+      if (!response.token) {
+        throw new Error("Could not create project access token");
+      }
+      ctx.output("access_token", response.token);
+    }
+  });
+};
+
+exports.createGitlabProjectAccessTokenAction = createGitlabProjectAccessTokenAction;
+//# sourceMappingURL=gitlabProjectAccessTokenCreate.cjs.js.map

package/dist/actions/gitlabProjectAccessTokenCreate.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabProjectAccessTokenCreate.cjs.js","sources":["../../src/actions/gitlabProjectAccessTokenCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { InputError } from '@backstage/errors';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { AccessTokenScopes, Gitlab } from '@gitbeaker/rest';\nimport { DateTime } from 'luxon';\nimport { z } from 'zod';\nimport { getToken } from '../util';\nimport { examples } from './gitlabProjectAccessTokenCreate.examples';\n\n/**\n * Creates a `gitlab:projectAccessToken:create` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\n\nexport const createGitlabProjectAccessTokenAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction({\n    id: 'gitlab:projectAccessToken:create',\n    examples,\n    schema: {\n      input: z.object({\n        projectId: z.union([z.number(), z.string()], {\n          description: 'Project ID/Name(slug) of the Gitlab Project',\n        }),\n        token: z\n          .string({\n            description: 'The token to use for authorization to GitLab',\n          })\n          .optional(),\n        name: z.string({ description: 'Name of Access Key' }).optional(),\n        repoUrl: z.string({ description: 'URL to gitlab instance' }),\n        accessLevel: z\n          .number({\n            description:\n              'Access Level of the Token, 10 (Guest), 20 (Reporter), 30 (Developer), 40 (Maintainer), and 50 (Owner)',\n          })\n          .optional(),\n        scopes: z\n          .string({\n            description: 'Scopes for a project access token',\n          })\n          .array()\n          .optional(),\n        expiresAt: z\n          .string({\n            description:\n              'Expiration date of the access token in ISO format (YYYY-MM-DD). If Empty, it will set to the maximum of 365 days.',\n          })\n          .optional(),\n      }),\n      output: z.object({\n        access_token: z.string({ description: 'Access Token' }),\n      }),\n    },\n    async handler(ctx) {\n      ctx.logger.info(`Creating Token for Project \"${ctx.input.projectId}\"`);\n      const {\n        projectId,\n        name = 'tokenname',\n        accessLevel = 40,\n        scopes = ['read_repository'],\n        expiresAt,\n      } = ctx.input;\n\n      const { token, integrationConfig } = getToken(ctx.input, integrations);\n\n      if (!integrationConfig.config.token && token) {\n        throw new InputError(\n          `No token available for host ${integrationConfig.config.baseUrl}`,\n        );\n      }\n\n      let api;\n\n      if (!ctx.input.token) {\n        api = new Gitlab({\n          host: integrationConfig.config.baseUrl,\n          token: token,\n        });\n      } else {\n        api = new Gitlab({\n          host: integrationConfig.config.baseUrl,\n          oauthToken: token,\n        });\n      }\n\n      const response = await api.ProjectAccessTokens.create(\n        projectId,\n        name,\n        scopes as AccessTokenScopes[],\n        {\n          expiresAt:\n            expiresAt || DateTime.now().plus({ days: 365 }).toISODate()!,\n          accessLevel,\n        },\n      );\n\n      if (!response.token) {\n        throw new Error('Could not create project access token');\n      }\n\n      ctx.output('access_token', response.token);\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","z","getToken","InputError","Gitlab","DateTime"],"mappings":";;;;;;;;;;AAgCa,MAAA,oCAAA,GAAuC,CAAC,OAE/C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,kCAAA;AAAA,cACJC,gDAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAA,EAAOC,MAAE,MAAO,CAAA;AAAA,QACd,SAAA,EAAWA,KAAE,CAAA,KAAA,CAAM,CAACA,KAAA,CAAE,QAAU,EAAAA,KAAA,CAAE,MAAO,EAAC,CAAG,EAAA;AAAA,UAC3C,WAAa,EAAA,6CAAA;AAAA,SACd,CAAA;AAAA,QACD,KAAA,EAAOA,MACJ,MAAO,CAAA;AAAA,UACN,WAAa,EAAA,8CAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACZ,IAAA,EAAMA,MAAE,MAAO,CAAA,EAAE,aAAa,oBAAqB,EAAC,EAAE,QAAS,EAAA;AAAA,QAC/D,SAASA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,0BAA0B,CAAA;AAAA,QAC3D,WAAA,EAAaA,MACV,MAAO,CAAA;AAAA,UACN,WACE,EAAA,uGAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACZ,MAAA,EAAQA,MACL,MAAO,CAAA;AAAA,UACN,WAAa,EAAA,mCAAA;AAAA,SACd,CAAA,CACA,KAAM,EAAA,CACN,QAAS,EAAA;AAAA,QACZ,SAAA,EAAWA,MACR,MAAO,CAAA;AAAA,UACN,WACE,EAAA,mHAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,OACb,CAAA;AAAA,MACD,MAAA,EAAQA,MAAE,MAAO,CAAA;AAAA,QACf,cAAcA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,gBAAgB,CAAA;AAAA,OACvD,CAAA;AAAA,KACH;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,4BAAA,EAA+B,GAAI,CAAA,KAAA,CAAM,SAAS,CAAG,CAAA,CAAA,CAAA,CAAA;AACrE,MAAM,MAAA;AAAA,QACJ,SAAA;AAAA,QACA,IAAO,GAAA,WAAA;AAAA,QACP,WAAc,GAAA,EAAA;AAAA,QACd,MAAA,GAAS,CAAC,iBAAiB,CAAA;AAAA,QAC3B,SAAA;AAAA,UACE,GAAI,CAAA,KAAA,CAAA;AAER,MAAA,MAAM,EAAE,KAAO,EAAA,iBAAA,KAAsBC,aAAS,CAAA,GAAA,CAAI,OAAO,YAAY,CAAA,CAAA;AAErE,MAAA,IAAI,CAAC,iBAAA,CAAkB,MAAO,CAAA,KAAA,IAAS,KAAO,EAAA;AAC5C,QAAA,MAAM,IAAIC,iBAAA;AAAA,UACR,CAAA,4BAAA,EAA+B,iBAAkB,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAAA,SACjE,CAAA;AAAA,OACF;AAEA,MAAI,IAAA,GAAA,CAAA;AAEJ,MAAI,IAAA,CAAC,GAAI,CAAA,KAAA,CAAM,KAAO,EAAA;AACpB,QAAA,GAAA,GAAM,IAAIC,WAAO,CAAA;AAAA,UACf,IAAA,EAAM,kBAAkB,MAAO,CAAA,OAAA;AAAA,UAC/B,KAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACI,MAAA;AACL,QAAA,GAAA,GAAM,IAAIA,WAAO,CAAA;AAAA,UACf,IAAA,EAAM,kBAAkB,MAAO,CAAA,OAAA;AAAA,UAC/B,UAAY,EAAA,KAAA;AAAA,SACb,CAAA,CAAA;AAAA,OACH;AAEA,MAAM,MAAA,QAAA,GAAW,MAAM,GAAA,CAAI,mBAAoB,CAAA,MAAA;AAAA,QAC7C,SAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,UACE,SAAA,EACE,SAAa,IAAAC,cAAA,CAAS,GAAI,EAAA,CAAE,IAAK,CAAA,EAAE,IAAM,EAAA,GAAA,EAAK,CAAA,CAAE,SAAU,EAAA;AAAA,UAC5D,WAAA;AAAA,SACF;AAAA,OACF,CAAA;AAEA,MAAI,IAAA,CAAC,SAAS,KAAO,EAAA;AACnB,QAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA,CAAA;AAAA,OACzD;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,cAAgB,EAAA,QAAA,CAAS,KAAK,CAAA,CAAA;AAAA,KAC3C;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/actions/gitlabProjectAccessTokenCreate.examples.cjs.js

@@ -0,0 +1,250 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Create a GitLab project access token with minimal options.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with custom scopes.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "789",
+            scopes: ["read_registry", "write_repository"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a specified name.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            name: "my-custom-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a numeric project ID.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: 42
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a specified expired Date.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "123",
+            expiresAt: "2024-06-25"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with an access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456",
+            accessLevel: 30
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with multiple options",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456",
+            accessLevel: 40,
+            name: "full-access-token",
+            expiresAt: "2024-12-31"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a token for authorization",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            token: "personal-access-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with read-only scopes",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            scopes: ["read_repository", "read_api"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with guest access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 10
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with maintainer access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 40
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with owner access level",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            accessLevel: 50
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token with a specified name and no expiration date",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            name: "no-expiry-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project access token for a specific gitlab instance",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createAccessToken",
+          action: "gitlab:projectAccessToken:create",
+          name: "Create GitLab Project Access Token",
+          input: {
+            repoUrl: "gitlab.example.com?repo=repo&owner=owner",
+            projectId: "101112"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=gitlabProjectAccessTokenCreate.examples.cjs.js.map

package/dist/actions/gitlabProjectAccessTokenCreate.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabProjectAccessTokenCreate.examples.cjs.js","sources":["../../src/actions/gitlabProjectAccessTokenCreate.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Create a GitLab project access token with minimal options.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '456',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with custom scopes.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '789',\n            scopes: ['read_registry', 'write_repository'],\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with a specified name.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            name: 'my-custom-token',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token with a numeric project ID.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: 42,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token with a specified expired Date.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '123',\n            expiresAt: '2024-06-25',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with an access level',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '456',\n            accessLevel: 30,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with multiple options',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '456',\n            accessLevel: 40,\n            name: 'full-access-token',\n            expiresAt: '2024-12-31',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token with a token for authorization',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            token: 'personal-access-token',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with read-only scopes',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            scopes: ['read_repository', 'read_api'],\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with guest access level',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            accessLevel: 10,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token with maintainer access level',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            accessLevel: 40,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project access token with owner access level',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            accessLevel: 50,\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token with a specified name and no expiration date',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            name: 'no-expiry-token',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project access token for a specific gitlab instance',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createAccessToken',\n          action: 'gitlab:projectAccessToken:create',\n          name: 'Create GitLab Project Access Token',\n          input: {\n            repoUrl: 'gitlab.example.com?repo=repo&owner=owner',\n            projectId: '101112',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAkBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,4DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,0DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,MAAA,EAAQ,CAAC,eAAA,EAAiB,kBAAkB,CAAA;AAAA,WAC9C;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,6DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,IAAM,EAAA,iBAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,iEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,EAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,qEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,SAAW,EAAA,YAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,2DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,WAAa,EAAA,EAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,4DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,WAAa,EAAA,EAAA;AAAA,YACb,IAAM,EAAA,mBAAA;AAAA,YACN,SAAW,EAAA,YAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,qEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,KAAO,EAAA,uBAAA;AAAA,WACT;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,4DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,MAAA,EAAQ,CAAC,iBAAA,EAAmB,UAAU,CAAA;AAAA,WACxC;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,8DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,WAAa,EAAA,EAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,mEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,WAAa,EAAA,EAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,8DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,WAAa,EAAA,EAAA;AAAA,WACf;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,mFAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,IAAM,EAAA,iBAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,qEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,0CAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,WACb;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/actions/gitlabProjectDeployTokenCreate.cjs.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var node = require('@gitbeaker/node');
+var zod = require('zod');
+var commonGitlabConfig = require('../commonGitlabConfig.cjs.js');
+var util = require('../util.cjs.js');
+var gitlabProjectDeployTokenCreate_examples = require('./gitlabProjectDeployTokenCreate.examples.cjs.js');
+
+const createGitlabProjectDeployTokenAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectDeployToken:create",
+    examples: gitlabProjectDeployTokenCreate_examples.examples,
+    schema: {
+      input: commonGitlabConfig.default.merge(
+        zod.z.object({
+          projectId: zod.z.union([zod.z.number(), zod.z.string()], {
+            description: "Project ID"
+          }),
+          name: zod.z.string({ description: "Deploy Token Name" }),
+          username: zod.z.string({ description: "Deploy Token Username" }).optional(),
+          scopes: zod.z.array(zod.z.string(), { description: "Scopes" }).optional()
+        })
+      ),
+      output: zod.z.object({
+        deploy_token: zod.z.string({ description: "Deploy Token" }),
+        user: zod.z.string({ description: "User" })
+      })
+    },
+    async handler(ctx) {
+      ctx.logger.info(`Creating Token for Project "${ctx.input.projectId}"`);
+      const { projectId, name, username, scopes } = ctx.input;
+      const { token, integrationConfig } = util.getToken(ctx.input, integrations);
+      const api = new node.Gitlab({
+        host: integrationConfig.config.baseUrl,
+        token
+      });
+      const deployToken = await api.ProjectDeployTokens.add(
+        projectId,
+        name,
+        scopes,
+        {
+          username
+        }
+      );
+      if (!deployToken.hasOwnProperty("token")) {
+        throw new errors.InputError(`No deploy_token given from gitlab instance`);
+      }
+      ctx.output("deploy_token", deployToken.token);
+      ctx.output("user", deployToken.username);
+    }
+  });
+};
+
+exports.createGitlabProjectDeployTokenAction = createGitlabProjectDeployTokenAction;
+//# sourceMappingURL=gitlabProjectDeployTokenCreate.cjs.js.map

package/dist/actions/gitlabProjectDeployTokenCreate.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabProjectDeployTokenCreate.cjs.js","sources":["../../src/actions/gitlabProjectDeployTokenCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { InputError } from '@backstage/errors';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { DeployTokenScope } from '@gitbeaker/core/dist/types/templates/ResourceDeployTokens';\nimport { Gitlab } from '@gitbeaker/node';\nimport { z } from 'zod';\nimport commonGitlabConfig from '../commonGitlabConfig';\nimport { getToken } from '../util';\nimport { examples } from './gitlabProjectDeployTokenCreate.examples';\n\n/**\n * Creates a `gitlab:projectDeployToken:create` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createGitlabProjectDeployTokenAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction({\n    id: 'gitlab:projectDeployToken:create',\n    examples,\n    schema: {\n      input: commonGitlabConfig.merge(\n        z.object({\n          projectId: z.union([z.number(), z.string()], {\n            description: 'Project ID',\n          }),\n          name: z.string({ description: 'Deploy Token Name' }),\n          username: z\n            .string({ description: 'Deploy Token Username' })\n            .optional(),\n          scopes: z.array(z.string(), { description: 'Scopes' }).optional(),\n        }),\n      ),\n      output: z.object({\n        deploy_token: z.string({ description: 'Deploy Token' }),\n        user: z.string({ description: 'User' }),\n      }),\n    },\n    async handler(ctx) {\n      ctx.logger.info(`Creating Token for Project \"${ctx.input.projectId}\"`);\n      const { projectId, name, username, scopes } = ctx.input;\n      const { token, integrationConfig } = getToken(ctx.input, integrations);\n\n      const api = new Gitlab({\n        host: integrationConfig.config.baseUrl,\n        token: token,\n      });\n\n      const deployToken = await api.ProjectDeployTokens.add(\n        projectId,\n        name,\n        scopes as DeployTokenScope[],\n        {\n          username: username,\n        },\n      );\n\n      if (!deployToken.hasOwnProperty('token')) {\n        throw new InputError(`No deploy_token given from gitlab instance`);\n      }\n\n      ctx.output('deploy_token', deployToken.token as string);\n      ctx.output('user', deployToken.username);\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","commonGitlabConfig","z","getToken","Gitlab","InputError"],"mappings":";;;;;;;;;;AAgCa,MAAA,oCAAA,GAAuC,CAAC,OAE/C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,kCAAA;AAAA,cACJC,gDAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,OAAOC,0BAAmB,CAAA,KAAA;AAAA,QACxBC,MAAE,MAAO,CAAA;AAAA,UACP,SAAA,EAAWA,KAAE,CAAA,KAAA,CAAM,CAACA,KAAA,CAAE,QAAU,EAAAA,KAAA,CAAE,MAAO,EAAC,CAAG,EAAA;AAAA,YAC3C,WAAa,EAAA,YAAA;AAAA,WACd,CAAA;AAAA,UACD,MAAMA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,qBAAqB,CAAA;AAAA,UACnD,QAAA,EAAUA,MACP,MAAO,CAAA,EAAE,aAAa,uBAAwB,EAAC,EAC/C,QAAS,EAAA;AAAA,UACZ,MAAA,EAAQA,KAAE,CAAA,KAAA,CAAMA,KAAE,CAAA,MAAA,EAAU,EAAA,EAAE,WAAa,EAAA,QAAA,EAAU,CAAA,CAAE,QAAS,EAAA;AAAA,SACjE,CAAA;AAAA,OACH;AAAA,MACA,MAAA,EAAQA,MAAE,MAAO,CAAA;AAAA,QACf,cAAcA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,gBAAgB,CAAA;AAAA,QACtD,MAAMA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,QAAQ,CAAA;AAAA,OACvC,CAAA;AAAA,KACH;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,4BAAA,EAA+B,GAAI,CAAA,KAAA,CAAM,SAAS,CAAG,CAAA,CAAA,CAAA,CAAA;AACrE,MAAA,MAAM,EAAE,SAAW,EAAA,IAAA,EAAM,QAAU,EAAA,MAAA,KAAW,GAAI,CAAA,KAAA,CAAA;AAClD,MAAA,MAAM,EAAE,KAAO,EAAA,iBAAA,KAAsBC,aAAS,CAAA,GAAA,CAAI,OAAO,YAAY,CAAA,CAAA;AAErE,MAAM,MAAA,GAAA,GAAM,IAAIC,WAAO,CAAA;AAAA,QACrB,IAAA,EAAM,kBAAkB,MAAO,CAAA,OAAA;AAAA,QAC/B,KAAA;AAAA,OACD,CAAA,CAAA;AAED,MAAM,MAAA,WAAA,GAAc,MAAM,GAAA,CAAI,mBAAoB,CAAA,GAAA;AAAA,QAChD,SAAA;AAAA,QACA,IAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,UACE,QAAA;AAAA,SACF;AAAA,OACF,CAAA;AAEA,MAAA,IAAI,CAAC,WAAA,CAAY,cAAe,CAAA,OAAO,CAAG,EAAA;AACxC,QAAM,MAAA,IAAIC,kBAAW,CAA4C,0CAAA,CAAA,CAAA,CAAA;AAAA,OACnE;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,cAAgB,EAAA,WAAA,CAAY,KAAe,CAAA,CAAA;AACtD,MAAI,GAAA,CAAA,MAAA,CAAO,MAAQ,EAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AAAA,KACzC;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/actions/gitlabProjectDeployTokenCreate.examples.cjs.js

@@ -0,0 +1,100 @@
+'use strict';
+
+var yaml = require('yaml');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+const examples = [
+  {
+    description: "Create a GitLab project deploy token with minimal options.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createDeployToken",
+          action: "gitlab:projectDeployToken:create",
+          name: "Create GitLab Project Deploy Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "456",
+            name: "tokenname"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project deploy token with custom scopes.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createDeployToken",
+          action: "gitlab:projectDeployToken:create",
+          name: "Create GitLab Project Deploy Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "789",
+            name: "tokenname",
+            scopes: ["read_registry", "write_repository"]
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project deploy token with a specified name.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createDeployToken",
+          action: "gitlab:projectDeployToken:create",
+          name: "Create GitLab Project Deploy Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: "101112",
+            name: "my-custom-token"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project deploy token with a numeric project ID.",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createDeployToken",
+          action: "gitlab:projectDeployToken:create",
+          name: "Create GitLab Project Deploy Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: 42,
+            name: "tokenname"
+          }
+        }
+      ]
+    })
+  },
+  {
+    description: "Create a GitLab project deploy token with a custom username",
+    example: yaml__default.default.stringify({
+      steps: [
+        {
+          id: "createDeployToken",
+          action: "gitlab:projectDeployToken:create",
+          name: "Create GitLab Project Deploy Token",
+          input: {
+            repoUrl: "gitlab.com?repo=repo&owner=owner",
+            projectId: 42,
+            name: "tokenname",
+            username: "tokenuser"
+          }
+        }
+      ]
+    })
+  }
+];
+
+exports.examples = examples;
+//# sourceMappingURL=gitlabProjectDeployTokenCreate.examples.cjs.js.map

package/dist/actions/gitlabProjectDeployTokenCreate.examples.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabProjectDeployTokenCreate.examples.cjs.js","sources":["../../src/actions/gitlabProjectDeployTokenCreate.examples.ts"],"sourcesContent":["/*\n * Copyright 2023 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 { TemplateExample } from '@backstage/plugin-scaffolder-node';\nimport yaml from 'yaml';\n\nexport const examples: TemplateExample[] = [\n  {\n    description: 'Create a GitLab project deploy token with minimal options.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createDeployToken',\n          action: 'gitlab:projectDeployToken:create',\n          name: 'Create GitLab Project Deploy Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '456',\n            name: 'tokenname',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project deploy token with custom scopes.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createDeployToken',\n          action: 'gitlab:projectDeployToken:create',\n          name: 'Create GitLab Project Deploy Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '789',\n            name: 'tokenname',\n            scopes: ['read_registry', 'write_repository'],\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description: 'Create a GitLab project deploy token with a specified name.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createDeployToken',\n          action: 'gitlab:projectDeployToken:create',\n          name: 'Create GitLab Project Deploy Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: '101112',\n            name: 'my-custom-token',\n          },\n        },\n      ],\n    }),\n  },\n  {\n    description:\n      'Create a GitLab project deploy token with a numeric project ID.',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createDeployToken',\n          action: 'gitlab:projectDeployToken:create',\n          name: 'Create GitLab Project Deploy Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: 42,\n            name: 'tokenname',\n          },\n        },\n      ],\n    }),\n  },\n\n  {\n    description: 'Create a GitLab project deploy token with a custom username',\n    example: yaml.stringify({\n      steps: [\n        {\n          id: 'createDeployToken',\n          action: 'gitlab:projectDeployToken:create',\n          name: 'Create GitLab Project Deploy Token',\n          input: {\n            repoUrl: 'gitlab.com?repo=repo&owner=owner',\n            projectId: 42,\n            name: 'tokenname',\n            username: 'tokenuser',\n          },\n        },\n      ],\n    }),\n  },\n];\n"],"names":["yaml"],"mappings":";;;;;;;;AAkBO,MAAM,QAA8B,GAAA;AAAA,EACzC;AAAA,IACE,WAAa,EAAA,4DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,IAAM,EAAA,WAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,0DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,KAAA;AAAA,YACX,IAAM,EAAA,WAAA;AAAA,YACN,MAAA,EAAQ,CAAC,eAAA,EAAiB,kBAAkB,CAAA;AAAA,WAC9C;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WAAa,EAAA,6DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,QAAA;AAAA,YACX,IAAM,EAAA,iBAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EACA;AAAA,IACE,WACE,EAAA,iEAAA;AAAA,IACF,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,EAAA;AAAA,YACX,IAAM,EAAA,WAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AAAA,EAEA;AAAA,IACE,WAAa,EAAA,6DAAA;AAAA,IACb,OAAA,EAASA,sBAAK,SAAU,CAAA;AAAA,MACtB,KAAO,EAAA;AAAA,QACL;AAAA,UACE,EAAI,EAAA,mBAAA;AAAA,UACJ,MAAQ,EAAA,kCAAA;AAAA,UACR,IAAM,EAAA,oCAAA;AAAA,UACN,KAAO,EAAA;AAAA,YACL,OAAS,EAAA,kCAAA;AAAA,YACT,SAAW,EAAA,EAAA;AAAA,YACX,IAAM,EAAA,WAAA;AAAA,YACN,QAAU,EAAA,WAAA;AAAA,WACZ;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/actions/gitlabProjectVariableCreate.cjs.js

@@ -0,0 +1,61 @@
+'use strict';
+
+var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
+var zod = require('zod');
+var commonGitlabConfig = require('../commonGitlabConfig.cjs.js');
+var util = require('../util.cjs.js');
+var gitlabProjectVariableCreate_examples = require('./gitlabProjectVariableCreate.examples.cjs.js');
+
+const createGitlabProjectVariableAction = (options) => {
+  const { integrations } = options;
+  return pluginScaffolderNode.createTemplateAction({
+    id: "gitlab:projectVariable:create",
+    examples: gitlabProjectVariableCreate_examples.examples,
+    schema: {
+      input: commonGitlabConfig.default.merge(
+        zod.z.object({
+          projectId: zod.z.union([zod.z.number(), zod.z.string()], {
+            description: "Project ID"
+          }),
+          key: zod.z.string({
+            description: "The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed"
+          }).regex(/^[A-Za-z0-9_]{1,255}$/),
+          value: zod.z.string({ description: "The value of a variable" }),
+          variableType: zod.z.string({
+            description: "Variable Type (env_var or file)"
+          }),
+          variableProtected: zod.z.boolean({ description: "Whether the variable is protected" }).default(false).optional(),
+          masked: zod.z.boolean({ description: "Whether the variable is masked" }).default(false).optional(),
+          raw: zod.z.boolean({ description: "Whether the variable is expandable" }).default(false).optional(),
+          environmentScope: zod.z.string({ description: "The environment_scope of the variable" }).default("*").optional()
+        })
+      )
+    },
+    async handler(ctx) {
+      const {
+        repoUrl,
+        projectId,
+        key,
+        value,
+        variableType,
+        variableProtected = false,
+        masked = false,
+        raw = false,
+        environmentScope = "*",
+        token
+      } = ctx.input;
+      const { host } = util.parseRepoUrl(repoUrl, integrations);
+      const api = util.getClient({ host, integrations, token });
+      await api.ProjectVariables.create(projectId, key, value, {
+        variableType,
+        protected: variableProtected,
+        masked,
+        raw,
+        environmentScope
+      });
+    }
+  });
+};
+
+exports.createGitlabProjectVariableAction = createGitlabProjectVariableAction;
+//# sourceMappingURL=gitlabProjectVariableCreate.cjs.js.map

package/dist/actions/gitlabProjectVariableCreate.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlabProjectVariableCreate.cjs.js","sources":["../../src/actions/gitlabProjectVariableCreate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { ScmIntegrationRegistry } from '@backstage/integration';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { VariableType } from '@gitbeaker/rest';\nimport { z } from 'zod';\nimport commonGitlabConfig from '../commonGitlabConfig';\nimport { getClient, parseRepoUrl } from '../util';\nimport { examples } from './gitlabProjectVariableCreate.examples';\n\n/**\n * Creates a `gitlab:projectVariable:create` Scaffolder action.\n *\n * @param options - Templating configuration.\n * @public\n */\nexport const createGitlabProjectVariableAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n  return createTemplateAction({\n    id: 'gitlab:projectVariable:create',\n    examples,\n    schema: {\n      input: commonGitlabConfig.merge(\n        z.object({\n          projectId: z.union([z.number(), z.string()], {\n            description: 'Project ID',\n          }),\n          key: z\n            .string({\n              description:\n                'The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed',\n            })\n            .regex(/^[A-Za-z0-9_]{1,255}$/),\n          value: z.string({ description: 'The value of a variable' }),\n          variableType: z.string({\n            description: 'Variable Type (env_var or file)',\n          }),\n          variableProtected: z\n            .boolean({ description: 'Whether the variable is protected' })\n            .default(false)\n            .optional(),\n          masked: z\n            .boolean({ description: 'Whether the variable is masked' })\n            .default(false)\n            .optional(),\n          raw: z\n            .boolean({ description: 'Whether the variable is expandable' })\n            .default(false)\n            .optional(),\n          environmentScope: z\n            .string({ description: 'The environment_scope of the variable' })\n            .default('*')\n            .optional(),\n        }),\n      ),\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        projectId,\n        key,\n        value,\n        variableType,\n        variableProtected = false,\n        masked = false,\n        raw = false,\n        environmentScope = '*',\n        token,\n      } = ctx.input;\n\n      const { host } = parseRepoUrl(repoUrl, integrations);\n\n      const api = getClient({ host, integrations, token });\n\n      await api.ProjectVariables.create(projectId, key, value, {\n        variableType: variableType as VariableType,\n        protected: variableProtected,\n        masked,\n        raw,\n        environmentScope,\n      });\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","commonGitlabConfig","z","parseRepoUrl","getClient"],"mappings":";;;;;;;;AA8Ba,MAAA,iCAAA,GAAoC,CAAC,OAE5C,KAAA;AACJ,EAAM,MAAA,EAAE,cAAiB,GAAA,OAAA,CAAA;AACzB,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,+BAAA;AAAA,cACJC,6CAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,OAAOC,0BAAmB,CAAA,KAAA;AAAA,QACxBC,MAAE,MAAO,CAAA;AAAA,UACP,SAAA,EAAWA,KAAE,CAAA,KAAA,CAAM,CAACA,KAAA,CAAE,QAAU,EAAAA,KAAA,CAAE,MAAO,EAAC,CAAG,EAAA;AAAA,YAC3C,WAAa,EAAA,YAAA;AAAA,WACd,CAAA;AAAA,UACD,GAAA,EAAKA,MACF,MAAO,CAAA;AAAA,YACN,WACE,EAAA,qGAAA;AAAA,WACH,CACA,CAAA,KAAA,CAAM,uBAAuB,CAAA;AAAA,UAChC,OAAOA,KAAE,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,2BAA2B,CAAA;AAAA,UAC1D,YAAA,EAAcA,MAAE,MAAO,CAAA;AAAA,YACrB,WAAa,EAAA,iCAAA;AAAA,WACd,CAAA;AAAA,UACD,iBAAA,EAAmBA,KAChB,CAAA,OAAA,CAAQ,EAAE,WAAA,EAAa,mCAAoC,EAAC,CAC5D,CAAA,OAAA,CAAQ,KAAK,CAAA,CACb,QAAS,EAAA;AAAA,UACZ,MAAA,EAAQA,KACL,CAAA,OAAA,CAAQ,EAAE,WAAA,EAAa,gCAAiC,EAAC,CACzD,CAAA,OAAA,CAAQ,KAAK,CAAA,CACb,QAAS,EAAA;AAAA,UACZ,GAAA,EAAKA,KACF,CAAA,OAAA,CAAQ,EAAE,WAAA,EAAa,oCAAqC,EAAC,CAC7D,CAAA,OAAA,CAAQ,KAAK,CAAA,CACb,QAAS,EAAA;AAAA,UACZ,gBAAA,EAAkBA,KACf,CAAA,MAAA,CAAO,EAAE,WAAA,EAAa,uCAAwC,EAAC,CAC/D,CAAA,OAAA,CAAQ,GAAG,CAAA,CACX,QAAS,EAAA;AAAA,SACb,CAAA;AAAA,OACH;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,SAAA;AAAA,QACA,GAAA;AAAA,QACA,KAAA;AAAA,QACA,YAAA;AAAA,QACA,iBAAoB,GAAA,KAAA;AAAA,QACpB,MAAS,GAAA,KAAA;AAAA,QACT,GAAM,GAAA,KAAA;AAAA,QACN,gBAAmB,GAAA,GAAA;AAAA,QACnB,KAAA;AAAA,UACE,GAAI,CAAA,KAAA,CAAA;AAER,MAAA,MAAM,EAAE,IAAA,EAAS,GAAAC,iBAAA,CAAa,SAAS,YAAY,CAAA,CAAA;AAEnD,MAAA,MAAM,MAAMC,cAAU,CAAA,EAAE,IAAM,EAAA,YAAA,EAAc,OAAO,CAAA,CAAA;AAEnD,MAAA,MAAM,GAAI,CAAA,gBAAA,CAAiB,MAAO,CAAA,SAAA,EAAW,KAAK,KAAO,EAAA;AAAA,QACvD,YAAA;AAAA,QACA,SAAW,EAAA,iBAAA;AAAA,QACX,MAAA;AAAA,QACA,GAAA;AAAA,QACA,gBAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA,CAAA;AACH;;;;"}