polarity-integration-utils 4.1.1 → 4.2.0

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

@@ -1,436 +0,0 @@
-import { ApiRequestError, NetworkError, RetryRequestError } from '../errors';
-import type { Entity, DoLookupUserOptions } from '@polarityio/integration-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;
-/**
- * Minimal interface for a rate limiter compatible with PolarityRequest.
- * The Polarity server provides a Bottleneck instance that satisfies this interface.
- *
- * @public
- */
-export interface Limiter {
-    schedule<T>(fn: (...args: unknown[]) => PromiseLike<T>, ...args: unknown[]): Promise<T>;
-}
-/**
- * Hook that runs before an HTTP request is made. Each hook receives the output
- * of the previous hook, allowing request options to be modified in a chain.
- *
- * Typically used for adding authentication headers or conditionally modifying
- * request options based on user options.
- *
- * @public
- */
-export type BeforeRequestHook = (requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<HttpRequestOptions>;
-/**
- * Hook that runs after a successful HTTP response. Each hook receives the output
- * of the previous hook, allowing the response to be modified in a chain.
- *
- * Typically used to extract specific fields from the response body or to
- * transform the response into a more useful shape.
- *
- * @public
- */
-export type AfterResponseHook = (response: HttpRequestResponse, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<HttpRequestResponse>;
-/**
- * Hook that runs when an API error is detected (non-success status code or error
- * properties found in the response body). Receives the full HTTP response so the
- * hook can inspect status codes, headers, and body.
- *
- * If all registered hooks return without throwing, the error is suppressed and
- * the HTTP response is returned to the caller. To propagate or replace the error,
- * throw from within the hook.
- *
- * @public
- */
-export type OnApiErrorHook = (error: ApiRequestError, response: HttpRequestResponse, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<void>;
-/**
- * Hook that runs when a network error or rate-limiting error occurs during a request.
- *
- * If all registered hooks return without throwing, the error is suppressed.
- * To propagate or replace the error, throw from within the hook.
- *
- * @public
- */
-export type OnNetworkErrorHook = (error: NetworkError | RetryRequestError, requestOptions: HttpRequestOptions, userOptions: DoLookupUserOptions) => Promise<void>;
-/**
- * Hooks for customizing the {@link PolarityRequest} lifecycle. All hook arrays
- * execute in order. `beforeRequest` and `afterResponse` hooks chain their output,
- * while error hooks run sequentially and can suppress errors by returning without
- * throwing.
- *
- * @public
- */
-export interface PolarityRequestHooks {
-    /**
-     * Hooks that run before each HTTP request. Each hook receives a copy of the request
-     * options and the return value is passed to the next hook (or used for the request).
-     */
-    beforeRequest?: BeforeRequestHook[];
-    /**
-     * Hooks that run after a successful HTTP response. Each hook receives the response
-     * from the previous hook and the return value is passed to the next hook (or returned
-     * to the caller).
-     */
-    afterResponse?: AfterResponseHook[];
-    /**
-     * Hooks that run when an API error is detected. Each hook receives the error and the
-     * full HTTP response. If all hooks return without throwing, the error is suppressed.
-     */
-    onApiError?: OnApiErrorHook[];
-    /**
-     * Hooks that run when a network or rate-limiting error occurs. If all hooks return
-     * without throwing, the error is suppressed.
-     */
-    onNetworkError?: OnNetworkErrorHook[];
-}
-/**
- * @public
- */
-export interface PolarityRequestOptions {
-    defaults?: ConfigRequestProxyOptions;
-    isApiError?: IsApiErrorFunction;
-    roundedSuccessStatusCodes?: number[];
-    httpResponseErrorProperties?: string[];
-    httpResponseErrorMessageProperties?: string[];
-    requestOptionsToSanitize?: string[];
-    hooks?: PolarityRequestHooks;
-    limiter?: Limiter;
-}
-/**
- * A utility class for making HTTP requests
- * @public
- */
-export declare class PolarityRequest {
-    /**
-     * Instance of a Bunyan logger
-     */
-    private logger;
-    /**
-     * 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;
-    /**
-     * An optional rate limiter instance used to throttle HTTP requests.
-     * When set, all requests made via {@link PolarityRequest.run} are scheduled
-     * through this limiter. Typically provided by the Polarity server via the
-     * integration context.
-     */
-    limiter: Limiter | null;
-    /**
-     * Lifecycle hooks for customizing request behavior. Hooks are configured via the
-     * {@link PolarityRequestOptions.hooks} property when creating a new instance of the
-     * {@link PolarityRequest} class.
-     *
-     * @see {@link PolarityRequestHooks} for hook type details.
-     */
-    readonly hooks: Required<PolarityRequestHooks>;
-    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 | undefined> | never;
-    /**
-     * Checks whether the HTTP response is an API error and returns an ApiRequestError if it is.
-     *
-     * @param httpResponse - The HTTP response from the Postman request.
-     * @param requestOptions - The options used for the request.
-     * @returns An ApiRequestError if the response indicates an API error, undefined otherwise.
-     *
-     * @throws {@link LibraryUsageError}
-     * Throws if the `isApiError` function returns an invalid result.
-     */
-    private detectApiError;
-    /**
-     * 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 in the same order as the input
-     * request options. If the `returnErrors` property is set to `true`, the response objects will
-     * have their `error` property set to the thrown error. If `onNetworkError` hooks are configured
-     * and suppress an error (return without throwing), the corresponding entry will be `undefined`.
-     */
-    runInParallel(options: RunInParallelOptions): Promise<(HttpRequestResponse | undefined)[]>;
-}
-//# sourceMappingURL=polarity-request.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"polarity-request.d.ts","sourceRoot":"","sources":["../../../../lib/requests/polarity-request.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,eAAe,EACf,YAAY,EACZ,iBAAiB,EAElB,MAAM,WAAW,CAAC;AAGnB,OAAO,KAAK,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAGjF;;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;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACzF;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEjC;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,QAAQ,EAAE,mBAAmB,EAC7B,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,CAC3B,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,mBAAmB,EAC7B,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC/B,KAAK,EAAE,YAAY,GAAG,iBAAiB,EACvC,cAAc,EAAE,kBAAkB,EAClC,WAAW,EAAE,mBAAmB,KAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACpC;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAC9B;;;OAGG;IACH,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACvC;AAED;;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,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC;IACf;;;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;;;;;OAKG;IACI,OAAO,EAAE,OAAO,GAAG,IAAI,CAAQ;IAEtC;;;;;;OAMG;IACH,SAAgB,KAAK,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAKnD;gBAEU,OAAO,GAAE,sBAA2B;IAmEhD,OAAO,CAAC,kBAAkB,CACsB;IAEhD;;;;;OAKG;IACU,GAAG,CACd,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,GAAG,KAAK;IAkGnD;;;;;;;;;OASG;IACH,OAAO,CAAC,cAAc;IAoEtB;;;;;;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,aAAa,CACxB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,CAAC,mBAAmB,GAAG,SAAS,CAAC,EAAE,CAAC;CA8ChD"}

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

@@ -1,20 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,19 +0,0 @@
-import type { Entity, EntityType } from '@polarityio/integration-types';
-/**
- * Creates a mock `Entity` for use in tests.
- *
- * Automatically detects whether the value is a domain or IPv4 address and sets
- * the corresponding boolean flags. All other flags default to `false`.
- *
- * @param type - An `EntityType` string (e.g., `'IPv4'`, `'domain'`, `'MD5'`)
- * @param value - The entity value string
- * @returns A fully populated `Entity` object
- *
- * @example
- * ```typescript
- * const ip = createEntity('IPv4', '8.8.8.8');
- * const domain = createEntity('domain', 'example.com');
- * ```
- */
-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

@@ -1 +0,0 @@
-{"version":3,"file":"create-entity.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/create-entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAwB,MAAM,+BAA+B,CAAC;AAQ9F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,UAAU,EAAE,OAAO,MAAM,KAAG,MAsC9D,CAAC"}

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

@@ -1,43 +0,0 @@
-import type { IntegrationContext } from '@polarityio/integration-types';
-/**
- * Factory function that creates mock functions. Pass `vi.fn` (Vitest)
- * or `jest.fn` (Jest) to get spy capabilities. When omitted, plain
- * no-op functions are used.
- *
- * @example
- * ```typescript
- * // Vitest — enables toHaveBeenCalledWith() assertions
- * const ctx = createMockIntegrationContext(vi.fn);
- *
- * // Jest
- * const ctx = createMockIntegrationContext(jest.fn);
- *
- * // No framework — plain no-ops
- * const ctx = createMockIntegrationContext();
- * ```
- */
-export type MockFnFactory = () => (...args: any[]) => any;
-/**
- * Creates a mock `IntegrationContext`
- * with stubbed logger, cache, and polling methods.
- *
- * Pass your testing framework's mock function factory to enable spy capabilities
- * (e.g., `toHaveBeenCalledWith()`). When omitted, plain no-op stubs are used.
- *
- * @param createMockFn - A factory that creates mock functions (e.g., `vi.fn` or `jest.fn`)
- * @returns A fully populated `IntegrationContext` with stubbed methods
- *
- * @example
- * ```typescript
- * // Vitest
- * const ctx = createMockIntegrationContext(vi.fn);
- *
- * // Jest
- * const ctx = createMockIntegrationContext(jest.fn);
- *
- * // No framework — plain no-ops
- * const ctx = createMockIntegrationContext();
- * ```
- */
-export declare const createMockIntegrationContext: (createMockFn?: MockFnFactory) => IntegrationContext;
-//# sourceMappingURL=create-mock-integration-context.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"create-mock-integration-context.d.ts","sourceRoot":"","sources":["../../../../../lib/testing/enhanced-utils/create-mock-integration-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAExE;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAI1D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,4BAA4B,GACvC,eAAc,aAAoB,KACjC,kBAqCF,CAAC"}

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

@@ -1,3 +0,0 @@
-export * from './enhanced-utils/create-entity';
-export * from './enhanced-utils/create-mock-integration-context';
-//# sourceMappingURL=index.d.ts.map

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

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

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

@@ -1,105 +0,0 @@
-/**
- * Integration config.json type
- * @public
- */
-export interface IntegrationConfig {
-    polarityIntegrationUuid: string;
-    name: string;
-    acronym: string;
-    description?: string;
-    defaultColor?: string;
-    entityTypes?: string[];
-    dataTypes?: (string | CustomType)[];
-    customTypes?: CustomType[];
-    supportsAdditionalCustomTypes?: boolean;
-    styles?: string[];
-    block: ViewComponent;
-    summary?: ViewComponent;
-    onDemandOnly?: boolean;
-    copyOnDemand?: boolean;
-    logging?: {
-        level: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-    };
-    request?: {
-        cert?: string;
-        key?: string;
-        passphrase?: string;
-        ca?: string;
-        proxy?: string;
-        rejectUnauthorized?: boolean;
-    };
-    options?: IntegrationOption[];
-}
-/**
- * Custom entity type definition for config.json
- * @public
- */
-export interface CustomType {
-    type?: 'custom';
-    name?: string;
-    description?: string;
-    key: string;
-    regex: string;
-    editable?: boolean;
-    enabled?: boolean;
-}
-/**
- * View component reference in config.json
- * @public
- */
-export interface ViewComponent {
-    component: {
-        file: string;
-    };
-    template: {
-        file: string;
-    };
-}
-/**
- * A select option item with display label and value
- * @public
- */
-export interface SelectOptionItem {
-    value: string;
-    display: string;
-}
-/**
- * Integration option definition for config.json
- * @public
- */
-export type IntegrationOption = {
-    type: 'text' | 'password';
-    key: string;
-    name: string;
-    description?: string;
-    default: string | null;
-    userCanEdit?: boolean;
-    adminOnly?: boolean;
-} | {
-    type: 'boolean';
-    key: string;
-    name: string;
-    description?: string;
-    default: boolean | null;
-    userCanEdit?: boolean;
-    adminOnly?: boolean;
-} | {
-    type: 'number';
-    key: string;
-    name: string;
-    description?: string;
-    default: number | null;
-    userCanEdit?: boolean;
-    adminOnly?: boolean;
-} | {
-    type: 'select';
-    key: string;
-    name: string;
-    description?: string;
-    default: SelectOptionItem | SelectOptionItem[] | string | null;
-    options: SelectOptionItem[];
-    multiple?: boolean;
-    userCanEdit: boolean;
-    adminOnly: boolean;
-};
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../lib/types.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,uBAAuB,EAAE,MAAM,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC;IACpC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE;QACR,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;KAChE,CAAC;IACF,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB;IACE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/D,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC"}