@antelopejs/dms-media 0.6.0 → 0.6.2

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 (238) hide show
  1. package/README.md +18 -3
  2. package/dist/acl/entries.js +1 -2
  3. package/dist/acl/entries.js.map +1 -1
  4. package/dist/bindings.js +1 -3
  5. package/dist/bindings.js.map +1 -1
  6. package/dist/db/models/mediaFolders.model.d.ts +0 -3
  7. package/dist/db/models/mediaFolders.model.js +0 -29
  8. package/dist/db/models/mediaFolders.model.js.map +1 -1
  9. package/dist/db/tables/mediaDeclarations.table.d.ts +0 -4
  10. package/dist/db/tables/mediaDeclarations.table.js +0 -16
  11. package/dist/db/tables/mediaDeclarations.table.js.map +1 -1
  12. package/dist/declared/assets.d.ts +0 -2
  13. package/dist/declared/assets.js +12 -140
  14. package/dist/declared/assets.js.map +1 -1
  15. package/dist/declared/folders.d.ts +1 -5
  16. package/dist/declared/folders.js +17 -82
  17. package/dist/declared/folders.js.map +1 -1
  18. package/dist/declared/index.d.ts +0 -2
  19. package/dist/declared/index.js +0 -2
  20. package/dist/declared/index.js.map +1 -1
  21. package/dist/declared/records.d.ts +4 -32
  22. package/dist/declared/records.js +6 -35
  23. package/dist/declared/records.js.map +1 -1
  24. package/dist/derivatives.js +14 -23
  25. package/dist/derivatives.js.map +1 -1
  26. package/dist/guards.d.ts +4 -0
  27. package/dist/guards.js +19 -0
  28. package/dist/guards.js.map +1 -0
  29. package/dist/implementations/interface-dms-media/index.d.ts +1 -3
  30. package/dist/implementations/interface-dms-media/index.js +0 -2
  31. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  32. package/dist/library/activity.js +7 -5
  33. package/dist/library/activity.js.map +1 -1
  34. package/dist/library/batches.js +6 -3
  35. package/dist/library/batches.js.map +1 -1
  36. package/dist/library/events.js +4 -4
  37. package/dist/library/events.js.map +1 -1
  38. package/dist/library/module-readout.js +5 -2
  39. package/dist/library/module-readout.js.map +1 -1
  40. package/dist/library/realtime.js.map +1 -1
  41. package/dist/pages/activity.js +1 -1
  42. package/dist/pages/activity.js.map +1 -1
  43. package/dist/routes/media/assets.d.ts +1 -1
  44. package/dist/routes/media/assets.js +5 -5
  45. package/dist/routes/media/assets.js.map +1 -1
  46. package/dist/routes/media/bulk.js +17 -13
  47. package/dist/routes/media/bulk.js.map +1 -1
  48. package/dist/routes/media/delivery-headers.js +9 -9
  49. package/dist/routes/media/delivery-headers.js.map +1 -1
  50. package/dist/routes/media/delivery-stream.js +7 -21
  51. package/dist/routes/media/delivery-stream.js.map +1 -1
  52. package/dist/routes/media/delivery.js.map +1 -1
  53. package/dist/routes/media/manage.js.map +1 -1
  54. package/dist/routes/media/transform.js +13 -8
  55. package/dist/routes/media/transform.js.map +1 -1
  56. package/dist/routes/media/upload.js +2 -5
  57. package/dist/routes/media/upload.js.map +1 -1
  58. package/dist/test/antelope.test.js +17 -16
  59. package/dist/test/antelope.test.js.map +1 -1
  60. package/dist/test/helpers/folders.d.ts +27 -0
  61. package/dist/test/helpers/folders.js +15 -0
  62. package/dist/test/helpers/folders.js.map +1 -1
  63. package/dist/test/helpers/pages.js +10 -6
  64. package/dist/test/helpers/pages.js.map +1 -1
  65. package/dist/test/helpers/permissions-world.d.ts +98 -0
  66. package/dist/test/helpers/permissions-world.js +205 -0
  67. package/dist/test/helpers/permissions-world.js.map +1 -0
  68. package/dist/test/helpers/prototype.d.ts +1 -0
  69. package/dist/test/helpers/prototype.js +11 -0
  70. package/dist/test/helpers/prototype.js.map +1 -0
  71. package/dist/test/integration/derivative-sweep-query.test.js +13 -16
  72. package/dist/test/integration/derivative-sweep-query.test.js.map +1 -1
  73. package/dist/test/integration/folder-query.test.js +5 -9
  74. package/dist/test/integration/folder-query.test.js.map +1 -1
  75. package/dist/test/integration/media-bindings.test.js +2 -2
  76. package/dist/test/integration/media-bindings.test.js.map +1 -1
  77. package/dist/test/integration/media-cleanup.test.js +14 -17
  78. package/dist/test/integration/media-cleanup.test.js.map +1 -1
  79. package/dist/test/integration/media-declared-content.test.js +19 -318
  80. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  81. package/dist/test/integration/media-delivery-editing.test.js +7 -5
  82. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  83. package/dist/test/integration/media-delivery.test.js +19 -5
  84. package/dist/test/integration/media-delivery.test.js.map +1 -1
  85. package/dist/test/integration/media-explorer-writes.test.js +2 -2
  86. package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
  87. package/dist/test/integration/media-guards.test.js +18 -7
  88. package/dist/test/integration/media-guards.test.js.map +1 -1
  89. package/dist/test/integration/media-library.test.js +1 -1
  90. package/dist/test/integration/media-library.test.js.map +1 -1
  91. package/dist/test/integration/media-linked-subfolders.test.js +6 -6
  92. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  93. package/dist/test/integration/media-member-access.test.js +2 -5
  94. package/dist/test/integration/media-member-access.test.js.map +1 -1
  95. package/dist/test/integration/media-permissions.test.js +142 -473
  96. package/dist/test/integration/media-permissions.test.js.map +1 -1
  97. package/dist/test/integration/media-project-field.test.js +3 -5
  98. package/dist/test/integration/media-project-field.test.js.map +1 -1
  99. package/dist/test/integration/media-search-query.test.js +11 -16
  100. package/dist/test/integration/media-search-query.test.js.map +1 -1
  101. package/dist/test/integration/media-storage-origin-unreachable.test.js +80 -0
  102. package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
  103. package/dist/test/integration/media-upload-policy.test.js +2 -2
  104. package/dist/test/integration/media-upload-policy.test.js.map +1 -1
  105. package/dist/test/integration/permissions-management.d.ts +2 -0
  106. package/dist/test/integration/permissions-management.js +189 -0
  107. package/dist/test/integration/permissions-management.js.map +1 -0
  108. package/dist/test/unit/acl/entries.test.js +2 -1
  109. package/dist/test/unit/acl/entries.test.js.map +1 -1
  110. package/dist/test/unit/acl/resolver.test.js +10 -3
  111. package/dist/test/unit/acl/resolver.test.js.map +1 -1
  112. package/dist/test/unit/declared.test.js +0 -66
  113. package/dist/test/unit/declared.test.js.map +1 -1
  114. package/dist/test/unit/library/fixtures.d.ts +1 -1
  115. package/dist/test/unit/library/fixtures.js +6 -1
  116. package/dist/test/unit/library/fixtures.js.map +1 -1
  117. package/dist/test/unit/library/library.test.js +0 -1
  118. package/dist/test/unit/library/library.test.js.map +1 -1
  119. package/dist/test/unit/library/realtime.test.js +1 -0
  120. package/dist/test/unit/library/realtime.test.js.map +1 -1
  121. package/dist/test/unit/library/search-facets.test.js +2 -2
  122. package/dist/test/unit/library/search-facets.test.js.map +1 -1
  123. package/dist/test/unit/pages/toolbar.test.js +24 -7
  124. package/dist/test/unit/pages/toolbar.test.js.map +1 -1
  125. package/dist/test/unit/routes/dto.test.js +7 -6
  126. package/dist/test/unit/routes/dto.test.js.map +1 -1
  127. package/dist/test/unit/routes/file-page.test.js +5 -7
  128. package/dist/test/unit/routes/file-page.test.js.map +1 -1
  129. package/dist/test/unit/routes/preset-row.test.js +2 -1
  130. package/dist/test/unit/routes/preset-row.test.js.map +1 -1
  131. package/dist/transform.js +6 -6
  132. package/dist/transform.js.map +1 -1
  133. package/dist/upload-checks.d.ts +8 -2
  134. package/dist/upload-checks.js.map +1 -1
  135. package/dist/upload-policy.js +8 -8
  136. package/dist/upload-policy.js.map +1 -1
  137. package/dist/validation/declared.schema.d.ts +7 -36
  138. package/dist/validation/declared.schema.js +15 -20
  139. package/dist/validation/declared.schema.js.map +1 -1
  140. package/dist/validation/media.schema.d.ts +1 -1
  141. package/dist/validation/media.schema.js +2 -2
  142. package/dist/validation/media.schema.js.map +1 -1
  143. package/frontend-vue/app/build/imageEditor/editorShapes.ts +118 -0
  144. package/frontend-vue/app/build/imageEditor/useEditorSaving.ts +86 -0
  145. package/frontend-vue/app/build/library/libraryActions.ts +444 -0
  146. package/frontend-vue/app/build/library/libraryCore.ts +136 -0
  147. package/frontend-vue/app/components/ImageEditor.vue +22 -179
  148. package/frontend-vue/app/composables/library/useMediaLibrary.ts +3 -575
  149. package/frontend-vue/app/composables/useMediaApi.ts +21 -5
  150. package/frontend-vue/build/backend-boundary.ts +122 -0
  151. package/frontend-vue/dms.frontend.build.ts +3 -0
  152. package/frontend-vue/eslint.config.mjs +13 -0
  153. package/frontend-vue/package.json +3 -1
  154. package/frontend-vue/pnpm-lock.yaml +217 -61
  155. package/frontend-vue/tests/backend-boundary.test.ts +203 -0
  156. package/frontend-vue/tests/mediaPreviews.test.ts +39 -0
  157. package/package.json +10 -16
  158. package/skills/dms-media/SKILL.md +12 -24
  159. package/skills/dms-media/cases.json +38 -0
  160. package/src/acl/entries.ts +6 -4
  161. package/src/bindings.ts +3 -3
  162. package/src/db/models/mediaFolders.model.ts +0 -44
  163. package/src/db/tables/mediaDeclarations.table.ts +3 -19
  164. package/src/declared/assets.ts +19 -210
  165. package/src/declared/folders.ts +25 -138
  166. package/src/declared/index.ts +0 -2
  167. package/src/declared/records.ts +17 -90
  168. package/src/derivatives.ts +17 -23
  169. package/src/guards.ts +19 -0
  170. package/src/implementations/interface-dms-media/index.ts +1 -8
  171. package/src/library/activity.ts +17 -9
  172. package/src/library/batches.ts +12 -9
  173. package/src/library/events.ts +7 -4
  174. package/src/library/module-readout.ts +6 -2
  175. package/src/library/realtime.ts +5 -1
  176. package/src/library/zip.ts +1 -1
  177. package/src/pages/activity.ts +6 -2
  178. package/src/routes/media/assets.ts +4 -3
  179. package/src/routes/media/bulk.ts +16 -14
  180. package/src/routes/media/delivery-headers.ts +9 -12
  181. package/src/routes/media/delivery-stream.ts +13 -28
  182. package/src/routes/media/delivery.ts +4 -2
  183. package/src/routes/media/manage.ts +4 -6
  184. package/src/routes/media/transform.ts +27 -23
  185. package/src/routes/media/upload.ts +4 -6
  186. package/src/test/antelope.test.ts +25 -21
  187. package/src/test/helpers/folders.ts +22 -0
  188. package/src/test/helpers/pages.ts +12 -5
  189. package/src/test/helpers/permissions-world.ts +326 -0
  190. package/src/test/helpers/prototype.ts +12 -0
  191. package/src/test/integration/derivative-sweep-query.test.ts +19 -21
  192. package/src/test/integration/folder-query.test.ts +11 -11
  193. package/src/test/integration/media-bindings.test.ts +7 -7
  194. package/src/test/integration/media-cleanup.test.ts +25 -37
  195. package/src/test/integration/media-declared-content.test.ts +35 -379
  196. package/src/test/integration/media-delivery-editing.test.ts +11 -7
  197. package/src/test/integration/media-delivery.test.ts +29 -8
  198. package/src/test/integration/media-explorer-writes.test.ts +2 -7
  199. package/src/test/integration/media-guards.test.ts +21 -7
  200. package/src/test/integration/media-library.test.ts +1 -1
  201. package/src/test/integration/media-linked-subfolders.test.ts +12 -21
  202. package/src/test/integration/media-member-access.test.ts +5 -9
  203. package/src/test/integration/media-permissions.test.ts +56 -570
  204. package/src/test/integration/media-project-field.test.ts +5 -7
  205. package/src/test/integration/media-search-query.test.ts +16 -20
  206. package/src/test/integration/media-storage-origin-unreachable.test.ts +111 -0
  207. package/src/test/integration/media-upload-policy.test.ts +2 -8
  208. package/src/test/integration/permissions-management.ts +292 -0
  209. package/src/test/unit/acl/entries.test.ts +2 -1
  210. package/src/test/unit/acl/resolver.test.ts +19 -7
  211. package/src/test/unit/declared.test.ts +0 -87
  212. package/src/test/unit/library/fixtures.ts +9 -3
  213. package/src/test/unit/library/library.test.ts +1 -7
  214. package/src/test/unit/library/realtime.test.ts +2 -0
  215. package/src/test/unit/library/search-facets.test.ts +2 -2
  216. package/src/test/unit/pages/toolbar.test.ts +42 -17
  217. package/src/test/unit/routes/dto.test.ts +7 -6
  218. package/src/test/unit/routes/file-page.test.ts +10 -9
  219. package/src/test/unit/routes/preset-row.test.ts +2 -2
  220. package/src/transform.ts +6 -6
  221. package/src/upload-checks.ts +12 -3
  222. package/src/upload-policy.ts +8 -8
  223. package/src/validation/declared.schema.ts +17 -25
  224. package/src/validation/media.schema.ts +6 -6
  225. package/dist/declared/readiness.d.ts +0 -2
  226. package/dist/declared/readiness.js +0 -52
  227. package/dist/declared/readiness.js.map +0 -1
  228. package/dist/declared/retire.d.ts +0 -3
  229. package/dist/declared/retire.js +0 -118
  230. package/dist/declared/retire.js.map +0 -1
  231. package/dist/test/integration/media-declared-retire.test.js +0 -186
  232. package/dist/test/integration/media-declared-retire.test.js.map +0 -1
  233. package/frontend-vue/tests/engines.test.ts +0 -20
  234. package/frontend-vue/tests/locales.test.ts +0 -61
  235. package/src/declared/readiness.ts +0 -64
  236. package/src/declared/retire.ts +0 -206
  237. package/src/test/integration/media-declared-retire.test.ts +0 -257
  238. /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
