Merge pull request #257 from DimaNike/mleapp-255

feat: add MLE application template

Author: dbtools-antcampo

.github/dependabot.yml

@@ -188,3 +188,11 @@ updates:
       - "templates-ords-remix"
     commit-message:
       prefix: fix(deps)
+
+  - package-ecosystem: "npm" 
+    directory: "/templates/mle-ts-sample/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "dependencies"
+      - "templates-mle"

README.md

@@ -58,6 +58,7 @@ The package offers the following templates, some of them connect to the database
 - `node-angular`: A starter template that uses Node.js and [Angular](https://angular.dev/). It is built by [Angular CLI](https://github.com/angular/angular-cli). (New in `v1.2.0`)
 - `node-react-todo`: A simple task manager template that uses Node.js and [React](https://react.dev/). It demonstrates the use of the database for Create, Read, Update and Delete (CRUD) operations. It is built by [vite](https://vitejs.dev/).
 - `ords-remix-jwt-sample`: A full stack Concert Application made with [Remix](https://remix.run/) that showcases the [Oracle REST Data Services](https://www.oracle.com/database/technologies/appdev/rest.html) functionalities. Some extra configuration is required, learn more about it in the `ords-remix-jwt-sample` [Getting Started Guide](/templates/ords-remix-jwt-sample/README.md#getting-started).
+- `mle-ts-sample`: A starter template application that demonstrates how backend applications can be developed using [Oracle Database Multilingual Engine (MLE)](https://docs.oracle.com/en/database/oracle/oracle-database/23/mlejs/introduction-to-mle.html). Requires SQLcl to be installed, for more information please read [README](/templates/mle-ts-sample/README.md)
 
 Each of the templates include documentation for you to get started with them, as well as NPM scripts for you to use right after generating the application.
 

generators/index.ts

@@ -142,6 +142,20 @@ export default class extends Generator {
                 this.templatePath( `${this.options.templateChoice}/.env.example` ),
                 this.destinationPath( '.env.example' ),
             );
+        } else if (this.options.templateChoice.includes('mle-ts-sample')) {
+            if( 'walletPath' in this.options ) {
+                this.fs.copyTpl(
+                    this.templatePath( `${this.options.templateChoice}/.env.example.wallet` ),
+                    this.destinationPath( '.env' ),
+                    this.options
+                );
+            } else {
+                this.fs.copyTpl(
+                    this.templatePath( `${this.options.templateChoice}/.env.example` ),
+                    this.destinationPath( '.env' ),
+                    this.options
+                );
+            }
         } else {
             this.fs.copyTpl(
                 this.templatePath( `${ path.dirname( this.options.templateChoice ) }/app/${ path.basename( this.options.templateChoice ) == 'node-jet' ? 'index-proxied' : 'index' }.cjs` ),
@@ -169,7 +183,7 @@ export default class extends Generator {
                     connectionString: '',
                     connectionUsername: '',
                     walletPassword: '',
-                    walletPath: '',
+                    walletPath: ''
                 }
             );
             this.fs.copyTpl(

package-lock.json

@@ -111,4 +111,4 @@
   "overrides": {
     "whatwg-url": "^14.2.0"
   }
-}
+}

package.json

@@ -207,7 +207,7 @@ export default class Generate extends Command {
         'template': Flags.string({ 
             char: 't', 
             description: 'Template to use',
-            options: ['node-vanilla', 'node-react', 'node-vue', 'node-react-todo', 'node-jet', 'node-angular', 'ords-remix-jwt-sample'],
+            options: ['node-vanilla', 'node-react', 'node-vue', 'node-react-todo', 'node-jet', 'node-angular', 'ords-remix-jwt-sample', 'mle-ts-sample'],
             multiple: false
         }),
 
@@ -313,6 +313,7 @@ export default class Generate extends Command {
         const databaseSID = flags['db-sid'] ?? '';
         const databaseServiceName = flags['db-service-name'] ?? '';
         const databaseUsername = flags['db-username'] ?? '';
+        const sqlclPath = flags['sqlcl'] ?? '';
 
         // TODO: Validate and use wallet path
         const walletPathDirectory = flags['wallet-path'] ? flags['wallet-path'] : '';
@@ -373,7 +374,13 @@ export default class Generate extends Command {
                         value: 'ords-remix-jwt-sample',
                         description: 'This creates a fullstack Concert Application made with Remix that leverages the Oracle REST Data Services functionalities. You will need to configurate the application yourself following the getting started guide.',
                     },
+                    {
+                        name: 'mle-ts-sample',
+                        value: 'mle-ts-sample',
+                        description: 'This creates an empty project with MLE and Oracle database connection starter code.'
+                    },
                 ],
+                pageSize: 10,
                 default: 'node-vanilla'
             },
         ) : template;
@@ -533,6 +540,20 @@ export default class Generate extends Command {
             } );
         }
 
