polarity-integration-utils 0.1.0 → 3.1.3

package/README.md

@@ -2,8 +2,36 @@
 
 This library is intended for use in development of Polarity Integrations.
 
+## Documentation
 
+Documentation for this library can be found at: https://polarityio.github.io/polarity-integration-utils/
 
-## Contribution Instructions
+## Building the Library
 
-> NOTE: Don't forget to add your implementations to the `./test/index.test.js` to ensure your implementation is accessible from the main index.js
+### Prerequisites
+| Tool | Version | Notes |
+| ---- | ------- | ----- |
+| Node | 18.x    | `nvm install 18 && nvm use 18` recommended |
+| npm  | 9.x     | Ships with Node 18 |
+
+### Install Dependencies
+    npm ci
+
+### Build
+    npm run build
+
+### Run Tests
+    npm test
+
+### Linting / Formatting
+    npm run lint
+    npm run lint:fix
+    npm run format
+    npm run format:check
+
+### Docs
+    npm run docs
+
+### Continuous Integration
+All pull-requests run the same **build → lint → test** pipeline in GitHub Actions.  
+Ensure local runs are green before opening a PR.

package/dist/dts/context/cache.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Cache operation options
+ */
+export interface CacheOptions {
+    /** Time-to-live in seconds. If not specified, uses default TTL */
+    ttl?: number;
+}
+/**
+ * Global cache operations - shared across all integrations and users
+ * Use for system-wide statistics, feature flags, or shared configuration
+ */
+export interface GlobalCache {
+    /**
+     * Get a value from global cache
+     * @param key - The cache key
+     * @returns Promise that resolves to the cached value or null if not found
+     * @example
+     * const totalLookups = await cache.global.get('total_lookups') || 0;
+     */
+    get(key: string): Promise<unknown>;
+    /**
+     * Set a value in global cache
+     * @param key - The cache key
+     * @param value - The value to cache (must be JSON serializable)
+     * @param options - Cache options including TTL
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.global.set('total_lookups', count + 1, \{ ttl: 86400 \});
+     */
+    set(key: string, value: unknown, options?: CacheOptions): Promise<void>;
+    /**
+     * Delete a value from global cache
+     * @param key - The cache key to delete
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.global.delete('feature_flags');
+     */
+    delete(key: string): Promise<void>;
+}
+/**
+ * Integration-scoped cache operations - shared across all users of a specific integration
+ * Use for API responses, configuration, or data that's the same for all users
+ */
+export interface IntegrationCache {
+    /**
+     * Get a value from integration cache
+     * @param key - The cache key
+     * @returns Promise that resolves to the cached value or null if not found
+     * @example
+     * const config = await cache.integration.get('api_config');
+     */
+    get(key: string): Promise<unknown>;
+    /**
+     * Set a value in integration cache
+     * @param key - The cache key
+     * @param value - The value to cache (must be JSON serializable)
+     * @param options - Cache options including TTL
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.integration.set('lookup_ip_1.1.1.1', result, \{ ttl: 300 \});
+     */
+    set(key: string, value: unknown, options?: CacheOptions): Promise<void>;
+    /**
+     * Delete a value from integration cache
+     * @param key - The cache key to delete
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.integration.delete('expired_config');
+     */
+    delete(key: string): Promise<void>;
+}
+/**
+ * User-scoped cache operations - specific to individual users
+ * Use for user preferences, recent activity, or personalized data
+ */
+export interface UserCache {
+    /**
+     * Get a value from user cache
+     * @param key - The cache key
+     * @returns Promise that resolves to the cached value or null if not found
+     * @example
+     * const preferences = await cache.user.get('preferences');
+     */
+    get(key: string): Promise<unknown>;
+    /**
+     * Set a value in user cache
+     * @param key - The cache key
+     * @param value - The value to cache (must be JSON serializable)
+     * @param options - Cache options including TTL
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.user.set('recent_lookups', lookups, \{ ttl: 3600 \});
+     */
+    set(key: string, value: unknown, options?: CacheOptions): Promise<void>;
+    /**
+     * Delete a value from user cache
+     * @param key - The cache key to delete
+     * @returns Promise that resolves when the operation completes
+     * @example
+     * await cache.user.delete('preferences');
+     */
+    delete(key: string): Promise<void>;
+}
+/**
+ * Main cache interface providing hierarchical caching with three scopes
+ *
+ * Cache Hierarchy:
+ * - Global: System-wide data shared across all integrations
+ * - Integration: Data shared among all users of a specific integration
+ * - User: User-specific data within an integration context
+ *
+ * Best Practices:
+ * - Use appropriate TTL values to prevent stale data
+ * - Handle cache misses gracefully (operations may return null)
+ * - Wrap cache operations in try/catch blocks
+ * - Use descriptive keys that won't conflict with other data
+ *
+ * @example
+ * ```javascript
+ * // In your integration functions:
+ * async function doLookup(entities, options, context) {
+ *   const cache = context?.cache;
+ *   if (!cache) return generateFreshData();
+ *
+ *   try {
+ *     // Check integration cache first
+ *     const cached = await cache.integration.get(`lookup_${entity.value}`);
+ *     if (cached) return cached;
+ *
+ *     // Generate and cache new data
+ *     const result = await apiCall(entity);
+ *     await cache.integration.set(`lookup_${entity.value}`, result, { ttl: 300 });
+ *     return result;
+ *   } catch (error) {
+ *     console.error('Cache error:', error);
+ *     return generateFreshData(); // Fallback
+ *   }
+ * }
+ * ```
+ */
+export interface PolarityCache {
+    /** Global cache operations - shared across all integrations and users */
+    global: GlobalCache;
+    /** Integration-scoped cache operations - shared across all users of a specific integration */
+    integration: IntegrationCache;
+    /** User-scoped cache operations - specific to individual users */
+    user: UserCache;
+}
+//# sourceMappingURL=cache.d.ts.map

