@formo/cli 0.2.0 → 1.0.2

package/dist/commands/charts.js

@@ -1,26 +1,134 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.charts = void 0;
+exports.buildChartBody = buildChartBody;
 exports.listChartsRun = listChartsRun;
+exports.listChartSummariesRun = listChartSummariesRun;
 exports.getChartRun = getChartRun;
+exports.queryChartRun = queryChartRun;
 exports.createChartRun = createChartRun;
 exports.updateChartRun = updateChartRun;
+exports.moveChartRun = moveChartRun;
+exports.normalizeDuplicateChartResponse = normalizeDuplicateChartResponse;
+exports.duplicateChartRun = duplicateChartRun;
+exports.reorderChartsRun = reorderChartsRun;
 exports.deleteChartRun = deleteChartRun;
 const incur_1 = require("incur");
 const client_1 = require("../lib/client");
+const json_1 = require("../lib/json");
+const sql_1 = require("../lib/sql");
 exports.charts = incur_1.Cli.create('charts', {
-    description: 'Chart commands — create, list, update, and delete charts within boards',
+    description: 'Chart commands — create, list, query, move, duplicate, reorder, update, and delete charts within boards',
+});
+const chartTypeSchema = incur_1.z.enum([
+    'table',
+    'number',
+    'funnel',
+    'bar',
+    'line',
+    'area',
+    'pie',
+    'stacked',
+    'user_paths',
+    'retention',
+]);
+function buildPaginationParams(options = {}) {
+    const params = {};
+    if (options.page !== undefined)
+        params.page = options.page;
+    if (options.size !== undefined)
+        params.size = options.size;
+    return params;
+}
+function hasTypedChartFields(options) {
+    return [
+        options.query,
+        options.chartType,
+        options.title,
+        options.description,
+        options.xAxis,
+        options.yAxis,
+        options.groupBy,
+        options.steps,
+        options.settings,
+    ].some((value) => value !== undefined);
+}
+function buildChartBody(options) {
+    let body = {};
+    if (options.body) {
+        body = (0, json_1.parseJsonObject)(options.body, '--body');
+    }
+    if (!options.body && !hasTypedChartFields(options)) {
+        throw new Error('Provide --body or chart fields such as --title, --chart-type, and --query');
+    }
+    if (options.query !== undefined) {
+        body.query = (0, sql_1.stripTrailingFormatClause)(options.query);
+    }
+    if (options.chartType !== undefined)
+        body.chart_type = options.chartType;
+    if (options.title !== undefined)
+        body.title = options.title;
+    if (options.description !== undefined)
+        body.description = options.description;
+    if (options.xAxis !== undefined)
+        body.x_axis = options.xAxis;
+    if (options.yAxis !== undefined) {
+        body.y_axis = (0, json_1.parseStringArray)(options.yAxis, '--y-axis');
+    }
+    if (options.groupBy !== undefined)
+        body.group_by = options.groupBy;
+    if (options.steps !== undefined) {
+        body.steps = (0, json_1.parseJsonArray)(options.steps, '--steps');
+    }
+    if (options.settings !== undefined) {
+        body.settings = (0, json_1.parseJsonObject)(options.settings, '--settings');
+    }
+    return body;
+}
+function coerceChartBody(input) {
+    return typeof input === 'string' ? buildChartBody({ body: input }) : buildChartBody(input);
+}
+const chartBodyOptions = incur_1.z.object({
+    body: incur_1.z
+        .string()
+        .optional()
+        .describe('Raw JSON chart body. Typed flags below override matching body keys.'),
+    query: incur_1.z
+        .string()
+        .optional()
+        .describe('SQL query powering table/number/bar/line/area/pie/stacked charts'),
+    chartType: chartTypeSchema.optional().describe('Chart type'),
+    title: incur_1.z.string().optional().describe('Chart title'),
+    description: incur_1.z.string().optional().describe('Optional chart description'),
+    xAxis: incur_1.z.string().optional().describe('Column used as the x axis'),
+    yAxis: incur_1.z
+        .string()
+        .optional()
+        .describe('Comma-separated or JSON array of y-axis metric columns'),
+    groupBy: incur_1.z.string().optional().describe('Column used to group or stack series'),
+    steps: incur_1.z
+        .string()
+        .optional()
+        .describe('JSON array of funnel/user-path step objects'),
+    settings: incur_1.z
+        .string()
+        .optional()
+        .describe('JSON object of type-specific chart settings'),
 });
 // ── List charts for a board ──
