monocross 14.0.1 → 20.0.1

package/_init/props/.extractor/readme.txt

@@ -0,0 +1,168 @@
+Extractor
+=========
+
+Extract business emails continuously from ZoomInfo, Alibaba, Made-in-China,
+Crunchbase, LinkedIn, or PitchBook. Each provider has its own config folder under
+props/extractor/.
+
+Folder layout
+-------------
+  props/extractor/zoominfo/
+    apikey.txt    — ZoomInfo JWT or username/password
+    role.txt      — job titles to search (one per line)
+    product.txt   — products / keywords / categories (one per line)
+    region.txt    — country, state, city, other (blocks or pipe format)
+    advanced.txt  — performance, filters, timing, quality settings
+    extracted/    — output (emails.txt, extraction.log)
+
+  props/extractor/alibaba/
+    apikey.txt    — APP_KEY, APP_SECRET, optional SESSION
+    role.txt, product.txt, region.txt, advanced.txt, extracted/
+
+  props/extractor/madeinchina/
+    apikey.txt    — API_KEY, API_SECRET
+    role.txt, product.txt, region.txt, advanced.txt, extracted/
+
+  props/extractor/crunchbase/
+    apikey.txt    — Crunchbase user API key
+    role.txt, product.txt, region.txt, advanced.txt, extracted/
+
+  props/extractor/linkedin/
+    apikey.txt    — Bearer token (Proxycurl or partner API)
+    role.txt, product.txt, region.txt, advanced.txt, extracted/
+
+  props/extractor/pitchbook/
+    apikey.txt    — PB-Token API key (PitchBook Direct Data API)
+    role.txt, product.txt, region.txt, advanced.txt, extracted/
+
+Commands
+--------
+  monocross email --zoominfo
+  monocross email --alibaba
+  monocross email --madeinchina
+  monocross email --crunchbase
+  monocross email --linkedin
+  monocross email --pitchbook
+  monotomic email --<provider>
+
+CLI options
+-----------
+  --unlimited              Force unlimited mode (no artificial caps)
+  --max-emails <number>    Stop after N unique emails (0 = unlimited)
+  --max-cycles <number>    Limit extraction cycles (0 = forever)
+  --page-size <number>     Override PAGE_SIZE from advanced.txt
+  --api-key-file <path>    Custom apikey.txt path
+  --role-file <path>       Custom role.txt path
+  --advanced-file <path>   Custom advanced.txt path
+
+Examples
+--------
+  monocross email --madeinchina --unlimited
+  monocross email --zoominfo --max-emails 500000
+  monocross email --linkedin --max-emails 100000 --page-size 50
+  monocross email --pitchbook --max-emails 250000
+
+Output files (extracted/)
+-------------------------
+  emails.txt              — one email per line (deduplicated)
+  extraction.log          — run log
+  .seen-emails.txt        — dedupe index (supports resume)
+  .checkpoint.json       — resume state after restart
+  .extraction-stats.json  — credit / goal progress
+
+Setup
+-----
+1. Open the provider folder you want.
+2. Fill in apikey.txt with your credentials.
+3. role.txt and product.txt ship with full A-Z databases — delete lines you
+   do not want to target (lines starting with # are ignored).
+4. Add or edit regions in region.txt.
+5. Tune advanced.txt for speed, accuracy, and filters.
+6. Run the matching command from your project folder.
+
+Regenerate role/product catalogs
+--------------------------------
+  node utils/gec.js
+
+Rewrites role.txt and product.txt for every provider under _init and
+props/.extractor. Edit the script to add more entries, then re-run.
+
+Target matrix
+-------------
+Each extraction cycle runs every combination of:
+  role.txt  ×  region.txt  ×  product.txt
+
+Leave product.txt empty (or comment all lines) to search all products.
+Leave region.txt empty to search globally.
+
+Region format
+-------------
+Key=value block (all fields optional — need at least one):
+  COUNTRY=United States
+  STATE=California
+  COUNTY=San Francisco County
+  CITY=San Francisco
+  TOWN=Oakland
+  DISTRICT=Bay Area
+  BOROUGH=
+  SUBURB=
+  METRO=San Francisco Bay Area
+  POSTCODE=94105
+  ADDRESS=123 Market Street
+  TERRITORY=
+  OTHER=Silicon Valley
+
+Extended pipe format:
+  country|state|county|city|town|postcode|district|other
+
+Legacy pipe format (still supported):
+  country|state|city|other
+
+POSTCODE accepts US ZIP, UK postcodes, and numeric postal codes.
+TOWN is separate from CITY (village, township, hamlet).
+COUNTY maps to shire/parish in UK-style addresses.
+
+Advanced config highlights
+--------------------------
+Shared (all providers in advanced.txt):
+  UNLIMITED_MODE=true          — no artificial extraction caps (default)
+  MAX_EMAILS=0                 — 0 = unlimited; set 500000 for a goal target
+  API_CREDIT_LIMIT=0           — 0 = unlimited; set to your API account credits
+  CREDITS_PER_SEARCH=1         — credits charged per search API call
+  CREDITS_PER_EMAIL=1          — credits charged per profile enrich call
+  ACCURACY_MODE=strict|balanced|fast
+  MIN_QUALITY_SCORE (0-100), REQUIRE_BUSINESS_DOMAIN, EXCLUDE_FREE_EMAIL
+  BLOCKED_DOMAINS, ALLOWED_DOMAINS
+  CHECKPOINT_ENABLED (resume after restart)
+  TARGET_PRIORITY, TARGET_SHUFFLE, PARALLEL_TARGETS
+  MAX_PAGE_RETRIES, RATE_LIMIT_RPS, RICH_OUTPUT
+
+ZoomInfo: PAGE_SIZE, ENRICH_CONCURRENCY, ACCURACY_SCORE, PREFETCH_PAGES
+Alibaba: PAGE_SIZE, CONCURRENCY, SUPPLIER_METHOD, GATEWAY_URL
+Made-in-China: PAGE_SIZE, CONCURRENCY, API_BASE_URL, SEARCH_PATH
+Crunchbase: PAGE_SIZE, CONCURRENCY, SEARCH_MODE (people|organizations|both)
+LinkedIn: PAGE_SIZE, ENRICH_CONCURRENCY, API_BASE_URL, ENRICH_PROFILES
+PitchBook: PAGE_SIZE, CONCURRENCY, SEARCH_MODE (people|companies|investors|both),
+  API_BASE_URL, PEOPLE/COMPANIES/INVESTORS_SEARCH_PATH,
+  ENRICH_PROFILES, ENRICH_CONCURRENCY, USE_SEARCH_QUERY,
+  EXACT_JOB_TITLE, REQUIRES_HAS_EMAIL
+
+PitchBook backend mapping
+-------------------------
+  apikey.txt API_KEY        → Authorization: PB-Token header
+  role.txt                  → jobTitle, title (+ exactTitle if EXACT_JOB_TITLE)
+  product.txt               → industry, sector, vertical, q query text
+  region.txt                → country, state, city, location params
+  PAGE_SIZE                 → pageSize, limit, perPage, offset pagination
+  SEARCH_MODE=people        → GET {API_BASE_URL}/people/search
+  SEARCH_MODE=companies     → GET {API_BASE_URL}/companies/search
+  SEARCH_MODE=investors     → GET {API_BASE_URL}/investors/search
+  SEARCH_MODE=both          → people + companies in parallel (CONCURRENCY)
+  ENRICH_PROFILES=true      → GET {API_BASE_URL}/people/{id} when no email
+  USE_SEARCH_QUERY=true     → combined q= role+product+region string
+  REQUIRES_HAS_EMAIL=true   → hasEmail/includeEmail param + post-filter
+
+Legacy migration
+----------------
+Flat props/extractor/apikey.txt and role.txt are auto-migrated into
+the matching provider folder on first run.

package/_init/props/.extractor/zoominfo/advanced.txt

@@ -0,0 +1,64 @@
+# Unlimited extraction — 0 means no cap
+UNLIMITED_MODE=true
+# true | false — disable artificial email/cycle caps
+MAX_EMAILS=0
+# 0 = unlimited; set goal e.g. 500000 for bulk runs
+API_CREDIT_LIMIT=0
+# 0 = unlimited; match your provider plan quota
+CREDITS_PER_EMAIL=1
+# credits consumed per saved email (billing estimate)
+CREDITS_PER_SEARCH=1
+# credits consumed per search/page request
+STOP_ON_CREDIT_EXHAUSTED=true
+# true = stop when API_CREDIT_LIMIT is reached
+MAX_CYCLES=0
+# 0 = infinite cycles until Ctrl+C or limits hit
+
+# API resilience — reduces rate-limit / quota blocks
+SOFT_RETRY_BLOCKS=true
+# true = retry soft 403/429/captcha signals; false = fail fast
+ANTI_BLOCK_MODE=balanced
+# strict | balanced | fast
+RATE_LIMIT_RPS=0
+# 0 = unlimited pacing; set 2-3 if blocked often
+MAX_PAGE_RETRIES=3
+# retries per page on transient errors
+ROLE_DELAY_MS=1200
+# pause between role/region/product targets (ms)
+PAGE_DELAY_MS=600
+# pause between paginated requests (ms)
+CYCLE_DELAY_MS=5000
+# pause between full extraction cycles (ms)
+MAX_ERRORS_BEFORE_PAUSE=12
+# consecutive errors before cooldown pause
+REQUEST_TIMEOUT_MS=30000
+# HTTP request timeout (ms)
+PROXY_URL=
+# optional rotating proxy
+USER_AGENT=
+# optional custom UA
+
+# ZoomInfo provider settings
+PAGE_SIZE=100
+# contacts per search page (max 100)
+ENRICH_CONCURRENCY=3
+# parallel enrich requests for missing emails
+ENRICH_BATCH_SIZE=25
+# contacts per enrich API batch
+ACCURACY_SCORE=70
+# 0-100 minimum ZoomInfo contact accuracy score
+PREFETCH_PAGES=true
+# true = prefetch next page while processing current
+
+# Quality & throughput
+ACCURACY_MODE=balanced
+# strict | balanced | fast
+MIN_QUALITY_SCORE=60
+# 0-100 minimum contact quality score
+CHECKPOINT_ENABLED=true
+# true = resume from last page after restart
+FAST_MODE=false
+# true = shorter delays (higher block risk)
+STRICT_QUALITY=true
+# true = apply quality filters strictly
+

package/_init/props/.extractor/zoominfo/apikey.txt

@@ -0,0 +1,10 @@
+# ZoomInfo API credentials
+#
+# Paste a JWT/access token OR username + password below.
+# Environment variables (ZOOMINFO_*) override these values.
+# Optional: set API_CREDIT_LIMIT to match your account balance (0 = unlimited).
+
+API_KEY=
+USERNAME=
+PASSWORD=
+# API_CREDIT_LIMIT=500000