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

package/dist/starters/adapters/aws-lambda/.eslintignore

@@ -0,0 +1,2 @@
+# AWS-lambda
+.serverless

package/dist/starters/adapters/aws-lambda/.prettierignore

@@ -0,0 +1,2 @@
+# AWS-lambda
+.serverless

package/dist/starters/adapters/aws-lambda/adapters/aws-lambda/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: {
+      // This configuration will bundle all dependencies, except the node builtins (path, fs, etc.)
+      external: builtinModules,
+      noExternal: /./,
+    },
+    build: {
+      minify: false,
+      ssr: true,
+      rollupOptions: {
+        input: ["./src/entry_aws-lambda.tsx", "@qwik-router-config"],
+      },
+    },
+    plugins: [nodeServerAdapter({ name: "aws-lambda" })],
+  };
+});

package/dist/starters/adapters/aws-lambda/gitignore

@@ -0,0 +1,2 @@
+# AWS-lambda
+.serverless

package/dist/starters/adapters/aws-lambda/package.json

@@ -0,0 +1,23 @@
+{
+  "description": "AWS Lambda",
+  "scripts": {
+    "build.server": "vite build -c adapters/aws-lambda/vite.config.mts",
+    "serve": "qwik build && serverless offline",
+    "deploy": "serverless deploy"
+  },
+  "devDependencies": {
+    "source-map-support": "^0.5.21",
+    "serverless": "^3.38.0",
+    "serverless-http": "^3.2.0",
+    "serverless-offline": "^13.3.2"
+  },
+  "__qwik__": {
+    "priority": 30,
+    "displayName": "Adapter: AWS Lambda",
+    "docs": [
+      "https://qwik.dev/docs/deployments/aws-lambda/",
+      "https://aws.amazon.com/es/lambda/",
+      "https://www.serverless.com/cloud/docs/get-started"
+    ]
+  }
+}

package/dist/starters/adapters/aws-lambda/serverless.yml

@@ -0,0 +1,31 @@
+service: qwik-lambda-app
+frameworkVersion: "3"
+
+provider:
+  name: aws
+  runtime: nodejs18.x
+  region: us-west-1
+  memorySize: 128
+  timeout: 10
+  stage: dev
+
+functions:
+  qwik:
+    handler: server/entry_aws-lambda.qwikApp
+    events:
+      - httpApi: "*"
+
+custom:
+  serverless-offline:
+    httpPort: 4000
+
+package:
+  excludeDevDependencies: true
+  patterns:
+    - "!*"
+    - "!*/**"
+    - "server/**"
+    - "dist/**"
+
+plugins:
+  - serverless-offline

package/dist/starters/adapters/aws-lambda/src/entry_aws-lambda.tsx

@@ -0,0 +1,32 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for Aws Lambda when building for production.
+ *
+ * Learn more about the Aws Lambda integration here:
+ * - https://qwik.dev/docs/deployments/aws/
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import {
+  createQwikRouter,
+  type PlatformAwsLambda,
+} from "@qwik.dev/router/middleware/aws-lambda";
+import serverless from "serverless-http";
+import "source-map-support/register";
+import render from "./entry.ssr";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformAwsLambda {}
+}
+
+export const { handle } = createQwikRouter({
+  render,
+  qwikRouterConfig,
+  manifest,
+});
+
+export const qwikApp = serverless({ handle }, { binary: true });
+// handler is the default export for the lambda functions
+export const handler = qwikApp;

package/dist/starters/adapters/azure-swa/README.md

