@estifanos-sh/convex-auth 0.0.1-preview.0

package/dist/svelte/SignedIn.svelte.d.ts

@@ -0,0 +1,8 @@
+import type { Snippet } from "svelte";
+type $$ComponentProps = {
+    children: Snippet<[string]>;
+};
+declare const SignedIn: import("svelte").Component<$$ComponentProps, {}, "">;
+type SignedIn = ReturnType<typeof SignedIn>;
+export default SignedIn;
+//# sourceMappingURL=SignedIn.svelte.d.ts.map

package/dist/svelte/SignedOut.svelte

@@ -0,0 +1,13 @@
+<script lang="ts">
+  import type { Snippet } from "svelte";
+
+  import { useConvexAuth } from "./context.svelte.js";
+
+  let { children }: { children: Snippet } = $props();
+
+  const auth = useConvexAuth();
+</script>
+
+{#if auth.signedOut}
+  {@render children()}
+{/if}

package/dist/svelte/SignedOut.svelte.d.ts

@@ -0,0 +1,8 @@
+import type { Snippet } from "svelte";
+type $$ComponentProps = {
+    children: Snippet;
+};
+declare const SignedOut: import("svelte").Component<$$ComponentProps, {}, "">;
+type SignedOut = ReturnType<typeof SignedOut>;
+export default SignedOut;
+//# sourceMappingURL=SignedOut.svelte.d.ts.map

package/dist/svelte/context.svelte.d.ts

@@ -0,0 +1,26 @@
+import type { AuthApiRefs, AuthClient } from "../browser/index";
+import type { AuthState, SignInOverloads } from "../client/core/types";
+type AnyAuthClient = AuthClient<AuthApiRefs<boolean, boolean, boolean>>;
+/** Reactive auth state bridged from the client's `subscribe`. Read its fields in markup. */
+export declare class ConvexAuth {
+    #private;
+    constructor(client: AnyAuthClient);
+    /** The discriminated auth state; narrow on `.status` to reach `token`. */
+    get state(): AuthState;
+    get status(): AuthState["status"];
+    get signedIn(): boolean;
+    get signedOut(): boolean;
+    get loading(): boolean;
+    get token(): string | null;
+    get signIn(): SignInOverloads;
+    get signOut(): () => Promise<void>;
+    /** The underlying imperative client, for factor flows (`totp`, `webauthn`, `device`). */
+    get client(): AnyAuthClient;
+    dispose(): void;
+}
+/** Expose an app-owned auth client as reactive `ConvexAuth` and share it via context. */
+export declare function setupConvexAuth(client: AnyAuthClient): ConvexAuth;
+/** Read the reactive auth shared by {@link setupConvexAuth} from a descendant component. */
+export declare function useConvexAuth(): ConvexAuth;
+export {};
+//# sourceMappingURL=context.svelte.d.ts.map

package/dist/svelte/context.svelte.js

@@ -0,0 +1,61 @@
+import { getContext, onDestroy, setContext } from "svelte";
+const AUTH_KEY = Symbol("convex-auth");
+/** Reactive auth state bridged from the client's `subscribe`. Read its fields in markup. */
+export class ConvexAuth {
+    #client;
+    #unsubscribe;
+    #state = $state({ status: "loading", token: null });
+    constructor(client) {
+        this.#client = client;
+        this.#unsubscribe = client.subscribe((state) => {
+            this.#state = state;
+        });
+    }
+    /** The discriminated auth state; narrow on `.status` to reach `token`. */
+    get state() {
+        return this.#state;
+    }
+    get status() {
+        return this.#state.status;
+    }
+    get signedIn() {
+        return this.#state.status === "signedIn";
+    }
+    get signedOut() {
+        return this.#state.status === "signedOut";
+    }
+    get loading() {
+        return this.#state.status === "loading";
+    }
+    get token() {
+        return this.#state.token;
+    }
+    get signIn() {
+        return this.#client.signIn;
+    }
+    get signOut() {
+        return this.#client.signOut;
+    }
+    /** The underlying imperative client, for factor flows (`totp`, `webauthn`, `device`). */
+    get client() {
+        return this.#client;
+    }
+    dispose() {
+        this.#unsubscribe();
+    }
+}
+/** Expose an app-owned auth client as reactive `ConvexAuth` and share it via context. */
+export function setupConvexAuth(client) {
+    const auth = new ConvexAuth(client);
+    onDestroy(() => auth.dispose());
+    setContext(AUTH_KEY, auth);
+    return auth;
+}
+/** Read the reactive auth shared by {@link setupConvexAuth} from a descendant component. */
+export function useConvexAuth() {
+    const auth = getContext(AUTH_KEY);
+    if (auth === undefined) {
+        throw new Error("useConvexAuth() must be called under a component tree that ran setupConvexAuth().");
+    }
+    return auth;
+}

