@formo/cli 1.1.0 → 1.2.0

package/dist/commands/charts.d.ts

@@ -1,9 +1,7 @@
 import { Cli } from 'incur';
+import { type PaginationOptions } from '../lib/pagination';
+export type { PaginationOptions };
 export declare const charts: Cli.Cli<{}, undefined, undefined>;
-export interface PaginationOptions {
-    page?: number;
-    size?: number;
-}
 export interface ChartBodyOptions {
     body?: string;
     query?: string;
@@ -17,18 +15,18 @@ export interface ChartBodyOptions {
     settings?: string;
 }
 export declare function buildChartBody(options: ChartBodyOptions): Record<string, unknown>;
-export declare function listChartsRun(boardId: string, options?: PaginationOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function listChartSummariesRun(boardId: string, options?: PaginationOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function getChartRun(boardId: string, chartId: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function listChartsRun(boardId: string, options?: PaginationOptions): Promise<unknown>;
+export declare function listChartSummariesRun(boardId: string, options?: PaginationOptions): Promise<unknown>;
+export declare function getChartRun(boardId: string, chartId: string): Promise<unknown>;
 export interface QueryChartOptions {
     dateFrom: string;
     dateTo: string;
 }
-export declare function queryChartRun(boardId: string, chartId: string, options: QueryChartOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function createChartRun(boardId: string, input: string | ChartBodyOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function updateChartRun(boardId: string, chartId: string, input: string | ChartBodyOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function moveChartRun(boardId: string, chartId: string, targetBoardId: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function queryChartRun(boardId: string, chartId: string, options: QueryChartOptions): Promise<unknown>;
+export declare function createChartRun(boardId: string, input: string | ChartBodyOptions): Promise<unknown>;
+export declare function updateChartRun(boardId: string, chartId: string, input: string | ChartBodyOptions): Promise<unknown>;
+export declare function moveChartRun(boardId: string, chartId: string, targetBoardId: string): Promise<unknown>;
 export declare function normalizeDuplicateChartResponse(result: unknown): unknown;
 export declare function duplicateChartRun(boardId: string, chartId: string): Promise<unknown>;
-export declare function reorderChartsRun(boardId: string, chartIds: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
-export declare function deleteChartRun(boardId: string, chartId: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function reorderChartsRun(boardId: string, chartIds: string): Promise<unknown>;
+export declare function deleteChartRun(boardId: string, chartId: string): Promise<unknown>;

package/dist/commands/charts.js

@@ -17,6 +17,7 @@ const incur_1 = require("incur");
 const client_1 = require("../lib/client");
 const json_1 = require("../lib/json");
 const sql_1 = require("../lib/sql");
+const pagination_1 = require("../lib/pagination");
 exports.charts = incur_1.Cli.create('charts', {
     description: 'Chart commands — create, list, query, move, duplicate, reorder, update, and delete charts within boards',
 });
@@ -32,14 +33,6 @@ const chartTypeSchema = incur_1.z.enum([
     '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,
@@ -109,26 +102,25 @@ const chartBodyOptions = incur_1.z.object({
     steps: incur_1.z
         .string()
         .optional()
-        .describe('JSON array of funnel/user-path step objects'),
+        .describe('JSON array of funnel step objects'),
     settings: incur_1.z
         .string()
         .optional()
-        .describe('JSON object of type-specific chart settings'),
+        .describe('JSON object of type-specific chart settings (for example, user_paths anchors/maxSteps/nodesPerStep or retention entryFilter/retentionFilter)'),
 });
 // ── List charts for a board ──
 function listChartsRun(boardId, options = {}) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
     return client.get(`/v0/boards/${encodeURIComponent(boardId)}/charts/`, {
-        params: buildPaginationParams(options),
+        params: (0, pagination_1.buildPaginationParams)(options),
     });
 }
 exports.charts.command('list', {
     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)'),
+        ...pagination_1.paginationOptionsSchema,
     }),
     examples: [
         {
@@ -146,15 +138,14 @@ 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),
+        params: (0, pagination_1.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)'),
+        ...pagination_1.paginationOptionsSchema,
     }),
     examples: [
         {
@@ -265,6 +256,11 @@ function updateChartRun(boardId, chartId, input) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
     const updates = coerceChartBody(input);
+    // The charts endpoint only supports full-body PUT, so emulate a partial
+    // update by fetching the current chart and merging flags over it. Two
+    // consequences: a concurrent edit between the GET and PUT is overwritten,
+    // and fields can't be cleared via typed flags (nulls are normalized to
+    // undefined below) — use --body with explicit nulls to clear.
     return client
         .get(`/v0/boards/${encodeURIComponent(boardId)}/charts/${encodeURIComponent(chartId)}`)
         .then((current) => {

package/dist/commands/contracts.d.ts

@@ -1,12 +1,10 @@
 import { Cli } from 'incur';
+import { type PaginationOptions } from '../lib/pagination';
+export type { PaginationOptions };
 export declare const contracts: Cli.Cli<{}, undefined, undefined>;
-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 declare function listContractsRun(options?: PaginationOptions): Promise<unknown>;
+export declare function getContractRun(chain: string, address: string): Promise<unknown>;
+export declare function getContractRecommendationsRun(): Promise<unknown>;
 export interface CreateContractOptions {
     address: string;
     chain: number;
@@ -17,7 +15,7 @@ export interface CreateContractOptions {
     includeInPipeline?: boolean;
 }
 export declare function buildCreateContractBody(options: CreateContractOptions): Record<string, unknown>;
-export declare function createContractRun(options: CreateContractOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function createContractRun(options: CreateContractOptions): Promise<unknown>;
 export interface UpdateContractOptions {
     name: string;
     abi: string;
@@ -26,9 +24,9 @@ export interface UpdateContractOptions {
     includeInPipeline?: boolean;
 }
 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 updateContractRun(chain: string, address: string, options: UpdateContractOptions): Promise<unknown>;
+export declare function updateContractPipelineRun(chain: string, address: string, includeInPipeline: boolean): Promise<unknown>;
 export declare function buildUpdateContractPipelineBody(includeInPipeline: boolean): {
     include_in_pipeline: boolean;
 };
-export declare function deleteContractRun(chain: string, address: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function deleteContractRun(chain: string, address: string): Promise<unknown>;

package/dist/commands/contracts.js

@@ -14,17 +14,10 @@ exports.deleteContractRun = deleteContractRun;
 const incur_1 = require("incur");
 const client_1 = require("../lib/client");
 const json_1 = require("../lib/json");
+const pagination_1 = require("../lib/pagination");
 exports.contracts = incur_1.Cli.create('contracts', {
     description: 'Smart contract commands — register, list, recommend, update, toggle pipeline inclusion, and remove tracked contracts',
 });
-function buildPaginationParams(options = {}) {
-    const params = {};
-    if (options.page !== undefined)
-        params.page = options.page;
-    if (options.size !== undefined)
-        params.size = options.size;
-    return params;
-}
 function parseChain(chain) {
     const value = typeof chain === 'number' ? chain : Number(chain);
     if (!Number.isInteger(value) || value < 1) {
@@ -37,15 +30,12 @@ function listContractsRun(options = {}) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
     return client.get('/v0/contracts/', {
-        params: buildPaginationParams(options),
+        params: (0, pagination_1.buildPaginationParams)(options),
     });
 }
 exports.contracts.command('list', {
     description: 'List all tracked contracts for the project',
-    options: incur_1.z.object({
-        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)'),
-    }),
+    options: incur_1.z.object(pagination_1.paginationOptionsSchema),
     examples: [{ description: 'List all project contracts' }],
     hint: 'Requires contracts:read scope on your API key.',
     run({ options }) {
@@ -56,7 +46,7 @@ exports.contracts.command('list', {
 function getContractRun(chain, address) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    return client.get(`/v0/contracts/${encodeURIComponent(chain)}/${encodeURIComponent(address)}`);
+    return client.get(`/v0/contracts/${parseChain(chain)}/${encodeURIComponent(address)}`);
 }
 // ── Recommended contracts ──
 function getContractRecommendationsRun() {
@@ -170,7 +160,7 @@ function buildUpdateContractBody(chain, address, options) {
 function updateContractRun(chain, address, options) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    return client.put(`/v0/contracts/${encodeURIComponent(chain)}/${encodeURIComponent(address)}`, buildUpdateContractBody(chain, address, options));
+    return client.put(`/v0/contracts/${parseChain(chain)}/${encodeURIComponent(address)}`, buildUpdateContractBody(chain, address, options));
 }
 exports.contracts.command('update', {
     description: 'Update a tracked contract',
@@ -211,7 +201,7 @@ exports.contracts.command('update', {
 function updateContractPipelineRun(chain, address, includeInPipeline) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    return client.patch(`/v0/contracts/${encodeURIComponent(chain)}/${encodeURIComponent(address)}/pipeline`, buildUpdateContractPipelineBody(includeInPipeline));
+    return client.patch(`/v0/contracts/${parseChain(chain)}/${encodeURIComponent(address)}/pipeline`, buildUpdateContractPipelineBody(includeInPipeline));
 }
 function buildUpdateContractPipelineBody(includeInPipeline) {
     return { include_in_pipeline: includeInPipeline };
@@ -246,7 +236,7 @@ exports.contracts.command('pipeline', {
 function deleteContractRun(chain, address) {
     (0, client_1.requireApiKey)();
     const client = (0, client_1.createClient)();
-    return client.delete(`/v0/contracts/${encodeURIComponent(chain)}/${encodeURIComponent(address)}`);
+    return client.delete(`/v0/contracts/${parseChain(chain)}/${encodeURIComponent(address)}`);
 }
 exports.contracts.command('delete', {
     description: 'Remove a tracked contract',

package/dist/commands/events.d.ts

@@ -6,4 +6,4 @@ export interface IngestEventsOptions {
     writeKey?: string;
 }
 export declare function buildIngestEventsBody(options: IngestEventsOptions): Record<string, unknown>[];
-export declare function ingestEventsRun(options: IngestEventsOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function ingestEventsRun(options: IngestEventsOptions): Promise<unknown>;

package/dist/commands/events.js

@@ -13,6 +13,9 @@ function getWriteKey(options) {
     return options.writeKey ?? process.env.FORMO_WRITE_KEY;
 }
 function buildIngestEventsBody(options) {
+    if (options.events && options.event) {
+        throw new Error('Provide only one of --event or --events');
+    }
     if (options.events) {
         const events = (0, json_1.parseJsonArrayOfObjects)(options.events, '--events');
         if (events.length === 0) {
@@ -26,11 +29,9 @@ function buildIngestEventsBody(options) {
     throw new Error('Provide --event or --events');
 }
 function ingestEventsRun(options) {
-    const writeKey = getWriteKey(options);
-    if (!writeKey) {
-        throw new Error('No event write key configured. Pass --write-key or set FORMO_WRITE_KEY.');
-    }
-    const client = (0, client_1.createEventsClient)(writeKey);
+    // createEventsClient throws the "No event write key configured" error for
+    // a missing key — no need to duplicate the guard here.
+    const client = (0, client_1.createEventsClient)(getWriteKey(options) ?? '');
     return client.post('/v0/raw_events', buildIngestEventsBody(options));
 }
 exports.events.command('ingest', {

package/dist/commands/import.d.ts

@@ -12,4 +12,4 @@ export declare function buildImportBody(options: ImportWalletsOptions): {
     addresses: unknown[];
     rows?: undefined;
 };
-export declare function importWalletsRun(options: ImportWalletsOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function importWalletsRun(options: ImportWalletsOptions): Promise<unknown>;

package/dist/commands/import.js

@@ -10,6 +10,9 @@ exports.importCmd = incur_1.Cli.create('import', {
     description: 'Import commands — bulk import wallet addresses into your project',
 });
 function buildImportBody(options) {
+    if (options.rows && options.addresses) {
+        throw new Error('Provide only one of --addresses or --rows');
+    }
     if (options.rows) {
         const rows = (0, json_1.parseJsonArrayOfObjects)(options.rows, '--rows');
         const addresses = rows.map((row) => row.address);

package/dist/commands/profiles.d.ts

@@ -12,7 +12,7 @@ export interface LifecycleThresholdOptions {
 export interface GetProfileOptions extends LifecycleThresholdOptions {
     expand?: string;
 }
-export declare function getProfileRun(address: string, optionsOrExpand?: GetProfileOptions | string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function getProfileRun(address: string, optionsOrExpand?: GetProfileOptions | string): Promise<unknown>;
 export interface SearchProfilesOptions extends LifecycleThresholdOptions {
     address?: string;
     search?: string;
@@ -21,27 +21,27 @@ export interface SearchProfilesOptions extends LifecycleThresholdOptions {
     orderBy?: string;
     orderDir?: string;
     expand?: string;
-    conditions?: string;
+    filters?: string;
     logic?: 'and' | 'or';
 }
 /**
- * Parse and validate the --conditions JSON. Ensures it is an array of
- * `{ field, op, value }` objects whose `field` is a typed path (e.g.
- * `users.net_worth_usd`) — a bare name like `net_worth_usd` is silently
- * dropped by the API, so it is rejected here. Exported for unit testing.
+ * Parse and validate the --filters JSON. Ensures it is an array of
+ * `{ field, op, value }` objects carrying a canonical `field` — either
+ * `users.{attribute}` or one of the four stable resource paths, with resource
+ * identity in named qualifier properties. Exported for unit testing.
  */
-export declare function parseSearchConditions(raw: string): unknown[];
-export declare function searchProfilesRun(options: SearchProfilesOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function parseSearchFilters(raw: string): unknown[];
+export declare function searchProfilesRun(options: SearchProfilesOptions): Promise<unknown>;
 export interface UpdateProfileOptions {
     properties: string;
 }
 export declare function buildUpdateProfileBody(options: UpdateProfileOptions): Record<string, unknown>;
-export declare function updateProfileRun(address: string, options: UpdateProfileOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function updateProfileRun(address: string, options: UpdateProfileOptions): Promise<unknown>;
 export interface BatchUpdateProfilesOptions {
     rows: string;
 }
 export declare function buildBatchUpdateProfilesBody(options: BatchUpdateProfilesOptions): Record<string, unknown>[];
-export declare function batchUpdateProfilesRun(options: BatchUpdateProfilesOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function batchUpdateProfilesRun(options: BatchUpdateProfilesOptions): Promise<unknown>;
 export declare const profilesProperties: Cli.Cli<{}, undefined, undefined>;
 export declare const profilesLabels: Cli.Cli<{}, undefined, undefined>;
 export interface CreateProfileLabelOptions {
@@ -53,15 +53,15 @@ export interface CreateProfileLabelOptions {
     labels?: string;
 }
 export declare function buildCreateLabelBody(options: CreateProfileLabelOptions): unknown;
-export declare function createProfileLabelRun(address: string, options: CreateProfileLabelOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function createProfileLabelRun(address: string, options: CreateProfileLabelOptions): Promise<unknown>;
 export interface BatchCreateProfileLabelsOptions {
     labels: string;
 }
 export declare function buildBatchCreateLabelsBody(options: BatchCreateProfileLabelsOptions): Record<string, unknown>[];
-export declare function batchCreateProfileLabelsRun(options: BatchCreateProfileLabelsOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function batchCreateProfileLabelsRun(options: BatchCreateProfileLabelsOptions): Promise<unknown>;
 export interface DeleteProfileLabelOptions {
     tagId: string;
     chainId?: string;
 }
 export declare function buildDeleteLabelBody(options: DeleteProfileLabelOptions): Record<string, string>;
-export declare function deleteProfileLabelRun(address: string, options: DeleteProfileLabelOptions): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export declare function deleteProfileLabelRun(address: string, options: DeleteProfileLabelOptions): Promise<unknown>;