mgc 1.0.1 → 1.2.0

package/bin/generate.js

@@ -3,7 +3,7 @@
 import path from "path";
 import { program } from "commander";
 
-import { generateProject } from "../services/filecopy.service.js";
+import { generateModule } from "../services/filecopy.service.js";
 
 program
   .command("gen <modulePath>")
@@ -18,7 +18,7 @@ program
 
     const currentDir = path.join(process.cwd(), externalPath || "");
 
-    generateProject(modulePath, currentDir);
+    generateModule(modulePath, currentDir);
   });
 
 program.parse(process.argv);

package/{templates → modules}/express/email/README.md

@@ -11,11 +11,17 @@ AWS_SECRET_ACCESS_KEY=""
 
 ## Usae
 
+### Packages Requied
+
+```
+yarn add nodemailer handlebars @aws-sdk/client-ses zod
+```
+
 - First you have to create a `.hbs` template in `/templates` directory with necessary placeholders i.e. `{{verificationCode}}` or any other name as per your requirement
-- Then in `email.interface.ts` file on `EmailTemplate` type, append the newly created file name, i.e. if you created `forgot-password.hbs`, the new type should be 
+- Then in `email.interface.ts` file on `EmailTemplate` type, append the newly created file name, i.e. if you created `forgot-password.hbs`, the new type should be
 
 ```ts
-export type EmailTemplate = "welcome" | "verify-email" | 'forgot-password';
+export type EmailTemplate = "welcome" | "verify-email" | "forgot-password";
 ```
 
 - Now use `sendMail` function wherever you require
