@clidey/dory 0.23.0 → 0.27.0

package/src/plugins/docs-assets.ts

@@ -0,0 +1,79 @@
+import type { Plugin } from 'vite';
+import { cpSync, existsSync, readdirSync, statSync } from 'fs';
+import { resolve, extname } from 'path';
+
+/**
+ * Plugin to copy docs assets to the build output
+ * Since we can't use publicDir for docs (we need to import from it),
+ * this plugin manually copies asset files during build
+ */
+export function docsAssetsPlugin(): Plugin {
+  return {
+    name: 'docs-assets',
+    apply: 'build', // Only run during build
+    closeBundle() {
+      const docsDir = resolve(process.cwd(), 'docs');
+      const outDir = resolve(process.cwd(), 'dist');
+
+      if (!existsSync(docsDir)) {
+        console.warn('[docs-assets] docs directory not found, skipping asset copy');
+        return;
+      }
+
+      // Define asset extensions to copy
+      const assetExtensions = new Set([
+        '.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp', '.ico',
+        '.pdf', '.mp4', '.webm', '.mp3', '.wav',
+        '.woff', '.woff2', '.ttf', '.eot',
+      ]);
+
+      // Define file/folder patterns to skip
+      const skipPatterns = new Set([
+        'dory.json',
+        'node_modules',
+        '.DS_Store',
+      ]);
+
+      const shouldSkip = (name: string) => {
+        if (skipPatterns.has(name)) return true;
+        const ext = extname(name).toLowerCase();
+        // Skip MDX and JSON files (they're processed by Vite)
+        if (ext === '.mdx' || ext === '.md' || ext === '.json') return true;
+        return false;
+      };
+
+      const copyAssets = (srcDir: string, destDir: string, relativePath: string = '') => {
+        const items = readdirSync(srcDir);
+
+        for (const item of items) {
+          if (shouldSkip(item)) continue;
+
+          const srcPath = resolve(srcDir, item);
+          const destPath = resolve(destDir, item);
+          const itemRelativePath = relativePath ? `${relativePath}/${item}` : item;
+
+          try {
+            const stats = statSync(srcPath);
+
+            if (stats.isDirectory()) {
+              // Recursively copy directories
+              copyAssets(srcPath, destPath, itemRelativePath);
+            } else if (stats.isFile()) {
+              const ext = extname(item).toLowerCase();
+              // Copy if it's an asset file
+              if (assetExtensions.has(ext)) {
+                cpSync(srcPath, destPath, { force: true });
+                console.log(`[docs-assets] Copied ${itemRelativePath}`);
+              }
+            }
+          } catch (error) {
+            console.warn(`[docs-assets] Failed to copy ${itemRelativePath}:`, error);
+          }
+        }
+      };
+
+      console.log('[docs-assets] Copying assets from docs to dist...');
+      copyAssets(docsDir, outDir);
+    },
+  };
+}

package/src/theme.scss

@@ -21,6 +21,8 @@
     // Using light color for light mode
     --primary: var(--brand-light);
     --primary-rgb: var(--brand-light-rgb);
+    
+    --ring: rgba(0, 0, 0, 0.1);
 }
 
 // Dark mode overrides
@@ -28,6 +30,8 @@
     // Use dark color for dark mode
     --primary: var(--brand-dark);
     --primary-rgb: var(--brand-dark-rgb);
