tiptapify/index.d.ts

Tiptap3 editor with Vuetify3 menu implementation

import { Editor as TiptapEditor, nodeViewProps, NodeViewWrapper, VueNodeViewRenderer } from '@tiptap/vue-3'
import {
  Extension,
  ExtendableConfig,
  InputRule,
  PasteRule,
  Node,
  Mark,
  markInputRule,
  markPasteRule,
  mergeAttributes
} from '@tiptap/core'
import type {
  AnyExtension,
  CanCommands,
  ChainedCommands,
  Command,
  CommandProps,
  Commands,
  Content,
  EditorOptions,
  EditorEvents,
  Extensions,
  ExtensionConfig,
  InputRuleMatch,
  JSONContent,
  MarkConfig,
  NodeConfig,
  PasteRuleMatch,
  Range,
  RawCommands,
  SingleCommands,
} from '@tiptap/core'

import '@tiptap/extensions'
import '@tiptap/extension-text-style'
import '@tiptap/extension-list'
import '@tiptap/extensions'
import '@tiptap/extension-document'
import '@tiptap/extension-text'
import '@tiptap/extension-paragraph'
import '@tiptap/extension-heading'
import '@tiptap/extension-bold'
import '@tiptap/extension-italic'
import '@tiptap/extension-strike'
import '@tiptap/extension-link'
import '@tiptap/extension-code'
import '@tiptap/extension-blockquote'
import '@tiptap/extension-hard-break'
import '@tiptap/extension-horizontal-rule'
import '@tiptap/extension-typography'
import '@tiptap/extension-highlight'
import '@tiptap/extension-image'
import '@tiptap/extension-youtube'
import '@tiptap/extension-superscript'
import '@tiptap/extension-subscript'
import '@tiptap/extension-text-align'
import '@tiptap/extension-underline'
import '@tiptap/extension-table'
import '@tiptap/extension-code-block-lowlight'
import '@tiptap/extension-invisible-characters'

import Tiptapify from './src/components/Tiptapify.vue'
import TiptapifyDialog from './src/components/UI/TiptapifyDialog.vue'
import * as mdi from '@mdi/js'

export type TiptapifyFooterAlignment = 'start' | 'center' | 'end'

export interface TiptapifyOptions {
  i18n?: string
}

export type TiptapifyAiMode = 'insert' | 'replace' | 'append'

export interface TiptapifyAiPromptExample {
  title: string
  prompt: string
}

export type TiptapifyAiChatRole = 'system' | 'user' | 'assistant' | 'developer' | 'tool'

export interface TiptapifyAiChatMessage {
  role: TiptapifyAiChatRole
  content: string
}

export interface TiptapifyAiEditorContext {
  prompt: string
  selectedText: string
  text: string
  html: string
  json: object
  mode: TiptapifyAiMode
}

export interface TiptapifyAiRequest {
  model?: string
  messages: TiptapifyAiChatMessage[]
  temperature?: number
  stream?: false
  [key: string]: unknown
}

export interface TiptapifyAiResponse {
  content: string
}

export interface TiptapifyAiOpenAiResponse {
  choices?: Array<{
    message?: {
      content?: string
    }
    text?: string
  }>
}

export type TiptapifyAiProvider = (request: TiptapifyAiRequest, context: TiptapifyAiEditorContext) => Promise<TiptapifyAiResponse | TiptapifyAiOpenAiResponse | string>

export type TiptapifyAiTokenProvider = () => Promise<string | null> | string | null

export interface TiptapifyAiStorage {
  getItem: (key: string) => string | null | Promise<string | null>
  setItem: (key: string, value: string) => void | Promise<void>
  removeItem: (key: string) => void | Promise<void>
}

export interface TiptapifyAiOptions {
  aiProvider?: TiptapifyAiProvider
  model?: string
  promptExamples?: TiptapifyAiPromptExample[]
  mode?: TiptapifyAiMode
  defaultPrompt?: string
  systemPrompt?: string
  temperature?: number
  chatCompletionOptions?: Record<string, unknown>
  createMessages?: (context: TiptapifyAiEditorContext) => TiptapifyAiChatMessage[]
  tokenProvider?: TiptapifyAiTokenProvider
  storage?: TiptapifyAiStorage
}

declare const TiptapifyPlugin: {
  install: (app: never, options?: TiptapifyOptions) => void
}

export default TiptapifyPlugin

export {
  mdi,
  Tiptapify,
  TiptapifyDialog,
  TiptapEditor,
  nodeViewProps,
  NodeViewWrapper,
  VueNodeViewRenderer,
  Extension,
  ExtendableConfig,
  InputRule,
  Mark,
  mergeAttributes,
  markInputRule,
  markPasteRule,
  Node,
  PasteRule,
}

export type {
  AnyExtension,
  CanCommands,
  ChainedCommands,
  Command,
  CommandProps,
  Commands,
  Content,
  EditorOptions,
  EditorEvents,
  Extensions,
  ExtensionConfig,
  InputRuleMatch,
  JSONContent,
  MarkConfig,
  NodeConfig,
  PasteRuleMatch,
  Range,
  RawCommands,
  SingleCommands,
}

declare module '@vue/runtime-core' {
  interface GlobalComponents {
    Tiptapify: typeof Tiptapify
  }
}