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

package/dist/commonjs/models.js

@@ -0,0 +1,107 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageFileAudience = void 0;
+exports.toShareProtocols = toShareProtocols;
+exports.toShareProtocolsString = toShareProtocolsString;
+exports.validateFilePermissionOptions = validateFilePermissionOptions;
+exports.validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions = validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions;
+exports.validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions = validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions;
+exports.fileAttributesToString = fileAttributesToString;
+exports.fileCreationTimeToString = fileCreationTimeToString;
+exports.fileLastWriteTimeToString = fileLastWriteTimeToString;
+exports.fileChangeTimeToString = fileChangeTimeToString;
+exports.getFileServiceAccountAudience = getFileServiceAccountAudience;
+const FileSystemAttributes_js_1 = require("./FileSystemAttributes.js");
+const utils_common_js_1 = require("./utils/utils.common.js");
+const log_js_1 = require("./log.js");
+/**
+ * Convert protocols from joined string to ShareProtocols.
+ *
+ * @param protocolsString -
+ */
+function toShareProtocols(protocolsString) {
+    if (protocolsString === undefined) {
+        return undefined;
+    }
+    const protocolStrArray = protocolsString.split(";");
+    const protocols = {};
+    for (const protocol of protocolStrArray) {
+        if (protocol === "SMB") {
+            protocols.smbEnabled = true;
+        }
+        else if (protocol === "NFS") {
+            protocols.nfsEnabled = true;
+        }
+    }
+    return protocols;
+}
+/**
+ * Convert ShareProtocols to joined string.
+ *
+ * @param protocols -
+ */
+function toShareProtocolsString(protocols = {}) {
+    let protocolStr = undefined;
+    if (protocols.smbEnabled === true) {
+        protocolStr = "SMB";
+    }
+    if (protocols.nfsEnabled === true) {
+        log_js_1.logger.info(`Using "NFS" in favor of "SMB" for the share protocol as currently they can't be supported at the same time.`);
+        protocolStr = "NFS";
+    }
+    return protocolStr;
+}
+function validateFilePermissionOptions(filePermission, filePermissionKey) {
+    if (filePermission && filePermissionKey) {
+        throw new RangeError("Only one of filePermission or filePermissionKey can be specified.");
+    }
+}
+function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options) {
+    // Would better deep copy params set by user.
+    if (!options) {
+        options = {};
+    }
+    validateFilePermissionOptions(options.filePermission, options.filePermissionKey);
+    return options;
+}
+function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options) {
+    // Would better deep copy params set by user.
+    if (!options) {
+        options = {};
+    }
+    validateFilePermissionOptions(options.filePermission, options.filePermissionKey);
+    return options;
+}
+function fileAttributesToString(fileAttributes) {
+    return fileAttributes instanceof FileSystemAttributes_js_1.FileSystemAttributes
+        ? fileAttributes.toString()
+        : fileAttributes;
+}
+function fileCreationTimeToString(time) {
+    return time instanceof Date ? (0, utils_common_js_1.truncatedISO8061Date)(time) : time;
+}
+function fileLastWriteTimeToString(time) {
+    return time instanceof Date ? (0, utils_common_js_1.truncatedISO8061Date)(time) : time;
+}
+function fileChangeTimeToString(time) {
+    return time instanceof Date ? (0, utils_common_js_1.truncatedISO8061Date)(time) : time;
+}
+/**
+ * Defines the known cloud audiences for Storage.
+ */
+var StorageFileAudience;
+(function (StorageFileAudience) {
+    /**
+     * The OAuth scope to use to retrieve an AAD token for Azure Storage.
+     */
+    StorageFileAudience["StorageOAuthScopes"] = "https://storage.azure.com/.default";
+})(StorageFileAudience || (exports.StorageFileAudience = StorageFileAudience = {}));
+/**
+ * To get the OAuth audience for a storage account for file service.
+ */
+function getFileServiceAccountAudience(storageAccountName) {
+    return `https://${storageAccountName}.file.core.windows.net/.default`;
+}
+//# sourceMappingURL=models.js.map

