@alchemy.run/fly 0.0.0 → 2.0.0-beta.84

package/src/Website/Foldkit.ts

@@ -0,0 +1,54 @@
+import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
+import type { ViteProps } from "./Vite.ts";
+
+/** Configuration for a Foldkit website. */
+export interface FoldkitProps extends FrameworkSiteProps {
+  /** Serializable overrides merged over vite.config.*. */
+  vite?: ViteProps["vite"];
+}
+
+/**
+ * Deploy a [Foldkit](https://foldkit.dev) application to Fly Machines.
+ * Browser-only apps use SPA routing. With `ssr.build` enabled in the
+ * Foldkit Vite plugin, prerendered pages and assets are served first,
+ * followed by Foldkit's generated request handler for SSR and hybrid routes.
+ *
+ * The build uses `@alchemy.run/frontend-frameworks/foldkit` and the
+ * project's Vite configuration. No application adapter is required.
+ * Native Foldkit development and live reload run without cloud resources;
+ * `Alchemy.remote()` opts into a live deployment during development.
+ *
+ * ### Creating a Website
+ * **Example:** SPA, SSR, or prerendered Foldkit application
+ * ```typescript
+ * const site = yield* Fly.Website.Foldkit("Web", {
+ *   rootDir: "./app",
+ * });
+ * ```
+ *
+ * ### Server Configuration
+ * **Example:** Runtime environment for server-rendered pages
+ * ```typescript
+ * const site = yield* Fly.Website.Foldkit("Web", {
+ *   rootDir: "./app",
+ *   env: { API_BASE: "https://api.example.com" },
+ * });
+ * ```
+ *
+ * @resource
+ * @product Website
+ */
+export const Foldkit = (id: string, props: FoldkitProps = {}) =>
+  frameworkSite(id, props, {
+    name: "Foldkit",
+    framework: "@alchemy.run/frontend-frameworks/foldkit",
+    target: "@alchemy.run/frontend-frameworks/foldkit/node",
+    options: {
+      vite: props.vite,
+      notFoundHandling:
+        props.assets?.notFoundHandling === "single-page-application"
+          ? "spa"
+          : props.assets?.notFoundHandling,
+      htmlHandling: props.assets?.htmlHandling,
+    },
+  });

package/src/Website/FrameworkSite.ts

