Merge pull request #449 from beyondwords-io/s-7095-scope-out-integrating-the-magic-embed-script-into-wordpress

Magic Embed for WordPress

Author: galbus

.mockoon/beyondwords-api.json

@@ -119,13 +119,6 @@
           "filePath": "",
           "sendFileAsBody": false,
           "rules": [
-            {
-              "target": "header",
-              "modifier": "Content-Type",
-              "value": "application/json",
-              "operator": "equals",
-              "invert": false
-            },
             {
               "target": "header",
               "modifier": "X-Api-Key",
@@ -276,7 +269,7 @@
         },
         {
           "uuid": "ecdb7657-8a38-4380-937e-54204529d2e5",
-          "body": "{\n  \"id\": \"9279c9e0-e0b5-4789-9040-f44478ed3e9e\",\n  \"title\": \"{{body 'title' 'Title'}}\",\n  \"type\": \"auto_segment\",\n  \"source_id\": \"{{body 'source_id' '90e4cbff-6382-4a88-adc5-1eb3ffa16c6d'}}\",\n  \"source_url\": \"{{body 'source_url' 'https://example.com'}}\",\n  \"author\": \"{{body 'author' 'Jane Smith'}}\",\n  \"image_url\": \"{{body 'image' 'https://example.com/image.jpg'}}\",\n  \"audio\": [\n    {\n      \"id\": 12192819,\n      \"content_type\": \"application/x-mpegURL\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/e8219ee2f3465d6834984f9ae607a81e.m3u8\",\n      \"duration\": 2685,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    },\n    {\n      \"id\": 12192811,\n      \"content_type\": \"audio/mpeg\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/fd7108e13a7c7fee6820a1b07bb676e0_compiled.mp3\",\n      \"duration\": 2712,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    }\n  ],\n  \"video\": [],\n  \"ads_enabled\": true,\n  \"is_copy\": false,\n  \"title_voice_id\": 2517,\n  \"summary_voice_id\": 2517,\n  \"body_voice_id\": 2517,\n  \"title_enabled\": true,\n  \"body_enabled\": true,\n  \"summary_enabled\": true,\n  \"summary_title_enabled\": false,\n  \"summarization\": {\n    \"audio\": [],\n    \"video\": []\n  },\n  \"background_track\": null,\n  \"language\": \"{{body 'language' 'en_US'}}\",\n  \"preview_token\": \"d9ce36ea-ddc4-4611-b60c-4f90ed0fc082\",\n  \"status\": \"processed\",\n  \"metadata\": {\n    \"categories\": [\n      \"News\", \n      \"Audio\"\n    ]\n  },\n  \"created\": \"2022-01-02T23:59:59Z\",\n  \"updated\": \"2022-03-04T00:00:00Z\",\n  \"published\": true,\n  \"publish_date\": \"2099-12-31T23:59:59Z\",\n  \"auto_segment_updates_enabled\": false,\n  \"ai_summary_updates_enabled\": true,\n  \"summary\": \"{{body 'summary' 'Summary'}}\",\n  \"body\": \"<p>Test.</p>\",\n  \"summarization_settings\": null,\n  \"video_settings\": null\n}",
+          "body": "{\n  \"id\": \"9279c9e0-e0b5-4789-9040-f44478ed3e9e\",\n  \"title\": \"{{body 'title' 'Title'}}\",\n  \"type\": \"auto_segment\",\n  \"source_id\": \"{{body 'source_id' '90e4cbff-6382-4a88-adc5-1eb3ffa16c6d'}}\",\n  \"source_url\": \"{{body 'source_url' 'https://example.com'}}\",\n  \"author\": \"{{body 'author' 'Jane Smith'}}\",\n  \"image_url\": \"{{body 'image' 'https://example.com/image.jpg'}}\",\n  \"audio\": [\n    {\n      \"id\": 12192819,\n      \"content_type\": \"application/x-mpegURL\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/e8219ee2f3465d6834984f9ae607a81e.m3u8\",\n      \"duration\": 2685,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    },\n    {\n      \"id\": 12192811,\n      \"content_type\": \"audio/mpeg\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/fd7108e13a7c7fee6820a1b07bb676e0_compiled.mp3\",\n      \"duration\": 2712,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    }\n  ],\n  \"video\": [],\n  \"ads_enabled\": true,\n  \"is_copy\": false,\n  \"title_voice_id\": 2517,\n  \"summary_voice_id\": 2517,\n  \"body_voice_id\": 2517,\n  \"title_enabled\": true,\n  \"body_enabled\": true,\n  \"summary_enabled\": true,\n  \"summary_title_enabled\": false,\n  \"summarization\": {\n    \"audio\": [],\n    \"video\": []\n  },\n  \"background_track\": null,\n  \"language\": \"{{body 'language' 'en_US'}}\",\n  \"preview_token\": \"d9ce36ea-ddc4-4611-b60c-4f90ed0fc082\",\n  \"status\": \"processed\",\n  \"metadata\": {\n    \"categories\": [\n      \"News\", \n      \"Audio\"\n    ]\n  },\n  \"created\": \"2022-01-02T23:59:59Z\",\n  \"updated\": \"2022-03-04T00:00:00Z\",\n  \"published\": true,\n  \"publish_date\": \"2099-12-31T23:59:59Z\",\n  \"auto_segment_updates_enabled\": true,\n  \"ai_summary_updates_enabled\": true,\n  \"summary\": \"{{body 'summary' 'Summary'}}\",\n  \"body\": \"<p>Test.</p>\",\n  \"summarization_settings\": null,\n  \"video_settings\": null\n}",
           "latency": 0,
           "statusCode": 200,
           "label": "OK",
@@ -414,7 +407,7 @@
         },
         {
           "uuid": "52762211-f2da-4e53-a68f-74883e69e862",
-          "body": "{\n  \"id\": \"9279c9e0-e0b5-4789-9040-f44478ed3e9e\",\n  \"title\": \"{{body 'title' 'Title'}}\",\n  \"type\": \"auto_segment\",\n  \"source_id\": \"{{body 'source_id' '90e4cbff-6382-4a88-adc5-1eb3ffa16c6d'}}\",\n  \"source_url\": \"{{body 'source_url' 'https://example.com'}}\",\n  \"author\": \"{{body 'author' 'Jane Smith'}}\",\n  \"image_url\": \"{{body 'image' 'https://example.com/image.jpg'}}\",\n  \"audio\": [\n    {\n      \"id\": 12192819,\n      \"content_type\": \"application/x-mpegURL\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/e8219ee2f3465d6834984f9ae607a81e.m3u8\",\n      \"duration\": 2685,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    },\n    {\n      \"id\": 12192811,\n      \"content_type\": \"audio/mpeg\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/fd7108e13a7c7fee6820a1b07bb676e0_compiled.mp3\",\n      \"duration\": 2712,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    }\n  ],\n  \"video\": [],\n  \"ads_enabled\": true,\n  \"is_copy\": false,\n  \"title_voice_id\": 2517,\n  \"summary_voice_id\": 2517,\n  \"body_voice_id\": 2517,\n  \"title_enabled\": true,\n  \"body_enabled\": true,\n  \"summary_enabled\": true,\n  \"summary_title_enabled\": false,\n  \"summarization\": {\n    \"audio\": [],\n    \"video\": []\n  },\n  \"background_track\": null,\n  \"language\": \"{{body 'language' 'en_US'}}\",\n  \"preview_token\": \"d9ce36ea-ddc4-4611-b60c-4f90ed0fc082\",\n  \"status\": \"processed\",\n  \"metadata\": {\n    \"categories\": [\n      \"News\", \n      \"Audio\"\n    ]\n  },\n  \"created\": \"2022-01-02T23:59:59Z\",\n  \"updated\": \"2022-03-04T00:00:00Z\",\n  \"published\": true,\n  \"publish_date\": \"2099-12-31T23:59:59Z\",\n  \"auto_segment_updates_enabled\": false,\n  \"ai_summary_updates_enabled\": true,\n  \"summary\": \"{{body 'summary' 'Summary'}}\",\n  \"body\": \"<p>Test.</p>\",\n  \"summarization_settings\": null,\n  \"video_settings\": null\n}",
+          "body": "{\n  \"id\": \"9279c9e0-e0b5-4789-9040-f44478ed3e9e\",\n  \"title\": \"{{body 'title' 'Title'}}\",\n  \"type\": \"auto_segment\",\n  \"source_id\": \"{{body 'source_id' '90e4cbff-6382-4a88-adc5-1eb3ffa16c6d'}}\",\n  \"source_url\": \"{{body 'source_url' 'https://example.com'}}\",\n  \"author\": \"{{body 'author' 'Jane Smith'}}\",\n  \"image_url\": \"{{body 'image' 'https://example.com/image.jpg'}}\",\n  \"audio\": [\n    {\n      \"id\": 12192819,\n      \"content_type\": \"application/x-mpegURL\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/e8219ee2f3465d6834984f9ae607a81e.m3u8\",\n      \"duration\": 2685,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    },\n    {\n      \"id\": 12192811,\n      \"content_type\": \"audio/mpeg\",\n      \"url\": \"https://beyondwords-cdn-b7fyckdeejejb6dj.a03.azurefd.net/audio/projects/9969/podcasts/3161419/media/fd7108e13a7c7fee6820a1b07bb676e0_compiled.mp3\",\n      \"duration\": 2712,\n      \"base64_file\": null,\n      \"variant\": \"article\"\n    }\n  ],\n  \"video\": [],\n  \"ads_enabled\": true,\n  \"is_copy\": false,\n  \"title_voice_id\": 2517,\n  \"summary_voice_id\": 2517,\n  \"body_voice_id\": 2517,\n  \"title_enabled\": true,\n  \"body_enabled\": true,\n  \"summary_enabled\": true,\n  \"summary_title_enabled\": false,\n  \"summarization\": {\n    \"audio\": [],\n    \"video\": []\n  },\n  \"background_track\": null,\n  \"language\": \"{{body 'language' 'en_US'}}\",\n  \"preview_token\": \"d9ce36ea-ddc4-4611-b60c-4f90ed0fc082\",\n  \"status\": \"processed\",\n  \"metadata\": {\n    \"categories\": [\n      \"News\", \n      \"Audio\"\n    ]\n  },\n  \"created\": \"2022-01-02T23:59:59Z\",\n  \"updated\": \"2022-03-04T00:00:00Z\",\n  \"published\": true,\n  \"publish_date\": \"2099-12-31T23:59:59Z\",\n  \"auto_segment_updates_enabled\": true,\n  \"ai_summary_updates_enabled\": true,\n  \"summary\": \"{{body 'summary' 'Summary'}}\",\n  \"body\": \"<p>Test.</p>\",\n  \"summarization_settings\": null,\n  \"video_settings\": null\n}",
           "latency": 0,
           "statusCode": 200,
           "label": "OK",
@@ -720,13 +713,6 @@
           "filePath": "",
           "sendFileAsBody": false,
           "rules": [
-            {
-              "target": "header",
-              "modifier": "Content-Type",
-              "value": "application/json",
-              "operator": "equals",
-              "invert": false
-            },
             {
               "target": "header",
               "modifier": "X-Api-Key",
@@ -962,13 +948,6 @@
           "filePath": "",
           "sendFileAsBody": false,
           "rules": [
-            {
-              "target": "header",
-              "modifier": "Content-Type",
-              "value": "application/json",
-              "operator": "equals",
-              "invert": false
-            },
             {
               "target": "header",
               "modifier": "X-Api-Key",

doc/wp-config.md

@@ -20,13 +20,3 @@ Defaults to `true`.
 ```php
 define('BEYONDWORDS_AUTOREGENERATE', false);
 ```
-
-##  BEYONDWORDS_PLAYER_INLINE_SCRIPT_TAG
-
-Use the recommended BeyondWords inline player script.
-Defaults to `false`.
-From plugin version `6.0` this will default to `true`.
-
-```php
-define('BEYONDWORDS_PLAYER_INLINE_SCRIPT_TAG', true);
-```

package.json

@@ -17,7 +17,7 @@
     "@wordpress/eslint-plugin": "^22.5.1",
     "@wordpress/scripts": "^30.12.1",
     "badge-maker": "^4.1.0",
-    "cypress": "14.3.3",
+    "cypress": "15.1.0",
     "cypress-fail-fast": "^7.1.1",
     "cypress-map": "^1.45.0",
     "cypress-multi-reporters": "^2.0.5",

readme.txt

@@ -86,7 +86,11 @@ Release date: TBC
 
 **Enhancements and Features:**
 
-* Make PHP methods static.
+* [#449](https://github.com/beyondwords-io/wordpress-plugin/pull/449) Magic Embed for WordPress.
+    * An **Integration method** plugin setting has been added in the *Content* tab.
+    * The default is **REST API**. This method will continue to send post content and metadata to BeyondWords using REST API calls.
+    * If **Magic Embed** is selected then [Client-Side Integration](https://github.com/beyondwords-io/player/blob/main/doc/client-side-integration.md) will be enabed for new posts. With this method BeyondWords handles the extraction and delivery of audio content using the rendered HTML for the post.
+* [#447](https://github.com/beyondwords-io/wordpress-plugin/pull/447) Make PHP methods static.
 
 = 5.5.0 =
 

src/Compatibility/WPGraphQL/WPGraphQL.php

@@ -34,13 +34,17 @@ public static function init()
      * @since 3.6.0
      * @since 4.0.0 Register contentId field, and contentId/podcastId are now String, not Int
      * @since 4.7.0 Moved graphqlRegisterTypes() from Beyondwords\Wordpress\Core to here.
-     * @since 6.0.0 Make static.
+     * @since 6.0.0 Make static, add sourceId field.
      */
     public static function graphqlRegisterTypes()
     {
         register_graphql_object_type('Beyondwords', [
             'description' => __('BeyondWords audio details. Use this data to embed an audio player using the BeyondWords JavaScript SDK.', 'speechkit'), // phpcs:ignore Generic.Files.LineLength.TooLong
             'fields' => [
+                'sourceId' => [
+                    'description' => __('BeyondWords source ID', 'speechkit'),
+                    'type' => 'String'
+                ],
                 'projectId' => [
                     'description' => __('BeyondWords project ID', 'speechkit'),
                     'type' => 'Int'
@@ -70,22 +74,24 @@ public static function graphqlRegisterTypes()
                     'type'        => 'Beyondwords',
                     'description' => __('BeyondWords audio details', 'speechkit'),
                     'resolve'     => function (WPGraphQLPlugin\Model\Post $post) {
-                        $beyondwords = [];
+                        $fields = [
+                            'sourceId' => (string) $post->ID,
+                        ];
 
-                        $contentId = PostMetaUtils::getContentId($post->ID);
+                        $projectId = PostMetaUtils::getProjectId($post->ID);
 
-                        if (! empty($contentId)) {
-                            $beyondwords['contentId'] = $contentId;
-                            $beyondwords['podcastId'] = $contentId; // legacy
+                        if (! empty($projectId)) {
+                            $fields['projectId'] = $projectId;
                         }
 
-                        $projectId = PostMetaUtils::getProjectId($post->ID);
+                        $contentId = PostMetaUtils::getContentId($post->ID);
 
-                        if (! empty($projectId)) {
-                            $beyondwords['projectId'] = $projectId;
+                        if (! empty($contentId)) {
+                            $fields['contentId'] = $contentId;
+                            $fields['podcastId'] = $contentId; // legacy
                         }
 
-                        return ! empty($beyondwords) ? $beyondwords : null;
+                        return $fields;
                     }
                 ]);
             }

src/Component/Post/BlockAttributes/BlockAttributes.php

@@ -90,7 +90,7 @@ public static function registerMarkerAttribute($args)
      *
      * @since 4.0.0
      * @since 4.2.2 Rename method to renderBlock.
-     * @since 6.0.0 Make static.
+     * @since 6.0.0 Make static and update for Magic Embed.
      *
      * @param string $blockContent The block content (HTML).
      * @param string $block        The full block, including name and attributes.
@@ -100,12 +100,12 @@ public static function registerMarkerAttribute($args)
     public static function renderBlock($blockContent, $block)
     {
         // Skip adding marker if player UI is disabled
-        if (get_option('beyondwords_player_ui', PlayerUI::ENABLED) === PlayerUI::DISABLED) {
+        if (get_option(PlayerUI::OPTION_NAME) === PlayerUI::DISABLED) {
             return $blockContent;
         }
 
-        // Skip adding marker if no content ID exists
-        if (! PostMetaUtils::getContentId(get_the_ID())) {
+        // Skip adding marker if no content exists
+        if (! PostMetaUtils::hasContent(get_the_ID())) {
             return $blockContent;
         }
 

src/Component/Post/DisplayPlayer/DisplayPlayer.php

@@ -79,7 +79,7 @@ public static function save($postId)
      *
      * @since 6.0.0 Make static.
      *
-     * @param WP_Post $post The post object.
+     * @param \WP_Post $post The post object.
      */
     public static function element($post)
     {

src/Component/Post/GenerateAudio/GenerateAudio.php

@@ -44,6 +44,8 @@ public static function init()
     /**
      * Check whether the post type should preselect the "Generate audio" checkbox.
      *
+     * @param \WP_Post|int $post The post object or ID.
+     *
      * @todo move this function to somewhere reusable for the Block editor.
      *
      * @since 6.0.0 Make static.
@@ -73,22 +75,13 @@ public static function shouldPreselectGenerateAudio($post)
     /**
      * Render the element.
      *
-     * @since 6.0.0 Make static.
+     * @since 6.0.0 Make static and refactor generate audio check.
      */
     public static function element($post)
     {
         wp_nonce_field('beyondwords_generate_audio', 'beyondwords_generate_audio_nonce');
 
         $generateAudio = PostMetaUtils::hasGenerateAudio($post->ID);
-
-        if (! $generateAudio) {
-            // Check whether "0" has explicitly been saved
-            $generateAudioMeta = PostMetaUtils::getRenamedPostMeta($post->ID, 'generate_audio', true);
-
-            if ($generateAudioMeta !== '0' && self::shouldPreselectGenerateAudio($post)) {
-                $generateAudio = true;
-            }
-        }
         ?>
         <!--  checkbox -->
         <p id="beyondwords-metabox-generate-audio">

src/Component/Post/GenerateAudio/index.js

@@ -73,17 +73,13 @@ export default compose( [
 				beyondwords_generate_audio,
 				/* eslint-disable-next-line camelcase */
 				speechkit_generate_audio,
-				/* eslint-disable-next-line camelcase */
-				publish_post_to_speechkit,
 			} = getCurrentPostAttribute( 'meta' );
 
 			if (
 				/* eslint-disable-next-line camelcase */
 				beyondwords_generate_audio === '1' ||
 				/* eslint-disable-next-line camelcase */
-				speechkit_generate_audio === '1' ||
-				/* eslint-disable-next-line camelcase */
-				publish_post_to_speechkit === '1'
+				speechkit_generate_audio === '1'
 			) {
 				return true;
 			}
@@ -92,9 +88,7 @@ export default compose( [
 				/* eslint-disable-next-line camelcase */
 				beyondwords_generate_audio === '0' ||
 				/* eslint-disable-next-line camelcase */
-				speechkit_generate_audio === '0' ||
-				/* eslint-disable-next-line camelcase */
-				publish_post_to_speechkit === '0'
+				speechkit_generate_audio === '0'
 			) {
 				return false;
 			}