typograf 6.15.0 → 7.0.0

package/dist/data/no.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'no/char': string;
+    'no/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/pl.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'pl/char': string;
+    'pl/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/ro.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'ro/char': string;
+    'ro/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/ru.d.ts

@@ -0,0 +1,19 @@
+declare const _default: {
+    'ru/char': string;
+    'ru/dashBefore': string;
+    'ru/dashAfter': string;
+    'ru/dashAfterDe': string;
+    'ru/l': string;
+    'ru/L': string;
+    'ru/month': string;
+    'ru/monthGenCase': string;
+    'ru/monthPreCase': string;
+    'ru/quote': {
+        left: string;
+        right: string;
+        removeDuplicateQuotes: boolean;
+    };
+    'ru/shortMonth': string;
+    'ru/weekday': string;
+};
+export default _default;

package/dist/data/sk.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'sk/char': string;
+    'sk/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/sl.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'sl/char': string;
+    'sl/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/sr.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'sr/char': string;
+    'sr/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/sv.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'sv/char': string;
+    'sv/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/tr.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'tr/char': string;
+    'tr/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data/uk.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    'uk/char': string;
+    'uk/quote': {
+        left: string;
+        right: string;
+    };
+};
+export default _default;

package/dist/data.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Get data for use in rules.
+ */
+export declare function getData(key: string): unknown;
+/**
+ * Set data for use in rules.
+ */
+export declare function setData(newData: Record<string, unknown>): void;
+export type DataChar = string;
+export type DataCommonQuote = string;
+export type DataQuote = {
+    left: string;
+    right: string;
+    spacing?: boolean;
+    removeDuplicateQuotes?: true;
+};

package/dist/groupIndexes.d.ts

@@ -0,0 +1 @@
+export declare const groupIndexes: Record<string, number>;

package/dist/helpers/object.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Get a deep copy of a object.
+ */
+export declare function deepCopy<T>(obj: T): T;

package/dist/helpers/regExp.d.ts

@@ -0,0 +1,4 @@
+export declare const regExpUrl: RegExp;
+export declare const regExpNumber = "\\d+([.,]\\d+)?";
+export declare const regExpDigit: RegExp;
+export declare function isDigit(symbol: string): boolean;

package/dist/helpers/string.d.ts

@@ -0,0 +1,6 @@
+export declare function repeat(symbol: string, count: number): string;
+export declare function replaceNbsp(text: string): string;
+export declare function replace(text: string, re: [RegExp, string][]): string;
+export declare function isHTML(text: string): boolean;
+export declare function removeCR(text: string): string;
+export declare function fixLineEnding(text: string, type: 'CRLF' | 'CR' | 'LF'): string;

package/dist/htmlEntities/index.d.ts

@@ -0,0 +1,41 @@
+import type { TypografContext } from '../main';
+export type Entity = [string, number];
+export type TypografHtmlEntityType = 'name' | 'digit' | 'default';
+interface HtmlEntityInfo {
+    name: string;
+    nameEntity: string;
+    digitEntity: string;
+    utf: string;
+    reName: RegExp;
+    reUtf: RegExp;
+}
+declare class HtmlEntities {
+    private entities;
+    private invisibleEntities;
+    private entitiesByName;
+    private entitiesByNameEntity;
+    private entitiesByDigitEntity;
+    private entitiesByUtf;
+    constructor();
+    /**
+     * Entities as name or digit to UTF-8.
+     */
+    toUtf(context: TypografContext): void;
+    /**
+     * Entities in decimal or hexadecimal form to UTF-8.
+     */
+    decHexToUtf(text: string): string;
+    /**
+     * Restore HTML entities in text.
+     */
+    restore(context: TypografContext): void;
+    /**
+     * Get a entity by utf using the type.
+     */
+    getByUtf(symbol: string, type?: TypografHtmlEntityType): HtmlEntityInfo | string | undefined;
+    private prepareEntities;
+    private prepareListParam;
+    private restoreEntitiesByIndex;
+}
+export declare const htmlEntities: HtmlEntities;
+export {};

