@maiyunnet/kebab 2.0.0

package/types/index.d.ts

@@ -0,0 +1,283 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2022-07-22 13:44:12
+ * Last: 2022-07-22 13:44:12, 2023-5-2 21:12:32, 2023-12-14 11:43:09
+ */
+import * as http from 'http';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/** --- 除非确定是不可知的 Json，否则不能使用 --- */
+export type Json = any;
+
+/* eslint-enable */
+
+/** --- 数据库值的类型 --- */
+export type DbValue = string | number | null | Record<string, Json>;
+
+/** --- mod ls 对象 --- */
+export declare class Rows<T> implements Iterable<T> {
+
+    /** --- 总行数 --- */
+    public get length(): number;
+
+    /** --- 通过索引获取一个对象 --- */
+    public item(index: number): T;
+
+    /** --- 转换为数组对象 --- */
+    public toArray(): Array<Record<string, DbValue>>;
+
+    public [Symbol.iterator](): Iterator<T>;
+
+}
+
+/** --- 虚拟机配置对象 --- */
+export interface IVhost {
+    readonly 'name': string;
+    readonly 'domains': string[];
+    readonly 'root': string;
+    readonly 'remark': string;
+}
+
+/** --- 上传的文件信息对象 --- */
+export interface IPostFile {
+    readonly 'name': string;
+    readonly 'origin': string;
+    readonly 'size': number;
+    readonly 'path': string;
+}
+
+/** --- 动态目录配置文件 --- */
+export interface IConfig {
+    'set': {
+        'timezone': number;
+        'mustHttps': boolean;
+        'cacheTtl': number;
+
+        'staticVer': string;
+        'staticPath': string;
+        'staticPathFull': string;
+
+        [key: string]: Json;
+    };
+    'const': IConfigConst;
+    'db': IConfigDb;
+    'jwt': IConfigJwt;
+    'kv': IConfigKv;
+    'route': Record<string, string>;
+    'session': {
+        'name': string;
+        'ttl': number;
+        'ssl': boolean;
+    };
+    'sql': IConfigSql;
+    'dns': Record<string, IConfigDns>;
+    'lang': IConfigLang;
+    's3': Record<string, IConfigS3>;
+    'turnstile': IConfigTurnstile;
+
+    [key: string]: Record<string, Json>;
+}
+
+/** --- 动配数据库 --- */
+export interface IConfigLang {
+    'list': string[];
+    'direct': string[];
+}
+
+/** --- 动配对象存储信息 --- */
+export interface IConfigS3 {
+    /** --- cf r2 要用 --- */
+    'account'?: string;
+    'sid': string;
+    'skey': string;
+    'region': string;
+    'bucket': string;
+}
+
+/** --- 动配对象存储信息 --- */
+export interface IConfigTurnstile {
+    'CF': {
+        'sid': string;
+        'skey': string;
+    },
+    'TENCENT': {
+        'sid': string;
+        'skey': string;
+        'aid': string;
+        'akey': string;
+    }
+}
+
+/** --- 动配数据库 --- */
+export interface IConfigDb {
+    'host': string;
+    'port': number;
+    'charset': string;
+    'name': string;
+
+    'user': string;
+    'pwd': string;
+}
+
+/** --- Jwt 信息 --- */
+export interface IConfigJwt {
+    'name': string;
+    'ttl': number;
+    'ssl': boolean;
+    'secret': string;
+    'auth': boolean;
+}
+
+/** --- DNS --- */
+export interface IConfigDns {
+    'sid': string;
+    'skey': string;
+}
+
+/** --- 动配 kv --- */
+export interface IConfigKv {
+    'host': string;
+    'port': number;
+    'index': number;
+    'pre': string;
+
+    'user': string;
+    'pwd': string;
+}
+
+/** --- 动配 sql --- */
+export interface IConfigSql {
+    'pre': string;
+}
+
+/** --- 动配常量 --- */
+export interface IConfigConst {
+    'path': string;
+    'qs': string;
+    'startTime': bigint;
+    'startMemory': number;
+
+    // --- 环境判断 ---
+
+    'mobile': boolean;
+    'wechat': boolean;
+    'https': boolean;
+    'host': string;
+    'hostname': string;
+    'hostport': number;
+    'uri': IUrlParse;
+
+    // --- 服务端用的路径 ---
+
+    'rootPath': string;
+    'modPath': string;
+    'ctrPath': string;
+    'viewPath': string;
+    'dataPath': string;
+    'wsPath': string;
+
+    // --- 前端用的路径 ---
+
+    'urlBase': string;
+    'urlStc': string;
+    'urlFull': string;
+    'urlStcFull': string;
+}
+
+/** --- http headers --- */
+/* eslint-disable @typescript-eslint/naming-convention */
+export type THttpHeaders = http.IncomingHttpHeaders & {
+    'http-version'?: '1.1' | '2.0';
+    'http-code'?: number;
+    'http-url'?: string;
+};
+/* eslint-enable */
+
+/** --- Net Cookie 对象 --- */
+export interface ICookie {
+    'name': string;
+    'value': string;
+    /** --- 有效期秒级时间戳 --- */
+    'exp': number;
+    'path': string;
+    'domain': string;
+    'secure': boolean;
+    'httponly': boolean;
+}
+
+export interface IUrlParse {
+    'protocol': string | null;
+    'auth': string | null;
+    'user': string | null;
+    'pass': string | null;
+    'host': string | null;
+    'hostname': string | null;
+    'port': string | null;
+    'pathname': string;
+    'path': string | null;
+    'query': string | null;
+    'hash': string | null;
+}
+
+export interface IModUnionItem {
+    'field': string;
+    'where'?: any;
+}
+
+// -------------------------
+// -------- zip lib --------
+// -------------------------
+
+export interface IZipItem {
+    'name': string;
+    'compressedSize': number;
+    'uncompressedSize': number;
+    'date': Date;
+    'isFile': boolean;
+    'isDirectory': boolean;
+    'path': string;
+}
+
+export interface IZipStats {
+    'compressedSize': number;
+    'uncompressedSize': number;
+    'date': Date;
+    'isFile': boolean;
+    'isDirectory': boolean;
+}
+
+export interface IZipOutputByType {
+    'base64': string;
+    'string': string;
+    'text': string;
+    'binarystring': string;
+    'array': number[];
+    'uint8array': Uint8Array;
+    'arraybuffer': ArrayBuffer;
+    'blob': Blob;
+    'nodebuffer': Buffer;
+}
+
+export type TZipOutputType = keyof IZipOutputByType;
+
+export interface IZipInputByType {
+    'base64': string;
+    'string': string;
+    'text': string;
+    'binarystring': string;
+    'array': number[];
+    'uint8array': Uint8Array;
+    'arraybuffer': ArrayBuffer;
+    'blob': Blob;
+    'nodebuffer': Buffer;
+}
+
+export type TZipInputType = keyof IZipInputByType;
+
+export type TZipInputFileFormat = IZipInputByType[keyof IZipInputByType];
+
+export interface IZipMetadata {
+    'percent': number;
+    'currentFile': string | null;
+}

