@vexcms/better-auth 0.1.0-alpha.2 → 0.1.0-alpha.21

package/dist/pluginSchemas.d.ts

@@ -0,0 +1,159 @@
+import type { DBFieldAttribute } from "better-auth";
+import type * as BetterAuthPlugins from "better-auth/plugins";
+/**
+ * A Better Auth plugin's DB schema contribution — one entry per table it adds
+ * or extends.
+ *
+ * Declared structurally rather than imported from `@better-auth/core/db`:
+ * that package is a transitive dependency of `better-auth`, not one this
+ * package declares, so naming it in a public type would be an undeclared
+ * dependency on consumers' resolution.
+ */
+export type PluginDBSchema = Record<string, {
+    fields: Record<string, DBFieldAttribute>;
+    modelName?: string | undefined;
+    disableMigration?: boolean | undefined;
+}>;
+/**
+ * Every export of `better-auth/plugins` that is a plugin factory — derived
+ * from the module's own types, so the union tracks upstream automatically:
+ * a Better Auth release that adds a plugin adds a member here with no code
+ * change, and {@link UnclassifiedPlugin} turns that into a compile error in
+ * this package until the plugin is classified.
+ */
+export type BetterAuthPluginName = {
+    [K in keyof typeof BetterAuthPlugins]: (typeof BetterAuthPlugins)[K] extends (...args: never[]) => {
+        id: string;
+    } ? K : never;
+}[keyof typeof BetterAuthPlugins];
+/**
+ * Per-table overrides a plugin's own `schema` option accepts — renaming its
+ * table or adding fields to it. Mirrors Better Auth's `schema` option shape so
+ * the value can be authored once and passed to both the real plugin factory
+ * and {@link betterAuthCollections}.
+ */
+export type PluginSchemaOverride = Record<string, {
+    modelName?: string | undefined;
+    /** Column renames, keyed by the plugin's own field name. */
+    fields?: Record<string, string> | undefined;
+    additionalFields?: Record<string, DBFieldAttribute> | undefined;
+}>;
+/**
+ * Plugins whose DB schema this package models. `true` enables a plugin with
+ * its default schema; an object supplies the SCHEMA-AFFECTING options only.
+ *
+ * Runtime options (`adminRoles`, `sendInvitationEmail`, OAuth secrets, …) are
+ * deliberately absent: this descriptor is authored in a client-safe module and
+ * accepting a plugin's full option type is how a server callback — and
+ * whatever it closes over — would end up in the browser bundle. Options that
+ * do not change the schema cannot change what the admin panel renders, so
+ * nothing is lost by keeping them on the server's real plugin instances.
+ */
+export interface ModelledPluginDescriptors {
+    /** Roles, bans, and impersonation fields on `user`/`session`. */
+    admin?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** `isAnonymous` on `user`. */
+    anonymous?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The `apikey` table. */
+    apiKey?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** `userId` on `user`, plus the `jwks` table the Convex plugin's JWT half adds. */
+    convex?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The `deviceCode` table. */
+    deviceAuthorization?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The `jwks` table. */
+    jwt?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The OAuth application/access-token/consent tables. */
+    mcp?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The OAuth application/access-token/consent tables. */
+    oidcProvider?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /**
+     * Organizations, members, and invitations — plus `team`/`teamMember` when
+     * `teams` is enabled, which is the one option that changes which tables exist.
+     */
+    organization?: true | {
+        teams?: boolean;
+        schema?: PluginSchemaOverride;
+    };
+    /** `phoneNumber`/`phoneNumberVerified` on `user`. */
+    phoneNumber?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The `walletAddress` table. */
+    siwe?: true | {
+        schema?: PluginSchemaOverride;
+    };
+    /** The `twoFactor` table and `twoFactorEnabled` on `user`. */
+    twoFactor?: true | {
+        schema?: PluginSchemaOverride;
+    };
+}
+/** A plugin name this package models. */
+export type ModelledPluginName = keyof ModelledPluginDescriptors;
+/**
+ * Plugins that exist upstream but contribute no tables, or whose schema this
+ * package does not model. Passing one is a type error naming the escape hatch:
+ * read its `schema` off your real plugin instance on the server and hand the
+ * value to `betterAuthCollections`'s `extraSchema`.
+ */
+export type UnmodelledPluginDescriptor<TName extends string> = {
+    readonly __unmodelled_plugin_pass_its_schema_via_extraSchema: TName;
+};
+/**
+ * Plugin names neither modelled nor explicitly acknowledged as unmodelled.
+ * Always `never`; {@link assertEveryPluginClassified} makes a non-`never`
+ * value a compile error naming the plugin a Better Auth release just added.
+ */
+export type UnclassifiedPlugin = Exclude<BetterAuthPluginName, ModelledPluginName | UnmodelledPluginName>;
+/**
+ * Upstream plugins knowingly left unmodelled. Enumerated rather than inferred
+ * so adding a plugin upstream breaks this package's typecheck instead of
+ * silently widening the accepted descriptor map.
+ */
+export type UnmodelledPluginName = "backupCode2fa" | "bearer" | "captcha" | "customSession" | "emailOTP" | "genericOAuth" | "haveIBeenPwned" | "lastLoginMethod" | "magicLink" | "multiSession" | "oAuthProxy" | "oauthPopup" | "oneTap" | "oneTimeToken" | "openAPI" | "otp2fa" | "passkey" | "sso" | "testUtils" | "totp2fa" | "twoFactorClient" | "username";
+/**
+ * The `plugins` map `betterAuthCollections` accepts: modelled plugins carry a
+ * descriptor, every other upstream plugin is rejected with a message pointing
+ * at `extraSchema`.
+ */
+export type BetterAuthPluginDescriptors = ModelledPluginDescriptors & {
+    [K in UnmodelledPluginName]?: UnmodelledPluginDescriptor<K>;
+};
+/**
+ * Resolves a descriptor map into the plain plugin stubs `getAuthTables` reads.
+ *
+ * Each enabled plugin contributes its generated schema snapshot with the
+ * caller's `schema` overrides applied the same way the real plugin applies
+ * them: `additionalFields` are spread into the table (plugins do this
+ * themselves when building their schema, so the snapshot — generated with no
+ * overrides — cannot already contain them), then Better Auth's own
+ * the same field renames and `modelName` override Better Auth's `mergeSchema` applies.
+ *
+ * @param props.plugins - Descriptor map; omitted or `undefined` entries contribute nothing.
+ * @param props.extraSchema - Schemas of plugins this package does not model, taken from a real plugin instance's `schema`.
+ * @returns One `{ id, schema }` stub per contributing plugin, in descriptor-key order.
+ * @throws {Error} When a descriptor names a plugin with no modelled schema.
+ */
+export declare function resolvePluginStubs(props: {
+    plugins?: BetterAuthPluginDescriptors | undefined;
+    extraSchema?: PluginDBSchema | PluginDBSchema[] | undefined;
+}): {
+    id: string;
+    schema: PluginDBSchema;
+}[];
+//# sourceMappingURL=pluginSchemas.d.ts.map

