@lukoweb/apitogo 0.2.22 → 0.2.24

package/docs/components.mdx

@@ -1,60 +1,60 @@
----
-title: Components
-sidebar_icon: component
-description: Reference of all APIToGo UI and documentation components.
----
-
-Use these components in MDX pages and custom React pages. Import from `@lukoweb/apitogo/ui/*` or
-`@lukoweb/apitogo/components` unless noted.
-
-## General
-
-| Component                                 | Import                        | Description                                      |
-| ----------------------------------------- | ----------------------------- | ------------------------------------------------ |
-| [Alert](/docs/components/alert)           | `@lukoweb/apitogo/ui/Alert`   | Important messages with severity levels          |
-| [Callout](/docs/components/callout)       | `@lukoweb/apitogo/ui/Callout` | Highlight notes, tips, and warnings              |
-| [Badge](/docs/components/badge)           | `@lukoweb/apitogo/ui/Badge`   | Status labels and tags                           |
-| [Card](/docs/components/card)             | `@lukoweb/apitogo/ui/Card`    | Grouped content with header, body, and footer    |
-| [Dialog](/docs/components/dialog)         | `@lukoweb/apitogo/ui/Dialog`  | Modal dialogs that require attention             |
-| [Icons](/docs/components/icons)           | `@lukoweb/apitogo/icons`      | Lucide icons re-exported for MDX and React       |
-| [Markdown](/docs/components/markdown)     | `@lukoweb/apitogo/components` | Render markdown with syntax highlighting         |
-| [Tooltip](/docs/components/tooltip)       | `@lukoweb/apitogo/ui/Tooltip` | Hover or focus hints                             |
-| [Typography](/docs/components/typography) | `@lukoweb/apitogo/components` | Prose styling for headings, lists, and body text |
-
-## Documentation
-
-| Component                                             | Import                                | Description                                          |
-| ----------------------------------------------------- | ------------------------------------- | ---------------------------------------------------- |
-| [CodeTabs](/docs/components/code-tabs)                | MDX built-in                          | Tabbed code examples (languages or package managers) |
-| [Mermaid](/docs/components/mermaid)                   | `@lukoweb/apitogo/mermaid`            | Client-rendered Mermaid diagrams                     |
-| [API Playground](/docs/components/playground)         | MDX built-in                          | Try API requests from the docs                       |
-| [Secret](/docs/components/secret)                     | `@lukoweb/apitogo/ui/Secret`          | Mask and reveal API keys                             |
-| [Stepper](/docs/components/stepper)                   | MDX built-in                          | Numbered multi-step guides                           |
-| [Syntax Highlight](/docs/components/syntax-highlight) | `@lukoweb/apitogo/ui/SyntaxHighlight` | Highlighted code with line numbers and copy          |
-
-## Form
-
-| Component                             | Import                         | Description                     |
-| ------------------------------------- | ------------------------------ | ------------------------------- |
-| [Button](/docs/components/button)     | `@lukoweb/apitogo/ui/Button`   | Actions with variants and sizes |
-| [Checkbox](/docs/components/checkbox) | `@lukoweb/apitogo/ui/Checkbox` | Boolean checkbox input          |
-| [Input](/docs/components/input)       | `@lukoweb/apitogo/ui/Input`    | Single-line text input          |
-| [Label](/docs/components/label)       | `@lukoweb/apitogo/ui/Label`    | Accessible form labels          |
-| [Select](/docs/components/select)     | `@lukoweb/apitogo/ui/Select`   | Choose from a list of options   |
-| [Slider](/docs/components/slider)     | `@lukoweb/apitogo/ui/Slider`   | Numeric range input             |
-| [Switch](/docs/components/switch)     | `@lukoweb/apitogo/ui/Switch`   | Boolean toggle                  |
-| [Textarea](/docs/components/textarea) | `@lukoweb/apitogo/ui/Textarea` | Multiline text input            |
-
-## Utility
-
-| Component                                  | Import                        | Description                         |
-| ------------------------------------------ | ----------------------------- | ----------------------------------- |
-| [ClientOnly](/docs/components/client-only) | `@lukoweb/apitogo/components` | Render children only on the client  |
-| [Head](/docs/components/head)              | `@lukoweb/apitogo/components` | Set title, meta, and link tags      |
-| [Link](/docs/components/link)              | `@lukoweb/apitogo/components` | Client-side and external navigation |
-| [Slot](/docs/components/slot)              | `@lukoweb/apitogo/components` | Inject content into layout slots    |
-
-## shadcn/ui
-
-Additional primitives are available from `@lukoweb/apitogo/ui/*`. See
-[shadcn/ui](/docs/components/shadcn) for the full list.
+---
+title: Components
+sidebar_icon: component
+description: Reference of all APIToGo UI and documentation components.
+---
+
+Use these components in MDX pages and custom React pages. Import from `@lukoweb/apitogo/ui/*` or
+`@lukoweb/apitogo/components` unless noted.
+
+## General
+
+| Component                                 | Import                        | Description                                      |
+| ----------------------------------------- | ----------------------------- | ------------------------------------------------ |
+| [Alert](/docs/components/alert)           | `@lukoweb/apitogo/ui/Alert`   | Important messages with severity levels          |
+| [Callout](/docs/components/callout)       | `@lukoweb/apitogo/ui/Callout` | Highlight notes, tips, and warnings              |
+| [Badge](/docs/components/badge)           | `@lukoweb/apitogo/ui/Badge`   | Status labels and tags                           |
+| [Card](/docs/components/card)             | `@lukoweb/apitogo/ui/Card`    | Grouped content with header, body, and footer    |
+| [Dialog](/docs/components/dialog)         | `@lukoweb/apitogo/ui/Dialog`  | Modal dialogs that require attention             |
+| [Icons](/docs/components/icons)           | `@lukoweb/apitogo/icons`      | Lucide icons re-exported for MDX and React       |
+| [Markdown](/docs/components/markdown)     | `@lukoweb/apitogo/components` | Render markdown with syntax highlighting         |
+| [Tooltip](/docs/components/tooltip)       | `@lukoweb/apitogo/ui/Tooltip` | Hover or focus hints                             |
+| [Typography](/docs/components/typography) | `@lukoweb/apitogo/components` | Prose styling for headings, lists, and body text |
+
+## Documentation
+
+| Component                                             | Import                                | Description                                          |
+| ----------------------------------------------------- | ------------------------------------- | ---------------------------------------------------- |
+| [CodeTabs](/docs/components/code-tabs)                | MDX built-in                          | Tabbed code examples (languages or package managers) |
+| [Mermaid](/docs/components/mermaid)                   | `@lukoweb/apitogo/mermaid`            | Client-rendered Mermaid diagrams                     |
+| [API Playground](/docs/components/playground)         | MDX built-in                          | Try API requests from the docs                       |
+| [Secret](/docs/components/secret)                     | `@lukoweb/apitogo/ui/Secret`          | Mask and reveal API keys                             |
+| [Stepper](/docs/components/stepper)                   | MDX built-in                          | Numbered multi-step guides                           |
+| [Syntax Highlight](/docs/components/syntax-highlight) | `@lukoweb/apitogo/ui/SyntaxHighlight` | Highlighted code with line numbers and copy          |
+
+## Form
+
+| Component                             | Import                         | Description                     |
+| ------------------------------------- | ------------------------------ | ------------------------------- |
+| [Button](/docs/components/button)     | `@lukoweb/apitogo/ui/Button`   | Actions with variants and sizes |
+| [Checkbox](/docs/components/checkbox) | `@lukoweb/apitogo/ui/Checkbox` | Boolean checkbox input          |
+| [Input](/docs/components/input)       | `@lukoweb/apitogo/ui/Input`    | Single-line text input          |
+| [Label](/docs/components/label)       | `@lukoweb/apitogo/ui/Label`    | Accessible form labels          |
+| [Select](/docs/components/select)     | `@lukoweb/apitogo/ui/Select`   | Choose from a list of options   |
+| [Slider](/docs/components/slider)     | `@lukoweb/apitogo/ui/Slider`   | Numeric range input             |
+| [Switch](/docs/components/switch)     | `@lukoweb/apitogo/ui/Switch`   | Boolean toggle                  |
+| [Textarea](/docs/components/textarea) | `@lukoweb/apitogo/ui/Textarea` | Multiline text input            |
+
+## Utility
+
+| Component                                  | Import                        | Description                         |
+| ------------------------------------------ | ----------------------------- | ----------------------------------- |
+| [ClientOnly](/docs/components/client-only) | `@lukoweb/apitogo/components` | Render children only on the client  |
+| [Head](/docs/components/head)              | `@lukoweb/apitogo/components` | Set title, meta, and link tags      |
+| [Link](/docs/components/link)              | `@lukoweb/apitogo/components` | Client-side and external navigation |
+| [Slot](/docs/components/slot)              | `@lukoweb/apitogo/components` | Inject content into layout slots    |
+
+## shadcn/ui
+
+Additional primitives are available from `@lukoweb/apitogo/ui/*`. See
+[shadcn/ui](/docs/components/shadcn) for the full list.

