July 2023 Release of the APL 2023.2 compliant APL Client Library

For more details on this release refer to CHANGELOG.md To learn about APL see: https://developer.amazon.com/docs/alexa-presentation-language/understand-apl.html
alexa · Jul 6, 2023 · 51f7df1 · 51f7df1
1 parent df2c9b0
commit 51f7df1
Show file tree

Hide file tree

Showing 20 changed files with 207 additions and 203 deletions.
diff --git a/APLClient/include/APLClient/AplCoreConnectionManager.h b/APLClient/include/APLClient/AplCoreConnectionManager.h
@@ -232,11 +232,6 @@ class AplCoreConnectionManager
      */
     void sendViewhostScalingMessage();
 
-    /**
-     * Sends document theme information to the client
-     */
-    void sendDocumentThemeMessage();
-
     /**
      * Sends document background information to the client
      * @param background

diff --git a/APLClient/include/APLClient/AplCoreMediaPlayer.h b/APLClient/include/APLClient/AplCoreMediaPlayer.h
@@ -69,6 +69,7 @@ class AplCoreMediaPlayer : public apl::MediaPlayer {
     void previous() override;
     void rewind() override;
     void seek(int offset) override;
+    void seekTo(int position) override;
     void setTrackIndex(int trackIndex) override;
     void setAudioTrack(apl::AudioTrack audioTrack) override;
     void setMute(bool mute) override;

diff --git a/APLClient/src/AplCoreConnectionManager.cpp b/APLClient/src/AplCoreConnectionManager.cpp
@@ -357,7 +357,6 @@ void AplCoreConnectionManager::handleConfigurationChange(const rapidjson::Value&
     // config change for theme
     if (configurationChange.HasMember(DOCTHEME_KEY) && configurationChange[DOCTHEME_KEY].IsString()) {
         configChange = configChange.theme(configurationChange[DOCTHEME_KEY].GetString());
-        sendDocumentThemeMessage();
     }
     // config change for mode
     if (configurationChange.HasMember(MODE_KEY) &&
@@ -762,7 +761,6 @@ void AplCoreConnectionManager::handleBuild(const rapidjson::Value& message) {
                          {apl::RootProperty::kAnimationQuality, static_cast<apl::RootConfig::AnimationQuality>(animationQuality)},
                          {apl::RootProperty::kUTCTime, getCurrentTime().count()},
                          {apl::RootProperty::kLocalTimeAdjustment, aplOptions->getTimezoneOffset().count()},
-                         {apl::RootProperty::kSequenceChildCache, 5},
                          {apl::RootProperty::kDefaultIdleTimeout, -1}
                       })
                      .measure(std::make_shared<AplCoreTextMeasurement>(shared_from_this(), m_aplConfiguration))
@@ -887,7 +885,6 @@ void AplCoreConnectionManager::handleBuild(const rapidjson::Value& message) {
         inflationTimer->stop();
         // Init viewhost globals
         sendViewhostScalingMessage();
-        sendDocumentThemeMessage();
         sendDocumentBackgroundMessage(background);
 
         // Start rendering component hierarchy
@@ -926,19 +923,6 @@ void AplCoreConnectionManager::sendViewhostScalingMessage() {
     }
 }
 
-void AplCoreConnectionManager::sendDocumentThemeMessage() {
-    if (m_Root) {
-        auto themeMsg = AplCoreViewhostMessage(DOCTHEME_KEY);
-        auto& alloc = themeMsg.alloc();
-        rapidjson::Value payload(rapidjson::kObjectType);
-        std::string docTheme = "dark";
-        docTheme = m_Root->getTheme();
-        payload.AddMember(DOCTHEME_KEY, rapidjson::Value(docTheme.c_str(), alloc).Move(), alloc);
-        themeMsg.setPayload(std::move(payload));
-        send(themeMsg);
-    }
-}
-
 void AplCoreConnectionManager::sendDocumentBackgroundMessage(const apl::Object& background) {
     auto backgroundMsg = AplCoreViewhostMessage(BACKGROUND_KEY);
     auto& alloc = backgroundMsg.alloc();
@@ -998,11 +982,6 @@ void AplCoreConnectionManager::handleUpdate(const rapidjson::Value& update) {
         component->update(type, value);
     } else {
         auto value = update["value"].GetFloat();
-
-        if (type == apl::UpdateType::kUpdateScrollPosition) {
-            value = m_AplCoreMetrics->toCore(value);
-        }
-
         component->update(type, value);
     }
 }
@@ -1075,7 +1054,7 @@ void AplCoreConnectionManager::handleGraphicUpdate(const rapidjson::Value& updat
         return;
     }
 
-    auto json = apl::GraphicContent::create(m_Root->getSession(), update["avg"].GetString());
+    auto json = apl::GraphicContent::create(update["avg"].GetString());
     component->updateGraphic(json);
 }
 

diff --git a/APLClient/src/AplCoreMediaPlayer.cpp b/APLClient/src/AplCoreMediaPlayer.cpp
@@ -218,6 +218,18 @@ AplCoreMediaPlayer::seek(int offset)
     sendMediaPlayerCommand("mediaPlayerSeek", std::move(payload));
 }
 
+void
+AplCoreMediaPlayer::seekTo(int position)
+{
+    if (!isActive()) return;
+    resolveExistingAction();
+
+    rapidjson::MemoryPoolAllocator<rapidjson::CrtAllocator> alloc;
+    rapidjson::Value payload(rapidjson::kObjectType);
+    payload.AddMember("position", position, alloc);
+    sendMediaPlayerCommand("mediaPlayerSeekTo", std::move(payload));
+}
+
 void
 AplCoreMediaPlayer::setTrackIndex(int trackIndex)
 {

diff --git a/APLClient/test/AplCoreConnectionManagerTest.cpp b/APLClient/test/AplCoreConnectionManagerTest.cpp
@@ -867,8 +867,6 @@ TEST_F(AplCoreConnectionManagerTest, HandleReInflateSuccess) {
     SetupMocksForDocumentRender();
     // Given a document build success.
     BuildDocument(DOCUMENT, DATA, VIEWPORT);
-    const std::string measureMessageType = "\"type\":\"measure\"";
-    EXPECT_CALL(*m_mockAplOptions, sendMessage(_, MatchOutMessage(measureMessageType, ""))).Times(AtLeast(1));
     const std::string hierarchyMessageType = "\"type\":\"hierarchy\"";
     EXPECT_CALL(*m_mockAplOptions, sendMessage(_, MatchOutMessage(hierarchyMessageType, ""))).Times(1);
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog for apl-client-library
 
+## [2023.2]
+This release adds support for version 2023.2 of the APL specification. Please also see APL Core Library for changes: [apl-core-library CHANGELOG](https://github.com/alexa/apl-core-library/blob/master/CHANGELOG.md)
+
+### Added
+- Add support for the seekTo ControlMedia command
+
+### Changed
+- Remove usage of APL Core Library's deprecated getTheme API
+- Bug fixes
+
 ## [2023.1]
 This release adds support for version 2023.1 of the APL specification. Please also see APL Core Library for changes: [apl-core-library CHANGELOG](https://github.com/alexa/apl-core-library/blob/master/CHANGELOG.md)
 

diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # Alexa Presentation Language (APL) Client Library
 
 <p>
- <a href="https://github.com/alexa/apl-client-library/tree/v2023.1.0" alt="version">
- <img src="https://img.shields.io/badge/stable%20version-2023.1.0-brightgreen" /></a>
- <a href="https://github.com/alexa/apl-core-library/tree/v2023.1.0" alt="APLCore">
- <img src="https://img.shields.io/badge/apl%20core%20library-2023.1.0-navy" /></a>
+ <a href="https://github.com/alexa/apl-client-library/tree/v2023.2.0" alt="version">
+ <img src="https://img.shields.io/badge/stable%20version-2023.2.0-brightgreen" /></a>
+ <a href="https://github.com/alexa/apl-core-library/tree/v2023.2.0" alt="APLCore">
+ <img src="https://img.shields.io/badge/apl%20core%20library-2023.2.0-navy" /></a>
 </p>
 
 ## Introduction

diff --git a/apl-client-js/@types/apl-html/lib/APLRenderer.d.ts b/apl-client-js/@types/apl-html/lib/APLRenderer.d.ts
@@ -252,7 +252,7 @@ export default abstract class APLRenderer<Options = any> {
      */
     onDisplayStateChange(displayStateOptions: IDisplayStateOptions): void;
     getComponentCount(): number;
