@erxes/api-shared 0.0.0-stage → 3.2.19-1

package/src/core-types/common.ts

@@ -0,0 +1,183 @@
+import { GraphQLResolveInfo } from 'graphql';
+import { SortOrder } from 'mongoose';
+import { IUserDocument } from './modules/team-member/user';
+import { Request as ApiRequest } from 'express';
+import { ScopedEventHandlers } from '../core-modules';
+
+export interface IRule {
+  kind: string;
+  text: string;
+  condition: string;
+  value: string;
+}
+
+export interface ILink {
+  [key: string]: string;
+}
+
+export interface IRuleDocument extends IRule, Document {
+  _id: string;
+}
+
+export interface IOffsetPaginateParams {
+  limit?: number;
+  page?: number;
+  perPage?: number;
+
+  sortField?: string;
+  sortDirection?: SortOrder;
+}
+
+export interface ICursorPaginateParams {
+  limit?: number;
+  cursor?: string;
+  direction?: 'forward' | 'backward';
+  cursorMode?: 'inclusive' | 'exclusive';
+  orderBy?: Record<string, SortOrder>;
+}
+
+export interface ICursorPaginateResult<T> {
+  list: T[];
+  pageInfo: {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor: string | null;
+    endCursor: string | null;
+  };
+  totalCount: number;
+}
+
+export interface IListParams extends ICursorPaginateParams {
+  searchValue?: string;
+  sortField?: string;
+}
+
+export interface IStringMap {
+  [key: string]: string;
+}
+
+export interface ICustomField {
+  field: string;
+  value: any;
+  stringValue?: string;
+  numberValue?: number;
+  dateValue?: Date;
+  locationValue?: ILocationOption;
+  extraValue?: string;
+}
+
+export interface IPropertyField {
+  [key: string]:
+    | string
+    | number
+    | boolean
+    | Date
+    | Array<string | number | boolean | Date>
+    | null;
+}
+
+export interface IBrowserInfo {
+  language?: string;
+  url?: string;
+  city?: string;
+  countryCode?: string;
+}
+
+export interface IAttachment {
+  name: string;
+  url: string;
+  size: number;
+  type: string;
+}
+
+export interface IPdfAttachment {
+  pdf?: IAttachment;
+  pages: IAttachment[];
+}
+
+export interface IMainContext {
+  res: any;
+  req: ApiRequest;
+  requestInfo: any;
+  user: IUserDocument;
+  cpUser?: any;
+  clientPortal?: any;
+  models?: any;
+  __: <T extends object>(doc: T) => T & { processId: string };
+  processId: string;
+  eventHandlers: ScopedEventHandlers;
+  checkPermission: (action: string, ownerId?: string) => Promise<void>;
+}
+
+export interface IOrderInput {
+  _id: string;
+  order: number;
+}
+
+export interface IAttachment {
+  name: string;
+  url: string;
+  size: number;
+  type: string;
+}
+
+export interface IPageInfo {
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+  startCursor: string | null;
+  endCursor: string | null;
+}
+
+export interface IResolverSymbol {
+  wrapperConfig?: {
+    skipPermission?: boolean;
+    forClientPortal?: boolean;
+    cpUserRequired?: boolean;
+  };
+}
+
+export type Resolver<
+  Parent = any,
+  Args = any,
+  Context = { subdomain: string } & IMainContext,
+  Result = any,
+> = {
+  resolve(
+    parent: Parent,
+    args: Args,
+    context: Context,
+    info: GraphQLResolveInfo,
+  ): Promise<Result> | Result;
+}['resolve'] &
+  Partial<IResolverSymbol>;
+
+export interface ILocationOption {
+  lat: number;
+  lng: number;
+  description?: string;
+}
+
+/**
+ * Where a record came from, when nobody typed it in.
+ *
+ * `createdBy` answers who owns a record; this answers what produced it — a
+ * campaign, an automation, an import. The two are not the same claim: a task
+ * opened by a campaign belongs to the person whose campaign it was, but they
+ * never pressed create, and only this says so.
+ */
+export type TCreatedVia = {
+  /** What kind of thing produced it: `broadcast`, `automation`, `import`, … */
+  source: string;
+  /** The configuration that produced it — a campaign, an automation. */
+  sourceId: string;
+  /**
+   * What that configuration was called at the time. Kept rather than looked
+   * up: a record explains itself without a join, and renaming the campaign
+   * later must not rewrite what already happened.
+   */
+  sourceName?: string;
+  /** The single run of that configuration, when there is one to point at. */
+  runId?: string;
+  /** Whose configuration it was. Absent when nobody asked — an event did. */
+  actorId?: string;
+};

