umami-compass 0.1.0

package/dist/api/client.js

@@ -0,0 +1,313 @@
+import { VERSION } from "../version.js";
+import { UmamiError } from "./errors.js";
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function appendQuery(url, query) {
+    if (!query)
+        return;
+    for (const [key, value] of Object.entries(query)) {
+        if (value === undefined)
+            continue;
+        const values = Array.isArray(value) ? value : [value];
+        for (const item of values)
+            url.searchParams.append(key, String(item));
+    }
+}
+function resolveApiPath(baseUrl, path) {
+    if (!path || path.includes("\\") || path.includes("?") || path.includes("#")) {
+        throw new UmamiError("CONFIGURATION_ERROR", "The Umami API path is invalid.");
+    }
+    const url = new URL(path, baseUrl);
+    if (url.origin !== baseUrl.origin || !url.pathname.startsWith(baseUrl.pathname)) {
+        throw new UmamiError("CONFIGURATION_ERROR", "The Umami API path escaped its fixed origin.");
+    }
+    return url;
+}
+function requireWebsitePage(value) {
+    if (!isRecord(value) ||
+        !Array.isArray(value.data) ||
+        typeof value.count !== "number" ||
+        typeof value.page !== "number" ||
+        typeof value.pageSize !== "number") {
+        throw new UmamiError("INVALID_RESPONSE", "Umami returned an invalid website list.");
+    }
+    return value;
+}
+function requireWebsite(value) {
+    if (!isRecord(value) || typeof value.id !== "string") {
+        throw new UmamiError("INVALID_RESPONSE", "Umami returned invalid website metadata.");
+    }
+    return value;
+}
+async function readJsonResponse(response, maxBytes, invalidMessage) {
+    const declaredLength = Number(response.headers.get("content-length"));
+    if (Number.isFinite(declaredLength) && declaredLength > maxBytes) {
+        await response.body?.cancel().catch(() => undefined);
+        throw new UmamiError("INVALID_RESPONSE", `Umami response exceeded the configured ${maxBytes}-byte limit.`);
+    }
+    if (!response.body) {
+        throw new UmamiError("INVALID_RESPONSE", invalidMessage);
+    }
+    const reader = response.body.getReader();
+    const chunks = [];
+    let totalBytes = 0;
+    while (true) {
+        const { done, value } = await reader.read();
+        if (done)
+            break;
+        totalBytes += value.byteLength;
+        if (totalBytes > maxBytes) {
+            await reader.cancel().catch(() => undefined);
+            throw new UmamiError("INVALID_RESPONSE", `Umami response exceeded the configured ${maxBytes}-byte limit.`);
+        }
+        chunks.push(value);
+    }
+    const bytes = new Uint8Array(totalBytes);
+    let offset = 0;
+    for (const chunk of chunks) {
+        bytes.set(chunk, offset);
+        offset += chunk.byteLength;
+    }
+    try {
+        return JSON.parse(new TextDecoder().decode(bytes));
+    }
+    catch (error) {
+        throw new UmamiError("INVALID_RESPONSE", invalidMessage, { cause: error });
+    }
+}
+function waitForSignal(promise, signal) {
+    if (!signal)
+        return promise;
+    if (signal.aborted) {
+        return Promise.reject(new UmamiError("ABORTED", "The Umami request was cancelled."));
+    }
+    return new Promise((resolve, reject) => {
+        const onAbort = () => {
+            reject(new UmamiError("ABORTED", "The Umami request was cancelled."));
+        };
+        signal.addEventListener("abort", onAbort, { once: true });
+        promise.then((value) => {
+            signal.removeEventListener("abort", onAbort);
+            resolve(value);
+        }, (error) => {
+            signal.removeEventListener("abort", onAbort);
+            reject(error);
+        });
+    });
+}
+function statusError(status) {
+    if (status === 401) {
+        return new UmamiError("AUTHENTICATION_FAILED", "Umami rejected the configured credentials.", {
+            status,
+        });
+    }
+    if (status === 403) {
+        return new UmamiError("FORBIDDEN", "Umami denied access to this resource.", { status });
+    }
+    if (status === 404) {
+        return new UmamiError("NOT_FOUND", "The requested Umami resource was not found.", { status });
+    }
+    if (status === 429) {
+        return new UmamiError("RATE_LIMITED", "Umami rate-limited the request. Try again later.", {
+            retryable: true,
+            status,
+        });
+    }
+    return new UmamiError("UPSTREAM_ERROR", status >= 500 ? "Umami is temporarily unavailable." : "Umami rejected the analytics request.", { retryable: status >= 500, status });
+}
+export class UmamiClient {
+    #config;
+    #fetch;
+    #loginGeneration = 0;
+    #loginPromise;
+    #loginToken;
+    constructor(config, fetchImplementation = globalThis.fetch) {
+        this.#config = config;
+        this.#fetch = fetchImplementation;
+    }
+    isWebsiteAllowed(websiteId) {
+        return !this.#config.websiteIds || this.#config.websiteIds.has(websiteId.toLowerCase());
+    }
+    assertWebsiteAllowed(websiteId) {
+        if (!this.isWebsiteAllowed(websiteId)) {
+            throw new UmamiError("FORBIDDEN", "This website is outside the configured UMAMI_WEBSITE_IDS allowlist.");
+        }
+    }
+    async listWebsites(query, signal) {
+        if (!this.#config.websiteIds) {
+            return requireWebsitePage(await this.get("websites", query, signal));
+        }
+        const requestedPage = typeof query.page === "number" ? query.page : 1;
+        const requestedPageSize = typeof query.pageSize === "number" ? query.pageSize : 20;
+        const upstreamQuery = { ...query, page: 1, pageSize: 100 };
+        const firstPage = requireWebsitePage(await this.get("websites", upstreamQuery, signal));
+        const pageCount = Math.ceil(firstPage.count / 100);
+        if (pageCount > 25) {
+            throw new UmamiError("VALIDATION_ERROR", "The account has too many websites to apply the local allowlist safely. Use a more limited Umami identity or a search filter.");
+        }
+        const websites = [...firstPage.data];
+        for (let page = 2; page <= pageCount; page += 1) {
+            const nextPage = requireWebsitePage(await this.get("websites", { ...upstreamQuery, page }, signal));
+            websites.push(...nextPage.data);
+        }
+        const visible = websites.filter((website) => typeof website.id === "string" && this.#config.websiteIds?.has(website.id.toLowerCase()));
+        const start = (requestedPage - 1) * requestedPageSize;
+        return {
+            data: visible.slice(start, start + requestedPageSize),
+            count: visible.length,
+            page: requestedPage,
+            pageSize: requestedPageSize,
+        };
+    }
+    async getWebsite(websiteId, signal) {
+        const normalizedWebsiteId = websiteId.toLowerCase();
+        this.assertWebsiteAllowed(normalizedWebsiteId);
+        return requireWebsite(await this.get(`websites/${encodeURIComponent(normalizedWebsiteId)}`, undefined, signal));
+    }
+    async get(path, query, signal) {
+        return this.#request(path, { method: "GET", query, signal }, true);
+    }
+    async getHeatmapReport(request, signal) {
+        return this.runReport(request, signal);
+    }
+    async runReport(request, signal) {
+        const allowedTypes = new Set([
+            "attribution",
+            "breakdown",
+            "funnel",
+            "goal",
+            "heatmap",
+            "journey",
+            "performance",
+            "retention",
+            "utm",
+        ]);
+        if (!allowedTypes.has(request.type)) {
+            throw new UmamiError("CONFIGURATION_ERROR", "Unsupported read-only Umami report type.");
+        }
+        this.assertWebsiteAllowed(request.websiteId);
+        return this.#request(`reports/${request.type}`, { body: request, method: "POST", signal }, true);
+    }
+    async #request(path, options, retryLogin) {
+        const url = resolveApiPath(this.#config.apiUrl, path);
+        appendQuery(url, options.query);
+        const timeoutSignal = AbortSignal.timeout(this.#config.requestTimeoutMs);
+        const signal = options.signal
+            ? AbortSignal.any([options.signal, timeoutSignal])
+            : timeoutSignal;
+        let response;
+        let loginGeneration;
+        try {
+            const requestHeaders = await this.#headers(options.signal);
+            const { headers } = requestHeaders;
+            loginGeneration = requestHeaders.loginGeneration;
+            if (options.body !== undefined)
+                headers.set("Content-Type", "application/json");
+            response = await this.#fetch(url, {
+                body: options.body === undefined ? undefined : JSON.stringify(options.body),
+                headers,
+                method: options.method ?? "GET",
+                redirect: "error",
+                signal,
+            });
+        }
+        catch (error) {
+            if (signal.aborted) {
+                throw new UmamiError("ABORTED", "The Umami request was cancelled or timed out.", {
+                    cause: error,
+                    retryable: !options.signal?.aborted,
+                });
+            }
+            throw new UmamiError("UPSTREAM_ERROR", "Could not connect to the configured Umami API.", {
+                cause: error,
+                retryable: true,
+            });
+        }
+        if (response.status === 401 && this.#config.auth.type === "login" && retryLogin) {
+            if (this.#loginToken?.generation === loginGeneration)
+                this.#loginToken = undefined;
+            return this.#request(path, options, false);
+        }
+        if (!response.ok)
+            throw statusError(response.status);
+        if (response.status === 204)
+            return undefined;
+        return (await readJsonResponse(response, this.#config.maxResponseBytes, "Umami returned an invalid JSON response."));
+    }
+    async #headers(signal) {
+        const headers = new Headers({
+            Accept: "application/json",
+            "User-Agent": `umami-compass/${VERSION}`,
+        });
+        if (this.#config.auth.type === "apiKey") {
+            headers.set("x-umami-api-key", this.#config.auth.apiKey);
+        }
+        else if (this.#config.auth.type === "accessToken") {
+            headers.set("Authorization", `Bearer ${this.#config.auth.accessToken}`);
+        }
+        else {
+            const credential = await this.#login(signal);
+            headers.set("Authorization", `Bearer ${credential.token}`);
+            return { headers, loginGeneration: credential.generation };
+        }
+        return { headers };
+    }
+    async #login(signal) {
+        if (this.#loginToken)
+            return this.#loginToken;
+        if (!this.#loginPromise) {
+            this.#loginGeneration += 1;
+            const generation = this.#loginGeneration;
+            const loginPromise = this.#performLogin().then((token) => ({ generation, token }));
+            this.#loginPromise = loginPromise;
+            void loginPromise.then((credential) => {
+                this.#loginToken = credential;
+                if (this.#loginPromise === loginPromise)
+                    this.#loginPromise = undefined;
+            }, () => {
+                if (this.#loginPromise === loginPromise)
+                    this.#loginPromise = undefined;
+            });
+        }
+        return waitForSignal(this.#loginPromise, signal);
+    }
+    async #performLogin() {
+        if (this.#config.auth.type !== "login") {
+            throw new UmamiError("CONFIGURATION_ERROR", "Login auth is not configured.");
+        }
+        const url = resolveApiPath(this.#config.apiUrl, "auth/login");
+        const timeoutSignal = AbortSignal.timeout(this.#config.requestTimeoutMs);
+        let response;
+        try {
+            response = await this.#fetch(url, {
+                body: JSON.stringify({
+                    username: this.#config.auth.username,
+                    password: this.#config.auth.password,
+                }),
+                headers: {
+                    Accept: "application/json",
+                    "Content-Type": "application/json",
+                    "User-Agent": `umami-compass/${VERSION}`,
+                },
+                method: "POST",
+                redirect: "error",
+                signal: timeoutSignal,
+            });
+        }
+        catch (error) {
+            throw new UmamiError("AUTHENTICATION_FAILED", "Could not authenticate with Umami.", {
+                cause: error,
+                retryable: true,
+            });
+        }
+        if (!response.ok)
+            throw statusError(response.status);
+        const result = await readJsonResponse(response, this.#config.maxResponseBytes, "Umami returned an invalid login response.");
+        if (!isRecord(result) || typeof result.token !== "string" || !result.token) {
+            throw new UmamiError("INVALID_RESPONSE", "Umami did not return an access token.");
+        }
+        return result.token;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/api/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AA6BzC,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,WAAW,CAAC,GAAQ,EAAE,KAAwB;IACrD,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM;YAAE,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,OAAY,EAAE,IAAY;IAChD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,gCAAgC,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnC,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChF,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,8CAA8C,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAc;IACxC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;QAChB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;QAC1B,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;QAC/B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAClC,CAAC;QACD,MAAM,IAAI,UAAU,CAAC,kBAAkB,EAAE,yCAAyC,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,KAA0C,CAAC;AACpD,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;QACrD,MAAM,IAAI,UAAU,CAAC,kBAAkB,EAAE,0CAA0C,CAAC,CAAC;IACvF,CAAC;IACD,OAAO,KAAgB,CAAC;AAC1B,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,QAAkB,EAClB,QAAgB,EAChB,cAAsB;IAEtB,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACtE,IAAI,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,cAAc,GAAG,QAAQ,EAAE,CAAC;QACjE,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,0CAA0C,QAAQ,cAAc,CACjE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,UAAU,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;IACzC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI;YAAE,MAAM;QAChB,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC;QAC/B,IAAI,UAAU,GAAG,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC7C,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,0CAA0C,QAAQ,cAAc,CACjE,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;IACzC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;IAC7B,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAY,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,UAAU,CAAC,kBAAkB,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAI,OAAmB,EAAE,MAA+B;IAC5E,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAC5B,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC;IACvF,CAAC;IACD,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,MAAM,CAAC,IAAI,UAAU,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CACV,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,UAAU,CAAC,uBAAuB,EAAE,4CAA4C,EAAE;YAC3F,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,UAAU,CAAC,WAAW,EAAE,uCAAuC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,UAAU,CAAC,WAAW,EAAE,6CAA6C,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,UAAU,CAAC,cAAc,EAAE,kDAAkD,EAAE;YACxF,SAAS,EAAE,IAAI;YACf,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IACD,OAAO,IAAI,UAAU,CACnB,gBAAgB,EAChB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,uCAAuC,EAC7F,EAAE,SAAS,EAAE,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,CACrC,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,WAAW;IACb,OAAO,CAAqB;IAC5B,MAAM,CAAQ;IACvB,gBAAgB,GAAG,CAAC,CAAC;IACrB,aAAa,CAA4B;IACzC,WAAW,CAAmB;IAE9B,YAAY,MAA0B,EAAE,sBAA6B,UAAU,CAAC,KAAK;QACnF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC;IACpC,CAAC;IAED,gBAAgB,CAAC,SAAiB;QAChC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,oBAAoB,CAAC,SAAiB;QACpC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,UAAU,CAClB,WAAW,EACX,qEAAqE,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,KAAY,EACZ,MAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC7B,OAAO,kBAAkB,CAAC,MAAM,IAAI,CAAC,GAAG,CAAU,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QAChF,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,iBAAiB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,MAAM,aAAa,GAAG,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;QAC3D,MAAM,SAAS,GAAG,kBAAkB,CAClC,MAAM,IAAI,CAAC,GAAG,CAAU,UAAU,EAAE,aAAa,EAAE,MAAM,CAAC,CAC3D,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;QACnD,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC;YACnB,MAAM,IAAI,UAAU,CAClB,kBAAkB,EAClB,8HAA8H,CAC/H,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,SAAS,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;YAChD,MAAM,QAAQ,GAAG,kBAAkB,CACjC,MAAM,IAAI,CAAC,GAAG,CAAU,UAAU,EAAE,EAAE,GAAG,aAAa,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,CACxE,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAC7B,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,OAAO,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAC3F,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,iBAAiB,CAAC;QACtD,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,iBAAiB,CAAC;YACrD,KAAK,EAAE,OAAO,CAAC,MAAM;YACrB,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,iBAAiB;SACK,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,MAAoB;QACtD,MAAM,mBAAmB,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACpD,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QAC/C,OAAO,cAAc,CACnB,MAAM,IAAI,CAAC,GAAG,CACZ,YAAY,kBAAkB,CAAC,mBAAmB,CAAC,EAAE,EACrD,SAAS,EACT,MAAM,CACP,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAc,IAAY,EAAE,KAAa,EAAE,MAAoB;QACtE,OAAO,IAAI,CAAC,QAAQ,CAAI,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,OAA6B,EAC7B,MAAoB;QAEpB,OAAO,IAAI,CAAC,SAAS,CAAI,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,SAAS,CAAc,OAA8B,EAAE,MAAoB;QAC/E,MAAM,YAAY,GAAG,IAAI,GAAG,CAAgC;YAC1D,aAAa;YACb,WAAW;YACX,QAAQ;YACR,MAAM;YACN,SAAS;YACT,SAAS;YACT,aAAa;YACb,WAAW;YACX,KAAK;SACN,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,0CAA0C,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,QAAQ,CAClB,WAAW,OAAO,CAAC,IAAI,EAAE,EACzB,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EACzC,IAAI,CACL,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,IAAY,EAAE,OAAuB,EAAE,UAAmB;QAC1E,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtD,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;YAClD,CAAC,CAAC,aAAa,CAAC;QAElB,IAAI,QAAkB,CAAC;QACvB,IAAI,eAAmC,CAAC;QACxC,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3D,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;YACnC,eAAe,GAAG,cAAc,CAAC,eAAe,CAAC;YACjD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAChF,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAChC,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC3E,OAAO;gBACP,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;gBAC/B,QAAQ,EAAE,OAAO;gBACjB,MAAM;aACP,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,+CAA+C,EAAE;oBAC/E,KAAK,EAAE,KAAK;oBACZ,SAAS,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO;iBACpC,CAAC,CAAC;YACL,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,gBAAgB,EAAE,gDAAgD,EAAE;gBACvF,KAAK,EAAE,KAAK;gBACZ,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,UAAU,EAAE,CAAC;YAChF,IAAI,IAAI,CAAC,WAAW,EAAE,UAAU,KAAK,eAAe;gBAAE,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;YACnF,OAAO,IAAI,CAAC,QAAQ,CAAI,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,SAAc,CAAC;QAEnD,OAAO,CAAC,MAAM,gBAAgB,CAC5B,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAC7B,0CAA0C,CAC3C,CAAM,CAAC;IACV,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAoB;QACjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;YAC1B,MAAM,EAAE,kBAAkB;YAC1B,YAAY,EAAE,iBAAiB,OAAO,EAAE;SACzC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;YAC3D,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC;QAC7D,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;YACzC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YACnF,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YAClC,KAAK,YAAY,CAAC,IAAI,CACpB,CAAC,UAAU,EAAE,EAAE;gBACb,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;gBAC9B,IAAI,IAAI,CAAC,aAAa,KAAK,YAAY;oBAAE,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC1E,CAAC,EACD,GAAG,EAAE;gBACH,IAAI,IAAI,CAAC,aAAa,KAAK,YAAY;oBAAE,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC1E,CAAC,CACF,CAAC;QACJ,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACvC,MAAM,IAAI,UAAU,CAAC,qBAAqB,EAAE,+BAA+B,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACzE,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;oBACpC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ;iBACrC,CAAC;gBACF,OAAO,EAAE;oBACP,MAAM,EAAE,kBAAkB;oBAC1B,cAAc,EAAE,kBAAkB;oBAClC,YAAY,EAAE,iBAAiB,OAAO,EAAE;iBACzC;gBACD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE,aAAa;aACtB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,UAAU,CAAC,uBAAuB,EAAE,oCAAoC,EAAE;gBAClF,KAAK,EAAE,KAAK;gBACZ,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,QAAQ,EACR,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAC7B,2CAA2C,CAC5C,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAC3E,MAAM,IAAI,UAAU,CAAC,kBAAkB,EAAE,uCAAuC,CAAC,CAAC;QACpF,CAAC;QACD,OAAQ,MAAwB,CAAC,KAAK,CAAC;IACzC,CAAC;CACF"}

package/dist/api/errors.d.ts

@@ -0,0 +1,18 @@
+export type UmamiErrorCode = "ABORTED" | "AUTHENTICATION_FAILED" | "CONFIGURATION_ERROR" | "FORBIDDEN" | "INVALID_RESPONSE" | "NOT_FOUND" | "RATE_LIMITED" | "UPSTREAM_ERROR" | "VALIDATION_ERROR";
+export declare class UmamiError extends Error {
+    readonly code: UmamiErrorCode;
+    readonly retryable: boolean;
+    readonly status?: number;
+    constructor(code: UmamiErrorCode, message: string, options?: {
+        cause?: unknown;
+        retryable?: boolean;
+        status?: number;
+    });
+}
+export declare function toSafeError(error: unknown): {
+    code: UmamiErrorCode;
+    message: string;
+    retryable: boolean;
+    status?: number;
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/api/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/api/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,SAAS,GACT,uBAAuB,GACvB,qBAAqB,GACrB,WAAW,GACX,kBAAkB,GAClB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,kBAAkB,CAAC;AAEvB,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;gBAGvB,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;CAQ1E;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG;IAC3C,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAeA"}

package/dist/api/errors.js

@@ -0,0 +1,28 @@
+export class UmamiError extends Error {
+    code;
+    retryable;
+    status;
+    constructor(code, message, options = {}) {
+        super(message, { cause: options.cause });
+        this.name = "UmamiError";
+        this.code = code;
+        this.retryable = options.retryable ?? false;
+        this.status = options.status;
+    }
+}
+export function toSafeError(error) {
+    if (error instanceof UmamiError) {
+        return {
+            code: error.code,
+            message: error.message,
+            retryable: error.retryable,
+            ...(error.status === undefined ? {} : { status: error.status }),
+        };
+    }
+    return {
+        code: "UPSTREAM_ERROR",
+        message: "The Umami request failed unexpectedly.",
+        retryable: false,
+    };
+}
+//# sourceMappingURL=errors.js.map

package/dist/api/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/api/errors.ts"],"names":[],"mappings":"AAWA,MAAM,OAAO,UAAW,SAAQ,KAAK;IAC1B,IAAI,CAAiB;IACrB,SAAS,CAAU;IACnB,MAAM,CAAU;IAEzB,YACE,IAAoB,EACpB,OAAe,EACf,UAAqE,EAAE;QAEvE,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,UAAU,WAAW,CAAC,KAAc;IAMxC,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;QAChC,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;SAChE,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,wCAAwC;QACjD,SAAS,EAAE,KAAK;KACjB,CAAC;AACJ,CAAC"}

package/dist/api/types.d.ts

@@ -0,0 +1,101 @@
+export type QueryPrimitive = boolean | number | string;
+export type QueryValue = QueryPrimitive | readonly QueryPrimitive[] | undefined;
+export type Query = Readonly<Record<string, QueryValue>>;
+export interface PagedResponse<T = unknown> {
+    count: number;
+    data: T[];
+    page: number;
+    pageSize: number;
+}
+export interface Website {
+    createdAt?: string;
+    deletedAt?: string | null;
+    domain?: string;
+    id: string;
+    name?: string;
+    resetAt?: string | null;
+    teamId?: string | null;
+    updatedAt?: string;
+    userId?: string | null;
+    [key: string]: unknown;
+}
+export interface LoginResponse {
+    token: string;
+    [key: string]: unknown;
+}
+interface ReportRequest<TType extends string, TParameters> {
+    filters: Record<string, unknown>;
+    parameters: TParameters;
+    type: TType;
+    websiteId: string;
+}
+export type HeatmapReportRequest = ReportRequest<"heatmap", {
+    endDate: string;
+    mode: "click" | "scroll";
+    startDate: string;
+    urlPath?: string;
+}>;
+export type PerformanceMetric = "cls" | "fcp" | "inp" | "lcp" | "ttfb";
+export type PerformanceReportRequest = ReportRequest<"performance", {
+    endDate: string;
+    metric?: PerformanceMetric;
+    startDate: string;
+    timezone?: string;
+    unit?: "day" | "hour" | "minute" | "month" | "year";
+}>;
+export type GoalReportRequest = ReportRequest<"goal", {
+    endDate: string;
+    startDate: string;
+    type: string;
+    value: string;
+}>;
+export interface FunnelStepFilter {
+    operator: "c" | "dnc" | "eq" | "neq";
+    property: string;
+    value: string;
+}
+export interface FunnelStep {
+    filters?: FunnelStepFilter[];
+    type: "event" | "path";
+    value: string;
+}
+export type FunnelReportRequest = ReportRequest<"funnel", {
+    endDate: string;
+    startDate: string;
+    steps: FunnelStep[];
+    window: number;
+}>;
+export type JourneyReportRequest = ReportRequest<"journey", {
+    endDate: string;
+    endStep?: string;
+    eventType?: number;
+    startDate: string;
+    startStep?: string;
+    steps: number;
+}>;
+export type RetentionReportRequest = ReportRequest<"retention", {
+    endDate: string;
+    startDate: string;
+    timezone?: string;
+}>;
+export type UtmReportRequest = ReportRequest<"utm", {
+    endDate: string;
+    startDate: string;
+}>;
+export type AttributionReportRequest = ReportRequest<"attribution", {
+    currency?: string;
+    endDate: string;
+    model: "first-click" | "last-click";
+    startDate: string;
+    step: string;
+    type: "event" | "path";
+}>;
+export type BreakdownField = "browser" | "city" | "country" | "device" | "distinctId" | "event" | "hostname" | "language" | "os" | "path" | "query" | "referrer" | "region" | "tag" | "title" | "utmCampaign" | "utmContent" | "utmMedium" | "utmSource" | "utmTerm";
+export type BreakdownReportRequest = ReportRequest<"breakdown", {
+    endDate: string;
+    fields: BreakdownField[];
+    startDate: string;
+}>;
+export type ReadOnlyReportRequest = AttributionReportRequest | BreakdownReportRequest | FunnelReportRequest | GoalReportRequest | HeatmapReportRequest | JourneyReportRequest | PerformanceReportRequest | RetentionReportRequest | UtmReportRequest;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/api/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACvD,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,SAAS,cAAc,EAAE,GAAG,SAAS,CAAC;AAChF,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAEzD,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,UAAU,aAAa,CAAC,KAAK,SAAS,MAAM,EAAE,WAAW;IACvD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,UAAU,EAAE,WAAW,CAAC;IACxB,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,SAAS,EACT;IACE,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvE,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,aAAa,EACb;IACE,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;CACrD,CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAC3C,MAAM,EACN;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CACpE,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,GAAG,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAC7C,QAAQ,EACR;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,UAAU,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAC5E,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAC9C,SAAS,EACT;IACE,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CACF,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAChD,WAAW,EACX;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAC1D,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC,KAAK,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAE5F,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,aAAa,EACb;IACE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,aAAa,GAAG,YAAY,CAAC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CACxB,CACF,CAAC;AAEF,MAAM,MAAM,cAAc,GACtB,SAAS,GACT,MAAM,GACN,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,UAAU,GACV,UAAU,GACV,IAAI,GACJ,MAAM,GACN,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,OAAO,GACP,aAAa,GACb,YAAY,GACZ,WAAW,GACX,WAAW,GACX,SAAS,CAAC;AAEd,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAChD,WAAW,EACX;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,cAAc,EAAE,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CACjE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAC7B,wBAAwB,GACxB,sBAAsB,GACtB,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,gBAAgB,CAAC"}

package/dist/api/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/api/types.ts"],"names":[],"mappings":""}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { toSafeError, UmamiError } from "./api/errors.js";
+import { loadConfig } from "./config.js";
+import { createServer } from "./server.js";
+import { VERSION } from "./version.js";
+const HELP = `Umami Compass ${VERSION}
+
+A secure MCP server for Umami Analytics Cloud and self-hosted deployments.
+
+Usage:
+  umami-compass
+  umami-compass --help
+  umami-compass --version
+
+The server uses stdio. Configure it through environment variables; see .env.example
+and https://github.com/webcredo/umami-compass#configuration.
+`;
+async function main() {
+    const argument = process.argv[2];
+    if (argument === "--help" || argument === "-h") {
+        process.stdout.write(HELP);
+        return;
+    }
+    if (argument === "--version" || argument === "-v") {
+        process.stdout.write(`${VERSION}\n`);
+        return;
+    }
+    if (process.argv.length > 2) {
+        throw new UmamiError("CONFIGURATION_ERROR", "Umami Compass does not accept positional arguments. Use --help for usage.");
+    }
+    const server = createServer({ config: loadConfig() });
+    const transport = new StdioServerTransport();
+    const shutdown = async () => {
+        await server.close();
+    };
+    process.once("SIGINT", shutdown);
+    process.once("SIGTERM", shutdown);
+    await server.connect(transport);
+}
+main().catch((error) => {
+    const safeError = toSafeError(error);
+    console.error(`[umami-compass] ${safeError.message}`);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,IAAI,GAAG,iBAAiB,OAAO;;;;;;;;;;;CAWpC,CAAC;AAEF,KAAK,UAAU,IAAI;IACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjC,IAAI,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,UAAU,CAClB,qBAAqB,EACrB,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClC,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;IAC9B,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,mBAAmB,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IACtD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,25 @@
+export declare const TOOLSETS: readonly ["core", "events", "sessions", "performance", "reports", "revenue", "replay", "heatmaps"];
+export type Toolset = (typeof TOOLSETS)[number];
+export type UmamiAuth = {
+    type: "apiKey";
+    apiKey: string;
+} | {
+    type: "accessToken";
+    accessToken: string;
+} | {
+    type: "login";
+    username: string;
+    password: string;
+};
+export interface UmamiCompassConfig {
+    apiUrl: URL;
+    auth: UmamiAuth;
+    allowInsecureHttp: boolean;
+    maxRangeDays: number;
+    maxResponseBytes: number;
+    requestTimeoutMs: number;
+    toolsets: ReadonlySet<Toolset>;
+    websiteIds?: ReadonlySet<string>;
+}
+export declare function loadConfig(env?: NodeJS.ProcessEnv): UmamiCompassConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,oGASX,CAAC;AACX,MAAM,MAAM,OAAO,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhD,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAC5C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1D,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,EAAE,SAAS,CAAC;IAChB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC/B,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAClC;AA8JD,wBAAgB,UAAU,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,kBAAkB,CAgCnF"}