@backstage/cli 0.36.0-next.1 → 0.36.0

package/templates/backend-plugin/src/plugin.ts.hbs

@@ -1,32 +0,0 @@
-import {
-  coreServices,
-  createBackendPlugin,
-} from '@backstage/backend-plugin-api';
-import { createRouter } from './router';
-import { todoListServiceRef } from './services/TodoListService';
-
-/**
- * {{pluginVar}} backend plugin
- *
- * @public
- */
-export const {{pluginVar}} = createBackendPlugin({
-  pluginId: '{{pluginId}}',
-  register(env) {
-    env.registerInit({
-      deps: {
-        httpAuth: coreServices.httpAuth,
-        httpRouter: coreServices.httpRouter,
-        todoList: todoListServiceRef,
-      },
-      async init({ httpAuth, httpRouter, todoList }) {
-        httpRouter.use(
-          await createRouter({
-            httpAuth,
-            todoList,
-          }),
-        );
-      },
-    });
-  },
-});

package/templates/backend-plugin/src/router.test.ts

@@ -1,67 +0,0 @@
-import {
-  mockCredentials,
-  mockErrorHandler,
-  mockServices,
-} from '@backstage/backend-test-utils';
-import express from 'express';
-import request from 'supertest';
-
-import { createRouter } from './router';
-import { todoListServiceRef } from './services/TodoListService';
-
-const mockTodoItem = {
-  title: 'Do the thing',
-  id: '123',
-  createdBy: mockCredentials.user().principal.userEntityRef,
-  createdAt: new Date().toISOString(),
-};
-
-// TEMPLATE NOTE:
-// Testing the router directly allows you to write a unit test that mocks the provided options.
-describe('createRouter', () => {
-  let app: express.Express;
-  let todoList: jest.Mocked<typeof todoListServiceRef.T>;
-
-  beforeEach(async () => {
-    todoList = {
-      createTodo: jest.fn(),
-      listTodos: jest.fn(),
-      getTodo: jest.fn(),
-    };
-    const router = await createRouter({
-      httpAuth: mockServices.httpAuth(),
-      todoList,
-    });
-    app = express();
-    app.use(router);
-    app.use(mockErrorHandler());
-  });
-
-  it('should create a TODO', async () => {
-    todoList.createTodo.mockResolvedValue(mockTodoItem);
-
-    const response = await request(app).post('/todos').send({
-      title: 'Do the thing',
-    });
-
-    expect(response.status).toBe(201);
-    expect(response.body).toEqual(mockTodoItem);
-  });
-
-  it('should not allow unauthenticated requests to create a TODO', async () => {
-    todoList.createTodo.mockResolvedValue(mockTodoItem);
-
-    // TEMPLATE NOTE:
-    // The HttpAuth mock service considers all requests to be authenticated as a
-    // mock user by default. In order to test other cases we need to explicitly
-    // pass an authorization header with mock credentials.
-    const response = await request(app)
-      .post('/todos')
-      .set('Authorization', mockCredentials.none.header())
-      .send({
-        title: 'Do the thing',
-      });
-
-    expect(response.status).toBe(401);
-  });
-});

package/templates/backend-plugin/src/router.ts

@@ -1,51 +0,0 @@
-import { HttpAuthService } from '@backstage/backend-plugin-api';
-import { InputError } from '@backstage/errors';
-import { z } from 'zod';
-import express from 'express';
-import Router from 'express-promise-router';
-import { todoListServiceRef } from './services/TodoListService';
-
-export async function createRouter({
-  httpAuth,
-  todoList,
-}: {
-  httpAuth: HttpAuthService;
-  todoList: typeof todoListServiceRef.T;
-}): Promise<express.Router> {
-  const router = Router();
-  router.use(express.json());
-
-  // TEMPLATE NOTE:
-  // Zod is a powerful library for data validation and recommended in particular
-  // for user-defined schemas. In this case we use it for input validation too.
-  //
-  // If you want to define a schema for your API we recommend using Backstage's
-  // OpenAPI tooling: https://backstage.io/docs/next/openapi/01-getting-started
-  const todoSchema = z.object({
-    title: z.string(),
-    entityRef: z.string().optional(),
-  });
-
-  router.post('/todos', async (req, res) => {
-    const parsed = todoSchema.safeParse(req.body);
-    if (!parsed.success) {
-      throw new InputError(parsed.error.toString());
-    }
-
-    const result = await todoList.createTodo(parsed.data, {
-      credentials: await httpAuth.credentials(req, { allow: ['user'] }),
-    });
-
-    res.status(201).json(result);
-  });
-
-  router.get('/todos', async (_req, res) => {
-    res.json(await todoList.listTodos());
-  });
-
-  router.get('/todos/:id', async (req, res) => {
-    res.json(await todoList.getTodo({ id: req.params.id }));
-  });
-
-  return router;
-}

