xladmin 0.1.0

package/README.md

@@ -0,0 +1,51 @@
+# xladmin
+
+`xladmin` это React/MUI-библиотека для admin UI поверх backend-пакета `xladmin`.
+
+Важно:
+
+- имя пакета в npm: `xladmin`
+- импорты во frontend: `from 'xladmin'`
+
+## Что есть в библиотеке
+
+- `createXLAdminClient(...)` — сборка клиента из любого совместимого transport-объекта
+- `createAxiosXLAdminClient(...)` — готовый helper для `axios`
+- `createFetchXLAdminClient(...)` — готовый helper для `fetch`
+- `AdminShell` — общий layout админки
+- `AdminHome` — главная страница со списком моделей
+- `AdminModelPage` — список объектов модели
+- `AdminObjectPage` — детальная страница объекта
+- `defaultAdminTheme` — встроенная тема библиотеки
+
+Основные файлы:
+
+- `src/client.ts`
+- `src/components/AdminShell.tsx`
+- `src/components/AdminModelPage.tsx`
+- `src/components/AdminObjectPage.tsx`
+- `src/components/AdminFieldEditor.tsx`
+- `src/theme/defaultAdminTheme.ts`
+
+## Совместимость
+
+- `React >=19,<20`
+- `React DOM >=19,<20`
+- `Next >=15,<17`
+- `@mui/material >=7,<8`
+- `@mui/icons-material >=7,<8`
+- `@mui/x-date-pickers >=8,<9`
+- `dayjs >=1,<2`
+- `axios >=1,<2` — опционально, только если проект хочет использовать axios-helper
+
+## Как подключать
+
+Библиотека не требует именно `axios`.
+
+Можно использовать:
+
+- `createAxiosXLAdminClient(api)` если у проекта уже есть `axios instance`
+- `createFetchXLAdminClient({...})` если проект работает через `fetch`
+- свой `XLAdminClient`, если проекту нужен полностью свой transport или особая логика
+
+Практическая инструкция вынесена в [docs/HOW_TO_USE.md](docs/HOW_TO_USE.md).

package/dist/client.d.ts

@@ -0,0 +1,46 @@
+import type { AdminChoicesResponse, AdminDetailResponse, AdminListResponse, AdminModelMeta, AdminModelsResponse, AdminObjectActionResponse } from './types';
+export type XLAdminClient = {
+    getModels: () => Promise<AdminModelsResponse>;
+    getModel: (slug: string) => Promise<AdminModelMeta>;
+    getItems: (slug: string, params?: {
+        limit?: number;
+        offset?: number;
+        q?: string;
+        sort?: string;
+    }) => Promise<AdminListResponse>;
+    getItem: (slug: string, id: string | number) => Promise<AdminDetailResponse>;
+    createItem: (slug: string, payload: Record<string, unknown>) => Promise<AdminDetailResponse>;
+    patchItem: (slug: string, id: string | number, payload: Record<string, unknown>) => Promise<AdminDetailResponse>;
+    deleteItem: (slug: string, id: string | number) => Promise<void>;
+    bulkDelete: (slug: string, ids: Array<string | number>) => Promise<{
+        deleted: number;
+    }>;
+    runBulkAction: (slug: string, actionSlug: string, ids: Array<string | number>, payload?: Record<string, unknown>) => Promise<{
+        processed: number;
+    } & Record<string, unknown>>;
+    runObjectAction: (slug: string, id: string | number, actionSlug: string, payload?: Record<string, unknown>) => Promise<AdminObjectActionResponse>;
+    getChoices: (slug: string, fieldName: string, q?: string, ids?: Array<string | number>) => Promise<AdminChoicesResponse>;
+};
+type XLAdminTransportResponse<T> = T | {
+    data: T;
+};
+export type XLAdminTransport = {
+    get: <T>(url: string, options?: {
+        params?: Record<string, unknown>;
+    }) => Promise<XLAdminTransportResponse<T>>;
+    post: <T>(url: string, body?: Record<string, unknown>) => Promise<XLAdminTransportResponse<T>>;
+    patch: <T>(url: string, body: Record<string, unknown>) => Promise<XLAdminTransportResponse<T>>;
+    delete: (url: string) => Promise<unknown>;
+};
+export type XLAdminAxiosLike = XLAdminTransport;
+export type XLAdminFetchClientConfig = {
+    baseUrl: string;
+    fetch?: typeof globalThis.fetch;
+    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
+    credentials?: RequestCredentials;
+};
+export declare function createXLAdminClient(transport: XLAdminTransport): XLAdminClient;
+export declare function createAxiosXLAdminClient(api: XLAdminAxiosLike): XLAdminClient;
+export declare function createFetchXLAdminClient(config: XLAdminFetchClientConfig): XLAdminClient;
+export declare function createFetchXLAdminTransport(config: XLAdminFetchClientConfig): XLAdminTransport;
+export {};

