@estifanos-sh/convex-auth 0.0.1 → 0.0.3

package/README.md

@@ -2,10 +2,10 @@
 
 Authentication and authorization for Convex applications.
 
-This is a preview release. Install it from the `preview` channel:
+Install the published package:
 
 ```sh
-pnpm add @estifanos-sh/convex-auth@preview
+npm install @estifanos-sh/convex-auth
 ```
 
 Configure the component in `convex/convex.config.ts`:
@@ -45,8 +45,8 @@ and provider configuration.
 
 ## Links
 
-- [Documentation](https://estifanos.sh/convex-auth/)
-- [Source](https://github.com/estifanos-sh/convex-auth)
-- [Issues](https://github.com/estifanos-sh/convex-auth/issues)
+Read the [documentation](https://estifanos.sh/convex-auth/), browse the
+[source](https://github.com/estifanos-sh/convex-auth), or report an
+[issue](https://github.com/estifanos-sh/convex-auth/issues).
 
 Apache-2.0

package/dist/_generated/component.d.ts

@@ -1,3 +1,4 @@
+import { Doc } from "./dataModel.js";
 import { FunctionReference } from "convex/server";
 
 //#region src/component/_generated/component.d.ts
@@ -16,6 +17,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
   account: {
     beginCredentialsSignIn: FunctionReference<"mutation", "internal", {
       includeTotp: boolean;
+      limitIdentifier: string;
       maxAttemptsPerHour: number;
       provider: string;
       providerAccountId: string;
@@ -58,8 +60,12 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       accountId: string;
       generateTokens: boolean;
       issueSession: boolean;
+      limitIdentifier: string;
       refreshTokenExpirationTime: number;
-      replaceSessionId?: string;
+      replaceSession?: {
+        authenticatedUserId: string;
+        sessionId: string;
+      };
       sessionExpirationTime: number;
     }, {
       status: "rejected";
@@ -502,7 +508,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           _id: string;
           active?: boolean;
           connectionId: string;
-          externalId: string;
+          externalId?: string;
           groupId: string;
           lastProvisionedAt?: number;
           mappedGroupId?: string;
@@ -514,7 +520,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           _id: string;
           active?: boolean;
           connectionId: string;
-          externalId: string;
+          externalId?: string;
           groupId: string;
           lastProvisionedAt?: number;
           mappedGroupId?: string;
@@ -540,7 +546,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
             _id: string;
             active?: boolean;
             connectionId: string;
-            externalId: string;
+            externalId?: string;
             groupId: string;
             lastProvisionedAt?: number;
             mappedGroupId?: string;
@@ -554,11 +560,11 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         provision: FunctionReference<"mutation", "internal", {
           active?: boolean;
           connectionId: string;
-          externalId: string;
-          groupId: string;
+          externalId?: string;
           lastProvisionedAt?: number;
-          provider: string;
+          profileUpdate: "never" | "missing" | "always";
           raw?: any;
+          roleIds: Array<string>;
           userData: {
             email?: string;
             emailVerificationTime?: number;
@@ -576,20 +582,61 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           created: boolean;
           userId: string;
         }, Name>;
-        remove: FunctionReference<"mutation", "internal", {
-          id: string;
+        provisionGroup: FunctionReference<"mutation", "internal", {
+          connectionId: string;
+          externalId?: string;
+          memberIds: Array<string>;
+          name: string;
+          raw?: any;
+          roleIds: Array<string>;
+        }, {
+          created: boolean;
+          groupId: string;
+        }, Name>;
+        revoke: FunctionReference<"mutation", "internal", {
+          connectionId: string;
+          mode: "soft" | "hard";
+          userId: string;
+        }, {
+          cleanupPending: boolean;
+          cleanedSessions: number;
+          epoch: number;
+        }, Name>;
+        revokeGroup: FunctionReference<"mutation", "internal", {
+          connectionId: string;
+          groupId: string;
         }, null, Name>;
-        upsert: FunctionReference<"mutation", "internal", {
-          active?: boolean;
+        updateGroup: FunctionReference<"mutation", "internal", {
           connectionId: string;
-          externalId: string;
           groupId: string;
+          memberIds: Array<string>;
+          name?: string;
+          raw?: any;
+          roleIds: Array<string>;
+        }, null, Name>;
+        update: FunctionReference<"mutation", "internal", {
+          active: boolean;
+          connectionId: string;
+          externalId?: string;
           lastProvisionedAt?: number;
-          mappedGroupId?: string;
+          profileUpdate: "never" | "missing" | "always";
           raw?: any;
-          resourceType: "user" | "group";
-          userId?: string;
-        }, string, Name>;
+          roleIds: Array<string>;
+          userData: {
+            email?: string;
+            emailVerificationTime?: number;
+            extend?: any;
+            firstName?: string;
+            image?: string;
+            isAnonymous?: boolean;
+            lastActiveGroup?: string;
+            lastName?: string;
+            name?: string;
+            phone?: string;
+            phoneVerificationTime?: number;
+          };
+          userId: string;
+        }, null, Name>;
       };
     };
     secret: {
@@ -690,17 +737,6 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           pageStatus?: "SplitRecommended" | "SplitRequired" | null;
           splitCursor?: string | null;
         }, Name>;
-        update: FunctionReference<"mutation", "internal", {
-          id: string;
-          patch: {
-            attemptCount?: number;
-            lastAttemptAt?: number;
-            lastError?: string;
-            lastResponseStatus?: number;
-            nextAttemptAt?: number;
-            status?: "pending" | "processing" | "delivered" | "failed";
-          };
-        }, null, Name>;
       };
       endpoint: {
         create: FunctionReference<"mutation", "internal", {
@@ -763,6 +799,20 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       };
     };
   };
+  context: {
+    get: FunctionReference<"query", "internal", {
+      sessionId?: string;
+      userId: string;
+    }, {
+      active: {
+        group: Doc<"Group"> | null;
+        groupId: string;
+        membership: Doc<"GroupMember">;
+      } | null;
+      session: Doc<"Session"> | null;
+      user: Doc<"User"> | null;
+    }, Name>;
+  };
   event: {
     append: FunctionReference<"mutation", "internal", {
       event: {
@@ -770,7 +820,6 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           id?: string;
           type: "user" | "system" | "scim" | "api_key" | "oauth_client" | "webhook" | "anonymous";
         };
-        category: "user" | "session" | "account" | "password" | "passkey" | "totp" | "email" | "phone" | "api_key" | "oauth" | "connection" | "scim" | "webhook" | "security";
         data?: {
           existingUserId?: string;
           profile?: Record<string, any>;
@@ -865,7 +914,6 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           kind: "user" | "session" | "group" | "connection" | "oauth_client" | "api_key" | "global";
         }>;
       };
-      idempotencyKey?: string;
       targets?: Array<{
         id: string;
         kind: "user" | "session" | "group" | "connection" | "oauth_client" | "api_key" | "global";
@@ -1305,13 +1353,36 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         };
         verifierId: string;
       }, Name>;
+      beginRotation: FunctionReference<"mutation", "internal", {
+        continuationId: string;
+        expirationTime: number;
+        provider: string;
+        signature: string;
+      }, {
+        status: "rejected";
+      } | {
+        credentials: Array<{
+          id: string;
+          transports?: Array<string>;
+        }>;
+        status: "accepted";
+        user: {
+          email?: string;
+          name?: string;
+        };
+        userId: string;
+        verifierId: string;
+      }, Name>;
       beginSignIn: FunctionReference<"mutation", "internal", {
         expirationTime: number;
         sessionId?: string;
         signature: string;
         verifiedEmail?: string;
       }, {
-        credentialIds: Array<string>;
+        credentials: Array<{
+          id: string;
+          transports?: Array<string>;
+        }>;
         verifierId: string;
       }, Name>;
       completeAssertion: FunctionReference<"mutation", "internal", {
@@ -1320,7 +1391,10 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         id: string;
         lastUsedAt: number;
         refreshTokenExpirationTime: number;
-        replaceSessionId?: string;
+        replaceSession?: {
+          authenticatedUserId: string;
+          sessionId: string;
+        };
         sessionExpirationTime: number;
       }, {
         status: "rejected";
@@ -1363,7 +1437,10 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         name?: string;
         publicKey: ArrayBuffer;
         refreshTokenExpirationTime: number;
-        replaceSessionId?: string;
+        replaceSession?: {
+          authenticatedUserId: string;
+          sessionId: string;
+        };
         sessionExpirationTime: number;
         transports?: Array<string>;
         userId: string;
@@ -1388,6 +1465,55 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           phoneVerificationTime?: number;
         };
       }, Name>;
+      completeRotation: FunctionReference<"mutation", "internal", {
+        algorithm: number;
+        attestation?: {
+          aaguid: string;
+          format: string;
+          metadataDescription?: string;
+          status: "trusted";
+          verifiedAt: number;
+          verifier: string;
+        };
+        backedUp: boolean;
+        continuationId: string;
+        counter: number;
+        createdAt: number;
+        credentialId: string;
+        deviceType: string;
+        name?: string;
+        provider: string;
+        publicKey: ArrayBuffer;
+        refreshTokenExpirationTime: number;
+        sessionExpirationTime: number;
+        transports?: Array<string>;
+        userId: string;
+      }, {
+        status: "rejected";
+      } | {
+        passkeyId: string;
+        passwordChanged: boolean;
+        refreshTokenId: string;
+        removedPasskeyIds: Array<string>;
+        revokedSessions: number;
+        sessionId: string;
+        status: "accepted";
+        user: {
+          _creationTime: number;
+          _id: string;
+          email?: string;
+          emailVerificationTime?: number;
+          extend?: any;
+          firstName?: string;
+          image?: string;
+          isAnonymous?: boolean;
+          lastActiveGroup?: string;
+          lastName?: string;
+          name?: string;
+          phone?: string;
+          phoneVerificationTime?: number;
+        };
+      }, Name>;
       create: FunctionReference<"mutation", "internal", {
         algorithm: number;
         attestation?: {
@@ -1512,7 +1638,10 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         intent: "enrollment" | "challenge";
         now: number;
         refreshTokenExpirationTime: number;
-        replaceSessionId?: string;
+        replaceSession?: {
+          authenticatedUserId: string;
+          sessionId: string;
+        };
         sessionExpirationTime: number;
         totpId?: string;
         verifierId: string;
@@ -1658,11 +1787,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
                 mode: "ignore" | "map";
                 source: "protocol";
               };
-              scimReuse: {
-                user: "externalId" | "none";
-              };
               user: {
-                authority: "app" | "connection" | "scim";
+                authority: "app" | "scim";
                 createOnSignIn: boolean;
                 updateProfileFromScim: "never" | "missing" | "always";
                 updateProfileOnLogin: "never" | "missing" | "always";
@@ -1733,11 +1859,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
               mode: "ignore" | "map";
               source: "protocol";
             };
-            scimReuse: {
-              user: "externalId" | "none";
-            };
             user: {
-              authority: "app" | "connection" | "scim";
+              authority: "app" | "scim";
               createOnSignIn: boolean;
               updateProfileFromScim: "never" | "missing" | "always";
               updateProfileOnLogin: "never" | "missing" | "always";
@@ -1796,11 +1919,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
             mode: "ignore" | "map";
             source: "protocol";
           };
-          scimReuse: {
-            user: "externalId" | "none";
-          };
           user: {
-            authority: "app" | "connection" | "scim";
+            authority: "app" | "scim";
             createOnSignIn: boolean;
             updateProfileFromScim: "never" | "missing" | "always";
             updateProfileOnLogin: "never" | "missing" | "always";
@@ -1845,11 +1965,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
             mode: "ignore" | "map";
             source: "protocol";
           };
-          scimReuse: {
-            user: "externalId" | "none";
-          };
           user: {
-            authority: "app" | "connection" | "scim";
+            authority: "app" | "scim";
             createOnSignIn: boolean;
             updateProfileFromScim: "never" | "missing" | "always";
             updateProfileOnLogin: "never" | "missing" | "always";
@@ -1880,7 +1997,6 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         groupId?: string;
         invitedByUserId?: string;
         roleIds?: Array<string>;
-        status: "pending" | "accepted" | "revoked" | "expired";
         tokenHash: string;
       }, string, Name>;
       get: FunctionReference<"query", "internal", {
@@ -2000,11 +2116,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
               mode: "ignore" | "map";
               source: "protocol";
             };
-            scimReuse: {
-              user: "externalId" | "none";
-            };
             user: {
-              authority: "app" | "connection" | "scim";
+              authority: "app" | "scim";
               createOnSignIn: boolean;
               updateProfileFromScim: "never" | "missing" | "always";
               updateProfileOnLogin: "never" | "missing" | "always";
@@ -2154,11 +2267,8 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
               mode: "ignore" | "map";
               source: "protocol";
             };
-            scimReuse: {
-              user: "externalId" | "none";
-            };
             user: {
-              authority: "app" | "connection" | "scim";
+              authority: "app" | "scim";
               createOnSignIn: boolean;
               updateProfileFromScim: "never" | "missing" | "always";
               updateProfileOnLogin: "never" | "missing" | "always";
@@ -2364,7 +2474,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         _id: string;
         expiresAt: number;
         firstUsedTime?: number;
-        grantId?: string;
+        grantId: string;
         parentTokenId?: string;
         tokenHash: string;
       } | null, Name>;
@@ -2379,11 +2489,15 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
   session: {
     create: FunctionReference<"mutation", "internal", {
       refreshTokenExpirationTime?: number;
-      replaceSessionId?: string;
+      replaceSession?: {
+        authenticatedUserId: string;
+        sessionId: string;
+      };
       sessionExpirationTime: number;
       sessionId?: string;
       userId: string;
     }, {
+      epoch: number;
       refreshTokenId?: string;
       replacedSessionId?: string;
       sessionId: string;
@@ -2401,6 +2515,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         name?: string;
         phone?: string;
         phoneVerificationTime?: number;
+        sessionEpoch?: number;
       };
       userId: string;
     }, Name>;
@@ -2409,6 +2524,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
     }, {
       _creationTime: number;
       _id: string;
+      epoch?: number;
       expirationTime: number;
       userId: string;
     } | null, Name>;
@@ -2417,6 +2533,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
     }, Array<{
       _creationTime: number;
       _id: string;
+      epoch?: number;
       expirationTime: number;
       userId: string;
     }>, Name>;
@@ -2424,12 +2541,56 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       id: string;
     }, null, Name>;
     revokeForUser: FunctionReference<"mutation", "internal", {
+      except?: Array<string>;
       userId: string;
     }, {
-      revoked: number;
+      cleanedRefreshTokens: number;
+      cleanedSessionIds: Array<string>;
+      cleanedSessions: number;
+      cleanupPending: boolean;
+      epoch: number;
+      retainedSessionIds: Array<string>;
     }, Name>;
   };
   token: {
+    continuation: {
+      create: FunctionReference<"mutation", "internal", {
+        expirationTime: number;
+        operation: "rotate";
+        provider: string;
+        userId: string;
+      }, string, Name>;
+      recover: FunctionReference<"mutation", "internal", {
+        accountId: string;
+        code: string;
+        expirationTime: number;
+        identifier?: string;
+        maxAttemptsPerHour: number;
+        now: number;
+        operation: "rotate";
+        passwordProvider: string;
+        provider: string;
+        resetProvider: string;
+        secret: string;
+        verifier?: string;
+      }, {
+        status: "limited" | "rejected";
+      } | {
+        continuationId: string;
+        status: "accepted";
+        userId: string;
+      }, Name>;
+      get: FunctionReference<"query", "internal", {
+        id: string;
+      }, {
+        _creationTime: number;
+        _id: string;
+        expirationTime: number;
+        operation: "rotate";
+        provider: string;
+        userId: string;
+      } | null, Name>;
+    };
     pkce: {
       consume: FunctionReference<"mutation", "internal", {
         expectedSignature?: string;
@@ -2438,11 +2599,13 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       }, {
         _creationTime: number;
         _id: string;
+        continuationId?: string;
         expirationTime?: number;
         sessionId?: string;
         signature?: string;
       } | null, Name>;
       create: FunctionReference<"mutation", "internal", {
+        continuationId?: string;
         expirationTime?: number;
         sessionId?: string;
         signature?: string;
@@ -2453,6 +2616,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       }, {
         _creationTime: number;
         _id: string;
+        continuationId?: string;
         expirationTime?: number;
         sessionId?: string;
         signature?: string;
@@ -2463,6 +2627,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       update: FunctionReference<"mutation", "internal", {
         id: string;
         patch: {
+          continuationId?: string;
           expirationTime?: number;
           sessionId?: string;
           signature?: string;
@@ -2482,6 +2647,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
         reuseWindowMs: number;
         sessionId: string;
       }, {
+        epoch: number;
         refreshTokenId: string;
         sessionId: string;
         status: "rotated";
@@ -2499,6 +2665,7 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
           name?: string;
           phone?: string;
           phoneVerificationTime?: number;
+          sessionEpoch?: number;
         };
         userId: string;
       } | {
@@ -2580,19 +2747,40 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       }, Name>;
       completeVerification: FunctionReference<"mutation", "internal", {
         codeId: string;
+        createSession: boolean;
         generateTokens: boolean;
         identifier?: string;
         refreshTokenExpirationTime: number;
-        replaceSessionId?: string;
+        replaceSession?: {
+          authenticatedUserId: string;
+          sessionId: string;
+        };
         sessionExpirationTime: number;
         userId: string;
       }, {
         status: "rejected";
+      } | {
+        status: "verified";
+        user: {
+          _creationTime: number;
+          _id: string;
+          email?: string;
+          emailVerificationTime?: number;
+          extend?: any;
+          firstName?: string;
+          image?: string;
+          isAnonymous?: boolean;
+          lastActiveGroup?: string;
+          lastName?: string;
+          name?: string;
+          phone?: string;
+          phoneVerificationTime?: number;
+        };
       } | {
         refreshTokenId?: string;
         replacedSessionId?: string;
         sessionId: string;
-        status: "accepted";
+        status: "signedIn";
         user: {
           _creationTime: number;
           _id: string;
@@ -2821,7 +3009,6 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       recordUse: FunctionReference<"mutation", "internal", {
         coarsenMs?: number;
         id: string;
-        now: number;
       }, {
         status: "invalid";
       } | {
@@ -2863,16 +3050,11 @@ type ComponentApi<Name extends string | undefined = string | undefined> = {
       update: FunctionReference<"mutation", "internal", {
         id: string;
         patch: {
-          lastUsedAt?: number;
           name?: string;
           rateLimit?: {
             maxRequests: number;
             windowMs: number;
           };
-          rateLimitState?: {
-            attemptsLeft: number;
-            lastAttemptTime: number;
-          };
           revoked?: boolean;
           scopes?: Array<{
             actions: Array<string>;