@atlaskit/media-client 23.1.2 → 23.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 (65) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/client/file-fetcher/index.js +2 -2
  3. package/dist/cjs/client/media-store/index.js +2 -2
  4. package/dist/cjs/models/file-state.js +2 -2
  5. package/dist/cjs/test-helpers/_numbers.js +9 -0
  6. package/dist/cjs/test-helpers/authProvider.js +71 -0
  7. package/dist/cjs/test-helpers/collectionNames.js +16 -0
  8. package/dist/cjs/test-helpers/exampleMediaItems.js +317 -0
  9. package/dist/cjs/test-helpers/fakeMediaClient.js +77 -0
  10. package/dist/cjs/test-helpers/index.js +374 -0
  11. package/dist/cjs/test-helpers/mediaClientProvider.js +60 -0
  12. package/dist/cjs/test-helpers/mediaPickerAuthProvider.js +95 -0
  13. package/dist/cjs/utils/createFileDataLoader.js +2 -2
  14. package/dist/cjs/utils/mobileUpload/stateMachine/states/uploading.js +2 -2
  15. package/dist/cjs/utils/polling/index.js +2 -2
  16. package/dist/cjs/utils/request/helpers.js +2 -2
  17. package/dist/cjs/utils/url.js +2 -2
  18. package/dist/es2019/test-helpers/_numbers.js +3 -0
  19. package/dist/es2019/test-helpers/authProvider.js +34 -0
  20. package/dist/es2019/test-helpers/collectionNames.js +5 -0
  21. package/dist/es2019/test-helpers/exampleMediaItems.js +268 -0
  22. package/dist/es2019/test-helpers/fakeMediaClient.js +63 -0
  23. package/dist/es2019/test-helpers/index.js +7 -0
  24. package/dist/es2019/test-helpers/mediaClientProvider.js +42 -0
  25. package/dist/es2019/test-helpers/mediaPickerAuthProvider.js +56 -0
  26. package/dist/esm/client/file-fetcher/index.js +2 -2
  27. package/dist/esm/client/media-store/index.js +2 -2
  28. package/dist/esm/models/file-state.js +2 -2
  29. package/dist/esm/test-helpers/_numbers.js +3 -0
  30. package/dist/esm/test-helpers/authProvider.js +63 -0
  31. package/dist/esm/test-helpers/collectionNames.js +5 -0
  32. package/dist/esm/test-helpers/exampleMediaItems.js +268 -0
  33. package/dist/esm/test-helpers/fakeMediaClient.js +69 -0
  34. package/dist/esm/test-helpers/index.js +7 -0
  35. package/dist/esm/test-helpers/mediaClientProvider.js +48 -0
  36. package/dist/esm/test-helpers/mediaPickerAuthProvider.js +85 -0
  37. package/dist/esm/utils/createFileDataLoader.js +2 -2
  38. package/dist/esm/utils/mobileUpload/stateMachine/states/uploading.js +2 -2
  39. package/dist/esm/utils/polling/index.js +2 -2
  40. package/dist/esm/utils/request/helpers.js +2 -2
  41. package/dist/esm/utils/url.js +2 -2
  42. package/dist/types/models/artifacts.d.ts +3 -0
  43. package/dist/types/test-helpers/_numbers.d.ts +1 -0
  44. package/dist/types/test-helpers/authProvider.d.ts +6 -0
  45. package/dist/types/test-helpers/collectionNames.d.ts +5 -0
  46. package/dist/types/test-helpers/exampleMediaItems.d.ts +53 -0
  47. package/dist/types/test-helpers/fakeMediaClient.d.ts +4 -0
  48. package/dist/types/test-helpers/index.d.ts +7 -0
  49. package/dist/types/test-helpers/mediaClientProvider.d.ts +23 -0
  50. package/dist/types/test-helpers/mediaPickerAuthProvider.d.ts +5 -0
  51. package/dist/types-ts4.5/models/artifacts.d.ts +3 -0
  52. package/dist/types-ts4.5/test-helpers/_numbers.d.ts +1 -0
  53. package/dist/types-ts4.5/test-helpers/authProvider.d.ts +6 -0
  54. package/dist/types-ts4.5/test-helpers/collectionNames.d.ts +5 -0
  55. package/dist/types-ts4.5/test-helpers/exampleMediaItems.d.ts +53 -0
  56. package/dist/types-ts4.5/test-helpers/fakeMediaClient.d.ts +4 -0
  57. package/dist/types-ts4.5/test-helpers/index.d.ts +7 -0
  58. package/dist/types-ts4.5/test-helpers/mediaClientProvider.d.ts +23 -0
  59. package/dist/types-ts4.5/test-helpers/mediaPickerAuthProvider.d.ts +5 -0
  60. package/package.json +11 -4
  61. package/report.api.md +7 -0
  62. package/tmp/api-report-tmp.d.ts +6 -0
  63. package/dist/cjs/version.json +0 -5
  64. package/dist/es2019/version.json +0 -5
  65. package/dist/esm/version.json +0 -5
