@wavyx/pdcli 0.9.0 → 0.11.0

package/src/commands/deal/participant/remove.js

@@ -0,0 +1,53 @@
+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 DealParticipantRemoveCommand extends BaseCommand {
+  static description = 'Remove a participant from a deal'
+
+  static examples = [
+    '<%= config.bin %> deal participant remove 42 --participant 3',
+    '<%= config.bin %> deal participant remove 42 --participant 3 --yes',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Deal ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    participant: Flags.integer({
+      required: true,
+      description: 'Deal-participant ID',
+    }),
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(DealParticipantRemoveCommand)
+
+    const ok = await confirmAction(
+      `Remove participant ${flags.participant} from deal ${args.id}?`,
+      flags.yes,
+      { default: false },
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(
+      `/api/v1/deals/${args.id}/participants/${flags.participant}`,
+    )
+    this.log(
+      chalk.green(
+        `Removed participant ${flags.participant} from deal ${args.id}`,
+      ),
+    )
+  }
+}

package/src/commands/deal/product/add.js

@@ -0,0 +1,69 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { CliError } from '../../../lib/errors.js'
+import { buildWriteBody } from '../../../lib/input.js'
+import { outputRecord } from '../../../lib/entity-view.js'
+
+/** Coerce a numeric flag, failing with a clean input error on garbage. */
+function num(name, value) {
+  if (value === undefined) return undefined
+  const n = Number(value)
+  if (!Number.isFinite(n)) {
+    throw new CliError(`Invalid number for --${name}: "${value}"`, {
+      exitCode: 64,
+    })
+  }
+  return n
+}
+
+export default class DealProductAddCommand extends BaseCommand {
+  static description = 'Attach a product to a deal'
+
+  static examples = [
+    '<%= config.bin %> deal product add 42 --product 10 --price 90',
+    '<%= config.bin %> deal product add 42 --product 10 --price 90 --quantity 3',
+    '<%= config.bin %> deal product add 42 --product 10 --price 90 --discount 10 --discount-type percentage',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Deal ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    product: Flags.integer({ required: true, description: 'Product ID' }),
+    price: Flags.string({
+      required: true,
+      description: 'Item price (per unit)',
+    }),
+    quantity: Flags.string({ description: 'Quantity', default: '1' }),
+    discount: Flags.string({ description: 'Discount value' }),
+    'discount-type': Flags.string({
+      description: 'Discount type',
+      options: ['percentage', 'amount'],
+    }),
+    tax: Flags.string({ description: 'Product tax percentage' }),
+    comments: Flags.string({ description: 'Comments' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(DealProductAddCommand)
+
+    const body = buildWriteBody({
+      typed: {
+        product_id: flags.product,
+        item_price: num('price', flags.price),
+        quantity: num('quantity', flags.quantity),
+        discount: num('discount', flags.discount),
+        discount_type: flags['discount-type'],
+        tax: num('tax', flags.tax),
+        comments: flags.comments,
+      },
+    })
+
+    const res = await this.apiClient.post(`/api/v2/deals/${args.id}/products`, {
+      body,
+    })
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/deal/product/list.js

@@ -0,0 +1,56 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { collectPages } from '../../../lib/pagination.js'
+
+const columns = {
+  id: { header: 'ID' },
+  product_id: { header: 'Product' },
+  name: { header: 'Name' },
+  item_price: { header: 'Item price' },
+  quantity: { header: 'Qty' },
+  discount: { header: 'Discount' },
+  sum: { header: 'Sum' },
+}
+
+export default class DealProductListCommand extends BaseCommand {
+  static description = 'List products attached to a deal'
+
+  static examples = [
+    '<%= config.bin %> deal product list 42',
+    '<%= config.bin %> deal product list 42 --sort-by add_time --sort-direction desc',
+    '<%= config.bin %> deal product list 42 --output json',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Deal ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    'sort-by': Flags.string({
+      description: 'Field to sort by',
+      options: ['id', 'add_time', 'update_time', 'order_nr'],
+    }),
+    'sort-direction': Flags.string({
+      description: 'Sort direction',
+      options: ['asc', 'desc'],
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(DealProductListCommand)
+    const limit = flags.limit ?? 500
+
+    const query = {
+      sort_by: flags['sort-by'],
+      sort_direction: flags['sort-direction'],
+      limit: Math.min(limit, 500),
+    }
+
+    const items = await collectPages(
+      this.apiClient.pageV2(`/api/v2/deals/${args.id}/products`, query),
+      limit,
+    )
+    await this.outputResults(items, columns)
+  }
+}

package/src/commands/deal/product/remove.js

@@ -0,0 +1,52 @@
+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 DealProductRemoveCommand extends BaseCommand {
+  static description = 'Remove a product attached to a deal'
+
+  static examples = [
+    '<%= config.bin %> deal product remove 42 --attachment 3',
+    '<%= config.bin %> deal product remove 42 --attachment 3 --yes',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Deal ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    attachment: Flags.integer({
+      required: true,
+      description: 'Deal-product (attachment) ID',
+    }),
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(DealProductRemoveCommand)
+
+    const ok = await confirmAction(
+      `Remove product attachment ${flags.attachment} from deal ${args.id}?`,
+      flags.yes,
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(
+      `/api/v2/deals/${args.id}/products/${flags.attachment}`,
+    )
+    this.log(
+      chalk.green(
+        `Removed product attachment ${flags.attachment} from deal ${args.id}`,
+      ),
+    )
+  }
+}

package/src/commands/deal/product/update.js

@@ -0,0 +1,78 @@
+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'
+
+/** Coerce a numeric flag, failing with a clean input error on garbage. */
+function num(name, value) {
+  if (value === undefined) return undefined
+  const n = Number(value)
+  if (!Number.isFinite(n)) {
+    throw new CliError(`Invalid number for --${name}: "${value}"`, {
+      exitCode: 64,
+    })
+  }
+  return n
+}
+
+export default class DealProductUpdateCommand extends BaseCommand {
+  static description =
+    'Update a product attached to a deal (v2 PATCH — only provided fields change)'
+
+  static examples = [
+    '<%= config.bin %> deal product update 42 --attachment 3 --quantity 5',
+    '<%= config.bin %> deal product update 42 --attachment 3 --price 120',
+    '<%= config.bin %> deal product update 42 --attachment 3 --discount 15 --discount-type amount',
+  ]
+
+  static args = {
+    id: Args.integer({ required: true, description: 'Deal ID' }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    attachment: Flags.integer({
+      required: true,
+      description: 'Deal-product (attachment) ID',
+    }),
+    product: Flags.integer({ description: 'Product ID' }),
+    price: Flags.string({ description: 'Item price (per unit)' }),
+    quantity: Flags.string({ description: 'Quantity' }),
+    discount: Flags.string({ description: 'Discount value' }),
+    'discount-type': Flags.string({
+      description: 'Discount type',
+      options: ['percentage', 'amount'],
+    }),
+    tax: Flags.string({ description: 'Product tax percentage' }),
+    comments: Flags.string({ description: 'Comments' }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(DealProductUpdateCommand)
+
+    const body = buildWriteBody({
+      typed: {
+        product_id: flags.product,
+        item_price: num('price', flags.price),
+        quantity: num('quantity', flags.quantity),
+        discount: num('discount', flags.discount),
+        discount_type: flags['discount-type'],
+        tax: num('tax', flags.tax),
+        comments: flags.comments,
+      },
+    })
+
+    if (Object.keys(body).length === 0) {
+      throw new CliError('Nothing to update — pass at least one field flag', {
+        exitCode: 64,
+      })
+    }
+
+    const res = await this.apiClient.patch(
+      `/api/v2/deals/${args.id}/products/${flags.attachment}`,
+      { body },
+    )
+    await outputRecord(this, res.data)
+  }
+}

package/src/commands/deal/summary.js

@@ -0,0 +1,69 @@
+import { Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+
+const columns = {
+  currency: { header: 'Currency' },
+  total: { header: 'Total' },
+  weighted: { header: 'Weighted' },
+  count: { header: 'Count' },
+}
+
+export default class DealSummaryCommand extends BaseCommand {
+  static description = 'Summary of open/won/lost deals, totalled per currency'
+
+  static examples = [
+    '<%= config.bin %> deal summary',
+    '<%= config.bin %> deal summary --status open --pipeline 1',
+    '<%= config.bin %> deal summary --output json',
+  ]
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    status: Flags.string({
+      description: 'Filter by status',
+      options: ['open', 'won', 'lost'],
+    }),
+    pipeline: Flags.integer({ description: 'Filter by pipeline ID' }),
+    stage: Flags.integer({ description: 'Filter by stage ID' }),
+    filter: Flags.integer({ description: 'Filter by saved filter ID' }),
+  }
+
+  async run() {
+    const { flags } = await this.parse(DealSummaryCommand)
+
+    // Summary lives on v1; the v2 wrapper does not exist. Cost: 40 tokens.
+    const body = await this.apiClient.get('/api/v1/deals/summary', {
+      query: {
+        status: flags.status,
+        pipeline_id: flags.pipeline,
+        stage_id: flags.stage,
+        filter_id: flags.filter,
+      },
+    })
+
+    const data = body.data ?? {}
+
+    // Non-table formats stay raw for scriptability: emit the data object as-is
+    // (per-currency totals, grand totals, counts).
+    if (this.resolveFormat() !== 'table') {
+      await this.outputResults(data, columns)
+      return
+    }
+
+    // Table view: one row per deal currency. Totals come pre-formatted from the
+    // API (`value_formatted`, e.g. "€10") — render those rather than re-deriving
+    // currency symbols. Weighted totals are keyed by the same currency code.
+    const values = data.values_total ?? {}
+    const weighted = data.weighted_values_total ?? {}
+    // `get` returning undefined renders as an empty cell, so no `?? ''` tail.
+    const rows = Object.entries(values).map(([currency, totals]) => ({
+      currency,
+      total: totals.value_formatted ?? totals.value,
+      weighted:
+        weighted[currency]?.value_formatted ?? weighted[currency]?.value,
+      count: totals.count,
+    }))
+
+    await this.outputResults(rows, columns)
+  }
+}

package/src/commands/field/create.js

@@ -0,0 +1,72 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../base-command.js'
+import { clearFieldsCache, entityToFieldsPath } from '../../lib/fields.js'
+import { CliError } from '../../lib/errors.js'
+
+/** Option-bearing field types that require --options on creation. */
+const OPTION_TYPES = new Set(['enum', 'set'])
+
+export default class FieldCreateCommand extends BaseCommand {
+  static description = 'Create a custom field on an entity'
+
+  static examples = [
+    '<%= config.bin %> field create deal --name "Budget" --type double',
+    '<%= config.bin %> field create person --name "Tier" --type enum --options "Gold,Silver,Bronze"',
+  ]
+
+  static args = {
+    entity: Args.string({
+      required: true,
+      description: 'Entity type',
+      // Custom fields are writable on core v2 entities only — activity fields
+      // are read-only, and lead/note have no v2 write path.
+      options: ['deal', 'person', 'org', 'organization', 'product'],
+    }),
+  }
+
+  static flags = {
+    ...BaseCommand.baseFlags,
+    name: Flags.string({ required: true, description: 'Field name (label)' }),
+    type: Flags.string({
+      required: true,
+      description: 'Field type (e.g. varchar, double, monetary, enum, set)',
+    }),
+    options: Flags.string({
+      description: 'Comma-separated option labels (required for enum/set)',
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FieldCreateCommand)
+
+    const isOptionType = OPTION_TYPES.has(flags.type)
+    if (isOptionType && !flags.options) {
+      throw new CliError(
+        `Field type "${flags.type}" requires --options "A,B,C"`,
+        { exitCode: 64 },
+      )
+    }
+
+    const body = { field_name: flags.name, field_type: flags.type }
+    if (isOptionType) {
+      body.options = flags.options
+        .split(',')
+        .map((label) => ({ label: label.trim() }))
+    }
+
+    const path = entityToFieldsPath(args.entity)
+    const res = await this.apiClient.post(path, { body })
+
+    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/field/delete.js

@@ -0,0 +1,56 @@
+import { Args, Flags } from '@oclif/core'
+import chalk from 'chalk'
+import BaseCommand from '../../base-command.js'
+import { confirmAction } from '../../lib/confirm.js'
+import { clearFieldsCache, entityToFieldsPath } from '../../lib/fields.js'
+import { CliError } from '../../lib/errors.js'
+
+export default class FieldDeleteCommand extends BaseCommand {
+  static description = 'Delete a custom field (data stored on records is lost)'
+
+  static examples = [
+    '<%= config.bin %> field delete deal dcf558aac1ae4e8c4f849ba5e668430d8df9be12',
+    '<%= config.bin %> field delete deal dcf558aac1ae4e8c4f849ba5e668430d8df9be12 --yes',
+  ]
+
+  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,
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FieldDeleteCommand)
+
+    const ok = await confirmAction(
+      `Delete field ${args.field} on ${args.entity}? ` +
+        `All data stored in this field on existing records is lost.`,
+      flags.yes,
+      { default: false },
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    await this.apiClient.del(`${entityToFieldsPath(args.entity)}/${args.field}`)
+
+    clearFieldsCache()
+
+    this.log(chalk.green(`Deleted field ${args.field} on ${args.entity}`))
+  }
+}

package/src/commands/field/get.js

@@ -15,7 +15,16 @@ export default class FieldGetCommand extends BaseCommand {
     entity: Args.string({
       required: true,
       description: 'Entity type',
-      options: ['deal', 'person', 'org', 'organization', 'product', 'activity'],
+      options: [
+        'deal',
+        'person',
+        'org',
+        'organization',
+        'product',
+        'activity',
+        'lead',
+        'note',
+      ],
     }),
     field: Args.string({
       required: true,

package/src/commands/field/list.js

@@ -15,7 +15,16 @@ export default class FieldListCommand extends BaseCommand {
     entity: Args.string({
       required: true,
       description: 'Entity type',
-      options: ['deal', 'person', 'org', 'organization', 'product', 'activity'],
+      options: [
+        'deal',
+        'person',
+        'org',
+        'organization',
+        'product',
+        'activity',
+        'lead',
+        'note',
+      ],
     }),
   }
 

package/src/commands/field/option/add.js

@@ -0,0 +1,49 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { clearFieldsCache, entityToFieldsPath } from '../../../lib/fields.js'
+
+export default class FieldOptionAddCommand extends BaseCommand {
+  static description = 'Add an option to an enum/set custom field'
+
+  static examples = [
+    '<%= config.bin %> field option add deal dcf558aac1ae4e8c4f849ba5e668430d8df9be12 --label "Critical"',
+  ]
+
+  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,
+    label: Flags.string({
+      required: true,
+      description: 'Label for the new option',
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FieldOptionAddCommand)
+
+    const res = await this.apiClient.post(
+      `${entityToFieldsPath(args.entity)}/${args.field}/options`,
+      { body: [{ label: flags.label }] },
+    )
+
+    // Option ids feed the per-run resolver — invalidate so the new option
+    // resolves immediately within this process.
+    clearFieldsCache()
+
+    await this.outputResults(res.data ?? [], {
+      id: { header: 'ID' },
+      label: { header: 'Label' },
+    })
+  }
+}

package/src/commands/field/option/remove.js

@@ -0,0 +1,72 @@
+import { Args, Flags } from '@oclif/core'
+import BaseCommand from '../../../base-command.js'
+import { confirmAction } from '../../../lib/confirm.js'
+import { clearFieldsCache, entityToFieldsPath } from '../../../lib/fields.js'
+import { CliError } from '../../../lib/errors.js'
+
+export default class FieldOptionRemoveCommand extends BaseCommand {
+  static description =
+    'Remove an option from an enum/set custom field (records lose the value)'
+
+  static examples = [
+    '<%= config.bin %> field option remove deal dcf558aac1ae4e8c4f849ba5e668430d8df9be12 --option 4',
+  ]
+
+  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,
+    option: Flags.string({
+      required: true,
+      description: 'Option ID to remove (see field get)',
+    }),
+    yes: Flags.boolean({
+      char: 'y',
+      description: 'Skip the confirmation prompt',
+      default: false,
+    }),
+  }
+
+  async run() {
+    const { args, flags } = await this.parse(FieldOptionRemoveCommand)
+
+    const optionId = Number(flags.option)
+    if (!Number.isInteger(optionId)) {
+      throw new CliError(`Invalid option id: "${flags.option}"`, {
+        exitCode: 64,
+      })
+    }
+
+    const ok = await confirmAction(
+      `Remove option ${optionId} from field ${args.field} on ${args.entity}? ` +
+        `Records using it lose the value.`,
+      flags.yes,
+      { default: false },
+    )
+    if (!ok) {
+      throw new CliError('Aborted', { exitCode: 1 })
+    }
+
+    const res = await this.apiClient.del(
+      `${entityToFieldsPath(args.entity)}/${args.field}/options`,
+      { body: [{ id: optionId }] },
+    )
+
+    clearFieldsCache()
+
+    await this.outputResults(res.data ?? [], {
+      id: { header: 'ID' },
+      label: { header: 'Label' },
+    })
+  }
+}