feat: add utils

Author: Léo Guillaume

src/index.ts

@@ -21,9 +21,10 @@
  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { Language } from './language';
-import { NlpUtil, NlpManager, NlpExcelReader } from './nlp';
-import { XTableUtils, XTable, XDoc } from './xtables';
+import { Language } from './language'
+import { NlpUtil, NlpManager, NlpExcelReader } from './nlp'
+import { XTableUtils, XTable, XDoc } from './xtables'
+import { removeEmojis, Evaluator, SpellCheck, Handlebars } from './util'
 
 export {
     Language,
@@ -33,4 +34,17 @@ export {
     XTableUtils,
     XTable,
     XDoc,
+    removeEmojis,
+    Evaluator,
+    SpellCheck,
+    Handlebars,
+    // ActionManager,
+    // NlgManager,
+    // NeuralNetwork,
+    // SentimentAnalyzer,
+    // SentimentManager,
+    // Recognizer,
+    // ConversationContext,
+    // MemoryConversationContext,
+    // BrainNLU,
 };

src/types/@nlpjs/emoji.d.ts

@@ -0,0 +1,5 @@
+declare module '@nlpjs/emoji' {
+    function removeEmojis(str: string | null | undefined): string | null | undefined;
+
+    export { removeEmojis };
+}

src/types/@nlpjs/evaluator.d.ts

@@ -1,4 +1,6 @@
 declare module '@nlpjs/evaluator' {
     export class Evaluator {}
     export class Template {}
+
+    export function compile(str: string): string
 }

src/types/@nlpjs/similarity.d.ts

@@ -0,0 +1,21 @@
+declare module '@nlpjs/similarity' {
+    interface SimilarityResult {
+        distance: number;
+        text1: string;
+        text2: string;
+    }
+
+    interface Similarity {
+        getDistance(text1: string, text2: string): Promise<SimilarityResult>;
+    }
+
+    interface SpellCheckSettings {
+        features?: Similarity[];
+    }
+
+    class SpellCheck {
+        constructor(settings?: SpellCheckSettings);
+    }
+
+    export { SpellCheck, Similarity, SimilarityResult, SpellCheckSettings };
+}

src/util/handlebars.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { compile } from '@nlpjs/evaluator'
+
+class Handlebars {
+  static compile(str: string) {
+    return compile(str);
+  }
+}
+
+export {
+  Handlebars,
+};

src/util/index.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { removeEmojis } from '@nlpjs/emoji'
+import { Evaluator } from '@nlpjs/evaluator'
+import { SpellCheck } from './spell-check'
+import { Handlebars } from './handlebars'
+
+export {
+  removeEmojis,
+  Evaluator,
+  SpellCheck,
+  Handlebars,
+};

src/util/spell-check.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { SpellCheck as SpellCheckBase, SpellCheckSettings } from '@nlpjs/similarity';
+
+class SpellCheck extends SpellCheckBase {
+  constructor(settings: SpellCheckSettings = {}) {
+    const features = Array.isArray(settings) ? settings : settings.features;
+    super({ features });
+  }
+}
+
+export { SpellCheck };
+