-function listChartsRun(boardId) {
+function listChartsRun(boardId, options = {}) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    return client.get(`/v0/boards/${encodeURIComponent(boardId)}/charts/`);
+    return client.get(`/v0/boards/${encodeURIComponent(boardId)}/charts/`, {
+        params: buildPaginationParams(options),
+    });
 }
 exports.charts.command('list', {
-    description: 'List all charts for a board',
+    description: 'List all charts for a board, including executed results',
     options: incur_1.z.object({
         boardId: incur_1.z.string().describe('Board ID to list charts from'),
+        page: incur_1.z.coerce.number().optional().describe('Page number (1-indexed, default 1)'),
+        size: incur_1.z.coerce.number().optional().describe('Page size (default 100, max 200)'),
     }),
     examples: [
         {
@@ -30,7 +138,33 @@ exports.charts.command('list', {
     ],
     hint: 'Requires boards:read scope on your API key.',
     run({ options }) {
-        return listChartsRun(options.boardId);
+        return listChartsRun(options.boardId, options);
+    },
+});
+// ── List chart metadata for a board ──
+function listChartSummariesRun(boardId, options = {}) {
+    (0, client_1.requireApiKey)();
+    const client = (0, client_1.createClient)();
+    return client.get(`/v0/boards/${encodeURIComponent(boardId)}/charts/meta`, {
+        params: buildPaginationParams(options),
+    });
+}
+exports.charts.command('meta', {
+    description: 'List lightweight chart metadata for a board without query results',
+    options: incur_1.z.object({
+        boardId: incur_1.z.string().describe('Board ID to list chart metadata from'),
+        page: incur_1.z.coerce.number().optional().describe('Page number (1-indexed, default 1)'),
+        size: incur_1.z.coerce.number().optional().describe('Page size (default 100, max 200)'),
+    }),
+    examples: [
+        {
+            options: { boardId: 'board_abc123', size: 25 },
+            description: 'List chart summaries for a board',
+        },
+    ],
+    hint: 'Requires boards:read scope on your API key.',
+    run({ options }) {
+        return listChartSummariesRun(options.boardId, options);
     },
 });
 // ── Get a single chart ──
@@ -59,74 +193,204 @@ exports.charts.command('get', {
         return getChartRun(options.boardId, args.chartId);
     },
 });
+function queryChartRun(boardId, chartId, options) {
+    (0, client_1.requireApiKey)();
+    const client = (0, client_1.createClient)();
+    return client.get(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}/query`, { params: { dateFrom: options.dateFrom, dateTo: options.dateTo } });
+}
+exports.charts.command('query', {
+    description: 'Execute a saved chart query after substituting date variables',
+    args: incur_1.z.object({
+        chartId: incur_1.z.string().describe('Chart ID to query'),
+    }),
+    options: incur_1.z.object({
+        boardId: incur_1.z.string().describe('Board ID the chart belongs to'),
+        dateFrom: incur_1.z.string().describe('Date variable value for {{date_from}}, YYYY-MM-DD'),
+        dateTo: incur_1.z.string().describe('Date variable value for {{date_to}}, YYYY-MM-DD'),
+    }),
+    examples: [
+        {
+            args: { chartId: 'chart_abc123' },
+            options: {
+                boardId: 'board_abc123',
+                dateFrom: '2026-04-01',
+                dateTo: '2026-04-30',
+            },
+            description: 'Query a chart for April 2026',
+        },
+    ],
+    hint: 'Requires boards:read scope and a chart query containing {{date_from}}/{{date_to}} variables.',
+    run({ args, options }) {
+        return queryChartRun(options.boardId, args.chartId, options);
+    },
+});
 // ── Create a chart ──
-function createChartRun(boardId, body) {
+function createChartRun(boardId, input) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    let parsed;
-    try {
-        parsed = JSON.parse(body);
-    }
-    catch {
-        throw new Error('--body must be valid JSON');
-    }
-    return client.post(`/v0/boards/${encodeURIComponent(boardId)}/charts/`, parsed);
+    return client.post(`/v0/boards/${encodeURIComponent(boardId)}/charts/`, coerceChartBody(input));
 }
 exports.charts.command('create', {
     description: 'Create a new chart in a board',
-    options: incur_1.z.object({
+    options: chartBodyOptions.extend({
         boardId: incur_1.z.string().describe('Board ID to add the chart to'),
-        body: incur_1.z.string().describe('JSON string with chart configuration'),
     }),
     examples: [
         {
             options: {
                 boardId: 'board_abc123',
-                body: '{"name":"Daily active users","chartType":"line"}',
+                title: 'Daily active users',
+                chartType: 'line',
+                query: 'SELECT toDate(timestamp) AS date, countDistinct(address) AS users FROM events GROUP BY date ORDER BY date',
+                xAxis: 'date',
+                yAxis: 'users',
             },
-            description: 'Create a line chart',
+            description: 'Create a line chart from typed flags',
+        },
+        {
+            options: {
+                boardId: 'board_abc123',
+                body: '{"title":"Onboarding Funnel","chart_type":"funnel","query":"SELECT 1","steps":[{"type":"event","event":"page"},{"type":"event","event":"connect"}]}',
+            },
+            description: 'Create a chart from raw JSON',
         },
     ],
     hint: 'Requires boards:write scope on your API key.',
     run({ options }) {
-        return createChartRun(options.boardId, options.body);
+        return createChartRun(options.boardId, options);
     },
 });
 // ── Update a chart ──
-function updateChartRun(boardId, chartId, body) {
+function updateChartRun(boardId, chartId, input) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    let parsed;
-    try {
-        parsed = JSON.parse(body);
-    }
-    catch {
-        throw new Error('--body must be valid JSON');
-    }
-    return client.put(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}`, parsed);
+    const updates = coerceChartBody(input);
+    return client
+        .get(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}`)
+        .then((current) => {
+        const existing = current && typeof current === 'object'
+            ? current
+            : {};
+        const body = {
+            query: existing.query,
+            chart_type: existing.chart_type,
+            title: existing.title,
+            description: existing.description ?? undefined,
+            x_axis: existing.x_axis ?? undefined,
+            y_axis: existing.y_axis ?? undefined,
+            group_by: existing.group_by ?? undefined,
+            steps: existing.steps ?? undefined,
+            settings: existing.settings ?? undefined,
+            ...updates,
+        };
+        return client.put(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}`, body);
+    });
 }
 exports.charts.command('update', {
     description: 'Update an existing chart',
     args: incur_1.z.object({
         chartId: incur_1.z.string().describe('Chart ID to update'),
     }),
-    options: incur_1.z.object({
+    options: chartBodyOptions.extend({
         boardId: incur_1.z.string().describe('Board ID the chart belongs to'),
-        body: incur_1.z.string().describe('JSON string with updated chart configuration'),
     }),
     examples: [
         {
             args: { chartId: 'chart_abc123' },
             options: {
                 boardId: 'board_abc123',
-                body: '{"name":"Updated chart name"}',
+                title: 'Updated chart name',
             },
-            description: 'Update a chart',
+            description: 'Update a chart title',
+        },
+    ],
+    hint: 'Requires boards:write scope on your API key.',
+    run({ args, options }) {
+        return updateChartRun(options.boardId, args.chartId, options);
+    },
+});
+// ── Move a chart ──
+function moveChartRun(boardId, chartId, targetBoardId) {
+    (0, client_1.requireApiKey)();
+    const client = (0, client_1.createClient)();
+    return client.put(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}/move`, { targetBoardId });
+}
+exports.charts.command('move', {
+    description: 'Move a chart to another board',
+    args: incur_1.z.object({
+        chartId: incur_1.z.string().describe('Chart ID to move'),
+    }),
+    options: incur_1.z.object({
+        boardId: incur_1.z.string().describe('Current board ID'),
+        targetBoardId: incur_1.z.string().describe('Destination board ID'),
+    }),
+    examples: [
+        {
+            args: { chartId: 'chart_abc123' },
+            options: { boardId: 'board_source', targetBoardId: 'board_target' },
+            description: 'Move a chart between boards',
+        },
+    ],
+    hint: 'Requires boards:write scope on your API key.',
+    run({ args, options }) {
+        return moveChartRun(options.boardId, args.chartId, options.targetBoardId);
+    },
+});
+// ── Duplicate a chart ──
+function normalizeDuplicateChartResponse(result) {
+    return typeof result === 'string' ? { id: result } : result;
+}
+function duplicateChartRun(boardId, chartId) {
+    (0, client_1.requireApiKey)();
+    const client = (0, client_1.createClient)();
+    return client.post(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}/duplicate`).then(normalizeDuplicateChartResponse);
+}
+exports.charts.command('duplicate', {
+    description: 'Duplicate a chart within its board',
+    args: incur_1.z.object({
+        chartId: incur_1.z.string().describe('Chart ID to duplicate'),
+    }),
+    options: incur_1.z.object({
+        boardId: incur_1.z.string().describe('Board ID the chart belongs to'),
+    }),
+    examples: [
+        {
+            args: { chartId: 'chart_abc123' },
+            options: { boardId: 'board_abc123' },
+            description: 'Duplicate a chart',
         },
     ],
     hint: 'Requires boards:write scope on your API key.',
     run({ args, options }) {
-        return updateChartRun(options.boardId, args.chartId, options.body);
+        return duplicateChartRun(options.boardId, args.chartId);
+    },
+});
+// ── Reorder charts ──
+function reorderChartsRun(boardId, chartIds) {
+    (0, client_1.requireApiKey)();
+    const client = (0, client_1.createClient)();
+    return client.put(`/v0/boards/${encodeURIComponent(boardId)}/charts/reorder`, { chartIds: (0, json_1.parseStringArray)(chartIds, '--chart-ids') });
+}
+exports.charts.command('reorder', {
+    description: 'Reorder charts in a board',
+    options: incur_1.z.object({
+        boardId: incur_1.z.string().describe('Board ID whose charts should be reordered'),
+        chartIds: incur_1.z
+            .string()
+            .describe('Chart IDs in desired order, as comma-separated text or JSON array'),
+    }),
+    examples: [
+        {
+            options: {
+                boardId: 'board_abc123',
+                chartIds: 'chart_a,chart_b,chart_c',
+            },
+            description: 'Reorder charts using comma-separated IDs',
+        },
+    ],
+    hint: 'Requires boards:write scope on your API key.',
+    run({ options }) {
+        return reorderChartsRun(options.boardId, options.chartIds);
     },
 });
 // ── Delete a chart ──

package/dist/commands/contracts.d.ts

@@ -1,30 +1,34 @@
 import { Cli } from 'incur';
 export declare const contracts: Cli.Cli<{}, undefined, undefined>;
-export declare function listContractsRun(): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export interface PaginationOptions {
+    page?: number;
+    size?: number;
+}
+export declare function listContractsRun(options?: PaginationOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function getContractRun(chain: string, address: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function getContractRecommendationsRun(): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export interface CreateContractOptions {
     address: string;
     chain: number;
     name: string;
     abi: string;
     events: string;
+    startBlock?: number;
+    includeInPipeline?: boolean;
 }
-export declare function buildCreateContractBody(options: CreateContractOptions): {
-    address: string;
-    chain: number;
-    name: string;
-    abi: unknown;
-    events: unknown;
-};
+export declare function buildCreateContractBody(options: CreateContractOptions): Record<string, unknown>;
 export declare function createContractRun(options: CreateContractOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
 export interface UpdateContractOptions {
     name: string;
     abi: string;
     events: string;
+    startBlock?: number;
+    includeInPipeline?: boolean;
 }
-export declare function buildUpdateContractBody(options: UpdateContractOptions): {
-    name: string;
-    abi: unknown;
-    events: unknown;
-};
+export declare function buildUpdateContractBody(chain: string | number, address: string, options: UpdateContractOptions): Record<string, unknown>;
 export declare function updateContractRun(chain: string, address: string, options: UpdateContractOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function updateContractPipelineRun(chain: string, address: string, includeInPipeline: boolean): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function buildUpdateContractPipelineBody(includeInPipeline: boolean): {
+    include_in_pipeline: boolean;
+};
 export declare function deleteContractRun(chain: string, address: string): Promise<import("axios").AxiosResponse<any, any, {}>>;