|
| 1 | +import { ParsedFilter, type SQLOperator } from "@dub/utils"; |
| 2 | + |
| 3 | +/** |
| 4 | + * Advanced filter structure for Tinybird's filters JSON parameter. |
| 5 | + * Used for event-level dimensional filters. |
| 6 | + */ |
| 7 | +export interface AdvancedFilter { |
| 8 | + field: string; |
| 9 | + operator: SQLOperator; |
| 10 | + values: string[]; |
| 11 | +} |
| 12 | + |
| 13 | +/** |
| 14 | + * Extract the first string value from a ParsedFilter. |
| 15 | + * Useful for API routes that need a single value (e.g., domain, folderId) |
| 16 | + * for lookups, even when the filter supports multiple values. |
| 17 | + */ |
| 18 | +export function getFirstFilterValue( |
| 19 | + filter: ParsedFilter | string | undefined, |
| 20 | +): string | undefined { |
| 21 | + if (!filter) return undefined; |
| 22 | + if (typeof filter === "string") return filter; |
| 23 | + return filter.values?.[0]; |
| 24 | +} |
| 25 | + |
| 26 | +/** |
| 27 | + * Prepare trigger and region filters for Tinybird pipes. |
| 28 | + * Handles backward compatibility for qr parameter and region splitting. |
| 29 | + */ |
| 30 | +export function prepareFiltersForPipe(params: { |
| 31 | + qr?: boolean; |
| 32 | + trigger?: ParsedFilter; |
| 33 | + region?: string | ParsedFilter; |
| 34 | + country?: ParsedFilter; |
| 35 | +}) { |
| 36 | + // Handle qr backward compatibility |
| 37 | + let triggerForPipe = params.trigger; |
| 38 | + if (params.qr && !params.trigger) { |
| 39 | + triggerForPipe = { |
| 40 | + operator: "IS" as const, |
| 41 | + sqlOperator: "IN" as const, |
| 42 | + values: ["qr"], |
| 43 | + }; |
| 44 | + } |
| 45 | + |
| 46 | + // Handle region split (format: "US-CA") |
| 47 | + let countryForPipe = params.country; |
| 48 | + let regionForPipe = params.region; |
| 49 | + if (params.region && typeof params.region === "string") { |
| 50 | + const split = params.region.split("-"); |
| 51 | + countryForPipe = { |
| 52 | + operator: "IS" as const, |
| 53 | + sqlOperator: "IN" as const, |
| 54 | + values: [split[0]], |
| 55 | + }; |
| 56 | + regionForPipe = split[1]; |
| 57 | + } |
| 58 | + |
| 59 | + return { triggerForPipe, countryForPipe, regionForPipe }; |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * Extract workspace link filters (domain, tagIds, folderId, root) into |
| 64 | + * separate values and operators for Tinybird. |
| 65 | + * |
| 66 | + * These filters are applied on the workspace_links node in Tinybird, |
| 67 | + * so they need to be passed as separate parameters (not in the filters JSON). |
| 68 | + */ |
| 69 | +export function extractWorkspaceLinkFilters(params: { |
| 70 | + domain?: ParsedFilter; |
| 71 | + tagIds?: ParsedFilter; |
| 72 | + folderId?: ParsedFilter; |
| 73 | + root?: ParsedFilter; |
| 74 | +}) { |
| 75 | + const extractFilter = (filter?: ParsedFilter) => ({ |
| 76 | + values: filter?.values, |
| 77 | + operator: (filter?.sqlOperator === "NOT IN" ? "NOT IN" : "IN") as |
| 78 | + | "IN" |
| 79 | + | "NOT IN", |
| 80 | + }); |
| 81 | + |
| 82 | + const domain = extractFilter(params.domain); |
| 83 | + const tagIds = extractFilter(params.tagIds); |
| 84 | + const folderId = extractFilter(params.folderId); |
| 85 | + const root = extractFilter(params.root); |
| 86 | + |
| 87 | + return { |
| 88 | + domain: domain.values, |
| 89 | + domainOperator: domain.operator, |
| 90 | + tagIds: tagIds.values, |
| 91 | + tagIdsOperator: tagIds.operator, |
| 92 | + folderId: folderId.values, |
| 93 | + folderIdOperator: folderId.operator, |
| 94 | + root: root.values, |
| 95 | + rootOperator: root.operator, |
| 96 | + }; |
| 97 | +} |
| 98 | + |
| 99 | +/** |
| 100 | + * Build advanced filters array for Tinybird's filters JSON parameter. |
| 101 | + * Extracts event-level dimensional filters from params and formats them |
| 102 | + * for the filters JSON that gets passed to Tinybird pipes. |
| 103 | + */ |
| 104 | +const SUPPORTED_FIELDS = [ |
| 105 | + "country", |
| 106 | + "city", |
| 107 | + "continent", |
| 108 | + "device", |
| 109 | + "browser", |
| 110 | + "os", |
| 111 | + "referer", |
| 112 | + "refererUrl", |
| 113 | + "url", |
| 114 | + "trigger", |
| 115 | + "utm_source", |
| 116 | + "utm_medium", |
| 117 | + "utm_campaign", |
| 118 | + "utm_term", |
| 119 | + "utm_content", |
| 120 | + "saleType", |
| 121 | +] as const; |
| 122 | + |
| 123 | +type SupportedField = (typeof SUPPORTED_FIELDS)[number]; |
| 124 | + |
| 125 | +export function buildAdvancedFilters( |
| 126 | + params: Partial<Record<SupportedField, ParsedFilter | undefined>>, |
| 127 | +): AdvancedFilter[] { |
| 128 | + const filters: AdvancedFilter[] = []; |
| 129 | + |
| 130 | + for (const field of SUPPORTED_FIELDS) { |
| 131 | + const parsed = params[field]; |
| 132 | + if (!parsed) continue; |
| 133 | + |
| 134 | + filters.push({ |
| 135 | + field, |
| 136 | + operator: parsed.sqlOperator, |
| 137 | + values: parsed.values, |
| 138 | + }); |
| 139 | + } |
| 140 | + |
| 141 | + return filters; |
| 142 | +} |
0 commit comments