@dealmachine/cli 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +66 -15
  3. package/dist/commands/agents.d.ts.map +1 -1
  4. package/dist/commands/agents.js +1 -0
  5. package/dist/commands/agents.js.map +1 -1
  6. package/dist/commands/enrich.d.ts +16 -0
  7. package/dist/commands/enrich.d.ts.map +1 -1
  8. package/dist/commands/enrich.js +67 -7
  9. package/dist/commands/enrich.js.map +1 -1
  10. package/dist/commands/filters.d.ts.map +1 -1
  11. package/dist/commands/filters.js +2 -1
  12. package/dist/commands/filters.js.map +1 -1
  13. package/dist/commands/locations.d.ts +1 -1
  14. package/dist/commands/locations.js +4 -4
  15. package/dist/commands/onboarding.d.ts +24 -0
  16. package/dist/commands/onboarding.d.ts.map +1 -0
  17. package/dist/commands/onboarding.js +139 -0
  18. package/dist/commands/onboarding.js.map +1 -0
  19. package/dist/commands/people.d.ts +4 -0
  20. package/dist/commands/people.d.ts.map +1 -1
  21. package/dist/commands/people.js +14 -0
  22. package/dist/commands/people.js.map +1 -1
  23. package/dist/commands/properties.d.ts +1 -0
  24. package/dist/commands/properties.d.ts.map +1 -1
  25. package/dist/commands/properties.js +2 -0
  26. package/dist/commands/properties.js.map +1 -1
  27. package/dist/index.js +82 -9
  28. package/dist/index.js.map +1 -1
  29. package/dist/lib/api.d.ts.map +1 -1
  30. package/dist/lib/api.js +4 -3
  31. package/dist/lib/api.js.map +1 -1
  32. package/dist/lib/client.d.ts.map +1 -1
  33. package/dist/lib/client.js +2 -1
  34. package/dist/lib/client.js.map +1 -1
  35. package/dist/version.d.ts +3 -0
  36. package/dist/version.d.ts.map +1 -0
  37. package/dist/version.js +3 -0
  38. package/dist/version.js.map +1 -0
  39. package/package.json +22 -5
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 DealMachine
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -108,6 +108,8 @@ dm login --key dm_sk_live_abc123...
108
108
 
109
109
  The key is verified against `GET /v1/account` before being stored. If verification fails, the CLI exits with a non-zero code.
110
110
 
111
+ If you do not have an API key yet, use `dm signup`, `dm plans`, and `dm checkout` first. Public plan checkout only accepts self-serve Basic and Pro prices from the shared plan catalog and is capped at 60,000 monthly data credits.
112
+
111
113
  ### Switching Environments
112
114
 
113
115
  If you are already logged in, you can switch the target API environment without logging out:
@@ -206,6 +208,32 @@ The Playbook is copied from `packages/playbooks/playbook/SKILL.md` into `dist/ag
206
208
 
207
209
  ### Auth Commands
208
210
 
211
+ #### `dm signup`
212
+
213
+ Create a public API account and receive an API key:
214
+
215
+ ```bash
216
+ dm signup developer@example.com --first-name Ada --last-name Lovelace --phone-number +15551234567
217
+ dm signup developer@example.com --login
218
+ ```
219
+
220
+ #### `dm plans`
221
+
222
+ List public self-serve Basic and Pro plans:
223
+
224
+ ```bash
225
+ dm plans
226
+ dm plans --json
227
+ ```
228
+
229
+ #### `dm checkout`
230
+
231
+ Create a Stripe checkout session using a price ID from `dm plans`:
232
+
233
+ ```bash
234
+ dm checkout --price-id price_xxx_monthly
235
+ ```
236
+
209
237
  #### `dm login`
210
238
 
211
239
  Authenticate with your DealMachine account.
@@ -385,12 +413,14 @@ Get a single property by its DealMachine ID.
385
413
  ```bash
386
414
  dm properties get prop_12345
387
415
  dm properties get prop_12345 --contact-audience owners_and_family
416
+ dm properties get prop_12345 --fields estimated_value,equity
388
417
  dm properties get prop_12345 --json
