tiptapify 0.3.2 → 0.3.4

package/src/i18n/locales/th.json

@@ -65,6 +65,8 @@
     },
     "image": {
       "alt": "ข้อความทางเลือก",
+      "caption": "คำบรรยายภาพ",
+      "caption_placeholder": "เพิ่มคำบรรยายภาพ…",
       "dialog_title": "เพิ่ม/แก้ไขรูปภาพ",
       "height": "ความสูง",
       "keep_ratio": "รักษาสัดส่วน",
@@ -121,6 +123,16 @@
     "indent": "เพิ่มการเยื้อง",
     "numbered": "รายการแบบมีหมายเลข",
     "outdent": "ลดการเยื้อง",
+    "styles": {
+      "circle": "Circle",
+      "default": "Default",
+      "lower_alpha": "Lower alpha",
+      "lower_greek": "Lower Greek",
+      "lower_roman": "Lower Roman",
+      "square": "Square",
+      "upper_alpha": "Upper alpha",
+      "upper_roman": "Upper Roman"
+    },
     "task": "รายการงาน"
   },
   "media": {
@@ -161,7 +173,17 @@
     },
     "iframe": "กรอบฝังตัว",
     "image": "รูปภาพ",
+    "image_toolbar": {
+      "align_left": "Align left",
+      "align_right": "Align right",
+      "delete": "Remove",
+      "download": "Download",
+      "edit": "Edit or replace",
+      "move_back": "Move one slide back",
+      "move_forward": "Move one slide forward"
+    },
     "link": "ลิงก์ภายนอก",
+    "slider": "สไลด์",
     "tables": {
       "col": "คอลัมน์",
       "cols": "คอลัมน์",

package/src/i18n/locales/tr.json

@@ -65,6 +65,8 @@
     },
     "image": {
       "alt": "Alternatif metin",
+      "caption": "Açıklama",
+      "caption_placeholder": "Açıklama ekleyin…",
       "dialog_title": "Görsel ekle/düzenle",
       "height": "Yükseklik",
       "keep_ratio": "En boy oranını koru",
@@ -121,6 +123,16 @@
     "indent": "Girintiyi artır",
     "numbered": "Numaralı liste",
     "outdent": "Girintiyi azalt",
+    "styles": {
+      "circle": "Circle",
+      "default": "Default",
+      "lower_alpha": "Lower alpha",
+      "lower_greek": "Lower Greek",
+      "lower_roman": "Lower Roman",
+      "square": "Square",
+      "upper_alpha": "Upper alpha",
+      "upper_roman": "Upper Roman"
+    },
     "task": "Görev listesi"
   },
   "media": {
@@ -161,7 +173,17 @@
     },
     "iframe": "iframe",
     "image": "Görsel",
+    "image_toolbar": {
+      "align_left": "Align left",
+      "align_right": "Align right",
+      "delete": "Remove",
+      "download": "Download",
+      "edit": "Edit or replace",
+      "move_back": "Move one slide back",
+      "move_forward": "Move one slide forward"
+    },
     "link": "Harici bağlantı",
+    "slider": "Slayt",
     "tables": {
       "col": "Sütun",
       "cols": "Sütunlar",

package/src/i18n/locales/uk.json

@@ -65,10 +65,12 @@
     },
     "image": {
       "alt": "alt",
+      "caption": "Підпис",
+      "caption_placeholder": "Додайте підпис…",
       "dialog_title": "Додавання/зміна зображення",
       "height": "Висота",
       "keep_ratio": "Зберігати пропорції",
-      "src": "Джерело",
+      "src": "Адреса зображення",
       "title": "Заголовок",
       "width": "Ширина"
     },
@@ -121,6 +123,16 @@
     "indent": "Збільшити відступ елемента списку",
     "numbered": "Нумерований список",
     "outdent": "Зменшити відступ елемента списку",
