Add support for Ceros Flex embeds by DikshitaKhandke · Pull Request #1934 · CondeNast/atjson

DikshitaKhandke · 2026-04-21T04:30:25Z

Ticket : https://cnissues.atlassian.net/browse/ATC-6999

DikshitaKhandke

@copilot-robot prerelease

fennen529 · 2026-04-21T17:58:54Z

@copilot-robot prerelease

copilot-robot · 2026-04-21T18:00:00Z

Hi, @fennen529, there are no changed packages to publish.

colin-alexa · 2026-04-21T18:51:13Z

+  return (
+    a.type === "script" &&
+    typeof a.attributes.src === "string" &&
+    /(?:^|\/)embed_v\d+\.js(?:[?#].*)?$/i.test(a.attributes.src)


this test doesn't seem specific enough, especially for the open-source atjson package that might be used in any arbitrary context. It should at least have the hostname in the test

Good call. I tightened the Flex detection so it now checks the documented Ceros host and path (assets.ceros.site/js/embed.v*.js) instead of matching any similar filename. I also updated the fixture to use the documented script URL and added a negative test to confirm a non-Ceros host with a similar script name does not get parsed as Flex.

colin-alexa · 2026-04-21T18:55:26Z

   */
  url: string;

+  /**


I think this should be a union type, like

class CerosEmbed extends BlockAnnotation< {cerosType?: "studio"; url: string; aspectRatio: number} | {cerosType: "flex"; url: string; experienceUrl: string; scriptUrl: string; width: string; height: string} >

Agreed. I moved CerosEmbed to a discriminated union so Studio and Flex now have distinct shapes instead of one wide object with loosely related optional fields. I kept url as the canonical experience URL for both variants and dropped experienceUrl, since it was redundant with the renderer logic.

tim-evans

I have some questions and would like some further information on valid values! Thanks 😄

tim-evans · 2026-04-21T18:53:46Z

+  /**
+   * The script URL required to bootstrap a Flex embed.
+   */
+  scriptUrl?: string;


The script URL was previously provided by upstream clients to ensure that the creative URL and the script could be assigned separately. Is there a reason for these to be bundled together?

I separated the concerns more clearly. url is now the canonical experience URL, and scriptUrl remains a separate Flex-specific field, so they are no longer bundled conceptually in the model.

tim-evans · 2026-04-21T18:54:20Z

+  /**
+   * The URL to the Flex experience when represented separately
+   * from the canonical `url` field.
+   */
+  experienceUrl?: string;


Seeing experienceUrl || url in code below indicates that this field is perhaps redundant

Agreed. I removed experienceUrl and standardized on url as the single canonical Ceros experience URL. The renderer no longer falls back between the two.

tim-evans · 2026-04-21T18:54:41Z

+        "data-embed-width": embed.attributes.width,
+        "data-embed-height": embed.attributes.height,


Could you provide some documentation on valid values for width and height?

In our upstream systems width and height cannot be auto.

Yes, I added documentation for those fields in the annotation type. Based on the Ceros Flex docs, width is typically a percentage like 100%, and height is either auto for full-height embeds or a fixed pixel value like 800px for scrolling embeds.

tim-evans · 2026-04-22T16:43:16Z

From the Ceros documentation:

There are different scripts used for each:

Flex	Studio
`https://assets.ceros.site/js/embed.v1.js`	`https://view.ceros.com/scroll-proxy.min.js`

There are notes about adding title for accessibility in flex as well. This should be added to support EAA and ADA compliance that we need to have.

Aspect ratios could still be used as a storage mechanism for this annotation, alongside a boolean that controls whether the embed full screen or scrolling, per the documentation 😄

DikshitaKhandke · 2026-04-23T13:29:54Z

From the Ceros documentation:

https://educate.ceros.com/en/articles/12149807-how-to-embed-a-published-studio-experience

https://educate.ceros.com/en/articles/12785205-how-to-embed-a-published-flex-experience

There are different scripts used for each:

Flex Studio
https://assets.ceros.site/js/embed.v1.js https://view.ceros.com/scroll-proxy.min.js
There are notes about adding title for accessibility in flex as well. This should be added to support EAA and ADA compliance that we need to have.

Aspect ratios could still be used as a storage mechanism for this annotation, alongside a boolean that controls whether the embed full screen or scrolling, per the documentation 😄

Agreed on the script distinction and the accessibility point. I updated the implementation to use the documented Studio/Flex script URLs and to preserve Flex data-title for accessibility.

For the model itself, I kept this change closer to the documented embed shape by storing the explicit Flex fields rather than normalizing into aspect ratio + fullscreen/scrolling. That normalization could still be a good follow-up, but I kept this pass focused on correctness and round-tripping the documented embed format.

tim-evans · 2026-04-23T14:04:28Z

   */
-  anchorName?: string;
-}> {
+  scriptUrl?: string;


Please remove the script url from the annotation. This should be managed upstream by any client using this to ensure that they don't include the script twice on one page, for example.

removed this

tim-evans · 2026-04-23T14:12:11Z

+   * either `auto` for a full-height embed or a fixed pixel value
+   * such as `800px` for a scrolling embed.
+   */
+  height?: string;


auto I'm fairly sure will not be compatible with our upstream parsers.

Either verify that this works upstream as a valid value for a width or make this an enum that specifies behavior (a suggestion is full-height | scrolling)

Updated this as per slack comments

DikshitaKhandke

Hey @tim-evans Can you please review this PR as well.

tim-evans

One requested change to the types

tim-evans · 2026-04-28T15:04:29Z

 import { BlockAnnotation } from "@atjson/document";

-export class CerosEmbed extends BlockAnnotation<{
+type SharedCerosEmbedAttributes = {


Please inline these as it makes types opaque to any clients using this package

Updated this

DikshitaKhandke

@copilot-robot prerelease

tim-evans

Thanks for adapting to our rounds of reviews 😄

a-rena · 2026-06-08T06:16:34Z

@copilot-robot prerelease

copilot-robot · 2026-06-08T06:17:40Z

Hi, @a-rena, there are no changed packages to publish.

feat(ceros): atc-7328 ceros flex support

8431dfb

DikshitaKhandke assigned DikshitaKhandke and unassigned DikshitaKhandke Apr 21, 2026

DikshitaKhandke added the 🥚 Pre-Release label Apr 21, 2026

DikshitaKhandke commented Apr 21, 2026

View reviewed changes

colin-alexa reviewed Apr 21, 2026

View reviewed changes

Comment thread packages/@atjson/offset-annotations/src/annotations/ceros-embed.ts Outdated

colin-alexa reviewed Apr 21, 2026

View reviewed changes

tim-evans requested changes Apr 21, 2026

View reviewed changes

tim-evans changed the title ~~feat(ceros): atc-7328 ceros flex support~~ Add support for Ceros Flex embeds Apr 22, 2026

feat(ceros): atc-7328 updated review comments

9a37a5f

DikshitaKhandke requested review from colin-alexa and tim-evans April 23, 2026 13:34

feat(ceros): atc-7328 updated test fixture

7a6a7a4

tim-evans reviewed Apr 23, 2026

View reviewed changes

feat(ceros): atc-7328 updated review comments from tim

fe6dafb

DikshitaKhandke requested a review from tim-evans April 24, 2026 12:18

DikshitaKhandke commented Apr 30, 2026

View reviewed changes

tim-evans removed the 🥚 Pre-Release label May 4, 2026

tim-evans requested changes May 5, 2026

View reviewed changes

feat(ceros-flex): atc-7328 updated typecheck issue

961e894

DikshitaKhandke requested a review from tim-evans May 12, 2026 07:01

DikshitaKhandke commented May 12, 2026

View reviewed changes

tim-evans approved these changes May 13, 2026

View reviewed changes

DikshitaKhandke added 2 commits June 10, 2026 12:50

Merge remote-tracking branch 'origin' into ATC-7328

cbb9e58

Merge remote-tracking branch 'origin' into ATC-7328

599deff

		"data-embed-width": embed.attributes.width,
		"data-embed-height": embed.attributes.height,

Conversation

DikshitaKhandke commented Apr 21, 2026

Uh oh!

DikshitaKhandke left a comment

Choose a reason for hiding this comment

Uh oh!

fennen529 commented Apr 21, 2026

Uh oh!

copilot-robot commented Apr 21, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tim-evans left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tim-evans commented Apr 22, 2026

Uh oh!

DikshitaKhandke commented Apr 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DikshitaKhandke left a comment

Choose a reason for hiding this comment

Uh oh!

tim-evans left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DikshitaKhandke left a comment

Choose a reason for hiding this comment

Uh oh!

tim-evans left a comment

Choose a reason for hiding this comment

Uh oh!

a-rena commented Jun 8, 2026

Uh oh!

copilot-robot commented Jun 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants