checkly 6.3.2 → 6.4.0-prerelease-c2b97da

package/dist/rest/api.js

@@ -19,6 +19,7 @@ const test_sessions_1 = __importDefault(require("./test-sessions"));
 const environment_variables_1 = __importDefault(require("./environment-variables"));
 const heartbeat_checks_1 = __importDefault(require("./heartbeat-checks"));
 const checkly_storage_1 = __importDefault(require("./checkly-storage"));
+const errors_1 = require("./errors");
 function getDefaults() {
     const apiKey = config_1.default.getApiKey();
     const accountId = config_1.default.getAccountId();
@@ -46,17 +47,11 @@ async function validateAuthentication() {
         return resp.data;
     }
     catch (err) {
-        if (err.response?.status === 401) {
+        if (err instanceof errors_1.UnauthorizedError) {
             throw new Error(`Authentication failed with account id "${accountId}" `
                 + `and API key "...${apiKey?.slice(-4)}"`);
         }
-        else if (!err.response) {
-            // The request was made but no response was received. This may be due to an internet connection issue.
-            throw new Error(`Encountered an error connecting to Checkly. Please check that the internet connection is working. ${err.message}`);
-        }
-        else {
-            throw new Error(`Encountered an unexpected error connecting to Checkly: ${err.message}`);
-        }
+        throw err;
     }
 }
 exports.validateAuthentication = validateAuthentication;
@@ -73,11 +68,7 @@ function requestInterceptor(config) {
 }
 exports.requestInterceptor = requestInterceptor;
 function responseErrorInterceptor(error) {
-    if (error.response?.status === 408) {
-        throw new Error('Encountered an error connecting to Checkly. '
-            + 'This can be triggered by a slow internet connection or a network with high packet loss.');
-    }
-    throw error;
+    (0, errors_1.handleErrorResponse)(error);
 }
 exports.responseErrorInterceptor = responseErrorInterceptor;
 function init() {

package/dist/rest/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/rest/api.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAwE;AACxE,qCAAwC;AACxC,gEAAuC;AACvC,2CAA8C;AAC9C,0DAA8C;AAC9C,oDAA2B;AAC3B,0DAAiC;AACjC,sDAA6B;AAC7B,0DAAiC;AACjC,4EAAkD;AAClD,4DAAmC;AACnC,oEAA0C;AAC1C,oFAA0D;AAC1D,0EAAgD;AAChD,wEAA8C;AAE9C,SAAgB,WAAW;IACzB,MAAM,MAAM,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IACjC,MAAM,SAAS,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;IACvC,MAAM,OAAO,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IAClC,MAAM,aAAa,GAAG,UAAU,MAAM,EAAE,CAAA;IAExC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,CAAA;AACtD,CAAC;AAPD,kCAOC;AAEM,KAAK,UAAU,sBAAsB;IAC1C,sEAAsE;IACtE,uEAAuE;IACvE,wBAAwB;IACxB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,KAAK,GAAG,EAAE,CAAC;QAC1C,OAAM;IACR,CAAC;IAED,IAAI,CAAC,gBAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,4DAA4D;cACxE,uEAAuE,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,SAAS,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;IACvC,MAAM,MAAM,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IAEjC,IAAI,CAAC;QACH,6BAA6B;QAC7B,MAAM,IAAI,GAAG,MAAM,gBAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,0CAA0C,SAAS,IAAI;kBACnE,mBAAmB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC9C,CAAC;aAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YACzB,sGAAsG;YACtG,MAAM,IAAI,KAAK,CAAC,qGAAqG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QACrI,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0DAA0D,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QAC1F,CAAC;IACH,CAAC;AACH,CAAC;AA/BD,wDA+BC;AAED,SAAgB,kBAAkB,CAAE,MAAkC;IACpE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,CAAA;IAClD,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9C,CAAC;IAED,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,cAAM,CAAA;IAE5C,OAAO,MAAM,CAAA;AACf,CAAC;AAbD,gDAaC;AAED,SAAgB,wBAAwB,CAAE,KAAU;IAClD,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,8CAA8C;cAC1D,yFAAyF,CAAC,CAAA;IAChG,CAAC;IACD,MAAM,KAAK,CAAA;AACb,CAAC;AAND,4DAMC;AAED,SAAS,IAAI;IACX,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;IACjC,MAAM,SAAS,GAAG,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAEnD,MAAM,GAAG,GAAG,eAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAEnC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IAEhD,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAC3B,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,wBAAwB,CACzB,CAAA;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAEY,QAAA,GAAG,GAAG,IAAI,EAAE,CAAA;AAEZ,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,IAAI,GAAG,IAAI,eAAK,CAAC,WAAG,CAAC,CAAA;AACrB,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,MAAM,GAAG,IAAI,gBAAM,CAAC,WAAG,CAAC,CAAA;AACxB,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,SAAS,GAAG,IAAI,mBAAS,CAAC,WAAG,CAAC,CAAA;AAC9B,QAAA,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,WAAG,CAAC,CAAA;AAC5C,QAAA,YAAY,GAAG,IAAI,uBAAY,CAAC,WAAG,CAAC,CAAA;AACpC,QAAA,oBAAoB,GAAG,IAAI,+BAAoB,CAAC,WAAG,CAAC,CAAA;AACpD,QAAA,cAAc,GAAG,IAAI,0BAAe,CAAC,WAAG,CAAC,CAAA;AACzC,QAAA,cAAc,GAAG,IAAI,yBAAc,CAAC,WAAG,CAAC,CAAA"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/rest/api.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAwE;AACxE,qCAAwC;AACxC,gEAAuC;AACvC,2CAA8C;AAC9C,0DAA8C;AAC9C,oDAA2B;AAC3B,0DAAiC;AACjC,sDAA6B;AAC7B,0DAAiC;AACjC,4EAAkD;AAClD,4DAAmC;AACnC,oEAA0C;AAC1C,oFAA0D;AAC1D,0EAAgD;AAChD,wEAA8C;AAC9C,qCAAiE;AAEjE,SAAgB,WAAW;IACzB,MAAM,MAAM,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IACjC,MAAM,SAAS,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;IACvC,MAAM,OAAO,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IAClC,MAAM,aAAa,GAAG,UAAU,MAAM,EAAE,CAAA;IAExC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,CAAA;AACtD,CAAC;AAPD,kCAOC;AAEM,KAAK,UAAU,sBAAsB;IAC1C,sEAAsE;IACtE,uEAAuE;IACvE,wBAAwB;IACxB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,KAAK,GAAG,EAAE,CAAC;QAC1C,OAAM;IACR,CAAC;IAED,IAAI,CAAC,gBAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,4DAA4D;cACxE,uEAAuE,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,SAAS,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;IACvC,MAAM,MAAM,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAA;IAEjC,IAAI,CAAC;QACH,6BAA6B;QAC7B,MAAM,IAAI,GAAG,MAAM,gBAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,IAAI,GAAG,YAAY,0BAAiB,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,0CAA0C,SAAS,IAAI;kBACnE,mBAAmB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC9C,CAAC;QAED,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AA5BD,wDA4BC;AAED,SAAgB,kBAAkB,CAAE,MAAkC;IACpE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,CAAA;IAClD,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAA;IAC9C,CAAC;IAED,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,cAAM,CAAA;IAE5C,OAAO,MAAM,CAAA;AACf,CAAC;AAbD,gDAaC;AAED,SAAgB,wBAAwB,CAAE,KAAU;IAClD,IAAA,4BAAmB,EAAC,KAAK,CAAC,CAAA;AAC5B,CAAC;AAFD,4DAEC;AAED,SAAS,IAAI;IACX,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,CAAA;IACjC,MAAM,SAAS,GAAG,IAAA,kBAAW,EAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAEnD,MAAM,GAAG,GAAG,eAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IAEnC,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IAEhD,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAC3B,QAAQ,CAAC,EAAE,CAAC,QAAQ,EACpB,wBAAwB,CACzB,CAAA;IAED,OAAO,GAAG,CAAA;AACZ,CAAC;AAEY,QAAA,GAAG,GAAG,IAAI,EAAE,CAAA;AAEZ,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,IAAI,GAAG,IAAI,eAAK,CAAC,WAAG,CAAC,CAAA;AACrB,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,MAAM,GAAG,IAAI,gBAAM,CAAC,WAAG,CAAC,CAAA;AACxB,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,WAAG,CAAC,CAAA;AAC5B,QAAA,SAAS,GAAG,IAAI,mBAAS,CAAC,WAAG,CAAC,CAAA;AAC9B,QAAA,gBAAgB,GAAG,IAAI,2BAAgB,CAAC,WAAG,CAAC,CAAA;AAC5C,QAAA,YAAY,GAAG,IAAI,uBAAY,CAAC,WAAG,CAAC,CAAA;AACpC,QAAA,oBAAoB,GAAG,IAAI,+BAAoB,CAAC,WAAG,CAAC,CAAA;AACpD,QAAA,cAAc,GAAG,IAAI,0BAAe,CAAC,WAAG,CAAC,CAAA;AACzC,QAAA,cAAc,GAAG,IAAI,yBAAc,CAAC,WAAG,CAAC,CAAA"}

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

@@ -1,17 +1,43 @@
-import type { AxiosInstance } from 'axios';
+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

@@ -1,5 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentVariableAlreadyExistsError = exports.EnvironmentVariableNotFoundError = void 0;
+const errors_1 = require("./errors");
+/**
+ * Error thrown when the requested environment variable does not exist.
+ */
+class EnvironmentVariableNotFoundError extends Error {
+    environmentVariable;
+    constructor(environmentVariable, options) {
+        super(`Environment variable "${environmentVariable}" does not exist.`, options);
+        this.name = 'EnvironmentVariableNotFoundError';
+        this.environmentVariable = environmentVariable;
+    }
+}
+exports.EnvironmentVariableNotFoundError = EnvironmentVariableNotFoundError;
+/**
+ * Error thrown when the requested environment variable already exists.
+ */
+class EnvironmentVariableAlreadyExistsError extends Error {
+    environmentVariable;
+    constructor(environmentVariable, options) {
+        super(`Environment variable "${environmentVariable}" already exists.`, options);
+        this.name = 'EnvironmentVariableAlreadyExistsError';
+        this.environmentVariable = environmentVariable;
+    }
+}
+exports.EnvironmentVariableAlreadyExistsError = EnvironmentVariableAlreadyExistsError;
 class EnvironmentVariables {
     api;
     constructor(api) {
@@ -8,18 +34,62 @@ class EnvironmentVariables {
     getAll() {
         return this.api.get('/v1/variables');
     }
-    delete(environmentVariableKey) {
-        return this.api.delete(`/v1/variables/${environmentVariableKey}`);
+    /**
+     * @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 errors_1.NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
     }
-    add(environmentVariableKey, environmentVariableValue, locked = false, secret = false) {
-        return this.api.post('/v1/variables', { key: environmentVariableKey, value: environmentVariableValue, locked, secret });
+    /**
+     * @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 errors_1.ConflictError) {
+                throw new EnvironmentVariableAlreadyExistsError(environmentVariableKey);
+            }
+            throw err;
+        }
     }
-    get(environmentVariableKey) {
-        return this.api.get(`/v1/variables/${environmentVariableKey}`);
+    /**
+     * @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 errors_1.NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
     }
+    /**
+     * @throws {EnvironmentVariableNotFoundError} If the environment variable does not exist.
+    */
     // update environment variable with default locked value false
-    update(environmentVariableKey, environmentVariableValue, locked = false, secret = false) {
-        return this.api.put(`/v1/variables/${environmentVariableKey}`, { value: environmentVariableValue, locked, secret });
+    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 errors_1.NotFoundError) {
+                throw new EnvironmentVariableNotFoundError(environmentVariableKey);
+            }
+            throw err;
+        }
     }
 }
 exports.default = EnvironmentVariables;

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

@@ -1 +1 @@
-{"version":3,"file":"environment-variables.js","sourceRoot":"","sources":["../../src/rest/environment-variables.ts"],"names":[],"mappings":";;AASA,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,MAAM,CAAE,sBAA8B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,sBAAsB,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,GAAG,CAAE,sBAA8B,EAAE,wBAAgC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,KAAK;QACnG,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,GAAG,EAAE,sBAAsB,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACzH,CAAC;IAED,GAAG,CAAE,sBAA8B;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,iBAAiB,sBAAsB,EAAE,CAAC,CAAA;IACrF,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAE,sBAA8B,EAAE,wBAAgC,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,GAAG,KAAK;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IACrH,CAAC;CACF;AAED,kBAAe,oBAAoB,CAAA"}
+{"version":3,"file":"environment-variables.js","sourceRoot":"","sources":["../../src/rest/environment-variables.ts"],"names":[],"mappings":";;;AACA,qCAAuD;AASvD;;GAEG;AACH,MAAa,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;AARD,4EAQC;AAED;;GAEG;AACH,MAAa,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;AARD,sFAQC;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,sBAAa,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,sBAAa,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,sBAAa,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,sBAAa,EAAE,CAAC;gBACjC,MAAM,IAAI,gCAAgC,CAAC,sBAAsB,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;CACF;AAED,kBAAe,oBAAoB,CAAA"}

package/dist/rest/errors.d.ts

@@ -0,0 +1,84 @@
+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;
+}
+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);
+}
+export declare function handleErrorResponse(err: Error): never;

