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

package/dist/component/public.d.ts

@@ -1,3 +1,4 @@
+/** Retrieve a user by their document ID. */
 export declare const userGetById: import("convex/server").RegisteredQuery<"public", {
     userId: import("convex/values").GenericId<"user">;
 }, Promise<{
@@ -10,8 +11,13 @@ export declare const userGetById: import("convex/server").RegisteredQuery<"publi
     emailVerificationTime?: number | undefined;
     phoneVerificationTime?: number | undefined;
     isAnonymous?: boolean | undefined;
-    favoriteColor?: string | undefined;
+    extend?: any;
 } | null>>;
+/**
+ * Find a user by their verified email address. Returns `null` if no user
+ * has this email verified, or if multiple users share the same verified email
+ * (ambiguous — should not happen in normal operation).
+ */
 export declare const userFindByVerifiedEmail: import("convex/server").RegisteredQuery<"public", {
     email: string;
 }, Promise<{
@@ -24,8 +30,13 @@ export declare const userFindByVerifiedEmail: import("convex/server").Registered
     emailVerificationTime?: number | undefined;
     phoneVerificationTime?: number | undefined;
     isAnonymous?: boolean | undefined;
-    favoriteColor?: string | undefined;
+    extend?: any;
 } | null>>;
+/**
+ * Find a user by their verified phone number. Returns `null` if no user
+ * has this phone verified, or if multiple users share the same verified phone
+ * (ambiguous — should not happen in normal operation).
+ */
 export declare const userFindByVerifiedPhone: import("convex/server").RegisteredQuery<"public", {
     phone: string;
 }, Promise<{
@@ -38,19 +49,23 @@ export declare const userFindByVerifiedPhone: import("convex/server").Registered
     emailVerificationTime?: number | undefined;
     phoneVerificationTime?: number | undefined;
     isAnonymous?: boolean | undefined;
-    favoriteColor?: string | undefined;
+    extend?: any;
 } | null>>;
+/** Insert a new user document. */
 export declare const userInsert: import("convex/server").RegisteredMutation<"public", {
     data: any;
 }, Promise<import("convex/values").GenericId<"user">>>;
+/** Insert a new user or update an existing one. */
 export declare const userUpsert: import("convex/server").RegisteredMutation<"public", {
     userId?: import("convex/values").GenericId<"user"> | undefined;
     data: any;
 }, Promise<import("convex/values").GenericId<"user">>>;
+/** Patch an existing user document with partial data. */
 export declare const userPatch: import("convex/server").RegisteredMutation<"public", {
     userId: import("convex/values").GenericId<"user">;
     data: any;
 }, Promise<void>>;
+/** Look up an account by provider and provider-specific account ID. */
 export declare const accountGet: import("convex/server").RegisteredQuery<"public", {
     provider: string;
     providerAccountId: string;
@@ -64,6 +79,7 @@ export declare const accountGet: import("convex/server").RegisteredQuery<"public
     provider: string;
     providerAccountId: string;
 } | null>>;
+/** Retrieve an account by its document ID. */
 export declare const accountGetById: import("convex/server").RegisteredQuery<"public", {
     accountId: import("convex/values").GenericId<"account">;
 }, Promise<{
@@ -76,23 +92,28 @@ export declare const accountGetById: import("convex/server").RegisteredQuery<"pu
     provider: string;
     providerAccountId: string;
 } | null>>;
+/** Create a new account linking a user to an auth provider. */
 export declare const accountInsert: import("convex/server").RegisteredMutation<"public", {
     secret?: string | undefined;
     userId: import("convex/values").GenericId<"user">;
     provider: string;
     providerAccountId: string;
 }, Promise<import("convex/values").GenericId<"account">>>;
+/** Patch an existing account document with partial data. */
 export declare const accountPatch: import("convex/server").RegisteredMutation<"public", {
     accountId: import("convex/values").GenericId<"account">;
     data: any;
 }, Promise<void>>;
+/** Delete an account document. */
 export declare const accountDelete: import("convex/server").RegisteredMutation<"public", {
     accountId: import("convex/values").GenericId<"account">;
 }, Promise<void>>;
+/** Create a new session for a user with an expiration time. */
 export declare const sessionCreate: import("convex/server").RegisteredMutation<"public", {
     userId: import("convex/values").GenericId<"user">;
     expirationTime: number;
 }, Promise<import("convex/values").GenericId<"session">>>;
