@arcjet/env/index.js

Arcjet environment detection

/**
 * Detect the platform.
 *
 * @param environment
 *   Environment.
 * @returns
 *   Name of platform if found.
 */
function platform(environment) {
    if (typeof environment["FLY_APP_NAME"] === "string" &&
        environment["FLY_APP_NAME"] !== "") {
        return "fly-io";
    }
    if (typeof environment["VERCEL"] === "string" &&
        environment["VERCEL"] === "1") {
        return "vercel";
    }
    // https://render.com/docs/environment-variables
    if (typeof environment["RENDER"] === "string" &&
        environment["RENDER"] === "true") {
        return "render";
    }
}
/**
 * Check if the environment is development.
 *
 * @param environment
 *   Environment.
 * @returns
 *   Whether the environment is development.
 */
function isDevelopment(environment) {
    return (environment.NODE_ENV === "development" ||
        environment.MODE === "development" ||
        environment.ARCJET_ENV === "development");
}
/**
 * Get the log level.
 *
 * @param environment
 *   Environment.
 * @returns
 *   Log level.
 */
function logLevel(environment) {
    const level = environment["ARCJET_LOG_LEVEL"];
    switch (level) {
        case "debug":
        case "info":
        case "warn":
        case "error":
            return level;
        default:
            // Default to warn if not set
            return "warn";
    }
}
const baseUrlAllowed = [
    "https://decide.arcjet.com",
    "https://decide.arcjettest.com",
    "https://fly.decide.arcjet.com",
    "https://fly.decide.arcjettest.com",
    "https://decide.arcjet.orb.local",
    // Allow trailing slashes
    "https://decide.arcjet.com/",
    "https://decide.arcjettest.com/",
    "https://fly.decide.arcjet.com/",
    "https://fly.decide.arcjettest.com/",
    "https://decide.arcjet.orb.local/",
];
/**
 * Get the base URL of an Arcjet API.
 *
 * @param environment
 *   Environment.
 * @returns
 *   Base URL of Arcjet API.
 */
function baseUrl(environment) {
    // Use ARCJET_BASE_URL if it is set and belongs to our allowlist; otherwise
    // use the hardcoded default.
    if (typeof environment["ARCJET_BASE_URL"] === "string" &&
        baseUrlAllowed.includes(environment["ARCJET_BASE_URL"])) {
        return environment["ARCJET_BASE_URL"];
    }
    // If we're running on fly.io, use the Arcjet Decide Service hosted on fly
    // Ref: https://fly.io/docs/machines/runtime-environment/#environment-variables
    if (platform(environment) === "fly-io") {
        return "https://fly.decide.arcjet.com";
    }
    return "https://decide.arcjet.com";
}
/**
 * Get the key for an Arcjet API.
 *
 * @param environment
 *   Environment.
 * @returns
 *   Key for Arcjet API if found.
 */
function apiKey(environment) {
    const key = environment["ARCJET_KEY"];
    if (typeof key === "string" && key.startsWith("ajkey_")) {
        return key;
    }
}

export { apiKey, baseUrl, isDevelopment, logLevel, platform };