@teamblind/axeda-better-auth 0.0.0-stage → 0.1.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @teamblind/axeda-better-auth
+
+## 0.1.0-alpha.0
+
+### Minor Changes
+
+- b519956: Add the authorization use cases. `@teamblind/axeda-core` gains role management, assignments with the no-escalation rule (also on revoke and on role edits), an append-only audit log, `bootstrap` for the first administrator, roles declared in code that sync at start, `scopesFor` and `scopeFilter`, and a version-validated permission cache. `requireMfa` is now enforced when deciding. `@teamblind/axeda-better-auth` stores the audit log and exposes `createBetterAuthUserDirectory`; `@teamblind/axeda-testing` adds an in-memory user directory and covers the new ports in the contract suite.
+
+  The Better Auth plugin now exposes the use cases as `/axeda/*` endpoints (every one requires a session and declares its permission), connects the session to the actor, cleans up on user deletion, refuses to start with `session.cookieCache`, and ships a typed client at `@teamblind/axeda-better-auth/client`. `npm run demo` runs the whole story against a real server.
+
+- c55b0f4: Persist Axeda on top of the Better Auth database adapter. `@teamblind/axeda-better-auth` adds the plugin schema (roles, assignments, policy state and the user's `authzVersion`) and `createBetterAuthPersistence`, which implements the persistence ports for any database Better Auth supports, with atomic counters, optimistic role updates and real transactions. The persistence contract suite now also covers concurrent duplicate creation, and `@teamblind/axeda-core` adds the `AXEDA_USER_NOT_FOUND` and `AXEDA_DATA_CORRUPT` error codes.
+- c6a80da: Add companies, businesses, invitations and public identity. Companies and businesses are real entities with versions, soft deletion with a grace period (and immediate deletion for privacy requests) and a status that silences their people at once; business scopes are now resolved from the database, never from the request. Invitations are single-use, only the owner of the verified email can accept them, and the inviter's current power is re-checked on acceptance. The plugin exposes `/axeda/company/*`, `/axeda/business/*`, `/axeda/invitation/*` and an opt-in `/axeda/public/identity`; the HTTP status of every error code is now decided exhaustively.
+- 7ebf1fd: Add Express middleware, a secure Better Auth preset and the first documentation. `@teamblind/axeda-express` provides `requireAuth()`, `requirePermission()` and `resolveScope()`: it denies by default, resolves the company of a business from the database, answers the same whether a scope exists or not, requires a trusted origin for cookie-bearing writes and never fails open. `@teamblind/axeda-better-auth` adds `secureAuthOptions()` (refuses weak secrets, wildcard or plain-http origins), `sessionPrincipal()` and `principalFromUser()`, and the plugin now refuses to start with Better Auth's CSRF check, origin check or IP tracking disabled. `@teamblind/axeda-core` adds `resolveTarget()` so applications never trust a company id sent by the client. Documentation in English and Spanish, and an example API in `apps/example`.
+- b402e20: Add user administration and menus. Platform administrators can list users, create accounts without any credential, ban and unban (with an optional end date) and sign people out everywhere; a user with more administrative power than the actor cannot be touched, a ban applies to every path including API keys, and a banned account cannot open sessions. Menus are declared in code, validated at startup (every entry needs its permission, no cycles, safe paths) and `GET /axeda/menu` returns only what the person may use in the requested scope, in their language.
+
+### Patch Changes
+
+- fed4ed1: Make the packages publishable: compiled ES modules with type declarations under `dist/`, an `exports` map, `files` limited to what is needed, a README, the licence and the notice in each tarball, and the dependencies each package really uses (`@teamblind/axeda-core` for the others, `zod`, and `vitest` and `@types/express` as peers where needed). The CI now builds the packages, checks what would be published and installs the packed files in an empty project to run and type-check them, and it runs the suite against Better Auth 1.7.10 and 1.7.14.
+- d9c4b80: `@teamblind/axeda-express` gains an optional `onDenied` hook that reports every refused request, with the exact reason the client is not told, so an application can log it; it never changes the response and a failing hook is ignored. All packages now declare a `default` export condition next to `types`, so they can be loaded from CommonJS with `require()` on Node 22.12 or later (and with `import()` everywhere); before, `require()` failed with `ERR_PACKAGE_PATH_NOT_EXPORTED`.
+- 680ab7d: Fix three findings of the security review. A banned principal (for example one arriving through an API key) could still read roles, companies, businesses and other people's assignments; every use case now builds the actor's permission data in one place, which includes the ban. Listing the assignments of a scope answered differently for a company or business that exists and one that does not, which let any signed-in person probe for identifiers; both now answer the same unless the caller holds the permission globally. Every `/axeda/*` response, errors included, now carries `Cache-Control: no-store`.
+- e7e5e56: Fix four problems found while reviewing the first alpha. With sessions kept in `secondaryStorage` (for example Redis), Better Auth keeps a stale copy of the user next to each session, so a revoked assignment, a ban or a 2FA change never reached it; the plugin endpoints and `sessionPrincipal` now re-read the user from the database when `secondaryStorage` is set, and a user who no longer exists is nobody (`principalFromSession` is now async). Dropping a role's `requireMfa` now requires covering all of its permissions, as reactivating it already did. `start()` retries after a transient failure such as an unreachable database instead of staying broken until the process restarts; configuration failures are still remembered. The startup transaction probe no longer reports a false "no transactions" when another instance syncs its roles at the same moment.
+- Updated dependencies [b519956]
+- Updated dependencies [c55b0f4]
+- Updated dependencies [c6a80da]
+- Updated dependencies [a836007]
+- Updated dependencies [7ebf1fd]
+- Updated dependencies [fed4ed1]
+- Updated dependencies [d9c4b80]
+- Updated dependencies [680ab7d]
+- Updated dependencies [b402e20]
+  - @teamblind/axeda-core@0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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] TeamBlind
+
+   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/NOTICE

