create-zuplo-api 6.16.14 → 6.17.0

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

@@ -0,0 +1,29 @@
+## 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:3000](http://localhost:3000) 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/dev-portal.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://cdn.zuplo.com/schemas/dev-portal.json",
+  "enabled": true,
+  "enableAuthentication": true
+}

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

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

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

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

package/dist/templates/default/docs/index.md

@@ -0,0 +1,43 @@
+# My API
+
+You can write full markdown in these documents. Syntax highlighting and full
+Github Flavored markdown are supported. To learn more about customizing the
+documentation of this developer portal
+[see the documentation](https://zuplo.com/docs/developer-portal/adding-pages).
+
+```ts
+const response = await fetch("https://echo.zuplo.io", {
+  headers: {
+    "content-type": "application/json",
+  },
+});
+
+const data = await response.json();
+console.log(data);
+```
+
+## Labore et Dolore
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+culpa qui officia deserunt mollit anim id est laborum.
+
+| Item            | Description                                  | Quanity |
+| --------------- | -------------------------------------------- | ------- |
+| ullamco laboris | reprehenderit in voluptate velit esse cillum | 21      |
+| Excepteur sint  | tempor incididunt ut labore                  | 1       |
+| anim id est     | irure dolor in reprehenderit in voluptate    | 82      |
+| non proiden     | cupidatat non proident, sunt in              | 53      |
+
+## Aliquip pariatur
+
+Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
+deserunt mollit anim id est laborum.
+
+- **Item 1** - ullamco laboris nisi ut aliquip ex ea commodo
+- **Item 2** - ullamco laboris nisi ut aliquip ex ea commodo
+- **Item 3** - ullamco laboris nisi ut aliquip ex ea commodo
+- **Item 4** - ullamco laboris nisi ut aliquip ex ea commodo

package/dist/templates/default/docs/sidebar.json

@@ -0,0 +1,13 @@
+{
+  "docs": [
+    {
+      "type": "doc",
+      "id": "index",
+      "label": "Index"
+    },
+    {
+      "type": "api-ref",
+      "label": "API Reference"
+    }
+  ]
+}

package/dist/templates/default/docs/theme.css

@@ -0,0 +1,29 @@
+/* Learn about theming here: https://zuplo.com/docs/developer-portal/theme */
+
+:root {
+  --logo-url: url(https://cdn.zuplo.com/dev-portal/v2/made-with-zuplo.svg);
+}
+
+.light {
+  --background-primary: white;
+  --font-family-primary: "-apple-system", "BlinkMacSystemFont", "Segoe UI",
+    "Roboto", "Helvetica Neue", "Ubuntu", "sans-serif";
+  --text-color-h1: rgb(42 47 69);
+  --text-color-h2: rgb(42 47 69);
+  --text-color-primary: rgb(79 86 107);
+}
+
+.dark {
+  --background-primary: #1a1f36;
+  --font-family-primary: "-apple-system", "BlinkMacSystemFont", "Segoe UI",
+    "Roboto", "Helvetica Neue", "Ubuntu", "sans-serif";
+  --text-color-h1: #f7fafc;
+  --text-color-h2: #f7fafc;
+  --text-color-primary: rgb(193 201 210);
+}
+
+/* The logo image */
+.theme-logo {
+  content: var(--logo-url);
+  margin: 20px;
+}

package/dist/templates/default/env.example

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

package/dist/templates/default/eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "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

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

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

@@ -0,0 +1,21 @@
+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

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

package/dist/templates/default/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "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

@@ -0,0 +1,37 @@
+{
+  // 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

@@ -0,0 +1,20 @@
+{
+  "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

@@ -0,0 +1,4 @@
+{
+  "version": 1,
+  "compatibilityDate": "2024-09-02",
+}

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

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

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

@@ -0,0 +1,5 @@
+{
+  "openapi": "3.1.0",
+  "info": {},
+  "paths": {}
+}

package/dist/templates/default-empty/env.example

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

package/dist/templates/default-empty/eslintrc.json

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

package/dist/templates/default-empty/gitignore

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

package/dist/templates/default-empty/prettierrc.json

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

package/dist/templates/default-empty/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "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-empty/zuplo.jsonc

@@ -0,0 +1,4 @@
+{
+  "version": 1,
+  "compatibilityDate": "2024-09-02",
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-zuplo-api",
-  "version": "6.16.14",
+  "version": "6.17.0",
   "keywords": [
     "api",
     "openapi",
@@ -25,7 +25,8 @@
   ],
   "scripts": {
     "dev": "ncc build ./index.ts -w -o dist/",
-    "build": "rm -rf ./dist && ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register"
+    "build": "rm -rf ./dist && ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register",
+    "build:public": "rm -rf ./dist && ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register"
   },
   "devDependencies": {
     "@types/async-retry": "1.4.9",