feat: declaration types core, core-loader, lang-all, language

Author: Léo Guillaume

.gitignore

@@ -1,3 +1,4 @@
 .idea
 node_modules
 dist
+node-nlp

package-lock.json

@@ -30,6 +30,10 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
-    "node-nlp-typescript": "^0.1.29"
+    "@nlpjs/core-loader": "^4.26.1",
+    "@nlpjs/lang-all": "^4.26.1",
+    "@nlpjs/language": "^4.25.0",
+    "node-nlp": "^4.26.1",
+    "node-nlp-typescript": "^0.1.30"
   }
 }

package.json

@@ -1,9 +1,30 @@
-export class Point {
-    x = 0
-    y = 0
-    move(x: number, y: number){
-        this.x += x
-        this.y += y
-        return this
-    }
-}
+/*
+ * Copyright (c) AXA Group Operations Spain S.A.
+ *
+ * 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.
+ */
+
+import { Language } from './language';
+import { NlpUtil } from './nlp';
+
+export {
+    Language,
+    NlpUtil
+};

src/index.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) AXA Group Operations Spain S.A.
+ *
+ * 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.
+ */
+
+import Language from '@nlpjs/language';
+
+export {
+  Language,
+};

src/language/index.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) AXA Group Operations Spain S.A.
+ *
+ * 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.
+ */
+
+import NlpUtil from './nlp-util';
+
+export {
+    NlpUtil
+}

src/nlp/index.ts

@@ -0,0 +1,153 @@
+/*
+ * Copyright (c) AXA Group Operations Spain S.A.
+ *
+ * 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.
+ */
+
+import {
+  BaseStemmer,
+  Tokenizer,
+  defaultContainer,
+  containerBootstrap,
+} from '@nlpjs/core-loader';
+import LangAll from '@nlpjs/lang-all';
+
+interface Cultures {
+  [key: string]: string;
+}
+
+const cultures: Cultures = {
+  ar: 'ar-ae', // Arabic
+  bn: 'bn-bd', // Bengali
+  ca: 'ca-es', // Catalan
+  cs: 'cs-cz', // Czech
+  da: 'da-dk', // Danish
+  el: 'el-gr', // Greek
+  en: 'en-us', // English
+  eu: 'eu-es', // Basque
+  fa: 'fa-ir', // Farsi
+  ga: 'ga-ie', // Irish
+  gl: 'gl-es', // Galician
+  hi: 'hi-in', // Hindi
+  hy: 'hy-am', // Armenian
+  ja: 'ja-jp', // Japanese
+  ko: 'ko-kr', // Korean
+  pl: 'pl-pl', // Polish
+  lt: 'lt-lt', // Lithuanian
+  ne: 'ne-ne', // Nepali
+  pt: 'pt-br', // Portuguese
+  sr: 'sr-rs', // Serbian
+  sv: 'sv-se', // Swedish
+  ta: 'ta-in', // Tamil
+  tl: 'tl-ph', // Tagalog
+  uk: 'uk-ua', // Ukraine
+  zh: 'zh-cn', // Chinese
+  id: 'id-id', // Indonesian,
+  ms: 'id-id', // Malay
+};
+
+class NlpUtil {
+  static tokenizers = {};
+
+  static useAutoStemmer = true;
+  static autoStemmers = {};
+
+  static useAlternative = {};
+
+  static useNoneFeature = {
+    bn: false,
+    el: true,
+    en: true,
+    hi: false,
+    fa: false,
+    fr: true,
+    ru: true,
+    es: true,
+    gl: true,
+    it: true,
+    nl: true,
+    no: true,
+    pt: true,
+    pl: true,
+    sv: true,
+    tl: true,
+    id: true,
+    ja: false,
+    ar: false,
+    hy: false,
+    eu: true,
+    ca: true,
+    cs: true,
+    da: true,
+    fi: true,
+    de: true,
+    hu: true,
+    ga: true,
+    ro: true,
+    sl: true,
+    ta: false,
+    th: false,
+    tr: true,
+    zh: false,
+  };
+
+  /**
+   * Given a locale, get the 2 character one.
+   * @param {String} locale Locale of the language.
+   * @returns {String} Locale in 2 character length.
+   */
+  static getTruncatedLocale(locale: string): string | undefined {
+    return locale ? locale.substring(0, 2).toLowerCase() : undefined;
+  }
+
+  static getStemmer(locale: string): BaseStemmer {
+    if (!locale) {
+      return new BaseStemmer();
+    }
+    const name = `Stemmer${locale.slice(0, 1).toUpperCase()}${locale.slice(1)}`;
+    const Stemmer = LangAll[name];
+    return Stemmer ? new Stemmer() : new BaseStemmer();
+  }
+
+  static getTokenizer(locale: string): Tokenizer {
+    if (!locale) {
+      return new Tokenizer();
+    }
+    const name = `Tokenizer${locale.slice(0, 1).toUpperCase()}${locale.slice(
+        1
+    )}`;
+    const TokenizerClass = LangAll[name];
+    return TokenizerClass
+        ? new TokenizerClass(undefined, true)
+        : new Tokenizer(undefined, true);
+  }
+
+  static getCulture(locale: string): string {
+    if (!locale) {
+      return 'en-us';
+    }
+    return cultures[locale] || `${locale}-${locale}`;
+  }
+}
+
+containerBootstrap({}, true, defaultContainer);
+defaultContainer.use(LangAll.LangAll);
+
+export default NlpUtil;