+    "styles": {
+      "circle": "Коло",
+      "default": "Типовий",
+      "lower_alpha": "Малі літери",
+      "lower_greek": "Грецькі літери",
+      "lower_roman": "Малі римські",
+      "square": "Квадрат",
+      "upper_alpha": "Великі літери",
+      "upper_roman": "Великі римські"
+    },
     "task": "Список задач"
   },
   "media": {
@@ -161,7 +173,17 @@
     },
     "iframe": "iframe",
     "image": "Зображення",
+    "image_toolbar": {
+      "align_left": "Ліворуч, з обтіканням",
+      "align_right": "Праворуч, з обтіканням",
+      "delete": "Видалити",
+      "download": "Завантажити",
+      "edit": "Змінити або замінити",
+      "move_back": "На місце раніше",
+      "move_forward": "На місце пізніше"
+    },
     "link": "Зовнішнє посилання",
+    "slider": "Слайдер",
     "tables": {
       "col": "Стовпчик",
       "cols": "Стовпчики",

package/src/i18n/locales/vi.json

@@ -65,6 +65,8 @@
     },
     "image": {
       "alt": "Văn bản thay thế",
+      "caption": "Chú thích",
+      "caption_placeholder": "Thêm chú thích…",
       "dialog_title": "Thêm/sửa hình ảnh",
       "height": "Chiều cao",
       "keep_ratio": "Giữ tỷ lệ khung hình",
@@ -121,6 +123,16 @@
     "indent": "Tăng thụt đầu dòng",
     "numbered": "Danh sách có đánh số",
     "outdent": "Giảm thụt đầu dòng",
+    "styles": {
+      "circle": "Circle",
+      "default": "Default",
+      "lower_alpha": "Lower alpha",
+      "lower_greek": "Lower Greek",
+      "lower_roman": "Lower Roman",
+      "square": "Square",
+      "upper_alpha": "Upper alpha",
+      "upper_roman": "Upper Roman"
+    },
     "task": "Danh sách công việc"
   },
   "media": {
@@ -161,7 +173,17 @@
     },
     "iframe": "khung nhúng",
     "image": "Hình ảnh",
+    "image_toolbar": {
+      "align_left": "Align left",
+      "align_right": "Align right",
+      "delete": "Remove",
+      "download": "Download",
+      "edit": "Edit or replace",
+      "move_back": "Move one slide back",
+      "move_forward": "Move one slide forward"
+    },
     "link": "Liên kết ngoài",
