@robelest/convex-auth 0.0.1

package/dist/server/implementation/index.d.ts

@@ -0,0 +1,370 @@
+import { Auth, DocumentByName, GenericActionCtx, GenericDataModel, HttpRouter, WithoutSystemFields } from "convex/server";
+import { GenericId, Value } from "convex/values";
+import { FunctionReferenceFromExport, GenericDoc } from "../convex_types.js";
+import { AuthProviderConfig, ConvexAuthConfig, GenericActionCtxWithAuthConfig } from "../types.js";
+import { Tokens } from "./types.js";
+export { authTables, Doc, Tokens } from "./types.js";
+export { getAuthSessionId } from "./sessions.js";
+/**
+ * The type of the signIn Convex Action returned from the auth() helper.
+ *
+ * This type is exported for implementors of other client integrations.
+ * However it is not stable, and may change until this library reaches 1.0.
+ */
+export type SignInAction = FunctionReferenceFromExport<ReturnType<typeof Auth>["signIn"]>;
+/**
+ * The type of the signOut Convex Action returned from the auth() helper.
+ *
+ * This type is exported for implementors of other client integrations.
+ * However it is not stable, and may change until this library reaches 1.0.
+ */
+export type SignOutAction = FunctionReferenceFromExport<ReturnType<typeof Auth>["signOut"]>;
+/**
+ * Configure the Convex Auth library. Returns an object with
+ * functions and `auth` helper. You must export the functions
+ * from `convex/auth.ts` to make them callable:
+ *
+ * ```ts filename="convex/auth.ts"
+ * import { Auth } from "@robelest/convex-auth/component";
+ *
+ * export const { auth, signIn, signOut, store } = Auth({
+ *   providers: [],
+ * });
+ * ```
+ *
+ * @returns An object with fields you should reexport from your
+ *          `convex/auth.ts` file.
+ */
+export declare function Auth(config_: ConvexAuthConfig): {
+    /**
+     * Helper for configuring HTTP actions.
+     */
+    auth: {
+        user: {
+            current: (ctx: {
+                auth: Auth;
+            }) => Promise<GenericId<"user"> | null>;
+            require: (ctx: {
+                auth: Auth;
+            }) => Promise<GenericId<"user">>;
+            get: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery">, userId: string) => Promise<any>;
+            viewer: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery"> & {
+                auth: Auth;
+            }) => Promise<any>;
+        };
+        organization: {
+            create: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, data: Record<string, unknown>) => Promise<string>;
+            get: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, organizationId: string) => Promise<any>;
+            list: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, ownerUserId?: string) => Promise<any>;
+            update: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, organizationId: string, data: Record<string, unknown>) => Promise<void>;
+            delete: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, organizationId: string) => Promise<void>;
+            member: {
+                add: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, data: Record<string, unknown>) => Promise<string>;
+                remove: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, memberId: string) => Promise<void>;
+                list: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, args: {
+                    organizationId: string;
+                    teamId?: string;
+                }) => Promise<any>;
+                role: {
+                    set: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, memberId: string, role: string) => Promise<void>;
+                    get: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, memberId: string) => Promise<any>;
+                };
+            };
+        };
+        invite: {
+            create: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, data: Record<string, unknown>) => Promise<string>;
+            get: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, inviteId: string) => Promise<any>;
+            list: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, args: {
+                organizationId?: string;
+                status?: string;
+            }) => Promise<any>;
+            accept: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, inviteId: string) => Promise<void>;
+            revoke: (ctx: Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">, inviteId: string) => Promise<void>;
+        };
+        /**
+         * Add HTTP actions for JWT verification and OAuth sign-in.
+         *
+         * ```ts
+         * import { httpRouter } from "convex/server";
+         * import { auth } from "./auth.js";
+         *
+         * const http = httpRouter();
+         *
+         * auth.addHttpRoutes(http);
+         *
+         * export default http;
+         * ```
+         *
+         * The following routes are handled always:
+         *
+         * - `/.well-known/openid-configuration`
+         * - `/.well-known/jwks.json`
+         *
+         * The following routes are handled if OAuth is configured:
+         *
+         * - `/api/auth/signin/*`
+         * - `/api/auth/callback/*`
+         *
+         * @param http your HTTP router
+         */
+        addHttpRoutes: (http: HttpRouter) => void;
+    };
+    /**
+     * Action called by the client to sign the user in.
+     *
+     * Also used for refreshing the session.
+     */
+    signIn: import("convex/server").RegisteredAction<"public", {
+        provider?: string | undefined;
+        verifier?: string | undefined;
+        refreshToken?: string | undefined;
+        params?: any;
+        calledBy?: string | undefined;
+    }, Promise<{
+        redirect?: string;
+        verifier?: string;
+        tokens?: Tokens | null;
+        started?: boolean;
+    }>>;
+    /**
+     * Action called by the client to invalidate the current session.
+     */
+    signOut: import("convex/server").RegisteredAction<"public", {}, Promise<void>>;
+    /**
+     * Internal mutation used by the library to read and write
+     * to the database during signin and signout.
+     */
+    store: import("convex/server").RegisteredMutation<"internal", {
+        args: {
+            sessionId?: string | undefined;
+            type: "signIn";
+            userId: string;
+            generateTokens: boolean;
+        } | {
+            type: "signOut";
+        } | {
+            type: "refreshSession";
+            refreshToken: string;
+        } | {
+            provider?: string | undefined;
+            verifier?: string | undefined;
+            type: "verifyCodeAndSignIn";
+            generateTokens: boolean;
+            params: any;
+            allowExtraProviders: boolean;
+        } | {
+            type: "verifier";
+        } | {
+            type: "verifierSignature";
+            verifier: string;
+            signature: string;
+        } | {
+            type: "userOAuth";
+            profile: any;
+            provider: string;
+            providerAccountId: string;
+            signature: string;
+        } | {
+            email?: string | undefined;
+            phone?: string | undefined;
+            accountId?: string | undefined;
+            type: "createVerificationCode";
+            expirationTime: number;
+            provider: string;
+            code: string;
+            allowExtraProviders: boolean;
+        } | {
+            shouldLinkViaEmail?: boolean | undefined;
+            shouldLinkViaPhone?: boolean | undefined;
+            type: "createAccountFromCredentials";
+            profile: any;
+            account: {
+                secret?: string | undefined;
+                id: string;
+            };
+            provider: string;
+        } | {
+            type: "retrieveAccountWithCredentials";
+            account: {
+                secret?: string | undefined;
+                id: string;
+            };
+            provider: string;
+        } | {
+            type: "modifyAccount";
+            account: {
+                id: string;
+                secret: string;
+            };
+            provider: string;
+        } | {
+            except?: string[] | undefined;
+            type: "invalidateSessions";
+            userId: string;
+        };
+    }, Promise<string | void | {
+        userId: GenericId<"user">;
+        sessionId: GenericId<"session">;
+    } | {
+        token: string;
+        refreshToken: string;
+    } | {
+        account: import("./types.js").Doc<"account">;
+        user: import("./types.js").Doc<"user">;
+    } | null>>;
+};
+/**
+ * Return the currently signed-in user's ID.
+ *
+ * ```ts filename="convex/myFunctions.tsx"
+ * import { mutation } from "./_generated/server";
+ * import { getAuthUserId } from "@robelest/convex-auth/component";
+ *
+ * export const doSomething = mutation({
+ *   args: {/* ... *\/},
+ *   handler: async (ctx, args) => {
+ *     const userId = await getAuthUserId(ctx);
+ *     if (userId === null) {
+ *       throw new Error("Client is not authenticated!")
+ *     }
+ *     const user = await ctx.db.get(userId);
+ *     // ...
+ *   },
+ * });
+ * ```
+ *
+ * @param ctx query, mutation or action `ctx`
+ * @returns the user ID or `null` if the client isn't authenticated
+ */
+export declare function getAuthUserId(ctx: {
+    auth: Auth;
+}): Promise<GenericId<"user"> | null>;
+/**
+ * Use this function from a
+ * [`ConvexCredentials`](https://labs.convex.dev/auth/api_reference/providers/ConvexCredentials)
+ * provider to create an account and a user with a unique account "id" (OAuth
+ * provider ID, email address, phone number, username etc.).
+ *
+ * @returns user ID if it successfully creates the account
+ * or throws an error.
+ */
+export declare function createAccount<DataModel extends GenericDataModel = GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+    /**
+     * The provider ID (like "password"), used to disambiguate accounts.
+     *
+     * It is also used to configure account secret hashing via the provider's
+     * `crypto` option.
+     */
+    provider: string;
+    account: {
+        /**
+         * The unique external ID for the account, for example email address.
+         */
+        id: string;
+        /**
+         * The secret credential to store for this account, if given.
+         */
+        secret?: string;
+    };
+    /**
+     * The profile data to store for the user.
+     * These must fit the `users` table schema.
+     */
+    profile: WithoutSystemFields<DocumentByName<DataModel, "user">>;
+    /**
+     * If `true`, the account will be linked to an existing user
+     * with the same verified email address.
+     * This is only safe if the returned account's email is verified
+     * before the user is allowed to sign in with it.
+     */
+    shouldLinkViaEmail?: boolean;
+    /**
+     * If `true`, the account will be linked to an existing user
+     * with the same verified phone number.
+     * This is only safe if the returned account's phone is verified
+     * before the user is allowed to sign in with it.
+     */
+    shouldLinkViaPhone?: boolean;
+}): Promise<{
+    account: GenericDoc<DataModel, "account">;
+    user: GenericDoc<DataModel, "user">;
+}>;
+/**
+ * Use this function from a
+ * [`ConvexCredentials`](https://labs.convex.dev/auth/api_reference/providers/ConvexCredentials)
+ * provider to retrieve a user given the account provider ID and
+ * the provider-specific account ID.
+ *
+ * @returns the retrieved user document, or `null` if there is no account
+ * for given account ID or throws if the provided
+ * secret does not match.
+ */
+export declare function retrieveAccount<DataModel extends GenericDataModel = GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+    /**
+     * The provider ID (like "password"), used to disambiguate accounts.
+     *
+     * It is also used to configure account secret hashing via the provider's
+     * `crypto` option.
+     */
+    provider: string;
+    account: {
+        /**
+         * The unique external ID for the account, for example email address.
+         */
+        id: string;
+        /**
+         * The secret that should match the stored credential, if given.
+         */
+        secret?: string;
+    };
+}): Promise<{
+    account: GenericDoc<DataModel, "account">;
+    user: GenericDoc<DataModel, "user">;
+}>;
+/**
+ * Use this function to modify the account credentials
+ * from a [`ConvexCredentials`](https://labs.convex.dev/auth/api_reference/providers/ConvexCredentials)
+ * provider.
+ */
+export declare function modifyAccountCredentials<DataModel extends GenericDataModel = GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+    /**
+     * The provider ID (like "password"), used to disambiguate accounts.
+     *
+     * It is also used to configure account secret hashing via the `crypto` option.
+     */
+    provider: string;
+    account: {
+        /**
+         * The unique external ID for the account, for example email address.
+         */
+        id: string;
+        /**
+         * The new secret credential to store for this account.
+         */
+        secret: string;
+    };
+}): Promise<void>;
+/**
+ * Use this function to invalidate existing sessions.
+ */
+export declare function invalidateSessions<DataModel extends GenericDataModel = GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+    userId: GenericId<"user">;
+    except?: GenericId<"session">[];
+}): Promise<void>;
+/**
+ * Use this function from a
+ * [`ConvexCredentials`](https://labs.convex.dev/auth/api_reference/providers/ConvexCredentials)
+ * provider to sign in the user via another provider (usually
+ * for email verification on sign up or password reset).
+ *
+ * Returns the user ID if the sign can proceed,
+ * or `null`.
+ */
+export declare function signInViaProvider<DataModel extends GenericDataModel = GenericDataModel>(ctx: GenericActionCtxWithAuthConfig<DataModel>, provider: AuthProviderConfig, args: {
+    accountId?: GenericId<"account">;
+    params?: Record<string, Value | undefined>;
+}): Promise<{
+    userId: GenericId<"user">;
+    sessionId: GenericId<"session">;
+} | null>;
+//# sourceMappingURL=index.d.ts.map

