avo 3.0.0-beta.1 → 3.1.0

package/cli.js

@@ -25,7 +25,7 @@ import walk from 'ignore-walk';
 import writeFile from 'write';
 import { writeJsonFile } from 'write-json-file';
 import Configstore from 'configstore';
-import Inspector from 'node-avo-inspector';
+import { AvoInspector, AvoInspectorEnv } from 'node-avo-inspector';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import httpShutdown from 'http-shutdown';
@@ -293,7 +293,7 @@ const customAnalyticsDestination = {
     make: function make(production) {
         this.production = production;
     },
-    logEvent: function logEvent(userId, eventName, eventProperties) {
+    logEvent: (userId, eventName, eventProperties) => {
         api
             .request('POST', '/c/v1/track', {
             origin: api.apiOrigin,
@@ -306,17 +306,18 @@ const customAnalyticsDestination = {
             .catch(() => {
             // don't crash on tracking errors
         });
+        return undefined;
     },
-    setUserProperties: () => { }, // noop
+    setUserProperties: () => undefined, // noop
 };
-const inspector = new Inspector.AvoInspector({
+const inspector = new AvoInspector({
     apiKey: '3UWtteG9HenZ825cYoYr',
-    env: Inspector.AvoInspectorEnv.Prod,
-    version: '1.0.0',
+    env: AvoInspectorEnv.Prod,
+    version: pkg.version,
     appName: 'Avo CLI',
 });
 // setup Avo analytics
-Avo.initAvo({ env: 'prod', inspector }, { client: Avo.Client.CLI, version: pkg.version }, {}, customAnalyticsDestination);
+Avo.initAvo({ env: Avo.AvoEnv.Prod, inspector }, { client: Avo.Client.CLI, version: pkg.version }, {}, customAnalyticsDestination);
 function isLegacyAvoJson(json) {
     // check if legacy avo.json or un-initialized project
     return json.types ?? !json.schema;
@@ -739,7 +740,11 @@ function loadAvoJsonOrInit({ argv, skipPullMaster, skipInit }) {
         }
         return Promise.resolve(JSON.parse(avoFile));
     })
-        .then((json) => Promise.resolve({ ...json, force: argv.f === true }))
+        .then((json) => Promise.resolve({
+        ...json,
+        force: argv.f === true,
+        forceFeatures: argv.forceFeatures,
+    }))
         .then(validateAvoJson)
         .catch((error) => {
         if (error.code === 'ENOENT' && skipInit) {
@@ -757,7 +762,7 @@ function writeAvoJson(json) {
         indent: 2,
     }).then(() => json);
 }
-function codegen(json, { schema, sources: targets, warnings, errors }) {
+function codegen(json, { schema, sources: targets, warnings, success, errors }) {
     const newJson = { ...JSON.parse(JSON.stringify(json)), schema };
     newJson.sources = newJson.sources.map((source) => {
         const target = targets.find(({ id }) => id === source.id);
@@ -787,6 +792,11 @@ function codegen(json, { schema, sources: targets, warnings, errors }) {
                 report.warn(warning);
             });
         }
+        if (success !== undefined && success !== null && Array.isArray(success)) {
+            success.forEach((success) => {
+                report.success(success);
+            });
+        }
         report.success(`Analytics ${targets.length > 1 ? 'wrappers' : 'wrapper'} successfully updated`);
         targets.forEach((target) => {
             const source = newJson.sources.find(({ id }) => id === target.id);
@@ -923,6 +933,7 @@ function pull(sourceFilter, json) {
                 path: source.path,
             })),
             force: json.force ?? false,
+            forceFeatures: json.forceFeatures,
         },
     }))
         .then((result) => {
@@ -1253,6 +1264,9 @@ function logout(refreshToken) {
         conf.delete('tokens');
     }
 }
+function parseForceFeaturesParam(forceFeatures) {
+    return forceFeatures?.split(',').map((it) => it.trim());
+}
 yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     .usage('$0 command')
     .scriptName('avo')
@@ -1262,12 +1276,6 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     default: false,
     describe: 'make output more verbose',
     type: 'boolean',
-})
-    .option('f', {
-    alias: 'force',
-    describe: 'Proceed with merge when incoming branch is open',
-    default: false,
-    type: 'boolean',
 })
     .command({
     command: 'track-install',
@@ -1294,6 +1302,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                     userId_: installIdOrUserId(),
                     cliAction: Avo.CliAction.INIT,
                     cliInvokedByCi: invokedByCi(),
+                    force: undefined,
+                    forceFeatures: undefined,
                 });
                 report.info(`Avo is already initialized for workspace ${cyan(json.schema.name)} (${file('avo.json')} exists)`);
                 return Promise.resolve();
@@ -1306,6 +1316,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.INIT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             return requireAuth(argv, () => init()
                 .then(writeAvoJson)
@@ -1322,6 +1334,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.INIT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
         });
     },
@@ -1329,8 +1343,21 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     .command({
     command: 'pull [source]',
     desc: 'Pull analytics wrappers from Avo workspace',
-    builder: (yargs) => yargs.option('branch', {
+    builder: (yargs) => yargs
+        .option('branch', {
         describe: 'Name of Avo branch to pull from',
+        default: 'main',
+        type: 'string',
+    })
+        .option('f', {
+        alias: 'force',
+        describe: 'Proceed ignoring the unsupported features for given source',
+        default: false,
+        type: 'boolean',
+    })
+        .option('forceFeatures', {
+        describe: 'Optional comma separated list of features to force enable',
+        default: undefined,
         type: 'string',
     }),
     handler: (argv) => {
@@ -1344,6 +1371,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.PULL,
                 cliInvokedByCi: invokedByCi(),
+                force: argv.f === true,
+                forceFeatures: parseForceFeaturesParam(argv.forceFeatures),
             });
             requireAuth(argv, () => {
                 if (argv.branch && json.branch.name !== argv.branch) {
@@ -1364,6 +1393,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.PULL,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             throw error;
         });
@@ -1383,6 +1414,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
             userId_: installIdOrUserId(),
             cliAction: Avo.CliAction.CHECKOUT,
             cliInvokedByCi: invokedByCi(),
+            force: undefined,
+            forceFeatures: undefined,
         });
         report.info(`Currently on branch '${json.branch.name}'`);
         requireAuth(argv, () => checkout(argv.branch, json).then(writeAvoJson));
@@ -1396,6 +1429,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
             userId_: installIdOrUserId(),
             cliAction: Avo.CliAction.CHECKOUT,
             cliInvokedByCi: invokedByCi(),
+            force: undefined,
+            forceFeatures: undefined,
         });
         throw error;
     }),
