xpe 0.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 wangbo
+
+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

@@ -0,0 +1,71 @@
+# PDD Framework
+
+> PDD⭐ - 是数企官方开发的纯前端容器框架，在Typescript赋能下基于IOC开发出的OOP框架，同时通过内置模块可快速实现AOP开发。
+
+### PDD能带来什么：
+
+- 统一代码，规范化。
+- 更好的拓展、易于维护。
+- 提升开发效率，开发只需考虑解决具体功能即可。
+
+### 为什么要做PDD：
+- 1.由于前端只有Vue/React/NG等MVVM框架，缺少像Spring、Laravel、Django这类架构更清晰、生态更完善的框架 [**当然现在有了像Nest.js、Midway.js这类Node.js服务端框架**] ，导致绝大多数纯前端对开发项目的认知不足。
+- 2.前端缺少较为完整的开发方案，导致整体项目“乱”-高耦合、低聚合。PDD给前端项目开发整体规范化约束。
+- 3.提升可维护性，目前PDD从整体配置到应用层面的拓展都有着明确的规定。大家都怕见到“宝藏代码”，“千人千面”这些给开发者造成的困扰无异乎抛出异常缺没有指出异常具体位置，很难维护。
+
+### 如何使用：
+```shell
+# 通过npm方式安装
+npm i pdd
+# 通过cnpm方式安装 
+cnpm i pdd 
+# 通过yarn方式安装
+yarn add pdd 
+# 通过pnpm方式安装，推荐
+pnpm add pdd 
+```
+> 集成到现有框架中，以Vue3+TS项目为模板来说
+```typescript
+// main.ts
+/********** PDD Start **********/
+import Application from 'pdd'
+// PDD AppConfig 获取App配置文件
+import AppConfig from './app/config/AppConfig'
+// PDD Setting Config
+Application.setAppConfig(AppConfig)
+// PDD Run
+Application.run()
+// 如需使用日志系统
+import { Log } from 'pdd'
+// 日志初始化配置
+Log.init({
+	// 使用web-sql方式存储
+	storage:'WEB_SQL',
+	// 存储的总条数，再超出范围后会将最先存储的日志给替换，请参照日志系统文档
+	total:10000,
+	// 控制台打印的级别，error及以下的级别在控制台打印，默认为debug级别，设置为false时则全部级别不在控制台打印
+	console:'error'
+})
+// 如需使用任务系统
+import { Job } from 'pdd'
+// 启动任务系统，具体细节请参照任务系统文档
+Job.boot()
+```
+> 更多使用方法参照 [官方文档]: https://jxbse4s2oz1.feishu.cn/wiki/wikcnX8DSYtb1agME6mxb6NRfrQ
+
+### ChangeLog：
+> #### Version 0.3.20
+> 1. 添加中间件上下文
+> 2. http方法参数处理更新
+> #### Version 0.3.15
+> 1. 请求中间件和响应中间件添加上下文。
+> 2. 请求方法添加fetch方法，返回为上下文。
+> #### Version 0.3.14
+> 1. $http.send方法处理自定义request headers会覆盖自动携带数据问题。
+> #### Version 0.3.13
+> 1. GET去除携带Content-Type
+> #### Version 0.3.7
+> 1. 启动BUG处理。
+> #### Version 0.3.6
+> 1. 对`Application`、`ServiceProvider`、`HttpService`、`Middleware`、`Container`等类型进行了深度优化。
+> 2. 对`Pipeline`和`Log`部分代码重构，`Pipeline`做类似`Java lite-flow`组合式、并联、串联校验，`Log`使用三方`Dexie.js`处理SQL处理。

package/framework/es/core/Application.d.ts

