@automattic/jetpack-shared-extension-utils 0.8.4 → 0.9.0

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.9.0] - 2023-02-20
+### Added
+- Add a new section to describe including assets from backend [#29016]
+
 ## [0.8.4] - 2023-02-15
 ### Changed
 - Update to React 18. [#28710]
@@ -169,6 +173,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Core: prepare utility for release
 
+[0.9.0]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.8.4...0.9.0
 [0.8.4]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.8.3...0.8.4
 [0.8.3]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.8.2...0.8.3
 [0.8.2]: https://github.com/Automattic/jetpack-shared-extension-utils/compare/0.8.1...0.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-shared-extension-utils",
-	"version": "0.8.4",
+	"version": "0.9.0",
 	"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": {

package/src/hooks/readme.md

@@ -10,6 +10,37 @@ use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
 wp_add_inline_script( 'your-app-script-handle-in-editor', Connection_Initial_State::render(), 'before' );
 ```
 
+Adding Tracks related class and including the check function in your admin ui page:
+```php
+use Automattic\Jetpack\Status as Status;
+use Automattic\Jetpack\Terms_Of_Service;
+use Automattic\Jetpack\Tracking;
+
+/**
+ * Returns whether we are in condition to track to use
+ * Analytics functionality like Tracks, MC, or GA.
+ */
+public static function can_use_analytics() {
+	$status     = new Status();
+	$connection = new Connection_Manager();
+	$tracking   = new Tracking( 'jetpack', $connection );
+
+	return $tracking->should_enable_tracking( new Terms_Of_Service(), $status );
+}
+```
+
+Then adding the assets in the `enqueue_admin_scripts` function after the `Assets::register_script` function:
+```php
+public function enqueue_admin_scripts() {
+	...
+	// Required for Analytics.
+	if ( self::can_use_analytics() ) {
+		Tracking::register_tracks_functions_scripts( true );
+	}
+	...
+}
+```
+
 ## Usage
 
 ```es6
@@ -23,7 +54,7 @@ tracks.recordEvent( 'jetpack_editor_block_upgrade_click', {
 ```
 
 The hook function also accepts parameters to record a "page view" event when the component renders.
-You can also import a wrapped version of `recordEvent` that checks for a Jetpack connected user before actually recording the event.  
+You can also import a wrapped version of `recordEvent` that checks for a Jetpack connected user before actually recording the event.
 
 ```es6
 const Component = () => {
@@ -33,7 +64,7 @@ const Component = () => {
 			pageViewSuffix: '',
 		} );
 	const recordClick = useCallback( () => { recordEvent( 'event_name', {} ) }, [] );
-	
+
 	return (
 		<Button
 			onClick={ recordClick }