avo 3.2.1 → 3.2.3

package/README.md

@@ -1,6 +1,12 @@
-![https://www.avo.app](https://firebasestorage.googleapis.com/v0/b/avo-frontpage.appspot.com/o/logo%2Fassets%2Favo.png?alt=media&token=2acfd7bd-2faf-4787-a450-8f99c407a483)
+# Avo CLI
 
-## Install
+Better event tracking, **faster**.
+
+![https://www.avo.app](https://cdn.avo.app/assets/avo-cado.png)
+
+The Avo CLI gives you access to [Avo Codegen](https://www.avo.app/docs/implementation/devs-101) right from your command line. It allows you to pull [your Avo tracking plan](http://avo.app/schemas/default) as type-safe functions for each of your events, making analytics implementation quick and seamless. Avo Codegen supports a variety of [platforms, programming languages and destinations](https://www.avo.app/docs/implementation/supported-programming-languages). 
+
+## Installation
 
 Avo runs on Node `>=14.16`. To install the latest version of Avo CLI, run this command:
 
@@ -15,6 +21,7 @@ $ avo --help
 avo command
 
 Commands:
+  avo login              Log into the Avo platform
   avo init               Initialize an Avo workspace in the current folder
   avo pull [source]      Pull analytics wrappers from Avo workspace
   avo checkout [branch]  Switch branches                               [aliases: branch]
@@ -23,7 +30,6 @@ Commands:
   avo merge main         Pull the Avo main branch into your current branch
   avo conflict           Resolve git conflicts in Avo files            [aliases: resolve, conflicts]
   avo edit               Open the Avo workspace in your browser
-  avo login              Log into the Avo platform
   avo logout             Log out from the Avo platform
   avo whoami             Shows the currently logged in username
 
@@ -34,24 +40,9 @@ Options:
   --help         Show help                                             [boolean]
 ```
 
-For more detailed documentation, visit [https://www.avo.app/docs/commands](https://www.avo.app/docs/commands)
-
-## Caught a Bug?
+For more documentation, visit [https://www.avo.app/docs/implementation/cli](https://www.avo.app/docs/implementation/cli)
 
-Thank you, you are precious to us :hug: Please send an email to friends@avo.app or file an issue here on GitHub.
 
-## How to contribute
-
-Make your changes and add them to the _Unreleased_ section in CHANGELOG.md
-
-## How to Create a Release
-
-1. Verify that the changes in the _Unrelased_ section in CHANGELOG.md are accurate, create a new heading with the correct semantic version then move the content from the _Unreleased_ section there
-2. Update the semantic version in `package.json` to match the one you just created in the changelog
-3. Commit with the message "Release <version>" and push the changes
-4. Publish the package to npm (you'll need to be a maintainer of the avo project in npm)
-
-```
-npm publish
-```
+**Caught a Bug?** Thank you, you are precious to us :hug: Please create a issue on the GitHub repo or send an email to friends@avo.app. We'll do our best to resolve it quickly!
 
+**To create a release:** Verify that the changes in the _Unreleased_ section in CHANGELOG.md are accurate, create a new heading with the correct semantic version then move the content from the _Unreleased_ section there • Update the semantic version in `package.json` to match the one you just created in the changelog • Commit with the message "Release <version>" and push the changes • Publish the package to npm (you'll need to be a maintainer of the avo project in npm): `npm publish`

package/cli.js

@@ -135,8 +135,20 @@ function responseToError(response) {
         }
     }
     if (!body.error) {
+        const getMessage = (statusCode) => {
+            switch (statusCode) {
+                case 401:
+                    return 'Unauthorized';
+                case 403:
+                    return 'Forbidden. Do you have the required permissions? Some commands require editor or admin access.';
+                case 404:
+                    return 'Not Found';
+                default:
+                    return 'Unknown Error';
+            }
+        };
         body.error = {
-            message: response.statusCode === 404 ? 'Not Found' : 'Unknown Error',
+            message: getMessage(response.statusCode),
         };
     }
     const message = `HTTP Error: ${response.statusCode}, ${body.error.message ?? body.error}`;
@@ -375,11 +387,14 @@ function extractConflictingFiles(str) {
     }
     return [files[0].join('\n'), files[1].join('\n')];
 }
-const BRANCH_UP_TO_DATE = 'branch-up-to-date';
-const BRANCH_NOT_UP_TO_DATE = 'branch-not-up-to-date';
+var BranchStatus;
+(function (BranchStatus) {
+    BranchStatus["BRANCH_UP_TO_DATE"] = "branch-up-to-date";
+    BranchStatus["BRANCH_NOT_UP_TO_DATE"] = "branch-not-up-to-date";
+})(BranchStatus || (BranchStatus = {}));
 function getMasterStatus(json) {
     if (json.branch.id === 'master') {
-        return Promise.resolve(BRANCH_UP_TO_DATE);
+        return Promise.resolve(BranchStatus.BRANCH_UP_TO_DATE);
     }
     return api
         .request('POST', '/c/v1/master', {
@@ -390,7 +405,9 @@ function getMasterStatus(json) {
             branchId: json.branch.id,
         },
     })
-        .then(({ pullRequired }) => pullRequired ? BRANCH_NOT_UP_TO_DATE : BRANCH_UP_TO_DATE);
+        .then(({ pullRequired }) => pullRequired
+        ? BranchStatus.BRANCH_NOT_UP_TO_DATE
+        : BranchStatus.BRANCH_UP_TO_DATE);
 }
 function pullMaster(json) {
     if (json.branch.name === 'main') {
@@ -419,7 +436,7 @@ function promptPullMaster(json) {
     return getMasterStatus(json)
         .then((branchStatus) => {
         cancelWait();
-        if (branchStatus === BRANCH_NOT_UP_TO_DATE) {
+        if (branchStatus === BranchStatus.BRANCH_NOT_UP_TO_DATE) {
             return inquirer
                 .prompt([
                 {
@@ -435,7 +452,7 @@ function promptPullMaster(json) {
         return Promise.resolve([branchStatus]);
     })
         .then(([branchStatus, answer]) => {
-        if (branchStatus === BRANCH_UP_TO_DATE) {
+        if (branchStatus === BranchStatus.BRANCH_UP_TO_DATE) {
             report.success('Branch is up to date with main');
             return Promise.resolve(json);
         }
@@ -477,7 +494,7 @@ function requireAuth(argv, cb) {
 function init() {
     const makeAvoJson = (schema) => {
         report.success(`Initialized for workspace ${cyan(schema.name)}`);
-        return {
+        return Promise.resolve({
             avo: {
                 version: semver.major(pkg.version),
             },
@@ -489,7 +506,7 @@ function init() {
                 id: 'master',
                 name: 'main',
             },
-        };
+        });
     };
     wait('Initializing');
     return api
@@ -533,7 +550,10 @@ function validateAvoJson(json) {
         return init();
     }
     // augment the latest major version into avo.json
-    return { ...json, avo: { ...json.avo, version: semver.major(pkg.version) } };
+    return Promise.resolve({
+        ...json,
+        avo: { ...json.avo, version: semver.major(pkg.version) },
+    });
 }
 function fetchBranches(json) {
     wait('Fetching open branches');
@@ -732,7 +752,7 @@ function loadAvoJson() {
         }
     });
 }
-function loadAvoJsonOrInit({ argv, skipPullMaster, skipInit }) {
+function loadAvoJsonOrInit({ argv, skipPullMaster, skipInit, }) {
     return pify(fs.readFile)('avo.json', 'utf8')
         .then((avoFile) => {
         if (hasMergeConflicts(avoFile)) {
@@ -830,7 +850,7 @@ function selectSource(sourceToAdd, json) {
         .then((data) => {
         cancelWait();
         const existingSources = json.sources ?? [];
-        let sources = data.sources
+        const sources = data.sources
             .filter((source) => !existingSources.find(({ id }) => source.id === id))
             .sort((a, b) => {
             if (a.name < b.name)
@@ -948,8 +968,7 @@ function selectSource(sourceToAdd, json) {
                     interfacePath: relativeInterfacePath,
                 };
             }
-            sources = (json.sources ?? []).concat([source]);
-            const newJson = { ...json, sources };
+            const newJson = { ...json, sources: [...json.sources, source] };
             report.info(`Added source ${source.name} to the project`);
             report.info(`Run 'avo pull "${source.name}"' to pull the latest analytics wrapper for this source`);
             return newJson;
@@ -964,7 +983,7 @@ function pull(sourceFilter, json) {
     wait(`Pulling ${sourceNames.join(', ')}`);
     return getMasterStatus(json)
         .then((masterStatus) => {
-        if (masterStatus === BRANCH_NOT_UP_TO_DATE) {
+        if (masterStatus === BranchStatus.BRANCH_NOT_UP_TO_DATE) {
             report.warn(`Your branch '${json.branch.name}' is not up to date with Avo main. To merge latest Avo main into the branch, run 'avo merge main'.`);
         }
         return Promise.resolve();
@@ -1394,7 +1413,6 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     builder: (yargs) => yargs
         .option('branch', {
         describe: 'Name of Avo branch to pull from',
-        default: 'main',
         type: 'string',
     })
         .option('f', {
@@ -1404,7 +1422,7 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
         type: 'boolean',
     })
         .option('forceFeatures', {
-        describe: 'Optional comma separated list of features to force enable',
+        describe: 'Optional comma separated list of features to force enable, pass unsupported name to get the list of available features',
         default: undefined,
         type: 'string',
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "avo",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "type": "module",
   "description": "The command-line interface for Avo",
   "author": "Avo (https://www.avo.app)",
@@ -48,13 +48,16 @@
     "portfinder": "^1.0.28",
     "semver": "^7.3.7",
     "update-notifier": "^6.0.2",
-    "uuid": "^8.3.2",
+    "uuid": "^9.0.0",
     "write": "^2.0.0",
     "write-json-file": "^5.0.0",
     "yargs": "^17.2.1",
     "yurnalist": "^2.1.0"
   },
   "devDependencies": {
+    "@types/ignore-walk": "^4.0.0",
+    "@types/minimatch": "^5.1.2",
+    "@types/node": "^18.7.18",
     "@typescript-eslint/eslint-plugin": "^5.30.5",
     "@typescript-eslint/parser": "^5.30.5",
     "eslint": "^7.32.0 || ^8.2.0",