package/dist/components/AdminFieldEditor.d.ts

@@ -0,0 +1,18 @@
+import type { XLAdminClient } from '../client';
+import type { AdminFieldMeta } from '../types';
+type AdminFieldEditorProps = {
+    field: AdminFieldMeta;
+    value: unknown;
+    onChange: (value: unknown) => void;
+    slug: string;
+    client: XLAdminClient;
+    readOnly?: boolean;
+};
+/**
+ * Универсальный редактор поля админки.
+ *
+ * Здесь библиотека сама подбирает виджет под тип поля, а проект при необходимости
+ * может переопределить это через `input_kind` на backend.
+ */
+export declare function AdminFieldEditor({ field, value, onChange, slug, client, readOnly, }: AdminFieldEditorProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminFormDialog.d.ts

@@ -0,0 +1,16 @@
+import type { XLAdminClient } from '../client';
+import type { AdminModelMeta } from '../types';
+type AdminFormDialogProps = {
+    open: boolean;
+    onClose: () => void;
+    onSuccess: () => void;
+    title: string;
+    slug: string;
+    mode: 'create' | 'patch';
+    meta: AdminModelMeta;
+    client: XLAdminClient;
+    initialValues?: Record<string, unknown>;
+    itemId?: string | number;
+};
+export declare function AdminFormDialog({ open, onClose, onSuccess, title, slug, mode, meta, client, initialValues, itemId, }: AdminFormDialogProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminHome.d.ts

@@ -0,0 +1,7 @@
+import type { XLAdminClient } from '../client';
+type AdminHomeProps = {
+    client: XLAdminClient;
+    basePath: string;
+};
+export declare function AdminHome({ client, basePath }: AdminHomeProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminModelPage.d.ts

@@ -0,0 +1,8 @@
+import type { XLAdminClient } from '../client';
+type AdminModelPageProps = {
+    client: XLAdminClient;
+    basePath: string;
+    slug: string;
+};
+export declare function AdminModelPage({ client, basePath, slug }: AdminModelPageProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminObjectPage.d.ts

@@ -0,0 +1,8 @@
+import type { XLAdminClient } from '../client';
+type AdminObjectPageProps = {
+    client: XLAdminClient;
+    slug: string;
+    id: string;
+};
+export declare function AdminObjectPage({ client, slug, id }: AdminObjectPageProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminShell.d.ts

@@ -0,0 +1,14 @@
+import type { ReactNode } from 'react';
+import { type Theme } from '@mui/material/styles';
+import type { XLAdminClient } from '../client';
+import type { AdminModelMeta } from '../types';
+type AdminShellProps = {
+    client: XLAdminClient;
+    models: AdminModelMeta[];
+    basePath: string;
+    children: ReactNode;
+    /** Передайте свою MUI theme сюда, если хотите переопределить дефолтную тему библиотеки. */
+    theme?: Theme;
+};
+export declare function AdminShell({ client, models, basePath, children, theme }: AdminShellProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/AdminSidebar.d.ts

@@ -0,0 +1,7 @@
+import type { AdminModelMeta } from '../types';
+type AdminSidebarProps = {
+    models: AdminModelMeta[];
+    basePath: string;
+};
+export declare function AdminSidebar({ models, basePath }: AdminSidebarProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/hooks/useAdminRequest.d.ts

@@ -0,0 +1,6 @@
+export declare function useAdminRequest<T>(loader: () => Promise<T>, deps: unknown[]): {
+    data: T | null;
+    isLoading: boolean;
+    error: string | null;
+    setData: import("react").Dispatch<import("react").SetStateAction<T | null>>;
+};

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+export { createAxiosXLAdminClient, createFetchXLAdminClient, createFetchXLAdminTransport, createXLAdminClient, type XLAdminAxiosLike, type XLAdminClient, type XLAdminFetchClientConfig, type XLAdminTransport, } from './client';
+export * from './components/AdminFormDialog';
+export * from './components/AdminHome';
+export * from './components/AdminModelPage';
+export * from './components/AdminObjectPage';
+export * from './components/AdminShell';
+export * from './components/AdminSidebar';
+export * from './theme/defaultAdminTheme';
+export * from './types';

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { createAxiosXLAdminClient, createFetchXLAdminClient, createFetchXLAdminTransport, createXLAdminClient, type XLAdminAxiosLike, type XLAdminClient, type XLAdminFetchClientConfig, type XLAdminTransport, } from './client';
+export * from './components/AdminFormDialog';
+export * from './components/AdminHome';
+export * from './components/AdminModelPage';
+export * from './components/AdminObjectPage';
+export * from './components/AdminShell';
+export * from './components/AdminSidebar';
+export * from './theme/defaultAdminTheme';
+export * from './types';