@qwik.dev/core 0.0.0 → 2.0.0-alpha.0

package/dist/starters/adapters/cloudflare-pages/public/_headers

@@ -0,0 +1,9 @@
+# https://developers.cloudflare.com/pages/platform/headers/
+
+/*service-worker.js
+  Cache-Control: no-store
+  Content-Type: application/javascript
+  X-Content-Type-Options: nosniff
+
+/build/*
+  Cache-Control: public, max-age=31536000, s-maxage=31536000, immutable

package/dist/starters/adapters/cloudflare-pages/public/_redirects

@@ -0,0 +1 @@
+# https://developers.cloudflare.com/pages/platform/redirects/

package/dist/starters/adapters/cloudflare-pages/src/entry.cloudflare-pages.tsx

@@ -0,0 +1,24 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for Cloudflare Pages when building for production.
+ *
+ * Learn more about the Cloudflare Pages integration here:
+ * - https://qwik.dev/docs/deployments/cloudflare-pages/
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import {
+  createQwikRouter,
+  type PlatformCloudflarePages,
+} from "@qwik.dev/router/middleware/cloudflare-pages";
+import render from "./entry.ssr";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformCloudflarePages {}
+}
+
+const fetch = createQwikRouter({ render, qwikRouterConfig, manifest });
+
+export { fetch };

package/dist/starters/adapters/deno/README.md

@@ -0,0 +1,9 @@
+## Deno Server
+
+This app has a minimal [Deno server](https://docs.deno.com/runtime/tutorials/http_server) implementation. After running a full build, you can preview the build using the command:
+
+```
+npm run serve
+```
+
+Then visit [http://localhost:8080/](http://localhost:8080/)

package/dist/starters/adapters/deno/adapters/deno/vite.config.mts

@@ -0,0 +1,23 @@
+import { denoServerAdapter } from "@qwik.dev/router/adapters/deno-server/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      rollupOptions: {
+        input: ["src/entry.deno.ts", "@qwik-router-config"],
+      },
+      minify: false,
+    },
+    plugins: [
+      denoServerAdapter({
+        ssg: {
+          include: ["/*"],
+          origin: "https://yoursite.dev",
+        },
+      }),
+    ],
+  };
+});

package/dist/starters/adapters/deno/package.json

@@ -0,0 +1,24 @@
+{
+  "description": "Deno server",
+  "scripts": {
+    "build.server": "vite build -c adapters/deno/vite.config.mts",
+    "serve": "deno run --allow-net --allow-read --allow-env server/entry.deno.js"
+  },
+  "__qwik__": {
+    "priority": 20,
+    "displayName": "Adapter: Deno Server",
+    "docs": [
+      "https://qwik.dev/deployments/deno/",
+      "https://docs.deno.com/runtime/tutorials/http_server"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build a production-ready Deno app:",
+        "",
+        "- pnpm run build: production build",
+        "- pnpm run serve: runs the production server locally"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/deno/src/entry.deno.ts

@@ -0,0 +1,45 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for the Deno HTTP server when building for production.
+ *
+ * Learn more about the Deno integration here:
+ * - https://qwik.dev/docs/deployments/deno/
+ * - https://docs.deno.com/runtime/tutorials/http_server
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import { createQwikRouter } from "@qwik.dev/router/middleware/deno";
+import render from "./entry.ssr";
+
+// Create the Qwik Router Deno middleware
+const { router, notFound, staticFile } = createQwikRouter({
+  render,
+  qwikRouterConfig,
+  manifest,
+});
+
+// Allow for dynamic port
+const port = Number(Deno.env.get("PORT") ?? 3009);
+
+/* eslint-disable */
+console.log(`Server starter: http://localhost:${port}/app/`);
+
+Deno.serve({ port }, async (request: Request, info: any) => {
+  const staticResponse = await staticFile(request);
+  if (staticResponse) {
+    return staticResponse;
+  }
+
+  // Server-side render this request with Qwik Router
+  const qwikRouterResponse = await router(request, info);
+  if (qwikRouterResponse) {
+    return qwikRouterResponse;
+  }
+
+  // Path not found
+  return notFound(request);
+});
+
+declare const Deno: any;

