@lukoweb/apitogo 0.2.23 → 0.2.25

package/docs/guides/managing-api-keys-and-identities.md

@@ -1,89 +1,89 @@
----
-title: Managing API Keys and Identities
-sidebar_label: API Keys and Identities
-sidebar_icon: key-square
----
-
-## Portal products (APItoGo)
-
-For developer portals, enable API keys under **`modules.userPanel.apiKeys`** in
-`apitogo.config.json` (not a root `apiKeys` key):
-
-```json
-{
-  "modules": {
-    "userPanel": {
-      "enabled": true,
-      "apiKeys": { "enabled": true }
-    }
-  }
-}
-```
-
-With MCP, prefer `update_dev_portal_manifest`. Subscription / gateway keys for provisioned portals
-are issued by the APItoGo platform after sign-in; see
-[Authentication](../configuration/authentication.md) and [MCP go-live](../mcp/go-live.md).
-
-Legacy root `apiKeys: { enabled: true }` is still migrated on load into `modules.userPanel.apiKeys`.
-
-## Custom API key UI plugin
-
-APIToGo includes a UI plugin for managing API consumers and keys (create, view, update, delete). You
-can point it at any backend by implementing callbacks / `ApiKeyService`.
-
-Enable and customize from TSX when you need custom create/list logic:
-
-```typescript title=config
-const config = {
-  apiKeys: {
-    enabled: true,
-    createKey: async ({ apiKey, context, auth }) => {
-      const createApiKeyRequest = new Request("https://api.example.com/v1/developer/api-key", {
-        method: "POST",
-        body: JSON.stringify({ apiKey }),
-      });
-      const signedRequest = await context.signRequest(createApiKeyRequest);
-      const response = await fetch(signedRequest);
-      if (!response.ok) {
-        throw new Error("Could not create API Key");
-      }
-      return true;
-    },
-  },
-};
-```
-
-The account UI is typically available under `/account/settings/api-keys` when the user panel is
-enabled.
-
-## Custom `ApiKeyService`
-
-```typescript
-interface ApiKeyService {
-  getConsumers: (context: ApitogoContext) => Promise<ApiConsumer[]>;
-  rollKey?: (consumerId: string, context: ApitogoContext) => Promise<void>;
-  deleteKey?: (consumerId: string, keyId: string, context: ApitogoContext) => Promise<void>;
-  updateConsumer?: (
-    consumer: { id: string; label?: string },
-    context: ApitogoContext,
-  ) => Promise<void>;
-  getUsage?: (apiKeys: string[], context: ApitogoContext) => Promise<void>;
-  createKey?: ({
-    apiKey,
-    context,
-    auth,
-  }: {
-    apiKey: { description: string; expiresOn?: string };
-    context: ApitogoContext;
-    auth: UseAuthReturn;
-  }) => Promise<void>;
-}
-```
-
-Wire the service through the `apiKeys` config object in TSX (same callbacks as above). Prefer
-`modules.userPanel.apiKeys.enabled` in JSON for portal toggles.
-
-## Related
-
-- [Auth providers and API identities](../concepts/auth-provider-api-identities.md)
-- [Manifest](../configuration/manifest.md)
+---
+title: Managing API Keys and Identities
+sidebar_label: API Keys and Identities
+sidebar_icon: key-square
+---
+
+## Portal products (APItoGo)
+
+For developer portals, enable API keys under **`modules.userPanel.apiKeys`** in
+`apitogo.config.json` (not a root `apiKeys` key):
+
+```json
+{
+  "modules": {
+    "userPanel": {
+      "enabled": true,
+      "apiKeys": { "enabled": true }
+    }
+  }
+}
+```
+
+With MCP, prefer `update_dev_portal_manifest`. Subscription / gateway keys for provisioned portals
+are issued by the APItoGo platform after sign-in; see
+[Authentication](../configuration/authentication.md) and [MCP go-live](../mcp/go-live.md).
+
+Legacy root `apiKeys: { enabled: true }` is still migrated on load into `modules.userPanel.apiKeys`.
+
+## Custom API key UI plugin
+
+APIToGo includes a UI plugin for managing API consumers and keys (create, view, update, delete). You
+can point it at any backend by implementing callbacks / `ApiKeyService`.
+
+Enable and customize from TSX when you need custom create/list logic:
+
+```typescript title=config
+const config = {
+  apiKeys: {
+    enabled: true,
+    createKey: async ({ apiKey, context, auth }) => {
+      const createApiKeyRequest = new Request("https://api.example.com/v1/developer/api-key", {
+        method: "POST",
+        body: JSON.stringify({ apiKey }),
+      });
+      const signedRequest = await context.signRequest(createApiKeyRequest);
+      const response = await fetch(signedRequest);
+      if (!response.ok) {
+        throw new Error("Could not create API Key");
+      }
+      return true;
+    },
+  },
+};
+```
+
+The account UI is typically available under `/account/settings/api-keys` when the user panel is
+enabled.
+
+## Custom `ApiKeyService`
+
+```typescript
+interface ApiKeyService {
+  getConsumers: (context: ApitogoContext) => Promise<ApiConsumer[]>;
+  rollKey?: (consumerId: string, context: ApitogoContext) => Promise<void>;
+  deleteKey?: (consumerId: string, keyId: string, context: ApitogoContext) => Promise<void>;
+  updateConsumer?: (
+    consumer: { id: string; label?: string },
+    context: ApitogoContext,
+  ) => Promise<void>;
+  getUsage?: (apiKeys: string[], context: ApitogoContext) => Promise<void>;
+  createKey?: ({
+    apiKey,
+    context,
+    auth,
+  }: {
+    apiKey: { description: string; expiresOn?: string };
+    context: ApitogoContext;
+    auth: UseAuthReturn;
+  }) => Promise<void>;
+}
+```
+
+Wire the service through the `apiKeys` config object in TSX (same callbacks as above). Prefer
+`modules.userPanel.apiKeys.enabled` in JSON for portal toggles.
+
+## Related
+
+- [Auth providers and API identities](../concepts/auth-provider-api-identities.md)
+- [Manifest](../configuration/manifest.md)

