@offworld/sdk 0.2.2 → 0.3.0

package/dist/config-DW8J4gl5.mjs

@@ -0,0 +1,174 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { ConfigSchema } from "@offworld/types";
+import { xdgConfig, xdgData, xdgState } from "xdg-basedir";
+import { homedir } from "node:os";
+
+//#region src/paths.ts
+/**
+* XDG-based directory paths for offworld CLI
+* Uses xdg-basedir package for cross-platform compatibility (Linux/macOS)
+*/
+const APP_NAME = "offworld";
+/**
+* Main namespace for all XDG-compliant paths
+*/
+const Paths = {
+	get config() {
+		return join(xdgConfig ?? join(homedir(), ".config"), APP_NAME);
+	},
+	get data() {
+		return join(xdgData ?? join(homedir(), ".local", "share"), APP_NAME);
+	},
+	get state() {
+		return join(xdgState ?? join(homedir(), ".local", "state"), APP_NAME);
+	},
+	get configFile() {
+		return join(this.config, "offworld.json");
+	},
+	get authFile() {
+		return join(this.data, "auth.json");
+	},
+	get metaDir() {
+		return join(this.data, "meta");
+	},
+	get defaultRepoRoot() {
+		return join(homedir(), "ow");
+	},
+	get offworldSkillDir() {
+		return join(this.data, "skill", "offworld");
+	},
+	get offworldReferencesDir() {
+		return join(this.offworldSkillDir, "references");
+	},
+	get offworldAssetsDir() {
+		return join(this.offworldSkillDir, "assets");
+	},
+	get offworldGlobalMapPath() {
+		return join(this.offworldAssetsDir, "map.json");
+	}
+};
+/**
+* Expands ~ to user's home directory (for backward compatibility)
+*/
+function expandTilde(path) {
+	if (path.startsWith("~/")) return join(homedir(), path.slice(2));
+	return path;
+}
+
+//#endregion
+//#region src/config.ts
+/**
+* Config utilities for path management and configuration loading
+*/
+/**
+* Returns the repository root directory.
+* Uses configured repoRoot or defaults to ~/ow
+*/
+function getMetaRoot() {
+	return Paths.data;
+}
+function getRepoRoot(config) {
+	return expandTilde(config?.repoRoot ?? Paths.defaultRepoRoot);
+}
+/**
+* Returns the path for a specific repository.
+* Format: {repoRoot}/{provider}/{owner}/{repo}
+*
+* @param fullName - The repo identifier in "owner/repo" format
+* @param provider - Git provider (defaults to "github")
+* @param config - Optional config for custom repoRoot
+*/
+function getRepoPath(fullName, provider = "github", config) {
+	const root = getRepoRoot(config);
+	const [owner, repo] = fullName.split("/");
+	if (!owner || !repo) throw new Error(`Invalid fullName format: ${fullName}. Expected "owner/repo"`);
+	return join(root, provider, owner, repo);
+}
+/**
+* Convert owner/repo format to meta directory name.
+* Collapses owner==repo (e.g., better-auth/better-auth -> better-auth)
+*/
+function toMetaDirName(repoName) {
+	if (repoName.includes("/")) {
+		const parts = repoName.split("/");
+		const owner = parts[0];
+		const repo = parts[1];
+		if (!owner || !repo) return repoName;
+		if (owner === repo) return repo;
+		return `${owner}-${repo}`;
+	}
+	return repoName;
+}
+/**
+* Convert owner/repo format to reference filename.
+* Collapses redundant owner/repo pairs by checking if repo name is contained in owner:
+* - honojs/hono -> hono.md (hono is in honojs)
+* - get-convex/convex-backend -> convex-backend.md (convex is in get-convex)
+* - tanstack/query -> tanstack-query.md (query is not in tanstack)
+*/
+function toReferenceFileName(repoName) {
+	if (repoName.includes("/")) {
+		const parts = repoName.split("/");
+		const owner = parts[0];
+		const repo = parts[1];
+		if (!owner || !repo) return `${repoName.toLowerCase()}.md`;
+		const ownerLower = owner.toLowerCase();
+		const repoLower = repo.toLowerCase();
+		if (repoLower.split("-").find((part) => part.length >= 3 && ownerLower.includes(part)) || ownerLower === repoLower) return `${repoLower}.md`;
+		return `${ownerLower}-${repoLower}.md`;
+	}
+	return `${repoName.toLowerCase()}.md`;
+}
+function toReferenceName(repoName) {
+	return toReferenceFileName(repoName).replace(/\.md$/, "");
+}
+function getReferencePath(fullName) {
+	return join(Paths.offworldReferencesDir, toReferenceFileName(fullName));
+}
+function getMetaPath(fullName) {
+	return join(Paths.data, "meta", toMetaDirName(fullName));
+}
+/**
+* Returns the path to the configuration file
+* Uses XDG Base Directory specification
+*/
+function getConfigPath() {
+	return Paths.configFile;
+}
+/**
+* Loads configuration from ~/.config/offworld/offworld.json
+* Returns defaults if file doesn't exist
+*/
+function loadConfig() {
+	const configPath = getConfigPath();
+	if (!existsSync(configPath)) return ConfigSchema.parse({});
+	try {
+		const content = readFileSync(configPath, "utf-8");
+		const data = JSON.parse(content);
+		return ConfigSchema.parse(data);
+	} catch {
+		return ConfigSchema.parse({});
+	}
+}
+/**
+* Saves configuration to ~/.config/offworld/offworld.json
+* Creates directory if it doesn't exist
+* Merges with existing config
+*/
+function saveConfig(updates) {
+	const configPath = getConfigPath();
+	const configDir = dirname(configPath);
+	if (!existsSync(configDir)) mkdirSync(configDir, { recursive: true });
+	const merged = {
+		...loadConfig(),
+		...updates
+	};
+	const validated = ConfigSchema.parse(merged);
+	writeFileSync(configPath, JSON.stringify(validated, null, 2), "utf-8");
+	return validated;
+}
+
+//#endregion
+export { getRepoPath as a, saveConfig as c, toReferenceName as d, Paths as f, getReferencePath as i, toMetaDirName as l, getMetaPath as n, getRepoRoot as o, expandTilde as p, getMetaRoot as r, loadConfig as s, getConfigPath as t, toReferenceFileName as u };
+//# sourceMappingURL=config-DW8J4gl5.mjs.map