package/dist/htmlEntities/invisible.d.ts

@@ -0,0 +1,2 @@
+import { Entity } from '.';
+export declare const invisibleEntities: Entity[];

package/dist/htmlEntities/visible.d.ts

@@ -0,0 +1,2 @@
+import { Entity } from '.';
+export declare const visibleEntities: Entity[];

package/dist/htmlTags/block.d.ts

@@ -0,0 +1 @@
+export declare const blockElements: string[];

package/dist/htmlTags/inline.d.ts

@@ -0,0 +1 @@
+export declare const inlineElements: string[];

package/dist/locale.d.ts

@@ -0,0 +1,5 @@
+export declare function addLocale(locale: string): void;
+export declare function getLocales(): string[];
+export declare function hasLocale(locale: string): boolean;
+export declare function prepareLocale(locale1?: string | string[], locale2?: string | string[]): string[];
+export declare function checkLocales(locales: string[]): void;

package/dist/main.d.ts

@@ -0,0 +1,130 @@
+import { TypografHtmlEntityType } from './htmlEntities/index';
+import { SafeTags } from './safeTags';
+export type TypografLineEnding = 'LF' | 'CR' | 'CRLF';
+export interface TypografHtmlEntity {
+    type: TypografHtmlEntityType;
+    onlyInvisible: boolean;
+    list?: string[];
+}
+export type TypofrafRuleFilter = (rule: TypografRuleInternal) => boolean;
+export interface TypografPrefs {
+    locale: string | string[];
+    lineEnding?: TypografLineEnding;
+    htmlEntity?: Partial<TypografHtmlEntity>;
+    live?: boolean;
+    enableRule?: string | string[];
+    disableRule?: string | string[];
+    processingSeparateParts?: boolean;
+    ruleFilter?: TypofrafRuleFilter;
+}
+export interface TypografExecutePrefs {
+    locale?: string | string[];
+    lineEnding?: TypografLineEnding;
+    htmlEntity?: Partial<TypografHtmlEntity>;
+    processingSeparateParts?: boolean;
+    ruleFilter?: TypofrafRuleFilter;
+}
+export interface TypografPrefsInternal {
+    locale: string[];
+    lineEnding: TypografLineEnding;
+    htmlEntity: TypografHtmlEntity;
+    live: boolean;
+    enableRule: string | string[];
+    disableRule: string | string[];
+    processingSeparateParts: boolean;
+    ruleFilter: TypofrafRuleFilter;
+}
+export interface TypografContext {
+    text: string;
+    isHTML: boolean;
+    prefs: TypografPrefsInternal;
+    safeTags: SafeTags;
+    getData: (key: string) => unknown;
+}
+export interface TypografRule<T = Record<string, unknown>> {
+    name: string;
+    handler: (this: Typograf, text: string, settings: T, context: TypografContext) => string;
+    queue?: string;
+    index?: string | number;
+    disabled?: boolean;
+    live?: boolean;
+    settings?: T;
+    htmlAttrs?: boolean;
+}
+export interface TypografRuleInternal {
+    name: string;
+    handler: (text: string, settings: unknown, context: TypografContext) => string;
+    shortName: string;
+    locale: string;
+    group: string;
+    queue: string;
+    index: number;
+    enabled: boolean;
+    live: boolean;
+    settings: unknown;
+    htmlAttrs: boolean;
+}
+export declare class Typograf {
+    safeTags: SafeTags;
+    onBeforeRule?: (ruleName: string, context: TypografContext) => void;
+    onAfterRule?: (ruleName: string, context: TypografContext) => void;
+    private prefs;
+    private rules;
+    private innerRules;
+    private rulesByQueues;
+    private innerRulesByQueues;
+    private enabledRules;
+    private settings;
+    private separatePartsTags;
+    constructor(prefs: TypografPrefs);
+    static addRule(rule: TypografRule): void;
+    static addRules(rules: TypografRule[]): void;
+    /**
+     * Add internal rule.
+     * Internal rules are executed before main rules.
+     */
+    static addInnerRule(rule: TypografRule): void;
+    static addInnerRules(rules: TypografRule[]): void;
+    static getRule(ruleName: string): TypografRuleInternal | null;
+    static getRules(): TypografRuleInternal[];
+    static getInnerRules(): TypografRuleInternal[];
+    static getLocales(): string[];
+    static addLocale(locale: string): void;
+    static hasLocale(locale: string): boolean;
+    static setData(data: Record<string, unknown>): void;
+    static getData(key: string): unknown;
+    static groups: {
+        name: string;
+        title: Record<string, string>;
+    }[];
+    static titles: Record<string, Record<string, string>>;
+    static version: string;
+    /**
+     * Execute typographical rules for text.
+     */
+    execute(text: string | number, prefs?: TypografExecutePrefs): string;
+    getSetting(ruleName: string, setting: string): unknown;
+    setSetting(ruleName: string, setting: string, value: unknown): void;
+    isEnabledRule(ruleName: string): boolean;
+    isDisabledRule(ruleName: string): boolean;
+    enableRule(ruleName: string | string[]): void;
+    disableRule(ruleName: string | string[]): void;
+    /**
+     * Add safe tag.
+     *
+     * @example
+     * // const typograf = new Typograf({ locale: 'ru' });
+     * // typograf.addSafeTag('<mytag>', '</mytag>');
+     * // typograf.addSafeTag('<mytag>', '</mytag>', '.*?');
+     * // typograf.addSafeTag(/<mytag>.*?</mytag>/gi);
+    */
+    addSafeTag(startTag: string | RegExp, endTag?: string, middle?: string): void;
+    private prepareContext;
+    private splitBySeparateParts;
+    private process;
+    private executeRules;
+    private ruleIterator;
+    private prepareRuleSettings;
+    private enable;
+    private enableByMask;
+}

