measurely-js/dist/measurely.js

A client library for interacting with the Measurely API to manage and track custom metrics easily.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
class Measurely {
    /**
     * Initializes the Measurely library with an API key.
     * This key is required for authentication when interacting with the API.
     * @param NEW_API_KEY - The API key provided by Measurely.
     */
    static init(NEW_API_KEY) {
        Measurely.API_KEY = NEW_API_KEY;
    }
    /**
     * Sends a metric to the Measurely API.
     * @param metric_identifier - The metric id or metric name to be tracked.
     * @param payload - The data payload containing the metric value and optional filters.
     * @returns A Promise resolving to a CaptureResult object indicating the operation's outcome.
     */
    static async capture(metric_identifier, payload) {
        // Ensure the API key is set before making the API call.
        if (Measurely.API_KEY === "") {
            return {
                success: false, // Indicates failure due to a missing API key.
                message: "Missing API KEY, please call the init function", // Error message.
            };
        }
        // Makes a POST request to the Measurely API with the metric data.
        const response = await fetch(`https://api.measurely.dev/event/v1/${metric_identifier}`, {
            method: "POST", // Specifies the HTTP method as POST.
            headers: {
                Authorization: `Bearer ${Measurely.API_KEY}`, // Adds the API key for authentication.
                "Content-Type": "application/json", // Specifies JSON as the content type.
            },
            body: JSON.stringify(payload), // Converts the payload to a JSON string.
        });
        // Retrieves the text response from the server.
        const text = await response.text();
        // Returns whether the request was successful and the server response.
        return {
            success: response.ok, // True if the HTTP status code indicates success.
            message: text, // The response message from the server.
        };
    }
}
// Holds the API key used for authentication with the Measurely API.
Measurely.API_KEY = "";
exports.default = Measurely;