@@ -0,0 +1,363 @@
+import { AlchemyContext } from "alchemy/AlchemyContext";
+import type { MemoOptions } from "alchemy/Command/Memo";
+import * as Namespace from "alchemy/Namespace";
+import * as Output from "alchemy/Output";
+import { ProviderModePolicy } from "alchemy/ProviderMode";
+import { initialCwd } from "alchemy/Util/Node";
+import {
+  staticConfigFromAssets,
+  type WebsiteAssetsProps,
+  type WebsiteNotFoundHandling,
+} from "alchemy/Website/assets";
+import { packSiteExtraFiles } from "alchemy/Website/packExtraFiles";
+import { Server as FrameworkServer, type ServerDevProps } from "alchemy/Website/Server";
+import * as Data from "effect/Data";
+import * as Effect from "effect/Effect";
+import * as FileSystem from "effect/FileSystem";
+import * as Path from "effect/Path";
+import * as Redacted from "effect/Redacted";
+import { App } from "../App.ts";
+import { Bucket } from "../Bucket.ts";
+import { Certificate } from "../Certificate.ts";
+import { IpAssignment } from "../IpAssignment.ts";
+import type { Providers } from "../Providers.ts";
+import { Service, type ServiceProps } from "../Service.ts";
+import { AssetDeployment } from "./AssetDeployment.ts";
+
+/**
+ * A resource-valued prop: the resource itself, or an Effect that produces
+ * it (so `yield* App(...)` and `App(...)` both type-check).
+ */
+export type Ref<T> = T | Effect.Effect<T, never, Providers>;
+
+export type { ServerDevProps, WebsiteAssetsProps, WebsiteNotFoundHandling };
+export { staticConfigFromAssets };
+
+/**
+ * Props shared by every Fly framework website composite.
+ */
+export interface FrameworkSiteProps {
+  /** Deployment strategy forwarded to the hosted Fly Service. */
+  deploy?: ServiceProps["deploy"];
+  /** Process shutdown policy. The framework server must handle the signal. */
+  shutdown?: ServiceProps["shutdown"];
+  /** Named Machine readiness checks. */
+  checks?: ServiceProps["checks"];
+  /** Override proxy services and their routing health checks. */
+  services?: ServiceProps["services"];
+  /**
+   * Project root directory (the directory containing `package.json`).
+   * @default "."
+   */
+  rootDir?: string;
+  /**
+   * Controls which files are hashed to decide whether the build re-runs.
+   * @default true
+   */
+  memo?: MemoOptions | boolean;
+  /**
+   * Parent Fly App. Accepts a `Fly.App` or an Effect that produces one.
+   * When omitted, a `Fly.App` is created under this site's namespace.
+   */
+  app?: Ref<App>;
+  /**
+   * Process environment for the hosted server. Not Cloudflare Worker
+   * bindings — values become Machine env vars. Accepts `Output`s
+   * (e.g. `VITE_API_URL: api.url`).
+   */
+  env?: Record<string, string | Redacted.Redacted<string> | Output.Output<string | undefined>>;
+  /**
+   * Static-asset routing (`notFoundHandling`, `htmlHandling`). Hashed
+   * client files are uploaded to Tigris regardless of this bag.
+   */
+  assets?: WebsiteAssetsProps;
+  /**
+   * Options for the local dev server that runs this site under
+   * `alchemy dev`.
+   */
+  dev?: ServerDevProps;
+  /**
+   * Optional custom hostname. Requests ACME (`Fly.Certificate`) on the
+   * App. `url` becomes `https://<domain>` (existing DNS only for v1).
+   */
+  domain?: string;
+  /**
+   * User-defined tags. Accepted for API parity; Fly Services do not
+   * surface resource tags.
+   */
+  tags?: Record<string, string>;
+}
+
+/** Per-framework wiring for {@link makeFrameworkSite}. */
+export interface FrameworkSiteConfig {
+  /** Display name used in error messages (e.g. `"SvelteKit"`). */
+  name: string;
+  /** Framework-integration module specifier. */
+  framework: string;
+  /** Node deploy-target module specifier. */
+  target: string;
+  /**
+   * Framework-specific build options forwarded to the integration (e.g.
+   * `{ kit }`, `{ nuxt }`, `{ astro }`). Must be JSON-serializable.
+   */
+  options?: Record<string, unknown> | undefined;
+  /**
+   * Assets-only routing forwarded to the Node target (Vite SPA fallback).
+   * `spa` also publishes client files to Tigris at `/`.
+   */
+  static?: { spa?: boolean; errorPage?: string } | undefined;
+  /**
+   * Vocs/Waku: serve `about/index.html` at `/about`.
+   * @default "none"
+   */
+  htmlHandling?: "none" | "drop-trailing-slash";
+  /**
+   * Packages installed into the Machine image with `npm install` instead
+   * of bundling (Next.js needs `next`).
+   */
+  install?: string[] | undefined;
+  /**
+   * Skip baking `clientDirectory` at `/app/dist`. Next.js serves `.next`
+   * from the image root instead.
+   */
+  skipClientAssets?: boolean | undefined;
+}
+
+export interface FrameworkSite {
+  /**
+   * Public site URL. Local framework URL under `alchemy dev`;
+   * `https://{app}.fly.dev` (or `https://{domain}`) on deploy.
+   */
+  url: string | Output.Output<string | undefined> | undefined;
+  /** Parent Fly App. `undefined` during `alchemy dev`. */
+  app: App | undefined;
+  /** Hosted Fly Service. `undefined` during `alchemy dev`. */
+  service: Service | undefined;
+  /** Shared Anycast IPv4 so `{app}.fly.dev` answers. */
+  ip: IpAssignment | undefined;
+  /** ACME certificate when {@link FrameworkSiteProps.domain} is set. */
+  certificate: Certificate | undefined;
+}
+
+export class FrameworkSiteError extends Data.TaggedError("FrameworkSiteError")<{
+  readonly framework: string;
+  readonly message: string;
+  readonly cause?: unknown;
+}> {}
+
+const DEFAULT_PORT = 3000;
+
+const resolveRef = <T>(ref: Ref<T>): Effect.Effect<T, never, Providers> =>
+  Effect.isEffect(ref) ? ref : Effect.succeed(ref);
+
+const envRecord = (
+  env:
+    | Record<string, string | Redacted.Redacted<string> | Output.Output<string | undefined>>
+    | undefined,
+): Record<string, string | Output.Output<string | undefined>> | undefined => {
+  if (env === undefined) return undefined;
+  return Object.fromEntries(
+    Object.entries(env).map(([key, value]) => [
+      key,
+      Redacted.isRedacted(value) ? Redacted.value(value) : value,
+    ]),
+  );
+};
+
+const runFrameworkSite = Effect.fn("Fly.Website.FrameworkSite")(function* (
+  _id: string,
+  props: FrameworkSiteProps,
+  config: FrameworkSiteConfig,
+) {
+  const ctx = yield* AlchemyContext;
+  const remoted = yield* ProviderModePolicy;
+  const isLocal = ctx.dev && remoted !== true;
+  const path = yield* Path.Path;
+  const fs = yield* FileSystem.FileSystem;
+
+  const build = yield* FrameworkServer("Build", {
+    framework: config.framework,
+    target: config.target,
+    root: props.rootDir,
+    env: envRecord(props.env),
+    options: config.options,
+    memo: props.memo,
+    dev: props.dev,
+  });
+
+  if (isLocal) {
+    return {
+      url: build.url,
+      app: undefined,
+      service: undefined,
+      ip: undefined,
+      certificate: undefined,
+    } satisfies FrameworkSite;
+  }
+
+  // The build runs at APPLY time (`Website.Server` is a resource), so its
+  // attributes are Outputs here — derive every deploy input lazily and let
+  // the engine resolve them once the build has produced real paths. Reading
+  // `build.distDir` eagerly in the composite body would observe an Output
+  // proxy, not a string.
+  const buildOut = Output.mapEffect(
+    ([serverEntry, distDir]: [string | undefined, string | undefined]) =>
+      Effect.gen(function* () {
+        if (serverEntry === undefined || distDir === undefined) {
+          return yield* Effect.die(
+            new FrameworkSiteError({
+              framework: config.framework,
+              message: `The ${config.name} build produced no Node serve entry (serverModules[0]). The Node deploy target should write serve-node.mjs.`,
+            }),
+          );
+        }
+        const main = path.resolve(initialCwd, serverEntry);
+        if (!(yield* fs.exists(main).pipe(Effect.orElseSucceed(() => false)))) {
+          return yield* Effect.die(
+            new FrameworkSiteError({
+              framework: config.framework,
+              message: `The ${config.name} build produced no server entry at ${main}`,
+            }),
+          );
+        }
+        return { distDir: path.resolve(initialCwd, distDir), main };
+      }),
+  )(
+    Output.all(
+      build.serverEntry as unknown as Output.Output<string | undefined>,
+      build.distDir as unknown as Output.Output<string | undefined>,
+    ) as unknown as Output.Output<[string | undefined, string | undefined]>,
+  );
+  const main = Output.map(buildOut, (out) => out.main);
+
+  const extraFiles = Output.mapEffect((out: { distDir: string; main: string }) =>
+    packSiteExtraFiles(out.distDir, config.skipClientAssets === true ? "next" : "client"),
+  )(buildOut);
+
+  const app = props.app !== undefined ? yield* resolveRef(props.app) : yield* App("App");
+
+  const ip = yield* IpAssignment("Shared", {
+    app,
+    type: "shared_v4",
+  });
+
+  // SPA: hashed `/assets` at Tigris. HTML and unknown paths stay on
+  // origin (NodeServe `notFoundHandling: "spa"`). Intercepting `/` with
+  // Tigris hangs SPA fallbacks — Fly does not rewrite `/counter/42` to
+  // `index.html`.
+  let statics:
+    | Output.Output<
+        | Array<{
+            guestPath: string;
+            urlPrefix: string;
+            tigrisBucket?: string;
+            indexDocument?: string;
+          }>
+        | undefined
+      >
+    | undefined;
+  if (config.static?.spa === true) {
+    const clientDir = Output.map(
+      build.clientDir as unknown as Output.Output<string | undefined>,
+      (dir) => {
+        if (dir === undefined) {
+          throw new FrameworkSiteError({
+            framework: config.framework,
+            message: `The ${config.name} build produced no client assets directory`,
+          });
+        }
+        return path.resolve(initialCwd, dir);
+      },
+    );
+    const bucket = yield* Bucket("Assets", { public: true });
+    yield* AssetDeployment("Files", {
+      bucket,
+      sourcePath: clientDir as unknown as string,
+      purge: true,
+    });
+    statics = Output.mapEffect(([clientDir, bucketName]: [string, string]) =>
+      Effect.gen(function* () {
+        const assetsDir = path.join(clientDir, "assets");
+        const exists = yield* fs.exists(assetsDir).pipe(Effect.orElseSucceed(() => false));
+        return exists
+          ? [
+              {
+                guestPath: "/assets",
+                urlPrefix: "/assets",
+                tigrisBucket: bucketName,
+              },
+            ]
+          : undefined;
+      }),
+    )(
+      Output.all(
+        clientDir,
+        bucket.name as unknown as Output.Output<string>,
+      ) as unknown as Output.Output<[string, string]>,
+    );
+  }
+
+  const service = yield* Service("Service", {
+    app,
+    deploy: props.deploy,
+    shutdown: props.shutdown,
+    checks: props.checks,
+    services: props.services,
+    main: main as unknown as string,
+    port: DEFAULT_PORT,
+    // Node + nitro SSR needs more than the Machine default 256MB.
+    guest: { memoryMb: 512 },
+    isExternal: true,
+    env: props.env,
+    extraFiles: extraFiles as unknown as Array<{
+      source: string;
+      dest: string;
+    }>,
+    statics: statics as unknown as
+      | Array<{
+          guestPath: string;
+          urlPrefix: string;
+          tigrisBucket?: string;
+          indexDocument?: string;
+        }>
+      | undefined,
+    build:
+      config.install !== undefined && config.install.length > 0
+        ? { install: config.install }
+        : undefined,
+  });
+
+  const certificate =
+    props.domain !== undefined
+      ? yield* Certificate("Certificate", {
+          app,
+          hostname: props.domain,
+          kind: "acme",
+        })
+      : undefined;
+
+  const url = props.domain !== undefined ? `https://${props.domain}` : app.url;
+
+  return { url, app, service, ip, certificate };
+});
+
+/**
+ * Shared implementation behind the Fly framework website composites:
+ * `Website.Server` runs the framework toolchain (dev sidecar / production
+ * build), then a live deploy hosts `serve-node.mjs` on a Fly.Service.
+ *
+ * Callers pipe `Namespace.push(id)` themselves (the composites do).
+ *
+ * Composite-level tagged errors (`FrameworkSiteError`, filesystem) are
+ * defects — `Alchemy.Stack` only admits `ConfigError` on the user
+ * effect, same as Cloudflare/AWS Website composites.
+ */
+export const makeFrameworkSite = (
+  id: string,
+  props: FrameworkSiteProps,
+  config: FrameworkSiteConfig,
+) => runFrameworkSite(id, props, config).pipe(Effect.orDie);
+
+/** Push {@link id} then run {@link makeFrameworkSite}. */
+export const frameworkSite = (id: string, props: FrameworkSiteProps, config: FrameworkSiteConfig) =>
+  makeFrameworkSite(id, props, config).pipe(Namespace.push(id));

