domrobot-client 3.3.0 → 4.0.0

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
-  <a href="https://www.inwx.com/en/" target="_blank">
-    <img src="https://images.inwx.com/logos/inwx.png">
+  <a href="https://www.inwx.de/en" target="_blank">
+    <img src="https://images.inwx.com/logos/inwx_nl.png">
   </a>
 </p>
 
@@ -28,6 +28,8 @@ You can find more information about the package on [npmjs.org](https://www.npmjs
 
 ## Example
 
+The third argument of the `ApiClient` constructor turns on debug mode, which prints each request and response with `console.info`; this output can contain sensitive data.
+
 ```typescript
 import { ApiClient, Language } from 'domrobot-client';
 
@@ -37,7 +39,7 @@ const sharedSecret = ''; // only needed for 2FA.
 const domain = 'my-test-domain-' + Math.round(Math.random() * 1e8) + '.com'; // the domain which will be checked.
 
 const asyncFunc = async () => {
-    // By default your ApiClient uses the test api (OT&E). If you want to use the production/live api
+    // By default, your ApiClient uses the test api (OT&E). If you want to use the production/live api
     // we have a constant named API_URL_LIVE in the ApiClient class. Just set apiUrl=ApiClient.API_URL_LIVE and you're good.
     const apiClient = new ApiClient(ApiClient.API_URL_OTE, Language.EN, true);
 
@@ -66,7 +68,7 @@ const asyncFunc = async () => {
 };
 
 // call the async function
-asyncFunc();
+asyncFunc().catch(console.error);
 ```
 
 ## License

package/lib/domrobot.d.ts

@@ -1,5 +1,5 @@
 export declare class ApiClient {
-    static readonly CLIENT_VERSION = "3.0.2";
+    static readonly CLIENT_VERSION = "4.0.0";
     static readonly API_URL_LIVE = "https://api.domrobot.com/jsonrpc/";
     static readonly API_URL_OTE = "https://api.ote.domrobot.com/jsonrpc/";
     static generateClientTransactionId(): string;
@@ -20,10 +20,13 @@ export declare class ApiClient {
      *
      * @param apiMethod The name of the method called in the API.
      * @param methodParams An object of parameters added to the request.
-     * @param clientTransactionId Id sent with every request to distinguish your api requests in case you need support.
-     * @param language Language for the API request. Default is value of field language.
-     * @param cacheOption HTTP cache options
-     * @param nextjsOptions Next.js options
+     * @param clientTransactionId Id to distinguish your api requests in case you need support. It is sent only if
+     *     methodParams already has the key `clTRID`, and it then replaces that value.
+     * @param language Language for the API request. Default is value of field language. It is sent only if
+     *     methodParams already has the key `lang`, and it then replaces that value.
+     * @param cacheOption HTTP cache option of fetch. `only-if-cached` needs `mode: 'same-origin'`.
+     * @param nextjsOptions Next.js options, spread over the fetch options. Each key replaces the value of the client.
+     *     A `headers` key replaces all default headers.
      */
     callApi(apiMethod: string, methodParams?: any, clientTransactionId?: string, language?: string, cacheOption?: 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached' | 'default', nextjsOptions?: object): Promise<any>;
     /**

package/lib/domrobot.js

@@ -33,10 +33,13 @@ class ApiClient {
      *
      * @param apiMethod The name of the method called in the API.
      * @param methodParams An object of parameters added to the request.
-     * @param clientTransactionId Id sent with every request to distinguish your api requests in case you need support.
-     * @param language Language for the API request. Default is value of field language.
-     * @param cacheOption HTTP cache options
-     * @param nextjsOptions Next.js options
+     * @param clientTransactionId Id to distinguish your api requests in case you need support. It is sent only if
+     *     methodParams already has the key `clTRID`, and it then replaces that value.
+     * @param language Language for the API request. Default is value of field language. It is sent only if
+     *     methodParams already has the key `lang`, and it then replaces that value.
+     * @param cacheOption HTTP cache option of fetch. `only-if-cached` needs `mode: 'same-origin'`.
+     * @param nextjsOptions Next.js options, spread over the fetch options. Each key replaces the value of the client.
+     *     A `headers` key replaces all default headers.
      */
     callApi(apiMethod_1) {
         return __awaiter(this, arguments, void 0, function* (apiMethod, methodParams = {}, clientTransactionId = ApiClient.generateClientTransactionId(), language = this.language, cacheOption, nextjsOptions) {
@@ -53,7 +56,7 @@ class ApiClient {
             });
             let fetchOption = {
                 method: 'POST',
-                headers: new Headers(Object.assign({ 'Content-Type': 'application/json', Cookie: this.cookie, 'User-Agent': `DomRobot/${ApiClient.CLIENT_VERSION} (Node ${process.version})` }, ((_a = this.headers) !== null && _a !== void 0 ? _a : {}))),
+                headers: new Headers(Object.assign(Object.assign(Object.assign({ 'Content-Type': 'application/json' }, (this.cookie != null ? { Cookie: this.cookie } : {})), { 'User-Agent': `DomRobot/${ApiClient.CLIENT_VERSION} (Node ${process.version})` }), ((_a = this.headers) !== null && _a !== void 0 ? _a : {}))),
                 body: requestBody,
                 cache: cacheOption !== null && cacheOption !== void 0 ? cacheOption : 'default',
             };
@@ -64,9 +67,16 @@ class ApiClient {
             if (apiMethod === 'account.login') {
                 this.cookie = response.headers.get('set-cookie');
             }
-            const data = yield response.json();
+            const data = yield response.json().catch((error) => {
+                if (error instanceof SyntaxError) {
+                    // The ES6 lib of the compiler has no constructor with options.
+                    throw Object.assign(new SyntaxError(`Response of ${apiMethod} is not JSON (HTTP ${response.status} ${response.statusText})`), { cause: error });
+                }
+                throw error;
+            });
             if (this.debugMode) {
-                console.info(`Request (${apiMethod}): ${requestBody}`);
+                const printedRequest = JSON.stringify({ method: apiMethod, params: methodParams }, (key, value) => key === 'pass' || key === 'tan' ? '***' : value);
+                console.info(`Request (${apiMethod}): ${printedRequest}`);
                 console.info(`Response (${apiMethod}): ${JSON.stringify(data)}`);
             }
             return data;
@@ -86,7 +96,7 @@ class ApiClient {
                 if (sharedSecret === null) {
                     return Promise.reject('API requests two factor challenge but no shared secret is given. Aborting.');
                 }
-                const secretCode = otplib.authenticator.generate(sharedSecret);
+                const secretCode = otplib.generateSync({ secret: sharedSecret });
                 const unlockResult = yield this.callApi('account.unlock', { tan: secretCode });
                 if (unlockResult.code !== 1000) {
                     return unlockResult;
@@ -132,7 +142,7 @@ class ApiClient {
     }
 }
 exports.ApiClient = ApiClient;
-ApiClient.CLIENT_VERSION = '3.0.2';
+ApiClient.CLIENT_VERSION = '4.0.0';
 ApiClient.API_URL_LIVE = 'https://api.domrobot.com/jsonrpc/';
 ApiClient.API_URL_OTE = 'https://api.ote.domrobot.com/jsonrpc/';
 /**

package/lib/domrobot.js.map

@@ -1 +1 @@
-{"version":3,"file":"domrobot.js","sourceRoot":"","sources":["../src/domrobot.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAiC;AAEjC,MAAa,SAAS;IAMX,MAAM,CAAC,2BAA2B;QACrC,OAAO,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IAChE,CAAC;IASD;;;;;OAKG;IACH,YACI,SAAiB,SAAS,CAAC,WAAW,EACtC,WAAmB,QAAQ,CAAC,EAAE,EAC9B,YAAqB,KAAK,EAC1B,UAA+B,EAAE;QAEjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACU,OAAO;6DAChB,SAAiB,EACjB,eAAoB,EAAE,EACtB,sBAA8B,SAAS,CAAC,2BAA2B,EAAE,EACrE,WAAmB,IAAI,CAAC,QAAQ,EAChC,WAA+F,EAC/F,aAAsB;;YAEtB,IAAI,QAAS,IAAI,YAAY,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;gBAC5D,YAAY,CAAC,MAAM,GAAG,mBAAmB,CAAC;YAC9C,CAAC;YACD,IAAI,MAAO,IAAI,YAAY,EAAE,CAAC;gBAC1B,YAAY,CAAC,IAAI,GAAG,QAAQ,CAAC;YACjC,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,YAAY;aACvB,CAAC,CAAC;YAEH,IAAI,WAAW,GAAG;gBACd,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,OAAO,iBAChB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,IAAI,CAAC,MAAM,EACnB,YAAY,EAAE,YAAY,SAAS,CAAC,cAAc,UAAU,OAAO,CAAC,OAAO,GAAG,IAC3E,CAAC,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC,EACzB;gBACF,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,SAAS;aAClC,CAAC;YAEF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC9B,WAAW,mCAAQ,WAAW,GAAK,aAAa,CAAE,CAAC;YACvD,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEvD,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACrD,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,OAAO,CAAC,IAAI,CAAC,YAAY,SAAS,MAAM,WAAW,EAAE,CAAC,CAAC;gBACvD,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,KAAK;6DAAC,QAAgB,EAAE,QAAgB,EAAE,eAAuB,IAAI;YAC9E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC5F,IAAI,WAAW,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;gBAC/F,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBACxB,OAAO,OAAO,CAAC,MAAM,CAAC,4EAA4E,CAAC,CAAC;gBACxG,CAAC;gBACD,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;gBAC/D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC/E,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO,YAAY,CAAC;gBACxB,CAAC;YACL,CAAC;YAED,OAAO,WAAW,CAAC;QACvB,CAAC;KAAA;IAED;;OAEG;IACU,MAAM;;YACf,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;QACjF,CAAC;KAAA;IAEM,SAAS;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,WAAW,CAAC,KAAa;QAC5B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAEM,YAAY,CAAC,KAAc;QAC9B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,SAAS;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAEM,UAAU,CAAC,OAA4B;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAEM,UAAU;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;;AAjKL,8BAkKC;AAjK0B,wBAAc,GAAG,OAAO,CAAC;AAEzB,sBAAY,GAAG,mCAAmC,CAAC;AACnD,qBAAW,GAAG,uCAAuC,CAAC;AAgKjF;;GAEG;AACH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,qBAAS,CAAA;IACT,qBAAS,CAAA;IACT,qBAAS,CAAA;AACb,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}
+{"version":3,"file":"domrobot.js","sourceRoot":"","sources":["../src/domrobot.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAiC;AAEjC,MAAa,SAAS;IAMX,MAAM,CAAC,2BAA2B;QACrC,OAAO,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IAChE,CAAC;IASD;;;;;OAKG;IACH,YACI,SAAiB,SAAS,CAAC,WAAW,EACtC,WAAmB,QAAQ,CAAC,EAAE,EAC9B,YAAqB,KAAK,EAC1B,UAA+B,EAAE;QAEjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACU,OAAO;6DAChB,SAAiB,EACjB,eAAoB,EAAE,EACtB,sBAA8B,SAAS,CAAC,2BAA2B,EAAE,EACrE,WAAmB,IAAI,CAAC,QAAQ,EAChC,WAA+F,EAC/F,aAAsB;;YAEtB,IAAI,QAAS,IAAI,YAAY,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;gBAC5D,YAAY,CAAC,MAAM,GAAG,mBAAmB,CAAC;YAC9C,CAAC;YACD,IAAI,MAAO,IAAI,YAAY,EAAE,CAAC;gBAC1B,YAAY,CAAC,IAAI,GAAG,QAAQ,CAAC;YACjC,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,YAAY;aACvB,CAAC,CAAC;YAEH,IAAI,WAAW,GAAG;gBACd,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,OAAO,6CAChB,cAAc,EAAE,kBAAkB,IAC/B,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KACvD,YAAY,EAAE,YAAY,SAAS,CAAC,cAAc,UAAU,OAAO,CAAC,OAAO,GAAG,KAC3E,CAAC,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC,EACzB;gBACF,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,SAAS;aAClC,CAAC;YAEF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC9B,WAAW,mCAAQ,WAAW,GAAK,aAAa,CAAE,CAAC;YACvD,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEvD,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACrD,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC/C,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;oBAC/B,+DAA+D;oBAC/D,MAAM,MAAM,CAAC,MAAM,CACf,IAAI,WAAW,CACX,eAAe,SAAS,sBAAsB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,GAAG,CAC1F,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CAAC;gBACN,CAAC;gBACD,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAC9F,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAClD,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC,YAAY,SAAS,MAAM,cAAc,EAAE,CAAC,CAAC;gBAC1D,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrE,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,KAAK;6DAAC,QAAgB,EAAE,QAAgB,EAAE,eAAuB,IAAI;YAC9E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC5F,IAAI,WAAW,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;gBAC/F,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBACxB,OAAO,OAAO,CAAC,MAAM,CAAC,4EAA4E,CAAC,CAAC;gBACxG,CAAC;gBACD,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;gBACjE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC/E,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO,YAAY,CAAC;gBACxB,CAAC;YACL,CAAC;YAED,OAAO,WAAW,CAAC;QACvB,CAAC;KAAA;IAED;;OAEG;IACU,MAAM;;YACf,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;QACjF,CAAC;KAAA;IAEM,SAAS;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,WAAW,CAAC,KAAa;QAC5B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEM,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAEM,YAAY,CAAC,KAAc;QAC9B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,SAAS;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAEM,UAAU,CAAC,OAA4B;QAC1C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAEM,UAAU;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;;AAlLL,8BAmLC;AAlL0B,wBAAc,GAAG,OAAO,CAAC;AAEzB,sBAAY,GAAG,mCAAmC,CAAC;AACnD,qBAAW,GAAG,uCAAuC,CAAC;AAiLjF;;GAEG;AACH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,qBAAS,CAAA;IACT,qBAAS,CAAA;IACT,qBAAS,CAAA;AACb,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}

package/package.json

@@ -1,10 +1,14 @@
 {
     "name": "domrobot-client",
-    "version": "3.3.0",
+    "version": "4.0.0",
     "description": "INWX Domrobot Node.JS Client",
     "author": "INWX Developer <developer@inwx.de> (https://inwx.com)",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
+    "files": [
+        "lib",
+        "src"
+    ],
     "repository": {
         "type": "git",
         "url": "git+https://github.com/inwx/nodejs-client.git"
@@ -24,22 +28,22 @@
         "format": "prettier --write \"src/**/*.ts\"",
         "format:check": "prettier --check \"src/**/*.ts\"",
         "lint": "eslint \"src/**/*.ts\"",
-        "prepare": "npm run build"
+        "prepare": "npm run build",
+        "pretest": "npm run build",
+        "test": "node --test"
     },
     "dependencies": {
-        "otplib": "^12.0.1"
+        "otplib": "^13.5.0"
     },
     "devDependencies": {
+        "@eslint/js": "^10.0.1",
         "@types/node": "^22.2.0",
-        "@types/otplib": "^7.0.0",
-        "@typescript-eslint/eslint-plugin": "^8.1.0",
-        "browserify": "^17.0.0",
-        "eslint": "^8.44.0",
-        "eslint-config-prettier": "^8.8.0",
+        "eslint": "^10.12.0",
         "prettier": "^3.3.3",
-        "typescript": "^5.5.4"
+        "typescript": "^5.5.4",
+        "typescript-eslint": "^8.71.0"
     },
     "engines": {
-        "node": ">=18"
+        "node": ">=24"
     }
 }

package/src/domrobot.ts

@@ -1,7 +1,7 @@
 import * as otplib from 'otplib';
 
 export class ApiClient {
-    public static readonly CLIENT_VERSION = '3.0.2';
+    public static readonly CLIENT_VERSION = '4.0.0';
 
     public static readonly API_URL_LIVE = 'https://api.domrobot.com/jsonrpc/';
     public static readonly API_URL_OTE = 'https://api.ote.domrobot.com/jsonrpc/';
@@ -41,10 +41,13 @@ export class ApiClient {
      *
      * @param apiMethod The name of the method called in the API.
      * @param methodParams An object of parameters added to the request.
-     * @param clientTransactionId Id sent with every request to distinguish your api requests in case you need support.
-     * @param language Language for the API request. Default is value of field language.
-     * @param cacheOption HTTP cache options
-     * @param nextjsOptions Next.js options
+     * @param clientTransactionId Id to distinguish your api requests in case you need support. It is sent only if
+     *     methodParams already has the key `clTRID`, and it then replaces that value.
+     * @param language Language for the API request. Default is value of field language. It is sent only if
+     *     methodParams already has the key `lang`, and it then replaces that value.
+     * @param cacheOption HTTP cache option of fetch. `only-if-cached` needs `mode: 'same-origin'`.
+     * @param nextjsOptions Next.js options, spread over the fetch options. Each key replaces the value of the client.
+     *     A `headers` key replaces all default headers.
      */
     public async callApi(
         apiMethod: string,
@@ -70,7 +73,7 @@ export class ApiClient {
             method: 'POST',
             headers: new Headers({
                 'Content-Type': 'application/json',
-                Cookie: this.cookie,
+                ...(this.cookie != null ? { Cookie: this.cookie } : {}),
                 'User-Agent': `DomRobot/${ApiClient.CLIENT_VERSION} (Node ${process.version})`,
                 ...(this.headers ?? {}),
             }),
@@ -88,9 +91,23 @@ export class ApiClient {
             this.cookie = response.headers.get('set-cookie');
         }
 
-        const data = await response.json();
+        const data = await response.json().catch((error) => {
+            if (error instanceof SyntaxError) {
+                // The ES6 lib of the compiler has no constructor with options.
+                throw Object.assign(
+                    new SyntaxError(
+                        `Response of ${apiMethod} is not JSON (HTTP ${response.status} ${response.statusText})`,
+                    ),
+                    { cause: error },
+                );
+            }
+            throw error;
+        });
         if (this.debugMode) {
-            console.info(`Request (${apiMethod}): ${requestBody}`);
+            const printedRequest = JSON.stringify({ method: apiMethod, params: methodParams }, (key, value) =>
+                key === 'pass' || key === 'tan' ? '***' : value,
+            );
+            console.info(`Request (${apiMethod}): ${printedRequest}`);
             console.info(`Response (${apiMethod}): ${JSON.stringify(data)}`);
         }
 
@@ -110,7 +127,7 @@ export class ApiClient {
             if (sharedSecret === null) {
                 return Promise.reject('API requests two factor challenge but no shared secret is given. Aborting.');
             }
-            const secretCode = otplib.authenticator.generate(sharedSecret);
+            const secretCode = otplib.generateSync({ secret: sharedSecret });
             const unlockResult = await this.callApi('account.unlock', { tan: secretCode });
             if (unlockResult.code !== 1000) {
                 return unlockResult;

package/.eslintrc

@@ -1,22 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "script"
-  },
-  "env": {
-    "es2021": true,
-    "node": true
-  },
-  "plugins": [
-    "@typescript-eslint"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "prettier"
-  ],
-  "rules": {
-    "no-console": 0,
-    "no-unused-vars": 0
-  }
-}

package/.github/workflows/format-lint.yaml

@@ -1,20 +0,0 @@
-name: format-lint.yaml
-
-on:
-    pull_request:
-        branches:
-            - master
-
-jobs:
-    format:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: '20'
-            - run: npm ci
-            - name: Prettier check
-              run: npm run format:check
-            - name: Lint the code
-              run: npm run lint

package/.github/workflows/publish.yaml

@@ -1,22 +0,0 @@
-name: Publish Package to npmjs
-
-on:
-    release:
-        types: [published]
-
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            id-token: write
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: '20.x'
-                  registry-url: 'https://registry.npmjs.org'
-            - run: npm ci
-            - run: npm publish --provenance --access public
-              env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-    "printWidth": 120,
-    "trailingComma": "all",
-    "singleQuote": true,
-    "tabWidth": 4
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "none",
-        "target": "es6",
-        "moduleResolution": "node",
-        "sourceMap": true,
-        "allowSyntheticDefaultImports": true,
-        "declaration": true,
-        "outDir": "./lib"
-    },
-    "include": ["src"],
-    "exclude": ["node_modules", "examples"]
-}