@arkxio/ark-dev-utils 0.1.5 → 0.1.8

package/typings.d.ts

@@ -1,295 +1,295 @@
-/**
- * default: 'all'，生成资源清单时的元数据提取方式，会影响元数据的记录结果
- * ```
- * all：提取并记录构建时生成的产物、静态路径导入的产物、homePage之外相对路径导入的产物，同时也会记录 html_content
- * build：只提取并记录构建时生成的产物，同时也会记录 html_content
- * all_no_html：提取并记录构建时生成的产物、静态路径导入的产物、homePage之外相对路径导入的产物，不记录 html_content
- * build_no_html：只提取并记录构建时生成的产物，不记录 html_content
- * ```
- */
-type ExtractMode = 'all' | 'build' | 'all_no_html' | 'build_no_html';
-
-/** SrcMap形如：
-{
-  "iconSrc": "/web-app/sub-apps/news-shelf/favicon.ico",
-  "mainCssSrc": "",
-  "chunkCssSrcList": [],
-}
-*/
-export interface SrcMap {
-  webDirPath: string;
-  /** default: 'all' */
-  extractMode: ExtractMode;
-  /** 用于辅助iframe载入子应用入口html地址 */
-  iframeSrc: string;
-  /** 所有依据 homePage 构建生成的 js 列表 */
-  chunkJsSrcList: string[];
-  /** 所有依据 homePage 构建生成的 css 列表 */
-  chunkCssSrcList: string[];
-  /** 所有绝对路径导入的 homePage 之外的 js 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
-  staticJsSrcList: string[];
-  /** 所有绝对路径导入的 homePage 之外的 css 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
-  staticCssSrcList: string[];
-  /** 所有相对路径导入的 homePage 之外的 js 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
-  relativeJsSrcList: string[];
-  /** 所有相对路径导入的 homePage 之外的 css 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
-  relativeCssSrcList: string[];
-  /** 应用首屏加载时需要插入到 document.head 里的资源列表 */
-  headAssetList: string[];
-  /** 应用首屏加载时需要插入到 document.body 里的资源列表 */
-  bodyAssetList: string[];
-  /** 所有依据 homePage 构建生成的其他类型的资源文件列表 */
-  otherSrcList: string[];
-}
-
-interface ObjBase {
-  create_by: string;
-  // create_at: '2020-04-01T02:51:35.000Z',
-  create_at: string;
-  update_at: string;
-}
-
-export interface SubAppInfo extends ObjBase {
-  id: number;
-  /** app对应的英文名 */
-  name: string;
-  /** app对应的组名 */
-  app_group_name: string;
-  /** app对应在敏感权限系统里的名字 */
-  name_in_sec: string;
-  /** 如果是测试app的话，只下发给测试人员，此种模式的app永远只会将build_version下发给前端，其他xxx_version对于它来说都是冗余的 */
-  is_test: 1 | 0;
-  /** 是否允许灰度 */
-  enable_gray: 1 | 0;
-  /** 是否正在灰度中，每次流水线构建时如果 enable_gray 是1，则此值会设置为1 */
-  is_in_gray: 1 | 0;
-  /** 灰度用户名单 */
-  gray_users: string[];
-  /** 每一个子应用对应的唯一token */
-  token: string;
-  /** app对应的中文名 */
-  cnname: string;
-  splash_screen: string;
-  logo: string;
-  desc: string;
-  owners: string[];
-  _ctime: string;
-  _mtime: string;
-  /** 产品审核通过，将预发布版本变为线上版本 */
-  online_version: string;
-  /** 测试人员提交审核，触发更新预发布版本 */
-  pre_version: string;
-  /** 开发在app后台提交构建版本为测试，触发更新测试版本 */
-  test_version: string;
-  /** 每次蓝盾流水线构建完毕，都会更新构建版本，当做灰度版本使用 */
-  build_version: string;
-  /** 是否允许流水线发布新版本 */
-  enable_pipeline: 1 | 0;
-  /** 是否允许下发给客户端做展示 */
-  enable_display: 1 | 0;
-  /** 请求host */
-  api_host: string;
-  /** 渲染模式 react react-shadow iframe */
-  render_mode: string;
-  class_name: string;
-  versions: string;
-  ui_framework: string;
-  host_map: {
-    online: string;
-    pre: string;
-    build: string;
-  };
-}
-export interface SubAppVersion extends ObjBase {
-  id: number;
-  sub_app_id: string;
-  /** 冗余存储的子应用名称，对应app_info表的name字段 */
-  sub_app_name: string;
-  /** 每次构建新生成的版本号 */
-  sub_app_version: string;
-  /**
-   * 资源描述表map，parse后见domain-inner SrcMap
-   */
-  src_map: string;
-  desc: string;
-}
-
-export interface SubAppVersionEntity extends Omit<SubAppVersion, 'src_map'> {
-  src_map: SrcMap;
-}
-
-/** 形如
-  {
-    fileAbsolutePath: '/tmp/CmsSubAppBxxxxx.chunk.css',
-    cosDirName: 'om_20200408113805',
-    cosFileRelativePath: '/static/css/35.4288e4f0.chunk.css'
-  }
-*/
-export interface FileDesc {
-  /** 文件在构建机容器里所处的绝对路径 */
-  fileAbsolutePath: string;
-  /** 文件在网络上所处的路径 */
-  fileWebPath: string;
-  /** 文件在网络上所处的路径（不带host） */
-  fileWebPathWithoutHost: string;
-}
-
-export interface IAssetOptions {
-  el: HTMLScriptElement;
-  homePage: string;
-  extractMode: SrcMap;
-  enableRelativePath: boolean;
-  enableAssetInnerText: boolean;
-  innerText: string;
-}
-
-export interface IAssetInfo {
-  url: string;
-  el: HTMLScriptElement;
-  isBuildUrl: boolean;
-  isNonBuildAndRelative: boolean;
-  allowAddToAssetList: boolean;
-  canAppend: boolean;
-  innerText: string;
-}
-
-export interface ISubAppBuildDesc {
-  platform: string;
-  homePage: string;
-  npmCdnType: string;
-  groupName: string;
-  semverApi: boolean;
-  name: string;
-  externals: Record<string, any>;
-  /** return merged externals */
-  getExternals: (userExternals?: Record<string, any>) => Record<string, any>;
-  jsonpFnName: string;
-  /**
-   * fallbackPathOrUrl default: '/'
-   * ensureEndSlash default: true
-   */
-  getPublicPathOrUrl: (fallbackPathOrUrl: string, ensureEndSlash: boolean) => string;
-  distDir: string;
-}
-
-/** 用户自定义的各种提取选项 */
-export interface IUserExtractOptions {
-  buildDirFullPath: string;
-  packageJson: Record<string, any>;
-  /**
-   * @deprecated
-   * 应用信息，保留此属性是为了让老用户升级后不报错，内部优先取 appInfo 再取 subApp
-   */
-  subApp: ISubAppBuildDesc;
-  /**
-   * 应用信息
-   */
-  appInfo: ISubAppBuildDesc;
-  /**
-   *  构建版本号，当指定了 appHomePage 且不想采用默认的版本号生成规则时，才需要透传 buildVer 值
-   *  默认生成规则：
-   *  内网包：裁出 appHomePage ${cdnHost}/${appZone}/${appName}_${dateStr} 里的 ${appName}_${dateStr} 作为版本号
-   *  外网包：pkg.version
-   */
-  buildVer?: string;
-  /**
-   * default: 'all'，资源清单元数据提取方式，会影响元数据的记录结果
-   */
-  extractMode?: ExtractMode;
-  /** default: ark_dist */
-  distDir?: string;
-  /** default: true */
-  writeMetaJsonToDist?: boolean;
-  /**
-   * default: false, 针对存在有 innerText 的节点时，是否提取到元数据 srcMap 里，true：提取 innerText 到 srcMap，false：存为外链后放 srcMap
-   * 此参数在针对 vite 产物场景有用，vite 产物里有一些内联的 type='module' 的 script，它们需要被按顺序触发执行，外链后执行顺讯因为网络关系不一定能保证
-   * 设置为 true 后，则 assetItem.innerText 会直接记录内联脚本内容，不再有额外的网络请求去拉取外链资源，执行顺序也就能保证了
-   */
-  enableAssetInnerText?: boolean;
-  /** default: true, 是否替换的 dev.js 结尾的文件为 .js */
-  enableReplaceDevJs?: boolean;
-  /** default: false, 是否允许在 homePage 之外的相对路径的资源存在 */
-  enableRelativePath?: boolean;
-  /**
-   * default: false,是否自动为 html 文件里出现的以单 / 开头的资源拼接上 homePage 前缀
-   * 目前的使用场景式1：
-   * vite.config 不知如何配置 publicUrl，可设置此参数为 true
-   * 开启后，index.html里的 /aaa-123.js 会变为 {homePage}/aaa-123.js
-   */
-  enablePrefixHomePage?: boolean;
-  /** default: undefined, 如无特殊情况，不需要指定，内部会自动去构建目录下查询 .html 结尾的文件 */
-  indexHtmlName?: string;
-}
-
-export interface IInnerSubAppOptions {
-  /** 历史原因，保留 vue3 vue3，目前他们的external配置一样 */
-  frameworkType: 'react' | 'vue2' | 'vue3' | 'vue' | 'lib';
-}
-
-export interface IInnerFillAssetListOptions {
-  homePage: string;
-  buildDirFullPath: string;
-  srcMap: SrcMap;
-  isHead: boolean;
-  enableReplaceDevJs: IUserExtractOptions['enableReplaceDevJs'];
-  enableRelativePath: IUserExtractOptions['enableRelativePath'];
-  enablePrefixHomePage: IUserExtractOptions['enablePrefixHomePage'];
-  enableAssetInnerText: IUserExtractOptions['enableAssetInnerText'];
-  /** webpack compilation 对象，用于在开发模式下通过 emitAsset 输出文件 */
-  compilation?: any;
-  /** 自定义资产列表，用于收集从 HTML 内联脚本提取的代码 */
-  customAssets?: Array<{ scriptName: string; fileWebPath: string; content: string }>;
-}
-
-export interface ICreateSubAppOptions {
-  externals?: Record<string, any>;
-  homePage?: string;
-  /**
-   * default: true，
-   * 当 platform 为 unpkg ，且用户自定义了 homePage 值时， 此参数才有作用
-   * 表示最终生成的homepage值是否拼接上模块名、版本号、hel内置目录等参数
-   * 例如用户设定 homePage: https://xxx.yyy.com/sub_path
-   * changeHomePage 为 true ，最终生成的 homePage 形如：https://xxx.yyy.com/sub_path/pack-name@1.0.0/ark_dist/
-   * changeHomePage 为 false ，最终生成的 homePage 形如：https://xxx.yyy.com/sub_path/
-   */
-  handleHomePage?: boolean;
-  /**
-   * default: 外部包为 unpkg, 内部包为 hel
-   */
-  platform?: string;
-  /** default: unpkg ，当 platform 为 unpkg 时，此参数才有效
-   * 需要发布到npm cdn托管元数据时（支持语义化版本资源请求链接）可设定此值，
-   * 目前支持 unpkg、jsdelivr，后期支持其他 cdn 类型
-   */
-  npmCdnType?: 'unpkg' | 'jsdelivr';
-  /**
-   * default: true
-   * 是否是语义化api格式的cdn链接
-   */
-  semverApi?: boolean;
-  /**
-   * default: 'ark_dist'
-   */
-  distDir?: string;
-}
-
-export interface ICheckOptions {
-  /**
-   * 不传递 fileFullPath 的话，会按照下面的路径去猜测 subApp 文件的位置：
-   *
-   * 执行的代码位于：<projectDir>/node_modules/ark-dev-utils/lib/index.js
-   * 推测路径：path.join(__dirname, '../../../src/configs/subApp')
-   *
-   * 因通常 check 都是在 <projectDir>/scripts/check.js 里执行，如要传递可写为
-   * ```js
-   *  const fileFullPath = path.join(__dirname, '../src/configs/subApp');
-   * ```
-   *
-   */
-  fileFullPath?: string;
-  /**
-   * default: true
-   * 是否检查 process.env.HEL_APP_GROUP_NAME 和 代码里的定义的 LIB_NAME 是否一致
-   */
-  checkEnv?: boolean;
-}
+/**
+ * default: 'all'，生成资源清单时的元数据提取方式，会影响元数据的记录结果
+ * ```
+ * all：提取并记录构建时生成的产物、静态路径导入的产物、homePage之外相对路径导入的产物，同时也会记录 html_content
+ * build：只提取并记录构建时生成的产物，同时也会记录 html_content
+ * all_no_html：提取并记录构建时生成的产物、静态路径导入的产物、homePage之外相对路径导入的产物，不记录 html_content
+ * build_no_html：只提取并记录构建时生成的产物，不记录 html_content
+ * ```
+ */
+type ExtractMode = 'all' | 'build' | 'all_no_html' | 'build_no_html';
+
+/** SrcMap形如：
+{
+  "iconSrc": "/web-app/sub-apps/news-shelf/favicon.ico",
+  "mainCssSrc": "",
+  "chunkCssSrcList": [],
+}
+*/
+export interface SrcMap {
+  webDirPath: string;
+  /** default: 'all' */
+  extractMode: ExtractMode;
+  /** 用于辅助iframe载入子应用入口html地址 */
+  iframeSrc: string;
+  /** 所有依据 homePage 构建生成的 js 列表 */
+  chunkJsSrcList: string[];
+  /** 所有依据 homePage 构建生成的 css 列表 */
+  chunkCssSrcList: string[];
+  /** 所有绝对路径导入的 homePage 之外的 js 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
+  staticJsSrcList: string[];
+  /** 所有绝对路径导入的 homePage 之外的 css 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
+  staticCssSrcList: string[];
+  /** 所有相对路径导入的 homePage 之外的 js 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
+  relativeJsSrcList: string[];
+  /** 所有相对路径导入的 homePage 之外的 css 列表，在 extractMode 为 all 或 all_no_html 时才会记录 */
+  relativeCssSrcList: string[];
+  /** 应用首屏加载时需要插入到 document.head 里的资源列表 */
+  headAssetList: string[];
+  /** 应用首屏加载时需要插入到 document.body 里的资源列表 */
+  bodyAssetList: string[];
+  /** 所有依据 homePage 构建生成的其他类型的资源文件列表 */
+  otherSrcList: string[];
+}
+
+interface ObjBase {
+  create_by: string;
+  // create_at: '2020-04-01T02:51:35.000Z',
+  create_at: string;
+  update_at: string;
+}
+
+export interface SubAppInfo extends ObjBase {
+  id: number;
+  /** app对应的英文名 */
+  name: string;
+  /** app对应的组名 */
+  app_group_name: string;
+  /** app对应在敏感权限系统里的名字 */
+  name_in_sec: string;
+  /** 如果是测试app的话，只下发给测试人员，此种模式的app永远只会将build_version下发给前端，其他xxx_version对于它来说都是冗余的 */
+  is_test: 1 | 0;
+  /** 是否允许灰度 */
+  enable_gray: 1 | 0;
+  /** 是否正在灰度中，每次流水线构建时如果 enable_gray 是1，则此值会设置为1 */
+  is_in_gray: 1 | 0;
+  /** 灰度用户名单 */
+  gray_users: string[];
+  /** 每一个子应用对应的唯一token */
+  token: string;
+  /** app对应的中文名 */
+  cnname: string;
+  splash_screen: string;
+  logo: string;
+  desc: string;
+  owners: string[];
+  _ctime: string;
+  _mtime: string;
+  /** 产品审核通过，将预发布版本变为线上版本 */
+  online_version: string;
+  /** 测试人员提交审核，触发更新预发布版本 */
+  pre_version: string;
+  /** 开发在app后台提交构建版本为测试，触发更新测试版本 */
+  test_version: string;
+  /** 每次蓝盾流水线构建完毕，都会更新构建版本，当做灰度版本使用 */
+  build_version: string;
+  /** 是否允许流水线发布新版本 */
+  enable_pipeline: 1 | 0;
+  /** 是否允许下发给客户端做展示 */
+  enable_display: 1 | 0;
+  /** 请求host */
+  api_host: string;
+  /** 渲染模式 react react-shadow iframe */
+  render_mode: string;
+  class_name: string;
+  versions: string;
+  ui_framework: string;
+  host_map: {
+    online: string;
+    pre: string;
+    build: string;
+  };
+}
+export interface SubAppVersion extends ObjBase {
+  id: number;
+  sub_app_id: string;
+  /** 冗余存储的子应用名称，对应app_info表的name字段 */
+  sub_app_name: string;
+  /** 每次构建新生成的版本号 */
+  sub_app_version: string;
+  /**
+   * 资源描述表map，parse后见domain-inner SrcMap
+   */
+  src_map: string;
+  desc: string;
+}
+
+export interface SubAppVersionEntity extends Omit<SubAppVersion, 'src_map'> {
+  src_map: SrcMap;
+}
+
+/** 形如
+  {
+    fileAbsolutePath: '/tmp/CmsSubAppBxxxxx.chunk.css',
+    cosDirName: 'om_20200408113805',
+    cosFileRelativePath: '/static/css/35.4288e4f0.chunk.css'
+  }
+*/
+export interface FileDesc {
+  /** 文件在构建机容器里所处的绝对路径 */
+  fileAbsolutePath: string;
+  /** 文件在网络上所处的路径 */
+  fileWebPath: string;
+  /** 文件在网络上所处的路径（不带host） */
+  fileWebPathWithoutHost: string;
+}
+
+export interface IAssetOptions {
+  el: HTMLScriptElement;
+  homePage: string;
+  extractMode: SrcMap;
+  enableRelativePath: boolean;
+  enableAssetInnerText: boolean;
+  innerText: string;
+}
+
+export interface IAssetInfo {
+  url: string;
+  el: HTMLScriptElement;
+  isBuildUrl: boolean;
+  isNonBuildAndRelative: boolean;
+  allowAddToAssetList: boolean;
+  canAppend: boolean;
+  innerText: string;
+}
+
+export interface ISubAppBuildDesc {
+  platform: string;
+  homePage: string;
+  npmCdnType: string;
+  groupName: string;
+  semverApi: boolean;
+  name: string;
+  externals: Record<string, any>;
+  /** return merged externals */
+  getExternals: (userExternals?: Record<string, any>) => Record<string, any>;
+  jsonpFnName: string;
+  /**
+   * fallbackPathOrUrl default: '/'
+   * ensureEndSlash default: true
+   */
+  getPublicPathOrUrl: (fallbackPathOrUrl: string, ensureEndSlash: boolean) => string;
+  distDir: string;
+}
+
+/** 用户自定义的各种提取选项 */
+export interface IUserExtractOptions {
+  buildDirFullPath: string;
+  packageJson: Record<string, any>;
+  /**
+   * @deprecated
+   * 应用信息，保留此属性是为了让老用户升级后不报错，内部优先取 appInfo 再取 subApp
+   */
+  subApp: ISubAppBuildDesc;
+  /**
+   * 应用信息
+   */
+  appInfo: ISubAppBuildDesc;
+  /**
+   *  构建版本号，当指定了 appHomePage 且不想采用默认的版本号生成规则时，才需要透传 buildVer 值
+   *  默认生成规则：
+   *  内网包：裁出 appHomePage ${cdnHost}/${appZone}/${appName}_${dateStr} 里的 ${appName}_${dateStr} 作为版本号
+   *  外网包：pkg.version
+   */
+  buildVer?: string;
+  /**
+   * default: 'all'，资源清单元数据提取方式，会影响元数据的记录结果
+   */
+  extractMode?: ExtractMode;
+  /** default: ark_dist */
+  distDir?: string;
+  /** default: true */
+  writeMetaJsonToDist?: boolean;
+  /**
+   * default: false, 针对存在有 innerText 的节点时，是否提取到元数据 srcMap 里，true：提取 innerText 到 srcMap，false：存为外链后放 srcMap
+   * 此参数在针对 vite 产物场景有用，vite 产物里有一些内联的 type='module' 的 script，它们需要被按顺序触发执行，外链后执行顺讯因为网络关系不一定能保证
+   * 设置为 true 后，则 assetItem.innerText 会直接记录内联脚本内容，不再有额外的网络请求去拉取外链资源，执行顺序也就能保证了
+   */
+  enableAssetInnerText?: boolean;
+  /** default: true, 是否替换的 dev.js 结尾的文件为 .js */
+  enableReplaceDevJs?: boolean;
+  /** default: false, 是否允许在 homePage 之外的相对路径的资源存在 */
+  enableRelativePath?: boolean;
+  /**
+   * default: false,是否自动为 html 文件里出现的以单 / 开头的资源拼接上 homePage 前缀
+   * 目前的使用场景式1：
+   * vite.config 不知如何配置 publicUrl，可设置此参数为 true
+   * 开启后，index.html里的 /aaa-123.js 会变为 {homePage}/aaa-123.js
+   */
+  enablePrefixHomePage?: boolean;
+  /** default: undefined, 如无特殊情况，不需要指定，内部会自动去构建目录下查询 .html 结尾的文件 */
+  indexHtmlName?: string;
+}
+
+export interface IInnerSubAppOptions {
+  /** 历史原因，保留 vue3 vue3，目前他们的external配置一样 */
+  frameworkType: 'react' | 'vue2' | 'vue3' | 'vue' | 'lib';
+}
+
+export interface IInnerFillAssetListOptions {
+  homePage: string;
+  buildDirFullPath: string;
+  srcMap: SrcMap;
+  isHead: boolean;
+  enableReplaceDevJs: IUserExtractOptions['enableReplaceDevJs'];
+  enableRelativePath: IUserExtractOptions['enableRelativePath'];
+  enablePrefixHomePage: IUserExtractOptions['enablePrefixHomePage'];
+  enableAssetInnerText: IUserExtractOptions['enableAssetInnerText'];
+  /** webpack compilation 对象，用于在开发模式下通过 emitAsset 输出文件 */
+  compilation?: any;
+  /** 自定义资产列表，用于收集从 HTML 内联脚本提取的代码 */
+  customAssets?: Array<{ scriptName: string; fileWebPath: string; content: string }>;
+}
+
+export interface ICreateSubAppOptions {
+  externals?: Record<string, any>;
+  homePage?: string;
+  /**
+   * default: true，
+   * 当 platform 为 unpkg ，且用户自定义了 homePage 值时， 此参数才有作用
+   * 表示最终生成的homepage值是否拼接上模块名、版本号、hel内置目录等参数
+   * 例如用户设定 homePage: https://xxx.yyy.com/sub_path
+   * changeHomePage 为 true ，最终生成的 homePage 形如：https://xxx.yyy.com/sub_path/pack-name@1.0.0/ark_dist/
+   * changeHomePage 为 false ，最终生成的 homePage 形如：https://xxx.yyy.com/sub_path/
+   */
+  handleHomePage?: boolean;
+  /**
+   * default: 外部包为 unpkg, 内部包为 hel
+   */
+  platform?: string;
+  /** default: unpkg ，当 platform 为 unpkg 时，此参数才有效
+   * 需要发布到npm cdn托管元数据时（支持语义化版本资源请求链接）可设定此值，
+   * 目前支持 unpkg、jsdelivr，后期支持其他 cdn 类型
+   */
+  npmCdnType?: 'unpkg' | 'jsdelivr';
+  /**
+   * default: true
+   * 是否是语义化api格式的cdn链接
+   */
+  semverApi?: boolean;
+  /**
+   * default: 'ark_dist'
+   */
+  distDir?: string;
+}
+
+export interface ICheckOptions {
+  /**
+   * 不传递 fileFullPath 的话，会按照下面的路径去猜测 subApp 文件的位置：
+   *
+   * 执行的代码位于：<projectDir>/node_modules/ark-dev-utils/lib/index.js
+   * 推测路径：path.join(__dirname, '../../../src/configs/subApp')
+   *
+   * 因通常 check 都是在 <projectDir>/scripts/check.js 里执行，如要传递可写为
+   * ```js
+   *  const fileFullPath = path.join(__dirname, '../src/configs/subApp');
+   * ```
+   *
+   */
+  fileFullPath?: string;
+  /**
+   * default: true
+   * 是否检查 process.env.HEL_APP_GROUP_NAME 和 代码里的定义的 LIB_NAME 是否一致
+   */
+  checkEnv?: boolean;
+}