389
418
  ```
390
419
 
391
420
  | Option | Description |
392
421
  | ------------------------------- | ------------------------------------------------------------ |
393
422
  | `--contact-audience <audience>` | `owners`, `owners_and_family`, `renters`, `residents`, `all` |
423
+ | `--fields <csv>` | Comma-separated property field IDs from `dm fields` |
394
424
  | `--json` | Output as JSON |
395
425
 
396
426
  #### `dm properties ids [ids...]`
@@ -467,14 +497,17 @@ Get a single person by their DealMachine ID.
467
497
 
468
498
  ```bash
469
499
  dm people get per_12345
470
- dm people get per_12345 --include-properties
500
+ dm people get per_12345 --include-properties --property-limit 20
501
+ dm people get per_12345 --fields estimated_household_income,estimated_value
471
502
  dm people get per_12345 --json
472
503
  ```
473
504
 
474
- | Option | Description |
475
- | ---------------------- | ----------------------------- |
476
- | `--include-properties` | Include associated properties |
477
- | `--json` | Output as JSON |
505
+ | Option | Description |
506
+ | ---------------------- | ---------------------------------------------------------- |
507
+ | `--include-properties` | Include associated properties |
508
+ | `--property-limit <n>` | Maximum associated properties to return, from 1 through 100 |
509
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
510
+ | `--json` | Output as JSON |
478
511
 
479
512
  #### `dm people ids [ids...]`
480
513
 
@@ -482,9 +515,16 @@ Get multiple people by their IDs in a single batch request.
482
515
 
483
516
  ```bash
484
517
  dm people ids per_111 per_222 per_333
485
- dm people ids --body '{"ids": ["per_111", "per_222"]}' --include-properties
518
+ dm people ids --body '{"ids": ["per_111", "per_222"]}' --include-properties --property-limit 20
519
+ dm people ids per_111 per_222 --fields estimated_household_income,estimated_value
486
520
  ```
487
521
 
522
+ | Option | Description |
523
+ | ---------------------- | -------------------------------------------------------------- |
524
+ | `--include-properties` | Include associated properties |
525
+ | `--property-limit <n>` | Maximum associated properties to return per person, up to 100 |
526
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
527
+
488
528
  #### `dm people export`
489
529
 
490
530
  Export people as CSV (up to 1,000,000 records). Returns signed download URLs.
@@ -500,7 +540,7 @@ Contact filter options are the same as `dm properties export`.
500
540
 
501
541
  ### Enrich Commands
502
542
 
503
- All enrichment commands support three input modes: a positional argument for single-item lookup, `--body`/`-f` for JSON payloads, and `-f` with a `.csv` file for batch enrichment from CSV. Batches larger than 250 items are automatically chunked.
543
+ All enrichment commands support three input modes: a positional argument for single-item lookup, `--body`/`-f` for JSON payloads, and `-f` with a `.csv` file for batch enrichment from CSV. Batches larger than 250 items are automatically chunked. Every enrichment command accepts `--fields <csv>` and sends the selected field IDs to the API. Email, phone, and name matches also include a free `property_count`; use `--include-properties` when you need the property records themselves.
504
544
 
505
545
  #### `dm enrich address [address]`
506
546
 
@@ -509,6 +549,7 @@ Look up a property by street address.
509
549
  ```bash
510
550
  # Single address
511
551
  dm enrich address "123 Main St, Austin, TX 78704"
552
+ dm enrich address "123 Main St, Austin, TX 78704" --fields estimated_value,equity
512
553
 
513
554
  # Batch from JSON
514
555
  dm enrich address --body '{"data": [{"full_address": "123 Main St, Austin, TX"}]}'
@@ -524,6 +565,7 @@ dm enrich address -f addresses.csv --contact-audience owners
524
565
  | `--body <json>` | Request body as JSON string |
525
566
  | `-f, --file <path>` | Read from JSON or CSV file |
526
567
  | `--contact-audience <audience>` | `owners`, `owners_and_family`, `renters`, `residents` |
568
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
527
569
  | `--json` | Output as JSON |
528
570
 
529
571
  #### `dm enrich latlng [coords]`
@@ -532,7 +574,7 @@ Look up a property by latitude/longitude coordinates.
532
574
 
533
575
  ```bash
534
576
  dm enrich latlng 30.25,-97.75
535
- dm enrich latlng -f coordinates.csv
577
+ dm enrich latlng -f coordinates.csv --fields estimated_value,equity
536
578
  # CSV columns: latitude, longitude (or lat, lng/lon/long)
537
579
  ```
