@backstage/cli 0.34.1 → 0.34.2-next.2

package/CHANGELOG.md

@@ -1,11 +1,38 @@
 # @backstage/cli
 
-## 0.34.1
+## 0.34.2-next.2
 
 ### Patch Changes
 
-- f470192: Fixed the `new-frontend-plugin` template that was incorrectly passing `id` instead of `pluginId` to `createFrontendPlugin` and unnecessarily importing `React`.
-- d778acb: Fixed an issue that could cause conflicts of detected modules in workspaces with multiple apps.
+- Updated dependencies
+  - @backstage/config-loader@1.10.3-next.0
+  - @backstage/integration@1.18.0-next.0
+
+## 0.34.2-next.1
+
+### Patch Changes
+
+- e1adce4: Updated the backend plugin template to use a new pattern for the `TodoListService` that reduces boilerplate.
+- Updated dependencies
+  - @backstage/integration@1.18.0-next.0
+
+## 0.34.1-next.0
+
+### Patch Changes
+
+- 080f252: Fixed the `new-frontend-plugin` template that was incorrectly passing `id` instead of `pluginId` to `createFrontendPlugin` and unnecessarily importing `React`.
+- 275bda8: Fixed an issue that could cause conflicts of detected modules in workspaces with multiple apps.
+- Updated dependencies
+  - @backstage/catalog-model@1.7.5
+  - @backstage/cli-common@0.1.15
+  - @backstage/cli-node@0.2.14
+  - @backstage/config@1.3.3
+  - @backstage/config-loader@1.10.2
+  - @backstage/errors@1.2.7
+  - @backstage/eslint-plugin@0.1.11
+  - @backstage/integration@1.17.1
+  - @backstage/release-manifests@0.0.13
+  - @backstage/types@1.2.1
 
 ## 0.34.0
 

package/dist/lib/version.cjs.js

@@ -3,27 +3,28 @@
 var fs = require('fs-extra');
 var semver = require('semver');
 var paths = require('./paths.cjs.js');
-var _package$j = require('../packages/backend-plugin-api/package.json.cjs.js');
-var _package$i = require('../packages/backend-test-utils/package.json.cjs.js');
-var _package$h = require('../packages/catalog-client/package.json.cjs.js');
-var _package$g = require('../packages/cli/package.json.cjs.js');
-var _package$f = require('../packages/config/package.json.cjs.js');
-var _package$e = require('../packages/core-app-api/package.json.cjs.js');
-var _package$d = require('../packages/core-components/package.json.cjs.js');
-var _package$c = require('../packages/core-plugin-api/package.json.cjs.js');
-var _package$b = require('../packages/dev-utils/package.json.cjs.js');
-var _package$a = require('../packages/errors/package.json.cjs.js');
-var _package$9 = require('../packages/frontend-defaults/package.json.cjs.js');
-var _package$8 = require('../packages/frontend-plugin-api/package.json.cjs.js');
-var _package$7 = require('../packages/frontend-test-utils/package.json.cjs.js');
-var _package$6 = require('../packages/test-utils/package.json.cjs.js');
+var _package$k = require('../packages/backend-plugin-api/package.json.cjs.js');
+var _package$j = require('../packages/backend-test-utils/package.json.cjs.js');
+var _package$i = require('../packages/catalog-client/package.json.cjs.js');
+var _package$h = require('../packages/cli/package.json.cjs.js');
+var _package$g = require('../packages/config/package.json.cjs.js');
+var _package$f = require('../packages/core-app-api/package.json.cjs.js');
+var _package$e = require('../packages/core-components/package.json.cjs.js');
+var _package$d = require('../packages/core-plugin-api/package.json.cjs.js');
+var _package$c = require('../packages/dev-utils/package.json.cjs.js');
+var _package$b = require('../packages/errors/package.json.cjs.js');
+var _package$a = require('../packages/frontend-defaults/package.json.cjs.js');
+var _package$9 = require('../packages/frontend-plugin-api/package.json.cjs.js');
+var _package$8 = require('../packages/frontend-test-utils/package.json.cjs.js');
+var _package$7 = require('../packages/test-utils/package.json.cjs.js');
 var _package$4 = require('../plugins/scaffolder-node/package.json.cjs.js');
 var _package$3 = require('../plugins/scaffolder-node-test-utils/package.json.cjs.js');
 var _package$2 = require('../plugins/auth-backend/package.json.cjs.js');
 var _package$1 = require('../plugins/auth-backend-module-guest-provider/package.json.cjs.js');
 var _package = require('../plugins/catalog-node/package.json.cjs.js');
