@aristid/leav-types 1.4.1-9e3f8604 → 1.4.1-a44cd133

package/apps/core/config/default.d.ts

@@ -63,6 +63,13 @@ export declare namespace mailer {
     export { port_1 as port };
     let secure_1: boolean;
     export { secure_1 as secure };
+    export let requireTLS: boolean;
+    export namespace from {
+        let name_1: string;
+        export { name_1 as name };
+        let email_2: string;
+        export { email_2 as email };
+    }
     export namespace auth_1 {
         export let user: string;
         let password_1: string;
@@ -90,12 +97,6 @@ export declare namespace lang {
     let _default: string;
     export { _default as default };
 }
-export declare namespace logs {
-    let level: string;
-    let transport: string;
-    let destinationFile: string;
-    let useJsonFormat: boolean;
-}
 export declare namespace permissions {
     let _default_1: boolean;
     export { _default_1 as default };
@@ -200,6 +201,19 @@ export declare namespace preview {
     let directory_3: string;
     export { directory_3 as directory };
 }
+export declare namespace notification {
+    let enable_3: boolean;
+    export { enable_3 as enable };
+    export namespace email_3 {
+        let enable_4: boolean;
+        export { enable_4 as enable };
+    }
+    export { email_3 as email };
+    export namespace webSocket {
+        let enable_5: boolean;
+        export { enable_5 as enable };
+    }
+}
 export declare namespace applications {
     let rootFolder: string;
 }
@@ -208,10 +222,10 @@ export declare namespace files {
     let originalsPathPrefix: string;
 }
 export declare namespace dbProfiler {
-    let enable_3: boolean;
-    export { enable_3 as enable };
+    let enable_6: boolean;
+    export { enable_6 as enable };
 }
-export declare namespace elasticSearch {
+export declare namespace elasticsearch {
     export let indexPrefix: string;
     let url_2: string;
     export { url_2 as url };

package/apps/core/config/development.d.ts

@@ -1,10 +1,6 @@
 export namespace server {
     let allowIntrospection: boolean;
 }
-export namespace logs {
-    let level: string;
-    let transport: string;
-}
 export namespace auth {
     let refreshTokenExpiration: string;
     namespace cookie {

package/apps/core/config/test.d.ts

@@ -6,6 +6,10 @@ export namespace server {
         let password: string;
         let email: string;
     }
+    namespace systemUser {
+        let email_1: string;
+        export { email_1 as email };
+    }
     let allowIntrospection: boolean;
 }
 export namespace db {
@@ -34,19 +38,43 @@ export namespace indexationManager {
     export { queues_1 as queues };
 }
 export namespace tasksManager {
+    export let checkingInterval: number;
     export namespace queues_2 {
-        let orders: string;
+        let execOrders: string;
+        let cancelOrders: string;
     }
     export { queues_2 as queues };
     export namespace routingKeys_1 {
-        let orders_1: string;
-        export { orders_1 as orders };
+        let execOrders_1: string;
+        export { execOrders_1 as execOrders };
+        let cancelOrders_1: string;
+        export { cancelOrders_1 as cancelOrders };
     }
     export { routingKeys_1 as routingKeys };
 }
 export namespace logs {
     let transport: string;
 }
+export namespace notification {
+    export let enable: boolean;
+    export namespace email_2 {
+        let enable_1: boolean;
+        export { enable_1 as enable };
+    }
+    export { email_2 as email };
+    export namespace webSocket {
+        let enable_2: boolean;
+        export { enable_2 as enable };
+    }
+}
+export namespace mailer {
+    namespace from {
+        let name_1: string;
+        export { name_1 as name };
+        let email_3: string;
+        export { email_3 as email };
+    }
+}
 export let debug: boolean;
 export namespace redis {
     let database: number;

package/apps/core/src/__tests__/e2e/api/e2eUtils.d.ts

@@ -1,3 +1,4 @@
+import type WebSocket from 'ws';
 import type FormData from 'form-data';
 import { type ActionsListConfig } from '_types/actionsList';
 import { type ITreeElement } from '_types/tree';
@@ -41,3 +42,6 @@ export declare function gqlSaveVersionProfile(profileId: string, label: string,
  * Convert object to JSON, escaping quotes to be able to use it in a graphql query
  **/
 export declare function toCleanJSON(obj: {}): string;
+export declare function waitWebSocketMessage<T>(webSocket: WebSocket, acceptMessage: (msg: T) => boolean, { timeoutMs }: {
+    timeoutMs: any;
+}): Promise<T>;

package/apps/core/src/__tests__/e2e/api/export/export.test.d.ts

@@ -0,0 +1 @@
+export {};

package/apps/core/src/__tests__/e2e/api/mailpitUtils.d.ts

@@ -0,0 +1,21 @@
+interface IMailpitMsgLight {
+    From: {
+        Name: string;
+        Address: string;
+    };
+    ID: string;
+    MessageID: string;
+    Read: boolean;
+    Size: number;
+    Subject: string;
+    To: Array<{
+        Name: string;
+        Address: string;
+    }>;
+}
+interface IMailpitMsgFull extends IMailpitMsgLight {
+    HTML: string;
+    Text: string;
+}
+export declare function waitMailpitMessage(acceptMessage: (msg: IMailpitMsgLight) => boolean): Promise<IMailpitMsgFull>;
+export {};

package/apps/core/src/_types/config.d.ts

@@ -1,4 +1,3 @@
-import { type ILoggerConfig } from '@leav/logger';
 import { type Options } from 'amqplib';
 import { type IKeyValue } from './shared';
 export interface IConfig {
@@ -10,7 +9,6 @@ export interface IConfig {
     auth: IAuth;
     mailer: IMailer;
     lang: ILang;
-    logs: ILogs;
     permissions: IPermissions;
     amqp: IAmqp;
     redis: IRedis;
@@ -18,6 +16,7 @@ export interface IConfig {
     indexationManager: IIndexationManager;
     tasksManager: ITasksManager;
     eventsManager: IEventsManager;
+    notification: INotificationConfig;
     debug?: boolean;
     env?: string;
     defaultUserId: string;
@@ -29,7 +28,7 @@ export interface IConfig {
     files: IFilesConfig;
     dbProfiler: IDbProfilerConfig;
     instanceId: string;
-    elasticSearch: IElasticSearchConfig;
+    elasticsearch: IElasticsearchConfig;
     logsCollector: ILogsCollector;
     pluginsPath: string[];
     bugsnag: IBugsnag;
@@ -99,7 +98,18 @@ export interface IAuth {
 export interface IMailer {
     host: string;
     port: number;
+    /**
+     * If true, use SSL/TLS connection (usually port 465). If false, use STARTTLS (usually port 587)
+     */
     secure: boolean;
+    /**
+     * If true, require TLS for the connection (STARTTLS). Only used if secure is false
+     */
+    requireTLS: boolean;
+    from: {
+        name: string;
+        email: string;
+    };
     auth: {
         user: string;
         password: string;
@@ -109,7 +119,6 @@ export interface ILang {
     available: string[];
     default: string;
 }
-export type ILogs = ILoggerConfig;
 export interface IPermissions {
     default: boolean;
     enableCache: boolean;
@@ -225,7 +234,16 @@ export interface IFilesConfig {
 export interface IDbProfilerConfig {
     enable: boolean;
 }
-export interface IElasticSearchConfig {
+export interface INotificationConfig {
+    enable: boolean;
+    email: {
+        enable: boolean;
+    };
+    webSocket: {
+        enable: boolean;
+    };
+}
+export interface IElasticsearchConfig {
     indexPrefix: string;
     url: string;
     ilmPolicyName: string;

package/apps/core/src/_types/forms.d.ts

@@ -22,8 +22,8 @@ export interface IRecordForm {
     sidePanel: IFormSidePanel;
 }
 export declare enum FormElementTypes {
-    field = "field",
-    layout = "layout"
+    FIELD = "field",
+    LAYOUT = "layout"
 }
 export type IFormStrict = Required<IForm>;
 export interface IFormElementsDependency {

package/apps/core/src/_types/notification.d.ts

@@ -0,0 +1,51 @@
+import { type IQueryInfos } from './queryInfos';
+export interface INotification {
+    /**
+     * Timestamp of the notification creation in milliseconds since epoch
+     */
+    date: number;
+    /**
+     * User ID of the notification recipient
+     */
+    recipientUserId: string;
+    content: INotificationContent;
+}
+export interface INotificationContent {
+    level: 'info' | 'warning';
+    title: string;
+    message: string;
+    relatedEntities?: Array<{
+        url: string;
+        label: string;
+    }>;
+    attachments?: Array<{
+        url: string;
+        label: string;
+    }>;
+}
+export interface ICreateNotification {
+    emitterUserId: string;
+    /**
+     * Recipients of the notification, need at least one userId or groupId
+     */
+    recipients: {
+        userIds: string[];
+        /**
+         * No implementation yet
+         */
+        groupIds: string[];
+    };
+    /**
+     * Priority of the notification, may change which channel is used to send it (no yet implemented)
+     */
+    priority: 'urgent' | 'normal';
+    content: INotificationContent;
+}
+export declare enum NotificationChannels {
+    EMAIL = "email",
+    WEB_SOCKET = "web_socket"
+}
+export interface INotificationChannel {
+    type: NotificationChannels;
+    sendNotifications(notifications: INotification[], ctx: IQueryInfos): Promise<void>;
+}

package/apps/core/src/_types/userData.d.ts

@@ -2,3 +2,13 @@ export interface IUserData {
     global: boolean;
     data: any;
 }
+/**
+ * Same idea as IRecordIdentity but for users
+ */
+export interface IUserIdentity {
+    id: string;
+    /**
+     * @throw if user have no email
+     */
+    getEmail: () => Promise<string>;
+}

package/apps/core/src/domain/export/exportDomain.d.ts

@@ -11,6 +11,7 @@ import { type IQueryInfos } from '../../_types/queryInfos';
 import { type IRecordFilterLight } from '../../_types/record';
 import { type ITaskFuncParams } from '../../_types/tasksManager';
 import { type IValidateHelper } from '../helpers/validate';
+import { type INotificationDomain } from 'domain/notification/notificationDomain';
 export interface IExportParams {
     library: string;
     attributes: string[];
@@ -39,8 +40,9 @@ export interface IExportDomainDeps {
     'core.domain.helpers.validate': IValidateHelper;
     'core.domain.helpers.updateTaskProgress': UpdateTaskProgress;
     'core.domain.eventsManager': IEventsManagerDomain;
+    'core.domain.notification': INotificationDomain;
     'core.utils': IUtils;
     translator: i18n;
     config: Config.IConfig;
 }
-export default function ({ config, 'core.domain.record': recordDomain, 'core.domain.helpers.validate': validateHelper, 'core.domain.attribute': attributeDomain, 'core.domain.library': libraryDomain, 'core.domain.tasksManager': tasksManager, 'core.domain.helpers.updateTaskProgress': updateTaskProgress, 'core.domain.eventsManager': eventsManagerDomain, 'core.utils': utils, translator }: IExportDomainDeps): IExportDomain;
+export default function ({ config, 'core.domain.record': recordDomain, 'core.domain.helpers.validate': validateHelper, 'core.domain.attribute': attributeDomain, 'core.domain.library': libraryDomain, 'core.domain.tasksManager': tasksManager, 'core.domain.helpers.updateTaskProgress': updateTaskProgress, 'core.domain.eventsManager': eventsManagerDomain, 'core.domain.notification': notificationDomain, 'core.utils': utils, translator }: IExportDomainDeps): IExportDomain;

package/apps/core/src/domain/logsCollector/logsCollectorDomain.d.ts

@@ -2,7 +2,7 @@ import { type IAmqpService } from '@leav/message-broker';
 import { type ILogger } from '@leav/logger';
 import type * as Config from '_types/config';
 import { type IIndexationService } from '../../infra/indexation/indexationService';
-import { type IElasticSearchService } from '../../infra/elasticSearch/elasticSearchService';
+import { type IElasticsearchService } from '../../infra/elasticsearch/elasticsearchService';
 export interface ILogsCollectorDomain {
     init(): Promise<void>;
 }
@@ -11,6 +11,6 @@ export interface ILogsCollectorDomainDeps {
     'core.infra.amqpService': IAmqpService;
     'core.infra.indexation.indexationService': IIndexationService;
     'core.utils.logger': ILogger;
-    'core.infra.elasticSearch.service': IElasticSearchService;
+    'core.infra.elasticsearch.service': IElasticsearchService;
 }
-export default function ({ config, 'core.infra.amqpService': amqpService, 'core.infra.indexation.indexationService': indexationService, 'core.utils.logger': logger, 'core.infra.elasticSearch.service': esService }: ILogsCollectorDomainDeps): ILogsCollectorDomain;
+export default function ({ config, 'core.infra.amqpService': amqpService, 'core.infra.indexation.indexationService': indexationService, 'core.utils.logger': logger, 'core.infra.elasticsearch.service': esService }: ILogsCollectorDomainDeps): ILogsCollectorDomain;

package/apps/core/src/domain/notification/channels/emailChannel.d.ts

@@ -0,0 +1,12 @@
+import { type INotificationChannel } from '../../../_types/notification';
+import { type IMailerService } from 'infra/mailer/mailerService';
+import { type IUserDomain } from 'domain/user/userDomain';
+import { type IGlobalSettingsDomain } from 'domain/globalSettings/globalSettingsDomain';
+import { type IConfig } from '_types/config';
+export interface INotificationByEmailChannelDeps {
+    config: IConfig;
+    'core.infra.mailer.mailerService': IMailerService;
+    'core.domain.globalSettings': IGlobalSettingsDomain;
+    'core.domain.user': IUserDomain;
+}
+export default function ({ config, 'core.infra.mailer.mailerService': mailerService, 'core.domain.globalSettings': globalSettingsDomain, 'core.domain.user': userDomain }: INotificationByEmailChannelDeps): INotificationChannel;

package/apps/core/src/domain/notification/channels/webSocketChannel.d.ts

@@ -0,0 +1,6 @@
+import { type INotificationChannel } from '../../../_types/notification';
+import { type IEventsManagerDomain } from 'domain/eventsManager/eventsManagerDomain';
+export interface INotificationByWebSocketChannelDeps {
+    'core.domain.eventsManager': IEventsManagerDomain;
+}
+export default function ({ 'core.domain.eventsManager': eventsManagerDomain }: INotificationByWebSocketChannelDeps): INotificationChannel;

package/apps/core/src/domain/notification/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './notificationDomain';
+export { default as emailChannel } from './channels/emailChannel';
+export { default as webSocketChannel } from './channels/webSocketChannel';

package/apps/core/src/domain/notification/notificationDomain.d.ts

@@ -0,0 +1,12 @@
+import { type IConfig } from '_types/config';
+import { type INotificationChannel, type ICreateNotification } from '_types/notification';
+import { type IQueryInfos } from '_types/queryInfos';
+export interface INotificationDomain {
+    createNotification(notification: ICreateNotification, ctx: IQueryInfos): Promise<void>;
+}
+export interface INotificationDomainDeps {
+    'core.domain.notification.emailChannel': INotificationChannel;
+    'core.domain.notification.webSocketChannel': INotificationChannel;
+    config: IConfig;
+}
+export default function ({ 'core.domain.notification.emailChannel': emailChannel, 'core.domain.notification.webSocketChannel': webSocketChannel, config }: INotificationDomainDeps): INotificationDomain;

package/apps/core/src/domain/user/userDomain.d.ts

@@ -6,7 +6,8 @@ import { type IUserDataRepo } from 'infra/userData/userDataRepo';
 import { type IUtils } from 'utils/utils';
 import type * as Config from '_types/config';
 import { type IQueryInfos } from '_types/queryInfos';
-import { type IUserData } from '_types/userData';
+import { type IUserIdentity, type IUserData } from '_types/userData';
+import { type IValueDomain } from 'domain/value/valueDomain';
 interface ISaveUserDataParams {
     key: string;
     value: any;
@@ -15,12 +16,14 @@ interface ISaveUserDataParams {
     ctx: IQueryInfos;
 }
 export interface IUserDomain {
+    getUserIdentity(userId: string, ctx: IQueryInfos): Promise<IUserIdentity>;
     saveUserData(params: ISaveUserDataParams): Promise<IUserData>;
     getUserData(keys: string[], global: boolean, ctx: IQueryInfos): Promise<IUserData>;
     sendResetPasswordEmail(email: string, token: string, login: string, browser: string, os: string, lang: 'fr' | 'en', ctx: IQueryInfos): Promise<void>;
 }
 export interface IUserDomainDeps {
     config: Config.IConfig;
+    'core.domain.value': IValueDomain;
     'core.domain.permissions': IPermissionDomain;
     'core.infra.userData': IUserDataRepo;
     'core.domain.permission': IPermissionDomain;
@@ -32,5 +35,5 @@ export interface IUserDomainDeps {
 export declare enum UserCoreDataKeys {
     CONSULTED_APPS = "applications_consultation"
 }
-export default function ({ config, 'core.infra.userData': userDataRepo, 'core.domain.permission': permissionDomain, 'core.infra.mailer.mailerService': mailerService, 'core.domain.globalSettings': globalSettingsDomain, 'core.utils': utils, translator }: IUserDomainDeps): IUserDomain;
+export default function ({ config, 'core.domain.value': valueDomain, 'core.infra.userData': userDataRepo, 'core.domain.permission': permissionDomain, 'core.infra.mailer.mailerService': mailerService, 'core.domain.globalSettings': globalSettingsDomain, 'core.utils': utils, translator }: IUserDomainDeps): IUserDomain;
 export {};

package/apps/core/src/domain/value/valueDomain.d.ts

@@ -88,11 +88,6 @@ export interface IValueDomain {
         ctx: IQueryInfos;
     }): Promise<IValue>;
     runActionsList(params: IRunActionListParams): Promise<IValue[]>;
-    runActionsListAndFormatOnValue({ library, value, ctx }: {
-        library: string;
-        value: IValue;
-        ctx: IQueryInfos;
-    }): Promise<IValue[]>;
 }
 export interface IValueDomainDeps {
     config: Config.IConfig;

package/apps/core/src/infra/{elasticSearch/elasticSearchService.d.ts → elasticsearch/elasticsearchService.d.ts}

@@ -15,14 +15,14 @@ interface IElasticsearchServiceSearchParams {
     };
     query?: estypes.QueryDslQueryContainer;
 }
-export interface IElasticSearchService {
+export interface IElasticsearchService {
     client: Client;
     search: <T>(params: IElasticsearchServiceSearchParams) => Promise<IElasticsearchServiceSearchResponse<T>>;
     writeData: (indexName: string, data: Log) => Promise<void>;
 }
-export interface IElasticSearchServiceDeps {
-    'core.infra.elasticSearch.client'?: Client;
+export interface IElasticsearchServiceDeps {
+    'core.infra.elasticsearch.client'?: Client;
     config?: IConfig;
 }
-export default function ({ config }: IElasticSearchServiceDeps): IElasticSearchService;
+export default function ({ config }: IElasticsearchServiceDeps): IElasticsearchService;
 export {};

package/apps/core/src/infra/elasticsearch/index.d.ts

@@ -0,0 +1 @@
+export { default as service } from './elasticsearchService';

package/apps/core/src/infra/log/logRepo.d.ts

@@ -1,4 +1,4 @@
-import { type IElasticSearchService } from 'infra/elasticSearch/elasticSearchService';
+import { type IElasticsearchService } from 'infra/elasticsearch/elasticsearchService';
 import { type IConfig } from '_types/config';
 import { type ILogFilters, type ILogPagination, type ILogResponse, type ILogSort } from '_types/log';
 import { type IQueryInfos } from '_types/queryInfos';
@@ -10,8 +10,8 @@ export interface ILogRepo {
     }, ctx: IQueryInfos): Promise<ILogResponse>;
 }
 interface IDeps {
-    'core.infra.elasticSearch.service'?: IElasticSearchService;
+    'core.infra.elasticsearch.service'?: IElasticsearchService;
     config?: IConfig;
 }
-export default function ({ 'core.infra.elasticSearch.service': esService, config }: IDeps): ILogRepo;
+export default function ({ 'core.infra.elasticsearch.service': esService, config }: IDeps): ILogRepo;
 export {};

package/libs/logger/src/LoggerCallStack.d.ts

@@ -0,0 +1,14 @@
+interface ICallerInfo {
+    path: string;
+    line: string;
+    col: string;
+}
+export declare class LoggerCallStack {
+    private callerLineIndexInStack;
+    getCallStackTrace(): string | null;
+    getLocationInfo(): ICallerInfo | null;
+    private getStackLines;
+    private detectCallLineIndexInStack;
+    private callStackTraceLongEnough;
+}
+export {};

package/libs/logger/src/catchErrorFormatter.d.ts

@@ -0,0 +1,2 @@
+import winston from 'winston';
+export declare function catchErrorFormatter(onErrorLog?: (message: string, meta: any, getCallStackTrace: () => string) => void): winston.Logform.FormatWrap | null;

package/libs/logger/src/config.d.ts

@@ -3,7 +3,7 @@ export interface ILoggerConfig {
      * Log level (error, warn, info, log, verbose, debug, silly)
      * @default info
      */
-    level: string;
+    level?: string;
     /**
      * If true, disable all logging
      * Default: true if TS_JEST=1 (tests), false otherwise
@@ -18,7 +18,36 @@ export interface ILoggerConfig {
      * Default: false (plain text)
      */
     useJsonFormat?: boolean;
-    onErrorLog?: (message: string, meta: any) => void;
+    /**
+     * If true, add timestamp to each log line, ISO format
+     */
+    addTimestamp?: boolean;
+    /**
+     * If true, add file and line number of the code that called the logger function (error, warn, info, debug, etc.)
+     */
+    addLocationInfo?: boolean;
+    /**
+     * Add those metadata to all logs
+     */
+    additionalMeta?: {
+        /**
+         * any string to identify the application those logs came from
+         */
+        app?: string;
+        /**
+         * any string to identify each client those logs came from
+         */
+        client?: string;
+        /**
+         * environment, like production, development, test, integration
+         */
+        env?: string;
+        /**
+         * application version, maybe semver format
+         */
+        version?: string;
+    };
+    onErrorLog?: (message: string, meta: any, getCallStackTrace: () => string) => void;
 }
 export declare function envToBool(value: string, defaultValue?: boolean): boolean;
-export declare const defaultLoggerConfig: ILoggerConfig;
+export declare const defaultLoggerConfig: ILoggerConfig & Required<Omit<ILoggerConfig, 'onErrorLog'>>;

package/libs/logger/src/locationInfoFormatter.d.ts

@@ -0,0 +1,2 @@
+import winston from 'winston';
+export declare const addLocationInfoInLog: winston.Logform.FormatWrap;

package/libs/message-broker/src/amqpService.d.ts

@@ -1,5 +1,5 @@
 import * as amqp from 'amqplib';
-import { type IAmqp, type onMessageFunc } from './types/amqp';
+import { type IAmqp, type OnMessageFunc } from './types/amqp';
 export interface IAmqpService {
     publisher: {
         connection: amqp.ChannelModel;
@@ -10,7 +10,7 @@ export interface IAmqpService {
         channel: amqp.ConfirmChannel;
     };
     publish(exchange: string, routingKey: string, msg: string, priority?: number): Promise<void>;
-    consume(queue: string, routingKey: string, onMessage: onMessageFunc, consumerTag?: string): Promise<amqp.Replies.Consume>;
+    consume(queue: string, routingKey: string, onMessage: OnMessageFunc, consumerTag?: string): Promise<amqp.Replies.Consume>;
     close(): Promise<void>;
 }
 interface IDeps {

package/libs/message-broker/src/types/amqp.d.ts

@@ -12,4 +12,4 @@ export interface IAmqpConn {
 export interface IMessageBody {
     [key: string]: any;
 }
-export type onMessageFunc = (msg: amqp.ConsumeMessage) => Promise<void>;
+export type OnMessageFunc = (msg: amqp.ConsumeMessage) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aristid/leav-types",
-  "version": "1.4.1-9e3f8604",
+  "version": "1.4.1-a44cd133",
   "description": "Shared Leav types",
   "scripts": {
     "tscheck": "",

package/apps/core/src/infra/elasticSearch/index.d.ts

@@ -1 +0,0 @@
-export { default as service } from './elasticSearchService';

package/libs/logger/src/locationInfoFormatters.d.ts

@@ -1,10 +0,0 @@
-import winston from 'winston';
-interface ICallerInfo {
-    path: string;
-    line: string;
-    col: string;
-}
-export declare function getLocationInfo(): ICallerInfo | null;
-export declare const addLocationInfoInLog: winston.Logform.FormatWrap;
-export declare const mergeLocationInfoInLog: winston.Logform.FormatWrap;
-export {};