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

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+## 1.0.0 (2022-01-11)
+
+This release marks the general availability release of Azure Container Registry client SDK library.
+
+### Breaking Changes
+
+- `TagOrderBy` is renamed to `ArtifactTagOrder`.
+- `ManifestOrderBy` is renamed to `ArtifactManifestOrder`.
+- `size` property in `ArtifactManifestProperties` is renamed to `sizeInBytes`.
+
 ## 1.0.0-beta.6 (2021-11-09)
 
 ### Features Added

package/README.md

@@ -219,9 +219,9 @@ async function main() {
   const repositoryNames = client.listRepositoryNames();
   for await (const repositoryName of repositoryNames) {
     const repository = client.getRepository(repositoryName);
-    // Obtain the images ordered from newest to oldest by passing the `orderBy` option
+    // Obtain the images ordered from newest to oldest by passing the `order` option
     const imageManifests = repository.listManifestProperties({
-      orderBy: "LastUpdatedOnDescending"
+      order: "LastUpdatedOnDescending"
     });
     const imagesToKeep = 3;
     let imageCount = 0;

package/dist/index.js

@@ -3214,7 +3214,7 @@ class GeneratedClientContext extends coreClient.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-container-registry/1.0.0-beta.6`;
+        const packageDetails = `azsdk-js-container-registry/1.0.0`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -3262,7 +3262,7 @@ class GeneratedClient extends GeneratedClientContext {
  */
 const createSpan = coreTracing.createSpanFunction({
     namespace: "Azure.Containers",
-    packagePrefix: "Azure.Containers.ContainerRegistry"
+    packagePrefix: "Azure.Containers.ContainerRegistry",
 });
 
 // Copyright (c) Microsoft Corporation.
@@ -3315,7 +3315,7 @@ function delay(t, value) {
 const DEFAULT_CYCLER_OPTIONS = {
     forcedRefreshWindowInMs: 1000,
     retryIntervalInMs: 3000,
-    refreshWindowInMs: 1000 * 60 * 2 // Start refreshing 2m before expiry
+    refreshWindowInMs: 1000 * 60 * 2, // Start refreshing 2m before expiry
 };
 /**
  * Converts an an unreliable access token getter (which may resolve with null)
@@ -3399,7 +3399,7 @@ function createTokenCycler(credential, tokenCyclerOptions) {
          */
         get mustRefresh() {
             return (token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now());
-        }
+        },
     };
     /**
      * Starts a refresh job or returns the existing job if one is already
@@ -3451,7 +3451,7 @@ function createTokenCycler(credential, tokenCyclerOptions) {
                 refresh(scopes, tokenOptions);
             }
             return token;
-        }
+        },
     };
 }
 
@@ -3480,7 +3480,7 @@ class ChallengeHandler {
         this.credential = credential;
         this.options = options;
         this.cycler = createTokenCycler(credential, {
-            refreshWindowInMs: fiveMinutesInMs
+            refreshWindowInMs: fiveMinutesInMs,
         });
     }
     authorizeRequest(_options) {
@@ -3534,14 +3534,14 @@ function toManifestWritableProperties(from) {
             canDelete: from.canDelete,
             canList: from.canList,
             canRead: from.canRead,
-            canWrite: from.canWrite
+            canWrite: from.canWrite,
         }
         : undefined;
 }
 function toArtifactManifestProperties(from, repositoryName, registryLoginServer) {
     var _a, _b, _c, _d;
     return Object.assign({ registryLoginServer,
-        repositoryName, digest: from.digest, size: from.size, createdOn: from.createdOn, lastUpdatedOn: from.lastUpdatedOn, architecture: (_a = from.architecture) !== null && _a !== void 0 ? _a : undefined, operatingSystem: (_b = from.operatingSystem) !== null && _b !== void 0 ? _b : undefined, relatedArtifacts: (_c = from.relatedArtifacts) !== null && _c !== void 0 ? _c : [], tags: (_d = from.tags) !== null && _d !== void 0 ? _d : [] }, toManifestWritableProperties(from));
+        repositoryName, digest: from.digest, sizeInBytes: from.size, createdOn: from.createdOn, lastUpdatedOn: from.lastUpdatedOn, architecture: (_a = from.architecture) !== null && _a !== void 0 ? _a : undefined, operatingSystem: (_b = from.operatingSystem) !== null && _b !== void 0 ? _b : undefined, relatedArtifacts: (_c = from.relatedArtifacts) !== null && _c !== void 0 ? _c : [], tags: (_d = from.tags) !== null && _d !== void 0 ? _d : [] }, toManifestWritableProperties(from));
 }
 function toServiceTagOrderBy(orderBy) {
     return orderBy === "LastUpdatedOnAscending"
@@ -3678,7 +3678,7 @@ class RegistryArtifactImpl {
                 canDelete: options.canDelete,
                 canWrite: options.canWrite,
                 canList: options.canList,
-                canRead: options.canRead
+                canRead: options.canRead,
             } }));
         try {
             const result = await this.client.containerRegistry.updateManifestProperties(this.repositoryName, await this.getDigest(), updatedOptions);
@@ -3739,7 +3739,7 @@ class RegistryArtifactImpl {
                 canDelete: options.canDelete,
                 canWrite: options.canWrite,
                 canList: options.canList,
-                canRead: options.canRead
+                canRead: options.canRead,
             } }));
         try {
             return await this.client.containerRegistry.updateTagAttributes(this.repositoryName, tag, updatedOptions);
@@ -3804,7 +3804,7 @@ class RegistryArtifactImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: (settings = {}) => this.listTagsPage(settings, options)
+            byPage: (settings = {}) => this.listTagsPage(settings, options),
         };
     }
     listTagsItems(options = {}) {
@@ -3827,7 +3827,7 @@ class RegistryArtifactImpl {
     }
     listTagsPage(continuationState, options = {}) {
         return tslib.__asyncGenerator(this, arguments, function* listTagsPage_1() {
-            const orderby = toServiceTagOrderBy(options.orderBy);
+            const orderby = toServiceTagOrderBy(options.order);
             if (!continuationState.continuationToken) {
                 const optionsComplete = Object.assign(Object.assign({}, options), { n: continuationState.maxPageSize, orderby });
                 const currentPage = yield tslib.__await(this.client.containerRegistry.getTags(this.repositoryName, optionsComplete));
@@ -3838,7 +3838,7 @@ class RegistryArtifactImpl {
                     });
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }
@@ -3851,7 +3851,7 @@ class RegistryArtifactImpl {
                     });
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }
@@ -3943,7 +3943,7 @@ class ContainerRepositoryImpl {
             canDelete: options.canDelete,
             canWrite: options.canWrite,
             canList: options.canList,
-            canRead: options.canRead
+            canRead: options.canRead,
         };
         const { span, updatedOptions } = createSpan("ContainerRepository-updateProperties", Object.assign(Object.assign({}, options), { value }));
         try {
@@ -4010,7 +4010,7 @@ class ContainerRepositoryImpl {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: (settings = {}) => this.listManifestsPage(settings, options)
+            byPage: (settings = {}) => this.listManifestsPage(settings, options),
         };
     }
     listManifestsItems(options = {}) {
@@ -4033,7 +4033,7 @@ class ContainerRepositoryImpl {
     }
     listManifestsPage(continuationState, options = {}) {
         return tslib.__asyncGenerator(this, arguments, function* listManifestsPage_1() {
-            const orderby = toServiceManifestOrderBy(options.orderBy);
+            const orderby = toServiceManifestOrderBy(options.order);
             if (!continuationState.continuationToken) {
                 const optionsComplete = Object.assign(Object.assign({}, options), { n: continuationState.maxPageSize, orderby });
                 const currentPage = yield tslib.__await(this.client.containerRegistry.getManifests(this.name, optionsComplete));
@@ -4042,7 +4042,7 @@ class ContainerRepositoryImpl {
                     const array = currentPage.manifests.map((t) => toArtifactManifestProperties(t, this.name, currentPage.registryLoginServer));
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }
@@ -4053,7 +4053,7 @@ class ContainerRepositoryImpl {
                     const array = currentPage.manifests.map((t) => toArtifactManifestProperties(t, this.name, currentPage.registryLoginServer));
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }
@@ -4093,74 +4093,12 @@ class ContainerRegistryRefreshTokenCredential {
         return this.tokenService.ExchangeAadAccessTokenForAcrRefreshTokenAsync(aadToken.token, options.service, options);
     }
 }
-const customExchangeAadTokenForAcrRefreshTokenOperationSpec = {
-    path: "/oauth2/exchange",
-    httpMethod: "POST",
-    responses: {
-        200: {
-            bodyMapper: AcrRefreshToken
-        },
-        default: {
-            bodyMapper: AcrErrors
-        }
-    },
-    // formDataParameters: [Parameters.aadAccesstoken],
-    requestBody: {
-        parameterPath: ["options", "payload"],
-        mapper: {
-            type: {
-                name: "Stream"
-            }
-        }
-    },
-    urlParameters: [url],
-    headerParameters: [contentType3, accept4],
-    serializer: coreClient.createSerializer(Mappers, /* isXml */ false)
-};
-const customExchangeAcrRefreshTokenForAcrAccessTokenOperationSpec = {
-    path: "/oauth2/token",
-    httpMethod: "POST",
-    responses: {
-        200: {
-            bodyMapper: AcrAccessToken
-        },
-        default: {
-            bodyMapper: AcrErrors
-        }
-    },
-    // formDataParameters: [Parameters.acrRefreshToken],
-    requestBody: {
-        parameterPath: ["options", "payload"],
-        mapper: {
-            type: {
-                name: "Stream"
-            }
-        }
-    },
-    urlParameters: [url],
-    headerParameters: [contentType3, accept4],
-    serializer: coreClient.createSerializer(Mappers, /* isXml */ false)
-};
 class ContainerRegistryTokenService {
     constructor(authClient) {
         this.authClient = authClient;
     }
     async ExchangeAadAccessTokenForAcrRefreshTokenAsync(aadAccessToken, service, options) {
-        // const acrRefreshToken = await this.authClient.authentication.exchangeAadTokenForAcrRefreshToken(
-        //   {
-        //     aadAccesstoken: {
-        //       grantType: "access_token",
-        //       service,
-        //       aadAccesstoken: aadAccessToken,
-        //     }
-        //   }
-        // );
-        // TODO: (jeremymeng) revert custom sendOperationRequest call after FormData is working in core
-        const payload = `grant_type=access_token&service=${encodeURIComponent(service)}&access_token=${encodeURIComponent(aadAccessToken)}`;
-        const customOptions = {
-            payload
-        };
-        const acrRefreshToken = await this.authClient.sendOperationRequest({ options: Object.assign(Object.assign({}, options), customOptions) }, customExchangeAadTokenForAcrRefreshTokenOperationSpec);
+        const acrRefreshToken = await this.authClient.authentication.exchangeAadAccessTokenForAcrRefreshToken("access_token", service, Object.assign(Object.assign({}, options), { accessToken: aadAccessToken }));
         if (!acrRefreshToken.refreshToken) {
             throw new Error("Failed to exchange AAD access token for an ACR refresh token.");
         }
@@ -4180,26 +4118,11 @@ class ContainerRegistryTokenService {
         const expiry = Number.parseInt(jwtPayload.exp) * 1000;
         return {
             token: acrRefreshToken.refreshToken,
-            expiresOnTimestamp: expiry
+            expiresOnTimestamp: expiry,
         };
     }
     async ExchangeAcrRefreshTokenForAcrAccessTokenAsync(acrRefreshToken, service, scope, grantType, options) {
-        // const acrAccessToken = await this.authClient.authentication.exchangeAcrRefreshTokenForAcrAccessToken(
-        //   {
-        //     acrRefreshToken: {
-        //       grantType: "refresh_token",
-        //       acrRefreshToken,
-        //       service,
-        //       scope
-        //     }
-        //   }
-        // );
-        // TODO: (jeremymeng) revert custom sendOperationRequest call after FormData is working in core
-        const payload = `grant_type=${grantType}&service=${encodeURIComponent(service)}&refresh_token=${acrRefreshToken ? encodeURIComponent(acrRefreshToken) : ""}&scope=${encodeURIComponent(scope)}`;
-        const customOptions = {
-            payload
-        };
-        const acrAccessToken = await this.authClient.sendOperationRequest({ options: Object.assign(Object.assign({}, options), customOptions) }, customExchangeAcrRefreshTokenForAcrAccessTokenOperationSpec);
+        const acrAccessToken = await this.authClient.authentication.exchangeAcrRefreshTokenForAcrAccessToken(service, scope, acrRefreshToken, grantType, options);
         if (!acrAccessToken.accessToken) {
             throw new Error("Failed to exchange ACR refresh token for an ACR access token");
         }
@@ -4232,7 +4155,7 @@ class ContainerRegistryClient {
                 logger: logger.info,
                 // This array contains header names we want to log that are not already
                 // included as safe. Unknown/unsafe headers are logged as "<REDACTED>".
-                additionalAllowedQueryParameters: ["last", "n", "orderby", "digest"]
+                additionalAllowedQueryParameters: ["last", "n", "orderby", "digest"],
             } });
         // Require audience now until we have a default ACR audience from the service.
         if (!options.audience) {
@@ -4245,7 +4168,7 @@ class ContainerRegistryClient {
         this.client.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({
             credential,
             scopes: [defaultScope],
-            challengeCallbacks: new ChallengeHandler(new ContainerRegistryRefreshTokenCredential(authClient, defaultScope, credential))
+            challengeCallbacks: new ChallengeHandler(new ContainerRegistryRefreshTokenCredential(authClient, defaultScope, credential)),
         }));
     }
     /**
@@ -4345,7 +4268,7 @@ class ContainerRegistryClient {
             [Symbol.asyncIterator]() {
                 return this;
             },
-            byPage: (settings = {}) => this.listRepositoriesPage(settings, options)
+            byPage: (settings = {}) => this.listRepositoriesPage(settings, options),
         };
     }
     listRepositoryItems(options = {}) {
@@ -4376,7 +4299,7 @@ class ContainerRegistryClient {
                     const array = currentPage.repositories;
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }
@@ -4387,7 +4310,7 @@ class ContainerRegistryClient {
                     const array = currentPage.repositories;
                     yield yield tslib.__await(Object.defineProperty(array, "continuationToken", {
                         value: continuationState.continuationToken,
-                        enumerable: true
+                        enumerable: true,
                     }));
                 }
             }