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 2 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
2 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
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
56 changes: 41 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,31 @@ 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
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">

interface Timeline extends Parent {
type: "timeline"
layoutWidth: TimelineLayoutWidth
children: [Heading, ...TimelineEvent[]]
}
```

**Timeline** nodes display a timeline of events in arbitrary order.

### TimelineEvent

```ts
interface TimelineEvent extends Parent {
type: "timeline-event"
dateLabel: string
children: Paragraph[]
}
```

**TimelineEvent** nodes represents a single event in a timeline.

## License

Expand Down
52 changes: 48 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,19 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes: CustomCodeComponentAttributes;
}
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">;
interface Timeline extends Parent {
type: "timeline";
layoutWidth: TimelineLayoutWidth;
children: [Heading, ...TimelineEvent[]];
}
interface TimelineEvent extends Parent {
type: "timeline-event";
dateLabel: string;
children: Paragraph[];
}
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 +569,20 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes: CustomCodeComponentAttributes;
}
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">;
interface Timeline extends Parent {
type: "timeline";
layoutWidth: TimelineLayoutWidth;
children: [Heading, ...TimelineEvent[]];
}
interface TimelineEvent extends Parent {
type: "timeline-event";
dateLabel: string;
children: Paragraph[];
}
}
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 +846,20 @@ export declare namespace ContentTree {
/** How the component should be presented in the article page according to the column layout system */
layoutWidth: LayoutWidth;
}
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">;
interface Timeline extends Parent {
type: "timeline";
layoutWidth: TimelineLayoutWidth;
children: [Heading, ...TimelineEvent[]];
}
interface TimelineEvent extends Parent {
type: "timeline-event";
dateLabel: string;
children: Paragraph[];
}
}
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 +1138,16 @@ export declare namespace ContentTree {
/** Configuration data to be passed to the component. */
attributes?: CustomCodeComponentAttributes;
}
type TimelineLayoutWidth = Extract<LayoutWidth, "full-width" | "inset-left" | "full-grid">;
interface Timeline extends Parent {
type: "timeline";
layoutWidth: TimelineLayoutWidth;
children: [Heading, ...TimelineEvent[]];
}
interface TimelineEvent extends Parent {
type: "timeline-event";
dateLabel: string;
children: Paragraph[];
}
}
}
67 changes: 67 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,70 @@
],
"type": "object"
},
"ContentTree.transit.Timeline": {
"additionalProperties": false,
"properties": {
"children": {
"additionalItems": {
"$ref": "#/definitions/ContentTree.transit.TimelineEvent"
},
"items": [
{
"$ref": "#/definitions/ContentTree.transit.Heading"
}
],
"minItems": 1,
"type": "array"
},
"data": {},
"layoutWidth": {
"$ref": "#/definitions/ContentTree.transit.TimelineLayoutWidth"
},
"type": {
"const": "timeline",
"type": "string"
}
},
"required": [
"children",
"layoutWidth",
"type"
],
"type": "object"
},
"ContentTree.transit.TimelineEvent": {
"additionalProperties": false,
"properties": {
"children": {
"items": {
"$ref": "#/definitions/ContentTree.transit.Paragraph"
},
"type": "array"
},
"data": {},
"dateLabel": {
"type": "string"
},
"type": {
"const": "timeline-event",
"type": "string"
}
},
"required": [
"children",
"dateLabel",
"type"
],
"type": "object"
},
"ContentTree.transit.TimelineLayoutWidth": {
"enum": [
"full-grid",
"full-width",
"inset-left"
],
"type": "string"
},
"ContentTree.transit.Tweet": {
"additionalProperties": false,
"properties": {
Expand Down
67 changes: 67 additions & 0 deletions schemas/content-tree.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,9 @@
},
{
"$ref": "#/definitions/ContentTree.full.Text"
},
{
"$ref": "#/definitions/ContentTree.full.Timeline"
}
]
},
Expand Down Expand Up @@ -1867,6 +1870,70 @@
],
"type": "object"
},
"ContentTree.full.Timeline": {
"additionalProperties": false,
"properties": {
"children": {
"additionalItems": {
"$ref": "#/definitions/ContentTree.full.TimelineEvent"
},
"items": [
{
"$ref": "#/definitions/ContentTree.full.Heading"
}
],
"minItems": 1,
"type": "array"
},
"data": {},
"layoutWidth": {
"$ref": "#/definitions/ContentTree.full.TimelineLayoutWidth"
},
"type": {
"const": "timeline",
"type": "string"
}
},
"required": [
"children",
"layoutWidth",
"type"
],
"type": "object"
},
"ContentTree.full.TimelineEvent": {
"additionalProperties": false,
"properties": {
"children": {
"items": {
"$ref": "#/definitions/ContentTree.full.Paragraph"
},
"type": "array"
},
"data": {},
"dateLabel": {
"type": "string"
},
"type": {
"const": "timeline-event",
"type": "string"
}
},
"required": [
"children",
"dateLabel",
"type"
],
"type": "object"
},
"ContentTree.full.TimelineLayoutWidth": {
"enum": [
"full-grid",
"full-width",
"inset-left"
],
"type": "string"
},
"ContentTree.full.Tweet": {
"additionalProperties": false,
"properties": {
Expand Down
Loading