Skip to content

feat: add timeline and event nodes #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: add timeline and event nodes #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
218b159
feat: add timeline and event nodes
umbobabo Sep 22, 2025
92150dd
Update TypeScript definition file
umbobabo Sep 26, 2025
c01e9aa
feat: support Imageset in Timeline and title for initial field instea…
umbobabo Oct 14, 2025
1d6046f
Update TypeScript definition file
umbobabo Oct 14, 2025
77fdb27
doc: JSDO doc approach
umbobabo Oct 14, 2025
4ed8a70
Remove heading and use title instead
umbobabo Oct 16, 2025
cbc49ba
Update TypeScript definition file
umbobabo Oct 16, 2025
3db9f64
Add title instead of heading
umbobabo Oct 16, 2025
bd88a84
Update TypeScript definition file
umbobabo Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 46 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ type BodyBlock =
| Video
| YoutubeVideo
| Text
| Timeline
```

`BodyBlock` nodes are the only things that are valid as the top level of a `Body`.
Expand Down Expand Up @@ -736,24 +737,24 @@ interface Table extends Parent {

```ts
type CustomCodeComponentAttributes = {
[key: string]: string | boolean | undefined
[key: string]: string | boolean | undefined
}

interface CustomCodeComponent extends Node {
/** Component type */
type: "custom-code-component"
/** Id taken from the CAPI url */
id: string
/** How the component should be presented in the article page according to the column layout system */
layoutWidth: LayoutWidth
/** Repository for the code of the component in the format "[github org]/[github repo]/[component name]". */
external path: string
/** Semantic version of the code of the component, e.g. "^0.3.5". */
external versionRange: string
/** Last date-time when the attributes for this block were modified, in ISO-8601 format. */
external attributesLastModified: string
/** Configuration data to be passed to the component. */
external attributes: CustomCodeComponentAttributes
/** Component type */
type: "custom-code-component"
/** Id taken from the CAPI url */
id: string
/** How the component should be presented in the article page according to the column layout system */
layoutWidth: LayoutWidth
/** Repository for the code of the component in the format "[github org]/[github repo]/[component name]". */
external path: string
/** Semantic version of the code of the component, e.g. "^0.3.5". */
external versionRange: string
/** Last date-time when the attributes for this block were modified, in ISO-8601 format. */
external attributesLastModified: string
/** Configuration data to be passed to the component. */
external attributes: CustomCodeComponentAttributes
}
```

Expand All @@ -762,6 +763,36 @@ interface CustomCodeComponent extends Node {
- The basic interface in Spark to make reference to this system above (eg. the git repo URL or a public S3 bucket), and provide some data for it if necessary. This will be the Custom Component storyblock.
- The data Spark receives from entering a specific ID will be used to render dynamic fields (the `attributes`).

### Timeline

```ts
/**
* Allowed layout widths for a Timeline.
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "full-grid">

/**
* Timeline nodes display a timeline of events in arbitrary order.
*/
interface Timeline extends Parent {
type: "timeline"
/** The title for the timeline */
title: string
/** The layout width for the timeline */
layoutWidth: TimelineLayoutWidth
children: TimelineEvent[]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below comment

Suggested change
children: TimelineEvent[]
/** Must contain at least one TimelineEvent */
children: [TimelineEvent, ...TimelineEvent[]];

}

