polarity-integration-utils 2.0.8 → 3.1.3

package/dist/dts/types.d.ts

@@ -1,10 +1,10 @@
+import { z } from 'zod';
+import { Logger as PolarityLogger } from './logging';
+import { ValidationErrorSchema, DoLookupUserOptionsSchema, ValidateOptionsUserOptionsSchema, ValidateOptionsUserOptionSchema, PossibleUserOptionValueSchema, DropdownUserOptionValueSchema, EntitySchema, EntityTypeSchema, StandardEntityTypeSchema, ChannelSchema, ResultSchema, IntegrationConfigSchema } from './zod-types';
 /**
  * @public
  */
-export type ValidationError = {
-    key: string;
-    message: string;
-};
+export type ValidationError = z.infer<typeof ValidationErrorSchema>;
 /**
  * User options object passed into the integration's `doLookup` method.
  *
@@ -26,79 +26,76 @@ export type ValidationError = {
  * ```
  * @public
  */
-export type DoLookupUserOptions = {
-    [key: string]: PossibleUserOptionValue;
-};
+export type DoLookupUserOptions = z.infer<typeof DoLookupUserOptionsSchema>;
 /**
  * @public
  */
-export type ValidateOptionsUserOptions = {
-    [key: string]: ValidateOptionsUserOption;
-};
+export type ValidateOptionsUserOptions = z.infer<typeof ValidateOptionsUserOptionsSchema>;
 /**
  * @public
  */
-export type ValidateOptionsUserOption = {
-    integration_id?: string;
-    key: string;
-    value: PossibleUserOptionValue;
-    user_can_edit?: boolean;
-    admin_only?: boolean;
-};
+export type ValidateOptionsUserOption = z.infer<typeof ValidateOptionsUserOptionSchema>;
 /**
  * @public
  */
-export type PossibleUserOptionValue = undefined | string | number | boolean | DropdownUserOptionValue | DropdownUserOptionValue[];
+export type PossibleUserOptionValue = z.infer<typeof PossibleUserOptionValueSchema>;
 /**
  * @public
  */
-export type DropdownUserOptionValue = {
-    display: string;
-    value: string;
-};
+export type DropdownUserOptionValue = z.infer<typeof DropdownUserOptionValueSchema>;
 /**
  * Represents a Polarity Entity object which is passed to an integration's
  * doLookup method.
  *
  * @public
  */
-export type Entity = {
-    value: string;
-    types: EntityType[];
-    type: EntityType;
-    requestContext: {
-        requestType: 'onDemand';
-        isUserInitiated: boolean;
-    };
-    longitude: number;
-    latitude: number;
-    isURL: boolean;
-    isSHA512: boolean;
-    isSHA256: boolean;
-    isSHA1: boolean;
-    isPrivateIP: boolean;
-    isMD5: boolean;
-    isIPv6: boolean;
-    isIPv4: boolean;
-    isIP: boolean;
-    isHex: boolean;
-    isHash: boolean;
-    isHTMLTag: boolean;
-    isEmail: boolean;
-    isDomain: boolean;
-    hashType: string;
-    displayValue: string;
-    channels: string[];
-    IPType: string;
-};
+export type Entity = z.infer<typeof EntitySchema>;
+/**
+ * @public
+ */
+export type Channel = z.infer<typeof ChannelSchema>;
 /**
  * Entity Types including custom types
  * @public
  */
-export type EntityType = StandardEntityType | '*' | 'custom' | `custom.${string}`;
+export type EntityType = z.infer<typeof EntityTypeSchema>;
 /**
  * List of supported entity type values
  * @public
  */
