Skip to content

Open-source and local-first Slack and Notion alternative that puts you in control of your data

1.7 KB
Raw Blame
import { z } from 'zod/v4';

import { Node, NodeAttributes } from '@colanode/core/registry/nodes';
import { Mention } from '@colanode/core/types/mentions';
import { WorkspaceRole } from '@colanode/core/types/workspaces';

export type NodeRole = 'admin' | 'editor' | 'collaborator' | 'viewer';
export const nodeRoleEnum = z.enum([
  'admin',
  'editor',
  'collaborator',
  'viewer',
]);

export interface NodeMutationUser {
  id: string;
  role: WorkspaceRole;
  workspaceId: string;
  accountId: string;
}

export type CanCreateNodeContext = {
  user: NodeMutationUser;
  tree: Node[];
  attributes: NodeAttributes;
};

export type CanUpdateAttributesContext = {
  user: NodeMutationUser;
  tree: Node[];
  node: Node;
  attributes: NodeAttributes;
};

export type CanUpdateDocumentContext = {
  user: NodeMutationUser;
  tree: Node[];
  node: Node;
};

export type CanDeleteNodeContext = {
  user: NodeMutationUser;
  tree: Node[];
  node: Node;
};

export interface CanReactNodeContext {
  user: NodeMutationUser;
  tree: Node[];
  node: Node;
}

export type NodeText = {
  name: string | null | undefined;
  attributes: string | null | undefined;
};

export interface NodeModel {
  type: string;
  attributesSchema: z.ZodType;
  documentSchema?: z.ZodType;
  canCreate: (context: CanCreateNodeContext) => boolean;
  canUpdateAttributes: (context: CanUpdateAttributesContext) => boolean;
  canUpdateDocument: (context: CanUpdateDocumentContext) => boolean;
  canDelete: (context: CanDeleteNodeContext) => boolean;
  canReact: (context: CanReactNodeContext) => boolean;
  extractText: (id: string, attributes: NodeAttributes) => NodeText | null;
  extractMentions: (id: string, attributes: NodeAttributes) => Mention[];
}