@dynamic-field-kit/core 1.0.1 → 1.0.3

package/README.md

@@ -45,7 +45,7 @@ react >= 17
 
 The library **does NOT define field types** like:
 ```ts
-"text" | "number" | "select"
+"text" | "number"
 ```
 
 Instead, it exposes an **extendable interface** that applications can augment:
@@ -65,9 +65,9 @@ This pattern is used by mature libraries like **MUI, React Hook Form,** and **Re
 Create a `.d.ts` file in your app (e.g. src/types/dynamic-field.d.ts):
 
 ```ts
-import "@dynamic-field-kit/react"
+import "@dynamic-field-kit/core"
 
-declare module "@dynamic-field-kit/react" {
+declare module "@dynamic-field-kit/core" {
   interface FieldTypeMap {
     text: string
     number: number
@@ -80,6 +80,19 @@ declare module "@dynamic-field-kit/react" {
 
 ---
 
+## FieldRendererProps
+
+```ts
+export interface FieldRendererProps<T = any> {
+  value?: T
+  onValueChange?: (value: T) => void
+  label?: string
+}
+```
+👉 A common contract for all field renderers
+
+---
+
 ### FieldDescription
 
 A `FieldDescription` defines **what a field is**, not **how it looks**.
@@ -102,11 +115,14 @@ const fields: FieldDescription[] = [
 ]
 ```
 
-**Key properties**
-- `name` – field key in form data
-- `type` – renderer key
-- `appearCondition` – runtime visibility condition
-- No domain-specific typing enforced
+**Common Properties**
+| Property	| Description |
+|------|------------|
+| name	| Field key in form data |
+| type	| Field renderer key |
+| label	| UI label |
+| value	| Default value |
+| appearCondition	| Runtime visibility condition |
 
 **Field Registry (Render Layer)**
 The library does **not** ship UI components.