package/dist/starters/adapters/express/README.md

@@ -0,0 +1,9 @@
+## Express Server
+
+This app has a minimal [Express server](https://expressjs.com/) implementation. After running a full build, you can preview the build using the command:
+
+```
+npm run serve
+```
+
+Then visit [http://localhost:8080/](http://localhost:8080/)

package/dist/starters/adapters/express/adapters/express/vite.config.mts

@@ -0,0 +1,15 @@
+import { nodeServerAdapter } from "@qwik.dev/router/adapters/node-server/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      rollupOptions: {
+        input: ["src/entry.express.tsx", "@qwik-router-config"],
+      },
+    },
+    plugins: [nodeServerAdapter({ name: "express" })],
+  };
+});

package/dist/starters/adapters/express/package.json

@@ -0,0 +1,33 @@
+{
+  "description": "Express.js server",
+  "scripts": {
+    "build.server": "vite build -c adapters/express/vite.config.mts",
+    "serve": "node server/entry.express"
+  },
+  "dependencies": {
+    "express": "4.20.0"
+  },
+  "devDependencies": {
+    "@types/compression": "^1.7.2",
+    "@types/express": "^4.17.19",
+    "compression": "^1.7.4",
+    "dotenv": "^16.3.2"
+  },
+  "__qwik__": {
+    "priority": 20,
+    "displayName": "Adapter: Node.js Express Server",
+    "docs": [
+      "https://qwik.dev/deployments/node/",
+      "https://expressjs.com/"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build a production-ready Express app:",
+        "",
+        "- pnpm run build: production build",
+        "- pnpm run serve: runs the production server locally"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/express/src/entry.express.tsx

@@ -0,0 +1,70 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for the Express HTTP server when building for production.
+ *
+ * Learn more about Node.js server integrations here:
+ * - https://qwik.dev/docs/deployments/node/
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import {
+  createQwikRouter,
+  type PlatformNode,
+} from "@qwik.dev/router/middleware/node";
+import "dotenv/config";
+import express from "express";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import render from "./entry.ssr";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformNode {}
+}
+
+// Directories where the static assets are located
+const distDir = join(fileURLToPath(import.meta.url), "..", "..", "dist");
+const buildDir = join(distDir, "build");
+
+// Allow for dynamic port
+const PORT = process.env.PORT ?? 3000;
+
+// Create the Qwik Router Node middleware
+const { router, notFound } = createQwikRouter({
+  render,
+  qwikRouterConfig,
+  manifest,
+  // getOrigin(req) {
+  //   // If deploying under a proxy, you may need to build the origin from the request headers
+  //   // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
+  //   const protocol = req.headers["x-forwarded-proto"] ?? "http";
+  //   // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host
+  //   const host = req.headers["x-forwarded-host"] ?? req.headers.host;
+  //   return `${protocol}://${host}`;
+  // }
+});
+
+// Create the express server
+// https://expressjs.com/
+const app = express();
+
+// Enable gzip compression
+// app.use(compression());
+
+// Static asset handlers
+// https://expressjs.com/en/starter/static-files.html
+app.use(`/build`, express.static(buildDir, { immutable: true, maxAge: "1y" }));
+app.use(express.static(distDir, { redirect: false }));
+
+// Use Qwik Router's page and endpoint request handler
+app.use(router);
+
+// Use Qwik Router's 404 handler
+app.use(notFound);
+
+// Start the express server
+app.listen(PORT, () => {
+  /* eslint-disable */
+  console.log(`Server started: http://localhost:${PORT}/`);
+});

package/dist/starters/adapters/fastify/README.md

@@ -0,0 +1,9 @@
+## Fastify Server
+
+This app has a minimal [Fastify server](https://fastify.dev/) implementation. After running a full build, you can preview the build using the command:
+
+```
+npm run serve
+```
+
+Then visit [http://localhost:3000/](http://localhost:3000/)

package/dist/starters/adapters/fastify/adapters/fastify/vite.config.mts

@@ -0,0 +1,15 @@
+import { nodeServerAdapter } from "@qwik.dev/router/adapters/node-server/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      rollupOptions: {
+        input: ["src/entry.fastify.tsx", "@qwik-router-config"],
+      },
+    },
+    plugins: [nodeServerAdapter({ name: "fastify" })],
+  };
+});