@@ -0,0 +1,126 @@
+import Container from './Container/Container';
+import type { UtilityClass, UtilityObject } from './Type/utility';
+import type { APP_CONFIG, IServiceProvider } from './Type/types';
+/**
+ * Application 核心应用
+ * @extends Container
+ * @author SunnyXu <xy@ztes.com>
+ */
+export default class Application extends Container {
+    private static VERSION;
+    private adapters;
+    private providers;
+    /**
+     * lifecycle
+     * 生命周期
+     * @private
+     */
+    private static lifecycle;
+    /**
+     * getterProviders Providers 获取器
+     */
+    getterProviders(): IServiceProvider[];
+    /**
+     * getProviders
+     * 获取
+     * @protected
+     */
+    private static getProviders;
+    /**
+     * setterProviders Providers
+     * 设置器
+     * @param providers
+     */
+    setterProviders(providers: IServiceProvider[]): void;
+    /**
+     * setProviders
+     * 设置
+     * @param providers
+     */
+    static setProviders(providers: IServiceProvider[]): void;
+    /**
+     * registerProvider
+     * @description 注册服务提供者
+     * @param provider
+     */
+    static registerProvider(provider: any): void;
+    /**
+     * registerProviders
+     * 批量注册
+     * @param providers
+     */
+    static registerProviders(providers: IServiceProvider[]): void;
+    /**
+     * config
+     * 配置
+     * @param {Object} config
+     * @param {String} name
+     */
+    static setConfig(name: string, config: UtilityObject): void;
+    /**
+     * getConfig
+     * 获取
+     * @param name
+     * @param {Object} def 默认值
+     */
+    static getConfig(name: string, def?: any): UtilityObject;
+    /**
+     * setAppConfig
+     * 设置App配置
+     * @param config
+     */
+    static setAppConfig(config: APP_CONFIG): void;
+    /**
+     * getAppConfig
+     * 获取App配置
+     * @param name
+     * @description 遵守getAppConfig中参数值和返回值的约定
+     */
+    static getAppConfig<T extends keyof APP_CONFIG>(name: T): APP_CONFIG[T];
+    /**
+     * bindAdapter
+     * 绑定
+     * @param adapter
+     * @param payload
+     */
+    static bindAdapter(adapter: UtilityClass, payload?: UtilityObject): void;
+    /**
+     * setAdapter
+     * 新增
+     * @param adapter
+     * @param instance
+     * @protected
+     */
+    setterAdapter(adapter: UtilityClass, instance: UtilityObject): void;
+    /**
+     * static getAdapter
+     * 获取适配器
+     * @param adapter 必须是个类
+     * @return instance
+     */
+    static getAdapter(adapter: UtilityClass): any;
+    /**
+     * static getAdapter
+     * 适配器 获取器
+     * @param adapter
+     */
+    getterAdapter(adapter: UtilityClass): any;
+    /**
+     * getService
+     * 获取服务实例
+     * @param serviceName
+     */
+    static getService<T>(serviceName: string): T;
+    /**
+     * Application instance
+     * 获取应用实例
+     * @description 应该使用Proxy进行拦截，目前先放行
+     */
+    static getInstance(): InstanceType<typeof Application>;
+    /**
+     * App run
+     * 框架应用运行
+     * @param {CallableFunction} callback
+     */
+    static run(callback?: CallableFunction): void;
+}

package/framework/es/core/Command/Command.d.ts

@@ -0,0 +1,7 @@
+import type { IHelper } from '../Type/types';
+export default abstract class Command {
+    protected payload: any[];
+    protected $helper: IHelper;
+    protected constructor(...payload: any[]);
+    abstract handle(...args: any[]): any | Promise<any> | void;
+}

package/framework/es/core/Container/Container.d.ts

@@ -0,0 +1,80 @@
+import type { ClassConstructor } from '../Type/utility';
+import type { IContainer } from '../Type/types';
+/**
+ * Class Container
+ * 容器类
+ * @author SunnyXu <xy@ztes.com>
+ */
+export default class Container implements IContainer {
+    protected static instance: unknown;
+    protected instances: Map<any, any>;
+    protected bindings: Record<string, any>;
+    protected aliases: Record<string, any>;
+    /**
+     * bind 绑定实体
+     * @param {String|Array} abstract
+     * @param {*} concrete
+     */
+    bind(abstract: string | string[], concrete: any): void;
+    /**
+     * make 创建类的实例/获取对象 create instance/object
+     * @param abstract
+     * @param params
+     * @param shared
+     */
+    make(abstract: string, params?: object | [], shared?: boolean): any;
+    /**
+     * makeClass 创建类
+     * @param name
+     * @param executor
+     * @param params
+     * @param shared
+     */
+    protected makeClass(name: string, executor: ClassConstructor, params: unknown, shared?: boolean): any;
+    /**
+     * makeFunc 创建函数
+     * @param name
+     * @param executor
+     * @param params
+     * @param shared
+     * @protected
+     */
+    protected makeFunc(name: string, executor: CallableFunction, params: unknown, shared?: boolean): any;
+    /**
+     * has as existence
+     * 是否存在标识 existence 的别名
+     * @param {String} name
+     */
+    has(name: string): boolean;
+    /**
+     * existence 存在标识
+     * @param {String} name
+     */
+    existence(name: string): boolean;
+    /**
+     * getAlias 获取别名
+     * @param abstract
+     */
+    getAlias(abstract: string): any;
+    /**
+     * get 获取实例
+     * @param abstract
+     */
+    get(abstract: string): any;
+    /**
+     * singleton 单例
+     * @param abstract
+     * @param concrete
+     */
+    singleton(abstract: string, concrete: any): void;
+    /**
+     * getInstance 获取实例
+     *
+     */
+    static getInstance<Instance>(): Container | Instance;
+    /**
+     * proxyInstance 代理实例
+     *
+     */
+    protected proxyInstance(): this;
+}