+        if(templateChoice == 'mle-ts-sample'){
+            // Ask the user for the path to SQLcl
+            Object.assign( configObject, {
+                sqlclPath: sqlclPath === '' ? await input(
+                    {
+                        message: 'Please provide full path to your SQLcl installation (SQLcl can be downloaded and installed from https://www.oracle.com/database/sqldeveloper/technologies/sqlcl): ',
+                        validate ( input ) {
+                            return input.trim().length === 0 ? 'This field cannot be empty!' : true;
+                        }
+                    },
+                ) : sqlclPath
+            });
+        }
+
         generateDatabaseApp( configObject );
         // TODO: This is the object that holds the application name, template choice, connection details depending on the chosen connection type.
         // console.log( JSON.stringify( configObject, null, ' ' ) );

src/index.ts

@@ -11,4 +11,4 @@ CONNECT_STRING=<%= connectionString %>
 
 # Optional HTTP Proxy Settings
 # HTTPS_PROXY=
-# HTTPS_PROXY_PORT=
+# HTTPS_PROXY_PORT=

templates/app/.env.example

@@ -7,4 +7,4 @@ CONNECT_STRING=<%= connectionString %>
 
 # Optional HTTP Proxy Settings
 # HTTPS_PROXY=
-# HTTPS_PROXY_PORT=
+# HTTPS_PROXY_PORT=

templates/app/.env.example.basic

@@ -0,0 +1,16 @@
+# Database User
+DB_USER=<%= connectionUsername %>
+# Database User Password
+DB_PASSWORD=<%= connectionPassword %>
+# Connection string to your Autonomous Database/
+# Oracle Database instance
+CONNECT_STRING=<%= connectionString %>
+# Oracle MLE Module name
+MLE_MODULE=
+# Optional HTTP Proxy Settings
+# HTTPS_PROXY=
+# HTTPS_PROXY_PORT=
+
+# Path to your local SQL Developer Command Line
+# installation
+SQL_CL_PATH=<%= sqlclPath %>

templates/mle-ts-sample/.env.example

@@ -0,0 +1,19 @@
+# Path to database wallet
+WALLET_PATH=<%= walletPath %>
+
+# Database User
+DB_USER=<%= connectionUsername %>
+# Database User Password
+DB_PASSWORD=<%= connectionPassword %>
+# Connection string to your Autonomous Database/
+# Oracle Database instance
+CONNECT_STRING=<%= connectionString %>
+# Oracle MLE Module name
+MLE_MODULE=
+# Optional HTTP Proxy Settings
+# HTTPS_PROXY=
+# HTTPS_PROXY_PORT=
+
+# Path to your local SQL Developer Command Line
+# installation
+SQL_CL_PATH=<%= sqlclPath %>

templates/mle-ts-sample/.env.example.wallet

@@ -0,0 +1,22 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.DS_Store
+
+/.env
+/.env.*
+!/.env.example
+!/.env.*.example
+/server/utils/db/wallet