@antelopejs/dms-media 0.4.1 → 0.5.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 (123) hide show
  1. package/README.md +4 -3
  2. package/dist/bindings.d.ts +4 -1
  3. package/dist/bindings.js +21 -0
  4. package/dist/bindings.js.map +1 -1
  5. package/dist/db/models/index.d.ts +1 -0
  6. package/dist/db/models/index.js +1 -0
  7. package/dist/db/models/index.js.map +1 -1
  8. package/dist/db/models/mediaAssets.model.d.ts +1 -0
  9. package/dist/db/models/mediaAssets.model.js +19 -0
  10. package/dist/db/models/mediaAssets.model.js.map +1 -1
  11. package/dist/db/models/mediaDeclarations.model.d.ts +24 -0
  12. package/dist/db/models/mediaDeclarations.model.js +13 -0
  13. package/dist/db/models/mediaDeclarations.model.js.map +1 -0
  14. package/dist/db/models/mediaFolders.model.d.ts +3 -0
  15. package/dist/db/models/mediaFolders.model.js +29 -0
  16. package/dist/db/models/mediaFolders.model.js.map +1 -1
  17. package/dist/db/tables/index.d.ts +1 -0
  18. package/dist/db/tables/index.js +1 -0
  19. package/dist/db/tables/index.js.map +1 -1
  20. package/dist/db/tables/mediaDeclarations.table.d.ts +15 -0
  21. package/dist/db/tables/mediaDeclarations.table.js +65 -0
  22. package/dist/db/tables/mediaDeclarations.table.js.map +1 -0
  23. package/dist/declared/assets.d.ts +4 -0
  24. package/dist/declared/assets.js +269 -0
  25. package/dist/declared/assets.js.map +1 -0
  26. package/dist/declared/folders.d.ts +10 -0
  27. package/dist/declared/folders.js +154 -0
  28. package/dist/declared/folders.js.map +1 -0
  29. package/dist/declared/index.d.ts +5 -0
  30. package/dist/declared/index.js +22 -0
  31. package/dist/declared/index.js.map +1 -0
  32. package/dist/declared/readiness.d.ts +2 -0
  33. package/dist/declared/readiness.js +52 -0
  34. package/dist/declared/readiness.js.map +1 -0
  35. package/dist/declared/records.d.ts +46 -0
  36. package/dist/declared/records.js +94 -0
  37. package/dist/declared/records.js.map +1 -0
  38. package/dist/declared/retire.d.ts +3 -0
  39. package/dist/declared/retire.js +118 -0
  40. package/dist/declared/retire.js.map +1 -0
  41. package/dist/implementations/interface-dms-media/index.d.ts +5 -0
  42. package/dist/implementations/interface-dms-media/index.js +5 -0
  43. package/dist/implementations/interface-dms-media/index.js.map +1 -1
  44. package/dist/library/events.d.ts +2 -1
  45. package/dist/library/events.js.map +1 -1
  46. package/dist/routes/media/assets.js +19 -4
  47. package/dist/routes/media/assets.js.map +1 -1
  48. package/dist/routes/media/context.d.ts +1 -1
  49. package/dist/routes/media/context.js.map +1 -1
  50. package/dist/routes/media/dto.d.ts +1 -0
  51. package/dist/routes/media/dto.js +3 -1
  52. package/dist/routes/media/dto.js.map +1 -1
  53. package/dist/routes/media/folders.d.ts +6 -0
  54. package/dist/routes/media/folders.js +25 -13
  55. package/dist/routes/media/folders.js.map +1 -1
  56. package/dist/routes/media/upload.d.ts +1 -1
  57. package/dist/routes/media/upload.js +26 -58
  58. package/dist/routes/media/upload.js.map +1 -1
  59. package/dist/test/integration/media-declared-content.test.d.ts +1 -0
  60. package/dist/test/integration/media-declared-content.test.js +705 -0
  61. package/dist/test/integration/media-declared-content.test.js.map +1 -0
  62. package/dist/test/integration/media-declared-retire.test.d.ts +1 -0
  63. package/dist/test/integration/media-declared-retire.test.js +186 -0
  64. package/dist/test/integration/media-declared-retire.test.js.map +1 -0
  65. package/dist/test/integration/media-delivery-editing.test.js +26 -0
  66. package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
  67. package/dist/test/integration/media-linked-subfolders.test.d.ts +1 -0
  68. package/dist/test/integration/media-linked-subfolders.test.js +192 -0
  69. package/dist/test/integration/media-linked-subfolders.test.js.map +1 -0
  70. package/dist/test/unit/declared.test.d.ts +1 -0
  71. package/dist/test/unit/declared.test.js +118 -0
  72. package/dist/test/unit/declared.test.js.map +1 -0
  73. package/dist/upload-checks.d.ts +18 -0
  74. package/dist/upload-checks.js +75 -0
  75. package/dist/upload-checks.js.map +1 -0
  76. package/dist/validation/declared.schema.d.ts +187 -0
  77. package/dist/validation/declared.schema.js +78 -0
  78. package/dist/validation/declared.schema.js.map +1 -0
  79. package/dist/validation/media.schema.d.ts +3 -0
  80. package/dist/validation/media.schema.js +12 -12
  81. package/dist/validation/media.schema.js.map +1 -1
  82. package/frontend-vue/app/components/dialogs/DestinationDialog.vue +1 -1
  83. package/frontend-vue/app/components/dialogs/MoveDialog.vue +2 -2
  84. package/frontend-vue/app/components/explorer/ExplorerContent.vue +1 -1
  85. package/frontend-vue/app/components/explorer/ExplorerToolbar.vue +1 -1
  86. package/frontend-vue/app/components/shared/AssetThumb.vue +3 -1
  87. package/frontend-vue/app/composables/library/explorerMenus.ts +1 -1
  88. package/frontend-vue/app/composables/library/useExplorerCommands.ts +1 -1
  89. package/frontend-vue/app/composables/library/useExplorerDrop.ts +1 -1
  90. package/frontend-vue/app/types/media.ts +3 -1
  91. package/frontend-vue/package.json +1 -1
  92. package/frontend-vue/tests/serverRender.test.ts +2 -1
  93. package/package.json +2 -2
  94. package/skills/dms-media/SKILL.md +50 -4
  95. package/src/bindings.ts +28 -0
  96. package/src/db/models/index.ts +1 -0
  97. package/src/db/models/mediaAssets.model.ts +25 -0
  98. package/src/db/models/mediaDeclarations.model.ts +19 -0
  99. package/src/db/models/mediaFolders.model.ts +44 -0
  100. package/src/db/tables/index.ts +1 -0
  101. package/src/db/tables/mediaDeclarations.table.ts +59 -0
  102. package/src/declared/assets.ts +446 -0
  103. package/src/declared/folders.ts +273 -0
  104. package/src/declared/index.ts +5 -0
  105. package/src/declared/readiness.ts +64 -0
  106. package/src/declared/records.ts +185 -0
  107. package/src/declared/retire.ts +206 -0
  108. package/src/implementations/interface-dms-media/index.ts +10 -0
  109. package/src/library/events.ts +4 -1
  110. package/src/routes/media/assets.ts +34 -5
  111. package/src/routes/media/context.ts +1 -1
  112. package/src/routes/media/dto.ts +6 -2
  113. package/src/routes/media/folders.ts +47 -21
  114. package/src/routes/media/upload.ts +50 -121
  115. package/src/test/integration/media-declared-content.test.ts +844 -0
  116. package/src/test/integration/media-declared-retire.test.ts +257 -0
  117. package/src/test/integration/media-delivery-editing.test.ts +45 -0
  118. package/src/test/integration/media-linked-subfolders.test.ts +256 -0
  119. package/src/test/unit/declared.test.ts +158 -0
  120. package/src/upload-checks.ts +126 -0
  121. package/src/validation/declared.schema.ts +104 -0
  122. package/src/validation/media.schema.ts +7 -6
  123. package/frontend-vue/pnpm-workspace.yaml +0 -2
