types aren't compatible between createWrapper returned function and AnalyticsBrowser

[YoFirmy]

We're trying to set up our analytics with the withOneTrust wrapper in packages/consent/consent-wrapper-onetrust. We've followed the documentation for npm library users, which is essentially just this snippet:

import { withOneTrust } from '@segment/analytics-consent-wrapper-onetrust'
import { AnalyticsBrowser } from '@segment/analytics-next'

export const analytics = new AnalyticsBrowser()

withOneTrust(analytics).load({ writeKey: '<MY_WRITE_KEY'> })

Everything seems to work but we get a typescript error in our code. The issue seems to be the writeKeyOrSettings argument on the load method of the analyticsInstance that is supposed to be passed to the withOneTrust wrapper. The withOneTrust wrapper has it typed as AnalyticsBrowserSettings | string, but the load method on the analyticsInstance does not have string as an option for it's first argument.

Here is the full type error:

Argument of type 'AnalyticsBrowser' is not assignable to parameter of type 'AnyAnalytics'.
  Types of property 'load' are incompatible.
    Type '(settings: AnalyticsBrowserSettings, options?: InitOptions | undefined) => AnalyticsBrowser' is not assignable to type '(writeKeyOrSettings: string | AnalyticsBrowserSettings, options?: InitOptions | undefined) => void'.
      Types of parameters 'settings' and 'writeKeyOrSettings' are incompatible.
        Type 'string | AnalyticsBrowserSettings' is not assignable to type 'AnalyticsBrowserSettings'.
          Type 'string' is not assignable to type 'AnalyticsBrowserSettings'.

Version information in case it is relevant: we're importing withOneTrust from "@segment/analytics-consent-wrapper-onetrust": "1.1.2", and AnalyticsBrowser from "@segment/analytics-next": "1.75.0".

[YoFirmy]

Note: the withOneTrust wrapper uses the createWrapper function from @segment/analytics-consent-tools. It is createWrapper that returns a function expecting AnyAnalytics as it's first argument, but all docs show passing AnalyticsBrowser

[silesky]

@YoFirmy,

window.analytics is one of the targets, and it’s actually type Analytics, not AnalyticsBrowser :-)

Background: AnyAnalytics is supposed to be a minimal interface that AnalyticsBrowser and Analytics (the non buffered instance it wraps) conforms to. We wanted to avoid making the wrapper a hard dependency of any of the analytics packages to avoid unneeded bloat (as this is just a compile time dependency). The point was to make the typing as antifragile as possible, but still have some minimal guarantees. Looks like something slipped through the cracks (which is weird, because we have tests for the types as well).

(It’s also being used in a snippet context)

Sorry, I haven’t had time to look at this issue, but this kind of thing is usually easy to resolve afaik. Contribution welcome here!

[tomh-altium]

@silesky this has been broken for a while now, is this being looked into by segment?

[silesky]

@silesky this has been broken for a while now, is this being looked into by segment?

Sorry, haven't had time. It's being tracked in our Jira.

For now, I would just recommend you do // @ts-expect-error above that line.