@kabel-project/kabel 1.0.7

package/docs/interfaces/KabelNodeRendering.md

@@ -0,0 +1,77 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / KabelNodeRendering
+
+# Interface: KabelNodeRendering
+
+Defined in: [src/types.ts:68](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L68)
+
+Node rendering utilities and classes.
+
+## Properties
+
+### Apollo
+
+> **Apollo**: `__module`
+
+Defined in: [src/types.ts:72](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L72)
+
+***
+
+### Atlas
+
+> **Atlas**: `__module`
+
+Defined in: [src/types.ts:73](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L73)
+
+***
+
+### Renderer
+
+> **Renderer**: *typeof* [`Renderer`](../classes/Renderer.md)
+
+Defined in: [src/types.ts:76](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L76)
+
+Node renderer class.
+
+***
+
+### RendererConstants
+
+> **RendererConstants**: *typeof* [`RendererConstants`](../classes/RendererConstants.md)
+
+Defined in: [src/types.ts:79](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L79)
+
+Constant class to be instantiated and used in node rendering.
+
+***
+
+### rendererMap
+
+> **rendererMap**: *typeof* `RMap`
+
+Defined in: [src/types.ts:70](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L70)
+
+Map of registered node renderers.
+
+***
+
+### Representer
+
+> **Representer**: *typeof* [`Representer`](../classes/Representer.md)
+
+Defined in: [src/types.ts:83](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L83)
+
+used by the renderer to create RepresenterNodes for each rendered node. (node.svg API is provided by this)
+
+***
+
+### RepresenterNode
+
+> **RepresenterNode**: *typeof* [`RepresenterNode`](../classes/RepresenterNode.md)
+
+Defined in: [src/types.ts:87](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L87)
+
+Class behind node.svg API. Represents a renderer's DrawState.

package/docs/interfaces/KabelUIX.md

@@ -0,0 +1,105 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / KabelUIX
+
+# Interface: KabelUIX
+
+Defined in: [src/types.ts:9](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L9)
+
+Represents the UIX (UI experience utilities) portion of Kabel.
+
+## Properties
+
+### events
+
+> **events**: [`Eventer`](../classes/Eventer.md)
+
+Defined in: [src/types.ts:13](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L13)
+
+Event system for SVG.js elements, allowing reusable functionality and event handling.
+
+***
+
+### FontManager
+
+> **FontManager**: `__module`
+
+Defined in: [src/types.ts:15](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L15)
+
+handles loading fonts from Google fonts and possibly other CDNs in the future.
+
+***
+
+### userState
+
+> **userState**: `UserState`
+
+Defined in: [src/types.ts:19](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L19)
+
+Stores the current state of the user.
+
+***
+
+### windowListeners
+
+> **windowListeners**: `object`
+
+Defined in: [src/types.ts:24](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L24)
+
+window listener system.
+
+#### addWindowListener()
+
+> **addWindowListener**: (`type`, `fn`) => `void`
+
+##### Parameters
+
+###### type
+
+`WindowEventKeys`
+
+###### fn
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### clearWindowListeners()
+
+> **clearWindowListeners**: (`type?`) => `void`
+
+##### Parameters
+
+###### type?
+
+`WindowEventKeys`
+
+##### Returns
+
+`void`
+
+#### removeWindowListener()
+
+> **removeWindowListener**: (`type`, `fn`) => `void`
+
+##### Parameters
+
+###### type
+
+`WindowEventKeys`
+
+###### fn
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### windowListeners
+
+> **windowListeners**: `WindowListenersMap`

package/docs/interfaces/KabelUtils.md

