Media Collection support

package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactor-extension-alloy",
-  "version": "2.21.2",
+  "version": "2.21.4",
   "description": "The Adobe Experience Platform Web SDK allows for streaming data into the platform, syncing identities, personalizing content, and more.",
   "author": {
     "name": "Adobe",
@@ -36,7 +36,8 @@
     "test:functional:watch:debug": "echo \"open chrome://inspect in Chrome and click 'inspect'\" && node --inspect-brk ./scripts/functional.js --watch",
     "test": "npm-run-all --parallel test:unit test:functional",
     "token": "node scripts/token.js",
-    "version": "./scripts/version.sh"
+    "version": "./scripts/version.sh",
+    "upload": "reactor-uploader --org-id=$REACTOR_UPLOADER_ORG_ID --tech-account-id=$REACTOR_UPLOADER_TECH_ACCOUNT_ID --api-key=$REACTOR_UPLOADER_API_KEY --client-secret=$REACTOR_IO_INTEGRATION_CLIENT_SECRET"
   },
   "lint-staged": {
     "./*.{js,jsx}": [
@@ -53,7 +54,7 @@
     ]
   },
   "dependencies": {
-    "@adobe/alloy": "^2.19.0",
+    "@adobe/alloy": "file:../adobe/alloy",
     "@adobe/react-spectrum": "^3.26.0",
     "@react-stately/data": "^3.4.0",
     "@spectrum-css/typography": "^3.0.2",
@@ -76,6 +77,7 @@
     "@adobe/reactor-sandbox": "^12.5.0",
     "@adobe/reactor-turbine": "^27.2.1",
     "@adobe/reactor-turbine-schemas": "^10.5.0",
+    "@adobe/reactor-uploader": "^4.1.0",
     "@babel/cli": "^7.12.16",
     "@babel/core": "^7.12.16",
     "@babel/plugin-proposal-class-properties": "^7.12.13",

scripts/helpers/createExtensionManifest.js

@@ -192,7 +192,7 @@ const createExtensionManifest = ({ version }) => {
   const extensionManifest = {
     version,
     displayName: "Adobe Experience Platform Web SDK",
-    name: "adobe-alloy",
+    name: "adobe-alloy-nina",
     iconPath: "resources/images/icon.svg",
     exchangeUrl:
       "https://exchange.adobe.com/experiencecloud.details.106387.aep-web-sdk.html",
@@ -309,6 +309,26 @@ const createExtensionManifest = ({ version }) => {
                   minLength: 1
                 },
                 edgeConfigOverrides: createEdgeConfigOverridesSchema(false),
+                mediaCollection: {
+                  type: "object",
+                  properties: {
+                    channel: {
+                      type: "string"
+                    },
+                    playerName: {
+                      type: "string"
+                    },
+                    version: {
+                      type: "string"
+                    },
+                    mainPingInterval: {
+                      type: "integer"
+                    },
+                    adPingInterval: {
+                      type: "integer"
+                    }
+                  }
+                },
                 personalizationStorageEnabled: {
                   type: "boolean"
                 }
@@ -788,6 +808,90 @@ const createExtensionManifest = ({ version }) => {
         libPath: "dist/lib/actions/updateVariable/index.js",
         viewPath: "actions/updateVariable.html"
       },
+      {
+        displayName: "Create Media Analytics Session",
+        name: "create-media-session",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            instanceName: {
+              type: "string",
+              minLength: 1
+            },
+            xdm: {
+              type: "string",
+              pattern: "^%[^%]+%$"
+            },
+            playerId: {
+              type: "string"
+            },
+            onBeforeMediaEvent: {
+              type: "string"
+            }
+          },
+          required: ["instanceName"],
+          additionalProperties: false
+        },
+        libPath: "dist/lib/actions/createMediaSession/index.js",
+        viewPath: "actions/createMediaSession.html",
+        transforms: [
+          {
+            type: "function",
+            propertyPath: "onBeforeMediaEvent",
+            parameters: ["content"]
+          }
+        ]
+      },
+      {
+        displayName: "Send Media Analytics Event",
+        name: "send-media-event",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            instanceName: {
+              type: "string",
+              minLength: 1
+            },
+            eventType: {
+              type: "string",
+              minLength: 1
+            },
+            playerId: {
+              type: "string",
+              minLength: 1
+            },
+            xdm: {
+              type: "object"
+            }
+          },
+          required: ["instanceName"]
+        },
+        libPath: "dist/lib/actions/sendMediaEvent/index.js",
+        viewPath: "actions/sendMediaAnalyticsEvent.html"
+      },
+      {
+        displayName: "Get Media Tracker API",
+        name: "get-media-tracker-api",
+        schema: {
+          $schema: "http://json-schema.org/draft-04/schema#",
+          type: "object",
+          properties: {
+            instanceName: {
+              type: "string",
+              minLength: 1
+            },
+            objectName: {
+              type: "string",
+              minLength: 1
+            }
+          },
+          required: ["instanceName"]
+        },
+        libPath: "dist/lib/actions/getMediaTrackerAPI/index.js",
+        viewPath: "actions/createMediaTracker.html"
+      },
       {
         displayName: "Evaluate rulesets",
         name: "evaluate-rulesets",
@@ -883,6 +987,13 @@ const createExtensionManifest = ({ version }) => {
             ]
           }
         }
