sentencex-ts 0.1.13-ts

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2026 Abe Jellinek
+
+Based on sentencex
+Copyright (c) 2025 Santhosh Thottingal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# Sentence segmenter
+
+[sentencex](https://github.com/wikimedia/sentencex), but ported (back) from Rust to TypeScript, so it can be used on the
+web in environments where bundle size matters.
+
+## Install
+
+```shell
+npm install sentencex-ts
+```
+
+## Build
+
+```shell
+npm run build
+```

package/dist/chunk-text.d.ts

@@ -0,0 +1 @@
+export declare function chunkText(text: string, chunkSize: number): string[];

package/dist/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const ROMAN_NUMERALS: readonly string[];
+export declare function getQuotePairs(): Map<string, string>;
+export declare const PARENS_REGEX: RegExp;
+export declare const EMAIL_REGEX: RegExp;
+export declare const NUMBERED_REFERENCE_REGEX: RegExp;
+export declare const SPACE_AFTER_SEPARATOR: RegExp;
+export declare const QUOTES_REGEX: RegExp;
+export declare const EXCLAMATION_WORDS: readonly string[];
+export declare const GLOBAL_SENTENCE_TERMINATORS: readonly string[];
+export declare const SENTENCE_TERMINATOR_SET: Set<string>;
+export declare const TERMINATORS_PATTERN: string;

package/dist/fallbacks.d.ts

@@ -0,0 +1 @@
+export declare const LANGUAGE_FALLBACKS: ReadonlyMap<string, readonly string[]>;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { Language, parseAbbreviations } from './language';
+export type { SentenceBoundary } from './language';
+export { chunkText } from './chunk-text';
+export { LANGUAGE_FALLBACKS } from './fallbacks';
+export { LANGUAGE_REGISTRY } from './languages';
+import type { SentenceBoundary } from './language';
+import { Language } from './language';
+export declare function languageFactory(languageCode: string): Language;
+export declare function segment(languageCode: string, text: string): string[];
+export declare function getSentenceBoundaries(languageCode: string, text: string): SentenceBoundary[];

package/dist/language.d.ts

@@ -0,0 +1,33 @@
+export interface SentenceBoundary {
+    startIndex: number;
+    endIndex: number;
+    text: string;
+    boundarySymbol: string | null;
+    isParagraphBreak: boolean;
+}
+export declare enum SkippableRangeType {
+    Quote = "Quote",
+    Parentheses = "Parentheses",
+    Email = "Email"
+}
+export interface SkippableRange {
+    start: number;
+    end: number;
+    rangeType: SkippableRangeType;
+}
+export declare function parseAbbreviations(...texts: string[]): string[];
+export declare abstract class Language {
+    abstract getAbbreviations(): readonly string[];
+    getAbbreviationChar(): string;
+    getSentenceBreakRegex(): RegExp;
+    getSentenceBoundaries(text: string): SentenceBoundary[];
+    segment(text: string): string[];
+    getBoundaryExtend(word: string): number;
+    isAbbreviation(head: string, _tail: string, separator: string): boolean;
+    getLastWord(text: string): string;
+    isExclamation(head: string, _tail: string): boolean;
+    getNextWordApprox(text: string, start: number): string;
+    findBoundary(text: string, start: number, end: number): number | null;
+    continueInNextWord(textAfterBoundary: string): boolean;
+    getSkippableRanges(text: string): SkippableRange[];
+}

package/dist/languages/am.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Amharic extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/ar.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Arabic extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/bg.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Bulgarian extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/bn.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Bengali extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/ca.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Catalan extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/da.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Danish extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/de.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class German extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/el.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Greek extends Language {
+    getAbbreviations(): readonly string[];
+    getSentenceBreakRegex(): RegExp;
+}

package/dist/languages/en.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class English extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/es.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Spanish extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/fi.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Finnish extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/fr.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class French extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/gu.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Gujarati extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/hi.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Hindi extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/hy.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Armenian extends Language {
+    getAbbreviations(): readonly string[];
+    getSentenceBreakRegex(): RegExp;
+}

package/dist/languages/index.d.ts

@@ -0,0 +1,3 @@
+import { Language } from '../language';
+export type LanguageConstructor = new () => Language;
+export declare const LANGUAGE_REGISTRY: Map<string, LanguageConstructor>;

package/dist/languages/it.d.ts

@@ -0,0 +1,6 @@
+import { Language } from '../language';
+export declare class Italian extends Language {
+    getAbbreviations(): readonly string[];
+    getLastWord(text: string): string;
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/ja.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Japanese extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/kk.d.ts

@@ -0,0 +1,6 @@
+import { Language } from '../language';
+export declare class Kazakh extends Language {
+    getAbbreviations(): readonly string[];
+    getLastWord(text: string): string;
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/kn.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Kannada extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/ml.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Malayalam extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/mr.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Marathi extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/my.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Burmese extends Language {
+    getAbbreviations(): readonly string[];
+    getSentenceBreakRegex(): RegExp;
+}

package/dist/languages/nl.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Dutch extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/pa.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Punjabi extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/pl.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Polish extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/pt.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Portuguese extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/ru.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Russian extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/sk.d.ts

@@ -0,0 +1,5 @@
+import { Language } from '../language';
+export declare class Slovak extends Language {
+    getAbbreviations(): readonly string[];
+    continueInNextWord(textAfterBoundary: string): boolean;
+}

package/dist/languages/ta.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Tamil extends Language {
+    getAbbreviations(): readonly string[];
+}

package/dist/languages/te.d.ts

@@ -0,0 +1,4 @@
+import { Language } from '../language';
+export declare class Telugu extends Language {
+    getAbbreviations(): readonly string[];
+}