@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.
- package/README.md +18 -3
- package/dist/acl/entries.js +1 -2
- package/dist/acl/entries.js.map +1 -1
- package/dist/bindings.js +1 -3
- package/dist/bindings.js.map +1 -1
- package/dist/db/models/mediaFolders.model.d.ts +0 -3
- package/dist/db/models/mediaFolders.model.js +0 -29
- package/dist/db/models/mediaFolders.model.js.map +1 -1
- package/dist/db/tables/mediaDeclarations.table.d.ts +0 -4
- package/dist/db/tables/mediaDeclarations.table.js +0 -16
- package/dist/db/tables/mediaDeclarations.table.js.map +1 -1
- package/dist/declared/assets.d.ts +0 -2
- package/dist/declared/assets.js +12 -140
- package/dist/declared/assets.js.map +1 -1
- package/dist/declared/folders.d.ts +1 -5
- package/dist/declared/folders.js +17 -82
- package/dist/declared/folders.js.map +1 -1
- package/dist/declared/index.d.ts +0 -2
- package/dist/declared/index.js +0 -2
- package/dist/declared/index.js.map +1 -1
- package/dist/declared/records.d.ts +4 -32
- package/dist/declared/records.js +6 -35
- package/dist/declared/records.js.map +1 -1
- package/dist/derivatives.js +14 -23
- package/dist/derivatives.js.map +1 -1
- package/dist/guards.d.ts +4 -0
- package/dist/guards.js +19 -0
- package/dist/guards.js.map +1 -0
- package/dist/implementations/interface-dms-media/index.d.ts +1 -3
- package/dist/implementations/interface-dms-media/index.js +0 -2
- package/dist/implementations/interface-dms-media/index.js.map +1 -1
- package/dist/library/activity.js +7 -5
- package/dist/library/activity.js.map +1 -1
- package/dist/library/batches.js +6 -3
- package/dist/library/batches.js.map +1 -1
- package/dist/library/events.js +4 -4
- package/dist/library/events.js.map +1 -1
- package/dist/library/module-readout.js +5 -2
- package/dist/library/module-readout.js.map +1 -1
- package/dist/library/realtime.js.map +1 -1
- package/dist/pages/activity.js +1 -1
- package/dist/pages/activity.js.map +1 -1
- package/dist/routes/media/assets.d.ts +1 -1
- package/dist/routes/media/assets.js +5 -5
- package/dist/routes/media/assets.js.map +1 -1
- package/dist/routes/media/bulk.js +17 -13
- package/dist/routes/media/bulk.js.map +1 -1
- package/dist/routes/media/delivery-headers.js +9 -9
- package/dist/routes/media/delivery-headers.js.map +1 -1
- package/dist/routes/media/delivery-stream.js +7 -21
- package/dist/routes/media/delivery-stream.js.map +1 -1
- package/dist/routes/media/delivery.js.map +1 -1
- package/dist/routes/media/manage.js.map +1 -1
- package/dist/routes/media/transform.js +13 -8
- package/dist/routes/media/transform.js.map +1 -1
- package/dist/routes/media/upload.js +2 -5
- package/dist/routes/media/upload.js.map +1 -1
- package/dist/test/antelope.test.js +17 -16
- package/dist/test/antelope.test.js.map +1 -1
- package/dist/test/helpers/folders.d.ts +27 -0
- package/dist/test/helpers/folders.js +15 -0
- package/dist/test/helpers/folders.js.map +1 -1
- package/dist/test/helpers/pages.js +10 -6
- package/dist/test/helpers/pages.js.map +1 -1
- package/dist/test/helpers/permissions-world.d.ts +98 -0
- package/dist/test/helpers/permissions-world.js +205 -0
- package/dist/test/helpers/permissions-world.js.map +1 -0
- package/dist/test/helpers/prototype.d.ts +1 -0
- package/dist/test/helpers/prototype.js +11 -0
- package/dist/test/helpers/prototype.js.map +1 -0
- package/dist/test/integration/derivative-sweep-query.test.js +13 -16
- package/dist/test/integration/derivative-sweep-query.test.js.map +1 -1
- package/dist/test/integration/folder-query.test.js +5 -9
- package/dist/test/integration/folder-query.test.js.map +1 -1
- package/dist/test/integration/media-bindings.test.js +2 -2
- package/dist/test/integration/media-bindings.test.js.map +1 -1
- package/dist/test/integration/media-cleanup.test.js +14 -17
- package/dist/test/integration/media-cleanup.test.js.map +1 -1
- package/dist/test/integration/media-declared-content.test.js +19 -318
- package/dist/test/integration/media-declared-content.test.js.map +1 -1
- package/dist/test/integration/media-delivery-editing.test.js +7 -5
- package/dist/test/integration/media-delivery-editing.test.js.map +1 -1
- package/dist/test/integration/media-delivery.test.js +19 -5
- package/dist/test/integration/media-delivery.test.js.map +1 -1
- package/dist/test/integration/media-explorer-writes.test.js +2 -2
- package/dist/test/integration/media-explorer-writes.test.js.map +1 -1
- package/dist/test/integration/media-guards.test.js +18 -7
- package/dist/test/integration/media-guards.test.js.map +1 -1
- package/dist/test/integration/media-library.test.js +1 -1
- package/dist/test/integration/media-library.test.js.map +1 -1
- package/dist/test/integration/media-linked-subfolders.test.js +6 -6
- package/dist/test/integration/media-linked-subfolders.test.js.map +1 -1
- package/dist/test/integration/media-member-access.test.js +2 -5
- package/dist/test/integration/media-member-access.test.js.map +1 -1
- package/dist/test/integration/media-permissions.test.js +142 -473
- package/dist/test/integration/media-permissions.test.js.map +1 -1
- package/dist/test/integration/media-project-field.test.js +3 -5
- package/dist/test/integration/media-project-field.test.js.map +1 -1
- package/dist/test/integration/media-search-query.test.js +11 -16
- package/dist/test/integration/media-search-query.test.js.map +1 -1
- package/dist/test/integration/media-storage-origin-unreachable.test.js +80 -0
- package/dist/test/integration/media-storage-origin-unreachable.test.js.map +1 -0
- package/dist/test/integration/media-upload-policy.test.js +2 -2
- package/dist/test/integration/media-upload-policy.test.js.map +1 -1
- package/dist/test/integration/permissions-management.d.ts +2 -0
- package/dist/test/integration/permissions-management.js +189 -0
- package/dist/test/integration/permissions-management.js.map +1 -0
- package/dist/test/unit/acl/entries.test.js +2 -1
- package/dist/test/unit/acl/entries.test.js.map +1 -1
- package/dist/test/unit/acl/resolver.test.js +10 -3
- package/dist/test/unit/acl/resolver.test.js.map +1 -1
- package/dist/test/unit/declared.test.js +0 -66
- package/dist/test/unit/declared.test.js.map +1 -1
- package/dist/test/unit/library/fixtures.d.ts +1 -1
- package/dist/test/unit/library/fixtures.js +6 -1
- package/dist/test/unit/library/fixtures.js.map +1 -1
- package/dist/test/unit/library/library.test.js +0 -1
- package/dist/test/unit/library/library.test.js.map +1 -1
- package/dist/test/unit/library/realtime.test.js +1 -0
- package/dist/test/unit/library/realtime.test.js.map +1 -1
- package/dist/test/unit/library/search-facets.test.js +2 -2
- package/dist/test/unit/library/search-facets.test.js.map +1 -1
- package/dist/test/unit/pages/toolbar.test.js +24 -7
- package/dist/test/unit/pages/toolbar.test.js.map +1 -1
- package/dist/test/unit/routes/dto.test.js +7 -6
- package/dist/test/unit/routes/dto.test.js.map +1 -1
- package/dist/test/unit/routes/file-page.test.js +5 -7
- package/dist/test/unit/routes/file-page.test.js.map +1 -1
- package/dist/test/unit/routes/preset-row.test.js +2 -1
- package/dist/test/unit/routes/preset-row.test.js.map +1 -1
- package/dist/transform.js +6 -6
- package/dist/transform.js.map +1 -1
- package/dist/upload-checks.d.ts +8 -2
- package/dist/upload-checks.js.map +1 -1
- package/dist/upload-policy.js +8 -8
- package/dist/upload-policy.js.map +1 -1
- package/dist/validation/declared.schema.d.ts +7 -36
- package/dist/validation/declared.schema.js +15 -20
- package/dist/validation/declared.schema.js.map +1 -1
- package/dist/validation/media.schema.d.ts +1 -1
- package/dist/validation/media.schema.js +2 -2
- package/dist/validation/media.schema.js.map +1 -1
- package/frontend-vue/app/build/imageEditor/editorShapes.ts +118 -0
- package/frontend-vue/app/build/imageEditor/useEditorSaving.ts +86 -0
- package/frontend-vue/app/build/library/libraryActions.ts +444 -0
- package/frontend-vue/app/build/library/libraryCore.ts +136 -0
- package/frontend-vue/app/components/ImageEditor.vue +22 -179
- package/frontend-vue/app/composables/library/useMediaLibrary.ts +3 -575
- package/frontend-vue/app/composables/useMediaApi.ts +21 -5
- package/frontend-vue/build/backend-boundary.ts +122 -0
- package/frontend-vue/dms.frontend.build.ts +3 -0
- package/frontend-vue/eslint.config.mjs +13 -0
- package/frontend-vue/package.json +3 -1
- package/frontend-vue/pnpm-lock.yaml +217 -61
- package/frontend-vue/tests/backend-boundary.test.ts +203 -0
- package/frontend-vue/tests/mediaPreviews.test.ts +39 -0
- package/package.json +10 -16
- package/skills/dms-media/SKILL.md +12 -24
- package/skills/dms-media/cases.json +38 -0
- package/src/acl/entries.ts +6 -4
- package/src/bindings.ts +3 -3
- package/src/db/models/mediaFolders.model.ts +0 -44
- package/src/db/tables/mediaDeclarations.table.ts +3 -19
- package/src/declared/assets.ts +19 -210
- package/src/declared/folders.ts +25 -138
- package/src/declared/index.ts +0 -2
- package/src/declared/records.ts +17 -90
- package/src/derivatives.ts +17 -23
- package/src/guards.ts +19 -0
- package/src/implementations/interface-dms-media/index.ts +1 -8
- package/src/library/activity.ts +17 -9
- package/src/library/batches.ts +12 -9
- package/src/library/events.ts +7 -4
- package/src/library/module-readout.ts +6 -2
- package/src/library/realtime.ts +5 -1
- package/src/library/zip.ts +1 -1
- package/src/pages/activity.ts +6 -2
- package/src/routes/media/assets.ts +4 -3
- package/src/routes/media/bulk.ts +16 -14
- package/src/routes/media/delivery-headers.ts +9 -12
- package/src/routes/media/delivery-stream.ts +13 -28
- package/src/routes/media/delivery.ts +4 -2
- package/src/routes/media/manage.ts +4 -6
- package/src/routes/media/transform.ts +27 -23
- package/src/routes/media/upload.ts +4 -6
- package/src/test/antelope.test.ts +25 -21
- package/src/test/helpers/folders.ts +22 -0
- package/src/test/helpers/pages.ts +12 -5
- package/src/test/helpers/permissions-world.ts +326 -0
- package/src/test/helpers/prototype.ts +12 -0
- package/src/test/integration/derivative-sweep-query.test.ts +19 -21
- package/src/test/integration/folder-query.test.ts +11 -11
- package/src/test/integration/media-bindings.test.ts +7 -7
- package/src/test/integration/media-cleanup.test.ts +25 -37
- package/src/test/integration/media-declared-content.test.ts +35 -379
- package/src/test/integration/media-delivery-editing.test.ts +11 -7
- package/src/test/integration/media-delivery.test.ts +29 -8
- package/src/test/integration/media-explorer-writes.test.ts +2 -7
- package/src/test/integration/media-guards.test.ts +21 -7
- package/src/test/integration/media-library.test.ts +1 -1
- package/src/test/integration/media-linked-subfolders.test.ts +12 -21
- package/src/test/integration/media-member-access.test.ts +5 -9
- package/src/test/integration/media-permissions.test.ts +56 -570
- package/src/test/integration/media-project-field.test.ts +5 -7
- package/src/test/integration/media-search-query.test.ts +16 -20
- package/src/test/integration/media-storage-origin-unreachable.test.ts +111 -0
- package/src/test/integration/media-upload-policy.test.ts +2 -8
- package/src/test/integration/permissions-management.ts +292 -0
- package/src/test/unit/acl/entries.test.ts +2 -1
- package/src/test/unit/acl/resolver.test.ts +19 -7
- package/src/test/unit/declared.test.ts +0 -87
- package/src/test/unit/library/fixtures.ts +9 -3
- package/src/test/unit/library/library.test.ts +1 -7
- package/src/test/unit/library/realtime.test.ts +2 -0
- package/src/test/unit/library/search-facets.test.ts +2 -2
- package/src/test/unit/pages/toolbar.test.ts +42 -17
- package/src/test/unit/routes/dto.test.ts +7 -6
- package/src/test/unit/routes/file-page.test.ts +10 -9
- package/src/test/unit/routes/preset-row.test.ts +2 -2
- package/src/transform.ts +6 -6
- package/src/upload-checks.ts +12 -3
- package/src/upload-policy.ts +8 -8
- package/src/validation/declared.schema.ts +17 -25
- package/src/validation/media.schema.ts +6 -6
- package/dist/declared/readiness.d.ts +0 -2
- package/dist/declared/readiness.js +0 -52
- package/dist/declared/readiness.js.map +0 -1
- package/dist/declared/retire.d.ts +0 -3
- package/dist/declared/retire.js +0 -118
- package/dist/declared/retire.js.map +0 -1
- package/dist/test/integration/media-declared-retire.test.js +0 -186
- package/dist/test/integration/media-declared-retire.test.js.map +0 -1
- package/frontend-vue/tests/engines.test.ts +0 -20
- package/frontend-vue/tests/locales.test.ts +0 -61
- package/src/declared/readiness.ts +0 -64
- package/src/declared/retire.ts +0 -206
- package/src/test/integration/media-declared-retire.test.ts +0 -257
- /package/dist/test/integration/{media-declared-retire.test.d.ts → media-storage-origin-unreachable.test.d.ts} +0 -0
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
import {
|
|
2
|
+
mkdirSync,
|
|
3
|
+
mkdtempSync,
|
|
4
|
+
realpathSync,
|
|
5
|
+
rmSync,
|
|
6
|
+
symlinkSync,
|
|
7
|
+
writeFileSync,
|
|
8
|
+
} from 'node:fs'
|
|
9
|
+
import { tmpdir } from 'node:os'
|
|
10
|
+
import { dirname, join } from 'node:path'
|
|
11
|
+
import { build as viteBuild, type Plugin } from 'vite'
|
|
12
|
+
import { afterAll, beforeAll, describe, expect, it } from 'vitest'
|
|
13
|
+
import { backendBoundary } from '../build/backend-boundary'
|
|
14
|
+
|
|
15
|
+
/** A scratch repository: the backend package, another package, and the frontend module inside the backend package. */
|
|
16
|
+
let repository: string
|
|
17
|
+
let frontend: string
|
|
18
|
+
|
|
19
|
+
function write(file: string, text: string): void {
|
|
20
|
+
mkdirSync(dirname(file), { recursive: true })
|
|
21
|
+
writeFileSync(file, text)
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
beforeAll(() => {
|
|
25
|
+
repository = realpathSync(
|
|
26
|
+
mkdtempSync(join(tmpdir(), 'dms-media-boundary-')),
|
|
27
|
+
)
|
|
28
|
+
const backend = join(repository, 'packages/dms-media')
|
|
29
|
+
frontend = join(backend, 'frontend-vue')
|
|
30
|
+
write(
|
|
31
|
+
join(backend, 'package.json'),
|
|
32
|
+
JSON.stringify({ name: '@antelopejs/dms-media' }),
|
|
33
|
+
)
|
|
34
|
+
write(join(backend, 'src/backend.ts'), 'export const secret = 1\n')
|
|
35
|
+
write(join(backend, 'src/nested/deep.ts'), 'export const deep = 6\n')
|
|
36
|
+
write(join(backend, 'dist/built.js'), 'export const built = 2\n')
|
|
37
|
+
write(join(backend, 'dist/src/nested.js'), 'export const nested = 4\n')
|
|
38
|
+
write(join(backend, 'srcx/sibling.ts'), 'export const sibling = 5\n')
|
|
39
|
+
write(
|
|
40
|
+
join(repository, 'packages/other/package.json'),
|
|
41
|
+
JSON.stringify({ name: 'other' }),
|
|
42
|
+
)
|
|
43
|
+
write(
|
|
44
|
+
join(repository, 'packages/other/src/shared.ts'),
|
|
45
|
+
'export const shared = 3\n',
|
|
46
|
+
)
|
|
47
|
+
mkdirSync(frontend, { recursive: true })
|
|
48
|
+
symlinkSync(join(backend, 'src/backend.ts'), join(frontend, 'linked.ts'))
|
|
49
|
+
})
|
|
50
|
+
|
|
51
|
+
afterAll(() => {
|
|
52
|
+
rmSync(repository, { recursive: true, force: true })
|
|
53
|
+
})
|
|
54
|
+
|
|
55
|
+
interface BuildOptions {
|
|
56
|
+
extra?: Plugin[]
|
|
57
|
+
alias?: Record<string, string>
|
|
58
|
+
preserveSymlinks?: boolean
|
|
59
|
+
external?: string[]
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/** Builds a frontend entry made of `source` with the boundary plugin, and returns the bundled code. */
|
|
63
|
+
async function build(
|
|
64
|
+
source: string,
|
|
65
|
+
options: BuildOptions = {},
|
|
66
|
+
): Promise<string> {
|
|
67
|
+
write(join(frontend, 'entry.ts'), source)
|
|
68
|
+
const result = await viteBuild({
|
|
69
|
+
root: frontend,
|
|
70
|
+
configFile: false,
|
|
71
|
+
logLevel: 'silent',
|
|
72
|
+
plugins: [backendBoundary(), ...(options.extra ?? [])],
|
|
73
|
+
resolve: {
|
|
74
|
+
alias: options.alias ?? {},
|
|
75
|
+
preserveSymlinks: options.preserveSymlinks ?? false,
|
|
76
|
+
},
|
|
77
|
+
build: {
|
|
78
|
+
write: false,
|
|
79
|
+
rollupOptions: { external: options.external ?? [] },
|
|
80
|
+
lib: { entry: join(frontend, 'entry.ts'), formats: ['es'] },
|
|
81
|
+
},
|
|
82
|
+
})
|
|
83
|
+
return JSON.stringify(result)
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/** A plugin that answers the import `request` with the module id `id`. */
|
|
87
|
+
function resolver(request: string, id: string): Plugin {
|
|
88
|
+
return {
|
|
89
|
+
name: 'test-resolver',
|
|
90
|
+
resolveId: (source) => (source === request ? { id } : null),
|
|
91
|
+
load: (loaded) =>
|
|
92
|
+
loaded === id || loaded.startsWith('\0') ? 'export default 1\n' : null,
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
const backendFile = () =>
|
|
97
|
+
join(repository, 'packages/dms-media/src/backend.ts')
|
|
98
|
+
|
|
99
|
+
describe('the backend boundary of the frontend build', () => {
|
|
100
|
+
it('fails on an import of the backend source, naming both files', async () => {
|
|
101
|
+
const failure = build(
|
|
102
|
+
'import { secret } from "../src/backend.ts"\nexport { secret }\n',
|
|
103
|
+
)
|
|
104
|
+
await expect(failure).rejects.toThrow(/Backend boundary/)
|
|
105
|
+
await expect(failure).rejects.toThrow(join(frontend, 'entry.ts'))
|
|
106
|
+
await expect(failure).rejects.toThrow(backendFile())
|
|
107
|
+
})
|
|
108
|
+
|
|
109
|
+
it('fails on a file deeper under the backend source', async () => {
|
|
110
|
+
await expect(
|
|
111
|
+
build('import { deep } from "../src/nested/deep.ts"\nexport { deep }\n'),
|
|
112
|
+
).rejects.toThrow(/Backend boundary/)
|
|
113
|
+
})
|
|
114
|
+
|
|
115
|
+
it('fails on an alias that points into the backend source', async () => {
|
|
116
|
+
await expect(
|
|
117
|
+
build(
|
|
118
|
+
'import { secret } from "@backend/backend.ts"\nexport { secret }\n',
|
|
119
|
+
{
|
|
120
|
+
alias: { '@backend': join(repository, 'packages/dms-media/src') },
|
|
121
|
+
},
|
|
122
|
+
),
|
|
123
|
+
).rejects.toThrow(/Backend boundary/)
|
|
124
|
+
})
|
|
125
|
+
|
|
126
|
+
it('fails on a symlink to the backend source that the resolver returns', async () => {
|
|
127
|
+
await expect(
|
|
128
|
+
build('import { secret } from "./linked.ts"\nexport { secret }\n', {
|
|
129
|
+
extra: [resolver('./linked.ts', join(frontend, 'linked.ts'))],
|
|
130
|
+
preserveSymlinks: true,
|
|
131
|
+
}),
|
|
132
|
+
).rejects.toThrow(/Backend boundary/)
|
|
133
|
+
})
|
|
134
|
+
|
|
135
|
+
it('fails on an id that names the backend source with a query or a hash', async () => {
|
|
136
|
+
for (const suffix of ['?raw', '#fragment']) {
|
|
137
|
+
await expect(
|
|
138
|
+
build('import secret from "virtual-backend"\nexport { secret }\n', {
|
|
139
|
+
extra: [resolver('virtual-backend', `${backendFile()}${suffix}`)],
|
|
140
|
+
}),
|
|
141
|
+
).rejects.toThrow(/Backend boundary/)
|
|
142
|
+
}
|
|
143
|
+
})
|
|
144
|
+
|
|
145
|
+
it('fails on a backend source import declared external', async () => {
|
|
146
|
+
await expect(
|
|
147
|
+
build('import { secret } from "../src/backend.ts"\nexport { secret }\n', {
|
|
148
|
+
external: [backendFile()],
|
|
149
|
+
}),
|
|
150
|
+
).rejects.toThrow(/Backend boundary/)
|
|
151
|
+
})
|
|
152
|
+
|
|
153
|
+
it('fails on a worker entry under the backend source', async () => {
|
|
154
|
+
await expect(
|
|
155
|
+
build(
|
|
156
|
+
'export const worker = new Worker(new URL("../src/backend.ts", import.meta.url), { type: "module" })\n',
|
|
157
|
+
),
|
|
158
|
+
).rejects.toThrow(/Backend boundary/)
|
|
159
|
+
})
|
|
160
|
+
|
|
161
|
+
it('fails on a worker of the frontend that imports the backend source', async () => {
|
|
162
|
+
write(
|
|
163
|
+
join(frontend, 'worker.ts'),
|
|
164
|
+
'import { secret } from "../src/backend.ts"\npostMessage(secret)\n',
|
|
165
|
+
)
|
|
166
|
+
await expect(
|
|
167
|
+
build(
|
|
168
|
+
'export const worker = new Worker(new URL("./worker.ts", import.meta.url), { type: "module" })\n',
|
|
169
|
+
),
|
|
170
|
+
).rejects.toThrow(/Backend boundary/)
|
|
171
|
+
})
|
|
172
|
+
|
|
173
|
+
it('passes the built output, a virtual module and the source of another package', async () => {
|
|
174
|
+
expect(
|
|
175
|
+
await build(
|
|
176
|
+
'import { built } from "../dist/built.js"\nexport { built }\n',
|
|
177
|
+
),
|
|
178
|
+
).toMatch(/built/)
|
|
179
|
+
expect(
|
|
180
|
+
await build('import value from "virtual:thing"\nexport { value }\n', {
|
|
181
|
+
extra: [resolver('virtual:thing', '\0virtual:thing')],
|
|
182
|
+
}),
|
|
183
|
+
).toMatch(/value/)
|
|
184
|
+
expect(
|
|
185
|
+
await build(
|
|
186
|
+
'import { shared } from "../../other/src/shared.ts"\nexport { shared }\n',
|
|
187
|
+
),
|
|
188
|
+
).toMatch(/shared/)
|
|
189
|
+
})
|
|
190
|
+
|
|
191
|
+
it('passes a sibling folder named like src and a src folder inside dist', async () => {
|
|
192
|
+
expect(
|
|
193
|
+
await build(
|
|
194
|
+
'import { sibling } from "../srcx/sibling.ts"\nexport { sibling }\n',
|
|
195
|
+
),
|
|
196
|
+
).toMatch(/sibling/)
|
|
197
|
+
expect(
|
|
198
|
+
await build(
|
|
199
|
+
'import { nested } from "../dist/src/nested.js"\nexport { nested }\n',
|
|
200
|
+
),
|
|
201
|
+
).toMatch(/nested/)
|
|
202
|
+
})
|
|
203
|
+
})
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { afterEach, expect, it, vi } from 'vitest'
|
|
2
|
+
import { useMediaApi } from '../app/composables/useMediaApi'
|
|
3
|
+
|
|
4
|
+
interface PreviewRequest {
|
|
5
|
+
method: string
|
|
6
|
+
query: { ids: string[] }
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
afterEach(() => vi.unstubAllGlobals())
|
|
10
|
+
|
|
11
|
+
it('reads 150 previews in GET batches of 100 and 50 and merges both responses', async () => {
|
|
12
|
+
const ids = Array.from(
|
|
13
|
+
{ length: 150 },
|
|
14
|
+
(_, index) => `00000000-0000-4000-8000-${String(index).padStart(12, '0')}`,
|
|
15
|
+
)
|
|
16
|
+
const authFetch = vi.fn((_url: string, request: PreviewRequest) =>
|
|
17
|
+
Promise.resolve({
|
|
18
|
+
previews: Object.fromEntries(
|
|
19
|
+
request.query.ids.map((id) => [id, `https://media.test/${id}`]),
|
|
20
|
+
),
|
|
21
|
+
}),
|
|
22
|
+
)
|
|
23
|
+
vi.stubGlobal('useAuthFetch', () => ({ $authFetch: authFetch }))
|
|
24
|
+
|
|
25
|
+
const result = await useMediaApi().previews(ids)
|
|
26
|
+
|
|
27
|
+
expect(authFetch).toHaveBeenCalledTimes(2)
|
|
28
|
+
expect(authFetch).toHaveBeenNthCalledWith(1, '/api/media/previews', {
|
|
29
|
+
method: 'GET',
|
|
30
|
+
query: { ids: ids.slice(0, 100) },
|
|
31
|
+
})
|
|
32
|
+
expect(authFetch).toHaveBeenNthCalledWith(2, '/api/media/previews', {
|
|
33
|
+
method: 'GET',
|
|
34
|
+
query: { ids: ids.slice(100) },
|
|
35
|
+
})
|
|
36
|
+
expect(result.previews).toEqual(
|
|
37
|
+
Object.fromEntries(ids.map((id) => [id, `https://media.test/${id}`])),
|
|
38
|
+
)
|
|
39
|
+
})
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antelopejs/dms-media",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.2",
|
|
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",
|
|
@@ -47,10 +47,7 @@
|
|
|
47
47
|
"dev:frontend": "pnpm frontend:dev",
|
|
48
48
|
"frontend:dev": "cd playground && pnpm frontend:dev",
|
|
49
49
|
"dev": "ajs project run -w -p playground",
|
|
50
|
-
"
|
|
51
|
-
"lint": "oxlint && oxfmt --check . && pnpm --dir frontend-vue lint && antelopejs-check-interface-ranges",
|
|
52
|
-
"typecheck": "tsc --noEmit",
|
|
53
|
-
"format": "oxfmt . && pnpm --dir frontend-vue format",
|
|
50
|
+
"typecheck": "pnpm --filter @antelopejs/interface-dms-media build && tsc --noEmit",
|
|
54
51
|
"test": "[ -n \"$DMS_PREBUILT\" ] || pnpm run build && ajs module test .",
|
|
55
52
|
"test:unit": "[ -n \"$DMS_PREBUILT\" ] || pnpm run build && DMS_MEDIA_TEST_DIR=dist/test/unit ajs module test .",
|
|
56
53
|
"test:integration": "[ -n \"$DMS_PREBUILT\" ] || pnpm run build && DMS_MEDIA_TEST_DIR=dist/test/integration ajs module test .",
|
|
@@ -66,20 +63,20 @@
|
|
|
66
63
|
"@antelopejs/interface-api": ">=0.0.15 <1.0.0",
|
|
67
64
|
"@antelopejs/interface-api-util": ">=0.1.3 <1.0.0",
|
|
68
65
|
"@antelopejs/interface-core": ">=0.2.4 <1.0.0",
|
|
69
|
-
"@antelopejs/interface-database": ">=0.1.
|
|
70
|
-
"@antelopejs/interface-database-decorators": ">=0.1.
|
|
71
|
-
"@antelopejs/interface-dms": ">=0.
|
|
66
|
+
"@antelopejs/interface-database": ">=0.1.11 <1.0.0",
|
|
67
|
+
"@antelopejs/interface-database-decorators": ">=0.1.10 <1.0.0",
|
|
68
|
+
"@antelopejs/interface-dms": ">=0.9.0 <1.0.0",
|
|
72
69
|
"@antelopejs/interface-dms-media": ">=0.3.0 <0.4.0",
|
|
73
|
-
"@antelopejs/interface-file-storage": ">=0.1.
|
|
70
|
+
"@antelopejs/interface-file-storage": ">=0.1.6 <1.0.0",
|
|
74
71
|
"node-cron": "^4.2.1",
|
|
75
72
|
"sharp": "^0.34.4",
|
|
76
73
|
"zod": "~3.24.2"
|
|
77
74
|
},
|
|
78
75
|
"devDependencies": {
|
|
79
|
-
"@antelopejs/core": ">=1.17.
|
|
80
|
-
"@antelopejs/dms": ">=0.
|
|
81
|
-
"@antelopejs/dms-frontend": "0.
|
|
82
|
-
"@antelopejs/tooling-configs": "
|
|
76
|
+
"@antelopejs/core": ">=1.17.1 <2",
|
|
77
|
+
"@antelopejs/dms": ">=0.11.0 <1.0.0",
|
|
78
|
+
"@antelopejs/dms-frontend": "0.9.1",
|
|
79
|
+
"@antelopejs/tooling-configs": "^0.2.12",
|
|
83
80
|
"@types/chai": "^4.3.20",
|
|
84
81
|
"@types/mocha": "^10",
|
|
85
82
|
"@types/node": "^24.0.0",
|
|
@@ -88,9 +85,6 @@
|
|
|
88
85
|
"chai": "^4.5.0",
|
|
89
86
|
"knip": "^6.34.0",
|
|
90
87
|
"mongodb-memory-server-core": "^11.0.1",
|
|
91
|
-
"oxfmt": "^0.66.0",
|
|
92
|
-
"oxlint": "1.81.0",
|
|
93
|
-
"oxlint-tsgolint": "^7.0.2001",
|
|
94
88
|
"release-it": "^19.2.4",
|
|
95
89
|
"release-it-changelogen": "^0.1.0",
|
|
96
90
|
"rimraf": "^6.1.3",
|
|
@@ -32,6 +32,7 @@ Every data block carries `realtimeTopic: MEDIA_LIBRARY_TOPIC`; custom components
|
|
|
32
32
|
Put the field in a DMS `Form` block of a backend-declared page; no custom Vue is needed.
|
|
33
33
|
|
|
34
34
|
```typescript
|
|
35
|
+
import { Form } from "@antelopejs/interface-dms/base";
|
|
35
36
|
import { AssetType } from "@antelopejs/interface-dms-media"; // in the module's dependencies
|
|
36
37
|
|
|
37
38
|
static form = Form({
|
|
@@ -57,10 +58,11 @@ static form = Form({
|
|
|
57
58
|
## Ship content as code
|
|
58
59
|
|
|
59
60
|
```typescript
|
|
61
|
+
import { Hook, RegisterHook } from "@antelopejs/interface-dms/hooks";
|
|
60
62
|
import { EnsureMediaFolder, ImportMediaAsset } from "@antelopejs/interface-dms-media";
|
|
61
63
|
|
|
62
|
-
//
|
|
63
|
-
|
|
64
|
+
// Once per tenant, when it is created (registered from construct()).
|
|
65
|
+
RegisterHook(Hook.TENANT_BEING_PROVISIONED, async ({ tenantId }) => {
|
|
64
66
|
await EnsureMediaFolder({ tenantId, key: "helio.procedures", name: "Procedures", visibility: "private" });
|
|
65
67
|
await ImportMediaAsset({
|
|
66
68
|
tenantId,
|
|
@@ -69,31 +71,17 @@ export async function declareMedia(tenantId: string): Promise<void> {
|
|
|
69
71
|
name: "Roof safety checklist.pdf",
|
|
70
72
|
mimetype: "application/pdf",
|
|
71
73
|
source: { filePath: "/abs/path.pdf" }, // or { bytes: buffer }, or { load: () => bytes }
|
|
72
|
-
version: "2026-10-17", // optional: while unchanged, the source is not read
|
|
73
74
|
});
|
|
74
|
-
}
|
|
75
|
+
});
|
|
75
76
|
```
|
|
76
77
|
|
|
77
|
-
- Required `tenantId` in types and runtime: omitted/empty/whitespace-only rejects before writes. No fallback
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
- `start()` is process-global: use it for registration or explicitly scoped global work, not implicit default content.
|
|
85
|
-
Never await declarations in `construct()`. A required tenant does not prove authorization or committed provisioning.
|
|
86
|
-
The prepayment `TENANT_BEING_PROVISIONED` hook has no automatic replay/compensation and is not durable `created`.
|
|
87
|
-
- Deployment refresh/backfill is separate: enumerate trusted tenants, require `IsWorkspaceProvisioningCommitted(tenantId)`,
|
|
88
|
-
fail closed on lookup errors, and coordinate writers. Idempotent APIs do not make all effects exactly-once.
|
|
89
|
-
See the [canonical lifecycle guidance](https://dms.antelopejs.com/docs/modules/media/reference#new-saas-tenants-application-owned-durable-lifecycle).
|
|
90
|
-
- Generated files: `source: { load }` is called only when the bytes are needed; with a `version` changed whenever the
|
|
91
|
-
bytes change, an unchanged file is not read or generated again on reload. Files a member changed or deleted are never read.
|
|
92
|
-
- Dropped content: `PruneMediaDeclarations({ tenantId, prefix: "helio.", keep: declaredKeys })` after declaring retires
|
|
93
|
-
the namespace's other keys (files, then deepest folders); `RetireMediaDeclaration({ tenantId, kind, key })` one key.
|
|
94
|
-
Removed only while still as declared (folders only when empty), else `preserved` and handed to members; never a cascade.
|
|
95
|
-
- Never undoes a member: a row changed since its last declaration is `preserved`, a deleted one stays `deleted`;
|
|
96
|
-
only a row still exactly as declared is refreshed. Parents before children, folders before files (await each).
|
|
78
|
+
- Required `tenantId` in types and runtime: omitted/empty/whitespace-only rejects before writes. No fallback.
|
|
79
|
+
Idempotent per tenant + kind + key. Returns `{ status: "created" | "kept", id }`.
|
|
80
|
+
- Call from `Hook.TENANT_BEING_PROVISIONED` (the DMS fires it for `default` on the start that creates it, after
|
|
81
|
+
`DATABASE_INITIALIZED`; dms-saas for each workspace). Never from `start()` / `DATABASE_INITIALIZED`, never awaited in `construct()`.
|
|
82
|
+
- Written once: a key declared before is `kept` without reading its source. No refresh, no retirement, no `version`:
|
|
83
|
+
the content belongs to the members. Parents before children, folders before files (await each).
|
|
84
|
+
- `source: { load }` is called only when the file is created. Bytes are written with `WriteFile` (no HTTP round trip).
|
|
97
85
|
- Same rules as the dashboard (names, unique sibling folders, allowed and field types, quota, decodable images); errors
|
|
98
86
|
name the key (`Media file 'helio.x': ...`). Never write `media_folders` / `media_assets` directly.
|
|
99
87
|
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"cases": [
|
|
4
|
+
{
|
|
5
|
+
"id": "media-image-field",
|
|
6
|
+
"area": "modules",
|
|
7
|
+
"style": "clean",
|
|
8
|
+
"prompt": "Add an image upload field for the product photos in the product form.",
|
|
9
|
+
"expect": {
|
|
10
|
+
"skills": ["dms-media"],
|
|
11
|
+
"acceptable": ["dms-pages", "dms", "dms-best-practices"],
|
|
12
|
+
"mustMention": ["AssetType"]
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"id": "media-upload-refused-casual",
|
|
17
|
+
"area": "modules",
|
|
18
|
+
"style": "casual",
|
|
19
|
+
"prompt": "uploads get refused on the media folder, cors maybe?",
|
|
20
|
+
"expect": {
|
|
21
|
+
"skills": ["dms-media"],
|
|
22
|
+
"acceptable": ["dms"]
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"id": "dms-media-avoid-form-page",
|
|
27
|
+
"area": "modules",
|
|
28
|
+
"style": "clean",
|
|
29
|
+
"prompt": "Build an articles admin page with a Form block for the title and body and a TableView listing the articles.",
|
|
30
|
+
"expect": {
|
|
31
|
+
"skills": ["dms-pages"],
|
|
32
|
+
"acceptable": ["dms-best-practices", "dms"],
|
|
33
|
+
"mustMention": ["RegisterPage", "TableView"],
|
|
34
|
+
"avoid": ["dms-media"]
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
]
|
|
38
|
+
}
|
package/src/acl/entries.ts
CHANGED
|
@@ -2,15 +2,17 @@ import { Logging } from "@antelopejs/interface-core/logging";
|
|
|
2
2
|
import type { MediaFolder } from "../db/tables";
|
|
3
3
|
import type { AclEntry } from "../types";
|
|
4
4
|
|
|
5
|
-
/**
|
|
5
|
+
/**
|
|
6
|
+
* Fails closed: an unreadable stored ACL grants nothing instead of inheriting.
|
|
7
|
+
* A stored ACL that is not JSON is handled like one that is not an array:
|
|
8
|
+
* logged, then read as empty.
|
|
9
|
+
*/
|
|
6
10
|
export function parseFolderAcl(folder: MediaFolder): AclEntry[] | undefined {
|
|
7
11
|
if (!folder.json_acl) return undefined;
|
|
8
12
|
try {
|
|
9
13
|
const parsed = JSON.parse(folder.json_acl);
|
|
10
14
|
if (Array.isArray(parsed)) return parsed as AclEntry[];
|
|
11
|
-
} catch {
|
|
12
|
-
// Handled below with the non-array case.
|
|
13
|
-
}
|
|
15
|
+
} catch {}
|
|
14
16
|
Logging.Warn(
|
|
15
17
|
`Media folder '${folder._id}' has an unreadable ACL; treating it as empty.`,
|
|
16
18
|
);
|
package/src/bindings.ts
CHANGED
|
@@ -149,9 +149,9 @@ async function provisionTenant(
|
|
|
149
149
|
if (registeredBindings.size > 0) {
|
|
150
150
|
const folders = await folderModel.getAll();
|
|
151
151
|
const foldersByBinding = new Map(
|
|
152
|
-
folders
|
|
153
|
-
.
|
|
154
|
-
|
|
152
|
+
folders.flatMap((folder): [string, MediaFolder][] =>
|
|
153
|
+
folder.binding ? [[folder.binding, folder]] : [],
|
|
154
|
+
),
|
|
155
155
|
);
|
|
156
156
|
const contentRootId = await ensureContentRoot(
|
|
157
157
|
folderModel,
|
|
@@ -1,54 +1,10 @@
|
|
|
1
1
|
import { BasicDataModel } from "@antelopejs/interface-database-decorators";
|
|
2
|
-
import { triggerEvent } from "@antelopejs/interface-database-decorators/modifiers/common";
|
|
3
2
|
import { MEDIA_FOLDERS_TABLE_NAME, MediaFolder } from "../tables";
|
|
4
3
|
|
|
5
4
|
export class MediaFolderModel extends BasicDataModel(
|
|
6
5
|
MediaFolder,
|
|
7
6
|
MEDIA_FOLDERS_TABLE_NAME,
|
|
8
7
|
) {
|
|
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
|
-
|
|
52
8
|
async getChildren(parentId: string): Promise<MediaFolder[]> {
|
|
53
9
|
return this.getBy("parentId", parentId);
|
|
54
10
|
}
|
|
@@ -13,9 +13,9 @@ export const MEDIA_DECLARATIONS_TABLE_NAME = "media_declarations";
|
|
|
13
13
|
export type MediaDeclarationKind = "folder" | "asset";
|
|
14
14
|
|
|
15
15
|
/**
|
|
16
|
-
* A folder or file a module declared as code, by the key it chose: what
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* A folder or file a module declared as code, by the key it chose: what lets
|
|
17
|
+
* a later declaration name it (a declared parent folder) and a repeated
|
|
18
|
+
* declaration leave it as it is.
|
|
19
19
|
*/
|
|
20
20
|
@RegisterTable(MEDIA_DECLARATIONS_TABLE_NAME, TENANT_SCHEMA_NAME)
|
|
21
21
|
export class MediaDeclaration extends Table {
|
|
@@ -40,20 +40,4 @@ export class MediaDeclaration extends Table {
|
|
|
40
40
|
/** Id of the declared folder or asset row. */
|
|
41
41
|
@Field("string")
|
|
42
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
43
|
}
|