+    "slider": "Trình chiếu",
     "tables": {
       "col": "Cột",
       "cols": "Cột",

package/src/index.test.ts

@@ -0,0 +1,88 @@
+import { readFileSync } from 'node:fs'
+import path from 'node:path'
+import { describe, expect, it } from 'vitest'
+import { registerSkin, defineSkin } from '@tiptapify/index'
+import { registerSkin as fromRegistry, defineSkin as defineFromRegistry } from '@tiptapify/skins/registry'
+
+describe('package entry exports', () => {
+  it('exports registerSkin and defineSkin as functions', () => {
+    expect(typeof registerSkin).toBe('function')
+    expect(typeof defineSkin).toBe('function')
+  })
+
+  it('re-exports the registry functions, not copies', () => {
+    expect(registerSkin).toBe(fromRegistry)
+    expect(defineSkin).toBe(defineFromRegistry)
+  })
+
+  it('defineSkin is identity: the same object comes back', () => {
+    const skin = { extends: 'pastel', colors: { toolbarBg: 'rebeccapurple' } }
+
+    expect(defineSkin(skin)).toBe(skin)
+  })
+})
+
+describe('index.d.ts skin-type parity with src/types/editor.ts', () => {
+  // index.d.ts is hand-mirrored from the source types; this guard compares the
+  // exported skin-type declarations member-for-member (declared shape, not
+  // comments/formatting), ending the silent-drift risk of the hand mirror.
+  const SKIN_TYPES = [
+    'TiptapifySkin',
+    'TiptapifyShape',
+    'ResolvedShape',
+    'TiptapifySkinColors',
+    'TiptapifySkinMetrics',
+    'TiptapifySkinConfig',
+    'TiptapifySkinInput',
+  ]
+
+  // cwd is the vitest root (the repo): the guard pins files of the package root
+  const dts = readFileSync(path.resolve(process.cwd(), 'index.d.ts'), 'utf8')
+  const source = readFileSync(path.resolve(process.cwd(), 'src/types/editor.ts'), 'utf8')
+
+  // The declaration block of `name`: a brace body to its closing brace,
+  // an alias body (no `{` on the header line) to the end of its line.
+  // Constraints of this extractor, adequate for the skin blocks it pins:
+  // declarations must be single-line aliases or brace-bodied types (the
+  // index.d.ts mirror style); the `//`-stripping in normalize treats any
+  // `//` as a comment start, so these blocks must contain no URLs in strings.
+  function declaration (file: string, name: string): string {
+    const lines = file.split('\n')
+    const start = lines.findIndex((line) => new RegExp(`^export (interface|type) ${name}\\b`).test(line))
+    if (start < 0) return ''
+    if (lines[start].indexOf('{') < 0) return lines[start]
+    let depth = 0
+    for (let i = start; i < lines.length; i++) {
+      for (const ch of lines[i]) {
+        if (ch === '{') depth++
+        if (ch === '}') depth--
+      }
+      if (depth === 0) return lines.slice(start, i + 1).join('\n')
+    }
+    return ''
+  }
+
+  // Tolerant to the formatting freedom of a hand-written mirror: interface vs type
+  // literal, comments, indentation, line breaks inside the body
+  function normalize (block: string, name: string): string {
+    return block
+      .split('\n')
+      .map((line) => line.replace(/\/\/.*$/, ''))
+      .join(' ')
+      .replace(new RegExp(`interface ${name} \\{`), `${name} {`)
+      .replace(new RegExp(`type ${name} = \\{`), `${name} {`)
+      .replace(/\s+/g, ' ')
+      .trim()
+  }
+
+  for (const name of SKIN_TYPES) {
+    it(`${name} is mirrored member-for-member`, () => {
+      const inDts = declaration(dts, name)
+      const inSource = declaration(source, name)
+
+      expect(inDts, `${name} missing from index.d.ts`).not.toBe('')
+      expect(inSource, `${name} missing from src/types/editor.ts`).not.toBe('')
+      expect(normalize(inDts, name)).toBe(normalize(inSource, name))
+    })
+  }
+})

package/src/index.ts

@@ -4,6 +4,7 @@ import TiptapifyDialog from '@tiptapify/components/UI/TiptapifyDialog.vue'
 import { useTiptapifyConfig } from '@tiptapify/composables/useTiptapifyConfig'
 import { TiptapifyFooterAlignment } from '@tiptapify/types/editor'
 import { createAiBackendProvider } from '@tiptapify/extensions/components/ai/backend'
+import { registerSkin, defineSkin } from '@tiptapify/skins/registry'
 
 import { Editor as TipTapEditor, nodeViewProps, NodeViewWrapper, VueNodeViewRenderer } from '@tiptap/vue-3'
 import { Node, Mark, markInputRule, markPasteRule, mergeAttributes } from '@tiptap/core'
@@ -13,6 +14,9 @@ import * as mdi from '@mdi/js'
 
 import { messages } from './i18n'
 
+// The shared menu skin stylesheet: shipped in the dist CSS next to the SFC styles (spec: Menu CSS strategy)
+import './skins/menu.css'
+
 interface PackageOptions {
   i18n?: any;
 }
@@ -46,11 +50,22 @@ export {
   markInputRule,
   markPasteRule,
   mergeAttributes,
+  registerSkin,
+  defineSkin,
 }
 
 export type { TiptapifyConfig } from '@tiptapify/composables/useTiptapifyConfig'
 export type { TiptapifyFooterAlignment }
 export type { CommandProps, InputRuleMatch, PasteRuleMatch }
+export type {
+  TiptapifySkin,
+  TiptapifyShape,
+  TiptapifySkinColors,
+  TiptapifySkinMetrics,
+  TiptapifySkinConfig,
+  TiptapifySkinInput,
+  ResolvedShape,
+} from '@tiptapify/types/editor'
 export type {
   TiptapifyAiBackendProviderOptions,
   TiptapifyAiBackendRequest,