`@stesura/core/utils`

Framework-free helpers: unit conversion, number formatting, colours, links, URLs and upload validation. No ProseMirror dependency.

Functions & values

`applyNumberCasing`

Parameters:

Name	Type	Default
`text`	`string`
`casing`	`"capitalize" \| "uppercase" \| "lowercase" \| "firstLetter"`
`lang`	`string`

Returns:

string

`arrayFromNumber`

Parameters:

Name	Type	Default
`number`	`number`

Returns:

number[]

`arrayOfZeroes`

Parameters:

Name	Type	Default
`length`	`number`

Returns:

0[]

`boolFromStringOrNull`

Parameters:

Name	Type	Default
`value`	`string`

Returns:

boolean | null

`camelToKebabCase`

Parameters:

Name	Type	Default
`str`	`string`

Returns:

string

`cmToInches`

Parameters:

Name	Type	Default
`cm`	`string \| number`

Returns:

number | undefined

`cmToPoints`

Parameters:

Name	Type	Default
`cm`	`string \| number`

Returns:

number | undefined

`cmToPx`

Parameters:

Name	Type	Default
`cm`	`string \| number`

Returns:

number | undefined

`cmToTwips`

Parameters:

Name	Type	Default
`cm`	`string \| number`

Returns:

number | undefined

`cn`

Parameters:

Name	Type	Default
`inputs`	`ClassValue[]`

Returns:

string

`compareStrings`

Parameters:

Name	Type	Default
`str1`	`string`
`str2`	`string`

Returns:

boolean

`contrastTextColor`

Parameters:

Name	Type	Default
`background`	`string`

Returns:

"#000000" | "#FFFFFF" | null

`cssToReactStyle`

Parameters:

Name	Type	Default
`css`	`string`

Returns:

CSSProperties

`cssUnitToPixels`

Parameters:

Name	Type	Default
`value`	`string \| number`
`baseSize`	`number`

Returns:

number

`cssUnitToPoints`

Parameters:

Name	Type	Default
`value`	`string \| number`

Returns:

number

`deleteObjProps`

Parameters:

Name	Type	Default
`obj`	`Record<string, unknown>`
`propOrProps`	`string \| string[]`

Returns:

Record<string, unknown>

`DISPLAY_UNIT_LABELS`

Name	Type	Default
`cm`	`string`
`inches`	`string`
`pt`	`string`
`px`	`string`

`displayUnitToPx`

Parameters:

Name	Type	Default
`unit`	`DisplayUnit`
`value`	`number`

Returns:

number

`escapeRegExp`

Parameters:

Name	Type	Default
`string`	`string`

Returns:

string

`findLinkAtEnd`

Parameters:

Name	Type	Default
`text`	`string`
`options`	`DetectLinksOptions`

Returns:

DetectedLink | null

`findLinks`

Parameters:

Name	Type	Default
`text`	`string`
`options`	`DetectLinksOptions`

Returns:

DetectedLink[]

`findWholeLink`

Parameters:

Name	Type	Default
`text`	`string`
`options`	`DetectLinksOptions`

Returns:

DetectedLink | null

`formatDisplayUnit`

Parameters:

Name	Type	Default
`value`	`number`
`unit`	`DisplayUnit`

Returns:

string

`formatEndnoteNumber`

Parameters:

Name	Type	Default
`n`	`number`
`format`	`string`

Returns:

string

`generateId`

Parameters:

This function does not accept any parameters.

Returns:

string

`getInitials`

Parameters:

Name	Type	Default
`name`	`string`

Returns:

string

`getKeyboardShortcutPrefix`

Parameters:

Name	Type	Default
`shortcut`	`string`

Returns:

string | undefined

`getZoomFactor`

Parameters:

Name	Type	Default
`zoomLevel`	`number`

Returns:

number

`inchesToCm`

Parameters:

Name	Type	Default
`inches`	`string \| number`

Returns:

number | undefined

`inchesToPoints`

Parameters:

Name	Type	Default
`inches`	`string \| number`

Returns:

number | undefined

`inchesToPx`

Parameters:

Name	Type	Default
`inches`	`string \| number`

Returns:

number | undefined

`inchesToTwips`

Parameters:

Name	Type	Default
`inches`	`string \| number`