package/dist/commonjs/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAoXlC,4CAeC;AAOD,wDAaC;AAED,sEAOC;AAED,oIAYC;AAED,kJAYC;AAED,wDAMC;AAED,4DAIC;AAED,8DAIC;AAED,wDAIC;AA+BD,sEAEC;AArfD,uEAAiE;AACjE,6DAA+D;AAC/D,qCAAkC;AA2WlC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,eAAwB;IACvD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,gBAAgB,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpD,MAAM,SAAS,GAAmB,EAAE,CAAC;IACrC,KAAK,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;QACxC,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC;QAC9B,CAAC;aAAM,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC9B,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,YAA4B,EAAE;IACnE,IAAI,WAAW,GAAG,SAAS,CAAC;IAE5B,IAAI,SAAS,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAClC,WAAW,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,IAAI,SAAS,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAClC,eAAM,CAAC,IAAI,CACT,6GAA6G,CAC9G,CAAC;QACF,WAAW,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAgB,6BAA6B,CAC3C,cAAuB,EACvB,iBAA0B;IAE1B,IAAI,cAAc,IAAI,iBAAiB,EAAE,CAAC;QACxC,MAAM,IAAI,UAAU,CAAC,mEAAmE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAgB,4DAA4D,CAC1E,OAA4C;IAE5C,6CAA6C;IAE7C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,EAAE,CAAC;IACf,CAAC;IAED,6BAA6B,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEjF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAgB,mEAAmE,CACjF,OAAmD;IAEnD,6CAA6C;IAE7C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,EAAE,CAAC;IACf,CAAC;IAED,6BAA6B,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEjF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAgB,sBAAsB,CACpC,cAAiE;IAEjE,OAAO,cAAc,YAAY,8CAAoB;QACnD,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE;QAC3B,CAAC,CAAC,cAAc,CAAC;AACrB,CAAC;AAED,SAAgB,wBAAwB,CACtC,IAAuD;IAEvD,OAAO,IAAI,YAAY,IAAI,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAED,SAAgB,yBAAyB,CACvC,IAAuD;IAEvD,OAAO,IAAI,YAAY,IAAI,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAED,SAAgB,sBAAsB,CACpC,IAAuD;IAEvD,OAAO,IAAI,YAAY,IAAI,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAkBD;;GAEG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,gFAAyD,CAAA;AAC3D,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAED;;GAEG;AACH,SAAgB,6BAA6B,CAAC,kBAA0B;IACtE,OAAO,WAAW,kBAAkB,iCAAiC,CAAC;AACxE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { FileSystemAttributes } from \"./FileSystemAttributes.js\";\nimport { truncatedISO8061Date } from \"./utils/utils.common.js\";\nimport { logger } from \"./log.js\";\nimport type { FilePermissionFormat, NfsFileType, ShareTokenIntent } from \"./generatedModels.js\";\nimport type { StoragePipelineOptions } from \"./Pipeline.js\";\nimport type { FileDownloadHeaders } from \"./generatedModels.js\";\n\nexport interface Metadata {\n  [propertyName: string]: string;\n}\n\n/**\n * Represents file permissions for a specific role.\n */\nexport interface PosixRolePermissions {\n  /**\n   * The execute permission.\n   */\n  execute: boolean;\n  /**\n   * The write permission.\n   */\n  write: boolean;\n  /**\n   * The read permission.\n   */\n  read: boolean;\n}\n\n/**\n * The mode permissions of the file or directory.\n */\nexport interface NfsFileMode {\n  /**\n   * Permissions the owner has over the file or directory.\n   */\n  owner: PosixRolePermissions;\n\n  /**\n   * Permissions the group has over the file or directory.\n   */\n  group: PosixRolePermissions;\n\n  /**\n   * Permissions other have over the file or directory.\n   */\n  other: PosixRolePermissions;\n\n  /**\n   * Set effective user ID (setuid) on the file or directory.\n   */\n  effectiveUserIdentity: boolean;\n\n  /**\n   * Set effective group ID (setgid) on the file or directory.\n   */\n  effectiveGroupIdentity: boolean;\n\n  /**\n   * The sticky bit may be set on directories.  The files in that\n   * directory may only be renamed or deleted by the file's owner, the directory's owner, or the root user.\n   */\n  stickyBit: boolean;\n}\n\n/**\n * \n   NFS properties.\n   Note that these properties only apply to files or directories in\n   premium NFS file accounts.\n  */\nexport interface FilePosixProperties {\n  /** NFS only. The owner of the file or directory. */\n  owner?: string;\n  /** NFS only. The owning group of the file or directory. */\n  group?: string;\n  /** NFS only. The file mode of the file or directory */\n  fileMode?: NfsFileMode;\n  /** NFS only. Type of the file or directory. */\n  fileType?: NfsFileType;\n  /** NFS only. The link count of the file or directory. */\n  linkCount?: number;\n}\n\n/** Defines headers for File_setHttpHeaders operation. */\nexport interface FileSetHttpHeadersHeaders {\n  /** The ETag contains a value which represents the version of the file, in quotes. */\n  etag?: string;\n  /** Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */\n  lastModified?: Date;\n  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */\n  requestId?: string;\n  /** Indicates the version of the File service used to execute the request. */\n  version?: string;\n  /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */\n  date?: Date;\n  /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */\n  isServerEncrypted?: boolean;\n  /** Key of the permission set for the file. */\n  filePermissionKey?: string;\n  /** Attributes set for the file. */\n  fileAttributes?: string;\n  /** Creation time for the file. */\n  fileCreatedOn?: Date;\n  /** Last write time for the file. */\n  fileLastWriteOn?: Date;\n  /** Change time for the file. */\n  fileChangeOn?: Date;\n  /** The fileId of the directory. */\n  fileId?: string;\n  /** The parent fileId of the directory. */\n  fileParentId?: string;\n  /** Properties of NFS files. */\n  posixProperties?: FilePosixProperties;\n  /** Error Code */\n  errorCode?: string;\n}\n\n/** Contains response data for the download operation. */\nexport type FileDownloadResponse = FileDownloadHeaders & {\n  /**\n   * BROWSER ONLY\n   *\n   * The response body as a browser Blob.\n   * Always `undefined` in node.js.\n   */\n  blobBody?: Promise<Blob>;\n  /**\n   * NODEJS ONLY\n   *\n   * The response body as a node.js Readable stream.\n   * Always `undefined` in the browser.\n   */\n  readableStreamBody?: NodeJS.ReadableStream;\n};\n\nexport interface FileHttpHeaders {\n  /**\n   * Optional. Sets the file's cache\n   * control. If specified, this property is stored with the file and returned\n   * with a read request.\n   */\n  fileCacheControl?: string;\n  /**\n   * Optional. Sets the file's content type.\n   * If specified, this property is stored with the file and returned with a\n   * read request.\n   */\n  fileContentType?: string;\n  /**\n   * Optional. An MD5 hash of the file\n   * content. Note that this hash is not validated, as the hashes for the\n   * individual blocks were validated when each was uploaded.\n   */\n  fileContentMD5?: Uint8Array;\n  /**\n   * Optional. Sets the file's content\n   * encoding. If specified, this property is stored with the file and returned\n   * with a read request.\n   */\n  fileContentEncoding?: string;\n  /**\n   * Optional. Set the file's content\n   * language. If specified, this property is stored with the file and returned\n   * with a read request.\n   */\n  fileContentLanguage?: string;\n  /**\n   * Optional. Sets the file's\n   * Content-Disposition header.\n   */\n  fileContentDisposition?: string;\n}\n\n/**\n * Indicates inherit file permission from the parent directory.\n */\nexport type FilePermissionInheritType = \"inherit\";\n\n/**\n * Indicates keep existing file permission value unchanged.\n */\nexport type FilePermissionPreserveType = \"preserve\";\n\n/**\n * Indicates setting as the time of the request.\n */\nexport type TimeNowType = \"now\";\n\n/**\n * Indicates keep existing time value unchanged.\n */\nexport type TimePreserveType = \"preserve\";\n\n/**\n * Indicates keep existing file attributes unchanged.\n */\nexport type FileAttributesPreserveType = \"preserve\";\n\nexport interface FileAndDirectoryCreateCommonOptions {\n  /**\n   * The permission(security descriptor) to be set for the file or directory in the\n   * Security Descriptor Definition Language (SDDL) or binary.\n   * If specified, it must have an owner, group, and discretionary access control list (DACL).\n   * A value of inherit may be passed to inherit from the parent directory.\n   *\n   * Note that only one of filePermission or filePermissionKey can be specified.\n   * And if both are not specified, inherit will be set to filePermission as default value by client library.\n   */\n  filePermission?: string | FilePermissionInheritType;\n\n  /**\n   * Optional. Available for version 2023-06-01 and later.\n   * Specifies the format in which the permission is returned. Acceptable values are SDDL or binary.\n   * If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.\n   * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission\n   */\n  filePermissionFormat?: FilePermissionFormat;\n\n  /**\n   * The key of the permission to be set for the file or directory. This can be created using the Create-Permission API.\n   *\n   * Note that only one of filePermission or filePermissionKey can be specified.\n   */\n  filePermissionKey?: string;\n\n  /**\n   * The file system attributes to be set on the file or directory.\n   */\n  fileAttributes?: FileSystemAttributes;\n\n  /**\n   * The Coordinated Universal Time (UTC) creation time property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * By default, the value will be set as now.\n   */\n  creationTime?: Date | TimeNowType;\n\n  /**\n   * The Coordinated Universal Time (UTC) last write property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * By default, the value will be set as now.\n   */\n  lastWriteTime?: Date | TimeNowType;\n\n  /**\n   * The Coordinated Universal Time (UTC) change time property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * By default, the value will be set to the time of the request.\n   */\n  changeTime?: Date | TimeNowType;\n  /**\n   * Optional properties to set on NFS files.\n     Note that this property is only applicable to files created in NFS shares.\n   */\n  posixProperties?: FilePosixProperties;\n}\n\nexport interface FileAndDirectorySetPropertiesCommonOptions {\n  /**\n   * The permission(security descriptor) to be set for the file or directory in the\n   * Security Descriptor Definition Language (SDDL). If specified, it must have an owner, group, and discretionary access control list (DACL).\n   * A value of inherit may be passed to inherit from the parent directory.\n   * A value of preserve may be passed to keep the value unchanged.\n   *\n   * Note that only one of filePermission or filePermissionKey can be specified.\n   * And if both are not specified, preserve will be set to filePermission as default value by client library.\n   */\n  filePermission?: string | FilePermissionInheritType | FilePermissionPreserveType;\n\n  /**\n   * Optional. Available for version 2023-06-01 and later.\n   * Specifies the format in which the permission is returned. Acceptable values are SDDL or binary.\n   * If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.\n   * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission\n   */\n  filePermissionFormat?: FilePermissionFormat;\n\n  /**\n   * The key of the permission to be set for the file or directory. This can be created using the Create-Permission API.\n   *\n   * Note that only one of filePermission or filePermissionKey can be specified.\n   */\n  filePermissionKey?: string;\n\n  /**\n   * The file system attributes to be set on the file or directory.\n   */\n  fileAttributes?: FileSystemAttributes | FileAttributesPreserveType;\n\n  /**\n   * The Coordinated Universal Time (UTC) creation time property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * A value of preserve may be passed to keep an existing value unchanged.\n   * By default, the value will be set as preserve.\n   */\n  creationTime?: Date | TimeNowType | TimePreserveType;\n\n  /**\n   * The Coordinated Universal Time (UTC) last write property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * A value of preserve may be passed to keep an existing value unchanged.\n   * By default, the value will be set as preserve.\n   */\n  lastWriteTime?: Date | TimeNowType | TimePreserveType;\n\n  /**\n   * The Coordinated Universal Time (UTC) change time property for the directory.\n   * A value of now may be used to indicate the time of the request.\n   * By default, the value will be set to the time of the request.\n   */\n  changeTime?: Date | TimeNowType;\n\n  /**\n   * Optional properties to set on NFS files.\n     Note that this property is only applicable to files created in NFS shares.\n   */\n  posixProperties?: FilePosixProperties;\n}\n\n/**\n * Close handles result information.\n */\nexport interface CloseHandlesInfo {\n  closedHandlesCount: number;\n  /**\n   * Contains count of number of handles that failed to close.\n   */\n  closeFailureCount?: number;\n}\n\n/**\n * Protocols to enable on the share. For now, only support SMB or NFS.\n */\nexport interface ShareProtocols {\n  /**\n   * The share can be accessed by SMBv3.0, SMBv2.1 and REST.\n   */\n  smbEnabled?: boolean;\n  /**\n   * The share can be accessed by NFSv4.1.\n   */\n  nfsEnabled?: boolean;\n}\n\nexport interface ShareClientConfig {\n  /**\n   * The Files OAuth over REST feature requires special permissions to be included in the role definition to use\n   * These special permissions will give privileged access to file share data -\n   * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data\n   * Since this additional permission can be unintended and to prevent unintended and over privileged access,\n   * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.\n   * This is done using the fileRequestIntent option.\n   * Currently, the only value that the header supports is 'backup'\n   * Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.\n   */\n  fileRequestIntent?: ShareTokenIntent;\n  /** If true, the trailing dot will not be trimmed from the target URI. */\n  allowTrailingDot?: boolean;\n  /** If true, the trailing dot will not be trimmed from the source URI. */\n  allowSourceTrailingDot?: boolean;\n}\n\nexport type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;\n\n/**\n * Convert protocols from joined string to ShareProtocols.\n *\n * @param protocolsString -\n */\nexport function toShareProtocols(protocolsString?: string): ShareProtocols | undefined {\n  if (protocolsString === undefined) {\n    return undefined;\n  }\n\n  const protocolStrArray = protocolsString.split(\";\");\n  const protocols: ShareProtocols = {};\n  for (const protocol of protocolStrArray) {\n    if (protocol === \"SMB\") {\n      protocols.smbEnabled = true;\n    } else if (protocol === \"NFS\") {\n      protocols.nfsEnabled = true;\n    }\n  }\n  return protocols;\n}\n\n/**\n * Convert ShareProtocols to joined string.\n *\n * @param protocols -\n */\nexport function toShareProtocolsString(protocols: ShareProtocols = {}): string | undefined {\n  let protocolStr = undefined;\n\n  if (protocols.smbEnabled === true) {\n    protocolStr = \"SMB\";\n  }\n  if (protocols.nfsEnabled === true) {\n    logger.info(\n      `Using \"NFS\" in favor of \"SMB\" for the share protocol as currently they can't be supported at the same time.`,\n    );\n    protocolStr = \"NFS\";\n  }\n  return protocolStr;\n}\n\nexport function validateFilePermissionOptions(\n  filePermission?: string,\n  filePermissionKey?: string,\n): void {\n  if (filePermission && filePermissionKey) {\n    throw new RangeError(\"Only one of filePermission or filePermissionKey can be specified.\");\n  }\n}\n\nexport function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(\n  options: FileAndDirectoryCreateCommonOptions,\n): FileAndDirectoryCreateCommonOptions {\n  // Would better deep copy params set by user.\n\n  if (!options) {\n    options = {};\n  }\n\n  validateFilePermissionOptions(options.filePermission, options.filePermissionKey);\n\n  return options;\n}\n\nexport function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(\n  options: FileAndDirectorySetPropertiesCommonOptions,\n): FileAndDirectorySetPropertiesCommonOptions {\n  // Would better deep copy params set by user.\n\n  if (!options) {\n    options = {};\n  }\n\n  validateFilePermissionOptions(options.filePermission, options.filePermissionKey);\n\n  return options;\n}\n\nexport function fileAttributesToString(\n  fileAttributes: FileSystemAttributes | FileAttributesPreserveType,\n): string {\n  return fileAttributes instanceof FileSystemAttributes\n    ? fileAttributes.toString()\n    : fileAttributes;\n}\n\nexport function fileCreationTimeToString(\n  time: Date | TimeNowType | TimePreserveType | undefined,\n): string | undefined {\n  return time instanceof Date ? truncatedISO8061Date(time) : time;\n}\n\nexport function fileLastWriteTimeToString(\n  time: Date | TimeNowType | TimePreserveType | undefined,\n): string | undefined {\n  return time instanceof Date ? truncatedISO8061Date(time) : time;\n}\n\nexport function fileChangeTimeToString(\n  time: Date | TimeNowType | TimePreserveType | undefined,\n): string | undefined {\n  return time instanceof Date ? truncatedISO8061Date(time) : time;\n}\n\n/**\n * Represents authentication information in Authorization, ProxyAuthorization,\n * WWW-Authenticate, and Proxy-Authenticate header values.\n */\nexport interface HttpAuthorization {\n  /**\n   * The scheme to use for authorization.\n   */\n  scheme: string;\n\n  /**\n   * the credentials containing the authentication information of the user agent for the resource being requested.\n   */\n  value: string;\n}\n\n/**\n * Defines the known cloud audiences for Storage.\n */\nexport enum StorageFileAudience {\n  /**\n   * The OAuth scope to use to retrieve an AAD token for Azure Storage.\n   */\n  StorageOAuthScopes = \"https://storage.azure.com/.default\",\n}\n\n/**\n * To get the OAuth audience for a storage account for file service.\n */\nexport function getFileServiceAccountAudience(storageAccountName: string): string {\n  return `https://${storageAccountName}.file.core.windows.net/.default`;\n}\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/policies/StorageRetryPolicy.d.ts

