@azure/data-tables 13.3.1-alpha.20241126.1 → 13.3.1-alpha.20241128.1

package/dist/commonjs/sas/generateAccountSas.js

@@ -0,0 +1,33 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateAccountSas = generateAccountSas;
+const tslib_1 = require("tslib");
+const accountSasPermissions_js_1 = require("./accountSasPermissions.js");
+const accountSasServices_js_1 = require("./accountSasServices.js");
+const core_auth_1 = require("@azure/core-auth");
+const accountSasSignatureValues_js_1 = require("./accountSasSignatureValues.js");
+/**
+ * Generates a Table Account Shared Access Signature (SAS) URI based on the client properties
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+ *
+ * @param options - Optional parameters.
+ * @returns An account SAS token
+ */
+function generateAccountSas(credential, options = {}) {
+    const { expiresOn, permissions = (0, accountSasPermissions_js_1.accountSasPermissionsFromString)("rl"), resourceTypes = "sco", services = (0, accountSasServices_js_1.accountSasServicesFromString)("t") } = options, rest = tslib_1.__rest(options, ["expiresOn", "permissions", "resourceTypes", "services"]);
+    if (!(0, core_auth_1.isNamedKeyCredential)(credential)) {
+        throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+    }
+    let expiry = expiresOn;
+    if (expiry === undefined) {
+        const now = new Date();
+        expiry = new Date(now.getTime() + 3600 * 1000);
+    }
+    const sas = (0, accountSasSignatureValues_js_1.generateAccountSasQueryParameters)(Object.assign({ permissions, expiresOn: expiry, resourceTypes, services: (0, accountSasServices_js_1.accountSasServicesToString)(services) }, rest), credential).toString();
+    return sas;
+}
+//# sourceMappingURL=generateAccountSas.js.map

package/dist/commonjs/sas/generateAccountSas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateAccountSas.js","sourceRoot":"","sources":["../../../src/sas/generateAccountSas.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAqBlC,gDAoCC;;AAtDD,yEAA6E;AAE7E,mEAAmG;AAEnG,gDAAwD;AAGxD,iFAAmF;AAEnF;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAChC,UAA8B,EAC9B,UAA6B,EAAE;IAE/B,MAAM,EACJ,SAAS,EACT,WAAW,GAAG,IAAA,0DAA+B,EAAC,IAAI,CAAC,EACnD,aAAa,GAAG,KAAK,EACrB,QAAQ,GAAG,IAAA,oDAA4B,EAAC,GAAG,CAAC,KAE1C,OAAO,EADN,IAAI,kBACL,OAAO,EANL,yDAML,CAAU,CAAC;IACZ,IAAI,CAAC,IAAA,gCAAoB,EAAC,UAAU,CAAC,EAAE,CAAC;QACtC,MAAM,UAAU,CACd,+FAA+F,CAChG,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,GAAG,SAAS,CAAC;IAEvB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,gEAAiC,kBAEzC,WAAW,EACX,SAAS,EAAE,MAAM,EACjB,aAAa,EACb,QAAQ,EAAE,IAAA,kDAA0B,EAAC,QAAQ,CAAC,IAC3C,IAAI,GAET,UAAU,CACX,CAAC,QAAQ,EAAE,CAAC;IAEb,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AccountSasPermissions } from \"./accountSasPermissions.js\";\nimport { accountSasPermissionsFromString } from \"./accountSasPermissions.js\";\nimport type { AccountSasServices } from \"./accountSasServices.js\";\nimport { accountSasServicesFromString, accountSasServicesToString } from \"./accountSasServices.js\";\nimport type { NamedKeyCredential } from \"@azure/core-auth\";\nimport { isNamedKeyCredential } from \"@azure/core-auth\";\nimport type { SasIPRange } from \"./sasIPRange.js\";\nimport type { SasProtocol } from \"./sasQueryParameters.js\";\nimport { generateAccountSasQueryParameters } from \"./accountSasSignatureValues.js\";\n\n/**\n * Generates a Table Account Shared Access Signature (SAS) URI based on the client properties\n * and parameters passed in. The SAS is signed by the shared key credential of the client.\n *\n * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas\n *\n * @param options - Optional parameters.\n * @returns An account SAS token\n */\nexport function generateAccountSas(\n  credential: NamedKeyCredential,\n  options: AccountSasOptions = {},\n): string {\n  const {\n    expiresOn,\n    permissions = accountSasPermissionsFromString(\"rl\"),\n    resourceTypes = \"sco\",\n    services = accountSasServicesFromString(\"t\"),\n    ...rest\n  } = options;\n  if (!isNamedKeyCredential(credential)) {\n    throw RangeError(\n      \"Can only generate the account SAS when the client is initialized with a shared key credential\",\n    );\n  }\n\n  let expiry = expiresOn;\n\n  if (expiry === undefined) {\n    const now = new Date();\n    expiry = new Date(now.getTime() + 3600 * 1000);\n  }\n\n  const sas = generateAccountSasQueryParameters(\n    {\n      permissions,\n      expiresOn: expiry,\n      resourceTypes,\n      services: accountSasServicesToString(services),\n      ...rest,\n    },\n    credential,\n  ).toString();\n\n  return sas;\n}\n\n/**\n * Options to configure {@link generateAccountSas} operation.\n */\nexport interface AccountSasOptions {\n  /**\n   * The time at which the shared access signature becomes invalid. Default to an hour later if not provided.\n   */\n  expiresOn?: Date;\n  /**\n   * Specifies the list of permissions to be associated with the SAS.\n   */\n  permissions?: AccountSasPermissions;\n  /**\n   * Specifies the resource types associated with the shared access signature.\n   */\n  resourceTypes?: string;\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   * SAS protocols allowed.\n   */\n  protocol?: SasProtocol;\n\n  /**\n   * When the SAS will take effect.\n   */\n  startsOn?: Date;\n  /**\n   * IP range allowed.\n   */\n  ipRange?: SasIPRange;\n  /**\n   * Account services\n   */\n  services?: AccountSasServices;\n}\n"]}

