oipage 1.7.0-rc.0 → 1.7.0

package/.github/FUNDING.yml

@@ -1,12 +1,12 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
 custom: ['https://zxl20070701.github.io/notebook/home.html']

package/AUTHORS.txt

@@ -1,6 +1,6 @@
-Authors ordered by first contribution.
-
-zxl20070701 <1904314465@qq.com> <https://github.com/zxl20070701>
-
------------------------------------------------------
-We thank all of them for their contributions!
+Authors ordered by first contribution.
+
+zxl20070701 <1904314465@qq.com> <https://github.com/zxl20070701>
+
+-----------------------------------------------------
+We thank all of them for their contributions!

package/CHANGELOG

@@ -143,7 +143,7 @@ v1.6.1:
           1、修复run命令在Windows中运行错误
             （关联issue： https://github.com/oi-contrib/OIPage/issues/8 ）
 v1.7.0:
-    date:
+    date:2026-01-06
     changes:
         - 优化改造
           1、types定义模块，方便使用时代码提示

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) zxl20070701 走一步，再走一步
-
-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
+MIT License
+
+Copyright (c) zxl20070701 走一步，再走一步
+
+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

@@ -1,95 +1,95 @@
--   💘 开源不易，去 <i>[Github给个Star](https://github.com/oi-contrib/OIPage) </i>吧！
-
-<img src='https://oi-contrib.github.io/OIPage/images/logo.png' height='100px'/>
-
-<p>
-    <a href="https://zxl20070701.github.io/toolbox/#/npm-download?packages=oipage&interval=7">
-        <img src="https://img.shields.io/npm/dm/oipage.svg" alt="downloads">
-    </a>
-    <a href="https://www.npmjs.com/package/oipage">
-        <img src="https://img.shields.io/npm/v/oipage.svg" alt="npm">
-    </a>
-    <a href="https://github.com/oi-contrib/OIPage/issues">
-        <img src="https://img.shields.io/github/issues/oi-contrib/OIPage" alt="issue">
-    </a>
-    <a href="https://github.com/oi-contrib/OIPage" target='_blank'>
-        <img alt="GitHub repo stars" src="https://img.shields.io/github/stars/oi-contrib/OIPage?style=social">
-    </a>
-    <a href="https://github.com/oi-contrib/OIPage">
-        <img src="https://img.shields.io/github/forks/oi-contrib/OIPage" alt="forks">
-    </a>
-     <a href="https://gitee.com/oi-contrib/OIPage" target='_blank'>
-        <img alt="Gitee repo stars" src="https://gitee.com/oi-contrib/OIPage/badge/star.svg">
-    </a>
-    <a href="https://gitee.com/oi-contrib/OIPage">
-        <img src="https://gitee.com/oi-contrib/OIPage/badge/fork.svg" alt="forks">
-    </a>
-</p>
-
-<img src="https://nodei.co/npm/oipage.png?downloads=true&amp;downloadRank=true&amp;stars=true" alt="NPM">
-
-# [OIPage](https://github.com/oi-contrib/OIPage)
-前端网页或应用快速开发助手，包括开发服务器、辅助命令、实用API等。官网地址：[https://oi-contrib.github.io/OIPage](https://oi-contrib.github.io/OIPage)
-
-## 如何使用？
-
-你可以作为一个命令行使用，那么你需要全局安装：
-
-```shell
-npm install -g oipage
-```
-
-也可以作为项目开发中的一个功能加强，在 package.json 中配置命令或nodejs文件中引入需要的模块使用，那么就在项目中执行安装命令：
-
-```shell
-npm install oipage --save
-```
-
-安装后，就可以直接作为命令行使用了。你可以打印帮助查看：
-
-```shell
-oipage-cli
-```
-
-比如会出现类似下列内容：
-
-```
-OIPage@v1.2.0
-
-可以使用的命令如下：
-
-【1】oipage-cli serve 开发服务器
-    --port|-p 端口号
-    --baseUrl 服务器根目录
-......
-```
-
-根据提示我们知道，比如第一个命令，其提供了一个快速访问本地资源服务器的功能，比如执行：
-
-```shell
-oipage-cli serve -p 8080
-```
-
-启动成功后，直接访问： http://localhost:8080/ 即可。
-
-如果你需要在项目中使用，我们也提供了一些有用的API，具体可以访问[ 在线文档 ](https://oi-contrib.github.io/OIPage)进行了解。
-
-## 应用市场
-
-为了方便日常使用，内置了一个应用市场网站，比如有如下功能：
-
-### 群聊天
-
-<img src="./snipping/chart.png" />
-
-### 图片编辑器
-
-<img src="./snipping/image-editor.png" />
-
-已有功能或更多功能我们将根据实际情况逐步完善和维护，当然，你可以通过 [issue](https://github.com/oi-contrib/OIPage/issues) 给我们留言，告诉我们你的改进意见。
-
-## 版权
-
-MIT License
-
-Copyright (c) [zxl20070701](https://zxl20070701.github.io/notebook/home.html) 走一步，再走一步
+-   💘 开源不易，去 <i>[Github给个Star](https://github.com/oi-contrib/OIPage) </i>吧！
+
+<img src='https://oi-contrib.github.io/OIPage/images/logo.png' height='100px'/>
+
+<p>
+    <a href="https://zxl20070701.github.io/toolbox/#/npm-download?packages=oipage&interval=7">
+        <img src="https://img.shields.io/npm/dm/oipage.svg" alt="downloads">
+    </a>
+    <a href="https://www.npmjs.com/package/oipage">
+        <img src="https://img.shields.io/npm/v/oipage.svg" alt="npm">
+    </a>
+    <a href="https://github.com/oi-contrib/OIPage/issues">
+        <img src="https://img.shields.io/github/issues/oi-contrib/OIPage" alt="issue">
+    </a>
+    <a href="https://github.com/oi-contrib/OIPage" target='_blank'>
+        <img alt="GitHub repo stars" src="https://img.shields.io/github/stars/oi-contrib/OIPage?style=social">
+    </a>
+    <a href="https://github.com/oi-contrib/OIPage">
+        <img src="https://img.shields.io/github/forks/oi-contrib/OIPage" alt="forks">
+    </a>
+     <a href="https://gitee.com/oi-contrib/OIPage" target='_blank'>
+        <img alt="Gitee repo stars" src="https://gitee.com/oi-contrib/OIPage/badge/star.svg">
+    </a>
+    <a href="https://gitee.com/oi-contrib/OIPage">
+        <img src="https://gitee.com/oi-contrib/OIPage/badge/fork.svg" alt="forks">
+    </a>
+</p>
+
+<img src="https://nodei.co/npm/oipage.png?downloads=true&amp;downloadRank=true&amp;stars=true" alt="NPM">
+
+# [OIPage](https://github.com/oi-contrib/OIPage)
+前端网页或应用快速开发助手，包括开发服务器、辅助命令、实用API等。官网地址：[https://oi-contrib.github.io/OIPage](https://oi-contrib.github.io/OIPage)
+
+## 如何使用？
+
+你可以作为一个命令行使用，那么你需要全局安装：
+
+```shell
+npm install -g oipage
+```
+
+也可以作为项目开发中的一个功能加强，在 package.json 中配置命令或nodejs文件中引入需要的模块使用，那么就在项目中执行安装命令：
+
+```shell
+npm install oipage --save
+```
+
+安装后，就可以直接作为命令行使用了。你可以打印帮助查看：
+
+```shell
+oipage-cli
+```
+
+比如会出现类似下列内容：
+
+```
+OIPage@v1.2.0
+
+可以使用的命令如下：
+
+【1】oipage-cli serve 开发服务器
+    --port|-p 端口号
+    --baseUrl 服务器根目录
+......
+```
+
+根据提示我们知道，比如第一个命令，其提供了一个快速访问本地资源服务器的功能，比如执行：
+
+```shell
+oipage-cli serve -p 8080
+```
+
+启动成功后，直接访问： http://localhost:8080/ 即可。
+
+如果你需要在项目中使用，我们也提供了一些有用的API，具体可以访问[ 在线文档 ](https://oi-contrib.github.io/OIPage)进行了解。
+
+## 应用市场
+
+为了方便日常使用，内置了一个应用市场网站，比如有如下功能：
+
+### 群聊天
+
+<img src="./snipping/chart.png" />
+
+### 图片编辑器
+
+<img src="./snipping/image-editor.png" />
+
+已有功能或更多功能我们将根据实际情况逐步完善和维护，当然，你可以通过 [issue](https://github.com/oi-contrib/OIPage/issues) 给我们留言，告诉我们你的改进意见。
+
+## 版权
+
+MIT License
+
+Copyright (c) [zxl20070701](https://zxl20070701.github.io/notebook/home.html) 走一步，再走一步

package/bin/WebSocket/decodeWsFrame.js

@@ -1,43 +1,43 @@
-
-// 处理收到的数据
-module.exports = function decodeWsFrame(data) {
-    let start = 0;
-    let frame = {
-        isFinal: (data[start] & 0x80) === 0x80,
-        opcode: data[start++] & 0xF,
-        masked: (data[start] & 0x80) === 0x80,
-        payloadLen: data[start++] & 0x7F,
-        maskingKey: '',
-        payloadData: null
-    };
-
-    if (frame.payloadLen === 126) {
-        frame.payloadLen = (data[start++] << 8) + data[start++];
-    } else if (frame.payloadLen === 127) {
-        frame.payloadLen = 0;
-        for (let i = 7; i >= 0; --i) {
-            frame.payloadLen += (data[start++] << (i * 8));
-        }
-    }
-
-    if (frame.payloadLen) {
-        if (frame.masked) {
-            const maskingKey = [
-                data[start++],
-                data[start++],
-                data[start++],
-                data[start++]
-            ];
-
-            frame.maskingKey = maskingKey;
-
-            frame.payloadData = data
-                .slice(start, start + frame.payloadLen)
-                .map((byte, idx) => byte ^ maskingKey[idx % 4]);
-        } else {
-            frame.payloadData = data.slice(start, start + frame.payloadLen);
-        }
-    }
-
-    return frame;
-};
+
+// 处理收到的数据
+module.exports = function decodeWsFrame(data) {
+    let start = 0;
+    let frame = {
+        isFinal: (data[start] & 0x80) === 0x80,
+        opcode: data[start++] & 0xF,
+        masked: (data[start] & 0x80) === 0x80,
+        payloadLen: data[start++] & 0x7F,
+        maskingKey: '',
+        payloadData: null
+    };
+
+    if (frame.payloadLen === 126) {
+        frame.payloadLen = (data[start++] << 8) + data[start++];
+    } else if (frame.payloadLen === 127) {
+        frame.payloadLen = 0;
+        for (let i = 7; i >= 0; --i) {
+            frame.payloadLen += (data[start++] << (i * 8));
+        }
+    }
+
+    if (frame.payloadLen) {
+        if (frame.masked) {
+            const maskingKey = [
+                data[start++],
+                data[start++],
+                data[start++],
+                data[start++]
+            ];
+
+            frame.maskingKey = maskingKey;
+
+            frame.payloadData = data
+                .slice(start, start + frame.payloadLen)
+                .map((byte, idx) => byte ^ maskingKey[idx % 4]);
+        } else {
+            frame.payloadData = data.slice(start, start + frame.payloadLen);
+        }
+    }
+
+    return frame;
+};

package/bin/WebSocket/encodeWsFrame.js

@@ -1,28 +1,28 @@
-
-// 处理发出的数据
-module.exports = function encodeWsFrame(data) {
-    const isFinal = data.isFinal !== undefined ? data.isFinal : true,
-        opcode = data.opcode !== undefined ? data.opcode : 1,
-        payloadData = data.payloadData ? Buffer.from(data.payloadData) : null,
-        payloadLen = payloadData ? payloadData.length : 0;
-
-    let frame = [];
-
-    if (isFinal) frame.push((1 << 7) + opcode);
-    else frame.push(opcode);
-
-    if (payloadLen < 126) {
-        frame.push(payloadLen);
-    } else if (payloadLen < 65536) {
-        frame.push(126, payloadLen >> 8, payloadLen & 0xFF);
-    } else {
-        frame.push(127);
-        for (let i = 7; i >= 0; --i) {
-            frame.push((payloadLen & (0xFF << (i * 8))) >> (i * 8));
-        }
-    }
-
-    frame = payloadData ? Buffer.concat([Buffer.from(frame), payloadData]) : Buffer.from(frame);
-
-    return frame;
-};
+
+// 处理发出的数据
+module.exports = function encodeWsFrame(data) {
+    const isFinal = data.isFinal !== undefined ? data.isFinal : true,
+        opcode = data.opcode !== undefined ? data.opcode : 1,
+        payloadData = data.payloadData ? Buffer.from(data.payloadData) : null,
+        payloadLen = payloadData ? payloadData.length : 0;
+
+    let frame = [];
+
+    if (isFinal) frame.push((1 << 7) + opcode);
+    else frame.push(opcode);
+
+    if (payloadLen < 126) {
+        frame.push(payloadLen);
+    } else if (payloadLen < 65536) {
+        frame.push(126, payloadLen >> 8, payloadLen & 0xFF);
+    } else {
+        frame.push(127);
+        for (let i = 7; i >= 0; --i) {
+            frame.push((payloadLen & (0xFF << (i * 8))) >> (i * 8));
+        }
+    }
+
+    frame = payloadData ? Buffer.concat([Buffer.from(frame), payloadData]) : Buffer.from(frame);
+
+    return frame;
+};

package/bin/WebSocket/headersToJSON.js

@@ -1,26 +1,26 @@
-module.exports = function (headersStr) {
-
-    let headersArray = headersStr.split(/\r{0,1}\n/);
-    let headersJSON = {};
-
-    // 第一行的内容：GET / HTTP/1.1
-    let firstLine = headersArray.shift().split(' ');
-    headersJSON.method = firstLine[0];
-    headersJSON.url = firstLine[1];
-    headersJSON.protocol = firstLine[2];
-
-    for (let item of headersArray) {
-        let temp = item.split(':');
-
-        if (temp.length > 1) {
-
-            let key = temp.shift();
-            let value = temp.join(':');
-
-            headersJSON[key] = value.trim();
-
-        }
-    }
-
-    return headersJSON;
-};
+module.exports = function (headersStr) {
+
+    let headersArray = headersStr.split(/\r{0,1}\n/);
+    let headersJSON = {};
+
+    // 第一行的内容：GET / HTTP/1.1
+    let firstLine = headersArray.shift().split(' ');
+    headersJSON.method = firstLine[0];
+    headersJSON.url = firstLine[1];
+    headersJSON.protocol = firstLine[2];
+
+    for (let item of headersArray) {
+        let temp = item.split(':');
+
+        if (temp.length > 1) {
+
+            let key = temp.shift();
+            let value = temp.join(':');
+
+            headersJSON[key] = value.trim();
+
+        }
+    }
+
+    return headersJSON;
+};

package/bin/WebSocket/index.js

@@ -1,80 +1,80 @@
-const net = require('net');
-const crypto = require('crypto');
-
-const headersToJSON = require('./headersToJSON');
-const decodeWsFrame = require('./decodeWsFrame');
-const encodeWsFrame = require('./encodeWsFrame');
-
-module.exports = function (port, name, version) {
-    let sockets = [];
-
-    let handler = {
-        notifyBrowser: (msg) => {
-            for (let socket of sockets) {
-                socket.write(encodeWsFrame(msg));
-            }
-        }
-    };
-
-    const server = net.createServer(socket => {
-
-        // 错误
-        socket.on('error', (error) => {
-            console.log('Connection error:', error.message);
-        });
-
-        // 数据
-        socket.on('data', buffer => {
-            console.log('Connection data:' + (decodeWsFrame(buffer).payloadData?.toString() || "断开连接......"));
-        });
-
-        // 连接
-        socket.once('data', buffer => {
-
-            // 把请求头变成容易操作的json
-            const headers = headersToJSON(buffer.toString());
-
-            // 如果是ws请求
-            // 就需要建立连接
-            if (headers.Upgrade == 'websocket') {
-
-                if (headers['Sec-WebSocket-Version'] !== '13') {
-                    console.log('\r\n警告：当前WebSocket版本为' + headers['Sec-WebSocket-Version'] + "，可能存在兼容问题~\r\n");
-                }
-
-                // 开始连接
-                /*
-                    协议中规定的校验用GUID，可参考如下链接：
-                    https://tools.ietf.org/html/rfc6455#section-5.5.2
-                    https://stackoverflow.com/questions/13456017/what-does-258eafa5-e914-47da-95ca-c5ab0dc85b11-means-in-websocket-protocol
-                */
-                const GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
-                const key = headers['Sec-WebSocket-Key'];
-                const hash = crypto.createHash('sha1');  // 创建一个签名算法为sha1的哈希对象
-
-                hash.update(`${key}${GUID}`);  // 将key和GUID连接后，更新到hash
-                const result = hash.digest('base64'); // 生成base64字符串
-                const header = `HTTP/1.1 101 Switching Protocols\r\nServer: Powered by ${name}@${version}\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-Websocket-Accept: ${result}\r\n\r\n`; // 生成供前端校验用的请求头
-
-                socket.write(header);  // 返回HTTP头，告知客户端校验结果，HTTP状态码101表示切换协议：https://httpstatuses.com/101。
-                // 若客户端校验结果正确，在控制台的Network模块可以看到HTTP请求的状态码变为101 Switching Protocols，同时客户端的ws.onopen事件被触发。
-
-                sockets.push(socket);
-            }
-
-            // 否则就普通的，
-            // 普通的由http服务器提供支持
-            else {
-                socket.end();
-
-            }
-        });
-    });
-
-    // 启动
-    server.listen(port);
-
-    console.log('<i> \x1b[1m\x1b[32m[' + name + '] Loopback: \x1b[36mws://localhost:' + port + '/\x1b[0m\n');
-
-    return handler;
-};
+const net = require('net');
+const crypto = require('crypto');
+
+const headersToJSON = require('./headersToJSON');
+const decodeWsFrame = require('./decodeWsFrame');
+const encodeWsFrame = require('./encodeWsFrame');
+
+module.exports = function (port, name, version) {
+    let sockets = [];
+
+    let handler = {
+        notifyBrowser: (msg) => {
+            for (let socket of sockets) {
+                socket.write(encodeWsFrame(msg));
+            }
+        }
+    };
+
+    const server = net.createServer(socket => {
+
+        // 错误
+        socket.on('error', (error) => {
+            console.log('Connection error:', error.message);
+        });
+
+        // 数据
+        socket.on('data', buffer => {
+            console.log('Connection data:' + (decodeWsFrame(buffer).payloadData?.toString() || "断开连接......"));
+        });
+
+        // 连接
+        socket.once('data', buffer => {
+
+            // 把请求头变成容易操作的json
+            const headers = headersToJSON(buffer.toString());
+
+            // 如果是ws请求
+            // 就需要建立连接
+            if (headers.Upgrade == 'websocket') {
+
+                if (headers['Sec-WebSocket-Version'] !== '13') {
+                    console.log('\r\n警告：当前WebSocket版本为' + headers['Sec-WebSocket-Version'] + "，可能存在兼容问题~\r\n");
+                }
+
+                // 开始连接
+                /*
+                    协议中规定的校验用GUID，可参考如下链接：
+                    https://tools.ietf.org/html/rfc6455#section-5.5.2
+                    https://stackoverflow.com/questions/13456017/what-does-258eafa5-e914-47da-95ca-c5ab0dc85b11-means-in-websocket-protocol
+                */
+                const GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
+                const key = headers['Sec-WebSocket-Key'];
+                const hash = crypto.createHash('sha1');  // 创建一个签名算法为sha1的哈希对象
+
+                hash.update(`${key}${GUID}`);  // 将key和GUID连接后，更新到hash
+                const result = hash.digest('base64'); // 生成base64字符串
+                const header = `HTTP/1.1 101 Switching Protocols\r\nServer: Powered by ${name}@${version}\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-Websocket-Accept: ${result}\r\n\r\n`; // 生成供前端校验用的请求头
+
+                socket.write(header);  // 返回HTTP头，告知客户端校验结果，HTTP状态码101表示切换协议：https://httpstatuses.com/101。
+                // 若客户端校验结果正确，在控制台的Network模块可以看到HTTP请求的状态码变为101 Switching Protocols，同时客户端的ws.onopen事件被触发。
+
+                sockets.push(socket);
+            }
+
+            // 否则就普通的，
+            // 普通的由http服务器提供支持
+            else {
+                socket.end();
+
+            }
+        });
+    });
+
+    // 启动
+    server.listen(port);
+
+    console.log('<i> \x1b[1m\x1b[32m[' + name + '] Loopback: \x1b[36mws://localhost:' + port + '/\x1b[0m\n');
+
+    return handler;
+};