@@ -13,8 +13,7 @@ import {
13
13
  RegisterAssetBinding,
14
14
  } from "@antelopejs/interface-dms-media";
15
15
  import type { AxiosInstance } from "axios";
16
- import { expect } from "chai";
17
- import sharp from "sharp";
16
+ import { assert, expect } from "chai";
18
17
  import {
19
18
  MediaAssetModel,
20
19
  MediaDeclarationModel,
@@ -49,24 +48,12 @@ async function rejectionOf(promise: Promise<unknown>): Promise<Error> {
49
48
  try {
50
49
  await promise;
51
50
  } catch (error) {
52
- return error as Error;
51
+ assert.instanceOf(error, Error);
52
+ return error;
53
53
  }
54
54
  throw new Error("Expected the declaration to be refused");
55
55
  }
56
56
 
57
- function squarePng(size: number): Promise<Buffer> {
58
- return sharp({
59
- create: {
60
- width: size,
61
- height: size,
62
- channels: 3,
63
- background: { r: 240, g: 160, b: 0 },
64
- },
65
- })
66
- .png()
67
- .toBuffer();
68
- }
69
-
70
57
  describe("[integration] media declared content — folders and files shipped as code", () => {
71
58
  let client: AxiosInstance;
72
59
  let tempDir: string;
@@ -107,12 +94,11 @@ describe("[integration] media declared content — folders and files shipped as
107
94
  mimetype: PNG_MIMETYPE,
108
95
  source: { bytes: ONE_PIXEL_PNG },
109
96
  };
110
- // These calls also fail compilation if the public contract becomes optional.
111
- // @ts-expect-error A JavaScript caller can omit the required tenantId.
97
+ // @ts-expect-error A JavaScript caller can omit the required tenantId; this call stops compiling if the public contract makes it optional.
112
98
  expect((await rejectionOf(EnsureMediaFolder(folder))).message).to.contain(
113
99
  "tenantId",
114
100
  );
115
- // @ts-expect-error A JavaScript caller can omit the required tenantId.
101
+ // @ts-expect-error A JavaScript caller can omit the required tenantId; this call stops compiling if the public contract makes it optional.
116
102
  expect((await rejectionOf(ImportMediaAsset(file))).message).to.contain(
117
103
  "tenantId",
118
104
  );
@@ -124,7 +110,6 @@ describe("[integration] media declared content — folders and files shipped as
124
110
  (await rejectionOf(ImportMediaAsset({ ...file, tenantId }))).message,
125
111
  ).to.contain("tenantId");
126
112
  }
127
- // Validation also precedes source reads, not only the final database write.
128
113
  expect(
129
114
  (
130
115
  await rejectionOf(
@@ -135,6 +120,7 @@ describe("[integration] media declared content — folders and files shipped as
135
120
  }),
136
121
  )
137
122
  ).message,
123
+ "validation precedes source reads, not only the final database write",
138
124
  ).to.contain("tenantId");
139
125
  expect({
140
126
  folders: await folders().getAll(),
@@ -144,11 +130,10 @@ describe("[integration] media declared content — folders and files shipped as
144
130
  }).to.deep.equal(before);
145
131
  });