package/src/core-types/index.ts

@@ -0,0 +1,19 @@
+export * from './common';
+export * from './modules/app/app';
+export * from './modules/contacts/company';
+export * from './modules/contacts/contacts-common';
+export * from './modules/contacts/customer';
+export * from './modules/permissions/permission';
+export * from './modules/permissions/role';
+export * from './modules/products/product';
+export * from './modules/products/productCategory';
+export * from './modules/products/productConfig';
+export * from './modules/products/uom';
+export * from './modules/tags/tag';
+export * from './modules/team-member/structure';
+export * from './modules/team-member/user';
+export * from './modules/relations/relations';
+export * from './modules/logs/logs';
+export * from './modules/automations/automations';
+export * from './modules/emailTemplates/emailTemplate';
+export * from './modules/saas/organization';

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

@@ -0,0 +1,13 @@
+import { Document } from 'mongoose';
+
+export interface IApp {
+  name: string;
+}
+
+export interface IAppDocument extends IApp, Document {
+  _id: string;
+  token: string;
+  status: string; // 'active' | 'revoked'
+  lastUsedAt?: Date;
+  createdAt: Date;
+}

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

@@ -0,0 +1,23 @@
+import {
+  IAutomationAction,
+  IAutomationExecution,
+  IAutomationTrigger,
+} from '../../../core-modules/automations/definitions';
+
+
+export type ICheckTriggerData = {
+  collectionType: string;
+  automationId: string;
+  trigger: IAutomationTrigger;
+  target: any;
+  config: any;
+};
+
+export type IAutomationReceiveActionData = {
+  action: IAutomationAction;
+  execution: { _id: string } & IAutomationExecution;
+  actionType: string;
+  collectionType: string;
+  triggerType: string;
+  targetType: string;
+};

package/src/core-types/modules/contacts/company.ts

@@ -0,0 +1,70 @@
+import { Document } from 'mongoose';
+import {
+  ICursorPaginateParams,
+  ICustomField,
+  IListParams,
+  IPropertyField,
+  IStringMap,
+} from '../../common';
+import { IAddress } from './contacts-common';
+
+export interface ICompany {
+  scopeBrandIds?: string[];
+  primaryName?: string;
+  avatar?: string;
+  names?: string[];
+  size?: number;
+  industry?: string;
+  parentCompanyId?: string;
+
+  primaryEmail?: string;
+  emails?: string[];
+  primaryAddress?: IAddress;
+  addresses?: IAddress[];
+
+  ownerId?: string;
+
+  primaryPhone?: string;
+  phones?: string[];
+
+  mergedIds?: string[];
+  status?: string;
+  businessType?: string;
+  description?: string;
+  employees?: number;
+  isSubscribed?: string;
+  links?: IStringMap;
+  tagIds?: string[];
+  customFieldsData?: ICustomField[];
+  propertiesData?: IPropertyField;
+  trackedData?: ICustomField[];
+  website?: string;
+  code?: string;
+  location?: string;
+}
+
+export interface ICompanyDocument extends ICompany, Document {
+  _id: string;
+  status?: string;
+  createdAt: Date;
+  updatedAt: Date;
+  searchText: string;
+  score?: number;
+}
+
+export interface ICompanyFilterQueryParams
+  extends IListParams,
+    ICursorPaginateParams {
+  status?: string;
+  createdAt?: Date;
+  dateFilters?: string;
+
+  tagIds?: string[];
+  excludeTagIds?: string[];
+  tagWithRelated?: boolean;
+
+  integrationIds?: string[];
+  integrationTypes?: string[];
+
+  brandIds?: string[];
+}

package/src/core-types/modules/contacts/contacts-common.ts

@@ -0,0 +1,32 @@
+export interface IAddress {
+  id: string; // lng_lat || random
+  location: {
+    type: string;
+    coordinates: number[];
+  };
+  address: {
+    countryCode: string;
+    country: string;
+    postCode: string;
+    city: string;
+    city_district: string;
+    suburb: string;
+    road: string;
+    street: string;
+    building: string;
+    number: string;
+    other: string;
+  };
+  short: string;
+}
+
+export interface ILocation {
+  remoteAddress: string;
+  country: string;
+  countryCode: string;
+  city: string;
+  region: string;
+  hostname: string;
+  language: string;
+  userAgent: string;
+}

package/src/core-types/modules/contacts/customer.ts

