Merge pull request #97 from Sozialarchiv/master

jsdoc types processing added, refs #88.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editorjs/list",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "keywords": [
     "codex editor",
     "list",
@@ -15,10 +15,12 @@
   ],
   "main": "./dist/list.umd.js",
   "module": "./dist/list.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/list.mjs",
-      "require": "./dist/list.umd.js"
+      "require": "./dist/list.umd.js",
+      "types": "./dist/index.d.ts"
     }
   },
   "scripts": {
@@ -32,8 +34,10 @@
   "devDependencies": {
     "postcss-nested": "^4.2.1",
     "postcss-nested-ancestors": "^2.0.0",
+    "typescript": "^5.5.3",
     "vite": "^4.5.0",
-    "vite-plugin-css-injected-by-js": "^3.3.0"
+    "vite-plugin-css-injected-by-js": "^3.3.0",
+    "vite-plugin-dts": "^3.9.1"
   },
   "dependencies": {
     "@codexteam/icons": "^0.0.4"

src/index.js

@@ -5,6 +5,10 @@ import './index.css';
 
 import { IconListBulleted, IconListNumbered } from '@codexteam/icons'
 
+/**
+ * @typedef {import('@editorjs/editorjs').PasteEvent} PasteEvent
+ */
+
 /**
  * @typedef {object} ListData
  * @property {string} style - can be ordered or unordered

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist",
+  }
+}

vite.config.js

@@ -1,6 +1,7 @@
 import path from "path";
 import cssInjectedByJsPlugin from "vite-plugin-css-injected-by-js";
 import * as pkg from "./package.json";
+import dts from 'vite-plugin-dts';
 
 const NODE_ENV = process.argv.mode || "development";
 const VERSION = pkg.version;
@@ -19,5 +20,5 @@ export default {
     VERSION: JSON.stringify(VERSION),
   },
 
-  plugins: [cssInjectedByJsPlugin()],
+  plugins: [cssInjectedByJsPlugin(), dts({tsconfigPath: './tsconfig.json'})],
 };