@atlaskit/media-common 11.1.0 → 11.2.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 (39) hide show
  1. package/CHANGELOG.md +326 -141
  2. package/analytics/package.json +1 -1
  3. package/dist/cjs/mediaFeatureFlags/mediaFeatureFlags.js +2 -1
  4. package/dist/cjs/mediaFeatureFlags/productKeys.js +4 -2
  5. package/dist/es2019/mediaFeatureFlags/mediaFeatureFlags.js +2 -1
  6. package/dist/es2019/mediaFeatureFlags/productKeys.js +4 -2
  7. package/dist/esm/mediaFeatureFlags/mediaFeatureFlags.js +2 -1
  8. package/dist/esm/mediaFeatureFlags/productKeys.js +4 -2
  9. package/dist/types/mediaFeatureFlags/mediaFeatureFlags.d.ts +1 -1
  10. package/dist/types/mediaFeatureFlags/productKeys.d.ts +1 -1
  11. package/dist/types/mediaFeatureFlags/types.d.ts +1 -0
  12. package/dist/types-ts4.5/mediaFeatureFlags/mediaFeatureFlags.d.ts +1 -1
  13. package/dist/types-ts4.5/mediaFeatureFlags/productKeys.d.ts +1 -1
  14. package/dist/types-ts4.5/mediaFeatureFlags/types.d.ts +1 -0
  15. package/downloadUrl/package.json +1 -1
  16. package/mediaFeatureFlags/package.json +1 -1
  17. package/mediaTypeUtils/package.json +1 -1
  18. package/package.json +5 -5
  19. package/test-helpers/package.json +1 -1
  20. package/dist/cjs/docs/index.js +0 -26
  21. package/dist/cjs/docs/media-use-only.js +0 -33
  22. package/dist/cjs/docs/rxjs-notice.js +0 -17
  23. package/dist/cjs/docs/singleton-notice.js +0 -19
  24. package/dist/es2019/docs/index.js +0 -3
  25. package/dist/es2019/docs/media-use-only.js +0 -25
  26. package/dist/es2019/docs/rxjs-notice.js +0 -10
  27. package/dist/es2019/docs/singleton-notice.js +0 -12
  28. package/dist/esm/docs/index.js +0 -3
  29. package/dist/esm/docs/media-use-only.js +0 -26
  30. package/dist/esm/docs/rxjs-notice.js +0 -10
  31. package/dist/esm/docs/singleton-notice.js +0 -12
  32. package/dist/types/docs/index.d.ts +0 -3
  33. package/dist/types/docs/media-use-only.d.ts +0 -5
  34. package/dist/types/docs/rxjs-notice.d.ts +0 -2
  35. package/dist/types/docs/singleton-notice.d.ts +0 -2
  36. package/dist/types-ts4.5/docs/index.d.ts +0 -3
  37. package/dist/types-ts4.5/docs/media-use-only.d.ts +0 -5
  38. package/dist/types-ts4.5/docs/rxjs-notice.d.ts +0 -2
  39. package/dist/types-ts4.5/docs/singleton-notice.d.ts +0 -2
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/analytics/index.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/analytics/index.d.ts"
12
12
  ]
@@ -56,7 +56,8 @@ var defaultMediaFeatureFlags = exports.defaultMediaFeatureFlags = {
56
56
  mediaInline: false,
57
57
  // We can't yet switch this feature on
58
58
  // TODO https://product-fabric.atlassian.net/browse/MEX-104
59
- folderUploads: false
59
+ folderUploads: false,
60
+ commentsOnMedia: false
60
61
  };
61
62
 
62
63
  /**
@@ -10,12 +10,14 @@ var productKeys = {
10
10
  * Note: Confluence Flags must be prefixed with "confluence.frontend" in order to integrate properly with the product
11
11
  */
12
12
  mediaInline: 'confluence.frontend.fabric.editor.media.inline',
13
- folderUploads: 'confluence.frontend.media.picker.folder.uploads'
13
+ folderUploads: 'confluence.frontend.media.picker.folder.uploads',
14
+ commentsOnMedia: 'confluence.frontend.renderer.comments-on-media'
14
15
  },