538
580
 
@@ -542,7 +584,7 @@ Look up a property by Assessor's Parcel Number. Narrow results with `--state` or
542
584
 
543
585
  ```bash
544
586
  dm enrich apn "0123-456-789" --state TX
545
- dm enrich apn -f parcels.csv --zip 78704
587
+ dm enrich apn -f parcels.csv --zip 78704 --fields estimated_value,equity
546
588
  # CSV columns: apn (or parcel_id, parcel_number)
547
589
  ```
548
590
 
@@ -551,6 +593,7 @@ dm enrich apn -f parcels.csv --zip 78704
551
593
  | `--state <code>` | Narrow by state (e.g., TX) |
552
594
  | `--zip <code>` | Narrow by ZIP code |
553
595
  | `--contact-audience <audience>` | `owners`, `owners_and_family`, `renters`, `residents` |
596
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
554
597
 
555
598
  #### `dm enrich email [email]`
556
599
 
@@ -559,13 +602,14 @@ Look up a person by email address.
559
602
  ```bash
560
603
  dm enrich email jane@example.com
561
604
  dm enrich email jane@example.com --include-properties
562
- dm enrich email -f emails.csv --json
605
+ dm enrich email -f emails.csv --fields estimated_household_income,estimated_value --json
563
606
  # CSV columns: email (or email_address)
564
607
  ```
565
608
 
566
- | Option | Description |
567
- | ---------------------- | ----------------------------- |
568
- | `--include-properties` | Include associated properties |
609
+ | Option | Description |
610
+ | ---------------------- | ---------------------------------------------- |
611
+ | `--include-properties` | Include associated properties |
612
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
569
613
 
570
614
  #### `dm enrich phone [phone]`
571
615
 
@@ -573,10 +617,15 @@ Look up a person by phone number.
573
617
 
574
618
  ```bash
575
619
  dm enrich phone 5125551234
576
- dm enrich phone -f phones.csv --include-properties
620
+ dm enrich phone -f phones.csv --include-properties --fields estimated_value
577
621
  # CSV columns: phone (or phone_number)
578
622
  ```
579
623
 
624
+ | Option | Description |
625
+ | ---------------------- | ------------------------------------------ |
626
+ | `--include-properties` | Include associated properties |
627
+ | `--fields <csv>` | Comma-separated field IDs from `dm fields` |
628
+
580
629
  #### `dm enrich name [name]`
581
630
 
582
631
  Look up people by name. Supports "First Last" or just "Last" format.
@@ -586,6 +635,7 @@ dm enrich name "Jane Doe"
586
635
  dm enrich name "Jane Doe" --state TX --estimate-cost
587
636
  dm enrich name "Doe" --state TX --page 2
588
637
  dm enrich name "Jane Doe" --zip 78704 --include-properties
