🔖(minor) release 2.1.0

Added: - ✨(backend) add soft delete and restore API endpoints to documents - ✨(backend) allow organizing documents in a tree structure - ✨(backend) add "excerpt" field to document list serializer - ✨(backend) add github actions to manage Crowdin workflow - 📈Integrate Posthog - 🏷️(backend) add content-type to uploaded file - ✨(frontend) export pdf docx front side7 Changed: - 💄(frontend) add abilities on doc row - 💄(frontend) improve DocsGridItem responsive padding - 🔧(backend) Bump maximum page size to 200 - 📝(doc) Improve Read me Fixed: - 🐛Fix invitations Removed: - 🔥(backend) remove "content" field from list serializer
2025-01-30 12:29:19 +01:00
13 changed files with 135 additions and 1146 deletions
@@ -6,7 +6,6 @@ on:
  push:
    branches:
      - 'main'
-      - 'feature/blocknote-ai'
    tags:
      - 'v*'
  pull_request:
@@ -9,8 +9,6 @@ and this project adheres to

 ## [Unreleased]

-## Added
- 📝(doc) Add security.md and codeofconduct.md #604

 ## [2.1.0] - 2025-01-29

@@ -1,75 +0,0 @@
-# Contributor Covenant Code of Conduct
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Enforcement Responsibilities
-
- Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
- Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
- This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at docs@numerique.gouv.fr.
-
- All complaints will be reviewed and investigated promptly and fairly.
-
- All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
- Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this 
-
-## Code of Conduct:
-
-1. Correction
-
-Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-2. Warning
-
-Community Impact: A violation through a single incident or series of actions.
-
-Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-3. Temporary Ban
-
-Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
-
-Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-4. Permanent Ban
-
-Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-Consequence: A permanent ban from any sort of public interaction within the community.
-Attribution
-
-This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
-
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
@@ -13,10 +13,8 @@ Welcome to Docs! The open source document editor where your notes can become kno
    Chat on Matrix
  </a> - <a href="/docs/">
    Documentation
-  </a> - <a href="#getting-started-">
+  </a> - <a href="#getting-started">
    Getting started
-  </a> - <a href="mailto:docs@numerique.gouv.fr">
-    Reach out
  </a>
 </p>

@@ -62,7 +60,7 @@ $ docker compose -v
 docker compose version 1.27.4, build 40524192
 ```

-> ⚠️ You may need to run the following commands with sudo but this can be avoided by adding your user to the `docker` group.
+> ⚠️ You may need to run the following commands with sudo but this can be avoided by assigning your user to the `docker` group.

 **Project bootstrap**
 The easiest way to start working on the project is to use GNU Make:
@@ -73,7 +71,7 @@ $ make bootstrap FLUSH_ARGS='--no-input'

 This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this

-command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
+command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.

 Your Docker services should now be up and running 🎉

@@ -81,8 +79,9 @@ You can access to the project by going to <http://localhost:3000>.

 You will be prompted to log in, the default credentials are:

-```
+```shellscript
 username: impress
+
 password: impress
 ```

@@ -173,11 +172,11 @@ docs
 Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/)

 ### Gov ❤️ open source
-Docs is the result of a joint effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)). 
+Docs is the result of a joint effort lead by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)). 

 We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).

