@venizia/ardor 0.4.8-1 → 0.4.8-2

package/README.md

@@ -13,6 +13,8 @@ control comes from `@venizia/ignis-inversion`, and the data layer speaks the que
 bun add @venizia/ardor @venizia/ignis-inversion @venizia/ignis-filter @venizia/ignis-kernel @venizia/ignis-helpers reflect-metadata
 ```
 
+The React-side peers (`react`, `react-dom`, `react-redux`, `@reduxjs/toolkit`, `@tanstack/react-query`, `ra-core`, `ra-i18n-polyglot`, `react-router-dom`) are installed too; the full `bun add` line is in the [setup guide](https://ardor.venizia.ai/guides/get-started/setup).
+
 ## The `Ardor` namespace
 
 `Ardor` gathers every React hook of the react and admin packages under one name: `Ardor.useRepository(...)`, `Ardor.useTranslate()`. It is the same function as the bare `useRepository`, the Rules of Hooks check the call, and a bundler keeps only the hooks you use, so it adds no bytes to an app.
@@ -20,8 +22,10 @@ bun add @venizia/ardor @venizia/ignis-inversion @venizia/ignis-filter @venizia/i
 ```tsx
 import { Ardor } from '@venizia/ardor';
 
+import { OrdersRepository } from './orders.repository';
+
 export const Orders = () => {
-  const repository = Ardor.useRepository({ key: 'repositories.Orders' });
+  const repository = Ardor.useRepository({ target: OrdersRepository });
 
   return <div>{String(repository)}</div>;
 };
