polarity-integration-utils 0.1.0 → 3.1.3

package/dist/dts/lib/requests/polarity-request.d.ts

@@ -0,0 +1,411 @@
+import Bottleneck from 'bottleneck';
+import { ApiRequestError, NetworkError, RetryRequestError } from '../errors';
+import type { Entity, DoLookupUserOptions } from '../types';
+/**
+ * @public
+ */
+export type ConfigRequestProxyOptions = {
+    ca?: undefined | string;
+    cert?: undefined | string;
+    key?: undefined | string;
+    passphrase?: undefined | string;
+    rejectUnauthorized?: undefined | boolean;
+    proxy?: undefined | string;
+    json?: undefined | boolean;
+};
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+/**
+ * @public
+ */
+export type HttpRequestOptions = {
+    /**
+     * The URL to make the request to.
+     */
+    url?: string;
+    /**
+     * The HTTP method to use for the request.
+     *
+     * @defaultValue 'GET'
+     */
+    method?: HttpMethod;
+    /**
+     *  If true, sets body to JSON representation of value and adds Content-type: application/json header.
+     *  Additionally, parses the response body as JSON.
+     *
+     *  @defaultValue true
+     */
+    json?: boolean;
+    /**
+     * An object containing the headers to include in the request.
+     * @example
+     * Here is an example of setting the "X-Api-Key" `headers` property:
+     * ```
+     * {
+     *   headers: {
+     *     'X-Api-Key': '1234567890'
+     *   }
+     * }
+     * ```
+     */
+    headers?: object;
+    /**
+     * An object containing querystring parameters to include in the request.
+     * @example
+     * Here is an example of setting the `qs` property:
+     * ```
+     * {
+     *   qs: {
+     *     search: 'foo'
+     *   }
+     * }
+     * ```
+     */
+    qs?: object;
+    /**
+     * When passed an object or a querystring, this sets body to a querystring representation of value,
+     * and adds Content-type: application/x-www-form-urlencoded header.
+     */
+    form?: object;
+    /**
+     * The body of the request.
+     */
+    body?: object;
+    /**
+     * The authentication options to use for the request
+     */
+    auth?: {
+        username: string;
+        password: string;
+        sendImmediately?: boolean;
+    } | {
+        bearer: string;
+        sendImmediately?: boolean;
+    };
+    [key: string]: unknown;
+} & ({
+    entity: Entity;
+    entities?: never;
+    requestId?: never;
+} | {
+    entities: Entity[];
+    entity?: never;
+    requestId?: never;
+} | {
+    requestId: string | unknown;
+    entity?: never;
+    entities?: never;
+} | {
+    entity?: never;
+    entities?: never;
+    requestId?: never;
+});
+/**
+ * @public
+ */
+export type RunInParallelOptions = {
+    /**
+     * Array of HttpRequestOptions that will be run in parallel as specified by
+     * the `maxConcurrentRequests` property.
+     */
+    allRequestOptions: HttpRequestOptions[];
+    /**
+     * Maximum number of requests to run in parallel
+     *
+     * @defaultValue 5
+     */
+    maxConcurrentRequests?: number;
+    /**
+     * If true, any errors thrown during the request will be returned in the response object on the `error` property
+     * of the returned `HttpRequestResponse` object.  If false, any errors thrown will be thrown and should be handled by
+     *
+     *
+     * @defaultValue false
+     */
+    returnErrors?: boolean;
+};
+/**
+ * @public
+ */
+export type HttpRequestResponse = {
+    /**
+     * The HTTP status code of the response.
+     */
+    statusCode: number;
+    request: {
+        uri: unknown;
+        method: string;
+        headers: unknown;
+        [key: string]: unknown;
+    };
+    /**
+     * The body of the response.
+     */
+    body: unknown;
+    /**
+     * The response headers
+     */
+    headers: unknown;
+    /**
+     * The error object if an error occurred during the request.
+     */
+    error?: ApiRequestError | NetworkError | RetryRequestError;
+    /**
+     * The entity that the request was made for. The `entity` property matches the
+     * `entity` property set on the {@link HttpRequestOptions} object associated with this HttpRequestResponse.
+     */
+    entity?: Entity;
+    /**
+     * An array of entities that the request was made for.  The `entities` property
+     * matches the `entities` property set on the {@link HttpRequestOptions} object associated
+     * with this HttpRequestResponse.
+     */
+    entities?: Entity[];
+    /**
+     * A custom request id that can be used to identify the request.  The `requestId` matches
+     * the `requestId` property set on the {@link HttpRequestOptions} object.
+     */
+    requestId?: string | unknown;
+    [key: string]: unknown;
+};
+/**
+ * @public
+ */
+export type IsApiErrorResult = {
+    /**
+     * Indicates whether the response is an API error.
+     */
+    isApiError: boolean;
+    /**
+     * Optional message providing additional information about the API error.  The
+     * returned `message` will be used as the `message` property on the {@link ApiRequestError} object
+     * thrown by the request.
+     */
+    message?: string;
+};
+/**
+ * @public
+ */
+export type IsApiErrorFunction = (response: HttpRequestResponse, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => IsApiErrorResult;
+/**
+ * Optional middleware method for modifying {@link HttpRequestOptions} before a request is made
+ * via the {@link PolarityRequest.run} method or {@link PolarityRequest.runInParallel} method.
+ * The returned `requestOptions` object will be used for the request.  This method is passed
+ * a copy of the original `requestOptions` object so it can be modified without side effects.
+ *
+ * This method is typically used for adding authentication (e.g., auth headers, or basic auth) to every request.  It can also
+ * be used to add headers that are required on every request or conditionally add headers based
+ * on the passed in `userOptions`.
+ *
+ * @public
+ */
+export type PreprocessRequestOptions = (requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<HttpRequestOptions> | never | undefined;
+/**
+ * Optional middleware method for modifying the {@link HttpRequestResponse} after a successful request.
+ * The passed in {@link HttpRequestResponse} object is not a copy but can be safely modified without
+ * side effects.  The returned `HttpRequestResponse` object will be used for the response.
+ *
+ * @public
+ */
+export type PostprocessRequestSuccess = (response: HttpRequestResponse, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<HttpRequestResponse> | never;
+/**
+ * @public
+ */
+export type PostprocessRequestFailure = (error: Error, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<unknown> | never;
+/**
+ * @public
+ */
+export interface PolarityRequestOptions {
+    defaults?: ConfigRequestProxyOptions;
+    isApiError?: IsApiErrorFunction;
+    roundedSuccessStatusCodes?: number[];
+    httpResponseErrorProperties?: string[];
+    httpResponseErrorMessageProperties?: string[];
+    requestOptionsToSanitize?: string[];
+    preprocessRequestOptions?: PreprocessRequestOptions;
+    postprocessRequestSuccess?: PostprocessRequestSuccess;
+    postprocessRequestFailure?: PostprocessRequestFailure;
+    throttlingOptions?: Bottleneck.ConstructorOptions;
+}
+/**
+ * A utility class for making HTTP requests
+ * @public
+ */
+export declare class PolarityRequest {
+    private bottleneckLimiter;
+    /**
+     * Instance of a Bunyan logger
+     */
+    private logger;
+    private internalThrottlingOptions;
+    /**
+     * postman-request library request object with default values set.  Used internally for
+     * making HTTP requests directly via the postman-request library
+     */
+    private readonly requestWithDefaults;
+    readonly roundedSuccessStatusCodes: number[];
+    /**
+     * One or more HTTP response properties specified using JSON dot notation.  If the
+     * specified path exists within the `body` property of the HTTP Response, an
+     * ApiRequestError will be thrown.
+     *
+     * By default, this value is an empty array and response properties are not used to
+     * detect errors.
+     * @defaultValue []
+     */
+    readonly httpResponseErrorProperties: string[];
+    /**
+     * One or more HTTP response properties specified using JSON dot notation that
+     * point to an error message that should be displayed to the user in the event
+     * of an API error.
+     *
+     * The property should be a string value.  If the property does not exist or is not
+     * a string value, a default error message will be used instead.
+     */
+    readonly httpResponseErrorMessageProperties: string[];
+    /**
+     * Optional method that can be implemented to determine if an API error
+     * was encountered after an HTTP request is made.
+     *
+     * If the `isApiError` method is implemented
+     * the property `roundedSuccessStatusCodes` and `httpResponseErrorProperties` are not
+     * used to determine API errors.
+     *
+     * @returns An object indicating whether an API error was encountered and an optional message.
+     */
+    readonly isApiError: IsApiErrorFunction;
+    /**
+     * An array of JSON dot notation paths to omit from the request options when logging.
+     *
+     * This property can be used to sanitize sensitive request properties that should not
+     * appear in logging.
+     *
+     * Note that the `requestOptions` object is automatically sanitized to remove properties that
+     * typically contain sensitive API key and passwords.  For a list of properties that are
+     * automatically sanitized, see the {@link sanitizeRequestOptions} method.
+     */
+    readonly requestOptionsToSanitize: string[];
+    userOptions: DoLookupUserOptions;
+    /**
+     * Optional middleware method for modifying {@link HttpRequestOptions} before a request is made
+     * via the {@link PolarityRequest.run} method or {@link PolarityRequest.runInParallel} method.
+     * The returned `requestOptions` object will be used for the request.  This method is passed
+     * a copy of the original `requestOptions` object so it can be modified without side effects.
+     *
+     * This method is typically used for adding authentication (e.g., auth headers, or basic auth) to every request.
+     * It can also be used to add headers that are required on every request or conditionally add headers based
+     * on the passed in `userOptions`.
+     *
+     * This method can be set as part of the {@link PolarityRequestOptions} when creating a new instance of the
+     * {@link PolarityRequest} class or can be set after the fact.
+     *
+     * @param requestOptions - A copy of the request options used for the request.  This object can be modified
+     * without side effects.
+     * @param userOptions - The user options passed into the `doLookup` method.
+     * @returns The modified request options to use for the request.
+     */
+    preprocessRequestOptions: PreprocessRequestOptions;
+    /**
+     * Optional middleware method for modifying the {@link HttpRequestResponse} after a successful request.
+     * The passed in {@link HttpRequestResponse} object is not a copy but can be safely modified without
+     * side effects.  The returned `HttpRequestResponse` object will be used for the response.
+     *
+     * @param response - The HTTP response from the request.
+     * @param requestOptions - The request options used for the request.
+     * @param userOptions - The user options passed into the `doLookup` method.
+     */
+    postprocessRequestSuccess: PostprocessRequestSuccess;
+    /**
+     * Method that can be implemented to post-process the HTTP response after a failed request.
+     * This method is typically used to inspect the error thrown and either alter the error
+     * object (e.g., to change the error message property to something more specific), to ignore
+     * the error (by not rethrowing it), or to take a specific action based on the error (e.g.,
+     * in the case of a RetryRequestError you may want to retry the request or return a special
+     * payload to the integration front end).
+     *
+     * @param error - The error thrown during the request.
+     * @param requestOptions - The request options used for the request.
+     * @param userOptions - The user options passed into the `doLookup` method.
+     */
+    postprocessRequestFailure: PostprocessRequestFailure;
+    get throttlingOptions(): Bottleneck.ConstructorOptions;
+    set throttlingOptions(throttlingOptions: Bottleneck.ConstructorOptions);
+    constructor(options?: PolarityRequestOptions);
+    private configFieldIsValid;
+    /**
+     * Makes a single HTTP request and returns the response or throws an error
+     *
+     * @param requestOptions - request options used to make the HTTP request
+     * @returns The HTTP response
+     */
+    run(requestOptions: HttpRequestOptions): Promise<HttpRequestResponse> | never;
+    /**
+     * Checks whether the HTTP response is an API error and throws an ApiRequestError if it is.
+     *
+     * @param httpResponse - The HTTP response from the Postman request.
+     * @param requestOptions - The options used for the request.
+     *
+     * @throws {@link ApiRequestError}
+     * Throws an error if the response indicates an API error.
+     */
+    private maybeThrowApiRequestError;
+    /**
+     * Returns true if the `httpStatusCode` is not one of the rounded HTTP status codes
+     * specified in the PolarityRequest `roundedSuccessStatusCodes` property.
+     *
+     * @param httpStatusCode - A numeric HTTP Status Code
+     * @returns true if the provided `httpStatusCode` is an error code
+     */
+    private isHttpStatusCodeError;
+    /**
+     * Returns true indicating that the API returned an error  if the `httpBody` contains
+     * one of the paths specified by the PolarityRequest `httpResponseErrorProperties`
+     * property.
+     *
+     * @param httpBody - body property from the HttpRequestResponse
+     * @returns `true` if the httpBody property contains properties specified in `httpResponseErrorProperties`
+     */
+    private hasHttpResponseErrorProperty;
+    /**
+     * Returns an error message based on the `httpResponseErrorMessageProperties` first.  If no
+     * message is found, it then uses the `httpResponseErrorProperties` to attempt to find
+     * a suitable error message.  If no message is still found, the `defaultMessage` is returned.
+     *
+     * @param httpBody - JSON Object returned by an HTTP Request
+     * @param defaultMessage - A default error message to use if no specific error messages are found
+     * @returns An error message
+     */
+    private getErrorMessageFromHttpResponse;
+    /**
+     * Given a list of `properties` which are strings representing JSON dot notation, this
+     * method returns the first string property found at the given JSON path
+     * in the given `object`.
+     *
+     * @param object - An object to find properties in
+     * @param properties - a list of JSON dot notation properties to look for within `object`
+     * @returns A string value of the property found within the given object or undefined if no value is found
+     */
+    private maybeGetStringPropertyValue;
+    /**
+     * Runs multiple requests in parallel with a limit on the maximum number of concurrent requests.
+     *
+     * When running multiple request at once it is often useful to be able to tie a specific request
+     * back to the entity the request is for.  To support this, the `HttpRequestOptions` object accepts
+     * an optional `entity` property which can be assigned to the Entity the request is being made for.
+     * The `HttpRequestResponse` object returned by this method will include the same `entity` property
+     * making it easy to match the response to the entity.
+     *
+     * Alternatively, for requests that are made for multiple entities at once (e.g., a query that can
+     * search multiple entities at a time), the `HttpRequestOptions` object also has an `entities`
+     * property which accept an array of entity objects.  Similar to the `entity`, the
+     * `entities` property will be set on the `HttpRequestResponse` object.
+     *
+     * Finally, if you are looking to pass through a custom request id you can do that using the
+     * `requestId` property.
+     *
+     * @param options - An array of request options for running requests in parallel.
+     * @returns A promise that resolves to an array of responses.  If the `returnErrors` property is set to `true`
+     * then the response objects will have their `error` property set to the thrown error.
+     */
+    runInParallel(options: RunInParallelOptions): Promise<HttpRequestResponse[]>;
+}
+//# sourceMappingURL=polarity-request.d.ts.map

package/dist/dts/lib/requests/polarity-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polarity-request.d.ts","sourceRoot":"","sources":["../../../../lib/requests/polarity-request.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,MAAM,YAAY,CAAC;AAMpC,OAAO,EACL,eAAe,EACf,YAAY,EACZ,iBAAiB,EAElB,MAAM,WAAW,CAAC;AAGnB,OAAO,KAAK,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG5D;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAChC,kBAAkB,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IACzC,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EACD;QACE,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,GACD;QACE,MAAM,EAAE,MAAM,CAAC;QACf,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;IACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,GAAG,CACA;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAE,GACvD;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAE,GACzD;IAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GACjE;IAAE,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAE,CAC1D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;IACxC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACP,GAAG,EAAE,OAAO,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,OAAO,CAAC;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,GAAG,YAAY,GAAG,iBAAiB,CAAC;IAC3D;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,QAAQ,EAAE,mBAAmB,EAC7B,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,gBAAgB,CAAC;AAEtB;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,kBAAkB,CAAC,GAAG,KAAK,GAAG,SAAS,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACtC,QAAQ,EAAE,mBAAmB,EAC7B,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACtC,KAAK,EAAE,KAAK,EACZ,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC,kCAAkC,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9C,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD,iBAAiB,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC;CACnD;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,iBAAiB,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC;IACf,OAAO,CAAC,yBAAyB,CAAgC;IACjE;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAEF;IAElC,SAAgB,yBAAyB,EAAE,MAAM,EAAE,CAAS;IAC5D;;;;;;;;OAQG;IACH,SAAgB,2BAA2B,EAAE,MAAM,EAAE,CAAM;IAC3D;;;;;;;OAOG;IACH,SAAgB,kCAAkC,EAAE,MAAM,EAAE,CAAM;IAClE;;;;;;;;;OASG;IACH,SAAgB,UAAU,EAAE,kBAAkB,CAAQ;IACtD;;;;;;;;;OASG;IACH,SAAgB,wBAAwB,EAAE,MAAM,EAAE,CAAM;IACjD,WAAW,EAAE,mBAAmB,CAAQ;IAE/C;;;;;;;;;;;;;;;;;OAiBG;IACI,wBAAwB,EAAE,wBAAwB,CAIR;IAEjD;;;;;;;;OAQG;IACI,yBAAyB,EAAE,yBAAyB,CAMf;IAE5C;;;;;;;;;;;OAWG;IACI,yBAAyB,EAAE,yBAAyB,CAQzD;IAEF,IAAW,iBAAiB,IAAI,UAAU,CAAC,kBAAkB,CAE5D;IAID,IAAW,iBAAiB,CAAC,iBAAiB,EAAE,UAAU,CAAC,kBAAkB,EAkB5E;gBAEW,OAAO,GAAE,sBAA2B;IAuEhD,OAAO,CAAC,kBAAkB,CACsB;IAEhD;;;;;OAKG;IACU,GAAG,CACd,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,mBAAmB,CAAC,GAAG,KAAK;IA2EvC;;;;;;;;OAQG;IACH,OAAO,CAAC,yBAAyB;IAkEjC;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;;;;;;OAOG;IACH,OAAO,CAAC,4BAA4B;IAIpC;;;;;;;;OAQG;IACH,OAAO,CAAC,+BAA+B;IAkBvC;;;;;;;;OAQG;IACH,OAAO,CAAC,2BAA2B;IAiBnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,aAAa,CACxB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,mBAAmB,EAAE,CAAC;CA4ClC"}

package/dist/dts/lib/requests/sanitize-request-options.d.ts

@@ -0,0 +1,20 @@
+import type { HttpRequestOptions } from './polarity-request';
+/**
+ * Sanitizes the request options by removing sensitive information
+ * from the provided request options object.
+ *
+ * Default sanitized paths are:
+ *
+ * - auth.password
+ * - auth.bearer
+ * - body.password
+ * - form.client_secret
+ * - headers.authorization
+ * - headers.x-api-key
+ *
+ * @param requestOptions - request options to sanitize
+ * @param additionalPathsToSanitize - array of additional paths to sanitize in addition to the
+ * default paths.
+ */
+export declare function sanitizeRequestOptions(requestOptions: HttpRequestOptions, additionalPathsToSanitize?: string[]): HttpRequestOptions;
+//# sourceMappingURL=sanitize-request-options.d.ts.map

package/dist/dts/lib/requests/sanitize-request-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitize-request-options.d.ts","sourceRoot":"","sources":["../../../../lib/requests/sanitize-request-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAU7D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,kBAAkB,EAClC,yBAAyB,GAAE,MAAM,EAAO,GACvC,kBAAkB,CA0BpB"}

package/dist/dts/lib/testing/enhanced-utils/create-entity.d.ts

@@ -0,0 +1,3 @@
+import { Entity, EntityType } from '../../types';
+export declare const createEntity: (type: EntityType, value: string) => Entity;
+//# sourceMappingURL=create-entity.d.ts.map

package/dist/dts/lib/testing/enhanced-utils/create-entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-entity.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/create-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEjD,eAAO,MAAM,YAAY,GAAI,MAAM,UAAU,EAAE,OAAO,MAAM,KAAG,MAmC9D,CAAC"}

package/dist/dts/lib/testing/enhanced-utils/create-mock-integration-context.d.ts

@@ -0,0 +1,3 @@
+import { IntegrationContext } from '../../context';
+export declare const createMockIntegrationContext: () => IntegrationContext;
+//# sourceMappingURL=create-mock-integration-context.d.ts.map

package/dist/dts/lib/testing/enhanced-utils/create-mock-integration-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-mock-integration-context.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/create-mock-integration-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,eAAO,MAAM,4BAA4B,QAAO,kBAgC/C,CAAC"}

package/dist/dts/lib/testing/enhanced-utils/mock-request.d.ts

@@ -0,0 +1,14 @@
+import { PolarityRequest } from '../../requests/polarity-request';
+export declare const mockRequest: () => {
+    PolarityRequestMock: jest.MockedClass<typeof PolarityRequest>;
+    mockRequest: {
+        get: jest.Mock<any, any, any>;
+        post: jest.Mock<any, any, any>;
+        put: jest.Mock<any, any, any>;
+        delete: jest.Mock<any, any, any>;
+        patch: jest.Mock<any, any, any>;
+        head: jest.Mock<any, any, any>;
+        options: jest.Mock<any, any, any>;
+    };
+};
+//# sourceMappingURL=mock-request.d.ts.map

package/dist/dts/lib/testing/enhanced-utils/mock-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-request.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/mock-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAIlE,eAAO,MAAM,WAAW;yBAcoB,IAAI,CAAC,WAAW,CAAC,OAAO,eAAe,CAAC;;;;;;;;;;CAGnF,CAAC"}

package/dist/dts/lib/testing/enhanced-utils/validate-integration.d.ts

@@ -0,0 +1,8 @@
+import { Integration, IntegrationConfig } from '../../types';
+export interface ValidationResult {
+    isValid: boolean;
+    errors: string[];
+    warnings: string[];
+}
+export declare const validateIntegration: (integration: Integration, config?: IntegrationConfig) => ValidationResult;
+//# sourceMappingURL=validate-integration.d.ts.map

package/dist/dts/lib/testing/enhanced-utils/validate-integration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-integration.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/validate-integration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAsB,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKjF,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,eAAO,MAAM,mBAAmB,GAC9B,aAAa,WAAW,EACxB,SAAS,iBAAiB,KACzB,gBAoCF,CAAC"}

package/dist/dts/lib/testing/index.d.ts

@@ -0,0 +1,6 @@
+export * from './test-factory/create-integration-tests';
+export * from './enhanced-utils/create-entity';
+export * from './enhanced-utils/create-mock-integration-context';
+export * from './enhanced-utils/mock-request';
+export * from './enhanced-utils/validate-integration';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/lib/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAC;AACxD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kDAAkD,CAAC;AACjE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,uCAAuC,CAAC"}

package/dist/dts/lib/testing/test-factory/create-integration-tests.d.ts

@@ -0,0 +1,6 @@
+import { Integration } from '../../types';
+export declare const createIntegrationTests: (integration: Integration) => {
+    testDoLookup: any;
+    testOnMessage: any;
+};
+//# sourceMappingURL=create-integration-tests.d.ts.map

package/dist/dts/lib/testing/test-factory/create-integration-tests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-integration-tests.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/test-factory/create-integration-tests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAO1C,eAAO,MAAM,sBAAsB,GAAI,aAAa,WAAW;;;CAY9D,CAAC"}

package/dist/dts/lib/testing/test-factory/test-do-lookup.d.ts

@@ -0,0 +1,7 @@
+import { DoLookupResult, DoLookupUserOptions, Entity, Integration } from '../../types';
+export declare const testDoLookup: (integration: Integration, description: string, { entities, options, expected }: {
+    entities: Entity[];
+    options: DoLookupUserOptions;
+    expected: DoLookupResult;
+}) => void;
+//# sourceMappingURL=test-do-lookup.d.ts.map

package/dist/dts/lib/testing/test-factory/test-do-lookup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-do-lookup.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/test-factory/test-do-lookup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAIvF,eAAO,MAAM,YAAY,GACvB,aAAa,WAAW,EACxB,aAAa,MAAM,EACnB,iCAIG;IACD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,QAAQ,EAAE,cAAc,CAAC;CAC1B,SAkBF,CAAC"}

package/dist/dts/lib/testing/test-factory/test-on-message.d.ts

@@ -0,0 +1,8 @@
+import { DoLookupUserOptions, Integration } from '../../types';
+export declare const testOnMessage: (integration: Integration, description: string, { command, args, expected, options }: {
+    command: string;
+    args: Record<string, unknown>;
+    expected: unknown;
+    options?: DoLookupUserOptions;
+}) => void;
+//# sourceMappingURL=test-on-message.d.ts.map

package/dist/dts/lib/testing/test-factory/test-on-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-on-message.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/test-factory/test-on-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/D,eAAO,MAAM,aAAa,GACxB,aAAa,WAAW,EACxB,aAAa,MAAM,EACnB,sCAKG;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,SAmBF,CAAC"}

package/dist/dts/lib/types.d.ts

@@ -0,0 +1,101 @@
+import { z } from 'zod';
+import { Logger as PolarityLogger } from './logging';
+import { ValidationErrorSchema, DoLookupUserOptionsSchema, ValidateOptionsUserOptionsSchema, ValidateOptionsUserOptionSchema, PossibleUserOptionValueSchema, DropdownUserOptionValueSchema, EntitySchema, EntityTypeSchema, StandardEntityTypeSchema, ChannelSchema, ResultSchema, IntegrationConfigSchema } from './zod-types';
+/**
+ * @public
+ */
+export type ValidationError = z.infer<typeof ValidationErrorSchema>;
+/**
+ * User options object passed into the integration's `doLookup` method.
+ *
+ * @example
+ * Example of the user options object passed into `doLookup`
+ * ```js
+ * function doLookup(entities, options, cb){
+ *   // options here is of type DoLookupUserOptions
+ * }
+ * ```
+ *
+ * @example
+ * As an example, if your integration has a user option with a `key` value of
+ * `apiKey` within its `config.json`, the user options object passed into the `doLookup` method would look like:
+ * ```json
+ * {
+ *   "apiKey": "XXXXXXXXXX"
+ * }
+ * ```
+ * @public
+ */
+export type DoLookupUserOptions = z.infer<typeof DoLookupUserOptionsSchema>;
+/**
+ * @public
+ */
+export type ValidateOptionsUserOptions = z.infer<typeof ValidateOptionsUserOptionsSchema>;
+/**
+ * @public
+ */
+export type ValidateOptionsUserOption = z.infer<typeof ValidateOptionsUserOptionSchema>;
+/**
+ * @public
+ */
+export type PossibleUserOptionValue = z.infer<typeof PossibleUserOptionValueSchema>;
+/**
+ * @public
+ */
+export type DropdownUserOptionValue = z.infer<typeof DropdownUserOptionValueSchema>;
+/**
+ * Represents a Polarity Entity object which is passed to an integration's
+ * doLookup method.
+ *
+ * @public
+ */
+export type Entity = z.infer<typeof EntitySchema>;
+/**
+ * @public
+ */
+export type Channel = z.infer<typeof ChannelSchema>;
+/**
+ * Entity Types including custom types
+ * @public
+ */
+export type EntityType = z.infer<typeof EntityTypeSchema>;
+/**
+ * List of supported entity type values
+ * @public
+ */
+export type StandardEntityType = z.infer<typeof StandardEntityTypeSchema>;
+/**
+ * @public
+ */
+export type Result<TDetails = unknown> = Omit<z.infer<typeof ResultSchema>, 'data'> & {
+    data: {
+        summary: string[];
+        details: TDetails;
+    };
+};
+/**
+ * @public
+ */
+export type DoLookupResult<TDetails = unknown> = Result<TDetails>[];
+/**
+ * @public
+ */
+export type IntegrationConfig = z.infer<typeof IntegrationConfigSchema>;
+/**
+ * @public
+ */
+export { PolarityLogger };
+/**
+ * @public
+ */
+import { IntegrationContext } from './context';
+import { IntegrationError } from './errors';
+export { IntegrationContext, IntegrationError };
+export interface Integration<TStartupResult = unknown, TDetails = unknown> {
+    startup: (logger: PolarityLogger) => Promise<TStartupResult>;
+    doLookup: (entities: Entity[], options: DoLookupUserOptions, context: IntegrationContext) => Promise<DoLookupResult<TDetails> | IntegrationError | null | void>;
+    onMessage?: (payload: unknown, options: DoLookupUserOptions, context: IntegrationContext) => Promise<unknown>;
+    onDetails?: (lookupObject: Result<TDetails>, options: DoLookupUserOptions, context: IntegrationContext) => Promise<unknown>;
+    validateOptions: (options: ValidateOptionsUserOptions, context: IntegrationContext) => IntegrationError[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/dts/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,EAC/B,6BAA6B,EAC7B,6BAA6B,EAC7B,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,uBAAuB,EACxB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,QAAQ,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,EAAE,MAAM,CAAC,GAAG;IACpF,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC;KACnB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,QAAQ,GAAG,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;GAEG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;AAEhD,MAAM,WAAW,WAAW,CAAC,cAAc,GAAG,OAAO,EAAE,QAAQ,GAAG,OAAO;IACvE,OAAO,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7D,QAAQ,EAAE,CACR,QAAQ,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,gBAAgB,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;IACxE,SAAS,CAAC,EAAE,CACV,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,SAAS,CAAC,EAAE,CACV,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,EAC9B,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,eAAe,EAAE,CACf,OAAO,EAAE,0BAA0B,EACnC,OAAO,EAAE,kBAAkB,KACxB,gBAAgB,EAAE,CAAC;CACzB"}