@coursebuilder/analytics 1.1.0

package/dist/types.d.ts

@@ -0,0 +1,303 @@
+declare const __brand: unique symbol;
+type Brand<T, B extends string> = T & {
+    readonly [__brand]: B;
+};
+type USD = Brand<number, 'USD'>;
+type Count = Brand<number, 'Count'>;
+type Percentage = Brand<number, 'Percentage'>;
+type Minutes = Brand<number, 'Minutes'>;
+type Seconds = Brand<number, 'Seconds'>;
+type AnalyticsRange = '24h' | '7d' | '30d' | '90d' | 'all';
+interface RevenueSummary {
+    totalRevenue: USD;
+    purchaseCount: Count;
+    avgOrderValue: USD;
+}
+interface RevenueDaily {
+    date: string;
+    revenue: USD;
+    count: Count;
+}
+interface RevenueByProduct {
+    productId: string;
+    productName: string;
+    revenue: USD;
+    count: Count;
+}
+interface RevenueByCountry {
+    country: string;
+    revenue: USD;
+    count: Count;
+}
+interface RecentPurchase {
+    id: string;
+    createdAt: Date;
+    totalAmount: USD;
+    productName: string;
+    productId: string;
+    country: string | null;
+    couponId: string | null;
+    userName: string | null;
+    userEmail: string | null;
+}
+interface AttributionCount {
+    type: string;
+    count: Count;
+}
+interface ShortlinkPerformance {
+    shortlinkId: string;
+    slug: string;
+    url: string;
+    clicks: Count;
+}
+interface RevenueBySource {
+    source: string;
+    medium: string;
+    campaign: string | null;
+    revenue: USD;
+    count: Count;
+}
+interface ConversionFunnel {
+    totalSignups: Count;
+    totalPurchases: Count;
+    attributedPurchases: Count;
+    unattributedPurchases: Count;
+    conversionRate: Percentage;
+    attributionCoverage: Percentage;
+}
+interface ContentCorrelation {
+    resourceId: string;
+    purchaserCount: Count;
+}
+interface AttributionCoverage {
+    totalRevenue: USD;
+    attributedRevenue: USD;
+    unattributedRevenue: USD;
+    attributionRate: Percentage;
+    totalPurchases: Count;
+}
+interface TrafficOverview {
+    sessions: Count;
+    totalUsers: Count;
+    newUsers: Count;
+    pageviews: Count;
+    avgSessionDuration: Seconds;
+    bounceRate: Percentage;
+}
+interface TrafficDaily {
+    date: string;
+    sessions: Count;
+    users: Count;
+    pageviews: Count;
+}
+interface TopPage {
+    path: string;
+    pageviews: Count;
+    users: Count;
+    avgDuration: Seconds;
+}
+interface TrafficSource {
+    source: string;
+    medium: string;
+    sessions: Count;
+    users: Count;
+}
+interface YouTubeChannelOverview {
+    subscriberCount: Count;
+    viewCount: Count;
+    videoCount: Count;
+}
+interface YouTubeVideoPerformance {
+    videoId: string;
+    views: Count;
+    watchMinutes: Minutes;
+    avgViewDuration: Seconds;
+    subscribersGained: Count;
+    likes: Count;
+    comments: Count;
+}
+interface YouTubeDaily {
+    date: string;
+    views: Count;
+    watchMinutes: Minutes;
+}
+interface YouTubeTrafficSource {
+    source: string;
+    views: Count;
+    watchMinutes: Minutes;
+}
+interface TrafficRevenueCorrelation {
+    traffic: TrafficDaily[];
+    revenue: RevenueDaily[];
+}
+interface YouTubeRevenueCorrelation {
+    youtube: YouTubeDaily[];
+    traffic: TrafficDaily[];
+    revenue: RevenueDaily[];
+}
+interface SurveySummary {
+    totalSurveys: Count;
+    totalResponses: Count;
+    uniqueRespondents: Count;
+    avgResponsesPerSurvey: number;
+}
+interface SurveyListItem {
+    surveyId: string;
+    surveyTitle: string;
+    surveySlug: string;
+    responses: Count;
+    uniqueRespondents: Count;
+    questionCount: Count;
+}
+interface SurveyResponsesDaily {
+    date: string;
+    responses: Count;
+}
+interface SurveyQuestionBreakdown {
+    questionId: string;
+    question: string;
+    type: string | null;
+    responses: Count;
+    answerDistribution: {
+        answer: string;
+        count: Count;
+    }[];
+}
+interface SurveyConversionByQuestion {
+    questionId: string;
+    questionTitle: string | null;
+    answer: string;
+    respondents: Count;
+    purchasers: Count;
+    conversionRate: Percentage;
+    revenue: USD;
+    prePurchaseCount: Count;
+    postPurchaseCount: Count;
+}
+interface EmailCampaignKitLink {
+    url: string;
+    uniqueClicks: Count;
+    clickToDeliveryRate: Percentage;
+    clickToOpenRate: Percentage;
+    shortlinkSlug?: string | null;
+}
+interface EmailCampaignShortlink {
+    slug: string;
+    url: string;
+    kitClicks: Count;
+    clickToDeliveryRate?: Percentage;
+    clickToOpenRate?: Percentage;
+    shortlinkClicks: Count;
+    signups: Count;
+    purchases: Count;
+    revenue: USD;
+}
+interface EmailCampaignFunnel {
+    broadcastId: number;
+    subject: string;
+    sentAt: string | null;
+    recipients: Count;
+    openRate: Percentage;
+    emailsOpened?: Count;
+    clickRate: Percentage;
+    totalClicks: Count;
+    showTotalClicks?: boolean;
+    unsubscribes: Count;
+    unsubscribeRate?: Percentage;
+    progress?: Percentage;
+    openTrackingDisabled?: boolean;
+    clickTrackingDisabled?: boolean;
+    kitLinks?: EmailCampaignKitLink[];
+    shortlinks: EmailCampaignShortlink[];
+    totalSignups: Count;
+    totalPurchases: Count;
+    totalRevenue: USD;
+    clickToPurchaseRate: Percentage;
+}
+interface EmailRevenueOverview {
+    configured: boolean;
+    totalBroadcasts: Count;
+    totalRecipients: Count;
+    totalRevenue: USD;
+    campaigns: EmailCampaignFunnel[];
+}
+interface SurveyResponseRow {
+    responseId: string;
+    surveyId: string;
+    surveyTitle: string;
+    surveySlug: string;
+    questionId: string;
+    questionText: string;
+    questionType: string | null;
+    answer: string;
+    userId: string | null;
+    userEmail: string | null;
+    emailListSubscriberId: string | null;
+    createdAt: string;
+}
+interface SurveyRevenueCorrelation {
+    totalRespondents: Count;
+    respondentsWhoPurchased: Count;
+    overallConversionRate: Percentage;
+    totalRevenueFromRespondents: USD;
+    prePurchaseRespondents: Count;
+    postPurchaseRespondents: Count;
+    neverPurchasedRespondents: Count;
+    baselineConversionRate: Percentage;
+    byQuestion: SurveyConversionByQuestion[];
+}
+interface SurfaceMap {
+    summary: RevenueSummary;
+    'revenue/daily': RevenueDaily[];
+    'revenue/products': RevenueByProduct[];
+    'revenue/countries': RevenueByCountry[];
+    'purchases/recent': RecentPurchase[];
+    attribution: AttributionCount[];
+    'attribution/shortlinks': ShortlinkPerformance[];
+    'attribution/sources': RevenueBySource[];
+    'attribution/funnel': ConversionFunnel;
+    'attribution/content': ContentCorrelation[];
+    'attribution/coverage': AttributionCoverage;
+    traffic: TrafficOverview;
+    'traffic/daily': TrafficDaily[];
+    'traffic/pages': TopPage[];
+    'traffic/sources': TrafficSource[];
+    youtube: YouTubeChannelOverview;
+    'youtube/videos': YouTubeVideoPerformance[];
+    'youtube/daily': YouTubeDaily[];
+    'youtube/sources': YouTubeTrafficSource[];
+    'correlation/traffic-revenue': TrafficRevenueCorrelation;
+    'correlation/youtube-revenue': YouTubeRevenueCorrelation;
+    surveys: SurveySummary;
+    'surveys/list': SurveyListItem[];
+    'surveys/daily': SurveyResponsesDaily[];
+    'surveys/questions': SurveyQuestionBreakdown[];
+    'surveys/responses': SurveyResponseRow[];
+    'correlation/survey-revenue': SurveyRevenueCorrelation;
+    'attribution/email-campaigns': EmailRevenueOverview;
+}
+type SurfaceName = keyof SurfaceMap;
+interface QueryOptions {
+    range?: AnalyticsRange;
+    limit?: number;
+}
+type QueryResult<S extends SurfaceName> = {
+    ok: true;
+    surface: S;
+    range: AnalyticsRange;
+    data: SurfaceMap[S];
+    meta: {
+        queryTimeMs: number;
+        truncated: boolean;
+    };
+} | {
+    ok: false;
+    surface: S;
+    error: {
+        message: string;
+        code: string;
+    };
+    fix: string;
+};
+
+export type { AnalyticsRange, AttributionCount, AttributionCoverage, ContentCorrelation, ConversionFunnel, Count, EmailCampaignFunnel, EmailCampaignKitLink, EmailCampaignShortlink, EmailRevenueOverview, Minutes, Percentage, QueryOptions, QueryResult, RecentPurchase, RevenueByCountry, RevenueByProduct, RevenueBySource, RevenueDaily, RevenueSummary, Seconds, ShortlinkPerformance, SurfaceMap, SurfaceName, SurveyConversionByQuestion, SurveyListItem, SurveyQuestionBreakdown, SurveyResponseRow, SurveyResponsesDaily, SurveyRevenueCorrelation, SurveySummary, TopPage, TrafficDaily, TrafficOverview, TrafficRevenueCorrelation, TrafficSource, USD, YouTubeChannelOverview, YouTubeDaily, YouTubeRevenueCorrelation, YouTubeTrafficSource, YouTubeVideoPerformance };