package/dist/config-DW8J4gl5.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-DW8J4gl5.mjs","names":[],"sources":["../src/paths.ts","../src/config.ts"],"sourcesContent":["/**\n * XDG-based directory paths for offworld CLI\n * Uses xdg-basedir package for cross-platform compatibility (Linux/macOS)\n */\n\nimport { xdgConfig, xdgData, xdgState } from \"xdg-basedir\";\nimport { join } from \"node:path\";\nimport { homedir } from \"node:os\";\n\nconst APP_NAME = \"offworld\";\n\n/**\n * Main namespace for all XDG-compliant paths\n */\nexport const Paths = {\n\t/**\n\t * XDG_CONFIG_HOME/offworld\n\t * Fallback: ~/.config/offworld\n\t */\n\tget config(): string {\n\t\treturn join(xdgConfig ?? join(homedir(), \".config\"), APP_NAME);\n\t},\n\n\t/**\n\t * XDG_DATA_HOME/offworld\n\t * Fallback: ~/.local/share/offworld\n\t */\n\tget data(): string {\n\t\treturn join(xdgData ?? join(homedir(), \".local\", \"share\"), APP_NAME);\n\t},\n\n\t/**\n\t * XDG_STATE_HOME/offworld\n\t * Fallback: ~/.local/state/offworld\n\t */\n\tget state(): string {\n\t\treturn join(xdgState ?? join(homedir(), \".local\", \"state\"), APP_NAME);\n\t},\n\n\t/**\n\t * Configuration file path: ~/.config/offworld/offworld.json\n\t */\n\tget configFile(): string {\n\t\treturn join(this.config, \"offworld.json\");\n\t},\n\n\t/**\n\t * Auth file path: ~/.local/share/offworld/auth.json\n\t */\n\tget authFile(): string {\n\t\treturn join(this.data, \"auth.json\");\n\t},\n\n\t/**\n\t * Meta directory: ~/.local/share/offworld/meta\n\t */\n\tget metaDir(): string {\n\t\treturn join(this.data, \"meta\");\n\t},\n\n\t/**\n\t * Default repo root: ~/ow\n\t */\n\tget defaultRepoRoot(): string {\n\t\treturn join(homedir(), \"ow\");\n\t},\n\n\t/**\n\t * Offworld single-skill directory: ~/.local/share/offworld/skill/offworld\n\t */\n\tget offworldSkillDir(): string {\n\t\treturn join(this.data, \"skill\", \"offworld\");\n\t},\n\n\t/**\n\t * Offworld references directory: ~/.local/share/offworld/skill/offworld/references\n\t */\n\tget offworldReferencesDir(): string {\n\t\treturn join(this.offworldSkillDir, \"references\");\n\t},\n\n\t/**\n\t * Offworld assets directory: ~/.local/share/offworld/skill/offworld/assets\n\t */\n\tget offworldAssetsDir(): string {\n\t\treturn join(this.offworldSkillDir, \"assets\");\n\t},\n\n\t/**\n\t * Global map path: ~/.local/share/offworld/skill/offworld/assets/map.json\n\t */\n\tget offworldGlobalMapPath(): string {\n\t\treturn join(this.offworldAssetsDir, \"map.json\");\n\t},\n};\n\n/**\n * Expands ~ to user's home directory (for backward compatibility)\n */\nexport function expandTilde(path: string): string {\n\tif (path.startsWith(\"~/\")) {\n\t\treturn join(homedir(), path.slice(2));\n\t}\n\treturn path;\n}\n","/**\n * Config utilities for path management and configuration loading\n */\n\nimport { existsSync, mkdirSync, readFileSync, writeFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { ConfigSchema } from \"@offworld/types\";\nimport type { Config } from \"@offworld/types\";\nimport { Paths, expandTilde } from \"./paths\";\n\n/**\n * Returns the repository root directory.\n * Uses configured repoRoot or defaults to ~/ow\n */\nexport function getMetaRoot(): string {\n\treturn Paths.data;\n}\n\nexport function getRepoRoot(config?: Config): string {\n\tconst root = config?.repoRoot ?? Paths.defaultRepoRoot;\n\treturn expandTilde(root);\n}\n\n/**\n * Returns the path for a specific repository.\n * Format: {repoRoot}/{provider}/{owner}/{repo}\n *\n * @param fullName - The repo identifier in \"owner/repo\" format\n * @param provider - Git provider (defaults to \"github\")\n * @param config - Optional config for custom repoRoot\n */\nexport function getRepoPath(\n\tfullName: string,\n\tprovider: \"github\" | \"gitlab\" | \"bitbucket\" = \"github\",\n\tconfig?: Config,\n): string {\n\tconst root = getRepoRoot(config);\n\tconst [owner, repo] = fullName.split(\"/\");\n\tif (!owner || !repo) {\n\t\tthrow new Error(`Invalid fullName format: ${fullName}. Expected \"owner/repo\"`);\n\t}\n\treturn join(root, provider, owner, repo);\n}\n\n/**\n * Convert owner/repo format to meta directory name.\n * Collapses owner==repo (e.g., better-auth/better-auth -> better-auth)\n */\nexport function toMetaDirName(repoName: string): string {\n\tif (repoName.includes(\"/\")) {\n\t\tconst parts = repoName.split(\"/\");\n\t\tconst owner = parts[0];\n\t\tconst repo = parts[1];\n\t\tif (!owner || !repo) {\n\t\t\treturn repoName;\n\t\t}\n\t\tif (owner === repo) {\n\t\t\treturn repo;\n\t\t}\n\t\treturn `${owner}-${repo}`;\n\t}\n\treturn repoName;\n}\n\n/**\n * Convert owner/repo format to reference filename.\n * Collapses redundant owner/repo pairs by checking if repo name is contained in owner:\n * - honojs/hono -> hono.md (hono is in honojs)\n * - get-convex/convex-backend -> convex-backend.md (convex is in get-convex)\n * - tanstack/query -> tanstack-query.md (query is not in tanstack)\n */\nexport function toReferenceFileName(repoName: string): string {\n\tif (repoName.includes(\"/\")) {\n\t\tconst parts = repoName.split(\"/\");\n\t\tconst owner = parts[0];\n\t\tconst repo = parts[1];\n\t\tif (!owner || !repo) {\n\t\t\treturn `${repoName.toLowerCase()}.md`;\n\t\t}\n\t\tconst ownerLower = owner.toLowerCase();\n\t\tconst repoLower = repo.toLowerCase();\n\n\t\tconst repoParts = repoLower.split(\"-\");\n\t\tconst significantPart = repoParts.find((part) => part.length >= 3 && ownerLower.includes(part));\n\n\t\tif (significantPart || ownerLower === repoLower) {\n\t\t\treturn `${repoLower}.md`;\n\t\t}\n\n\t\treturn `${ownerLower}-${repoLower}.md`;\n\t}\n\treturn `${repoName.toLowerCase()}.md`;\n}\n\nexport function toReferenceName(repoName: string): string {\n\treturn toReferenceFileName(repoName).replace(/\\.md$/, \"\");\n}\n\nexport function getReferencePath(fullName: string): string {\n\treturn join(Paths.offworldReferencesDir, toReferenceFileName(fullName));\n}\n\nexport function getMetaPath(fullName: string): string {\n\treturn join(Paths.data, \"meta\", toMetaDirName(fullName));\n}\n\n/**\n * Returns the path to the configuration file\n * Uses XDG Base Directory specification\n */\nexport function getConfigPath(): string {\n\treturn Paths.configFile;\n}\n\n/**\n * Loads configuration from ~/.config/offworld/offworld.json\n * Returns defaults if file doesn't exist\n */\nexport function loadConfig(): Config {\n\tconst configPath = getConfigPath();\n\n\tif (!existsSync(configPath)) {\n\t\treturn ConfigSchema.parse({});\n\t}\n\n\ttry {\n\t\tconst content = readFileSync(configPath, \"utf-8\");\n\t\tconst data = JSON.parse(content);\n\t\treturn ConfigSchema.parse(data);\n\t} catch {\n\t\treturn ConfigSchema.parse({});\n\t}\n}\n\n/**\n * Saves configuration to ~/.config/offworld/offworld.json\n * Creates directory if it doesn't exist\n * Merges with existing config\n */\nexport function saveConfig(updates: Partial<Config>): Config {\n\tconst configPath = getConfigPath();\n\tconst configDir = dirname(configPath);\n\n\tif (!existsSync(configDir)) {\n\t\tmkdirSync(configDir, { recursive: true });\n\t}\n\n\tconst existing = loadConfig();\n\tconst merged = { ...existing, ...updates };\n\n\tconst validated = ConfigSchema.parse(merged);\n\n\twriteFileSync(configPath, JSON.stringify(validated, null, 2), \"utf-8\");\n\n\treturn validated;\n}\n"],"mappings":";;;;;;;;;;;AASA,MAAM,WAAW;;;;AAKjB,MAAa,QAAQ;CAKpB,IAAI,SAAiB;AACpB,SAAO,KAAK,aAAa,KAAK,SAAS,EAAE,UAAU,EAAE,SAAS;;CAO/D,IAAI,OAAe;AAClB,SAAO,KAAK,WAAW,KAAK,SAAS,EAAE,UAAU,QAAQ,EAAE,SAAS;;CAOrE,IAAI,QAAgB;AACnB,SAAO,KAAK,YAAY,KAAK,SAAS,EAAE,UAAU,QAAQ,EAAE,SAAS;;CAMtE,IAAI,aAAqB;AACxB,SAAO,KAAK,KAAK,QAAQ,gBAAgB;;CAM1C,IAAI,WAAmB;AACtB,SAAO,KAAK,KAAK,MAAM,YAAY;;CAMpC,IAAI,UAAkB;AACrB,SAAO,KAAK,KAAK,MAAM,OAAO;;CAM/B,IAAI,kBAA0B;AAC7B,SAAO,KAAK,SAAS,EAAE,KAAK;;CAM7B,IAAI,mBAA2B;AAC9B,SAAO,KAAK,KAAK,MAAM,SAAS,WAAW;;CAM5C,IAAI,wBAAgC;AACnC,SAAO,KAAK,KAAK,kBAAkB,aAAa;;CAMjD,IAAI,oBAA4B;AAC/B,SAAO,KAAK,KAAK,kBAAkB,SAAS;;CAM7C,IAAI,wBAAgC;AACnC,SAAO,KAAK,KAAK,mBAAmB,WAAW;;CAEhD;;;;AAKD,SAAgB,YAAY,MAAsB;AACjD,KAAI,KAAK,WAAW,KAAK,CACxB,QAAO,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,CAAC;AAEtC,QAAO;;;;;;;;;;;;ACzFR,SAAgB,cAAsB;AACrC,QAAO,MAAM;;AAGd,SAAgB,YAAY,QAAyB;AAEpD,QAAO,YADM,QAAQ,YAAY,MAAM,gBACf;;;;;;;;;;AAWzB,SAAgB,YACf,UACA,WAA8C,UAC9C,QACS;CACT,MAAM,OAAO,YAAY,OAAO;CAChC,MAAM,CAAC,OAAO,QAAQ,SAAS,MAAM,IAAI;AACzC,KAAI,CAAC,SAAS,CAAC,KACd,OAAM,IAAI,MAAM,4BAA4B,SAAS,yBAAyB;AAE/E,QAAO,KAAK,MAAM,UAAU,OAAO,KAAK;;;;;;AAOzC,SAAgB,cAAc,UAA0B;AACvD,KAAI,SAAS,SAAS,IAAI,EAAE;EAC3B,MAAM,QAAQ,SAAS,MAAM,IAAI;EACjC,MAAM,QAAQ,MAAM;EACpB,MAAM,OAAO,MAAM;AACnB,MAAI,CAAC,SAAS,CAAC,KACd,QAAO;AAER,MAAI,UAAU,KACb,QAAO;AAER,SAAO,GAAG,MAAM,GAAG;;AAEpB,QAAO;;;;;;;;;AAUR,SAAgB,oBAAoB,UAA0B;AAC7D,KAAI,SAAS,SAAS,IAAI,EAAE;EAC3B,MAAM,QAAQ,SAAS,MAAM,IAAI;EACjC,MAAM,QAAQ,MAAM;EACpB,MAAM,OAAO,MAAM;AACnB,MAAI,CAAC,SAAS,CAAC,KACd,QAAO,GAAG,SAAS,aAAa,CAAC;EAElC,MAAM,aAAa,MAAM,aAAa;EACtC,MAAM,YAAY,KAAK,aAAa;AAKpC,MAHkB,UAAU,MAAM,IAAI,CACJ,MAAM,SAAS,KAAK,UAAU,KAAK,WAAW,SAAS,KAAK,CAAC,IAExE,eAAe,UACrC,QAAO,GAAG,UAAU;AAGrB,SAAO,GAAG,WAAW,GAAG,UAAU;;AAEnC,QAAO,GAAG,SAAS,aAAa,CAAC;;AAGlC,SAAgB,gBAAgB,UAA0B;AACzD,QAAO,oBAAoB,SAAS,CAAC,QAAQ,SAAS,GAAG;;AAG1D,SAAgB,iBAAiB,UAA0B;AAC1D,QAAO,KAAK,MAAM,uBAAuB,oBAAoB,SAAS,CAAC;;AAGxE,SAAgB,YAAY,UAA0B;AACrD,QAAO,KAAK,MAAM,MAAM,QAAQ,cAAc,SAAS,CAAC;;;;;;AAOzD,SAAgB,gBAAwB;AACvC,QAAO,MAAM;;;;;;AAOd,SAAgB,aAAqB;CACpC,MAAM,aAAa,eAAe;AAElC,KAAI,CAAC,WAAW,WAAW,CAC1B,QAAO,aAAa,MAAM,EAAE,CAAC;AAG9B,KAAI;EACH,MAAM,UAAU,aAAa,YAAY,QAAQ;EACjD,MAAM,OAAO,KAAK,MAAM,QAAQ;AAChC,SAAO,aAAa,MAAM,KAAK;SACxB;AACP,SAAO,aAAa,MAAM,EAAE,CAAC;;;;;;;;AAS/B,SAAgB,WAAW,SAAkC;CAC5D,MAAM,aAAa,eAAe;CAClC,MAAM,YAAY,QAAQ,WAAW;AAErC,KAAI,CAAC,WAAW,UAAU,CACzB,WAAU,WAAW,EAAE,WAAW,MAAM,CAAC;CAI1C,MAAM,SAAS;EAAE,GADA,YAAY;EACC,GAAG;EAAS;CAE1C,MAAM,YAAY,aAAa,MAAM,OAAO;AAE5C,eAAc,YAAY,KAAK,UAAU,WAAW,MAAM,EAAE,EAAE,QAAQ;AAEtE,QAAO"}