@@ -0,0 +1,75 @@
+import type { RequestPolicy, RequestPolicyOptionsLike as RequestPolicyOptions, RequestPolicyFactory, WebResourceLike as WebResource, CompatResponse as HttpOperationResponse } from "@azure/core-http-compat";
+import { BaseRequestPolicy } from "@azure/storage-blob";
+import type { RestError } from "@azure/core-rest-pipeline";
+import type { StorageRetryOptions } from "../StorageRetryPolicyFactory.js";
+/**
+ * A factory method used to generated a RetryPolicy factory.
+ *
+ * @param retryOptions -
+ */
+export declare function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory;
+/**
+ * RetryPolicy types.
+ */
+export declare enum StorageRetryPolicyType {
+    /**
+     * Exponential retry. Retry time delay grows exponentially.
+     */
+    EXPONENTIAL = 0,
+    /**
+     * Linear retry. Retry time delay grows linearly.
+     */
+    FIXED = 1
+}
+/**
+ * Retry policy with exponential retry and linear retry implemented.
+ */
+export declare class StorageRetryPolicy extends BaseRequestPolicy {
+    /**
+     * RetryOptions.
+     */
+    private readonly retryOptions;
+    /**
+     * Creates an instance of RetryPolicy.
+     *
+     * @param nextPolicy -
+     * @param options -
+     * @param retryOptions -
+     */
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
+    /**
+     * Sends request.
+     *
+     * @param request -
+     */
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
+    /**
+     * Decide and perform next retry. Won't mutate request parameter.
+     *
+     * @param request -
+     * @param secondaryHas404 -  If attempt was against the secondary & it returned a StatusNotFound (404), then
+     *                                   the resource was not found. This may be due to replication delay. So, in this
+     *                                   case, we'll never try the secondary again for this operation.
+     * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes
+     *                                   the attempt will be performed by this method call.
+     */
+    protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
+    /**
+     * Decide whether to retry according to last HTTP response and retry counters.
+     *
+     * @param isPrimaryRetry -
+     * @param attempt -
+     * @param response -
+     * @param err -
+     */
+    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
+    /**
+     * Delay a calculated time between retries.
+     *
+     * @param isPrimaryRetry -
+     * @param attempt -
+     * @param abortSignal -
+     */
+    private delay;
+}
+//# sourceMappingURL=StorageRetryPolicy.d.ts.map

