@oceanbase/ui 1.0.0-alpha.8 → 1.0.0

package/lib/BackgroundTaskManager/index.js

@@ -1,132 +1,135 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+"use strict";
 
-// src/BackgroundTaskManager/index.tsx
-var BackgroundTaskManager_exports = {};
-__export(BackgroundTaskManager_exports, {
-  BackgroundTaskManagerConstants: () => BackgroundTaskManagerConstants,
-  NotificationApi: () => NotificationApi,
-  default: () => BackgroundTaskManager_default
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
-module.exports = __toCommonJS(BackgroundTaskManager_exports);
-var import_react = require("react");
-var import_design = require("@oceanbase/design");
-var import_constants = require("./constants");
-var import_RefreshMan = require("./RefreshMan");
-var import_jsx_runtime = require("react/jsx-runtime");
-var NotificationApi = /* @__PURE__ */ ((NotificationApi2) => {
-  NotificationApi2["success"] = "success";
-  NotificationApi2["error"] = "error";
-  NotificationApi2["info"] = "info";
-  NotificationApi2["warning"] = "warning";
-  NotificationApi2["open"] = "open";
-  return NotificationApi2;
-})(NotificationApi || {});
-var BackgroundTaskManagerConstants = {
-  REFRESH_FREQUENCY: import_constants.REFRESH_FREQUENCY,
+exports.default = exports.NotificationApi = exports.BackgroundTaskManagerConstants = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _design = require("@oceanbase/design");
+var _constants = require("./constants");
+var _RefreshMan = require("./RefreshMan");
+var _jsxRuntime = require("react/jsx-runtime");
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+"use client"; // antd Notification组件支持的api种类
+let NotificationApi = exports.NotificationApi = /*#__PURE__*/function (NotificationApi) {
+  NotificationApi["success"] = "success";
+  NotificationApi["error"] = "error";
+  NotificationApi["info"] = "info";
+  NotificationApi["warning"] = "warning";
+  NotificationApi["open"] = "open";
+  return NotificationApi;
+}({});
+const BackgroundTaskManagerConstants = exports.BackgroundTaskManagerConstants = {
+  REFRESH_FREQUENCY: _constants.REFRESH_FREQUENCY,
   NotificationApi
 };
-var BackgroundTaskManager_default = (0, import_react.forwardRef)((props, ref) => {
-  const { rollingFrequency = import_constants.REFRESH_FREQUENCY.EXTREMELY, prefix } = props;
-  const [queue, setQueue] = (0, import_react.useState)({});
-  const [preset, setPreset] = (0, import_react.useState)({});
-  const pushQueue = (0, import_react.useCallback)(
-    (q) => {
-      setQueue({
-        ...queue,
-        ...q
-      });
-    },
-    [queue, setQueue]
-  );
-  const popQueue = (0, import_react.useCallback)(
-    (id) => {
-      delete queue[id];
-      setQueue({ ...queue });
-    },
-    [queue, setQueue]
-  );
-  const taskQueue = (0, import_react.useMemo)(() => {
+const visuallyHiddenStyle = {
+  position: 'absolute',
+  width: 1,
+  height: 1,
+  padding: 0,
+  margin: -1,
+  overflow: 'hidden',
+  clip: 'rect(0, 0, 0, 0)',
+  whiteSpace: 'nowrap',
+  border: 0
+};
+var _default = exports.default = /*#__PURE__*/(0, _react.forwardRef)((props, ref) => {
+  const {
+    rollingFrequency = _constants.REFRESH_FREQUENCY.EXTREMELY,
+    prefix,
+    taskStatusTemplate = '{count} background tasks in progress'
+  } = props;
+  // 任务管理器的任务队列
+  const [queue, setQueue] = (0, _react.useState)({});
+  // 任务管理器的行为预设
+  const [preset, setPreset] = (0, _react.useState)({});
+
+  // push任务队列
+  const pushQueue = (0, _react.useCallback)(q => {
+    setQueue({
+      ...queue,
+      ...q
+    });
+  }, [queue, setQueue]);
+  // pop任务队列
+  const popQueue = (0, _react.useCallback)(id => {
+    delete queue[id];
+    setQueue({
+      ...queue
+    });
+  }, [queue, setQueue]);
+  const taskQueue = (0, _react.useMemo)(() => {
     return Object.entries(queue);
   }, [queue]);
-  const run = (0, import_react.useCallback)(
-    (newPreset) => {
-      if (!!taskQueue.length) {
-        taskQueue == null ? void 0 : taskQueue.forEach(([id, ns]) => {
-          const realPreset = newPreset ?? preset;
-          if (!realPreset[ns]) {
-            console.warn("cannot find preset of namespace: ", ns);
-            return;
+  const run = (0, _react.useCallback)(newPreset => {
+    if (!!taskQueue.length) {
+      taskQueue?.forEach(([id, ns]) => {
+        const realPreset = newPreset ?? preset;
+        if (!realPreset[ns]) {
+          console.warn('cannot find preset of namespace: ', ns);
+          return;
+        }
+        const {
+          api,
+          successCb,
+          failedCb
+        } = realPreset[ns];
+        api?.({
+          id
+        }).then(res => {
+          const {
+            type,
+            config
+          } = successCb(res, id) || {
+            type: null,
+            config: null
+          };
+          if (type) {
+            _design.notification[type](config);
           }
-          const { api, successCb, failedCb } = realPreset[ns];
-          api == null ? void 0 : api({ id }).then((res) => {
-            const { type, config } = successCb(res, id) || {
+        }).catch(err => {
+          if (failedCb) {
+            const {
+              type,
+              config
+            } = failedCb(err, id) || {
               type: null,
               config: null
             };
             if (type) {
-              import_design.notification[type](config);
-            }
-          }).catch((err) => {
-            if (failedCb) {
-              const { type, config } = failedCb(err, id) || {
-                type: null,
-                config: null
-              };
-              if (type) {
-                import_design.notification[type](config);
-              }
+              _design.notification[type](config);
             }
-          });
+          }
         });
-      }
-    },
-    [taskQueue, preset]
-  );
-  const pushPreset = (0, import_react.useCallback)(
-    (p) => {
-      const newPreset = {
-        ...preset,
-        ...p
-      };
-      if (Object.keys(newPreset).length === Object.keys(preset).length)
-        return;
-      setPreset(newPreset);
-      run(newPreset);
-    },
-    [preset, setPreset, run]
-  );
-  const fetchPreset = (0, import_react.useCallback)(() => {
+      });
+    }
+  }, [taskQueue, preset]);
+
+  // push任务预设
+  const pushPreset = (0, _react.useCallback)(p => {
+    const newPreset = {
+      ...preset,
+      ...p
+    };
+    if (Object.keys(newPreset).length === Object.keys(preset).length) return;
+    setPreset(newPreset);
+    run(newPreset);
+  }, [preset, setPreset, run]);
+  const fetchPreset = (0, _react.useCallback)(() => {
     return preset;
   }, [preset]);
-  const fetchQueue = (0, import_react.useCallback)(() => {
+  const fetchQueue = (0, _react.useCallback)(() => {
     return queue;
   }, [queue]);
-  const fetchQueueNsById = (0, import_react.useCallback)(
-    (id) => {
-      return queue[id];
-    },
-    [queue]
-  );
-  const closeNotification = (0, import_react.useCallback)((key) => {
-    import_design.notification.destroy(key);
+  const fetchQueueNsById = (0, _react.useCallback)(id => {
+    return queue[id];
+  }, [queue]);
+  const closeNotification = (0, _react.useCallback)(key => {
+    _design.notification.destroy(key);
   }, []);
-  (0, import_react.useImperativeHandle)(ref, () => ({
+  (0, _react.useImperativeHandle)(ref, () => ({
     pushQueue,
     popQueue,
     setQueue,
@@ -137,30 +140,38 @@ var BackgroundTaskManager_default = (0, import_react.forwardRef)((props, ref) =>
     fetchQueueNsById,
     closeNotification
   }));
-  const getLocalStorageIds = (0, import_react.useCallback)(() => {
-    const storedIdsStr = window.localStorage.getItem(prefix) || "[]";
+  const getLocalStorageIds = (0, _react.useCallback)(() => {
+    const storedIdsStr = window.localStorage.getItem(prefix) || '[]';
     const storedQueue = JSON.parse(storedIdsStr);
     return storedQueue;
   }, []);
-  (0, import_react.useEffect)(() => {
+  (0, _react.useEffect)(() => {
     const storedQueue = getLocalStorageIds();
-    if (!!Object.keys(storedQueue).length)
-      setQueue(storedQueue);
+    if (!!Object.keys(storedQueue).length) setQueue(storedQueue);
   }, [setQueue, getLocalStorageIds]);
-  (0, import_react.useEffect)(() => {
+
+  // 组件销毁和beforeunload都需要同步
+  (0, _react.useEffect)(() => {
     const onUnload = () => {
       window.localStorage.setItem(prefix, JSON.stringify(queue));
     };
-    window.addEventListener("beforeunload", onUnload);
+    window.addEventListener('beforeunload', onUnload);
     return () => {
       window.localStorage.setItem(prefix, JSON.stringify(queue));
-      window.removeEventListener("beforeunload", onUnload);
+      window.removeEventListener('beforeunload', onUnload);
     };
   }, [queue, preset]);
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children: !!taskQueue.length && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_RefreshMan.RefreshMan, { run, rollingFrequency }) });
-});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  BackgroundTaskManagerConstants,
-  NotificationApi
-});
+  const statusMessage = taskQueue.length > 0 ? taskStatusTemplate.replace('{count}', String(taskQueue.length)) : '';
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)(_jsxRuntime.Fragment, {
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+      role: "status",
+      "aria-live": "polite",
+      "aria-atomic": "true",
+      style: visuallyHiddenStyle,
+      children: statusMessage
+    }), !!taskQueue.length && /*#__PURE__*/(0, _jsxRuntime.jsx)(_RefreshMan.RefreshMan, {
+      run: run,
+      rollingFrequency: rollingFrequency
+    })]
+  });
+});