package/src/Website/Nextjs.ts

@@ -0,0 +1,50 @@
+import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
+
+/**
+ * The Next.js-on-Node framework module (`next build` + a custom
+ * `next({ dev: false })` server). Not OpenNext.
+ */
+export const NEXTJS_NODE_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/nextjs/node";
+
+export interface NextjsProps extends FrameworkSiteProps {}
+
+/**
+ * Deploy a Next.js application to Fly as a long-running Node process:
+ * `next build`, then a serve entry that `import("next")` +
+ * `next({ dev: false }).prepare()` + `getRequestHandler()`. The `.next`
+ * output (and `public/` when present) is baked into the image; `next` is
+ * installed unbundled.
+ *
+ * Do not use OpenNext AWS/CF wrappers — those are Lambda/workerd.
+ *
+ * During `alchemy dev` the site is `next dev` and no cloud resources are
+ * declared; `Alchemy.remote()` opts back into the live Service path.
+ *
+ *
+ * ### Creating Next.js Sites
+ * **Example:** Basic Next.js App
+ * ```typescript
+ * const site = yield* Fly.Website.Nextjs("Web", {
+ *   rootDir: "./app",
+ * });
+ * ```
+ *
+ * **Example:** Custom Domain
+ * ```typescript
+ * const site = yield* Fly.Website.Nextjs("Web", {
+ *   rootDir: "./app",
+ *   domain: "app.example.com",
+ * });
+ * ```
+ *
+ * @resource
+ * @product Website
+ */
+export const Nextjs = (id: string, props: NextjsProps = {}) =>
+  frameworkSite(id, props, {
+    name: "Next.js",
+    framework: NEXTJS_NODE_FRAMEWORK_SPECIFIER,
+    target: NEXTJS_NODE_FRAMEWORK_SPECIFIER,
+    install: ["next", "react", "react-dom"],
+    skipClientAssets: true,
+  });