-    private setBackground(docTheme);
+    private setBackground();
     /**
      * Get developer tool options (if defined)
      */

diff --git a/apl-client-js/@types/apl-html/lib/dts/Context.d.ts b/apl-client-js/@types/apl-html/lib/dts/Context.d.ts
@@ -23,7 +23,6 @@ declare namespace APL {
     export class Context extends Deletable {
         public static create(options: any, text: TextMeasure, metrics?: APL.Metrics, content?: APL.Content, config?: APL.RootConfig, scalingOptions?: any): Context;
         public topComponent(): APL.Component;
-        public getTheme(): string;
         public getBackground(): APL.IBackground;
         public setBackground(background: APL.IBackground): void;
         public getDataSourceContext(): Promise<string>;

diff --git a/apl-client-js/@types/apl-html/lib/enums/CommandControlMedia.d.ts b/apl-client-js/@types/apl-html/lib/enums/CommandControlMedia.d.ts
@@ -10,5 +10,6 @@ export declare enum CommandControlMedia {
     kCommandControlMediaPrevious = 3,
     kCommandControlMediaRewind = 4,
     kCommandControlMediaSeek = 5,
-    kCommandControlMediaSetTrack = 6
+    kCommandControlMediaSeekTo = 6,
+    kCommandControlMediaSetTrack = 7
 }
diff --git a/apl-client-js/@types/apl-html/lib/enums/CommandType.d.ts b/apl-client-js/@types/apl-html/lib/enums/CommandType.d.ts
@@ -27,5 +27,7 @@ export declare enum CommandType {
     kCommandTypeClearFocus = 20,
     kCommandTypeFinish = 21,
     kCommandTypeReinflate = 22,
-    kCommandTypeCustomEvent = 23
+    kCommandTypeCustomEvent = 23,
+    kCommandTypeInsertItem = 24,
+    kCommandTypeRemoveItem = 25
 }
diff --git a/apl-client-js/@types/apl-html/lib/enums/ComponentType.d.ts b/apl-client-js/@types/apl-html/lib/enums/ComponentType.d.ts
@@ -9,12 +9,13 @@ export declare enum ComponentType {
     kComponentTypeExtension = 2,
     kComponentTypeFrame = 3,
     kComponentTypeGridSequence = 4,
-    kComponentTypeImage = 5,
-    kComponentTypePager = 6,
-    kComponentTypeScrollView = 7,
-    kComponentTypeSequence = 8,
-    kComponentTypeText = 9,
-    kComponentTypeTouchWrapper = 10,
-    kComponentTypeVectorGraphic = 11,
-    kComponentTypeVideo = 12
+    kComponentTypeHost = 5,
+    kComponentTypeImage = 6,
+    kComponentTypePager = 7,
+    kComponentTypeScrollView = 8,
+    kComponentTypeSequence = 9,
+    kComponentTypeText = 10,
+    kComponentTypeTouchWrapper = 11,
+    kComponentTypeVectorGraphic = 12,
+    kComponentTypeVideo = 13
 }