@backstage/plugin-scaffolder-node 0.12.6-next.0 → 0.13.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.13.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-test-utils@1.11.1-next.2
+  - @backstage/backend-plugin-api@1.8.0-next.1
+  - @backstage/integration@2.0.0-next.2
+  - @backstage/plugin-scaffolder-common@2.0.0-next.2
+
+## 0.13.0-next.1
+
+### Minor Changes
+
+- e27bd4e: **BREAKING** Removed deprecated `bitbucket` integration from being used in the `parseRepoUrl` function. It will use the `bitbucketCloud` or `bitbucketServer` integrations instead.
+
+### Patch Changes
+
+- f598909: Added `scaffolderServiceRef` and `ScaffolderService` interface for backend plugins that need to interact with the scaffolder API using `BackstageCredentials` instead of raw tokens.
+- Updated dependencies
+  - @backstage/backend-test-utils@1.11.1-next.1
+  - @backstage/integration@2.0.0-next.1
+  - @backstage/plugin-scaffolder-common@2.0.0-next.1
+  - @backstage/backend-plugin-api@1.7.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.2
+  - @backstage/plugin-permission-common@0.9.6
+
 ## 0.12.6-next.0
 
 ### Patch Changes

package/dist/actions/util.cjs.js

@@ -48,10 +48,11 @@ const parseRepoUrl = (repoUrl, integrations) => {
     ])
   );
   switch (type) {
-    case "bitbucket": {
-      if (host === "www.bitbucket.org") {
-        checkRequiredParams(parsed, "workspace");
-      }
+    case "bitbucketCloud": {
+      checkRequiredParams(parsed, "workspace", "project", "repo");
+      break;
+    }
+    case "bitbucketServer": {
       checkRequiredParams(parsed, "project", "repo");
       break;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"util.cjs.js","sources":["../../src/actions/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 { isChildPath } from '@backstage/backend-plugin-api';\nimport { join as joinPath, normalize as normalizePath } from 'node:path';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { TemplateActionOptions } from './createTemplateAction';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { z } from 'zod';\nimport { Schema } from 'jsonschema';\nimport { trim } from 'lodash';\n\n/**\n * @public\n */\nexport const getRepoSourceDirectory = (\n  workspacePath: string,\n  sourcePath: string | undefined,\n) => {\n  if (sourcePath) {\n    const safeSuffix = normalizePath(sourcePath).replace(\n      /^(\\.\\.(\\/|\\\\|$))+/,\n      '',\n    );\n    const path = joinPath(workspacePath, safeSuffix);\n    if (!isChildPath(workspacePath, path)) {\n      throw new Error('Invalid source path');\n    }\n    return path;\n  }\n  return workspacePath;\n};\n\n/**\n * @public\n */\nexport const parseRepoUrl = (\n  repoUrl: string,\n  integrations: ScmIntegrationRegistry,\n): {\n  repo: string;\n  host: string;\n  owner?: string;\n  organization?: string;\n  workspace?: string;\n  project?: string;\n} => {\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 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  const { owner, organization, workspace, project, repo } = Object.fromEntries(\n    ['owner', 'organization', 'workspace', 'project', 'repo'].map(param => [\n      param,\n      parsed.searchParams.has(param)\n        ? trim(parsed.searchParams.get(param)!, '/')\n        : undefined,\n    ]),\n  );\n  switch (type) {\n    case 'bitbucket': {\n      if (host === 'www.bitbucket.org') {\n        checkRequiredParams(parsed, 'workspace');\n      }\n      checkRequiredParams(parsed, 'project', 'repo');\n      break;\n    }\n    case 'azure': {\n      checkRequiredParams(parsed, 'project', 'repo');\n      break;\n    }\n    case 'gitlab': {\n      // project is the projectID, and if defined, owner and repo won't be needed.\n      if (!project) {\n        checkRequiredParams(parsed, 'owner', 'repo');\n      }\n      break;\n    }\n    case 'gitea': {\n      checkRequiredParams(parsed, 'repo');\n      break;\n    }\n    case 'gerrit': {\n      checkRequiredParams(parsed, 'repo');\n      break;\n    }\n    default: {\n      checkRequiredParams(parsed, 'repo', 'owner');\n      break;\n    }\n  }\n  return { host, owner, repo: repo!, organization, workspace, project };\n};\n\nfunction checkRequiredParams(repoUrl: URL, ...params: string[]) {\n  for (let i = 0; i < params.length; i++) {\n    if (!repoUrl.searchParams.get(params[i])) {\n      throw new InputError(\n        `Invalid repo URL passed to publisher: ${repoUrl.toString()}, missing ${\n          params[i]\n        }`,\n      );\n    }\n  }\n}\n\nconst isKeyValueZodCallback = (\n  schema: unknown,\n): schema is { [key in string]: (zImpl: typeof z) => z.ZodType } => {\n  return (\n    typeof schema === 'object' &&\n    !!schema &&\n    Object.values(schema).every(v => typeof v === 'function')\n  );\n};\n\nconst isZodFunctionDefinition = (\n  schema: unknown,\n): schema is (zImpl: typeof z) => z.ZodType => {\n  return typeof schema === 'function';\n};\n\nexport const parseSchemas = (\n  action: TemplateActionOptions<any, any, any>,\n): { inputSchema?: Schema; outputSchema?: Schema } => {\n  if (!action.schema) {\n    return { inputSchema: undefined, outputSchema: undefined };\n  }\n\n  if (isKeyValueZodCallback(action.schema.input)) {\n    const input = z.object(\n      Object.fromEntries(\n        Object.entries(action.schema.input).map(([k, v]) => [k, v(z)]),\n      ),\n    );\n\n    return {\n      inputSchema: zodToJsonSchema(input) as Schema,\n      outputSchema: isKeyValueZodCallback(action.schema.output)\n        ? (zodToJsonSchema(\n            z.object(\n              Object.fromEntries(\n                Object.entries(action.schema.output).map(([k, v]) => [k, v(z)]),\n              ),\n            ),\n          ) as Schema)\n        : undefined,\n    };\n  }\n\n  if (isZodFunctionDefinition(action.schema.input)) {\n    return {\n      inputSchema: zodToJsonSchema(action.schema.input(z)) as Schema,\n      outputSchema: isZodFunctionDefinition(action.schema.output)\n        ? (zodToJsonSchema(action.schema.output(z)) as Schema)\n        : undefined,\n    };\n  }\n\n  return {\n    inputSchema: undefined,\n    outputSchema: undefined,\n  };\n};\n\n/**\n * Filter function to exclude the .git directory and its contents\n * while keeping other files like .gitignore\n * @public\n */\nexport function isNotGitDirectoryOrContents(path: string): boolean {\n  return !(path.endsWith('.git') || path.includes('.git/'));\n}\n"],"names":["normalizePath","path","joinPath","isChildPath","InputError","trim","z","zodToJsonSchema"],"mappings":";;;;;;;;;;;;;AA6BO,MAAM,sBAAA,GAAyB,CACpC,aAAA,EACA,UAAA,KACG;AACH,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,MAAM,UAAA,GAAaA,cAAA,CAAc,UAAU,CAAA,CAAE,OAAA;AAAA,MAC3C,mBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAMC,MAAA,GAAOC,SAAA,CAAS,aAAA,EAAe,UAAU,CAAA;AAC/C,IAAA,IAAI,CAACC,4BAAA,CAAY,aAAA,EAAeF,MAAI,CAAA,EAAG;AACrC,MAAA,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAAA,IACvC;AACA,IAAA,OAAOA,MAAA;AAAA,EACT;AACA,EAAA,OAAO,aAAA;AACT;AAKO,MAAM,YAAA,GAAe,CAC1B,OAAA,EACA,YAAA,KAQG;AACH,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,IAAIG,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,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;AACA,EAAA,MAAM,EAAE,KAAA,EAAO,YAAA,EAAc,WAAW,OAAA,EAAS,IAAA,KAAS,MAAA,CAAO,WAAA;AAAA,IAC/D,CAAC,SAAS,cAAA,EAAgB,WAAA,EAAa,WAAW,MAAM,CAAA,CAAE,IAAI,CAAA,KAAA,KAAS;AAAA,MACrE,KAAA;AAAA,MACA,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA,GACzBC,WAAA,CAAK,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA,EAAI,GAAG,CAAA,GACzC;AAAA,KACL;AAAA,GACH;AACA,EAAA,QAAQ,IAAA;AAAM,IACZ,KAAK,WAAA,EAAa;AAChB,MAAA,IAAI,SAAS,mBAAA,EAAqB;AAChC,QAAA,mBAAA,CAAoB,QAAQ,WAAW,CAAA;AAAA,MACzC;AACA,MAAA,mBAAA,CAAoB,MAAA,EAAQ,WAAW,MAAM,CAAA;AAC7C,MAAA;AAAA,IACF;AAAA,IACA,KAAK,OAAA,EAAS;AACZ,MAAA,mBAAA,CAAoB,MAAA,EAAQ,WAAW,MAAM,CAAA;AAC7C,MAAA;AAAA,IACF;AAAA,IACA,KAAK,QAAA,EAAU;AAEb,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,mBAAA,CAAoB,MAAA,EAAQ,SAAS,MAAM,CAAA;AAAA,MAC7C;AACA,MAAA;AAAA,IACF;AAAA,IACA,KAAK,OAAA,EAAS;AACZ,MAAA,mBAAA,CAAoB,QAAQ,MAAM,CAAA;AAClC,MAAA;AAAA,IACF;AAAA,IACA,KAAK,QAAA,EAAU;AACb,MAAA,mBAAA,CAAoB,QAAQ,MAAM,CAAA;AAClC,MAAA;AAAA,IACF;AAAA,IACA,SAAS;AACP,MAAA,mBAAA,CAAoB,MAAA,EAAQ,QAAQ,OAAO,CAAA;AAC3C,MAAA;AAAA,IACF;AAAA;AAEF,EAAA,OAAO,EAAE,IAAA,EAAM,KAAA,EAAO,IAAA,EAAa,YAAA,EAAc,WAAW,OAAA,EAAQ;AACtE;AAEA,SAAS,mBAAA,CAAoB,YAAiB,MAAA,EAAkB;AAC9D,EAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,MAAA,CAAO,QAAQ,CAAA,EAAA,EAAK;AACtC,IAAA,IAAI,CAAC,OAAA,CAAQ,YAAA,CAAa,IAAI,MAAA,CAAO,CAAC,CAAC,CAAA,EAAG;AACxC,MAAA,MAAM,IAAID,iBAAA;AAAA,QACR,yCAAyC,OAAA,CAAQ,QAAA,EAAU,CAAA,UAAA,EACzD,MAAA,CAAO,CAAC,CACV,CAAA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF;AAEA,MAAM,qBAAA,GAAwB,CAC5B,MAAA,KACkE;AAClE,EAAA,OACE,OAAO,MAAA,KAAW,QAAA,IAClB,CAAC,CAAC,MAAA,IACF,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,CAAE,KAAA,CAAM,CAAA,CAAA,KAAK,OAAO,MAAM,UAAU,CAAA;AAE5D,CAAA;AAEA,MAAM,uBAAA,GAA0B,CAC9B,MAAA,KAC6C;AAC7C,EAAA,OAAO,OAAO,MAAA,KAAW,UAAA;AAC3B,CAAA;AAEO,MAAM,YAAA,GAAe,CAC1B,MAAA,KACoD;AACpD,EAAA,IAAI,CAAC,OAAO,MAAA,EAAQ;AAClB,IAAA,OAAO,EAAE,WAAA,EAAa,MAAA,EAAW,YAAA,EAAc,MAAA,EAAU;AAAA,EAC3D;AAEA,EAAA,IAAI,qBAAA,CAAsB,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,EAAG;AAC9C,IAAA,MAAM,QAAQE,KAAA,CAAE,MAAA;AAAA,MACd,MAAA,CAAO,WAAA;AAAA,QACL,OAAO,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,KAAK,EAAE,GAAA,CAAI,CAAC,CAAC,CAAA,EAAG,CAAC,CAAA,KAAM,CAAC,GAAG,CAAA,CAAEA,KAAC,CAAC,CAAC;AAAA;AAC/D,KACF;AAEA,IAAA,OAAO;AAAA,MACL,WAAA,EAAaC,iCAAgB,KAAK,CAAA;AAAA,MAClC,YAAA,EAAc,qBAAA,CAAsB,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,GACnDA,gCAAA;AAAA,QACCD,KAAA,CAAE,MAAA;AAAA,UACA,MAAA,CAAO,WAAA;AAAA,YACL,OAAO,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,MAAM,EAAE,GAAA,CAAI,CAAC,CAAC,CAAA,EAAG,CAAC,CAAA,KAAM,CAAC,GAAG,CAAA,CAAEA,KAAC,CAAC,CAAC;AAAA;AAChE;AACF,OACF,GACA;AAAA,KACN;AAAA,EACF;AAEA,EAAA,IAAI,uBAAA,CAAwB,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,EAAG;AAChD,IAAA,OAAO;AAAA,MACL,aAAaC,gCAAA,CAAgB,MAAA,CAAO,MAAA,CAAO,KAAA,CAAMD,KAAC,CAAC,CAAA;AAAA,MACnD,YAAA,EAAc,uBAAA,CAAwB,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,GACrDC,gCAAA,CAAgB,MAAA,CAAO,MAAA,CAAO,MAAA,CAAOD,KAAC,CAAC,CAAA,GACxC;AAAA,KACN;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,WAAA,EAAa,MAAA;AAAA,IACb,YAAA,EAAc;AAAA,GAChB;AACF;AAOO,SAAS,4BAA4B,IAAA,EAAuB;AACjE,EAAA,OAAO,EAAE,IAAA,CAAK,QAAA,CAAS,MAAM,CAAA,IAAK,IAAA,CAAK,SAAS,OAAO,CAAA,CAAA;AACzD;;;;;;;"}
+{"version":3,"file":"util.cjs.js","sources":["../../src/actions/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 { isChildPath } from '@backstage/backend-plugin-api';\nimport { join as joinPath, normalize as normalizePath } from 'node:path';\nimport { ScmIntegrationRegistry } from '@backstage/integration';\nimport { TemplateActionOptions } from './createTemplateAction';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { z } from 'zod';\nimport { Schema } from 'jsonschema';\nimport { trim } from 'lodash';\n\n/**\n * @public\n */\nexport const getRepoSourceDirectory = (\n  workspacePath: string,\n  sourcePath: string | undefined,\n) => {\n  if (sourcePath) {\n    const safeSuffix = normalizePath(sourcePath).replace(\n      /^(\\.\\.(\\/|\\\\|$))+/,\n      '',\n    );\n    const path = joinPath(workspacePath, safeSuffix);\n    if (!isChildPath(workspacePath, path)) {\n      throw new Error('Invalid source path');\n    }\n    return path;\n  }\n  return workspacePath;\n};\n\n/**\n * @public\n */\nexport const parseRepoUrl = (\n  repoUrl: string,\n  integrations: ScmIntegrationRegistry,\n): {\n  repo: string;\n  host: string;\n  owner?: string;\n  organization?: string;\n  workspace?: string;\n  project?: string;\n} => {\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 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  const { owner, organization, workspace, project, repo } = Object.fromEntries(\n    ['owner', 'organization', 'workspace', 'project', 'repo'].map(param => [\n      param,\n      parsed.searchParams.has(param)\n        ? trim(parsed.searchParams.get(param)!, '/')\n        : undefined,\n    ]),\n  );\n  switch (type) {\n    case 'bitbucketCloud': {\n      checkRequiredParams(parsed, 'workspace', 'project', 'repo');\n      break;\n    }\n    case 'bitbucketServer': {\n      checkRequiredParams(parsed, 'project', 'repo');\n      break;\n    }\n    case 'azure': {\n      checkRequiredParams(parsed, 'project', 'repo');\n      break;\n    }\n    case 'gitlab': {\n      // project is the projectID, and if defined, owner and repo won't be needed.\n      if (!project) {\n        checkRequiredParams(parsed, 'owner', 'repo');\n      }\n      break;\n    }\n    case 'gitea': {\n      checkRequiredParams(parsed, 'repo');\n      break;\n    }\n    case 'gerrit': {\n      checkRequiredParams(parsed, 'repo');\n      break;\n    }\n    default: {\n      checkRequiredParams(parsed, 'repo', 'owner');\n      break;\n    }\n  }\n  return { host, owner, repo: repo!, organization, workspace, project };\n};\n\nfunction checkRequiredParams(repoUrl: URL, ...params: string[]) {\n  for (let i = 0; i < params.length; i++) {\n    if (!repoUrl.searchParams.get(params[i])) {\n      throw new InputError(\n        `Invalid repo URL passed to publisher: ${repoUrl.toString()}, missing ${\n          params[i]\n        }`,\n      );\n    }\n  }\n}\n\nconst isKeyValueZodCallback = (\n  schema: unknown,\n): schema is { [key in string]: (zImpl: typeof z) => z.ZodType } => {\n  return (\n    typeof schema === 'object' &&\n    !!schema &&\n    Object.values(schema).every(v => typeof v === 'function')\n  );\n};\n\nconst isZodFunctionDefinition = (\n  schema: unknown,\n): schema is (zImpl: typeof z) => z.ZodType => {\n  return typeof schema === 'function';\n};\n\nexport const parseSchemas = (\n  action: TemplateActionOptions<any, any, any>,\n): { inputSchema?: Schema; outputSchema?: Schema } => {\n  if (!action.schema) {\n    return { inputSchema: undefined, outputSchema: undefined };\n  }\n\n  if (isKeyValueZodCallback(action.schema.input)) {\n    const input = z.object(\n      Object.fromEntries(\n        Object.entries(action.schema.input).map(([k, v]) => [k, v(z)]),\n      ),\n    );\n\n    return {\n      inputSchema: zodToJsonSchema(input) as Schema,\n      outputSchema: isKeyValueZodCallback(action.schema.output)\n        ? (zodToJsonSchema(\n            z.object(\n              Object.fromEntries(\n                Object.entries(action.schema.output).map(([k, v]) => [k, v(z)]),\n              ),\n            ),\n          ) as Schema)\n        : undefined,\n    };\n  }\n\n  if (isZodFunctionDefinition(action.schema.input)) {\n    return {\n      inputSchema: zodToJsonSchema(action.schema.input(z)) as Schema,\n      outputSchema: isZodFunctionDefinition(action.schema.output)\n        ? (zodToJsonSchema(action.schema.output(z)) as Schema)\n        : undefined,\n    };\n  }\n\n  return {\n    inputSchema: undefined,\n    outputSchema: undefined,\n  };\n};\n\n/**\n * Filter function to exclude the .git directory and its contents\n * while keeping other files like .gitignore\n * @public\n */\nexport function isNotGitDirectoryOrContents(path: string): boolean {\n  return !(path.endsWith('.git') || path.includes('.git/'));\n}\n"],"names":["normalizePath","path","joinPath","isChildPath","InputError","trim","z","zodToJsonSchema"],"mappings":";;;;;;;;;;;;;AA6BO,MAAM,sBAAA,GAAyB,CACpC,aAAA,EACA,UAAA,KACG;AACH,EAAA,IAAI,UAAA,EAAY;AACd,IAAA,MAAM,UAAA,GAAaA,cAAA,CAAc,UAAU,CAAA,CAAE,OAAA;AAAA,MAC3C,mBAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAMC,MAAA,GAAOC,SAAA,CAAS,aAAA,EAAe,UAAU,CAAA;AAC/C,IAAA,IAAI,CAACC,4BAAA,CAAY,aAAA,EAAeF,MAAI,CAAA,EAAG;AACrC,MAAA,MAAM,IAAI,MAAM,qBAAqB,CAAA;AAAA,IACvC;AACA,IAAA,OAAOA,MAAA;AAAA,EACT;AACA,EAAA,OAAO,aAAA;AACT;AAKO,MAAM,YAAA,GAAe,CAC1B,OAAA,EACA,YAAA,KAQG;AACH,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,IAAIG,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,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;AACA,EAAA,MAAM,EAAE,KAAA,EAAO,YAAA,EAAc,WAAW,OAAA,EAAS,IAAA,KAAS,MAAA,CAAO,WAAA;AAAA,IAC/D,CAAC,SAAS,cAAA,EAAgB,WAAA,EAAa,WAAW,MAAM,CAAA,CAAE,IAAI,CAAA,KAAA,KAAS;AAAA,MACrE,KAAA;AAAA,MACA,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA,GACzBC,WAAA,CAAK,MAAA,CAAO,YAAA,CAAa,GAAA,CAAI,KAAK,CAAA,EAAI,GAAG,CAAA,GACzC;AAAA,KACL;AAAA,GACH;AACA,EAAA,QAAQ,IAAA;AAAM,IACZ,KAAK,gBAAA,EAAkB;AACrB,MAAA,mBAAA,CAAoB,MAAA,EAAQ,WAAA,EAAa,SAAA,EAAW,MAAM,CAAA;AAC1D,MAAA;AAAA,IACF;AAAA,IACA,KAAK,iBAAA,EAAmB;AACtB,MAAA,mBAAA,CAAoB,MAAA,EAAQ,WAAW,MAAM,CAAA;AAC7C,MAAA;AAAA,IACF;AAAA,IACA,KAAK,OAAA,EAAS;AACZ,MAAA,mBAAA,CAAoB,MAAA,EAAQ,WAAW,MAAM,CAAA;AAC7C,MAAA;AAAA,IACF;AAAA,IACA,KAAK,QAAA,EAAU;AAEb,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,mBAAA,CAAoB,MAAA,EAAQ,SAAS,MAAM,CAAA;AAAA,MAC7C;AACA,MAAA;AAAA,IACF;AAAA,IACA,KAAK,OAAA,EAAS;AACZ,MAAA,mBAAA,CAAoB,QAAQ,MAAM,CAAA;AAClC,MAAA;AAAA,IACF;AAAA,IACA,KAAK,QAAA,EAAU;AACb,MAAA,mBAAA,CAAoB,QAAQ,MAAM,CAAA;AAClC,MAAA;AAAA,IACF;AAAA,IACA,SAAS;AACP,MAAA,mBAAA,CAAoB,MAAA,EAAQ,QAAQ,OAAO,CAAA;AAC3C,MAAA;AAAA,IACF;AAAA;AAEF,EAAA,OAAO,EAAE,IAAA,EAAM,KAAA,EAAO,IAAA,EAAa,YAAA,EAAc,WAAW,OAAA,EAAQ;AACtE;AAEA,SAAS,mBAAA,CAAoB,YAAiB,MAAA,EAAkB;AAC9D,EAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,MAAA,CAAO,QAAQ,CAAA,EAAA,EAAK;AACtC,IAAA,IAAI,CAAC,OAAA,CAAQ,YAAA,CAAa,IAAI,MAAA,CAAO,CAAC,CAAC,CAAA,EAAG;AACxC,MAAA,MAAM,IAAID,iBAAA;AAAA,QACR,yCAAyC,OAAA,CAAQ,QAAA,EAAU,CAAA,UAAA,EACzD,MAAA,CAAO,CAAC,CACV,CAAA;AAAA,OACF;AAAA,IACF;AAAA,EACF;AACF;AAEA,MAAM,qBAAA,GAAwB,CAC5B,MAAA,KACkE;AAClE,EAAA,OACE,OAAO,MAAA,KAAW,QAAA,IAClB,CAAC,CAAC,MAAA,IACF,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,CAAE,KAAA,CAAM,CAAA,CAAA,KAAK,OAAO,MAAM,UAAU,CAAA;AAE5D,CAAA;AAEA,MAAM,uBAAA,GAA0B,CAC9B,MAAA,KAC6C;AAC7C,EAAA,OAAO,OAAO,MAAA,KAAW,UAAA;AAC3B,CAAA;AAEO,MAAM,YAAA,GAAe,CAC1B,MAAA,KACoD;AACpD,EAAA,IAAI,CAAC,OAAO,MAAA,EAAQ;AAClB,IAAA,OAAO,EAAE,WAAA,EAAa,MAAA,EAAW,YAAA,EAAc,MAAA,EAAU;AAAA,EAC3D;AAEA,EAAA,IAAI,qBAAA,CAAsB,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,EAAG;AAC9C,IAAA,MAAM,QAAQE,KAAA,CAAE,MAAA;AAAA,MACd,MAAA,CAAO,WAAA;AAAA,QACL,OAAO,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,KAAK,EAAE,GAAA,CAAI,CAAC,CAAC,CAAA,EAAG,CAAC,CAAA,KAAM,CAAC,GAAG,CAAA,CAAEA,KAAC,CAAC,CAAC;AAAA;AAC/D,KACF;AAEA,IAAA,OAAO;AAAA,MACL,WAAA,EAAaC,iCAAgB,KAAK,CAAA;AAAA,MAClC,YAAA,EAAc,qBAAA,CAAsB,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,GACnDA,gCAAA;AAAA,QACCD,KAAA,CAAE,MAAA;AAAA,UACA,MAAA,CAAO,WAAA;AAAA,YACL,OAAO,OAAA,CAAQ,MAAA,CAAO,MAAA,CAAO,MAAM,EAAE,GAAA,CAAI,CAAC,CAAC,CAAA,EAAG,CAAC,CAAA,KAAM,CAAC,GAAG,CAAA,CAAEA,KAAC,CAAC,CAAC;AAAA;AAChE;AACF,OACF,GACA;AAAA,KACN;AAAA,EACF;AAEA,EAAA,IAAI,uBAAA,CAAwB,MAAA,CAAO,MAAA,CAAO,KAAK,CAAA,EAAG;AAChD,IAAA,OAAO;AAAA,MACL,aAAaC,gCAAA,CAAgB,MAAA,CAAO,MAAA,CAAO,KAAA,CAAMD,KAAC,CAAC,CAAA;AAAA,MACnD,YAAA,EAAc,uBAAA,CAAwB,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA,GACrDC,gCAAA,CAAgB,MAAA,CAAO,MAAA,CAAO,MAAA,CAAOD,KAAC,CAAC,CAAA,GACxC;AAAA,KACN;AAAA,EACF;AAEA,EAAA,OAAO;AAAA,IACL,WAAA,EAAa,MAAA;AAAA,IACb,YAAA,EAAc;AAAA,GAChB;AACF;AAOO,SAAS,4BAA4B,IAAA,EAAuB;AACjE,EAAA,OAAO,EAAE,IAAA,CAAK,QAAA,CAAS,MAAM,CAAA,IAAK,IAAA,CAAK,SAAS,OAAO,CAAA,CAAA;AACzD;;;;;;;"}

package/dist/index.cjs.js

@@ -8,6 +8,7 @@ var util = require('./actions/util.cjs.js');
 var serializeDirectoryContents = require('./files/serializeDirectoryContents.cjs.js');
 var deserializeDirectoryContents = require('./files/deserializeDirectoryContents.cjs.js');
 var extensions = require('./extensions.cjs.js');
+var scaffolderService = require('./scaffolderService.cjs.js');
 
 
 
@@ -27,4 +28,5 @@ exports.parseRepoUrl = util.parseRepoUrl;
 exports.serializeDirectoryContents = serializeDirectoryContents.serializeDirectoryContents;
 exports.deserializeDirectoryContents = deserializeDirectoryContents.deserializeDirectoryContents;
 exports.scaffolderActionsExtensionPoint = extensions.scaffolderActionsExtensionPoint;
+exports.scaffolderServiceRef = scaffolderService.scaffolderServiceRef;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import { SpawnOptionsWithoutStdio } from 'node:child_process';
 import { Writable } from 'node:stream';
 import { ScmIntegrations, ScmIntegrationRegistry } from '@backstage/integration';
 export { T as TemplateFilter, a as TemplateGlobal } from './types/types.d-C0fXdKnD.js';
+export { a as ScaffolderService, S as ScaffolderServiceRequestOptions, s as scaffolderServiceRef } from './types/scaffolderService.d-BC_MUrKh.js';
 
 /**
  * TaskSecrets

package/dist/scaffolderService.cjs.js

@@ -0,0 +1,141 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var errors = require('@backstage/errors');
+var integration = require('@backstage/integration');
+var pluginScaffolderCommon = require('@backstage/plugin-scaffolder-common');
+
+class DefaultScaffolderService {
+  #auth;
+  #client;
+  #discovery;
+  constructor(options) {
+    this.#auth = options.auth;
+    this.#client = options.client;
+    this.#discovery = options.discovery;
+  }
+  async getTemplateParameterSchema(request, options) {
+    return this.#client.getTemplateParameterSchema(
+      request.templateRef,
+      await this.#getOptions(options)
+    );
+  }
+  async scaffold(request, options) {
+    return this.#client.scaffold(request, await this.#getOptions(options));
+  }
+  async getTask(request, options) {
+    return this.#client.getTask(
+      request.taskId,
+      await this.#getOptions(options)
+    );
+  }
+  async cancelTask(request, options) {
+    return this.#client.cancelTask(
+      request.taskId,
+      await this.#getOptions(options)
+    );
+  }
+  async retry(request, options) {
+    return this.#client.retry(request.taskId, await this.#getOptions(options));
+  }
+  async listTasks(request, options) {
+    const { token } = await this.#getOptions(options);
+    const baseUrl = await this.#discovery.getBaseUrl("scaffolder");
+    const params = new URLSearchParams();
+    if (request.createdBy) {
+      params.set("createdBy", request.createdBy);
+    }
+    if (request.limit !== void 0) {
+      params.set("limit", String(request.limit));
+    }
+    if (request.offset !== void 0) {
+      params.set("offset", String(request.offset));
+    }
+    const query = params.toString();
+    const url = `${baseUrl}/v2/tasks${query ? `?${query}` : ""}`;
+    const response = await fetch(url, {
+      headers: {
+        "Content-Type": "application/json",
+        ...token && { Authorization: `Bearer ${token}` }
+      }
+    });
+    if (!response.ok) {
+      throw await errors.ResponseError.fromResponse(response);
+    }
+    const body = await response.json();
+    return {
+      items: body.tasks,
+      totalItems: body.totalTasks ?? 0
+    };
+  }
+  async listActions(_request, options) {
+    return this.#client.listActions(
+      options ? await this.#getOptions(options) : {}
+    );
+  }
+  async listTemplatingExtensions(_request, options) {
+    return this.#client.listTemplatingExtensions(
+      options ? await this.#getOptions(options) : {}
+    );
+  }
+  async getLogs(request, options) {
+    const { token } = await this.#getOptions(options);
+    const baseUrl = await this.#discovery.getBaseUrl("scaffolder");
+    const params = new URLSearchParams();
+    if (request.after !== void 0) {
+      params.set("after", String(request.after));
+    }
+    const query = params.toString();
+    const taskId = encodeURIComponent(request.taskId);
+    const url = `${baseUrl}/v2/tasks/${taskId}/events${query ? `?${query}` : ""}`;
+    const response = await fetch(url, {
+      headers: {
+        "Content-Type": "application/json",
+        ...token && { Authorization: `Bearer ${token}` }
+      }
+    });
+    if (!response.ok) {
+      throw await errors.ResponseError.fromResponse(response);
+    }
+    return response.json();
+  }
+  async dryRun(request, options) {
+    return this.#client.dryRun(request, await this.#getOptions(options));
+  }
+  async autocomplete(request, options) {
+    return this.#client.autocomplete(request, await this.#getOptions(options));
+  }
+  async #getOptions(options) {
+    return this.#auth.getPluginRequestToken({
+      onBehalfOf: options.credentials,
+      targetPluginId: "scaffolder"
+    });
+  }
+}
+const scaffolderServiceRef = backendPluginApi.createServiceRef({
+  id: "scaffolder-client",
+  defaultFactory: async (service) => backendPluginApi.createServiceFactory({
+    service,
+    deps: {
+      auth: backendPluginApi.coreServices.auth,
+      discovery: backendPluginApi.coreServices.discovery,
+      config: backendPluginApi.coreServices.rootConfig
+    },
+    async factory({ auth, discovery, config }) {
+      const integrations = integration.ScmIntegrations.fromConfig(config);
+      const client = new pluginScaffolderCommon.ScaffolderClient({
+        discoveryApi: discovery,
+        fetchApi: { fetch },
+        scmIntegrationsApi: integrations
+      });
+      return new DefaultScaffolderService({
+        auth,
+        client,
+        discovery
+      });
+    }
+  })
+});
+
+exports.scaffolderServiceRef = scaffolderServiceRef;
+//# sourceMappingURL=scaffolderService.cjs.js.map

package/dist/scaffolderService.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffolderService.cjs.js","sources":["../src/scaffolderService.ts"],"sourcesContent":["/*\n * Copyright 2025 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 {\n  AuthService,\n  BackstageCredentials,\n  coreServices,\n  createServiceFactory,\n  createServiceRef,\n  DiscoveryService,\n} from '@backstage/backend-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n  ListActionsResponse,\n  ListTemplatingExtensionsResponse,\n  LogEvent,\n  ScaffolderClient,\n  ScaffolderDryRunOptions,\n  ScaffolderDryRunResponse,\n  ScaffolderRequestOptions,\n  ScaffolderScaffoldOptions,\n  ScaffolderScaffoldResponse,\n  ScaffolderTask,\n  ScaffolderTaskStatus,\n} from '@backstage/plugin-scaffolder-common';\nimport type { TemplateParameterSchema } from '@backstage/plugin-scaffolder-common';\n\n/**\n * @public\n */\nexport interface ScaffolderServiceRequestOptions {\n  credentials: BackstageCredentials;\n}\n\n/**\n * A backend service interface for the scaffolder that uses\n * {@link @backstage/backend-plugin-api#BackstageCredentials} instead of tokens.\n *\n * @public\n */\nexport interface ScaffolderService {\n  getTemplateParameterSchema(\n    request: { templateRef: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<TemplateParameterSchema>;\n\n  scaffold(\n    request: ScaffolderScaffoldOptions,\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderScaffoldResponse>;\n\n  getTask(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderTask>;\n\n  cancelTask(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ status?: ScaffolderTaskStatus }>;\n\n  retry(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ id: string }>;\n\n  listTasks(\n    request: {\n      createdBy?: string;\n      limit?: number;\n      offset?: number;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ items: ScaffolderTask[]; totalItems: number }>;\n\n  listActions(\n    request?: {},\n    options?: ScaffolderServiceRequestOptions,\n  ): Promise<ListActionsResponse>;\n\n  listTemplatingExtensions(\n    request?: {},\n    options?: ScaffolderServiceRequestOptions,\n  ): Promise<ListTemplatingExtensionsResponse>;\n\n  getLogs(\n    request: {\n      taskId: string;\n      after?: number;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<LogEvent[]>;\n\n  dryRun(\n    request: ScaffolderDryRunOptions,\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderDryRunResponse>;\n\n  autocomplete(\n    request: {\n      token: string;\n      provider: string;\n      resource: string;\n      context: Record<string, string>;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ results: { title?: string; id: string }[] }>;\n}\n\nclass DefaultScaffolderService implements ScaffolderService {\n  readonly #auth: AuthService;\n  readonly #client: ScaffolderClient;\n  readonly #discovery: DiscoveryService;\n\n  constructor(options: {\n    auth: AuthService;\n    client: ScaffolderClient;\n    discovery: DiscoveryService;\n  }) {\n    this.#auth = options.auth;\n    this.#client = options.client;\n    this.#discovery = options.discovery;\n  }\n\n  async getTemplateParameterSchema(\n    request: { templateRef: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<TemplateParameterSchema> {\n    return this.#client.getTemplateParameterSchema(\n      request.templateRef,\n      await this.#getOptions(options),\n    );\n  }\n\n  async scaffold(\n    request: ScaffolderScaffoldOptions,\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderScaffoldResponse> {\n    return this.#client.scaffold(request, await this.#getOptions(options));\n  }\n\n  async getTask(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderTask> {\n    return this.#client.getTask(\n      request.taskId,\n      await this.#getOptions(options),\n    );\n  }\n\n  async cancelTask(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ status?: ScaffolderTaskStatus }> {\n    return this.#client.cancelTask(\n      request.taskId,\n      await this.#getOptions(options),\n    );\n  }\n\n  async retry(\n    request: { taskId: string },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ id: string }> {\n    return this.#client.retry(request.taskId, await this.#getOptions(options));\n  }\n\n  async listTasks(\n    request: {\n      createdBy?: string;\n      limit?: number;\n      offset?: number;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ items: ScaffolderTask[]; totalItems: number }> {\n    const { token } = await this.#getOptions(options);\n    const baseUrl = await this.#discovery.getBaseUrl('scaffolder');\n\n    const params = new URLSearchParams();\n    if (request.createdBy) {\n      params.set('createdBy', request.createdBy);\n    }\n    if (request.limit !== undefined) {\n      params.set('limit', String(request.limit));\n    }\n    if (request.offset !== undefined) {\n      params.set('offset', String(request.offset));\n    }\n\n    const query = params.toString();\n    const url = `${baseUrl}/v2/tasks${query ? `?${query}` : ''}`;\n\n    const response = await fetch(url, {\n      headers: {\n        'Content-Type': 'application/json',\n        ...(token && { Authorization: `Bearer ${token}` }),\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    const body = await response.json();\n    return {\n      items: body.tasks,\n      totalItems: body.totalTasks ?? 0,\n    };\n  }\n\n  async listActions(\n    _request?: {},\n    options?: ScaffolderServiceRequestOptions,\n  ): Promise<ListActionsResponse> {\n    return this.#client.listActions(\n      options ? await this.#getOptions(options) : {},\n    );\n  }\n\n  async listTemplatingExtensions(\n    _request?: {},\n    options?: ScaffolderServiceRequestOptions,\n  ): Promise<ListTemplatingExtensionsResponse> {\n    return this.#client.listTemplatingExtensions(\n      options ? await this.#getOptions(options) : {},\n    );\n  }\n\n  async getLogs(\n    request: {\n      taskId: string;\n      after?: number;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<LogEvent[]> {\n    const { token } = await this.#getOptions(options);\n    const baseUrl = await this.#discovery.getBaseUrl('scaffolder');\n\n    const params = new URLSearchParams();\n    if (request.after !== undefined) {\n      params.set('after', String(request.after));\n    }\n\n    const query = params.toString();\n    const taskId = encodeURIComponent(request.taskId);\n    const url = `${baseUrl}/v2/tasks/${taskId}/events${\n      query ? `?${query}` : ''\n    }`;\n\n    const response = await fetch(url, {\n      headers: {\n        'Content-Type': 'application/json',\n        ...(token && { Authorization: `Bearer ${token}` }),\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    return response.json();\n  }\n\n  async dryRun(\n    request: ScaffolderDryRunOptions,\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderDryRunResponse> {\n    return this.#client.dryRun(request, await this.#getOptions(options));\n  }\n\n  async autocomplete(\n    request: {\n      token: string;\n      provider: string;\n      resource: string;\n      context: Record<string, string>;\n    },\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<{ results: { title?: string; id: string }[] }> {\n    return this.#client.autocomplete(request, await this.#getOptions(options));\n  }\n\n  async #getOptions(\n    options: ScaffolderServiceRequestOptions,\n  ): Promise<ScaffolderRequestOptions> {\n    return this.#auth.getPluginRequestToken({\n      onBehalfOf: options.credentials,\n      targetPluginId: 'scaffolder',\n    });\n  }\n}\n\n/**\n * A service ref for the scaffolder client, to be used by backend plugins\n * and modules that need to interact with the scaffolder API.\n *\n * @public\n */\nexport const scaffolderServiceRef = createServiceRef<ScaffolderService>({\n  id: 'scaffolder-client',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\n        auth: coreServices.auth,\n        discovery: coreServices.discovery,\n        config: coreServices.rootConfig,\n      },\n      async factory({ auth, discovery, config }) {\n        const integrations = ScmIntegrations.fromConfig(config);\n        const client = new ScaffolderClient({\n          discoveryApi: discovery,\n          fetchApi: { fetch },\n          scmIntegrationsApi: integrations,\n        });\n        return new DefaultScaffolderService({\n          auth,\n          client,\n          discovery,\n        });\n      },\n    }),\n});\n"],"names":["ResponseError","createServiceRef","createServiceFactory","coreServices","ScmIntegrations","ScaffolderClient"],"mappings":";;;;;;;AA2HA,MAAM,wBAAA,CAAsD;AAAA,EACjD,KAAA;AAAA,EACA,OAAA;AAAA,EACA,UAAA;AAAA,EAET,YAAY,OAAA,EAIT;AACD,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,IAAA;AACrB,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,MAAA;AACvB,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,SAAA;AAAA,EAC5B;AAAA,EAEA,MAAM,0BAAA,CACJ,OAAA,EACA,OAAA,EACkC;AAClC,IAAA,OAAO,KAAK,OAAA,CAAQ,0BAAA;AAAA,MAClB,OAAA,CAAQ,WAAA;AAAA,MACR,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,OAAA,EACA,OAAA,EACqC;AACrC,IAAA,OAAO,IAAA,CAAK,QAAQ,QAAA,CAAS,OAAA,EAAS,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,CAAC,CAAA;AAAA,EACvE;AAAA,EAEA,MAAM,OAAA,CACJ,OAAA,EACA,OAAA,EACyB;AACzB,IAAA,OAAO,KAAK,OAAA,CAAQ,OAAA;AAAA,MAClB,OAAA,CAAQ,MAAA;AAAA,MACR,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,UAAA,CACJ,OAAA,EACA,OAAA,EAC4C;AAC5C,IAAA,OAAO,KAAK,OAAA,CAAQ,UAAA;AAAA,MAClB,OAAA,CAAQ,MAAA;AAAA,MACR,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO;AAAA,KAChC;AAAA,EACF;AAAA,EAEA,MAAM,KAAA,CACJ,OAAA,EACA,OAAA,EACyB;AACzB,IAAA,OAAO,IAAA,CAAK,QAAQ,KAAA,CAAM,OAAA,CAAQ,QAAQ,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,CAAC,CAAA;AAAA,EAC3E;AAAA,EAEA,MAAM,SAAA,CACJ,OAAA,EAKA,OAAA,EAC0D;AAC1D,IAAA,MAAM,EAAE,KAAA,EAAM,GAAI,MAAM,IAAA,CAAK,YAAY,OAAO,CAAA;AAChD,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,UAAA,CAAW,WAAW,YAAY,CAAA;AAE7D,IAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,IAAA,IAAI,QAAQ,SAAA,EAAW;AACrB,MAAA,MAAA,CAAO,GAAA,CAAI,WAAA,EAAa,OAAA,CAAQ,SAAS,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI,OAAA,CAAQ,UAAU,MAAA,EAAW;AAC/B,MAAA,MAAA,CAAO,GAAA,CAAI,OAAA,EAAS,MAAA,CAAO,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAC3C;AACA,IAAA,IAAI,OAAA,CAAQ,WAAW,MAAA,EAAW;AAChC,MAAA,MAAA,CAAO,GAAA,CAAI,QAAA,EAAU,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAC,CAAA;AAAA,IAC7C;AAEA,IAAA,MAAM,KAAA,GAAQ,OAAO,QAAA,EAAS;AAC9B,IAAA,MAAM,GAAA,GAAM,GAAG,OAAO,CAAA,SAAA,EAAY,QAAQ,CAAA,CAAA,EAAI,KAAK,KAAK,EAAE,CAAA,CAAA;AAE1D,IAAA,MAAM,QAAA,GAAW,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,MAChC,OAAA,EAAS;AAAA,QACP,cAAA,EAAgB,kBAAA;AAAA,QAChB,GAAI,KAAA,IAAS,EAAE,aAAA,EAAe,CAAA,OAAA,EAAU,KAAK,CAAA,CAAA;AAAG;AAClD,KACD,CAAA;AAED,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,MAAMA,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,IACjD;AAEA,IAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK;AACjC,IAAA,OAAO;AAAA,MACL,OAAO,IAAA,CAAK,KAAA;AAAA,MACZ,UAAA,EAAY,KAAK,UAAA,IAAc;AAAA,KACjC;AAAA,EACF;AAAA,EAEA,MAAM,WAAA,CACJ,QAAA,EACA,OAAA,EAC8B;AAC9B,IAAA,OAAO,KAAK,OAAA,CAAQ,WAAA;AAAA,MAClB,UAAU,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,IAAI;AAAC,KAC/C;AAAA,EACF;AAAA,EAEA,MAAM,wBAAA,CACJ,QAAA,EACA,OAAA,EAC2C;AAC3C,IAAA,OAAO,KAAK,OAAA,CAAQ,wBAAA;AAAA,MAClB,UAAU,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,IAAI;AAAC,KAC/C;AAAA,EACF;AAAA,EAEA,MAAM,OAAA,CACJ,OAAA,EAIA,OAAA,EACqB;AACrB,IAAA,MAAM,EAAE,KAAA,EAAM,GAAI,MAAM,IAAA,CAAK,YAAY,OAAO,CAAA;AAChD,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,UAAA,CAAW,WAAW,YAAY,CAAA;AAE7D,IAAA,MAAM,MAAA,GAAS,IAAI,eAAA,EAAgB;AACnC,IAAA,IAAI,OAAA,CAAQ,UAAU,MAAA,EAAW;AAC/B,MAAA,MAAA,CAAO,GAAA,CAAI,OAAA,EAAS,MAAA,CAAO,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAC3C;AAEA,IAAA,MAAM,KAAA,GAAQ,OAAO,QAAA,EAAS;AAC9B,IAAA,MAAM,MAAA,GAAS,kBAAA,CAAmB,OAAA,CAAQ,MAAM,CAAA;AAChD,IAAA,MAAM,GAAA,GAAM,CAAA,EAAG,OAAO,CAAA,UAAA,EAAa,MAAM,UACvC,KAAA,GAAQ,CAAA,CAAA,EAAI,KAAK,CAAA,CAAA,GAAK,EACxB,CAAA,CAAA;AAEA,IAAA,MAAM,QAAA,GAAW,MAAM,KAAA,CAAM,GAAA,EAAK;AAAA,MAChC,OAAA,EAAS;AAAA,QACP,cAAA,EAAgB,kBAAA;AAAA,QAChB,GAAI,KAAA,IAAS,EAAE,aAAA,EAAe,CAAA,OAAA,EAAU,KAAK,CAAA,CAAA;AAAG;AAClD,KACD,CAAA;AAED,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,MAAMA,oBAAA,CAAc,YAAA,CAAa,QAAQ,CAAA;AAAA,IACjD;AAEA,IAAA,OAAO,SAAS,IAAA,EAAK;AAAA,EACvB;AAAA,EAEA,MAAM,MAAA,CACJ,OAAA,EACA,OAAA,EACmC;AACnC,IAAA,OAAO,IAAA,CAAK,QAAQ,MAAA,CAAO,OAAA,EAAS,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,CAAC,CAAA;AAAA,EACrE;AAAA,EAEA,MAAM,YAAA,CACJ,OAAA,EAMA,OAAA,EACwD;AACxD,IAAA,OAAO,IAAA,CAAK,QAAQ,YAAA,CAAa,OAAA,EAAS,MAAM,IAAA,CAAK,WAAA,CAAY,OAAO,CAAC,CAAA;AAAA,EAC3E;AAAA,EAEA,MAAM,YACJ,OAAA,EACmC;AACnC,IAAA,OAAO,IAAA,CAAK,MAAM,qBAAA,CAAsB;AAAA,MACtC,YAAY,OAAA,CAAQ,WAAA;AAAA,MACpB,cAAA,EAAgB;AAAA,KACjB,CAAA;AAAA,EACH;AACF;AAQO,MAAM,uBAAuBC,iCAAA,CAAoC;AAAA,EACtE,EAAA,EAAI,mBAAA;AAAA,EACJ,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAA,CAAqB;AAAA,IACnB,OAAA;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,MAAMC,6BAAA,CAAa,IAAA;AAAA,MACnB,WAAWA,6BAAA,CAAa,SAAA;AAAA,MACxB,QAAQA,6BAAA,CAAa;AAAA,KACvB;AAAA,IACA,MAAM,OAAA,CAAQ,EAAE,IAAA,EAAM,SAAA,EAAW,QAAO,EAAG;AACzC,MAAA,MAAM,YAAA,GAAeC,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AACtD,MAAA,MAAM,MAAA,GAAS,IAAIC,uCAAA,CAAiB;AAAA,QAClC,YAAA,EAAc,SAAA;AAAA,QACd,QAAA,EAAU,EAAE,KAAA,EAAM;AAAA,QAClB,kBAAA,EAAoB;AAAA,OACrB,CAAA;AACD,MAAA,OAAO,IAAI,wBAAA,CAAyB;AAAA,QAClC,IAAA;AAAA,QACA,MAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD;AACL,CAAC;;;;"}

package/dist/testUtils/scaffolderServiceMock.cjs.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var backendTestUtils = require('@backstage/backend-test-utils');
+var scaffolderService = require('../scaffolderService.cjs.js');
+
+exports.scaffolderServiceMock = void 0;
+((scaffolderServiceMock2) => {
+  scaffolderServiceMock2.mock = backendTestUtils.createServiceMock(
+    scaffolderService.scaffolderServiceRef,
+    () => ({
+      getTemplateParameterSchema: jest.fn(),
+      scaffold: jest.fn(),
+      getTask: jest.fn(),
+      cancelTask: jest.fn(),
+      retry: jest.fn(),
+      listTasks: jest.fn(),
+      listActions: jest.fn(),
+      listTemplatingExtensions: jest.fn(),
+      getLogs: jest.fn(),
+      dryRun: jest.fn(),
+      autocomplete: jest.fn()
+    })
+  );
+})(exports.scaffolderServiceMock || (exports.scaffolderServiceMock = {}));
+//# sourceMappingURL=scaffolderServiceMock.cjs.js.map

package/dist/testUtils/scaffolderServiceMock.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffolderServiceMock.cjs.js","sources":["../../src/testUtils/scaffolderServiceMock.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { createServiceMock } from '@backstage/backend-test-utils';\nimport { scaffolderServiceRef, ScaffolderService } from '../scaffolderService';\n\n/**\n * A collection of mock functionality for the scaffolder service.\n *\n * @public\n */\nexport namespace scaffolderServiceMock {\n  /**\n   * Creates a scaffolder service whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = createServiceMock<ScaffolderService>(\n    scaffolderServiceRef,\n    () => ({\n      getTemplateParameterSchema: jest.fn(),\n      scaffold: jest.fn(),\n      getTask: jest.fn(),\n      cancelTask: jest.fn(),\n      retry: jest.fn(),\n      listTasks: jest.fn(),\n      listActions: jest.fn(),\n      listTemplatingExtensions: jest.fn(),\n      getLogs: jest.fn(),\n      dryRun: jest.fn(),\n      autocomplete: jest.fn(),\n    }),\n  );\n}\n"],"names":["scaffolderServiceMock","createServiceMock","scaffolderServiceRef"],"mappings":";;;;;AAwBiBA;AAAA,CAAV,CAAUA,sBAAAA,KAAV;AAKE,EAAMA,uBAAA,IAAA,GAAOC,kCAAA;AAAA,IAClBC,sCAAA;AAAA,IACA,OAAO;AAAA,MACL,0BAAA,EAA4B,KAAK,EAAA,EAAG;AAAA,MACpC,QAAA,EAAU,KAAK,EAAA,EAAG;AAAA,MAClB,OAAA,EAAS,KAAK,EAAA,EAAG;AAAA,MACjB,UAAA,EAAY,KAAK,EAAA,EAAG;AAAA,MACpB,KAAA,EAAO,KAAK,EAAA,EAAG;AAAA,MACf,SAAA,EAAW,KAAK,EAAA,EAAG;AAAA,MACnB,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,MACrB,wBAAA,EAA0B,KAAK,EAAA,EAAG;AAAA,MAClC,OAAA,EAAS,KAAK,EAAA,EAAG;AAAA,MACjB,MAAA,EAAQ,KAAK,EAAA,EAAG;AAAA,MAChB,YAAA,EAAc,KAAK,EAAA;AAAG,KACxB;AAAA,GACF;AAAA,CAAA,EApBeF,6BAAA,KAAAA,6BAAA,GAAA,EAAA,CAAA,CAAA;;"}

package/dist/testUtils.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var scaffolderServiceMock = require('./testUtils/scaffolderServiceMock.cjs.js');
+
+
+
+Object.defineProperty(exports, "scaffolderServiceMock", {
+  enumerable: true,
+  get: function () { return scaffolderServiceMock.scaffolderServiceMock; }
+});
+//# sourceMappingURL=testUtils.cjs.js.map

package/dist/testUtils.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

package/dist/testUtils.d.ts

@@ -0,0 +1,20 @@
+import { a as ScaffolderService } from './types/scaffolderService.d-BC_MUrKh.js';
+export { S as ScaffolderServiceRequestOptions } from './types/scaffolderService.d-BC_MUrKh.js';
+import * as _backstage_backend_test_utils from '@backstage/backend-test-utils';
+import '@backstage/backend-plugin-api';
+import '@backstage/plugin-scaffolder-common';
+
+/**
+ * A collection of mock functionality for the scaffolder service.
+ *
+ * @public
+ */
+declare namespace scaffolderServiceMock {
+    /**
+     * Creates a scaffolder service whose methods are mock functions, possibly with
+     * some of them overloaded by the caller.
+     */
+    const mock: (partialImpl?: Partial<ScaffolderService> | undefined) => _backstage_backend_test_utils.ServiceMock<ScaffolderService>;
+}
+
+export { ScaffolderService, scaffolderServiceMock };

package/dist/types/scaffolderService.d-BC_MUrKh.d.ts

@@ -0,0 +1,71 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { BackstageCredentials } from '@backstage/backend-plugin-api';
+import { TemplateParameterSchema, ScaffolderScaffoldOptions, ScaffolderScaffoldResponse, ScaffolderTask, ScaffolderTaskStatus, ListActionsResponse, ListTemplatingExtensionsResponse, LogEvent, ScaffolderDryRunOptions, ScaffolderDryRunResponse } from '@backstage/plugin-scaffolder-common';
+
+/**
+ * @public
+ */
+interface ScaffolderServiceRequestOptions {
+    credentials: BackstageCredentials;
+}
+/**
+ * A backend service interface for the scaffolder that uses
+ * {@link @backstage/backend-plugin-api#BackstageCredentials} instead of tokens.
+ *
+ * @public
+ */
+interface ScaffolderService {
+    getTemplateParameterSchema(request: {
+        templateRef: string;
+    }, options: ScaffolderServiceRequestOptions): Promise<TemplateParameterSchema>;
+    scaffold(request: ScaffolderScaffoldOptions, options: ScaffolderServiceRequestOptions): Promise<ScaffolderScaffoldResponse>;
+    getTask(request: {
+        taskId: string;
+    }, options: ScaffolderServiceRequestOptions): Promise<ScaffolderTask>;
+    cancelTask(request: {
+        taskId: string;
+    }, options: ScaffolderServiceRequestOptions): Promise<{
+        status?: ScaffolderTaskStatus;
+    }>;
+    retry(request: {
+        taskId: string;
+    }, options: ScaffolderServiceRequestOptions): Promise<{
+        id: string;
+    }>;
+    listTasks(request: {
+        createdBy?: string;
+        limit?: number;
+        offset?: number;
+    }, options: ScaffolderServiceRequestOptions): Promise<{
+        items: ScaffolderTask[];
+        totalItems: number;
+    }>;
+    listActions(request?: {}, options?: ScaffolderServiceRequestOptions): Promise<ListActionsResponse>;
+    listTemplatingExtensions(request?: {}, options?: ScaffolderServiceRequestOptions): Promise<ListTemplatingExtensionsResponse>;
+    getLogs(request: {
+        taskId: string;
+        after?: number;
+    }, options: ScaffolderServiceRequestOptions): Promise<LogEvent[]>;
+    dryRun(request: ScaffolderDryRunOptions, options: ScaffolderServiceRequestOptions): Promise<ScaffolderDryRunResponse>;
+    autocomplete(request: {
+        token: string;
+        provider: string;
+        resource: string;
+        context: Record<string, string>;
+    }, options: ScaffolderServiceRequestOptions): Promise<{
+        results: {
+            title?: string;
+            id: string;
+        }[];
+    }>;
+}
+/**
+ * A service ref for the scaffolder client, to be used by backend plugins
+ * and modules that need to interact with the scaffolder API.
+ *
+ * @public
+ */
+declare const scaffolderServiceRef: _backstage_backend_plugin_api.ServiceRef<ScaffolderService, "plugin", "singleton">;
+
+export { scaffolderServiceRef as s };
+export type { ScaffolderServiceRequestOptions as S, ScaffolderService as a };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.12.6-next.0",
+  "version": "0.13.0-next.2",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -35,6 +35,11 @@
       "types": "./dist/alpha.d.ts",
       "default": "./dist/alpha.cjs.js"
     },
+    "./testUtils": {
+      "require": "./dist/testUtils.cjs.js",
+      "types": "./dist/testUtils.d.ts",
+      "default": "./dist/testUtils.cjs.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs.js",
@@ -44,6 +49,9 @@
       "alpha": [
         "dist/alpha.d.ts"
       ],
+      "testUtils": [
+        "dist/testUtils.d.ts"
+      ],
       "package.json": [
         "package.json"
       ]
@@ -62,12 +70,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.7.1-next.0",
+    "@backstage/backend-plugin-api": "1.8.0-next.1",
     "@backstage/catalog-model": "1.7.6",
     "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.21.0-next.0",
+    "@backstage/integration": "2.0.0-next.2",
     "@backstage/plugin-permission-common": "0.9.6",
-    "@backstage/plugin-scaffolder-common": "1.7.7-next.0",
+    "@backstage/plugin-scaffolder-common": "2.0.0-next.2",
     "@backstage/types": "1.2.2",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
@@ -84,9 +92,18 @@
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.1-next.0",
-    "@backstage/cli": "0.35.5-next.0",
+    "@backstage/backend-test-utils": "1.11.1-next.2",
+    "@backstage/cli": "0.36.0-next.2",
     "@backstage/config": "1.3.6",
-    "@types/lodash": "^4.14.151"
+    "@types/lodash": "^4.14.151",
+    "msw": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@backstage/backend-test-utils": "1.11.1-next.2"
+  },
+  "peerDependenciesMeta": {
+    "@backstage/backend-test-utils": {
+      "optional": true
+    }
   }
 }