fast-vue-multi-pages 1.0.0

package/README.md

@@ -0,0 +1,63 @@
+# fast-vue-multi-pages
+### 快速搭建VUE项目工具类的基本库，主要用于每个功能页面独立生成html，不使用vue单页面功能。
+
+## Install
+```
+npm i fast-vue-multi-pages
+```
+
+## Package.json配置
+
+```
+"dependencies": {
+    "fast-vue-multi-pages": "^1.0.0", //具体版本以npm库更新为准
+}
+```
+
+
+
+## 配置vue.config.js 文件，快速配置VUE项目代码，复制如下代码：
+```
+const {FastVueMultiPages} = require("fast-vue-multi-pages/vue");
+
+const result = FastVueMultiPages.getDefaultVueConfig(__dirname, {
+    projectTitle: "项目标题",
+    projectPagesDir: ["src/user_pages"],
+    projectOutDir: "dist",
+    autoCreateProjectIndexPage: false,
+    autoCreatePageConfigFile: true,
+    buildLevel: 1,
+    httpFinalParams:  {
+        userTest: true,
+    },
+    httpBeforeRequest: function (config) {
+        console.log("httpBeforeRequest", config);
+    },
+    httpAfterRequest: function (response) {
+        console.log("httpAfterRequest", response);
+    },
+    globalConfig: {},
+    injectJsFiles: ["src/js/iconfont.js"],
+    clientStrict: true
+});
+
+module.exports = result;
+```
+
+
+# 使用默认工具类
+
+### 引用库之后，在项目中导入即可，例如：
+```
+import {FastVueMultiTool} from "fast-vue-multi-pages";
+
+FastVueMultiTool.Http.get("接口地址", {
+  orderId: 1
+}).then(result => {
+  if (result.isSuccess()) {
+    console.error(result.getData());
+  } else {
+    console.error(result.getMessage());
+  }
+});
+```

package/dist/cjs/FastVueMultiTool.d.ts

@@ -0,0 +1,60 @@
+import _ from "lodash";
+import { FastVueMultiHttp } from "./http/FastVueMultiHttp";
+import { FastVueMultiStore } from "./other/FastVueMultiStore";
+import { FastVueMultiConfig } from "./vue/FastVueMultiConfig";
+import { FastVueMultiCookie } from "./http/FastVueMultiCookie";
+import { FastVueMultiClipboard } from "./other/FastVueMultiClipboard";
+import { FastVueMultiDate } from "./other/FastVueMultiDate";
+import { FastVueMultiBoolean } from "./other/FastVueMultiBoolean";
+import { FastVueMultiFunction } from "./other/FastVueMultiFunction";
+import { FastVueMultiElement } from "./other/FastVueMultiElement";
+import { FastVueMultiWindow } from "./other/FastVueMultiWindow";
+/**
+ * FastBaseApp 手机APP功能工具类
+ */
+export declare class FastVueMultiTool {
+    /**
+     * 页面配置工具类
+     */
+    static Config: typeof FastVueMultiConfig;
+    /**
+     * 网络请求工具类
+     */
+    static Http: typeof FastVueMultiHttp.Simple;
+    /**
+     * 页面数据缓存工具类
+     */
+    static Store: typeof FastVueMultiStore;
+    /**
+     * cookie操作
+     */
+    static Cookie: typeof FastVueMultiCookie;
+    /**
+     * 剪贴板操作
+     */
+    static Clipboard: typeof FastVueMultiClipboard;
+    /**
+     * Lodash工具类 https://lodash.com/docs/
+     */
+    static Lodash: _.LoDashStatic;
+    /**
+     * 日期类操作
+     */
+    static Date: typeof FastVueMultiDate;
+    /**
+     * boolean工具类
+     */
+    static Boolean: typeof FastVueMultiBoolean;
+    /**
+     * function工具类
+     */
+    static Function: typeof FastVueMultiFunction;
+    /**
+     * html元素操作工具类
+     */
+    static Element: typeof FastVueMultiElement;
+    /**
+     * window对象相关操作
+     */
+    static Window: typeof FastVueMultiWindow;
+}

