arche 1.0.0 → 1.0.2

package/LICENSE

@@ -1,21 +1,9 @@
-The MIT License (MIT)
+The CLOUT Free and Open Source Software License (CFOSS)
 
-Copyright (c) 2025 Richard Tong
+© Richard Yufei Tong, King of Software
 
-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:
+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.
+  1. This permission notice is 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.
+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 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 IN THE USE OF OR OTHER DEALINGS OF THE SOFTWARE.

package/README.md

@@ -1,46 +1,44 @@
 # Arche
 ![arche-logo](https://raw.githubusercontent.com/a-synchronous/assets/master/arche-logo-226x226.png)
-> Arche (/ˈɑːrki/; Ancient Greek: ἀρχή) is a Greek word with primary senses "beginning", "origin" or "source of action" (ἐξ' ἀρχῆς: from the beginning, οr ἐξ' ἀρχῆς λόγος: the original argument), and later "first principle" or "element". ([wikipedia](https://en.wikipedia.org/wiki/Arche))
+> Arche (/ˈɑːrki/; Ancient Greek: ἀρχή) is a Greek word with primary senses "beginning", "origin" or "source of action" (ἐξ' ἀρχῆς: from the beginning, οr ἐξ' ἀρχῆς λόγος: the original argument), and later "first principle" or "element".
 
 ![Node.js CI](https://github.com/richytong/arche/actions/workflows/nodejs.yml/badge.svg)
 [![codecov](https://codecov.io/gh/richytong/arche/branch/master/graph/badge.svg)](https://codecov.io/gh/richytong/arche)
+[![npm version](https://img.shields.io/npm/v/arche.svg?style=flat)](https://www.npmjs.com/package/arche)
 
 Simplified DOM interface / React in pure JavaScript.
 
-```javascript
-const DocumentElement = Arche(document)
-const { Div, H1, P } = DocumentElement
-
-const myElement = Div({ id: 'my-element' }, [
-  H1('I am a heading'),
-  P('paragraph'),
-  P('lorem ipsum'),
-])
-
-document.getElementById('#my-container').appendChild(myElement)
-// <div id="my-container">
-//   <div id="my-element">
-//     <h1>I am a heading</h1>
-//     <p>paragraph</p>
-//     <p>lorem ipsum</p>
-//   </div>
-// </div>
+```javascript [playground]
+{
+  const DocumentElement = Arche(document)
+  const { Div, H1, P } = DocumentElement
 
-const ReactElement = Arche(React)
-const { Div, H1, P, Button, Img } = ReactElement
+  const myElement = Div({ id: 'my-element' }, [
+    H1('DOM Example'),
+    P('paragraph'),
+    P('lorem ipsum'),
+  ])
 
-const UserCard = ReactElement(({
-  firstName, lastName, age,
-}) => Div([
-  H1(`${firstName} ${lastName}`),
-  Img({ src: 'https://via.placeholder.com/150x150', alt: 'placeholder' }),
-  P({ style: { color: 'lightgrey' } }, `age: ${age}`),
-]))
+  document.getElementById('dom-container').appendChild(myElement)
+}
 
-ReactDOM.render(
-  UserCard({ firstName: 'Example', lastName: 'Name', age: 32 }),
-  document.getElementById('react-root')
-)
+{
+  const ReactElement = Arche(React)
+  const { Div, H1, P, Button, Img } = ReactElement
+
+  const UserCard = ReactElement(({
+    firstName, lastName, age,
+  }) => Div([
+    H1(`${firstName} ${lastName}`),
+    Img({ src: 'https://placehold.co/300x300', alt: 'placeholder' }),
+    P({ style: { color: 'lightgrey' } }, `age: ${age}`),
+  ]))
+
+  ReactDOM.render(
+    UserCard({ firstName: 'React', lastName: 'ExampleUser', age: 32 }),
+    document.getElementById('react-root')
+  )
+}
 ```
 
 ## Installation
@@ -79,70 +77,6 @@ window.Svg = DocumentElement('svg')
 window.Path = DocumentElement('path')
 ```
 
-## Syntax
-```coffeescript [specscript]
-Arche() -> DocumentElement
-Arche(document Document) -> DocumentElement
-
-DocumentElement(
-  elementType string,
-  props object,
-  text string
-) -> element Element
-
-DocumentElement(
-  elementType string,
-  props object,
-  children Array<Element|string>
-) -> element Element
-
-DocumentElement(elementType string) -> TypedDocumentElement
-DocumentElement.A -> TypedDocumentElement
-DocumentElement.P -> TypedDocumentElement
-DocumentElement.B -> TypedDocumentElement
-DocumentElement.Q -> TypedDocumentElement
-DocumentElement.I -> TypedDocumentElement
-DocumentElement.Ul -> TypedDocumentElement
-DocumentElement.Ol -> TypedDocumentElement
-DocumentElement.Li -> TypedDocumentElement
-DocumentElement.H1 -> TypedDocumentElement
-DocumentElement.H2 -> TypedDocumentElement
-DocumentElement.H3 -> TypedDocumentElement
-DocumentElement.H4 -> TypedDocumentElement
-DocumentElement.H5 -> TypedDocumentElement
-DocumentElement.H6 -> TypedDocumentElement
-DocumentElement.Hr -> TypedDocumentElement
-DocumentElement.Br -> TypedDocumentElement
-DocumentElement.Script -> TypedDocumentElement
-DocumentElement.Html -> TypedDocumentElement
-DocumentElement.Body -> TypedDocumentElement
-DocumentElement.Nav -> TypedDocumentElement
-DocumentElement.Section -> TypedDocumentElement
-DocumentElement.Article -> TypedDocumentElement
-DocumentElement.Footer -> TypedDocumentElement
-DocumentElement.Span -> TypedDocumentElement
-DocumentElement.Div -> TypedDocumentElement
-DocumentElement.Img -> TypedDocumentElement
-DocumentElement.Video -> TypedDocumentElement
-DocumentElement.Form -> TypedDocumentElement
-DocumentElement.Fieldset -> TypedDocumentElement
-DocumentElement.Input -> TypedDocumentElement
-DocumentElement.Label -> TypedDocumentElement
-DocumentElement.Textarea -> TypedDocumentElement
-DocumentElement.Select -> TypedDocumentElement
-DocumentElement.Option -> TypedDocumentElement
-DocumentElement.Button -> TypedDocumentElement
-DocumentElement.Iframe -> TypedDocumentElement
-DocumentElement.Blockquote -> TypedDocumentElement
-DocumentElement.Code -> TypedDocumentElement
-DocumentElement.Pre -> TypedDocumentElement
-
-TypedDocumentElement(props object, text string) -> element Element
-TypedDocumentElement(text string) -> element Element
-TypedDocumentElement(props object, children Array<Element|string>) -> element Element
-TypedDocumentElement(children Array<Element|string>) -> element Element
-```
-
 ## Using React
 To use Arche with [React](https://react.dev/), simply provide the React library.
 
@@ -152,7 +86,7 @@ const ReactElement = Arche(React)
 
 Create dynamic components with props.
 
-```javascript
+```javascript [playground]
 const ReactElement = Arche(React)
 
 const { Div, H1, P, Button, Img } = ReactElement
@@ -161,21 +95,19 @@ const UserCard = ReactElement(({
   firstName, lastName, age,
 }) => Div([
   H1(`${firstName} ${lastName}`),
-  Img({ src: 'https://via.placeholder.com/150x150', alt: 'placeholder' }),
+  Img({ src: 'https://placehold.co/300x300', alt: 'placeholder' }),
   P({ style: { color: 'lightgrey' } }, `age: ${age}`),
 ]))
 
-render(UserCard({ firstName: 'Example', lastName: 'Name', age: 32 }))
-// <div>
-//   <h1>Example Name</h1>
-//   <img src="https://via.placeholder.com/150x150" alt="placeholder">
-//   <p style="color: lightgrey">age: 32</p>
-// </div>
+ReactDOM.render(
+  UserCard({ firstName: 'Example', lastName: 'Name', age: 32 }),
+  document.getElementById('react-root')
+)
 ```
 
 Complete interoperability with React hooks (converted from [this example](https://reactjs.org/docs/hooks-intro.html)).
 
-```javascript
+```javascript [playground]
 const ReactElement = Arche(React)
 const { Div, P, Button } = ReactElement
 const { useState } = React
@@ -193,11 +125,7 @@ const Example = ReactElement(() => {
   ])
 })
 
-render(Example())
-// <div>
-//   <p>You clicked {count} times</p>
-//   <button onclick="setCount(count + 1)">Click me</button>
-// </div>
+ReactDOM.render(Example(), document.getElementById('react-root'))
 ```
 
 Set `ReactElement` globally for a better developer experience.
@@ -218,83 +146,6 @@ window.Svg = ReactElement('svg')
 window.Path = ReactElement('path')
 ```
 
-## Syntax with React
-
-```coffeescript [specscript]
-type React = {
-  createElement: (
-    elementType string,
-    props object,
-    children string|Array<React.Element|string>
-  )=>(reactElement React.Element)
-}
-
-Arche(React) -> ReactElement
-
-ReactElement(
-  elementType string,
-  props object,
-  text string
-) -> reactElement React.Element
-
-ReactElement(
-  elementType string,
-  props object,
-  children Array<React.Element|string>
-) -> reactElement React.Element
-
-ReactElement(elementType string) -> TypedReactElement
-ReactElement.A -> TypedReactElement
-ReactElement.P -> TypedReactElement
-ReactElement.B -> TypedReactElement
-ReactElement.Q -> TypedReactElement
-ReactElement.I -> TypedReactElement
-ReactElement.Ul -> TypedReactElement
-ReactElement.Ol -> TypedReactElement
-ReactElement.Li -> TypedReactElement
-ReactElement.H1 -> TypedReactElement
-ReactElement.H2 -> TypedReactElement
-ReactElement.H3 -> TypedReactElement
-ReactElement.H4 -> TypedReactElement
-ReactElement.H5 -> TypedReactElement
-ReactElement.H6 -> TypedReactElement
-ReactElement.Hr -> TypedReactElement
-ReactElement.Br -> TypedReactElement
-ReactElement.Script -> TypedReactElement
-ReactElement.Html -> TypedReactElement
-ReactElement.Body -> TypedReactElement
-ReactElement.Nav -> TypedReactElement
-ReactElement.Section -> TypedReactElement
-ReactElement.Article -> TypedReactElement
-ReactElement.Footer -> TypedReactElement
-ReactElement.Span -> TypedReactElement
-ReactElement.Div -> TypedReactElement
-ReactElement.Img -> TypedReactElement
-ReactElement.Video -> TypedReactElement
-ReactElement.Form -> TypedReactElement
-ReactElement.Fieldset -> TypedReactElement
-ReactElement.Input -> TypedReactElement
-ReactElement.Label -> TypedReactElement
-ReactElement.Textarea -> TypedReactElement
-ReactElement.Select -> TypedReactElement
-ReactElement.Option -> TypedReactElement
-ReactElement.Button -> TypedReactElement
-ReactElement.Iframe -> TypedReactElement
-ReactElement.Blockquote -> TypedReactElement
-ReactElement.Code -> TypedReactElement
-ReactElement.Pre -> TypedReactElement
-
-TypedReactElement(props object, text string) -> reactElement React.Element
-TypedReactElement(text string) -> reactElement React.Element
-
-TypedReactElement(
-  props object,
-  children Array<React.Element|string>
-) -> reactElement React.Element
-
-TypedReactElement(children Array<React.Element|string>) -> reactElement React.Element
-```
-
 ## Using React Context
 To use React Context with Arche, wrap `YourContext.Provider` with `ReactElement` and supply `value` as a prop, specifying children in the next argument.
 
@@ -330,135 +181,37 @@ const ArticleWrapper = ReactElement(() => {
 Arche accepts a `styled` option from css-in-js libraries like [Styled Components](https://styled-components.com/) to enable a `css` prop on `ReactElement` and `TypedReactElement`.
 
 ```javascript
-// global.js
 const ReactElement = Arche(React, { styled })
 ```
 
 Elements can now specify a `css` prop to use css-in-js.
 
-```javascript
-// MyComponent.js
-const MyComponent = ReactElement(props => {
+```javascript [playground]
+const ReactElement = Arche(React, { styled })
+const { Div, H1, P } = ReactElement
+
+const MyComponent = ReactElement(() => {
   return Div({
     css: `
-      width: 500px;
+      height: 500px;
+      width: 100%;
       background-color: pink;
     `,
-  })
+  }, [
+    H1('Styled Example'),
+    P('Text'),
+  ])
 })
-```
-
-## Syntax with styled
-```coffeescript [specscript]
-([css string])=>(reactElement React.Element) -> StyledComponent
-
-type Styled = {
-  h1: StyledComponent,
-  h2: StyledComponent,
-  h3: StyledComponent,
-  h4: StyledComponent,
-  h5: StyledComponent,
-  div: StyledComponent,
-  button: StyledComponent,
-  a: StyledComponent,
-  p: StyledComponent,
-  span: StyledComponent,
-  img: StyledComponent,
-  ul: StyledComponent,
-  ol: StyledComponent,
-  li: StyledComponent,
-  form: StyledComponent,
-  article: StyledComponent,
-  main: StyledComponent,
-  section: StyledComponent,
-  nav: StyledComponent,
-}
 
-Arche(React {
-  createElement: (
-    elementType string,
-    props object,
-    textOrChildren string|Array<React.Element|string>
-  )=>(reactElement React.Element)
-}, options {
-  styled: Styled,
-  styledMemoizationCap?: number
-}) -> reactElement ReactElement
-
-ReactElement(
-  elementType string,
-  propsWithCss { css: string, ...props object },
-  text string
-) -> reactElement React.Element
-
-ReactElement(
-  elementType string,
-  propsWithCss { css: string, ...props object },
-  children Array<React.Element|string>
-) -> reactElement React.Element
-
-ReactElement(elementType string) -> TypedReactElement
-ReactElement.A -> TypedReactElement
-ReactElement.P -> TypedReactElement
-ReactElement.B -> TypedReactElement
-ReactElement.Q -> TypedReactElement
-ReactElement.I -> TypedReactElement
-ReactElement.Ul -> TypedReactElement
-ReactElement.Ol -> TypedReactElement
-ReactElement.Li -> TypedReactElement
-ReactElement.H1 -> TypedReactElement
-ReactElement.H2 -> TypedReactElement
-ReactElement.H3 -> TypedReactElement
-ReactElement.H4 -> TypedReactElement
-ReactElement.H5 -> TypedReactElement
-ReactElement.H6 -> TypedReactElement
-ReactElement.Hr -> TypedReactElement
-ReactElement.Br -> TypedReactElement
-ReactElement.Script -> TypedReactElement
-ReactElement.Html -> TypedReactElement
-ReactElement.Body -> TypedReactElement
-ReactElement.Nav -> TypedReactElement
-ReactElement.Section -> TypedReactElement
-ReactElement.Article -> TypedReactElement
-ReactElement.Footer -> TypedReactElement
-ReactElement.Span -> TypedReactElement
-ReactElement.Div -> TypedReactElement
-ReactElement.Img -> TypedReactElement
-ReactElement.Video -> TypedReactElement
-ReactElement.Form -> TypedReactElement
-ReactElement.Fieldset -> TypedReactElement
-ReactElement.Input -> TypedReactElement
-ReactElement.Label -> TypedReactElement
-ReactElement.Textarea -> TypedReactElement
-ReactElement.Select -> TypedReactElement
-ReactElement.Option -> TypedReactElement
-ReactElement.Button -> TypedReactElement
-ReactElement.Iframe -> TypedReactElement
-ReactElement.Blockquote -> TypedReactElement
-ReactElement.Code -> TypedReactElement
-ReactElement.Pre -> TypedReactElement
-
-TypedReactElement(
-  propsWithCss { css: string, ...props object },
-  text string
-) -> reactElement React.Element
-
-TypedReactElement(text string) -> reactElement React.Element
-
-TypedReactElement(
-  propsWithCss { css: string, ...props object },
-  children Array<React.Element|string>
-) -> reactElement React.Element
-
-TypedReactElement(children Array<React.Element|string>) -> reactElement React.Element
+ReactDOM.render(MyComponent(), document.getElementById('react-root'))
 ```
 
 # Contributing
 Your feedback and contributions are welcome. If you have a suggestion, please raise an issue. Prior to that, please search through the issues first in case your suggestion has been made already. If you decide to work on an issue, please create a pull request.
 
-Pull requests should provide some basic context and link the relevant issue. Here is an [example pull request](https://github.com/a-synchronous/rubico/pull/12). If you are interested in contributing, the [help wanted](https://github.com/richytong/arche/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag is a good place to start.
+Pull requests should provide some basic context and link the relevant issue. If you are interested in contributing, the [help wanted](https://github.com/richytong/arche/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag is a good place to start.
 
-For more information please see [CONTRIBUTING.md](/CONTRIBUTING.md)
+For more information please see [CONTRIBUTING.md](https://github.com/richytong/arche/blob/master/CONTRIBUTING.md)
 
 # License
 Arche is [MIT Licensed](https://github.com/a-synchronous/rubico/blob/master/LICENSE).