zova-module-a-router 5.0.27

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present Zova
+
+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/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "zova-module-a-router",
+  "version": "5.0.27",
+  "title": "a-router",
+  "cabloyModule": {
+    "capabilities": {
+      "monkey": true
+    }
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": [
+        "./src/index.ts",
+        "./dist/index.d.ts"
+      ],
+      "import": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": "./*"
+  },
+  "description": "router",
+  "keywords": [
+    "Zova Module"
+  ],
+  "author": "zhennann",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "clean": "tsc -b --clean",
+    "tsc:publish": "npm run clean && tsc -b",
+    "prepublishOnly": "npm run tsc:publish"
+  },
+  "dependencies": {
+    "vue-router": "^4.3.2"
+  },
+  "gitHead": "e452293f92ba46b87ab8d1bb19d4e507cb8a4654"
+}

package/src/bean/store.router.ts

@@ -0,0 +1,164 @@
+import { BeanBase, Cast, IModule, IPageNameRecord, IPagePathRecord, Store, TypeEventOff } from 'zova';
+import { Router } from 'vue-router';
+import * as ModuleInfo from '@cabloy/module-info';
+import { IModuleRoute, IModuleRouteComponent } from '../types.js';
+
+const SymbolRouter = Symbol('SymbolRouter');
+
+export type StoreRouterLike = StoreRouter & Router;
+
+@Store()
+export class StoreRouter extends BeanBase {
+  [SymbolRouter]: Router;
+  eventRouterGuards: TypeEventOff;
+
+  get router(): Router {
+    return this[SymbolRouter];
+  }
+
+  protected __get__(prop) {
+    return this[SymbolRouter] && this[SymbolRouter][prop];
+  }
+
+  protected async __init__(router?: Router) {
+    if (!router) {
+      // app router
+      router = this.bean.inject('a-router:appRouter');
+      if (!router) {
+        throw new Error('Should provide router');
+      }
+      this.bean.provide('a-router:router', Cast<StoreRouterLike>(this));
+      // event
+      this.eventRouterGuards = this.app.meta.event.on('a-router:routerGuards', async (context, next) => {
+        this._routerGuards(context.data);
+        await next();
+      });
+    }
+    this[SymbolRouter] = router;
+  }
+
+  protected __dispose__() {
+    if (this.eventRouterGuards) {
+      this.eventRouterGuards();
+    }
+  }
+
+  public createAsyncComponent(component: string | IModuleRouteComponent) {
+    if (typeof component !== 'string') return component;
+    return this.app.meta.component.createAsyncComponent(component);
+  }
+
+  public resolveName<K extends keyof IPageNameRecord>(name: K, options?: IPageNameRecord[K]): string {
+    const params = Cast(options)?.params;
+    const query = Cast(options)?.query;
+    return this._resolveNameOrPath(query, query => {
+      const route = this[SymbolRouter].resolve({ name, params, query });
+      return route.fullPath;
+    });
+  }
+
+  public resolvePath<K extends keyof IPagePathRecord>(path: K, query?: IPagePathRecord[K]): string {
+    return this._resolveNameOrPath(query, query => {
+      const route = this[SymbolRouter].resolve({ path, query });
+      return route.fullPath;
+    });
+  }
+
+  private _resolveNameOrPath(query, fn) {
+    const query1 = {};
+    const query2: any = [];
+    if (query) {
+      for (const key in query) {
+        const value = query[key];
+        if (value && typeof value === 'object') {
+          query2.push([key, value]);
+        } else {
+          query1[key] = value;
+        }
+      }
+    }
+    // resolve
+    const fullPath = fn(query1);
+    // query2
+    const query2str = query2
+      .map(([key, value]) => {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(JSON.stringify(value))}`;
+      })
+      .join('&');
+    // join
+    if (!query2str) return fullPath;
+    const join = Object.keys(query1).length > 0 ? '&' : '?';
+    return `${fullPath}${join}${query2str}`;
+  }
+
+  private _routerGuards(router: StoreRouterLike) {
+    router.beforeEach(async to => {
+      // fullPath
+      const fullPath = to.fullPath;
+      // module info
+      const moduleInfo = ModuleInfo.parseInfo(fullPath);
+      if (!moduleInfo) {
+        // donothing
+        return;
+      }
+      const module = this.app.meta.module.get(moduleInfo.relativeName);
+      if (module) return;
+      // use module
+      await this.app.meta.module.use(fullPath);
+      // redirect again
+      return fullPath;
+    });
+  }
+
+  /** @internal */
+  public _registerRoutes(module: IModule) {
+    if (!module.resource.routes) return null;
+    for (const route of module.resource.routes) {
+      this._registerRoute(module, route);
+    }
+  }
+
+  private _registerRoute(module: IModule, route: IModuleRoute) {
+    // meta
+    const meta = route.meta;
+    // name
+    let name: string | undefined;
+    if (route.name) {
+      if (meta?.absolute === true) {
+        name = String(route.name);
+      } else {
+        name = `${module.info.relativeName}:${String(route.name)}`;
+      }
+    }
+    // path
+    let path: string | undefined;
+    if (route.path) {
+      if (meta?.absolute === true) {
+        path = route.path;
+      } else {
+        path = `/${module.info.pid}/${module.info.name}/${route.path}`;
+      }
+    }
+    // component
+    const component = route.component;
+    // layout / routeData
+    let layout = meta?.layout;
+    let routeData;
+    if (layout === false) {
+      routeData = { ...route, name, path, component, meta };
+    } else {
+      if (layout === undefined || layout === 'default') {
+        layout = this.app.config.layout.component.default;
+      } else if (layout === 'empty') {
+        layout = this.app.config.layout.component.empty;
+      }
+      routeData = {
+        path,
+        component: this.createAsyncComponent(layout as any),
+        children: [{ ...route, name, path: '', component, meta }],
+      };
+    }
+    // add
+    this.router.addRoute(routeData);
+  }
+}

