@pitcher/cli-scripts 2.19.0 → 2.20.0

package/dist/src/commands/analytics.d.ts

@@ -22,7 +22,9 @@ export interface AnalyticsKpiOpts extends CommonOpts {
  * org/instance rollups (Django), this hits `clickhouse.pitcher.com` with the
  * org api-key; the caller inherits the key user's real role. Dates are required
  * by the server for activity-metric types (inventory counts like
- * `total-members` need none) — that validation stays server-side.
+ * `total-members` need none) — that validation stays server-side, as does the
+ * set of valid `type` values (a bad one comes back as a 400 listing them). There
+ * is no aggregate `all` type, so `--type` is required.
  */
 export declare function runAnalyticsKpi(opts: AnalyticsKpiOpts, deps?: AnalyticsDeps): Promise<Envelope<unknown>>;
 export interface AnalyticsEngagementOpts extends CommonOpts {

package/dist/src/commands/analytics.js

@@ -32,16 +32,20 @@ export async function runAnalyticsInstance(opts, deps = {}) {
  * org/instance rollups (Django), this hits `clickhouse.pitcher.com` with the
  * org api-key; the caller inherits the key user's real role. Dates are required
  * by the server for activity-metric types (inventory counts like
- * `total-members` need none) — that validation stays server-side.
+ * `total-members` need none) — that validation stays server-side, as does the
+ * set of valid `type` values (a bad one comes back as a 400 listing them). There
+ * is no aggregate `all` type, so `--type` is required.
  */
 export async function runAnalyticsKpi(opts, deps = {}) {
     try {
         if (!opts.instanceId)
             throw createCliError('VALIDATION', '--instance-id is required for analytics kpi');
+        if (!opts.type)
+            throw createCliError('VALIDATION', '--type is required for analytics kpi');
         const client = clickhouseClientFor(opts, deps);
         const params = {
             instance_id: opts.instanceId,
-            type: opts.type || 'all',
+            type: opts.type,
         };
         if (opts.startDate)
             params.start_date = opts.startDate;
@@ -376,7 +380,7 @@ export function createAnalyticsCommand() {
     });
     withAuthFlags(cmd.command('kpi'))
         .option('--instance-id <id>', 'Instance ID (required)')
-        .option('--type <type>', "KPI type, e.g. total-members, total-active-users (default 'all')")
+        .option('--type <type>', 'KPI type, e.g. total-members, total-active-users (required)')
         .option('--start-date <iso>', 'Window start (ISO date; required by the server for activity metrics)')
         .option('--end-date <iso>', 'Window end (ISO date; required by the server for activity metrics)')
         .option('--group-ids <csv>', 'Comma-separated distribution-group IDs to scope by')

package/dist/src/mcp/tools/analytics.js

@@ -25,7 +25,7 @@ export const analyticsTools = [
             '(inventory counts like total-members do not).',
         inputShape: {
             instanceId: z.string().describe('Instance ID (required)'),
-            type: z.string().optional().describe("KPI type, e.g. total-members, total-active-users (default 'all')"),
+            type: z.string().describe('KPI type, e.g. total-members, total-active-users (required)'),
             startDate: z.string().optional().describe('Window start, ISO date (required by the server for activity metrics)'),
             endDate: z.string().optional().describe('Window end, ISO date (required by the server for activity metrics)'),
             groupIds: z.string().optional().describe('Comma-separated distribution-group IDs to scope by'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/cli-scripts",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "description": "The Pitcher CLI for various tasks in its ecosystem.",
   "author": "Pitcher AG",
   "license": "MIT",