package/dist/dts/context/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../lib/context/cache.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kEAAkE;IAClE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,MAAM,EAAE,WAAW,CAAC;IAEpB,8FAA8F;IAC9F,WAAW,EAAE,gBAAgB,CAAC;IAE9B,kEAAkE;IAClE,IAAI,EAAE,SAAS,CAAC;CACjB"}

package/dist/dts/context/index.d.ts

@@ -0,0 +1,3 @@
+export * from './cache';
+export * from './integration-context';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,uBAAuB,CAAC"}

package/dist/dts/context/integration-context.d.ts

@@ -0,0 +1,16 @@
+import { Logger } from '../logging';
+import { PolarityCache } from './cache';
+/**
+ * Integration context provided to integration functions
+ */
+export interface IntegrationContext {
+    /** Cache client for hierarchical caching operations */
+    cache: PolarityCache;
+    /** Integration identifier */
+    integrationId: string;
+    /** User identifier */
+    userId?: string;
+    /** Logger instance */
+    logger: Logger;
+}
+//# sourceMappingURL=integration-context.d.ts.map

package/dist/dts/context/integration-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-context.d.ts","sourceRoot":"","sources":["../../../lib/context/integration-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,KAAK,EAAE,aAAa,CAAC;IAErB,6BAA6B;IAC7B,aAAa,EAAE,MAAM,CAAC;IAEtB,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/dist/dts/errors/api-request-error.d.ts

@@ -0,0 +1,10 @@
+import { IntegrationError, type IntegrationErrorProperties } from './integration-error';
+/**
+ * API error for REST requests
+ *
+ * @public
+ */
+export declare class ApiRequestError extends IntegrationError {
+    constructor(message: string, properties?: IntegrationErrorProperties);
+}
+//# sourceMappingURL=api-request-error.d.ts.map

package/dist/dts/errors/api-request-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-request-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/api-request-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAExF;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;gBACvC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;CAGzE"}

package/dist/dts/errors/auth-request-error.d.ts

