@aristid/leav-types 1.4.1-8dd5ba55 → 1.4.1-94f48449

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -63,6 +63,7 @@ export declare namespace mailer {
63
63
  export { port_1 as port };
64
64
  let secure_1: boolean;
65
65
  export { secure_1 as secure };
66
+ export let requireTLS: boolean;
66
67
  export namespace from {
67
68
  let name_1: string;
68
69
  export { name_1 as name };
@@ -121,7 +122,8 @@ export declare namespace redis {
121
122
  export { host_2 as host };
122
123
  let port_3: string;
123
124
  export { port_3 as port };
124
- export let database: number;
125
+ export let cacheDatabase: number;
126
+ export let sessionDatabase: number;
125
127
  }
126
128
  export declare namespace filesManager {
127
129
  namespace queues {
@@ -6,6 +6,10 @@ export namespace server {
6
6
  let password: string;
7
7
  let email: string;
8
8
  }
9
+ namespace systemUser {
10
+ let email_1: string;
11
+ export { email_1 as email };
12
+ }
9
13
  let allowIntrospection: boolean;
10
14
  }
11
15
  export namespace db {
@@ -22,33 +26,64 @@ export namespace filesManager {
22
26
  }
23
27
  }
24
28
  export namespace eventsManager {
25
- namespace routingKeys {
29
+ export namespace routingKeys {
26
30
  let data_events: string;
31
+ let pubsub_events: string;
32
+ }
33
+ export namespace queues_1 {
34
+ let pubsub_events_1: string;
35
+ export { pubsub_events_1 as pubsub_events };
27
36
  }
37
+ export { queues_1 as queues };
28
38
  }
29
39
  export namespace indexationManager {
30
- export namespace queues_1 {
40
+ export namespace queues_2 {
31
41
  let events_1: string;
32
42
  export { events_1 as events };
33
43
  }
34
- export { queues_1 as queues };
44
+ export { queues_2 as queues };
35
45
  }
36
46
  export namespace tasksManager {
37
- export namespace queues_2 {
38
- let orders: string;
47
+ export let checkingInterval: number;
48
+ export namespace queues_3 {
49
+ let execOrders: string;
50
+ let cancelOrders: string;
39
51
  }
40
- export { queues_2 as queues };
52
+ export { queues_3 as queues };
41
53
  export namespace routingKeys_1 {
42
- let orders_1: string;
43
- export { orders_1 as orders };
54
+ let execOrders_1: string;
55
+ export { execOrders_1 as execOrders };
56
+ let cancelOrders_1: string;
57
+ export { cancelOrders_1 as cancelOrders };
44
58
  }
45
59
  export { routingKeys_1 as routingKeys };
46
60
  }
47
61
  export namespace logs {
48
62
  let transport: string;
49
63
  }
64
+ export namespace notification {
65
+ export let enable: boolean;
66
+ export namespace email_2 {
67
+ let enable_1: boolean;
68
+ export { enable_1 as enable };
69
+ }
70
+ export { email_2 as email };
71
+ export namespace webSocket {
72
+ let enable_2: boolean;
73
+ export { enable_2 as enable };
74
+ }
75
+ }
76
+ export namespace mailer {
77
+ namespace from {
78
+ let name_1: string;
79
+ export { name_1 as name };
80
+ let email_3: string;
81
+ export { email_3 as email };
82
+ }
83
+ }
50
84
  export let debug: boolean;
51
85
  export namespace redis {
52
- let database: number;
86
+ let cacheDatabase: number;
87
+ let sessionDatabase: number;
53
88
  }
54
89
  export let pluginsPath: string[];
@@ -1,3 +1,5 @@
1
+ import WebSocket from 'ws';
2
+ import { type Client as GraphqlWsClient } from 'graphql-ws';
1
3
  import type FormData from 'form-data';
2
4
  import { type ActionsListConfig } from '_types/actionsList';
3
5
  import { type ITreeElement } from '_types/tree';
@@ -41,3 +43,10 @@ export declare function gqlSaveVersionProfile(profileId: string, label: string,
41
43
  * Convert object to JSON, escaping quotes to be able to use it in a graphql query
42
44
  **/
43
45
  export declare function toCleanJSON(obj: {}): string;
46
+ export declare function makeWebSocketGraphQlCall(): Promise<GraphqlWsClient>;
47
+ export declare function waitGraphqlWebSocketMessage<T>(client: GraphqlWsClient, query: string, variables: Record<string, any>, acceptMessage: (msg: T) => boolean, { timeoutMs }: {
48
+ timeoutMs: any;
49
+ }): Promise<T>;
50
+ export declare function waitWebSocketMessage<T>(webSocket: WebSocket, acceptMessage: (msg: T) => boolean, { timeoutMs }: {
51
+ timeoutMs: any;
52
+ }): Promise<T>;
@@ -0,0 +1,21 @@
1
+ interface IMailpitMsgLight {
2
+ From: {
3
+ Name: string;
4
+ Address: string;
5
+ };
6
+ ID: string;
7
+ MessageID: string;
8
+ Read: boolean;
9
+ Size: number;
10
+ Subject: string;
11
+ To: Array<{
12
+ Name: string;
13
+ Address: string;
14
+ }>;
15
+ }
16
+ interface IMailpitMsgFull extends IMailpitMsgLight {
17
+ HTML: string;
18
+ Text: string;
19
+ }
20
+ export declare function waitMailpitMessage(acceptMessage: (msg: IMailpitMsgLight) => boolean): Promise<IMailpitMsgFull>;
21
+ export {};
@@ -98,7 +98,14 @@ export interface IAuth {
98
98
  export interface IMailer {
99
99
  host: string;
100
100
  port: number;
101
+ /**
102
+ * If true, use SSL/TLS connection (usually port 465). If false, use STARTTLS (usually port 587)
103
+ */
101
104
  secure: boolean;
105
+ /**
106
+ * If true, require TLS for the connection (STARTTLS). Only used if secure is false
107
+ */
108
+ requireTLS: boolean;
102
109
  from: {
103
110
  name: string;
104
111
  email: string;
@@ -125,7 +132,8 @@ export interface IAmqp {
125
132
  export interface IRedis {
126
133
  host: string;
127
134
  port: number;
128
- database: number;
135
+ cacheDatabase: number;
136
+ sessionDatabase: number;
129
137
  }
130
138
  export interface IFilesManager {
131
139
  queues: {
@@ -1,8 +1,16 @@
1
+ import { type INotificationContent } from './notification';
1
2
  export declare enum TriggerNames {
2
3
  APPLICATION_EVENT = "APPLICATION_EVENT",
3
4
  UPLOAD_FILE = "UPLOAD_FILE",
4
5
  INDEXATION = "INDEXATION",
5
6
  TASK = "TASK",
6
7
  TREE_EVENT = "TREE_EVENT",
7
- RECORD_UPDATE = "RECORD_UPDATE"
8
+ RECORD_UPDATE = "RECORD_UPDATE",
9
+ NOTIFICATION = "NOTIFICATION"
10
+ }
11
+ export interface IPubSubNotificationData {
12
+ notification: INotificationContent & {
13
+ date: number;
14
+ };
15
+ recipientUserIds: string[];
8
16
  }
@@ -2,3 +2,13 @@ export interface IUserData {
2
2
  global: boolean;
3
3
  data: any;
4
4
  }
5
+ /**
6
+ * Same idea as IRecordIdentity but for users
7
+ */
8
+ export interface IUserIdentity {
9
+ id: string;
10
+ /**
11
+ * @throw if user have no email
12
+ */
13
+ getEmail: () => Promise<string>;
14
+ }
@@ -4,7 +4,6 @@ import { type IUserDomain } from 'domain/user/userDomain';
4
4
  import { type IValueDomain } from 'domain/value/valueDomain';
5
5
  import { type Response } from 'express';
6
6
  import { type IConfig } from '_types/config';
7
- import { type ICachesService } from '../../infra/cache/cacheService';
8
7
  import { type ITokenUserData } from '../../_types/auth';
9
8
  import { type IRequestWithContext } from '../../_types/express';
10
9
  import { type ILogger } from '@leav/logger';
@@ -16,6 +15,7 @@ import { type IRecordRepo } from '../../infra/record/recordRepo';
16
15
  import { type IGraphqlAppModule } from 'app/graphql/graphqlApp';
17
16
  import { type IServerRouteAppModule } from 'interface/server';
18
17
  import { type GetSystemQueryContext } from 'utils/helpers/getSystemQueryContext';
18
+ import { type ISessionRepo } from '../../infra/session/sessionRepo';
19
19
  export interface IAuthApp extends IGraphqlAppModule, IServerRouteAppModule {
20
20
  validateRequestToken(params: {
21
21
  apiKey?: string;
@@ -30,12 +30,12 @@ export interface IAuthAppDeps {
30
30
  'core.infra.record': IRecordRepo;
31
31
  'core.domain.apiKey': IApiKeyDomain;
32
32
  'core.domain.user': IUserDomain;
33
- 'core.infra.cache.cacheService': ICachesService;
34
33
  'core.utils.logger': ILogger;
35
34
  'core.infra.oidc.oidcClientService': IOIDCClientService;
36
35
  'core.app.helpers.initQueryContext': InitQueryContextFunc;
37
36
  'core.app.helpers.convertOIDCIdentifier': IConvertOIDCIdentifier;
38
37
  'core.utils.getSystemQueryContext': GetSystemQueryContext;
39
38
  config: IConfig;
39
+ 'core.infra.session': ISessionRepo;
40
40
  }
41
- export default function ({ 'core.domain.value': valueDomain, 'core.domain.record': recordDomain, 'core.infra.record': recordRepo, 'core.domain.apiKey': apiKeyDomain, 'core.domain.user': userDomain, 'core.utils.logger': logger, 'core.infra.cache.cacheService': cacheService, 'core.infra.oidc.oidcClientService': oidcClientService, 'core.app.helpers.initQueryContext': initQueryContext, 'core.app.helpers.convertOIDCIdentifier': convertOIDCIdentifier, 'core.utils.getSystemQueryContext': getSystemQueryContext, config }: IAuthAppDeps): IAuthApp;
41
+ export default function ({ 'core.domain.value': valueDomain, 'core.domain.record': recordDomain, 'core.infra.record': recordRepo, 'core.domain.apiKey': apiKeyDomain, 'core.domain.user': userDomain, 'core.utils.logger': logger, 'core.infra.oidc.oidcClientService': oidcClientService, 'core.app.helpers.initQueryContext': initQueryContext, 'core.app.helpers.convertOIDCIdentifier': convertOIDCIdentifier, 'core.utils.getSystemQueryContext': getSystemQueryContext, 'core.infra.session': sessionRepo, config }: IAuthAppDeps): IAuthApp;
@@ -17,6 +17,7 @@ export { default as permission } from './permissionApp/permissionApp';
17
17
  export { default as plugins } from './pluginsApp';
18
18
  export { default as record } from './recordApp/recordApp';
19
19
  export { default as tasksManager } from './tasksManagerApp';
20
+ export { default as notification } from './notificationApp';
20
21
  export { default as tree } from './treeApp/treeApp';
21
22
  export { default as userData } from './userDataApp';
22
23
  export { default as value } from './valueApp';
@@ -0,0 +1,10 @@
1
+ import { type IGraphqlAppModule } from 'app/graphql/graphqlApp';
2
+ import { type IEventsManagerDomain } from 'domain/eventsManager/eventsManagerDomain';
3
+ import { type IUtils } from 'utils/utils';
4
+ export type INotificationApp = IGraphqlAppModule;
5
+ interface IDeps {
6
+ 'core.utils'?: IUtils;
7
+ 'core.domain.eventsManager'?: IEventsManagerDomain;
8
+ }
9
+ export default function ({ 'core.domain.eventsManager': eventsManager }: IDeps): INotificationApp;
10
+ export {};
@@ -1,6 +1,12 @@
1
1
  import { type INotificationChannel } from '../../../_types/notification';
2
2
  import { type IMailerService } from 'infra/mailer/mailerService';
3
+ import { type IUserDomain } from 'domain/user/userDomain';
4
+ import { type IGlobalSettingsDomain } from 'domain/globalSettings/globalSettingsDomain';
5
+ import { type IConfig } from '_types/config';
3
6
  export interface INotificationByEmailChannelDeps {
7
+ config: IConfig;
4
8
  'core.infra.mailer.mailerService': IMailerService;
9
+ 'core.domain.globalSettings': IGlobalSettingsDomain;
10
+ 'core.domain.user': IUserDomain;
5
11
  }
6
- export default function ({ 'core.infra.mailer.mailerService': mailerService }: INotificationByEmailChannelDeps): INotificationChannel;
12
+ export default function ({ config, 'core.infra.mailer.mailerService': mailerService, 'core.domain.globalSettings': globalSettingsDomain, 'core.domain.user': userDomain }: INotificationByEmailChannelDeps): INotificationChannel;
@@ -6,7 +6,8 @@ import { type IUserDataRepo } from 'infra/userData/userDataRepo';
6
6
  import { type IUtils } from 'utils/utils';
7
7
  import type * as Config from '_types/config';
8
8
  import { type IQueryInfos } from '_types/queryInfos';
9
- import { type IUserData } from '_types/userData';
9
+ import { type IUserIdentity, type IUserData } from '_types/userData';
10
+ import { type IValueDomain } from 'domain/value/valueDomain';
10
11
  interface ISaveUserDataParams {
11
12
  key: string;
12
13
  value: any;
@@ -15,12 +16,14 @@ interface ISaveUserDataParams {
15
16
  ctx: IQueryInfos;
16
17
  }
17
18
  export interface IUserDomain {
19
+ getUserIdentity(userId: string, ctx: IQueryInfos): Promise<IUserIdentity>;
18
20
  saveUserData(params: ISaveUserDataParams): Promise<IUserData>;
19
21
  getUserData(keys: string[], global: boolean, ctx: IQueryInfos): Promise<IUserData>;
20
22
  sendResetPasswordEmail(email: string, token: string, login: string, browser: string, os: string, lang: 'fr' | 'en', ctx: IQueryInfos): Promise<void>;
21
23
  }
22
24
  export interface IUserDomainDeps {
23
25
  config: Config.IConfig;
26
+ 'core.domain.value': IValueDomain;
24
27
  'core.domain.permissions': IPermissionDomain;
25
28
  'core.infra.userData': IUserDataRepo;
26
29
  'core.domain.permission': IPermissionDomain;
@@ -32,5 +35,5 @@ export interface IUserDomainDeps {
32
35
  export declare enum UserCoreDataKeys {
33
36
  CONSULTED_APPS = "applications_consultation"
34
37
  }
35
- 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;
38
+ 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;
36
39
  export {};
@@ -1,4 +1,5 @@
1
1
  import { type IQueryInfos } from '_types/queryInfos';
2
+ import { type IRedis } from './redis';
2
3
  export interface IMemoizeParams<T> {
3
4
  key: string;
4
5
  func: () => Promise<T>;
@@ -21,13 +22,13 @@ export interface ICacheService {
21
22
  deleteData(keys: string[], path?: string): Promise<void>;
22
23
  deleteAll(path?: string): Promise<void>;
23
24
  }
24
- interface IDeps {
25
- 'core.infra.cache.ramService': ICacheService;
25
+ interface ICacheServiceDeps {
26
+ 'core.infra.redis': IRedis;
26
27
  'core.infra.cache.diskService': ICacheService;
27
28
  }
28
29
  export declare enum ECacheType {
29
30
  DISK = "DISK",
30
31
  RAM = "RAM"
31
32
  }
32
- export default function ({ 'core.infra.cache.ramService': ramService, 'core.infra.cache.diskService': diskService }: IDeps): ICachesService;
33
+ export default function ({ 'core.infra.redis': redis, 'core.infra.cache.diskService': diskService }: ICacheServiceDeps): ICachesService;
33
34
  export {};
@@ -1,4 +1,3 @@
1
1
  export { initRedis } from './redis';
2
- export { default as diskService } from './diskService';
3
- export { default as ramService } from './ramService';
4
2
  export { default as cacheService } from './cacheService';
3
+ export { default as diskService } from './diskService';
@@ -1,9 +1,3 @@
1
1
  import { type ICacheService } from './cacheService';
2
2
  import { type RedisClientType } from './redis';
3
- import { type IConfig } from '../../_types/config';
4
- interface IDeps {
5
- config?: IConfig;
6
- 'core.infra.redis'?: RedisClientType;
7
- }
8
- export default function ({ 'core.infra.redis': redis, config }: IDeps): ICacheService;
9
- export {};
3
+ export default function (redisClient: RedisClientType): ICacheService;
@@ -4,5 +4,9 @@ interface IDeps {
4
4
  config?: IConfig;
5
5
  }
6
6
  export type RedisClientType = ReturnType<typeof redis.createClient>;
7
- export declare function initRedis({ config }: IDeps): Promise<RedisClientType>;
7
+ export interface IRedis {
8
+ cache: RedisClientType;
9
+ session: RedisClientType;
10
+ }
11
+ export declare function initRedis({ config }: IDeps): Promise<IRedis>;
8
12
  export {};
@@ -1,7 +1,7 @@
1
1
  import { type OidcClient } from './oidcClient';
2
2
  import { TokenSet } from 'openid-client';
3
- import { type ICachesService } from '../cache/cacheService';
4
3
  import { type IConfig } from '../../_types/config';
4
+ import { type ISessionRepo } from '../session/sessionRepo';
5
5
  export interface IOIDCClientService {
6
6
  oidcClient?: OidcClient;
7
7
  getTokensFromCodes: (params: {
@@ -30,8 +30,8 @@ export interface IOIDCClientService {
30
30
  }
31
31
  interface IDeps {
32
32
  'core.infra.oidcClient'?: OidcClient;
33
- 'core.infra.cache.cacheService'?: ICachesService;
34
33
  config?: IConfig;
34
+ 'core.infra.session'?: ISessionRepo;
35
35
  }
36
- export default function ({ 'core.infra.oidcClient': oidcClient, 'core.infra.cache.cacheService': cacheService, config }?: IDeps): IOIDCClientService;
36
+ export default function ({ 'core.infra.oidcClient': oidcClient, 'core.infra.session': sessionRepo, config }?: IDeps): IOIDCClientService;
37
37
  export {};
@@ -0,0 +1 @@
1
+ export { default } from './sessionRepo';
@@ -0,0 +1,8 @@
1
+ import { type ICacheService } from '../cache/cacheService';
2
+ import { type IRedis } from '../cache/redis';
3
+ export type ISessionRepo = ICacheService;
4
+ interface ISessionRepoDeps {
5
+ 'core.infra.redis'?: IRedis;
6
+ }
7
+ export default function ({ 'core.infra.redis': redis }: ISessionRepoDeps): ISessionRepo;
8
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aristid/leav-types",
3
- "version": "1.4.1-8dd5ba55",
3
+ "version": "1.4.1-94f48449",
4
4
  "description": "Shared Leav types",
5
5
  "scripts": {
6
6
  "tscheck": "",