package/dist/commonjs/policies/StorageRetryPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageRetryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/StorageRetryPolicy.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,IAAI,oBAAoB,EAChD,oBAAoB,EACpB,eAAe,IAAI,WAAW,EAC9B,cAAc,IAAI,qBAAqB,EACxC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAK3E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,CAAC,EAAE,mBAAmB,GAAG,oBAAoB,CAM9F;AAED;;GAEG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,WAAW,IAAA;IACX;;OAEG;IACH,KAAK,IAAA;CACN;AAaD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,iBAAiB;IACvD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAsB;IAEnD;;;;;;OAMG;gBAED,UAAU,EAAE,aAAa,EACzB,OAAO,EAAE,oBAAoB,EAC7B,YAAY,GAAE,mBAA2C;IAqC3D;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI9E;;;;;;;;;OASG;cACa,kBAAkB,CAChC,OAAO,EAAE,WAAW,EACpB,eAAe,EAAE,OAAO,EACxB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,qBAAqB,CAAC;IAkCjC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CACnB,cAAc,EAAE,OAAO,EACvB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,qBAAqB,EAChC,GAAG,CAAC,EAAE,SAAS,GACd,OAAO;IA+EV;;;;;;OAMG;YACW,KAAK;CA0BpB"}

package/dist/commonjs/policies/StorageRetryPolicy.js