@@ -1419,6 +1454,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     if (!json.sources || !json.sources.length) {
                         report.info(`No sources defined in ${file('avo.json')}. Run ${cmd('avo source add')} to add sources`);
@@ -1439,6 +1476,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     throw error;
                 });
@@ -1458,6 +1497,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE_ADD,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     requireAuth(argv, () => {
                         selectSource(argv.source, json).then(writeAvoJson);
@@ -1472,6 +1513,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE_ADD,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     throw error;
                 });
@@ -1492,6 +1535,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE_REMOVE,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     if (!json.sources || !json.sources.length) {
                         report.warn(`No sources defined in ${file('avo.json')}. Run ${cmd('avo source add')} to add sources`);
@@ -1552,6 +1597,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                         userId_: installIdOrUserId(),
                         cliAction: Avo.CliAction.SOURCE_REMOVE,
                         cliInvokedByCi: invokedByCi(),
+                        force: undefined,
+                        forceFeatures: undefined,
                     });
                     throw error;
                 });
@@ -1573,6 +1620,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.STATUS,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             report.info(`Currently on branch '${json.branch.name}'`);
             return getSource(argv, json);
@@ -1587,6 +1636,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.STATUS,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             throw error;
         });
@@ -1596,6 +1647,12 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     command: 'merge main',
     aliases: ['merge master'],
     desc: 'Pull the Avo main branch into your current branch',
+    builder: (yargs) => yargs.option('f', {
+        alias: 'force',
+        describe: 'Proceed with merge when incoming branch is open',
+        default: false,
+        type: 'boolean',
+    }),
     handler: (argv) => {
         loadAvoJsonOrInit({ argv, skipPullMaster: true, skipInit: false })
             .then((json) => {
@@ -1608,6 +1665,7 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 cliAction: Avo.CliAction.MERGE,
                 cliInvokedByCi: invokedByCi(),
                 force: json.force,
+                forceFeatures: undefined,
             });
             return requireAuth(argv, () => pullMaster(json).then(writeAvoJson));
         })
@@ -1620,6 +1678,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.MERGE,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             throw error;
         });
@@ -1644,6 +1704,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                     userId_: installIdOrUserId(),
                     cliAction: Avo.CliAction.CONFLICT,
                     cliInvokedByCi: invokedByCi(),
+                    force: undefined,
+                    forceFeatures: undefined,
                 });
                 pull(null, json);
             }));
@@ -1658,6 +1720,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
             userId_: installIdOrUserId(),
             cliAction: Avo.CliAction.CONFLICT,
             cliInvokedByCi: invokedByCi(),
+            force: undefined,
+            forceFeatures: undefined,
         });
         return Promise.resolve(json);
     })
@@ -1670,6 +1734,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
             userId_: installIdOrUserId(),
             cliAction: Avo.CliAction.CONFLICT,
             cliInvokedByCi: invokedByCi(),
+            force: undefined,
+            forceFeatures: undefined,
         });
         throw error;
     }),
@@ -1688,6 +1754,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.EDIT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             const { schema } = json;
             const schemaUrl = `https://www.avo.app/schemas/${schema.id}`;
@@ -1703,6 +1771,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.EDIT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             throw error;
         });
@@ -1725,7 +1795,7 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 Avo.signedIn({
                     userId_: result.user.user_id,
                     email: result.user.email,
-                    cliInvokedByCi: invokedByCi(),
+                    authenticationMethod: Avo.AuthenticationMethod.CLI,
                 });
                 report.success(`Logged in as ${email(result.user.email)}`);
             })
@@ -1734,7 +1804,6 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                     userId_: conf.get('avo_install_id'),
                     emailInput: '',
                     signInError: Avo.SignInError.UNKNOWN,
-                    cliInvokedByCi: invokedByCi(),
                 });
             });
         };
@@ -1748,6 +1817,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.LOGIN,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         })
@@ -1760,6 +1831,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.LOGIN,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         });
@@ -1804,6 +1877,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.LOGOUT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         })
@@ -1816,6 +1891,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.LOGOUT,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         });
@@ -1846,6 +1923,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.WHOAMI,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         })
@@ -1858,6 +1937,8 @@ yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
                 userId_: installIdOrUserId(),
                 cliAction: Avo.CliAction.WHOAMI,
                 cliInvokedByCi: invokedByCi(),
+                force: undefined,
+                forceFeatures: undefined,
             });
             command();
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "avo",
-  "version": "3.0.0-beta.1",
+  "version": "3.1.0",
   "type": "module",
   "description": "The command-line interface for Avo",
   "author": "Avo (https://www.avo.app)",