@lukoweb/apitogo 0.2.23 → 0.2.24

package/docs/guides/transforming-examples.md

@@ -1,156 +1,156 @@
----
-title: Transforming Operation Examples
-sidebar_icon: git-compare-arrows
----
-
-APIToGo allows you to transform operation examples in both request and response sections of your API
-documentation. This feature is particularly useful when you need to:
-
-- Modify example data before displaying it
-- Add dynamic values to examples
-- Format examples in a specific way
-- Filter or transform example content based on certain conditions
-
-## Configuration
-
-To use this feature, you need to configure the `transformExamples` function in your
-`apitogo.config.json` file. Here's how to do it:
-
-```tsx
-import type { ApitogoConfig } from "@lukoweb/apitogo";
-
-const config: ApitogoConfig = {
-  // ... other config options ...
-  defaults: {
-    apis: {
-      transformExamples: (options) => {
-        // Transform the content here
-        return options.content;
-      },
-    },
-  },
-};
-```
-
-## The Transform Function
-
-The `transformExamples` function receives an options object with the following properties:
-
-1. `content`: An array of Content objects containing the example data
-1. `operation`: The operation being displayed
-1. `type`: Either "request" or "response" indicating which type of example is being transformed
-1. `auth`: The current authentication state
-1. `context`: `ApitogoContext` (runtime context from `@lukoweb/apitogo`)
-
-The function should return an array of Content objects with the transformed examples.
-
-## Example Usage
-
-Here's a practical example showing how to transform examples:
-
-```tsx
-const config: ApitogoConfig = {
-  defaults: {
-    apis: {
-      transformExamples: ({ content, type }) => {
-        // Example: Add a timestamp to all examples
-        const timestamp = new Date().toISOString();
-
-        return content.map((contentItem) => ({
-          ...contentItem,
-          example: {
-            ...contentItem.example,
-            timestamp,
-            // You can modify other example properties here
-          },
-        }));
-      },
-    },
-  },
-};
-```
-
-## Use Cases
-
-### Adding Dynamic Values
-
-```tsx
-transformExamples: ({ content, auth }) => {
-  const apiKey = auth.accessToken;
-
-  return content.map((contentItem) => ({
-    ...contentItem,
-    example: {
-      ...contentItem.example,
-      headers: {
-        ...contentItem.example.headers,
-        Authorization: `Bearer ${apiKey}`,
-      },
-    },
-  }));
-};
-```
-
-### Formatting Examples
-
-```tsx
-transformExamples: ({ content }) => {
-  return content.map((contentItem) => ({
-    ...contentItem,
-    example: {
-      ...contentItem.example,
-      // Format dates in a specific way
-      createdAt: new Date(contentItem.example.createdAt).toLocaleDateString(),
-      // Format numbers with specific precision
-      amount: Number(contentItem.example.amount).toFixed(2),
-    },
-  }));
-};
-```
-
-### Conditional Transformation
-
-```tsx
-transformExamples: ({ content, auth, type }) => {
-  const isAuthenticated = auth.isAuthenticated;
-
-  return content.map((contentItem) => ({
-    ...contentItem,
-    example: isAuthenticated
-      ? contentItem.example // Show full example for authenticated users
-      : { ...contentItem.example, sensitiveData: undefined }, // Hide sensitive data for unauthenticated users
-  }));
-};
-```
-
-### Using JWT Claims
-
-```tsx
-transformExamples: async ({ content, auth, context }) => {
-  const token = await context.authentication.getAccessToken();
-
-  // Decode the JWT (this is a simple example - in production you might want to use a proper JWT library)
-  const [, payload] = token.split(".");
-  const decodedPayload = JSON.parse(atob(payload));
-
-  return content.map((contentItem) => ({
-    ...contentItem,
-    example: {
-      ...contentItem.example,
-      // Add user-specific data from the JWT
-      userId: decodedPayload.sub,
-      organizationId: decodedPayload.org_id,
-      // You can add any other claims from the JWT
-      role: decodedPayload.role,
-    },
-  }));
-};
-```
-
-## Best Practices
-
-1. Always return an array of Content objects, even if you're not transforming the content
-2. Preserve the original content structure while making your modifications
-3. Handle errors gracefully to prevent breaking the documentation
-4. Consider performance implications when transforming large examples
-5. Use the provided options object to access relevant information for your transformations
+---
+title: Transforming Operation Examples
+sidebar_icon: git-compare-arrows
+---
+
+APIToGo allows you to transform operation examples in both request and response sections of your API
+documentation. This feature is particularly useful when you need to:
+
+- Modify example data before displaying it
+- Add dynamic values to examples
+- Format examples in a specific way
+- Filter or transform example content based on certain conditions
+
+## Configuration
+
+To use this feature, you need to configure the `transformExamples` function in your
+`apitogo.config.json` file. Here's how to do it:
+
+```tsx
+import type { ApitogoConfig } from "@lukoweb/apitogo";
+
+const config: ApitogoConfig = {
+  // ... other config options ...
+  defaults: {
+    apis: {
+      transformExamples: (options) => {
+        // Transform the content here
+        return options.content;
+      },
+    },
+  },
+};
+```
+
+## The Transform Function
+
+The `transformExamples` function receives an options object with the following properties:
+
+1. `content`: An array of Content objects containing the example data
+1. `operation`: The operation being displayed
+1. `type`: Either "request" or "response" indicating which type of example is being transformed
+1. `auth`: The current authentication state
+1. `context`: `ApitogoContext` (runtime context from `@lukoweb/apitogo`)
+
+The function should return an array of Content objects with the transformed examples.
+
+## Example Usage
+
+Here's a practical example showing how to transform examples:
+
+```tsx
+const config: ApitogoConfig = {
+  defaults: {
+    apis: {
+      transformExamples: ({ content, type }) => {
+        // Example: Add a timestamp to all examples
+        const timestamp = new Date().toISOString();
+
+        return content.map((contentItem) => ({
+          ...contentItem,
+          example: {
+            ...contentItem.example,
+            timestamp,
+            // You can modify other example properties here
+          },
+        }));
+      },
+    },
+  },
+};
+```
+
+## Use Cases
+
+### Adding Dynamic Values
+
+```tsx
+transformExamples: ({ content, auth }) => {
+  const apiKey = auth.accessToken;
+
+  return content.map((contentItem) => ({
+    ...contentItem,
+    example: {
+      ...contentItem.example,
+      headers: {
+        ...contentItem.example.headers,
+        Authorization: `Bearer ${apiKey}`,
+      },
+    },
+  }));
+};
+```
+
+### Formatting Examples
+
+```tsx
+transformExamples: ({ content }) => {
+  return content.map((contentItem) => ({
+    ...contentItem,
+    example: {
+      ...contentItem.example,
+      // Format dates in a specific way
+      createdAt: new Date(contentItem.example.createdAt).toLocaleDateString(),
+      // Format numbers with specific precision
+      amount: Number(contentItem.example.amount).toFixed(2),
+    },
+  }));
+};
+```
+
+### Conditional Transformation
+
+```tsx
+transformExamples: ({ content, auth, type }) => {
+  const isAuthenticated = auth.isAuthenticated;
+
+  return content.map((contentItem) => ({
+    ...contentItem,
+    example: isAuthenticated
+      ? contentItem.example // Show full example for authenticated users
+      : { ...contentItem.example, sensitiveData: undefined }, // Hide sensitive data for unauthenticated users
+  }));
+};
+```
+
+### Using JWT Claims
+
+```tsx
+transformExamples: async ({ content, auth, context }) => {
+  const token = await context.authentication.getAccessToken();
+
+  // Decode the JWT (this is a simple example - in production you might want to use a proper JWT library)
+  const [, payload] = token.split(".");
+  const decodedPayload = JSON.parse(atob(payload));
+
+  return content.map((contentItem) => ({
+    ...contentItem,
+    example: {
+      ...contentItem.example,
+      // Add user-specific data from the JWT
+      userId: decodedPayload.sub,
+      organizationId: decodedPayload.org_id,
+      // You can add any other claims from the JWT
+      role: decodedPayload.role,
+    },
+  }));
+};
+```
+
+## Best Practices
+
+1. Always return an array of Content objects, even if you're not transforming the content
+2. Preserve the original content structure while making your modifications
+3. Handle errors gracefully to prevent breaking the documentation
+4. Consider performance implications when transforming large examples
+5. Use the provided options object to access relevant information for your transformations

