create-zuplo-api 6.60.20 → 6.60.22

package/dist/templates/default/docs/zudoku.config.tsx

@@ -1,93 +0,0 @@
-import type { ZudokuConfig } from "zudoku";
-
-/**
- * Developer Portal Configuration
- * For more information, see:
- * https://zuplo.com/docs/dev-portal/zudoku/configuration/overview
- */
-const config: ZudokuConfig = {
-  site: {
-    title: "My Developer Portal",
-    logo: {
-      src: {
-        light: "https://cdn.zuplo.com/assets/my-dev-portal-light.svg",
-        dark: "https://cdn.zuplo.com/assets/my-dev-portal-dark.svg",
-      },
-    },
-  },
-  metadata: {
-    title: "Developer Portal",
-    description: "Developer Portal",
-  },
-  navigation: [
-    {
-      type: "category",
-      label: "Documentation",
-      items: [
-        {
-          type: "category",
-          label: "Getting Started",
-          icon: "sparkles",
-          items: [
-            {
-              type: "doc",
-              file: "introduction",
-            },
-            {
-              type: "doc",
-              file: "markdown",
-            },
-          ],
-        },
-        {
-          type: "category",
-          label: "Useful Links",
-          collapsible: false,
-          icon: "link",
-          items: [
-            {
-              type: "link",
-              label: "Zuplo Docs",
-              to: "https://zuplo.com/docs/dev-portal/introduction",
-            },
-            {
-              type: "link",
-              label: "Developer Portal Docs",
-              to: "https://zuplo.com/docs/dev-portal/introduction",
-            },
-          ],
-        },
-      ],
-    },
-    {
-      type: "link",
-      to: "/api",
-      label: "API Reference",
-    },
-  ],
-  redirects: [{ from: "/", to: "/api" }],
-  apis: [
-    {
-      type: "file",
-      input: "../config/routes.oas.json",
-      path: "api",
-    },
-  ],
-  authentication: {
-    // IMPORTANT: This is a demo Auth0 configuration.
-    // In a real application, you should replace these values with your own
-    // identity provider's configuration.
-    // This configuration WILL NOT WORK with custom domains.
-    // For more information, see:
-    // https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication
-    type: "auth0",
-    domain: "auth.zuplo.site",
-    clientId: "f8I87rdsCRo4nU2FHf0fHVwA9P7xi7Ml",
-    audience: "https://api.example.com/",
-  },
-  apiKeys: {
-    enabled: true,
-  },
-};
-
-export default config;

package/dist/templates/default/env.example

@@ -1,2 +0,0 @@
-EXAMPLE_SECRET=👀 What you looking at?
-EXAMPLE_CONFIG=https://twitter.com/zuplo

package/dist/templates/default/eslintrc.json

@@ -1,7 +0,0 @@
-{
-  "root": true,
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": { "project": ["./tsconfig.json"] },
-  "plugins": ["@typescript-eslint"]
-}

package/dist/templates/default/gitignore

@@ -1,10 +0,0 @@
-.zuplo/
-.cache/
-dist/
-node_modules/
-.env
-.env.zuplo
-
-# OS Stuff
-
-.DS_Store

package/dist/templates/default/modules/hello-world.ts

@@ -1,21 +0,0 @@
-import { ZuploContext, ZuploRequest } from "@zuplo/runtime";
-
-export default async function (request: ZuploRequest, context: ZuploContext) {
-  /**
-   * Use the log property on context to enjoy
-   * logging magic when testing your API.
-   */
-  context.log.info(`Hi, from inside your zup!`);
-
-  /**
-   * If you want to proxy an API, you can simply
-   * return the content of a fetch. Try it by
-   * uncommenting the line below.
-   */
-  // return fetch('http://www.example.com/');
-
-  /**
-   * In this example, we're just going to return some content.
-   */
-  return "What zup?";
-}

package/dist/templates/default/prettierrc.json

@@ -1 +0,0 @@
-{}

package/dist/templates/default/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "include": ["modules/**/*", ".zuplo/**/*", "tests/**/*"],
-  "exclude": ["./node_modules", "./dist"],
-  "compilerOptions": {
-    "module": "ESNext",
-    "target": "ES2022",
-    "lib": ["ESNext", "WebWorker", "Webworker.Iterable"],
-    "preserveConstEnums": true,
-    "moduleResolution": "Bundler",
-    "useUnknownInCatchVariables": false,
-    "forceConsistentCasingInFileNames": true,
-    "importHelpers": true,
-    "removeComments": true,
-    "esModuleInterop": true,
-    "noEmit": true,
-    "strictNullChecks": true,
-    "experimentalDecorators": true
-  }
-}

package/dist/templates/default/vscode/launch.json

@@ -1,37 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Launch Zuplo",
-      "runtimeExecutable": "npx",
-      "runtimeArgs": [
-        "@zuplo/cli",
-        "dev",
-        "--debug-port",
-        "9229",
-        "--port",
-        "9000"
-      ],
-      "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen"
-    },
-    {
-      "name": "Zuplo Gateway",
-      "type": "node",
-      "request": "attach",
-      "restart": true,
-      "port": 9229
-    }
-  ],
-  "compounds": [
-    {
-      "name": "Launch & Attach Zuplo",
-      "configurations": ["Launch Zuplo", "Zuplo Gateway"]
-    }
-  ]
-}

package/dist/templates/default/vscode/settings.json

@@ -1,20 +0,0 @@
-{
-  "json.schemas": [
-    {
-      "fileMatch": ["config/*.oas.json"],
-      "url": "https://cdn.zuplo.com/schemas/openapi-v3.1-zuplo.json"
-    },
-    {
-      "fileMatch": ["config/policies.json"],
-      "url": "https://cdn.zuplo.com/schemas/policies.json"
-    },
-    {
-      "fileMatch": ["config/dev-portal.json"],
-      "url": "https://cdn.zuplo.com/schemas/dev-portal.json"
-    },
-    {
-      "fileMatch": ["docs/sidebar.json"],
-      "url": "https://cdn.zuplo.com/schemas/sidebar.json"
-    }
-  ]
-}

package/dist/templates/default/zuplo.jsonc

@@ -1,4 +0,0 @@
-{
-  "version": 1,
-  "compatibilityDate": "2025-02-06"
-}

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

@@ -1,3 +0,0 @@
-{
-  "policies": []
-}

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

@@ -1,8 +0,0 @@
-{
-  "openapi": "3.1.0",
-  "info": {
-    "version": "1.0.0",
-    "title": "My Zuplo API"
-  },
-  "paths": {}
-}

package/dist/templates/default-empty/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-empty/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-empty/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-empty/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_