package/src/bean/virtual.router.ts

@@ -0,0 +1,22 @@
+import { BeanBase, TypeEventOff, Virtual } from 'zova';
+import { StoreRouterLike } from './store.router.js';
+
+@Virtual()
+export class BeanRouterBase<TScopeModule = unknown> extends BeanBase<TScopeModule> {
+  private _eventRouterGuards: TypeEventOff;
+
+  protected async __init__() {
+    this._eventRouterGuards = this.app.meta.event.on('a-router:routerGuards', async (context, next) => {
+      this.onRouterGuards(context.data);
+      await next();
+    });
+  }
+
+  protected __dispose__() {
+    if (this._eventRouterGuards) {
+      this._eventRouterGuards();
+    }
+  }
+
+  protected onRouterGuards(_router: StoreRouterLike) {}
+}

package/src/config/config.ts

@@ -0,0 +1,5 @@
+import { ZovaApplication } from 'zova';
+
+export const config = (_app: ZovaApplication) => {
+  return {};
+};

package/src/config/constants.ts

@@ -0,0 +1 @@
+export const constants = null;

package/src/config/errors.ts

@@ -0,0 +1 @@
+export enum Errors {}

package/src/config/index.ts

@@ -0,0 +1,4 @@
+export * from './locales.js';
+export * from './errors.js';
+export * from './config.js';
+export * from './constants.js';

package/src/config/locale/en-us.ts

@@ -0,0 +1 @@
+export default {};

package/src/config/locale/zh-cn.ts

@@ -0,0 +1 @@
+export default {};

package/src/config/locales.ts

@@ -0,0 +1,7 @@
+import en_us from './locale/en-us.js';
+import zh_cn from './locale/zh-cn.js';
+
+export const locales = {
+  'en-us': en_us,
+  'zh-cn': zh_cn,
+};

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './config/index.js';
+export * from './resource/index.js';
+export * from './routes.js';
+export * from './types.js';
+export * from './monkey.js';
+
+import './typings.js';

package/src/monkey.ts

@@ -0,0 +1,85 @@
+import {
+  BeanBase,
+  BeanContainerLike,
+  BeanControllerPageBase,
+  BeanSimple,
+  IModule,
+  IMonkeyModule,
+  IMonkeyController,
+  IMonkeySystem,
+  IControllerData,
+  TypePageSchema,
+  useComputed,
+} from 'zova';
+import * as ModuleInfo from '@cabloy/module-info';
+import { useRoute } from 'vue-router';
+import { StoreRouterLike } from './bean/store.router.js';
+
+export class Monkey extends BeanSimple implements IMonkeySystem, IMonkeyModule, IMonkeyController {
+  private _storeRouter: StoreRouterLike;
+  private _moduleSelf: IModule;
+
+  constructor(moduleSelf: IModule) {
+    super();
+    this._moduleSelf = moduleSelf;
+  }
+
+  async getStoreRouter() {
+    if (!this._storeRouter) {
+      this._storeRouter = (await this.bean._getBean('a-router.store.router', false)) as StoreRouterLike;
+    }
+    return this._storeRouter;
+  }
+
+  async appInitialize() {}
+  async appInitialized() {
+    // emit event
+    const router = this.bean.inject('a-router:router');
+    await this.app.meta.event.emit('a-router:routerGuards', router);
+  }
+  async beanInit(bean: BeanContainerLike, beanInstance: BeanBase) {
+    bean.defineProperty(beanInstance, '$router', {
+      enumerable: false,
+      configurable: true,
+      get() {
+        return bean.inject('a-router:router');
+      },
+    });
+  }
+  async beanInited(_bean: BeanContainerLike, _beanInstance: BeanBase) {}
+  beanDispose(_bean: BeanContainerLike, _beanInstance: BeanBase) {}
+  beanDisposed(_bean: BeanContainerLike, _beanInstance: BeanBase) {}
+  async moduleLoading(module: IModule) {
+    if (this._moduleSelf === module) return;
+    const storeRouter = await this.getStoreRouter();
+    storeRouter._registerRoutes(module);
+  }
+  async moduleLoaded(_module: IModule) {}
+  async configLoaded(_module: IModule, _config) {}
+  controllerDataPrepare(controllerData: IControllerData) {
+    controllerData.context.route = useRoute();
+  }
+  controllerDataInit(controllerData: IControllerData, controller: BeanBase) {
+    // only for controller page
+    if (controller instanceof BeanControllerPageBase) {
+      const route = controllerData.context.route;
+      const schemaKey = String(route.name || route.path);
+      let schemas: TypePageSchema | undefined;
+      const moduleName = ModuleInfo.parseName(schemaKey)!;
+      const module = this.app.meta.module.get(moduleName)!;
+      if (route.name) {
+        schemas = module.resource.pageNameSchemas?.[schemaKey];
+      } else {
+        schemas = module.resource.pagePathSchemas?.[schemaKey];
+      }
+      controller.$params = useComputed(() => {
+        if (!schemas?.params) throw new Error(`page params schema not found: ${schemaKey}`);
+        return schemas.params.parse(route.params);
+      });
+      controller.$query = useComputed(() => {
+        if (!schemas?.query) throw new Error(`page query schema not found: ${schemaKey}`);
+        return schemas.query.parse(route.query);
+      });
+    }
+  }
+}

