@dnv-plant/typescriptpws 1.0.0-alpha.0 → 1.0.0-alpha.1785261

package/src/utilities.ts

@@ -1,218 +1,218 @@
-/***********************************************************************
- * This file has been auto-generated by a code generation tool.
- * Version:   1.0.0
- * Date/time: 30 Jan 2025 11:43:04
- * Template:  templates/typescriptpws/utilities.razor.
- ***********************************************************************/
-
-import jwt from "jsonwebtoken";
-import axios, { AxiosResponse } from "axios";
-
-import { REST_API_URI, PWS_CLIENT_ID, REST_API_VERSION } from "./constants";
-
-// Get headers for requests
-function getHeaders(accessToken: string) {
-  return {
-    "Content-Type": "application/json",
-    Authorization: `Bearer ${accessToken}`,
-  };
-}
-
-// Post JSON to URL and time the call
-export async function postRequest(url: string, data: string): Promise<AxiosResponse> {
-  try {
-    const accessToken = getAccessToken();
-
-    if (!accessToken) {
-      throw new Error("Access token not found");
-    }
-
-    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
-
-    if (!hasExpired) {
-      const response = await axios.post(url, data, { headers: getHeaders(accessToken) });
-      return response;
-    } else {
-      console.log(`Your access token has expired: ${expiryDate}`);
-      throw new Error("Expired access token");
-    }
-  } catch (error: unknown) {
-    if (axios.isAxiosError(error)) {
-      console.error("Error during HTTP request:", error.response?.data || error.message);
-      throw error;
-    } else {
-      console.error("Unexpected error:", error);
-      throw new Error("Unexpected error occurred");
-    }
-  }
-}
-
-// Put JSON to URL and time the call
-export async function putRequest(url: string, data: string) {
-  try {
-    const accessToken = getAccessToken();
-
-    if (!accessToken) {
-      throw new Error("Access token not found");
-    }
-
-    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
-
-    if (!hasExpired) {
-      const response = await axios.put(url, data, { headers: getHeaders(accessToken) });
-      return response;
-    } else {
-      console.log(`Your access token has expired: ${expiryDate}`);
-      throw new Error("Expired access token");
-    }
-  } catch (error: unknown) {
-    if (axios.isAxiosError(error)) {
-      console.error("Error during HTTP request:", error.response?.data || error.message);
-      throw error;
-    } else {
-      console.error("Unexpected error:", error);
-      throw new Error("Unexpected error occurred");
-    }
-  }
-}
-
-// Get data from URL
-export async function getRequest(url: string) {
-  try {
-    const accessToken = getAccessToken();
-
-    if (!accessToken) {
-      throw new Error("Access token not found");
-    }
-
-    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
-
-    if (!hasExpired) {
-      const response = await axios.get(url, { headers: getHeaders(accessToken) });
-      return response;
-    } else {
-      console.log(`Your access token has expired: ${expiryDate}`);
-      throw new Error("Expired access token");
-    }
-  } catch (error: unknown) {
-    if (axios.isAxiosError(error)) {
-      console.error("Error during HTTP request:", error.response?.data || error.message);
-      throw error;
-    } else {
-      console.error("Unexpected error:", error);
-      throw new Error("Unexpected error occurred");
-    }
-  }
-}
-
-// Get access token from environment variables
-function getAccessToken() {
-  const debug = process.env.PYPWS_DEBUG;
-
-  let accessToken = process.env.PWS_ACCESS_TOKEN || process.env.PYPWS_ACCESS_TOKEN;
-
-  if (!accessToken) {
-    console.log(
-      "Access token not found. Please define an environment variable called PWS_ACCESS_TOKEN and set its value to your access token (downloaded from the Plant Web Services web site)."
-    );
-    return null;
-  }
-
-  // Migrate PYPWS_ACCESS_TOKEN if needed
-  if (process.env.PYPWS_ACCESS_TOKEN && !process.env.PWS_ACCESS_TOKEN) {
-    console.log("Migrating PYPWS_ACCESS_TOKEN to PWS_ACCESS_TOKEN.");
-
-    process.env.PWS_ACCESS_TOKEN = process.env.PYPWS_ACCESS_TOKEN;
-    process.env.PYPWS_ACCESS_TOKEN = undefined;
-  }
-
-  // Debugging output
-  if (debug) {
-    console.log("Found access token in environment variable.");
-    const tokenInfo = getAccessTokenInfo(accessToken);
-    if (tokenInfo) {
-      const [platform, expiryDate, hasExpired] = tokenInfo;
-      console.log(`Platform: ${platform}. Expiry date: ${expiryDate}. Expired: ${hasExpired}`);
-    }
-  }
-
-  return accessToken;
-}
-
-// Get platform, expiry date and token expiration status
-function getAccessTokenInfo(accessToken: string): [string, string, boolean] {
-  const decoded = jwt.decode(accessToken);
-
-  // Ensure the token is valid and contains the expected properties
-  if (!decoded || typeof decoded !== "object" || !("exp" in decoded)) {
-    throw new Error("Invalid or malformed token");
-  }
-
-  const exp = decoded.exp as number;
-  const aud = decoded.aud as string | undefined;
-
-  if (typeof exp !== "number") {
-    throw new Error("Token does not have a valid expiration time");
-  }
-
-  const platform = aud || "unknown";
-  const expiryDate = new Date(exp * 1000).toISOString();
-  const hasExpired = Date.now() >= exp * 1000;
-
-  return [platform, expiryDate, hasExpired];
-}
-
-// Get API root URL
-function getApiRoot() {
-  const accessToken = getAccessToken();
-  const devMode = process.env.DEV_MODE || false;
-
-  if (accessToken) {
-    const [platform] = getAccessTokenInfo(accessToken);
-
-    // Determine API root based on devMode
-    const apiTarget = devMode ? "/api/" : `${platform}/api/`;
-
-    if (process.env.PYPWS_DEBUG) {
-      console.log(`Dev Mode: ${devMode}, API Target: ${apiTarget}`);
-    }
-
-    return apiTarget;
-  }
-
-  if (process.env.PYPWS_DEBUG) {
-    console.warn("Access token not found. Falling back to REST_API_URI.");
-  }
-
-  return REST_API_URI;
-}
-
-// Get API version
-function getApiVersion() {
-  return process.env.PYPWS_API_VERSION || REST_API_VERSION;
-}
-
-// Get analytics API target URL
-export function getAnalyticsApiTarget() {
-  return `${getApiRoot()}analytics/v${getApiVersion()}/`;
-}
-
-// Get materials API target URL
-export function getMaterialsApiTarget() {
-  return `${getApiRoot()}materials-storage/v${getApiVersion()}/`;
-}
-
-// Get client alias ID
-export function getClientAliasId() {
-  return process.env.PYPWS_CLIENT_ALIAS_ID || PWS_CLIENT_ID;
-}
-
-// Convert snake_case to camelCase
-export function convertSnakeCaseToCamelCase(snakeStr: string) {
-  return snakeStr.replace(/_./g, (s) => s.charAt(1).toUpperCase());
-}
-
-// Convert camelCase to snake_case
-export function convertCamelCaseToSnakeCase(camelStr: string) {
-  return camelStr.replace(/([a-z])([A-Z])/g, "$1_$2").toLowerCase();
+/***********************************************************************
+ * This file has been auto-generated by a code generation tool.
+ * Version:   1.0.0
+ * Date/time: 30 Jan 2025 11:43:04
+ * Template:  templates/typescriptpws/utilities.razor.
+ ***********************************************************************/
+
+import jwt from "jsonwebtoken";
+import axios, { AxiosResponse } from "axios";
+
+import { REST_API_URI, PWS_CLIENT_ID, REST_API_VERSION } from "./constants";
+
+// Get headers for requests
+function getHeaders(accessToken: string) {
+  return {
+    "Content-Type": "application/json",
+    Authorization: `Bearer ${accessToken}`,
+  };
+}
+
+// Post JSON to URL and time the call
+export async function postRequest(url: string, data: string): Promise<AxiosResponse> {
+  try {
+    const accessToken = getAccessToken();
+
+    if (!accessToken) {
+      throw new Error("Access token not found");
+    }
+
+    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
+
+    if (!hasExpired) {
+      const response = await axios.post(url, data, { headers: getHeaders(accessToken) });
+      return response;
+    } else {
+      console.log(`Your access token has expired: ${expiryDate}`);
+      throw new Error("Expired access token");
+    }
+  } catch (error: unknown) {
+    if (axios.isAxiosError(error)) {
+      console.error("Error during HTTP request:", error.response?.data || error.message);
+      throw error;
+    } else {
+      console.error("Unexpected error:", error);
+      throw new Error("Unexpected error occurred");
+    }
+  }
+}
+
+// Put JSON to URL and time the call
+export async function putRequest(url: string, data: string) {
+  try {
+    const accessToken = getAccessToken();
+
+    if (!accessToken) {
+      throw new Error("Access token not found");
+    }
+
+    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
+
+    if (!hasExpired) {
+      const response = await axios.put(url, data, { headers: getHeaders(accessToken) });
+      return response;
+    } else {
+      console.log(`Your access token has expired: ${expiryDate}`);
+      throw new Error("Expired access token");
+    }
+  } catch (error: unknown) {
+    if (axios.isAxiosError(error)) {
+      console.error("Error during HTTP request:", error.response?.data || error.message);
+      throw error;
+    } else {
+      console.error("Unexpected error:", error);
+      throw new Error("Unexpected error occurred");
+    }
+  }
+}
+
+// Get data from URL
+export async function getRequest(url: string) {
+  try {
+    const accessToken = getAccessToken();
+
+    if (!accessToken) {
+      throw new Error("Access token not found");
+    }
+
+    const [, expiryDate, hasExpired] = getAccessTokenInfo(accessToken);
+
+    if (!hasExpired) {
+      const response = await axios.get(url, { headers: getHeaders(accessToken) });
+      return response;
+    } else {
+      console.log(`Your access token has expired: ${expiryDate}`);
+      throw new Error("Expired access token");
+    }
+  } catch (error: unknown) {
+    if (axios.isAxiosError(error)) {
+      console.error("Error during HTTP request:", error.response?.data || error.message);
+      throw error;
+    } else {
+      console.error("Unexpected error:", error);
+      throw new Error("Unexpected error occurred");
+    }
+  }
+}
+
+// Get access token from environment variables
+function getAccessToken() {
+  const debug = process.env.PYPWS_DEBUG;
+
+  let accessToken = process.env.PWS_ACCESS_TOKEN || process.env.PYPWS_ACCESS_TOKEN;
+
+  if (!accessToken) {
+    console.log(
+      "Access token not found. Please define an environment variable called PWS_ACCESS_TOKEN and set its value to your access token (downloaded from the Plant Web Services web site)."
+    );
+    return null;
+  }
+
+  // Migrate PYPWS_ACCESS_TOKEN if needed
+  if (process.env.PYPWS_ACCESS_TOKEN && !process.env.PWS_ACCESS_TOKEN) {
+    console.log("Migrating PYPWS_ACCESS_TOKEN to PWS_ACCESS_TOKEN.");
+
+    process.env.PWS_ACCESS_TOKEN = process.env.PYPWS_ACCESS_TOKEN;
+    process.env.PYPWS_ACCESS_TOKEN = undefined;
+  }
+
+  // Debugging output
+  if (debug) {
+    console.log("Found access token in environment variable.");
+    const tokenInfo = getAccessTokenInfo(accessToken);
+    if (tokenInfo) {
+      const [platform, expiryDate, hasExpired] = tokenInfo;
+      console.log(`Platform: ${platform}. Expiry date: ${expiryDate}. Expired: ${hasExpired}`);
+    }
+  }
+
+  return accessToken;
+}
+
+// Get platform, expiry date and token expiration status
+function getAccessTokenInfo(accessToken: string): [string, string, boolean] {
+  const decoded = jwt.decode(accessToken);
+
+  // Ensure the token is valid and contains the expected properties
+  if (!decoded || typeof decoded !== "object" || !("exp" in decoded)) {
+    throw new Error("Invalid or malformed token");
+  }
+
+  const exp = decoded.exp as number;
+  const aud = decoded.aud as string | undefined;
+
+  if (typeof exp !== "number") {
+    throw new Error("Token does not have a valid expiration time");
+  }
+
+  const platform = aud || "unknown";
+  const expiryDate = new Date(exp * 1000).toISOString();
+  const hasExpired = Date.now() >= exp * 1000;
+
+  return [platform, expiryDate, hasExpired];
+}
+
+// Get API root URL
+function getApiRoot() {
+  const accessToken = getAccessToken();
+  const devMode = process.env.DEV_MODE || false;
+
+  if (accessToken) {
+    const [platform] = getAccessTokenInfo(accessToken);
+
+    // Determine API root based on devMode
+    const apiTarget = devMode ? "/api/" : `${platform}/api/`;
+
+    if (process.env.PYPWS_DEBUG) {
+      console.log(`Dev Mode: ${devMode}, API Target: ${apiTarget}`);
+    }
+
+    return apiTarget;
+  }
+
+  if (process.env.PYPWS_DEBUG) {
+    console.warn("Access token not found. Falling back to REST_API_URI.");
+  }
+
+  return REST_API_URI;
+}
+
+// Get API version
+function getApiVersion() {
+  return process.env.PYPWS_API_VERSION || REST_API_VERSION;
+}
+
+// Get analytics API target URL
+export function getAnalyticsApiTarget() {
+  return `${getApiRoot()}analytics/v${getApiVersion()}/`;
+}
+
+// Get materials API target URL
+export function getMaterialsApiTarget() {
+  return `${getApiRoot()}materials-storage/v${getApiVersion()}/`;
+}
+
+// Get client alias ID
+export function getClientAliasId() {
+  return process.env.PYPWS_CLIENT_ALIAS_ID || PWS_CLIENT_ID;
+}
+
+// Convert snake_case to camelCase
+export function convertSnakeCaseToCamelCase(snakeStr: string) {
+  return snakeStr.replace(/_./g, (s) => s.charAt(1).toUpperCase());
+}
+
+// Convert camelCase to snake_case
+export function convertCamelCaseToSnakeCase(camelStr: string) {
+  return camelStr.replace(/([a-z])([A-Z])/g, "$1_$2").toLowerCase();
 }