@robelest/convex-auth 0.0.2-preview.2 → 0.0.3-preview

package/src/component/_generated/component.ts

@@ -23,6 +23,56 @@ import type { FunctionReference } from "convex/server";
  */
 export type ComponentApi<Name extends string | undefined = string | undefined> =
   {
+    portalBridge: {
+      gcOldAssets: FunctionReference<
+        "mutation",
+        "internal",
+        { currentDeploymentId: string },
+        any,
+        Name
+      >;
+      getByPath: FunctionReference<
+        "query",
+        "internal",
+        { path: string },
+        any,
+        Name
+      >;
+      getCurrentDeployment: FunctionReference<
+        "query",
+        "internal",
+        {},
+        any,
+        Name
+      >;
+      listAssets: FunctionReference<
+        "query",
+        "internal",
+        { limit?: number },
+        any,
+        Name
+      >;
+      recordAsset: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          blobId?: string;
+          contentType: string;
+          deploymentId: string;
+          path: string;
+          storageId?: string;
+        },
+        any,
+        Name
+      >;
+      setCurrentDeployment: FunctionReference<
+        "mutation",
+        "internal",
+        { deploymentId: string },
+        null,
+        Name
+      >;
+    };
     public: {
       accountDelete: FunctionReference<
         "mutation",
@@ -57,6 +107,13 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      accountListByUser: FunctionReference<
+        "query",
+        "internal",
+        { userId: string },
+        any,
+        Name
+      >;
       accountPatch: FunctionReference<
         "mutation",
         "internal",
@@ -102,7 +159,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
       inviteAccept: FunctionReference<
         "mutation",
         "internal",
-        { inviteId: string },
+        { acceptedByUserId?: string; inviteId: string },
         any,
         Name
       >;
@@ -110,11 +167,11 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         "mutation",
         "internal",
         {
-          email: string;
-          expiresTime: number;
+          email?: string;
+          expiresTime?: number;
           extend?: any;
           groupId?: string;
-          invitedByUserId: string;
+          invitedByUserId?: string;
           role?: string;
           status: "pending" | "accepted" | "revoked" | "expired";
           tokenHash: string;
@@ -129,6 +186,13 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      inviteGetByTokenHash: FunctionReference<
+        "query",
+        "internal",
+        { tokenHash: string },
+        any,
+        Name
+      >;
       inviteList: FunctionReference<
         "query",
         "internal",
@@ -146,6 +210,67 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      keyDelete: FunctionReference<
+        "mutation",
+        "internal",
+        { keyId: string },
+        any,
+        Name
+      >;
+      keyGetByHashedKey: FunctionReference<
+        "query",
+        "internal",
+        { hashedKey: string },
+        any,
+        Name
+      >;
+      keyGetById: FunctionReference<
+        "query",
+        "internal",
+        { keyId: string },
+        any,
+        Name
+      >;
+      keyInsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          expiresAt?: number;
+          hashedKey: string;
+          name: string;
+          prefix: string;
+          rateLimit?: { maxRequests: number; windowMs: number };
+          scopes: Array<{ resource: string; actions: Array<string> }>;
+          userId: string;
+        },
+        any,
+        Name
+      >;
+      keyList: FunctionReference<"query", "internal", {}, any, Name>;
+      keyListByUserId: FunctionReference<
+        "query",
+        "internal",
+        { userId: string },
+        any,
+        Name
+      >;
+      keyPatch: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          data: {
+            lastUsedAt?: number;
+            name?: string;
+            rateLimit?: { maxRequests: number; windowMs: number };
+            rateLimitState?: { attemptsLeft: number; lastAttemptTime: number };
+            revoked?: boolean;
+            scopes?: Array<{ resource: string; actions: Array<string> }>;
+          };
+          keyId: string;
+        },
+        any,
+        Name
+      >;
       memberAdd: FunctionReference<
         "mutation",
         "internal",
