feat: 配置插件api提示

packages/fes-plugin-access/types.d.ts

@@ -1,16 +1,29 @@
 import { Router, NavigationGuard } from 'vue-router';
+import { Ref } from 'vue';
 
-declare module "@fesjs/fes" {
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        access: {
+        access?:
-            rules: Record<string, []>;
+            | {
-        };
+                  rules: Record<string, []>;
+              }
+            | false;
     }
 
     interface PluginRuntimeConfig {
-        access: {
+        access?: {
             noFoundHandler: (param: { router: Router } & NavigationGuard) => void;
             unAccessHandler: (param: { router: Router } & NavigationGuard) => void;
         };
     }
+
+    export function access(): {
+        hasAccess(accessId: string | number): Promise<boolean>;
+        isDataReady(): boolean;
+        setRole(roleId: string | Promise<string>): void;
+        setAccess(accessIds: Array<string | number> | Promise<Array<string | number>>): void;
+        getAccess(): string[];
+    };
+
+    export function useAccess(accessId: Array<string | number>): Ref<boolean>;
 }

packages/fes-plugin-enums/types.d.ts

@@ -1,3 +1,4 @@
+import '@fesjs/fes';
 
 interface EnumExtend {
     key: string;
@@ -7,20 +8,18 @@ interface EnumExtend {
 
 interface EnumApi {
     get(name: string, key?: string, extend?: EnumExtend): any;
-    push(name: string, _enum?: [] | object, option?: {keyName: string; valueName: string}): any;
+    push(name: string, _enum?: [] | object, option?: { keyName: string; valueName: string }): any;
     remove(name: string): void;
-    concat(name: string, _enum: [] | object, option?: {keyName: string; valueName: string, before: boolean, extend: EnumExtend}): any;
+    concat(name: string, _enum: [] | object, option?: { keyName: string; valueName: string; before: boolean; extend: EnumExtend }): any;
-    convert(name: string, _enum?: [] | object, option?: {keyName: string; valueName: string}): any;
+    convert(name: string, _enum?: [] | object, option?: { keyName: string; valueName: string }): any;
 }
 
-declare module "@fesjs/fes" {
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        enums: {
+        enums?: {
-            [key: string]: [string | number, string | number][]
+            [key: string]: [string | number, string | number][];
-        }
+        } | false;
     }
 
     export const enums: EnumApi;
 }
-
-

packages/fes-plugin-icon/package.json

@@ -4,7 +4,8 @@
   "description": "@fesjs/plugin-icon",
   "main": "lib/index.js",
   "files": [
-    "lib"
+    "lib",
+    "types.d.ts"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -31,5 +32,6 @@
   },
   "dependencies": {
     "svgo": "^2.3.1"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-icon/types.d.ts

@@ -0,0 +1,7 @@
+import '@fesjs/fes';
+
+declare module '@fesjs/fes' {
+    interface PluginBuildConfig {
+        icon?: {} | false;
+    }
+}

packages/fes-plugin-layout/types.d.ts

@@ -1,4 +1,4 @@
-import {Component, VNode, Ref } from 'vue';
+import { Component, VNode, Ref } from 'vue';
 import { Router, NavigationGuard } from 'vue-router';
 
 interface Menu {
@@ -7,31 +7,33 @@ interface Menu {
     match: string[];
     title: string;
     icon: string | Component;
-    children?: Menu[]
+    children?: Menu[];
 }
 
-declare module "@fesjs/fes" {
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        layout: {
+        layout?:
-            footer: string;
+            | {
-            theme: 'dark' | 'light';
+                  footer: string;
-            navigation: 'side' | 'top' | 'mixin' | 'left-right';
+                  theme: 'dark' | 'light';
-            title: string;
+                  navigation: 'side' | 'top' | 'mixin' | 'left-right';
-            isFixedHeader: boolean;
+                  title: string;
-            isFixedSidebar: boolean;
+                  isFixedHeader: boolean;
-            logo: string;
+                  isFixedSidebar: boolean;
-            multiTabs: boolean;
+                  logo: string;
-            sideWidth: number;
+                  multiTabs: boolean;
-            menus: Menu[];
+                  sideWidth: number;
-            menuProps: {
+                  menus: Menu[];
-                expandedKeys: string[];
+                  menuProps: {
-                defaultExpandAll: boolean;
+                      expandedKeys: string[];
-                accordion: boolean;
+                      defaultExpandAll: boolean;
-            };
+                      accordion: boolean;
-        };
+                  };
+              }
+            | false;
     }
     interface PluginRuntimeConfig {
-        layout: {
+        layout?: {
             footer: string;
             theme: 'dark' | 'light';
             navigation: 'side' | 'top' | 'mixin' | 'left-right';
@@ -41,15 +43,17 @@ declare module "@fesjs/fes" {
             logo: string;
             multiTabs: boolean;
             sideWidth: number;
-            menus: Menu[] | (()=> (Ref<Menu[]> | Menu[]));
+            menus: Menu[] | (() => Ref<Menu[]> | Menu[]);
             menuProps: {
                 expandedKeys: string[];
                 defaultExpandAll: boolean;
                 accordion: boolean;
             };
-            renderCustom: ()=> VNode[],
+            renderCustom: () => VNode[];
             noFoundHandler: (param: { router: Router } & NavigationGuard) => void;
             unAccessHandler: (param: { router: Router } & NavigationGuard) => void;
         };
     }
+
+    export const Page: Component;
 }

packages/fes-plugin-locale/types.d.ts

@@ -1,10 +1,23 @@
-declare module "@fesjs/fes" {
+import '@fesjs/fes';
+
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        locale: {
+        locale?:
-            locale: string;
+            | {
-            fallbackLocale: string;
+                  locale: string;
-            baseNavigator: boolean;
+                  fallbackLocale: string;
-            legacy: boolean;
+                  baseNavigator: boolean;
-        };
+                  legacy: boolean;
+              }
+            | false;
     }
+
+    // export * from 'vue-i18n';
+
+    export const locale: {
+        setLocale({ locale }: { locale: string }): void;
+        addLocale({ locale, messages }: { locale: string; messages: object }): void;
+        getAllLocales(): string[];
+        messages: Record<string, object>;
+    };
 }

packages/fes-plugin-model/package.json

@@ -4,7 +4,8 @@
   "description": "@fesjs/plugin-model",
   "main": "lib/index.js",
   "files": [
-    "lib"
+    "lib",
+    "types.d.ts"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -32,5 +33,6 @@
   "peerDependencies": {
     "@fesjs/fes": "^3.0.0-beta.0",
     "vue": "^3.0.5"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-model/src/index.js

@@ -1,5 +1,6 @@
 import { readFileSync } from 'fs';
 import { join } from 'path';
+import { name } from '../package.json';
 
 const namespace = 'plugin-model';
 
@@ -70,4 +71,8 @@ export default (api) => {
             source: absCoreFilePath,
         },
     ]);
+
+    api.addConfigType(() => ({
+        source: name,
+    }));
 };

packages/fes-plugin-model/types.d.ts

@@ -0,0 +1,10 @@
+import '@fesjs/fes';
+
+declare module '@fesjs/fes' {
+
+    interface PluginBuildConfig {
+        model?: {} | false;
+    }
+
+    export function useModel(moduleId: string): any;
+}

packages/fes-plugin-monaco-editor/types.d.ts

@@ -1,14 +1,17 @@
+import type { Component } from 'vue';
 import type { EditorLanguage } from 'monaco-editor-webpack-plugin/out/languages';
 import type { EditorFeature } from 'monaco-editor-webpack-plugin/out/features';
 
-declare module "@fesjs/fes" {
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        monacoEditor: {
+        monacoEditor?: {
             filename: string;
             publicPath: string;
             languages: EditorLanguage[];
             features: EditorFeature[];
             globalAPI: boolean;
-        };
+        } | false;
     }
+
+    export const MonacoEditor: Component;
 }

packages/fes-plugin-pinia/package.json

@@ -4,7 +4,8 @@
   "description": "@fesjs/plugin-pinia",
   "main": "lib/index.js",
   "files": [
-    "lib"
+    "lib",
+    "types.d.ts"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -33,5 +34,6 @@
     "@fesjs/fes": "^3.0.0-beta.0",
     "pinia": "^2.0.11",
     "vue": "^3.0.5"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-pinia/types.d.ts

@@ -0,0 +1,9 @@
+import type { Pinia } from 'pinia';
+
+declare module '@fesjs/fes' {
+    interface PluginBuildConfig {
+        pinia?: {} | false;
+    }
+
+    export const pinia: Pinia;
+}

packages/fes-plugin-qiankun/types.d.ts

@@ -1,3 +1,4 @@
+import { Component } from 'vue';
 import { FrameworkLifeCycles, MicroApp } from 'qiankun';
 
 interface AppOption {
@@ -6,16 +7,20 @@ interface AppOption {
     props: Record<string, any>;
 }
 
-
+declare module '@fesjs/fes' {
-declare module "@fesjs/fes" {
     interface PluginBuildConfig {
-        qiankun: {
+        qiankun?:
-            main: {
+            | {
-                apps: AppOption[];
+                  main?: {
-                lifeCycles?: FrameworkLifeCycles<MicroApp>;
+                      apps: AppOption[];
-                [key: string]: any;
+                      lifeCycles?: FrameworkLifeCycles<MicroApp>;
-            };
+                      [key: string]: any;
-            micro: {}
+                  };
-        };
+                  micro?: {};
+              }
+            | false;
     }
+
+    export const MicroApp: Component;
+    export const MicroAppWithMemoHistory: Component;
 }

packages/fes-plugin-request/types.d.ts

@@ -15,7 +15,7 @@ interface RequestPluginOption {
 
 declare module "@fesjs/fes" {
     interface PluginRuntimeConfig {
-        request: {
+        request?: {
             dataHandler?(data: any, response: AxiosResponse): any;
             errorHandler?(error: AxiosError | {type: string, msg: string, [key: string]: string}): void;
             requestInterceptors?: RequestInterceptor[];

packages/fes-plugin-sass/package.json

@@ -4,7 +4,8 @@
   "description": "@fesjs/plugin-sass",
   "main": "lib/index.js",
   "files": [
-    "lib"
+    "lib",
+    "types.d.ts"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -32,5 +33,6 @@
   },
   "peerDependencies": {
     "@fesjs/fes": "^3.0.0-beta.0"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-sass/types.d.ts

@@ -0,0 +1,14 @@
+import '@fesjs/fes';
+
+declare module '@fesjs/fes' {
+    interface PluginBuildConfig {
+        sass?:
+            | {
+                  implementation: any;
+                  sassOptions: object;
+                  sourceMap: boolean;
+                  webpackImporter: boolean;
+              }
+            | false;
+    }
+}

packages/fes-plugin-vuex/types.d.ts

@@ -1,12 +1,19 @@
-
+import '@fesjs/fes';
-
+declare module '@fesjs/fes' {
-declare module "@fesjs/fes" {
     interface PluginBuildConfig {
-        vuex: {
+        vuex?:
-            strict: boolean;
+            | {
-            devtools: boolean;
+                  strict: boolean;
-        }
+                  devtools: boolean;
+              }
+            | false;
     }
-}
 
+    export const MUTATION_TYPES: object;
 
+    export const ACTION_TYPES: object;
+
+    export const GETTER_TYPES: object;
+
+    export const store: object;
+}

packages/fes-plugin-watermark/package.json

@@ -4,7 +4,8 @@
   "description": "@fesjs/plugin-watermark",
   "main": "lib/index.js",
   "files": [
-    "lib"
+    "lib",
+    "types.d.ts"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -33,5 +34,6 @@
   "peerDependencies": {
     "@fesjs/fes": "^3.0.0-beta.0",
     "vue": "^3.0.5"
-  }
+  },
+  "typings": "./types.d.ts"
 }

packages/fes-plugin-watermark/src/index.js

@@ -1,4 +1,5 @@
 import { join } from 'path';
+import { name } from '../package.json';
 
 const namespace = 'plugin-watermark';
 
@@ -8,11 +9,11 @@ export default (api) => {
         config: {
             schema(joi) {
                 return joi.object({
-                    disabled: joi.boolean()
+                    disabled: joi.boolean(),
                 });
             },
-            default: {}
+            default: {},
-        }
+        },
     });
 
     const absoluteFilePath = join(namespace, 'core.js');
@@ -23,23 +24,26 @@ export default (api) => {
         defineConfig.WATERMARK_DISABLED = memo.watermark.disabled ?? false;
         return {
             ...memo,
-            define: defineConfig
+            define: defineConfig,
         };
     });
 
-
     api.onGenerateFiles(() => {
         api.copyTmpFiles({
             namespace,
             path: join(__dirname, 'runtime'),
-            ignore: ['.tpl']
+            ignore: ['.tpl'],
         });
     });
 
     api.addPluginExports(() => [
         {
             specifiers: ['createWatermark', 'destroyWatermark'],
-            source: absoluteFilePath
+            source: absoluteFilePath,
-        }
+        },
     ]);
+
+    api.addConfigType(() => ({
+        source: name,
+    }));
 };

packages/fes-plugin-watermark/types.d.ts

@@ -0,0 +1,27 @@
+import '@fesjs/fes';
+
+interface WatermarkParam {
+    content: string;
+    container: HTMLElement;
+    width: number;
+    height: number;
+    textAlign: 'left' | 'right' | 'center' | 'start' | 'end';
+    textBaseline: 'top' | 'hanging' | 'middle' | 'alphabetic' | 'ideographic' | 'bottom';
+    fontSize: string;
+    fontFamily: string;
+    fillStyle: string;
+    rotate: number;
+    zIndex: number;
+    timestamp: string;
+}
+
+declare module '@fesjs/fes' {
+    interface PluginBuildConfig {
+        watermark?: {
+            disable: boolean;
+        } | false;
+    }
+
+    export function createWatermark(param: WatermarkParam): void;
+    export function destroyWatermark(): void;
+}

packages/fes-plugin-windicss/types.d.ts

@@ -1,9 +1,11 @@
 import type { Config } from 'windicss/types/interfaces';
 
-declare module "@fesjs/fes" {
+declare module '@fesjs/fes' {
     interface PluginBuildConfig {
-        windicss: {
+        windicss?:
-            config: Config
+            | {
-        }
+                  config: Config;
+              }
+            | false;
     }
 }

packages/fes-template/.fes.js

@@ -1,6 +1,5 @@
-// .fes.js 只负责管理编译时配置，只能使用plain Object
+import { defineBuildConfig } from '@fesjs/fes'
-
+export default defineBuildConfig({
-export default {
     // exportStatic: {},
     define: {
         __DEV__: false
@@ -98,4 +97,4 @@ export default {
     presets: [
         require.resolve('../fes-builder-webpack/lib'),
     ]
-};
+});

packages/fes-template/tsconfig.json

@@ -3,7 +3,10 @@
     "outDir": "build/dist",
     "module": "esnext",
     "target": "esnext",
-    "lib": ["esnext", "dom"],
+    "lib": [
+      "esnext",
+      "dom"
+    ],
     "sourceMap": true,
     "baseUrl": ".",
     "jsx": "preserve",
@@ -14,25 +17,31 @@
     "suppressImplicitAnyIndexErrors": true,
     "noUnusedLocals": true,
     "allowJs": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
     "strict": true,
     "paths": {
-      "@/*": ["./src/*"],
+      "@/*": [
-      "@@/*": ["./src/.fes/*"]
+        "./src/*"
+      ],
+      "@@/*": [
+        "./src/.fes/*"
+      ]
     }
   },
   "include": [
+    "*.js",
+    ".fes.js",
     "src/**/*",
-    "tests/**/*",
-    "test/**/*",
-    "__test__/**/*",
     "typings/**/*",
     "config/**/*",
-    ".eslintrc.js",
-    ".stylelintrc.js",
-    ".prettierrc.js",
     "src/.fes/configType.d.ts"
   ],
-  "exclude": ["node_modules", "build", "dist", "scripts", "src/.fes/*", "webpack", "jest"]
+  "exclude": [
-}
+    "build",
+    "dist",
+    "scripts",
+    "webpack",
+    "jest",
+    "node_modules"
+  ]
+}

packages/fes/types.d.ts

@@ -15,7 +15,7 @@ export interface PluginBuildConfig {}
 
 export declare function defineRouteMeta(routeMeta: RouteMeta): RouteMeta;
 
-export function defineBuildConfig(config: PluginBuildConfig ): PluginBuildConfig;
+export declare function defineBuildConfig(config: PluginBuildConfig ): PluginBuildConfig;
 
-export function defineRuntimeConfig(config:  PluginRuntimeConfig):  PluginRuntimeConfig;
+export declare function defineRuntimeConfig(config:  PluginRuntimeConfig):  PluginRuntimeConfig;