package/dist/pluginSchemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginSchemas.d.ts","sourceRoot":"","sources":["../src/pluginSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,OAAO,KAAK,KAAK,iBAAiB,MAAM,qBAAqB,CAAC;AAI9D;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CACjC,MAAM,EACN;IACE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACzC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACxC,CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,MAAM,OAAO,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAC3E,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;QACH,EAAE,EAAE,MAAM,CAAC;KACZ,GACG,CAAC,GACD,KAAK;CACV,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,MAAM,EACN;IACE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAAG,SAAS,CAAC;CACjE,CACF,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yBAAyB;IACxC,iEAAiE;IACjE,KAAK,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IACjD,+BAA+B;IAC/B,SAAS,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IACrD,0BAA0B;IAC1B,MAAM,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAClD,mFAAmF;IACnF,MAAM,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAClD,8BAA8B;IAC9B,mBAAmB,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAC/D,wBAAwB;IACxB,GAAG,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAC/C,yDAAyD;IACzD,GAAG,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAC/C,yDAAyD;IACzD,YAAY,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IACxD;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IACzE,qDAAqD;IACrD,WAAW,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IACvD,iCAAiC;IACjC,IAAI,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;IAChD,8DAA8D;IAC9D,SAAS,CAAC,EAAE,IAAI,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;CACtD;AAED,yCAAyC;AACzC,MAAM,MAAM,kBAAkB,GAAG,MAAM,yBAAyB,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,CAAC,KAAK,SAAS,MAAM,IAAI;IAC7D,QAAQ,CAAC,mDAAmD,EAAE,KAAK,CAAC;CACrE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CACtC,oBAAoB,EACpB,kBAAkB,GAAG,oBAAoB,CAC1C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAC5B,eAAe,GACf,QAAQ,GACR,SAAS,GACT,eAAe,GACf,UAAU,GACV,cAAc,GACd,gBAAgB,GAChB,iBAAiB,GACjB,WAAW,GACX,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,cAAc,GACd,SAAS,GACT,QAAQ,GACR,SAAS,GACT,KAAK,GACL,WAAW,GACX,SAAS,GACT,iBAAiB,GACjB,UAAU,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,yBAAyB,GAAG;KACnE,CAAC,IAAI,oBAAoB,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC;CAC5D,CAAC;AAeF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE;IACxC,OAAO,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAClD,WAAW,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,GAAG,SAAS,CAAC;CAC7D,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,EAAE,CAoD3C"}

