@massdriver/backstage-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,196 @@
+# Massdriver Backstage plugin
+
+Surface your [Massdriver](https://www.massdriver.cloud/) infrastructure inside
+Backstage: projects, environment graphs, instance details, repositories, and
+resources — plus a status card and tab for any catalog entity you link to a
+Massdriver project, environment, or instance. Everything is read-only and
+updates live; actions deep-link into the Massdriver app.
+
+## Packages
+
+| Package                                | Role                                                       |
+| -------------------------------------- | ---------------------------------------------------------- |
+| `@massdriver/backstage-plugin`         | Frontend: Massdriver pages, entity card, entity tab        |
+| `@massdriver/backstage-plugin-backend` | Backend: authenticated GraphQL relay + realtime SSE bridge |
+| `@massdriver/backstage-plugin-common`  | Shared types, annotations, deep-link builders              |
+
+## Requirements
+
+- A Backstage app on the **New Frontend System** (`createApp` from
+  `@backstage/frontend-defaults`). The plugin is built with frontend-system
+  blueprints and does not support the legacy frontend system.
+- The Backstage backend must have outbound HTTPS **and WebSocket** access to
+  your Massdriver API origin (`https://api.massdriver.cloud` unless
+  self-hosted) — WebSockets power the live-update bridge.
+- A Massdriver **service account** (instructions below).
+
+## Install
+
+From your Backstage repo root:
+
+```bash
+# Frontend
+yarn --cwd packages/app add @massdriver/backstage-plugin
+
+# Backend relay
+yarn --cwd packages/backend add \
+  @massdriver/backstage-plugin-backend
+```
+
+Add the backend plugin in `packages/backend/src/index.ts`:
+
+```ts
+backend.add(import('@massdriver/backstage-plugin-backend'));
+```
+
+The frontend registers itself automatically if your app uses package discovery
+(`app: { packages: all }` in `app-config.yaml`). Without discovery, add it as
+an explicit feature in `packages/app/src/App.tsx`:
+
+```ts
+import massdriverPlugin from '@massdriver/backstage-plugin';
+
+export default createApp({
+  features: [
+    // ...your other features
+    massdriverPlugin,
+  ],
+});
+```
+
+Either way you get the `/massdriver` pages, the entity overview card, and the
+"Massdriver" entity tab.
+
+## Configuration
+
+```yaml
+# app-config.yaml
+massdriver:
+  organizationId: ${MASSDRIVER_ORG_ID}
+  apiToken: ${MASSDRIVER_API_TOKEN}
+  # Optional — only for self-hosted Massdriver installations:
+  # baseUrl: ${MASSDRIVER_API_URL} # default: https://api.massdriver.cloud
+  # appUrl: ${MASSDRIVER_APP_URL}  # default: https://app.massdriver.cloud
+```
+
+| Key                         | Env var (suggested)    | Required | Visibility | Description                                                                                  |
+| --------------------------- | ---------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------- |
+| `massdriver.organizationId` | `MASSDRIVER_ORG_ID`    | yes      | frontend   | Your Massdriver organization ID.                                                             |
+| `massdriver.apiToken`       | `MASSDRIVER_API_TOKEN` | yes      | **secret** | Service-account bearer token used by the backend relay. Never sent to the browser.           |
+| `massdriver.baseUrl`        | `MASSDRIVER_API_URL`   | no       | frontend   | Massdriver API origin. Only set for self-hosted installations.                               |
+| `massdriver.appUrl`         | `MASSDRIVER_APP_URL`   | no       | frontend   | Massdriver web app origin, used to build deep-links. Only set for self-hosted installations. |
+
+### Getting the values
+
+- **Organization ID** (`MASSDRIVER_ORG_ID`): log into the
+  [Massdriver app](https://app.massdriver.cloud) — the ID is the URL segment
+  after `/orgs/` on any page (`https://app.massdriver.cloud/orgs/<org-id>/…`),
+  and is also shown under **Organization settings → General**.
+- **API token** (`MASSDRIVER_API_TOKEN`): create a service account under
+  **Organization settings → Service accounts**
+  (`https://app.massdriver.cloud/orgs/<org-id>/settings/service-accounts`) and
+  copy its token. See the [Massdriver docs](https://docs.massdriver.cloud) for
+  details on service accounts.
+
+`apiToken` is declared with `secret` visibility in the config schema: Backstage
+strips it from frontend config automatically. Still, keep it out of committed
+files — put it in `app-config.local.yaml` (gitignored), an environment
+variable, or your secret store, like any other Backstage secret.
+
+## What you get
+
+- **`/massdriver/projects`** — organization-wide projects list, and per-project
+  details with tabs.
+- **`/massdriver/projects/:project/environments/:environment`** — the
+  environment graph: packages, connections, statuses, and an instance drawer
+  with overview, configuration, deployment history, logs, resources, and
+  dependencies. Environments and deployments can be compared side by side.
+- **`/massdriver/repositories`** — bundle repositories, versions, and files.
+- **`/massdriver/resources`** — cloud resources with usage and details.
+- **Entity overview card** and **Massdriver tab** on any catalog entity
+  annotated with a `massdriver.cloud/*` ID (below), showing instance status,
+  versions, and "Open in Massdriver" deep-links.
+
+All views are read-only and update live. Actions that change infrastructure
+(deploy, decommission, configuration edits, …) deep-link into the Massdriver
+app.
+
+The plugin does **not** mirror infrastructure into the Backstage catalog; you
+link your existing catalog entities to Massdriver via annotations.
+
+## Sidebar
+
+On the default nav, the plugin contributes a flat **Massdriver** sidebar link
+automatically — nothing to do.
+
+If your app customizes the sidebar (`NavContentBlueprint`), you can render the
+plugin's ready-made entry instead: the Massdriver logo linking to the projects
+list, with a **Projects / Resources / Repositories** submenu matching the
+Massdriver web app:
+
+```tsx
+import { MassdriverSidebarItem } from '@massdriver/backstage-plugin';
+
+// Inside your NavContentBlueprint component: swap the plugin's default flat
+// item for the submenu entry, and render everything else as usual.
+const nav = navItems.withComponent(item =>
+  item.href?.startsWith('/massdriver') ? (
+    <MassdriverSidebarItem />
+  ) : (
+    <SidebarItem icon={() => item.icon} to={item.href} text={item.title} />
+  ),
+);
+```
+
+(If you build your `<Sidebar>` without the `navItems` API, just place
+`<MassdriverSidebarItem />` wherever it belongs — but then make sure the
+default Massdriver nav item isn't also rendered, or it will appear twice.)
+
+## Annotations
+
+Add one of these to an entity's `catalog-info.yaml` to attach the Massdriver
+card + tab, pointing at the most specific matching Massdriver resource:
+
+```yaml
+metadata:
+  annotations:
+    massdriver.cloud/project-id: my-project
+    # or the more specific scopes:
+    # massdriver.cloud/environment-id: my-project-prod
+    # massdriver.cloud/instance-id: my-project-prod-cache
+```
+
+If an entity carries more than one, the most specific wins: `instance-id` >
+`environment-id` > `project-id`. An optional `massdriver.cloud/org-id`
+annotation can accompany any of them to pin the organization explicitly (useful
+mainly in multi-org setups); it defaults to the configured
+`massdriver.organizationId`.
+
+## Security & authorization
+
+- The service-account token lives only in backend config (`secret`
+  visibility); the browser talks exclusively to the relay, which injects the
+  token and your `organizationId` server-side. Client-supplied organization
+  IDs are ignored.
+- The relay exposes **no mutation endpoints** — it forwards read queries and a
+  read-only realtime subscription stream.
+- Any authenticated Backstage user sees whatever the service account can read.
+  This is an org-wide, read-only integration; there is no per-user scoping in
+  this version.
+
+## Troubleshooting
+
+**Massdriver pages load but details look subtly wrong (misaligned switch
+thumbs, tooltip arrows, chip padding).** In development the plugin logs a
+`console.warn` starting with `[backstage-plugin-massdriver] MUI v5 class-name
+mismatch detected` when it can diagnose the cause: something in your app
+evaluates `@mui/material` during startup, before Backstage configures its MUI
+v5 class-name prefix — usually an eager import of a MUI v5 component (or a
+library re-exporting one) in custom app chrome or another plugin's package
+root. Move that import behind a dynamic `import()` (or out of the startup
+path). Background: [backstage#31846](https://github.com/backstage/backstage/issues/31846).
+
+**No data / errors on Massdriver pages.** Check the backend logs — the relay
+logs Massdriver API failures. Verify `massdriver.apiToken` and
+`massdriver.organizationId`, and that the backend can reach your API origin
+over both HTTPS and WSS.

package/dist/MassdriverRouter.esm.js

@@ -0,0 +1,78 @@
+import { jsxs, jsx } from 'react/jsx-runtime';
+import { Routes, Route, Navigate } from 'react-router-dom';
+import { NotFound } from './components/NotFound.esm.js';
+import { EnvironmentGraphPage } from './features/environment/EnvironmentGraphPage.esm.js';
+import { ProjectDetailsPage } from './features/project/ProjectDetailsPage.esm.js';
+import { ProjectsListPage } from './features/projects/ProjectsListPage.esm.js';
+import { RepoDetailsPage } from './features/repo/RepoDetailsPage.esm.js';
+import { ReposListPage } from './features/repos/ReposListPage.esm.js';
+import { ResourceDetailsPage } from './features/resource/ResourceDetailsPage.esm.js';
+import { ResourcesListPage } from './features/resources/ResourcesListPage.esm.js';
+
+const MassdriverRouter = () => /* @__PURE__ */ jsxs(Routes, { children: [
+  /* @__PURE__ */ jsx(Route, { index: true, element: /* @__PURE__ */ jsx(Navigate, { to: "projects", replace: true }) }),
+  /* @__PURE__ */ jsx(Route, { path: "projects", element: /* @__PURE__ */ jsx(ProjectsListPage, {}) }),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "projects/:projectId",
+      element: /* @__PURE__ */ jsx(Navigate, { to: "overview", replace: true })
+    }
+  ),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "projects/:projectId/environments/:scopedEnvironmentId",
+      element: /* @__PURE__ */ jsx(EnvironmentGraphPage, {})
+    }
+  ),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "projects/:projectId/environments/:scopedEnvironmentId/instances/:scopedComponentId",
+      element: /* @__PURE__ */ jsx(EnvironmentGraphPage, {})
+    }
+  ),
+  /* @__PURE__ */ jsx(Route, { path: "projects/:projectId/:tab", element: /* @__PURE__ */ jsx(ProjectDetailsPage, {}) }),
+  /* @__PURE__ */ jsx(Route, { path: "repositories", element: /* @__PURE__ */ jsx(ReposListPage, {}) }),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "repositories/:repoId",
+      element: /* @__PURE__ */ jsx(Navigate, { to: "all", replace: true })
+    }
+  ),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "repositories/:repoId/:version",
+      element: /* @__PURE__ */ jsx(Navigate, { to: "overview", replace: true })
+    }
+  ),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "repositories/:repoId/:version/:tab",
+      element: /* @__PURE__ */ jsx(RepoDetailsPage, {})
+    }
+  ),
+  /* @__PURE__ */ jsx(Route, { path: "resources", element: /* @__PURE__ */ jsx(ResourcesListPage, {}) }),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "resources/:resourceId",
+      element: /* @__PURE__ */ jsx(Navigate, { to: "general", replace: true })
+    }
+  ),
+  /* @__PURE__ */ jsx(
+    Route,
+    {
+      path: "resources/:resourceId/:tab",
+      element: /* @__PURE__ */ jsx(ResourceDetailsPage, {})
+    }
+  ),
+  /* @__PURE__ */ jsx(Route, { path: "*", element: /* @__PURE__ */ jsx(NotFound, {}) })
+] });
+
+export { MassdriverRouter };
+//# sourceMappingURL=MassdriverRouter.esm.js.map