+      },
+      {
+        name: "media-session-id-received",
+        displayName: "Media Analytics Session ID received",
+        libPath:
+          "dist/lib/events/createMediaAnalyticsSessionIDComplete/index.js",
+        schema: {}
       }
     ],
     dataElements: [

src/lib/actions/createMediaSession/createMediaSession.js

@@ -0,0 +1,41 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports = ({
+  instanceManager,
+  mediaAnalyticsSessionCallbackStorage,
+  wrapOnBeforeMediaEvent
+}) => settings => {
+  const { instanceName, ...createMediaSessionSettings } = settings;
+  const instance = instanceManager.getInstance(instanceName);
+
+  if (!instance) {
+    throw new Error(
+      `Failed to send event for instance "${instanceName}". No matching instance was configured with this name.`
+    );
+  }
+
+  const options = { xdm: createMediaSessionSettings.xdm };
+  if (
+    createMediaSessionSettings.playerId &&
+    createMediaSessionSettings.onBeforeMediaEvent
+  ) {
+    options.playerId = createMediaSessionSettings.playerId;
+    options.onBeforeMediaEvent = wrapOnBeforeMediaEvent(
+      createMediaSessionSettings.onBeforeMediaEvent
+    );
+  }
+
+  return instance("createMediaSession", options).then(result => {
+    mediaAnalyticsSessionCallbackStorage.triggerEvent(result);
+  });
+};

src/lib/actions/createMediaSession/index.js

@@ -0,0 +1,23 @@
+/*
+Copyright 2019 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const createMediaSession = require("./createMediaSession");
+const instanceManager = require("../../instanceManager/index");
+const { mediaAnalyticsSessionCallbackStorage } = require("../../index");
+const injectWrapOnBeforeMediaEvent = require("./injectWrapOnBeforeMediaEvent");
+
+const wrapOnBeforeMediaEvent = injectWrapOnBeforeMediaEvent();
+module.exports = createMediaSession({
+  instanceManager,
+  mediaAnalyticsSessionCallbackStorage,
+  wrapOnBeforeMediaEvent
+});

src/lib/actions/createMediaSession/injectWrapOnBeforeMediaEvent.js

@@ -0,0 +1,18 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports = () => onBeforeMediaEventSend => content => {
+  if (onBeforeMediaEventSend) {
+    return onBeforeMediaEventSend(content);
+  }
+  return undefined;
+};

src/lib/actions/getMediaTrackerAPI/getMediaTrackerAPI.js

@@ -0,0 +1,26 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports = ({ instanceManager, windowObject }) => settings => {
+  const { instanceName, objectName = "Media" } = settings;
+  const instance = instanceManager.getInstance(instanceName);
+
+  if (!instance) {
+    throw new Error(
+      `Failed to send event for instance "${instanceName}". No matching instance was configured with this name.`
+    );
+  }
+
+  return instance("getMediaAnalyticsTracker", {}).then(result => {
+    windowObject[objectName] = result;
+  });
+};

src/lib/actions/getMediaTrackerAPI/index.js

@@ -0,0 +1,21 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const getMediaTrackerAPI = require("./getMediaTrackerAPI");
+const instanceManager = require("../../instanceManager/index");
+
+const windowObject = window;
+
+module.exports = getMediaTrackerAPI({
+  instanceManager,
+  windowObject
+});

src/lib/actions/sendMediaEvent/createSendMediaEvent.js

@@ -0,0 +1,32 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { deepAssign } = require("../../alloy");
+
+module.exports = ({ instanceManager }) => settings => {
+  const {
+    instanceName,
+    eventType,
+    playerId,
+    ...createMediaEventSettings
+  } = settings;
+  const instance = instanceManager.getInstance(instanceName);
+
+  if (!instance) {
+    throw new Error(
+      `Failed to send event for instance "${instanceName}". No matching instance was configured with this name.`
+    );
+  }
+  const { xdm = {} } = createMediaEventSettings;
+  deepAssign(xdm, { eventType });
+  return instance("sendMediaEvent", { xdm, playerId });
+};

src/lib/actions/sendMediaEvent/index.js

@@ -0,0 +1,18 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const createMediaEvent = require("./createSendMediaEvent");
+const instanceManager = require("../../instanceManager/index");
+
+module.exports = createMediaEvent({
+  instanceManager
+});

src/lib/createMediaAnalyticsSessionCallbackStorage.js

@@ -0,0 +1,25 @@
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+module.exports = () => {
+  const createMediaAnalyticsSessionCompleteTriggers = [];
+  return {
+    add(trigger) {
+      createMediaAnalyticsSessionCompleteTriggers.push(trigger);
+    },
+    triggerEvent(result) {
+      createMediaAnalyticsSessionCompleteTriggers.forEach(trigger => {
+        trigger(result);
+      });
+    }
+  };
+};