package/dist/commonjs/sas/generateTableSas.d.ts

@@ -0,0 +1,13 @@
+import type { NamedKeyCredential } from "@azure/core-auth";
+import type { TableSasSignatureValues } from "./tableSasSignatureValues.js";
+/**
+ * Generates a Table Service Shared Access Signature (SAS) URI based on the client properties
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+ *
+ * @param options - Optional parameters.
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+ */
+export declare function generateTableSas(tableName: string, credential: NamedKeyCredential, options?: TableSasSignatureValues): string;
+//# sourceMappingURL=generateTableSas.d.ts.map

package/dist/commonjs/sas/generateTableSas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateTableSas.d.ts","sourceRoot":"","sources":["../../../src/sas/generateTableSas.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAI5E;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,kBAAkB,EAC9B,OAAO,GAAE,uBAA4B,GACpC,MAAM,CA6BR"}

package/dist/commonjs/sas/generateTableSas.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTableSas = generateTableSas;
+const core_auth_1 = require("@azure/core-auth");
+const tableSasSignatureValues_js_1 = require("./tableSasSignatureValues.js");
+const tableSasPermisions_js_1 = require("./tableSasPermisions.js");
+/**
+ * Generates a Table Service Shared Access Signature (SAS) URI based on the client properties
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+ *
+ * @param options - Optional parameters.
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+ */
+function generateTableSas(tableName, credential, options = {}) {
+    let { expiresOn, permissions } = options;
+    if (!(0, core_auth_1.isNamedKeyCredential)(credential)) {
+        throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+    }
+    // expiresOn and permissions are optional if an identifier is provided
+    // set defaults when no identifier and no values were provided
+    if (!options.identifier) {
+        if (!permissions) {
+            permissions = (0, tableSasPermisions_js_1.tableSasPermissionsFromString)("r");
+        }
+        if (expiresOn === undefined) {
+            const now = new Date();
+            expiresOn = new Date(now.getTime() + 3600 * 1000);
+        }
+    }
+    const sas = (0, tableSasSignatureValues_js_1.generateTableSasQueryParameters)(tableName, credential, Object.assign(Object.assign({}, options), { expiresOn,
+        permissions })).toString();
+    return sas;
+}
+//# sourceMappingURL=generateTableSas.js.map