@@ -0,0 +1,5 @@
+Axeda
+Copyright 2026 TeamBlind
+
+This product is licensed under the Apache License, Version 2.0.
+See the LICENSE file for the full license text.

package/README.md

@@ -1,3 +1,14 @@
-# Temporary Holding Version
+# @teamblind/axeda-better-auth
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Better Auth plugin for Axeda: schema, `/axeda/*` endpoints, the typed client, `secureAuthOptions()` and the stores that persist everything through Better Auth's database adapter (SQLite and PostgreSQL verified).
+
+> **Status:** alpha (`0.1.0-alpha.0`); the API can still change before 1.0. Install with `npm install @teamblind/axeda-better-auth@alpha`. Documentation: [English](https://github.com/teamblindmx/axeda/tree/main/docs/en) · [Español](https://github.com/teamblindmx/axeda/tree/main/docs/es).
+
+```ts
+import { axeda, secureAuthOptions, sessionPrincipal } from '@teamblind/axeda-better-auth';
+import { axedaClient } from '@teamblind/axeda-better-auth/client';
+```
+
+Peer dependencies: `better-auth` and `@better-auth/core` (`^1.7.10`; tested on 1.7.10 and 1.7.14).
+
+Part of [Axeda](https://github.com/teamblindmx/axeda), hierarchical authorization (global → company → business) on top of [Better Auth](https://www.better-auth.com). Licensed under [Apache-2.0](LICENSE).

package/dist/client.d.ts

@@ -0,0 +1,10 @@
+import type { axeda } from './plugin.js';
+/**
+ * Plugin de cliente: infiere los endpoints del servidor, de modo que
+ * `authClient.axeda.role.create({ … })` está tipado de punta a punta. Solo importa tipos del
+ * servidor: no lleva código de servidor al navegador.
+ */
+export declare const axedaClient: () => {
+    id: "axeda";
+    $InferServerPlugin: ReturnType<typeof axeda>;
+};

package/dist/client.js

@@ -0,0 +1,9 @@
+/**
+ * Plugin de cliente: infiere los endpoints del servidor, de modo que
+ * `authClient.axeda.role.create({ … })` está tipado de punta a punta. Solo importa tipos del
+ * servidor: no lleva código de servidor al navegador.
+ */
+export const axedaClient = () => ({
+    id: 'axeda',
+    $InferServerPlugin: {},
+});

package/dist/dto.d.ts

@@ -0,0 +1,89 @@
+import type { AssignmentScope, AuditEvent, Business, Company, Invitation, ManagedUser, Role, RoleAssignment } from '@teamblind/axeda-core';
+/**
+ * Salida por lista blanca (S17): cada respuesta enumera sus campos. Si el modelo gana un campo
+ * nuevo, no sale por la API hasta que se añada aquí a propósito. Las fechas salen como texto ISO.
+ */
+export interface RoleDto {
+    id: string;
+    key: string;
+    name: string;
+    description: string | null;
+    permissions: string[];
+    requireMfa: boolean;
+    status: 'active' | 'inactive';
+    managed: boolean;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AssignmentDto {
+    id: string;
+    userId: string;
+    roleId: string;
+    scope: AssignmentScope;
+    grantedBy: string | null;
+    createdAt: string;
+    expiresAt: string | null;
+}
+export interface AuditEventDto {
+    id: string;
+    at: string;
+    actorId: string | null;
+    action: string;
+    targetType: string;
+    targetId: string | null;
+    scope: AssignmentScope | null;
+    outcome: 'success' | 'denied';
+    ip: string | null;
+    userAgent: string | null;
+    metadata: Record<string, unknown>;
+}
+export declare const toRoleDto: (role: Role) => RoleDto;
+export declare const toAssignmentDto: (assignment: RoleAssignment) => AssignmentDto;
+export declare const toAuditEventDto: (event: AuditEvent) => AuditEventDto;
+interface TenantDto {
+    id: string;
+    slug: string;
+    name: string;
+    logoUrl: string | null;
+    faviconUrl: string | null;
+    status: 'active' | 'inactive';
+    metadata: Record<string, unknown>;
+    version: number;
+    deletedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CompanyDto extends TenantDto {
+    legalName: string | null;
+}
+export interface BusinessDto extends TenantDto {
+    companyId: string;
+}
+export interface InvitationDto {
+    id: string;
+    email: string;
+    scope: AssignmentScope;
+    roleIds: string[];
+    invitedBy: string;
+    expiresAt: string;
+    createdAt: string;
+    acceptedAt: string | null;
+    revokedAt: string | null;
+}
+export declare const toCompanyDto: (company: Company) => CompanyDto;
+export declare const toBusinessDto: (business: Business) => BusinessDto;
+export declare const toInvitationDto: (invitation: Invitation) => InvitationDto;
+export interface ManagedUserDto {
+    id: string;
+    email: string;
+    name: string;
+    emailVerified: boolean;
+    twoFactorEnabled: boolean;
+    banned: boolean;
+    banReason: string | null;
+    banExpires: string | null;
+    createdAt: string;
+}
+export declare const toManagedUserDto: (user: ManagedUser) => ManagedUserDto;
+export {};

package/dist/dto.js

@@ -0,0 +1,78 @@
+export const toRoleDto = (role) => ({
+    id: role.id,
+    key: role.key,
+    name: role.name,
+    description: role.description,
+    permissions: [...role.permissions],
+    requireMfa: role.requireMfa,
+    status: role.status,
+    managed: role.managed,
+    version: role.version,
+    createdAt: role.createdAt.toISOString(),
+    updatedAt: role.updatedAt.toISOString(),
+});
+export const toAssignmentDto = (assignment) => ({
+    id: assignment.id,
+    userId: assignment.userId,
+    roleId: assignment.roleId,
+    scope: assignment.scope,
+    grantedBy: assignment.grantedBy,
+    createdAt: assignment.createdAt.toISOString(),
+    expiresAt: assignment.expiresAt?.toISOString() ?? null,
+});
+export const toAuditEventDto = (event) => ({
+    id: event.id,
+    at: event.at.toISOString(),
+    actorId: event.actorId,
+    action: event.action,
+    targetType: event.targetType,
+    targetId: event.targetId,
+    scope: event.scope,
+    outcome: event.outcome,
+    ip: event.ip,
+    userAgent: event.userAgent,
+    metadata: { ...event.metadata },
+});
+const tenantFields = (entity) => ({
+    id: entity.id,
+    slug: entity.slug,
+    name: entity.name,
+    logoUrl: entity.logoUrl,
+    faviconUrl: entity.faviconUrl,
+    status: entity.status,
+    metadata: { ...entity.metadata },
+    version: entity.version,
+    deletedAt: entity.deletedAt?.toISOString() ?? null,
+    createdAt: entity.createdAt.toISOString(),
+    updatedAt: entity.updatedAt.toISOString(),
+});
+export const toCompanyDto = (company) => ({
+    ...tenantFields(company),
+    legalName: company.legalName,
+});
+export const toBusinessDto = (business) => ({
+    ...tenantFields(business),
+    companyId: business.companyId,
+});
+export const toInvitationDto = (invitation) => ({
+    id: invitation.id,
+    email: invitation.email,
+    scope: invitation.scope,
+    roleIds: [...invitation.roleIds],
+    invitedBy: invitation.invitedBy,
+    expiresAt: invitation.expiresAt.toISOString(),
+    createdAt: invitation.createdAt.toISOString(),
+    acceptedAt: invitation.acceptedAt?.toISOString() ?? null,
+    revokedAt: invitation.revokedAt?.toISOString() ?? null,
+});
+export const toManagedUserDto = (user) => ({
+    id: user.id,
+    email: user.email,
+    name: user.name,
+    emailVerified: user.emailVerified,
+    twoFactorEnabled: user.twoFactorEnabled,
+    banned: user.banned,
+    banReason: user.banReason,
+    banExpires: user.banExpires?.toISOString() ?? null,
+    createdAt: user.createdAt.toISOString(),
+});