@voilabs/plugins 0.0.1-beta.0 → 0.0.1-beta.2

package/README.md

@@ -9,8 +9,9 @@ A framework-agnostic plugin system for Node.js applications. The core package ru
 - HTTP runtime for `/plugins`, `/plugins/:id/install`, `/plugins/:id/config`, and custom plugin routes.
 - WordPress-like injection support: plugins can inject `script`, `style`, `html`, `meta`, `link`, and `noscript` into placements such as `head`, `body:end`, `admin:head`, and `public:footer`.
 - Elysia and Next.js adapters that use structural typing and do not require hard dependencies.
-- React integration through a fetch client and hook factory without making React a peer dependency.
-- GitHub marketplace support through `<plugin-id>.plugin`, `marketplace.json`, `plugins.json`, and `index.json`.
+- React integration through a fetch client, hook factory, and slot renderer without making React a peer dependency.
+- GitHub marketplace support through plugin folders such as `lumina/schema.json`, plus optional `marketplace.json`, `plugins.json`, and `index.json` manifests.
+- Plugin-contained frontend modules and assets: remote schemas can reference component, script, style, image, and font files living beside `schema.json`.
 
 ## Installation
 
@@ -109,7 +110,7 @@ export const luminaAIPlugin = new Plugin({
 });
 ```
 
-When you create a plugin locally with `new Plugin()`, `provider` is required and the exact value you provide is used. For GitHub-loaded `.plugin` files, `provider` and `iconUrl` from the file are ignored.
+When you create a plugin locally with `new Plugin()`, `provider` is required and the exact value you provide is used. For GitHub-loaded `schema.json` files, `provider` and `iconUrl` from the file are ignored.
 
 Ready-to-use example: `@voilabs/plugins/examples/lumina`.
 
@@ -155,7 +156,7 @@ const plugins = new PluginManager({
       branch: "main",
       token: process.env.GITHUB_TOKEN,
       files: ["marketplace.json", "plugins.json"],
-      pluginFileExtensions: [".plugin"],
+      schemaFileNames: ["schema.json"],
     },
     {
       github: "voilabs/plugins-marketplace",
@@ -168,18 +169,19 @@ const plugins = new PluginManager({
 
 By default, a GitHub repository is read from two sources:
 
-- `*.plugin` files discovered through the repository tree. File names usually follow `<plugin-id>.plugin`.
+- `schema.json` files discovered through the repository tree. Each plugin normally owns a folder such as `lumina/schema.json`.
 - `marketplace.json`, `plugins.json`, and `index.json` marketplace manifests.
 
 If no branch is configured, `main` and `master` are tried. If you provide a GitHub `blob` URL, that exact JSON file is used.
 
-## GitHub `.plugin` Files
+## GitHub Plugin Folders
 
-A `.plugin` file contains one plugin manifest as JSON. For GitHub-loaded plugins:
+A plugin folder contains one `schema.json` manifest plus any files the plugin needs. For GitHub-loaded plugins:
 
 - `provider` is always the repository owner.
 - `iconUrl` is always generated from the repository owner avatar: `https://github.com/<owner>.png?size=128`.
-- Any `provider` or `iconUrl` inside the `.plugin` file is ignored.
+- Any `provider` or `iconUrl` inside `schema.json` is ignored.
+- Relative component, asset, script, style, and injection URLs are resolved from the folder containing `schema.json`.
 
 ```json
 {
@@ -195,6 +197,23 @@ A `.plugin` file contains one plugin manifest as JSON. For GitHub-loaded plugins
       "required": true
     }
   ],
+  "frontend": {
+    "components": [
+      {
+        "key": "lumina-settings",
+        "slot": "settings-panel",
+        "label": "Lumina settings",
+        "component": {
+          "type": "remote",
+          "path": "components/settings.js",
+          "exportName": "default"
+        },
+        "props": {
+          "dense": true
+        }
+      }
+    ]
+  },
   "routes": [
     {
       "id": "create-article",
@@ -221,6 +240,13 @@ A `.plugin` file contains one plugin manifest as JSON. For GitHub-loaded plugins
       "type": "html",
       "placement": "body:end",
       "content": "<div data-lumina-widget></div>"
+    },
+    {
+      "key": "lumina-widget-script",
+      "type": "script",
+      "placement": "public:footer",
+      "src": "assets/widget.js",
+      "defer": true
     }
   ]
 }
@@ -230,12 +256,27 @@ Example repository:
 
 ```text
 plugins-marketplace/