package/dist/rest/errors.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleErrorResponse = exports.MissingResponseError = exports.parseErrorData = exports.RequestTimeoutError = exports.MiscellaneousError = exports.ServerError = exports.ConflictError = exports.ForbiddenError = exports.NotFoundError = exports.InadequateEntitlementsError = exports.UnauthorizedError = exports.ValidationError = exports.ApiError = void 0;
+const axios_1 = require("axios");
+class ApiError extends Error {
+    data;
+    constructor(data, options) {
+        super(data.message, options);
+        this.name = 'ApiError';
+        this.data = data;
+    }
+}
+exports.ApiError = ApiError;
+/**
+ * Error thrown when an API response indicates that the request was not valid.
+ */
+class ValidationError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'ValidationError';
+    }
+}
+exports.ValidationError = ValidationError;
+/**
+ * Error thrown when an API response indicates that the request was not
+ * authorized.
+ */
+class UnauthorizedError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'UnauthorizedError';
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;
+/**
+ * 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
+ */
+class InadequateEntitlementsError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'InadequateEntitlementsError';
+    }
+}
+exports.InadequateEntitlementsError = InadequateEntitlementsError;
+/**
+ * Error thrown when an API response indicates that the requested resource
+ * could not be found.
+ */
+class NotFoundError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'NotFoundError';
+    }
+}
+exports.NotFoundError = NotFoundError;
+/**
+ * Error thrown when an API response indicates that the request was not
+ * allowed.
+ */
+class ForbiddenError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'ForbiddenError';
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+/**
+ * Error thrown when an API response indicates that the request conflicts
+ * with server state.
+ */
+class ConflictError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'ConflictError';
+    }
+}
+exports.ConflictError = ConflictError;
+/**
+ * Error thrown when an API response indicates a server error.
+ */
+class ServerError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'ServerError';
+    }
+}
+exports.ServerError = ServerError;
+/**
+ * Error thrown when an API response indicates an error that is not handled
+ * globally.
+ */
+class MiscellaneousError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'MiscellaneousError';
+    }
+}
+exports.MiscellaneousError = MiscellaneousError;
+/**
+ * Error thrown when an API request times out.
+ */
+class RequestTimeoutError extends ApiError {
+    constructor(data, options) {
+        super(data, options);
+        this.name = 'RequestTimeoutError';
+    }
+}
+exports.RequestTimeoutError = RequestTimeoutError;
+function isErrorData(value) {
+    const o = Object(value);
+    return 'statusCode' in o
+        && 'error' in o
+        && 'message' in o;
+}
+function parseErrorData(data, options) {
+    if (isErrorData(data)) {
+        return {
+            ...data,
+            // Prefer the actual HTTP status code from the options just in case the
+            // payload doesn't match.
+            statusCode: options.statusCode,
+        };
+    }
+    if (isErrorOnlyErrorData(data)) {
+        return normalizeErrorOnlyErrorData(data, options);
+    }
+    if (isMessageAndErrorCodeErrorData(data)) {
+        return normalizeMessageAndErrorCodeErrorData(data, options);
+    }
+    if (isStringErrorData(data)) {
+        return normalizeStringErrorData(data, options);
+    }
+}
+exports.parseErrorData = parseErrorData;
+function isErrorOnlyErrorData(value) {
+    return 'error' in Object(value);
+}
+function normalizeErrorOnlyErrorData(data, { statusCode }) {
+    return {
+        ...data,
+        statusCode,
+        message: data.error,
+    };
+}
+function isMessageAndErrorCodeErrorData(value) {
+    const o = Object(value);
+    return 'message' in o
+        && 'errorCode' in o;
+}
+function normalizeMessageAndErrorCodeErrorData(data, { statusCode }) {
+    return {
+        ...data,
+        statusCode,
+        error: data.message,
+    };
+}
+function isStringErrorData(value) {
+    return typeof value === 'string';
+}
+function normalizeStringErrorData(data, { statusCode }) {
+    return {
+        statusCode,
+        error: data,
+        message: data,
+    };
+}
+/**
+ * Error thrown when an API request unexpectedly produces no response.
+ */
+class MissingResponseError extends Error {
+    constructor(options) {
+        super(`Encountered an error connecting to Checkly. Please check that `
+            + `the internet connection is working.`
+            + `\n\n`
+            + `Details: ${options.cause}`, options);
+        this.name = 'MissingResponseError';
+    }
+}
+exports.MissingResponseError = MissingResponseError;
+function handleErrorResponse(err) {
+    if ((0, axios_1.isAxiosError)(err)) {
+        if (!err.response) {
+            throw new MissingResponseError({ cause: err });
+        }
+        const { status: statusCode, data } = err.response;
+        const errorData = parseErrorData(data, {
+            statusCode,
+        });
+        if (errorData !== undefined) {
+            if (statusCode === 400) {
+                throw new ValidationError(errorData, { cause: err });
+            }
+            if (statusCode === 401) {
+                throw new UnauthorizedError(errorData, { cause: err });
+            }
+            if (statusCode === 402) {
+                throw new InadequateEntitlementsError(errorData, { cause: err });
+            }
+            if (statusCode === 403) {
+                throw new ForbiddenError(errorData, { cause: err });
+            }
+            if (statusCode === 404) {
+                throw new NotFoundError(errorData, { cause: err });
+            }
+            if (statusCode === 408) {
+                throw new RequestTimeoutError(errorData, { cause: err });
+            }
+            if (statusCode === 409) {
+                throw new ConflictError(errorData, { cause: err });
+            }
+            if (statusCode >= 500) {
+                throw new ServerError(errorData, { cause: err });
+            }
+            throw new MiscellaneousError(errorData, { cause: err });
+        }
+        if (statusCode === 408) {
+            throw new RequestTimeoutError({
+                statusCode,
+                error: 'Request Timeout',
+                message: 'Encountered an error connecting to Checkly. '
+                    + 'This can be triggered by a slow internet connection or a network with high packet loss.',
+            });
+        }
+    }
+    throw err;
+}
+exports.handleErrorResponse = handleErrorResponse;
+//# sourceMappingURL=errors.js.map