@@ -0,0 +1,94 @@
+import { Document } from 'mongoose';
+
+import {
+  ICursorPaginateParams,
+  ICustomField,
+  IListParams,
+  IStringMap,
+  IPropertyField,
+} from '../../common';
+import { IAddress, ILocation } from './contacts-common';
+
+export interface IVisitorContact {
+  email?: string;
+  phone?: string;
+}
+
+export interface ICustomer {
+  state?: 'visitor' | 'lead' | 'customer';
+
+  scopeBrandIds?: string[];
+  firstName?: string;
+  lastName?: string;
+  middleName?: string;
+  birthDate?: Date;
+  sex?: number;
+  primaryEmail?: string;
+  emails?: string[];
+  avatar?: string;
+  primaryPhone?: string;
+  phones?: string[];
+  primaryAddress?: IAddress;
+  addresses?: IAddress[];
+
+  ownerId?: string;
+  position?: string;
+  department?: string;
+  leadStatus?: string;
+  hasAuthority?: string;
+  description?: string;
+  doNotDisturb?: string;
+  isSubscribed?: string;
+  emailValidationStatus?: string;
+  phoneValidationStatus?: string;
+  links?: IStringMap;
+  status?: string;
+  code?: string;
+  integrationId?: string;
+  clientPortalId?: string;
+  tagIds?: string[];
+
+  mergedIds?: string[];
+  relatedIntegrationIds?: string[];
+  deviceTokens?: string[];
+  trackedData?: ICustomField[];
+  customFieldsData?: ICustomField[];
+  propertiesData?: IPropertyField;
+  lastSeenAt?: Date;
+  isOnline?: boolean;
+  sessionCount?: number;
+  visitorContactInfo?: IVisitorContact;
+}
+
+export interface ICustomerDocument extends ICustomer, Document {
+  _id: string;
+  createdAt: Date;
+  updatedAt: Date;
+
+  location?: ILocation;
+  searchText?: string;
+  searchTokens?: string[];
+}
+
+export interface ICustomerQueryFilterParams
+  extends ICursorPaginateParams, IListParams {
+  createdAt?: Date;
+  type?: string;
+  status?: string;
+  dateFilters?: string;
+  propertiesData?: string;
+
+  tagIds?: string[];
+  excludeTagIds?: string[];
+  tagWithRelated?: boolean;
+
+  /** Membership as the segmentation worker materialised it onto the record. */
+  segmentIds?: string[];
+
+  integrationIds?: string[];
+  integrationTypes?: string[];
+
+  brandIds?: string[];
+
+  clientPortalId?: string;
+}

package/src/core-types/modules/emailTemplates/emailTemplate.ts