-  voidigital-lumina.plugin
-  analytics-pixel.plugin
-  commerce/iyzico.plugin
+  lumina/
+    schema.json
+    components/settings.js
+    assets/widget.js
+  analytics-pixel/
+    schema.json
+    assets/pixel.js
+  commerce/iyzico/
+    schema.json
+    components/settings.js
 ```
 
-If you set `path`, only `.plugin` files under that folder are read.
+If you set `path`, only `schema.json` files under that folder are read. A single-plugin repository can also put `schema.json` at the repository root.
+
+## GitHub Examples
+
+See `github-examples/google-tag-manager` for a folder-based marketplace plugin. It includes:
+
+- `schema.json` with fields, routes, frontend components, assets, and GTM injections.
+- `components/settings.js` and `components/dashboard-card.js` as browser-ready remote components.
+- `assets/admin.css` as a plugin-owned asset referenced from the schema.
 
 GitHub-loaded plugins support the same manifest surface as local plugins: routes, frontend components, injections, meta tags, assets, permissions, webhooks, and more. Since JSON cannot carry JavaScript functions, remote plugin routes use declarative actions:
 
@@ -395,25 +436,340 @@ await plugins.renderInjections({
 ## Next.js App Router Adapter
 
 ```ts
-// app/api/plugins/[...voilabs]/route.ts
+// app/api/plugins/[[...voilabs]]/route.ts
+import { createNextPluginRouteHandlers } from "@voilabs/plugins/adapters/next";
+import { plugins } from "@/server/plugins";
+
+export const { GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD } =
+  createNextPluginRouteHandlers(plugins, {
+    prefix: "/api/plugins",
+  });
+```
+
+Use an optional catch-all route (`[[...voilabs]]`) so both `/api/plugins` and `/api/plugins/:pluginId/*` reach the same handler.
+
+## Minimal Next.js App Router Example
+
+This is a copy-paste friendly setup for a native Next.js app. It uses the App Router, one API route, one client-side plugin provider, a tiny admin page, and a client injection bridge.
+
+```text
+instrumentation.ts
+src/
+  server/plugins.ts
+app/
+  api/plugins/[[...voilabs]]/route.ts
+  admin/plugins/page.tsx
+  admin/plugins/voilabs-plugin-react.tsx
+  plugin-injections.tsx
+  layout.tsx
+```
+
+### `src/server/plugins.ts`
+
+```ts
+import "server-only";
+import { MemoryPluginDatabase, PluginManager } from "@voilabs/plugins";
+
+const globalForPlugins = globalThis as typeof globalThis & {
+  __voilabsPlugins?: PluginManager;
+};
+
+const marketplace = process.env.VOILABS_PLUGIN_MARKETPLACE;
+const githubToken = process.env.GITHUB_TOKEN;
+
+export const plugins =
+  globalForPlugins.__voilabsPlugins ??
+  (globalForPlugins.__voilabsPlugins = new PluginManager({
+    marketplaces: marketplace ? [marketplace] : [],
+    autoSyncMarketplaces: Boolean(marketplace),
+    database: new MemoryPluginDatabase(),
+    encryption: {
+      encrypt: async (value) => value,
+      decrypt: async (value) => value,
+    },
+    github: githubToken ? { token: githubToken } : undefined,
+    marketplaceRequestTimeoutMs: 10_000,
+    marketplaceRefreshIntervalMs: 5 * 60 * 1000,
+  }));
+```
+
+If `VOILABS_PLUGIN_MARKETPLACE` is not set, the API returns an empty plugin list instead of trying to fetch a placeholder repository.
+
+For Redis persistence, install a Redis client and assign it to `redis`. Upstash works well in serverless Next.js projects:
+
+```ts
+import { Redis } from "@upstash/redis";
+import { MemoryPluginDatabase, RedisPluginDatabase } from "@voilabs/plugins";
+
+const redis =
+  process.env.UPSTASH_REDIS_REST_URL && process.env.UPSTASH_REDIS_REST_TOKEN
+    ? Redis.fromEnv()
+    : undefined;
+
+const database = redis
+  ? new RedisPluginDatabase(redis, { prefix: "my-app:plugins" })
+  : new MemoryPluginDatabase();
+```
+
+Then pass `database` into `new PluginManager({ database, ... })`. You can also let the manager create the adapter:
+
+```ts
+new PluginManager({
+  redis,
+  redisPrefix: "my-app:plugins",
+});
+```
+
+The built-in `RedisPluginDatabase` stores installations and config in Redis. For production secret fields, replace the placeholder encryption provider with your KMS or app encryption layer.
+
+### `instrumentation.ts`
+
+```ts
+export async function register() {
+  if (process.env.NEXT_RUNTIME === "nodejs") {
+    const { plugins } = await import("./src/server/plugins");
+    await plugins.ready();
+  }
+}
+```
+
+`instrumentation.ts` warms the marketplace registry when the Next.js server starts, so `/admin/plugins` does not have to perform the first GitHub sync during its initial loading state.
+
+### `app/api/plugins/[[...voilabs]]/route.ts`
+
+```ts
 import { createNextPluginRouteHandlers } from "@voilabs/plugins/adapters/next";
 import { plugins } from "@/server/plugins";
 
+export const runtime = "nodejs";
+export const dynamic = "force-dynamic";
+
 export const { GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD } =
   createNextPluginRouteHandlers(plugins, {
     prefix: "/api/plugins",
+    exposeErrors: process.env.NODE_ENV !== "production",
   });
 ```
 
+### `app/admin/plugins/voilabs-plugin-react.tsx`
+
+```tsx
+"use client";
+
+import * as React from "react";
+import { createPluginReactIntegration } from "@voilabs/plugins/react";
+
+export const {
+  PluginProvider,
+  PluginSlot,
+  usePluginClient,
+  usePlugins,
+} = createPluginReactIntegration(React, {
+  baseUrl: "/api/plugins",
+  requestTimeoutMs: 15_000,
+});
+```
+
+### `app/admin/plugins/page.tsx`
+
+```tsx
+"use client";
+
+import {
+  PluginProvider,
+  PluginSlot,
+  usePluginClient,
+  usePlugins,
+} from "./voilabs-plugin-react";
+
+function defaultConfig(plugin: { id: string; fields?: Array<{ key: string; defaultValue?: unknown }> }) {
+  if (plugin.id === "google-tag-manager") {
+    return {
+      containerId: "GTM-ABC123",
+      dataLayerName: "dataLayer",
+    };
+  }
+
+  return Object.fromEntries(
+    (plugin.fields ?? []).map((field) => [field.key, field.defaultValue ?? ""]),
+  );
+}
+
+function PluginAdmin() {
+  const client = usePluginClient();
+  const { data, loading, error } = usePlugins({ page: 1, limit: 50 });
+
+  if (loading) return <main>Loading plugins...</main>;
+  if (error) {
+    return (
+      <main style={{ padding: 24 }}>
+        <h1>Plugin API error</h1>
+        <pre>{error instanceof Error ? error.message : String(error)}</pre>
+      </main>
+    );
+  }
+
+  return (
+    <main style={{ display: "grid", gap: 24, padding: 24 }}>
+      <section style={{ display: "grid", gap: 12 }}>
+        {data?.data.map((plugin) => (
+          <article
+            key={plugin.id}
+            style={{ border: "1px solid #ddd", borderRadius: 8, padding: 16 }}
+          >
+            <img src={plugin.iconUrl} alt="" width={32} height={32} />
+            <h2>{plugin.name}</h2>
+            <p>{plugin.summary}</p>
+            <p>
+              {plugin.provider} / {plugin.category}
+            </p>
+            <button
+              onClick={() => client.install(plugin.id, defaultConfig(plugin))}
+            >
+              Install
+            </button>
+            <button onClick={() => client.enable(plugin.id)}>Enable</button>
+            <button onClick={() => client.disable(plugin.id)}>Disable</button>
+          </article>
+        ))}
+      </section>
+
+      <aside>
+        <PluginSlot
+          slot="settings-panel"
+          installedOnly={false}
+          enabledOnly={false}
+        />
+      </aside>
+    </main>
+  );
+}
+
+export default function PluginsPage() {
+  return (
+    <PluginProvider>
+      <PluginAdmin />
+    </PluginProvider>
+  );
+}
+```
+
+### `app/plugin-injections.tsx`
+
+```tsx
+"use client";
+
+import { useEffect } from "react";
+
+type Placement = "head" | "body:start" | "body:end";
+
+export function PluginInjections() {
+  useEffect(() => {
+    const controller = new AbortController();
+
+    void inject("head", document.head, "beforeend", controller.signal);
+    void inject("body:start", document.body, "afterbegin", controller.signal);
+    void inject("body:end", document.body, "beforeend", controller.signal);
+
+    return () => controller.abort();
+  }, []);
+
+  return null;
+}
+
+async function inject(
+  placement: Placement,
+  target: HTMLElement,
+  position: InsertPosition,
+  signal: AbortSignal,
+) {
+  const marker = `voilabs:${placement}`;
+  if (document.querySelector(`[data-voilabs-injection="${marker}"]`)) {
+    return;
+  }
+
+  const response = await fetch(
+    `/api/plugins/injections?area=public&placement=${encodeURIComponent(placement)}`,
+    { signal },
+  );
+  const payload = (await response.json()) as { html?: string };
+  if (!payload.html) return;
+
+  const wrapper = document.createElement("div");
+  wrapper.dataset.voilabsInjection = marker;
+  appendExecutableHtml(wrapper, payload.html);
+  target.insertAdjacentElement(position, wrapper);
+}
+
+function appendExecutableHtml(target: HTMLElement, html: string) {
+  const template = document.createElement("template");
+  template.innerHTML = html;
+
+  for (const node of Array.from(template.content.childNodes)) {
+    if (node instanceof HTMLScriptElement) {
+      const script = document.createElement("script");
+      for (const attribute of Array.from(node.attributes)) {
+        script.setAttribute(attribute.name, attribute.value);
+      }
+      script.text = node.text;
+      target.appendChild(script);
+      continue;
+    }
+
+    target.appendChild(node);
+  }
+}
+```
+
+### `app/layout.tsx`
+
+```tsx
+import { PluginInjections } from "./plugin-injections";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>
+        <PluginInjections />
+        {children}
+      </body>
+    </html>
+  );
+}
+```
+
+### Try It With The GTM Example
+
+Push `github-examples/google-tag-manager` to a GitHub repo, then set:
+
+```bash
+VOILABS_PLUGIN_MARKETPLACE=<github-owner>/<plugins-repo>
+```
+
+Open `/admin/plugins`, install `google-tag-manager`, then visit any public page. The app will request `/api/plugins/injections?area=public&placement=head` and inject the GTM script for installed and enabled plugins.
+
+### If The Page Stays Loading
+
+Open `/api/plugins` directly in the browser.
+
+- If it is pending, the server is waiting on GitHub. Check `VOILABS_PLUGIN_MARKETPLACE`, add `GITHUB_TOKEN` for private or rate-limited repos, or lower `marketplaceRequestTimeoutMs`.
+- If it returns 404, make sure the route folder is `app/api/plugins/[[...voilabs]]/route.ts`, not `[...voilabs]`.
+- If it returns JSON with `data: []`, the Next.js wiring is working and the marketplace repo did not provide discoverable `schema.json` files.
+- If `/admin/plugins` still says loading after `/api/plugins` returns JSON, confirm `PluginProvider` uses `baseUrl: "/api/plugins"` and the page is a client component with `"use client"`.
+
 ## React Integration
 
-React is not imported by the package. Pass your app's React object into the integration factory.
+React is not imported by the package. Pass your app's React object into the integration factory. The host app does not need to register every marketplace component manually; it can render plugin slots and let the plugin schema load browser-ready component modules from the plugin folder.
 
 ```tsx
 import * as React from "react";
 import { createPluginReactIntegration } from "@voilabs/plugins/react";
 
-const { PluginProvider, usePlugins } = createPluginReactIntegration(React, {
+const { PluginProvider, PluginSlot, usePlugins } = createPluginReactIntegration(React, {
   baseUrl: "/api/plugins",
 });
 
@@ -436,11 +792,45 @@ export function App() {
   return (
     <PluginProvider>
       <PluginList />
+      <PluginSlot slot="settings-panel" />
     </PluginProvider>
   );
 }
 ```
 
+Remote component modules are loaded from the plugin asset endpoint when a schema uses `component.path`:
+
+```json
+{
+  "frontend": {
+    "components": [
+      {
+        "key": "analytics-card",
+        "slot": "dashboard-card",
+        "component": {
+          "type": "remote",
+          "path": "components/dashboard-card.js"
+        }
+      }
+    ]
+  }
+}
+```
+
+The component file must be browser-ready ESM:
+
+```js
+export default function DashboardCard(props) {
+  return props.React.createElement(
+    "section",
+    null,
+    `Plugin: ${props.plugin.name}`,
+  );
+}
+```
+
+If a project uses a custom module federation/runtime loader, pass `loadRemoteModule` to `createPluginReactIntegration` or `PluginProvider`.
+
 ## Marketplace JSON Format
 
 Marketplace JSON can be either an array or an object:
@@ -460,7 +850,7 @@ Marketplace JSON can be either an array or an object:
 }
 ```
 
-When a GitHub repository URL is provided, `<plugin-id>.plugin` files are discovered first. `marketplace.json`, `plugins.json`, and `index.json` are also tried.
+When a GitHub repository URL is provided, folder-based `schema.json` files are discovered first. `marketplace.json`, `plugins.json`, and `index.json` are also tried for curated indexes or non-GitHub sources.
 
 ## Integration Prompts
 
@@ -473,11 +863,11 @@ Integrate @voilabs/plugins into this project using Next.js for the frontend/admi
 
 Goals:
 - Use GitHub marketplace repositories as the plugin source.
-- Automatically discover <plugin-id>.plugin files from the configured GitHub repo.
+- Automatically discover plugin folders with schema.json files from the configured GitHub repo.
 - Treat the GitHub repo owner as the provider for remote plugins.
 - Use the GitHub owner avatar as the plugin icon.
-- Ignore provider and iconUrl values inside remote .plugin files.
-- Support plugin fields, install/update/enable/disable/uninstall, declarative routes, proxy routes, redirects, frontend component manifests, and HTML/script/style injections.
+- Ignore provider and iconUrl values inside remote schema.json files.
+- Support plugin fields, install/update/enable/disable/uninstall, declarative routes, proxy routes, redirects, plugin-contained frontend modules/assets, and HTML/script/style injections.
 
 Backend/Elysia work:
 1. Create a singleton plugin manager, for example in src/server/plugins.ts:
@@ -508,9 +898,10 @@ Next.js/React work:
    - generate config forms from plugin.fields
    - support secret fields without echoing plain secret values back into the UI
    - install, update config, enable, disable, and uninstall plugins
-4. Render frontend component manifests through a local component registry:
-   - support component.type === "registry"
-   - ignore unknown registry components safely
+4. Render frontend component manifests through plugin slots:
+   - use PluginSlot from @voilabs/plugins/react for slots such as settings-panel, dashboard-card, sidebar-item
+   - support component.type === "remote" with component.path resolved from the plugin folder
+   - avoid host-app component registration unless the project intentionally uses local registry components
 5. Add injection support:
    - head injections: render via the API or server helper and place into the document head
    - body/footer injections: provide slots in the app layout
@@ -518,7 +909,7 @@ Next.js/React work:
 
 Verification:
 - Run TypeScript checks and the project build.
-- Verify GitHub .plugin discovery with at least one plugin that does not define provider or iconUrl.
+- Verify GitHub schema.json discovery with at least one plugin that does not define provider or iconUrl.
 - Confirm the UI shows provider as the GitHub owner and icon as the GitHub avatar.
 - Confirm install + enable works.
 - Confirm a declarative route using response/proxy/redirect works.
@@ -533,10 +924,10 @@ Integrate @voilabs/plugins into this native Next.js project.
 Goals:
 - Use Next.js App Router API routes for the plugin runtime.
 - Use React integration for the admin/plugin UI.
-- Load remote plugins from GitHub marketplace repositories and <plugin-id>.plugin files.
+- Load remote plugins from GitHub marketplace repositories and plugin folders with schema.json files.
 - Remote plugin provider must always be the GitHub repo owner.
 - Remote plugin iconUrl must always be the GitHub owner avatar.
-- Ignore provider and iconUrl fields inside GitHub-loaded plugin files.
+- Ignore provider and iconUrl fields inside GitHub-loaded schema.json files.
 
 Server work:
 1. Create src/server/plugins.ts:
@@ -544,7 +935,7 @@ Server work:
    - configure marketplaces: ["<github-owner>/<plugins-repo>"]
    - use MemoryPluginDatabase as a temporary adapter if no DB adapter exists
    - add encryption provider hooks for secret fields
-2. Create app/api/plugins/[...voilabs]/route.ts:
+2. Create app/api/plugins/[[...voilabs]]/route.ts:
    - import createNextPluginRouteHandlers from @voilabs/plugins/adapters/next
    - export GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD from createNextPluginRouteHandlers(plugins, { prefix: "/api/plugins" })
 3. Ensure the following routes work:
@@ -569,8 +960,9 @@ React/admin work:
    - handle secret fields carefully and do not display stored secrets as plain text
    - wire install, updateConfig, enable, disable, uninstall
 4. Add support for plugin frontend manifests:
-   - resolve frontend.components with a local registry map
-   - render known registry components in their slots
+   - use PluginSlot from @voilabs/plugins/react
+   - render remote components declared by frontend.components without adding per-plugin host code
+   - only use a local registry map for explicitly local components
 5. Add injection support:
    - for server layouts, call plugins.renderInjections({ area: "public", placement: "head", nonce })
    - create safe body/footer slots for public and admin injections
@@ -578,7 +970,7 @@ React/admin work:
 
 Verification:
 - Run lint/typecheck/build.
-- Test a GitHub .plugin file without provider/iconUrl.
+- Test a GitHub schema.json file without provider/iconUrl.
 - Confirm provider is GitHub owner and iconUrl is https://github.com/<owner>.png?size=128.
 - Confirm declarative response, proxy, and redirect routes work.
 - Confirm plugin injections render in the expected placements.
@@ -591,10 +983,10 @@ Integrate @voilabs/plugins into this native Elysia.js project.
 
 Goals:
 - Use Elysia as the plugin API runtime.
-- Load plugins from GitHub marketplace repositories and <plugin-id>.plugin files.
+- Load plugins from GitHub marketplace repositories and plugin folders with schema.json files.
 - GitHub-loaded plugin provider must be the GitHub repo owner.
 - GitHub-loaded plugin iconUrl must be the GitHub owner avatar.
-- Ignore provider and iconUrl fields inside remote .plugin files.
+- Ignore provider and iconUrl fields inside remote schema.json files.
 - Support install/config/enable/disable/uninstall, declarative routes, proxy routes, redirects, and injection rendering endpoints.
 
 Implementation:
@@ -626,7 +1018,7 @@ Implementation:
 
 Verification:
 - Run typecheck/build/tests.
-- Mock or use a real GitHub marketplace with at least one <plugin-id>.plugin file.
+- Mock or use a real GitHub marketplace with at least one plugin-folder/schema.json file.
 - Confirm provider and iconUrl are derived from the GitHub repo owner.
 - Install and enable the plugin.
 - Confirm declarative response/proxy/redirect routes work.

package/dist/client.d.ts

@@ -1,16 +1,27 @@
-import type { PaginatedResult, PluginConfig, PluginInstallOptions, PluginListItem, PluginListOptions } from "./types.js";
+import type { PaginatedResult, PluginConfig, PluginInstallOptions, PluginListItem, PluginListOptions, ResolvedPluginFrontendComponent } from "./types.js";
 export interface PluginApiClientOptions {
     baseUrl?: string;
     fetcher?: typeof fetch;
     headers?: HeadersInit | (() => HeadersInit);
+    requestTimeoutMs?: number;
+}
+export interface PluginComponentListOptions {
+    pluginId?: string;
+    slot?: string;
+    tenantId?: string;
+    installedOnly?: boolean;
+    enabledOnly?: boolean;
 }
 export declare class PluginApiClient {
     private readonly baseUrl;
     private readonly fetcher;
     private readonly headers?;
+    private readonly requestTimeoutMs;
     constructor(options?: PluginApiClientOptions);
     list(options?: PluginListOptions): Promise<PaginatedResult<PluginListItem>>;
     get(pluginId: string): Promise<PluginListItem>;
+    components(options?: PluginComponentListOptions): Promise<ResolvedPluginFrontendComponent[]>;
+    assetUrl(pluginId: string, path: string): string;
     install<TConfig extends PluginConfig = PluginConfig>(pluginId: string, config: Partial<TConfig>, options?: PluginInstallOptions): Promise<unknown>;
     updateConfig<TConfig extends PluginConfig = PluginConfig>(pluginId: string, config: Partial<TConfig>, options?: {
         tenantId?: string;
@@ -25,6 +36,10 @@ export declare class PluginApiClient {
     }): Promise<TResponse>;
     private request;
 }
+export declare class PluginApiClientTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
 export declare class PluginApiClientError extends Error {
     readonly status: number;
     readonly payload: unknown;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;IACvB,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,CAAC,CAAC;CAC7C;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAoC;gBAEjD,OAAO,GAAE,sBAA2B;IAUhD,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAe/E,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9C,OAAO,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EACjD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,GAAE,oBAAyB;IAapC,YAAY,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EACtD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAO;IAatF,MAAM,CAAC,QAAQ,EAAE,MAAM;IAMvB,OAAO,CAAC,QAAQ,EAAE,MAAM;IAMxB,SAAS,CAAC,QAAQ,EAAE,MAAM;IAM1B,IAAI,CAAC,SAAS,GAAG,OAAO,EACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAO,GACxD,OAAO,CAAC,SAAS,CAAC;YAOP,OAAO;CAkCtB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAM7C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,iBAAiB,EACjB,+BAA+B,EAChC,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;IACvB,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,CAAC,CAAC;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAoC;IAC7D,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;gBAE9B,OAAO,GAAE,sBAA2B;IAWhD,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAe/E,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9C,UAAU,CACR,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,+BAA+B,EAAE,CAAC;IAe7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAOhD,OAAO,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EACjD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,GAAE,oBAAyB;IAapC,YAAY,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EACtD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAO;IAatF,MAAM,CAAC,QAAQ,EAAE,MAAM;IAMvB,OAAO,CAAC,QAAQ,EAAE,MAAM;IAMxB,SAAS,CAAC,QAAQ,EAAE,MAAM;IAM1B,IAAI,CAAC,SAAS,GAAG,OAAO,EACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAO,GACxD,OAAO,CAAC,SAAS,CAAC;YAOP,OAAO;CA8CtB;AAED,qBAAa,2BAA4B,SAAQ,KAAK;IACpD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;gBAEf,SAAS,EAAE,MAAM;CAK9B;AAED,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAM7C"}