@codiac.io/codiac-cli 1.2.156 → 1.2.164

package/lib/ops/docker-registry-api-client/docker-registry-api-client.js

@@ -1,289 +1,289 @@
-"use strict";
-// COMMENTED OUT BC:  Moved to ops-common (and refactored)
-// import * as path from 'path';
-// import { ApiClientBase } from '@codiac.io/api-client-base/api-client-base';
-// import { inject } from 'inversify';
-// import * as urella from 'url';
-// import { INTERFACES, httpRestVerb } from '@codiac.io/codiac-common';
-// import { ListResult, SingleResult } from '@codiac.io/codiac-common/contracts';
-// import { CodiacError } from "@codiac.io/codiac-common/contracts";
-// import { IBetterLogger, LogLevel } from '@codiac.io/codiac-common/IBetterLogger';
-// import { CliExec } from '@codiac.io/codiac-ops-common';
-// import { ImageTagCriteria } from './entities/image-tag-criteria';
-// import { ImageTagList } from './entities/image-tag-list';
-// import { IDockerErrorResponse } from './entities/i-docker-error-response';
-// import { TokenResponse } from './entities/token-response';
-// import { DockerAuthTokenCriteria } from './entities/docker-auth-token-criteria';
-// import { Token } from './entities/token';
-// import { DockerActionPermissionsEnum } from './entities/docker-access-actions-enum';
-// import endpointsJson from './endpoints.json';
-// import { IClientForImageRegistry } from '@codiac.io/codiac-ops-common';
-// import { DockerCredentialsStore } from '@codiac.io/codiac-ops-common';
-// import { DOCKER_CONSTANTS } from '@codiac.io/codiac-ops-common';
-// import { RepositoryCriteria } from './entities/repository-criteria';
-// import { ImageRepository } from './entities/image-repository';
-// import { IDockerListResponse } from './entities/i-docker-list-response';
-// // Test "Authorization" header value
-// // letmeaskmydog:cd32d895-8074-4bbd-ba7a-3fa4bcf5f6ab   <--- The password here is an Access Token I created on docker hub in account settings/security
-// // Basic bGV0bWVhc2tteWRvZzpjZDMyZDg5NS04MDc0LTRiYmQtYmE3YS0zZmE0YmNmNWY2YWI=
-// // RECOMMENDED WORKFLOW:  ( per https://docs.docker.com/registry/spec/auth/token/ )
-// // 
-// // 1.  Try to make a request without a token
-// // 2.  if 401,
-// //   a.  Make a JWT request with the specs provided in the response (described on that page above)
-// //      1.  The queruystring will need a service, scope, and action
-// //      2.  The headers will need a basic auth header value "Authorization" = "Basic bGV0bWVhc2tteWRvZzpjZDMyZDg5NS04MDc0LTRiYmQtYmE3YS0zZmE0YmNmNWY2YWI="
-// // 3.  Run your request again with the JWT you got back  "Authorization" = "Bearer blahasdfksdfjksd..."
-// // 4.  That token is only good for that scope and actions and expires in 5 mins
-// // 5.  To refresh the token: skip the creds and use "access_type=refresh_token" and include "refresh_token=[the refresh token you got back]"
-// export class DockerRegistryApiClient extends ApiClientBase implements IClientForImageRegistry {
-//   /** 
-//    * @see https://docs.docker.com/registry/spec/api/#detail
-//    */
-//   public static readonly DOCKER_HUB_API_URL = 'https://index.docker.io/v1/';
-//   /** Why Docker makes discovery on their api so difficult is a mystery (if you have a GOOD attitude about it). 
-//    * @see https://stackoverflow.com/questions/35444178/public-docker-v2-api-endpoints
-//    */
-//   public static readonly DOCKER_HUB_OTHER_API_URL = 'https://hub.docker.com';
-//   /** Api url to use when acquiring auth tokens. */
-//   public static readonly DOCKER_HUB_AUTH_API_URL = 'https://auth.docker.io/';
-//   /** SERVICE NAME for the information being requested.  **NOT** The target url of the Docker Hub api. */
-//   public static readonly DOCKER_REGISTRY_SERVICE_NAME = "registry.docker.io";
-//   /** The identifier for this client provided to docker for recognition.
-//    * Accepted syntax is defined in [RFC6749 Appendix A.1](https://tools.ietf.org/html/rfc6749#appendix-A.1)   */
-//   public static readonly CLIENT_ID = "codiac_cli";
-//   /** The user creds provided in "bootstrap" encoded into a basic authentication token with its "Basic " prefix, 
-//    *  for use as the value of the Authorization header when requesting a scoped token. */
-//   // private static basicAuthHeaderValue: string;
-//   /** Inidicator that the bootstrap method has been run */
-//   private static bootstrapped: boolean = false;
-//   /** REQUIRED!! You MUST fire this at startup time in order to use this class.  */
-//   public static bootstrap( /* username: string, apiKey: string */): void {
-//     super.bootstrap_base(endpointsJson);
-//     // this.setBasicAuthCreds(username, apiKey);
-//     DockerRegistryApiClient.bootstrapped = true;
-//   }
-//   // private static setBasicAuthCreds(username: string, apiKey: string): void {
-//   //   this.basicAuthHeaderValue = this.buildBasicAuthenticationHeader(username, apiKey);
-//   // }  
-//   /**
-//    * @param registryDomain The server host name of the registry (eg: my.registry.io) (without any url protocol). 
-//    *              This value is the first part of a fully qualified image name, separated by a slash "/" character.   */
-//   static supports(registryDomain: string): boolean {
-//     if (registryDomain == ""
-//       || registryDomain == this.DOCKER_REGISTRY_SERVICE_NAME
-//       || registryDomain.startsWith(this.DOCKER_HUB_API_URL)  // <-- I think this one is wrong.  Really needs to be:  https://index.docker.io/v1/
-//     ) {
-//       return true;
-//     } else {
-//       return false;
-//     }
-//   }
-//   /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
-//   *   _____          _                         ___  ___               _                   
-//   *  |_   _|        | |                        |  \/  |              | |                  
-//   *    | | _ __  ___| |_ __ _ _ __   ___ ___   | .  . | ___ _ __ ___ | |__   ___ _ __ ___ 
-//   *    | || '_ \/ __| __/ _` | '_ \ / __/ _ \  | |\/| |/ _ \ '_ ` _ \| '_ \ / _ \ '__/ __|
-//   *   _| || | | \__ \ || (_| | | | | (_|  __/  | |  | |  __/ | | | | | |_) |  __/ |  \__ \
-//   *   \___/_| |_|___/\__\__,_|_| |_|\___\___|  \_|  |_/\___|_| |_| |_|_.__/ \___|_|  |___/
-//   *                                                                                   
-//   * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-//   constructor(@inject(DockerCredentialsStore) private credStore: DockerCredentialsStore, @inject(INTERFACES.ILogger) logger: IBetterLogger
-//     , apiRootUrl?: string, authToken?: string) {
-//     super(logger, apiRootUrl, authToken);
-//     if (!DockerRegistryApiClient.bootstrapped) throw new Error("Api client has not been initialized.  Please execute the static bootstrap() method during your app startup phase.");
-//     this._cliExec = new CliExec(logger);  // this wed be better of lazy-loaded cuz we arent always gonna use it.
-//     // TODO:  Load saved tokens from a user config
-//   }
-//   private _cliExec: CliExec;
-//   protected GetDefaultRootUrl(): string {
-//     return DockerRegistryApiClient.DOCKER_HUB_API_URL;
-//   }
-//   /** List of tokens that are scoped for specific image repositories and actions within them. 
-//    * In this class, this list is hydrated by ensureTokenFor(). */
-//   private tokens: { [scope: string]: Token } = {};
-//   /** Friendly syntax for assembling a call to requestToken(). */
-//   private async ensureTokenFor(scopedImageName: string, ...permissions: DockerActionPermissionsEnum[]): Promise<Token> {
-//     return new Promise<Token>(async (resolve, reject) => {
-//       try {
-//         // Lazy load the token
-//         let scope = `repository:${(scopedImageName.indexOf("/") < 0) ? "library/" : ""}${scopedImageName}:pull`
-//         if (!this.tokens[scope] || this.tokens[scope].expirationUtc < new Date(Date.now())) {
-//           let defaultIssuedAt = new Date(Date.now());
-//           let defaultTTL_ms = 60 * 1000;
-//           let tokenCriteria = {
-//             scope: scope,
-//             service: DockerRegistryApiClient.DOCKER_REGISTRY_SERVICE_NAME,
-//             client_id: DockerRegistryApiClient.CLIENT_ID,
-//             offline_token: true
-//           };
-//           let result = await this.requestToken(tokenCriteria, DockerRegistryApiClient.DOCKER_HUB_API_URL);
-//           if (result.success && result.output) {
-//             let issuedAt = (result.output.issued_at) ? new Date(result.output.issued_at) : defaultIssuedAt;
-//             let ttl_ms = (result.output.expires_in) ? result.output.expires_in * 1000 : defaultTTL_ms;
-//             let exp = new Date(issuedAt.getTime() + ttl_ms);
-//             this.tokens[scope] = new Token(result.output.token, scopedImageName, permissions, exp);
-//             // TODO:  Persist these to the client config file
-//           } else if (result.error) new CodiacError(`Error making token request for scope ${scope}:  ${result.message || ""} ${result.error.message}. ${result.output ? JSON.stringify(result.output) : ""}`, result.error);
-//           else throw new Error(`Token request for scope ${scope} failed without error.  ${result.message}.  ${result.output ? JSON.stringify(result.output) : ""}`);
-//         }
-//         resolve(this.tokens[scope]);
-//       } catch (err) {
-//         reject(err);
-//       }
-//     });
-//   }
-//   /** Makes the actual remote call to the Docker Hub Auth service acquire a token. 
-//    * This method is used internally by this class and there is no need to call it; 
-//    * it is exposed publically merely for general utility. */
-//   public async requestToken(tokenCriteria: DockerAuthTokenCriteria, tokenProviderService: string): Promise<SingleResult<TokenResponse>> {
-//     return new Promise<SingleResult<TokenResponse>>(async (resolve, reject) => {
-//       let result = new SingleResult<TokenResponse>(false);
-//       try {
-//         let ep = this.getEndpointFor<DockerAuthTokenCriteria>(DockerAuthTokenCriteria, httpRestVerb.GET);
-//         let relUrl = this.buildUrl(ep.route, tokenCriteria, true);
-//         // relUrl = path.join(DockerRegistryApiClient.DOCKER_HUB_AUTH_API_URL.replace("//", "/"), relUrl);
-//         let url = new urella.URL(relUrl, DockerRegistryApiClient.DOCKER_HUB_AUTH_API_URL).toString();
-//         let creds = await this.credStore.tryGet(tokenProviderService);  // we know we want DockerRegistryApiClient.DOCKER_HUB_API_URL
-//         if (!creds) throw new Error(`No credentials found for ${tokenProviderService}.`);
-//         let basicAuthHeaderValue = DockerRegistryApiClient.buildBasicAuthenticationHeader(creds.Username, creds.Secret);
-//         let headers = {
-//           Authorization: basicAuthHeaderValue,
-//           "Content-Type": "application/json"
-//         };
-//         let res = await this.makeHttpCall<ImageTagCriteria, ImageTagList | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
-//         if ((<IDockerErrorResponse>res).errors) {
-//           let errResponse = <IDockerErrorResponse>res;
-//           result.error = new Error(`Error from ${ep.httpMethod} ${url}: ${errResponse.errors[0].code} ${errResponse.errors[0].message}; ${JSON.stringify(errResponse.errors[0].detail)}`)
-//           result.message = result.error.message;
-//           this.logger.error(result.error.message, errResponse);
-//         } else {
-//           let tokenResponse = <TokenResponse>(<any>res)
-//           result.success = (tokenResponse && (tokenResponse.token != undefined) && (tokenResponse.token != ""));  // ugh!
-//           result.output = tokenResponse;
-//           this.logger.debug(`Token successfully acquired for scope [${tokenCriteria.scope}].`, tokenResponse);
-//         }
-//       } catch (err) {
-//         result.message = `Error requesting token of scope [${tokenCriteria.scope}] for service [${tokenCriteria.service}]: ${err.message || err.stack}.`
-//         result.error = err;
-//       } finally {
-//         resolve(result);
-//       }
-//     });
-//   }
-//   public async authenticate(registryDomain: string, secret: string, username?: string): Promise<boolean> {
-//     return new Promise<boolean>(async (resolve, reject) => {
-//       try {
-//         let success = false;
-//         let userArg = (username) ? ` -u ${username}` : ``;  // We dont use "<token>" here.  Only do that with a creds store.
-//         let workingDir = process.cwd();
-//         let loginEnv: { [key: string]: any } = { ...process.env };
-//         loginEnv.registry_pwd = secret;
-//         let cmdLogin = `echo $registry_pwd | docker login ${registryDomain} ${userArg} --password-stdin`;
-//         // this.logger.notice(`Attempting to log into image registry [${this.styler.hilite(registryDomain)}]...`);
-//         this.logger.notice(`Attempting to log into image registry [${registryDomain}]...`);
-//         let result = await this._cliExec.execAsyncStdOut(cmdLogin, { cwd: workingDir, env: loginEnv }, LogLevel.detail, true);
-//         // need to differentiate login failures (401, 403) from other types of errors
-//         success = true;
-//         resolve(success);
-//       } catch (err) {
-//         reject(err);
-//       }
-//     });
-//   }
-//   public async push(registryDomain: string, scopedImageName: string, tag: string): Promise<void> {
-//     return new Promise<void>(async (resolve, reject) => {
-//       try {
-//         let fullImageId = registryDomain ? `${registryDomain}/${scopedImageName}:${tag}` : `${scopedImageName}:${tag}`;
-//         let scope = (scopedImageName.indexOf("/") >= 0) ? scopedImageName.split("/")[0] : undefined;
-//         let store = DockerCredentialsStore.create();
-//         let creds = await store.tryGet(registryDomain);
-//         if (!creds) throw new Error(`No credentials found for ${registryDomain}.`);
-//         let userArg = (creds.Username) ? ` -u ${creds.Username}` : ``;
-//         let passArg = (creds.Secret) ? ` -p ${creds.Secret}` : ``;
-//         let cmdLogin: string;
-//         let loginEnv: { [key: string]: any } = { ...process.env };
-//         let workingDir = process.cwd();
-//         // let regToken = "8c307c0b-e0ae-4945-9567-1da692b99322";
-//         // userArg = `-u "<token>"`; // nope that only works when using a credentials store.
-//         loginEnv.registry_pwd = creds.Secret;
-//         cmdLogin = `echo $registry_pwd | docker login ${registryDomain} ${userArg} --password-stdin`;
-//         // this.logger.notice(`Logging in and pushing [${this.styler.hilite(scopedImageName)}] to registry as [${this.styler.hilite(fullImageId)}]...`);
-//         this.logger.notice(`Logging in and pushing [${scopedImageName}] to registry as [${fullImageId}]...`);
-//         let cmdLoginAndPush = cmdLogin.concat(`  &&  docker push ${fullImageId}`);
-//         await this._cliExec.spawnAndLog(cmdLoginAndPush, workingDir, loginEnv, LogLevel.detail);
-//         resolve();
-//       } catch (err) {
-//         reject(err);
-//       }
-//     });
-//   }
-//   public async tryGetImageTags(scopedImageName: string): Promise<ListResult<string>> {
-//     return new Promise<ListResult<string>>(async (resolve, reject) => {
-//       try {
-//         let result = new ListResult<string>(false);
-//         // TODO: Validate character set in image name (this shd trap any backslashes meant to be fwd slashes)
-//         let nameInCatalog = scopedImageName;
-//         let scope = (scopedImageName.indexOf("/") >= 0) ? scopedImageName.split("/")[0] : undefined;
-//         if (!scope) nameInCatalog = DOCKER_CONSTANTS.PUBLIC_LIBRARY_SCOPE.concat("/", scopedImageName);
-//         let scopedToken = await this.ensureTokenFor(nameInCatalog, DockerActionPermissionsEnum.pull);
-//         let crit = new ImageTagCriteria(nameInCatalog);
-//         let ep = this.getEndpointFor<ImageTagCriteria>(ImageTagCriteria, httpRestVerb.GET);
-//         let url = this.buildUrl(ep.route, crit);
-//         let headers = {
-//           Authorization: `Bearer ${scopedToken.token}`
-//         };
-//         let res = await this.makeHttpCall<ImageTagCriteria, ImageTagList | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
-//         if ((<IDockerErrorResponse>res).errors) {
-//           let errRsponse = <IDockerErrorResponse>res;
-//           result.error = new Error(`Error from ${ep.httpMethod} ${url}: ${errRsponse.errors[0].code} ${errRsponse.errors[0].message}; ${JSON.stringify(errRsponse.errors[0].detail)}`)
-//           this.logger.debug(result.error.message, res);
-//           // This is where we should pick up the error and trigger a token request and reattempt.
-//           this.authToken = undefined;
-//         } else {
-//           let tagResponse = <ImageTagList>res;
-//           result.success = (tagResponse.tags && tagResponse.tags.length > 0);
-//           result.output = tagResponse;
-//         }
-//         resolve(result);
-//       } catch (err) {
-//         this.logger.write(`Error attempting getImageTags(${scopedImageName}): ${err.message || err.stack}.`);
-//         reject(err);
-//       }
-//     });
-//   }
-//   /** Performs a fuxzy text search for repositories in the catalog. 
-//    * NOTE:  Used OAuth token when running this endpoint in Postman. 
-//   */
-//   public async searchRepositories(query: string, isOfficial?: boolean, pageNumber?: number): Promise<ImageRepository[]> {
-//     return new Promise<ImageRepository[]>(async (resolve, reject) => {
-//       try {
-//         // let url = `https://hub.docker.com/v2/search/repositories/?query=rabbit`
-//         let crit = new RepositoryCriteria();
-//         crit.query = query;
-//         if (isOfficial != undefined) crit.is_official = isOfficial;
-//         if (pageNumber) crit.page = pageNumber;
-//         let ep = this.getEndpointFor<RepositoryCriteria>(RepositoryCriteria, httpRestVerb.GET);
-//         let url = this.buildUrl(ep.route, crit);
-//         let headers = {
-//           // this may only take an OAuth token
-//           // Authorization: `JWT ${OAuth.token}`  
-//         };
-//         let res = await this.makeHttpCall<RepositoryCriteria, IDockerListResponse<ImageRepository> | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
-//         let output: ImageRepository[];
-//         if ((<IDockerErrorResponse>res).errors) {
-//           let errResponse = <IDockerErrorResponse>res;
-//           throw new Error(`Error from ${ep.httpMethod} ${url}: ${errResponse.errors[0].code} ${errResponse.errors[0].message}; ${JSON.stringify(errResponse.errors[0].detail)}`)
-//           // this.logger.debug(result.error.message, res);
-//         } else {
-//           let tagResponse = <IDockerListResponse<ImageRepository>>res;
-//           output = tagResponse.results;
-//         }
-//         resolve(output);
-//       } catch (err) {
-//         reject(err);
-//       }
-//     });
-//   }
-// }
+"use strict";
+// COMMENTED OUT BC:  Moved to ops-common (and refactored)
+// import * as path from 'path';
+// import { ApiClientBase } from '@codiac.io/api-client-base/api-client-base';
+// import { inject } from 'inversify';
+// import * as urella from 'url';
+// import { INTERFACES, httpRestVerb } from '@codiac.io/codiac-common';
+// import { ListResult, SingleResult } from '@codiac.io/codiac-common/contracts';
+// import { CodiacError } from "@codiac.io/codiac-common/contracts";
+// import { IBetterLogger, LogLevel } from '@codiac.io/codiac-common/IBetterLogger';
+// import { CliExec } from '@codiac.io/codiac-ops-common';
+// import { ImageTagCriteria } from './entities/image-tag-criteria';
+// import { ImageTagList } from './entities/image-tag-list';
+// import { IDockerErrorResponse } from './entities/i-docker-error-response';
+// import { TokenResponse } from './entities/token-response';
+// import { DockerAuthTokenCriteria } from './entities/docker-auth-token-criteria';
+// import { Token } from './entities/token';
+// import { DockerActionPermissionsEnum } from './entities/docker-access-actions-enum';
+// import endpointsJson from './endpoints.json';
+// import { IClientForImageRegistry } from '@codiac.io/codiac-ops-common';
+// import { DockerCredentialsStore } from '@codiac.io/codiac-ops-common';
+// import { DOCKER_CONSTANTS } from '@codiac.io/codiac-ops-common';
+// import { RepositoryCriteria } from './entities/repository-criteria';
+// import { ImageRepository } from './entities/image-repository';
+// import { IDockerListResponse } from './entities/i-docker-list-response';
+// // Test "Authorization" header value
+// // letmeaskmydog:cd32d895-8074-4bbd-ba7a-3fa4bcf5f6ab   <--- The password here is an Access Token I created on docker hub in account settings/security
+// // Basic bGV0bWVhc2tteWRvZzpjZDMyZDg5NS04MDc0LTRiYmQtYmE3YS0zZmE0YmNmNWY2YWI=
+// // RECOMMENDED WORKFLOW:  ( per https://docs.docker.com/registry/spec/auth/token/ )
+// // 
+// // 1.  Try to make a request without a token
+// // 2.  if 401,
+// //   a.  Make a JWT request with the specs provided in the response (described on that page above)
+// //      1.  The queruystring will need a service, scope, and action
+// //      2.  The headers will need a basic auth header value "Authorization" = "Basic bGV0bWVhc2tteWRvZzpjZDMyZDg5NS04MDc0LTRiYmQtYmE3YS0zZmE0YmNmNWY2YWI="
+// // 3.  Run your request again with the JWT you got back  "Authorization" = "Bearer blahasdfksdfjksd..."
+// // 4.  That token is only good for that scope and actions and expires in 5 mins
+// // 5.  To refresh the token: skip the creds and use "access_type=refresh_token" and include "refresh_token=[the refresh token you got back]"
+// export class DockerRegistryApiClient extends ApiClientBase implements IClientForImageRegistry {
+//   /** 
+//    * @see https://docs.docker.com/registry/spec/api/#detail
+//    */
+//   public static readonly DOCKER_HUB_API_URL = 'https://index.docker.io/v1/';
+//   /** Why Docker makes discovery on their api so difficult is a mystery (if you have a GOOD attitude about it). 
+//    * @see https://stackoverflow.com/questions/35444178/public-docker-v2-api-endpoints
+//    */
+//   public static readonly DOCKER_HUB_OTHER_API_URL = 'https://hub.docker.com';
+//   /** Api url to use when acquiring auth tokens. */
+//   public static readonly DOCKER_HUB_AUTH_API_URL = 'https://auth.docker.io/';
+//   /** SERVICE NAME for the information being requested.  **NOT** The target url of the Docker Hub api. */
+//   public static readonly DOCKER_REGISTRY_SERVICE_NAME = "registry.docker.io";
+//   /** The identifier for this client provided to docker for recognition.
+//    * Accepted syntax is defined in [RFC6749 Appendix A.1](https://tools.ietf.org/html/rfc6749#appendix-A.1)   */
+//   public static readonly CLIENT_ID = "codiac_cli";
+//   /** The user creds provided in "bootstrap" encoded into a basic authentication token with its "Basic " prefix, 
+//    *  for use as the value of the Authorization header when requesting a scoped token. */
+//   // private static basicAuthHeaderValue: string;
+//   /** Inidicator that the bootstrap method has been run */
+//   private static bootstrapped: boolean = false;
+//   /** REQUIRED!! You MUST fire this at startup time in order to use this class.  */
+//   public static bootstrap( /* username: string, apiKey: string */): void {
+//     super.bootstrap_base(endpointsJson);
+//     // this.setBasicAuthCreds(username, apiKey);
+//     DockerRegistryApiClient.bootstrapped = true;
+//   }
+//   // private static setBasicAuthCreds(username: string, apiKey: string): void {
+//   //   this.basicAuthHeaderValue = this.buildBasicAuthenticationHeader(username, apiKey);
+//   // }  
+//   /**
+//    * @param registryDomain The server host name of the registry (eg: my.registry.io) (without any url protocol). 
+//    *              This value is the first part of a fully qualified image name, separated by a slash "/" character.   */
+//   static supports(registryDomain: string): boolean {
+//     if (registryDomain == ""
+//       || registryDomain == this.DOCKER_REGISTRY_SERVICE_NAME
+//       || registryDomain.startsWith(this.DOCKER_HUB_API_URL)  // <-- I think this one is wrong.  Really needs to be:  https://index.docker.io/v1/
+//     ) {
+//       return true;
+//     } else {
+//       return false;
+//     }
+//   }
+//   /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+//   *   _____          _                         ___  ___               _                   
+//   *  |_   _|        | |                        |  \/  |              | |                  
+//   *    | | _ __  ___| |_ __ _ _ __   ___ ___   | .  . | ___ _ __ ___ | |__   ___ _ __ ___ 
+//   *    | || '_ \/ __| __/ _` | '_ \ / __/ _ \  | |\/| |/ _ \ '_ ` _ \| '_ \ / _ \ '__/ __|
+//   *   _| || | | \__ \ || (_| | | | | (_|  __/  | |  | |  __/ | | | | | |_) |  __/ |  \__ \
+//   *   \___/_| |_|___/\__\__,_|_| |_|\___\___|  \_|  |_/\___|_| |_| |_|_.__/ \___|_|  |___/
+//   *                                                                                   
+//   * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+//   constructor(@inject(DockerCredentialsStore) private credStore: DockerCredentialsStore, @inject(INTERFACES.ILogger) logger: IBetterLogger
+//     , apiRootUrl?: string, authToken?: string) {
+//     super(logger, apiRootUrl, authToken);
+//     if (!DockerRegistryApiClient.bootstrapped) throw new Error("Api client has not been initialized.  Please execute the static bootstrap() method during your app startup phase.");
+//     this._cliExec = new CliExec(logger);  // this wed be better of lazy-loaded cuz we arent always gonna use it.
+//     // TODO:  Load saved tokens from a user config
+//   }
+//   private _cliExec: CliExec;
+//   protected GetDefaultRootUrl(): string {
+//     return DockerRegistryApiClient.DOCKER_HUB_API_URL;
+//   }
+//   /** List of tokens that are scoped for specific image repositories and actions within them. 
+//    * In this class, this list is hydrated by ensureTokenFor(). */
+//   private tokens: { [scope: string]: Token } = {};
+//   /** Friendly syntax for assembling a call to requestToken(). */
+//   private async ensureTokenFor(scopedImageName: string, ...permissions: DockerActionPermissionsEnum[]): Promise<Token> {
+//     return new Promise<Token>(async (resolve, reject) => {
+//       try {
+//         // Lazy load the token
+//         let scope = `repository:${(scopedImageName.indexOf("/") < 0) ? "library/" : ""}${scopedImageName}:pull`
+//         if (!this.tokens[scope] || this.tokens[scope].expirationUtc < new Date(Date.now())) {
+//           let defaultIssuedAt = new Date(Date.now());
+//           let defaultTTL_ms = 60 * 1000;
+//           let tokenCriteria = {
+//             scope: scope,
+//             service: DockerRegistryApiClient.DOCKER_REGISTRY_SERVICE_NAME,
+//             client_id: DockerRegistryApiClient.CLIENT_ID,
+//             offline_token: true
+//           };
+//           let result = await this.requestToken(tokenCriteria, DockerRegistryApiClient.DOCKER_HUB_API_URL);
+//           if (result.success && result.output) {
+//             let issuedAt = (result.output.issued_at) ? new Date(result.output.issued_at) : defaultIssuedAt;
+//             let ttl_ms = (result.output.expires_in) ? result.output.expires_in * 1000 : defaultTTL_ms;
+//             let exp = new Date(issuedAt.getTime() + ttl_ms);
+//             this.tokens[scope] = new Token(result.output.token, scopedImageName, permissions, exp);
+//             // TODO:  Persist these to the client config file
+//           } else if (result.error) new CodiacError(`Error making token request for scope ${scope}:  ${result.message || ""} ${result.error.message}. ${result.output ? JSON.stringify(result.output) : ""}`, result.error);
+//           else throw new Error(`Token request for scope ${scope} failed without error.  ${result.message}.  ${result.output ? JSON.stringify(result.output) : ""}`);
+//         }
+//         resolve(this.tokens[scope]);
+//       } catch (err) {
+//         reject(err);
+//       }
+//     });
+//   }
+//   /** Makes the actual remote call to the Docker Hub Auth service acquire a token. 
+//    * This method is used internally by this class and there is no need to call it; 
+//    * it is exposed publically merely for general utility. */
+//   public async requestToken(tokenCriteria: DockerAuthTokenCriteria, tokenProviderService: string): Promise<SingleResult<TokenResponse>> {
+//     return new Promise<SingleResult<TokenResponse>>(async (resolve, reject) => {
+//       let result = new SingleResult<TokenResponse>(false);
+//       try {
+//         let ep = this.getEndpointFor<DockerAuthTokenCriteria>(DockerAuthTokenCriteria, httpRestVerb.GET);
+//         let relUrl = this.buildUrl(ep.route, tokenCriteria, true);
+//         // relUrl = path.join(DockerRegistryApiClient.DOCKER_HUB_AUTH_API_URL.replace("//", "/"), relUrl);
+//         let url = new urella.URL(relUrl, DockerRegistryApiClient.DOCKER_HUB_AUTH_API_URL).toString();
+//         let creds = await this.credStore.tryGet(tokenProviderService);  // we know we want DockerRegistryApiClient.DOCKER_HUB_API_URL
+//         if (!creds) throw new Error(`No credentials found for ${tokenProviderService}.`);
+//         let basicAuthHeaderValue = DockerRegistryApiClient.buildBasicAuthenticationHeader(creds.Username, creds.Secret);
+//         let headers = {
+//           Authorization: basicAuthHeaderValue,
+//           "Content-Type": "application/json"
+//         };
+//         let res = await this.makeHttpCall<ImageTagCriteria, ImageTagList | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
+//         if ((<IDockerErrorResponse>res).errors) {
+//           let errResponse = <IDockerErrorResponse>res;
+//           result.error = new Error(`Error from ${ep.httpMethod} ${url}: ${errResponse.errors[0].code} ${errResponse.errors[0].message}; ${JSON.stringify(errResponse.errors[0].detail)}`)
+//           result.message = result.error.message;
+//           this.logger.error(result.error.message, errResponse);
+//         } else {
+//           let tokenResponse = <TokenResponse>(<any>res)
+//           result.success = (tokenResponse && (tokenResponse.token != undefined) && (tokenResponse.token != ""));  // ugh!
+//           result.output = tokenResponse;
+//           this.logger.debug(`Token successfully acquired for scope [${tokenCriteria.scope}].`, tokenResponse);
+//         }
+//       } catch (err) {
+//         result.message = `Error requesting token of scope [${tokenCriteria.scope}] for service [${tokenCriteria.service}]: ${err.message || err.stack}.`
+//         result.error = err;
+//       } finally {
+//         resolve(result);
+//       }
+//     });
+//   }
+//   public async authenticate(registryDomain: string, secret: string, username?: string): Promise<boolean> {
+//     return new Promise<boolean>(async (resolve, reject) => {
+//       try {
+//         let success = false;
+//         let userArg = (username) ? ` -u ${username}` : ``;  // We dont use "<token>" here.  Only do that with a creds store.
+//         let workingDir = process.cwd();
+//         let loginEnv: { [key: string]: any } = { ...process.env };
+//         loginEnv.registry_pwd = secret;
+//         let cmdLogin = `echo $registry_pwd | docker login ${registryDomain} ${userArg} --password-stdin`;
+//         // this.logger.notice(`Attempting to log into image registry [${this.styler.hilite(registryDomain)}]...`);
+//         this.logger.notice(`Attempting to log into image registry [${registryDomain}]...`);
+//         let result = await this._cliExec.execAsyncStdOut(cmdLogin, { cwd: workingDir, env: loginEnv }, LogLevel.detail, true);
+//         // need to differentiate login failures (401, 403) from other types of errors
+//         success = true;
+//         resolve(success);
+//       } catch (err) {
+//         reject(err);
+//       }
+//     });
+//   }
+//   public async push(registryDomain: string, scopedImageName: string, tag: string): Promise<void> {
+//     return new Promise<void>(async (resolve, reject) => {
+//       try {
+//         let fullImageId = registryDomain ? `${registryDomain}/${scopedImageName}:${tag}` : `${scopedImageName}:${tag}`;
+//         let scope = (scopedImageName.indexOf("/") >= 0) ? scopedImageName.split("/")[0] : undefined;
+//         let store = DockerCredentialsStore.create();
+//         let creds = await store.tryGet(registryDomain);
+//         if (!creds) throw new Error(`No credentials found for ${registryDomain}.`);
+//         let userArg = (creds.Username) ? ` -u ${creds.Username}` : ``;
+//         let passArg = (creds.Secret) ? ` -p ${creds.Secret}` : ``;
+//         let cmdLogin: string;
+//         let loginEnv: { [key: string]: any } = { ...process.env };
+//         let workingDir = process.cwd();
+//         // let regToken = "8c307c0b-e0ae-4945-9567-1da692b99322";
+//         // userArg = `-u "<token>"`; // nope that only works when using a credentials store.
+//         loginEnv.registry_pwd = creds.Secret;
+//         cmdLogin = `echo $registry_pwd | docker login ${registryDomain} ${userArg} --password-stdin`;
+//         // this.logger.notice(`Logging in and pushing [${this.styler.hilite(scopedImageName)}] to registry as [${this.styler.hilite(fullImageId)}]...`);
+//         this.logger.notice(`Logging in and pushing [${scopedImageName}] to registry as [${fullImageId}]...`);
+//         let cmdLoginAndPush = cmdLogin.concat(`  &&  docker push ${fullImageId}`);
+//         await this._cliExec.spawnAndLog(cmdLoginAndPush, workingDir, loginEnv, LogLevel.detail);
+//         resolve();
+//       } catch (err) {
+//         reject(err);
+//       }
+//     });
+//   }
+//   public async tryGetImageTags(scopedImageName: string): Promise<ListResult<string>> {
+//     return new Promise<ListResult<string>>(async (resolve, reject) => {
+//       try {
+//         let result = new ListResult<string>(false);
+//         // TODO: Validate character set in image name (this shd trap any backslashes meant to be fwd slashes)
+//         let nameInCatalog = scopedImageName;
+//         let scope = (scopedImageName.indexOf("/") >= 0) ? scopedImageName.split("/")[0] : undefined;
+//         if (!scope) nameInCatalog = DOCKER_CONSTANTS.PUBLIC_LIBRARY_SCOPE.concat("/", scopedImageName);
+//         let scopedToken = await this.ensureTokenFor(nameInCatalog, DockerActionPermissionsEnum.pull);
+//         let crit = new ImageTagCriteria(nameInCatalog);
+//         let ep = this.getEndpointFor<ImageTagCriteria>(ImageTagCriteria, httpRestVerb.GET);
+//         let url = this.buildUrl(ep.route, crit);
+//         let headers = {
+//           Authorization: `Bearer ${scopedToken.token}`
+//         };
+//         let res = await this.makeHttpCall<ImageTagCriteria, ImageTagList | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
+//         if ((<IDockerErrorResponse>res).errors) {
+//           let errRsponse = <IDockerErrorResponse>res;
+//           result.error = new Error(`Error from ${ep.httpMethod} ${url}: ${errRsponse.errors[0].code} ${errRsponse.errors[0].message}; ${JSON.stringify(errRsponse.errors[0].detail)}`)
+//           this.logger.debug(result.error.message, res);
+//           // This is where we should pick up the error and trigger a token request and reattempt.
+//           this.authToken = undefined;
+//         } else {
+//           let tagResponse = <ImageTagList>res;
+//           result.success = (tagResponse.tags && tagResponse.tags.length > 0);
+//           result.output = tagResponse;
+//         }
+//         resolve(result);
+//       } catch (err) {
+//         this.logger.write(`Error attempting getImageTags(${scopedImageName}): ${err.message || err.stack}.`);
+//         reject(err);
+//       }
+//     });
+//   }
+//   /** Performs a fuxzy text search for repositories in the catalog. 
+//    * NOTE:  Used OAuth token when running this endpoint in Postman. 
+//   */
+//   public async searchRepositories(query: string, isOfficial?: boolean, pageNumber?: number): Promise<ImageRepository[]> {
+//     return new Promise<ImageRepository[]>(async (resolve, reject) => {
+//       try {
+//         // let url = `https://hub.docker.com/v2/search/repositories/?query=rabbit`
+//         let crit = new RepositoryCriteria();
+//         crit.query = query;
+//         if (isOfficial != undefined) crit.is_official = isOfficial;
+//         if (pageNumber) crit.page = pageNumber;
+//         let ep = this.getEndpointFor<RepositoryCriteria>(RepositoryCriteria, httpRestVerb.GET);
+//         let url = this.buildUrl(ep.route, crit);
+//         let headers = {
+//           // this may only take an OAuth token
+//           // Authorization: `JWT ${OAuth.token}`  
+//         };
+//         let res = await this.makeHttpCall<RepositoryCriteria, IDockerListResponse<ImageRepository> | IDockerErrorResponse>(ep.httpMethod, url, {}, headers);
+//         let output: ImageRepository[];
+//         if ((<IDockerErrorResponse>res).errors) {
+//           let errResponse = <IDockerErrorResponse>res;
+//           throw new Error(`Error from ${ep.httpMethod} ${url}: ${errResponse.errors[0].code} ${errResponse.errors[0].message}; ${JSON.stringify(errResponse.errors[0].detail)}`)
+//           // this.logger.debug(result.error.message, res);
+//         } else {
+//           let tagResponse = <IDockerListResponse<ImageRepository>>res;
+//           output = tagResponse.results;
+//         }
+//         resolve(output);
+//       } catch (err) {
+//         reject(err);
+//       }
+//     });
+//   }
+// }
 //# sourceMappingURL=docker-registry-api-client.js.map

package/lib/ops/docker-registry-api-client/entities/blob-sum.d.ts

@@ -1,7 +1,7 @@
-export declare class Blob {
-    blobSum: string;
-    /**
-     * @param blobSum Digest
-     */
-    constructor(blobSum: string);
-}
+export declare class Blob {
+    blobSum: string;
+    /**
+     * @param blobSum Digest
+     */
+    constructor(blobSum: string);
+}