luchy 0.0.1 → 0.2.0

package/dist/api/schema.d.ts

@@ -0,0 +1,457 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/ingest/pageview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["PageviewInput"];
+                };
+            };
+            responses: {
+                /** @description Pageview tracked successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["SuccessResponse"];
+                    };
+                };
+                /** @description Invalid request body or validation error */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ServerErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ingest/event": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["EventInput"];
+                };
+            };
+            responses: {
+                /** @description Event tracked successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["SuccessResponse"];
+                    };
+                };
+                /** @description Invalid request body or validation error */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ServerErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/query": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["QueryRequest"];
+                };
+            };
+            responses: {
+                /** @description Query executed successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["QueryResponse"];
+                    };
+                };
+                /** @description Invalid request body or validation error */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ServerErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Health check endpoint */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["HealthResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description Successful tracking response */
+        SuccessResponse: {
+            /**
+             * @description Indicates if the operation was successful
+             * @example true
+             */
+            success: boolean;
+            /**
+             * @description Unique session identifier
+             * @example session_1703123456789_abc123def
+             */
+            sessionId: string;
+            /**
+             * @description Unique pageview identifier (for pageview tracking)
+             * @example pageview_1703123456789_xyz789
+             */
+            pageviewId?: string;
+            /**
+             * @description Unique event identifier (for event tracking)
+             * @example event_1703123456789_def456
+             */
+            eventId?: string;
+        };
+        /** @description Validation error response */
+        ValidationErrorResponse: {
+            /**
+             * @description Error message
+             * @example Invalid request body
+             */
+            error: string;
+            /**
+             * @description Validation error details
+             * @example Required field "pathname" is missing
+             */
+            details: string;
+        };
+        /** @description Server error response */
+        ServerErrorResponse: {
+            /**
+             * @description Error message
+             * @example Internal server error
+             */
+            error: string;
+            /**
+             * @description Server error details
+             * @example Database connection failed
+             */
+            details: string;
+        };
+        /** @description Pageview tracking data */
+        PageviewInput: {
+            /**
+             * @description The pathname of the page being viewed
+             * @example /dashboard
+             */
+            pathname: string;
+            /**
+             * @description The referrer URL
+             * @example https://google.com
+             */
+            referrer?: string;
+            /**
+             * @description The user agent string
+             * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
+             */
+            userAgent?: string;
+            /**
+             * @description The user language preference
+             * @example en-US
+             */
+            language?: string;
+            /**
+             * @description The user country code
+             * @example US
+             */
+            country?: string;
+        };
+        /** @description Event tracking data */
+        EventInput: {
+            /**
+             * @description The event name
+             * @example button_click
+             */
+            name: string;
+            /**
+             * @description The event type/category (optional)
+             * @example interaction
+             */
+            type?: string;
+            /**
+             * @description The pathname where the event occurred
+             * @example /dashboard
+             */
+            pathname: string;
+            /**
+             * @description Event payload data
+             * @example {
+             *       "button_id": "cta-button",
+             *       "section": "hero"
+             *     }
+             */
+            payload?: {
+                [key: string]: string | number | boolean;
+            };
+            /**
+             * @deprecated
+             * @description DEPRECATED — legacy alias for `payload`. Use `payload`.
+             * @example {
+             *       "button_id": "cta-button"
+             *     }
+             */
+            props?: {
+                [key: string]: string | number | boolean;
+            };
+            /**
+             * @description The user agent string
+             * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
+             */
+            userAgent?: string;
+            /**
+             * @description The user language preference
+             * @example en-US
+             */
+            language?: string;
+            /**
+             * @description The user country code
+             * @example US
+             */
+            country?: string;
+        };
+        /**
+         * Analytics Query Request
+         * @description Query parameters for analytics data
+         */
+        QueryRequest: {
+            /** @description Time range for the query */
+            date_range: string | {
+                /**
+                 * @description Start date (ISO 8601)
+                 * @example 2025-01-01
+                 */
+                from: string;
+                /**
+                 * @description End date (ISO 8601)
+                 * @example 2025-01-31
+                 */
+                to: string;
+            };
+            /** @description Timezone (e.g., America/Santo_Domingo) */
+            tz?: string;
+            /**
+             * @description Metrics to calculate
+             * @example [
+             *       "pageviews",
+             *       "visitors"
+             *     ]
+             */
+            metrics: ("pageviews" | "visitors" | "sessions" | "visit:bounce_rate" | "visit:avg_duration" | "events")[];
+            /**
+             * @description Dimensions to group by
+             * @example [
+             *       "event:page"
+             *     ]
+             */
+            dimensions?: ("event:page" | "visit:country_name" | "visit:source" | "visit:referrer" | "visit:device" | "visit:browser" | "event:name")[];
+            /**
+             * @description Filters to apply
+             * @example []
+             */
+            filters?: (("equals" | "not_equals" | "contains" | "starts_with" | "in" | "not_in" | "between" | "is_not") | string | (string | number | string[] | number[] | string[]))[][] | (("equals" | "not_equals" | "contains" | "starts_with" | "in" | "not_in" | "between" | "is_not") | string | (string | number | string[] | number[] | string[]))[][];
+            /**
+             * @description Ordering criteria
+             * @example []
+             */
+            order_by?: (string | ("asc" | "desc"))[][] | (string | ("asc" | "desc"))[][];
+            /** @description Pagination options */
+            pagination?: {
+                /**
+                 * @default 100
+                 * @example 50
+                 */
+                limit: number;
+                /**
+                 * @default 0
+                 * @example 0
+                 */
+                offset: number;
+            };
+            /** @description Additional data to include in response */
+            include?: {
+                /** @default false */
+                time_labels: boolean;
+                /** @default false */
+                total_rows: boolean;
+                /**
+                 * @default daily
+                 * @enum {string}
+                 */
+                granularity: "hourly" | "daily" | "weekly" | "monthly" | "yearly";
+            };
+        };
+        /**
+         * Analytics Query Response
+         * @description Analytics query results
+         */
+        QueryResponse: {
+            /** @description Query results */
+            results: {
+                dimensions: string[];
+                metrics: number[];
+                time_series?: number[];
+            }[];
+            /** @description Metadata about the query */
+            meta: {
+                time_labels?: string[];
+                total_rows?: number;
+                query: components["schemas"]["QueryRequest"];
+            };
+        };
+        /** @description Health check response */
+        HealthResponse: {
+            /**
+             * @description Health status
+             * @example ok
+             */
+            status: string;
+            /**
+             * @description Current timestamp in ISO format
+             * @example 2023-12-21T10:30:00.000Z
+             */
+            timestamp: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;

package/dist/client.d.ts

@@ -0,0 +1,23 @@
+export type SendEventOptions = {
+    endpoint: string;
+    apiKey: string;
+    data: unknown;
+    /**
+     * Notified when the send fails. The failure is still swallowed — analytics
+     * must never break the page or the request it is describing — but a
+     * server-side caller usually wants it in its logs.
+     */
+    onError?: (error: unknown) => void;
+};
+/**
+ * Sends tracking data to the Luchy API
+ */
+export declare function sendEvent(options: SendEventOptions): Promise<void>;
+/**
+ * Collects browser data automatically
+ */
+export declare function collectBrowserData(): {
+    userAgent: string;
+    language: string;
+};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,wBAAsB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBxE;AAED;;GAEG;AACH,wBAAgB,kBAAkB;;;EAKjC"}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+export type LuchyInitOptions = {
+    endpoint?: string;
+    apiKey: string;
+    trackLocalhost?: boolean;
+};
+export type LuchyTrackerOptions = {
+    autoPageviews?: boolean;
+    autoOutbound?: boolean;
+    autoEvents?: boolean;
+    hashRouting?: boolean;
+};
+export type LuchyTracker = {
+    trackPageview(data?: {
+        pathname?: string;
+        referrer?: string;
+    }): Promise<void>;
+    trackEvent(name: string, payload?: Record<string, string | number>, options?: {
+        type?: string;
+    }): Promise<void>;
+    setOptions(options: LuchyTrackerOptions): void;
+};
+/**
+ * Creates a Luchy tracker instance
+ */
+export declare function luchy(options: LuchyInitOptions): LuchyTracker;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,aAAa,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACzC,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY,CAyW7D"}