-We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱🧀), feel free to [reach out](mailto:docs@numerique.gouv.fr) if you are interested in using or contributing to Docs.
+We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱🧀), feel free to [reach out](https://matrix.to/#/#docs-official:matrix.org) if you are interested in using or contributing to Docs.

 <p align="center">
  <img src="/docs/assets/europe_opensource.png" width="50%"/>
@@ -1,23 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-Security is very important to us.
-
-If you have any issue regarding security, please disclose the information responsibly submiting [this form](https://vdp.numerique.gouv.fr/p/Send-a-report?lang=en) and not by creating an issue on the repository. You can also email us at docs@numerique.gouv.fr
-
-We appreciate your effort to make Docs more secure.
-
-## Vulnerability disclosure policy
-
-Working with security issues in an open source project can be challenging, as we are required to disclose potential problems that could be exploited by attackers. With this in mind, our security fix policy is as follows:
-
-1. The Maintainers team will handle the fix as usual (Pull Request,
-release).
-2. In the release notes, we will include the identification numbers from the
-GitHub Advisory Database (GHSA) and, if applicable, the Common Vulnerabilities
-and Exposures (CVE) identifier for the vulnerability.
-3. Once this grace period has passed, we will publish the vulnerability.
-
-By adhering to this security policy, we aim to address security concerns
-effectively and responsibly in our open source software project.
@@ -15,14 +15,9 @@
    "test:watch": "jest --watch"
  },
  "dependencies": {
-    "ai": "^4.1.18",
-    "zod": "^3.24.1",
-    "@ai-sdk/openai": "^1.1.9",
-    "@blocknote/core": "*",
-    "@blocknote/mantine": "*",
-    "@blocknote/react": "*",
-    "@blocknote/xl-ai": "*",
-    "vitest": "^2.0.3",
+    "@blocknote/core": "0.21.0",
+    "@blocknote/mantine": "0.21.0",
+    "@blocknote/react": "0.21.0",
    "@blocknote/xl-docx-exporter": "0.21.0",
    "@blocknote/xl-pdf-exporter": "0.21.0",
    "@gouvfr-lasuite/integration": "1.0.2",
@@ -95,7 +95,7 @@ export function AIGroupButton() {
  return (
    <Components.Generic.Menu.Root>
      <Components.Generic.Menu.Trigger>
-        <Components.Toolbar.Button
+        <Components.FormattingToolbar.Button
          className="bn-button bn-menu-item"
          data-test="ai-actions"
          label="AI"
@@ -1,34 +1,12 @@
-import { createOpenAI } from '@ai-sdk/openai';
-import {
-  BlockNoteEditor as BNEditor,
-  BlockConfig,
-  Dictionary,
-  InlineContentSchema,
-  StyleSchema,
-  filterSuggestionItems,
-  locales,
-} from '@blocknote/core';
+import { Dictionary, locales } from '@blocknote/core';
 import '@blocknote/core/fonts/inter.css';
 import { BlockNoteView } from '@blocknote/mantine';
 import '@blocknote/mantine/style.css';
-import {
-  SuggestionMenuController,
-  getDefaultReactSlashMenuItems,
-  useCreateBlockNote,
-} from '@blocknote/react';
-import {
-  AIShowSelectionPlugin,
-  BlockNoteAIContextProvider,
-  BlockNoteAIUI,
-  locales as aiLocales,
-  createBlockNoteAIClient,
-  getAISlashMenuItems,
-  useBlockNoteAIContext,
-} from '@blocknote/xl-ai';
-import '@blocknote/xl-ai/style.css';
+import { useCreateBlockNote } from '@blocknote/react';
 import { HocuspocusProvider } from '@hocuspocus/provider';
 import { useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
+import { css } from 'styled-components';
 import * as Y from 'yjs';

 import { Box, TextErrors } from '@/components';
@@ -39,38 +17,95 @@ import { useUploadFile } from '../hook';
 import { useHeadings } from '../hook/useHeadings';
 import useSaveDoc from '../hook/useSaveDoc';
 import { useEditorStore } from '../stores';
-import { cssEditor } from '../styles';
 import { randomColor } from '../utils';

 import { BlockNoteToolbar } from './BlockNoteToolbar';

-const blocknoteAIClient = createBlockNoteAIClient({
-  apiKey: 'BLOCKNOTE-API-KEY-CURRENTLY-NOT-NEEDED',
-  baseURL: 'https://blocknote-esy4.onrender.com/ai',
-});
+const cssEditor = (readonly: boolean) => css`
+  &,
+  & > .bn-container,
+  & .ProseMirror {
+    height: 100%;

-const model = createOpenAI({
-  baseURL: 'https://albert.api.staging.etalab.gouv.fr/v1',
-  ...blocknoteAIClient.getProviderSettings('albert-etalab'),
-  compatibility: 'compatible',
-})('neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8');
+    .bn-side-menu[data-block-type='heading'][data-level='1'] {
+      height: 50px;
+    }
+    .bn-side-menu[data-block-type='heading'][data-level='2'] {
+      height: 43px;
+    }
+    .bn-side-menu[data-block-type='heading'][data-level='3'] {
+      height: 35px;
+    }
+    h1 {
+      font-size: 1.875rem;
+    }
+    h2 {
+      font-size: 1.5rem;
+    }
+    h3 {
+      font-size: 1.25rem;
+    }
+    a {
+      color: var(--c--theme--colors--greyscale-500);
+      cursor: pointer;
+    }
+    .bn-block-group
+      .bn-block-group
+      .bn-block-outer:not([data-prev-depth-changed]):before {
+      border-left: none;
+    }
+  }

-// We call the model via a proxy server (see above) that has the API key,
-// but we could also call the model directly from the frontend.
-// i.e., this should work as well (but it would leak your albert key to the frontend):
-/*
-    return createOpenAI({
-    baseURL: 'https://albert.api.staging.etalab.gouv.fr/v1',
-    apiKey: 'ALBERT-API-KEY',
-    compatibility: 'compatible',
-  })('albert-etalab/neuralmagic/Meta-Llama-3.1-70B-Instruct-FP8');
-*/
+  .bn-editor {
+    color: var(--c--theme--colors--greyscale-700);
+  }

-export type DocsBlockNoteEditor = BNEditor<
-  Record<string, BlockConfig>,
-  InlineContentSchema,
-  StyleSchema
->;
+  .bn-block-outer:not(:first-child) {
+    &:has(h1) {
+      padding-top: 32px;
+    }
+    &:has(h2) {
+      padding-top: 24px;
+    }
+    &:has(h3) {
+      padding-top: 16px;
+    }
+  }
+
+  & .bn-inline-content code {
+    background-color: gainsboro;
+    padding: 2px;
+    border-radius: 4px;
+  }
+
+  @media screen and (width <= 560px) {
+    & .bn-editor {
+      ${readonly && `padding-left: 10px;`}
+    }
+    .bn-side-menu[data-block-type='heading'][data-level='1'] {
+      height: 46px;
+    }
+    .bn-side-menu[data-block-type='heading'][data-level='2'] {
+      height: 40px;
+    }
+    .bn-side-menu[data-block-type='heading'][data-level='3'] {
+      height: 40px;
+    }
+    & .bn-editor h1 {
+      font-size: 1.6rem;
+    }
+    & .bn-editor h2 {
+      font-size: 1.35rem;
+    }
+    & .bn-editor h3 {
+      font-size: 1.2rem;
+    }
+    .bn-block-content[data-is-empty-and-focused][data-content-type='paragraph']
+      .bn-inline-content:has(> .ProseMirror-trailingBreak:only-child)::before {
+      font-size: 14px;
+    }
+  }
+`;

 interface BlockNoteEditorProps {
  doc: Doc;
@@ -95,10 +130,6 @@ export const BlockNoteEditor = ({ doc, provider }: BlockNoteEditorProps) => {

  const editor = useCreateBlockNote(
    {
-      _extensions: {
-        aiSelection: new AIShowSelectionPlugin(),
-      },
-
      collaboration: {
        provider,
        fragment: provider.document.getXmlFragment('document-store'),
@@ -132,10 +163,7 @@ export const BlockNoteEditor = ({ doc, provider }: BlockNoteEditorProps) => {
          return cursor;
        },
      },
-      dictionary: {
-        ...(locales[lang as keyof typeof locales] as Dictionary),
-        ai: aiLocales['en'] as unknown as Dictionary,
-      },
+      dictionary: locales[lang as keyof typeof locales] as Dictionary,
      uploadFile,
    },
    [collabName, lang, provider, uploadFile],
@@ -171,42 +199,13 @@ export const BlockNoteEditor = ({ doc, provider }: BlockNoteEditorProps) => {
        formattingToolbar={false}
        editable={!readOnly}
        theme="light"
-        slashMenu={false}
      >
-        <BlockNoteAIContextProvider
-          model={model}
-          dataFormat="markdown"
-          stream={false}
-        >
-          <BlockNoteAIUI />
-          <BlockNoteToolbar />
-          <SuggestionMenu editor={editor as unknown as DocsBlockNoteEditor} />
-        </BlockNoteAIContextProvider>
+        <BlockNoteToolbar />
      </BlockNoteView>
    </Box>
  );
 };

-function SuggestionMenu(props: { editor: DocsBlockNoteEditor }) {
-  const ctx = useBlockNoteAIContext();
-  return (
-    <SuggestionMenuController
-      triggerCharacter="/"
-      getItems={async (query) =>
-        Promise.resolve(
-          filterSuggestionItems(
-            [
-              ...getDefaultReactSlashMenuItems(props.editor),
-              ...getAISlashMenuItems(props.editor, ctx),
-            ],
-            query,
-          ),
-        )
-      }
-    />
-  );
-}
-
 interface BlockNoteEditorVersionProps {
  initialContent: Y.XmlFragment;
 }
@@ -5,9 +5,9 @@ import {
  FormattingToolbarProps,
  getFormattingToolbarItems,
 } from '@blocknote/react';
-import { AIToolbarButton } from '@blocknote/xl-ai';
-import { useCallback } from 'react';
+import React, { useCallback } from 'react';

+import { AIGroupButton } from './AIButton';
 import { MarkdownButton } from './MarkdownButton';

 export const BlockNoteToolbar = () => {
@@ -17,8 +17,7 @@ export const BlockNoteToolbar = () => {
        {getFormattingToolbarItems(blockTypeSelectItems)}

        {/* Extra button to do some AI powered actions */}
-        {/* <AIGroupButton key="AIButton" /> */}
-        <AIToolbarButton key="AIButton" />
+        <AIGroupButton key="AIButton" />

        {/* Extra button to convert from markdown to json */}
        <MarkdownButton key="customButton" />
@@ -5,7 +5,7 @@ import {
  useSelectedBlocks,
 } from '@blocknote/react';
 import { forEach, isArray } from 'lodash';
-import { useMemo } from 'react';
+import React, { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';

 type Block = {
@@ -80,11 +80,11 @@ export function MarkdownButton() {
  }

  return (
-    <Components.Toolbar.Button
+    <Components.FormattingToolbar.Button
      mainTooltip={t('Convert Markdown')}
      onClick={handleConvertMarkdown}
    >
      M
-    </Components.Toolbar.Button>
+    </Components.FormattingToolbar.Button>
  );
 }
@@ -1,87 +0,0 @@
-import { css } from 'styled-components';
-
-export const cssEditor = (readonly: boolean) => css`
-  &,
-  & > .bn-container,
-  & .ProseMirror {
-    height: 100%;
-
-    .bn-side-menu[data-block-type='heading'][data-level='1'] {
-      height: 50px;
-    }
-    .bn-side-menu[data-block-type='heading'][data-level='2'] {
-      height: 43px;
-    }
-    .bn-side-menu[data-block-type='heading'][data-level='3'] {
-      height: 35px;
-    }
-    h1 {
-      font-size: 1.875rem;
-    }
-    h2 {
-      font-size: 1.5rem;
-    }
-    h3 {
-      font-size: 1.25rem;
-    }
-    a {
-      color: var(--c--theme--colors--greyscale-500);
-      cursor: pointer;
-    }
-    .bn-block-group
-      .bn-block-group
-      .bn-block-outer:not([data-prev-depth-changed]):before {
-      border-left: none;
-    }
-  }
-
-  .bn-editor {
-    color: var(--c--theme--colors--greyscale-700);
-  }
-
-  .bn-block-outer:not(:first-child) {
-    &:has(h1) {
-      padding-top: 32px;
-    }
-    &:has(h2) {
-      padding-top: 24px;
-    }
-    &:has(h3) {
-      padding-top: 16px;
-    }
-  }
-
-  & .bn-inline-content code {
-    background-color: gainsboro;
-    padding: 2px;
-    border-radius: 4px;
-  }
-
-  @media screen and (width <= 560px) {
-    & .bn-editor {
-      ${readonly && `padding-left: 10px;`}
-    }
-    .bn-side-menu[data-block-type='heading'][data-level='1'] {
-      height: 46px;
-    }
-    .bn-side-menu[data-block-type='heading'][data-level='2'] {
-      height: 40px;
-    }
-    .bn-side-menu[data-block-type='heading'][data-level='3'] {
-      height: 40px;
-    }
-    & .bn-editor h1 {
-      font-size: 1.6rem;
-    }
-    & .bn-editor h2 {
-      font-size: 1.35rem;
-    }
-    & .bn-editor h3 {
-      font-size: 1.2rem;
-    }
-    .bn-block-content[data-is-empty-and-focused][data-content-type='paragraph']
-      .bn-inline-content:has(> .ProseMirror-trailingBreak:only-child)::before {
-      font-size: 14px;
-    }
-  }
-`;
@@ -35,10 +35,6 @@
    "eslint": "8.57.0",
    "react": "18.3.1",
    "react-dom": "18.3.1",
-    "typescript": "5.7.3",
-    "@blocknote/core": "https://gitpkg.vercel.app/typecellOS/blocknote/packages/core?ai-block-built&v=3",
-    "@blocknote/mantine": "https://gitpkg.vercel.app/typecellOS/blocknote/packages/mantine?ai-block-built&v=3",
-    "@blocknote/react": "https://gitpkg.vercel.app/typecellOS/blocknote/packages/react?ai-block-built&v=3",
-    "@blocknote/xl-ai": "https://gitpkg.vercel.app/typecellOS/blocknote/packages/xl-ai?ai-block-built&v=3"
+    "typescript": "5.7.3"
  }
 }