@atlaskit/app-provider 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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/app-provider
2
2
 
3
+ ## 1.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#87244](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/87244) [`7d9d0320d3da`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/7d9d0320d3da) - Add option to disable theming features with `UNSAFE_isThemingDisabled`
8
+
9
+ ## 1.0.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [#83116](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83116) [`8d4e99057fe0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8d4e99057fe0) - Upgrade Typescript from `4.9.5` to `5.4.2`
14
+
3
15
  ## 1.0.0
4
16
 
5
17
  ### Major Changes
@@ -10,8 +10,8 @@ exports.default = void 0;
10
10
  var _react = _interopRequireWildcard(require("react"));
11
11
  var _routerLinkProvider = _interopRequireDefault(require("./router-link-provider"));
12
12
  var _themeProvider = _interopRequireDefault(require("./theme-provider"));
13
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
14
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
13
+ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
14
+ 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; }
15
15
  var InsideAppProviderContext = /*#__PURE__*/(0, _react.createContext)(false);
16
16
  /**
17
17
  * __App provider__
@@ -25,18 +25,20 @@ function AppProvider(_ref) {
25
25
  _ref$defaultColorMode = _ref.defaultColorMode,
26
26
  defaultColorMode = _ref$defaultColorMode === void 0 ? 'light' : _ref$defaultColorMode,
27
27
  defaultTheme = _ref.defaultTheme,
28
- routerLinkComponent = _ref.routerLinkComponent;
28
+ routerLinkComponent = _ref.routerLinkComponent,
29
+ UNSAFE_isThemingDisabled = _ref.UNSAFE_isThemingDisabled;
29
30
  var isInsideAppProvider = (0, _react.useContext)(InsideAppProviderContext);
30
31
  if (isInsideAppProvider) {
31
32
  throw new Error('App provider should not be nested within another app provider.');
32
33
  }
34
+ var routerLinkProvider = /*#__PURE__*/_react.default.createElement(_routerLinkProvider.default, {
35
+ routerLinkComponent: routerLinkComponent
36
+ }, children);
33
37
  return /*#__PURE__*/_react.default.createElement(InsideAppProviderContext.Provider, {
34
38
  value: true
35
- }, /*#__PURE__*/_react.default.createElement(_themeProvider.default, {
39
+ }, UNSAFE_isThemingDisabled ? routerLinkProvider : /*#__PURE__*/_react.default.createElement(_themeProvider.default, {
36
40
  defaultColorMode: defaultColorMode,
37
41
  defaultTheme: defaultTheme
38
- }, /*#__PURE__*/_react.default.createElement(_routerLinkProvider.default, {
39
- routerLinkComponent: routerLinkComponent
40
- }, children)));
42
+ }, routerLinkProvider));
41
43
  }
42
44
  var _default = exports.default = AppProvider;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  });
7
7
  exports.default = exports.RouterLinkProviderContext = void 0;
8
8
  var _react = _interopRequireWildcard(require("react"));
9
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
10
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
9
+ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
10
+ 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; }
11
11
  var RouterLinkProviderContext = exports.RouterLinkProviderContext = /*#__PURE__*/(0, _react.createContext)({});
