@backstage/plugin-scaffolder-backend 2.0.0-next.1 → 2.0.0

package/dist/index.d.ts

@@ -1,19 +1,17 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { AuthService, UrlReaderService, DatabaseService, BackstageCredentials, AuditorService } from '@backstage/backend-plugin-api';
+import { UrlReaderService, DatabaseService, LoggerService, AuthService, BackstageCredentials, AuditorService } from '@backstage/backend-plugin-api';
 import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
 import { TemplateFilter, TemplateGlobal, TemplateAction, TaskSecrets, SerializedTask, TaskStatus, SerializedTaskEvent, TaskContext, TaskCompletionState, TaskBroker } from '@backstage/plugin-scaffolder-node';
-import * as _backstage_types from '@backstage/types';
-import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
 import { ScmIntegrations } from '@backstage/integration';
-import { CatalogApi } from '@backstage/catalog-client';
-import { Config } from '@backstage/config';
+import { CatalogService } from '@backstage/plugin-catalog-node';
+import { HumanDuration, JsonObject, JsonValue } from '@backstage/types';
 import { Duration } from 'luxon';
 import { Knex } from 'knex';
 import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
 import { TaskSpec, TaskRecovery, TemplateEntityStepV1beta3, TemplateParametersV1beta3 } from '@backstage/plugin-scaffolder-common';
 import { EventsService } from '@backstage/plugin-events-node';
+import { Config } from '@backstage/config';
 import { WorkspaceProvider } from '@backstage/plugin-scaffolder-node/alpha';
-import { Logger } from 'winston';
 import { PermissionEvaluator, PermissionRuleParams } from '@backstage/plugin-permission-common';
 import { PermissionRule } from '@backstage/plugin-permission-node';
 import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE, RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha';
