) => {
const entitiesAchievementsPromise = [];
for (const entityJSON of Object.values(entitiesJSON)) {
entitiesAchievementsPromise.push(achievement.processEdit(
orm, editorJSON.id, entityJSON.revisionId
)
.then((unlock) => {
if (unlock.alert) {
entityJSON.alert = unlock.alert;
}
return entityJSON;
}));
}
return Promise.all(entitiesAchievementsPromise).catch(err => { throw err; });
}
);
return handler.sendPromiseResult(
res,
achievementPromise,
search._bulkIndexEntities
);
}
```
## Frontend Changes
We will need a new redux store for handling form state, redux state should look something like this
```auto
{
entitySection:{
activeEntity:{
nameSection,
….,
type,
id,
isActive,
}
entities:{0:{}}
}
submissionSection:{...}
}
```
**Redux Reducer** in client/unified-form/helper
Single entity will be using the same entity-editor state with some extra attributes
```auto
function entitySectionReducer(state, action) {
const intermediateState = combineReducers({
activeEntity: combineReducers(
{
active: activeReducer,
aliasEditor: aliasEditorReducer,
annotationSection: annotationSectionReducer,
authorSection: authorSectionReducer,
id: idReducer,
identifierEditor: identifierEditorReducer,
nameSection: nameSectionReducer,
relationshipSection: relationshipSectionReducer,
type: typeReducer,
workSection: workSectionReducer
}
),
entities: entitiesReducer
})(state, action);
const finalState = crossSliceReducer(intermediateState, action);
return finalState;
}
export function createRootReducer() {
return combineReducers({
entitySection: entitySectionReducer,
submissionSection: submissionSectionReducer
});
}
```
**crossSliceReducer** for facilitating interaction between different states
```auto
function crossSliceReducer(state, action) {
const {type, payload} = action;
switch (type) {
case SELECT_ENTITY: {
const newState = crossSliceReducer(state.setIn(['activeEntity', 'active'], false), {type: SAVE_ENTITY});
return newState.setIn(['entities', payload, 'active'], true).set('activeEntity', newState.getIn(['entities', payload]));
}
case SAVE_ENTITY:
return state.setIn(['entities', state.getIn(['activeEntity', 'id'])], state.get('activeEntity'));
case REMOVE_ENTITY:
{
const activeEntityId = state.getIn(['activeEntity', 'id']);
const newState = state.deleteIn(['entities', payload]);
if (payload === activeEntityId) {
return newState.set('activeEntity', newState.get('entities').first());
}
return newState;
}
case REMOVEALL_ENTITY:
return state.set('activeEntity', new Map()).set('entities', new Map());
default:
return state;
}
}
```
entity-section will manage namely these actions
- **REMOVE\_ALL** : Remove all entity from “activeEntity” as well as from “entities”
- **REMOVE\_ENTITY** : Remove specific entity with id
- **SAVE\_ENTITY** : Save the active entity state in entities
- **SELECT\_ENTITY** : Select active entity from entities
# TIMELINE
### Community Bonding Period
I believe this project is similar to the present entity-editor in bookbrainz so I will try to understand it more sincerely.
But my priority would be to design an awesome unified form with the suggestions of community members.
Also, I will be taking on some small tickets in the meantime.
### Week 1-2: Designing Phase
Together with my mentor, we will be finalizing the designs for a unified form.
This will need a thorough discussion with mentors and community members for perfecting it!
### Week 3: Implementation Phase
I will be working on the routes for submitting multiple entities, also writing thorough unit tests for the same.
### Week 4-5-6-7
I will then start with front-end work, I will first work on accommodating the existing entities in the editor.
I will add a unified-form page and create or modify its required components.
I will also be adding the redux reducers and their respective actions.
### Week 8
Taking reviews from the mentor, fixing bugs, UX issues, and improving the overall code quality.
### Week 9-10-11
I will then start to implement the book template, also I will be adding the default entity-entity relationships so the user doesn’t need to manually link them.
### Week 12
Testing unified form thoroughly for bugs, UX issues.
### Stretch Goal
- Adding graph to visualize entities before submission
- Adding useful validation messages
## Detailed information about yourself
My name is Shubham Gupta (aka Shubh), I am a first-year undergrad student pursuing a bachelor’s degree in Information Technology from the National Institute of Technology, Kurushetra. I love working with computers, building stuff to solve real-life problems is what drives me forwards apart from that I’ve always been a big fan of fiction series.
I joined the **metabrainz** community at the end of November’21
**My PRs** : [Check out](https://github.com/metabrainz/bookbrainz-site/pulls?q=is%3Apr+sort%3Aupdated-desc+author%3Atr1ten)
**Tell us about the computer(s) you have available for working on your SoC project!**
I have a dell Inspiron with 12 gigs of memory and an i3 6th gen processor
**When did you first start programming?**
In middle school, I wrote my first hello world program in C language.
**What type of music do you listen to?**
I’m a big fan of artist [Alec Benjamin](https://musicbrainz.org/artist/21a14ee3-cede-420a-9d6d-a33517d2f952), some of my favorites are [outrunning karma](https://musicbrainz.org/release/efe29403-43c5-445f-ae0d-5cacb4e37dde) and [demons](https://musicbrainz.org/release/828d19c0-bef8-4123-ab58-66362b95c691).
**If applying for a BookBrainz project: what type of books do you read?**
I love reading fiction, my favorites include [Classroom of elite](https://bookbrainz.org/series/71c35cfc-3fa2-4398-8be6-af6338468391), [Sherlock Holmes](https://bookbrainz.org/series/99d911ad-e5da-40fd-9e32-281b3d2df345).
**What aspects of the project you’re applying for the interest you the most?**
Designing the intuitive unified form excites me the most
**Have you contributed to other Open Source projects?**
No, Bookbrainz is my first Open Source project
**How much time do you have available, and how would you plan to use it?**
I would be able to give approx 45 hours every week to the project.
**Do you plan to have a job or study during the summer in conjunction with Summer of Code?**
No, I would be able to devote all my time to the project
---
### Author:  [@Shubh](https://community.metabrainz.org/u/Shubh)
#### Post date: [April 4, 2022, 7:36am UTC](https://community.metabrainz.org/t/gsoc-2022-unified-creation-form-bookbrainz/578635/2 "2022-04-04T07:36:24Z")
@mr_monkey When you get time please have a look, would love to hear your suggestions to improve the proposal.
also looking forward to community member’s thoughts on the new form design 😄
---
### Author:  [@mr\_monkey](https://community.metabrainz.org/u/mr_monkey)
#### Post date: [April 17, 2022, 6:28pm UTC](https://community.metabrainz.org/t/gsoc-2022-unified-creation-form-bookbrainz/578635/3 "2022-04-17T18:28:44Z")
Hi!
Thanks for your proposal, and sorry to answer only this late, life got in the way.
In general the proposal is looking great!
I like that the Basic tab is about information you would find on a cover, that’s a smart approach. Why not call the tab **Cover** instead?
Here are some details that we would need to figure out in the early design process:
The Contents tab should include a way to search for an existing Work, which I don’t see there.
We would also probably find a good way to add some other common relationships when creating a new work such as translator, illustrator…
I’m not sure what purpose the “created entities” section on the right currently has that isn’t covered by a recap screen at the end to confirm data before submission, as we previously talked about (and which I don’t see mentioned in the proposal; it would be good to add it).
The mockup doesn’t make it clear to me how i would use it to add entities, which is what I expect the “+ add work” button in the Contents tab would be for.
I think we can find a way to add entities inline without having that side bar.
One thing that is going to be important is to write tests as the project goes along.
So when you would implement the back-end routes, you would write the tests for it in the continuation before moving to the next task.
It’s easier to write tests with the implementation fresh in mind than at the end, possibly running out of time.
Thanks for your submission !
---
### Author:  [@Shubh](https://community.metabrainz.org/u/Shubh)
#### Post date: [April 18, 2022, 7:18am UTC](https://community.metabrainz.org/t/gsoc-2022-unified-creation-form-bookbrainz/578635/4 "2022-04-18T07:18:07Z")
> [@mr\_monkey](#):
>
> The Contents tab should include a way to search for an existing Work, which I don’t see there.
Yeah, my bad we should definitely have a search (or create if not exist) field for contents tab.
> [@mr\_monkey](#):
>
> I’m not sure what purpose the “created entities” section
I suppose user might want to modify entity that automatically created like publisher, although we can get rid of that for simplicity but i’m afraid it might make this form more restrictive for existing users.
> [@mr\_monkey](#):
>
> recap screen at the end to confirm data before submission,
I am planning to show a confirmation modal to list all the entities that will be created after submission.
> [@mr\_monkey](#):
>
> The mockup doesn’t make it clear to me how i would use it to add entities
We will be using search (create if not exist) dropdown to create entity with search query as a primary alias (like publisher shown in the example).
> [@mr\_monkey](#):
>
> I think we can find a way to add entities inline without having that side bar.
like i said i’m worried if it might make this form restrictive in its usage ☹
> [@mr\_monkey](#):
>
> It’s easier to write tests with the implementation fresh in mind than at the end
Yep!
Thanks for all the suggestions, i will be adding these details (with mockups) in the proposal.