@@ -254,6 +270,10 @@ Renders a single field with value binding.
   onChange={(value, key) => {}}
 />
 ```
+
+## Demo
+- [Examples](https://github.com/vannt-dev/dynamic-field-kit-demo)
+
 ---
 
 ## 🏗 Architecture
@@ -273,4 +293,7 @@ This library intentionally does not include:
 -Built-in UI components
 -Form state management library
 
-It is a **form engine**, not a full form framework.
+It is a **form engine**, not a full form framework.
+
+## 📄 License
+MIT © vannt-dev

package/dist/index.d.mts

@@ -16,12 +16,12 @@ interface FieldDescription<T extends FieldTypeKey = FieldTypeKey> {
     appearCondition?: (data: Properties) => boolean;
 }
 
-type Renderer = (props: FieldRendererProps<any>) => JSX.Element;
+type FieldRenderer<T = any> = (props: FieldRendererProps<T>) => JSX.Element;
 declare class FieldRegistry {
-    private map;
-    register<T extends FieldTypeKey>(type: T, renderer: (props: FieldRendererProps) => JSX.Element): void;
-    get(type: FieldTypeKey): Renderer | undefined;
+    private registry;
+    register<K extends keyof FieldTypeMap>(type: K, renderer: FieldRenderer<FieldTypeMap[K]>): void;
+    get<K extends keyof FieldTypeMap>(type: K): FieldRenderer<FieldTypeMap[K]> | undefined;
 }
 declare const fieldRegistry: FieldRegistry;
 
-export { type FieldDescription, type FieldRendererProps, type FieldTypeKey, type FieldTypeMap, type Properties, fieldRegistry };
+export { type FieldDescription, FieldRegistry, type FieldRenderer, type FieldRendererProps, type FieldTypeKey, type FieldTypeMap, type Properties, fieldRegistry };

package/dist/index.d.ts

@@ -16,12 +16,12 @@ interface FieldDescription<T extends FieldTypeKey = FieldTypeKey> {
     appearCondition?: (data: Properties) => boolean;
 }
 
-type Renderer = (props: FieldRendererProps<any>) => JSX.Element;
+type FieldRenderer<T = any> = (props: FieldRendererProps<T>) => JSX.Element;
 declare class FieldRegistry {
-    private map;
-    register<T extends FieldTypeKey>(type: T, renderer: (props: FieldRendererProps) => JSX.Element): void;
-    get(type: FieldTypeKey): Renderer | undefined;
+    private registry;
+    register<K extends keyof FieldTypeMap>(type: K, renderer: FieldRenderer<FieldTypeMap[K]>): void;
+    get<K extends keyof FieldTypeMap>(type: K): FieldRenderer<FieldTypeMap[K]> | undefined;
 }
 declare const fieldRegistry: FieldRegistry;
 
-export { type FieldDescription, type FieldRendererProps, type FieldTypeKey, type FieldTypeMap, type Properties, fieldRegistry };
+export { type FieldDescription, FieldRegistry, type FieldRenderer, type FieldRendererProps, type FieldTypeKey, type FieldTypeMap, type Properties, fieldRegistry };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  FieldRegistry: () => FieldRegistry,
   fieldRegistry: () => fieldRegistry
 });
 module.exports = __toCommonJS(index_exports);
@@ -27,18 +28,21 @@ module.exports = __toCommonJS(index_exports);
 // src/fieldRegistry.ts
 var FieldRegistry = class {
   constructor() {
-    this.map = /* @__PURE__ */ new Map();
+    // ❗ INTERNAL = string, KHÔNG constrain
+    this.registry = {};
   }
+  // ✅ Type safety ở API
   register(type, renderer) {
-    this.map.set(type, renderer);
+    this.registry[type] = renderer;
   }
   get(type) {
-    return this.map.get(type);
+    return this.registry[type];
   }
 };
 var fieldRegistry = new FieldRegistry();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  FieldRegistry,
   fieldRegistry
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/fieldRegistry.ts"],"sourcesContent":["export * from \"./types\"\r\nexport * from \"./fieldRegistry\"\r\n","import { JSX } from \"react\"\r\nimport { FieldRendererProps, FieldTypeKey } from \"./types\"\r\n\r\ntype Renderer = (props: FieldRendererProps<any>) => JSX.Element\r\n\r\nclass FieldRegistry {\r\n    private map = new Map<FieldTypeKey, Renderer>()\r\n\r\n    register<T extends FieldTypeKey>(\r\n        type: T,\r\n        renderer: (props: FieldRendererProps) => JSX.Element\r\n    ) {\r\n        this.map.set(type, renderer)\r\n    }\r\n\r\n    get(type: FieldTypeKey) {\r\n        return this.map.get(type)\r\n    }\r\n}\r\n\r\nexport const fieldRegistry = new FieldRegistry()\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKA,IAAM,gBAAN,MAAoB;AAAA,EAApB;AACI,SAAQ,MAAM,oBAAI,IAA4B;AAAA;AAAA,EAE9C,SACI,MACA,UACF;AACE,SAAK,IAAI,IAAI,MAAM,QAAQ;AAAA,EAC/B;AAAA,EAEA,IAAI,MAAoB;AACpB,WAAO,KAAK,IAAI,IAAI,IAAI;AAAA,EAC5B;AACJ;AAEO,IAAM,gBAAgB,IAAI,cAAc;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/fieldRegistry.ts"],"sourcesContent":["export * from \"./types\"\r\nexport * from \"./fieldRegistry\"\r\n","import { JSX } from \"react\"\r\nimport type { FieldRendererProps, FieldTypeMap } from \"./types\"\r\n\r\nexport type FieldRenderer<T = any> = (props: FieldRendererProps<T>) => JSX.Element\r\n\r\nexport class FieldRegistry {\r\n    // ❗ INTERNAL = string, KHÔNG constrain\r\n    private registry: Record<string, FieldRenderer<any>> = {}\r\n\r\n    // ✅ Type safety ở API\r\n    register<K extends keyof FieldTypeMap>(\r\n        type: K,\r\n        renderer: FieldRenderer<FieldTypeMap[K]>\r\n    ) {\r\n        this.registry[type as string] = renderer\r\n    }\r\n\r\n    get<K extends keyof FieldTypeMap>(\r\n        type: K\r\n    ): FieldRenderer<FieldTypeMap[K]> | undefined {\r\n        return this.registry[type as string]\r\n    }\r\n}\r\n\r\nexport const fieldRegistry = new FieldRegistry()\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,gBAAN,MAAoB;AAAA,EAApB;AAEH;AAAA,SAAQ,WAA+C,CAAC;AAAA;AAAA;AAAA,EAGxD,SACI,MACA,UACF;AACE,SAAK,SAAS,IAAc,IAAI;AAAA,EACpC;AAAA,EAEA,IACI,MAC0C;AAC1C,WAAO,KAAK,SAAS,IAAc;AAAA,EACvC;AACJ;AAEO,IAAM,gBAAgB,IAAI,cAAc;","names":[]}

package/dist/index.mjs

@@ -1,17 +1,20 @@
 // src/fieldRegistry.ts
 var FieldRegistry = class {
   constructor() {
-    this.map = /* @__PURE__ */ new Map();
+    // ❗ INTERNAL = string, KHÔNG constrain
+    this.registry = {};
   }
+  // ✅ Type safety ở API
   register(type, renderer) {
-    this.map.set(type, renderer);
+    this.registry[type] = renderer;
   }
   get(type) {
-    return this.map.get(type);
+    return this.registry[type];
   }
 };
 var fieldRegistry = new FieldRegistry();
 export {
+  FieldRegistry,
   fieldRegistry
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/fieldRegistry.ts"],"sourcesContent":["import { JSX } from \"react\"\r\nimport { FieldRendererProps, FieldTypeKey } from \"./types\"\r\n\r\ntype Renderer = (props: FieldRendererProps<any>) => JSX.Element\r\n\r\nclass FieldRegistry {\r\n    private map = new Map<FieldTypeKey, Renderer>()\r\n\r\n    register<T extends FieldTypeKey>(\r\n        type: T,\r\n        renderer: (props: FieldRendererProps) => JSX.Element\r\n    ) {\r\n        this.map.set(type, renderer)\r\n    }\r\n\r\n    get(type: FieldTypeKey) {\r\n        return this.map.get(type)\r\n    }\r\n}\r\n\r\nexport const fieldRegistry = new FieldRegistry()\r\n"],"mappings":";AAKA,IAAM,gBAAN,MAAoB;AAAA,EAApB;AACI,SAAQ,MAAM,oBAAI,IAA4B;AAAA;AAAA,EAE9C,SACI,MACA,UACF;AACE,SAAK,IAAI,IAAI,MAAM,QAAQ;AAAA,EAC/B;AAAA,EAEA,IAAI,MAAoB;AACpB,WAAO,KAAK,IAAI,IAAI,IAAI;AAAA,EAC5B;AACJ;AAEO,IAAM,gBAAgB,IAAI,cAAc;","names":[]}
+{"version":3,"sources":["../src/fieldRegistry.ts"],"sourcesContent":["import { JSX } from \"react\"\r\nimport type { FieldRendererProps, FieldTypeMap } from \"./types\"\r\n\r\nexport type FieldRenderer<T = any> = (props: FieldRendererProps<T>) => JSX.Element\r\n\r\nexport class FieldRegistry {\r\n    // ❗ INTERNAL = string, KHÔNG constrain\r\n    private registry: Record<string, FieldRenderer<any>> = {}\r\n\r\n    // ✅ Type safety ở API\r\n    register<K extends keyof FieldTypeMap>(\r\n        type: K,\r\n        renderer: FieldRenderer<FieldTypeMap[K]>\r\n    ) {\r\n        this.registry[type as string] = renderer\r\n    }\r\n\r\n    get<K extends keyof FieldTypeMap>(\r\n        type: K\r\n    ): FieldRenderer<FieldTypeMap[K]> | undefined {\r\n        return this.registry[type as string]\r\n    }\r\n}\r\n\r\nexport const fieldRegistry = new FieldRegistry()\r\n"],"mappings":";AAKO,IAAM,gBAAN,MAAoB;AAAA,EAApB;AAEH;AAAA,SAAQ,WAA+C,CAAC;AAAA;AAAA;AAAA,EAGxD,SACI,MACA,UACF;AACE,SAAK,SAAS,IAAc,IAAI;AAAA,EACpC;AAAA,EAEA,IACI,MAC0C;AAC1C,WAAO,KAAK,SAAS,IAAc;AAAA,EACvC;AACJ;AAEO,IAAM,gBAAgB,IAAI,cAAc;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dynamic-field-kit/core",
-    "version": "1.0.1",
+    "version": "1.0.3",
     "description": "Core types and field registry for dynamic-field-kit",
     "license": "MIT",
     "main": "dist/index.cjs",