@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
@@ -24,23 +24,27 @@ const HTTP_BAD_REQUEST = 400;
24
24
  const HTTP_CONFLICT = 409;
25
25
  const HTTP_UNPROCESSABLE_ENTITY = 422;
26
26
 
27
- function translateTransformError(error: unknown): never {
28
- assert(
29
- !(error instanceof AnimatedImageTransformError),
30
- HTTP_UNPROCESSABLE_ENTITY,
31
- "Animated images cannot be edited",
32
- );
33
- assert(
34
- !(error instanceof OversizedImageTransformError),
35
- HTTP_UNPROCESSABLE_ENTITY,
36
- "This image is too large to be edited",
37
- );
38
- assert(
39
- !(error instanceof MediaAssetChangedError),
40
- HTTP_CONFLICT,
41
- "This image was changed by someone else in the meantime. Reload the page to see the latest version.",
42
- );
43
- throw error;
27
+ async function translatingTransformErrors<T>(work: Promise<T>): Promise<T> {
28
+ try {
29
+ return await work;
30
+ } catch (error) {
31
+ assert(
32
+ !(error instanceof AnimatedImageTransformError),
33
+ HTTP_UNPROCESSABLE_ENTITY,
34
+ "Animated images cannot be edited",
35
+ );
36
+ assert(
37
+ !(error instanceof OversizedImageTransformError),
38
+ HTTP_UNPROCESSABLE_ENTITY,
39
+ "This image is too large to be edited",
40
+ );
41
+ assert(
42
+ !(error instanceof MediaAssetChangedError),
43
+ HTTP_CONFLICT,
44
+ "This image was changed by someone else in the meantime. Reload the page to see the latest version.",
45
+ );
46
+ throw error;
47
+ }
44
48
  }
45
49
 
46
50
  async function requireEditableAsset(
@@ -106,8 +110,8 @@ export class MediaTransformController extends MediaApiController {
106
110
  const ops = assertValidation(body, (v) => transformSchema.parse(v));
107
111
  const context = await this.resolveContext();
108
112
  const asset = await requireEditableAsset(context, assetId);
109
- await applyImageTransform(context.assetModel, asset, ops).catch(
110
- translateTransformError,
113
+ await translatingTransformErrors(
114
+ applyImageTransform(context.assetModel, asset, ops),
111
115
  );
112
116
  const updated = await context.assetModel.get(assetId);
113
117
  assert(updated, HTTP_CONFLICT, "Asset disappeared during transform");
@@ -132,8 +136,8 @@ export class MediaTransformController extends MediaApiController {
132
136
  const ops = assertValidation(body, (v) => transformSchema.parse(v));
133
137
  const context = await this.resolveContext();
134
138
  const asset = await requireEditableAsset(context, assetId);
135
- const copy = await createEditedCopy(context, asset, ops).catch(
136
- translateTransformError,
139
+ const copy = await translatingTransformErrors(
140
+ createEditedCopy(context, asset, ops),
137
141
  );
138
142
  await this.record(context, {
139
143
  kind: "asset.upload",
@@ -156,8 +160,8 @@ export class MediaTransformController extends MediaApiController {
156
160
  HTTP_CONFLICT,
157
161
  "Asset has no original to revert to",
158
162
  );
159
- await revertImageTransform(context.assetModel, asset).catch(
160
- translateTransformError,
163
+ await translatingTransformErrors(
164
+ revertImageTransform(context.assetModel, asset),
161
165
  );
162
166
  const updated = await context.assetModel.get(assetId);
163
167
  assert(updated, HTTP_CONFLICT, "Asset disappeared during revert");
@@ -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(
@@ -4,6 +4,7 @@ import { tmpdir } from "node:os";
4
4
  import { join } from "node:path";
5
5
  import { defineConfig } from "@antelopejs/interface-core/config";
6
6
  import { MongoMemoryReplSet } from "mongodb-memory-server-core";
7
+ import { isString } from "../guards";
7
8
 
8
9
  const API_PORT = 5019;
9
10
  const LOCAL_BUILD_COMMAND = process.env.DMS_PREBUILT ? [] : ["pnpm build"];
@@ -13,16 +14,16 @@ const MONGO_BINARY_VERSION = "8.0.8";
13
14
  const SMTP_HOST = "127.0.0.1";
14
15
  const EPHEMERAL_PORT = 0;
15
16
  const TEST_SENDER = "dms-media@test.local";
16
- const SMTP_RESPONSES: Record<string, string> = {
17
- EHLO: "250-dms-media.test\r\n250 PIPELINING\r\n",
18
- HELO: "250 dms-media.test\r\n",
19
- MAIL: "250 OK\r\n",
20
- RCPT: "250 OK\r\n",
21
- DATA: "354 End data with <CR><LF>.<CR><LF>\r\n",
22
- RSET: "250 OK\r\n",
23
- NOOP: "250 OK\r\n",
24
- QUIT: "221 Bye\r\n",
25
- };
17
+ const SMTP_RESPONSES = new Map([
18
+ ["EHLO", "250-dms-media.test\r\n250 PIPELINING\r\n"],
19
+ ["HELO", "250 dms-media.test\r\n"],
20
+ ["MAIL", "250 OK\r\n"],
21
+ ["RCPT", "250 OK\r\n"],
22
+ ["DATA", "354 End data with <CR><LF>.<CR><LF>\r\n"],
23
+ ["RSET", "250 OK\r\n"],
24
+ ["NOOP", "250 OK\r\n"],
25
+ ["QUIT", "221 Bye\r\n"],
26
+ ]);
26
27
 
27
28
  interface SmtpConnectionState {
28
29
  pending: string;
@@ -47,7 +48,7 @@ function processSmtpLine(
47
48
  }
48
49
  const command = line.split(" ", 1)[0]?.toUpperCase() ?? "";
49
50
  state.isReadingData = command === "DATA";
50
- const response = SMTP_RESPONSES[command] ?? "250 OK\r\n";
51
+ const response = SMTP_RESPONSES.get(command) ?? "250 OK\r\n";
51
52
  if (command === "QUIT") socket.end(response);
52
53
  else socket.write(response);
53
54
  }
@@ -77,8 +78,7 @@ async function startSmtpFixture(): Promise<number> {
77
78
  });
78
79
  });
79
80
  const address = smtpServer.address();
80
- if (!address || typeof address === "string")
81
- throw new Error("Invalid SMTP address");
81
+ if (!address || isString(address)) throw new Error("Invalid SMTP address");
82
82
  return address.port;
83
83
  }
84
84
 
@@ -110,17 +110,21 @@ 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
- // No frontend server runs here: the dashboard URL is the API, whose
117
- // paths the front proxy serves unchanged.
116
+ /**
117
+ * No frontend server runs here: the dashboard URL is the API, whose
118
+ * paths the front proxy serves unchanged.
119
+ */
118
120
  clientBaseUrl: `http://127.0.0.1:${API_PORT}`,
119
121
  auth: {
120
122
  jwtSecret: JWT_SECRET,
121
123
  },
122
- // Outside development, which the test run is not, dms 0.10 refuses
123
- // to start without a render secret of its own.
124
+ /**
125
+ * Outside development, which the test run is not, dms 0.10 refuses
126
+ * to start without a render secret of its own.
127
+ */
124
128
  htmlRender: {
125
129
  serviceSecret: HTML_RENDER_SECRET,
126
130
  },
@@ -130,7 +134,7 @@ export default defineConfig({
130
134
  source: {
131
135
  type: "package",
132
136
  package: "@antelopejs/mongodb",
133
- version: "1.4.4",
137
+ version: "1.5.0",
134
138
  },
135
139
  },
136
140
  "auth-jwt": {
@@ -147,7 +151,7 @@ export default defineConfig({
147
151
  source: {
148
152
  type: "package",
149
153
  package: "@antelopejs/api",
150
- version: "1.4.0",
154
+ version: "1.5.0",
151
155
  },
152
156
  config: {
153
157
  servers: [{ protocol: "http", host: "127.0.0.1", port: API_PORT }],
@@ -158,7 +162,7 @@ export default defineConfig({
158
162
  source: {
159
163
  type: "package",
160
164
  package: "@antelopejs/file-storage-local",
161
- version: "0.1.12",
165
+ version: "0.1.13",
162
166
  },
163
167
  },
164
168
  nodemailer: {
@@ -1,5 +1,7 @@
1
1
  import { GetModel } from "@antelopejs/interface-database-decorators";
2
2
  import { DEFAULT_TENANT_ID } from "@antelopejs/interface-dms/constants";
3
+ import type { AxiosInstance } from "axios";
4
+ import { z } from "zod";
3
5
  import { parseFolderAcl, serializeAcl } from "../../acl";
4
6
  import { MediaFolderModel } from "../../db";
5
7
  import type { AclEntry } from "../../types";
@@ -23,3 +25,23 @@ export async function writeFolderAcl(
23
25
  json_acl: serializeAcl(entries ?? undefined) ?? "",
24
26
  });
25
27
  }
28
+
29
+ const folderNodeSchema = z.object({
30
+ id: z.string(),
31
+ name: z.string(),
32
+ parentId: z.string().nullable(),
33
+ binding: z.string().nullable(),
34
+ acceptsSubfolders: z.boolean(),
35
+ accepts: z.array(z.string()).nullable(),
36
+ });
37
+
38
+ export type FolderNode = z.infer<typeof folderNodeSchema>;
39
+
40
+ /** The folders `/api/media/tree` answers, checked against the fields the suites read. */
41
+ export async function fetchFolderNodes(
42
+ client: AxiosInstance,
43
+ ): Promise<FolderNode[]> {
44
+ const response = await client.get("/api/media/tree");
45
+ return z.object({ folders: z.array(folderNodeSchema) }).parse(response.data)
46
+ .folders;
47
+ }
@@ -1,5 +1,6 @@
1
1
  import { pageRoutePath } from "@antelopejs/interface-dms/page";
2
2
  import type { AxiosInstance } from "axios";
3
+ import { z } from "zod";
3
4
 
4
5
  const HTTP_OK = 200;
5
6
  const PAGE_LAYOUT_ROUTE = "/pagelayout";
@@ -15,10 +16,16 @@ export interface PageAccess {
15
16
  servedBlocks: number;
16
17
  }
17
18
 
18
- function countBlocks(components: unknown): number {
19
- if (Array.isArray(components)) return components.length;
20
- return Object.keys(components ?? {}).length;
21
- }
19
+ const layoutSchema = z.object({
20
+ components: z
21
+ .union([z.array(z.unknown()), z.record(z.unknown())])
22
+ .nullish()
23
+ .transform((components) =>
24
+ Array.isArray(components)
25
+ ? components.length
26
+ : Object.keys(components ?? {}).length,
27
+ ),
28
+ });
22
29
 
23
30
  /** Reads a page through its guarded route, its page entry and its by-slug layout. */
24
31
  export async function readPageAccess(
@@ -40,6 +47,6 @@ export async function readPageAccess(
40
47
  return {
41
48
  ownRouteStatus: ownRoute.status,
42
49
  hasAccess: page.data.route?.hasAccess === true,
43
- servedBlocks: countBlocks(layout.data.components),
50
+ servedBlocks: layoutSchema.parse(layout.data).components,
44
51
  };
45
52
  }
@@ -0,0 +1,326 @@
1
+ import type { AxiosInstance } from "axios";
2
+ import { assert, expect } from "chai";
3
+ import { RegisterAssetBinding } from "@antelopejs/interface-dms-media";
4
+ import {
5
+ configureMediaModule,
6
+ type DmsMediaConfig,
7
+ getMediaConfig,
8
+ } from "../../config";
9
+ import { MEDIA_PAGE_PERMISSION } from "../../pages/files";
10
+ import type { AclEntry } from "../../types";
11
+ import {
12
+ type UploadedAsset,
13
+ uploadPixelPng,
14
+ uploadTextAsset,
15
+ } from "../helpers/assets";
16
+ import { writeFolderAcl } from "../helpers/folders";
17
+ import { authorizedClient } from "../helpers/http";
18
+ import {
19
+ createRole,
20
+ type MemberSession,
21
+ registerMember,
22
+ } from "../helpers/members";
23
+ import { ensureOwnerSession } from "../helpers/owner";
24
+
25
+ export const HTTP_OK = 200;
26
+ export const HTTP_FOUND = 302;
27
+ export const HTTP_FORBIDDEN = 403;
28
+ export const HTTP_NOT_FOUND = 404;
29
+
30
+ export const LIBRARY_VIEW_PERMISSION = "warehouse.library.view";
31
+ export const LIBRARY_UPLOAD_PERMISSION = "warehouse.library.upload";
32
+ export const LIBRARY_MANAGE_PERMISSION = "warehouse.library.manage";
33
+ export const WAREHOUSE_EDIT_PERMISSION = "warehouse.table.edit";
34
+ export const WAREHOUSE_VIEW_PERMISSION = "warehouse.page";
35
+ export const STOCK_BINDING_ID = "warehouse.stock";
36
+ export const STOCK_FOLDER_NAME = "Warehouse stock";
37
+ export const CONTENT_ROOT_NAME = "Content";
38
+ export const ROTATE_QUARTER_TURN = 90;
39
+
40
+ export interface TreeFolderNode {
41
+ id: string;
42
+ name: string;
43
+ parentId: string | null;
44
+ shell: boolean;
45
+ bound: boolean;
46
+ visibility: string;
47
+ rights: { read: boolean; write: boolean; manage: boolean };
48
+ }
49
+
50
+ export interface TreeRootRights {
51
+ write: boolean;
52
+ manage: boolean;
53
+ }
54
+
55
+ export interface TreeResponse {
56
+ folders: TreeFolderNode[];
57
+ root: TreeRootRights;
58
+ }
59
+
60
+ export interface WorldRoles {
61
+ pageHolder: string;
62
+ viewer: string;
63
+ uploader: string;
64
+ folderManager: string;
65
+ clerk: string;
66
+ secretTeam: string;
67
+ latecomer: string;
68
+ }
69
+
70
+ export interface WorldSessions {
71
+ pageHolder: MemberSession;
72
+ viewer: MemberSession;
73
+ uploader: MemberSession;
74
+ folderManager: MemberSession;
75
+ clerk: MemberSession;
76
+ secretMember: MemberSession;
77
+ hybrid: MemberSession;
78
+ latecomer: MemberSession;
79
+ outsider: MemberSession;
80
+ }
81
+
82
+ export interface WorldFolders {
83
+ library: string;
84
+ restricted: string;
85
+ deep: string;
86
+ vault: string;
87
+ pocket: string;
88
+ publicZone: string;
89
+ readOnlyCorner: string;
90
+ depot: string;
91
+ curtain: string;
92
+ stock: string;
93
+ contentRoot: string;
94
+ }
95
+
96
+ export interface WorldAssets {
97
+ notes: UploadedAsset;
98
+ secretText: UploadedAsset;
99
+ secretPng: UploadedAsset;
100
+ libraryPng: UploadedAsset;
101
+ }
102
+
103
+ export async function fetchTree(client: AxiosInstance): Promise<TreeResponse> {
104
+ const response = await client.get("/api/media/tree");
105
+ expect(response.status, "tree").to.equal(HTTP_OK);
106
+ return response.data;
107
+ }
108
+
109
+ export function findByName(
110
+ tree: TreeResponse,
111
+ name: string,
112
+ ): TreeFolderNode | undefined {
113
+ return tree.folders.find((folder) => folder.name === name);
114
+ }
115
+
116
+ export function findById(
117
+ tree: TreeResponse,
118
+ id: string,
119
+ ): TreeFolderNode | undefined {
120
+ return tree.folders.find((folder) => folder.id === id);
121
+ }
122
+
123
+ /** The folder `id` of the tree, failing the test when the tree does not show it. */
124
+ export function requireById(tree: TreeResponse, id: string): TreeFolderNode {
125
+ const folder = findById(tree, id);
126
+ assert.isDefined(folder, `folder ${id}`);
127
+ return folder;
128
+ }
129
+
130
+ export async function createFolder(
131
+ owner: AxiosInstance,
132
+ name: string,
133
+ parentId?: string,
134
+ ): Promise<string> {
135
+ const response = await owner.post("/api/media/folders", { name, parentId });
136
+ expect(response.status, `create folder ${name}`).to.equal(HTTP_OK);
137
+ return response.data.id;
138
+ }
139
+
140
+ export function roleEntry(
141
+ roleId: string,
142
+ rights: AclEntry["rights"],
143
+ ): AclEntry {
144
+ return { subject: { kind: "role", id: roleId }, rights };
145
+ }
146
+
147
+ export function permissionEntry(
148
+ id: string,
149
+ rights: AclEntry["rights"],
150
+ ): AclEntry {
151
+ return { subject: { kind: "permission", id }, rights };
152
+ }
153
+
154
+ export function snapshotMediaConfig(): DmsMediaConfig {
155
+ const config = getMediaConfig();
156
+ return {
157
+ rootAcl: config.rootAcl,
158
+ storage: config.storage,
159
+ presets: [...config.presets.values()],
160
+ storageQuotaBytes: config.storageQuotaBytes,
161
+ };
162
+ }
163
+
164
+ export function grantLibraryAtRoot(config: DmsMediaConfig): void {
165
+ configureMediaModule({
166
+ ...config,
167
+ rootAcl: [
168
+ ...(config.rootAcl ?? []),
169
+ permissionEntry(LIBRARY_VIEW_PERMISSION, ["read"]),
170
+ permissionEntry(LIBRARY_UPLOAD_PERMISSION, ["write"]),
171
+ permissionEntry(LIBRARY_MANAGE_PERMISSION, ["manage"]),
172
+ ],
173
+ });
174
+ }
175
+
176
+ export async function createWorldRoles(): Promise<WorldRoles> {
177
+ const [
178
+ pageHolder,
179
+ viewer,
180
+ uploader,
181
+ folderManager,
182
+ clerk,
183
+ secretTeam,
184
+ latecomer,
185
+ ] = await Promise.all([
186
+ createRole("media-page-holder", [MEDIA_PAGE_PERMISSION]),
187
+ createRole("media-viewer", [LIBRARY_VIEW_PERMISSION]),
188
+ createRole("media-uploader", [
189
+ LIBRARY_VIEW_PERMISSION,
190
+ LIBRARY_UPLOAD_PERMISSION,
191
+ ]),
192
+ createRole("media-folder-manager", [
193
+ LIBRARY_VIEW_PERMISSION,
194
+ LIBRARY_MANAGE_PERMISSION,
195
+ ]),
196
+ createRole("warehouse-clerk", [WAREHOUSE_EDIT_PERMISSION]),
197
+ createRole("secret-team", []),
198
+ createRole("latecomer", []),
199
+ ]);
200
+ return {
201
+ pageHolder,
202
+ viewer,
203
+ uploader,
204
+ folderManager,
205
+ clerk,
206
+ secretTeam,
207
+ latecomer,
208
+ };
209
+ }
210
+
211
+ export async function registerWorldMembers(
212
+ roles: WorldRoles,
213
+ ): Promise<WorldSessions> {
214
+ return {
215
+ pageHolder: await registerMember("PageHolder", [roles.pageHolder]),
216
+ viewer: await registerMember("Viewer", [roles.viewer]),
217
+ uploader: await registerMember("Uploader", [roles.uploader]),
218
+ folderManager: await registerMember("FolderManager", [roles.folderManager]),
219
+ clerk: await registerMember("Clerk", [roles.clerk]),
220
+ secretMember: await registerMember("SecretMember", [roles.secretTeam]),
221
+ hybrid: await registerMember("Hybrid", [roles.viewer, roles.secretTeam]),
222
+ latecomer: await registerMember("Latecomer", [roles.latecomer]),
223
+ outsider: await registerMember("Outsider", []),
224
+ };
225
+ }
226
+
227
+ export async function buildWorldFolders(
228
+ owner: AxiosInstance,
229
+ secretTeamRoleId: string,
230
+ ): Promise<WorldFolders> {
231
+ const library = await createFolder(owner, "Library");
232
+ const restricted = await createFolder(owner, "Restricted");
233
+ const deep = await createFolder(owner, "Deep", restricted);
234
+ const vault = await createFolder(owner, "Vault");
235
+ const pocket = await createFolder(owner, "Pocket", vault);
236
+ const publicZone = await createFolder(owner, "PublicZone");
237
+ const readOnlyCorner = await createFolder(owner, "ReadOnlyCorner");
238
+ const depot = await createFolder(owner, "Depot");
239
+ const curtain = await createFolder(owner, "Curtain");
240
+ await writeFolderAcl(restricted, [roleEntry(secretTeamRoleId, ["write"])]);
241
+ await writeFolderAcl(vault, []);
242
+ await writeFolderAcl(pocket, [roleEntry(secretTeamRoleId, ["read"])]);
243
+ await writeFolderAcl(readOnlyCorner, [
244
+ permissionEntry(LIBRARY_VIEW_PERMISSION, ["read"]),
245
+ ]);
246
+ const flip = await owner.post(`/api/media/folders/${publicZone}/visibility`, {
247
+ visibility: "public",
248
+ });
249
+ expect(flip.status, "flip PublicZone public").to.equal(HTTP_OK);
250
+ const tree = await fetchTree(owner);
251
+ const stock = findByName(tree, STOCK_FOLDER_NAME);
252
+ const contentRoot = findByName(tree, CONTENT_ROOT_NAME);
253
+ assert.isDefined(stock, "provisioned stock folder");
254
+ assert.isDefined(contentRoot, "provisioned content root");
255
+ return {
256
+ library,
257
+ restricted,
258
+ deep,
259
+ vault,
260
+ pocket,
261
+ publicZone,
262
+ readOnlyCorner,
263
+ depot,
264
+ curtain,
265
+ stock: stock.id,
266
+ contentRoot: contentRoot.id,
267
+ };
268
+ }
269
+
270
+ export async function seedWorldAssets(
271
+ owner: AxiosInstance,
272
+ folders: WorldFolders,
273
+ ): Promise<WorldAssets> {
274
+ return {
275
+ notes: await uploadTextAsset(owner, folders.library, "notes.txt"),
276
+ secretText: await uploadTextAsset(owner, folders.restricted, "secret.txt"),
277
+ secretPng: await uploadPixelPng(owner, folders.restricted),
278
+ libraryPng: await uploadPixelPng(owner, folders.library),
279
+ };
280
+ }
281
+
282
+ /** The owner's client, once the world is set up. */
283
+ export let owner: AxiosInstance;
284
+ /** The roles of the world's members, by what they hold. */
285
+ export let roles: WorldRoles;
286
+ /** The world's members, signed in. */
287
+ export let sessions: WorldSessions;
288
+ /** The world's folders, by role in the tests. */
289
+ export let folders: WorldFolders;
290
+ /** The assets seeded into the world's folders. */
291
+ export let assets: WorldAssets;
292
+ let previousConfig: DmsMediaConfig;
293
+
294
+ /** Builds the world every permissions suite reads: root grant, binding, roles, members, folders and assets. */
295
+ export async function setUpPermissionsWorld(): Promise<void> {
296
+ previousConfig = snapshotMediaConfig();
297
+ grantLibraryAtRoot(previousConfig);
298
+ RegisterAssetBinding({
299
+ id: STOCK_BINDING_ID,
300
+ folderName: STOCK_FOLDER_NAME,
301
+ permissionMapping: { write: [WAREHOUSE_EDIT_PERMISSION] },
302
+ });
303
+ const session = await ensureOwnerSession();
304
+ owner = authorizedClient(session.accessToken);
305
+ roles = await createWorldRoles();
306
+ sessions = await registerWorldMembers(roles);
307
+ folders = await buildWorldFolders(owner, roles.secretTeam);
308
+ assets = await seedWorldAssets(owner, folders);
309
+ }
310
+
311
+ /** Deletes the world's top-level folders and puts the module's configuration back. */
312
+ export async function tearDownPermissionsWorld(): Promise<void> {
313
+ const roots = [
314
+ folders.library,
315
+ folders.restricted,
316
+ folders.vault,
317
+ folders.publicZone,
318
+ folders.readOnlyCorner,
319
+ folders.depot,
320
+ folders.curtain,
321
+ ];
322
+ for (const folderId of roots) {
323
+ await owner.delete(`/api/media/folders/${folderId}`);
324
+ }
325
+ configureMediaModule(previousConfig);
326
+ }
@@ -0,0 +1,12 @@
1
+ /** Replaces a prototype method with `wrap(original)` and returns the call that puts the original back. */
2
+ export function patchMethod<Owner extends object, Key extends keyof Owner>(
3
+ owner: Owner,
4
+ key: Key,
5
+ wrap: (original: Owner[Key]) => Owner[Key],
6
+ ): () => void {
7
+ const original = owner[key];
8
+ owner[key] = wrap(original);
9
+ return () => {
10
+ owner[key] = original;
11
+ };
12
+ }
@@ -3,9 +3,9 @@ import { GetModel } from "@antelopejs/interface-database-decorators";
3
3
  import { expect } from "chai";
4
4
  import { runSweepStaleDerivatives } from "../../crons/sweep-derivatives";
5
5
  import { type MediaAsset, MediaAssetModel } from "../../db";
6
+ import { patchMethod } from "../helpers/prototype";
6
7
 
7
8
  const TENANTS = ["stream-sweep-a", "stream-sweep-b"];
8
- type CursorFactory = (this: Query<unknown>) => AsyncIterable<unknown>;
9
9
 
10
10
  describe("[integration] streaming derivative sweep", () => {
11
11
  it("visits each scoped asset cursor and retains per-asset updates", async () => {
@@ -28,27 +28,25 @@ describe("[integration] streaming derivative sweep", () => {
28
28
  for (const [index, model] of models.entries()) {
29
29
  await model.insert([{ ...fixture, _id: TENANTS[index] }]);
30
30
  }
31
- const original = Object.getOwnPropertyDescriptor(
31
+ const visits: string[] = [];
32
+ const restore = patchMethod<Query<unknown>, "cursor">(
32
33
  Query.prototype,
33
34
  "cursor",
34
- )!;
35
- const readCursor = original.value as CursorFactory;
36
- const visits: string[] = [];
37
- Object.defineProperty(Query.prototype, "cursor", {
38
- ...original,
39
- value: async function* (this: Query<unknown>) {
40
- const table = this.stages.find((stage) => stage.stage === "table")
41
- ?.options?.id;
42
- if (table === "tenants") {
43
- for (const _id of TENANTS) yield { _id };
44
- return;
45
- }
46
- visits.push(
47
- this.stages.find((stage) => stage.stage === "instance")?.options?.id,
48
- );
49
- yield* readCursor.call(this);
50
- },
51
- });
35
+ (readCursor) =>
36
+ async function* (this: Query<unknown>) {
37
+ const table = this.stages.find((stage) => stage.stage === "table")
38
+ ?.options?.id;
39
+ if (table === "tenants") {
40
+ for (const _id of TENANTS) yield { _id };
41
+ return;
42
+ }
43
+ visits.push(
44
+ this.stages.find((stage) => stage.stage === "instance")?.options
45
+ ?.id,
46
+ );
47
+ yield* readCursor.call(this);
48
+ },
49
+ );
52
50
  try {
53
51
  await runSweepStaleDerivatives();
54
52
  expect(visits).to.deep.equal(TENANTS);
@@ -58,7 +56,7 @@ describe("[integration] streaming derivative sweep", () => {
58
56
  );
59
57
  }
60
58
  } finally {
61
- Object.defineProperty(Query.prototype, "cursor", original);
59
+ restore();
62
60
  for (const model of models) await model.table.delete().run();
63
61
  }
64
62
  });