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

package/README.md

@@ -6,6 +6,7 @@ Component-first authentication for [Convex](https://convex.dev). One component,
 
 - **Class-based API** — `new Auth(components.auth, { providers })` gives you everything.
 - **OAuth via Arctic** — 50+ providers through [Arctic](https://arcticjs.dev), zero-dependency OAuth 2.0.
+- **Fluent Convex builders (recommended)** — cleaner auth-aware API handling with middleware and explicit `.public()` / `.internal()` exports.
 - **Password, passkeys, TOTP, magic links, OTP, phone, anonymous** — all built in.
 - **Device Authorization (RFC 8628)** — authenticate CLIs, smart TVs, and IoT devices.
 - **API keys** — scoped permissions, SHA-256 hashed storage, optional rate limiting.
@@ -19,6 +20,9 @@ Component-first authentication for [Convex](https://convex.dev). One component,
 npm install @robelest/convex-auth
 ```
 
+> Renamed package: if you are migrating from earlier previews, replace
+> `@convex-dev/auth` with `@robelest/convex-auth` in imports and CLI commands.
+
 ## Quick Start
 
 ```bash
@@ -66,6 +70,33 @@ auth.http.add(http);
 export default http;
 ```
 
+## Recommended Convex API Handling (`fluent-convex`)
+
+For new projects, we recommend `fluent-convex` for auth middleware composition and cleaner API exports.
+
+```ts
+// convex/functions.ts
+import { createBuilder } from "fluent-convex";
+import { WithZod } from "fluent-convex/zod";
+import type { DataModel } from "./_generated/dataModel";
+import { auth } from "./auth";
+
+const convex = createBuilder<DataModel>();
+
+const withRequiredAuth = convex.createMiddleware<any, { auth: any }>(
+  async (ctx, next) => {
+    const userId = await auth.user.require(ctx);
+    const user = await auth.user.get(ctx, userId);
+    return next({ ...ctx, auth: { ...ctx.auth, userId, user } });
+  },
+);
+
+export const query = convex.query().use(withRequiredAuth).extend(WithZod);
+export const mutation = convex.mutation().use(withRequiredAuth).extend(WithZod);
+```
+
+`AuthCtx` from `@robelest/convex-auth/component` remains supported if your project already uses `convex-helpers`.
+
 ## Providers
 
 | Provider | Import |

package/dist/component/_generated/api.d.ts

@@ -1,9 +1,11 @@
+import { functions_d_exports } from "../functions.js";
 import { index_d_exports } from "../index.js";
 import { public_d_exports } from "../public.js";
 import { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
 
 //#region src/component/_generated/api.d.ts
 declare const fullApi: ApiFromModules<{
+  functions: typeof functions_d_exports;
   index: typeof index_d_exports;
   public: typeof public_d_exports;
 }>;

package/dist/component/_generated/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","names":[],"sources":["../../../src/component/_generated/api.ts"],"mappings":";;;;;cAoBM,OAAA,EAAS,cAAA;EACb,KAAA,SAAc,eAAA;EACd,MAAA,SAAe,gBAAA;AAAA;;;;;;AAWjB;;;cAAa,GAAA,EAAK,SAAA,QACT,OAAA,EACP,iBAAA;;;;;;;;;cAWW,QAAA,EAAU,SAAA,QACd,OAAA,EACP,iBAAA;AAAA,cAGW,UAAA"}
+{"version":3,"file":"api.d.ts","names":[],"sources":["../../../src/component/_generated/api.ts"],"mappings":";;;;;;cAqBM,OAAA,EAAS,cAAA;EACb,SAAA,SAAkB,mBAAA;EAClB,KAAA,SAAc,eAAA;EACd,MAAA,SAAe,gBAAA;AAAA;;;;;;;;AAWjB;cAAa,GAAA,EAAK,SAAA,QACT,OAAA,EACP,iBAAA;;;;;;;;;cAWW,QAAA,EAAU,SAAA,QACd,OAAA,EACP,iBAAA;AAAA,cAGW,UAAA"}

package/dist/component/_generated/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","names":[],"sources":["../../../src/component/_generated/api.ts"],"sourcesContent":["/* eslint-disable */\n/**\n * Generated `api` utility.\n *\n * THIS CODE IS AUTOMATICALLY GENERATED.\n *\n * To regenerate, run `npx convex dev`.\n * @module\n */\n\nimport type * as index from \"../index.js\";\nimport type * as public_ from \"../public.js\";\n\nimport type {\n  ApiFromModules,\n  FilterApi,\n  FunctionReference,\n} from \"convex/server\";\nimport { anyApi, componentsGeneric } from \"convex/server\";\n\nconst fullApi: ApiFromModules<{\n  index: typeof index;\n  public: typeof public_;\n}> = anyApi as any;\n\n/**\n * A utility for referencing Convex functions in your app's public API.\n *\n * Usage:\n * ```js\n * const myFunctionReference = api.myModule.myFunction;\n * ```\n */\nexport const api: FilterApi<\n  typeof fullApi,\n  FunctionReference<any, \"public\">\n> = anyApi as any;\n\n/**\n * A utility for referencing Convex functions in your app's internal API.\n *\n * Usage:\n * ```js\n * const myFunctionReference = internal.myModule.myFunction;\n * ```\n */\nexport const internal: FilterApi<\n  typeof fullApi,\n  FunctionReference<any, \"internal\">\n> = anyApi as any;\n\nexport const components = componentsGeneric() as unknown as {};\n"],"mappings":";;;;;;;;;;;AAiCA,MAAa,MAGT;;;;;;;;;AAUJ,MAAa,WAGT;AAEJ,MAAa,aAAa,mBAAmB"}
+{"version":3,"file":"api.js","names":[],"sources":["../../../src/component/_generated/api.ts"],"sourcesContent":["/* eslint-disable */\n/**\n * Generated `api` utility.\n *\n * THIS CODE IS AUTOMATICALLY GENERATED.\n *\n * To regenerate, run `npx convex dev`.\n * @module\n */\n\nimport type * as functions from \"../functions.js\";\nimport type * as index from \"../index.js\";\nimport type * as public_ from \"../public.js\";\n\nimport type {\n  ApiFromModules,\n  FilterApi,\n  FunctionReference,\n} from \"convex/server\";\nimport { anyApi, componentsGeneric } from \"convex/server\";\n\nconst fullApi: ApiFromModules<{\n  functions: typeof functions;\n  index: typeof index;\n  public: typeof public_;\n}> = anyApi as any;\n\n/**\n * A utility for referencing Convex functions in your app's public API.\n *\n * Usage:\n * ```js\n * const myFunctionReference = api.myModule.myFunction;\n * ```\n */\nexport const api: FilterApi<\n  typeof fullApi,\n  FunctionReference<any, \"public\">\n> = anyApi as any;\n\n/**\n * A utility for referencing Convex functions in your app's internal API.\n *\n * Usage:\n * ```js\n * const myFunctionReference = internal.myModule.myFunction;\n * ```\n */\nexport const internal: FilterApi<\n  typeof fullApi,\n  FunctionReference<any, \"internal\">\n> = anyApi as any;\n\nexport const components = componentsGeneric() as unknown as {};\n"],"mappings":";;;;;;;;;;;AAmCA,MAAa,MAGT;;;;;;;;;AAUJ,MAAa,WAGT;AAEJ,MAAa,aAAa,mBAAmB"}

package/dist/component/convex.config.d.ts

@@ -1,7 +1,7 @@
-import * as convex_server0 from "convex/server";
+import * as convex_server15 from "convex/server";
 
 //#region src/component/convex.config.d.ts
-declare const component: convex_server0.ComponentDefinition<any>;
+declare const component: convex_server15.ComponentDefinition<any>;
 //#endregion
 export { component as default };
 //# sourceMappingURL=convex.config.d.ts.map

package/dist/component/convex.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convex.config.d.ts","names":[],"sources":["../../src/component/convex.config.ts"],"mappings":";;;cAEM,SAAA,EAAmC,cAAA,CAA1B,mBAAA"}
+{"version":3,"file":"convex.config.d.ts","names":[],"sources":["../../src/component/convex.config.ts"],"mappings":";;;cAEM,SAAA,EAAmC,eAAA,CAA1B,mBAAA"}

package/dist/component/functions.d.ts

@@ -0,0 +1,23 @@
+import { ActionCtx, MutationCtx, QueryCtx } from "./_generated/server.js";
+import { GenericValidator, Infer, ObjectType, PropertyValidators } from "convex/values";
+
+//#region src/component/functions.d.ts
+declare namespace functions_d_exports {
+  export { action, internalAction, internalMutation, internalQuery, mutation, query };
+}
+type ArgsValidator = PropertyValidators | GenericValidator;
+type ArgsFor<TArgs extends ArgsValidator | undefined> = TArgs extends PropertyValidators ? ObjectType<TArgs> : TArgs extends GenericValidator ? Infer<TArgs> : any;
+type BaseFunctionConfig<Ctx, TArgs extends ArgsValidator | undefined> = {
+  args?: TArgs;
+  returns?: GenericValidator;
+  handler: (ctx: Ctx, args: ArgsFor<TArgs>) => Promise<any> | any;
+};
+declare function query<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<QueryCtx, TArgs>): any;
+declare function mutation<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<MutationCtx, TArgs>): any;
+declare function internalQuery<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<QueryCtx, TArgs>): any;
+declare function internalMutation<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<MutationCtx, TArgs>): any;
+declare function action<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<ActionCtx, TArgs>): any;
+declare function internalAction<TArgs extends ArgsValidator | undefined>(config: BaseFunctionConfig<ActionCtx, TArgs>): any;
+//#endregion
+export { action, functions_d_exports, internalAction, internalMutation, internalQuery, mutation, query };
+//# sourceMappingURL=functions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"functions.d.ts","names":[],"sources":["../../src/component/functions.ts"],"mappings":";;;;;;;KAYK,aAAA,GAAgB,kBAAA,GAAqB,gBAAA;AAAA,KAErC,OAAA,eAAsB,aAAA,gBACzB,KAAA,SAAc,kBAAA,GACV,UAAA,CAAW,KAAA,IACX,KAAA,SAAc,gBAAA,GACZ,KAAA,CAAM,KAAA;AAAA,KAGT,kBAAA,oBAAsC,aAAA;EACzC,IAAA,GAAO,KAAA;EACP,OAAA,GAAU,gBAAA;EACV,OAAA,GAAU,GAAA,EAAK,GAAA,EAAK,IAAA,EAAM,OAAA,CAAQ,KAAA,MAAW,OAAA;AAAA;AAAA,iBAiB/B,KAAA,eAAoB,aAAA,aAAA,CAClC,MAAA,EAAQ,kBAAA,CAAmB,QAAA,EAAU,KAAA;AAAA,iBAOvB,QAAA,eAAuB,aAAA,aAAA,CACrC,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,KAAA;AAAA,iBAO1B,aAAA,eAA4B,aAAA,aAAA,CAC1C,MAAA,EAAQ,kBAAA,CAAmB,QAAA,EAAU,KAAA;AAAA,iBAOvB,gBAAA,eAA+B,aAAA,aAAA,CAC7C,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,KAAA;AAAA,iBAO1B,MAAA,eAAqB,aAAA,aAAA,CACnC,MAAA,EAAQ,kBAAA,CAAmB,SAAA,EAAW,KAAA;AAAA,iBAOxB,cAAA,eAA6B,aAAA,aAAA,CAC3C,MAAA,EAAQ,kBAAA,CAAmB,SAAA,EAAW,KAAA"}

package/dist/component/functions.js

@@ -0,0 +1,32 @@
+import { createBuilder } from "fluent-convex";
+
+//#region src/component/functions.ts
+const convex = createBuilder();
+function withValidation(builder, config) {
+	let current = builder;
+	if (config.args !== void 0) current = current.input(config.args);
+	if (config.returns !== void 0) current = current.returns(config.returns);
+	return current;
+}
+function query(config) {
+	return withValidation(convex.query(), config).handler(config.handler).public();
+}
+function mutation(config) {
+	return withValidation(convex.mutation(), config).handler(config.handler).public();
+}
+function internalQuery(config) {
+	return withValidation(convex.query(), config).handler(config.handler).internal();
+}
+function internalMutation(config) {
+	return withValidation(convex.mutation(), config).handler(config.handler).internal();
+}
+function action(config) {
+	return withValidation(convex.action(), config).handler(config.handler).public();
+}
+function internalAction(config) {
+	return withValidation(convex.action(), config).handler(config.handler).internal();
+}
+
+//#endregion
+export { action, internalAction, internalMutation, internalQuery, mutation, query };
+//# sourceMappingURL=functions.js.map

package/dist/component/functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.js","names":[],"sources":["../../src/component/functions.ts"],"sourcesContent":["import { createBuilder } from \"fluent-convex\";\nimport type {\n  GenericValidator,\n  Infer,\n  ObjectType,\n  PropertyValidators,\n} from \"convex/values\";\nimport type { DataModel } from \"./_generated/dataModel\";\nimport type { ActionCtx, MutationCtx, QueryCtx } from \"./_generated/server\";\n\nconst convex = createBuilder<DataModel>();\n\ntype ArgsValidator = PropertyValidators | GenericValidator;\n\ntype ArgsFor<TArgs extends ArgsValidator | undefined> =\n  TArgs extends PropertyValidators\n    ? ObjectType<TArgs>\n    : TArgs extends GenericValidator\n      ? Infer<TArgs>\n      : any;\n\ntype BaseFunctionConfig<Ctx, TArgs extends ArgsValidator | undefined> = {\n  args?: TArgs;\n  returns?: GenericValidator;\n  handler: (ctx: Ctx, args: ArgsFor<TArgs>) => Promise<any> | any;\n};\n\nfunction withValidation(\n  builder: any,\n  config: { args?: ArgsValidator; returns?: GenericValidator },\n) {\n  let current = builder;\n  if (config.args !== undefined) {\n    current = current.input(config.args);\n  }\n  if (config.returns !== undefined) {\n    current = current.returns(config.returns);\n  }\n  return current;\n}\n\nexport function query<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<QueryCtx, TArgs>,\n) {\n  return withValidation(convex.query(), config)\n    .handler(config.handler)\n    .public();\n}\n\nexport function mutation<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<MutationCtx, TArgs>,\n) {\n  return withValidation(convex.mutation(), config)\n    .handler(config.handler)\n    .public();\n}\n\nexport function internalQuery<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<QueryCtx, TArgs>,\n) {\n  return withValidation(convex.query(), config)\n    .handler(config.handler)\n    .internal();\n}\n\nexport function internalMutation<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<MutationCtx, TArgs>,\n) {\n  return withValidation(convex.mutation(), config)\n    .handler(config.handler)\n    .internal();\n}\n\nexport function action<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<ActionCtx, TArgs>,\n) {\n  return withValidation(convex.action(), config)\n    .handler(config.handler)\n    .public();\n}\n\nexport function internalAction<TArgs extends ArgsValidator | undefined>(\n  config: BaseFunctionConfig<ActionCtx, TArgs>,\n) {\n  return withValidation(convex.action(), config)\n    .handler(config.handler)\n    .internal();\n}\n"],"mappings":";;;AAUA,MAAM,SAAS,eAA0B;AAiBzC,SAAS,eACP,SACA,QACA;CACA,IAAI,UAAU;AACd,KAAI,OAAO,SAAS,OAClB,WAAU,QAAQ,MAAM,OAAO,KAAK;AAEtC,KAAI,OAAO,YAAY,OACrB,WAAU,QAAQ,QAAQ,OAAO,QAAQ;AAE3C,QAAO;;AAGT,SAAgB,MACd,QACA;AACA,QAAO,eAAe,OAAO,OAAO,EAAE,OAAO,CAC1C,QAAQ,OAAO,QAAQ,CACvB,QAAQ;;AAGb,SAAgB,SACd,QACA;AACA,QAAO,eAAe,OAAO,UAAU,EAAE,OAAO,CAC7C,QAAQ,OAAO,QAAQ,CACvB,QAAQ;;AAGb,SAAgB,cACd,QACA;AACA,QAAO,eAAe,OAAO,OAAO,EAAE,OAAO,CAC1C,QAAQ,OAAO,QAAQ,CACvB,UAAU;;AAGf,SAAgB,iBACd,QACA;AACA,QAAO,eAAe,OAAO,UAAU,EAAE,OAAO,CAC7C,QAAQ,OAAO,QAAQ,CACvB,UAAU;;AAGf,SAAgB,OACd,QACA;AACA,QAAO,eAAe,OAAO,QAAQ,EAAE,OAAO,CAC3C,QAAQ,OAAO,QAAQ,CACvB,QAAQ;;AAGb,SAAgB,eACd,QACA;AACA,QAAO,eAAe,OAAO,QAAQ,EAAE,OAAO,CAC3C,QAAQ,OAAO,QAAQ,CACvB,UAAU"}