package/dist/MassdriverRouter.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MassdriverRouter.esm.js","sources":["../src/MassdriverRouter.tsx"],"sourcesContent":["import { Navigate, Route, Routes } from 'react-router-dom';\nimport { NotFound } from './components/NotFound';\nimport { EnvironmentGraphPage } from './features/environment/EnvironmentGraphPage';\nimport { ProjectDetailsPage } from './features/project/ProjectDetailsPage';\nimport { ProjectsListPage } from './features/projects/ProjectsListPage';\nimport { RepoDetailsPage } from './features/repo/RepoDetailsPage';\nimport { ReposListPage } from './features/repos/ReposListPage';\nimport { ResourceDetailsPage } from './features/resource/ResourceDetailsPage';\nimport { ResourcesListPage } from './features/resources/ResourcesListPage';\n\n/**\n * Internal drill-down routing for the embedded Massdriver views, mounted under\n * the plugin's `/massdriver` page. The index redirects to `/massdriver/projects`.\n */\nexport const MassdriverRouter = () => (\n  <Routes>\n    <Route index element={<Navigate to=\"projects\" replace />} />\n    <Route path=\"projects\" element={<ProjectsListPage />} />\n    <Route\n      path=\"projects/:projectId\"\n      element={<Navigate to=\"overview\" replace />}\n    />\n    <Route\n      path=\"projects/:projectId/environments/:scopedEnvironmentId\"\n      element={<EnvironmentGraphPage />}\n    />\n    <Route\n      path=\"projects/:projectId/environments/:scopedEnvironmentId/instances/:scopedComponentId\"\n      element={<EnvironmentGraphPage />}\n    />\n    <Route path=\"projects/:projectId/:tab\" element={<ProjectDetailsPage />} />\n    <Route path=\"repositories\" element={<ReposListPage />} />\n    <Route\n      path=\"repositories/:repoId\"\n      element={<Navigate to=\"all\" replace />}\n    />\n    <Route\n      path=\"repositories/:repoId/:version\"\n      element={<Navigate to=\"overview\" replace />}\n    />\n    <Route\n      path=\"repositories/:repoId/:version/:tab\"\n      element={<RepoDetailsPage />}\n    />\n    <Route path=\"resources\" element={<ResourcesListPage />} />\n    <Route\n      path=\"resources/:resourceId\"\n      element={<Navigate to=\"general\" replace />}\n    />\n    <Route\n      path=\"resources/:resourceId/:tab\"\n      element={<ResourceDetailsPage />}\n    />\n    <Route path=\"*\" element={<NotFound />} />\n  </Routes>\n);\n"],"names":[],"mappings":";;;;;;;;;;;AAcO,MAAM,gBAAA,GAAmB,sBAC9B,IAAA,CAAC,MAAA,EAAA,EACC,QAAA,EAAA;AAAA,kBAAA,GAAA,CAAC,KAAA,EAAA,EAAM,KAAA,EAAK,IAAA,EAAC,OAAA,kBAAS,GAAA,CAAC,YAAS,EAAA,EAAG,UAAA,EAAW,OAAA,EAAO,IAAA,EAAC,CAAA,EAAI,CAAA;AAAA,sBACzD,KAAA,EAAA,EAAM,IAAA,EAAK,YAAW,OAAA,kBAAS,GAAA,CAAC,oBAAiB,CAAA,EAAI,CAAA;AAAA,kBACtD,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,qBAAA;AAAA,MACL,yBAAS,GAAA,CAAC,QAAA,EAAA,EAAS,EAAA,EAAG,UAAA,EAAW,SAAO,IAAA,EAAC;AAAA;AAAA,GAC3C;AAAA,kBACA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,uDAAA;AAAA,MACL,OAAA,sBAAU,oBAAA,EAAA,EAAqB;AAAA;AAAA,GACjC;AAAA,kBACA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,oFAAA;AAAA,MACL,OAAA,sBAAU,oBAAA,EAAA,EAAqB;AAAA;AAAA,GACjC;AAAA,sBACC,KAAA,EAAA,EAAM,IAAA,EAAK,4BAA2B,OAAA,kBAAS,GAAA,CAAC,sBAAmB,CAAA,EAAI,CAAA;AAAA,sBACvE,KAAA,EAAA,EAAM,IAAA,EAAK,gBAAe,OAAA,kBAAS,GAAA,CAAC,iBAAc,CAAA,EAAI,CAAA;AAAA,kBACvD,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,sBAAA;AAAA,MACL,yBAAS,GAAA,CAAC,QAAA,EAAA,EAAS,EAAA,EAAG,KAAA,EAAM,SAAO,IAAA,EAAC;AAAA;AAAA,GACtC;AAAA,kBACA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,+BAAA;AAAA,MACL,yBAAS,GAAA,CAAC,QAAA,EAAA,EAAS,EAAA,EAAG,UAAA,EAAW,SAAO,IAAA,EAAC;AAAA;AAAA,GAC3C;AAAA,kBACA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,oCAAA;AAAA,MACL,OAAA,sBAAU,eAAA,EAAA,EAAgB;AAAA;AAAA,GAC5B;AAAA,sBACC,KAAA,EAAA,EAAM,IAAA,EAAK,aAAY,OAAA,kBAAS,GAAA,CAAC,qBAAkB,CAAA,EAAI,CAAA;AAAA,kBACxD,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,uBAAA;AAAA,MACL,yBAAS,GAAA,CAAC,QAAA,EAAA,EAAS,EAAA,EAAG,SAAA,EAAU,SAAO,IAAA,EAAC;AAAA;AAAA,GAC1C;AAAA,kBACA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,IAAA,EAAK,4BAAA;AAAA,MACL,OAAA,sBAAU,mBAAA,EAAA,EAAoB;AAAA;AAAA,GAChC;AAAA,sBACC,KAAA,EAAA,EAAM,IAAA,EAAK,KAAI,OAAA,kBAAS,GAAA,CAAC,YAAS,CAAA,EAAI;AAAA,CAAA,EACzC;;;;"}