@@ -0,0 +1,225 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageRetryPolicy = exports.StorageRetryPolicyType = void 0;
+exports.NewRetryPolicyFactory = NewRetryPolicyFactory;
+const abort_controller_1 = require("@azure/abort-controller");
+const storage_blob_1 = require("@azure/storage-blob");
+const constants_js_1 = require("../utils/constants.js");
+const utils_common_js_1 = require("../utils/utils.common.js");
+const log_js_1 = require("../log.js");
+/**
+ * A factory method used to generated a RetryPolicy factory.
+ *
+ * @param retryOptions -
+ */
+function NewRetryPolicyFactory(retryOptions) {
+    return {
+        create: (nextPolicy, options) => {
+            return new StorageRetryPolicy(nextPolicy, options, retryOptions);
+        },
+    };
+}
+/**
+ * RetryPolicy types.
+ */
+var StorageRetryPolicyType;
+(function (StorageRetryPolicyType) {
+    /**
+     * Exponential retry. Retry time delay grows exponentially.
+     */
+    StorageRetryPolicyType[StorageRetryPolicyType["EXPONENTIAL"] = 0] = "EXPONENTIAL";
+    /**
+     * Linear retry. Retry time delay grows linearly.
+     */
+    StorageRetryPolicyType[StorageRetryPolicyType["FIXED"] = 1] = "FIXED";
+})(StorageRetryPolicyType || (exports.StorageRetryPolicyType = StorageRetryPolicyType = {}));
+// Default values of StorageRetryOptions
+const DEFAULT_RETRY_OPTIONS = {
+    maxRetryDelayInMs: 120 * 1000,
+    maxTries: 4,
+    retryDelayInMs: 4 * 1000,
+    retryPolicyType: StorageRetryPolicyType.EXPONENTIAL,
+    tryTimeoutInMs: undefined, // Use server side default timeout strategy
+};
+const RETRY_ABORT_ERROR = new abort_controller_1.AbortError("The operation was aborted.");
+/**
+ * Retry policy with exponential retry and linear retry implemented.
+ */
+class StorageRetryPolicy extends storage_blob_1.BaseRequestPolicy {
+    /**
+     * Creates an instance of RetryPolicy.
+     *
+     * @param nextPolicy -
+     * @param options -
+     * @param retryOptions -
+     */
+    constructor(nextPolicy, options, retryOptions = DEFAULT_RETRY_OPTIONS) {
+        super(nextPolicy, options);
+        // Initialize retry options
+        this.retryOptions = {
+            retryPolicyType: retryOptions.retryPolicyType
+                ? retryOptions.retryPolicyType
+                : DEFAULT_RETRY_OPTIONS.retryPolicyType,
+            maxTries: retryOptions.maxTries && retryOptions.maxTries >= 1
+                ? Math.floor(retryOptions.maxTries)
+                : DEFAULT_RETRY_OPTIONS.maxTries,
+            tryTimeoutInMs: retryOptions.tryTimeoutInMs && retryOptions.tryTimeoutInMs >= 0
+                ? retryOptions.tryTimeoutInMs
+                : DEFAULT_RETRY_OPTIONS.tryTimeoutInMs,
+            retryDelayInMs: retryOptions.retryDelayInMs && retryOptions.retryDelayInMs >= 0
+                ? Math.min(retryOptions.retryDelayInMs, retryOptions.maxRetryDelayInMs
+                    ? retryOptions.maxRetryDelayInMs
+                    : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs)
+                : DEFAULT_RETRY_OPTIONS.retryDelayInMs,
+            maxRetryDelayInMs: retryOptions.maxRetryDelayInMs && retryOptions.maxRetryDelayInMs >= 0
+                ? retryOptions.maxRetryDelayInMs
+                : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs,
+        };
+    }
+    /**
+     * Sends request.
+     *
+     * @param request -
+     */
+    async sendRequest(request) {
+        return this.attemptSendRequest(request, false, 1);
+    }
+    /**
+     * Decide and perform next retry. Won't mutate request parameter.
+     *
+     * @param request -
+     * @param secondaryHas404 -  If attempt was against the secondary & it returned a StatusNotFound (404), then
+     *                                   the resource was not found. This may be due to replication delay. So, in this
+     *                                   case, we'll never try the secondary again for this operation.
+     * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes
+     *                                   the attempt will be performed by this method call.
+     */
+    async attemptSendRequest(request, secondaryHas404, attempt) {
+        const newRequest = request.clone();
+        const isPrimaryRetry = true;
+        // Set the server-side timeout query parameter "timeout=[seconds]"
+        if (this.retryOptions.tryTimeoutInMs) {
+            newRequest.url = (0, utils_common_js_1.setURLParameter)(newRequest.url, constants_js_1.URLConstants.Parameters.TIMEOUT, Math.floor(this.retryOptions.tryTimeoutInMs / 1000).toString());
+        }
+        let response;
+        try {
+            log_js_1.logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
+            response = await this._nextPolicy.sendRequest(newRequest);
+            if (!this.shouldRetry(isPrimaryRetry, attempt, response)) {
+                return response;
+            }
+            secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
+        }
+        catch (err) {
+            log_js_1.logger.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);
+            if (!this.shouldRetry(isPrimaryRetry, attempt, response, err)) {
+                throw err;
+            }
+        }
+        await this.delay(isPrimaryRetry, attempt, request.abortSignal);
+        return this.attemptSendRequest(request, secondaryHas404, ++attempt);
+    }
+    /**
+     * Decide whether to retry according to last HTTP response and retry counters.
+     *
+     * @param isPrimaryRetry -
+     * @param attempt -
+     * @param response -
+     * @param err -
+     */
+    shouldRetry(isPrimaryRetry, attempt, response, err) {
+        if (attempt >= this.retryOptions.maxTries) {
+            log_js_1.logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions
+                .maxTries}, no further try.`);
+            return false;
+        }
+        // Handle network failures, you may need to customize the list when you implement
+        // your own http client
+        const retriableErrors = [
+            "ETIMEDOUT",
+            "ESOCKETTIMEDOUT",
+            "ECONNREFUSED",
+            "ECONNRESET",
+            "ENOENT",
+            "ENOTFOUND",
+            "TIMEOUT",
+            "EPIPE",
+            "REQUEST_SEND_ERROR", // For default xhr based http client provided in ms-rest-js
+        ];
+        if (err) {
+            for (const retriableError of retriableErrors) {
+                if (err.name.toUpperCase().includes(retriableError) ||
+                    err.message.toUpperCase().includes(retriableError) ||
+                    (err.code && err.code.toString().toUpperCase() === retriableError)) {
+                    log_js_1.logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
+                    return true;
+                }
+            }
+        }
+        // If attempt was against the secondary & it returned a StatusNotFound (404), then
+        // the resource was not found. This may be due to replication delay. So, in this
+        // case, we'll never try the secondary again for this operation.
+        if (response || err) {
+            const statusCode = response ? response.status : err ? err.statusCode : 0;
+            if (!isPrimaryRetry && statusCode === 404) {
+                log_js_1.logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
+                return true;
+            }
+            // Server internal error or server timeout
+            if (statusCode === 503 || statusCode === 500) {
+                log_js_1.logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
+                return true;
+            }
+        }
+        // [Copy source error code] Feature is pending on service side, skip retry on copy source error for now.
+        // if (response) {
+        //   // Retry select Copy Source Error Codes.
+        //   if (response?.status >= 400) {
+        //     const copySourceError = response.headers.get(HeaderConstants.X_MS_CopySourceErrorCode);
+        //     if (copySourceError !== undefined) {
+        //       switch (copySourceError)
+        //       {
+        //           case "InternalError":
+        //           case "OperationTimedOut":
+        //           case "ServerBusy":
+        //               return true;
+        //       }
+        //     }
+        //   }
+        // }
+        if ((err === null || err === void 0 ? void 0 : err.code) === "PARSE_ERROR" && (err === null || err === void 0 ? void 0 : err.message.startsWith(`Error "Error: Unclosed root tag`))) {
+            log_js_1.logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Delay a calculated time between retries.
+     *
+     * @param isPrimaryRetry -
+     * @param attempt -
+     * @param abortSignal -
+     */
+    async delay(isPrimaryRetry, attempt, abortSignal) {
+        let delayTimeInMs = 0;
+        if (isPrimaryRetry) {
+            switch (this.retryOptions.retryPolicyType) {
+                case StorageRetryPolicyType.EXPONENTIAL:
+                    delayTimeInMs = Math.min((Math.pow(2, attempt - 1) - 1) * this.retryOptions.retryDelayInMs, this.retryOptions.maxRetryDelayInMs);
+                    break;
+                case StorageRetryPolicyType.FIXED:
+                    delayTimeInMs = this.retryOptions.retryDelayInMs;
+                    break;
+            }
+        }
+        else {
+            delayTimeInMs = Math.random() * 1000;
+        }
+        log_js_1.logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
+        return (0, utils_common_js_1.delay)(delayTimeInMs, abortSignal, RETRY_ABORT_ERROR);
+    }
+}
+exports.StorageRetryPolicy = StorageRetryPolicy;
+//# sourceMappingURL=StorageRetryPolicy.js.map

