@azure/storage-file-share 12.27.0 → 12.28.0-beta.1

package/dist/commonjs/utils/constants.js

@@ -0,0 +1,165 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathStylePorts = exports.StorageFileLoggingAllowedQueryParameters = exports.StorageFileLoggingAllowedHeaderNames = exports.FileAttributesNone = exports.FileAttributesPreserve = exports.ETagAny = exports.ETagNone = exports.HeaderConstants = exports.HttpUrlConnection = exports.URLConstants = exports.StorageOAuthScopes = exports.REQUEST_TIMEOUT = exports.DEFAULT_HIGH_LEVEL_CONCURRENCY = exports.DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS = exports.FILE_RANGE_MAX_SIZE_BYTES = exports.FILE_MAX_SIZE_BYTES = exports.SERVICE_VERSION = exports.SDK_VERSION = void 0;
+exports.SDK_VERSION = "12.28.0-beta.1";
+exports.SERVICE_VERSION = "2025-07-05";
+exports.FILE_MAX_SIZE_BYTES = 4 * 1024 * 1024 * 1024 * 1024; // 4TB
+exports.FILE_RANGE_MAX_SIZE_BYTES = 4 * 1024 * 1024; // 4MB
+exports.DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS = 5;
+exports.DEFAULT_HIGH_LEVEL_CONCURRENCY = 5;
+exports.REQUEST_TIMEOUT = 100 * 1000; // In ms
+/**
+ * The OAuth scope to use with Azure Storage.
+ */
+exports.StorageOAuthScopes = "https://storage.azure.com/.default";
+exports.URLConstants = {
+    Parameters: {
+        FORCE_BROWSER_NO_CACHE: "_",
+        SHARE_SNAPSHOT: "sharesnapshot",
+        SIGNATURE: "sig",
+        TIMEOUT: "timeout",
+    },
+};
+exports.HttpUrlConnection = {
+    HTTP_CONFLICT: 409,
+    HTTP_NOT_FOUND: 404,
+    HTTP_PRECON_FAILED: 412,
+    HTTP_RANGE_NOT_SATISFIABLE: 416,
+};
+exports.HeaderConstants = {
+    AUTHORIZATION: "authorization",
+    AUTHORIZATION_SCHEME: "Bearer",
+    CONTENT_ENCODING: "content-encoding",
+    CONTENT_LANGUAGE: "content-language",
+    CONTENT_LENGTH: "content-length",
+    CONTENT_MD5: "content-md5",
+    CONTENT_TYPE: "content-type",
+    COOKIE: "Cookie",
+    DATE: "date",
+    IF_MATCH: "if-match",
+    IF_MODIFIED_SINCE: "if-modified-since",
+    IF_NONE_MATCH: "if-none-match",
+    IF_UNMODIFIED_SINCE: "if-unmodified-since",
+    PREFIX_FOR_STORAGE: "x-ms-",
+    RANGE: "Range",
+    USER_AGENT: "User-Agent",
+    X_MS_CLIENT_REQUEST_ID: "x-ms-client-request-id",
+    X_MS_COPY_SOURCE: "x-ms-copy-source",
+    X_MS_CopySourceErrorCode: "x-ms-copy-source-error-code",
+    X_MS_DATE: "x-ms-date",
+};
+exports.ETagNone = "";
+exports.ETagAny = "*";
+exports.FileAttributesPreserve = "Preserve";
+exports.FileAttributesNone = "None";
+exports.StorageFileLoggingAllowedHeaderNames = [
+    "Access-Control-Allow-Origin",
+    "Cache-Control",
+    "Content-Length",
+    "Content-Type",
+    "Date",
+    "Request-Id",
+    "traceparent",
+    "Transfer-Encoding",
+    "User-Agent",
+    "x-ms-client-request-id",
+    "x-ms-date",
+    "x-ms-error-code",
+    "x-ms-request-id",
+    "x-ms-return-client-request-id",
+    "x-ms-version",
+    "Accept-Ranges",
+    "Content-Disposition",
+    "Content-Encoding",
+    "Content-Language",
+    "Content-MD5",
+    "Content-Range",
+    "ETag",
+    "Last-Modified",
+    "Server",
+    "Vary",
+    "x-ms-content-crc64",
+    "x-ms-copy-action",
+    "x-ms-copy-completion-time",
+    "x-ms-copy-id",
+    "x-ms-copy-progress",
+    "x-ms-copy-status",
+    "x-ms-has-immutability-policy",
+    "x-ms-has-legal-hold",
+    "x-ms-lease-state",
+    "x-ms-lease-status",
+    "x-ms-range",
+    "x-ms-request-server-encrypted",
+    "x-ms-server-encrypted",
+    "x-ms-snapshot",
+    "x-ms-source-range",
+    "x-ms-cache-control",
+    "x-ms-content-disposition",
+    "x-ms-content-encoding",
+    "x-ms-content-language",
+    "x-ms-content-length",
+    "x-ms-content-md5",
+    "x-ms-content-type",
+    "x-ms-copy-source-error-code",
+    "x-ms-copy-source-status-code",
+    "x-ms-file-attributes",
+    "x-ms-file-change-time",
+    "x-ms-file-creation-time",
+    "x-ms-file-id",
+    "x-ms-file-last-write-time",
+    "x-ms-file-parent-id",
+    "x-ms-handle-id",
+    "x-ms-number-of-handles-closed",
+    "x-ms-recursive",
+    "x-ms-share-quota",
+    "x-ms-type",
+    "x-ms-write",
+];
+exports.StorageFileLoggingAllowedQueryParameters = [
+    "comp",
+    "maxresults",
+    "rscc",
+    "rscd",
+    "rsce",
+    "rscl",
+    "rsct",
+    "se",
+    "si",
+    "sip",
+    "sp",
+    "spr",
+    "sr",
+    "srt",
+    "ss",
+    "st",
+    "sv",
+    "copyid",
+    "restype",
+];
+/// List of ports used for path style addressing.
+/// Path style addressing means that storage account is put in URI's Path segment in instead of in host.
+exports.PathStylePorts = [
+    "10000",
+    "10001",
+    "10002",
+    "10003",
+    "10004",
+    "10100",
+    "10101",
+    "10102",
+    "10103",
+    "10104",
+    "11000",
+    "11001",
+    "11002",
+    "11003",
+    "11004",
+    "11100",
+    "11101",
+    "11102",
+    "11103",
+    "11104",
+];
+//# sourceMappingURL=constants.js.map