12
12
  /**
13
13
  * __RouterLinkProvider__
@@ -16,8 +16,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
16
16
  var _react = _interopRequireWildcard(require("react"));
17
17
  var _bindEventListener = require("bind-event-listener");
18
18
  var _tokens = require("@atlaskit/tokens");
19
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
20
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
19
+ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
20
+ 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; }
21
21
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
22
22
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
23
23
  var defaultThemeSettings = {
@@ -13,19 +13,21 @@ export function AppProvider({
13
13
  children,
14
14
  defaultColorMode = 'light',
15
15
  defaultTheme,
16
- routerLinkComponent
16
+ routerLinkComponent,
17
+ UNSAFE_isThemingDisabled
17
18
  }) {
18
19
  const isInsideAppProvider = useContext(InsideAppProviderContext);
19
20
  if (isInsideAppProvider) {
20
21
  throw new Error('App provider should not be nested within another app provider.');
21
22
  }
23
+ const routerLinkProvider = /*#__PURE__*/React.createElement(RouterLinkProvider, {
24
+ routerLinkComponent: routerLinkComponent
25
+ }, children);
22
26
  return /*#__PURE__*/React.createElement(InsideAppProviderContext.Provider, {
23
27
  value: true
24
- }, /*#__PURE__*/React.createElement(ThemeProvider, {
28
+ }, UNSAFE_isThemingDisabled ? routerLinkProvider : /*#__PURE__*/React.createElement(ThemeProvider, {
25
29
  defaultColorMode: defaultColorMode,
26
30
  defaultTheme: defaultTheme
27
- }, /*#__PURE__*/React.createElement(RouterLinkProvider, {
28
- routerLinkComponent: routerLinkComponent
29
- }, children)));
31
+ }, routerLinkProvider));
30
32
  }
31
33
  export default AppProvider;
@@ -14,18 +14,20 @@ export function AppProvider(_ref) {
14
14
  _ref$defaultColorMode = _ref.defaultColorMode,
15
15
  defaultColorMode = _ref$defaultColorMode === void 0 ? 'light' : _ref$defaultColorMode,
16
16
  defaultTheme = _ref.defaultTheme,
17
- routerLinkComponent = _ref.routerLinkComponent;
17
+ routerLinkComponent = _ref.routerLinkComponent,
18
+ UNSAFE_isThemingDisabled = _ref.UNSAFE_isThemingDisabled;
18
19
  var isInsideAppProvider = useContext(InsideAppProviderContext);
19
20
  if (isInsideAppProvider) {
20
21
  throw new Error('App provider should not be nested within another app provider.');
21
22
  }
23
+ var routerLinkProvider = /*#__PURE__*/React.createElement(RouterLinkProvider, {
24
+ routerLinkComponent: routerLinkComponent
25
+ }, children);
22
26
  return /*#__PURE__*/React.createElement(InsideAppProviderContext.Provider, {
23
27
  value: true
24
- }, /*#__PURE__*/React.createElement(ThemeProvider, {
28
+ }, UNSAFE_isThemingDisabled ? routerLinkProvider : /*#__PURE__*/React.createElement(ThemeProvider, {
25
29
  defaultColorMode: defaultColorMode,
26
30
  defaultTheme: defaultTheme
27
- }, /*#__PURE__*/React.createElement(RouterLinkProvider, {
28
- routerLinkComponent: routerLinkComponent
29
- }, children)));
31
+ }, routerLinkProvider));
30
32
  }
31
33
  export default AppProvider;
@@ -14,6 +14,15 @@ interface AppProviderProps {
14
14
  * A configured router link component.
15
15
  */
16
16
  routerLinkComponent?: RouterLinkComponent<any>;
17
+ /**
18
+ * Disables theming functionality.
19
+ * This is intended for use in apps with existing
20
+ * theming configuration that want to incrementally
21
+ * adopt AppProvider.
22
+ *
23
+ * @warning Use with caution. This prop will be removed in a future release.
24
+ */
25
+ UNSAFE_isThemingDisabled?: boolean;
17
26
  /**
18
27
  * App content.
19
28
  */
@@ -26,5 +35,5 @@ interface AppProviderProps {
26
35
  *
27
36
  * Place it at the root of your application.
28
37
  */
29
- export declare function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, }: AppProviderProps): JSX.Element;
38
+ export declare function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, UNSAFE_isThemingDisabled, }: AppProviderProps): JSX.Element;
30
39
  export default AppProvider;
@@ -2,8 +2,11 @@ import React from 'react';
2
2
  export type RouterLinkComponent<RouterLinkConfig extends Record<string, any> = never> = React.ForwardRefExoticComponent<RouterLinkComponentProps<RouterLinkConfig> & React.RefAttributes<HTMLAnchorElement>>;