package/dist/prefs.d.ts

@@ -0,0 +1,6 @@
+import type { TypografLineEnding, TypografExecutePrefs, TypografPrefs, TypografPrefsInternal } from './main';
+export declare function prepareHtmlEntity(htmlEntity?: Partial<TypografPrefsInternal['htmlEntity']>): TypografPrefsInternal['htmlEntity'];
+export declare function prepareLineEnding(lineEnding?: TypografLineEnding): TypografLineEnding;
+export declare function prepareProcessingSeparateParts(value?: boolean): boolean;
+export declare function preparePrefs(prefs: TypografPrefs): TypografPrefsInternal;
+export declare function prepareContextPrefs(prefs: TypografPrefsInternal, executePrefs?: TypografExecutePrefs): TypografPrefsInternal;

package/dist/rule.d.ts

@@ -0,0 +1,9 @@
+import { TypografRule, TypografRuleInternal } from './main';
+export declare const DEFAULT_RULE_INDEX = 0;
+export declare const DEFAULT_QUEUE_NAME = "default";
+export declare function addInnerRule(rule: TypografRule): void;
+export declare function addRule(rule: TypografRule): void;
+export declare function sortRules(rules: TypografRuleInternal[]): void;
+export declare function getRules(): TypografRuleInternal[];
+export declare function getInnerRules(): TypografRuleInternal[];
+export declare function prepareRule(rule: TypografRule): TypografRuleInternal;

package/dist/rules/common/html/e-mail.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const eMailRule: TypografRule;

package/dist/rules/common/html/e-mail.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/escape.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const escapeRule: TypografRule;

package/dist/rules/common/html/escape.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/nbr.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const nbrRule: TypografRule;

package/dist/rules/common/html/nbr.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/p.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const pRule: TypografRule;