@@ -0,0 +1,23 @@
1
+ import { MediaClient } from '../';
2
+ import { MediaClientConfig } from '@atlaskit/media-core';
3
+ import { MediaEnv } from './mediaPickerAuthProvider';
4
+ export declare const defaultBaseUrl = "https://media.dev.atl-paas.net";
5
+ export declare const defaultParams: {
6
+ clientId: string;
7
+ asapIssuer: string;
8
+ baseUrl: string;
9
+ };
10
+ interface AuthParameter {
11
+ authType: 'client' | 'asap';
12
+ }
13
+ /**
14
+ * Creates and returns `MediaClient` (from `media-client`) based on the data provided in parameter object.
15
+ *
16
+ * @param {AuthParameter} authParameter specifies serviceName and whatever auth should be done with clientId or asapIssuer
17
+ * @returns {Context}
18
+ */
19
+ export declare const createStorybookMediaClient: (authParameter?: AuthParameter) => MediaClient;
20
+ export declare const createStorybookMediaClientConfig: (authParameter?: AuthParameter) => MediaClientConfig;
21
+ export declare const createUploadMediaClient: () => MediaClient;
22
+ export declare const createUploadMediaClientConfig: (stargateBaseUrl?: string, env?: MediaEnv) => MediaClientConfig;
23
+ export {};
@@ -0,0 +1,5 @@
1
+ import { Auth, AuthContext } from '@atlaskit/media-core';
2
+ export declare const authProviderBaseURL = "https://media.dev.atl-paas.net";
3
+ export type MediaEnv = 'dev' | 'staging';
4
+ export declare const mediaPickerAuthProvider: (authEnvironment?: string, env?: MediaEnv) => (context?: AuthContext) => Promise<Auth>;
5
+ export declare const defaultMediaPickerAuthProvider: () => () => Promise<Auth>;
@@ -8,5 +8,8 @@ export interface MediaFileArtifacts {
8
8
  'video_640.mp4'?: MediaFileArtifact;
9
9
  'document.pdf'?: MediaFileArtifact;
10
10
  'audio.mp3'?: MediaFileArtifact;
11
+ 'thumb.jpg'?: MediaFileArtifact;
12
+ 'image.png'?: MediaFileArtifact;
13
+ 'image.jpg'?: MediaFileArtifact;
11
14
  }
12
15
  export declare const getArtifactUrl: (artifacts: MediaFileArtifacts, prop: keyof MediaFileArtifacts) => string | undefined;
