@iann29/rastro 0.1.0-alpha.0

package/src/component/_generated/component.ts

@@ -0,0 +1,706 @@
+/* eslint-disable */
+/**
+ * Generated `ComponentApi` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type { FunctionReference } from "convex/server";
+
+/**
+ * A utility for referencing a Convex component's exposed API.
+ *
+ * Useful when expecting a parameter like `components.myComponent`.
+ * Usage:
+ * ```ts
+ * async function myFunction(ctx: QueryCtx, component: ComponentApi) {
+ *   return ctx.runQuery(component.someFile.someQuery, { ...args });
+ * }
+ * ```
+ */
+export type ComponentApi<Name extends string | undefined = string | undefined> =
+  {
+    affiliates: {
+      list: FunctionReference<
+        "query",
+        "internal",
+        { siteId: string },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          active: boolean;
+          attributionWindowDays: number;
+          commissionBps: number;
+          createdAt: number;
+          name: string;
+          siteId: string;
+          slug: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      remove: FunctionReference<
+        "mutation",
+        "internal",
+        { affiliateId: string; siteId: string },
+        null,
+        Name
+      >;
+      upsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          active?: boolean;
+          affiliateId?: string;
+          attributionWindowDays: number;
+          commissionBps: number;
+          name: string;
+          siteId: string;
+          slug: string;
+        },
+        string,
+        Name
+      >;
+    };
+    funnels: {
+      list: FunctionReference<
+        "query",
+        "internal",
+        { siteId: string },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          active: boolean;
+          conversionWindowMs: number;
+          createdAt: number;
+          key: string;
+          name: string;
+          siteId: string;
+          steps: Array<{
+            name: string;
+            type: "pageview" | "custom";
+            value: string;
+          }>;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      remove: FunctionReference<
+        "mutation",
+        "internal",
+        { funnelId: string; siteId: string },
+        null,
+        Name
+      >;
+      upsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          active?: boolean;
+          conversionWindowMs: number;
+          funnelId?: string;
+          key: string;
+          name: string;
+          siteId: string;
+          steps: Array<{
+            name: string;
+            type: "pageview" | "custom";
+            value: string;
+          }>;
+        },
+        string,
+        Name
+      >;
+    };
+    goals: {
+      list: FunctionReference<
+        "query",
+        "internal",
+        { siteId: string },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          active: boolean;
+          createdAt: number;
+          key: string;
+          matchType: "pageview" | "custom";
+          matchValue: string;
+          name: string;
+          siteId: string;
+          updatedAt: number;
+          valueCents?: number;
+        }>,
+        Name
+      >;
+      remove: FunctionReference<
+        "mutation",
+        "internal",
+        { goalId: string; siteId: string },
+        null,
+        Name
+      >;
+      upsert: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          active?: boolean;
+          goalId?: string;
+          key: string;
+          matchType: "pageview" | "custom";
+          matchValue: string;
+          name: string;
+          siteId: string;
+          valueCents?: number;
+        },
+        string,
+        Name
+      >;
+    };
+    ingest: {
+      ingestBatch: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          context?: {
+            browser?: string;
+            city?: string;
+            country?: string;
+            device?: string;
+            latitude?: number;
+            longitude?: number;
+            os?: string;
+          };
+          events: Array<{
+            affiliateSlug?: string;
+            currency?: string;
+            eventId: string;
+            href?: string;
+            name?: string;
+            path: string;
+            properties?: Record<string, string | number | boolean | null>;
+            referrer?: string;
+            revenueCents?: number;
+            sequence: number;
+            sessionId: string;
+            target?: string;
+            timestamp: number;
+            type:
+              | "pageview"
+              | "click"
+              | "custom"
+              | "conversion"
+              | "heartbeat"
+              | "outbound";
+            visitorId: string;
+          }>;
+          origin: string;
+          siteId: string;
+        },
+        { accepted: number; duplicates: number; rejected: number },
+        Name
+      >;
+      trackConversion: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          currency: string;
+          eventId: string;
+          goalKey?: string;
+          path?: string;
+          properties?: Record<string, string | number | boolean | null>;
+          revenueCents: number;
+          sessionId: string;
+          siteId: string;
+          timestamp: number;
+          visitorId: string;
+        },
+        { accepted: number; duplicates: number; rejected: number },
+        Name
+      >;
+    };
+    reports: {
+      affiliatesReport: FunctionReference<
+        "query",
+        "internal",
+        { from: number; siteId: string; to: number },
+        {
+          affiliates: Array<{
+            _creationTime: number;
+            _id: string;
+            active: boolean;
+            attributionWindowDays: number;
+            commissionBps: number;
+            commissionCents: number;
+            conversions: number;
+            createdAt: number;
+            name: string;
+            revenueCents: number;
+            siteId: string;
+            slug: string;
+            uniqueVisitors: number;
+            updatedAt: number;
+            visits: number;
+          }>;
+          truncated: boolean;
+        },
+        Name
+      >;
+      funnelsReport: FunctionReference<
+        "query",
+        "internal",
+        { from: number; siteId: string; to: number },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          active: boolean;
+          conversionWindowMs: number;
+          createdAt: number;
+          key: string;
+          name: string;
+          siteId: string;
+          steps: Array<{
+            name: string;
+            type: "pageview" | "custom";
+            value: string;
+          }>;
+          stepsReport: Array<{
+            completions: number;
+            entrants: number;
+            name: string;
+            step: number;
+          }>;
+          truncated: boolean;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      goalsReport: FunctionReference<
+        "query",
+        "internal",
+        { from: number; siteId: string; to: number },
+        {
+          goals: Array<{
+            _creationTime: number;
+            _id: string;
+            active: boolean;
+            completions: number;
+            createdAt: number;
+            key: string;
+            matchType: "pageview" | "custom";
+            matchValue: string;
+            name: string;
+            siteId: string;
+            updatedAt: number;
+            valueCents: number;
+          }>;
+          truncated: boolean;
+        },
+        Name
+      >;
+      listConversions: FunctionReference<
+        "query",
+        "internal",
+        {
+          from: number;
+          paginationOpts: {
+            cursor: string | null;
+            endCursor?: string | null;
+            id?: number;
+            maximumBytesRead?: number;
+            maximumRowsRead?: number;
+            numItems: number;
+          };
+          siteId: string;
+          to: number;
+        },
+        {
+          continueCursor: string;
+          isDone: boolean;
+          page: Array<{
+            _creationTime: number;
+            _id: string;
+            affiliateAttributedAt?: number;
+            affiliateExpiresAt?: number;
+            affiliateId?: string;
+            affiliateSlug?: string;
+            commissionCents: number;
+            currency: string;
+            eventId: string;
+            goalKey?: string;
+            path: string;
+            revenueCents: number;
+            sessionId: string;
+            siteId: string;
+            source: "tracker" | "trusted";
+            timestamp: number;
+            visitorId: string;
+          }>;
+          pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+          splitCursor?: string | null;
+        },
+        Name
+      >;
+      listSessions: FunctionReference<
+        "query",
+        "internal",
+        {
+          from: number;
+          paginationOpts: {
+            cursor: string | null;
+            endCursor?: string | null;
+            id?: number;
+            maximumBytesRead?: number;
+            maximumRowsRead?: number;
+            numItems: number;
+          };
+          siteId: string;
+          to: number;
+        },
+        {
+          continueCursor: string;
+          isDone: boolean;
+          page: Array<{
+            _creationTime: number;
+            _id: string;
+            affiliateAttributedAt?: number;
+            affiliateExpiresAt?: number;
+            affiliateId?: string;
+            affiliateSlug?: string;
+            browser: string;
+            city?: string;
+            conversionCount: number;
+            country?: string;
+            currency?: string;
+            device: string;
+            durationMs: number;
+            entryPath: string;
+            eventCount: number;
+            exitPath: string;
+            lastSeenAt: number;
+            latitude?: number;
+            longitude?: number;
+            os: string;
+            pageviewCount: number;
+            referrer?: string;
+            revenueCents: number;
+            sessionId: string;
+            siteId: string;
+            source: string;
+            startedAt: number;
+            utmCampaign?: string;
+            utmMedium?: string;
+            utmSource?: string;
+            visitorId: string;
+          }>;
+          pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+          splitCursor?: string | null;
+        },
+        Name
+      >;
+      liveVisitors: FunctionReference<
+        "query",
+        "internal",
+        { limit?: number; now: number; siteIds: Array<string> },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          browser: string;
+          city?: string;
+          country?: string;
+          device: string;
+          eventCount: number;
+          expiresAt: number;
+          lastSeenAt: number;
+          latitude?: number;
+          longitude?: number;
+          os: string;
+          pageviewCount: number;
+          path: string;
+          sessionId: string;
+          siteId: string;
+          source: string;
+          startedAt: number;
+          visitorId: string;
+        }>,
+        Name
+      >;
+      overview: FunctionReference<
+        "query",
+        "internal",
+        {
+          from: number;
+          interval?: "hour" | "day";
+          siteIds: Array<string>;
+          to: number;
+        },
+        {
+          currency: string;
+          from: number;
+          interval: "hour" | "day";
+          timeSeries: Array<{
+            clicks: number;
+            conversions: number;
+            customEvents: number;
+            events: number;
+            outboundClicks: number;
+            pageviews: number;
+            revenueCents: number;
+            sessions: number;
+            timestamp: number;
+            visitors: number;
+          }>;
+          to: number;
+          topBrowsers: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topCountries: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topDevices: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topEvents: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topGoals: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topPages: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          topSources: Array<{
+            count: number;
+            revenueCents: number;
+            value: string;
+          }>;
+          totals: {
+            clicks: number;
+            conversions: number;
+            customEvents: number;
+            events: number;
+            outboundClicks: number;
+            pageviews: number;
+            revenueCents: number;
+            sessions: number;
+            visitors: number;
+          };
+        },
+        Name
+      >;
+      sessionJourney: FunctionReference<
+        "query",
+        "internal",
+        {
+          from: number;
+          paginationOpts: {
+            cursor: string | null;
+            endCursor?: string | null;
+            id?: number;
+            maximumBytesRead?: number;
+            maximumRowsRead?: number;
+            numItems: number;
+          };
+          sessionId: string;
+          siteId: string;
+          to: number;
+        },
+        {
+          continueCursor: string;
+          isDone: boolean;
+          page: Array<{
+            _creationTime: number;
+            _id: string;
+            affiliateSlug?: string;
+            browser: string;
+            city?: string;
+            country?: string;
+            currency?: string;
+            device: string;
+            eventId: string;
+            href?: string;
+            latitude?: number;
+            longitude?: number;
+            name?: string;
+            os: string;
+            path: string;
+            properties?: Record<string, string | number | boolean | null>;
+            referrer?: string;
+            revenueCents?: number;
+            sequence: number;
+            sessionId: string;
+            siteId: string;
+            target?: string;
+            timestamp: number;
+            type:
+              | "pageview"
+              | "click"
+              | "custom"
+              | "conversion"
+              | "heartbeat"
+              | "outbound";
+            visitorId: string;
+          }>;
+          pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+          splitCursor?: string | null;
+        },
+        Name
+      >;
+      visitorJourney: FunctionReference<
+        "query",
+        "internal",
+        {
+          from: number;
+          limit?: number;
+          siteIds: Array<string>;
+          to: number;
+          visitorId: string;
+        },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          affiliateSlug?: string;
+          browser: string;
+          city?: string;
+          country?: string;
+          currency?: string;
+          device: string;
+          eventId: string;
+          href?: string;
+          latitude?: number;
+          longitude?: number;
+          name?: string;
+          os: string;
+          path: string;
+          properties?: Record<string, string | number | boolean | null>;
+          referrer?: string;
+          revenueCents?: number;
+          sequence: number;
+          sessionId: string;
+          siteId: string;
+          target?: string;
+          timestamp: number;
+          type:
+            | "pageview"
+            | "click"
+            | "custom"
+            | "conversion"
+            | "heartbeat"
+            | "outbound";
+          visitorId: string;
+        }>,
+        Name
+      >;
+    };
+    retention: {
+      cleanup: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          batchSize?: number;
+          before: number;
+          kind:
+            | "events"
+            | "sessions"
+            | "conversions"
+            | "goalCompletions"
+            | "aggregateHour"
+            | "aggregateDay"
+            | "funnelProgress"
+            | "funnelSteps"
+            | "affiliateStats"
+            | "attributions"
+            | "liveSessions"
+            | "ingestWindows"
+            | "siteIngestWindows";
+          siteId: string;
+        },
+        { deleted: number; hasMore: boolean },
+        Name
+      >;
+    };
+    sites: {
+      create: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          cookieless?: boolean;
+          currency?: string;
+          domains: Array<string>;
+          name: string;
+          networkId?: string;
+          ownerId: string;
+          timezone?: string;
+        },
+        string,
+        Name
+      >;
+      get: FunctionReference<
+        "query",
+        "internal",
+        { siteId: string },
+        {
+          _creationTime: number;
+          _id: string;
+          cookieless: boolean;
+          createdAt: number;
+          currency?: string;
+          domains: Array<string>;
+          name: string;
+          networkId?: string;
+          ownerId: string;
+          timezone?: string;
+          updatedAt: number;
+        } | null,
+        Name
+      >;
+      listByOwner: FunctionReference<
+        "query",
+        "internal",
+        { limit?: number; ownerId: string },
+        Array<{
+          _creationTime: number;
+          _id: string;
+          cookieless: boolean;
+          createdAt: number;
+          currency?: string;
+          domains: Array<string>;
+          name: string;
+          networkId?: string;
+          ownerId: string;
+          timezone?: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      update: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          cookieless?: boolean;
+          currency?: string;
+          domains?: Array<string>;
+          name?: string;
+          networkId?: string | null;
+          siteId: string;
+          timezone?: string | null;
+        },
+        null,
+        Name
+      >;
+    };
+  };