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

package/dist/util.cjs.js

@@ -0,0 +1,129 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var rest = require('@gitbeaker/rest');
+
+const parseRepoHost = (repoUrl) => {
+  let parsed;
+  try {
+    parsed = new URL(`https://${repoUrl}`);
+  } catch (error) {
+    throw new errors.InputError(
+      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`
+    );
+  }
+  return parsed.host;
+};
+const getToken = (config, integrations) => {
+  const host = parseRepoHost(config.repoUrl);
+  const integrationConfig = integrations.gitlab.byHost(host);
+  if (!integrationConfig) {
+    throw new errors.InputError(
+      `No matching integration configuration for host ${host}, please check your integrations config`
+    );
+  }
+  const token = config.token || integrationConfig.config.token;
+  return { token, integrationConfig };
+};
+const parseRepoUrl = (repoUrl, integrations) => {
+  let parsed;
+  try {
+    parsed = new URL(`https://${repoUrl}`);
+  } catch (error) {
+    throw new errors.InputError(
+      `Invalid repo URL passed to publisher, got ${repoUrl}, ${error}`
+    );
+  }
+  const host = parsed.host;
+  const owner = parsed.searchParams.get("owner") ?? void 0;
+  const repo = parsed.searchParams.get("repo");
+  const type = integrations.byHost(host)?.type;
+  if (!type) {
+    throw new errors.InputError(
+      `No matching integration configuration for host ${host}, please check your integrations config`
+    );
+  }
+  return { host, owner, repo };
+};
+function getClient(props) {
+  const { host, token, integrations } = 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`
+    );
+  }
+  const { config } = integrationConfig;
+  if (!config.token && !token) {
+    throw new errors.InputError(`No token available for host ${host}`);
+  }
+  const requestToken = token || config.token;
+  const tokenType = token ? "oauthToken" : "token";
+  const gitlabOptions = {
+    host: config.baseUrl
+  };
+  gitlabOptions[tokenType] = requestToken;
+  return new rest.Gitlab(gitlabOptions);
+}
+function convertDate(inputDate, defaultDate) {
+  try {
+    return inputDate ? new Date(inputDate).toISOString() : new Date(defaultDate).toISOString();
+  } catch (error) {
+    throw new errors.InputError(`Error converting input date - ${error}`);
+  }
+}
+async function getTopLevelParentGroup(client, groupId) {
+  try {
+    const topParentGroup = await client.Groups.show(groupId);
+    if (topParentGroup.parent_id) {
+      return getTopLevelParentGroup(
+        client,
+        topParentGroup.parent_id
+      );
+    }
+    return topParentGroup;
+  } catch (error) {
+    throw new errors.InputError(
+      `Error finding top-level parent group ID: ${error.message}`
+    );
+  }
+}
+async function checkEpicScope(client, projectId, epicId) {
+  try {
+    const project = await client.Projects.show(projectId);
+    if (!project) {
+      throw new errors.InputError(
+        `Project with id ${projectId} not found. Check your GitLab instance.`
+      );
+    }
+    const topParentGroup = await getTopLevelParentGroup(
+      client,
+      project.namespace.id
+    );
+    if (!topParentGroup) {
+      throw new errors.InputError(`Couldn't find a suitable top-level parent group.`);
+    }
+    const epic = (await client.Epics.all(topParentGroup.id)).find(
+      (x) => x.id === epicId
+    );
+    if (!epic) {
+      throw new errors.InputError(
+        `Epic with id ${epicId} not found in the top-level parent group ${topParentGroup.name}.`
+      );
+    }
+    const epicGroup = await client.Groups.show(epic.group_id);
+    const projectNamespace = project.path_with_namespace;
+    return projectNamespace.startsWith(epicGroup.full_path);
+  } catch (error) {
+    throw new errors.InputError(`Could not find epic scope: ${error.message}`);
+  }
+}
+
+exports.checkEpicScope = checkEpicScope;
+exports.convertDate = convertDate;
+exports.getClient = getClient;
+exports.getToken = getToken;
+exports.getTopLevelParentGroup = getTopLevelParentGroup;
+exports.parseRepoHost = parseRepoHost;
+exports.parseRepoUrl = parseRepoUrl;
+//# sourceMappingURL=util.cjs.js.map

package/dist/util.cjs.js.map

