@abpjs/saas 3.0.0 → 3.2.0
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.
- package/dist/index.d.mts +365 -48
- package/dist/index.d.ts +365 -48
- package/dist/index.js +220 -19
- package/dist/index.mjs +218 -19
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ABP, RoutesService, RestService } from '@abpjs/core';
|
|
1
|
+
import { ABP, RoutesService, RestService, PagedResultDto } from '@abpjs/core';
|
|
2
2
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -97,6 +97,257 @@ declare const SAAS_ROUTE_PROVIDERS: {
|
|
|
97
97
|
deps: readonly ["RoutesService"];
|
|
98
98
|
};
|
|
99
99
|
|
|
100
|
+
/**
|
|
101
|
+
* SaaS Proxy DTOs
|
|
102
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
103
|
+
*
|
|
104
|
+
* Typed Data Transfer Objects for the SaaS module proxy services.
|
|
105
|
+
*
|
|
106
|
+
* @since 3.2.0
|
|
107
|
+
*/
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Base DTO for edition create/update operations
|
|
111
|
+
* @since 3.2.0
|
|
112
|
+
*/
|
|
113
|
+
interface EditionCreateOrUpdateDtoBase {
|
|
114
|
+
displayName: string;
|
|
115
|
+
extraProperties?: ABP.Dictionary<unknown>;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* DTO for creating a new edition
|
|
119
|
+
* @since 3.2.0
|
|
120
|
+
*/
|
|
121
|
+
type EditionCreateDto = EditionCreateOrUpdateDtoBase;
|
|
122
|
+
/**
|
|
123
|
+
* DTO for updating an edition
|
|
124
|
+
* @since 3.2.0
|
|
125
|
+
*/
|
|
126
|
+
type EditionUpdateDto = EditionCreateOrUpdateDtoBase;
|
|
127
|
+
/**
|
|
128
|
+
* DTO for edition entity response
|
|
129
|
+
* @since 3.2.0
|
|
130
|
+
*/
|
|
131
|
+
interface EditionDto {
|
|
132
|
+
id: string;
|
|
133
|
+
displayName: string;
|
|
134
|
+
concurrencyStamp?: string;
|
|
135
|
+
creationTime?: string | Date;
|
|
136
|
+
creatorId?: string;
|
|
137
|
+
extraProperties?: ABP.Dictionary<unknown>;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Query input for fetching editions
|
|
141
|
+
* @since 3.2.0
|
|
142
|
+
*/
|
|
143
|
+
interface GetEditionsInput {
|
|
144
|
+
filter?: string;
|
|
145
|
+
skipCount?: number;
|
|
146
|
+
maxResultCount?: number;
|
|
147
|
+
sorting?: string;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Base DTO for tenant create/update operations
|
|
151
|
+
* @since 3.2.0
|
|
152
|
+
*/
|
|
153
|
+
interface SaasTenantCreateOrUpdateDtoBase {
|
|
154
|
+
name: string;
|
|
155
|
+
editionId?: string;
|
|
156
|
+
extraProperties?: ABP.Dictionary<unknown>;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* DTO for creating a new tenant
|
|
160
|
+
* @since 3.2.0
|
|
161
|
+
*/
|
|
162
|
+
interface SaasTenantCreateDto extends SaasTenantCreateOrUpdateDtoBase {
|
|
163
|
+
adminEmailAddress: string;
|
|
164
|
+
adminPassword: string;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* DTO for updating a tenant
|
|
168
|
+
* @since 3.2.0
|
|
169
|
+
*/
|
|
170
|
+
type SaasTenantUpdateDto = SaasTenantCreateOrUpdateDtoBase;
|
|
171
|
+
/**
|
|
172
|
+
* DTO for tenant entity response
|
|
173
|
+
* @since 3.2.0
|
|
174
|
+
*/
|
|
175
|
+
interface SaasTenantDto {
|
|
176
|
+
id: string;
|
|
177
|
+
name: string;
|
|
178
|
+
editionId?: string;
|
|
179
|
+
editionName?: string;
|
|
180
|
+
concurrencyStamp?: string;
|
|
181
|
+
creationTime?: string | Date;
|
|
182
|
+
creatorId?: string;
|
|
183
|
+
extraProperties?: ABP.Dictionary<unknown>;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Query input for fetching tenants
|
|
187
|
+
* @since 3.2.0
|
|
188
|
+
*/
|
|
189
|
+
interface GetTenantsInput {
|
|
190
|
+
filter?: string;
|
|
191
|
+
getEditionNames?: boolean;
|
|
192
|
+
skipCount?: number;
|
|
193
|
+
maxResultCount?: number;
|
|
194
|
+
sorting?: string;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* SaaS Proxy Host Models
|
|
199
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
200
|
+
*
|
|
201
|
+
* Additional models for the SaaS host proxy services.
|
|
202
|
+
*
|
|
203
|
+
* @since 3.2.0
|
|
204
|
+
*/
|
|
205
|
+
/**
|
|
206
|
+
* Result type for edition usage statistics
|
|
207
|
+
* @since 3.2.0
|
|
208
|
+
*/
|
|
209
|
+
interface GetEditionUsageStatisticsResult {
|
|
210
|
+
data: Record<string, number>;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Edition Proxy Service
|
|
215
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
216
|
+
*
|
|
217
|
+
* Provides typed REST API methods for managing editions.
|
|
218
|
+
*
|
|
219
|
+
* @since 3.2.0
|
|
220
|
+
*/
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Service for edition operations with typed DTOs.
|
|
224
|
+
* This is the new proxy service that replaces the edition-related
|
|
225
|
+
* methods in the legacy SaasService.
|
|
226
|
+
*
|
|
227
|
+
* @since 3.2.0
|
|
228
|
+
*/
|
|
229
|
+
declare class EditionService {
|
|
230
|
+
private restService;
|
|
231
|
+
/**
|
|
232
|
+
* API name for multi-API configurations
|
|
233
|
+
* @since 3.2.0
|
|
234
|
+
*/
|
|
235
|
+
apiName: string;
|
|
236
|
+
constructor(restService: RestService);
|
|
237
|
+
/**
|
|
238
|
+
* Create a new edition
|
|
239
|
+
* @param input Edition creation DTO
|
|
240
|
+
* @returns Promise with created edition
|
|
241
|
+
*/
|
|
242
|
+
create(input: EditionCreateDto): Promise<EditionDto>;
|
|
243
|
+
/**
|
|
244
|
+
* Delete an edition by ID
|
|
245
|
+
* @param id Edition ID
|
|
246
|
+
* @returns Promise that resolves when deletion is complete
|
|
247
|
+
*/
|
|
248
|
+
delete(id: string): Promise<void>;
|
|
249
|
+
/**
|
|
250
|
+
* Get an edition by ID
|
|
251
|
+
* @param id Edition ID
|
|
252
|
+
* @returns Promise with edition data
|
|
253
|
+
*/
|
|
254
|
+
get(id: string): Promise<EditionDto>;
|
|
255
|
+
/**
|
|
256
|
+
* Get paginated list of editions
|
|
257
|
+
* @param input Query parameters for filtering and pagination
|
|
258
|
+
* @returns Promise with paginated editions response
|
|
259
|
+
*/
|
|
260
|
+
getList(input?: GetEditionsInput): Promise<PagedResultDto<EditionDto>>;
|
|
261
|
+
/**
|
|
262
|
+
* Get usage statistics for editions
|
|
263
|
+
* @returns Promise with usage statistics data
|
|
264
|
+
*/
|
|
265
|
+
getUsageStatistics(): Promise<GetEditionUsageStatisticsResult>;
|
|
266
|
+
/**
|
|
267
|
+
* Update an existing edition
|
|
268
|
+
* @param id Edition ID
|
|
269
|
+
* @param input Edition update DTO
|
|
270
|
+
* @returns Promise with updated edition
|
|
271
|
+
*/
|
|
272
|
+
update(id: string, input: EditionUpdateDto): Promise<EditionDto>;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Tenant Proxy Service
|
|
277
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
278
|
+
*
|
|
279
|
+
* Provides typed REST API methods for managing tenants.
|
|
280
|
+
*
|
|
281
|
+
* @since 3.2.0
|
|
282
|
+
*/
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Service for tenant operations with typed DTOs.
|
|
286
|
+
* This is the new proxy service that replaces the tenant-related
|
|
287
|
+
* methods in the legacy SaasService.
|
|
288
|
+
*
|
|
289
|
+
* @since 3.2.0
|
|
290
|
+
*/
|
|
291
|
+
declare class TenantService {
|
|
292
|
+
private restService;
|
|
293
|
+
/**
|
|
294
|
+
* API name for multi-API configurations
|
|
295
|
+
* @since 3.2.0
|
|
296
|
+
*/
|
|
297
|
+
apiName: string;
|
|
298
|
+
constructor(restService: RestService);
|
|
299
|
+
/**
|
|
300
|
+
* Create a new tenant
|
|
301
|
+
* @param input Tenant creation DTO
|
|
302
|
+
* @returns Promise with created tenant
|
|
303
|
+
*/
|
|
304
|
+
create(input: SaasTenantCreateDto): Promise<SaasTenantDto>;
|
|
305
|
+
/**
|
|
306
|
+
* Delete a tenant by ID
|
|
307
|
+
* @param id Tenant ID
|
|
308
|
+
* @returns Promise that resolves when deletion is complete
|
|
309
|
+
*/
|
|
310
|
+
delete(id: string): Promise<void>;
|
|
311
|
+
/**
|
|
312
|
+
* Delete the default connection string for a tenant
|
|
313
|
+
* @param id Tenant ID
|
|
314
|
+
* @returns Promise that resolves when deletion is complete
|
|
315
|
+
*/
|
|
316
|
+
deleteDefaultConnectionString(id: string): Promise<void>;
|
|
317
|
+
/**
|
|
318
|
+
* Get a tenant by ID
|
|
319
|
+
* @param id Tenant ID
|
|
320
|
+
* @returns Promise with tenant data
|
|
321
|
+
*/
|
|
322
|
+
get(id: string): Promise<SaasTenantDto>;
|
|
323
|
+
/**
|
|
324
|
+
* Get the default connection string for a tenant
|
|
325
|
+
* @param id Tenant ID
|
|
326
|
+
* @returns Promise with connection string
|
|
327
|
+
*/
|
|
328
|
+
getDefaultConnectionString(id: string): Promise<string>;
|
|
329
|
+
/**
|
|
330
|
+
* Get paginated list of tenants
|
|
331
|
+
* @param input Query parameters for filtering and pagination
|
|
332
|
+
* @returns Promise with paginated tenants response
|
|
333
|
+
*/
|
|
334
|
+
getList(input?: GetTenantsInput): Promise<PagedResultDto<SaasTenantDto>>;
|
|
335
|
+
/**
|
|
336
|
+
* Update an existing tenant
|
|
337
|
+
* @param id Tenant ID
|
|
338
|
+
* @param input Tenant update DTO
|
|
339
|
+
* @returns Promise with updated tenant
|
|
340
|
+
*/
|
|
341
|
+
update(id: string, input: SaasTenantUpdateDto): Promise<SaasTenantDto>;
|
|
342
|
+
/**
|
|
343
|
+
* Update the default connection string for a tenant
|
|
344
|
+
* @param id Tenant ID
|
|
345
|
+
* @param defaultConnectionString The connection string
|
|
346
|
+
* @returns Promise that resolves when update is complete
|
|
347
|
+
*/
|
|
348
|
+
updateDefaultConnectionString(id: string, defaultConnectionString: string): Promise<void>;
|
|
349
|
+
}
|
|
350
|
+
|
|
100
351
|
/**
|
|
101
352
|
* SaaS Component Identifiers
|
|
102
353
|
* Used for component registration and routing
|
|
@@ -115,26 +366,50 @@ type SaasComponentKey = (typeof eSaasComponents)[keyof typeof eSaasComponents];
|
|
|
115
366
|
|
|
116
367
|
/**
|
|
117
368
|
* SaaS Models
|
|
118
|
-
* Translated from @volo/abp.ng.saas
|
|
369
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
119
370
|
*
|
|
120
371
|
* @updated 2.4.0 - Updated CreateTenantRequest and UpdateTenantRequest types
|
|
372
|
+
* @updated 3.2.0 - Added deprecation notices for legacy types, state now uses proxy DTOs
|
|
121
373
|
*/
|
|
122
374
|
|
|
123
375
|
/**
|
|
124
376
|
* Saas namespace containing all models for SaaS management
|
|
377
|
+
*
|
|
378
|
+
* @deprecated The types in this namespace are deprecated in favor of the proxy DTOs.
|
|
379
|
+
* Use the following instead:
|
|
380
|
+
* - `SaasTenantDto` instead of `Saas.Tenant`
|
|
381
|
+
* - `EditionDto` instead of `Saas.Edition`
|
|
382
|
+
* - `SaasTenantCreateDto` instead of `Saas.CreateTenantRequest`
|
|
383
|
+
* - `SaasTenantUpdateDto` instead of `Saas.UpdateTenantRequest`
|
|
384
|
+
* - `EditionCreateDto` instead of `Saas.CreateEditionRequest`
|
|
385
|
+
* - `EditionUpdateDto` instead of `Saas.UpdateEditionRequest`
|
|
386
|
+
*
|
|
387
|
+
* These legacy types will be removed in v4.0.0.
|
|
125
388
|
*/
|
|
126
389
|
declare namespace Saas {
|
|
127
390
|
/**
|
|
128
391
|
* State interface for SaaS
|
|
392
|
+
* @updated 3.2.0 - Now uses proxy DTOs (PagedResultDto<SaasTenantDto>, PagedResultDto<EditionDto>)
|
|
129
393
|
*/
|
|
130
394
|
interface State {
|
|
131
|
-
tenants:
|
|
132
|
-
editions:
|
|
395
|
+
tenants: PagedResultDto<SaasTenantDto>;
|
|
396
|
+
editions: PagedResultDto<EditionDto>;
|
|
133
397
|
usageStatistics: Record<string, number>;
|
|
134
|
-
latestTenants:
|
|
398
|
+
latestTenants: SaasTenantDto[];
|
|
135
399
|
}
|
|
400
|
+
/**
|
|
401
|
+
* Tenant response type alias
|
|
402
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be removed in v4.0.
|
|
403
|
+
*/
|
|
404
|
+
type TenantResponse = PagedResultDto<Tenant>;
|
|
405
|
+
/**
|
|
406
|
+
* Edition response type alias
|
|
407
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be removed in v4.0.
|
|
408
|
+
*/
|
|
409
|
+
type EditionResponse = PagedResultDto<Edition>;
|
|
136
410
|
/**
|
|
137
411
|
* Tenant interface
|
|
412
|
+
* @deprecated Use SaasTenantDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
138
413
|
*/
|
|
139
414
|
interface Tenant {
|
|
140
415
|
id: string;
|
|
@@ -145,6 +420,7 @@ declare namespace Saas {
|
|
|
145
420
|
}
|
|
146
421
|
/**
|
|
147
422
|
* Edition interface
|
|
423
|
+
* @deprecated Use EditionDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
148
424
|
*/
|
|
149
425
|
interface Edition {
|
|
150
426
|
id: string;
|
|
@@ -153,20 +429,29 @@ declare namespace Saas {
|
|
|
153
429
|
}
|
|
154
430
|
/**
|
|
155
431
|
* Query parameters for fetching tenants
|
|
432
|
+
* @deprecated Use GetTenantsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
156
433
|
*/
|
|
157
|
-
interface TenantsQueryParams
|
|
434
|
+
interface TenantsQueryParams {
|
|
158
435
|
filter?: string;
|
|
159
436
|
editionId?: string;
|
|
160
437
|
getEditionNames?: boolean;
|
|
438
|
+
skipCount?: number;
|
|
439
|
+
maxResultCount?: number;
|
|
440
|
+
sorting?: string;
|
|
161
441
|
}
|
|
162
442
|
/**
|
|
163
443
|
* Query parameters for fetching editions
|
|
444
|
+
* @deprecated Use GetEditionsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
164
445
|
*/
|
|
165
|
-
interface EditionsQueryParams
|
|
446
|
+
interface EditionsQueryParams {
|
|
166
447
|
filter?: string;
|
|
448
|
+
skipCount?: number;
|
|
449
|
+
maxResultCount?: number;
|
|
450
|
+
sorting?: string;
|
|
167
451
|
}
|
|
168
452
|
/**
|
|
169
453
|
* Create tenant request
|
|
454
|
+
* @deprecated Use SaasTenantCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
170
455
|
* @updated 2.4.0 - adminEmailAddress and adminPassword are now required
|
|
171
456
|
*/
|
|
172
457
|
interface CreateTenantRequest {
|
|
@@ -177,17 +462,20 @@ declare namespace Saas {
|
|
|
177
462
|
}
|
|
178
463
|
/**
|
|
179
464
|
* Update tenant request
|
|
465
|
+
* @deprecated Use SaasTenantUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
180
466
|
* @updated 2.4.0 - Now uses Omit<Tenant, 'editionName'> pattern
|
|
181
467
|
*/
|
|
182
468
|
type UpdateTenantRequest = Omit<Tenant, 'editionName'>;
|
|
183
469
|
/**
|
|
184
470
|
* Create edition request
|
|
471
|
+
* @deprecated Use EditionCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
185
472
|
*/
|
|
186
473
|
interface CreateEditionRequest {
|
|
187
474
|
displayName: string;
|
|
188
475
|
}
|
|
189
476
|
/**
|
|
190
477
|
* Update edition request
|
|
478
|
+
* @deprecated Use EditionUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
191
479
|
*/
|
|
192
480
|
interface UpdateEditionRequest {
|
|
193
481
|
id?: string;
|
|
@@ -196,6 +484,7 @@ declare namespace Saas {
|
|
|
196
484
|
}
|
|
197
485
|
/**
|
|
198
486
|
* Default connection string request
|
|
487
|
+
* @deprecated Use TenantService.updateDefaultConnectionString(id, connectionString) instead. To be removed in v4.0.
|
|
199
488
|
*/
|
|
200
489
|
interface DefaultConnectionStringRequest {
|
|
201
490
|
id: string;
|
|
@@ -203,14 +492,17 @@ declare namespace Saas {
|
|
|
203
492
|
}
|
|
204
493
|
/**
|
|
205
494
|
* Paginated response for tenants
|
|
495
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be removed in v4.0.
|
|
206
496
|
*/
|
|
207
|
-
type TenantsResponse =
|
|
497
|
+
type TenantsResponse = PagedResultDto<Tenant>;
|
|
208
498
|
/**
|
|
209
499
|
* Paginated response for editions
|
|
500
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be removed in v4.0.
|
|
210
501
|
*/
|
|
211
|
-
type EditionsResponse =
|
|
502
|
+
type EditionsResponse = PagedResultDto<Edition>;
|
|
212
503
|
/**
|
|
213
504
|
* Usage statistics response
|
|
505
|
+
* @deprecated Use GetEditionUsageStatisticsResult from proxy/host/models instead. To be removed in v4.0.
|
|
214
506
|
*/
|
|
215
507
|
interface UsageStatisticsResponse {
|
|
216
508
|
data: Record<string, number>;
|
|
@@ -219,12 +511,13 @@ declare namespace Saas {
|
|
|
219
511
|
|
|
220
512
|
/**
|
|
221
513
|
* SaaS Extension Tokens
|
|
222
|
-
* Translated from @volo/abp.ng.saas v3.
|
|
514
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
223
515
|
*
|
|
224
516
|
* Default entity actions, toolbar actions, entity props, and form props
|
|
225
517
|
* for the SaaS module extensibility system.
|
|
226
518
|
*
|
|
227
519
|
* @since 3.0.0
|
|
520
|
+
* @updated 3.2.0 - Now uses proxy DTOs (EditionDto, SaasTenantDto) instead of Saas.Edition/Saas.Tenant
|
|
228
521
|
*/
|
|
229
522
|
|
|
230
523
|
/**
|
|
@@ -285,92 +578,102 @@ interface FormProp<T = unknown> {
|
|
|
285
578
|
/**
|
|
286
579
|
* Default entity actions for Editions component
|
|
287
580
|
* @since 3.0.0
|
|
581
|
+
* @updated 3.2.0 - Now uses EditionDto instead of Saas.Edition
|
|
288
582
|
*/
|
|
289
|
-
declare const DEFAULT_EDITIONS_ENTITY_ACTIONS: EntityAction<
|
|
583
|
+
declare const DEFAULT_EDITIONS_ENTITY_ACTIONS: EntityAction<EditionDto>[];
|
|
290
584
|
/**
|
|
291
585
|
* Default entity actions for Tenants component
|
|
292
586
|
* @since 3.0.0
|
|
587
|
+
* @updated 3.2.0 - Now uses SaasTenantDto instead of Saas.Tenant
|
|
293
588
|
*/
|
|
294
|
-
declare const DEFAULT_TENANTS_ENTITY_ACTIONS: EntityAction<
|
|
589
|
+
declare const DEFAULT_TENANTS_ENTITY_ACTIONS: EntityAction<SaasTenantDto>[];
|
|
295
590
|
/**
|
|
296
591
|
* Default entity actions aggregated by component
|
|
297
592
|
* @since 3.0.0
|
|
298
593
|
*/
|
|
299
594
|
declare const DEFAULT_SAAS_ENTITY_ACTIONS: {
|
|
300
|
-
readonly "Saas.EditionsComponent": EntityAction<
|
|
301
|
-
readonly "Saas.TenantsComponent": EntityAction<
|
|
595
|
+
readonly "Saas.EditionsComponent": EntityAction<EditionDto>[];
|
|
596
|
+
readonly "Saas.TenantsComponent": EntityAction<SaasTenantDto>[];
|
|
302
597
|
};
|
|
303
598
|
/**
|
|
304
599
|
* Default toolbar actions for Editions component
|
|
305
600
|
* @since 3.0.0
|
|
601
|
+
* @updated 3.2.0 - Now uses EditionDto instead of Saas.Edition
|
|
306
602
|
*/
|
|
307
|
-
declare const DEFAULT_EDITIONS_TOOLBAR_ACTIONS: ToolbarAction<
|
|
603
|
+
declare const DEFAULT_EDITIONS_TOOLBAR_ACTIONS: ToolbarAction<EditionDto[]>[];
|
|
308
604
|
/**
|
|
309
605
|
* Default toolbar actions for Tenants component
|
|
310
606
|
* @since 3.0.0
|
|
607
|
+
* @updated 3.2.0 - Now uses SaasTenantDto instead of Saas.Tenant
|
|
311
608
|
*/
|
|
312
|
-
declare const DEFAULT_TENANTS_TOOLBAR_ACTIONS: ToolbarAction<
|
|
609
|
+
declare const DEFAULT_TENANTS_TOOLBAR_ACTIONS: ToolbarAction<SaasTenantDto[]>[];
|
|
313
610
|
/**
|
|
314
611
|
* Default toolbar actions aggregated by component
|
|
315
612
|
* @since 3.0.0
|
|
316
613
|
*/
|
|
317
614
|
declare const DEFAULT_SAAS_TOOLBAR_ACTIONS: {
|
|
318
|
-
readonly "Saas.EditionsComponent": ToolbarAction<
|
|
319
|
-
readonly "Saas.TenantsComponent": ToolbarAction<
|
|
615
|
+
readonly "Saas.EditionsComponent": ToolbarAction<EditionDto[]>[];
|
|
616
|
+
readonly "Saas.TenantsComponent": ToolbarAction<SaasTenantDto[]>[];
|
|
320
617
|
};
|
|
321
618
|
/**
|
|
322
619
|
* Default entity props for Editions component
|
|
323
620
|
* @since 3.0.0
|
|
621
|
+
* @updated 3.2.0 - Now uses EditionDto instead of Saas.Edition
|
|
324
622
|
*/
|
|
325
|
-
declare const DEFAULT_EDITIONS_ENTITY_PROPS: EntityProp<
|
|
623
|
+
declare const DEFAULT_EDITIONS_ENTITY_PROPS: EntityProp<EditionDto>[];
|
|
326
624
|
/**
|
|
327
625
|
* Default entity props for Tenants component
|
|
328
626
|
* @since 3.0.0
|
|
627
|
+
* @updated 3.2.0 - Now uses SaasTenantDto instead of Saas.Tenant
|
|
329
628
|
*/
|
|
330
|
-
declare const DEFAULT_TENANTS_ENTITY_PROPS: EntityProp<
|
|
629
|
+
declare const DEFAULT_TENANTS_ENTITY_PROPS: EntityProp<SaasTenantDto>[];
|
|
331
630
|
/**
|
|
332
631
|
* Default entity props aggregated by component
|
|
333
632
|
* @since 3.0.0
|
|
334
633
|
*/
|
|
335
634
|
declare const DEFAULT_SAAS_ENTITY_PROPS: {
|
|
336
|
-
readonly "Saas.EditionsComponent": EntityProp<
|
|
337
|
-
readonly "Saas.TenantsComponent": EntityProp<
|
|
635
|
+
readonly "Saas.EditionsComponent": EntityProp<EditionDto>[];
|
|
636
|
+
readonly "Saas.TenantsComponent": EntityProp<SaasTenantDto>[];
|
|
338
637
|
};
|
|
339
638
|
/**
|
|
340
639
|
* Default create form props for Editions component
|
|
341
640
|
* @since 3.0.0
|
|
641
|
+
* @updated 3.2.0 - Now uses EditionDto instead of Saas.Edition
|
|
342
642
|
*/
|
|
343
|
-
declare const DEFAULT_EDITIONS_CREATE_FORM_PROPS: FormProp<
|
|
643
|
+
declare const DEFAULT_EDITIONS_CREATE_FORM_PROPS: FormProp<EditionDto>[];
|
|
344
644
|
/**
|
|
345
645
|
* Default create form props for Tenants component
|
|
346
646
|
* @since 3.0.0
|
|
647
|
+
* @updated 3.2.0 - Now uses SaasTenantDto instead of Saas.Tenant
|
|
347
648
|
*/
|
|
348
|
-
declare const DEFAULT_TENANTS_CREATE_FORM_PROPS: FormProp<
|
|
649
|
+
declare const DEFAULT_TENANTS_CREATE_FORM_PROPS: FormProp<SaasTenantDto>[];
|
|
349
650
|
/**
|
|
350
651
|
* Default create form props aggregated by component
|
|
351
652
|
* @since 3.0.0
|
|
352
653
|
*/
|
|
353
654
|
declare const DEFAULT_SAAS_CREATE_FORM_PROPS: {
|
|
354
|
-
readonly "Saas.EditionsComponent": FormProp<
|
|
355
|
-
readonly "Saas.TenantsComponent": FormProp<
|
|
655
|
+
readonly "Saas.EditionsComponent": FormProp<EditionDto>[];
|
|
656
|
+
readonly "Saas.TenantsComponent": FormProp<SaasTenantDto>[];
|
|
356
657
|
};
|
|
357
658
|
/**
|
|
358
659
|
* Default edit form props for Editions component
|
|
359
660
|
* @since 3.0.0
|
|
661
|
+
* @updated 3.2.0 - Now uses EditionDto instead of Saas.Edition
|
|
360
662
|
*/
|
|
361
|
-
declare const DEFAULT_EDITIONS_EDIT_FORM_PROPS: FormProp<
|
|
663
|
+
declare const DEFAULT_EDITIONS_EDIT_FORM_PROPS: FormProp<EditionDto>[];
|
|
362
664
|
/**
|
|
363
665
|
* Default edit form props for Tenants component
|
|
364
666
|
* @since 3.0.0
|
|
667
|
+
* @updated 3.2.0 - Now uses SaasTenantDto instead of Saas.Tenant
|
|
365
668
|
*/
|
|
366
|
-
declare const DEFAULT_TENANTS_EDIT_FORM_PROPS: FormProp<
|
|
669
|
+
declare const DEFAULT_TENANTS_EDIT_FORM_PROPS: FormProp<SaasTenantDto>[];
|
|
367
670
|
/**
|
|
368
671
|
* Default edit form props aggregated by component
|
|
369
672
|
* @since 3.0.0
|
|
370
673
|
*/
|
|
371
674
|
declare const DEFAULT_SAAS_EDIT_FORM_PROPS: {
|
|
372
|
-
readonly "Saas.EditionsComponent": FormProp<
|
|
373
|
-
readonly "Saas.TenantsComponent": FormProp<
|
|
675
|
+
readonly "Saas.EditionsComponent": FormProp<EditionDto>[];
|
|
676
|
+
readonly "Saas.TenantsComponent": FormProp<SaasTenantDto>[];
|
|
374
677
|
};
|
|
375
678
|
/**
|
|
376
679
|
* Entity action contributor callback type
|
|
@@ -722,10 +1025,12 @@ declare class SaasService {
|
|
|
722
1025
|
|
|
723
1026
|
/**
|
|
724
1027
|
* SaaS State Service
|
|
725
|
-
* Translated from @volo/abp.ng.saas
|
|
1028
|
+
* Translated from @volo/abp.ng.saas v3.2.0
|
|
726
1029
|
*
|
|
727
1030
|
* Provides a stateful facade over SaaS operations,
|
|
728
1031
|
* maintaining internal state that mirrors the Angular NGXS store pattern.
|
|
1032
|
+
*
|
|
1033
|
+
* @updated 3.2.0 - Now uses EditionService and TenantService proxy services internally
|
|
729
1034
|
*/
|
|
730
1035
|
|
|
731
1036
|
/**
|
|
@@ -734,6 +1039,7 @@ declare class SaasService {
|
|
|
734
1039
|
* mirroring the Angular NGXS store pattern.
|
|
735
1040
|
*
|
|
736
1041
|
* @since 2.0.0
|
|
1042
|
+
* @updated 3.2.0 - Now uses EditionService and TenantService proxy services internally
|
|
737
1043
|
*
|
|
738
1044
|
* @example
|
|
739
1045
|
* ```tsx
|
|
@@ -748,32 +1054,39 @@ declare class SaasService {
|
|
|
748
1054
|
* ```
|
|
749
1055
|
*/
|
|
750
1056
|
declare class SaasStateService {
|
|
751
|
-
private
|
|
1057
|
+
private tenantService;
|
|
1058
|
+
private editionService;
|
|
752
1059
|
private state;
|
|
753
1060
|
constructor(rest: RestService);
|
|
754
1061
|
/**
|
|
755
1062
|
* Get the current list of tenants from state
|
|
1063
|
+
* @returns Array of tenants
|
|
756
1064
|
*/
|
|
757
|
-
getTenants():
|
|
1065
|
+
getTenants(): SaasTenantDto[];
|
|
758
1066
|
/**
|
|
759
1067
|
* Get the latest tenants from state (for dashboard widget)
|
|
760
1068
|
* @since 2.0.0
|
|
1069
|
+
* @returns Array of latest tenants
|
|
761
1070
|
*/
|
|
762
|
-
getLatestTenants():
|
|
1071
|
+
getLatestTenants(): SaasTenantDto[];
|
|
763
1072
|
/**
|
|
764
1073
|
* Get the total count of tenants from state
|
|
1074
|
+
* @returns Total count
|
|
765
1075
|
*/
|
|
766
1076
|
getTenantsTotalCount(): number;
|
|
767
1077
|
/**
|
|
768
1078
|
* Get the current list of editions from state
|
|
1079
|
+
* @returns Array of editions
|
|
769
1080
|
*/
|
|
770
|
-
getEditions():
|
|
1081
|
+
getEditions(): EditionDto[];
|
|
771
1082
|
/**
|
|
772
1083
|
* Get the total count of editions from state
|
|
1084
|
+
* @returns Total count
|
|
773
1085
|
*/
|
|
774
1086
|
getEditionsTotalCount(): number;
|
|
775
1087
|
/**
|
|
776
1088
|
* Get the usage statistics from state
|
|
1089
|
+
* @returns Usage statistics data
|
|
777
1090
|
*/
|
|
778
1091
|
getUsageStatistics(): Record<string, number>;
|
|
779
1092
|
/**
|
|
@@ -781,25 +1094,27 @@ declare class SaasStateService {
|
|
|
781
1094
|
* @param params - Optional query parameters for pagination and filtering
|
|
782
1095
|
* @returns Promise with the tenants response
|
|
783
1096
|
*/
|
|
784
|
-
dispatchGetTenants(params?:
|
|
1097
|
+
dispatchGetTenants(params?: GetTenantsInput): Promise<PagedResultDto<SaasTenantDto>>;
|
|
785
1098
|
/**
|
|
786
1099
|
* Dispatch action to fetch a tenant by ID
|
|
787
1100
|
* @param id - The tenant ID
|
|
788
1101
|
* @returns Promise with the tenant
|
|
789
1102
|
*/
|
|
790
|
-
dispatchGetTenantById(id: string): Promise<
|
|
1103
|
+
dispatchGetTenantById(id: string): Promise<SaasTenantDto>;
|
|
791
1104
|
/**
|
|
792
1105
|
* Dispatch action to create a new tenant
|
|
793
1106
|
* @param body - The tenant creation request
|
|
794
1107
|
* @returns Promise with the created tenant
|
|
795
1108
|
*/
|
|
796
|
-
dispatchCreateTenant(body:
|
|
1109
|
+
dispatchCreateTenant(body: SaasTenantCreateDto): Promise<SaasTenantDto>;
|
|
797
1110
|
/**
|
|
798
1111
|
* Dispatch action to update a tenant
|
|
799
|
-
* @param
|
|
1112
|
+
* @param payload - Object containing id and update data
|
|
800
1113
|
* @returns Promise with the updated tenant
|
|
801
1114
|
*/
|
|
802
|
-
dispatchUpdateTenant(
|
|
1115
|
+
dispatchUpdateTenant(payload: SaasTenantUpdateDto & {
|
|
1116
|
+
id: string;
|
|
1117
|
+
}): Promise<SaasTenantDto>;
|
|
803
1118
|
/**
|
|
804
1119
|
* Dispatch action to delete a tenant
|
|
805
1120
|
* @param id - The tenant ID to delete
|
|
@@ -811,31 +1126,33 @@ declare class SaasStateService {
|
|
|
811
1126
|
* @returns Promise with the latest tenants
|
|
812
1127
|
* @since 2.0.0
|
|
813
1128
|
*/
|
|
814
|
-
dispatchGetLatestTenants(): Promise<
|
|
1129
|
+
dispatchGetLatestTenants(): Promise<PagedResultDto<SaasTenantDto>>;
|
|
815
1130
|
/**
|
|
816
1131
|
* Dispatch action to fetch editions with optional pagination
|
|
817
1132
|
* @param params - Optional query parameters for pagination and filtering
|
|
818
1133
|
* @returns Promise with the editions response
|
|
819
1134
|
*/
|
|
820
|
-
dispatchGetEditions(params?:
|
|
1135
|
+
dispatchGetEditions(params?: GetEditionsInput): Promise<PagedResultDto<EditionDto>>;
|
|
821
1136
|
/**
|
|
822
1137
|
* Dispatch action to fetch an edition by ID
|
|
823
1138
|
* @param id - The edition ID
|
|
824
1139
|
* @returns Promise with the edition
|
|
825
1140
|
*/
|
|
826
|
-
dispatchGetEditionById(id: string): Promise<
|
|
1141
|
+
dispatchGetEditionById(id: string): Promise<EditionDto>;
|
|
827
1142
|
/**
|
|
828
1143
|
* Dispatch action to create a new edition
|
|
829
1144
|
* @param body - The edition creation request
|
|
830
1145
|
* @returns Promise with the created edition
|
|
831
1146
|
*/
|
|
832
|
-
dispatchCreateEdition(body:
|
|
1147
|
+
dispatchCreateEdition(body: EditionCreateDto): Promise<EditionDto>;
|
|
833
1148
|
/**
|
|
834
1149
|
* Dispatch action to update an edition
|
|
835
|
-
* @param
|
|
1150
|
+
* @param payload - Object containing id and update data
|
|
836
1151
|
* @returns Promise with the updated edition
|
|
837
1152
|
*/
|
|
838
|
-
dispatchUpdateEdition(
|
|
1153
|
+
dispatchUpdateEdition(payload: EditionUpdateDto & {
|
|
1154
|
+
id: string;
|
|
1155
|
+
}): Promise<EditionDto>;
|
|
839
1156
|
/**
|
|
840
1157
|
* Dispatch action to delete an edition
|
|
841
1158
|
* @param id - The edition ID to delete
|
|
@@ -846,7 +1163,7 @@ declare class SaasStateService {
|
|
|
846
1163
|
* Dispatch action to fetch usage statistics
|
|
847
1164
|
* @returns Promise with the usage statistics response
|
|
848
1165
|
*/
|
|
849
|
-
dispatchGetUsageStatistics(): Promise<
|
|
1166
|
+
dispatchGetUsageStatistics(): Promise<GetEditionUsageStatisticsResult>;
|
|
850
1167
|
}
|
|
851
1168
|
|
|
852
1169
|
/**
|
|
@@ -1112,4 +1429,4 @@ interface EditionsComponentProps {
|
|
|
1112
1429
|
*/
|
|
1113
1430
|
declare function EditionsComponent({ onEditionCreated, onEditionUpdated, onEditionDeleted, onManageFeatures, }: EditionsComponentProps): react_jsx_runtime.JSX.Element;
|
|
1114
1431
|
|
|
1115
|
-
export { type CreateFormPropContributorCallback, DEFAULT_EDITIONS_CREATE_FORM_PROPS, DEFAULT_EDITIONS_EDIT_FORM_PROPS, DEFAULT_EDITIONS_ENTITY_ACTIONS, DEFAULT_EDITIONS_ENTITY_PROPS, DEFAULT_EDITIONS_TOOLBAR_ACTIONS, DEFAULT_SAAS_CREATE_FORM_PROPS, DEFAULT_SAAS_EDIT_FORM_PROPS, DEFAULT_SAAS_ENTITY_ACTIONS, DEFAULT_SAAS_ENTITY_PROPS, DEFAULT_SAAS_TOOLBAR_ACTIONS, DEFAULT_TENANTS_CREATE_FORM_PROPS, DEFAULT_TENANTS_EDIT_FORM_PROPS, DEFAULT_TENANTS_ENTITY_ACTIONS, DEFAULT_TENANTS_ENTITY_PROPS, DEFAULT_TENANTS_TOOLBAR_ACTIONS, type EditFormPropContributorCallback, type EditionOperationResult, EditionsComponent, type EditionsComponentProps, type EntityAction, type EntityActionContributorCallback, type EntityProp, type EntityPropContributorCallback, type FormProp, SAAS_CREATE_FORM_PROP_CONTRIBUTORS, SAAS_EDIT_FORM_PROP_CONTRIBUTORS, SAAS_ENTITY_ACTION_CONTRIBUTORS, SAAS_ENTITY_PROP_CONTRIBUTORS, SAAS_ROUTES, SAAS_ROUTE_CONFIG, SAAS_ROUTE_PROVIDERS, SAAS_TOOLBAR_ACTION_CONTRIBUTORS, Saas, type SaasComponentKey, type SaasConfigOptions, type SaasCreateFormPropContributors, type SaasEditFormPropContributors, type SaasEntityActionContributors, type SaasEntityPropContributors, SaasExtensionsGuard, type SaasPolicyNameKey, type SaasRouteNameKey, SaasService, SaasStateService, type SaasToolbarActionContributors, type SortOrder$1 as SortOrder, type TenantOperationResult, TenantsComponent, type TenantsComponentProps, type ToolbarAction, type ToolbarActionContributorCallback, type UseEditionsReturn, type UseTenantsReturn, configureRoutes, eSaasComponents, eSaasPolicyNames, eSaasRouteNames, initializeSaasRoutes, saasExtensionsGuard, useEditions, useSaasExtensionsGuard, useTenants };
|
|
1432
|
+
export { type CreateFormPropContributorCallback, DEFAULT_EDITIONS_CREATE_FORM_PROPS, DEFAULT_EDITIONS_EDIT_FORM_PROPS, DEFAULT_EDITIONS_ENTITY_ACTIONS, DEFAULT_EDITIONS_ENTITY_PROPS, DEFAULT_EDITIONS_TOOLBAR_ACTIONS, DEFAULT_SAAS_CREATE_FORM_PROPS, DEFAULT_SAAS_EDIT_FORM_PROPS, DEFAULT_SAAS_ENTITY_ACTIONS, DEFAULT_SAAS_ENTITY_PROPS, DEFAULT_SAAS_TOOLBAR_ACTIONS, DEFAULT_TENANTS_CREATE_FORM_PROPS, DEFAULT_TENANTS_EDIT_FORM_PROPS, DEFAULT_TENANTS_ENTITY_ACTIONS, DEFAULT_TENANTS_ENTITY_PROPS, DEFAULT_TENANTS_TOOLBAR_ACTIONS, type EditFormPropContributorCallback, type EditionCreateDto, type EditionCreateOrUpdateDtoBase, type EditionDto, type EditionOperationResult, EditionService, type EditionUpdateDto, EditionsComponent, type EditionsComponentProps, type EntityAction, type EntityActionContributorCallback, type EntityProp, type EntityPropContributorCallback, type FormProp, type GetEditionUsageStatisticsResult, type GetEditionsInput, type GetTenantsInput, SAAS_CREATE_FORM_PROP_CONTRIBUTORS, SAAS_EDIT_FORM_PROP_CONTRIBUTORS, SAAS_ENTITY_ACTION_CONTRIBUTORS, SAAS_ENTITY_PROP_CONTRIBUTORS, SAAS_ROUTES, SAAS_ROUTE_CONFIG, SAAS_ROUTE_PROVIDERS, SAAS_TOOLBAR_ACTION_CONTRIBUTORS, Saas, type SaasComponentKey, type SaasConfigOptions, type SaasCreateFormPropContributors, type SaasEditFormPropContributors, type SaasEntityActionContributors, type SaasEntityPropContributors, SaasExtensionsGuard, type SaasPolicyNameKey, type SaasRouteNameKey, SaasService, SaasStateService, type SaasTenantCreateDto, type SaasTenantCreateOrUpdateDtoBase, type SaasTenantDto, type SaasTenantUpdateDto, type SaasToolbarActionContributors, type SortOrder$1 as SortOrder, type TenantOperationResult, TenantService, TenantsComponent, type TenantsComponentProps, type ToolbarAction, type ToolbarActionContributorCallback, type UseEditionsReturn, type UseTenantsReturn, configureRoutes, eSaasComponents, eSaasPolicyNames, eSaasRouteNames, initializeSaasRoutes, saasExtensionsGuard, useEditions, useSaasExtensionsGuard, useTenants };
|