package/dist/pluginSchemas.generated.d.ts

@@ -0,0 +1,4 @@
+import type { PluginDBSchema } from "./pluginSchemas";
+/** Declared DB schema per plugin descriptor key. */
+export declare const PLUGIN_SCHEMAS: Record<string, PluginDBSchema>;
+//# sourceMappingURL=pluginSchemas.generated.d.ts.map

package/dist/pluginSchemas.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginSchemas.generated.d.ts","sourceRoot":"","sources":["../src/pluginSchemas.generated.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,oDAAoD;AACpD,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAw6BzD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vexcms/better-auth",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.21",
   "description": "better-auth adapter for VexCMS on Convex",
   "keywords": [
     "cms",
@@ -25,6 +25,11 @@
       "source": "./src/index.ts",
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./client": {
+      "source": "./src/client.ts",
+      "import": "./dist/client.js",
+      "types": "./dist/client.d.ts"
     }
   },
   "main": "./dist/index.js",
@@ -35,9 +40,11 @@
   "peerDependencies": {
     "better-auth": ">=1.6.23 <1.7.0",
     "convex": ">=1.44.0 <2",
-    "@vexcms/core": "^0.1.0-alpha.2"
+    "@vexcms/core": "^0.1.0-alpha.21"
   },
   "devDependencies": {
+    "@better-auth/api-key": "1.6.23",
+    "@convex-dev/better-auth": "0.11.5",
     "@types/node": "20.19.43",
     "@vitest/coverage-v8": "4.1.10",
     "better-auth": "1.6.23",
@@ -47,7 +54,7 @@
     "tsup": "8.5.1",
     "typescript": "6.0.3",
     "vitest": "4.1.10",
-    "@vexcms/core": "0.1.0-alpha.2",
+    "@vexcms/core": "0.1.0-alpha.21",
     "@vexcms/tsconfig": "0.0.0"
   },
   "publishConfig": {
@@ -56,11 +63,12 @@
   },
   "scripts": {
     "build": "tsup && tsc -p tsconfig.build.json --emitDeclarationOnly",
-    "dev": "tsup --watch",
+    "dev": "tsup --watch src",
     "clean": "rm -rf dist",
     "coverage": "vitest run --coverage",
     "typecheck": "tsc --noEmit -p tsconfig.check.json",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "gen:auth-schemas": "UPDATE_AUTH_SCHEMAS=1 vitest run src/pluginSchemas.test.ts"
   }
 }