@backstage/cli 0.36.0-next.2 → 0.36.0

package/dist/packages/frontend-plugin-api/src/routing/describeParentCallSite.cjs.js

@@ -1,26 +0,0 @@
-'use strict';
-
-const MESSAGE_MARKER = "eHgtF5hmbrXyiEvo";
-function describeParentCallSite(ErrorConstructor = Error) {
-  const { stack } = new ErrorConstructor(MESSAGE_MARKER);
-  if (!stack) {
-    return "<unknown>";
-  }
-  const startIndex = stack.includes(MESSAGE_MARKER) ? stack.indexOf("\n") + 1 : 0;
-  const secondEntryStart = stack.indexOf("\n", stack.indexOf("\n", startIndex) + 1) + 1;
-  const secondEntryEnd = stack.indexOf("\n", secondEntryStart);
-  const line = stack.substring(secondEntryStart, secondEntryEnd).trim();
-  if (!line) {
-    return "unknown";
-  }
-  if (line.includes("(")) {
-    return line.substring(line.indexOf("(") + 1, line.indexOf(")"));
-  }
-  if (line.includes("@")) {
-    return line.substring(line.indexOf("@") + 1);
-  }
-  return line;
-}
-
-exports.describeParentCallSite = describeParentCallSite;
-//# sourceMappingURL=describeParentCallSite.cjs.js.map

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/wiring/CommandRegistry.cjs.js

@@ -1,14 +0,0 @@
-'use strict';
-
-class CommandRegistry {
-  graph;
-  constructor(graph) {
-    this.graph = graph;
-  }
-  addCommand(command) {
-    this.graph.add(command);
-  }
-}
-
-exports.CommandRegistry = CommandRegistry;
-//# sourceMappingURL=CommandRegistry.cjs.js.map

package/dist/wiring/factory.cjs.js

@@ -1,15 +0,0 @@
-'use strict';
-
-var describeParentCallSite = require('../packages/frontend-plugin-api/src/routing/describeParentCallSite.cjs.js');
-var types = require('./types.cjs.js');
-
-function createCliPlugin(options) {
-  return types.OpaqueCliPlugin.createInstance("v1", {
-    pluginId: options.pluginId,
-    init: options.init,
-    description: `created at '${describeParentCallSite.describeParentCallSite()}'`
-  });
-}
-
-exports.createCliPlugin = createCliPlugin;
-//# sourceMappingURL=factory.cjs.js.map

package/dist/wiring/types.cjs.js

@@ -1,11 +0,0 @@
-'use strict';
-
-var OpaqueType = require('../packages/opaque-internal/src/OpaqueType.cjs.js');
-
-const OpaqueCliPlugin = OpaqueType.OpaqueType.create({
-  type: "@backstage/CliPlugin",
-  versions: ["v1"]
-});
-
-exports.OpaqueCliPlugin = OpaqueCliPlugin;
-//# sourceMappingURL=types.cjs.js.map

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

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

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

@@ -1,28 +0,0 @@
-# {{pluginId}}
-
-This plugin backend was templated using the Backstage CLI. You should replace this text with a description of your plugin backend.
-
-## Installation
-
-This plugin is installed via the `{{packageName}}` package. To install it to your backend package, run the following command:
-
-```bash
-# From your root directory
-yarn --cwd packages/backend add {{packageName}}
-```
-
-Then add the plugin to your backend in `packages/backend/src/index.ts`:
-
-```ts
-const backend = createBackend();
-// ...
-backend.add(import('{{packageName}}'));
-```
-
-## Development
-
-This plugin backend can be started in a standalone mode from directly in this
-package with `yarn start`. It is a limited setup that is most convenient when
-developing the plugin backend itself.
-
-If you want to run the entire project, including the frontend, run `yarn start` from the root directory.

package/templates/backend-plugin/dev/index.ts.hbs

