feat(audience): CDN bundle entry point and tsup build (SDK-115)#2853
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit 42565f8
☁️ Nx Cloud last updated this comment at |
|
View your CI Pipeline Execution ↗ for commit c58d1f8
☁️ Nx Cloud last updated this comment at |
ImmutableJeffrey
added a commit
that referenced
this pull request
Apr 15, 2026
…core Exposes AudienceError to web SDK consumers. The core queue and consent manager already accept an onError callback and map TransportError to a public AudienceError via toAudienceError; this commit just forwards AudienceConfig.onError into both positional slots in the Audience constructor, which were previously hard-coded to undefined. Also re-exports AudienceError (runtime) and AudienceErrorCode (type) from the @imtbl/audience package index so ESM consumers can import the error type they need for their onError handler. CDN consumers already have it via window.ImmutableAudience.AudienceError from the CDN bundle work in #2853. Two new sdk.test.ts tests cover the wire-through end-to-end: a flush failure against a mocked backend, and a consent sync failure against a mocked backend. Both verify the AudienceError shape (name, code, status, endpoint) rather than just that the callback fires. Refs SDK-49 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This was referenced Apr 15, 2026
ImmutableJeffrey
added a commit
that referenced
this pull request
Apr 15, 2026
…core Exposes AudienceError to web SDK consumers. The core queue and consent manager already accept an onError callback and map TransportError to a public AudienceError via toAudienceError; this commit just forwards AudienceConfig.onError into both positional slots in the Audience constructor, which were previously hard-coded to undefined. Also re-exports AudienceError (runtime) and AudienceErrorCode (type) from the @imtbl/audience package index so ESM consumers can import the error type they need for their onError handler. CDN consumers already have it via window.ImmutableAudience.AudienceError from the CDN bundle work in #2853. Two new sdk.test.ts tests cover the wire-through end-to-end: a flush failure against a mocked backend, and a consent sync failure against a mocked backend. Both verify the AudienceError shape (name, code, status, endpoint) rather than just that the callback fires. Refs SDK-49 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ImmutableJeffrey
force-pushed
the
feat/audience-cdn-bundle
branch
from
fddbfed to
90add33
Compare
Ships @imtbl/audience as a single-file IIFE bundle for <script>-tag
embedding — no npm install, no bundler required.
Public API:
- Studios load dist/cdn/imtbl-audience.global.js, then call
ImmutableAudience.init({publishableKey: '...'}) to get an instance.
- Global surface: init, AudienceError, AudienceEvents, IdentityType,
canIdentify, canTrack, version. Flat — no class on the global.
Every peer is a conscious forever-commitment, nothing leaks by
default. Adding the class back later is non-breaking additive.
- TypeScript consumers get ImmutableAudienceGlobal re-exported from
the npm entry for typing window.ImmutableAudience.
Build (new tsup.cdn.js):
- format: iife, globalName: ImmutableAudience, platform: browser,
target: es2018
- noExternal: [/.*/] — inlines every transitive dep; a "no bundler"
bundle has to ship self-contained
- treeshake + minify; no source maps (keeps SRI hash stable for
studios pinning)
- Wired into `pnpm build` alongside the existing ESM/CJS builds
- Watch-mode and production version-fallback strings aligned to
'0.0.0-local' for local dev builds
Robustness:
- Double-import guard: a second load is ignored, a warning logs the
already-loaded version and tells the studio to remove the old
<script> tag to upgrade
- globalThis with a window fallback for Safari < 12.1 (the es2018
target predates the globalThis baseline)
Tests:
- src/cdn.test.ts: source-level unit tests (global shape, guard)
- test/cdn-artifact.test.ts: reads the built IIFE off disk, evaluates
it in a jsdom realm, asserts the full global shape, and calls
init() end-to-end via a mocked fetch. Catches failure modes a
source-level test cannot — e.g., a broken tsup config that ships
with the source-level test still passing
- Chained into `pnpm test` so CI's nx affected -t test runs both
ImmutableJeffrey
force-pushed
the
feat/audience-cdn-bundle
branch
from
90add33 to
42565f8
Compare
nattb8
reviewed
Apr 15, 2026
| }), | ||
| replace({ | ||
| __SDK_VERSION__: pkg.version === '0.0.0' ? '2.0.0' : pkg.version, | ||
| __SDK_VERSION__: pkg.version === '0.0.0' ? '0.0.0-local' : pkg.version, |
Contributor
There was a problem hiding this comment.
This is correct — hardcoding '2.0.0' as the local dev fallback was clearly wrong — but it changes the version string reported by all local builds of the existing npm package, not just the new CDN bundle. Worth a quick check that nothing in the codebase compares against '2.0.0' at runtime before the next publish.
ImmutableJeffrey
added a commit
that referenced
this pull request
Apr 15, 2026
…core Exposes AudienceError to web SDK consumers. The core queue and consent manager already accept an onError callback and map TransportError to a public AudienceError via toAudienceError; this commit just forwards AudienceConfig.onError into both positional slots in the Audience constructor, which were previously hard-coded to undefined. Also re-exports AudienceError (runtime) and AudienceErrorCode (type) from the @imtbl/audience package index so ESM consumers can import the error type they need for their onError handler. CDN consumers already have it via window.ImmutableAudience.AudienceError from the CDN bundle work in #2853. Two new sdk.test.ts tests cover the wire-through end-to-end: a flush failure against a mocked backend, and a consent sync failure against a mocked backend. Both verify the AudienceError shape (name, code, status, endpoint) rather than just that the callback fires. Refs SDK-49 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
nattb8
approved these changes
Apr 15, 2026
ImmutableJeffrey
added a commit
that referenced
this pull request
Apr 15, 2026
The sample app and both READMEs were written against the nested ImmutableAudience.Audience.init(...) shape that the CDN bundle originally exposed. #2853 has since flattened the global to ImmutableAudience.init(...) and removed the Audience class from the CDN surface entirely — so the sample app's destructure (\`var Audience = window.ImmutableAudience.Audience\`) now resolves to undefined and every init call throws. - sample-app.js: destructure \`init\` directly into a local \`audienceInit\` var and update all six call sites. - sdk-sample-app/README.md: update the one remaining code snippet that showed Audience.init(...). - sdk/README.md: update the tagline, rewrite the CDN quickstart to destructure \`init\` instead of \`Audience\`, and rephrase the "symbols attached to the global" paragraph to match the new surface (the CDN no longer exposes the Audience class itself).
JCSanPedro
approved these changes
Apr 15, 2026
ImmutableJeffrey
added a commit
that referenced
this pull request
Apr 16, 2026
…core Exposes AudienceError to web SDK consumers. The core queue and consent manager already accept an onError callback and map TransportError to a public AudienceError via toAudienceError; this commit just forwards AudienceConfig.onError into both positional slots in the Audience constructor, which were previously hard-coded to undefined. Also re-exports AudienceError (runtime) and AudienceErrorCode (type) from the @imtbl/audience package index so ESM consumers can import the error type they need for their onError handler. CDN consumers already have it via window.ImmutableAudience.AudienceError from the CDN bundle work in #2853. Two new sdk.test.ts tests cover the wire-through end-to-end: a flush failure against a mocked backend, and a consent sync failure against a mocked backend. Both verify the AudienceError shape (name, code, status, endpoint) rather than just that the callback fires. Refs SDK-49 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a single-file IIFE build of
@imtbl/audienceatdist/cdn/imtbl-audience.global.jsso studios can embed via<script>and callImmutableAudience.Audience.init({...})— no bundler, nonpm installrequired.Linear: SDK-115.