@riffdb/better-auth 0.0.0-stage → 0.2.1

package/DESIGN.md

@@ -0,0 +1,273 @@
+# Design boundary
+
+## Package responsibility
+
+`@riffdb/better-auth` owns Better Auth schema interpretation, profile
+generation, adapter method mapping, and Better Auth conformance tests. RiffDB
+owns database semantics, compiled operations, authorization, durability,
+idempotency, and the Rust-backed TypeScript transport.
+
+## Better Auth 1.7.18 method inventory
+
+The adapter project must cover the current `createAdapterFactory` interface:
+
+- `create`
+- `update`
+- `updateMany`
+- `delete`
+- `deleteMany`
+- `consumeOne`
+- `findOne`
+- `findMany`
+- `count`
+- `incrementOne`
+
+The Better Auth API presents these as generic model/where/update requests.
+The RiffDB adapter must instead recognize a finite reviewed call shape and
+dispatch to one generated named command or query. An unmatched combination
+is an unsupported-profile error, never a dynamic RiffQL expression or generic
+storage callback.
+
+The core profile implements exact user `count` and bounded user windows for a
+finite set of UUID and email predicates. Numeric offset, exact total, text
+matching, independent order, and nullable order are declared in the compiled
+query. The result page and total therefore share one provider epoch; the
+adapter neither drains pages nor recounts client-side.
+
+`consumeOne` maps to one atomic delete-and-return compiled command. In a
+recognized Better Auth verification transaction, the adapter records a bounded
+candidate and its internal revision, then commits `ConsumeVerificationSnapshot`.
+The database validates that revision while deleting; a losing delete racer
+returns `null`, and a changed snapshot fails explicitly. Remaining identifier-
+scoped rows use the separate bounded cleanup command.
+
+Better Auth 1.7.18 wraps password reset in a larger transaction. For the
+supported existing-credential graph, `ResetCredentialPassword` consumes the
+recorded verification row and revision-guards the credential password write
+in one compiled command. A stale or missing account leaves the token and
+password unchanged. Basic password changes use the native
+`UpdateCredentialPassword` command with its current credential selector.
+Additional verification rows, credential-account creation,
+and session-revoking reset graphs are unsupported. Signup and OAuth creation
+also remain single-command graphs; unknown callback shapes fail closed.
+
+Mutable core records carry internal monotonically increasing revisions. The
+adapter reads that compiler-owned revision, sends it to an exact update
+command, and retries a bounded stale outcome. This preserves partial-update
+semantics without allowing a client-side read/modify/write race to overwrite
+an unrelated concurrent change. Revisions are not exposed as Better Auth
+model fields.
+
+Password-only account updates use the same revision protocol. The adapter
+queries the bounded `(organization_id, user_id, provider_id)` index, submits
+every observed revision to `UpdateAccountPasswords`, and retries a stale whole
+command. An OAuth refresh therefore cannot restore a password from an older
+account snapshot.
+
+## Upstream patterns adopted
+
+The adapter follows Better Auth's documented `createAdapterFactory` boundary
+and lets that factory own its standard model/field mapping and value
+transformations. It uses the current `@better-auth/test-utils/adapter`
+conformance harness rather than reproducing the upstream tests.
+
+Community adapters are useful compatibility references, especially the
+non-relational Convex, Firestore, InstantDB, and DynamoDB implementations. The
+patterns worth retaining are:
+
+- declare storage capabilities explicitly in the adapter factory;
+- keep transport/storage mechanics behind a small typed seam;
+- derive and validate schema metadata before serving requests;
+- exercise the adapter through Better Auth's own conformance suite; and
+- treat pagination, uniqueness, and atomic consumption as database semantics,
+  not incidental adapter conveniences.
+
+RiffDB intentionally does not copy their generic CRUD dispatch, unbounded
+page-draining, sequential multi-row mutation, or callback-transaction
+patterns. Its seam consists of generated named operations for a compiled
+profile, with explicit bounds and idempotency identity.
+
+## Profile planning boundary
+
+Better Auth's `createSchema` hook is exposed through a generation-only adapter.
+It captures Better Auth's resolved tables after plugins, additional fields,
+and storage-name overrides have been applied. The deterministic plan records
+only bounded declarative metadata and never connects to RiffDB.
+
+A plan is not a runtime database schema. Materializing it requires a reviewed
+RiffDB contract, finite named queries and commands for the call shapes used by
+that Better Auth configuration, generated bindings, and equivalent conformance
+tests. This separation makes the profile customizable without turning schema
+generation into a generic database or weakening the application-facing safety
+boundary. The generation adapter rejects every runtime method.
+
+## Planning materialization
+
+`materializeRiffDBBetterAuthProfile` turns a reviewed plan into the first two
+of those artifacts: one contract and one named query per accepted call shape,
+plus the application source binding them. It emits source for review and
+compilation, never a deployment, and it never connects to RiffDB.
+
+Rows partition on `tenant_id`. The column is deliberately not `organization_id`
+because the organization plugin contributes a model of that name, whose
+synthesized key column would collide. Each model's key column is likewise
+resolved against the rest of its entity: Better Auth's `account` carries the
+provider's own `accountId`, so that entity keys on `account_row_id`.
+
+Aggregate assignment follows the reference graph. A model with no references is
+a root; a model that references a root becomes that root's child, choosing the
+first such reference in sorted field order so the assignment is deterministic;
+anything else is its own root, because a RiffDB aggregate is one level deep and
+a child cannot own children. A child's key is prefixed by its root's key, which
+is what makes the aggregate provable.
+
+Deletion follows from that shape. A root cascades to its children, naming each
+relationship and the reverse index that serves it. SPEC DEL-004 bounds the
+whole discovered graph at `root_count_maximum * (1 + sum(maxima)) <= 256`, so a
+wide aggregate lowers its per-relationship maximum and its bulk-delete root
+count rather than failing to compile: `user` owns five children and admits one
+root per command, `organization` owns two and admits three.
+
+The generator does not pretend to enforce what RiffDB cannot prove. A cascade
+may not cross an aggregate (DEL-003) and must cover every inbound relationship
+exactly once (DEL-002), so a join model that reaches two roots can declare only
+the edge that owns it. Every other edge becomes an indexed `uuid` field and is
+listed in the materialization report as an unenforced reference. For the
+representative organization and two-factor plan those are
+`invitation.organizationId`, `member.userId`, and `teamMember.teamId`; the
+adapter, not the contract, is responsible for their integrity. A reviewer who
+needs one of them enforced changes the aggregate assignment by hand.
+
+`profiles/organization-security/` is the materialized fixture for the
+representative plan, regenerated by `npm run profiles:materialize` and verified
+byte-for-byte by `npm run profiles:check`. It ships its own `riffdb.toml`, so
+the claim made about it is checkable directly: `riffdb application check` in
+that directory compiles the contract and all twenty queries.
+
+References:
+
+- <https://better-auth.com/docs/guides/create-a-db-adapter>
+- <https://better-auth.com/docs/adapters/community-adapters>
+- <https://github.com/get-convex/better-auth>
+- <https://github.com/yultyyev/better-auth-firestore>
+- <https://github.com/datar-platform/better-auth-dynamodb>
+
+## Executable runtime profiles
+
+`materializeRiffDBBetterAuthRuntimeProfile` extends the reviewed core sources
+with a finite operation catalogue and emits `profile.ts`. After source review,
+`riffdb application lock --write` generates its named client and exact immutable
+identity. The adapter accepts that bound module, compares its schema plan with
+the resolved Better Auth schema, and instantiates the generated client. It never
+accepts a JSON schema as executable storage or a caller-supplied CRUD callback.
+
+The runtime generator currently accepts scalar custom user fields and the
+reviewed default organization and two-factor schemas. Baseline fields,
+references, requiredness, and secret classification cannot be overridden.
+Organization teams, dynamic access control, and mutation hooks are rejected.
+Additional plugins and call shapes need a reviewed compiler implementation.
+`nextCookies` is a reviewed integration plugin and adds no storage schema; its
+ID is excluded from storage plans while runtime validation checks its version.
+
+The sample applications live in `profiles/custom-fields/` and `profiles/runtime/`.
+They have separate locks and generated clients. Source freshness, compilation,
+package contents, and official real-service authentication conformance are
+checked for all advertised profiles. The custom-field profile runs the official
+additional-fields test against a contract already carrying that field.
+
+Runtime profiles place all entities under one tenant aggregate. This intentionally
+serializes same-tenant commands and lets member and invitation rows retain both
+user and organization references. Compiled reads hydrate related rows through
+bounded dependent batches in the same snapshot; the adapter only associates
+those returned identities. It enables native joins for these profiles and
+rejects unmatched joins before querying, rather than invoking factory fallback
+join queries.
+
+The current compiler refuses a command binding two entities carrying cascade
+policies, even when they are read parents. Therefore the organization profile
+omits user deletion and rejects `user.deleteUser.enabled`; organization deletion
+cascades both memberships and invitations atomically. This is a limitation of
+this layout and compiler surface, not permission to remove either reference.
+The core and custom-field profiles retain their compiled user cascade.
+
+Organization capacity is authoritative: member and invitation creation mutate
+the organization's internal counters with a guard below 100, and individual
+deletions release capacity atomically. The organization delete graph has at most
+201 rows. Membership creation plus session activation during invitation
+acceptance is another single compiled graph. Invitation status guards admit
+one racer; upstream Better Auth owns its higher-level acceptance and compensation
+flow around that graph.
+
+Native 2FA commands increment failure counters, set locks under a threshold
+guard, reset expired locks, and replace backup codes under an exact old-value
+guard. An internal millisecond field tracks the optional lock timestamp in the
+same commands, so the expiry comparison stays a native scalar predicate. Every
+secret result leaf has an explicit `reveals` declaration. No counter or backup-
+code path invokes Better Auth's generic mutation fallback.
+
+Profile changes require explicit data migration review. The shared tenant
+aggregate and plugin fields cannot reinterpret an installed core profile.
+Internal revisions, capacity counters, required fields, reference targets, and
+secret authority must be initialized and verified before adopting a new lock.
+No automatic migration or mixed-profile runtime is supplied.
+
+The broader planning materializer still supports schema exploration for teams.
+Better Auth 1.7's optional unique `teamMember.membershipKey` needs an explicit
+`requireUniqueValues` review: RiffDB cannot enforce a nullable unique field.
+The planning fixture requires a non-null key on every row and reports that
+stronger storage requirement. It cannot accept legacy null-key rows and is not
+an advertised runtime profile.
+
+## Default core profile exclusions
+
+- renamed models or fields;
+- additional user/session fields;
+- plugin models or plugin-added fields;
+- numeric, serial, mixed, or database-generated identifiers;
+- arbitrary joins, predicates, offsets beyond the compiled bound, or sort
+  combinations outside the named user-window queries;
+- Better Auth database hooks that imply additional database mutations; and
+- secondary storage implemented by RiffDB.
+
+These exclusions describe the default core profile; the executable profiles
+above provide reviewed extensions. Each addition needs an explicit bounded contract and semantic tests.
+
+## Closed RiffDB blockers
+
+The loopback conformance run deploys the exact contract and role and connects
+through `riffdb-driverd`. The initial empty `FindUserByEmail` result carries the
+valid application head `0`; `@riffdb/client@0.2.1` preserves it
+as `0n`. The adapter does not issue an unrelated warmup write, so the first
+application-visible mutation remains the compiled signup graph.
+
+RiffDB now supports bounded cascade deletion across the `Account` and `Session`
+inbound relationships, so user deletion retains stored referential integrity
+and executes as one compiled command.
+
+Named RiffQL queries now support exact compiler-declared secret output leaves.
+The application role derives dedicated secret-field visibility from each
+selected immutable query, which closes the former `RDB-AUTH-0214` failure
+without using read-only commands or broadening the role manually.
+
+Unary compiled deletes can now return the exact transaction-revalidated
+preimage, including explicitly authorized secret leaves. Verification
+consumption therefore has one durable delete/result boundary rather than a
+query followed by a delete.
+
+RiffQL now supports finite exact text predicates, numeric offsets, exact totals,
+independent ordering, and explicit null placement. The generated TypeScript
+client also emits only reachable compact decoders, so it compiles under strict
+consumer `noUnusedLocals` settings without generated-source suppressions.
+
+
+## Secrets and authority
+
+Session tokens, verification values, passwords, OAuth access/refresh tokens,
+and ID tokens require deliberate secret classification in the generated
+RiffDB contract. Every named RiffQL result leaf that returns one carries an
+exact `reveals` annotation. That declaration participates in immutable query
+and role identity, while the generated Better Auth server role receives only
+the corresponding secret-field visibility. These queries are typed SDK reads
+and are omitted from MCP tool generation. End-user identity and session
+semantics remain Better Auth's responsibility; the adapter must not turn them
+into RiffDB capability administration.

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,27 @@
+MIT License
+
+Copyright © 2026 Kevin O'Shea and O'Shea & Sons, LLC.
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.