@@ -32,6 +38,7 @@ sendMail({
 ```
 
 ## Important Note
+
 - we have to copy hbs file as it won't happen during ts compilation step thus add this script on your `package.json`
 
 ```json
@@ -43,3 +50,8 @@ sendMail({
 ```json
     "build": "tsc && yarn copy-hbs",
 ```
+
+## Bugs
+
+- [ ] Ts do not read .hbs file so, for now, we have copy hbs file using copy-hbs package when building and starting the application.
+- [ ] need to generate dynamic date i.e. @2023 copyright

package/modules/express/email/email.config.ts

@@ -0,0 +1,24 @@
+import "dotenv/config";
+
+import { z } from "zod";
+
+const envSchema = z.object({
+  BUCKET: z.string().optional(),
+  EMAIL_FROM: z.string().nonempty(),
+  AWS_REGION: z.string().nonempty(),
+  AWS_ACCESS_KEY_ID: z.string().nonempty(),
+  AWS_SECRET_ACCESS_KEY: z.string().nonempty(),
+});
+
+export const env = envSchema.parse(process.env);
+
+export default {
+  aws: {
+    region: env.AWS_REGION,
+    accessKeyId: env.AWS_ACCESS_KEY_ID,
+    secretAccessKey: env.AWS_SECRET_ACCESS_KEY,
+  },
+  email: {
+    from: process.env.EMAIL_FROM,
+  },
+};

package/{templates → modules}/express/email/email.service.ts

@@ -4,14 +4,15 @@ import nodemailer from "nodemailer";
 import handlebars from "handlebars";
 import * as aws from "@aws-sdk/client-ses";
 
+import config from "./email.config";
 import { MailerParams, EmailTemplate } from "./email.interface";
 
 const ses = new aws.SESClient({
   apiVersion: "2010-12-01",
-  region: process.env.AWS_REGION,
+  region: config.aws.region,
   credentials: {
-    accessKeyId: process.env.AWS_ACCESS_KEY_ID || "",
-    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY || "",
+    accessKeyId: config.aws.accessKeyId,
+    secretAccessKey: config.aws.secretAccessKey,
   },
 });
 
@@ -20,7 +21,7 @@ const nodeMailerTransporter = nodemailer.createTransport({
 });
 
 export function sendMail(emailData: MailerParams) {
-  emailData.from = emailData.from || process.env.EMAIL_FROM;
+  emailData.from = emailData.from || config.email.from;
 
   // handlebars config
   if (emailData.template) {

package/modules/express/s3/README.md

@@ -0,0 +1,50 @@
+# S3 Module
+
+Generating signed url for uploading and previewing files
+
+## Required env variables
+
+```
+  BUCKET: '',
+  AWS_REGION: '',
+  AWS_ACCESS_KEY_ID: '',
+  AWS_SECRET_ACCESS_KEY: '',
+
+```
+
+## Usage
+
+### Packages Required
+
+```
+yarn add http-status http-errors @aws-sdk/client-s3 @aws-sdk/s3-request-presigner zod dotenv
+```
+
+### Implementation
+
+```ts
+// 1. signed url for previewing file
+const key = "file-management/sample.pdf";
+const fileName = "sample.pdf";
+const downlaod = false as boolean;
+
+const previewSignedUrl = await s3Service.generateSignedURL({
+  key: key,
+  fileName: fileName,
+  download: download,
+});
+
+// 2. generate a pre-signed url for uploading the file
+const fileName = "sample.pdf";
+const prefix = "file-management/";
+
+const { signedUrl: preSignedUploadUrl, key } =
+  await s3Service.generatePresignedUrl({ prefix, fileName });
+
+// Optionally for mime-types
+import mime from "mime-types";
+const mimeType = mime.lookup(fileName);
+
+// 3. Delete file
+await s3Service.deleteFile(file.key);
+```

package/modules/express/s3/s3.config.ts

@@ -0,0 +1,24 @@
+import "dotenv/config";
+
+import ms from "ms";
+import { z } from "zod";
+
+// validate environment variables to ensure they are available at runtime
+const envSchema = z.object({
+  BUCKET: z.string().optional(),
+  AWS_REGION: z.string().nonempty(),
+  AWS_ACCESS_KEY_ID: z.string().nonempty(),
+  AWS_SECRET_ACCESS_KEY: z.string().nonempty(),
+});
+
+export const env = envSchema.parse(process.env);
+
+export default {
+  aws: {
+    bucket: env.BUCKET,
+    region: env.AWS_REGION,
+    accessKeyId: env.AWS_ACCESS_KEY_ID,
+    secretAccessKey: env.AWS_SECRET_ACCESS_KEY,
+    uploadSignedUrlExpiresIn: ms("60m"), // since we are expecting large files, we are setting this to 60 minutes
+  },
+};

package/modules/express/s3/s3.lib.ts

@@ -0,0 +1,11 @@
+import { S3Client } from '@aws-sdk/client-s3';
+
+import config from './s3.config';
+
+export const s3Client = new S3Client({
+  region: config.aws.region,
+  credentials: {
+    accessKeyId: config.aws.accessKeyId,
+    secretAccessKey: config.aws.secretAccessKey,
+  },
+});

package/modules/express/s3/s3.service.ts

@@ -0,0 +1,103 @@
+import httpStatus from "http-status";
+import createError from "http-errors";
+import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
+import {
+  GetObjectCommand,
+  PutObjectCommand,
+  HeadObjectCommand,
+  DeleteObjectCommand,
+} from "@aws-sdk/client-s3";
+
+import config from "./s3.config";
+import { s3Client } from "./s3.lib";
+import { generateString, getMime } from "./S3.helper";
+
+import { IGeneratePresignedUrl } from "./s3.interface";
+
+export const msToSeconds = (ms: number) => ms / 1000;
+
+/**
+ * Generates a signed URL for accessing an S3 object.
+ * @param {string} key - The file name stored in s3.
+ * @param {string} fileName - The file name stored in db.
+ * @returns {Promise<{key: string, signedUrl: string}>>} The signed URL.
+ */
+export const generateSignedURL = async ({
+  key,
+  fileName,
+  download,
+}: {
+  key: string;
+  fileName: string;
+  download: boolean;
+}) => {
+  const getObjectParams = {
+    Bucket: config.aws.bucket,
+    Key: key,
+    ...(download
+      ? { ResponseContentDisposition: `attachment;filename=${fileName}` }
+      : {}), // use browser default download manager
+  };
+
+  const command = new GetObjectCommand(getObjectParams);
+  const signedUrl = await getSignedUrl(s3Client, command, { expiresIn: 120 });
+
+  return {
+    key,
+    signedUrl,
+  };
+};
+
+/**
+ * Generates a presigned URL for uploading a file to an S3 bucket.
+ * @param {object} params - The parameters for generating the presigned URL.
+ * @param {string} params.bucket - The S3 bucket name.
+ * @param {string} params.fileName - The desired file name.
+ * @returns {Promise<{key: string, signedUrl: string}>} The presigned URL.
+ */
+export const generatePresignedUrl = async ({
+  prefix = "",
+  bucket,
+  fileName,
+}: IGeneratePresignedUrl) => {
+  const mime = getMime(fileName);
+
+  const key = prefix + `${await generateString(10)}_${Date.now()}.` + mime;
+
+  const command = new PutObjectCommand({
+    Bucket: bucket || config.aws.bucket,
+    Key: key,
+  });
+  const signedUrl = await getSignedUrl(s3Client, command, {
+    expiresIn: msToSeconds(config.aws.uploadSignedUrlExpiresIn),
+  });
+  return {
+    key,
+    signedUrl,
+  };
+};
+
+export const getFileSize = async (key: string): Promise<number> => {
+  const getObjectMetaDataParams = {
+    Bucket: config.aws.bucket,
+    Key: key,
+  };
+
+  const response = await s3Client.send(
+    new HeadObjectCommand(getObjectMetaDataParams)
+  );
+  const sizeInBytes = response.ContentLength;
+
+  if (!sizeInBytes) throw createError(httpStatus.NOT_FOUND, "File not found");
+
+  return sizeInBytes;
+};
+
+export const deleteFile = (key: string) => {
+  const deleteObjectParams = {
+    Bucket: config.aws.bucket,
+    Key: key,
+  };
+
+  return s3Client.send(new DeleteObjectCommand(deleteObjectParams));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mgc",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "A cli based tool for generating your saved modules",
   "author": "Admond Tamang",
   "license": "MIT",
@@ -8,6 +8,10 @@
   "bin": {
     "cli": "bin/generate.js"
   },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:admondtamang/module-generate-cli.git"
+  },
   "publishConfig": {
     "access": "public"
   },

package/readme.md

@@ -7,10 +7,10 @@ Module Generate Cli (mgc)
 To generate a module
 
 ```
-mgc gen express/email
+npx mgc gen express/email
 ```
 
 ## Inspiration
 
-https://github.com/arminbro/generate-react-cli#openai-integration-alpha-release
-https://github.com/shadcn-ui
+- https://github.com/arminbro/generate-react-cli#openai-integration-alpha-release
+- https://github.com/shadcn-ui

package/services/filecopy.service.js

@@ -39,13 +39,13 @@ export const getCurrentFolder = (name) => {
   else return name;
 };
 
-export const generateProject = (modulePath, toGeneratePath) => {
+export const generateModule = (modulePath, toGeneratePath) => {
   // to get __dirname
   const __filename = fileURLToPath(import.meta.url);
   const __dirname = path.dirname(__filename);
 
   // copy template files and folders
-  const templatePath = path.join(__dirname, "../templates/" + modulePath);
+  const templatePath = path.join(__dirname, "../modules/" + modulePath);
 
   // generate module folder
   const moduleName = getCurrentFolder(modulePath);
@@ -58,5 +58,5 @@ export const generateProject = (modulePath, toGeneratePath) => {
   // copy module to your dir
   copyFolderSync(templatePath, newPathToGenerate);
 
-  console.log("Module generated successfully!");
+  console.log("Yeah!!! Module generated successfully!");
 };

package/templates/express/s3/s3.service.ts

@@ -1,121 +0,0 @@
-import fs from 'fs';
-import httpStatus from 'http-status';
-import createError from 'http-errors';
-import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { GetObjectCommand, PutObjectCommand, HeadObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
-
-import { config } from '../../../config';
-import { s3Client } from '../../../lib/aws';
-import { generateString, getMime } from './S3.helper';
-import { msToSeconds } from '../../../utils/msToSeconds';
-
-import { IFileUploadResult, IGeneratePresignedUrl, IPutFilesOptions } from './s3.interface';
-
-/**
- * Generates a signed URL for accessing an S3 object.
- * @param {string} key - The file name stored in s3.
- * @returns {Promise<{key: string, signedUrl: string}>>} The signed URL.
- */
-export const generateSignedURL = async (key: string) => {
-  const getObjectParams = {
-    Bucket: config.aws.bucket,
-    Key: key,
-  };
-
-  const command = new GetObjectCommand(getObjectParams);
-  const signedUrl = await getSignedUrl(s3Client, command, { expiresIn: 120 });
-
-  return {
-    key,
-    signedUrl,
-  };
-};
-
-/**
- * Generates a presigned URL for uploading a file to an S3 bucket.
- * @param {object} params - The parameters for generating the presigned URL.
- * @param {string} params.bucket - The S3 bucket name.
- * @param {string} params.fileName - The desired file name.
- * @returns {Promise<{key: string, signedUrl: string}>} The presigned URL.
- */
-export const generatePresignedUrl = async ({ prefix = '', bucket, fileName }: IGeneratePresignedUrl) => {
-  const mime = getMime(fileName);
-
-  const key = prefix + `${await generateString(10)}_${Date.now()}.` + mime;
-
-  const command = new PutObjectCommand({ Bucket: bucket || config.aws.bucket, Key: key });
-  const signedUrl = await getSignedUrl(s3Client, command, {
-    expiresIn: msToSeconds(config.aws.uploadSignedUrlExpiresIn),
-  });
-  return {
-    key,
-    signedUrl,
-  };
-};
-
-/**
- * Uploads multiple files to an S3 bucket.
- * @param {any[]} files - The array of files to upload.
- * @param {IOptions} [options] - The optional upload options.
- * @returns {Promise<IFileUploadResult[]>} The array of file upload results.
- */
-export const putFilesToBucket = async (files: any, options?: IPutFilesOptions): Promise<IFileUploadResult[]> => {
-  let path = options?.path;
-
-  const bucketName = options?.bucketName || config.aws.bucket;
-
-  return await Promise.all(
-    files.map(async (file: any) => {
-      const fileContent = fs.readFileSync(file.path);
-
-      const originalname = file.originalname;
-      const mime = getMime(originalname);
-
-      const filename = `${await generateString(10)}_${Date.now()}.` + mime;
-      if (path) path = path.startsWith('/') ? path.replace('/', '') : `${path}`;
-
-      // path from aws
-      const key = path ? `${path}/${filename}` : filename;
-      const filePath = `https://${bucketName}.s3.amazonaws.com/${key}`;
-
-      const command = new PutObjectCommand({
-        Bucket: bucketName,
-        Key: key,
-        Body: fileContent,
-      });
-
-      await s3Client.send(command);
-
-      return {
-        key,
-        mime,
-        completedUrl: filePath,
-        originalFileName: originalname,
-        createdAt: new Date(),
-      };
-    }),
-  );
-};
-
-export const getFileSize = async (key: string): Promise<number> => {
-  const getObjectMetaDataParams = {
-    Bucket: config.aws.bucket,
-    Key: key,
-  };
-
-  const response = await s3Client.send(new HeadObjectCommand(getObjectMetaDataParams));
-  const sizeInBytes = response.ContentLength;
-
-  if (!sizeInBytes) throw createError(httpStatus.NOT_FOUND, 'File not found');
-
-  return sizeInBytes;
-};
-
-export const deleteFile = (key: string) => {
-  const deleteObjectParams = {
-    Bucket: config.aws.bucket,
-    Key: key,
-  };
-
-  return s3Client.send(new DeleteObjectCommand(deleteObjectParams));
-};