@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,9 +1,7 @@
1
1
  import { createHash } from "node:crypto";
2
- import { Readable } from "node:stream";
3
- import type { ReadableStream as WebReadableStream } from "node:stream/web";
4
2
  import type { HTTPResult, RequestContext } from "@antelopejs/interface-api";
5
3
  import { assert } from "@antelopejs/interface-api-util";
6
- import { signedReadUrl } from "../../read-urls";
4
+ import { ReadFile } from "@antelopejs/interface-file-storage";
7
5
  import { PRIVATE_CACHE_CONTROL, PUBLIC_CACHE_CONTROL } from "./constants";
8
6
  import {
9
7
  contentDisposition,
@@ -11,6 +9,7 @@ import {
11
9
  normalizedMimetype,
12
10
  } from "./delivery-headers";
13
11
 
12
+ const HTTP_OK = 200;
14
13
  const HTTP_NOT_MODIFIED = 304;
15
14
  const HTTP_BAD_GATEWAY = 502;
16
15
  const ETAG_HASH_LENGTH = 24;
@@ -18,11 +17,6 @@ const ANY_MATCH = "*";
18
17
  const ANY_ORIGIN = "*";
19
18
  const DENIED_ORIGIN = "false";
20
19
  const HEAD_METHOD = "HEAD";
21
- const FORWARDED_UPSTREAM_HEADERS = [
22
- "Content-Length",
23
- "Content-Range",
24
- "Accept-Ranges",
25
- ];
26
20
 
27
21
  /** One stored file as the delivery route hands it out. */
28
22
  export interface DeliveredFile {
@@ -79,24 +73,12 @@ function addRepresentationHeaders(
79
73
  if (file.isPublic) openPublicCors(response);
80
74
  }
81
75
 
82
- async function fetchUpstream(
83
- ctx: RequestContext,
84
- file: DeliveredFile,
85
- ): Promise<Response> {
86
- const range = ctx.rawRequest.headers.range;
87
- const upstream = await fetch(
88
- await signedReadUrl(file.storageKey, file.storage),
89
- { headers: range ? { Range: range } : {} },
90
- );
91
- assert(upstream.ok && upstream.body, HTTP_BAD_GATEWAY, "File unavailable");
92
- return upstream;
93
- }
94
-
95
76
  /**
96
77
  * Serves the bytes through the API. Only used for active content (SVG,
97
78
  * legacy HTML/XML): the storage's signed URL cannot carry the sandbox policy
98
79
  * or the attachment disposition these files need, every other file is
99
80
  * redirected to the storage so its bandwidth never goes through Node.
81
+ * Byte ranges are not served: these files are small and rendered whole.
100
82
  */
101
83
  export async function streamStoredFile(
102
84
  ctx: RequestContext,
@@ -110,16 +92,18 @@ export async function streamStoredFile(
110
92
  response.setBody("");
111
93
  return response;
112
94
  }
113
- const upstream = await fetchUpstream(ctx, file);
114
- for (const header of FORWARDED_UPSTREAM_HEADERS) {
115
- const value = upstream.headers.get(header);
116
- if (value) response.addHeader(header, value);
117
- }
95
+ // Read from the storage itself: its read URL is the public origin, which
96
+ // the server may not reach (private network, egress policy).
97
+ const stored = await ReadFile(file.storageKey, file.storage).catch(
98
+ () => undefined,
99
+ );
100
+ assert(stored, HTTP_BAD_GATEWAY, "File unavailable");
101
+ response.addHeader("Content-Length", String(stored.size));
118
102
  const stream = response.getWriteStream(
119
103
  normalizedMimetype(file.mimetype),
120
- upstream.status,
104
+ HTTP_OK,
121
105
  );
122
- const body = Readable.fromWeb(upstream.body as WebReadableStream);
106
+ const body = stored.body;
123
107
  if (ctx.rawRequest.method === HEAD_METHOD) {
124
108
  body.destroy();
125
109
  stream.end();
@@ -78,16 +78,29 @@ interface PresetRowInput {
78
78
  example?: MediaAsset;
79
79
  }
80
80
 
81
- function presetRow({ preset, origin, renderedKeys, example }: PresetRowInput) {
81
+ /**
82
+ * A preset's card: `urlPattern` and `exampleUrl` are the absolute links a
83
+ * website copies, while `examplePreviewUrl` stays relative so the dashboard
84
+ * loads the preview through its own origin, which carries the member's
85
+ * session to a private example.
86
+ */
87
+ export function presetRow({
88
+ preset,
89
+ origin,
90
+ renderedKeys,
91
+ example,
92
+ }: PresetRowInput) {
82
93
  const cacheKey = presetCacheKey(preset);
94
+ const examplePath = example
95
+ ? `/media/${example._id}/${preset.id}/${encodeURIComponent(example.name)}`
96
+ : null;
83
97
  return {
84
98
  ...preset,
85
99
  cacheKey,
86
100
  rendered: renderedKeys.filter((key) => key === cacheKey).length,
87
101
  urlPattern: `${origin}/media/{asset}/${preset.id}/{filename}`,
88
- exampleUrl: example
89
- ? `${origin}/media/${example._id}/${preset.id}/${encodeURIComponent(example.name)}`
90
- : null,
102
+ exampleUrl: examplePath ? `${origin}${examplePath}` : null,
103
+ examplePreviewUrl: examplePath,
91
104
  };
92
105
  }
93
106
 
@@ -1,15 +1,16 @@
1
1
  import { MediaApiController } from "./controller";
2
2
  import { randomUUID } from "node:crypto";
3
+ import { buffer } from "node:stream/consumers";
3
4
  import { HTTPResult, JSONBody, Post } from "@antelopejs/interface-api";
4
5
  import { assert, assertValidation } from "@antelopejs/interface-api-util";
5
6
  import {
6
- CreateReadUrl,
7
7
  CreateUploadUrl,
8
8
  DeleteFile,
9
9
  type FileMetadata,
10
10
  GetFileMetadata,
11
11
  isStagedKey,
12
12
  PromoteFile,
13
+ ReadFile,
13
14
  } from "@antelopejs/interface-file-storage";
14
15
  import { TenantScopedModel } from "@antelopejs/interface-dms/tenant-scoped-model";
15
16
  import { feedingBinding } from "../../bindings";
@@ -63,11 +64,8 @@ function mediaUploadPath(tenantId: string, folderId: string): string {
63
64
  async function readStoredFile(
64
65
  storageKey: string,
65
66
  storage: string | undefined,
66
- ): Promise<Buffer | undefined> {
67
- const readUrl = await CreateReadUrl(storageKey, undefined, storage);
68
- const response = await fetch(readUrl.url);
69
- if (!response.ok) return undefined;
70
- return Buffer.from(await response.arrayBuffer());
67
+ ): Promise<Buffer> {
68
+ return buffer((await ReadFile(storageKey, storage)).body);
71
69
  }
72
70
 
73
71
  async function readImage(
@@ -8,6 +8,7 @@ import { MongoMemoryReplSet } from "mongodb-memory-server-core";
8
8
  const API_PORT = 5019;
9
9
  const LOCAL_BUILD_COMMAND = process.env.DMS_PREBUILT ? [] : ["pnpm build"];
10
10
  const JWT_SECRET = "test-jwt-secret";
11
+ const HTML_RENDER_SECRET = "test-html-render-secret";
11
12
  const MONGO_BINARY_VERSION = "8.0.8";
12
13
  const SMTP_HOST = "127.0.0.1";
13
14
  const EPHEMERAL_PORT = 0;
@@ -109,19 +110,27 @@ export default defineConfig({
109
110
  source: {
110
111
  type: "package",
111
112
  package: "@antelopejs/dms",
112
- version: ">=0.9.3 <1.0.0",
113
+ version: ">=0.11.0 <1.0.0",
113
114
  },
114
115
  config: {
116
+ // No frontend server runs here: the dashboard URL is the API, whose
117
+ // paths the front proxy serves unchanged.
118
+ clientBaseUrl: `http://127.0.0.1:${API_PORT}`,
115
119
  auth: {
116
120
  jwtSecret: JWT_SECRET,
117
121
  },
122
+ // Outside development, which the test run is not, dms 0.10 refuses
123
+ // to start without a render secret of its own.
124
+ htmlRender: {
125
+ serviceSecret: HTML_RENDER_SECRET,
126
+ },
118
127
  },
119
128
  },
120
129
  mongodb: {
121
130
  source: {
122
131
  type: "package",
123
132
  package: "@antelopejs/mongodb",
124
- version: "1.4.3",
133
+ version: "1.5.0",
125
134
  },
126
135
  },
127
136
  "auth-jwt": {
@@ -138,7 +147,7 @@ export default defineConfig({
138
147
  source: {
139
148
  type: "package",
140
149
  package: "@antelopejs/api",
141
- version: "1.3.5",
150
+ version: "1.5.0",
142
151
  },
143
152
  config: {
144
153
  servers: [{ protocol: "http", host: "127.0.0.1", port: API_PORT }],
@@ -149,7 +158,7 @@ export default defineConfig({
149
158
  source: {
150
159
  type: "package",
151
160
  package: "@antelopejs/file-storage-local",
152
- version: "0.1.9",
161
+ version: "0.1.13",
153
162
  },
154
163
  },
155
164
  nodemailer: {
@@ -145,6 +145,11 @@ describe("[integration] media activity and overview — figures, upload history
145
145
  const response = await client.get("/api/media/presets");
146
146
  expect(response.data.isDefault).to.be.a("boolean");
147
147
  expect(response.data.presets[0].urlPattern).to.match(/^https?:\/\//);
148
+ for (const preset of response.data.presets) {
149
+ if (preset.examplePreviewUrl === null) continue;
150
+ expect(preset.examplePreviewUrl).to.match(/^\/media\//);
151
+ expect(preset.exampleUrl).to.match(/^https?:\/\//);
152
+ }
148
153
  const cache = await client.get("/api/media/presets/cache");
149
154
  expect(
150
155
  cache.data.items.map((item: { id: string }) => item.id),