OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
import { readdirSync, readFileSync } from 'node:fs';
import { join } from 'node:path';
import { isContentSlug } from './utils';
export interface CompareSeo {
title: string;
description: string;
noindex?: boolean;
}
export interface CompareCta {
label: string;
href: string;
}
export interface CompareHero {
heading: string;
subheading: string;
badges: string[];
}
export interface CompareCompetitor {
name: string;
logo: string;
url: string;
short_description: string;
founded?: number;
headquarters?: string;
}
export interface CompareMeta {
author: string;
updated: string;
prices_checked?: string;
}
export interface CompareSummary {
title: string;
intro: string;
one_liner: string;
best_for_openpanel: string[];
best_for_competitor: string[];
}
export interface CompareHighlight {
label: string;
openpanel: string;
competitor: string;
}
export interface CompareHighlights {
title: string;
intro: string;
items: CompareHighlight[];
}
export interface CompareFeature {
name: string;
openpanel: boolean | string;
competitor: boolean | string;
notes?: string | null;
}
export interface CompareFeatureGroup {
group: string;
features: CompareFeature[];
}
export interface CompareFeatureComparison {
title: string;
intro: string;
groups: CompareFeatureGroup[];
}
export interface ComparePricing {
title: string;
intro: string;
openpanel: {
model: string;
description: string;
};
competitor: {
model: string;
description: string;
free_tier?: string;
pricing_url?: string;
};
volumes?: ComparePriceAtVolume[];
}
export interface ComparePriceAtVolume {
volume: string;
openpanel: string;
competitor: string;
}
export interface CompareStrength {
title: string;
description: string;
}
export interface CompareStrengths {
title: string;
intro: string;
items: CompareStrength[];
}
export interface CompareTrust {
data_processing: string;
data_location: string;
self_hosting: boolean;
}
export interface CompareTrustCompliance {
title: string;
intro: string;
openpanel: CompareTrust;
competitor: CompareTrust;
}
export interface CompareScreenshot {
// Name of a VisualMock (src/components/visual-mock.tsx); preferred over images.
mock?: string;
src?: string;
alt: string;
}
export interface CompareUseCase {
title: string;
description: string;
icon?: string;
screenshot?: CompareScreenshot;
}
export interface CompareUseCases {
title: string;
intro: string;
items: CompareUseCase[];
}
export interface CompareFaq {
question: string;
answer: string;
}
export interface CompareFaqs {
title: string;
intro: string;
items: CompareFaq[];
}
export interface CompareTechnicalItem {
label: string;
openpanel: string | string[];
competitor: string | string[];
notes?: string | null;
}
export interface CompareTechnicalComparison {
title: string;
intro: string;
items: CompareTechnicalItem[];
}
export interface CompareMigrationStep {
title: string;
description: string;
}
export interface CompareMigration {
title: string;
intro: string;
difficulty: string;
estimated_time: string;
steps: CompareMigrationStep[];
sdk_compatibility: {
similar_api: boolean;
notes: string;
};
historical_data: {
can_import: boolean;
notes: string;
};
}
export interface RelatedLink {
title?: string;
name?: string;
url: string;
}
export interface RelatedLinks {
guides?: RelatedLink[];
articles?: RelatedLink[];
alternatives?: RelatedLink[];
}
export interface CompareOverview {
title: string;
paragraphs: string[];
}
// Which part of OpenPanel the competitor is closest to; picks the replicas
// a page shows.
export type CompareCategory = 'product' | 'web' | 'replay' | 'attribution';
export interface CompareData {
url: string;
slug: string;
page_type: 'alternative' | 'vs';
category: CompareCategory;
seo: CompareSeo;
hero: CompareHero;
competitor: CompareCompetitor;
meta?: CompareMeta;
overview?: CompareOverview;
summary_comparison: CompareSummary;
highlights: CompareHighlights;
competitor_strengths?: CompareStrengths;
feature_comparison: CompareFeatureComparison;
technical_comparison?: CompareTechnicalComparison;
pricing: ComparePricing;
migration?: CompareMigration;
trust_and_compliance?: CompareTrustCompliance;
use_cases: CompareUseCases;
faqs: CompareFaqs;
related_links?: RelatedLinks;
ctas: {
primary: CompareCta;
secondary: CompareCta;
};
}
const contentDir = join(process.cwd(), 'content', 'compare');
export async function getCompareData(
slug: string
): Promise<CompareData | null> {
if (!isContentSlug(slug)) {
return null;
}
try {
const filePath = join(contentDir, `${slug}.json`);
const fileContents = readFileSync(filePath, 'utf8');
const data = JSON.parse(fileContents) as CompareData;
return {
...data,
url: `/compare/${slug}`,
};
} catch (error) {
console.error(`Error loading compare data for ${slug}:`, error);
return null;
}
}
export async function getAllCompareSlugs(): Promise<string[]> {
try {
const files = readdirSync(contentDir);
return files
.filter((file) => file.endsWith('.json'))
.map((file) => file.replace('.json', ''));
} catch (error) {
console.error('Error reading compare directory:', error);
return [];
}
}