-var _package$5 = require('../packages/theme/package.json.cjs.js');
-var _package$k = require('../packages/backend-defaults/package.json.cjs.js');
+var _package$6 = require('../packages/theme/package.json.cjs.js');
+var _package$5 = require('../packages/types/package.json.cjs.js');
+var _package$l = require('../packages/backend-defaults/package.json.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -31,22 +32,23 @@ var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var semver__default = /*#__PURE__*/_interopDefaultCompat(semver);
 
 const packageVersions = {
-  "@backstage/backend-defaults": _package$k.version,
-  "@backstage/backend-plugin-api": _package$j.version,
-  "@backstage/backend-test-utils": _package$i.version,
-  "@backstage/catalog-client": _package$h.version,
-  "@backstage/cli": _package$g.version,
-  "@backstage/config": _package$f.version,
-  "@backstage/core-app-api": _package$e.version,
-  "@backstage/core-components": _package$d.version,
-  "@backstage/core-plugin-api": _package$c.version,
-  "@backstage/dev-utils": _package$b.version,
-  "@backstage/errors": _package$a.version,
-  "@backstage/frontend-defaults": _package$9.version,
-  "@backstage/frontend-plugin-api": _package$8.version,
-  "@backstage/frontend-test-utils": _package$7.version,
-  "@backstage/test-utils": _package$6.version,
-  "@backstage/theme": _package$5.version,
+  "@backstage/backend-defaults": _package$l.version,
+  "@backstage/backend-plugin-api": _package$k.version,
+  "@backstage/backend-test-utils": _package$j.version,
+  "@backstage/catalog-client": _package$i.version,
+  "@backstage/cli": _package$h.version,
+  "@backstage/config": _package$g.version,
+  "@backstage/core-app-api": _package$f.version,
+  "@backstage/core-components": _package$e.version,
+  "@backstage/core-plugin-api": _package$d.version,
+  "@backstage/dev-utils": _package$c.version,
+  "@backstage/errors": _package$b.version,
+  "@backstage/frontend-defaults": _package$a.version,
+  "@backstage/frontend-plugin-api": _package$9.version,
+  "@backstage/frontend-test-utils": _package$8.version,
+  "@backstage/test-utils": _package$7.version,
+  "@backstage/theme": _package$6.version,
+  "@backstage/types": _package$5.version,
   "@backstage/plugin-scaffolder-node": _package$4.version,
   "@backstage/plugin-scaffolder-node-test-utils": _package$3.version,
   "@backstage/plugin-auth-backend": _package$2.version,

package/dist/packages/backend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.12.0";
+var version = "0.12.1-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.4.2";
+var version = "1.4.3-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.8.0";
+var version = "1.9.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/catalog-client/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.11.0";
+var version = "1.12.0-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/cli/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.34.1";
+var version = "0.34.2-next.2";
 var dependencies = {
 	"@backstage/catalog-model": "workspace:^",
 	"@backstage/cli-common": "workspace:^",

package/dist/packages/core-components/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.17.5";
+var version = "0.17.6-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/dev-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.1.13";
+var version = "1.1.14-next.2";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.0";
+var version = "0.3.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.11.0";
+var version = "0.11.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.5";
+var version = "0.3.6-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/types/package.json.cjs.js

@@ -0,0 +1,6 @@
+'use strict';
+
+var version = "1.2.1";
+
+exports.version = version;
+//# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.25.3";
+var version = "0.25.4-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend-module-guest-provider/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.11";
+var version = "0.2.12-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/catalog-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.18.0";
+var version = "1.19.0-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.11.0";
+var version = "0.11.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.2";
+var version = "0.3.3-next.1";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.34.1",
+  "version": "0.34.2-next.2",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -47,16 +47,16 @@
     ]
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.7.5",
-    "@backstage/cli-common": "^0.1.15",
-    "@backstage/cli-node": "^0.2.14",
-    "@backstage/config": "^1.3.3",
-    "@backstage/config-loader": "^1.10.2",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/eslint-plugin": "^0.1.11",
-    "@backstage/integration": "^1.17.1",
-    "@backstage/release-manifests": "^0.0.13",
-    "@backstage/types": "^1.2.1",
+    "@backstage/catalog-model": "1.7.5",
+    "@backstage/cli-common": "0.1.15",
+    "@backstage/cli-node": "0.2.14",
+    "@backstage/config": "1.3.3",
+    "@backstage/config-loader": "1.10.3-next.0",
+    "@backstage/errors": "1.2.7",
+    "@backstage/eslint-plugin": "0.1.11",
+    "@backstage/integration": "1.18.0-next.0",
+    "@backstage/release-manifests": "0.0.13",
+    "@backstage/types": "1.2.1",
     "@manypkg/get-packages": "^1.1.3",
     "@module-federation/enhanced": "^0.9.0",
     "@octokit/graphql": "^5.0.0",
@@ -154,22 +154,22 @@
     "zod-validation-error": "^3.4.0"
   },
   "devDependencies": {
-    "@backstage/backend-plugin-api": "^1.4.2",
-    "@backstage/backend-test-utils": "^1.8.0",
-    "@backstage/catalog-client": "^1.11.0",
-    "@backstage/config": "^1.3.3",
-    "@backstage/core-app-api": "^1.18.0",
-    "@backstage/core-components": "^0.17.5",
-    "@backstage/core-plugin-api": "^1.10.9",
-    "@backstage/dev-utils": "^1.1.13",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-auth-backend": "^0.25.3",
-    "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.11",
-    "@backstage/plugin-catalog-node": "^1.18.0",
-    "@backstage/plugin-scaffolder-node": "^0.11.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "^0.3.2",
-    "@backstage/test-utils": "^1.7.11",
-    "@backstage/theme": "^0.6.8",
+    "@backstage/backend-plugin-api": "1.4.3-next.0",
+    "@backstage/backend-test-utils": "1.9.0-next.1",
+    "@backstage/catalog-client": "1.12.0-next.0",
+    "@backstage/config": "1.3.3",
+    "@backstage/core-app-api": "1.18.0",
+    "@backstage/core-components": "0.17.6-next.1",
+    "@backstage/core-plugin-api": "1.10.9",
+    "@backstage/dev-utils": "1.1.14-next.2",
+    "@backstage/errors": "1.2.7",
+    "@backstage/plugin-auth-backend": "0.25.4-next.1",
+    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.12-next.0",
+    "@backstage/plugin-catalog-node": "1.19.0-next.1",
+    "@backstage/plugin-scaffolder-node": "0.11.1-next.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.3-next.1",
+    "@backstage/test-utils": "1.7.11",
+    "@backstage/theme": "0.6.8",
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
     "@types/cross-spawn": "^6.0.2",
     "@types/ejs": "^3.1.3",

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

@@ -25,6 +25,7 @@
     "@backstage/backend-plugin-api": "{{versionQuery '@backstage/backend-plugin-api'}}",
     "@backstage/catalog-client": "{{versionQuery '@backstage/catalog-client'}}",
     "@backstage/errors": "{{versionQuery '@backstage/errors'}}",
+    "@backstage/types": "{{versionQuery '@backstage/types'}}",
     "@backstage/plugin-catalog-node": "{{versionQuery '@backstage/plugin-catalog-node'}}",
     "express": "{{versionQuery 'express' '4.17.1'}}",
     "express-promise-router": "{{versionQuery 'express-promise-router' '4.1.0'}}",

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

@@ -2,9 +2,16 @@ import {
   mockCredentials,
   startTestBackend,
 } from '@backstage/backend-test-utils';
+import { createServiceFactory } from '@backstage/backend-plugin-api';
+import { todoListServiceRef } from './services/TodoListService';
 import { {{pluginVar}} } from './plugin';
 import request from 'supertest';
 import { catalogServiceMock } from '@backstage/plugin-catalog-node/testUtils';
+import {
+  ConflictError,
+  AuthenticationError,
+  NotAllowedError,
+} from '@backstage/errors';
 
 // TEMPLATE NOTE:
 // Plugin tests are integration tests for your plugin, ensuring that all pieces
@@ -82,4 +89,41 @@ describe('plugin', () => {
       createdAt: expect.any(String),
     });
   });