@@ -0,0 +1,13 @@
+## Create your Static Web App on Azure
+
+1. Follow [this](https://learn.microsoft.com/en-us/azure/static-web-apps/overview) guide to create a Static Web App. This guide will also detail how to generate a github action or Azure Pipeline (see "Quickstarts" section)
+
+2. If you're using github actions, make sure to add skip_api_build with true value.
+
+```yml
+app_location: "/"
+api_location: "azure-functions"
+output_location: "dist"
+skip_api_build: true # <--- add this line
+###### End of Repository/Build Configurations ######
+```

package/dist/starters/adapters/azure-swa/adapters/azure-swa/vite.config.mts

@@ -0,0 +1,23 @@
+import { azureSwaAdapter } from "@qwik.dev/router/adapters/azure-swa/vite";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      outDir: "azure-functions/render",
+      rollupOptions: {
+        input: ["src/entry.azure-swa.tsx", "@qwik-router-config"],
+        output: {
+          entryFileNames: `[name].[hash].mjs`,
+          chunkFileNames: `[name].[hash].mjs`,
+        },
+      },
+    },
+    ssr: {
+      noExternal: /.*/,
+    },
+    plugins: [azureSwaAdapter()],
+  };
+});

package/dist/starters/adapters/azure-swa/azure-functions/host.json

@@ -0,0 +1,20 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "extensions": {
+    "http": {
+      "routePrefix": "api"
+    }
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[2.*, 3.0.0)"
+  }
+}

package/dist/starters/adapters/azure-swa/gitignore