638
+ dm enrich name "Jane Doe" --fields estimated_household_income,estimated_value
589
639
  ```
590
640
 
591
641
  | Option | Description |
@@ -593,6 +643,7 @@ dm enrich name "Jane Doe" --zip 78704 --include-properties
593
643
  | `--state <code>` | Narrow by state |
594
644
  | `--zip <code>` | Narrow by ZIP code |
595
645
  | `--include-properties` | Include associated properties |
646
+ | `--fields <csv>` | Field IDs from `dm fields` |
596
647
  | `--estimate-cost` | Preview count and credits |
597
648
  | `--page <n>` | Page number |
598
649
  | `--per-page <n>` | Results per page |
@@ -996,7 +1047,7 @@ packages/cli/
996
1047
  | Module | Responsibility |
997
1048
  | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
998
1049
  | `lib/config.ts` | Manages `~/.dealmachine/config.json`. Enforces `0600` file permissions and `0700` directory permissions. Provides typed read/write/delete helpers. |
999
- | `lib/client.ts` | Central HTTP client. Resolves the API base URL from env vars, config, or defaults. Attaches the `Authorization: Bearer` header and `User-Agent: dm-cli/0.1.0`. Exits with a non-zero code on HTTP errors. |
1050
+ | `lib/client.ts` | Central HTTP client. Resolves the API base URL from env vars, config, or defaults. Attaches the `Authorization: Bearer` header and versioned `User-Agent`. Exits with a non-zero code on HTTP errors. |
1000
1051
  | `lib/api.ts` | Device authorization flow implementation. Handles `POST /v1/auth/device/code` and `POST /v1/auth/device/token` with RFC 8628-compliant polling and error mapping. Also provides `verifyCredentials` for key validation. |
1001
1052
  | `lib/output.ts` | All output formatting: `printTable` (auto-width columns), `printJson`, `printKeyValue`, `printPagination`, `printCredits`, `printTotals`, `printWarning`, `printHeader`. Also exports `parseRequestBody` which handles `--body`, `-f`, and stdin input. |
1002
1053
 
@@ -1 +1 @@
1
- {"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../src/commands/agents.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,UAAU,YAAY;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAkFD,wBAAsB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAYtE;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CA0BzE"}
1
+ {"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../src/commands/agents.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,UAAU,YAAY;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAmFD,wBAAsB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAYtE;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CA0BzE"}
@@ -59,6 +59,7 @@ function getPlaybookCandidates() {
59
59
  return Array.from(new Set([
60
60
  path.resolve(currentDir, '../agents', PLAYBOOK_FILE_NAME),
61
61
  path.resolve(currentDir, '../../dist/agents', PLAYBOOK_FILE_NAME),
62
+ path.resolve(currentDir, '../../playbook/SKILL.md'),
62
63
  path.resolve(currentDir, '../../../playbooks/playbook/SKILL.md'),
63
64
  path.resolve(process.cwd(), 'packages/playbooks/playbook/SKILL.md'),
64
65
  path.resolve(process.cwd(), '../playbooks/playbook/SKILL.md'),
@@ -1 +1 @@
1
- {"version":3,"file":"agents.js","sourceRoot":"","sources":["../../src/commands/agents.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAM7C,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;AAErD,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CnB,CAAC;AAEF,SAAS,qBAAqB;IAC5B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7C,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,GAAG,CAAC;QACN,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC;QACzD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAmB,EAAE,kBAAkB,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,sCAAsC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sCAAsC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,gCAAgC,CAAC;KAC9D,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,YAAY;IACnB,KAAK,MAAM,SAAS,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAChD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO;gBACL,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC;gBAC5C,IAAI,EAAE,SAAS;aAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CACb,gHAAgH,CACjH,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAqB;IACrD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,SAAS,CAAC;YACR,IAAI,EAAE,6BAA6B;YACnC,IAAI,EAAE,aAAa;YACnB,yBAAyB,EAAE,oBAAoB;YAC/C,OAAO,EAAE,WAAW;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAqB;IACxD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,SAAS,CAAC;gBACR,IAAI,EAAE,sBAAsB;gBAC5B,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAA0C,CAAC;QACpG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;YAC9B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"agents.js","sourceRoot":"","sources":["../../src/commands/agents.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAM7C,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;AAErD,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CnB,CAAC;AAEF,SAAS,qBAAqB;IAC5B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7C,OAAO,KAAK,CAAC,IAAI,CACf,IAAI,GAAG,CAAC;QACN,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,kBAAkB,CAAC;QACzD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAmB,EAAE,kBAAkB,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,yBAAyB,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,sCAAsC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sCAAsC,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,gCAAgC,CAAC;KAC9D,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,YAAY;IACnB,KAAK,MAAM,SAAS,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAChD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7B,OAAO;gBACL,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC;gBAC5C,IAAI,EAAE,SAAS;aAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CACb,gHAAgH,CACjH,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAqB;IACrD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,SAAS,CAAC;YACR,IAAI,EAAE,6BAA6B;YACnC,IAAI,EAAE,aAAa;YACnB,yBAAyB,EAAE,oBAAoB;YAC/C,OAAO,EAAE,WAAW;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAqB;IACxD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;QAEhC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,SAAS,CAAC;gBACR,IAAI,EAAE,sBAAsB;gBAC5B,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAA0C,CAAC;QACpG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;YAC9B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}
@@ -5,12 +5,14 @@ export declare function enrichAddress(address: string | undefined, options: {
5
5
  body?: string;
6
6
  file?: string;
7
7
  contactAudience?: string;
8
+ fields?: string;
8
9
  json?: boolean;
9
10
  }): Promise<void>;
10
11
  export declare function enrichLatLng(coords: string | undefined, options: {
11
12
  body?: string;
12
13
  file?: string;
13
14
  contactAudience?: string;
15
+ fields?: string;
14
16
  json?: boolean;
15
17
  }): Promise<void>;
16
18
  export declare function enrichApn(apn: string | undefined, options: {
@@ -19,18 +21,29 @@ export declare function enrichApn(apn: string | undefined, options: {
19
21
  state?: string;
20
22
  zip?: string;
21
23
  contactAudience?: string;
24
+ fields?: string;
22
25
  json?: boolean;
23
26
  }): Promise<void>;
24
27
  export declare function enrichEmail(email: string | undefined, options: {
25
28
  body?: string;
26
29
  file?: string;
27
30
  includeProperties?: boolean;
31
+ state?: string;
32
+ zip?: string;
33
+ county?: string;
34
+ city?: string;
35
+ fields?: string;
28
36
  json?: boolean;
29
37
  }): Promise<void>;
30
38
  export declare function enrichPhone(phone: string | undefined, options: {
31
39
  body?: string;
32
40
  file?: string;
33
41
  includeProperties?: boolean;
42
+ state?: string;
43
+ zip?: string;
44
+ county?: string;
45
+ city?: string;
46
+ fields?: string;
34
47
  json?: boolean;
35
48
  }): Promise<void>;
36
49
  export declare function enrichName(name: string | undefined, options: {
@@ -38,10 +51,13 @@ export declare function enrichName(name: string | undefined, options: {
38
51
  file?: string;
39
52
  state?: string;
40
53
  zip?: string;
54
+ county?: string;
55
+ city?: string;
41
56
  includeProperties?: boolean;
42
57
  estimateCost?: boolean;
43
58
  page?: string;
44
59
  perPage?: string;
60
+ fields?: string;
45
61
  json?: boolean;
46
62
  }): Promise<void>;
47
63
  //# sourceMappingURL=enrich.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"enrich.d.ts","sourceRoot":"","sources":["../../src/commands/enrich.ts"],"names":[],"mappings":"AAAA;;GAEG;AA0KH,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CA6Ff;AAMD,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAyFf;AAMD,wBAAsB,SAAS,CAC7B,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAgFf;AAMD,wBAAsB,WAAW,CAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CA4Ef;AAMD,wBAAsB,WAAW,CAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CA4Ef;AAMD,wBAAsB,UAAU,CAC9B,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CA8Ef"}
1
+ {"version":3,"file":"enrich.d.ts","sourceRoot":"","sources":["../../src/commands/enrich.ts"],"names":[],"mappings":"AAAA;;GAEG;AAoMH,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAgGf;AAMD,wBAAsB,YAAY,CAChC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CA4Ff;AAMD,wBAAsB,SAAS,CAC7B,GAAG,EAAE,MAAM,GAAG,SAAS,EACvB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAmFf;AAMD,wBAAsB,WAAW,CAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAiFf;AAMD,wBAAsB,WAAW,CAC/B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAiFf;AAMD,wBAAsB,UAAU,CAC9B,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,OAAO,EAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GACA,OAAO,CAAC,IAAI,CAAC,CAgFf"}
@@ -6,10 +6,30 @@ import path from 'node:path';
6
6
  import chalk from 'chalk';
7
7
  import { apiRequest } from '../lib/client.js';
8
8
  import { parseRequestBody, printJson, printHeader, printTable, printTotals, printCredits, printWarning, printPagination, formatCurrency, truncate, createSpinner, } from '../lib/output.js';
9
+ function parseFieldsCsv(value) {
10
+ return value
11
+ .split(',')
12
+ .map((field) => field.trim())
13
+ .filter(Boolean);
14
+ }
9
15
  // ============================================================================
10
16
  // CSV + Batch Helpers
11
17
  // ============================================================================
12
18
  const API_BATCH_LIMIT = 250;
19
+ function applyLocationOption(body, options) {
20
+ if (options.city) {
21
+ body.location = { type: 'city', code: options.city };
22
+ }
23
+ else if (options.county) {
24
+ body.location = { type: 'county', code: options.county };
25
+ }
26
+ else if (options.zip) {
27
+ body.location = { type: 'zip_code', code: options.zip };
28
+ }
29
+ else if (options.state) {
30
+ body.location = { type: 'state', code: options.state };
31
+ }
32
+ }
13
33
  /** Parse a CSV file into an array of objects keyed by lowercase column headers. */
14
34
  function parseCsv(filePath) {
15
35
  const content = fs.readFileSync(filePath, 'utf-8');
@@ -128,6 +148,8 @@ export async function enrichAddress(address, options) {
128
148
  const extraBody = {};
129
149
  if (options.contactAudience)
130
150
  extraBody.contact_audience = options.contactAudience;
151
+ if (options.fields)
152
+ extraBody.fields = parseFieldsCsv(options.fields);
131
153
  const merged = await runBatchEnrichment({
132
154
  items,
133
155
  arrayKey: 'data',
@@ -147,9 +169,13 @@ export async function enrichAddress(address, options) {
147
169
  requestBody = { data: [{ full_address: address }] };
148
170
  if (options.contactAudience)
149
171
  requestBody.contact_audience = options.contactAudience;
172
+ if (options.fields)
173
+ requestBody.fields = parseFieldsCsv(options.fields);
150
174
  }
151
175
  else {
152
176
  requestBody = await parseRequestBody(options);
177
+ if (options.fields)
178
+ requestBody.fields = parseFieldsCsv(options.fields);
153
179
  }
154
180
  // Auto-batch large JSON input
155
181
  const addrItems = requestBody.data;
@@ -208,6 +234,8 @@ export async function enrichLatLng(coords, options) {
208
234
  const extraBody = {};
209
235
  if (options.contactAudience)
210
236
  extraBody.contact_audience = options.contactAudience;
237
+ if (options.fields)
238
+ extraBody.fields = parseFieldsCsv(options.fields);
211
239
  const merged = await runBatchEnrichment({
212
240
  items,
213
241
  arrayKey: 'data',
@@ -232,9 +260,13 @@ export async function enrichLatLng(coords, options) {
232
260
  requestBody = { data: [{ latitude: lat, longitude: lng }] };
233
261
  if (options.contactAudience)
234
262
  requestBody.contact_audience = options.contactAudience;
263
+ if (options.fields)
264
+ requestBody.fields = parseFieldsCsv(options.fields);
235
265
  }
236
266
  else {
237
267
  requestBody = await parseRequestBody(options);
268
+ if (options.fields)
269
+ requestBody.fields = parseFieldsCsv(options.fields);
238
270
  }
239
271
  // Auto-batch large JSON input
240
272
  const latlngItems = requestBody.data;
@@ -287,6 +319,8 @@ export async function enrichApn(apn, options) {
287
319
  const extraBody = {};
288
320
  if (options.contactAudience)
289
321
  extraBody.contact_audience = options.contactAudience;
322
+ if (options.fields)
323
+ extraBody.fields = parseFieldsCsv(options.fields);
290
324
  if (options.state)
291
325
  extraBody.location = { type: 'state', code: options.state };
292
326
  else if (options.zip)
@@ -314,9 +348,13 @@ export async function enrichApn(apn, options) {
314
348
  requestBody.location = { type: 'zip_code', code: options.zip };
315
349
  if (options.contactAudience)
316
350
  requestBody.contact_audience = options.contactAudience;
351
+ if (options.fields)
352
+ requestBody.fields = parseFieldsCsv(options.fields);
317
353
  }
318
354
  else {
319
355
  requestBody = await parseRequestBody(options);
356
+ if (options.fields)
357
+ requestBody.fields = parseFieldsCsv(options.fields);
320
358
  }
321
359
  // Auto-batch large JSON input
322
360
  const apnItems = requestBody.data;
@@ -369,6 +407,9 @@ export async function enrichEmail(email, options) {
369
407
  const extraBody = {};
370
408
  if (options.includeProperties)
371
409
  extraBody.include_properties = true;
410
+ if (options.fields)
411
+ extraBody.fields = parseFieldsCsv(options.fields);
412
+ applyLocationOption(extraBody, options);
372
413
  const merged = await runBatchEnrichment({
373
414
  items,
374
415
  arrayKey: 'data',
@@ -388,10 +429,15 @@ export async function enrichEmail(email, options) {
388
429
  requestBody = { data: [{ email }] };
389
430
  if (options.includeProperties)
390
431
  requestBody.include_properties = true;
432
+ if (options.fields)
433
+ requestBody.fields = parseFieldsCsv(options.fields);
391
434
  }
392
435
  else {
393
436
  requestBody = await parseRequestBody(options);
437
+ if (options.fields)
438
+ requestBody.fields = parseFieldsCsv(options.fields);
394
439
  }
440
+ applyLocationOption(requestBody, options);
395
441
  // Auto-batch large JSON input
396
442
  const emailItems = requestBody.data;
397
443
  if (emailItems && emailItems.length > API_BATCH_LIMIT) {
@@ -443,6 +489,9 @@ export async function enrichPhone(phone, options) {
443
489
  const extraBody = {};
444
490
  if (options.includeProperties)
445
491
  extraBody.include_properties = true;
492
+ if (options.fields)
493
+ extraBody.fields = parseFieldsCsv(options.fields);
494
+ applyLocationOption(extraBody, options);
446
495
  const merged = await runBatchEnrichment({
447
496
  items,
448
497
  arrayKey: 'data',
@@ -462,10 +511,15 @@ export async function enrichPhone(phone, options) {
462
511
  requestBody = { data: [{ phone }] };
463
512
  if (options.includeProperties)
464
513
  requestBody.include_properties = true;
514
+ if (options.fields)
515
+ requestBody.fields = parseFieldsCsv(options.fields);
465
516
  }
466
517
  else {
467
518
  requestBody = await parseRequestBody(options);
519
+ if (options.fields)
520
+ requestBody.fields = parseFieldsCsv(options.fields);
468
521
  }
522
+ applyLocationOption(requestBody, options);
469
523
  // Auto-batch large JSON input
470
524
  const phoneItems = requestBody.data;
471
525
  if (phoneItems && phoneItems.length > API_BATCH_LIMIT) {
@@ -517,12 +571,6 @@ export async function enrichName(name, options) {
517
571
  data: [nameObj],
518
572
  };
519
573
  // Add location if provided
520
- if (options.state) {
521
- requestBody.location = { type: 'state', code: options.state };
522
- }
523
- else if (options.zip) {
524
- requestBody.location = { type: 'zip_code', code: options.zip };
525
- }
526
574
  if (options.includeProperties)
527
575
  requestBody.include_properties = true;
528
576
  if (options.estimateCost)
@@ -531,12 +579,17 @@ export async function enrichName(name, options) {
531
579
  requestBody.page = parseInt(options.page, 10);
532
580
  if (options.perPage)
533
581
  requestBody.per_page = parseInt(options.perPage, 10);
582
+ if (options.fields)
583
+ requestBody.fields = parseFieldsCsv(options.fields);
534
584
  }
535
585
  else {
536
586
  requestBody = await parseRequestBody(options);
537
587
  if (options.estimateCost)
538
588
  requestBody.estimate_cost = true;
589
+ if (options.fields)
590
+ requestBody.fields = parseFieldsCsv(options.fields);
539
591
  }
592
+ applyLocationOption(requestBody, options);
540
593
  const isEstimate = requestBody.estimate_cost === true;
541
594
  const spinner = createSpinner(isEstimate ? 'Estimating name enrichment...' : 'Enriching by name...').start();
542
595
  const data = await apiRequest('/enrichment/name', {
@@ -560,7 +613,11 @@ export async function enrichName(name, options) {
560
613
  name: truncate(String(p.full_name || ''), 25),
561
614
  phones: Array.isArray(p.phones) ? String(p.phones.length) : '—',
562
615
  emails: Array.isArray(p.emails) ? String(p.emails.length) : '—',
563
- properties: Array.isArray(p.properties) ? String(p.properties.length) : '—',
616
+ properties: p.property_count != null
617
+ ? String(p.property_count)
618
+ : Array.isArray(p.properties)
619
+ ? String(p.properties.length)
620
+ : '—',
564
621
  }));
565
622
  printTable(rows, ['id', 'name', 'phones', 'emails', 'properties']);
566
623
  }
@@ -671,6 +728,9 @@ function printPersonEnrichResult(title, data) {
671
728
  console.log(` ${chalk.dim('email:')} ${em.address || em.email || '—'}`);
672
729
  }
673
730
  }
731
+ if (ct.property_count != null) {
732
+ console.log(` ${chalk.dim('properties:')} ${String(ct.property_count)}`);
733
+ }
674
734
  }
675
735
  }
676
736
  console.log();