package/framework/es/core/Contracts/AxiosAdapter.d.ts

@@ -0,0 +1,12 @@
+import { HttpAdapterInterface } from '../Type/adapters';
+/**
+ * Class AxiosAdapter
+ * @description axios适配器，适配器主要完成
+ */
+export default class AxiosAdapter extends HttpAdapterInterface<{}> {
+    /**
+     * Method request
+     * @returns Promise
+     */
+    request(): Promise<unknown>;
+}

package/framework/es/core/Helper/Helper.d.ts

@@ -0,0 +1,43 @@
+import Service from '../Service/Service';
+import type { IResponseReturn, TResponseDataReturn, IHelper } from '../Type/types';
+/**
+ * Class Helper
+ * @extends Service
+ */
+export default class Helper extends Service implements IHelper {
+    env(): Record<any, any>;
+    private webStorage;
+    /**
+     * Local storage
+     * @param name
+     * @param payload
+     */
+    storage(name?: string, payload?: any): any | Record<any, any>;
+    cookie(): void;
+    /**
+     * Session storage
+     * @param name
+     * @param payload
+     */
+    session(name?: string, payload?: any): any | Record<any, any>;
+    /**
+     * Method http
+     * 发起一个http请求
+     * @param api
+     * @param data
+     * @param handle
+     */
+    http(api: any, data: any, handle: any): Promise<TResponseDataReturn | IResponseReturn | undefined>;
+    /**
+     * 发送一个Http请求
+     * @param api
+     * @param data
+     * @param handle
+     * @param config
+     * @param returnResponse
+     */
+    send(api: any, data: any, handle: any, config: any, returnResponse?: boolean): Promise<TResponseDataReturn | IResponseReturn>;
+    checkAuth(): void;
+    cookies(name: string): Record<any, any>;
+    cookies(name: string, payload?: any): void;
+}

package/framework/es/core/Helper/Storage/WebStorage.d.ts

@@ -0,0 +1,71 @@
+declare type Type = "localStorage" | "sessionStorage";
+/**
+ * Class WebStorage
+ * 浏览器存储
+ */
+export default class WebStorage {
+    type: Type;
+    storage: Storage;
+    /**
+     * constructor
+     * @param {String} type 存储类型
+     */
+    constructor({ type }: {
+        type: Type;
+    });
+    /**
+     * get get|getAll storage
+     * @param key
+     */
+    get(key?: string): string | any;
+    /**
+     * set
+     * Set storage 保持/设置数据
+     * @param key
+     * @param value
+     */
+    set(key: string, value: string | any[] | Record<any, any>): void;
+    /**
+     * save
+     * Save storage as set set的别名
+     * @param key
+     * @param value
+     */
+    save(key: string, value: string | any[] | Record<any, any>): void;
+    /**
+     * delete
+     * Delete storage 删除一个或数组内多个
+     * @param {String|Array<string>} key
+     */
+    delete(key: string | string[]): void;
+    /**
+     * remove
+     * Remove storage as delete delete的别名
+     * @param key
+     */
+    remove(key: string | string[]): void;
+    /**
+     * clear
+     * Clear storage 清空
+     */
+    clear(): void;
+    /**
+     * keys
+     * Get storage keys 获取全部键
+     * @return keys
+     */
+    keys(): string[];
+    /**
+     * getAll
+     * Get storage key & val 获取全部键值对
+     */
+    getAll(): Record<any, any>;
+    /**
+     * setConfig
+     * @param type
+     */
+    setConfig({ type }: {
+        type: Type;
+    }): void;
+}
+export {};

