static-cms/packages/core/src/reducers/mediaLibrary.ts

336 lines
7.4 KiB
TypeScript
Raw Normal View History

2023-04-12 15:18:32 -04:00
import { basename, dirname } from 'path';
2022-10-20 11:57:30 -04:00
import { v4 as uuid } from 'uuid';
import {
2022-10-20 11:57:30 -04:00
MEDIA_DELETE_FAILURE,
MEDIA_DELETE_REQUEST,
MEDIA_DELETE_SUCCESS,
MEDIA_DISPLAY_URL_FAILURE,
MEDIA_DISPLAY_URL_REQUEST,
MEDIA_DISPLAY_URL_SUCCESS,
MEDIA_INSERT,
MEDIA_LIBRARY_CLOSE,
2022-10-20 11:57:30 -04:00
MEDIA_LIBRARY_OPEN,
MEDIA_LOAD_FAILURE,
MEDIA_LOAD_REQUEST,
MEDIA_LOAD_SUCCESS,
2022-10-20 11:57:30 -04:00
MEDIA_PERSIST_FAILURE,
MEDIA_PERSIST_REQUEST,
MEDIA_PERSIST_SUCCESS,
2022-10-20 11:57:30 -04:00
MEDIA_REMOVE_INSERTED,
} from '../constants';
import type { MediaLibraryAction } from '../actions/mediaLibrary';
2023-03-30 13:29:09 -04:00
import type {
Collection,
2023-04-13 13:27:13 -04:00
CollectionFile,
MediaField,
2023-03-30 13:29:09 -04:00
MediaFile,
MediaLibrarInsertOptions,
MediaLibraryConfig,
2023-03-30 13:29:09 -04:00
MediaLibraryDisplayURL,
MediaPath,
} from '../interface';
2022-10-20 11:57:30 -04:00
export type MediaLibraryState = {
Feat: editorial workflow bitbucket gitlab (#3014) * refactor: typescript the backends * feat: support multiple files upload for GitLab and BitBucket * fix: load entry media files from media folder or UI state * chore: cleanup log message * chore: code cleanup * refactor: typescript the test backend * refactor: cleanup getEntry unsued variables * refactor: moved shared backend code to lib util * chore: rename files to preserve history * fix: bind readFile method to API classes * test(e2e): switch to chrome in cypress tests * refactor: extract common api methods * refactor: remove most of immutable js usage from backends * feat(backend-gitlab): initial editorial workflow support * feat(backend-gitlab): implement missing workflow methods * chore: fix lint error * feat(backend-gitlab): support files deletion * test(e2e): add gitlab cypress tests * feat(backend-bitbucket): implement missing editorial workflow methods * test(e2e): add BitBucket backend e2e tests * build: update node version to 12 on netlify builds * fix(backend-bitbucket): extract BitBucket avatar url * test: fix git-gateway AuthenticationPage test * test(e2e): fix some backend tests * test(e2e): fix tests * test(e2e): add git-gateway editorial workflow test * chore: code cleanup * test(e2e): revert back to electron * test(e2e): add non editorial workflow tests * fix(git-gateway-gitlab): don't call unpublishedEntry in simple workflow gitlab git-gateway doesn't support editorial workflow APIs yet. This change makes sure not to call them in simple workflow * refactor(backend-bitbucket): switch to diffstat API instead of raw diff * chore: fix test * test(e2e): add more git-gateway tests * fix: post rebase typescript fixes * test(e2e): fix tests * fix: fix parsing of content key and add tests * refactor: rename test file * test(unit): add getStatues unit tests * chore: update cypress * docs: update beta docs
2020-01-15 00:15:14 +02:00
isVisible: boolean;
showMediaButton: boolean;
2023-03-30 13:29:09 -04:00
controlMedia: Record<string, MediaPath>;
2022-10-20 11:57:30 -04:00
displayURLs: Record<string, MediaLibraryDisplayURL>;
Feat: editorial workflow bitbucket gitlab (#3014) * refactor: typescript the backends * feat: support multiple files upload for GitLab and BitBucket * fix: load entry media files from media folder or UI state * chore: cleanup log message * chore: code cleanup * refactor: typescript the test backend * refactor: cleanup getEntry unsued variables * refactor: moved shared backend code to lib util * chore: rename files to preserve history * fix: bind readFile method to API classes * test(e2e): switch to chrome in cypress tests * refactor: extract common api methods * refactor: remove most of immutable js usage from backends * feat(backend-gitlab): initial editorial workflow support * feat(backend-gitlab): implement missing workflow methods * chore: fix lint error * feat(backend-gitlab): support files deletion * test(e2e): add gitlab cypress tests * feat(backend-bitbucket): implement missing editorial workflow methods * test(e2e): add BitBucket backend e2e tests * build: update node version to 12 on netlify builds * fix(backend-bitbucket): extract BitBucket avatar url * test: fix git-gateway AuthenticationPage test * test(e2e): fix some backend tests * test(e2e): fix tests * test(e2e): add git-gateway editorial workflow test * chore: code cleanup * test(e2e): revert back to electron * test(e2e): add non editorial workflow tests * fix(git-gateway-gitlab): don't call unpublishedEntry in simple workflow gitlab git-gateway doesn't support editorial workflow APIs yet. This change makes sure not to call them in simple workflow * refactor(backend-bitbucket): switch to diffstat API instead of raw diff * chore: fix test * test(e2e): add more git-gateway tests * fix: post rebase typescript fixes * test(e2e): fix tests * fix: fix parsing of content key and add tests * refactor: rename test file * test(unit): add getStatues unit tests * chore: update cypress * docs: update beta docs
2020-01-15 00:15:14 +02:00
controlID?: string;
page?: number;
files?: MediaFile[];
config: MediaLibraryConfig;
2023-02-16 13:34:35 -05:00
collection?: Collection;
2023-04-13 13:27:13 -04:00
collectionFile?: CollectionFile;
field?: MediaField;
value?: string | string[];
2023-03-30 13:29:09 -04:00
alt?: string;
replaceIndex?: number;
2022-10-20 11:57:30 -04:00
isLoading?: boolean;
dynamicSearch?: boolean;
dynamicSearchActive?: boolean;
dynamicSearchQuery?: string;
forImage?: boolean;
forFolder?: boolean;
2022-10-20 11:57:30 -04:00
isPersisting?: boolean;
isDeleting?: boolean;
hasNextPage?: boolean;
isPaginating?: boolean;
2023-03-30 13:29:09 -04:00
insertOptions?: MediaLibrarInsertOptions;
2022-10-20 11:57:30 -04:00
};
const defaultState: MediaLibraryState = {
isVisible: false,
showMediaButton: true,
2022-10-20 11:57:30 -04:00
controlMedia: {},
displayURLs: {},
config: {},
};
2022-10-20 11:57:30 -04:00
function mediaLibrary(
state: MediaLibraryState = defaultState,
action: MediaLibraryAction,
): MediaLibraryState {
switch (action.type) {
case MEDIA_LIBRARY_OPEN: {
2023-03-30 13:29:09 -04:00
const {
controlID,
forImage,
forFolder,
2023-03-30 13:29:09 -04:00
config,
collection,
2023-04-13 13:27:13 -04:00
collectionFile,
2023-03-30 13:29:09 -04:00
field,
value,
alt,
replaceIndex,
insertOptions,
} = action.payload;
2022-10-20 11:57:30 -04:00
const libConfig = config || {};
return {
...state,
isVisible: true,
forImage: Boolean(forImage),
forFolder: Boolean(forFolder),
2022-10-20 11:57:30 -04:00
controlID,
config: libConfig,
2023-02-16 13:34:35 -05:00
collection,
2023-04-13 13:27:13 -04:00
collectionFile,
2022-10-20 11:57:30 -04:00
field,
value,
2023-03-30 13:29:09 -04:00
alt,
2022-10-20 11:57:30 -04:00
replaceIndex,
2023-03-30 13:29:09 -04:00
insertOptions,
2022-10-20 11:57:30 -04:00
};
}
case MEDIA_LIBRARY_CLOSE:
2022-10-20 11:57:30 -04:00
return {
...state,
isVisible: false,
2023-03-30 13:29:09 -04:00
insertOptions: undefined,
alt: undefined,
2022-10-20 11:57:30 -04:00
};
case MEDIA_INSERT: {
2023-03-30 13:29:09 -04:00
const { mediaPath, alt } = action.payload;
2022-10-20 11:57:30 -04:00
const controlID = state.controlID;
if (!controlID) {
return state;
}
const value = state.value;
if (!Array.isArray(value)) {
2022-10-20 11:57:30 -04:00
return {
...state,
controlMedia: {
...state.controlMedia,
2023-03-30 13:29:09 -04:00
[controlID]: {
path: mediaPath,
alt,
},
2022-10-20 11:57:30 -04:00
},
};
}
2022-10-20 11:57:30 -04:00
const replaceIndex = state.replaceIndex;
const mediaArray = Array.isArray(mediaPath) ? mediaPath : [mediaPath];
const valueArray = value as string[];
if (typeof replaceIndex == 'number') {
valueArray[replaceIndex] = mediaArray[0];
} else {
valueArray.push(...mediaArray);
}
2022-10-20 11:57:30 -04:00
return {
...state,
controlMedia: {
...state.controlMedia,
2023-03-30 13:29:09 -04:00
[controlID]: {
path: valueArray,
},
2022-10-20 11:57:30 -04:00
},
};
}
WIP - Global UI (#785) * update top bar and collections sidebar UI * update collection entries UI * improve global layout * merge search page into collection page * enable new entry button * search fixup * wip -initial editor update * update editor scrolling and markdown toolbar position * wip * editor toolbar progress * editor toolbar wip * finished basic editor toolbar * add standalone toggle component * improve markdown toolbar spacing * add user avatar placeholder * finish markdown toggle styling * refactor icon setup, add new icons * add new icons to markdown editor toolbar * remove extra app container * add markdown active mark style * relation and text widget styling * widget design updates, basic list/object design update * widget style updates, image widget improvements * refactor widget directory, fix file removal * widget focus styles * finish editor widget focus styles * migrate media library modal to react-modal * wip - migrate editor component form to modal * wip - move editor component form to modal * wip - embed plugin forms in the editor * inline shortcode forms working * disable react hot loading, its breaking things * improve shortcode form styles * make shortcode form collapsible, improve styling * add close functionality to shortcode blocks * improve base media library styling * fix shortcode label * migrate unstyled workflow to new UI * wip - reorganizing everything * more work moving everything * finish more moving and eliminating stuff * restructure, remove react-toolbox * wip - removing old stuff, more restructure * finish restructure * wip - css arch * switch back to test repo * update react-datetime to ^2.11.0 * remove leftover react-toolbox button * more restructuring clean-up * fix UI component directory case * wip -css editor control style * wip - consolidate widget styles * wip - use a single control renderer * fixed object values breaking * wip - editor control active styles * pass control wrapper to widgets * ensure branch name is trimmed * wip - improve widget authoring support * import Map to Widget component * refactor toolbar buttons * wip - more widget active styles * break out editor toggle component * add local scroll sync back * update editor toggle icons * limit editor control pane content width * fix editor control spacing * migrate markdown toolbar stickiness to css * fix markdown toolbar border radius * temporarily use test backend * stop markdown toolbar from going to bottom * restore disabled markdown toolbar buttons for raw * test markdown widget without focus styles * more widget updates * remove card visuals from editor * disable dragging editor split off screen * use editorControl component for shortcode fields * make header site link configurable * add configurable collection descriptions * temporarily add example assets * add basic list view * remove outdated css mixins * add and implement search icon * activate quick add menu * visualize usable space in editor view * fix entry close, other improvements * wip - editorial workflow updates * some dropshadow and other CSS tweaks * workflow ui updates * add worfklow card buttons * fix workflow card button handlers * some dropshadow and other CSS tweaks * make workflow board wider * center workflow and collection views * add basic responsiveness * a bunch of fun UI fixes! a BUNCH! (#875) * give `.nc-entryEditor-toolbar-mainSection` left and right child divs * a bunch of fun UI fixes! a BUNCH! * remove obscure --buttonShadow * revert to test repo * fix not found page styling * allow workflow publishing from any column * disallow publishing from all columns, with feedback * fix new entry button * fix markdown state persisting across entries * enable simple workflow save and new from editor * update slug in address bar when saving new entry * wip - workflow updates, deletion working * add status change functionality to editor * wip - improving status change from editor * editor toolbar back button improvements, loading improvements, cleanup * progress on the media library UI cleanup * remove font smothing css * a quick fix for these buttons * tweaks * progress on media library modal— broken FYI * fix media library functionality, finish migrating footer * remove media library footer files * remove leftover css import * fix media library * editor publishing functionality complete (unstyled) * remove leftover loader var from media library * wip - editor publishing styles * add status dropdown styling * editor toolbar style updates * editor toolbar state improvements * progress on the media library UI cleanup, style improvements * finish editorial workflow editor styling * finish media library styling * fix config * add what-input to optimize focus styling * fix button * fix navigation blocking for simple workflow * improve simple workflow publishing * add avatar dropdown to editor top bar * style github and test-repo auth pages * add git gateway auth page styles * improve editor error styling
2017-12-07 12:37:10 -05:00
case MEDIA_REMOVE_INSERTED: {
const controlID = action.payload.controlID;
2022-10-20 11:57:30 -04:00
2023-03-30 13:29:09 -04:00
const newControlMedia = { ...state.controlMedia };
delete newControlMedia[controlID];
2022-10-20 11:57:30 -04:00
return {
...state,
2023-03-30 13:29:09 -04:00
controlMedia: newControlMedia,
2022-10-20 11:57:30 -04:00
};
WIP - Global UI (#785) * update top bar and collections sidebar UI * update collection entries UI * improve global layout * merge search page into collection page * enable new entry button * search fixup * wip -initial editor update * update editor scrolling and markdown toolbar position * wip * editor toolbar progress * editor toolbar wip * finished basic editor toolbar * add standalone toggle component * improve markdown toolbar spacing * add user avatar placeholder * finish markdown toggle styling * refactor icon setup, add new icons * add new icons to markdown editor toolbar * remove extra app container * add markdown active mark style * relation and text widget styling * widget design updates, basic list/object design update * widget style updates, image widget improvements * refactor widget directory, fix file removal * widget focus styles * finish editor widget focus styles * migrate media library modal to react-modal * wip - migrate editor component form to modal * wip - move editor component form to modal * wip - embed plugin forms in the editor * inline shortcode forms working * disable react hot loading, its breaking things * improve shortcode form styles * make shortcode form collapsible, improve styling * add close functionality to shortcode blocks * improve base media library styling * fix shortcode label * migrate unstyled workflow to new UI * wip - reorganizing everything * more work moving everything * finish more moving and eliminating stuff * restructure, remove react-toolbox * wip - removing old stuff, more restructure * finish restructure * wip - css arch * switch back to test repo * update react-datetime to ^2.11.0 * remove leftover react-toolbox button * more restructuring clean-up * fix UI component directory case * wip -css editor control style * wip - consolidate widget styles * wip - use a single control renderer * fixed object values breaking * wip - editor control active styles * pass control wrapper to widgets * ensure branch name is trimmed * wip - improve widget authoring support * import Map to Widget component * refactor toolbar buttons * wip - more widget active styles * break out editor toggle component * add local scroll sync back * update editor toggle icons * limit editor control pane content width * fix editor control spacing * migrate markdown toolbar stickiness to css * fix markdown toolbar border radius * temporarily use test backend * stop markdown toolbar from going to bottom * restore disabled markdown toolbar buttons for raw * test markdown widget without focus styles * more widget updates * remove card visuals from editor * disable dragging editor split off screen * use editorControl component for shortcode fields * make header site link configurable * add configurable collection descriptions * temporarily add example assets * add basic list view * remove outdated css mixins * add and implement search icon * activate quick add menu * visualize usable space in editor view * fix entry close, other improvements * wip - editorial workflow updates * some dropshadow and other CSS tweaks * workflow ui updates * add worfklow card buttons * fix workflow card button handlers * some dropshadow and other CSS tweaks * make workflow board wider * center workflow and collection views * add basic responsiveness * a bunch of fun UI fixes! a BUNCH! (#875) * give `.nc-entryEditor-toolbar-mainSection` left and right child divs * a bunch of fun UI fixes! a BUNCH! * remove obscure --buttonShadow * revert to test repo * fix not found page styling * allow workflow publishing from any column * disallow publishing from all columns, with feedback * fix new entry button * fix markdown state persisting across entries * enable simple workflow save and new from editor * update slug in address bar when saving new entry * wip - workflow updates, deletion working * add status change functionality to editor * wip - improving status change from editor * editor toolbar back button improvements, loading improvements, cleanup * progress on the media library UI cleanup * remove font smothing css * a quick fix for these buttons * tweaks * progress on media library modal— broken FYI * fix media library functionality, finish migrating footer * remove media library footer files * remove leftover css import * fix media library * editor publishing functionality complete (unstyled) * remove leftover loader var from media library * wip - editor publishing styles * add status dropdown styling * editor toolbar style updates * editor toolbar state improvements * progress on the media library UI cleanup, style improvements * finish editorial workflow editor styling * finish media library styling * fix config * add what-input to optimize focus styling * fix button * fix navigation blocking for simple workflow * improve simple workflow publishing * add avatar dropdown to editor top bar * style github and test-repo auth pages * add git gateway auth page styles * improve editor error styling
2017-12-07 12:37:10 -05:00
}
case MEDIA_LOAD_REQUEST:
2022-10-20 11:57:30 -04:00
return {
...state,
isLoading: true,
isPaginating: action.payload.page > 1,
};
case MEDIA_LOAD_SUCCESS: {
2022-11-04 17:41:12 -04:00
const { files = [], page, canPaginate, dynamicSearch, dynamicSearchQuery } = action.payload;
const filesWithKeys = files.map(file => ({ ...file, key: uuid() }));
2022-10-20 11:57:30 -04:00
return {
...state,
isLoading: false,
isPaginating: false,
page: page ?? 1,
hasNextPage: Boolean(canPaginate && files.length > 0),
dynamicSearch: Boolean(dynamicSearch),
dynamicSearchQuery: dynamicSearchQuery ?? '',
dynamicSearchActive: !!dynamicSearchQuery,
files:
page && page > 1 ? (state.files as MediaFile[]).concat(filesWithKeys) : filesWithKeys,
};
}
case MEDIA_LOAD_FAILURE: {
2022-10-20 11:57:30 -04:00
return {
...state,
isLoading: false,
};
}
case MEDIA_PERSIST_REQUEST:
2022-10-20 11:57:30 -04:00
return {
...state,
isPersisting: true,
};
case MEDIA_PERSIST_SUCCESS: {
2023-04-12 15:18:32 -04:00
const { file, currentFolder } = action.payload;
2022-10-20 11:57:30 -04:00
const fileWithKey = { ...file, key: uuid() };
const files = state.files as MediaFile[];
2023-04-12 15:18:32 -04:00
const dir = dirname(file.path);
if (!currentFolder || dir === currentFolder) {
const updatedFiles: MediaFile[] = [fileWithKey, ...files];
return {
...state,
files: updatedFiles,
isPersisting: false,
};
}
const folder = files.find(otherFile => otherFile.isDirectory && otherFile.path === dir);
if (!folder) {
const updatedFiles: MediaFile[] = [
{
name: basename(dir),
id: dir,
path: dir,
isDirectory: true,
},
...files,
];
return {
...state,
files: updatedFiles,
isPersisting: false,
};
}
2022-10-20 11:57:30 -04:00
return {
...state,
isPersisting: false,
};
}
case MEDIA_PERSIST_FAILURE: {
2022-10-20 11:57:30 -04:00
return {
...state,
isPersisting: false,
};
}
case MEDIA_DELETE_REQUEST:
2022-10-20 11:57:30 -04:00
return {
...state,
isDeleting: true,
};
case MEDIA_DELETE_SUCCESS: {
2022-11-04 17:41:12 -04:00
const { file } = action.payload;
const { key, id } = file;
2022-10-20 11:57:30 -04:00
const files = state.files as MediaFile[];
const updatedFiles = files.filter(file => (key ? file.key !== key : file.id !== id));
const displayURLs = {
...state.displayURLs,
};
delete displayURLs[id];
return {
...state,
files: updatedFiles,
displayURLs,
isDeleting: false,
};
}
case MEDIA_DELETE_FAILURE: {
2022-10-20 11:57:30 -04:00
return {
...state,
isDeleting: false,
};
}
case MEDIA_DISPLAY_URL_REQUEST:
2022-10-20 11:57:30 -04:00
return {
...state,
displayURLs: {
...state.displayURLs,
[action.payload.key]: {
...state.displayURLs[action.payload.key],
isFetching: true,
},
},
};
case MEDIA_DISPLAY_URL_SUCCESS: {
2022-10-20 11:57:30 -04:00
return {
...state,
displayURLs: {
...state.displayURLs,
[action.payload.key]: {
url: action.payload.url,
isFetching: false,
},
},
};
}
case MEDIA_DISPLAY_URL_FAILURE: {
2022-10-20 11:57:30 -04:00
const displayUrl = { ...state.displayURLs[action.payload.key] };
delete displayUrl.url;
displayUrl.isFetching = false;
displayUrl.err = action.payload.err ?? true;
return {
...state,
displayURLs: {
...state.displayURLs,
[action.payload.key]: displayUrl,
},
};
}
default:
return state;
}
}
export default mediaLibrary;