@duke333/builder-ui 0.1.1 → 0.1.3

package/README.md

@@ -1,155 +1,73 @@
 # @duke333/builder-ui
 
-Frontend талын builder package. Энэ package нь dynamic form/list/view runtime logic,
-builder admin factory components, API client factory, React Query hook factory-уудыг
-эзэмшинэ.
+React Builder package for admin screens and runtime form/list/view UI.
 
-## Workspace Development
-
-This repository uses the package as a workspace dependency:
-
-```json
-{
-  "dependencies": {
-    "@duke333/builder-ui": "workspace:*"
-  }
-}
-```
-
-Ажиллуулах:
+## Install
 
 ```bash
-pnpm install
-pnpm build
-pnpm typecheck
-pnpm test:run
+pnpm add @duke333/builder-ui
 ```
 
-## Хэрэглэх
-
-Host app дээр package factory-уудыг host wrapper component болгон угсарна:
-
-```text
-src/features/builder/api.ts
-src/features/builder/hooks/useBuilder.ts
-src/features/builder/components/DynamicForm.tsx
-src/features/builder/components/DynamicList.tsx
-src/features/builder/components/DynamicView.tsx
-```
+## One File Setup
 
-App page дээр wrapper-уудыг ашиглана:
+Use one frontend bind file:
 
 ```tsx
-import { DynamicView } from "../features/builder/components/DynamicView";
-
-export default function RuntimePage() {
-  return <DynamicView viewId="..." />;
-}
-```
+"use client";
 
-Дангаар нь дуудах contract:
-
-```tsx
-<DynamicForm formId="..." />
-<DynamicList listId="..." />
-<DynamicView viewId="..." />
-```
-
-`DynamicView` нь form + list нийлсэн CRUD screen. Харин зөвхөн form эсвэл зөвхөн
-grid/list хэрэгтэй бол `DynamicForm`, `DynamicList`-ийг шууд ашиглана.
-
-## Integration API
-
-Host app нэг builder client object-оор API, hooks, route config-оо авах бол:
-
-```ts
-import { createBuilderIntegration } from "@duke333/builder-ui/integration";
+import { createBuilderPortalIntegration } from "@duke333/builder-ui/integration";
 import { api } from "@/lib/api/apiClient";
 
-export const builder = createBuilderIntegration({
+export const builder = createBuilderPortalIntegration({
   transport: api,
   adminBasePath: "/admin/dev/builder",
-});
-```
-
-Үр дүнд нь:
-
-- `builder.api`
-- `builder.hooks`
-- `builder.routes`
-
-## Default Admin Pages
-
-Admin home/forms/lists/views screen-үүдийг host app дотор олон wrapper файлгүйгээр
-үүсгэх бол:
-
-```tsx
-import { createBuilderAdminPages } from "@duke333/builder-ui/admin";
-import { createBuilderIntegration } from "@duke333/builder-ui/integration";
-import { api } from "@/lib/api/apiClient";
-
-const integration = createBuilderIntegration({
-  transport: api,
-  adminBasePath: "/admin/dev/builder",
-});
-
-export const builderAdmin = createBuilderAdminPages({
-  hooks: integration.hooks,
-  routes: {
-    adminBasePath: integration.routes.adminBasePath,
+  runtimeBasePath: "/admin/winu",
+  adminPages: {
+    permissionOptions: [{ value: "org:manage", label: "org:manage" }],
+    defaultPermission: "org:manage",
   },
 });
+
+export const {
+  api: builderApi,
+  hooks: builderHooks,
+  routes: builderRoutes,
+  adminPages,
+} = builder;
 ```
 
-Route file дээр:
+## Route Example
 
 ```tsx
+import { adminPages } from "@/features/builder/builder.config";
+
 export default function Page() {
-  return <builderAdmin.AdminFormsPage />;
+  const Component = adminPages?.AdminFormsPage;
+  return Component ? <Component /> : null;
 }
 ```
 
-New/edit route дээр:
+## Runtime Component Example
 
 ```tsx
-export default function Page() {
-  return <builderAdmin.AdminNewFormPage />;
-}
+import { createDynamicViewComponent } from "@duke333/builder-ui/components";
+import { builderHooks } from "@/features/builder/builder.config";
 
-export default function EditPage({ searchParams }: { searchParams: { id?: string } }) {
-  return <builderAdmin.AdminEditFormPage formId={searchParams.id} />;
-}
+export const DynamicView = createDynamicViewComponent({
+  hooks: builderHooks,
+  notifications,
+});
 ```
 
-Available default admin pages:
-
-- `AdminHomePage`
-- `AdminFormsPage`, `AdminNewFormPage`, `AdminEditFormPage`
-- `AdminListsPage`, `AdminNewListPage`, `AdminEditListPage`
-- `AdminViewsPage`, `AdminNewViewPage`, `AdminEditViewPage`
-
-## Host UI Adapter
-
-Package нь shadcn/ui-г шууд эзэмшихгүй. Default admin pages нь dependency-free HTML
-controls ашиглана. Host app өөрийн Button, Dialog, DataGrid, form renderer зэрэг
-design-system component-уудаа adapter-аар өгвөл custom UI layer ашиглаж болно.
+Use:
 
-## Publish / Update
+- `DynamicForm` for form-only write flow
+- `DynamicList` for list-only read flow
+- `DynamicView` for full CRUD flow
 
-Publish after `@duke333/builder-contracts` and `@duke333/builder-backend` are available in the
-target registry. The package is configured for public npm publishing.
-
-External portal project дээр:
+## Validation
 
 ```bash
-pnpm add @duke333/builder-ui
-```
-
-Update:
-
-```bash
-pnpm update @duke333/builder-ui
+pnpm typecheck
+pnpm test:run
 ```
-
-Package нь `dist` output publish хийнэ. `prepack` нь publish/pack хийхээс өмнө
-`pnpm build` ажиллуулна.