@stll/folio-core 0.45.0 → 0.47.0

package/dist/types/documentEnumValues.js

@@ -1,3 +1,4 @@
+import { COUNTER_FORMATS, NUMBER_FORMATS, PARAGRAPH_ALIGNMENTS, PRESET_LINE_DASH_VALS, TABLE_ALIGNMENTS, TAB_STOP_ALIGNMENTS, TEXT_DIRECTIONS } from "@stll/docx-core/model";
 //#region src/types/documentEnumValues.ts
 const SHAPE_TEXT_ANCHOR_VALUES = [
 	"top",
@@ -10,48 +11,6 @@ const normalizeShapeTextAnchor = (value) => {
 	if (value === "center") return "middle";
 	for (const anchor of SHAPE_TEXT_ANCHOR_VALUES) if (value === anchor) return anchor;
 };
-const THEME_COLOR_SLOT_VALUES = [
-	"dk1",
-	"lt1",
-	"dk2",
-	"lt2",
-	"accent1",
-	"accent2",
-	"accent3",
-	"accent4",
-	"accent5",
-	"accent6",
-	"hlink",
-	"folHlink",
-	"background1",
-	"text1",
-	"background2",
-	"text2"
-];
-const BORDER_STYLE_VALUES = [
-	"none",
-	"single",
-	"double",
-	"dotted",
-	"dashed",
-	"thick",
-	"triple",
-	"thinThickSmallGap",
-	"thickThinSmallGap",
-	"thinThickMediumGap",
-	"thickThinMediumGap",
-	"thinThickLargeGap",
-	"thickThinLargeGap",
-	"wave",
-	"doubleWave",
-	"dashSmallGap",
-	"dashDotStroked",
-	"threeDEmboss",
-	"threeDEngrave",
-	"outset",
-	"inset",
-	"nil"
-];
 const UNDERLINE_STYLE_VALUES = [
 	"none",
 	"single",
@@ -122,31 +81,22 @@ const FONT_HINT_VALUES = [
 	"eastAsia",
 	"cs"
 ];
-const PARAGRAPH_ALIGNMENT_VALUES = [
-	"left",
-	"center",
-	"right",
-	"both",
-	"distribute",
-	"mediumKashida",
-	"highKashida",
-	"lowKashida",
-	"thaiDistribute"
-];
+/**
+* `ST_Jc`, from the schema rather than spelled here: the hand-written list
+* omitted `start`, `end` and `numTab`, and every one of them was dropped at
+* parse time.
+*/
+const PARAGRAPH_ALIGNMENT_VALUES = PARAGRAPH_ALIGNMENTS;
 const LINE_SPACING_RULE_VALUES = [
 	"auto",
 	"exact",
 	"atLeast"
 ];
-const TAB_STOP_ALIGNMENT_VALUES = [
-	"left",
-	"center",
-	"right",
-	"decimal",
-	"bar",
-	"clear",
-	"num"
-];
+/**
+* `ST_TabJc`, from the schema: the hand-written list omitted `start` and
+* `end`, and a tab stop declared with either lost its alignment on save.
+*/
+const TAB_STOP_ALIGNMENT_VALUES = TAB_STOP_ALIGNMENTS;
 const TAB_LEADER_VALUES = [
 	"none",
 	"dot",
@@ -289,11 +239,11 @@ const TABLE_WIDTH_TYPE_VALUES = [
 	"nil",
 	"pct"
 ];
-const TABLE_JUSTIFICATION_VALUES = [
-	"left",
-	"center",
-	"right"
-];
+/**
+* `ST_JcTable`, from the schema: the hand-written list omitted `start` and
+* `end`, so a table written with either read as having no placement at all.
+*/
+const TABLE_JUSTIFICATION_VALUES = TABLE_ALIGNMENTS;
 const TABLE_ROW_HEIGHT_RULE_VALUES = [
 	"auto",
 	"atLeast",
@@ -304,17 +254,12 @@ const TABLE_CELL_VERTICAL_ALIGNMENT_VALUES = [
 	"center",
 	"bottom"
 ];
-const TABLE_CELL_TEXT_DIRECTION_VALUES = [
-	"lr",
-	"lrV",
-	"rl",
-	"rlV",
-	"tb",
-	"tbV",
-	"tbRl",
-	"tbRlV",
-	"btLr"
-];
+/**
+* `ST_TextDirection`, from the schema: the hand-written list omitted `lrTb`,
+* `lrTbV` and `tbLrV`, so a cell written with one read as the table's flow and
+* saved without a `w:textDirection`.
+*/
+const TEXT_DIRECTION_VALUES = TEXT_DIRECTIONS;
 const SHADING_PATTERN_VALUES = [
 	"clear",
 	"solid",
@@ -599,43 +544,20 @@ const SHAPE_TYPE_VALUES = [
 	"swooshArrow",
 	"textBox"
 ];
-const SHAPE_OUTLINE_STYLE_VALUES = [
-	"solid",
-	"dot",
-	"dash",
-	"lgDash",
-	"dashDot",
-	"lgDashDot",
-	"lgDashDotDot",
-	"sysDot",
-	"sysDash",
-	"sysDashDot",
-	"sysDashDotDot"
-];
 /**
 * CSS border-style names folio historically stored on `outlineStyle`. They are
 * NOT part of OOXML `ST_PresetLineDashVal`; they exist only because the node
 * kept CSS values. This tuple is the single source of truth for which aliases
-* are accepted — both the serializer (`normalizeShapeOutlineStyle`) and the
-* attr allow-list ({@link OUTLINE_STYLE_ATTR_VALUES}) derive from it, so they
-* cannot drift apart. eigenpal #694.
+* are accepted, and {@link OUTLINE_ATTR_PRESET_DASHES} is total over the
+* vocabulary they help build, so an alias cannot be listed without a dash.
+* eigenpal #694.
 */
 const OUTLINE_STYLE_CSS_ALIAS_VALUES = ["dashed", "dotted"];
 /**
-* Each folio CSS alias and the OOXML dash style it serializes to. The
-* `satisfies` keeps every alias key (from {@link OUTLINE_STYLE_CSS_ALIAS_VALUES})
-* present and pointed at a real `ShapeOutline["style"]`, so an alias can never
-* be listed without a mapping.
-*/
-const OUTLINE_STYLE_CSS_ALIASES = {
-	dashed: "dash",
-	dotted: "dot"
-};
-/**
 * Allowed `outlineStyle` values for the shape / text-box ProseMirror attribute:
-* the complete OOXML `ST_PresetLineDashVal` set ({@link
-* SHAPE_OUTLINE_STYLE_VALUES}, single-sourced from the docx-core model), the
-* folio CSS aliases ({@link OUTLINE_STYLE_CSS_ALIAS_VALUES}), and the `"none"`
+* the complete OOXML `ST_PresetLineDashVal` set ({@link PRESET_LINE_DASH_VALS},
+* derived from the committed schema graph), the folio CSS aliases
+* ({@link OUTLINE_STYLE_CSS_ALIAS_VALUES}), and the `"none"`
 * sentinel — an explicit "no outline" the author can choose, distinct from an
 * unset style (which falls back to the node default). The DOCX serializer
 * suppresses the `<a:ln>` element for `"none"` and maps the aliases to OOXML, so
@@ -644,79 +566,55 @@ const OUTLINE_STYLE_CSS_ALIASES = {
 * validation. eigenpal #694.
 */
 const OUTLINE_STYLE_ATTR_VALUES = [
-	...SHAPE_OUTLINE_STYLE_VALUES,
+	...PRESET_LINE_DASH_VALS,
 	...OUTLINE_STYLE_CSS_ALIAS_VALUES,
 	"none"
 ];
-const NUMBER_FORMAT_VALUES = [
-	"decimal",
-	"upperRoman",
-	"lowerRoman",
-	"upperLetter",
-	"lowerLetter",
-	"ordinal",
-	"cardinalText",
-	"ordinalText",
-	"hex",
-	"chicago",
-	"ideographDigital",
-	"japaneseCounting",
-	"aiueo",
-	"iroha",
-	"decimalFullWidth",
-	"decimalHalfWidth",
-	"japaneseLegal",
-	"japaneseDigitalTenThousand",
-	"decimalEnclosedCircle",
-	"decimalFullWidth2",
-	"aiueoFullWidth",
-	"irohaFullWidth",
-	"decimalZero",
-	"decimalZero3",
-	"decimalZero4",
-	"decimalZero5",
-	"bullet",
-	"ganada",
-	"chosung",
-	"decimalEnclosedFullstop",
-	"decimalEnclosedParen",
-	"decimalEnclosedCircleChinese",
-	"ideographEnclosedCircle",
-	"ideographTraditional",
-	"ideographZodiac",
-	"ideographZodiacTraditional",
-	"taiwaneseCounting",
-	"ideographLegalTraditional",
-	"taiwaneseCountingThousand",
-	"taiwaneseDigital",
-	"chineseCounting",
-	"chineseLegalSimplified",
-	"chineseCountingThousand",
-	"koreanDigital",
-	"koreanCounting",
-	"koreanLegal",
-	"koreanDigital2",
-	"vietnameseCounting",
-	"russianLower",
-	"russianUpper",
-	"none",
-	"numberInDash",
-	"hebrew1",
-	"hebrew2",
-	"arabicAlpha",
-	"arabicAbjad",
-	"hindiVowels",
-	"hindiConsonants",
-	"hindiNumbers",
-	"hindiCounting",
-	"thaiLetters",
-	"thaiNumbers",
-	"thaiCounting"
-];
+const OUTLINE_ATTR_DASHES_BY_VALUE = new Map(Object.entries({
+	solid: "solid",
+	dot: "dot",
+	dash: "dash",
+	lgDash: "lgDash",
+	dashDot: "dashDot",
+	lgDashDot: "lgDashDot",
+	lgDashDotDot: "lgDashDotDot",
+	sysDash: "sysDash",
+	sysDot: "sysDot",
+	sysDashDot: "sysDashDot",
+	sysDashDotDot: "sysDashDotDot",
+	dashed: "dash",
+	dotted: "dot",
+	none: "none"
+}));
+/**
+* The dash an `outlineStyle` attribute names, `"none"` for the sentinel, or
+* `undefined` for a value outside the attribute's vocabulary.
+*/
+const presetDashForOutlineAttr = (value) => value === void 0 ? void 0 : OUTLINE_ATTR_DASHES_BY_VALUE.get(value);
+/**
+* The `outlineStyle` attribute a parsed dash travels on.
+*
+* The attribute's vocabulary is closed, so a `@val` the schema does not
+* declare cannot ride the node; it reaches the editor as the plain line it
+* paints. The authored token still survives a parse and save that does not
+* rebuild the outline, because the serializer replays `ShapeOutline.rawXml`.
+*/
+const outlineAttrForDash = (dash) => {
+	if (dash === void 0) return;
+	return typeof dash === "string" ? dash : "solid";
+};
+/**
+* `ST_NumberFormat`, from the schema: the hand-written list omitted
+* `bahtText`, `dollarText` and `custom`, and carried three `decimalZeroN`
+* members the format does not declare at all.
+*/
+const NUMBER_FORMAT_VALUES = NUMBER_FORMATS;
+/** What a marker may count in, which is wider than what a `w:numFmt` may say. */
+const COUNTER_FORMAT_VALUES = COUNTER_FORMATS;
 const LEVEL_SUFFIX_VALUES = [
 	"tab",
 	"space",
 	"nothing"
 ];
 //#endregion
-export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, normalizeShapeTextAnchor };
+export { CONDITIONAL_STYLE_TYPE_VALUES, COUNTER_FORMAT_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIAS_VALUES, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_DIRECTION_VALUES, TEXT_EFFECT_VALUES, UNDERLINE_STYLE_VALUES, normalizeShapeTextAnchor, outlineAttrForDash, presetDashForOutlineAttr };

package/dist/types/formatting.d.ts

@@ -1,2 +1,2 @@
-import { CellMargins, ConditionalFormatStyle, EmphasisMark, FloatingTableProperties, LineSpacingRule, ParagraphAlignment, ParagraphFormatting, SpacingExplicit, TabLeader, TabStop, TabStopAlignment, TableBorders, TableCellFormatting, TableFormatting, TableLook, TableMeasurement, TableRowFormatting, TableWidthType, TextEffect, TextFormatting, UnderlineStyle } from "@stll/docx-core/model";
-export type { CellMargins, ConditionalFormatStyle, EmphasisMark, FloatingTableProperties, LineSpacingRule, ParagraphAlignment, ParagraphFormatting, SpacingExplicit, TabLeader, TabStop, TabStopAlignment, TableBorders, TableCellFormatting, TableFormatting, TableLook, TableMeasurement, TableRowFormatting, TableWidthType, TextEffect, TextFormatting, UnderlineStyle };
+import { CellMargins, ConditionalFormatStyle, EmphasisMark, FloatingTableProperties, LineSpacingRule, ParagraphAlignment, ParagraphFormatting, SpacingExplicit, TabLeader, TabStop, TabStopAlignment, TableAlignment, TableBorders, TableCellFormatting, TableFormatting, TableGridChange, TableLook, TableMeasurement, TableRowFormatting, TableWidthType, TextDirection, TextEffect, TextFormatting, UnderlineStyle } from "@stll/docx-core/model";
+export type { CellMargins, ConditionalFormatStyle, EmphasisMark, FloatingTableProperties, LineSpacingRule, ParagraphAlignment, ParagraphFormatting, SpacingExplicit, TabLeader, TabStop, TabStopAlignment, TableAlignment, TableBorders, TableCellFormatting, TableFormatting, TableGridChange, TableLook, TableMeasurement, TableRowFormatting, TableWidthType, TextDirection, TextEffect, TextFormatting, UnderlineStyle };

package/dist/types/index.d.ts

@@ -17,6 +17,7 @@ type DocxConformanceClass = document_d_exports.DocxConformanceClass;
 type DocxPackage = document_d_exports.DocxPackage;
 type DrawingContent = document_d_exports.DrawingContent;
 type DrawingRawXmlMode = document_d_exports.DrawingRawXmlMode;
+type EmbeddedFontRef = document_d_exports.EmbeddedFontRef;
 type EmphasisMark = document_d_exports.EmphasisMark;
 type Endnote = document_d_exports.Endnote;
 type EndnotePosition = document_d_exports.EndnotePosition;
@@ -25,6 +26,7 @@ type Field = document_d_exports.Field;
 type FieldCharContent = document_d_exports.FieldCharContent;
 type FieldType = document_d_exports.FieldType;
 type FloatingTableProperties = document_d_exports.FloatingTableProperties;
+type FontCharset = document_d_exports.FontCharset;
 type FontInfo = document_d_exports.FontInfo;
 type FontTable = document_d_exports.FontTable;
 type FooterReference = document_d_exports.FooterReference;
@@ -43,6 +45,8 @@ type ImageSize = document_d_exports.ImageSize;
 type ImageTransform = document_d_exports.ImageTransform;
 type ImageWrap = document_d_exports.ImageWrap;
 type InstrTextContent = document_d_exports.InstrTextContent;
+type LevelLegacy = document_d_exports.LevelLegacy;
+type LevelOverride = document_d_exports.LevelOverride;
 type LevelSuffix = document_d_exports.LevelSuffix;
 type LineNumberRestart = document_d_exports.LineNumberRestart;
 type LineSpacingRule = document_d_exports.LineSpacingRule;
@@ -66,6 +70,7 @@ type RelationshipMap = document_d_exports.RelationshipMap;
 type RelationshipType = document_d_exports.RelationshipType;
 type Run = document_d_exports.Run;
 type RunContent = document_d_exports.RunContent;
+type SchemeColorSlot = document_d_exports.SchemeColorSlot;
 type Section = document_d_exports.Section;
 type SectionProperties = document_d_exports.SectionProperties;
 type SectionStart = document_d_exports.SectionStart;
@@ -92,6 +97,7 @@ type TableBorders = document_d_exports.TableBorders;
 type TableCell = document_d_exports.TableCell;
 type TableCellFormatting = document_d_exports.TableCellFormatting;
 type TableFormatting = document_d_exports.TableFormatting;
+type TableGridChange = document_d_exports.TableGridChange;
 type TableLook = document_d_exports.TableLook;
 type TableMeasurement = document_d_exports.TableMeasurement;
 type TableRow = document_d_exports.TableRow;
@@ -102,10 +108,11 @@ type TextContent = document_d_exports.TextContent;
 type TextEffect = document_d_exports.TextEffect;
 type TextFormatting = document_d_exports.TextFormatting;
 type Theme = document_d_exports.Theme;
+type ThemeColor = document_d_exports.ThemeColor;
 type ThemeColorScheme = document_d_exports.ThemeColorScheme;
-type ThemeColorSlot = document_d_exports.ThemeColorSlot;
+type ThemeColorValue = document_d_exports.ThemeColorValue;
 type ThemeFont = document_d_exports.ThemeFont;
 type ThemeFontScheme = document_d_exports.ThemeFontScheme;
 type UnderlineStyle = document_d_exports.UnderlineStyle;
 type VerticalAlign = document_d_exports.VerticalAlign;
-export type { AbstractNumbering, BlockContent, BookmarkEnd, BookmarkStart, BorderSpec, BreakContent, CellMargins, ColorValue, Column, ComplexField, ConditionalFormatStyle, DocDefaults, Document, DocumentBody, DocxConformanceClass, DocxPackage, DrawingContent, DrawingRawXmlMode, EmphasisMark, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FloatingTableProperties, FontInfo, FontTable, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, InstrTextContent, LevelSuffix, LineNumberRestart, LineSpacingRule, ListLevel, ListRendering, MediaFile, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, NumberFormat, NumberingDefinitions, NumberingInstance, PageOrientation, Paragraph, ParagraphAlignment, ParagraphContent, ParagraphFormatting, PositionalTab, Relationship, RelationshipMap, RelationshipType, Run, RunContent, Section, SectionProperties, SectionStart, ShadingProperties, Shape, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, Style, StyleDefinitions, StyleType, SymbolContent, TabContent, TabLeader, TabStop, TabStopAlignment, Table, TableBorders, TableCell, TableCellFormatting, TableFormatting, TableLook, TableMeasurement, TableRow, TableRowFormatting, TableWidthType, TextBox, TextContent, TextEffect, TextFormatting, Theme, ThemeColorScheme, ThemeColorSlot, ThemeFont, ThemeFontScheme, UnderlineStyle, VerticalAlign };
+export type { AbstractNumbering, BlockContent, BookmarkEnd, BookmarkStart, BorderSpec, BreakContent, CellMargins, ColorValue, Column, ComplexField, ConditionalFormatStyle, DocDefaults, Document, DocumentBody, DocxConformanceClass, DocxPackage, DrawingContent, DrawingRawXmlMode, EmbeddedFontRef, EmphasisMark, Endnote, EndnotePosition, EndnoteProperties, Field, FieldCharContent, FieldType, FloatingTableProperties, FontCharset, FontInfo, FontTable, FooterReference, Footnote, FootnotePosition, FootnoteProperties, HeaderFooter, HeaderFooterType, HeaderReference, Hyperlink, Image, ImageCrop, ImagePadding, ImagePosition, ImageSize, ImageTransform, ImageWrap, InstrTextContent, LevelLegacy, LevelOverride, LevelSuffix, LineNumberRestart, LineSpacingRule, ListLevel, ListRendering, MediaFile, NoBreakHyphenContent, NoteNumberRestart, NoteReferenceContent, NumberFormat, NumberingDefinitions, NumberingInstance, PageOrientation, Paragraph, ParagraphAlignment, ParagraphContent, ParagraphFormatting, PositionalTab, Relationship, RelationshipMap, RelationshipType, Run, RunContent, SchemeColorSlot, Section, SectionProperties, SectionStart, ShadingProperties, Shape, ShapeContent, ShapeFill, ShapeGeometryAdjustment, ShapeOutline, ShapeTextBody, ShapeType, SimpleField, SoftHyphenContent, Style, StyleDefinitions, StyleType, SymbolContent, TabContent, TabLeader, TabStop, TabStopAlignment, Table, TableBorders, TableCell, TableCellFormatting, TableFormatting, TableGridChange, TableLook, TableMeasurement, TableRow, TableRowFormatting, TableWidthType, TextBox, TextContent, TextEffect, TextFormatting, Theme, ThemeColor, ThemeColorScheme, ThemeColorValue, ThemeFont, ThemeFontScheme, UnderlineStyle, VerticalAlign };

package/dist/utils/borderCss.d.ts

@@ -0,0 +1,246 @@
+import { BorderStyleValue, PresetLineDashVal, PresetLineDashValue } from "@stll/docx-core/model";
+//#region src/utils/borderCss.d.ts
+/** The CSS `border-style` keywords folio paints a border with, in one tuple. */
+declare const CSS_BORDER_STYLE_VALUES: readonly ["none", "solid", "double", "dotted", "dashed", "groove", "ridge", "inset", "outset"];
+/** The CSS `border-style` keywords folio paints a border with. */
+type CssBorderStyle = (typeof CSS_BORDER_STYLE_VALUES)[number];
+/**
+ * Read the CSS keyword an editor attribute carries into the union folio paints.
+ *
+ * The attribute is a bare `string` because a host may write any CSS keyword
+ * into it. A keyword folio does not paint is not guessed at: the caller gets
+ * `undefined` and applies its own default.
+ */
+declare const cssBorderStyleOf: (value: string | undefined) => CssBorderStyle | undefined;
+/**
+ * Every `ST_Border` member's CSS rendering.
+ *
+ * The art borders (`apples` … `zigZagStitch`) and the gap-patterned line
+ * styles degrade to a plain line, which is how Word itself degrades where the
+ * specialised glyphs are unavailable; folio paints the underlying line and
+ * round-trips the member. `custom` names art supplied by a relationship, so it
+ * degrades the same way.
+ */
+declare const CSS_BORDER_STYLES: {
+  readonly nil: "none";
+  readonly none: "none";
+  readonly single: "solid";
+  readonly thick: "solid";
+  readonly double: "double";
+  readonly dotted: "dotted";
+  readonly dashed: "dashed";
+  readonly dotDash: "dashed";
+  readonly dotDotDash: "dotted";
+  readonly triple: "double";
+  readonly thinThickSmallGap: "double";
+  readonly thickThinSmallGap: "double";
+  readonly thinThickThinSmallGap: "double";
+  readonly thinThickMediumGap: "double";
+  readonly thickThinMediumGap: "double";
+  readonly thinThickThinMediumGap: "double";
+  readonly thinThickLargeGap: "double";
+  readonly thickThinLargeGap: "double";
+  readonly thinThickThinLargeGap: "double";
+  readonly wave: "solid";
+  readonly doubleWave: "double";
+  readonly dashSmallGap: "dashed";
+  readonly dashDotStroked: "dashed";
+  readonly threeDEmboss: "ridge";
+  readonly threeDEngrave: "groove";
+  readonly outset: "outset";
+  readonly inset: "inset";
+  readonly apples: "solid";
+  readonly archedScallops: "solid";
+  readonly babyPacifier: "solid";
+  readonly babyRattle: "solid";
+  readonly balloons3Colors: "solid";
+  readonly balloonsHotAir: "solid";
+  readonly basicBlackDashes: "solid";
+  readonly basicBlackDots: "solid";
+  readonly basicBlackSquares: "solid";
+  readonly basicThinLines: "solid";
+  readonly basicWhiteDashes: "solid";
+  readonly basicWhiteDots: "solid";
+  readonly basicWhiteSquares: "solid";
+  readonly basicWideInline: "solid";
+  readonly basicWideMidline: "solid";
+  readonly basicWideOutline: "solid";
+  readonly bats: "solid";
+  readonly birds: "solid";
+  readonly birdsFlight: "solid";
+  readonly cabins: "solid";
+  readonly cakeSlice: "solid";
+  readonly candyCorn: "solid";
+  readonly celticKnotwork: "solid";
+  readonly certificateBanner: "solid";
+  readonly chainLink: "solid";
+  readonly champagneBottle: "solid";
+  readonly checkedBarBlack: "solid";
+  readonly checkedBarColor: "solid";
+  readonly checkered: "solid";
+  readonly christmasTree: "solid";
+  readonly circlesLines: "solid";
+  readonly circlesRectangles: "solid";
+  readonly classicalWave: "solid";
+  readonly clocks: "solid";
+  readonly compass: "solid";
+  readonly confetti: "solid";
+  readonly confettiGrays: "solid";
+  readonly confettiOutline: "solid";
+  readonly confettiStreamers: "solid";
+  readonly confettiWhite: "solid";
+  readonly cornerTriangles: "solid";
+  readonly couponCutoutDashes: "solid";
+  readonly couponCutoutDots: "solid";
+  readonly crazyMaze: "solid";
+  readonly creaturesButterfly: "solid";
+  readonly creaturesFish: "solid";
+  readonly creaturesInsects: "solid";
+  readonly creaturesLadyBug: "solid";
+  readonly crossStitch: "solid";
+  readonly cup: "solid";
+  readonly decoArch: "solid";
+  readonly decoArchColor: "solid";
+  readonly decoBlocks: "solid";
+  readonly diamondsGray: "solid";
+  readonly doubleD: "solid";
+  readonly doubleDiamonds: "solid";
+  readonly earth1: "solid";
+  readonly earth2: "solid";
+  readonly earth3: "solid";
+  readonly eclipsingSquares1: "solid";
+  readonly eclipsingSquares2: "solid";
+  readonly eggsBlack: "solid";
+  readonly fans: "solid";
+  readonly film: "solid";
+  readonly firecrackers: "solid";
+  readonly flowersBlockPrint: "solid";
+  readonly flowersDaisies: "solid";
+  readonly flowersModern1: "solid";
+  readonly flowersModern2: "solid";
+  readonly flowersPansy: "solid";
+  readonly flowersRedRose: "solid";
+  readonly flowersRoses: "solid";
+  readonly flowersTeacup: "solid";
+  readonly flowersTiny: "solid";
+  readonly gems: "solid";
+  readonly gingerbreadMan: "solid";
+  readonly gradient: "solid";
+  readonly handmade1: "solid";
+  readonly handmade2: "solid";
+  readonly heartBalloon: "solid";
+  readonly heartGray: "solid";
+  readonly hearts: "solid";
+  readonly heebieJeebies: "solid";
+  readonly holly: "solid";
+  readonly houseFunky: "solid";
+  readonly hypnotic: "solid";
+  readonly iceCreamCones: "solid";
+  readonly lightBulb: "solid";
+  readonly lightning1: "solid";
+  readonly lightning2: "solid";
+  readonly mapPins: "solid";
+  readonly mapleLeaf: "solid";
+  readonly mapleMuffins: "solid";
+  readonly marquee: "solid";
+  readonly marqueeToothed: "solid";
+  readonly moons: "solid";
+  readonly mosaic: "solid";
+  readonly musicNotes: "solid";
+  readonly northwest: "solid";
+  readonly ovals: "solid";
+  readonly packages: "solid";
+  readonly palmsBlack: "solid";
+  readonly palmsColor: "solid";
+  readonly paperClips: "solid";
+  readonly papyrus: "solid";
+  readonly partyFavor: "solid";
+  readonly partyGlass: "solid";
+  readonly pencils: "solid";
+  readonly people: "solid";
+  readonly peopleWaving: "solid";
+  readonly peopleHats: "solid";
+  readonly poinsettias: "solid";
+  readonly postageStamp: "solid";
+  readonly pumpkin1: "solid";
+  readonly pushPinNote2: "solid";
+  readonly pushPinNote1: "solid";
+  readonly pyramids: "solid";
+  readonly pyramidsAbove: "solid";
+  readonly quadrants: "solid";
+  readonly rings: "solid";
+  readonly safari: "solid";
+  readonly sawtooth: "solid";
+  readonly sawtoothGray: "solid";
+  readonly scaredCat: "solid";
+  readonly seattle: "solid";
+  readonly shadowedSquares: "solid";
+  readonly sharksTeeth: "solid";
+  readonly shorebirdTracks: "solid";
+  readonly skyrocket: "solid";
+  readonly snowflakeFancy: "solid";
+  readonly snowflakes: "solid";
+  readonly sombrero: "solid";
+  readonly southwest: "solid";
+  readonly stars: "solid";
+  readonly starsTop: "solid";
+  readonly stars3d: "solid";
+  readonly starsBlack: "solid";
+  readonly starsShadowed: "solid";
+  readonly sun: "solid";
+  readonly swirligig: "solid";
+  readonly tornPaper: "solid";
+  readonly tornPaperBlack: "solid";
+  readonly trees: "solid";
+  readonly triangleParty: "solid";
+  readonly triangles: "solid";
+  readonly triangle1: "solid";
+  readonly triangle2: "solid";
+  readonly triangleCircle1: "solid";
+  readonly triangleCircle2: "solid";
+  readonly shapes1: "solid";
+  readonly shapes2: "solid";
+  readonly twistedLines1: "solid";
+  readonly twistedLines2: "solid";
+  readonly vine: "solid";
+  readonly waveline: "solid";
+  readonly weavingAngles: "solid";
+  readonly weavingBraid: "solid";
+  readonly weavingRibbon: "solid";
+  readonly weavingStrips: "solid";
+  readonly whiteFlowers: "solid";
+  readonly woodwork: "solid";
+  readonly xIllusions: "solid";
+  readonly zanyTriangles: "solid";
+  readonly zigZag: "solid";
+  readonly zigZagStitch: "solid";
+  readonly custom: "solid";
+};
+/**
+ * Whether a laid-out border paints a line.
+ *
+ * Only an explicit `none` does not: a border with a width but no style paints
+ * the CSS initial `solid`, which is what the measurers and the painter have
+ * always assumed. The argument is a CSS keyword, never an `ST_Border` member —
+ * `nil` cannot reach here, which is what typing `BorderStyle.style` bought.
+ */
+declare const paintsCssBorder: (style: CssBorderStyle | undefined) => boolean;
+/**
+ * The CSS `border-style` for a parsed `w:val`.
+ *
+ * A token the schema does not declare paints as a plain line: the member is
+ * kept for the round trip, but nothing can be inferred about how it draws.
+ */
+declare const cssBorderStyle: (style: BorderStyleValue | undefined) => CssBorderStyle;
+/**
+ * The CSS `border-style` for a parsed `a:prstDash@val`.
+ *
+ * A token the schema does not declare paints as a plain line, the way an
+ * undeclared `ST_Border` member does: the member is kept for the round trip,
+ * but nothing can be inferred about how it draws.
+ */
+declare const cssBorderStyleForDash: (dash: PresetLineDashValue | undefined) => CssBorderStyle;
+/** The preset dash an authored CSS border style serializes to. */
+declare const presetDashForCssBorderStyle: (style: string | undefined) => PresetLineDashVal;
+//#endregion
+export { CSS_BORDER_STYLES, CSS_BORDER_STYLE_VALUES, CssBorderStyle, cssBorderStyle, cssBorderStyleForDash, cssBorderStyleOf, paintsCssBorder, presetDashForCssBorderStyle };