@privacyscrubber/sdk 2.4.7 → 2.4.8

package/index.js

@@ -41,7 +41,7 @@ export const SDK_VERSION = (() => {
             return pkgJson.version;
         }
     } catch (_) {}
-    return '2.4.7';
+    return '2.4.8';
 })();
 
 /**
@@ -134,7 +134,7 @@ export function validateLicenseKey(key) {
  * @param {Record<string, string>|string[]} currentTokenMap 
  * @returns {object}
  */
-export function buildAuditTelemetry(currentTokenMap = {}) {
+export function buildAuditTelemetry(currentTokenMap = {}, extraStats = {}) {
     const entities = {};
     let totalCount = 0;
 
@@ -244,12 +244,31 @@ export function buildAuditTelemetry(currentTokenMap = {}) {
         }
     ];
 
+    const rawLicenseTier = String(extraStats?.licenseTier || '').trim().toUpperCase();
+    const isOrganizationalScope = ['TEAMS', 'SDK', 'OEM', 'ENTERPRISE', 'ENTERPRISE_AIRGAP'].includes(rawLicenseTier);
+    const auditScope = isOrganizationalScope ? {
+        tier: rawLicenseTier,
+        isOrganizational: true,
+        badge: 'ORGANIZATIONAL MULTI-SEAT COMPLIANCE SCOPE',
+        coverage: 'Covers department, clinic, or firm personnel under unified ZTDS policy governance.',
+        upgradeRecommended: false,
+        upgradeUrl: null
+    } : {
+        tier: rawLicenseTier || 'SINGLE_OPERATOR',
+        isOrganizational: false,
+        badge: 'SINGLE-OPERATOR PERSONAL SCOPE',
+        coverage: 'Valid for individual workstation only. Multi-employee clinics, CPA firms, and departments require TEAMS ($99/mo flat, unlimited seats) for organizational audit coverage.',
+        upgradeRecommended: true,
+        upgradeUrl: 'https://privacyscrubber.com/pricing/?tier=teams&utm_source=audit_receipt&utm_medium=scope_upsell'
+    };
+
     return {
         totalCount,
         entities,
         types,
         riskLevel,
         frameworksList: Array.from(frameworksSet),
+        auditScope,
         statutoryCitations,
         ipHoldings,
         agenticProtocol,
@@ -303,6 +322,19 @@ export function _resetCommunityNoticeForTesting() {
     communityNoticeLogged = false;
 }
 
+export const FREE_PROD_SPECIALIZED_CALL_LIMIT = 250;
+let _freeProdSpecializedCalls = 0;
+let _prodProfileFallbackNoticeLogged = false;
+
+/**
+ * Resets the production specialized call quota state for testing purposes.
+ * @private
+ */
+export function _resetProdQuotaForTesting() {
+    _freeProdSpecializedCalls = 0;
+    _prodProfileFallbackNoticeLogged = false;
+}
+
 let devSecretNoticeLogged = false;
 
 function emitDevSecretNoticeIfNeeded(isPro, tokenMap = {}, limit = 15000) {
@@ -483,6 +515,82 @@ We request approval to acquire a **Developer SDK License** (\$299/month flat or
  *   auditReceipt: string
  * }}
  */
+const SDK_VERTICAL_DETECTORS = [
+    { profile: 'medical', label: 'Medical PHI (HIPAA)', regex: /\b(?:Patient\s*(?:Name|ID|DOB|Record)|MRN\b|Medical\s+Record|Attending\s+Physician|Chief\s+Complaint|Diagnosis\s*:|ICD-10|HIPAA|Clinical\s+Intake|Discharge\s+Summary|MedPod|NPI\s*(?:#|No|:)?\s*\d{10}|Medicare\s*(?:ID|Beneficiary|Claim)|Medicaid\s*ID|Prescription|Rx\s*#|Blood\s+Type|Vital\s+Signs|Radiology|Lab\s+Results|EHR\b|EMR\b)\b/gi },
+    { profile: 'accounting', label: 'Tax & Accounting', regex: /\b(?:Form\s*1040|Form\s*W-2|Form\s*1099|Adjusted\s+Gross\s+Income|Employer\s+Identification\s+Number|Schedule\s+C\b|Steuer-ID|USt-IdNr|Tax\s+Return|General\s+Ledger|Withholding\s+Allowance|Total\s+Tax\s+Liability)\b/gi },
+    { profile: 'wealthmgmt', label: 'Wealth Management', regex: /\b(?:Revocable\s+Living\s+Trust|Irrevocable\s+(?:Generation-Skipping\s+)?Trust|Grantor\s*:|Settlor\s*:|Trustee\s*:|Beneficiary\s+Designation|Roth\s+IRA|Asset\s+Allocation|FBO\b|CUSIP\s*:|Grantor\s+Retained\s+Annuity\s+Trust|AUM\s*:)\b/gi },
+    { profile: 'legal', label: 'Legal & Contracts', regex: /\b(?:Non-Disclosure\s+Agreement|Attorney-Client\s+Privilege|Docket\s+No|Hereinafter\s+referred|Indemnification\s+Clause|Governing\s+Law\s+and\s+Jurisdiction|Plaintiff\b|Defendant\b|Subpoena\b|Deposition\b|State\s+Bar\s*#)\b/gi },
+    { profile: 'finance', label: 'Finance & Banking', regex: /\b(?:Wire\s+Transfer\s+Authorization|SWIFT\s*\/?\s*BIC\s*:|IBAN\s*:\s*[A-Z]{2}\d{2}|ABA\s+Routing|ACH\s+Transfer|PCI-DSS|Primary\s+Account\s+Number)\b/gi },
+    { profile: 'hr', label: 'HR & Resumes', regex: /\b(?:Employee\s*ID|Performance\s+Improvement\s+Plan|Payroll\s+Register|Gross\s+Pay\b|Net\s+Pay\b|Candidate\s+Evaluation|Compensation\s+Band|Sozialversicherungsnummer|Personalnummer|EEID\s*:)\b/gi },
+    { profile: 'realestate', label: 'Real Estate', regex: /\b(?:Assessor\s+Parcel\s+Number|APN\s*:|MLS\s*#|Closing\s+Disclosure|Escrow\s+(?:Account|Number|Officer)|Property\s+Deed|Title\s+Insurance|Lease\s+Application)\b/gi },
+    { profile: 'dev', label: 'API & Dev Logs', regex: /\b(?:BEGIN\s+(?:RSA|OPENSSH|EC|PRIVATE)\s+PRIVATE\s+KEY|AWS_SECRET_ACCESS_KEY|DATABASE_URL\s*=|GITHUB_TOKEN\s*=|Bearer\s+eyJ[A-Za-z0-9_-]+)\b/g },
+    { profile: 'sales', label: 'Sales & CRM', regex: /\b(?:CRM\s+(?:Opportunity|Export)|HubSpot\b|Salesforce\b|MEDDPICC\b|Primary\s+Buyer\s*:|MSA\s+Redlines|Deal\s+Stage|Pipeline\s+Forecast|Opportunity\s+ID|Account\s+Executive)\b/gi },
+    { profile: 'engineering', label: 'DevOps & Infra', regex: /\b(?:Incident\s+Postmortem|Kubeconfig|Kubernetes\s+Cluster|Helm\s+Chart|Terraform\s+State|DMAIC\b|Bill\s+of\s+Materials|BOM\s+Spec|CNC\s+Machining|Shop\s+Floor\s+Batch)\b/gi },
+    { profile: 'insurance', label: 'Insurance & Claims', regex: /\b(?:Claim\s+Settlement|Policyholder\s*:|Policy\s*#?POL-|Claim\s+Number|Adjuster\s*:|Loss\s+Location|Loss\s+Run|Subrogation\b|FNOL\b|Deductible\s*:)\b/gi },
+    { profile: 'pharma', label: 'Pharma & Trials', regex: /\b(?:Clinical\s+Trial(?:\s+Protocol)?|NCT\d{8}\b|IRB\s+Protocol|FDA\s+1572|Adverse\s+Event|Pharmacovigilance|Principal\s+Investigator|Cohort\s+[A-Z]\b|Blinded\s+Study|CDISC\b|IND\s*(?:#|Protocol))\b/gi },
+    { profile: 'underwriting', label: 'Loan Underwriting & Income', regex: /\b(?:Loan\s+Underwriting|Mortgage\s+Appraisal|Loan\s+Application\s+#?LOS|FICO\s*:\s*\d{3}|Appraised\s+Value\s*:|80%\s+LTV|Monthly\s+Qualifying\s*:|YTD\s+Earnings|Borrower\s*:)\b/gi },
+    { profile: 'security', label: 'Security & SIEM', regex: /\b(?:SIEM\s+Alert|CVE-\d{4}-\d{4,7}\b|Threat\s*:\s*CRITICAL|Unauthorized\s+S3\s+bucket|SOC\s+Incident|Firewall\s+Rule\s+Violation|Intrusion\s+Detection)\b/gi },
+    { profile: 'support', label: 'Support & Tickets', regex: /\b(?:Support\s+Ticket|Ticket\s*#INC-|Zendesk\b|Intercom\b|Billing\s+Discrepancy|SLA\s+Escalation|CSAT\s+Score|Customer\s+Support\s+Escalation)\b/gi },
+    { profile: 'compliance', label: 'Compliance Audit', regex: /\b(?:Suspicious\s+Activity\s+Report|FinCEN\s+SAR|BSA\s+Officer|31\s+CFR\b|ROPA\s+Register|Data\s+Protection\s+Impact\s+Assessment|SOC\s*2\s+Type\s+II|ISO\s*27001\s+Audit|CMMC\s+Level|ITAR\s+Controlled)\b/gi },
+    { profile: 'ccpa', label: 'CCPA / CPRA Privacy', regex: /\b(?:CCPA\s*\/?\s*CPRA|1798\.105|Right\s+to\s+Delete|Opt-out\s+of\s+Sale|Ticket\s*#?DSAR-)\b/gi },
+    { profile: 'bizops', label: 'Biz Ops & M&A', regex: /\b(?:Vendor\s+Master\s+Agreement|Bill\s+of\s+Lading|Customs\s+Declaration|Purchase\s+Order\s*#?PO-|Supply\s+Chain\s+Manifest)\b/gi },
+    { profile: 'biotech', label: 'Biotech & Genomics', regex: /\b(?:Sequencing\s+Platform|Illumina\s+NovaSeq|Flowcell\s*:|FastQ\s+Sample|ClinVar\b|HGVS\s+Variant|Genomic\s+Sequencing|Bioinformatics\s+Intake|BRCA[12]\s+c\.)\b/gi },
+    { profile: 'automotive', label: 'Automotive & EV', regex: /\b(?:Connected\s+Vehicle\s+Telematics|ECU\s+Serial|Telematics\s+Device|ASIL-D\b|DTC\s+P\d{4}\b|CAN-Bus\s+Log)\b/gi },
+    { profile: 'energy', label: 'Energy & Smart Grid', regex: /\b(?:Critical\s+Infrastructure\s+SCADA|Substation\s+ID|Feeder\s+ID|Smart\s+Meter\s*:|ESI\s+ID\s*:|NERC\s+CIP|BES\s+Cyber\s+Asset)\b/gi },
+    { profile: 'hospitality', label: 'Hospitality & Travel', regex: /\b(?:Airline\s+Passenger\s+Dossier|PNR\s*:\s*[A-Z0-9]{6}|e-Ticket\s*:|Boarding\s+Pass\s*:|Known\s+Traveler\s+KTN|Guest\s+Folio|Marriott\s+Bonvoy|SkyMiles)\b/gi },
+    { profile: 'telecom', label: 'Telecom & Call Center', regex: /\b(?:Telecom\s+Subscriber\s+CDR|MSISDN\s*:|IMSI\s*:\s*\d{14,15}|IMEI\s*:\s*\d{14,16}|Cell\s+Tower\s+ID|SIP\s+Signaling)\b/gi },
+    { profile: 'academic', label: 'Academic & Research', regex: /\b(?:FERPA\s+Student\s+Record|Student\s+ID\s*:\s*#?STU-|Disciplinary\s+Record|IEP\s+Evaluation|IRB\s+Approval)\b/gi },
+    { profile: 'agents', label: 'AI Agents & Prompts', regex: /\b(?:Autonomous\s+Financial\s+Procurement\s+Agent|AgentID\s*:\s*agt_|Encrypted\s+Tool\s+Token|Agent\s+Memory\s*>)\b/gi }
+];
+
+/**
+ * Automatically detects the most relevant industry compliance profile from text content.
+ * Executes in <0.05ms in local RAM with zero network egress.
+ *
+ * @param {string} text - Input document or prompt text.
+ * @returns {{
+ *   detectedProfile: string,
+ *   label: string,
+ *   confidence: 'high'|'medium'|'low',
+ *   score: number,
+ *   alternatives: Array<{ profile: string, label: string, score: number }>
+ * }}
+ */
+export function detectProfile(text) {
+    if (!text || typeof text !== 'string') {
+        return { detectedProfile: 'general', label: 'General PII', confidence: 'low', score: 0, alternatives: [] };
+    }
+    const sampleSlice = text.length > 16384 ? text.slice(0, 16384) : text;
+    const matches = [];
+    for (let i = 0; i < SDK_VERTICAL_DETECTORS.length; i++) {
+        const c = SDK_VERTICAL_DETECTORS[i];
+        c.regex.lastIndex = 0;
+        const found = sampleSlice.match(c.regex);
+        if (found && found.length > 0) {
+            matches.push({
+                profile: c.profile,
+                label: c.label,
+                score: found.length,
+                priority: i
+            });
+        }
+    }
+    if (matches.length === 0) {
+        return { detectedProfile: 'general', label: 'General PII', confidence: 'low', score: 0, alternatives: [] };
+    }
+    matches.sort((a, b) => (b.score !== a.score) ? (b.score - a.score) : (a.priority - b.priority));
+    const primary = matches[0];
+    const alternatives = matches.slice(1, 4).map(({ profile, label, score }) => ({ profile, label, score }));
+    const confidence = primary.score >= 3 ? 'high' : (primary.score >= 2 ? 'medium' : 'low');
+    return {
+        detectedProfile: primary.profile,
+        label: primary.label,
+        confidence,
+        score: primary.score,
+        alternatives
+    };
+}
+
 export function sanitize(text, options = {}) {
     if (!text || typeof text !== 'string') {
         return {
@@ -501,7 +609,7 @@ export function sanitize(text, options = {}) {
     }
 
     const {
-        profile = 'General',
+        profile: rawProfileOption = 'General',
         licenseKey = (typeof process !== 'undefined' && (process.env?.PRIVACYSCRUBBER_KEY || process.env?.PRIVACYSCRUBBER_LICENSE_KEY)) || '',
         customRules = [],
         tokenLabelMap = {},
@@ -513,6 +621,12 @@ export function sanitize(text, options = {}) {
         ignoreList = null
     } = options;
 
+    const isAutoProfile = Boolean(
+        (typeof rawProfileOption === 'string' && rawProfileOption.trim().toLowerCase() === 'auto') ||
+        options.autoDetectProfile === true
+    );
+    const autoDetected = isAutoProfile ? detectProfile(text) : null;
+
     const licenseCheck = validateLicense(licenseKey);
     const rawTier = licenseCheck.valid ? (licenseCheck.tier || 'PRO') : 'FREE';
     const isExpiredKey = !licenseCheck.valid && typeof licenseCheck.error === 'string' && /expired/i.test(licenseCheck.error);
@@ -534,6 +648,21 @@ export function sanitize(text, options = {}) {
     const isSdkTier = licenseCheck.valid && ['SDK', 'OEM', 'ENTERPRISE'].includes(rawTier);
     const isSeatTier = licenseCheck.valid && ['PRO', 'TEAMS'].includes(rawTier);
 
+    const isPro = isSdkTier;
+    const tier = isPro ? rawTier : (isSeatTier ? rawTier : 'FREE');
+
+    let autoSuggestedOnly = false;
+    let profile = rawProfileOption;
+    if (isAutoProfile && autoDetected) {
+        if (!isPro && text.length > 5000 && text.length <= 15000 && autoDetected.detectedProfile !== 'general') {
+            // Non-blocking PLG fallback: keep General for Free 5k-15k texts so auto-mode never breaks free calls
+            profile = 'General';
+            autoSuggestedOnly = true;
+        } else {
+            profile = autoDetected.detectedProfile;
+        }
+    }
+
     if (isSeatTier) {
         const keyPreview = licenseKey ? `${licenseKey.slice(0, 12)}...` : '';
         const errorMsg = `[PrivacyScrubber] License tier mismatch: ${rawTier} license (${keyPreview}) is licensed strictly for human seats (Web App & Chrome Extension). Backend automation, microservices, and CRM pipelines require a Developer SDK license ($299/mo). Upgrade: https://privacyscrubber.com/pricing?tier=sdk&src=seat_tier_mismatch`;
@@ -547,9 +676,6 @@ export function sanitize(text, options = {}) {
         }
     }
 
-    const isPro = isSdkTier;
-    const tier = isPro ? rawTier : (isSeatTier ? rawTier : 'FREE');
-
     emitCommunityNoticeIfNeeded(isPro);
 
     const isSpecialized = profile && profile.toLowerCase() !== 'general';
@@ -583,8 +709,33 @@ export function sanitize(text, options = {}) {
     });
 
     // Auto-inject DevOps Secrets rules when in Dev profile or when detectSecrets is requested
-    const activeRules = [...safeCustomRules];
-    if (profile.toLowerCase() === 'dev' || detectSecrets === true) {
+    const isProdEnv = typeof process !== 'undefined' && process.env?.NODE_ENV === 'production';
+    const hasCustomEnterpriseConfig = isSpecialized || safeCustomRules.length > 0 || (Array.isArray(ignoreList) && ignoreList.length > 0);
+    let profileFallback = false;
+    let effectiveProfile = profile;
+    let effectiveCustomRules = safeCustomRules;
+    let effectiveIgnoreList = ignoreList;
+
+    if (!isPro && isProdEnv && hasCustomEnterpriseConfig) {
+        _freeProdSpecializedCalls++;
+        if (_freeProdSpecializedCalls > FREE_PROD_SPECIALIZED_CALL_LIMIT) {
+            profileFallback = true;
+            effectiveProfile = 'General';
+            effectiveCustomRules = [];
+            effectiveIgnoreList = null;
+            if (!_prodProfileFallbackNoticeLogged && typeof process !== 'undefined' && process.stderr && typeof process.stderr.write === 'function') {
+                _prodProfileFallbackNoticeLogged = true;
+                process.stderr.write(
+                    `\n[@privacyscrubber/sdk] Free Production Quota (${FREE_PROD_SPECIALIZED_CALL_LIMIT} specialized calls) reached for profile '${profile}'.\n` +
+                    `[@privacyscrubber/sdk] Gracefully falling back to 'General' profile (Core PII remains protected, 0 downtime).\n` +
+                    `[@privacyscrubber/sdk] Unlock unlimited specialized profiles, custom rules & ignoreLists in production ($299/mo): https://privacyscrubber.com/pricing?tier=sdk&src=prod_profile_fallback (7-Day Trial: npx @privacyscrubber/sdk trial)\n\n`
+                );
+            }
+        }
+    }
+
+    const activeRules = [...effectiveCustomRules];
+    if (effectiveProfile.toLowerCase() === 'dev' || detectSecrets === true) {
         DEVOPS_SECRETS_DETECTOR.forEach(rule => {
             activeRules.push({
                 name: rule.name,
@@ -605,10 +756,10 @@ export function sanitize(text, options = {}) {
         textToScrub,
         activeRules,
         tokenLabelMap,
-        profile,
+        effectiveProfile,
         existingSessionMap,
         isPro,
-        ignoreList
+        effectiveIgnoreList
     );
 
     const endTime = (typeof performance !== 'undefined' && typeof performance.now === 'function') 
@@ -616,7 +767,7 @@ export function sanitize(text, options = {}) {
         : Date.now();
 
     const executionMs = Math.round((endTime - startTime) * 100) / 100;
-    const telemetry = buildAuditTelemetry(rawResult.tokenMap || {});
+    const telemetry = buildAuditTelemetry(rawResult.tokenMap || {}, { licenseTier: tier });
     const auditReceipt = generateReceipt ? formatAuditReceipt(telemetry) : '';
 
     emitDevSecretNoticeIfNeeded(isPro, rawResult.tokenMap, limit);
@@ -644,6 +795,10 @@ export function sanitize(text, options = {}) {
             limit: limit,
             wasTruncated: wasTruncated,
             truncated: wasTruncated,
+            profileFallback: profileFallback,
+            effectiveProfile: effectiveProfile,
+            specializedCallsUsed: _freeProdSpecializedCalls,
+            specializedCallsLimit: isPro ? Infinity : FREE_PROD_SPECIALIZED_CALL_LIMIT,
             ...(isSeatTier && {
                 upgradeUrl: `https://privacyscrubber.com/pricing?tier=sdk&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=seat_tier_mismatch`,
                 trialUrl: `https://privacyscrubber.com/pricing?tier=sdk&trial=true&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=seat_tier_mismatch`,
@@ -651,12 +806,20 @@ export function sanitize(text, options = {}) {
                 recommendation: `Your ${rawTier} license is valid for interactive browser seats only. Upgrade to Developer SDK ($299/mo) for unlimited backend server throughput: https://privacyscrubber.com/pricing?tier=sdk`
             }),
             ...(!isPro && !isSeatTier && {
-                upgradeUrl: `https://privacyscrubber.com/pricing?tier=sdk&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=dev_upsell`,
-                trialUrl: `https://privacyscrubber.com/pricing?tier=sdk&trial=true&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=dev_upsell`,
+                upgradeUrl: `https://privacyscrubber.com/pricing?tier=sdk&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=${profileFallback ? 'prod_profile_fallback' : 'dev_upsell'}`,
+                trialUrl: `https://privacyscrubber.com/pricing?tier=sdk&trial=true&profile=${encodeURIComponent(String(profile || 'General').toLowerCase())}&src=${profileFallback ? 'prod_profile_fallback' : 'dev_upsell'}`,
                 trialCommand: 'npx @privacyscrubber/sdk trial',
                 recommendation: 'Upgrade to Developer SDK ($299/mo) for unlimited backend text processing, custom regex rules, and specialized compliance profiles.'
             })
         },
+        profileDetection: {
+            autoDetected: isAutoProfile,
+            detectedProfile: autoDetected ? autoDetected.detectedProfile : String(effectiveProfile || 'General').toLowerCase(),
+            label: autoDetected ? autoDetected.label : effectiveProfile,
+            confidence: autoDetected ? autoDetected.confidence : 'high',
+            suggestedOnly: autoSuggestedOnly,
+            alternatives: autoDetected ? autoDetected.alternatives : []
+        },
         telemetry: telemetry,
         auditReceipt: auditReceipt
     };
@@ -3888,6 +4051,7 @@ import {
 
 export default {
     SDK_VERSION,
+    detectProfile,
     sanitize,
     sanitizeObject,
     scrub,
@@ -3940,6 +4104,8 @@ export default {
     scrubText,
     unscrubText,
     DEVOPS_SECRETS_DETECTOR,
+    FREE_PROD_SPECIALIZED_CALL_LIMIT,
+    _resetProdQuotaForTesting,
     stripExifMetadata,
     redactImageBoundingBoxes,
     generateSvgRedactionOverlay

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@privacyscrubber/sdk",
-  "version": "2.4.7",
+  "version": "2.4.8",
   "description": "In-process consumer privacy defense and pre-emptive PII interception SDK for Node.js, Next.js, and AI pipelines. Zero data loss, zero third parties, sub-millisecond in-memory execution.",
   "main": "index.cjs",
   "module": "index.js",