package/www/example/ctr/main.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const ctr = __importStar(require("~/sys/ctr"));
+class default_1 extends ctr.Ctr {
+    index() {
+        return `<a href="${this._config.const.urlBase}test">Hello world! Click here to visit demo.</a>`;
+    }
+}
+exports.default = default_1;

package/www/example/ctr/main.ts

@@ -0,0 +1,9 @@
+import * as ctr from '~/sys/ctr';
+
+export default class extends ctr.Ctr {
+
+    public index(): string {
+        return `<a href="${this._config.const.urlBase}test">Hello world! Click here to visit demo.</a>`;
+    }
+
+}

package/www/example/ctr/middle.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const ctr = __importStar(require("~/sys/ctr"));
+class default_1 extends ctr.Ctr {
+    onLoad() {
+        if (this._config.const.path !== 'test/middle') {
+            return true;
+        }
+        return '_action: ' + this._action + "<br><br>In fact, the middle method does not exist in the test controller, which uses Kebab's middle structure to preprocess requests.";
+    }
+    onUnload(rtn) {
+        if (!Array.isArray(rtn)) {
+            return rtn;
+        }
+        if (rtn[0] !== -101) {
+            return rtn;
+        }
+        rtn.push({
+            'middle': 'unload'
+        });
+        return rtn;
+    }
+}
+exports.default = default_1;

package/www/example/ctr/middle.ts

@@ -0,0 +1,26 @@
+import * as ctr from '~/sys/ctr';
+import * as types from '~/types';
+
+export default class extends ctr.Ctr {
+
+    public onLoad(): string | boolean {
+        if (this._config.const.path !== 'test/middle') {
+            return true;
+        }
+        return '_action: ' + this._action + "<br><br>In fact, the middle method does not exist in the test controller, which uses Kebab's middle structure to preprocess requests.";
+    }
+
+    public onUnload(rtn: string | boolean | types.DbValue[]): string | boolean | types.DbValue[] {
+        if (!Array.isArray(rtn)) {
+            return rtn;
+        }
+        if (rtn[0] !== -101) {
+            return rtn;
+        }
+        rtn.push({
+            'middle': 'unload'
+        });
+        return rtn;
+    }
+
+}