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

package/dist/react-native/FileSASPermissions.d.ts

@@ -0,0 +1,42 @@
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. Setting
+ * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
+ * the values are set, this should be serialized with toString and set as the permissions field on a
+ * {@link FileSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
+ */
+export declare class FileSASPermissions {
+    /**
+     * Creates a FileSASPermissions from the specified permissions string. This method will throw an
+     * Error if it encounters a character that does not correspond to a valid permission.
+     *
+     * @param permissions -
+     */
+    static parse(permissions: string): FileSASPermissions;
+    /**
+     * Specifies Read access granted.
+     */
+    read: boolean;
+    /**
+     * Specifies Create access granted.
+     */
+    create: boolean;
+    /**
+     * Specifies Write access granted.
+     */
+    write: boolean;
+    /**
+     * Specifies Delete access granted.
+     */
+    delete: boolean;
+    /**
+     * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
+     * order accepted by the service.
+     *
+     * @returns A string which represents the FileSASPermissions
+     */
+    toString(): string;
+}
+//# sourceMappingURL=FileSASPermissions.d.ts.map

package/dist/react-native/FileSASPermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSASPermissions.d.ts","sourceRoot":"","sources":["../../src/FileSASPermissions.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B;;;;;OAKG;WACW,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB;IAyB5D;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,KAAK,EAAE,OAAO,CAAS;IAE9B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;;;;OAKG;IACI,QAAQ,IAAI,MAAM;CAgB1B"}

package/dist/react-native/FileSASPermissions.js

@@ -0,0 +1,82 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. Setting
+ * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
+ * the values are set, this should be serialized with toString and set as the permissions field on a
+ * {@link FileSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
+ */
+export class FileSASPermissions {
+    constructor() {
+        /**
+         * Specifies Read access granted.
+         */
+        this.read = false;
+        /**
+         * Specifies Create access granted.
+         */
+        this.create = false;
+        /**
+         * Specifies Write access granted.
+         */
+        this.write = false;
+        /**
+         * Specifies Delete access granted.
+         */
+        this.delete = false;
+    }
+    /**
+     * Creates a FileSASPermissions from the specified permissions string. This method will throw an
+     * Error if it encounters a character that does not correspond to a valid permission.
+     *
+     * @param permissions -
+     */
+    static parse(permissions) {
+        const fileSASPermissions = new FileSASPermissions();
+        for (const char of permissions) {
+            switch (char) {
+                case "r":
+                    fileSASPermissions.read = true;
+                    break;
+                case "c":
+                    fileSASPermissions.create = true;
+                    break;
+                case "w":
+                    fileSASPermissions.write = true;
+                    break;
+                case "d":
+                    fileSASPermissions.delete = true;
+                    break;
+                default:
+                    throw new RangeError(`Invalid permission: ${char}`);
+            }
+        }
+        return fileSASPermissions;
+    }
+    /**
+     * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
+     * order accepted by the service.
+     *
+     * @returns A string which represents the FileSASPermissions
+     */
+    toString() {
+        const permissions = [];
+        if (this.read) {
+            permissions.push("r");
+        }
+        if (this.create) {
+            permissions.push("c");
+        }
+        if (this.write) {
+            permissions.push("w");
+        }
+        if (this.delete) {
+            permissions.push("d");
+        }
+        return permissions.join("");
+    }
+}
+//# sourceMappingURL=FileSASPermissions.js.map

package/dist/react-native/FileSASPermissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSASPermissions.js","sourceRoot":"","sources":["../../src/FileSASPermissions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAkB;IAA/B;QAgCE;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;QAE9B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;IAwBjC,CAAC;IAzEC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAEpD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;YAC/B,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,GAAG;oBACN,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAC/B,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;oBAChC,MAAM;gBACR,KAAK,GAAG;oBACN,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,uBAAuB,IAAI,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAsBD;;;;;OAKG;IACI,QAAQ;QACb,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. Setting\n * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all\n * the values are set, this should be serialized with toString and set as the permissions field on a\n * {@link FileSASSignatureValues} object. It is possible to construct the permissions string without this class, but\n * the order of the permissions is particular and this class guarantees correctness.\n */\nexport class FileSASPermissions {\n  /**\n   * Creates a FileSASPermissions from the specified permissions string. This method will throw an\n   * Error if it encounters a character that does not correspond to a valid permission.\n   *\n   * @param permissions -\n   */\n  public static parse(permissions: string): FileSASPermissions {\n    const fileSASPermissions = new FileSASPermissions();\n\n    for (const char of permissions) {\n      switch (char) {\n        case \"r\":\n          fileSASPermissions.read = true;\n          break;\n        case \"c\":\n          fileSASPermissions.create = true;\n          break;\n        case \"w\":\n          fileSASPermissions.write = true;\n          break;\n        case \"d\":\n          fileSASPermissions.delete = true;\n          break;\n        default:\n          throw new RangeError(`Invalid permission: ${char}`);\n      }\n    }\n\n    return fileSASPermissions;\n  }\n\n  /**\n   * Specifies Read access granted.\n   */\n  public read: boolean = false;\n\n  /**\n   * Specifies Create access granted.\n   */\n  public create: boolean = false;\n\n  /**\n   * Specifies Write access granted.\n   */\n  public write: boolean = false;\n\n  /**\n   * Specifies Delete access granted.\n   */\n  public delete: boolean = false;\n\n  /**\n   * Converts the given permissions to a string. Using this method will guarantee the permissions are in an\n   * order accepted by the service.\n   *\n   * @returns A string which represents the FileSASPermissions\n   */\n  public toString(): string {\n    const permissions: string[] = [];\n    if (this.read) {\n      permissions.push(\"r\");\n    }\n    if (this.create) {\n      permissions.push(\"c\");\n    }\n    if (this.write) {\n      permissions.push(\"w\");\n    }\n    if (this.delete) {\n      permissions.push(\"d\");\n    }\n    return permissions.join(\"\");\n  }\n}\n"]}

package/dist/react-native/FileSASSignatureValues.d.ts

@@ -0,0 +1,95 @@
+import type { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { FileSASPermissions } from "./FileSASPermissions.js";
+import type { SasIPRange } from "./SasIPRange.js";
+import type { SASProtocol } from "./SASQueryParameters.js";
+import { SASQueryParameters } from "./SASQueryParameters.js";
+import { ShareSASPermissions } from "./ShareSASPermissions.js";
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * FileSASSignatureValues is used to help generating File service SAS tokens for shares or files.
+ */
+export interface FileSASSignatureValues {
+    /**
+     * The version of the service this SAS will target. If not specified, it will default to the version targeted by the
+     * library.
+     */
+    version?: string;
+    /**
+     * Optional. SAS protocols, HTTPS only or HTTPSandHTTP
+     */
+    protocol?: SASProtocol;
+    /**
+     * Optional. When the SAS will take effect.
+     */
+    startsOn?: Date;
+    /**
+     * Optional only when identifier is provided. The time after which the SAS will no longer work.
+     */
+    expiresOn?: Date;
+    /**
+     * Optional only when identifier is provided.
+     * Please refer to either {@link ShareSASPermissions} or {@link FileSASPermissions} depending on the resource
+     * being accessed for help constructing the permissions string.
+     */
+    permissions?: FileSASPermissions | ShareSASPermissions;
+    /**
+     * Optional. IP ranges allowed in this SAS.
+     */
+    ipRange?: SasIPRange;
+    /**
+     * The name of the share the SAS user may access.
+     */
+    shareName: string;
+    /**
+     * Optional. The path of the file like, "directory/FileName" or "FileName".
+     */
+    filePath?: string;
+    /**
+     * Optional. The name of the access policy on the share this SAS references if any.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     */
+    identifier?: string;
+    /**
+     * Optional. The cache-control header for the SAS.
+     */
+    cacheControl?: string;
+    /**
+     * Optional. The content-disposition header for the SAS.
+     */
+    contentDisposition?: string;
+    /**
+     * Optional. The content-encoding header for the SAS.
+     */
+    contentEncoding?: string;
+    /**
+     * Optional. The content-language header for the SAS.
+     */
+    contentLanguage?: string;
+    /**
+     * Optional. The content-type header for the SAS.
+     */
+    contentType?: string;
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn and identifier.
+ *
+ * WARNING: When identifier is not provided, permissions and expiresOn are required.
+ * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
+ * this constructor.
+ *
+ * @param fileSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+export declare function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters;
+export declare function generateFileSASQueryParametersInternal(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): {
+    sasQueryParameters: SASQueryParameters;
+    stringToSign: string;
+};
+//# sourceMappingURL=FileSASSignatureValues.d.ts.map

package/dist/react-native/FileSASSignatureValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSASSignatureValues.d.ts","sourceRoot":"","sources":["../../src/FileSASSignatureValues.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAI/D;;;;GAIG;AAEH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,kBAAkB,GAAG,mBAAmB,CAAC;IAEvD;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,8BAA8B,CAC5C,sBAAsB,EAAE,sBAAsB,EAC9C,mBAAmB,EAAE,0BAA0B,GAC9C,kBAAkB,CAGpB;AAED,wBAAgB,sCAAsC,CACpD,sBAAsB,EAAE,sBAAsB,EAC9C,mBAAmB,EAAE,0BAA0B,GAC9C;IAAE,kBAAkB,EAAE,kBAAkB,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CA8ElE"}

package/dist/react-native/FileSASSignatureValues.js

@@ -0,0 +1,84 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { FileSASPermissions } from "./FileSASPermissions.js";
+import { ipRangeToString } from "./SasIPRange.js";
+import { SASQueryParameters } from "./SASQueryParameters.js";
+import { ShareSASPermissions } from "./ShareSASPermissions.js";
+import { SERVICE_VERSION } from "./utils/constants.js";
+import { truncatedISO8061Date } from "./utils/utils.common.js";
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn and identifier.
+ *
+ * WARNING: When identifier is not provided, permissions and expiresOn are required.
+ * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
+ * this constructor.
+ *
+ * @param fileSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+export function generateFileSASQueryParameters(fileSASSignatureValues, sharedKeyCredential) {
+    return generateFileSASQueryParametersInternal(fileSASSignatureValues, sharedKeyCredential)
+        .sasQueryParameters;
+}
+export function generateFileSASQueryParametersInternal(fileSASSignatureValues, sharedKeyCredential) {
+    if (!fileSASSignatureValues.identifier &&
+        !(fileSASSignatureValues.permissions && fileSASSignatureValues.expiresOn)) {
+        throw new RangeError("Must provide 'permissions' and 'expiresOn' for File SAS generation when 'identifier' is not provided.");
+    }
+    const version = fileSASSignatureValues.version ? fileSASSignatureValues.version : SERVICE_VERSION;
+    let resource = "s";
+    if (fileSASSignatureValues.filePath) {
+        resource = "f";
+    }
+    let verifiedPermissions;
+    // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+    if (fileSASSignatureValues.permissions) {
+        if (fileSASSignatureValues.filePath) {
+            verifiedPermissions = FileSASPermissions.parse(fileSASSignatureValues.permissions.toString()).toString();
+        }
+        else {
+            verifiedPermissions = ShareSASPermissions.parse(fileSASSignatureValues.permissions.toString()).toString();
+        }
+    }
+    // Signature is generated on the un-url-encoded values.
+    const stringToSign = [
+        verifiedPermissions,
+        fileSASSignatureValues.startsOn
+            ? truncatedISO8061Date(fileSASSignatureValues.startsOn, false)
+            : "",
+        fileSASSignatureValues.expiresOn
+            ? truncatedISO8061Date(fileSASSignatureValues.expiresOn, false)
+            : "",
+        getCanonicalName(sharedKeyCredential.accountName, fileSASSignatureValues.shareName, fileSASSignatureValues.filePath),
+        fileSASSignatureValues.identifier,
+        fileSASSignatureValues.ipRange ? ipRangeToString(fileSASSignatureValues.ipRange) : "",
+        fileSASSignatureValues.protocol,
+        version,
+        fileSASSignatureValues.cacheControl,
+        fileSASSignatureValues.contentDisposition,
+        fileSASSignatureValues.contentEncoding,
+        fileSASSignatureValues.contentLanguage,
+        fileSASSignatureValues.contentType,
+    ].join("\n");
+    const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
+    return {
+        sasQueryParameters: new SASQueryParameters(version, signature, verifiedPermissions, undefined, undefined, fileSASSignatureValues.protocol, fileSASSignatureValues.startsOn, fileSASSignatureValues.expiresOn, fileSASSignatureValues.ipRange, fileSASSignatureValues.identifier, resource, fileSASSignatureValues.cacheControl, fileSASSignatureValues.contentDisposition, fileSASSignatureValues.contentEncoding, fileSASSignatureValues.contentLanguage, fileSASSignatureValues.contentType),
+        stringToSign: stringToSign,
+    };
+}
+function getCanonicalName(accountName, shareName, filePath) {
+    // Share: "/file/account/sharename"
+    // File:  "/file/account/sharename/filename"
+    // File:  "/file/account/sharename/directoryname/filename"
+    const elements = [`/file/${accountName}/${shareName}`];
+    if (filePath) {
+        elements.push(`/${filePath}`);
+    }
+    return elements.join("");
+}
+//# sourceMappingURL=FileSASSignatureValues.js.map

package/dist/react-native/FileSASSignatureValues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSASSignatureValues.js","sourceRoot":"","sources":["../../src/FileSASSignatureValues.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAqF/D;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,8BAA8B,CAC5C,sBAA8C,EAC9C,mBAA+C;IAE/C,OAAO,sCAAsC,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;SACvF,kBAAkB,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,sCAAsC,CACpD,sBAA8C,EAC9C,mBAA+C;IAE/C,IACE,CAAC,sBAAsB,CAAC,UAAU;QAClC,CAAC,CAAC,sBAAsB,CAAC,WAAW,IAAI,sBAAsB,CAAC,SAAS,CAAC,EACzE,CAAC;QACD,MAAM,IAAI,UAAU,CAClB,uGAAuG,CACxG,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;IAClG,IAAI,QAAQ,GAAW,GAAG,CAAC;IAC3B,IAAI,sBAAsB,CAAC,QAAQ,EAAE,CAAC;QACpC,QAAQ,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,IAAI,mBAAuC,CAAC;IAC5C,8FAA8F;IAC9F,IAAI,sBAAsB,CAAC,WAAW,EAAE,CAAC;QACvC,IAAI,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YACpC,mBAAmB,GAAG,kBAAkB,CAAC,KAAK,CAC5C,sBAAsB,CAAC,WAAW,CAAC,QAAQ,EAAE,CAC9C,CAAC,QAAQ,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,mBAAmB,GAAG,mBAAmB,CAAC,KAAK,CAC7C,sBAAsB,CAAC,WAAW,CAAC,QAAQ,EAAE,CAC9C,CAAC,QAAQ,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,uDAAuD;IACvD,MAAM,YAAY,GAAG;QACnB,mBAAmB;QACnB,sBAAsB,CAAC,QAAQ;YAC7B,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,QAAQ,EAAE,KAAK,CAAC;YAC9D,CAAC,CAAC,EAAE;QACN,sBAAsB,CAAC,SAAS;YAC9B,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,SAAS,EAAE,KAAK,CAAC;YAC/D,CAAC,CAAC,EAAE;QACN,gBAAgB,CACd,mBAAmB,CAAC,WAAW,EAC/B,sBAAsB,CAAC,SAAS,EAChC,sBAAsB,CAAC,QAAQ,CAChC;QACD,sBAAsB,CAAC,UAAU;QACjC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;QACrF,sBAAsB,CAAC,QAAQ;QAC/B,OAAO;QACP,sBAAsB,CAAC,YAAY;QACnC,sBAAsB,CAAC,kBAAkB;QACzC,sBAAsB,CAAC,eAAe;QACtC,sBAAsB,CAAC,eAAe;QACtC,sBAAsB,CAAC,WAAW;KACnC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,MAAM,SAAS,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAEtE,OAAO;QACL,kBAAkB,EAAE,IAAI,kBAAkB,CACxC,OAAO,EACP,SAAS,EACT,mBAAmB,EACnB,SAAS,EACT,SAAS,EACT,sBAAsB,CAAC,QAAQ,EAC/B,sBAAsB,CAAC,QAAQ,EAC/B,sBAAsB,CAAC,SAAS,EAChC,sBAAsB,CAAC,OAAO,EAC9B,sBAAsB,CAAC,UAAU,EACjC,QAAQ,EACR,sBAAsB,CAAC,YAAY,EACnC,sBAAsB,CAAC,kBAAkB,EACzC,sBAAsB,CAAC,eAAe,EACtC,sBAAsB,CAAC,eAAe,EACtC,sBAAsB,CAAC,WAAW,CACnC;QACD,YAAY,EAAE,YAAY;KAC3B,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,WAAmB,EAAE,SAAiB,EAAE,QAAiB;IACjF,mCAAmC;IACnC,4CAA4C;IAC5C,0DAA0D;IAC1D,MAAM,QAAQ,GAAa,CAAC,SAAS,WAAW,IAAI,SAAS,EAAE,CAAC,CAAC;IACjE,IAAI,QAAQ,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { StorageSharedKeyCredential } from \"@azure/storage-blob\";\nimport { FileSASPermissions } from \"./FileSASPermissions.js\";\nimport type { SasIPRange } from \"./SasIPRange.js\";\nimport { ipRangeToString } from \"./SasIPRange.js\";\nimport type { SASProtocol } from \"./SASQueryParameters.js\";\nimport { SASQueryParameters } from \"./SASQueryParameters.js\";\nimport { ShareSASPermissions } from \"./ShareSASPermissions.js\";\nimport { SERVICE_VERSION } from \"./utils/constants.js\";\nimport { truncatedISO8061Date } from \"./utils/utils.common.js\";\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * FileSASSignatureValues is used to help generating File service SAS tokens for shares or files.\n */\n\nexport interface FileSASSignatureValues {\n  /**\n   * The version of the service this SAS will target. If not specified, it will default to the version targeted by the\n   * library.\n   */\n  version?: string;\n\n  /**\n   * Optional. SAS protocols, HTTPS only or HTTPSandHTTP\n   */\n  protocol?: SASProtocol;\n\n  /**\n   * Optional. When the SAS will take effect.\n   */\n  startsOn?: Date;\n\n  /**\n   * Optional only when identifier is provided. The time after which the SAS will no longer work.\n   */\n  expiresOn?: Date;\n\n  /**\n   * Optional only when identifier is provided.\n   * Please refer to either {@link ShareSASPermissions} or {@link FileSASPermissions} depending on the resource\n   * being accessed for help constructing the permissions string.\n   */\n  permissions?: FileSASPermissions | ShareSASPermissions;\n\n  /**\n   * Optional. IP ranges allowed in this SAS.\n   */\n  ipRange?: SasIPRange;\n\n  /**\n   * The name of the share the SAS user may access.\n   */\n  shareName: string;\n\n  /**\n   * Optional. The path of the file like, \"directory/FileName\" or \"FileName\".\n   */\n  filePath?: string;\n\n  /**\n   * Optional. The name of the access policy on the share this SAS references if any.\n   *\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy\n   */\n  identifier?: string;\n\n  /**\n   * Optional. The cache-control header for the SAS.\n   */\n  cacheControl?: string;\n\n  /**\n   * Optional. The content-disposition header for the SAS.\n   */\n  contentDisposition?: string;\n\n  /**\n   * Optional. The content-encoding header for the SAS.\n   */\n  contentEncoding?: string;\n\n  /**\n   * Optional. The content-language header for the SAS.\n   */\n  contentLanguage?: string;\n\n  /**\n   * Optional. The content-type header for the SAS.\n   */\n  contentType?: string;\n}\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * Creates an instance of SASQueryParameters.\n *\n * Only accepts required settings needed to create a SAS. For optional settings please\n * set corresponding properties directly, such as permissions, startsOn and identifier.\n *\n * WARNING: When identifier is not provided, permissions and expiresOn are required.\n * You MUST assign value to identifier or expiresOn & permissions manually if you initial with\n * this constructor.\n *\n * @param fileSASSignatureValues -\n * @param sharedKeyCredential -\n */\nexport function generateFileSASQueryParameters(\n  fileSASSignatureValues: FileSASSignatureValues,\n  sharedKeyCredential: StorageSharedKeyCredential,\n): SASQueryParameters {\n  return generateFileSASQueryParametersInternal(fileSASSignatureValues, sharedKeyCredential)\n    .sasQueryParameters;\n}\n\nexport function generateFileSASQueryParametersInternal(\n  fileSASSignatureValues: FileSASSignatureValues,\n  sharedKeyCredential: StorageSharedKeyCredential,\n): { sasQueryParameters: SASQueryParameters; stringToSign: string } {\n  if (\n    !fileSASSignatureValues.identifier &&\n    !(fileSASSignatureValues.permissions && fileSASSignatureValues.expiresOn)\n  ) {\n    throw new RangeError(\n      \"Must provide 'permissions' and 'expiresOn' for File SAS generation when 'identifier' is not provided.\",\n    );\n  }\n\n  const version = fileSASSignatureValues.version ? fileSASSignatureValues.version : SERVICE_VERSION;\n  let resource: string = \"s\";\n  if (fileSASSignatureValues.filePath) {\n    resource = \"f\";\n  }\n\n  let verifiedPermissions: string | undefined;\n  // Calling parse and toString guarantees the proper ordering and throws on invalid characters.\n  if (fileSASSignatureValues.permissions) {\n    if (fileSASSignatureValues.filePath) {\n      verifiedPermissions = FileSASPermissions.parse(\n        fileSASSignatureValues.permissions.toString(),\n      ).toString();\n    } else {\n      verifiedPermissions = ShareSASPermissions.parse(\n        fileSASSignatureValues.permissions.toString(),\n      ).toString();\n    }\n  }\n\n  // Signature is generated on the un-url-encoded values.\n  const stringToSign = [\n    verifiedPermissions,\n    fileSASSignatureValues.startsOn\n      ? truncatedISO8061Date(fileSASSignatureValues.startsOn, false)\n      : \"\",\n    fileSASSignatureValues.expiresOn\n      ? truncatedISO8061Date(fileSASSignatureValues.expiresOn, false)\n      : \"\",\n    getCanonicalName(\n      sharedKeyCredential.accountName,\n      fileSASSignatureValues.shareName,\n      fileSASSignatureValues.filePath,\n    ),\n    fileSASSignatureValues.identifier,\n    fileSASSignatureValues.ipRange ? ipRangeToString(fileSASSignatureValues.ipRange) : \"\",\n    fileSASSignatureValues.protocol,\n    version,\n    fileSASSignatureValues.cacheControl,\n    fileSASSignatureValues.contentDisposition,\n    fileSASSignatureValues.contentEncoding,\n    fileSASSignatureValues.contentLanguage,\n    fileSASSignatureValues.contentType,\n  ].join(\"\\n\");\n\n  const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);\n\n  return {\n    sasQueryParameters: new SASQueryParameters(\n      version,\n      signature,\n      verifiedPermissions,\n      undefined,\n      undefined,\n      fileSASSignatureValues.protocol,\n      fileSASSignatureValues.startsOn,\n      fileSASSignatureValues.expiresOn,\n      fileSASSignatureValues.ipRange,\n      fileSASSignatureValues.identifier,\n      resource,\n      fileSASSignatureValues.cacheControl,\n      fileSASSignatureValues.contentDisposition,\n      fileSASSignatureValues.contentEncoding,\n      fileSASSignatureValues.contentLanguage,\n      fileSASSignatureValues.contentType,\n    ),\n    stringToSign: stringToSign,\n  };\n}\n\nfunction getCanonicalName(accountName: string, shareName: string, filePath?: string): string {\n  // Share: \"/file/account/sharename\"\n  // File:  \"/file/account/sharename/filename\"\n  // File:  \"/file/account/sharename/directoryname/filename\"\n  const elements: string[] = [`/file/${accountName}/${shareName}`];\n  if (filePath) {\n    elements.push(`/${filePath}`);\n  }\n  return elements.join(\"\");\n}\n"]}

package/dist/react-native/FileSystemAttributes.d.ts

@@ -0,0 +1,63 @@
+/**
+ * This is a helper class to construct a string representing the NTFS attributes to a file or directory.
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
+ */
+export declare class FileSystemAttributes {
+    /**
+     * Creates a FileSystemAttributes from the specified attributes string. This method will throw an
+     * Error if it encounters a string that does not correspond to a valid attributes.
+     *
+     * @param fileAttributes - The value of header x-ms-file-attributes.
+     */
+    static parse(fileAttributes: string): FileSystemAttributes;
+    /**
+     * Specifies a directory or file that is read-only.
+     */
+    readonly: boolean;
+    /**
+     * Specifies a directory or file is hidden.
+     */
+    hidden: boolean;
+    /**
+     * Specifies a directory or file that the operating system uses a part of, or uses exclusively.
+     */
+    system: boolean;
+    /**
+     * Specifies a directory or file that does not have other attributes set. This attribute is valid only when used alone.
+     */
+    none: boolean;
+    /**
+     * Specifies the handle identifies a directory.
+     */
+    directory: boolean;
+    /**
+     * Specifies a directory or file is an archive. Applications typically use this attribute to mark files for backup or removal.
+     */
+    archive: boolean;
+    /**
+     * Specifies if a file is temporary.
+     */
+    temporary: boolean;
+    /**
+     * Specifies the data of a directory or file is not available immediately.
+     * This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options.
+     */
+    offline: boolean;
+    /**
+     * Specifies the directory or file is not to be indexed by the content indexing service.
+     */
+    notContentIndexed: boolean;
+    /**
+     * Specifies the user data stream not to be read by the background data integrity scanner.
+     * This file system attribute is presented primarily to provide compatibility with Windows.
+     * Applicable to directory or file.
+     */
+    noScrubData: boolean;
+    /**
+     * Converts the given attributes to a string.
+     *
+     * @returns A string which represents the FileSystemAttributes
+     */
+    toString(): string;
+}
+//# sourceMappingURL=FileSystemAttributes.d.ts.map

package/dist/react-native/FileSystemAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystemAttributes.d.ts","sourceRoot":"","sources":["../../src/FileSystemAttributes.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B;;;;;OAKG;WACW,KAAK,CAAC,cAAc,EAAE,MAAM,GAAG,oBAAoB;IAkDjE;;OAEG;IACI,QAAQ,EAAE,OAAO,CAAS;IAEjC;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,MAAM,EAAE,OAAO,CAAS;IAE/B;;OAEG;IACI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IACI,SAAS,EAAE,OAAO,CAAS;IAElC;;OAEG;IACI,OAAO,EAAE,OAAO,CAAS;IAEhC;;OAEG;IACI,SAAS,EAAE,OAAO,CAAS;IAElC;;;OAGG;IACI,OAAO,EAAE,OAAO,CAAS;IAEhC;;OAEG;IACI,iBAAiB,EAAE,OAAO,CAAS;IAE1C;;;;OAIG;IACI,WAAW,EAAE,OAAO,CAAS;IAEpC;;;;OAIG;IACI,QAAQ,IAAI,MAAM;CAkC1B"}

package/dist/react-native/FileSystemAttributes.js

@@ -0,0 +1,144 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * This is a helper class to construct a string representing the NTFS attributes to a file or directory.
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
+ */
+export class FileSystemAttributes {
+    constructor() {
+        /**
+         * Specifies a directory or file that is read-only.
+         */
+        this.readonly = false;
+        /**
+         * Specifies a directory or file is hidden.
+         */
+        this.hidden = false;
+        /**
+         * Specifies a directory or file that the operating system uses a part of, or uses exclusively.
+         */
+        this.system = false;
+        /**
+         * Specifies a directory or file that does not have other attributes set. This attribute is valid only when used alone.
+         */
+        this.none = false;
+        /**
+         * Specifies the handle identifies a directory.
+         */
+        this.directory = false;
+        /**
+         * Specifies a directory or file is an archive. Applications typically use this attribute to mark files for backup or removal.
+         */
+        this.archive = false;
+        /**
+         * Specifies if a file is temporary.
+         */
+        this.temporary = false;
+        /**
+         * Specifies the data of a directory or file is not available immediately.
+         * This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options.
+         */
+        this.offline = false;
+        /**
+         * Specifies the directory or file is not to be indexed by the content indexing service.
+         */
+        this.notContentIndexed = false;
+        /**
+         * Specifies the user data stream not to be read by the background data integrity scanner.
+         * This file system attribute is presented primarily to provide compatibility with Windows.
+         * Applicable to directory or file.
+         */
+        this.noScrubData = false;
+    }
+    /**
+     * Creates a FileSystemAttributes from the specified attributes string. This method will throw an
+     * Error if it encounters a string that does not correspond to a valid attributes.
+     *
+     * @param fileAttributes - The value of header x-ms-file-attributes.
+     */
+    static parse(fileAttributes) {
+        if (!fileAttributes) {
+            throw new RangeError(`Invalid fileAttributes: '${fileAttributes}'.`);
+        }
+        const fileSystemAttributes = new FileSystemAttributes();
+        const attributes = fileAttributes.trim().split("|");
+        for (let str of attributes) {
+            str = str.trim();
+            switch (str) {
+                case "ReadOnly":
+                    fileSystemAttributes.readonly = true;
+                    break;
+                case "Hidden":
+                    fileSystemAttributes.hidden = true;
+                    break;
+                case "System":
+                    fileSystemAttributes.system = true;
+                    break;
+                case "None":
+                    fileSystemAttributes.none = true;
+                    break;
+                case "Temporary":
+                    fileSystemAttributes.temporary = true;
+                    break;
+                case "Offline":
+                    fileSystemAttributes.offline = true;
+                    break;
+                case "Directory":
+                    fileSystemAttributes.directory = true;
+                    break;
+                case "Archive":
+                    fileSystemAttributes.archive = true;
+                    break;
+                case "NotContentIndexed":
+                    fileSystemAttributes.notContentIndexed = true;
+                    break;
+                case "NoScrubData":
+                    fileSystemAttributes.noScrubData = true;
+                    break;
+                default:
+                    throw new RangeError(`Invalid attribute: ${str}`);
+            }
+        }
+        return fileSystemAttributes;
+    }
+    /**
+     * Converts the given attributes to a string.
+     *
+     * @returns A string which represents the FileSystemAttributes
+     */
+    toString() {
+        const attributes = [];
+        if (this.readonly) {
+            attributes.push("ReadOnly");
+        }
+        if (this.hidden) {
+            attributes.push("Hidden");
+        }
+        if (this.system) {
+            attributes.push("System");
+        }
+        if (this.none) {
+            attributes.push("None");
+        }
+        if (this.temporary) {
+            attributes.push("Temporary");
+        }
+        if (this.directory) {
+            attributes.push("Directory");
+        }
+        if (this.archive) {
+            attributes.push("Archive");
+        }
+        if (this.offline) {
+            attributes.push("Offline");
+        }
+        if (this.notContentIndexed) {
+            attributes.push("NotContentIndexed");
+        }
+        if (this.noScrubData) {
+            attributes.push("NoScrubData");
+        }
+        return attributes.join("|");
+    }
+}
+//# sourceMappingURL=FileSystemAttributes.js.map

package/dist/react-native/FileSystemAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystemAttributes.js","sourceRoot":"","sources":["../../src/FileSystemAttributes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAAjC;QAyDE;;WAEG;QACI,aAAQ,GAAY,KAAK,CAAC;QAEjC;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,cAAS,GAAY,KAAK,CAAC;QAElC;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;QAEhC;;WAEG;QACI,cAAS,GAAY,KAAK,CAAC;QAElC;;;WAGG;QACI,YAAO,GAAY,KAAK,CAAC;QAEhC;;WAEG;QACI,sBAAiB,GAAY,KAAK,CAAC;QAE1C;;;;WAIG;QACI,gBAAW,GAAY,KAAK,CAAC;IAyCtC,CAAC;IApJC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,cAAsB;QACxC,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,UAAU,CAAC,4BAA4B,cAAc,IAAI,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAExD,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEpD,KAAK,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;YAC3B,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,QAAQ,GAAG,EAAE,CAAC;gBACZ,KAAK,UAAU;oBACb,oBAAoB,CAAC,QAAQ,GAAG,IAAI,CAAC;oBACrC,MAAM;gBACR,KAAK,QAAQ;oBACX,oBAAoB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACnC,MAAM;gBACR,KAAK,QAAQ;oBACX,oBAAoB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACnC,MAAM;gBACR,KAAK,MAAM;oBACT,oBAAoB,CAAC,IAAI,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR,KAAK,WAAW;oBACd,oBAAoB,CAAC,SAAS,GAAG,IAAI,CAAC;oBACtC,MAAM;gBACR,KAAK,SAAS;oBACZ,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,WAAW;oBACd,oBAAoB,CAAC,SAAS,GAAG,IAAI,CAAC;oBACtC,MAAM;gBACR,KAAK,SAAS;oBACZ,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,mBAAmB;oBACtB,oBAAoB,CAAC,iBAAiB,GAAG,IAAI,CAAC;oBAC9C,MAAM;gBACR,KAAK,aAAa;oBAChB,oBAAoB,CAAC,WAAW,GAAG,IAAI,CAAC;oBACxC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,sBAAsB,GAAG,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAuDD;;;;OAIG;IACI,QAAQ;QACb,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * This is a helper class to construct a string representing the NTFS attributes to a file or directory.\n * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes\n */\nexport class FileSystemAttributes {\n  /**\n   * Creates a FileSystemAttributes from the specified attributes string. This method will throw an\n   * Error if it encounters a string that does not correspond to a valid attributes.\n   *\n   * @param fileAttributes - The value of header x-ms-file-attributes.\n   */\n  public static parse(fileAttributes: string): FileSystemAttributes {\n    if (!fileAttributes) {\n      throw new RangeError(`Invalid fileAttributes: '${fileAttributes}'.`);\n    }\n\n    const fileSystemAttributes = new FileSystemAttributes();\n\n    const attributes = fileAttributes.trim().split(\"|\");\n\n    for (let str of attributes) {\n      str = str.trim();\n      switch (str) {\n        case \"ReadOnly\":\n          fileSystemAttributes.readonly = true;\n          break;\n        case \"Hidden\":\n          fileSystemAttributes.hidden = true;\n          break;\n        case \"System\":\n          fileSystemAttributes.system = true;\n          break;\n        case \"None\":\n          fileSystemAttributes.none = true;\n          break;\n        case \"Temporary\":\n          fileSystemAttributes.temporary = true;\n          break;\n        case \"Offline\":\n          fileSystemAttributes.offline = true;\n          break;\n        case \"Directory\":\n          fileSystemAttributes.directory = true;\n          break;\n        case \"Archive\":\n          fileSystemAttributes.archive = true;\n          break;\n        case \"NotContentIndexed\":\n          fileSystemAttributes.notContentIndexed = true;\n          break;\n        case \"NoScrubData\":\n          fileSystemAttributes.noScrubData = true;\n          break;\n        default:\n          throw new RangeError(`Invalid attribute: ${str}`);\n      }\n    }\n\n    return fileSystemAttributes;\n  }\n\n  /**\n   * Specifies a directory or file that is read-only.\n   */\n  public readonly: boolean = false;\n\n  /**\n   * Specifies a directory or file is hidden.\n   */\n  public hidden: boolean = false;\n\n  /**\n   * Specifies a directory or file that the operating system uses a part of, or uses exclusively.\n   */\n  public system: boolean = false;\n\n  /**\n   * Specifies a directory or file that does not have other attributes set. This attribute is valid only when used alone.\n   */\n  public none: boolean = false;\n\n  /**\n   * Specifies the handle identifies a directory.\n   */\n  public directory: boolean = false;\n\n  /**\n   * Specifies a directory or file is an archive. Applications typically use this attribute to mark files for backup or removal.\n   */\n  public archive: boolean = false;\n\n  /**\n   * Specifies if a file is temporary.\n   */\n  public temporary: boolean = false;\n\n  /**\n   * Specifies the data of a directory or file is not available immediately.\n   * This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options.\n   */\n  public offline: boolean = false;\n\n  /**\n   * Specifies the directory or file is not to be indexed by the content indexing service.\n   */\n  public notContentIndexed: boolean = false;\n\n  /**\n   * Specifies the user data stream not to be read by the background data integrity scanner.\n   * This file system attribute is presented primarily to provide compatibility with Windows.\n   * Applicable to directory or file.\n   */\n  public noScrubData: boolean = false;\n\n  /**\n   * Converts the given attributes to a string.\n   *\n   * @returns A string which represents the FileSystemAttributes\n   */\n  public toString(): string {\n    const attributes: string[] = [];\n    if (this.readonly) {\n      attributes.push(\"ReadOnly\");\n    }\n    if (this.hidden) {\n      attributes.push(\"Hidden\");\n    }\n    if (this.system) {\n      attributes.push(\"System\");\n    }\n    if (this.none) {\n      attributes.push(\"None\");\n    }\n    if (this.temporary) {\n      attributes.push(\"Temporary\");\n    }\n    if (this.directory) {\n      attributes.push(\"Directory\");\n    }\n    if (this.archive) {\n      attributes.push(\"Archive\");\n    }\n    if (this.offline) {\n      attributes.push(\"Offline\");\n    }\n    if (this.notContentIndexed) {\n      attributes.push(\"NotContentIndexed\");\n    }\n    if (this.noScrubData) {\n      attributes.push(\"NoScrubData\");\n    }\n    return attributes.join(\"|\");\n  }\n}\n"]}