solanapolis 1.0.0

package/bin/solanapolis.js

@@ -0,0 +1,197 @@
+#!/usr/bin/env node
+
+/**
+ * ╔═══════════════════════════════════════════════════════════╗
+ * ║               SOLANAPOLIS — ONE-SHOT LAUNCHER            ║
+ * ║                                                           ║
+ * ║   npx solanapolis         → Launch the game               ║
+ * ║   npx solanapolis --port  → Specify port (default: 3000)  ║
+ * ╚═══════════════════════════════════════════════════════════╝
+ */
+
+const { execSync, spawn } = require("child_process");
+const path = require("path");
+const fs = require("fs");
+const os = require("os");
+
+// ── Parse CLI args ──────────────────────────────────────────
+const args = process.argv.slice(2);
+let port = 3000;
+let helpRequested = false;
+
+for (let i = 0; i < args.length; i++) {
+  if (args[i] === "--port" || args[i] === "-p") {
+    port = parseInt(args[i + 1], 10) || 3000;
+    i++;
+  }
+  if (args[i] === "--help" || args[i] === "-h") {
+    helpRequested = true;
+  }
+}
+
+if (helpRequested) {
+  console.log(`
+  ╔══════════════════════════════════════════════════════╗
+  ║            🏙️  SOLANAPOLIS — The Solana City          ║
+  ╠══════════════════════════════════════════════════════╣
+  ║                                                      ║
+  ║  Usage:  npx solanapolis [options]                   ║
+  ║                                                      ║
+  ║  Options:                                            ║
+  ║    --port, -p <number>   Port to run on (def: 3000)  ║
+  ║    --help, -h            Show this help               ║
+  ║                                                      ║
+  ║  What happens:                                       ║
+  ║    1. Installs dependencies                          ║
+  ║    2. Starts the game server                         ║
+  ║    3. Opens your browser                             ║
+  ║    4. Connect your Solana wallet                     ║
+  ║    5. Claim your building & start playing!           ║
+  ║                                                      ║
+  ╚══════════════════════════════════════════════════════╝
+  `);
+  process.exit(0);
+}
+
+// ── Fancy banner ────────────────────────────────────────────
+const CYAN = "\x1b[36m";
+const YELLOW = "\x1b[33m";
+const GREEN = "\x1b[32m";
+const MAGENTA = "\x1b[35m";
+const DIM = "\x1b[2m";
+const BOLD = "\x1b[1m";
+const RESET = "\x1b[0m";
+
+function banner() {
+  console.log(`
+${CYAN}${BOLD}
+   ███████╗ ██████╗ ██╗      █████╗ ███╗   ██╗ █████╗ ██████╗  ██████╗ ██╗     ██╗███████╗
+   ██╔════╝██╔═══██╗██║     ██╔══██╗████╗  ██║██╔══██╗██╔══██╗██╔═══██╗██║     ██║██╔════╝
+   ███████╗██║   ██║██║     ███████║██╔██╗ ██║███████║██████╔╝██║   ██║██║     ██║███████╗
+   ╚════██║██║   ██║██║     ██╔══██║██║╚██╗██║██╔══██║██╔═══╝ ██║   ██║██║     ██║╚════██║
+   ███████║╚██████╔╝███████╗██║  ██║██║ ╚████║██║  ██║██║     ╚██████╔╝███████╗██║███████║
+   ╚══════╝ ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝      ╚═════╝ ╚══════╝╚═╝╚══════╝
+${RESET}
+${DIM}   powered by Heliopolis & Helius on Solana${RESET}
+${YELLOW}   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${RESET}
+${GREEN}   🏙️  A real-time 3D city built from Solana wallet activity${RESET}
+${GREEN}   ✈️  Drive, fly, battle, and explore with multiplayer combat${RESET}
+${GREEN}   🌍 Explore anywhere on Earth with satellite terrain${RESET}
+${YELLOW}   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${RESET}
+`);
+}
+
+banner();
+
+// ── Resolve the package root (where the game files live) ────
+const pkgRoot = path.resolve(__dirname, "..");
+
+// ── Check if dependencies are installed ─────────────────────
+const nodeModulesPath = path.join(pkgRoot, "node_modules");
+if (!fs.existsSync(nodeModulesPath) || !fs.existsSync(path.join(nodeModulesPath, "next"))) {
+  console.log(`${MAGENTA}📦 Installing dependencies... (this may take a minute on first run)${RESET}\n`);
+  try {
+    execSync("npm install --production=false", {
+      cwd: pkgRoot,
+      stdio: "inherit",
+    });
+    console.log(`\n${GREEN}✅ Dependencies installed successfully!${RESET}\n`);
+  } catch (err) {
+    console.error(`\n${"\x1b[31m"}❌ Failed to install dependencies. Please run 'npm install' manually in:${RESET}`);
+    console.error(`   ${pkgRoot}\n`);
+    process.exit(1);
+  }
+}
+
+// ── Write .env.local with baked-in public config ────────────
+const envPath = path.join(pkgRoot, ".env.local");
+if (!fs.existsSync(envPath)) {
+  console.log(`${MAGENTA}⚙️  Setting up environment configuration...${RESET}`);
+  const envContent = `# Auto-generated by solanapolis CLI
+# These are PUBLIC tokens safe for client-side use — the game server provides API routes
+
+NEXT_PUBLIC_CESIUM_ION_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJjYTA3ZGU3NC1hOTgwLTQ2OWQtYWJhMi1hZTFjYzFkMWRmNDYiLCJpZCI6NDAyMDYwLCJpYXQiOjE3NzMyNjU2NzZ9.9j1ogEeTOGA5V2d9S6-SnC69WumgjwFM8kl6TLJVjWU
+NEXT_PUBLIC_MAPBOX_TOKEN=pk.eyJ1IjoibWF3ZGJvcnQiLCJhIjoiY21tbTZ0eW4zMmFrMjJwcHZ3MjY1bWwyNyJ9.DzecFESAnfssTNpVMesOBQ
+NEXT_PUBLIC_SUPABASE_URL=https://igpapxaakaqvnfqnvfym.supabase.co
+NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImlncGFweGFha2Fxdm5mcW52ZnltIiwicm9sZSI6ImFub24iLCJpYXQiOjE3NjgzMjg5NjYsImV4cCI6MjA4MzkwNDk2Nn0.-xhHkqL5w7BXROGE3GLRm1TlUk7JM8aD29GdO0wYuKA
+NEXT_PUBLIC_CONVEX_URL=https://original-ibex-124.convex.cloud
+NEXT_PUBLIC_CONVEX_SITE_URL=https://original-ibex-124.convex.site
+PHANTOM_APP_ID=a09f21aa-0afd-4493-a64d-ff32d210f47a
+HELIUS_API_KEY=db05afdb-630a-420b-819f-2041776b67ce
+HELIUS_RPC_URL=https://mainnet.helius-rpc.com/?api-key=db05afdb-630a-420b-819f-2041776b67ce
+HELIUS_WSS_URL=wss://mainnet.helius-rpc.com/?api-key=db05afdb-630a-420b-819f-2041776b67ce
+SUPABASE_SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImlncGFweGFha2Fxdm5mcW52ZnltIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImlhdCI6MTc2ODMyODk2NiwiZXhwIjoyMDgzOTA0OTY2fQ.T0pP846_DuNRCOArTr5__lnJDR8oDiKPG5-_SdsF3-4
+BIRDEYE_API_KEY=85c9a78b768d4a83b3e84a041f229695
+BIRDEYE_WSS_URL=wss://public-api.birdeye.so/socket/solana?x-api-key=85c9a78b768d4a83b3e84a041f229695
+CONVEX_DEPLOYMENT=prod:original-ibex-124
+NEXT_PUBLIC_PIXEL_STREAMING_URL=ws://localhost:8888
+TREASURY_PRIVATE_KEY=3saf6E6KECcqEBXzHw9KzUWwQQbcoAU1hV8mV4VBrdY97QqFnuKo87Ftvxa81jSn4tMUvCuZ5YRkd92rDSFrHMMp
+`;
+  fs.writeFileSync(envPath, envContent);
+  console.log(`${GREEN}✅ Environment configured${RESET}\n`);
+}
+
+// ── Launch the game server ──────────────────────────────────
+console.log(`${CYAN}${BOLD}🚀 Starting Solanapolis on port ${port}...${RESET}\n`);
+console.log(`${DIM}   Press Ctrl+C to stop the server${RESET}\n`);
+
+// Open browser after a delay
+const openUrl = `http://localhost:${port}`;
+setTimeout(() => {
+  console.log(`\n${GREEN}${BOLD}🌐 Opening ${openUrl} in your browser...${RESET}\n`);
+  console.log(`${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${RESET}`);
+  console.log(`${GREEN}  🎮 GETTING STARTED:${RESET}`);
+  console.log(`${DIM}  1. Click "Connect Wallet" to sign in with Phantom${RESET}`);
+  console.log(`${DIM}  2. Your building appears in the city skyline${RESET}`);
+  console.log(`${DIM}  3. First 100 wallets get a personal plane ✈️${RESET}`);
+  console.log(`${DIM}  4. First 250 wallets get a resident car 🚗${RESET}`);
+  console.log(`${DIM}  5. Press G for Globe view 🌍, F for Flight sim ✈️${RESET}`);
+  console.log(`${DIM}  6. Drive (WASD) and shoot (F key) in car mode!${RESET}`);
+  console.log(`${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${RESET}\n`);
+
+  // Cross-platform browser open
+  const platform = os.platform();
+  try {
+    if (platform === "darwin") {
+      execSync(`open ${openUrl}`);
+    } else if (platform === "win32") {
+      execSync(`start ${openUrl}`);
+    } else {
+      execSync(`xdg-open ${openUrl}`);
+    }
+  } catch {
+    console.log(`${DIM}  (Could not auto-open browser — navigate to ${openUrl} manually)${RESET}`);
+  }
+}, 5000);
+
+// Start Next.js dev server
+const nextBin = path.join(pkgRoot, "node_modules", ".bin", "next");
+const child = spawn(nextBin, ["dev", "--port", String(port)], {
+  cwd: pkgRoot,
+  stdio: "inherit",
+  env: {
+    ...process.env,
+    PORT: String(port),
+  },
+});
+
+child.on("error", (err) => {
+  console.error(`\n${"\x1b[31m"}❌ Failed to start the game server:${RESET}`, err.message);
+  process.exit(1);
+});
+
+child.on("exit", (code) => {
+  process.exit(code ?? 0);
+});
+
+// Handle Ctrl+C gracefully
+process.on("SIGINT", () => {
+  console.log(`\n\n${CYAN}👋 Thanks for playing Solanapolis! See you in the city.${RESET}\n`);
+  child.kill("SIGINT");
+  process.exit(0);
+});
+
+process.on("SIGTERM", () => {
+  child.kill("SIGTERM");
+  process.exit(0);
+});

