xframelib 0.4.2 → 0.4.7

package/dist/model/Layout.d.ts

@@ -24,13 +24,52 @@ export interface IWidgetLayout {
     height?: string;
 }
 export interface IWidgetConfig {
+    /**
+     * 唯一ID,与组件名一致
+     */
     id: string;
+    /**
+     * 标题或说明
+     */
     label?: string;
+    /**
+     * 图标路径(备用)
+     */
     icon?: string;
+    /**
+     * 所属容器，top/bottom/left/right等
+     */
     container: LayoutContainerEnum;
+    /**
+     * 外部组件js url(备用)
+     */
+    jsURL?: string;
+    /**
+     * 外部组件css url(备用)
+     */
+    cssURL?: string;
+    /**
+     * 动态加载的组件
+     */
     component: Lazy<Component>;
+    /**
+     * 是否初始化时，预加载
+     */
     preload?: boolean;
+    /**
+     * 前置容器ID,一般也就是bindid
+     */
     afterid?: string;
+    /**
+     * 绑定依赖容器ID,不一定有afterid
+     */
+    bindid?: string;
+    /**
+     * 所属组，用于业务分类
+     */
     group?: string;
+    /**
+     * 外部定义布局(备用)
+     */
     layout?: IWidgetLayout;
 }

package/dist/public/mitm.html