package/dist/commonjs/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAErB,QAAA,WAAW,GAAW,gBAAgB,CAAC;AACvC,QAAA,eAAe,GAAW,YAAY,CAAC;AAEvC,QAAA,mBAAmB,GAAW,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,MAAM;AACnE,QAAA,yBAAyB,GAAW,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,MAAM;AAC3D,QAAA,mCAAmC,GAAW,CAAC,CAAC;AAChD,QAAA,8BAA8B,GAAW,CAAC,CAAC;AAC3C,QAAA,eAAe,GAAW,GAAG,GAAG,IAAI,CAAC,CAAC,QAAQ;AAC3D;;GAEG;AACU,QAAA,kBAAkB,GAAsB,oCAAoC,CAAC;AAE7E,QAAA,YAAY,GAAG;IAC1B,UAAU,EAAE;QACV,sBAAsB,EAAE,GAAG;QAC3B,cAAc,EAAE,eAAe;QAC/B,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,SAAS;KACnB;CACF,CAAC;AAEW,QAAA,iBAAiB,GAAG;IAC/B,aAAa,EAAE,GAAG;IAClB,cAAc,EAAE,GAAG;IACnB,kBAAkB,EAAE,GAAG;IACvB,0BAA0B,EAAE,GAAG;CAChC,CAAC;AAEW,QAAA,eAAe,GAAG;IAC7B,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,QAAQ;IAC9B,gBAAgB,EAAE,kBAAkB;IACpC,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,mBAAmB;IACtC,aAAa,EAAE,eAAe;IAC9B,mBAAmB,EAAE,qBAAqB;IAC1C,kBAAkB,EAAE,OAAO;IAC3B,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,YAAY;IACxB,sBAAsB,EAAE,wBAAwB;IAChD,gBAAgB,EAAE,kBAAkB;IACpC,wBAAwB,EAAE,6BAA6B;IACvD,SAAS,EAAE,WAAW;CACvB,CAAC;AAEW,QAAA,QAAQ,GAAG,EAAE,CAAC;AACd,QAAA,OAAO,GAAG,GAAG,CAAC;AACd,QAAA,sBAAsB,GAAG,UAAU,CAAC;AACpC,QAAA,kBAAkB,GAAG,MAAM,CAAC;AAE5B,QAAA,oCAAoC,GAAG;IAClD,6BAA6B;IAC7B,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,MAAM;IACN,YAAY;IACZ,aAAa;IACb,mBAAmB;IACnB,YAAY;IACZ,wBAAwB;IACxB,WAAW;IACX,iBAAiB;IACjB,iBAAiB;IACjB,+BAA+B;IAC/B,cAAc;IACd,eAAe;IACf,qBAAqB;IACrB,kBAAkB;IAClB,kBAAkB;IAClB,aAAa;IACb,eAAe;IACf,MAAM;IACN,eAAe;IACf,QAAQ;IACR,MAAM;IACN,oBAAoB;IACpB,kBAAkB;IAClB,2BAA2B;IAC3B,cAAc;IACd,oBAAoB;IACpB,kBAAkB;IAClB,8BAA8B;IAC9B,qBAAqB;IACrB,kBAAkB;IAClB,mBAAmB;IACnB,YAAY;IACZ,+BAA+B;IAC/B,uBAAuB;IACvB,eAAe;IACf,mBAAmB;IACnB,oBAAoB;IACpB,0BAA0B;IAC1B,uBAAuB;IACvB,uBAAuB;IACvB,qBAAqB;IACrB,kBAAkB;IAClB,mBAAmB;IACnB,6BAA6B;IAC7B,8BAA8B;IAC9B,sBAAsB;IACtB,uBAAuB;IACvB,yBAAyB;IACzB,cAAc;IACd,2BAA2B;IAC3B,qBAAqB;IACrB,gBAAgB;IAChB,+BAA+B;IAC/B,gBAAgB;IAChB,kBAAkB;IAClB,WAAW;IACX,YAAY;CACb,CAAC;AAEW,QAAA,wCAAwC,GAAG;IACtD,MAAM;IACN,YAAY;IACZ,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,SAAS;CACV,CAAC;AAEF,iDAAiD;AACjD,wGAAwG;AAC3F,QAAA,cAAc,GAAG;IAC5B,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;CACR,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"12.28.0-beta.1\";\nexport const SERVICE_VERSION: string = \"2025-07-05\";\n\nexport const FILE_MAX_SIZE_BYTES: number = 4 * 1024 * 1024 * 1024 * 1024; // 4TB\nexport const FILE_RANGE_MAX_SIZE_BYTES: number = 4 * 1024 * 1024; // 4MB\nexport const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS: number = 5;\nexport const DEFAULT_HIGH_LEVEL_CONCURRENCY: number = 5;\nexport const REQUEST_TIMEOUT: number = 100 * 1000; // In ms\n/**\n * The OAuth scope to use with Azure Storage.\n */\nexport const StorageOAuthScopes: string | string[] = \"https://storage.azure.com/.default\";\n\nexport const URLConstants = {\n  Parameters: {\n    FORCE_BROWSER_NO_CACHE: \"_\",\n    SHARE_SNAPSHOT: \"sharesnapshot\",\n    SIGNATURE: \"sig\",\n    TIMEOUT: \"timeout\",\n  },\n};\n\nexport const HttpUrlConnection = {\n  HTTP_CONFLICT: 409,\n  HTTP_NOT_FOUND: 404,\n  HTTP_PRECON_FAILED: 412,\n  HTTP_RANGE_NOT_SATISFIABLE: 416,\n};\n\nexport const HeaderConstants = {\n  AUTHORIZATION: \"authorization\",\n  AUTHORIZATION_SCHEME: \"Bearer\",\n  CONTENT_ENCODING: \"content-encoding\",\n  CONTENT_LANGUAGE: \"content-language\",\n  CONTENT_LENGTH: \"content-length\",\n  CONTENT_MD5: \"content-md5\",\n  CONTENT_TYPE: \"content-type\",\n  COOKIE: \"Cookie\",\n  DATE: \"date\",\n  IF_MATCH: \"if-match\",\n  IF_MODIFIED_SINCE: \"if-modified-since\",\n  IF_NONE_MATCH: \"if-none-match\",\n  IF_UNMODIFIED_SINCE: \"if-unmodified-since\",\n  PREFIX_FOR_STORAGE: \"x-ms-\",\n  RANGE: \"Range\",\n  USER_AGENT: \"User-Agent\",\n  X_MS_CLIENT_REQUEST_ID: \"x-ms-client-request-id\",\n  X_MS_COPY_SOURCE: \"x-ms-copy-source\",\n  X_MS_CopySourceErrorCode: \"x-ms-copy-source-error-code\",\n  X_MS_DATE: \"x-ms-date\",\n};\n\nexport const ETagNone = \"\";\nexport const ETagAny = \"*\";\nexport const FileAttributesPreserve = \"Preserve\";\nexport const FileAttributesNone = \"None\";\n\nexport const StorageFileLoggingAllowedHeaderNames = [\n  \"Access-Control-Allow-Origin\",\n  \"Cache-Control\",\n  \"Content-Length\",\n  \"Content-Type\",\n  \"Date\",\n  \"Request-Id\",\n  \"traceparent\",\n  \"Transfer-Encoding\",\n  \"User-Agent\",\n  \"x-ms-client-request-id\",\n  \"x-ms-date\",\n  \"x-ms-error-code\",\n  \"x-ms-request-id\",\n  \"x-ms-return-client-request-id\",\n  \"x-ms-version\",\n  \"Accept-Ranges\",\n  \"Content-Disposition\",\n  \"Content-Encoding\",\n  \"Content-Language\",\n  \"Content-MD5\",\n  \"Content-Range\",\n  \"ETag\",\n  \"Last-Modified\",\n  \"Server\",\n  \"Vary\",\n  \"x-ms-content-crc64\",\n  \"x-ms-copy-action\",\n  \"x-ms-copy-completion-time\",\n  \"x-ms-copy-id\",\n  \"x-ms-copy-progress\",\n  \"x-ms-copy-status\",\n  \"x-ms-has-immutability-policy\",\n  \"x-ms-has-legal-hold\",\n  \"x-ms-lease-state\",\n  \"x-ms-lease-status\",\n  \"x-ms-range\",\n  \"x-ms-request-server-encrypted\",\n  \"x-ms-server-encrypted\",\n  \"x-ms-snapshot\",\n  \"x-ms-source-range\",\n  \"x-ms-cache-control\",\n  \"x-ms-content-disposition\",\n  \"x-ms-content-encoding\",\n  \"x-ms-content-language\",\n  \"x-ms-content-length\",\n  \"x-ms-content-md5\",\n  \"x-ms-content-type\",\n  \"x-ms-copy-source-error-code\",\n  \"x-ms-copy-source-status-code\",\n  \"x-ms-file-attributes\",\n  \"x-ms-file-change-time\",\n  \"x-ms-file-creation-time\",\n  \"x-ms-file-id\",\n  \"x-ms-file-last-write-time\",\n  \"x-ms-file-parent-id\",\n  \"x-ms-handle-id\",\n  \"x-ms-number-of-handles-closed\",\n  \"x-ms-recursive\",\n  \"x-ms-share-quota\",\n  \"x-ms-type\",\n  \"x-ms-write\",\n];\n\nexport const StorageFileLoggingAllowedQueryParameters = [\n  \"comp\",\n  \"maxresults\",\n  \"rscc\",\n  \"rscd\",\n  \"rsce\",\n  \"rscl\",\n  \"rsct\",\n  \"se\",\n  \"si\",\n  \"sip\",\n  \"sp\",\n  \"spr\",\n  \"sr\",\n  \"srt\",\n  \"ss\",\n  \"st\",\n  \"sv\",\n  \"copyid\",\n  \"restype\",\n];\n\n/// List of ports used for path style addressing.\n/// Path style addressing means that storage account is put in URI's Path segment in instead of in host.\nexport const PathStylePorts = [\n  \"10000\",\n  \"10001\",\n  \"10002\",\n  \"10003\",\n  \"10004\",\n  \"10100\",\n  \"10101\",\n  \"10102\",\n  \"10103\",\n  \"10104\",\n  \"11000\",\n  \"11001\",\n  \"11002\",\n  \"11003\",\n  \"11004\",\n  \"11100\",\n  \"11101\",\n  \"11102\",\n  \"11103\",\n  \"11104\",\n];\n"]}

