convex 1.47.0 → 1.48.0

package/src/server/impl/authentication_impl.ts

@@ -1,4 +1,5 @@
-import { Auth } from "../authentication.js";
+import { Auth, MutationAuth } from "../authentication.js";
+import { version } from "../../index.js";
 import { performAsyncSyscall } from "./syscall.js";
 
 export function setupAuth(requestId: string): Auth {
@@ -10,3 +11,16 @@ export function setupAuth(requestId: string): Auth {
     },
   };
 }
+
+export function setupMutationAuth(requestId: string): MutationAuth {
+  return {
+    ...setupAuth(requestId),
+    signJwt: async (options) => {
+      return await performAsyncSyscall("1.0/signJwt", {
+        requestId,
+        version,
+        ...options,
+      });
+    },
+  };
+}

package/src/server/impl/registration_impl.ts

@@ -24,7 +24,7 @@ import {
 } from "../registration.js";
 import { setupActionCalls } from "./actions_impl.js";
 import { setupActionVectorSearch } from "./vector_search_impl.js";
-import { setupAuth } from "./authentication_impl.js";
+import { setupAuth, setupMutationAuth } from "./authentication_impl.js";
 import { setupReader, setupWriter } from "./database_impl.js";
 import { QueryImpl, QueryInitializerImpl } from "./query_impl.js";
 import {
@@ -55,7 +55,7 @@ async function invokeMutation<
   const args = jsonToConvex(JSON.parse(argsStr));
   const mutationCtx = {
     db: setupWriter(),
-    auth: setupAuth(requestId),
+    auth: setupMutationAuth(requestId),
     storage: setupStorageWriter(requestId),
     scheduler: setupMutationScheduler(),
     meta: setupMutationMeta(visibility),

package/src/server/index.ts

@@ -55,7 +55,12 @@ export type {
   Auth,
   AuthConfig,
   AuthProvider,
+  MutationAuth,
   UserIdentity,
+  ReservedJwtClaim,
+  ReservedJwtClaimPrefix,
+  SignJwtClaims,
+  SignJwtOptions,
   UserIdentityAttributes,
 } from "./authentication.js";
 export * from "./database.js";
@@ -209,6 +214,7 @@ export type {
   ComponentDefinition,
   AnyComponents,
   FunctionHandle,
+  FunctionHandle_future,
 } from "./components/index.js";
 
 /**

package/src/server/meta.ts

@@ -26,13 +26,9 @@ export type TransactionMetrics = {
   documentsWritten: TransactionMetric;
   functionsScheduled: TransactionMetric;
   scheduledFunctionArgsBytes: TransactionMetric;
-  /** @internal */
   filesWritten: TransactionMetric;
-  /** @internal */
   fileWriteBytes: TransactionMetric;
-  /** @internal */
   filesRead: TransactionMetric;
-  /** @internal */
   fileReadBytes: TransactionMetric;
 };
 
@@ -51,13 +47,9 @@ export interface TransactionLimits {
   documentsWritten?: number;
   functionsScheduled?: number;
   scheduledFunctionArgsBytes?: number;
-  /** @internal */
   filesWritten?: number;
-  /** @internal */
   fileWriteBytes?: number;
-  /** @internal */
   filesRead?: number;
-  /** @internal */
   fileReadBytes?: number;
 }
 

package/src/server/registration.ts

@@ -1,5 +1,6 @@
 import {
   Auth,
+  MutationAuth,
   GenericDatabaseReader,
   GenericDatabaseReaderWithTable,
   GenericDatabaseWriter,
@@ -87,12 +88,14 @@ export interface GenericMutationCtx<DataModel extends GenericDataModel> {
   db: GenericDatabaseWriter<DataModel>;
 
   /**
-   * Information about the currently authenticated user.
+   * Auth functionality for mutations.
    *
    * Call `await ctx.auth.getUserIdentity()` to get the current user's identity,
    * or `null` if the user is not authenticated.
+   *
+   * `ctx.auth.signJwt` is available for creating deployment issued JWTs.
    */
-  auth: Auth;
+  auth: MutationAuth;
 
   /**
    * A utility for reading and writing files in storage.

package/src/server/schema.ts

@@ -226,8 +226,6 @@ export class TableDefinition<
    *
    * Returns indexes defined on this table.
    * Intended for the advanced use cases of dynamically deciding which index to use for a query.
-   * If you think you need this, please chime in on ths issue in the Convex JS GitHub repo.
-   * https://github.com/get-convex/convex-js/issues/49
    */
   " indexes"(): { indexDescriptor: string; fields: string[] }[] {
     return this.indexes;

package/src/server/storage.ts

@@ -133,9 +133,9 @@ export interface StorageReader {
 }
 
 /**
- * An interface to write files to storage within Convex mutation functions.
+ * An interface to read and write files to storage within Convex mutation functions.
  *
- * Available as `ctx.storage` in mutations.
+ * Available as `ctx.storage` in mutations, actions, and HTTP actions.
  *
  * @see https://docs.convex.dev/file-storage
  * @public
@@ -195,46 +195,12 @@ export interface StorageWriter extends StorageReader {
     storageId: T extends { __tableName: any } ? never : T,
   ): Promise<void>;
 
-  /**
-   * @internal
-   */
-  // TODO: move `store` from StorageActionWriter to StorageWriter when mutation
-  // file storage access is ready for release
-  store(
-    blob: Blob,
-    options?: { sha256?: string },
-  ): Promise<GenericId<"_storage">>;
-
-  /**
-   * @internal
-   */
-  // TODO: move `get` from StorageActionWriter to StorageWriter when mutation
-  // file storage access is ready for release
-  get(storageId: GenericId<"_storage">): Promise<Blob | null>;
-}
-
-/**
- * An interface to read and write files to storage within Convex actions and HTTP actions.
- *
- * In actions, `ctx.storage` has additional methods not available in mutations:
- * `get()` to download a file as a Blob, and `store()` to upload a Blob directly.
- *
- * @example
- * ```typescript
- * // In an action, download and re-upload a file:
- * const blob = await ctx.storage.get(storageId);
- * if (blob) {
- *   const newStorageId = await ctx.storage.store(blob);
- * }
- * ```
- *
- * @public
- */
-export interface StorageActionWriter extends StorageWriter {
   /**
    * Download a file from storage as a Blob.
    *
-   * Only available in actions and HTTP actions (not in mutations or queries).
+   * In mutations, files read count toward the transaction's `filesRead` and
+   * `fileReadBytes` limits. Use
+   * `ctx.meta.getTransactionMetrics()` to check the remaining headroom.
    *
    * @param storageId - The `Id<"_storage">` of the file.
    * @returns A Blob containing the file contents, or `null` if the file doesn't exist.
@@ -249,16 +215,21 @@ export interface StorageActionWriter extends StorageWriter {
   get<T extends StorageId>(
     storageId: T extends { __tableName: any } ? never : T,
   ): Promise<Blob | null>;
+
   /**
    * Upload a Blob directly to storage.
    *
-   * Only available in actions and HTTP actions. For client-side uploads from
-   * mutations, use `generateUploadUrl()` instead.
+   * To upload files from a client, use {@link StorageWriter.generateUploadUrl}
+   * instead.
+   *
+   * In mutations, files stored count toward the transaction's `filesWritten`
+   * and `fileWriteBytes` limits. Use
+   * `ctx.meta.getTransactionMetrics()` to check the remaining headroom.
    *
    * @example
    * ```typescript
    * const storageId = await ctx.storage.store(blob);
-   * // Save storageId to the database via ctx.runMutation
+   * // If in an action, save storageId to the database via ctx.runMutation
    * ```
    *
    * @param blob - The Blob to store.
@@ -270,3 +241,19 @@ export interface StorageActionWriter extends StorageWriter {
     options?: { sha256?: string },
   ): Promise<GenericId<"_storage">>;
 }
+
+/**
+ * An interface to read and write files to storage within Convex actions and HTTP actions.
+ *
+ * @example
+ * ```typescript
+ * // In an action, download and re-upload a file:
+ * const blob = await ctx.storage.get(storageId);
+ * if (blob) {
+ *   const newStorageId = await ctx.storage.store(blob);
+ * }
+ * ```
+ *
+ * @public
+ */
+export interface StorageActionWriter extends StorageWriter {}