@venizia/ardor 0.1.5 → 0.3.1

package/README.md

@@ -95,7 +95,7 @@ The full guide, including the root component and the typed hooks, is in the
 ## Migrating from `@minimaltech/ra-core-infra`
 
 ARDOR is that package, split and rebranded. See
-[the migration guide](https://ardor.venizia.ai/guides/migration/from-ra-core-infra) -
+[the migration guide](https://ardor.venizia.ai/guides/migrations/from-ra-core-infra) -
 the move is four mechanical edits plus four symbol renames.
 
 ## License

package/dist/vulcan-preset/files/.configs/eslint.config.mjs

@@ -0,0 +1,5 @@
+import { reactHouseConfigs } from '@venizia/dev-configs/linters';
+
+// oxlint runs the shared rules; ESLint runs what oxlint cannot: the naming convention, the house rules
+// and `no-leaked-render`.
+export default reactHouseConfigs;

package/dist/vulcan-preset/files/.configs/oxfmt.config.mts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'oxfmt';
+import { browserOxfmtConfigs } from '@venizia/dev-configs/formatters';
+
+export default defineConfig(browserOxfmtConfigs);

package/dist/vulcan-preset/files/.configs/oxlint.config.mts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'oxlint';
+import { BrowserOxlintConfigs } from '@venizia/dev-configs/linters';
+
+export default defineConfig(BrowserOxlintConfigs.create());

package/dist/vulcan-preset/files/README.md

@@ -0,0 +1,7 @@
+# {{app}}
+
+The {{app}} admin of {{project}}, built on ARDOR: Vite, React and react-admin.
+
+`bun run dev` serves `http://localhost:{{devPort}}`. `/api` is proxied to the backend app chosen when this app was added (`apiUrl` in `vite.config.mts`).
+
+The `products` resource reads `GET /api/products` (a JSON array and a `Content-Range` header) and writes `POST /api/products` and `PATCH /api/products/:id`. Point it at your own resource by renaming `products` in `src/main.tsx`.

package/dist/vulcan-preset/files/_env.example

@@ -0,0 +1 @@
+PORT={{devPort}}

package/dist/vulcan-preset/files/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>{{app}}</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/dist/vulcan-preset/files/src/application.ts

@@ -0,0 +1,19 @@
+import 'reflect-metadata';
+
+import AutoArtifacts from '@venizia/ignis-boot/auto';
+
+import { BaseArdorApplication, type IApplicationInfo, type IArtifactIndex } from '@venizia/ardor';
+
+// The decorated classes live in their own files and this module imports none of them: the build lists
+// every one under src/ in `AutoArtifacts`.
+export class Application extends BaseArdorApplication {
+  getAppInfo(): IApplicationInfo {
+    return { name: '{{app}}', version: '0.0.0', description: 'The {{app}} admin of {{project}}' };
+  }
+
+  override artifacts(): Array<IArtifactIndex> {
+    return [AutoArtifacts];
+  }
+
+  bindContext(): void {}
+}

package/dist/vulcan-preset/files/src/configurations/admin.configuration.ts

@@ -0,0 +1,44 @@
+import {
+  type BaseArdorApplication as TArdorApplication,
+  configuration,
+  CoreBindings,
+  DefaultI18nProvider,
+  DefaultRestDataProvider,
+  englishMessages,
+  inject,
+  provide,
+} from '@venizia/ardor';
+
+// The two providers an application without sign-in needs. start() binds each @provide method under its
+// key; the auth provider stays unbound, so every page is public.
+@configuration()
+export class AdminConfiguration {
+  constructor(
+    @inject({ key: CoreBindings.APPLICATION_INSTANCE })
+    private readonly application: TArdorApplication,
+  ) {}
+
+  @provide({ key: CoreBindings.REST_DATA_PROVIDER_OPTIONS })
+  restDataProviderOptions() {
+    // No sign-in: no request carries an Authorization header.
+    return { url: '/api', noAuthPathRegex: /./ };
+  }
+
+  @provide({ key: CoreBindings.I18N_PROVIDER_OPTIONS })
+  i18nProviderOptions() {
+    return {
+      i18nSources: { en: englishMessages },
+      languages: [{ locale: 'en', name: 'English' }],
+    };
+  }
+
+  @provide({ key: CoreBindings.DEFAULT_REST_DATA_PROVIDER })
+  restDataProvider() {
+    return this.application.instantiate(DefaultRestDataProvider).value(this.application);
+  }
+
+  @provide({ key: CoreBindings.DEFAULT_I18N_PROVIDER })
+  i18nProvider() {
+    return this.application.instantiate(DefaultI18nProvider).value(this.application);
+  }
+}

package/dist/vulcan-preset/files/src/main.tsx

@@ -0,0 +1,26 @@
+import 'reflect-metadata';
+
+import { configureStore } from '@reduxjs/toolkit';
+import { ArdorApplication } from '@venizia/ardor';
+import { createRoot } from 'react-dom/client';
+
+import { Application } from '@/application';
+import { ProductCreate } from '@/pages/product-create';
+import { ProductEdit } from '@/pages/product-edit';
+import { ProductList } from '@/pages/product-list';
+
+const application = new Application();
+const store = configureStore({
+  reducer: { app: (state: { ready: boolean } = { ready: true }) => state },
+});
+
+await application.start();
+
+createRoot(document.getElementById('root')!).render(
+  <ArdorApplication
+    container={application}
+    reduxStore={store}
+    suspense={<p>Loading</p>}
+    resources={[{ name: 'products', list: ProductList, create: ProductCreate, edit: ProductEdit }]}
+  />,
+);

package/dist/vulcan-preset/files/src/pages/product-create.tsx

@@ -0,0 +1,10 @@
+import { CreateBase } from 'ra-core';
+
+import { ProductForm } from '@/pages/product-form';
+
+export const ProductCreate = () => (
+  <CreateBase resource="products" redirect="list">
+    <h1>Create a product</h1>
+    <ProductForm />
+  </CreateBase>
+);

package/dist/vulcan-preset/files/src/pages/product-edit.tsx

@@ -0,0 +1,10 @@
+import { EditBase } from 'ra-core';
+
+import { ProductForm } from '@/pages/product-form';
+
+export const ProductEdit = () => (
+  <EditBase resource="products" redirect="list">
+    <h1>Edit a product</h1>
+    <ProductForm />
+  </EditBase>
+);

package/dist/vulcan-preset/files/src/pages/product-form.tsx

@@ -0,0 +1,32 @@
+import { Form, useInput } from 'ra-core';
+
+const TextInput = (props: { source: string; label: string }) => {
+  const { field } = useInput({ source: props.source });
+
+  return (
+    <label>
+      {props.label} <input {...field} value={field.value ?? ''} />
+    </label>
+  );
+};
+
+const NumberInput = (props: { source: string; label: string }) => {
+  const { field } = useInput({
+    source: props.source,
+    parse: (value: string) => (value === '' ? null : Number(value)),
+  });
+
+  return (
+    <label>
+      {props.label} <input {...field} type="number" value={field.value ?? ''} />
+    </label>
+  );
+};
+
+export const ProductForm = () => (
+  <Form>
+    <TextInput source="name" label="Name" />
+    <NumberInput source="price" label="Price" />
+    <button type="submit">Save</button>
+  </Form>
+);

package/dist/vulcan-preset/files/src/pages/product-list.tsx

@@ -0,0 +1,42 @@
+import { Link } from 'react-router-dom';
+import { ListBase, useCreatePath, useListContext } from 'ra-core';
+
+interface IProduct {
+  id: number;
+  name: string;
+  price: number;
+}
+
+const Rows = () => {
+  const { data, total, isPending } = useListContext<IProduct>();
+  const createPath = useCreatePath();
+
+  if (isPending) {
+    return <p>Loading</p>;
+  }
+
+  return (
+    <main>
+      <h1>
+        Products <small>({total} total)</small>
+      </h1>
+      <Link to={createPath({ resource: 'products', type: 'create' })}>Create</Link>
+      <ul>
+        {(data ?? []).map((product) => (
+          <li key={product.id}>
+            <Link to={createPath({ resource: 'products', type: 'edit', id: product.id })}>
+              {product.name}
+            </Link>{' '}
+            - {product.price}
+          </li>
+        ))}
+      </ul>
+    </main>
+  );
+};
+
+export const ProductList = () => (
+  <ListBase resource="products" perPage={10}>
+    <Rows />
+  </ListBase>
+);

package/dist/vulcan-preset/files/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@venizia/dev-configs/tsconfig.react.json",
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "types": ["vite/client"],
+    "noEmit": true,
+    "isolatedModules": true,
+
+    // Restated, not inherited: Bun ignores an `extends` that names a package.
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "useDefineForClassFields": false,
+
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src", "vite.config.mts"]
+}

package/dist/vulcan-preset/files/vite.config.mts

@@ -0,0 +1,36 @@
+import { IgnisArtifactsVitePlugin } from '@venizia/ignis-boot/vite';
+import react from '@vitejs/plugin-react';
+import { defineConfig, loadEnv } from 'vite';
+
+export default defineConfig(({ mode }) => {
+  const env = loadEnv(mode, '.', '');
+  // The backend app `vulcan add --api` chose; empty when there is none, and then nothing is proxied.
+  const apiUrl: string = '{{apiUrl}}';
+  const proxy: Record<string, string> = apiUrl === '' ? {} : { '/api': apiUrl };
+
+  return {
+    // Builds the class list of src/ into the bundle, so a decorated class is bound without being imported.
+    plugins: [IgnisArtifactsVitePlugin.create(), react()],
+    resolve: { alias: { '@': '/src' } },
+    server: {
+      port: Number(env.PORT ?? '{{devPort}}'),
+      strictPort: true,
+      proxy,
+    },
+    build: {
+      rolldownOptions: {
+        output: {
+          // React, react-admin and the router weigh about 500 KB before any application code. Two
+          // vendor chunks keep the application's own chunk small, cacheable across a deploy, and
+          // under Vite's 500 KB warning.
+          codeSplitting: {
+            groups: [
+              { name: 'react', test: /node_modules[\\/](react|react-dom|scheduler)[\\/]/ },
+              { name: 'vendor', test: /node_modules/ },
+            ],
+          },
+        },
+      },
+    },
+  };
+});

package/dist/vulcan-preset/preset.json

@@ -0,0 +1,71 @@
+{
+  "presetVersion": 1,
+  "side": "frontend",
+  "summary": "An ARDOR admin on Vite and React: one products resource with list, create and edit pages, REST data provider and i18n, no sign-in.",
+  "devPort": 5173,
+  "urls": [
+    "/"
+  ],
+  "dependencies": {
+    "@reduxjs/toolkit": "^2.12.0",
+    "@tanstack/react-query": "^5.101.2",
+    "@venizia/ardor": "0.3.1",
+    "@venizia/ignis-connectors": "0.3.1",
+    "@venizia/ignis-filter": "0.3.1",
+    "@venizia/ignis-helpers": "0.3.1",
+    "@venizia/ignis-inversion": "0.3.1",
+    "@venizia/ignis-kernel": "0.3.1",
+    "ra-core": "^5.15.0",
+    "ra-i18n-polyglot": "^5.15.0",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "react-redux": "^9.3.0",
+    "react-router-dom": "^7.9.4",
+    "reflect-metadata": "^0.2.2"
+  },
+  "devDependencies": {
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@venizia/dev-configs": "0.3.1",
+    "@venizia/ignis-boot": "0.3.1",
+    "@vitejs/plugin-react": "^6.1.1",
+    "eslint": "^10.10.0",
+    "oxfmt": "0.73.0",
+    "oxlint": "1.88.0",
+    "oxlint-tsgolint": "7.0.2004",
+    "typescript": "^6.0.3",
+    "vite": "^8.2.2"
+  },
+  "peers": {
+    "@venizia/ignis-connectors": "^0.3.0",
+    "@venizia/ignis-filter": "^0.3.0",
+    "@venizia/ignis-helpers": "^0.3.0",
+    "@venizia/ignis-inversion": "^0.3.0",
+    "@venizia/ignis-kernel": "^0.3.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "lint": "oxlint -c .configs/oxlint.config.mts --deny-warnings && eslint -c .configs/eslint.config.mjs . && oxfmt -c .configs/oxfmt.config.mts --check \"**/*.{js,mjs,ts,mts,tsx}\"",
+    "lint:fix": "oxlint -c .configs/oxlint.config.mts --fix && eslint -c .configs/eslint.config.mjs . --fix && oxfmt -c .configs/oxfmt.config.mts \"**/*.{js,mjs,ts,mts,tsx}\""
+  },
+  "checks": [
+    "typecheck",
+    "lint",
+    "build"
+  ],
+  "files": "./files",
+  "atlas": [
+    {
+      "name": "ardor",
+      "repo": "VENIZIA-AI/ardor",
+      "ref": "develop"
+    },
+    {
+      "name": "ignis",
+      "repo": "VENIZIA-AI/ignis",
+      "ref": "develop"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ardor",
-  "version": "0.1.5",
+  "version": "0.3.1",
   "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",
@@ -58,6 +58,9 @@
     "./package.json": "./package.json"
   },
   "sideEffects": false,
+  "vulcan": {
+    "preset": "./dist/vulcan-preset/preset.json"
+  },
   "files": [
     "README.md",
     "LICENSE.md",
@@ -73,18 +76,18 @@
     "prepublishOnly": "make rebuild"
   },
   "dependencies": {
-    "@venizia/ardor-admin": "0.1.5",
-    "@venizia/ardor-kernel": "0.1.5",
-    "@venizia/ardor-react": "0.1.5"
+    "@venizia/ardor-admin": "0.3.0",
+    "@venizia/ardor-kernel": "0.3.0",
+    "@venizia/ardor-react": "0.3.0"
   },
   "peerDependencies": {
     "@reduxjs/toolkit": ">=2.12.0",
     "@tanstack/react-query": ">=5.101.2",
-    "@venizia/ignis-connectors": "^0.2.2",
-    "@venizia/ignis-filter": "^0.2.2",
-    "@venizia/ignis-helpers": "^0.2.2",
-    "@venizia/ignis-inversion": "^0.2.2",
-    "@venizia/ignis-kernel": "^0.2.2",
+    "@venizia/ignis-connectors": "^0.3.0",
+    "@venizia/ignis-filter": "^0.3.0",
+    "@venizia/ignis-helpers": "^0.3.0",
+    "@venizia/ignis-inversion": "^0.3.0",
+    "@venizia/ignis-kernel": "^0.3.0",
     "ra-core": ">=5.15.0",
     "ra-i18n-polyglot": ">=5.15.0",
     "react": ">=18.0",
@@ -109,11 +112,11 @@
     "@types/bun": "^1.4.1",
     "@types/react": "^19",
     "@types/react-dom": "^19",
-    "@venizia/dev-configs": "0.3.1",
-    "@venizia/ignis-connectors": "0.2.2",
-    "@venizia/ignis-filter": "0.2.2",
-    "@venizia/ignis-inversion": "0.2.2",
-    "@venizia/ignis-kernel": "0.2.2",
+    "@venizia/dev-configs": "^0.3.1",
+    "@venizia/ignis-connectors": "^0.3.1",
+    "@venizia/ignis-filter": "^0.3.1",
+    "@venizia/ignis-inversion": "^0.3.1",
+    "@venizia/ignis-kernel": "^0.3.1",
     "eslint": "^10.10.0",
     "oxfmt": "0.73.0",
     "oxlint": "1.88.0",