package/dist/commonjs/utils/tracing.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Creates a span using the global tracer.
+ * @internal
+ */
+export declare const tracingClient: import("@azure/core-tracing").TracingClient;
+//# sourceMappingURL=tracing.d.ts.map

package/dist/commonjs/utils/tracing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../../src/utils/tracing.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,eAAO,MAAM,aAAa,6CAIxB,CAAC"}

package/dist/commonjs/utils/tracing.js

@@ -0,0 +1,17 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tracingClient = void 0;
+const core_tracing_1 = require("@azure/core-tracing");
+const constants_js_1 = require("./constants.js");
+/**
+ * Creates a span using the global tracer.
+ * @internal
+ */
+exports.tracingClient = (0, core_tracing_1.createTracingClient)({
+    packageName: "@azure/storage-file-share",
+    packageVersion: constants_js_1.SDK_VERSION,
+    namespace: "Microsoft.Storage",
+});
+//# sourceMappingURL=tracing.js.map

package/dist/commonjs/utils/tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../../src/utils/tracing.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,sDAA0D;AAC1D,iDAA6C;AAE7C;;;GAGG;AACU,QAAA,aAAa,GAAG,IAAA,kCAAmB,EAAC;IAC/C,WAAW,EAAE,2BAA2B;IACxC,cAAc,EAAE,0BAAW;IAC3B,SAAS,EAAE,mBAAmB;CAC/B,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createTracingClient } from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"./constants.js\";\n\n/**\n * Creates a span using the global tracer.\n * @internal\n */\nexport const tracingClient = createTracingClient({\n  packageName: \"@azure/storage-file-share\",\n  packageVersion: SDK_VERSION,\n  namespace: \"Microsoft.Storage\",\n});\n"]}