+
+    --ring: rgba(255, 255, 255, 0.1);
 }
   
 article h2:first-of-type {
@@ -45,7 +49,7 @@ article img {
 
 [data-testid="header-actions"] button,
 [data-slot="dropdown-menu-content"] {
-    border-color: rgba(0, 0, 0, 0.1);
+    border-color: var(--ring);
 }
 
 [data-slot="search-input-wrapper"] {

package/src/ui/header.tsx

@@ -2,7 +2,7 @@ import classNames from 'classnames';
 import { useEffect, useMemo, useState } from 'preact/hooks';
 import { Link } from 'wouter-preact';
 import { usePathname } from 'wouter-preact/use-browser-location';
-import docsConfig from '../../docs/dory.json';
+import docsConfig from '../../docs/dory.json' with { type: 'json' };
 import type { DoryConfig } from '../types/config';
 import { MobileSearch, Search } from '../components/search';
 import { ALL_NAVIGATION } from '../components/store';

package/src/ui/table-of-content.tsx

@@ -114,7 +114,7 @@ export function TableOfContents() {
   }
 
   return (
-    <div className="hidden xl:sticky xl:top-[4.75rem] xl:-mr-6 xl:block xl:h-[calc(100vh-4.75rem)] xl:flex-none xl:overflow-y-auto xl:py-16 xl:pr-6 pl-4">
+    <div className="hidden xl:sticky xl:top-[4.75rem] xl:-mr-6 xl:block xl:h-[calc(100vh-4.75rem)] xl:flex-none xl:overflow-y-auto xl:py-16 xl:pr-6 pl-8">
       <nav aria-labelledby="on-this-page-title" className="w-56">
         {sections.length > 0 && (
           <>

package/src/utils/colors.ts

@@ -1,4 +1,4 @@
-import docsConfig from '../../docs/dory.json';
+import docsConfig from '../../docs/dory.json' with { type: 'json' };
 import type { DoryConfig } from '../types/config';
 
 const config = docsConfig as DoryConfig;

package/src/utils/fonts.ts

@@ -1,4 +1,4 @@
-import docsConfig from '../../docs/dory.json';
+import docsConfig from '../../docs/dory.json' with { type: 'json' };
 import type { DoryConfig } from '../types/config';
 
 const config = docsConfig as DoryConfig;

package/tsconfig.app.json

@@ -28,5 +28,6 @@
     "noFallthroughCasesInSwitch": true,
     "noUncheckedSideEffectImports": true
   },
-  "include": ["src"]
+  "include": ["src"],
+  "exclude": ["src/plugins"]
 }

package/tsconfig.bin.json

@@ -4,17 +4,21 @@
     "lib": ["ES2023"],
     "module": "ESNext",
     "moduleResolution": "node",
-    "allowImportingTsExtensions": true,
     "skipLibCheck": true,
-    "strict": false,
+    "strict": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    "noEmit": true,
-    "noImplicitAny": false,
-    "noImplicitReturns": false,
-    "noImplicitThis": false
+    "noEmit": false,
+    "outDir": "./bin/dist",
+    "rootDir": "./bin",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
   },
   "include": [
-    "bin/dory.ts"
+    "bin/**/*.ts"
+  ],
+  "exclude": [
+    "bin/dist"
   ]
 }

package/tsconfig.node.json

@@ -5,6 +5,7 @@
     "lib": ["ES2023"],
     "module": "ESNext",
     "skipLibCheck": true,
+    "types": ["node"],
 
     /* Bundler mode */
     "moduleResolution": "bundler",
@@ -21,5 +22,5 @@
     "noFallthroughCasesInSwitch": true,
     "noUncheckedSideEffectImports": true
   },
-  "include": ["vite.config.ts"]
+  "include": ["vite.config.ts", "src/plugins/**/*.ts", "bin/**/*.ts"]
 }

package/vite.config.ts

@@ -7,6 +7,7 @@ import { llmTxtGenerator } from './src/plugins/llm-txt-generator';
 import { llmTxtDevServer } from './src/plugins/llm-txt-dev-server';
 import { frontmatterGenerator } from './src/plugins/frontmatter-generator';
 import { frontmatterDevServer } from './src/plugins/frontmatter-dev-server';