@@ -0,0 +1 @@
1
+ export declare function numbers(count: number): Array<number>;
@@ -0,0 +1,6 @@
1
+ import { AuthProvider } from '@atlaskit/media-core';
2
+ export declare class StoryBookAuthProvider {
3
+ static create(isAsapEnvironment: boolean, access?: {
4
+ [resourceUrn: string]: string[];
5
+ }): AuthProvider;
6
+ }
@@ -0,0 +1,5 @@
1
+ export declare const defaultCollectionName = "MediaServicesSample";
2
+ export declare const onlyAnimatedGifsCollectionName = "only-animated-gifs";
3
+ export declare const fileCollectionName: string;
4
+ export declare const defaultMediaPickerCollectionName = "mediapicker-test";
5
+ export declare const collectionNames: string[];
@@ -0,0 +1,53 @@
1
+ import { FileIdentifier, FileDetails, ExternalImageIdentifier, MediaType } from '../';
2
+ export declare const genericFileId: FileIdentifier;
3
+ export declare const audioFileId: FileIdentifier;
4
+ export declare const audioNoCoverFileId: FileIdentifier;
5
+ export declare const videoFileId: FileIdentifier;
6
+ export declare const videoHorizontalFileId: FileIdentifier;
7
+ export declare const videoLargeFileId: FileIdentifier;
8
+ export declare const videoSquareFileId: FileIdentifier;
9
+ export declare const videoProcessingFailedId: FileIdentifier;
10
+ export declare const imageFileId: FileIdentifier;
11
+ export declare const emptyImageFileId: FileIdentifier;
12
+ export declare const smallImageFileId: FileIdentifier;
13
+ export declare const wideImageFileId: FileIdentifier;
14
+ export declare const largeImageFileId: FileIdentifier;
15
+ export declare const verticalImageFileId: FileIdentifier;
16
+ export declare const docFileId: FileIdentifier;
17
+ export declare const bigDocFileId: FileIdentifier;
18
+ export declare const largePdfFileId: FileIdentifier;
19
+ export declare const passwordProtectedPdfFileId: FileIdentifier;
20
+ export declare const codeFileId: FileIdentifier;
21
+ export declare const emailFileId: FileIdentifier;
22
+ export declare const emailUnsupportedFileId: FileIdentifier;
23
+ export declare const archiveFileId: FileIdentifier;
24
+ export declare const zipJiraArchiveFileId: FileIdentifier;
25
+ export declare const zipFileWithNestedFolderId: FileIdentifier;
26
+ export declare const zipFileId: FileIdentifier;
27
+ export declare const zipItemMultipleFoldersAtRootId: FileIdentifier;
28
+ export declare const zipItemLargeInnerFileId: FileIdentifier;
29
+ export declare const zipEncryptedFileId: FileIdentifier;
30
+ export declare const unknownFileId: FileIdentifier;
31
+ export declare const errorFileId: FileIdentifier;
32
+ export declare const gifFileId: FileIdentifier;
33
+ export declare const noMetadataFileId: FileIdentifier;
34
+ export declare const animatedFileId: FileIdentifier;
35
+ export declare const atlassianLogoUrl = "https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/apple-touch-icon-152x152.png";
36
+ export declare const externalImageIdentifier: ExternalImageIdentifier;
37
+ export declare const externalSmallImageIdentifier: ExternalImageIdentifier;
38
+ export declare const externaBrokenlIdentifier: ExternalImageIdentifier;
39
+ export declare const genericFileDetails: FileDetails;
40
+ export declare const imageFileDetails: FileDetails;
41
+ export declare const videoFileDetails: FileDetails;
42
+ export declare const audioFileDetails: FileDetails;
43
+ export declare const docFileDetails: FileDetails;
44
+ export declare const unknownFileDetails: FileDetails;
45
+ export declare const genericDataURI = "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAZABkAAD/4QCMRXhpZgAATU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABkAAAAAQAAAGQAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAAKgAwAEAAAAAQAAAAIAAAAA/+0AOFBob3Rvc2hvcCAzLjAAOEJJTQQEAAAAAAAAOEJJTQQlAAAAAAAQ1B2M2Y8AsgTpgAmY7PhCfv/AABEIAAIAAgMBEQACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQICAQECAQEBAgICAgICAgICAQICAgICAgICAgL/2wBDAQEBAQEBAQEBAQECAQEBAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgL/3QAEAAH/2gAMAwEAAhEDEQA/AP0U8M2NmPDfh8C0tgBomkgAW8OAPsFvwK/lh7s+5u+/4n//2Q==";
46
+ export declare const vrVideoDetails: {
47
+ id: string;
48
+ name: string;
49
+ dataUri: string;
50
+ previewDataUri: string;
51
+ mediaType: MediaType;
52
+ mimeType: string;
53
+ };
@@ -0,0 +1,4 @@
1
+ import { MediaClientConfig } from '@atlaskit/media-core';
2
+ import { MediaClient } from '../';
3
+ export declare const getDefaultMediaClientConfig: () => MediaClientConfig;
4
+ export declare const fakeMediaClient: (config?: MediaClientConfig) => MediaClient;
@@ -0,0 +1,7 @@
1
+ export { StoryBookAuthProvider } from './authProvider';
2
+ export { createStorybookMediaClient, createStorybookMediaClientConfig, createUploadMediaClient, createUploadMediaClientConfig, defaultBaseUrl, defaultParams, } from './mediaClientProvider';
3
+ export { collectionNames, defaultCollectionName, defaultMediaPickerCollectionName, fileCollectionName, onlyAnimatedGifsCollectionName, } from './collectionNames';
4
+ export { animatedFileId, archiveFileId, atlassianLogoUrl, audioFileDetails, audioFileId, audioNoCoverFileId, bigDocFileId, docFileDetails, docFileId, emptyImageFileId, errorFileId, externalImageIdentifier, externalSmallImageIdentifier, externaBrokenlIdentifier, genericDataURI, genericFileDetails, genericFileId, gifFileId, imageFileDetails, imageFileId, largeImageFileId, largePdfFileId, noMetadataFileId, passwordProtectedPdfFileId, smallImageFileId, unknownFileDetails, unknownFileId, verticalImageFileId, videoFileDetails, videoFileId, videoHorizontalFileId, videoLargeFileId, videoProcessingFailedId, videoSquareFileId, wideImageFileId, zipFileId, zipFileWithNestedFolderId, zipItemLargeInnerFileId, zipItemMultipleFoldersAtRootId, zipJiraArchiveFileId, zipEncryptedFileId, codeFileId, emailFileId, emailUnsupportedFileId, vrVideoDetails, } from './exampleMediaItems';
5
+ export declare const authProviderBaseURL = "https://media.dev.atl-paas.net";
6
+ export { mediaPickerAuthProvider, defaultMediaPickerAuthProvider, } from './mediaPickerAuthProvider';
7
+ export { fakeMediaClient } from './fakeMediaClient';
@@ -0,0 +1,23 @@
1
+ import { MediaClient } from '../';
2
+ import { MediaClientConfig } from '@atlaskit/media-core';
3
+ import { MediaEnv } from './mediaPickerAuthProvider';
4
+ export declare const defaultBaseUrl = "https://media.dev.atl-paas.net";
5
+ export declare const defaultParams: {
6
+ clientId: string;
7
+ asapIssuer: string;
8
+ baseUrl: string;
9
+ };
10
+ interface AuthParameter {
11
+ authType: 'client' | 'asap';
12
+ }
13
+ /**
14
+ * Creates and returns `MediaClient` (from `media-client`) based on the data provided in parameter object.
15
+ *
16
+ * @param {AuthParameter} authParameter specifies serviceName and whatever auth should be done with clientId or asapIssuer
17
+ * @returns {Context}
18
+ */
19
+ export declare const createStorybookMediaClient: (authParameter?: AuthParameter) => MediaClient;
20
+ export declare const createStorybookMediaClientConfig: (authParameter?: AuthParameter) => MediaClientConfig;
21
+ export declare const createUploadMediaClient: () => MediaClient;
22
+ export declare const createUploadMediaClientConfig: (stargateBaseUrl?: string, env?: MediaEnv) => MediaClientConfig;
23
+ export {};
@@ -0,0 +1,5 @@
1
+ import { Auth, AuthContext } from '@atlaskit/media-core';
2
+ export declare const authProviderBaseURL = "https://media.dev.atl-paas.net";
3
+ export type MediaEnv = 'dev' | 'staging';
4
+ export declare const mediaPickerAuthProvider: (authEnvironment?: string, env?: MediaEnv) => (context?: AuthContext) => Promise<Auth>;
5
+ export declare const defaultMediaPickerAuthProvider: () => () => Promise<Auth>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/media-client",
3
- "version": "23.1.2",
3
+ "version": "23.2.0",
4
4
  "description": "Media API Web Client Library",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -24,6 +24,7 @@