package/dist/convex/_generated/api.d.ts

@@ -0,0 +1,67 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type * as admin from "../admin.js";
+import type * as auth from "../auth.js";
+import type * as github from "../github.js";
+import type * as http from "../http.js";
+import type * as lib_githubAuth from "../lib/githubAuth.js";
+import type * as references from "../references.js";
+import type * as repository from "../repository.js";
+import type * as validation_github from "../validation/github.js";
+import type * as validation_push from "../validation/push.js";
+import type * as validation_referenceContent from "../validation/referenceContent.js";
+
+import type {
+  ApiFromModules,
+  FilterApi,
+  FunctionReference,
+} from "convex/server";
+
+declare const fullApi: ApiFromModules<{
+  admin: typeof admin;
+  auth: typeof auth;
+  github: typeof github;
+  http: typeof http;
+  "lib/githubAuth": typeof lib_githubAuth;
+  references: typeof references;
+  repository: typeof repository;
+  "validation/github": typeof validation_github;
+  "validation/push": typeof validation_push;
+  "validation/referenceContent": typeof validation_referenceContent;
+}>;
+
+/**
+ * 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: {};

package/dist/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/dist/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/dist/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>;

package/dist/convex/_generated/server.js

@@ -0,0 +1,93 @@
+/* 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 {
+  actionGeneric,
+  httpActionGeneric,
+  queryGeneric,
+  mutationGeneric,
+  internalActionGeneric,
+  internalMutationGeneric,
+  internalQueryGeneric,
+} from "convex/server";
+
+/**
+ * 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 const query = queryGeneric;
+
+/**
+ * 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 const internalQuery = internalQueryGeneric;
+
+/**
+ * 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 const mutation = mutationGeneric;
+
+/**
+ * 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 const internalMutation = internalMutationGeneric;
+
+/**
+ * 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 const action = actionGeneric;
+
+/**
+ * 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 const internalAction = internalActionGeneric;
+
+/**
+ * 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 const httpAction = httpActionGeneric;