package/src/Website/Nuxt.ts

@@ -0,0 +1,48 @@
+import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
+
+/** The framework-integration package that drives the Nuxt build. */
+export const NUXT_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/nuxt";
+
+/** The Node container deploy target for the Nuxt build. */
+export const NUXT_NODE_TARGET_SPECIFIER = "@alchemy.run/frontend-frameworks/nuxt/node";
+
+export interface NuxtProps extends FrameworkSiteProps {
+  /**
+   * Nuxt config overrides merged over the project's own `nuxt.config.ts`
+   * (highest-priority layer). `nitro.preset` is owned by the Node deploy
+   * target and may not be set here.
+   */
+  nuxt?: Record<string, unknown>;
+}
+
+/**
+ * Deploy a Nuxt application to Fly: the nitro Node server on a Machine,
+ * static assets (prerendered pages included) baked into the image.
+ *
+ *
+ * ### Creating Nuxt Sites
+ * **Example:** Basic Nuxt App
+ * ```typescript
+ * const site = yield* Fly.Website.Nuxt("Web", {
+ *   rootDir: "./app",
+ * });
+ * ```
+ *
+ * **Example:** Custom Domain
+ * ```typescript
+ * const site = yield* Fly.Website.Nuxt("Web", {
+ *   rootDir: "./app",
+ *   domain: "app.example.com",
+ * });
+ * ```
+ *
+ * @resource
+ * @product Website
+ */
+export const Nuxt = (id: string, props: NuxtProps = {}) =>
+  frameworkSite(id, props, {
+    name: "Nuxt",
+    framework: NUXT_FRAMEWORK_SPECIFIER,
+    target: NUXT_NODE_TARGET_SPECIFIER,
+    options: props.nuxt ? { nuxt: props.nuxt } : undefined,
+  });