package/dist/rest/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/rest/errors.ts"],"names":[],"mappings":";;;AAAA,iCAAoC;AAEpC,MAAsB,QAAS,SAAQ,KAAK;IAC1C,IAAI,CAAW;IAEf,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAA;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AARD,4BAQC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,QAAQ;IAC3C,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;AALD,0CAKC;AAED;;;GAGG;AACH,MAAa,iBAAkB,SAAQ,QAAQ;IAC7C,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;CACF;AALD,8CAKC;AAED;;;;;;GAMG;AACH,MAAa,2BAA4B,SAAQ,QAAQ;IACvD,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,6BAA6B,CAAA;IAC3C,CAAC;CACF;AALD,kEAKC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,QAAQ;IACzC,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;IAC7B,CAAC;CACF;AALD,sCAKC;AAED;;;GAGG;AACH,MAAa,cAAe,SAAQ,QAAQ;IAC1C,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAA;IAC9B,CAAC;CACF;AALD,wCAKC;AAED;;;GAGG;AACH,MAAa,aAAc,SAAQ,QAAQ;IACzC,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;IAC7B,CAAC;CACF;AALD,sCAKC;AAED;;GAEG;AACH,MAAa,WAAY,SAAQ,QAAQ;IACvC,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAA;IAC3B,CAAC;CACF;AALD,kCAKC;AAED;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,QAAQ;IAC9C,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;IAClC,CAAC;CACF;AALD,gDAKC;AAED;;GAEG;AACH,MAAa,mBAAoB,SAAQ,QAAQ;IAC/C,YAAa,IAAe,EAAE,OAAsB;QAClD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAA;IACnC,CAAC;CACF;AALD,kDAKC;AASD,SAAS,WAAW,CAAE,KAAU;IAC9B,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACvB,OAAO,YAAY,IAAI,CAAC;WACnB,OAAO,IAAI,CAAC;WACZ,SAAS,IAAI,CAAC,CAAA;AACrB,CAAC;AAMD,SAAgB,cAAc,CAAE,IAAS,EAAE,OAAyB;IAClE,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO;YACL,GAAG,IAAI;YAEP,uEAAuE;YACvE,yBAAyB;YACzB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,2BAA2B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;IAED,IAAI,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,OAAO,qCAAqC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC7D,CAAC;IAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,OAAO,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAChD,CAAC;AACH,CAAC;AAtBD,wCAsBC;AAMD,SAAS,oBAAoB,CAAE,KAAU;IACvC,OAAO,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;AACjC,CAAC;AAED,SAAS,2BAA2B,CAClC,IAAwB,EACxB,EAAE,UAAU,EAAoB;IAEhC,OAAO;QACL,GAAG,IAAI;QACP,UAAU;QACV,OAAO,EAAE,IAAI,CAAC,KAAK;KACpB,CAAA;AACH,CAAC;AAOD,SAAS,8BAA8B,CAAE,KAAU;IACjD,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACvB,OAAO,SAAS,IAAI,CAAC;WAChB,WAAW,IAAI,CAAC,CAAA;AACvB,CAAC;AAED,SAAS,qCAAqC,CAC5C,IAAkC,EAClC,EAAE,UAAU,EAAoB;IAEhC,OAAO;QACL,GAAG,IAAI;QACP,UAAU;QACV,KAAK,EAAE,IAAI,CAAC,OAAO;KACpB,CAAA;AACH,CAAC;AAID,SAAS,iBAAiB,CAAE,KAAU;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAA;AAClC,CAAC;AAED,SAAS,wBAAwB,CAC/B,IAAqB,EACrB,EAAE,UAAU,EAAoB;IAEhC,OAAO;QACL,UAAU;QACV,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,IAAI;KACd,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAa,OAAqB;QAChC,KAAK,CACH,gEAAgE;cAC9D,qCAAqC;cACrC,MAAM;cACN,YAAY,OAAO,CAAC,KAAK,EAAE,EAC7B,OAAO,CACR,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAA;IACpC,CAAC;CACF;AAXD,oDAWC;AAED,SAAgB,mBAAmB,CAAE,GAAU;IAC7C,IAAI,IAAA,oBAAY,EAAC,GAAG,CAAC,EAAE,CAAC;QACtB,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,oBAAoB,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;QAChD,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAA;QAEjD,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,EAAE;YACrC,UAAU;SACX,CAAC,CAAA;QAEF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,eAAe,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YACtD,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,iBAAiB,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YACxD,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,2BAA2B,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YAClE,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,cAAc,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YACrD,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YACpD,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YAC1D,CAAC;YAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YACpD,CAAC;YAED,IAAI,UAAU,IAAI,GAAG,EAAE,CAAC;gBACtB,MAAM,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;YAClD,CAAC;YAED,MAAM,IAAI,kBAAkB,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;YACvB,MAAM,IAAI,mBAAmB,CAAC;gBAC5B,UAAU;gBACV,KAAK,EAAE,iBAAiB;gBACxB,OAAO,EAAE,8CAA8C;sBACnD,yFAAyF;aAC9F,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,MAAM,GAAG,CAAA;AACX,CAAC;AA3DD,kDA2DC"}

