create-zuplo-api 6.60.21 → 6.60.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-zuplo-api",
-  "version": "6.60.21",
+  "version": "6.60.22",
   "keywords": [
     "api",
     "openapi",
@@ -35,7 +35,7 @@
     "@types/prompts": "2.4.9",
     "@types/tar": "^6.1.13",
     "@types/validate-npm-package-name": "4.0.2",
-    "@vercel/ncc": "0.38.2",
+    "@vercel/ncc": "0.38.4",
     "async-retry": "1.3.3",
     "ci-info": "4.0.0",
     "commander": "12.1.0",
@@ -44,11 +44,11 @@
     "fast-glob": "^3.3.2",
     "picocolors": "1.1.0",
     "prompts": "2.4.2",
+    "rimraf": "^5.0.5",
     "semver": "^7.6.3",
     "tar": "^7.4.3",
     "update-check": "1.5.4",
-    "validate-npm-package-name": "6.0.0",
-    "rimraf": "^5.0.5"
+    "validate-npm-package-name": "6.0.0"
   },
   "engines": {
     "node": ">=20"

package/dist/templates/default/README-template.md

@@ -1,29 +0,0 @@
-## Zuplo API
-
-This is a Zuplo API that was created with
-[`create-zuplo-api`](https://zuplo.com/docs).
-
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
-
-Open [http://localhost:9000](http://localhost:9000) with your browser to see the
-result.
-
-You can start editing the API by modifying `config/routes.oas.json`. The dev
-server will automatically reload the API with your changes.
-
-## Learn More
-
-To learn more about Zuplo, you can visit the
-[Zuplo documentation](https://zuplo.com/docs).
-
-To connect with the community join [Discord](https://discord.zuplo.com).

package/dist/templates/default/config/policies.json

@@ -1,13 +0,0 @@
-{
-  "policies": [
-    {
-      "handler": {
-        "export": "MockApiInboundPolicy",
-        "module": "$import(@zuplo/runtime)",
-        "options": {}
-      },
-      "name": "mock-api-inbound",
-      "policyType": "mock-api-inbound"
-    }
-  ]
-}

package/dist/templates/default/config/routes.oas.json

@@ -1,284 +0,0 @@
-{
-  "openapi": "3.1.0",
-  "info": {
-    "version": "1.0.0",
-    "title": "My Zuplo API"
-  },
-  "paths": {
-    "/todos": {
-      "get": {
-        "summary": "Get all todos",
-        "description": "**Retrieves a complete list of all todo items** from the system. This endpoint returns all todos regardless of their completion status or owner, making it useful for displaying comprehensive todo lists or performing bulk operations.",
-        "responses": {
-          "200": {
-            "description": "A list of todos",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/Todo"
-                  }
-                },
-                "examples": {
-                  "mixed_todos": {
-                    "summary": "A list of todos with different completion states",
-                    "value": [
-                      {
-                        "id": 1,
-                        "title": "Buy groceries",
-                        "completed": false,
-                        "userId": 123
-                      },
-                      {
-                        "id": 2,
-                        "title": "Write documentation",
-                        "completed": true,
-                        "userId": 456
-                      },
-                      {
-                        "id": 3,
-                        "title": "Review pull requests",
-                        "completed": false,
-                        "userId": 123
-                      }
-                    ]
-                  }
-                }
-              }
-            }
-          }
-        },
-        "operationId": "1e0edd2a-8d53-4355-805f-54b7e5555725",
-        "x-zuplo-route": {
-          "corsPolicy": "none",
-          "handler": {
-            "export": "urlForwardHandler",
-            "module": "$import(@zuplo/runtime)",
-            "options": {
-              "baseUrl": "https://todo.zuplo.io"
-            }
-          }
-        },
-        "tags": ["Todo"]
-      },
-      "post": {
-        "summary": "Create a new todo",
-        "description": "**Creates a new todo item** with the provided details. The todo will be assigned a unique ID automatically and can include a title, completion status, and user association. This is the primary endpoint for adding new tasks to the system.",
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/CreateTodo"
-              }
-            }
-          }
-        },
-        "responses": {
-          "201": {
-            "description": "Todo created successfully",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Todo"
-                },
-                "examples": {
-                  "new_todo": {
-                    "summary": "A newly created todo",
-                    "value": {
-                      "id": 4,
-                      "title": "Deploy application",
-                      "completed": false,
-                      "userId": 789
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid request body"
-          }
-        },
-        "operationId": "55ee860b-fe7e-4d66-a228-bb5320c3305d",
-        "x-zuplo-route": {
-          "corsPolicy": "none",
-          "handler": {
-            "export": "urlForwardHandler",
-            "module": "$import(@zuplo/runtime)",
-            "options": {
-              "baseUrl": "https://todo.zuplo.io"
-            }
-          }
-        },
-        "tags": ["Todo"]
-      }
-    },
-    "/todos/{id}": {
-      "put": {
-        "summary": "Update a todo",
-        "description": "**Updates an existing todo item** by its unique identifier. You can modify any combination of the todo's properties including title, completion status, and user assignment. All changes are applied atomically to ensure data consistency.",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "integer"
-            },
-            "description": "The todo ID"
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UpdateTodo"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "Todo updated successfully",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Todo"
-                },
-                "examples": {
-                  "updated_todo": {
-                    "summary": "A todo that has been updated",
-                    "value": {
-                      "id": 1,
-                      "title": "Buy groceries and cook dinner",
-                      "completed": true,
-                      "userId": 123
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid request body"
-          },
-          "404": {
-            "description": "Todo not found"
-          }
-        },
-        "operationId": "4569a607-338e-4d66-80f7-17f911778b1d",
-        "x-zuplo-route": {
-          "corsPolicy": "none",
-          "handler": {
-            "export": "urlForwardHandler",
-            "module": "$import(@zuplo/runtime)",
-            "options": {
-              "baseUrl": "https://todo.zuplo.io"
-            }
-          }
-        },
-        "tags": ["Todo"]
-      },
-      "delete": {
-        "summary": "Delete a todo",
-        "description": "**Permanently removes a todo item** from the system using its unique identifier. This operation cannot be undone, so use with caution. The endpoint will return a 404 error if the specified todo does not exist.",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "integer"
-            },
-            "description": "The todo ID"
-          }
-        ],
-        "responses": {
-          "204": {
-            "description": "Todo deleted successfully"
-          },
-          "404": {
-            "description": "Todo not found"
-          }
-        },
-        "operationId": "888a8d15-aa30-45fe-8957-b07a8bcdd7ca",
-        "x-zuplo-route": {
-          "corsPolicy": "none",
-          "handler": {
-            "export": "urlForwardHandler",
-            "module": "$import(@zuplo/runtime)",
-            "options": {
-              "baseUrl": "https://todo.zuplo.io"
-            }
-          }
-        },
-        "tags": ["Todo"]
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "Todo": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "integer",
-            "description": "The todo ID"
-          },
-          "title": {
-            "type": "string",
-            "description": "The todo title"
-          },
-          "completed": {
-            "type": "boolean",
-            "description": "Whether the todo is completed"
-          },
-          "userId": {
-            "type": "integer",
-            "description": "The user ID who owns the todo"
-          }
-        },
-        "required": ["id", "title", "completed", "userId"]
-      },
-      "CreateTodo": {
-        "type": "object",
-        "properties": {
-          "title": {
-            "type": "string",
-            "description": "The todo title"
-          },
-          "completed": {
-            "type": "boolean",
-            "description": "Whether the todo is completed",
-            "default": false
-          },
-          "userId": {
-            "type": "integer",
-            "description": "The user ID who owns the todo"
-          }
-        },
-        "required": ["title", "userId"]
-      },
-      "UpdateTodo": {
-        "type": "object",
-        "properties": {
-          "title": {
-            "type": "string",
-            "description": "The todo title"
-          },
-          "completed": {
-            "type": "boolean",
-            "description": "Whether the todo is completed"
-          },
-          "userId": {
-            "type": "integer",
-            "description": "The user ID who owns the todo"
-          }
-        }
-      }
-    }
-  }
-}

