IModelsClient.ts

/*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
import {
  AxiosRestClient,
  AxiosRetryPolicy,
  ExponentialBackoffAlgorithm,
} from "./base/axios";
import { IModelsErrorParser, ResponseInfo } from "./base/internal";
import {
  ApiOptions,
  HeaderFactories,
  HttpRequestRetryPolicy,
  IModelsOriginalError,
  RecursiveRequired,
  RestClient,
} from "./base/types";
import { Constants } from "./Constants";
import {
  BriefcaseOperations,
  ChangesetOperations,
  FavoriteIModelOperations,
  IModelOperations,
  NamedVersionOperations,
  OperationOperations,
  RecentIModelOperations,
  ThumbnailOperations,
  UserOperations,
  UserPermissionOperations,
} from "./operations";
import { ChangesetExtendedDataOperations } from "./operations/changeset-extended-data/ChangesetExtendedDataOperations";
import { ChangesetGroupOperations } from "./operations/changeset-group/ChangesetGroupOperations";
import { CheckpointOperations } from "./operations/checkpoint/CheckpointOperations";
import { IModelsApiUrlFormatter } from "./operations/IModelsApiUrlFormatter";
import { OperationOptions } from "./operations/OperationOptions";

/** User-configurable iModels client options. */
export interface IModelsClientOptions {
  /**
   * Rest client that is used for making HTTP requests. If `undefined` the default client is used which is implemented
   * using `axios` library. See {@link AxiosRestClient}.
   */
  restClient?: RestClient;
  /** iModels API options. See {@link ApiOptions}. */
  api?: ApiOptions;
  /** Additional headers to add to each request. See {@link HeaderFactories}. */
  headers?: HeaderFactories;
  /**
   * Retry policy that is used with {@link AxiosRestClient} when HTTP request sending fails.
   * If `undefined` the default implementation is used with exponential backoff algorithm
   * (3 retries with incremental sleep durations of 300ms, 900ms and 2700ms).
   * See {@link AxiosRetryPolicy} and {@link ExponentialBackoffAlgorithm}.
   */
  retryPolicy?: HttpRequestRetryPolicy;
}

/**
 * iModels API client for iModel management workflows. For more information on the API visit the
 * {@link https://developer.bentley.com/apis/imodels-v2/ iModels API documentation page}.
 */
export class IModelsClient {
  protected _operationsOptions: OperationOptions;

  /**
   * Class constructor.
   * @param {iModelsClientOptions} options client options. If `options` are `undefined` or if some of the properties
   * are `undefined` the client uses defaults. See {@link iModelsClientOptions}.
   */
  constructor(options?: IModelsClientOptions) {
    const filledIModelsClientOptions =
      IModelsClient.fillManagementClientConfiguration(options);
    this._operationsOptions = {
      ...filledIModelsClientOptions,
      parseErrorFunc: (
        response: ResponseInfo,
        originalError: IModelsOriginalError
      ) => IModelsErrorParser.parse(response, originalError),
      urlFormatter: new IModelsApiUrlFormatter(
        filledIModelsClientOptions.api.baseUrl
      ),
    };
  }

  /** iModel operations. See {@link iModelOperations}. */
  public get iModels(): IModelOperations<OperationOptions> {
    return new IModelOperations(this._operationsOptions, this);
  }

  /** Briefcase operations. See {@link BriefcaseOperations}. */
  public get briefcases(): BriefcaseOperations<OperationOptions> {
    return new BriefcaseOperations(this._operationsOptions, this);
  }

  /** Changeset operations. See {@link ChangesetOperations}. */
  public get changesets(): ChangesetOperations<OperationOptions> {
    return new ChangesetOperations(this._operationsOptions, this);
  }

  /** Changeset Extended Data operations. See {@link ChangesetExtendedDataOperations}. */
  public get changesetExtendedData(): ChangesetExtendedDataOperations<OperationOptions> {
    return new ChangesetExtendedDataOperations(this._operationsOptions);
  }

  /** Changeset Group operations. See {@link ChangesetGroupOperations}. */
  public get changesetGroups(): ChangesetGroupOperations<OperationOptions> {
    return new ChangesetGroupOperations(this._operationsOptions, this);
  }

  /** Named version operations. See {@link NamedVersionOperations}. */
  public get namedVersions(): NamedVersionOperations<OperationOptions> {
    return new NamedVersionOperations(this._operationsOptions, this);
  }

  /** Checkpoint operations. See {@link CheckpointOperations}. */
  public get checkpoints(): CheckpointOperations<OperationOptions> {
    return new CheckpointOperations(this._operationsOptions);
  }

  /** Thumbnail operations. See {@link ThumbnailOperations}. */
  public get thumbnails(): ThumbnailOperations<OperationOptions> {
    return new ThumbnailOperations(this._operationsOptions);
  }

  /** User operations. See {@link UserOperations}. */
  public get users(): UserOperations<OperationOptions> {
    return new UserOperations(this._operationsOptions);
  }

  /** User Permission operations. See {@link UserPermissionOperations}. */
  public get userPermissions(): UserPermissionOperations<OperationOptions> {
    return new UserPermissionOperations(this._operationsOptions);
  }

  /** Operation operations. See {@link OperationOperations}. */
  public get operations(): OperationOperations<OperationOptions> {
    return new OperationOperations(this._operationsOptions);
  }

  /** Favorite iModel operations. See {@link FavoriteIModelOperations}. */
  public get favoriteIModels(): FavoriteIModelOperations<OperationOptions> {
    return new FavoriteIModelOperations(this._operationsOptions);
  }

  /** Recent iModel operations. See {@link RecentIModelOperations}. */
  public get recentIModels(): RecentIModelOperations<OperationOptions> {
    return new RecentIModelOperations(this._operationsOptions);
  }

  private static fillManagementClientConfiguration(
    options: IModelsClientOptions | undefined
  ): RecursiveRequired<IModelsClientOptions> {
    const retryPolicy =
      options?.retryPolicy ??
      new AxiosRetryPolicy({
        maxRetries: Constants.retryPolicy.maxRetries,
        backoffAlgorithm: new ExponentialBackoffAlgorithm({
          baseDelayInMs: Constants.retryPolicy.baseDelayInMs,
          factor: Constants.retryPolicy.delayFactor,
        }),
      });

    return {
      api: this.fillApiConfiguration(options?.api),
      restClient: options?.restClient ?? new AxiosRestClient(retryPolicy),
      headers: options?.headers ?? {},
      retryPolicy,
    };
  }

  protected static fillApiConfiguration(
    apiOptions: ApiOptions | undefined
  ): RecursiveRequired<ApiOptions> {
    return {
      baseUrl: apiOptions?.baseUrl ?? Constants.api.baseUrl,
      version: apiOptions?.version ?? Constants.api.version,
    };
  }
}