package/framework/es/core/Libs/Exception.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Exception Class
+ * 目前原生的错误类型
+ * Error [一般错误类型]
+ * SyntaxError [语法错误]
+ * ReferenceError [不存在的变量]
+ * RangeError [超出有效范围]
+ * TypeError [非预期类型]
+ * URIError [URI参数错误]
+ * EvalError [eval函数没有正确执行]
+ * Example: throw new Exception() catch(error) error.name,error.message,error.code,error.stack
+ */
+export default class Exception extends Error {
+    name: string;
+    message: string;
+    code: number;
+    /**
+     *
+     * @param {String} name 错误名称
+     * @param {String} message 错误提示
+     * @param {Number} code 错误码
+     */
+    constructor(name: string, message: string, code?: number);
+}

package/framework/es/core/Libs/Lib.d.ts

@@ -0,0 +1,72 @@
+declare type variableType = "string" | "number" | "object" | "undefined" | "function" | "boolean" | "bigInt" | "symbol";
+declare type TrimType = "R" | "L" | "";
+/**
+ * Class Lib
+ * 基础函数库，Lodash、Underscore... So big
+ */
+export default class Lib {
+    /**
+     * typeOf 判断变量类型
+     * @param value
+     * @param type
+     */
+    static typeOf<T>(value: unknown, type: variableType): value is T;
+    /**
+     * getTag 判断变量类型
+     * @param value
+     */
+    static getTag(value: unknown): string;
+    /**
+     * isFunction 是否函数
+     * @param {Function} value
+     * @return {Boolean}
+     */
+    static isFunction(value: unknown): value is typeof Function;
+    /**
+     * isString 是否字符串
+     * @param {String} value
+     * @return {Boolean}
+     */
+    static isString(value: unknown): value is string;
+    /**
+     * isNumber 是否数字
+     * @param value
+     * @return {Boolean}
+     */
+    static isNumber(value: unknown): value is number;
+    /**
+     * isObject 是否对象
+     * @param {Object} value
+     */
+    static isObject(value: unknown): value is Record<any, any>;
+    /**
+     * isObject 是否Undefined
+     * @param {*} value
+     * @return boolean
+     */
+    static isUndefined(value: unknown): boolean;
+    /**
+     * isNull 是否Null
+     * @param value
+     */
+    static isNull(value: unknown): boolean;
+    /**
+     * isEmpty 是否空
+     * 目前只对 null undefined '' {} [] 做处理
+     * @param value
+     */
+    static isEmpty(value: unknown): boolean;
+    /**
+     * isClass 是否类
+     * @param value
+     */
+    static isClass(value: unknown): boolean;
+    /**
+     * 字符串去除首尾字符
+     * @param str 字符串
+     * @param char 字符
+     * @param type 类型
+     */
+    static strTrim(str: string, char: string, type?: TrimType): string;
+}
+export {};

package/framework/es/core/Provider/CommandProvider.d.ts

@@ -0,0 +1,4 @@
+import ServiceProvider from "./ServiceProvider";
+export default class CommandProvider extends ServiceProvider {
+    register(): void;
+}

package/framework/es/core/Provider/HelperProvider.d.ts

@@ -0,0 +1,4 @@
+import ServiceProvider from "./ServiceProvider";
+export default class HelperProvider extends ServiceProvider {
+    register(): void;
+}

package/framework/es/core/Provider/HttpProvider.d.ts

@@ -0,0 +1,13 @@
+import ServiceProvider from "./ServiceProvider";
+/**
+ * @name HttpProvider
+ * @description HTTP服务提供者，对HTTP服务进行注册
+ */
+export default class HttpProvider extends ServiceProvider {
+    /**
+     * Method Register
+     * 注册服务
+     * @protected
+     */
+    register(): void;
+}

package/framework/es/core/Provider/ServiceProvider.d.ts

@@ -0,0 +1,15 @@
+import type { IApplicationInstance } from '../Type/types';
+export default abstract class ServiceProvider {
+    protected app: import("../Type/types").IApplication;
+    /**
+     * constructor
+     * @param app Application instance
+     *
+     */
+    constructor(app: IApplicationInstance);
+    /**
+     * register
+     * 注册 provider
+     */
+    register(): void;
+}