polarity-integration-utils 4.1.0 → 4.2.0

package/dist/dts/cache/create-cache-key.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Creates a cache-safe key by hashing the input values with SHA-256 and
+ * prepending a descriptive prefix.
+ *
+ * Use this to derive cache keys from dynamic or sensitive data (entity values,
+ * credentials, etc.) that may contain characters outside the allowed set.
+ *
+ * @param prefix - A short descriptive label using only letters, digits, dots,
+ *   underscores, and hyphens (must match `/^[a-zA-Z0-9._-]+$/`).
+ * @param value - First value to hash (required).
+ * @param values - Additional values to hash (e.g., further credentials or identifiers).
+ * @returns A key in the form `prefix_<64-char hex hash>`.
+ *
+ * @throws {@link LibraryUsageError}
+ * If `prefix` or `value` is not a string, if `prefix` is empty or contains
+ * invalid characters, if any additional value is not a string, or if the
+ * resulting key would exceed 250 characters.
+ *
+ * @group Utilities
+ * @public
+ */
+export declare function createCacheKey(prefix: string, value: string, ...values: string[]): string;
+//# sourceMappingURL=create-cache-key.d.ts.map

package/dist/dts/cache/create-cache-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-cache-key.d.ts","sourceRoot":"","sources":["../../../lib/cache/create-cache-key.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAqCzF"}

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

@@ -0,0 +1,2 @@
+export { createCacheKey } from './create-cache-key';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/cache/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC"}

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