package/docs/guides/mermaid.mdx

@@ -1,70 +1,70 @@
----
-title: Mermaid Diagrams
-sidebar_icon: chart-network
----
-
-APIToGo supports rendering [Mermaid diagrams](https://mermaid.js.org/) in two ways:
-
-| Approach                        | Pros                                                                  | Cons                                                        |
-| ------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------- |
-| **Build-Time** (rehype-mermaid) | • Faster page loads<br/>• No client-side JS needed<br/>• SEO friendly | • Requires playwright<br/>• Slower builds<br/>• Static only |
-| **Client-Side** (`<Mermaid />`) | • Fast builds<br/>• Can be dynamic<br/>• No build dependencies        | • Requires client-side JS<br/>• Slight render delay         |
-
-## Client-Side Rendering
-
-For the [`<Mermaid />` component](/docs/components/mermaid), install the peer dependency:
-
-```bash
-npm install mermaid
-```
-
-Then use in your MDX files (no import needed):
-
-```tsx
-<Mermaid
-  chart={`graph TD;
-    A-->B;
-    A-->C;`}
-/>
-```
-
-Outside of MDX, import from `@lukoweb/apitogo/mermaid`:
-
-```tsx
-import { Mermaid } from "@lukoweb/apitogo/mermaid";
-```
-
-See the [Mermaid component documentation](/docs/components/mermaid) for full details.
-
-## Build-Time Rendering
-
-<Stepper>
-
-1. Install dependencies:
-
-   ```bash
-   npm install rehype-mermaid
-   npm install -D playwright
-   npx playwright install
-   ```
-
-1. Add to `apitogo.build.ts`:
-
-   ```tsx title="apitogo.build.ts"
-   import rehypeMermaid from "rehype-mermaid";
-
-   export default {
-     rehypePlugins: (plugins) => [[rehypeMermaid, { strategy: "inline-svg" }], ...plugins],
-   };
-   ```
-
-1. Use in markdown with code blocks:
-
-   ````mdx
-   ```mermaid
-   graph TD;
-       A-->B;
-   ```
-   ````
-
-</Stepper>
+---
+title: Mermaid Diagrams
+sidebar_icon: chart-network
+---
+
+APIToGo supports rendering [Mermaid diagrams](https://mermaid.js.org/) in two ways:
+
+| Approach                        | Pros                                                                  | Cons                                                        |
+| ------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------- |
+| **Build-Time** (rehype-mermaid) | • Faster page loads<br/>• No client-side JS needed<br/>• SEO friendly | • Requires playwright<br/>• Slower builds<br/>• Static only |
+| **Client-Side** (`<Mermaid />`) | • Fast builds<br/>• Can be dynamic<br/>• No build dependencies        | • Requires client-side JS<br/>• Slight render delay         |
+
+## Client-Side Rendering
+
+For the [`<Mermaid />` component](/docs/components/mermaid), install the peer dependency:
+
+```bash
+npm install mermaid
+```
+
+Then use in your MDX files (no import needed):
+
+```tsx
+<Mermaid
+  chart={`graph TD;
+    A-->B;
+    A-->C;`}
+/>
+```
+
+Outside of MDX, import from `@lukoweb/apitogo/mermaid`:
+
+```tsx
+import { Mermaid } from "@lukoweb/apitogo/mermaid";
+```
+
+See the [Mermaid component documentation](/docs/components/mermaid) for full details.
+
+## Build-Time Rendering
+
+<Stepper>
+
+1. Install dependencies:
+
+   ```bash
+   npm install rehype-mermaid
+   npm install -D playwright
+   npx playwright install
+   ```
+
+1. Add to `apitogo.build.ts`:
+
+   ```tsx title="apitogo.build.ts"
+   import rehypeMermaid from "rehype-mermaid";
+
+   export default {
+     rehypePlugins: (plugins) => [[rehypeMermaid, { strategy: "inline-svg" }], ...plugins],
+   };
+   ```
+
+1. Use in markdown with code blocks:
+
+   ````mdx
+   ```mermaid
+   graph TD;
+       A-->B;
+   ```
+   ````
+
+</Stepper>