@venizia/ardor-admin 0.4.8-2 → 0.4.8-3

package/README.md

@@ -4,7 +4,7 @@ The [react-admin](https://marmelab.com/react-admin/) adapter of
 [ARDOR](https://github.com/VENIZIA-AI/ardor): every place the framework touches `ra-core`.
 
 ```bash
-bun add @venizia/ardor-admin @venizia/ardor-kernel @venizia/ardor-react @venizia/ignis-inversion @venizia/ignis-filter @venizia/ignis-kernel @venizia/ignis-helpers reflect-metadata ra-core ra-i18n-polyglot
+bun add @venizia/ardor-admin @venizia/ardor-kernel @venizia/ardor-react @venizia/ignis-inversion @venizia/ignis-filter @venizia/ignis-kernel @venizia/ignis-helpers reflect-metadata ra-core ra-i18n-polyglot react react-dom react-redux react-router-dom @reduxjs/toolkit @tanstack/react-query
 ```
 
 Most applications install [`@venizia/ardor`](https://www.npmjs.com/package/@venizia/ardor) instead,

package/dist/common/types.d.ts

@@ -5,7 +5,7 @@ import type { TExtraRequest } from '@venizia/ignis-kernel/repository';
 import type { AuthProvider, CoreAdminProps, DataProvider, Locale, ResourceProps } from 'ra-core';
 import type { ReactNode } from 'react';
 import type { RouteProps } from 'react-router-dom';
-import type { DefaultNetworkRequestService, IDataSourceAuth, ISendParams, ISendResponse, RequestCountData, TConstValue, TRequestMethod, TRequestType } from '@venizia/ardor-kernel';
+import type { DefaultNetworkRequestService, IDataSourceAuth, INetworkResponse, ISendParams, RequestCountData, TConstValue, TRequestMethod, TRequestType } from '@venizia/ardor-kernel';
 import type { TFeature } from '../features/feature.js';
 /** What `DefaultRestDataProvider.request` sends: every react-admin method goes through it. */
 export interface IRestRequestOptions<TResource extends string = string> {
@@ -37,12 +37,13 @@ export interface IRestRequestOptions<TResource extends string = string> {
 }
 /** The nine data methods of react-admin, as ra-core declares them. */
 export type IReactAdminDataProvider<TResource extends string = string> = Pick<DataProvider<TResource>, 'getList' | 'getOne' | 'getMany' | 'getManyReference' | 'update' | 'updateMany' | 'create' | 'delete' | 'deleteMany'>;
+/** react-admin's data provider with a free-form `send` and access to the network service and its auth. */
 export interface IDataProvider<TResource extends string = string> extends IReactAdminDataProvider<TResource> {
     /** A request outside react-admin's methods: the same headers and auth, the method and body of `params`. */
     send: <TResult = unknown>(opts: {
         resource: TResource;
         params: ISendParams;
-    }) => Promise<ISendResponse<TResult>>;
+    }) => Promise<INetworkResponse<TResult>>;
     /** The network service every request goes through. */
     getNetworkService(): DefaultNetworkRequestService;
     /** Spread into an `HttpDataSource`: the repository then sends what this provider sends. */
@@ -60,6 +61,7 @@ export interface IAuthRejection {
     logoutUser?: boolean;
     message?: string | false;
 }
+/** The auth provider of an ARDOR application: react-admin's methods, the user's roles and a token refresh. */
 export interface IAuthProvider extends IReactAdminAuthProvider {
     /** The roles of the signed-in user. */
     getRoles: (params?: unknown) => Promise<Set<string>>;
@@ -72,6 +74,7 @@ export interface IAuthProvider extends IReactAdminAuthProvider {
  * is the messages). A loader that fails leaves that locale on the English messages.
  */
 export type TI18nSource = object | (() => Promise<object>);
+/** What `DefaultI18nProvider` is built from: the message sources and the languages on offer. */
 export interface II18nProviderOptions {
     /**
      * Messages by locale: the application's own over the features', English for a locale with no source or whose loader failed.
@@ -89,7 +92,7 @@ export interface IApplication extends Omit<CoreAdminProps, 'children'> {
     /** The container the providers and the features are resolved from. */
     container: Container;
     /**
-     * The logger `useApplicationLogger()` returns. Absent, a console logger named after the application
+     * The logger `useApplicationLogger()` returns. Absent, a console logger named `ArdorApplication`
      * (IGNIS's, so a provider registered with `LoggerFactory.use` is the one behind it).
      */
     logger?: ILogger;

package/dist/hooks/use-document-title.d.ts

@@ -1,4 +1,5 @@
 type TDocumentTitleSegment = string | false | null | undefined;
+/** What `useDocumentTitle` writes into the tab title, and when. */
 export interface IUseDocumentTitleOptions {
     /** The screen title, or a list of segments in order; `false`, `null`, `undefined` and empty segments are dropped. */
     title: TDocumentTitleSegment | Array<TDocumentTitleSegment>;

package/dist/hooks/use-request-header-locale.d.ts

@@ -1,3 +1,4 @@
+/** The header `useRequestHeaderLocale` sends the locale in. */
 export interface IUseRequestHeaderLocaleOptions {
     /**
      * The header the locale is sent in.

package/dist/providers/list-filter.d.ts

@@ -9,8 +9,6 @@ export interface IListFilter {
     limit?: number;
     /** IGNIS's offset; `ListFilterBuilder.build` sets this one. */
     skip?: number;
-    /** An alias of `skip`. */
-    offset?: number;
     include?: unknown;
     fields?: unknown;
     /** Not part of the filter sent: `ListFilterBuilder.build` moves it into the query string. */

package/dist/providers/list-filter.js

@@ -37,7 +37,7 @@ export class ListFilterBuilder {
         }
         else {
             const { page = 1, perPage = 0 } = pagination ?? {};
-            // No `perPage` is no limit. `skip` is IGNIS's offset (`offset` is its alias): one is enough.
+            // No `perPage` is no limit. `skip` is IGNIS's offset.
             if (perPage > 0) {
                 filter['limit'] = perPage;
                 filter['skip'] = (Math.max(page, 1) - 1) * perPage;

package/dist/providers/rest-data.d.ts

@@ -1,6 +1,6 @@
 import { type Container } from '@venizia/ignis-inversion';
 import type { CreateParams, CreateResult, DeleteManyParams, DeleteManyResult, DeleteParams, DeleteResult, GetListParams, GetListResult, GetManyParams, GetManyReferenceParams, GetManyReferenceResult, GetManyResult, GetOneParams, GetOneResult, Identifier, QueryFunctionContext, RaRecord, UpdateManyParams, UpdateManyResult, UpdateParams, UpdateResult } from 'ra-core';
-import { BaseProvider, DefaultNetworkRequestService, type IApplicationInfo, type INetworkResponse, type ICustomParams, type IRestDataProviderOptions, type ISendParams, type ISendResponse, type TRequestType } from '@venizia/ardor-kernel';
+import { BaseProvider, DefaultNetworkRequestService, type IApplicationInfo, type INetworkResponse, type ICustomParams, type IRestDataProviderOptions, type ISendParams, type TRequestType } from '@venizia/ardor-kernel';
 import type { TExtraRequest } from '@venizia/ignis-kernel/repository';
 import type { IDataProvider, IRestRequestOptions } from '../common/index.js';
 import { type IListFilter } from './list-filter.js';
@@ -172,7 +172,7 @@ export declare class DefaultRestDataProvider<TResource extends string = string>
     send<TResult = unknown>(opts: {
         resource: TResource;
         params: ISendParams;
-    }): Promise<ISendResponse<TResult>>;
+    }): Promise<INetworkResponse<TResult>>;
     /**
      * react-admin's data provider contract takes positional arguments, `(resource, params)`: the one
      * place this class does not take an `opts` object. Each method hands them to the `opts` method.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ardor-admin",
-  "version": "0.4.8-2",
+  "version": "0.4.8-3",
   "description": "ARDOR react-admin adapter - the REST data provider, auth provider and i18n provider wired through IGNIS inversion, the ArdorApplication root component, the translate and notify hooks, and the English and Vietnamese message bundles.",
   "keywords": [
     "admin",
@@ -61,8 +61,8 @@
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ardor-kernel": "0.4.8-2",
-    "@venizia/ardor-react": "0.4.8-2"
+    "@venizia/ardor-kernel": "0.4.8-3",
+    "@venizia/ardor-react": "0.4.8-3"
   },
   "devDependencies": {
     "@happy-dom/global-registrator": "^21.0.4",
@@ -72,11 +72,11 @@
     "@testing-library/react": "^16.3.3",
     "@types/bun": "^1.4.3",
     "@types/react": "^19",
-    "@venizia/dev-configs": "^0.4.8-1",
-    "@venizia/ignis-filter": "^0.4.7-1",
-    "@venizia/ignis-helpers": "^0.4.8-1",
-    "@venizia/ignis-inversion": "^0.4.7-1",
-    "@venizia/ignis-kernel": "^0.4.8-1",
+    "@venizia/dev-configs": "^0.4.8-2",
+    "@venizia/ignis-filter": "^0.4.7-2",
+    "@venizia/ignis-helpers": "^0.4.8-2",
+    "@venizia/ignis-inversion": "^0.4.7-2",
+    "@venizia/ignis-kernel": "^0.4.8-2",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
     "oxlint-tsgolint": "7.0.2004",
@@ -94,10 +94,10 @@
   "peerDependencies": {
     "@reduxjs/toolkit": ">=2.13.0",
     "@tanstack/react-query": ">=5.104.5",
-    "@venizia/ignis-filter": "^0.4.7-1",
-    "@venizia/ignis-helpers": "^0.4.8-1",
-    "@venizia/ignis-inversion": "^0.4.7-1",
-    "@venizia/ignis-kernel": "^0.4.8-1",
+    "@venizia/ignis-filter": "^0.4.7-2",
+    "@venizia/ignis-helpers": "^0.4.8-2",
+    "@venizia/ignis-inversion": "^0.4.7-2",
+    "@venizia/ignis-kernel": "^0.4.8-2",
     "ra-core": ">=5.15.5",
     "ra-i18n-polyglot": ">=5.15.5",
     "react": ">=19.3.1",