hyperscript-rxjs 1.2.7 → 1.3.1

package/package.json

@@ -1,34 +1,47 @@
 {
-  "dependencies": {},
   "devDependencies": {
-    "rxjs": "7.5.5",
-    "@babel/core": "7.17.7",
-    "@babel/plugin-proposal-class-properties": "7.16.7",
-    "@babel/plugin-proposal-export-default-from": "7.16.7",
-    "@babel/plugin-proposal-export-namespace-from": "7.16.7",
-    "@babel/plugin-proposal-pipeline-operator": "7.17.6",
-    "@babel/preset-env": "7.16.11",
-    "@webpack-cli/serve": "1.6.1",
-    "babel-jest": "27.5.1",
-    "babel-loader": "8.2.3",
+    "@babel/core": "7.27.1",
+    "@babel/preset-env": "7.27.2",
+    "@microsoft/api-extractor": "7.52.8",
+    "@webpack-cli/serve": "3.0.1",
+    "babel-jest": "29.7.0",
+    "babel-loader": "10.0.0",
     "clean-webpack-plugin": "4.0.0",
-    "core-js": "3.21.1",
-    "jest": "27.5.1",
-    "node-fetch": "3.2.3",
-    "webpack": "5.70.0",
-    "webpack-cli": "4.9.2",
-    "webpack-dev-server": "4.7.4",
-    "webpack-merge": "5.8.0"
+    "core-js": "3.42.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "jsdom": "26.1.0",
+    "node-fetch": "3.3.2",
+    "regenerator-runtime": "0.14.1",
+    "rxjs": "7.8.2",
+    "tslib": "2.8.1",
+    "typescript": "5.8.3",
+    "webpack": "5.99.8",
+    "webpack-cli": "6.0.1",
+    "webpack-dev-server": "5.2.1",
+    "webpack-merge": "6.0.1"
+  },
+  "jest": {
+    "testEnvironment": "jsdom",
+    "transform": {
+      "^.+\\.jsx?$": "babel-jest"
+    },
+    "transformIgnorePatterns": [
+      "/node_modules/(?!rxjs)"
+    ]
   },
   "scripts": {
     "build": "webpack --config webpack.prod.js",
     "start": "webpack serve --config webpack.dev.js",
-    "test": "jest"
+    "test": "jest",
+    "dts:build": "tsc",
+    "dts:extract": "api-extractor run --local"
   },
   "name": "hyperscript-rxjs",
-  "description": "A js UI library that uses rxjs to react dom directly.",
+  "description": "A js UI library that uses rxjs to handle dom directly.",
   "main": "dist/hyperscript-rxjs.js",
-  "version": "1.2.7",
+  "types": "dist/hyperscript-rxjs.d.ts",
+  "version": "1.3.1",
   "author": "cuishengli<34696643@qq.com>",
   "keywords": [
     "ui",
@@ -40,5 +53,9 @@
     "type": "git",
     "url": "https://github.com/xp44mm/hyperscript-rxjs"
   },
-  "license": "LGPL-3.0-or-later"
+  "license": "LGPL-3.0-or-later",
+  "files": [
+    "dist",
+    "README.md"
+  ]
 }

package/readme.md

@@ -1,45 +1,151 @@
-`hyperscript-rxjs`是一个直接操作DOM的js前端框架库。`hyperscript-rxjs`具有如下特点：
 
-* 相比操作DOM模型的命令式代码，`hyperscript-rxjs`更具声明性。
+# hyperscript-rxjs
 
-* `hyperscript-rxjs`修复或绕开了很多DOM的历史缺陷。
+A JavaScript UI library that uses RxJS to handle DOM directly.
 
-* 像knockout一样，`hyperscript-rxjs`使用MVVM分离视图与视图模型，不同的是`hyperscript-rxjs`采取通用的rxjs库来观察变化。
+## Features
 
-* 像react一样，`hyperscript-rxjs`操作DOM，与html无关。不同的是`hyperscript-rxjs`直接操作DOM本身，无虚拟DOM。
+- Reactive programming with RxJS.
+- Direct DOM manipulation.
+- Lightweight and flexible.
 
-* `hyperscript-rxjs`采用更新的事件标准`addEventListener`，不采用属性事件`onevent`。采用rxjs观察DOM模型的变化，事件通知。
+---
 
-* 尽管rxjs是技术发展趋势，用户仍然可以基于`hyperscript-rxjs`实现代码，渐进实现不依赖任何框架的代码。
+## Installation
 
-`hyperscript-rxjs`学习难度小于react，并且其知识兼容底层的DOM，实用性更强。教程见单独的文件。
+Install the library via npm:
 
-## 依赖库
+```bash
+npm install hyperscript-rxjs
+```
+
+---
+
+## Usage
+
+### Basic Example
+
+```javascript
+import { Comparer } from "hyperscript-rxjs";
+
+const comparer = new Comparer((a, b) => a - b);
+console.log(comparer.sort([3, 1, 2])); // Output: [1, 2, 3]
+```
+
+### Importing Specific Modules
+
+You can import specific modules as needed:
+
+```javascript
+import { nestedCombineLatest } from "hyperscript-rxjs";
+```
+
+---
+
+## API
+
+### Exported Modules
+
+#### Comparers
+- `Comparer`
+- `defaultComparer`
+- `keyComparer`
+- `keyPathComparer`
+- `entryComparer`
+
+#### Reactive Utilities
+- `isRxType`
+- `ObservableArray`
+
+#### Other Utilities
+- `Deep`
+- `nodes`
+- `object`
+- `props`
+- `ramda`
+- `structures`
+- `unquoted-json`
+
+---
+
+## Development
+
+### Prerequisites
+
+Ensure you have the following installed:
+- Node.js (>= 14.x)
+- npm (>= 6.x)
 
-`hyperscript-rxjs` is based on `rxjs`。
+### Clone the Repository
 
-## 入门
+```bash
+git clone https://github.com/xp44mm/hyperscript-rxjs.git
+cd hyperscript-rxjs
+```
+
+### Install Dependencies
+
+```bash
+npm install
+```
 
-一个Hello World程序，就像写html一样简单。
+### Build the Project
 
-```js
-import { p } from 'hyperscript-rxjs'
-export function hello() { return p('hello world!'); }
+```bash
+npm run build
 ```
 
-本框架API的设计和DOM底层完全一致，即使你将来不使用本框架，也会有益于你的职业生涯。本教程的其余部分将更加详细地涵盖前端库的各种功能以及其它高级用法。
+The build output will be located in the `dist/` directory.
+
+---
 
-## 教程
+## Testing
 
-教程及其源代码位于github库`xp44mm/hyperscript-rxjs-test`中。
+### Run Tests
 
-## 相关库
+```bash
+npm test
+```
 
-推荐使用如下库，编写更优美的代码：
+### Watch Tests
+
+```bash
+npm run test:watch
+```
+
+### Test Coverage
+
+```bash
+npm run test:coverage
+```
 
-xp44mm/structural-comparison
+---
 
-xp44mm/deep-rxjs
+## Contributing
 
-xp44mm/parse-html
+Contributions are welcome! Please follow these steps:
 
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Commit your changes and push the branch.
+4. Submit a pull request.
+
+---
+
+## License
+
+This project is licensed under the **LGPL-3.0-or-later** license. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Repository
+
+[GitHub Repository](https://github.com/xp44mm/hyperscript-rxjs)
+
+---
+
+## Author
+
+**cuishengli**  
+Email: 34696643@qq.com
+```