package/dist/templates/default/docs/README-template.md

@@ -1,45 +0,0 @@
-# Developer Portal
-
-This is your
-[Zuplo Developer Portal](https://zuplo.com/docs/dev-portal/introduction). This
-developer portal allows you to ship a beautiful API documentation for your
-users. You can customize this portal to match your brand and style.
-
-This developer portal is configured to work with your Zuplo API. When you
-publish your API, your developer portal will be automatically published with the
-latest API documentation.
-
-For more information, visit the
-[Documentation](https://zuplo.com/docs/dev-portal/introduction).
-
-The Zuplo Developer Portal is built on top of the open source
-[Zudoku](https://zudoku.dev) project, a powerful tool for creating and managing
-API documentation. If you would like to learn more about the project, open a
-feature request, or contribute to the codebase, visit the
-[Zudoku GitHub repository](https://github.com/zuplo/zudoku).
-
-## Local Development
-
-After you have connected your Zuplo project to
-[source control](https://zuplo.com/docs/articles/source-control) you can clone
-your project locally. Running the Developer Portal locally allows you to see
-changes in real-time with live-reload.
-
-1. Clone the repository
-
-   ```bash
-   git clone https://github.com/my-org/my-repo
-   cd my-repo
-   ```
-
-2. Install dependencies
-
-   ```bash
-   npm install
-   ```
-
-3. Start the development server
-
-   ```bash
-   npm run docs
-   ```

package/dist/templates/default/docs/gitignore

@@ -1,32 +0,0 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/versions
-
-# testing
-/coverage
-
-# zudoku
-/dist/
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# env files (can opt-in for commiting if needed)
-.env*
-
-# typescript
-*.tsbuildinfo

package/dist/templates/default/docs/pages/introduction.mdx

@@ -1,153 +0,0 @@
----
-description: Welcome to your new Zudoku documentation site.
-sidebar_label: My Developer Portal
-sidebar_icon: panel-top
-category: ""
----
-
-<div>
-  <img src="/banner.svg" className="dark:hidden" />
-  <img src="/banner-dark.svg" className="hidden dark:block" />
-</div>
-
-# Welcome to Better API Documentation
-
-Welcome to your new developer portal that makes sense. 🎉
-
-This is your new developer portal, built with ["Zudoku by Zuplo"](https://github.com/zuplo/zudoku)
-and designed to elevate your API documentation experience. We've streamlined the setup process so
-you can focus on what matters most: creating exceptional developer experiences.
-
-Think of this as your API's professional showcase—presenting your endpoints and documentation in the
-best possible light. Whether you're launching innovative new features or improving existing
-services, this portal provides the foundation for clear, accessible, and engaging developer
-documentation.
-
-Let's explore what we've configured for you and how you can customize it to perfectly match your
-needs.
-
-## Let's Review Your Configuration
-
-The developer portal is configured in the `zudoku.config.tsx` file. We've created a starter
-configuration to get you up and running quickly. Let's walk you through everything we've set up so
-you know how to customize it:
-
-<Stepper>
-
-1. **Change the Basics**
-
-   First, you may want to change the title and banner we've put in place. These are part of the
-   `page` section in your configuration.
-
-   :::tip
-
-   **Have a company logo?** Learn how you can
-   [add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/site#logo) in our
-   documentation.
-
-   :::
-
-   ```jsx
-   {
-    // ...
-    "page": {
-      "title": "My Developer Portal",
-      "banner": {
-        "message": (
-          <div className="w-full text-center">
-            <strong>Congrats!</strong> 🙌 You just created your first developer
-            portal.
-          </div>
-        ),
-        "color": "info",
-        "dismissible": true,
-      }
-   }
-   ```
-
-1. **API Reference**
-
-   Your [API Reference](/api) is generated from your Zuplo OpenAPI file in `../routes.oas.json`—you
-   can add other APIs whenever you need them. Improve your documentation by adding more details to
-   the OpenAPI file.
-
-   ```json
-   {
-     // ...
-     "apis": {
-       "type": "file",
-       "input": "../config/routes.oas.json",
-       "navigationId": "api"
-     }
-   }
-   ```
-
-1. **Authentication & Login**
-
-   We've configured your project to use [Auth0](https://auth0.com) as an authentication provider
-   with our demo account. We support many authentication providers—check the
-   [documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers)
-   each one.
-
-   :::caution
-
-   You must change the authentication provider before taking this to **production**. Using our demo
-   provider is not secure for production use.
-
-   :::
-
-   ```json
-   {
-     // ...
-     "authentication": {
-       "type": "auth0",
-       "domain": "auth.zuplo.io",
-       "clientId": "kWQs12Q9Og4w6zzI82qJSa3klN1sMtvz",
-       "audience": "https://api.example.com/"
-     }
-   }
-   ```
-
-1. **API Keys**
-
-   We've enabled API Keys on your developer portal. This connects to the API Key Service in Zuplo.
-   To add API Keys for your users, create a consumer with the matching email address in **Services
-   => API Key Service** in Zuplo, or
-   [create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
-
-   ```json
-   {
-     // ...
-     "apiKeys": {
-       "enabled": true
-     }
-   }
-   ```
-
-</Stepper>
-
-## Make It Yours
-
-You can customize the look and feel of your documentation site by modifying the `theme` section in
-`zudoku.config.tsx`. Why not try changing the primary color of your site?
-
-```json
-{
-  // ...
-  "theme": {
-    "light": {
-      "primary": "316 100% 50%",
-      "primaryForeground": "360 100% 100%"
-    },
-    "dark": {
-      "primary": "316 100% 50%",
-      "primaryForeground": "360 100% 100%"
-    }
-  }
-  // ...
-}
-```
-
-We have extensive customization options available. From colors to fonts and borders, find the
-[full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme) in our
-documentation.

package/dist/templates/default/docs/pages/markdown.mdx

@@ -1,108 +0,0 @@
-# Welcome to Our Documentation
-
-## Overview
-
-This page demonstrates various markdown features and formatting options available in our
-documentation system. Whether you're writing technical documentation, guides, or tutorials, these
-examples will help you create beautiful and well-structured content.
-
-### Key Features
-
-- **Rich Text Formatting**: Bold, italic, and code formatting
-- **Lists**: Ordered and unordered lists
-- **Code Blocks**: Syntax highlighting for multiple languages
-- **Tables**: Organized data presentation
-- **Images**: Visual content integration
-- **Links**: Internal and external references
-
-## Text Formatting
-
-You can make text **bold** or _italic_ to emphasize important points. For technical terms, use
-`inline code` formatting.
-
-### Code Examples
-
-Here's a simple JavaScript function:
-
-```javascript
-function greet(name) {
-  return `Hello, ${name}!`;
-}
-
-// Example usage
-console.log(greet("World"));
-```
-
-And here's a Python example:
-
-```python
-def calculate_fibonacci(n):
-    if n <= 1:
-        return n
-    return calculate_fibonacci(n-1) + calculate_fibonacci(n-2)
-
-# Print first 10 Fibonacci numbers
-for i in range(10):
-    print(calculate_fibonacci(i))
-```
-
-## Lists and Organization
-
-### Unordered Lists
-
-- First item
-- Second item
-  - Nested item
-  - Another nested item
-- Third item
-
-### Ordered Lists
-
-1. First step
-2. Second step
-   1. Sub-step A
-   2. Sub-step B
-3. Third step
-
-## Tables
-
-| Feature     | Description           | Status |
-| ----------- | --------------------- | ------ |
-| Markdown    | Basic text formatting | ✅     |
-| Code Blocks | Syntax highlighting   | ✅     |
-| Tables      | Data organization     | ✅     |
-| Images      | Visual content        | ✅     |
-
-## Blockquotes
-
-> "The best way to predict the future is to implement it."
->
-> — Alan Kay
-
-## Links and References
-
-- [Internal Link](#overview)
-- [External Link](https://example.com)
-- [Documentation Home](/)
-
-## Horizontal Rules
-
----
-
-## Additional Tips
-
-1. Use headings to create a clear hierarchy
-2. Keep paragraphs short and focused
-3. Include code examples when relevant
-4. Use lists for better readability
-5. Add tables for structured data
-
-## Conclusion
-
-This example demonstrates the power and flexibility of markdown for creating beautiful
-documentation. Feel free to use these patterns in your own documentation to maintain consistency and
-readability.
-
----
-
-_Last updated: March 2024_