Merge pull request #330 from Uconnect-Technologies/dev-ilyas/mysql-enum

Dev ilyas/mysql enum

docs/v1/custom-modules/introduction.md

@@ -11,7 +11,7 @@ let configuration = {
   modules: [
     {
       name: "Article",
-      useDatabase: true,
+      useMysqlDatabase: true,
       fields: {
         sql: {
           title: {
@@ -81,7 +81,7 @@ To allow database you have to configure your module in this way:
 let configuration = {
   modules: [
     {
-      useDatabase: true, // Set false if you are not storing data for this module.
+      useMysqlDatabase: true, // Set false if you are not storing data for this module.
       database: {
         sql: {
           tableName: "YOUR_TABLE_NAME",
@@ -170,7 +170,7 @@ The above module will generate these GraphQL subscriptions:
 
 #### Rest API:
 
-So when you enable useDatabase feature, If you have enabled RestAPI these API's will be generated by Wertik for the module named Person:
+So when you enable useMysqlDatabase feature, If you have enabled RestAPI these API's will be generated by Wertik for the module named Person:
 
       [SAVE] http://localhost:7000/api/v1/person/save - {input: args }
       [POST] http://localhost:7000/api/v1/person/create - {input: args }

docs/v2/custom-modules.md

@@ -12,7 +12,7 @@ With this guide, you can extend your app with extra modules and functionality. P
 **Default Value:** null
 **Description:** The name of module.
 
-### useDatabase
+### useMysqlDatabase
 
 **Type:** Boolean
 **Default Value:** true

docs/v3/database.md

@@ -1,13 +1,13 @@
 # Database
 
-As of today 28 November 2021, Wertik-js only supports MySQL database. Wertik JS provides a function called `useDatabase` you can use to connect to a database.
+As of today 28 November 2021, Wertik-js only supports MySQL database. Wertik JS provides a function called `useMysqlDatabase` you can use to connect to a database.
 
 ```js
-import wertik, { useDatabase } from "wertik-js/lib/next";
+import wertik, { useMysqlDatabase } from "wertik-js/lib/next";
 weritk({
   port: 1200,
   database: {
-    default: useDatabase({
+    default: useMysqlDatabase({
       name: "default",
       password: "pass",
       host: "localhost",

docs/v3/mailer.md

@@ -3,11 +3,11 @@
 To send emails. Wertik-js uses Node Mailer for sending emails. To setup emails Wertik JS provides a function called `useMailer` as argument you need to pass Node Mailer Configuration.
 
 ```js
-import wertik, { useDatabase, useMailer } from "wertik-js/lib/next";
+import wertik, { useMysqlDatabase, useMailer } from "wertik-js/lib/next";
 weritk({
   port: 1200,
   database: {
-    default: useDatabase({
+    default: useMysqlDatabase({
       name: "default",
       password: "pass",
       host: "localhost",

docs/v3/modules.md

@@ -4,7 +4,7 @@ Wertik-js allows extending your app with more features using the `modules` term.
 
 ```js
 import wertik, {
-  useDatabase,
+  useMysqlDatabase,
   useMailer,
   useModule,
   useGraphql,
@@ -13,7 +13,7 @@ import wertik, {
 weritk({
   port: 1200,
   database: {
-    default: useDatabase({
+    default: useMysqlDatabase({
       name: "default",
       password: "pass",
       host: "localhost",
@@ -30,7 +30,7 @@ weritk({
       table: "users",
       database: "default",
       name: "users",
-      useDatabase: true,
+      useMysqlDatabase: true,
     }),
   },
 });
@@ -40,20 +40,20 @@ Please check this [interface](https://github.com/Uconnect-Technologies/wertik-js
 
 # Modules GraphQL Schema and Database operations
 
-When you provide `useDatabase: true`, `table` and `database`, Wertik JS automatically generates GraphQL schema, `updateInput` and `createInput`. For example let's say you have a table called `Games` with following fields:
+When you provide `useMysqlDatabase: true`, `table` and `database`, Wertik JS automatically generates GraphQL schema, `updateInput` and `createInput`. For example let's say you have a table called `Games` with following fields:
 
 - name: varchar
 - publisher: varchar
 
 You have to initialize its module in this way:
 
 ```js
-import wertik, { useModule, useDatabase, useGraphql } from "wertik-js/lib/next";
+import wertik, { useModule, useMysqlDatabase, useGraphql } from "wertik-js/lib/next";
 wertik({
   port: 1200,
   graphql: useGraphql(),
   database: {
-    default: useDatabase({
+    default: useMysqlDatabase({
       name: "dbname",
       password: "pass",
       host: "localhost",
@@ -63,7 +63,7 @@ wertik({
   },
   modules: {
     games: useModule({
-      useDatabase: true,
+      useMysqlDatabase: true,
       name: "Games",
       table: "games",
       database: "default",
@@ -127,6 +127,7 @@ type Query {
 }
 ```
 
+**Note:** When you are using enums in table please make sure that your enum value doesn't contains dashes, it should be something like this `enum('X_SMALL','X_LARGE')` not `enum('X-SMALL','X-LARGE')`.
 ### Mutations:
 
 - update
@@ -151,7 +152,7 @@ You can try these `Mutations` and `Queries` in your GraphQL playground. If you f
 
 # More on filtering rows from a table
 
-When you provide `useDatabase: true` for a module called Games. Wertik JS will create a query as:
+When you provide `useMysqlDatabase: true` for a module called Games. Wertik JS will create a query as:
 
 ```graphql
 listGames(
@@ -218,12 +219,12 @@ When events are running you get access to Apollo GraphQL Resolver arguments wher
 Example:
 
 ```js
-import wertik, { useDatabase, useModule } from "wertik-js/lib/next";
+import wertik, { useMysqlDatabase, useModule } from "wertik-js/lib/next";
 
 wertik({
   port: 1200,
   database: {
-    default: useDatabase({
+    default: useMysqlDatabase({
       name: "default",
       password: "pass",
       host: "localhost",
@@ -233,7 +234,7 @@ wertik({
   },
   modules: {
     games: useModule({
-      useDatabase: true,
+      useMysqlDatabase: true,
       name: "Games",
       table: "games",
       database: "jscontainer",
@@ -275,7 +276,7 @@ wertik({
   port: 1200,
   modules: {
     games: useModule({
-      useDatabase: true,
+      useMysqlDatabase: true,
       name: "Games",
       table: "games",
       database: "jscontainer",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wertik-js",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "main": "lib/main.js",
   "types": "lib/types.d.ts",
   "repository": "https://github.com/Uconnect-Technologies/wertik-js.git",

src/next/database.ts

@@ -17,7 +17,7 @@ export const getAllRelationships = (dbName: String) => {
   `
 }
 
-export const useDatabase = function (obj: useDatabaseProps) {
+export const useMysqlDatabase = function (obj: useDatabaseProps) {
   return async () => {
     let sequelize = new Sequelize(obj.name, obj.username, obj.password, {
       host: obj.host,
@@ -40,6 +40,11 @@ export const useDatabase = function (obj: useDatabaseProps) {
   }
 }
 
+/**
+ * @deprecated use useMysqlDatabase instead useDatabase is deprecated and will be removed in 3.5.0 version.
+ */
+export const useDatabase = useMysqlDatabase
+
 export const applyRelationshipsFromStoreToDatabase = async (
   store: Store,
   app: WertikApp

src/next/devServers/dev-ilyas.ts

@@ -1,19 +1,33 @@
-import wertik from "../index"
-import { useQueue } from "../queue"
+import { useMysqlDatabase } from "../database"
+import { useGraphql } from "../graphql"
+import wertik, { useModule } from "../index"
 
 const devIlyas = async () => {
   wertik({
     port: 1200,
-    queue: {
-      options: {
-        useBullBoard: true,
-        uiPath: "/admin/jobs",
-      },
-      jobs: {
-        fetchGames: useQueue({
-          name: "fetchGames",
-        }),
-      },
+    graphql: useGraphql(),
+    database: {
+      default: useMysqlDatabase({
+        port: 3306,
+        username: "root",
+        password: "pass",
+        name: "wertik",
+        host: "localhost",
+      }),
+    },
+    modules: {
+      forgetPassword: useModule({
+        name: "forgetPassword",
+        useDatabase: true,
+        database: "default",
+        table: "forgetPassword",
+      }),
+      shirts: useModule({
+        name: "shirts",
+        useDatabase: true,
+        database: "default",
+        table: "shirts",
+      }),
     },
   })
 }

src/next/index.ts

@@ -43,7 +43,7 @@ const Wertik: (configuration: WertikConfiguration) => Promise<WertikApp> = (
         redis: {},
       }
 
-      const port = get(configuration, "port", 5050)
+      const port = get(configuration, "port", 1200)
       const skip = get(configuration, "skip", false)
       const expressApp = get(configuration, "express", express())
       const httpServer = http.createServer(expressApp)