@@ -0,0 +1,10 @@
+import { IntegrationError, type IntegrationErrorProperties } from './integration-error';
+/**
+ * Thrown by generateAccessToken method if there is a failure to fetch a token
+ *
+ * @public
+ */
+export declare class AuthRequestError extends IntegrationError {
+    constructor(message: string, properties?: IntegrationErrorProperties);
+}
+//# sourceMappingURL=auth-request-error.d.ts.map

package/dist/dts/errors/auth-request-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-request-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/auth-request-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAExF;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;gBACxC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;CAGzE"}

package/dist/dts/errors/index.d.ts

@@ -0,0 +1,8 @@
+export * from './parse-error-to-readable-json';
+export * from './integration-error';
+export * from './api-request-error';
+export * from './auth-request-error';
+export * from './network-error';
+export * from './retry-request-error';
+export * from './library-usage-error';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/dist/dts/errors/integration-error.d.ts

@@ -0,0 +1,189 @@
+import type { HttpRequestOptions } from '../requests/polarity-request';
+/**
+ * @public
+ */
+export interface Error {
+    name: string;
+    message: string;
+    stack?: string;
+    code?: number | string;
+}
+/**
+ * @public
+ */
+export type ErrorMeta = {
+    [otherMetadata: string]: unknown;
+};
+/**
+ * @public
+ */
+export type MetaObject = {
+    [key: string]: unknown;
+};
+/**
+ * @public
+ */
+export interface IntegrationErrorProperties {
+    /**
+     *  a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of
+     *  the problem except for purposes of localization.  If omitted, the title will default to the type
+     *  of error (e.g., IntegrationError, or ApiRequestError)
+     */
+    title?: string;
+    /**
+     * Additional details related to the error that may help the user troubleshoot the issue.  If set by the user
+     * via the Error constructor, the user provided value will override any automated help message set by the
+     * Error class.
+     */
+    help?: string;
+    /**
+     * The `cause` property is used to specify the `cause` of the error.  Typically,
+     * this property is used to pass through a related Error instance.
+     */
+    cause?: Error;
+    /**
+     * The HTTP status code applicable to this error, expressed as a string value.
+     */
+    status?: string;
+    /**
+     *  an application-specific error code, expressed as a string value.
+     */
+    code?: string;
+    /**
+     * Relevant for integration errors involving a network call, the `requestOptions` property
+     * details the request options that resulted in the specified error.  The `requestOptions` property will automatically
+     * have sensitive authentication headers stripped.
+     * By default, the following paths are sanitized:
+     *
+     * - auth.password
+     * - auth.bearer
+     * - body.password
+     * - form.client_secret
+     * - headers.authorization
+     * - headers.x-api-key
+     *
+     * Additional paths can be sanitized by using the `requestOptionsToSanitize` property.
+     */
+    requestOptions?: HttpRequestOptions;
+    /**
+     * List of paths in JSON dot notation to sanitize in the requestOptions object
+     */
+    requestOptionsToSanitize?: string[];
+    /**
+     * Any additional properties which will be appended to the Error's meta property
+     */
+    meta?: MetaObject;
+}
+/**
+ * @public
+ */
+export interface SerializedIntegrationError {
+    /**
+     *  a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of
+     *  the problem except for purposes of localization.  If omitted, the title will default to the type
+     *  of error (e.g., IntegrationError, or ApiRequestError)
+     */
+    title: string;
+    /**
+     * The name data property of IntegrationError.prototype is shared by all Error instances.
+     * It represents the name for the type of error. For IntegrationError.prototype.name,
+     * the initial value is "IntegrationError".
+     */
+    name: string;
+    /**
+     * a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be
+     * localized
+     */
+    detail: string;
+    /**
+     * An optional HTTP status code applicable to this error, expressed as a string value.
+     */
+    status?: string;
+    /**
+     * Additional details related to the error that may help the user troubleshoot the issue.  If set by the user
+     * via the Error constructor, the user provided value will override any automated help message set by the
+     * Error class.
+     */
+    help?: string;
+    /**
+     * An optional StackTrace of the error
+     */
+    stack?: string;
+    /**
+     *  An optional application-specific error code, expressed as a string value.
+     */
+    code?: number | string;
+    /**
+     * The `cause` property is used to specify the `cause` of the error.  Typically,
+     * this property is used to pass through a related Error instance.
+     */
+    cause?: Error;
+    /**
+     * Relevant for integration errors involving a network call, the `requestOptions` property
+     * details the request options that resulted in the specified error.  The `requestOptions` property will automatically
+     * have sensitive authentication headers stripped.
+     */
+    requestOptions?: HttpRequestOptions;
+    /**
+     * an optional  meta object containing non-standard meta-information about the error.
+     */
+    meta?: ErrorMeta;
+}
+/**
+ * @public
+ */
+export declare class IntegrationError extends Error {
+    /**
+     *  a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of
+     *  the problem except for purposes of localization.
+     */
+    readonly title: string;
+    /**
+     * a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be
+     * localized
+     */
+    readonly detail: string;
+    /**
+     * a meta object containing non-standard meta-information about the error.
+     */
+    readonly meta: ErrorMeta;
+    /**
+     * The HTTP status code applicable to this error, expressed as a string value.
+     */
+    readonly status: string;
+    /**
+     *  an application-specific error code, expressed as a string value.
+     */
+    readonly code: string;
+    /**
+     * The `cause` property is used to specify the `cause` of the error.  Typically,
+     * this property is used to pass through a related Error instance.
+     */
+    readonly cause: Error;
+    /**
+     * Additional details related to the error that may help the user troubleshoot the issue.  If set by the user
+     * via the Error constructor, the user provided value will override any automated help message set by the
+     * Error class.
+     */
+    readonly help: string;
+    /**
+     * Relevant for integration errors involving a network call, the `requestOptions` property
+     * details the request options that resulted in the specified error.  The `requestOptions` property will automatically
+     * have sensitive authentication headers stripped.
+     */
+    readonly requestOptions?: HttpRequestOptions;
+    /**
+     * Construct a new IntegrationError object.
+     * @param message - A string description of the error which is used as the `detail` property on the
+     * serialized error.
+     * @param properties - Optional properties for the error.
+     */
+    constructor(message: string, properties?: IntegrationErrorProperties);
+    /**
+     * Serializes the error's properties into a POJO.  The order of the
+     * properties is preserved when serialized.
+     * @returns JSON representation of the error
+     */
+    toJSON(): SerializedIntegrationError;
+}
+//# sourceMappingURL=integration-error.d.ts.map

