Fix TS types for editor package (WordPress#66754)

Co-authored-by: manzoorwanijk <[email protected]> Co-authored-by: youknowriad <[email protected]>
karthick-murugan · Nov 13, 2024 · e213e48 · e213e48
1 parent 424f359
commit e213e48
Show file tree

Hide file tree

Showing 6 changed files with 4 additions and 17 deletions.
diff --git a/docs/reference-guides/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md
@@ -786,7 +786,7 @@ Return true if the current post has already been published.
 _Parameters_
 
 -   _state_ `Object`: Global application state.
--   _currentPost_ `Object?`: Explicit current post for bypassing registry selector.
+-   _currentPost_ `[Object]`: Explicit current post for bypassing registry selector.
 
 _Returns_
 

diff --git a/packages/editor/README.md b/packages/editor/README.md
@@ -1631,10 +1631,6 @@ _Related_
 
 -   <https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore>
 
-_Type_
-
--   `Object`
-
 ### storeConfig
 
 Post editor data store configuration.
@@ -1643,10 +1639,6 @@ _Related_
 
 -   <https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#registerStore>
 
-_Type_
-
--   `Object`
-
 ### TableOfContents
 
 Renders a table of contents component.

diff --git a/packages/editor/package.json b/packages/editor/package.json
@@ -26,6 +26,7 @@
 	"module": "build-module/index.js",
 	"react-native": "src/index",
 	"wpScript": true,
+	"types": "build-types",
 	"sideEffects": [
 		"build-style/**",
 		"src/**/*.scss",

diff --git a/packages/editor/src/store/constants.ts b/packages/editor/src/store/constants.ts
@@ -8,8 +8,6 @@ export const EDIT_MERGE_PROPERTIES = new Set( [ 'meta' ] );
 
 /**
  * Constant for the store module (or reducer) key.
- *
- * @type {string}
  */
 export const STORE_NAME = 'core/editor';
 

diff --git a/packages/editor/src/store/index.js b/packages/editor/src/store/index.js
@@ -18,8 +18,6 @@ import { unlock } from '../lock-unlock';
  * Post editor data store configuration.
  *
  * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#registerStore
- *
- * @type {Object}
  */
 export const storeConfig = {
 	reducer,
@@ -31,8 +29,6 @@ export const storeConfig = {
  * Store definition for the editor namespace.
  *
  * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore
- *
- * @type {Object}
  */
 export const store = createReduxStore( STORE_NAME, {
 	...storeConfig,

diff --git a/packages/editor/src/store/selectors.js b/packages/editor/src/store/selectors.js
@@ -442,8 +442,8 @@ export function isCurrentPostPending( state ) {
 /**
  * Return true if the current post has already been published.
  *
- * @param {Object}  state       Global application state.
- * @param {Object?} currentPost Explicit current post for bypassing registry selector.
+ * @param {Object} state         Global application state.
+ * @param {Object} [currentPost] Explicit current post for bypassing registry selector.
  *
  * @return {boolean} Whether the post has been published.
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,8 +8,6 @@ export const EDIT_MERGE_PROPERTIES = new Set( [ 'meta' ] ); @@
     /**
      * Constant for the store module (or reducer) key.
-     *
-     * @type {string}
      */
     export const STORE_NAME = 'core/editor';
@@ Expand Down @@