natural 5.2.4 → 6.0.1

package/.github/workflows/linter.yml

@@ -48,8 +48,9 @@ jobs:
       # Run Linter against code base #
       ################################
       - name: Lint Code Base
-        uses: github/super-linter@v4
+        uses: github/super-linter/slim@v4
         env:
           VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: master
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LINTER_RULES_PATH: /

package/README.md

@@ -6,8 +6,9 @@
 [![GitHub Super-Linter](https://github.com/NaturalNode/natural/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
 [![Coverage Status](https://coveralls.io/repos/github/NaturalNode/natural/badge.svg?branch=master)](https://coveralls.io/github/NaturalNode/natural?branch=master)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4651/badge)](https://bestpractices.coreinfrastructure.org/projects/4651)
+[![TypeScript support](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 
-"Natural" is a general natural language facility for nodejs. It offers a broad range of functionalities for natural language processing. Documentation can be found [here on Github Pages](http://naturalnode.github.io/natural/).
+"Natural" is a general natural language facility for nodejs. It offers a broad range of functionalities for natural language processing. Documentation can be found [here on GitHub Pages](http://naturalnode.github.io/natural/).
 
 
 ## License

package/lib/natural/analyzers/index.d.ts

@@ -0,0 +1,55 @@
+/*
+Copyright (c) 2022,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export declare interface TaggedWord {
+  [key: string]: string
+  token: string
+  pos: string
+  spos?: string
+  added?: boolean
+}
+
+export declare type PunctuationFunction = () => string[] | ''
+
+export declare interface TaggedSentence {
+  tags: TaggedWord[]
+  punct?: PunctuationFunction
+}
+
+export declare type CallbackFunction = (obj: SentenceAnalyzer) => void
+
+export declare type SenType = string
+
+export declare class SentenceAnalyzer {
+  posObj: TaggedSentence
+  senType: string | null
+
+  constructor (pos: TaggedSentence, cbf: CallbackFunction)
+  part (cbf: CallbackFunction): void
+  prepositionPhrases (): void
+  subjectToString (): string | null
+  predicateToString (): string | null
+  implicitYou (): boolean
+  toString (): string
+  type (cbf: CallbackFunction): SenType
+}

package/lib/natural/analyzers/sentence_analyzer.js

@@ -149,7 +149,9 @@ Sentences.prototype.type = function (cbf) {
 
   // FIXME - punct seems useless
   let lastElement = this.posObj.punct()
+  // console.log(lastElement)
   lastElement = (lastElement.length !== 0) ? lastElement.pop() : this.posObj.tags.pop()
+  // console.log(lastElement)
 
   if (lastElement.pos !== '.') {
     if (implicitYou) {

package/lib/natural/brill_pos_tagger/index.d.ts

@@ -0,0 +1,73 @@
+/*
+Copyright (c) 2022,
+Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export declare class Predicate {
+  constructor (name: string, parameter1: string, parameter2?: string)
+  name: string
+  parameter1: string
+  parameter2?: string | undefined
+  function?: ((tagged_sentence: string[][], i: number, parameter: string) => boolean) | undefined
+  evaluate (taggedSentence: string[][], position: number): boolean
+}
+
+export declare class TransformationRule {
+  constructor (c1: string, c2: string, predicate: string, parameter1: string, parameter2?: string)
+  literal: string[]
+  predicate: Predicate
+  old_category: string
+  new_category: string
+  apply (taggedSentence: string[][], position: number): void
+}
+
+export declare class RuleSet {
+  constructor (filename: string)
+  rules: TransformationRule[]
+}
+
+export declare class Lexicon {
+  constructor (filename: string, defaultCategory: string)
+  defaultCategory: string
+  parseLexicon (data: string): void
+  tagWord (word: string): string[]
+}
+
+export interface TaggedWord {
+  token: string
+  tag: string
+}
+
+export declare class Sentence {
+  constructor (data?: string[])
+  taggedWords: TaggedWord[]
+  addTaggedWord (token: string, tag: string): void
+  clone (): Sentence
+}
+
+export declare class BrillPOSTagger {
+  constructor (lexicon: Lexicon, ruleSet: RuleSet)
+  lexicon: Lexicon
+  ruleSet: RuleSet
+  tag (sentence: string[]): Sentence
+}

package/lib/natural/classifiers/index.d.ts

@@ -0,0 +1,135 @@
+
+export interface BayesClassifierClassification {
+  label: string
+  value: number
+}
+
+export type BayesClassifierCallback = (err: any, classifier: BayesClassifier) => void
+
+declare class BayesClassifier {
+  events: events.EventEmitter
+
+  constructor (stem?: Stemmer)
+  addDocument (text: string, stem: string): void
+  addDocument (text: string[], stem: string): void
+  train (): void
+  classify (observation: string): string
+  getClassifications (observation: string): BayesClassifierClassification[]
+  save (filename: string, callback: BayesClassifierCallback): void
+  static load (filename: string, stemmer: Stemmer, callback: BayesClassifierCallback): void
+  static restore (classifier: any, stemmer?: Stemmer): BayesClassifier
+}
+
+interface LogisticRegressionClassifierClassification {
+  label: string
+  value: number
+}
+
+export type LogisticRegressionCallback = (err: any, result: LogisticRegressionClassifier) => void
+
+declare class LogisticRegressionClassifier {
+  events: events.EventEmitter
+
+  addDocument (text: string, stem: string): void
+  addDocument (text: string[], stem: string): void
+  train (): void
+  classify (observation: string): string
+  getClassifications (observation: string): LogisticRegressionClassifierClassification[]
+  save (filename: string, callback: LogisticRegressionCallback): void
+  static load (filename: string, stemmer: Stemmer, callback: LogisticRegressionCallback): void
+  static restore (classifier: any, stemmer?: Stemmer): LogisticRegressionClassifier
+}
+
+export type MaxEntClassifierCallback = (err: any, result: MaxEntClassifier) => void
+
+declare class MaxEntClassifier {
+  sample: Sample
+  features: FeatureSet
+
+  constructor (features: FeatureSet, sample: Sample)
+  addElement (x: Element): void
+  addDocument (context: Context, classification: string, elementClass: Element): void
+  train (maxIterations: number, minImprovement: number, approxExpectation: object): void
+  getClassifications (b: Context): array
+  classify (b: Context): string
+  save (filename: string, callback: MaxEntClassifierCallback): void
+  static load (filename: string, elementClass: Element, callback: MaxEntClassifierCallback): void
+}
+
+export type FeatureFunction = (x: Element) => number
+
+declare class Feature {
+  evaluate: FeatureFunction
+  name: string
+  parameters: array
+
+  constructor (f: FeatureFunction, name: string, parameters: array)
+  apply (x: Element): number
+  expectationApprox (p: Distribution, sample: Sample): number
+  expectation (p: Distribution, A: array, B: array): number
+  observedExpectation (sample: Sample): number
+}
+
+declare class FeatureSet {
+  features: array
+  map: object
+
+  addFeature (feature: FeatureFunction): boolean
+  featureExists (feature: FeatureFunction): boolean
+  getFeatures (): array
+  size (): number
+  prettyPrint (): string
+}
+
+export type SampleCallback = (err: any, result: Sample) => void
+
+declare class Sample {
+  frequencyOfContext: object
+  frequency: object
+  classes: array
+
+  constructor (elements)
+  analyse (): void
+  addElement (x: Element): void
+  observedProbabilityOfContext (context: Context): number
+  observedProbability (x): number
+  size (): number
+  getClasses (): array
+  generateFeatures (featureSet: FeatureSet): void
+  save (filename: string, callback: SampleCallback): void
+  load (filename: string, elementClass: Element, callback: SampleCallback): void
+}
+
+declare class Context {
+  toString (): string
+}
+
+declare class Element {
+  constructor (a: any, b: Context)
+  key (): string
+}
+
+declare class SEElement extends Element {
+  generateFeatures (featureSet: FeatureSet): void
+}
+
+declare class POSElement extends Element {
+  generateFeatures (featureSet: FeatureSet): void
+}
+
+declare class GISScaler {
+  constructor (featureSet: FeatureSet, sample: Sample)
+  calculateMaxSumOfFeatures (): void
+  addCorrectionFeature (): void
+  run (maxIterations: number, minImprovement: number): Distribution
+}
+
+declare class MESentence {
+  constructor (data: array): void
+  generateSampleElements (sample: Sample): void
+}
+
+declare class MECorpus {
+  generateSample (): Sample
+  splitInTrainAndTest (percentageTrain: number): array
+}

package/lib/natural/classifiers/maxent/Classifier.js

@@ -76,6 +76,7 @@ Classifier.prototype.save = function (filename, callback) {
   const classifier = this
   fs.writeFile(filename, data, 'utf8', function (err) {
     if (callback) {
+      console.log('Saved classifier to ' + filename)
       callback(err, err ? null : classifier)
     }
   })

package/lib/natural/classifiers/maxent/Feature.js

@@ -62,7 +62,7 @@ Feature.prototype.expectationApprox = function (p, sample) {
   return sum
 }
 
-// Diect calculation of expected value of this feature according to distribution p
+// Direct calculation of expected value of this feature according to distribution p
 // In real-life applications with a lot of features this is not tractable
 Feature.prototype.expectation = function (p, A, B) {
   let sum = 0

package/lib/natural/distance/index.d.ts

@@ -0,0 +1,76 @@
+
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+// Based on type definitions on Definitely Typed
+
+export interface JaroWinklerOptions {
+  dj?: number | undefined
+  // default: false
+  ignoreCase?: boolean | undefined
+}
+export declare function JaroWinklerDistance (s1: string, s2: string, options: JaroWinklerOptions): number
+
+export interface DamerauLevenshteinDistanceOptions {
+  /** @default 1 */
+  insertion_cost?: number | undefined
+  /** @default 1 */
+  deletion_cost?: number | undefined
+  /** @default 1 */
+  substitution_cost?: number | undefined
+  /** @default 1 */
+  transposition_cost?: number | undefined
+  /** @default false */
+  search?: boolean | undefined
+  /** @default false */
+  restricted?: boolean | undefined
+  damerau?: boolean | undefined
+}
+interface SubstringDistanceResult {
+  substring: string
+  distance: number
+}
+export declare function LevenshteinDistance (source: string, target: string, options?: DamerauLevenshteinDistanceOptions): number
+/**
+ * Returns the Damerau-Levenshtein distance between strings. Counts the distance
+ * between two strings by returning the number of edit operations required to
+ * convert `source` into `target`.
+ *
+ * Valid edit operations are:
+ *  - transposition, insertion, deletion, and substitution
+ */
+export function DamerauLevenshteinDistance (
+  source: string,
+  target: string,
+  options: DamerauLevenshteinDistanceOptions & { search: true }
+): SubstringDistanceResult
+export function DamerauLevenshteinDistance (
+  source: string,
+  target: string,
+  options?: DamerauLevenshteinDistanceOptions & { search?: false | undefined }
+): number
+export function DamerauLevenshteinDistance (
+  source: string,
+  target: string,
+  options: DamerauLevenshteinDistanceOptions & { search: boolean }
+): number | SubstringDistanceResult
+export declare function DiceCoefficient (str1: string, str2: string): number

package/lib/natural/distance/jaro-winkler_distance.js

@@ -102,19 +102,17 @@ function distance (s1, s2) {
 // s2 is the second string to compare
 // dj is the Jaro Distance (if you've already computed it), leave blank and the method handles it
 // ignoreCase: if true strings are first converted to lower case before comparison
-function JaroWinklerDistance (s1, s2, dj, ignoreCase) {
+function JaroWinklerDistance (s1, s2, options) {
   if (s1 === s2) {
     return 1
   } else {
-    if (ignoreCase) {
+    if (options.ignoreCase) {
       s1 = s1.toLowerCase()
       s2 = s2.toLowerCase()
     }
 
-    // console.log(news1);
-    // console.log(news2);
-
-    const jaro = (typeof (dj) === 'undefined') ? distance(s1, s2) : dj
+    // Use the  Jaro distance provided by the client if present
+    const jaro = (options.dj === undefined) ? distance(s1, s2) : options.dj
     const p = 0.1 // default scaling factor
     let l = 0 // length of the matching prefix
     while (s1[l] === s2[l] && l < 4) {

package/lib/natural/distance/levenshtein_distance.js

@@ -89,6 +89,7 @@ function getMinCostSubstring (distanceMatrix, source, target) {
 *  transposition_cost: number (default: 1)
 *  search: boolean (default: false)
 *  restricted: boolean (default: false)
+*  damerau: boolean (depends on the function called)
 */
 function DamerauLevenshteinDistance (source, target, options) {
   const damLevOptions = _.extend(

package/lib/natural/index.d.ts

@@ -0,0 +1,39 @@
+/*
+Copyright (c) 2022,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export * from './analyzers'
+export * from './brill_pos_tagger'
+export * from './classifiers'
+export * from './distance'
+export * from './inflectors'
+export * from './ngrams'
+export * from './normalizers'
+export * from './phonetics'
+export * from './sentiment'
+export * from './spelcheck'
+export * from './stemmers'
+export * from './tfidf'
+export * from './tokenizers'
+export * from './transliterators'
+export * from './util'
+export * from './wordnet'

package/lib/natural/inflectors/index.d.ts

@@ -0,0 +1,35 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+export declare class NounInflector {
+  pluralize (token: string): string
+  singularize (token: string): string
+}
+
+export declare let CountInflector: {
+  nth: (i: number) => string
+}
+
+export declare class PresentVerbInflector {
+  pluralize (token: string): string
+  singularize (token: string): string
+}

package/lib/natural/ngrams/index.d.ts

@@ -0,0 +1,35 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+declare interface ngramsFunctions {
+  bigrams: (sequence: string | string[], startSymbol?: string, endSymbol?: string) => string[][]
+  // bigrams: (sequence: string[], startSymbol?: string, endSymbol?: string) => string[][]
+  trigrams: (sequence: string | string[], startSymbol?: string, endSymbol?: string) => string[][]
+  // trigrams: (sequence: string[], startSymbol?: string, endSymbol?: string) => string[][]
+  ngrams: (sequence: string | string[], n: number, startSymbol?: string, endSymbol?: string) => string[][]
+  // ngrams: (sequence: string[], n: number, startSymbol?: string, endSymbol?: string) => string[][]
+}
+
+export declare let NGrams: ngramsFunctions
+export declare let NGramsZH: ngramsFunctions

package/lib/natural/phonetics/index.d.ts

@@ -0,0 +1,41 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+export interface Phonetic {
+  compare: (stringA: string, stringB: string) => boolean
+  process: (token: string, maxLength?: number) => string
+}
+
+declare let Metaphone: {
+  compare: (stringA: string, stringB: string) => boolean
+  process: (token: string, maxLength?: number) => string
+}
+
+declare let SoundEx: {
+  compare: (stringA: string, stringB: string) => boolean
+  process: (token: string, maxLength?: number) => string
+}
+
+declare let DoubleMetaphone: {
+  compare: (stringA: string, stringB: string) => boolean
+  process: (token: string, maxLength?: number) => string[]
+}

package/lib/natural/sentiment/index.d.ts

@@ -0,0 +1,27 @@
+
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+export declare class SentimentAnalyzer {
+  constructor (language: string, stemmer: Stemmer, vocabulary: string)
+  getSentiment (words: string[]): number
+}

package/lib/natural/spellcheck/index.d.ts

@@ -0,0 +1,30 @@
+/*
+Copyright (c) 2022,
+Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export declare class Spellcheck {
+  constructor (wordlist: string[])
+  isCorrect (word: string): boolean
+  getCorrections (word: string, maxDistance?: number): string[]
+}

package/lib/natural/stemmers/index.d.ts

@@ -0,0 +1,44 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+// Based on the type definitions on definitely typed
+
+export interface Stemmer {
+  stem: (token: string) => string
+  tokenizeAndStem: (text: string) => string[]
+  attach: () => void
+}
+
+declare const CarryStemmerFr: Stemmer
+declare const LancasterStemmer: Stemmer
+declare const PorterStemmer: Stemmer
+declare const PorterStemmerEs: Stemmer
+declare const PorterStemmerFa: Stemmer
+declare const PorterStemmerFr: Stemmer
+declare const PorterStemmerIt: Stemmer
+declare const PorterStemmerNl: Stemmer
+declare const PorterStemmerNo: Stemmer
+declare const PorterStemmerPt: Stemmer
+declare const PorterStemmerRu: Stemmer
+declare const PorterStemmerSv: Stemmer
+declare const StemmerId: Stemmer
+declare const StemmerJa: Stemmer

package/lib/natural/tfidf/index.d.ts

@@ -0,0 +1,42 @@
+/*
+Copyright (c) 2022,
+Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export type TfIdfCallback = (i: number, measure: number) => void
+
+export interface TfIdfTerm {
+  term: string
+  tfidf: number
+}
+
+export declare class TfIdf {
+  constructor (deserialized?: any)
+  addDocument (document: string, key?: string, restoreCache?: boolean): void
+  addDocument (document: string[], key?: string, restoreCache?: boolean): void
+  addFileSync (path: string, encoding?: string, key?: string, restoreCache?: boolean): void
+  tfidf (terms: string, d: number): void
+  tfidfs (terms: string, callback: TfIdfCallback): void
+  tfidfs (terms: string[], callback: TfIdfCallback): void
+  listTerms (d: number): TfIdfTerm[]
+}

package/lib/natural/tokenizers/index.d.ts

@@ -0,0 +1,99 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>, Emily Marigold Klassen <https://github.com/forivall>, Hugo W.L. ter Doest
+
+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.
+*/
+
+// Based on type definitions on Definitely Typed
+
+export interface Tokenizer {
+  tokenize: (text: string) => string[]
+}
+export declare class WordTokenizer implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class TreebankWordTokenizer implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export interface RegexTokenizerOptions {
+  pattern?: RegExp | undefined
+  discardEmpty?: boolean | undefined
+}
+export declare class RegexpTokenizer implements Tokenizer {
+  constructor (options: RegexTokenizerOptions)
+  tokenize (text: string): string[];
+}
+export declare class OrthographyTokenizer implements Tokenizer {
+  constructor (options: RegexTokenizerOptions & { language: string })
+  tokenize (text: string): string[]
+}
+export declare class WordPunctTokenizer implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class SentenceTokenizer implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class SentenceTokenizerNew implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class CaseTokenizer implements Tokenizer {
+  tokenize (text: string, preserveApostrophy?: boolean): string[]
+}
+export declare class AggressiveTokenizer implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerEs implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerFa implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerFr implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerId implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerIt implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerNl implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerNo implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerPl implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerPt implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerRu implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerSv implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class AggressiveTokenizerVi implements Tokenizer {
+  tokenize (text: string): string[]
+}
+export declare class TokenizerJa implements Tokenizer {
+  tokenize (text: string): string[]
+}

package/lib/natural/transliterators/index.d.ts

@@ -0,0 +1,27 @@
+/*
+Copyright (c) 2022,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+// First define a function type for transliterators ...
+export declare type TransliteratorFunction = (s: string) => string
+// and then export the Japanese transliterator as a function of that type
+export declare let TransliterateJa: TransliteratorFunction

package/lib/natural/transliterators/index.js

@@ -22,4 +22,4 @@ THE SOFTWARE.
 
 'use strict'
 
-exports.transliterate_ja = require('./ja')
+exports.TransliterateJa = require('./ja')

package/lib/natural/trie/index.d.ts

@@ -0,0 +1,33 @@
+/*
+Copyright (c) 2022, Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export declare class Trie {
+  constructor (caseSensitive?: boolean)
+  addString (text: string): boolean
+  addStrings (strings: string[]): void
+  contains (token: string): boolean
+  findPrefix (text: string): string[]
+  findMatchesOnPath (text: string): string[]
+  keysWithPrefix (text: string): string[]
+}

package/lib/natural/util/index.d.ts

@@ -0,0 +1,44 @@
+/*
+Copyright (c) 2022,
+Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export declare class EdgeWeightedDigraph {
+  add (start: number, end: number, weight: number): void
+  v (): number
+  e (): number
+}
+
+export declare class ShortestPathTree {
+  constructor (diagraph: EdgeWeightedDigraph, startVertex: number)
+  getDistTo (vertex: number): number
+  hasPathTo (vertex: number): boolean
+  pathTo (vertex: number): number[]
+}
+
+export declare class LongestPathTree {
+  constructor (diagraph: EdgeWeightedDigraph, startVertex: number)
+  getDistTo (vertex: number): number
+  hasPathTo (vertex: number): boolean
+  pathTo (vertex: number): number[]
+}

package/lib/natural/wordnet/index.d.ts

@@ -0,0 +1,42 @@
+/*
+Copyright (c) 2022,
+Dylan R. E. Moonfire <https://github.com/dmoonfire>,
+Emily Marigold Klassen <https://github.com/forivall>,
+Hugo W.L. ter Doest <https://github.com/Hugo-ter-Doest>
+
+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.
+*/
+
+export interface WordNetLookupResults {
+  synsetOffset: number
+  pos: string
+  lemma: string
+  synonyms: string[]
+  gloss: string
+}
+
+export type WordNetLookupCallback = (results: WordNetLookupResults[]) => void
+
+export type WordNetGetCallback = (results: WordNetLookupResults) => void
+
+export declare class WordNet {
+  constructor (filename?: string)
+  lookup (word: string, callback: WordNetLookupCallback): void
+  get (synsetOffset: number, pos: string, callback: WordNetGetCallback): void
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "natural",
   "description": "General natural language (tokenizing, stemming (English, Russian, Spanish), part-of-speech tagging, sentiment analysis, classification, inflection, phonetics, tfidf, WordNet, jaro-winkler, Levenshtein distance, Dice's Coefficient) facilities for node.",
-  "version": "5.2.4",
+  "version": "6.0.1",
   "homepage": "https://github.com/NaturalNode/natural",
   "repository": {
     "type": "git",
@@ -15,6 +15,7 @@
     "apparatus": "^0.0.10",
     "safe-stable-stringify": "^2.2.0",
     "sylvester": "^0.0.12",
+    "tsc": "^2.0.4",
     "underscore": "^1.9.1",
     "wordnet-db": "^3.1.11"
   },
@@ -57,7 +58,8 @@
     "test": "NODE_PATH=. node ./node_modules/jasmine/bin/jasmine.js io_spec/*_spec.js spec/*_spec.js",
     "coverage": "nyc --reporter=lcov npm test",
     "test_io": "NODE_PATH=. node ./node_modules/jasmine/bin/jasmine.js --random=false io_spec/*_spec.js",
-    "test_browser": "NODE_PATH=. node ./node_modules/gulp/bin/gulp.js"
+    "test_browser": "NODE_PATH=. node ./node_modules/gulp/bin/gulp.js",
+    "lint": "eslint . --ext .ts"
   },
   "license": "MIT",
   "author": "Chris Umbel <chris@chrisumbel.com>",
@@ -93,6 +95,7 @@
     "maximum entropy modelling"
   ],
   "main": "./lib/natural/index.js",
+  "types": "./lib/natural/index.d.ts",
   "maintainers": [
     {
       "name": "Chris Umbel",
@@ -106,6 +109,10 @@
     {
       "name": "Ken Koch",
       "email": "kkoch986@gmail.com"
+    },
+    {
+      "name": "Hugo W.L. ter Doest",
+      "email": "hwl.ter.doest@gmail.com"
     }
   ]
 }

package/tsconfig.json

@@ -1,23 +1,25 @@
 {
-    "compilerOptions": {
-        "module": "commonjs",
-        "lib": [
-            "es6"
-        ],
-        "noImplicitAny": true,
-        "noImplicitThis": true,
-        "strictNullChecks": false,
-        "strictFunctionTypes": true,
-        "baseUrl": "../",
-        "typeRoots": [
-            "../"
-        ],
-        "types": [],
-        "noEmit": true,
-        "forceConsistentCasingInFileNames": true
-    },
-    "include": ["./lib/natural/**/*"],
-    "files": [
-        "tokenizers.d.ts"
-    ]
+  "compilerOptions": {
+    "target": "es6",
+    "resolveJsonModule": true,
+    "lib": [
+      "es6"
+    ],
+    "module": "commonjs",
+    "rootDir": "./",
+    "moduleResolution": "node",
+    "allowJs": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "lib/natural/**/*",
+    "spec/*"
+  ],
+  "exclude": [
+    "./node_modules"
+  ]
 }