@arqel-dev/ui 0.8.0

package/dist/pages.d.ts

@@ -0,0 +1,73 @@
+import { JSX, ComponentType } from 'react';
+import { RecordType } from '@arqel-dev/types/resources';
+
+/**
+ * Default Inertia page for `arqel::create`.
+ *
+ * Renders a `<FormRenderer>` over the schema/fields the server
+ * emits (with `record: null`). Submission goes through Inertia's
+ * `useForm` via `useArqelForm` from `@arqel-dev/hooks` — this page is
+ * just the layout shell.
+ */
+
+declare function ArqelCreatePage(): JSX.Element;
+
+/**
+ * Default Inertia page for `arqel::edit`.
+ *
+ * Same shape as `ArqelCreatePage` but seeds the form with the
+ * server-emitted `record`. Submission posts to PUT `/{slug}/{id}`.
+ */
+
+declare function ArqelEditPage<TRecord extends RecordType = RecordType>(): JSX.Element;
+
+/**
+ * Default Inertia page for `arqel::index`.
+ *
+ * Pulls every prop the server emits via `InertiaDataBuilder::
+ * buildIndexData` / `buildTableIndexData` and forwards them to
+ * `<ResourceIndex>`. Apps can override per-resource by registering
+ * their own page component at `Pages/Arqel/{Slug}/Index.tsx` (the
+ * lookup falls through to user pages first inside `createArqelApp`).
+ */
+
+declare function ArqelIndexPage<TRecord extends RecordType = RecordType>(): JSX.Element;
+
+/**
+ * Default Inertia page for `arqel::show`.
+ *
+ * Read-only render of the record. Re-uses `<FormRenderer>` with
+ * every field forced to disabled — keeps a single rendering path
+ * for create/edit/show without a parallel "DetailRenderer" stack.
+ */
+
+declare function ArqelShowPage<TRecord extends RecordType = RecordType>(): JSX.Element;
+
+/**
+ * Built-in Inertia page registry for `arqel::*`.
+ *
+ * `createArqelApp({ pages })` from `@arqel-dev/react/inertia` accepts
+ * one or more `PageRegistry` records — merge `arqelPages` first so
+ * user-defined pages can override per-resource:
+ *
+ * ```ts
+ * import { arqelPages } from '@arqel-dev/ui/pages';
+ * import { createArqelApp } from '@arqel-dev/react/inertia';
+ *
+ * const userPages = import.meta.glob('./Pages/**\/*.tsx');
+ *
+ * createArqelApp({
+ *   pages: { ...arqelPages, ...userPages },
+ * });
+ * ```
+ *
+ * Names match what `ResourceController` emits via
+ * `Inertia::render('arqel::index', ...)`.
+ */
+
+type LazyPage = () => Promise<{
+    default: ComponentType<unknown>;
+}>;
+declare const arqelPages: Record<string, LazyPage>;
+
+export { ArqelCreatePage, ArqelEditPage, ArqelIndexPage, ArqelShowPage, arqelPages };