smart-word-generator 1.0.0

package/README.md

@@ -0,0 +1 @@
+# smart-word-generator

package/index.js

@@ -0,0 +1,159 @@
+const axios = require("axios");
+const { wordOptionalParams, decorateWords } = require("./utils");
+
+/**
+ * Generate words that have similar meaning of input word
+ * @param  {String} word The input word
+ * @param  {Boolean} transformToArray Specify if true then return type array of words otherwise array of objects include extra details
+ * @param  {String} partOfSpeech Optional param to specify the part-Of-Speech of returned words 'n' for nouns, 'v' for verbs, 'adj' for adjectives and 'adv' for adverbs
+ * @param  {String} topics  Optional param to specify which category of the returned words belong to
+ * @param  {String} startWith  Optional param to specify what returned words should start with
+ * @param  {String} endWith  Optional param to specify what returned words should end with
+ * @param  {String} max Optional param to specify number of returned words
+ */
+const generateWordMeansLike = async (
+  word,
+  transformToArray = false,
+  partOfSpeech,
+  topics,
+  startWith,
+  endWith,
+  max
+) => {
+  try {
+    const optionalParams = wordOptionalParams(topics, startWith, endWith, max);
+    let response = await axios.get(
+      `https://api.datamuse.com/words?ml=${word}&${optionalParams}`
+    );
+    return decorateWords(partOfSpeech, transformToArray, response);
+  } catch (err) {
+    console.error(err);
+  }
+};
+
+/**
+ * Generate words that sounds like input word
+ * @param  {String} word The input word
+ * @param  {Boolean} transformToArray Specify if true then return type array of words otherwise array of objects include extra details
+ * @param  {String} partOfSpeech Optional param to specify the part-Of-Speech of returned words 'n' for nouns, 'v' for verbs, 'adj' for adjectives and 'adv' for adverbs
+ * @param  {String} topics  Optional param to specify which category of the returned words belong to
+ * @param  {String} startWith  Optional param to specify what returned words should start with
+ * @param  {String} endWith  Optional param to specify what returned words should end with
+ * @param  {String} max Optional param to specify number of returned words
+ */
+const generateWordSoundsLike = async (
+  word,
+  transformToArray = false,
+  partOfSpeech,
+  topics,
+  startWith,
+  endWith,
+  max
+) => {
+  try {
+    const optionalParams = wordOptionalParams(topics, startWith, endWith, max);
+    let response = await axios.get(
+      `https://api.datamuse.com/words?sl=${word}&${optionalParams}`
+    );
+    return decorateWords(partOfSpeech, transformToArray, response);
+  } catch (err) {
+    console.error(err);
+  }
+};
+
+/**
+ * Generate words that spelled like input word
+ * @param  {String} word The input word
+ * @param  {Boolean} transformToArray Specify if true then return type array of words otherwise array of objects include extra details
+ * @param  {String} partOfSpeech Optional param to specify the part-Of-Speech of returned words 'n' for nouns, 'v' for verbs, 'adj' for adjectives and 'adv' for adverbs
+ * @param  {String} topics  Optional param to specify which category of the returned words belong to
+ * @param  {String} startWith  Optional param to specify what returned words should start with
+ * @param  {String} endWith  Optional param to specify what returned words should end with
+ * @param  {String} max Optional param to specify number of returned words
+ */
+const generateWordSpelledLike = async (
+  word,
+  transformToArray = false,
+  partOfSpeech,
+  topics,
+  startWith,
+  endWith,
+  max
+) => {
+  try {
+    const optionalParams = wordOptionalParams(topics, startWith, endWith, max);
+    let response = await axios.get(
+      `https://api.datamuse.com/words?sp=${word}&${optionalParams}`
+    );
+    return decorateWords(partOfSpeech, transformToArray, response);
+  } catch (err) {
+    console.error(err);
+  }
+};
+
+/**
+ * Generate words that have left context of input word
+ * @param  {String} word The input word
+ * @param  {Boolean} transformToArray Specify if true then return type array of words otherwise array of objects include extra details
+ * @param  {String} partOfSpeech Optional param to specify the part-Of-Speech of returned words 'n' for nouns, 'v' for verbs, 'adj' for adjectives and 'adv' for adverbs
+ * @param  {String} topics  Optional param to specify which category of the returned words belong to
+ * @param  {String} startWith  Optional param to specify what returned words should start with
+ * @param  {String} endWith  Optional param to specify what returned words should end with
+ * @param  {String} max Optional param to specify number of returned words
+ */
+const generateWordHasLeftContext = async (
+  word,
+  transformToArray = false,
+  partOfSpeech,
+  topics,
+  startWith,
+  endWith,
+  max
+) => {
+  try {
+    const optionalParams = wordOptionalParams(topics, startWith, endWith, max);
+    let response = await axios.get(
+      `https://api.datamuse.com/words?lc=${word}&${optionalParams}`
+    );
+    return decorateWords(partOfSpeech, transformToArray, response);
+  } catch (err) {
+    console.error(err);
+  }
+};
+
+/**
+ * Generate words that have right context of input word
+ * @param  {String} word The input word
+ * @param  {Boolean} transformToArray Specify if true then return type array of words otherwise array of objects include extra details
+ * @param  {String} partOfSpeech Optional param to specify the part-Of-Speech of returned words 'n' for nouns, 'v' for verbs, 'adj' for adjectives and 'adv' for adverbs
+ * @param  {String} topics  Optional param to specify which category of the returned words belong to
+ * @param  {String} startWith  Optional param to specify what returned words should start with
+ * @param  {String} endWith  Optional param to specify what returned words should end with
+ * @param  {String} max Optional param to specify number of returned words
+ */
+const generateWordHasRightContext = async (
+  word,
+  transformToArray = false,
+  partOfSpeech,
+  topics,
+  startWith,
+  endWith,
+  max
+) => {
+  try {
+    const optionalParams = wordOptionalParams(topics, startWith, endWith, max);
+    let response = await axios.get(
+      `https://api.datamuse.com/words?rc=${word}&${optionalParams}`
+    );
+    return decorateWords(partOfSpeech, transformToArray, response);
+  } catch (err) {
+    console.error(err);
+  }
+};
+module.exports = {
+  generateWordMeansLike,
+  generateWordSoundsLike,
+  generateWordSpelledLike,
+  generateWordHasLeftContext,
+  generateWordHasRightContext,
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "smart-word-generator",
+  "version": "1.0.0",
+  "description": "Generate specific words depending on your needs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Mahmoud-Magdy-deeplearning/smart-word-generator.git"
+  },
+  "keywords": [
+    "word",
+    "generator",
+    "AI",
+    "NLP"
+  ],
+  "author": "Mahmoud Magdy",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Mahmoud-Magdy-deeplearning/smart-word-generator/issues"
+  },
+  "homepage": "https://github.com/Mahmoud-Magdy-deeplearning/smart-word-generator#readme",
+  "dependencies": {
+    "axios": "^1.2.1"
+  }
+}

package/utils.js

@@ -0,0 +1,33 @@
+const wordOptionalParams = (topics, startWith, endWith, max) => {
+  max = max ? max : "";
+  topics = topics ? topics : "";
+  endWith = endWith ? endWith : "";
+  startWith = startWith ? startWith : "";
+  return `sp=${startWith + "*" + endWith}&max=${max}&topics=${topics}&md=p`;
+};
+const filterWords = (words, type) => {
+  const filteredWords = words.data.filter((word) => {
+    const tags = word.tags.filter((tag) => tag === type);
+    return tags.length;
+  });
+  return filteredWords;
+};
+const arrayOfWordsTransformer = (words) => {
+  const arr = [];
+  words.map((wordObject) => {
+    arr.push(wordObject.word);
+  });
+  return arr;
+};
+
+const decorateWords = (partOfSpeech, transformToArray, words) => {
+  if (partOfSpeech) words = partOfSpeech && filterWords(words, partOfSpeech);
+  else
+    words = words.data.map((word) => {
+      return word;
+    });
+  if (transformToArray) words = arrayOfWordsTransformer(words);
+  return words;
+};
+
+module.exports = { wordOptionalParams, decorateWords };