@bud.sh/app 0.1.0 → 0.2.0

package/dist/types/assets/contract-jA5pqK6h.d.ts

@@ -0,0 +1,111 @@
+import { i as ResolvedBudConfig } from "./config-BzzRLcL-.js";
+//#region app/server/hosted/contract.d.ts
+/** How a hosted Bud's captures stand, as its host reports them. */
+interface RemoteBranchState {
+  main: string | null;
+  /** The branch the server's checkout shows, or null. */
+  working: string | null;
+  active: string[];
+  /** The commit each branch's pictures show. */
+  captured: Record<string, string>;
+  /** Captures under way or failed, by branch. */
+  jobs: Record<string, {
+    commit: string;
+    state: "queued" | "building" | "capturing" | "failed";
+    error: string | null;
+    progress: {
+      captured: number;
+      total: number;
+    } | null;
+  }>;
+}
+/**
+ * Branches and captures kept by a host instead of local Git and builds: a hosted Bud lists the
+ * repository's branches through its source and captures them in builders of its own.
+ */
+interface BranchRemote {
+  branches(): Promise<{
+    name: string;
+    commit: string;
+    subject: string | null;
+  }[]>;
+  state(): Promise<RemoteBranchState>;
+  activate(name: string): Promise<void>;
+  deactivate(name: string): Promise<void>;
+  /** Captures the branch's current head now, even when its pictures already show that commit. */
+  capture(name: string): Promise<void>;
+}
+/**
+ * Where a hosted Bud's pictures, maps and indexes are kept: keys such as `<hash>.jpg`, shared
+ * with the host's captures. The same shape as `@bud.sh/previews`' storage.
+ */
+interface HostedStorage {
+  /** The file's bytes, or undefined when there is none. */
+  read(key: string): Promise<Uint8Array<ArrayBuffer> | undefined>;
+  write(key: string, bytes: Uint8Array): Promise<void>;
+  has(key: string): Promise<boolean>;
+  /**
+   * The file's bytes as a stream, or null when there is none. Pictures are served from it
+   * without holding them in memory.
+   */
+  stream?(key: string): Promise<ReadableStream<Uint8Array> | null>;
+}
+/**
+ * A hosted Bud with only the canvas and tasks: pictures, maps and branch state come from its
+ * host's stores, Beads lives in D1, and nothing reads a checkout, runs Git or opens a browser.
+ */
+interface HostedAppOptions {
+  /** The project's resolved config; its screens are limited to the canvas and tasks. */
+  config: ResolvedBudConfig;
+  /** Bud's built HTML shell, `dist/client/index.html`. */
+  template: string;
+  /** The D1 database holding the project's Beads: a binding or any D1-like database. */
+  database: HostedDatabase;
+  /** The previews store the host's captures write. */
+  storage: HostedStorage;
+  /** The host's branches and capture state. */
+  remote: BranchRemote;
+  /**
+   * Who comments and task edits are attributed to when a request names no author of its own.
+   */
+  author: HostedAuthor;
+  /**
+   * The capability the browser presents, 48 hex characters; random when absent. A host that
+   * restarts its server keeps it, so open pages keep working.
+   */
+  token?: string;
+}
+/** The part of a D1 database the Beads store uses. */
+interface HostedDatabase {
+  prepare(query: string): unknown;
+  batch(statements: never[]): Promise<unknown[]>;
+}
+/** A person comments and task edits are attributed to. */
+interface HostedAuthor {
+  name: string;
+  email: string;
+}
+/** What the host knows about one request it authenticated. */
+interface HostedRequestContext {
+  /**
+   * The signed-in person, who authors the request's comments, replies and task edits; the
+   * browser never chooses one.
+   */
+  author?: HostedAuthor;
+}
+/** A running hosted Bud. */
+interface HostedApp {
+  /** Answers one request to Bud, already authenticated by the host. */
+  fetch(request: Request, context?: HostedRequestContext): Promise<Response>;
+  /** Stops its services. */
+  dispose(): Promise<void>;
+}
+/** Creates a hosted Bud from its host's stores. */
+type CreateHostedApp = (options: HostedAppOptions) => HostedApp;
+/**
+ * The screens a hosted Bud shows: Pages as captured pictures, and no Files, which need a
+ * checkout.
+ */
+declare const hostedScreenModules: readonly string[];
+//#endregion
+export { HostedAuthor as a, HostedStorage as c, HostedAppOptions as i, RemoteBranchState as l, CreateHostedApp as n, HostedDatabase as o, HostedApp as r, HostedRequestContext as s, BranchRemote as t, hostedScreenModules as u };

