trimble-connect-sdk/service.d.ts

Trimble Connect SDK for JavaScript

import { Configuration } from './config';
import { Range } from './common';
import { ServiceResponse } from './response';
/**
 * The service client that represents connection to the Organizer Service.
 * Each API operation is exposed as a function on service.
 */
export declare class Service {
    readonly config: Configuration;
    /** Used if maxRetries is not specified in {@see Configuration#maxRetries }. The defaultRetryCount can be overridden by service classes. */
    private defaultRetryCount;
    /**
     * @constructor Constructs a service object.
     * @param {Config} config The configuration options (e.g. service url).
     */
    constructor(config: Configuration);
    /**
     * Fetches the next page from the sequence of pages initiated by {@see Organizer.listTrees }.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {string} method The HTTP method.
     * @param {string | FormData} body Optional body to send in the request.
     * @param {Headers} customHeaders Optional headers to attach to request.
     * @param {boolean} auth The value indicating whether the request requires authentication. If true, the credentials will be requested from the configuration {@see Config#credentials } and Authorization header will be attached.
     * @returns {Promise<ServiceResponse<D>>} The service response.
     * @throws {ServiceError} in case of the error response from the service.
     */
    makeRequest<D>(url: string, method?: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE', body?: string | FormData, customHeaders?: Headers, auth?: boolean): Promise<ServiceResponse<D>>;
    /**
     * Fetches all the items page by page, returning each page results in a callback.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {(response: ServiceResponse<D>) => void} onPageRetrieved The callback used to return results, page by page.
     * @param {number} pageSize The page size used to request items.
     * @param {string | FormData} body Optional body to send in the request.
     * @param {Headers} customHeaders Optional headers to attach to request.
     * @param {boolean} auth The value indicating whether the request requires authentication. If true, the credentials will be requested from the configuration {@see Config#credentials } and Authorization header will be attached.
     * @returns {Promise<void>} Promise that resolves when all pages have been retrieved.
     * @throws {ServiceError} in case of the error response from the service.
     */
    getItemsWithPages<D>(url: string, onPageRetrieved: (response: ServiceResponse<D>) => void, pageSize: number, body?: string | FormData, customHeaders?: Headers, auth?: boolean): Promise<void>;
    /**
     * Fetches all the items page by page using adaptive pagination, returning each page results in a callback.
     * Starts with a small initial page size for faster first response, then switches to a larger page size after a threshold.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {(response: ServiceResponse<D>) => void} onPageRetrieved The callback used to return results, page by page.
     * @param {number} initialPageSize The page size for initial requests (default: 10).
     * @param {number} standardPageSize The page size after threshold is reached (default: 100).
     * @param {number} threshold The number of items to load before switching to standard page size (default: 50).
     * @param {string | FormData} body Optional body to send in the request.
     * @param {Headers} customHeaders Optional headers to attach to request.
     * @param {boolean} auth The value indicating whether the request requires authentication. If true, the credentials will be requested from the configuration {@see Config#credentials } and Authorization header will be attached.
     * @returns {Promise<void>} Promise that resolves when all pages have been retrieved.
     * @throws {ServiceError} in case of the error response from the service.
     */
    getItemsWithPagesAdaptive<D>(url: string, onPageRetrieved: (response: ServiceResponse<D>) => void, initialPageSize?: number, standardPageSize?: number, threshold?: number, body?: string | FormData, customHeaders?: Headers, auth?: boolean): Promise<void>;
    /**
     * Makes a service request with all needed authentication and retry logic. Converts error response to exception.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {string} method The HTTP method.
     * @param {string | FormData | Blob} body The body to send in the request.
     * @param {Headers} customHeaders The custom headers to attach to request.
     * @param {boolean} auth The value indicating whether the request requires authentication. If true, the credentials will be requested from the configuration {@see Config#credentials } and Authorization header will be attached.
     * @returns {Promise<ServiceResponse<D>>} The service response.
     * @throws {ServiceError} in case of the error response from the service.
     */
    request(url: string, method?: 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE', body?: string | FormData | Blob, customHeaders?: Headers, auth?: boolean): Promise<ServiceResponse<void>>;
    /**
     * How many times a failed request should be retried before giving up.
     * the defaultRetryCount can be overridden by service classes.
     *
     * @api private
     * @private
     */
    maxRetries(): number;
    /**
     * First retry goes immediately (0ms delay) then exponential growth with 100ms as a base.
     * @api private
     * @private
     */
    calculateRetryDelay(retryCount: number): number;
    /**
     * @api private
     * @private
     */
    private retryableError;
    /**
     * @api private
     * @private
     */
    private networkingError;
    /**
     * @api private
     * @private
     */
    private timeoutError;
    /**
     * @api private
     * @private
     */
    private expiredCredentialsError;
    /**
     * @api private
     * @private
     */
    private throttledError;
    /**
     * Makes a service call and takes care about retry logic (re-authentication if needed).
     * Note the <void> as a generic parameter. This method does not read the response body. The ServiceResponse return value will be cased to needed type on upper levels of the code.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {string} params The fetch parameters.
     * @param {boolean} auth The value indicating whether the request requires authentication. If true, the credentials will be requested from the configuration {@see Config#credentials } and Authorization header will be attached.
     * @returns {Promise<ServiceResponse<void>>} The service response.
     * @throws {ServiceError} in case of the error response from the service.
     * @private
     */
    private fetchWithRetry;
    /**
     * The lowest level fetch function wrapper.
     * This method allows to separate the step of actual sending of the request in the HTTP pipeline and potentially intercept it and fire events.
     * @param {string} url The url to make request to. Could be absolute or relative to the service base uri.
     * @param {string} params The HTTP method.
     * @private
     */
    private fetch;
    /**
     * Gets the next range for the rest of the results of response data.
     * @param {ServiceResponse<D>} response The response for which we get the next range.
     * @private
     */
    private getRange;
    /**
     * Determines if there are more pages to retrieve based on the response and Content-Range header.
     * @param {ServiceResponse<D>} response The response to check.
     * @param {Range} responseRange Optional pre-computed range to avoid duplicate header parsing.
     * @returns {boolean} True if there are more pages to retrieve, false otherwise.
     * @protected
     */
    protected hasMorePages<D>(response: ServiceResponse<D>, responseRange?: Range): boolean;
    /**
     * Put a line of text to the log.
     * @param {string} line The line to log.
     * @private
     */
    private log;
}