@backstage/create-app 0.4.5 → 0.4.6

package/CHANGELOG.md

@@ -1,5 +1,72 @@
 # @backstage/create-app
 
+## 0.4.6
+
+### Patch Changes
+
+- 24d2ce03f3: Search Modal now relies on the Search Context to access state and state setter. If you use the SidebarSearchModal as described in the [getting started documentation](https://backstage.io/docs/features/search/getting-started#using-the-search-modal), make sure to update your code with the SearchContextProvider.
+
+  ```diff
+  export const Root = ({ children }: PropsWithChildren<{}>) => (
+    <SidebarPage>
+      <Sidebar>
+        <SidebarLogo />
+  -     <SidebarSearchModal />
+  +     <SearchContextProvider>
+  +       <SidebarSearchModal />
+  +     </SearchContextProvider>
+        <SidebarDivider />
+      ...
+  ```
+
+- 905dd952ac: Incorporate usage of the tokenManager into the backend created using `create-app`.
+
+  In existing backends, update the `PluginEnvironment` to include a `tokenManager`:
+
+  ```diff
+  // packages/backend/src/types.ts
+
+  ...
+  import {
+    ...
+  + TokenManager,
+  } from '@backstage/backend-common';
+
+  export type PluginEnvironment = {
+    ...
+  + tokenManager: TokenManager;
+  };
+  ```
+
+  Then, create a `ServerTokenManager`. This can either be a `noop` that requires no secret and validates all requests by default, or one that uses a secret from your `app-config.yaml` to generate and validate tokens.
+
+  ```diff
+  // packages/backend/src/index.ts
+
+  ...
+  import {
+    ...
+  + ServerTokenManager,
+  } from '@backstage/backend-common';
+  ...
+
+  function makeCreateEnv(config: Config) {
+    ...
+    // CHOOSE ONE
+    // TokenManager not requiring a secret
+  + const tokenManager = ServerTokenManager.noop();
+    // OR TokenManager requiring a secret
+  + const tokenManager = ServerTokenManager.fromConfig(config);
+
+    ...
+    return (plugin: string): PluginEnvironment => {
+      ...
+  -   return { logger, cache, database, config, reader, discovery };
+  +   return { logger, cache, database, config, reader, discovery, tokenManager };
+    };
+  }
+  ```
+
 ## 0.4.5
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -55,25 +55,25 @@ ${chalk__default['default'].red(`${error}`)}
   }
 }
 
-var version$A = "0.4.5";
+var version$A = "0.4.6";
 
 var version$z = "0.1.1";
 
-var version$y = "0.9.11";
+var version$y = "0.9.12";
 
 var version$x = "0.5.2";
 
 var version$w = "0.9.7";
 
-var version$v = "0.9.1";
+var version$v = "0.10.0";
 
 var version$u = "0.1.11";
 
-var version$t = "0.1.23";
+var version$t = "0.1.24";
 
-var version$s = "0.7.5";
+var version$s = "0.7.6";
 
-var version$r = "0.2.1";
+var version$r = "0.2.2";
 
 var version$q = "0.1.5";
 
@@ -81,23 +81,23 @@ var version$p = "0.1.14";
 
 var version$o = "0.1.23";
 
-var version$n = "0.2.13";
+var version$n = "0.2.14";
 
-var version$m = "0.6.15";
+var version$m = "0.6.16";
 
 var version$l = "0.3.19";
 
-var version$k = "0.4.9";
+var version$k = "0.4.10";
 
 var version$j = "0.7.3";
 
 var version$i = "0.6.4";
 
-var version$h = "0.18.0";
+var version$h = "0.19.0";
 
 var version$g = "0.7.4";
 
-var version$f = "0.2.29";
+var version$f = "0.2.30";
 
 var version$e = "0.3.21";
 
@@ -111,11 +111,11 @@ var version$a = "0.2.14";
 
 var version$9 = "0.1.16";
 
-var version$8 = "0.11.12";
+var version$8 = "0.11.13";
 
-var version$7 = "0.15.14";
+var version$7 = "0.15.15";
 
-var version$6 = "0.4.18";
+var version$6 = "0.5.0";
 
 var version$5 = "0.2.7";
 
@@ -123,11 +123,11 @@ var version$4 = "0.4.3";
 
 var version$3 = "0.4.12";
 
-var version$2 = "0.12.7";
+var version$2 = "0.12.8";
 
