@automattic/jetpack-shared-extension-utils 0.15.3 → 0.15.4

package/CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
+## [0.15.4] - 2024-08-21
+### Changed
+- Internal updates.
+
 ## [0.15.3] - 2024-08-15
 ### Changed
 - Updated package dependencies. [#38662]
@@ -428,6 +432,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Core: prepare utility for release
 
+[0.15.4]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.15.3...0.15.4
 [0.15.3]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.15.2...0.15.3
 [0.15.2]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.15.1...0.15.2
 [0.15.1]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.15.0...0.15.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-shared-extension-utils",
-	"version": "0.15.3",
+	"version": "0.15.4",
 	"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": {
@@ -17,9 +17,9 @@
 		"test": "jest"
 	},
 	"dependencies": {
-		"@automattic/jetpack-analytics": "^0.1.29",
-		"@automattic/jetpack-components": "^0.55.7",
-		"@automattic/jetpack-connection": "^0.35.1",
+		"@automattic/jetpack-analytics": "^0.1.30",
+		"@automattic/jetpack-components": "^0.55.9",
+		"@automattic/jetpack-connection": "^0.35.3",
 		"@wordpress/api-fetch": "7.5.0",
 		"@wordpress/compose": "7.5.0",
 		"@wordpress/data": "10.5.0",

package/src/components/jetpack-editor-panel-logo/index.jsx

@@ -6,7 +6,7 @@ import './style.scss';
 /**
  * The Jetpack logo used for block editor panels
  *
- * @returns {React.Component} Jetpack logo component
+ * @return {React.Component} Jetpack logo component
  */
 const JetpackEditorPanelLogo = () => (
 	<JetpackLogo

package/src/get-block-icon-from-metadata.js

@@ -10,7 +10,7 @@ import getIconColor from './get-icon-color';
  * dynamically set the icon color later on.
  *
  * @param {object} metadata - Block.json content
- * @returns {React.Component} Icon component
+ * @return {React.Component} Icon component
  */
 export function getBlockIconComponent( metadata ) {
 	// Set default values
@@ -46,7 +46,7 @@ export function getBlockIconComponent( metadata ) {
  * of the icon.
  *
  * @param {object} metadata - Block.json content
- * @returns {object} Icon property for client registration
+ * @return {object} Icon property for client registration
  */
 export function getBlockIconProp( metadata ) {
 	return {

package/src/get-block-icon-from-metadata.native.js

@@ -10,7 +10,7 @@ import getIconColor from './get-icon-color';
  * dynamically set the icon color later on.
  *
  * @param {object} metadata - Block.json content
- * @returns {React.JSX.Element|string} Icon component
+ * @return {React.JSX.Element|string} Icon component
  */
 export function getBlockIconComponent( metadata ) {
 	// If the SVG has been passed as a string, use SvgXml to correctly parse it.
@@ -27,7 +27,7 @@ export function getBlockIconComponent( metadata ) {
  * of the icon.
  *
  * @param {object} metadata - Block.json content
- * @returns {object} Icon property for client registration
+ * @return {object} Icon property for client registration
  */
 export function getBlockIconProp( metadata ) {
 	return {

package/src/get-host-app-namespace.native.js

@@ -7,7 +7,7 @@ import { select } from '@wordpress/data';
 /**
  * Retrieves host app's namespace e.g. "WordPress" or "Jetpack".
  *
- * @returns {string} hostAppNamespace The host app's namespace.
+ * @return {string} hostAppNamespace The host app's namespace.
  */
 export default function getHostAppNamespace() {
 	return select( blockEditorStore ).getSettings().hostAppNamespace;

package/src/get-icon-color.js

@@ -10,7 +10,7 @@ const JETPACK_GREEN_40 = '#069e08';
  *
  * Green in the Jetpack context, otherwise black for Simple sites or Atomic sites.
  *
- * @returns {string} HEX color for block editor icons
+ * @return {string} HEX color for block editor icons
  */
 export default function getIconColor() {
 	if ( isAtomicSite() || isSimpleSite() ) {

package/src/get-jetpack-blocks-variation.js

@@ -2,7 +2,7 @@ import getJetpackData from './get-jetpack-data';
 /**
  * Returns the jetpack block variation that is defined on the backend.
  *
- * @returns {?string} options are ['production', 'beta', 'experimental']
+ * @return {?string} options are ['production', 'beta', 'experimental']
  */
 export default function getJetpackBlocksVariation() {
 	const data = getJetpackData();

package/src/get-jetpack-data.js

@@ -3,7 +3,7 @@ export const JETPACK_DATA_PATH = 'Jetpack_Editor_Initial_State';
 /**
  * Retrieves Jetpack editor state
  *
- * @returns {object|null}Object The Jetpack Editor State.
+ * @return {object|null}Object The Jetpack Editor State.
  */
 export default function getJetpackData() {
 	return 'object' === typeof window ? window?.[ JETPACK_DATA_PATH ] ?? null : null;

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

@@ -4,7 +4,7 @@ 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)
- * @returns {object} Object indicating if the extension is available (property `available`) and the reason why it is
+ * @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 ) {

package/src/get-site-fragment.js

@@ -1,7 +1,7 @@
 /**
  * Returns the site fragment (slug) in the environment we're running Gutenberg in.
  *
- * @returns {?string} Site fragment (slug)
+ * @return {?string} Site fragment (slug)
  */
 export default function getSiteFragment() {
 	// Gutenberg in Jetpack adds a site fragment in the initial state

package/src/hooks/use-module-status/index.js

@@ -6,7 +6,7 @@ import { JETPACK_MODULES_STORE_ID } from '../../modules-state';
  * Manage a Jetpack module's status (get and set).
  *
  * @param {string} name - The module's name.
- * @returns {boolean} Whether the module is active.
+ * @return {boolean} Whether the module is active.
  */
 const useModuleStatus = name => {
 	const { isModuleActive, isChangingStatus, isLoadingModules } = useSelect(

package/src/is-current-user-connected.js

@@ -3,7 +3,7 @@ import getJetpackData from './get-jetpack-data';
 /**
  * Return whether the current user is connected to WP.com.
  *
- * @returns {boolean} Whether the current user is connected.
+ * @return {boolean} Whether the current user is connected.
  */
 export default function isCurrentUserConnected() {
 	return getJetpackData()?.jetpack?.is_current_user_connected ?? false;

package/src/is-my-jetpack-available.js

@@ -6,7 +6,7 @@ import getJetpackData from './get-jetpack-data';
  * @see https://github.com/Automattic/jetpack/pull/38500 introduced the is_my_jetpack_available flag
  * The value is the same that can be found on Initial_State.siteData.showMyJetpack (dashboard context)
  *
- * @returns {boolean} Object indicating if My Jetpack is available (so to navigate to interstitials and product pages)
+ * @return {boolean} Object indicating if My Jetpack is available (so to navigate to interstitials and product pages)
  */
 export default function isMyJetpackAvailable() {
 	return getJetpackData()?.jetpack?.is_my_jetpack_available === true;

package/src/modules-state/actions.js

@@ -12,11 +12,11 @@ export const SET_MODULE_UPDATING = 'SET_MODULE_UPDATING';
 /**
  * Yield actions to update module status
  *
- * @param {object} settings - Jetpack module settings.
- * @param {string} settings.name - Jetpack module name.
+ * @param {object}  settings        - Jetpack module settings.
+ * @param {string}  settings.name   - Jetpack module name.
  * @param {boolean} settings.active - If the module is active or not.
- * @yields {object} - an action object.
- * @returns {object} - an action object.
+ * @yield {object} - an action object.
+ * @return {object} - an action object.
  */
 export function* updateJetpackModuleStatus( settings ) {
 	try {
@@ -36,8 +36,8 @@ export function* updateJetpackModuleStatus( settings ) {
 
 /**
  * Yield actions to update module status
- * @yields {object} - an action object.
- * @returns {boolean} - if operation is successful or not.
+ * @yield {object} - an action object.
+ * @return {boolean} - if operation is successful or not.
  */
 export function* fetchModules() {
 	// We don't fetch modules for Simple Site and aknowledge that all modules are active
@@ -62,7 +62,7 @@ export function* fetchModules() {
  * Set modules as loading action
  *
  * @param {boolean} isLoading - If the modules are loading or not.
- * @returns {object} - an action object.
+ * @return {object} - an action object.
  */
 function setIsLoading( isLoading ) {
 	return setJetpackModules( { isLoading } );
@@ -71,9 +71,9 @@ function setIsLoading( isLoading ) {
 /**
  * Set modules as updating action
  *
- * @param {string} name - Name of the module.
+ * @param {string}  name       - Name of the module.
  * @param {boolean} isUpdating - If the modules are updating or not.
- * @returns {object} - an action object.
+ * @return {object} - an action object.
  */
 function setIsUpdating( name, isUpdating ) {
 	return { type: SET_MODULE_UPDATING, name, isUpdating };
@@ -82,10 +82,10 @@ function setIsUpdating( name, isUpdating ) {
 /**
  * Set Jetpack module action
  *
- * @param {object} options - Jetpack settings.
- * @param {object} options.modules - Jetpack modules.
+ * @param {object}  options           - Jetpack settings.
+ * @param {object}  options.modules   - Jetpack modules.
  * @param {boolean} options.isLoading - If the modules are loading or not.
- * @returns {object} - an action object.
+ * @return {object} - an action object.
  */
 export function setJetpackModules( options ) {
 	return { type: SET_JETPACK_MODULES, options };

package/src/modules-state/controls.js

@@ -6,7 +6,7 @@ export const UPDATE_JETPACK_MODULE_STATUS = 'UPDATE_JETPACK_MODULE_STATUS';
 /**
  * fetchJetpackModules action
  *
- * @returns {object} - an action object.
+ * @return {object} - an action object.
  */
 export const fetchJetpackModules = () => {
 	return {
@@ -17,8 +17,8 @@ export const fetchJetpackModules = () => {
 /**
  * Updating single module status action
  *
- * @param settings - Jetpack module settings.
- * @param {string} settings.name - Jetpack module name.
+ * @param           settings        - Jetpack module settings.
+ * @param {string}  settings.name   - Jetpack module name.
  * @param {boolean} settings.active - If the module is active or not.
  */
 

package/src/modules-state/resolvers.js

@@ -4,8 +4,8 @@ import { fetchJetpackModules } from './controls';
 /**
  * Yield actions to get the Jetpack modules.
  *
- * @yields {object} - an action object.
- * @returns {object} - an action object.
+ * @yield {object} - an action object.
+ * @return {object} - an action object.
  */
 export function* getJetpackModules() {
 	try {

package/src/plan-utils.js

@@ -10,12 +10,12 @@ import { isAtomicSite, isSimpleSite } from './site-type-utils';
  * Return the checkout URL to upgrade the site plan,
  * depending on the plan, postId, and postType site values.
  *
- * @param {object} siteParams -          Site params used to build the URL.
+ * @param {object} siteParams          - Site params used to build the URL.
  * @param {string} siteParams.planSlug - Plan slug.
- * @param {object} siteParams.plan -     An object with details about the plan.
- * @param {number} siteParams.postId -   Post id.
+ * @param {object} siteParams.plan     - An object with details about the plan.
+ * @param {number} siteParams.postId   - Post id.
  * @param {string} siteParams.postType - Post type.
- * @returns {string}                     Upgrade URL.
+ * @return {string}                     Upgrade URL.
  */
 export function getUpgradeUrl( { planSlug, plan, postId, postType } ) {
 	// WP.com plan objects have a dedicated `path_slug` field, Jetpack plan objects don't.
@@ -88,7 +88,7 @@ export function getUpgradeUrl( { planSlug, plan, postId, postType } ) {
  * the block requires a paid plan.
  *
  * @param {string} name - Block name.
- * @returns {boolean} True if the block is upgradable, false otherwise.
+ * @return {boolean} True if the block is upgradable, false otherwise.
  */
 export function isUpgradable( name ) {
 	if ( ! name ) {
@@ -105,8 +105,8 @@ export function isUpgradable( name ) {
  * Checks whether the block requires a paid plan or not.
  *
  * @param {string} unavailableReason - The reason why block is unavailable
- * @param {object} details - The block details
- * @returns {string|boolean} Either false if the block doesn't require a paid plan, or the actual plan name it requires.
+ * @param {object} details           - The block details
+ * @return {string|boolean} Either false if the block doesn't require a paid plan, or the actual plan name it requires.
  */
 export function requiresPaidPlan( unavailableReason, details ) {
 	if ( unavailableReason === 'missing_plan' ) {
@@ -119,7 +119,7 @@ export function requiresPaidPlan( unavailableReason, details ) {
  * Returns the required plan slug for a passed block name.
  *
  * @param {string} name - Block name.
- * @returns {string|boolean} Plan name if the block is upgradable, false otherwise.
+ * @return {string|boolean} Plan name if the block is upgradable, false otherwise.
  */
 export function getRequiredPlan( name ) {
 	if ( ! name ) {
@@ -158,7 +158,7 @@ const usableBlockWithFreePlan = [
 /**
  * Return whether upgrade nudges are enabled or not.
  *
- * @returns {boolean} True if the Upgrade Nudge is enable. Otherwise, False.
+ * @return {boolean} True if the Upgrade Nudge is enable. Otherwise, False.
  */
 export function isUpgradeNudgeEnabled() {
 	return get( getJetpackData(), 'jetpack.enable_upgrade_nudge', false );

package/src/register-jetpack-plugin.js

@@ -4,9 +4,9 @@ import getJetpackExtensionAvailability from './get-jetpack-extension-availabilit
 /**
  * Registers a Gutenberg block if the availability requirements are met.
  *
- * @param {string} name - The plugin's name
+ * @param {string} name     - The plugin's name
  * @param {object} settings - The plugin's settings.
- * @returns {object|boolean} Either false if the plugin is not available, or the results of `registerPlugin`
+ * @return {object|boolean} Either false if the plugin is not available, or the results of `registerPlugin`
  */
 export default function registerJetpackPlugin( name, settings ) {
 	const { available, unavailableReason } = getJetpackExtensionAvailability( name );

package/src/site-type-utils.js

@@ -3,7 +3,7 @@ import getJetpackData from './get-jetpack-data';
 /**
  * Get the site type from environment
  *
- * @returns {(string|null)} Site type
+ * @return {(string|null)} Site type
  */
 function getSiteType() {
 	return 'object' === typeof window && typeof window._currentSiteType === 'string'
@@ -14,7 +14,7 @@ function getSiteType() {
 /**
  * Check if environment is Simple site.
  *
- * @returns {boolean} True for Simple sites.
+ * @return {boolean} True for Simple sites.
  */
 export function isSimpleSite() {
 	return getSiteType() === 'simple';
@@ -23,7 +23,7 @@ export function isSimpleSite() {
 /**
  * Check if environment is Atomic site.
  *
- * @returns {boolean} True for Atomic sites.
+ * @return {boolean} True for Atomic sites.
  */
 export function isAtomicSite() {
 	return getSiteType() === 'atomic';
@@ -32,7 +32,7 @@ export function isAtomicSite() {
 /**
  * Return whether the current blog is set to private. (if blog_public option is -1)
  *
- * @returns {boolean} whether the current blog is set to private.
+ * @return {boolean} whether the current blog is set to private.
  */
 export function isPrivateSite() {
 	const jetpackData = getJetpackData();
@@ -43,7 +43,7 @@ export function isPrivateSite() {
  * Return whether the current site is coming soon (i.e. not launched yet).
  * This is only available for WordPress.com sites so far.
  *
- * @returns {boolean} whether the current site is coming soon.
+ * @return {boolean} whether the current site is coming soon.
  */
 export function isComingSoon() {
 	const jetpackData = getJetpackData();