Returns:

number | undefined

`isEmbedUrlAllowed`

Parameters:

Name	Type	Default
`url`	`string`
`allowedHosts`	`string[]`

Returns:

boolean

`isForbiddenEmbedUrl`

Parameters:

Name	Type	Default
`url`	`string`

Returns:

boolean

`isoDateToDate`

Parameters:

Name	Type	Default
`isoDate`	`string \| Date`

Returns:

Date

`isRegExp`

Parameters:

Name	Type	Default
`value`	`unknown`

Returns:

boolean

`isValidHex`

Parameters:

Name	Type	Default
`hex`	`string`

Returns:

boolean

`kebabToCamelCase`

Parameters:

Name	Type	Default
`str`	`string`

Returns:

string

`localeHasGenderVariants`

Parameters:

Name	Type	Default
`localeCode`	`"ar" \| "de-DE" \| "en-GB" \| "en-US" \| "es-ES" \| "fr-FR" \| "it-IT" \| "ja-JP" \| "nl-NL" \| "pl-PL" \| "pt-BR" \| "pt-PT" \| "ru-RU" \| "uk-UA" \| "zh-CN"`

Returns:

boolean

`minMax`

Parameters:

Name	Type	Default
`value`	`number`
`min`	`number`
`max`	`number`

Returns:

number

`NUMBER_LOCALES`

Name	Type	Default
`ar`	`{ masculine: typeof Locale; }`
`de-DE`	`{ masculine: typeof Locale; }`
`en-GB`	`{ masculine: ConstructorOf<LocaleInterface>; }`
`en-US`	`{ masculine: typeof Locale; }`
`es-ES`	`{ masculine: typeof Locale; feminine: ConstructorOf<LocaleInterface>; }`
`fr-FR`	`{ masculine: typeof Locale; feminine: ConstructorOf<LocaleInterface>; }`
`it-IT`	`{ masculine: typeof Locale; feminine: ConstructorOf<LocaleInterface>; }`
`ja-JP`	`{ masculine: typeof Locale; }`
`nl-NL`	`{ masculine: typeof Locale; }`
`pl-PL`	`{ masculine: typeof Locale; }`
`pt-BR`	`{ masculine: ConstructorOf<LocaleInterface>; feminine: ConstructorOf<LocaleInterface>; }`
`pt-PT`	`{ masculine: typeof Locale; feminine: ConstructorOf<LocaleInterface>; }`
`ru-RU`	`{ masculine: typeof Locale; }`
`uk-UA`	`{ masculine: typeof Locale; }`
`zh-CN`	`{ masculine: typeof Locale; }`

`objectIncludes`

Parameters:

Name	Type	Default
`object1`	`Record<string, any>`
`object2`	`Record<string, any>`
`options`	`{ strict: boolean; }`

Returns:

boolean

`parsePtLineHeight`

Parameters:

Name	Type	Default
`value`	`unknown`

Returns:

number | null

`pointToCm`

Parameters:

Name	Type	Default
`pt`	`string \| number`

Returns:

number | undefined

`pointToInches`

Parameters:

Name	Type	Default
`pt`	`string \| number`

Returns:

number | undefined

`pointToPx`

Parameters:

Name	Type	Default
`pt`	`string \| number`

Returns:

number | undefined

`pointToTwips`

Parameters:

Name	Type	Default
`pt`	`string \| number`

Returns:

number | undefined

`ptToPxExact`

Parameters:

Name	Type	Default
`pt`	`number`

Returns:

number

`pxToCm`

Parameters:

Name	Type	Default
`px`	`string \| number`

Returns:

number | undefined

`pxToDisplayUnit`

Parameters:

Name	Type	Default
`unit`	`DisplayUnit`
`value`	`number`

Returns:

number

`pxToInches`

Parameters:

Name	Type	Default
`px`	`string \| number`

Returns:

number | undefined

`pxToPoints`

Parameters:

Name	Type	Default
`px`	`string \| number`

Returns:

number | undefined

`pxToTwips`

Parameters:

Name	Type	Default
`pixels`	`string \| number`

Returns:

number | undefined

`randomUUID`

Parameters:

This function does not accept any parameters.

Returns:

string

`removeDuplicates`

