@azure/storage-queue 12.29.0 → 12.30.0-beta.1

package/dist/esm/utils/utils.common.js

@@ -1,362 +1,251 @@
 import { createHttpHeaders } from "@azure/core-rest-pipeline";
-import { HeaderConstants, URLConstants, DevelopmentConnectionString, PathStylePorts, } from "./constants.js";
-/**
- * Append a string to URL path. Will remove duplicated "/" in front of the string
- * when URL path ends with a "/".
- *
- * @param url - Source URL string
- * @param name - String to be appended to URL
- * @returns An updated URL string
- */
-export function appendToURLPath(url, name) {
+import {
+  HeaderConstants,
+  URLConstants,
+  DevelopmentConnectionString,
+  PathStylePorts
+} from "./constants.js";
+function appendToURLPath(url, name) {
+  const urlParsed = new URL(url);
+  let path = urlParsed.pathname;
+  path = path ? path.endsWith("/") ? `${path}${name}` : `${path}/${name}` : name;
+  urlParsed.pathname = path;
+  return urlParsed.toString();
+}
+function setURLParameter(url, name, value) {
+  const urlParsed = new URL(url);
+  const encodedName = encodeURIComponent(name);
+  const encodedValue = value ? encodeURIComponent(value) : void 0;
+  const searchString = urlParsed.search === "" ? "?" : urlParsed.search;
+  const searchPieces = [];
+  for (const pair of searchString.slice(1).split("&")) {
+    if (pair) {
+      const [key] = pair.split("=", 2);
+      if (key !== encodedName) {
+        searchPieces.push(pair);
+      }
+    }
+  }
+  if (encodedValue) {
+    searchPieces.push(`${encodedName}=${encodedValue}`);
+  }
+  urlParsed.search = searchPieces.length ? `?${searchPieces.join("&")}` : "";
+  return urlParsed.toString();
+}
+function getURLParameter(url, name) {
+  const urlParsed = new URL(url);
+  return urlParsed.searchParams.get(name) ?? void 0;
+}
+function setURLHost(url, host) {
+  const urlParsed = new URL(url);
+  urlParsed.hostname = host;
+  return urlParsed.toString();
+}
+function getURLPath(url) {
+  try {
     const urlParsed = new URL(url);
-    let path = urlParsed.pathname;
-    path = path ? (path.endsWith("/") ? `${path}${name}` : `${path}/${name}`) : name;
-    urlParsed.pathname = path;
-    return urlParsed.toString();
-}
-/**
- * Set URL parameter name and value. If name exists in URL parameters, old value
- * will be replaced by name key. If not provide value, the parameter will be deleted.
- *
- * @param url - Source URL string
- * @param name - Parameter name
- * @param value - Parameter value
- * @returns An updated URL string
- */
-export function setURLParameter(url, name, value) {
-    const urlParsed = new URL(url);
-    const encodedName = encodeURIComponent(name);
-    const encodedValue = value ? encodeURIComponent(value) : undefined;
-    // mutating searchParams will change the encoding, so we have to do this ourselves
-    const searchString = urlParsed.search === "" ? "?" : urlParsed.search;
-    const searchPieces = [];
-    for (const pair of searchString.slice(1).split("&")) {
-        if (pair) {
-            const [key] = pair.split("=", 2);
-            if (key !== encodedName) {
-                searchPieces.push(pair);
-            }
-        }
-    }
-    if (encodedValue) {
-        searchPieces.push(`${encodedName}=${encodedValue}`);
-    }
-    urlParsed.search = searchPieces.length ? `?${searchPieces.join("&")}` : "";
-    return urlParsed.toString();
-}
-/**
- * Get URL parameter by name.
- *
- * @param url - URL string
- * @param name - Parameter name
- * @returns Parameter value(s) for the given parameter name.
- */
-export function getURLParameter(url, name) {
-    const urlParsed = new URL(url);
-    return urlParsed.searchParams.get(name) ?? undefined;
-}
-/**
- * Set URL host.
- *
- * @param url - Source URL string
- * @param host - New host string
- * @returns An updated URL string
- */
-export function setURLHost(url, host) {
-    const urlParsed = new URL(url);
-    urlParsed.hostname = host;
-    return urlParsed.toString();
-}
-/**
- * Gets URL path from an URL string.
- *
- * @param url - Source URL string
- * @returns The path part of the given URL string.
- */
-export function getURLPath(url) {
-    try {
-        const urlParsed = new URL(url);
-        return urlParsed.pathname;
-    }
-    catch (e) {
-        return undefined;
-    }
-}
-/**
- * Gets URL query key value pairs from an URL string.
- *
- * @param url -
- * @returns query key value string pairs from the given URL string.
- */
-export function getURLQueries(url) {
-    let queryString = new URL(url).search;
-    if (!queryString) {
-        return {};
-    }
-    queryString = queryString.trim();
-    queryString = queryString.startsWith("?") ? queryString.substring(1) : queryString;
-    let querySubStrings = queryString.split("&");
-    querySubStrings = querySubStrings.filter((value) => {
-        const indexOfEqual = value.indexOf("=");
-        const lastIndexOfEqual = value.lastIndexOf("=");
-        return (indexOfEqual > 0 && indexOfEqual === lastIndexOfEqual && lastIndexOfEqual < value.length - 1);
-    });
-    const queries = {};
-    for (const querySubString of querySubStrings) {
-        const splitResults = querySubString.split("=");
-        const key = splitResults[0];
-        const value = splitResults[1];
-        queries[key] = value;
-    }
-    return queries;
+    return urlParsed.pathname;
+  } catch (e) {
+    return void 0;
+  }
+}
+function getURLQueries(url) {
+  let queryString = new URL(url).search;
+  if (!queryString) {
+    return {};
+  }
+  queryString = queryString.trim();
+  queryString = queryString.startsWith("?") ? queryString.substring(1) : queryString;
+  let querySubStrings = queryString.split("&");
+  querySubStrings = querySubStrings.filter((value) => {
+    const indexOfEqual = value.indexOf("=");
+    const lastIndexOfEqual = value.lastIndexOf("=");
+    return indexOfEqual > 0 && indexOfEqual === lastIndexOfEqual && lastIndexOfEqual < value.length - 1;
+  });
+  const queries = {};
+  for (const querySubString of querySubStrings) {
+    const splitResults = querySubString.split("=");
+    const key = splitResults[0];
+    const value = splitResults[1];
+    queries[key] = value;
+  }
+  return queries;
 }
 function getProxyUriFromDevConnString(connectionString) {
-    // Development Connection String
-    // https://learn.microsoft.com/azure/storage/common/storage-configure-connection-string#connect-to-the-emulator-account-using-the-well-known-account-name-and-key
-    let proxyUri = "";
-    if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
-        // CONNECTION_STRING=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri
-        const matchCredentials = connectionString.split(";");
-        for (const element of matchCredentials) {
-            if (element.trim().startsWith("DevelopmentStorageProxyUri=")) {
-                proxyUri = element.trim().match("DevelopmentStorageProxyUri=(.*)")[1];
-            }
-        }
-    }
-    return proxyUri;
-}
-/**
- *
- * @param connectionString - Account connection string.
- * @param argument - property to get value from the connection string.
- * @returns Value of the property specified in argument.
- */
-export function getValueInConnString(connectionString, argument) {
-    const elements = connectionString.split(";");
-    for (const element of elements) {
-        if (element.trim().startsWith(argument)) {
-            return element.trim().match(argument + "=(.*)")[1];
-        }
-    }
-    return "";
-}
-/**
- * Extracts the parts of an Azure Storage account connection string.
- *
- * @param connectionString - Connection string.
- * @returns String key value pairs of the storage account's url and credentials.
- */
-export function extractConnectionStringParts(connectionString) {
-    let proxyUri = "";
-    if (connectionString.startsWith("UseDevelopmentStorage=true")) {
-        // Development connection string
-        proxyUri = getProxyUriFromDevConnString(connectionString);
-        connectionString = DevelopmentConnectionString;
-    }
-    // Matching QueueEndpoint in the Account connection string
-    let queueEndpoint = getValueInConnString(connectionString, "QueueEndpoint");
-    // Slicing off '/' at the end if exists
-    // (The methods that use `extractConnectionStringParts` expect the url to not have `/` at the end)
-    queueEndpoint = queueEndpoint.endsWith("/") ? queueEndpoint.slice(0, -1) : queueEndpoint;
-    if (connectionString.search("DefaultEndpointsProtocol=") !== -1 &&
-        connectionString.search("AccountKey=") !== -1) {
-        // Account connection string
-        let defaultEndpointsProtocol = "";
-        let accountName = "";
-        let accountKey = Buffer.from("accountKey", "base64");
-        let endpointSuffix = "";
-        // Get account name and key
-        accountName = getValueInConnString(connectionString, "AccountName");
-        accountKey = Buffer.from(getValueInConnString(connectionString, "AccountKey"), "base64");
-        if (!queueEndpoint) {
-            // QueueEndpoint is not present in the Account connection string
-            // Can be obtained from `${defaultEndpointsProtocol}://${accountName}.queue.${endpointSuffix}`
-            defaultEndpointsProtocol = getValueInConnString(connectionString, "DefaultEndpointsProtocol");
-            const protocol = defaultEndpointsProtocol.toLowerCase();
-            if (protocol !== "https" && protocol !== "http") {
-                throw new Error("Invalid DefaultEndpointsProtocol in the provided Connection String. Expecting 'https' or 'http'");
-            }
-            endpointSuffix = getValueInConnString(connectionString, "EndpointSuffix");
-            if (!endpointSuffix) {
-                throw new Error("Invalid EndpointSuffix in the provided Connection String");
-            }
-            queueEndpoint = `${defaultEndpointsProtocol}://${accountName}.queue.${endpointSuffix}`;
-        }
-        if (!accountName) {
-            throw new Error("Invalid AccountName in the provided Connection String");
-        }
-        else if (accountKey.length === 0) {
-            throw new Error("Invalid AccountKey in the provided Connection String");
-        }
-        return {
-            kind: "AccountConnString",
-            url: queueEndpoint,
-            accountName,
-            accountKey,
-            proxyUri,
-        };
-    }
-    else {
-        // SAS connection string
-        const accountSas = getValueInConnString(connectionString, "SharedAccessSignature");
-        let accountName = getValueInConnString(connectionString, "AccountName");
-        // if accountName is empty, try to read it from BlobEndpoint
-        if (!accountName) {
-            accountName = getAccountNameFromUrl(queueEndpoint);
-        }
-        if (!queueEndpoint) {
-            throw new Error("Invalid QueueEndpoint in the provided SAS Connection String");
-        }
-        else if (!accountSas) {
-            throw new Error("Invalid SharedAccessSignature in the provided SAS Connection String");
-        }
-        return { kind: "SASConnString", url: queueEndpoint, accountName, accountSas };
-    }
-}
-/**
- * Rounds a date off to seconds.
- *
- * @param date -
- * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned;
- *                                          If false, YYYY-MM-DDThh:mm:ssZ will be returned.
- * @returns Date string in ISO8061 format, with or without 7 milliseconds component
- */
-export function truncatedISO8061Date(date, withMilliseconds = true) {
-    // Date.toISOString() will return like "2018-10-29T06:34:36.139Z"
-    const dateString = date.toISOString();
-    return withMilliseconds
-        ? dateString.substring(0, dateString.length - 1) + "0000" + "Z"
-        : dateString.substring(0, dateString.length - 5) + "Z";
-}
-/**
- * Delay specified time interval.
- *
- * @param timeInMs -
- * @param aborter -
- * @param abortError -
- */
-export async function delay(timeInMs, aborter, abortError) {
-    return new Promise((resolve, reject) => {
-        /* eslint-disable-next-line prefer-const*/
-        let timeout;
-        const abortHandler = () => {
-            if (timeout !== undefined) {
-                clearTimeout(timeout);
-            }
-            reject(abortError);
-        };
-        const resolveHandler = () => {
-            if (aborter !== undefined) {
-                aborter.removeEventListener("abort", abortHandler);
-            }
-            resolve();
-        };
-        timeout = setTimeout(resolveHandler, timeInMs);
-        if (aborter !== undefined) {
-            aborter.addEventListener("abort", abortHandler);
-        }
-    });
-}
-/**
- * Sanitizes a url by removing the Signature parameter
- * @param url - to sanitize
- * @returns sanitized string
- */
-export function sanitizeURL(url) {
-    let safeURL = url;
-    if (getURLParameter(safeURL, URLConstants.Parameters.SIGNATURE)) {
-        safeURL = setURLParameter(safeURL, URLConstants.Parameters.SIGNATURE, "*****");
-    }
-    return safeURL;
-}
-/**
- * Sanitize headers by removing sensitive values such as AUTHORIZATION and X_MS_COPY_SOURCE
- * @param originalHeader - original headers
- * @returns sanitized headers
- */
-export function sanitizeHeaders(originalHeader) {
-    const headers = createHttpHeaders();
-    for (const [name, value] of originalHeader) {
-        if (name.toLowerCase() === HeaderConstants.AUTHORIZATION) {
-            headers.set(name, "*****");
-        }
-        else if (name.toLowerCase() === HeaderConstants.X_MS_COPY_SOURCE) {
-            headers.set(name, sanitizeURL(value));
-        }
-        else {
-            headers.set(name, value);
-        }
-    }
-    return headers;
-}
-/**
- * Extracts account name from the url
- * @param url - url to extract the account name from
- * @returns with the account name
- */
-export function getAccountNameFromUrl(url) {
-    const parsedUrl = new URL(url);
-    let accountName;
-    try {
-        if (parsedUrl.hostname.split(".")[1] === "queue") {
-            // `${defaultEndpointsProtocol}://${accountName}.queue.${endpointSuffix}`;
-            accountName = parsedUrl.hostname.split(".")[0];
-        }
-        else if (isIpEndpointStyle(parsedUrl)) {
-            // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/
-            // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/
-            // .getPath() -> /devstoreaccount1/
-            accountName = parsedUrl.pathname.split("/")[1];
-        }
-        else {
-            // Custom domain case: "https://customdomain.com/containername/blob".
-            accountName = "";
-        }
-        return accountName;
-    }
-    catch (error) {
-        throw new Error("Unable to extract accountName with provided information.");
-    }
-}
-export function isIpEndpointStyle(parsedUrl) {
-    const host = parsedUrl.host;
-    // Case 1: Ipv6, use a broad regex to find out candidates whose host contains two ':'.
-    // Case 2: localhost(:port) or host.docker.internal, use broad regex to match port part.
-    // Case 3: Ipv4, use broad regex which just check if host contains Ipv4.
-    // For valid host please refer to https://man7.org/linux/man-pages/man7/hostname.7.html.
-    return (/^.*:.*:.*$|^(localhost|host.docker.internal)(:[0-9]+)?$|^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])){3}(:[0-9]+)?$/.test(host) ||
-        (Boolean(parsedUrl.port) && PathStylePorts.includes(parsedUrl.port)));
-}
-/**
- * Append a string to URL query.
- *
- * @param url - Source URL string.
- * @param queryParts - String to be appended to the URL query.
- * @returns An updated URL string.
- */
-export function appendToURLQuery(url, queryParts) {
-    const urlParsed = new URL(url);
-    let query = urlParsed.search;
-    if (query) {
-        query += "&" + queryParts;
-    }
-    else {
-        query = queryParts;
-    }
-    urlParsed.search = query;
-    return urlParsed.toString();
-}
-/**
- * A typesafe helper for ensuring that a given response object has
- * the original _response attached.
- * @param response - A response object from calling a client operation
- * @returns The same object, but with known _response property
- */
-export function assertResponse(response) {
-    if (`_response` in response) {
-        return response;
-    }
-    throw new TypeError(`Unexpected response object ${response}`);
-}
-//# sourceMappingURL=utils.common.js.map
+  let proxyUri = "";
+  if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
+    const matchCredentials = connectionString.split(";");
+    for (const element of matchCredentials) {
+      if (element.trim().startsWith("DevelopmentStorageProxyUri=")) {
+        proxyUri = element.trim().match("DevelopmentStorageProxyUri=(.*)")[1];
+      }
+    }
+  }
+  return proxyUri;
+}
+function getValueInConnString(connectionString, argument) {
+  const elements = connectionString.split(";");
+  for (const element of elements) {
+    if (element.trim().startsWith(argument)) {
+      return element.trim().match(argument + "=(.*)")[1];
+    }
+  }
+  return "";
+}
+function extractConnectionStringParts(connectionString) {
+  let proxyUri = "";
+  if (connectionString.startsWith("UseDevelopmentStorage=true")) {
+    proxyUri = getProxyUriFromDevConnString(connectionString);
+    connectionString = DevelopmentConnectionString;
+  }
+  let queueEndpoint = getValueInConnString(connectionString, "QueueEndpoint");
+  queueEndpoint = queueEndpoint.endsWith("/") ? queueEndpoint.slice(0, -1) : queueEndpoint;
+  if (connectionString.search("DefaultEndpointsProtocol=") !== -1 && connectionString.search("AccountKey=") !== -1) {
+    let defaultEndpointsProtocol = "";
+    let accountName = "";
+    let accountKey = Buffer.from("accountKey", "base64");
+    let endpointSuffix = "";
+    accountName = getValueInConnString(connectionString, "AccountName");
+    accountKey = Buffer.from(getValueInConnString(connectionString, "AccountKey"), "base64");
+    if (!queueEndpoint) {
+      defaultEndpointsProtocol = getValueInConnString(connectionString, "DefaultEndpointsProtocol");
+      const protocol = defaultEndpointsProtocol.toLowerCase();
+      if (protocol !== "https" && protocol !== "http") {
+        throw new Error(
+          "Invalid DefaultEndpointsProtocol in the provided Connection String. Expecting 'https' or 'http'"
+        );
+      }
+      endpointSuffix = getValueInConnString(connectionString, "EndpointSuffix");
+      if (!endpointSuffix) {
+        throw new Error("Invalid EndpointSuffix in the provided Connection String");
+      }
+      queueEndpoint = `${defaultEndpointsProtocol}://${accountName}.queue.${endpointSuffix}`;
+    }
+    if (!accountName) {
+      throw new Error("Invalid AccountName in the provided Connection String");
+    } else if (accountKey.length === 0) {
+      throw new Error("Invalid AccountKey in the provided Connection String");
+    }
+    return {
+      kind: "AccountConnString",
+      url: queueEndpoint,
+      accountName,
+      accountKey,
+      proxyUri
+    };
+  } else {
+    const accountSas = getValueInConnString(connectionString, "SharedAccessSignature");
+    let accountName = getValueInConnString(connectionString, "AccountName");
+    if (!accountName) {
+      accountName = getAccountNameFromUrl(queueEndpoint);
+    }
+    if (!queueEndpoint) {
+      throw new Error("Invalid QueueEndpoint in the provided SAS Connection String");
+    } else if (!accountSas) {
+      throw new Error("Invalid SharedAccessSignature in the provided SAS Connection String");
+    }
+    return { kind: "SASConnString", url: queueEndpoint, accountName, accountSas };
+  }
+}
+function truncatedISO8061Date(date, withMilliseconds = true) {
+  const dateString = date.toISOString();
+  return withMilliseconds ? dateString.substring(0, dateString.length - 1) + "0000Z" : dateString.substring(0, dateString.length - 5) + "Z";
+}
+async function delay(timeInMs, aborter, abortError) {
+  return new Promise((resolve, reject) => {
+    let timeout;
+    const abortHandler = () => {
+      if (timeout !== void 0) {
+        clearTimeout(timeout);
+      }
+      reject(abortError);
+    };
+    const resolveHandler = () => {
+      if (aborter !== void 0) {
+        aborter.removeEventListener("abort", abortHandler);
+      }
+      resolve();
+    };
+    timeout = setTimeout(resolveHandler, timeInMs);
+    if (aborter !== void 0) {
+      aborter.addEventListener("abort", abortHandler);
+    }
+  });
+}
+function sanitizeURL(url) {
+  let safeURL = url;
+  if (getURLParameter(safeURL, URLConstants.Parameters.SIGNATURE)) {
+    safeURL = setURLParameter(safeURL, URLConstants.Parameters.SIGNATURE, "*****");
+  }
+  return safeURL;
+}
+function sanitizeHeaders(originalHeader) {
+  const headers = createHttpHeaders();
+  for (const [name, value] of originalHeader) {
+    if (name.toLowerCase() === HeaderConstants.AUTHORIZATION) {
+      headers.set(name, "*****");
+    } else if (name.toLowerCase() === HeaderConstants.X_MS_COPY_SOURCE) {
+      headers.set(name, sanitizeURL(value));
+    } else {
+      headers.set(name, value);
+    }
+  }
+  return headers;
+}
+function getAccountNameFromUrl(url) {
+  const parsedUrl = new URL(url);
+  let accountName;
+  try {
+    if (parsedUrl.hostname.split(".")[1] === "queue") {
+      accountName = parsedUrl.hostname.split(".")[0];
+    } else if (isIpEndpointStyle(parsedUrl)) {
+      accountName = parsedUrl.pathname.split("/")[1];
+    } else {
+      accountName = "";
+    }
+    return accountName;
+  } catch (error) {
+    throw new Error("Unable to extract accountName with provided information.");
+  }
+}
+function isIpEndpointStyle(parsedUrl) {
+  const host = parsedUrl.host;
+  return /^.*:.*:.*$|^(localhost|host.docker.internal)(:[0-9]+)?$|^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])){3}(:[0-9]+)?$/.test(
+    host
+  ) || Boolean(parsedUrl.port) && PathStylePorts.includes(parsedUrl.port);
+}
+function appendToURLQuery(url, queryParts) {
+  const urlParsed = new URL(url);
+  let query = urlParsed.search;
+  if (query) {
+    query += "&" + queryParts;
+  } else {
+    query = queryParts;
+  }
+  urlParsed.search = query;
+  return urlParsed.toString();
+}
+function assertResponse(response) {
+  if (`_response` in response) {
+    return response;
+  }
+  throw new TypeError(`Unexpected response object ${response}`);
+}
+export {
+  appendToURLPath,
+  appendToURLQuery,
+  assertResponse,
+  delay,
+  extractConnectionStringParts,
+  getAccountNameFromUrl,
+  getURLParameter,
+  getURLPath,
+  getURLQueries,
+  getValueInConnString,
+  isIpEndpointStyle,
+  sanitizeHeaders,
+  sanitizeURL,
+  setURLHost,
+  setURLParameter,
+  truncatedISO8061Date
+};