@@ -108,7 +112,8 @@ export class Application extends BaseArdorApplication {
 ```
 
 The full guide, including the root component and the typed hooks, is in the
-[repository README](https://github.com/VENIZIA-AI/ardor#readme).
+[Quickstart](https://ardor.venizia.ai/guides/get-started/5-minute-quickstart) and the
+[references](https://ardor.venizia.ai/references/hooks).
 
 ## Migrating from `@minimaltech/ra-core-infra`
 

package/dist/index.d.ts

@@ -1,3 +1,24 @@
+/**
+ * Every ARDOR hook under one name: `Ardor.useRepository(...)` is the same function as
+ * `useRepository`. Call a member by its name; do not index with a computed key (`Ardor[name]`), which
+ * keeps every hook in a bundle.
+ *
+ * @example
+ * ```tsx
+ * import { Ardor, repository } from '@venizia/ardor';
+ *
+ * @repository()
+ * class OrdersRepository {
+ *   count() { return 3; }
+ * }
+ *
+ * export const Orders = () => {
+ *   const orders = Ardor.useRepository({ target: OrdersRepository });
+ *   const container = Ardor.useApplicationContainer();
+ *   return <span>{orders.count()} {container.isBound({ key: 'repositories.OrdersRepository' }) ? 'bound' : 'missing'}</span>;
+ * };
+ * ```
+ */
 export * as Ardor from './ardor.js';
 export * from '@venizia/ardor-kernel';
 export * from '@venizia/ardor-react';

package/dist/index.js

@@ -1,6 +1,27 @@
 // ARDOR - one entry point over the framework packages.
 // An application imports from `@venizia/ardor`; a consumer that needs only one layer installs that
 // package directly.
+/**
+ * Every ARDOR hook under one name: `Ardor.useRepository(...)` is the same function as
+ * `useRepository`. Call a member by its name; do not index with a computed key (`Ardor[name]`), which
+ * keeps every hook in a bundle.
+ *
+ * @example
+ * ```tsx
+ * import { Ardor, repository } from '@venizia/ardor';
+ *
+ * @repository()
+ * class OrdersRepository {
+ *   count() { return 3; }
+ * }
+ *
+ * export const Orders = () => {
+ *   const orders = Ardor.useRepository({ target: OrdersRepository });
+ *   const container = Ardor.useApplicationContainer();
+ *   return <span>{orders.count()} {container.isBound({ key: 'repositories.OrdersRepository' }) ? 'bound' : 'missing'}</span>;
+ * };
+ * ```
+ */
 export * as Ardor from './ardor.js';
 export * from '@venizia/ardor-kernel';
 export * from '@venizia/ardor-react';

package/dist/presets/app/preset.json

@@ -13,12 +13,12 @@
   "dependencies": {
     "@reduxjs/toolkit": "^2.13.0",
     "@tanstack/react-query": "^5.104.5",
-    "@venizia/ardor": "0.4.8-1",
-    "@venizia/ignis-connectors": "0.4.8-0",
-    "@venizia/ignis-filter": "0.4.7-0",
-    "@venizia/ignis-helpers": "0.4.8-0",
-    "@venizia/ignis-inversion": "0.4.7-0",
-    "@venizia/ignis-kernel": "0.4.8-0",
+    "@venizia/ardor": "0.4.8-2",
+    "@venizia/ignis-connectors": "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",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
     "ra-core": "^5.15.5",
@@ -35,8 +35,8 @@
     "@types/bun": "^1.4.3",
     "@types/react": "^19",
     "@types/react-dom": "^19",
-    "@venizia/dev-configs": "0.4.8-0",
-    "@venizia/ignis-boot": "0.4.8-0",
+    "@venizia/dev-configs": "0.4.8-1",
+    "@venizia/ignis-boot": "0.4.8-1",
     "@vitejs/plugin-react": "^6.1.2",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
@@ -47,11 +47,11 @@
   },
   "peers": {
     "@venizia/dev-configs": "^0.4.0 || ^0.4.8-0",
-    "@venizia/ignis-connectors": "^0.4.8-0",
-    "@venizia/ignis-filter": "^0.4.7-0",
-    "@venizia/ignis-helpers": "^0.4.8-0",
-    "@venizia/ignis-inversion": "^0.4.7-0",
-    "@venizia/ignis-kernel": "^0.4.8-0"
+    "@venizia/ignis-connectors": "^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"
   },
   "scripts": {
     "server:dev": "vite --config .configs/builders/vite.config.mts",

package/dist/presets/lib/preset.json

@@ -5,14 +5,14 @@
   "devDependencies": {
     "@types/bun": "^1.4.3",
     "@types/react": "^19",
-    "@venizia/ardor": "^0.4.8-1",
-    "@venizia/dev-configs": "0.4.8-0",
-    "@venizia/ignis-boot": "0.4.8-0",
-    "@venizia/ignis-connectors": "0.4.8-0",
-    "@venizia/ignis-filter": "0.4.7-0",
-    "@venizia/ignis-helpers": "0.4.8-0",
-    "@venizia/ignis-inversion": "0.4.7-0",
-    "@venizia/ignis-kernel": "0.4.8-0",
+    "@venizia/ardor": "^0.4.8-2",
+    "@venizia/dev-configs": "0.4.8-1",
+    "@venizia/ignis-boot": "0.4.8-1",
+    "@venizia/ignis-connectors": "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",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
     "oxlint-tsgolint": "7.0.2004",
@@ -23,7 +23,7 @@
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "@venizia/ardor": "^0.4.8-1",
+    "@venizia/ardor": "^0.4.8-2",
     "react": "^19.3.1",
     "react-dom": "^19.3.1",
     "react-router-dom": "^7.18.4",

package/dist/testing.d.ts

@@ -16,8 +16,9 @@ export interface IAssertArdorApplicationBootsOptions {
     /** The locale whose messages must load. Default: the i18n provider's initial one. */
     locale?: string;
     /**
-     * Default `false`: an application with no service, repository, datasource, component or
-     * configuration and no feature proves nothing (usually the artifact index was empty).
+     * An application with no service, repository, datasource, component or configuration and no
+     * feature proves nothing (usually the artifact index was empty), so it fails unless this is `true`.
+     * @default false
      */
     allowEmpty?: boolean;
 }

package/dist/vite/common/constants.d.ts

@@ -1,10 +1,16 @@
+/** The build info file's path when `fileName` is not set. */
 export declare const DEFAULT_BUILD_INFO_FILE_NAME = "build-info.json";
+/** The package-name prefix listed under `frameworks` when `frameworkScope` is not set. */
 export declare const DEFAULT_FRAMEWORK_SCOPE = "@venizia/";
 /** What to do when the commit is neither in the pipeline environment nor in git. */
 export declare class UnresolvedPolicies {
+    /** The build fails. */
     static readonly ERROR = "error";
+    /** The build goes on with the commit recorded as `unspecified`. */
     static readonly UNSPECIFIED = "unspecified";
+    /** Every accepted policy value. */
     static readonly SCHEME_SET: Set<string>;
+    /** Whether `value` is one of the policies. */
     static isValid(value: string): boolean;
 }
 //# sourceMappingURL=constants.d.ts.map

package/dist/vite/common/constants.js

@@ -1,10 +1,16 @@
+/** The build info file's path when `fileName` is not set. */
 export const DEFAULT_BUILD_INFO_FILE_NAME = 'build-info.json';
+/** The package-name prefix listed under `frameworks` when `frameworkScope` is not set. */
 export const DEFAULT_FRAMEWORK_SCOPE = '@venizia/';
 /** What to do when the commit is neither in the pipeline environment nor in git. */
 export class UnresolvedPolicies {
+    /** The build fails. */
     static { this.ERROR = 'error'; }
+    /** The build goes on with the commit recorded as `unspecified`. */
     static { this.UNSPECIFIED = 'unspecified'; }
+    /** Every accepted policy value. */
     static { this.SCHEME_SET = new Set([this.ERROR, this.UNSPECIFIED]); }
+    /** Whether `value` is one of the policies. */
     static isValid(value) {
         return this.SCHEME_SET.has(value);
     }

package/dist/vite/common/types.d.ts

@@ -1,15 +1,30 @@
 import type { IBuildInfoFile, TConstValue } from '@venizia/ardor-kernel';
 import type { TBuildInfoRecord } from '@venizia/ignis-helpers/core';
 import type { UnresolvedPolicies } from './constants.js';
+/** `'error'` or `'unspecified'`; see `UnresolvedPolicies`. */
 export type TUnresolvedPolicy = TConstValue<typeof UnresolvedPolicies>;
 export interface IBuildInfoFileOptions {
-    /** The app folder, where its package.json is. Default: the folder Vite runs in. */
+    /**
+     * The app folder, where its package.json is.
+     * @default process.cwd()
+     */
     root?: string;
-    /** The file's path under the output folder and under the dev server's base. Default: `build-info.json`. */
+    /**
+     * The file's path under the output folder and under the dev server's base.
+     * A relative path of letters, digits, `.`, `_` and `-`, with `/` between folders, ending `.json`, and
+     * no `..` segment; anything else throws.
+     * @default 'build-info.json'
+     */
     fileName?: string;
-    /** Dependencies whose name starts with this are listed under `frameworks`. Default: `@venizia/`. */
+    /**
+     * Dependencies whose name starts with this are listed under `frameworks`.
+     * @default '@venizia/'
+     */
     frameworkScope?: string;
-    /** What a build does when no commit can be found: `error` (default) or `unspecified`. The dev server always serves what it has and warns. */
+    /**
+     * What a build does when no commit can be found: `error` or `unspecified`. The dev server always serves what it has and warns.
+     * @default UnresolvedPolicies.ERROR
+     */
     onUnresolved?: TUnresolvedPolicy;
 }
 export type TGitReadResult = {

package/dist/vite/plugin.d.ts

@@ -15,6 +15,16 @@ export declare const createBuildInfoFilePlugin: (opts: {
  * Emits `build-info.json` into the build and serves it on the dev server: the commit, the branch and
  * the build time from the pipeline or git, the app's name and version, and the installed versions of
  * the framework packages it depends on. The shape is `IBuildInfoFile` of `@venizia/ardor`.
+ *
+ * @example
+ * ```ts
+ * import { buildInfoFile } from '@venizia/ardor/vite';
+ * import { defineConfig } from 'vite';
+ *
+ * export default defineConfig({
+ *   plugins: [buildInfoFile({ fileName: 'build-info.json', onUnresolved: 'unspecified' })],
+ * });
+ * ```
  */
 export declare const buildInfoFile: (opts?: IBuildInfoFileOptions) => Plugin;
 export {};

package/dist/vite/plugin.js

@@ -104,6 +104,16 @@ export const createBuildInfoFilePlugin = (opts) => {
  * Emits `build-info.json` into the build and serves it on the dev server: the commit, the branch and
  * the build time from the pipeline or git, the app's name and version, and the installed versions of
  * the framework packages it depends on. The shape is `IBuildInfoFile` of `@venizia/ardor`.
+ *
+ * @example
+ * ```ts
+ * import { buildInfoFile } from '@venizia/ardor/vite';
+ * import { defineConfig } from 'vite';
+ *
+ * export default defineConfig({
+ *   plugins: [buildInfoFile({ fileName: 'build-info.json', onUnresolved: 'unspecified' })],
+ * });
+ * ```
  */
 export const buildInfoFile = (opts = {}) => createBuildInfoFilePlugin({ options: opts, sources: defaultSources });
 //# sourceMappingURL=plugin.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ardor",
-  "version": "0.4.8-1",
+  "version": "0.4.8-2",
   "description": "ARDOR - frontend application framework for the VENIZIA family. One entry point over ardor-kernel, ardor-react and ardor-admin: IGNIS inversion of control, a REST data layer, auth and i18n providers, and the React bindings for a react-admin application.",
   "keywords": [
     "ardor",
@@ -79,21 +79,21 @@
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ardor-admin": "0.4.8-1",
-    "@venizia/ardor-kernel": "0.4.8-1",
-    "@venizia/ardor-react": "0.4.8-1"
+    "@venizia/ardor-admin": "0.4.8-2",
+    "@venizia/ardor-kernel": "0.4.8-2",
+    "@venizia/ardor-react": "0.4.8-2"
   },
   "devDependencies": {
     "@size-limit/preset-small-lib": "^14.2.0",
     "@types/bun": "^1.4.3",
     "@types/node": "^25.0.10",
-    "@venizia/dev-configs": "^0.4.8-0",
-    "@venizia/ignis-boot": "^0.4.8-0",
-    "@venizia/ignis-connectors": "^0.4.8-0",
-    "@venizia/ignis-filter": "^0.4.7-0",
-    "@venizia/ignis-helpers": "^0.4.8-0",
-    "@venizia/ignis-inversion": "^0.4.7-0",
-    "@venizia/ignis-kernel": "^0.4.8-0",
+    "@venizia/dev-configs": "^0.4.8-1",
+    "@venizia/ignis-boot": "^0.4.8-1",
+    "@venizia/ignis-connectors": "^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",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
     "oxlint-tsgolint": "7.0.2004",
@@ -105,12 +105,12 @@
   "peerDependencies": {
     "@reduxjs/toolkit": ">=2.13.0",
     "@tanstack/react-query": ">=5.104.5",
-    "@venizia/ignis-boot": "^0.4.8-0",
-    "@venizia/ignis-connectors": "^0.4.8-0",
-    "@venizia/ignis-filter": "^0.4.7-0",
-    "@venizia/ignis-helpers": "^0.4.8-0",
-    "@venizia/ignis-inversion": "^0.4.7-0",
-    "@venizia/ignis-kernel": "^0.4.8-0",
+    "@venizia/ignis-boot": "^0.4.8-1",
+    "@venizia/ignis-connectors": "^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",
     "ra-core": ">=5.15.5",
     "ra-i18n-polyglot": ">=5.15.5",
     "react": ">=19.3.1",