@duke333/builder-ui 0.1.0 → 0.1.3

package/README.md

@@ -1,85 +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
 ```
 
-## Хэрэглэх
+## One File Setup
 
-Host app дээр package factory-уудыг host wrapper component болгон угсарна:
+Use one frontend bind file:
 
-```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
+```tsx
+"use client";
+
+import { createBuilderPortalIntegration } from "@duke333/builder-ui/integration";
+import { api } from "@/lib/api/apiClient";
+
+export const builder = createBuilderPortalIntegration({
+  transport: api,
+  adminBasePath: "/admin/dev/builder",
+  runtimeBasePath: "/admin/winu",
+  adminPages: {
+    permissionOptions: [{ value: "org:manage", label: "org:manage" }],
+    defaultPermission: "org:manage",
+  },
+});
+
+export const {
+  api: builderApi,
+  hooks: builderHooks,
+  routes: builderRoutes,
+  adminPages,
+} = builder;
 ```
 
-App page дээр wrapper-уудыг ашиглана:
+## Route Example
 
 ```tsx
-import { DynamicView } from "../features/builder/components/DynamicView";
+import { adminPages } from "@/features/builder/builder.config";
 
-export default function RuntimePage() {
-  return <DynamicView viewId="..." />;
+export default function Page() {
+  const Component = adminPages?.AdminFormsPage;
+  return Component ? <Component /> : null;
 }
 ```
 
-Дангаар нь дуудах contract:
+## Runtime Component Example
 
 ```tsx
-<DynamicForm formId="..." />
-<DynamicList listId="..." />
-<DynamicView viewId="..." />
-```
-
-`DynamicView` нь form + list нийлсэн CRUD screen. Харин зөвхөн form эсвэл зөвхөн
-grid/list хэрэгтэй бол `DynamicForm`, `DynamicList`-ийг шууд ашиглана.
+import { createDynamicViewComponent } from "@duke333/builder-ui/components";
+import { builderHooks } from "@/features/builder/builder.config";
 
-## Host UI Adapter
-
-Package нь shadcn/ui-г шууд эзэмшихгүй. Host app өөрийн Button, Dialog, DataGrid,
-form renderer зэрэг design-system component-уудаа adapter-аар өгнө. Ингэснээр portal
-энгийн shadcn app хэвээр, builder нь нэмэлт reusable layer хэвээр үлдэнэ.
-
-## Publish / Update
-
-Publish after `@duke333/builder-contracts` and `@duke333/builder-backend` are available in the
-target registry. The package is configured for public npm publishing.
+export const DynamicView = createDynamicViewComponent({
+  hooks: builderHooks,
+  notifications,
+});
+```
 
-External portal project дээр:
+Use:
 
-```bash
-pnpm add @duke333/builder-ui
-```
+- `DynamicForm` for form-only write flow
+- `DynamicList` for list-only read flow
+- `DynamicView` for full CRUD flow
 
-Update:
+## Validation
 
 ```bash
-pnpm update @duke333/builder-ui
+pnpm typecheck
+pnpm test:run
 ```
-
-Package нь `dist` output publish хийнэ. `prepack` нь publish/pack хийхээс өмнө
-`pnpm build` ажиллуулна.