akanjs 3.0.0-beta.2 → 3.0.0-beta.20

package/index.ts

@@ -4,10 +4,9 @@ import type { AkanImageConfig } from "akanjs/server";
 export const archs = ["amd64", "arm64"] as const;
 export type Arch = (typeof archs)[number];
 
-/** One image step. The object form runs only on the matching `TARGETARCH` leg of a multi-arch build. */
+/** The object form runs only on the matching `TARGETARCH` leg of a multi-arch build. */
 export type DockerRun = string | { [key in Arch]?: string };
 
-/** The pieces Akan assembles a Dockerfile from. */
 export interface DockerImageConfig {
   image: string | { [key in Arch]?: string };
   /** Runs before `bun install`, so a system package a native dependency needs is there for the install. */
@@ -17,19 +16,12 @@ export interface DockerImageConfig {
   command: string[];
 }
 
-/**
- * A whole Dockerfile as a string, or the parts Akan assembles one from. The string form is taken verbatim —
- * nothing is merged into it, including the steps a lib contributes through its own `docker`.
- */
+/** The string form is taken verbatim: nothing is merged into it, not even a lib's `docker` steps. */
 export type DockerConfig = string | DockerImageConfig;
 
-/** What an `akan.config.ts` may write for `docker`: a whole Dockerfile, or any subset of the parts. */
 export type DockerOption = string | Partial<DockerImageConfig>;
 
-/**
- * A lib's contribution to the image of every app that mounts it — a lib never picks the base image or the
- * command, only the steps its own runtime needs.
- */
+/** Steps every app mounting the lib inherits; a lib never picks the base image or the command. */
 export interface LibDockerConfig {
   preRuns: DockerRun[];
   postRuns: DockerRun[];
@@ -47,39 +39,23 @@ export interface AkanRouteConfig {
   domains: AkanRouteDomains;
 }
 
-/**
- * Which web surfaces an app serves, resolved. `ssr` is the RSC/SSR route renderer and everything it needs —
- * the pages bundle, the client bundles, the RSC worker process. `csr` is the single-file SPA shell that the
- * Capacitor mobile build ships and that `/__csr` serves.
- */
+/** `ssr`: the RSC/SSR renderer with its bundles and RSC worker; `csr`: the SPA shell Capacitor ships and `/__csr` serves. */
 export interface AkanWebConfig {
   ssr: boolean;
   csr: boolean;
 }
 
 /**
- * What an `akan.config.ts` may write. `false` is an API-only app — no web artifact is built and no web route
- * is mounted; `true` (the default) is both surfaces. The object form keeps SSR and toggles only the CSR
- * bundle, which is the whole range there is: the CSR bundle inlines the stylesheet the SSR build compiles, so
- * CSR without SSR would ship an unstyled app and is not expressible here.
+ * `false` is an API-only app, `true` (the default) both surfaces; the object form toggles only CSR, because the CSR
+ * bundle inlines the stylesheet the SSR build compiles.
  */
 export type AkanWebOption = boolean | { csr: boolean };
 
-/**
- * How `akan build` trims the `public/` tree it copies into `dist`. Source trees are never touched: an app's
- * and a lib's `public/` keep every file, and only the build's own copy is trimmed.
- */
+/** Trims only the build's own copy of `public/`; source trees keep every file. */
 export interface AkanAssetsConfig {
-  /**
-   * Drop font files from the build's `public/` that no built surface references. A font with `optimize` on is
-   * served from `/_akan/fonts` after subsetting, so its source is a build input the image never reads.
-   */
+  /** Drops fonts no built surface references; an `optimize` font is served subset from `/_akan/fonts`. */
   pruneFonts: boolean;
-  /**
-   * Font files to keep whatever the scan concludes, as globs relative to this app's or lib's own `public/`
-   * (`"fonts/Assistant-*.woff2"`). For the case a scan cannot see: a URL assembled at runtime. Declare it in
-   * the `akan.config.ts` that owns the font, so the reason travels with the lib rather than with the app.
-   */
+  /** Globs relative to the owning app's or lib's `public/`, for fonts a scan cannot see (a runtime-built URL). */
   keepFonts: string[];
 }
 
@@ -174,10 +150,10 @@ export interface AkanExecutor {
 export interface AkanSyncContext {
   readonly appName: string;
   readonly appPath: string;
-  /** The full app/lib executor for advanced scan-result access and file operations. */
   readonly executor: AkanExecutor;
   getPath(rel: string): string;
   fileExists(rel: string): Promise<boolean>;
+  readFile(rel: string): Promise<string>;
   writeFile(rel: string, content: string, opts?: { overwrite?: boolean }): Promise<void>;
   /** Resolves `env/env.client.ts` and returns its exported `env`, or null when absent/invalid. */
   readEnvClient(): Promise<Record<string, unknown> | null>;
@@ -185,7 +161,6 @@ export interface AkanSyncContext {
 
 export interface AkanNativeContext {
   readonly appPath: string;
-  /** The app executor for advanced scan-result access and file operations. */
   readonly executor: AkanExecutor;
   readonly target: AkanMobileTargetConfig;
   readonly operation: "local" | "release";
@@ -207,15 +182,14 @@ export interface AkanNativeContext {
 export interface AkanPluginCapacitorConfig {
   /** Mobile permission that activates this plugin's native config (reuses the existing permission model). */
   permission?: MobilePermission;
-  /** Imperative native (Capacitor) project configuration. */
   configureNative?: (ctx: AkanNativeContext) => Promise<void>;
 }
 
+/** Read live by the CLI at build time; it carries functions, so it stays out of the serializable config results. */
 export interface AkanPlugin {
   name: string;
   /** Runtime npm packages this plugin needs; installed on demand by the CLI (e.g. firebase for push). */
   runtimePackages?: (ctx: PluginRuntimeContext) => string[];
-  /** Native (Capacitor) project configuration. */
   capacitor?: AkanPluginCapacitorConfig;
   /** Build-time asset generation (e.g. `public/firebase-messaging-sw.js`). */
   syncAssets?: (ctx: AkanSyncContext) => Promise<void>;
@@ -228,22 +202,28 @@ export interface AkanApiConfig {
   websocketPrefix: string;
 }
 
+export interface AkanDatabaseConfig {
+  /**
+   * The build carries each mode's drivers; a deployment picks one with `AKAN_DATABASE_MODE` (required when there are
+   * several), and `akan start` runs the first unless the shell names another.
+   */
+  modes: DatabaseMode[];
+}
+
 export interface AppConfigResult {
   docker: DockerConfig;
-  defaultDatabaseMode: DatabaseMode;
+  database: AkanDatabaseConfig;
   /**
-   * Where this app mounts its endpoints. Declared here rather than only in `main.ts` because the value is baked
-   * into every client bundle: a prebuilt CSR shell or a mobile bundle never reaches the server that would tell
-   * it otherwise. `new AkanApp({ prefix })` still overrides the server and every server-rendered page.
+   * Baked into every client bundle, since a prebuilt CSR shell or mobile bundle never asks the server;
+   * `new AkanApp({ prefix })` still overrides the server and every server-rendered page.
    */
   api: AkanApiConfig;
   /** Web surfaces built into the app and mounted at boot. Both default to `true`. */
   web: AkanWebConfig;
   routes?: AkanRouteConfig[];
   /**
-   * Mounts `libs/<lib>/page` into this app under `page/(libs)/(<lib>)` on sync. `true` takes every lib
-   * dependency that ships a `page` folder, an array takes exactly the libs listed, `false` (the default)
-   * syncs nothing and removes what a previous sync created.
+   * Mounts `libs/<lib>/page` under `page/(libs)/(<lib>)` on sync: `true` every lib dependency with a `page` folder, an
+   * array exactly those libs, `false` (the default) nothing, removing what a previous sync created.
    */
   syncPageLibs?: string[] | boolean;
   externalLibs: string[];
@@ -254,7 +234,6 @@ export interface AppConfigResult {
   publicEnv: string[];
   mobile: AkanMobileConfig;
   secrets: string[];
-  /** How the build trims the `public/` copy it ships. */
   assets: AkanAssetsConfig;
 }
 
@@ -292,25 +271,15 @@ export interface SubspaceDeclaration {
   repo: string;
   /** Apps this subspace serves. Libraries are never listed — they are derived from each app's closure. */
   apps: string[];
+  /** The subspace's own `AKAN_WORKSPACE_ID`, not this workspace's; only `akan subspace upload-env` reads it. */
+  workspaceId?: string;
 }
 
-/**
- * What `akan.subspace.ts` at a workspace root may write: the customer repos this workspace is mirrored
- * to. There is no branch field — the branch is whichever one the workspace is on, so one declaration
- * serves every release branch and each of them holds one akanjs version and one copy of the library
- * source.
- */
+/** `akan.subspace.ts`: the repos this workspace mirrors to, on whichever branch the workspace is on. */
 export interface SubspaceConfigInput {
-  /**
-   * Branches a push may target. A feature branch is refused, because pushing it would copy this
-   * workspace's branch namespace into every customer repo.
-   */
+  /** A feature branch is refused: pushing it would copy this workspace's branch namespace into every customer repo. */
   pushableBranches?: string[];
-  /**
-   * Workspace-root entries to keep out of every subspace, on top of the ones that always are. Top-level
-   * names or `dir/` prefixes — a workspace's own infra, release and benchmark trees are the usual
-   * entries.
-   */
+  /** Workspace-root names or `dir/` prefixes kept out of every subspace, on top of the ones that always are. */
   exclude?: string[];
   subspaces: SubspaceDeclaration[];
 }
@@ -334,10 +303,8 @@ export interface FileConventionScanResult {
 }
 
 /**
- * What a *live* scan exposes on `AppInfo.file` / `LibInfo.file`: a set per module kind, with every file
- * type carrying all four kinds. `FileConventionScanResult` above is the serialized form that crosses a
- * process boundary as JSON, which is why it is arrays and why each file type lists only the kinds it can
- * hold. The two are not interchangeable — every reader of `.file` calls `.has()`.
+ * The live form of `FileConventionScanResult` on `AppInfo.file`/`LibInfo.file` (every reader calls `.has()`); the
+ * arrays above are its JSON form, which lists only the kinds each file type can hold.
  */
 export interface FileConventionScanSet {
   all: Set<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akanjs",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.20",
   "sourceType": "module",
   "type": "module",
   "publishConfig": {
@@ -171,6 +171,11 @@
       "import": "./server/akanApp.ts",
       "default": "./server/akanApp.ts"
     },
+    "./server/tunnel": {
+      "types": "./types/server/tunnel/index.d.ts",
+      "import": "./server/tunnel/index.ts",
+      "default": "./server/tunnel/index.ts"
+    },
     "./server/memoryLimit": {
       "types": "./types/server/memoryLimit.d.ts",
       "import": "./server/memoryLimit.ts",
@@ -181,6 +186,16 @@
       "import": "./server/lifecycle/portInUse.ts",
       "default": "./server/lifecycle/portInUse.ts"
     },
+    "./server/artifact/routeSeedIndexStore": {
+      "types": "./types/server/artifact/routeSeedIndexStore.d.ts",
+      "import": "./server/artifact/routeSeedIndexStore.ts",
+      "default": "./server/artifact/routeSeedIndexStore.ts"
+    },
+    "./server/artifact/routesManifestStore": {
+      "types": "./types/server/artifact/routesManifestStore.d.ts",
+      "import": "./server/artifact/routesManifestStore.ts",
+      "default": "./server/artifact/routesManifestStore.ts"
+    },
     "./server/logging/logQuery": {
       "types": "./types/server/logging/logQuery.d.ts",
       "import": "./server/logging/logQuery.ts",
@@ -193,8 +208,11 @@
     }
   },
   "dependencies": {
+    "@lexical/plain-text": "^0.51.0",
+    "@noble/ciphers": "^2.4.0",
     "dayjs": "^1.11.20",
     "immer": "^11.1.8",
+    "lexical": "^0.51.0",
     "tailwind-merge": "^3.3.1",
     "tailwind-variants": "^3.3.0"
   },
@@ -235,7 +253,6 @@
     "react-icons": "^5.6.0",
     "react-refresh": "^0.18.0",
     "react-server-dom-webpack": "^19.2.7",
-    "react-simple-pull-to-refresh": "^1.3.4",
     "react-spring": "^10.0.4",
     "scheduler": "^0.27.0",
     "tailwind-scrollbar": "^4.0.2",
@@ -350,9 +367,6 @@
     "react-server-dom-webpack": {
       "optional": true
     },
-    "react-simple-pull-to-refresh": {
-      "optional": true
-    },
     "react-spring": {
       "optional": true
     },