Parameters:

Name	Type	Default
`array`	`T[]`
`by`	`{ (value: any, replacer?: ((this: any, key: string, value: any) => any) \| undefined, space?: string \| number \| undefined): string; (value: any, replacer?: (string \| number)[] \| null \| undefined, space?: string \| ... 1 more ... \| undefined): string; }`

Returns:

T[]

`removeSpaces`

Parameters:

Name	Type	Default
`str`	`string`

Returns:

string

`resolveNumberLocale`

Parameters:

Name	Type	Default
`lang`	`string`

Returns:

"ar" | "de-DE" | "en-GB" | "en-US" | "es-ES" | "fr-FR" | "it-IT" | "ja-JP" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ru-RU" | "uk-UA" | "zh-CN"

`safeCssColor`

Parameters:

Name	Type	Default
`value`	`unknown`

Returns:

string | null

`safeNormalizeUrl`

Parameters:

Name	Type	Default
`url`	`string`

Returns:

string | null

`safeRawUrl`

Parameters:

Name	Type	Default
`url`	`string`

Returns:

string | null

`sanitizeStyleId`

Parameters:

Name	Type	Default
`id`	`string`

Returns:

string

`setsAreEqual`

Parameters:

Name	Type	Default
`a`	`Set<string>`
`b`	`Set<string>`

Returns:

boolean

`snapToHalfPoint`

Parameters:

Name	Type	Default
`pt`	`number`

Returns:

number

`sniffDocumentType`

Parameters:

Name	Type	Default
`file`	`Blob`
`name`	`string`

Returns:

Promise<SniffedDocumentType | null>

`sniffImageBytes`

Parameters:

Name	Type	Default
`bytes`	`Uint8Array<ArrayBufferLike>`

Returns:

SniffedImageType | null

`sniffImageType`

Parameters:

Name	Type	Default
`file`	`Blob`

Returns:

Promise<SniffedImageType | null>

`sniffPdf`

Parameters:

Name	Type	Default
`file`	`Blob`

Returns:

Promise<boolean>

`toAlphabetLetter`

Parameters:

Name	Type	Default
`i`	`number`
`alphabet`	`readonly string[]`

Returns:

string

`toAlphanumeric`

Parameters:

Name	Type	Default
`i`	`number`
`uppercase`	`boolean`

Returns:

string

`toChicago`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toDecimalZero`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toDigitSystem`

Parameters:

Name	Type	Default
`i`	`number`
`numberingSystem`	`string`

Returns:

string

`toEnclosedCircle`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toEnclosedFullstop`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toEnclosedParen`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toHex`

Parameters:

Name	Type	Default
`inputColor`	`string`
`noHash`	`boolean`

Returns:

string

`toHexNumber`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toNumberInDash`

Parameters:

Name	Type	Default
`i`	`number`

Returns:

string

`toOrdinalIndicator`

Parameters:

Name	Type	Default
`n`	`number`
`options`	`NumberWordsOptions`

Returns:

OrdinalIndicatorParts

`toOrdinalWords`

Parameters:

Name	Type	Default
`n`	`number`
`options`	`NumberWordsOptions`

Returns:

string

`toRgb`

Parameters:

Name	Type	Default
`hex`	`string`

Returns:

[number, number, number] | undefined

`toRoman`

Parameters:

Name	Type	Default
`i`	`number`
`uppercase`	`boolean`

Returns:

string

`toWords`

Parameters:

Name	Type	Default
`n`	`number`
`options`	`NumberWordsOptions`

Returns:

string

`twipsToCm`

Parameters:

Name	Type	Default
`twips`	`string \| number`

Returns:

number | undefined

`twipsToInches`

Parameters:

Name	Type	Default
`twips`	`string \| number`

Returns:

number | undefined

`twipsToPt`

Parameters:

Name	Type	Default
`twips`	`string \| number`

Returns:

number | undefined

`twipsToPx`

Parameters:

Name	Type	Default
`twips`	`string \| number`

Returns:

number | undefined

`undefinedIfNotNumber`

Parameters:

Name	Type	Default
`value`	`string \| number`

Returns:

number | undefined

`userColorSlot`

Parameters:

Name	Type	Default
`userId`	`string`
`userName`	`string`

