@kubuild/components 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +110 -0
  2. package/dist/blocks.d.ts.map +1 -1
  3. package/dist/definitions.d.ts +5 -0
  4. package/dist/definitions.d.ts.map +1 -1
  5. package/dist/index.cjs +1671 -19
  6. package/dist/index.cjs.map +1 -1
  7. package/dist/index.js +1641 -19
  8. package/dist/index.js.map +1 -1
  9. package/dist/traits.d.ts +50 -0
  10. package/dist/traits.d.ts.map +1 -1
  11. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,110 @@
1
+ # @kubuild/components
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@kubuild/components.svg)](https://www.npmjs.com/package/@kubuild/components)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
5
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue)](https://www.typescriptlang.org/)
6
+
7
+ Component registry, schema definitions, traits, prop types, and starter form/layout block templates for **KUBUILD**.
8
+
9
+ ---
10
+
11
+ ## 📦 Installation
12
+
13
+ ```bash
14
+ # Using pnpm (recommended)
15
+ pnpm add @kubuild/components @kubuild/core @kubuild/schema
16
+
17
+ # Using npm
18
+ npm install @kubuild/components @kubuild/core @kubuild/schema
19
+
20
+ # Using yarn
21
+ yarn add @kubuild/components @kubuild/core @kubuild/schema
22
+ ```
23
+
24
+ ---
25
+
26
+ ## ✨ Features
27
+
28
+ - **Component Registry**: Unified registry (`componentRegistry`) of built-in components:
29
+ - Layout: `container`, `section`, `grid`, `flex`
30
+ - Typography: `heading`, `text`, `paragraph`, `link`
31
+ - Media: `image`, `video`, `icon`
32
+ - Interactive & Forms: `form`, `input`, `textarea`, `select`, `checkbox`, `radio`, `button`, `button-submit`
33
+ - Data & Modals: `table`, `table-row`, `table-cell`, `modal`
34
+ - **Component Traits**: Declarative configuration for traits (properties, labels, input types, default values, validation rules).
35
+ - **Starter Block Templates**: Production-ready blocks in `STARTER_BLOCKS`:
36
+ - **Contact Us Form**: Form block with validation, inputs (Name, Email, Message), and submit action.
37
+ - **Newsletter Subscription**: Inline form with email input and submit handler.
38
+ - **Lead Generation**: Multi-field lead capture form.
39
+ - **Hero & Content Sections**: Responsive hero banners and feature grids.
40
+ - **Structural Integrity Rules**: Enforces parent-child constraints (e.g. table cells must be inside table rows, form inputs must be inside form nodes, submit buttons cannot be nested inside another button).
41
+
42
+ ---
43
+
44
+ ## 🚀 Quick Usage
45
+
46
+ ### Accessing the Component Registry
47
+
48
+ ```typescript
49
+ import { componentRegistry } from '@kubuild/components';
50
+
51
+ // Retrieve definition for a specific component
52
+ const buttonDef = componentRegistry.get('button');
53
+
54
+ console.log('Button default props:', buttonDef?.defaultProps);
55
+ console.log('Button traits:', buttonDef?.traits);
56
+
57
+ // Check all registered components
58
+ const allComponents = componentRegistry.getAll();
59
+ ```
60
+
61
+ ### Using Starter Form Templates
62
+
63
+ ```typescript
64
+ import { STARTER_BLOCKS } from '@kubuild/components';
65
+
66
+ // Find the Contact Us starter block
67
+ const contactFormBlock = STARTER_BLOCKS.find(b => b.id === 'contact-us-form');
68
+
69
+ if (contactFormBlock) {
70
+ console.log('Template name:', contactFormBlock.name);
71
+ console.log('Preconfigured node tree:', contactFormBlock.node);
72
+ }
73
+ ```
74
+
75
+ ### Registering Custom Components
76
+
77
+ ```typescript
78
+ import { componentRegistry, type ComponentDefinition } from '@kubuild/components';
79
+
80
+ const customCardDef: ComponentDefinition = {
81
+ type: 'custom-card',
82
+ name: 'Custom Card',
83
+ category: 'Custom',
84
+ icon: 'credit-card',
85
+ defaultProps: {
86
+ title: 'Card Title',
87
+ body: 'Card description content.'
88
+ },
89
+ traits: [
90
+ {
91
+ name: 'title',
92
+ label: 'Title',
93
+ type: 'text'
94
+ },
95
+ {
96
+ name: 'body',
97
+ label: 'Body Text',
98
+ type: 'textarea'
99
+ }
100
+ ]
101
+ };
102
+
103
+ componentRegistry.register(customCardDef);
104
+ ```
105
+
106
+ ---
107
+
108
+ ## 📄 License
109
+
110
+ MIT © [KUBUILD](https://github.com/kustora/kubuild)
package/dist/blocks.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,iBAAiB,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,KAAK,IAAI,CAAC;CACpE;AAOD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,eAAe,EAigB3C,CAAC"}
1
+ {"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../src/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,iBAAiB,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,KAAK,IAAI,CAAC;CACpE;AAOD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,eAAe,EA+uC3C,CAAC"}
package/dist/definitions.d.ts CHANGED
@@ -26,7 +26,12 @@ export declare const inputDefinition: ComponentDefinition;
26
26
  export declare const textareaDefinition: ComponentDefinition;
27
27
  export declare const selectDefinition: ComponentDefinition;
28
28
  export declare const checkboxDefinition: ComponentDefinition;
29
+ export declare const switchDefinition: ComponentDefinition;
30
+ export declare const radioGroupDefinition: ComponentDefinition;
29
31
  export declare const radioDefinition: ComponentDefinition;
32
+ export declare const radioItemDefinition: ComponentDefinition;
33
+ export declare const fileUploadDefinition: ComponentDefinition;
34
+ export declare const buttonSubmitDefinition: ComponentDefinition;
30
35
  export declare const coreComponentDefinitions: ComponentDefinition[];
31
36
  export declare function createDefaultComponentRegistry(): ComponentRegistry;
32
37
  //# sourceMappingURL=definitions.d.ts.map
package/dist/definitions.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAqEpE,eAAO,MAAM,cAAc,EAAE,mBAc5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBA8B/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBA0BjC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBA0B/B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBAwC/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBA4B5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAgD7B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,mBAsF9B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBAkBlC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmE5B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAqDhC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBA0CjC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmE5B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBA8DlC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBA6D7B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAqDjC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAoG7B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmD5B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAkCjC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAyD7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAmBhC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAiFjC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBA4G5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAuG7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBA6EhC,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,mBAgF9B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAiEhC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAiE7B,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,mBAAmB,EA6BzD,CAAC;AAEF,wBAAgB,8BAA8B,IAAI,iBAAiB,CAMlE"}
1
+ {"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../src/definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAmGpE,eAAO,MAAM,cAAc,EAAE,mBAc5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBA8B/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBA0BjC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBA0B/B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,mBAwC/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBA4B5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAgD7B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,mBAsF9B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBAkBlC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmE5B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAqDhC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBA0CjC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmE5B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBA8DlC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBA6D7B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAqDjC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAoG7B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBAmD5B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAkCjC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAyD7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAmBhC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAiFjC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,mBA8H5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBA+I7B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBAqHhC,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,mBAuF9B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,mBA8EhC,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,mBA2F9B,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBAgFlC,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,mBAwE7B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,mBAIjC,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,mBAoFlC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,mBA8GpC,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,mBAAmB,EAkCzD,CAAC;AAEF,wBAAgB,8BAA8B,IAAI,iBAAiB,CAMlE"}