safebyok-convex 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,189 @@
-# Temporary Holding Version
+# safebyok-convex
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+safebyok's storage on [Convex](https://convex.dev): a Convex **component** that holds each vault's
+bundle and lockboxes, ciphertext and public fields only, in tables of its own, and
+**`convexVaultDB`**, the client side a vault stores through. Your Convex backend never sees a
+whisper, a passphrase, or any key that opens one.
+
+## Install
+
+```sh
+pnpm add safebyok safebyok-convex convex
+```
+
+`safebyok` and `convex` are peer dependencies: your app installs them itself, so the adapter and
+your app share one copy of each, and a `VaultError` from one is a `VaultError` to the other.
+
+## What your app adds to its `convex/` directory
+
+Install the component, in `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from 'convex/server'
+import safebyok from 'safebyok-convex/convex.config'
+
+const app = defineApp()
+app.use(safebyok)
+export default app
+```
+
+Serve its functions to your clients, from a module of your own, `convex/safebyok.ts`. They call
+your `getUserId` first: say who is signed in, the same id your app passes to `openVault` as
+`userId`.
+
+```ts
+import { SafebyokComponent } from 'safebyok-convex/server'
+import { components } from './_generated/api'
+
+export const {
+  getBundle, createBundle, updateBundle, getBox, listBoxSummaries,
+  updateBox, eraseBox, eraseVault, watchVault,
+} = new SafebyokComponent(components.safebyok).api({
+  getUserId: async (ctx) => (await ctx.auth.getUserIdentity())?.subject ?? null,
+})
+```
+
+Run your usual Convex codegen, and your clients reach these as `api.safebyok.*`.
+
+* **Who may reach a vault.** Each function refuses a caller who is signed out (`getUserId`
+  answers null, undefined or empty), or whose id is not the vault's `user_id`, with a
+  `ConvexError` whose `data` is `{ kind: 'not_permitted', message }`. The kind is the safebyok
+  `VaultError` kind of the same name. The message names no user and quotes no record.
+* **Writes that come too late.** An update (`updateBundle`, `updateBox`) or an erase
+  (`eraseBox`, `eraseVault`) carries what its writer expects to stand -- the vault's `vault_id`,
+  and the bundle's `passphrase_epoch` or the lockbox's `revision_id` -- and checks it in the same
+  transaction it writes in. When that no longer stands, it writes nothing and resolves `false`,
+  which the client turns into a `stale_write`. Not an error: no `ConvexError`, nothing in your logs.
+
+## What your app does on the client
+
+`convexVaultDB(client, api.safebyok)`, from `safebyok-convex`, is a vault's storage: a `VaultDB`
+whose every call is one call to the functions above, through the Convex client your app already
+has. Hand it to `openVault`:
+
+```ts
+import { ConvexClient } from 'convex/browser'
+import { openVault } from 'safebyok'
+import { browserOpts } from 'safebyok/browser'
+import { convexVaultDB } from 'safebyok-convex'
+import { api } from '../convex/_generated/api'
+
+const convex = new ConvexClient(import.meta.env.VITE_CONVEX_URL)
+convex.setAuth(fetchToken) // your auth provider's token, as for any Convex call
+
+const vault = await openVault({
+  applabel: 'acme', userId, vaultlabel: 'main',
+  vaultDB:  convexVaultDB(convex, api.safebyok),
+  ...browserOpts(), // the key deriver and device store a browser wants
+})
+```
+
+In a React app, pass the `ConvexReactClient` you give `ConvexProvider`, so the vault shares its
+socket and its signed-in user. `safebyok-convex` itself imports nothing of React's.
+
+* **Sign in first.** `userId` is the id your `getUserId` answers for the signed-in user. Open
+  the vault once the Convex client is authenticated (in React, once `useConvexAuth()` says so):
+  a call made before then is refused with kind `not_permitted`.
+* **Close the vault when the user signs out.** Signing out of Convex does not lock it: every
+  call it makes is refused from then on, but the unlocked vaultKey stays in memory until the
+  vault locks, expires or closes.
+* **Other devices' writes arrive live.** The vault watches `watchVault` and refreshes whenever
+  it changes, so its snapshot (and a React render) follows writes from anywhere.
+* **Refusals** are `VaultError`s: `not_permitted` (signed out, or not this user's vault);
+  `stale_write` (another device changed the vault first: the vault has already caught up, so
+  read again before retrying); and `storage_unavailable` for anything else Convex reported, with
+  Convex's own error as its `cause`.
+* **Offline, a call waits** for the connection, as every Convex call does, rather than failing.
+  Convex resends a mutation when it reconnects, so a write may land after any timeout you set:
+  show progress, but don't report it failed.
+* A record holds at most 1 MiB, Convex's document limit; `openVault` keeps `maxWhisperBytes`
+  under half of it. A vault holds at most 8 MiB in all (`maxVaultBytes`; see *How big a vault
+  can be*).
+
+## What is stored
+
+Two tables, inside the component, beside nothing of your app's:
+
+| Table                | One row per | Columns                                                         | Index                                                |
+| -------------------- | ----------- | --------------------------------------------------------------- | ---------------------------------------------------- |
+| `safebyok_bundles`   | vault       | the `VaultBundle` record as-is                                  | `by_scope`: `user_id`, `applabel`, `vaultlabel`      |
+| `safebyok_lockboxes` | lockbox     | the `Lockbox` record as-is, and its vault's scope columns       | `by_box`: `user_id`, `applabel`, `vaultlabel`, `boxlabel` |
+
+* **Encrypted**, as `{ cipher_iv_b64, ciphertext_b64 }`: each whisper (`whisper_ciphered`), each
+  lockbox's lockboxKey (`lockbox_key_wrapped`), and the vaultKey (`vault_key_passphrase_wrapped`).
+* **In the open**: the scope (`applabel`, `user_id`, `vaultlabel`), each `boxlabel` and `note`,
+  the `vault_id`, `passphrase_epoch`, `revision_id`s, the passphraseSalt and key deriver's label,
+  timestamps, and the length of every ciphertext.
+* **Never**: a whisper, a passphrase, any key in usable form, or the device-local remembered
+  unlock. No history: an update replaces its row. (Convex's own backups and exports keep what
+  they keep.)
+* `user_id` leads both indexes, so one user's rows are one range of each.
+
+**How big a vault can be.** Listing a vault, watching it and erasing it each read the whole vault
+in one Convex transaction, which may read 16 MiB; erasing reads it twice, so `convexVaultDB`
+declares a `maxVaultBytes` of 8 MiB. A vault holds 100 lockboxes by default, raised with
+`maxLockboxes` as far as `maxVaultBytes` allows: `openVault` refuses, with kind `bad_option`, a
+`maxLockboxes` whose lockboxes at `maxWhisperBytes` each might not fit, and its message says how
+many would. At the default `maxWhisperBytes` (40444) that is at most 101; at a `maxWhisperBytes`
+of 2048, ample for API keys, it is 1365. A store past the limit is refused with kind
+`vault_full`, until a lockbox is erased. Each record must also fit Convex's 1 MiB document limit,
+which the core's `maxWhisperBytes` keeps well inside.
+
+## The functions
+
+Each is one `VaultDB` verb (the core's storage interface). Arguments and results are plain JSON:
+the core's own records, scopes and expectations.
+
+| Function           | Kind     | Arguments                                   | Resolves                                              |
+| ------------------ | -------- | ------------------------------------------- | ----------------------------------------------------- |
+| `getBundle`        | query    | `{ scope }`                                 | the `VaultBundle`, or null                            |
+| `createBundle`     | mutation | `{ bundle }`                                | the bundle standing after: this one, or the first one |
+| `updateBundle`     | mutation | `{ bundle, expected: { vault_id, passphrase_epoch } }` | `true` if written, `false` if not           |
+| `getBox`           | query    | `{ scope, boxlabel }`                       | the `Lockbox`, or null                                |
+| `listBoxSummaries` | query    | `{ scope }`                                 | each lockbox without its ciphered fields, `format` kept, in boxlabel order |
+| `updateBox`        | mutation | `{ scope, lockbox, expected: { vault_id, revision_id } }` | `true` if written, `false` if not        |
+| `eraseBox`         | mutation | `{ scope, boxlabel, expected: { vault_id } }` | `true` if the vault still stands (box or none), `false` if not |
+| `eraseVault`       | mutation | `{ scope, expected: { vault_id } }`         | `true` if erased, `false` if not                      |
+| `watchVault`       | query    | `{ scope }`                                 | `{ vault_id, passphrase_epoch, boxes: [[boxlabel, revision_id]] }`, changing with every write |
+
+`scope` is `{ applabel, user_id, vaultlabel }`. A `revision_id` of null expects no lockbox there.
+
+## Testing your own functions
+
+`safebyok-convex/test` installs the component into a [`convex-test`](https://docs.convex.dev/testing/convex-test)
+instance. It assumes vitest, or another runner on Vite: it loads the component's modules with
+`import.meta.glob`.
+
+```ts
+import { register } from 'safebyok-convex/test'
+
+const t = convexTest(schema, modules)
+register(t)
+```
+
+## Developing this package
+
+`pnpm justify` here runs its lint, typecheck, tests -- `convex-test` under the edge runtime,
+in memory, with no deployment -- and the build with its publint and arethetypeswrong checks. The typecheck and lint read `safebyok` from its source, through
+the workspace's `@safebyok/source` export condition, so they need no build. The tests resolve it
+through its built `dist/`, as a consumer's would, and make real vaults with the core's own code;
+they build the core first by themselves (`pnpm build:deps`), so a fresh clone needs no prebuild
+step.
+
+The client's tests run the real `ConvexClient` and `ConvexReactClient` against
+`tests/fake-deployment.ts`: a fake WebSocket that answers the sync protocol's query and mutation
+messages from `convex-test`. It runs one call at a time, reruns every watched query after each
+mutation, and signs each socket in as one user from the start; its doc block says what that
+cannot prove.
+
+The build follows Convex's component template: ESM only, unbundled, so each of the component's
+modules keeps its own file under `dist/component/`, beside its `convex.config.js` and
+`_generated/`, for a host's Convex CLI to bundle at deploy. `safebyok-convex/test` alone ships as
+source, `src/test.ts`, since its `import.meta.glob` must find the component's `.ts` modules; a
+test runner that resolves as a bundler does (vitest) loads it.
+
+`src/component/_generated/` holds Convex's codegen output for the component, written by the
+templates of the installed `convex` and never edited by hand. Codegen for a component needs a
+Convex deployment, so until one has run it holds only the files Convex writes without one
+(`server.ts`, `dataModel.ts`, and the untyped stub `api.ts`); the component's typed API,
+`ComponentApi`, is derived from the functions themselves in `src/component-api.ts`.

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll };

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

@@ -0,0 +1,7 @@
+import { AnyApi, AnyComponents } from "convex/server";
+//#region src/component/_generated/api.d.ts
+export declare const api: AnyApi;
+export declare const internal: AnyApi;
+export declare const components: AnyComponents;
+//#endregion
+//# sourceMappingURL=api.d.ts.map

package/dist/component/_generated/api.js

@@ -0,0 +1,9 @@
+import { anyApi, componentsGeneric } from "convex/server";
+//#region src/component/_generated/api.ts
+const api = anyApi;
+const internal = anyApi;
+const components = componentsGeneric();
+//#endregion
+export { api, components, internal };
+
+//# sourceMappingURL=api.js.map

package/dist/component/_generated/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","names":[],"sources":["../../../src/component/_generated/api.ts"],"sourcesContent":["/* eslint-disable */\n/**\n * Generated `api` utility.\n *\n * THIS CODE IS AUTOMATICALLY GENERATED.\n *\n * To regenerate, run `npx convex dev`.\n * @module\n */\n\nimport type { AnyApi, AnyComponents } from \"convex/server\";\nimport { anyApi, componentsGeneric } from \"convex/server\";\n\nexport const api: AnyApi = anyApi;\nexport const internal: AnyApi = anyApi;\nexport const components: AnyComponents = componentsGeneric();\n"],"mappings":";;AAaA,MAAa,MAAc;AAC3B,MAAa,WAAmB;AAChC,MAAa,aAA4B,kBAAkB"}

