@adonis-agora/payments-dashboard 0.5.2 → 1.0.0-rc.1

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @adonis-agora/payments-dashboard
 
+## 1.0.0-rc.1
+
+### Major Changes
+
+- [#222](https://github.com/DavideCarvalho/adonis-agora-payments/pull/222) [`b57fa20`](https://github.com/DavideCarvalho/adonis-agora-payments/commit/b57fa209cf7da05b6c26eebb8ced5341d85eaa67) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - Dashboard `authorize` adopts the shared Agora console contract, and the console behaves like every other Agora console.
+  
+  - `authorize` takes an inline function, an authorizer class (built through the container, so `@inject()` works), or a lazy import `() => import('#policies/console_access')`. An authorizer may answer `{ redirectTo }`: a `302` for page navigations, `401 { error: 'unauthenticated', redirectTo }` for API calls. A throw is a `403`.
+  - With `authorize` omitted the console is open outside production and answers every request with `403` in production, and the app logs one warning at boot: ``[@adonis-agora/payments] console has no `authorize` configured: it is open outside production and denies every request in production. Set `authorize` in config/payments_dashboard.ts.``
+  - `PAYMENTS_DASHBOARD_TOKEN` is removed, with the `x-payments-token` header and the `?token=` query param, and `defaultAuthorize` is no longer exported. For token access use the new `authorizeByToken({ token: env.get('CONSOLE_TOKEN') })`, which checks `Authorization: Bearer <token>` in constant time and answers `401` otherwise. An empty token throws when the config loads.
+  - API denials from `authorize` answer `{ error: 'forbidden' }` (`403`) or `{ error: 'unauthenticated' }` (`401`, was `'unauthorized'`).
+  - `dashboardAuth` is removed, with no alias: the built-in login page, `GET|POST <path>/login`, `POST <path>/session`, `GET <path>/logout`, the signed session cookie and its `login`/`session` hooks, and the exports `resolveDashboardAuth`, `performLogin`, `performSession`, `readSession`, `sanitizeReturnTo`, `SESSION_COOKIE_NAME`, `signSessionCookie`, `verifySessionCookie`, `renderLoginPage` and the types `DashboardAuthOptions`, `ResolvedDashboardAuth`, `AuthMode`, `LoginHook`, `LoginOutcome`, `SessionHook`, `SessionOutcome`, `DashboardSession`, `DashboardSessionUser`, `SignOptions`, `VerifyOptions`, `InjectedAuth`. Sign-in is your app's own: gate the console in `authorize` and return `{ redirectTo: '/login' }` for a signed-out visitor. `ResolvedPaymentsDashboardConfig` has no `dashboardAuth`, and the injected page config no `auth`.
+  - The console UI has no Sign out link. On a `401` from its API it follows the body's `redirectTo`, or reloads the console page so the server answers the navigation.
+  - Refunds and dispute resolutions are recorded against the app's signed-in user (`ctx.auth.user`'s `email`, `name` or `id`), `bearer` for a token caller, else unattributed.
+  - The access-denied page drops the `session-required` reason; `loginHref` is only what you pass in `accessDenied`.
+  
+  Exported from `@adonis-agora/payments/dashboard`: `ConsoleAuthorize`, `ConsoleAuthorizer`, `ConsoleAuthorizerClass`, `ConsoleAuthorizeResult`, `resolveConsoleAuthorize`, `authorizeByToken`. `ResolvedPaymentsDashboardConfig['authorize']` is now `ConsoleAuthorize | null`. The payments client endpoint (`config/payments_client.ts`) and payment-driver tokens are unchanged.
+
+## 1.0.0-rc.0
+
+### Major Changes
+
+- [#220](https://github.com/DavideCarvalho/adonis-agora-payments/pull/220) [`198495f`](https://github.com/DavideCarvalho/adonis-agora-payments/commit/198495f227b18603e0082687d1d7b116eccac4f5) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - 1.0. The 0.x aliases are removed. See "Migrating to 1.0" in the docs.
+  
+  - `@adonis-agora/payments`: `Payment.pixQrCode` is removed. Use `Payment.pixQrCodeImage`.
+  - `@adonis-agora/payments`: `Payment.pixCopiaECola` and `CheckoutSession.pixCopiaECola` are removed. Use `pixCode`. No driver sets the old names any more.
+  - `@adonis-agora/payments`: the `billing.durable` config option is removed. Use `billing.dispatcher` (`true` → `'durable'`, `false` → `'in-process'`). A config that still sets `durable` fails at boot with a message naming the replacement. The `configure` stub now writes `dispatcher: 'auto'`.
+  - `@adonis-agora/payments`: the payments client endpoint's default `authorize`/`owner` read only `ctx.auth.user`; the `ctx.auth.getUser()` probe (old authkit-client) is removed. Pass your own `authorize`/`owner` for any other auth shape.
+  - `@adonis-agora/payments`: `PROVIDER_SCAN_CAP` is no longer exported from `@adonis-agora/payments/dashboard`.
+  - `@adonis-agora/payments-dashboard`: the SPA no longer reads the `window.__PAYMENTS_BASE__` / `__PAYMENTS_API__` / `__PAYMENTS_CURRENCY__` / `__PAYMENTS_AUTH__` globals; config comes only from the provider's JSON data block. Without a block it falls back to `/payments`, the server's default mount (was `/payments-dashboard`).
+  - `@adonis-agora/payments-dashboard`: the `react` / `react-dom` peers are dropped. The console ships prebuilt with React bundled.
+  - The optional `@adonis-agora/durable` peer is widened to `>=0.1.0 <2.0.0 || >=1.0.0-rc.0 <2.0.0`.
+  - All packages require Node `>=24` (tested on 24 and 26).
+
 ## 0.5.2
 
 ### Patch Changes

package/README.md

@@ -39,18 +39,20 @@ import { defineConfig } from '@adonis-agora/payments/dashboard'
 
 export default defineConfig({
   enabled: true,               // false => no routes are registered at all
-  path: '/payments-dashboard', // the SPA mounts here; the JSON API at <path>/api
+  path: '/payments',           // the SPA mounts here; the JSON API at <path>/api
   currency: 'BRL',             // how the edge formats the integer cents it receives
 })
 ```
 
-**Auth defaults to the same posture as `@adonis-agora/durable`'s console**: open outside production;
-in production it requires a bearer token equal to `PAYMENTS_DASHBOARD_TOKEN`, and denies everything
-when that variable is unset. Replace `authorize` with your own guard — it returns `true`/`false` or
+**Without `authorize` the console is open outside production and answers `403` to every request in
+production** (with a warning at boot). Set `authorize` to your own guard: an inline
+function, an authorizer class (built through the container, so `@inject()` works), or a lazy import
+`() => import('#policies/console_access')`. It answers `true`/`false`,
 `{ allowed, reason?: 'unauthenticated' | 'forbidden' }` (`401` for `unauthenticated`, `403` for any
-other denial or a throw) — and/or add the optional
-`dashboardAuth` session gate (a built-in login page and/or an "open the console from your app"
-endpoint) on top of it.
+other denial or a throw) or `{ redirectTo }`. For machine access use
+`authorizeByToken({ token: env.get('CONSOLE_TOKEN') })` (bearer header only). Sign-in is your app's
+own: return `{ redirectTo: '/login' }` for a signed-out visitor. When an API call answers `401`, the
+console follows its `redirectTo`, or reloads so the server answers the navigation.
 
 ## URLs
 
@@ -65,8 +67,7 @@ wider than the viewport.
 
 The provider hands the SPA its config as a `<script type="application/json">` data block, never an
 executable inline script, so `script-src 'self'` (with or without a nonce) is all the console needs.
-The `window.__PAYMENTS_*__` globals `src/client/payments-client.ts` also reads are a test/embedding
-escape hatch, consulted only when the block is absent.
+That block is the only way the SPA learns its mount, API base and currency.
 
 ## Money