@@ -0,0 +1,215 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / KabelUtils
+
+# Interface: KabelUtils
+
+Defined in: [src/types.ts:30](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L30)
+
+Utility functions and classes provided by Kabel.
+
+## Properties
+
+### escapeHTML()
+
+> **escapeHTML**: (`s`) => `string`
+
+Defined in: [src/types.ts:59](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L59)
+
+Escapes HTML for safe insertion into the DOM.
+
+Escapes special characters in a string to their corresponding HTML entities.
+
+Specifically, it replaces:
+- `&` with `&`
+- `'` with `'`
+- `"` with `"`
+- `<` with `&lt;`
+- `>` with `&gt;`
+
+#### Parameters
+
+##### s
+
+`string`
+
+The string to escape.
+
+#### Returns
+
+`string`
+
+The escaped string with special characters replaced by HTML entities.
+
+***
+
+### EventEmitter
+
+> **EventEmitter**: *typeof* `EventEmitter`
+
+Defined in: [src/types.ts:47](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L47)
+
+Event emitter class for custom events.
+
+***
+
+### hasProp()
+
+> **hasProp**: (`obj`, `name`) => `boolean`
+
+Defined in: [src/types.ts:50](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L50)
+
+Checks if an object has a property.
+
+#### Parameters
+
+##### obj
+
+`object`
+
+##### name
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### parseColor()
+
+> **parseColor**: (`color`) => `` `#${string}` ``
+
+Defined in: [src/types.ts:41](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L41)
+
+Parses a color string into an internal format.
+
+Parse any Color type into a hex string "#RRGGBB"
+
+#### Parameters
+
+##### color
+
+[`Color`](../type-aliases/Color.md)
+
+#### Returns
+
+`` `#${string}` ``
+
+***
+
+### Path
+
+> **Path**: `__module`
+
+Defined in: [src/types.ts:32](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L32)
+
+Path manipulation utilities.
+
+***
+
+### styler
+
+> **styler**: `Styler`
+
+Defined in: [src/types.ts:53](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L53)
+
+Styler helper functions.
+
+***
+
+### Styler
+
+> **Styler**: *typeof* `Styler`
+
+Defined in: [src/types.ts:56](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L56)
+
+Styler class for managing styles.
+
+***
+
+### SVG
+
+> **SVG**: `__module`
+
+Defined in: [src/types.ts:38](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L38)
+
+SVG utilities.
+
+***
+
+### UID
+
+> **UID**: `__module`
+
+Defined in: [src/types.ts:44](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L44)
+
+Unique ID generation utilities.
+
+***
+
+### unescapeHTML()
+
+> **unescapeHTML**: (`s`) => `string`
+
+Defined in: [src/types.ts:62](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L62)
+
+Unescapes HTML strings back to their original form.
+
+Converts HTML-escaped characters in a string back to their literal form.
+
+Specifically, it replaces:
+- `&lt;` with `<`
+- `&gt;` with `>`
+- `&quot;` with `"`
+- `&apos;` with `'`
+- `&amp;` with `&`
+
+#### Parameters
+
+##### s
+
+`string`
+
+The string containing HTML-escaped characters.
+
+#### Returns
+
+`string`
+
+The unescaped string with HTML entities replaced by their literal characters.
+
+***
+
+### waitFrames()
+
+> **waitFrames**: (`frames`, `callback`) => `void`
+
+Defined in: [src/types.ts:35](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/types.ts#L35)
+
+Wait for a number of animation frames.
+
+Delays execution of a callback by a specified number of animation frames.
+
+Uses `requestAnimationFrame` to count frames, then calls the provided callback.
+
+#### Parameters
+
+##### frames
+
+`number`
+
+The number of animation frames to wait before executing the callback.
+
+##### callback
+
+() => `void`
+
+The function to execute after the specified frames have passed.
+
+#### Returns
+
+`void`

package/docs/interfaces/NodeEvents.md

@@ -0,0 +1,42 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / NodeEvents
+
+# Interface: NodeEvents
+
+Defined in: [src/nodesvg.ts:134](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L134)
+
+Events emitted by NodeSvg instances.
+Consumers can listen to these events to react to node lifecycle changes.
+
+## Properties
+
+### INITING
+
+> **INITING**: `null`
+
+Defined in: [src/nodesvg.ts:139](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L139)
+
+Triggered immediately after node initialization
+
+***
+
+### NODE\_DRAG
+
+> **NODE\_DRAG**: `null`
+
+Defined in: [src/nodesvg.ts:142](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L142)
+
+Triggered while the node is being dragged
+
+***
+
+### REMOVING
+
+> **REMOVING**: `null`
+
+Defined in: [src/nodesvg.ts:136](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L136)
+
+Triggered before the node is removed from the workspace

package/docs/interfaces/NodeJson.md

@@ -0,0 +1,104 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / NodeJson
+
+# Interface: NodeJson
+
+Defined in: [src/nodesvg.ts:42](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L42)
+
+Represents a JSON structure for initializing a NodeSvg instance.
+Includes colors, connections, label, fields, category, and type information.
+
+## Properties
+
+### arguments?
+
+> `optional` **arguments**: [`InputFieldJson`](InputFieldJson.md)[]
+
+Defined in: [src/nodesvg.ts:68](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L68)
+
+Array of field definitions (InputFieldJson) to attach to this node
+
+***
+
+### category?
+
+> `optional` **category**: `string`
+
+Defined in: [src/nodesvg.ts:71](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L71)
+
+Optional category name for color theming
+
+***
+
+### labelText?
+
+> `optional` **labelText**: `string`
+
+Defined in: [src/nodesvg.ts:65](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L65)
+
+Optional node label text to display
+
+***
+
+### nextConnection?
+
+> `optional` **nextConnection**: `any`
+
+Defined in: [src/nodesvg.ts:62](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L62)
+
+Optional next connection data.
+Presence triggers creation of a next connection when initializing NodeSvg.
+
+***
+
+### previousConnection?
+
+> `optional` **previousConnection**: `any`
+
+Defined in: [src/nodesvg.ts:56](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L56)
+
+Optional previous connection data.
+Presence triggers creation of a previous connection when initializing NodeSvg.
+
+***
+
+### primaryColor?
+
+> `optional` **primaryColor**: [`Color`](../type-aliases/Color.md)
+
+Defined in: [src/nodesvg.ts:44](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L44)
+
+Primary color of the node (e.g., top bar, main connections)
+
+***
+
+### secondaryColor?
+
+> `optional` **secondaryColor**: [`Color`](../type-aliases/Color.md)
+
+Defined in: [src/nodesvg.ts:47](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L47)
+
+Secondary color of the node (e.g., field backgrounds)
+
+***
+
+### tertiaryColor?
+
+> `optional` **tertiaryColor**: [`Color`](../type-aliases/Color.md)
+
+Defined in: [src/nodesvg.ts:50](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L50)
+
+Tertiary color of the node (e.g., outlines)
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [src/nodesvg.ts:74](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L74)
+
+Node type identifier, used to look up the NodePrototype

package/docs/interfaces/NodePrototype.md

@@ -0,0 +1,82 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / NodePrototype
+
+# Interface: NodePrototype
+
+Defined in: [src/node-types.ts:7](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/node-types.ts#L7)
+
+Represents a prototype definition for a NodeSvg.
+Prototypes define behavior for initialization and removal of nodes.
+
+## Properties
+
+### init()
+
+> **init**: (`this`, `prototype`, `block`) => `void`
+
+Defined in: [src/node-types.ts:16](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/node-types.ts#L16)
+
+Called when a node is initialized.
+Use this to set up fields, connections, or any runtime state for the node.
+
+#### Parameters
+
+##### this
+
+[`NodeSvg`](../classes/NodeSvg.md)
+
+The NodeSvg instance being initialized
+
+##### prototype
+
+`NodePrototype`
+
+The prototype object itself
+
+##### block
+
+[`NodeSvg`](../classes/NodeSvg.md)
+
+The NodeSvg instance (same as `this`) for convenience
+
+#### Returns
+
+`void`
+
+***
+
+### removed()
+
+> **removed**: (`this`, `prototype`, `block`) => `void`
+
+Defined in: [src/node-types.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/node-types.ts#L26)
+
+Called when a node is being removed from the workspace.
+Use this to clean up references, event listeners, or related resources.
+
+#### Parameters
+
+##### this
+
+[`NodeSvg`](../classes/NodeSvg.md)
+
+The NodeSvg instance being removed
+
+##### prototype
+
+`NodePrototype`
+
+The prototype object itself
+
+##### block
+
+[`NodeSvg`](../classes/NodeSvg.md)
+
+The NodeSvg instance (same as `this`) for convenience
+
+#### Returns
+
+`void`

package/docs/interfaces/RegisteredEl.md

@@ -0,0 +1,53 @@
+[**Kabel Project Docs v1.0.6**](../README.md)
+
+***
+
+[Kabel Project Docs](../globals.md) / RegisteredEl
+
+# Interface: RegisteredEl
+
+Defined in: [util/eventer.ts:7](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L7)
+
+## Properties
+
+### args?
+
+> `optional` **args**: [`EventArgs`](../type-aliases/EventArgs.md)
+
+Defined in: [util/eventer.ts:11](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L11)
+
+***
+
+### destroyFn()?
+
+> `optional` **destroyFn**: () => `void`
+
+Defined in: [util/eventer.ts:12](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L12)
+
+#### Returns
+
+`void`
+
+***
+
+### el
+
+> **el**: `Element`
+
+Defined in: [util/eventer.ts:9](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L9)
+
+***
+
+### tags
+
+> **tags**: `string`[]
+
+Defined in: [util/eventer.ts:8](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L8)
+
+***
+
+### type
+
+> **type**: `string`
+
+Defined in: [util/eventer.ts:10](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L10)