@wavyx/pdcli 0.9.0 → 0.11.0

package/src/commands/field/update.js

@@ -0,0 +1,53 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { clearFieldsCache, entityToFieldsPath } from '../../lib/fields.js'
+
+export default class FieldUpdateCommand extends BaseCommand {
+  static description =
+    'Update a custom field (field_code and field_type cannot change)'
+
+  static examples = [
+    '<%= config.bin %> field update deal dcf558aac1ae4e8c4f849ba5e668430d8df9be12 --name "New name"',
+  ]
+
+  static args = {
+    entity: Args.string({
+      required: true,
+      description: 'Entity type',
+      options: ['deal', 'person', 'org', 'organization', 'product'],
+    }),
+    field: Args.string({
+      required: true,
+      description: 'Field code (hashed key)',
+    }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    name: Flags.string({
+      required: true,
+      description: 'New field name (label)',
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FieldUpdateCommand)
+
+    const path = `${entityToFieldsPath(args.entity)}/${args.field}`
+    const res = await this.apiClient.patch(path, {
+      body: { field_name: flags.name },
+    })
+
+    clearFieldsCache()
+
+    await this.outputResults(res.data, {
+      field_code: { header: 'Key' },
+      field_name: { header: 'Name' },
+      field_type: { header: 'Type' },
+      options: {
+        header: 'Options',
+        get: (row) => row.options?.map((o) => `${o.id}=${o.label}`).join(', '),
+      },
+    })
+  }
+}

package/src/commands/file/delete.js

@@ -0,0 +1,41 @@
+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 FileDeleteCommand extends BaseCommand {
+  static description = 'Delete a file'
+
+  static examples = [
+    '<%= config.bin %> file delete 5',
+    '<%= config.bin %> file delete 5 --yes',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'File ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FileDeleteCommand)
+
+    const ok = await confirmAction(`Delete file ${args.id}?`, flags.yes, {
+      default: false,
+    })
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(`/api/v1/files/${args.id}`)
+    this.log(chalk.green(`Deleted file ${args.id}`))
+  }
+}

package/src/commands/file/update.js

@@ -0,0 +1,39 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { outputRecord } from '../../lib/entity-view.js'
+import { CliError } from '../../lib/errors.js'
+
+export default class FileUpdateCommand extends BaseCommand {
+  static description = 'Update a file name and/or description'
+
+  static examples = [
+    '<%= config.bin %> file update 5 --name report.pdf',
+    '<%= config.bin %> file update 5 --description "Signed contract"',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'File ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    name: Flags.string({ description: 'The visible name of the file' }),
+    description: Flags.string({ description: 'The description of the file' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FileUpdateCommand)
+
+    if (flags.name == null && flags.description == null) {
+      throw new CliError('Pass at least one of --name or --description', {
+        exitCode: 64,
+      })
+    }
+
+    const res = await this.apiClient.putForm(`/api/v1/files/${args.id}`, {
+      name: flags.name,
+      description: flags.description,
+    })
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/filter/delete.js

@@ -0,0 +1,41 @@
+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 FilterDeleteCommand extends BaseCommand {
+  static description = 'Delete a filter'
+
+  static examples = [
+    '<%= config.bin %> filter delete 5',
+    '<%= config.bin %> filter delete 5 --yes',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Filter ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FilterDeleteCommand)
+
+    const ok = await confirmAction(`Delete filter ${args.id}?`, flags.yes, {
+      default: false,
+    })
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(`/api/v1/filters/${args.id}`)
+    this.log(chalk.green(`Deleted filter ${args.id}`))
+  }
+}

package/src/commands/funnel.js

@@ -3,12 +3,8 @@ import BaseCommand from '../base-command.js'
 import { collectPages } from '../lib/pagination.js'
 import { parsePeriod, formatApiDatetime } from '../lib/period.js'
 import { computeFunnel, computeExactFunnel } from '../lib/analytics.js'
-import { CliError, ApiError } from '../lib/errors.js'
-
-/** Token cost of one GET /deals/{id}/changelog request (rate-limit budget). */
-const CHANGELOG_COST = 20
-/** Above this deal count, mining gets expensive — warn before proceeding. */
-const MINE_WARN_THRESHOLD = 100
+import { mineMany } from '../lib/changelog.js'
+import { CliError } from '../lib/errors.js'
 
 export default class FunnelCommand extends BaseCommand {
   static description =
@@ -134,54 +130,16 @@ export default class FunnelCommand extends BaseCommand {
   }
 
   /**
-   * Mine real stage transitions from each deal's v1 changelog. The changelog
-   * uses a flat v2-style cursor (additional_data.next_cursor on a v1 path), so
-   * the v2 pager works directly. Warns on stderr before mining a large set —
-   * each request costs 20 tokens — then lets the client's rate limiter pace it.
+   * Mine real stage transitions from each deal's v1 changelog (one request per
+   * deal, paced by the rate limiter), then compute the exact funnel. Mining,
+   * the large-set warning, and the skip-on-ApiError behavior live in the
+   * shared changelog lib so this command and `deal history` stay in step.
    * @param {object[]} deals deals to mine (current stage_id needed per deal)
    * @param {object[]} stages
    * @param {number} pipelineId
    */
   async mineExactFunnel(deals, stages, pipelineId) {
-    if (deals.length > MINE_WARN_THRESHOLD) {
-      process.stderr.write(
-        `Mining stage history for ${deals.length} deals ` +
-          `(~${deals.length} requests, ${CHANGELOG_COST} tokens each); ` +
-          `rate limiting may slow this down.\n`,
-      )
-    }
-
-    const transitionsByDeal = []
-    let skipped = 0
-    for (const deal of deals) {
-      try {
-        const rows = await collectPages(
-          this.apiClient.pageV2(`/api/v1/deals/${deal.id}/changelog`, {
-            limit: 500,
-          }),
-        )
-        transitionsByDeal.push({
-          dealId: deal.id,
-          stageId: deal.stage_id,
-          rows,
-        })
-      } catch (err) {
-        // One bad changelog request must not abort the whole mine: skip the
-        // deal, count it, and warn once after mining completes.
-        if (err instanceof ApiError) {
-          skipped++
-          continue
-        }
-        throw err
-      }
-    }
-
-    if (skipped > 0) {
-      process.stderr.write(
-        `skipped ${skipped} deal(s) whose changelog could not be fetched\n`,
-      )
-    }
-
+    const transitionsByDeal = await mineMany(this.apiClient, deals)
     return computeExactFunnel(transitionsByDeal, stages, { pipelineId })
   }
 }

package/src/commands/lead/convert.js

@@ -0,0 +1,103 @@
+import { Args, Flags } from '@oclif/core'
+import chalk from 'chalk'
+import BaseCommand from '../../base-command.js'
+import { CliError } from '../../lib/errors.js'
+
+const POLL_INTERVAL_MS = 2000
+
+function defaultSleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms))
+}
+
+export default class LeadConvertCommand extends BaseCommand {
+  static description =
+    'Convert a lead to a deal. The conversion runs as an async job; ' +
+    'use --wait to poll until it finishes. On success the lead is deleted.'
+
+  static examples = [
+    '<%= config.bin %> lead convert adf21080-0e10-11eb-879b-05d71fb426ec',
+    '<%= config.bin %> lead convert adf21080-0e10-11eb-879b-05d71fb426ec --stage 7',
+    '<%= config.bin %> lead convert adf21080-0e10-11eb-879b-05d71fb426ec --wait',
+  ]
+
+  static args = {
+    id: Args.string({ required: true, description: 'Lead ID (UUID)' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    stage: Flags.integer({
+      description: 'Stage ID for the new deal (a pipeline is inferred from it)',
+    }),
+    pipeline: Flags.integer({
+      description: 'Pipeline ID for the new deal (ignored when --stage is set)',
+    }),
+    wait: Flags.boolean({
+      description: 'Poll the conversion status until it finishes',
+      default: false,
+    }),
+    'timeout-secs': Flags.integer({
+      description: 'Max seconds to poll when --wait is set',
+      default: 30,
+    }),
+  }
+
+  /** Overridable in tests so polling never waits in real time. */
+  static sleepFn = defaultSleep
+
+  async run() {
+    const { args, flags } = await this.parse(LeadConvertCommand)
+
+    const body = {}
+    if (flags.stage !== undefined) body.stage_id = flags.stage
+    if (flags.pipeline !== undefined) body.pipeline_id = flags.pipeline
+
+    const res = await this.apiClient.post(
+      `/api/v2/leads/${args.id}/convert/deal`,
+      { body },
+    )
+    const conversionId = res.data?.conversion_id
+
+    if (!flags.wait) {
+      this.log(chalk.green(`Conversion started: ${conversionId}`))
+      this.log(
+        `Check status: ${this.config.bin} api GET ` +
+          `/api/v2/leads/${args.id}/convert/status/${conversionId}`,
+      )
+      return
+    }
+
+    const timeoutMs = flags['timeout-secs'] * 1000
+    const sleep = LeadConvertCommand.sleepFn
+    let elapsed = 0
+    while (true) {
+      const status = await this.apiClient.get(
+        `/api/v2/leads/${args.id}/convert/status/${conversionId}`,
+      )
+      const state = status.data?.status
+      if (state === 'completed') {
+        this.log(
+          chalk.green(
+            `Conversion completed: lead ${args.id} → deal ${status.data?.deal_id}`,
+          ),
+        )
+        return
+      }
+      if (state === 'failed' || state === 'rejected') {
+        throw new CliError(`Conversion ${state} for lead ${args.id}`, {
+          exitCode: 70,
+        })
+      }
+      if (elapsed + POLL_INTERVAL_MS > timeoutMs) {
+        throw new CliError(
+          `Timed out after ${flags['timeout-secs']}s waiting for conversion ` +
+            `${conversionId} (last status: ${state}). ` +
+            `Check status: ${this.config.bin} api GET /api/v2/leads/${args.id}/convert/status/${conversionId}`,
+          { exitCode: 1 },
+        )
+      }
+      await sleep(POLL_INTERVAL_MS)
+      elapsed += POLL_INTERVAL_MS
+    }
+  }
+}

package/src/commands/note/comment/add.js

@@ -0,0 +1,31 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { outputRecord } from '../../../lib/entity-view.js'
+
+export default class NoteCommentAddCommand extends BaseCommand {
+  static description = 'Add a comment to a note'
+
+  static examples = [
+    '<%= config.bin %> note comment add 5 --content "Nice work"',
+    '<%= config.bin %> note comment add 5 --content "Reviewed" --output json',
+  ]
+
+  static args = {
+    noteId: Args.integer({ required: true, description: 'Note ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    content: Flags.string({ required: true, description: 'Comment content' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(NoteCommentAddCommand)
+
+    const res = await this.apiClient.post(
+      `/api/v1/notes/${args.noteId}/comments`,
+      { body: { content: flags.content } },
+    )
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/note/comment/delete.js

@@ -0,0 +1,51 @@
+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 NoteCommentDeleteCommand extends BaseCommand {
+  static description = 'Delete a comment from a note'
+
+  static examples = [
+    '<%= config.bin %> note comment delete 5 --comment <uuid>',
+    '<%= config.bin %> note comment delete 5 --comment <uuid> --yes',
+  ]
+
+  static args = {
+    noteId: Args.integer({ required: true, description: 'Note ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    comment: Flags.string({
+      required: true,
+      description: 'Comment ID (UUID)',
+    }),
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(NoteCommentDeleteCommand)
+
+    const ok = await confirmAction(
+      `Delete comment ${flags.comment} from note ${args.noteId}?`,
+      flags.yes,
+      { default: false },
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(
+      `/api/v1/notes/${args.noteId}/comments/${flags.comment}`,
+    )
+    this.log(
+      chalk.green(`Deleted comment ${flags.comment} from note ${args.noteId}`),
+    )
+  }
+}

package/src/commands/note/comment/list.js

@@ -0,0 +1,43 @@
+import { Args } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { collectPages } from '../../../lib/pagination.js'
+
+const columns = {
+  uuid: { header: 'ID' },
+  content: {
+    header: 'Content',
+    get: (row) => (row.content ?? '').slice(0, 60),
+  },
+  user_id: { header: 'User' },
+  add_time: { header: 'Created' },
+}
+
+export default class NoteCommentListCommand extends BaseCommand {
+  static description = 'List comments on a note'
+
+  static examples = [
+    '<%= config.bin %> note comment list 5',
+    '<%= config.bin %> note comment list 5 --output json',
+  ]
+
+  static args = {
+    noteId: Args.integer({ required: true, description: 'Note ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(NoteCommentListCommand)
+    const limit = flags.limit ?? 100
+
+    const query = { limit: Math.min(limit, 100) }
+
+    const items = await collectPages(
+      this.apiClient.pageV1(`/api/v1/notes/${args.noteId}/comments`, query),
+      limit,
+    )
+    await this.outputResults(items, columns)
+  }
+}

package/src/commands/note/comment/update.js

@@ -0,0 +1,37 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { outputRecord } from '../../../lib/entity-view.js'
+
+export default class NoteCommentUpdateCommand extends BaseCommand {
+  static description = 'Update a comment on a note'
+
+  static examples = [
+    '<%= config.bin %> note comment update 5 --comment <uuid> --content "Edited"',
+  ]
+
+  static args = {
+    noteId: Args.integer({ required: true, description: 'Note ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    comment: Flags.string({
+      required: true,
+      description: 'Comment ID (UUID)',
+    }),
+    content: Flags.string({
+      required: true,
+      description: 'New comment content',
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(NoteCommentUpdateCommand)
+
+    const res = await this.apiClient.put(
+      `/api/v1/notes/${args.noteId}/comments/${flags.comment}`,
+      { body: { content: flags.content } },
+    )
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/org/follower/add.js

@@ -0,0 +1,31 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { outputRecord } from '../../../lib/entity-view.js'
+
+export default class OrgFollowerAddCommand extends BaseCommand {
+  static description = 'Add a follower (user) to an organization'
+
+  static examples = [
+    '<%= config.bin %> org follower add 42 --user 5',
+    '<%= config.bin %> org follower add 42 --user 5 --output json',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Organization ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    user: Flags.integer({ required: true, description: 'User ID' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(OrgFollowerAddCommand)
+
+    const res = await this.apiClient.post(
+      `/api/v2/organizations/${args.id}/followers`,
+      { body: { user_id: flags.user } },
+    )
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/org/follower/list.js

@@ -0,0 +1,41 @@
+import { Args } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { collectPages } from '../../../lib/pagination.js'
+
+const columns = {
+  user_id: { header: 'User' },
+  add_time: { header: 'Added' },
+}
+
+export default class OrgFollowerListCommand extends BaseCommand {
+  static description = 'List followers of an organization'
+
+  static examples = [
+    '<%= config.bin %> org follower list 42',
+    '<%= config.bin %> org follower list 42 --output json',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Organization ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(OrgFollowerListCommand)
+    const limit = flags.limit ?? 500
+
+    const query = { limit: Math.min(limit, 500) }
+
+    const items = await collectPages(
+      this.apiClient.pageV2(
+        `/api/v2/organizations/${args.id}/followers`,
+        query,
+      ),
+      limit,
+    )
+    await this.outputResults(items, columns)
+  }
+}

package/src/commands/org/follower/remove.js

@@ -0,0 +1,50 @@
+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 OrgFollowerRemoveCommand extends BaseCommand {
+  static description = 'Remove a follower from an organization'
+
+  static examples = [
+    '<%= config.bin %> org follower remove 42 --user 5',
+    '<%= config.bin %> org follower remove 42 --user 5 --yes',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Organization ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    user: Flags.integer({ required: true, description: 'User ID' }),
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(OrgFollowerRemoveCommand)
+
+    const ok = await confirmAction(
+      `Remove follower ${flags.user} from organization ${args.id}?`,
+      flags.yes,
+      { default: false },
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(
+      `/api/v2/organizations/${args.id}/followers/${flags.user}`,
+    )
+    this.log(
+      chalk.green(
+        `Removed follower ${flags.user} from organization ${args.id}`,
+      ),
+    )
+  }
+}