@camunda8/sdk 8.5.0 → 8.5.1-alpha.2

package/dist/admin/lib/AdminApiClient.js

@@ -8,6 +8,10 @@ const debug_1 = __importDefault(require("debug"));
 const got_1 = __importDefault(require("got"));
 const lib_1 = require("../../lib");
 const debug = (0, debug_1.default)('camunda:adminconsole');
+/**
+ * This class provides methods to interact with the Camunda Admin API.
+ * @throws {RESTError} An error that may occur during API operations.
+ */
 class AdminApiClient {
     constructor(options) {
         const config = lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(options?.config ?? {});
@@ -16,25 +20,19 @@ class AdminApiClient {
             options?.oAuthProvider ?? (0, lib_1.constructOAuthProvider)(config);
         const certificateAuthority = (0, lib_1.GetCertificateAuthority)(config);
         this.userAgentString = (0, lib_1.createUserAgentString)(config);
+        const prefixUrl = `${baseUrl}/clusters`;
         this.rest = got_1.default.extend({
-            prefixUrl: `${baseUrl}/clusters`,
+            prefixUrl,
+            retry: lib_1.GotRetryConfig,
             https: {
                 certificateAuthority,
             },
+            handlers: [lib_1.gotErrorHandler],
             hooks: {
-                beforeError: [
-                    (error) => {
-                        const { request } = error;
-                        if (request) {
-                            debug(`Error in request to ${request.options.url.href}`);
-                            debug(`Request headers: ${JSON.stringify(request.options.headers)}`);
-                            debug(`Error: ${error.code} - ${error.message}`);
-                            // Attach more contextual information to the error object
-                            error.message += ` (request to ${request.options.url.href})`;
-                        }
-                        return error;
-                    },
+                beforeRetry: [
+                    (0, lib_1.makeBeforeRetryHandlerFor401TokenRetry)(this.getHeaders.bind(this)),
                 ],
+                beforeError: [lib_1.gotBeforeErrorHook],
             },
         });
         debug('prefixUrl', `${baseUrl}/clusters`);
@@ -52,6 +50,7 @@ class AdminApiClient {
     /**
      *
      * @description Get an array of the current API clients for this cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClients) for more details.
+     * @throws {RESTError}
      * @param clusterUuid - The cluster UUID
      *
      */
@@ -63,7 +62,7 @@ class AdminApiClient {
     }
     /**
      * @description Create a new API client for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateClient) for more details.
-     * @returns
+     * @throws {RESTError}
      */
     async createClient(req) {
         const headers = await this.getHeaders();
@@ -81,6 +80,7 @@ class AdminApiClient {
      * @description Get the details of an API client. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClient) for more details.
      * @param clusterUuid
      * @param clientId
+     * @throws {RESTError}
      * @returns
      */
     async getClient(clusterUuid, clientId) {
@@ -93,6 +93,7 @@ class AdminApiClient {
      * @description See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteClient) for more details.
      * @param clusterUuid
      * @param clientId
+     * @throws {RESTError}
      */
     async deleteClient(clusterUuid, clientId) {
         const headers = await this.getHeaders();
@@ -105,6 +106,7 @@ class AdminApiClient {
     /**
      *
      * @description Return an array of clusters. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClusters) for more details.
+     * @throws {RESTError}
      */
     async getClusters() {
         const headers = await this.getHeaders();
@@ -115,6 +117,7 @@ class AdminApiClient {
     /**
      *
      * @description Create a new cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateCluster) for more details.
+     * @throws {RESTError}
      */
     async createCluster(createClusterRequest) {
         const headers = await this.getHeaders();
@@ -128,6 +131,7 @@ class AdminApiClient {
     /**
      *
      * @description Retrieve the metadata for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetCluster) for more details.
+     * @throws {RESTError}
      *
      */
     async getCluster(clusterUuid) {
@@ -139,6 +143,7 @@ class AdminApiClient {
     /**
      *
      * @description Delete a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteCluster) for more details.
+     * @throws {RESTError}
      *
      */
     async deleteCluster(clusterUuid) {
@@ -152,6 +157,7 @@ class AdminApiClient {
     /**
      *
      * @description Retrieve the available parameters for cluster creation. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetParameters) for more details.
+     * @throws {RESTError}
      */
     async getParameters() {
         const headers = await this.getHeaders();
@@ -162,6 +168,7 @@ class AdminApiClient {
     /**
      *
      * @description Retrieve the connector secrets. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetSecrets) for more details.
+     * @throws {RESTError}
      */
     async getSecrets(clusterUuid) {
         const headers = await this.getHeaders();
@@ -172,6 +179,7 @@ class AdminApiClient {
     /**
      *
      * @description Create a new connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateSecret) for more details.
+     * @throws {RESTError}
      */
     async createSecret({ clusterUuid, secretName, secretValue, }) {
         const headers = await this.getHeaders();
@@ -184,6 +192,7 @@ class AdminApiClient {
     /**
      *
      * @description Delete a connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteSecret) for more details.
+     * @throws {RESTError}
      */
     async deleteSecret(clusterUuid, secretName) {
         const headers = await this.getHeaders();
@@ -196,6 +205,7 @@ class AdminApiClient {
     /**
      *
      * @description Add one or more IPs to the whitelist for the cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/UpdateIpWhitelist) for more details.
+     * @throws {RESTError}
      * @param ipwhitelist
      * @returns
      */
@@ -213,6 +223,7 @@ class AdminApiClient {
     /**
      *
      * @description Retrieve a list of members and pending invites for your organisation. See the [API Documentation]() for more details.
+     * @throws {RESTError}
      */
     async getUsers() {
         const headers = await this.getHeaders();
@@ -225,6 +236,7 @@ class AdminApiClient {
     /**
      *
      * @description Add a member. See the [API Documentation]() for more details.
+     * @throws {RESTError}
      *
      */
     async createMember(email, orgRoles) {
@@ -239,6 +251,7 @@ class AdminApiClient {
     /**
      *
      * @description Delete a member from your organization. See the [API Documentation]() for more details.
+     * @throws {RESTError}
      *
      */
     async deleteMember(email) {

package/dist/admin/lib/AdminApiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAQkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,OAAO,GAAG,IAAA,0BAAoB,EACnC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,oBAAoB,GAAG,IAAA,6BAAuB,EAAC,MAAM,CAAC,CAAA;QAE5D,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACtB,SAAS,EAAE,GAAG,OAAO,WAAW;YAChC,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,CAAC,KAAK,EAAE,EAAE;wBACT,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;wBACzB,IAAI,OAAO,EAAE,CAAC;4BACb,KAAK,CAAC,uBAAuB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;4BACxD,KAAK,CACJ,oBAAoB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAA;4BACD,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;4BAEhD,yDAAyD;4BACzD,KAAK,CAAC,OAAO,IAAI,gBAAgB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAA;wBAC7D,CAAC;wBACD,OAAO,KAAK,CAAA;oBACb,CAAC;iBACD;aACD;SACD,CAAC,CAAA;QACF,KAAK,CAAC,WAAW,EAAE,GAAG,OAAO,WAAW,CAAC,CAAA;IAC1C,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1D,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE;YAC1C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,UAAU,EAAE;YACnC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC7C,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACpB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,EAAE,EAAE;YACzB,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9B,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE;YAC1C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAC5D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,YAAY,UAAU,EAAE,EAAE;YAC/C,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,GAAG,CAAC,GAAG,WAAW,cAAc,EAAE;YAClC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAhTD,wCAgTC"}
+{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAYkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC;;;GAGG;AACH,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,OAAO,GAAG,IAAA,0BAAoB,EACnC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,oBAAoB,GAAG,IAAA,6BAAuB,EAAC,MAAM,CAAC,CAAA;QAE5D,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,GAAG,OAAO,WAAW,CAAA;QACvC,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACtB,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClE;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;aACjC;SACD,CAAC,CAAA;QACF,KAAK,CAAC,WAAW,EAAE,GAAG,OAAO,WAAW,CAAC,CAAA;IAC1C,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1D,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE;YAC1C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,GAAG,GAAG,CAAC,WAAW,UAAU,EAAE;YACnC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC7C,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACpB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,EAAE,EAAE;YACzB,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9B,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE;YAC1C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAC5D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,GAAG,WAAW,YAAY,UAAU,EAAE,EAAE;YAC/C,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,GAAG,CAAC,GAAG,WAAW,cAAc,EAAE;YAClC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAtTD,wCAsTC"}

package/dist/c8/index.d.ts

@@ -15,7 +15,7 @@ import { ZeebeGrpcClient } from '../zeebe';
  * import { Camunda8 } from '@camunda8/sdk'
  *
  * const c8 = new Camunda8()
- * const zeebe = c8.getZeebeGrpcClient()
+ * const zeebe = c8.getZeebeGrpcApiClient()
  * const operate = c8.getOperateApiClient()
  * const optimize = c8.getOptimizeApiClient()
  * const tasklist = c8.getTasklistApiClient()
@@ -29,7 +29,7 @@ export declare class Camunda8 {
     private modelerApiClient?;
     private optimizeApiClient?;
     private tasklistApiClient?;
-    private zeebeGrpcClient?;
+    private zeebeGrpcApiClient?;
     private configuration;
     private oAuthProvider?;
     constructor(config?: DeepPartial<CamundaPlatform8Configuration>);

package/dist/c8/index.js

@@ -19,7 +19,7 @@ const zeebe_1 = require("../zeebe");
  * import { Camunda8 } from '@camunda8/sdk'
  *
  * const c8 = new Camunda8()
- * const zeebe = c8.getZeebeGrpcClient()
+ * const zeebe = c8.getZeebeGrpcApiClient()
  * const operate = c8.getOperateApiClient()
  * const optimize = c8.getOptimizeApiClient()
  * const tasklist = c8.getTasklistApiClient()
@@ -82,13 +82,13 @@ class Camunda8 {
         return this.tasklistApiClient;
     }
     getZeebeGrpcApiClient() {
-        if (!this.zeebeGrpcClient) {
-            this.zeebeGrpcClient = new zeebe_1.ZeebeGrpcClient({
+        if (!this.zeebeGrpcApiClient) {
+            this.zeebeGrpcApiClient = new zeebe_1.ZeebeGrpcClient({
                 config: this.configuration,
                 oAuthProvider: this.oAuthProvider,
             });
         }
-        return this.zeebeGrpcClient;
+        return this.zeebeGrpcApiClient;
     }
 }
 exports.Camunda8 = Camunda8;

package/dist/c8/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAIe;AACf,wCAA6C;AAC7C,oCAAwC;AACxC,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA0C;AAE1C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,QAAQ;IAUpB,YAAY,SAAqD,EAAE;QAClE,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,CAAC;YAChD,IAAI,CAAC,aAAa,GAAG,IAAI,qBAAa,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;QACvE,CAAC;IACF,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,iBAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,qBAAqB;QAC3B,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAe,CAAC;gBAC1C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;CACD;AA9ED,4BA8EC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAIe;AACf,wCAA6C;AAC7C,oCAAwC;AACxC,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA0C;AAE1C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,QAAQ;IAUpB,YAAY,SAAqD,EAAE;QAClE,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,CAAC;YAChD,IAAI,CAAC,aAAa,GAAG,IAAI,qBAAa,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;QACvE,CAAC;IACF,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,iBAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,qBAAqB;QAC3B,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAe,CAAC;gBAC7C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAC/B,CAAC;CACD;AA9ED,4BA8EC"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import * as Operate from './operate';
 import * as Optimize from './optimize';
 import * as Tasklist from './tasklist';
 import * as Zeebe from './zeebe';
+export { /*HTTPError,*/ RESTError } from './lib';
 export declare const Dto: {
     ChildDto: typeof ChildDto;
     BigIntValue: typeof BigIntValue;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAYvB,sBAAK;AAXd,6BAA+B;AAWT,yFAXb,aAAQ,OAWa;AAV9B,+BAAuE;AACvE,mDAAoC;AASJ,0BAAO;AARvC,8CAA+B;AAQf,oBAAI;AAPpB,mDAAoC;AAOK,0BAAO;AANhD,qDAAsC;AAMY,4BAAQ;AAL1D,qDAAsC;AAKsB,4BAAQ;AAJpE,+CAAgC;AAIsC,sBAAK;AAF9D,QAAA,GAAG,GAAG,EAAE,QAAQ,EAAR,cAAQ,EAAE,WAAW,EAAX,iBAAW,EAAE,WAAW,EAAX,iBAAW,EAAE,WAAW,EAAX,iBAAW,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAcvB,sBAAK;AAbd,6BAA+B;AAaT,yFAbb,aAAQ,OAaa;AAZ9B,+BAAuE;AACvE,mDAAoC;AAWJ,0BAAO;AAVvC,8CAA+B;AAUf,oBAAI;AATpB,mDAAoC;AASK,0BAAO;AARhD,qDAAsC;AAQY,4BAAQ;AAP1D,qDAAsC;AAOsB,4BAAQ;AANpE,+CAAgC;AAMsC,sBAAK;AAF9D,QAAA,GAAG,GAAG,EAAE,QAAQ,EAAR,cAAQ,EAAE,WAAW,EAAX,iBAAW,EAAE,WAAW,EAAX,iBAAW,EAAE,WAAW,EAAX,iBAAW,EAAE,CAAA"}

package/dist/lib/GotErrors.d.ts

@@ -0,0 +1,6 @@
+import * as Got from 'got';
+export declare class HTTPError extends Got.HTTPError {
+    statusCode: number;
+    constructor(response: Got.Response<unknown>);
+}
+export type RESTError = HTTPError | Got.RequestError | Got.ReadError | Got.ParseError | Got.TimeoutError | Got.CancelError | Got.CacheError | Got.MaxRedirectsError | Got.UnsupportedProtocolError;

package/dist/lib/GotErrors.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTPError = void 0;
+const Got = __importStar(require("got"));
+class HTTPError extends Got.HTTPError {
+    constructor(response) {
+        super(response);
+        const details = JSON.parse(response?.body || '{}');
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.statusCode = details.status;
+    }
+}
+exports.HTTPError = HTTPError;
+//# sourceMappingURL=GotErrors.js.map

package/dist/lib/GotErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GotErrors.js","sourceRoot":"","sources":["../../src/lib/GotErrors.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA0B;AAE1B,MAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IAE3C,YAAY,QAA+B;QAC1C,KAAK,CAAC,QAAQ,CAAC,CAAA;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAE,QAAQ,EAAE,IAAe,IAAI,IAAI,CAAC,CAAA;QAC9D,8DAA8D;QAC9D,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAA;IACjC,CAAC;CACD;AARD,8BAQC"}

package/dist/lib/GotHooks.d.ts

@@ -0,0 +1,23 @@
+import { Method } from 'got';
+/**
+ *
+ * This function stores the call point from the application of got requests.
+ * This enables users to see where the error originated from.
+ */
+export declare const gotErrorHandler: (options: any, next: any) => any;
+/**
+ * This function adds the call point to the error stack trace of got errors.
+ * This enables users to see where the error originated from.
+ */
+export declare const gotBeforeErrorHook: (error: any) => any;
+/**
+ *
+ * This function is used on a 401 response to retry the request with a new token, one single time.
+ * https://github.com/camunda/camunda-8-js-sdk/issues/125
+ */
+export declare const makeBeforeRetryHandlerFor401TokenRetry: (getHeadersFn: any) => (context: any) => Promise<void>;
+export declare const GotRetryConfig: {
+    limit: number;
+    methods: Method[];
+    statusCodes: number[];
+};

package/dist/lib/GotHooks.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GotRetryConfig = exports.makeBeforeRetryHandlerFor401TokenRetry = exports.gotBeforeErrorHook = exports.gotErrorHandler = void 0;
+const got_1 = require("got");
+const GotErrors_1 = require("./GotErrors");
+/**
+ *
+ * This function stores the call point from the application of got requests.
+ * This enables users to see where the error originated from.
+ */
+const gotErrorHandler = (options, next) => {
+    if (Object.isFrozen(options.context)) {
+        options.context = { ...options.context, hasRetried: false };
+    }
+    Error.captureStackTrace(options.context);
+    return next(options);
+};
+exports.gotErrorHandler = gotErrorHandler;
+/**
+ * This function adds the call point to the error stack trace of got errors.
+ * This enables users to see where the error originated from.
+ */
+const gotBeforeErrorHook = (error) => {
+    const { request } = error;
+    if (error instanceof got_1.HTTPError) {
+        error = new GotErrors_1.HTTPError(error.response);
+        const details = JSON.parse(error.response?.body || '{}');
+        error.statusCode = details.status;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ;
+    error.source = error.options.context.stack.split('\n');
+    error.message += ` (request to ${request?.options.url.href})`;
+    return error;
+};
+exports.gotBeforeErrorHook = gotBeforeErrorHook;
+/**
+ *
+ * This function is used on a 401 response to retry the request with a new token, one single time.
+ * https://github.com/camunda/camunda-8-js-sdk/issues/125
+ */
+const makeBeforeRetryHandlerFor401TokenRetry = (getHeadersFn) => async (context) => {
+    context.headers.authorization = (await getHeadersFn()).authorization;
+};
+exports.makeBeforeRetryHandlerFor401TokenRetry = makeBeforeRetryHandlerFor401TokenRetry;
+exports.GotRetryConfig = {
+    limit: 1,
+    methods: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'],
+    statusCodes: [401],
+};
+//# sourceMappingURL=GotHooks.js.map

package/dist/lib/GotHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GotHooks.js","sourceRoot":"","sources":["../../src/lib/GotHooks.ts"],"names":[],"mappings":";;;AAAA,6BAAuD;AAEvD,2CAAuC;AAEvC;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;IAChD,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;IAC5D,CAAC;IACD,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAExC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAA;AACrB,CAAC,CAAA;AAPY,QAAA,eAAe,mBAO3B;AAED;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,EAAE;IAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;IACzB,IAAI,KAAK,YAAY,eAAY,EAAE,CAAC;QACnC,KAAK,GAAG,IAAI,qBAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAE,KAAK,CAAC,QAAQ,EAAE,IAAe,IAAI,IAAI,CAAC,CAAA;QACpE,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAA;IAClC,CAAC;IACD,8DAA8D;IAC9D,CAAC;IAAC,KAAa,CAAC,MAAM,GAAI,KAAa,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzE,KAAK,CAAC,OAAO,IAAI,gBAAgB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAA;IAC7D,OAAO,KAAK,CAAA;AACb,CAAC,CAAA;AAXY,QAAA,kBAAkB,sBAW9B;AAED;;;;GAIG;AACI,MAAM,sCAAsC,GAClD,CAAC,YAAY,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACnC,OAAO,CAAC,OAAO,CAAC,aAAa,GAAG,CAAC,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAA;AACrE,CAAC,CAAA;AAHW,QAAA,sCAAsC,0CAGjD;AAEW,QAAA,cAAc,GAAG;IAC7B,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAa;IAC9D,WAAW,EAAE,CAAC,GAAG,CAAC;CAClB,CAAA"}

package/dist/lib/index.d.ts

@@ -6,6 +6,8 @@ export * from './CreateUserAgentString';
 export * from './Delay';
 export * from './EnvironmentSetup';
 export { packageVersion } from './GetPackageVersion';
+export * from './GotErrors';
+export * from './GotHooks';
 export * from './LosslessJsonParser';
 export { RequireConfiguration } from './RequireConfiguration';
 export * from './SuppressZeebeLogging';

package/dist/lib/index.js

@@ -24,6 +24,8 @@ __exportStar(require("./Delay"), exports);
 __exportStar(require("./EnvironmentSetup"), exports);
 var GetPackageVersion_1 = require("./GetPackageVersion");
 Object.defineProperty(exports, "packageVersion", { enumerable: true, get: function () { return GetPackageVersion_1.packageVersion; } });
+__exportStar(require("./GotErrors"), exports);
+__exportStar(require("./GotHooks"), exports);
 __exportStar(require("./LosslessJsonParser"), exports);
 var RequireConfiguration_1 = require("./RequireConfiguration");
 Object.defineProperty(exports, "RequireConfiguration", { enumerable: true, get: function () { return RequireConfiguration_1.RequireConfiguration; } });

package/dist/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,sDAAmC;AACnC,kDAA+B;AAC/B,2DAAwC;AACxC,0DAAuC;AACvC,0CAAuB;AACvB,qDAAkC;AAClC,yDAAoD;AAA3C,mHAAA,cAAc,OAAA;AACvB,uDAAoC;AACpC,+DAA6D;AAApD,4HAAA,oBAAoB,OAAA;AAC7B,yDAAsC;AACtC,mDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,sDAAmC;AACnC,kDAA+B;AAC/B,2DAAwC;AACxC,0DAAuC;AACvC,0CAAuB;AACvB,qDAAkC;AAClC,yDAAoD;AAA3C,mHAAA,cAAc,OAAA;AACvB,8CAA2B;AAC3B,6CAA0B;AAC1B,uDAAoC;AACpC,+DAA6D;AAApD,4HAAA,oBAAoB,OAAA;AAC7B,yDAAsC;AACtC,mDAAgC"}

package/dist/modeler/lib/ModelerAPIClient.d.ts

@@ -14,6 +14,7 @@ export declare class ModelerApiClient {
     /**
      * Adds a new collaborator to a project or modifies the permission level of an existing collaborator.
      * Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.
+     * @throws {RESTError}
      */
     addCollaborator(req: Dto.CreateCollaboratorDto): Promise<null>;
     /**
@@ -22,8 +23,14 @@ export declare class ModelerApiClient {
      * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
      * page specifies the page number to return.
      * size specifies the number of items per page. The default value is 10.
+     * @throws {RESTError}
      */
     searchCollaborators(req: Dto.PubSearchDtoProjectCollaboratorDto): Promise<Dto.PubSearchResultDtoProjectCollaboratorDto>;
+    /**
+     *
+     * @throws {RESTError}
+     * @returns
+     */
     deleteCollaborator({ email, projectId, }: {
         projectId: string;
         email: string;
@@ -49,7 +56,9 @@ export declare class ModelerApiClient {
      *
      * The value of content.version is managed by Web Modeler and will be updated automatically.
      *
-     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/").
+     * This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * @throws {RESTError}
      */
     createFile(req: Dto.CreateFileDto): Promise<Dto.FileMetadataDto>;
     /**
@@ -60,11 +69,14 @@ export declare class ModelerApiClient {
      * facilitates the processing of path-like structures within file and folder names.
      *
      * Does this throw if it is not found?
+     * @throws {RESTError}
      */
     getFile(fileId: string): Promise<Dto.FileDto>;
     /**
      * Deletes a file.
-     * Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.
+     * Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects.
+     * Deletion of resources is recursive and cannot be undone.
+     * @throws {RESTError}
      */
     deleteFile(fileId: string): Promise<null>;
     /**
@@ -80,7 +92,9 @@ export declare class ModelerApiClient {
      * The value of content.name can only be changed via name.
      * The value of content.id is not updatable.
      * The value of content.version is managed by Web Modeler and will be updated automatically.
-     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/").
+     * This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * @throws {RESTError}
      */
     updateFile(fileId: string, update: Dto.UpdateFileDto): Promise<Dto.FileMetadataDto>;
     /**
@@ -105,7 +119,9 @@ export declare class ModelerApiClient {
      * page specifies the page number to return.
      * size specifies the number of items per page. The default value is 10.
      *
-     * Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/").
+     * This form of escaping facilitates the processing of path-like structures within file and folder names.
+     * @throws {RESTError}
      */
     searchFiles(req: Dto.PubSearchDtoFileMetadataDto): Promise<Dto.PubSearchResultDtoFileMetadataDto>;
     /**
@@ -117,12 +133,19 @@ export declare class ModelerApiClient {
      * When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.
      *
      * When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.
+     * @throws {RESTError}
      */
     createFolder(req: Dto.CreateFolderDto): Promise<Dto.FolderMetadataDto>;
+    /**
+     *
+     * @throws {RESTError}
+     * @returns
+     */
     getFolder(folderId: string): Promise<Dto.FolderDto>;
     /**
      *
      * Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     * @throws {RESTError}
      */
     deleteFolder(folderId: string): Promise<null>;
     /**
@@ -135,17 +158,32 @@ export declare class ModelerApiClient {
      * When projectId is given and parentId is either null or omitted altogether, the file will be moved to the root of the project.
      *
      * When projectId and parentId are both given, they must be consistent - i.e. the new parent folder is in the new project.
+     * @throws {RESTError}
      */
     updateFolder(folderId: string, update: Dto.UpdateFolderDto): Promise<Dto.FolderMetadataDto>;
+    /**
+     *
+     * @throws {RESTError}
+     */
     getInfo(): Promise<Dto.InfoDto>;
+    /**
+     *
+     * @throws {RESTError}
+     */
     createMilestone(req: Dto.CreateMilestoneDto): Promise<Dto.MilestoneMetadataDto>;
+    /**
+     *
+     * @throws {RESTError}
+     */
     getMilestone(milestoneId: string): Promise<Dto.MilestoneDto>;
     /**
      * Deletion of resources is recursive and cannot be undone.
+     * @throws {RESTError}
      */
-    deleteMilestone(milestoneId: string): Promise<string | null>;
+    deleteMilestone(milestoneId: string): Promise<string>;
     /**
      * Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.
+     * @throws {RESTError}
      */
     getMilestoneComparison(milestone1Id: string, milestone2Id: string): Promise<string>;
     /**
@@ -170,17 +208,29 @@ export declare class ModelerApiClient {
      * page specifies the page number to return.
      *
      * size specifies the number of items per page. The default value is 10.
+     * @throws {RESTError}
      */
     searchMilestones(req: Dto.PubSearchDtoMilestoneMetadataDto): Promise<Dto.PubSearchResultDtoMilestoneMetadataDto>;
     /**
      * Creates a new project. This project will be created without any collaborators, so it will not be visible in the UI by default. To assign collaborators, use `addCollaborator()`.
+     * @throws {RESTError}
      */
     createProject(name: string): Promise<Dto.ProjectMetadataDto>;
+    /**
+     *
+     * @throws {RESTError}
+     * @returns
+     */
     getProject(projectId: string): Promise<Dto.ProjectDto>;
     /**
-     * This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     * @description This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     * @throws {RESTError}
+     */
+    deleteProject(projectId: string): Promise<any>;
+    /**
+     *
+     * @throws {RESTError}
      */
-    deleteProject(projectId: string): Promise<string | null>;
     renameProject(projectId: string, name: string): Promise<Dto.ProjectMetadataDto>;
     /**
      * Searches for projects.
@@ -205,6 +255,7 @@ export declare class ModelerApiClient {
      * page specifies the page number to return.
      *
      * size specifies the number of items per page. The default value is 10.
+     * @throws {RESTError}
      */
     searchProjects(req: Dto.PubSearchDtoProjectMetadataDto): Promise<Dto.PubSearchResultDtoProjectMetadataDto>;
 }