package/dist/commonjs/utils/utils.common.d.ts

@@ -0,0 +1,304 @@
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { HttpHeaders } from "@azure/core-rest-pipeline";
+import type { ListFilesAndDirectoriesSegmentResponse as ListFilesAndDirectoriesSegmentResponseInternal, ListHandlesResponse as ListHandlesResponseInternal, SharePermission, StringEncoded } from "../generated/src/models/index.js";
+import type { ListFilesAndDirectoriesSegmentResponse, ListHandlesResponse } from "../generatedModels.js";
+import type { HttpAuthorization, NfsFileMode, PosixRolePermissions } from "../models.js";
+import type { HttpHeadersLike, WebResourceLike } from "@azure/core-http-compat";
+/**
+ * Reserved URL characters must be properly escaped for Storage services like Blob or File.
+ *
+ * ## URL encode and escape strategy for JS SDKs
+ *
+ * When customers pass a URL string into XXXClient classes constructor, the URL string may already be URL encoded or not.
+ * But before sending to Azure Storage server, the URL must be encoded. However, it's hard for a SDK to guess whether the URL
+ * string has been encoded or not. We have 2 potential strategies, and chose strategy two for the XXXClient constructors.
+ *
+ * ### Strategy One: Assume the customer URL string is not encoded, and always encode URL string in SDK.
+ *
+ * This is what legacy V2 SDK does, simple and works for most of the cases.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
+ *   SDK will encode it to "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
+ *   SDK will encode it to "http://account.blob.core.windows.net/con/b%253A" and send to server. A blob named "b%3A" will be created.
+ *
+ * But this strategy will make it not possible to create a blob with "?" in it's name. Because when customer URL string is
+ * "http://account.blob.core.windows.net/con/blob?name", the "?name" will be treated as URL paramter instead of blob name.
+ * If customer URL string is "http://account.blob.core.windows.net/con/blob%3Fname", a blob named "blob%3Fname" will be created.
+ * V2 SDK doesn't have this issue because it doesn't allow customer pass in a full URL, it accepts a separate blob name and encodeURIComponent for it.
+ * We cannot accept a SDK cannot create a blob name with "?". So we implement strategy two:
+ *
+ * ### Strategy Two: SDK doesn't assume the URL has been encoded or not. It will just escape the special characters.
+ *
+ * This is what V10 Blob Go SDK does. It accepts a URL type in Go, and call url.EscapedPath() to escape the special chars unescaped.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
+ *   SDK will escape ":" like "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
+ *   There is no special characters, so send "http://account.blob.core.windows.net/con/b%3A" to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%253A",
+ *   There is no special characters, so send "http://account.blob.core.windows.net/con/b%253A" to server. A blob named "b%3A" will be created.
+ *
+ * This strategy gives us flexibility to create with any special characters. But "%" will be treated as a special characters, if the URL string
+ * is not encoded, there shouldn't a "%" in the URL string, otherwise the URL is not a valid URL.
+ * If customer needs to create a blob with "%" in it's blob name, use "%25" insead of "%". Just like above 3rd sample.
+ * And following URL strings are invalid:
+ * - "http://account.blob.core.windows.net/con/b%"
+ * - "http://account.blob.core.windows.net/con/b%2"
+ * - "http://account.blob.core.windows.net/con/b%G"
+ *
+ * Another special character is "?", use "%2F" to represent a blob name with "?" in a URL string.
+ *
+ * ### Strategy for containerName, blobName or other specific XXXName parameters in methods such as `ContainerClient.getBlobClient(blobName)`
+ *
+ * We will apply strategy one, and call encodeURIComponent for these parameters like blobName. Because what customers passes in is a plain name instead of a URL.
+ *
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
+ *
+ * @param url -
+ */
+export declare function escapeURLPath(url: string): string;
+export interface ConnectionString {
+    kind: "AccountConnString" | "SASConnString";
+    url: string;
+    accountName: string;
+    accountKey?: any;
+    accountSas?: string;
+}
+/**
+ * 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 declare function extractConnectionStringParts(connectionString: string): ConnectionString;
+/**
+ * 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 declare function appendToURLPath(url: string, name: string): string;
+/**
+ * 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 declare function appendToURLQuery(url: string, queryParts: string): string;
+/**
+ * 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 declare function setURLParameter(url: string, name: string, value?: string): string;
+/**
+ * Get URL parameter by name.
+ *
+ * @param url -
+ * @param name -
+ */
+export declare function getURLParameter(url: string, name: string): string | string[] | undefined;
+/**
+ * Set URL host.
+ *
+ * @param url - Source URL string
+ * @param host - New host string
+ * @returns An updated URL string
+ */
+export declare function setURLHost(url: string, host: string): string;
+/**
+ * Get URL path from an URL string.
+ *
+ * @param url - Source URL string
+ */
+export declare function getURLPath(url: string): string | undefined;
+/**
+ * Get URL query key value pairs from an URL string.
+ *
+ * @param url -
+ */
+export declare function getURLQueries(url: string): {
+    [key: string]: string;
+};
+/**
+ * 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 declare function truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string;
+/**
+ * Base64 encode.
+ *
+ * @param content -
+ */
+export declare function base64encode(content: string): string;
+/**
+ * Base64 decode.
+ *
+ * @param encodedString -
+ */
+export declare function base64decode(encodedString: string): string;
+/**
+ * Delay specified time interval.
+ *
+ * @param timeInMs -
+ * @param aborter -
+ * @param abortError -
+ */
+export declare function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error): Promise<void>;
+export declare function sanitizeURL(url: string): string;
+export declare function sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders;
+/**
+ * Extracts account name from the url
+ * @param url - url to extract the account name from
+ * @returns with the account name
+ */
+export declare function getAccountNameFromUrl(url: string): string;
+export declare function isIpEndpointStyle(parsedUrl: URL): boolean;
+export declare function getShareNameAndPathFromUrl(url: string): {
+    baseName: string;
+    shareName: string;
+    path: string;
+};
+export declare function httpAuthorizationToString(httpAuthorization?: HttpAuthorization): string | undefined;
+/**
+ * Set URL path.
+ *
+ * @param url - URL to change path to.
+ * @param path - Path to set into the URL.
+ */
+export declare function setURLPath(url: string, path: string): string;
+/**
+ * Set URL query string.
+ *
+ * @param url - URL to set query string to.
+ * @param queryString - Query string to set to the URL.
+ */
+export declare function setURLQueries(url: string, queryString: string): string;
+/**
+ * Escape the file or directory name but keep path separator ('/').
+ */
+export declare function EscapePath(pathName: string): string;
+/**
+ * A representation of an HTTP response that
+ * includes a reference to the request that
+ * originated it.
+ */
+export interface HttpResponse {
+    /**
+     * The headers from the response.
+     */
+    headers: HttpHeadersLike;
+    /**
+     * The original request that resulted in this response.
+     */
+    request: WebResourceLike;
+    /**
+     * The HTTP status code returned from the service.
+     */
+    status: number;
+}
+/**
+ * An object with a _response property that has
+ * headers already parsed into a typed object.
+ */
+export interface ResponseWithHeaders<Headers> {
+    /**
+     * The underlying HTTP response.
+     */
+    _response: HttpResponse & {
+        /**
+         * The parsed HTTP response headers.
+         */
+        parsedHeaders: Headers;
+    };
+}
+/**
+ * An object with a _response property that has body
+ * and headers already parsed into known types.
+ */
+export interface ResponseWithBody<Headers, Body> {
+    /**
+     * The underlying HTTP response.
+     */
+    _response: HttpResponse & {
+        /**
+         * The parsed HTTP response headers.
+         */
+        parsedHeaders: Headers;
+        /**
+         * The response body as text (string format)
+         */
+        bodyAsText: string;
+        /**
+         * The response body as parsed JSON or XML
+         */
+        parsedBody: Body;
+    };
+}
+/**
+ * An object with a simple _response property.
+ */
+export interface ResponseLike {
+    /**
+     * The underlying HTTP response.
+     */
+    _response: HttpResponse;
+}
+/**
+ * A type that represents an operation result with a known _response property.
+ */
+export type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
+/**
+ * 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 declare function assertResponse<T extends object, Headers = undefined, Body = undefined>(response: T): WithResponse<T, Headers, Body>;
+export declare function StringEncodedToString(name: StringEncoded): string;
+export declare function ConvertInternalResponseOfListFiles(internalResponse: ListFilesAndDirectoriesSegmentResponseInternal): ListFilesAndDirectoriesSegmentResponse;
+export declare function ConvertInternalResponseOfListHandles(internalResponse: ListHandlesResponseInternal): ListHandlesResponse;
+/**
+ * A small helper to handle converting an empty string "" into undefined
+ * This is used in the case of query parameters (like continuation token) where
+ * we don't want to send an empty query parameter to the service since the signing
+ * policy for shared key will fail.
+ * @internal
+ */
+export declare function removeEmptyString(value: string | undefined): string | undefined;
+export declare function asSharePermission(value: string | SharePermission): SharePermission;
+/**
+ * Parse 4-digit octal string representation of a File Mode to a {@link NfsFileMode} structure.
+ */
+export declare function parseOctalFileMode(input?: string): NfsFileMode | undefined;
+/**
+ * Convert {@link NfsFileMode} structure to a 4-digit octal string represenation.
+ */
+export declare function toOctalFileMode(input?: NfsFileMode): string | undefined;
+/**
+ * Convert a {@link NfsFileMode} to a string in symbolic notation.
+ */
+export declare function toSymbolicFileMode(input?: NfsFileMode): string | undefined;
+/**
+ * Parse a 9-character symbolic string representation of a File Mode to a {@link NfsFileMode} structure.
+ */
+export declare function parseSymbolicFileMode(input?: string): NfsFileMode | undefined;
+export declare function parseOctalRolePermissions(c: string): PosixRolePermissions;
+export declare function toOctalRolePermissions(rolePermissions: PosixRolePermissions): string;
+export declare function toSymbolicRolePermissions(rolePermissions: PosixRolePermissions): string;
+export declare function parseSymbolicRolePermissions(input: string): {
+    rolePermissions: PosixRolePermissions;
+    setSticky: boolean;
+};
+//# sourceMappingURL=utils.common.d.ts.map