package/dist/commonjs/sas/generateTableSas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateTableSas.js","sourceRoot":"","sources":["../../../src/sas/generateTableSas.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAiBlC,4CAiCC;AA/CD,gDAAwD;AAExD,6EAA+E;AAC/E,mEAAwE;AAExE;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,UAA8B,EAC9B,UAAmC,EAAE;IAErC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEzC,IAAI,CAAC,IAAA,gCAAoB,EAAC,UAAU,CAAC,EAAE,CAAC;QACtC,MAAM,UAAU,CACd,+FAA+F,CAChG,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,8DAA8D;IAC9D,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,IAAA,qDAA6B,EAAC,GAAG,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,4DAA+B,EAAC,SAAS,EAAE,UAAU,kCAC5D,OAAO,KACV,SAAS;QACT,WAAW,IACX,CAAC,QAAQ,EAAE,CAAC;IAEd,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { NamedKeyCredential } from \"@azure/core-auth\";\nimport { isNamedKeyCredential } from \"@azure/core-auth\";\nimport type { TableSasSignatureValues } from \"./tableSasSignatureValues.js\";\nimport { generateTableSasQueryParameters } from \"./tableSasSignatureValues.js\";\nimport { tableSasPermissionsFromString } from \"./tableSasPermisions.js\";\n\n/**\n * Generates a Table Service Shared Access Signature (SAS) URI based on the client properties\n * and parameters passed in. The SAS is signed by the shared key credential of the client.\n *\n * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas\n *\n * @param options - Optional parameters.\n * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.\n */\nexport function generateTableSas(\n  tableName: string,\n  credential: NamedKeyCredential,\n  options: TableSasSignatureValues = {},\n): string {\n  let { expiresOn, permissions } = options;\n\n  if (!isNamedKeyCredential(credential)) {\n    throw RangeError(\n      \"Can only generate the account SAS when the client is initialized with a shared key credential\",\n    );\n  }\n\n  // expiresOn and permissions are optional if an identifier is provided\n  // set defaults when no identifier and no values were provided\n  if (!options.identifier) {\n    if (!permissions) {\n      permissions = tableSasPermissionsFromString(\"r\");\n    }\n\n    if (expiresOn === undefined) {\n      const now = new Date();\n      expiresOn = new Date(now.getTime() + 3600 * 1000);\n    }\n  }\n\n  const sas = generateTableSasQueryParameters(tableName, credential, {\n    ...options,\n    expiresOn,\n    permissions,\n  }).toString();\n\n  return sas;\n}\n"]}

package/dist/commonjs/sas/index.d.ts

@@ -0,0 +1,9 @@
+export { generateAccountSas, AccountSasOptions } from "./generateAccountSas.js";
+export { generateTableSas } from "./generateTableSas.js";
+export { TableSasSignatureValues } from "./tableSasSignatureValues.js";
+export { SasIPRange } from "./sasIPRange.js";
+export { TableSasPermissions } from "./tableSasPermisions.js";
+export { AccountSasPermissions } from "./accountSasPermissions.js";
+export { SasProtocol } from "./sasQueryParameters.js";
+export { AccountSasServices } from "./accountSasServices.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/sas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sas/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/commonjs/sas/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTableSas = exports.generateAccountSas = void 0;
+var generateAccountSas_js_1 = require("./generateAccountSas.js");
+Object.defineProperty(exports, "generateAccountSas", { enumerable: true, get: function () { return generateAccountSas_js_1.generateAccountSas; } });
+var generateTableSas_js_1 = require("./generateTableSas.js");
+Object.defineProperty(exports, "generateTableSas", { enumerable: true, get: function () { return generateTableSas_js_1.generateTableSas; } });
+//# sourceMappingURL=index.js.map

package/dist/commonjs/sas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sas/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,iEAAgF;AAAvE,2HAAA,kBAAkB,OAAA;AAC3B,6DAAyD;AAAhD,uHAAA,gBAAgB,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport { generateAccountSas, AccountSasOptions } from \"./generateAccountSas.js\";\nexport { generateTableSas } from \"./generateTableSas.js\";\nexport { TableSasSignatureValues } from \"./tableSasSignatureValues.js\";\nexport { SasIPRange } from \"./sasIPRange.js\";\nexport { TableSasPermissions } from \"./tableSasPermisions.js\";\nexport { AccountSasPermissions } from \"./accountSasPermissions.js\";\nexport { SasProtocol } from \"./sasQueryParameters.js\";\nexport { AccountSasServices } from \"./accountSasServices.js\";\n"]}

package/dist/commonjs/sas/models.d.ts