package/dist/dts/errors/integration-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/integration-error.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGvE;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IAEvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;;OAIG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAE7C;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;IAqCxE;;;;OAIG;IACH,MAAM;CAqCP"}

package/dist/dts/errors/library-usage-error.d.ts

@@ -0,0 +1,12 @@
+import { IntegrationError, type IntegrationErrorProperties } from './integration-error';
+/**
+ * Thrown when the polarity-integration-utils library is used incorrectly.  For example,
+ * if a method is called with incorrect or missing parameters, or a required initialization
+ * method is not called.  This Error class should not be used directly by integrations.
+ *
+ * @public
+ */
+export declare class LibraryUsageError extends IntegrationError {
+    constructor(message: string, properties?: IntegrationErrorProperties);
+}
+//# sourceMappingURL=library-usage-error.d.ts.map

package/dist/dts/errors/library-usage-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"library-usage-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/library-usage-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAExF;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;gBACzC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;CAGzE"}

package/dist/dts/errors/network-error.d.ts

@@ -0,0 +1,11 @@
+import { IntegrationError, type IntegrationErrorProperties } from './integration-error';
+/**
+ * Generic network error for REST requests.
+ * https://betterstack.com/community/guides/scaling-nodejs/nodejs-errors/#4-econnrefused
+ *
+ * @public
+ */
+export declare class NetworkError extends IntegrationError {
+    constructor(message: string, properties?: IntegrationErrorProperties);
+}
+//# sourceMappingURL=network-error.d.ts.map

package/dist/dts/errors/network-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/network-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AA+CxF;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;gBACpC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;CAgCzE"}

