@clidey/dory 0.1.0 → 0.2.0

package/README.md

@@ -43,7 +43,7 @@ Dory is:
 Install Dory globally to use the CLI tool:
 
 ```bash
-npm install -g dory
+npm install -g @clidey/dory
 ```
 
 ### CLI Usage

package/docs/api-playground-demo.mdx

@@ -0,0 +1,119 @@
+---
+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/docs/api-reference/openapi.json

@@ -0,0 +1,366 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Products API",
+    "version": "1.0.0",
+    "description": "API for managing products"
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com/v1",
+      "description": "Production server"
+    }
+  ],
+  "components": {
+    "securitySchemes": {
+      "ApiKeyAuth": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-API-Key"
+      }
+    },
+    "schemas": {
+      "Product": {
+        "type": "object",
+        "required": ["name", "price", "category"],
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Unique identifier for the product"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the product"
+          },
+          "description": {
+            "type": "string",
+            "description": "Detailed description of the product"
+          },
+          "price": {
+            "type": "number",
+            "format": "float",
+            "minimum": 0,
+            "description": "Price of the product"
+          },
+          "category": {
+            "type": "string",
+            "description": "Category of the product"
+          },
+          "inStock": {
+            "type": "boolean",
+            "default": true,
+            "description": "Whether the product is in stock"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Creation timestamp"
+          },
+          "updatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Last update timestamp"
+          }
+        }
+      },
+      "Error": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Error code"
+          },
+          "message": {
+            "type": "string",
+            "description": "Error message"
+          }
+        }
+      }
+    }
+  },
+  "paths": {
+    "/products": {
+      "get": {
+        "summary": "List all products",
+        "description": "Retrieve a paginated list of products",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Page number",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 1,
+              "minimum": 1
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of items per page",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 10,
+              "minimum": 1,
+              "maximum": 100
+            }
+          },
+          {
+            "name": "category",
+            "in": "query",
+            "description": "Filter by category",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Product"
+                      }
+                    },
+                    "total": {
+                      "type": "integer"
+                    },
+                    "page": {
+                      "type": "integer"
+                    },
+                    "limit": {
+                      "type": "integer"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a new product",
+        "description": "Create a new product with the provided details",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": ["name", "price", "category"],
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "price": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "category": {
+                    "type": "string"
+                  },
+                  "inStock": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Product created successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid input",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/products/{id}": {
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "description": "Product ID"
+        }
+      ],
+      "get": {
+        "summary": "Get product by ID",
+        "description": "Retrieve a specific product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "summary": "Update product",
+        "description": "Update an existing product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "price": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "category": {
+                    "type": "string"
+                  },
+                  "inStock": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Product updated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete product",
+        "description": "Delete a product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Product deleted successfully"
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/docs/api-reference/operations/create.mdx

@@ -0,0 +1,5 @@
+---
+title: 'POST /products'
+description: 'Create a new product'
+openapi: 'POST /products'
+---

package/docs/api-reference/operations/delete.mdx

@@ -0,0 +1,5 @@
+---
+title: 'DELETE /products/{id}'
+description: 'Delete a product'
+openapi: 'DELETE /products/{id}'
+---

package/docs/api-reference/operations/get.mdx

@@ -0,0 +1,5 @@
+---
+title: 'GET /products'
+description: 'Get a list of products'
+openapi: 'GET /products'
+---

package/docs/api-reference/operations/update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'PUT /products/{id}'
+description: 'Update a product'
+openapi: 'PUT /products/{id}'
+---

package/docs/dory.json