@@ -0,0 +1,166 @@
+<!--
+	mitm.html is the lite "man in the middle"
+
+	This is only meant to signal the opener's messageChannel to
+	the service worker - when that is done this mitm can be closed
+    but it's better to keep it alive since this also stops the sw
+    from restarting
+
+	The service worker is capable of intercepting all request and fork their
+	own "fake" response - wish we are going to craft
+	when the worker then receives a stream then the worker will tell the opener
+	to open up a link that will start the download
+-->
+<script>
+// This will prevent the sw from restarting
+let keepAlive = () => {
+  keepAlive = () => {}
+  var ping = location.href.substr(0, location.href.lastIndexOf('/')) + '/ping'
+  var interval = setInterval(() => {
+    if (sw) {
+      sw.postMessage('ping')
+    } else {
+      fetch(ping).then(res => res.text(!res.ok && clearInterval(interval)))
+    }
+  }, 10000)
+}
+
+// message event is the first thing we need to setup a listner for
+// don't want the opener to do a random timeout - instead they can listen for
+// the ready event
+// but since we need to wait for the Service Worker registration, we store the
+// message for later
+let messages = []
+window.onmessage = evt => messages.push(evt)
+
+let sw = null
+let scope = ''
+
+function registerWorker() {
+  return navigator.serviceWorker.getRegistration('./').then(swReg => {
+    return swReg || navigator.serviceWorker.register('sw.js', { scope: './' })
+  }).then(swReg => {
+    const swRegTmp = swReg.installing || swReg.waiting
+
+    scope = swReg.scope
+
+    return (sw = swReg.active) || new Promise(resolve => {
+      swRegTmp.addEventListener('statechange', fn = () => {
+        if (swRegTmp.state === 'activated') {
+          swRegTmp.removeEventListener('statechange', fn)
+          sw = swReg.active
+          resolve()
+        }
+      })
+    })
+  })
+}
+
+// Now that we have the Service Worker registered we can process messages
+function onMessage (event) {
+  let { data, ports, origin } = event
+
+  // It's important to have a messageChannel, don't want to interfere
+  // with other simultaneous downloads
+  if (!ports || !ports.length) {
+    throw new TypeError("[StreamSaver] You didn't send a messageChannel")
+  }
+
+  if (typeof data !== 'object') {
+    throw new TypeError("[StreamSaver] You didn't send a object")
+  }
+
+  // the default public service worker for StreamSaver is shared among others.
+  // so all download links needs to be prefixed to avoid any other conflict
+  data.origin = origin
+
+  // if we ever (in some feature versoin of streamsaver) would like to
+  // redirect back to the page of who initiated a http request
+  data.referrer = data.referrer || document.referrer || origin
+
+  // pass along version for possible backwards compatibility in sw.js
+  data.streamSaverVersion = new URLSearchParams(location.search).get('version')
+
+  if (data.streamSaverVersion === '1.2.0') {
+    console.warn('[StreamSaver] please update streamsaver')
+  }
+
+  /** @since v2.0.0 */
+  if (!data.headers) {
+    console.warn("[StreamSaver] pass `data.headers` that you would like to pass along to the service worker\nit should be a 2D array or a key/val object that fetch's Headers api accepts")
+  } else {
+    // test if it's correct
+    // should thorw a typeError if not
+    new Headers(data.headers)
+  }
+
+  /** @since v2.0.0 */
+  if (typeof data.filename === 'string') {
+    console.warn("[StreamSaver] You shouldn't send `data.filename` anymore. It should be included in the Content-Disposition header option")
+    // Do what File constructor do with fileNames
+    data.filename = data.filename.replace(/\//g, ':')
+  }
+
+  /** @since v2.0.0 */
+  if (data.size) {
+    console.warn("[StreamSaver] You shouldn't send `data.size` anymore. It should be included in the content-length header option")
+  }
+
+  /** @since v2.0.0 */
+  if (data.readableStream) {
+    console.warn("[StreamSaver] You should send the readableStream in the messageChannel, not throught mitm")
+  }
+
+  /** @since v2.0.0 */
+  if (!data.pathname) {
+    console.warn("[StreamSaver] Please send `data.pathname` (eg: /pictures/summer.jpg)")
+    data.pathname = Math.random().toString().slice(-6) + '/' + data.filename
+  }
+
+  // remove all leading slashes
+  data.pathname = data.pathname.replace(/^\/+/g, '')
+
+  // remove protocol
+  let org = origin.replace(/(^\w+:|^)\/\//, '')
+
+  // set the absolute pathname to the download url.
+  data.url = new URL(`${scope + org}/${data.pathname}`).toString()
+
+  if (!data.url.startsWith(`${scope + org}/`)) {
+    throw new TypeError('[StreamSaver] bad `data.pathname`')
+  }
+
+  // This sends the message data as well as transferring
+  // messageChannel.port2 to the service worker. The service worker can
+  // then use the transferred port to reply via postMessage(), which
+  // will in turn trigger the onmessage handler on messageChannel.port1.
+
+  const transferable = data.readableStream
+    ? [ ports[0], data.readableStream ]
+    : [ ports[0] ]
+
+  if (!(data.readableStream || data.transferringReadable)) {
+    keepAlive()
+  }
+
+  return sw.postMessage(data, transferable)
+}
+
+if (window.opener) {
+  // The opener can't listen to onload event, so we need to help em out!
+  // (telling them that we are ready to accept postMessage's)
+  window.opener.postMessage('StreamSaver::loadedPopup', '*')
+}
+
+if (navigator.serviceWorker) {
+  registerWorker().then(() => {
+    window.onmessage = onMessage
+    messages.forEach(window.onmessage)
+  })
+} else {
+  // FF can ping sw with fetch from a secure hidden iframe
+  // shouldn't really be possible?
+  keepAlive()
+}
+
+</script>

package/dist/public/sw.js

@@ -0,0 +1,128 @@
+/* global self ReadableStream Response */
+
+self.addEventListener('install', () => {
+  self.skipWaiting()
+})
+
+self.addEventListener('activate', event => {
+  event.waitUntil(self.clients.claim())
+})
+
+const map = new Map()
+
+// This should be called once per download
+// Each event has a dataChannel that the data will be piped through
+self.onmessage = event => {
+  // We send a heartbeat every x secound to keep the
+  // service worker alive if a transferable stream is not sent
+  if (event.data === 'ping') {
+    return
+  }
+
+  const data = event.data
+  const downloadUrl = data.url || self.registration.scope + Math.random() + '/' + (typeof data === 'string' ? data : data.filename)
+  const port = event.ports[0]
+  const metadata = new Array(3) // [stream, data, port]
+
+  metadata[1] = data
+  metadata[2] = port
+
+  // Note to self:
+  // old streamsaver v1.2.0 might still use `readableStream`...
+  // but v2.0.0 will always transfer the stream throught MessageChannel #94
+  if (event.data.readableStream) {
+    metadata[0] = event.data.readableStream
+  } else if (event.data.transferringReadable) {
+    port.onmessage = evt => {
+      port.onmessage = null
+      metadata[0] = evt.data.readableStream
+    }
+  } else {
+    metadata[0] = createStream(port)
+  }
+
+  map.set(downloadUrl, metadata)
+  port.postMessage({ download: downloadUrl })
+}
+
+function createStream (port) {
+  // ReadableStream is only supported by chrome 52
+  return new ReadableStream({
+    start (controller) {
+      // When we receive data on the messageChannel, we write
+      port.onmessage = ({ data }) => {
+        if (data === 'end') {
+          return controller.close()
+        }
+
+        if (data === 'abort') {
+          controller.error('Aborted the download')
+          return
+        }
+
+        controller.enqueue(data)
+      }
+    },
+    cancel () {
+      console.log('user aborted')
+    }
+  })
+}
+
+self.onfetch = event => {
+  const url = event.request.url
+
+  // this only works for Firefox
+  if (url.endsWith('/ping')) {
+    return event.respondWith(new Response('pong'))
+  }
+
+  const hijacke = map.get(url)
+
+  if (!hijacke) return null
+
+  const [ stream, data, port ] = hijacke
+
+  map.delete(url)
+
+  // Not comfortable letting any user control all headers
+  // so we only copy over the length & disposition
+  const responseHeaders = new Headers({
+    'Content-Type': 'application/octet-stream; charset=utf-8',
+
+    // To be on the safe side, The link can be opened in a iframe.
+    // but octet-stream should stop it.
+    'Content-Security-Policy': "default-src 'none'",
+    'X-Content-Security-Policy': "default-src 'none'",
+    'X-WebKit-CSP': "default-src 'none'",
+    'X-XSS-Protection': '1; mode=block'
+  })
+
+  let headers = new Headers(data.headers || {})
+
+  if (headers.has('Content-Length')) {
+    responseHeaders.set('Content-Length', headers.get('Content-Length'))
+  }
+
+  if (headers.has('Content-Disposition')) {
+    responseHeaders.set('Content-Disposition', headers.get('Content-Disposition'))
+  }
+
+  // data, data.filename and size should not be used anymore
+  if (data.size) {
+    console.warn('Depricated')
+    responseHeaders.set('Content-Length', data.size)
+  }
+
+  let fileName = typeof data === 'string' ? data : data.filename
+  if (fileName) {
+    console.warn('Depricated')
+    // Make filename RFC5987 compatible
+    fileName = encodeURIComponent(fileName).replace(/['()]/g, escape).replace(/\*/g, '%2A')
+    responseHeaders.set('Content-Disposition', "attachment; filename*=UTF-8''" + fileName)
+  }
+
+  event.respondWith(new Response(stream, { headers: responseHeaders }))
+
+  port.postMessage({ debug: 'Download started' })
+}

package/dist/utils/AxiosHelper.d.ts

@@ -7,26 +7,33 @@ export declare type ResponseType = 'arraybuffer' | 'blob' | 'document' | 'json'
  * @param headers headers参数
  * @param responseType 响应类型,默认为json
  * @param cancelToken  取消标识
+ * @param timeoutMS 超时时间-毫秒
  * @returns 返回Promise对象
  */
-declare function requestGet(apiUrl: string, baseUrl?: string, _params?: any, headers?: any, responseType?: ResponseType, cancelToken?: any): Promise<any>;
+declare function requestGet(apiUrl: string, baseUrl?: string, _params?: any, headers?: any, responseType?: ResponseType, cancelToken?: any, timeoutMS?: number): Promise<any>;
 /**
  * Post服务请求-FormData
  * @param apiUrl API接口路径
  * @param baseUrl 基础服务路径
  * @param _params 参数
  * @param headers headers参数
+ * @param responseType 返回类型，默认为json
+ * @param timeoutMS  超时时间，默认为60000毫秒
  * @returns 返回Promise对象
  */
-declare function requestPost(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType): Promise<any>;
+declare function requestPost(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType, timeoutMS?: number): Promise<any>;
 /**
  * Post服务请求-Body方式
  * @param apiUrl API接口路径
  * @param baseUrl 基础服务路径
- * @param _params 参数
- * @returns 返回Promise对象
+ * @param _bodyParams body相关参数
+ * @param _queryParams  url的相关参数
+ * @param headers 头相关参数
+ * @param responseType 返回类型，默认为json
+ * @param timeoutMS  超时时间，默认为60000毫秒
+ * @returns
  */
-declare function requestPostBody(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType): Promise<any>;
+declare function requestPostBody(apiUrl: string, baseUrl?: string, _bodyParams?: any, _queryParams?: any, headers?: any, responseType?: ResponseType, timeoutMS?: number): Promise<any>;
 /**
  * 业务服务Get请求
  * @param apiUrl API接口路径

package/dist/utils/BigFileDownload.d.ts

@@ -29,7 +29,17 @@ export declare class BigFileDownload {
     private cancelSource;
     private isStarting;
     private fileName?;
-    constructor(fileID: string, downloadURL: string, chunkSizeM?: number);
+    private cacheSize;
+    private requestTimeout;
+    /**
+     *
+     * @param fileID
+     * @param downloadURL 下载链接
+     * @param chunkSizeM 分片大小，默认为3M
+     * @param cacheNum 缓存大小
+     * @param requestTimeoutMS 请求超时时间(毫秒)默认为60s
+     */
+    constructor(fileID: string, downloadURL: string, chunkSizeM?: number, cacheNum?: number, requestTimeoutMS?: number);
     /**
      * 订阅事件
      */
@@ -87,10 +97,11 @@ export declare class BigFileDownload {
      * 删除下载任务
      */
     delete(): void;
+    sleep(ms: any): Promise<unknown>;
     /**
      * 开始分段下载
      */
-    download(downURL?: string): void;
+    download(downURL?: string): Promise<void>;
     /**
      * 下载完成进度
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xframelib",
-  "version": "0.4.2",
+  "version": "0.4.7",
   "description": "积累的前端开发基础库",
   "main": "dist/index.js",
   "common": "dist/index.cjs",
@@ -31,27 +31,27 @@
     "xhr": "^2.6.0"
   },
   "devDependencies": {
-    "@rollup/plugin-alias": "^3.1.8",
+    "@rollup/plugin-alias": "^3.1.9",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.0.6",
+    "@rollup/plugin-node-resolve": "^13.1.2",
     "@rollup/plugin-typescript": "^8.3.0",
     "@types/streamsaver": "^2.0.1",
-    "@vitejs/plugin-vue": "^1.9.3",
-    "@vue/compiler-sfc": "^3.2.20",
-    "axios": "^0.23.0",
-    "esbuild": "^0.13.9",
-    "node-sass": "^6.0.1",
-    "rollup-plugin-esbuild": "^4.6.0",
+    "@vitejs/plugin-vue": "^2.0.1",
+    "@vue/compiler-sfc": "^3.2.26",
+    "axios": "^0.24.0",
+    "esbuild": "^0.14.10",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-esbuild": "^4.8.2",
     "rollup-plugin-scss": "^3.0.0",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.31.1",
     "rollup-plugin-vue": "^6.0.0",
-    "sass": "^1.43.3",
-    "typescript": "^4.4.4",
-    "vite": "^2.6.10",
+    "sass": "^1.45.2",
+    "typescript": "^4.5.4",
+    "vite": "^2.7.10",
     "vue": "^3.2.20",
     "vue-router": "^4.0.10",
-    "vue-tsc": "^0.28.8"
+    "vue-tsc": "^0.30.2"
   }
 }