- layout(first, second, third?): LayoutBlock
Parameters
- first: {
children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: (...) | (...) | (...);
code?: (...) | (...) | (...);
italic?: (...) | (...) | (...);
link?: (...) | (...);
strike?: (...) | (...) | (...);
sub?: (...) | (...) | (...);
sup?: (...) | (...) | (...);
text: string;
underline?: (...) | (...) | (...);
} | {
mention: {
documentId?: ...;
name?: ...;
resourceId: ...;
text?: ...;
};
} | {
break: true;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...)[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[];
id?: string;
kind: "layoutColumn";
width?: number;
}children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: (...) | (...) | (...);
code?: (...) | (...) | (...);
italic?: (...) | (...) | (...);
link?: (...) | (...);
strike?: (...) | (...) | (...);
sub?: (...) | (...) | (...);
sup?: (...) | (...) | (...);
text: string;
underline?: (...) | (...) | (...);
} | {
mention: {
documentId?: ...;
name?: ...;
resourceId: ...;
text?: ...;
};
} | {
break: true;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...)[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[]
Optionalid?: string
kind: "layoutColumn"
Optionalwidth?: number
- second: {
children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: (...) | (...) | (...);
code?: (...) | (...) | (...);
italic?: (...) | (...) | (...);
link?: (...) | (...);
strike?: (...) | (...) | (...);
sub?: (...) | (...) | (...);
sup?: (...) | (...) | (...);
text: string;
underline?: (...) | (...) | (...);
} | {
mention: {
documentId?: ...;
name?: ...;
resourceId: ...;
text?: ...;
};
} | {
break: true;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...)[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[];
id?: string;
kind: "layoutColumn";
width?: number;
}children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: (...) | (...) | (...);
code?: (...) | (...) | (...);
italic?: (...) | (...) | (...);
link?: (...) | (...);
strike?: (...) | (...) | (...);
sub?: (...) | (...) | (...);
sup?: (...) | (...) | (...);
text: string;
underline?: (...) | (...) | (...);
} | {
mention: {
documentId?: ...;
name?: ...;
resourceId: ...;
text?: ...;
};
} | {
break: true;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...)[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "id";
id: string;
ids: ((...) | (...))[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: ...]: ...;
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (...)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[]
Optionalid?: string
kind: "layoutColumn"
Optionalwidth?: number
Optionalthird: {
children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: ...;
code?: ...;
italic?: ...;
link?: ...;
strike?: ...;
sub?: ...;
sup?: ...;
text: ...;
underline?: ...;
} | {
mention: ...;
} | {
break: ...;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...) | (...);
id?: (...) | (...);
key: string;
rank?: (...) | (...);
text?: (...) | (...);
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: (...) | (...);
current: number;
icon: string;
id?: (...) | (...);
max: number;
name: string;
ratingIcon?: (...) | (...);
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "id";
id: string;
ids: (...)[];
operator: (...) | (...);
scope?: (...) | (...);
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
tags: (...)[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: (...) | (...);
predicate: string;
scope?: (...) | (...);
type: "filter";
}
| {
end?: (...) | (...);
field: string;
filterType: "date_range";
id: string;
scope?: (...) | (...);
start?: (...) | (...);
type: "filter";
}
| {
field?:
| (...)
| (...)
| (...)
| (...)
| (...);
filterType: "property";
id: string;
key?: (...) | (...);
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "mention";
id: string;
key?: (...) | (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: (...) | (...);
type: "filter";
value: string;
}
| {
filters: (...)[];
filterType: "composite";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: ...;
id?: ...;
rank?: ...;
resourceId: ...;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [(...), (...)];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "id";
id: string;
ids: (...)[];
operator: (...) | (...);
scope?: (...) | (...);
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
tags: (...)[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: (...) | (...);
predicate: string;
scope?: (...) | (...);
type: "filter";
}
| {
end?: (...) | (...);
field: string;
filterType: "date_range";
id: string;
scope?: (...) | (...);
start?: (...) | (...);
type: "filter";
}
| {
field?:
| (...)
| (...)
| (...)
| (...)
| (...);
filterType: "property";
id: string;
key?: (...) | (...);
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "mention";
id: string;
key?: (...) | (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: (...) | (...);
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[];
id?: string;
kind: "layoutColumn";
width?: number;
}children: (
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "paragraph";
}
| {
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "heading";
level: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "quote";
}
| {
id?: string;
kind: "code";
language?: string;
text: string;
}
| {
id?: string;
kind: "rule";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "bulletList";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "orderedList";
start?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "listItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "taskList";
}
| {
checked: boolean;
content: ({
bold?: boolean;
code?: boolean;
italic?: boolean;
link?: string;
strike?: boolean;
sub?: boolean;
sup?: boolean;
text: string;
underline?: boolean;
} | {
mention: {
documentId?: string;
name?: string;
resourceId: string;
text?: string;
};
} | {
break: true;
})[];
id?: string;
kind: "taskItem";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "table";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "tableRow";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
colspan?: number;
header?: boolean;
id?: string;
kind: "tableCell";
rowspan?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
color?: string;
icon?: string;
id?: string;
kind: "callout";
tone:
| "info"
| "note"
| "success"
| "warning"
| "error"
| "custom";
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "expand";
title: string;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "layout";
}
| ({ id?: string | undefined; kind: "layoutColumn"; width?: number | undefined; children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; ... 6 more ...; sup?: boolean | undefined; } | { ...; } | { ...; })[]; } | ... 26 more ... | { ...; })[]; })
| {
alt?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "image";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
url: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
kind: "embed";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
provider: "youtube" | "spotify" | "soundcloud";
title?: string;
url: string;
width?: number;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isTitleHidden?: boolean;
kind: "keyValue";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: {
content?: ({
bold?: ...;
code?: ...;
italic?: ...;
link?: ...;
strike?: ...;
sub?: ...;
sup?: ...;
text: ...;
underline?: ...;
} | {
mention: ...;
} | {
break: ...;
})[];
id?: string;
key: string;
rank?: string;
text?: string;
}[];
title?: string;
width?: number;
}
| {
id?: string;
kind: "infobox";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
rows: (
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "textField";
rank?: string;
title?: string;
}
| {
display?: "list" | "grid" | "inline";
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "keyValue";
rank?: string;
rows: {
content?: (...) | (...);
id?: (...) | (...);
key: string;
rank?: (...) | (...);
text?: (...) | (...);
}[];
title?: string;
}
| {
alt?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "image";
rank?: string;
title?: string;
url: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
color?: (...) | (...);
current: number;
icon: string;
id?: (...) | (...);
max: number;
name: string;
ratingIcon?: (...) | (...);
}[];
kind: "meter";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
rank?: string;
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "id";
id: string;
ids: (...)[];
operator: (...) | (...);
scope?: (...) | (...);
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
tags: (...)[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: (...) | (...);
predicate: string;
scope?: (...) | (...);
type: "filter";
}
| {
end?: (...) | (...);
field: string;
filterType: "date_range";
id: string;
scope?: (...) | (...);
start?: (...) | (...);
type: "filter";
}
| {
field?:
| (...)
| (...)
| (...)
| (...)
| (...);
filterType: "property";
id: string;
key?: (...) | (...);
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "mention";
id: string;
key?: (...) | (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: (...) | (...);
type: "filter";
value: string;
}
| {
filters: (...)[];
filterType: "composite";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
type: "filter";
};
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items?: {
documentId?: ...;
id?: ...;
rank?: ...;
resourceId: ...;
}[];
kind: "resourceCollection";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
items: {
documentId?: (...) | (...);
id?: (...) | (...);
rank?: (...) | (...);
resourceId: string;
}[];
kind: "resourceLink";
rank?: string;
title?: string;
}
| {
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "embed";
provider: "youtube" | "spotify" | "soundcloud";
rank?: string;
title?: string;
url: string;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "map";
rank?: string;
resourceId?: string;
title?: string;
viewport?: {
center: [(...), (...)];
zoom: number;
};
}
| {
id: string;
isHidden?: boolean;
isTitleHidden?: boolean;
kind: "unsupported";
rank?: string;
title?: string;
})[];
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
color?: string;
current: number;
icon: string;
id?: string;
max: number;
name: string;
ratingIcon?: string;
}[];
kind: "meter";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
mode:
| "bar"
| "wheel"
| "gauge-180"
| "gauge-270"
| "pool"
| "rating";
showIcon?: boolean;
showMax?: boolean;
showText?: boolean;
title?: string;
width?: number;
}
| {
filter?:
| {
field: string;
filterType: "field";
id: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "id";
id: string;
ids: (string | number)[];
operator: "in" | "not_in";
scope?: string;
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: "has_all" | "has_any" | "has_none";
scope?: string;
tags: string[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: {
[key: string]:
| string
| number
| boolean
| null
| (...)[];
};
predicate: string;
scope?: string;
type: "filter";
}
| {
end?: number;
field: string;
filterType: "date_range";
id: string;
scope?: string;
start?: number;
type: "filter";
}
| {
field?:
| "textValue"
| "numValue"
| "meterCurrent"
| "meterMax";
filterType: "property";
id: string;
key?: string;
operator:
| "equals"
| "not_equals"
| "greater_than"
| "greater_than_or_equal"
| "less_than"
| "less_than_or_equal"
| "contains"
| "starts_with"
| "ends_with"
| "regex"
| "in"
| "not_in";
propertyType?: string;
scope?: string;
type: "filter";
value?:
| null
| string
| number
| boolean
| (
| null
| string
| number
| boolean)[];
}
| {
filterType: "mention";
id: string;
key?: string;
propertyType?: string;
scope?: string;
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: string;
type: "filter";
value: string;
}
| {
filters: (
| {
field: string;
filterType: "field";
id: string;
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "id";
id: string;
ids: (...)[];
operator: (...) | (...);
scope?: (...) | (...);
type: "filter";
}
| {
filterType: "tag";
id: string;
operator: (...) | (...) | (...);
scope?: (...) | (...);
tags: (...)[];
type: "filter";
}
| {
filterType: "custom";
id: string;
params?: (...) | (...);
predicate: string;
scope?: (...) | (...);
type: "filter";
}
| {
end?: (...) | (...);
field: string;
filterType: "date_range";
id: string;
scope?: (...) | (...);
start?: (...) | (...);
type: "filter";
}
| {
field?:
| (...)
| (...)
| (...)
| (...)
| (...);
filterType: "property";
id: string;
key?: (...) | (...);
operator:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
type: "filter";
value?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}
| {
filterType: "mention";
id: string;
key?: (...) | (...);
propertyType?: (...) | (...);
scope?: (...) | (...);
targetId: string;
type: "filter";
}
| {
filterType: "text";
id: string;
operator: "contains";
scope?: (...) | (...);
type: "filter";
value: string;
}
| ({ type: "filter"; id: string; scope?: string | undefined; filterType: "composite"; operator: "and" | "or" | "not"; filters: ({ type: "filter"; id: string; scope?: string | undefined; filterType: "field"; field: string; operator: "equals" | ... 10 more ... | "not_in"; value?: string | ... 4 more ... | undefined; } | ...))[];
filterType: "composite";
id: string;
operator: "and" | "or" | "not";
scope?: string;
type: "filter";
};
id?: string;
isTitleHidden?: boolean;
items?: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceCollection";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id?: string;
isTitleHidden?: boolean;
items: {
documentId?: string;
id?: string;
rank?: string;
resourceId: string;
}[];
kind: "resourceLink";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
displayHeight?: number;
documentId?: string;
fill?: boolean;
id?: string;
isTitleHidden?: boolean;
kind: "map";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
resourceId?: string;
title?: string;
viewport?: {
center: [number, number];
zoom: number;
};
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
kind: "secret";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
width?: number;
}
| {
children: ({ id?: string | undefined; kind: "paragraph"; content: ({ text: string; bold?: boolean | undefined; italic?: boolean | undefined; underline?: boolean | undefined; strike?: boolean | undefined; code?: boolean | undefined; link?: string | undefined; sub?: boolean | undefined; sup?: boolean | undefined; } | { ...; } |...;
id?: string;
isTitleHidden?: boolean;
kind: "textField";
layout?:
| "default"
| "wrapLeft"
| "wrapRight"
| "center"
| "alignStart"
| "alignEnd";
title?: string;
width?: number;
}
| {
id: string;
kind: "unsupported";
})[]
Optionalid?: string
kind: "layoutColumn"
Optionalwidth?: number
A row of two or three columns. The schema holds no fewer and no more.