package/src/resource/beans.ts

@@ -0,0 +1,9 @@
+export * from '../bean/store.router.js';
+export * from '../bean/virtual.router.js';
+import { StoreRouter } from '../bean/store.router.js';
+import 'zova';
+declare module 'zova' {
+  export interface IBeanRecord {
+    'a-router.store.router': StoreRouter;
+  }
+}

package/src/resource/components.ts

@@ -0,0 +1 @@
+export const components = {};

package/src/resource/events.ts

@@ -0,0 +1,12 @@
+import { StoreRouterLike } from './beans.js';
+
+import 'zova';
+declare module 'zova' {
+  export interface IEventRecord {
+    'a-router:routerGuards': StoreRouterLike;
+  }
+
+  export interface IEventResultRecord {
+    'a-router:routerGuards': void;
+  }
+}

package/src/resource/index.ts

@@ -0,0 +1,5 @@
+export * from './scope.js';
+export * from './beans.js';
+export * from './components.js';
+export * from './events.js';
+export * from './injects.js';

package/src/resource/injects.ts

@@ -0,0 +1,10 @@
+import { Router } from 'vue-router';
+import { StoreRouterLike } from '../bean/store.router.js';
+
+import 'zova';
+declare module 'zova' {
+  export interface IInjectRecord {
+    'a-router:appRouter': Router;
+    'a-router:router': StoreRouterLike;
+  }
+}

package/src/resource/scope.ts

@@ -0,0 +1,30 @@
+import { BeanScopeBase, Scope, TypeLocaleBase, TypeModuleResource } from 'zova';
+import { config, Errors, locales, constants } from '../config/index.js';
+import { components } from './components.js';
+
+@Scope()
+export class ScopeModuleARouter extends BeanScopeBase {}
+
+export interface ScopeModuleARouter
+  extends TypeModuleResource<
+    typeof components,
+    typeof config,
+    typeof Errors,
+    (typeof locales)[TypeLocaleBase],
+    typeof constants
+  > {}
+
+import 'zova';
+declare module 'zova' {
+  export interface IBeanScopeRecord {
+    'a-router': ScopeModuleARouter;
+  }
+
+  export interface IBeanScopeConfig {
+    'a-router': ReturnType<typeof config>;
+  }
+
+  export interface IBeanScopeLocale {
+    'a-router': (typeof locales)[TypeLocaleBase];
+  }
+}

package/src/resource/this.ts

@@ -0,0 +1,4 @@
+export const __ThisModule__ = 'a-router';
+export type __ThisModuleType__ = typeof __ThisModule__;
+
+export { ScopeModuleARouter as ScopeModule } from './scope.js';

package/src/routes.ts

@@ -0,0 +1,3 @@
+import { IModuleRoute } from 'zova-module-a-router';
+
+export const routes: IModuleRoute[] = [];

package/src/types.ts

@@ -0,0 +1,35 @@
+import { TypePageSchemas } from 'zova';
+import { RouteComponent, RouteLocationNormalizedLoaded, RouteRecordRaw } from 'vue-router';
+import { StoreRouterLike } from './bean/store.router.js';
+
+export type Lazy<T> = () => Promise<T>;
+export type IModuleRouteComponent = RouteComponent | Lazy<RouteComponent>;
+export type IModuleRoute = RouteRecordRaw;
+
+import 'vue-router';
+declare module 'vue-router' {
+  interface RouteMeta {
+    absolute?: boolean;
+    layout?: 'empty' | 'default' | false | string | IModuleRouteComponent;
+    requiresAuth?: boolean;
+  }
+}
+
+declare module 'zova' {
+  export interface BeanBase {
+    $router: StoreRouterLike;
+  }
+
+  export interface IModuleResource {
+    routes: IModuleRoute[];
+  }
+
+  export interface IControllerDataContext {
+    route: RouteLocationNormalizedLoaded;
+  }
+
+  export interface IModuleResource {
+    pagePathSchemas?: TypePageSchemas;
+    pageNameSchemas?: TypePageSchemas;
+  }
+}

package/src/typings.ts

@@ -0,0 +1 @@
+export {};