+
+  it('should forward errors from the TodoListService', async () => {
+    const { server } = await startTestBackend({
+      features: [
+        {{pluginVar}},
+        createServiceFactory({
+          service: todoListServiceRef,
+          deps: {},
+          factory: () => ({
+            createTodo: jest.fn().mockRejectedValue(new ConflictError()),
+            listTodos: jest.fn().mockRejectedValue(new AuthenticationError()),
+            getTodo: jest.fn().mockRejectedValue(new NotAllowedError()),
+          }),
+        })
+      ],
+    });
+
+    const createRes = await request(server)
+      .post('/api/{{pluginId}}/todos')
+      .send({ title: 'My Todo', entityRef: 'component:default/my-component' });
+    expect(createRes.status).toBe(409);
+    expect(createRes.body).toMatchObject({
+      error: { name: 'ConflictError' },
+    });
+
+    const listRes = await request(server).get('/api/{{pluginId}}/todos');
+    expect(listRes.status).toBe(401);
+    expect(listRes.body).toMatchObject({
+      error: { name: 'AuthenticationError' },
+    });
+
+    const getRes = await request(server).get('/api/{{pluginId}}/todos/123');
+    expect(getRes.status).toBe(403);
+    expect(getRes.body).toMatchObject({
+      error: { name: 'NotAllowedError' },
+    });
+  });
 });

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

