@antelopejs/dms-media 0.5.1 → 0.6.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.
Files changed (135) hide show
  1. package/README.md +3 -3
  2. package/dist/db/models/mediaFolders.model.d.ts +0 -3
  3. package/dist/db/models/mediaFolders.model.js +0 -29
  4. package/dist/db/models/mediaFolders.model.js.map +1 -1
  5. package/dist/db/tables/mediaDeclarations.table.d.ts +0 -4
  6. package/dist/db/tables/mediaDeclarations.table.js +0 -16
  7. package/dist/db/tables/mediaDeclarations.table.js.map +1 -1
  8. package/dist/declared/assets.d.ts +0 -2
  9. package/dist/declared/assets.js +12 -140
  10. package/dist/declared/assets.js.map +1 -1
  11. package/dist/declared/folders.d.ts +1 -5
  12. package/dist/declared/folders.js +14 -80
  13. package/dist/declared/folders.js.map +1 -1
  14. package/dist/declared/index.d.ts +0 -2
  15. package/dist/declared/index.js +0 -2
  16. package/dist/declared/index.js.map +1 -1
  17. package/dist/declared/records.d.ts +2 -30
  18. package/dist/declared/records.js +3 -33
  19. package/dist/declared/records.js.map +1 -1
  20. package/dist/derivatives.js +5 -17
  21. package/dist/derivatives.js.map +1 -1
  22. package/dist/frontend-module.d.ts +4 -0
  23. package/dist/frontend-module.js +24 -0
  24. package/dist/frontend-module.js.map +1 -0
  25. package/dist/implementations/interface-dms-media/index.d.ts +1 -3
  26. package/dist/implementations/interface-dms-media/index.js +0 -2
  27. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  28. package/dist/index.d.ts +1 -3
  29. package/dist/index.js +3 -19
  30. package/dist/index.js.map +1 -1
  31. package/dist/library/realtime.js +8 -1
  32. package/dist/library/realtime.js.map +1 -1
  33. package/dist/pages/activity.d.ts +1 -0
  34. package/dist/pages/activity.js +3 -0
  35. package/dist/pages/activity.js.map +1 -1
  36. package/dist/pages/overview.d.ts +1 -0
  37. package/dist/pages/overview.js +3 -2
  38. package/dist/pages/overview.js.map +1 -1
  39. package/dist/pages/toolbar.d.ts +3 -0
  40. package/dist/pages/toolbar.js +19 -0
  41. package/dist/pages/toolbar.js.map +1 -0
  42. package/dist/pages/uploads.d.ts +1 -0
  43. package/dist/pages/uploads.js +4 -0
  44. package/dist/pages/uploads.js.map +1 -1
  45. package/dist/routes/media/delivery-stream.js +7 -21
  46. package/dist/routes/media/delivery-stream.js.map +1 -1
  47. package/dist/routes/media/manage.d.ts +23 -0
  48. package/dist/routes/media/manage.js +7 -4
  49. package/dist/routes/media/manage.js.map +1 -1
  50. package/dist/routes/media/upload.js +2 -5
  51. package/dist/routes/media/upload.js.map +1 -1
  52. package/dist/test/antelope.test.js +9 -4
  53. package/dist/test/antelope.test.js.map +1 -1
  54. package/dist/test/integration/media-activity-overview.test.js +6 -0
  55. package/dist/test/integration/media-activity-overview.test.js.map +1 -1
  56. package/dist/test/integration/media-declared-content.test.js +17 -317
  57. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  58. package/dist/test/integration/media-linked-subfolders.test.js +2 -2
  59. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  60. package/dist/test/integration/media-storage-origin-unreachable.test.js +79 -0
  61. package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
  62. package/dist/test/unit/declared.test.js +0 -66
  63. package/dist/test/unit/declared.test.js.map +1 -1
  64. package/dist/test/unit/library/realtime.test.d.ts +1 -0
  65. package/dist/test/unit/library/realtime.test.js +44 -0
  66. package/dist/test/unit/library/realtime.test.js.map +1 -0
  67. package/dist/test/unit/pages/toolbar.test.d.ts +1 -0
  68. package/dist/test/unit/pages/toolbar.test.js +64 -0
  69. package/dist/test/unit/pages/toolbar.test.js.map +1 -0
  70. package/dist/test/unit/routes/preset-row.test.d.ts +1 -0
  71. package/dist/test/unit/routes/preset-row.test.js +36 -0
  72. package/dist/test/unit/routes/preset-row.test.js.map +1 -0
  73. package/dist/validation/declared.schema.d.ts +7 -36
  74. package/dist/validation/declared.schema.js +1 -12
  75. package/dist/validation/declared.schema.js.map +1 -1
  76. package/frontend-vue/app/components/Explorer.vue +2 -0
  77. package/frontend-vue/app/components/FirstRun.vue +3 -1
  78. package/frontend-vue/app/components/PresetCards.vue +28 -5
  79. package/frontend-vue/app/components/RecentFiles.vue +11 -5
  80. package/frontend-vue/app/components/UploadQueue.vue +3 -1
  81. package/frontend-vue/app/components/UploadStrip.vue +3 -1
  82. package/frontend-vue/app/components/explorer/ExplorerDetailsDrawer.vue +10 -0
  83. package/frontend-vue/app/components/explorer/ExplorerInspector.vue +19 -14
  84. package/frontend-vue/app/components/explorer/ExplorerShell.vue +1 -11
  85. package/frontend-vue/app/composables/library/useExplorerCommands.ts +7 -1
  86. package/frontend-vue/app/composables/library/useExplorerDetailsDrawer.ts +75 -0
  87. package/frontend-vue/i18n/locales/media-en-GB.json +9 -2
  88. package/frontend-vue/i18n/locales/media-fr-FR.json +9 -2
  89. package/frontend-vue/package.json +1 -1
  90. package/frontend-vue/tests/detailsDrawer.test.ts +150 -0
  91. package/frontend-vue/tests/fixtures/serverRender.ts +70 -0
  92. package/frontend-vue/tests/locales.test.ts +17 -0
  93. package/frontend-vue/tests/serverRender.test.ts +47 -2
  94. package/package.json +10 -9
  95. package/skills/dms-media/SKILL.md +17 -24
  96. package/src/db/models/mediaFolders.model.ts +0 -44
  97. package/src/db/tables/mediaDeclarations.table.ts +3 -19
  98. package/src/declared/assets.ts +19 -210
  99. package/src/declared/folders.ts +22 -135
  100. package/src/declared/index.ts +0 -2
  101. package/src/declared/records.ts +8 -82
  102. package/src/derivatives.ts +7 -17
  103. package/src/frontend-module.ts +35 -0
  104. package/src/implementations/interface-dms-media/index.ts +1 -8
  105. package/src/index.ts +4 -28
  106. package/src/library/realtime.ts +12 -3
  107. package/src/pages/activity.ts +4 -0
  108. package/src/pages/overview.ts +4 -3
  109. package/src/pages/toolbar.ts +28 -0
  110. package/src/pages/uploads.ts +5 -0
  111. package/src/routes/media/delivery-stream.ts +12 -28
  112. package/src/routes/media/manage.ts +17 -4
  113. package/src/routes/media/upload.ts +4 -6
  114. package/src/test/antelope.test.ts +13 -4
  115. package/src/test/integration/media-activity-overview.test.ts +5 -0
  116. package/src/test/integration/media-declared-content.test.ts +17 -360
  117. package/src/test/integration/media-linked-subfolders.test.ts +2 -2
  118. package/src/test/integration/media-storage-origin-unreachable.test.ts +110 -0
  119. package/src/test/unit/declared.test.ts +0 -87
  120. package/src/test/unit/library/realtime.test.ts +55 -0
  121. package/src/test/unit/pages/toolbar.test.ts +92 -0
  122. package/src/test/unit/routes/preset-row.test.ts +39 -0
  123. package/src/validation/declared.schema.ts +0 -13
  124. package/dist/declared/readiness.d.ts +0 -2
  125. package/dist/declared/readiness.js +0 -52
  126. package/dist/declared/readiness.js.map +0 -1
  127. package/dist/declared/retire.d.ts +0 -3
  128. package/dist/declared/retire.js +0 -118
  129. package/dist/declared/retire.js.map +0 -1
  130. package/dist/test/integration/media-declared-retire.test.js +0 -186
  131. package/dist/test/integration/media-declared-retire.test.js.map +0 -1
  132. package/src/declared/readiness.ts +0 -64
  133. package/src/declared/retire.ts +0 -206
  134. package/src/test/integration/media-declared-retire.test.ts +0 -257
  135. /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