package/dist/commonjs/utils/utils.common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.common.d.ts","sourceRoot":"","sources":["../../../src/utils/utils.common.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EACV,sCAAsC,IAAI,8CAA8C,EACxF,mBAAmB,IAAI,2BAA2B,EAClD,eAAe,EACf,aAAa,EACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAIV,sCAAsC,EACtC,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAGzF,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAUjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,mBAAmB,GAAG,eAAe,CAAC;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAqBD;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB,CAqEvF;AAgBD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAQjE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAYxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAwBjF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAGxF;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAO1D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CA2BpE;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,gBAAgB,GAAE,OAAc,GAAG,MAAM,CAOzF;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;;;;;GAMG;AACH,wBAAsB,KAAK,CACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,eAAe,EACzB,UAAU,CAAC,EAAE,KAAK,GACjB,OAAO,CAAC,IAAI,CAAC,CAwBf;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/C;AAED,wBAAgB,eAAe,CAAC,cAAc,EAAE,WAAW,GAAG,WAAW,CAaxE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAuBzD;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAazD;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAyDA;AAED,wBAAgB,yBAAyB,CACvC,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,MAAM,GAAG,SAAS,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAItE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAMnD;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,OAAO;IAC1C;;OAEG;IACH,SAAS,EAAE,YAAY,GAAG;QACxB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;KACxB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,OAAO,EAAE,IAAI;IAC7C;;OAEG;IACH,SAAS,EAAE,YAAY,GAAG;QACxB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QACvB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,UAAU,EAAE,IAAI,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,GAAG,SAAS,IAAI,CAAC,GACpE,CAAC,IAAI,SAAS,MAAM,GAChB,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,GAC/B,OAAO,SAAS,MAAM,GACpB,mBAAmB,CAAC,OAAO,CAAC,GAC5B,YAAY,CAAC,CAAC;AAEtB;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,GAAG,SAAS,EACpF,QAAQ,EAAE,CAAC,GACV,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,CAMhC;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAMjE;AAED,wBAAgB,kCAAkC,CAChD,gBAAgB,EAAE,8CAA8C,GAC/D,sCAAsC,CAmCxC;AAED,wBAAgB,oCAAoC,CAClD,gBAAgB,EAAE,2BAA2B,GAC5C,mBAAmB,CAerB;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAE/E;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,eAAe,CAYlF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAiC1E;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAsBvE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CA8B1E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAmB7E;AAED,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,MAAM,GAAG,oBAAoB,CA0BzE;AAED,wBAAgB,sBAAsB,CAAC,eAAe,EAAE,oBAAoB,GAAG,MAAM,CAepF;AAED,wBAAgB,yBAAyB,CAAC,eAAe,EAAE,oBAAoB,GAAG,MAAM,CAqBvF;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,GAAG;IAC3D,eAAe,EAAE,oBAAoB,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;CACpB,CAsDA"}