-export type StandardEntityType = 'IP' | 'IPv4' | 'IPv4CIDR' | 'IPv6' | 'MAC' | 'MD5' | 'SHA1' | 'SHA256' | 'cve' | 'domain' | 'email' | 'hash' | 'string' | 'url';
+export type StandardEntityType = z.infer<typeof StandardEntityTypeSchema>;
+/**
+ * @public
+ */
+export type Result<TDetails = unknown> = Omit<z.infer<typeof ResultSchema>, 'data'> & {
+    data: {
+        summary: string[];
+        details: TDetails;
+    };
+};
+/**
+ * @public
+ */
+export type DoLookupResult<TDetails = unknown> = Result<TDetails>[];
+/**
+ * @public
+ */
+export type IntegrationConfig = z.infer<typeof IntegrationConfigSchema>;
+/**
+ * @public
+ */
+export { PolarityLogger };
+/**
+ * @public
+ */
+import { IntegrationContext } from './context';
+import { IntegrationError } from './errors';
+export { IntegrationContext, IntegrationError };
+export interface Integration<TStartupResult = unknown, TDetails = unknown> {
+    startup: (logger: PolarityLogger) => Promise<TStartupResult>;
+    doLookup: (entities: Entity[], options: DoLookupUserOptions, context: IntegrationContext) => Promise<DoLookupResult<TDetails> | IntegrationError | null | void>;
+    onMessage?: (payload: unknown, options: DoLookupUserOptions, context: IntegrationContext) => Promise<unknown>;
+    onDetails?: (lookupObject: Result<TDetails>, options: DoLookupUserOptions, context: IntegrationContext) => Promise<unknown>;
+    validateOptions: (options: ValidateOptionsUserOptions, context: IntegrationContext) => IntegrationError[];
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,uBAAuB,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,yBAAyB,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,uBAAuB,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,uBAAuB,GACvB,uBAAuB,EAAE,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,cAAc,EAAE;QAAE,WAAW,EAAE,UAAU,CAAC;QAAC,eAAe,EAAE,OAAO,CAAA;KAAE,CAAC;IACtE,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,kBAAkB,GAClB,GAAG,GACH,QAAQ,GACR,UAAU,MAAM,EAAE,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,IAAI,GACJ,MAAM,GACN,UAAU,GACV,MAAM,GACN,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,KAAK,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,gCAAgC,EAChC,+BAA+B,EAC/B,6BAA6B,EAC7B,6BAA6B,EAC7B,YAAY,EACZ,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,uBAAuB,EACxB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,QAAQ,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,EAAE,MAAM,CAAC,GAAG;IACpF,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC;KACnB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,QAAQ,GAAG,OAAO,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;GAEG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;AAEhD,MAAM,WAAW,WAAW,CAAC,cAAc,GAAG,OAAO,EAAE,QAAQ,GAAG,OAAO;IACvE,OAAO,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7D,QAAQ,EAAE,CACR,QAAQ,EAAE,MAAM,EAAE,EAClB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,gBAAgB,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;IACxE,SAAS,CAAC,EAAE,CACV,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,SAAS,CAAC,EAAE,CACV,YAAY,EAAE,MAAM,CAAC,QAAQ,CAAC,EAC9B,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,kBAAkB,KACxB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,eAAe,EAAE,CACf,OAAO,EAAE,0BAA0B,EACnC,OAAO,EAAE,kBAAkB,KACxB,gBAAgB,EAAE,CAAC;CACzB"}

package/dist/dts/zod-types.d.ts

@@ -0,0 +1,278 @@
+import { z } from 'zod';
+export declare const ValidationErrorSchema: z.ZodObject<{
+    key: z.ZodString;
+    message: z.ZodString;
+}, z.core.$strip>;
+export declare const DropdownUserOptionValueSchema: z.ZodObject<{
+    display: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>;
+export declare const PossibleUserOptionValueSchema: z.ZodUnion<readonly [z.ZodUndefined, z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodObject<{
+    display: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+    display: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>>]>;
+export declare const DoLookupUserOptionsSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUndefined, z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodObject<{
+    display: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+    display: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>>]>>;
+export declare const ValidateOptionsUserOptionSchema: z.ZodObject<{
+    integration_id: z.ZodOptional<z.ZodString>;
+    key: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodUndefined, z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodObject<{
+        display: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+        display: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>]>;
+    user_can_edit: z.ZodOptional<z.ZodBoolean>;
+    admin_only: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const ValidateOptionsUserOptionsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    integration_id: z.ZodOptional<z.ZodString>;
+    key: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodUndefined, z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodObject<{
+        display: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+        display: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>]>;
+    user_can_edit: z.ZodOptional<z.ZodBoolean>;
+    admin_only: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>>;
+export declare const ChannelSchema: z.ZodObject<{
+    channel_name: z.ZodString;
+    id: z.ZodNumber;
+}, z.core.$strip>;
+export declare const StandardEntityTypeSchema: z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>;
+export declare const EntityTypeSchema: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>;
+export declare const EntitySchema: z.ZodObject<{
+    value: z.ZodString;
+    types: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>>;
+    type: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>;
+    requestContext: z.ZodObject<{
+        requestType: z.ZodLiteral<"onDemand">;
+        isUserInitiated: z.ZodBoolean;
+    }, z.core.$strip>;
+    longitude: z.ZodNumber;
+    latitude: z.ZodNumber;
+    isURL: z.ZodBoolean;
+    isSHA512: z.ZodBoolean;
+    isSHA256: z.ZodBoolean;
+    isSHA1: z.ZodBoolean;
+    isPrivateIP: z.ZodBoolean;
+    isMD5: z.ZodBoolean;
+    isIPv6: z.ZodBoolean;
+    isIPv4: z.ZodBoolean;
+    isIP: z.ZodBoolean;
+    isHex: z.ZodBoolean;
+    isHash: z.ZodBoolean;
+    isHTMLTag: z.ZodBoolean;
+    isEmail: z.ZodBoolean;
+    isDomain: z.ZodBoolean;
+    hashType: z.ZodUnion<readonly [z.ZodLiteral<"md5">, z.ZodLiteral<"sha1">, z.ZodLiteral<"sha256">, z.ZodLiteral<"sha512">, z.ZodLiteral<"">]>;
+    displayValue: z.ZodString;
+    channels: z.ZodArray<z.ZodObject<{
+        channel_name: z.ZodString;
+        id: z.ZodNumber;
+    }, z.core.$strip>>;
+    IPType: z.ZodUnion<readonly [z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"">]>;
+}, z.core.$strip>;
+export declare const ResultSchema: z.ZodObject<{
+    entity: z.ZodObject<{
+        value: z.ZodString;
+        types: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>>;
+        type: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>;
+        requestContext: z.ZodObject<{
+            requestType: z.ZodLiteral<"onDemand">;
+            isUserInitiated: z.ZodBoolean;
+        }, z.core.$strip>;
+        longitude: z.ZodNumber;
+        latitude: z.ZodNumber;
+        isURL: z.ZodBoolean;
+        isSHA512: z.ZodBoolean;
+        isSHA256: z.ZodBoolean;
+        isSHA1: z.ZodBoolean;
+        isPrivateIP: z.ZodBoolean;
+        isMD5: z.ZodBoolean;
+        isIPv6: z.ZodBoolean;
+        isIPv4: z.ZodBoolean;
+        isIP: z.ZodBoolean;
+        isHex: z.ZodBoolean;
+        isHash: z.ZodBoolean;
+        isHTMLTag: z.ZodBoolean;
+        isEmail: z.ZodBoolean;
+        isDomain: z.ZodBoolean;
+        hashType: z.ZodUnion<readonly [z.ZodLiteral<"md5">, z.ZodLiteral<"sha1">, z.ZodLiteral<"sha256">, z.ZodLiteral<"sha512">, z.ZodLiteral<"">]>;
+        displayValue: z.ZodString;
+        channels: z.ZodArray<z.ZodObject<{
+            channel_name: z.ZodString;
+            id: z.ZodNumber;
+        }, z.core.$strip>>;
+        IPType: z.ZodUnion<readonly [z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"">]>;
+    }, z.core.$strip>;
+    displayValue: z.ZodOptional<z.ZodString>;
+    data: z.ZodObject<{
+        summary: z.ZodArray<z.ZodString>;
+        details: z.ZodUnknown;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const DoLookupResultSchema: z.ZodArray<z.ZodObject<{
+    entity: z.ZodObject<{
+        value: z.ZodString;
+        types: z.ZodArray<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>>;
+        type: z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodLiteral<"IP">, z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv4CIDR">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"MAC">, z.ZodLiteral<"MD5">, z.ZodLiteral<"SHA1">, z.ZodLiteral<"SHA256">, z.ZodLiteral<"cve">, z.ZodLiteral<"domain">, z.ZodLiteral<"email">, z.ZodLiteral<"hash">, z.ZodLiteral<"string">, z.ZodLiteral<"url">]>, z.ZodLiteral<"*">, z.ZodLiteral<"custom">, z.ZodCustom<`custom.${string}`, `custom.${string}`>]>;
+        requestContext: z.ZodObject<{
+            requestType: z.ZodLiteral<"onDemand">;
+            isUserInitiated: z.ZodBoolean;
+        }, z.core.$strip>;
+        longitude: z.ZodNumber;
+        latitude: z.ZodNumber;
+        isURL: z.ZodBoolean;
+        isSHA512: z.ZodBoolean;
+        isSHA256: z.ZodBoolean;
+        isSHA1: z.ZodBoolean;
+        isPrivateIP: z.ZodBoolean;
+        isMD5: z.ZodBoolean;
+        isIPv6: z.ZodBoolean;
+        isIPv4: z.ZodBoolean;
+        isIP: z.ZodBoolean;
+        isHex: z.ZodBoolean;
+        isHash: z.ZodBoolean;
+        isHTMLTag: z.ZodBoolean;
+        isEmail: z.ZodBoolean;
+        isDomain: z.ZodBoolean;
+        hashType: z.ZodUnion<readonly [z.ZodLiteral<"md5">, z.ZodLiteral<"sha1">, z.ZodLiteral<"sha256">, z.ZodLiteral<"sha512">, z.ZodLiteral<"">]>;
+        displayValue: z.ZodString;
+        channels: z.ZodArray<z.ZodObject<{
+            channel_name: z.ZodString;
+            id: z.ZodNumber;
+        }, z.core.$strip>>;
+        IPType: z.ZodUnion<readonly [z.ZodLiteral<"IPv4">, z.ZodLiteral<"IPv6">, z.ZodLiteral<"">]>;
+    }, z.core.$strip>;
+    displayValue: z.ZodOptional<z.ZodString>;
+    data: z.ZodObject<{
+        summary: z.ZodArray<z.ZodString>;
+        details: z.ZodUnknown;
+    }, z.core.$strip>;
+}, z.core.$strip>>;
+export declare const IntegrationConfigSchema: z.ZodObject<{
+    polarityIntegrationUuid: z.ZodUUID;
+    name: z.ZodString;
+    acronym: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    defaultColor: z.ZodOptional<z.ZodString>;
+    entityTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    dataTypes: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        type: z.ZodOptional<z.ZodLiteral<"custom">>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        key: z.ZodString;
+        regex: z.ZodString;
+        editable: z.ZodOptional<z.ZodBoolean>;
+        enabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>]>>>;
+    customTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodOptional<z.ZodLiteral<"custom">>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        key: z.ZodString;
+        regex: z.ZodString;
+        editable: z.ZodOptional<z.ZodBoolean>;
+        enabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    supportsAdditionalCustomTypes: z.ZodOptional<z.ZodBoolean>;
+    styles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    block: z.ZodObject<{
+        component: z.ZodObject<{
+            file: z.ZodString;
+        }, z.core.$strip>;
+        template: z.ZodObject<{
+            file: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    summary: z.ZodOptional<z.ZodObject<{
+        component: z.ZodObject<{
+            file: z.ZodString;
+        }, z.core.$strip>;
+        template: z.ZodObject<{
+            file: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    onDemandOnly: z.ZodOptional<z.ZodBoolean>;
+    copyOnDemand: z.ZodOptional<z.ZodBoolean>;
+    logging: z.ZodOptional<z.ZodObject<{
+        level: z.ZodEnum<{
+            error: "error";
+            debug: "debug";
+            info: "info";
+            trace: "trace";
+            warn: "warn";
+            fatal: "fatal";
+        }>;
+    }, z.core.$strip>>;
+    request: z.ZodOptional<z.ZodObject<{
+        cert: z.ZodOptional<z.ZodString>;
+        key: z.ZodOptional<z.ZodString>;
+        passphrase: z.ZodOptional<z.ZodString>;
+        ca: z.ZodOptional<z.ZodString>;
+        proxy: z.ZodOptional<z.ZodString>;
+        rejectUnauthorized: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    options: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodEnum<{
+            text: "text";
+            password: "password";
+        }>;
+        key: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        default: z.ZodNullable<z.ZodString>;
+        userCanEdit: z.ZodOptional<z.ZodBoolean>;
+        adminOnly: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"boolean">;
+        key: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        default: z.ZodNullable<z.ZodBoolean>;
+        userCanEdit: z.ZodOptional<z.ZodBoolean>;
+        adminOnly: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"number">;
+        key: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        default: z.ZodNullable<z.ZodNumber>;
+        userCanEdit: z.ZodOptional<z.ZodBoolean>;
+        adminOnly: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"select">;
+        key: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        default: z.ZodNullable<z.ZodUnion<readonly [z.ZodObject<{
+            value: z.ZodString;
+            display: z.ZodString;
+        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            display: z.ZodString;
+        }, z.core.$strip>>, z.ZodString]>>;
+        options: z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            display: z.ZodString;
+        }, z.core.$strip>>;
+        multiple: z.ZodOptional<z.ZodBoolean>;
+        userCanEdit: z.ZodBoolean;
+        adminOnly: z.ZodBoolean;
+    }, z.core.$strip>], "type">>>;
+}, z.core.$strip>;
+export type IntegrationConfig = z.infer<typeof IntegrationConfigSchema>;
+//# sourceMappingURL=zod-types.d.ts.map

package/dist/dts/zod-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-types.d.ts","sourceRoot":"","sources":["../../lib/zod-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;oBAOxC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;qBAGrC,CAAC;AAEF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;iBAM1C,CAAC;AAEH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;kBAG5C,CAAC;AAEF,eAAO,MAAM,aAAa;;;iBAGxB,CAAC;AAEH,eAAO,MAAM,wBAAwB,gVAenC,CAAC;AAEH,eAAO,MAAM,gBAAgB,ucAK3B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkCvB,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAOvB,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAwB,CAAC;AAyE1D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoClC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/es/lib/context/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./cache"), exports);
+__exportStar(require("./integration-context"), exports);

package/dist/es/lib/context/integration-context.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es/{errors → lib/errors}/network-error.js

@@ -65,7 +65,7 @@ class NetworkError extends integration_error_1.IntegrationError {
                     'SSL errors are typically caused by an untrusted SSL certificate in the HTTPS request chain (e.g., ' +
                         'an internal server that is being queried directly, or a web proxy for external requests). You can temporarily ' +
                         'ignore SSL validation errors by enabling the integration setting "Allow Insecure TLS/SSL Connections". In most ' +
-                        'cases, you will need to add your organization\'s Certificate Authority to the Polarity Server to resolve the ' +
+                        "cases, you will need to add your organization's Certificate Authority to the Polarity Server to resolve the " +
                         'issue permanently.';
             }
             else if (code && code === 'ENOTFOUND') {

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

@@ -22,3 +22,4 @@ __exportStar(require("./errors"), exports);
 __exportStar(require("./requests"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./context"), exports);

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

@@ -32,11 +32,19 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+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.types = exports.context = 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 context = __importStar(require("./context"));
+exports.context = context;
+const types = __importStar(require("./types"));
+exports.types = types;
+__exportStar(require("./types"), exports);

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEntity = void 0;
+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);
+    const isIPv4 = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/.test(value);
+    return {
+        value,
+        displayValue: value,
+        type,
+        types: [type],
+        isDomain,
+        isIPv4,
+        isIP: isIPv4,
+        isEmail: false,
+        isHash: false,
+        isHex: false,
+        isHTMLTag: false,
+        isIPv6: false,
+        isMD5: false,
+        isPrivateIP: false,
+        isSHA1: false,
+        isSHA256: false,
+        isSHA512: false,
+        isURL: false,
+        latitude: 0,
+        longitude: 0,
+        hashType: '',
+        IPType: isIPv4 ? 'IPv4' : '',
+        channels: [],
+        requestContext: {
+            requestType: 'onDemand',
+            isUserInitiated: true
+        }
+    };
+};
+exports.createEntity = createEntity;

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

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockIntegrationContext = void 0;
+const createMockIntegrationContext = () => {
+    const cache = {
+        global: {
+            get: jest.fn(),
+            set: jest.fn(),
+            delete: jest.fn()
+        },
+        integration: {
+            get: jest.fn(),
+            set: jest.fn(),
+            delete: jest.fn()
+        },
+        user: {
+            get: jest.fn(),
+            set: jest.fn(),
+            delete: jest.fn()
+        }
+    };
+    return {
+        cache,
+        integrationId: 'test-integration',
+        userId: 'test-user',
+        logger: {
+            info: jest.fn(),
+            debug: jest.fn(),
+            trace: jest.fn(),
+            warn: jest.fn(),
+            error: jest.fn(),
+            fatal: jest.fn()
+        }
+    };
+};
+exports.createMockIntegrationContext = createMockIntegrationContext;

package/dist/es/lib/testing/enhanced-utils/mock-request.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockRequest = void 0;
+const polarity_request_1 = require("../../requests/polarity-request");
+jest.mock('../../requests/polarity-request');
+const mockRequest = () => {
+    const mockRequest = {
+        get: jest.fn(),
+        post: jest.fn(),
+        put: jest.fn(),
+        delete: jest.fn(),
+        patch: jest.fn(),
+        head: jest.fn(),
+        options: jest.fn()
+    };
+    polarity_request_1.PolarityRequest.mockImplementation(() => mockRequest);
+    return {
+        PolarityRequestMock: polarity_request_1.PolarityRequest,
+        mockRequest
+    };
+};
+exports.mockRequest = mockRequest;