@@ -1,257 +0,0 @@
1
- import { GetModel } from "@antelopejs/interface-database-decorators";
2
- import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
3
- import {
4
- EnsureMediaFolder,
5
- ImportMediaAsset,
6
- PruneMediaDeclarations,
7
- RetireMediaDeclaration,
8
- } from "@antelopejs/interface-dms-media";
9
- import type { AxiosInstance } from "axios";
10
- import { expect } from "chai";
11
- import {
12
- MediaAssetModel,
13
- MediaDeclarationModel,
14
- MediaEventModel,
15
- MediaFolderModel,
16
- } from "../../db";
17
- import { authorizedClient } from "../helpers/http";
18
- import { ensureOwnerSession } from "../helpers/owner";
19
-
20
- const HTTP_OK = 200;
21
- const PREFIX = "retire.";
22
- const ROOT_KEY = "retire.root";
23
- const tenantId = DEFAULT_TENANT_ID;
24
-
25
- function folders() {
26
- return GetModel(MediaFolderModel, tenantId);
27
- }
28
-
29
- function assets() {
30
- return GetModel(MediaAssetModel, tenantId);
31
- }
32
-
33
- function declarations() {
34
- return GetModel(MediaDeclarationModel, tenantId);
35
- }
36
-
37
- async function rejectionOf(promise: Promise<unknown>): Promise<Error> {
38
- try {
39
- await promise;
40
- } catch (error) {
41
- return error as Error;
42
- }
43
- throw new Error("Expected the call to be refused");
44
- }
45
-
46
- function textFile(key: string, folderKey: string, text: string) {
47
- return ImportMediaAsset({
48
- tenantId,
49
- key,
50
- folder: { key: folderKey },
51
- name: `${key.slice(PREFIX.length)}.txt`,
52
- mimetype: "text/plain",
53
- source: { bytes: Buffer.from(text) },
54
- });
55
- }
56
-
57
- /** The library rows still standing, deleting tombstones aside. */
58
- async function liveAsset(id: string | undefined) {
59
- const asset = await assets().get(id as string);
60
- return asset && !asset.isDeleting ? asset : undefined;
61
- }
62
-
63
- describe("[integration] media declared content — retiring what the code no longer declares", () => {
64
- let client: AxiosInstance;
65
-
66
- before(async () => {
67
- client = authorizedClient((await ensureOwnerSession()).accessToken);
68
- await EnsureMediaFolder({ tenantId, key: ROOT_KEY, name: "Retired" });
69
- });
70
-
71
- after(async () => {
72
- const all = await folders().getAll();
73
- const root = all.find((folder) => folder.name === "Retired");
74
- if (root) await client.delete(`/api/media/folders/${root._id}`);
75
- const records = (await declarations().getAll()).filter((record) =>
76
- record.key.startsWith(PREFIX),
77
- );
78
- await Promise.all(
79
- records.map((record) => declarations().delete(record._id)),
80
- );
81
- });
82
-
83
- it("removes a file still as declared, once, and forgets its key", async () => {
84
- const file = await textFile("retire.untouched", ROOT_KEY, "Untouched");
85
- const retired = await RetireMediaDeclaration({
86
- tenantId,
87
- kind: "asset",
88
- key: "retire.untouched",
89
- });
90
- expect(retired).to.deep.equal({
91
- kind: "asset",
92
- key: "retire.untouched",
93
- status: "removed",
94
- id: file.id,
95
- });
96
- expect(await liveAsset(file.id)).to.equal(undefined);
97
- expect(
98
- await declarations().findByKey("asset", "retire.untouched"),
99
- ).to.equal(undefined);
100
- const events = await GetModel(MediaEventModel, tenantId).getBy(
101
- "kind",
102
- "asset.delete",
103
- );
104
- expect(events.some((event) => event.assetId === file.id)).to.equal(true);
105
- expect(
106
- (
107
- await RetireMediaDeclaration({
108
- tenantId,
109
- kind: "asset",
110
- key: "retire.untouched",
111
- })
112
- ).status,
113
- ).to.equal("unknown");
114
- // Declared again, the key creates new content.
115
- const again = await textFile("retire.untouched", ROOT_KEY, "Untouched");
116
- expect(again.status).to.equal("created");
117
- expect(again.id).to.not.equal(file.id);
118
- });
119
-
120
- it("leaves a file a member changed, and hands it over to them", async () => {
121
- const file = await textFile("retire.edited", ROOT_KEY, "Edited");
122
- const rename = await client.post(`/api/media/assets/${file.id}/update`, {
123
- name: "kept-by-member.txt",
124
- });
125
- expect(rename.status).to.equal(HTTP_OK);
126
- const retired = await RetireMediaDeclaration({
127
- tenantId,
128
- kind: "asset",
129
- key: "retire.edited",
130
- });
131
- expect(retired.status).to.equal("preserved");
132
- expect((await liveAsset(file.id))?.name).to.equal("kept-by-member.txt");
133
- expect(await declarations().findByKey("asset", "retire.edited")).to.equal(
134
- undefined,
135
- );
136
- });
137
-
138
- it("reports a file a member already deleted", async () => {
139
- const file = await textFile("retire.gone", ROOT_KEY, "Gone");
140
- await client.delete(`/api/media/assets/${file.id}`);
141
- expect(
142
- (
143
- await RetireMediaDeclaration({
144
- tenantId,
145
- kind: "asset",
146
- key: "retire.gone",
147
- })
148
- ).status,
149
- ).to.equal("deleted");
150
- });
151
-
152
- it("keeps a declared folder holding a member's file", async () => {
153
- const folder = await EnsureMediaFolder({
154
- tenantId,
155
- key: "retire.shared",
156
- name: "Shared",
157
- parent: ROOT_KEY,
158
- });
159
- await textFile("retire.shared-file", "retire.shared", "Shared");
160
- const memberFolder = await client.post("/api/media/folders", {
161
- name: "Member's",
162
- parentId: folder.id,
163
- });
164
- expect(memberFolder.status).to.equal(HTTP_OK);
165
- const results = await PruneMediaDeclarations({
166
- tenantId,
167
- prefix: "retire.shared",
168
- keep: [],
169
- });
170
- expect(
171
- results.map(({ kind, key, status }) => ({ kind, key, status })),
172
- ).to.deep.equal([
173
- { kind: "asset", key: "retire.shared-file", status: "removed" },
174
- { kind: "folder", key: "retire.shared", status: "preserved" },
175
- ]);
176
- expect(await folders().get(folder.id as string)).to.not.equal(undefined);
177
- });
178
-
179
- it("prunes the stale declarations of a prefix, files first and deepest folders first", async () => {
180
- await EnsureMediaFolder({
181
- tenantId,
182
- key: "retire.v1",
183
- name: "Version 1",
184
- parent: ROOT_KEY,
185
- });
186
- const nested = await EnsureMediaFolder({
187
- tenantId,
188
- key: "retire.v1.nested",
189
- name: "Nested",
190
- parent: "retire.v1",
191
- });
192
- const kept = await textFile("retire.v1.kept", "retire.v1", "Kept");
193
- const stale = await textFile("retire.v1.stale", "retire.v1", "Stale");
194
- const deep = await textFile("retire.v1.deep", "retire.v1.nested", "Deep");
195
- const results = await PruneMediaDeclarations({
196
- tenantId,
197
- prefix: "retire.v1",
198
- keep: ["retire.v1", "retire.v1.kept"],
199
- });
200
- expect(
201
- results.map(({ kind, key, status }) => ({ kind, key, status })),
202
- ).to.have.deep.members([
203
- { kind: "asset", key: "retire.v1.stale", status: "removed" },
204
- { kind: "asset", key: "retire.v1.deep", status: "removed" },
205
- { kind: "folder", key: "retire.v1.nested", status: "removed" },
206
- ]);
207
- expect(results.at(-1)?.kind).to.equal("folder");
208
- expect(await liveAsset(stale.id)).to.equal(undefined);
209
- expect(await liveAsset(deep.id)).to.equal(undefined);
210
- expect(await folders().get(nested.id as string)).to.equal(undefined);
211
- expect(await liveAsset(kept.id)).to.not.equal(undefined);
212
- // Pruning again finds nothing left to retire.
213
- expect(
214
- await PruneMediaDeclarations({
215
- tenantId,
216
- prefix: "retire.v1",
217
- keep: ["retire.v1", "retire.v1.kept"],
218
- }),
219
- ).to.deep.equal([]);
220
- expect(
221
- (await textFile("retire.v1.kept", "retire.v1", "Kept")).status,
222
- ).to.equal("unchanged");
223
- });
224
-
225
- it("refuses a blank prefix, an unknown kind and a missing tenant", async () => {
226
- expect(
227
- (
228
- await rejectionOf(
229
- PruneMediaDeclarations({ tenantId, prefix: " ", keep: [] }),
230
- )
231
- ).message,
232
- ).to.contain("prefix");
233
- expect(
234
- (
235
- await rejectionOf(
236
- RetireMediaDeclaration({
237
- tenantId,
238
- // @ts-expect-error A JavaScript caller can pass any kind.
239
- kind: "page",
240
- key: "retire.page",
241
- }),
242
- )
243
- ).message,
244
- ).to.contain("kind");
245
- expect(
246
- (
247
- await rejectionOf(
248
- RetireMediaDeclaration({
249
- tenantId: "",
250
- kind: "asset",
251
- key: "retire.no-tenant",
252
- }),
253
- )
254
- ).message,
255
- ).to.contain("tenantId");
256
- });
257
- });