@azure/storage-file-datalake 12.26.0 → 12.27.0-beta.1

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

@@ -0,0 +1,236 @@
+import type { HttpHeaders } from "@azure/core-rest-pipeline";
+import type { ContainerEncryptionScope, WithResponse } from "@azure/storage-blob";
+import type { CpkInfo, FileSystemEncryptionScope, PathAccessControlItem, PathPermissions } from "../models.js";
+import type { HttpResponse } from "@azure/storage-blob";
+/**
+ * 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 constructors, 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" instead 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;
+    proxyUri?: string;
+}
+export declare function getValueInConnString(connectionString: string, argument: "BlobEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"): 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;
+/**
+ * Set URL path.
+ *
+ * @param url -
+ * @param path -
+ */
+export declare function setURLPath(url: string, path: string): string;
+/**
+ * Get URL scheme from an URL string.
+ *
+ * @param url - Source URL string
+ */
+export declare function getURLScheme(url: string): string | undefined;
+/**
+ * Get URL path and query from an URL string.
+ *
+ * @param url - Source URL string
+ */
+export declare function getURLPathAndQuery(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;
+};
+/**
+ * Set URL query string.
+ *
+ * @param url -
+ * @param queryString -
+ */
+export declare function setURLQueries(url: string, queryString: 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;
+/**
+ * Generate a 64 bytes base64 block ID string.
+ *
+ * @param blockIndex -
+ */
+export declare function generateBlockID(blockIDPrefix: string, blockIndex: number): string;
+export declare function sanitizeURL(url: string): string;
+export declare function sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders;
+/**
+ * If two strings are equal when compared case insensitive.
+ *
+ * @param str1 -
+ * @param str2 -
+ */
+export declare function iEqual(str1: string, str2: string): boolean;
+/**
+ * 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;
+/**
+ * This is to convert a Windows File Time ticks to a Date object.
+ */
+export declare function windowsFileTimeTicksToTime(timeNumber: string | undefined): Date | undefined;
+export declare function ensureCpkIfSpecified(cpk: CpkInfo | undefined, isHttps: boolean): void;
+export declare function ToBlobContainerEncryptionScope(fileSystemEncryptionScope?: FileSystemEncryptionScope): ContainerEncryptionScope | undefined;
+/**
+ * Escape the file or directory name but keep path separator ('/').
+ */
+export declare function EscapePath(pathName: string): string;
+/**
+ * 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 interface PathGetPropertiesRawResponseWithExtraPropertiesLike {
+    encryptionContext?: string;
+    owner?: string;
+    group?: string;
+    permissions?: PathPermissions;
+    acl: PathAccessControlItem[];
+    _response: HttpResponse & {
+        parsedHeaders: {
+            encryptionContext?: string;
+            owner?: string;
+            group?: string;
+            permissions?: PathPermissions;
+            acl: PathAccessControlItem[];
+        };
+    };
+}
+/**
+ * Parse extra properties values from headers in raw response.
+ */
+export declare function ParsePathGetPropertiesExtraHeaderValues(rawResponse: PathGetPropertiesRawResponseWithExtraPropertiesLike): PathGetPropertiesRawResponseWithExtraPropertiesLike;
+//# 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":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAG7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAClF,OAAO,KAAK,EACV,OAAO,EACP,yBAAyB,EACzB,qBAAqB,EACrB,eAAe,EAChB,MAAM,cAAc,CAAC;AAStB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAkBD,wBAAgB,oBAAoB,CAClC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EACJ,cAAc,GACd,aAAa,GACb,YAAY,GACZ,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GAC1B,MAAM,CAQR;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,gBAAgB,EAAE,MAAM,GAAG,gBAAgB,CA+EvF;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;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAO5D;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAclE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CA2BpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAItE;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;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAgBjF;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/C;AAED,wBAAgB,eAAe,CAAC,cAAc,EAAE,WAAW,GAAG,WAAW,CAaxE;AACD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAoBzD;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAazD;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS,CAmB3F;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAQrF;AAED,wBAAgB,8BAA8B,CAC5C,yBAAyB,CAAC,EAAE,yBAAyB,GACpD,wBAAwB,GAAG,SAAS,CAStC;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAMnD;AAED;;;;;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,MAAM,WAAW,mDAAmD;IAClE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,GAAG,EAAE,qBAAqB,EAAE,CAAC;IAC7B,SAAS,EAAE,YAAY,GAAG;QACxB,aAAa,EAAE;YACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,WAAW,CAAC,EAAE,eAAe,CAAC;YAC9B,GAAG,EAAE,qBAAqB,EAAE,CAAC;SAC9B,CAAC;KACH,CAAC;CACH;AAgBD;;GAEG;AACH,wBAAgB,uCAAuC,CACrD,WAAW,EAAE,mDAAmD,GAC/D,mDAAmD,CAerD"}