@koppajs/koppajs-core 3.0.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.
- package/CHANGELOG.md +153 -0
- package/LICENSE +201 -0
- package/README.md +152 -0
- package/dist/component.d.ts +29 -0
- package/dist/compose.d.ts +11 -0
- package/dist/event-handler.d.ts +40 -0
- package/dist/global-event-cleaner.d.ts +28 -0
- package/dist/globals.d.ts +82 -0
- package/dist/index.cjs.js +19 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.d.ts +35 -0
- package/dist/index.es.js +1603 -0
- package/dist/index.es.js.map +1 -0
- package/dist/kpa.d.ts +4 -0
- package/dist/model.d.ts +40 -0
- package/dist/template-processor.d.ts +17 -0
- package/dist/types.d.ts +364 -0
- package/dist/utils/dom.d.ts +3 -0
- package/dist/utils/extend.d.ts +9 -0
- package/dist/utils/extension-registry.d.ts +10 -0
- package/dist/utils/helper.d.ts +55 -0
- package/dist/utils/hook-registry.d.ts +34 -0
- package/dist/utils/identity.d.ts +6 -0
- package/dist/utils/index.d.ts +15 -0
- package/dist/utils/logger.d.ts +87 -0
- package/dist/utils/object.d.ts +3 -0
- package/dist/utils/reconcile.d.ts +23 -0
- package/dist/utils/script.d.ts +18 -0
- package/dist/utils/string.d.ts +18 -0
- package/dist/utils/template-watch.d.ts +7 -0
- package/dist/utils/type-guards.d.ts +82 -0
- package/package.json +107 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# Change Log
|
|
2
|
+
|
|
3
|
+
All notable changes to **@koppajs/koppajs-core** are documented in this file.
|
|
4
|
+
|
|
5
|
+
This project uses a **manual, tag-driven release process**.
|
|
6
|
+
Only tagged versions represent official releases.
|
|
7
|
+
|
|
8
|
+
This changelog documents **intentional milestones and guarantees**,
|
|
9
|
+
not every internal refactor.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## [Unreleased]
|
|
14
|
+
|
|
15
|
+
This section is intentionally empty.
|
|
16
|
+
|
|
17
|
+
Changes will only appear here when they:
|
|
18
|
+
|
|
19
|
+
- affect runtime behavior,
|
|
20
|
+
- change documented guarantees,
|
|
21
|
+
- or modify the public API surface.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## [3.0.0] — Baseline Runtime Release
|
|
26
|
+
|
|
27
|
+
**2026-03-01**
|
|
28
|
+
|
|
29
|
+
This release establishes the **stable runtime foundation of KoppaJS**.
|
|
30
|
+
|
|
31
|
+
It defines the final component model, lifecycle semantics, reactivity rules,
|
|
32
|
+
and architectural boundaries that KoppaJS is built upon.
|
|
33
|
+
|
|
34
|
+
From this version onward, the core runtime is considered **intentionally
|
|
35
|
+
defined and stable**, with changes happening only through explicit,
|
|
36
|
+
well-justified releases.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
### Architecture
|
|
41
|
+
|
|
42
|
+
- Fully **class-free, factory-free, and virtual-DOM-free** runtime design
|
|
43
|
+
- Component system built directly on **native Web Components**
|
|
44
|
+
- No hidden lifecycle phases or implicit execution paths
|
|
45
|
+
- Clear separation of responsibilities across runtime modules
|
|
46
|
+
- Explicit teardown and cleanup semantics
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
### Component Model & Lifecycle
|
|
51
|
+
|
|
52
|
+
- Deterministic lifecycle with explicit hooks:
|
|
53
|
+
- `created`
|
|
54
|
+
- `processed`
|
|
55
|
+
- `beforeMount`
|
|
56
|
+
- `mounted`
|
|
57
|
+
- `beforeUpdate`
|
|
58
|
+
- `updated`
|
|
59
|
+
- `beforeDestroy`
|
|
60
|
+
- `destroyed`
|
|
61
|
+
- No implicit lifecycle execution
|
|
62
|
+
- Guaranteed cleanup of:
|
|
63
|
+
- watchers
|
|
64
|
+
- reactive effects
|
|
65
|
+
- event listeners
|
|
66
|
+
- Predictable registration and destruction flow
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
### Reactivity & Data Flow
|
|
71
|
+
|
|
72
|
+
- Proxy-based reactive state model
|
|
73
|
+
- Referential prop binding (`:prop="state.value"`)
|
|
74
|
+
- Parent and child share the same reference
|
|
75
|
+
- Updates propagate through explicit observation
|
|
76
|
+
- No deep or implicit reactivity magic
|
|
77
|
+
- Rendering is triggered only by intentional, observable state changes
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
### Template & Rendering
|
|
82
|
+
|
|
83
|
+
- Inline template directives:
|
|
84
|
+
- `loop`
|
|
85
|
+
- `if` / `else`
|
|
86
|
+
- `ref`
|
|
87
|
+
- `slot`
|
|
88
|
+
- Text and attribute interpolation via `{{ expression }}`
|
|
89
|
+
- Declarative slot system for composition
|
|
90
|
+
- Direct DOM reconciliation (no virtual DOM diffing)
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
### Event System
|
|
95
|
+
|
|
96
|
+
- Custom event handling with:
|
|
97
|
+
- bubbling support
|
|
98
|
+
- scoped delegation
|
|
99
|
+
- Automatic listener cleanup on component destruction
|
|
100
|
+
- No global event leakage
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
### Typing & Contracts
|
|
105
|
+
|
|
106
|
+
- Strong typing throughout the runtime
|
|
107
|
+
- `satisfies`-based validation for internal structures
|
|
108
|
+
- Dedicated TypeScript configuration for public type generation
|
|
109
|
+
- Global type declarations (`globals.d.ts`, `kpa.d.ts`) intentionally provided
|
|
110
|
+
for editor integration and DX
|
|
111
|
+
- Clear separation between public API contracts and internal implementation types
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
### Tooling & Quality
|
|
116
|
+
|
|
117
|
+
- pnpm-based project setup
|
|
118
|
+
- Deterministic dependency resolution via committed lockfile
|
|
119
|
+
- Vite-based build pipeline:
|
|
120
|
+
- typecheck
|
|
121
|
+
- bundle
|
|
122
|
+
- type generation
|
|
123
|
+
- ESLint (flat config) and Prettier enforced
|
|
124
|
+
- Vitest test suite following the **KoppaJS “Three Test Rule”**
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
### Guarantees
|
|
129
|
+
|
|
130
|
+
Starting with `3.0.0`, the following guarantees apply:
|
|
131
|
+
|
|
132
|
+
- **Explicit runtime behavior**
|
|
133
|
+
- **No hidden global state**
|
|
134
|
+
- **Deterministic lifecycle execution**
|
|
135
|
+
- **Predictable reactivity and rendering**
|
|
136
|
+
- **Stability over feature velocity**
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
### Non-Goals
|
|
141
|
+
|
|
142
|
+
- No virtual DOM
|
|
143
|
+
- No implicit runtime magic
|
|
144
|
+
- No auto-registration side effects
|
|
145
|
+
- No framework-level convenience abstractions
|
|
146
|
+
- No hidden global mutations
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## [0.0.0] — Initial Development Phase
|
|
151
|
+
|
|
152
|
+
Experimental and exploratory development phase.
|
|
153
|
+
No stability or API guarantees.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Bastian Bensch
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
<a id="readme-top"></a>
|
|
2
|
+
|
|
3
|
+
<!-- PROJECT LOGO -->
|
|
4
|
+
<div align="center">
|
|
5
|
+
<img src="https://public-assets-1b57ca06-687a-4142-a525-0635f7649a5c.s3.eu-central-1.amazonaws.com/koppajs/koppajs-logo-text-900x226.png" width="500" alt="KoppaJS Logo">
|
|
6
|
+
</div>
|
|
7
|
+
|
|
8
|
+
<br>
|
|
9
|
+
|
|
10
|
+
<!-- PROJECT SHIELDS -->
|
|
11
|
+
<div align="center">
|
|
12
|
+
<a href="https://www.npmjs.com/package/@koppajs/koppajs-core"><img src="https://img.shields.io/npm/v/@koppajs/koppajs-core?style=flat-square" alt="npm version"></a> <a href="https://github.com/koppajs/koppajs-core/actions"><img src="https://img.shields.io/github/actions/workflow/status/koppajs/koppajs-core/ci.yml?branch=main&style=flat-square" alt="CI Status"></a> <a href="https://bundlephobia.com/package/@koppajs/koppajs-core"><img src="https://img.shields.io/bundlephobia/minzip/@koppajs/koppajs-core?style=flat-square" alt="Bundle size"></a> <a href="./LICENSE"><img src="https://img.shields.io/github/license/koppajs/koppajs-core?style=flat-square" alt="License"></a>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
<br>
|
|
16
|
+
|
|
17
|
+
<!-- ELEVATOR PITCH -->
|
|
18
|
+
<div align="center">
|
|
19
|
+
<h1 align="center">KoppaJS – Pragmatic frontend made modular</h1>
|
|
20
|
+
<h3 align="center">Build fast, simple, and growable – without the noise of modern frameworks.</h3>
|
|
21
|
+
<p align="center">
|
|
22
|
+
<i align="center">A quiet rebellion against complexity – and a wish that building can still feel good.</i>
|
|
23
|
+
</p>
|
|
24
|
+
</div>
|
|
25
|
+
|
|
26
|
+
<br>
|
|
27
|
+
|
|
28
|
+
<!-- IMPORTANT LINKS -->
|
|
29
|
+
<div align="center">
|
|
30
|
+
<p align="center">
|
|
31
|
+
<a href="https://github.com/koppajs/koppajs-documentation">Documentation</a>
|
|
32
|
+
·
|
|
33
|
+
<a href="https://github.com/koppajs/koppajs-example">Example Project</a>
|
|
34
|
+
·
|
|
35
|
+
<a href="https://github.com/koppajs/koppajs-core/issues">Issues</a>
|
|
36
|
+
</p>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<br>
|
|
40
|
+
|
|
41
|
+
<!-- TABLE OF CONTENTS -->
|
|
42
|
+
<details>
|
|
43
|
+
<summary>Table of Contents</summary>
|
|
44
|
+
<ol>
|
|
45
|
+
<li><a href="#what-is-koppajs">What is KoppaJS?</a></li>
|
|
46
|
+
<li><a href="#features">Features</a></li>
|
|
47
|
+
<li><a href="#getting-started">Getting Started</a></li>
|
|
48
|
+
<li><a href="#roadmap">Roadmap</a></li>
|
|
49
|
+
<li><a href="#support">Support</a></li>
|
|
50
|
+
<li><a href="#community--contribution">Community & Contribution</a></li>
|
|
51
|
+
</ol>
|
|
52
|
+
</details>
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## What is KoppaJS?
|
|
57
|
+
|
|
58
|
+
KoppaJS is a lightweight, modular frontend framework designed to simplify development without sacrificing flexibility. It provides a pragmatic approach to building modern web applications, focusing on:
|
|
59
|
+
|
|
60
|
+
- **Simplicity:** Minimal boilerplate and intuitive APIs.
|
|
61
|
+
- **Performance:** Optimized for speed and scalability.
|
|
62
|
+
- **Modularity:** Build only what you need, when you need it.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Features
|
|
67
|
+
|
|
68
|
+
- **Declarative Components:** Define components with `.kpa` files.
|
|
69
|
+
- **Reactive State Management:** Built-in reactivity for seamless updates.
|
|
70
|
+
- **Lifecycle Hooks:** Control component behavior with hooks like `mounted`, `updated`, and `beforeUpdate`.
|
|
71
|
+
- **Integration-Friendly:** Works with existing tools and libraries.
|
|
72
|
+
- **TypeScript Support:** First-class TypeScript support for safer, more maintainable code.
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Getting Started
|
|
77
|
+
|
|
78
|
+
The fastest way to start a new KoppaJS project:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
pnpm create koppajs my-app
|
|
82
|
+
cd my-app
|
|
83
|
+
pnpm install
|
|
84
|
+
pnpm dev
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
This scaffolds a ready-to-run project with Vite, TypeScript, and two sample components.
|
|
88
|
+
|
|
89
|
+
You can also use npm or npx:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npm create koppajs my-app
|
|
93
|
+
npx create-koppajs my-app
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Manual Setup
|
|
97
|
+
|
|
98
|
+
If you prefer to add KoppaJS to an existing project:
|
|
99
|
+
|
|
100
|
+
1. **Install the core library and Vite plugin:**
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
pnpm add @koppajs/koppajs-core
|
|
104
|
+
pnpm add -D @koppajs/koppajs-vite-plugin
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
2. **Create your first component:**
|
|
108
|
+
|
|
109
|
+
```typescript
|
|
110
|
+
import { Core } from '@koppajs/koppajs-core'
|
|
111
|
+
|
|
112
|
+
Core.take(
|
|
113
|
+
{
|
|
114
|
+
state: { count: 0 },
|
|
115
|
+
methods: {
|
|
116
|
+
increment() {
|
|
117
|
+
this.state.count++
|
|
118
|
+
},
|
|
119
|
+
},
|
|
120
|
+
},
|
|
121
|
+
'counter',
|
|
122
|
+
)
|
|
123
|
+
|
|
124
|
+
Core()
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
3. **Run your application:**
|
|
128
|
+
Use the KoppaJS Vite plugin to build and serve your app.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Roadmap
|
|
133
|
+
|
|
134
|
+
- 🌐 **Official Website** — koppajs.org with documentation, guides, and examples
|
|
135
|
+
- 🔌 **Official Plugins**
|
|
136
|
+
- Router
|
|
137
|
+
- Script Loader
|
|
138
|
+
- DSGVO / Cookie Consent Banner
|
|
139
|
+
- 🧩 **Ecosystem Growth** — Community plugins, starter templates, and integrations
|
|
140
|
+
- 💻 **VS Code Extension** — Syntax highlighting, IntelliSense, and tooling for `.kpa` files
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Support
|
|
145
|
+
|
|
146
|
+
For support, visit our [GitHub Issues](https://github.com/koppajs/koppajs-core/issues).
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## Community & Contribution
|
|
151
|
+
|
|
152
|
+
We welcome contributions! Check out our [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { type ComponentSource, type Props } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Processes slot elements in component template.
|
|
4
|
+
* Replaces <slot> elements with content from host element.
|
|
5
|
+
* @param container - Template fragment containing slot elements
|
|
6
|
+
* @param host - Host element containing slot content
|
|
7
|
+
*/
|
|
8
|
+
export declare function processSlots({ container, host, }: {
|
|
9
|
+
container: DocumentFragment;
|
|
10
|
+
host: HTMLElement;
|
|
11
|
+
}): void;
|
|
12
|
+
/**
|
|
13
|
+
* Validates a prop value against its definition.
|
|
14
|
+
* @param propName - Name of the prop
|
|
15
|
+
* @param propValue - Value to validate
|
|
16
|
+
* @param props - Props definition object
|
|
17
|
+
* @returns True if prop is valid, false otherwise
|
|
18
|
+
*/
|
|
19
|
+
export declare function validateProp({ propName, propValue, props, }: {
|
|
20
|
+
propName: string;
|
|
21
|
+
propValue: unknown;
|
|
22
|
+
props: Props;
|
|
23
|
+
}): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Registers a component with the custom elements registry.
|
|
26
|
+
* @param componentName - Custom element tag name
|
|
27
|
+
* @param source - Component source with template, script, and style
|
|
28
|
+
*/
|
|
29
|
+
export declare function registerComponent(componentName: string, source: ComponentSource): void;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ComposeOptions } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Composes multiple objects into a single Proxy that delegates property access.
|
|
4
|
+
* Properties are read from the first layer that contains them.
|
|
5
|
+
* Writes go to the layer where the property exists, or to defaultWriteIndex if not found.
|
|
6
|
+
* @param layers - Array of objects to compose
|
|
7
|
+
* @param options - Composition options
|
|
8
|
+
* @returns Proxy object that combines all layers
|
|
9
|
+
* @throws Error if layers is empty or contains invalid objects
|
|
10
|
+
*/
|
|
11
|
+
export declare function composeBySource<T extends object[]>(layers: T, options?: ComposeOptions): T[number];
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { State, Events, Refs, Methods } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Sets up custom event listeners for component events.
|
|
4
|
+
* Handles window events, selector-based events, and ref-based events.
|
|
5
|
+
* Returns a cleanup function that removes all listeners added by this call.
|
|
6
|
+
* @param userContext - User context to bind handlers to
|
|
7
|
+
* @param events - Array of event definitions
|
|
8
|
+
* @param container - Document fragment to query selectors from
|
|
9
|
+
* @param refs - Component element references
|
|
10
|
+
* @returns Cleanup function that removes all listeners added by this call
|
|
11
|
+
*/
|
|
12
|
+
export declare function setupEvents(userContext: State, events: Events, container: DocumentFragment, refs: Refs): () => void;
|
|
13
|
+
/**
|
|
14
|
+
* Binds native DOM event handlers from element attributes (e.g., onclick, oninput).
|
|
15
|
+
* Walks all elements once instead of querying per event type for better performance.
|
|
16
|
+
* Handlers are retrieved from userContext and assumed to be already bound (for options type).
|
|
17
|
+
* @param userContext - User context containing event handlers
|
|
18
|
+
* @param fragment - Document fragment to process
|
|
19
|
+
*/
|
|
20
|
+
export declare function bindNativeEvents(userContext: State, fragment: DocumentFragment): void;
|
|
21
|
+
/**
|
|
22
|
+
* Binds native DOM event handlers for composite component type.
|
|
23
|
+
* Walks all elements once instead of querying per event type for better performance.
|
|
24
|
+
* Handlers are retrieved directly from methods object without binding.
|
|
25
|
+
* @param methods - Methods object containing event handlers
|
|
26
|
+
* @param fragment - Document fragment to process
|
|
27
|
+
*/
|
|
28
|
+
export declare function bindNativeEventsForComposite(methods: Methods, fragment: DocumentFragment): void;
|
|
29
|
+
/**
|
|
30
|
+
* Sets up custom event listeners for composite component type.
|
|
31
|
+
* Handlers are bound to state using bindOnce.
|
|
32
|
+
* Returns a cleanup function that removes all listeners added by this call.
|
|
33
|
+
* @param methods - Methods object (unused, kept for signature consistency)
|
|
34
|
+
* @param state - Component state to bind handlers to
|
|
35
|
+
* @param events - Array of event definitions
|
|
36
|
+
* @param container - Document fragment to query selectors from
|
|
37
|
+
* @param refs - Component element references
|
|
38
|
+
* @returns Cleanup function that removes all listeners added by this call
|
|
39
|
+
*/
|
|
40
|
+
export declare function setupEventsForComposite(methods: Methods, state: State, events: Events, container: DocumentFragment, refs: Refs): () => void;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Patches EventTarget.prototype.addEventListener/removeEventListener
|
|
3
|
+
* to globally track registered listeners.
|
|
4
|
+
*
|
|
5
|
+
* This only runs when EventTarget exists (browser/JSDOM).
|
|
6
|
+
* In Node/SSR it is a safe no-op.
|
|
7
|
+
*/
|
|
8
|
+
export declare function patchGlobalEventTracking(): void;
|
|
9
|
+
/**
|
|
10
|
+
* Removes all listeners registered on a specific EventTarget.
|
|
11
|
+
*/
|
|
12
|
+
export declare function cleanupAllEventListeners(target: EventTarget): void;
|
|
13
|
+
/**
|
|
14
|
+
* Recursively cleans up all event listeners in a DOM subtree.
|
|
15
|
+
* This is only active in environments where DOM APIs exist.
|
|
16
|
+
*/
|
|
17
|
+
export declare function cleanupSubtree(root: Node): void;
|
|
18
|
+
/**
|
|
19
|
+
* Starts a global MutationObserver that automatically cleans up
|
|
20
|
+
* event listeners from removed DOM elements.
|
|
21
|
+
*
|
|
22
|
+
* In SSR/Node environments this function is a safe no-op.
|
|
23
|
+
*/
|
|
24
|
+
export declare function startGlobalDisconnectionObserver(): void;
|
|
25
|
+
/**
|
|
26
|
+
* Stops the global observer (useful in tests).
|
|
27
|
+
*/
|
|
28
|
+
export declare function stopGlobalDisconnectionObserver(): void;
|