npm - jj.js - Versions diffs - 0.8.7 → 0.9.0 - Mend

jj.js 0.8.7 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/lib/tpl/exception.js CHANGED Viewed

@@ -1,65 +1,65 @@
-module.exports = `<!doctype html>
-<html>
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"/>
-    <title>jj.js</title>
-    <style type="text/css">
-        * { padding: 0; margin: 0; }
-        body { background: #fff; font-family: "Microsoft Yahei","Helvetica Neue",Helvetica,Arial,sans-serif; color: #333; font-size: 16px; }
-        .message { padding: 24px 48px; }
-        .message h1 { font-size: 36px; font-weight: normal; line-height: 50px; margin-bottom: 12px; }
-        .message h3 { line-height: 1.8em; font-size: 28px; font-weight: normal; }
-        .message .code {
-            line-height: 1.5em;
-            font-size: 12px;
-            white-space: pre-wrap;
-            background: #303030;
-            color: #f1f1f1;
-            padding: 10px .2em 10px 3.2em;
-            border-radius: 2px;
-            -moz-box-shadow: inset 0 0 10px #000;
-            box-shadow: inset 0 0 10px #000;
-            counter-reset: line {$begin};
-        }
-        .message .code .line {
-            display: block;
-            padding-left: 1em;
-            padding-right: 1em;
-            min-height: 1.5em;
-            position: relative;
-        }
-        .message .code .line:before {
-            counter-increment: line;
-            content: counter(line);
-            display: inline-block;
-            box-sizing: border-box;
-            border-right: 1px solid #ddd;
-            width: 3.2em;
-            padding-right: .5em;
-            color: #888;
-            text-align: right;
-            position: absolute;
-            left: -3em;
-        }
-        .message .code .line:nth-child({$nth}) {
-            background-color: #efed0b;
-            color: #303030;
-        }
-        .message .code .line:nth-child({$nth}):before {
-            background-color: #efed0b;
-            color: #333;
-        }
-        .message .stack{ line-height: 1.8em; font-size: 14px; }
-    </style>
-</head>
-<body>
-    <div class="message">
-        <h1 class="h0">jj.js</h1>
-        <h3>{$msg}</h3>
-        <pre class="code">{$code}</pre>
-        <h3>Call Stack</h3>
-        <p class="stack">{$stack}</p>
-    </div>
-</body>
+module.exports = `<!doctype html>
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"/>
+    <title>jj.js</title>
+    <style type="text/css">
+        * { padding: 0; margin: 0; }
+        body { background: #fff; font-family: "Microsoft Yahei","Helvetica Neue",Helvetica,Arial,sans-serif; color: #333; font-size: 16px; }
+        .message { padding: 24px 48px; }
+        .message h1 { font-size: 36px; font-weight: normal; line-height: 50px; margin-bottom: 12px; }
+        .message h3 { line-height: 1.8em; font-size: 28px; font-weight: normal; }
+        .message .code {
+            line-height: 1.5em;
+            font-size: 12px;
+            white-space: pre-wrap;
+            background: #303030;
+            color: #f1f1f1;
+            padding: 10px .2em 10px 3.2em;
+            border-radius: 2px;
+            -moz-box-shadow: inset 0 0 10px #000;
+            box-shadow: inset 0 0 10px #000;
+            counter-reset: line {$begin};
+        }
+        .message .code .line {
+            display: block;
+            padding-left: 1em;
+            padding-right: 1em;
+            min-height: 1.5em;
+            position: relative;
+        }
+        .message .code .line:before {
+            counter-increment: line;
+            content: counter(line);
+            display: inline-block;
+            box-sizing: border-box;
+            border-right: 1px solid #ddd;
+            width: 3.2em;
+            padding-right: .5em;
+            color: #888;
+            text-align: right;
+            position: absolute;
+            left: -3em;
+        }
+        .message .code .line:nth-child({$nth}) {
+            background-color: #efed0b;
+            color: #303030;
+        }
+        .message .code .line:nth-child({$nth}):before {
+            background-color: #efed0b;
+            color: #333;
+        }
+        .message .stack{ line-height: 1.8em; font-size: 14px; }
+    </style>
+</head>
+<body>
+    <div class="message">
+        <h1 class="h0">jj.js</h1>
+        <h3>{$msg}</h3>
+        <pre class="code">{$code}</pre>
+        <h3>Call Stack</h3>
+        <p class="stack">{$stack}</p>
+    </div>
+</body>
 </html>`;

package/lib/tpl/jump.js CHANGED Viewed

@@ -1,41 +1,41 @@
-module.exports = `<!doctype html>
-<html>
-<head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"/>
-    <title>跳转提示</title>
-    <style type="text/css">
-        *{ padding: 0; margin: 0; }
-        body{ background: #fff; font-family: "Microsoft Yahei","Helvetica Neue",Helvetica,Arial,sans-serif; color: #333; font-size: 16px; }
-        .message{ padding: 24px 48px; }
-        .message h1{ font-size: 42px; font-weight: normal; line-height: 120px; margin-bottom: 12px; display: none; }
-        .message .h{$state}{ display: initial; }
-        .message .text{ line-height: 1.8em; font-size: 36px; }
-        .message .jump{ padding-top: 10px; }
-        .message .jump a{ color: #333; }
-    </style>
-</head>
-<body>
-    <div class="message">
-        <h1 class="h1">◠‿◠</h1>
-        <h1 class="h0">&gt;﹏&lt;</h1>
-        <p class="text">{$msg}</p>
-        <p class="jump">
-            页面自动 <a id="href" href="{$url}">跳转</a> 等待时间：<b id="wait">{$wait}</b>
-        </p>
-    </div>
-    <script>
-        (function(){
-            var wait = document.getElementById('wait'),
-                href = document.getElementById('href').href;
-            var interval = setInterval(function(){
-                var time = --wait.innerHTML;
-                if(time <= 0) {
-                    location.href = href;
-                    clearInterval(interval);
-                };
-            }, 1000);
-        })();
-    </script>
-</body>
+module.exports = `<!doctype html>
+<html>
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no"/>
+    <title>跳转提示</title>
+    <style type="text/css">
+        *{ padding: 0; margin: 0; }
+        body{ background: #fff; font-family: "Microsoft Yahei","Helvetica Neue",Helvetica,Arial,sans-serif; color: #333; font-size: 16px; }
+        .message{ padding: 24px 48px; }
+        .message h1{ font-size: 42px; font-weight: normal; line-height: 120px; margin-bottom: 12px; display: none; }
+        .message .h{$state}{ display: initial; }
+        .message .text{ line-height: 1.8em; font-size: 36px; }
+        .message .jump{ padding-top: 10px; }
+        .message .jump a{ color: #333; }
+    </style>
+</head>
+<body>
+    <div class="message">
+        <h1 class="h1">◠‿◠</h1>
+        <h1 class="h0">&gt;﹏&lt;</h1>
+        <p class="text">{$msg}</p>
+        <p class="jump">
+            页面自动 <a id="href" href="{$url}">跳转</a> 等待时间：<b id="wait">{$wait}</b>
+        </p>
+    </div>
+    <script>
+        (function(){
+            var wait = document.getElementById('wait'),
+                href = document.getElementById('href').href;
+            var interval = setInterval(function(){
+                var time = --wait.innerHTML;
+                if(time <= 0) {
+                    location.href = href;
+                    clearInterval(interval);
+                };
+            }, 1000);
+        })();
+    </script>
+</body>
 </html>`;

package/lib/types.js ADDED Viewed

@@ -0,0 +1,286 @@
+//------------------系统核心库------------------
+/**
+ * @typedef {Object} Core
+ * @property {typeof import('./app')} App
+ * @property {typeof import('./cache')} Cache
+ * @property {typeof import('./context')} Context
+ * @property {typeof import('./controller')} Controller
+ * @property {typeof import('./cookie')} Cookie
+ * @property {typeof import('./db')} Db
+ * @property {typeof import('./logger')} Logger
+ * @property {typeof import('./middleware')} Middleware
+ * @property {typeof import('./model')} Model
+ * @property {typeof import('./pagination')} Pagination
+ * @property {typeof import('./response')} Response
+ * @property {typeof import('./upload')} Upload
+ * @property {typeof import('./url')} Url
+ * @property {typeof import('./view')} View
+ * @property {Utils} utils
+ */
+//------------------系统App配置---------------------
+/**
+ * @typedef {Object} AppConfig - 系统配置
+ * @property {boolean} [app_debug=true] - 调试模式
+ * @property {boolean} [app_multi=false] - 是否开启多应用
+ * @property {string} [default_app=app] - 默认应用
+ * @property {string} [default_controller=index] - 默认控制器
+ * @property {string} [default_action=index] - 默认方法
+ * @property {string} [common_app=common] - 公共应用，存放公共模型及逻辑
+ * @property {string} [controller_folder=controller] - 控制器目录名
+ * @property {(string|boolean)} [static_dir=''] - 静态文件目录，相对于应用根目录，为空或false时，关闭静态访问
+ * @property {(string|boolean|null|object)} [koa_body=null] - koa-body配置参数，为''、null、false时，关闭koa-body
+ * @property {string} [base_dir] - 应用根目录（会自动计算）
+ */
+/**
+ * @typedef {Object} ViewConfig - 模板配置
+ * @property {string} [view_folder=view] - 模板目录名
+ * @property {string} [view_depr='/'] - 模版文件名分割符，'/'代表二级目录
+ * @property {string} [view_ext='.htm'] - 模版文件后缀
+ * @property {string} [view_engine=art-template] - 默认模版引擎，字符串或引擎类
+ * @property {object} [view_filte={}] - 模版函数
+ */
+/**
+ * @typedef {Object} DbConfigItem - 数据库参数
+ * @property {string} [type=mysql] - 数据库类型
+ * @property {string} [host='127.0.0.1'] - 服务器地址
+ * @property {string} [database=jj] - 数据库名
+ * @property {string} [user=root] - 数据库用户名
+ * @property {string} [password=''] - 数据库密码
+ * @property {string} [port=''] - 数据库连接端口
+ * @property {string} [charset=utf8] - 数据库编码默认采用utf8
+ * @property {string} [prefix=jj_] - 数据库表前缀
+ */
+/**
+ * @typedef {object} DbConfig - 数据库配置
+ * @property {DbConfigItem} default - 数据库参数
+ */
+/**
+ * @callback LogHandle - 日志驱动
+ * @param {string} level - 日志级别
+ * @param {array} args - 日志数据，支持多个，支持对象
+ */
+/**
+ * @typedef {object} LogConfig - 日志配置
+ * @property {array} [log_level] - 允许输出的日志级别
+ * @property {LogHandle} [log_handle] - 日志驱动
+ */
+/**
+ * @typedef {Object} CacheConfig - 缓存配置
+ * @property {number} [cache_time='60 * 60 * 24'] - 缓存时间，默认1天，为空或false则为10年
+ * @property {number} [clear_time=undefined] - 缓存自动清理周期，undefined: 清理一次, 0: 关闭自动清理, >0: 为周期时间，单位秒
+ */
+/**
+ * @typedef {Object} PageConfig - 分页配置
+ * @property {string} [page_key=page] - 分页标识
+ * @property {string} [key_origin=query] - page_key来源
+ * @property {number} [page_size=10] - page_key来源
+ * @property {number} [page_length=5] - page_key来源
+ * @property {string} [url_page] - page_key来源
+ * @property {string} [url_index] - page_key来源
+ * @property {string} [index_tpl] - 首页模板
+ * @property {string} [end_tpl] - 末页模板
+ * @property {string} [prev_tpl] - 上一页模板
+ * @property {string} [next_tpl] - 下一页模板
+ * @property {string} [list_tpl] - 数字页模板
+ * @property {string} [active_tpl] - 当前页模板
+ * @property {string} [info_tpl] - 分页信息模板
+ * @property {string} [template] - 渲染模板
+ */
+/**
+ * @typedef {Object} RouteConfigItem - 路由配置
+ * @property {string} [method=all] - 请求方法，支持['all', 'get', 'put', 'post', 'patch', 'delete', 'del']
+ * @property {string} url - 请求url，支持变量正则，详细参考@koa/router
+ * @property {(string|Middleware)} path - 响应地址(支持智能解析)或中间件函数，如果为中间件函数，则不会再执行后续代码
+ * @property {string} [type='AppConfig.controller_folder'] - 响应类型，即path对应的类型，支持controller、middleware、view(ViewConfig.view_folder)
+ * @property {string} [name] - 路由命名，命一个名字后，可以使用Url类反向编译路由url
+ */
+/**
+ * @typedef {RouteConfigItem[]} RouteConfig - 路由配置
+ */
+/**
+ * @typedef {import('cookies').SetOption} CookieConfig - Cookie配置，一般不用设置
+ */
+/**
+ * @typedef {Object} TplConfig - 跳转、调试模板配置
+ * @property {string} [jump] - 跳转模板，默认require('./tpl/jump')
+ * @property {string} [exception] - 调试异常输出模板，默认require('./tpl/exception')
+ */
+/**
+ * @typedef {Object} Config - 系统配置
+ * @property {AppConfig} [app]
+ * @property {ViewConfig} [view]
+ * @property {DbConfig} [db]
+ * @property {LogConfig} [log]
+ * @property {CacheConfig} [cache]
+ * @property {PageConfig} [page]
+ * @property {RouteConfig} [routes]
+ * @property {CookieConfig} [cookie]
+ * @property {TplConfig} [tpl]
+ */
+//------------------分页类--------------------
+/**
+ * @typedef {typeof import('./pagination')} Pagination - 分页类
+ * @typedef {typeof import('./pagination').prototype} PaginationInstance - 分页类实例
+ */
+//------------------数据库类--------------------
+/**
+ * @typedef {import('mysql').Pool} Pool - 连接池
+ * @typedef {import('mysql').PoolConfig} PoolConfig - 连接池配置
+ * @typedef {import('mysql').PoolConnection} PoolConnection - 连接池连接
+ * @typedef {import('mysql').QueryOptions} QueryOptions - 查询参数
+ * @typedef {import('mysql').OkPacket} OkPacket - 数据库查询结果
+ * @typedef {Object} RowData - 单条数据
+ * @typedef {Array<RowData>} ListData - 多条数据
+ * @typedef {Object} FieldInfo - 字段信息
+ * @property {string} Field
+ * @property {string} Type
+ * @property {string} Null
+ * @property {string} Key
+ * @property {string} Default
+ * @property {string} Extra
+ * @typedef {Map<Pool>} PoolMap
+ */
+//------------------上传类--------------------
+/**
+ * @typedef {Object} UploadData
+ * @property {string} [filename]
+ * @property {string} [extname]
+ * @property {string} [savename]
+ * @property {string} [filepath]
+ * @property {string} [name]
+ * @property {number} [size]
+ * @property {string} [mimetype]
+ * @property {string} [hash]
+ * /
+ *
+/**
+ * @typedef {Object} ValidateRule
+ * @property {number} [size] - 文件大小
+ * @property {string} [ext] - 文件名后缀，多个用','隔开
+ * @property {string} [type] - 文件mimetype，多个用','隔开
+ */
+//------------------系统工具--------------------
+/**
+ * @typedef {Object} Utils
+ * @property {typeof import('./utils/date')} date
+ * @property {typeof import('./utils/error')} error
+ * @property {typeof import('./utils/fs')} fs
+ * @property {typeof import('./utils/md5')} md5
+ * @property {typeof import('./utils/str')} str
+ */
+//------------------系统Context--------------------
+/**
+ * @typedef {import('koa').Context} Context
+ * @typedef {import('koa').Middleware} Middleware
+ */
+//------------------Ctx系统基类--------------------
+class Ctx {
+    constructor() {
+        /**
+         * @desc 系统缓存类
+         * @type {typeof import('./cache')}
+         */
+        this.$cache;
+        /**
+         * @type {typeof import('./context').prototype}
+         */
+        this.$context;
+        /**
+         * @type {typeof import('./controller').prototype}
+         */
+        this.$controller;
+        /**
+         * @type {typeof import('./cookie').prototype}
+         */
+        this.$cookie;
+        /**
+         * @type {typeof import('./db').prototype}
+         */
+        this.$db;
+        /**
+         * @type {typeof import('./logger')}
+         */
+        this.$logger;
+        /**
+         * @type {typeof import('./middleware').prototype}
+         */
+        this.$middleware;
+        /**
+         * @type {typeof import('./model').prototype}
+         */
+        this.$model;
+        /**
+         * @type {typeof import('./pagination').prototype}
+         */
+        this.$pagination;
+        /**
+         * @type {typeof import('./response').prototype}
+         */
+        this.$response;
+        /**
+         * @type {typeof import('./upload').prototype}
+         */
+        this.$upload;
+        /**
+         * @type {typeof import('./url').prototype}
+         */
+        this.$url;
+        /**
+         * @type {typeof import('./view').prototype}
+         */
+        this.$view;
+        /**
+         * @type {Utils}
+         */
+        this.$utils;
+        /**
+         * @type {import('./config')}
+         */
+        this.$config;
+    }
+}
+/**
+ * @module Types
+ */
+module.exports = Ctx;

package/lib/upload.js CHANGED Viewed

@@ -2,41 +2,85 @@ const pt = require('path');
 const fs = require('fs');
 const utils = require('./utils/utils');
 const Context = require('./context');
+const {app: cfg_app} = require('./config');
+/**
+ * @typedef {import('formidable').Files} Files
+ * @typedef {import('formidable').File} File
+ * @typedef {import('./types').UploadData} UploadData
+ * @typedef {import('./types').ValidateRule} ValidateRule
+ */
+/**
+ * @extends Context
+ */
 class Upload extends Context
 {
+    /**
+     * 设置上传文件
+     * @public
+     * @param {(string|File)} file
+     * @returns {this}
+     */
     file(file) {
-        this._file = typeof file == 'string' ? this.getFile(file) : file;
+        /**
+         * @private
+         */
+        this._file = /** @type {File} */ (typeof file == 'string' ? this.getFile(file) : file);
         return this;
     }
+    /**
+     * 设置检查规则
+     * @public
+     * @param {ValidateRule} [rule]
+     * @returns {this}
+     */
     validate(rule={}) {
+        /**
+         * @private
+         */
         this._rule = rule;
         return this;
     }
+    /**
+     * 设置存储文件名或函数
+     * @public
+     * @param {(string|function)} [name]
+     * @returns {this}
+     */
     rule(name) {
+        /**
+         * @private
+         */
         this._name = name;
         return this;
     }
+    /**
+     * 保存文件到目录
+     * @public
+     * @param {string} [dir]
+     * @returns {Promise<(boolean|UploadData)>}
+     */
     async save(dir) {
         if(!this.check()) {
             return false;
         }
         let savename = '';
-        if(this._name || this._name === 0) {
+        if(this._name) {
             savename = (typeof this._name == 'function' ? this._name() : this._name) + '';
         } else {
-            savename = utils.date.format('YYYY/mmdd/') + utils.md5(new Date().getTime() + Math.random().toString(36).substr(2));
+            savename = utils.date.format('YYYY/mmdd/') + utils.md5(Date.now() + Math.random().toString(36).substr(2));
         }
         if(!pt.extname(savename)) {
             savename += pt.extname(this._file.originalFilename);
         }
         try {
-            const filePath = pt.join(this.$config.app.base_dir, dir, savename);
+            const filePath = pt.join(cfg_app.base_dir, dir, savename);
             await utils.fs.mkdirs(pt.dirname(filePath));
             const reader = fs.createReadStream(this._file.filepath);
             const writer = fs.createWriteStream(filePath);
@@ -65,14 +109,30 @@ class Upload extends Context
         }
     }
+    /**
+     * 获取上传文件
+     * @public
+     * @param {string} [name] - 为空时，获取所有上传文件
+     * @returns {(File|File[]|Files)}
+     */
     getFile(name) {
         return typeof name == 'string' ? this.ctx.request.files[name] : this.ctx.request.files;
     }
+    /**
+     * 获取错误信息
+     * @public
+     * @returns {string}
+     */
     getError() {
         return this._error;
     }
+    /**
+     * 检查上传文件
+     * @public
+     * @returns {boolean}
+     */
     check() {
         if(!this._file) {
             this._error = '上传文件为找到！';
@@ -104,6 +164,12 @@ class Upload extends Context
         return true;
     }
+    /**
+     * 检查上传文件后缀
+     * @public
+     * @param {(string|array)} ext
+     * @returns {boolean}
+     */
     checkExt(ext) {
         if(typeof ext == 'string') {
             ext = ext.split(',');
@@ -114,6 +180,12 @@ class Upload extends Context
         return true;
     }
+    /**
+     * 检查上传文件mimetype
+     * @public
+     * @param {(string|array)} type
+     * @returns {boolean}
+     */
     checkType(type) {
         if(typeof type == 'string') {
             type = type.split(',');
@@ -124,6 +196,11 @@ class Upload extends Context
         return true;
     }
+    /**
+     * 检查上传图片
+     * @public
+     * @returns {boolean}
+     */
     checkImg() {
         const fileExt = pt.extname(this._file.originalFilename).slice(1).toLowerCase();
         const fileType = this._file.mimetype.toLowerCase().split('/');