@azure/container-registry 1.0.0-beta.3 → 1.0.0

package/types/container-registry.d.ts

@@ -1,10 +1,20 @@
 /// <reference types="node" />
 /// <reference lib="esnext.asynciterable" />
+
 import { OperationOptions } from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { PipelineOptions } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
+/**
+ * Defines values for ArtifactManifestOrder.
+ *  this contains the known values that the service supports.
+ * ### Know values supported by the service
+ * **LastUpdatedOnDescending**: Order registry artifacts by LastUpdatedOn field, from most recently updated to least recently updated.
+ * **LastUpdatedOnAscending**: Order  registry artifacts by LastUpdatedOn field, from least recently updated to most recently updated.
+ */
+export declare type ArtifactManifestOrder = "LastUpdatedOnDescending" | "LastUpdatedOnAscending";
+
 /** Manifest attributes details */
 export declare interface ArtifactManifestPlatform {
     /**
@@ -45,7 +55,7 @@ export declare interface ArtifactManifestProperties {
      * Image size
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
-    readonly size?: number;
+    readonly sizeInBytes?: number;
     /**
      * Created time
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -86,10 +96,19 @@ export declare interface ArtifactManifestProperties {
     canRead?: boolean;
 }
 
+/**
+ * Defines values for ArtifactTagOrder.
+ *  this contains the known values that the service supports.
+ * ### Know values supported by the service
+ * **LastUpdatedOnDescending**: Order tags by LastUpdatedOn field, from most recently updated to least recently updated.
+ * **LastUpdatedOnAscending**: Order tags by LastUpdatedOn field, from least recently updated to most recently updated.
+ */
+export declare type ArtifactTagOrder = "LastUpdatedOnDescending" | "LastUpdatedOnAscending";
+
 /** Tag attributes */
 export declare interface ArtifactTagProperties {
     /**
-     * Registry login server name.  This is likely to be similar to {registry-name}.azurecr.io
+     * Registry login server name. This is likely to be similar to {registry-name}.azurecr.io.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly registryLoginServer: string;
@@ -150,7 +169,7 @@ export declare class ContainerRegistryClient {
      *    new DefaultAzureCredential()
      * );
      * ```
-     * @param endpoint - the URL to the Container Registry endpoint
+     * @param endpoint - the URL endpoint of the container registry
      * @param credential - used to authenticate requests to the service
      * @param options - optional configuration used to send requests to the service
      */
@@ -158,6 +177,8 @@ export declare class ContainerRegistryClient {
     /**
      * Creates an instance of a ContainerRegistryClient to interact with
      * an Azure Container Registry that has anonymous pull access enabled.
+     * Only operations that support anonymous access are enabled. Other service
+     * methods will throw errors.
      *
      * Example usage:
      * ```ts
@@ -167,41 +188,68 @@ export declare class ContainerRegistryClient {
      *    "<container registry API endpoint>",
      * );
      * ```
-     * @param endpoint - the URL to the Container Registry endpoint
+     * @param endpoint - the URL endpoint of the container registry
      * @param options - optional configuration used to send requests to the service
      */
     constructor(endpoint: string, options?: ContainerRegistryClientOptions);
     /**
-     * Deletes the repository identified by the given name.
+     * Deletes the repository identified by the given name and all associated artifacts.
      *
      * @param repositoryName - the name of repository to delete
      * @param options - optional configuration for the operation
      */
     deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>;
     /**
-     * Returns an artifact for given repository name, and a tag or digest.
+     * Returns an instance of {@link RegistryArtifact} for calling service methods related to the artifact specified by `repositoryName` and `tagOrDigest`.
      *
      * @param repositoryName - the name of repository
      * @param tagOrDigest - tag or digest of the artifact to retrieve
      */
     getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact;
     /**
-     * Returns a ContainerRepositoryClient instance for the given repository.
+     * Returns an instance of {@link ContainerRepository} for calling service methods related to the repository specified by `repositoryName`.
      *
-     * @param repositoryName - the name of repository to delete
-     * @param options - optional configuration for the operation
+     * @param repositoryName - the name of repository
      */
     getRepository(repositoryName: string): ContainerRepository;
     /**
-     * Iterates repositories.
+     * Returns an async iterable iterator to list names of repositories in this registry.
      *
      * Example usage:
-     * ```ts
-     * let client = new ContainerRegistryClient(url, credentials);
+     * ```javascript
+     * let client = new ContainerRegistryClient(url, credential);
      * for await (const repository of client.listRepositoryNames()) {
      *   console.log("repository name: ", repository);
      * }
      * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```javascript
+     * let iter = client.listRepositoryNames();
+     * let item = await iter.next();
+     * while (!item.done) {
+     *   console.log(`repository name: ${item.value}`);
+     *   item = await iter.next();
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```javascript
+     * const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
+     * let page = await pages.next();
+     * let i = 1;
+     * while (!page.done) {
+     *  if (page.value) {
+     *    console.log(`-- page ${i++}`);
+     *    for (const name of page.value) {
+     *      console.log(`  repository name: ${name}`);
+     *    }
+     *  }
+     *  page = await pages.next();
+     * }
+     * ```
      * @param options -
      */
     listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse>;
@@ -214,19 +262,23 @@ export declare class ContainerRegistryClient {
  */
 export declare interface ContainerRegistryClientOptions extends PipelineOptions {
     /**
-     * Gets or sets the authentication scope to use for authentication with AAD.
-     * This defaults to the Azure Resource Manager "Azure Global" scope.  To
-     * connect to a different cloud, set this value to "&lt;resource-id&gt;/.default",
-     * where &lt;resource-id&gt; is one of the Resource IDs listed at
-     * https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-resource-manager.
-     * For example, to connect to the Azure Germany cloud, create a client with
-     * this set to "https://management.microsoftazure.de/.default".
+     * Gets or sets the audience to use for authentication with Azure Active Directory.
+     * The authentication scope will be set from this audience.
+     * See {@link KnownContainerRegistryAudience} for known audience values.
      */
-    authenticationScope?: string;
+    audience?: string;
+    /**
+     * The version of service API to make calls against.
+     */
+    serviceVersion?: "2021-07-01";
 }
 
 /**
- * The helper used to interact with the Container Registry service.
+ * A `repository` in a container registry is a logical grouping of images or artifacts that share the same name.  For example,
+ * different versions of a `hello-world` application could have tags `v1` and `v2`, and be grouped by the repository `hello-world`.
+ *
+ * The {@link ContainerRepository} interface is a helper that groups information and operations about a repository in this
+ * container registry.
  */
 export declare interface ContainerRepository {
     /**
@@ -238,37 +290,81 @@ export declare interface ContainerRepository {
      */
     readonly name: string;
     /**
-     * Deletes this repository.
+     * Deletes this repository and all artifacts that are part of its logical group.
      *
      * @param options - optional configuration for the operation
      */
     delete(options?: DeleteRepositoryOptions): Promise<void>;
     /**
-     * Returns an instance of RegistryArtifact.
+     * Returns an helper instance of {@link RegistryArtifact} for the given tag or digest.
      * @param tagOrDigest - the tag or digest of the artifact
      */
     getArtifact(tagOrDigest: string): RegistryArtifact;
     /**
-     * Retrieves properties of this repository.
+     * Retrieves the properties of this repository.
      * @param options -
      */
     getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>;
     /**
-     * Updates repository attributes.
+     * Updates the properties of this repository.
+     *
+     * Example usage:
+     *
+     * ```javascript
+     * const client = new ContainerRegistryClient(url, credential);
+     * const repository = client.getRepository(repositoryName)
+     * const updated = await repository.updateProperties({
+     *   canDelete: false,
+     *   canList: false,
+     *   canRead: false,
+     *   canWrite: false
+     * });
+     * ```
      * @param options -
      */
     updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>;
     /**
-     * Iterates manifests.
+     * Returns an async iterable iterator to list manifest properties.
+     * This is useful for determining the collection of artifacts associated with
+     * this repository, as each artifact is uniquely identified by its manifest.
      *
-     * Example usage:
-     * ```ts
-     * const client = new ContainerRegistryClient(url, credentials);
+     * Example using `for-await-of` syntax:
+     *
+     * ```javascript
+     * const client = new ContainerRegistryClient(url, credential);
      * const repository = client.getRepository(repositoryName)
      * for await (const manifest of repository.listManifestProperties()) {
      *   console.log("manifest: ", manifest);
      * }
      * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```javascript
+     * const iter = repository.listManifestProperties();
+     * let item = await iter.next();
+     * while (!item.done) {
+     *   console.log("manifest properties: ", item.value);
+     *   item = await iter.next();
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```javascript
+     * const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
+     * let page = await pages.next();
+     * let i = 1;
+     * while (!page.done) {
+     *  if (page.value) {
+     *    console.log(`-- page ${i++}`);
+     *    for (const manifestProperties of page.value) {
+     *      console.log(`  manifest properties: ${manifestProperties}`);
+     *    }
+     *  }
+     *  page = await pages.next();
+     * }
+     * ```
      * @param options -
      */
     listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties>;
@@ -277,7 +373,7 @@ export declare interface ContainerRepository {
 /** Properties of this repository. */
 export declare interface ContainerRepositoryProperties {
     /**
-     * Registry login server name.  This is likely to be similar to {registry-name}.azurecr.io
+     * Registry login server name. This is likely to be similar to {registry-name}.azurecr.io.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly registryLoginServer: string;
@@ -314,8 +410,6 @@ export declare interface ContainerRepositoryProperties {
     canList?: boolean;
     /** Read enabled */
     canRead?: boolean;
-    /** Enables Teleport functionality on new images in the repository improving Container startup performance */
-    teleportEnabled?: boolean;
 }
 
 /**
@@ -355,50 +449,91 @@ export declare interface GetTagPropertiesOptions extends OperationOptions {
 }
 
 /**
- * Defines known {@link ArtifactArchitecture} that the service supports.
+ * Defines known artifact architectures that the service supports.
  */
 export declare enum KnownArtifactArchitecture {
+    /** i386 */
     I386 = "386",
+    /** AMD64 */
     Amd64 = "amd64",
+    /** ARM */
     Arm = "arm",
+    /** ARM64 */
     Arm64 = "arm64",
+    /** MIPS */
     Mips = "mips",
+    /** MIPSLE */
     MipsLe = "mipsle",
+    /** MIPS64 */
     Mips64 = "mips64",
+    /** MIPS64LE */
     Mips64Le = "mips64le",
+    /** PPC64 */
     Ppc64 = "ppc64",
+    /** PPC64LE */
     Ppc64Le = "ppc64le",
+    /** RISCv64 */
     RiscV64 = "riscv64",
+    /** s390x */
     S390X = "s390x",
+    /** Wasm */
     Wasm = "wasm"
 }
 
 /**
- * Defines known {@link ArtifactOperatingSystem} values that the service supports.
+ * Defines known artifact platform's operating systems that the service supports.
  */
 export declare enum KnownArtifactOperatingSystem {
+    /** Aix */
     Aix = "aix",
+    /** Android */
     Android = "android",
+    /** Darwin */
     Darwin = "darwin",
+    /** Dragonfly */
     Dragonfly = "dragonfly",
+    /** FreeBSD */
     FreeBsd = "freebsd",
+    /** Illumos */
     Illumos = "illumos",
+    /** iOS */
     iOS = "ios",
+    /** JS */
     JS = "js",
+    /** Linux */
     Linux = "linux",
+    /** NetBSD */
     NetBsd = "netbsd",
+    /** OpenBSD */
     OpenBsd = "openbsd",
+    /** Plan9 */
     Plan9 = "plan9",
+    /** Solaris */
     Solaris = "solaris",
+    /** Windows */
     Windows = "windows"
 }
 
+/**
+ * Defines known cloud audiences for Azure Container Registry.
+ */
+export declare enum KnownContainerRegistryAudience {
+    /** Azure China */
+    AzureResourceManagerChina = "https://management.chinacloudapi.cn",
+    /** Azure Gemany */
+    AzureResourceManagerGermany = "https://management.microsoftazure.de",
+    /** Azure Government */
+    AzureResourceManagerGovernment = "https://management.usgovcloudapi.net",
+    /** Azure Public Cloud */
+    AzureResourceManagerPublicCloud = "https://management.azure.com"
+}
+
 /**
  * Options for the `listRegistryArtifacts` method of `ContainerRepository`.
  */
 export declare interface ListManifestPropertiesOptions extends OperationOptions {
-    /** orderby query parameter */
-    orderBy?: ManifestOrderBy;
+    /** order in which the manifest properties are returned */
+    order?: ArtifactManifestOrder;
 }
 
 /**
@@ -411,19 +546,10 @@ export declare interface ListRepositoriesOptions extends OperationOptions {
  * Options for the `listTagProperties` method of `RegistryArtifact`.
  */
 export declare interface ListTagPropertiesOptions extends OperationOptions {
-    /** orderby query parameter */
-    orderBy?: TagOrderBy;
+    /** order in which the tags are returned */
+    order?: ArtifactTagOrder;
 }
 
-/**
- * Defines values for RegistryArtifactOrderBy.
- *  this contains the known values that the service supports.
- * ### Know values supported by the service
- * **LastUpdatedOnDescending**: Order registry artifacts by LastUpdatedOn field, from most recently updated to least recently updated.
- * **LastUpdatedOnAscending**: Order  registry artifacts by LastUpdatedOn field, from least recently updated to most recently updated.
- */
-export declare type ManifestOrderBy = "LastUpdatedOnDescending" | "LastUpdatedOnAscending";
-
 /**
  * Contains response data for the listManifests operation.
  */
@@ -435,7 +561,12 @@ export declare interface ManifestPageResponse extends Array<ArtifactManifestProp
 }
 
 /**
- * The helper used to interact with the Container Registry artifact.
+ * `Artifact` is the general term for items stored in a container registry,
+ * and can include Docker images or other Open Container Initiative (OCI) artifact types.
+ *
+ * The {@link RegistryArtifact} interface is a helper that groups information and operations about an image
+ * or artifact in a container registry.
+ *
  */
 export declare interface RegistryArtifact {
     /**
@@ -451,43 +582,70 @@ export declare interface RegistryArtifact {
      */
     readonly fullyQualifiedReference: string;
     /**
-     * Deletes this artifact.
+     * Deletes this registry artifact by deleting its manifest.
      * @param options -
      */
     delete(options?: DeleteArtifactOptions): Promise<void>;
     /**
-     * Deletes a tag.
-     * @param tag - the name of the tag to be deleted.
+     * Deletes a tag. This removes the tag from the artifact and its manifest.
+     * @param tag - the name of the tag to delete.
      * @param options -
      */
     deleteTag(tag: string, options?: DeleteTagOptions): Promise<void>;
     /**
-     * Retrieves properties of this registry artifact.
+     * Retrieves the properties of the manifest that uniquely identifies this artifact.
      * @param options -
      */
     getManifestProperties(options?: GetManifestPropertiesOptions): Promise<ArtifactManifestProperties>;
     /**
-     * Updates manifest artifact attributes.
+     * Updates the properties of the artifact's manifest.
+     *
+     * Example usage:
+     *
+     * ```javascript
+     * const client = new ContainerRegistryClient(url, credential);
+     * const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
+     * const updated = await artifact.updateManifestProperties({
+     *   canDelete: false,
+     *   canList: false,
+     *   canRead: false,
+     *   canWrite: false
+     * });
+     * ```
      * @param options -
      */
-    updateManifestProperties(options?: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>;
+    updateManifestProperties(options: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>;
     /**
-     * Retrieves properties of a tag.
+     * Retrieves the properties of the specified tag.
      * @param tag - the tag to retrieve properties.
      * @param options -
      */
     getTagProperties(tag: string, options?: GetTagPropertiesOptions): Promise<ArtifactTagProperties>;
     /**
-     * Updates tag properties.
-     * @param tag - name of the tag
+     * Updates the properties of a given tag.
+     *
+     * Example usage:
+     *
+     * ```javascript
+     * const client = new ContainerRegistryClient(url, credential);
+     * const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
+     * const updated = await artifact.updateTagProperties(tag, {
+     *   canDelete: false,
+     *   canList: false,
+     *   canRead: false,
+     *   canWrite: false
+     * });
+     * ```
+     * @param tag - name of the tag to update properties on
      * @param options -
      */
     updateTagProperties(tag: string, options: UpdateTagPropertiesOptions): Promise<ArtifactTagProperties>;
     /**
-     * Iterates tags.
+     * Returns an async iterable iterator to list the tags that uniquely identify this artifact and the properties of each.
      *
-     * Example usage:
-     * ```ts
+     * Example using `for-await-of` syntax:
+     *
+     * ```javascript
      * const client = new ContainerRegistryClient(url, credentials);
      * const repository = client.getRepository(repositoryName);
      * const artifact = repository.getArtifact(digest)
@@ -495,6 +653,34 @@ export declare interface RegistryArtifact {
      *   console.log("tag: ", tag);
      * }
      * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```javascript
+     * const iter = artifact.listTagProperties();
+     * let item = await iter.next();
+     * while (!item.done) {
+     *   console.log("tag properties: ", item.value);
+     *   item = await iter.next();
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```javascript
+     * const pages = artifact.listTagProperties().byPage({ maxPageSize: 2 });
+     * let page = await pages.next();
+     * let i = 1;
+     * while (!page.done) {
+     *  if (page.value) {
+     *    console.log(`-- page ${i++}`);
+     *    for (const tagProperties of page.value) {
+     *      console.log(`  repository name: ${tagProperties}`);
+     *    }
+     *  }
+     *  page = await pages.next();
+     * }
+     * ```
      * @param options -
      */
     listTagProperties(options?: ListTagPropertiesOptions): PagedAsyncIterableIterator<ArtifactTagProperties>;
@@ -510,15 +696,6 @@ export declare interface RepositoryPageResponse extends Array<string> {
     continuationToken?: string;
 }
 
-/**
- * Defines values for TagOrderBy.
- *  this contains the known values that the service supports.
- * ### Know values supported by the service
- * **LastUpdatedOnDescending**: Order tags by LastUpdatedOn field, from most recently updated to least recently updated.
- * **LastUpdatedOnAscending**: Order tags by LastUpdatedOn field, from least recently updated to most recently updated.
- */
-export declare type TagOrderBy = "LastUpdatedOnDescending" | "LastUpdatedOnAscending";
-
 /**
  * Contains response data for the listTags operation.
  */
@@ -533,13 +710,13 @@ export declare interface TagPageResponse extends Array<ArtifactTagProperties> {
  * Options for the `updateManifestProperties` method of `RegistryArtifact`.
  */
 export declare interface UpdateManifestPropertiesOptions extends OperationOptions {
-    /** Delete enabled */
+    /** Whether or not this manifest can be deleted */
     canDelete?: boolean;
-    /** Write enabled */
+    /** Whether or not this manifest can be written to */
     canWrite?: boolean;
-    /** List enabled */
+    /** Whether or not to include this manifest when listing manifest properties */
     canList?: boolean;
-    /** Read enabled */
+    /** Whether or not this manifest can be read */
     canRead?: boolean;
 }
 
@@ -547,29 +724,27 @@ export declare interface UpdateManifestPropertiesOptions extends OperationOption
  * Options for the `setProperties` method of `ContainerRepository`.
  */
 export declare interface UpdateRepositoryPropertiesOptions extends OperationOptions {
-    /** Delete enabled */
+    /** Whether or not this repository can be deleted */
     canDelete?: boolean;
-    /** Write enabled */
+    /** Whether or not this repository can be written to */
     canWrite?: boolean;
-    /** List enabled */
+    /** Whether or not include this repository when listing repositories */
     canList?: boolean;
-    /** Read enabled */
+    /** Whether or not this repository can be read */
     canRead?: boolean;
-    /** Enables Teleport functionality on new images in the repository improving Container startup performance */
-    teleportEnabled?: boolean;
 }
 
 /**
  * Options for the `updateTagProperties` method of `RegistryArtifact`.
  */
 export declare interface UpdateTagPropertiesOptions extends OperationOptions {
-    /** Delete enabled */
+    /** Whether or not this tag can be deleted */
     canDelete?: boolean;
-    /** Write enabled */
+    /** Whether or not this tag can be written to */
     canWrite?: boolean;
-    /** List enabled */
+    /** Whether or not to include this tag when listing tags */
     canList?: boolean;
-    /** Read enabled */
+    /** Whether or not this tag can be read */
     canRead?: boolean;
 }
 

package/dist-esm/src/base64.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base64.browser.js","sourceRoot":"","sources":["../../src/base64.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAOlC;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,aAAqB;IAChD,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC;AAC7B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n// eslint-disable-next-line @azure/azure-sdk/ts-no-namespaces\ndeclare global {\n  function atob(input: string): string;\n}\n\n/**\n * Base64 decode\n *\n * @internal\n * @param encodedString -\n * @returns\n\n */\nexport function base64decode(encodedString: string): string {\n  return atob(encodedString);\n}\n"]}

package/dist-esm/src/base64.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base64.js","sourceRoot":"","sources":["../../src/base64.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,aAAqB;IAChD,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;AACzD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Base64 decode\n *\n * @internal\n * @param encodedString -\n * @returns\n */\nexport function base64decode(encodedString: string): string {\n  return Buffer.from(encodedString, \"base64\").toString();\n}\n"]}

package/dist-esm/src/constants.js

@@ -1,4 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export const SDK_VERSION = "1.0.0-beta.3";
-//# sourceMappingURL=constants.js.map

package/dist-esm/src/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const SDK_VERSION: string = \"1.0.0-beta.3\";\n"]}

package/dist-esm/src/tokenCycler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenCycler.js","sourceRoot":"","sources":["../../src/tokenCycler.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAIlC,SAAS,KAAK,CAAI,CAAS,EAAE,KAAS;IACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACvE,CAAC;AAyCD,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAuB;IACxD,uBAAuB,EAAE,IAAI;IAC7B,iBAAiB,EAAE,IAAI;IACvB,iBAAiB,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,oCAAoC;CACtE,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAe,YAAY,CACzB,cAAiD,EACjD,iBAAyB,EACzB,cAAsB;;QAEtB,4EAA4E;QAC5E,eAAe;QACf,SAAe,iBAAiB;;gBAC9B,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,EAAE;oBAC/B,IAAI;wBACF,OAAO,MAAM,cAAc,EAAE,CAAC;qBAC/B;oBAAC,WAAM;wBACN,OAAO,IAAI,CAAC;qBACb;iBACF;qBAAM;oBACL,MAAM,UAAU,GAAG,MAAM,cAAc,EAAE,CAAC;oBAE1C,6CAA6C;oBAC7C,IAAI,UAAU,KAAK,IAAI,EAAE;wBACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;qBACpD;oBAED,OAAO,UAAU,CAAC;iBACnB;YACH,CAAC;SAAA;QAED,IAAI,KAAK,GAAuB,MAAM,iBAAiB,EAAE,CAAC;QAE1D,OAAO,KAAK,KAAK,IAAI,EAAE;YACrB,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAE/B,KAAK,GAAG,MAAM,iBAAiB,EAAE,CAAC;SACnC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,UAA2B,EAC3B,kBAAgD;IAEhD,IAAI,aAAa,GAAgC,IAAI,CAAC;IACtD,IAAI,KAAK,GAAuB,IAAI,CAAC;IAErC,MAAM,OAAO,mCACR,sBAAsB,GACtB,kBAAkB,CACtB,CAAC;IAEF;;;OAGG;IACH,MAAM,MAAM,GAAG;QACb;;WAEG;QACH,IAAI,YAAY;YACd,OAAO,aAAa,KAAK,IAAI,CAAC;QAChC,CAAC;QACD;;;WAGG;QACH,IAAI,aAAa;;YACf,OAAO,CACL,CAAC,MAAM,CAAC,YAAY;gBACpB,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,kBAAkB,mCAAI,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAC1E,CAAC;QACJ,CAAC;QACD;;;WAGG;QACH,IAAI,WAAW;YACb,OAAO,CACL,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,GAAG,EAAE,CAC1F,CAAC;QACJ,CAAC;KACF,CAAC;IAEF;;;OAGG;IACH,SAAS,OAAO,CAAC,MAAyB,EAAE,eAAkB;;QAC5D,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YACxB,yDAAyD;YACzD,MAAM,iBAAiB,GAAG,GAAgC,EAAE,CAC1D,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YAE/C,wEAAwE;YACxE,6CAA6C;YAC7C,aAAa,GAAG,YAAY,CAC1B,iBAAiB,EACjB,OAAO,CAAC,iBAAiB;YACzB,+DAA+D;YAC/D,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,kBAAkB,mCAAI,IAAI,CAAC,GAAG,EAAE,CACxC;iBACE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,aAAa,GAAG,IAAI,CAAC;gBACrB,KAAK,GAAG,MAAM,CAAC;gBACf,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;gBAChB,sEAAsE;gBACtE,qEAAqE;gBACrE,mBAAmB;gBACnB,aAAa,GAAG,IAAI,CAAC;gBACrB,KAAK,GAAG,IAAI,CAAC;gBACb,MAAM,MAAM,CAAC;YACf,CAAC,CAAC,CAAC;SACN;QAED,OAAO,aAAqC,CAAC;IAC/C,CAAC;IAED,OAAO;QACL,IAAI,WAAW;YACb,OAAO,KAAK,IAAI,SAAS,CAAC;QAC5B,CAAC;QACD,QAAQ,EAAE,CAAO,MAAyB,EAAE,YAAe,EAAwB,EAAE;YACnF,EAAE;YACF,gBAAgB;YAChB,+DAA+D;YAC/D,6CAA6C;YAC7C,+DAA+D;YAC/D,yCAAyC;YACzC,6DAA6D;YAC7D,YAAY;YACZ,EAAE;YACF,IAAI,MAAM,CAAC,WAAW;gBAAE,OAAO,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YAE7D,IAAI,MAAM,CAAC,aAAa,EAAE;gBACxB,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;aAC/B;YAED,OAAO,KAAoB,CAAC;QAC9B,CAAC,CAAA;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AccessToken, GetTokenOptions, TokenCredential } from \"@azure/core-auth\";\n\nfunction delay<T>(t: number, value?: T): Promise<T | void> {\n  return new Promise((resolve) => setTimeout(() => resolve(value), t));\n}\n/**\n * A function that gets a promise of an access token and allows providing\n * options.\n *\n * @param options - the options to pass to the underlying token provider\n */\nexport type AccessTokenGetter<T extends GetTokenOptions> = (\n  scopes: string | string[],\n  options: T\n) => Promise<AccessToken>;\n\n/**\n * The response of the\n */\nexport interface AccessTokenRefresher<T extends GetTokenOptions> {\n  cachedToken?: AccessToken;\n  getToken: AccessTokenGetter<T>;\n}\n\nexport interface TokenCyclerOptions {\n  /**\n   * The window of time before token expiration during which the token will be\n   * considered unusable due to risk of the token expiring before sending the\n   * request.\n   *\n   * This will only become meaningful if the refresh fails for over\n   * (refreshWindow - forcedRefreshWindow) milliseconds.\n   */\n  forcedRefreshWindowInMs: number;\n  /**\n   * Interval in milliseconds to retry failed token refreshes.\n   */\n  retryIntervalInMs: number;\n  /**\n   * The window of time before token expiration during which\n   * we will attempt to refresh the token.\n   */\n  refreshWindowInMs: number;\n}\n\n// Default options for the cycler if none are provided\nexport const DEFAULT_CYCLER_OPTIONS: TokenCyclerOptions = {\n  forcedRefreshWindowInMs: 1000, // Force waiting for a refresh 1s before the token expires\n  retryIntervalInMs: 3000, // Allow refresh attempts every 3s\n  refreshWindowInMs: 1000 * 60 * 2 // Start refreshing 2m before expiry\n};\n\n/**\n * Converts an an unreliable access token getter (which may resolve with null)\n * into an AccessTokenGetter by retrying the unreliable getter in a regular\n * interval.\n *\n * @param getAccessToken - A function that produces a promise of an access token that may fail by returning null.\n * @param retryIntervalInMs - The time (in milliseconds) to wait between retry attempts.\n * @param refreshTimeout - The timestamp after which the refresh attempt will fail, throwing an exception.\n * @returns - A promise that, if it resolves, will resolve with an access token.\n */\nasync function beginRefresh(\n  getAccessToken: () => Promise<AccessToken | null>,\n  retryIntervalInMs: number,\n  refreshTimeout: number\n): Promise<AccessToken> {\n  // This wrapper handles exceptions gracefully as long as we haven't exceeded\n  // the timeout.\n  async function tryGetAccessToken(): Promise<AccessToken | null> {\n    if (Date.now() < refreshTimeout) {\n      try {\n        return await getAccessToken();\n      } catch {\n        return null;\n      }\n    } else {\n      const finalToken = await getAccessToken();\n\n      // Timeout is up, so throw if it's still null\n      if (finalToken === null) {\n        throw new Error(\"Failed to refresh access token.\");\n      }\n\n      return finalToken;\n    }\n  }\n\n  let token: AccessToken | null = await tryGetAccessToken();\n\n  while (token === null) {\n    await delay(retryIntervalInMs);\n\n    token = await tryGetAccessToken();\n  }\n\n  return token;\n}\n\n/**\n * Creates a token cycler from a credential, scopes, and optional settings.\n *\n * A token cycler represents a way to reliably retrieve a valid access token\n * from a TokenCredential. It will handle initializing the token, refreshing it\n * when it nears expiration, and synchronizes refresh attempts to avoid\n * concurrency hazards.\n *\n * @param credential - the underlying TokenCredential that provides the access\n * token\n * @param tokenCyclerOptions - optionally override default settings for the cycler\n *\n * @returns - a function that reliably produces a valid access token\n */\nexport function createTokenCycler<T extends GetTokenOptions>(\n  credential: TokenCredential,\n  tokenCyclerOptions?: Partial<TokenCyclerOptions>\n): AccessTokenRefresher<T> {\n  let refreshWorker: Promise<AccessToken> | null = null;\n  let token: AccessToken | null = null;\n\n  const options = {\n    ...DEFAULT_CYCLER_OPTIONS,\n    ...tokenCyclerOptions\n  };\n\n  /**\n   * This little holder defines several predicates that we use to construct\n   * the rules of refreshing the token.\n   */\n  const cycler = {\n    /**\n     * Produces true if a refresh job is currently in progress.\n     */\n    get isRefreshing(): boolean {\n      return refreshWorker !== null;\n    },\n    /**\n     * Produces true if the cycler SHOULD refresh (we are within the refresh\n     * window and not already refreshing)\n     */\n    get shouldRefresh(): boolean {\n      return (\n        !cycler.isRefreshing &&\n        (token?.expiresOnTimestamp ?? 0) - options.refreshWindowInMs < Date.now()\n      );\n    },\n    /**\n     * Produces true if the cycler MUST refresh (null or nearly-expired\n     * token).\n     */\n    get mustRefresh(): boolean {\n      return (\n        token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now()\n      );\n    }\n  };\n\n  /**\n   * Starts a refresh job or returns the existing job if one is already\n   * running.\n   */\n  function refresh(scopes: string | string[], getTokenOptions: T): Promise<AccessToken> {\n    if (!cycler.isRefreshing) {\n      // We bind `scopes` here to avoid passing it around a lot\n      const tryGetAccessToken = (): Promise<AccessToken | null> =>\n        credential.getToken(scopes, getTokenOptions);\n\n      // Take advantage of promise chaining to insert an assignment to `token`\n      // before the refresh can be considered done.\n      refreshWorker = beginRefresh(\n        tryGetAccessToken,\n        options.retryIntervalInMs,\n        // If we don't have a token, then we should timeout immediately\n        token?.expiresOnTimestamp ?? Date.now()\n      )\n        .then((_token) => {\n          refreshWorker = null;\n          token = _token;\n          return token;\n        })\n        .catch((reason) => {\n          // We also should reset the refresher if we enter a failed state.  All\n          // existing awaiters will throw, but subsequent requests will start a\n          // new retry chain.\n          refreshWorker = null;\n          token = null;\n          throw reason;\n        });\n    }\n\n    return refreshWorker as Promise<AccessToken>;\n  }\n\n  return {\n    get cachedToken(): AccessToken | undefined {\n      return token || undefined;\n    },\n    getToken: async (scopes: string | string[], tokenOptions: T): Promise<AccessToken> => {\n      //\n      // Simple rules:\n      // - If we MUST refresh, then return the refresh task, blocking\n      //   the pipeline until a token is available.\n      // - If we SHOULD refresh, then run refresh but don't return it\n      //   (we can still use the cached token).\n      // - Return the token, since it's fine if we didn't return in\n      //   step 1.\n      //\n      if (cycler.mustRefresh) return refresh(scopes, tokenOptions);\n\n      if (cycler.shouldRefresh) {\n        refresh(scopes, tokenOptions);\n      }\n\n      return token as AccessToken;\n    }\n  };\n}\n"]}

package/dist-esm/src/url.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.browser.js","sourceRoot":"","sources":["../../src/url.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,GAAG,GAAG,GAAG,CAAC;AAChB,MAAM,eAAe,GAAG,eAAe,CAAC;AAExC,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,eAAe,IAAI,eAAe,EAAE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nconst url = URL;\nconst urlSearchParams = URLSearchParams;\n\nexport { url as URL, urlSearchParams as URLSearchParams };\n"]}

package/dist-esm/src/url.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport { URL, URLSearchParams } from \"url\";\n"]}

package/dist-esm/src/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,KAAyB;IACvD,kCAAkC;IAClC,oDAAoD;IACpD,4CAA4C;IAC5C,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,WAAmB;IAC1C,OAAO,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Extract the path part from the next link value returned by the service,\n * @internal\n */\nexport function extractNextLink(value: string | undefined): string | undefined {\n  // The link value has this pattern\n  //     `</acr/v1/name/...&n=2&orderby=>; rel=\"next\"`\n  // and we only want the part inside of <...>\n  return value?.substr(1, value.indexOf(\">\") - 1);\n}\n\n/**\n * Checks whether a string is a digest\n * @internal\n */\nexport function isDigest(tagOrDigest: string): boolean {\n  return tagOrDigest.includes(\":\");\n}\n"]}