static-cms/core/src/mediaLibrary.ts

53 lines
1.8 KiB
TypeScript
Raw Normal View History

/**
* This module is currently concerned only with external media libraries
* registered via `registerMediaLibrary`.
*/
2022-10-20 11:57:30 -04:00
import once from 'lodash/once';
import { configFailed } from './actions/config';
feat: bundle assets with content (#2958) * fix(media_folder_relative): use collection name in unpublished entry * refactor: pass arguments as object to AssetProxy ctor * feat: support media folders per collection * feat: resolve media files path based on entry path * fix: asset public path resolving * refactor: introduce typescript for AssetProxy * refactor: code cleanup * refactor(asset-proxy): add tests,switch to typescript,extract arguments * refactor: typescript for editorialWorkflow * refactor: add typescript for media library actions * refactor: fix type error on map set * refactor: move locale selector into reducer * refactor: add typescript for entries actions * refactor: remove duplication between asset store and media lib * feat: load assets from backend using API * refactor(github): add typescript, cache media files * fix: don't load media URL if already loaded * feat: add media folder config to collection * fix: load assets from API when not in UI state * feat: load entry media files when opening media library * fix: editorial workflow draft media files bug fixes * test(unit): fix unit tests * fix: editor control losing focus * style: add eslint object-shorthand rule * test(cypress): re-record mock data * fix: fix non github backends, large media * test: uncomment only in tests * fix(backend-test): add missing displayURL property * test(e2e): add media library tests * test(e2e): enable visual testing * test(e2e): add github backend media library tests * test(e2e): add git-gateway large media tests * chore: post rebase fixes * test: fix tests * test: fix tests * test(cypress): fix tests * docs: add media_folder docs * test(e2e): add media library delete test * test(e2e): try and fix image comparison on CI * ci: reduce test machines from 9 to 8 * test: add reducers and selectors unit tests * test(e2e): disable visual regression testing for now * test: add getAsset unit tests * refactor: use Asset class component instead of hooks * build: don't inline source maps * test: add more media path tests
2019-12-18 18:16:02 +02:00
import { createMediaLibrary, insertMedia } from './actions/mediaLibrary';
2022-10-20 11:57:30 -04:00
import { getMediaLibrary } from './lib/registry';
import { store } from './store';
2022-10-20 11:57:30 -04:00
import type { MediaLibrary, MediaLibraryExternalLibrary } from './interface';
import type { RootState } from './store';
feat: bundle assets with content (#2958) * fix(media_folder_relative): use collection name in unpublished entry * refactor: pass arguments as object to AssetProxy ctor * feat: support media folders per collection * feat: resolve media files path based on entry path * fix: asset public path resolving * refactor: introduce typescript for AssetProxy * refactor: code cleanup * refactor(asset-proxy): add tests,switch to typescript,extract arguments * refactor: typescript for editorialWorkflow * refactor: add typescript for media library actions * refactor: fix type error on map set * refactor: move locale selector into reducer * refactor: add typescript for entries actions * refactor: remove duplication between asset store and media lib * feat: load assets from backend using API * refactor(github): add typescript, cache media files * fix: don't load media URL if already loaded * feat: add media folder config to collection * fix: load assets from API when not in UI state * feat: load entry media files when opening media library * fix: editorial workflow draft media files bug fixes * test(unit): fix unit tests * fix: editor control losing focus * style: add eslint object-shorthand rule * test(cypress): re-record mock data * fix: fix non github backends, large media * test: uncomment only in tests * fix(backend-test): add missing displayURL property * test(e2e): add media library tests * test(e2e): enable visual testing * test(e2e): add github backend media library tests * test(e2e): add git-gateway large media tests * chore: post rebase fixes * test: fix tests * test: fix tests * test(cypress): fix tests * docs: add media_folder docs * test(e2e): add media library delete test * test(e2e): try and fix image comparison on CI * ci: reduce test machines from 9 to 8 * test: add reducers and selectors unit tests * test(e2e): disable visual regression testing for now * test: add getAsset unit tests * refactor: use Asset class component instead of hooks * build: don't inline source maps * test: add more media path tests
2019-12-18 18:16:02 +02:00
2022-10-20 11:57:30 -04:00
function handleInsert(url: string | string[]) {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
return store.dispatch(insertMedia(url, undefined));
}
2022-10-20 11:57:30 -04:00
const initializeMediaLibrary = once(async function initializeMediaLibrary(
name: string,
{ config }: MediaLibraryExternalLibrary,
) {
const lib = getMediaLibrary(name);
if (!lib) {
const err = new Error(
`Missing external media library '${name}'. Please use 'registerMediaLibrary' to register it.`,
);
store.dispatch(configFailed(err));
} else {
2022-10-20 11:57:30 -04:00
const instance = await lib.init({ options: config, handleInsert });
store.dispatch(createMediaLibrary(instance));
}
});
2022-10-20 11:57:30 -04:00
function isExternalMediaLibraryConfig(
config: MediaLibrary | undefined,
): config is MediaLibraryExternalLibrary {
return Boolean(config && 'name' in config);
}
store.subscribe(() => {
2022-10-20 11:57:30 -04:00
const state = store.getState() as unknown as RootState;
if (state.config.config && isExternalMediaLibraryConfig(state.config.config.media_library)) {
const mediaLibraryName = state.config.config.media_library?.name;
if (mediaLibraryName && !state.mediaLibrary.externalLibrary) {
const mediaLibraryConfig = state.config.config.media_library;
initializeMediaLibrary(mediaLibraryName, mediaLibraryConfig);
}
}
});