package/dist/commonjs/policies/StorageRetryPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageRetryPolicy.js","sourceRoot":"","sources":["../../../src/policies/StorageRetryPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAwBlC,sDAMC;AA3BD,8DAAqD;AAQrD,sDAAwD;AAIxD,wDAAqD;AACrD,8DAAkE;AAClE,sCAAmC;AAEnC;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,YAAkC;IACtE,OAAO;QACL,MAAM,EAAE,CAAC,UAAyB,EAAE,OAA6B,EAAsB,EAAE;YACvF,OAAO,IAAI,kBAAkB,CAAC,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QACnE,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC;;OAEG;IACH,iFAAW,CAAA;IACX;;OAEG;IACH,qEAAK,CAAA;AACP,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAED,wCAAwC;AACxC,MAAM,qBAAqB,GAAwB;IACjD,iBAAiB,EAAE,GAAG,GAAG,IAAI;IAC7B,QAAQ,EAAE,CAAC;IACX,cAAc,EAAE,CAAC,GAAG,IAAI;IACxB,eAAe,EAAE,sBAAsB,CAAC,WAAW;IACnD,cAAc,EAAE,SAAS,EAAE,2CAA2C;CACvE,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,6BAAU,CAAC,4BAA4B,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAa,kBAAmB,SAAQ,gCAAiB;IAMvD;;;;;;OAMG;IACH,YACE,UAAyB,EACzB,OAA6B,EAC7B,eAAoC,qBAAqB;QAEzD,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAE3B,2BAA2B;QAC3B,IAAI,CAAC,YAAY,GAAG;YAClB,eAAe,EAAE,YAAY,CAAC,eAAe;gBAC3C,CAAC,CAAC,YAAY,CAAC,eAAe;gBAC9B,CAAC,CAAC,qBAAqB,CAAC,eAAe;YAEzC,QAAQ,EACN,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,QAAQ,IAAI,CAAC;gBACjD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC;gBACnC,CAAC,CAAC,qBAAqB,CAAC,QAAQ;YAEpC,cAAc,EACZ,YAAY,CAAC,cAAc,IAAI,YAAY,CAAC,cAAc,IAAI,CAAC;gBAC7D,CAAC,CAAC,YAAY,CAAC,cAAc;gBAC7B,CAAC,CAAC,qBAAqB,CAAC,cAAc;YAE1C,cAAc,EACZ,YAAY,CAAC,cAAc,IAAI,YAAY,CAAC,cAAc,IAAI,CAAC;gBAC7D,CAAC,CAAC,IAAI,CAAC,GAAG,CACN,YAAY,CAAC,cAAc,EAC3B,YAAY,CAAC,iBAAiB;oBAC5B,CAAC,CAAC,YAAY,CAAC,iBAAiB;oBAChC,CAAC,CAAC,qBAAqB,CAAC,iBAAkB,CAC7C;gBACH,CAAC,CAAC,qBAAqB,CAAC,cAAc;YAE1C,iBAAiB,EACf,YAAY,CAAC,iBAAiB,IAAI,YAAY,CAAC,iBAAiB,IAAI,CAAC;gBACnE,CAAC,CAAC,YAAY,CAAC,iBAAiB;gBAChC,CAAC,CAAC,qBAAqB,CAAC,iBAAiB;SAC9C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAoB;QAC3C,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACO,KAAK,CAAC,kBAAkB,CAChC,OAAoB,EACpB,eAAwB,EACxB,OAAe;QAEf,MAAM,UAAU,GAAgB,OAAO,CAAC,KAAK,EAAE,CAAC;QAEhD,MAAM,cAAc,GAAG,IAAI,CAAC;QAE5B,kEAAkE;QAClE,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;YACrC,UAAU,CAAC,GAAG,GAAG,IAAA,iCAAe,EAC9B,UAAU,CAAC,GAAG,EACd,2BAAY,CAAC,UAAU,CAAC,OAAO,EAC/B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,cAAe,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAChE,CAAC;QACJ,CAAC;QAED,IAAI,QAA2C,CAAC;QAChD,IAAI,CAAC;YACH,eAAM,CAAC,IAAI,CAAC,2BAA2B,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC9F,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,eAAe,GAAG,eAAe,IAAI,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC;QACpF,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,eAAM,CAAC,KAAK,CAAC,uCAAuC,GAAG,CAAC,OAAO,WAAW,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACtF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC;gBAC9D,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACO,WAAW,CACnB,cAAuB,EACvB,OAAe,EACf,QAAgC,EAChC,GAAe;QAEf,IAAI,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,QAAS,EAAE,CAAC;YAC3C,eAAM,CAAC,IAAI,CACT,2BAA2B,OAAO,gBAAgB,IAAI,CAAC,YAAY;iBAChE,QAAS,mBAAmB,CAChC,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC;QAED,iFAAiF;QACjF,uBAAuB;QACvB,MAAM,eAAe,GAAG;YACtB,WAAW;YACX,iBAAiB;YACjB,cAAc;YACd,YAAY;YACZ,QAAQ;YACR,WAAW;YACX,SAAS;YACT,OAAO;YACP,oBAAoB,EAAE,2DAA2D;SAClF,CAAC;QACF,IAAI,GAAG,EAAE,CAAC;YACR,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;gBAC7C,IACE,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;oBAC/C,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;oBAClD,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,EAClE,CAAC;oBACD,eAAM,CAAC,IAAI,CAAC,8BAA8B,cAAc,qBAAqB,CAAC,CAAC;oBAC/E,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,kFAAkF;QAClF,gFAAgF;QAChF,gEAAgE;QAChE,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YACzE,IAAI,CAAC,cAAc,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC1C,eAAM,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;gBACnE,OAAO,IAAI,CAAC;YACd,CAAC;YAED,0CAA0C;YAC1C,IAAI,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC7C,eAAM,CAAC,IAAI,CAAC,2CAA2C,UAAU,GAAG,CAAC,CAAC;gBACtE,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,wGAAwG;QACxG,kBAAkB;QAClB,6CAA6C;QAC7C,mCAAmC;QACnC,8FAA8F;QAC9F,2CAA2C;QAC3C,iCAAiC;QACjC,UAAU;QACV,kCAAkC;QAClC,sCAAsC;QACtC,+BAA+B;QAC/B,6BAA6B;QAC7B,UAAU;QACV,QAAQ;QACR,MAAM;QACN,IAAI;QAEJ,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,aAAa,KAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAA,EAAE,CAAC;YAC9F,eAAM,CAAC,IAAI,CACT,iFAAiF,CAClF,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,KAAK,CACjB,cAAuB,EACvB,OAAe,EACf,WAA6B;QAE7B,IAAI,aAAa,GAAW,CAAC,CAAC;QAE9B,IAAI,cAAc,EAAE,CAAC;YACnB,QAAQ,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;gBAC1C,KAAK,sBAAsB,CAAC,WAAW;oBACrC,aAAa,GAAG,IAAI,CAAC,GAAG,CACtB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,cAAe,EAClE,IAAI,CAAC,YAAY,CAAC,iBAAkB,CACrC,CAAC;oBACF,MAAM;gBACR,KAAK,sBAAsB,CAAC,KAAK;oBAC/B,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,cAAe,CAAC;oBAClD,MAAM;YACV,CAAC;QACH,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;QACvC,CAAC;QAED,eAAM,CAAC,IAAI,CAAC,0BAA0B,aAAa,IAAI,CAAC,CAAC;QACzD,OAAO,IAAA,uBAAK,EAAC,aAAa,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAC9D,CAAC;CACF;AA3OD,gDA2OC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport type {\n  RequestPolicy,\n  RequestPolicyOptionsLike as RequestPolicyOptions,\n  RequestPolicyFactory,\n  WebResourceLike as WebResource,\n  CompatResponse as HttpOperationResponse,\n} from \"@azure/core-http-compat\";\nimport { BaseRequestPolicy } from \"@azure/storage-blob\";\nimport type { RestError } from \"@azure/core-rest-pipeline\";\n\nimport type { StorageRetryOptions } from \"../StorageRetryPolicyFactory.js\";\nimport { URLConstants } from \"../utils/constants.js\";\nimport { delay, setURLParameter } from \"../utils/utils.common.js\";\nimport { logger } from \"../log.js\";\n\n/**\n * A factory method used to generated a RetryPolicy factory.\n *\n * @param retryOptions -\n */\nexport function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory {\n  return {\n    create: (nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy => {\n      return new StorageRetryPolicy(nextPolicy, options, retryOptions);\n    },\n  };\n}\n\n/**\n * RetryPolicy types.\n */\nexport enum StorageRetryPolicyType {\n  /**\n   * Exponential retry. Retry time delay grows exponentially.\n   */\n  EXPONENTIAL,\n  /**\n   * Linear retry. Retry time delay grows linearly.\n   */\n  FIXED,\n}\n\n// Default values of StorageRetryOptions\nconst DEFAULT_RETRY_OPTIONS: StorageRetryOptions = {\n  maxRetryDelayInMs: 120 * 1000,\n  maxTries: 4,\n  retryDelayInMs: 4 * 1000,\n  retryPolicyType: StorageRetryPolicyType.EXPONENTIAL,\n  tryTimeoutInMs: undefined, // Use server side default timeout strategy\n};\n\nconst RETRY_ABORT_ERROR = new AbortError(\"The operation was aborted.\");\n\n/**\n * Retry policy with exponential retry and linear retry implemented.\n */\nexport class StorageRetryPolicy extends BaseRequestPolicy {\n  /**\n   * RetryOptions.\n   */\n  private readonly retryOptions: StorageRetryOptions;\n\n  /**\n   * Creates an instance of RetryPolicy.\n   *\n   * @param nextPolicy -\n   * @param options -\n   * @param retryOptions -\n   */\n  constructor(\n    nextPolicy: RequestPolicy,\n    options: RequestPolicyOptions,\n    retryOptions: StorageRetryOptions = DEFAULT_RETRY_OPTIONS,\n  ) {\n    super(nextPolicy, options);\n\n    // Initialize retry options\n    this.retryOptions = {\n      retryPolicyType: retryOptions.retryPolicyType\n        ? retryOptions.retryPolicyType\n        : DEFAULT_RETRY_OPTIONS.retryPolicyType,\n\n      maxTries:\n        retryOptions.maxTries && retryOptions.maxTries >= 1\n          ? Math.floor(retryOptions.maxTries)\n          : DEFAULT_RETRY_OPTIONS.maxTries,\n\n      tryTimeoutInMs:\n        retryOptions.tryTimeoutInMs && retryOptions.tryTimeoutInMs >= 0\n          ? retryOptions.tryTimeoutInMs\n          : DEFAULT_RETRY_OPTIONS.tryTimeoutInMs,\n\n      retryDelayInMs:\n        retryOptions.retryDelayInMs && retryOptions.retryDelayInMs >= 0\n          ? Math.min(\n              retryOptions.retryDelayInMs,\n              retryOptions.maxRetryDelayInMs\n                ? retryOptions.maxRetryDelayInMs\n                : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs!,\n            )\n          : DEFAULT_RETRY_OPTIONS.retryDelayInMs,\n\n      maxRetryDelayInMs:\n        retryOptions.maxRetryDelayInMs && retryOptions.maxRetryDelayInMs >= 0\n          ? retryOptions.maxRetryDelayInMs\n          : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs,\n    };\n  }\n\n  /**\n   * Sends request.\n   *\n   * @param request -\n   */\n  public async sendRequest(request: WebResource): Promise<HttpOperationResponse> {\n    return this.attemptSendRequest(request, false, 1);\n  }\n\n  /**\n   * Decide and perform next retry. Won't mutate request parameter.\n   *\n   * @param request -\n   * @param secondaryHas404 -  If attempt was against the secondary & it returned a StatusNotFound (404), then\n   *                                   the resource was not found. This may be due to replication delay. So, in this\n   *                                   case, we'll never try the secondary again for this operation.\n   * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes\n   *                                   the attempt will be performed by this method call.\n   */\n  protected async attemptSendRequest(\n    request: WebResource,\n    secondaryHas404: boolean,\n    attempt: number,\n  ): Promise<HttpOperationResponse> {\n    const newRequest: WebResource = request.clone();\n\n    const isPrimaryRetry = true;\n\n    // Set the server-side timeout query parameter \"timeout=[seconds]\"\n    if (this.retryOptions.tryTimeoutInMs) {\n      newRequest.url = setURLParameter(\n        newRequest.url,\n        URLConstants.Parameters.TIMEOUT,\n        Math.floor(this.retryOptions.tryTimeoutInMs! / 1000).toString(),\n      );\n    }\n\n    let response: HttpOperationResponse | undefined;\n    try {\n      logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? \"Primary\" : \"Secondary\"}`);\n      response = await this._nextPolicy.sendRequest(newRequest);\n      if (!this.shouldRetry(isPrimaryRetry, attempt, response)) {\n        return response;\n      }\n\n      secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);\n    } catch (err: any) {\n      logger.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);\n      if (!this.shouldRetry(isPrimaryRetry, attempt, response, err)) {\n        throw err;\n      }\n    }\n\n    await this.delay(isPrimaryRetry, attempt, request.abortSignal);\n    return this.attemptSendRequest(request, secondaryHas404, ++attempt);\n  }\n\n  /**\n   * Decide whether to retry according to last HTTP response and retry counters.\n   *\n   * @param isPrimaryRetry -\n   * @param attempt -\n   * @param response -\n   * @param err -\n   */\n  protected shouldRetry(\n    isPrimaryRetry: boolean,\n    attempt: number,\n    response?: HttpOperationResponse,\n    err?: RestError,\n  ): boolean {\n    if (attempt >= this.retryOptions.maxTries!) {\n      logger.info(\n        `RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions\n          .maxTries!}, no further try.`,\n      );\n      return false;\n    }\n\n    // Handle network failures, you may need to customize the list when you implement\n    // your own http client\n    const retriableErrors = [\n      \"ETIMEDOUT\",\n      \"ESOCKETTIMEDOUT\",\n      \"ECONNREFUSED\",\n      \"ECONNRESET\",\n      \"ENOENT\",\n      \"ENOTFOUND\",\n      \"TIMEOUT\",\n      \"EPIPE\",\n      \"REQUEST_SEND_ERROR\", // For default xhr based http client provided in ms-rest-js\n    ];\n    if (err) {\n      for (const retriableError of retriableErrors) {\n        if (\n          err.name.toUpperCase().includes(retriableError) ||\n          err.message.toUpperCase().includes(retriableError) ||\n          (err.code && err.code.toString().toUpperCase() === retriableError)\n        ) {\n          logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);\n          return true;\n        }\n      }\n    }\n\n    // If attempt was against the secondary & it returned a StatusNotFound (404), then\n    // the resource was not found. This may be due to replication delay. So, in this\n    // case, we'll never try the secondary again for this operation.\n    if (response || err) {\n      const statusCode = response ? response.status : err ? err.statusCode : 0;\n      if (!isPrimaryRetry && statusCode === 404) {\n        logger.info(`RetryPolicy: Secondary access with 404, will retry.`);\n        return true;\n      }\n\n      // Server internal error or server timeout\n      if (statusCode === 503 || statusCode === 500) {\n        logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);\n        return true;\n      }\n    }\n\n    // [Copy source error code] Feature is pending on service side, skip retry on copy source error for now.\n    // if (response) {\n    //   // Retry select Copy Source Error Codes.\n    //   if (response?.status >= 400) {\n    //     const copySourceError = response.headers.get(HeaderConstants.X_MS_CopySourceErrorCode);\n    //     if (copySourceError !== undefined) {\n    //       switch (copySourceError)\n    //       {\n    //           case \"InternalError\":\n    //           case \"OperationTimedOut\":\n    //           case \"ServerBusy\":\n    //               return true;\n    //       }\n    //     }\n    //   }\n    // }\n\n    if (err?.code === \"PARSE_ERROR\" && err?.message.startsWith(`Error \"Error: Unclosed root tag`)) {\n      logger.info(\n        \"RetryPolicy: Incomplete XML response likely due to service timeout, will retry.\",\n      );\n      return true;\n    }\n\n    return false;\n  }\n\n  /**\n   * Delay a calculated time between retries.\n   *\n   * @param isPrimaryRetry -\n   * @param attempt -\n   * @param abortSignal -\n   */\n  private async delay(\n    isPrimaryRetry: boolean,\n    attempt: number,\n    abortSignal?: AbortSignalLike,\n  ): Promise<void> {\n    let delayTimeInMs: number = 0;\n\n    if (isPrimaryRetry) {\n      switch (this.retryOptions.retryPolicyType) {\n        case StorageRetryPolicyType.EXPONENTIAL:\n          delayTimeInMs = Math.min(\n            (Math.pow(2, attempt - 1) - 1) * this.retryOptions.retryDelayInMs!,\n            this.retryOptions.maxRetryDelayInMs!,\n          );\n          break;\n        case StorageRetryPolicyType.FIXED:\n          delayTimeInMs = this.retryOptions.retryDelayInMs!;\n          break;\n      }\n    } else {\n      delayTimeInMs = Math.random() * 1000;\n    }\n\n    logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);\n    return delay(delayTimeInMs, abortSignal, RETRY_ABORT_ERROR);\n  }\n}\n"]}