+import { docsAssetsPlugin } from './src/plugins/docs-assets';
 import { getMdxConfig } from './src/config/mdx';
 
 export default defineConfig(({ command }) => ({
@@ -20,6 +21,7 @@ export default defineConfig(({ command }) => ({
     llmTxtDevServer(),
     frontmatterGenerator(),
     frontmatterDevServer(),
+    docsAssetsPlugin(),
   ],
   resolve: {
     alias: {
@@ -27,10 +29,13 @@ export default defineConfig(({ command }) => ({
       'react-dom': 'preact/compat'
     }
   },
-  publicDir: "docs",
+  publicDir: false, // Don't use a public directory since we need to import from docs
   server: {
     allowedHosts: true,
     port: 3000,
     strictPort: false,
   },
+  json: {
+    stringify: false
+  },
 }));

package/dist/api-playground-demo.mdx

@@ -1,119 +0,0 @@
----
-title: 'API Playground Demo'
-description: 'Interactive API playground for testing HTTP endpoints'
-openapi: 'POST /plants'
----
-
-# API Playground Demo
-
-This page demonstrates the new HTTP API playground that allows you to test API endpoints directly from the documentation.
-
-## Basic GET Request
-
-Test a simple GET request with query parameters:
-
-<APIPlayground
-  method="GET"
-  url="/api/users"
-  title="Get Users"
-  description="Retrieve a list of users with optional filtering"
-  parameters={[
-    {
-      name: "page",
-      type: "number",
-      description: "Page number for pagination",
-      defaultValue: "1"
-    },
-    {
-      name: "limit",
-      type: "number", 
-      description: "Number of items per page",
-      defaultValue: "10"
-    },
-    {
-      name: "search",
-      type: "string",
-      description: "Search term to filter users"
-    }
-  ]}
-  baseUrl="https://jsonplaceholder.typicode.com"
-/>
-
-## POST Request with Body
-
-Test a POST request with a JSON body:
-
-<APIPlayground
-  method="POST"
-  url="/api/users"
-  title="Create User"
-  description="Create a new user account"
-  parameters={[]}
-  body={{
-    "name": "John Doe",
-    "email": "john@example.com",
-    "username": "johndoe"
-  }}
-  headers={{
-    "Content-Type": "application/json"
-  }}
-  authType="bearer"
-  baseUrl="https://jsonplaceholder.typicode.com"
-/>
-
-## Authenticated Endpoint
-
-Test an endpoint that requires authentication:
-
-<APIPlayground
-  method="GET"
-  url="/api/profile/{userId}"
-  title="Get User Profile"
-  description="Get detailed profile information for a specific user"
-  parameters={[
-    {
-      name: "userId",
-      type: "string",
-      required: true,
-      description: "The ID of the user to retrieve"
-    }
-  ]}
-  authType="bearer"
-  baseUrl="https://jsonplaceholder.typicode.com"
-/>
-
-## Features
-
-The API playground provides:
-
-- **Interactive Request Configuration**: Set parameters, headers, request body, and authentication
-- **Multiple Auth Types**: Support for Bearer token, API key, and Basic authentication
-- **Real-time Response**: See actual HTTP responses with status codes, headers, and formatted JSON
-- **Request Timing**: Monitor request duration for performance analysis
-- **Error Handling**: Clear error messages for failed requests
-- **Copy-Paste Ready**: Generate curl commands and code examples
-
-## Usage in Documentation
-
-To add a playground to your API documentation, use the `APIPlayground` component:
-
-```mdx
-<APIPlayground
-  method="GET"
-  url="/api/endpoint"
-  title="Endpoint Title"
-  description="Description of what this endpoint does"
-  parameters={[
-    {
-      name: "param1",
-      type: "string",
-      required: true,
-      description: "Parameter description"
-    }
-  ]}
-  authType="bearer"
-  baseUrl="https://api.example.com"
-/>
-```
-
-The playground seamlessly integrates with your existing API documentation and provides a Postman-like experience directly in the docs.

package/dist/api-reference/asyncapi.json

@@ -1,324 +0,0 @@
-{
-  "asyncapi": "3.0.0",
-  "info": {
-    "title": "Chat WebSocket API",
-    "version": "1.0.0",
-    "description": "Real-time chat API using WebSocket for bidirectional communication"
-  },
-  "servers": {
-    "development": {
-      "host": "localhost:8080",
-      "pathname": "/ws",
-      "protocol": "ws",
-      "description": "Development WebSocket server"
-    },
-    "production": {
-      "host": "api.example.com",
-      "pathname": "/ws",
-      "protocol": "wss",
-      "description": "Production WebSocket server"
-    }
-  },
-  "channels": {
-    "/chat": {
-      "address": "/chat",
-      "title": "Chat Channel",
-      "description": "Channel for sending and receiving chat messages",
-      "subscribe": {
-        "operationId": "receiveChatMessage",
-        "summary": "Receive chat messages",
-        "description": "Subscribe to receive chat messages from other users",
-        "message": {
-          "$ref": "#/components/messages/ChatMessage"
-        }
-      },
-      "publish": {
-        "operationId": "sendChatMessage",
-        "summary": "Send chat message",
-        "description": "Send a chat message to other users",
-        "message": {
-          "$ref": "#/components/messages/ChatMessage"
-        }
-      }
-    },
-    "/notifications": {
-      "address": "/notifications",
-      "title": "Notifications Channel",
-      "description": "Channel for receiving system notifications",
-      "subscribe": {
-        "operationId": "receiveNotification",
-        "summary": "Receive notifications",
-        "description": "Subscribe to receive system notifications",
-        "message": {
-          "$ref": "#/components/messages/Notification"
-        }
-      }
-    },
-    "/presence": {
-      "address": "/presence",
-      "title": "Presence Channel",
-      "description": "Channel for user presence updates",
-      "subscribe": {
-        "operationId": "receivePresenceUpdate",
-        "summary": "Receive presence updates",
-        "description": "Subscribe to receive user presence updates",
-        "message": {
-          "$ref": "#/components/messages/PresenceUpdate"
-        }
-      },
-      "publish": {
-        "operationId": "sendPresenceUpdate",
-        "summary": "Send presence update",
-        "description": "Send a presence update",
-        "message": {
-          "$ref": "#/components/messages/PresenceUpdate"
-        }
-      }
-    }
-  },
-  "components": {
-    "messages": {
-      "ChatMessage": {
-        "name": "ChatMessage",
-        "title": "Chat Message",
-        "summary": "Message sent in a chat conversation",
-        "description": "A message sent by a user in a chat conversation",
-        "contentType": "application/json",
-        "payload": {
-          "$ref": "#/components/schemas/ChatMessagePayload"
-        },
-        "headers": {
-          "$ref": "#/components/schemas/MessageHeaders"
-        },
-        "examples": [
-          {
-            "id": "msg_123",
-            "type": "message",
-            "content": "Hello, how are you?",
-            "userId": "user_456",
-            "username": "john_doe",
-            "timestamp": "2024-01-15T10:30:00Z",
-            "channel": "general"
-          }
-        ]
-      },
-      "Notification": {
-        "name": "Notification",
-        "title": "System Notification",
-        "summary": "System-generated notification",
-        "description": "A notification sent by the system to inform users about events",
-        "contentType": "application/json",
-        "payload": {
-          "$ref": "#/components/schemas/NotificationPayload"
-        },
-        "headers": {
-          "$ref": "#/components/schemas/MessageHeaders"
-        },
-        "examples": [
-          {
-            "id": "notif_789",
-            "type": "notification",
-            "title": "New Message",
-            "message": "You have a new message from Alice",
-            "level": "info",
-            "timestamp": "2024-01-15T10:35:00Z",
-            "userId": "user_456"
-          }
-        ]
-      },
-      "PresenceUpdate": {
-        "name": "PresenceUpdate",
-        "title": "Presence Update",
-        "summary": "User presence status update",
-        "description": "Update about a user's presence status (online, offline, away)",
-        "contentType": "application/json",
-        "payload": {
-          "$ref": "#/components/schemas/PresenceUpdatePayload"
-        },
-        "headers": {
-          "$ref": "#/components/schemas/MessageHeaders"
-        },
-        "examples": [
-          {
-            "id": "presence_101",
-            "type": "presence",
-            "userId": "user_456",
-            "username": "john_doe",
-            "status": "online",
-            "lastSeen": "2024-01-15T10:40:00Z",
-            "timestamp": "2024-01-15T10:40:00Z"
-          }
-        ]
-      }
-    },
-    "schemas": {
-      "ChatMessagePayload": {
-        "type": "object",
-        "required": ["id", "type", "content", "userId", "username", "timestamp"],
-        "properties": {
-          "id": {
-            "type": "string",
-            "description": "Unique identifier for the message",
-            "example": "msg_123"
-          },
-          "type": {
-            "type": "string",
-            "enum": ["message"],
-            "description": "Message type identifier",
-            "example": "message"
-          },
-          "content": {
-            "type": "string",
-            "description": "The message content",
-            "example": "Hello, how are you?"
-          },
-          "userId": {
-            "type": "string",
-            "description": "ID of the user who sent the message",
-            "example": "user_456"
-          },
-          "username": {
-            "type": "string",
-            "description": "Username of the sender",
-            "example": "john_doe"
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time",
-            "description": "When the message was sent",
-            "example": "2024-01-15T10:30:00Z"
-          },
-          "channel": {
-            "type": "string",
-            "description": "Channel where the message was sent",
-            "example": "general"
-          },
-          "replyTo": {
-            "type": "string",
-            "description": "ID of the message this is replying to",
-            "example": "msg_122"
-          }
-        }
-      },
-      "NotificationPayload": {
-        "type": "object",
-        "required": ["id", "type", "title", "message", "timestamp"],
-        "properties": {
-          "id": {
-            "type": "string",
-            "description": "Unique identifier for the notification",
-            "example": "notif_789"
-          },
-          "type": {
-            "type": "string",
-            "enum": ["notification"],
-            "description": "Message type identifier",
-            "example": "notification"
-          },
-          "title": {
-            "type": "string",
-            "description": "Notification title",
-            "example": "New Message"
-          },
-          "message": {
-            "type": "string",
-            "description": "Notification message content",
-            "example": "You have a new message from Alice"
-          },
-          "level": {
-            "type": "string",
-            "enum": ["info", "warning", "error", "success"],
-            "description": "Notification level",
-            "example": "info"
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time",
-            "description": "When the notification was created",
-            "example": "2024-01-15T10:35:00Z"
-          },
-          "userId": {
-            "type": "string",
-            "description": "ID of the user receiving the notification",
-            "example": "user_456"
-          },
-          "actionUrl": {
-            "type": "string",
-            "description": "URL to navigate to when notification is clicked",
-            "example": "/chat/general"
-          }
-        }
-      },
-      "PresenceUpdatePayload": {
-        "type": "object",
-        "required": ["id", "type", "userId", "username", "status", "timestamp"],
-        "properties": {
-          "id": {
-            "type": "string",
-            "description": "Unique identifier for the presence update",
-            "example": "presence_101"
-          },
-          "type": {
-            "type": "string",
-            "enum": ["presence"],
-            "description": "Message type identifier",
-            "example": "presence"
-          },
-          "userId": {
-            "type": "string",
-            "description": "ID of the user whose presence is being updated",
-            "example": "user_456"
-          },
-          "username": {
-            "type": "string",
-            "description": "Username of the user",
-            "example": "john_doe"
-          },
-          "status": {
-            "type": "string",
-            "enum": ["online", "offline", "away", "busy"],
-            "description": "User's presence status",
-            "example": "online"
-          },
-          "lastSeen": {
-            "type": "string",
-            "format": "date-time",
-            "description": "When the user was last seen",
-            "example": "2024-01-15T10:40:00Z"
-          },
-          "timestamp": {
-            "type": "string",
-            "format": "date-time",
-            "description": "When the presence update was sent",
-            "example": "2024-01-15T10:40:00Z"
-          }
-        }
-      },
-      "MessageHeaders": {
-        "type": "object",
-        "properties": {
-          "correlation-id": {
-            "type": "string",
-            "description": "Correlation ID for request tracking",
-            "example": "corr_123"
-          },
-          "user-id": {
-            "type": "string",
-            "description": "ID of the user sending the message",
-            "example": "user_456"
-          },
-          "session-id": {
-            "type": "string",
-            "description": "Session ID for the connection",
-            "example": "sess_789"
-          },
-          "client-version": {
-            "type": "string",
-            "description": "Version of the client application",
-            "example": "1.0.0"
-          }
-        }
-      }
-    }
-  }
-}