package/src/Website/Octane.ts

@@ -0,0 +1,44 @@
+import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
+
+/** The framework-integration package that drives the Octane build. */
+export const OCTANE_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/octane";
+
+/** The Node container deploy target for the Octane build. */
+export const OCTANE_NODE_TARGET_SPECIFIER = "@alchemy.run/frontend-frameworks/octane/node";
+
+export interface OctaneProps extends FrameworkSiteProps {}
+
+/**
+ * Deploy an [OctaneJS](https://octanejs.dev) application to Fly: Octane's
+ * SSR server on a Machine, static assets baked into the image.
+ *
+ * `Fly.Website.Octane` selects hosting and automatically wraps Octane's
+ * default native Node output. Keep compiler and route settings in
+ * `octane.config.ts` without an adapter. The legacy Node marker adapter
+ * remains optional for existing projects.
+ *
+ * ### Creating Octane Sites
+ * **Example:** Basic Octane App
+ * ```typescript
+ * const site = yield* Fly.Website.Octane("Web", {
+ *   rootDir: "./app",
+ * });
+ * ```
+ *
+ * **Example:** Custom Domain
+ * ```typescript
+ * const site = yield* Fly.Website.Octane("Web", {
+ *   rootDir: "./app",
+ *   domain: "app.example.com",
+ * });
+ * ```
+ *
+ * @resource
+ * @product Website
+ */
+export const Octane = (id: string, props: OctaneProps = {}) =>
+  frameworkSite(id, props, {
+    name: "Octane",
+    framework: OCTANE_FRAMEWORK_SPECIFIER,
+    target: OCTANE_NODE_TARGET_SPECIFIER,
+  });