@@ -3,8 +3,7 @@ import {
   createBackendPlugin,
 } from '@backstage/backend-plugin-api';
 import { createRouter } from './router';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node';
-import { createTodoListService } from './services/TodoListService';
+import { todoListServiceRef } from './services/TodoListService';
 
 /**
  * {{pluginVar}} backend plugin
@@ -16,21 +15,15 @@ export const {{pluginVar}} = createBackendPlugin({
   register(env) {
     env.registerInit({
       deps: {
-        logger: coreServices.logger,
         httpAuth: coreServices.httpAuth,
         httpRouter: coreServices.httpRouter,
-        catalog: catalogServiceRef,
+        todoList: todoListServiceRef,
       },
-      async init({ logger, httpAuth, httpRouter, catalog }) {
-        const todoListService = await createTodoListService({
-          logger,
-          catalog,
-        });
-
+      async init({ httpAuth, httpRouter, todoList }) {
         httpRouter.use(
           await createRouter({
             httpAuth,
-            todoListService,
+            todoList,
           }),
         );
       },

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

@@ -7,7 +7,7 @@ import express from 'express';
 import request from 'supertest';
 
 import { createRouter } from './router';
-import { TodoListService } from './services/TodoListService/types';
+import { todoListServiceRef } from './services/TodoListService';
 
 const mockTodoItem = {
   title: 'Do the thing',
@@ -20,17 +20,17 @@ const mockTodoItem = {
 // Testing the router directly allows you to write a unit test that mocks the provided options.
 describe('createRouter', () => {
   let app: express.Express;
-  let todoListService: jest.Mocked<TodoListService>;
+  let todoList: jest.Mocked<typeof todoListServiceRef.T>;
 
   beforeEach(async () => {
-    todoListService = {
+    todoList = {
       createTodo: jest.fn(),
       listTodos: jest.fn(),
       getTodo: jest.fn(),
     };
     const router = await createRouter({
       httpAuth: mockServices.httpAuth(),
-      todoListService,
+      todoList,
     });
     app = express();
     app.use(router);
@@ -38,7 +38,7 @@ describe('createRouter', () => {
   });
 
   it('should create a TODO', async () => {
-    todoListService.createTodo.mockResolvedValue(mockTodoItem);
+    todoList.createTodo.mockResolvedValue(mockTodoItem);
 
     const response = await request(app).post('/todos').send({
       title: 'Do the thing',
@@ -49,7 +49,7 @@ describe('createRouter', () => {
   });
 
   it('should not allow unauthenticated requests to create a TODO', async () => {
-    todoListService.createTodo.mockResolvedValue(mockTodoItem);
+    todoList.createTodo.mockResolvedValue(mockTodoItem);
 
     // TEMPLATE NOTE:
     // The HttpAuth mock service considers all requests to be authenticated as a

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

@@ -3,14 +3,14 @@ import { InputError } from '@backstage/errors';
 import { z } from 'zod';
 import express from 'express';
 import Router from 'express-promise-router';
-import { TodoListService } from './services/TodoListService/types';
+import { todoListServiceRef } from './services/TodoListService';
 
 export async function createRouter({
   httpAuth,
-  todoListService,
+  todoList,
 }: {
   httpAuth: HttpAuthService;
-  todoListService: TodoListService;
+  todoList: typeof todoListServiceRef.T;
 }): Promise<express.Router> {
   const router = Router();
   router.use(express.json());
@@ -32,7 +32,7 @@ export async function createRouter({
       throw new InputError(parsed.error.toString());
     }
 
-    const result = await todoListService.createTodo(parsed.data, {
+    const result = await todoList.createTodo(parsed.data, {
       credentials: await httpAuth.credentials(req, { allow: ['user'] }),
     });
 
@@ -40,11 +40,11 @@ export async function createRouter({
   });
 
   router.get('/todos', async (_req, res) => {
-    res.json(await todoListService.listTodos());
+    res.json(await todoList.listTodos());
   });
 
   router.get('/todos/:id', async (req, res) => {
-    res.json(await todoListService.getTodo({ id: req.params.id }));
+    res.json(await todoList.getTodo({ id: req.params.id }));
   });
 
   return router;

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

@@ -0,0 +1,155 @@
+/*
+ * 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/services/TodoListService/createTodoListService.ts

@@ -1,92 +0,0 @@
-import { LoggerService } from '@backstage/backend-plugin-api';
-import { NotFoundError } from '@backstage/errors';
-import { catalogServiceRef } from '@backstage/plugin-catalog-node';
-import crypto from 'node:crypto';
-import { TodoItem, TodoListService } from './types';
-
-// 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 async function createTodoListService({
-  logger,
-  catalog,
-}: {
-  logger: LoggerService;
-  catalog: typeof catalogServiceRef.T;
-}): Promise<TodoListService> {
-  logger.info('Initializing TodoListService');
-
-  const storedTodos = new Array<TodoItem>();
-
-  return {
-    async createTodo(input, options) {
-      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 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(),
-      };
-
-      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
-      logger.info('Created new todo item', { id, title, createdBy });
-
-      return newTodo;
-    },
-
-    async listTodos() {
-      return { items: Array.from(storedTodos) };
-    },
-
-    async getTodo(request: { id: string }) {
-      const todo = storedTodos.find(item => item.id === request.id);
-      if (!todo) {
-        throw new NotFoundError(`No todo found with id '${request.id}'`);
-      }
-      return todo;
-    },
-  };
-}

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

@@ -1 +0,0 @@
-export { createTodoListService } from './createTodoListService';

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

@@ -1,27 +0,0 @@
-import {
-  BackstageCredentials,
-  BackstageUserPrincipal,
-} from '@backstage/backend-plugin-api';
-
-export interface TodoItem {
-  title: string;
-  id: string;
-  createdBy: string;
-  createdAt: string;
-}
-
-export interface TodoListService {
-  createTodo(
-    input: {
-      title: string;
-      entityRef?: string;
-    },
-    options: {
-      credentials: BackstageCredentials<BackstageUserPrincipal>;
-    },
-  ): Promise<TodoItem>;
-
-  listTodos(): Promise<{ items: TodoItem[] }>;
-
-  getTodo(request: { id: string }): Promise<TodoItem>;
-}