package/convex/_generated/api.d.ts

@@ -0,0 +1,175 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type * as agent_conversation from "../agent/conversation.js";
+import type * as agent_embeddingsCache from "../agent/embeddingsCache.js";
+import type * as agent_memory from "../agent/memory.js";
+import type * as aiChat from "../aiChat.js";
+import type * as aiTown_agent from "../aiTown/agent.js";
+import type * as aiTown_agentDescription from "../aiTown/agentDescription.js";
+import type * as aiTown_agentInputs from "../aiTown/agentInputs.js";
+import type * as aiTown_agentOperations from "../aiTown/agentOperations.js";
+import type * as aiTown_conversation from "../aiTown/conversation.js";
+import type * as aiTown_conversationMembership from "../aiTown/conversationMembership.js";
+import type * as aiTown_game from "../aiTown/game.js";
+import type * as aiTown_ids from "../aiTown/ids.js";
+import type * as aiTown_inputHandler from "../aiTown/inputHandler.js";
+import type * as aiTown_inputs from "../aiTown/inputs.js";
+import type * as aiTown_insertInput from "../aiTown/insertInput.js";
+import type * as aiTown_location from "../aiTown/location.js";
+import type * as aiTown_main from "../aiTown/main.js";
+import type * as aiTown_movement from "../aiTown/movement.js";
+import type * as aiTown_player from "../aiTown/player.js";
+import type * as aiTown_playerDescription from "../aiTown/playerDescription.js";
+import type * as aiTown_world from "../aiTown/world.js";
+import type * as aiTown_worldMap from "../aiTown/worldMap.js";
+import type * as chat from "../chat.js";
+import type * as constants from "../constants.js";
+import type * as crons from "../crons.js";
+import type * as engine_abstractGame from "../engine/abstractGame.js";
+import type * as engine_historicalObject from "../engine/historicalObject.js";
+import type * as http from "../http.js";
+import type * as init from "../init.js";
+import type * as messages from "../messages.js";
+import type * as npcCarAgents from "../npcCarAgents.js";
+import type * as streaming from "../streaming.js";
+import type * as testing from "../testing.js";
+import type * as util_FastIntegerCompression from "../util/FastIntegerCompression.js";
+import type * as util_assertNever from "../util/assertNever.js";
+import type * as util_asyncMap from "../util/asyncMap.js";
+import type * as util_compression from "../util/compression.js";
+import type * as util_geometry from "../util/geometry.js";
+import type * as util_isSimpleObject from "../util/isSimpleObject.js";
+import type * as util_llm from "../util/llm.js";
+import type * as util_minheap from "../util/minheap.js";
+import type * as util_object from "../util/object.js";
+import type * as util_sleep from "../util/sleep.js";
+import type * as util_types from "../util/types.js";
+import type * as util_xxhash from "../util/xxhash.js";
+import type * as world from "../world.js";
+
+import type {
+  ApiFromModules,
+  FilterApi,
+  FunctionReference,
+} from "convex/server";
+
+declare const fullApi: ApiFromModules<{
+  "agent/conversation": typeof agent_conversation;
+  "agent/embeddingsCache": typeof agent_embeddingsCache;
+  "agent/memory": typeof agent_memory;
+  aiChat: typeof aiChat;
+  "aiTown/agent": typeof aiTown_agent;
+  "aiTown/agentDescription": typeof aiTown_agentDescription;
+  "aiTown/agentInputs": typeof aiTown_agentInputs;
+  "aiTown/agentOperations": typeof aiTown_agentOperations;
+  "aiTown/conversation": typeof aiTown_conversation;
+  "aiTown/conversationMembership": typeof aiTown_conversationMembership;
+  "aiTown/game": typeof aiTown_game;
+  "aiTown/ids": typeof aiTown_ids;
+  "aiTown/inputHandler": typeof aiTown_inputHandler;
+  "aiTown/inputs": typeof aiTown_inputs;
+  "aiTown/insertInput": typeof aiTown_insertInput;
+  "aiTown/location": typeof aiTown_location;
+  "aiTown/main": typeof aiTown_main;
+  "aiTown/movement": typeof aiTown_movement;
+  "aiTown/player": typeof aiTown_player;
+  "aiTown/playerDescription": typeof aiTown_playerDescription;
+  "aiTown/world": typeof aiTown_world;
+  "aiTown/worldMap": typeof aiTown_worldMap;
+  chat: typeof chat;
+  constants: typeof constants;
+  crons: typeof crons;
+  "engine/abstractGame": typeof engine_abstractGame;
+  "engine/historicalObject": typeof engine_historicalObject;
+  http: typeof http;
+  init: typeof init;
+  messages: typeof messages;
+  npcCarAgents: typeof npcCarAgents;
+  streaming: typeof streaming;
+  testing: typeof testing;
+  "util/FastIntegerCompression": typeof util_FastIntegerCompression;
+  "util/assertNever": typeof util_assertNever;
+  "util/asyncMap": typeof util_asyncMap;
+  "util/compression": typeof util_compression;
+  "util/geometry": typeof util_geometry;
+  "util/isSimpleObject": typeof util_isSimpleObject;
+  "util/llm": typeof util_llm;
+  "util/minheap": typeof util_minheap;
+  "util/object": typeof util_object;
+  "util/sleep": typeof util_sleep;
+  "util/types": typeof util_types;
+  "util/xxhash": typeof util_xxhash;
+  world: typeof world;
+}>;
+
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export declare const api: FilterApi<
+  typeof fullApi,
+  FunctionReference<any, "public">
+>;
+
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export declare const internal: FilterApi<
+  typeof fullApi,
+  FunctionReference<any, "internal">
+>;
+
+export declare const components: {
+  persistentTextStreaming: {
+    lib: {
+      addChunk: FunctionReference<
+        "mutation",
+        "internal",
+        { final: boolean; streamId: string; text: string },
+        any
+      >;
+      createStream: FunctionReference<"mutation", "internal", {}, any>;
+      getStreamStatus: FunctionReference<
+        "query",
+        "internal",
+        { streamId: string },
+        "pending" | "streaming" | "done" | "error" | "timeout"
+      >;
+      getStreamText: FunctionReference<
+        "query",
+        "internal",
+        { streamId: string },
+        {
+          status: "pending" | "streaming" | "done" | "error" | "timeout";
+          text: string;
+        }
+      >;
+      setStreamStatus: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          status: "pending" | "streaming" | "done" | "error" | "timeout";
+          streamId: string;
+        },
+        any
+      >;
+    };
+  };
+};

