@forklaunch/implementation-iam-base 0.6.2 → 0.6.4

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.
@@ -1,94 +1,263 @@
1
1
  import { IdDto, IdsDto } from '@forklaunch/common';
2
- import { OpenTelemetryCollector, MetricsDefinition, TelemetryOptions } from '@forklaunch/core/http';
3
- import { OrganizationService, PermissionService, RoleService, UserService } from '@forklaunch/interfaces-iam/interfaces';
4
- import { CreateOrganizationDto, UpdateOrganizationDto, CreatePermissionDto, UpdatePermissionDto, CreateRoleDto, RoleDto, UpdateRoleDto, CreateUserDto, UpdateUserDto } from '@forklaunch/interfaces-iam/types';
2
+ import {
3
+ OpenTelemetryCollector,
4
+ MetricsDefinition,
5
+ TelemetryOptions
6
+ } from '@forklaunch/core/http';
7
+ import {
8
+ OrganizationService,
9
+ PermissionService,
10
+ RoleService,
11
+ UserService
12
+ } from '@forklaunch/interfaces-iam/interfaces';
13
+ import {
14
+ CreateOrganizationDto,
15
+ UpdateOrganizationDto,
16
+ CreatePermissionDto,
17
+ UpdatePermissionDto,
18
+ CreateRoleDto,
19
+ RoleDto,
20
+ UpdateRoleDto,
21
+ CreateUserDto,
22
+ UpdateUserDto
23
+ } from '@forklaunch/interfaces-iam/types';
5
24
  import { AnySchemaValidator } from '@forklaunch/validator';
6
25
  import { EntityManager } from '@mikro-orm/core';
7
- import { OrganizationEntities, OrganizationDtos, OrganizationMappers, PermissionEntities, PermissionDtos, PermissionMappers, RoleEntities, RoleDtos, RoleMappers, UserEntities, UserDtos, UserMappers } from '../domain/types/index.js';
26
+ import {
27
+ OrganizationEntities,
28
+ OrganizationDtos,
29
+ OrganizationMappers,
30
+ PermissionEntities,
31
+ PermissionDtos,
32
+ PermissionMappers,
33
+ RoleEntities,
34
+ RoleDtos,
35
+ RoleMappers,
36
+ UserEntities,
37
+ UserDtos,
38
+ UserMappers
39
+ } from '../domain/types/index.js';
8
40
  import '@forklaunch/core/services';
9
41
 