package/dist/component/_generated/dataModel.d.ts

@@ -0,0 +1,40 @@
+import _default from "../schema.js";
+import { DataModelFromSchemaDefinition, DocumentByName, SystemTableNames, TableNamesInDataModel } from "convex/server";
+import { GenericId } from "convex/values";
+//#region src/component/_generated/dataModel.d.ts
+/**
+ * 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 _default>;
+//#endregion
+//# sourceMappingURL=dataModel.d.ts.map

package/dist/component/_generated/server.d.ts

@@ -0,0 +1,127 @@
+import { DataModel } from "./dataModel.js";
+import { ActionBuilder, GenericActionCtx, GenericDatabaseReader, GenericDatabaseWriter, GenericMutationCtx, GenericQueryCtx, HttpActionBuilder, MutationBuilder, QueryBuilder } from "convex/server";
+//#region src/component/_generated/server.d.ts
+/**
+ * Typesafe environment variables.
+ *
+ * This includes platform-provided env vars and any variables declared in
+ * `convex.config.ts`.
+ */
+type Env = {
+  readonly CONVEX_CLOUD_URL: string;
+  readonly CONVEX_SITE_URL: string;
+};
+/**
+ * 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;
+export declare const env: Env;
+/**
+ * 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.
+ *
+ * If you're using code generation, use the `QueryCtx` type in `convex/_generated/server.d.ts` instead.
+ */
+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.
+ *
+ * If you're using code generation, use the `MutationCtx` type in `convex/_generated/server.d.ts` instead.
+ */
+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>;
+//#endregion
+export {};
+//# sourceMappingURL=server.d.ts.map