package/dist/rules/common/html/p.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/processingAttrs.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const processingAttrsRule: TypografRule<{
+    attrs: string[];
+}>;

package/dist/rules/common/html/quot.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const quotRule: TypografRule;

package/dist/rules/common/html/quot.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/stripTags.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const stripTagsRule: TypografRule;

package/dist/rules/common/html/stripTags.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/html/url.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const urlRule: TypografRule;

package/dist/rules/common/html/url.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/index.d.ts

@@ -0,0 +1,7 @@
+import './html/index';
+import './nbsp/index';
+import './number/index';
+import './other/index';
+import './punctuation/index';
+import './space/index';
+import './symbols/index';

package/dist/rules/common/nbsp/afterNumber.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const afterNumberRule: TypografRule;

package/dist/rules/common/nbsp/afterNumber.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/afterParagraphMark.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const afterParagraphMarkRule: TypografRule;

package/dist/rules/common/nbsp/afterParagraphMark.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/afterSectionMark.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const afterSectionMarkRule: TypografRule;

package/dist/rules/common/nbsp/afterSectionMark.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/afterShortWord.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const afterShortWordRule: TypografRule<{
+    lengthShortWord: number;
+}>;

package/dist/rules/common/nbsp/afterShortWord.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/beforeShortLastNumber.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const beforeShortLastNumberRule: TypografRule<{
+    lengthLastNumber: number;
+}>;

package/dist/rules/common/nbsp/beforeShortLastNumber.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/beforeShortLastWord.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const beforeShortLastWordRule: TypografRule<{
+    lengthLastWord: number;
+}>;

package/dist/rules/common/nbsp/beforeShortLastWord.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/dpi.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const dpiRule: TypografRule;

package/dist/rules/common/nbsp/dpi.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/nowrap.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const nowrapRule: TypografRule;

package/dist/rules/common/nbsp/nowrap.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/nbsp/replaceNbsp.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const replaceNbspRule: TypografRule;

package/dist/rules/common/nbsp/replaceNbsp.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/number/digitGrouping.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const digitGroupingRule: TypografRule<{
+    space: string;
+}>;

package/dist/rules/common/number/digitGrouping.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/number/fraction.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const fractionRule: TypografRule;

package/dist/rules/common/number/fraction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/number/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/number/mathSigns.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const mathSignsRule: TypografRule;

package/dist/rules/common/number/mathSigns.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/number/times.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const timesRule: TypografRule;

package/dist/rules/common/number/times.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/other/delBOM.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const delBOMRule: TypografRule;

package/dist/rules/common/other/delBOM.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/other/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/other/repeatWord.d.ts

@@ -0,0 +1,4 @@
+import type { TypografRule } from '../../../main';
+export declare const repeatWordRule: TypografRule<{
+    min: number;
+}>;

package/dist/rules/common/other/repeatWord.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/apostrophe.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const apostropheRule: TypografRule;

package/dist/rules/common/punctuation/apostrophe.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/delDoublePunctuation.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const delDoublePunctuationRule: TypografRule;

package/dist/rules/common/punctuation/delDoublePunctuation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/hellip.d.ts

@@ -0,0 +1,2 @@
+import type { TypografRule } from '../../../main';
+export declare const hellipRule: TypografRule;

package/dist/rules/common/punctuation/hellip.en-US.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/hellip.ru.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.d.ts

@@ -0,0 +1,5 @@
+import type { TypografRule } from '../../../main';
+import { DataQuote } from '../../../data';
+type QuoteRuleSettings = Record<string, DataQuote>;
+export declare const quoteRule: TypografRule<QuoteRuleSettings>;
+export {};

package/dist/rules/common/punctuation/quote.de.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.en-GB.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.en-US.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.fi.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.fr.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.pl.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rules/common/punctuation/quote.ru.test.d.ts

@@ -0,0 +1 @@
+export {};