@atlaskit/media-document-viewer 1.0.1 → 1.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.
- package/AGENTS.md +7 -5
- package/CHANGELOG.md +30 -1
- package/compass.yml +38 -0
- package/dist/cjs/entry-points/documentViewer.js +12 -0
- package/dist/cjs/entry-points/getDocumentRoot.js +12 -0
- package/dist/es2019/entry-points/documentViewer.js +1 -0
- package/dist/es2019/entry-points/getDocumentRoot.js +1 -0
- package/dist/esm/entry-points/documentViewer.js +1 -0
- package/dist/esm/entry-points/getDocumentRoot.js +1 -0
- package/dist/types/entry-points/documentViewer.d.ts +1 -0
- package/dist/types/entry-points/getDocumentRoot.d.ts +1 -0
- package/document-viewer/package.json +10 -0
- package/get-document-root/package.json +10 -0
- package/media-document-viewer.docs.tsx +41 -0
- package/package.json +10 -10
package/AGENTS.md
CHANGED
|
@@ -26,11 +26,13 @@
|
|
|
26
26
|
> codebase and the docs after any code change. Use the `generate` subcommand to bootstrap the index
|
|
27
27
|
> in a new repository.
|
|
28
28
|
|
|
29
|
-
**Entry point:** `.agents/knowledge-index/INDEX.md`
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
**CLI:**
|
|
33
|
-
|
|
29
|
+
**Entry point:** `.agents/knowledge-index/INDEX.md` **Unit doc:**
|
|
30
|
+
`.agents/knowledge-index/domains/media/units/atlaskit-media-document-viewer.md` **Standards page:**
|
|
31
|
+
`.agents/knowledge-index/domains/media/units/atlaskit-media-document-viewer/standards-and-patterns.md`
|
|
32
|
+
**CLI:**
|
|
33
|
+
`python3 .agents/skills/knowledge-index/scripts/kg.py {find,read,edit,investigate,validate,init,explore,generate} …`
|
|
34
|
+
**Refresh protocol:** never silently bump `Last verified` — always re-read the listed `Sources`
|
|
35
|
+
first, edit, then `kg.py edit <path> --message "<reason>"`.
|
|
34
36
|
|
|
35
37
|
## Key source files
|
|
36
38
|
|
package/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,40 @@
|
|
|
1
1
|
# @atlaskit/media-document-viewer
|
|
2
2
|
|
|
3
|
+
## 1.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`c98e0cf5cc4f6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c98e0cf5cc4f6) -
|
|
8
|
+
Autofix: add explicit package exports (barrel removal)
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
|
|
14
|
+
## 1.1.0
|
|
15
|
+
|
|
16
|
+
### Minor Changes
|
|
17
|
+
|
|
18
|
+
- [`cd097a2111788`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cd097a2111788) -
|
|
19
|
+
Republish packages depending on `@atlaskit/react-compiler-gating` so their published dependency
|
|
20
|
+
reference is updated to the renamed `@atlaskit/react-compiler-gating` scope.
|
|
21
|
+
|
|
22
|
+
The earlier rename of `@atlassian/react-compiler-gating` to `@atlaskit/react-compiler-gating` only
|
|
23
|
+
bumped the renamed package itself, so dependent packages were never republished and their
|
|
24
|
+
published versions still referenced the old `@atlassian/react-compiler-gating` name, which is not
|
|
25
|
+
available in the public npm registry. This minor bump republishes all affected packages with the
|
|
26
|
+
corrected dependency.
|
|
27
|
+
|
|
28
|
+
### Patch Changes
|
|
29
|
+
|
|
30
|
+
- Updated dependencies
|
|
31
|
+
|
|
3
32
|
## 1.0.1
|
|
4
33
|
|
|
5
34
|
### Patch Changes
|
|
6
35
|
|
|
7
36
|
- [`ee28cf33718b0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ee28cf33718b0) -
|
|
8
|
-
Add @
|
|
37
|
+
Add @atlaskit/react-compiler-gating as a runtime dependency to enable React Compiler platform
|
|
9
38
|
gating.
|
|
10
39
|
- Updated dependencies
|
|
11
40
|
|
package/compass.yml
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
configVersion: 1
|
|
2
|
+
id: ari:cloud:compass:a436116f-02ce-4520-8fbb-7301462a1674:component/c5751cc6-3513-4070-9deb-af31e86aed34/1e09a7a9-92d6-488d-854f-f3bd7fb49c8b
|
|
3
|
+
name: '@atlaskit/media-document-viewer'
|
|
4
|
+
ownerId: ari:cloud:identity::team/67d46864-2809-45fc-8ef0-f9a810dc13c5 # Media EXIF
|
|
5
|
+
labels:
|
|
6
|
+
- platform-code
|
|
7
|
+
- platform-afm
|
|
8
|
+
typeId: OTHER
|
|
9
|
+
fields:
|
|
10
|
+
tier: 4
|
|
11
|
+
lifecycle: Active
|
|
12
|
+
isMonorepoProject: true
|
|
13
|
+
links:
|
|
14
|
+
- name: Root Repository
|
|
15
|
+
type: REPOSITORY
|
|
16
|
+
url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master
|
|
17
|
+
- name: Slack Channel
|
|
18
|
+
type: CHAT_CHANNEL
|
|
19
|
+
url: https://atlassian.enterprise.slack.com/archives/C05J5GNHPLN # #help-media-platform
|
|
20
|
+
- name: Media Document Viewer
|
|
21
|
+
type: REPOSITORY
|
|
22
|
+
url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/media/media-document-viewer
|
|
23
|
+
customFields:
|
|
24
|
+
- name: Department
|
|
25
|
+
type: text
|
|
26
|
+
value: Eng - Automation
|
|
27
|
+
- name: Technical Owner
|
|
28
|
+
type: user
|
|
29
|
+
value: ari:cloud:identity::user/712020:678ede01-221b-4b2f-9fce-adcc0b0d095e # Anupama Majety
|
|
30
|
+
- name: Required Reviewers Opt In
|
|
31
|
+
type: boolean
|
|
32
|
+
value: true
|
|
33
|
+
- name: Reviewer Selection Mechanism
|
|
34
|
+
type: text
|
|
35
|
+
value: random(2)
|
|
36
|
+
- name: Required Reviewer Approvals
|
|
37
|
+
type: number
|
|
38
|
+
value: 1
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
Object.defineProperty(exports, "DocumentViewer", {
|
|
7
|
+
enumerable: true,
|
|
8
|
+
get: function get() {
|
|
9
|
+
return _documentViewer.DocumentViewer;
|
|
10
|
+
}
|
|
11
|
+
});
|
|
12
|
+
var _documentViewer = require("../documentViewer");
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
Object.defineProperty(exports, "DOCUMENT_SCROLL_ROOT_ID", {
|
|
7
|
+
enumerable: true,
|
|
8
|
+
get: function get() {
|
|
9
|
+
return _getDocumentRoot.DOCUMENT_SCROLL_ROOT_ID;
|
|
10
|
+
}
|
|
11
|
+
});
|
|
12
|
+
var _getDocumentRoot = require("../utils/getDocumentRoot");
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DocumentViewer } from '../documentViewer';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DOCUMENT_SCROLL_ROOT_ID } from '../utils/getDocumentRoot';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DocumentViewer } from '../documentViewer';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DOCUMENT_SCROLL_ROOT_ID } from '../utils/getDocumentRoot';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DocumentViewer } from '../documentViewer';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { DOCUMENT_SCROLL_ROOT_ID } from '../utils/getDocumentRoot';
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/media-document-viewer/document-viewer",
|
|
3
|
+
"main": "../dist/cjs/entry-points/documentViewer.js",
|
|
4
|
+
"module": "../dist/esm/entry-points/documentViewer.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/entry-points/documentViewer.js",
|
|
6
|
+
"sideEffects": [
|
|
7
|
+
"*.compiled.css"
|
|
8
|
+
],
|
|
9
|
+
"types": "../dist/types/entry-points/documentViewer.d.ts"
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@atlaskit/media-document-viewer/get-document-root",
|
|
3
|
+
"main": "../dist/cjs/entry-points/getDocumentRoot.js",
|
|
4
|
+
"module": "../dist/esm/entry-points/getDocumentRoot.js",
|
|
5
|
+
"module:es2019": "../dist/es2019/entry-points/getDocumentRoot.js",
|
|
6
|
+
"sideEffects": [
|
|
7
|
+
"*.compiled.css"
|
|
8
|
+
],
|
|
9
|
+
"types": "../dist/types/entry-points/getDocumentRoot.d.ts"
|
|
10
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
|
|
4
|
+
|
|
5
|
+
import packageJson from './package.json';
|
|
6
|
+
|
|
7
|
+
const packagePath = path.resolve(__dirname);
|
|
8
|
+
|
|
9
|
+
const documentation: StructuredContentSource = {
|
|
10
|
+
components: [
|
|
11
|
+
{
|
|
12
|
+
name: 'DocumentViewer',
|
|
13
|
+
description:
|
|
14
|
+
'A specialized viewer for document types like PDF, Word, and Excel, providing paginated navigation and zooming.',
|
|
15
|
+
status: 'general-availability',
|
|
16
|
+
import: {
|
|
17
|
+
name: 'DocumentViewer',
|
|
18
|
+
package: '@atlaskit/media-document-viewer',
|
|
19
|
+
type: 'named',
|
|
20
|
+
packagePath,
|
|
21
|
+
packageJson,
|
|
22
|
+
},
|
|
23
|
+
usageGuidelines: [
|
|
24
|
+
'Use DocumentViewer for high-fidelity previews of documents.',
|
|
25
|
+
'Supports multi-page navigation and zoom controls.',
|
|
26
|
+
'Ideal for embedding document previews within a page or modal.',
|
|
27
|
+
],
|
|
28
|
+
examples: [
|
|
29
|
+
{
|
|
30
|
+
name: 'Basic',
|
|
31
|
+
description: 'Standard document viewer example.',
|
|
32
|
+
source: path.resolve(packagePath, './examples/basic.tsx'),
|
|
33
|
+
},
|
|
34
|
+
],
|
|
35
|
+
keywords: ['media', 'document', 'viewer', 'pdf', 'word', 'excel', 'preview'],
|
|
36
|
+
categories: ['media'],
|
|
37
|
+
},
|
|
38
|
+
],
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
export default documentation;
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"react-compiler": {
|
|
4
4
|
"enabled": true,
|
|
5
5
|
"gating": {
|
|
6
|
-
"source": "@
|
|
6
|
+
"source": "@atlaskit/react-compiler-gating",
|
|
7
7
|
"importSpecifierName": "isReactCompilerActivePlatform"
|
|
8
8
|
}
|
|
9
9
|
},
|
|
@@ -23,13 +23,13 @@
|
|
|
23
23
|
],
|
|
24
24
|
"atlaskit:src": "src/index.ts",
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@atlaskit/browser-apis": "^1.
|
|
26
|
+
"@atlaskit/browser-apis": "^1.1.0",
|
|
27
27
|
"@atlaskit/css": "^1.0.0",
|
|
28
|
-
"@atlaskit/media-common": "^14.
|
|
29
|
-
"@atlaskit/primitives": "^20.
|
|
30
|
-
"@atlaskit/
|
|
31
|
-
"@atlaskit/
|
|
32
|
-
"@
|
|
28
|
+
"@atlaskit/media-common": "^14.3.0",
|
|
29
|
+
"@atlaskit/primitives": "^20.6.0",
|
|
30
|
+
"@atlaskit/react-compiler-gating": "^0.2.0",
|
|
31
|
+
"@atlaskit/spinner": "^20.1.0",
|
|
32
|
+
"@atlaskit/tokens": "^15.6.0",
|
|
33
33
|
"@babel/runtime": "^7.0.0",
|
|
34
34
|
"@compiled/react": "^0.20.0"
|
|
35
35
|
},
|
|
@@ -40,8 +40,8 @@
|
|
|
40
40
|
"@af/integration-testing": "workspace:^",
|
|
41
41
|
"@af/visual-regression": "workspace:^",
|
|
42
42
|
"@atlaskit/ssr": "workspace:^",
|
|
43
|
-
"@atlassian/a11y-jest-testing": "^0.
|
|
44
|
-
"@atlassian/feature-flags-test-utils": "^1.
|
|
43
|
+
"@atlassian/a11y-jest-testing": "^0.13.0",
|
|
44
|
+
"@atlassian/feature-flags-test-utils": "^1.2.0",
|
|
45
45
|
"@testing-library/react": "^16.3.0",
|
|
46
46
|
"@testing-library/user-event": "^14.4.3",
|
|
47
47
|
"react": "^18.2.0",
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
}
|
|
84
84
|
},
|
|
85
85
|
"name": "@atlaskit/media-document-viewer",
|
|
86
|
-
"version": "1.0
|
|
86
|
+
"version": "1.2.0",
|
|
87
87
|
"description": "Modern and fast document viewer",
|
|
88
88
|
"author": "Atlassian Pty Ltd",
|
|
89
89
|
"license": "Apache-2.0",
|