There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.
TypeScript appcrdteditorelectronknowledge-basemarkdownmironotesnotionnotion-alternativerustrust-langrust-languagetabletableviewwhiteboardwikiworkspace
feat(editor): support user provided role and role schema (#10939)
Saul-Mirone9f3cf271e3ef
diff --git a/blocksuite/affine/blocks/block-surface/src/surface-model.ts b/blocksuite/affine/blocks/block-surface/src/surface-model.tsindex 3db3869206..03137f13e2 100644--- a/blocksuite/affine/blocks/block-surface/src/surface-model.ts+++ b/blocksuite/affine/blocks/block-surface/src/surface-model.ts@@ -21,7 +21,7 @@ export const SurfaceBlockSchema = defineBlockSchema({metadata: {version: 5,role: 'hub',- parent: ['affine:page'],+ parent: ['@root'],children: ['affine:frame','affine:image',diff --git a/blocksuite/affine/model/src/blocks/note/note-model.ts b/blocksuite/affine/model/src/blocks/note/note-model.tsindex 4967fc7698..46a0261daf 100644--- a/blocksuite/affine/model/src/blocks/note/note-model.ts+++ b/blocksuite/affine/model/src/blocks/note/note-model.ts@@ -25,7 +25,6 @@ import {StrokeStyleSchema,} from '../../consts/note';import { type Color, ColorSchema, DefaultTheme } from '../../themes';-import { TableModelFlavour } from '../table';export const NoteZodSchema = z.object({@@ -74,22 +73,12 @@ export const NoteBlockSchema = defineBlockSchema({metadata: {version: 1,role: 'hub',- parent: ['affine:page'],+ parent: ['@root'],children: [- 'affine:paragraph',- 'affine:list',- 'affine:code',- 'affine:divider',+ '@content','affine:database','affine:data-view',- 'affine:image',- 'affine:bookmark',- 'affine:attachment',- 'affine:surface-ref',- 'affine:embed-*',- 'affine:latex','affine:callout',- TableModelFlavour,],},toModel: () => {diff --git a/blocksuite/framework/store/src/__tests__/schema.unit.spec.ts b/blocksuite/framework/store/src/__tests__/schema.unit.spec.tsindex 7828e6e245..039877a2a2 100644--- a/blocksuite/framework/store/src/__tests__/schema.unit.spec.ts+++ b/blocksuite/framework/store/src/__tests__/schema.unit.spec.ts@@ -54,6 +54,34 @@ const TestInvalidNoteBlockSchemaExtension = BlockSchemaExtension(TestInvalidNoteBlockSchema);+const TestRoleBlockSchema = defineBlockSchema({+ flavour: 'affine:note-block-role-test',+ metadata: {+ version: 1,+ role: 'content',+ parent: ['affine:note'],+ children: ['@test'],+ },+ props: internal => ({+ text: internal.Text(),+ }),+});++const TestRoleBlockSchemaExtension = BlockSchemaExtension(TestRoleBlockSchema);++const TestParagraphBlockSchema = defineBlockSchema({+ flavour: 'affine:test-paragraph',+ metadata: {+ version: 1,+ role: 'test',+ parent: ['@content'],+ },+});++const TestParagraphBlockSchemaExtension = BlockSchemaExtension(+ TestParagraphBlockSchema+);+const extensions = [RootBlockSchemaExtension,ParagraphBlockSchemaExtension,@@ -62,6 +90,8 @@ const extensions = [DividerBlockSchemaExtension,TestCustomNoteBlockSchemaExtension,TestInvalidNoteBlockSchemaExtension,+ TestRoleBlockSchemaExtension,+ TestParagraphBlockSchemaExtension,];const defaultDocId = 'doc0';@@ -128,4 +158,28 @@ describe('schema', () => {return call[0] instanceof SchemaValidateError;});});++ it('should be able to validate schema by role', () => {+ const consoleMock = vi+ .spyOn(console, 'error')+ .mockImplementation(() => undefined);+ const doc = createTestDoc();+ const rootId = doc.addBlock('affine:page', {});+ const noteId = doc.addBlock('affine:note', {}, rootId);+ const roleId = doc.addBlock('affine:note-block-role-test', {}, noteId);++ doc.addBlock('affine:paragraph', {}, roleId);+ doc.addBlock('affine:paragraph', {}, roleId);++ expect(consoleMock.mock.calls[1]).toSatisfy((call: unknown[]) => {+ return call[0] instanceof SchemaValidateError;+ });++ consoleMock.mockClear();+ doc.addBlock('affine:test-paragraph', {}, roleId);+ doc.addBlock('affine:test-paragraph', {}, roleId);+ expect(consoleMock).not.toBeCalled();++ expect(doc.getBlocksByFlavour('affine:test-paragraph')).toHaveLength(2);+ });});diff --git a/blocksuite/framework/store/src/model/block/zod.ts b/blocksuite/framework/store/src/model/block/zod.tsindex 2458b65295..6472a1c7c1 100644--- a/blocksuite/framework/store/src/model/block/zod.ts+++ b/blocksuite/framework/store/src/model/block/zod.ts@@ -8,10 +8,9 @@ import type { BlockModel } from './block-model.js';const FlavourSchema = z.string();const ParentSchema = z.array(z.string()).optional();const ContentSchema = z.array(z.string()).optional();-const role = ['root', 'hub', 'content'] as const;-const RoleSchema = z.enum(role);+const RoleSchema = z.string();-export type RoleType = (typeof role)[number];+export type RoleType = 'root' | 'content' | string;export interface InternalPrimitives {Text: (input?: Y.Text | string) => Text;diff --git a/blocksuite/framework/store/src/schema/schema.ts b/blocksuite/framework/store/src/schema/schema.tsindex a74dd47d30..744c4ba667 100644--- a/blocksuite/framework/store/src/schema/schema.ts+++ b/blocksuite/framework/store/src/schema/schema.ts@@ -59,7 +59,7 @@ export class Schema {if (!parentFlavour) {throw new SchemaValidateError(schema.model.flavour,- 'Hub/Content must have parent.'+ 'None root block must have parent.');}@@ -86,33 +86,84 @@ export class Schema {);}+ private _matchFlavourOrRole(+ childValue: string,+ parentValue: string,+ childRole: string,+ parentRole: string+ ): boolean {+ // Check if either value starts with '@' indicating it's a role+ const isChildRole = childValue.startsWith('@');+ const isParentRole = parentValue.startsWith('@');++ // If both are roles, do exact match+ if (isChildRole && isParentRole) {+ return childValue === parentValue;+ }+ // If child is role, compare with parent's actual role+ if (isChildRole) {+ return childValue === `@${parentRole}`;+ }+ // If parent is role, compare with child's actual role+ if (isParentRole) {+ return parentValue === `@${childRole}`;+ }+ // If neither is role, use flavour matching+ return this._matchFlavour(childValue, parentValue);+ }+private _validateParent(child: BlockSchemaType,parent: BlockSchemaType): boolean {const _childFlavour = child.model.flavour;const _parentFlavour = parent.model.flavour;-- const childValidFlavours = child.model.parent || ['*'];- const parentValidFlavours = parent.model.children || ['*'];-- return parentValidFlavours.some(parentValidFlavour => {- return childValidFlavours.some(childValidFlavour => {- if (parentValidFlavour === '*' && childValidFlavour === '*') {+ const _childRole = child.model.role;+ const _parentRole = parent.model.role;++ const childValidFlavourOrRole = child.model.parent || ['*'];+ const parentValidFlavourOrRole = parent.model.children || ['*'];++ return parentValidFlavourOrRole.some(parentValidFlavourOrRole => {+ return childValidFlavourOrRole.some(childValidFlavourOrRole => {+ if (+ parentValidFlavourOrRole === '*' &&+ childValidFlavourOrRole === '*'+ ) {return true;}- if (parentValidFlavour === '*') {- return this._matchFlavour(childValidFlavour, _parentFlavour);+ if (parentValidFlavourOrRole === '*') {+ return this._matchFlavourOrRole(+ childValidFlavourOrRole,+ _parentFlavour,+ _childRole,+ _parentRole+ );}- if (childValidFlavour === '*') {- return this._matchFlavour(_childFlavour, parentValidFlavour);+ if (childValidFlavourOrRole === '*') {+ return this._matchFlavourOrRole(+ _childFlavour,+ parentValidFlavourOrRole,+ _childRole,+ _parentRole+ );}return (- this._matchFlavour(_childFlavour, parentValidFlavour) &&- this._matchFlavour(childValidFlavour, _parentFlavour)+ this._matchFlavourOrRole(+ _childFlavour,+ parentValidFlavourOrRole,+ _childRole,+ _parentRole+ ) &&+ this._matchFlavourOrRole(+ childValidFlavourOrRole,+ _parentFlavour,+ _childRole,+ _parentRole+ ));});});@@ -120,7 +171,6 @@ export class Schema {private _validateRole(child: BlockSchemaType, parent: BlockSchemaType) {const childRole = child.model.role;- const parentRole = parent.model.role;const childFlavour = child.model.flavour;const parentFlavour = parent.model.flavour;@@ -130,20 +180,6 @@ export class Schema {`Root block cannot have parent: ${parentFlavour}.`);}-- if (childRole === 'hub' && parentRole === 'content') {- throw new SchemaValidateError(- childFlavour,- `Hub block cannot be child of content block: ${parentFlavour}.`- );- }-- if (childRole === 'content' && parentRole === 'root') {- throw new SchemaValidateError(- childFlavour,- `Content block can only be child of hub block or itself. But get: ${parentFlavour}.`- );- }}isValid(child: string, parent: string) {