package/docs/concepts/auth-provider-api-identities.md

@@ -1,105 +1,105 @@
----
-title: Authentication Providers & API Identities
-sidebar_label: Authentication and Identities
----
-
-When building an API documentation portal, you often need a way for users to authenticate API
-requests — API keys and other identities — separately from how they sign in to the portal. APIToGo
-splits **portal authentication** from **API identities**.
-
-## Authentication Providers and API Identities
-
-:::tip
-
-**Authentication providers** allow your users to sign in to your documentation portal. **API
-Identities** allow your users to authenticate their API requests.
-
-:::
-
-Before diving into API Identities, it's important to understand that APIToGo separates user
-authentication from API authentication. Authentication providers handle how users sign in to your
-documentation portal, while API Identities manage how these users interact with your APIs.
-
-Portal products use [`dev-portal`](../configuration/authentication.md) auth (backend-delegated
-OIDC). SPA providers (Auth0, Clerk, …) are advanced for standalone docs sites. Providers handle:
-
-- User authentication for the documentation portal
-- Session management
-- User authorization and access control
-
-This separation allows you to:
-
-- Use different authentication methods for your portal and APIs
-- Manage API access independently of user authentication
-- Support multiple API authentication schemes simultaneously
-
-[Learn more about authentication providers](../configuration/authentication)
-
-## Understanding API Identities
-
-API Identities in APIToGo represent different authentication contexts that can be used to make API
-requests. These could be different environments (production, staging), different authentication
-methods (API key, JWT), or different service accounts.
-
-### The API Identity Interface
-
-```typescript
-interface ApiIdentity {
-  id: string;
-  label: string;
-  authorizeRequest: (request: Request) => Promise<Request> | Request;
-}
-
-interface ApiIdentityPlugin {
-  getIdentities: () => Promise<ApiIdentity[]> | ApiIdentity[];
-}
-```
-
-Each API Identity consists of:
-
-- `id`: A unique identifier for the identity
-- `label`: A human-readable name shown in the UI
-- `authorizeRequest`: A function that modifies requests to include the necessary authentication
-
-## Implementing API Identities
-
-In this example, we'll use Auth0 as our authentication provider and implement an API Identity for a
-demo API.
-
-:::note
-
-For APItoGo-hosted portals, subscription keys come from the platform after `dev-portal` sign-in.
-Implement custom API Identities when the playground should attach your own keys or JWTs.
-
-:::
-
-To add API Identities, implement the `ApiIdentityPlugin` interface:
-
-```typescript
-import { createApiIdentityPlugin } from "@lukoweb/apitogo/plugins";
-
-export default {
-  authentication: {
-    type: "auth0",
-    domain: "my-domain.auth0.com",
-    clientId: "my-client-id",
-  },
-  plugins: [
-    createApiIdentityPlugin({
-      getIdentities: async (context) => [
-        {
-          id: "api-key-one",
-          label: "My API Key",
-          authorizeRequest: (request) => {
-            // We get the access token from the
-            // authentication provider (Auth0) and add it to the request headers
-            return context.authentication?.signRequest(request);
-          },
-        },
-      ],
-    }),
-  ],
-};
-```
-
-When implemented, this identity will appear in the APIToGo playground.
+---
+title: Authentication Providers & API Identities
+sidebar_label: Authentication and Identities
+---
+
+When building an API documentation portal, you often need a way for users to authenticate API
+requests — API keys and other identities — separately from how they sign in to the portal. APIToGo
+splits **portal authentication** from **API identities**.
+
+## Authentication Providers and API Identities
+
+:::tip
+
+**Authentication providers** allow your users to sign in to your documentation portal. **API
+Identities** allow your users to authenticate their API requests.
+
+:::
+
+Before diving into API Identities, it's important to understand that APIToGo separates user
+authentication from API authentication. Authentication providers handle how users sign in to your
+documentation portal, while API Identities manage how these users interact with your APIs.
+
+Portal products use [`dev-portal`](../configuration/authentication.md) auth (backend-delegated
+OIDC). SPA providers (Auth0, Clerk, …) are advanced for standalone docs sites. Providers handle:
+
+- User authentication for the documentation portal
+- Session management
+- User authorization and access control
+
+This separation allows you to:
+
+- Use different authentication methods for your portal and APIs
+- Manage API access independently of user authentication
+- Support multiple API authentication schemes simultaneously
+
+[Learn more about authentication providers](../configuration/authentication)
+
+## Understanding API Identities
+
+API Identities in APIToGo represent different authentication contexts that can be used to make API
+requests. These could be different environments (production, staging), different authentication
+methods (API key, JWT), or different service accounts.
+
+### The API Identity Interface
+
+```typescript
+interface ApiIdentity {
+  id: string;
+  label: string;
+  authorizeRequest: (request: Request) => Promise<Request> | Request;
+}
+
+interface ApiIdentityPlugin {
+  getIdentities: () => Promise<ApiIdentity[]> | ApiIdentity[];
+}
+```
+
+Each API Identity consists of:
+
+- `id`: A unique identifier for the identity
+- `label`: A human-readable name shown in the UI
+- `authorizeRequest`: A function that modifies requests to include the necessary authentication
+
+## Implementing API Identities
+
+In this example, we'll use Auth0 as our authentication provider and implement an API Identity for a
+demo API.
+
+:::note
+
+For APItoGo-hosted portals, subscription keys come from the platform after `dev-portal` sign-in.
+Implement custom API Identities when the playground should attach your own keys or JWTs.
+
+:::
+
+To add API Identities, implement the `ApiIdentityPlugin` interface:
+
+```typescript
+import { createApiIdentityPlugin } from "@lukoweb/apitogo/plugins";
+
+export default {
+  authentication: {
+    type: "auth0",
+    domain: "my-domain.auth0.com",
+    clientId: "my-client-id",
+  },
+  plugins: [
+    createApiIdentityPlugin({
+      getIdentities: async (context) => [
+        {
+          id: "api-key-one",
+          label: "My API Key",
+          authorizeRequest: (request) => {
+            // We get the access token from the
+            // authentication provider (Auth0) and add it to the request headers
+            return context.authentication?.signRequest(request);
+          },
+        },
+      ],
+    }),
+  ],
+};
+```
+
+When implemented, this identity will appear in the APIToGo playground.

