@overkube/web 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 the overkube contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# @overkube/web
+
+overkube's page: what the browser runs. Started in order ([src/boot.ts](src/boot.ts)): signed in as its server says one signs in here (`GET /auth`; [src/session.tsx](src/session.tsx): not signed in, the sign-in screen alone); the connector to the gateway at `/kube` ([@overkube/connector](../../packages/connector/README.md)) and the source answering queries over it ([@overkube/source](../../packages/source/README.md)); overweave's registry of the dashboard's kinds ([@overkube/sdk](../../packages/sdk/README.md)); the user's changes read back ([@overkube/shell](../../packages/shell/README.md)'s `UserService`, in localStorage); the addons run in it ([src/host](src/host): their lifecycle — requirements, retries, `?safe` runs the core alone); the shell drawn into `#app` (`?debug`: the slots over it). The addons in its bundle: [src/addons.ts](src/addons.ts) — the [core](../../addons/core/README.md), [metrics](../../addons/metrics/README.md), [cert-manager](../../addons/cert-manager/README.md), [trivy](../../addons/trivy/README.md), [helm](../../addons/helm/README.md), [flux](../../addons/flux/README.md).
+
+```bash
+npm run dev -w @overkube/web      # Vite, with /kube and /auth passed to OVERKUBE_SERVER (http://127.0.0.1:8080)
+npm run build -w @overkube/web    # dist/: what the server serves as OVERKUBE_UI
+```
+
+The dev stand (`make dev`) runs the first at [http://localhost:5173](http://localhost:5173); the image copies the second to `/app/ui`. [vite.config.ts](vite.config.ts) reads the workspace's packages and overweave from their sources (the `overkube-source` and `overweave-source` conditions), one Preact.
+
+For a host that draws the page into a page of its own (a platform's plugin), it is published as a library, `@overkube/web` ([src/index.ts](src/index.ts)): `boot({ element, asked, gateway, headers, signIn: false, addons })` — its gateway where the host serves it, the host's headers on every request (a CSRF token), no `/auth` asked (the host has signed the user in), the host's own addons beside the page's; it answers the registry and `close()`. Its own packages (the addons, the shell, the runtime, the source, the connector) are bundled in; those a host's addons are written with — `@overkube/sdk`, `@overkube/uikit`, `@overkube/kube-types`, `@overkube/query`, `@overkube/gateway`, overweave, Preact — are dependencies, one of each in the host's bundle. `@overkube/web/styles` is the page around it (the fonts, [src/page.css](src/page.css)), for the host's bundler.
+
+```ts
+import { boot } from '@overkube/web';
+import '@overkube/web/styles';
+
+const page = await boot({ element, asked: new URLSearchParams(location.search), gateway: '/plugins/overkube/kube', signIn: false });
+```
+
+```bash
+npm run build:lib -w @overkube/web   # lib/: the library (vite.lib.config.ts), its types
+```

package/lib/index.d.ts

@@ -0,0 +1,21 @@
+import type { KubeKinds } from '@overkube/sdk';
+import type { KindsByName, Registry } from '@overweave/core';
+import type { BootOptions } from './options.ts';
+/**
+ * overkube's page, for a host that draws it into a page of its own (a
+ * platform's plugin): boot it into an element, with its gateway where the
+ * host serves it. Its addons are those of addons.ts — and the host's own,
+ * given to boot (BootOptions.addons). Published as @overkube/web: its
+ * own packages bundled in, those a host's addons are written with (the
+ * SDK, the kit, overweave, Preact) the host's, one of each. The page
+ * around it: @overkube/web/styles (the fonts, page.css), if the host
+ * wants it.
+ */
+export type { BootOptions };
+/** The page started: the registry of its kinds, and its end (a host's page left). */
+export interface Booted {
+    registry: Registry<KindsByName<KubeKinds>>;
+    close(): void;
+}
+/** The page started into its element; none (the sign-in screen in its place, or the server not answering): undefined. */
+export declare function boot(options: BootOptions): Promise<Booted | undefined>;