checkly 0.0.0-canary.58c867e

package/dist/rest/checks.js

@@ -0,0 +1,43 @@
+import { parseTotalFromContentRange } from '../helpers/content-range.js';
+class Checks {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    getAll(params = {}) {
+        return this.api.get('/v1/checks', { params });
+    }
+    async getAllPaginated(params = {}) {
+        const response = await this.api.get('/v1/checks', { params });
+        const total = parseTotalFromContentRange(response.headers['content-range']) ?? response.data.length;
+        return {
+            checks: response.data,
+            total,
+            page: params.page ?? 1,
+            limit: params.limit ?? 10,
+        };
+    }
+    async fetchAll(params = {}) {
+        const pageSize = 100;
+        const first = await this.getAllPaginated({ ...params, page: 1, limit: pageSize });
+        const allChecks = [...first.checks];
+        if (first.total <= pageSize)
+            return allChecks;
+        const totalPages = Math.ceil(first.total / pageSize);
+        const remaining = await Promise.all(Array.from({ length: totalPages - 1 }, (_, i) => this.api.get('/v1/checks', {
+            params: { ...params, page: i + 2, limit: pageSize },
+        }).then(r => r.data)));
+        for (const page of remaining) {
+            allChecks.push(...page);
+        }
+        return allChecks;
+    }
+    get(id) {
+        return this.api.get(`/v1/checks/${id}`);
+    }
+    delete(id) {
+        return this.api.delete(`/v1/checks/${id}`);
+    }
+}
+export default Checks;
+//# sourceMappingURL=checks.js.map

package/dist/rest/checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../src/rest/checks.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAA;AAuCxE,MAAM,MAAM;IACV,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM,CAAE,SAA2B,EAAE;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,SAA2B,EAAE;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAA;QACnG,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,KAAK;YACL,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,EAAE;SAC1B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,SAAmD,EAAE;QACnE,MAAM,QAAQ,GAAG,GAAG,CAAA;QACpB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;QACjF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;QAEnC,IAAI,KAAK,CAAC,KAAK,IAAI,QAAQ;YAAE,OAAO,SAAS,CAAA;QAE7C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,YAAY,EAAE;YAClC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE;SACpD,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACrB,CACF,CAAA;QACD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAQ,cAAc,EAAE,EAAE,CAAC,CAAA;IAChD,CAAC;IAED,MAAM,CAAE,EAAU;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,cAAc,EAAE,EAAE,CAAC,CAAA;IAClD,CAAC;CACF;AAED,eAAe,MAAM,CAAA"}

package/dist/rest/entitlements.d.ts

@@ -0,0 +1,47 @@
+import type { AxiosInstance } from 'axios';
+export interface Addon {
+    tier: string;
+    tierDisplayName: string;
+}
+export interface RequiredAddon {
+    name: string;
+    displayName: string;
+    tier: string;
+    tierDisplayName: string;
+}
+export interface Entitlement {
+    key: string;
+    name: string;
+    description: string;
+    type: 'metered' | 'flag';
+    enabled: boolean;
+    quantity?: number;
+    requiredPlan?: string;
+    requiredPlanDisplayName?: string;
+    requiredAddon?: RequiredAddon;
+}
+export interface Location {
+    id: string;
+    name: string;
+    available: boolean;
+}
+export interface AccountLocations {
+    all: Location[];
+    maxPerCheck: number;
+}
+export interface AccountPlan {
+    plan: string;
+    planDisplayName: string;
+    addons: {
+        communicate?: Addon;
+        resolve?: Addon;
+    };
+    locations?: AccountLocations;
+    entitlements: Entitlement[];
+}
+declare class Entitlements {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<AccountPlan, any, {}>>;
+}
+export default Entitlements;

package/dist/rest/entitlements.js

@@ -0,0 +1,11 @@
+class Entitlements {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/v1/accounts/me/entitlements');
+    }
+}
+export default Entitlements;
+//# sourceMappingURL=entitlements.js.map

package/dist/rest/entitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../src/rest/entitlements.ts"],"names":[],"mappings":"AAgDA,MAAM,YAAY;IAChB,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,8BAA8B,CAAC,CAAA;IAClE,CAAC;CACF;AAED,eAAe,YAAY,CAAA"}

package/dist/rest/environment-variables.d.ts