package/docs/configuration/ai-assistants.md

@@ -1,65 +1,65 @@
----
-title: AI Assistants
-sidebar_icon: bot
-description:
-  Configure which AI assistant integrations appear in dropdown menus across your APIToGo
-  documentation site, including built-in presets and custom providers.
----
-
-By default, APIToGo shows "Use in Claude" and "Use in ChatGPT" options in dropdown menus on both
-[API reference](./api-reference.md) and [documentation](./docs.md) pages. You can customize this
-behavior using the top-level `aiAssistants` configuration.
-
-## Disable AI Assistants
-
-To remove all AI assistant options:
-
-```ts title=config
-const config = {
-  aiAssistants: false,
-  // ...
-};
-```
-
-## Use Only Specific Presets
-
-```ts title=config
-const config = {
-  aiAssistants: ["claude"], // Only show Claude
-  // ...
-};
-```
-
-Available presets: `"claude"`, `"chatgpt"`
-
-## Add Custom AI Assistants
-
-You can add custom entries with a label and URL. Use `{pageUrl}` as a placeholder in the URL string,
-or provide a callback for full control:
-
-```ts title=config
-const config = {
-  aiAssistants: [
-    "claude", // built-in preset
-    {
-      label: "Open in MyAI",
-      // Simple string with placeholder
-      url: "https://myai.com/?context={pageUrl}",
-    },
-    {
-      label: "Open in CustomAI",
-      // Callback for full control
-      url: ({ pageUrl, type }) => {
-        if (type === "openapi") {
-          return `https://custom.ai/?q=${encodeURIComponent("Explain this API: " + pageUrl)}`;
-        }
-        return `https://custom.ai/?q=${encodeURIComponent("Explain this page: " + pageUrl)}`;
-      },
-    },
-  ],
-  // ...
-};
-```
-
-The callback receives `{ pageUrl: string, type: "docs" | "openapi" }` so you can customize behavior
-per context.
+---
+title: AI Assistants
+sidebar_icon: bot
+description:
+  Configure which AI assistant integrations appear in dropdown menus across your APIToGo
+  documentation site, including built-in presets and custom providers.
+---
+
+By default, APIToGo shows "Use in Claude" and "Use in ChatGPT" options in dropdown menus on both
+[API reference](./api-reference.md) and [documentation](./docs.md) pages. You can customize this
+behavior using the top-level `aiAssistants` configuration.
+
+## Disable AI Assistants
+
+To remove all AI assistant options:
+
+```ts title=config
+const config = {
+  aiAssistants: false,
+  // ...
+};
+```
+
+## Use Only Specific Presets
+
+```ts title=config
+const config = {
+  aiAssistants: ["claude"], // Only show Claude
+  // ...
+};
+```
+
+Available presets: `"claude"`, `"chatgpt"`
+
+## Add Custom AI Assistants
+
+You can add custom entries with a label and URL. Use `{pageUrl}` as a placeholder in the URL string,
+or provide a callback for full control:
+
+```ts title=config
+const config = {
+  aiAssistants: [
+    "claude", // built-in preset
+    {
+      label: "Open in MyAI",
+      // Simple string with placeholder
+      url: "https://myai.com/?context={pageUrl}",
+    },
+    {
+      label: "Open in CustomAI",
+      // Callback for full control
+      url: ({ pageUrl, type }) => {
+        if (type === "openapi") {
+          return `https://custom.ai/?q=${encodeURIComponent("Explain this API: " + pageUrl)}`;
+        }
+        return `https://custom.ai/?q=${encodeURIComponent("Explain this page: " + pageUrl)}`;
+      },
+    },
+  ],
+  // ...
+};
+```
+
+The callback receives `{ pageUrl: string, type: "docs" | "openapi" }` so you can customize behavior
+per context.