package/convex/_generated/api.js

@@ -0,0 +1,23 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import { anyApi, componentsGeneric } from "convex/server";
+
+/**
+ * A utility for referencing Convex functions in your app's API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+export const internal = anyApi;
+export const components = componentsGeneric();

package/convex/_generated/dataModel.d.ts

@@ -0,0 +1,60 @@
+/* eslint-disable */
+/**
+ * Generated data model types.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type {
+  DataModelFromSchemaDefinition,
+  DocumentByName,
+  TableNamesInDataModel,
+  SystemTableNames,
+} from "convex/server";
+import type { GenericId } from "convex/values";
+import schema from "../schema.js";
+
+/**
+ * The names of all of your Convex tables.
+ */
+export type TableNames = TableNamesInDataModel<DataModel>;
+
+/**
+ * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Doc<TableName extends TableNames> = DocumentByName<
+  DataModel,
+  TableName
+>;
+
+/**
+ * An identifier for a document in Convex.
+ *
+ * Convex documents are uniquely identified by their `Id`, which is accessible
+ * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
+ *
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
+ *
+ * IDs are just strings at runtime, but this type can be used to distinguish them from other
+ * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Id<TableName extends TableNames | SystemTableNames> =
+  GenericId<TableName>;
+
+/**
+ * A type describing your Convex data model.
+ *
+ * This type includes information about what tables you have, the type of
+ * documents stored in those tables, and the indexes defined on them.
+ *
+ * This type is used to parameterize methods like `queryGeneric` and
+ * `mutationGeneric` to make them type-safe.
+ */
+export type DataModel = DataModelFromSchemaDefinition<typeof schema>;

