@backstage/cli 0.36.0-next.2 → 0.36.0

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([]);
-  });
-})

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

@@ -1,109 +0,0 @@
-import { Config } from '@backstage/config';
-import {
-  DeferredEntity,
-  EntityProvider,
-  EntityProviderConnection,
-} from '@backstage/plugin-catalog-node';
-import * as uuid from 'uuid';
-import { readProviderConfigs } from './readProviderConfigs';
-import {
-  LoggerService,
-  SchedulerService,
-  SchedulerServiceTaskRunner,
-} from '@backstage/backend-plugin-api';
-
-export type {{providerClass}}Options = {
-  /**
-   * The logger to use.
-   */
-  logger: LoggerService;
-
-  /**
-   * Scheduler used to schedule refreshes based on
-   * the schedule config.
-   */
-  scheduler: SchedulerService;
-};
-
-export class {{providerClass}} implements EntityProvider {
-  static fromConfig(
-    configRoot: Config,
-    options: {{providerClass}}Options,
-  ): {{providerClass}}[] {
-    return readProviderConfigs(configRoot).map(providerConfig => {
-      return new {{providerClass}}({
-        id: providerConfig.id,
-        target: providerConfig.target,
-        logger: options.logger,
-        taskRunner: options.scheduler.createScheduledTaskRunner(
-          providerConfig.schedule,
-        ),
-      });
-    });
-  }
-
-  readonly #id: string;
-  readonly #target: string;
-  readonly #logger: LoggerService;
-  readonly #taskRunner: SchedulerServiceTaskRunner;
-
-  constructor(options: {
-    id: string;
-    target: string;
-    logger: LoggerService;
-    taskRunner: SchedulerServiceTaskRunner;
-  }) {
-    this.#id = options.id;
-    this.#target = options.target;
-    this.#logger = options.logger;
-    this.#taskRunner = options.taskRunner;
-  }
-
-  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
-  getProviderName() {
-    return `{{providerClass}}:${this.#id}`;
-  }
-
-  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
-  async connect(connection: EntityProviderConnection) {
-    const id = `${this.getProviderName()}:refresh`;
-
-    // Schedule a refresh task to be run periodically
-    await this.#taskRunner.run({
-      id,
-      fn: async () => {
-        const logger = this.#logger.child({
-          taskId: id,
-          taskInstanceId: uuid.v4(),
-        });
-
-        try {
-          const entities = await this.read({ logger });
-
-          logger.info(`Read ${entities.length} entities`);
-
-          await connection.applyMutation({
-            type: 'full',
-            entities,
-          });
-        } catch (error) {
-          logger.error(`Refresh failed`, error);
-        }
-      },
-    });
-  }
-
-  /**
-   * Reads entities to be added to the catalog.
-   */
-  async read(options: { logger: LoggerService }): Promise<DeferredEntity[]> {
-    const { logger } = options;
-
-    logger.info(`Reading entities from ${this.#target}`);
-
-    // TODO: Implement entity reading logic from the target
-    const entities: DeferredEntity[] = [];
-
-    return entities;
-  }
-}

package/templates/frontend-plugin/.eslintrc.js.hbs

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

package/templates/frontend-plugin/README.md.hbs

@@ -1,13 +0,0 @@
-# {{pluginId}}
-
-Welcome to the {{pluginId}} plugin!
-
-_This plugin was created through the Backstage CLI_
-
-## Getting started
-
-Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/{{pluginId}}](http://localhost:3000/{{pluginId}}).
-
-You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
-This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
-It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.

package/templates/frontend-plugin/dev/index.tsx.hbs

@@ -1,11 +0,0 @@
-import { createDevApp } from '@backstage/dev-utils';
-import { {{ pluginVar }}, {{ extensionName }} } from '../src/plugin';
-
-createDevApp()
-  .registerPlugin({{ pluginVar }})
-  .addPage({
-    element: <{{ extensionName }} />,
-    title: 'Root Page',
-    path: '/{{pluginId}}',
-  })
-  .render();

package/templates/frontend-plugin/package.json.hbs

@@ -1,54 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
-  },
-  "backstage": {
-    "role": "frontend-plugin",
-    "pluginId": "{{pluginId}}"
-  },
-  "sideEffects": false,
-  "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/core-components": "{{versionQuery '@backstage/core-components'}}",
-    "@backstage/core-plugin-api": "{{versionQuery '@backstage/core-plugin-api'}}",
-    "@backstage/theme": "{{versionQuery '@backstage/theme'}}",
-    "@material-ui/core": "{{versionQuery '@material-ui/core' '4.12.2'}}",
-    "@material-ui/icons": "{{versionQuery '@material-ui/icons' '4.9.1'}}",
-    "@material-ui/lab": "{{versionQuery '@material-ui/lab' '4.0.0-alpha.61'}}",
-    "react-use": "{{versionQuery 'react-use' '17.2.4'}}"
-  },
-  "peerDependencies": {
-    "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0 || ^18.0.0'}}",
-    "react-dom": "{{versionQuery 'react-dom' '^16.13.1 || ^17.0.0 || ^18.0.0'}}",
-    "react-router-dom": "{{versionQuery 'react-router-dom' '^6.0.0'}}"
-  },
-  "devDependencies": {
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@backstage/core-app-api": "{{versionQuery '@backstage/core-app-api'}}",
-    "@backstage/dev-utils": "{{versionQuery '@backstage/dev-utils'}}",
-    "@backstage/test-utils": "{{versionQuery '@backstage/test-utils'}}",
-    "@testing-library/jest-dom": "{{versionQuery '@testing-library/jest-dom' '6.0.0'}}",
-    "@testing-library/react": "{{versionQuery '@testing-library/react' '14.0.0'}}",
-    "@testing-library/user-event": "{{versionQuery '@testing-library/user-event' '14.0.0'}}",
-    "msw": "{{versionQuery 'msw' '1.0.0'}}",
-    "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0 || ^18.0.0'}}",
-    "react-dom": "{{versionQuery 'react-dom' '^16.13.1 || ^17.0.0 || ^18.0.0'}}",
-    "react-router-dom": "{{versionQuery 'react-router-dom' '^6.0.0'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

package/templates/frontend-plugin/portable-template.yaml

@@ -1,6 +0,0 @@
-name: frontend-plugin
-role: frontend-plugin
-description: A new frontend plugin
-values:
-  pluginVar: '{{ camelCase pluginId }}Plugin'
-  extensionName: '{{ upperFirst ( camelCase pluginId ) }}Page'