package/dist/server/implementation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/server/implementation/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,IAAI,EACJ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,mBAAmB,EAIpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAe,SAAS,EAAE,KAAK,EAAK,MAAM,eAAe,CAAC;AAGjE,OAAO,EAAE,2BAA2B,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAM7E,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC/B,MAAM,aAAa,CAAC;AAErB,OAAO,EAA0B,MAAM,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AA2BrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,2BAA2B,CACpD,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC,CAClC,CAAC;AACF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,2BAA2B,CACrD,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,SAAS,CAAC,CACnC,CAAC;AACF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,gBAAgB;IAgZ1C;;OAEG;;;2BAnWoB;gBAAE,IAAI,EAAE,IAAI,CAAA;aAAE;2BAQd;gBAAE,IAAI,EAAE,IAAI,CAAA;aAAE;qFAQQ,MAAM;;sBApBE,IAAI;;;;sGAoC/C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC5B,OAAO,CAAC,MAAM,CAAC;6GAM6B,MAAM;4GAQrC,MAAM;gHASJ,MAAM,QAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;gHAQmB,MAAM;;uGAS9C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC5B,OAAO,CAAC,MAAM,CAAC;8GAM0B,MAAM;wGAM1C;oBAAE,cAAc,EAAE,MAAM,CAAC;oBAAC,MAAM,CAAC,EAAE,MAAM,CAAA;iBAAE;;+GAMR,MAAM,QAAQ,MAAM;+GAOpB,MAAM;;;;;sGAY3C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC5B,OAAO,CAAC,MAAM,CAAC;uGAMuB,MAAM;oGAMvC;gBAAE,cAAc,CAAC,EAAE,MAAM,CAAC;gBAAC,MAAM,CAAC,EAAE,MAAM,CAAA;aAAE;0GAKR,MAAM;0GAIN,MAAM;;QAKpD;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;8BACmB,UAAU;;IAgMhC;;;;OAIG;;;;;;;;mBAaY,MAAM;mBACN,MAAM;iBACR,MAAM,GAAG,IAAI;kBACZ,OAAO;;IA4BrB;;OAEG;;IAQH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASN;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,aAAa,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,qCAOtD;AAED;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CACjC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,EAErD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,EAChC,IAAI,EAAE;IACJ;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACP;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;;OAGG;IACH,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAChE;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GACA,OAAO,CAAC;IACT,OAAO,EAAE,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;CACrC,CAAC,CAMD;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CACnC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,EAErD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,EAChC,IAAI,EAAE;IACJ;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACP;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,GACA,OAAO,CAAC;IACT,OAAO,EAAE,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;CACrC,CAAC,CAOD;AAED;;;;GAIG;AACH,wBAAsB,wBAAwB,CAC5C,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,EAErD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,EAChC,IAAI,EAAE;IACJ;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACP;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QACX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,GACA,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,EAErD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,EAChC,IAAI,EAAE;IACJ,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;CACjC,GACA,OAAO,CAAC,IAAI,CAAC,CAGf;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,EAErD,GAAG,EAAE,8BAA8B,CAAC,SAAS,CAAC,EAC9C,QAAQ,EAAE,kBAAkB,EAC5B,IAAI,EAAE;IACJ,SAAS,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC,CAAC;CAC5C;;;UAgBF"}