@wavyx/pdcli 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavyx/pdcli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -100,6 +100,8 @@
     "cli-table3": "0.6.5",
     "conf": "15.1.0",
     "debug": "4.4.3",
+    "js-yaml": "^4.1.1",
+    "node-jq": "^6.3.1",
     "open": "^11.0.0",
     "ora": "9.4.0",
     "undici": "8.3.0"

package/src/base-command.js

@@ -12,7 +12,15 @@ export default class BaseCommand extends Command {
       char: 'o',
       description: 'Output format',
       helpGroup: 'GLOBAL',
-      options: ['table', 'json'],
+      options: ['table', 'json', 'yaml', 'csv'],
+    }),
+    jq: Flags.string({
+      description: 'jq expression to filter JSON output',
+      helpGroup: 'GLOBAL',
+    }),
+    fields: Flags.string({
+      description: 'Comma-separated fields to display',
+      helpGroup: 'GLOBAL',
     }),
     profile: Flags.string({
       description: 'Named auth profile to use',
@@ -120,7 +128,27 @@ export default class BaseCommand extends Command {
    * @param {Record<string, import('./lib/output/table.js').Column>} columns
    */
   async outputResults(data, columns) {
-    formatOutput(data, columns, this.resolveFormat(), this)
+    if (this.flags.jq) {
+      // node-jq ships a native binary — load it only when actually used.
+      const { run } = await import('node-jq')
+      const input = JSON.stringify(Array.isArray(data) ? data : [data])
+      const result = await run(this.flags.jq, input, {
+        input: 'string',
+        output: 'pretty',
+      })
+      this.log(result)
+      return
+    }
+
+    let filteredColumns = columns
+    if (this.flags.fields && columns) {
+      const requested = this.flags.fields.split(',').map((f) => f.trim())
+      filteredColumns = Object.fromEntries(
+        Object.entries(columns).filter(([key]) => requested.includes(key)),
+      )
+    }
+
+    formatOutput(data, filteredColumns, this.resolveFormat(), this)
   }
 
   async catch(err) {

package/src/commands/api.js

@@ -53,8 +53,12 @@ export default class ApiCommand extends BaseCommand {
 
     const data = await this.apiClient[method](args.path, opts)
 
-    if (data !== null) {
-      this.log(JSON.stringify(data, null, 2))
+    if (data === null) return
+
+    if (this.flags.jq) {
+      await this.outputResults(data, {})
+      return
     }
+    this.log(JSON.stringify(data, null, 2))
   }
 }

package/src/commands/backup.js

@@ -0,0 +1,53 @@
+import { Flags } from '@oclif/core'
+import chalk from 'chalk'
+import ora from 'ora'
+import BaseCommand from '../base-command.js'
+import { runBackup } from '../lib/backup.js'
+
+export default class BackupCommand extends BaseCommand {
+  static description =
+    'Export the whole account to a JSON tree (resumable, one file per resource)'
+
+  static examples = [
+    '<%= config.bin %> backup',
+    '<%= config.bin %> backup --dir ./my-backup',
+    '<%= config.bin %> backup --dir ./my-backup --resume',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    dir: Flags.string({
+      description: 'Target directory for the export',
+      default: 'pipedrive-backup',
+    }),
+    resume: Flags.boolean({
+      description: 'Skip resources already completed in a previous run',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(BackupCommand)
+
+    const spinner = ora('Starting backup...').start()
+    let summary
+    try {
+      summary = await runBackup(this.apiClient, flags.dir, {
+        resume: flags.resume,
+        onProgress: (resource, count) => {
+          spinner.text = `Exported ${resource} (${count})`
+        },
+      })
+    } finally {
+      spinner.stop()
+    }
+
+    this.log(
+      chalk.green(
+        `Backup complete: ${summary.exported}/${summary.total} resources ` +
+          `exported to ${chalk.cyan(flags.dir)}` +
+          (summary.skipped ? chalk.dim(` (${summary.skipped} skipped)`) : ''),
+      ),
+    )
+  }
+}

package/src/commands/file/download.js

@@ -0,0 +1,35 @@
+import { writeFileSync } from 'node:fs'
+import { Args, Flags } from '@oclif/core'
+import chalk from 'chalk'
+import BaseCommand from '../../base-command.js'
+
+export default class FileDownloadCommand extends BaseCommand {
+  static description = 'Download a file by ID'
+
+  static examples = [
+    '<%= config.bin %> file download 5',
+    '<%= config.bin %> file download 5 --out ./report.pdf',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'File ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    out: Flags.string({ description: 'Path to write to (default: file name)' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FileDownloadCommand)
+
+    const body = await this.apiClient.get(`/api/v1/files/${args.id}`)
+    const { buffer } = await this.apiClient.download(
+      `/api/v1/files/${args.id}/download`,
+    )
+    const bytes = Buffer.from(buffer)
+    const out = flags.out ?? body.data.name
+    writeFileSync(out, bytes)
+    this.log(chalk.green(`Saved ${out} (${bytes.length} bytes)`))
+  }
+}

package/src/commands/file/get.js

@@ -0,0 +1,26 @@
+import { Args } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class FileGetCommand extends BaseCommand {
+  static description = 'Get a file by ID'
+
+  static examples = [
+    '<%= config.bin %> file get 5',
+    '<%= config.bin %> file get 5 --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  static args = {
+    id: Args.integer({ required: true, description: 'File ID' }),
+  }
+
+  async run() {
+    const { args } = await this.parse(FileGetCommand)
+    const body = await this.apiClient.get(`/api/v1/files/${args.id}`)
+    await outputRecord(this, body.data)
+  }
+}

package/src/commands/file/list.js

@@ -0,0 +1,40 @@
+import BaseCommand from '../../base-command.js'
+import { collectPages } from '../../lib/pagination.js'
+
+const columns = {
+  id: { header: 'ID' },
+  name: { header: 'Name' },
+  file_type: { header: 'Type' },
+  file_size: { header: 'Size' },
+  deal_id: { header: 'Deal' },
+  person_id: { header: 'Person' },
+  add_time: { header: 'Created' },
+}
+
+export default class FileListCommand extends BaseCommand {
+  static description = 'List files'
+
+  static examples = [
+    '<%= config.bin %> file list',
+    '<%= config.bin %> file list --limit 50 --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  async run() {
+    const { flags } = await this.parse(FileListCommand)
+    const limit = flags.limit ?? 100
+
+    const query = {
+      limit: Math.min(limit, 100),
+    }
+
+    const items = await collectPages(
+      this.apiClient.pageV1('/api/v1/files', query),
+      limit,
+    )
+    await this.outputResults(items, columns)
+  }
+}

package/src/commands/file/upload.js

@@ -0,0 +1,42 @@
+import { readFileSync } from 'node:fs'
+import { basename } from 'node:path'
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class FileUploadCommand extends BaseCommand {
+  static description = 'Upload a file'
+
+  static examples = [
+    '<%= config.bin %> file upload ./report.pdf',
+    '<%= config.bin %> file upload ./report.pdf --deal 42',
+  ]
+
+  static args = {
+    path: Args.string({ required: true, description: 'Path to the file' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    deal: Flags.integer({ description: 'Associate with a deal ID' }),
+    person: Flags.integer({ description: 'Associate with a person ID' }),
+    org: Flags.integer({ description: 'Associate with an organization ID' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FileUploadCommand)
+
+    const data = readFileSync(args.path)
+    const name = basename(args.path)
+
+    const res = await this.apiClient.postMultipart('/api/v1/files', {
+      file: { name, data },
+      fields: {
+        deal_id: flags.deal,
+        person_id: flags.person,
+        org_id: flags.org,
+      },
+    })
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/filter/get.js

@@ -0,0 +1,26 @@
+import { Args } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class FilterGetCommand extends BaseCommand {
+  static description = 'Get a filter by ID'
+
+  static examples = [
+    '<%= config.bin %> filter get 5',
+    '<%= config.bin %> filter get 5 --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Filter ID' }),
+  }
+
+  async run() {
+    const { args } = await this.parse(FilterGetCommand)
+    const body = await this.apiClient.get(`/api/v1/filters/${args.id}`)
+    await outputRecord(this, body.data)
+  }
+}

package/src/commands/filter/list.js

@@ -0,0 +1,43 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+
+const columns = {
+  id: { header: 'ID' },
+  name: { header: 'Name' },
+  type: { header: 'Type' },
+  active_flag: { header: 'Active' },
+}
+
+export default class FilterListCommand extends BaseCommand {
+  static description = 'List filters'
+
+  static examples = [
+    '<%= config.bin %> filter list',
+    '<%= config.bin %> filter list --type deals --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    type: Flags.string({
+      description: 'Filter by type',
+      options: [
+        'deals',
+        'leads',
+        'org',
+        'people',
+        'products',
+        'activity',
+        'projects',
+      ],
+    }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(FilterListCommand)
+
+    const body = await this.apiClient.get('/api/v1/filters', {
+      query: { type: flags.type },
+    })
+    await this.outputResults(body.data, columns)
+  }
+}

package/src/commands/goal/list.js

@@ -0,0 +1,37 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+
+const columns = {
+  id: { header: 'ID' },
+  title: { header: 'Title', get: (row) => row.title ?? '' },
+  type: { header: 'Type', get: (row) => row.type?.name ?? '' },
+  interval: { header: 'Interval', get: (row) => row.interval ?? '' },
+  owner_id: { header: 'Owner' },
+}
+
+export default class GoalListCommand extends BaseCommand {
+  static description = 'List goals'
+
+  static examples = [
+    '<%= config.bin %> goal list',
+    '<%= config.bin %> goal list --assignee 7 --type deals_won --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    assignee: Flags.integer({ description: 'Filter by assignee (user) ID' }),
+    type: Flags.string({ description: 'Filter by goal type name' }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(GoalListCommand)
+
+    const body = await this.apiClient.get('/api/v1/goals/find', {
+      query: {
+        'assignee.id': flags.assignee,
+        'type.name': flags.type,
+      },
+    })
+    await this.outputResults(body.data?.goals ?? [], columns)
+  }
+}

package/src/commands/lead/create.js

@@ -0,0 +1,58 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { buildWriteBody } from '../../lib/input.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class LeadCreateCommand extends BaseCommand {
+  static description = 'Create a lead'
+
+  static examples = [
+    '<%= config.bin %> lead create --title "Acme renewal" --value 5000 --currency EUR',
+    '<%= config.bin %> lead create --title "Linked" --person 4 --org 5',
+    '<%= config.bin %> lead create --title "Raw" --body \'{"visible_to":"3"}\'',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    title: Flags.string({ required: true, description: 'Lead title' }),
+    person: Flags.integer({ description: 'Linked person ID' }),
+    org: Flags.integer({ description: 'Linked organization ID' }),
+    owner: Flags.integer({ description: 'Owner (user) ID' }),
+    value: Flags.string({
+      description: 'Lead value amount (requires --currency)',
+      dependsOn: ['currency'],
+    }),
+    currency: Flags.string({
+      description: 'Lead value currency (requires --value)',
+      dependsOn: ['value'],
+    }),
+    'expected-close-date': Flags.string({
+      description: 'Expected close date (YYYY-MM-DD)',
+    }),
+    body: Flags.string({ description: 'Raw JSON body to merge (flags win)' }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(LeadCreateCommand)
+
+    const value =
+      flags.value !== undefined && flags.currency !== undefined
+        ? { amount: Number(flags.value), currency: flags.currency }
+        : undefined
+
+    const body = buildWriteBody({
+      typed: {
+        title: flags.title,
+        person_id: flags.person,
+        organization_id: flags.org,
+        owner_id: flags.owner,
+        value,
+        expected_close_date: flags['expected-close-date'],
+      },
+      rawBody: flags.body,
+    })
+
+    const res = await this.apiClient.post('/api/v1/leads', { body })
+    await outputRecord(this, res.data, 'deal')
+  }
+}

package/src/commands/lead/delete.js

@@ -0,0 +1,39 @@
+import { Args, Flags } from '@oclif/core'
+import chalk from 'chalk'
+import BaseCommand from '../../base-command.js'
+import { confirmAction } from '../../lib/confirm.js'
+import { CliError } from '../../lib/errors.js'
+
+export default class LeadDeleteCommand extends BaseCommand {
+  static description = 'Delete a lead'
+
+  static examples = [
+    '<%= config.bin %> lead delete adf21080-0e10-11eb-879b-05d71fb426ec',
+    '<%= config.bin %> lead delete adf21080-0e10-11eb-879b-05d71fb426ec --yes',
+  ]
+
+  static args = {
+    id: Args.string({ required: true, description: 'Lead ID (UUID)' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(LeadDeleteCommand)
+
+    const ok = await confirmAction(`Delete lead ${args.id}?`, flags.yes)
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(`/api/v1/leads/${args.id}`)
+    this.log(chalk.green(`Deleted lead ${args.id}`))
+  }
+}

package/src/commands/lead/get.js

@@ -0,0 +1,26 @@
+import { Args } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class LeadGetCommand extends BaseCommand {
+  static description = 'Get a lead by ID'
+
+  static examples = [
+    '<%= config.bin %> lead get adf21080-0e10-11eb-879b-05d71fb426ec',
+    '<%= config.bin %> lead get adf21080-0e10-11eb-879b-05d71fb426ec --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  static args = {
+    id: Args.string({ required: true, description: 'Lead ID (UUID)' }),
+  }
+
+  async run() {
+    const { args } = await this.parse(LeadGetCommand)
+    const body = await this.apiClient.get(`/api/v1/leads/${args.id}`)
+    await outputRecord(this, body.data, 'deal')
+  }
+}

package/src/commands/lead/list.js

@@ -0,0 +1,50 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { collectPages } from '../../lib/pagination.js'
+
+const columns = {
+  id: { header: 'ID' },
+  title: { header: 'Title' },
+  person_id: { header: 'Person' },
+  organization_id: { header: 'Org' },
+  value: {
+    header: 'Value',
+    get: (row) =>
+      row.value ? `${row.value.amount} ${row.value.currency}` : '',
+  },
+  add_time: { header: 'Created' },
+}
+
+export default class LeadListCommand extends BaseCommand {
+  static description = 'List leads'
+
+  static examples = [
+    '<%= config.bin %> lead list',
+    '<%= config.bin %> lead list --owner 3 --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    owner: Flags.integer({ description: 'Filter by owner (user) ID' }),
+    person: Flags.integer({ description: 'Filter by person ID' }),
+    org: Flags.integer({ description: 'Filter by organization ID' }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(LeadListCommand)
+    const limit = flags.limit ?? 100
+
+    const query = {
+      owner_id: flags.owner,
+      person_id: flags.person,
+      organization_id: flags.org,
+      limit: Math.min(limit, 100),
+    }
+
+    const items = await collectPages(
+      this.apiClient.pageV1('/api/v1/leads', query),
+      limit,
+    )
+    await this.outputResults(items, columns)
+  }
+}

package/src/commands/lead/update.js

@@ -0,0 +1,71 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { buildWriteBody } from '../../lib/input.js'
+import { outputRecord } from '../../lib/entity-view.js'
+import { CliError } from '../../lib/errors.js'
+
+export default class LeadUpdateCommand extends BaseCommand {
+  static description = 'Update a lead (v1 PATCH — only provided fields change)'
+
+  static examples = [
+    '<%= config.bin %> lead update adf21080-0e10-11eb-879b-05d71fb426ec --title "Renamed"',
+    '<%= config.bin %> lead update adf21080-0e10-11eb-879b-05d71fb426ec --value 7500 --currency USD',
+  ]
+
+  static args = {
+    id: Args.string({ required: true, description: 'Lead ID (UUID)' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    title: Flags.string({ description: 'Lead title' }),
+    person: Flags.integer({ description: 'Linked person ID' }),
+    org: Flags.integer({ description: 'Linked organization ID' }),
+    owner: Flags.integer({ description: 'Owner (user) ID' }),
+    value: Flags.string({
+      description: 'Lead value amount (requires --currency)',
+      dependsOn: ['currency'],
+    }),
+    currency: Flags.string({
+      description: 'Lead value currency (requires --value)',
+      dependsOn: ['value'],
+    }),
+    'expected-close-date': Flags.string({
+      description: 'Expected close date (YYYY-MM-DD)',
+    }),
+    body: Flags.string({ description: 'Raw JSON body to merge (flags win)' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(LeadUpdateCommand)
+
+    const value =
+      flags.value !== undefined && flags.currency !== undefined
+        ? { amount: Number(flags.value), currency: flags.currency }
+        : undefined
+
+    const body = buildWriteBody({
+      typed: {
+        title: flags.title,
+        person_id: flags.person,
+        organization_id: flags.org,
+        owner_id: flags.owner,
+        value,
+        expected_close_date: flags['expected-close-date'],
+      },
+      rawBody: flags.body,
+    })
+
+    if (Object.keys(body).length === 0) {
+      throw new CliError(
+        'Nothing to update — pass at least one field flag or --body',
+        { exitCode: 64 },
+      )
+    }
+
+    const res = await this.apiClient.patch(`/api/v1/leads/${args.id}`, {
+      body,
+    })
+    await outputRecord(this, res.data, 'deal')
+  }
+}

package/src/commands/note/create.js

@@ -0,0 +1,42 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { buildWriteBody } from '../../lib/input.js'
+import { outputRecord } from '../../lib/entity-view.js'
+
+export default class NoteCreateCommand extends BaseCommand {
+  static description = 'Create a note'
+
+  static examples = [
+    '<%= config.bin %> note create --content "Called the lead"',
+    '<%= config.bin %> note create --content "Follow up" --deal 42',
+    '<%= config.bin %> note create --content "Pinned" --body \'{"pinned_to_deal_flag":1}\'',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    content: Flags.string({ required: true, description: 'Note content' }),
+    deal: Flags.integer({ description: 'Attach to deal ID' }),
+    person: Flags.integer({ description: 'Attach to person ID' }),
+    org: Flags.integer({ description: 'Attach to organization ID' }),
+    lead: Flags.string({ description: 'Attach to lead ID (UUID)' }),
+    body: Flags.string({ description: 'Raw JSON body to merge (flags win)' }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(NoteCreateCommand)
+
+    const body = buildWriteBody({
+      typed: {
+        content: flags.content,
+        deal_id: flags.deal,
+        person_id: flags.person,
+        org_id: flags.org,
+        lead_id: flags.lead,
+      },
+      rawBody: flags.body,
+    })
+
+    const res = await this.apiClient.post('/api/v1/notes', { body })
+    await outputRecord(this, res.data)
+  }
+}