OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
/*
* -- copyright
* OpenProject is an open source project management software.
* Copyright (C) 2023 the OpenProject GmbH
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 3.
*
* OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
* Copyright (C) 2006-2013 Jean-Philippe Lang
* Copyright (C) 2010-2013 the ChiliProject Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* See COPYRIGHT and LICENSE files for more details.
* ++
*/
import { BlockNoteSchema, defaultBlockSpecs, filterSuggestionItems } from '@blocknote/core';
import { BlockNoteView } from '@blocknote/mantine';
import { getDefaultReactSlashMenuItems, SuggestionMenuController, useCreateBlockNote } from '@blocknote/react';
import { initOpenProjectApi, getDefaultOpenProjectSlashMenuItems, openProjectWorkPackageBlockSpec } from 'op-blocknote-extensions';
import { useEffect, useState } from 'react';
import { OpColorMode } from 'core-app/core/setup/globals/theme-utils';
import { HocuspocusProvider } from '@hocuspocus/provider';
import * as Y from 'yjs';
import {
DefaultThreadStoreAuth,
YjsThreadStore,
} from '@blocknote/core/comments';
import { User } from '@blocknote/core/comments';
export interface OpBlockNoteContainerProps {
inputField:HTMLInputElement;
inputText?:string;
hocuspocusUrl:string;
hocuspocusAccessToken:string;
users:User[];
activeUser:User;
documentId:string;
openProjectUrl:string;
}
const schema = BlockNoteSchema.create({
blockSpecs: {
...defaultBlockSpecs,
openProjectWorkPackage: openProjectWorkPackageBlockSpec,
},
});
const detectTheme = ():OpColorMode => { return window.OpenProject.theme.detectOpColorMode(); };
export default function OpBlockNoteContainer({ inputField,
inputText,
users,
activeUser,
hocuspocusUrl,
hocuspocusAccessToken,
documentId,
openProjectUrl }:OpBlockNoteContainerProps) {
initOpenProjectApi({ baseUrl: openProjectUrl});
const [isLoading, setIsLoading] = useState(true);
let collaboration:any;
let comments:any;
const collaborationEnabled = Boolean(hocuspocusUrl && documentId && hocuspocusAccessToken && activeUser);
let hocuspocusProvider:HocuspocusProvider | null = null;
let threadStore:any;
if(collaborationEnabled) {
const doc = new Y.Doc();
hocuspocusProvider = new HocuspocusProvider({
url: hocuspocusUrl,
name: documentId,
token: hocuspocusAccessToken,
document: doc
});
const cursorColor = '#' + Math.floor(Math.random() * 16777215).toString(16).padStart(6, '0');
collaboration = {
provider: hocuspocusProvider,
fragment: doc.getXmlFragment('document-store'),
user: {
name: activeUser.username,
color: cursorColor,
},
showCursorLabels: 'activity'
};
threadStore = new YjsThreadStore(
activeUser.id,
doc.getMap('threads'),
new DefaultThreadStoreAuth(activeUser.id, 'editor'),
);
comments = {
threadStore: threadStore,
};
}
let editor:any;
if(collaborationEnabled) {
const resolveUsers = async (userIds:string[]) => {
return users.filter((user) => userIds.includes(user.id));
};
editor = useCreateBlockNote(
{
resolveUsers,
collaboration,
schema,
comments
},
[activeUser, threadStore]
);
} else {
editor = useCreateBlockNote(
{ schema },
);
};
type EditorType = typeof editor;
const getCustomSlashMenuItems = (editor:EditorType) => {
return [
...getDefaultReactSlashMenuItems(editor),
...getDefaultOpenProjectSlashMenuItems(editor),
];
};
useEffect(() => {
async function prepareEditor() {
if(collaborationEnabled && hocuspocusProvider) {
hocuspocusProvider.on('synced', async () => {
console.log('BlockNote collaboration synced');
setIsLoading(false);
});
hocuspocusProvider.on('disconnect', () => {
console.error('BlockNote collaboration disconnected');
setIsLoading(true);
});
} else {
const blocks = await editor.tryParseMarkdownToBlocks(inputText || '');
editor.replaceBlocks(editor.document, blocks);
setIsLoading(false);
}
}
void prepareEditor();
return () => {
if (hocuspocusProvider) {
hocuspocusProvider.destroy();
}
};
}, []);
return (
<>
{isLoading ? <div>Loading...</div>
:
<BlockNoteView
editor={editor}
theme={detectTheme()}
onChange={async (editor) => {
const content = await editor.blocksToMarkdownLossy();
inputField.value = content;
}}
className={'block-note-editor-container'}
>
<SuggestionMenuController
triggerCharacter="/"
getItems={async (query:string) => filterSuggestionItems(getCustomSlashMenuItems(editor), query)}
/>
</BlockNoteView>
}
</>
);
}