package/dist/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@coursebuilder/analytics",
+  "version": "1.1.0",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "default": "./dist/types.js"
+    },
+    "./engine": {
+      "types": "./dist/engine.d.ts",
+      "import": "./dist/engine.js",
+      "default": "./dist/engine.js"
+    },
+    "./catalog": {
+      "types": "./dist/catalog.d.ts",
+      "import": "./dist/catalog.js",
+      "default": "./dist/catalog.js"
+    },
+    "./providers": {
+      "types": "./dist/providers/index.d.ts",
+      "import": "./dist/providers/index.js",
+      "default": "./dist/providers/index.js"
+    },
+    "./providers/database": {
+      "types": "./dist/providers/database.d.ts",
+      "import": "./dist/providers/database.js",
+      "default": "./dist/providers/database.js"
+    },
+    "./providers/ga4": {
+      "types": "./dist/providers/ga4.d.ts",
+      "import": "./dist/providers/ga4.js",
+      "default": "./dist/providers/ga4.js"
+    },
+    "./providers/derived": {
+      "types": "./dist/providers/derived.d.ts",
+      "import": "./dist/providers/derived.js",
+      "default": "./dist/providers/derived.js"
+    },
+    "./providers/mux": {
+      "types": "./dist/providers/mux.d.ts",
+      "import": "./dist/providers/mux.js",
+      "default": "./dist/providers/mux.js"
+    },
+    "./providers/survey": {
+      "types": "./dist/providers/survey.d.ts",
+      "import": "./dist/providers/survey.js",
+      "default": "./dist/providers/survey.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js",
+      "default": "./dist/components/index.js"
+    },
+    "./api": {
+      "types": "./dist/api/index.d.ts",
+      "import": "./dist/api/index.js",
+      "default": "./dist/api/index.js"
+    }
+  },
+  "dependencies": {
+    "@google-analytics/data": "^4.0.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.7",
+    "drizzle-orm": "^0.30.0",
+    "lucide-react": "^0.344.0",
+    "next": "16.0.10",
+    "nuqs": "^2.0.0",
+    "react": "19.2.3",
+    "recharts": "^2.12.0",
+    "tsup": "8.0.2",
+    "typescript": "5.4.5",
+    "@coursebuilder/ui": "2.0.10"
+  },
+  "peerDependencies": {
+    "@coursebuilder/ui": "*",
+    "drizzle-orm": "*",
+    "lucide-react": "*",
+    "next": "*",
+    "nuqs": "*",
+    "react": ">=18",
+    "recharts": "*"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}