package/dist/cjs/FastVueMultiTool.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FastVueMultiTool = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const FastVueMultiHttp_1 = require("./http/FastVueMultiHttp");
+const FastVueMultiStore_1 = require("./other/FastVueMultiStore");
+const FastVueMultiConfig_1 = require("./vue/FastVueMultiConfig");
+const FastVueMultiCookie_1 = require("./http/FastVueMultiCookie");
+const FastVueMultiClipboard_1 = require("./other/FastVueMultiClipboard");
+const FastVueMultiDate_1 = require("./other/FastVueMultiDate");
+const FastVueMultiBoolean_1 = require("./other/FastVueMultiBoolean");
+const FastVueMultiFunction_1 = require("./other/FastVueMultiFunction");
+const FastVueMultiElement_1 = require("./other/FastVueMultiElement");
+const FastVueMultiWindow_1 = require("./other/FastVueMultiWindow");
+/**
+ * FastBaseApp 手机APP功能工具类
+ */
+class FastVueMultiTool {
+    /**
+     * 页面配置工具类
+     */
+    static Config = FastVueMultiConfig_1.FastVueMultiConfig;
+    /**
+     * 网络请求工具类
+     */
+    static Http = FastVueMultiHttp_1.FastVueMultiHttp.Simple;
+    /**
+     * 页面数据缓存工具类
+     */
+    static Store = FastVueMultiStore_1.FastVueMultiStore;
+    /**
+     * cookie操作
+     */
+    static Cookie = FastVueMultiCookie_1.FastVueMultiCookie;
+    /**
+     * 剪贴板操作
+     */
+    static Clipboard = FastVueMultiClipboard_1.FastVueMultiClipboard;
+    /**
+     * Lodash工具类 https://lodash.com/docs/
+     */
+    static Lodash = lodash_1.default;
+    /**
+     * 日期类操作
+     */
+    static Date = FastVueMultiDate_1.FastVueMultiDate;
+    /**
+     * boolean工具类
+     */
+    static Boolean = FastVueMultiBoolean_1.FastVueMultiBoolean;
+    /**
+     * function工具类
+     */
+    static Function = FastVueMultiFunction_1.FastVueMultiFunction;
+    /**
+     * html元素操作工具类
+     */
+    static Element = FastVueMultiElement_1.FastVueMultiElement;
+    /**
+     * window对象相关操作
+     */
+    static Window = FastVueMultiWindow_1.FastVueMultiWindow;
+}
+exports.FastVueMultiTool = FastVueMultiTool;

package/dist/cjs/http/FastVueMultiCookie.d.ts

@@ -0,0 +1,18 @@
+export declare class FastVueMultiCookie {
+    /**
+     * 设置cookie
+     * @param key 键
+     * @param value 值
+     */
+    static setCookie(key: string, value: string): void;
+    /**
+     * 获取cookie
+     * @param key 键
+     */
+    static getCookie(key: string): string | undefined;
+    /**
+     * 删除cookie
+     * @param key 键
+     */
+    static removeCookie(key: string): void;
+}

package/dist/cjs/http/FastVueMultiCookie.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FastVueMultiCookie = void 0;
+const tslib_1 = require("tslib");
+const js_cookie_1 = tslib_1.__importDefault(require("js-cookie"));
+class FastVueMultiCookie {
+    /**
+     * 设置cookie
+     * @param key 键
+     * @param value 值
+     */
+    static setCookie(key, value) {
+        js_cookie_1.default.set(key, value);
+    }
+    /**
+     * 获取cookie
+     * @param key 键
+     */
+    static getCookie(key) {
+        return js_cookie_1.default.get(key);
+    }
+    /**
+     * 删除cookie
+     * @param key 键
+     */
+    static removeCookie(key) {
+        js_cookie_1.default.remove(key);
+    }
+}
+exports.FastVueMultiCookie = FastVueMultiCookie;

