@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
@@ -4,47 +4,24 @@ import type {
4
4
  } from "@antelopejs/interface-dms-media";
5
5
  import { serializeAcl } from "../acl";
6
6
  import { bindingHoldsSubfolders, ensureTenantBindings } from "../bindings";
7
- import type { MediaDeclaration, MediaFolder } from "../db";
7
+ import type { MediaFolder } from "../db";
8
8
  import { recordMediaEvent } from "../library/events";
9
- import {
10
- buildChildPath,
11
- hasSiblingNamed,
12
- isMoveInsideSubtree,
13
- rewriteDescendantPaths,
14
- } from "../routes/media/folders";
9
+ import { buildChildPath, hasSiblingNamed } from "../routes/media/folders";
15
10
  import {
16
11
  declaredFolderSchema,
17
12
  type DeclaredFolderInput,
18
13
  } from "../validation/declared.schema";
19
- import { waitForTenant } from "./readiness";
20
14
  import {
21
15
  DECLARED_CONTENT_AUTHOR,
22
16
  type DeclaredModels,
23
17
  declaredModels,
24
- hashState,
25
- judgeDeclaredRow,
26
18
  MediaDeclarationError,
27
19
  parseDeclaration,
28
- saveDeclaration,
20
+ rememberDeclaration,
29
21
  settlePendingDeclaration,
30
22
  withDeclarationLock,
31
23
  } from "./records";
32
24
 
33
- /** A declared folder looked up by key: absent when a member deleted it. */
34
- export interface DeclaredFolderLookup {
35
- folder?: MediaFolder;
36
- }
37
-
38
- /** The member-editable state of a folder: its name, place, visibility and ACL. */
39
- export function folderStateHash(folder: MediaFolder): string {
40
- return hashState({
41
- name: folder.name,
42
- parentId: folder.parentId || null,
43
- visibility: folder.visibility,
44
- acl: folder.json_acl || null,
45
- });
46
- }
47
-
48
25
  type ParentTarget = NonNullable<DeclaredFolderInput["parent"]>;
49
26
 
50
27
  /** The declared folder key a parent names, written as a string or as `{ key }`. */
@@ -53,33 +30,24 @@ function parentKeyOf(parent: ParentTarget | undefined): string | undefined {
53
30
  return parent && "key" in parent ? parent.key : undefined;
54
31
  }
55
32
 
56
- function folderDeclarationHash(declaration: DeclaredFolderInput): string {
57
- const { parent } = declaration;
58
- return hashState({
59
- name: declaration.name,
60
- // Both spellings of a declared parent hash alike: switching between them changes nothing.
61
- parent: parentKeyOf(parent) ?? parent ?? null,
62
- visibility: declaration.visibility,
63
- acl: declaration.acl ?? null,
64
- });
65
- }
66
-
67
33
  /**
68
- * The folder declared under `key`. Throws when no module ever declared it,
69
- * since that is a mistake in the calling code rather than a member's change.
34
+ * The folder declared under `key`. Throws when no module declared it, since
35
+ * that is a mistake in the calling code, or when it was deleted since.
70
36
  */