+/** Retrieve a session by its document ID. */
 export declare const sessionGetById: import("convex/server").RegisteredQuery<"public", {
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<{
@@ -101,9 +122,11 @@ export declare const sessionGetById: import("convex/server").RegisteredQuery<"pu
     userId: import("convex/values").GenericId<"user">;
     expirationTime: number;
 } | null>>;
+/** Delete a session. No-op if the session does not exist. */
 export declare const sessionDelete: import("convex/server").RegisteredMutation<"public", {
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<void>>;
+/** List all sessions for a user. */
 export declare const sessionListByUser: import("convex/server").RegisteredQuery<"public", {
     userId: import("convex/values").GenericId<"user">;
 }, Promise<{
@@ -112,9 +135,11 @@ export declare const sessionListByUser: import("convex/server").RegisteredQuery<
     userId: import("convex/values").GenericId<"user">;
     expirationTime: number;
 }[]>>;
+/** Create a new PKCE verifier, optionally linked to a session. */
 export declare const verifierCreate: import("convex/server").RegisteredMutation<"public", {
     sessionId?: import("convex/values").GenericId<"session"> | undefined;
 }, Promise<import("convex/values").GenericId<"verifier">>>;
+/** Retrieve a verifier by its document ID. */
 export declare const verifierGetById: import("convex/server").RegisteredQuery<"public", {
     verifierId: import("convex/values").GenericId<"verifier">;
 }, Promise<{
@@ -123,6 +148,7 @@ export declare const verifierGetById: import("convex/server").RegisteredQuery<"p
     sessionId?: import("convex/values").GenericId<"session"> | undefined;
     signature?: string | undefined;
 } | null>>;
+/** Look up a verifier by its cryptographic signature. */
 export declare const verifierGetBySignature: import("convex/server").RegisteredQuery<"public", {
     signature: string;
 }, Promise<{
@@ -131,13 +157,16 @@ export declare const verifierGetBySignature: import("convex/server").RegisteredQ
     sessionId?: import("convex/values").GenericId<"session"> | undefined;
     signature?: string | undefined;
 } | null>>;
+/** Patch a verifier document with partial data. */
 export declare const verifierPatch: import("convex/server").RegisteredMutation<"public", {
     data: any;
     verifierId: import("convex/values").GenericId<"verifier">;
 }, Promise<void>>;
+/** Delete a verifier document. */
 export declare const verifierDelete: import("convex/server").RegisteredMutation<"public", {
     verifierId: import("convex/values").GenericId<"verifier">;
 }, Promise<void>>;
+/** Find a verification code by its associated account ID. */
 export declare const verificationCodeGetByAccountId: import("convex/server").RegisteredQuery<"public", {
     accountId: import("convex/values").GenericId<"account">;
 }, Promise<{
@@ -151,6 +180,7 @@ export declare const verificationCodeGetByAccountId: import("convex/server").Reg
     accountId: import("convex/values").GenericId<"account">;
     code: string;
 } | null>>;
+/** Find a verification code by its code string. */
 export declare const verificationCodeGetByCode: import("convex/server").RegisteredQuery<"public", {
     code: string;
 }, Promise<{
@@ -164,6 +194,7 @@ export declare const verificationCodeGetByCode: import("convex/server").Register
     accountId: import("convex/values").GenericId<"account">;
     code: string;
 } | null>>;
+/** Create a new verification code for OTP, magic link, or OAuth flows. */
 export declare const verificationCodeCreate: import("convex/server").RegisteredMutation<"public", {
     emailVerified?: string | undefined;
     phoneVerified?: string | undefined;
@@ -173,14 +204,17 @@ export declare const verificationCodeCreate: import("convex/server").RegisteredM
     accountId: import("convex/values").GenericId<"account">;
     code: string;
 }, Promise<import("convex/values").GenericId<"verification">>>;
+/** Delete a verification code document. */
 export declare const verificationCodeDelete: import("convex/server").RegisteredMutation<"public", {
     verificationCodeId: import("convex/values").GenericId<"verification">;
 }, Promise<void>>;
+/** Create a new refresh token for a session. */
 export declare const refreshTokenCreate: import("convex/server").RegisteredMutation<"public", {
     parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
     expirationTime: number;
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<import("convex/values").GenericId<"token">>>;
+/** Retrieve a refresh token by its document ID. */
 export declare const refreshTokenGetById: import("convex/server").RegisteredQuery<"public", {
     refreshTokenId: import("convex/values").GenericId<"token">;
 }, Promise<{
@@ -191,10 +225,12 @@ export declare const refreshTokenGetById: import("convex/server").RegisteredQuer
     expirationTime: number;
     sessionId: import("convex/values").GenericId<"session">;
 } | null>>;
+/** Patch a refresh token document with partial data. */
 export declare const refreshTokenPatch: import("convex/server").RegisteredMutation<"public", {
     data: any;
     refreshTokenId: import("convex/values").GenericId<"token">;
 }, Promise<void>>;
+/** Get child tokens that were created by exchanging a specific parent token. */
 export declare const refreshTokenGetChildren: import("convex/server").RegisteredQuery<"public", {
     sessionId: import("convex/values").GenericId<"session">;
     parentRefreshTokenId: import("convex/values").GenericId<"token">;
@@ -206,6 +242,7 @@ export declare const refreshTokenGetChildren: import("convex/server").Registered
     expirationTime: number;
     sessionId: import("convex/values").GenericId<"session">;
 }[]>>;
+/** List all refresh tokens for a session. */
 export declare const refreshTokenListBySession: import("convex/server").RegisteredQuery<"public", {
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<{
@@ -216,9 +253,11 @@ export declare const refreshTokenListBySession: import("convex/server").Register
     expirationTime: number;
     sessionId: import("convex/values").GenericId<"session">;
 }[]>>;
+/** Delete all refresh tokens for a session. */
 export declare const refreshTokenDeleteAll: import("convex/server").RegisteredMutation<"public", {
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<void>>;
+/** Get the active (unused) refresh token for a session. */
 export declare const refreshTokenGetActive: import("convex/server").RegisteredQuery<"public", {
     sessionId: import("convex/values").GenericId<"session">;
 }, Promise<{
@@ -229,6 +268,7 @@ export declare const refreshTokenGetActive: import("convex/server").RegisteredQu
     expirationTime: number;
     sessionId: import("convex/values").GenericId<"session">;
 } | null>>;
+/** Look up a rate limit entry by its identifier. */
 export declare const rateLimitGet: import("convex/server").RegisteredQuery<"public", {
     identifier: string;
 }, Promise<{
@@ -238,212 +278,238 @@ export declare const rateLimitGet: import("convex/server").RegisteredQuery<"publ
     lastAttemptTime: number;
     attemptsLeft: number;
 } | null>>;
+/** Create a new rate limit entry. */
 export declare const rateLimitCreate: import("convex/server").RegisteredMutation<"public", {
     identifier: string;
     lastAttemptTime: number;
     attemptsLeft: number;
 }, Promise<import("convex/values").GenericId<"limit">>>;
+/** Patch a rate limit entry with partial data. */
 export declare const rateLimitPatch: import("convex/server").RegisteredMutation<"public", {
     data: any;
     rateLimitId: import("convex/values").GenericId<"limit">;
 }, Promise<void>>;
+/** Delete a rate limit entry. */
 export declare const rateLimitDelete: import("convex/server").RegisteredMutation<"public", {
     rateLimitId: import("convex/values").GenericId<"limit">;
 }, Promise<void>>;
-export declare const verificationGetByAccountId: import("convex/server").RegisteredQuery<"public", {
-    accountId: import("convex/values").GenericId<"account">;
+/**
+ * Create a new group. Groups are hierarchical — set `parentGroupId` to nest
+ * under an existing group, or omit it to create a root-level group.
+ *
+ * @returns The ID of the newly created group.
+ */
+export declare const groupCreate: import("convex/server").RegisteredMutation<"public", {
+    extend?: any;
+    slug?: string | undefined;
+    parentGroupId?: import("convex/values").GenericId<"group"> | undefined;
+    name: string;
+}, Promise<import("convex/values").GenericId<"group">>>;
+/** Retrieve a group by its document ID. Returns `null` if not found. */
+export declare const groupGet: import("convex/server").RegisteredQuery<"public", {
+    groupId: import("convex/values").GenericId<"group">;
 }, Promise<{
-    _id: import("convex/values").GenericId<"verification">;
+    _id: import("convex/values").GenericId<"group">;
     _creationTime: number;
-    emailVerified?: string | undefined;
-    phoneVerified?: string | undefined;
-    verifier?: string | undefined;
-    expirationTime: number;
-    provider: string;
-    accountId: import("convex/values").GenericId<"account">;
-    code: string;
+    extend?: any;
+    slug?: string | undefined;
+    parentGroupId?: import("convex/values").GenericId<"group"> | undefined;
+    name: string;
 } | null>>;
-export declare const verificationGetByCode: import("convex/server").RegisteredQuery<"public", {
-    code: string;
+/**
+ * List groups. When `parentGroupId` is provided, returns children of that
+ * group. When omitted, returns all root-level groups (groups with no parent).
+ */
+export declare const groupList: import("convex/server").RegisteredQuery<"public", {
+    parentGroupId?: import("convex/values").GenericId<"group"> | undefined;
 }, Promise<{
-    _id: import("convex/values").GenericId<"verification">;
+    _id: import("convex/values").GenericId<"group">;
     _creationTime: number;
-    emailVerified?: string | undefined;
-    phoneVerified?: string | undefined;
-    verifier?: string | undefined;
-    expirationTime: number;
-    provider: string;
-    accountId: import("convex/values").GenericId<"account">;
-    code: string;
-} | null>>;
-export declare const verificationCreate: import("convex/server").RegisteredMutation<"public", {
-    emailVerified?: string | undefined;
-    phoneVerified?: string | undefined;
-    verifier?: string | undefined;
-    expirationTime: number;
-    provider: string;
-    accountId: import("convex/values").GenericId<"account">;
-    code: string;
-}, Promise<import("convex/values").GenericId<"verification">>>;
-export declare const verificationDelete: import("convex/server").RegisteredMutation<"public", {
-    verificationCodeId: import("convex/values").GenericId<"verification">;
+    extend?: any;
+    slug?: string | undefined;
+    parentGroupId?: import("convex/values").GenericId<"group"> | undefined;
+    name: string;
+}[]>>;
+/** Update a group's fields (name, slug, extend, parentGroupId). */
+export declare const groupUpdate: import("convex/server").RegisteredMutation<"public", {
+    groupId: import("convex/values").GenericId<"group">;
+    data: any;
 }, Promise<void>>;
-export declare const tokenCreate: import("convex/server").RegisteredMutation<"public", {
-    parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
-    expirationTime: number;
-    sessionId: import("convex/values").GenericId<"session">;
-}, Promise<import("convex/values").GenericId<"token">>>;
-export declare const tokenGetById: import("convex/server").RegisteredQuery<"public", {
-    refreshTokenId: import("convex/values").GenericId<"token">;
+/**
+ * Delete a group and all of its descendants. This cascades to:
+ * - All child groups (recursively)
+ * - All members of this group and its descendants
+ * - All invites for this group and its descendants
+ */
+export declare const groupDelete: import("convex/server").RegisteredMutation<"public", {
+    groupId: import("convex/values").GenericId<"group">;
+}, Promise<void>>;
+/**
+ * Add a user as a member of a group.
+ *
+ * The `role` field is an application-defined string (e.g. "owner", "admin",
+ * "member", "viewer"). The auth component stores it but does not enforce
+ * access control — your application defines what each role means.
+ *
+ * Throws `ConvexError` with code `DUPLICATE_MEMBERSHIP` when the user is
+ * already a member of the target group.
+ *
+ * @returns The ID of the new member record.
+ */
+export declare const memberAdd: import("convex/server").RegisteredMutation<"public", {
+    extend?: any;
+    role?: string | undefined;
+    status?: string | undefined;
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
+}, Promise<import("convex/values").GenericId<"member">>>;
+/** Retrieve a member record by its document ID. Returns `null` if not found. */
+export declare const memberGet: import("convex/server").RegisteredQuery<"public", {
+    memberId: import("convex/values").GenericId<"member">;
 }, Promise<{
-    _id: import("convex/values").GenericId<"token">;
+    _id: import("convex/values").GenericId<"member">;
     _creationTime: number;
-    firstUsedTime?: number | undefined;
-    parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
-    expirationTime: number;
-    sessionId: import("convex/values").GenericId<"session">;
+    extend?: any;
+    role?: string | undefined;
+    status?: string | undefined;
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
 } | null>>;
-export declare const tokenPatch: import("convex/server").RegisteredMutation<"public", {
-    data: any;
-    refreshTokenId: import("convex/values").GenericId<"token">;
-}, Promise<void>>;
-export declare const tokenGetChildren: import("convex/server").RegisteredQuery<"public", {
-    sessionId: import("convex/values").GenericId<"session">;
-    parentRefreshTokenId: import("convex/values").GenericId<"token">;
+/** List all members of a specific group. */
+export declare const memberList: import("convex/server").RegisteredQuery<"public", {
+    groupId: import("convex/values").GenericId<"group">;
 }, Promise<{
-    _id: import("convex/values").GenericId<"token">;
+    _id: import("convex/values").GenericId<"member">;
     _creationTime: number;
-    firstUsedTime?: number | undefined;
-    parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
-    expirationTime: number;
-    sessionId: import("convex/values").GenericId<"session">;
+    extend?: any;
+    role?: string | undefined;
+    status?: string | undefined;
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
 }[]>>;
-export declare const tokenListBySession: import("convex/server").RegisteredQuery<"public", {
-    sessionId: import("convex/values").GenericId<"session">;
+/**
+ * List all group memberships for a specific user. Returns member records
+ * which include the `groupId`, `role`, `status`, and `extend` for each
+ * group the user belongs to.
+ */
+export declare const memberListByUser: import("convex/server").RegisteredQuery<"public", {
+    userId: import("convex/values").GenericId<"user">;
 }, Promise<{
-    _id: import("convex/values").GenericId<"token">;
+    _id: import("convex/values").GenericId<"member">;
     _creationTime: number;
-    firstUsedTime?: number | undefined;
-    parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
-    expirationTime: number;
-    sessionId: import("convex/values").GenericId<"session">;
+    extend?: any;
+    role?: string | undefined;
+    status?: string | undefined;
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
 }[]>>;
-export declare const tokenDeleteAll: import("convex/server").RegisteredMutation<"public", {
-    sessionId: import("convex/values").GenericId<"session">;
-}, Promise<void>>;
-export declare const tokenGetActive: import("convex/server").RegisteredQuery<"public", {
-    sessionId: import("convex/values").GenericId<"session">;
-}, Promise<{
-    _id: import("convex/values").GenericId<"token">;
-    _creationTime: number;
-    firstUsedTime?: number | undefined;
-    parentRefreshTokenId?: import("convex/values").GenericId<"token"> | undefined;
-    expirationTime: number;
-    sessionId: import("convex/values").GenericId<"session">;
-} | null>>;
-export declare const limitGet: import("convex/server").RegisteredQuery<"public", {
-    identifier: string;
+/**
+ * Look up a specific user's membership in a specific group.
+ * Returns `null` if the user is not a member of the group.
+ */
+export declare const memberGetByGroupAndUser: import("convex/server").RegisteredQuery<"public", {
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
 }, Promise<{
-    _id: import("convex/values").GenericId<"limit">;
+    _id: import("convex/values").GenericId<"member">;
     _creationTime: number;
-    identifier: string;
-    lastAttemptTime: number;
-    attemptsLeft: number;
+    extend?: any;
+    role?: string | undefined;
+    status?: string | undefined;
+    userId: import("convex/values").GenericId<"user">;
+    groupId: import("convex/values").GenericId<"group">;
 } | null>>;
-export declare const limitCreate: import("convex/server").RegisteredMutation<"public", {
-    identifier: string;
-    lastAttemptTime: number;
-    attemptsLeft: number;
-}, Promise<import("convex/values").GenericId<"limit">>>;
-export declare const limitPatch: import("convex/server").RegisteredMutation<"public", {
-    data: any;
-    rateLimitId: import("convex/values").GenericId<"limit">;
-}, Promise<void>>;
-export declare const limitDelete: import("convex/server").RegisteredMutation<"public", {
-    rateLimitId: import("convex/values").GenericId<"limit">;
-}, Promise<void>>;
-export declare const organizationCreate: import("convex/server").RegisteredMutation<"public", {
-    data: any;
-}, Promise<any>>;
-export declare const organizationGet: import("convex/server").RegisteredQuery<"public", {
-    organizationId: import("convex/values").GenericId<"organization">;
-}, Promise<any>>;
-export declare const organizationList: import("convex/server").RegisteredQuery<"public", {
-    ownerUserId?: import("convex/values").GenericId<"user"> | undefined;
-}, Promise<any>>;
-export declare const organizationUpdate: import("convex/server").RegisteredMutation<"public", {
-    organizationId: import("convex/values").GenericId<"organization">;
-    data: any;
-}, Promise<void>>;
-export declare const organizationDelete: import("convex/server").RegisteredMutation<"public", {
-    organizationId: import("convex/values").GenericId<"organization">;
-}, Promise<void>>;
-export declare const teamCreate: import("convex/server").RegisteredMutation<"public", {
-    slug?: string | undefined;
-    metadata?: any;
-    parentTeamId?: import("convex/values").GenericId<"team"> | undefined;
-    name: string;
-    organizationId: import("convex/values").GenericId<"organization">;
-}, Promise<any>>;
-export declare const teamGet: import("convex/server").RegisteredQuery<"public", {
-    teamId: import("convex/values").GenericId<"team">;
-}, Promise<any>>;
-export declare const teamListByOrganization: import("convex/server").RegisteredQuery<"public", {
-    organizationId: import("convex/values").GenericId<"organization">;
-}, Promise<any>>;
-export declare const teamUpdate: import("convex/server").RegisteredMutation<"public", {
-    teamId: import("convex/values").GenericId<"team">;
-    data: any;
-}, Promise<void>>;
-export declare const teamDelete: import("convex/server").RegisteredMutation<"public", {
-    teamId: import("convex/values").GenericId<"team">;
-}, Promise<void>>;
-export declare const teamRelationCreate: import("convex/server").RegisteredMutation<"public", {
-    relation?: string | undefined;
-    organizationId: import("convex/values").GenericId<"organization">;
-    parentTeamId: import("convex/values").GenericId<"team">;
-    childTeamId: import("convex/values").GenericId<"team">;
-}, Promise<any>>;
-export declare const teamRelationGet: import("convex/server").RegisteredQuery<"public", {
-    teamRelationId: import("convex/values").GenericId<"teamRelation">;
-}, Promise<any>>;
-export declare const teamRelationListByParent: import("convex/server").RegisteredQuery<"public", {
-    organizationId: import("convex/values").GenericId<"organization">;
-    parentTeamId: import("convex/values").GenericId<"team">;
-}, Promise<any>>;
-export declare const teamRelationDelete: import("convex/server").RegisteredMutation<"public", {
-    teamRelationId: import("convex/values").GenericId<"teamRelation">;
-}, Promise<void>>;
-export declare const memberAdd: import("convex/server").RegisteredMutation<"public", {
-    data: any;
-}, Promise<any>>;
+/** Remove a member from a group by deleting the member record. */
 export declare const memberRemove: import("convex/server").RegisteredMutation<"public", {
     memberId: import("convex/values").GenericId<"member">;
 }, Promise<void>>;
-export declare const memberList: import("convex/server").RegisteredQuery<"public", {
-    teamId?: import("convex/values").GenericId<"team"> | undefined;
-    organizationId: import("convex/values").GenericId<"organization">;
-}, Promise<any>>;
-export declare const memberRoleSet: import("convex/server").RegisteredMutation<"public", {
-    role: string;
+/**
+ * Update a member record's fields (role, status, extend).
+ *
+ * Common usage: `memberUpdate({ memberId, data: { role: "admin" } })`
+ */
+export declare const memberUpdate: import("convex/server").RegisteredMutation<"public", {
+    data: any;
     memberId: import("convex/values").GenericId<"member">;
 }, Promise<void>>;
-export declare const memberRoleGet: import("convex/server").RegisteredQuery<"public", {
-    memberId: import("convex/values").GenericId<"member">;
-}, Promise<any>>;
+/**
+ * Create a new platform-level invitation. Optionally set `groupId` to tie
+ * the invite to a specific group. The invitation is sent to an email address
+ * and includes a hashed token for secure acceptance.
+ *
+ * Throws `ConvexError` with code `DUPLICATE_INVITE` when a pending invite
+ * already exists for the same email and scope:
+ * - group invite: same `email` + same `groupId`
+ * - platform invite: same `email` with no `groupId`
+ *
+ * @returns The ID of the new invite record.
+ */
 export declare const inviteCreate: import("convex/server").RegisteredMutation<"public", {
-    data: any;
-}, Promise<any>>;
+    extend?: any;
+    groupId?: import("convex/values").GenericId<"group"> | undefined;
+    role?: string | undefined;
+    email: string;
+    status: "pending" | "accepted" | "revoked" | "expired";
+    invitedByUserId: import("convex/values").GenericId<"user">;
+    tokenHash: string;
+    expiresTime: number;
+}, Promise<import("convex/values").GenericId<"invite">>>;
+/** Retrieve an invite by its document ID. Returns `null` if not found. */
 export declare const inviteGet: import("convex/server").RegisteredQuery<"public", {
     inviteId: import("convex/values").GenericId<"invite">;
-}, Promise<any>>;
+}, Promise<{
+    _id: import("convex/values").GenericId<"invite">;
+    _creationTime: number;
+    extend?: any;
+    groupId?: import("convex/values").GenericId<"group"> | undefined;
+    role?: string | undefined;
+    acceptedByUserId?: import("convex/values").GenericId<"user"> | undefined;
+    acceptedTime?: number | undefined;
+    email: string;
+    status: "pending" | "accepted" | "revoked" | "expired";
+    invitedByUserId: import("convex/values").GenericId<"user">;
+    tokenHash: string;
+    expiresTime: number;
+} | null>>;
+/**
+ * List invites, optionally filtered by group and/or status.
+ * Both `groupId` and `status` are optional filters.
+ */
 export declare const inviteList: import("convex/server").RegisteredQuery<"public", {
-    organizationId?: import("convex/values").GenericId<"organization"> | undefined;
-    status?: string | undefined;
-}, Promise<any>>;
+    groupId?: import("convex/values").GenericId<"group"> | undefined;
+    status?: "pending" | "accepted" | "revoked" | "expired" | undefined;
+}, Promise<{
+    _id: import("convex/values").GenericId<"invite">;
+    _creationTime: number;
+    extend?: any;
+    groupId?: import("convex/values").GenericId<"group"> | undefined;
+    role?: string | undefined;
+    acceptedByUserId?: import("convex/values").GenericId<"user"> | undefined;
+    acceptedTime?: number | undefined;
+    email: string;
+    status: "pending" | "accepted" | "revoked" | "expired";
+    invitedByUserId: import("convex/values").GenericId<"user">;
+    tokenHash: string;
+    expiresTime: number;
+}[]>>;
+/**
+ * Accept a pending invitation.
+ *
+ * Marks the invite as "accepted" and records the acceptance timestamp.
+ * Throws a structured `ConvexError` when the invite doesn't exist or is not
+ * currently pending.
+ *
+ * The caller is responsible for creating the corresponding member record.
+ */
 export declare const inviteAccept: import("convex/server").RegisteredMutation<"public", {
     inviteId: import("convex/values").GenericId<"invite">;
 }, Promise<void>>;
+/**
+ * Revoke a pending invitation.
+ *
+ * Marks the invite as "revoked". Throws a structured `ConvexError` when the
+ * invite doesn't exist or is not currently pending.
+ */
 export declare const inviteRevoke: import("convex/server").RegisteredMutation<"public", {
     inviteId: import("convex/values").GenericId<"invite">;
 }, Promise<void>>;

package/dist/component/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/component/public.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,WAAW;;;;;;;;;;;;;UAKtB,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;UAUlC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;UAUlC,CAAC;AAEH,eAAO,MAAM,UAAU;;sDAKrB,CAAC;AAEH,eAAO,MAAM,UAAU;;;sDASrB,CAAC;AAEH,eAAO,MAAM,SAAS;;;iBAKpB,CAAC;AAGH,eAAO,MAAM,UAAU;;;;;;;;;;;;UAUrB,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;;;;;;;UAKzB,CAAC;AAEH,eAAO,MAAM,aAAa;;;;;yDAUxB,CAAC;AAEH,eAAO,MAAM,YAAY;;;iBAKvB,CAAC;AAEH,eAAO,MAAM,aAAa;;iBAKxB,CAAC;AAGH,eAAO,MAAM,aAAa;;;yDAQxB,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;;;UAKzB,CAAC;AAEH,eAAO,MAAM,aAAa;;iBAOxB,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;KAQ5B,CAAC;AAGH,eAAO,MAAM,cAAc;;0DAKzB,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;UAK1B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;UAQjC,CAAC;AAEH,eAAO,MAAM,aAAa;;;iBAKxB,CAAC;AAEH,eAAO,MAAM,cAAc;;iBAKzB,CAAC;AAGH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;UAQzC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;UAQpC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;8DAajC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;iBAKjC,CAAC;AAGH,eAAO,MAAM,kBAAkB;;;;uDAS7B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;UAK9B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;iBAK5B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;KAelC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;KAUpC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;iBAWhC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;UAUhC,CAAC;AAGH,eAAO,MAAM,YAAY;;;;;;;;UAQvB,CAAC;AAEH,eAAO,MAAM,eAAe;;;;uDAS1B,CAAC;AAEH,eAAO,MAAM,cAAc;;;iBAKzB,CAAC;AAEH,eAAO,MAAM,eAAe;;iBAK1B,CAAC;AAGH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;UAAiC,CAAC;AACzE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;UAA4B,CAAC;AAC/D,eAAO,MAAM,kBAAkB;;;;;;;;8DAAyB,CAAC;AACzD,eAAO,MAAM,kBAAkB;;iBAAyB,CAAC;AAEzD,eAAO,MAAM,WAAW;;;;uDAAqB,CAAC;AAC9C,eAAO,MAAM,YAAY;;;;;;;;;UAAsB,CAAC;AAChD,eAAO,MAAM,UAAU;;;iBAAoB,CAAC;AAC5C,eAAO,MAAM,gBAAgB;;;;;;;;;;KAA0B,CAAC;AACxD,eAAO,MAAM,kBAAkB;;;;;;;;;KAA4B,CAAC;AAC5D,eAAO,MAAM,cAAc;;iBAAwB,CAAC;AACpD,eAAO,MAAM,cAAc;;;;;;;;;UAAwB,CAAC;AAEpD,eAAO,MAAM,QAAQ;;;;;;;;UAAe,CAAC;AACrC,eAAO,MAAM,WAAW;;;;uDAAkB,CAAC;AAC3C,eAAO,MAAM,UAAU;;;iBAAiB,CAAC;AACzC,eAAO,MAAM,WAAW;;iBAAkB,CAAC;AAG3C,eAAO,MAAM,kBAAkB;;gBAK7B,CAAC;AAEH,eAAO,MAAM,eAAe;;gBAK1B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;gBAW3B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;iBAK7B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;iBAK7B,CAAC;AAGH,eAAO,MAAM,UAAU;;;;;;gBAWrB,CAAC;AAEH,eAAO,MAAM,OAAO;;gBAKlB,CAAC;AAEH,eAAO,MAAM,sBAAsB;;gBAUjC,CAAC;AAEH,eAAO,MAAM,UAAU;;;iBAKrB,CAAC;AAEH,eAAO,MAAM,UAAU;;iBAKrB,CAAC;AAGH,eAAO,MAAM,kBAAkB;;;;;gBAU7B,CAAC;AAEH,eAAO,MAAM,eAAe;;gBAK1B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;gBAanC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;iBAK7B,CAAC;AAGH,eAAO,MAAM,SAAS;;gBAKpB,CAAC;AAEH,eAAO,MAAM,YAAY;;iBAKvB,CAAC;AAEH,eAAO,MAAM,UAAU;;;gBAmBrB,CAAC;AAEH,eAAO,MAAM,aAAa;;;iBAKxB,CAAC;AAEH,eAAO,MAAM,aAAa;;gBAMxB,CAAC;AAGH,eAAO,MAAM,YAAY;;gBAKvB,CAAC;AAEH,eAAO,MAAM,SAAS;;gBAKpB,CAAC;AAEH,eAAO,MAAM,UAAU;;;gBAgCrB,CAAC;AAEH,eAAO,MAAM,YAAY;;iBAQvB,CAAC;AAEH,eAAO,MAAM,YAAY;;iBAKvB,CAAC"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/component/public.ts"],"names":[],"mappings":"AAOA,4CAA4C;AAC5C,eAAO,MAAM,WAAW;;;;;;;;;;;;;UAKtB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;UAUlC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;UAUlC,CAAC;AAEH,kCAAkC;AAClC,eAAO,MAAM,UAAU;;sDAKrB,CAAC;AAEH,mDAAmD;AACnD,eAAO,MAAM,UAAU;;;sDASrB,CAAC;AAEH,yDAAyD;AACzD,eAAO,MAAM,SAAS;;;iBAKpB,CAAC;AAMH,uEAAuE;AACvE,eAAO,MAAM,UAAU;;;;;;;;;;;;UAUrB,CAAC;AAEH,8CAA8C;AAC9C,eAAO,MAAM,cAAc;;;;;;;;;;;UAKzB,CAAC;AAEH,+DAA+D;AAC/D,eAAO,MAAM,aAAa;;;;;yDAUxB,CAAC;AAEH,4DAA4D;AAC5D,eAAO,MAAM,YAAY;;;iBAKvB,CAAC;AAEH,kCAAkC;AAClC,eAAO,MAAM,aAAa;;iBAKxB,CAAC;AAMH,+DAA+D;AAC/D,eAAO,MAAM,aAAa;;;yDAQxB,CAAC;AAEH,6CAA6C;AAC7C,eAAO,MAAM,cAAc;;;;;;;UAKzB,CAAC;AAEH,6DAA6D;AAC7D,eAAO,MAAM,aAAa;;iBAOxB,CAAC;AAEH,oCAAoC;AACpC,eAAO,MAAM,iBAAiB;;;;;;;KAQ5B,CAAC;AAMH,kEAAkE;AAClE,eAAO,MAAM,cAAc;;0DAKzB,CAAC;AAEH,8CAA8C;AAC9C,eAAO,MAAM,eAAe;;;;;;;UAK1B,CAAC;AAEH,yDAAyD;AACzD,eAAO,MAAM,sBAAsB;;;;;;;UAQjC,CAAC;AAEH,mDAAmD;AACnD,eAAO,MAAM,aAAa;;;iBAKxB,CAAC;AAEH,kCAAkC;AAClC,eAAO,MAAM,cAAc;;iBAKzB,CAAC;AAMH,6DAA6D;AAC7D,eAAO,MAAM,8BAA8B;;;;;;;;;;;;UAQzC,CAAC;AAEH,mDAAmD;AACnD,eAAO,MAAM,yBAAyB;;;;;;;;;;;;UAQpC,CAAC;AAEH,0EAA0E;AAC1E,eAAO,MAAM,sBAAsB;;;;;;;;8DAajC,CAAC;AAEH,2CAA2C;AAC3C,eAAO,MAAM,sBAAsB;;iBAKjC,CAAC;AAMH,gDAAgD;AAChD,eAAO,MAAM,kBAAkB;;;;uDAS7B,CAAC;AAEH,mDAAmD;AACnD,eAAO,MAAM,mBAAmB;;;;;;;;;UAK9B,CAAC;AAEH,wDAAwD;AACxD,eAAO,MAAM,iBAAiB;;;iBAK5B,CAAC;AAEH,gFAAgF;AAChF,eAAO,MAAM,uBAAuB;;;;;;;;;;KAelC,CAAC;AAEH,6CAA6C;AAC7C,eAAO,MAAM,yBAAyB;;;;;;;;;KAUpC,CAAC;AAEH,+CAA+C;AAC/C,eAAO,MAAM,qBAAqB;;iBAWhC,CAAC;AAEH,2DAA2D;AAC3D,eAAO,MAAM,qBAAqB;;;;;;;;;UAUhC,CAAC;AAMH,oDAAoD;AACpD,eAAO,MAAM,YAAY;;;;;;;;UAQvB,CAAC;AAEH,qCAAqC;AACrC,eAAO,MAAM,eAAe;;;;uDAS1B,CAAC;AAEH,kDAAkD;AAClD,eAAO,MAAM,cAAc;;;iBAKzB,CAAC;AAEH,iCAAiC;AACjC,eAAO,MAAM,eAAe;;iBAK1B,CAAC;AAMH;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;;;uDAUtB,CAAC;AAEH,wEAAwE;AACxE,eAAO,MAAM,QAAQ;;;;;;;;;UAKnB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,SAAS;;;;;;;;;KAQpB,CAAC;AAEH,mEAAmE;AACnE,eAAO,MAAM,WAAW;;;iBAKtB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;iBAiCtB,CAAC;AAMH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS;;;;;;wDA0BpB,CAAC;AAEH,gFAAgF;AAChF,eAAO,MAAM,SAAS;;;;;;;;;;UAKpB,CAAC;AAEH,4CAA4C;AAC5C,eAAO,MAAM,UAAU;;;;;;;;;;KAQrB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;KAQ3B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;UAUlC,CAAC;AAEH,kEAAkE;AAClE,eAAO,MAAM,YAAY;;iBAKvB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;iBAKvB,CAAC;AAMH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY;;;;;;;;;wDAqDvB,CAAC;AAEH,0EAA0E;AAC1E,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;UAKpB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;KAmCrB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;iBAwBvB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,YAAY;;iBAqBvB,CAAC"}