@@ -0,0 +1,43 @@
+import { type AxiosInstance } from 'axios';
+export interface EnvironmentVariable {
+    key: string;
+    value: string;
+    locked: boolean;
+    secret?: boolean;
+}
+/**
+ * Error thrown when the requested environment variable does not exist.
+ */
+export declare class EnvironmentVariableNotFoundError extends Error {
+    environmentVariable: string;
+    constructor(environmentVariable: string, options?: ErrorOptions);
+}
+/**
+ * Error thrown when the requested environment variable already exists.
+ */
+export declare class EnvironmentVariableAlreadyExistsError extends Error {
+    environmentVariable: string;
+    constructor(environmentVariable: string, options?: ErrorOptions);
+}
+declare class EnvironmentVariables {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<EnvironmentVariable[], any, {}>>;
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+     */
+    delete(environmentVariableKey: string): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * @throws {EnvironmentVariableAlreadyExistsError} If the environment variable already exists.
+     */
+    add(environmentVariableKey: string, environmentVariableValue: string, locked?: boolean, secret?: boolean): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+     */
+    get(environmentVariableKey: string): Promise<import("axios").AxiosResponse<EnvironmentVariable, any, {}>>;
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+    */
+    update(environmentVariableKey: string, environmentVariableValue: string, locked?: boolean, secret?: boolean): Promise<import("axios").AxiosResponse<any, any, {}>>;
+}
+export default EnvironmentVariables;

package/dist/rest/environment-variables.js