146
132
 
147
- it("isolates the same declaration keys and updates in two tenant instances", async () => {
133
+ it("isolates the same declaration keys in two tenant instances", async () => {
148
134
  const tenantId = "declared-isolation";
149
135
  const schema = Schema.get(TENANT_SCHEMA_NAME);
150
136
  if (!schema) throw new Error("Tenant schema is missing");
151
- // Disposable database fixture, not a change to workspace provisioning.
152
137
  await schema.createInstance(tenantId).run();
153
138
  try {
154
139
  const folder = {
@@ -170,30 +155,12 @@ describe("[integration] media declared content — folders and files shipped as
170
155
  const firstFile = await ImportMediaAsset(file);
171
156
  const secondFile = await ImportMediaAsset({ ...file, tenantId });
172
157
  expect(firstFile.id).to.not.equal(secondFile.id);
158
+ expect((await EnsureMediaFolder(folder)).status).to.equal("kept");
159
+ expect((await ImportMediaAsset(file)).status).to.equal("kept");
173
160
  expect(
174
- (
175
- await EnsureMediaFolder({
176
- ...folder,
177
- tenantId,
178
- name: "Other tenant folder",
179
- })
180
- ).status,
181
- ).to.equal("updated");
182
- expect(
183
- (
184
- await ImportMediaAsset({
185
- ...file,
186
- tenantId,
187
- source: { bytes: Buffer.from("Other tenant content") },
188
- })
189
- ).status,
190
- ).to.equal("updated");
191
- expect((await EnsureMediaFolder(folder)).status).to.equal("unchanged");
192
- expect((await ImportMediaAsset(file)).status).to.equal("unchanged");
193
- expect(
194
- await GetModel(MediaAssetModel, tenantId).get(firstFile.id as string),
161
+ await GetModel(MediaAssetModel, tenantId).get(firstFile.id),
195
162
  ).to.equal(undefined);
196
- expect(await assets().get(secondFile.id as string)).to.equal(undefined);
163
+ expect(await assets().get(secondFile.id)).to.equal(undefined);
197
164
  } finally {
198
165
  await schema.destroyInstance(tenantId).run();
199
166
  }
@@ -235,89 +202,6 @@ describe("[integration] media declared content — folders and files shipped as
235
202
  }
236
203
  });
237
204
 
238
- it("rejects moving a declared ancestor under its descendant", async () => {
239
- const root = {
240
- tenantId: DEFAULT_TENANT_ID,
241
- key: "declared.cycle-root",
242
- name: "Cycle root",
243
- };
244
- const parent = await EnsureMediaFolder(root);
245
- const child = await EnsureMediaFolder({
246
- tenantId: DEFAULT_TENANT_ID,
247
- key: "declared.cycle-child",
248
- name: "Cycle child",
249
- parent: root.key,
250
- });
251
- const error = await rejectionOf(
252
- EnsureMediaFolder({ ...root, parent: "declared.cycle-child" }),
253
- );
254
- expect(error.message).to.contain("inside itself");
255
- expect((await folders().get(parent.id as string))?.path).to.deep.equal(
256
- [],
257
- );
258
- expect((await folders().get(child.id as string))?.path).to.deep.equal([
259
- parent.id,
260
- ]);
261
- const destination = await EnsureMediaFolder({
262
- tenantId: DEFAULT_TENANT_ID,
263
- key: "declared.move-target",
264
- name: "Move target",
265
- });
266
- expect(
267
- (await EnsureMediaFolder({ ...root, parent: "declared.move-target" }))
268
- .status,
269
- ).to.equal("updated");
270
- expect((await folders().get(child.id as string))?.path).to.deep.equal([
271
- destination.id,
272
- parent.id,
273
- ]);
274
- expect((await EnsureMediaFolder(root)).status).to.equal("updated");
275
- expect(
276
- (await folders().get(parent.id as string))?.parentId ?? undefined,
277
- ).to.equal(undefined);
278
- expect((await folders().get(child.id as string))?.path).to.deep.equal([
279
- parent.id,
280
- ]);
281
- });
282
-
283
- it("preserves a member rename racing a folder refresh", async () => {
284
- const declaration = {
285
- tenantId: DEFAULT_TENANT_ID,
286
- key: "declared.folder-race",
287
- name: "Folder before race",
288
- };
289
- const first = await EnsureMediaFolder(declaration);
290
- // oxlint-disable-next-line typescript/unbound-method -- Rebound with call(this) below and restored in finally.
291
- const original = MediaFolderModel.prototype.get;
292
- let renamed = false;
293
- MediaFolderModel.prototype.get = async function (id) {
294
- const snapshot = await original.call(this, id);
295
- if (id === first.id && !renamed) {
296
- renamed = true;
297
- await client.post(`/api/media/folders/${id}/rename`, {
298
- name: "Member folder name",
299
- });
300
- }
301
- return snapshot;
302
- };
303
- try {
304
- const result = await EnsureMediaFolder({
305
- ...declaration,
306
- name: "Code folder name",
307
- visibility: "public",
308
- });
309
- expect(result).to.deep.equal({ status: "preserved", id: first.id });
310
- const folder = await folders().get(first.id as string);
311
- expect(folder?.name).to.equal("Member folder name");
312
- expect(folder?.visibility).to.equal("private");
313
- expect((await EnsureMediaFolder(declaration)).status).to.equal(
314
- "preserved",
315
- );
316
- } finally {
317
- MediaFolderModel.prototype.get = original;
318
- }
319
- });
320
-
321
205
  it("creates a folder once, however often it is declared", async () => {
322
206
  const declaration = {
323
207
  tenantId: DEFAULT_TENANT_ID,
@@ -327,8 +211,8 @@ describe("[integration] media declared content — folders and files shipped as
327
211
  const first = await EnsureMediaFolder(declaration);
328
212
  const second = await EnsureMediaFolder(declaration);
329
213
  expect(first.status).to.equal("created");
330
- expect(second).to.deep.equal({ status: "unchanged", id: first.id });
331
- const folder = await folders().get(first.id as string);
214
+ expect(second).to.deep.equal({ status: "kept", id: first.id });
215
+ const folder = await folders().get(first.id);
332
216
  expect(folder?.name).to.equal("Declared procedures");
333
217
  expect(folder?.parentId ?? undefined).to.equal(undefined);
334
218
  expect(folder?.visibility).to.equal("private");
@@ -337,7 +221,7 @@ describe("[integration] media declared content — folders and files shipped as
337
221
  "folder.create",
338
222
  );
339
223
  const created = events.filter((event) =>
340
- event.json_details?.includes(first.id as string),
224
+ event.json_details?.includes(first.id),
341
225
  );
342
226
  expect(created).to.have.length(1);
343
227
  expect(created[0]?.actorName).to.equal("System");
@@ -358,11 +242,11 @@ describe("[integration] media declared content — folders and files shipped as
358
242
  acl: ACL,
359
243
  });
360
244
  expect(child.status).to.equal("created");
361
- const folder = await folders().get(child.id as string);
245
+ const folder = await folders().get(child.id);
362
246
  expect(folder?.parentId).to.equal(parent.id);
363
247
  expect(folder?.path).to.deep.equal([parent.id]);
364
248
  expect(folder?.visibility).to.equal("public");
365
- expect(await readFolderAcl(child.id as string)).to.deep.equal(ACL);
249
+ expect(await readFolderAcl(child.id)).to.deep.equal(ACL);
366
250
  const tree = await client.get("/api/media/tree");
367
251
  expect(tree.status).to.equal(HTTP_OK);
368
252
  expect(
@@ -372,21 +256,7 @@ describe("[integration] media declared content — folders and files shipped as
372
256
  ).to.have.length(1);
373
257
  });
374
258
 
375
- it("refreshes a folder still as declared", async () => {
376
- const result = await EnsureMediaFolder({
377
- tenantId: DEFAULT_TENANT_ID,
378
- key: CHILD_KEY,
379
- name: "Safety rules",
380
- parent: ROOT_KEY,
381
- });
382
- expect(result.status).to.equal("updated");
383
- const folder = await folders().get(result.id as string);
384
- expect(folder?.name).to.equal("Safety rules");
385
- expect(folder?.visibility).to.equal("private");
386
- expect(await readFolderAcl(result.id as string)).to.equal(undefined);
387
- });
388
-
389
- it("leaves a folder a member renamed as they made it", async () => {
259
+ it("never changes a folder declared before, even renamed by a member", async () => {
390
260
  const declared = await EnsureMediaFolder({
391
261
  tenantId: DEFAULT_TENANT_ID,
392
262
  key: "declared.renamed",
@@ -402,31 +272,11 @@ describe("[integration] media declared content — folders and files shipped as
402
272
  key: "declared.renamed",
403
273
  name: "Declared templates v2",
404
274
  });
405
- expect(result).to.deep.equal({ status: "preserved", id: declared.id });
406
- const folder = await folders().get(declared.id as string);
275
+ expect(result).to.deep.equal({ status: "kept", id: declared.id });
276
+ const folder = await folders().get(declared.id);
407
277
  expect(folder?.name).to.equal("Our templates");
408
278
  });
409
279
 
410
- it("does not bring back a folder a member deleted", async () => {
411
- const declared = await EnsureMediaFolder({
412
- tenantId: DEFAULT_TENANT_ID,
413
- key: "declared.deleted",
414
- name: "Declared archive",
415
- });
416
- const removal = await client.delete(`/api/media/folders/${declared.id}`);
417
- expect(removal.status).to.equal(HTTP_OK);
418
- const result = await EnsureMediaFolder({
419
- tenantId: DEFAULT_TENANT_ID,
420
- key: "declared.deleted",
421
- name: "Declared archive",
422
- });
423
- expect(result).to.deep.equal({ status: "deleted" });
424
- const all = await folders().getAll();
425
- expect(all.some((folder) => folder.name === "Declared archive")).to.equal(
426
- false,
427
- );
428
- });
429
-
430
280
  it("refuses an invalid name, an unknown parent and a taken name", async () => {
431
281
  const badName = await rejectionOf(
432
282
  EnsureMediaFolder({
@@ -457,52 +307,6 @@ describe("[integration] media declared content — folders and files shipped as
457
307
  });
458
308
 
459
309
  describe("files", () => {
460
- for (const replaceBytes of [false, true]) {
461
- it(`preserves a member rename racing an asset ${replaceBytes ? "content" : "metadata"} refresh`, async () => {
462
- const declaration = {
463
- tenantId: DEFAULT_TENANT_ID,
464
- key: `declared.asset-race.${replaceBytes}`,
465
- folder: { key: ROOT_KEY },
466
- name: `race-${replaceBytes}.txt`,
467
- mimetype: "text/plain",
468
- source: { bytes: Buffer.from("Original content") },
469
- };
470
- const first = await ImportMediaAsset(declaration);
471
- const before = await assets().get(first.id as string);
472
- // oxlint-disable-next-line typescript/unbound-method -- Rebound with call(this) below and restored in finally.
473
- const original = MediaAssetModel.prototype.get;
474
- let reads = 0;
475
- MediaAssetModel.prototype.get = async function (id) {
476
- const snapshot = await original.call(this, id);
477
- // Race the last snapshot used to publish, not just the initial verdict.
478
- if (id === first.id && ++reads === 2) {
479
- await client.post(`/api/media/assets/${id}/update`, {
480
- name: `member-${replaceBytes}.txt`,
481
- });
482
- }
483
- return snapshot;
484
- };
485
- try {
486
- const result = await ImportMediaAsset({
487
- ...declaration,
488
- name: `code-${replaceBytes}.txt`,
489
- source: replaceBytes
490
- ? { bytes: Buffer.from("Replacement content") }
491
- : declaration.source,
492
- });
493
- expect(result).to.deep.equal({ status: "preserved", id: first.id });
494
- const after = await assets().get(first.id as string);
495
- expect(after?.name).to.equal(`member-${replaceBytes}.txt`);
496
- expect(after?.storageKey).to.equal(before?.storageKey);
497
- expect((await ImportMediaAsset(declaration)).status).to.equal(
498
- "preserved",
499
- );
500
- } finally {
501
- MediaAssetModel.prototype.get = original;
502
- }
503
- });
504
- }
505
-
506
310
  it("imports bytes once, with their dimensions and an upload event", async () => {
507
311
  const declaration = {
508
312
  tenantId: DEFAULT_TENANT_ID,
@@ -516,8 +320,8 @@ describe("[integration] media declared content — folders and files shipped as
516
320
  const first = await ImportMediaAsset(declaration);
517
321
  const second = await ImportMediaAsset(declaration);
518
322
  expect(first.status).to.equal("created");
519
- expect(second).to.deep.equal({ status: "unchanged", id: first.id });
520
- const asset = await assets().get(first.id as string);
323
+ expect(second).to.deep.equal({ status: "kept", id: first.id });
324
+ const asset = await assets().get(first.id);
521
325
  expect(asset?.name).to.equal("logo.png");
522
326
  expect(asset?.alt).to.equal("Helio logo");
523
327
  expect(asset?.width).to.equal(1);
@@ -526,7 +330,7 @@ describe("[integration] media declared content — folders and files shipped as
526
330
  const events = await GetModel(
527
331
  MediaEventModel,
528
332
  DEFAULT_TENANT_ID,
529
- ).listByAsset(first.id as string);
333
+ ).listByAsset(first.id);
530
334
  expect(events.map((event) => event.kind)).to.deep.equal(["asset.upload"]);
531
335
  const readUrl = await client.get(
532
336
  `/api/media/assets/${first.id}/read-url`,
@@ -550,7 +354,7 @@ describe("[integration] media declared content — folders and files shipped as
550
354
  source: { filePath },
551
355
  });
552
356
  expect(result.status).to.equal("created");
553
- const asset = await assets().get(result.id as string);
357
+ const asset = await assets().get(result.id);
554
358
  expect(asset?.mimetype).to.equal("text/plain");
555
359
  expect(asset?.width ?? undefined).to.equal(undefined);
556
360
  });
@@ -565,7 +369,7 @@ describe("[integration] media declared content — folders and files shipped as
565
369
  source: { bytes: ONE_PIXEL_PNG },
566
370
  });
567
371
  expect(result.status).to.equal("created");
568
- const asset = await assets().get(result.id as string);
372
+ const asset = await assets().get(result.id);
569
373
  const bound = await folders().getByBinding(BINDING_ID);
570
374
  expect(asset?.folderId).to.equal(bound?._id);
571
375
  const refused = await rejectionOf(
@@ -581,145 +385,6 @@ describe("[integration] media declared content — folders and files shipped as
581
385
  expect(refused.message).to.contain("only accepts image/*");
582
386
  });
583
387
 
584
- it("refreshes the content of a file still as declared", async () => {
585
- const declaration = {
586
- tenantId: DEFAULT_TENANT_ID,
587
- key: "declared.banner",
588
- folder: { key: ROOT_KEY },
589
- name: "banner.png",
590
- mimetype: PNG_MIMETYPE,
591
- };
592
- const first = await ImportMediaAsset({
593
- ...declaration,
594
- source: { bytes: await squarePng(2) },
595
- });
596
- const before = await assets().get(first.id as string);
597
- const second = await ImportMediaAsset({
598
- ...declaration,
599
- source: { bytes: await squarePng(3) },
600
- });
601
- expect(second).to.deep.equal({ status: "updated", id: first.id });
602
- const after = await assets().get(first.id as string);
603
- expect(after?.width).to.equal(3);
604
- expect(after?.storageKey).to.not.equal(before?.storageKey);
605
- const third = await ImportMediaAsset({
606
- ...declaration,
607
- source: { bytes: await squarePng(3) },
608
- });
609
- expect(third.status).to.equal("unchanged");
610
- });
611
-
612
- it("does not read the source while the caller's version is unchanged", async () => {
613
- let loads = 0;
614
- const load = (text: string) => () => {
615
- loads++;
616
- return Buffer.from(text);
617
- };
618
- const declaration = {
619
- tenantId: DEFAULT_TENANT_ID,
620
- key: "declared.generated",
621
- folder: { key: ROOT_KEY },
622
- name: "generated.txt",
623
- mimetype: "text/plain",
624
- };
625
- const first = await ImportMediaAsset({
626
- ...declaration,
627
- version: "v1",
628
- source: { load: load("Generated v1") },
629
- });
630
- expect(first.status).to.equal("created");
631
- expect(loads).to.equal(1);
632
- // Same version: neither the loader nor a file path that does not exist is read.
633
- expect(
634
- await ImportMediaAsset({
635
- ...declaration,
636
- version: "v1",
637
- source: { load: load("never read") },
638
- }),
639
- ).to.deep.equal({ status: "unchanged", id: first.id });
640
- expect(
641
- (
642
- await ImportMediaAsset({
643
- ...declaration,
644
- version: "v1",
645
- source: { filePath: join(tempDir, "never-written.txt") },
646
- })
647
- ).status,
648
- ).to.equal("unchanged");
649
- expect(loads).to.equal(1);
650
- // New metadata under the same version refreshes without reading the bytes.
651
- const renamed = await ImportMediaAsset({
652
- ...declaration,
653
- version: "v1",
654
- name: "generated-renamed.txt",
655
- source: { load: load("never read") },
656
- });
657
- expect(renamed).to.deep.equal({ status: "updated", id: first.id });
658
- expect(loads).to.equal(1);
659
- const updated = await ImportMediaAsset({
660
- ...declaration,
661
- version: "v2",
662
- name: "generated-renamed.txt",
663
- source: { load: load("Generated v2") },
664
- });
665
- expect(updated).to.deep.equal({ status: "updated", id: first.id });
666
- expect(loads).to.equal(2);
667
- const asset = await assets().get(first.id as string);
668
- expect(asset?.size).to.equal("Generated v2".length);
669
- });
670
-
671
- it("reads a new version once, and not again when its bytes did not change", async () => {
672
- let loads = 0;
673
- const declaration = {
674
- tenantId: DEFAULT_TENANT_ID,
675
- key: "declared.rebuilt",
676
- folder: { key: ROOT_KEY },
677
- name: "rebuilt.txt",
678
- mimetype: "text/plain",
679
- source: {
680
- load: async () => {
681
- loads++;
682
- return Buffer.from("Same bytes");
683
- },
684
- },
685
- };
686
- const first = await ImportMediaAsset({ ...declaration, version: "a" });
687
- const rebuilt = await ImportMediaAsset({ ...declaration, version: "b" });
688
- expect(rebuilt).to.deep.equal({ status: "unchanged", id: first.id });
689
- expect(loads).to.equal(2);
690
- expect(
691
- (await ImportMediaAsset({ ...declaration, version: "b" })).status,
692
- ).to.equal("unchanged");
693
- expect(loads).to.equal(2);
694
- });
695
-
696
- it("does not read the source of a file a member changed or deleted", async () => {
697
- let loads = 0;
698
- const declaration = {
699
- tenantId: DEFAULT_TENANT_ID,
700
- key: "declared.untouchable",
701
- folder: { key: ROOT_KEY },
702
- name: "untouchable.txt",
703
- mimetype: "text/plain",
704
- source: {
705
- load: () => {
706
- loads++;
707
- return Buffer.from(`Untouchable ${loads}`);
708
- },
709
- },
710
- };
711
- const first = await ImportMediaAsset(declaration);
712
- await client.post(`/api/media/assets/${first.id}/update`, {
713
- name: "member-owned.txt",
714
- });
715
- expect((await ImportMediaAsset(declaration)).status).to.equal(
716
- "preserved",
717
- );
718
- await client.delete(`/api/media/assets/${first.id}`);
719
- expect((await ImportMediaAsset(declaration)).status).to.equal("deleted");
720
- expect(loads).to.equal(1);
721
- });
722
-
723
388
  it("names the key when a lazy source fails or returns no bytes", async () => {
724
389
  const declaration = {
725
390
  tenantId: DEFAULT_TENANT_ID,
@@ -754,7 +419,7 @@ describe("[integration] media declared content — folders and files shipped as
754
419
  expect(wrong.message).to.contain("must return a Uint8Array");
755
420
  });
756
421
 
757
- it("leaves a file a member renamed as they made it", async () => {
422
+ it("never changes a file declared before, nor reads its source again", async () => {
758
423
  const declaration = {
759
424
  tenantId: DEFAULT_TENANT_ID,
760
425
  key: "declared.manual",
@@ -768,32 +433,23 @@ describe("[integration] media declared content — folders and files shipped as
768
433
  name: "our-manual.txt",
769
434
  });
770
435
  expect(rename.status).to.equal(HTTP_OK);
436
+ let loads = 0;
771
437
  const result = await ImportMediaAsset({
772
438
  ...declaration,
773
- source: { bytes: Buffer.from("Manual v2") },
439
+ source: {
440
+ load: () => {
441
+ loads++;
442
+ return Buffer.from("Manual v2");
443
+ },
444
+ },
774
445
  });
775
- expect(result).to.deep.equal({ status: "preserved", id: first.id });
776
- const asset = await assets().get(first.id as string);
446
+ expect(result).to.deep.equal({ status: "kept", id: first.id });
447
+ expect(loads, "the source of a kept file is not read").to.equal(0);
448
+ const asset = await assets().get(first.id);
777
449
  expect(asset?.name).to.equal("our-manual.txt");
778
450
  expect(asset?.size).to.equal("Manual v1".length);
779
451
  });
780
452
 
781
- it("does not bring back a file a member deleted", async () => {
782
- const declaration = {
783
- tenantId: DEFAULT_TENANT_ID,
784
- key: "declared.flyer",
785
- folder: { key: ROOT_KEY },
786
- name: "flyer.txt",
787
- mimetype: "text/plain",
788
- source: { bytes: Buffer.from("Flyer") },
789
- };
790
- const first = await ImportMediaAsset(declaration);
791
- const removal = await client.delete(`/api/media/assets/${first.id}`);
792
- expect(removal.status).to.equal(HTTP_OK);
793
- const result = await ImportMediaAsset(declaration);
794
- expect(result).to.deep.equal({ status: "deleted" });
795
- });
796
-
797
453
  it("refuses an unknown folder, a refused type and an unreadable image", async () => {
798
454
  const unknown = await rejectionOf(
799
455
  ImportMediaAsset({
@@ -1,6 +1,6 @@
1
1
  import { randomUUID } from "node:crypto";
2
2
  import type { AxiosInstance } from "axios";
3
- import { expect } from "chai";
3
+ import { assert, expect } from "chai";
4
4
  import { GetModel } from "@antelopejs/interface-database-decorators";
5
5
  import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
6
6
  import sharp from "sharp";
@@ -61,7 +61,9 @@ async function follow(
61
61
  ): Promise<Delivery> {
62
62
  const redirect = await deliver(path, headers);
63
63
  expect(redirect.status, path).to.equal(HTTP_FOUND);
64
- const response = await fetch(redirect.headers.get("location") as string);
64
+ const location = redirect.headers.get("location");
65
+ assert.isNotNull(location, path);
66
+ const response = await fetch(location);
65
67
  return {
66
68
  status: response.status,
67
69
  headers: response.headers,
@@ -301,9 +303,11 @@ describe("[integration] media delivery and editing — cache, orientation, activ
301
303
  const original = await deliver(assetPath(svg), auth);
302
304
  expect(original.status).to.equal(HTTP_OK);
303
305
  expect(original.headers.get("content-security-policy")).to.equal("sandbox");
306
+ const etag = original.headers.get("etag");
307
+ assert.isNotNull(etag, "etag");
304
308
  const revalidated = await deliver(assetPath(svg), {
305
309
  ...auth,
306
- "If-None-Match": original.headers.get("etag") as string,
310
+ "If-None-Match": etag,
307
311
  });
308
312
  expect(revalidated.status).to.equal(HTTP_NOT_MODIFIED);
309
313
  });
@@ -323,7 +327,7 @@ describe("[integration] media delivery and editing — cache, orientation, activ
323
327
  "image/png",
324
328
  await sharp({
325
329
  create: {
326
- // Larger than the thumb both ways, so its square crop shows.
330
+ /** Larger than the thumb both ways, so its square crop shows. */
327
331
  width: WIDE_SVG_WIDTH * 2,
328
332
  height: WIDE_SVG_HEIGHT * 2,
329
333
  channels: 3,
@@ -333,9 +337,9 @@ describe("[integration] media delivery and editing — cache, orientation, activ
333
337
  .png()
334
338
  .toBuffer(),
335
339
  );
336
- const answer = await client.post("/api/media/previews", {
337
- ids: [logo.id, banner.id],
338
- });
340
+ const answer = await client.get(
341
+ `/api/media/previews?ids=${logo.id}&ids=${banner.id}`,
342
+ );
339
343
  expect(answer.status).to.equal(HTTP_OK);
340
344
  const [vector, raster] = await Promise.all(
341
345
  [logo.id, banner.id].map(async (id) => {