Only export core types from messaging

Author: Shane Osbourne

Diff for: injected/entry-points/android.js

@@ -4,7 +4,7 @@
 import { load, init } from '../src/content-scope-features.js'
 import { processConfig, isGloballyDisabled } from './../src/utils'
 import { isTrackerOrigin } from '../src/trackers'
-import { AndroidMessagingConfig } from '../../messaging/index.js'
+import { AndroidMessagingConfig } from '../../messaging/lib/android.js'
 
 function initCode () {
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f

Diff for: injected/entry-points/apple.js

@@ -4,7 +4,8 @@
 import { load, init } from '../src/content-scope-features.js'
 import { processConfig, isGloballyDisabled } from './../src/utils'
 import { isTrackerOrigin } from '../src/trackers'
-import { WebkitMessagingConfig, TestTransportConfig } from '../../messaging/index.js'
+import { TestTransportConfig } from '../../messaging/index.js'
+import { WebkitMessagingConfig } from '../../messaging/lib/webkit.js'
 
 function initCode () {
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f

Diff for: injected/entry-points/windows.js

@@ -4,7 +4,7 @@
 import { load, init } from '../src/content-scope-features.js'
 import { processConfig, isGloballyDisabled, windowsSpecificFeatures } from './../src/utils'
 import { isTrackerOrigin } from '../src/trackers'
-import { WindowsMessagingConfig } from '../../messaging/index.js'
+import { WindowsMessagingConfig } from '../../messaging/lib/windows.js'
 
 function initCode () {
     // @ts-expect-error https://app.asana.com/0/1201614831475344/1203979574128023/f

Diff for: injected/src/content-feature.js

@@ -3,7 +3,7 @@ import { immutableJSONPatch } from 'immutable-json-patch'
 import { PerformanceMonitor } from './performance.js'
 import { defineProperty, shimInterface, shimProperty, wrapMethod, wrapProperty, wrapToString } from './wrapper-utils.js'
 import { Proxy, Reflect } from './captured-globals.js'
-import { Messaging, MessagingContext } from '../../messaging/index.js'
+import { MessagingContext } from '../../messaging/index.js'
 import { extensionConstructMessagingConfig } from './sendmessage-transport.js'
 
 /**
@@ -125,7 +125,7 @@ export default class ContentFeature {
             if (this.platform?.name !== 'extension') throw new Error('Only extension messaging supported, all others should be passed in')
             messagingConfig = extensionConstructMessagingConfig()
         }
-        this._messaging = new Messaging(messagingContext, messagingConfig)
+        this._messaging = messagingConfig.intoMessaging(messagingContext)
         return this._messaging
     }
 

Diff for: injected/src/features/click-to-load.js

@@ -1,4 +1,3 @@
-import { Messaging, TestTransportConfig, WebkitMessagingConfig } from '../../../messaging/index.js'
 import { createCustomEvent, originalWindowDispatchEvent } from '../utils.js'
 import { logoImg, loadingImages, closeIcon, facebookLogo } from './click-to-load/ctl-assets.js'
 import { getStyles, getConfig } from './click-to-load/ctl-config.js'
@@ -7,6 +6,7 @@ import ContentFeature from '../content-feature.js'
 import { DDGCtlPlaceholderBlockedElement } from './click-to-load/components/ctl-placeholder-blocked.js'
 import { DDGCtlLoginButton } from './click-to-load/components/ctl-login-button.js'
 import { registerCustomElements } from './click-to-load/components'
+import { TestTransportConfig } from '@duckduckgo/messaging'
 
 /**
  * @typedef {'darkMode' | 'lightMode' | 'loginMode' | 'cancelMode'} displayMode
@@ -2019,16 +2019,10 @@ export default class ClickToLoad extends ContentFeature {
         if (this.platform.name === 'android' || this.platform.name === 'extension') {
             this._clickToLoadMessagingTransport = new SendMessageMessagingTransport()
             const config = new TestTransportConfig(this._clickToLoadMessagingTransport)
-            this._messaging = new Messaging(this.messagingContext, config)
+            this._messaging = config.intoMessaging(this.messagingContext)
             return this._messaging
         } else if (this.platform.name === 'ios' || this.platform.name === 'macos') {
-            const config = new WebkitMessagingConfig({
-                secret: '',
-                hasModernWebkitAPI: true,
-                webkitMessageHandlerNames: ['contentScopeScriptsIsolated']
-            })
-            this._messaging = new Messaging(this.messagingContext, config)
-            return this._messaging
+            return this.messaging
         } else {
             throw new Error('Messaging not supported yet on platform: ' + this.name)
         }

Diff for: injected/unit-test/messaging.js

@@ -1,5 +1,4 @@
 import {
-    Messaging,
     MessagingContext,
     TestTransportConfig,
     RequestMessage, NotificationMessage, Subscription, MessageResponse, SubscriptionEvent
@@ -82,7 +81,7 @@ describe('Android', () => {
             featureName,
             env: 'development'
         })
-        const messaging = new Messaging(messageContextA, config)
+        const messaging = config.intoMessaging(messageContextA)
         return { messaging }
     }
     it('sends notification to 1 feature', () => {
@@ -232,7 +231,7 @@ function createMessaging () {
         env: 'development'
     })
 
-    const messaging = new Messaging(messagingContext, testTransportConfig)
+    const messaging = testTransportConfig.intoMessaging(messagingContext)
 
     return { transport, messaging }
 }

Diff for: messaging/index.js

@@ -19,11 +19,16 @@
  * - Implementation Guide: {@link "Messaging Implementation Guide"}
  *
  * @module Messaging
+ *
+ * @import { WindowsMessagingConfig, } from './lib/windows.js'
+ * @import { WebkitMessagingConfig, WebkitMessagingTransport } from './lib/webkit.js';
+ * @import { AndroidMessagingConfig } from './lib/android.js';
+ * @typedef {WebkitMessagingConfig | WindowsMessagingConfig | AndroidMessagingConfig | TestTransportConfig} MessagingConfig
+ * @typedef {{intoMessaging: (ctx: MessagingContext) => Messaging}} IntoMessaging
+ *
  */
-import { WindowsMessagingConfig, WindowsMessagingTransport, WindowsInteropMethods, WindowsNotification, WindowsRequestMessage } from './lib/windows.js'
-import { WebkitMessagingConfig, WebkitMessagingTransport } from './lib/webkit.js'
+
 import { NotificationMessage, RequestMessage, Subscription, MessageResponse, MessageError, SubscriptionEvent } from './schema.js'
-import { AndroidMessagingConfig, AndroidMessagingTransport } from './lib/android.js'
 import { createTypedMessages } from './lib/typed-messages.js'
 
 /**
@@ -45,20 +50,22 @@ export class MessagingContext {
 }
 
 /**
- * @typedef {WebkitMessagingConfig | WindowsMessagingConfig | AndroidMessagingConfig | TestTransportConfig} MessagingConfig
- */
-
-/**
- *
+ * The consumer interface
  */
 export class Messaging {
     /**
      * @param {MessagingContext} messagingContext
-     * @param {MessagingConfig} config
+     * @param {MessagingTransport} transport
      */
-    constructor (messagingContext, config) {
+    constructor (messagingContext, transport) {
+        /**
+         * @internal
+         */
         this.messagingContext = messagingContext
-        this.transport = getTransport(config, this.messagingContext)
+        /**
+         * @internal
+         */
+        this.transport = transport
     }
 
     /**
@@ -164,6 +171,7 @@ export class MessagingTransport {
  * It's useful for debugging, and for enabling scripts to run in
  * other environments - for example, testing in a browser without the need
  * for a full integration
+ * @implements IntoMessaging
  */
 export class TestTransportConfig {
     /**
@@ -172,6 +180,13 @@ export class TestTransportConfig {
     constructor (impl) {
         this.impl = impl
     }
+
+    /**
+     * @param {MessagingContext} context
+     */
+    intoMessaging (context) {
+        return new Messaging(context, new TestTransport(this, context))
+    }
 }
 
 /**
@@ -200,27 +215,6 @@ export class TestTransport {
     }
 }
 
-/**
- * @param {WebkitMessagingConfig | WindowsMessagingConfig | AndroidMessagingConfig | TestTransportConfig} config
- * @param {MessagingContext} messagingContext
- * @returns {MessagingTransport}
- */
-function getTransport (config, messagingContext) {
-    if (config instanceof WebkitMessagingConfig) {
-        return new WebkitMessagingTransport(config, messagingContext)
-    }
-    if (config instanceof WindowsMessagingConfig) {
-        return new WindowsMessagingTransport(config, messagingContext)
-    }
-    if (config instanceof AndroidMessagingConfig) {
-        return new AndroidMessagingTransport(config, messagingContext)
-    }
-    if (config instanceof TestTransportConfig) {
-        return new TestTransport(config, messagingContext)
-    }
-    throw new Error('unreachable')
-}
-
 /**
  * Thrown when a handler cannot be found
  */
@@ -239,20 +233,11 @@ export class MissingHandler extends Error {
  * Some re-exports for convenience
  */
 export {
-    WebkitMessagingConfig,
-    WebkitMessagingTransport,
-    WindowsMessagingConfig,
-    WindowsMessagingTransport,
-    WindowsInteropMethods,
     NotificationMessage,
     RequestMessage,
     Subscription,
     MessageResponse,
     MessageError,
     SubscriptionEvent,
-    WindowsNotification,
-    WindowsRequestMessage,
-    AndroidMessagingConfig,
-    AndroidMessagingTransport,
     createTypedMessages
 }

Diff for: messaging/lib/android.js

@@ -6,13 +6,16 @@
  *
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { MessagingTransport, MessageResponse, SubscriptionEvent } from '../index.js'
+import { Messaging, MessagingTransport } from '../index.js'
 import { isResponseFor, isSubscriptionEventFor } from '../schema.js'
 
 /**
  * @typedef {import('../index.js').Subscription} Subscription
  * @typedef {import('../index.js').MessagingContext} MessagingContext
  * @typedef {import('../index.js').RequestMessage} RequestMessage
+ * @typedef {import('../index.js').SubscriptionEvent} SubscriptionEvent
+ * @typedef {import('../index.js').MessageResponse} MessageResponse
+ * @typedef {import('../index.js').IntoMessaging} IntoMessaging
  * @typedef {import('../index.js').NotificationMessage} NotificationMessage
  */
 
@@ -171,6 +174,7 @@ export class AndroidMessagingTransport {
  *     }
  * }
  * ```
+ * @implements IntoMessaging
  */
 export class AndroidMessagingConfig {
     /** @type {(json: string, secret: string) => void} */
@@ -210,6 +214,14 @@ export class AndroidMessagingConfig {
         this._assignHandlerMethod()
     }
 
+    /**
+     * @param {MessagingContext} context
+     * @return {Messaging}
+     */
+    intoMessaging (context) {
+        return new Messaging(context, new AndroidMessagingTransport(this, context))
+    }
+
     /**
      * The transport can call this to transmit a JSON payload along with a secret
      * to the native Android handler.

Diff for: messaging/lib/examples/android.example.js

@@ -1,4 +1,4 @@
-import { Messaging, MessagingContext } from '../../index.js'
+import { MessagingContext } from '../../index.js'
 import { AndroidMessagingConfig } from '../android.js'
 
 /**
@@ -30,7 +30,7 @@ const messagingContext = new MessagingContext({
 /**
  * And then send notifications!
  */
-const messaging = new Messaging(messagingContext, config)
+const messaging = config.intoMessaging(messagingContext)
 messaging.notify('helloWorld')
 
 /**
@@ -63,8 +63,8 @@ const messagingContext2 = { ...messagingContext1, featureName: 'duckPlayer' }
 /**
  * Now, each feature has its own isolated messaging...
  */
-const messaging1 = new Messaging(messagingContext, config)
+const messaging1 = config.intoMessaging(messagingContext1)
 messaging1.notify('helloWorld')
 
-const messaging2 = new Messaging(messagingContext2, config)
+const messaging2 = config.intoMessaging(messagingContext2)
 messaging2.notify('getUserValues')

Diff for: messaging/lib/examples/test.example.js

@@ -1,4 +1,4 @@
-import { Messaging, MessagingContext, TestTransportConfig } from '../../index.js'
+import { MessagingContext, TestTransportConfig } from '../../index.js'
 
 /**
  * Creates an ad-hoc messaging transport on the fly - useful for testing
@@ -36,7 +36,7 @@ const messagingContext = new MessagingContext({
 /**
  * And then send notifications!
  */
-const messaging = new Messaging(messagingContext, config)
+const messaging = config.intoMessaging(messagingContext)
 messaging.notify('helloWorld')
 
 /**

Diff for: messaging/lib/examples/webkit.example.js

@@ -1,4 +1,5 @@
-import { Messaging, MessagingContext, WebkitMessagingConfig } from '../../index.js'
+import { MessagingContext } from '../../index.js'
+import { WebkitMessagingConfig } from '../webkit.js'
 
 /**
  * Configuration for WebkitMessaging
@@ -21,7 +22,7 @@ const messagingContext = new MessagingContext({
 /**
  * With config + context, now create an instance:
  */
-const messaging = new Messaging(messagingContext, config)
+const messaging = config.intoMessaging(messagingContext)
 
 /**
  * send notifications (fire and forget)

Diff for: messaging/lib/examples/windows.example.js

@@ -1,5 +1,5 @@
 import { WindowsMessagingConfig } from '../windows.js'
-import { Messaging, MessagingContext } from '../../index.js'
+import { MessagingContext } from '../../index.js'
 
 /**
  * These 3 required methods that get assigned by the Native side.
@@ -32,7 +32,7 @@ const messagingContext = new MessagingContext({
 /**
  * And then send notifications!
  */
-const messaging = new Messaging(messagingContext, config)
+const messaging = config.intoMessaging(messagingContext)
 messaging.notify('helloWorld')
 
 /**

Diff for: messaging/lib/webkit.js

@@ -7,7 +7,7 @@
  * part of the message handling, see {@link WebkitMessagingTransport} for details.
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { MessagingTransport, MissingHandler } from '../index.js'
+import { MessagingTransport, MissingHandler, Messaging } from '../index.js'
 import { isResponseFor, isSubscriptionEventFor } from '../schema.js'
 
 /**
@@ -317,6 +317,9 @@ export class WebkitMessagingTransport {
  * Please see {@link WebkitMessagingTransport} for details on how messages are sent/received
  *
  * [Example](./examples/webkit.example.js)
+ *
+ * @import { IntoMessaging, MessagingContext } from "../index.js"
+ * @implements IntoMessaging
  */
 export class WebkitMessagingConfig {
     /**
@@ -354,6 +357,14 @@ export class WebkitMessagingConfig {
          */
         this.secret = params.secret
     }
+
+    /**
+     * @param {MessagingContext} context
+     * @return {Messaging}
+     */
+    intoMessaging (context) {
+        return new Messaging(context, new WebkitMessagingTransport(this, context))
+    }
 }
 
 /**