Merge pull request #302 from DimaNike/mle-ords-backend

feat: mle-ts-ords-backend template #301

Author: dbtools-antcampo

README.md

@@ -59,6 +59,7 @@ The package offers the following templates, some of them connect to the database
 - `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)
+- `mle-ts-ords-backend`: A starter template application that demonstrates how to expose MLE-based backend logic as RESTful endpoints using [Oracle REST Data Services](https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/) (ORDS). This template requires both SQLcl and ORDS to be installed. For more information, please refer to the [README](/templates/mle-ts-ords-backend/).
 
 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

@@ -92,14 +92,34 @@ export default class extends Generator {
             const { protocol, hostname, port, serviceName } = retrieveConnectionStringDetailsFromORAFile( path.join( walletPath, 'tnsnames.ora' ) );
             this.options.connectionString = generateConnectionString( protocol, hostname, port, serviceName );
         }
-        // Copy files that are common to all of the templates.
-        this.fs.copyTpl(
-            this.templatePath( this.options.templateChoice ),
-            this.destinationPath(),
-            {
-                appName: this.options.appName
-            }
-        );
+        if(this.options.templateChoice.includes('mle-ts-ords-backend')) {
+            const files = ['src/todos.ts', 'test/users.test.js', 'utils/db.mjs', 'utils/database/initdb.sql', 'utils/database/cleanup.sql', 'deploy.mjs', 'tsconfig.json',''];
+            files.forEach(file => {
+                this.fs.copyTpl(
+                    this.templatePath(`../../templates/mle-ts-sample/${file}`),
+                    this.destinationPath(file),
+                    {
+                        appName: this.options.appName
+                    }
+                );
+            });
+            // Copy files that are common to all of the templates.
+            this.fs.copyTpl(
+                this.templatePath( this.options.templateChoice ),
+                this.destinationPath(),
+                this.options
+            );
+        } else {
+            // Copy files that are common to all of the templates.
+            this.fs.copyTpl(
+                this.templatePath( this.options.templateChoice ),
+                this.destinationPath(),
+                {
+                    appName: this.options.appName
+                }
+            );
+        }
+        
         this.fs.copy(
             this.templatePath(`${ path.dirname( this.options.templateChoice ) }/app/.github`),
             this.destinationPath('.github')
@@ -142,7 +162,7 @@ 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')) {
+        } else if (this.options.templateChoice.includes('mle-ts-sample') || this.options.templateChoice.includes('mle-ts-ords-backend')) {
             if( 'walletPath' in this.options ) {
                 this.fs.copyTpl(
                     this.templatePath( `${this.options.templateChoice}/.env.example.wallet` ),

src/index.ts

@@ -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', 'mle-ts-sample'],
+            options: ['node-vanilla', 'node-react', 'node-vue', 'node-react-todo', 'node-jet', 'node-angular', 'ords-remix-jwt-sample', 'mle-ts-sample', 'mle-ts-ords-backend'],
             multiple: false
         }),
 
@@ -314,6 +314,7 @@ export default class Generate extends Command {
         const databaseServiceName = flags['db-service-name'] ?? '';
         const databaseUsername = flags['db-username'] ?? '';
         const sqlclPath = flags['sqlcl'] ?? '';
+        const ordsHost = flags['ords-host'] ?? '';
 
         // TODO: Validate and use wallet path
         const walletPathDirectory = flags['wallet-path'] ? flags['wallet-path'] : '';
@@ -379,6 +380,11 @@ export default class Generate extends Command {
                         value: 'mle-ts-sample',
                         description: 'This creates an empty project with MLE and Oracle database connection starter code.'
                     },
+                    {
+                        name: 'mle-ts-ords-backend',
+                        value: 'mle-ts-ords-backend',
+                        description: 'Creates a starter project with MLE integration, Oracle Database connectivity, and scaffolded ORDS REST endpoints.'
+                    },
                 ],
                 pageSize: 10,
                 default: 'node-vanilla'
@@ -476,8 +482,10 @@ export default class Generate extends Command {
 
             // This will be config object for the basic connection type.
             Object.assign(configObject, {
-                connectionString: generateConnectionString( protocol, hostname, port, serviceValue )
-            });
+                connectionString: generateConnectionString( protocol, hostname, port, serviceValue ),
+                serviceValue: serviceValue,
+                databasePort: port
+            });            
         } else if( databaseConnectionType === 'walletPath' ) {
             let walletPath = '';
 
@@ -509,23 +517,29 @@ export default class Generate extends Command {
             // This is the config object that represents the wallet connection type.
             Object.assign(configObject, {
                 walletPath: walletPath,
-                walletPassword: walletPassword
+                walletPassword: walletPassword,
+                serviceValue: "",
+                databasePort: 8080,
             });
         }
 
-        if(templateChoice !== 'ords-remix-jwt-sample'){
+        if(templateChoice !== 'ords-remix-jwt-sample') {
             // Ask the user for the database connection username.
+            let databaseUser = databaseUsername === '' ? await input(
+                {
+                    message: 'What\'s your database username?',
+                    validate ( input ) {
+                        return input.trim().length === 0 ? 'This field cannot be empty!' : true;
+                    }
+                },
+            ) : databaseUsername;
+            if (templateChoice === 'mle-ts-ords-backend') {
+                databaseUser = databaseUser.toLowerCase();                
+            }            
             Object.assign( configObject, {
-                connectionUsername: databaseUsername === '' ? await input(
-                    {
-                        message: 'What\'s your database username?',
-                        validate ( input ) {
-                            return input.trim().length === 0 ? 'This field cannot be empty!' : true;
-                        }
-                    },
-                ) : databaseUsername
-            } );
-
+                connectionUsername: databaseUser
+            });
+            
             // Ask the user for the database connection password.
             Object.assign( configObject, {
                 connectionPassword: await password(
@@ -540,7 +554,8 @@ export default class Generate extends Command {
             } );
         }
 
-        if(templateChoice == 'mle-ts-sample'){
+        if(templateChoice === 'mle-ts-sample' || templateChoice === 'mle-ts-ords-backend') 
+        {
             // Ask the user for the path to SQLcl
             Object.assign( configObject, {
                 sqlclPath: sqlclPath === '' ? await input(
@@ -552,6 +567,22 @@ export default class Generate extends Command {
                     },
                 ) : sqlclPath
             });
+            if (templateChoice === 'mle-ts-ords-backend') 
+            {
+                let ordsHostURL = ordsHost === '' ? await input(
+                    {
+                        message: 'Please provide ORDS Base URL: ',
+                        validate ( input ) {
+                            return input.trim().length === 0 ? 'This field cannot be empty!' : true;
+                        },
+                        default: 'http://localhost:8080/ords'   
+                    },
+                ) : ordsHost;
+                const normalizedBaseURL = ordsHostURL.replace(/\/+$/, '');
+                Object.assign( configObject, {
+                    ordsHost: normalizedBaseURL
+                });
+            }
         }
 
         generateDatabaseApp( configObject );

templates/mle-ts-ords-backend/.env.example

@@ -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-ords-backend/.env.example.wallet

@@ -0,0 +1,19 @@
+# Path to database wallet
+WALLET_PATH=<%= walletPath %>
+WALLET_PASSWORD=<%= walletPassword %>
+# 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-ords-backend/.gitignore.template

@@ -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