package/templates/backend-plugin/src/services/TodoListService.ts

@@ -1,155 +0,0 @@
-/*
- * Copyright 2025 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import crypto from 'node:crypto';
-import {
-  coreServices,
-  createServiceFactory,
-  createServiceRef,
-  LoggerService,
-} from '@backstage/backend-plugin-api';
-import { NotFoundError } from '@backstage/errors';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node';
-import {
-  BackstageCredentials,
-  BackstageUserPrincipal,
-} from '@backstage/backend-plugin-api';
-import { Expand } from '@backstage/types';
-
-export interface TodoItem {
-  title: string;
-  id: string;
-  createdBy: string;
-  createdAt: string;
-}
-
-// TEMPLATE NOTE:
-// This is a simple in-memory todo list store. It is recommended to use a
-// database to store data in a real application. See the database service
-// documentation for more information on how to do this:
-// https://backstage.io/docs/backend-system/core-services/database
-export class TodoListService {
-  readonly #logger: LoggerService;
-  readonly #catalog: typeof catalogServiceRef.T;
-
-  readonly #storedTodos = new Array<TodoItem>();
-
-  static create(options: {
-    logger: LoggerService;
-    catalog: typeof catalogServiceRef.T;
-  }) {
-    return new TodoListService(options.logger, options.catalog);
-  }
-
-  private constructor(
-    logger: LoggerService,
-    catalog: typeof catalogServiceRef.T,
-  ) {
-    this.#logger = logger;
-    this.#catalog = catalog;
-  }
-
-  async createTodo(
-    input: {
-      title: string;
-      entityRef?: string;
-    },
-    options: {
-      credentials: BackstageCredentials<BackstageUserPrincipal>;
-    },
-  ): Promise<TodoItem> {
-    let title = input.title;
-
-    // TEMPLATE NOTE:
-    // A common pattern for Backstage plugins is to pass an entity reference
-    // from the frontend to then fetch the entire entity from the catalog in the
-    // backend plugin.
-    if (input.entityRef) {
-      // TEMPLATE NOTE:
-      // Cross-plugin communication uses service-to-service authentication. The
-      // `AuthService` lets you generate a token that is valid for communication
-      // with the target plugin only. You must also provide credentials for the
-      // identity that you are making the request on behalf of.
-      //
-      // If you want to make a request using the plugin backend's own identity,
-      // you can access it via the `auth.getOwnServiceCredentials()` method.
-      // Beware that this bypasses any user permission checks.
-      const entity = await this.#catalog.getEntityByRef(
-        input.entityRef,
-        options,
-      );
-      if (!entity) {
-        throw new NotFoundError(`No entity found for ref '${input.entityRef}'`);
-      }
-
-      // TEMPLATE NOTE:
-      // Here you could read any form of data from the entity. A common use case
-      // is to read the value of a custom annotation for your plugin. You can
-      // read more about how to add custom annotations here:
-      // https://backstage.io/docs/features/software-catalog/extending-the-model#adding-a-new-annotation
-      //
-      // In this example we just use the entity title to decorate the todo item.
-
-      const entityDisplay = entity.metadata.title ?? input.entityRef;
-      title = `[${entityDisplay}] ${input.title}`;
-    }
-
-    const id = crypto.randomUUID();
-    const createdBy = options.credentials.principal.userEntityRef;
-    const newTodo = {
-      title,
-      id,
-      createdBy,
-      createdAt: new Date().toISOString(),
-    };
-
-    this.#storedTodos.push(newTodo);
-
-    // TEMPLATE NOTE:
-    // The second argument of the logger methods can be used to pass
-    // structured metadata. You can read more about the logger service here:
-    // https://backstage.io/docs/backend-system/core-services/logger
-    this.#logger.info('Created new todo item', { id, title, createdBy });
-
-    return newTodo;
-  }
-
-  async listTodos(): Promise<{ items: TodoItem[] }> {
-    return { items: Array.from(this.#storedTodos) };
-  }
-
-  async getTodo(request: { id: string }): Promise<TodoItem> {
-    const todo = this.#storedTodos.find(item => item.id === request.id);
-    if (!todo) {
-      throw new NotFoundError(`No todo found with id '${request.id}'`);
-    }
-    return todo;
-  }
-}
-
-export const todoListServiceRef = createServiceRef<Expand<TodoListService>>({
-  id: 'todo.list',
-  defaultFactory: async service =>
-    createServiceFactory({
-      service,
-      deps: {
-        logger: coreServices.logger,
-        catalog: catalogServiceRef,
-      },
-      async factory(deps) {
-        return TodoListService.create(deps);
-      },
-    }),
-});

package/templates/backend-plugin/src/setupTests.ts

@@ -1 +0,0 @@
-export {};

package/templates/backend-plugin-module/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

package/templates/backend-plugin-module/README.md.hbs

@@ -1,5 +0,0 @@
-# {{packageName}}
-
-The {{moduleId}} backend module for the {{pluginId}} plugin.
-
-_This plugin was created through the Backstage CLI_

package/templates/backend-plugin-module/package.json.hbs

@@ -1,34 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "description": "The {{moduleId}} backend module for the {{pluginId}} plugin.",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "backend-plugin-module",
-    "pluginId": "{{pluginId}}"
-  },
-  "scripts": {
-    "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "dependencies": {
-    "@backstage/backend-plugin-api": "{{versionQuery '@backstage/backend-plugin-api'}}"
-  },
-  "devDependencies": {
-    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}",
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

package/templates/backend-plugin-module/portable-template.yaml

@@ -1,5 +0,0 @@
-name: backend-plugin-module
-role: backend-plugin-module
-description: A new backend module that extends an existing backend plugin
-values:
-  moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'

package/templates/backend-plugin-module/src/index.ts.hbs

@@ -1,8 +0,0 @@
-/***/
-/**
- * The {{moduleId}} backend module for the {{pluginId}} plugin.
- *
- * @packageDocumentation
- */
-
-export { {{moduleVar}} as default } from './module';