3
3
  export type RouterLinkComponentProps<RouterLinkConfig extends Record<string, any> = never> = {
4
4
  /**
5
- * A string which can be mapped to the underlying router link,
6
- * or optionally a custom object defined in the generic type for advanced use.
5
+ * Standard links can be provided as a string, which should be mapped to the
6
+ * underlying router link component.
7
+ *
8
+ * Alternatively, you can provide an object for advanced link configurations
9
+ * by supplying the expected object type to the generic.
7
10
  *
8
11
  * @example
9
12
  * ```
@@ -14,6 +14,15 @@ interface AppProviderProps {
14
14
  * A configured router link component.
15
15
  */
16
16
  routerLinkComponent?: RouterLinkComponent<any>;
17
+ /**
18
+ * Disables theming functionality.
19
+ * This is intended for use in apps with existing
20
+ * theming configuration that want to incrementally
21
+ * adopt AppProvider.
22
+ *
23
+ * @warning Use with caution. This prop will be removed in a future release.
24
+ */
25
+ UNSAFE_isThemingDisabled?: boolean;
17
26
  /**
18
27
  * App content.
19
28
  */
@@ -26,5 +35,5 @@ interface AppProviderProps {
26
35
  *
27
36
  * Place it at the root of your application.
28
37
  */
29
- export declare function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, }: AppProviderProps): JSX.Element;
38
+ export declare function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, UNSAFE_isThemingDisabled, }: AppProviderProps): JSX.Element;
30
39
  export default AppProvider;
@@ -2,8 +2,11 @@ import React from 'react';
2
2
  export type RouterLinkComponent<RouterLinkConfig extends Record<string, any> = never> = React.ForwardRefExoticComponent<RouterLinkComponentProps<RouterLinkConfig> & React.RefAttributes<HTMLAnchorElement>>;
3
3
  export type RouterLinkComponentProps<RouterLinkConfig extends Record<string, any> = never> = {
4
4
  /**
5
- * A string which can be mapped to the underlying router link,
6
- * or optionally a custom object defined in the generic type for advanced use.
5
+ * Standard links can be provided as a string, which should be mapped to the
6
+ * underlying router link component.
7
+ *
8
+ * Alternatively, you can provide an object for advanced link configurations
9
+ * by supplying the expected object type to the generic.
7
10
  *
8
11
  * @example
9
12
  * ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/app-provider",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "A top level provider for the Design System.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -38,7 +38,7 @@
38
38
  ".": "./src/index.tsx"
39
39
  },
40
40
  "dependencies": {
41
- "@atlaskit/tokens": "^1.35.0",
41
+ "@atlaskit/tokens": "^1.42.0",
42
42
  "@babel/runtime": "^7.0.0",
43
43
  "bind-event-listener": "^2.1.1"
44
44
  },
@@ -47,6 +47,7 @@
47
47
  },
48
48
  "devDependencies": {
49
49
  "@af/visual-regression": "*",
50
+ "@atlaskit/ds-lib": "^2.2.0",
50
51
  "@atlaskit/ssr": "*",
51
52
  "@atlaskit/visual-regression": "*",
52
53
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
@@ -56,7 +57,7 @@
56
57
  "react-dom": "^16.8.0",
57
58
  "react-resource-router": "^0.20.0",
58
59
  "react-router-dom": "^4.2.2",
59
- "typescript": "~4.9.5",
60
+ "typescript": "~5.4.2",
60
61
  "wait-for-expect": "^1.2.0"
61
62
  },
62
63
  "techstack": {
@@ -80,11 +81,9 @@
80
81
  "ui-components": [
81
82
  "lite-mode"
82
83
  ],
83
- "deprecation": [
84
- "no-deprecated-imports"
85
- ],
84
+ "deprecation": "no-deprecated-imports",
86
85
  "styling": [
87
- "static",
86
+ "emotion",
88
87
  "emotion"
89
88
  ],
90
89
  "imports": [
@@ -94,4 +93,4 @@
94
93
  },
95
94
  "homepage": "https://atlassian.design/components",
96
95
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
97
- }
96
+ }