@@ -0,0 +1,91 @@
+import { ConflictError, NotFoundError } from './errors.js';
+/**
+ * Error thrown when the requested environment variable does not exist.
+ */
+export class EnvironmentVariableNotFoundError extends Error {
+    environmentVariable;
+    constructor(environmentVariable, options) {
+        super(`Environment variable "${environmentVariable}" does not exist.`, options);
+        this.name = 'EnvironmentVariableNotFoundError';
+        this.environmentVariable = environmentVariable;
+    }
+}
+/**
+ * Error thrown when the requested environment variable already exists.
+ */
+export class EnvironmentVariableAlreadyExistsError extends Error {
+    environmentVariable;
+    constructor(environmentVariable, options) {
+        super(`Environment variable "${environmentVariable}" already exists.`, options);
+        this.name = 'EnvironmentVariableAlreadyExistsError';
+        this.environmentVariable = environmentVariable;
+    }
+}
+class EnvironmentVariables {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/v1/variables');
+    }
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+     */
+    async delete(environmentVariableKey) {
+        try {
+            return await this.api.delete(`/v1/variables/${environmentVariableKey}`);
+        }
+        catch (err) {
+            if (err instanceof NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
+    }
+    /**
+     * @throws {EnvironmentVariableAlreadyExistsError} If the environment variable already exists.
+     */
+    async add(environmentVariableKey, environmentVariableValue, locked = false, secret = false) {
+        try {
+            return await this.api.post('/v1/variables', { key: environmentVariableKey, value: environmentVariableValue, locked, secret });
+        }
+        catch (err) {
+            if (err instanceof ConflictError) {
+                throw new EnvironmentVariableAlreadyExistsError(environmentVariableKey);
+            }
+            throw err;
+        }
+    }
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+     */
+    async get(environmentVariableKey) {
+        try {
+            return await this.api.get(`/v1/variables/${environmentVariableKey}`);
+        }
+        catch (err) {
+            if (err instanceof NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
+    }
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+    */
+    // update environment variable with default locked value false
+    async update(environmentVariableKey, environmentVariableValue, locked = false, secret = false) {
+        try {
+            return await this.api.put(`/v1/variables/${environmentVariableKey}`, { value: environmentVariableValue, locked, secret });
+        }
+        catch (err) {
+            if (err instanceof NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
+    }
+}
+export default EnvironmentVariables;
+//# sourceMappingURL=environment-variables.js.map

package/dist/rest/environment-variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment-variables.js","sourceRoot":"","sources":["../../src/rest/environment-variables.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAS1D;;GAEG;AACH,MAAM,OAAO,gCAAiC,SAAQ,KAAK;IACzD,mBAAmB,CAAQ;IAE3B,YAAa,mBAA2B,EAAE,OAAsB;QAC9D,KAAK,CAAC,yBAAyB,mBAAmB,mBAAmB,EAAE,OAAO,CAAC,CAAA;QAC/E,IAAI,CAAC,IAAI,GAAG,kCAAkC,CAAA;QAC9C,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;IAChD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,qCAAsC,SAAQ,KAAK;IAC9D,mBAAmB,CAAQ;IAE3B,YAAa,mBAA2B,EAAE,OAAsB;QAC9D,KAAK,CAAC,yBAAyB,mBAAmB,mBAAmB,EAAE,OAAO,CAAC,CAAA;QAC/E,IAAI,CAAC,IAAI,GAAG,uCAAuC,CAAA;QACnD,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;IAChD,CAAC;CACF;AAED,MAAM,oBAAoB;IACxB,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA6B,eAAe,CAAC,CAAA;IAClE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAE,sBAA8B;QAC1C,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,sBAAsB,EAAE,CAAC,CAAA;QACzE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;gBACjC,MAAM,IAAI,gCAAgC,CAAC,sBAAsB,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAE,sBAA8B,EAAE,wBAAgC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,KAAK;QACzG,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,sBAAsB,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAC/H,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;gBACjC,MAAM,IAAI,qCAAqC,CAAC,sBAAsB,CAAC,CAAA;YACzE,CAAC;YAED,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAE,sBAA8B;QACvC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,iBAAiB,sBAAsB,EAAE,CAAC,CAAA;QAC3F,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;gBACjC,MAAM,IAAI,gCAAgC,CAAC,sBAAsB,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAED;;MAEE;IACF,8DAA8D;IAC9D,KAAK,CAAC,MAAM,CAAE,sBAA8B,EAAE,wBAAgC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,KAAK;QAC5G,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAC3H,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;gBACjC,MAAM,IAAI,gCAAgC,CAAC,sBAAsB,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;CACF;AAED,eAAe,oBAAoB,CAAA"}

package/dist/rest/error-groups.d.ts

@@ -0,0 +1,49 @@
+import type { AxiosInstance } from 'axios';
+export interface RcaEvidence {
+    artifacts: Array<{
+        name: string;
+        type: string;
+    }>;
+    description: string;
+}
+export interface RcaReferenceLink {
+    url: string;
+    title: string;
+}
+export interface RootCauseAnalysis {
+    id: string;
+    created_at: string;
+    analysis: {
+        classification: string;
+        rootCause: string;
+        userImpact: string;
+        codeFix: string | null;
+        evidence: RcaEvidence[] | null;
+        referenceLinks: RcaReferenceLink[] | null;
+    };
+    provider: string;
+    model: string;
+    durationMs: number;
+    userContext: Array<{
+        text: string;
+        type: string;
+    }> | null;
+}
+export interface ErrorGroup {
+    id: string;
+    checkId: string;
+    errorHash: string;
+    rawErrorMessage: string | null;
+    cleanedErrorMessage: string;
+    firstSeen: string;
+    lastSeen: string;
+    archivedUntilNextEvent: boolean;
+    rootCauseAnalyses?: RootCauseAnalysis[];
+}
+declare class ErrorGroups {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getByCheckId(checkId: string): Promise<import("axios").AxiosResponse<ErrorGroup[], any, {}>>;
+    get(id: string): Promise<import("axios").AxiosResponse<ErrorGroup, any, {}>>;
+}
+export default ErrorGroups;

package/dist/rest/error-groups.js

@@ -0,0 +1,14 @@
+class ErrorGroups {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    getByCheckId(checkId) {
+        return this.api.get(`/v1/error-groups/checks/${checkId}`);
+    }
+    get(id) {
+        return this.api.get(`/v1/error-groups/${id}`);
+    }
+}
+export default ErrorGroups;
+//# sourceMappingURL=error-groups.js.map

package/dist/rest/error-groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-groups.js","sourceRoot":"","sources":["../../src/rest/error-groups.ts"],"names":[],"mappings":"AAyCA,MAAM,WAAW;IACf,GAAG,CAAe;IAClB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,YAAY,CAAE,OAAe;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAe,2BAA2B,OAAO,EAAE,CAAC,CAAA;IACzE,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAa,oBAAoB,EAAE,EAAE,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,eAAe,WAAW,CAAA"}

package/dist/rest/errors.d.ts

@@ -0,0 +1,95 @@
+export declare abstract class ApiError extends Error {
+    data: ErrorData;
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the request was not valid.
+ */
+export declare class ValidationError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the request was not
+ * authorized.
+ */
+export declare class UnauthorizedError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the operation exceeded
+ * the capabilities of the user's payment plan. Examples include:
+ *
+ *   - Using features not included in the user's plan
+ *   - Exceeding the resource limits of the plan
+ */
+export declare class InadequateEntitlementsError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the requested resource
+ * could not be found.
+ */
+export declare class NotFoundError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the request was not
+ * allowed.
+ */
+export declare class ForbiddenError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates that the request conflicts
+ * with server state.
+ */
+export declare class ConflictError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates a server error.
+ */
+export declare class ServerError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API response indicates an error that is not handled
+ * globally.
+ */
+export declare class MiscellaneousError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+/**
+ * Error thrown when an API request times out.
+ */
+export declare class RequestTimeoutError extends ApiError {
+    constructor(data: ErrorData, options?: ErrorOptions);
+}
+export interface ErrorData {
+    statusCode: number;
+    error: string;
+    errorCode?: string;
+    message: string;
+    /**
+     * Set on a 409 from the async project-deploy endpoint: the id of the in-flight
+     * deployment that blocked this one. Lets the client attach to or cancel it.
+     */
+    deploymentId?: string;
+}
+export interface ErrorDataOptions {
+    statusCode: number;
+}
+export declare function parseErrorData(data: any, options: ErrorDataOptions): ErrorData | undefined;
+/**
+ * Error thrown when an API request unexpectedly produces no response.
+ */
+export declare class MissingResponseError extends Error {
+    constructor(options: ErrorOptions);
+}
+/**
+ * Error thrown when the configured proxy cannot be reached.
+ */
+export declare class ProxyConnectionError extends Error {
+    constructor(proxyUrl: string, options: ErrorOptions);
+}
+export declare function handleErrorResponse(err: Error): never;