@backstage/plugin-app 0.1.11 → 0.2.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/plugin-app
 
+## 0.2.0-next.1
+
+### Minor Changes
+
+- 121899a: **BREAKING**: The `app-root-element` extension now only accepts `JSX.Element` in its `element` param, meaning overrides need to be updated.
+
+### Patch Changes
+
+- a08f95f: Added a new module for implementing public sign-in apps, exported as `appModulePublicSignIn` via the `/alpha` sub-path export. This replaces the `createPublicSignInApp` export from `@backstage/frontend-defaults`, which is now deprecated.
+- 5d31d66: Updated the usage of the `RouterBlueprint` and `AppRootWrapperBlueprint` to use the lowercase `component` parameter
+- 93b5e38: The default implementation of the Analytics API now collects and instantiates analytics implementations exposed via `AnalyticsImplementationBlueprint` extensions. If no such extensions are discovered, the API continues to do nothing with analytics events fired within Backstage. If multiple such extensions are discovered, every discovered implementation automatically receives analytics events.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.11.0-next.1
+  - @backstage/core-components@0.17.5-next.1
+  - @backstage/core-plugin-api@1.10.9
+  - @backstage/integration-react@1.2.9
+  - @backstage/theme@0.6.8-next.0
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-react@0.4.36
+
+## 0.2.0-next.0
+
+### Minor Changes
+
+- 29786f6: Updated the `app/nav` extension to use the new `NavContentBlueprint`, and removed support for extensions created with the now removed `NavLogoBlueprint`.
+
+### Patch Changes
+
+- f2f133c: Internal update to use the new variant of `ApiBlueprint`.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.11.0-next.0
+  - @backstage/theme@0.6.8-next.0
+  - @backstage/core-components@0.17.5-next.0
+  - @backstage/core-plugin-api@1.10.9
+  - @backstage/integration-react@1.2.9
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-react@0.4.36
+
 ## 0.1.11
 
 ### Patch Changes

package/dist/alpha/appModulePublicSignIn.esm.js

@@ -0,0 +1,52 @@
+import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
+import appPlugin from '@backstage/plugin-app';
+import { useAsync, useMountEffect } from '@react-hookz/web';
+import { createFrontendModule, coreExtensionData, useApi, identityApiRef } from '@backstage/frontend-plugin-api';
+
+function InternalCookieAuthRedirect() {
+  const identityApi = useApi(identityApiRef);
+  const [state, actions] = useAsync(async () => {
+    const { token } = await identityApi.getCredentials();
+    if (!token) {
+      throw new Error("Expected Backstage token in sign-in response");
+    }
+    return token;
+  });
+  useMountEffect(actions.execute);
+  if (state.status === "error" && state.error) {
+    return /* @__PURE__ */ jsxs(Fragment, { children: [
+      "An error occurred: ",
+      state.error.message
+    ] });
+  }
+  if (state.status === "success" && state.result) {
+    return /* @__PURE__ */ jsxs(
+      "form",
+      {
+        ref: (form) => form?.submit(),
+        action: window.location.href,
+        method: "POST",
+        style: { visibility: "hidden" },
+        children: [
+          /* @__PURE__ */ jsx("input", { type: "hidden", name: "type", value: "sign-in" }),
+          /* @__PURE__ */ jsx("input", { type: "hidden", name: "token", value: state.result }),
+          /* @__PURE__ */ jsx("input", { type: "submit", value: "Continue" })
+        ]
+      }
+    );
+  }
+  return null;
+}
+const appModulePublicSignIn = createFrontendModule({
+  pluginId: "app",
+  extensions: [
+    appPlugin.getExtension("app/layout").override({
+      factory: () => [
+        coreExtensionData.reactElement(/* @__PURE__ */ jsx(InternalCookieAuthRedirect, {}))
+      ]
+    })
+  ]
+});
+
+export { InternalCookieAuthRedirect, appModulePublicSignIn };
+//# sourceMappingURL=appModulePublicSignIn.esm.js.map