package/convex/_generated/server.d.ts

@@ -0,0 +1,143 @@
+/* eslint-disable */
+/**
+ * Generated utilities for implementing server-side Convex query and mutation functions.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import {
+  ActionBuilder,
+  HttpActionBuilder,
+  MutationBuilder,
+  QueryBuilder,
+  GenericActionCtx,
+  GenericMutationCtx,
+  GenericQueryCtx,
+  GenericDatabaseReader,
+  GenericDatabaseWriter,
+} from "convex/server";
+import type { DataModel } from "./dataModel.js";
+
+/**
+ * Define a query in this Convex app's public API.
+ *
+ * This function will be allowed to read your Convex database and will be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export declare const query: QueryBuilder<DataModel, "public">;
+
+/**
+ * Define a query that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to read from your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The query function. It receives a {@link QueryCtx} as its first argument.
+ * @returns The wrapped query. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalQuery: QueryBuilder<DataModel, "internal">;
+
+/**
+ * Define a mutation in this Convex app's public API.
+ *
+ * This function will be allowed to modify your Convex database and will be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export declare const mutation: MutationBuilder<DataModel, "public">;
+
+/**
+ * Define a mutation that is only accessible from other Convex functions (but not from the client).
+ *
+ * This function will be allowed to modify your Convex database. It will not be accessible from the client.
+ *
+ * @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
+ * @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalMutation: MutationBuilder<DataModel, "internal">;
+
+/**
+ * Define an action in this Convex app's public API.
+ *
+ * An action is a function which can execute any JavaScript code, including non-deterministic
+ * code and code with side-effects, like calling third-party services.
+ * They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
+ * They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
+ *
+ * @param func - The action. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped action. Include this as an `export` to name it and make it accessible.
+ */
+export declare const action: ActionBuilder<DataModel, "public">;
+
+/**
+ * Define an action that is only accessible from other Convex functions (but not from the client).
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument.
+ * @returns The wrapped function. Include this as an `export` to name it and make it accessible.
+ */
+export declare const internalAction: ActionBuilder<DataModel, "internal">;
+
+/**
+ * Define an HTTP action.
+ *
+ * The wrapped function will be used to respond to HTTP requests received
+ * by a Convex deployment if the requests matches the path and method where
+ * this action is routed. Be sure to route your httpAction in `convex/http.js`.
+ *
+ * @param func - The function. It receives an {@link ActionCtx} as its first argument
+ * and a Fetch API `Request` object as its second.
+ * @returns The wrapped function. Import this function from `convex/http.js` and route it to hook it up.
+ */
+export declare const httpAction: HttpActionBuilder;
+
+/**
+ * A set of services for use within Convex query functions.
+ *
+ * The query context is passed as the first argument to any Convex query
+ * function run on the server.
+ *
+ * This differs from the {@link MutationCtx} because all of the services are
+ * read-only.
+ */
+export type QueryCtx = GenericQueryCtx<DataModel>;
+
+/**
+ * A set of services for use within Convex mutation functions.
+ *
+ * The mutation context is passed as the first argument to any Convex mutation
+ * function run on the server.
+ */
+export type MutationCtx = GenericMutationCtx<DataModel>;
+
+/**
+ * A set of services for use within Convex action functions.
+ *
+ * The action context is passed as the first argument to any Convex action
+ * function run on the server.
+ */
+export type ActionCtx = GenericActionCtx<DataModel>;
+
+/**
+ * An interface to read from the database within Convex query functions.
+ *
+ * The two entry points are {@link DatabaseReader.get}, which fetches a single
+ * document by its {@link Id}, or {@link DatabaseReader.query}, which starts
+ * building a query.
+ */
+export type DatabaseReader = GenericDatabaseReader<DataModel>;
+
+/**
+ * An interface to read from and write to the database within Convex mutation
+ * functions.
+ *
+ * Convex guarantees that all writes within a single mutation are
+ * executed atomically, so you never have to worry about partial writes leaving
+ * your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control)
+ * for the guarantees Convex provides your functions.
+ */
+export type DatabaseWriter = GenericDatabaseWriter<DataModel>;