@atlaskit/editor-plugin-user-preferences 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/ui/useDocumentVisibilityWatcher.js +53 -0
  3. package/dist/cjs/userPreferencesPlugin.js +2 -0
  4. package/dist/es2019/ui/useDocumentVisibilityWatcher.js +24 -0
  5. package/dist/es2019/userPreferencesPlugin.js +2 -0
  6. package/dist/esm/ui/useDocumentVisibilityWatcher.js +46 -0
  7. package/dist/esm/userPreferencesPlugin.js +2 -0
  8. package/dist/types/pm-plugins/commands.d.ts +2 -2
  9. package/dist/types/ui/useDocumentVisibilityWatcher.d.ts +2 -0
  10. package/dist/types-ts4.5/pm-plugins/commands.d.ts +2 -2
  11. package/dist/types-ts4.5/ui/useDocumentVisibilityWatcher.d.ts +2 -0
  12. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/editor-plugin-user-preferences
2
2
 
3
+ ## 1.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#180076](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/180076)
8
+ [`f4353390abf4e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f4353390abf4e) -
9
+ ED-27284 restore page active wather
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
3
15
  ## 1.0.0
4
16
 
5
17
  ### Major Changes
package/dist/cjs/ui/useDocumentVisibilityWatcher.js ADDED
@@ -0,0 +1,53 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.useDocumentVisibilityWatcher = void 0;
8
+ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
9
+ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
10
+ var _react = require("react");
11
+ var _bindEventListener = require("bind-event-listener");
12
+ var _monitoring = require("@atlaskit/editor-common/monitoring");
13
+ var useDocumentVisibilityWatcher = exports.useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
14
+ (0, _react.useEffect)(function () {
15
+ if (userPreferencesProvider) {
16
+ var refreshPreferences = /*#__PURE__*/function () {
17
+ var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
18
+ return _regenerator.default.wrap(function _callee$(_context) {
19
+ while (1) switch (_context.prev = _context.next) {
20
+ case 0:
21
+ if (!(document.visibilityState === 'visible')) {
22
+ _context.next = 9;
23
+ break;
24
+ }
25
+ _context.prev = 1;
26
+ _context.next = 4;
27
+ return userPreferencesProvider.loadPreferences();
28
+ case 4:
29
+ _context.next = 9;
30
+ break;
31
+ case 6:
32
+ _context.prev = 6;
33
+ _context.t0 = _context["catch"](1);
34
+ (0, _monitoring.logException)(_context.t0, {
35
+ location: 'editor-plugin-user-preferences/userPreferencesPlugin'
36
+ });
37
+ case 9:
38
+ case "end":
39
+ return _context.stop();
40
+ }
41
+ }, _callee, null, [[1, 6]]);
42
+ }));
43
+ return function refreshPreferences() {
44
+ return _ref.apply(this, arguments);
45
+ };
46
+ }();
47
+ return (0, _bindEventListener.bind)(document, {
48
+ type: 'visibilitychange',
49
+ listener: refreshPreferences
50
+ });
51
+ }
52
+ }, [userPreferencesProvider]);
53
+ };
package/dist/cjs/userPreferencesPlugin.js CHANGED
@@ -7,6 +7,7 @@ exports.userPreferencesPlugin = void 0;
7
7
  var _userPreferences = require("@atlaskit/editor-common/user-preferences");
8
8
  var _commands = require("./pm-plugins/commands");
9
9
  var _main = require("./pm-plugins/main");
10
+ var _useDocumentVisibilityWatcher = require("./ui/useDocumentVisibilityWatcher");
10
11
  var _useUserPreferencesInitListener = require("./ui/useUserPreferencesInitListener");
11
12
  var _useUserPreferencesUpdateListener = require("./ui/useUserPreferencesUpdateListener");
12
13
  var userPreferencesPlugin = exports.userPreferencesPlugin = function userPreferencesPlugin(_ref) {
@@ -45,6 +46,7 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
45
46
  var _useResolvedUserPrefe = (0, _userPreferences.useResolvedUserPreferences)(userPreferencesProvider),
46
47
  resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
47
48
  (0, _useUserPreferencesUpdateListener.useUserPreferencesUpdateListener)(editorView, resolvedUserPreferences);
49
+ (0, _useDocumentVisibilityWatcher.useDocumentVisibilityWatcher)(userPreferencesProvider);
48
50
  (0, _useUserPreferencesInitListener.useUserPreferencesInitListener)(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
49
51
  }
50
52
  };
package/dist/es2019/ui/useDocumentVisibilityWatcher.js ADDED
@@ -0,0 +1,24 @@
1
+ import { useEffect } from 'react';
2
+ import { bind } from 'bind-event-listener';
3
+ import { logException } from '@atlaskit/editor-common/monitoring';
4
+ export const useDocumentVisibilityWatcher = userPreferencesProvider => {
5
+ useEffect(() => {
6
+ if (userPreferencesProvider) {
7
+ const refreshPreferences = async () => {
8
+ if (document.visibilityState === 'visible') {
9
+ try {
10
+ await userPreferencesProvider.loadPreferences();
11
+ } catch (error) {
12
+ logException(error, {
13
+ location: 'editor-plugin-user-preferences/userPreferencesPlugin'
14
+ });
15
+ }
16
+ }
17
+ };
18
+ return bind(document, {
19
+ type: 'visibilitychange',
20
+ listener: refreshPreferences
21
+ });
22
+ }
23
+ }, [userPreferencesProvider]);
24
+ };
package/dist/es2019/userPreferencesPlugin.js CHANGED
@@ -1,6 +1,7 @@
1
1
  import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
2
2
  import { updateUserPreference } from './pm-plugins/commands';
3
3
  import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
4
+ import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
4
5
  import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
5
6
  import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
6
7
  export const userPreferencesPlugin = ({
@@ -42,6 +43,7 @@ export const userPreferencesPlugin = ({
42
43
  resolvedUserPreferences
43
44
  } = useResolvedUserPreferences(userPreferencesProvider);
44
45
  useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
46
+ useDocumentVisibilityWatcher(userPreferencesProvider);
45
47
  useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
46
48
  }
47
49
  };
package/dist/esm/ui/useDocumentVisibilityWatcher.js ADDED
@@ -0,0 +1,46 @@
1
+ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
2
+ import _regeneratorRuntime from "@babel/runtime/regenerator";
3
+ import { useEffect } from 'react';
4
+ import { bind } from 'bind-event-listener';
5
+ import { logException } from '@atlaskit/editor-common/monitoring';
6
+ export var useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
7
+ useEffect(function () {
8
+ if (userPreferencesProvider) {
9
+ var refreshPreferences = /*#__PURE__*/function () {
10
+ var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
11
+ return _regeneratorRuntime.wrap(function _callee$(_context) {
12
+ while (1) switch (_context.prev = _context.next) {
13
+ case 0:
14
+ if (!(document.visibilityState === 'visible')) {
15
+ _context.next = 9;
16
+ break;
17
+ }
18
+ _context.prev = 1;
19
+ _context.next = 4;
20
+ return userPreferencesProvider.loadPreferences();
21
+ case 4:
22
+ _context.next = 9;
23
+ break;
24
+ case 6:
25
+ _context.prev = 6;
26
+ _context.t0 = _context["catch"](1);
27
+ logException(_context.t0, {
28
+ location: 'editor-plugin-user-preferences/userPreferencesPlugin'
29
+ });
30
+ case 9:
31
+ case "end":
32
+ return _context.stop();
33
+ }
34
+ }, _callee, null, [[1, 6]]);
35
+ }));
36
+ return function refreshPreferences() {
37
+ return _ref.apply(this, arguments);
38
+ };
39
+ }();
40
+ return bind(document, {
41
+ type: 'visibilitychange',
42
+ listener: refreshPreferences
43
+ });
44
+ }
45
+ }, [userPreferencesProvider]);
46
+ };
package/dist/esm/userPreferencesPlugin.js CHANGED
@@ -1,6 +1,7 @@
1
1
  import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
2
2
  import { updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
3
3
  import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
4
+ import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
4
5
  import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
5
6
  import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
6
7
  export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
@@ -39,6 +40,7 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
39
40
  var _useResolvedUserPrefe = useResolvedUserPreferences(userPreferencesProvider),
40
41
  resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
41
42
  useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
43
+ useDocumentVisibilityWatcher(userPreferencesProvider);
42
44
  useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
43
45
  }
44
46
  };
package/dist/types/pm-plugins/commands.d.ts CHANGED
@@ -3,7 +3,7 @@ import type { EditorCommand } from '@atlaskit/editor-common/types';
3
3
  import { type ResolvedUserPreferences, type UserPreferences, type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
4
4
  export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
5
5
  key: keyof UserPreferences;
6
- value: "top" | "none";
7
- userPreferencesProvider?: UserPreferencesProvider | undefined;
6
+ value: ResolvedUserPreferences[typeof key];
7
+ userPreferencesProvider?: UserPreferencesProvider;
8
8
  editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
9
9
  }) => EditorCommand;
package/dist/types/ui/useDocumentVisibilityWatcher.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
2
+ export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;
package/dist/types-ts4.5/pm-plugins/commands.d.ts CHANGED
@@ -3,7 +3,7 @@ import type { EditorCommand } from '@atlaskit/editor-common/types';
3
3
  import { type ResolvedUserPreferences, type UserPreferences, type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
4
4
  export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
5
5
  key: keyof UserPreferences;
6
- value: "top" | "none";
7
- userPreferencesProvider?: UserPreferencesProvider | undefined;
6
+ value: ResolvedUserPreferences[typeof key];
7
+ userPreferencesProvider?: UserPreferencesProvider;
8
8
  editorAnalyticsApi?: EditorAnalyticsAPI | undefined;
9
9
  }) => EditorCommand;
package/dist/types-ts4.5/ui/useDocumentVisibilityWatcher.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ import { type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
2
+ export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-user-preferences",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "UserPreferences plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -34,12 +34,12 @@
34
34
  "@atlaskit/editor-plugin-analytics": "^3.0.0",
35
35
  "@atlaskit/editor-prosemirror": "7.0.0",
36
36
  "@atlaskit/platform-feature-flags": "^1.1.0",
37
- "@atlaskit/tmp-editor-statsig": "^8.7.0",
37
+ "@atlaskit/tmp-editor-statsig": "^8.8.0",
38
38
  "@babel/runtime": "^7.0.0",
39
39
  "bind-event-listener": "^3.0.0"
40
40
  },
41
41
  "peerDependencies": {
42
- "@atlaskit/editor-common": "^107.6.0",
42
+ "@atlaskit/editor-common": "^107.7.0",
43
43
  "react": "^18.2.0"
44
44
  },
45
45
  "devDependencies": {