package/dist/types/hosted.d.ts

@@ -1,101 +1,5 @@
 import { i as ResolvedBudConfig } from "./assets/config-BzzRLcL-.js";
-//#region app/server/hosted/contract.d.ts
-/** How a hosted Bud's captures stand, as its host reports them. */
-interface RemoteBranchState {
-  main: string | null;
-  /** The branch the server's checkout shows, or null. */
-  working: string | null;
-  active: string[];
-  /** The commit each branch's pictures show. */
-  captured: Record<string, string>;
-  /** Captures under way or failed, by branch. */
-  jobs: Record<string, {
-    commit: string;
-    state: "queued" | "building" | "capturing" | "failed";
-    error: string | null;
-    progress: {
-      captured: number;
-      total: number;
-    } | null;
-  }>;
-}
-/**
- * Branches and captures kept by a host instead of local Git and builds: a hosted Bud lists the
- * repository's branches through its source and captures them in builders of its own.
- */
-interface BranchRemote {
-  branches(): Promise<{
-    name: string;
-    commit: string;
-    subject: string | null;
-  }[]>;
-  state(): Promise<RemoteBranchState>;
-  activate(name: string): Promise<void>;
-  deactivate(name: string): Promise<void>;
-  /** Captures the branch's current head now, even when its pictures already show that commit. */
-  capture(name: string): Promise<void>;
-}
-/**
- * Where a hosted Bud's pictures, maps and indexes are kept: keys such as `<hash>.jpg`, shared
- * with the host's captures. The same shape as `@bud.sh/previews`' storage.
- */
-interface HostedStorage {
-  /** The file's bytes, or undefined when there is none. */
-  read(key: string): Promise<Uint8Array<ArrayBuffer> | undefined>;
-  write(key: string, bytes: Uint8Array): Promise<void>;
-  has(key: string): Promise<boolean>;
-  /**
-   * The file's bytes as a stream, or null when there is none. Pictures are served from it
-   * without holding them in memory.
-   */
-  stream?(key: string): Promise<ReadableStream<Uint8Array> | null>;
-}
-/**
- * A hosted Bud with only the canvas and tasks: pictures, maps and branch state come from its
- * host's stores, Beads lives in D1, and nothing reads a checkout, runs Git or opens a browser.
- */
-interface HostedAppOptions {
-  /** The project's resolved config; its screens are limited to the canvas and tasks. */
-  config: ResolvedBudConfig;
-  /** Bud's built HTML shell, `dist/client/index.html`. */
-  template: string;
-  /** The D1 database holding the project's Beads: a binding or any D1-like database. */
-  database: HostedDatabase;
-  /** The previews store the host's captures write. */
-  storage: HostedStorage;
-  /** The host's branches and capture state. */
-  remote: BranchRemote;
-  /** Who comments and task edits are attributed to. */
-  author: {
-    name: string;
-    email: string;
-  };
-  /**
-   * The capability the browser presents, 48 hex characters; random when absent. A host that
-   * restarts its server keeps it, so open pages keep working.
-   */
-  token?: string;
-}
-/** The part of a D1 database the Beads store uses. */
-interface HostedDatabase {
-  prepare(query: string): unknown;
-  batch(statements: never[]): Promise<unknown[]>;
-}
-/** A running hosted Bud. */
-interface HostedApp {
-  /** Answers one request to Bud, already authenticated by the host. */
-  fetch(request: Request): Promise<Response>;
-  /** Stops its services. */
-  dispose(): Promise<void>;
-}
-/** Creates a hosted Bud from its host's stores. */
-type CreateHostedApp = (options: HostedAppOptions) => HostedApp;
-/**
- * The screens a hosted Bud shows: Pages as captured pictures, and no Files, which need a
- * checkout.
- */
-export declare const hostedScreenModules: readonly string[];
-//#endregion
+import { a as HostedAuthor, c as HostedStorage, i as HostedAppOptions, l as RemoteBranchState, n as CreateHostedApp, o as HostedDatabase, r as HostedApp, s as HostedRequestContext, t as BranchRemote, u as hostedScreenModules } from "./assets/contract-jA5pqK6h.js";
 //#region src/hosted.server.d.ts
 /**
  * Creates a hosted Bud: Bud's own routes for the canvas and tasks on the host's stores.
@@ -104,4 +8,4 @@ export declare const hostedScreenModules: readonly string[];
  */
 export declare const createHostedApp: CreateHostedApp;
 //#endregion
