neonctl 2.5.0 → 2.6.0

package/analytics.js

@@ -48,15 +48,7 @@ export const analyticsMiddleware = async (args) => {
     client.track({
         userId: userId ?? 'anonymous',
         event: 'CLI Started',
-        properties: {
-            version: pkg.version,
-            command: args._.join(' '),
-            flags: {
-                output: args.output,
-            },
-            ci: isCi(),
-            githubEnvVars: getGithubEnvVars(process.env),
-        },
+        properties: getAnalyticsEventProperties(args),
         context: {
             direct: true,
         },
@@ -97,3 +89,12 @@ export const trackEvent = (event, properties) => {
     });
     log.debug('Sent CLI event: %s', event);
 };
+export const getAnalyticsEventProperties = (args) => ({
+    version: pkg.version,
+    command: args._.join(' '),
+    flags: {
+        output: args.output,
+    },
+    ci: isCi(),
+    githubEnvVars: getGithubEnvVars(process.env),
+});

package/commands/branches.js

@@ -36,6 +36,10 @@ export const builder = (argv) => argv
     },
 })
     .middleware(fillSingleProject)
+    .middleware((args) => {
+    // Provide alias for analytics
+    args.branchId ?? (args.branchId = args.id);
+})
     .command('list', 'List branches', (yargs) => yargs, (args) => list(args))
     .command('create', 'Create a branch', (yargs) => yargs.options({
     name: branchCreateRequest['branch.name'],
@@ -94,6 +98,7 @@ export const builder = (argv) => argv
     .middleware((args) => {
     args.id = args.targetId;
     args.pointInTime = args['source@(timestamp'];
+    args.branchId = args.id; // for analytics
 })
     .usage('$0 branches restore <target-id|name> <source>[@(timestamp|lsn)]')
     .options({

package/commands/projects.js

@@ -26,6 +26,10 @@ export const aliases = ['project'];
 export const builder = (argv) => {
     return argv
         .usage('$0 projects <sub-command> [options]')
+        .middleware((args) => {
+        // Provide alias for analytics
+        args.projectId = args.id;
+    })
         .command('list', 'List projects', (yargs) => yargs.options({
         'org-id': {
             describe: 'List projects of a given organization',

package/index.js

@@ -20,7 +20,7 @@ import { defaultClientID } from './auth.js';
 import { fillInArgs } from './utils/middlewares.js';
 import pkg from './pkg.js';
 import commands from './commands/index.js';
-import { analyticsMiddleware, closeAnalytics, sendError } from './analytics.js';
+import { analyticsMiddleware, closeAnalytics, getAnalyticsEventProperties, sendError, trackEvent, } from './analytics.js';
 import { isAxiosError } from 'axios';
 import { matchErrorCode } from './errors.js';
 import { showHelp } from './help.js';
@@ -180,6 +180,11 @@ builder = builder
 void (async () => {
     try {
         const args = await builder.argv;
+        trackEvent('cli_command_success', {
+            ...getAnalyticsEventProperties(args),
+            projectId: args.projectId,
+            branchId: args.branchId,
+        });
         if (args._.length === 0 || args.help) {
             await showHelp(builder);
             process.exit(0);

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",

package/utils/enrichers.js

@@ -15,7 +15,7 @@ export const branchIdResolve = async ({ branch, apiClient, projectId, }) => {
     }
     return branchData.id;
 };
-export const branchIdFromProps = async (props) => {
+const getBranchIdFromProps = async (props) => {
     const branch = 'branch' in props && typeof props.branch === 'string'
         ? props.branch
         : props.id;
@@ -35,11 +35,15 @@ export const branchIdFromProps = async (props) => {
     }
     throw new Error('No default branch found');
 };
+export const branchIdFromProps = async (props) => {
+    props.branchId = await getBranchIdFromProps(props);
+    return props.branchId;
+};
 export const fillSingleProject = async (props) => {
     if (props.projectId) {
         return props;
     }
-    const { data } = await props.apiClient.listProjects({});
+    const { data } = await props.apiClient.listProjects({ limit: 2 });
     if (data.projects.length === 0) {
         throw new Error('No projects found');
     }