@@ -25,7 +25,7 @@ const isScoped = computed(() => Boolean(layout.scopeFolderId))
25
25
  const canCreateFolder = computed(() => {
26
26
  if (library.mode !== 'browse') return false
27
27
  const folder = library.currentFolder.value
28
- if (folder) return folder.rights.manage && !folder.bound
28
+ if (folder) return folder.rights.manage && folder.acceptsSubfolders
29
29
  return location.value.kind === 'root' && Boolean(library.tree.tree.value?.root.manage)
30
30
  })
31
31
  const canUpload = computed(() => {
@@ -25,6 +25,8 @@ watch(
25
25
  const source = computed(() =>
26
26
  hasFailed.value ? undefined : previews.previewOf(props.asset.id),
27
27
  )
28
+ // A vector is mostly a logo: cropping it to the tile would cut its ends off.
29
+ const effectiveFit = computed(() => (props.asset.typeGroup === 'vector' ? 'contain' : props.fit))
28
30
  const extension = computed(() => extensionOf(props.asset).toUpperCase())
29
31
  const sizeClass = computed(
30
32
  () =>
@@ -49,7 +51,7 @@ const iconClass = computed(() => (props.size === 'xs' || props.size === 'sm' ? '
49
51
  :src="source"
50
52
  :alt="asset.alt || ''"
51
53
  class="size-full"
52
- :class="fit === 'cover' ? 'object-cover' : 'object-contain'"
54
+ :class="effectiveFit === 'cover' ? 'object-cover' : 'object-contain'"
53
55
  loading="lazy"
54
56
  draggable="false"
55
57
  @error="hasFailed = true"
@@ -129,7 +129,7 @@ export function createExplorerMenus(library: MediaLibrary, commands: MenuCommand
129
129
  ...(folder.rights.write
130
130
  ? [{ label: t('dms_media.actions.upload_here'), icon: 'i-ph-upload-simple', onSelect: afterMenu(() => commands.upload(folder.id)) }]
131
131
  : []),
132
- ...(folder.rights.manage && !folder.bound
132
+ ...(folder.rights.manage && folder.acceptsSubfolders
133
133
  ? [{ label: t('dms_media.actions.new_subfolder'), icon: 'i-ph-folder-plus', onSelect: afterMenu(() => commands.newFolder(folder.id)) }]
134
134
  : []),
135
135
  {
@@ -80,7 +80,7 @@ export function useExplorerCommands(library: MediaLibrary, handlers: ExplorerHan
80
80
  async function newFolder(parentId?: string | null): Promise<void> {
81
81
  const parentKey = parentId === undefined ? (library.currentFolder.value?.id ?? null) : parentId
82
82
  const parent = parentKey ? library.tree.foldersById.value.get(parentKey) : undefined
83
- if (parent?.bound) return showLocked(parent)
83
+ if (parent && !parent.acceptsSubfolders) return showLocked(parent)
84
84
  await nameDialog.open({
85
85
  title: t('dms_media.dialogs.new_folder.title'),
86
86
  description: parent
@@ -53,7 +53,7 @@ export function createExplorerDrop(library: MediaLibrary, upload: DropUpload) {
53
53
  const dragged = draggedFolder.value
54
54
  if (!dragged || dragged.parentId === (target?.id ?? null)) return false
55
55
  if (!target) return Boolean(library.tree.tree.value?.root.manage)
56
- if (!target.rights.manage || target.bound || target.id === dragged.id) return false
56
+ if (!target.rights.manage || !target.acceptsSubfolders || target.id === dragged.id) return false
57
57
  return !library.tree.descendantsOf(dragged.id).some((child) => child.id === target.id)
58
58
  }
59
59
 
@@ -32,7 +32,9 @@ export interface MediaFolder {
32
32
  bound: boolean
33
33
  binding: string | null
34
34
  link: FolderLink | null
35
- /** Mimetype patterns the linked field accepts; null when unlinked or unrestricted. */
35
+ /** Whether new folders may go inside: false for a linked folder unless its binding allows subfolders. */
36
+ acceptsSubfolders: boolean
37
+ /** Mimetype patterns the field the folder feeds accepts; null when unlinked or unrestricted. */
36
38
  accepts: string[] | null
37
39
  visibility: FolderVisibility
38
40
  hasOwnAcl: boolean
@@ -6,7 +6,7 @@
6
6
  "main": "./dms.frontend.ts",
7
7
  "packageManager": "pnpm@10.6.5",
8
8
  "engines": {
9
- "@antelopejs/dms-frontend": ">=0.6.3 <0.7.0"
9
+ "@antelopejs/dms-frontend": ">=0.6.3 <0.8.0"
10
10
  },
11
11
  "scripts": {
12
12
  "dev": "pnpm --dir ../playground frontend:dev",
@@ -24,6 +24,7 @@ const folder = (id: string, name: string): MediaFolder => ({
24
24
  parentId: null,
25
25
  shell: false,
26
26
  bound: false,
27
+ acceptsSubfolders: true,
27
28
  binding: null,
28
29
  link: null,
29
30
  accepts: null,
@@ -91,7 +92,7 @@ function backend({ url }: BackendRead): unknown {
91
92
  case '/api/media/folders/catalog/assets':
92
93
  return { assets: FILES, total: FILES.length, facets: {} }
93
94
  case '/api/media/bindings/demo.cover/folder':
94
- return { folder: { ...folder('covers', 'Demo covers'), bound: true }, maxUploadBytes: 1000, allowedMimetypes: [] }
95
+ return { folder: { ...folder('covers', 'Demo covers'), bound: true, acceptsSubfolders: false }, maxUploadBytes: 1000, allowedMimetypes: [] }
95
96
  default:
96
97
  return {}
97
98
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antelopejs/dms-media",
3
- "version": "0.4.1",
3
+ "version": "0.5.1",
4
4
  "description": "Media library for the AntelopeJS DMS: uploads, folders with per-folder permissions, image sizes and light editing, with a Finder-style explorer.",
5
5
  "keywords": [
6
6
  "antelopejs",
@@ -69,7 +69,7 @@
69
69
  "@antelopejs/interface-database": ">=0.1.10 <1.0.0",
70
70
  "@antelopejs/interface-database-decorators": ">=0.1.9 <1.0.0",
71
71
  "@antelopejs/interface-dms": ">=0.7.2 <1.0.0",
72
- "@antelopejs/interface-dms-media": ">=0.2.2 <0.3.0",
72
+ "@antelopejs/interface-dms-media": ">=0.3.0 <0.4.0",
73
73
  "@antelopejs/interface-file-storage": ">=0.1.4 <1.0.0",
74
74
  "node-cron": "^4.2.1",
75
75
  "sharp": "^0.34.4",
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: dms-media
3
- description: Media library with the @antelopejs/dms-media module of the AntelopeJS DMS. Use when installing or configuring dms-media, adding an image or file field to a DMS form with AssetType, binding a field to a folder and its permissions (permissionsFromPage, permissionMapping, rootAcl), serving images in a given size (presets, /media URLs), or debugging uploads refused by CORS, type, quota or folder rights.
3
+ description: Media library with the @antelopejs/dms-media module of the AntelopeJS DMS. Use when installing or configuring dms-media, adding an image or file field to a DMS form with AssetType, binding a field to a folder and its permissions (permissionsFromPage, permissionMapping, rootAcl), shipping folders and files as code (EnsureMediaFolder, ImportMediaAsset, seeding demo content), serving images in a given size (presets, /media URLs), or debugging uploads refused by CORS, type, quota or folder rights.
4
4
  icon: i-lucide-images
5
5
  category: content
6
6
  tags: [media, assets, uploads, images, permissions, dms-module]
@@ -15,8 +15,8 @@ https://dms.antelopejs.com/docs/modules/media.
15
15
 
16
16
  ## Setup
17
17
 
18
- - Media 0.4 requires `@antelopejs/dms` >=0.9 (interface-dms 0.7, renderer `@antelopejs/dms-frontend` 0.6); 0.3 is the
19
- DMS 0.8 line.
18
+ - Media 0.5 requires `@antelopejs/dms` >=0.9 (interface-dms >=0.7.2, renderer `@antelopejs/dms-frontend` 0.6)
19
+ and `@antelopejs/interface-dms-media` >=0.3.0 <0.4.0. Media 0.4 uses media interface 0.2; Media 0.3 is the DMS 0.8 line.
20
20
  - `ajs project modules add @antelopejs/dms-media`, plus an `interface-file-storage` module (`file-storage-local`).
21
21
  - Set the storage's `baseUrl` and the module's `publicBaseUrl` to `${@api.API_PUBLIC_BASE_URL}`, and list every
22
22
  dashboard origin in the api module's `cors.allowedOrigins`: the browser `PUT`s files straight to the storage.
@@ -45,9 +45,54 @@ static form = Form({
45
45
  - The value is an asset id (an array with `multiple`). The `binding` provisions a linked folder under `Content`
46
46
  (idempotent on `id`); its rights derive from the page's permission. Explicit `permissionMapping`
47
47
  (`{ read: [...], write: [...] }`) wins per right.
48
+ - Per-record layout under a field's folder (one folder per project): `binding: { id, subfolders: true }`, then
49
+ `EnsureMediaFolder({ tenantId, key, name, parent: { binding: id } })` or owner-created subfolders.
48
50
  - Only an explicit role grant of the page counts: `memberAccess` / `publicAccess` pages grant no folder right.
49
51
  - Rights: `manage` ⇒ `write` ⇒ `read`. Upload needs `write`; folder structure needs `manage`; visibility is owner-only.
50
52
 
53
+ ## Ship content as code
54
+
55
+ ```typescript
56
+ import { EnsureMediaFolder, ImportMediaAsset } from "@antelopejs/interface-dms-media";
57
+
58
+ // Called by the application's lifecycle with a trusted, explicit tenant.
59
+ export async function declareMedia(tenantId: string): Promise<void> {
60
+ await EnsureMediaFolder({ tenantId, key: "helio.procedures", name: "Procedures", visibility: "private" });
61
+ await ImportMediaAsset({
62
+ tenantId,
63
+ key: "helio.procedures.roof",
64
+ folder: { key: "helio.procedures" }, // or { binding: "projects.cover" } for a field's folder
65
+ name: "Roof safety checklist.pdf",
66
+ mimetype: "application/pdf",
67
+ source: { filePath: "/abs/path.pdf" }, // or { bytes: buffer }, or { load: () => bytes }
68
+ version: "2026-10-17", // optional: while unchanged, the source is not read
69
+ });
70
+ }
71
+ ```
72
+
73
+ - Required `tenantId` in types and runtime: omitted/empty/whitespace-only rejects before writes. No fallback;
74
+ an explicitly chosen `DEFAULT_TENANT_ID` remains valid. Idempotent per tenant + kind + key. Returns
75
+ `{ status: "created" | "updated" | "unchanged" | "preserved" | "deleted", id? }`.
76
+ - New SaaS tenants: the application registers `RegisterWorkspaceLifecycleConsumer` from
77
+ `@antelopejs/interface-dms-saas/workspace-lifecycle` for `created` before startup reconciliation.
78
+ Delivery follows preparation/payment and is at least once: deduplicate `operationId`, persist resource links
79
+ before returning a receipt, and recover incomplete attempts. Media does not register it or depend on SaaS.
80
+ - `start()` is process-global: use it for registration or explicitly scoped global work, not implicit default content.
81
+ Never await declarations in `construct()`. A required tenant does not prove authorization or committed provisioning.
82
+ The prepayment `TENANT_BEING_PROVISIONED` hook has no automatic replay/compensation and is not durable `created`.
83
+ - Deployment refresh/backfill is separate: enumerate trusted tenants, require `IsWorkspaceProvisioningCommitted(tenantId)`,
84
+ fail closed on lookup errors, and coordinate writers. Idempotent APIs do not make all effects exactly-once.
85
+ See the [canonical lifecycle guidance](https://dms.antelopejs.com/docs/modules/media/reference#new-saas-tenants-application-owned-durable-lifecycle).
86
+ - Generated files: `source: { load }` is called only when the bytes are needed; with a `version` changed whenever the
87
+ bytes change, an unchanged file is not read or generated again on reload. Files a member changed or deleted are never read.
88
+ - Dropped content: `PruneMediaDeclarations({ tenantId, prefix: "helio.", keep: declaredKeys })` after declaring retires
89
+ the namespace's other keys (files, then deepest folders); `RetireMediaDeclaration({ tenantId, kind, key })` one key.
90
+ Removed only while still as declared (folders only when empty), else `preserved` and handed to members; never a cascade.
91
+ - Never undoes a member: a row changed since its last declaration is `preserved`, a deleted one stays `deleted`;
92
+ only a row still exactly as declared is refreshed. Parents before children, folders before files (await each).
93
+ - Same rules as the dashboard (names, unique sibling folders, allowed and field types, quota, decodable images); errors
94
+ name the key (`Media file 'helio.x': ...`). Never write `media_folders` / `media_assets` directly.
95
+
51
96
  ## Delivery
52
97
 
53
98
  - `GET /media/<assetId>/<filename>` and `/media/<assetId>/<presetId>/<filename>` (302 to a signed URL; stable
@@ -59,6 +104,7 @@ static form = Form({
59
104
  ## Gotchas
60
105
 
61
106
  - Upload refusals answer `{ reason }`: `type_not_allowed` / `field_type` (415), `quota` (413), `invalid_image` (422).
62
- - Linked folders cannot be renamed, moved, deleted, re-ACLed or hold subfolders (403 `bound_parent`).
107
+ - Linked folders cannot be renamed, moved, deleted or re-ACLed; they hold subfolders only with `subfolders: true`
108
+ on the binding (otherwise 403 `bound_parent`). Subfolders inherit the folder's ACL and the field's accepted types.
63
109
  - Names are unique per folder, case aside (409 `name_taken`).
64
110
  - Editing an image changes it everywhere it is used; there is no per-usage crop and no usage tracking yet.
package/src/bindings.ts CHANGED
@@ -27,6 +27,34 @@ export function getRegisteredBindings(): AssetBindingConfig[] {
27
27
  return [...registeredBindings.values()];
28
28
  }
29
29
 
30
+ /** Whether the folder linked to `bindingId` may hold subfolders: opt-in per binding. */
31
+ export function bindingHoldsSubfolders(bindingId: string): boolean {
32
+ return registeredBindings.get(bindingId)?.subfolders === true;
33
+ }
34
+
35
+ /** Whether new folders may go under `folder`: any unlinked folder, a linked one when its binding allows. */
36
+ export function holdsSubfolders(folder: MediaFolder): boolean {
37
+ return !folder.binding || bindingHoldsSubfolders(folder.binding);
38
+ }
39
+
40
+ /**
41
+ * The binding whose field a folder's files feed: its own, or the nearest
42
+ * linked ancestor's, since the subfolders a binding allows hold files for the
43
+ * same field.
44
+ */
45
+ export function feedingBinding(
46
+ folder: MediaFolder | undefined,
47
+ foldersById: ReadonlyMap<string, MediaFolder>,
48
+ ): string | undefined {
49
+ if (!folder) return undefined;
50
+ if (folder.binding) return folder.binding;
51
+ for (const ancestorId of [...folder.path].reverse()) {
52
+ const binding = foldersById.get(ancestorId)?.binding;
53
+ if (binding) return binding;
54
+ }
55
+ return undefined;
56
+ }
57
+
30
58
  interface BindingFingerprintEntry {
31
59
  id: string;
32
60
  folderName?: string;
@@ -1,4 +1,5 @@
1
1
  export * from "./mediaAssets.model";
2
+ export * from "./mediaDeclarations.model";
2
3
  export * from "./mediaEvents.model";
3
4
  export * from "./mediaFavorites.model";
4
5
  export * from "./mediaFolders.model";
@@ -7,6 +7,8 @@ import { MEDIA_ASSETS_TABLE_NAME, MediaAsset } from "../tables";
7
7
  export interface MediaMutationOptions {
8
8
  /** False for bookkeeping writes that must not move `updatedAt`. */
9
9
  touchesAsset?: boolean;
10
+ /** Declarations must also preserve metadata edits, which do not advance mediaRevision. */
11
+ preserveDetails?: boolean;
10
12
  }
11
13
 
12
14
  function mutationApplied(outcome: AtomicMutationOutcome): boolean {
@@ -28,6 +30,29 @@ export class MediaAssetModel extends BasicDataModel(
28
30
  const instance = MediaAssetModel.fromPlainData(patch);
29
31
  if (options.touchesAsset !== false) triggerEvent(instance, "update");
30
32
  const payload = MediaAssetModel.toDatabase(instance);
33
+ if (options.preserveDetails) {
34
+ const count = await this.table
35
+ .filter((row) =>
36
+ row
37
+ .key("_id")
38
+ .eq(expected._id)
39
+ .and(row.key("mediaRevision").eq(expected.mediaRevision))
40
+ .and(row.key("isDeleting").default(false).eq(false))
41
+ .and(row.key("name").eq(expected.name))
42
+ .and(row.key("folderId").eq(expected.folderId))
43
+ .and(
44
+ row
45
+ .key("alt")
46
+ .default("")
47
+ .eq(expected.alt || ""),
48
+ )
49
+ .and(row.key("visibility").eq(expected.visibility))
50
+ .and(row.key("storageKey").eq(expected.storageKey)),
51
+ )
52
+ .update({ ...payload, mediaRevision: randomUUID() })
53
+ .run();
54
+ return count === 1;
55
+ }
31
56
  const outcome = await this.table
32
57
  .atomicMutation(expected._id, {
33
58
  type: "update",
@@ -0,0 +1,19 @@
1
+ import { BasicDataModel } from "@antelopejs/interface-database-decorators";
2
+ import {
3
+ MEDIA_DECLARATIONS_TABLE_NAME,
4
+ MediaDeclaration,
5
+ type MediaDeclarationKind,
6
+ } from "../tables";
7
+
8
+ export class MediaDeclarationModel extends BasicDataModel(
9
+ MediaDeclaration,
10
+ MEDIA_DECLARATIONS_TABLE_NAME,
11
+ ) {
12
+ async findByKey(
13
+ kind: MediaDeclarationKind,
14
+ key: string,
15
+ ): Promise<MediaDeclaration | undefined> {
16
+ const rows = await this.getBy("key", key);
17
+ return rows.find((row) => row.kind === kind);
18
+ }
19
+ }
@@ -1,10 +1,54 @@
1
1
  import { BasicDataModel } from "@antelopejs/interface-database-decorators";
2
+ import { triggerEvent } from "@antelopejs/interface-database-decorators/modifiers/common";
2
3
  import { MEDIA_FOLDERS_TABLE_NAME, MediaFolder } from "../tables";
3
4
 
4
5
  export class MediaFolderModel extends BasicDataModel(
5
6
  MediaFolder,
6
7
  MEDIA_FOLDERS_TABLE_NAME,
7
8
  ) {
9
+ /** The row of `expected` while its editable state and path are still as observed. */
10
+ private whileAsObserved(expected: MediaFolder) {
11
+ return this.table.filter((row) =>
12
+ row
13
+ .key("_id")
14
+ .eq(expected._id)
15
+ .and(row.key("name").eq(expected.name))
16
+ .and(
17
+ row
18
+ .key("parentId")
19
+ .default("")
20
+ .eq(expected.parentId || ""),
21
+ )
22
+ .and(row.key("path").eq(expected.path))
23
+ .and(row.key("visibility").eq(expected.visibility))
24
+ .and(
25
+ row
26
+ .key("json_acl")
27
+ .default("")
28
+ .eq(expected.json_acl || ""),
29
+ ),
30
+ );
31
+ }
32
+
33
+ /** Applies a declaration only while the observed editable state and path still match. */
34
+ async compareDeclared(
35
+ expected: MediaFolder,
36
+ patch: Partial<MediaFolder>,
37
+ ): Promise<boolean> {
38
+ const instance = MediaFolderModel.fromPlainData(patch);
39
+ triggerEvent(instance, "update");
40
+ const count = await this.whileAsObserved(expected)
41
+ .update(MediaFolderModel.toDatabase(instance))
42
+ .run();
43
+ return count === 1;
44
+ }
45
+
46
+ /** Deletes a retired declaration's folder only while the observed editable state and path still match. */
47
+ async deleteDeclared(expected: MediaFolder): Promise<boolean> {
48
+ const count = await this.whileAsObserved(expected).delete().run();
49
+ return count === 1;
50
+ }
51
+
8
52
  async getChildren(parentId: string): Promise<MediaFolder[]> {
9
53
  return this.getBy("parentId", parentId);
10
54
  }
@@ -1,4 +1,5 @@
1
1
  export * from "./mediaAssets.table";
2
+ export * from "./mediaDeclarations.table";
2
3
  export * from "./mediaEvents.table";
3
4
  export * from "./mediaFavorites.table";
4
5
  export * from "./mediaFolders.table";
@@ -0,0 +1,59 @@
1
+ import {
2
+ CreationTime,
3
+ Field,
4
+ Index,
5
+ RegisterTable,
6
+ Table,
7
+ UpdateTime,
8
+ } from "@antelopejs/interface-database-decorators";
9
+ import { TENANT_SCHEMA_NAME } from "@antelopejs/interface-dms/constants";
10
+
11
+ export const MEDIA_DECLARATIONS_TABLE_NAME = "media_declarations";
12
+
13
+ export type MediaDeclarationKind = "folder" | "asset";
14
+
15
+ /**
16
+ * A folder or file a module declared as code, by the key it chose: what it
17
+ * last declared, and the state it left the row in, to tell a member's change
18
+ * from content still as declared.
19
+ */
20
+ @RegisterTable(MEDIA_DECLARATIONS_TABLE_NAME, TENANT_SCHEMA_NAME)
21
+ export class MediaDeclaration extends Table {
22
+ @Field("string")
23
+ declare _id: string;
24
+
25
+ @CreationTime()
26
+ @Field("date")
27
+ declare createdAt: Date;
28
+
29
+ @UpdateTime()
30
+ @Field("date")
31
+ declare updatedAt: Date;
32
+
33
+ @Field("string")
34
+ declare kind: MediaDeclarationKind;
35
+
36
+ @Index()
37
+ @Field("string")
38
+ declare key: string;
39
+
40
+ /** Id of the declared folder or asset row. */
41
+ @Field("string")
42
+ declare targetId: string;
43
+
44
+ /** Hash of the last declaration applied. */
45
+ @Field("string")
46
+ declare declaredHash: string;
47
+
48
+ /** Hash of the row's member-editable state right after that declaration was applied. */
49
+ @Field("string")
50
+ declare appliedHash: string;
51
+
52
+ /** Hash of the declared file's bytes; absent for a folder. */
53
+ @Field("string")
54
+ declare contentHash?: string;
55
+
56
+ /** Caller's version of those bytes; empty when the last declaration gave none. */
57
+ @Field("string")
58
+ declare version?: string;
59
+ }