-var version$1 = "0.10.9";
+var version$1 = "0.11.0";
 
-var version = "0.3.11";
+var version = "0.3.12";
 
 const packageVersions = {
   "@backstage/app-defaults": version$z,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/create-app",
   "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.4.5",
+  "version": "0.4.6",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -56,5 +56,5 @@
     "dist",
     "templates"
   ],
-  "gitHead": "85c127e436a24140bb3606f17f034f82aa9c7c0d"
+  "gitHead": "a05e7081b805006e3f0b2960a08a7753357f532f"
 }

package/templates/default-app/app-config.yaml.hbs

@@ -6,6 +6,11 @@ organization:
   name: My Company
 
 backend:
+  # Used for enabling authentication, secret is shared by all backend plugins
+  # See backend-to-backend-auth.md in the docs for information on the format
+  # auth:
+  #   keys:
+  #     - secret: ${BACKEND_SECRET}
   baseUrl: http://localhost:7007
   listen:
     port: 7007

package/templates/default-app/packages/app/src/components/Root/Root.tsx

@@ -25,7 +25,10 @@ import LogoFull from './LogoFull';
 import LogoIcon from './LogoIcon';
 import { NavLink } from 'react-router-dom';
 import { Settings as SidebarSettings } from '@backstage/plugin-user-settings';
-import { SidebarSearchModal } from '@backstage/plugin-search';
+import {
+  SidebarSearchModal,
+  SearchContextProvider,
+} from '@backstage/plugin-search';
 import {
   Sidebar,
   SidebarPage,
@@ -74,7 +77,9 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
   <SidebarPage>
     <Sidebar>
       <SidebarLogo />
-      <SidebarSearchModal />
+      <SearchContextProvider>
+        <SidebarSearchModal />
+      </SearchContextProvider>
       <SidebarDivider />
       {/* Global nav, not org-specific */}
       <SidebarItem icon={HomeIcon} to="catalog" text="Home" />

package/templates/default-app/packages/backend/src/index.ts

@@ -17,6 +17,7 @@ import {
   DatabaseManager,
   SingleHostDiscovery,
   UrlReaders,
+  ServerTokenManager,
 } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
 import app from './plugins/app';
@@ -37,12 +38,13 @@ function makeCreateEnv(config: Config) {
 
   const cacheManager = CacheManager.fromConfig(config);
   const databaseManager = DatabaseManager.fromConfig(config);
+  const tokenManager = ServerTokenManager.noop();
 
   return (plugin: string): PluginEnvironment => {
     const logger = root.child({ type: 'plugin', plugin });
     const database = databaseManager.forPlugin(plugin);
     const cache = cacheManager.forPlugin(plugin);
-    return { logger, database, cache, config, reader, discovery };
+    return { logger, database, cache, config, reader, discovery, tokenManager };
   };
 }
 

package/templates/default-app/packages/backend/src/plugins/search.ts

@@ -12,6 +12,7 @@ export default async function createPlugin({
   logger,
   discovery,
   config,
+  tokenManager,
 }: PluginEnvironment) {
   // Initialize a connection to a search engine.
   const searchEngine = new LunrSearchEngine({ logger });
@@ -21,13 +22,20 @@ export default async function createPlugin({
   // collator gathers entities from the software catalog.
   indexBuilder.addCollator({
     defaultRefreshIntervalSeconds: 600,
-    collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
+    collator: DefaultCatalogCollator.fromConfig(config, {
+      discovery,
+      tokenManager,
+    }),
   });
 
   // collator gathers entities from techdocs.
   indexBuilder.addCollator({
     defaultRefreshIntervalSeconds: 600,
-    collator: DefaultTechDocsCollator.fromConfig(config, { discovery, logger }),
+    collator: DefaultTechDocsCollator.fromConfig(config, {
+      discovery,
+      logger,
+      tokenManager,
+    }),
   });
 
   // The scheduler controls when documents are gathered from collators and sent

package/templates/default-app/packages/backend/src/types.ts

@@ -4,6 +4,7 @@ import {
   PluginCacheManager,
   PluginDatabaseManager,
   PluginEndpointDiscovery,
+  TokenManager,
   UrlReader,
 } from '@backstage/backend-common';
 
@@ -14,4 +15,5 @@ export type PluginEnvironment = {
   config: Config;
   reader: UrlReader;
   discovery: PluginEndpointDiscovery;
+  tokenManager: TokenManager;
 };