@@ -0,0 +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 { InputError } from '@backstage/errors';\nimport {\n  GitLabIntegration,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport { Gitlab, GroupSchema } from '@gitbeaker/rest';\nimport { z } from 'zod';\nimport commonGitlabConfig from './commonGitlabConfig';\nimport * as util from './util';\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 util.getTopLevelParentGroup(\n        client,\n        topParentGroup.parent_id as number,\n      );\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"],"names":["InputError","Gitlab","util.getTopLevelParentGroup"],"mappings":";;;;;AA0Ba,MAAA,aAAA,GAAgB,CAAC,OAA4B,KAAA;AACxD,EAAI,IAAA,MAAA,CAAA;AACJ,EAAI,IAAA;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAW,QAAA,EAAA,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,WAC9B,KAAO,EAAA;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA,CAAA;AAAA,KAChE,CAAA;AAAA,GACF;AACA,EAAA,OAAO,MAAO,CAAA,IAAA,CAAA;AAChB,EAAA;AAEa,MAAA,QAAA,GAAW,CACtB,MAAA,EACA,YAC4D,KAAA;AAC5D,EAAM,MAAA,IAAA,GAAO,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AACzC,EAAA,MAAM,iBAAoB,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAmB,EAAA;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA,CAAA;AAAA,KACxD,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,KAAS,IAAA,iBAAA,CAAkB,MAAO,CAAA,KAAA,CAAA;AAEvD,EAAO,OAAA,EAAE,OAAc,iBAAqC,EAAA,CAAA;AAC9D,EAAA;AAQa,MAAA,YAAA,GAAe,CAC1B,OAAA,EACA,YACa,KAAA;AACb,EAAI,IAAA,MAAA,CAAA;AACJ,EAAI,IAAA;AACF,IAAA,MAAA,GAAS,IAAI,GAAA,CAAI,CAAW,QAAA,EAAA,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,WAC9B,KAAO,EAAA;AACd,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,CAAA,0CAAA,EAA6C,OAAO,CAAA,EAAA,EAAK,KAAK,CAAA,CAAA;AAAA,KAChE,CAAA;AAAA,GACF;AACA,EAAA,MAAM,OAAO,MAAO,CAAA,IAAA,CAAA;AACpB,EAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,YAAa,CAAA,GAAA,CAAI,OAAO,CAAK,IAAA,KAAA,CAAA,CAAA;AAClD,EAAA,MAAM,IAAe,GAAA,MAAA,CAAO,YAAa,CAAA,GAAA,CAAI,MAAM,CAAA,CAAA;AAEnD,EAAA,MAAM,IAAO,GAAA,YAAA,CAAa,MAAO,CAAA,IAAI,CAAG,EAAA,IAAA,CAAA;AAExC,EAAA,IAAI,CAAC,IAAM,EAAA;AACT,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA,CAAA;AAAA,KACxD,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,EAAE,IAAM,EAAA,KAAA,EAAO,IAAK,EAAA,CAAA;AAC7B,EAAA;AAEO,SAAS,UAAU,KAIM,EAAA;AAC9B,EAAA,MAAM,EAAE,IAAA,EAAM,KAAO,EAAA,YAAA,EAAiB,GAAA,KAAA,CAAA;AACtC,EAAA,MAAM,iBAAoB,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AAEzD,EAAA,IAAI,CAAC,iBAAmB,EAAA;AACtB,IAAA,MAAM,IAAIA,iBAAA;AAAA,MACR,kDAAkD,IAAI,CAAA,uCAAA,CAAA;AAAA,KACxD,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,EAAE,QAAW,GAAA,iBAAA,CAAA;AAEnB,EAAA,IAAI,CAAC,MAAA,CAAO,KAAS,IAAA,CAAC,KAAO,EAAA;AAC3B,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAA+B,4BAAA,EAAA,IAAI,CAAE,CAAA,CAAA,CAAA;AAAA,GAC5D;AAEA,EAAM,MAAA,YAAA,GAAe,SAAS,MAAO,CAAA,KAAA,CAAA;AACrC,EAAM,MAAA,SAAA,GAAY,QAAQ,YAAe,GAAA,OAAA,CAAA;AAEzC,EAAA,MAAM,aAAqB,GAAA;AAAA,IACzB,MAAM,MAAO,CAAA,OAAA;AAAA,GACf,CAAA;AAEA,EAAA,aAAA,CAAc,SAAS,CAAI,GAAA,YAAA,CAAA;AAC3B,EAAO,OAAA,IAAIC,YAAO,aAAa,CAAA,CAAA;AACjC,CAAA;AAEgB,SAAA,WAAA,CACd,WACA,WACA,EAAA;AACA,EAAI,IAAA;AACF,IAAO,OAAA,SAAA,GACH,IAAI,IAAA,CAAK,SAAS,CAAA,CAAE,WAAY,EAAA,GAChC,IAAI,IAAA,CAAK,WAAW,CAAA,CAAE,WAAY,EAAA,CAAA;AAAA,WAC/B,KAAO,EAAA;AACd,IAAA,MAAM,IAAID,iBAAA,CAAW,CAAiC,8BAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,GAC/D;AACF,CAAA;AAEsB,eAAA,sBAAA,CACpB,QACA,OACsB,EAAA;AACtB,EAAI,IAAA;AACF,IAAA,MAAM,cAAiB,GAAA,MAAM,MAAO,CAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACvD,IAAA,IAAI,eAAe,SAAW,EAAA;AAC5B,MAAA,OAAOE,sBAAK;AAAA,QACV,MAAA;AAAA,QACA,cAAe,CAAA,SAAA;AAAA,OACjB,CAAA;AAAA,KACF;AACA,IAAO,OAAA,cAAA,CAAA;AAAA,WACA,KAAY,EAAA;AACnB,IAAA,MAAM,IAAIF,iBAAA;AAAA,MACR,CAAA,yCAAA,EAA4C,MAAM,OAAO,CAAA,CAAA;AAAA,KAC3D,CAAA;AAAA,GACF;AACF,CAAA;AAEsB,eAAA,cAAA,CACpB,MACA,EAAA,SAAA,EACA,MACA,EAAA;AACA,EAAI,IAAA;AAEF,IAAA,MAAM,OAAU,GAAA,MAAM,MAAO,CAAA,QAAA,CAAS,KAAK,SAAS,CAAA,CAAA;AACpD,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,mBAAmB,SAAS,CAAA,uCAAA,CAAA;AAAA,OAC9B,CAAA;AAAA,KACF;AACA,IAAA,MAAM,iBAAiB,MAAM,sBAAA;AAAA,MAC3B,MAAA;AAAA,MACA,QAAQ,SAAU,CAAA,EAAA;AAAA,KACpB,CAAA;AACA,IAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,MAAM,MAAA,IAAIA,kBAAW,CAAkD,gDAAA,CAAA,CAAA,CAAA;AAAA,KACzE;AAEA,IAAA,MAAM,QAAQ,MAAM,MAAA,CAAO,MAAM,GAAI,CAAA,cAAA,CAAe,EAAE,CAAG,EAAA,IAAA;AAAA,MACvD,CAAC,CAAW,KAAA,CAAA,CAAE,EAAO,KAAA,MAAA;AAAA,KACvB,CAAA;AACA,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,CAAgB,aAAA,EAAA,MAAM,CAA4C,yCAAA,EAAA,cAAA,CAAe,IAAI,CAAA,CAAA,CAAA;AAAA,OACvF,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,YAAY,MAAM,MAAA,CAAO,MAAO,CAAA,IAAA,CAAK,KAAK,QAAkB,CAAA,CAAA;AAClE,IAAA,MAAM,mBAA2B,OAAQ,CAAA,mBAAA,CAAA;AACzC,IAAO,OAAA,gBAAA,CAAiB,UAAW,CAAA,SAAA,CAAU,SAAmB,CAAA,CAAA;AAAA,WACzD,KAAY,EAAA;AACnB,IAAA,MAAM,IAAIA,iBAAA,CAAW,CAA8B,2BAAA,EAAA,KAAA,CAAM,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,GACpE;AACF;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-gitlab",
-  "version": "0.5.1-next.1",
+  "version": "0.6.0-next.2",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "scaffolder",
@@ -44,11 +44,11 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "1.0.1-next.0",
+    "@backstage/backend-plugin-api": "1.0.1-next.1",
     "@backstage/config": "1.2.0",
     "@backstage/errors": "1.2.4",
-    "@backstage/integration": "1.15.1-next.0",
-    "@backstage/plugin-scaffolder-node": "0.5.0-next.1",
+    "@backstage/integration": "1.15.1-next.1",
+    "@backstage/plugin-scaffolder-node": "0.5.0-next.2",
     "@gitbeaker/core": "^35.8.0",
     "@gitbeaker/node": "^35.8.0",
     "@gitbeaker/rest": "^39.25.0",
@@ -57,9 +57,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.1-next.1",
-    "@backstage/cli": "0.28.0-next.1",
+    "@backstage/backend-test-utils": "1.0.1-next.2",
+    "@backstage/cli": "0.28.0-next.2",
     "@backstage/core-app-api": "1.15.1-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.1.13-next.1"
+    "@backstage/plugin-scaffolder-node-test-utils": "0.1.13-next.2"
   }
 }