@antelopejs/dms-media 0.6.0 → 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 (74) 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/implementations/interface-dms-media/index.d.ts +1 -3
  23. package/dist/implementations/interface-dms-media/index.js +0 -2
  24. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  25. package/dist/routes/media/delivery-stream.js +7 -21
  26. package/dist/routes/media/delivery-stream.js.map +1 -1
  27. package/dist/routes/media/upload.js +2 -5
  28. package/dist/routes/media/upload.js.map +1 -1
  29. package/dist/test/antelope.test.js +4 -4
  30. package/dist/test/integration/media-declared-content.test.js +17 -317
  31. package/dist/test/integration/media-declared-content.test.js.map +1 -1
  32. package/dist/test/integration/media-linked-subfolders.test.js +2 -2
  33. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
  34. package/dist/test/integration/media-storage-origin-unreachable.test.js +79 -0
  35. package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
  36. package/dist/test/unit/declared.test.js +0 -66
  37. package/dist/test/unit/declared.test.js.map +1 -1
  38. package/dist/test/unit/library/realtime.test.js +1 -0
  39. package/dist/test/unit/library/realtime.test.js.map +1 -1
  40. package/dist/validation/declared.schema.d.ts +7 -36
  41. package/dist/validation/declared.schema.js +1 -12
  42. package/dist/validation/declared.schema.js.map +1 -1
  43. package/frontend-vue/package.json +1 -1
  44. package/package.json +8 -8
  45. package/skills/dms-media/SKILL.md +11 -24
  46. package/src/db/models/mediaFolders.model.ts +0 -44
  47. package/src/db/tables/mediaDeclarations.table.ts +3 -19
  48. package/src/declared/assets.ts +19 -210
  49. package/src/declared/folders.ts +22 -135
  50. package/src/declared/index.ts +0 -2
  51. package/src/declared/records.ts +8 -82
  52. package/src/derivatives.ts +7 -17
  53. package/src/implementations/interface-dms-media/index.ts +1 -8
  54. package/src/routes/media/delivery-stream.ts +12 -28
  55. package/src/routes/media/upload.ts +4 -6
  56. package/src/test/antelope.test.ts +4 -4
  57. package/src/test/integration/media-declared-content.test.ts +17 -360
  58. package/src/test/integration/media-linked-subfolders.test.ts +2 -2
  59. package/src/test/integration/media-storage-origin-unreachable.test.ts +110 -0
  60. package/src/test/unit/declared.test.ts +0 -87
  61. package/src/test/unit/library/realtime.test.ts +2 -0
  62. package/src/validation/declared.schema.ts +0 -13
  63. package/dist/declared/readiness.d.ts +0 -2
  64. package/dist/declared/readiness.js +0 -52
  65. package/dist/declared/readiness.js.map +0 -1
  66. package/dist/declared/retire.d.ts +0 -3
  67. package/dist/declared/retire.js +0 -118
  68. package/dist/declared/retire.js.map +0 -1
  69. package/dist/test/integration/media-declared-retire.test.js +0 -186
  70. package/dist/test/integration/media-declared-retire.test.js.map +0 -1
  71. package/src/declared/readiness.ts +0 -64
  72. package/src/declared/retire.ts +0 -206
  73. package/src/test/integration/media-declared-retire.test.ts +0 -257
  74. /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
@@ -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> {
@@ -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
  }
@@ -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();
@@ -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(
@@ -110,7 +110,7 @@ export default defineConfig({
110
110
  source: {
111
111
  type: "package",
112
112
  package: "@antelopejs/dms",
113
- version: ">=0.10.0 <1.0.0",
113
+ version: ">=0.11.0 <1.0.0",
114
114
  },
115
115
  config: {
116
116
  // No frontend server runs here: the dashboard URL is the API, whose
@@ -130,7 +130,7 @@ export default defineConfig({
130
130
  source: {
131
131
  type: "package",
132
132
  package: "@antelopejs/mongodb",
133
- version: "1.4.4",
133
+ version: "1.5.0",
134
134
  },
135
135
  },
136
136
  "auth-jwt": {
@@ -147,7 +147,7 @@ export default defineConfig({
147
147
  source: {
148
148
  type: "package",
149
149
  package: "@antelopejs/api",
150
- version: "1.4.0",
150
+ version: "1.5.0",
151
151
  },
152
152
  config: {
153
153
  servers: [{ protocol: "http", host: "127.0.0.1", port: API_PORT }],
@@ -158,7 +158,7 @@ export default defineConfig({
158
158
  source: {
159
159
  type: "package",
160
160
  package: "@antelopejs/file-storage-local",
161
- version: "0.1.12",
161
+ version: "0.1.13",
162
162
  },
163
163
  },
164
164
  nodemailer: {