@@ -1,5 +1,6 @@
 import type { HttpRequestOptions } from '../requests/polarity-request';
 /**
+ * @deprecated Do not use in v2 integrations.
  * @public
  */
 export interface ResponseError {

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

@@ -1 +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,aAAa;IAC5B,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,OAAO,CAAC;IAChB;;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,OAAO,CAAC;IAChB;;;;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,CAAC,EAAE,SAAS,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAE7C;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;IAqCxE;;;;OAIG;IACH,MAAM;CAwCP"}
+{"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;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,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,OAAO,CAAC;IAChB;;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,OAAO,CAAC;IAChB;;;;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,CAAC,EAAE,SAAS,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAE7C;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,0BAA+B;IAqCxE;;;;OAIG;IACH,MAAM;CAwCP"}

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

@@ -1,5 +1,7 @@
 import type { ResponseError } from './integration-error';
 /**
+ * @deprecated Do not use in v2 integrations.
+ * @group Utilities
  * @public
  * @param error - Error instance to parse into a plain old javascript object
  */

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

@@ -1 +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,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,aAAa,QACS,CAAC"}
+{"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,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,aAAa,QACS,CAAC"}

package/dist/dts/index.d.ts

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

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

@@ -1 +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;AAErC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC"}
+{"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,KAAK,MAAM,SAAS,CAAC;AAEjC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC"}

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

@@ -11,4 +11,5 @@ export * from './requests';
 export * from './logging';
 export * from './types';
 export * from './testing';
+export * from './cache';
 //# sourceMappingURL=index.docs.d.ts.map

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

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

package/dist/dts/logging/logger.d.ts

@@ -14,6 +14,7 @@ import type { Logger } from '@polarityio/integration-types';
  *
  * You can now use {@link getLogger} to get the logger object anywhere within your integration codebase.
  *
+ * @group Logging
  * @public
  * @param logger - the integration logger object passed into the `startup` method
  */
@@ -30,6 +31,7 @@ declare const setLogger: (logger: Logger) => void;
  * logger.trace('this is a trace message');
  * ```
  *
+ * @group Logging
  * @public
  * @returns the integration's logger object
  */

package/dist/dts/logging/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../lib/logging/logger.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AA2B5D;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,SAAS,GAAI,QAAQ,MAAM,SAEhC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,SAAS,cAAgB,CAAC;AAEhC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../lib/logging/logger.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AA2B5D;;;;;;;;;;;;;;;;;;GAkBG;AACH,QAAA,MAAM,SAAS,GAAI,QAAQ,MAAM,SAEhC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,SAAS,cAAgB,CAAC;AAEhC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC"}

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

@@ -281,6 +281,7 @@ export interface PolarityRequestOptions {
 }
 /**
  * A utility class for making HTTP requests
+ * @group Requests
  * @public
  */
 export declare class PolarityRequest {

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

@@ -1 +1 @@
-{"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"}
+{"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;;;;GAIG;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/requests/sanitize-request-options.d.ts

@@ -15,6 +15,8 @@ import type { HttpRequestOptions } from './polarity-request';
  * @param requestOptions - request options to sanitize
  * @param additionalPathsToSanitize - array of additional paths to sanitize in addition to the
  * default paths.
+ * @group Requests
+ * @public
  */
 export declare function sanitizeRequestOptions(requestOptions: HttpRequestOptions, additionalPathsToSanitize?: string[]): HttpRequestOptions;
 //# sourceMappingURL=sanitize-request-options.d.ts.map

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,sBAAsB,CACpC,cAAc,EAAE,kBAAkB,EAClC,yBAAyB,GAAE,MAAM,EAAO,GACvC,kBAAkB,CA0BpB"}

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

@@ -14,6 +14,9 @@ import type { Entity, EntityType } from '@polarityio/integration-types';
  * const ip = createEntity('IPv4', '8.8.8.8');
  * const domain = createEntity('domain', 'example.com');
  * ```
+ *
+ * @group Testing
+ * @public
  */
 export declare const createEntity: (type: EntityType, value: string) => Entity;
 //# sourceMappingURL=create-entity.d.ts.map

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

@@ -1 +1 @@
-{"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"}
+{"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;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,UAAU,EAAE,OAAO,MAAM,KAAG,MAsC9D,CAAC"}

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

@@ -15,6 +15,7 @@ import type { IntegrationContext } from '@polarityio/integration-types';
  * // No framework — plain no-ops
  * const ctx = createMockIntegrationContext();
  * ```
+ * @public
  */
 export type MockFnFactory = () => (...args: any[]) => any;
 /**
@@ -27,6 +28,9 @@ export type MockFnFactory = () => (...args: any[]) => any;
  * @param createMockFn - A factory that creates mock functions (e.g., `vi.fn` or `jest.fn`)
  * @returns A fully populated `IntegrationContext` with stubbed methods
  *
+ * @group Testing
+ * @public
+ *
  * @example
  * ```typescript
  * // Vitest

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

@@ -1 +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,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"}
+{"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;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAI1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,4BAA4B,GACvC,eAAc,aAAoB,KACjC,kBAqCF,CAAC"}

package/dist/es/cache/create-cache-key.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCacheKey = createCacheKey;
+const crypto_1 = __importDefault(require("crypto"));
+const errors_1 = require("../errors");
+const VALID_PREFIX = /^[a-zA-Z0-9._-]+$/;
+const MAX_KEY_LENGTH = 250;
+/**
+ * Creates a cache-safe key by hashing the input values with SHA-256 and
+ * prepending a descriptive prefix.
+ *
+ * Use this to derive cache keys from dynamic or sensitive data (entity values,
+ * credentials, etc.) that may contain characters outside the allowed set.
+ *
+ * @param prefix - A short descriptive label using only letters, digits, dots,
+ *   underscores, and hyphens (must match `/^[a-zA-Z0-9._-]+$/`).
+ * @param value - First value to hash (required).
+ * @param values - Additional values to hash (e.g., further credentials or identifiers).
+ * @returns A key in the form `prefix_<64-char hex hash>`.
+ *
+ * @throws {@link LibraryUsageError}
+ * If `prefix` or `value` is not a string, if `prefix` is empty or contains
+ * invalid characters, if any additional value is not a string, or if the
+ * resulting key would exceed 250 characters.
+ *
+ * @group Utilities
+ * @public
+ */
+function createCacheKey(prefix, value, ...values) {
+    if (typeof prefix !== 'string' || !prefix || !VALID_PREFIX.test(prefix)) {
+        const received = typeof prefix !== 'string' ? `type ${typeof prefix}` : `"${prefix}"`;
+        throw new errors_1.LibraryUsageError(`Invalid cache key prefix: ${received}. ` +
+            'Prefix must be a non-empty string containing only letters, digits, dots, underscores, and hyphens ' +
+            '(must match /^[a-zA-Z0-9._-]+$/).');
+    }
+    if (typeof value !== 'string') {
+        throw new errors_1.LibraryUsageError(`Invalid cache key value: expected a string but received ${typeof value}.`);
+    }
+    for (let i = 0; i < values.length; i++) {
+        if (typeof values[i] !== 'string') {
+            throw new errors_1.LibraryUsageError(`Invalid cache key value at index ${i + 1}: expected a string but received ${typeof values[i]}.`);
+        }
+    }
+    const hash = crypto_1.default.createHash('sha256').update(JSON.stringify([value, ...values])).digest('hex');
+    const key = `${prefix}_${hash}`;
+    if (key.length > MAX_KEY_LENGTH) {
+        throw new errors_1.LibraryUsageError(`Cache key prefix "${prefix}" is too long. ` +
+            `The generated key is ${key.length} characters but the maximum is ${MAX_KEY_LENGTH}. ` +
+            `Prefix must be at most ${MAX_KEY_LENGTH - 1 - 64} characters ` +
+            '(250 minus 1 underscore minus 64-character SHA-256 hex digest).');
+    }
+    return key;
+}

package/dist/es/cache/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCacheKey = void 0;
+var create_cache_key_1 = require("./create-cache-key");
+Object.defineProperty(exports, "createCacheKey", { enumerable: true, get: function () { return create_cache_key_1.createCacheKey; } });

package/dist/es/{lib/errors → errors}/parse-error-to-readable-json.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseErrorToReadableJson = void 0;
 /**
+ * @deprecated Do not use in v2 integrations.
+ * @group Utilities
  * @public
  * @param error - Error instance to parse into a plain old javascript object
  */

package/dist/es/{lib/index.docs.js → index.docs.js}

@@ -27,3 +27,4 @@ __exportStar(require("./requests"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./testing"), exports);
+__exportStar(require("./cache"), exports);

package/dist/es/{lib/index.js → index.js}

@@ -36,14 +36,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logging = exports.requests = exports.errors = void 0;
+exports.cache = exports.logging = exports.requests = exports.errors = void 0;
 const errors = __importStar(require("./errors"));
 exports.errors = errors;
 const requests = __importStar(require("./requests"));
 exports.requests = requests;
 const logging = __importStar(require("./logging"));
 exports.logging = logging;
+const cache = __importStar(require("./cache"));
+exports.cache = cache;
 __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./requests"), exports);
 __exportStar(require("./logging"), exports);
+__exportStar(require("./cache"), exports);

package/dist/es/{lib/logging → logging}/logger.js

@@ -38,6 +38,7 @@ let _logger = createDefaultLogger();
  *
  * You can now use {@link getLogger} to get the logger object anywhere within your integration codebase.
  *
+ * @group Logging
  * @public
  * @param logger - the integration logger object passed into the `startup` method
  */
@@ -57,6 +58,7 @@ exports.setLogger = setLogger;
  * logger.trace('this is a trace message');
  * ```
  *
+ * @group Logging
  * @public
  * @returns the integration's logger object
  */

package/dist/es/{lib/requests → requests}/polarity-request.js

@@ -15,6 +15,7 @@ const logging_1 = require("../logging");
 const sanitize_request_options_1 = require("./sanitize-request-options");
 /**
  * A utility class for making HTTP requests
+ * @group Requests
  * @public
  */
 class PolarityRequest {

package/dist/es/{lib/requests → requests}/sanitize-request-options.js

@@ -24,6 +24,8 @@ const DEFAULT_PATHS_TO_SANITIZE = [
  * @param requestOptions - request options to sanitize
  * @param additionalPathsToSanitize - array of additional paths to sanitize in addition to the
  * default paths.
+ * @group Requests
+ * @public
  */
 function sanitizeRequestOptions(requestOptions, additionalPathsToSanitize = []) {
     const pathsToSanitize = [

package/dist/es/{lib/testing → testing}/enhanced-utils/create-entity.js

@@ -23,6 +23,9 @@ function toEntityTypeIdentifier(type) {
  * const ip = createEntity('IPv4', '8.8.8.8');
  * const domain = createEntity('domain', 'example.com');
  * ```
+ *
+ * @group Testing
+ * @public
  */
 const createEntity = (type, value) => {
     const isDomain = /^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9](?:\.[a-zA-Z]{2,})+$/.test(value);

package/dist/es/{lib/testing → testing}/enhanced-utils/create-mock-integration-context.js

@@ -12,6 +12,9 @@ const noOp = () => () => undefined;
  * @param createMockFn - A factory that creates mock functions (e.g., `vi.fn` or `jest.fn`)
  * @returns A fully populated `IntegrationContext` with stubbed methods
  *
+ * @group Testing
+ * @public
+ *
  * @example
  * ```typescript
  * // Vitest

package/dist/lib/cache/create-cache-key.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCacheKey = createCacheKey;
+const crypto_1 = __importDefault(require("crypto"));
+const errors_1 = require("../errors");
+const VALID_PREFIX = /^[a-zA-Z0-9._-]+$/;
+const MAX_KEY_LENGTH = 250;
+/**
+ * Creates a cache-safe key by hashing the input values with SHA-256 and
+ * prepending a descriptive prefix.
+ *
+ * Use this to derive cache keys from dynamic or sensitive data (entity values,
+ * credentials, etc.) that may contain characters outside the allowed set.
+ *
+ * @param prefix - A short descriptive label using only letters, digits, dots,
+ *   underscores, and hyphens (must match `/^[a-zA-Z0-9._-]+$/`).
+ * @param value - First value to hash (required).
+ * @param values - Additional values to hash (e.g., further credentials or identifiers).
+ * @returns A key in the form `prefix_<64-char hex hash>`.
+ *
+ * @throws {@link LibraryUsageError}
+ * If `prefix` or `value` is not a string, if `prefix` is empty or contains
+ * invalid characters, if any additional value is not a string, or if the
+ * resulting key would exceed 250 characters.
+ *
+ * @group Utilities
+ * @public
+ */
+function createCacheKey(prefix, value, ...values) {
+    if (typeof prefix !== 'string' || !prefix || !VALID_PREFIX.test(prefix)) {
+        const received = typeof prefix !== 'string' ? `type ${typeof prefix}` : `"${prefix}"`;
+        throw new errors_1.LibraryUsageError(`Invalid cache key prefix: ${received}. ` +
+            'Prefix must be a non-empty string containing only letters, digits, dots, underscores, and hyphens ' +
+            '(must match /^[a-zA-Z0-9._-]+$/).');
+    }
+    if (typeof value !== 'string') {
+        throw new errors_1.LibraryUsageError(`Invalid cache key value: expected a string but received ${typeof value}.`);
+    }
+    for (let i = 0; i < values.length; i++) {
+        if (typeof values[i] !== 'string') {
+            throw new errors_1.LibraryUsageError(`Invalid cache key value at index ${i + 1}: expected a string but received ${typeof values[i]}.`);
+        }
+    }
+    const hash = crypto_1.default.createHash('sha256').update(JSON.stringify([value, ...values])).digest('hex');
+    const key = `${prefix}_${hash}`;
+    if (key.length > MAX_KEY_LENGTH) {
+        throw new errors_1.LibraryUsageError(`Cache key prefix "${prefix}" is too long. ` +
+            `The generated key is ${key.length} characters but the maximum is ${MAX_KEY_LENGTH}. ` +
+            `Prefix must be at most ${MAX_KEY_LENGTH - 1 - 64} characters ` +
+            '(250 minus 1 underscore minus 64-character SHA-256 hex digest).');
+    }
+    return key;
+}

package/dist/lib/cache/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCacheKey = void 0;
+var create_cache_key_1 = require("./create-cache-key");
+Object.defineProperty(exports, "createCacheKey", { enumerable: true, get: function () { return create_cache_key_1.createCacheKey; } });

package/dist/lib/errors/parse-error-to-readable-json.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseErrorToReadableJson = void 0;
 /**
+ * @deprecated Do not use in v2 integrations.
+ * @group Utilities
  * @public
  * @param error - Error instance to parse into a plain old javascript object
  */

package/dist/lib/index.docs.js

@@ -27,3 +27,4 @@ __exportStar(require("./requests"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./testing"), exports);
+__exportStar(require("./cache"), exports);

package/dist/lib/index.js

@@ -36,14 +36,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logging = exports.requests = exports.errors = void 0;
+exports.cache = exports.logging = exports.requests = exports.errors = void 0;
 const errors = __importStar(require("./errors"));
 exports.errors = errors;
 const requests = __importStar(require("./requests"));
 exports.requests = requests;
 const logging = __importStar(require("./logging"));
 exports.logging = logging;
+const cache = __importStar(require("./cache"));
+exports.cache = cache;
 __exportStar(require("./types"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./requests"), exports);
 __exportStar(require("./logging"), exports);
+__exportStar(require("./cache"), exports);

package/dist/lib/logging/logger.js

@@ -38,6 +38,7 @@ let _logger = createDefaultLogger();
  *
  * You can now use {@link getLogger} to get the logger object anywhere within your integration codebase.
  *
+ * @group Logging
  * @public
  * @param logger - the integration logger object passed into the `startup` method
  */
@@ -57,6 +58,7 @@ exports.setLogger = setLogger;
  * logger.trace('this is a trace message');
  * ```
  *
+ * @group Logging
  * @public
  * @returns the integration's logger object
  */

package/dist/lib/requests/polarity-request.js

@@ -15,6 +15,7 @@ const logging_1 = require("../logging");
 const sanitize_request_options_1 = require("./sanitize-request-options");
 /**
  * A utility class for making HTTP requests
+ * @group Requests
  * @public
  */
 class PolarityRequest {

package/dist/lib/requests/sanitize-request-options.js

@@ -24,6 +24,8 @@ const DEFAULT_PATHS_TO_SANITIZE = [
  * @param requestOptions - request options to sanitize
  * @param additionalPathsToSanitize - array of additional paths to sanitize in addition to the
  * default paths.
+ * @group Requests
+ * @public
  */
 function sanitizeRequestOptions(requestOptions, additionalPathsToSanitize = []) {
     const pathsToSanitize = [

package/dist/lib/testing/enhanced-utils/create-entity.js

@@ -23,6 +23,9 @@ function toEntityTypeIdentifier(type) {
  * const ip = createEntity('IPv4', '8.8.8.8');
  * const domain = createEntity('domain', 'example.com');
  * ```
+ *
+ * @group Testing
+ * @public
  */
 const createEntity = (type, value) => {
     const isDomain = /^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9](?:\.[a-zA-Z]{2,})+$/.test(value);

package/dist/lib/testing/enhanced-utils/create-mock-integration-context.js

@@ -12,6 +12,9 @@ const noOp = () => () => undefined;
  * @param createMockFn - A factory that creates mock functions (e.g., `vi.fn` or `jest.fn`)
  * @returns A fully populated `IntegrationContext` with stubbed methods
  *
+ * @group Testing
+ * @public
+ *
  * @example
  * ```typescript
  * // Vitest