@@ -201,6 +326,59 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      passkeyDelete: FunctionReference<
+        "mutation",
+        "internal",
+        { passkeyId: string },
+        any,
+        Name
+      >;
+      passkeyGetByCredentialId: FunctionReference<
+        "query",
+        "internal",
+        { credentialId: string },
+        any,
+        Name
+      >;
+      passkeyInsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          algorithm: number;
+          backedUp: boolean;
+          counter: number;
+          createdAt: number;
+          credentialId: string;
+          deviceType: string;
+          name?: string;
+          publicKey: ArrayBuffer;
+          transports?: Array<string>;
+          userId: string;
+        },
+        any,
+        Name
+      >;
+      passkeyListByUserId: FunctionReference<
+        "query",
+        "internal",
+        { userId: string },
+        any,
+        Name
+      >;
+      passkeyUpdateCounter: FunctionReference<
+        "mutation",
+        "internal",
+        { counter: number; lastUsedAt: number; passkeyId: string },
+        any,
+        Name
+      >;
+      passkeyUpdateMeta: FunctionReference<
+        "mutation",
+        "internal",
+        { data: any; passkeyId: string },
+        any,
+        Name
+      >;
       rateLimitCreate: FunctionReference<
         "mutation",
         "internal",
@@ -303,6 +481,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      sessionList: FunctionReference<"query", "internal", {}, any, Name>;
       sessionListByUser: FunctionReference<
         "query",
         "internal",
@@ -310,6 +489,63 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      totpDelete: FunctionReference<
+        "mutation",
+        "internal",
+        { totpId: string },
+        any,
+        Name
+      >;
+      totpGetById: FunctionReference<
+        "query",
+        "internal",
+        { totpId: string },
+        any,
+        Name
+      >;
+      totpGetVerifiedByUserId: FunctionReference<
+        "query",
+        "internal",
+        { userId: string },
+        any,
+        Name
+      >;
+      totpInsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          createdAt: number;
+          digits: number;
+          name?: string;
+          period: number;
+          secret: ArrayBuffer;
+          userId: string;
+          verified: boolean;
+        },
+        any,
+        Name
+      >;
+      totpListByUserId: FunctionReference<
+        "query",
+        "internal",
+        { userId: string },
+        any,
+        Name
+      >;
+      totpMarkVerified: FunctionReference<
+        "mutation",
+        "internal",
+        { lastUsedAt: number; totpId: string },
+        any,
+        Name
+      >;
+      totpUpdateLastUsed: FunctionReference<
+        "mutation",
+        "internal",
+        { lastUsedAt: number; totpId: string },
+        any,
+        Name
+      >;
       userFindByVerifiedEmail: FunctionReference<
         "query",
         "internal",
@@ -338,6 +574,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         any,
         Name
       >;
+      userList: FunctionReference<"query", "internal", {}, any, Name>;
       userPatch: FunctionReference<
         "mutation",
         "internal",

package/src/component/convex.config.ts

@@ -1,5 +1,8 @@
 import { defineComponent } from "convex/server";
+import selfHosting from "@convex-dev/self-hosting/convex.config";
 
 const component = defineComponent("auth");
 
+component.use(selfHosting);
+
 export default component;

package/src/component/index.ts

@@ -2,19 +2,20 @@
  * Configuration and helpers for using Convex Auth on your Convex
  * backend.
  *
- * Call {@link Auth} to configure your authentication methods
- * and use the helpers it returns.
+ * Use `new Auth(components.auth, config)` to configure authentication
+ * and `Portal(auth)` to create portal admin exports.
  *
  * @module
  */
 
 export {
-  Auth,
+  Auth as AuthFactory,
   Tokens,
   Doc,
   SignInAction,
   SignOutAction,
 } from "../server/implementation/index.js";