package/dist/starters/adapters/fastify/package.json

@@ -0,0 +1,33 @@
+{
+  "description": "Fastify server",
+  "scripts": {
+    "build.server": "vite build -c adapters/fastify/vite.config.mts",
+    "serve": "node server/entry.fastify"
+  },
+  "dependencies": {
+    "@fastify/compress": "^6.2.1",
+    "@fastify/static": "^6.10.1",
+    "fastify": "^4.17.0",
+    "fastify-plugin": "^4.5.0"
+  },
+  "devDependencies": {
+    "dotenv": "^16.3.2"
+  },
+  "__qwik__": {
+    "priority": 20,
+    "displayName": "Adapter: Node.js Fastify Server",
+    "docs": [
+      "https://qwik.dev/integrations/deployments/node/",
+      "https://fastify.dev/"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build a production-ready Fastify app:",
+        "",
+        "- pnpm run build: production build for Fastify",
+        "- pnpm run serve: runs the production server locally"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/fastify/src/entry.fastify.tsx

@@ -0,0 +1,48 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for the Fastify server when building for production.
+ *
+ * Learn more about Node.js server integrations here:
+ * - https://qwik.dev/docs/deployments/node/
+ *
+ */
+import { type PlatformNode } from "@qwik.dev/router/middleware/node";
+import "dotenv/config";
+import Fastify from "fastify";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import FastifyQwik from "./plugins/fastify-qwik";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformNode {}
+}
+
+// Directories where the static assets are located
+const distDir = join(fileURLToPath(import.meta.url), "..", "..", "dist");
+const buildDir = join(distDir, "build");
+
+// Allow for dynamic port and host
+const PORT = parseInt(process.env.PORT ?? "3000");
+const HOST = process.env.HOST ?? "0.0.0.0";
+
+const start = async () => {
+  // Create the fastify server
+  // https://fastify.dev/docs/latest/Guides/Getting-Started/
+  const fastify = Fastify({
+    logger: true,
+  });
+
+  // Enable compression
+  // https://github.com/fastify/fastify-compress
+  // IMPORTANT NOTE: THIS MUST BE REGISTERED BEFORE THE fastify-qwik PLUGIN
+  // await fastify.register(import('@fastify/compress'))
+
+  // Handle Qwik Router using a plugin
+  await fastify.register(FastifyQwik, { distDir, buildDir });
+
+  // Start the fastify server
+  await fastify.listen({ port: PORT, host: HOST });
+};
+
+start();

package/dist/starters/adapters/fastify/src/plugins/fastify-qwik.ts

@@ -0,0 +1,42 @@
+import fastifyStatic from "@fastify/static";
+import qwikRouterConfig from "@qwik-router-config";
+import { createQwikRouter } from "@qwik.dev/router/middleware/node";
+import type { FastifyPluginAsync } from "fastify";
+import fastifyPlugin from "fastify-plugin";
+
+import render from "../entry.ssr";
+
+export interface FastifyQwikOptions {
+  distDir: string;
+  buildDir: string;
+}
+
+const { router, notFound } = createQwikRouter({ render, qwikRouterConfig });
+
+const qwikPlugin: FastifyPluginAsync<FastifyQwikOptions> = async (
+  fastify,
+  options,
+) => {
+  const { buildDir, distDir } = options;
+
+  fastify.register(fastifyStatic, {
+    root: buildDir,
+    prefix: "/build",
+    immutable: true,
+    maxAge: "1y",
+    decorateReply: false,
+  });
+
+  fastify.register(fastifyStatic, {
+    root: distDir,
+    redirect: false,
+    decorateReply: false,
+  });
+
+  fastify.setNotFoundHandler(async (request, response) => {
+    await router(request.raw, response.raw, (err) => fastify.log.error(err));
+    await notFound(request.raw, response.raw, (err) => fastify.log.error(err));
+  });
+};
+
+export default fastifyPlugin(qwikPlugin, { fastify: ">=4.0.0 <6.0.0" });

package/dist/starters/adapters/firebase/.eslintignore

@@ -0,0 +1 @@
+# Firebase

package/dist/starters/adapters/firebase/.prettierignore

@@ -0,0 +1 @@
+# Firebase

package/dist/starters/adapters/firebase/adapters/firebase/vite.config.mts

@@ -0,0 +1,21 @@
+import { nodeServerAdapter } from "@qwik.dev/router/adapters/node-server/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import { builtinModules } from "module";
+import baseConfig from "../../vite.config.mts";
+export default extendConfig(baseConfig, () => {
+  return {
+    ssr: {
+      external: builtinModules,
+      noExternal: /./,
+    },
+    build: {
+      minify: false,
+      ssr: true,
+      rollupOptions: {
+        input: ["./src/entry-firebase.tsx", "@qwik-router-config"],
+      },
+      outDir: "./functions/server",
+    },
+    plugins: [nodeServerAdapter({ name: "firebase" })],
+  };
+});

package/dist/starters/adapters/firebase/firebase.json

@@ -0,0 +1,24 @@
+{
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default",
+      "ignore": [
+        "node_modules",
+        ".git",
+        "firebase-debug.log",
+        "firebase-debug.*.log"
+      ]
+    }
+  ],
+  "hosting": {
+    "public": "dist",
+    "rewrites": [
+      {
+        "source": "**",
+        "function": "app"
+      }
+    ],
+    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"]
+  }
+}

