@erxes/api-shared 3.3.2 → 3.3.3-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erxes/api-shared",
-  "version": "3.3.2",
+  "version": "3.3.3-next.1",
   "description": "Shared platform utilities for erxes backend plugins: plugin startup, tenant-scoped models, service discovery, messaging and core types.",
   "license": "AGPL-3.0-only",
   "repository": {

package/src/core-modules/automations/constants.ts

@@ -1,3 +1,8 @@
+import {
+  AUTOMATION_ACTION_CONTRIBUTIONS,
+  TAutomationActionPlacement,
+} from './types';
+
 export const AUTOMATION_PROPERTY_OPERATORS = {
   SET: 'set',
   CLEAR: 'clear',
@@ -141,6 +146,27 @@ export const AUTOMATION_CORE_ACTION_DEFERRED: Record<
   [AUTOMATION_CORE_ACTIONS.AI_AGENT]: { mode: 'standby', timeoutMinutes: 3 },
 };
 
+/**
+ * Core actions have no plugin constants either, so how they combine with the
+ * actions around them is declared here.
+ */
+export const AUTOMATION_CORE_ACTION_PLACEMENTS: Record<
+  string,
+  TAutomationActionPlacement
+> = {
+  [AUTOMATION_CORE_ACTIONS.AI_AGENT]: {
+    accepts: [AUTOMATION_ACTION_CONTRIBUTIONS.REMEMBERED_RECORD_CHOICE],
+  },
+  [AUTOMATION_CORE_ACTIONS.SET_PROPERTY]: {
+    addsToPrevious: [
+      {
+        actionType: AUTOMATION_CORE_ACTIONS.AI_AGENT,
+        kind: AUTOMATION_ACTION_CONTRIBUTIONS.REMEMBERED_RECORD_CHOICE,
+      },
+    ],
+  },
+};
+
 export const AUTOMATION_DEFERRED_TIMEOUT = {
   DEFAULT_MINUTES: 10,
   MAX_MINUTES: 60,

package/src/core-modules/automations/outputResolvers.ts

@@ -793,6 +793,14 @@ const findAutomationNodeConstant = async (
   });
 };
 