package/dist/dts/errors/parse-error-to-readable-json.d.ts

@@ -0,0 +1,7 @@
+import type { Error } from './integration-error';
+/**
+ * @public
+ * @param error - Error instance to parse into a plain old javascript object
+ */
+export declare const parseErrorToReadableJson: (error: Error) => any;
+//# sourceMappingURL=parse-error-to-readable-json.d.ts.map

package/dist/dts/errors/parse-error-to-readable-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-error-to-readable-json.d.ts","sourceRoot":"","sources":["../../../lib/errors/parse-error-to-readable-json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,KAAK,QACiB,CAAC"}

package/dist/dts/errors/retry-request-error.d.ts

@@ -0,0 +1,11 @@
+import { IntegrationError, type IntegrationErrorProperties } from './integration-error';
+/**
+ * Thrown by authenticated request method for any HTTP status codes where we want to allow
+ * the user to retry their lookup.
+ *
+ * @public
+ */
+export declare class RetryRequestError extends IntegrationError {
+    constructor(message: string, properties?: IntegrationErrorProperties);
+}
+//# sourceMappingURL=retry-request-error.d.ts.map

package/dist/dts/errors/retry-request-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-request-error.d.ts","sourceRoot":"","sources":["../../../lib/errors/retry-request-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAExF;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;gBACzC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;CAGzE"}

package/dist/dts/index.d.ts

@@ -0,0 +1,8 @@
+import * as errors from './errors';
+import * as requests from './requests';
+import * as logging from './logging';
+import * as context from './context';
+import * as types from './types';
+export * from './types';
+export { errors, requests, logging, context, types };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,cAAc,SAAS,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/dts/index.docs.d.ts

@@ -0,0 +1,10 @@
+/**
+ * API Docs index. This is used by api-extractor given our package.json exports.
+ * Monitoring: https://github.com/microsoft/rushstack/issues/3557
+ */
+export * from './errors';
+export * from './requests';
+export * from './logging';
+export * from './types';
+export * from './context';
+//# sourceMappingURL=index.docs.d.ts.map

package/dist/dts/index.docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.docs.d.ts","sourceRoot":"","sources":["../../lib/index.docs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}

package/dist/dts/internal/helpers/parallel-limit.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Execute an array of async tasks while ensuring that no more than `limit`
+ * tasks are running at the same time.  Results preserve task order.
+ *
+ * @param tasks - Array of thunked async tasks (`() => Promise<T>`).
+ * @param limit - Maximum number of concurrent tasks (positive integer).
+ */
+export declare function parallelLimit<T>(tasks: Array<() => Promise<T>>, limit: number): Promise<T[]>;
+//# sourceMappingURL=parallel-limit.d.ts.map

package/dist/dts/internal/helpers/parallel-limit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parallel-limit.d.ts","sourceRoot":"","sources":["../../../../lib/internal/helpers/parallel-limit.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,KAAK,EAAE,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,EAC9B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,CAAC,EAAE,CAAC,CAgCd"}

package/dist/dts/internal/helpers/sanitize-object.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sanitizes the specified paths in an object by setting their values to a mask.
+ * This function returns a **new** object (deep clone) and does **not** mutate the original.
+ *
+ * @param obj - An object to sanitize (or nullish, which is returned directly).
+ * @param paths - An array of dot/bracket-notation paths to mask.
+ * @param mask - A replacement string. Defaults to "******".
+ * @returns A new object that has specified paths overwritten by `mask`.
+ */
+export declare function sanitizeObject<T extends object>(obj: T | null | undefined, paths?: string[], mask?: string): T | null | undefined;
+//# sourceMappingURL=sanitize-object.d.ts.map

package/dist/dts/internal/helpers/sanitize-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sanitize-object.d.ts","sourceRoot":"","sources":["../../../../lib/internal/helpers/sanitize-object.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAC7C,GAAG,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EACzB,KAAK,GAAE,MAAM,EAAO,EACpB,IAAI,GAAE,MAAiB,GACtB,CAAC,GAAG,IAAI,GAAG,SAAS,CAsBtB"}