package/docs/guides/using-multiple-apis.md

@@ -1,87 +1,87 @@
----
-title: Multiple APIs
-sidebar_icon: file-stack
----
-
-APIToGo supports creating documentation and API references for multiple APIs and can work with as
-many OpenAPI documents as you need.
-
-In order to do this you will need to modify the
-[APIToGo Configuration](../configuration/overview.md) file to include additional APIs.
-
-## Configuration
-
-Using multiple APIs is a configuration setting that you can add in the
-[APIToGo Configuration](../configuration/overview.md) file.
-
-### Step 1: Add your APIs
-
-First, create a new array in your configuration file that lists each API you want to include:
-
-```typescript
-const apis = [
-  {
-    type: "file",
-    input: "apis/my-first-api.json",
-    path: "/my-first-api",
-  },
-  {
-    type: "file",
-    input: "apis/my-second-api.json",
-    path: "/my-second-api",
-  },
-] as const;
-```
-
-### Step 2: Add navigation
-
-Create a navigation array for your sidebar:
-
-```typescript
-const navigation = [
-  {
-    type: "link",
-    label: "My First API",
-    to: "/my-first-api",
-  },
-  {
-    type: "link",
-    label: "My Second API",
-    to: "/my-second-api",
-  },
-] as const;
-```
-
-### Step 3: Update your config
-
-Modify your [APIToGo Configuration](../configuration/overview.md) file to include these arrays:
-
-```typescript
-import type { ApitogoConfig } from "@lukoweb/apitogo";
-
-const config: ApitogoConfig = {
-  navigation: [
-    {
-      type: "category",
-      label: "Overview",
-      items: navigation,
-    },
-  ],
-  redirects: [{ from: "/", to: "/overview" }],
-  apis,
-  docs: {
-    files: "/pages/**/*.{md,mdx}",
-  },
-};
-
-export default config;
-```
-
-Make sure that:
-
-1. The `path` in each API config matches the `href` in the navigation
-2. Your OpenAPI files are placed in the correct location as specified in the `input` field
-3. The `label` in navigation matches what you want to display in the sidebar
-
-You don't necessarily need to add the APIs to your sidebar, you can also put them into the top
-navigation or link to them from your docs.
+---
+title: Multiple APIs
+sidebar_icon: file-stack
+---
+
+APIToGo supports creating documentation and API references for multiple APIs and can work with as
+many OpenAPI documents as you need.
+
+In order to do this you will need to modify the
+[APIToGo Configuration](../configuration/overview.md) file to include additional APIs.
+
+## Configuration
+
+Using multiple APIs is a configuration setting that you can add in the
+[APIToGo Configuration](../configuration/overview.md) file.
+
+### Step 1: Add your APIs
+
+First, create a new array in your configuration file that lists each API you want to include:
+
+```typescript
+const apis = [
+  {
+    type: "file",
+    input: "apis/my-first-api.json",
+    path: "/my-first-api",
+  },
+  {
+    type: "file",
+    input: "apis/my-second-api.json",
+    path: "/my-second-api",
+  },
+] as const;
+```
+
+### Step 2: Add navigation
+
+Create a navigation array for your sidebar:
+
+```typescript
+const navigation = [
+  {
+    type: "link",
+    label: "My First API",
+    to: "/my-first-api",
+  },
+  {
+    type: "link",
+    label: "My Second API",
+    to: "/my-second-api",
+  },
+] as const;
+```
+
+### Step 3: Update your config
+
+Modify your [APIToGo Configuration](../configuration/overview.md) file to include these arrays:
+
+```typescript
+import type { ApitogoConfig } from "@lukoweb/apitogo";
+
+const config: ApitogoConfig = {
+  navigation: [
+    {
+      type: "category",
+      label: "Overview",
+      items: navigation,
+    },
+  ],
+  redirects: [{ from: "/", to: "/overview" }],
+  apis,
+  docs: {
+    files: "/pages/**/*.{md,mdx}",
+  },
+};
+
+export default config;
+```
+
+Make sure that:
+
+1. The `path` in each API config matches the `href` in the navigation
+2. Your OpenAPI files are placed in the correct location as specified in the `input` field
+3. The `label` in navigation matches what you want to display in the sidebar
+
+You don't necessarily need to add the APIs to your sidebar, you can also put them into the top
+navigation or link to them from your docs.