71
37
  export async function findDeclaredFolder(
72
38
  models: DeclaredModels,
73
39
  key: string,
74
- onUnknown: (reason: string) => never,
75
- ): Promise<DeclaredFolderLookup> {
40
+ fail: (reason: string) => never,
41
+ ): Promise<MediaFolder> {
76
42
  await settlePendingDeclaration(models.tenantId, "folder", key);
77
43
  const record = await models.declarationModel.findByKey("folder", key);
78
44
  if (!record)
79
- onUnknown(
45
+ fail(
80
46
  `'${key}' is not a declared folder: declare it with EnsureMediaFolder first`,
81
47
  );
82
- return { folder: await models.folderModel.get(record.targetId) };
48
+ const folder = await models.folderModel.get(record.targetId);
49
+ if (!folder) fail(`the folder declared as '${key}' was deleted`);
50
+ return folder;
83
51
  }
84
52
 
85
53
  /** The folder bound to an asset field, provisioned like the dashboard does. */
@@ -101,7 +69,7 @@ async function findParentFolder(
101
69
  models: DeclaredModels,
102
70
  parent: ParentTarget,
103
71
  fail: (reason: string) => never,
104
- ): Promise<DeclaredFolderLookup> {
72
+ ): Promise<MediaFolder> {
105
73
  if (typeof parent === "string")
106
74
  return findDeclaredFolder(models, parent, fail);
107
75
  if ("key" in parent) return findDeclaredFolder(models, parent.key, fail);
@@ -111,7 +79,7 @@ async function findParentFolder(
111
79
  fail(
112
80
  `the folder linked to '${binding}' cannot hold subfolders: register its binding with subfolders: true`,
113
81
  );
114
- return { folder };
82
+ return folder;
115
83
  }
116
84
 
117
85
  async function createFolder(
@@ -152,105 +120,24 @@ async function createFolder(
152
120
  return folder;
153
121
  }
154
122
 
155
- async function refreshFolder(
156
- models: DeclaredModels,
157
- declaration: DeclaredFolderInput,
158
- folder: MediaFolder,
159
- parent: MediaFolder | undefined,
160
- ): Promise<MediaFolder | undefined> {
161
- if (isMoveInsideSubtree(folder, parent))
162
- throw new MediaDeclarationError(
163
- "folder",
164
- declaration.key,
165
- "Cannot move a folder inside itself",
166
- );
167
- const folders = await models.folderModel.getAll();
168
- if (hasSiblingNamed(folders, declaration.name, parent?._id, folder._id))
169
- throw new MediaDeclarationError(
170
- "folder",
171
- declaration.key,
172
- `a folder named '${declaration.name}' already exists there`,
173
- );
174
- // An empty ACL string reads as no ACL: the folder inherits its parent's.
175
- const patch: Partial<MediaFolder> = {
176
- name: declaration.name,
177
- parentId: parent?._id,
178
- path: buildChildPath(parent),
179
- visibility: declaration.visibility,
180
- json_acl: serializeAcl(declaration.acl) ?? "",
181
- };
182
- if (!(await models.folderModel.compareDeclared(folder, patch)))
183
- return undefined;
184
- if ((folder.parentId || undefined) !== parent?._id) {
185
- await rewriteDescendantPaths(
186
- { folderModel: models.folderModel, folders },
187
- folder,
188
- patch.path ?? [],
189
- );
190
- }
191
- // Remember only our write, not a member's edit made just after it.
192
- return Object.assign(folder, patch);
193
- }
194
-
195
123
  async function applyFolderDeclaration(
196
124
  declaration: DeclaredFolderInput,
197
125
  ): Promise<MediaDeclarationResult> {
198
- await waitForTenant(declaration.tenantId);
199
126
  const models = declaredModels(declaration.tenantId);
127
+ const record = await models.declarationModel.findByKey(
128
+ "folder",
129
+ declaration.key,
130
+ );
131
+ if (record) return { status: "kept", id: record.targetId };
200
132
  const fail = (reason: string): never => {
201
133
  throw new MediaDeclarationError("folder", declaration.key, reason);
202
134
  };
203
- const parentLookup = declaration.parent
135
+ const parent = declaration.parent
204
136
  ? await findParentFolder(models, declaration.parent, fail)
205
137
  : undefined;
206
- const parent = parentLookup?.folder;
207
- const isParentDeleted = Boolean(parentLookup) && !parent;
208
- const record = await models.declarationModel.findByKey(
209
- "folder",
210
- declaration.key,
211
- );
212
- const declaredHash = folderDeclarationHash(declaration);
213
- if (!record) {
214
- // The parent a member deleted takes its declared children with it.
215
- if (isParentDeleted) return { status: "deleted" };
216
- const folder = await createFolder(models, declaration, parent);
217
- await rememberFolder(models, undefined, declaration, folder, declaredHash);
218
- return { status: "created", id: folder._id };
219
- }
220
- const folder = await models.folderModel.get(record.targetId);
221
- const verdict = judgeDeclaredRow(
222
- record,
223
- folder,
224
- folder && folderStateHash(folder),
225
- declaredHash,
226
- );
227
- if (verdict || !folder) return verdict ?? { status: "deleted" };
228
- if (isParentDeleted) return { status: "preserved", id: folder._id };
229
- const refreshed = await refreshFolder(models, declaration, folder, parent);
230
- if (!refreshed) {
231
- const current = await models.folderModel.get(folder._id);
232
- return current
233
- ? { status: "preserved", id: folder._id }
234
- : { status: "deleted" };
235
- }
236
- await rememberFolder(models, record, declaration, refreshed, declaredHash);
237
- return { status: "updated", id: refreshed._id };
238
- }
239
-
240
- function rememberFolder(
241
- models: DeclaredModels,
242
- record: MediaDeclaration | undefined,
243
- declaration: DeclaredFolderInput,
244
- folder: MediaFolder,
245
- declaredHash: string,
246
- ): Promise<void> {
247
- return saveDeclaration(models.declarationModel, record, {
248
- kind: "folder",
249
- key: declaration.key,
250
- targetId: folder._id,
251
- declaredHash,
252
- appliedHash: folderStateHash(folder),
253
- });
138
+ const folder = await createFolder(models, declaration, parent);
139
+ await rememberDeclaration(models, "folder", declaration.key, folder._id);
140
+ return { status: "created", id: folder._id };
254
141
  }
255
142
 
256
143
  /** Implements `EnsureMediaFolder`. */
@@ -1,5 +1,3 @@
1
1
  export * from "./assets";
2
2
  export * from "./folders";
3
- export * from "./readiness";
4
3
  export * from "./records";
5
- export * from "./retire";
@@ -1,10 +1,7 @@
1
- import { createHash } from "node:crypto";
2
1
  import { GetModel } from "@antelopejs/interface-database-decorators";
3
- import type { MediaDeclarationResult } from "@antelopejs/interface-dms-media";
4
2
  import type { ZodError, ZodType } from "zod";
5
3
  import {
6
4
  MediaAssetModel,
7
- type MediaDeclaration,
8
5
  type MediaDeclarationKind,
9
6
  MediaDeclarationModel,
10
7
  MediaFolderModel,
@@ -47,17 +44,6 @@ export function declaredModels(tenantId: string): DeclaredModels {
47
44
  };
48
45
  }
49
46
 
50
- /** Values a declaration compares, built with a fixed key order so equal values hash equally. */
51
- export type HashedState = Record<string, unknown>;
52
-
53
- export function hashState(state: HashedState): string {
54
- return createHash("sha256").update(JSON.stringify(state)).digest("hex");
55
- }
56
-
57
- export function hashBytes(bytes: Uint8Array): string {
58
- return createHash("sha256").update(bytes).digest("hex");
59
- }
60
-
61
47
  /** Validates a declaration, naming every refused field. */
62
48
  export function parseDeclaration<Schema extends ZodType>(
63
49
  kind: MediaDeclarationKind,
@@ -86,7 +72,7 @@ function lockKey(
86
72
 
87
73
  /**
88
74
  * Runs the declarations of one key one after another, so a key declared twice
89
- * at once (a boot racing a hot reload) still creates a single row.
75
+ * at once (a retried provisioning racing the first) still creates a single row.
90
76
  */
91
77
  export function withDeclarationLock<T>(
92
78
  tenantId: string,
@@ -114,72 +100,12 @@ export async function settlePendingDeclaration(
114
100
  await pendingDeclarations.get(lockKey(tenantId, kind, key));
115
101
  }
116
102
 
117
- export interface AppliedDeclaration {
118
- kind: MediaDeclarationKind;
119
- key: string;
120
- targetId: string;
121
- declaredHash: string;
122
- appliedHash: string;
123
- contentHash?: string;
124
- version?: string;
125
- }
126
-
127
- /** Remembers what was declared and the state it left the row in. */
128
- export async function saveDeclaration(
129
- model: MediaDeclarationModel,
130
- existing: MediaDeclaration | undefined,
131
- applied: AppliedDeclaration,
103
+ /** Remembers the folder or file a declaration created, under its kind and key. */
104
+ export async function rememberDeclaration(
105
+ models: DeclaredModels,
106
+ kind: MediaDeclarationKind,
107
+ key: string,
108
+ targetId: string,
132
109
  ): Promise<void> {
133
- if (existing) {
134
- await model.update(existing._id, applied);
135
- return;
136
- }
137
- await model.insert(applied);
138
- }
139
-
140
- interface DeletedByMember {
141
- status: "deleted";
142
- }
143
-
144
- interface ChangedByMember {
145
- status: "preserved";
146
- id: string;
147
- }
148
-
149
- /** What a member did to declared content: deleted it, or changed it and so keeps it. */
150
- export type MemberChange = DeletedByMember | ChangedByMember;
151
-
152
- /**
153
- * The part of the rule that needs no new declaration: a row deleted since it
154
- * was declared stays deleted, and a row whose editable state no longer hashes
155
- * to what the last declaration left was changed by a member and stays as they
156
- * made it. Returns undefined when the row is still as declared.
157
- */
158
- export function judgeMemberChange(
159
- record: MediaDeclaration,
160
- row: { _id: string } | undefined,
161
- stateHash: string | undefined,
162
- ): MemberChange | undefined {
163
- if (!row) return { status: "deleted" };
164
- if (stateHash !== record.appliedHash)
165
- return { status: "preserved", id: row._id };
166
- return undefined;
167
- }
168
-
169
- /**
170
- * The rule shared by folders and files: `judgeMemberChange`, then a
171
- * declaration equal to the last one leaves the row unchanged. Returns
172
- * undefined when the row may be refreshed.
173
- */
174
- export function judgeDeclaredRow(
175
- record: MediaDeclaration,
176
- row: { _id: string } | undefined,
177
- stateHash: string | undefined,
178
- declaredHash: string,
179
- ): MediaDeclarationResult | undefined {
180
- const change = judgeMemberChange(record, row, stateHash);
181
- if (change || !row) return change;
182
- if (record.declaredHash === declaredHash)
183
- return { status: "unchanged", id: row._id };
184
- return undefined;
110
+ await models.declarationModel.insert({ kind, key, targetId });
185
111
  }
@@ -1,7 +1,9 @@
1
1
  import { randomUUID } from "node:crypto";
2
+ import { buffer } from "node:stream/consumers";
2
3
  import {
3
- CreateUploadUrl,
4
4
  DeleteFile,
5
+ ReadFile,
6
+ WriteFile,
5
7
  } from "@antelopejs/interface-file-storage";
6
8
  import sharp from "sharp";
7
9
  import { TECHNICAL_MUTATION, updateAssetMedia } from "./asset-lifecycle";
@@ -15,7 +17,6 @@ import {
15
17
  RASTERIZED_SVG_FORMAT,
16
18
  SVG_MIMETYPE,
17
19
  } from "./presets";
18
- import { signedReadUrl } from "./read-urls";
19
20
  import { parseDerivatives } from "./routes/media/storage-keys";
20
21
 
21
22
  const DERIVATIVES_PATH_PREFIX = "media-derivatives";
@@ -41,11 +42,7 @@ export async function downloadStorageBytes(
41
42
  storageKey: string,
42
43
  storage: string | undefined,
43
44
  ): Promise<Buffer> {
44
- const response = await fetch(await signedReadUrl(storageKey, storage));
45
- if (!response.ok) {
46
- throw new Error(`Failed to download ${storageKey}: ${response.status}`);
47
- }
48
- return Buffer.from(await response.arrayBuffer());
45
+ return buffer((await ReadFile(storageKey, storage)).body);
49
46
  }
50
47
 
51
48
  export async function uploadStorageBytes(
@@ -55,7 +52,7 @@ export async function uploadStorageBytes(
55
52
  path: string,
56
53
  storage: string | undefined,
57
54
  ): Promise<string> {
58
- const presigned = await CreateUploadUrl(
55
+ const { resourceKey } = await WriteFile(
59
56
  {
60
57
  filename,
61
58
  size: bytes.byteLength,
@@ -63,18 +60,11 @@ export async function uploadStorageBytes(
63
60
  path,
64
61
  metadata: { [ORIGINAL_FILENAME_METADATA_KEY]: filename },
65
62
  },
63
+ bytes,
66
64
  undefined,
67
65
  storage,
68
66
  );
69
- const response = await fetch(presigned.uploadUrl, {
70
- method: "PUT",
71
- headers: presigned.headers,
72
- body: new Uint8Array(bytes),
73
- });
74
- if (!response.ok) {
75
- throw new Error(`Failed to upload ${filename}: ${response.status}`);
76
- }
77
- return presigned.resourceKey;
67
+ return resourceKey;
78
68
  }
79
69
 
80
70
  async function readSourceMetadata(source: Buffer): Promise<sharp.Metadata> {
@@ -0,0 +1,35 @@
1
+ import path from "node:path";
2
+ import type {
3
+ AddFrontendModuleOptions,
4
+ FrontendBackendProxy,
5
+ } from "@antelopejs/interface-dms/page";
6
+
7
+ /** The frontend module the dashboard loads: its blocks, viewers and fields. */
8
+ export const MEDIA_FRONTEND_MODULE = "@antelopejs/dms-media-frontend-vue";
9
+
10
+ /**
11
+ * The file links a dashboard page shows (`/media/<id>/<name>`), which the
12
+ * backend serves: proxied by the frontend server with the member's session,
13
+ * so that a private file opens for a member signed in, as on the API origin.
14
+ */
15
+ export const MEDIA_DELIVERY_PROXY: FrontendBackendProxy = {
16
+ path: "/media/**",
17
+ auth: "session",
18
+ };
19
+
20
+ /**
21
+ * This module's frontend, from its configuration alone: the backend registers
22
+ * it with `AddFrontendModule`, and `@antelopejs/dms-frontend` calls this same
23
+ * function (declared as `dmsFrontend` in package.json) to build and start the
24
+ * frontend without a backend. It reads nothing but its arguments.
25
+ */
26
+ export function frontendModule(): AddFrontendModuleOptions {
27
+ return {
28
+ name: MEDIA_FRONTEND_MODULE,
29
+ sourcePath: path.join(__dirname, "../frontend-vue"),
30
+ renderer: { name: "vue", version: "3" },
31
+ configKey: "dmsMedia",
32
+ priority: 0,
33
+ backendProxies: [MEDIA_DELIVERY_PROXY],
34
+ };
35
+ }
@@ -1,11 +1,6 @@
1
1
  import type { AssetBindingConfig } from "@antelopejs/interface-dms-media";
2
2
  import { addAssetBinding, removeAssetBinding } from "../../bindings";
3
- import {
4
- ensureDeclaredFolder,
5
- importDeclaredAsset,
6
- pruneDeclarations,
7
- retireDeclaration,
8
- } from "../../declared";
3
+ import { ensureDeclaredFolder, importDeclaredAsset } from "../../declared";
9
4
 
10
5
  export namespace internal {
11
6
  export const RegisterAssetBinding = {
@@ -18,6 +13,4 @@ export namespace internal {
18
13
  };
19
14
  export const EnsureMediaFolder = ensureDeclaredFolder;
20
15
  export const ImportMediaAsset = importDeclaredAsset;
21
- export const RetireMediaDeclaration = retireDeclaration;
22
- export const PruneMediaDeclarations = pruneDeclarations;
23
16
  }
package/src/index.ts CHANGED
@@ -1,14 +1,11 @@
1
- import path from "node:path";
2
1
  import { ImplementInterface } from "@antelopejs/interface-core";
3
- import {
4
- AddFrontendModule,
5
- type FrontendBackendProxy,
6
- } from "@antelopejs/interface-dms/page";
2
+ import { AddFrontendModule } from "@antelopejs/interface-dms/page";
7
3
  import { Logging } from "@antelopejs/interface-core/logging";
8
4
  import "./db";
9
5
  import type { ScheduledTask } from "node-cron";
10
6
  import { type DmsMediaConfig, configureMediaModule } from "./config";
11
7
  import { registerMediaCrons } from "./crons";
8
+ import { frontendModule } from "./frontend-module";
12
9
  import { cancelLibraryChange } from "./library/realtime";
13
10
 
14
11
  export * from "./acl";
@@ -18,6 +15,7 @@ export * from "./constants";
18
15
  export * from "./crons";
19
16
  export * from "./db";
20
17
  export * from "./derivatives";
18
+ export * from "./frontend-module";
21
19
  export * from "./pages";
22
20
  export * from "./presets";
23
21
  export * from "./routes";
@@ -26,35 +24,13 @@ export * from "./types";
26
24
 
27
25
  let cronTasks: ScheduledTask[] = [];
28
26
 
29
- /** The frontend module the dashboard loads: its blocks, viewers and fields. */
30
- export const MEDIA_FRONTEND_MODULE = "@antelopejs/dms-media-frontend-vue";
31
-
32
- /**
33
- * The file links a dashboard page shows (`/media/<id>/<name>`), which the
34
- * backend serves: proxied by the frontend server with the member's session,
35
- * so that a private file opens for a member signed in, as on the API origin.
36
- */
37
- export const MEDIA_DELIVERY_PROXY: FrontendBackendProxy = {
38
- path: "/media/**",
39
- auth: "session",
40
- };
41
-
42
27
  export async function construct(config: DmsMediaConfig = {}): Promise<void> {
43
28
  configureMediaModule(config);
44
29
  ImplementInterface(
45
30
  await import("@antelopejs/interface-dms-media"),
46
31
  await import("./implementations/interface-dms-media"),
47
32
  );
48
- const sourcePath = path.join(__dirname, "../frontend-vue");
49
-
50
- await AddFrontendModule({
51
- name: MEDIA_FRONTEND_MODULE,
52
- sourcePath,
53
- renderer: { name: "vue", version: "3" },
54
- configKey: "dmsMedia",
55
- priority: 0,
56
- backendProxies: [MEDIA_DELIVERY_PROXY],
57
- });
33
+ await AddFrontendModule(frontendModule());
58
34
  }
59
35
 
60
36
  export function start(): void {
@@ -10,12 +10,18 @@ const LIBRARY_CHANGED = "changed";
10
10
 
11
11
  let pending: ReturnType<typeof setTimeout> | undefined;
12
12
  let pendingDueAt = 0;
13
+ let pendingChanges = 0;
13
14
  let version = 0;
14
15
 
15
16
  async function publishNow(): Promise<void> {
16
17
  pending = undefined;
18
+ // A paused page counts `payload.count` as that many missed changes, not one per announcement.
19
+ const count = pendingChanges;
20
+ pendingChanges = 0;
17
21
  try {
18
- await PublishMessage(MEDIA_LIBRARY_TOPIC, LIBRARY_CHANGED);
22
+ await PublishMessage(MEDIA_LIBRARY_TOPIC, LIBRARY_CHANGED, {
23
+ payload: { count },
24
+ });
19
25
  } catch (error) {
20
26
  Logging.Error("Failed to publish a media library change", error);
21
27
  }
@@ -23,11 +29,13 @@ async function publishNow(): Promise<void> {
23
29
 
24
30
  /**
25
31
  * Tells the pages showing the library that it changed, so their blocks read
26
- * their routes again. The message carries nothing: each block re-reads what
27
- * its reader may see. An announcement already due sooner absorbs this one.
32
+ * their routes again. The message carries only how many changes it stands
33
+ * for: each block re-reads what its reader may see. An announcement already
34
+ * due sooner absorbs this one.
28
35
  */
29
36
  export function announceLibraryChange(delayMs = COALESCE_WINDOW_MS): void {
30
37
  version += 1;
38
+ pendingChanges += 1;
31
39
  const dueAt = Date.now() + delayMs;
32
40
  if (pending && pendingDueAt <= dueAt) return;
33
41
  clearTimeout(pending);
@@ -45,4 +53,5 @@ export function libraryVersion(): number {
45
53
  export function cancelLibraryChange(): void {
46
54
  clearTimeout(pending);
47
55
  pending = undefined;
56
+ pendingChanges = 0;
48
57
  }
@@ -7,6 +7,7 @@ import { MEDIA_LIBRARY_TOPIC } from "../constants";
7
7
  import { ACTIVITY_FILTERS, type ActivityFilter } from "../library/activity";
8
8
  import { libraryCategory, MEDIA_MODULE_ID } from "./module";
9
9
  import { blockMeta } from "./texts";
10
+ import { MEDIA_LIVE, mediaPageToolbar } from "./toolbar";
10
11
 
11
12
  const TEXTS = "$dms_media.activity_page";
12
13
  const FEED_LENGTH = 50;
@@ -57,9 +58,12 @@ export class MediaActivityPage extends PageController(
57
58
  icon: "i-ph-clock-counter-clockwise",
58
59
  hidden: true,
59
60
  order: 5,
61
+ live: MEDIA_LIVE,
60
62
  },
61
63
  DefaultLayout(),
62
64
  ) {
65
+ static toolbar = mediaPageToolbar();
66
+
63
67
  static feed = Card()
64
68
  .meta(blockMeta("activity_log", "i-ph-clock-counter-clockwise"))
65
69
  .child("filters", filteredFeeds());
@@ -12,10 +12,9 @@ import { MEDIA_ROUTES, viewLink } from "../library/links";
12
12
  import { libraryCategory, MEDIA_MODULE_ID } from "./module";
13
13
  import { blockMeta } from "./texts";
14
14
  import { MEDIA_LIBRARY_TOPIC } from "../constants";
15
+ import { MEDIA_LIVE, mediaPageToolbar } from "./toolbar";
15
16
 
16
17
  const TEXTS = "$dms_media.overview";
17
- /** Shortest interval, in seconds, between two refetches of a block while files upload. */
18
- const LIVE_MAX_RATE_SECONDS = 2;
19
18
  const GAP = "1rem";
20
19
  const MIN_COLUMN_WIDTH = "320px";
21
20
  const WIDE_SPAN = 2;
@@ -83,7 +82,7 @@ export class MediaOverviewPage extends PageController(
83
82
  module: MEDIA_MODULE_ID,
84
83
  icon: "i-ph-squares-four",
85
84
  order: 0,
86
- live: { maxRate: LIVE_MAX_RATE_SECONDS },
85
+ live: MEDIA_LIVE,
87
86
  },
88
87
  DefaultLayout({
89
88
  headerActions: [
@@ -98,6 +97,8 @@ export class MediaOverviewPage extends PageController(
98
97
  ],
99
98
  }),
100
99
  ) {
100
+ static toolbar = mediaPageToolbar();
101
+
101
102
  static firstRun = CustomComponent("DmsMediaFirstRun").meta(
102
103
  blockMeta("first_run", "i-ph-sparkle"),
103
104
  );
@@ -0,0 +1,28 @@
1
+ import { pageToolbar } from "@antelopejs/interface-dms/base/page-toolbar";
2
+ import type { PageLiveOptions } from "@antelopejs/interface-dms/page";
3
+ import { MEDIA_MODULE_ID } from "./module";
4
+ import { blockMeta } from "./texts";
5
+
6
+ /** Shortest interval, in seconds, between two refetches of a block while files upload. */
7
+ const LIVE_MAX_RATE_SECONDS = 2;
8
+
9
+ /**
10
+ * Live mode of the media pages that follow the library as it changes. They
11
+ * share one Direct / Pause choice: pausing the overview pauses the uploads too.
12
+ */
13
+ export const MEDIA_LIVE: PageLiveOptions = {
14
+ maxRate: LIVE_MAX_RATE_SECONDS,
15
+ rememberKey: MEDIA_MODULE_ID,
16
+ };
17
+
18
+ /**
19
+ * The DMS page toolbar of a live media page, first in its body: when the page
20
+ * last read the library and Direct / Pause. No period: the library's figures
21
+ * are a snapshot, not a window of time.
22
+ */
23
+ export function mediaPageToolbar() {
24
+ return pageToolbar({
25
+ live: { missedLabel: "$dms_media.live.missed" },
26
+ period: false,
27
+ }).meta(blockMeta("page_toolbar", "i-ph-sliders-horizontal"));
28
+ }
@@ -10,6 +10,7 @@ import { libraryCategory, MEDIA_MODULE_ID } from "./module";
10
10
  import { blockMeta } from "./texts";
11
11
  import { uploadAvailability } from "./upload-availability";
12
12
  import { MEDIA_LIBRARY_TOPIC } from "../constants";
13
+ import { MEDIA_LIVE, mediaPageToolbar } from "./toolbar";
13
14
 
14
15
  const TEXTS = "$dms_media.uploads";
15
16
  const HISTORY_PAGE_SIZE = 10;
@@ -19,6 +20,7 @@ const history = TableView.fromSource({
19
20
  caption: `${TEXTS}.history.title`,
20
21
  fetchUrl: "/api/media/upload/batches",
21
22
  realtimeTopic: MEDIA_LIBRARY_TOPIC,
23
+ liveHold: true,
22
24
  layout: "full",
23
25
  density: "compact",
24
26
  pageSize: HISTORY_PAGE_SIZE,
@@ -117,6 +119,7 @@ export class MediaUploadsPage extends PageController(
117
119
  module: MEDIA_MODULE_ID,
118
120
  icon: "i-ph-cloud-arrow-up",
119
121
  order: 2,
122
+ live: MEDIA_LIVE,
120
123
  },
121
124
  DefaultLayout({
122
125
  headerActions: [
@@ -132,6 +135,8 @@ export class MediaUploadsPage extends PageController(
132
135
  ],
133
136
  }),
134
137
  ) {
138
+ static toolbar = mediaPageToolbar();
139
+
135
140
  static queue = CustomComponent("DmsMediaUploadQueue").meta(
136
141
  blockMeta("upload_queue", "i-ph-cloud-arrow-up"),
137
142
  );