@pyreon/core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Vit Bokisch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+# @pyreon/core
+
+Core component model, VNode types, lifecycle hooks, and control-flow components for Pyreon.
+
+## Install
+
+```bash
+bun add @pyreon/core
+```
+
+## Quick Start
+
+```ts
+import { h, Fragment, onMount, onUnmount, createContext, useContext } from "@pyreon/core"
+
+function Counter() {
+  onMount(() => {
+    console.log("mounted")
+    return undefined
+  })
+
+  return h("div", null, "Hello Pyreon")
+}
+```
+
+## API
+
+### VNode Creation
+
+- **`h<P>(type, props, ...children): VNode`** -- Creates a virtual node. Accepts element tags, component functions, or Fragment.
+- **`Fragment`** -- Groups children without adding a wrapper DOM element.
+- **`EMPTY_PROPS`** -- Shared empty props object.
+
+### Components
+
+- **`defineComponent(fn)`** -- Wraps a function as a named component.
+- **`runWithHooks(instance, fn)`** -- Executes a function within a component's hook context.
+- **`propagateError(error, instance)`** -- Propagates an error up the component tree.
+- **`dispatchToErrorBoundary(error, instance)`** -- Sends an error to the nearest ErrorBoundary.
+
+### Lifecycle Hooks
+
+- **`onMount(fn: () => CleanupFn | undefined)`** -- Runs after the component mounts. Return a cleanup function or `undefined`.
+- **`onUnmount(fn)`** -- Runs when the component is removed.
+- **`onUpdate(fn)`** -- Runs after each reactive update.
+- **`onErrorCaptured(fn)`** -- Captures errors thrown by descendant components.
+
+### Context
+
+- **`createContext<T>(defaultValue?): Context<T>`** -- Creates a context with an optional default.
+- **`useContext(ctx): T`** -- Reads the nearest provided context value.
+- **`withContext(ctx, value, fn)`** -- Runs `fn` with the given context value.
+- **`pushContext(map)` / `popContext()`** -- Low-level context stack manipulation.
+
+### Refs
+
+- **`createRef<T>(): Ref<T>`** -- Creates a mutable ref object.
+
+### Control-Flow Components
+
+- **`Show`** -- Conditionally renders children based on a `when` prop.
+- **`Switch` / `Match`** -- Multi-branch conditional rendering.
+- **`For`** -- Keyed list rendering with efficient reconciliation.
+- **`Portal`** -- Renders children into a different DOM container.
+- **`Suspense`** -- Shows fallback content while async children resolve.
+- **`ErrorBoundary`** -- Catches errors in descendant components and renders a fallback.
+
+### Utilities
+
+- **`mapArray(source, mapFn)`** -- Reactively maps over an array source.
+- **`registerErrorHandler(handler)` / `reportError(error, context)`** -- Global error telemetry.
+
+### Types
+
+`VNode`, `VNodeChild`, `VNodeChildAtom`, `Props`, `ComponentFn`, `ComponentInstance`, `LifecycleHooks`, `CleanupFn`, `NativeItem`, `Ref`, `Context`, `LazyComponent`, `ShowProps`, `SwitchProps`, `MatchProps`, `ForProps`, `PortalProps`, `ErrorContext`, `ErrorHandler`
+
+## License
+
+MIT