@@ -0,0 +1,3 @@
+# Azure
+/azure-functions/**
+!/azure-functions/host.json

package/dist/starters/adapters/azure-swa/package.json

@@ -0,0 +1,28 @@
+{
+  "description": "Azure Static Web Apps",
+  "scripts": {
+    "build.server": "vite build -c adapters/azure-swa/vite.config.mts",
+    "serve": "swa start"
+  },
+  "devDependencies": {
+    "@azure/functions": "^3.5.0",
+    "@azure/static-web-apps-cli": "^1.1.1"
+  },
+  "__qwik__": {
+    "priority": 30,
+    "displayName": "Adapter: Azure Static Web Apps",
+    "docs": [
+      "https://qwik.dev/deployments/azure-swa/",
+      "https://learn.microsoft.com/en-us/azure/static-web-apps/"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build and deploy to Azure with:",
+        "",
+        "- pnpm run build: production build for Azure SWA",
+        "- pnpm run deploy: it will use the SWA CLI to deploy your site"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/azure-swa/public/staticwebapp.config.json

@@ -0,0 +1,23 @@
+{
+  "routes": [
+    {
+      "route": "*",
+      "methods": ["POST", "PUT", "DELETE"],
+      "rewrite": "/api/render"
+    },
+    {
+      "route": "/",
+      "rewrite": "/api/render"
+    },
+    {
+      "route": "/index.html",
+      "rewrite": "/api/render"
+    }
+  ],
+  "navigationFallback": {
+    "rewrite": "/api/render"
+  },
+  "platform": {
+    "apiRuntime": "node:18"
+  }
+}

package/dist/starters/adapters/azure-swa/src/entry.azure-swa.tsx

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

package/dist/starters/adapters/azure-swa/swa-cli.config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://aka.ms/azure/static-web-apps-cli/schema",
+  "configurations": {
+    "qwik-app": {
+      "appLocation": ".",
+      "apiLocation": "./azure-functions",
+      "outputLocation": "./dist",
+      "appBuildCommand": "npm run build"
+    }
+  }
+}

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

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

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

@@ -0,0 +1,28 @@
+import { bunServerAdapter } from "@qwik.dev/router/adapters/bun-server/vite";
+import { _TextEncoderStream_polyfill } from "@qwik.dev/router/middleware/request-handler";
+import { extendConfig } from "@qwik.dev/router/vite";
+import baseConfig from "../../vite.config.mts";
+
+// This polyfill is required when you use SSG and build your app with Bun, because Bun does not have TextEncoderStream. See: https://github.com/oven-sh/bun/issues/5648
+globalThis.TextEncoderStream ||= _TextEncoderStream_polyfill;
+
+export default extendConfig(baseConfig, () => {
+  return {
+    build: {
+      ssr: true,
+      rollupOptions: {
+        input: ["src/entry.bun.ts", "@qwik-router-config"],
+      },
+      minify: false,
+    },
+    plugins: [
+      bunServerAdapter({
+        ssg: {
+          include: ["/*"],
+          origin: "https://yoursite.dev",
+          maxWorkers: 1, // Limit Workers to 1, otherwise SSG will hang when compiling Qwik City app with `bun run --bun build`.
+        },
+      }),
+    ],
+  };
+});

package/dist/starters/adapters/bun/package.json

@@ -0,0 +1,27 @@
+{
+  "description": "Bun server",
+  "scripts": {
+    "build.server": "vite build -c adapters/bun/vite.config.mts",
+    "serve": "bun server/entry.bun.js"
+  },
+  "__qwik__": {
+    "priority": 20,
+    "displayName": "Adapter: Bun Server",
+    "docs": [
+      "https://qwik.dev/deployments/bun/",
+      "https://bun.sh/docs/api/http"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build a production-ready Bun app:",
+        "",
+        "- bun run build: production build",
+        "- bun run serve: runs the production server locally"
+      ]
+    }
+  },
+  "devDependencies": {
+    "@types/bun": "*"
+  }
+}

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

@@ -0,0 +1,46 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for the Bun HTTP server when building for production.
+ *
+ * Learn more about the Bun integration here:
+ * - https://qwik.dev/docs/deployments/bun/
+ * - https://bun.sh/docs/api/http
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import { createQwikRouter } from "@qwik.dev/router/middleware/bun";
+import render from "./entry.ssr";
+
+// Create the Qwik Router Bun middleware
+const { router, notFound, staticFile } = createQwikRouter({
+  render,
+  qwikRouterConfig,
+  manifest,
+});
+
+// Allow for dynamic port
+const port = Number(Bun.env.PORT ?? 3000);
+
+// eslint-disable-next-line no-console
+console.log(`Server started: http://localhost:${port}/`);
+
+Bun.serve({
+  async fetch(request: Request) {
+    const staticResponse = await staticFile(request);
+    if (staticResponse) {
+      return staticResponse;
+    }
+
+    // Server-side render this request with Qwik Router
+    const qwikRouterResponse = await router(request);
+    if (qwikRouterResponse) {
+      return qwikRouterResponse;
+    }
+
+    // Path not found
+    return notFound(request);
+  },
+  port,
+});

package/dist/starters/adapters/cloud-run/Dockerfile

@@ -0,0 +1,24 @@
+FROM node:18-bullseye-slim AS build-env
+
+COPY . /app
+WORKDIR /app
+
+# It is recommended that you only install production dependencies with
+# `npm i --omit=dev`. You may need to check which dependencies are missing
+RUN npm i
+RUN npm run build
+
+
+# A light-weight image for running the app
+FROM gcr.io/distroless/nodejs18-debian11
+
+WORKDIR /app
+COPY --from=build-env /app/node_modules ./node_modules
+
+# After running `npm run build` you will have 2 build folders.
+# - The `dist` folder will be created including all the static files.
+# - The `server` folder will be created including all node server files.
+COPY --from=build-env /app/server ./server
+COPY --from=build-env /app/dist ./dist
+
+CMD ["server/entry.cloud-run.js"]

package/dist/starters/adapters/cloud-run/README.md

@@ -0,0 +1,7 @@
+## Google Cloud Run Server
+
+This app has a minimal [Cloud Run server](https://cloud.google.com/run) implementation. After running a full build, deploy your app with:
+
+```
+npm run deploy
+```

package/dist/starters/adapters/cloud-run/adapters/cloud-run/vite.config.mts

@@ -0,0 +1,15 @@
+import { cloudRunAdapter } from "@qwik.dev/router/adapters/cloud-run/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.cloud-run.tsx", "@qwik-router-config"],
+      },
+    },
+    plugins: [cloudRunAdapter()],
+  };
+});

package/dist/starters/adapters/cloud-run/package.json

@@ -0,0 +1,24 @@
+{
+  "description": "Google Cloud Run server",
+  "scripts": {
+    "build.server": "vite build -c adapters/cloud-run/vite.config.mts",
+    "deploy": "gcloud run deploy my-cloud-run-app --source ."
+  },
+  "__qwik__": {
+    "priority": 20,
+    "displayName": "Adapter: Google Cloud Run server",
+    "docs": [
+      "https://qwik.dev/deployments/gcp-cloud-run/",
+      "https://cloud.google.com/run"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build and deploy to Google Cloud Run with:",
+        "",
+        "- pnpm run build: production build for Cloud Run",
+        "- pnpm run deploy: it will use the gcloud CLI to deploy your site"
+      ]
+    }
+  }
+}

package/dist/starters/adapters/cloud-run/src/entry.cloud-run.tsx

@@ -0,0 +1,96 @@
+/*
+ * WHAT IS THIS FILE?
+ *
+ * It's the entry point for the Google Cloud Run middleware when building for production.
+ *
+ * Learn more about the Cloud Run integration here:
+ * - https://qwik.dev/docs/deployments/gcp-cloud-run/
+ *
+ */
+import { manifest } from "@qwik-client-manifest";
+import qwikRouterConfig from "@qwik-router-config";
+import {
+  createQwikRouter,
+  type PlatformNode,
+} from "@qwik.dev/router/middleware/node";
+import { createServer } from "node:http";
+import render from "./entry.ssr";
+
+declare global {
+  interface QwikRouterPlatform extends PlatformNode {}
+}
+
+/** The default headers used by helmet */
+const DEFAULT_HEADERS = {
+  "Content-Security-Policy": [
+    `default-src 'self'`,
+    `base-uri 'self'`,
+    `font-src 'self' https: data:`,
+    `form-action 'self'`,
+    `frame-ancestors 'self'`,
+    `img-src 'self' data:`,
+    `object-src 'none'`,
+    `script-src 'self'`,
+    `script-src-attr 'none'`,
+    `style-src 'self' https: 'unsafe-inline'`,
+    `upgrade-insecure-requests`,
+  ].join(";"),
+  "Cross-Origin-Embedder-Policy": "require-corp",
+  "Cross-Origin-Opener-Policy": "same-origin",
+  "Cross-Origin-Resource-Policy": "same-origin",
+  "Origin-Agent-Cluster": "?1",
+  "Referrer-Policy": "no-referrer",
+  "Strict-Transport-Security": "max-age=15552000; includeSubDomains",
+  "X-Content-Type-Options": "nosniff",
+  "X-DNS-Prefetch-Control": "off",
+  "X-Download-Options": "noopen",
+  "X-Frame-Options": "SAMEORIGIN",
+  "X-Permitted-Cross-Domain-Policies": "none",
+  "X-XSS-Protection": "0",
+};
+
+const { router, notFound, staticFile } = createQwikRouter({
+  render,
+  qwikRouterConfig,
+  manifest,
+  static: {
+    cacheControl: "public, max-age=31557600",
+  },
+  getOrigin(req) {
+    // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
+    const protocol = req.headers["x-forwarded-proto"] ?? "http";
+    const host = req.headers["host"];
+    return `${protocol}://${host}`;
+  },
+  getClientConn: (conn) => {
+    const xForwardedFor = conn.headers["x-forwarded-for"];
+    if (typeof xForwardedFor === "string") {
+      return {
+        ip: xForwardedFor.split(",").shift()?.trim(),
+      };
+    } else if (Array.isArray(xForwardedFor)) {
+      return {
+        ip: xForwardedFor.shift()?.trim(),
+      };
+    }
+    return {
+      ip: undefined,
+    };
+  },
+});
+
+const server = createServer();
+
+server.on("request", (req, res) => {
+  for (const header of Object.entries(DEFAULT_HEADERS)) {
+    res.setHeader(...header);
+  }
+
+  staticFile(req, res, () => {
+    router(req, res, () => {
+      notFound(req, res, () => {});
+    });
+  });
+});
+
+server.listen(process.env.PORT ?? 8080);