@@ -0,0 +1,34 @@
+/**
+ * A user delegation key.
+ */
+export interface UserDelegationKey {
+    /**
+     * The Azure Active Directory object ID in GUID format.
+     */
+    signedObjectId: string;
+    /**
+     * The Azure Active Directory tenant ID in GUID format.
+     */
+    signedTenantId: string;
+    /**
+     * The date-time the key is active.
+     */
+    signedStartsOn: Date;
+    /**
+     * The date-time the key expires.
+     */
+    signedExpiresOn: Date;
+    /**
+     * Abbreviation of the Azure Storage service that accepts the key.
+     */
+    signedService: string;
+    /**
+     * The service version that created the key.
+     */
+    signedVersion: string;
+    /**
+     * The key as a base64 string.
+     */
+    value: string;
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/commonjs/sas/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/sas/models.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,IAAI,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,IAAI,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/commonjs/sas/models.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=models.js.map

package/dist/commonjs/sas/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/sas/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * A user delegation key.\n */\nexport interface UserDelegationKey {\n  /**\n   * The Azure Active Directory object ID in GUID format.\n   */\n  signedObjectId: string;\n  /**\n   * The Azure Active Directory tenant ID in GUID format.\n   */\n  signedTenantId: string;\n  /**\n   * The date-time the key is active.\n   */\n  signedStartsOn: Date;\n  /**\n   * The date-time the key expires.\n   */\n  signedExpiresOn: Date;\n  /**\n   * Abbreviation of the Azure Storage service that accepts the key.\n   */\n  signedService: string;\n  /**\n   * The service version that created the key.\n   */\n  signedVersion: string;\n  /**\n   * The key as a base64 string.\n   */\n  value: string;\n}\n"]}

package/dist/commonjs/sas/sasIPRange.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Allowed IP range for a SAS.
+ */
+export interface SasIPRange {
+    /**
+     * Starting IP address in the IP range.
+     * If end IP doesn't provide, start IP will the only IP allowed.
+     */
+    start: string;
+    /**
+     * Optional. IP address that ends the IP range.
+     * If not provided, start IP will the only IP allowed.
+     */
+    end?: string;
+}
+/**
+ * Generate SasIPRange format string. For example:
+ *
+ * "8.8.8.8" or "1.1.1.1-255.255.255.255"
+ *
+ * @param ipRange -
+ */
+export declare function ipRangeToString(ipRange?: SasIPRange): string;
+//# sourceMappingURL=sasIPRange.d.ts.map

package/dist/commonjs/sas/sasIPRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sasIPRange.d.ts","sourceRoot":"","sources":["../../../src/sas/sasIPRange.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAM5D"}

package/dist/commonjs/sas/sasIPRange.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ipRangeToString = ipRangeToString;
+/**
+ * Generate SasIPRange format string. For example:
+ *
+ * "8.8.8.8" or "1.1.1.1-255.255.255.255"
+ *
+ * @param ipRange -
+ */
+function ipRangeToString(ipRange) {
+    if (!ipRange) {
+        return "";
+    }
+    return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start;
+}
+//# sourceMappingURL=sasIPRange.js.map

package/dist/commonjs/sas/sasIPRange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sasIPRange.js","sourceRoot":"","sources":["../../../src/sas/sasIPRange.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAyBlC,0CAMC;AAbD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,OAAoB;IAClD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;AACzE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Allowed IP range for a SAS.\n */\nexport interface SasIPRange {\n  /**\n   * Starting IP address in the IP range.\n   * If end IP doesn't provide, start IP will the only IP allowed.\n   */\n  start: string;\n  /**\n   * Optional. IP address that ends the IP range.\n   * If not provided, start IP will the only IP allowed.\n   */\n  end?: string;\n}\n\n/**\n * Generate SasIPRange format string. For example:\n *\n * \"8.8.8.8\" or \"1.1.1.1-255.255.255.255\"\n *\n * @param ipRange -\n */\nexport function ipRangeToString(ipRange?: SasIPRange): string {\n  if (!ipRange) {\n    return \"\";\n  }\n\n  return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start;\n}\n"]}

package/dist/commonjs/sas/sasQueryParameters.d.ts

@@ -0,0 +1,246 @@
+import type { SasIPRange } from "./sasIPRange.js";
+import type { UserDelegationKey } from "./models.js";
+/**
+ * Protocols for generated SAS.
+ */
+export type SasProtocol = "https" | "https,http";
+/**
+ * Represents the components that make up an Azure SAS' query parameters. This type is not constructed directly
+ * by the user; it is only generated by the {@link AccountSasSignatureValues} and {@link TableSasSignatureValues}
+ * types. Once generated, it can be encoded into a `string` and appended to a URL directly (though caution should
+ * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
+ * these query parameters).
+ *
+ * NOTE: Instances of this class are immutable.
+ */
+export declare class SasQueryParameters {
+    /**
+     * The Tables API version.
+     */
+    readonly version: string;
+    /**
+     * Optional. Table name to generate the SAS for
+     */
+    readonly tableName?: string;
+    /**
+     * Optional. The allowed HTTP protocol(s).
+     */
+    readonly protocol?: SasProtocol;
+    /**
+     * Optional. The start time for this SAS token.
+     */
+    readonly startsOn?: Date;
+    /**
+     * Optional only when identifier is provided. The expiry time for this SAS token.
+     */
+    readonly expiresOn?: Date;
+    /**
+     * Optional only when identifier is provided.
+     * Please refer to {@link AccountSasPermissions}, or {@link TableSasPermissions} for
+     * more details.
+     */
+    readonly permissions?: string;
+    /**
+     * Optional. The table services being accessed (only for Account SAS). Please refer to {@link AccountSasServices}
+     * for more details.
+     */
+    readonly services?: string;
+    /**
+     * Optional. The table resource types being accessed (only for Account SAS). Please refer to
+     * {@link AccountSasResourceTypes} for more details.
+     */
+    readonly resourceTypes?: string;
+    /**
+     * Optional. The signed identifier (only for {@link TableSasSignatureValues}).
+     *
+     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     */
+    readonly identifier?: string;
+    /**
+     * The signature for the SAS token.
+     */
+    readonly signature: string;
+    /**
+     * Inner value of getter ipRange.
+     */
+    private readonly ipRangeInner?;
+    /**
+     * The Azure Active Directory object ID in GUID format.
+     * Property of user delegation key.
+     */
+    private readonly signedOid?;
+    /**
+     * The Azure Active Directory tenant ID in GUID format.
+     * Property of user delegation key.
+     */
+    private readonly signedTenantId?;
+    /**
+     * The date-time the key is active.
+     * Property of user delegation key.
+     */
+    private readonly signedStartsOn?;
+    /**
+     * The date-time the key expires.
+     * Property of user delegation key.
+     */
+    private readonly signedExpiresOn?;
+    /**
+     * Abbreviation of the Azure Table service that accepts the user delegation key.
+     * Property of user delegation key.
+     */
+    private readonly signedService?;
+    /**
+     * The service version that created the user delegation key.
+     * Property of user delegation key.
+     */
+    private readonly signedVersion?;
+    /**
+     * Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key
+     * to perform the action granted by the SAS. The Azure Table service will ensure that the owner of the user delegation key
+     * has the required permissions before granting access but no additional permission check for the user specified in
+     * this value will be performed. This is only used for User Delegation SAS.
+     */
+    readonly preauthorizedAgentObjectId?: string;
+    /**
+     * A GUID value that will be logged in the table diagnostic logs and can be used to correlate SAS generation with table resource access.
+     * This is only used for User Delegation SAS.
+     */
+    readonly correlationId?: string;
+    /**
+     * Optional, but startPartitionKey must accompany startRowKey. The minimum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no lower bound on the table entities that can be accessed.
+     */
+    readonly startPartitionKey?: string;
+    /**
+     * Optional, but startPartitionKey must accompany startRowKey. The minimum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no lower bound on the table entities that can be accessed.
+     */
+    readonly startRowKey?: string;
+    /**
+     * Optional, but endPartitionKey must accompany endRowKey. The maximum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no upper bound on the table entities that can be accessed.
+     */
+    readonly endPartitionKey?: string;
+    /**
+     * Optional, but endPartitionKey must accompany endRowKey. The maximum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no upper bound on the table entities that can be accessed.
+     */
+    readonly endRowKey?: string;
+    /**
+     * Optional. IP range allowed for this SAS.
+     *
+     * @readonly
+     */
+    get ipRange(): SasIPRange | undefined;
+    /**
+     * Creates an instance of SASQueryParameters.
+     *
+     * @param version - Representing the table service version
+     * @param signature - Representing the signature for the SAS token
+     * @param options - Optional. Options to construct the SASQueryParameters.
+     */
+    constructor(version: string, signature: string, options?: SasQueryParametersOptions);
+    /**
+     * Encodes all SAS query parameters into a string that can be appended to a URL.
+     *
+     */
+    toString(): string;
+    /**
+     * A private helper method used to filter and append query key/value pairs into an array.
+     *
+     * @param queries -
+     * @param key -
+     * @param value -
+     */
+    private tryAppendQueryParameter;
+}
+/**
+ * Options to construct {@link SasQueryParameters}.
+ */
+export interface SasQueryParametersOptions {
+    /**
+     * Optional only when identifier is provided.
+     * Please refer to {@link AccountSasPermissions}, or {@link TableSasPermissions} for
+     * more details.
+     */
+    permissions?: string;
+    /**
+     * Optional. Table name to generate the SAS for
+     */
+    tableName?: string;
+    /**
+     * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSasServices}
+     * for more details.
+     */
+    services?: string;
+    /**
+     * Optional. The storage resource types being accessed (only for Account SAS). Please refer to
+     * {@link AccountSasResourceTypes} for more details.
+     */
+    resourceTypes?: string;
+    /**
+     * Optional. The allowed HTTP protocol(s).
+     */
+    protocol?: SasProtocol;
+    /**
+     * Optional. The start time for this SAS token.
+     */
+    startsOn?: Date;
+    /**
+     * Optional only when identifier is provided. The expiry time for this SAS token.
+     */
+    expiresOn?: Date;
+    /**
+     * Optional. IP ranges allowed in this SAS.
+     */
+    ipRange?: SasIPRange;
+    /**
+     * Optional. The signed identifier for access policy
+     *
+     * @see https://docs.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
+     */
+    identifier?: string;
+    /**
+     * Optional. Specifies which resources are accessible via the SAS (only for {@link AccountSasSignatureValues}).
+     * @see https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
+     */
+    resource?: string;
+    /**
+     * User delegation key properties.
+     */
+    userDelegationKey?: UserDelegationKey;
+    /**
+     * Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key
+     * to perform the action granted by the SAS. The Azure Table service will ensure that the owner of the user delegation key
+     * has the required permissions before granting access but no additional permission check for the user specified in
+     * this value will be performed. This cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}.
+     * This is only used for User Delegation SAS.
+     */
+    preauthorizedAgentObjectId?: string;
+    /**
+     * A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access.
+     * This is only used for User Delegation SAS.
+     */
+    correlationId?: string;
+    /**
+     * Optional, but startPartitionKey must accompany startRowKey. The minimum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no lower bound on the table entities that can be accessed.
+     */
+    startPartitionKey?: string;
+    /**
+     * Optional, but startPartitionKey must accompany startRowKey. The minimum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no lower bound on the table entities that can be accessed.
+     */
+    startRowKey?: string;
+    /**
+     * Optional, but endPartitionKey must accompany endRowKey. The maximum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no upper bound on the table entities that can be accessed.
+     */
+    endPartitionKey?: string;
+    /**
+     * Optional, but endPartitionKey must accompany endRowKey. The maximum partition and row keys that are accessible with this shared access signature.
+     * Key values are inclusive. If they're omitted, there's no upper bound on the table entities that can be accessed.
+     */
+    endRowKey?: string;
+}
+//# sourceMappingURL=sasQueryParameters.d.ts.map

package/dist/commonjs/sas/sasQueryParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sasQueryParameters.d.ts","sourceRoot":"","sources":["../../../src/sas/sasQueryParameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGrD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,YAAY,CAAC;AAEjD;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAgB,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvC;;OAEG;IACH,SAAgB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjC;;;;OAIG;IACH,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAa;IAE3C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IAEpC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IAEzC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAO;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAO;IAExC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IAExC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IAExC;;;;;OAKG;IACH,SAAgB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpD;;;OAGG;IACH,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,SAAgB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3C;;;OAGG;IACH,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,SAAgB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzC;;;OAGG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,IAAW,OAAO,IAAI,UAAU,GAAG,SAAS,CAQ3C;IAED;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,yBAA8B;IA+BvF;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAkIzB;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;CAWhC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}