10
- declare class BaseOrganizationService<SchemaValidator extends AnySchemaValidator, OrganizationStatus = unknown, MapperEntities extends OrganizationEntities<OrganizationStatus> = OrganizationEntities<OrganizationStatus>, MapperDomains extends OrganizationDtos<OrganizationStatus> = OrganizationDtos<OrganizationStatus>> implements OrganizationService<OrganizationStatus> {
11
- private evaluatedTelemetryOptions;
12
- em: EntityManager;
13
- protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
14
- protected schemaValidator: SchemaValidator;
15
- protected mappers: OrganizationMappers<OrganizationStatus, MapperEntities, MapperDomains>;
16
- constructor(em: EntityManager, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, schemaValidator: SchemaValidator, mappers: OrganizationMappers<OrganizationStatus, MapperEntities, MapperDomains>, options?: {
17
- telemetry?: TelemetryOptions;
18
- });
19
- createOrganization(organizationDto: CreateOrganizationDto, em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['OrganizationMapper']>;
20
- getOrganization(idDto: IdDto, em?: EntityManager): Promise<MapperDomains['OrganizationMapper']>;
21
- updateOrganization(organizationDto: UpdateOrganizationDto, em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['OrganizationMapper']>;
22
- deleteOrganization(idDto: IdDto, em?: EntityManager): Promise<void>;
42
+ declare class BaseOrganizationService<
43
+ SchemaValidator extends AnySchemaValidator,
44
+ OrganizationStatus = unknown,
45
+ MapperEntities extends
46
+ OrganizationEntities<OrganizationStatus> = OrganizationEntities<OrganizationStatus>,
47
+ MapperDomains extends
48
+ OrganizationDtos<OrganizationStatus> = OrganizationDtos<OrganizationStatus>
49
+ > implements OrganizationService<OrganizationStatus>
50
+ {
51
+ private evaluatedTelemetryOptions;
52
+ em: EntityManager;
53
+ protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
54
+ protected schemaValidator: SchemaValidator;
55
+ protected mappers: OrganizationMappers<
56
+ OrganizationStatus,
57
+ MapperEntities,
58
+ MapperDomains
59
+ >;
60
+ constructor(
61
+ em: EntityManager,
62
+ openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
63
+ schemaValidator: SchemaValidator,
64
+ mappers: OrganizationMappers<
65
+ OrganizationStatus,
66
+ MapperEntities,
67
+ MapperDomains
68
+ >,
69
+ options?: {
70
+ telemetry?: TelemetryOptions;
71
+ }
72
+ );
73
+ createOrganization(
74
+ organizationDto: CreateOrganizationDto,
75
+ em?: EntityManager,
76
+ ...args: unknown[]
77
+ ): Promise<MapperDomains['OrganizationMapper']>;
78
+ getOrganization(
79
+ idDto: IdDto,
80
+ em?: EntityManager
81
+ ): Promise<MapperDomains['OrganizationMapper']>;
82
+ updateOrganization(
83
+ organizationDto: UpdateOrganizationDto,
84
+ em?: EntityManager,
85
+ ...args: unknown[]
86
+ ): Promise<MapperDomains['OrganizationMapper']>;
87
+ deleteOrganization(idDto: IdDto, em?: EntityManager): Promise<void>;
23
88
  }
24
89
 
25
- declare class BasePermissionService<SchemaValidator extends AnySchemaValidator, MapperEntities extends PermissionEntities = PermissionEntities, MapperDomains extends PermissionDtos = PermissionDtos> implements PermissionService {
26
- private evaluatedTelemetryOptions;
27
- em: EntityManager;
28
- protected roleServiceFactory: () => RoleService;
29
- protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
30
- protected schemaValidator: SchemaValidator;
31
- protected mappers: PermissionMappers<MapperEntities, MapperDomains>;
32
- constructor(em: EntityManager, roleServiceFactory: () => RoleService, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, schemaValidator: SchemaValidator, mappers: PermissionMappers<MapperEntities, MapperDomains>, options?: {
33
- telemetry?: TelemetryOptions;
34
- });
35
- private updateRolesWithPermissions;
36
- private removePermissionsFromRoles;
37
- private getBatchRoles;
38
- private createPermissionEntity;
39
- private extractCreatePermissionEntityToEntityData;
40
- createPermission(createPermissionEntity: CreatePermissionDto, em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['PermissionMapper']>;
41
- createBatchPermissions(permissionDtos: CreatePermissionDto[], em?: EntityManager): Promise<MapperDomains['PermissionMapper'][]>;
42
- getPermission(idDto: IdDto, em?: EntityManager): Promise<MapperDomains['PermissionMapper']>;
43
- getBatchPermissions(idsDto: IdsDto, em?: EntityManager): Promise<MapperDomains['PermissionMapper'][]>;
44
- private updatePermissionDto;
45
- updatePermission(permissionDto: UpdatePermissionDto, em?: EntityManager): Promise<MapperDomains['PermissionMapper']>;
46
- updateBatchPermissions(permissionDtos: UpdatePermissionDto[], em?: EntityManager): Promise<MapperDomains['PermissionMapper'][]>;
47
- deletePermission(idDto: IdDto, em?: EntityManager): Promise<void>;
48
- deleteBatchPermissions(idsDto: IdsDto, em?: EntityManager): Promise<void>;
90
+ declare class BasePermissionService<
91
+ SchemaValidator extends AnySchemaValidator,
92
+ MapperEntities extends PermissionEntities = PermissionEntities,
93
+ MapperDomains extends PermissionDtos = PermissionDtos
94
+ > implements PermissionService
95
+ {
96
+ private evaluatedTelemetryOptions;
97
+ em: EntityManager;
98
+ protected roleServiceFactory: () => RoleService;
99
+ protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
100
+ protected schemaValidator: SchemaValidator;
101
+ protected mappers: PermissionMappers<MapperEntities, MapperDomains>;
102
+ constructor(
103
+ em: EntityManager,
104
+ roleServiceFactory: () => RoleService,
105
+ openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
106
+ schemaValidator: SchemaValidator,
107
+ mappers: PermissionMappers<MapperEntities, MapperDomains>,
108
+ options?: {
109
+ telemetry?: TelemetryOptions;
110
+ }
111
+ );
112
+ private updateRolesWithPermissions;
113
+ private removePermissionsFromRoles;
114
+ private getBatchRoles;
115
+ private createPermissionEntity;
116
+ private extractCreatePermissionEntityToEntityData;
117
+ createPermission(
118
+ createPermissionEntity: CreatePermissionDto,
119
+ em?: EntityManager,
120
+ ...args: unknown[]
121
+ ): Promise<MapperDomains['PermissionMapper']>;
122
+ createBatchPermissions(
123
+ permissionDtos: CreatePermissionDto[],
124
+ em?: EntityManager
125
+ ): Promise<MapperDomains['PermissionMapper'][]>;
126
+ getPermission(
127
+ idDto: IdDto,
128
+ em?: EntityManager
129
+ ): Promise<MapperDomains['PermissionMapper']>;
130
+ getBatchPermissions(
131
+ idsDto: IdsDto,
132
+ em?: EntityManager
133
+ ): Promise<MapperDomains['PermissionMapper'][]>;
134
+ private updatePermissionDto;
135
+ updatePermission(
136
+ permissionDto: UpdatePermissionDto,
137
+ em?: EntityManager
138
+ ): Promise<MapperDomains['PermissionMapper']>;
139
+ updateBatchPermissions(
140
+ permissionDtos: UpdatePermissionDto[],
141
+ em?: EntityManager
142
+ ): Promise<MapperDomains['PermissionMapper'][]>;
143
+ deletePermission(idDto: IdDto, em?: EntityManager): Promise<void>;
144
+ deleteBatchPermissions(idsDto: IdsDto, em?: EntityManager): Promise<void>;
49
145
  }
50
146
 
51
- declare class BaseRoleService<SchemaValidator extends AnySchemaValidator, MapperEntities extends RoleEntities = RoleEntities, MapperDomains extends RoleDtos = RoleDtos> implements RoleService {
52
- private evaluatedTelemetryOptions;
53
- em: EntityManager;
54
- protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
55
- protected schemaValidator: SchemaValidator;
56
- protected mappers: RoleMappers<MapperEntities, MapperDomains>;
57
- constructor(em: EntityManager, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, schemaValidator: SchemaValidator, mappers: RoleMappers<MapperEntities, MapperDomains>, options?: {
58
- telemetry?: TelemetryOptions;
59
- });
60
- createRole(roleDto: CreateRoleDto, em?: EntityManager, ...args: unknown[]): Promise<RoleDto>;
61
- createBatchRoles(roleDtos: CreateRoleDto[], em?: EntityManager, ...args: unknown[]): Promise<RoleDto[]>;
62
- getRole({ id }: IdDto, em?: EntityManager): Promise<RoleDto>;
63
- getBatchRoles({ ids }: IdsDto, em?: EntityManager): Promise<RoleDto[]>;
64
- updateRole(roleDto: UpdateRoleDto, em?: EntityManager, ...args: unknown[]): Promise<RoleDto>;
65
- updateBatchRoles(roleDtos: UpdateRoleDto[], em?: EntityManager, ...args: unknown[]): Promise<RoleDto[]>;
66
- deleteRole(idDto: IdDto, em?: EntityManager): Promise<void>;
67
- deleteBatchRoles(idsDto: IdsDto, em?: EntityManager): Promise<void>;
147
+ declare class BaseRoleService<
148
+ SchemaValidator extends AnySchemaValidator,
149
+ MapperEntities extends RoleEntities = RoleEntities,
150
+ MapperDomains extends RoleDtos = RoleDtos
151
+ > implements RoleService
152
+ {
153
+ private evaluatedTelemetryOptions;
154
+ em: EntityManager;
155
+ protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
156
+ protected schemaValidator: SchemaValidator;
157
+ protected mappers: RoleMappers<MapperEntities, MapperDomains>;
158
+ constructor(
159
+ em: EntityManager,
160
+ openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
161
+ schemaValidator: SchemaValidator,
162
+ mappers: RoleMappers<MapperEntities, MapperDomains>,
163
+ options?: {
164
+ telemetry?: TelemetryOptions;
165
+ }
166
+ );
167
+ createRole(
168
+ roleDto: CreateRoleDto,
169
+ em?: EntityManager,
170
+ ...args: unknown[]
171
+ ): Promise<RoleDto>;
172
+ createBatchRoles(
173
+ roleDtos: CreateRoleDto[],
174
+ em?: EntityManager,
175
+ ...args: unknown[]
176
+ ): Promise<RoleDto[]>;
177
+ getRole({ id }: IdDto, em?: EntityManager): Promise<RoleDto>;
178
+ getBatchRoles({ ids }: IdsDto, em?: EntityManager): Promise<RoleDto[]>;
179
+ updateRole(
180
+ roleDto: UpdateRoleDto,
181
+ em?: EntityManager,
182
+ ...args: unknown[]
183
+ ): Promise<RoleDto>;
184
+ updateBatchRoles(
185
+ roleDtos: UpdateRoleDto[],
186
+ em?: EntityManager,
187
+ ...args: unknown[]
188
+ ): Promise<RoleDto[]>;
189
+ deleteRole(idDto: IdDto, em?: EntityManager): Promise<void>;
190
+ deleteBatchRoles(idsDto: IdsDto, em?: EntityManager): Promise<void>;
68
191
  }
69
192
 
70
- declare class BaseUserService<SchemaValidator extends AnySchemaValidator, OrganizationStatus = unknown, MapperEntities extends UserEntities = UserEntities, MapperDomains extends UserDtos = UserDtos> implements UserService {
71
- private evaluatedTelemetryOptions;
72
- em: EntityManager;
73
- protected passwordEncryptionPublicKeyPath: string;
74
- protected roleServiceFactory: () => RoleService;
75
- protected organizationServiceFactory: () => OrganizationService<OrganizationStatus>;
76
- protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
77
- protected schemaValidator: SchemaValidator;
78
- protected mappers: UserMappers<MapperEntities, MapperDomains>;
79
- constructor(em: EntityManager, passwordEncryptionPublicKeyPath: string, roleServiceFactory: () => RoleService, organizationServiceFactory: () => OrganizationService<OrganizationStatus>, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, schemaValidator: SchemaValidator, mappers: UserMappers<MapperEntities, MapperDomains>, options?: {
80
- telemetry?: TelemetryOptions;
81
- });
82
- createUser(userDto: CreateUserDto, em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['UserMapper']>;
83
- createBatchUsers(userDtos: CreateUserDto[], em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['UserMapper'][]>;
84
- getUser(idDto: IdDto, em?: EntityManager): Promise<MapperDomains['UserMapper']>;
85
- getBatchUsers(idsDto: IdsDto, em?: EntityManager): Promise<MapperDomains['UserMapper'][]>;
86
- updateUser(userDto: UpdateUserDto, em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['UserMapper']>;
87
- updateBatchUsers(userDtos: UpdateUserDto[], em?: EntityManager, ...args: unknown[]): Promise<MapperDomains['UserMapper'][]>;
88
- deleteUser(idDto: IdDto, em?: EntityManager): Promise<void>;
89
- deleteBatchUsers(idsDto: IdsDto, em?: EntityManager): Promise<void>;
90
- verifyHasRole(idDto: IdDto, roleId: string): Promise<void>;
91
- verifyHasPermission(idDto: IdDto, permissionId: string): Promise<void>;
193
+ declare class BaseUserService<
194
+ SchemaValidator extends AnySchemaValidator,
195
+ OrganizationStatus = unknown,
196
+ MapperEntities extends UserEntities = UserEntities,
197
+ MapperDomains extends UserDtos = UserDtos
198
+ > implements UserService
199
+ {
200
+ private evaluatedTelemetryOptions;
201
+ em: EntityManager;
202
+ protected roleServiceFactory: () => RoleService;
203
+ protected organizationServiceFactory: () => OrganizationService<OrganizationStatus>;
204
+ protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>;
205
+ protected schemaValidator: SchemaValidator;
206
+ protected mappers: UserMappers<MapperEntities, MapperDomains>;
207
+ constructor(
208
+ em: EntityManager,
209
+ roleServiceFactory: () => RoleService,
210
+ organizationServiceFactory: () => OrganizationService<OrganizationStatus>,
211
+ openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
212
+ schemaValidator: SchemaValidator,
213
+ mappers: UserMappers<MapperEntities, MapperDomains>,
214
+ options?: {
215
+ telemetry?: TelemetryOptions;
216
+ }
217
+ );
218
+ createUser(
219
+ userDto: CreateUserDto,
220
+ em?: EntityManager,
221
+ ...args: unknown[]
222
+ ): Promise<MapperDomains['UserMapper']>;
223
+ createBatchUsers(
224
+ userDtos: CreateUserDto[],
225
+ em?: EntityManager,
226
+ ...args: unknown[]
227
+ ): Promise<MapperDomains['UserMapper'][]>;
228
+ getUser(
229
+ idDto: IdDto,
230
+ em?: EntityManager
231
+ ): Promise<MapperDomains['UserMapper']>;
232
+ getBatchUsers(
233
+ idsDto: IdsDto,
234
+ em?: EntityManager
235
+ ): Promise<MapperDomains['UserMapper'][]>;
236
+ updateUser(
237
+ userDto: UpdateUserDto,
238
+ em?: EntityManager,
239
+ ...args: unknown[]
240
+ ): Promise<MapperDomains['UserMapper']>;
241
+ updateBatchUsers(
242
+ userDtos: UpdateUserDto[],
243
+ em?: EntityManager,
244
+ ...args: unknown[]
245
+ ): Promise<MapperDomains['UserMapper'][]>;
246
+ deleteUser(idDto: IdDto, em?: EntityManager): Promise<void>;
247
+ deleteBatchUsers(idsDto: IdsDto, em?: EntityManager): Promise<void>;
248
+ surfaceRoles(
249
+ idDto: IdDto,
250
+ em?: EntityManager
251
+ ): Promise<MapperDomains['UserMapper']['roles']>;
252
+ surfacePermissions(
253
+ idDto: IdDto,
254
+ em?: EntityManager
255
+ ): Promise<MapperDomains['UserMapper']['roles'][0]['permissions']>;
92
256
  }
93
257
 
94
- export { BaseOrganizationService, BasePermissionService, BaseRoleService, BaseUserService };
258
+ export {
259
+ BaseOrganizationService,
260
+ BasePermissionService,
261
+ BaseRoleService,
262
+ BaseUserService
263
+ };