package/dist/alpha/appModulePublicSignIn.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appModulePublicSignIn.esm.js","sources":["../../src/alpha/appModulePublicSignIn.tsx"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport appPlugin from '@backstage/plugin-app';\nimport { useAsync, useMountEffect } from '@react-hookz/web';\nimport {\n  coreExtensionData,\n  createFrontendModule,\n  identityApiRef,\n  useApi,\n} from '@backstage/frontend-plugin-api';\n\n// This is a copy of the CookieAuthRedirect component from the auth-react\n// plugin, to avoid a dependency on that package. Long-term we want this to be\n// the only implementation and remove the one in auth-react once the old frontend system is gone.\n\n// TODO(Rugvip): Should this be part of the app plugin instead? since it owns the backend part of it.\n\n/** @internal */\nexport function InternalCookieAuthRedirect() {\n  const identityApi = useApi(identityApiRef);\n\n  const [state, actions] = useAsync(async () => {\n    const { token } = await identityApi.getCredentials();\n    if (!token) {\n      throw new Error('Expected Backstage token in sign-in response');\n    }\n    return token;\n  });\n\n  useMountEffect(actions.execute);\n\n  if (state.status === 'error' && state.error) {\n    return <>An error occurred: {state.error.message}</>;\n  }\n\n  if (state.status === 'success' && state.result) {\n    return (\n      <form\n        ref={form => form?.submit()}\n        action={window.location.href}\n        method=\"POST\"\n        style={{ visibility: 'hidden' }}\n      >\n        <input type=\"hidden\" name=\"type\" value=\"sign-in\" />\n        <input type=\"hidden\" name=\"token\" value={state.result} />\n        <input type=\"submit\" value=\"Continue\" />\n      </form>\n    );\n  }\n\n  return null;\n}\n\n/**\n * This module is intended for use in public sign-in page apps, in the\n * `index-public-experimental.tsx` file.\n *\n * @remarks\n *\n * This module is used to enable the public sign-in flow where the build output\n * is split into one small publicly accessible app, and the full app protected\n * by auth.\n *\n * This module overrides the `app/layout` extension, which means that most\n * extension typically installed in an app will be ignored. However, you can\n * still for example install API and root element extensions.\n *\n * A typical setup of this app will only install a custom sign-in page.\n *\n * @example\n *\n *#### In `index-public-experimental.tsx`\n *\n *```ts\n *import { createApp } from '@backstage/frontend-defaults\n *import { appModulePublicSignIn } from '@backstage/plugin-app/alpha';\n *import { appModuleSignInPage } from './appModuleSignInPage';\n *\n *const app = createApp({\n *  features: [appModuleSignInPage, appModulePublicSignIn],\n *});\n *```\n *\n *#### In `appModuleSignInPage.tsx`\n *\n *```tsx\n *import { createFrontendModule, SignInPageBlueprint } from '@backstage/frontend-plugin-api';\n *\n *export const appModuleSignInPage = createFrontendModule({\n *  pluginId: 'app',\n *  extensions: [\n *    SignInPageBlueprint.make({\n *      params: {\n *        ...\n *      }\n *    }),\n *  ],\n *})\n *```\n *\n * @alpha\n */\nexport const appModulePublicSignIn = createFrontendModule({\n  pluginId: 'app',\n  extensions: [\n    appPlugin.getExtension('app/layout').override({\n      factory: () => [\n        coreExtensionData.reactElement(<InternalCookieAuthRedirect />),\n      ],\n    }),\n  ],\n});\n"],"names":[],"mappings":";;;;;AAgCO,SAAS,0BAA6B,GAAA;AAC3C,EAAM,MAAA,WAAA,GAAc,OAAO,cAAc,CAAA;AAEzC,EAAA,MAAM,CAAC,KAAA,EAAO,OAAO,CAAA,GAAI,SAAS,YAAY;AAC5C,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,YAAY,cAAe,EAAA;AACnD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAM,MAAA,IAAI,MAAM,8CAA8C,CAAA;AAAA;AAEhE,IAAO,OAAA,KAAA;AAAA,GACR,CAAA;AAED,EAAA,cAAA,CAAe,QAAQ,OAAO,CAAA;AAE9B,EAAA,IAAI,KAAM,CAAA,MAAA,KAAW,OAAW,IAAA,KAAA,CAAM,KAAO,EAAA;AAC3C,IAAA,uBAAS,IAAA,CAAA,QAAA,EAAA,EAAA,QAAA,EAAA;AAAA,MAAA,qBAAA;AAAA,MAAoB,MAAM,KAAM,CAAA;AAAA,KAAQ,EAAA,CAAA;AAAA;AAGnD,EAAA,IAAI,KAAM,CAAA,MAAA,KAAW,SAAa,IAAA,KAAA,CAAM,MAAQ,EAAA;AAC9C,IACE,uBAAA,IAAA;AAAA,MAAC,MAAA;AAAA,MAAA;AAAA,QACC,GAAA,EAAK,CAAQ,IAAA,KAAA,IAAA,EAAM,MAAO,EAAA;AAAA,QAC1B,MAAA,EAAQ,OAAO,QAAS,CAAA,IAAA;AAAA,QACxB,MAAO,EAAA,MAAA;AAAA,QACP,KAAA,EAAO,EAAE,UAAA,EAAY,QAAS,EAAA;AAAA,QAE9B,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,WAAM,IAAK,EAAA,QAAA,EAAS,IAAK,EAAA,MAAA,EAAO,OAAM,SAAU,EAAA,CAAA;AAAA,0BACjD,GAAA,CAAC,WAAM,IAAK,EAAA,QAAA,EAAS,MAAK,OAAQ,EAAA,KAAA,EAAO,MAAM,MAAQ,EAAA,CAAA;AAAA,0BACtD,GAAA,CAAA,OAAA,EAAA,EAAM,IAAK,EAAA,QAAA,EAAS,OAAM,UAAW,EAAA;AAAA;AAAA;AAAA,KACxC;AAAA;AAIJ,EAAO,OAAA,IAAA;AACT;AAmDO,MAAM,wBAAwB,oBAAqB,CAAA;AAAA,EACxD,QAAU,EAAA,KAAA;AAAA,EACV,UAAY,EAAA;AAAA,IACV,SAAU,CAAA,YAAA,CAAa,YAAY,CAAA,CAAE,QAAS,CAAA;AAAA,MAC5C,SAAS,MAAM;AAAA,QACb,iBAAkB,CAAA,YAAA,iBAAc,GAAA,CAAA,0BAAA,EAAA,EAA2B,CAAE;AAAA;AAC/D,KACD;AAAA;AAEL,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,54 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+
+/**
+ * This module is intended for use in public sign-in page apps, in the
+ * `index-public-experimental.tsx` file.
+ *
+ * @remarks
+ *
+ * This module is used to enable the public sign-in flow where the build output
+ * is split into one small publicly accessible app, and the full app protected
+ * by auth.
+ *
+ * This module overrides the `app/layout` extension, which means that most
+ * extension typically installed in an app will be ignored. However, you can
+ * still for example install API and root element extensions.
+ *
+ * A typical setup of this app will only install a custom sign-in page.
+ *
+ * @example
+ *
+ *#### In `index-public-experimental.tsx`
+ *
+ *```ts
+ *import { createApp } from '@backstage/frontend-defaults
+ *import { appModulePublicSignIn } from '@backstage/plugin-app/alpha';
+ *import { appModuleSignInPage } from './appModuleSignInPage';
+ *
+ *const app = createApp({
+ *  features: [appModuleSignInPage, appModulePublicSignIn],
+ *});
+ *```
+ *
+ *#### In `appModuleSignInPage.tsx`
+ *
+ *```tsx
+ *import { createFrontendModule, SignInPageBlueprint } from '@backstage/frontend-plugin-api';
+ *
+ *export const appModuleSignInPage = createFrontendModule({
+ *  pluginId: 'app',
+ *  extensions: [
+ *    SignInPageBlueprint.make({
+ *      params: {
+ *        ...
+ *      }
+ *    }),
+ *  ],
+ *})
+ *```
+ *
+ * @alpha
+ */
+declare const appModulePublicSignIn: _backstage_frontend_plugin_api.FrontendModule;
+
+export { appModulePublicSignIn };

package/dist/alpha.esm.js

@@ -0,0 +1,2 @@
+export { appModulePublicSignIn } from './alpha/appModulePublicSignIn.esm.js';
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}