24
24
  "atlaskit:src": "src/index.ts",
25
25
  "af:exports": {
26
26
  "./constants": "./src/constants.ts",
27
+ "./test-helpers": "./src/test-helpers/index.ts",
27
28
  ".": "./src/index.ts"
28
29
  },
29
30
  "atlassian": {
@@ -36,7 +37,7 @@
36
37
  },
37
38
  "dependencies": {
38
39
  "@atlaskit/chunkinator": "^4.2.0",
39
- "@atlaskit/media-common": "^7.1.0",
40
+ "@atlaskit/media-common": "^8.2.0",
40
41
  "@babel/runtime": "^7.0.0",
41
42
  "dataloader": "^2.0.0",
42
43
  "deep-equal": "^1.0.1",
@@ -52,13 +53,19 @@
52
53
  "peerDependencies": {
53
54
  "@atlaskit/media-core": "^34.1.2",
54
55
  "@emotion/react": "^11.7.1",
56
+ "enzyme": ">=3.10.0",
55
57
  "react": "^16.8.0"
56
58
  },
59
+ "peerDependenciesMeta": {
60
+ "enzyme": {
61
+ "optional": true,
62
+ "dev": true
63
+ }
64
+ },
57
65
  "devDependencies": {
58
66
  "@atlaskit/media-core": "^34.1.0",
59
- "@atlaskit/media-test-helpers": "^33.0.0",
60
67
  "@atlaskit/ssr": "*",
61
- "@atlaskit/tokens": "^1.13.0",
68
+ "@atlaskit/tokens": "^1.18.0",
62
69
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
63
70
  "@emotion/react": "^11.7.1",
64
71
  "@types/deep-equal": "^1.0.1",
package/report.api.md CHANGED
@@ -847,6 +847,12 @@ export interface MediaFileArtifacts {
847
847
  // (undocumented)
848
848
  'document.pdf'?: MediaFileArtifact;
849
849
  // (undocumented)
850
+ 'image.jpg'?: MediaFileArtifact;
851
+ // (undocumented)
852
+ 'image.png'?: MediaFileArtifact;
853
+ // (undocumented)
854
+ 'thumb.jpg'?: MediaFileArtifact;
855
+ // (undocumented)
850
856
  'video_1280.mp4'?: MediaFileArtifact;
851
857
  // (undocumented)
852
858
  'video_640.mp4'?: MediaFileArtifact;
@@ -1671,6 +1677,7 @@ export type WithMediaClientFunction = <P extends WithMediaClient>(
1671
1677
  {
1672
1678
  "@atlaskit/media-core": "^34.1.2",
1673
1679
  "@emotion/react": "^11.7.1",
1680
+ "enzyme": ">=3.10.0",
1674
1681
  "react": "^16.8.0"
1675
1682
  }
1676
1683
  ```
@@ -629,6 +629,12 @@ export interface MediaFileArtifacts {
629
629
  // (undocumented)
630
630
  'document.pdf'?: MediaFileArtifact;
631
631
  // (undocumented)
632
+ 'image.jpg'?: MediaFileArtifact;
633
+ // (undocumented)
634
+ 'image.png'?: MediaFileArtifact;
635
+ // (undocumented)
636
+ 'thumb.jpg'?: MediaFileArtifact;
637
+ // (undocumented)
632
638
  'video_1280.mp4'?: MediaFileArtifact;
633
639
  // (undocumented)
634
640
  'video_640.mp4'?: MediaFileArtifact;
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/media-client",
3
- "version": "23.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/media-client",
3
- "version": "23.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/media-client",
3
- "version": "23.1.2",
4
- "sideEffects": false
5
- }