@worktile/planet 17.0.0-next.0 → 17.0.0-next.1

package/helpers.d.ts

@@ -6,7 +6,7 @@ export declare function createElementByTemplate(template: string): HTMLElement;
 export declare function coerceArray<T>(value: T | T[]): T[];
 export declare function isEmpty(value: any): boolean;
 export declare function isFunction(value: any): value is Function;
-export declare function isObject(val: any): boolean;
+export declare function isObject<T extends object>(value: any): value is T;
 /**
  * Get file name from path
  * 1. "main.js" => "main.js"
@@ -14,6 +14,7 @@ export declare function isObject(val: any): boolean;
  * @param path path
  */
 export declare function getResourceFileName(path: string): string;
+export declare function getExtName(name: string): string;
 /**
  * Build resource path by manifest
  * if manifest is { "main.js": "main.h2sh23abee.js"}
@@ -25,12 +26,14 @@ export declare function getResourceFileName(path: string): string;
 export declare function buildResourceFilePath(resourceFilePath: string, manifestResult: {
     [key: string]: string;
 }): string;
+export declare function buildFullPath(path: string, basePath?: string): string;
+export declare function getAssetsBasePath(app: PlanetApplication): string;
 /**
  * Get static resource full path
  * @param app PlanetApplication
  * @param manifestResult manifest
  */
-export declare function getScriptsAndStylesFullPaths(app: PlanetApplication, manifestResult?: {
+export declare function getScriptsAndStylesFullPaths(app: PlanetApplication, basePath: string, manifestResult?: {
     [key: string]: string;
 }): {
     scripts: string[];

package/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../packages/planet/src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAInD,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAY5C;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,IAAI,CAMjF;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,eAUvD;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAElD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAM3C;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,QAAQ,CAGxD;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,WAEhC;AACD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,UAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,UAOxG;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE;;;EAwB9G"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../packages/planet/src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAA0B,MAAM,gBAAgB,CAAC;AAI3E,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAY5C;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,IAAI,CAMjF;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,eAUvD;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAElD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAM3C;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,QAAQ,CAGxD;AAED,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEjE;AACD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,UAO/C;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,UAOtC;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,UAOxG;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,UAS5D;AAeD,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAWhE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE;;;EA2ChI"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@worktile/planet",
-  "version": "17.0.0-next.0",
+  "version": "17.0.0-next.1",
   "private": false,
   "peerDependencies": {
     "@angular/common": "^17.0.0",

package/planet.class.d.ts

@@ -5,25 +5,105 @@ export interface PlanetOptions {
     errorHandler: (error: Error) => void;
     debugFactory?: Debug;
 }
+export interface PlanetApplicationEntry {
+    basePath?: string;
+    scripts?: string[];
+    styles?: string[];
+    manifest?: string;
+}
 export interface PlanetApplication<TExtra = any> {
+    /**
+     * Application name, e.g. "app1"
+     */
     name: string;
+    /**
+     * Selector or Element which app host parent
+     * 应用加载的宿主元素或者选择器
+     */
     hostParent: string | HTMLElement;
     /**
+     * Class name for host
+     */
+    hostClass?: string | string[];
+    /**
+     * Selector for sub application
+     * 子应用的选择器
      * @deprecated please use new defineApplication to set selector
      */
     selector?: string;
+    /**
+     * Path prefix for sub application, e.g. '/app1'
+     * 子应用路由前缀路径
+     */
     routerPathPrefix: string | RegExp;
-    hostClass?: string | string[];
+    /**
+     * Preload enabled, default false, if enabled,the application will be loaded when idle in the background
+     * 是否开启预加载，开启后会在后台提前加载此应用
+     */
     preload?: boolean;
+    /**
+     * Sandbox enabled
+     * 是否开启沙箱模式
+     */
     sandbox?: boolean;
+    /**
+     * Switch application mode
+     * default: will be destroyed when switch to other app
+     * coexist: only hide app when switch to other app
+     * 切换应用的模式
+     */
     switchMode?: SwitchModes;
-    resourcePathPrefix?: string;
+    /**
+     * Style prefix, e.g. 'app1'
+     * 样式前缀
+     */
     stylePrefix?: string;
+    /**
+     * The entry of the micro application, e.g. '/static/app1/index.html'
+     * If configured as string, it represents the entry html address of the micro application.  e.g. '/static/app1/index.html'
+     * If configured as object, the value of manifest is the html address of the micro application
+     *   entry.basePath: the base path of the entry, e.g. '/static/app1/'
+     *   entry.manifest: the manifest of the entry, e.g. 'index.html' or 'assets-manifest.json'
+     *   entry.scripts: the scripts of the entry, will get final scripts address by manifest and basePath
+     *   entry.styles: the styles of the entry, will get final styles address by manifest and basePath
+     */
+    entry?: string | PlanetApplicationEntry;
+    /**
+     * Manifest json file path, e.g. /static/app1/assets-manifest.json
+     * 应用程序打包后的脚本和样式文件替换
+     * @deprecated Please use entry.manifest instead
+     */
+    manifest?: string;
+    /**
+     * Path prefix of scripts and styles, e.g. 'static/app1/'
+     * 资源文件路径的前缀
+     * @deprecated Please use entry.basePath instead
+     */
+    resourcePathPrefix?: string;
+    /**
+     * Style static resource paths
+     * 样式资源文件
+     * @deprecated Please use entry.styles instead
+     */
     styles?: string[];
+    /**
+     * Scripts static resource paths
+     * 脚本资源文件
+     * @deprecated Please use entry.scripts instead
+     */
     scripts?: string[];
+    /**
+     * Serial load scripts, default is parallel, only enable when the script has sequentially loaded dependency
+     * 串行加载，默认并行加载脚本资源，仅当脚本资源有依赖关系时开启
+     */
     loadSerial?: boolean;
-    themeStylesPath?: string;
-    manifest?: string;
+    /**
+     * 皮肤样式的路径
+     */
+    /**
+     * Extra data for application
+     * 附加数据，主要应用于业务，比如图标，子应用的颜色，显示名等个性化配置
+     */
     extra?: TExtra;
 }
 export declare enum SwitchModes {

package/planet.class.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"planet.class.d.ts","sourceRoot":"","sources":["../../packages/planet/src/planet.class.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,aAAa;IAC1B,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACrC,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,GAAG,WAAW,CAAC;IAGjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAElC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,WAAW,CAAC;IAEzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,WAAW;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,QAAA,MAAM,mBAAmB,wCAA+D,CAAC;AAEzF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"planet.class.d.ts","sourceRoot":"","sources":["../../packages/planet/src/planet.class.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,aAAa;IAC1B,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACrC,YAAY,CAAC,EAAE,KAAK,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB,CAAC,MAAM,GAAG,GAAG;IAC3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,WAAW,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACxC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IAEH;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,WAAW;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,QAAA,MAAM,mBAAmB,wCAA+D,CAAC;AAEzF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}