@stll/folio-core 0.0.1-placeholder.0 → 0.1.0

package/dist/types/documentEnumValues.js

@@ -0,0 +1,693 @@
+//#region src/types/documentEnumValues.ts
+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",
+	"words",
+	"double",
+	"thick",
+	"dotted",
+	"dottedHeavy",
+	"dash",
+	"dashedHeavy",
+	"dashLong",
+	"dashLongHeavy",
+	"dotDash",
+	"dashDotHeavy",
+	"dotDotDash",
+	"dashDotDotHeavy",
+	"wave",
+	"wavyHeavy",
+	"wavyDouble"
+];
+const HIGHLIGHT_COLOR_VALUES = [
+	"black",
+	"blue",
+	"cyan",
+	"darkBlue",
+	"darkCyan",
+	"darkGray",
+	"darkGreen",
+	"darkMagenta",
+	"darkRed",
+	"darkYellow",
+	"green",
+	"lightGray",
+	"magenta",
+	"none",
+	"red",
+	"white",
+	"yellow"
+];
+const TEXT_EFFECT_VALUES = [
+	"none",
+	"blinkBackground",
+	"lights",
+	"antsBlack",
+	"antsRed",
+	"shimmer",
+	"sparkle"
+];
+const EMPHASIS_MARK_VALUES = [
+	"none",
+	"dot",
+	"comma",
+	"circle",
+	"underDot"
+];
+const FONT_THEME_VALUES = [
+	"majorAscii",
+	"majorHAnsi",
+	"majorEastAsia",
+	"majorBidi",
+	"minorAscii",
+	"minorHAnsi",
+	"minorEastAsia",
+	"minorBidi"
+];
+const PARAGRAPH_ALIGNMENT_VALUES = [
+	"left",
+	"center",
+	"right",
+	"both",
+	"distribute",
+	"mediumKashida",
+	"highKashida",
+	"lowKashida",
+	"thaiDistribute"
+];
+const LINE_SPACING_RULE_VALUES = [
+	"auto",
+	"exact",
+	"atLeast"
+];
+const TAB_STOP_ALIGNMENT_VALUES = [
+	"left",
+	"center",
+	"right",
+	"decimal",
+	"bar",
+	"clear",
+	"num"
+];
+const TAB_LEADER_VALUES = [
+	"none",
+	"dot",
+	"hyphen",
+	"underscore",
+	"heavy",
+	"middleDot"
+];
+const FRAME_X_ALIGN_VALUES = [
+	"left",
+	"center",
+	"right",
+	"inside",
+	"outside"
+];
+const FRAME_Y_ALIGN_VALUES = [
+	"top",
+	"center",
+	"bottom",
+	"inside",
+	"outside",
+	"inline"
+];
+const FRAME_WRAP_VALUES = [
+	"around",
+	"auto",
+	"none",
+	"notBeside",
+	"through",
+	"tight"
+];
+const SDT_LOCK_VALUES = [
+	"sdtLocked",
+	"contentLocked",
+	"sdtContentLocked",
+	"unlocked"
+];
+const SDT_TYPE_VALUES = [
+	"richText",
+	"plainText",
+	"date",
+	"dropdown",
+	"comboBox",
+	"checkbox",
+	"picture",
+	"buildingBlockGallery",
+	"group",
+	"unknown"
+];
+const FIELD_TYPE_VALUES = [
+	"PAGE",
+	"NUMPAGES",
+	"NUMWORDS",
+	"NUMCHARS",
+	"DATE",
+	"TIME",
+	"CREATEDATE",
+	"SAVEDATE",
+	"PRINTDATE",
+	"AUTHOR",
+	"TITLE",
+	"SUBJECT",
+	"KEYWORDS",
+	"COMMENTS",
+	"FILENAME",
+	"FILESIZE",
+	"TEMPLATE",
+	"DOCPROPERTY",
+	"DOCVARIABLE",
+	"REF",
+	"PAGEREF",
+	"NOTEREF",
+	"HYPERLINK",
+	"TOC",
+	"TOA",
+	"INDEX",
+	"SEQ",
+	"STYLEREF",
+	"AUTONUM",
+	"AUTONUMLGL",
+	"AUTONUMOUT",
+	"LISTNUM",
+	"IF",
+	"MERGEFIELD",
+	"NEXT",
+	"NEXTIF",
+	"ASK",
+	"SET",
+	"QUOTE",
+	"INCLUDETEXT",
+	"INCLUDEPICTURE",
+	"SYMBOL",
+	"ADVANCE",
+	"EDITTIME",
+	"REVNUM",
+	"SECTION",
+	"SECTIONPAGES",
+	"USERADDRESS",
+	"USERNAME",
+	"USERINITIALS",
+	"UNKNOWN"
+];
+const STYLE_TYPE_VALUES = [
+	"paragraph",
+	"character",
+	"numbering",
+	"table"
+];
+const CONDITIONAL_STYLE_TYPE_VALUES = [
+	"band1Horz",
+	"band1Vert",
+	"band2Horz",
+	"band2Vert",
+	"firstCol",
+	"firstRow",
+	"lastCol",
+	"lastRow",
+	"neCell",
+	"nwCell",
+	"seCell",
+	"swCell",
+	"wholeTable"
+];
+const TABLE_WIDTH_TYPE_VALUES = [
+	"auto",
+	"dxa",
+	"nil",
+	"pct"
+];
+const TABLE_JUSTIFICATION_VALUES = [
+	"left",
+	"center",
+	"right"
+];
+const TABLE_ROW_HEIGHT_RULE_VALUES = [
+	"auto",
+	"atLeast",
+	"exact"
+];
+const TABLE_CELL_VERTICAL_ALIGNMENT_VALUES = [
+	"top",
+	"center",
+	"bottom"
+];
+const TABLE_CELL_TEXT_DIRECTION_VALUES = [
+	"lr",
+	"lrV",
+	"rl",
+	"rlV",
+	"tb",
+	"tbV",
+	"tbRl",
+	"tbRlV",
+	"btLr"
+];
+const SHADING_PATTERN_VALUES = [
+	"clear",
+	"solid",
+	"horzStripe",
+	"vertStripe",
+	"reverseDiagStripe",
+	"diagStripe",
+	"horzCross",
+	"diagCross",
+	"thinHorzStripe",
+	"thinVertStripe",
+	"thinReverseDiagStripe",
+	"thinDiagStripe",
+	"thinHorzCross",
+	"thinDiagCross",
+	"pct5",
+	"pct10",
+	"pct12",
+	"pct15",
+	"pct20",
+	"pct25",
+	"pct30",
+	"pct35",
+	"pct37",
+	"pct40",
+	"pct45",
+	"pct50",
+	"pct55",
+	"pct60",
+	"pct62",
+	"pct65",
+	"pct70",
+	"pct75",
+	"pct80",
+	"pct85",
+	"pct87",
+	"pct90",
+	"pct95",
+	"nil"
+];
+const FLOATING_TABLE_X_SPEC_VALUES = [
+	"left",
+	"center",
+	"right",
+	"inside",
+	"outside"
+];
+const FLOATING_TABLE_Y_SPEC_VALUES = [
+	"top",
+	"center",
+	"bottom",
+	"inside",
+	"outside",
+	"inline"
+];
+const IMAGE_WRAP_TYPE_VALUES = [
+	"inline",
+	"square",
+	"tight",
+	"through",
+	"topAndBottom",
+	"behind",
+	"inFront"
+];
+const IMAGE_HORIZONTAL_RELATIVE_TO_VALUES = [
+	"character",
+	"column",
+	"insideMargin",
+	"leftMargin",
+	"margin",
+	"outsideMargin",
+	"page",
+	"rightMargin"
+];
+const IMAGE_HORIZONTAL_ALIGNMENT_VALUES = [
+	"left",
+	"right",
+	"center",
+	"inside",
+	"outside"
+];
+const IMAGE_VERTICAL_RELATIVE_TO_VALUES = [
+	"insideMargin",
+	"line",
+	"margin",
+	"outsideMargin",
+	"page",
+	"paragraph",
+	"topMargin",
+	"bottomMargin"
+];
+const IMAGE_VERTICAL_ALIGNMENT_VALUES = [
+	"top",
+	"bottom",
+	"center",
+	"inside",
+	"outside"
+];
+const IMAGE_WRAP_TEXT_VALUES = [
+	"bothSides",
+	"left",
+	"right",
+	"largest"
+];
+/**
+* All `<a:prstGeom prst="...">` values recognised by OOXML
+* (ECMA-376 Part 1 §20.1.10.55 ST_ShapeType).
+*
+* Folio's phase-1 renderer only draws a subset (rect, roundRect, ellipse,
+* line, basic arrows); presets outside the subset round-trip via the model
+* but render as a fallback rectangle. Listing every value here keeps
+* `parseShape` strictly typed: any unknown string from a malformed DOCX is
+* narrowed to `undefined` by `narrowEnum` and falls back to `rect`, while
+* known phase-2/3 presets keep their identity for serialization.
+*/
+const SHAPE_TYPE_VALUES = [
+	"rect",
+	"roundRect",
+	"ellipse",
+	"triangle",
+	"rtTriangle",
+	"parallelogram",
+	"trapezoid",
+	"pentagon",
+	"hexagon",
+	"heptagon",
+	"octagon",
+	"decagon",
+	"dodecagon",
+	"star4",
+	"star5",
+	"star6",
+	"star7",
+	"star8",
+	"star10",
+	"star12",
+	"star16",
+	"star24",
+	"star32",
+	"line",
+	"straightConnector1",
+	"bentConnector2",
+	"bentConnector3",
+	"bentConnector4",
+	"bentConnector5",
+	"curvedConnector2",
+	"curvedConnector3",
+	"curvedConnector4",
+	"curvedConnector5",
+	"rightArrow",
+	"leftArrow",
+	"upArrow",
+	"downArrow",
+	"leftRightArrow",
+	"upDownArrow",
+	"quadArrow",
+	"leftRightUpArrow",
+	"bentArrow",
+	"uturnArrow",
+	"leftUpArrow",
+	"bentUpArrow",
+	"curvedRightArrow",
+	"curvedLeftArrow",
+	"curvedUpArrow",
+	"curvedDownArrow",
+	"stripedRightArrow",
+	"notchedRightArrow",
+	"homePlate",
+	"chevron",
+	"rightArrowCallout",
+	"downArrowCallout",
+	"leftArrowCallout",
+	"upArrowCallout",
+	"leftRightArrowCallout",
+	"quadArrowCallout",
+	"circularArrow",
+	"flowChartProcess",
+	"flowChartAlternateProcess",
+	"flowChartDecision",
+	"flowChartInputOutput",
+	"flowChartPredefinedProcess",
+	"flowChartInternalStorage",
+	"flowChartDocument",
+	"flowChartMultidocument",
+	"flowChartTerminator",
+	"flowChartPreparation",
+	"flowChartManualInput",
+	"flowChartManualOperation",
+	"flowChartConnector",
+	"flowChartOffpageConnector",
+	"flowChartPunchedCard",
+	"flowChartPunchedTape",
+	"flowChartSummingJunction",
+	"flowChartOr",
+	"flowChartCollate",
+	"flowChartSort",
+	"flowChartExtract",
+	"flowChartMerge",
+	"flowChartOnlineStorage",
+	"flowChartDelay",
+	"flowChartMagneticTape",
+	"flowChartMagneticDisk",
+	"flowChartMagneticDrum",
+	"flowChartDisplay",
+	"wedgeRectCallout",
+	"wedgeRoundRectCallout",
+	"wedgeEllipseCallout",
+	"cloudCallout",
+	"borderCallout1",
+	"borderCallout2",
+	"borderCallout3",
+	"accentCallout1",
+	"accentCallout2",
+	"accentCallout3",
+	"callout1",
+	"callout2",
+	"callout3",
+	"accentBorderCallout1",
+	"accentBorderCallout2",
+	"accentBorderCallout3",
+	"actionButtonBlank",
+	"actionButtonHome",
+	"actionButtonHelp",
+	"actionButtonInformation",
+	"actionButtonBackPrevious",
+	"actionButtonForwardNext",
+	"actionButtonBeginning",
+	"actionButtonEnd",
+	"actionButtonReturn",
+	"actionButtonDocument",
+	"actionButtonSound",
+	"actionButtonMovie",
+	"irregularSeal1",
+	"irregularSeal2",
+	"frame",
+	"halfFrame",
+	"corner",
+	"diagStripe",
+	"chord",
+	"arc",
+	"bracketPair",
+	"bracePair",
+	"leftBracket",
+	"rightBracket",
+	"leftBrace",
+	"rightBrace",
+	"can",
+	"cube",
+	"bevel",
+	"donut",
+	"noSmoking",
+	"blockArc",
+	"foldedCorner",
+	"smileyFace",
+	"heart",
+	"lightningBolt",
+	"sun",
+	"moon",
+	"cloud",
+	"snip1Rect",
+	"snip2SameRect",
+	"snip2DiagRect",
+	"snipRoundRect",
+	"round1Rect",
+	"round2SameRect",
+	"round2DiagRect",
+	"plaque",
+	"teardrop",
+	"mathPlus",
+	"mathMinus",
+	"mathMultiply",
+	"mathDivide",
+	"mathEqual",
+	"mathNotEqual",
+	"gear6",
+	"gear9",
+	"funnel",
+	"pieWedge",
+	"pie",
+	"leftCircularArrow",
+	"leftRightCircularArrow",
+	"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.
+*/
+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"`
+* 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
+* every accepted value round-trips. All three groups are kept valid (not
+* stripped) so loading a document that persisted any of them does not fail
+* validation. eigenpal #694.
+*/
+const OUTLINE_STYLE_ATTR_VALUES = [
+	...SHAPE_OUTLINE_STYLE_VALUES,
+	...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 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_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, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_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 };

package/dist/types/formatting.d.ts

@@ -0,0 +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 };