feat: Improve typings (#196)

Jungwoo-An · May 8, 2022 · e58b7ba · e58b7ba
1 parent f5d4731
commit e58b7ba
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 33 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/packages/@react-editor-js/client/src/ReactEditorJSClient.tsx b/packages/@react-editor-js/client/src/ReactEditorJSClient.tsx
@@ -1,14 +1,9 @@
 import React from 'react'
-import {
-  Props as ReactEditorJSProps,
-  ReactEditorJS,
-} from '@react-editor-js/core'
+import { WrapperProps as Props, ReactEditorJS } from '@react-editor-js/core'
 
 import { ClientEditorCore } from './client-editor-core'
 import { EditorConfig } from '@editorjs/editorjs'
 
-export type Props = Omit<ReactEditorJSProps, 'factory'>
-
 function ReactEditorJSClient(props: Props) {
   const factory = React.useCallback(
     (config: EditorConfig) => new ClientEditorCore(config),

diff --git a/packages/@react-editor-js/core/src/component-types.ts b/packages/@react-editor-js/core/src/component-types.ts
@@ -14,3 +14,5 @@ export interface Props extends Omit<EditorConfig, 'data'> {
 
   onInitialize?: (core: EditorCore) => void
 }
+
+export type WrapperProps = Omit<Props, 'factory'>
diff --git a/packages/@react-editor-js/server/package.json b/packages/@react-editor-js/server/package.json
@@ -15,7 +15,6 @@
   "peerDependencies": {
     "@editorjs/editorjs": "*",
     "@editorjs/paragraph": "*",
-    "@react-editor-js/core": "2.0.6",
     "react": "*"
   },
   "dependencies": {

diff --git a/packages/@react-editor-js/server/src/ReactEditorJSServer.tsx b/packages/@react-editor-js/server/src/ReactEditorJSServer.tsx
@@ -1,14 +1,9 @@
 import React from 'react'
-import {
-  Props as ReactEditorJSProps,
-  ReactEditorJS,
-} from '@react-editor-js/core'
+import { WrapperProps as Props, ReactEditorJS } from '@react-editor-js/core'
 import { EditorConfig } from '@editorjs/editorjs'
 
 import { ServerEditorCore } from './server-editor-core'
 
-export type Props = Omit<ReactEditorJSProps, 'factory'>
-
 function ReactEditorJSServer(props: Props) {
   const factory = React.useCallback(
     (config: EditorConfig) => new ServerEditorCore(config),

diff --git a/packages/react-editor-js/package.json b/packages/react-editor-js/package.json
@@ -4,20 +4,17 @@
   "description": "The unofficial editor-js component for React",
   "main": "./dist/react-editor-js.cjs.js",
   "module": "./dist/react-editor-js.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/react-editor-js/src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/Jungwoo-An/react-editor-js.git"
   },
   "bugs": {
     "url": "https://github.com/Jungwoo-An/react-editor-js/issues"
   },
-  "peerDependencies": {
-    "@react-editor-js/client": "2.0.6",
-    "@react-editor-js/server": "2.0.6"
-  },
   "dependencies": {
     "@react-editor-js/client": "2.0.6",
+    "@react-editor-js/core": "2.0.6",
     "@react-editor-js/server": "2.0.6"
   },
   "devDependencies": {

diff --git a/packages/react-editor-js/src/factory.ts b/packages/react-editor-js/src/factory.ts
@@ -1,4 +1,6 @@
-export function createReactEditorJS() {
+import { WrapperProps } from '@react-editor-js/core'
+
+export function createReactEditorJS(): (props: WrapperProps) => JSX.Element {
   if (typeof window !== 'undefined') {
     const Component = require('@react-editor-js/client')
     return Component.default || Component

diff --git a/yarn.lock b/yarn.lock
@@ -821,13 +821,13 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@react-editor-js/client@2.0.5, @react-editor-js/client@workspace:packages/@react-editor-js/client":
+"@react-editor-js/client@2.0.6, @react-editor-js/client@workspace:packages/@react-editor-js/client":
   version: 0.0.0-use.local
   resolution: "@react-editor-js/client@workspace:packages/@react-editor-js/client"
   dependencies:
     "@editorjs/editorjs": "*"
     "@editorjs/paragraph": "*"
-    "@react-editor-js/core": 2.0.5
+    "@react-editor-js/core": 2.0.6
     "@types/react": "*"
     react: "*"
     tslib: ^2.3.1
@@ -839,7 +839,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@react-editor-js/core@2.0.5, @react-editor-js/core@workspace:packages/@react-editor-js/core":
+"@react-editor-js/core@2.0.6, @react-editor-js/core@workspace:packages/@react-editor-js/core":
   version: 0.0.0-use.local
   resolution: "@react-editor-js/core@workspace:packages/@react-editor-js/core"
   dependencies:
@@ -857,21 +857,20 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@react-editor-js/server@2.0.5, @react-editor-js/server@workspace:packages/@react-editor-js/server":
+"@react-editor-js/server@2.0.6, @react-editor-js/server@workspace:packages/@react-editor-js/server":
   version: 0.0.0-use.local
   resolution: "@react-editor-js/server@workspace:packages/@react-editor-js/server"
   dependencies:
     "@editorjs/editorjs": "*"
     "@editorjs/paragraph": "*"
-    "@react-editor-js/core": 2.0.5
+    "@react-editor-js/core": 2.0.6
     "@types/react": "*"
     react: "*"
     tslib: ^2.3.1
     typescript: ^4.3.5
   peerDependencies:
     "@editorjs/editorjs": "*"
     "@editorjs/paragraph": "*"
-    "@react-editor-js/core": 2.0.5
     react: "*"
   languageName: unknown
   linkType: soft
@@ -5803,14 +5802,12 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "react-editor-js@workspace:packages/react-editor-js"
   dependencies:
-    "@react-editor-js/client": 2.0.5
-    "@react-editor-js/server": 2.0.5
+    "@react-editor-js/client": 2.0.6
+    "@react-editor-js/core": 2.0.6
+    "@react-editor-js/server": 2.0.6
     "@types/node": ^16.11.6
     tslib: ^2.3.1
     typescript: ^4.3.5
-  peerDependencies:
-    "@react-editor-js/client": 2.0.5
-    "@react-editor-js/server": 2.0.5
   languageName: unknown
   linkType: soft