Merge pull request #24 from gandalf-network/staging

Staging -> Prod [ Interactive CLI + ESM Support ]

README.md

@@ -33,7 +33,11 @@ eyeofsauron generate
 
 - -f, --folder [folder]: Set the destination folder for the generated files
 
-- -j, --javascript : Specify if the generated files should be compiled to Javascript.
+- -esm, --esModules : Generate JavaScript files as ESModules, utilizing `import` statements for module imports.
+
+- -c, --commonJS : Generate JavaScript files as CommonJS modules, using `require` statements for module imports.
+
+- -ts, --typescript : Generate TypeScript files.
 
 ### Using the Generated Files
 
@@ -42,7 +46,7 @@ Once you have successfully generated the necessary files and installed the requi
 #### Initialization
 
 ```typescript
-// index.ts
+// Typescript
 
 // Change eyeofsauron to whatever name you specified for the file generation
 import Eye, { Source } from './eyeofsauron';
@@ -51,6 +55,27 @@ const privateKey = process.env.PRIVATE_KEY
 const eye = new Eye({ privateKey })
 ```
 
+```javascript
+// ESModules
+
+// Change eyeofsauron to whatever name you specified for the file generation
+import Eye, { Source } from './eyeofsauron/index.js'
+
+const privateKey = process.env.PRIVATE_KEY
+const eye = new Eye({ privateKey })
+```
+
+```javascript
+// CommonJS
+
+// Change eyeofsauron to whatever name you specified for the file generation
+const Eye = require('./eyeofsauron').default
+const { Source } = require('./eyeofsauron')
+
+const privateKey = process.env.PRIVATE_KEY
+const eye = new Eye({ privateKey })
+```
+
 #### Get Activity
 
 ```typescript

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gandalf-network/eyeofsauron",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -30,9 +30,11 @@
     "@graphql-codegen/cli": "^5.0.2",
     "axios": "^1.6.7",
     "commander": "^12.0.0",
+    "inquirer": "^8.0.0",
     "rimraf": "^5.0.5"
   },
   "devDependencies": {
+    "@types/inquirer": "^8.0.0",
     "@types/jest": "^29.5.12",
     "copyfiles": "^2.4.1",
     "dotenv": "^16.4.5",

src/index.ts

@@ -1,25 +1,61 @@
 #!/usr/bin/env node
 
 import { Command } from 'commander';
+import inquirer from 'inquirer';
 import generate from './scripts/generate';
 
 const program = new Command();
 
 program
   .name("Eye Of Sauron")
   .version("1.0.0")
-  .description('A CLI tool for generating prebuilt functions to access the Gandalf Network')
+  .description('A CLI tool for generating prebuilt functions to access the Gandalf Network');
 
 program
   .command('generate')
   .alias('g')
-  .description('Generate the prebuilt funtions')
+  .description('Generate the prebuilt functions')
   .option('-f, --folder <folder>', 'Set the destination folder for the generated files')
-  .option('-j, --javascript', 'Use when generating Javascript files')
-  .action(async (options) => {
-    const folder = options.folder ? options.folder: 'eyeofsauron'
-    const generateJSFiles = options.javascript
-    await generate(folder, generateJSFiles);
+  .option('-ts, --typescript', 'Initialize as a TypeScript project.')
+  .option('-esm, --esModules', 'Initialize as an ESModules JavaScript project. i.e [ import Eye, { Source } from "./eyeofsauron/index.js" ]')
+  .option('-c, --commonJS', 'Initialize as a CommonJS JavaScript project. i.e [ const Eye = require("./eyeofsauron").default ]')
+  .allowUnknownOption()
+  .action(async (cliFlags) => {
+    let { folder, typescript, commonJS } = cliFlags;
+    let generateJSFiles = !typescript
+    let generateESMFiles = generateJSFiles && !commonJS
+
+    if (!folder) {
+      const answers = await inquirer.prompt([
+        {
+          type: 'input',
+          name: 'folder',
+          message: 'Set the destination folder for the generated files:',
+          default: 'eyeofsauron',
+        },
+        {
+          type: 'list',
+          name: 'language',
+          message: 'Select the language for generating the files:',
+          choices: ['javascript', 'typescript'],
+          default: 'javascript',
+        },
+        {
+          type: 'list',
+          name: 'moduleSystem',
+          message: 'Select the Javascript Module system for generating the JS files:',
+          choices: ['ESModules', 'CommonJS'],
+          default: 'ESModules',
+          when: (answers) => answers.language === 'javascript',
+        },
+      ]);
+
+      folder = answers.folder;
+      generateJSFiles = answers.language === 'javascript'
+      generateESMFiles = generateJSFiles && answers.moduleSystem === 'ESModules';
+    }
+
+    await generate(folder, generateJSFiles, generateESMFiles);
   });
 
-  program.parse(process.argv);
+program.parse(process.argv);

src/lib/constants.ts

@@ -1 +1 @@
-export const WATSON_URL = process.env.WATSON_URL as string;
+export const WATSON_URL = "http://localhost:8080/public/gql" as string;

src/lib/plugins/custom-plugin/config.ts

@@ -53,4 +53,5 @@ export interface RawGraphQLRequestPluginConfig extends RawClientSideBasePluginCo
    * ```
    */
   extensionsType?: string;
+  esModules?: boolean;
 }