package/dist/api.esm.js

@@ -0,0 +1,119 @@
+import { createApiRef } from '@backstage/frontend-plugin-api';
+import { DEFAULT_APP_URL, MASSDRIVER_CONFIG_KEY } from '@massdriver/backstage-plugin-common';
+
+const massdriverApiRef = createApiRef({
+  id: "plugin.massdriver.api"
+});
+class MassdriverClientApi {
+  fetchApi;
+  appUrl;
+  organizationId;
+  constructor(options) {
+    this.fetchApi = options.fetchApi;
+    this.appUrl = options.configApi.getOptionalString(`${MASSDRIVER_CONFIG_KEY}.appUrl`) ?? DEFAULT_APP_URL;
+    this.organizationId = options.configApi.getOptionalString(
+      `${MASSDRIVER_CONFIG_KEY}.organizationId`
+    ) ?? "";
+  }
+  async query(query, variables) {
+    const response = await this.fetchApi.fetch("plugin://massdriver/graphql", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify({ query, variables })
+    });
+    if (!response.ok) {
+      throw new Error(
+        `Massdriver request failed: ${response.status} ${response.statusText}`
+      );
+    }
+    const body = await response.json();
+    if (body.errors?.length) {
+      throw new Error(body.errors.map((error) => error.message).join("; "));
+    }
+    return body.data;
+  }
+  async fetchText(url) {
+    const response = await this.fetchApi.fetch(
+      `plugin://massdriver/content?url=${encodeURIComponent(url)}`
+    );
+    if (!response.ok) {
+      throw new Error(
+        `Massdriver content fetch failed: ${response.status} ${response.statusText}`
+      );
+    }
+    return response.text();
+  }
+  async subscribe(query, variables, handlers, signal) {
+    let response;
+    try {
+      response = await this.fetchApi.fetch("plugin://massdriver/subscribe", {
+        method: "POST",
+        headers: { "content-type": "application/json" },
+        body: JSON.stringify({ query, variables }),
+        signal
+      });
+    } catch (error) {
+      if (signal?.aborted) return;
+      handlers.onError?.(error);
+      return;
+    }
+    if (!response.ok || !response.body) {
+      const requestFailed = Object.assign(
+        new Error(
+          `Massdriver subscription failed: ${response.status} ${response.statusText}`
+        ),
+        {
+          status: response.status,
+          fatal: response.status >= 400 && response.status < 500 && response.status !== 429
+        }
+      );
+      handlers.onError?.(requestFailed);
+      return;
+    }
+    const reader = response.body.getReader();
+    const decoder = new TextDecoder();
+    let buffer = "";
+    const handleFrame = (frame) => {
+      let eventName = null;
+      const dataLines = [];
+      for (const line of frame.split("\n")) {
+        if (line.startsWith(":")) continue;
+        if (line.startsWith("event:")) eventName = line.slice(6).trim();
+        else if (line.startsWith("data:")) dataLines.push(line.slice(5).trim());
+      }
+      if (dataLines.length === 0) return;
+      const payload = JSON.parse(dataLines.join("\n"));
+      if (eventName === "error") {
+        const streamError = Object.assign(
+          new Error(payload?.message ?? "Subscription error"),
+          { fatal: Boolean(payload?.fatal) }
+        );
+        handlers.onError?.(streamError);
+        return;
+      }
+      handlers.onData(payload);
+    };
+    try {
+      for (; ; ) {
+        const { done, value } = await reader.read();
+        if (done) break;
+        buffer += decoder.decode(value, { stream: true });
+        let index = buffer.indexOf("\n\n");
+        while (index !== -1) {
+          const frame = buffer.slice(0, index);
+          buffer = buffer.slice(index + 2);
+          if (frame.trim()) handleFrame(frame);
+          index = buffer.indexOf("\n\n");
+        }
+      }
+    } catch (error) {
+      if (!signal?.aborted) handlers.onError?.(error);
+    } finally {
+      reader.cancel().catch(() => {
+      });
+    }
+  }
+}
+
+export { MassdriverClientApi, massdriverApiRef };
+//# sourceMappingURL=api.esm.js.map