@@ -1,60 +0,0 @@
-import { createBackend } from '@backstage/backend-defaults';
-import { mockServices } from '@backstage/backend-test-utils';
-import { catalogServiceMock } from '@backstage/plugin-catalog-node/testUtils';
-
-// TEMPLATE NOTE:
-// This is the development setup for your plugin that wires up a
-// minimal backend that can use both real and mocked plugins and services.
-//
-// Start up the backend by running `yarn start` in the package directory.
-// Once it's up and running, try out the following requests:
-//
-// Create a new todo item, standalone or for the sample component:
-//
-//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo"}'
-//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Content-Type: application/json' -d '{"title": "My Todo", "entityRef": "component:default/sample"}'
-//
-// List TODOs:
-//
-//   curl http://localhost:7007/api/{{pluginId}}/todos
-//
-// Explicitly make an unauthenticated request, or with service auth:
-//
-//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Authorization: Bearer mock-none-token'
-//   curl http://localhost:7007/api/{{pluginId}}/todos -H 'Authorization: Bearer mock-service-token'
-
-const backend = createBackend();
-
-// TEMPLATE NOTE:
-// Mocking the auth and httpAuth service allows you to call your plugin API without
-// having to authenticate.
-//
-// If you want to use real auth, you can install the following instead:
-//   backend.add(import('@backstage/plugin-auth-backend'));
-//   backend.add(import('@backstage/plugin-auth-backend-module-guest-provider'));
-backend.add(mockServices.auth.factory());
-backend.add(mockServices.httpAuth.factory());
-
-// TEMPLATE NOTE:
-// Rather than using a real catalog you can use a mock with a fixed set of entities.
-backend.add(
-  catalogServiceMock.factory({
-    entities: [
-      {
-        apiVersion: 'backstage.io/v1alpha1',
-        kind: 'Component',
-        metadata: {
-          name: 'sample',
-          title: 'Sample Component',
-        },
-        spec: {
-          type: 'service',
-        },
-      },
-    ],
-  }),
-);
-
-backend.add(import('../src'));
-
-backend.start();

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

@@ -1,44 +0,0 @@
-{
-  "name": "{{packageName}}",
-  "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",
-    "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-defaults": "{{versionQuery '@backstage/backend-defaults'}}",
-    "@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'}}",
-    "zod": "{{versionQuery 'zod' '3.25.76'}}"
-  },
-  "devDependencies": {
-    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}",
-    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-    "@types/express": "{{versionQuery '@types/express' '4.17.6'}}",
-    "@types/supertest": "{{versionQuery '@types/supertest' '2.0.12'}}",
-    "supertest": "{{versionQuery 'supertest' '6.2.4'}}"
-  },
-  "files": [
-    "dist"
-  ]
-}

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

@@ -1,5 +0,0 @@
-name: backend-plugin
-role: backend-plugin
-description: A new backend plugin
-values:
-  pluginVar: '{{ camelCase pluginId }}Plugin'

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

@@ -1 +0,0 @@
-export { {{pluginVar}} as default } from './plugin';

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

@@ -1,129 +0,0 @@
-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
-// work together end-to-end. You can still mock injected backend services
-// however, just like anyone who installs your plugin might replace the
-// services with their own implementations.
-describe('plugin', () => {
-  it('should create and read TODO items', async () => {
-    const { server } = await startTestBackend({
-      features: [{{pluginVar}}],
-    });
-
-    await request(server).get('/api/{{pluginId}}/todos').expect(200, {
-      items: [],
-    });
-
-    const createRes = await request(server)
-      .post('/api/{{pluginId}}/todos')
-      .send({ title: 'My Todo' });
-
-    expect(createRes.status).toBe(201);
-    expect(createRes.body).toEqual({
-      id: expect.any(String),
-      title: 'My Todo',
-      createdBy: mockCredentials.user().principal.userEntityRef,
-      createdAt: expect.any(String),
-    });
-
-    const createdTodoItem = createRes.body;
-
-    await request(server)
-      .get('/api/{{pluginId}}/todos')
-      .expect(200, {
-        items: [createdTodoItem],
-      });
-
-    await request(server)
-      .get(`/api/{{pluginId}}/todos/${createdTodoItem.id}`)
-      .expect(200, createdTodoItem);
-  });
-
-  it('should create TODO item with catalog information', async () => {
-    const { server } = await startTestBackend({
-      features: [
-        {{pluginVar}},
-        catalogServiceMock.factory({
-          entities: [
-            {
-              apiVersion: 'backstage.io/v1alpha1',
-              kind: 'Component',
-              metadata: {
-                name: 'my-component',
-                namespace: 'default',
-                title: 'My Component',
-              },
-              spec: {
-                type: 'service',
-                owner: 'me',
-              },
-            },
-          ],
-        }),
-      ],
-    });
-
-    const createRes = await request(server)
-      .post('/api/{{pluginId}}/todos')
-      .send({ title: 'My Todo', entityRef: 'component:default/my-component' });
-
-    expect(createRes.status).toBe(201);
-    expect(createRes.body).toEqual({
-      id: expect.any(String),
-      title: '[My Component] My Todo',
-      createdBy: mockCredentials.user().principal.userEntityRef,
-      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

@@ -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;
-}