@activecollab/components 2.0.415 → 2.0.417
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/components/PortableText/Styles.js +20 -2
- package/dist/cjs/components/PortableText/Styles.js.map +1 -1
- package/dist/cjs/components/PortableText/renderers.js +15 -6
- package/dist/cjs/components/PortableText/renderers.js.map +1 -1
- package/dist/cjs/components/PortableText/types.js +22 -2
- package/dist/cjs/components/PortableText/types.js.map +1 -1
- package/dist/cjs/components/PortableText/types.test.js +138 -0
- package/dist/cjs/components/PortableText/types.test.js.map +1 -1
- package/dist/cjs/components/TitledText/TitledText.js +5 -1
- package/dist/cjs/components/TitledText/TitledText.js.map +1 -1
- package/dist/cjs/presentation/shared/FeatureAvailability.js +217 -0
- package/dist/cjs/presentation/shared/FeatureAvailability.js.map +1 -0
- package/dist/cjs/presentation/shared/index.js +16 -1
- package/dist/cjs/presentation/shared/index.js.map +1 -1
- package/dist/esm/components/PortableText/Styles.d.ts +19 -1
- package/dist/esm/components/PortableText/Styles.d.ts.map +1 -1
- package/dist/esm/components/PortableText/Styles.js +20 -2
- package/dist/esm/components/PortableText/Styles.js.map +1 -1
- package/dist/esm/components/PortableText/renderers.d.ts.map +1 -1
- package/dist/esm/components/PortableText/renderers.js +15 -6
- package/dist/esm/components/PortableText/renderers.js.map +1 -1
- package/dist/esm/components/PortableText/types.d.ts +12 -1
- package/dist/esm/components/PortableText/types.d.ts.map +1 -1
- package/dist/esm/components/PortableText/types.js +18 -2
- package/dist/esm/components/PortableText/types.js.map +1 -1
- package/dist/esm/components/PortableText/types.test.js +138 -0
- package/dist/esm/components/PortableText/types.test.js.map +1 -1
- package/dist/esm/components/TitledText/TitledText.d.ts +7 -3
- package/dist/esm/components/TitledText/TitledText.d.ts.map +1 -1
- package/dist/esm/components/TitledText/TitledText.js +5 -1
- package/dist/esm/components/TitledText/TitledText.js.map +1 -1
- package/dist/esm/presentation/shared/FeatureAvailability.d.ts +52 -0
- package/dist/esm/presentation/shared/FeatureAvailability.d.ts.map +1 -0
- package/dist/esm/presentation/shared/FeatureAvailability.js +203 -0
- package/dist/esm/presentation/shared/FeatureAvailability.js.map +1 -0
- package/dist/esm/presentation/shared/index.d.ts +2 -0
- package/dist/esm/presentation/shared/index.d.ts.map +1 -1
- package/dist/esm/presentation/shared/index.js +1 -0
- package/dist/esm/presentation/shared/index.js.map +1 -1
- package/dist/index.js +62 -11
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -27,6 +27,12 @@ export const PORTABLE_TEXT_DEFAULT_MARKS = ["strong", "em", "code", "link"];
|
|
|
27
27
|
|
|
28
28
|
/** 1 maps to Title1, 2 to Title2, 3 to Header2 typography. */
|
|
29
29
|
|
|
30
|
+
/**
|
|
31
|
+
* A list item's children are its own spans first, then any nested `list`
|
|
32
|
+
* block(s) — the shape that carries multi-level lists. A spans-only item (no
|
|
33
|
+
* nested list) is the common, flat case and stays valid unchanged.
|
|
34
|
+
*/
|
|
35
|
+
|
|
30
36
|
/** Screenshots render framed (border, no shadow); illustrations render flat. */
|
|
31
37
|
|
|
32
38
|
/**
|
|
@@ -112,11 +118,21 @@ export const isPortableTextBlock = value => {
|
|
|
112
118
|
}
|
|
113
119
|
switch (value.type) {
|
|
114
120
|
case "paragraph":
|
|
121
|
+
return Array.isArray(value.children) && value.children.every(isPortableTextSpan);
|
|
115
122
|
case "heading":
|
|
123
|
+
return (value.id === undefined || typeof value.id === "string") && Array.isArray(value.children) && value.children.every(isPortableTextSpan);
|
|
116
124
|
case "list-item":
|
|
117
|
-
|
|
125
|
+
// The item's spans, plus optional nested `list` block(s). Widened only
|
|
126
|
+
// for nested lists: any other block child (a stray paragraph, an object)
|
|
127
|
+
// still fails, so a serializer bug is caught here, not at render.
|
|
128
|
+
return Array.isArray(value.children) && value.children.every(child => isPortableTextSpan(child) || isPortableTextBlock(child) && child.type === "list");
|
|
118
129
|
case "list":
|
|
119
|
-
|
|
130
|
+
// A list holds `list-item`s only. A sublist emitted as a sibling of the
|
|
131
|
+
// items (the classic half-implemented-nesting bug) renders invalid HTML
|
|
132
|
+
// — <ul> with a direct <ul> child — so it fails here, not at render.
|
|
133
|
+
// `list-item` is validated but sits outside the PortableTextBlock union,
|
|
134
|
+
// so the discriminator is checked before isPortableTextBlock narrows it.
|
|
135
|
+
return Array.isArray(value.children) && value.children.every(child => isRecord(child) && child.type === "list-item" && isPortableTextBlock(child));
|
|
120
136
|
case "media":
|
|
121
137
|
return typeof value.src === "string";
|
|
122
138
|
case "titled-text":
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","names":["PORTABLE_TEXT_DEFAULT_MARKS","MEDIA_IMAGE_VARIANTS","screenshot","illustration","isPortableTextMediaImageVariant","value","DEFAULT_BLOCK_TYPES","paragraph","heading","list","media","table","divider","PORTABLE_TEXT_DEFAULT_BLOCKS","Object","keys","isRecord","isPortableTextSpan","text","isPortableTextTableRow","Array","isArray","every","cell","isPortableTextObjectNode","type","_type","isPortableTextBlock","children","src","title","content","undefined","isPortableTextContent","code","language","header","rows","node"],"sources":["../../../../src/components/PortableText/types.ts"],"sourcesContent":["import { ComponentType, ReactNode } from \"react\";\n\n/**\n * Portable Text envelope — the general content contract for structured,\n * renderer-independent content (in-app messages, help, changelogs).\n *\n * The design system owns this envelope and the universal default set below.\n * It never hardcodes a product element: concrete elements (callout,\n * button-reference, doc-link, …) are defined in the application catalog and\n * injected into the Portable Text engine through {@link PortableTextComponents}.\n * See README.md next to this file for the full contract.\n */\n\n/* ---- Spans and marks ------------------------------------------------- */\n\n/**\n * A mark with data. Parameterless marks travel as plain strings (\"strong\");\n * marks that need data travel as objects discriminated by `type`.\n */\nexport interface PortableTextMarkObject {\n type: string;\n [data: string]: unknown;\n}\n\n/** The one default mark that carries data. */\nexport interface PortableTextLinkMark extends PortableTextMarkObject {\n type: \"link\";\n href: string;\n}\n\nexport type PortableTextMark = string | PortableTextMarkObject;\n\n/** The leaf of every text run: a piece of text plus the marks wrapping it. */\nexport interface PortableTextSpan {\n text: string;\n marks?: PortableTextMark[];\n}\n\n/** Marks every client understands without injection. */\nexport const PORTABLE_TEXT_DEFAULT_MARKS = [\n \"strong\",\n \"em\",\n \"code\",\n \"link\",\n] as const;\n\nexport type PortableTextDefaultMark =\n (typeof PORTABLE_TEXT_DEFAULT_MARKS)[number];\n\n/* ---- Blocks ----------------------------------------------------------- */\n\nexport interface PortableTextParagraphBlock {\n type: \"paragraph\";\n children: PortableTextSpan[];\n}\n\n/** 1 maps to Title1, 2 to Title2, 3 to Header2 typography. */\nexport type PortableTextHeadingLevel = 1 | 2 | 3;\n\nexport interface PortableTextHeadingBlock {\n type: \"heading\";\n level: PortableTextHeadingLevel;\n children: PortableTextSpan[];\n}\n\nexport type PortableTextListStyle = \"bullet\" | \"number\";\n\nexport interface PortableTextListItemBlock {\n type: \"list-item\";\n children: PortableTextSpan[];\n}\n\nexport interface PortableTextListBlock {\n type: \"list\";\n style?: PortableTextListStyle;\n children: PortableTextListItemBlock[];\n}\n\n/** Screenshots render framed (border, no shadow); illustrations render flat. */\nexport type PortableTextMediaImageVariant = \"screenshot\" | \"illustration\";\n\n/**\n * Video variants name the hosting service; `src` is the canonical video URL.\n * Their rendering carries service semantics (URL parsing, embed derivation),\n * so it belongs to the application catalog — injected as a `media` block\n * override — never to the default set. The default renderer degrades them.\n */\nexport type PortableTextMediaVideoVariant = \"vimeo\" | \"youtube\";\n\nexport type PortableTextMediaVariant =\n | PortableTextMediaImageVariant\n | PortableTextMediaVideoVariant;\n\n// A Record so the compiler checks the list against the union in both\n// directions: a missing and a stray key each fail to build.\nconst MEDIA_IMAGE_VARIANTS: Record<PortableTextMediaImageVariant, true> = {\n screenshot: true,\n illustration: true,\n};\n\nexport const isPortableTextMediaImageVariant = (\n value: unknown\n): value is PortableTextMediaImageVariant =>\n typeof value === \"string\" && value in MEDIA_IMAGE_VARIANTS;\n\nexport interface PortableTextMediaBlock {\n type: \"media\";\n src: string;\n alt?: string;\n variant?: PortableTextMediaVariant;\n caption?: string;\n}\n\nexport interface PortableTextTitledTextBlock {\n type: \"titled-text\";\n /**\n * Same semantic scale as `heading` — 1, 2 or 3 (the default) — so the wire\n * format never encodes a typography name. How a level looks is the\n * renderer's business.\n */\n level?: PortableTextHeadingLevel;\n title: string;\n content?: PortableTextNode[];\n}\n\nexport interface PortableTextCodeBlock {\n type: \"code-block\";\n /**\n * A language hint (e.g. \"php\", \"json\"). The default renderer does no\n * highlighting, so any value — known, unknown or absent — renders as plain\n * preformatted text; it travels as data for surfaces that highlight.\n */\n language?: string;\n code: string;\n}\n\n/** A table cell is a span array, so inline marks work inside cells. */\nexport type PortableTextTableCell = PortableTextSpan[];\nexport type PortableTextTableRow = PortableTextTableCell[];\n\nexport interface PortableTextTableBlock {\n type: \"table\";\n header: PortableTextTableRow;\n rows: PortableTextTableRow[];\n}\n\n/** A themed horizontal rule between sections. Carries no data. */\nexport interface PortableTextDividerBlock {\n type: \"divider\";\n}\n\nexport type PortableTextBlock =\n | PortableTextParagraphBlock\n | PortableTextHeadingBlock\n | PortableTextListBlock\n | PortableTextMediaBlock\n | PortableTextTitledTextBlock\n | PortableTextCodeBlock\n | PortableTextTableBlock\n | PortableTextDividerBlock;\n\n/**\n * Derived from the union's discriminators, so adding a block to the union\n * without a renderer entry is a compile error, never silent drift.\n */\nexport type PortableTextDefaultBlockType = (\n | PortableTextBlock\n | PortableTextListItemBlock\n)[\"type\"];\n\n// A Record so the compiler checks the list against the union in both\n// directions: a missing and a stray key each fail to build.\nconst DEFAULT_BLOCK_TYPES: Record<PortableTextDefaultBlockType, true> = {\n paragraph: true,\n heading: true,\n list: true,\n \"list-item\": true,\n media: true,\n \"titled-text\": true,\n \"code-block\": true,\n table: true,\n divider: true,\n};\n\n/** Blocks every client understands without injection. */\nexport const PORTABLE_TEXT_DEFAULT_BLOCKS = Object.keys(\n DEFAULT_BLOCK_TYPES\n) as readonly PortableTextDefaultBlockType[];\n\n/* ---- Objects ----------------------------------------------------------- */\n\n/**\n * An embedded component the envelope does not interpret: `_type` names an\n * application-catalog element, everything else is that element's data. An\n * object whose `_type` has no injected renderer renders nothing and is logged.\n */\nexport interface PortableTextObjectNode {\n type: \"object\";\n _type: string;\n [data: string]: unknown;\n}\n\nexport type PortableTextNode = PortableTextBlock | PortableTextObjectNode;\n\n/** The root of a message body: what an API returns under `content`. */\nexport type PortableTextContent = PortableTextNode[];\n\n/* ---- Injection contract ------------------------------------------------ */\n\nexport interface PortableTextMarkRendererProps<\n TMark extends PortableTextMarkObject = PortableTextMarkObject\n> {\n /** Present for object marks; absent when the mark is a plain string. */\n mark?: TMark;\n children: ReactNode;\n}\n\nexport type PortableTextMarkRenderer<\n TMark extends PortableTextMarkObject = PortableTextMarkObject\n> = ComponentType<PortableTextMarkRendererProps<TMark>>;\n\nexport interface PortableTextObjectRendererProps<\n TNode extends PortableTextObjectNode = PortableTextObjectNode\n> {\n node: TNode;\n /** The object's nested `content`, already rendered by the engine. */\n children?: ReactNode;\n}\n\nexport type PortableTextObjectRenderer<\n TNode extends PortableTextObjectNode = PortableTextObjectNode\n> = ComponentType<PortableTextObjectRendererProps<TNode>>;\n\nexport interface PortableTextBlockRendererProps<\n TBlock extends PortableTextBlock = PortableTextBlock\n> {\n block: TBlock;\n /** The block's rendered children/content, when it has any. */\n children?: ReactNode;\n /**\n * Engine-bound span renderer for blocks that carry spans outside `children`\n * (table cells). Resolves marks with the same precedence — injected first,\n * then defaults — as flowing text. Absent when a renderer is used without\n * the engine.\n */\n renderSpans?: (spans: PortableTextSpan[]) => ReactNode;\n}\n\nexport type PortableTextBlockRenderer<\n TBlock extends PortableTextBlock = PortableTextBlock\n> = ComponentType<PortableTextBlockRendererProps<TBlock>>;\n\nexport type PortableTextUnknownKind = \"block\" | \"mark\" | \"object\";\n\n/**\n * Called once per unknown type instead of rendering it, so content written\n * for newer clients degrades silently on older ones.\n */\nexport type PortableTextUnknownTypeHandler = (\n kind: PortableTextUnknownKind,\n type: string\n) => void;\n\n/**\n * What an application injects into the Portable Text engine: renderers for\n * its catalog marks and objects, optional overrides for the default blocks,\n * and the unknown-type hook.\n */\nexport interface PortableTextComponents {\n marks?: Record<string, PortableTextMarkRenderer>;\n objects?: Record<string, PortableTextObjectRenderer>;\n blocks?: Partial<\n Record<PortableTextDefaultBlockType, PortableTextBlockRenderer>\n >;\n onUnknownType?: PortableTextUnknownTypeHandler;\n}\n\n/* ---- Runtime guards ----------------------------------------------------- */\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n typeof value === \"object\" && value !== null;\n\nexport const isPortableTextSpan = (value: unknown): value is PortableTextSpan =>\n isRecord(value) && typeof value.text === \"string\";\n\nexport const isPortableTextTableRow = (\n value: unknown\n): value is PortableTextTableRow =>\n Array.isArray(value) &&\n value.every((cell) => Array.isArray(cell) && cell.every(isPortableTextSpan));\n\nexport const isPortableTextObjectNode = (\n value: unknown\n): value is PortableTextObjectNode =>\n isRecord(value) && value.type === \"object\" && typeof value._type === \"string\";\n\n/**\n * A block is any non-object node with a string `type`. Unknown block types\n * stay valid on purpose — they render nothing on clients that predate them.\n * Known types are held to their shape, so a serializer bug (a paragraph\n * without `children`, a list of non-nodes) fails here instead of at render.\n */\nexport const isPortableTextBlock = (\n value: unknown\n): value is PortableTextBlock => {\n if (\n !isRecord(value) ||\n typeof value.type !== \"string\" ||\n value.type === \"object\"\n ) {\n return false;\n }\n\n switch (value.type) {\n case \"paragraph\":\n case \"heading\":\n case \"list-item\":\n return (\n Array.isArray(value.children) &&\n value.children.every(isPortableTextSpan)\n );\n case \"list\":\n return (\n Array.isArray(value.children) &&\n value.children.every(isPortableTextBlock)\n );\n case \"media\":\n return typeof value.src === \"string\";\n case \"titled-text\":\n return (\n typeof value.title === \"string\" &&\n (value.content === undefined || isPortableTextContent(value.content))\n );\n case \"code-block\":\n return (\n typeof value.code === \"string\" &&\n (value.language === undefined || typeof value.language === \"string\")\n );\n case \"table\":\n return (\n isPortableTextTableRow(value.header) &&\n Array.isArray(value.rows) &&\n value.rows.every(isPortableTextTableRow)\n );\n case \"divider\":\n return true;\n default:\n return true;\n }\n};\n\nexport const isPortableTextContent = (\n value: unknown\n): value is PortableTextContent =>\n Array.isArray(value) &&\n value.every(\n (node) => isPortableTextBlock(node) || isPortableTextObjectNode(node)\n );\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA;AACA;AACA;AACA;;AAMA;;AAQA;;AAMA;AACA,OAAO,MAAMA,2BAA2B,GAAG,CACzC,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,MAAM,CACE;;AAKV;;AAOA;;AAsBA;;AAGA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA,MAAMC,oBAAiE,GAAG;EACxEC,UAAU,EAAE,IAAI;EAChBC,YAAY,EAAE;AAChB,CAAC;AAED,OAAO,MAAMC,+BAA+B,GAC1CC,KAAc,IAEd,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,IAAIJ,oBAAoB;;AAiC5D;;AAUA;;AAeA;AACA;AACA;AACA;;AAMA;AACA;AACA,MAAMK,mBAA+D,GAAG;EACtEC,SAAS,EAAE,IAAI;EACfC,OAAO,EAAE,IAAI;EACbC,IAAI,EAAE,IAAI;EACV,WAAW,EAAE,IAAI;EACjBC,KAAK,EAAE,IAAI;EACX,aAAa,EAAE,IAAI;EACnB,YAAY,EAAE,IAAI;EAClBC,KAAK,EAAE,IAAI;EACXC,OAAO,EAAE;AACX,CAAC;;AAED;AACA,OAAO,MAAMC,4BAA4B,GAAGC,MAAM,CAACC,IAAI,CACrDT,mBACF,CAA4C;;AAE5C;;AAEA;AACA;AACA;AACA;AACA;;AASA;;AAGA;;AA+CA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;;AAUA;;AAEA,MAAMU,QAAQ,GAAIX,KAAc,IAC9B,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,KAAK,IAAI;AAE7C,OAAO,MAAMY,kBAAkB,GAAIZ,KAAc,IAC/CW,QAAQ,CAACX,KAAK,CAAC,IAAI,OAAOA,KAAK,CAACa,IAAI,KAAK,QAAQ;AAEnD,OAAO,MAAMC,sBAAsB,GACjCd,KAAc,IAEde,KAAK,CAACC,OAAO,CAAChB,KAAK,CAAC,IACpBA,KAAK,CAACiB,KAAK,CAAEC,IAAI,IAAKH,KAAK,CAACC,OAAO,CAACE,IAAI,CAAC,IAAIA,IAAI,CAACD,KAAK,CAACL,kBAAkB,CAAC,CAAC;AAE9E,OAAO,MAAMO,wBAAwB,GACnCnB,KAAc,IAEdW,QAAQ,CAACX,KAAK,CAAC,IAAIA,KAAK,CAACoB,IAAI,KAAK,QAAQ,IAAI,OAAOpB,KAAK,CAACqB,KAAK,KAAK,QAAQ;;AAE/E;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,mBAAmB,GAC9BtB,KAAc,IACiB;EAC/B,IACE,CAACW,QAAQ,CAACX,KAAK,CAAC,IAChB,OAAOA,KAAK,CAACoB,IAAI,KAAK,QAAQ,IAC9BpB,KAAK,CAACoB,IAAI,KAAK,QAAQ,EACvB;IACA,OAAO,KAAK;EACd;EAEA,QAAQpB,KAAK,CAACoB,IAAI;IAChB,KAAK,WAAW;IAChB,KAAK,SAAS;IACd,KAAK,WAAW;MACd,OACEL,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CAACL,kBAAkB,CAAC;IAE5C,KAAK,MAAM;MACT,OACEG,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CAACK,mBAAmB,CAAC;IAE7C,KAAK,OAAO;MACV,OAAO,OAAOtB,KAAK,CAACwB,GAAG,KAAK,QAAQ;IACtC,KAAK,aAAa;MAChB,OACE,OAAOxB,KAAK,CAACyB,KAAK,KAAK,QAAQ,KAC9BzB,KAAK,CAAC0B,OAAO,KAAKC,SAAS,IAAIC,qBAAqB,CAAC5B,KAAK,CAAC0B,OAAO,CAAC,CAAC;IAEzE,KAAK,YAAY;MACf,OACE,OAAO1B,KAAK,CAAC6B,IAAI,KAAK,QAAQ,KAC7B7B,KAAK,CAAC8B,QAAQ,KAAKH,SAAS,IAAI,OAAO3B,KAAK,CAAC8B,QAAQ,KAAK,QAAQ,CAAC;IAExE,KAAK,OAAO;MACV,OACEhB,sBAAsB,CAACd,KAAK,CAAC+B,MAAM,CAAC,IACpChB,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACgC,IAAI,CAAC,IACzBhC,KAAK,CAACgC,IAAI,CAACf,KAAK,CAACH,sBAAsB,CAAC;IAE5C,KAAK,SAAS;MACZ,OAAO,IAAI;IACb;MACE,OAAO,IAAI;EACf;AACF,CAAC;AAED,OAAO,MAAMc,qBAAqB,GAChC5B,KAAc,IAEde,KAAK,CAACC,OAAO,CAAChB,KAAK,CAAC,IACpBA,KAAK,CAACiB,KAAK,CACRgB,IAAI,IAAKX,mBAAmB,CAACW,IAAI,CAAC,IAAId,wBAAwB,CAACc,IAAI,CACtE,CAAC","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"types.js","names":["PORTABLE_TEXT_DEFAULT_MARKS","MEDIA_IMAGE_VARIANTS","screenshot","illustration","isPortableTextMediaImageVariant","value","DEFAULT_BLOCK_TYPES","paragraph","heading","list","media","table","divider","PORTABLE_TEXT_DEFAULT_BLOCKS","Object","keys","isRecord","isPortableTextSpan","text","isPortableTextTableRow","Array","isArray","every","cell","isPortableTextObjectNode","type","_type","isPortableTextBlock","children","id","undefined","child","src","title","content","isPortableTextContent","code","language","header","rows","node"],"sources":["../../../../src/components/PortableText/types.ts"],"sourcesContent":["import { ComponentType, ReactNode } from \"react\";\n\n/**\n * Portable Text envelope — the general content contract for structured,\n * renderer-independent content (in-app messages, help, changelogs).\n *\n * The design system owns this envelope and the universal default set below.\n * It never hardcodes a product element: concrete elements (callout,\n * button-reference, doc-link, …) are defined in the application catalog and\n * injected into the Portable Text engine through {@link PortableTextComponents}.\n * See README.md next to this file for the full contract.\n */\n\n/* ---- Spans and marks ------------------------------------------------- */\n\n/**\n * A mark with data. Parameterless marks travel as plain strings (\"strong\");\n * marks that need data travel as objects discriminated by `type`.\n */\nexport interface PortableTextMarkObject {\n type: string;\n [data: string]: unknown;\n}\n\n/** The one default mark that carries data. */\nexport interface PortableTextLinkMark extends PortableTextMarkObject {\n type: \"link\";\n href: string;\n}\n\nexport type PortableTextMark = string | PortableTextMarkObject;\n\n/** The leaf of every text run: a piece of text plus the marks wrapping it. */\nexport interface PortableTextSpan {\n text: string;\n marks?: PortableTextMark[];\n}\n\n/** Marks every client understands without injection. */\nexport const PORTABLE_TEXT_DEFAULT_MARKS = [\n \"strong\",\n \"em\",\n \"code\",\n \"link\",\n] as const;\n\nexport type PortableTextDefaultMark =\n (typeof PORTABLE_TEXT_DEFAULT_MARKS)[number];\n\n/* ---- Blocks ----------------------------------------------------------- */\n\nexport interface PortableTextParagraphBlock {\n type: \"paragraph\";\n children: PortableTextSpan[];\n}\n\n/** 1 maps to Title1, 2 to Title2, 3 to Header2 typography. */\nexport type PortableTextHeadingLevel = 1 | 2 | 3;\n\nexport interface PortableTextHeadingBlock {\n type: \"heading\";\n level: PortableTextHeadingLevel;\n /**\n * Optional anchor id, rendered verbatim as the heading element's `id` so the\n * heading is a scroll target (e.g. subarticle deep-links). Opaque to the\n * renderer — any slug convention lives with whoever produced the block.\n */\n id?: string;\n children: PortableTextSpan[];\n}\n\nexport type PortableTextListStyle = \"bullet\" | \"number\";\n\n/**\n * A list item's children are its own spans first, then any nested `list`\n * block(s) — the shape that carries multi-level lists. A spans-only item (no\n * nested list) is the common, flat case and stays valid unchanged.\n */\nexport interface PortableTextListItemBlock {\n type: \"list-item\";\n children: (PortableTextSpan | PortableTextListBlock)[];\n}\n\nexport interface PortableTextListBlock {\n type: \"list\";\n style?: PortableTextListStyle;\n children: PortableTextListItemBlock[];\n}\n\n/** Screenshots render framed (border, no shadow); illustrations render flat. */\nexport type PortableTextMediaImageVariant = \"screenshot\" | \"illustration\";\n\n/**\n * Video variants name the hosting service; `src` is the canonical video URL.\n * Their rendering carries service semantics (URL parsing, embed derivation),\n * so it belongs to the application catalog — injected as a `media` block\n * override — never to the default set. The default renderer degrades them.\n */\nexport type PortableTextMediaVideoVariant = \"vimeo\" | \"youtube\";\n\nexport type PortableTextMediaVariant =\n | PortableTextMediaImageVariant\n | PortableTextMediaVideoVariant;\n\n// A Record so the compiler checks the list against the union in both\n// directions: a missing and a stray key each fail to build.\nconst MEDIA_IMAGE_VARIANTS: Record<PortableTextMediaImageVariant, true> = {\n screenshot: true,\n illustration: true,\n};\n\nexport const isPortableTextMediaImageVariant = (\n value: unknown\n): value is PortableTextMediaImageVariant =>\n typeof value === \"string\" && value in MEDIA_IMAGE_VARIANTS;\n\nexport interface PortableTextMediaBlock {\n type: \"media\";\n src: string;\n alt?: string;\n variant?: PortableTextMediaVariant;\n caption?: string;\n}\n\nexport interface PortableTextTitledTextBlock {\n type: \"titled-text\";\n /**\n * Same semantic scale as `heading` — 1, 2 or 3 (the default) — so the wire\n * format never encodes a typography name. How a level looks is the\n * renderer's business.\n */\n level?: PortableTextHeadingLevel;\n title: string;\n content?: PortableTextNode[];\n}\n\nexport interface PortableTextCodeBlock {\n type: \"code-block\";\n /**\n * A language hint (e.g. \"php\", \"json\"). The default renderer does no\n * highlighting, so any value — known, unknown or absent — renders as plain\n * preformatted text; it travels as data for surfaces that highlight.\n */\n language?: string;\n code: string;\n}\n\n/** A table cell is a span array, so inline marks work inside cells. */\nexport type PortableTextTableCell = PortableTextSpan[];\nexport type PortableTextTableRow = PortableTextTableCell[];\n\nexport interface PortableTextTableBlock {\n type: \"table\";\n header: PortableTextTableRow;\n rows: PortableTextTableRow[];\n}\n\n/** A themed horizontal rule between sections. Carries no data. */\nexport interface PortableTextDividerBlock {\n type: \"divider\";\n}\n\nexport type PortableTextBlock =\n | PortableTextParagraphBlock\n | PortableTextHeadingBlock\n | PortableTextListBlock\n | PortableTextMediaBlock\n | PortableTextTitledTextBlock\n | PortableTextCodeBlock\n | PortableTextTableBlock\n | PortableTextDividerBlock;\n\n/**\n * Derived from the union's discriminators, so adding a block to the union\n * without a renderer entry is a compile error, never silent drift.\n */\nexport type PortableTextDefaultBlockType = (\n | PortableTextBlock\n | PortableTextListItemBlock\n)[\"type\"];\n\n// A Record so the compiler checks the list against the union in both\n// directions: a missing and a stray key each fail to build.\nconst DEFAULT_BLOCK_TYPES: Record<PortableTextDefaultBlockType, true> = {\n paragraph: true,\n heading: true,\n list: true,\n \"list-item\": true,\n media: true,\n \"titled-text\": true,\n \"code-block\": true,\n table: true,\n divider: true,\n};\n\n/** Blocks every client understands without injection. */\nexport const PORTABLE_TEXT_DEFAULT_BLOCKS = Object.keys(\n DEFAULT_BLOCK_TYPES\n) as readonly PortableTextDefaultBlockType[];\n\n/* ---- Objects ----------------------------------------------------------- */\n\n/**\n * An embedded component the envelope does not interpret: `_type` names an\n * application-catalog element, everything else is that element's data. An\n * object whose `_type` has no injected renderer renders nothing and is logged.\n */\nexport interface PortableTextObjectNode {\n type: \"object\";\n _type: string;\n [data: string]: unknown;\n}\n\nexport type PortableTextNode = PortableTextBlock | PortableTextObjectNode;\n\n/** The root of a message body: what an API returns under `content`. */\nexport type PortableTextContent = PortableTextNode[];\n\n/* ---- Injection contract ------------------------------------------------ */\n\nexport interface PortableTextMarkRendererProps<\n TMark extends PortableTextMarkObject = PortableTextMarkObject\n> {\n /** Present for object marks; absent when the mark is a plain string. */\n mark?: TMark;\n children: ReactNode;\n}\n\nexport type PortableTextMarkRenderer<\n TMark extends PortableTextMarkObject = PortableTextMarkObject\n> = ComponentType<PortableTextMarkRendererProps<TMark>>;\n\nexport interface PortableTextObjectRendererProps<\n TNode extends PortableTextObjectNode = PortableTextObjectNode\n> {\n node: TNode;\n /** The object's nested `content`, already rendered by the engine. */\n children?: ReactNode;\n}\n\nexport type PortableTextObjectRenderer<\n TNode extends PortableTextObjectNode = PortableTextObjectNode\n> = ComponentType<PortableTextObjectRendererProps<TNode>>;\n\nexport interface PortableTextBlockRendererProps<\n TBlock extends PortableTextBlock = PortableTextBlock\n> {\n block: TBlock;\n /** The block's rendered children/content, when it has any. */\n children?: ReactNode;\n /**\n * Engine-bound span renderer for blocks that carry spans outside `children`\n * (table cells). Resolves marks with the same precedence — injected first,\n * then defaults — as flowing text. Absent when a renderer is used without\n * the engine.\n */\n renderSpans?: (spans: PortableTextSpan[]) => ReactNode;\n}\n\nexport type PortableTextBlockRenderer<\n TBlock extends PortableTextBlock = PortableTextBlock\n> = ComponentType<PortableTextBlockRendererProps<TBlock>>;\n\nexport type PortableTextUnknownKind = \"block\" | \"mark\" | \"object\";\n\n/**\n * Called once per unknown type instead of rendering it, so content written\n * for newer clients degrades silently on older ones.\n */\nexport type PortableTextUnknownTypeHandler = (\n kind: PortableTextUnknownKind,\n type: string\n) => void;\n\n/**\n * What an application injects into the Portable Text engine: renderers for\n * its catalog marks and objects, optional overrides for the default blocks,\n * and the unknown-type hook.\n */\nexport interface PortableTextComponents {\n marks?: Record<string, PortableTextMarkRenderer>;\n objects?: Record<string, PortableTextObjectRenderer>;\n blocks?: Partial<\n Record<PortableTextDefaultBlockType, PortableTextBlockRenderer>\n >;\n onUnknownType?: PortableTextUnknownTypeHandler;\n}\n\n/* ---- Runtime guards ----------------------------------------------------- */\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n typeof value === \"object\" && value !== null;\n\nexport const isPortableTextSpan = (value: unknown): value is PortableTextSpan =>\n isRecord(value) && typeof value.text === \"string\";\n\nexport const isPortableTextTableRow = (\n value: unknown\n): value is PortableTextTableRow =>\n Array.isArray(value) &&\n value.every((cell) => Array.isArray(cell) && cell.every(isPortableTextSpan));\n\nexport const isPortableTextObjectNode = (\n value: unknown\n): value is PortableTextObjectNode =>\n isRecord(value) && value.type === \"object\" && typeof value._type === \"string\";\n\n/**\n * A block is any non-object node with a string `type`. Unknown block types\n * stay valid on purpose — they render nothing on clients that predate them.\n * Known types are held to their shape, so a serializer bug (a paragraph\n * without `children`, a list of non-nodes) fails here instead of at render.\n */\nexport const isPortableTextBlock = (\n value: unknown\n): value is PortableTextBlock => {\n if (\n !isRecord(value) ||\n typeof value.type !== \"string\" ||\n value.type === \"object\"\n ) {\n return false;\n }\n\n switch (value.type) {\n case \"paragraph\":\n return (\n Array.isArray(value.children) &&\n value.children.every(isPortableTextSpan)\n );\n case \"heading\":\n return (\n (value.id === undefined || typeof value.id === \"string\") &&\n Array.isArray(value.children) &&\n value.children.every(isPortableTextSpan)\n );\n case \"list-item\":\n // The item's spans, plus optional nested `list` block(s). Widened only\n // for nested lists: any other block child (a stray paragraph, an object)\n // still fails, so a serializer bug is caught here, not at render.\n return (\n Array.isArray(value.children) &&\n value.children.every(\n (child) =>\n isPortableTextSpan(child) ||\n (isPortableTextBlock(child) && child.type === \"list\")\n )\n );\n case \"list\":\n // A list holds `list-item`s only. A sublist emitted as a sibling of the\n // items (the classic half-implemented-nesting bug) renders invalid HTML\n // — <ul> with a direct <ul> child — so it fails here, not at render.\n // `list-item` is validated but sits outside the PortableTextBlock union,\n // so the discriminator is checked before isPortableTextBlock narrows it.\n return (\n Array.isArray(value.children) &&\n value.children.every(\n (child) =>\n isRecord(child) &&\n child.type === \"list-item\" &&\n isPortableTextBlock(child)\n )\n );\n case \"media\":\n return typeof value.src === \"string\";\n case \"titled-text\":\n return (\n typeof value.title === \"string\" &&\n (value.content === undefined || isPortableTextContent(value.content))\n );\n case \"code-block\":\n return (\n typeof value.code === \"string\" &&\n (value.language === undefined || typeof value.language === \"string\")\n );\n case \"table\":\n return (\n isPortableTextTableRow(value.header) &&\n Array.isArray(value.rows) &&\n value.rows.every(isPortableTextTableRow)\n );\n case \"divider\":\n return true;\n default:\n return true;\n }\n};\n\nexport const isPortableTextContent = (\n value: unknown\n): value is PortableTextContent =>\n Array.isArray(value) &&\n value.every(\n (node) => isPortableTextBlock(node) || isPortableTextObjectNode(node)\n );\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA;AACA;AACA;AACA;;AAMA;;AAQA;;AAMA;AACA,OAAO,MAAMA,2BAA2B,GAAG,CACzC,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,MAAM,CACE;;AAKV;;AAOA;;AAiBA;AACA;AACA;AACA;AACA;;AAYA;;AAGA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA,MAAMC,oBAAiE,GAAG;EACxEC,UAAU,EAAE,IAAI;EAChBC,YAAY,EAAE;AAChB,CAAC;AAED,OAAO,MAAMC,+BAA+B,GAC1CC,KAAc,IAEd,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,IAAIJ,oBAAoB;;AAiC5D;;AAUA;;AAeA;AACA;AACA;AACA;;AAMA;AACA;AACA,MAAMK,mBAA+D,GAAG;EACtEC,SAAS,EAAE,IAAI;EACfC,OAAO,EAAE,IAAI;EACbC,IAAI,EAAE,IAAI;EACV,WAAW,EAAE,IAAI;EACjBC,KAAK,EAAE,IAAI;EACX,aAAa,EAAE,IAAI;EACnB,YAAY,EAAE,IAAI;EAClBC,KAAK,EAAE,IAAI;EACXC,OAAO,EAAE;AACX,CAAC;;AAED;AACA,OAAO,MAAMC,4BAA4B,GAAGC,MAAM,CAACC,IAAI,CACrDT,mBACF,CAA4C;;AAE5C;;AAEA;AACA;AACA;AACA;AACA;;AASA;;AAGA;;AA+CA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;;AAUA;;AAEA,MAAMU,QAAQ,GAAIX,KAAc,IAC9B,OAAOA,KAAK,KAAK,QAAQ,IAAIA,KAAK,KAAK,IAAI;AAE7C,OAAO,MAAMY,kBAAkB,GAAIZ,KAAc,IAC/CW,QAAQ,CAACX,KAAK,CAAC,IAAI,OAAOA,KAAK,CAACa,IAAI,KAAK,QAAQ;AAEnD,OAAO,MAAMC,sBAAsB,GACjCd,KAAc,IAEde,KAAK,CAACC,OAAO,CAAChB,KAAK,CAAC,IACpBA,KAAK,CAACiB,KAAK,CAAEC,IAAI,IAAKH,KAAK,CAACC,OAAO,CAACE,IAAI,CAAC,IAAIA,IAAI,CAACD,KAAK,CAACL,kBAAkB,CAAC,CAAC;AAE9E,OAAO,MAAMO,wBAAwB,GACnCnB,KAAc,IAEdW,QAAQ,CAACX,KAAK,CAAC,IAAIA,KAAK,CAACoB,IAAI,KAAK,QAAQ,IAAI,OAAOpB,KAAK,CAACqB,KAAK,KAAK,QAAQ;;AAE/E;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,mBAAmB,GAC9BtB,KAAc,IACiB;EAC/B,IACE,CAACW,QAAQ,CAACX,KAAK,CAAC,IAChB,OAAOA,KAAK,CAACoB,IAAI,KAAK,QAAQ,IAC9BpB,KAAK,CAACoB,IAAI,KAAK,QAAQ,EACvB;IACA,OAAO,KAAK;EACd;EAEA,QAAQpB,KAAK,CAACoB,IAAI;IAChB,KAAK,WAAW;MACd,OACEL,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CAACL,kBAAkB,CAAC;IAE5C,KAAK,SAAS;MACZ,OACE,CAACZ,KAAK,CAACwB,EAAE,KAAKC,SAAS,IAAI,OAAOzB,KAAK,CAACwB,EAAE,KAAK,QAAQ,KACvDT,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CAACL,kBAAkB,CAAC;IAE5C,KAAK,WAAW;MACd;MACA;MACA;MACA,OACEG,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CACjBS,KAAK,IACJd,kBAAkB,CAACc,KAAK,CAAC,IACxBJ,mBAAmB,CAACI,KAAK,CAAC,IAAIA,KAAK,CAACN,IAAI,KAAK,MAClD,CAAC;IAEL,KAAK,MAAM;MACT;MACA;MACA;MACA;MACA;MACA,OACEL,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACuB,QAAQ,CAAC,IAC7BvB,KAAK,CAACuB,QAAQ,CAACN,KAAK,CACjBS,KAAK,IACJf,QAAQ,CAACe,KAAK,CAAC,IACfA,KAAK,CAACN,IAAI,KAAK,WAAW,IAC1BE,mBAAmB,CAACI,KAAK,CAC7B,CAAC;IAEL,KAAK,OAAO;MACV,OAAO,OAAO1B,KAAK,CAAC2B,GAAG,KAAK,QAAQ;IACtC,KAAK,aAAa;MAChB,OACE,OAAO3B,KAAK,CAAC4B,KAAK,KAAK,QAAQ,KAC9B5B,KAAK,CAAC6B,OAAO,KAAKJ,SAAS,IAAIK,qBAAqB,CAAC9B,KAAK,CAAC6B,OAAO,CAAC,CAAC;IAEzE,KAAK,YAAY;MACf,OACE,OAAO7B,KAAK,CAAC+B,IAAI,KAAK,QAAQ,KAC7B/B,KAAK,CAACgC,QAAQ,KAAKP,SAAS,IAAI,OAAOzB,KAAK,CAACgC,QAAQ,KAAK,QAAQ,CAAC;IAExE,KAAK,OAAO;MACV,OACElB,sBAAsB,CAACd,KAAK,CAACiC,MAAM,CAAC,IACpClB,KAAK,CAACC,OAAO,CAAChB,KAAK,CAACkC,IAAI,CAAC,IACzBlC,KAAK,CAACkC,IAAI,CAACjB,KAAK,CAACH,sBAAsB,CAAC;IAE5C,KAAK,SAAS;MACZ,OAAO,IAAI;IACb;MACE,OAAO,IAAI;EACf;AACF,CAAC;AAED,OAAO,MAAMgB,qBAAqB,GAChC9B,KAAc,IAEde,KAAK,CAACC,OAAO,CAAChB,KAAK,CAAC,IACpBA,KAAK,CAACiB,KAAK,CACRkB,IAAI,IAAKb,mBAAmB,CAACa,IAAI,CAAC,IAAIhB,wBAAwB,CAACgB,IAAI,CACtE,CAAC","ignoreList":[]}
|
|
@@ -135,6 +135,14 @@ describe("PortableText envelope", () => {
|
|
|
135
135
|
level: 2,
|
|
136
136
|
children: "oops"
|
|
137
137
|
}])).toBe(false);
|
|
138
|
+
expect(isPortableTextContent([{
|
|
139
|
+
type: "heading",
|
|
140
|
+
level: 2,
|
|
141
|
+
id: 42,
|
|
142
|
+
children: [{
|
|
143
|
+
text: "x"
|
|
144
|
+
}]
|
|
145
|
+
}])).toBe(false);
|
|
138
146
|
expect(isPortableTextContent([{
|
|
139
147
|
type: "paragraph",
|
|
140
148
|
children: [{
|
|
@@ -197,6 +205,126 @@ describe("PortableText envelope", () => {
|
|
|
197
205
|
rows: []
|
|
198
206
|
}])).toBe(false);
|
|
199
207
|
});
|
|
208
|
+
it("accepts a list-item whose children nest a list block after its spans", () => {
|
|
209
|
+
expect(isPortableTextContent([{
|
|
210
|
+
type: "list",
|
|
211
|
+
style: "bullet",
|
|
212
|
+
children: [{
|
|
213
|
+
type: "list-item",
|
|
214
|
+
children: [{
|
|
215
|
+
text: "Step 3:",
|
|
216
|
+
marks: ["strong"]
|
|
217
|
+
}, {
|
|
218
|
+
text: " Choose one of the following options:"
|
|
219
|
+
}, {
|
|
220
|
+
type: "list",
|
|
221
|
+
style: "bullet",
|
|
222
|
+
children: [{
|
|
223
|
+
type: "list-item",
|
|
224
|
+
children: [{
|
|
225
|
+
text: "Sign in via Email"
|
|
226
|
+
}]
|
|
227
|
+
}, {
|
|
228
|
+
type: "list-item",
|
|
229
|
+
children: [{
|
|
230
|
+
text: "Sign in via your Google account"
|
|
231
|
+
}]
|
|
232
|
+
}]
|
|
233
|
+
}]
|
|
234
|
+
}]
|
|
235
|
+
}])).toBe(true);
|
|
236
|
+
});
|
|
237
|
+
it("validates a list nested four levels deep with mixed styles per level", () => {
|
|
238
|
+
expect(isPortableTextContent([{
|
|
239
|
+
type: "list",
|
|
240
|
+
style: "number",
|
|
241
|
+
children: [{
|
|
242
|
+
type: "list-item",
|
|
243
|
+
children: [{
|
|
244
|
+
text: "Top level, ordered"
|
|
245
|
+
}, {
|
|
246
|
+
type: "list",
|
|
247
|
+
style: "bullet",
|
|
248
|
+
children: [{
|
|
249
|
+
type: "list-item",
|
|
250
|
+
children: [{
|
|
251
|
+
text: "Level 2, bullet"
|
|
252
|
+
}, {
|
|
253
|
+
type: "list",
|
|
254
|
+
style: "number",
|
|
255
|
+
children: [{
|
|
256
|
+
type: "list-item",
|
|
257
|
+
children: [{
|
|
258
|
+
text: "Level 3, ordered"
|
|
259
|
+
}, {
|
|
260
|
+
type: "list",
|
|
261
|
+
style: "bullet",
|
|
262
|
+
children: [{
|
|
263
|
+
type: "list-item",
|
|
264
|
+
children: [{
|
|
265
|
+
text: "Level 4, bullet"
|
|
266
|
+
}]
|
|
267
|
+
}]
|
|
268
|
+
}]
|
|
269
|
+
}]
|
|
270
|
+
}]
|
|
271
|
+
}]
|
|
272
|
+
}]
|
|
273
|
+
}]
|
|
274
|
+
}])).toBe(true);
|
|
275
|
+
});
|
|
276
|
+
it("rejects a list whose child is a sublist instead of a list-item", () => {
|
|
277
|
+
// The classic half-implemented-nesting bug: the sublist is emitted as a
|
|
278
|
+
// sibling of the items rather than inside one. It renders invalid HTML
|
|
279
|
+
// (<ul> with a direct <ul> child), so the guard must reject it.
|
|
280
|
+
expect(isPortableTextContent([{
|
|
281
|
+
type: "list",
|
|
282
|
+
style: "bullet",
|
|
283
|
+
children: [{
|
|
284
|
+
type: "list-item",
|
|
285
|
+
children: [{
|
|
286
|
+
text: "Parent"
|
|
287
|
+
}]
|
|
288
|
+
}, {
|
|
289
|
+
type: "list",
|
|
290
|
+
style: "bullet",
|
|
291
|
+
children: [{
|
|
292
|
+
type: "list-item",
|
|
293
|
+
children: [{
|
|
294
|
+
text: "Orphan sub"
|
|
295
|
+
}]
|
|
296
|
+
}]
|
|
297
|
+
}]
|
|
298
|
+
}])).toBe(false);
|
|
299
|
+
});
|
|
300
|
+
it("rejects a list-item child that is neither a span nor a nested list", () => {
|
|
301
|
+
// A stray paragraph child — the guard is widened for nested lists only.
|
|
302
|
+
expect(isPortableTextContent([{
|
|
303
|
+
type: "list",
|
|
304
|
+
children: [{
|
|
305
|
+
type: "list-item",
|
|
306
|
+
children: [{
|
|
307
|
+
text: "An item"
|
|
308
|
+
}, {
|
|
309
|
+
type: "paragraph",
|
|
310
|
+
children: [{
|
|
311
|
+
text: "not allowed here"
|
|
312
|
+
}]
|
|
313
|
+
}]
|
|
314
|
+
}]
|
|
315
|
+
}])).toBe(false);
|
|
316
|
+
// An embedded object child is rejected too.
|
|
317
|
+
expect(isPortableTextContent([{
|
|
318
|
+
type: "list",
|
|
319
|
+
children: [{
|
|
320
|
+
type: "list-item",
|
|
321
|
+
children: [{
|
|
322
|
+
type: "object",
|
|
323
|
+
_type: "callout"
|
|
324
|
+
}]
|
|
325
|
+
}]
|
|
326
|
+
}])).toBe(false);
|
|
327
|
+
});
|
|
200
328
|
it("accepts a code-block without a language and a table without rows", () => {
|
|
201
329
|
expect(isPortableTextContent([{
|
|
202
330
|
type: "code-block",
|
|
@@ -224,6 +352,16 @@ describe("PortableText envelope", () => {
|
|
|
224
352
|
content: []
|
|
225
353
|
}])).toBe(true);
|
|
226
354
|
});
|
|
355
|
+
it("accepts a heading carrying an optional anchor id", () => {
|
|
356
|
+
expect(isPortableTextContent([{
|
|
357
|
+
type: "heading",
|
|
358
|
+
level: 2,
|
|
359
|
+
id: "sub-create-a-task",
|
|
360
|
+
children: [{
|
|
361
|
+
text: "Anchored"
|
|
362
|
+
}]
|
|
363
|
+
}])).toBe(true);
|
|
364
|
+
});
|
|
227
365
|
it("tells blocks, objects and spans apart", () => {
|
|
228
366
|
const heading = sampleMessageContent[0],
|
|
229
367
|
paragraph = sampleMessageContent[1];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.test.js","names":["createElement","Fragment","isPortableTextBlock","isPortableTextContent","isPortableTextMediaImageVariant","isPortableTextObjectNode","isPortableTextSpan","PORTABLE_TEXT_DEFAULT_BLOCKS","PORTABLE_TEXT_DEFAULT_MARKS","describe","sampleMessageContent","type","level","children","text","marks","article","style","src","variant","caption","title","content","_type","tone","label","language","code","header","rows","it","expect","toBe","payload","data","heading","paragraph","callout","toEqual","undefined","_components$marks","seen","components","_ref","objects","_ref2","onUnknownType","kind","push","Object","keys"],"sources":["../../../../src/components/PortableText/types.test.ts"],"sourcesContent":["import { createElement, Fragment } from \"react\";\n\nimport {\n isPortableTextBlock,\n isPortableTextContent,\n isPortableTextMediaImageVariant,\n isPortableTextObjectNode,\n isPortableTextSpan,\n PORTABLE_TEXT_DEFAULT_BLOCKS,\n PORTABLE_TEXT_DEFAULT_MARKS,\n PortableTextComponents,\n PortableTextContent,\n} from \"./types\";\n\ndescribe(\"PortableText envelope\", () => {\n const sampleMessageContent: PortableTextContent = [\n { type: \"heading\", level: 2, children: [{ text: \"IP Firewall\" }] },\n {\n type: \"paragraph\",\n children: [\n { text: \"Open the \" },\n { text: \"Security page\", marks: [\"interface-name\"] },\n { text: \" and press \" },\n { text: \"Enter\", marks: [\"keyboard-key\"] },\n { text: \". Read more in \" },\n {\n text: \"the help article\",\n marks: [{ type: \"doc-link\", article: \"ip-firewall\" }],\n },\n { text: \".\" },\n ],\n },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [{ text: \"Allowlist the IPs you trust\" }],\n },\n {\n type: \"list-item\",\n children: [{ text: \"immediately\", marks: [\"strong\"] }],\n },\n ],\n },\n {\n type: \"media\",\n src: \"/screenshots/firewall.png\",\n variant: \"screenshot\",\n caption: \"The firewall settings\",\n },\n {\n type: \"titled-text\",\n title: \"Allowlist the IPs you trust\",\n level: 3,\n content: [\n { type: \"paragraph\", children: [{ text: \"Add one range per line.\" }] },\n ],\n },\n {\n type: \"object\",\n _type: \"callout\",\n tone: \"note\",\n content: [\n {\n type: \"paragraph\",\n children: [{ text: \"Takes effect immediately.\" }],\n },\n ],\n },\n {\n type: \"object\",\n _type: \"button-reference\",\n label: \"Save Changes\",\n variant: \"primary\",\n },\n { type: \"divider\" },\n {\n type: \"code-block\",\n language: \"json\",\n code: '{ \"allowlist\": [\"203.0.113.0/24\"] }',\n },\n {\n type: \"table\",\n header: [[{ text: \"Range\" }], [{ text: \"Purpose\" }]],\n rows: [\n [\n [{ text: \"203.0.113.0/24\", marks: [\"code\"] }],\n [{ text: \"Office\", marks: [\"strong\"] }],\n ],\n [[{ text: \"198.51.100.0/24\", marks: [\"code\"] }], [{ text: \"VPN\" }]],\n ],\n },\n ];\n\n it(\"validates a sample message that mixes default blocks and catalog objects\", () => {\n expect(isPortableTextContent(sampleMessageContent)).toBe(true);\n });\n\n it(\"keeps unknown block and object types valid so older clients degrade instead of break\", () => {\n expect(\n isPortableTextContent([\n { type: \"some-future-block\", payload: 1 },\n { type: \"object\", _type: \"some-future-element\", data: true },\n ])\n ).toBe(true);\n });\n\n it(\"rejects nodes without a type discriminator and objects without _type\", () => {\n expect(isPortableTextContent([{ children: [] }])).toBe(false);\n expect(isPortableTextContent([{ type: \"object\" }])).toBe(false);\n expect(isPortableTextContent([\"paragraph\"])).toBe(false);\n expect(isPortableTextContent({ content: [] })).toBe(false);\n });\n\n it(\"rejects known blocks whose shape a serializer bug has broken\", () => {\n expect(isPortableTextContent([{ type: \"paragraph\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"heading\", level: 2, children: \"oops\" }])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"paragraph\", children: [{ marks: [\"strong\"] }] },\n ])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"list\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"list\", children: [\"not a node\"] }])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"media\" }])).toBe(false);\n expect(isPortableTextContent([{ type: \"titled-text\", content: [] }])).toBe(\n false\n );\n expect(\n isPortableTextContent([\n { type: \"titled-text\", title: \"Ranges\", content: \"oops\" },\n ])\n ).toBe(false);\n });\n\n it(\"rejects malformed code-block, table and divider-adjacent shapes\", () => {\n expect(isPortableTextContent([{ type: \"code-block\" }])).toBe(false);\n expect(isPortableTextContent([{ type: \"code-block\", code: 42 }])).toBe(\n false\n );\n expect(\n isPortableTextContent([{ type: \"code-block\", code: \"x\", language: 1 }])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"table\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"table\", header: [], rows: \"oops\" }])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [[{ text: \"A\" }]], rows: [[\"not a cell\"]] },\n ])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [{ text: \"not a cell\" }], rows: [] },\n ])\n ).toBe(false);\n });\n\n it(\"accepts a code-block without a language and a table without rows\", () => {\n expect(\n isPortableTextContent([{ type: \"code-block\", code: \"npm install\" }])\n ).toBe(true);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [[{ text: \"A\" }]], rows: [] },\n ])\n ).toBe(true);\n expect(isPortableTextContent([{ type: \"divider\" }])).toBe(true);\n });\n\n it(\"accepts a titled-text with only a title, with or without content\", () => {\n expect(\n isPortableTextContent([{ type: \"titled-text\", title: \"Ranges\" }])\n ).toBe(true);\n expect(\n isPortableTextContent([\n { type: \"titled-text\", title: \"Ranges\", content: [] },\n ])\n ).toBe(true);\n });\n\n it(\"tells blocks, objects and spans apart\", () => {\n const [heading, paragraph] = sampleMessageContent;\n const callout = sampleMessageContent[5];\n\n expect(isPortableTextBlock(heading)).toBe(true);\n expect(isPortableTextBlock(callout)).toBe(false);\n expect(isPortableTextObjectNode(callout)).toBe(true);\n expect(isPortableTextObjectNode(heading)).toBe(false);\n expect(isPortableTextSpan({ text: \"plain\" })).toBe(true);\n expect(isPortableTextSpan(paragraph)).toBe(false);\n });\n\n it(\"ships a universal default set free of product elements\", () => {\n expect(PORTABLE_TEXT_DEFAULT_BLOCKS).toEqual([\n \"paragraph\",\n \"heading\",\n \"list\",\n \"list-item\",\n \"media\",\n \"titled-text\",\n \"code-block\",\n \"table\",\n \"divider\",\n ]);\n expect(PORTABLE_TEXT_DEFAULT_MARKS).toEqual([\n \"strong\",\n \"em\",\n \"code\",\n \"link\",\n ]);\n });\n\n it(\"keeps video media variants in the envelope but out of the image variant set\", () => {\n expect(\n isPortableTextContent([\n {\n type: \"media\",\n variant: \"vimeo\",\n src: \"https://vimeo.com/1131696931\",\n caption: \"Duplicating a project\",\n },\n {\n type: \"media\",\n variant: \"youtube\",\n src: \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\",\n },\n ])\n ).toBe(true);\n\n expect(isPortableTextMediaImageVariant(\"screenshot\")).toBe(true);\n expect(isPortableTextMediaImageVariant(\"illustration\")).toBe(true);\n expect(isPortableTextMediaImageVariant(\"vimeo\")).toBe(false);\n expect(isPortableTextMediaImageVariant(\"youtube\")).toBe(false);\n expect(isPortableTextMediaImageVariant(undefined)).toBe(false);\n });\n\n it(\"accepts an application components map through the injection contract\", () => {\n const seen: string[] = [];\n const components: PortableTextComponents = {\n marks: {\n \"interface-name\": ({ children }) =>\n createElement(Fragment, null, children),\n },\n objects: {\n callout: ({ children }) => createElement(Fragment, null, children),\n },\n onUnknownType: (kind, type) => {\n seen.push(`${kind}:${type}`);\n },\n };\n\n components.onUnknownType?.(\"object\", \"some-future-element\");\n\n expect(Object.keys(components.marks ?? {})).toEqual([\"interface-name\"]);\n expect(seen).toEqual([\"object:some-future-element\"]);\n });\n});\n"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,OAAO;AAE/C,SACEC,mBAAmB,EACnBC,qBAAqB,EACrBC,+BAA+B,EAC/BC,wBAAwB,EACxBC,kBAAkB,EAClBC,4BAA4B,EAC5BC,2BAA2B,QAGtB,SAAS;AAEhBC,QAAQ,CAAC,uBAAuB,EAAE,MAAM;EACtC,MAAMC,oBAAyC,GAAG,CAChD;IAAEC,IAAI,EAAE,SAAS;IAAEC,KAAK,EAAE,CAAC;IAAEC,QAAQ,EAAE,CAAC;MAAEC,IAAI,EAAE;IAAc,CAAC;EAAE,CAAC,EAClE;IACEH,IAAI,EAAE,WAAW;IACjBE,QAAQ,EAAE,CACR;MAAEC,IAAI,EAAE;IAAY,CAAC,EACrB;MAAEA,IAAI,EAAE,eAAe;MAAEC,KAAK,EAAE,CAAC,gBAAgB;IAAE,CAAC,EACpD;MAAED,IAAI,EAAE;IAAc,CAAC,EACvB;MAAEA,IAAI,EAAE,OAAO;MAAEC,KAAK,EAAE,CAAC,cAAc;IAAE,CAAC,EAC1C;MAAED,IAAI,EAAE;IAAkB,CAAC,EAC3B;MACEA,IAAI,EAAE,kBAAkB;MACxBC,KAAK,EAAE,CAAC;QAAEJ,IAAI,EAAE,UAAU;QAAEK,OAAO,EAAE;MAAc,CAAC;IACtD,CAAC,EACD;MAAEF,IAAI,EAAE;IAAI,CAAC;EAEjB,CAAC,EACD;IACEH,IAAI,EAAE,MAAM;IACZM,KAAK,EAAE,QAAQ;IACfJ,QAAQ,EAAE,CACR;MACEF,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA8B,CAAC;IACpD,CAAC,EACD;MACEH,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE,aAAa;QAAEC,KAAK,EAAE,CAAC,QAAQ;MAAE,CAAC;IACvD,CAAC;EAEL,CAAC,EACD;IACEJ,IAAI,EAAE,OAAO;IACbO,GAAG,EAAE,2BAA2B;IAChCC,OAAO,EAAE,YAAY;IACrBC,OAAO,EAAE;EACX,CAAC,EACD;IACET,IAAI,EAAE,aAAa;IACnBU,KAAK,EAAE,6BAA6B;IACpCT,KAAK,EAAE,CAAC;IACRU,OAAO,EAAE,CACP;MAAEX,IAAI,EAAE,WAAW;MAAEE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA0B,CAAC;IAAE,CAAC;EAE1E,CAAC,EACD;IACEH,IAAI,EAAE,QAAQ;IACdY,KAAK,EAAE,SAAS;IAChBC,IAAI,EAAE,MAAM;IACZF,OAAO,EAAE,CACP;MACEX,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA4B,CAAC;IAClD,CAAC;EAEL,CAAC,EACD;IACEH,IAAI,EAAE,QAAQ;IACdY,KAAK,EAAE,kBAAkB;IACzBE,KAAK,EAAE,cAAc;IACrBN,OAAO,EAAE;EACX,CAAC,EACD;IAAER,IAAI,EAAE;EAAU,CAAC,EACnB;IACEA,IAAI,EAAE,YAAY;IAClBe,QAAQ,EAAE,MAAM;IAChBC,IAAI,EAAE;EACR,CAAC,EACD;IACEhB,IAAI,EAAE,OAAO;IACbiB,MAAM,EAAE,CAAC,CAAC;MAAEd,IAAI,EAAE;IAAQ,CAAC,CAAC,EAAE,CAAC;MAAEA,IAAI,EAAE;IAAU,CAAC,CAAC,CAAC;IACpDe,IAAI,EAAE,CACJ,CACE,CAAC;MAAEf,IAAI,EAAE,gBAAgB;MAAEC,KAAK,EAAE,CAAC,MAAM;IAAE,CAAC,CAAC,EAC7C,CAAC;MAAED,IAAI,EAAE,QAAQ;MAAEC,KAAK,EAAE,CAAC,QAAQ;IAAE,CAAC,CAAC,CACxC,EACD,CAAC,CAAC;MAAED,IAAI,EAAE,iBAAiB;MAAEC,KAAK,EAAE,CAAC,MAAM;IAAE,CAAC,CAAC,EAAE,CAAC;MAAED,IAAI,EAAE;IAAM,CAAC,CAAC,CAAC;EAEvE,CAAC,CACF;EAEDgB,EAAE,CAAC,0EAA0E,EAAE,MAAM;IACnFC,MAAM,CAAC5B,qBAAqB,CAACO,oBAAoB,CAAC,CAAC,CAACsB,IAAI,CAAC,IAAI,CAAC;EAChE,CAAC,CAAC;EAEFF,EAAE,CAAC,sFAAsF,EAAE,MAAM;IAC/FC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,mBAAmB;MAAEsB,OAAO,EAAE;IAAE,CAAC,EACzC;MAAEtB,IAAI,EAAE,QAAQ;MAAEY,KAAK,EAAE,qBAAqB;MAAEW,IAAI,EAAE;IAAK,CAAC,CAC7D,CACH,CAAC,CAACF,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAC/EC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEU,QAAQ,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IAC7DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAS,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC/DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC6B,IAAI,CAAC,KAAK,CAAC;IACxDD,MAAM,CAAC5B,qBAAqB,CAAC;MAAEmB,OAAO,EAAE;IAAG,CAAC,CAAC,CAAC,CAACU,IAAI,CAAC,KAAK,CAAC;EAC5D,CAAC,CAAC;EAEFF,EAAE,CAAC,8DAA8D,EAAE,MAAM;IACvEC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAY,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAClED,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,SAAS;MAAEC,KAAK,EAAE,CAAC;MAAEC,QAAQ,EAAE;IAAO,CAAC,CAAC,CACzE,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,WAAW;MAAEE,QAAQ,EAAE,CAAC;QAAEE,KAAK,EAAE,CAAC,QAAQ;MAAE,CAAC;IAAE,CAAC,CACzD,CACH,CAAC,CAACiB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAO,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC7DD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,MAAM;MAAEE,QAAQ,EAAE,CAAC,YAAY;IAAE,CAAC,CAAC,CACpE,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,aAAa;MAAEW,OAAO,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACU,IAAI,CACxE,KACF,CAAC;IACDD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE,QAAQ;MAAEC,OAAO,EAAE;IAAO,CAAC,CAC1D,CACH,CAAC,CAACU,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,iEAAiE,EAAE,MAAM;IAC1EC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAa,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IACnED,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACK,IAAI,CACpE,KACF,CAAC;IACDD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE,GAAG;MAAED,QAAQ,EAAE;IAAE,CAAC,CAAC,CACxE,CAAC,CAACM,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,EAAE;MAAEC,IAAI,EAAE;IAAO,CAAC,CAAC,CACrE,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC,CAAC;QAAEd,IAAI,EAAE;MAAI,CAAC,CAAC,CAAC;MAAEe,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC;IAAE,CAAC,CACrE,CACH,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC;QAAEd,IAAI,EAAE;MAAa,CAAC,CAAC;MAAEe,IAAI,EAAE;IAAG,CAAC,CAC9D,CACH,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,kEAAkE,EAAE,MAAM;IAC3EC,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE;IAAc,CAAC,CAAC,CACrE,CAAC,CAACK,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC,CAAC;QAAEd,IAAI,EAAE;MAAI,CAAC,CAAC,CAAC;MAAEe,IAAI,EAAE;IAAG,CAAC,CACvD,CACH,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAU,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,IAAI,CAAC;EACjE,CAAC,CAAC;EAEFF,EAAE,CAAC,kEAAkE,EAAE,MAAM;IAC3EC,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE;IAAS,CAAC,CAAC,CAClE,CAAC,CAACW,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE,QAAQ;MAAEC,OAAO,EAAE;IAAG,CAAC,CACtD,CACH,CAAC,CAACU,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,uCAAuC,EAAE,MAAM;IAChD,MAAOK,OAAO,GAAezB,oBAAoB;MAAjC0B,SAAS,GAAI1B,oBAAoB;IACjD,MAAM2B,OAAO,GAAG3B,oBAAoB,CAAC,CAAC,CAAC;IAEvCqB,MAAM,CAAC7B,mBAAmB,CAACiC,OAAO,CAAC,CAAC,CAACH,IAAI,CAAC,IAAI,CAAC;IAC/CD,MAAM,CAAC7B,mBAAmB,CAACmC,OAAO,CAAC,CAAC,CAACL,IAAI,CAAC,KAAK,CAAC;IAChDD,MAAM,CAAC1B,wBAAwB,CAACgC,OAAO,CAAC,CAAC,CAACL,IAAI,CAAC,IAAI,CAAC;IACpDD,MAAM,CAAC1B,wBAAwB,CAAC8B,OAAO,CAAC,CAAC,CAACH,IAAI,CAAC,KAAK,CAAC;IACrDD,MAAM,CAACzB,kBAAkB,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAACkB,IAAI,CAAC,IAAI,CAAC;IACxDD,MAAM,CAACzB,kBAAkB,CAAC8B,SAAS,CAAC,CAAC,CAACJ,IAAI,CAAC,KAAK,CAAC;EACnD,CAAC,CAAC;EAEFF,EAAE,CAAC,wDAAwD,EAAE,MAAM;IACjEC,MAAM,CAACxB,4BAA4B,CAAC,CAAC+B,OAAO,CAAC,CAC3C,WAAW,EACX,SAAS,EACT,MAAM,EACN,WAAW,EACX,OAAO,EACP,aAAa,EACb,YAAY,EACZ,OAAO,EACP,SAAS,CACV,CAAC;IACFP,MAAM,CAACvB,2BAA2B,CAAC,CAAC8B,OAAO,CAAC,CAC1C,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,MAAM,CACP,CAAC;EACJ,CAAC,CAAC;EAEFR,EAAE,CAAC,6EAA6E,EAAE,MAAM;IACtFC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,OAAO;MACbQ,OAAO,EAAE,OAAO;MAChBD,GAAG,EAAE,8BAA8B;MACnCE,OAAO,EAAE;IACX,CAAC,EACD;MACET,IAAI,EAAE,OAAO;MACbQ,OAAO,EAAE,SAAS;MAClBD,GAAG,EAAE;IACP,CAAC,CACF,CACH,CAAC,CAACc,IAAI,CAAC,IAAI,CAAC;IAEZD,MAAM,CAAC3B,+BAA+B,CAAC,YAAY,CAAC,CAAC,CAAC4B,IAAI,CAAC,IAAI,CAAC;IAChED,MAAM,CAAC3B,+BAA+B,CAAC,cAAc,CAAC,CAAC,CAAC4B,IAAI,CAAC,IAAI,CAAC;IAClED,MAAM,CAAC3B,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAC4B,IAAI,CAAC,KAAK,CAAC;IAC5DD,MAAM,CAAC3B,+BAA+B,CAAC,SAAS,CAAC,CAAC,CAAC4B,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CAAC3B,+BAA+B,CAACmC,SAAS,CAAC,CAAC,CAACP,IAAI,CAAC,KAAK,CAAC;EAChE,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAAA,IAAAU,iBAAA;IAC/E,MAAMC,IAAc,GAAG,EAAE;IACzB,MAAMC,UAAkC,GAAG;MACzC3B,KAAK,EAAE;QACL,gBAAgB,EAAE4B,IAAA;UAAA,IAAG9B,QAAQ,GAAA8B,IAAA,CAAR9B,QAAQ;UAAA,oBAC3Bb,aAAa,CAACC,QAAQ,EAAE,IAAI,EAAEY,QAAQ,CAAC;QAAA;MAC3C,CAAC;MACD+B,OAAO,EAAE;QACPP,OAAO,EAAEQ,KAAA;UAAA,IAAGhC,QAAQ,GAAAgC,KAAA,CAARhC,QAAQ;UAAA,oBAAOb,aAAa,CAACC,QAAQ,EAAE,IAAI,EAAEY,QAAQ,CAAC;QAAA;MACpE,CAAC;MACDiC,aAAa,EAAEA,CAACC,IAAI,EAAEpC,IAAI,KAAK;QAC7B8B,IAAI,CAACO,IAAI,CAAID,IAAI,SAAIpC,IAAM,CAAC;MAC9B;IACF,CAAC;IAED+B,UAAU,CAACI,aAAa,YAAxBJ,UAAU,CAACI,aAAa,CAAG,QAAQ,EAAE,qBAAqB,CAAC;IAE3Df,MAAM,CAACkB,MAAM,CAACC,IAAI,EAAAV,iBAAA,GAACE,UAAU,CAAC3B,KAAK,YAAAyB,iBAAA,GAAI,CAAC,CAAC,CAAC,CAAC,CAACF,OAAO,CAAC,CAAC,gBAAgB,CAAC,CAAC;IACvEP,MAAM,CAACU,IAAI,CAAC,CAACH,OAAO,CAAC,CAAC,4BAA4B,CAAC,CAAC;EACtD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"types.test.js","names":["createElement","Fragment","isPortableTextBlock","isPortableTextContent","isPortableTextMediaImageVariant","isPortableTextObjectNode","isPortableTextSpan","PORTABLE_TEXT_DEFAULT_BLOCKS","PORTABLE_TEXT_DEFAULT_MARKS","describe","sampleMessageContent","type","level","children","text","marks","article","style","src","variant","caption","title","content","_type","tone","label","language","code","header","rows","it","expect","toBe","payload","data","id","heading","paragraph","callout","toEqual","undefined","_components$marks","seen","components","_ref","objects","_ref2","onUnknownType","kind","push","Object","keys"],"sources":["../../../../src/components/PortableText/types.test.ts"],"sourcesContent":["import { createElement, Fragment } from \"react\";\n\nimport {\n isPortableTextBlock,\n isPortableTextContent,\n isPortableTextMediaImageVariant,\n isPortableTextObjectNode,\n isPortableTextSpan,\n PORTABLE_TEXT_DEFAULT_BLOCKS,\n PORTABLE_TEXT_DEFAULT_MARKS,\n PortableTextComponents,\n PortableTextContent,\n} from \"./types\";\n\ndescribe(\"PortableText envelope\", () => {\n const sampleMessageContent: PortableTextContent = [\n { type: \"heading\", level: 2, children: [{ text: \"IP Firewall\" }] },\n {\n type: \"paragraph\",\n children: [\n { text: \"Open the \" },\n { text: \"Security page\", marks: [\"interface-name\"] },\n { text: \" and press \" },\n { text: \"Enter\", marks: [\"keyboard-key\"] },\n { text: \". Read more in \" },\n {\n text: \"the help article\",\n marks: [{ type: \"doc-link\", article: \"ip-firewall\" }],\n },\n { text: \".\" },\n ],\n },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [{ text: \"Allowlist the IPs you trust\" }],\n },\n {\n type: \"list-item\",\n children: [{ text: \"immediately\", marks: [\"strong\"] }],\n },\n ],\n },\n {\n type: \"media\",\n src: \"/screenshots/firewall.png\",\n variant: \"screenshot\",\n caption: \"The firewall settings\",\n },\n {\n type: \"titled-text\",\n title: \"Allowlist the IPs you trust\",\n level: 3,\n content: [\n { type: \"paragraph\", children: [{ text: \"Add one range per line.\" }] },\n ],\n },\n {\n type: \"object\",\n _type: \"callout\",\n tone: \"note\",\n content: [\n {\n type: \"paragraph\",\n children: [{ text: \"Takes effect immediately.\" }],\n },\n ],\n },\n {\n type: \"object\",\n _type: \"button-reference\",\n label: \"Save Changes\",\n variant: \"primary\",\n },\n { type: \"divider\" },\n {\n type: \"code-block\",\n language: \"json\",\n code: '{ \"allowlist\": [\"203.0.113.0/24\"] }',\n },\n {\n type: \"table\",\n header: [[{ text: \"Range\" }], [{ text: \"Purpose\" }]],\n rows: [\n [\n [{ text: \"203.0.113.0/24\", marks: [\"code\"] }],\n [{ text: \"Office\", marks: [\"strong\"] }],\n ],\n [[{ text: \"198.51.100.0/24\", marks: [\"code\"] }], [{ text: \"VPN\" }]],\n ],\n },\n ];\n\n it(\"validates a sample message that mixes default blocks and catalog objects\", () => {\n expect(isPortableTextContent(sampleMessageContent)).toBe(true);\n });\n\n it(\"keeps unknown block and object types valid so older clients degrade instead of break\", () => {\n expect(\n isPortableTextContent([\n { type: \"some-future-block\", payload: 1 },\n { type: \"object\", _type: \"some-future-element\", data: true },\n ])\n ).toBe(true);\n });\n\n it(\"rejects nodes without a type discriminator and objects without _type\", () => {\n expect(isPortableTextContent([{ children: [] }])).toBe(false);\n expect(isPortableTextContent([{ type: \"object\" }])).toBe(false);\n expect(isPortableTextContent([\"paragraph\"])).toBe(false);\n expect(isPortableTextContent({ content: [] })).toBe(false);\n });\n\n it(\"rejects known blocks whose shape a serializer bug has broken\", () => {\n expect(isPortableTextContent([{ type: \"paragraph\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"heading\", level: 2, children: \"oops\" }])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"heading\", level: 2, id: 42, children: [{ text: \"x\" }] },\n ])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"paragraph\", children: [{ marks: [\"strong\"] }] },\n ])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"list\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"list\", children: [\"not a node\"] }])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"media\" }])).toBe(false);\n expect(isPortableTextContent([{ type: \"titled-text\", content: [] }])).toBe(\n false\n );\n expect(\n isPortableTextContent([\n { type: \"titled-text\", title: \"Ranges\", content: \"oops\" },\n ])\n ).toBe(false);\n });\n\n it(\"rejects malformed code-block, table and divider-adjacent shapes\", () => {\n expect(isPortableTextContent([{ type: \"code-block\" }])).toBe(false);\n expect(isPortableTextContent([{ type: \"code-block\", code: 42 }])).toBe(\n false\n );\n expect(\n isPortableTextContent([{ type: \"code-block\", code: \"x\", language: 1 }])\n ).toBe(false);\n expect(isPortableTextContent([{ type: \"table\" }])).toBe(false);\n expect(\n isPortableTextContent([{ type: \"table\", header: [], rows: \"oops\" }])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [[{ text: \"A\" }]], rows: [[\"not a cell\"]] },\n ])\n ).toBe(false);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [{ text: \"not a cell\" }], rows: [] },\n ])\n ).toBe(false);\n });\n\n it(\"accepts a list-item whose children nest a list block after its spans\", () => {\n expect(\n isPortableTextContent([\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [\n { text: \"Step 3:\", marks: [\"strong\"] },\n { text: \" Choose one of the following options:\" },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [{ text: \"Sign in via Email\" }],\n },\n {\n type: \"list-item\",\n children: [{ text: \"Sign in via your Google account\" }],\n },\n ],\n },\n ],\n },\n ],\n },\n ])\n ).toBe(true);\n });\n\n it(\"validates a list nested four levels deep with mixed styles per level\", () => {\n expect(\n isPortableTextContent([\n {\n type: \"list\",\n style: \"number\",\n children: [\n {\n type: \"list-item\",\n children: [\n { text: \"Top level, ordered\" },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [\n { text: \"Level 2, bullet\" },\n {\n type: \"list\",\n style: \"number\",\n children: [\n {\n type: \"list-item\",\n children: [\n { text: \"Level 3, ordered\" },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n {\n type: \"list-item\",\n children: [{ text: \"Level 4, bullet\" }],\n },\n ],\n },\n ],\n },\n ],\n },\n ],\n },\n ],\n },\n ],\n },\n ],\n },\n ])\n ).toBe(true);\n });\n\n it(\"rejects a list whose child is a sublist instead of a list-item\", () => {\n // The classic half-implemented-nesting bug: the sublist is emitted as a\n // sibling of the items rather than inside one. It renders invalid HTML\n // (<ul> with a direct <ul> child), so the guard must reject it.\n expect(\n isPortableTextContent([\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n { type: \"list-item\", children: [{ text: \"Parent\" }] },\n {\n type: \"list\",\n style: \"bullet\",\n children: [\n { type: \"list-item\", children: [{ text: \"Orphan sub\" }] },\n ],\n },\n ],\n },\n ])\n ).toBe(false);\n });\n\n it(\"rejects a list-item child that is neither a span nor a nested list\", () => {\n // A stray paragraph child — the guard is widened for nested lists only.\n expect(\n isPortableTextContent([\n {\n type: \"list\",\n children: [\n {\n type: \"list-item\",\n children: [\n { text: \"An item\" },\n { type: \"paragraph\", children: [{ text: \"not allowed here\" }] },\n ],\n },\n ],\n },\n ])\n ).toBe(false);\n // An embedded object child is rejected too.\n expect(\n isPortableTextContent([\n {\n type: \"list\",\n children: [\n {\n type: \"list-item\",\n children: [{ type: \"object\", _type: \"callout\" }],\n },\n ],\n },\n ])\n ).toBe(false);\n });\n\n it(\"accepts a code-block without a language and a table without rows\", () => {\n expect(\n isPortableTextContent([{ type: \"code-block\", code: \"npm install\" }])\n ).toBe(true);\n expect(\n isPortableTextContent([\n { type: \"table\", header: [[{ text: \"A\" }]], rows: [] },\n ])\n ).toBe(true);\n expect(isPortableTextContent([{ type: \"divider\" }])).toBe(true);\n });\n\n it(\"accepts a titled-text with only a title, with or without content\", () => {\n expect(\n isPortableTextContent([{ type: \"titled-text\", title: \"Ranges\" }])\n ).toBe(true);\n expect(\n isPortableTextContent([\n { type: \"titled-text\", title: \"Ranges\", content: [] },\n ])\n ).toBe(true);\n });\n\n it(\"accepts a heading carrying an optional anchor id\", () => {\n expect(\n isPortableTextContent([\n {\n type: \"heading\",\n level: 2,\n id: \"sub-create-a-task\",\n children: [{ text: \"Anchored\" }],\n },\n ])\n ).toBe(true);\n });\n\n it(\"tells blocks, objects and spans apart\", () => {\n const [heading, paragraph] = sampleMessageContent;\n const callout = sampleMessageContent[5];\n\n expect(isPortableTextBlock(heading)).toBe(true);\n expect(isPortableTextBlock(callout)).toBe(false);\n expect(isPortableTextObjectNode(callout)).toBe(true);\n expect(isPortableTextObjectNode(heading)).toBe(false);\n expect(isPortableTextSpan({ text: \"plain\" })).toBe(true);\n expect(isPortableTextSpan(paragraph)).toBe(false);\n });\n\n it(\"ships a universal default set free of product elements\", () => {\n expect(PORTABLE_TEXT_DEFAULT_BLOCKS).toEqual([\n \"paragraph\",\n \"heading\",\n \"list\",\n \"list-item\",\n \"media\",\n \"titled-text\",\n \"code-block\",\n \"table\",\n \"divider\",\n ]);\n expect(PORTABLE_TEXT_DEFAULT_MARKS).toEqual([\n \"strong\",\n \"em\",\n \"code\",\n \"link\",\n ]);\n });\n\n it(\"keeps video media variants in the envelope but out of the image variant set\", () => {\n expect(\n isPortableTextContent([\n {\n type: \"media\",\n variant: \"vimeo\",\n src: \"https://vimeo.com/1131696931\",\n caption: \"Duplicating a project\",\n },\n {\n type: \"media\",\n variant: \"youtube\",\n src: \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\",\n },\n ])\n ).toBe(true);\n\n expect(isPortableTextMediaImageVariant(\"screenshot\")).toBe(true);\n expect(isPortableTextMediaImageVariant(\"illustration\")).toBe(true);\n expect(isPortableTextMediaImageVariant(\"vimeo\")).toBe(false);\n expect(isPortableTextMediaImageVariant(\"youtube\")).toBe(false);\n expect(isPortableTextMediaImageVariant(undefined)).toBe(false);\n });\n\n it(\"accepts an application components map through the injection contract\", () => {\n const seen: string[] = [];\n const components: PortableTextComponents = {\n marks: {\n \"interface-name\": ({ children }) =>\n createElement(Fragment, null, children),\n },\n objects: {\n callout: ({ children }) => createElement(Fragment, null, children),\n },\n onUnknownType: (kind, type) => {\n seen.push(`${kind}:${type}`);\n },\n };\n\n components.onUnknownType?.(\"object\", \"some-future-element\");\n\n expect(Object.keys(components.marks ?? {})).toEqual([\"interface-name\"]);\n expect(seen).toEqual([\"object:some-future-element\"]);\n });\n});\n"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,OAAO;AAE/C,SACEC,mBAAmB,EACnBC,qBAAqB,EACrBC,+BAA+B,EAC/BC,wBAAwB,EACxBC,kBAAkB,EAClBC,4BAA4B,EAC5BC,2BAA2B,QAGtB,SAAS;AAEhBC,QAAQ,CAAC,uBAAuB,EAAE,MAAM;EACtC,MAAMC,oBAAyC,GAAG,CAChD;IAAEC,IAAI,EAAE,SAAS;IAAEC,KAAK,EAAE,CAAC;IAAEC,QAAQ,EAAE,CAAC;MAAEC,IAAI,EAAE;IAAc,CAAC;EAAE,CAAC,EAClE;IACEH,IAAI,EAAE,WAAW;IACjBE,QAAQ,EAAE,CACR;MAAEC,IAAI,EAAE;IAAY,CAAC,EACrB;MAAEA,IAAI,EAAE,eAAe;MAAEC,KAAK,EAAE,CAAC,gBAAgB;IAAE,CAAC,EACpD;MAAED,IAAI,EAAE;IAAc,CAAC,EACvB;MAAEA,IAAI,EAAE,OAAO;MAAEC,KAAK,EAAE,CAAC,cAAc;IAAE,CAAC,EAC1C;MAAED,IAAI,EAAE;IAAkB,CAAC,EAC3B;MACEA,IAAI,EAAE,kBAAkB;MACxBC,KAAK,EAAE,CAAC;QAAEJ,IAAI,EAAE,UAAU;QAAEK,OAAO,EAAE;MAAc,CAAC;IACtD,CAAC,EACD;MAAEF,IAAI,EAAE;IAAI,CAAC;EAEjB,CAAC,EACD;IACEH,IAAI,EAAE,MAAM;IACZM,KAAK,EAAE,QAAQ;IACfJ,QAAQ,EAAE,CACR;MACEF,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA8B,CAAC;IACpD,CAAC,EACD;MACEH,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE,aAAa;QAAEC,KAAK,EAAE,CAAC,QAAQ;MAAE,CAAC;IACvD,CAAC;EAEL,CAAC,EACD;IACEJ,IAAI,EAAE,OAAO;IACbO,GAAG,EAAE,2BAA2B;IAChCC,OAAO,EAAE,YAAY;IACrBC,OAAO,EAAE;EACX,CAAC,EACD;IACET,IAAI,EAAE,aAAa;IACnBU,KAAK,EAAE,6BAA6B;IACpCT,KAAK,EAAE,CAAC;IACRU,OAAO,EAAE,CACP;MAAEX,IAAI,EAAE,WAAW;MAAEE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA0B,CAAC;IAAE,CAAC;EAE1E,CAAC,EACD;IACEH,IAAI,EAAE,QAAQ;IACdY,KAAK,EAAE,SAAS;IAChBC,IAAI,EAAE,MAAM;IACZF,OAAO,EAAE,CACP;MACEX,IAAI,EAAE,WAAW;MACjBE,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAA4B,CAAC;IAClD,CAAC;EAEL,CAAC,EACD;IACEH,IAAI,EAAE,QAAQ;IACdY,KAAK,EAAE,kBAAkB;IACzBE,KAAK,EAAE,cAAc;IACrBN,OAAO,EAAE;EACX,CAAC,EACD;IAAER,IAAI,EAAE;EAAU,CAAC,EACnB;IACEA,IAAI,EAAE,YAAY;IAClBe,QAAQ,EAAE,MAAM;IAChBC,IAAI,EAAE;EACR,CAAC,EACD;IACEhB,IAAI,EAAE,OAAO;IACbiB,MAAM,EAAE,CAAC,CAAC;MAAEd,IAAI,EAAE;IAAQ,CAAC,CAAC,EAAE,CAAC;MAAEA,IAAI,EAAE;IAAU,CAAC,CAAC,CAAC;IACpDe,IAAI,EAAE,CACJ,CACE,CAAC;MAAEf,IAAI,EAAE,gBAAgB;MAAEC,KAAK,EAAE,CAAC,MAAM;IAAE,CAAC,CAAC,EAC7C,CAAC;MAAED,IAAI,EAAE,QAAQ;MAAEC,KAAK,EAAE,CAAC,QAAQ;IAAE,CAAC,CAAC,CACxC,EACD,CAAC,CAAC;MAAED,IAAI,EAAE,iBAAiB;MAAEC,KAAK,EAAE,CAAC,MAAM;IAAE,CAAC,CAAC,EAAE,CAAC;MAAED,IAAI,EAAE;IAAM,CAAC,CAAC,CAAC;EAEvE,CAAC,CACF;EAEDgB,EAAE,CAAC,0EAA0E,EAAE,MAAM;IACnFC,MAAM,CAAC5B,qBAAqB,CAACO,oBAAoB,CAAC,CAAC,CAACsB,IAAI,CAAC,IAAI,CAAC;EAChE,CAAC,CAAC;EAEFF,EAAE,CAAC,sFAAsF,EAAE,MAAM;IAC/FC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,mBAAmB;MAAEsB,OAAO,EAAE;IAAE,CAAC,EACzC;MAAEtB,IAAI,EAAE,QAAQ;MAAEY,KAAK,EAAE,qBAAqB;MAAEW,IAAI,EAAE;IAAK,CAAC,CAC7D,CACH,CAAC,CAACF,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAC/EC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEU,QAAQ,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IAC7DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAS,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC/DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC6B,IAAI,CAAC,KAAK,CAAC;IACxDD,MAAM,CAAC5B,qBAAqB,CAAC;MAAEmB,OAAO,EAAE;IAAG,CAAC,CAAC,CAAC,CAACU,IAAI,CAAC,KAAK,CAAC;EAC5D,CAAC,CAAC;EAEFF,EAAE,CAAC,8DAA8D,EAAE,MAAM;IACvEC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAY,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAClED,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,SAAS;MAAEC,KAAK,EAAE,CAAC;MAAEC,QAAQ,EAAE;IAAO,CAAC,CAAC,CACzE,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,SAAS;MAAEC,KAAK,EAAE,CAAC;MAAEuB,EAAE,EAAE,EAAE;MAAEtB,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAAI,CAAC;IAAE,CAAC,CACjE,CACH,CAAC,CAACkB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,WAAW;MAAEE,QAAQ,EAAE,CAAC;QAAEE,KAAK,EAAE,CAAC,QAAQ;MAAE,CAAC;IAAE,CAAC,CACzD,CACH,CAAC,CAACiB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAO,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC7DD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,MAAM;MAAEE,QAAQ,EAAE,CAAC,YAAY;IAAE,CAAC,CAAC,CACpE,CAAC,CAACmB,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,aAAa;MAAEW,OAAO,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACU,IAAI,CACxE,KACF,CAAC;IACDD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE,QAAQ;MAAEC,OAAO,EAAE;IAAO,CAAC,CAC1D,CACH,CAAC,CAACU,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,iEAAiE,EAAE,MAAM;IAC1EC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAa,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IACnED,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE;IAAG,CAAC,CAAC,CAAC,CAAC,CAACK,IAAI,CACpE,KACF,CAAC;IACDD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE,GAAG;MAAED,QAAQ,EAAE;IAAE,CAAC,CAAC,CACxE,CAAC,CAACM,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,EAAE;MAAEC,IAAI,EAAE;IAAO,CAAC,CAAC,CACrE,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC,CAAC;QAAEd,IAAI,EAAE;MAAI,CAAC,CAAC,CAAC;MAAEe,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC;IAAE,CAAC,CACrE,CACH,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;IACbD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC;QAAEd,IAAI,EAAE;MAAa,CAAC,CAAC;MAAEe,IAAI,EAAE;IAAG,CAAC,CAC9D,CACH,CAAC,CAACG,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAC/EC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,MAAM;MACZM,KAAK,EAAE,QAAQ;MACfJ,QAAQ,EAAE,CACR;QACEF,IAAI,EAAE,WAAW;QACjBE,QAAQ,EAAE,CACR;UAAEC,IAAI,EAAE,SAAS;UAAEC,KAAK,EAAE,CAAC,QAAQ;QAAE,CAAC,EACtC;UAAED,IAAI,EAAE;QAAwC,CAAC,EACjD;UACEH,IAAI,EAAE,MAAM;UACZM,KAAK,EAAE,QAAQ;UACfJ,QAAQ,EAAE,CACR;YACEF,IAAI,EAAE,WAAW;YACjBE,QAAQ,EAAE,CAAC;cAAEC,IAAI,EAAE;YAAoB,CAAC;UAC1C,CAAC,EACD;YACEH,IAAI,EAAE,WAAW;YACjBE,QAAQ,EAAE,CAAC;cAAEC,IAAI,EAAE;YAAkC,CAAC;UACxD,CAAC;QAEL,CAAC;MAEL,CAAC;IAEL,CAAC,CACF,CACH,CAAC,CAACkB,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAC/EC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,MAAM;MACZM,KAAK,EAAE,QAAQ;MACfJ,QAAQ,EAAE,CACR;QACEF,IAAI,EAAE,WAAW;QACjBE,QAAQ,EAAE,CACR;UAAEC,IAAI,EAAE;QAAqB,CAAC,EAC9B;UACEH,IAAI,EAAE,MAAM;UACZM,KAAK,EAAE,QAAQ;UACfJ,QAAQ,EAAE,CACR;YACEF,IAAI,EAAE,WAAW;YACjBE,QAAQ,EAAE,CACR;cAAEC,IAAI,EAAE;YAAkB,CAAC,EAC3B;cACEH,IAAI,EAAE,MAAM;cACZM,KAAK,EAAE,QAAQ;cACfJ,QAAQ,EAAE,CACR;gBACEF,IAAI,EAAE,WAAW;gBACjBE,QAAQ,EAAE,CACR;kBAAEC,IAAI,EAAE;gBAAmB,CAAC,EAC5B;kBACEH,IAAI,EAAE,MAAM;kBACZM,KAAK,EAAE,QAAQ;kBACfJ,QAAQ,EAAE,CACR;oBACEF,IAAI,EAAE,WAAW;oBACjBE,QAAQ,EAAE,CAAC;sBAAEC,IAAI,EAAE;oBAAkB,CAAC;kBACxC,CAAC;gBAEL,CAAC;cAEL,CAAC;YAEL,CAAC;UAEL,CAAC;QAEL,CAAC;MAEL,CAAC;IAEL,CAAC,CACF,CACH,CAAC,CAACkB,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,gEAAgE,EAAE,MAAM;IACzE;IACA;IACA;IACAC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,MAAM;MACZM,KAAK,EAAE,QAAQ;MACfJ,QAAQ,EAAE,CACR;QAAEF,IAAI,EAAE,WAAW;QAAEE,QAAQ,EAAE,CAAC;UAAEC,IAAI,EAAE;QAAS,CAAC;MAAE,CAAC,EACrD;QACEH,IAAI,EAAE,MAAM;QACZM,KAAK,EAAE,QAAQ;QACfJ,QAAQ,EAAE,CACR;UAAEF,IAAI,EAAE,WAAW;UAAEE,QAAQ,EAAE,CAAC;YAAEC,IAAI,EAAE;UAAa,CAAC;QAAE,CAAC;MAE7D,CAAC;IAEL,CAAC,CACF,CACH,CAAC,CAACkB,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,oEAAoE,EAAE,MAAM;IAC7E;IACAC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,MAAM;MACZE,QAAQ,EAAE,CACR;QACEF,IAAI,EAAE,WAAW;QACjBE,QAAQ,EAAE,CACR;UAAEC,IAAI,EAAE;QAAU,CAAC,EACnB;UAAEH,IAAI,EAAE,WAAW;UAAEE,QAAQ,EAAE,CAAC;YAAEC,IAAI,EAAE;UAAmB,CAAC;QAAE,CAAC;MAEnE,CAAC;IAEL,CAAC,CACF,CACH,CAAC,CAACkB,IAAI,CAAC,KAAK,CAAC;IACb;IACAD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,MAAM;MACZE,QAAQ,EAAE,CACR;QACEF,IAAI,EAAE,WAAW;QACjBE,QAAQ,EAAE,CAAC;UAAEF,IAAI,EAAE,QAAQ;UAAEY,KAAK,EAAE;QAAU,CAAC;MACjD,CAAC;IAEL,CAAC,CACF,CACH,CAAC,CAACS,IAAI,CAAC,KAAK,CAAC;EACf,CAAC,CAAC;EAEFF,EAAE,CAAC,kEAAkE,EAAE,MAAM;IAC3EC,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,YAAY;MAAEgB,IAAI,EAAE;IAAc,CAAC,CAAC,CACrE,CAAC,CAACK,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,OAAO;MAAEiB,MAAM,EAAE,CAAC,CAAC;QAAEd,IAAI,EAAE;MAAI,CAAC,CAAC,CAAC;MAAEe,IAAI,EAAE;IAAG,CAAC,CACvD,CACH,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CAAC5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE;IAAU,CAAC,CAAC,CAAC,CAAC,CAACqB,IAAI,CAAC,IAAI,CAAC;EACjE,CAAC,CAAC;EAEFF,EAAE,CAAC,kEAAkE,EAAE,MAAM;IAC3EC,MAAM,CACJ5B,qBAAqB,CAAC,CAAC;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE;IAAS,CAAC,CAAC,CAClE,CAAC,CAACW,IAAI,CAAC,IAAI,CAAC;IACZD,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MAAEQ,IAAI,EAAE,aAAa;MAAEU,KAAK,EAAE,QAAQ;MAAEC,OAAO,EAAE;IAAG,CAAC,CACtD,CACH,CAAC,CAACU,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,kDAAkD,EAAE,MAAM;IAC3DC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,SAAS;MACfC,KAAK,EAAE,CAAC;MACRuB,EAAE,EAAE,mBAAmB;MACvBtB,QAAQ,EAAE,CAAC;QAAEC,IAAI,EAAE;MAAW,CAAC;IACjC,CAAC,CACF,CACH,CAAC,CAACkB,IAAI,CAAC,IAAI,CAAC;EACd,CAAC,CAAC;EAEFF,EAAE,CAAC,uCAAuC,EAAE,MAAM;IAChD,MAAOM,OAAO,GAAe1B,oBAAoB;MAAjC2B,SAAS,GAAI3B,oBAAoB;IACjD,MAAM4B,OAAO,GAAG5B,oBAAoB,CAAC,CAAC,CAAC;IAEvCqB,MAAM,CAAC7B,mBAAmB,CAACkC,OAAO,CAAC,CAAC,CAACJ,IAAI,CAAC,IAAI,CAAC;IAC/CD,MAAM,CAAC7B,mBAAmB,CAACoC,OAAO,CAAC,CAAC,CAACN,IAAI,CAAC,KAAK,CAAC;IAChDD,MAAM,CAAC1B,wBAAwB,CAACiC,OAAO,CAAC,CAAC,CAACN,IAAI,CAAC,IAAI,CAAC;IACpDD,MAAM,CAAC1B,wBAAwB,CAAC+B,OAAO,CAAC,CAAC,CAACJ,IAAI,CAAC,KAAK,CAAC;IACrDD,MAAM,CAACzB,kBAAkB,CAAC;MAAEQ,IAAI,EAAE;IAAQ,CAAC,CAAC,CAAC,CAACkB,IAAI,CAAC,IAAI,CAAC;IACxDD,MAAM,CAACzB,kBAAkB,CAAC+B,SAAS,CAAC,CAAC,CAACL,IAAI,CAAC,KAAK,CAAC;EACnD,CAAC,CAAC;EAEFF,EAAE,CAAC,wDAAwD,EAAE,MAAM;IACjEC,MAAM,CAACxB,4BAA4B,CAAC,CAACgC,OAAO,CAAC,CAC3C,WAAW,EACX,SAAS,EACT,MAAM,EACN,WAAW,EACX,OAAO,EACP,aAAa,EACb,YAAY,EACZ,OAAO,EACP,SAAS,CACV,CAAC;IACFR,MAAM,CAACvB,2BAA2B,CAAC,CAAC+B,OAAO,CAAC,CAC1C,QAAQ,EACR,IAAI,EACJ,MAAM,EACN,MAAM,CACP,CAAC;EACJ,CAAC,CAAC;EAEFT,EAAE,CAAC,6EAA6E,EAAE,MAAM;IACtFC,MAAM,CACJ5B,qBAAqB,CAAC,CACpB;MACEQ,IAAI,EAAE,OAAO;MACbQ,OAAO,EAAE,OAAO;MAChBD,GAAG,EAAE,8BAA8B;MACnCE,OAAO,EAAE;IACX,CAAC,EACD;MACET,IAAI,EAAE,OAAO;MACbQ,OAAO,EAAE,SAAS;MAClBD,GAAG,EAAE;IACP,CAAC,CACF,CACH,CAAC,CAACc,IAAI,CAAC,IAAI,CAAC;IAEZD,MAAM,CAAC3B,+BAA+B,CAAC,YAAY,CAAC,CAAC,CAAC4B,IAAI,CAAC,IAAI,CAAC;IAChED,MAAM,CAAC3B,+BAA+B,CAAC,cAAc,CAAC,CAAC,CAAC4B,IAAI,CAAC,IAAI,CAAC;IAClED,MAAM,CAAC3B,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAC4B,IAAI,CAAC,KAAK,CAAC;IAC5DD,MAAM,CAAC3B,+BAA+B,CAAC,SAAS,CAAC,CAAC,CAAC4B,IAAI,CAAC,KAAK,CAAC;IAC9DD,MAAM,CAAC3B,+BAA+B,CAACoC,SAAS,CAAC,CAAC,CAACR,IAAI,CAAC,KAAK,CAAC;EAChE,CAAC,CAAC;EAEFF,EAAE,CAAC,sEAAsE,EAAE,MAAM;IAAA,IAAAW,iBAAA;IAC/E,MAAMC,IAAc,GAAG,EAAE;IACzB,MAAMC,UAAkC,GAAG;MACzC5B,KAAK,EAAE;QACL,gBAAgB,EAAE6B,IAAA;UAAA,IAAG/B,QAAQ,GAAA+B,IAAA,CAAR/B,QAAQ;UAAA,oBAC3Bb,aAAa,CAACC,QAAQ,EAAE,IAAI,EAAEY,QAAQ,CAAC;QAAA;MAC3C,CAAC;MACDgC,OAAO,EAAE;QACPP,OAAO,EAAEQ,KAAA;UAAA,IAAGjC,QAAQ,GAAAiC,KAAA,CAARjC,QAAQ;UAAA,oBAAOb,aAAa,CAACC,QAAQ,EAAE,IAAI,EAAEY,QAAQ,CAAC;QAAA;MACpE,CAAC;MACDkC,aAAa,EAAEA,CAACC,IAAI,EAAErC,IAAI,KAAK;QAC7B+B,IAAI,CAACO,IAAI,CAAID,IAAI,SAAIrC,IAAM,CAAC;MAC9B;IACF,CAAC;IAEDgC,UAAU,CAACI,aAAa,YAAxBJ,UAAU,CAACI,aAAa,CAAG,QAAQ,EAAE,qBAAqB,CAAC;IAE3DhB,MAAM,CAACmB,MAAM,CAACC,IAAI,EAAAV,iBAAA,GAACE,UAAU,CAAC5B,KAAK,YAAA0B,iBAAA,GAAI,CAAC,CAAC,CAAC,CAAC,CAACF,OAAO,CAAC,CAAC,gBAAgB,CAAC,CAAC;IACvER,MAAM,CAACW,IAAI,CAAC,CAACH,OAAO,CAAC,CAAC,4BAA4B,CAAC,CAAC;EACtD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
|
|
@@ -1,18 +1,22 @@
|
|
|
1
1
|
import React, { ComponentType, ReactNode } from "react";
|
|
2
2
|
/** Heading typography of a TitledText — a component prop, not wire data. */
|
|
3
3
|
export type TitledTextVariant = "title1" | "title2" | "header2";
|
|
4
|
+
/** Props every heading in the trio accepts: content plus an optional anchor id. */
|
|
5
|
+
interface TitledTextHeadingProps {
|
|
6
|
+
id?: string;
|
|
7
|
+
children?: ReactNode;
|
|
8
|
+
}
|
|
4
9
|
/**
|
|
5
10
|
* The one heading trio the envelope renders — TitledText variants and the
|
|
6
11
|
* Portable Text `heading` / `titled-text` levels all resolve through this
|
|
7
12
|
* map, so the typography can never drift between them.
|
|
8
13
|
*/
|
|
9
|
-
export declare const titledTextHeadings: Record<TitledTextVariant, ComponentType<
|
|
10
|
-
children?: ReactNode;
|
|
11
|
-
}>>;
|
|
14
|
+
export declare const titledTextHeadings: Record<TitledTextVariant, ComponentType<TitledTextHeadingProps>>;
|
|
12
15
|
export interface ITitledTextProps extends Omit<React.ComponentPropsWithoutRef<"div">, "title"> {
|
|
13
16
|
title: string;
|
|
14
17
|
variant?: TitledTextVariant;
|
|
15
18
|
}
|
|
16
19
|
/** A heading plus body, with typography control on the heading. */
|
|
17
20
|
export declare const TitledText: React.ForwardRefExoticComponent<ITitledTextProps & React.RefAttributes<HTMLDivElement>>;
|
|
21
|
+
export {};
|
|
18
22
|
//# sourceMappingURL=TitledText.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TitledText.d.ts","sourceRoot":"","sources":["../../../../src/components/TitledText/TitledText.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAE,SAAS,EAAc,MAAM,OAAO,CAAC;AAMpE,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"TitledText.d.ts","sourceRoot":"","sources":["../../../../src/components/TitledText/TitledText.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAE,SAAS,EAAc,MAAM,OAAO,CAAC;AAMpE,4EAA4E;AAC5E,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhE,mFAAmF;AACnF,UAAU,sBAAsB;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAQD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,iBAAiB,EACjB,aAAa,CAAC,sBAAsB,CAAC,CAKtC,CAAC;AAEF,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED,mEAAmE;AACnE,eAAO,MAAM,UAAU,yFAWtB,CAAC"}
|
|
@@ -8,9 +8,13 @@ import { Header2, Title2 } from "../Typography";
|
|
|
8
8
|
|
|
9
9
|
/** Heading typography of a TitledText — a component prop, not wire data. */
|
|
10
10
|
|
|
11
|
+
/** Props every heading in the trio accepts: content plus an optional anchor id. */
|
|
12
|
+
|
|
11
13
|
const BoldTitle2 = _ref => {
|
|
12
|
-
let
|
|
14
|
+
let id = _ref.id,
|
|
15
|
+
children = _ref.children;
|
|
13
16
|
return /*#__PURE__*/React.createElement(Title2, {
|
|
17
|
+
id: id,
|
|
14
18
|
weight: "bold"
|
|
15
19
|
}, children);
|
|
16
20
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TitledText.js","names":["React","forwardRef","StyledTitle1","Stack","Header2","Title2","BoldTitle2","_ref","children","createElement","weight","titledTextHeadings","title1","title2","header2","TitledText","_ref2","ref","_titledTextHeadings$v","title","_ref2$variant","variant","rest","_objectWithoutPropertiesLoose","_excluded","Heading","_extends","space","displayName"],"sources":["../../../../src/components/TitledText/TitledText.tsx"],"sourcesContent":["import React, { ComponentType, ReactNode, forwardRef } from \"react\";\n\nimport { StyledTitle1 } from \"./Styles\";\nimport { Stack } from \"../Stack\";\nimport { Header2, Title2 } from \"../Typography\";\n\n/** Heading typography of a TitledText — a component prop, not wire data. */\nexport type TitledTextVariant = \"title1\" | \"title2\" | \"header2\";\n\
|
|
1
|
+
{"version":3,"file":"TitledText.js","names":["React","forwardRef","StyledTitle1","Stack","Header2","Title2","BoldTitle2","_ref","id","children","createElement","weight","titledTextHeadings","title1","title2","header2","TitledText","_ref2","ref","_titledTextHeadings$v","title","_ref2$variant","variant","rest","_objectWithoutPropertiesLoose","_excluded","Heading","_extends","space","displayName"],"sources":["../../../../src/components/TitledText/TitledText.tsx"],"sourcesContent":["import React, { ComponentType, ReactNode, forwardRef } from \"react\";\n\nimport { StyledTitle1 } from \"./Styles\";\nimport { Stack } from \"../Stack\";\nimport { Header2, Title2 } from \"../Typography\";\n\n/** Heading typography of a TitledText — a component prop, not wire data. */\nexport type TitledTextVariant = \"title1\" | \"title2\" | \"header2\";\n\n/** Props every heading in the trio accepts: content plus an optional anchor id. */\ninterface TitledTextHeadingProps {\n id?: string;\n children?: ReactNode;\n}\n\nconst BoldTitle2 = ({ id, children }: TitledTextHeadingProps) => (\n <Title2 id={id} weight=\"bold\">\n {children}\n </Title2>\n);\n\n/**\n * The one heading trio the envelope renders — TitledText variants and the\n * Portable Text `heading` / `titled-text` levels all resolve through this\n * map, so the typography can never drift between them.\n */\nexport const titledTextHeadings: Record<\n TitledTextVariant,\n ComponentType<TitledTextHeadingProps>\n> = {\n title1: StyledTitle1,\n title2: BoldTitle2,\n header2: Header2,\n};\n\nexport interface ITitledTextProps\n extends Omit<React.ComponentPropsWithoutRef<\"div\">, \"title\"> {\n title: string;\n variant?: TitledTextVariant;\n}\n\n/** A heading plus body, with typography control on the heading. */\nexport const TitledText = forwardRef<HTMLDivElement, ITitledTextProps>(\n ({ title, variant = \"header2\", children, ...rest }, ref) => {\n const Heading = titledTextHeadings[variant] ?? titledTextHeadings.header2;\n\n return (\n <Stack ref={ref} space={children ? \"xs\" : \"none\"} {...rest}>\n <Heading>{title}</Heading>\n {children}\n </Stack>\n );\n }\n);\n\nTitledText.displayName = \"TitledText\";\n"],"mappings":";;;AAAA,OAAOA,KAAK,IAA8BC,UAAU,QAAQ,OAAO;AAEnE,SAASC,YAAY,QAAQ,UAAU;AACvC,SAASC,KAAK,QAAQ,UAAU;AAChC,SAASC,OAAO,EAAEC,MAAM,QAAQ,eAAe;;AAE/C;;AAGA;;AAMA,MAAMC,UAAU,GAAGC,IAAA;EAAA,IAAGC,EAAE,GAAAD,IAAA,CAAFC,EAAE;IAAEC,QAAQ,GAAAF,IAAA,CAARE,QAAQ;EAAA,oBAChCT,KAAA,CAAAU,aAAA,CAACL,MAAM;IAACG,EAAE,EAAEA,EAAG;IAACG,MAAM,EAAC;EAAM,GAC1BF,QACK,CAAC;AAAA,CACV;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMG,kBAGZ,GAAG;EACFC,MAAM,EAAEX,YAAY;EACpBY,MAAM,EAAER,UAAU;EAClBS,OAAO,EAAEX;AACX,CAAC;AAQD;AACA,OAAO,MAAMY,UAAU,gBAAGf,UAAU,CAClC,CAAAgB,KAAA,EAAoDC,GAAG,KAAK;EAAA,IAAAC,qBAAA;EAAA,IAAzDC,KAAK,GAAAH,KAAA,CAALG,KAAK;IAAAC,aAAA,GAAAJ,KAAA,CAAEK,OAAO;IAAPA,OAAO,GAAAD,aAAA,cAAG,SAAS,GAAAA,aAAA;IAAEZ,QAAQ,GAAAQ,KAAA,CAARR,QAAQ;IAAKc,IAAI,GAAAC,6BAAA,CAAAP,KAAA,EAAAQ,SAAA;EAC9C,MAAMC,OAAO,IAAAP,qBAAA,GAAGP,kBAAkB,CAACU,OAAO,CAAC,YAAAH,qBAAA,GAAIP,kBAAkB,CAACG,OAAO;EAEzE,oBACEf,KAAA,CAAAU,aAAA,CAACP,KAAK,EAAAwB,QAAA;IAACT,GAAG,EAAEA,GAAI;IAACU,KAAK,EAAEnB,QAAQ,GAAG,IAAI,GAAG;EAAO,GAAKc,IAAI,gBACxDvB,KAAA,CAAAU,aAAA,CAACgB,OAAO,QAAEN,KAAe,CAAC,EACzBX,QACI,CAAC;AAEZ,CACF,CAAC;AAEDO,UAAU,CAACa,WAAW,GAAG,YAAY","ignoreList":[]}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
2
|
+
/**
|
|
3
|
+
* FeatureAvailability — a compact, data-driven block that states where a
|
|
4
|
+
* feature is available: on which hosting, on which plans and to which roles.
|
|
5
|
+
*
|
|
6
|
+
* It is the reusable version of the availability panel used in the Help Docs
|
|
7
|
+
* example articles, extracted so several stories (and, later, the real
|
|
8
|
+
* PortableText renderer) can share one implementation and one visual language:
|
|
9
|
+
*
|
|
10
|
+
* • green check → available
|
|
11
|
+
* • analog clock → decided but not shipped yet ("to be determined")
|
|
12
|
+
* • strikethrough → not included
|
|
13
|
+
*
|
|
14
|
+
* The component is theme-agnostic (all colors come from `--color-*` tokens) and
|
|
15
|
+
* self-contained (it carries its own typography, so it renders correctly
|
|
16
|
+
* outside the article body as well).
|
|
17
|
+
*/
|
|
18
|
+
export type AvailabilityStatus = "available" | "pending" | "excluded";
|
|
19
|
+
export interface AvailabilityMark {
|
|
20
|
+
label: string;
|
|
21
|
+
status: AvailabilityStatus;
|
|
22
|
+
/** Muted parenthetical, e.g. "(stable, since Jun 17 2026)". Include the parens. */
|
|
23
|
+
note?: string;
|
|
24
|
+
/** Italic muted trailing text for the pending state, e.g. "to be determined". */
|
|
25
|
+
pending?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Nested marks rendered in parentheses, e.g. Member+ (PM ✓ / FM ✓). When a
|
|
28
|
+
* mark has children it does not render its own status icon — the children
|
|
29
|
+
* carry the marks.
|
|
30
|
+
*/
|
|
31
|
+
children?: AvailabilityMark[];
|
|
32
|
+
}
|
|
33
|
+
export interface AvailabilityRow {
|
|
34
|
+
label: string;
|
|
35
|
+
items: AvailabilityMark[];
|
|
36
|
+
/** Icon before the label (Availability row) or after it (Plans / Roles). Default "after". */
|
|
37
|
+
iconPosition?: "before" | "after";
|
|
38
|
+
/** Separate items with a middot (used on the Availability row). Default false. */
|
|
39
|
+
separated?: boolean;
|
|
40
|
+
}
|
|
41
|
+
export interface FeatureAvailabilityProps {
|
|
42
|
+
rows: AvailabilityRow[];
|
|
43
|
+
className?: string;
|
|
44
|
+
}
|
|
45
|
+
export declare const FeatureAvailability: ({ rows, className, }: FeatureAvailabilityProps) => ReactElement;
|
|
46
|
+
/**
|
|
47
|
+
* A realistic GA feature: shipped on Cloud, self-hosted still to be scheduled,
|
|
48
|
+
* on every plan, for internal roles but not for clients. Exercises all three
|
|
49
|
+
* marks (check / clock / strikethrough) out of the box.
|
|
50
|
+
*/
|
|
51
|
+
export declare const DEFAULT_FEATURE_AVAILABILITY: FeatureAvailabilityProps;
|
|
52
|
+
//# sourceMappingURL=FeatureAvailability.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FeatureAvailability.d.ts","sourceRoot":"","sources":["../../../../src/presentation/shared/FeatureAvailability.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAI5C;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,kBAAkB,CAAC;IAC3B,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,6FAA6F;IAC7F,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAClC,kFAAkF;IAClF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAsMD,eAAO,MAAM,mBAAmB,GAAI,sBAGjC,wBAAwB,KAAG,YAsB7B,CAAC;AAMF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,wBA8C1C,CAAC"}
|