package/dist/api.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"sourcesContent":["import {\n  ConfigApi,\n  createApiRef,\n  FetchApi,\n} from '@backstage/frontend-plugin-api';\nimport {\n  DEFAULT_APP_URL,\n  MASSDRIVER_CONFIG_KEY,\n} from '@massdriver/backstage-plugin-common';\n\n/**\n * Subscription errors carry `fatal: true` when retrying cannot succeed — a 4xx\n * from the relay (unauthenticated/invalid request) or an upstream Absinthe\n * channel rejection (bad document / unknown environment). The reconnect loop in\n * `useMassdriverSubscription` stops on fatal errors instead of retrying forever.\n *\n * @public\n */\nexport type MassdriverSubscriptionError = Error & {\n  fatal?: boolean;\n  status?: number;\n};\n\n/**\n * Frontend API for talking to Massdriver via the backend relay.\n *\n * All queries are proxied through `plugin://massdriver/graphql`, where the\n * backend injects the service-account bearer token. The browser never sees the\n * token, and `organizationId` is injected server-side, so callers only declare\n * `$organizationId` in their operations.\n *\n * @public\n */\nexport interface MassdriverApi {\n  /** Web app origin used to build deep-links. */\n  readonly appUrl: string;\n  /** Massdriver organization id, when configured on the frontend. */\n  readonly organizationId: string;\n  query<T = unknown>(\n    query: string,\n    variables?: Record<string, unknown>,\n  ): Promise<T>;\n  /**\n   * Fetch an auth-guarded Massdriver asset (OCI repo icon SVG, repo tag file\n   * contents) as text, via the backend content proxy — the web app fetches\n   * these directly with the browser's bearer token, which this plugin's\n   * browser doesn't hold.\n   */\n  fetchText(url: string): Promise<string>;\n  /**\n   * Open a GraphQL subscription via the backend SSE relay. Invokes\n   * `handlers.onData` with each streamed result's `data`. The returned promise\n   * resolves when the stream ends (server close, error, or abort). Pass a\n   * `signal` to tear the subscription down.\n   */\n  subscribe<T = unknown>(\n    query: string,\n    variables: Record<string, unknown> | undefined,\n    handlers: { onData: (data: T) => void; onError?: (error: Error) => void },\n    signal?: AbortSignal,\n  ): Promise<void>;\n}\n\n/** @public */\nexport const massdriverApiRef = createApiRef<MassdriverApi>({\n  id: 'plugin.massdriver.api',\n});\n\n/** @public */\nexport class MassdriverClientApi implements MassdriverApi {\n  private readonly fetchApi: FetchApi;\n  readonly appUrl: string;\n  readonly organizationId: string;\n\n  constructor(options: { fetchApi: FetchApi; configApi: ConfigApi }) {\n    this.fetchApi = options.fetchApi;\n    this.appUrl =\n      options.configApi.getOptionalString(`${MASSDRIVER_CONFIG_KEY}.appUrl`) ??\n      DEFAULT_APP_URL;\n    this.organizationId =\n      options.configApi.getOptionalString(\n        `${MASSDRIVER_CONFIG_KEY}.organizationId`,\n      ) ?? '';\n  }\n\n  async query<T = unknown>(\n    query: string,\n    variables?: Record<string, unknown>,\n  ): Promise<T> {\n    const response = await this.fetchApi.fetch('plugin://massdriver/graphql', {\n      method: 'POST',\n      headers: { 'content-type': 'application/json' },\n      body: JSON.stringify({ query, variables }),\n    });\n\n    if (!response.ok) {\n      throw new Error(\n        `Massdriver request failed: ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const body = (await response.json()) as {\n      data?: T;\n      errors?: Array<{ message: string }>;\n    };\n\n    if (body.errors?.length) {\n      throw new Error(body.errors.map(error => error.message).join('; '));\n    }\n\n    return body.data as T;\n  }\n\n  async fetchText(url: string): Promise<string> {\n    const response = await this.fetchApi.fetch(\n      `plugin://massdriver/content?url=${encodeURIComponent(url)}`,\n    );\n    if (!response.ok) {\n      throw new Error(\n        `Massdriver content fetch failed: ${response.status} ${response.statusText}`,\n      );\n    }\n    return response.text();\n  }\n\n  async subscribe<T = unknown>(\n    query: string,\n    variables: Record<string, unknown> | undefined,\n    handlers: { onData: (data: T) => void; onError?: (error: Error) => void },\n    signal?: AbortSignal,\n  ): Promise<void> {\n    let response: Response;\n    try {\n      response = await this.fetchApi.fetch('plugin://massdriver/subscribe', {\n        method: 'POST',\n        headers: { 'content-type': 'application/json' },\n        body: JSON.stringify({ query, variables }),\n        signal,\n      });\n    } catch (error) {\n      // A fetch abort is an intentional teardown, not an error.\n      if (signal?.aborted) return;\n      handlers.onError?.(error as Error);\n      return;\n    }\n\n    if (!response.ok || !response.body) {\n      // 4xx (except 429) won't heal on retry — flag fatal so the reconnect\n      // loop stops instead of hammering the relay.\n      const requestFailed: MassdriverSubscriptionError = Object.assign(\n        new Error(\n          `Massdriver subscription failed: ${response.status} ${response.statusText}`,\n        ),\n        {\n          status: response.status,\n          fatal:\n            response.status >= 400 &&\n            response.status < 500 &&\n            response.status !== 429,\n        },\n      );\n      handlers.onError?.(requestFailed);\n      return;\n    }\n\n    const reader = response.body.getReader();\n    const decoder = new TextDecoder();\n    let buffer = '';\n\n    const handleFrame = (frame: string) => {\n      let eventName: string | null = null;\n      const dataLines: string[] = [];\n      for (const line of frame.split('\\n')) {\n        if (line.startsWith(':')) continue; // keepalive comment\n        if (line.startsWith('event:')) eventName = line.slice(6).trim();\n        else if (line.startsWith('data:')) dataLines.push(line.slice(5).trim());\n      }\n      if (dataLines.length === 0) return;\n\n      const payload = JSON.parse(dataLines.join('\\n'));\n      if (eventName === 'error') {\n        const streamError: MassdriverSubscriptionError = Object.assign(\n          new Error(payload?.message ?? 'Subscription error'),\n          { fatal: Boolean(payload?.fatal) },\n        );\n        handlers.onError?.(streamError);\n        return;\n      }\n      handlers.onData(payload as T);\n    };\n\n    try {\n      for (;;) {\n        const { done, value } = await reader.read();\n        if (done) break;\n        buffer += decoder.decode(value, { stream: true });\n        // SSE frames are separated by a blank line.\n        let index = buffer.indexOf('\\n\\n');\n        while (index !== -1) {\n          const frame = buffer.slice(0, index);\n          buffer = buffer.slice(index + 2);\n          if (frame.trim()) handleFrame(frame);\n          index = buffer.indexOf('\\n\\n');\n        }\n      }\n    } catch (error) {\n      if (!signal?.aborted) handlers.onError?.(error as Error);\n    } finally {\n      reader.cancel().catch(() => {});\n    }\n  }\n}\n"],"names":[],"mappings":";;;AAgEO,MAAM,mBAAmB,YAAA,CAA4B;AAAA,EAC1D,EAAA,EAAI;AACN,CAAC;AAGM,MAAM,mBAAA,CAA6C;AAAA,EACvC,QAAA;AAAA,EACR,MAAA;AAAA,EACA,cAAA;AAAA,EAET,YAAY,OAAA,EAAuD;AACjE,IAAA,IAAA,CAAK,WAAW,OAAA,CAAQ,QAAA;AACxB,IAAA,IAAA,CAAK,SACH,OAAA,CAAQ,SAAA,CAAU,kBAAkB,CAAA,EAAG,qBAAqB,SAAS,CAAA,IACrE,eAAA;AACF,IAAA,IAAA,CAAK,cAAA,GACH,QAAQ,SAAA,CAAU,iBAAA;AAAA,MAChB,GAAG,qBAAqB,CAAA,eAAA;AAAA,KAC1B,IAAK,EAAA;AAAA,EACT;AAAA,EAEA,MAAM,KAAA,CACJ,KAAA,EACA,SAAA,EACY;AACZ,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,QAAA,CAAS,MAAM,6BAAA,EAA+B;AAAA,MACxE,MAAA,EAAQ,MAAA;AAAA,MACR,OAAA,EAAS,EAAE,cAAA,EAAgB,kBAAA,EAAmB;AAAA,MAC9C,MAAM,IAAA,CAAK,SAAA,CAAU,EAAE,KAAA,EAAO,WAAW;AAAA,KAC1C,CAAA;AAED,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,2BAAA,EAA8B,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA;AAAA,OACtE;AAAA,IACF;AAEA,IAAA,MAAM,IAAA,GAAQ,MAAM,QAAA,CAAS,IAAA,EAAK;AAKlC,IAAA,IAAI,IAAA,CAAK,QAAQ,MAAA,EAAQ;AACvB,MAAA,MAAM,IAAI,KAAA,CAAM,IAAA,CAAK,MAAA,CAAO,GAAA,CAAI,CAAA,KAAA,KAAS,KAAA,CAAM,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,IACpE;AAEA,IAAA,OAAO,IAAA,CAAK,IAAA;AAAA,EACd;AAAA,EAEA,MAAM,UAAU,GAAA,EAA8B;AAC5C,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,QAAA,CAAS,KAAA;AAAA,MACnC,CAAA,gCAAA,EAAmC,kBAAA,CAAmB,GAAG,CAAC,CAAA;AAAA,KAC5D;AACA,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,iCAAA,EAAoC,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA;AAAA,OAC5E;AAAA,IACF;AACA,IAAA,OAAO,SAAS,IAAA,EAAK;AAAA,EACvB;AAAA,EAEA,MAAM,SAAA,CACJ,KAAA,EACA,SAAA,EACA,UACA,MAAA,EACe;AACf,IAAA,IAAI,QAAA;AACJ,IAAA,IAAI;AACF,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,+BAAA,EAAiC;AAAA,QACpE,MAAA,EAAQ,MAAA;AAAA,QACR,OAAA,EAAS,EAAE,cAAA,EAAgB,kBAAA,EAAmB;AAAA,QAC9C,MAAM,IAAA,CAAK,SAAA,CAAU,EAAE,KAAA,EAAO,WAAW,CAAA;AAAA,QACzC;AAAA,OACD,CAAA;AAAA,IACH,SAAS,KAAA,EAAO;AAEd,MAAA,IAAI,QAAQ,OAAA,EAAS;AACrB,MAAA,QAAA,CAAS,UAAU,KAAc,CAAA;AACjC,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,QAAA,CAAS,EAAA,IAAM,CAAC,SAAS,IAAA,EAAM;AAGlC,MAAA,MAAM,gBAA6C,MAAA,CAAO,MAAA;AAAA,QACxD,IAAI,KAAA;AAAA,UACF,CAAA,gCAAA,EAAmC,QAAA,CAAS,MAAM,CAAA,CAAA,EAAI,SAAS,UAAU,CAAA;AAAA,SAC3E;AAAA,QACA;AAAA,UACE,QAAQ,QAAA,CAAS,MAAA;AAAA,UACjB,KAAA,EACE,SAAS,MAAA,IAAU,GAAA,IACnB,SAAS,MAAA,GAAS,GAAA,IAClB,SAAS,MAAA,KAAW;AAAA;AACxB,OACF;AACA,MAAA,QAAA,CAAS,UAAU,aAAa,CAAA;AAChC,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,MAAA,GAAS,QAAA,CAAS,IAAA,CAAK,SAAA,EAAU;AACvC,IAAA,MAAM,OAAA,GAAU,IAAI,WAAA,EAAY;AAChC,IAAA,IAAI,MAAA,GAAS,EAAA;AAEb,IAAA,MAAM,WAAA,GAAc,CAAC,KAAA,KAAkB;AACrC,MAAA,IAAI,SAAA,GAA2B,IAAA;AAC/B,MAAA,MAAM,YAAsB,EAAC;AAC7B,MAAA,KAAA,MAAW,IAAA,IAAQ,KAAA,CAAM,KAAA,CAAM,IAAI,CAAA,EAAG;AACpC,QAAA,IAAI,IAAA,CAAK,UAAA,CAAW,GAAG,CAAA,EAAG;AAC1B,QAAA,IAAI,IAAA,CAAK,WAAW,QAAQ,CAAA,cAAe,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAAA,aAAA,IACrD,IAAA,CAAK,UAAA,CAAW,OAAO,CAAA,EAAG,SAAA,CAAU,IAAA,CAAK,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAM,CAAA;AAAA,MACxE;AACA,MAAA,IAAI,SAAA,CAAU,WAAW,CAAA,EAAG;AAE5B,MAAA,MAAM,UAAU,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU,IAAA,CAAK,IAAI,CAAC,CAAA;AAC/C,MAAA,IAAI,cAAc,OAAA,EAAS;AACzB,QAAA,MAAM,cAA2C,MAAA,CAAO,MAAA;AAAA,UACtD,IAAI,KAAA,CAAM,OAAA,EAAS,OAAA,IAAW,oBAAoB,CAAA;AAAA,UAClD,EAAE,KAAA,EAAO,OAAA,CAAQ,OAAA,EAAS,KAAK,CAAA;AAAE,SACnC;AACA,QAAA,QAAA,CAAS,UAAU,WAAW,CAAA;AAC9B,QAAA;AAAA,MACF;AACA,MAAA,QAAA,CAAS,OAAO,OAAY,CAAA;AAAA,IAC9B,CAAA;AAEA,IAAA,IAAI;AACF,MAAA,WAAS;AACP,QAAA,MAAM,EAAE,IAAA,EAAM,KAAA,EAAM,GAAI,MAAM,OAAO,IAAA,EAAK;AAC1C,QAAA,IAAI,IAAA,EAAM;AACV,QAAA,MAAA,IAAU,QAAQ,MAAA,CAAO,KAAA,EAAO,EAAE,MAAA,EAAQ,MAAM,CAAA;AAEhD,QAAA,IAAI,KAAA,GAAQ,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA;AACjC,QAAA,OAAO,UAAU,CAAA,CAAA,EAAI;AACnB,UAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,KAAK,CAAA;AACnC,UAAA,MAAA,GAAS,MAAA,CAAO,KAAA,CAAM,KAAA,GAAQ,CAAC,CAAA;AAC/B,UAAA,IAAI,KAAA,CAAM,IAAA,EAAK,EAAG,WAAA,CAAY,KAAK,CAAA;AACnC,UAAA,KAAA,GAAQ,MAAA,CAAO,QAAQ,MAAM,CAAA;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,CAAC,MAAA,EAAQ,OAAA,EAAS,QAAA,CAAS,UAAU,KAAc,CAAA;AAAA,IACzD,CAAA,SAAE;AACA,MAAA,MAAA,CAAO,MAAA,EAAO,CAAE,KAAA,CAAM,MAAM;AAAA,MAAC,CAAC,CAAA;AAAA,IAChC;AAAA,EACF;AACF;;;;"}