@clidey/dory 1.0.8 → 1.9.0

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: 'Create a new product'
+description: 'Create a new product'
+openapi: 'POST /products'
+---

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

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

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

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

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

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

package/docs/api-reference/websocket-operations/receive-chat-message.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Receive chat messages'
+description: 'Subscribe to receive chat messages from other users'
+asyncapi: 'subscribe /chat'
+---

package/docs/api-reference/websocket-operations/receive-notifications.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Receive notifications'
+description: 'Subscribe to receive system notifications'
+asyncapi: 'subscribe /notifications'
+---

package/docs/api-reference/websocket-operations/receive-presence-update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Receive presence updates'
+description: 'Subscribe to receive user presence updates'
+asyncapi: 'subscribe /presence'
+---

package/docs/api-reference/websocket-operations/send-chat-message.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Send chat message'
+description: 'Send a chat message to other users'
+asyncapi: 'publish /chat'
+---

package/docs/api-reference/websocket-operations/send-presence-update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Send presence update'
+description: 'Send a presence update'
+asyncapi: 'publish /presence'
+---

package/docs/components/accordion.mdx

@@ -0,0 +1,145 @@
+---
+title: 'Accordion'
+description: 'Collapsible content sections with optional icons, grouped together with AccordionGroup.'
+---
+
+# Accordion
+
+Accordions hide content until the user expands it — ideal for FAQs, optional details, or long reference sections.
+
+## Basic Usage
+
+<Specimen label="&lt;AccordionGroup&gt; &lt;Accordion&gt;">
+
+```mdx
+<AccordionGroup>
+  <Accordion title="What is Dory?">
+    Dory is a static site generator for technical documentation.
+    It turns MDX files and a dory.json config into a fast, beautiful docs site.
+  </Accordion>
+</AccordionGroup>
+```
+
+<AccordionGroup>
+  <Accordion title="What is Dory?">
+    Dory is a static site generator for technical documentation.
+    It turns MDX files and a `dory.json` config into a fast, beautiful docs site.
+  </Accordion>
+</AccordionGroup>
+
+</Specimen>
+
+## Multiple Items
+
+Only one accordion can be open at a time.
+
+<Specimen label="&lt;AccordionGroup&gt; &lt;Accordion&gt;">
+
+```mdx
+<AccordionGroup>
+  <Accordion title="How do I install Dory?">
+    Install globally with npm: `npm install -g @clidey/dory`
+  </Accordion>
+  <Accordion title="Which languages are supported?">
+    Dory supports 20+ languages: Python, TypeScript, Go, Rust, Java, Ruby, PHP, and more.
+  </Accordion>
+  <Accordion title="Can I deploy to GitHub Pages?">
+    Yes. Run `dory build` and upload the `dist/` directory to your GitHub Pages branch.
+  </Accordion>
+  <Accordion title="Does Dory support dark mode?">
+    Yes. Dory follows the user's OS preference automatically.
+    You can set custom colors for each mode in `dory.json`.
+  </Accordion>
+</AccordionGroup>
+```
+
+<AccordionGroup>
+  <Accordion title="How do I install Dory?">
+    Install globally with npm: `npm install -g @clidey/dory`
+  </Accordion>
+  <Accordion title="Which languages are supported?">
+    Dory supports 20+ languages: Python, TypeScript, Go, Rust, Java, Ruby, PHP, and more.
+  </Accordion>
+  <Accordion title="Can I deploy to GitHub Pages?">
+    Yes. Run `dory build` and upload the `dist/` directory to your GitHub Pages branch.
+  </Accordion>
+  <Accordion title="Does Dory support dark mode?">
+    Yes. Dory follows the user's OS preference automatically.
+    You can set custom colors for each mode in `dory.json`.
+  </Accordion>
+</AccordionGroup>
+
+</Specimen>
+
+## With Icons
+
+Add an `icon` prop using a Clidey Design icon name:
+
+<Specimen label="&lt;AccordionGroup&gt; &lt;Accordion&gt;">
+
+```mdx
+<AccordionGroup>
+  <Accordion title="Authentication" icon="lock">
+    All API requests require a Bearer token in the Authorization header.
+  </Accordion>
+  <Accordion title="Rate Limiting" icon="gauge">
+    The default limit is 1000 requests per hour per API key.
+  </Accordion>
+  <Accordion title="Error Handling" icon="alert-triangle">
+    All errors return a consistent JSON body with an error code and message.
+  </Accordion>
+</AccordionGroup>
+```
+
+<AccordionGroup>
+  <Accordion title="Authentication" icon="lock">
+    All API requests require a Bearer token in the `Authorization` header.
+  </Accordion>
+  <Accordion title="Rate Limiting" icon="gauge">
+    The default limit is 1000 requests per hour per API key. Exceeding this returns a `429 Too Many Requests` response.
+  </Accordion>
+  <Accordion title="Error Handling" icon="alert-triangle">
+    All errors return a consistent JSON body with an `error` code and `message` field.
+  </Accordion>
+</AccordionGroup>
+
+</Specimen>
+
+## Numbered Rows
+
+Add `numbered` to an `AccordionGroup` for reference lists readers scan by position.
+
+<Specimen label="&lt;AccordionGroup numbered&gt;">
+
+```mdx
+<AccordionGroup numbered>
+  <Accordion title="Database Connectivity">Connect to any supported engine.</Accordion>
+  <Accordion title="Schema Explorer">Browse tables, columns and keys.</Accordion>
+  <Accordion title="Interactive Data Grid">Edit rows inline.</Accordion>
+</AccordionGroup>
+```
+
+<AccordionGroup numbered>
+  <Accordion title="Database Connectivity">Connect to any supported engine.</Accordion>
+  <Accordion title="Schema Explorer">Browse tables, columns and keys.</Accordion>
+  <Accordion title="Interactive Data Grid">Edit rows inline.</Accordion>
+</AccordionGroup>
+
+</Specimen>
+
+## Props Reference
+
+### AccordionGroup Props
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `children` | `ReactNode` | One or more `Accordion` components. |
+| `numbered` | `boolean` | Label rows 01, 02, 03 in order. |
+
+### Accordion Props
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `title` | `string` | Heading text shown when collapsed. |
+| `icon` | `string` | Optional Clidey Design icon name (e.g. `"lock"`, `"gauge"`). |
+| `children` | `ReactNode` | Content revealed when expanded. Supports full MDX. |