package/dist/starters/adapters/firebase/functions/index.js

@@ -0,0 +1,5 @@
+import { https } from "firebase-functions";
+import qwikApp from './server/entry-firebase.mjs';
+
+
+export const app = https.onRequest(qwikApp)

package/dist/starters/adapters/firebase/functions/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "functions",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log"
+  },
+  "engines": {
+    "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
+  },
+  "type": "module",
+  "main": "index.js",
+  "dependencies": {
+    "@google-cloud/functions-framework": "^3.3.0",
+    "firebase-admin": "^11.8.0",
+    "firebase-functions": "^4.3.1"
+  },
+  "devDependencies": {
+    "firebase-functions-test": "^3.1.0"
+  },
+  "private": true
+}

package/dist/starters/adapters/firebase/gitignore

@@ -0,0 +1,3 @@
+# Firebase
+functions/server
+functions/node_modules

package/dist/starters/adapters/firebase/package.json

@@ -0,0 +1,24 @@
+{
+  "description": "Firebase",
+  "scripts": {
+    "build.server": "vite build -c adapters/firebase/vite.config.mts",
+    "serve": "qwik build && firebase emulators:start",
+    "deploy": "firebase deploy"
+  },
+  "devDependencies": {
+    "firebase-tools": "^13.10.2"
+  },
+  "__qwik__": {
+    "priority": 30,
+    "displayName": "Adapter: Firebase",
+    "docs": [
+      "https://qwik.dev/docs/deployments/aws-lambda/"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "- cd functions && pnpm i"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/firebase/src/entry-firebase.tsx

@@ -0,0 +1,22 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for Firbease when building for production.
+ *
+ * Learn more about the Firebase integration here:
+ * - https://qwik.dev/docs/deployments/firebase/
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import {
+  createQwikRouter,
+  type PlatformFirebase,
+} from "@qwik.dev/router/middleware/firebase";
+import render from "./entry.ssr";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformFirebase {}
+}
+
+export default createQwikRouter({ render, qwikRouterConfig, manifest });

package/dist/starters/adapters/netlify-edge/README.md

@@ -0,0 +1,64 @@
+## Netlify
+
+This starter site is configured to deploy to [Netlify Edge Functions](https://docs.netlify.com/edge-functions/overview/), which means it will be rendered at an edge location near to your users.
+
+### Local development
+
+The [Netlify CLI](https://docs.netlify.com/cli/get-started/) can be used to preview a production build locally. To do so: First build your site, then to start a local server, run:
+
+1. Install Netlify CLI globally `npm i -g netlify-cli`.
+2. Build your site with both ssr and static `npm run build`.
+3. Start a local server with `npm run serve`.
+   In this project, `npm run serve` uses the `netlify dev` command to spin up a server that can handle Netlify's Edge Functions locally.
+4. Visit [http://localhost:8888/](http://localhost:8888/) to check out your site.
+
+### Edge Functions Declarations
+
+[Netlify Edge Functions declarations](https://docs.netlify.com/edge-functions/declarations/)
+can be configured to run on specific URL patterns. Each edge function declaration associates
+one site path pattern with one function to execute on requests that match the path. A single request can execute a chain of edge functions from a series of declarations. A single edge function can be associated with multiple paths across various declarations.
+
+This is useful to determine if a page response should be Server-Side Rendered (SSR) or
+if the response should use a static-site generated (SSG) `index.html` file instead.
+
+By default, the Netlify Edge adaptor will generate a `.netlify/edge-middleware/manifest.json` file, which is used by the Netlify deployment to determine which paths should, and should not, use edge functions.
+
+To override the generated manifest, you can [add a declaration](https://docs.netlify.com/edge-functions/declarations/#add-a-declaration) to the `netlify.toml` using the `[[edge_functions]]` config. For example:
+
+```toml
+[[edge_functions]]
+  path = "/admin"
+  function = "auth"
+```
+
+### Addition Adapter Options
+
+Netlify-specific option fields that can be passed to the adapter options:
+
+- `excludedPath` this option accepts a `string` glob pattern that represents which path pattern should not go through the generated Edge Functions.
+
+### Deployments
+
+You can [deploy your site to Netlify](https://docs.netlify.com/site-deploys/create-deploys/) either via a Git provider integration or through the Netlify CLI. This starter site includes a `netlify.toml` file to configure your build for deployment.
+
+#### Deploying via Git
+
+Once your site has been pushed to your Git provider, you can either link it [in the Netlify UI](https://app.netlify.com/start) or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command:
+
+```shell
+netlify link
+```
+
+This sets up [continuous deployment](https://docs.netlify.com/site-deploys/create-deploys/#deploy-with-git) for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process..
+
+#### Deploying manually via the CLI
+
+If you wish to deploy from the CLI rather than using Git, you can use the command:
+
+```shell
+netlify deploy --build
+```
+
+You must use the `--build` flag whenever you deploy. This ensures that the Edge Functions that this starter site relies on are generated and available when you deploy your site.
+
+Add `--prod` flag to deploy to production.

package/dist/starters/adapters/netlify-edge/adapters/netlify-edge/vite.config.mts

@@ -0,0 +1,16 @@
+import { netlifyEdgeAdapter } from "@qwik.dev/router/adapters/netlify-edge/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      rollupOptions: {
+        input: ["src/entry.netlify-edge.tsx", "@qwik-router-config"],
+      },
+      outDir: ".netlify/edge-functions/entry.netlify-edge",
+    },
+    plugins: [netlifyEdgeAdapter()],
+  };
+});

package/dist/starters/adapters/netlify-edge/gitignore

@@ -0,0 +1,2 @@
+# Netlify
+.netlify

package/dist/starters/adapters/netlify-edge/netlify.toml

@@ -0,0 +1,3 @@
+[build]
+publish = "dist"
+command = "npm run build"