Returns:

number | null

`validateDocumentFile`

Parameters:

Name	Type	Default
`file`	`Blob`
`options`	`{ maxBytes?: number; name?: string; }`

Returns:

Promise<FileValidationResult<SniffedDocumentType>>

`validateImageFile`

Parameters:

Name	Type	Default
`file`	`Blob`
`options`	`{ maxBytes?: number; }`

Returns:

Promise<FileValidationResult<SniffedImageType>>

`validatePdfFile`

Parameters:

Name	Type	Default
`file`	`Blob`
`options`	`{ maxBytes?: number; }`

Returns:

Promise<FileValidationResult<"application/pdf">>

`zeroIfNaN`

Parameters:

Name	Type	Default
`value`	`number`

Returns:

number

Types

`DetectedLink`

Name	Type	Default
`from`	`number`
`to`	`number`
`text`	`string` The matched text, trailing sentence punctuation already trimmed off.
`href`	`string` The href the match should carry (`mailto:` for an address).

`DetectLinksOptions`

Name	Type	Default
`bareHosts`	`boolean` Whether `host.tld` without a scheme or `www.` counts. Default true.

`FileValidationResult`

Name	Type	Default
`ok`	`boolean`

`NumberWordsOptions`

Name	Type	Default
`lang`	`string \| null` A document `proofingLanguage`; resolved via resolveNumberLocale.
`gender`	`NumberGender`

Other exports

Export	Type	Description
`ARABIC_ALPHA_LETTERS`	`readonly ["أ", "ب", "ت", "ث", …]`	Word’s `arabicAlpha`: the 28 letters in hijāʾī (alphabetical) order.
`CONTRAST_LUMINANCE_THRESHOLD`	`0.179`	Relative luminance above which black text gives the better WCAG contrast ratio against the background — below it, white does. 0.179 is the exact crossover: (L + 0.05) / 0.05 = 1.05 / (L + 0.05) solves to L ≈ 0.1791.
`FALLBACK_NUMBER_LOCALE`	`"en-GB"`	Used when a document’s language has no entry in `NUMBER_LOCALES`.
`HEBREW_LETTERS`	`readonly ["א", "ב", "ג", "ד", …]`	Word’s `hebrew2`: the 22 base letters, no final forms.
`LINE_HEIGHT_PT_MAX`	`600`
`LINE_HEIGHT_PT_MIN`	`6`	Exact line-height bounds (pt), the guard’s counterpart to the multiplier list.
`MAX_DOCUMENT_BYTES`	`number`	Size cap for a document upload (the file node).
`MAX_IMAGE_BYTES`	`number`	Default upload size cap, aligned with the upload-block dropzone.
`NUMBER_CASINGS`	`readonly ["capitalize", "uppercase", "lowercase", "firstLetter"]`	The casings a word-based number format can render in.
`NumberCasing`	`"capitalize" \| "uppercase" \| "lowercase" \| "firstLetter"`	Casing for the word-based number formats (`cardinalText`, `ordinalText`): `capitalize` — every word capitalised: “Forty-Two” (the converters’ native output); `uppercase` — “FORTY-TWO”; `lowercase` — “forty-two”; `firstLetter` — only the leading letter capitalised: “Forty-two”
`NumberGender`	`"masculine" \| "feminine"`	The grammatical genders the numbering UI offers.
`RUSSIAN_LOWER`	`string[]`	Word’s `russianLower` sequence: the lower-case mirror of `RUSSIAN_UPPER`.
`RUSSIAN_UPPER`	`readonly ["А", "Б", "В", "Г", …]`	Word’s `russianUpper` sequence; ё, й, ъ, ы and ь are skipped.
`SniffedDocumentType`	`"application/pdf" \| "application/vnd.openxmlformats-officedocument.wordprocessingml.document" \| "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" \| "application/vnd.openxmlformats-officedocument.presentationml.presentation" \| "application/zip" \| "text/plain"`
`SniffedImageType`	`"image/png" \| "image/jpeg" \| "image/gif" \| "image/webp"`
`USER_COLOR_SLOTS`	`10`	Number of author colour slots. The remote-cursor palette in `collab-adapter` has the same length and order, so a collaborator’s caret and tracked edits share a colour.