/**
* TimelineEvent is the representation of a single event in a Timeline.
*/
interface TimelineEvent extends Parent {
type: "timeline-event"
/** The title of the event */
title: string
children: (Paragraph | ImageSet)[]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adgad @nadiasuleyman @todor-videv1 This would be more accurate. Same for L783

Suggested change
children: (Paragraph | ImageSet)[]
/** At least one Paragraph or one ImageSet should be provided **/
children: [Paragraph | ImageSet, ...(Paragraph | ImageSet)[]];

}
```

## License

Expand Down
104 changes: 100 additions & 4 deletions content-tree.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export declare namespace ContentTree {
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text | Timeline;
type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
interface Node {
Expand Down Expand Up @@ -278,8 +278,32 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes: CustomCodeComponentAttributes;
}
/**
* Allowed layout widths for a Timeline.
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "full-grid">;
/**
* Timeline nodes display a timeline of events in arbitrary order.
*/
interface Timeline extends Parent {
type: "timeline";
/** The title for the timeline */
title: string;
/** The layout width for the timeline */
layoutWidth: TimelineLayoutWidth;
children: TimelineEvent[];
}
/**
* TimelineEvent is the representation of a single event in a Timeline.
*/
interface TimelineEvent extends Parent {
type: "timeline-event";
/** The title of the event */
title: string;
children: (Paragraph | ImageSet)[];
}
namespace full {
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text | Timeline;
type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
interface Node {
Expand Down Expand Up @@ -558,9 +582,33 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes: CustomCodeComponentAttributes;
}
/**
* Allowed layout widths for a Timeline.
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "full-grid">;
/**
* Timeline nodes display a timeline of events in arbitrary order.
*/
interface Timeline extends Parent {
type: "timeline";
/** The title for the timeline */
title: string;
/** The layout width for the timeline */
layoutWidth: TimelineLayoutWidth;
children: TimelineEvent[];
}
/**
* TimelineEvent is the representation of a single event in a Timeline.
*/
interface TimelineEvent extends Parent {
type: "timeline-event";
/** The title of the event */
title: string;
children: (Paragraph | ImageSet)[];
}
}
namespace transit {
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text | Timeline;
type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
interface Node {
Expand Down Expand Up @@ -824,9 +872,33 @@ export declare namespace ContentTree {
/** How the component should be presented in the article page according to the column layout system */
layoutWidth: LayoutWidth;
}
/**
* Allowed layout widths for a Timeline.
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "full-grid">;
/**
* Timeline nodes display a timeline of events in arbitrary order.
*/
interface Timeline extends Parent {
type: "timeline";
/** The title for the timeline */
title: string;
/** The layout width for the timeline */
layoutWidth: TimelineLayoutWidth;
children: TimelineEvent[];
}
/**
* TimelineEvent is the representation of a single event in a Timeline.
*/
interface TimelineEvent extends Parent {
type: "timeline-event";
/** The title of the event */
title: string;
children: (Paragraph | ImageSet)[];
}
}
namespace loose {
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text | Timeline;
type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
interface Node {
Expand Down Expand Up @@ -1105,5 +1177,29 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes?: CustomCodeComponentAttributes;
}
/**
* Allowed layout widths for a Timeline.
*/
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "full-grid">;
/**
* Timeline nodes display a timeline of events in arbitrary order.
*/
interface Timeline extends Parent {
type: "timeline";
/** The title for the timeline */
title: string;
/** The layout width for the timeline */
layoutWidth: TimelineLayoutWidth;
children: TimelineEvent[];
}
/**
* TimelineEvent is the representation of a single event in a Timeline.
*/
interface TimelineEvent extends Parent {
type: "timeline-event";
/** The title of the event */
title: string;
children: (Paragraph | ImageSet)[];
}
}
}
77 changes: 77 additions & 0 deletions schemas/body-tree.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@
},
{
"$ref": "#/definitions/ContentTree.transit.Text"
},
{
"$ref": "#/definitions/ContentTree.transit.Timeline"
}
]
},
Expand Down Expand Up @@ -1089,6 +1092,80 @@
],
"type": "object"
},
"ContentTree.transit.Timeline": {
"additionalProperties": false,
"description": "Timeline nodes display a timeline of events in arbitrary order.",
"properties": {
"children": {
"items": {
"$ref": "#/definitions/ContentTree.transit.TimelineEvent"
},
"type": "array"
},
"data": {},
"layoutWidth": {
"$ref": "#/definitions/ContentTree.transit.TimelineLayoutWidth",
"description": "The layout width for the timeline"
},
"title": {
"description": "The title for the timeline",
"type": "string"
},
"type": {
"const": "timeline",
"type": "string"
}
},
"required": [
"children",
"layoutWidth",
"title",
"type"
],
"type": "object"
},
"ContentTree.transit.TimelineEvent": {
"additionalProperties": false,
"description": "TimelineEvent is the representation of a single event in a Timeline.",
"properties": {
"children": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/ContentTree.transit.Paragraph"
},
{
"$ref": "#/definitions/ContentTree.transit.ImageSet"
}
]
},
"type": "array"
},
"data": {},
"title": {
"description": "The title of the event",
"type": "string"
},
"type": {
"const": "timeline-event",
"type": "string"
}
},
"required": [
"children",
"title",
"type"
],
"type": "object"
},
"ContentTree.transit.TimelineLayoutWidth": {
"description": "Allowed layout widths for a Timeline.",
"enum": [
"full-grid",
"full-width"
],
"type": "string"
},
"ContentTree.transit.Tweet": {
"additionalProperties": false,
"properties": {
Expand Down
Loading