steel-frame 5.0.1 → 5.1.0

package/README.md

@@ -2,9 +2,11 @@
 
 ![Vasille.js logo](https://raw.githubusercontent.com/vasille-js/vasille-js/refs/heads/v5/doc/img/logo.png)
 
-`SteelFrameKit` is a front-end development kit, which is developed to provide bulletproof frontends.
+`SteelFrameKit` is a front-end development kit, which is developed to provide fault tolerant web applications.
 
-[![npm](https://img.shields.io/npm/v/vasille?style=flat-square)](https://www.npmjs.com/package/vasille)
+[![npm](https://img.shields.io/npm/v/steel-frame?style=round-square)](https://www.npmjs.com/package/steel-frame)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/vasille-js/steel-frame)
+[![Coverage Status](https://coveralls.io/repos/github/vasille-js/steel-frame/badge.svg?branch=v5)](https://coveralls.io/github/vasille-js/steel-frame?branch=v5)
 
 ## Table of content
 
@@ -19,11 +21,12 @@
   - [How POWERFUL is SteelFrameKit](#how-powerful-is-steelframekit)
   - [Road map](#road-map)
   - [Change log](#change-log)
-    - [5.0.0](#500)
-    - [4.3.0](#430)
-    - [4.2.0](#420)
-    - [4.1.0](#410)
-    - [4.0.0](#400)
+    - [5.1](#51)
+    - [5.0](#50)
+    - [4.0 - 4.3](#40---43)
+    - [3.0 - 3.2](#30---32)
+    - [2.0 - 2.3](#20---23)
+    - [1.0 - 1.2](#10---12)
   - [Questions](#questions)
 
 
@@ -92,7 +95,7 @@ All of these are supported:
 * Reactive values (observables).
 * Inline computed values.
 * Multiline computed values.
-* HTML & SVG tags.
+* HTML tags.
 * Component custom slots.
 * 2-way data binding in components.
 * Logic block (if, else).
@@ -103,7 +106,6 @@ All of these are supported:
 
 ## Road map
 
-* [x] Update the `core` library to version 3.0.
 * [x] `100%` Test Coverage for core Library v3.
 * [x] Develop the `JSX` library.
 * [x] `100%` Test Coverage for the JSX library.
@@ -117,25 +119,47 @@ All of these are supported:
 
 ## Change log
 
-### 5.0.0
+We respect semantic versioning:
+- A major version is increased when we make incompatible API changes.
+- A minor version is increased when we add functionality.
+- Patch version is increased when we fix bugs.
 
-Add support for context and dependencies injection.
+### 5.1
 
-### 4.3.0
+Add support for web components compile target `web build components`.
+_Web components as custom tags are supported in any version._
 
-Add new function `safe` which make functions safe, errors are reported automatically.
+### 5.0
 
-### 4.2.0
+- Add support for context and dependencies injection.
+- New developement direction: `fault tolerant`.
+- Renamed to `steel-frame`. **[API change]**
+- Removed `forward` and `backward` functions. **[API change]**
+- Removed `Debug` component. **[API change]**
 
-Add support for inlined conditions in JSX, binary `&&` and ternary `?:` operator.
+### 4.0 - 4.3
 
-### 4.1.0
+- Initial version of the framework with file based routing and building scripts (`web dev` and `web build spa`).
+- Reactive values naming switched to `$` prefix. **[API change]**
+- `4.1` Added SSG (static site generation) as build option `web build static`.
+- `4.2` Add support for inlined conditions in JSX, binary `&&` and ternary `?:` operator.
+- `4.3` Add new function `safe` which make functions safe, errors are reported automatically.
 
-Added SSG (static site generation) as build option `sf build static`.
+### 3.0 - 3.2
 
-### 4.0.0
+- Switch to a babel plugin to compile components code. **[API change]**
+- 100% of the code has been covered with unit tests.
+- New developement direction: `keep it simple`.
 
-Initial version of the framework with file based routing and building scripts (`sf dev` and `sf build spa`).
+### 2.0 - 2.3
+
+- Introduces components compilation via a typescript plugin. **[API change]**
+- New developement direction: `write less, do more`.
+
+### 1.0 - 1.2
+
+- Initial version of a core library.
+- Developemnt direction: `performance-first`.
 
 ## Questions
 

package/fake-types/index.d.ts

@@ -111,9 +111,6 @@ export declare function For<K, T>(props: { of: ReadonlyMap<K, T>; slot?: (value:
 /** Refresh the content each time then the reactive model is updated */
 export declare function Watch<T>(props: { $model: T; slot?: (value: T) => void }): void;
 
-/** Create a debug comment in DOM */
-export declare function Debug(props: { $model: unknown }): void;
-
 /** Render content after a while */
 export declare function Delay(props: { time?: number; slot?: unknown }): void;
 
@@ -258,3 +255,12 @@ export declare function impute<Class>(className: abstract new (...args: unknown[
 
 /** Share a setting value when it is missing */
 export declare function impute(key: string, value: string): string;
+
+export {
+    type WebComponent,
+    type WebComponentAdapter,
+    type WebComponentAttributes,
+    type WebComponentEventHandler,
+    type WebComponentProps,
+    type WebComponentEvents,
+} from "vasille-shadow";

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "steel-frame",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "SteelFrame: Build Fault-Tolerant Web Applications Effortlessly.",
   "main": "index.js",
   "types": "./index.d.ts",
-  "bin": {
-    "sf": "./lib/run.js"
-  },
   "exports": {
     ".": {
       "types": "./fake-types/index.d.ts",
@@ -47,11 +44,12 @@
   "homepage": "https://github.com/vasille-js/vasille-js#readme",
   "dependencies": {
     "csstype": "^3.1.3",
-    "vasille": "^5.0.0",
+    "vasille": "^5.1.0",
     "vasille-context": "^5.0.0",
     "vasille-css": "^5.0.0",
     "vasille-jsx": "^5.0.0",
     "vasille-router": "^5.0.0",
+    "vasille-shadow": "^5.0.0",
     "vasille-ssg": "^4.0.0",
     "vasille-web": "^5.0.0"
   },