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

package/dist/server/convex-auth.d.ts

@@ -0,0 +1,296 @@
+/**
+ * The `Auth` class — the main entry point for Convex Auth.
+ *
+ * Combines authentication and portal admin functionality:
+ *
+ * ```ts
+ * // convex/auth.ts
+ * import { Auth, Portal } from "@robelest/convex-auth/component";
+ * import google from "@auth/core/providers/google";
+ * import { components } from "./_generated/api";
+ *
+ * export const auth = new Auth(components.auth, {
+ *   providers: [google],
+ *   email: {
+ *     from: "My App <noreply@example.com>",
+ *     send: async (_ctx, { from, to, subject, html }) => {
+ *       await fetch("https://api.resend.com/emails", {
+ *         method: "POST",
+ *         headers: {
+ *           Authorization: `Bearer ${process.env.AUTH_RESEND_KEY}`,
+ *           "Content-Type": "application/json",
+ *         },
+ *         body: JSON.stringify({ from, to, subject, html }),
+ *       });
+ *     },
+ *   },
+ * });
+ * export const { signIn, signOut, store } = auth;
+ * export const { portalQuery, portalMutation, portalInternal } = Portal(auth);
+ * ```
+ *
+ * @module
+ */
+import type { HttpRouter } from "convex/server";
+import type { ComponentApi as AuthComponentApi } from "../component/_generated/component.js";
+import { Auth as AuthFactory } from "./implementation/index.js";
+import type { ConvexAuthConfig } from "./types.js";
+/**
+ * Config for the Auth class. Extends the standard auth config
+ * minus `component` (which is passed as the first constructor argument).
+ *
+ * When `email` is configured, the library auto-registers:
+ * - A magic link provider (`id: "email"`) for user-facing sign-in
+ * - A portal provider (`id: "portal"`) for admin dashboard sign-in
+ *
+ * Portal functionality is always available — no configuration flag
+ * needed. The portal UI works when you export `portalQuery`,
+ * `portalMutation`, `portalInternal` from your `convex/auth.ts`
+ * and upload the portal static files via CLI.
+ */
+export type AuthClassConfig = Omit<ConvexAuthConfig, "component">;
+/**
+ * Main entry point for Convex Auth. Instantiate with your component
+ * reference and config to get all the exports you need.
+ *
+ * ```ts
+ * export const auth = new Auth(components.auth, {
+ *   providers: [google, password],
+ *   email: {
+ *     from: "My App <noreply@example.com>",
+ *     send: (ctx, params) => resend.sendEmail(ctx, params),
+ *   },
+ * });
+ * export const { signIn, signOut, store } = auth;
+ * export const { portalQuery, portalMutation, portalInternal } = Portal(auth);
+ * ```
+ */
+export declare class Auth {
+    /** The inner `auth` helper object from AuthFactory() */
+    private readonly _auth;
+    /** The signIn action — export this from your convex/auth.ts */
+    readonly signIn: ReturnType<typeof AuthFactory>["signIn"];
+    /** The signOut action — export this from your convex/auth.ts */
+    readonly signOut: ReturnType<typeof AuthFactory>["signOut"];
+    /** The store internal mutation — export this from your convex/auth.ts */
+    readonly store: ReturnType<typeof AuthFactory>["store"];
+    /** @internal */
+    readonly component: AuthComponentApi;
+    /** @internal */
+    readonly portalUrl: string;
+    /** User helpers: `.current(ctx)`, `.require(ctx)`, `.get(ctx, userId)`, `.viewer(ctx)` */
+    get user(): {
+        current: (ctx: {
+            auth: import("convex/server").Auth;
+        }) => Promise<import("convex/values").GenericId<"user"> | null>;
+        require: (ctx: {
+            auth: import("convex/server").Auth;
+        }) => Promise<import("convex/values").GenericId<"user">>;
+        get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, userId: string) => Promise<any>;
+        viewer: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery"> & {
+            auth: import("convex/server").Auth;
+        }) => Promise<any>;
+        group: {
+            list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+                userId: string;
+            }) => Promise<any>;
+            get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+                userId: string;
+                groupId: string;
+            }) => Promise<any>;
+        };
+    };
+    /** Session helpers */
+    get session(): {
+        current: (ctx: {
+            auth: import("convex/server").Auth;
+        }) => Promise<import("convex/values").GenericId<"session"> | null>;
+        invalidate: <DataModel extends import("convex/server").GenericDataModel>(ctx: import("convex/server").GenericActionCtx<DataModel>, args: {
+            userId: import("convex/values").GenericId<"user">;
+            except?: import("convex/values").GenericId<"session">[];
+        }) => Promise<void>;
+    };
+    /** Provider helpers */
+    get provider(): {
+        signIn: <DataModel extends import("convex/server").GenericDataModel>(ctx: import("convex/server").GenericActionCtx<DataModel>, provider: import("./types.js").AuthProviderConfig, args: {
+            accountId?: import("convex/values").GenericId<"account">;
+            params?: Record<string, unknown>;
+        }) => Promise<{
+            userId: import("convex/values").GenericId<"user">;
+            sessionId: import("convex/values").GenericId<"session">;
+        } | null>;
+    };
+    /** Account helpers */
+    get account(): {
+        create: <DataModel extends import("convex/server").GenericDataModel>(ctx: import("convex/server").GenericActionCtx<DataModel>, args: {
+            provider: string;
+            account: {
+                id: string;
+                secret?: string;
+            };
+            profile: Record<string, unknown>;
+            shouldLinkViaEmail?: boolean;
+            shouldLinkViaPhone?: boolean;
+        }) => Promise<{
+            account: import("./implementation/types.js").Doc<"account">;
+            user: import("./implementation/types.js").Doc<"user">;
+        }>;
+        get: <DataModel extends import("convex/server").GenericDataModel>(ctx: import("convex/server").GenericActionCtx<DataModel>, args: {
+            provider: string;
+            account: {
+                id: string;
+                secret?: string;
+            };
+        }) => Promise<{
+            account: import("./implementation/types.js").Doc<"account">;
+            user: import("./implementation/types.js").Doc<"user">;
+        }>;
+        updateCredentials: <DataModel extends import("convex/server").GenericDataModel>(ctx: import("convex/server").GenericActionCtx<DataModel>, args: {
+            provider: string;
+            account: {
+                id: string;
+                secret: string;
+            };
+        }) => Promise<void>;
+    };
+    /** Group helpers */
+    get group(): {
+        create: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, data: {
+            name: string;
+            slug?: string;
+            parentGroupId?: string;
+            extend?: Record<string, unknown>;
+        }) => Promise<string>;
+        get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, groupId: string) => Promise<any>;
+        list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts?: {
+            parentGroupId?: string;
+        }) => Promise<any>;
+        update: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, groupId: string, data: Record<string, unknown>) => Promise<void>;
+        delete: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, groupId: string) => Promise<void>;
+        member: {
+            add: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, data: {
+                groupId: string;
+                userId: string;
+                role?: string;
+                status?: string;
+                extend?: Record<string, unknown>;
+            }) => Promise<string>;
+            get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, memberId: string) => Promise<any>;
+            list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+                groupId: string;
+            }) => Promise<any>;
+            remove: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, memberId: string) => Promise<void>;
+            update: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, memberId: string, data: Record<string, unknown>) => Promise<void>;
+        };
+    };
+    /** Invite helpers */
+    get invite(): {
+        create: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, data: {
+            groupId?: string;
+            invitedByUserId?: string;
+            email?: string;
+            tokenHash: string;
+            role?: string;
+            status: "pending" | "accepted" | "revoked" | "expired";
+            expiresTime?: number;
+            extend?: Record<string, unknown>;
+        }) => Promise<string>;
+        get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, inviteId: string) => Promise<any>;
+        getByTokenHash: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, tokenHash: string) => Promise<any>;
+        list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts?: {
+            groupId?: string;
+            status?: "pending" | "accepted" | "revoked" | "expired";
+        }) => Promise<any>;
+        accept: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, inviteId: string, acceptedByUserId?: string) => Promise<void>;
+        revoke: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, inviteId: string) => Promise<void>;
+    };
+    /** Passkey helpers */
+    get passkey(): {
+        list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+            userId: string;
+        }) => Promise<any>;
+        rename: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, passkeyId: string, name: string) => Promise<void>;
+        remove: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, passkeyId: string) => Promise<void>;
+    };
+    /** TOTP helpers */
+    get totp(): {
+        list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+            userId: string;
+        }) => Promise<any>;
+        remove: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, totpId: string) => Promise<void>;
+    };
+    /** API key helpers: `.create(ctx, ...)`, `.verify(ctx, ...)`, `.list(ctx, ...)`, `.revoke(ctx, ...)` */
+    get key(): {
+        create: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, opts: {
+            userId: string;
+            name: string;
+            scopes: import("./types.js").KeyScope[];
+            rateLimit?: {
+                maxRequests: number;
+                windowMs: number;
+            };
+            expiresAt?: number;
+        }) => Promise<{
+            keyId: string;
+            raw: string;
+        }>;
+        verify: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, rawKey: string) => Promise<{
+            userId: string;
+            keyId: string;
+            scopes: import("./types.js").ScopeChecker;
+        }>;
+        list: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, opts: {
+            userId: string;
+        }) => Promise<any>;
+        get: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery">, keyId: string) => Promise<any>;
+        update: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, keyId: string, data: {
+            name?: string;
+            scopes?: import("./types.js").KeyScope[];
+            rateLimit?: {
+                maxRequests: number;
+                windowMs: number;
+            };
+        }) => Promise<void>;
+        revoke: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, keyId: string) => Promise<void>;
+        remove: (ctx: Pick<import("convex/server").GenericActionCtx<import("convex/server").GenericDataModel>, "runQuery" | "runMutation">, keyId: string) => Promise<void>;
+    };
+    constructor(component: AuthComponentApi, config: AuthClassConfig);
+    /**
+     * Register HTTP routes for OAuth, JWT well-known endpoints, and portal
+     * static file serving.
+     *
+     * ```ts
+     * // convex/http.ts
+     * import { httpRouter } from "convex/server";
+     * import { auth } from "./auth";
+     *
+     * const http = httpRouter();
+     * auth.addHttpRoutes(http);
+     * export default http;
+     * ```
+     */
+    addHttpRoutes(http: HttpRouter, opts?: {
+        pathPrefix?: string;
+        spaFallback?: boolean;
+    }): void;
+}
+/**
+ * Create portal function definitions from a ConvexAuth instance.
+ *
+ * This is a standalone function (not a class method) because Convex's
+ * bundler can trace through `export const { x } = fn(instance)` but
+ * cannot trace through `instance.method()`.
+ *
+ * ```ts
+ * export const { portalQuery, portalMutation, portalInternal } = Portal(auth);
+ * ```
+ */
+export declare function Portal(auth: Auth): {
+    portalQuery: import("convex/server").RegisteredQuery<"public", {
+        action: string;
+        userId?: string;
+    }, Promise<any>>;
+    portalMutation: import("convex/server").RegisteredMutation<"public", any, Promise<any>>;
+    portalInternal: import("convex/server").RegisteredMutation<"internal", any, Promise<any>>;
+};
+//# sourceMappingURL=convex-auth.d.ts.map