-export type { BranchRemote, CreateHostedApp, HostedApp, HostedAppOptions, HostedDatabase, HostedStorage, RemoteBranchState, ResolvedBudConfig };
+export { type BranchRemote, type CreateHostedApp, type HostedApp, type HostedAppOptions, type HostedAuthor, type HostedDatabase, type HostedRequestContext, type HostedStorage, type RemoteBranchState, type ResolvedBudConfig, hostedScreenModules };

package/dist/types/node-host.d.ts

@@ -0,0 +1,40 @@
+import { a as HostedAuthor, s as HostedRequestContext } from "./assets/contract-jA5pqK6h.js";
+//#region src/node-host.server.d.ts
+/** Where the project's Bud on Cloudflare is, and the secret its remote API takes. */
+export interface NodeHostOptions {
+  /** The Worker's origin, such as `https://bud-hosted.example.workers.dev`. */
+  url: string;
+  /** The Worker's `BUD_REMOTE_TOKEN`. */
+  token: string;
+  /** Who authors comments and task edits when a request names no one; Bud when absent. */
+  author?: HostedAuthor;
+  /**
+   * The capability open pages present, 48 hex characters; random when absent, so pages opened
+   * before a restart reload once.
+   */
+  capability?: string;
+  /** Bud's built interface, `dist/client`; this package's own when absent. */
+  client?: string;
+  fetch?: typeof globalThis.fetch;
+}
+/** A hosted Bud answering a Node server's requests. */
+export interface NodeHost {
+  /**
+   * Answers one request, already authenticated by the host.
+   * @param request - The visitor's request.
+   * @param context - The signed-in person, who authors its comments and task edits.
+   * @returns Bud's response.
+   */
+  fetch(request: Request, context?: HostedRequestContext): Promise<Response>;
+  /** Stops Bud's services. */
+  dispose(): Promise<void>;
+}
+/**
+ * Starts a hosted Bud on Node: its interface from this package, and the project's config,
+ * pictures, tasks, discussions and branches from the project's Bud on Cloudflare.
+ * @param options - The Worker's origin and remote secret.
+ * @returns A fetch handler and a way to stop it.
+ */
+export declare function createNodeHost(options: NodeHostOptions): Promise<NodeHost>;
+//#endregion
+export type { HostedAuthor, HostedRequestContext };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bud.sh/app",
   "description": "The app, its config, screen and design APIs",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -41,6 +41,10 @@
     "./hosted": {
       "types": "./dist/types/hosted.d.ts",
       "import": "./dist/hosted/hosted.js"
+    },
+    "./node-host": {
+      "types": "./dist/types/node-host.d.ts",
+      "import": "./dist/node-host/node-host.js"
     }
   },
   "files": [
@@ -88,7 +92,7 @@
   },
   "scripts": {
     "dev": "vite",
-    "build": "vite build && vite build --ssr && vite build --config vite.node.config.ts && vite build --config vite.hosted.config.ts && vite build --config vite.types.config.ts",
+    "build": "vite build && vite build --ssr && vite build --config vite.node.config.ts && vite build --config vite.hosted.config.ts && vite build --config vite.node-host.config.ts && vite build --config vite.types.config.ts",
     "start": "NODE_ENV=production node --env-file-if-exists=.env dist/server/server.js",
     "typecheck": "node ../../scripts/typecheck.ts --project tsconfig.json",
     "test": "pnpm -w exec remix test \"packages/app/**/*.test.{ts,tsx}\"",