+export { Auth, Portal } from "../server/convex-auth.js";
 export type {
   ConvexAuthConfig,
   AuthProviderConfig,
@@ -26,5 +27,9 @@ export type {
   GenericActionCtxWithAuthConfig,
   AuthProviderMaterializedConfig,
   ConvexAuthMaterializedConfig,
+  ApiKeyConfig,
+  KeyScope,
+  ScopeChecker,
+  KeyRecord,
 } from "../server/types.js";
 export type { GenericDoc } from "../server/convex_types.js";

package/src/component/portalBridge.ts

@@ -0,0 +1,116 @@
+/**
+ * Bridge functions that delegate to the self-hosting sub-component.
+ *
+ * The auth component uses self-hosting as a sub-component for serving
+ * portal static assets. These functions expose the self-hosting API
+ * as internal queries/mutations within the auth component, so the
+ * app layer can call them via `ctx.runQuery(components.auth.portalBridge.getByPath, ...)`.
+ */
+
+import { v } from "convex/values";
+import { query, mutation, internalMutation } from "./_generated/server.js";
+import { components } from "./_generated/api.js";
+
+// ============================================================================
+// Queries — delegate to selfHosting.lib.*
+// ============================================================================
+
+/**
+ * Look up a static asset by URL path.
+ * Delegates to selfHosting.lib.getByPath.
+ */
+export const getByPath = query({
+  args: { path: v.string() },
+  returns: v.any(),
+  handler: async (ctx, args) => {
+    return await ctx.runQuery(components.selfHosting.lib.getByPath, {
+      path: args.path,
+    });
+  },
+});
+
+/**
+ * Get the current deployment info.
+ * Delegates to selfHosting.lib.getCurrentDeployment.
+ */
+export const getCurrentDeployment = query({
+  args: {},
+  returns: v.any(),
+  handler: async (ctx) => {
+    return await ctx.runQuery(
+      components.selfHosting.lib.getCurrentDeployment,
+      {},
+    );
+  },
+});
+
+/**
+ * List all static assets.
+ * Delegates to selfHosting.lib.listAssets.
+ */
+export const listAssets = query({
+  args: { limit: v.optional(v.number()) },
+  returns: v.any(),
+  handler: async (ctx, args) => {
+    return await ctx.runQuery(components.selfHosting.lib.listAssets, {
+      limit: args.limit,
+    });
+  },
+});
+
+// ============================================================================
+// Mutations — delegate to selfHosting.lib.*
+// ============================================================================
+
+/**
+ * Record an asset after upload.
+ * Delegates to selfHosting.lib.recordAsset.
+ */
+export const recordAsset = mutation({
+  args: {
+    path: v.string(),
+    storageId: v.optional(v.string()),
+    blobId: v.optional(v.string()),
+    contentType: v.string(),
+    deploymentId: v.string(),
+  },
+  returns: v.any(),
+  handler: async (ctx, args) => {
+    return await ctx.runMutation(components.selfHosting.lib.recordAsset, {
+      path: args.path,
+      ...(args.storageId ? { storageId: args.storageId } : {}),
+      ...(args.blobId ? { blobId: args.blobId } : {}),
+      contentType: args.contentType,
+      deploymentId: args.deploymentId,
+    });
+  },
+});
+
+/**
+ * Garbage collect assets from old deployments.
+ * Delegates to selfHosting.lib.gcOldAssets.
+ */
+export const gcOldAssets = mutation({
+  args: { currentDeploymentId: v.string() },
+  returns: v.any(),
+  handler: async (ctx, args) => {
+    return await ctx.runMutation(components.selfHosting.lib.gcOldAssets, {
+      currentDeploymentId: args.currentDeploymentId,
+    });
+  },
+});
+
+/**
+ * Update the current deployment ID.
+ * Delegates to selfHosting.lib.setCurrentDeployment.
+ */
+export const setCurrentDeployment = mutation({
+  args: { deploymentId: v.string() },
+  returns: v.null(),
+  handler: async (ctx, args) => {
+    return await ctx.runMutation(
+      components.selfHosting.lib.setCurrentDeployment,
+      { deploymentId: args.deploymentId },
+    );
+  },
+});