@@ -30,17 +28,25 @@ declare const scaffolderPlugin: _backstage_backend_plugin_api.BackendFeature;
  * @public
  */
 declare function createCatalogRegisterAction(options: {
-    catalogClient: CatalogApi;
+    catalog: CatalogService;
     integrations: ScmIntegrations;
-    auth?: AuthService;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     catalogInfoUrl: string;
-    optional?: boolean;
+    optional?: boolean | undefined;
+} | {
+    catalogInfoUrl: string;
+    optional?: boolean | undefined;
+    catalogInfoPath?: string | undefined;
 } | {
     repoContentsUrl: string;
-    catalogInfoPath?: string;
-    optional?: boolean;
-}, _backstage_types.JsonObject, "v1">;
+    optional?: boolean | undefined;
+} | {
+    repoContentsUrl: string;
+    optional?: boolean | undefined;
+    catalogInfoPath?: string | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Writes a catalog descriptor file containing the provided entity to a path in the workspace.
@@ -49,7 +55,9 @@ declare function createCatalogRegisterAction(options: {
 declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
     entity: Record<string, any>;
     filePath?: string | undefined;
-}, any, "v1">;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Returns entity or entities from the catalog by entity reference(s).
@@ -57,8 +65,7 @@ declare function createCatalogWriteAction(): _backstage_plugin_scaffolder_node.T
  * @public
  */
 declare function createFetchCatalogEntityAction(options: {
-    catalogClient: CatalogApi;
-    auth?: AuthService;
+    catalog: CatalogService;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     entityRef?: string | undefined;
     entityRefs?: string[] | undefined;
@@ -70,50 +77,6 @@ declare function createFetchCatalogEntityAction(options: {
     entities?: any[] | undefined;
 }, "v2">;
 
-/**
- * The options passed to {@link createBuiltinActions}
- * @public
- */
-interface CreateBuiltInActionsOptions {
-    /**
-     * The {@link @backstage/backend-plugin-api#UrlReaderService} interface that will be used in the default actions.
-     */
-    reader: UrlReaderService;
-    /**
-     * The {@link @backstage/integrations#ScmIntegrations} that will be used in the default actions.
-     */
-    integrations: ScmIntegrations;
-    /**
-     * The {@link @backstage/catalog-client#CatalogApi} that will be used in the default actions.
-     */
-    catalogClient: CatalogApi;
-    /**
-     * The {@link @backstage/backend-plugin-api#AuthService} that will be used in the default actions.
-     */
-    auth?: AuthService;
-    /**
-     * The {@link @backstage/config#Config} that will be used in the default actions.
-     */
-    config: Config;
-    /**
-     * Additional custom filters that will be passed to the nunjucks template engine for use in
-     * Template Manifests and also template skeleton files when using `fetch:template`.
-     */
-    additionalTemplateFilters?: Record<string, TemplateFilter>;
-    additionalTemplateGlobals?: Record<string, TemplateGlobal>;
-}
-/**
- * A function to generate create a list of default actions that the scaffolder provides.
- * Is called internally in the default setup, but can be used when adding your own actions or overriding the default ones
- *
- * TODO(blam): version 2 of the scaffolder shouldn't ship with the additional modules. We should ship the basics, and let people install
- * modules for the providers they want to use.
- * @public
- * @returns A list of actions that can be used in the scaffolder
- *
- */
-declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => TemplateAction[];
-
 /**
  * Writes a message into the log or lists all files in the workspace
  *
@@ -124,7 +87,12 @@ declare const createBuiltinActions: (options: CreateBuiltInActionsOptions) => Te
  *
  * @public
  */
-declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.TemplateAction<any, any, "v1">;
+declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.TemplateAction<{
+    message?: string | undefined;
+    listWorkspace?: boolean | "with-contents" | "with-filenames" | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Waits for a certain period of time.
@@ -138,7 +106,13 @@ declare function createDebugLogAction(): _backstage_plugin_scaffolder_node.Templ
  */
 declare function createWaitAction(options?: {
     maxWaitTime?: Duration | HumanDuration;
-}): _backstage_plugin_scaffolder_node.TemplateAction<HumanDuration, _backstage_types.JsonObject, "v1">;
+}): _backstage_plugin_scaffolder_node.TemplateAction<{
+    minutes?: number | undefined;
+    seconds?: number | undefined;
+    milliseconds?: number | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Downloads content and places it in the workspace, or optionally
@@ -150,13 +124,14 @@ declare function createFetchPlainAction(options: {
     integrations: ScmIntegrations;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
-    targetPath?: string;
-    token?: string;
-}, _backstage_types.JsonObject, "v1">;
+    targetPath?: string | undefined;
+    token?: string | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
- * Downloads content and places it in the workspace, or optionally
- * in a subdirectory specified by the 'targetPath' input option.
+ * Downloads a single file and places it in the workspace.
  * @public
  */
 declare function createFetchPlainFileAction(options: {
@@ -165,8 +140,10 @@ declare function createFetchPlainFileAction(options: {
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
     targetPath: string;
-    token?: string;
-}, _backstage_types.JsonObject, "v1">;
+    token?: string | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Downloads a skeleton, templates variables into file and directory names and content.
@@ -182,16 +159,19 @@ declare function createFetchTemplateAction(options: {
     additionalTemplateGlobals?: Record<string, TemplateGlobal>;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
-    targetPath?: string;
-    values: any;
-    templateFileExtension?: string | boolean;
-    copyWithoutTemplating?: string[];
-    cookiecutterCompat?: boolean;
-    replace?: boolean;
-    trimBlocks?: boolean;
-    lstripBlocks?: boolean;
-    token?: string;
-}, _backstage_types.JsonObject, "v1">;
+    targetPath?: string | undefined;
+    values?: Record<string, any> | undefined;
+    copyWithoutRender?: string[] | undefined;
+    copyWithoutTemplating?: string[] | undefined;
+    cookiecutterCompat?: boolean | undefined;
+    templateFileExtension?: string | boolean | undefined;
+    replace?: boolean | undefined;
+    trimBlocks?: boolean | undefined;
+    lstripBlocks?: boolean | undefined;
+    token?: string | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Downloads a single file and templates variables into file.
@@ -207,13 +187,15 @@ declare function createFetchTemplateFileAction(options: {
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     url: string;
     targetPath: string;
-    values: any;
-    cookiecutterCompat?: boolean;
-    replace?: boolean;
-    trimBlocks?: boolean;
-    lstripBlocks?: boolean;
-    token?: string;
-}, _backstage_types.JsonObject, "v1">;
+    values?: Record<string, any> | undefined;
+    cookiecutterCompat?: boolean | undefined;
+    replace?: boolean | undefined;
+    trimBlocks?: boolean | undefined;
+    lstripBlocks?: boolean | undefined;
+    token?: string | undefined;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Creates new action that enables deletion of files and directories in the workspace.
@@ -221,27 +203,31 @@ declare function createFetchTemplateFileAction(options: {
  */
 declare const createFilesystemDeleteAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
     files: string[];
-}, _backstage_types.JsonObject, "v1">;
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Creates a new action that allows renames of files and directories in the workspace.
  * @public
  */
 declare const createFilesystemRenameAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
-    files: Array<{
+    files: {
         from: string;
         to: string;
-        overwrite?: boolean;
-    }>;
-}, _backstage_types.JsonObject, "v1">;
+        overwrite?: boolean | undefined;
+    }[];
+}, {
+    [x: string]: any;
+}, "v2">;
 
 /**
  * Creates new action that enables reading directories in the workspace.
  * @public
  */
 declare const createFilesystemReadDirAction: () => _backstage_plugin_scaffolder_node.TemplateAction<{
-    recursive: boolean;
     paths: string[];
+    recursive: boolean;
 }, {
     files: {
         name: string;
@@ -253,7 +239,7 @@ declare const createFilesystemReadDirAction: () => _backstage_plugin_scaffolder_
         path: string;
         fullPath: string;
     }[];
-}, "v1">;
+}, "v2">;
 
 /**
  * Registry of all registered template actions.
@@ -534,7 +520,7 @@ declare class TaskManager implements TaskContext {
     private readonly auth?;
     private isDone;
     private heartbeatTimeoutId?;
-    static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: Logger, auth?: AuthService, config?: Config, additionalWorkspaceProviders?: Record<string, WorkspaceProvider>): TaskManager;
+    static create(task: CurrentClaimedTask, storage: TaskStore, abortSignal: AbortSignal, logger: LoggerService, auth?: AuthService, config?: Config, additionalWorkspaceProviders?: Record<string, WorkspaceProvider>): TaskManager;
     private constructor();
     get spec(): _backstage_plugin_scaffolder_common.TaskSpecV1beta3;
     get cancelSignal(): AbortSignal;
@@ -609,7 +595,7 @@ type CreateWorkerOptions = {
     actionRegistry: TemplateActionRegistry;
     integrations: ScmIntegrations;
     workingDirectory: string;
-    logger: Logger;
+    logger: LoggerService;
     auditor?: AuditorService;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
     /**
@@ -659,4 +645,4 @@ type TemplatePermissionRuleInput<TParams extends PermissionRuleParams = Permissi
  */
 type ActionPermissionRuleInput<TParams extends PermissionRuleParams = PermissionRuleParams> = PermissionRule<TemplateEntityStepV1beta3 | TemplateParametersV1beta3, {}, typeof RESOURCE_TYPE_SCAFFOLDER_ACTION, TParams>;
 
-export { type ActionPermissionRuleInput, type CreateBuiltInActionsOptions, type CreateWorkerOptions, type CurrentClaimedTask, DatabaseTaskStore, type DatabaseTaskStoreOptions, TaskManager, type TaskStore, type TaskStoreCreateTaskOptions, type TaskStoreCreateTaskResult, type TaskStoreEmitOptions, type TaskStoreListEventsOptions, type TaskStoreRecoverTaskOptions, type TaskStoreShutDownTaskOptions, TaskWorker, TemplateActionRegistry, type TemplatePermissionRuleInput, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFetchTemplateFileAction, createFilesystemDeleteAction, createFilesystemReadDirAction, createFilesystemRenameAction, createWaitAction, scaffolderPlugin as default };
+export { type ActionPermissionRuleInput, type CreateWorkerOptions, type CurrentClaimedTask, DatabaseTaskStore, type DatabaseTaskStoreOptions, TaskManager, type TaskStore, type TaskStoreCreateTaskOptions, type TaskStoreCreateTaskResult, type TaskStoreEmitOptions, type TaskStoreListEventsOptions, type TaskStoreRecoverTaskOptions, type TaskStoreShutDownTaskOptions, TaskWorker, TemplateActionRegistry, type TemplatePermissionRuleInput, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchCatalogEntityAction, createFetchPlainAction, createFetchPlainFileAction, createFetchTemplateAction, createFetchTemplateFileAction, createFilesystemDeleteAction, createFilesystemReadDirAction, createFilesystemRenameAction, createWaitAction, scaffolderPlugin as default };

package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js

@@ -6,7 +6,7 @@ var fetch_examples = require('./fetch.examples.cjs.js');
 
 const id = "catalog:fetch";
 function createFetchCatalogEntityAction(options) {
-  const { catalogClient, auth } = options;
+  const { catalog } = options;
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Returns entity or entities from the catalog by entity reference(s)",
@@ -45,17 +45,13 @@ function createFetchCatalogEntityAction(options) {
         }
         throw new Error("Missing entity reference or references");
       }
-      const { token } = await auth?.getPluginRequestToken({
-        onBehalfOf: await ctx.getInitiatorCredentials(),
-        targetPluginId: "catalog"
-      }) ?? { token: ctx.secrets?.backstageToken };
       if (entityRef) {
-        const entity = await catalogClient.getEntityByRef(
+        const entity = await catalog.getEntityByRef(
           catalogModel.stringifyEntityRef(
             catalogModel.parseEntityRef(entityRef, { defaultKind, defaultNamespace })
           ),
           {
-            token
+            credentials: await ctx.getInitiatorCredentials()
           }
         );
         if (!entity && !optional) {
@@ -64,7 +60,7 @@ function createFetchCatalogEntityAction(options) {
         ctx.output("entity", entity ?? null);
       }
       if (entityRefs) {
-        const entities = await catalogClient.getEntitiesByRefs(
+        const entities = await catalog.getEntitiesByRefs(
           {
             entityRefs: entityRefs.map(
               (ref) => catalogModel.stringifyEntityRef(
@@ -72,9 +68,7 @@ function createFetchCatalogEntityAction(options) {
               )
             )
           },
-          {
-            token
-          }
+          { credentials: await ctx.getInitiatorCredentials() }
         );
         const finalEntities = entities.items.map((e, i) => {
           if (!e && !optional) {

package/dist/scaffolder/actions/builtin/catalog/fetch.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/fetch.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 { CatalogApi } from '@backstage/catalog-client';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { parseEntityRef, stringifyEntityRef } from '@backstage/catalog-model';\nimport { examples } from './fetch.examples';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\nconst id = 'catalog:fetch';\n\n/**\n * Returns entity or entities from the catalog by entity reference(s).\n *\n * @public\n */\nexport function createFetchCatalogEntityAction(options: {\n  catalogClient: CatalogApi;\n  auth?: AuthService;\n}) {\n  const { catalogClient, auth } = options;\n\n  return createTemplateAction({\n    id,\n    description:\n      'Returns entity or entities from the catalog by entity reference(s)',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        entityRef: z =>\n          z\n            .string({\n              description: 'Entity reference of the entity to get',\n            })\n            .optional(),\n        entityRefs: z =>\n          z\n            .array(z.string(), {\n              description: 'Entity references of the entities to get',\n            })\n            .optional(),\n        optional: z =>\n          z\n            .boolean({\n              description:\n                'Allow the entity or entities to optionally exist. Default: false',\n            })\n            .optional(),\n        defaultKind: z =>\n          z.string({ description: 'The default kind' }).optional(),\n        defaultNamespace: z =>\n          z.string({ description: 'The default namespace' }).optional(),\n      },\n      output: {\n        entity: z =>\n          z\n            .any({\n              description:\n                'Object containing same values used in the Entity schema. Only when used with `entityRef` parameter.',\n            })\n            .optional(),\n        entities: z =>\n          z\n            .array(\n              z.any({\n                description:\n                  'Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter.',\n              }),\n            )\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const { entityRef, entityRefs, optional, defaultKind, defaultNamespace } =\n        ctx.input;\n\n      if (!entityRef && !entityRefs) {\n        if (optional) {\n          return;\n        }\n        throw new Error('Missing entity reference or references');\n      }\n\n      const { token } = (await auth?.getPluginRequestToken({\n        onBehalfOf: await ctx.getInitiatorCredentials(),\n        targetPluginId: 'catalog',\n      })) ?? { token: ctx.secrets?.backstageToken };\n\n      if (entityRef) {\n        const entity = await catalogClient.getEntityByRef(\n          stringifyEntityRef(\n            parseEntityRef(entityRef, { defaultKind, defaultNamespace }),\n          ),\n          {\n            token,\n          },\n        );\n\n        if (!entity && !optional) {\n          throw new Error(`Entity ${entityRef} not found`);\n        }\n        ctx.output('entity', entity ?? null);\n      }\n\n      if (entityRefs) {\n        const entities = await catalogClient.getEntitiesByRefs(\n          {\n            entityRefs: entityRefs.map(ref =>\n              stringifyEntityRef(\n                parseEntityRef(ref, { defaultKind, defaultNamespace }),\n              ),\n            ),\n          },\n          {\n            token,\n          },\n        );\n\n        const finalEntities = entities.items.map((e, i) => {\n          if (!e && !optional) {\n            throw new Error(`Entity ${entityRefs[i]} not found`);\n          }\n          return e ?? null;\n        });\n\n        ctx.output('entities', finalEntities);\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","stringifyEntityRef","parseEntityRef"],"mappings":";;;;;;AAsBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,+BAA+B,OAG5C,EAAA;AACD,EAAM,MAAA,EAAE,aAAe,EAAA,IAAA,EAAS,GAAA,OAAA;AAEhC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,oEAAA;AAAA,cACFC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,CACR,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,WAAA,EAAa,OACX,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,kBAAA,EAAoB,CAAA,CAAE,QAAS,EAAA;AAAA,QACzD,gBAAA,EAAkB,OAChB,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,uBAAA,EAAyB,CAAA,CAAE,QAAS;AAAA,OAChE;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,GAAI,CAAA;AAAA,UACH,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,OACR,CACG,CAAA,KAAA;AAAA,UACC,EAAE,GAAI,CAAA;AAAA,YACJ,WACE,EAAA;AAAA,WACH;AAAA,UAEF,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,SAAW,EAAA,UAAA,EAAY,UAAU,WAAa,EAAA,gBAAA,KACpD,GAAI,CAAA,KAAA;AAEN,MAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC7B,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA;AAAA;AAG1D,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAE5C,MAAA,IAAI,SAAW,EAAA;AACb,QAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA,cAAA;AAAA,UACjCC,+BAAA;AAAA,YACEC,2BAAe,CAAA,SAAA,EAAW,EAAE,WAAA,EAAa,kBAAkB;AAAA,WAC7D;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AAEA,QAAI,IAAA,CAAC,MAAU,IAAA,CAAC,QAAU,EAAA;AACxB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,SAAS,CAAY,UAAA,CAAA,CAAA;AAAA;AAEjD,QAAI,GAAA,CAAA,MAAA,CAAO,QAAU,EAAA,MAAA,IAAU,IAAI,CAAA;AAAA;AAGrC,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,MAAA,QAAA,GAAW,MAAM,aAAc,CAAA,iBAAA;AAAA,UACnC;AAAA,YACE,YAAY,UAAW,CAAA,GAAA;AAAA,cAAI,CACzB,GAAA,KAAAD,+BAAA;AAAA,gBACEC,2BAAe,CAAA,GAAA,EAAK,EAAE,WAAA,EAAa,kBAAkB;AAAA;AACvD;AACF,WACF;AAAA,UACA;AAAA,YACE;AAAA;AACF,SACF;AAEA,QAAA,MAAM,gBAAgB,QAAS,CAAA,KAAA,CAAM,GAAI,CAAA,CAAC,GAAG,CAAM,KAAA;AACjD,UAAI,IAAA,CAAC,CAAK,IAAA,CAAC,QAAU,EAAA;AACnB,YAAA,MAAM,IAAI,KAAM,CAAA,CAAA,OAAA,EAAU,UAAW,CAAA,CAAC,CAAC,CAAY,UAAA,CAAA,CAAA;AAAA;AAErD,UAAA,OAAO,CAAK,IAAA,IAAA;AAAA,SACb,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,YAAY,aAAa,CAAA;AAAA;AACtC;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"fetch.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/fetch.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 { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { parseEntityRef, stringifyEntityRef } from '@backstage/catalog-model';\nimport { examples } from './fetch.examples';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\nconst id = 'catalog:fetch';\n\n/**\n * Returns entity or entities from the catalog by entity reference(s).\n *\n * @public\n */\nexport function createFetchCatalogEntityAction(options: {\n  catalog: CatalogService;\n}) {\n  const { catalog } = options;\n\n  return createTemplateAction({\n    id,\n    description:\n      'Returns entity or entities from the catalog by entity reference(s)',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        entityRef: z =>\n          z\n            .string({\n              description: 'Entity reference of the entity to get',\n            })\n            .optional(),\n        entityRefs: z =>\n          z\n            .array(z.string(), {\n              description: 'Entity references of the entities to get',\n            })\n            .optional(),\n        optional: z =>\n          z\n            .boolean({\n              description:\n                'Allow the entity or entities to optionally exist. Default: false',\n            })\n            .optional(),\n        defaultKind: z =>\n          z.string({ description: 'The default kind' }).optional(),\n        defaultNamespace: z =>\n          z.string({ description: 'The default namespace' }).optional(),\n      },\n      output: {\n        entity: z =>\n          z\n            .any({\n              description:\n                'Object containing same values used in the Entity schema. Only when used with `entityRef` parameter.',\n            })\n            .optional(),\n        entities: z =>\n          z\n            .array(\n              z.any({\n                description:\n                  'Array containing objects with same values used in the Entity schema. Only when used with `entityRefs` parameter.',\n              }),\n            )\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const { entityRef, entityRefs, optional, defaultKind, defaultNamespace } =\n        ctx.input;\n\n      if (!entityRef && !entityRefs) {\n        if (optional) {\n          return;\n        }\n        throw new Error('Missing entity reference or references');\n      }\n\n      if (entityRef) {\n        const entity = await catalog.getEntityByRef(\n          stringifyEntityRef(\n            parseEntityRef(entityRef, { defaultKind, defaultNamespace }),\n          ),\n          {\n            credentials: await ctx.getInitiatorCredentials(),\n          },\n        );\n\n        if (!entity && !optional) {\n          throw new Error(`Entity ${entityRef} not found`);\n        }\n        ctx.output('entity', entity ?? null);\n      }\n\n      if (entityRefs) {\n        const entities = await catalog.getEntitiesByRefs(\n          {\n            entityRefs: entityRefs.map(ref =>\n              stringifyEntityRef(\n                parseEntityRef(ref, { defaultKind, defaultNamespace }),\n              ),\n            ),\n          },\n          { credentials: await ctx.getInitiatorCredentials() },\n        );\n\n        const finalEntities = entities.items.map((e, i) => {\n          if (!e && !optional) {\n            throw new Error(`Entity ${entityRefs[i]} not found`);\n          }\n          return e ?? null;\n        });\n\n        ctx.output('entities', finalEntities);\n      }\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","stringifyEntityRef","parseEntityRef"],"mappings":";;;;;;AAqBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,+BAA+B,OAE5C,EAAA;AACD,EAAM,MAAA,EAAE,SAAY,GAAA,OAAA;AAEpB,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,oEAAA;AAAA,cACFC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,SAAA,EAAW,CACT,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,YAAY,CACV,CAAA,KAAA,CAAA,CACG,KAAM,CAAA,CAAA,CAAE,QAAU,EAAA;AAAA,UACjB,WAAa,EAAA;AAAA,SACd,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,CACR,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,WAAA,EAAa,OACX,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,kBAAA,EAAoB,CAAA,CAAE,QAAS,EAAA;AAAA,QACzD,gBAAA,EAAkB,OAChB,CAAE,CAAA,MAAA,CAAO,EAAE,WAAa,EAAA,uBAAA,EAAyB,CAAA,CAAE,QAAS;AAAA,OAChE;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,GAAI,CAAA;AAAA,UACH,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,QAAA,EAAU,OACR,CACG,CAAA,KAAA;AAAA,UACC,EAAE,GAAI,CAAA;AAAA,YACJ,WACE,EAAA;AAAA,WACH;AAAA,UAEF,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,SAAW,EAAA,UAAA,EAAY,UAAU,WAAa,EAAA,gBAAA,KACpD,GAAI,CAAA,KAAA;AAEN,MAAI,IAAA,CAAC,SAAa,IAAA,CAAC,UAAY,EAAA;AAC7B,QAAA,IAAI,QAAU,EAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA;AAAA;AAG1D,MAAA,IAAI,SAAW,EAAA;AACb,QAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,UAC3BC,+BAAA;AAAA,YACEC,2BAAe,CAAA,SAAA,EAAW,EAAE,WAAA,EAAa,kBAAkB;AAAA,WAC7D;AAAA,UACA;AAAA,YACE,WAAA,EAAa,MAAM,GAAA,CAAI,uBAAwB;AAAA;AACjD,SACF;AAEA,QAAI,IAAA,CAAC,MAAU,IAAA,CAAC,QAAU,EAAA;AACxB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,SAAS,CAAY,UAAA,CAAA,CAAA;AAAA;AAEjD,QAAI,GAAA,CAAA,MAAA,CAAO,QAAU,EAAA,MAAA,IAAU,IAAI,CAAA;AAAA;AAGrC,MAAA,IAAI,UAAY,EAAA;AACd,QAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,iBAAA;AAAA,UAC7B;AAAA,YACE,YAAY,UAAW,CAAA,GAAA;AAAA,cAAI,CACzB,GAAA,KAAAD,+BAAA;AAAA,gBACEC,2BAAe,CAAA,GAAA,EAAK,EAAE,WAAA,EAAa,kBAAkB;AAAA;AACvD;AACF,WACF;AAAA,UACA,EAAE,WAAA,EAAa,MAAM,GAAA,CAAI,yBAA0B;AAAA,SACrD;AAEA,QAAA,MAAM,gBAAgB,QAAS,CAAA,KAAA,CAAM,GAAI,CAAA,CAAC,GAAG,CAAM,KAAA;AACjD,UAAI,IAAA,CAAC,CAAK,IAAA,CAAC,QAAU,EAAA;AACnB,YAAA,MAAM,IAAI,KAAM,CAAA,CAAA,OAAA,EAAU,UAAW,CAAA,CAAC,CAAC,CAAY,UAAA,CAAA,CAAA;AAAA;AAErD,UAAA,OAAO,CAAK,IAAA,IAAA;AAAA,SACb,CAAA;AAED,QAAI,GAAA,CAAA,MAAA,CAAO,YAAY,aAAa,CAAA;AAAA;AACtC;AACF,GACD,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/catalog/register.cjs.js

@@ -7,65 +7,33 @@ var register_examples = require('./register.examples.cjs.js');
 
 const id = "catalog:register";
 function createCatalogRegisterAction(options) {
-  const { catalogClient, integrations, auth } = options;
+  const { catalog, integrations } = options;
   return pluginScaffolderNode.createTemplateAction({
     id,
     description: "Registers entities from a catalog descriptor file in the workspace into the software catalog.",
     examples: register_examples.examples,
     schema: {
-      input: {
-        oneOf: [
-          {
-            type: "object",
-            required: ["catalogInfoUrl"],
-            properties: {
-              catalogInfoUrl: {
-                title: "Catalog Info URL",
-                description: "An absolute URL pointing to the catalog info file location",
-                type: "string"
-              },
-              optional: {
-                title: "Optional",
-                description: "Permit the registered location to optionally exist. Default: false",
-                type: "boolean"
-              }
-            }
-          },
-          {
-            type: "object",
-            required: ["repoContentsUrl"],
-            properties: {
-              repoContentsUrl: {
-                title: "Repository Contents URL",
-                description: "An absolute URL pointing to the root of a repository directory tree",
-                type: "string"
-              },
-              catalogInfoPath: {
-                title: "Fetch URL",
-                description: "A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml",
-                type: "string"
-              },
-              optional: {
-                title: "Optional",
-                description: "Permit the registered location to optionally exist. Default: false",
-                type: "boolean"
-              }
-            }
-          }
-        ]
-      },
-      output: {
-        type: "object",
-        required: ["catalogInfoUrl"],
-        properties: {
-          entityRef: {
-            type: "string"
-          },
-          catalogInfoUrl: {
-            type: "string"
-          }
-        }
-      }
+      input: (z) => z.union([
+        z.object({
+          catalogInfoUrl: z.string({
+            description: "An absolute URL pointing to the catalog info file location"
+          }),
+          optional: z.boolean({
+            description: "Permit the registered location to optionally exist. Default: false"
+          }).optional()
+        }),
+        z.object({
+          repoContentsUrl: z.string({
+            description: "An absolute URL pointing to the root of a repository directory tree"
+          }),
+          catalogInfoPath: z.string({
+            description: "A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml"
+          }).optional(),
+          optional: z.boolean({
+            description: "Permit the registered location to optionally exist. Default: false"
+          }).optional()
+        })
+      ])
     },
     async handler(ctx) {
       const { input } = ctx;
@@ -86,17 +54,13 @@ function createCatalogRegisterAction(options) {
         });
       }
       ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);
-      const { token } = await auth?.getPluginRequestToken({
-        onBehalfOf: await ctx.getInitiatorCredentials(),
-        targetPluginId: "catalog"
-      }) ?? { token: ctx.secrets?.backstageToken };
       try {
-        await catalogClient.addLocation(
+        await catalog.addLocation(
           {
             type: "url",
             target: catalogInfoUrl
           },
-          token ? { token } : {}
+          { credentials: await ctx.getInitiatorCredentials() }
         );
       } catch (e) {
         if (!input.optional) {
@@ -104,13 +68,13 @@ function createCatalogRegisterAction(options) {
         }
       }
       try {
-        const result = await catalogClient.addLocation(
+        const result = await catalog.addLocation(
           {
             dryRun: true,
             type: "url",
             target: catalogInfoUrl
           },
-          token ? { token } : {}
+          { credentials: await ctx.getInitiatorCredentials() }
         );
         if (result.entities.length) {
           const { entities } = result;

package/dist/scaffolder/actions/builtin/catalog/register.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"register.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/register.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 { ScmIntegrations } from '@backstage/integration';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport { stringifyEntityRef, Entity } from '@backstage/catalog-model';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { examples } from './register.examples';\nimport { AuthService } from '@backstage/backend-plugin-api';\n\nconst id = 'catalog:register';\n\n/**\n * Registers entities from a catalog descriptor file in the workspace into the software catalog.\n * @public\n */\nexport function createCatalogRegisterAction(options: {\n  catalogClient: CatalogApi;\n  integrations: ScmIntegrations;\n  auth?: AuthService;\n}) {\n  const { catalogClient, integrations, auth } = options;\n\n  return createTemplateAction<\n    | { catalogInfoUrl: string; optional?: boolean }\n    | { repoContentsUrl: string; catalogInfoPath?: string; optional?: boolean }\n  >({\n    id,\n    description:\n      'Registers entities from a catalog descriptor file in the workspace into the software catalog.',\n    examples,\n    schema: {\n      input: {\n        oneOf: [\n          {\n            type: 'object',\n            required: ['catalogInfoUrl'],\n            properties: {\n              catalogInfoUrl: {\n                title: 'Catalog Info URL',\n                description:\n                  'An absolute URL pointing to the catalog info file location',\n                type: 'string',\n              },\n              optional: {\n                title: 'Optional',\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n                type: 'boolean',\n              },\n            },\n          },\n          {\n            type: 'object',\n            required: ['repoContentsUrl'],\n            properties: {\n              repoContentsUrl: {\n                title: 'Repository Contents URL',\n                description:\n                  'An absolute URL pointing to the root of a repository directory tree',\n                type: 'string',\n              },\n              catalogInfoPath: {\n                title: 'Fetch URL',\n                description:\n                  'A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml',\n                type: 'string',\n              },\n              optional: {\n                title: 'Optional',\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n                type: 'boolean',\n              },\n            },\n          },\n        ],\n      },\n      output: {\n        type: 'object',\n        required: ['catalogInfoUrl'],\n        properties: {\n          entityRef: {\n            type: 'string',\n          },\n          catalogInfoUrl: {\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { input } = ctx;\n\n      let catalogInfoUrl;\n      if ('catalogInfoUrl' in input) {\n        catalogInfoUrl = input.catalogInfoUrl;\n      } else {\n        const { repoContentsUrl, catalogInfoPath = '/catalog-info.yaml' } =\n          input;\n        const integration = integrations.byUrl(repoContentsUrl);\n        if (!integration) {\n          throw new InputError(\n            `No integration found for host ${repoContentsUrl}`,\n          );\n        }\n\n        catalogInfoUrl = integration.resolveUrl({\n          base: repoContentsUrl,\n          url: catalogInfoPath,\n        });\n      }\n\n      ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);\n\n      const { token } = (await auth?.getPluginRequestToken({\n        onBehalfOf: await ctx.getInitiatorCredentials(),\n        targetPluginId: 'catalog',\n      })) ?? { token: ctx.secrets?.backstageToken };\n\n      try {\n        // 1st try to register the location, this will throw an error if the location already exists (see catch)\n        await catalogClient.addLocation(\n          {\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          token ? { token } : {},\n        );\n      } catch (e) {\n        if (!input.optional) {\n          // if optional is false or unset, it is not allowed to register the same location twice, we rethrow the error\n          throw e;\n        }\n      }\n\n      try {\n        // 2nd retry the registration as a dry run, this will not throw an error if the location already exists\n        const result = await catalogClient.addLocation(\n          {\n            dryRun: true,\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          token ? { token } : {},\n        );\n\n        if (result.entities.length) {\n          const { entities } = result;\n          let entity: Entity | undefined;\n          // prioritise 'Component' type as it is the most central kind of entity\n          entity = entities.find(\n            e =>\n              !e.metadata.name.startsWith('generated-') &&\n              e.kind === 'Component',\n          );\n          if (!entity) {\n            entity = entities.find(\n              e => !e.metadata.name.startsWith('generated-'),\n            );\n          }\n          if (!entity) {\n            entity = entities[0];\n          }\n\n          ctx.output('entityRef', stringifyEntityRef(entity));\n        }\n      } catch (e) {\n        if (!input.optional) {\n          throw e;\n        }\n      }\n\n      ctx.output('catalogInfoUrl', catalogInfoUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","InputError","stringifyEntityRef"],"mappings":";;;;;;;AAwBA,MAAM,EAAK,GAAA,kBAAA;AAMJ,SAAS,4BAA4B,OAIzC,EAAA;AACD,EAAA,MAAM,EAAE,aAAA,EAAe,YAAc,EAAA,IAAA,EAAS,GAAA,OAAA;AAE9C,EAAA,OAAOA,yCAGL,CAAA;AAAA,IACA,EAAA;AAAA,IACA,WACE,EAAA,+FAAA;AAAA,cACFC,0BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,KAAO,EAAA;AAAA,UACL;AAAA,YACE,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,gBAAgB,CAAA;AAAA,YAC3B,UAAY,EAAA;AAAA,cACV,cAAgB,EAAA;AAAA,gBACd,KAAO,EAAA,kBAAA;AAAA,gBACP,WACE,EAAA,4DAAA;AAAA,gBACF,IAAM,EAAA;AAAA,eACR;AAAA,cACA,QAAU,EAAA;AAAA,gBACR,KAAO,EAAA,UAAA;AAAA,gBACP,WACE,EAAA,oEAAA;AAAA,gBACF,IAAM,EAAA;AAAA;AACR;AACF,WACF;AAAA,UACA;AAAA,YACE,IAAM,EAAA,QAAA;AAAA,YACN,QAAA,EAAU,CAAC,iBAAiB,CAAA;AAAA,YAC5B,UAAY,EAAA;AAAA,cACV,eAAiB,EAAA;AAAA,gBACf,KAAO,EAAA,yBAAA;AAAA,gBACP,WACE,EAAA,qEAAA;AAAA,gBACF,IAAM,EAAA;AAAA,eACR;AAAA,cACA,eAAiB,EAAA;AAAA,gBACf,KAAO,EAAA,WAAA;AAAA,gBACP,WACE,EAAA,sGAAA;AAAA,gBACF,IAAM,EAAA;AAAA,eACR;AAAA,cACA,QAAU,EAAA;AAAA,gBACR,KAAO,EAAA,UAAA;AAAA,gBACP,WACE,EAAA,oEAAA;AAAA,gBACF,IAAM,EAAA;AAAA;AACR;AACF;AACF;AACF,OACF;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,gBAAgB,CAAA;AAAA,QAC3B,UAAY,EAAA;AAAA,UACV,SAAW,EAAA;AAAA,YACT,IAAM,EAAA;AAAA,WACR;AAAA,UACA,cAAgB,EAAA;AAAA,YACd,IAAM,EAAA;AAAA;AACR;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,EAAE,OAAU,GAAA,GAAA;AAElB,MAAI,IAAA,cAAA;AACJ,MAAA,IAAI,oBAAoB,KAAO,EAAA;AAC7B,QAAA,cAAA,GAAiB,KAAM,CAAA,cAAA;AAAA,OAClB,MAAA;AACL,QAAA,MAAM,EAAE,eAAA,EAAiB,eAAkB,GAAA,oBAAA,EACzC,GAAA,KAAA;AACF,QAAM,MAAA,WAAA,GAAc,YAAa,CAAA,KAAA,CAAM,eAAe,CAAA;AACtD,QAAA,IAAI,CAAC,WAAa,EAAA;AAChB,UAAA,MAAM,IAAIC,iBAAA;AAAA,YACR,iCAAiC,eAAe,CAAA;AAAA,WAClD;AAAA;AAGF,QAAA,cAAA,GAAiB,YAAY,UAAW,CAAA;AAAA,UACtC,IAAM,EAAA,eAAA;AAAA,UACN,GAAK,EAAA;AAAA,SACN,CAAA;AAAA;AAGH,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAe,YAAA,EAAA,cAAc,CAAiB,eAAA,CAAA,CAAA;AAE9D,MAAA,MAAM,EAAE,KAAA,EAAW,GAAA,MAAM,MAAM,qBAAsB,CAAA;AAAA,QACnD,UAAA,EAAY,MAAM,GAAA,CAAI,uBAAwB,EAAA;AAAA,QAC9C,cAAgB,EAAA;AAAA,OACjB,CAAM,IAAA,EAAE,KAAO,EAAA,GAAA,CAAI,SAAS,cAAe,EAAA;AAE5C,MAAI,IAAA;AAEF,QAAA,MAAM,aAAc,CAAA,WAAA;AAAA,UAClB;AAAA,YACE,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA;AAAA,WACV;AAAA,UACA,KAAQ,GAAA,EAAE,KAAM,EAAA,GAAI;AAAC,SACvB;AAAA,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AAEnB,UAAM,MAAA,CAAA;AAAA;AACR;AAGF,MAAI,IAAA;AAEF,QAAM,MAAA,MAAA,GAAS,MAAM,aAAc,CAAA,WAAA;AAAA,UACjC;AAAA,YACE,MAAQ,EAAA,IAAA;AAAA,YACR,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA;AAAA,WACV;AAAA,UACA,KAAQ,GAAA,EAAE,KAAM,EAAA,GAAI;AAAC,SACvB;AAEA,QAAI,IAAA,MAAA,CAAO,SAAS,MAAQ,EAAA;AAC1B,UAAM,MAAA,EAAE,UAAa,GAAA,MAAA;AACrB,UAAI,IAAA,MAAA;AAEJ,UAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,YAChB,CAAA,CAAA,KACE,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,UAAW,CAAA,YAAY,CACxC,IAAA,CAAA,CAAE,IAAS,KAAA;AAAA,WACf;AACA,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,cAChB,OAAK,CAAC,CAAA,CAAE,QAAS,CAAA,IAAA,CAAK,WAAW,YAAY;AAAA,aAC/C;AAAA;AAEF,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,SAAS,CAAC,CAAA;AAAA;AAGrB,UAAA,GAAA,CAAI,MAAO,CAAA,WAAA,EAAaC,+BAAmB,CAAA,MAAM,CAAC,CAAA;AAAA;AACpD,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AACnB,UAAM,MAAA,CAAA;AAAA;AACR;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,kBAAkB,cAAc,CAAA;AAAA;AAC7C,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"register.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/register.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 { ScmIntegrations } from '@backstage/integration';\nimport { stringifyEntityRef, Entity } from '@backstage/catalog-model';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport { examples } from './register.examples';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\n\nconst id = 'catalog:register';\n\n/**\n * Registers entities from a catalog descriptor file in the workspace into the software catalog.\n * @public\n */\nexport function createCatalogRegisterAction(options: {\n  catalog: CatalogService;\n  integrations: ScmIntegrations;\n}) {\n  const { catalog, integrations } = options;\n\n  return createTemplateAction({\n    id,\n    description:\n      'Registers entities from a catalog descriptor file in the workspace into the software catalog.',\n    examples,\n    schema: {\n      input: z =>\n        z.union([\n          z.object({\n            catalogInfoUrl: z.string({\n              description:\n                'An absolute URL pointing to the catalog info file location',\n            }),\n            optional: z\n              .boolean({\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n              })\n              .optional(),\n          }),\n          z.object({\n            repoContentsUrl: z.string({\n              description:\n                'An absolute URL pointing to the root of a repository directory tree',\n            }),\n            catalogInfoPath: z\n              .string({\n                description:\n                  'A relative path from the repo root pointing to the catalog info file, defaults to /catalog-info.yaml',\n              })\n              .optional(),\n            optional: z\n              .boolean({\n                description:\n                  'Permit the registered location to optionally exist. Default: false',\n              })\n              .optional(),\n          }),\n        ]),\n    },\n    async handler(ctx) {\n      const { input } = ctx;\n\n      let catalogInfoUrl;\n      if ('catalogInfoUrl' in input) {\n        catalogInfoUrl = input.catalogInfoUrl;\n      } else {\n        const { repoContentsUrl, catalogInfoPath = '/catalog-info.yaml' } =\n          input;\n        const integration = integrations.byUrl(repoContentsUrl);\n        if (!integration) {\n          throw new InputError(\n            `No integration found for host ${repoContentsUrl}`,\n          );\n        }\n\n        catalogInfoUrl = integration.resolveUrl({\n          base: repoContentsUrl,\n          url: catalogInfoPath,\n        });\n      }\n\n      ctx.logger.info(`Registering ${catalogInfoUrl} in the catalog`);\n\n      try {\n        // 1st try to register the location, this will throw an error if the location already exists (see catch)\n        await catalog.addLocation(\n          {\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          { credentials: await ctx.getInitiatorCredentials() },\n        );\n      } catch (e) {\n        if (!input.optional) {\n          // if optional is false or unset, it is not allowed to register the same location twice, we rethrow the error\n          throw e;\n        }\n      }\n\n      try {\n        // 2nd retry the registration as a dry run, this will not throw an error if the location already exists\n        const result = await catalog.addLocation(\n          {\n            dryRun: true,\n            type: 'url',\n            target: catalogInfoUrl,\n          },\n          { credentials: await ctx.getInitiatorCredentials() },\n        );\n\n        if (result.entities.length) {\n          const { entities } = result;\n          let entity: Entity | undefined;\n          // prioritise 'Component' type as it is the most central kind of entity\n          entity = entities.find(\n            e =>\n              !e.metadata.name.startsWith('generated-') &&\n              e.kind === 'Component',\n          );\n          if (!entity) {\n            entity = entities.find(\n              e => !e.metadata.name.startsWith('generated-'),\n            );\n          }\n          if (!entity) {\n            entity = entities[0];\n          }\n\n          ctx.output('entityRef', stringifyEntityRef(entity));\n        }\n      } catch (e) {\n        if (!input.optional) {\n          throw e;\n        }\n      }\n\n      ctx.output('catalogInfoUrl', catalogInfoUrl);\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","InputError","stringifyEntityRef"],"mappings":";;;;;;;AAuBA,MAAM,EAAK,GAAA,kBAAA;AAMJ,SAAS,4BAA4B,OAGzC,EAAA;AACD,EAAM,MAAA,EAAE,OAAS,EAAA,YAAA,EAAiB,GAAA,OAAA;AAElC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WACE,EAAA,+FAAA;AAAA,cACFC,0BAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CAAE,KAAM,CAAA;AAAA,QACN,EAAE,MAAO,CAAA;AAAA,UACP,cAAA,EAAgB,EAAE,MAAO,CAAA;AAAA,YACvB,WACE,EAAA;AAAA,WACH,CAAA;AAAA,UACD,QAAA,EAAU,EACP,OAAQ,CAAA;AAAA,YACP,WACE,EAAA;AAAA,WACH,EACA,QAAS;AAAA,SACb,CAAA;AAAA,QACD,EAAE,MAAO,CAAA;AAAA,UACP,eAAA,EAAiB,EAAE,MAAO,CAAA;AAAA,YACxB,WACE,EAAA;AAAA,WACH,CAAA;AAAA,UACD,eAAA,EAAiB,EACd,MAAO,CAAA;AAAA,YACN,WACE,EAAA;AAAA,WACH,EACA,QAAS,EAAA;AAAA,UACZ,QAAA,EAAU,EACP,OAAQ,CAAA;AAAA,YACP,WACE,EAAA;AAAA,WACH,EACA,QAAS;AAAA,SACb;AAAA,OACF;AAAA,KACL;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA,EAAE,OAAU,GAAA,GAAA;AAElB,MAAI,IAAA,cAAA;AACJ,MAAA,IAAI,oBAAoB,KAAO,EAAA;AAC7B,QAAA,cAAA,GAAiB,KAAM,CAAA,cAAA;AAAA,OAClB,MAAA;AACL,QAAA,MAAM,EAAE,eAAA,EAAiB,eAAkB,GAAA,oBAAA,EACzC,GAAA,KAAA;AACF,QAAM,MAAA,WAAA,GAAc,YAAa,CAAA,KAAA,CAAM,eAAe,CAAA;AACtD,QAAA,IAAI,CAAC,WAAa,EAAA;AAChB,UAAA,MAAM,IAAIC,iBAAA;AAAA,YACR,iCAAiC,eAAe,CAAA;AAAA,WAClD;AAAA;AAGF,QAAA,cAAA,GAAiB,YAAY,UAAW,CAAA;AAAA,UACtC,IAAM,EAAA,eAAA;AAAA,UACN,GAAK,EAAA;AAAA,SACN,CAAA;AAAA;AAGH,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAe,YAAA,EAAA,cAAc,CAAiB,eAAA,CAAA,CAAA;AAE9D,MAAI,IAAA;AAEF,QAAA,MAAM,OAAQ,CAAA,WAAA;AAAA,UACZ;AAAA,YACE,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA;AAAA,WACV;AAAA,UACA,EAAE,WAAA,EAAa,MAAM,GAAA,CAAI,yBAA0B;AAAA,SACrD;AAAA,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AAEnB,UAAM,MAAA,CAAA;AAAA;AACR;AAGF,MAAI,IAAA;AAEF,QAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,WAAA;AAAA,UAC3B;AAAA,YACE,MAAQ,EAAA,IAAA;AAAA,YACR,IAAM,EAAA,KAAA;AAAA,YACN,MAAQ,EAAA;AAAA,WACV;AAAA,UACA,EAAE,WAAA,EAAa,MAAM,GAAA,CAAI,yBAA0B;AAAA,SACrD;AAEA,QAAI,IAAA,MAAA,CAAO,SAAS,MAAQ,EAAA;AAC1B,UAAM,MAAA,EAAE,UAAa,GAAA,MAAA;AACrB,UAAI,IAAA,MAAA;AAEJ,UAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,YAChB,CAAA,CAAA,KACE,CAAC,CAAE,CAAA,QAAA,CAAS,KAAK,UAAW,CAAA,YAAY,CACxC,IAAA,CAAA,CAAE,IAAS,KAAA;AAAA,WACf;AACA,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,QAAS,CAAA,IAAA;AAAA,cAChB,OAAK,CAAC,CAAA,CAAE,QAAS,CAAA,IAAA,CAAK,WAAW,YAAY;AAAA,aAC/C;AAAA;AAEF,UAAA,IAAI,CAAC,MAAQ,EAAA;AACX,YAAA,MAAA,GAAS,SAAS,CAAC,CAAA;AAAA;AAGrB,UAAA,GAAA,CAAI,MAAO,CAAA,WAAA,EAAaC,+BAAmB,CAAA,MAAM,CAAC,CAAA;AAAA;AACpD,eACO,CAAG,EAAA;AACV,QAAI,IAAA,CAAC,MAAM,QAAU,EAAA;AACnB,UAAM,MAAA,CAAA;AAAA;AACR;AAGF,MAAI,GAAA,CAAA,MAAA,CAAO,kBAAkB,cAAc,CAAA;AAAA;AAC7C,GACD,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/catalog/write.cjs.js

@@ -4,7 +4,6 @@ var fs = require('fs-extra');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var yaml = require('yaml');
 var backendPluginApi = require('@backstage/backend-plugin-api');
-var z = require('zod');
 var write_examples = require('./write.examples.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -36,13 +35,13 @@ function createCatalogWriteAction() {
     id,
     description: "Writes the catalog-info.yaml for your template",
     schema: {
-      input: z.z.object({
-        filePath: z.z.string().optional().describe("Defaults to catalog-info.yaml"),
+      input: {
+        filePath: (z) => z.string().optional().describe("Defaults to catalog-info.yaml"),
         // TODO: this should reference an zod entity validator if it existed.
-        entity: z.z.record(z.z.any()).describe(
+        entity: (z) => z.record(z.any()).describe(
           "You can provide the same values used in the Entity schema."
         )
-      })
+      }
     },
     examples: write_examples.examples,
     supportsDryRun: true,

package/dist/scaffolder/actions/builtin/catalog/write.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"write.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/write.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 fs from 'fs-extra';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport * as yaml from 'yaml';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { z } from 'zod';\nimport { examples } from './write.examples';\n\nconst id = 'catalog:write';\n\n/**\n * Writes a catalog descriptor file containing the provided entity to a path in the workspace.\n * @public\n */\n\nexport function createCatalogWriteAction() {\n  return createTemplateAction({\n    id,\n    description: 'Writes the catalog-info.yaml for your template',\n    schema: {\n      input: z.object({\n        filePath: z\n          .string()\n          .optional()\n          .describe('Defaults to catalog-info.yaml'),\n        // TODO: this should reference an zod entity validator if it existed.\n        entity: z\n          .record(z.any())\n          .describe(\n            'You can provide the same values used in the Entity schema.',\n          ),\n      }),\n    },\n    examples,\n    supportsDryRun: true,\n    async handler(ctx) {\n      const { filePath, entity } = ctx.input;\n      const entityRef = ctx.templateInfo?.entityRef;\n      const path = filePath ?? 'catalog-info.yaml';\n      ctx.logger.info(`Writing ${path}`);\n\n      await fs.outputFile(\n        resolveSafeChildPath(ctx.workspacePath, path),\n        yaml.stringify({\n          ...entity,\n          metadata: {\n            ...entity.metadata,\n            ...(entityRef\n              ? {\n                  annotations: {\n                    ...entity.metadata.annotations,\n                    'backstage.io/source-template': entityRef,\n                  },\n                }\n              : undefined),\n          },\n        }),\n      );\n    },\n  });\n}\n"],"names":["createTemplateAction","z","examples","fs","resolveSafeChildPath","yaml"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,wBAA2B,GAAA;AACzC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WAAa,EAAA,gDAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAA,EAAOC,IAAE,MAAO,CAAA;AAAA,QACd,UAAUA,GACP,CAAA,MAAA,GACA,QAAS,EAAA,CACT,SAAS,+BAA+B,CAAA;AAAA;AAAA,QAE3C,QAAQA,GACL,CAAA,MAAA,CAAOA,GAAE,CAAA,GAAA,EAAK,CACd,CAAA,QAAA;AAAA,UACC;AAAA;AACF,OACH;AAAA,KACH;AAAA,cACAC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,QAAA,EAAU,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA;AACjC,MAAM,MAAA,SAAA,GAAY,IAAI,YAAc,EAAA,SAAA;AACpC,MAAA,MAAM,OAAO,QAAY,IAAA,mBAAA;AACzB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAW,QAAA,EAAA,IAAI,CAAE,CAAA,CAAA;AAEjC,MAAA,MAAMC,mBAAG,CAAA,UAAA;AAAA,QACPC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,IAAI,CAAA;AAAA,QAC5CC,gBAAK,SAAU,CAAA;AAAA,UACb,GAAG,MAAA;AAAA,UACH,QAAU,EAAA;AAAA,YACR,GAAG,MAAO,CAAA,QAAA;AAAA,YACV,GAAI,SACA,GAAA;AAAA,cACE,WAAa,EAAA;AAAA,gBACX,GAAG,OAAO,QAAS,CAAA,WAAA;AAAA,gBACnB,8BAAgC,EAAA;AAAA;AAClC,aAEF,GAAA,KAAA;AAAA;AACN,SACD;AAAA,OACH;AAAA;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"write.cjs.js","sources":["../../../../../src/scaffolder/actions/builtin/catalog/write.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 fs from 'fs-extra';\nimport { createTemplateAction } from '@backstage/plugin-scaffolder-node';\nimport * as yaml from 'yaml';\nimport { resolveSafeChildPath } from '@backstage/backend-plugin-api';\nimport { examples } from './write.examples';\n\nconst id = 'catalog:write';\n\n/**\n * Writes a catalog descriptor file containing the provided entity to a path in the workspace.\n * @public\n */\n\nexport function createCatalogWriteAction() {\n  return createTemplateAction({\n    id,\n    description: 'Writes the catalog-info.yaml for your template',\n    schema: {\n      input: {\n        filePath: z =>\n          z.string().optional().describe('Defaults to catalog-info.yaml'),\n        // TODO: this should reference an zod entity validator if it existed.\n        entity: z =>\n          z\n            .record(z.any())\n            .describe(\n              'You can provide the same values used in the Entity schema.',\n            ),\n      },\n    },\n    examples,\n    supportsDryRun: true,\n    async handler(ctx) {\n      const { filePath, entity } = ctx.input;\n      const entityRef = ctx.templateInfo?.entityRef;\n      const path = filePath ?? 'catalog-info.yaml';\n      ctx.logger.info(`Writing ${path}`);\n\n      await fs.outputFile(\n        resolveSafeChildPath(ctx.workspacePath, path),\n        yaml.stringify({\n          ...entity,\n          metadata: {\n            ...entity.metadata,\n            ...(entityRef\n              ? {\n                  annotations: {\n                    ...entity.metadata.annotations,\n                    'backstage.io/source-template': entityRef,\n                  },\n                }\n              : undefined),\n          },\n        }),\n      );\n    },\n  });\n}\n"],"names":["createTemplateAction","examples","fs","resolveSafeChildPath","yaml"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBA,MAAM,EAAK,GAAA,eAAA;AAOJ,SAAS,wBAA2B,GAAA;AACzC,EAAA,OAAOA,yCAAqB,CAAA;AAAA,IAC1B,EAAA;AAAA,IACA,WAAa,EAAA,gDAAA;AAAA,IACb,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAA,EAAU,OACR,CAAE,CAAA,MAAA,GAAS,QAAS,EAAA,CAAE,SAAS,+BAA+B,CAAA;AAAA;AAAA,QAEhE,QAAQ,CACN,CAAA,KAAA,CAAA,CACG,OAAO,CAAE,CAAA,GAAA,EAAK,CACd,CAAA,QAAA;AAAA,UACC;AAAA;AACF;AACN,KACF;AAAA,cACAC,uBAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,QAAA,EAAU,MAAO,EAAA,GAAI,GAAI,CAAA,KAAA;AACjC,MAAM,MAAA,SAAA,GAAY,IAAI,YAAc,EAAA,SAAA;AACpC,MAAA,MAAM,OAAO,QAAY,IAAA,mBAAA;AACzB,MAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAW,QAAA,EAAA,IAAI,CAAE,CAAA,CAAA;AAEjC,MAAA,MAAMC,mBAAG,CAAA,UAAA;AAAA,QACPC,qCAAA,CAAqB,GAAI,CAAA,aAAA,EAAe,IAAI,CAAA;AAAA,QAC5CC,gBAAK,SAAU,CAAA;AAAA,UACb,GAAG,MAAA;AAAA,UACH,QAAU,EAAA;AAAA,YACR,GAAG,MAAO,CAAA,QAAA;AAAA,YACV,GAAI,SACA,GAAA;AAAA,cACE,WAAa,EAAA;AAAA,gBACX,GAAG,OAAO,QAAS,CAAA,WAAA;AAAA,gBACnB,8BAAgC,EAAA;AAAA;AAClC,aAEF,GAAA,KAAA;AAAA;AACN,SACD;AAAA,OACH;AAAA;AACF,GACD,CAAA;AACH;;;;"}

package/dist/scaffolder/actions/builtin/debug/log.cjs.js

@@ -5,7 +5,6 @@ var path = require('path');
 var pluginScaffolderNode = require('@backstage/plugin-scaffolder-node');
 var log_examples = require('./log.examples.cjs.js');
 var fs = require('fs');
-var z = require('zod');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -18,12 +17,12 @@ function createDebugLogAction() {
     description: "Writes a message into the log and/or lists all files in the workspace.",
     examples: log_examples.examples,
     schema: {
-      input: z.z.object({
-        message: z.z.string({ description: "Message to output." }).optional(),
-        listWorkspace: z.z.union([z.z.boolean(), z.z.enum(["with-filenames", "with-contents"])], {
+      input: {
+        message: (z) => z.string({ description: "Message to output." }).optional(),
+        listWorkspace: (z) => z.union([z.boolean(), z.enum(["with-filenames", "with-contents"])], {
           description: 'List all files in the workspace. If used with "with-contents", also the file contents are listed.'
         }).optional()
-      })
+      }
     },
     supportsDryRun: true,
     async handler(ctx) {