@nexeraid/identity-schemas 1.12.22-dev → 1.12.23-dev

package/webhooks/dist/nexeraid-identity-schemas-webhooks.esm.js

@@ -0,0 +1,580 @@
+import { z } from 'zod';
+import { ae as UuidString, dy as ExternalCustomerId, aq as RiskScoreType, as as CustomerType, ay as CustomerOnboardingLevel, aA as CustomerStatus, ai as ISO3CountryCode, a2 as BlockchainAddress, bC as RuleResultStatus, dR as GenericVerifiableCredentialSchema, d_ as _toArray, dZ as _toConsumableArray, ad as EnvironmentSchema } from '../../dist/identity-api.schema-2df73bbd.esm.js';
+import { M as MergedProviders, S as ScoringAnalysisResponse, B as BitRankVerifiedResponse, a as MerkleAddressResponse, I as IpQualityServiceAnalysisResponse, C as ComplyAdvantageSearchResponse } from '../../dist/chainalysis.schema-9e5926b9.esm.js';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import 'nanoid';
+
+// Alert Statuses
+var AlertStatuses = ["Open", "Under Investigation", "Pending", "Closed", "Escalated"];
+var AlertStatus = z["enum"](AlertStatuses);
+// Alert Types
+var AlertTypes = ["AML Screening", "IP Screening", "Email Screening", "KYC Drop-off", "Onchain Monitoring", "Fraud", "Transaction Monitoring", "Duplicate"];
+var AlertType = z["enum"](AlertTypes);
+// Alert Severities
+var AlertSeverities = ["Low", "Medium", "High"];
+var AlertSeverity = z["enum"](AlertSeverities);
+// Alert Categories
+var AlertCategories = ["Onboarding", "Ongoing monitoring"];
+var AlertCategory = z["enum"](AlertCategories);
+var ALERT_CHART_TYPES = ["total", "new", "opened", "closed", "inProgress", "unassigned", "escalated", "overdue", "avgClosureTime", "ageOfOldest", "alertTrendsOverTime", "alertsByType", "ageOfOpenAlerts", "alertsPerOfficer", "alertsSeverity"];
+var AlertChartType = z["enum"](ALERT_CHART_TYPES);
+var ALERT_TABLE_COLUMNS = ["selected", "createdAt", "overdue", "id", "severity", "type", "description", "assignedTo", "country", "status"];
+var AlertTableColumn = z["enum"](ALERT_TABLE_COLUMNS);
+var UserInfoForDuplicate = z.object({
+  customerId: UuidString,
+  customerInfo: z.string().nullish(),
+  profilePicture: z.string().nullish(),
+  idDocumentUrl: z.string().nullish()
+});
+var DuplicateData = z.object({
+  original: UserInfoForDuplicate,
+  duplicate: UserInfoForDuplicate
+});
+
+var AlertWebhookPayload = z.object({
+  id: UuidString,
+  severity: AlertSeverity,
+  category: AlertCategory,
+  type: AlertType,
+  status: AlertStatus,
+  customerId: UuidString,
+  externalUserId: ExternalCustomerId.nullish(),
+  cmsProjectId: z.string().optional(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date(),
+  deletedBy: z.string().nullish(),
+  deletedAt: z.coerce.date().nullish()
+});
+
+var CustomerWebhookPayload = z.object({
+  cmsProjectId: z.string(),
+  customerId: UuidString,
+  externalClientId: ExternalCustomerId.nullish(),
+  createdBy: z.string(),
+  updatedBy: z.string(),
+  id: z.string(),
+  riskScore: RiskScoreType.nullish(),
+  type: CustomerType.nullish(),
+  onboardingLevel: CustomerOnboardingLevel.nullish(),
+  status: CustomerStatus.nullish(),
+  createdAt: z.coerce.date(),
+  updatedAt: z.coerce.date().nullish(),
+  reason: z.string().nullish(),
+  deletedBy: z.string().nullish(),
+  deletedAt: z.coerce.date().nullish()
+});
+var CUSTOMER_TOPICS = ["CUSTOMER_CREATED", "CUSTOMER_UPDATED", "CUSTOMER_DELETED", "CUSTOMER_STATUS_CHANGED", "CUSTOMER_RISK_LEVEL_CHANGED", "CUSTOMER_COUNTRY"];
+var CustomerTopics = z["enum"](CUSTOMER_TOPICS);
+var CustomerEvents = {
+  CUSTOMER_CREATED: z.object({
+    topic: z.literal("CUSTOMER_CREATED"),
+    subject: z.string().describe("Customer ID"),
+    // CUSTOMER ID
+    data: CustomerWebhookPayload
+  }),
+  CUSTOMER_UPDATED: z.object({
+    topic: z.literal("CUSTOMER_UPDATED"),
+    subject: z.string().describe("Customer ID"),
+    // CUSTOMER ID
+    data: CustomerWebhookPayload
+  }),
+  CUSTOMER_DELETED: z.object({
+    topic: z.literal("CUSTOMER_DELETED"),
+    subject: z.string().describe("Customer ID"),
+    // CUSTOMER ID
+    data: CustomerWebhookPayload
+  }),
+  CUSTOMER_STATUS_CHANGED: z.object({
+    topic: z.literal("CUSTOMER_STATUS_CHANGED"),
+    subject: z.string().describe("Project ID"),
+    // CMS PROJECT ID
+    data: z.object({
+      cmsProjectId: z.string(),
+      customerId: UuidString,
+      externalClientId: ExternalCustomerId.optional(),
+      fromStatus: CustomerStatus.optional(),
+      toStatus: CustomerStatus
+      // do we need updatedBy?
+    })
+  }),
+  CUSTOMER_RISK_LEVEL_CHANGED: z.object({
+    topic: z.literal("CUSTOMER_RISK_LEVEL_CHANGED"),
+    subject: z.string().describe("Project ID"),
+    // CMS PROJECT ID
+    data: z.object({
+      cmsProjectId: z.string(),
+      customerId: UuidString,
+      externalCustomerId: ExternalCustomerId.optional(),
+      fromRiskLevel: RiskScoreType.optional(),
+      toRiskLevel: RiskScoreType,
+      riskNumber: z.number().optional() // risk number is calculated based on toRiskLevel automatically when event is parsed with zod parse
+    }).transform(function (data) {
+      // assign riskNumber based on toRiskLevel (0 - 100)
+      switch (data.toRiskLevel) {
+        case "No risk":
+          data.riskNumber = 0;
+          break;
+        case "Low":
+          data.riskNumber = 25;
+          break;
+        case "Medium":
+          data.riskNumber = 50;
+          break;
+        case "High":
+          data.riskNumber = 100;
+          break;
+      }
+      return data;
+    })
+  }),
+  CUSTOMER_COUNTRY: z.object({
+    topic: z.literal("CUSTOMER_COUNTRY"),
+    subject: z.string().describe("Project ID"),
+    // CMS PROJECT ID
+    data: z.object({
+      cmsProjectId: z.string(),
+      customerId: UuidString,
+      externalCustomerId: ExternalCustomerId.optional(),
+      country: ISO3CountryCode
+    })
+  })
+};
+
+var ScenarioWebhookPayloadSchema = z.object({
+  customerId: z.string(),
+  externalCustomerId: ExternalCustomerId.nullish(),
+  address: BlockchainAddress.nullish(),
+  result: RuleResultStatus,
+  executionId: z.string(),
+  scenarios: z.object({
+    scenarioId: z.string(),
+    result: z.object({
+      objectId: z.string(),
+      result: z.object({
+        // TODO maybe start using OpaChallengeQueryResponse
+        is_valid: z["boolean"](),
+        reasons: z.array(z.unknown())
+      })
+    }).array()
+  }).array(),
+  data: GenericVerifiableCredentialSchema.array()
+});
+
+var VerificationFlowResult = z.union([z.object({
+  type: z["enum"]([MergedProviders["enum"].integratedScorechain, MergedProviders["enum"].scorechain]),
+  data: ScoringAnalysisResponse
+}), z.object({
+  type: z["enum"]([MergedProviders["enum"].big]),
+  data: BitRankVerifiedResponse
+}), z.object({
+  type: z["enum"]([MergedProviders["enum"].merkleScience]),
+  data: MerkleAddressResponse
+}), z.object({
+  type: z["enum"]([MergedProviders["enum"].integratedIpqualityscore, MergedProviders["enum"].ipQualityScore]),
+  data: IpQualityServiceAnalysisResponse
+}), z.object({
+  type: z["enum"]([MergedProviders["enum"].integratedComplyAdvantage, MergedProviders["enum"].complyAdvantage]),
+  data: ComplyAdvantageSearchResponse
+})]);
+var VerificationFlowChecksWebhookPayload = z.object({
+  executionId: z.string(),
+  customerId: z.string(),
+  externalCustomerId: ExternalCustomerId.optional(),
+  address: z.string().nullish(),
+  result: z.array(VerificationFlowResult)
+});
+
+var WebhookEventTypes = ["send.scenario", "send.verification.flow", "customer.created", "customer.updated", "customer.deleted", "alert.created", "alert.updated", "alert.deleted"];
+var WebhookEventType = z["enum"](WebhookEventTypes);
+var WebhookEventTypesForm = ["webhooks.sendScenario", "webhooks.sendVerificationFlow", "webhooks.customerCreated", "webhooks.customerUpdated", "webhooks.customerDeleted", "webhooks.alertCreated", "webhooks.alertUpdated", "webhooks.alertDeleted"];
+var WebhookEventTypeForm = z["enum"](WebhookEventTypesForm);
+var AttemptsStatus = {
+  Success: 0,
+  Pending: 1,
+  Fail: 2,
+  Sending: 3
+};
+var _ref = Object.keys(AttemptsStatus),
+  _ref2 = _toArray(_ref),
+  firstKey = _ref2[0],
+  othersKeys = _ref2.slice(1);
+var AttemptsStatusKeys = [firstKey].concat(_toConsumableArray(othersKeys));
+var AttemptsStatusKey = z["enum"](AttemptsStatusKeys);
+var AttemptsStatusCodes = ["0", "100", "200", "300", "400", "500"];
+var AttemptsStatusCode = z["enum"](AttemptsStatusCodes);
+/**
+ *
+ * Schemas
+ *
+ */
+var NexeraEventTypes = z.union([z.object({
+  name: z.literal("send.scenario"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("send.verification.flow"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("customer.created"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("customer.updated"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("customer.deleted"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("alert.created"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("alert.updated"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+}), z.object({
+  name: z.literal("alert.deleted"),
+  description: z.string(),
+  archived: z["boolean"](),
+  schemas: z.record(z.unknown())
+})]);
+
+/**
+ *
+ * Payload definitions
+ *
+ */
+var SendScenarioPayload = z.object({
+  eventType: z.literal("send.scenario"),
+  payload: ScenarioWebhookPayloadSchema
+});
+var SendVerificationFlowPayload = z.object({
+  eventType: z.literal("send.verification.flow"),
+  payload: VerificationFlowChecksWebhookPayload
+});
+var CustomerCreatedPayload = z.object({
+  eventType: z.literal("customer.created"),
+  payload: CustomerWebhookPayload
+});
+var CustomerUpdatedPayload = z.object({
+  eventType: z.literal("customer.updated"),
+  payload: CustomerWebhookPayload
+});
+var CustomerDeletedPayload = z.object({
+  eventType: z.literal("customer.deleted"),
+  payload: CustomerWebhookPayload
+});
+var AlertCreatedPayload = z.object({
+  eventType: z.literal("alert.created"),
+  payload: AlertWebhookPayload
+});
+var AlertUpdatedPayload = z.object({
+  eventType: z.literal("alert.updated"),
+  payload: AlertWebhookPayload
+});
+var AlertDeletedPayload = z.object({
+  eventType: z.literal("alert.deleted"),
+  payload: AlertWebhookPayload
+});
+var AllNexeraEventTypes = z.array(NexeraEventTypes);
+var NexeraSvixEnvironmentConfig = z.object({
+  env: EnvironmentSchema
+});
+var EndpointHandlingForm = z.object({
+  endpointURL: z.string().min(1, {
+    message: "Webhook Endpoint URL is required!"
+  }).url({
+    message: "Provided URL is not valid"
+  }),
+  name: z.string().min(1, {
+    message: "Webhook name is required!"
+  }),
+  webhooks: z.object({
+    sendScenario: z["boolean"]().optional(),
+    sendVerificationFlow: z["boolean"]().optional(),
+    customerCreated: z["boolean"]().optional(),
+    customerUpdated: z["boolean"]().optional(),
+    customerDeleted: z["boolean"]().optional(),
+    alertCreated: z["boolean"]().optional(),
+    alertUpdated: z["boolean"]().optional(),
+    alertDeleted: z["boolean"]().optional()
+  }).optional()
+});
+var WebhookCheckboxInformation = z.object({
+  name: WebhookEventTypeForm,
+  label: z.string(),
+  description: z.string()
+});
+var EndpointCheckboxsCollapsiblesSchema = z.object({
+  title: z.string(),
+  icon: z.any(),
+  description: z.string(),
+  webhooks: z.array(WebhookCheckboxInformation)
+});
+var EndpointOut = z.object({
+  disabled: z["boolean"]().optional(),
+  id: z.string(),
+  description: z.string(),
+  url: z.string(),
+  filterTypes: z.array(z.string()).nullish().optional(),
+  createdAt: z.coerce.date(),
+  channel: z.array(z.string()).optional(),
+  metadata: z.record(z.string()),
+  rateLimit: z.number().nullish().optional(),
+  // We are using the uid
+  uid: z.string().nullish().optional(),
+  version: z.number(),
+  updatedAt: z.coerce.date()
+});
+var MessageDataOut = z.object({
+  id: z.string(),
+  eventType: WebhookEventType,
+  timestamp: z.coerce.date(),
+  payload: z.union([SendScenarioPayload, SendVerificationFlowPayload, CustomerCreatedPayload, CustomerUpdatedPayload, CustomerDeletedPayload, AlertCreatedPayload, AlertUpdatedPayload, AlertDeletedPayload])
+});
+var AttemptDataOut = z.object({
+  id: z.string(),
+  url: z.string(),
+  responseStatusCode: z.number(),
+  status: z.number(),
+  triggerType: z.coerce.string(),
+  msgId: z.string(),
+  endpointId: z.string(),
+  timestamp: z.coerce.date()
+});
+var MessageDataOutExtended = MessageDataOut.extend({
+  status: z.number(),
+  url: z.string(),
+  attempts: z.array(AttemptDataOut)
+});
+var EventType = z.object({
+  archived: z["boolean"]().optional(),
+  createdAt: z.coerce.date(),
+  description: z.string(),
+  featureFlag: z.string().optional(),
+  name: z.string(),
+  schemas: z.record(z.unknown()).optional(),
+  updatedAt: z.coerce.date()
+});
+var ListEventTypeOutput = z.object({
+  data: z.array(EventType),
+  done: z["boolean"](),
+  iterator: z.string().optional(),
+  prevIterator: z.string().optional()
+});
+var CreateEndpointInput = z.object({
+  projectId: z.string(),
+  name: z.string(),
+  eventTypes: z.array(WebhookEventType),
+  url: z.string()
+});
+var CreateEndpointOutput = EndpointOut.optional();
+var ListEndpointsInput = z.object({
+  projectId: z.string()
+});
+var ListResponseEndpointOut = z.object({
+  endpoints: z.array(EndpointOut)
+});
+var UpdateEndpointInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string(),
+  url: z.string(),
+  name: z.string(),
+  eventTypes: z.array(WebhookEventType).optional(),
+  disabled: z["boolean"]().optional()
+});
+var UpdateEndpointOutput = EndpointOut.optional();
+var DeleteEndpointInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string()
+});
+var DeleteEndpointOutput = z["boolean"]();
+var GetEndpointSecretInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string()
+});
+var GetEndpointSecretOutput = z.object({
+  key: z.string()
+}).optional();
+
+/**
+ *
+ * Send Messages Types
+ *
+ */
+var SendMessageForSendScenarioInput = z.object({
+  projectId: z.string(),
+  payload: SendScenarioPayload
+});
+var SendMessageForSendVerificationFlowInput = z.object({
+  projectId: z.string(),
+  payload: SendVerificationFlowPayload
+});
+var SendMessageForCustomerCreatedInput = z.object({
+  projectId: z.string(),
+  payload: CustomerCreatedPayload
+});
+var SendMessageForCustomerUpdatedInput = z.object({
+  projectId: z.string(),
+  payload: CustomerUpdatedPayload
+});
+var SendMessageForCustomerDeletedInput = z.object({
+  projectId: z.string(),
+  payload: CustomerDeletedPayload
+});
+var SendMessageForAlertCreatedInput = z.object({
+  projectId: z.string(),
+  payload: AlertCreatedPayload
+});
+var SendMessageForAlertUpdatedInput = z.object({
+  projectId: z.string(),
+  payload: AlertUpdatedPayload
+});
+var SendMessageForAlertDeletedInput = z.object({
+  projectId: z.string(),
+  payload: AlertDeletedPayload
+});
+
+/**
+ *
+ *
+ *
+ */
+var ListMessagesInput = z.object({
+  projectId: z.string(),
+  eventType: WebhookEventType.optional()
+});
+var GetMessagesInput = z.object({
+  projectId: z.string(),
+  messageId: z.string()
+});
+var ListMessagesOutput = z.object({
+  messages: z.array(MessageDataOut)
+});
+var ListAttemptsByMessageInput = z.object({
+  projectId: z.string(),
+  messageId: z.string()
+});
+var ListAttemptsByEndpointInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string(),
+  eventType: WebhookEventType.optional(),
+  status: AttemptsStatusKey.optional(),
+  statusCode: AttemptsStatusCode.optional()
+});
+var ListAttemptsByMessageOutput = z.object({
+  attempts: z.array(AttemptDataOut)
+});
+var ConnectionHandlingWorkspaceInput = z.object({
+  projectId: z.string()
+});
+var ConnectionHandlingWorkspaceOutput = z["boolean"]();
+var SendExampleMessageInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string(),
+  eventType: WebhookEventType
+});
+var ResendWebhookInput = z.object({
+  projectId: z.string(),
+  endpointId: z.string(),
+  messageId: z.string()
+});
+
+/**
+ *
+ * Types
+ *
+ */
+
+/**
+ *
+ * Send Messages Types
+ *
+ */
+
+/**
+ *
+ *
+ *
+ */
+
+/**
+ *
+ * Payload types
+ *
+ */
+
+/**
+ *
+ * Constants definitions
+ *
+ */
+var NexeraWebhookEvents = [{
+  name: "send.scenario",
+  description: "Send Scenario Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(SendScenarioPayload)
+  }
+}, {
+  name: "send.verification.flow",
+  description: "Send Verification Flow Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(SendVerificationFlowPayload)
+  }
+}, {
+  name: "customer.created",
+  description: "Customer Created Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(CustomerCreatedPayload)
+  }
+}, {
+  name: "customer.updated",
+  description: "Customer Updated Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(CustomerUpdatedPayload)
+  }
+}, {
+  name: "customer.deleted",
+  description: "Customer Deleted Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(CustomerDeletedPayload)
+  }
+}, {
+  name: "alert.created",
+  description: "Alert Created Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(AlertCreatedPayload)
+  }
+}, {
+  name: "alert.updated",
+  description: "Alert Updated Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(AlertUpdatedPayload)
+  }
+}, {
+  name: "alert.deleted",
+  description: "Alert Deleted Webhook",
+  archived: false,
+  schemas: {
+    1: zodToJsonSchema(AlertDeletedPayload)
+  }
+}];
+
+export { ALERT_CHART_TYPES, ALERT_TABLE_COLUMNS, AlertCategories, AlertCategory, AlertChartType, AlertCreatedPayload, AlertDeletedPayload, AlertSeverities, AlertSeverity, AlertStatus, AlertStatuses, AlertTableColumn, AlertType, AlertTypes, AlertUpdatedPayload, AlertWebhookPayload, AllNexeraEventTypes, AttemptDataOut, AttemptsStatus, AttemptsStatusCode, AttemptsStatusCodes, AttemptsStatusKey, AttemptsStatusKeys, CUSTOMER_TOPICS, ConnectionHandlingWorkspaceInput, ConnectionHandlingWorkspaceOutput, CreateEndpointInput, CreateEndpointOutput, CustomerCreatedPayload, CustomerDeletedPayload, CustomerEvents, CustomerTopics, CustomerUpdatedPayload, CustomerWebhookPayload, DeleteEndpointInput, DeleteEndpointOutput, DuplicateData, EndpointCheckboxsCollapsiblesSchema, EndpointHandlingForm, EndpointOut, EventType, GetEndpointSecretInput, GetEndpointSecretOutput, GetMessagesInput, ListAttemptsByEndpointInput, ListAttemptsByMessageInput, ListAttemptsByMessageOutput, ListEndpointsInput, ListEventTypeOutput, ListMessagesInput, ListMessagesOutput, ListResponseEndpointOut, MessageDataOut, MessageDataOutExtended, NexeraSvixEnvironmentConfig, NexeraWebhookEvents, ResendWebhookInput, ScenarioWebhookPayloadSchema, SendExampleMessageInput, SendMessageForAlertCreatedInput, SendMessageForAlertDeletedInput, SendMessageForAlertUpdatedInput, SendMessageForCustomerCreatedInput, SendMessageForCustomerDeletedInput, SendMessageForCustomerUpdatedInput, SendMessageForSendScenarioInput, SendMessageForSendVerificationFlowInput, SendScenarioPayload, SendVerificationFlowPayload, UpdateEndpointInput, UpdateEndpointOutput, UserInfoForDuplicate, VerificationFlowChecksWebhookPayload, VerificationFlowResult, WebhookCheckboxInformation, WebhookEventType, WebhookEventTypeForm, WebhookEventTypes, WebhookEventTypesForm };

package/webhooks/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "dist/nexeraid-identity-schemas-webhooks.cjs.js",
+  "module": "dist/nexeraid-identity-schemas-webhooks.esm.js"
+}