package/dist/svelte/index.d.ts

@@ -0,0 +1,5 @@
+export { ConvexAuth, setupConvexAuth, useConvexAuth } from "./context.svelte.js";
+export { default as SignedIn } from "./SignedIn.svelte";
+export { default as SignedOut } from "./SignedOut.svelte";
+export { default as AuthLoading } from "./AuthLoading.svelte";
+//# sourceMappingURL=index.d.ts.map

package/dist/svelte/index.js

@@ -0,0 +1,4 @@
+export { ConvexAuth, setupConvexAuth, useConvexAuth } from "./context.svelte.js";
+export { default as SignedIn } from "./SignedIn.svelte";
+export { default as SignedOut } from "./SignedOut.svelte";
+export { default as AuthLoading } from "./AuthLoading.svelte";

package/dist/test.d.ts

@@ -0,0 +1,48 @@
+import { GenericSchema, SchemaDefinition } from "convex/server";
+import { TestConvex } from "convex-test";
+
+//#region src/test.d.ts
+/**
+ * Register the Convex Auth component (and its subcomponents) in a
+ * `convex-test` environment.
+ *
+ * Mounts the auth component under `name`, then nests
+ * `@convex-dev/workpool` at `<name>/webhookWorkpool`, matching the
+ * structure declared by `component/convex.config.ts`.
+ *
+ * @param t - The `convex-test` test harness.
+ * @param name - Component mount name. Defaults to `"auth"`.
+ *
+ * @example
+ * ```ts
+ * import { convexTest } from "convex-test";
+ * import { register } from "@estifanos-sh/convex-auth/test";
+ *
+ * const t = convexTest(schema);
+ * register(t);
+ * ```
+ */
+declare function register(t: TestConvex<SchemaDefinition<GenericSchema, boolean>>, name?: string): void;
+declare const testHelpers: {
+  register: typeof register;
+  schema: SchemaDefinition<GenericSchema, boolean>;
+  modules: Record<string, () => Promise<unknown>>;
+};
+/**
+ * Test helpers bundled for `convex-test` setups.
+ *
+ * Exposes the auth component `schema`, lazily discovered `modules`, and the
+ * `register()` helper as a convenience default export.
+ *
+ * @example
+ * ```ts
+ * import authTest from "@estifanos-sh/convex-auth/test";
+ * import { convexTest } from "convex-test";
+ *
+ * const t = convexTest(schema);
+ * authTest.register(t);
+ * ```
+ */
+//#endregion
+export { testHelpers as default, register };
+//# sourceMappingURL=test.d.ts.map

package/dist/test.js

@@ -0,0 +1,54 @@
+import modules_default from "./component/modules.js";
+import schema_default from "./component/schema.js";
+import workpoolTest from "@convex-dev/workpool/test";
+
+//#region src/test.ts
+/**
+* Register the Convex Auth component (and its subcomponents) in a
+* `convex-test` environment.
+*
+* Mounts the auth component under `name`, then nests
+* `@convex-dev/workpool` at `<name>/webhookWorkpool`, matching the
+* structure declared by `component/convex.config.ts`.
+*
+* @param t - The `convex-test` test harness.
+* @param name - Component mount name. Defaults to `"auth"`.
+*
+* @example
+* ```ts
+* import { convexTest } from "convex-test";
+* import { register } from "@estifanos-sh/convex-auth/test";
+*
+* const t = convexTest(schema);
+* register(t);
+* ```
+*/
+function register(t, name = "auth") {
+	t.registerComponent(name, schema_default, modules_default);
+	workpoolTest.register(t, `${name}/webhookWorkpool`);
+}
+const testHelpers = {
+	register,
+	schema: schema_default,
+	modules: modules_default
+};
+/**
+* Test helpers bundled for `convex-test` setups.
+*
+* Exposes the auth component `schema`, lazily discovered `modules`, and the
+* `register()` helper as a convenience default export.
+*
+* @example
+* ```ts
+* import authTest from "@estifanos-sh/convex-auth/test";
+* import { convexTest } from "convex-test";
+*
+* const t = convexTest(schema);
+* authTest.register(t);
+* ```
+*/
+var test_default = testHelpers;
+
+//#endregion
+export { test_default as default, register };
+//# sourceMappingURL=test.js.map

