@backstage/plugin-scaffolder-backend-module-gitlab 0.11.10-next.0 → 0.11.11-next.1

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

@@ -1 +1 @@
-{"version":3,"file":"gitlabRepoPush.cjs.js","sources":["../../src/actions/gitlabRepoPush.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 */\n\nimport path from 'node:path';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { InputError } from '@backstage/errors';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { CommitAction } from '@gitbeaker/rest';\nimport { createGitlabApi, getErrorMessage } from './helpers';\nimport { examples } from './gitlabRepoPush.examples';\nimport { getFileAction } from '../util';\nimport { SerializedFile } from '@backstage/plugin-scaffolder-node';\nimport { RepositoryTreeSchema } from '@gitbeaker/rest';\n\n/**\n * Create a new action that commits into a gitlab repository.\n *\n * @public\n */\nexport const createGitlabRepoPushAction = (options: {\n  integrations: ScmIntegrationRegistry;\n}) => {\n  const { integrations } = options;\n\n  return createTemplateAction({\n    id: 'gitlab:repo:push',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\n            description: `Accepts the format 'gitlab.com?repo=project_name&owner=group_name' where 'project_name' is the repository name and 'group_name' is a group or username`,\n          }),\n        branchName: z =>\n          z.string({\n            description: 'The branch name for the commit',\n          }),\n        commitMessage: z =>\n          z.string({\n            description: `The commit message`,\n          }),\n        sourcePath: z =>\n          z\n            .string({\n              description:\n                'Subdirectory of working directory to copy changes from',\n            })\n            .optional(),\n        targetPath: z =>\n          z\n            .string({\n              description: 'Subdirectory of repository to apply changes to',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitLab',\n            })\n            .optional(),\n        commitAction: z =>\n          z\n            .enum(['create', 'update', 'delete', 'auto'], {\n              description:\n                'The action to be used for git commit. Defaults to create, but can be set to update or delete',\n            })\n            .optional(),\n        allowEmpty: z =>\n          z\n            .boolean({\n              description: 'Allow an empty commit to be created.',\n            })\n            .optional(),\n      },\n      output: {\n        projectid: z =>\n          z.string({\n            description: 'Gitlab Project id/Name(slug)',\n          }),\n        projectPath: z =>\n          z.string({\n            description: 'Gitlab Project path',\n          }),\n        commitHash: z =>\n          z\n            .string({\n              description:\n                'The git commit hash of the commit, or omitted when there were no file changes to commit and `allowEmpty` is not true (covers both the default of unset and an explicit `false`).',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const {\n        branchName,\n        repoUrl,\n        targetPath,\n        sourcePath,\n        token,\n        commitAction,\n        allowEmpty,\n      } = ctx.input;\n\n      const { owner, repo, project } = parseRepoUrl(repoUrl, integrations);\n      const repoID = project ? project : `${owner}/${repo}`;\n\n      const api = createGitlabApi({\n        integrations,\n        token,\n        repoUrl,\n      });\n\n      let fileRoot: string;\n      if (sourcePath) {\n        fileRoot = resolveSafeChildPath(ctx.workspacePath, sourcePath);\n      } else {\n        fileRoot = ctx.workspacePath;\n      }\n\n      const fileContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      let remoteFiles: RepositoryTreeSchema[] = [];\n      if ((ctx.input.commitAction ?? 'auto') === 'auto') {\n        try {\n          remoteFiles = await api.Repositories.allRepositoryTrees(repoID, {\n            ref: branchName,\n            recursive: true,\n            path: targetPath ?? undefined,\n          });\n        } catch (e) {\n          ctx.logger.warn(\n            `Could not retrieve the list of files for ${repoID} (branch: ${branchName}) : ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n      }\n\n      const fileActionMap: {\n        file: SerializedFile;\n        action: 'create' | 'delete' | 'update' | 'skip';\n      }[] = [];\n      for (const file of fileContents) {\n        const action = await getFileAction(\n          { file, targetPath },\n          { repoID, branch: branchName },\n          api,\n          ctx.logger,\n          remoteFiles,\n          ctx.input.commitAction,\n        );\n        fileActionMap.push({ file, action });\n      }\n\n      const actions: CommitAction[] = fileActionMap\n        .filter(o => o.action !== 'skip')\n        .map(({ file, action }) => ({\n          action: action as CommitAction['action'],\n          filePath: targetPath\n            ? path.posix.join(targetPath, file.path)\n            : file.path,\n          encoding: 'base64',\n          content: file.content.toString('base64'),\n          execute_filemode: file.executable,\n        }));\n\n      const branchExists = await ctx.checkpoint({\n        key: `branch.exists.${repoID}.${branchName}`,\n        fn: async () => {\n          try {\n            await api.Branches.show(repoID, branchName);\n            return true;\n          } catch (e: any) {\n            if (e.cause?.response?.status !== 404) {\n              throw new InputError(\n                `Failed to check status of branch '${branchName}'. Please make sure that branch already exists or Backstage has permissions to create one. ${getErrorMessage(\n                  e,\n                )}`,\n              );\n            }\n          }\n          return false;\n        },\n      });\n\n      if (!branchExists) {\n        // create a branch using the default branch as ref\n        try {\n          const projects = await api.Projects.show(repoID);\n          const { default_branch: defaultBranch } = projects;\n          await api.Branches.create(repoID, branchName, String(defaultBranch));\n        } catch (e) {\n          throw new InputError(\n            `The branch '${branchName}' was not found and creation failed with error. Please make sure that branch already exists or Backstage has permissions to create one. ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n      }\n\n      if (actions.length === 0 && !allowEmpty) {\n        ctx.logger.warn(\n          `No file changes to commit to ${repoID} on branch '${branchName}'; skipping commit. Set 'allowEmpty: true' to create an empty commit.`,\n        );\n        ctx.output('projectid', repoID);\n        ctx.output('projectPath', repoID);\n        return;\n      }\n\n      try {\n        const commitId = await ctx.checkpoint({\n          key: `commit.create.${repoID}.${branchName}`,\n          fn: async () => {\n            const commit =\n              allowEmpty !== undefined\n                ? await api.Commits.create(\n                    repoID,\n                    branchName,\n                    ctx.input.commitMessage,\n                    actions,\n                    { allowEmpty } as any,\n                  )\n                : await api.Commits.create(\n                    repoID,\n                    branchName,\n                    ctx.input.commitMessage,\n                    actions,\n                  );\n            return commit.id;\n          },\n        });\n\n        ctx.output('projectid', repoID);\n        ctx.output('projectPath', repoID);\n        ctx.output('commitHash', commitId);\n      } catch (e) {\n        if (commitAction !== 'create') {\n          throw new InputError(\n            `Committing the changes to ${branchName} failed. Please verify that all files you're trying to modify exist in the repository. ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n        throw new InputError(\n          `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${getErrorMessage(\n            e,\n          )}`,\n        );\n      }\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","parseRepoUrl","createGitlabApi","resolveSafeChildPath","serializeDirectoryContents","getErrorMessage","getFileAction","path","InputError"],"mappings":";;;;;;;;;;;;;;AAqCO,MAAM,0BAAA,GAA6B,CAAC,OAAA,KAErC;AACJ,EAAA,MAAM,EAAE,cAAa,GAAI,OAAA;AAEzB,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,kBAAA;AAAA,cACJC,gCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,sJAAA;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,kBAAA;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,YAAA,EAAc,OACZ,CAAA,CACG,IAAA,CAAK,CAAC,QAAA,EAAU,QAAA,EAAU,QAAA,EAAU,MAAM,CAAA,EAAG;AAAA,UAC5C,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,UAAA;AAAA,QACA,OAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA;AAAA,QACA,YAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAO,IAAA,EAAM,SAAQ,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AACnE,MAAA,MAAM,SAAS,OAAA,GAAU,OAAA,GAAU,CAAA,EAAG,KAAK,IAAI,IAAI,CAAA,CAAA;AAEnD,MAAA,MAAM,MAAMC,uBAAA,CAAgB;AAAA,QAC1B,YAAA;AAAA,QACA,KAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI,UAAA,EAAY;AACd,QAAA,QAAA,GAAWC,qCAAA,CAAqB,GAAA,CAAI,aAAA,EAAe,UAAU,CAAA;AAAA,MAC/D,CAAA,MAAO;AACL,QAAA,QAAA,GAAW,GAAA,CAAI,aAAA;AAAA,MACjB;AAEA,MAAA,MAAM,YAAA,GAAe,MAAMC,+CAAA,CAA2B,QAAA,EAAU;AAAA,QAC9D,SAAA,EAAW;AAAA,OACZ,CAAA;AAED,MAAA,IAAI,cAAsC,EAAC;AAC3C,MAAA,IAAA,CAAK,GAAA,CAAI,KAAA,CAAM,YAAA,IAAgB,MAAA,MAAY,MAAA,EAAQ;AACjD,QAAA,IAAI;AACF,UAAA,WAAA,GAAc,MAAM,GAAA,CAAI,YAAA,CAAa,kBAAA,CAAmB,MAAA,EAAQ;AAAA,YAC9D,GAAA,EAAK,UAAA;AAAA,YACL,SAAA,EAAW,IAAA;AAAA,YACX,MAAM,UAAA,IAAc,KAAA;AAAA,WACrB,CAAA;AAAA,QACH,SAAS,CAAA,EAAG;AACV,UAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,YACT,CAAA,yCAAA,EAA4C,MAAM,CAAA,UAAA,EAAa,UAAU,CAAA,IAAA,EAAOC,uBAAA;AAAA,cAC9E;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAM,gBAGA,EAAC;AACP,MAAA,KAAA,MAAW,QAAQ,YAAA,EAAc;AAC/B,QAAA,MAAM,SAAS,MAAMC,kBAAA;AAAA,UACnB,EAAE,MAAM,UAAA,EAAW;AAAA,UACnB,EAAE,MAAA,EAAQ,MAAA,EAAQ,UAAA,EAAW;AAAA,UAC7B,GAAA;AAAA,UACA,GAAA,CAAI,MAAA;AAAA,UACJ,WAAA;AAAA,UACA,IAAI,KAAA,CAAM;AAAA,SACZ;AACA,QAAA,aAAA,CAAc,IAAA,CAAK,EAAE,IAAA,EAAM,MAAA,EAAQ,CAAA;AAAA,MACrC;AAEA,MAAA,MAAM,OAAA,GAA0B,aAAA,CAC7B,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,CAAE,MAAA,KAAW,MAAM,CAAA,CAC/B,GAAA,CAAI,CAAC,EAAE,IAAA,EAAM,QAAO,MAAO;AAAA,QAC1B,MAAA;AAAA,QACA,QAAA,EAAU,aACNC,qBAAA,CAAK,KAAA,CAAM,KAAK,UAAA,EAAY,IAAA,CAAK,IAAI,CAAA,GACrC,IAAA,CAAK,IAAA;AAAA,QACT,QAAA,EAAU,QAAA;AAAA,QACV,OAAA,EAAS,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,QAAQ,CAAA;AAAA,QACvC,kBAAkB,IAAA,CAAK;AAAA,OACzB,CAAE,CAAA;AAEJ,MAAA,MAAM,YAAA,GAAe,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACxC,GAAA,EAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,QAC1C,IAAI,YAAY;AACd,UAAA,IAAI;AACF,YAAA,MAAM,GAAA,CAAI,QAAA,CAAS,IAAA,CAAK,MAAA,EAAQ,UAAU,CAAA;AAC1C,YAAA,OAAO,IAAA;AAAA,UACT,SAAS,CAAA,EAAQ;AACf,YAAA,IAAI,CAAA,CAAE,KAAA,EAAO,QAAA,EAAU,MAAA,KAAW,GAAA,EAAK;AACrC,cAAA,MAAM,IAAIC,iBAAA;AAAA,gBACR,CAAA,kCAAA,EAAqC,UAAU,CAAA,2FAAA,EAA8FH,uBAAA;AAAA,kBAC3I;AAAA,iBACD,CAAA;AAAA,eACH;AAAA,YACF;AAAA,UACF;AACA,UAAA,OAAO,KAAA;AAAA,QACT;AAAA,OACD,CAAA;AAED,MAAA,IAAI,CAAC,YAAA,EAAc;AAEjB,QAAA,IAAI;AACF,UAAA,MAAM,QAAA,GAAW,MAAM,GAAA,CAAI,QAAA,CAAS,KAAK,MAAM,CAAA;AAC/C,UAAA,MAAM,EAAE,cAAA,EAAgB,aAAA,EAAc,GAAI,QAAA;AAC1C,UAAA,MAAM,IAAI,QAAA,CAAS,MAAA,CAAO,QAAQ,UAAA,EAAY,MAAA,CAAO,aAAa,CAAC,CAAA;AAAA,QACrE,SAAS,CAAA,EAAG;AACV,UAAA,MAAM,IAAIG,iBAAA;AAAA,YACR,CAAA,YAAA,EAAe,UAAU,CAAA,wIAAA,EAA2IH,uBAAA;AAAA,cAClK;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AAAA,MACF;AAEA,MAAA,IAAI,OAAA,CAAQ,MAAA,KAAW,CAAA,IAAK,CAAC,UAAA,EAAY;AACvC,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,6BAAA,EAAgC,MAAM,CAAA,YAAA,EAAe,UAAU,CAAA,qEAAA;AAAA,SACjE;AACA,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,MAAM,CAAA;AAC9B,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,MAAM,CAAA;AAChC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,QAAA,GAAW,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACpC,GAAA,EAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,UAC1C,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,GACJ,UAAA,KAAe,KAAA,CAAA,GACX,MAAM,IAAI,OAAA,CAAQ,MAAA;AAAA,cAChB,MAAA;AAAA,cACA,UAAA;AAAA,cACA,IAAI,KAAA,CAAM,aAAA;AAAA,cACV,OAAA;AAAA,cACA,EAAE,UAAA;AAAW,aACf,GACA,MAAM,GAAA,CAAI,OAAA,CAAQ,MAAA;AAAA,cAChB,MAAA;AAAA,cACA,UAAA;AAAA,cACA,IAAI,KAAA,CAAM,aAAA;AAAA,cACV;AAAA,aACF;AACN,YAAA,OAAO,MAAA,CAAO,EAAA;AAAA,UAChB;AAAA,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,MAAM,CAAA;AAC9B,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,MAAM,CAAA;AAChC,QAAA,GAAA,CAAI,MAAA,CAAO,cAAc,QAAQ,CAAA;AAAA,MACnC,SAAS,CAAA,EAAG;AACV,QAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,UAAA,MAAM,IAAIG,iBAAA;AAAA,YACR,CAAA,0BAAA,EAA6B,UAAU,CAAA,uFAAA,EAA0FH,uBAAA;AAAA,cAC/H;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AACA,QAAA,MAAM,IAAIG,iBAAA;AAAA,UACR,CAAA,0BAAA,EAA6B,UAAU,CAAA,qFAAA,EAAwFH,uBAAA;AAAA,YAC7H;AAAA,WACD,CAAA;AAAA,SACH;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"gitlabRepoPush.cjs.js","sources":["../../src/actions/gitlabRepoPush.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 */\n\nimport path from 'node:path';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { InputError } from '@backstage/errors';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n  serializeDirectoryContents,\n} from '@backstage/plugin-scaffolder-node';\nimport { CommitAction } from '@gitbeaker/rest';\nimport { createGitlabApi, getErrorMessage } from './helpers';\nimport { examples } from './gitlabRepoPush.examples';\nimport { getFileAction } from '../util';\nimport { SerializedFile } from '@backstage/plugin-scaffolder-node';\nimport { RepositoryTreeSchema } from '@gitbeaker/rest';\n\n/**\n * Create a new action that commits into a gitlab repository.\n *\n * @public\n */\nexport const createGitlabRepoPushAction = (options: {\n  integrations: ScmIntegrationRegistry;\n  requireScmUserCredentials?: boolean;\n}) => {\n  const { integrations, requireScmUserCredentials } = options;\n\n  return createTemplateAction({\n    id: 'gitlab:repo:push',\n    examples,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\n            description: `Accepts the format 'gitlab.com?repo=project_name&owner=group_name' where 'project_name' is the repository name and 'group_name' is a group or username`,\n          }),\n        branchName: z =>\n          z.string({\n            description: 'The branch name for the commit',\n          }),\n        commitMessage: z =>\n          z.string({\n            description: `The commit message`,\n          }),\n        sourcePath: z =>\n          z\n            .string({\n              description:\n                'Subdirectory of working directory to copy changes from',\n            })\n            .optional(),\n        targetPath: z =>\n          z\n            .string({\n              description: 'Subdirectory of repository to apply changes to',\n            })\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description: 'The token to use for authorization to GitLab',\n            })\n            .optional(),\n        commitAction: z =>\n          z\n            .enum(['create', 'update', 'delete', 'auto'], {\n              description:\n                'The action to be used for git commit. Defaults to create, but can be set to update or delete',\n            })\n            .optional(),\n        allowEmpty: z =>\n          z\n            .boolean({\n              description: 'Allow an empty commit to be created.',\n            })\n            .optional(),\n      },\n      output: {\n        projectid: z =>\n          z.string({\n            description: 'Gitlab Project id/Name(slug)',\n          }),\n        projectPath: z =>\n          z.string({\n            description: 'Gitlab Project path',\n          }),\n        commitHash: z =>\n          z\n            .string({\n              description:\n                'The git commit hash of the commit, or omitted when there were no file changes to commit and `allowEmpty` is not true (covers both the default of unset and an explicit `false`).',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const {\n        branchName,\n        repoUrl,\n        targetPath,\n        sourcePath,\n        token,\n        commitAction,\n        allowEmpty,\n      } = ctx.input;\n\n      const { owner, repo, project } = parseRepoUrl(repoUrl, integrations);\n      const repoID = project ? project : `${owner}/${repo}`;\n\n      const api = createGitlabApi({\n        integrations,\n        token,\n        repoUrl,\n        requireScmUserCredentials,\n      });\n\n      let fileRoot: string;\n      if (sourcePath) {\n        fileRoot = resolveSafeChildPath(ctx.workspacePath, sourcePath);\n      } else {\n        fileRoot = ctx.workspacePath;\n      }\n\n      const fileContents = await serializeDirectoryContents(fileRoot, {\n        gitignore: true,\n      });\n\n      let remoteFiles: RepositoryTreeSchema[] = [];\n      if ((ctx.input.commitAction ?? 'auto') === 'auto') {\n        try {\n          remoteFiles = await api.Repositories.allRepositoryTrees(repoID, {\n            ref: branchName,\n            recursive: true,\n            path: targetPath ?? undefined,\n          });\n        } catch (e) {\n          ctx.logger.warn(\n            `Could not retrieve the list of files for ${repoID} (branch: ${branchName}) : ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n      }\n\n      const fileActionMap: {\n        file: SerializedFile;\n        action: 'create' | 'delete' | 'update' | 'skip';\n      }[] = [];\n      for (const file of fileContents) {\n        const action = await getFileAction(\n          { file, targetPath },\n          { repoID, branch: branchName },\n          api,\n          ctx.logger,\n          remoteFiles,\n          ctx.input.commitAction,\n        );\n        fileActionMap.push({ file, action });\n      }\n\n      const actions: CommitAction[] = fileActionMap\n        .filter(o => o.action !== 'skip')\n        .map(({ file, action }) => ({\n          action: action as CommitAction['action'],\n          filePath: targetPath\n            ? path.posix.join(targetPath, file.path)\n            : file.path,\n          encoding: 'base64',\n          content: file.content.toString('base64'),\n          execute_filemode: file.executable,\n        }));\n\n      const branchExists = await ctx.checkpoint({\n        key: `branch.exists.${repoID}.${branchName}`,\n        fn: async () => {\n          try {\n            await api.Branches.show(repoID, branchName);\n            return true;\n          } catch (e: any) {\n            if (e.cause?.response?.status !== 404) {\n              throw new InputError(\n                `Failed to check status of branch '${branchName}'. Please make sure that branch already exists or Backstage has permissions to create one. ${getErrorMessage(\n                  e,\n                )}`,\n              );\n            }\n          }\n          return false;\n        },\n      });\n\n      if (!branchExists) {\n        // create a branch using the default branch as ref\n        try {\n          const projects = await api.Projects.show(repoID);\n          const { default_branch: defaultBranch } = projects;\n          await api.Branches.create(repoID, branchName, String(defaultBranch));\n        } catch (e) {\n          throw new InputError(\n            `The branch '${branchName}' was not found and creation failed with error. Please make sure that branch already exists or Backstage has permissions to create one. ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n      }\n\n      if (actions.length === 0 && !allowEmpty) {\n        ctx.logger.warn(\n          `No file changes to commit to ${repoID} on branch '${branchName}'; skipping commit. Set 'allowEmpty: true' to create an empty commit.`,\n        );\n        ctx.output('projectid', repoID);\n        ctx.output('projectPath', repoID);\n        return;\n      }\n\n      try {\n        const commitId = await ctx.checkpoint({\n          key: `commit.create.${repoID}.${branchName}`,\n          fn: async () => {\n            const commit =\n              allowEmpty !== undefined\n                ? await api.Commits.create(\n                    repoID,\n                    branchName,\n                    ctx.input.commitMessage,\n                    actions,\n                    { allowEmpty } as any,\n                  )\n                : await api.Commits.create(\n                    repoID,\n                    branchName,\n                    ctx.input.commitMessage,\n                    actions,\n                  );\n            return commit.id;\n          },\n        });\n\n        ctx.output('projectid', repoID);\n        ctx.output('projectPath', repoID);\n        ctx.output('commitHash', commitId);\n      } catch (e) {\n        if (commitAction !== 'create') {\n          throw new InputError(\n            `Committing the changes to ${branchName} failed. Please verify that all files you're trying to modify exist in the repository. ${getErrorMessage(\n              e,\n            )}`,\n          );\n        }\n        throw new InputError(\n          `Committing the changes to ${branchName} failed. Please check that none of the files created by the template already exists. ${getErrorMessage(\n            e,\n          )}`,\n        );\n      }\n    },\n  });\n};\n"],"names":["createTemplateAction","examples","parseRepoUrl","createGitlabApi","resolveSafeChildPath","serializeDirectoryContents","getErrorMessage","getFileAction","path","InputError"],"mappings":";;;;;;;;;;;;;;AAqCO,MAAM,0BAAA,GAA6B,CAAC,OAAA,KAGrC;AACJ,EAAA,MAAM,EAAE,YAAA,EAAc,yBAAA,EAA0B,GAAI,OAAA;AAEpD,EAAA,OAAOA,yCAAA,CAAqB;AAAA,IAC1B,EAAA,EAAI,kBAAA;AAAA,cACJC,gCAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,CAAA,CAAA,KACP,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,sJAAA;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CAAA,CAAA,KACb,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa,CAAA,kBAAA;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EAAa;AAAA,SACd,EACA,QAAA,EAAS;AAAA,QACd,YAAA,EAAc,OACZ,CAAA,CACG,IAAA,CAAK,CAAC,QAAA,EAAU,QAAA,EAAU,QAAA,EAAU,MAAM,CAAA,EAAG;AAAA,UAC5C,WAAA,EACE;AAAA,SACH,EACA,QAAA,EAAS;AAAA,QACd,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,OAAA,CAAQ;AAAA,UACP,WAAA,EAAa;AAAA,SACd,EACA,QAAA;AAAS,OAChB;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,SAAA,EAAW,CAAA,CAAA,KACT,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,WAAA,EAAa,CAAA,CAAA,KACX,CAAA,CAAE,MAAA,CAAO;AAAA,UACP,WAAA,EAAa;AAAA,SACd,CAAA;AAAA,QACH,UAAA,EAAY,CAAA,CAAA,KACV,CAAA,CACG,MAAA,CAAO;AAAA,UACN,WAAA,EACE;AAAA,SACH,EACA,QAAA;AAAS;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAA,EAAK;AACjB,MAAA,MAAM;AAAA,QACJ,UAAA;AAAA,QACA,OAAA;AAAA,QACA,UAAA;AAAA,QACA,UAAA;AAAA,QACA,KAAA;AAAA,QACA,YAAA;AAAA,QACA;AAAA,UACE,GAAA,CAAI,KAAA;AAER,MAAA,MAAM,EAAE,KAAA,EAAO,IAAA,EAAM,SAAQ,GAAIC,iCAAA,CAAa,SAAS,YAAY,CAAA;AACnE,MAAA,MAAM,SAAS,OAAA,GAAU,OAAA,GAAU,CAAA,EAAG,KAAK,IAAI,IAAI,CAAA,CAAA;AAEnD,MAAA,MAAM,MAAMC,uBAAA,CAAgB;AAAA,QAC1B,YAAA;AAAA,QACA,KAAA;AAAA,QACA,OAAA;AAAA,QACA;AAAA,OACD,CAAA;AAED,MAAA,IAAI,QAAA;AACJ,MAAA,IAAI,UAAA,EAAY;AACd,QAAA,QAAA,GAAWC,qCAAA,CAAqB,GAAA,CAAI,aAAA,EAAe,UAAU,CAAA;AAAA,MAC/D,CAAA,MAAO;AACL,QAAA,QAAA,GAAW,GAAA,CAAI,aAAA;AAAA,MACjB;AAEA,MAAA,MAAM,YAAA,GAAe,MAAMC,+CAAA,CAA2B,QAAA,EAAU;AAAA,QAC9D,SAAA,EAAW;AAAA,OACZ,CAAA;AAED,MAAA,IAAI,cAAsC,EAAC;AAC3C,MAAA,IAAA,CAAK,GAAA,CAAI,KAAA,CAAM,YAAA,IAAgB,MAAA,MAAY,MAAA,EAAQ;AACjD,QAAA,IAAI;AACF,UAAA,WAAA,GAAc,MAAM,GAAA,CAAI,YAAA,CAAa,kBAAA,CAAmB,MAAA,EAAQ;AAAA,YAC9D,GAAA,EAAK,UAAA;AAAA,YACL,SAAA,EAAW,IAAA;AAAA,YACX,MAAM,UAAA,IAAc,KAAA;AAAA,WACrB,CAAA;AAAA,QACH,SAAS,CAAA,EAAG;AACV,UAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,YACT,CAAA,yCAAA,EAA4C,MAAM,CAAA,UAAA,EAAa,UAAU,CAAA,IAAA,EAAOC,uBAAA;AAAA,cAC9E;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AAAA,MACF;AAEA,MAAA,MAAM,gBAGA,EAAC;AACP,MAAA,KAAA,MAAW,QAAQ,YAAA,EAAc;AAC/B,QAAA,MAAM,SAAS,MAAMC,kBAAA;AAAA,UACnB,EAAE,MAAM,UAAA,EAAW;AAAA,UACnB,EAAE,MAAA,EAAQ,MAAA,EAAQ,UAAA,EAAW;AAAA,UAC7B,GAAA;AAAA,UACA,GAAA,CAAI,MAAA;AAAA,UACJ,WAAA;AAAA,UACA,IAAI,KAAA,CAAM;AAAA,SACZ;AACA,QAAA,aAAA,CAAc,IAAA,CAAK,EAAE,IAAA,EAAM,MAAA,EAAQ,CAAA;AAAA,MACrC;AAEA,MAAA,MAAM,OAAA,GAA0B,aAAA,CAC7B,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,CAAE,MAAA,KAAW,MAAM,CAAA,CAC/B,GAAA,CAAI,CAAC,EAAE,IAAA,EAAM,QAAO,MAAO;AAAA,QAC1B,MAAA;AAAA,QACA,QAAA,EAAU,aACNC,qBAAA,CAAK,KAAA,CAAM,KAAK,UAAA,EAAY,IAAA,CAAK,IAAI,CAAA,GACrC,IAAA,CAAK,IAAA;AAAA,QACT,QAAA,EAAU,QAAA;AAAA,QACV,OAAA,EAAS,IAAA,CAAK,OAAA,CAAQ,QAAA,CAAS,QAAQ,CAAA;AAAA,QACvC,kBAAkB,IAAA,CAAK;AAAA,OACzB,CAAE,CAAA;AAEJ,MAAA,MAAM,YAAA,GAAe,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,QACxC,GAAA,EAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,QAC1C,IAAI,YAAY;AACd,UAAA,IAAI;AACF,YAAA,MAAM,GAAA,CAAI,QAAA,CAAS,IAAA,CAAK,MAAA,EAAQ,UAAU,CAAA;AAC1C,YAAA,OAAO,IAAA;AAAA,UACT,SAAS,CAAA,EAAQ;AACf,YAAA,IAAI,CAAA,CAAE,KAAA,EAAO,QAAA,EAAU,MAAA,KAAW,GAAA,EAAK;AACrC,cAAA,MAAM,IAAIC,iBAAA;AAAA,gBACR,CAAA,kCAAA,EAAqC,UAAU,CAAA,2FAAA,EAA8FH,uBAAA;AAAA,kBAC3I;AAAA,iBACD,CAAA;AAAA,eACH;AAAA,YACF;AAAA,UACF;AACA,UAAA,OAAO,KAAA;AAAA,QACT;AAAA,OACD,CAAA;AAED,MAAA,IAAI,CAAC,YAAA,EAAc;AAEjB,QAAA,IAAI;AACF,UAAA,MAAM,QAAA,GAAW,MAAM,GAAA,CAAI,QAAA,CAAS,KAAK,MAAM,CAAA;AAC/C,UAAA,MAAM,EAAE,cAAA,EAAgB,aAAA,EAAc,GAAI,QAAA;AAC1C,UAAA,MAAM,IAAI,QAAA,CAAS,MAAA,CAAO,QAAQ,UAAA,EAAY,MAAA,CAAO,aAAa,CAAC,CAAA;AAAA,QACrE,SAAS,CAAA,EAAG;AACV,UAAA,MAAM,IAAIG,iBAAA;AAAA,YACR,CAAA,YAAA,EAAe,UAAU,CAAA,wIAAA,EAA2IH,uBAAA;AAAA,cAClK;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AAAA,MACF;AAEA,MAAA,IAAI,OAAA,CAAQ,MAAA,KAAW,CAAA,IAAK,CAAC,UAAA,EAAY;AACvC,QAAA,GAAA,CAAI,MAAA,CAAO,IAAA;AAAA,UACT,CAAA,6BAAA,EAAgC,MAAM,CAAA,YAAA,EAAe,UAAU,CAAA,qEAAA;AAAA,SACjE;AACA,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,MAAM,CAAA;AAC9B,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,MAAM,CAAA;AAChC,QAAA;AAAA,MACF;AAEA,MAAA,IAAI;AACF,QAAA,MAAM,QAAA,GAAW,MAAM,GAAA,CAAI,UAAA,CAAW;AAAA,UACpC,GAAA,EAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,UAC1C,IAAI,YAAY;AACd,YAAA,MAAM,MAAA,GACJ,UAAA,KAAe,KAAA,CAAA,GACX,MAAM,IAAI,OAAA,CAAQ,MAAA;AAAA,cAChB,MAAA;AAAA,cACA,UAAA;AAAA,cACA,IAAI,KAAA,CAAM,aAAA;AAAA,cACV,OAAA;AAAA,cACA,EAAE,UAAA;AAAW,aACf,GACA,MAAM,GAAA,CAAI,OAAA,CAAQ,MAAA;AAAA,cAChB,MAAA;AAAA,cACA,UAAA;AAAA,cACA,IAAI,KAAA,CAAM,aAAA;AAAA,cACV;AAAA,aACF;AACN,YAAA,OAAO,MAAA,CAAO,EAAA;AAAA,UAChB;AAAA,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAA,CAAO,aAAa,MAAM,CAAA;AAC9B,QAAA,GAAA,CAAI,MAAA,CAAO,eAAe,MAAM,CAAA;AAChC,QAAA,GAAA,CAAI,MAAA,CAAO,cAAc,QAAQ,CAAA;AAAA,MACnC,SAAS,CAAA,EAAG;AACV,QAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,UAAA,MAAM,IAAIG,iBAAA;AAAA,YACR,CAAA,0BAAA,EAA6B,UAAU,CAAA,uFAAA,EAA0FH,uBAAA;AAAA,cAC/H;AAAA,aACD,CAAA;AAAA,WACH;AAAA,QACF;AACA,QAAA,MAAM,IAAIG,iBAAA;AAAA,UACR,CAAA,0BAAA,EAA6B,UAAU,CAAA,qFAAA,EAAwFH,uBAAA;AAAA,YAC7H;AAAA,WACD,CAAA;AAAA,SACH;AAAA,MACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/helpers.cjs.js

@@ -5,7 +5,12 @@ var errors = require('@backstage/errors');
 var rest = require('@gitbeaker/rest');
 
 function createGitlabApi(options) {
-  const { integrations, token: providedToken, repoUrl } = options;
+  const {
+    integrations,
+    token: providedToken,
+    repoUrl,
+    requireScmUserCredentials
+  } = options;
   const { host } = pluginScaffolderNode.parseRepoUrl(repoUrl, integrations);
   const integrationConfig = integrations.gitlab.byHost(host);
   if (!integrationConfig) {
@@ -13,6 +18,11 @@ function createGitlabApi(options) {
       `No matching integration configuration for host ${host}, please check your integrations config`
     );
   }
+  if (requireScmUserCredentials && !providedToken) {
+    throw new errors.InputError(
+      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`
+    );
+  }
   if (!integrationConfig.config.token && !providedToken) {
     throw new errors.InputError(`No token available for host ${host}`);
   }

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.cjs.js","sources":["../../src/actions/helpers.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 { parseRepoUrl } from '@backstage/plugin-scaffolder-node';\nimport { ErrorLike, InputError, isError } from '@backstage/errors';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { Gitlab } from '@gitbeaker/rest';\nimport { GitbeakerRequestError } from '@gitbeaker/requester-utils';\n\nexport function createGitlabApi(options: {\n  integrations: ScmIntegrationRegistry;\n  token?: string;\n  repoUrl: string;\n}): InstanceType<typeof Gitlab> {\n  const { integrations, token: providedToken, repoUrl } = options;\n\n  const { host } = parseRepoUrl(repoUrl, integrations);\n\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  if (!integrationConfig.config.token && !providedToken) {\n    throw new InputError(`No token available for host ${host}`);\n  }\n\n  const token = providedToken ?? integrationConfig.config.token!;\n  const tokenType = providedToken ? 'oauthToken' : 'token';\n\n  return new Gitlab({\n    host: integrationConfig.config.baseUrl,\n    [tokenType]: token,\n  });\n}\n\ninterface GitlabError extends ErrorLike {\n  // Errors from Gitlab may also include a description field that contains additional info\n  description: string;\n}\n\nfunction isGitlabError(e: unknown): e is GitlabError {\n  return isError(e) && 'description' in e && typeof e.description === 'string';\n}\n\nfunction isGitbeakerRequestError(e: unknown): e is GitbeakerRequestError {\n  return isError(e) && e.name === 'GitbeakerRequestError';\n}\n\nexport function getErrorMessage(e: unknown): string {\n  if (isGitbeakerRequestError(e) && e.cause)\n    return `${e} - ${e.cause.description}`;\n  if (isGitlabError(e)) return `${e} - ${e.description}`;\n  return String(e);\n}\n"],"names":["parseRepoUrl","InputError","Gitlab","isError"],"mappings":";;;;;;AAqBO,SAAS,gBAAgB,OAAA,EAIA;AAC9B,EAAA,MAAM,EAAE,YAAA,EAAc,KAAA,EAAO,aAAA,EAAe,SAAQ,GAAI,OAAA;AAExD,EAAA,MAAM,EAAE,IAAA,EAAK,GAAIA,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEnD,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,IAAI,CAAC,iBAAA,CAAkB,MAAA,CAAO,KAAA,IAAS,CAAC,aAAA,EAAe;AACrD,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,4BAAA,EAA+B,IAAI,CAAA,CAAE,CAAA;AAAA,EAC5D;AAEA,EAAA,MAAM,KAAA,GAAQ,aAAA,IAAiB,iBAAA,CAAkB,MAAA,CAAO,KAAA;AACxD,EAAA,MAAM,SAAA,GAAY,gBAAgB,YAAA,GAAe,OAAA;AAEjD,EAAA,OAAO,IAAIC,WAAA,CAAO;AAAA,IAChB,IAAA,EAAM,kBAAkB,MAAA,CAAO,OAAA;AAAA,IAC/B,CAAC,SAAS,GAAG;AAAA,GACd,CAAA;AACH;AAOA,SAAS,cAAc,CAAA,EAA8B;AACnD,EAAA,OAAOC,eAAQ,CAAC,CAAA,IAAK,iBAAiB,CAAA,IAAK,OAAO,EAAE,WAAA,KAAgB,QAAA;AACtE;AAEA,SAAS,wBAAwB,CAAA,EAAwC;AACvE,EAAA,OAAOA,cAAA,CAAQ,CAAC,CAAA,IAAK,CAAA,CAAE,IAAA,KAAS,uBAAA;AAClC;AAEO,SAAS,gBAAgB,CAAA,EAAoB;AAClD,EAAA,IAAI,uBAAA,CAAwB,CAAC,CAAA,IAAK,CAAA,CAAE,KAAA;AAClC,IAAA,OAAO,CAAA,EAAG,CAAC,CAAA,GAAA,EAAM,CAAA,CAAE,MAAM,WAAW,CAAA,CAAA;AACtC,EAAA,IAAI,aAAA,CAAc,CAAC,CAAA,EAAG,OAAO,GAAG,CAAC,CAAA,GAAA,EAAM,EAAE,WAAW,CAAA,CAAA;AACpD,EAAA,OAAO,OAAO,CAAC,CAAA;AACjB;;;;;"}
+{"version":3,"file":"helpers.cjs.js","sources":["../../src/actions/helpers.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 { parseRepoUrl } from '@backstage/plugin-scaffolder-node';\nimport { ErrorLike, InputError, isError } from '@backstage/errors';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { Gitlab } from '@gitbeaker/rest';\nimport { GitbeakerRequestError } from '@gitbeaker/requester-utils';\n\nexport function createGitlabApi(options: {\n  integrations: ScmIntegrationRegistry;\n  token?: string;\n  repoUrl: string;\n  requireScmUserCredentials?: boolean;\n}): InstanceType<typeof Gitlab> {\n  const {\n    integrations,\n    token: providedToken,\n    repoUrl,\n    requireScmUserCredentials,\n  } = options;\n\n  const { host } = parseRepoUrl(repoUrl, integrations);\n\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  if (requireScmUserCredentials && !providedToken) {\n    throw new InputError(\n      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`,\n    );\n  }\n\n  if (!integrationConfig.config.token && !providedToken) {\n    throw new InputError(`No token available for host ${host}`);\n  }\n\n  const token = providedToken ?? integrationConfig.config.token!;\n  const tokenType = providedToken ? 'oauthToken' : 'token';\n\n  return new Gitlab({\n    host: integrationConfig.config.baseUrl,\n    [tokenType]: token,\n  });\n}\n\ninterface GitlabError extends ErrorLike {\n  // Errors from Gitlab may also include a description field that contains additional info\n  description: string;\n}\n\nfunction isGitlabError(e: unknown): e is GitlabError {\n  return isError(e) && 'description' in e && typeof e.description === 'string';\n}\n\nfunction isGitbeakerRequestError(e: unknown): e is GitbeakerRequestError {\n  return isError(e) && e.name === 'GitbeakerRequestError';\n}\n\nexport function getErrorMessage(e: unknown): string {\n  if (isGitbeakerRequestError(e) && e.cause)\n    return `${e} - ${e.cause.description}`;\n  if (isGitlabError(e)) return `${e} - ${e.description}`;\n  return String(e);\n}\n"],"names":["parseRepoUrl","InputError","Gitlab","isError"],"mappings":";;;;;;AAqBO,SAAS,gBAAgB,OAAA,EAKA;AAC9B,EAAA,MAAM;AAAA,IACJ,YAAA;AAAA,IACA,KAAA,EAAO,aAAA;AAAA,IACP,OAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,EAAE,IAAA,EAAK,GAAIA,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEnD,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,IAAI,yBAAA,IAA6B,CAAC,aAAA,EAAe;AAC/C,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,yCAAyC,IAAI,CAAA,qDAAA;AAAA,KAC/C;AAAA,EACF;AAEA,EAAA,IAAI,CAAC,iBAAA,CAAkB,MAAA,CAAO,KAAA,IAAS,CAAC,aAAA,EAAe;AACrD,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,4BAAA,EAA+B,IAAI,CAAA,CAAE,CAAA;AAAA,EAC5D;AAEA,EAAA,MAAM,KAAA,GAAQ,aAAA,IAAiB,iBAAA,CAAkB,MAAA,CAAO,KAAA;AACxD,EAAA,MAAM,SAAA,GAAY,gBAAgB,YAAA,GAAe,OAAA;AAEjD,EAAA,OAAO,IAAIC,WAAA,CAAO;AAAA,IAChB,IAAA,EAAM,kBAAkB,MAAA,CAAO,OAAA;AAAA,IAC/B,CAAC,SAAS,GAAG;AAAA,GACd,CAAA;AACH;AAOA,SAAS,cAAc,CAAA,EAA8B;AACnD,EAAA,OAAOC,eAAQ,CAAC,CAAA,IAAK,iBAAiB,CAAA,IAAK,OAAO,EAAE,WAAA,KAAgB,QAAA;AACtE;AAEA,SAAS,wBAAwB,CAAA,EAAwC;AACvE,EAAA,OAAOA,cAAA,CAAQ,CAAC,CAAA,IAAK,CAAA,CAAE,IAAA,KAAS,uBAAA;AAClC;AAEO,SAAS,gBAAgB,CAAA,EAAoB;AAClD,EAAA,IAAI,uBAAA,CAAwB,CAAC,CAAA,IAAK,CAAA,CAAE,KAAA;AAClC,IAAA,OAAO,CAAA,EAAG,CAAC,CAAA,GAAA,EAAM,CAAA,CAAE,MAAM,WAAW,CAAA,CAAA;AACtC,EAAA,IAAI,aAAA,CAAc,CAAC,CAAA,EAAG,OAAO,GAAG,CAAC,CAAA,GAAA,EAAM,EAAE,WAAW,CAAA,CAAA;AACpD,EAAA,OAAO,OAAO,CAAC,CAAA;AACjB;;;;;"}

package/dist/index.d.ts

@@ -72,6 +72,7 @@ declare function createPublishGitlabAction(options: {
  */
 declare const createGitlabGroupEnsureExistsAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     path: (string | {
@@ -91,6 +92,7 @@ declare const createGitlabGroupEnsureExistsAction: (options: {
  */
 declare const createGitlabGroupAccessAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     path: string | number;
@@ -114,6 +116,7 @@ declare const createGitlabGroupAccessAction: (options: {
  */
 declare const createGitlabIssueAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     projectId: number;
@@ -145,6 +148,7 @@ declare const createGitlabIssueAction: (options: {
  */
 declare const editGitlabIssueAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     projectId: number;
@@ -182,6 +186,7 @@ declare const editGitlabIssueAction: (options: {
  */
 declare const createPublishGitlabMergeRequestAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     title: string;
@@ -198,6 +203,7 @@ declare const createPublishGitlabMergeRequestAction: (options: {
     reviewers?: string[] | undefined;
     assignReviewersFromApprovalRules?: boolean | undefined;
     labels?: string | string[] | undefined;
+    autoMerge?: boolean | undefined;
 }, {
     targetBranchName: string;
     projectid: string;
@@ -213,6 +219,7 @@ declare const createPublishGitlabMergeRequestAction: (options: {
  */
 declare const createTriggerGitlabPipelineAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     projectId: number;
@@ -232,6 +239,7 @@ declare const createTriggerGitlabPipelineAction: (options: {
  */
 declare const createGitlabProjectAccessTokenAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     projectId: string | number;
     repoUrl: string;
@@ -252,6 +260,7 @@ declare const createGitlabProjectAccessTokenAction: (options: {
  */
 declare const createGitlabProjectDeployTokenAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     projectId: string | number;
@@ -272,6 +281,7 @@ declare const createGitlabProjectDeployTokenAction: (options: {
  */
 declare const createGitlabProjectVariableAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     projectId: string | number;
@@ -295,6 +305,7 @@ declare const createGitlabProjectVariableAction: (options: {
  */
 declare const createGitlabRepoPushAction: (options: {
     integrations: ScmIntegrationRegistry;
+    requireScmUserCredentials?: boolean;
 }) => _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     branchName: string;

package/dist/module.cjs.js

@@ -32,20 +32,45 @@ const gitlabModule = backendPluginApi.createBackendModule({
       },
       async init({ scaffolder, autocomplete: autocomplete$1, config }) {
         const integrations = integration.ScmIntegrations.fromConfig(config);
+        const requireScmUserCredentials = config.getOptionalBoolean("scaffolder.requireScmUserCredentials") ?? false;
         scaffolder.addActions(
-          gitlabGroupEnsureExists.createGitlabGroupEnsureExistsAction({ integrations }),
-          gitlabGroupAccessAction.createGitlabGroupAccessAction({ integrations }),
+          gitlabGroupEnsureExists.createGitlabGroupEnsureExistsAction({
+            integrations,
+            requireScmUserCredentials
+          }),
+          gitlabGroupAccessAction.createGitlabGroupAccessAction({
+            integrations,
+            requireScmUserCredentials
+          }),
           gitlabProjectMigrate.createGitlabProjectMigrateAction({ integrations }),
-          gitlabIssueCreate.createGitlabIssueAction({ integrations }),
-          gitlabProjectAccessTokenCreate.createGitlabProjectAccessTokenAction({ integrations }),
-          gitlabProjectDeployTokenCreate.createGitlabProjectDeployTokenAction({ integrations }),
-          gitlabProjectVariableCreate.createGitlabProjectVariableAction({ integrations }),
-          gitlabRepoPush.createGitlabRepoPushAction({ integrations }),
+          gitlabIssueCreate.createGitlabIssueAction({ integrations, requireScmUserCredentials }),
+          gitlabProjectAccessTokenCreate.createGitlabProjectAccessTokenAction({
+            integrations,
+            requireScmUserCredentials
+          }),
+          gitlabProjectDeployTokenCreate.createGitlabProjectDeployTokenAction({
+            integrations,
+            requireScmUserCredentials
+          }),
+          gitlabProjectVariableCreate.createGitlabProjectVariableAction({
+            integrations,
+            requireScmUserCredentials
+          }),
+          gitlabRepoPush.createGitlabRepoPushAction({
+            integrations,
+            requireScmUserCredentials
+          }),
           gitlabUserInfo.createGitlabUserInfoAction({ integrations }),
-          gitlabIssueEdit.editGitlabIssueAction({ integrations }),
+          gitlabIssueEdit.editGitlabIssueAction({ integrations, requireScmUserCredentials }),
           gitlab.createPublishGitlabAction({ config, integrations }),
-          gitlabMergeRequest.createPublishGitlabMergeRequestAction({ integrations }),
-          gitlabPipelineTrigger.createTriggerGitlabPipelineAction({ integrations })
+          gitlabMergeRequest.createPublishGitlabMergeRequestAction({
+            integrations,
+            requireScmUserCredentials
+          }),
+          gitlabPipelineTrigger.createTriggerGitlabPipelineAction({
+            integrations,
+            requireScmUserCredentials
+          })
         );
         autocomplete$1.addAutocompleteProvider({
           id: "gitlab",

package/dist/module.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 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 {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { scaffolderAutocompleteExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n  createGitlabGroupEnsureExistsAction,\n  createGitlabGroupAccessAction,\n  createGitlabIssueAction,\n  createGitlabProjectAccessTokenAction,\n  createGitlabProjectDeployTokenAction,\n  createGitlabProjectVariableAction,\n  createGitlabRepoPushAction,\n  createGitlabUserInfoAction,\n  createPublishGitlabAction,\n  createPublishGitlabMergeRequestAction,\n  createTriggerGitlabPipelineAction,\n  editGitlabIssueAction,\n} from './actions';\nimport { createGitlabProjectMigrateAction } from './actions/gitlabProjectMigrate';\nimport { createHandleAutocompleteRequest } from './autocomplete/autocomplete';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\n\n/**\n * @public\n * The GitLab Module for the Scaffolder Backend\n */\nexport const gitlabModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'gitlab',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        autocomplete: scaffolderAutocompleteExtensionPoint,\n        config: coreServices.rootConfig,\n      },\n      async init({ scaffolder, autocomplete, config }) {\n        const integrations = ScmIntegrations.fromConfig(config);\n\n        scaffolder.addActions(\n          createGitlabGroupEnsureExistsAction({ integrations }),\n          createGitlabGroupAccessAction({ integrations }),\n          createGitlabProjectMigrateAction({ integrations }),\n          createGitlabIssueAction({ integrations }),\n          createGitlabProjectAccessTokenAction({ integrations }),\n          createGitlabProjectDeployTokenAction({ integrations }),\n          createGitlabProjectVariableAction({ integrations }),\n          createGitlabRepoPushAction({ integrations }),\n          createGitlabUserInfoAction({ integrations }),\n          editGitlabIssueAction({ integrations }),\n          createPublishGitlabAction({ config, integrations }),\n          createPublishGitlabMergeRequestAction({ integrations }),\n          createTriggerGitlabPipelineAction({ integrations }),\n        );\n\n        autocomplete.addAutocompleteProvider({\n          id: 'gitlab',\n          handler: createHandleAutocompleteRequest({ integrations }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","scaffolderAutocompleteExtensionPoint","coreServices","autocomplete","ScmIntegrations","createGitlabGroupEnsureExistsAction","createGitlabGroupAccessAction","createGitlabProjectMigrateAction","createGitlabIssueAction","createGitlabProjectAccessTokenAction","createGitlabProjectDeployTokenAction","createGitlabProjectVariableAction","createGitlabRepoPushAction","createGitlabUserInfoAction","editGitlabIssueAction","createPublishGitlabAction","createPublishGitlabMergeRequestAction","createTriggerGitlabPipelineAction","createHandleAutocompleteRequest"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA2CO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,YAAA,EAAcC,0CAAA;AAAA,QACd,QAAQC,6BAAA,CAAa;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,gBAAYC,cAAA,EAAc,QAAO,EAAG;AAC/C,QAAA,MAAM,YAAA,GAAeC,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AAEtD,QAAA,UAAA,CAAW,UAAA;AAAA,UACTC,2DAAA,CAAoC,EAAE,YAAA,EAAc,CAAA;AAAA,UACpDC,qDAAA,CAA8B,EAAE,YAAA,EAAc,CAAA;AAAA,UAC9CC,qDAAA,CAAiC,EAAE,YAAA,EAAc,CAAA;AAAA,UACjDC,yCAAA,CAAwB,EAAE,YAAA,EAAc,CAAA;AAAA,UACxCC,mEAAA,CAAqC,EAAE,YAAA,EAAc,CAAA;AAAA,UACrDC,mEAAA,CAAqC,EAAE,YAAA,EAAc,CAAA;AAAA,UACrDC,6DAAA,CAAkC,EAAE,YAAA,EAAc,CAAA;AAAA,UAClDC,yCAAA,CAA2B,EAAE,YAAA,EAAc,CAAA;AAAA,UAC3CC,yCAAA,CAA2B,EAAE,YAAA,EAAc,CAAA;AAAA,UAC3CC,qCAAA,CAAsB,EAAE,YAAA,EAAc,CAAA;AAAA,UACtCC,gCAAA,CAA0B,EAAE,MAAA,EAAQ,YAAA,EAAc,CAAA;AAAA,UAClDC,wDAAA,CAAsC,EAAE,YAAA,EAAc,CAAA;AAAA,UACtDC,uDAAA,CAAkC,EAAE,YAAA,EAAc;AAAA,SACpD;AAEA,QAAAd,cAAA,CAAa,uBAAA,CAAwB;AAAA,UACnC,EAAA,EAAI,QAAA;AAAA,UACJ,OAAA,EAASe,4CAAA,CAAgC,EAAE,YAAA,EAAc;AAAA,SAC1D,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["/*\n * Copyright 2024 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 {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { scaffolderAutocompleteExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';\nimport {\n  createGitlabGroupEnsureExistsAction,\n  createGitlabGroupAccessAction,\n  createGitlabIssueAction,\n  createGitlabProjectAccessTokenAction,\n  createGitlabProjectDeployTokenAction,\n  createGitlabProjectVariableAction,\n  createGitlabRepoPushAction,\n  createGitlabUserInfoAction,\n  createPublishGitlabAction,\n  createPublishGitlabMergeRequestAction,\n  createTriggerGitlabPipelineAction,\n  editGitlabIssueAction,\n} from './actions';\nimport { createGitlabProjectMigrateAction } from './actions/gitlabProjectMigrate';\nimport { createHandleAutocompleteRequest } from './autocomplete/autocomplete';\nimport { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node';\n\n/**\n * @public\n * The GitLab Module for the Scaffolder Backend\n */\nexport const gitlabModule = createBackendModule({\n  pluginId: 'scaffolder',\n  moduleId: 'gitlab',\n  register({ registerInit }) {\n    registerInit({\n      deps: {\n        scaffolder: scaffolderActionsExtensionPoint,\n        autocomplete: scaffolderAutocompleteExtensionPoint,\n        config: coreServices.rootConfig,\n      },\n      async init({ scaffolder, autocomplete, config }) {\n        const integrations = ScmIntegrations.fromConfig(config);\n        const requireScmUserCredentials =\n          config.getOptionalBoolean('scaffolder.requireScmUserCredentials') ??\n          false;\n\n        scaffolder.addActions(\n          createGitlabGroupEnsureExistsAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabGroupAccessAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabProjectMigrateAction({ integrations }),\n          createGitlabIssueAction({ integrations, requireScmUserCredentials }),\n          createGitlabProjectAccessTokenAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabProjectDeployTokenAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabProjectVariableAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabRepoPushAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createGitlabUserInfoAction({ integrations }),\n          editGitlabIssueAction({ integrations, requireScmUserCredentials }),\n          createPublishGitlabAction({ config, integrations }),\n          createPublishGitlabMergeRequestAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n          createTriggerGitlabPipelineAction({\n            integrations,\n            requireScmUserCredentials,\n          }),\n        );\n\n        autocomplete.addAutocompleteProvider({\n          id: 'gitlab',\n          handler: createHandleAutocompleteRequest({ integrations }),\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","scaffolderActionsExtensionPoint","scaffolderAutocompleteExtensionPoint","coreServices","autocomplete","ScmIntegrations","createGitlabGroupEnsureExistsAction","createGitlabGroupAccessAction","createGitlabProjectMigrateAction","createGitlabIssueAction","createGitlabProjectAccessTokenAction","createGitlabProjectDeployTokenAction","createGitlabProjectVariableAction","createGitlabRepoPushAction","createGitlabUserInfoAction","editGitlabIssueAction","createPublishGitlabAction","createPublishGitlabMergeRequestAction","createTriggerGitlabPipelineAction","createHandleAutocompleteRequest"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA2CO,MAAM,eAAeA,oCAAA,CAAoB;AAAA,EAC9C,QAAA,EAAU,YAAA;AAAA,EACV,QAAA,EAAU,QAAA;AAAA,EACV,QAAA,CAAS,EAAE,YAAA,EAAa,EAAG;AACzB,IAAA,YAAA,CAAa;AAAA,MACX,IAAA,EAAM;AAAA,QACJ,UAAA,EAAYC,oDAAA;AAAA,QACZ,YAAA,EAAcC,0CAAA;AAAA,QACd,QAAQC,6BAAA,CAAa;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,gBAAYC,cAAA,EAAc,QAAO,EAAG;AAC/C,QAAA,MAAM,YAAA,GAAeC,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,QAAA,MAAM,yBAAA,GACJ,MAAA,CAAO,kBAAA,CAAmB,sCAAsC,CAAA,IAChE,KAAA;AAEF,QAAA,UAAA,CAAW,UAAA;AAAA,UACTC,2DAAA,CAAoC;AAAA,YAClC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,qDAAA,CAA8B;AAAA,YAC5B,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,qDAAA,CAAiC,EAAE,YAAA,EAAc,CAAA;AAAA,UACjDC,yCAAA,CAAwB,EAAE,YAAA,EAAc,yBAAA,EAA2B,CAAA;AAAA,UACnEC,mEAAA,CAAqC;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,mEAAA,CAAqC;AAAA,YACnC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,6DAAA,CAAkC;AAAA,YAChC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yCAAA,CAA2B;AAAA,YACzB,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,yCAAA,CAA2B,EAAE,YAAA,EAAc,CAAA;AAAA,UAC3CC,qCAAA,CAAsB,EAAE,YAAA,EAAc,yBAAA,EAA2B,CAAA;AAAA,UACjEC,gCAAA,CAA0B,EAAE,MAAA,EAAQ,YAAA,EAAc,CAAA;AAAA,UAClDC,wDAAA,CAAsC;AAAA,YACpC,YAAA;AAAA,YACA;AAAA,WACD,CAAA;AAAA,UACDC,uDAAA,CAAkC;AAAA,YAChC,YAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAEA,QAAAd,cAAA,CAAa,uBAAA,CAAwB;AAAA,UACnC,EAAA,EAAI,QAAA;AAAA,UACJ,OAAA,EAASe,4CAAA,CAAgC,EAAE,YAAA,EAAc;AAAA,SAC1D,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/dist/util.cjs.js

@@ -20,7 +20,7 @@ const parseRepoHost = (repoUrl) => {
   }
   return parsed.host;
 };
-const getToken = (config, integrations) => {
+const getToken = (config, integrations, requireScmUserCredentials = false) => {
   const host = parseRepoHost(config.repoUrl);
   const integrationConfig = integrations.gitlab.byHost(host);
   if (!integrationConfig) {
@@ -28,6 +28,11 @@ const getToken = (config, integrations) => {
       `No matching integration configuration for host ${host}, please check your integrations config`
     );
   }
+  if (requireScmUserCredentials && !config.token) {
+    throw new errors.InputError(
+      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`
+    );
+  }
   const token = config.token || integrationConfig.config.token;
   return { token, integrationConfig };
 };
@@ -52,13 +57,18 @@ const parseRepoUrl = (repoUrl, integrations) => {
   return { host, owner, repo };
 };
 function getClient(props) {
-  const { host, token, integrations } = props;
+  const { host, token, integrations, requireScmUserCredentials } = props;
   const integrationConfig = integrations.gitlab.byHost(host);
   if (!integrationConfig) {
     throw new errors.InputError(
       `No matching integration configuration for host ${host}, please check your integrations config`
     );
   }
+  if (requireScmUserCredentials && !token) {
+    throw new errors.InputError(
+      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`
+    );
+  }
   const { config } = integrationConfig;
   if (!config.token && !token) {
     throw new errors.InputError(`No token available for host ${host}`);

package/dist/util.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.cjs.js","sources":["../src/util.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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { InputError } from '@backstage/errors';\nimport {\n  GitLabIntegration,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Gitlab, GroupSchema, RepositoryTreeSchema } from '@gitbeaker/rest';\nimport { z } from 'zod/v3';\nimport commonGitlabConfig from './commonGitlabConfig';\n\nimport { SerializedFile } from '@backstage/plugin-scaffolder-node';\n\nimport { createHash } from 'node:crypto';\nimport path from 'node:path';\n\nexport const parseRepoHost = (repoUrl: string): string => {\n  let parsed;\n  try {\n    parsed = new URL(`https://${repoUrl}`);\n  } catch (error) {\n    throw new InputError(\n      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,\n    );\n  }\n  return parsed.host;\n};\n\nexport const getToken = (\n  config: z.infer<typeof commonGitlabConfig>,\n  integrations: ScmIntegrationRegistry,\n): { token: string; integrationConfig: GitLabIntegration } => {\n  const host = parseRepoHost(config.repoUrl);\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  const token = config.token || integrationConfig.config.token!;\n\n  return { token: token, integrationConfig: integrationConfig };\n};\n\nexport type RepoSpec = {\n  repo: string;\n  host: string;\n  owner?: string;\n};\n\nexport const parseRepoUrl = (\n  repoUrl: string,\n  integrations: ScmIntegrationRegistry,\n): RepoSpec => {\n  let parsed;\n  try {\n    parsed = new URL(`https://${repoUrl}`);\n  } catch (error) {\n    throw new InputError(\n      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,\n    );\n  }\n  const host = parsed.host;\n  const owner = parsed.searchParams.get('owner') ?? undefined;\n  const repo: string = parsed.searchParams.get('repo')!;\n\n  const type = integrations.byHost(host)?.type;\n\n  if (!type) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  return { host, owner, repo };\n};\n\nexport function getClient(props: {\n  host: string;\n  token?: string;\n  integrations: ScmIntegrationRegistry;\n}): InstanceType<typeof Gitlab> {\n  const { host, token, integrations } = props;\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  const { config } = integrationConfig;\n\n  if (!config.token && !token) {\n    throw new InputError(`No token available for host ${host}`);\n  }\n\n  const requestToken = token || config.token!;\n  const tokenType = token ? 'oauthToken' : 'token';\n\n  const gitlabOptions: any = {\n    host: config.baseUrl,\n  };\n\n  gitlabOptions[tokenType] = requestToken;\n  return new Gitlab(gitlabOptions);\n}\n\nexport function convertDate(\n  inputDate: string | undefined,\n  defaultDate: string,\n) {\n  try {\n    return inputDate\n      ? new Date(inputDate).toISOString()\n      : new Date(defaultDate).toISOString();\n  } catch (error) {\n    throw new InputError(`Error converting input date - ${error}`);\n  }\n}\n\nexport async function getTopLevelParentGroup(\n  client: InstanceType<typeof Gitlab>,\n  groupId: number,\n): Promise<GroupSchema> {\n  try {\n    const topParentGroup = await client.Groups.show(groupId);\n    if (topParentGroup.parent_id) {\n      return getTopLevelParentGroup(client, topParentGroup.parent_id as number);\n    }\n    return topParentGroup as GroupSchema;\n  } catch (error: any) {\n    throw new InputError(\n      `Error finding top-level parent group ID: ${error.message}`,\n    );\n  }\n}\n\nexport async function checkEpicScope(\n  client: InstanceType<typeof Gitlab>,\n  projectId: number,\n  epicId: number,\n) {\n  try {\n    // If project exists, get the top level group id\n    const project = await client.Projects.show(projectId);\n    if (!project) {\n      throw new InputError(\n        `Project with id ${projectId} not found. Check your GitLab instance.`,\n      );\n    }\n    const topParentGroup = await getTopLevelParentGroup(\n      client,\n      project.namespace.id,\n    );\n    if (!topParentGroup) {\n      throw new InputError(`Couldn't find a suitable top-level parent group.`);\n    }\n    // Get the epic\n    const epic = (await client.Epics.all(topParentGroup.id)).find(\n      (x: any) => x.id === epicId,\n    );\n    if (!epic) {\n      throw new InputError(\n        `Epic with id ${epicId} not found in the top-level parent group ${topParentGroup.name}.`,\n      );\n    }\n\n    const epicGroup = await client.Groups.show(epic.group_id as number);\n    const projectNamespace: string = project.path_with_namespace as string;\n    return projectNamespace.startsWith(epicGroup.full_path as string);\n  } catch (error: any) {\n    throw new InputError(`Could not find epic scope: ${error.message}`);\n  }\n}\n\nfunction computeSha256(file: SerializedFile): string {\n  const hash = createHash('sha256');\n  hash.update(file.content);\n  return hash.digest('hex');\n}\n\nexport async function getFileAction(\n  fileInfo: { file: SerializedFile; targetPath?: string },\n  target: { repoID: string; branch: string },\n  api: InstanceType<typeof Gitlab>,\n  logger: LoggerService,\n  remoteFiles: RepositoryTreeSchema[],\n  defaultCommitAction:\n    | 'create'\n    | 'delete'\n    | 'update'\n    | 'skip'\n    | 'auto' = 'auto',\n): Promise<'create' | 'delete' | 'update' | 'skip'> {\n  if (defaultCommitAction === 'auto') {\n    const filePath = path.join(fileInfo.targetPath ?? '', fileInfo.file.path);\n\n    if (remoteFiles?.some(remoteFile => remoteFile.path === filePath)) {\n      try {\n        const targetFile = await api.RepositoryFiles.show(\n          target.repoID,\n          filePath,\n          target.branch,\n        );\n        if (computeSha256(fileInfo.file) === targetFile.content_sha256) {\n          return 'skip';\n        }\n      } catch (error) {\n        logger.warn(\n          `Unable to retrieve detailed information for remote file ${filePath}`,\n        );\n      }\n      return 'update';\n    }\n    return 'create';\n  }\n  return defaultCommitAction;\n}\n"],"names":["InputError","Gitlab","createHash","path"],"mappings":";;;;;;;;;;;AA+BO,MAAM,aAAA,GAAgB,CAAC,OAAA,KAA4B;AACxD,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,OAAO,CAAA,CAAE,CAAA;AAAA,EACvC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA;AAAA,KAChE;AAAA,EACF;AACA,EAAA,OAAO,MAAA,CAAO,IAAA;AAChB;AAEO,MAAM,QAAA,GAAW,CACtB,MAAA,EACA,YAAA,KAC4D;AAC5D,EAAA,MAAM,IAAA,GAAO,aAAA,CAAc,MAAA,CAAO,OAAO,CAAA;AACzC,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,IAAS,iBAAA,CAAkB,MAAA,CAAO,KAAA;AAEvD,EAAA,OAAO,EAAE,OAAc,iBAAA,EAAqC;AAC9D;AAQO,MAAM,YAAA,GAAe,CAC1B,OAAA,EACA,YAAA,KACa;AACb,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,OAAO,CAAA,CAAE,CAAA;AAAA,EACvC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA;AAAA,KAChE;AAAA,EACF;AACA,EAAA,MAAM,OAAO,MAAA,CAAO,IAAA;AACpB,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,OAAO,CAAA,IAAK,MAAA;AAClD,EAAA,MAAM,IAAA,GAAe,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,MAAM,CAAA;AAEnD,EAAA,MAAM,IAAA,GAAO,YAAA,CAAa,MAAA,CAAO,IAAI,CAAA,EAAG,IAAA;AAExC,EAAA,IAAI,CAAC,IAAA,EAAM;AACT,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAC7B;AAEO,SAAS,UAAU,KAAA,EAIM;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,YAAA,EAAa,GAAI,KAAA;AACtC,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,QAAO,GAAI,iBAAA;AAEnB,EAAA,IAAI,CAAC,MAAA,CAAO,KAAA,IAAS,CAAC,KAAA,EAAO;AAC3B,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,4BAAA,EAA+B,IAAI,CAAA,CAAE,CAAA;AAAA,EAC5D;AAEA,EAAA,MAAM,YAAA,GAAe,SAAS,MAAA,CAAO,KAAA;AACrC,EAAA,MAAM,SAAA,GAAY,QAAQ,YAAA,GAAe,OAAA;AAEzC,EAAA,MAAM,aAAA,GAAqB;AAAA,IACzB,MAAM,MAAA,CAAO;AAAA,GACf;AAEA,EAAA,aAAA,CAAc,SAAS,CAAA,GAAI,YAAA;AAC3B,EAAA,OAAO,IAAIC,YAAO,aAAa,CAAA;AACjC;AAEO,SAAS,WAAA,CACd,WACA,WAAA,EACA;AACA,EAAA,IAAI;AACF,IAAA,OAAO,SAAA,GACH,IAAI,IAAA,CAAK,SAAS,CAAA,CAAE,WAAA,EAAY,GAChC,IAAI,IAAA,CAAK,WAAW,CAAA,CAAE,WAAA,EAAY;AAAA,EACxC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAID,iBAAA,CAAW,CAAA,8BAAA,EAAiC,KAAK,CAAA,CAAE,CAAA;AAAA,EAC/D;AACF;AAEA,eAAsB,sBAAA,CACpB,QACA,OAAA,EACsB;AACtB,EAAA,IAAI;AACF,IAAA,MAAM,cAAA,GAAiB,MAAM,MAAA,CAAO,MAAA,CAAO,KAAK,OAAO,CAAA;AACvD,IAAA,IAAI,eAAe,SAAA,EAAW;AAC5B,MAAA,OAAO,sBAAA,CAAuB,MAAA,EAAQ,cAAA,CAAe,SAAmB,CAAA;AAAA,IAC1E;AACA,IAAA,OAAO,cAAA;AAAA,EACT,SAAS,KAAA,EAAY;AACnB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,yCAAA,EAA4C,MAAM,OAAO,CAAA;AAAA,KAC3D;AAAA,EACF;AACF;AAEA,eAAsB,cAAA,CACpB,MAAA,EACA,SAAA,EACA,MAAA,EACA;AACA,EAAA,IAAI;AAEF,IAAA,MAAM,OAAA,GAAU,MAAM,MAAA,CAAO,QAAA,CAAS,KAAK,SAAS,CAAA;AACpD,IAAA,IAAI,CAAC,OAAA,EAAS;AACZ,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,mBAAmB,SAAS,CAAA,uCAAA;AAAA,OAC9B;AAAA,IACF;AACA,IAAA,MAAM,iBAAiB,MAAM,sBAAA;AAAA,MAC3B,MAAA;AAAA,MACA,QAAQ,SAAA,CAAU;AAAA,KACpB;AACA,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,MAAM,IAAIA,kBAAW,CAAA,gDAAA,CAAkD,CAAA;AAAA,IACzE;AAEA,IAAA,MAAM,QAAQ,MAAM,MAAA,CAAO,MAAM,GAAA,CAAI,cAAA,CAAe,EAAE,CAAA,EAAG,IAAA;AAAA,MACvD,CAAC,CAAA,KAAW,CAAA,CAAE,EAAA,KAAO;AAAA,KACvB;AACA,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,CAAA,aAAA,EAAgB,MAAM,CAAA,yCAAA,EAA4C,cAAA,CAAe,IAAI,CAAA,CAAA;AAAA,OACvF;AAAA,IACF;AAEA,IAAA,MAAM,YAAY,MAAM,MAAA,CAAO,MAAA,CAAO,IAAA,CAAK,KAAK,QAAkB,CAAA;AAClE,IAAA,MAAM,mBAA2B,OAAA,CAAQ,mBAAA;AACzC,IAAA,OAAO,gBAAA,CAAiB,UAAA,CAAW,SAAA,CAAU,SAAmB,CAAA;AAAA,EAClE,SAAS,KAAA,EAAY;AACnB,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,2BAAA,EAA8B,KAAA,CAAM,OAAO,CAAA,CAAE,CAAA;AAAA,EACpE;AACF;AAEA,SAAS,cAAc,IAAA,EAA8B;AACnD,EAAA,MAAM,IAAA,GAAOE,uBAAW,QAAQ,CAAA;AAChC,EAAA,IAAA,CAAK,MAAA,CAAO,KAAK,OAAO,CAAA;AACxB,EAAA,OAAO,IAAA,CAAK,OAAO,KAAK,CAAA;AAC1B;AAEA,eAAsB,cACpB,QAAA,EACA,MAAA,EACA,KACA,MAAA,EACA,WAAA,EACA,sBAKa,MAAA,EACqC;AAClD,EAAA,IAAI,wBAAwB,MAAA,EAAQ;AAClC,IAAA,MAAM,QAAA,GAAWC,sBAAK,IAAA,CAAK,QAAA,CAAS,cAAc,EAAA,EAAI,QAAA,CAAS,KAAK,IAAI,CAAA;AAExE,IAAA,IAAI,aAAa,IAAA,CAAK,CAAA,UAAA,KAAc,UAAA,CAAW,IAAA,KAAS,QAAQ,CAAA,EAAG;AACjE,MAAA,IAAI;AACF,QAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,eAAA,CAAgB,IAAA;AAAA,UAC3C,MAAA,CAAO,MAAA;AAAA,UACP,QAAA;AAAA,UACA,MAAA,CAAO;AAAA,SACT;AACA,QAAA,IAAI,aAAA,CAAc,QAAA,CAAS,IAAI,CAAA,KAAM,WAAW,cAAA,EAAgB;AAC9D,UAAA,OAAO,MAAA;AAAA,QACT;AAAA,MACF,SAAS,KAAA,EAAO;AACd,QAAA,MAAA,CAAO,IAAA;AAAA,UACL,2DAA2D,QAAQ,CAAA;AAAA,SACrE;AAAA,MACF;AACA,MAAA,OAAO,QAAA;AAAA,IACT;AACA,IAAA,OAAO,QAAA;AAAA,EACT;AACA,EAAA,OAAO,mBAAA;AACT;;;;;;;;;;;"}
+{"version":3,"file":"util.cjs.js","sources":["../src/util.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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { InputError } from '@backstage/errors';\nimport {\n  GitLabIntegration,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Gitlab, GroupSchema, RepositoryTreeSchema } from '@gitbeaker/rest';\nimport { z } from 'zod/v3';\nimport commonGitlabConfig from './commonGitlabConfig';\n\nimport { SerializedFile } from '@backstage/plugin-scaffolder-node';\n\nimport { createHash } from 'node:crypto';\nimport path from 'node:path';\n\nexport const parseRepoHost = (repoUrl: string): string => {\n  let parsed;\n  try {\n    parsed = new URL(`https://${repoUrl}`);\n  } catch (error) {\n    throw new InputError(\n      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,\n    );\n  }\n  return parsed.host;\n};\n\nexport const getToken = (\n  config: z.infer<typeof commonGitlabConfig>,\n  integrations: ScmIntegrationRegistry,\n  requireScmUserCredentials = false,\n): { token: string; integrationConfig: GitLabIntegration } => {\n  const host = parseRepoHost(config.repoUrl);\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  if (requireScmUserCredentials && !config.token) {\n    throw new InputError(\n      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`,\n    );\n  }\n\n  const token = config.token || integrationConfig.config.token!;\n\n  return { token: token, integrationConfig: integrationConfig };\n};\n\nexport type RepoSpec = {\n  repo: string;\n  host: string;\n  owner?: string;\n};\n\nexport const parseRepoUrl = (\n  repoUrl: string,\n  integrations: ScmIntegrationRegistry,\n): RepoSpec => {\n  let parsed;\n  try {\n    parsed = new URL(`https://${repoUrl}`);\n  } catch (error) {\n    throw new InputError(\n      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`,\n    );\n  }\n  const host = parsed.host;\n  const owner = parsed.searchParams.get('owner') ?? undefined;\n  const repo: string = parsed.searchParams.get('repo')!;\n\n  const type = integrations.byHost(host)?.type;\n\n  if (!type) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  return { host, owner, repo };\n};\n\nexport function getClient(props: {\n  host: string;\n  token?: string;\n  integrations: ScmIntegrationRegistry;\n  requireScmUserCredentials?: boolean;\n}): InstanceType<typeof Gitlab> {\n  const { host, token, integrations, requireScmUserCredentials } = props;\n  const integrationConfig = integrations.gitlab.byHost(host);\n\n  if (!integrationConfig) {\n    throw new InputError(\n      `No matching integration configuration for host ${host}, please check your integrations config`,\n    );\n  }\n\n  if (requireScmUserCredentials && !token) {\n    throw new InputError(\n      `No user credentials provided for host ${host}, but scaffolder.requireScmUserCredentials is enabled`,\n    );\n  }\n\n  const { config } = integrationConfig;\n\n  if (!config.token && !token) {\n    throw new InputError(`No token available for host ${host}`);\n  }\n\n  const requestToken = token || config.token!;\n  const tokenType = token ? 'oauthToken' : 'token';\n\n  const gitlabOptions: any = {\n    host: config.baseUrl,\n  };\n\n  gitlabOptions[tokenType] = requestToken;\n  return new Gitlab(gitlabOptions);\n}\n\nexport function convertDate(\n  inputDate: string | undefined,\n  defaultDate: string,\n) {\n  try {\n    return inputDate\n      ? new Date(inputDate).toISOString()\n      : new Date(defaultDate).toISOString();\n  } catch (error) {\n    throw new InputError(`Error converting input date - ${error}`);\n  }\n}\n\nexport async function getTopLevelParentGroup(\n  client: InstanceType<typeof Gitlab>,\n  groupId: number,\n): Promise<GroupSchema> {\n  try {\n    const topParentGroup = await client.Groups.show(groupId);\n    if (topParentGroup.parent_id) {\n      return getTopLevelParentGroup(client, topParentGroup.parent_id as number);\n    }\n    return topParentGroup as GroupSchema;\n  } catch (error: any) {\n    throw new InputError(\n      `Error finding top-level parent group ID: ${error.message}`,\n    );\n  }\n}\n\nexport async function checkEpicScope(\n  client: InstanceType<typeof Gitlab>,\n  projectId: number,\n  epicId: number,\n) {\n  try {\n    // If project exists, get the top level group id\n    const project = await client.Projects.show(projectId);\n    if (!project) {\n      throw new InputError(\n        `Project with id ${projectId} not found. Check your GitLab instance.`,\n      );\n    }\n    const topParentGroup = await getTopLevelParentGroup(\n      client,\n      project.namespace.id,\n    );\n    if (!topParentGroup) {\n      throw new InputError(`Couldn't find a suitable top-level parent group.`);\n    }\n    // Get the epic\n    const epic = (await client.Epics.all(topParentGroup.id)).find(\n      (x: any) => x.id === epicId,\n    );\n    if (!epic) {\n      throw new InputError(\n        `Epic with id ${epicId} not found in the top-level parent group ${topParentGroup.name}.`,\n      );\n    }\n\n    const epicGroup = await client.Groups.show(epic.group_id as number);\n    const projectNamespace: string = project.path_with_namespace as string;\n    return projectNamespace.startsWith(epicGroup.full_path as string);\n  } catch (error: any) {\n    throw new InputError(`Could not find epic scope: ${error.message}`);\n  }\n}\n\nfunction computeSha256(file: SerializedFile): string {\n  const hash = createHash('sha256');\n  hash.update(file.content);\n  return hash.digest('hex');\n}\n\nexport async function getFileAction(\n  fileInfo: { file: SerializedFile; targetPath?: string },\n  target: { repoID: string; branch: string },\n  api: InstanceType<typeof Gitlab>,\n  logger: LoggerService,\n  remoteFiles: RepositoryTreeSchema[],\n  defaultCommitAction:\n    | 'create'\n    | 'delete'\n    | 'update'\n    | 'skip'\n    | 'auto' = 'auto',\n): Promise<'create' | 'delete' | 'update' | 'skip'> {\n  if (defaultCommitAction === 'auto') {\n    const filePath = path.join(fileInfo.targetPath ?? '', fileInfo.file.path);\n\n    if (remoteFiles?.some(remoteFile => remoteFile.path === filePath)) {\n      try {\n        const targetFile = await api.RepositoryFiles.show(\n          target.repoID,\n          filePath,\n          target.branch,\n        );\n        if (computeSha256(fileInfo.file) === targetFile.content_sha256) {\n          return 'skip';\n        }\n      } catch (error) {\n        logger.warn(\n          `Unable to retrieve detailed information for remote file ${filePath}`,\n        );\n      }\n      return 'update';\n    }\n    return 'create';\n  }\n  return defaultCommitAction;\n}\n"],"names":["InputError","Gitlab","createHash","path"],"mappings":";;;;;;;;;;;AA+BO,MAAM,aAAA,GAAgB,CAAC,OAAA,KAA4B;AACxD,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,OAAO,CAAA,CAAE,CAAA;AAAA,EACvC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA;AAAA,KAChE;AAAA,EACF;AACA,EAAA,OAAO,MAAA,CAAO,IAAA;AAChB;AAEO,MAAM,QAAA,GAAW,CACtB,MAAA,EACA,YAAA,EACA,4BAA4B,KAAA,KACgC;AAC5D,EAAA,MAAM,IAAA,GAAO,aAAA,CAAc,MAAA,CAAO,OAAO,CAAA;AACzC,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,IAAI,yBAAA,IAA6B,CAAC,MAAA,CAAO,KAAA,EAAO;AAC9C,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,yCAAyC,IAAI,CAAA,qDAAA;AAAA,KAC/C;AAAA,EACF;AAEA,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,IAAS,iBAAA,CAAkB,MAAA,CAAO,KAAA;AAEvD,EAAA,OAAO,EAAE,OAAc,iBAAA,EAAqC;AAC9D;AAQO,MAAM,YAAA,GAAe,CAC1B,OAAA,EACA,YAAA,KACa;AACb,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAA,QAAA,EAAW,OAAO,CAAA,CAAE,CAAA;AAAA,EACvC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA;AAAA,KAChE;AAAA,EACF;AACA,EAAA,MAAM,OAAO,MAAA,CAAO,IAAA;AACpB,EAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,OAAO,CAAA,IAAK,MAAA;AAClD,EAAA,MAAM,IAAA,GAAe,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,MAAM,CAAA;AAEnD,EAAA,MAAM,IAAA,GAAO,YAAA,CAAa,MAAA,CAAO,IAAI,CAAA,EAAG,IAAA;AAExC,EAAA,IAAI,CAAC,IAAA,EAAM;AACT,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,KAAA,EAAO,IAAA,EAAK;AAC7B;AAEO,SAAS,UAAU,KAAA,EAKM;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAO,YAAA,EAAc,2BAA0B,GAAI,KAAA;AACjE,EAAA,MAAM,iBAAA,GAAoB,YAAA,CAAa,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAA,EAAmB;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA;AAAA,KACxD;AAAA,EACF;AAEA,EAAA,IAAI,yBAAA,IAA6B,CAAC,KAAA,EAAO;AACvC,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,yCAAyC,IAAI,CAAA,qDAAA;AAAA,KAC/C;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,QAAO,GAAI,iBAAA;AAEnB,EAAA,IAAI,CAAC,MAAA,CAAO,KAAA,IAAS,CAAC,KAAA,EAAO;AAC3B,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,4BAAA,EAA+B,IAAI,CAAA,CAAE,CAAA;AAAA,EAC5D;AAEA,EAAA,MAAM,YAAA,GAAe,SAAS,MAAA,CAAO,KAAA;AACrC,EAAA,MAAM,SAAA,GAAY,QAAQ,YAAA,GAAe,OAAA;AAEzC,EAAA,MAAM,aAAA,GAAqB;AAAA,IACzB,MAAM,MAAA,CAAO;AAAA,GACf;AAEA,EAAA,aAAA,CAAc,SAAS,CAAA,GAAI,YAAA;AAC3B,EAAA,OAAO,IAAIC,YAAO,aAAa,CAAA;AACjC;AAEO,SAAS,WAAA,CACd,WACA,WAAA,EACA;AACA,EAAA,IAAI;AACF,IAAA,OAAO,SAAA,GACH,IAAI,IAAA,CAAK,SAAS,CAAA,CAAE,WAAA,EAAY,GAChC,IAAI,IAAA,CAAK,WAAW,CAAA,CAAE,WAAA,EAAY;AAAA,EACxC,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAID,iBAAA,CAAW,CAAA,8BAAA,EAAiC,KAAK,CAAA,CAAE,CAAA;AAAA,EAC/D;AACF;AAEA,eAAsB,sBAAA,CACpB,QACA,OAAA,EACsB;AACtB,EAAA,IAAI;AACF,IAAA,MAAM,cAAA,GAAiB,MAAM,MAAA,CAAO,MAAA,CAAO,KAAK,OAAO,CAAA;AACvD,IAAA,IAAI,eAAe,SAAA,EAAW;AAC5B,MAAA,OAAO,sBAAA,CAAuB,MAAA,EAAQ,cAAA,CAAe,SAAmB,CAAA;AAAA,IAC1E;AACA,IAAA,OAAO,cAAA;AAAA,EACT,SAAS,KAAA,EAAY;AACnB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,yCAAA,EAA4C,MAAM,OAAO,CAAA;AAAA,KAC3D;AAAA,EACF;AACF;AAEA,eAAsB,cAAA,CACpB,MAAA,EACA,SAAA,EACA,MAAA,EACA;AACA,EAAA,IAAI;AAEF,IAAA,MAAM,OAAA,GAAU,MAAM,MAAA,CAAO,QAAA,CAAS,KAAK,SAAS,CAAA;AACpD,IAAA,IAAI,CAAC,OAAA,EAAS;AACZ,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,mBAAmB,SAAS,CAAA,uCAAA;AAAA,OAC9B;AAAA,IACF;AACA,IAAA,MAAM,iBAAiB,MAAM,sBAAA;AAAA,MAC3B,MAAA;AAAA,MACA,QAAQ,SAAA,CAAU;AAAA,KACpB;AACA,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,MAAM,IAAIA,kBAAW,CAAA,gDAAA,CAAkD,CAAA;AAAA,IACzE;AAEA,IAAA,MAAM,QAAQ,MAAM,MAAA,CAAO,MAAM,GAAA,CAAI,cAAA,CAAe,EAAE,CAAA,EAAG,IAAA;AAAA,MACvD,CAAC,CAAA,KAAW,CAAA,CAAE,EAAA,KAAO;AAAA,KACvB;AACA,IAAA,IAAI,CAAC,IAAA,EAAM;AACT,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,CAAA,aAAA,EAAgB,MAAM,CAAA,yCAAA,EAA4C,cAAA,CAAe,IAAI,CAAA,CAAA;AAAA,OACvF;AAAA,IACF;AAEA,IAAA,MAAM,YAAY,MAAM,MAAA,CAAO,MAAA,CAAO,IAAA,CAAK,KAAK,QAAkB,CAAA;AAClE,IAAA,MAAM,mBAA2B,OAAA,CAAQ,mBAAA;AACzC,IAAA,OAAO,gBAAA,CAAiB,UAAA,CAAW,SAAA,CAAU,SAAmB,CAAA;AAAA,EAClE,SAAS,KAAA,EAAY;AACnB,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAAA,2BAAA,EAA8B,KAAA,CAAM,OAAO,CAAA,CAAE,CAAA;AAAA,EACpE;AACF;AAEA,SAAS,cAAc,IAAA,EAA8B;AACnD,EAAA,MAAM,IAAA,GAAOE,uBAAW,QAAQ,CAAA;AAChC,EAAA,IAAA,CAAK,MAAA,CAAO,KAAK,OAAO,CAAA;AACxB,EAAA,OAAO,IAAA,CAAK,OAAO,KAAK,CAAA;AAC1B;AAEA,eAAsB,cACpB,QAAA,EACA,MAAA,EACA,KACA,MAAA,EACA,WAAA,EACA,sBAKa,MAAA,EACqC;AAClD,EAAA,IAAI,wBAAwB,MAAA,EAAQ;AAClC,IAAA,MAAM,QAAA,GAAWC,sBAAK,IAAA,CAAK,QAAA,CAAS,cAAc,EAAA,EAAI,QAAA,CAAS,KAAK,IAAI,CAAA;AAExE,IAAA,IAAI,aAAa,IAAA,CAAK,CAAA,UAAA,KAAc,UAAA,CAAW,IAAA,KAAS,QAAQ,CAAA,EAAG;AACjE,MAAA,IAAI;AACF,QAAA,MAAM,UAAA,GAAa,MAAM,GAAA,CAAI,eAAA,CAAgB,IAAA;AAAA,UAC3C,MAAA,CAAO,MAAA;AAAA,UACP,QAAA;AAAA,UACA,MAAA,CAAO;AAAA,SACT;AACA,QAAA,IAAI,aAAA,CAAc,QAAA,CAAS,IAAI,CAAA,KAAM,WAAW,cAAA,EAAgB;AAC9D,UAAA,OAAO,MAAA;AAAA,QACT;AAAA,MACF,SAAS,KAAA,EAAO;AACd,QAAA,MAAA,CAAO,IAAA;AAAA,UACL,2DAA2D,QAAQ,CAAA;AAAA,SACrE;AAAA,MACF;AACA,MAAA,OAAO,QAAA;AAAA,IACT;AACA,IAAA,OAAO,QAAA;AAAA,EACT;AACA,EAAA,OAAO,mBAAA;AACT;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-gitlab",
-  "version": "0.11.10-next.0",
+  "version": "0.11.11-next.1",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "scaffolder",
@@ -53,11 +53,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.10.0",
+    "@backstage/backend-plugin-api": "1.10.1-next.0",
     "@backstage/config": "1.3.8",
     "@backstage/errors": "1.3.1",
-    "@backstage/integration": "2.1.0",
-    "@backstage/plugin-scaffolder-node": "0.13.7-next.0",
+    "@backstage/integration": "2.1.2-next.0",
+    "@backstage/plugin-scaffolder-node": "0.13.7-next.1",
     "@gitbeaker/core": "^43.8.0",
     "@gitbeaker/requester-utils": "^43.8.0",
     "@gitbeaker/rest": "^43.8.0",
@@ -66,8 +66,8 @@
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.6",
+    "@backstage/backend-test-utils": "1.11.7-next.0",
     "@backstage/cli": "0.36.6-next.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.3.15-next.0"
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.15-next.1"
   }
 }