package/templates/backend-plugin-module/src/module.ts.hbs

@@ -1,17 +0,0 @@
-import {
-  coreServices,
-  createBackendModule,
-} from '@backstage/backend-plugin-api';
-
-export const {{moduleVar}} = createBackendModule({
-  pluginId: '{{pluginId}}',
-  moduleId: '{{moduleId}}',
-  register(reg) {
-    reg.registerInit({
-      deps: { logger: coreServices.logger },
-      async init({ logger }) {
-        logger.info('Hello World!');
-      },
-    });
-  },
-});

package/templates/catalog-provider-module/.eslintrc.js.hbs

@@ -1 +0,0 @@
-module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

package/templates/catalog-provider-module/README.md.hbs

@@ -1,5 +0,0 @@
-# {{packageName}}
-
-The {{fullModuleId}} module for [@backstage/plugin-catalog-backend](https://www.npmjs.com/package/@backstage/plugin-catalog-backend).
-
-_This plugin was created through the Backstage CLI_

package/templates/catalog-provider-module/config.d.ts.hbs

@@ -1,34 +0,0 @@
-import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
-
-export interface Config {
-  catalog?: {
-    providers?: {
-      /**
-       * {{providerClass}} configuration.
-       */
-      {{providerVar}}?:
-        | {
-            /**
-             * The target that this provider should consume.
-             */
-            target: string;
-            /**
-             * Overrides the schedule at which this provider runs.
-             */
-            schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
-          }
-        | {
-            [name: string]: {
-              /**
-               * The target that this provider should consume.
-               */
-              target: string;
-              /**
-               * Overrides the schedule at which this provider runs.
-               */
-              schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
-            };
-          };
-    };
-  };
-}

package/templates/catalog-provider-module/package.json.hbs

@@ -1,36 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "description": "The {{fullModuleId}} module for @backstage/plugin-catalog-backend",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "backend-plugin-module",
-    "pluginId": "catalog",
-    "pluginPackage": "@backstage/plugin-catalog-backend"
-  },
-  "scripts": {
-    "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
-  },
-  "dependencies": {
-    "@backstage/backend-plugin-api": "{{versionQuery '@backstage/backend-plugin-api'}}",
-    "@backstage/plugin-catalog-node": "{{versionQuery '@backstage/plugin-catalog-node'}}"
-  },
-  "devDependencies": {
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

package/templates/catalog-provider-module/portable-template.yaml

@@ -1,9 +0,0 @@
-name: catalog-provider-module
-role: backend-plugin-module
-description: An Entity Provider module for the Software Catalog
-values:
-  pluginId: catalog
-  fullModuleId: '{{ moduleId }}-provider'
-  moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'
-  providerVar: '{{ camelCase moduleId }}Provider'
-  providerClass: '{{ upperFirst ( camelCase moduleId ) }}Provider'

package/templates/catalog-provider-module/src/index.ts.hbs

@@ -1,8 +0,0 @@
-/***/
-/**
- * The {{fullModuleId}} module for @backstage/plugin-catalog-backend
- *
- * @packageDocumentation
- */
-
-export { {{moduleVar}} as default } from './module';

package/templates/catalog-provider-module/src/module.ts.hbs

@@ -1,29 +0,0 @@
-import {
-  coreServices,
-  createBackendModule,
-} from '@backstage/backend-plugin-api';
-import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';
-import { {{providerClass}} } from './provider/{{providerClass}}';
-
-export const {{moduleVar}} = createBackendModule({
-  moduleId: '{{fullModuleId}}',
-  pluginId: '{{pluginId}}',
-  register({ registerInit }) {
-    registerInit({
-      deps: {
-        logger: coreServices.logger,
-        config: coreServices.rootConfig,
-        scheduler: coreServices.scheduler,
-        processing: catalogProcessingExtensionPoint,
-      },
-      async init({ logger, scheduler, config, processing }) {
-        processing.addEntityProvider(
-          {{providerClass}}.fromConfig(config, {
-            logger,
-            scheduler,
-          }),
-        );
-      }
-    });
-  },
-})

package/templates/catalog-provider-module/src/provider/readProviderConfigs.ts.hbs

@@ -1,78 +0,0 @@
-import {
-  readSchedulerServiceTaskScheduleDefinitionFromConfig,
-  SchedulerServiceTaskScheduleDefinition,
-} from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-
-const DEFAULT_PROVIDER_ID = 'default';
-const DEFAULT_SCHEDULE: SchedulerServiceTaskScheduleDefinition = {
-  frequency: {
-    minutes: 30,
-  },
-  timeout: {
-    minutes: 3,
-  },
-}
-
-export type {{providerClass}}ProviderConfig = {
-  id: string;
-  target: string;
-  schedule: SchedulerServiceTaskScheduleDefinition;
-}
-
-/**
- * Parses all configured providers.
- *
- * @param config - The root of the provider config hierarchy
- *
- * @public
- */
-export function readProviderConfigs(
-  config: Config,
-): {{providerClass}}ProviderConfig[] {
-  const providersConfig = config.getOptionalConfig(
-    'catalog.providers.{{providerVar}}',
-  );
-  if (!providersConfig) {
-    return [];
-  }
-
-  if ((providersConfig).has('target')) {
-    // simple/single config variant
-    return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];
-  }
-
-  return providersConfig.keys().map(id => {
-    const providerConfig = providersConfig.getConfig(id);
-
-    return readProviderConfig(id, providerConfig);
-  });
-}
-
-/**
- * Parses a single configured provider by id.
- *
- * @param id - the id of the provider to parse
- * @param config - The root of the provider config hierarchy
- *
- * @public
- */
-export function readProviderConfig(
-  id: string,
-  config: Config,
-): {{providerClass}}ProviderConfig {
-
-  const target = config.getString('target');
-
-  const schedule = config.has('schedule')
-    ? readSchedulerServiceTaskScheduleDefinitionFromConfig(
-        config.getConfig('schedule'),
-      )
-    : DEFAULT_SCHEDULE;
-
-  return {
-    id,
-    target,
-    schedule,
-  };
-}

package/templates/catalog-provider-module/src/provider/{{providerClass}}.test.ts.hbs

@@ -1,18 +0,0 @@
-import { {{providerClass}} } from './{{providerClass}}';
-import { mockServices } from '@backstage/backend-test-utils';
-
-describe('{{providerClass}}', () => {
-  it('should read entities from the target', async () => {
-    const logger = mockServices.logger.mock();
-    const provider = new {{providerClass}}({
-      id: 'test',
-      target: 'https://example.com',
-      logger: mockServices.logger.mock(),
-      taskRunner: { run: jest.fn() },
-    });
-
-    const entities = await provider.read({ logger });
-
-    expect(entities).toEqual([]);
-  });
-})