15
16
  jira: {
16
17
  // Manged by Linking Platform. No Rollout plan found for Jira
17
18
  mediaInline: '',
18
- folderUploads: 'issue.details.media-picker-folder-upload'
19
+ folderUploads: 'issue.details.media-picker-folder-upload',
20
+ commentsOnMedia: ''
19
21
  }
20
22
  };
21
23
  var getProductKeys = exports.getProductKeys = function getProductKeys() {
@@ -35,7 +35,8 @@ export const defaultMediaFeatureFlags = {
35
35
  mediaInline: false,
36
36
  // We can't yet switch this feature on
37
37
  // TODO https://product-fabric.atlassian.net/browse/MEX-104
38
- folderUploads: false
38
+ folderUploads: false,
39
+ commentsOnMedia: false
39
40
  };
40
41
 
41
42
  /**
@@ -4,12 +4,14 @@ const productKeys = {
4
4
  * Note: Confluence Flags must be prefixed with "confluence.frontend" in order to integrate properly with the product
5
5
  */
6
6
  mediaInline: 'confluence.frontend.fabric.editor.media.inline',
7
- folderUploads: 'confluence.frontend.media.picker.folder.uploads'
7
+ folderUploads: 'confluence.frontend.media.picker.folder.uploads',
8
+ commentsOnMedia: 'confluence.frontend.renderer.comments-on-media'
8
9
  },
9
10
  jira: {
10
11
  // Manged by Linking Platform. No Rollout plan found for Jira
11
12
  mediaInline: '',
12
- folderUploads: 'issue.details.media-picker-folder-upload'
13
+ folderUploads: 'issue.details.media-picker-folder-upload',
14
+ commentsOnMedia: ''
13
15
  }
14
16
  };
15
17
  export const getProductKeys = () => productKeys;
@@ -48,7 +48,8 @@ export var defaultMediaFeatureFlags = {
48
48
  mediaInline: false,
49
49
  // We can't yet switch this feature on
50
50
  // TODO https://product-fabric.atlassian.net/browse/MEX-104
51
- folderUploads: false
51
+ folderUploads: false,
52
+ commentsOnMedia: false
52
53
  };
53
54
 
54
55
  /**
@@ -4,12 +4,14 @@ var productKeys = {
4
4
  * Note: Confluence Flags must be prefixed with "confluence.frontend" in order to integrate properly with the product
5
5
  */
6
6
  mediaInline: 'confluence.frontend.fabric.editor.media.inline',
7
- folderUploads: 'confluence.frontend.media.picker.folder.uploads'
7
+ folderUploads: 'confluence.frontend.media.picker.folder.uploads',
8
+ commentsOnMedia: 'confluence.frontend.renderer.comments-on-media'
8
9
  },
9
10
  jira: {
10
11
  // Manged by Linking Platform. No Rollout plan found for Jira
11
12
  mediaInline: '',
12
- folderUploads: 'issue.details.media-picker-folder-upload'
13
+ folderUploads: 'issue.details.media-picker-folder-upload',
14
+ commentsOnMedia: ''
13
15
  }
14
16
  };
