@atlaskit/media-client 36.3.2 → 36.3.4
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 +51 -0
- package/CHANGELOG.md +12 -0
- package/package.json +4 -4
package/AGENTS.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# media-client — Agent Guide
|
|
2
|
+
|
|
3
|
+
> **Parent guide:** Always read [`../AGENTS.md`](../AGENTS.md) before working in this package — it
|
|
4
|
+
> contains workspace-wide rules covering platform guidelines, changeset workflow, accessibility
|
|
5
|
+
> standards, and the knowledge index protocol that applies to every Media package.
|
|
6
|
+
|
|
7
|
+
## Package identity
|
|
8
|
+
|
|
9
|
+
| Field | Value |
|
|
10
|
+
|---|---|
|
|
11
|
+
| NPM name | `@atlaskit/media-client` |
|
|
12
|
+
| Path | `media-client/` |
|
|
13
|
+
| Owner | Media Exif |
|
|
14
|
+
| Purpose | Media API Web Client Library — manages file state subscriptions, uploads, downloads, and communication with the Media backend API |
|
|
15
|
+
|
|
16
|
+
## Knowledge index
|
|
17
|
+
|
|
18
|
+
> Read, search, edit, investigate, and validate the repository knowledge index at
|
|
19
|
+
> `.agents/knowledge-index/`. ALWAYS use this skill before making ANY repo change, or when
|
|
20
|
+
> exploring the codebase. The knowledge index is the canonical starting point for every coding task
|
|
21
|
+
> in this repo, trigger this skill aggressively whenever the user mentions architecture, conventions,
|
|
22
|
+
> packages, modules, services, build, coding, writing code, APIs, feature flags, testing, or
|
|
23
|
+
> anything similar. Also trigger when "is the knowledge index up to date?" / "update the knowledge
|
|
24
|
+
> index" / "what does the knowledge index say about Y?" — even if they don't say the words
|
|
25
|
+
> "knowledge index". Also use it (via the `validate` subcommand) to detect drift between the
|
|
26
|
+
> codebase and the docs after any code change. Use the `generate` subcommand to bootstrap the index
|
|
27
|
+
> in a new repository.
|
|
28
|
+
|
|
29
|
+
**Entry point:** `.agents/knowledge-index/INDEX.md`
|
|
30
|
+
**Unit doc:** `.agents/knowledge-index/domains/media/units/atlaskit-media-client.md`
|
|
31
|
+
**CLI:** `python3 .agents/skills/knowledge-index/scripts/kg.py {find,read,edit,investigate,validate,init,explore,generate} …`
|
|
32
|
+
**Refresh protocol:** never silently bump `Last verified` — always re-read the listed `Sources` first, edit, then `kg.py edit <path> --message "<reason>"`.
|
|
33
|
+
|
|
34
|
+
## Key source files
|
|
35
|
+
|
|
36
|
+
- `src/index.ts` — public API entry point
|
|
37
|
+
- `src/client/` — MediaClient implementation and file fetcher
|
|
38
|
+
- `src/models/` — data models and error types
|
|
39
|
+
- `src/uploader/` — file upload logic
|
|
40
|
+
- `src/utils/` — utilities (hashing, polling, request, mobile upload state machine)
|
|
41
|
+
- `src/upload-controller.ts` — upload lifecycle controller
|
|
42
|
+
- `src/file-streams-cache.ts` — observable file state caching
|
|
43
|
+
- `src/identifier.ts` — file/external identifier types
|
|
44
|
+
|
|
45
|
+
## Development notes
|
|
46
|
+
|
|
47
|
+
- Peer dependencies: `@atlaskit/media-core`, `@atlaskit/media-state`
|
|
48
|
+
- Key internal dependencies: `@atlaskit/chunkinator`, `@atlaskit/media-common`
|
|
49
|
+
- 8 feature flags registered (see `package.json` → `platform-feature-flags`)
|
|
50
|
+
- Notable flags: `platform_media_cdn_delivery`, `platform_media_cdn_single_host`, `platform_media_auth_provider_analytics`
|
|
51
|
+
- All new behaviour changes must be behind a feature gate (`fg()` from `@atlaskit/platform-feature-flags`)
|
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/media-client",
|
|
3
|
-
"version": "36.3.
|
|
3
|
+
"version": "36.3.4",
|
|
4
4
|
"description": "Media API Web Client Library",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
}
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@atlaskit/atlassian-context": "^0.
|
|
32
|
+
"@atlaskit/atlassian-context": "^0.11.0",
|
|
33
33
|
"@atlaskit/chunkinator": "^7.1.0",
|
|
34
34
|
"@atlaskit/media-common": "^13.3.0",
|
|
35
35
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
@@ -52,8 +52,8 @@
|
|
|
52
52
|
"@atlaskit/media-core": "^37.1.0",
|
|
53
53
|
"@atlaskit/media-state": "^2.2.0",
|
|
54
54
|
"@atlaskit/ssr": "workspace:^",
|
|
55
|
-
"@atlaskit/tokens": "^13.
|
|
56
|
-
"@atlassian/a11y-jest-testing": "^0.
|
|
55
|
+
"@atlaskit/tokens": "^13.3.0",
|
|
56
|
+
"@atlassian/a11y-jest-testing": "^0.12.0",
|
|
57
57
|
"@atlassian/feature-flags-test-utils": "^1.1.0",
|
|
58
58
|
"@emotion/react": "^11.7.1",
|
|
59
59
|
"@types/deep-equal": "^1.0.1",
|