package/src/Website/ReactRouter.ts

@@ -0,0 +1,76 @@
+import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
+
+/** The framework-integration package that drives the React Router build. */
+export const REACT_ROUTER_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/react-router";
+
+/** The Node container deploy target for the React Router build. */
+export const REACT_ROUTER_NODE_TARGET_SPECIFIER =
+  "@alchemy.run/frontend-frameworks/react-router/node";
+
+export interface ReactRouterProps extends FrameworkSiteProps {}
+
+/**
+ * Deploy a [React Router](https://reactrouter.com) v7 app (framework mode)
+ * to Fly: the SSR server on a Machine, static assets baked into the image,
+ * served assets-first then the framework handler.
+ *
+ * The build runs through
+ * `@alchemy.run/frontend-frameworks/react-router` with the
+ * `@alchemy.run/frontend-frameworks/react-router/node` deploy target — both
+ * must be installed in your project, alongside `@react-router/dev`,
+ * `react-router`, and `vite`.
+ *
+ * Your `vite.config.ts` needs no adapter wiring. React Router's server
+ * build is a `ServerBuild` manifest rather than a request handler, so the
+ * integration wraps the manifest with `createRequestHandler` and packages
+ * the resulting fetch handler as a Node HTTP server on port 3000.
+ *
+ * React Server Components (React Router's `unstable` RSC plugin) and
+ * multi-environment builds are not supported yet — the build fails with an
+ * actionable error when more than one server entry is emitted.
+ *
+ *
+ * ### Creating React Router Sites
+ * **Example:** Basic React Router App
+ * ```typescript
+ * const site = yield* Fly.Website.ReactRouter("Web", {
+ *   rootDir: "./app",
+ * });
+ * ```
+ *
+ * **Example:** Custom Domain
+ * ```typescript
+ * const site = yield* Fly.Website.ReactRouter("Web", {
+ *   rootDir: "./app",
+ *   domain: "app.example.com",
+ * });
+ * ```
+ *
+ * ### Server Configuration
+ * **Example:** Process Environment
+ * ```typescript
+ * const site = yield* Fly.Website.ReactRouter("Web", {
+ *   rootDir: "./app",
+ *   env: {
+ *     GREETING: "Hello from React Router on Fly!",
+ *   },
+ * });
+ * ```
+ *
+ * **Example:** Read An Environment Variable From A Loader
+ * ```typescript
+ * // app/routes/home.tsx
+ * export function loader() {
+ *   return { greeting: process.env.GREETING ?? "Hello!" };
+ * }
+ * ```
+ *
+ * @resource
+ * @product Website
+ */
+export const ReactRouter = (id: string, props: ReactRouterProps = {}) =>
+  frameworkSite(id, props, {
+    name: "ReactRouter",
+    framework: REACT_ROUTER_FRAMEWORK_SPECIFIER,
+    target: REACT_ROUTER_NODE_TARGET_SPECIFIER,
+  });