@@ -0,0 +1,19 @@
+import { Document } from 'mongoose';
+import { TEmailContentFormat } from '../../../core-modules/email-content/types';
+
+export interface IEmailTemplate {
+  name: string;
+  description?: string;
+  /** Block content, as every template was written before the email editor. */
+  content?: string;
+  /** The email editor's own document. */
+  contentJson?: Record<string, any>;
+  contentFormat?: TEmailContentFormat;
+  createdBy: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface IEmailTemplateDocument extends IEmailTemplate, Document {
+  _id: string;
+}

package/src/core-types/modules/emailTemplates/index.ts

@@ -0,0 +1 @@
+export * from './emailTemplate';

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

@@ -0,0 +1,30 @@
+import { Document } from 'mongoose';
+
+export interface ILogDoc {
+  subdomain: string;
+  source: 'webhook' | 'graphql' | 'mongo' | 'auth';
+  action: string;
+  payload: any;
+  userId?: string;
+  executionTime?: {
+    startDate: Date;
+    endDate: Date;
+    durationMs: number;
+  };
+  status?: 'failed' | 'success';
+  processId?: string;
+}
+
+export interface ILog {
+  createdAt: Date;
+  userId?: string;
+  status: string;
+  payload?: any;
+  action?: string;
+  docId?: string;
+  source: string;
+}
+
+export interface ILogDocument extends Document, ILog {
+  _id: string;
+}

package/src/core-types/modules/permissions/permission.ts

@@ -0,0 +1,63 @@
+export interface IPermissionAction {
+  title: string;
+  name: string;
+  description: string;
+  oauthScope?: string;
+  oauthScopes?: string[];
+  always?: boolean;
+  disabled?: boolean;
+  type?: 'resolver' | 'custom';
+}
+
+export interface IPermissionScope {
+  name: 'own' | 'group' | 'all';
+  description: string;
+}
+
+export interface IPermissionModule {
+  name: string;
+  description?: string;
+  scopes: IPermissionScope[];
+  scopeField?: string | null;
+  ownerFields?: string[];
+  actions: IPermissionAction[];
+  always?: boolean;
+}
+
+export interface IPermissionGroupPermission {
+  plugin: string;
+  module: string;
+  actions: string[];
+  scope: 'own' | 'group' | 'all';
+}
+
+export interface IDefaultPermissionGroup {
+  id: string;
+  name: string;
+  description: string;
+  permissions: IPermissionGroupPermission[];
+}
+
+export interface IPermissionConfig {
+  plugin: string;
+  modules: IPermissionModule[];
+
+  defaultGroups?: IDefaultPermissionGroup[];
+}
+
+export interface IPermissionGroup {
+  name: string;
+  description?: string;
+  permissions: IPermissionGroupPermission[];
+}
+
+export interface IPermissionGroupDocument extends IPermissionGroup, Document {
+  _id: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+export interface IPermissionInput {
+  module: string;
+  actions: string[];
+  scope: 'own' | 'group' | 'all';
+}

package/src/core-types/modules/permissions/role.ts

@@ -0,0 +1,24 @@
+import { Document } from 'mongoose';
+import { ICursorPaginateParams } from '../../common';
+
+export enum Roles {
+  OWNER = 'owner',
+  ADMIN = 'admin',
+  MEMBER = 'member',
+}
+export interface IRole {
+  userId: string;
+  role: Roles;
+}
+
+export interface IRoleDocument extends IRole, Document {
+  _id: string;
+
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface IRoleParams extends ICursorPaginateParams {
+  userId: string;
+  role: Roles;
+}

package/src/core-types/modules/products/product.ts

@@ -0,0 +1,100 @@
+import {
+  IAttachment,
+  ICustomField,
+  IPdfAttachment,
+  IPropertyField,
+} from '../../common';
+import { Document } from 'mongoose';
+
+interface ISubUom {
+  uom: string;
+  ratio: number;
+}
+
+interface IInventory {
+  [branchId: string]: {
+    [departmentId: string]: {
+      remainder: number;
+      cost: number;
+      soonIn: number;
+      soonOut: number;
+    };
+  };
+}
+
+export type ProductDiscountConditionValue =
+  | string
+  | number
+  | boolean
+  | string[]
+  | number[]
+  | {
+      start?: string | number;
+      end?: string | number;
+    };
+
+export interface IDiscount {
+  planId: string;
+  discount: number;
+  discountPercent: number;
+  prefixes: string[];
+  conditions: Record<string, ProductDiscountConditionValue>;
+}
+
+export type ProductDurationType =
+  | 'minute'
+  | 'hour'
+  | 'day'
+  | 'week'
+  | 'month'
+  | 'quarter'
+  | 'year';
+
+export interface IProduct {
+  name: string;
+  shortName?: string;
+  categoryId?: string;
+  categoryCode?: string;
+  type?: string;
+  scopeBrandIds?: string[];
+  description?: string;
+  barcodes?: string[];
+  variants: { [code: string]: { image?: IAttachment; name?: string } };
+  barcodeDescription?: string;
+  unitPrice?: number;
+  weight?: number;
+  code: string;
+  customFieldsData?: ICustomField[];
+  propertiesData?: IPropertyField;
+  tagIds?: string[];
+  attachment?: IAttachment;
+  attachmentMore?: IAttachment[];
+  videos?: IAttachment[];
+  status?: string;
+  vendorId?: string;
+  vendorCode?: string;
+
+  mergedIds?: string[];
+
+  uom?: string;
+  // Codes of the conditions a sold unit of this product may be marked with.
+  conditionCodes?: string[];
+  subUoms?: ISubUom[];
+  sameMasks?: string[];
+  sameDefault?: string[];
+  currency?: string;
+  duration?: number;
+  durationType?: ProductDurationType;
+
+  pdfAttachment?: IPdfAttachment;
+
+  inventories?: IInventory;
+  discounts?: IDiscount[];
+
+  similarityId?: string;
+}
+
+export interface IProductDocument extends IProduct, Document {
+  _id: string;
+  createdAt: Date;
+}

package/src/core-types/modules/products/productCategory.ts

@@ -0,0 +1,27 @@
+import { Document } from 'mongoose';
+
+export interface IProductCategory {
+  name: string;
+  code: string;
+  order: string;
+  scopeBrandIds?: string[];
+  description?: string;
+  meta?: string;
+  parentId?: string;
+  attachment?: any;
+  status?: string;
+  maskType?: string;
+  mask?: any;
+  isSimilarity?: boolean;
+  similarities?: {
+    id: string;
+    groupId: string;
+    fieldId: string;
+    title: string;
+  }[];
+}
+
+export interface IProductCategoryDocument extends IProductCategory, Document {
+  _id: string;
+  createdAt: Date;
+}