@juhuu/sdk-ts 1.2.145 → 1.2.146

package/dist/index.d.mts

@@ -539,6 +539,9 @@ declare class Service {
     readonly httpBaseUrl: string;
     readonly wssBaseUrl: string;
     readonly clientVersion: string;
+    readonly apiKey: string | null;
+    readonly defaultRequestOptions: JUHUU.RequestOptions;
+    readonly authenticationMode: "jwt" | "apiKey";
     onException: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort" | "retry">;
     getAccessToken: () => Promise<string | null> | null;
     setAccessToken: (accessToken: string) => Promise<void>;
@@ -893,13 +896,16 @@ declare class Juhuu {
 }
 declare namespace JUHUU {
     interface SetupConfig {
-        environment: Environment;
-        getAccessToken: () => Promise<string | null>;
-        onException: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort">;
-        setAccessToken: (accessToken: string) => Promise<void>;
-        getRefreshToken: () => Promise<string | null>;
-        setRefreshToken: (refreshToken: string) => Promise<void>;
+        environment?: Environment;
+        getAccessToken?: () => Promise<string | null>;
+        onException?: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort">;
+        setAccessToken?: (accessToken: string) => Promise<void>;
+        getRefreshToken?: () => Promise<string | null>;
+        setRefreshToken?: (refreshToken: string) => Promise<void>;
         clientVersion: string;
+        apiKey?: string;
+        defaultRequestOptions?: JUHUU.RequestOptions;
+        authenticationMode?: "jwt" | "apiKey";
     }
     interface HttpResponse<T> {
         ok: boolean;
@@ -925,6 +931,10 @@ declare namespace JUHUU {
          * If this is true, a new accessToken will be requested if the current one is expired.
          */
         refreshTokensIfNecessary?: boolean;
+        /**
+         * If this API key is provided, the request will be sent with this API key instead of the one passed to config.
+         */
+        apiKey?: string | null;
     };
     interface LocaleString {
         de?: string;
@@ -1488,6 +1498,7 @@ declare namespace JUHUU {
         namespace Create {
             type Params = {
                 propertyId: string;
+                name?: string;
             };
             type Options = JUHUU.RequestOptions;
             type Response = {

package/dist/index.d.ts

@@ -539,6 +539,9 @@ declare class Service {
     readonly httpBaseUrl: string;
     readonly wssBaseUrl: string;
     readonly clientVersion: string;
+    readonly apiKey: string | null;
+    readonly defaultRequestOptions: JUHUU.RequestOptions;
+    readonly authenticationMode: "jwt" | "apiKey";
     onException: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort" | "retry">;
     getAccessToken: () => Promise<string | null> | null;
     setAccessToken: (accessToken: string) => Promise<void>;
@@ -893,13 +896,16 @@ declare class Juhuu {
 }
 declare namespace JUHUU {
     interface SetupConfig {
-        environment: Environment;
-        getAccessToken: () => Promise<string | null>;
-        onException: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort">;
-        setAccessToken: (accessToken: string) => Promise<void>;
-        getRefreshToken: () => Promise<string | null>;
-        setRefreshToken: (refreshToken: string) => Promise<void>;
+        environment?: Environment;
+        getAccessToken?: () => Promise<string | null>;
+        onException?: <T>(response: JUHUU.HttpResponse<T>) => Promise<"abort">;
+        setAccessToken?: (accessToken: string) => Promise<void>;
+        getRefreshToken?: () => Promise<string | null>;
+        setRefreshToken?: (refreshToken: string) => Promise<void>;
         clientVersion: string;
+        apiKey?: string;
+        defaultRequestOptions?: JUHUU.RequestOptions;
+        authenticationMode?: "jwt" | "apiKey";
     }
     interface HttpResponse<T> {
         ok: boolean;
@@ -925,6 +931,10 @@ declare namespace JUHUU {
          * If this is true, a new accessToken will be requested if the current one is expired.
          */
         refreshTokensIfNecessary?: boolean;
+        /**
+         * If this API key is provided, the request will be sent with this API key instead of the one passed to config.
+         */
+        apiKey?: string | null;
     };
     interface LocaleString {
         de?: string;
@@ -1488,6 +1498,7 @@ declare namespace JUHUU {
         namespace Create {
             type Params = {
                 propertyId: string;
+                name?: string;
             };
             type Options = JUHUU.RequestOptions;
             type Response = {

package/dist/index.js

@@ -46,14 +46,17 @@ module.exports = __toCommonJS(src_exports);
 var import_socket = __toESM(require("socket.io-client"));
 var Service = class {
   constructor(config) {
-    this.environment = config.environment;
-    this.getAccessToken = config.getAccessToken;
-    this.onException = config.onException;
-    this.setAccessToken = config.setAccessToken;
-    this.getAccessToken = config.getAccessToken;
-    this.setRefreshToken = config.setRefreshToken;
-    this.getRefreshToken = config.getRefreshToken;
+    this.environment = config.environment ?? "production";
+    this.getAccessToken = config.getAccessToken ?? (() => null);
+    this.onException = config.onException ?? (() => Promise.resolve("abort"));
+    this.setAccessToken = config.setAccessToken ?? (() => Promise.resolve());
+    this.getAccessToken = config.getAccessToken ?? (() => null);
+    this.setRefreshToken = config.setRefreshToken ?? (() => Promise.resolve());
+    this.getRefreshToken = config.getRefreshToken ?? (() => Promise.resolve(null));
     this.clientVersion = config.clientVersion;
+    this.apiKey = config.apiKey ?? null;
+    this.defaultRequestOptions = config.defaultRequestOptions ?? {};
+    this.authenticationMode = config.authenticationMode ?? "jwt";
     switch (config.environment) {
       case "development":
         this.httpBaseUrl = "https://api.juhuu.dev/v1/";
@@ -69,6 +72,9 @@ var Service = class {
   httpBaseUrl;
   wssBaseUrl;
   clientVersion;
+  apiKey;
+  defaultRequestOptions;
+  authenticationMode;
   onException;
   getAccessToken;
   setAccessToken;
@@ -80,29 +86,76 @@ var Service = class {
     body = void 0,
     authenticationNotOptional
   }, options = {}) {
-    if (options.triggerOnException === void 0) {
-      options.triggerOnException = true;
+    const currentOptions = {
+      ...this.defaultRequestOptions,
+      ...options
+    };
+    if (currentOptions.triggerOnException === void 0) {
+      switch (this.authenticationMode) {
+        case "jwt": {
+          currentOptions.triggerOnException = true;
+          break;
+        }
+        case "apiKey": {
+          currentOptions.triggerOnException = false;
+          break;
+        }
+      }
     }
-    if (options.refreshTokensIfNecessary === void 0) {
-      options.refreshTokensIfNecessary = true;
+    if (currentOptions.refreshTokensIfNecessary === void 0) {
+      switch (this.authenticationMode) {
+        case "jwt": {
+          currentOptions.refreshTokensIfNecessary = true;
+          break;
+        }
+        case "apiKey": {
+          currentOptions.refreshTokensIfNecessary = false;
+          break;
+        }
+      }
     }
     let token = null;
-    if (options.accessToken === void 0 || options.accessToken === null) {
-      token = await this.getAccessToken();
-    } else {
-      token = options.accessToken;
-    }
-    console.log("accessToken:", token);
-    if ((token === null || token === void 0) && authenticationNotOptional === true) {
-      console.error(
-        "endpoint",
-        url,
-        "should use authentication but no token was found"
-      );
-      return {
-        ok: false,
-        data: {}
-      };
+    let apiKey = null;
+    switch (this.authenticationMode) {
+      case "jwt": {
+        if (currentOptions.accessToken === void 0 || currentOptions.accessToken === null) {
+          token = await this.getAccessToken();
+        } else {
+          token = currentOptions.accessToken;
+        }
+        console.log("accessToken:", token);
+        if ((token === null || token === void 0) && authenticationNotOptional === true) {
+          console.error(
+            "endpoint",
+            url,
+            "should use authentication but no token was found"
+          );
+          return {
+            ok: false,
+            data: {}
+          };
+        }
+        break;
+      }
+      case "apiKey": {
+        if (currentOptions.apiKey === void 0 || currentOptions.apiKey === null) {
+          apiKey = this.apiKey;
+        } else {
+          apiKey = currentOptions.apiKey;
+        }
+        if (apiKey === null) {
+          console.error(
+            "endpoint",
+            url,
+            "should use authentication but no apiKey was found"
+          );
+          return {
+            ok: false,
+            data: {}
+          };
+        }
+        break;
+      }
     }
     const uri = this.httpBaseUrl + url;
     let response = null;
@@ -110,19 +163,19 @@ var Service = class {
     try {
       switch (method) {
         case "GET": {
-          response = await this.sendGetRequest(token, uri);
+          response = await this.sendGetRequest({ token, uri, apiKey });
           break;
         }
         case "POST": {
-          response = await this.sendPostRequest(token, uri, body);
+          response = await this.sendPostRequest({ token, uri, body, apiKey });
           break;
         }
         case "PATCH": {
-          response = await this.sendPatchRequest(token, uri, body);
+          response = await this.sendPatchRequest({ token, uri, body, apiKey });
           break;
         }
         case "DELETE": {
-          response = await this.sendDeleteRequest(token, uri);
+          response = await this.sendDeleteRequest({ token, uri, apiKey });
           break;
         }
       }
@@ -210,7 +263,11 @@ var Service = class {
     }
     return responseObject;
   }
-  async sendGetRequest(token, uri) {
+  async sendGetRequest({
+    token,
+    apiKey,
+    uri
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -218,12 +275,20 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "GET",
       headers
     });
   }
-  async sendPostRequest(token, uri, body) {
+  async sendPostRequest({
+    token,
+    uri,
+    apiKey,
+    body
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -231,13 +296,21 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "POST",
       headers,
       body: JSON.stringify(body)
     });
   }
-  async sendPatchRequest(token, uri, body) {
+  async sendPatchRequest({
+    token,
+    uri,
+    apiKey,
+    body
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -245,13 +318,20 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "PATCH",
       headers,
       body: JSON.stringify(body)
     });
   }
-  async sendDeleteRequest(token, uri) {
+  async sendDeleteRequest({
+    token,
+    uri,
+    apiKey
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -259,6 +339,9 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "DELETE",
       headers

package/dist/index.mjs

@@ -2,14 +2,17 @@
 import io from "socket.io-client";
 var Service = class {
   constructor(config) {
-    this.environment = config.environment;
-    this.getAccessToken = config.getAccessToken;
-    this.onException = config.onException;
-    this.setAccessToken = config.setAccessToken;
-    this.getAccessToken = config.getAccessToken;
-    this.setRefreshToken = config.setRefreshToken;
-    this.getRefreshToken = config.getRefreshToken;
+    this.environment = config.environment ?? "production";
+    this.getAccessToken = config.getAccessToken ?? (() => null);
+    this.onException = config.onException ?? (() => Promise.resolve("abort"));
+    this.setAccessToken = config.setAccessToken ?? (() => Promise.resolve());
+    this.getAccessToken = config.getAccessToken ?? (() => null);
+    this.setRefreshToken = config.setRefreshToken ?? (() => Promise.resolve());
+    this.getRefreshToken = config.getRefreshToken ?? (() => Promise.resolve(null));
     this.clientVersion = config.clientVersion;
+    this.apiKey = config.apiKey ?? null;
+    this.defaultRequestOptions = config.defaultRequestOptions ?? {};
+    this.authenticationMode = config.authenticationMode ?? "jwt";
     switch (config.environment) {
       case "development":
         this.httpBaseUrl = "https://api.juhuu.dev/v1/";
@@ -25,6 +28,9 @@ var Service = class {
   httpBaseUrl;
   wssBaseUrl;
   clientVersion;
+  apiKey;
+  defaultRequestOptions;
+  authenticationMode;
   onException;
   getAccessToken;
   setAccessToken;
@@ -36,29 +42,76 @@ var Service = class {
     body = void 0,
     authenticationNotOptional
   }, options = {}) {
-    if (options.triggerOnException === void 0) {
-      options.triggerOnException = true;
+    const currentOptions = {
+      ...this.defaultRequestOptions,
+      ...options
+    };
+    if (currentOptions.triggerOnException === void 0) {
+      switch (this.authenticationMode) {
+        case "jwt": {
+          currentOptions.triggerOnException = true;
+          break;
+        }
+        case "apiKey": {
+          currentOptions.triggerOnException = false;
+          break;
+        }
+      }
     }
-    if (options.refreshTokensIfNecessary === void 0) {
-      options.refreshTokensIfNecessary = true;
+    if (currentOptions.refreshTokensIfNecessary === void 0) {
+      switch (this.authenticationMode) {
+        case "jwt": {
+          currentOptions.refreshTokensIfNecessary = true;
+          break;
+        }
+        case "apiKey": {
+          currentOptions.refreshTokensIfNecessary = false;
+          break;
+        }
+      }
     }
     let token = null;
-    if (options.accessToken === void 0 || options.accessToken === null) {
-      token = await this.getAccessToken();
-    } else {
-      token = options.accessToken;
-    }
-    console.log("accessToken:", token);
-    if ((token === null || token === void 0) && authenticationNotOptional === true) {
-      console.error(
-        "endpoint",
-        url,
-        "should use authentication but no token was found"
-      );
-      return {
-        ok: false,
-        data: {}
-      };
+    let apiKey = null;
+    switch (this.authenticationMode) {
+      case "jwt": {
+        if (currentOptions.accessToken === void 0 || currentOptions.accessToken === null) {
+          token = await this.getAccessToken();
+        } else {
+          token = currentOptions.accessToken;
+        }
+        console.log("accessToken:", token);
+        if ((token === null || token === void 0) && authenticationNotOptional === true) {
+          console.error(
+            "endpoint",
+            url,
+            "should use authentication but no token was found"
+          );
+          return {
+            ok: false,
+            data: {}
+          };
+        }
+        break;
+      }
+      case "apiKey": {
+        if (currentOptions.apiKey === void 0 || currentOptions.apiKey === null) {
+          apiKey = this.apiKey;
+        } else {
+          apiKey = currentOptions.apiKey;
+        }
+        if (apiKey === null) {
+          console.error(
+            "endpoint",
+            url,
+            "should use authentication but no apiKey was found"
+          );
+          return {
+            ok: false,
+            data: {}
+          };
+        }
+        break;
+      }
     }
     const uri = this.httpBaseUrl + url;
     let response = null;
@@ -66,19 +119,19 @@ var Service = class {
     try {
       switch (method) {
         case "GET": {
-          response = await this.sendGetRequest(token, uri);
+          response = await this.sendGetRequest({ token, uri, apiKey });
           break;
         }
         case "POST": {
-          response = await this.sendPostRequest(token, uri, body);
+          response = await this.sendPostRequest({ token, uri, body, apiKey });
           break;
         }
         case "PATCH": {
-          response = await this.sendPatchRequest(token, uri, body);
+          response = await this.sendPatchRequest({ token, uri, body, apiKey });
           break;
         }
         case "DELETE": {
-          response = await this.sendDeleteRequest(token, uri);
+          response = await this.sendDeleteRequest({ token, uri, apiKey });
           break;
         }
       }
@@ -166,7 +219,11 @@ var Service = class {
     }
     return responseObject;
   }
-  async sendGetRequest(token, uri) {
+  async sendGetRequest({
+    token,
+    apiKey,
+    uri
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -174,12 +231,20 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "GET",
       headers
     });
   }
-  async sendPostRequest(token, uri, body) {
+  async sendPostRequest({
+    token,
+    uri,
+    apiKey,
+    body
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -187,13 +252,21 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "POST",
       headers,
       body: JSON.stringify(body)
     });
   }
-  async sendPatchRequest(token, uri, body) {
+  async sendPatchRequest({
+    token,
+    uri,
+    apiKey,
+    body
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -201,13 +274,20 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "PATCH",
       headers,
       body: JSON.stringify(body)
     });
   }
-  async sendDeleteRequest(token, uri) {
+  async sendDeleteRequest({
+    token,
+    uri,
+    apiKey
+  }) {
     const headers = {
       "Content-Type": "application/json",
       "Client-Version": this.clientVersion
@@ -215,6 +295,9 @@ var Service = class {
     if (token !== void 0 && token !== null) {
       headers.Authorization = `Bearer ${token}`;
     }
+    if (apiKey !== null) {
+      headers["X-API-KEY"] = apiKey;
+    }
     return await fetch(uri, {
       method: "DELETE",
       headers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juhuu/sdk-ts",
-  "version": "1.2.145",
+  "version": "1.2.146",
   "description": "Typescript wrapper for JUHUU services",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",