package/dist/rest/projects.d.ts

@@ -88,19 +88,50 @@ export interface ImportPlan {
     changes?: ImportPlanChanges;
 }
 export declare class ProjectNotFoundError extends Error {
+    logicalId: string;
+    constructor(logicalId: string, options?: ErrorOptions);
+}
+export declare class ProjectAlreadyExistsError extends Error {
+    logicalId: string;
+    constructor(logicalId: string, options?: ErrorOptions);
+}
+export declare class NoImportableResourcesFoundError extends Error {
+    constructor(options?: ErrorOptions);
+}
+export declare class ImportPlanNotFoundError extends Error {
+    constructor(options?: ErrorOptions);
+}
+export declare class InvalidImportPlanStateError extends Error {
+    constructor(options?: ErrorOptions);
 }
 declare class Projects {
     api: AxiosInstance;
     constructor(api: AxiosInstance);
     getAll(): Promise<import("axios").AxiosResponse<ProjectResponse[], any>>;
+    /**
+     * @throws {ProjectNotFoundError} If the project does not exist.
+     */
     get(logicalId: string): Promise<import("axios").AxiosResponse<ProjectResponse, any>>;
+    /**
+     * @throws {ProjectAlreadyExistsError} If the project already exists.
+     */
     create(project: Project): Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * @throws {ProjectNotFoundError} If the project does not exist.
+     */
     deleteProject(logicalId: string): Promise<import("axios").AxiosResponse<any, any>>;
     deploy(resources: ProjectSync, { dryRun, scheduleOnDeploy }?: {
         dryRun?: boolean | undefined;
         scheduleOnDeploy?: boolean | undefined;
     }): Promise<import("axios").AxiosResponse<ProjectDeployResponse, any>>;
+    /**
+     * @throws {ProjectNotFoundError} If the project does not exist.
+     * @throws {NoImportableResourcesFoundError} If no importable resources were found.
+     */
     createImportPlan(logicalId: string, options?: ImportPlanOptions): Promise<import("axios").AxiosResponse<ImportPlan, any>>;
+    /**
+     * @throws {ProjectNotFoundError} If the project does not exist.
+     */
     findImportPlans(logicalId: string, { onlyUnapplied, onlyUncommitted }?: {
         onlyUnapplied?: boolean | undefined;
         onlyUncommitted?: boolean | undefined;
@@ -109,8 +140,20 @@ declare class Projects {
         onlyUnapplied?: boolean | undefined;
         onlyUncommitted?: boolean | undefined;
     }): Promise<import("axios").AxiosResponse<ImportPlan[], any>>;
+    /**
+     * @throws {ImportPlanNotFoundError} If the import plan does not exist.
+     * @throws {InvalidImportPlanStateError} If the operation is performed out of order.
+     */
     cancelImportPlan(importPlanId: string): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @throws {ImportPlanNotFoundError} If the import plan does not exist.
+     * @throws {InvalidImportPlanStateError} If the operation is performed out of order.
+     */
     applyImportPlan(importPlanId: string): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @throws {ImportPlanNotFoundError} If the import plan does not exist.
+     * @throws {InvalidImportPlanStateError} If the operation is performed out of order.
+     */
     commitImportPlan(importPlanId: string): Promise<import("axios").AxiosResponse<void, any>>;
 }
 export default Projects;