package/dist/server/convex-auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convex-auth.d.ts","sourceRoot":"","sources":["../../src/server/convex-auth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAQH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,KAAK,EAAE,YAAY,IAAI,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAC7F,OAAO,EAAE,IAAI,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAkB,MAAM,YAAY,CAAC;AAWnE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;AAiClE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,IAAI;IACf,wDAAwD;IACxD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyC;IAC/D,+DAA+D;IAC/D,SAAgB,MAAM,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC;IACjE,gEAAgE;IAChE,SAAgB,OAAO,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,yEAAyE;IACzE,SAAgB,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;IAE/D,gBAAgB;IAChB,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IACrC,gBAAgB;IAChB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAG3B,0FAA0F;IAC1F,IAAI,IAAI;;;;;;;;;;;;;;;;;;;;MAA8B;IACtC,sBAAsB;IACtB,IAAI,OAAO;;;;;;kBAwED,CAAA;;MAxEkC;IAC5C,uBAAuB;IACvB,IAAI,QAAQ;;qBAkID,CAAC;kBACa,CAAC;;;;;MAnIoB;IAC9C,sBAAsB;IACtB,IAAI,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAiC;IAC5C,oBAAoB;IACpB,IAAI,KAAK;;;gBAgKO,CAAA;yBACO,CAAC;kBACpB,CAAC;;;;yBAqBqB,CAAC;;;;;;;;oBA4DnB,CAAD;sBACgB,CAAA;sBAA6B,CAAA;;;;;;;;;MApPZ;IACxC,qBAAqB;IACrB,IAAI,MAAM;;mBA0UE,CAAC;2BAGM,CAAC;iBACd,CAAL;;gBACyB,CAAC;;uBAC0B,CAAC;kBAClC,CAAC;;;;;mBA0BV,CAAA;kBAA0B,CAAC;;;;MA3WI;IAC1C,sBAAsB;IACtB,IAAI,OAAO;;;;;;MAAiC;IAC5C,mBAAmB;IACnB,IAAI,IAAI;;;;;MAA8B;IACtC,wGAAwG;IACxG,IAAI,GAAG;;;;;qBAocm6F,CAAC;;;;qBAAgE,CAAC;;;;;;;;;;;;;;;gBAA83G,CAAC;kBAA0B,CAAC;qBAAuD,CAAC;;;;;;;MApc15M;gBAExB,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,eAAe;IAmFhE;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAA;KAAE,GACpD,IAAI;CAsDR;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI;;gBAYG,MAAM;iBAAW,MAAM;;;;EA0Q1D"}