src/nlp/nlp-util.ts

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) AXA Group Operations Spain S.A.
+ *
+ * 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 module '@nlpjs/core-loader' {
+    import {
+        Among,
+        ArrToObj,
+        BaseStemmer,
+        Clonable,
+        Container,
+        defaultContainer,
+        Normalizer,
+        ObjToArr,
+        Stemmer,
+        Stopwords,
+        Tokenizer,
+        Timer,
+        logger,
+        MemoryStorage,
+        uuid,
+        Context,
+    } from '@nlpjs/core';
+
+    export const containerBootstrap: (
+        inputSettings?: string | Record<string, unknown>,
+        srcMustLoadEnv?: boolean,
+        container?: Container,
+        preffix?: string,
+        pipelines?: any[],
+        parent?: Container
+    ) => Container;
+
+    export function hasUnicode(str: string): boolean;
+
+    export function unicodeToArray(str: string): string[];
+
+    export function asciiToArray(str: string): string[];
+
+    export function stringToArray(str: string): string[];
+
+    export function compareWildcars(str: string, pattern: string): boolean;
+
+    export function listFiles(dir: string): Promise<string[]>;
+
+    export function loadEnv(env: string): void;
+
+    export function listFilesAbsolute(dir: string): Promise<string[]>;
+
+    export function getAbsolutePath(path: string): string;
+
+    export const dock: {
+        containers: { [name: string]: Container };
+        getContainer: (name?: string) => Container | undefined;
+        get(name: string): any;
+        createContainer(
+            name: string | object | undefined,
+            settings?: string | object | undefined,
+            srcMustLoadEnv?: boolean | undefined,
+            preffix?: string | undefined,
+            parent?: Container | undefined,
+            pipelines?: any
+        ): Promise<Container>;
+        buildChilds(container: Container): Promise<void>;
+        terraform(settings: string | object, mustLoadEnv?: boolean): Promise<Container>;
+        start(settings: string | object, mustLoadEnv?: boolean): Promise<Container>;
+    };
+
+    export {
+        Among,
+        ArrToObj,
+        BaseStemmer,
+        Clonable,
+        Container,
+        defaultContainer,
+        Normalizer,
+        ObjToArr,
+        Stemmer,
+        Stopwords,
+        Tokenizer,
+        Timer,
+        logger,
+        MemoryStorage,
+        uuid,
+        Context,
+    };
+}