Chore/fix copy command (#23)

Author: vaidik

.eslintignore

@@ -1 +1,2 @@
 build/
+dist/

README.md

@@ -95,15 +95,12 @@ process. Head over the to the [detailed docs
 here](docs/GOOGLE-API-CREDENTIALS-SETUP.md) to setup the Service Account and
 generate your credentials.
 
-Now that you have your credentials in a JSON file (let's say
-`credentials.json`), you are ready to tell `gtm-tools` how to use these
-credentials by setting the environment variable `GOOGLE_APPLICATION_CREDENTIALS`.
+Now that you have your credentials in a JSON file, which is also known as the
+key file (let's call this file `credentials.json`), you are ready to tell
+`gtm-tools` how to use these credentials. Do so by updating the path to
+`tagManagerAPI.googleAuthKeyFile` config in `config.json` file.
 
-```
-export GOOGLE_APPLICATION_CREDENTIALS=<path-to-credentials>/credentials.json
-```
-
-Now test these credentials with `gtm-tools` by running the following command:
+Now, test these credentials with `gtm-tools` by running the following command:
 
 ```
 gtm-tools --config config.json list -aa gtm-prod
@@ -116,6 +113,7 @@ account.
 
 | Configuration Key                          | Type                | Default | Required | Description                                                                                                                                                                                                  |
 |--------------------------------------------|---------------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `tagManagerAPI.googleAuthKeyFile`          | string              |         | Yes      | Path to the Google Auth API credentials or key file download from Google Cloud Console. Read the [detailed docs here](docs/GOOGLE-API-CREDENTIALS-SETUP.md) to understand how to get your key file. |
 | `tagManagerAPI.defaultRateLimitBatchSize`  | int                 | 1       |          | Batch size for the count of API requests to be made to Tag Manager API without a delay. After this batch, a delay will be injected before the next batch starts, controlled by `defaultRateLimitBatchDelay`. |
 | `tagManagerAPI.defaultRateLimitBatchDelay` | int                 | 5000    |          | Add delay (in milliseconds) between subsequent batches of requests to Tag Manager API to avoid rate limiting.                                                                                                |
 | `accounts[].alias`                         | string              |         | Yes      | Human-friendly alias to refer to the account while using  `gtm-tools`.                                                                                                                                       |

src/config.ts

@@ -9,8 +9,14 @@ import {
   IsNumber,
   IsPositive,
   MinLength,
+  Validate,
+  ValidationError,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
 } from 'class-validator';
 
+import fs from 'fs';
+
 abstract class AbstractConfig {
   fixTypes() {}
 }
@@ -60,7 +66,22 @@ class AccountConfig extends AbstractConfig {
   }
 }
 
+@ValidatorConstraint({name: 'customText', async: false})
+export class IsValidGoogleAuthKeyFile implements ValidatorConstraintInterface {
+  validate(text: string) {
+    // test if text ends with .json and the file exists
+    return text !== undefined && text.endsWith('.json') && fs.existsSync(text);
+  }
+
+  defaultMessage() {
+    return 'Value for $property ($value) should be a valid file path ".json" extension and must exist at that path.';
+  }
+}
+
 class TagManagerAPIConfig extends AbstractConfig {
+  @Validate(IsValidGoogleAuthKeyFile) // 6 characters for at least ".json" and a name of the file
+  googleAuthKeyFile: string;
+
   @IsNumber()
   @IsPositive()
   defaultRateLimitBatchSize: number;
@@ -70,10 +91,12 @@ class TagManagerAPIConfig extends AbstractConfig {
   defaultRateLimitBatchDelay: number;
 
   constructor(
-    defaultRateLimitBatchSize = 5, // 15 requests per minute
-    defaultRateLimitBatchDelay = 15000 // 15 seconds
+    googleAuthKeyFile: string,
+    defaultRateLimitBatchSize = 1, // 1 request per batch
+    defaultRateLimitBatchDelay = 5000 // 5 seconds
   ) {
     super();
+    this.googleAuthKeyFile = googleAuthKeyFile;
     this.defaultRateLimitBatchSize = defaultRateLimitBatchSize;
     this.defaultRateLimitBatchDelay = defaultRateLimitBatchDelay;
   }
@@ -93,7 +116,7 @@ export class Config extends AbstractConfig {
   constructor(tagManagerAPI?: TagManagerAPIConfig, accounts?: AccountConfig[]) {
     super();
     if (tagManagerAPI === undefined) {
-      this.tagManagerAPI = new TagManagerAPIConfig();
+      this.tagManagerAPI = new TagManagerAPIConfig('');
     } else {
       this.tagManagerAPI = tagManagerAPI;
     }
@@ -123,4 +146,26 @@ export class Config extends AbstractConfig {
     }
     return matchedAccounts ? matchedAccounts[0] : undefined;
   }
+
+  formatError(error: ValidationError): string {
+    // TODO: this function can be implemented in a better way. This is just a quick hack.
+    const delimiter = '\n - ';
+    let msg = '';
+    msg += error.property + ': ' + '\n';
+
+    if (error.constraints) {
+      msg += (' - ' + Object.values(error.constraints).join(delimiter))
+        .split('\n')
+        .join('\n  ');
+    }
+
+    if (error.children && error?.children.length > 0) {
+      msg += '';
+      error.children?.forEach(child => {
+        msg += '  ' + this.formatError(child).split('\n').join('\n  ') + '\n';
+      });
+    }
+
+    return msg;
+  }
 }

src/core.ts

@@ -77,7 +77,7 @@ export class TagManagerData {
 
   async init() {
     const auth = new google.auth.GoogleAuth({
-      // Scopes can be specified either as an array or as a single, space-delimited string.
+      keyFile: this.config.tagManagerAPI.googleAuthKeyFile,
       scopes: [
         'https://www.googleapis.com/auth/tagmanager.edit.containers',
         'https://www.googleapis.com/auth/tagmanager.manage.accounts',

src/index.ts

@@ -33,18 +33,18 @@ cli.hook('preAction', async () => {
 
   await validate(configObj, {forbidUnknownValues: false}).then(errors => {
     if (errors.length > 0) {
-      cli.error('Invalid configuration file. Validation failed.'.red);
+      cli.error(
+        (
+          'Invalid configuration file. Validation failed.' +
+          '\n\n' +
+          configObj.formatError(errors[0])
+        ).red
+      );
     }
   });
 });
 
 async function main() {
-  if (!process.env.GOOGLE_APPLICATION_CREDENTIALS) {
-    cli.error(
-      'GOOGLE_APPLICATION_CREDENTIALS environment variable must be set and pointing to a valid Google API credentials.json file.'
-        .red
-    );
-  }
   await cli.parseAsync();
 }