@@ -1,154 +1,35 @@
 {
   "name": "Docucod",
-  "colors": {
-    "primary": "#60A5FA",
-    "light": "#60A5FA",
-    "dark": "#1E3A8A"
-  },
-  "favicon": "/favicon.svg",
-  "styling": {
-    "eyebrows": "breadcrumbs",
-    "codeblocks": "dark"
-  },
-  "icons": {
-    "library": "fontawesome"
-  },
+  "favicon": "./favicon.svg",
   "fonts": {
     "family": "Montserrat",
     "source": "https://fonts.gstatic.com/s/googlesansflex/v5/t5sJIQcYNIWbFgDgAAzZ34auoVyXkJCOvp3SFWJbN5hF8Ju1x6sKCyp0l9sI40swNJwGpVd4AZzz0v6lJ4qFXNZhGjLvDSkV4USKMo6qQzwliVdHAy9jxTDHg_ugnAakpwGc-cxgUqDCIUI.woff2",
     "format": "woff2"
   },
-  "background": {
-    "decoration": "gradient"
-  },
   "navigation": {
     "tabs": [
       {
-        "tab": "Overview",
-        "groups": [
-          {
-            "group": "Developer Overview",
-            "pages": [
-              "overview/developer-overview/dev-architecture"
-            ]
-          },
-          {
-            "group": "Product Intro",
-            "pages": [
-              "overview/product-intro/app-overview",
-              "overview/product-intro/architecture",
-              "overview/product-intro/core-concepts"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Configuration",
+        "tab": "Documentation",
         "groups": [
           {
-            "group": "App Settings",
+            "group": "Getting Started",
             "pages": [
-              "configuration/app-settings/feature-flags",
-              "configuration/app-settings/user-settings"
+              "introduction"
             ]
           },
           {
-            "group": "Installation Setup",
-            "pages": [
-              "configuration/installation-setup/env-vars",
-              "configuration/installation-setup/installation"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Usage",
-        "groups": [
-          {
-            "group": "API Usage",
-            "pages": [
-              "usage/api-usage/api-inventory",
-              "usage/api-usage/api-products",
-              "usage/api-usage/api-purchase-orders",
-              "usage/api-usage/api-reports",
-              "usage/api-usage/api-suppliers",
-              "usage/api-usage/api-user-management"
-            ]
-          },
-          {
-            "group": "UI Workflows",
-            "pages": [
-              "usage/ui-workflows/bundles",
-              "usage/ui-workflows/demand-planning",
-              "usage/ui-workflows/favorites",
-              "usage/ui-workflows/inventory-management",
-              "usage/ui-workflows/onboarding",
-              "usage/ui-workflows/purchase-orders",
-              "usage/ui-workflows/reports"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Integrations",
-        "groups": [
-          {
-            "group": "Analytics Monitoring",
-            "pages": [
-              "integrations/analytics-monitoring/error-tracking",
-              "integrations/analytics-monitoring/notifications",
-              "integrations/analytics-monitoring/user-analytics"
-            ]
-          },
-          {
-            "group": "Shopify Integration",
-            "pages": [
-              "integrations/shopify-integration/shopify-setup",
-              "integrations/shopify-integration/shopify-webhooks"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Platform Admin",
-        "groups": [
-          {
-            "group": "Billing Subscriptions",
-            "pages": [
-              "platform-admin/billing-subscriptions/billing"
-            ]
-          },
-          {
-            "group": "System Maintenance",
-            "pages": [
-              "platform-admin/system-maintenance/db-migrations",
-              "platform-admin/system-maintenance/health-monitoring",
-              "platform-admin/system-maintenance/queue-management"
-            ]
-          },
-          {
-            "group": "User Team Management",
-            "pages": [
-              "platform-admin/user-team-management/teams",
-              "platform-admin/user-team-management/users"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Support",
-        "groups": [
-          {
-            "group": "Legal",
+            "group": "Features",
             "pages": [
-              "support/legal/dependency-analysis",
-              "support/legal/privacy-terms"
+              "features"
             ]
           },
           {
-            "group": "Troubleshooting",
+            "group": "API Reference",
             "pages": [
-              "support/troubleshooting/common-issues"
+              "api-reference/operations/create",
+              "api-reference/operations/get",
+              "api-reference/operations/update",
+              "api-reference/operations/delete"
             ]
           }
         ]
@@ -159,4 +40,4 @@
     "light": "./logo/logo.png",
     "dark": "./logo/logo.png"
   }
-}
+}