@spacefast/common 0.0.2

package/dist/contracts/events.d.ts

@@ -0,0 +1,398 @@
+import { z } from "zod";
+export declare const eventSourceSchema: z.ZodEnum<{
+    cli: "cli";
+    dashboard: "dashboard";
+    other: "other";
+    www: "www";
+    "domain-ssh": "domain-ssh";
+    "control-plane": "control-plane";
+}>;
+export type EventSource = z.infer<typeof eventSourceSchema>;
+export declare const eventActorSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"analytics_id">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"anonymous_id">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"anonymous_machine">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"anonymous_session">;
+    namespace: z.ZodString;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"system">;
+    id: z.ZodString;
+}, z.core.$strict>], "type">;
+export type EventActor = z.infer<typeof eventActorSchema>;
+export declare const EVENT_CATALOG: {
+    "client.page_viewed": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            path: z.ZodString;
+            referrer: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strict>;
+    };
+    "client.web_vital.measured": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            metric: z.ZodEnum<{
+                CLS: "CLS";
+                FCP: "FCP";
+                INP: "INP";
+                LCP: "LCP";
+                TTFB: "TTFB";
+            }>;
+            value: z.ZodNumber;
+            path: z.ZodString;
+        }, z.core.$strict>;
+    };
+    "client.error.observed": {
+        sources: ("cli" | "dashboard" | "other" | "www")[];
+        actors: ("analytics_id" | "anonymous_id" | "anonymous_machine")[];
+        properties: z.ZodObject<{
+            error_class: z.ZodString;
+            path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strict>;
+    };
+    "cli.command.completed": {
+        sources: "cli"[];
+        actors: "anonymous_machine"[];
+        properties: z.ZodObject<{
+            command: z.ZodString;
+            version: z.ZodString;
+            error_class: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    };
+    "browser.funnel.claim_page_viewed": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    };
+    "browser.funnel.claim_token_validated": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    };
+    "browser.funnel.space_claimed": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    };
+    "browser.funnel.claim_rescue_countdown_viewed": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    };
+    "browser.funnel.claim_reminder_requested": {
+        sources: ("dashboard" | "www")[];
+        actors: ("analytics_id" | "anonymous_id")[];
+        properties: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+    };
+    "domain.search.session_started": {
+        sources: "domain-ssh"[];
+        actors: "anonymous_session"[];
+        properties: z.ZodObject<{
+            action: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                suggestions: "suggestions";
+                whois: "whois";
+                availability: "availability";
+            }>>>;
+            cols: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            reason: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                closed: "closed";
+                ended: "ended";
+                exec_rejected: "exec_rejected";
+                lookup_rate_limited: "lookup_rate_limited";
+                renderer_failed: "renderer_failed";
+                session_limit: "session_limit";
+                shutdown: "shutdown";
+                started: "started";
+            }>>>;
+            rows: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            source: z.ZodLiteral<"ssh">;
+            source_family: z.ZodEnum<{
+                unknown: "unknown";
+                ipv4: "ipv4";
+                ipv6: "ipv6";
+            }>;
+            source_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            units: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strict>;
+    };
+    "domain.search.session_ended": {
+        sources: "domain-ssh"[];
+        actors: "anonymous_session"[];
+        properties: z.ZodObject<{
+            action: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                suggestions: "suggestions";
+                whois: "whois";
+                availability: "availability";
+            }>>>;
+            cols: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            reason: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                closed: "closed";
+                ended: "ended";
+                exec_rejected: "exec_rejected";
+                lookup_rate_limited: "lookup_rate_limited";
+                renderer_failed: "renderer_failed";
+                session_limit: "session_limit";
+                shutdown: "shutdown";
+                started: "started";
+            }>>>;
+            rows: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            source: z.ZodLiteral<"ssh">;
+            source_family: z.ZodEnum<{
+                unknown: "unknown";
+                ipv4: "ipv4";
+                ipv6: "ipv6";
+            }>;
+            source_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            units: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strict>;
+    };
+    "domain.search.lookup_requested": {
+        sources: "domain-ssh"[];
+        actors: "anonymous_session"[];
+        properties: z.ZodObject<{
+            action: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                suggestions: "suggestions";
+                whois: "whois";
+                availability: "availability";
+            }>>>;
+            cols: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            duration_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            reason: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                closed: "closed";
+                ended: "ended";
+                exec_rejected: "exec_rejected";
+                lookup_rate_limited: "lookup_rate_limited";
+                renderer_failed: "renderer_failed";
+                session_limit: "session_limit";
+                shutdown: "shutdown";
+                started: "started";
+            }>>>;
+            rows: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            source: z.ZodLiteral<"ssh">;
+            source_family: z.ZodEnum<{
+                unknown: "unknown";
+                ipv4: "ipv4";
+                ipv6: "ipv6";
+            }>;
+            source_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            units: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strict>;
+    };
+    "publish.receipt.created": {
+        sources: "control-plane"[];
+        actors: ("system" | "analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            access: z.ZodString;
+            anonymous: z.ZodBoolean;
+            upload_count: z.ZodNumber;
+            reused_count: z.ZodNumber;
+            ignored_count: z.ZodNumber;
+            no_changes: z.ZodBoolean;
+        }, z.core.$strict>;
+    };
+    "version.intent.created": {
+        sources: "control-plane"[];
+        actors: ("system" | "analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            access: z.ZodString;
+            file_count: z.ZodNumber;
+            open_session: z.ZodBoolean;
+            upload_count: z.ZodNumber;
+            skipped_count: z.ZodNumber;
+            ignored_count: z.ZodNumber;
+            no_changes: z.ZodBoolean;
+            finalize_required: z.ZodBoolean;
+            source_kind: z.ZodString;
+        }, z.core.$strict>;
+    };
+    "version.finalize.queued": {
+        sources: "control-plane"[];
+        actors: ("system" | "analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            access: z.ZodString;
+            async: z.ZodBoolean;
+            operation_id: z.ZodString;
+            has_redirects: z.ZodBoolean;
+            has_headers: z.ZodBoolean;
+        }, z.core.$strict>;
+    };
+    "version.promote.queued": {
+        sources: "control-plane"[];
+        actors: ("system" | "analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            access: z.ZodString;
+            async: z.ZodBoolean;
+            operation_id: z.ZodString;
+        }, z.core.$strict>;
+    };
+    "feature.blocked": {
+        sources: "control-plane"[];
+        actors: ("system" | "analytics_id" | "anonymous_id")[];
+        properties: z.ZodObject<{
+            feature: z.ZodString;
+            plan: z.ZodNullable<z.ZodString>;
+            outcome: z.ZodLiteral<"blocked">;
+        }, z.core.$strict>;
+    };
+    "abuse.limit_tripped": {
+        sources: "control-plane"[];
+        actors: "system"[];
+        properties: z.ZodObject<{
+            kind: z.ZodEnum<{
+                rate_limit: "rate_limit";
+                quota: "quota";
+            }>;
+            code: z.ZodString;
+            key_class: z.ZodNullable<z.ZodString>;
+            limit: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>;
+    };
+};
+export declare const eventNameSchema: z.ZodEnum<{
+    "client.page_viewed": "client.page_viewed";
+    "client.web_vital.measured": "client.web_vital.measured";
+    "client.error.observed": "client.error.observed";
+    "cli.command.completed": "cli.command.completed";
+    "browser.funnel.claim_page_viewed": "browser.funnel.claim_page_viewed";
+    "browser.funnel.claim_token_validated": "browser.funnel.claim_token_validated";
+    "browser.funnel.space_claimed": "browser.funnel.space_claimed";
+    "browser.funnel.claim_rescue_countdown_viewed": "browser.funnel.claim_rescue_countdown_viewed";
+    "browser.funnel.claim_reminder_requested": "browser.funnel.claim_reminder_requested";
+    "domain.search.session_started": "domain.search.session_started";
+    "domain.search.session_ended": "domain.search.session_ended";
+    "domain.search.lookup_requested": "domain.search.lookup_requested";
+    "publish.receipt.created": "publish.receipt.created";
+    "version.intent.created": "version.intent.created";
+    "version.finalize.queued": "version.finalize.queued";
+    "version.promote.queued": "version.promote.queued";
+    "feature.blocked": "feature.blocked";
+    "abuse.limit_tripped": "abuse.limit_tripped";
+}>;
+export type EventName = z.infer<typeof eventNameSchema>;
+export declare const eventPayloadSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodEnum<{
+        "client.page_viewed": "client.page_viewed";
+        "client.web_vital.measured": "client.web_vital.measured";
+        "client.error.observed": "client.error.observed";
+        "cli.command.completed": "cli.command.completed";
+        "browser.funnel.claim_page_viewed": "browser.funnel.claim_page_viewed";
+        "browser.funnel.claim_token_validated": "browser.funnel.claim_token_validated";
+        "browser.funnel.space_claimed": "browser.funnel.space_claimed";
+        "browser.funnel.claim_rescue_countdown_viewed": "browser.funnel.claim_rescue_countdown_viewed";
+        "browser.funnel.claim_reminder_requested": "browser.funnel.claim_reminder_requested";
+        "domain.search.session_started": "domain.search.session_started";
+        "domain.search.session_ended": "domain.search.session_ended";
+        "domain.search.lookup_requested": "domain.search.lookup_requested";
+        "publish.receipt.created": "publish.receipt.created";
+        "version.intent.created": "version.intent.created";
+        "version.finalize.queued": "version.finalize.queued";
+        "version.promote.queued": "version.promote.queued";
+        "feature.blocked": "feature.blocked";
+        "abuse.limit_tripped": "abuse.limit_tripped";
+    }>;
+    actor: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"analytics_id">;
+        id: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"anonymous_id">;
+        id: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"anonymous_machine">;
+        id: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"anonymous_session">;
+        namespace: z.ZodString;
+        id: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"system">;
+        id: z.ZodString;
+    }, z.core.$strict>], "type">;
+    context: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        team_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        space_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        version_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        client: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        surface: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>>>;
+    properties: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
+    occurredAt: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type EventPayload = z.infer<typeof eventPayloadSchema>;
+export declare const EVENT_MAX_EVENTS_PER_REQUEST = 20;
+export declare const EVENT_BODY_CAP_BYTES: number;
+export declare const eventIngestSchema: z.ZodObject<{
+    source: z.ZodDefault<z.ZodEnum<{
+        cli: "cli";
+        dashboard: "dashboard";
+        other: "other";
+        www: "www";
+        "domain-ssh": "domain-ssh";
+        "control-plane": "control-plane";
+    }>>;
+    events: z.ZodArray<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        name: z.ZodEnum<{
+            "client.page_viewed": "client.page_viewed";
+            "client.web_vital.measured": "client.web_vital.measured";
+            "client.error.observed": "client.error.observed";
+            "cli.command.completed": "cli.command.completed";
+            "browser.funnel.claim_page_viewed": "browser.funnel.claim_page_viewed";
+            "browser.funnel.claim_token_validated": "browser.funnel.claim_token_validated";
+            "browser.funnel.space_claimed": "browser.funnel.space_claimed";
+            "browser.funnel.claim_rescue_countdown_viewed": "browser.funnel.claim_rescue_countdown_viewed";
+            "browser.funnel.claim_reminder_requested": "browser.funnel.claim_reminder_requested";
+            "domain.search.session_started": "domain.search.session_started";
+            "domain.search.session_ended": "domain.search.session_ended";
+            "domain.search.lookup_requested": "domain.search.lookup_requested";
+            "publish.receipt.created": "publish.receipt.created";
+            "version.intent.created": "version.intent.created";
+            "version.finalize.queued": "version.finalize.queued";
+            "version.promote.queued": "version.promote.queued";
+            "feature.blocked": "feature.blocked";
+            "abuse.limit_tripped": "abuse.limit_tripped";
+        }>;
+        actor: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"analytics_id">;
+            id: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"anonymous_id">;
+            id: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"anonymous_machine">;
+            id: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"anonymous_session">;
+            namespace: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"system">;
+            id: z.ZodString;
+        }, z.core.$strict>], "type">;
+        context: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+            team_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            space_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            version_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            client: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            surface: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strict>>>;
+        properties: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
+        occurredAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type EventIngest = z.infer<typeof eventIngestSchema>;
+export declare const eventAcceptedSchema: z.ZodObject<{
+    accepted: z.ZodNumber;
+}, z.core.$strip>;