package/package.json

@@ -0,0 +1,247 @@
+{
+  "name": "@estifanos-sh/convex-auth",
+  "version": "0.0.1-preview.0",
+  "description": "Authentication for Convex",
+  "keywords": [
+    "auth",
+    "authentication",
+    "authorization",
+    "convex"
+  ],
+  "homepage": "https://estifanos.sh/convex-auth/",
+  "bugs": "https://github.com/estifanos-sh/convex-auth/issues",
+  "license": "Apache-2.0",
+  "author": "estifanos-sh",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/estifanos-sh/convex-auth.git"
+  },
+  "bin": {
+    "convex-auth": "dist/bin.js"
+  },
+  "files": [
+    "README.md",
+    "dist",
+    "!dist/**/*.map",
+    "!dist/index.js",
+    "!dist/model.js",
+    "!dist/model.d.ts",
+    "!dist/model.d.ts.map",
+    "!dist/schema.js",
+    "!dist/schema.d.ts",
+    "!dist/schema.d.ts.map"
+  ],
+  "type": "module",
+  "sideEffects": [
+    "./src/server/identity/convex.ts",
+    "./dist/server/identity/convex.js"
+  ],
+  "exports": {
+    "./_generated/component.js": {
+      "types": "./dist/component/_generated/component.d.ts"
+    },
+    "./test": {
+      "types": "./dist/test.d.ts",
+      "import": "./dist/test.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser/index.d.ts",
+      "import": "./dist/browser/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    },
+    "./svelte": {
+      "types": "./dist/svelte/index.d.ts",
+      "svelte": "./dist/svelte/index.js",
+      "import": "./dist/svelte/index.js"
+    },
+    "./expo": {
+      "types": "./dist/expo/index.d.ts",
+      "import": "./dist/expo/index.js"
+    },
+    "./otel": {
+      "types": "./dist/otel.d.ts",
+      "import": "./dist/otel.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js"
+    },
+    "./component": {
+      "types": "./dist/component/index.d.ts",
+      "import": "./dist/component/index.js"
+    },
+    "./permissions": {
+      "types": "./dist/permissions/index.d.ts",
+      "import": "./dist/permissions/index.js"
+    },
+    "./convex.config": {
+      "types": "./dist/component/convex.config.d.ts",
+      "import": "./dist/component/convex.config.js",
+      "default": "./dist/component/convex.config.js"
+    },
+    "./convex.config.js": {
+      "types": "./dist/component/convex.config.d.ts",
+      "import": "./dist/component/convex.config.js",
+      "default": "./dist/component/convex.config.js"
+    },
+    "./providers": {
+      "types": "./dist/providers/index.d.ts",
+      "import": "./dist/providers/index.js"
+    },
+    "./providers/*": {
+      "types": "./dist/providers/*.d.ts",
+      "import": "./dist/providers/*.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build:lib": "vp exec tsdown",
+    "build:svelte": "vp exec svelte-package --input src/svelte --output dist/svelte",
+    "build": "rm -rf dist && vp run build:lib && vp run build:svelte",
+    "typecheck": "vp exec tsc --project tsconfig.server.json --noEmit && vp exec tsc --project tsconfig.client.json --noEmit && vp exec tsc --project tsconfig.component.json --noEmit",
+    "typecheck:consumer": "vp exec tsc --project tsconfig.consumer.json --noEmit",
+    "typecheck:consumer:dist": "vp exec tsc --project tsconfig.consumer.dist.json --noEmit",
+    "check:attw": "vp exec attw --pack . --profile esm-only --exclude-entrypoints ./test ./_generated/component.js ./svelte",
+    "check:publint": "vp exec publint --strict",
+    "check:packaging": "vp run check:attw && vp run check:publint",
+    "check:component-paginate": "node ../../scripts/check-component-paginate.mjs",
+    "docs": "vp run --cwd ../../docs dev",
+    "lint": "vp run typecheck",
+    "spellcheck": "cspell \"../../docs/src/content/**/*.md*\" \"../../skills/**/*.md\"",
+    "prepublishOnly": "vp run build && vp run typecheck:consumer && vp run typecheck:consumer:dist && vp run check:packaging",
+    "test": "vp test --config ../../vite.config.ts --project convex --project node --project interop",
+    "test:once": "vp test --config ../../vite.config.ts --run --project convex --project node --project interop",
+    "convex:dev": "vp exec convex dev",
+    "convex:codegen": "vp exec convex codegen",
+    "convex:codegen:component": "vp exec convex codegen --component-dir ./src/component",
+    "convex:dashboard": "vp exec convex dashboard",
+    "convex:run": "vp exec convex run"
+  },
+  "dependencies": {
+    "@convex-dev/action-cache": "^0.3.0",
+    "@convex-dev/migrations": "^0.3.5",
+    "@convex-dev/workpool": "^0.4.9",
+    "@noble/hashes": "^2.0.1",
+    "@oslojs/cbor": "^1.0.0",
+    "@oslojs/crypto": "^1.0.1",
+    "@oslojs/encoding": "^1.1.0",
+    "@oslojs/otp": "^1.1.0",
+    "@oslojs/webauthn": "^1.0.0",
+    "@simplewebauthn/server": "^13.3.2",
+    "@xmldom/xmldom": "^0.8.11",
+    "arctic": "^3.7.0",
+    "camelcase": "^6.3.0",
+    "convex-helpers": "^0.1.118",
+    "cookie": "^1.1.1",
+    "fflate": "^0.8.2",
+    "jose": "^6.1.3",
+    "jwt-decode": "^4.0.0",
+    "uuid": "^8.3.2",
+    "xml-escape": "^1.1.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@clack/prompts": "^1.2.0",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/resources": "^2.6.1",
+    "@opentelemetry/sdk-logs": "^0.214.0",
+    "@opentelemetry/sdk-metrics": "^2.6.1",
+    "@opentelemetry/sdk-trace-base": "^2.6.1",
+    "@opentelemetry/sdk-trace-node": "^2.6.1",
+    "@opentelemetry/sdk-trace-web": "^2.6.1",
+    "@opentelemetry/semantic-conventions": "^1.40.0",
+    "@sveltejs/package": "^2.5.8",
+    "@sveltejs/vite-plugin-svelte": "^7.0.0",
+    "@types/figlet": "^1.7.0",
+    "@types/node": "25.2.2",
+    "@types/react": "^19.0.0",
+    "@types/xml-escape": "^1.1.3",
+    "convex": "catalog:",
+    "convex-test": "catalog:",
+    "cspell": "^9.6.4",
+    "dotenv": "^17.2.4",
+    "esbuild": "^0.27.3",
+    "expo": "^55.0.15",
+    "expo-auth-session": "^55.0.14",
+    "expo-secure-store": "^55.0.13",
+    "expo-web-browser": "^55.0.14",
+    "figlet": "^1.11.0",
+    "gradient-string": "^3.0.0",
+    "publint": "^0.3.17",
+    "react-native": "^0.85.2",
+    "react-native-passkey": "^3.3.3",
+    "svelte": "^5.55.9",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vite-plus": "catalog:"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/resources": "^2.6.1",
+    "@opentelemetry/sdk-trace-node": "^2.6.1",
+    "@opentelemetry/sdk-trace-web": "^2.6.1",
+    "@opentelemetry/semantic-conventions": "^1.40.0",
+    "convex": "^1.42.0",
+    "expo-auth-session": "*",
+    "expo-secure-store": "*",
+    "expo-web-browser": "*",
+    "react-native": "*",
+    "react-native-passkey": "*",
+    "svelte": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    },
+    "@opentelemetry/resources": {
+      "optional": true
+    },
+    "@opentelemetry/sdk-trace-node": {
+      "optional": true
+    },
+    "@opentelemetry/sdk-trace-web": {
+      "optional": true
+    },
+    "@opentelemetry/semantic-conventions": {
+      "optional": true
+    },
+    "svelte": {
+      "optional": true
+    },
+    "expo-auth-session": {
+      "optional": true
+    },
+    "expo-secure-store": {
+      "optional": true
+    },
+    "expo-web-browser": {
+      "optional": true
+    },
+    "react-native": {
+      "optional": true
+    },
+    "react-native-passkey": {
+      "optional": true
+    }
+  },
+  "@comment devDependencies": [
+    "The CLI deps (@clack/prompts, figlet, and gradient-string) are",
+    "devDependencies because they are bundled into dist/bin.js.",
+    "The @opentelemetry/* SDK packages are optional peerDependencies gated on",
+    "the /otel entry; @opentelemetry/sdk-logs, /sdk-metrics, and /sdk-trace-base",
+    "are devDependencies because otel.ts imports them as types only."
+  ]
+}