@automattic/jetpack-shared-extension-utils 1.5.0 → 1.5.2

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.2] - 2026-03-02
+### Changed
+- Convert `useAutosaveAndRedirect` and `getJetpackExtensionAvailability` to TypeScript. [#47382]
+
+## [1.5.1] - 2026-02-26
+### Changed
+- Update package dependencies. [#47300]
+
 ## [1.5.0] - 2026-02-23
 ### Changed
 - Update `JetpackEditorPanelLogo` to respect the `jetpack_show_editor_panel_branding` PHP filter. [#47094]
@@ -878,6 +886,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Core: prepare utility for release
 
+[1.5.2]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/1.5.1...1.5.2
+[1.5.1]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/1.5.0...1.5.1
 [1.5.0]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/1.4.13...1.5.0
 [1.4.13]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/1.4.12...1.4.13
 [1.4.12]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/1.4.11...1.4.12

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-shared-extension-utils",
-	"version": "1.5.0",
+	"version": "1.5.2",
 	"description": "Utility functions used by the block editor extensions",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/shared-extension-utils/#readme",
 	"bugs": {
@@ -31,23 +31,23 @@
 	"dependencies": {
 		"@automattic/color-studio": "4.1.0",
 		"@automattic/jetpack-analytics": "^1.0.8",
-		"@automattic/jetpack-base-styles": "^1.0.17",
-		"@automattic/jetpack-components": "^1.4.15",
-		"@automattic/jetpack-connection": "^1.4.36",
-		"@automattic/jetpack-script-data": "^0.5.5",
+		"@automattic/jetpack-base-styles": "^1.0.18",
+		"@automattic/jetpack-components": "^1.4.16",
+		"@automattic/jetpack-connection": "^1.4.38",
+		"@automattic/jetpack-script-data": "^0.6.0",
 		"@types/jest": "30.0.0",
-		"@wordpress/api-fetch": "7.39.0",
-		"@wordpress/block-editor": "15.12.0",
-		"@wordpress/components": "32.1.0",
-		"@wordpress/compose": "7.39.0",
-		"@wordpress/data": "10.39.0",
-		"@wordpress/dom-ready": "4.39.0",
-		"@wordpress/element": "6.39.0",
-		"@wordpress/hooks": "4.39.0",
-		"@wordpress/i18n": "6.12.0",
-		"@wordpress/plugins": "7.39.0",
-		"@wordpress/primitives": "4.39.0",
-		"@wordpress/url": "4.39.0",
+		"@wordpress/api-fetch": "7.40.0",
+		"@wordpress/block-editor": "15.13.1",
+		"@wordpress/components": "32.2.0",
+		"@wordpress/compose": "7.40.0",
+		"@wordpress/data": "10.40.0",
+		"@wordpress/dom-ready": "4.40.0",
+		"@wordpress/element": "6.40.0",
+		"@wordpress/hooks": "4.40.0",
+		"@wordpress/i18n": "6.13.0",
+		"@wordpress/plugins": "7.40.0",
+		"@wordpress/primitives": "4.40.0",
+		"@wordpress/url": "4.40.0",
 		"clsx": "2.1.1",
 		"debug": "4.4.3"
 	},

package/src/get-jetpack-extension-availability.ts

@@ -0,0 +1,34 @@
+import getJetpackData from './get-jetpack-data';
+
+interface BlockAvailability {
+	available: boolean;
+	unavailable_reason?: string;
+	details?: Record< string, unknown >;
+}
+
+interface JetpackData {
+	available_blocks?: Record< string, BlockAvailability >;
+}
+
+export interface ExtensionAvailability {
+	available: boolean;
+	details?: Record< string, unknown >;
+	unavailableReason?: string;
+}
+
+/**
+ * Return whether a Jetpack Gutenberg extension is available or not.
+ *
+ * @param {string} name - The extension's name (without the `jetpack/` prefix)
+ * @return Object indicating if the extension is available and the reason why it is unavailable.
+ */
+export default function getJetpackExtensionAvailability( name: string ): ExtensionAvailability {
+	const data = getJetpackData() as JetpackData | null;
+	const available = data?.available_blocks?.[ name ]?.available ?? false;
+	const unavailableReason = data?.available_blocks?.[ name ]?.unavailable_reason ?? 'unknown';
+	const details = data?.available_blocks?.[ name ]?.details ?? {};
+	return {
+		available,
+		...( ! available && { details, unavailableReason } ),
+	};
+}

package/src/hooks/use-autosave-and-redirect/{index.js → index.ts}

@@ -3,6 +3,16 @@ import { useState } from '@wordpress/element';
 
 const noop = () => {};
 
+interface PreventableEvent {
+	preventDefault: () => void;
+}
+
+export interface UseAutosaveAndRedirectReturn {
+	autosave: ( event?: PreventableEvent ) => Promise< void >;
+	autosaveAndRedirect: ( event?: PreventableEvent ) => Promise< void >;
+	isRedirecting: boolean;
+}
+
 /**
  * To handle the redirection
  * @param {string}   url                 - The redirect URL.
@@ -10,26 +20,32 @@ const noop = () => {};
  * @param {boolean}  shouldOpenNewWindow - Whether to open the new window.
  * @return {Window | null} - The open window.
  */
-function redirect( url, callback, shouldOpenNewWindow = false ) {
+function redirect( url: string, callback: ( url: string ) => void, shouldOpenNewWindow = false ) {
 	if ( callback ) {
 		callback( url );
 	}
 
-	return shouldOpenNewWindow ? window.open( url, '_blank' ) : ( window.top.location.href = url );
+	return shouldOpenNewWindow
+		? window.open( url, '_blank' )
+		: ( ( window.top as Window ).location.href = url );
 }
 
 /**
- * Hook to get properties for AiImage
+ * Hook to get properties for autosave and redirect.
  *
  * @param {string}   redirectUrl - The redirect URL.
  * @param {Function} onRedirect  - To handle the redirection.
- * @return {object} - Object containing properties to handle autosave and redirect.
+ * @return Object containing properties to handle autosave and redirect.
  */
-export default function useAutosaveAndRedirect( redirectUrl = null, onRedirect = noop ) {
+export default function useAutosaveAndRedirect(
+	redirectUrl: string | null = null,
+	onRedirect: ( url: string ) => void = noop
+): UseAutosaveAndRedirectReturn {
 	const [ isRedirecting, setIsRedirecting ] = useState( false );
 
 	const { isAutosaveablePost, isDirtyPost, currentPost } = useSelect( select => {
-		const editorSelector = select( 'core/editor' );
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		const editorSelector = select( 'core/editor' ) as any;
 
 		return {
 			isAutosaveablePost: editorSelector.isEditedPostAutosaveable(),
@@ -41,7 +57,7 @@ export default function useAutosaveAndRedirect( redirectUrl = null, onRedirect =
 	const isPostEditor = Object.keys( currentPost ).length > 0;
 
 	const isWidgetEditor = useSelect( select => {
-		if ( window.wp?.customize ) {
+		if ( ( window as { wp?: { customize?: unknown } } ).wp?.customize ) {
 			return true;
 		}
 
@@ -49,18 +65,21 @@ export default function useAutosaveAndRedirect( redirectUrl = null, onRedirect =
 	} );
 
 	// Alias. Save post by dispatch.
-	const savePost = dispatch( 'core/editor' ).savePost;
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	const savePost = ( dispatch( 'core/editor' ) as any ).savePost;
 
 	// For the site editor, save entities
 	const entityRecords = useSelect( select => {
-		return select( 'core' ).__experimentalGetDirtyEntityRecords();
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		return ( select( 'core' ) as any ).__experimentalGetDirtyEntityRecords();
 	} );
 
 	// Save
 	const saveEntities = async () => {
 		for ( let i = 0; i < entityRecords.length; i++ ) {
 			// await is needed here due to the loop.
-			await dispatch( 'core' ).saveEditedEntityRecord(
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
+			await ( dispatch( 'core' ) as any ).saveEditedEntityRecord(
 				entityRecords[ i ].kind,
 				entityRecords[ i ].name,
 				entityRecords[ i ].key
@@ -68,8 +87,8 @@ export default function useAutosaveAndRedirect( redirectUrl = null, onRedirect =
 		}
 	};
 
-	const autosave = async event => {
-		event.preventDefault();
+	const autosave = async ( event?: PreventableEvent ) => {
+		event?.preventDefault();
 
 		if ( isPostEditor ) {
 			/**
@@ -81,12 +100,12 @@ export default function useAutosaveAndRedirect( redirectUrl = null, onRedirect =
 			}
 		} else {
 			// Save entities in the site editor.
-			await saveEntities( event );
+			await saveEntities();
 		}
 	};
 
-	const autosaveAndRedirect = async event => {
-		event.preventDefault();
+	const autosaveAndRedirect = async ( event?: PreventableEvent ) => {
+		event?.preventDefault();
 
 		// Lock re-redirecting attempts.
 		if ( isRedirecting ) {

package/src/get-jetpack-extension-availability.js

@@ -1,19 +0,0 @@
-import getJetpackData from './get-jetpack-data';
-
-/**
- * Return whether a Jetpack Gutenberg extension is available or not.
- *
- * @param {string} name - The extension's name (without the `jetpack/` prefix)
- * @return {object} Object indicating if the extension is available (property `available`) and the reason why it is
- * unavailable (property `unavailable_reason`).
- */
-export default function getJetpackExtensionAvailability( name ) {
-	const data = getJetpackData();
-	const available = data?.available_blocks?.[ name ]?.available ?? false;
-	const unavailableReason = data?.available_blocks?.[ name ]?.unavailable_reason ?? 'unknown';
-	const details = data?.available_blocks?.[ name ]?.details ?? [];
-	return {
-		available,
-		...( ! available && { details, unavailableReason } ),
-	};
-}