+/** The action's own declaration from its plugin, e.g. isTargetSource. */
+export const getAutomationActionConstant = async (actionType: string) =>
+  (await findAutomationNodeConstant(actionType, ['actions'])) as
+    | (IAutomationsActionConfig & {
+        output?: TAutomationRuntimeOutputDefinition;
+      })
+    | undefined;
+
 const getAutomationOutputDefinition = async (nodeType: string) =>
   (
     await findAutomationNodeConstant(nodeType, [

package/src/core-modules/automations/types.ts

@@ -157,7 +157,44 @@ export type IAutomationDeferredMarker = {
   timeoutMinutes?: number;
 };
 
-export type IAutomationsActionConfig = {
+export const AUTOMATION_ACTION_CONTRIBUTIONS = {
+  // Acts on a record a sibling branch remembered: the agent picks which one.
+  REMEMBERED_RECORD_CHOICE: 'rememberedRecordChoice',
+} as const;
+
+export type TAutomationActionContribution =
+  (typeof AUTOMATION_ACTION_CONTRIBUTIONS)[keyof typeof AUTOMATION_ACTION_CONTRIBUTIONS];
+
+export type TAutomationRememberConfig = {
+  // What a later step calls the record when it picks one: 'ticket' → the
+  // agent names it as `ticketId`. Not a UI label or a record type.
+  as: string;
+  // Kept with the record so one can be told from another.
+  fields: string[];
+};
+
+export type TAutomationActionPlacement = {
+  /**
+   * Config this action takes when it runs after an action of the given type
+   * on the same path. The node's own config wins over it.
+   */
+  defaultsWhenAfter?: {
+    actionType: string;
+    config: Record<string, unknown>;
+  }[];
+  /**
+   * What this action adds to an earlier action of the given type on its
+   * path. The earlier action must list the kind in `accepts`, so no action
+   * reaches into another's config uninvited.
+   */
+  addsToPrevious?: {
+    actionType: string;
+    kind: TAutomationActionContribution;
+  }[];
+  accepts?: TAutomationActionContribution[];
+};
+
+export type IAutomationsActionConfig = TAutomationActionPlacement & {
   type?: string;
   moduleName?: string;
   collectionName?: string;
@@ -255,6 +292,11 @@ export type TAiContextHistoryItem = {
   meta?: Record<string, unknown>;
 };
 
+export type TAiMemoryScope = {
+  type: string;
+  id: string;
+};
+
 export type TAiContext = {
   version: 1;
   input?: {
@@ -266,6 +308,12 @@ export type TAiContext = {
   facts?: Record<string, unknown>;
   memory?: {
     scopeKey?: string;
+    /**
+     * Everything this run is about, as content type and id — the conversation,
+     * the customer. Long-term memory is written under all of them and read
+     * back by any, so it outlives the channel it was made in.
+     */
+    scopes?: TAiMemoryScope[];
   };
 };
 
@@ -365,6 +413,11 @@ export type TAutomationFindObjectResult = {
     field: string;
     value: string;
   };
+  // A later request about the same matter is added to this record (true) or
+  // starts a new one (false): an open ticket takes it, a resolved one does not.
+  // It says nothing about editing, assigning or reopening — people and other
+  // automations still change the record as before. Absent means true.
+  acceptsFollowUp?: boolean;
 };
 
 type TAutomationAdditionalAttribute = {

package/src/core-modules/automations/utils.ts

@@ -927,6 +927,26 @@ const getAutomationBaseType = (type: string) => {
     : `${pluginName}:${moduleName}`;
 };
 
+// The record an earlier action produced or found: Create returns targetId,
+// Find object returns objectId and the object itself.
+const getTargetActionRecord = (
+  execution: IPropertyProps<unknown>['execution'],
+  targetActionId: string,
+) => {
+  const result = (execution.actions || []).find(
+    ({ actionId }) => actionId === targetActionId,
+  )?.result as
+    | { targetId?: unknown; objectId?: unknown; object?: unknown }
+    | undefined;
+  const object =
+    result?.object && typeof result.object === 'object'
+      ? (result.object as Record<string, unknown>)
+      : {};
+  const id = result?.objectId ?? result?.targetId ?? object._id;
+
+  return { id: id == null ? '' : String(id), object };
+};
+
 export const getSetPropertySelector = async ({
   subdomain,
   module,
@@ -934,6 +954,7 @@ export const getSetPropertySelector = async ({
   targetType,
   relation,
   targetPath,
+  targetActionId,
 }: {
   subdomain: string;
   module: string;
@@ -944,9 +965,17 @@ export const getSetPropertySelector = async ({
     relatedContentType: string;
   };
   targetPath?: string;
+  // Set when the action's target is an earlier action's record, not the
+  // trigger's: the record's id has to come from that action, not the trigger.
+  targetActionId?: string;
 }) => {
-  const target = execution.target || {};
-  const targetId = String(execution.targetId || target._id || '');
+  const actionRecord = targetActionId
+    ? getTargetActionRecord(execution, targetActionId)
+    : undefined;
+  const target = actionRecord ? actionRecord.object : execution.target || {};
+  const targetId = actionRecord
+    ? actionRecord.id
+    : String(execution.targetId || target._id || '');
 
   if (targetPath) {
     const { found, value } = getValueByPath(target, targetPath);

package/src/core-modules/notifications/definitions/emailAddresses.ts

@@ -7,6 +7,15 @@ export type TEmailSuppressionReason =
   | 'screened'
   | 'manual';
 
+export type TEmailScreenReason = 'syntax' | 'no_mx' | 'disposable' | 'random';
+
+export const EMAIL_SCREEN_REASONS: TEmailScreenReason[] = [
+  'syntax',
+  'no_mx',
+  'disposable',
+  'random',
+];
+
 export type TEmailLane = 'proven' | 'unknown' | 'suppressed';
 
 export const EMAIL_LANES: TEmailLane[] = ['proven', 'unknown', 'suppressed'];
@@ -26,6 +35,7 @@ export interface IEmailAddressDocument extends Document {
 
   suppressedAt?: Date;
   suppressionReason?: TEmailSuppressionReason;
+  screenReason?: TEmailScreenReason;
   suppressedBy?: string;
 
   releasedAt?: Date;
@@ -74,6 +84,11 @@ export const emailAddressSchema = new Schema({
     enum: ['hard_bounce', 'complaint', 'unsubscribe', 'screened', 'manual'],
   },
 
+  screenReason: {
+    type: String,
+    enum: EMAIL_SCREEN_REASONS,
+  },
+
   suppressedBy: {
     type: String,
   },

package/utils/dist/erxes-api-shared-utils.cjs.dev.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var startPlugin = require('../../dist/start-plugin-6687b329.cjs.dev.js');
+var startPlugin = require('../../dist/start-plugin-2944ceaa.cjs.dev.js');
 var mongoose = require('mongoose');
 var stream$1 = require('stream');
 var _loadash = require('lodash');

package/utils/dist/erxes-api-shared-utils.cjs.prod.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var startPlugin = require('../../dist/start-plugin-46baacee.cjs.prod.js');
+var startPlugin = require('../../dist/start-plugin-7ebe8e9b.cjs.prod.js');
 var mongoose = require('mongoose');
 var stream$1 = require('stream');
 var _loadash = require('lodash');

package/utils/dist/erxes-api-shared-utils.esm.js

@@ -1,5 +1,5 @@
-import { u as userHeaderName, g as getEnv, c as connect, _ as _asyncToGenerator, a as _regeneratorRuntime, b as coreModelOrganizations, d as getSubdomain, e as getSaasCoreConnection, f as createScopedEventHandlers, h as _slicedToArray, l as logHandler, r as runBeforeResolvers, s as sendWorkerQueue, i as _objectSpread2, j as chunkArray, k as _createForOfIteratorHelper, m as _createClass, n as _classCallCheck, o as isValidURL, p as sendTRPCMessage, q as _inherits, t as _wrapNativeSuper, v as _callSuper, w as _defineProperty, x as _toConsumableArray } from '../../dist/start-plugin-2b3e89f5.esm.js';
-export { K as AGENT_TOOL_DEFAULT_MAX_RESPONSE_BYTES, ak as DEFAULT_JOB_OPTIONS, c1 as EXPECTED_ERROR_NAME, c2 as ExpectedError, aU as GP_STATUS, W as HEADER_SIZE_WARN_BYTES, bc as MAX_HEADER_BYTES, aA as ORGANIZATION_ID_MAPPING, T as TBeforeResolversProducers, V as USER_HEADER_OMITTED_FIELDS, N as agentToolResponseTooLargeError, F as agentToolsAuthHeaderName, y as apolloCustomScalars, bn as applyTrustProxy, bp as authCookieOptions, I as buildAgentToolManifest, bW as buildCursorQuery, ag as buildSearchTokenFilter, D as checkBeforeResolvers, aa as checkCollectionCodeDuplication, bM as checkServiceRunning, by as checkUserIds, j as chunkArray, c4 as classifyError, b$ as cleanHtml, b5 as clearServiceDiscoveryCache, P as clientPortalHeaderName, ad as closeMongooose, X as compactUserForHeader, ah as configureSchemaSearchTokens, c as connect, bo as connectionOptions, ar as coreModelAddons, as as coreModelBundles, av as coreModelEndpoints, ay as coreModelExperiences, at as coreModelInstallations, az as coreModelOrganizationPlanHistories, b as coreModelOrganizations, ax as coreModelPlugins, aw as coreModelPromoCodes, au as coreModelUsers, Q as cpUserHeaderName, c3 as createExpectedError, bL as createHealthRoute, al as createMQWorkerWithListeners, bh as createPluginTRPCContext, bi as createTRPCContext, a8 as cursorPaginate, a9 as cursorPaginateAggregation, bH as dateToShortStr, H as decodeAgentToolsAuthHeader, bV as decodeCursor, bg as decodeTRPCContextHeader, a7 as defaultPaginate, G as encodeAgentToolsAuthHeader, bU as encodeCursor, bf as encodeTRPCContextHeader, bk as err, bu as escapeRegExp, E as expectedErrorPlugin, S as extractCPUserFromHeader, U as extractClientPortalFromHeader, c6 as extractMessage, R as extractUserFromHeader, bx as fixDate, bG as fixNum, bP as flattenObject, z as generateApolloContext, af as generateConfiguredSearchTokens, bN as generateRequestProcess, b3 as getActivePlugins, L as getAgentToolMaxResponseBytes, b4 as getAvailablePlugins, bt as getCoreDomain, bA as getDate, bO as getDiffObjects, g as getEnv, bC as getFullDate, aY as getGlobalProfileV2Plugins, bF as getNextMonth, b6 as getPlugin, ba as getPluginAddress, b1 as getPlugins, bD as getPureDate, e as getSaasCoreConnection, aT as getSaasOrgPromoCodes, aO as getSaasOrganizationActiveAddons, aH as getSaasOrganizationByHelpCenterDomain, aM as getSaasOrganizationDetail, aI as getSaasOrganizationHelpCenterDomains, aB as getSaasOrganizationIdBySubdomain, aN as getSaasOrganizationPlanHistories, aD as getSaasOrganizations, aE as getSaasOrganizationsByFilter, aJ as getSaasOrganizationsWithPendingHelpCenterDomain, aC as getSaasOrgsCache, aR as getSaasPlugin, aQ as getSaasPlugins, aS as getSaasPromoCodes, ai as getSchemaSearchTokenConfig, d as getSubdomain, bB as getToday, bE as getTomorrow, bm as getTrustProxySetting, bz as getUniqueValue, O as graphqlPubsub, aG as helpCenterDomainsOf, c8 as initErxesSentry, bb as initializePluginConfig, a$ as isDev, b9 as isEnabled, c5 as isExpectedError, aV as isGlobalProfileV2, bJ as isImage, o as isValidURL, bK as isVideo, b7 as joinErxesGateway, b0 as keyForConfig, b8 as leaveErxesGateway, l as logHandler, B as markResolvers, a3 as mongoStringRequired, ac as mongooseConnectionOptions, a5 as mongooseField, a2 as mongooseStringNonBlank, a1 as mongooseStringRandomId, a4 as mongooseStringRequiredNonBlank, J as mountAgentTools, bj as ok, M as oversizedAgentToolResultBytes, bq as paginate, aX as pluginsFromStripe, aW as pluginsOfStripeItem, bw as pluralFormation, c0 as random, an as randomAlphanumeric, ao as randomLowercase, bR as readFileFromStorage, bS as readFileStreamFromStorage, bQ as readFileUrl, ap as redis, bs as regexSearchText, bZ as removeExtraSpaces, bY as removeLastTrailingSlash, aP as removeOrgsCache, aL as removeSaasOrganizationHelpCenterDomain, aq as resetConfigsCache, r as runBeforeResolvers, aZ as sanitizeFilename, a_ as sanitizeKey, aK as saveSaasOrganizationHelpCenterDomain, ab as schemaWrapper, bl as sendCoreModuleProducer, p as sendTRPCMessage, am as sendWorkerMessage, s as sendWorkerQueue, c7 as sentryExpectedErrorFilter, b2 as setActivePlugins, Z as setCPUserHeader, $ as setClientPortalHeader, Y as setUserHeader, bI as shortStrToDate, ae as splitSearchWords, b_ as splitStr, a0 as startAfterProcess, C as startBeforeResolvers, bd as startPlugin, bX as stripAnsi, aj as toSerializablePayload, be as trpcContextHeaderName, a6 as updateMongoDocumentOrder, bv as updateOrder, aF as updateSaasOrganization, bT as uploadFileToStorage, u as userHeaderName, br as validSearchText, A as wrapApolloResolvers } from '../../dist/start-plugin-2b3e89f5.esm.js';
+import { u as userHeaderName, g as getEnv, c as connect, _ as _asyncToGenerator, a as _regeneratorRuntime, b as coreModelOrganizations, d as getSubdomain, e as getSaasCoreConnection, f as createScopedEventHandlers, h as _slicedToArray, l as logHandler, r as runBeforeResolvers, s as sendWorkerQueue, i as _objectSpread2, j as chunkArray, k as _createForOfIteratorHelper, m as _createClass, n as _classCallCheck, o as isValidURL, p as sendTRPCMessage, q as _inherits, t as _wrapNativeSuper, v as _callSuper, w as _defineProperty, x as _toConsumableArray } from '../../dist/start-plugin-b4d9fece.esm.js';
+export { K as AGENT_TOOL_DEFAULT_MAX_RESPONSE_BYTES, ak as DEFAULT_JOB_OPTIONS, c1 as EXPECTED_ERROR_NAME, c2 as ExpectedError, aU as GP_STATUS, W as HEADER_SIZE_WARN_BYTES, bc as MAX_HEADER_BYTES, aA as ORGANIZATION_ID_MAPPING, T as TBeforeResolversProducers, V as USER_HEADER_OMITTED_FIELDS, N as agentToolResponseTooLargeError, F as agentToolsAuthHeaderName, y as apolloCustomScalars, bn as applyTrustProxy, bp as authCookieOptions, I as buildAgentToolManifest, bW as buildCursorQuery, ag as buildSearchTokenFilter, D as checkBeforeResolvers, aa as checkCollectionCodeDuplication, bM as checkServiceRunning, by as checkUserIds, j as chunkArray, c4 as classifyError, b$ as cleanHtml, b5 as clearServiceDiscoveryCache, P as clientPortalHeaderName, ad as closeMongooose, X as compactUserForHeader, ah as configureSchemaSearchTokens, c as connect, bo as connectionOptions, ar as coreModelAddons, as as coreModelBundles, av as coreModelEndpoints, ay as coreModelExperiences, at as coreModelInstallations, az as coreModelOrganizationPlanHistories, b as coreModelOrganizations, ax as coreModelPlugins, aw as coreModelPromoCodes, au as coreModelUsers, Q as cpUserHeaderName, c3 as createExpectedError, bL as createHealthRoute, al as createMQWorkerWithListeners, bh as createPluginTRPCContext, bi as createTRPCContext, a8 as cursorPaginate, a9 as cursorPaginateAggregation, bH as dateToShortStr, H as decodeAgentToolsAuthHeader, bV as decodeCursor, bg as decodeTRPCContextHeader, a7 as defaultPaginate, G as encodeAgentToolsAuthHeader, bU as encodeCursor, bf as encodeTRPCContextHeader, bk as err, bu as escapeRegExp, E as expectedErrorPlugin, S as extractCPUserFromHeader, U as extractClientPortalFromHeader, c6 as extractMessage, R as extractUserFromHeader, bx as fixDate, bG as fixNum, bP as flattenObject, z as generateApolloContext, af as generateConfiguredSearchTokens, bN as generateRequestProcess, b3 as getActivePlugins, L as getAgentToolMaxResponseBytes, b4 as getAvailablePlugins, bt as getCoreDomain, bA as getDate, bO as getDiffObjects, g as getEnv, bC as getFullDate, aY as getGlobalProfileV2Plugins, bF as getNextMonth, b6 as getPlugin, ba as getPluginAddress, b1 as getPlugins, bD as getPureDate, e as getSaasCoreConnection, aT as getSaasOrgPromoCodes, aO as getSaasOrganizationActiveAddons, aH as getSaasOrganizationByHelpCenterDomain, aM as getSaasOrganizationDetail, aI as getSaasOrganizationHelpCenterDomains, aB as getSaasOrganizationIdBySubdomain, aN as getSaasOrganizationPlanHistories, aD as getSaasOrganizations, aE as getSaasOrganizationsByFilter, aJ as getSaasOrganizationsWithPendingHelpCenterDomain, aC as getSaasOrgsCache, aR as getSaasPlugin, aQ as getSaasPlugins, aS as getSaasPromoCodes, ai as getSchemaSearchTokenConfig, d as getSubdomain, bB as getToday, bE as getTomorrow, bm as getTrustProxySetting, bz as getUniqueValue, O as graphqlPubsub, aG as helpCenterDomainsOf, c8 as initErxesSentry, bb as initializePluginConfig, a$ as isDev, b9 as isEnabled, c5 as isExpectedError, aV as isGlobalProfileV2, bJ as isImage, o as isValidURL, bK as isVideo, b7 as joinErxesGateway, b0 as keyForConfig, b8 as leaveErxesGateway, l as logHandler, B as markResolvers, a3 as mongoStringRequired, ac as mongooseConnectionOptions, a5 as mongooseField, a2 as mongooseStringNonBlank, a1 as mongooseStringRandomId, a4 as mongooseStringRequiredNonBlank, J as mountAgentTools, bj as ok, M as oversizedAgentToolResultBytes, bq as paginate, aX as pluginsFromStripe, aW as pluginsOfStripeItem, bw as pluralFormation, c0 as random, an as randomAlphanumeric, ao as randomLowercase, bR as readFileFromStorage, bS as readFileStreamFromStorage, bQ as readFileUrl, ap as redis, bs as regexSearchText, bZ as removeExtraSpaces, bY as removeLastTrailingSlash, aP as removeOrgsCache, aL as removeSaasOrganizationHelpCenterDomain, aq as resetConfigsCache, r as runBeforeResolvers, aZ as sanitizeFilename, a_ as sanitizeKey, aK as saveSaasOrganizationHelpCenterDomain, ab as schemaWrapper, bl as sendCoreModuleProducer, p as sendTRPCMessage, am as sendWorkerMessage, s as sendWorkerQueue, c7 as sentryExpectedErrorFilter, b2 as setActivePlugins, Z as setCPUserHeader, $ as setClientPortalHeader, Y as setUserHeader, bI as shortStrToDate, ae as splitSearchWords, b_ as splitStr, a0 as startAfterProcess, C as startBeforeResolvers, bd as startPlugin, bX as stripAnsi, aj as toSerializablePayload, be as trpcContextHeaderName, a6 as updateMongoDocumentOrder, bv as updateOrder, aF as updateSaasOrganization, bT as uploadFileToStorage, u as userHeaderName, br as validSearchText, A as wrapApolloResolvers } from '../../dist/start-plugin-b4d9fece.esm.js';
 import mongoose from 'mongoose';
 import { Transform } from 'stream';
 import { keyBy } from 'lodash';