@atlaskit/app-provider 0.4.0 → 1.0.1

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.0.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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`
8
+
9
+ ## 1.0.0
10
+
11
+ ### Major Changes
12
+
13
+ - [#69683](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69683) [`203c0f3c8b03`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/203c0f3c8b03) - Stable v1 release of app provider
14
+
3
15
  ## 0.4.0
4
16
 
5
17
  ### Minor Changes
@@ -32,7 +32,7 @@ The `useTheme` hook can be used to get the active themes. The `useSetTheme` hook
32
32
 
33
33
  The `routerLinkComponent` prop provides support for configuring router links within Design System components.
34
34
 
35
- Support for this is limited as Design System components are being updated, starting with `@atlaskit/button`.
35
+ Support for this is limited as Design System components are being updated, starting with [Button](/components/button/button-new/examples).
36
36
 
37
37
  This example shows how links can be configured to utilize the router link component supplied by [React Resource Router](https://github.com/atlassian-labs/react-resource-router), however any routing library can be used.
38
38
 
@@ -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__
@@ -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 = {
@@ -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
  * ```
@@ -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": "0.4.0",
3
+ "version": "1.0.1",
4
4
  "description": "A top level provider for the Design System.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -15,7 +15,7 @@
15
15
  "name": "App provider",
16
16
  "category": "Components",
17
17
  "status": {
18
- "type": "alpha"
18
+ "type": "beta"
19
19
  }
20
20
  }
21
21
  },
@@ -38,7 +38,7 @@
38
38
  ".": "./src/index.tsx"
39
39
  },
40
40
  "dependencies": {
41
- "@atlaskit/tokens": "^1.28.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,9 +47,9 @@
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
- "@atlaskit/webdriver-runner": "*",
53
53
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
54
54
  "@testing-library/react": "^12.1.5",
55
55
  "@testing-library/react-hooks": "^8.0.1",
@@ -57,7 +57,7 @@
57
57
  "react-dom": "^16.8.0",
58
58
  "react-resource-router": "^0.20.0",
59
59
  "react-router-dom": "^4.2.2",
60
- "typescript": "~4.9.5",
60
+ "typescript": "~5.4.2",
61
61
  "wait-for-expect": "^1.2.0"
62
62
  },
63
63
  "techstack": {
@@ -81,11 +81,9 @@
81
81
  "ui-components": [
82
82
  "lite-mode"
83
83
  ],
84
- "deprecation": [
85
- "no-deprecated-imports"
86
- ],
84
+ "deprecation": "no-deprecated-imports",
87
85
  "styling": [
88
- "static",
86
+ "emotion",
89
87
  "emotion"
90
88
  ],
91
89
  "imports": [
@@ -95,4 +93,4 @@
95
93
  },
96
94
  "homepage": "https://atlassian.design/components",
97
95
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
98
- }
96
+ }
@@ -1,57 +0,0 @@
1
- ## API Report File for "@atlaskit/app-provider"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { default as React_2 } from 'react';
8
- import { ThemeState } from '@atlaskit/tokens';
9
-
10
- // @public
11
- function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, }: AppProviderProps): JSX.Element;
12
- export default AppProvider;
13
-
14
- // @public (undocumented)
15
- interface AppProviderProps {
16
- children: React_2.ReactNode;
17
- defaultColorMode?: ColorMode;
18
- defaultTheme?: Partial<Theme>;
19
- routerLinkComponent?: RouterLinkComponent<any>;
20
- }
21
-
22
- // @public (undocumented)
23
- type ColorMode = 'auto' | 'dark' | 'light';
24
-
25
- // @public (undocumented)
26
- type ReconciledColorMode = Exclude<ColorMode, 'auto'>;
27
-
28
- // @public (undocumented)
29
- type RouterLinkComponent<RouterLinkConfig extends Record<string, any> = never> = React_2.ForwardRefExoticComponent<RouterLinkComponentProps<RouterLinkConfig> & React_2.RefAttributes<HTMLAnchorElement>>;
30
-
31
- // @public (undocumented)
32
- export type RouterLinkComponentProps<RouterLinkConfig extends Record<string, any> = never> = {
33
- href: RouterLinkConfig | string;
34
- children: React_2.ReactNode;
35
- };
36
-
37
- // @public (undocumented)
38
- type Theme = Omit<ThemeState, 'colorMode' | 'contrastMode'>;
39
-
40
- // @public
41
- export function useColorMode(): ReconciledColorMode;
42
-
43
- // @public
44
- export const useRouterLink: <RouterLinkConfig extends Record<string, any> = never>() => RouterLinkComponent<RouterLinkConfig> | undefined;
45
-
46
- // @public
47
- export function useSetColorMode(): (value: ColorMode) => void;
48
-
49
- // @public
50
- export function useSetTheme(): (value: Partial<Theme>) => void;
51
-
52
- // @public
53
- export function useTheme(): Theme;
54
-
55
- // (No @packageDocumentation comment for this package)
56
-
57
- ```