package/dist/starters/adapters/cloudflare-pages/README.md

@@ -0,0 +1,46 @@
+## Cloudflare Pages
+
+Cloudflare's [wrangler](https://github.com/cloudflare/wrangler) CLI can be used to preview a production build locally. To start a local server, run:
+
+```
+npm run serve
+```
+
+Then visit [http://localhost:8787/](http://localhost:8787/)
+
+### Deployments
+
+[Cloudflare Pages](https://pages.cloudflare.com/) are deployable through their [Git provider integrations](https://developers.cloudflare.com/pages/platform/git-integration/).
+
+If you don't already have an account, then [create a Cloudflare account here](https://dash.cloudflare.com/sign-up/pages). Next go to your dashboard and follow the [Cloudflare Pages deployment guide](https://developers.cloudflare.com/pages/framework-guides/deploy-anything/).
+
+Within the projects "Settings" for "Build and deployments", the "Build command" should be `npm run build`, and the "Build output directory" should be set to `dist`.
+
+### Function Invocation Routes
+
+Cloudflare Page's [function-invocation-routes config](https://developers.cloudflare.com/pages/platform/functions/routing/#functions-invocation-routes) can be used to include, or exclude, certain paths to be used by the worker functions. Having a `_routes.json` file gives developers more granular control over when your Function is invoked.
+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.
+
+By default, the Cloudflare pages adaptor _does not_ include a `public/_routes.json` config, but rather it is auto-generated from the build by the Cloudflare adaptor. An example of an auto-generate `dist/_routes.json` would be:
+
+```
+{
+  "include": [
+    "/*"
+  ],
+  "exclude": [
+    "/_headers",
+    "/_redirects",
+    "/build/*",
+    "/favicon.ico",
+    "/manifest.json",
+    "/service-worker.js",
+    "/about"
+  ],
+  "version": 1
+}
+```
+
+In the above example, it's saying _all_ pages should be SSR'd. However, the root static files such as `/favicon.ico` and any static assets in `/build/*` should be excluded from the Functions, and instead treated as a static file.
+
+In most cases the generated `dist/_routes.json` file is ideal. However, if you need more granular control over each path, you can instead provide you're own `public/_routes.json` file. When the project provides its own `public/_routes.json` file, then the Cloudflare adaptor will not auto-generate the routes config and instead use the committed one within the `public` directory.

package/dist/starters/adapters/cloudflare-pages/adapters/cloudflare-pages/vite.config.mts

@@ -0,0 +1,15 @@
+import { cloudflarePagesAdapter } from "@qwik.dev/router/adapters/cloudflare-pages/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.cloudflare-pages.tsx", "@qwik-router-config"],
+      },
+    },
+    plugins: [cloudflarePagesAdapter()],
+  };
+});

package/dist/starters/adapters/cloudflare-pages/gitignore

@@ -0,0 +1,2 @@
+# Cloudflare
+functions/**/*.js

package/dist/starters/adapters/cloudflare-pages/package.json

@@ -0,0 +1,28 @@
+{
+  "description": "Cloudflare Pages",
+  "scripts": {
+    "build.server": "vite build -c adapters/cloudflare-pages/vite.config.mts",
+    "deploy": "wrangler pages deploy ./dist",
+    "serve": "wrangler pages dev ./dist --compatibility-flags=nodejs_als"
+  },
+  "devDependencies": {
+    "wrangler": "^3.0.0"
+  },
+  "__qwik__": {
+    "priority": 40,
+    "displayName": "Adapter: Cloudflare Pages",
+    "docs": [
+      "https://qwik.dev/deployments/cloudflare-pages/",
+      "https://developers.cloudflare.com/pages"
+    ],
+    "nextSteps": {
+      "title": "Next Steps",
+      "lines": [
+        "Now you can build and deploy to Cloudflare Pages with:",
+        "",
+        "- pnpm run build: production build for Cloudflare",
+        "- pnpm run deploy: it will use the Cloudflare CLI to deploy your site"
+      ]
+    }
+  }
+}