tiptapify 0.1.5 → 0.2.0

package/src/i18n/locales/ja.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "単語数",
     "chars": "文字数"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/ko.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "단어",
     "chars": "글자"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/la.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "vārdi",
     "chars": "zīmes"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/lt.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "žodžiai",
     "chars": "simboliai"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/nl.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "woorden",
     "chars": "tekens"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/pl.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "słowa",
     "chars": "znaki"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/pt.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "palavras",
     "chars": "caracteres"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/ru.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "слова",
     "chars": "символы"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/se.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "ord",
     "chars": "tecken"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/th.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "คำ",
     "chars": "ตัวอักษร"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/tr.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "kelime",
     "chars": "karakter"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/uk.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "слова",
     "chars": "символи"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/i18n/locales/vi.json

@@ -172,5 +172,34 @@
   "footer": {
     "words": "từ ngữ",
     "chars": "ký tự"
+  },
+  "ai": {
+    "title": "AI assistant",
+    "prompt": "Prompt",
+    "examples": "Examples",
+    "generate": "Generate",
+    "apply": "Apply",
+    "result": "Result",
+    "loading": "Generating...",
+    "unavailable": "Configure an AI provider to use this action",
+    "error": "AI generation failed",
+    "defaultExamples": {
+      "improve": {
+        "title": "Improve writing",
+        "prompt": "Improve the clarity and tone of this text."
+      },
+      "proofReading": {
+        "title": "Proof-reading",
+        "prompt": "Correct grammar, spelling, and punctuation without changing the meaning."
+      },
+      "summarize": {
+        "title": "Summarize",
+        "prompt": "Summarize this text in a concise paragraph."
+      },
+      "expand": {
+        "title": "Expand",
+        "prompt": "Expand this into a more detailed version."
+      }
+    }
   }
 }

package/src/index.ts

@@ -40,4 +40,18 @@ export {
   mergeAttributes,
 }
 
-export type { CommandProps, InputRuleMatch, PasteRuleMatch }
+export type { CommandProps, InputRuleMatch, PasteRuleMatch }
+export type {
+  TiptapifyAiMode,
+  TiptapifyAiOptions,
+  TiptapifyAiChatMessage,
+  TiptapifyAiChatRole,
+  TiptapifyAiEditorContext,
+  TiptapifyAiOpenAiResponse,
+  TiptapifyAiPromptExample,
+  TiptapifyAiProvider,
+  TiptapifyAiRequest,
+  TiptapifyAiResponse,
+  TiptapifyAiStorage,
+  TiptapifyAiTokenProvider,
+} from '@tiptapify/types/editor'

package/src/types/editor.ts

@@ -7,4 +7,77 @@ declare class TiptapifyEditor extends Editor {
 export { TiptapifyEditor }
 
 export type variantBtnTypes = 'outlined' | 'plain' | 'flat' | 'text' | 'elevated' | 'tonal' | undefined
-export type variantFieldTypes = 'outlined' | 'plain' | 'filled' | 'solo' | 'solo-filled' | 'solo-inverted' | 'underlined' | undefined
+export type variantFieldTypes = 'outlined' | 'plain' | 'filled' | 'solo' | 'solo-filled' | 'solo-inverted' | 'underlined' | undefined
+
+export type TiptapifyAiMode = 'insert' | 'replace' | 'append'
+
+export type TiptapifyAiPromptExample = {
+  title: string,
+  prompt: string,
+}
+
+export type TiptapifyAiChatRole = 'system' | 'user' | 'assistant' | 'developer' | 'tool'
+
+export type TiptapifyAiChatMessage = {
+  role: TiptapifyAiChatRole,
+  content: string,
+}
+
+export type TiptapifyAiEditorContext = {
+  prompt: string,
+  selectedText: string,
+  text: string,
+  html: string,
+  json: object,
+  mode: TiptapifyAiMode,
+}
+
+export type TiptapifyAiRequest = {
+  model?: string,
+  messages: TiptapifyAiChatMessage[],
+  temperature?: number,
+  stream?: false,
+  [key: string]: unknown,
+}
+
+export type TiptapifyAiResponse = {
+  content: string,
+}
+
+export type 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 type TiptapifyAiStorage = {
+  getItem: (key: string) => string | null | Promise<string | null>,
+  setItem: (key: string, value: string) => void | Promise<void>,
+  removeItem: (key: string) => void | Promise<void>,
+}
+
+export type 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,
+}
+
+export type TiptapifyAiResolvedOptions = TiptapifyAiOptions & {
+  enabled: boolean,
+  promptExamples: TiptapifyAiPromptExample[],
+}

package/src/types/toolbarTypes.ts

@@ -2,6 +2,7 @@ import { Component } from 'vue'
 
 export enum ToolbarSectionsEnum {
   actions = 'actions',
+  ai = 'ai',
   alignment = 'alignment',
   extra = 'extra',
   formatExtra = 'formatExtra',
@@ -27,4 +28,4 @@ export type section = {
 
 export type toolbarSections = Array<section>
 
-export type itemsPropType = { [key: string]: string[] } | string[]
+export type itemsPropType = { [key: string]: string[] } | string[]

package/src/utils/helpers.test.ts

@@ -0,0 +1,32 @@
+import { describe, it, expect } from 'vitest'
+import helpers from './helpers'
+
+describe('ucFirst', () => {
+  it('capitalizes the first character of a string', () => {
+    expect(helpers.ucFirst('hello')).toBe('Hello')
+  })
+
+  it('returns empty string for empty input', () => {
+    expect(helpers.ucFirst('')).toBe('')
+  })
+
+  it('converts snake_case to words and capitalizes', () => {
+    expect(helpers.ucFirst('hello_world', true)).toBe('Hello world')
+  })
+
+  it('converts kebab-case to words and capitalizes', () => {
+    expect(helpers.ucFirst('hello-world', false, true)).toBe('Hello world')
+  })
+
+  it('converts both snake_case and kebab-case', () => {
+    expect(helpers.ucFirst('hello_world-test', true, true)).toBe('Hello world test')
+  })
+
+  it('handles already capitalized string', () => {
+    expect(helpers.ucFirst('Hello')).toBe('Hello')
+  })
+
+  it('handles single character', () => {
+    expect(helpers.ucFirst('a')).toBe('A')
+  })
+})