package/dist/commonjs/policies/StorageRetryPolicyV2.d.ts

@@ -0,0 +1,24 @@
+import type { PipelinePolicy } from "@azure/core-rest-pipeline";
+import type { StorageRetryOptions } from "../StorageRetryPolicyFactory.js";
+/**
+ * Name of the {@link storageRetryPolicy}
+ */
+export declare const storageRetryPolicyName = "storageRetryPolicy";
+/**
+ * RetryPolicy types.
+ */
+export declare enum StorageRetryPolicyType {
+    /**
+     * Exponential retry. Retry time delay grows exponentially.
+     */
+    EXPONENTIAL = 0,
+    /**
+     * Linear retry. Retry time delay grows linearly.
+     */
+    FIXED = 1
+}
+/**
+ * Retry policy with exponential retry and linear retry implemented.
+ */
+export declare function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy;
+//# sourceMappingURL=StorageRetryPolicyV2.d.ts.map

package/dist/commonjs/policies/StorageRetryPolicyV2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageRetryPolicyV2.d.ts","sourceRoot":"","sources":["../../../src/policies/StorageRetryPolicyV2.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,cAAc,EAIf,MAAM,2BAA2B,CAAC;AAGnC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAK3E;;GAEG;AACH,eAAO,MAAM,sBAAsB,uBAAuB,CAAC;AAE3D;;GAEG;AACH,oBAAY,sBAAsB;IAChC;;OAEG;IACH,WAAW,IAAA;IACX;;OAEG;IACH,KAAK,IAAA;CACN;AA0BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,GAAG,cAAc,CA0JpF"}