package/dist/cjs/http/FastVueMultiHttp.d.ts

@@ -0,0 +1,225 @@
+import { AxiosPromise } from "axios";
+/**
+ * FastVueMultiHttp 网咯请求接口工具类
+ * @author Janesen
+ */
+export declare namespace FastVueMultiHttp {
+    /**
+     * 基本的网络请求接口
+     */
+    class Base {
+        /**
+         * 获取地址栏携带的参数
+         * @param paramName 参数名
+         */
+        static getWindowUrlParam(paramName: string): string | null;
+        /**
+         * 获取地址栏携带的参数对象信息
+         */
+        static getWindowUrlInfo(): any;
+        /**
+         * 获取url的参数
+         * @param url 地址
+         * @param paramName 参数名
+         */
+        static getUrlParam(url: string, paramName: string): string | null;
+        /**
+         * 获取url的参数实体对象
+         * @param url 地址
+         */
+        static getUrlParamInfo(url: string): any;
+        /**
+         * 追加url参数
+         * @param url
+         * @param params
+         */
+        static appendUrlParams(url: string, params: any): string;
+        /**
+         * 合并多个FormData参数
+         * @param formData
+         */
+        static mergeFormData(...formData: FormData[]): FormData;
+        /**
+         * 如果是formData对象则转转换参数为object对象
+         * @param param
+         */
+        static convertToObject(param: any): object;
+        /**
+         * 转换参数为FormData格式
+         * @param param 任意格式的参数，FormData、Object、Function
+         */
+        static convertToFormData(param: any): FormData;
+        /**
+         * 合并参数并转换为FormData格式
+         * @param params 任意多个参数，FormData、Object、Function
+         */
+        static mergeParams(...params: any[]): FormData;
+        /**
+         * 将数组格式的参数合并
+         * @param params 数组
+         */
+        static mergeParamsByArray(params: any[]): FormData;
+        /**
+         * 发起接口请求
+         * @param method 请求方法，例如，post、get
+         * @param url 请求地址
+         * @param params 请求参数
+         */
+        static doRequest(method: string, url: string, params: any): AxiosPromise;
+        /**
+         * 执行post请求
+         * @param url 请求地址
+         * @param params 请求参数，可为object或form data
+         */
+        static doPost(url: string, params: any): AxiosPromise;
+        /**
+         * 执行get请求
+         * @param url 请求接口地址
+         * @param params 请求接口参数
+         */
+        static doGet(url: string, params?: any): AxiosPromise;
+        /**
+         * 获取请求接口的默认头信息配置
+         */
+        static getFinalHeaders(): any;
+        /**
+         * 设置请求头
+         * @param key
+         * @param value
+         */
+        static setFinalHeader(key: string, value: string): void;
+        /**
+         * 获取接口的全局参数，同步获取了原生APP的全局参数
+         */
+        static getFinalParams(): any;
+        /**
+         * 设置全局请求参数
+         * @param key
+         * @param value
+         */
+        static setFinalParam(key: string, value: any): void;
+        /**
+         * 构建接口请求的缓存key
+         * @param url 请求地址
+         * @param params 请求参数
+         */
+        static buildCacheKey(url: string, params: any): string;
+    }
+    /**
+     * 常规的接口请求类，返回格式要求为JSON：{success:true,message:"消息",data:{}}
+     */
+    class Simple extends Base {
+        /**
+         * 发起请求接口
+         * @param method 请求方法，例如：post、get
+         * @param url 接口地址 完整的地址，例如：http://loalhost:8080/user/login
+         * @param params 参数
+         * @param config 请求配置
+         * @param callBack 请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数为true时，必须使用回调函数接收
+         */
+        static request(method: string, url: string, params: any, config?: SimpleRequestConfig, callBack?: (result: SimpleJsonResponse) => void): Promise<SimpleJsonResponse>;
+        /**
+         * post请求接口
+         * @param url 接口地址 完整的地址，例如：http://loalhost:8080/user/login
+         * @param params 参数
+         * @param config 请求配置
+         * @param callBack 请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数为true时，必须使用回调函数接收
+         */
+        static post(url: string, params: any, config?: SimpleRequestConfig, callBack?: (result: SimpleJsonResponse) => void): Promise<SimpleJsonResponse>;
+        /**
+         * get请求接口
+         * @param url 接口地址 完整的地址，例如：http://loalhost:8080/user/login
+         * @param params 参数
+         * @param config 请求配置
+         * @param callBack 请求接口回调函数，在使用alwaysCache和alwaysBackRequest参数为true时，必须使用回调函数接收
+         */
+        static get(url: string, params: any, config?: SimpleRequestConfig, callBack?: (result: SimpleJsonResponse) => void): Promise<SimpleJsonResponse>;
+    }
+    /**
+     * 常规返回数据的格式解析类 JSON：{success:true,message:"消息",data:{}}
+     */
+    class SimpleJsonResponse {
+        responseData: any;
+        cacheData: boolean;
+        requestConfig: SimpleRequestConfig;
+        constructor(responseData: any, cacheData?: boolean);
+        /**
+         * 获取接口返回的原始数据
+         */
+        getResponseData(): any;
+        /**
+         * 判断当前回调的数据是否是缓存的数据
+         */
+        isCacheData(): boolean;
+        /**
+         * 判断接口是否请求成功-success
+         */
+        isSuccess(): boolean;
+        /**
+         * 获取接口请求返回的状态值-code
+         */
+        getCode(): number;
+        /**
+         * 获取接口请求返回的消息提示-message
+         */
+        getMessage(): string;
+        /**
+         * 获取接口请求返回的数据-data
+         */
+        getData(): any;
+        /**
+         * 获取接口请求返回的其他数据，例如：data_1、data_2
+         * @param suffixIndex 数据后缀，例如:data_1 后缀传 1
+         */
+        getOtherData(suffixIndex: number): any;
+        /**
+         * 判断接口返回的数据data是否是分页的数据
+         */
+        isPageData(): boolean;
+        /**
+         * 获取接口返回的数据列表，如果data是分页数据则返回分页的列表，否则返回data
+         */
+        getList(): any[];
+        /**
+         * 获取接口列表分页数据的页数
+         */
+        getPage(): number;
+        /**
+         * 获取接口列表分页数据的总页数
+         */
+        getTotalPage(): number;
+        /**
+         * 获取接口列表分页数据的总行数
+         */
+        getTotalRow(): number;
+        /**
+         * 获取接口列表分页数据的每页大小
+         */
+        getPageSize(): number;
+        /**
+         * 是否已加载结束，当page>=totalPage 或 list 为空时，认为加载已结束
+         */
+        isFinished(): boolean;
+    }
+    /**
+     * 接口请求配置类
+     */
+    class SimpleRequestConfig {
+        /**
+         * 是否追加全局参数，默认true
+         */
+        finalParams: boolean;
+        /**
+         * 是否缓存数据，true：检测到有当前接口的缓存数据时，将回调缓存的数据
+         */
+        cache: boolean;
+        /**
+         * 是否总是缓存数据，true：无论是否已有缓存数据，都将请求接口并刷新当前缓存的数据，不支持then方法接收
+         */
+        alwaysCache: boolean;
+        /**
+         * 是否总是回调接口请求返回的数据，true：如果有缓存第一次回调缓存数据，第二次回调接口返回的数据，否则值回调一次接口返回的数据，不支持then方法接收
+         */
+        alwaysBackRequest: boolean;
+    }
+}