15
17
  export var getProductKeys = function getProductKeys() {
@@ -1,4 +1,4 @@
1
- import { RequiredMediaFeatureFlags, MediaFeatureFlags } from './types';
1
+ import { type RequiredMediaFeatureFlags, type MediaFeatureFlags } from './types';
2
2
  export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;
3
3
  /**
4
4
  * Takes a record of {Media Feature Flag Names → boolean}.
@@ -1,2 +1,2 @@
1
- import { ProductKeys } from './types';
1
+ import { type ProductKeys } from './types';
2
2
  export declare const getProductKeys: () => ProductKeys;
@@ -1,6 +1,7 @@
1
1
  export interface MediaFeatureFlags {
2
2
  mediaInline?: boolean;
3
3
  folderUploads?: boolean;
4
+ commentsOnMedia?: boolean;
4
5
  }
5
6
  export interface WithMediaFeatureFlags {
6
7
  featureFlags?: MediaFeatureFlags;
@@ -1,4 +1,4 @@
1
- import { RequiredMediaFeatureFlags, MediaFeatureFlags } from './types';
1
+ import { type RequiredMediaFeatureFlags, type MediaFeatureFlags } from './types';
2
2
  export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;
3
3
  /**
4
4
  * Takes a record of {Media Feature Flag Names → boolean}.
@@ -1,2 +1,2 @@
1
- import { ProductKeys } from './types';
1
+ import { type ProductKeys } from './types';
2
2
  export declare const getProductKeys: () => ProductKeys;
@@ -1,6 +1,7 @@
1
1
  export interface MediaFeatureFlags {
2
2
  mediaInline?: boolean;
3
3
  folderUploads?: boolean;
4
+ commentsOnMedia?: boolean;
4
5
  }
5
6
  export interface WithMediaFeatureFlags {
6
7
  featureFlags?: MediaFeatureFlags;
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/downloadUrl.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/downloadUrl.d.ts"
12
12
  ]
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/mediaFeatureFlags/index.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/mediaFeatureFlags/index.d.ts"
12
12
  ]
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/mediaTypeUtils/index.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/mediaTypeUtils/index.d.ts"
12
12
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/media-common",
3
- "version": "11.1.0",
3
+ "version": "11.2.0",
4
4
  "description": "Includes common utilities used by other media packages",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -43,8 +43,8 @@
43
43
  "dependencies": {
44
44
  "@atlaskit/analytics-gas-types": "^5.1.0",
45
45
  "@atlaskit/analytics-namespaced-context": "^6.9.0",
46
- "@atlaskit/analytics-next": "^9.2.0",
47
- "@atlaskit/section-message": "^6.4.0",
46
+ "@atlaskit/analytics-next": "^9.3.0",
47
+ "@atlaskit/section-message": "^6.5.0",
48
48
  "@babel/runtime": "^7.0.0",
49
49
  "immer": "^9.0.12",
50
50
  "uuid-validate": "^0.0.3"
@@ -64,7 +64,7 @@
64
64
  "enzyme": "^3.10.0",
65
65
  "react": "^16.8.0",
66
66
  "react-dom": "^16.8.0",
67
- "typescript": "~4.9.5"
67
+ "typescript": "~5.4.2"
68
68
  },
69
69
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
70
- }
70
+ }
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/test-helpers/index.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/test-helpers/index.d.ts"
12
12
  ]
@@ -1,26 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- Object.defineProperty(exports, "createMediaUseOnlyNotice", {
7
- enumerable: true,
8
- get: function get() {
9
- return _mediaUseOnly.createMediaUseOnlyNotice;
10
- }
11
- });
12
- Object.defineProperty(exports, "createRxjsNotice", {
13
- enumerable: true,
14
- get: function get() {
15
- return _rxjsNotice.createRxjsNotice;
16
- }
17
- });
18
- Object.defineProperty(exports, "createSingletonNotice", {
19
- enumerable: true,
20
- get: function get() {
21
- return _singletonNotice.createSingletonNotice;
22
- }
23
- });
24
- var _rxjsNotice = require("./rxjs-notice");
25
- var _mediaUseOnly = require("./media-use-only");
26
- var _singletonNotice = require("./singleton-notice");
@@ -1,33 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.createMediaUseOnlyNotice = createMediaUseOnlyNotice;
8
- var _react = _interopRequireDefault(require("react"));
9
- var _sectionMessage = _interopRequireDefault(require("@atlaskit/section-message"));
10
- function AlternativePackagesMessage(_ref) {
11
- var alternatePackages = _ref.alternatePackages;
12
- if (!alternatePackages) {
13
- return null;
14
- }
15
- if (alternatePackages.length === 1) {
16
- return /*#__PURE__*/_react.default.createElement("p", null, "Consider using", ' ', /*#__PURE__*/_react.default.createElement("a", {
17
- href: alternatePackages[0].link
18
- }, alternatePackages[0].name), ' ', "instead.");
19
- }
20
- return /*#__PURE__*/_react.default.createElement("p", null, "Consider using one of these packages instead:", /*#__PURE__*/_react.default.createElement("ul", null, alternatePackages.map(function (p) {
21
- return /*#__PURE__*/_react.default.createElement("li", null, /*#__PURE__*/_react.default.createElement("a", {
22
- href: p.link
23
- }, p.name));
24
- })));
25
- }
26
- function createMediaUseOnlyNotice(componentName, alternatePackages) {
27
- return /*#__PURE__*/_react.default.createElement(_sectionMessage.default, {
28
- title: "Internal Media Use Only",
29
- appearance: "error"
30
- }, /*#__PURE__*/_react.default.createElement("p", null, componentName, " is intended for internal use by the Media Platform and as a transitive dependency of a media package within your product."), /*#__PURE__*/_react.default.createElement("p", null, "Direct use of this component is not supported."), /*#__PURE__*/_react.default.createElement(AlternativePackagesMessage, {
31
- alternatePackages: alternatePackages
32
- }));
33
- }
@@ -1,17 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.createRxjsNotice = createRxjsNotice;
8
- var _react = _interopRequireDefault(require("react"));
9
- var _sectionMessage = _interopRequireDefault(require("@atlaskit/section-message"));
10
- function createRxjsNotice(componentName) {
11
- return /*#__PURE__*/_react.default.createElement(_sectionMessage.default, {
12
- title: "RxJS compatilbity",
13
- appearance: "warning"
14
- }, /*#__PURE__*/_react.default.createElement("p", null, componentName, " currently requires", ' ', /*#__PURE__*/_react.default.createElement("a", {
15
- href: "https://www.npmjs.com/package/rxjs/v/5.5.12"
16
- }, "rxjs@^5.5.0"), " as peer dependency."));
17
- }
@@ -1,19 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.createSingletonNotice = createSingletonNotice;
8
- var _react = _interopRequireDefault(require("react"));
9
- var _sectionMessage = _interopRequireDefault(require("@atlaskit/section-message"));
10
- function createSingletonNotice(componentName) {
11
- var title = "".concat(componentName, " is a singleton package");
12
- return /*#__PURE__*/_react.default.createElement(_sectionMessage.default, {
13
- title: title,
14
- appearance: "error"
15
- }, /*#__PURE__*/_react.default.createElement("p", null, "Having multiple versions of ", componentName, " installed can result in potential issues, such as media preview failures."), /*#__PURE__*/_react.default.createElement("p", null, "You must ensure that your application dependencies only resolve to a unique package version, if you are:", /*#__PURE__*/_react.default.createElement("ul", null, /*#__PURE__*/_react.default.createElement("li", null, /*#__PURE__*/_react.default.createElement("b", null, "A platform consumer"), " \u2014 i.e. you are using ", componentName, ' ', "directly in a npm package, for instance in a monorepository. Define", ' ', componentName, " in your package.json file as a", ' ', /*#__PURE__*/_react.default.createElement("code", null, "peerDependency"), " and ", /*#__PURE__*/_react.default.createElement("code", null, "devDependency"), " (for local testing)."), /*#__PURE__*/_react.default.createElement("li", null, /*#__PURE__*/_react.default.createElement("b", null, "A product consumer"), " \u2014 i.e. you are working directly into your application. Define ", componentName, " in your package.json file as a direct dependency."))), /*#__PURE__*/_react.default.createElement("p", null, "If you have any questions or need assistance in consuming this package correctly, please reach out to the", ' ', /*#__PURE__*/_react.default.createElement("a", {
16
- href: "https://atlassian.slack.com/archives/C020CGJDJ3A",
17
- target: "_blank"
18
- }, "#help-media-platform"), ' ', "channel."));
19
- }
@@ -1,3 +0,0 @@
1
- export { createRxjsNotice } from './rxjs-notice';
2
- export { createMediaUseOnlyNotice } from './media-use-only';
3
- export { createSingletonNotice } from './singleton-notice';
@@ -1,25 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- function AlternativePackagesMessage({
4
- alternatePackages
5
- }) {
6
- if (!alternatePackages) {
7
- return null;
8
- }
9
- if (alternatePackages.length === 1) {
10
- return /*#__PURE__*/React.createElement("p", null, "Consider using", ' ', /*#__PURE__*/React.createElement("a", {
11
- href: alternatePackages[0].link
12
- }, alternatePackages[0].name), ' ', "instead.");
13
- }
14
- return /*#__PURE__*/React.createElement("p", null, "Consider using one of these packages instead:", /*#__PURE__*/React.createElement("ul", null, alternatePackages.map(p => /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("a", {
15
- href: p.link
16
- }, p.name)))));
17
- }
18
- export function createMediaUseOnlyNotice(componentName, alternatePackages) {
19
- return /*#__PURE__*/React.createElement(SectionMessage, {
20
- title: "Internal Media Use Only",
21
- appearance: "error"
22
- }, /*#__PURE__*/React.createElement("p", null, componentName, " is intended for internal use by the Media Platform and as a transitive dependency of a media package within your product."), /*#__PURE__*/React.createElement("p", null, "Direct use of this component is not supported."), /*#__PURE__*/React.createElement(AlternativePackagesMessage, {
23
- alternatePackages: alternatePackages
24
- }));
25
- }
@@ -1,10 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- export function createRxjsNotice(componentName) {
4
- return /*#__PURE__*/React.createElement(SectionMessage, {
5
- title: "RxJS compatilbity",
6
- appearance: "warning"
7
- }, /*#__PURE__*/React.createElement("p", null, componentName, " currently requires", ' ', /*#__PURE__*/React.createElement("a", {
8
- href: "https://www.npmjs.com/package/rxjs/v/5.5.12"
9
- }, "rxjs@^5.5.0"), " as peer dependency."));
10
- }
@@ -1,12 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- export function createSingletonNotice(componentName) {
4
- const title = `${componentName} is a singleton package`;
5
- return /*#__PURE__*/React.createElement(SectionMessage, {
6
- title: title,
7
- appearance: "error"
8
- }, /*#__PURE__*/React.createElement("p", null, "Having multiple versions of ", componentName, " installed can result in potential issues, such as media preview failures."), /*#__PURE__*/React.createElement("p", null, "You must ensure that your application dependencies only resolve to a unique package version, if you are:", /*#__PURE__*/React.createElement("ul", null, /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("b", null, "A platform consumer"), " \u2014 i.e. you are using ", componentName, ' ', "directly in a npm package, for instance in a monorepository. Define", ' ', componentName, " in your package.json file as a", ' ', /*#__PURE__*/React.createElement("code", null, "peerDependency"), " and ", /*#__PURE__*/React.createElement("code", null, "devDependency"), " (for local testing)."), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("b", null, "A product consumer"), " \u2014 i.e. you are working directly into your application. Define ", componentName, " in your package.json file as a direct dependency."))), /*#__PURE__*/React.createElement("p", null, "If you have any questions or need assistance in consuming this package correctly, please reach out to the", ' ', /*#__PURE__*/React.createElement("a", {
9
- href: "https://atlassian.slack.com/archives/C020CGJDJ3A",
10
- target: "_blank"
11
- }, "#help-media-platform"), ' ', "channel."));
12
- }
@@ -1,3 +0,0 @@
1
- export { createRxjsNotice } from './rxjs-notice';
2
- export { createMediaUseOnlyNotice } from './media-use-only';
3
- export { createSingletonNotice } from './singleton-notice';
@@ -1,26 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- function AlternativePackagesMessage(_ref) {
4
- var alternatePackages = _ref.alternatePackages;
5
- if (!alternatePackages) {
6
- return null;
7
- }
8
- if (alternatePackages.length === 1) {
9
- return /*#__PURE__*/React.createElement("p", null, "Consider using", ' ', /*#__PURE__*/React.createElement("a", {
10
- href: alternatePackages[0].link
11
- }, alternatePackages[0].name), ' ', "instead.");
12
- }
13
- return /*#__PURE__*/React.createElement("p", null, "Consider using one of these packages instead:", /*#__PURE__*/React.createElement("ul", null, alternatePackages.map(function (p) {
14
- return /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("a", {
15
- href: p.link
16
- }, p.name));
17
- })));
18
- }
19
- export function createMediaUseOnlyNotice(componentName, alternatePackages) {
20
- return /*#__PURE__*/React.createElement(SectionMessage, {
21
- title: "Internal Media Use Only",
22
- appearance: "error"
23
- }, /*#__PURE__*/React.createElement("p", null, componentName, " is intended for internal use by the Media Platform and as a transitive dependency of a media package within your product."), /*#__PURE__*/React.createElement("p", null, "Direct use of this component is not supported."), /*#__PURE__*/React.createElement(AlternativePackagesMessage, {
24
- alternatePackages: alternatePackages
25
- }));
26
- }
@@ -1,10 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- export function createRxjsNotice(componentName) {
4
- return /*#__PURE__*/React.createElement(SectionMessage, {
5
- title: "RxJS compatilbity",
6
- appearance: "warning"
7
- }, /*#__PURE__*/React.createElement("p", null, componentName, " currently requires", ' ', /*#__PURE__*/React.createElement("a", {
8
- href: "https://www.npmjs.com/package/rxjs/v/5.5.12"
9
- }, "rxjs@^5.5.0"), " as peer dependency."));
10
- }
@@ -1,12 +0,0 @@
1
- import React from 'react';
2
- import SectionMessage from '@atlaskit/section-message';
3
- export function createSingletonNotice(componentName) {
4
- var title = "".concat(componentName, " is a singleton package");
5
- return /*#__PURE__*/React.createElement(SectionMessage, {
6
- title: title,
7
- appearance: "error"
8
- }, /*#__PURE__*/React.createElement("p", null, "Having multiple versions of ", componentName, " installed can result in potential issues, such as media preview failures."), /*#__PURE__*/React.createElement("p", null, "You must ensure that your application dependencies only resolve to a unique package version, if you are:", /*#__PURE__*/React.createElement("ul", null, /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("b", null, "A platform consumer"), " \u2014 i.e. you are using ", componentName, ' ', "directly in a npm package, for instance in a monorepository. Define", ' ', componentName, " in your package.json file as a", ' ', /*#__PURE__*/React.createElement("code", null, "peerDependency"), " and ", /*#__PURE__*/React.createElement("code", null, "devDependency"), " (for local testing)."), /*#__PURE__*/React.createElement("li", null, /*#__PURE__*/React.createElement("b", null, "A product consumer"), " \u2014 i.e. you are working directly into your application. Define ", componentName, " in your package.json file as a direct dependency."))), /*#__PURE__*/React.createElement("p", null, "If you have any questions or need assistance in consuming this package correctly, please reach out to the", ' ', /*#__PURE__*/React.createElement("a", {
9
- href: "https://atlassian.slack.com/archives/C020CGJDJ3A",
10
- target: "_blank"
11
- }, "#help-media-platform"), ' ', "channel."));
12
- }
@@ -1,3 +0,0 @@
1
- export { createRxjsNotice } from './rxjs-notice';
2
- export { createMediaUseOnlyNotice } from './media-use-only';
3
- export { createSingletonNotice } from './singleton-notice';
@@ -1,5 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createMediaUseOnlyNotice(componentName: string, alternatePackages?: {
3
- name: string;
4
- link: string;
5
- }[]): JSX.Element;
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createRxjsNotice(componentName: string): JSX.Element;
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createSingletonNotice(componentName: string): JSX.Element;
@@ -1,3 +0,0 @@
1
- export { createRxjsNotice } from './rxjs-notice';
2
- export { createMediaUseOnlyNotice } from './media-use-only';
3
- export { createSingletonNotice } from './singleton-notice';
@@ -1,5 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createMediaUseOnlyNotice(componentName: string, alternatePackages?: {
3
- name: string;
4
- link: string;
5
- }[]): JSX.Element;
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createRxjsNotice(componentName: string): JSX.Element;
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function createSingletonNotice(componentName: string): JSX.Element;