@abpjs/saas 3.2.0 → 4.0.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 +167 -156
- package/dist/index.d.ts +167 -156
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -364,151 +364,6 @@ declare const eSaasComponents: {
|
|
|
364
364
|
*/
|
|
365
365
|
type SaasComponentKey = (typeof eSaasComponents)[keyof typeof eSaasComponents];
|
|
366
366
|
|
|
367
|
-
/**
|
|
368
|
-
* SaaS Models
|
|
369
|
-
* Translated from @volo/abp.ng.saas v3.2.0
|
|
370
|
-
*
|
|
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
|
|
373
|
-
*/
|
|
374
|
-
|
|
375
|
-
/**
|
|
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.
|
|
388
|
-
*/
|
|
389
|
-
declare namespace Saas {
|
|
390
|
-
/**
|
|
391
|
-
* State interface for SaaS
|
|
392
|
-
* @updated 3.2.0 - Now uses proxy DTOs (PagedResultDto<SaasTenantDto>, PagedResultDto<EditionDto>)
|
|
393
|
-
*/
|
|
394
|
-
interface State {
|
|
395
|
-
tenants: PagedResultDto<SaasTenantDto>;
|
|
396
|
-
editions: PagedResultDto<EditionDto>;
|
|
397
|
-
usageStatistics: Record<string, number>;
|
|
398
|
-
latestTenants: SaasTenantDto[];
|
|
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>;
|
|
410
|
-
/**
|
|
411
|
-
* Tenant interface
|
|
412
|
-
* @deprecated Use SaasTenantDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
413
|
-
*/
|
|
414
|
-
interface Tenant {
|
|
415
|
-
id: string;
|
|
416
|
-
name: string;
|
|
417
|
-
editionId?: string;
|
|
418
|
-
editionName?: string;
|
|
419
|
-
concurrencyStamp?: string;
|
|
420
|
-
}
|
|
421
|
-
/**
|
|
422
|
-
* Edition interface
|
|
423
|
-
* @deprecated Use EditionDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
424
|
-
*/
|
|
425
|
-
interface Edition {
|
|
426
|
-
id: string;
|
|
427
|
-
displayName: string;
|
|
428
|
-
concurrencyStamp?: string;
|
|
429
|
-
}
|
|
430
|
-
/**
|
|
431
|
-
* Query parameters for fetching tenants
|
|
432
|
-
* @deprecated Use GetTenantsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
433
|
-
*/
|
|
434
|
-
interface TenantsQueryParams {
|
|
435
|
-
filter?: string;
|
|
436
|
-
editionId?: string;
|
|
437
|
-
getEditionNames?: boolean;
|
|
438
|
-
skipCount?: number;
|
|
439
|
-
maxResultCount?: number;
|
|
440
|
-
sorting?: string;
|
|
441
|
-
}
|
|
442
|
-
/**
|
|
443
|
-
* Query parameters for fetching editions
|
|
444
|
-
* @deprecated Use GetEditionsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
445
|
-
*/
|
|
446
|
-
interface EditionsQueryParams {
|
|
447
|
-
filter?: string;
|
|
448
|
-
skipCount?: number;
|
|
449
|
-
maxResultCount?: number;
|
|
450
|
-
sorting?: string;
|
|
451
|
-
}
|
|
452
|
-
/**
|
|
453
|
-
* Create tenant request
|
|
454
|
-
* @deprecated Use SaasTenantCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
455
|
-
* @updated 2.4.0 - adminEmailAddress and adminPassword are now required
|
|
456
|
-
*/
|
|
457
|
-
interface CreateTenantRequest {
|
|
458
|
-
adminEmailAddress: string;
|
|
459
|
-
adminPassword: string;
|
|
460
|
-
name: string;
|
|
461
|
-
editionId?: string;
|
|
462
|
-
}
|
|
463
|
-
/**
|
|
464
|
-
* Update tenant request
|
|
465
|
-
* @deprecated Use SaasTenantUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
466
|
-
* @updated 2.4.0 - Now uses Omit<Tenant, 'editionName'> pattern
|
|
467
|
-
*/
|
|
468
|
-
type UpdateTenantRequest = Omit<Tenant, 'editionName'>;
|
|
469
|
-
/**
|
|
470
|
-
* Create edition request
|
|
471
|
-
* @deprecated Use EditionCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
472
|
-
*/
|
|
473
|
-
interface CreateEditionRequest {
|
|
474
|
-
displayName: string;
|
|
475
|
-
}
|
|
476
|
-
/**
|
|
477
|
-
* Update edition request
|
|
478
|
-
* @deprecated Use EditionUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
479
|
-
*/
|
|
480
|
-
interface UpdateEditionRequest {
|
|
481
|
-
id?: string;
|
|
482
|
-
displayName: string;
|
|
483
|
-
concurrencyStamp?: string;
|
|
484
|
-
}
|
|
485
|
-
/**
|
|
486
|
-
* Default connection string request
|
|
487
|
-
* @deprecated Use TenantService.updateDefaultConnectionString(id, connectionString) instead. To be removed in v4.0.
|
|
488
|
-
*/
|
|
489
|
-
interface DefaultConnectionStringRequest {
|
|
490
|
-
id: string;
|
|
491
|
-
defaultConnectionString: string;
|
|
492
|
-
}
|
|
493
|
-
/**
|
|
494
|
-
* Paginated response for tenants
|
|
495
|
-
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be removed in v4.0.
|
|
496
|
-
*/
|
|
497
|
-
type TenantsResponse = PagedResultDto<Tenant>;
|
|
498
|
-
/**
|
|
499
|
-
* Paginated response for editions
|
|
500
|
-
* @deprecated Use PagedResultDto<EditionDto> instead. To be removed in v4.0.
|
|
501
|
-
*/
|
|
502
|
-
type EditionsResponse = PagedResultDto<Edition>;
|
|
503
|
-
/**
|
|
504
|
-
* Usage statistics response
|
|
505
|
-
* @deprecated Use GetEditionUsageStatisticsResult from proxy/host/models instead. To be removed in v4.0.
|
|
506
|
-
*/
|
|
507
|
-
interface UsageStatisticsResponse {
|
|
508
|
-
data: Record<string, number>;
|
|
509
|
-
}
|
|
510
|
-
}
|
|
511
|
-
|
|
512
367
|
/**
|
|
513
368
|
* SaaS Extension Tokens
|
|
514
369
|
* Translated from @volo/abp.ng.saas v3.2.0
|
|
@@ -733,57 +588,63 @@ declare const SAAS_EDIT_FORM_PROP_CONTRIBUTORS: unique symbol;
|
|
|
733
588
|
|
|
734
589
|
/**
|
|
735
590
|
* SaaS Config Options
|
|
736
|
-
* Translated from @volo/abp.ng.saas
|
|
591
|
+
* Translated from @volo/abp.ng.saas v4.0.0
|
|
737
592
|
*
|
|
738
593
|
* Configuration options for SaaS module extensibility.
|
|
739
594
|
*
|
|
740
595
|
* @since 3.0.0
|
|
596
|
+
* @updated 4.0.0 - Now uses proxy DTOs (EditionDto, SaasTenantDto) instead of Saas.Edition/Saas.Tenant
|
|
741
597
|
*/
|
|
742
598
|
|
|
743
599
|
/**
|
|
744
600
|
* SaaS entity action contributors type
|
|
745
601
|
* Maps component keys to their entity action contributor callbacks
|
|
746
602
|
* @since 3.0.0
|
|
603
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
747
604
|
*/
|
|
748
605
|
type SaasEntityActionContributors = Partial<{
|
|
749
|
-
[eSaasComponents.Editions]: EntityActionContributorCallback<
|
|
750
|
-
[eSaasComponents.Tenants]: EntityActionContributorCallback<
|
|
606
|
+
[eSaasComponents.Editions]: EntityActionContributorCallback<EditionDto>[];
|
|
607
|
+
[eSaasComponents.Tenants]: EntityActionContributorCallback<SaasTenantDto>[];
|
|
751
608
|
}>;
|
|
752
609
|
/**
|
|
753
610
|
* SaaS toolbar action contributors type
|
|
754
611
|
* Maps component keys to their toolbar action contributor callbacks
|
|
755
612
|
* @since 3.0.0
|
|
613
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
756
614
|
*/
|
|
757
615
|
type SaasToolbarActionContributors = Partial<{
|
|
758
|
-
[eSaasComponents.Editions]: ToolbarActionContributorCallback<
|
|
759
|
-
[eSaasComponents.Tenants]: ToolbarActionContributorCallback<
|
|
616
|
+
[eSaasComponents.Editions]: ToolbarActionContributorCallback<EditionDto[]>[];
|
|
617
|
+
[eSaasComponents.Tenants]: ToolbarActionContributorCallback<SaasTenantDto[]>[];
|
|
760
618
|
}>;
|
|
761
619
|
/**
|
|
762
620
|
* SaaS entity prop contributors type
|
|
763
621
|
* Maps component keys to their entity prop contributor callbacks
|
|
764
622
|
* @since 3.0.0
|
|
623
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
765
624
|
*/
|
|
766
625
|
type SaasEntityPropContributors = Partial<{
|
|
767
|
-
[eSaasComponents.Editions]: EntityPropContributorCallback<
|
|
768
|
-
[eSaasComponents.Tenants]: EntityPropContributorCallback<
|
|
626
|
+
[eSaasComponents.Editions]: EntityPropContributorCallback<EditionDto>[];
|
|
627
|
+
[eSaasComponents.Tenants]: EntityPropContributorCallback<SaasTenantDto>[];
|
|
769
628
|
}>;
|
|
770
629
|
/**
|
|
771
630
|
* SaaS create form prop contributors type
|
|
772
631
|
* Maps component keys to their create form prop contributor callbacks
|
|
773
632
|
* @since 3.0.0
|
|
633
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
774
634
|
*/
|
|
775
635
|
type SaasCreateFormPropContributors = Partial<{
|
|
776
|
-
[eSaasComponents.Editions]: CreateFormPropContributorCallback<
|
|
777
|
-
[eSaasComponents.Tenants]: CreateFormPropContributorCallback<
|
|
636
|
+
[eSaasComponents.Editions]: CreateFormPropContributorCallback<EditionDto>[];
|
|
637
|
+
[eSaasComponents.Tenants]: CreateFormPropContributorCallback<SaasTenantDto>[];
|
|
778
638
|
}>;
|
|
779
639
|
/**
|
|
780
640
|
* SaaS edit form prop contributors type
|
|
781
641
|
* Maps component keys to their edit form prop contributor callbacks
|
|
782
642
|
* @since 3.0.0
|
|
643
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
783
644
|
*/
|
|
784
645
|
type SaasEditFormPropContributors = Partial<{
|
|
785
|
-
[eSaasComponents.Editions]: EditFormPropContributorCallback<
|
|
786
|
-
[eSaasComponents.Tenants]: EditFormPropContributorCallback<
|
|
646
|
+
[eSaasComponents.Editions]: EditFormPropContributorCallback<EditionDto>[];
|
|
647
|
+
[eSaasComponents.Tenants]: EditFormPropContributorCallback<SaasTenantDto>[];
|
|
787
648
|
}>;
|
|
788
649
|
/**
|
|
789
650
|
* SaaS module configuration options
|
|
@@ -829,6 +690,152 @@ interface SaasConfigOptions {
|
|
|
829
690
|
editFormPropContributors?: SaasEditFormPropContributors;
|
|
830
691
|
}
|
|
831
692
|
|
|
693
|
+
/**
|
|
694
|
+
* SaaS Models
|
|
695
|
+
* Translated from @volo/abp.ng.saas v4.0.0
|
|
696
|
+
*
|
|
697
|
+
* @updated 2.4.0 - Updated CreateTenantRequest and UpdateTenantRequest types
|
|
698
|
+
* @updated 3.2.0 - Added deprecation notices for legacy types, state now uses proxy DTOs
|
|
699
|
+
* @updated 4.0.0 - Deprecated types kept for backward compatibility (to be deleted in v5.0)
|
|
700
|
+
*/
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* Saas namespace containing all models for SaaS management
|
|
704
|
+
*
|
|
705
|
+
* @deprecated The types in this namespace are deprecated in favor of the proxy DTOs.
|
|
706
|
+
* Use the following instead:
|
|
707
|
+
* - `SaasTenantDto` instead of `Saas.Tenant`
|
|
708
|
+
* - `EditionDto` instead of `Saas.Edition`
|
|
709
|
+
* - `SaasTenantCreateDto` instead of `Saas.CreateTenantRequest`
|
|
710
|
+
* - `SaasTenantUpdateDto` instead of `Saas.UpdateTenantRequest`
|
|
711
|
+
* - `EditionCreateDto` instead of `Saas.CreateEditionRequest`
|
|
712
|
+
* - `EditionUpdateDto` instead of `Saas.UpdateEditionRequest`
|
|
713
|
+
*
|
|
714
|
+
* These legacy types will be removed in v5.0.
|
|
715
|
+
*/
|
|
716
|
+
declare namespace Saas {
|
|
717
|
+
/**
|
|
718
|
+
* State interface for SaaS
|
|
719
|
+
* @updated 3.2.0 - Now uses proxy DTOs (PagedResultDto<SaasTenantDto>, PagedResultDto<EditionDto>)
|
|
720
|
+
*/
|
|
721
|
+
interface State {
|
|
722
|
+
tenants: PagedResultDto<SaasTenantDto>;
|
|
723
|
+
editions: PagedResultDto<EditionDto>;
|
|
724
|
+
usageStatistics: Record<string, number>;
|
|
725
|
+
latestTenants: SaasTenantDto[];
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* Tenant response type alias
|
|
729
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be deleted in v5.0.
|
|
730
|
+
*/
|
|
731
|
+
type TenantResponse = PagedResultDto<Tenant>;
|
|
732
|
+
/**
|
|
733
|
+
* Edition response type alias
|
|
734
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be deleted in v5.0.
|
|
735
|
+
*/
|
|
736
|
+
type EditionResponse = PagedResultDto<Edition>;
|
|
737
|
+
/**
|
|
738
|
+
* Tenant interface
|
|
739
|
+
* @deprecated Use SaasTenantDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
740
|
+
*/
|
|
741
|
+
interface Tenant {
|
|
742
|
+
id: string;
|
|
743
|
+
name: string;
|
|
744
|
+
editionId?: string;
|
|
745
|
+
editionName?: string;
|
|
746
|
+
concurrencyStamp?: string;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* Edition interface
|
|
750
|
+
* @deprecated Use EditionDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
751
|
+
*/
|
|
752
|
+
interface Edition {
|
|
753
|
+
id: string;
|
|
754
|
+
displayName: string;
|
|
755
|
+
concurrencyStamp?: string;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Query parameters for fetching tenants
|
|
759
|
+
* @deprecated Use GetTenantsInput from proxy/host/dtos instead. To be deleted in v5.0.
|
|
760
|
+
*/
|
|
761
|
+
interface TenantsQueryParams {
|
|
762
|
+
filter?: string;
|
|
763
|
+
editionId?: string;
|
|
764
|
+
getEditionNames?: boolean;
|
|
765
|
+
skipCount?: number;
|
|
766
|
+
maxResultCount?: number;
|
|
767
|
+
sorting?: string;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* Query parameters for fetching editions
|
|
771
|
+
* @deprecated Use GetEditionsInput from proxy/host/dtos instead. To be deleted in v5.0.
|
|
772
|
+
*/
|
|
773
|
+
interface EditionsQueryParams {
|
|
774
|
+
filter?: string;
|
|
775
|
+
skipCount?: number;
|
|
776
|
+
maxResultCount?: number;
|
|
777
|
+
sorting?: string;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* Create tenant request
|
|
781
|
+
* @deprecated Use SaasTenantCreateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
782
|
+
* @updated 2.4.0 - adminEmailAddress and adminPassword are now required
|
|
783
|
+
*/
|
|
784
|
+
interface CreateTenantRequest {
|
|
785
|
+
adminEmailAddress: string;
|
|
786
|
+
adminPassword: string;
|
|
787
|
+
name: string;
|
|
788
|
+
editionId?: string;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Update tenant request
|
|
792
|
+
* @deprecated Use SaasTenantUpdateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
793
|
+
* @updated 2.4.0 - Now uses Omit<Tenant, 'editionName'> pattern
|
|
794
|
+
*/
|
|
795
|
+
type UpdateTenantRequest = Omit<Tenant, 'editionName'>;
|
|
796
|
+
/**
|
|
797
|
+
* Create edition request
|
|
798
|
+
* @deprecated Use EditionCreateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
799
|
+
*/
|
|
800
|
+
interface CreateEditionRequest {
|
|
801
|
+
displayName: string;
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* Update edition request
|
|
805
|
+
* @deprecated Use EditionUpdateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
806
|
+
*/
|
|
807
|
+
interface UpdateEditionRequest {
|
|
808
|
+
id?: string;
|
|
809
|
+
displayName: string;
|
|
810
|
+
concurrencyStamp?: string;
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
813
|
+
* Default connection string request
|
|
814
|
+
* @deprecated Use TenantService.updateDefaultConnectionString(id, connectionString) instead. To be deleted in v5.0.
|
|
815
|
+
*/
|
|
816
|
+
interface DefaultConnectionStringRequest {
|
|
817
|
+
id: string;
|
|
818
|
+
defaultConnectionString: string;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* Paginated response for tenants
|
|
822
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be deleted in v5.0.
|
|
823
|
+
*/
|
|
824
|
+
type TenantsResponse = PagedResultDto<Tenant>;
|
|
825
|
+
/**
|
|
826
|
+
* Paginated response for editions
|
|
827
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be deleted in v5.0.
|
|
828
|
+
*/
|
|
829
|
+
type EditionsResponse = PagedResultDto<Edition>;
|
|
830
|
+
/**
|
|
831
|
+
* Usage statistics response
|
|
832
|
+
* @deprecated Use GetEditionUsageStatisticsResult from proxy/host/models instead. To be deleted in v5.0.
|
|
833
|
+
*/
|
|
834
|
+
interface UsageStatisticsResponse {
|
|
835
|
+
data: Record<string, number>;
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
|
|
832
839
|
/**
|
|
833
840
|
* SaaS Routes
|
|
834
841
|
* Translated from @volo/abp.ng.saas v0.7.2
|
|
@@ -915,6 +922,9 @@ declare class SaasExtensionsGuard {
|
|
|
915
922
|
*
|
|
916
923
|
* Provides REST API methods for managing tenants, editions,
|
|
917
924
|
* and connection strings in a multi-tenant SaaS application.
|
|
925
|
+
*
|
|
926
|
+
* @deprecated To be deleted in v5.0. Use proxy services (TenantService, EditionService) instead.
|
|
927
|
+
* This service was deleted in the Angular source at v4.0.0.
|
|
918
928
|
*/
|
|
919
929
|
|
|
920
930
|
/**
|
|
@@ -923,6 +933,7 @@ declare class SaasExtensionsGuard {
|
|
|
923
933
|
*
|
|
924
934
|
* @since 2.0.0
|
|
925
935
|
* @updated 2.4.0 - Added apiName property
|
|
936
|
+
* @deprecated To be deleted in v5.0. Use proxy services (TenantService, EditionService) instead.
|
|
926
937
|
*/
|
|
927
938
|
declare class SaasService {
|
|
928
939
|
private restService;
|
package/dist/index.d.ts
CHANGED
|
@@ -364,151 +364,6 @@ declare const eSaasComponents: {
|
|
|
364
364
|
*/
|
|
365
365
|
type SaasComponentKey = (typeof eSaasComponents)[keyof typeof eSaasComponents];
|
|
366
366
|
|
|
367
|
-
/**
|
|
368
|
-
* SaaS Models
|
|
369
|
-
* Translated from @volo/abp.ng.saas v3.2.0
|
|
370
|
-
*
|
|
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
|
|
373
|
-
*/
|
|
374
|
-
|
|
375
|
-
/**
|
|
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.
|
|
388
|
-
*/
|
|
389
|
-
declare namespace Saas {
|
|
390
|
-
/**
|
|
391
|
-
* State interface for SaaS
|
|
392
|
-
* @updated 3.2.0 - Now uses proxy DTOs (PagedResultDto<SaasTenantDto>, PagedResultDto<EditionDto>)
|
|
393
|
-
*/
|
|
394
|
-
interface State {
|
|
395
|
-
tenants: PagedResultDto<SaasTenantDto>;
|
|
396
|
-
editions: PagedResultDto<EditionDto>;
|
|
397
|
-
usageStatistics: Record<string, number>;
|
|
398
|
-
latestTenants: SaasTenantDto[];
|
|
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>;
|
|
410
|
-
/**
|
|
411
|
-
* Tenant interface
|
|
412
|
-
* @deprecated Use SaasTenantDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
413
|
-
*/
|
|
414
|
-
interface Tenant {
|
|
415
|
-
id: string;
|
|
416
|
-
name: string;
|
|
417
|
-
editionId?: string;
|
|
418
|
-
editionName?: string;
|
|
419
|
-
concurrencyStamp?: string;
|
|
420
|
-
}
|
|
421
|
-
/**
|
|
422
|
-
* Edition interface
|
|
423
|
-
* @deprecated Use EditionDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
424
|
-
*/
|
|
425
|
-
interface Edition {
|
|
426
|
-
id: string;
|
|
427
|
-
displayName: string;
|
|
428
|
-
concurrencyStamp?: string;
|
|
429
|
-
}
|
|
430
|
-
/**
|
|
431
|
-
* Query parameters for fetching tenants
|
|
432
|
-
* @deprecated Use GetTenantsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
433
|
-
*/
|
|
434
|
-
interface TenantsQueryParams {
|
|
435
|
-
filter?: string;
|
|
436
|
-
editionId?: string;
|
|
437
|
-
getEditionNames?: boolean;
|
|
438
|
-
skipCount?: number;
|
|
439
|
-
maxResultCount?: number;
|
|
440
|
-
sorting?: string;
|
|
441
|
-
}
|
|
442
|
-
/**
|
|
443
|
-
* Query parameters for fetching editions
|
|
444
|
-
* @deprecated Use GetEditionsInput from proxy/host/dtos instead. To be removed in v4.0.
|
|
445
|
-
*/
|
|
446
|
-
interface EditionsQueryParams {
|
|
447
|
-
filter?: string;
|
|
448
|
-
skipCount?: number;
|
|
449
|
-
maxResultCount?: number;
|
|
450
|
-
sorting?: string;
|
|
451
|
-
}
|
|
452
|
-
/**
|
|
453
|
-
* Create tenant request
|
|
454
|
-
* @deprecated Use SaasTenantCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
455
|
-
* @updated 2.4.0 - adminEmailAddress and adminPassword are now required
|
|
456
|
-
*/
|
|
457
|
-
interface CreateTenantRequest {
|
|
458
|
-
adminEmailAddress: string;
|
|
459
|
-
adminPassword: string;
|
|
460
|
-
name: string;
|
|
461
|
-
editionId?: string;
|
|
462
|
-
}
|
|
463
|
-
/**
|
|
464
|
-
* Update tenant request
|
|
465
|
-
* @deprecated Use SaasTenantUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
466
|
-
* @updated 2.4.0 - Now uses Omit<Tenant, 'editionName'> pattern
|
|
467
|
-
*/
|
|
468
|
-
type UpdateTenantRequest = Omit<Tenant, 'editionName'>;
|
|
469
|
-
/**
|
|
470
|
-
* Create edition request
|
|
471
|
-
* @deprecated Use EditionCreateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
472
|
-
*/
|
|
473
|
-
interface CreateEditionRequest {
|
|
474
|
-
displayName: string;
|
|
475
|
-
}
|
|
476
|
-
/**
|
|
477
|
-
* Update edition request
|
|
478
|
-
* @deprecated Use EditionUpdateDto from proxy/host/dtos instead. To be removed in v4.0.
|
|
479
|
-
*/
|
|
480
|
-
interface UpdateEditionRequest {
|
|
481
|
-
id?: string;
|
|
482
|
-
displayName: string;
|
|
483
|
-
concurrencyStamp?: string;
|
|
484
|
-
}
|
|
485
|
-
/**
|
|
486
|
-
* Default connection string request
|
|
487
|
-
* @deprecated Use TenantService.updateDefaultConnectionString(id, connectionString) instead. To be removed in v4.0.
|
|
488
|
-
*/
|
|
489
|
-
interface DefaultConnectionStringRequest {
|
|
490
|
-
id: string;
|
|
491
|
-
defaultConnectionString: string;
|
|
492
|
-
}
|
|
493
|
-
/**
|
|
494
|
-
* Paginated response for tenants
|
|
495
|
-
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be removed in v4.0.
|
|
496
|
-
*/
|
|
497
|
-
type TenantsResponse = PagedResultDto<Tenant>;
|
|
498
|
-
/**
|
|
499
|
-
* Paginated response for editions
|
|
500
|
-
* @deprecated Use PagedResultDto<EditionDto> instead. To be removed in v4.0.
|
|
501
|
-
*/
|
|
502
|
-
type EditionsResponse = PagedResultDto<Edition>;
|
|
503
|
-
/**
|
|
504
|
-
* Usage statistics response
|
|
505
|
-
* @deprecated Use GetEditionUsageStatisticsResult from proxy/host/models instead. To be removed in v4.0.
|
|
506
|
-
*/
|
|
507
|
-
interface UsageStatisticsResponse {
|
|
508
|
-
data: Record<string, number>;
|
|
509
|
-
}
|
|
510
|
-
}
|
|
511
|
-
|
|
512
367
|
/**
|
|
513
368
|
* SaaS Extension Tokens
|
|
514
369
|
* Translated from @volo/abp.ng.saas v3.2.0
|
|
@@ -733,57 +588,63 @@ declare const SAAS_EDIT_FORM_PROP_CONTRIBUTORS: unique symbol;
|
|
|
733
588
|
|
|
734
589
|
/**
|
|
735
590
|
* SaaS Config Options
|
|
736
|
-
* Translated from @volo/abp.ng.saas
|
|
591
|
+
* Translated from @volo/abp.ng.saas v4.0.0
|
|
737
592
|
*
|
|
738
593
|
* Configuration options for SaaS module extensibility.
|
|
739
594
|
*
|
|
740
595
|
* @since 3.0.0
|
|
596
|
+
* @updated 4.0.0 - Now uses proxy DTOs (EditionDto, SaasTenantDto) instead of Saas.Edition/Saas.Tenant
|
|
741
597
|
*/
|
|
742
598
|
|
|
743
599
|
/**
|
|
744
600
|
* SaaS entity action contributors type
|
|
745
601
|
* Maps component keys to their entity action contributor callbacks
|
|
746
602
|
* @since 3.0.0
|
|
603
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
747
604
|
*/
|
|
748
605
|
type SaasEntityActionContributors = Partial<{
|
|
749
|
-
[eSaasComponents.Editions]: EntityActionContributorCallback<
|
|
750
|
-
[eSaasComponents.Tenants]: EntityActionContributorCallback<
|
|
606
|
+
[eSaasComponents.Editions]: EntityActionContributorCallback<EditionDto>[];
|
|
607
|
+
[eSaasComponents.Tenants]: EntityActionContributorCallback<SaasTenantDto>[];
|
|
751
608
|
}>;
|
|
752
609
|
/**
|
|
753
610
|
* SaaS toolbar action contributors type
|
|
754
611
|
* Maps component keys to their toolbar action contributor callbacks
|
|
755
612
|
* @since 3.0.0
|
|
613
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
756
614
|
*/
|
|
757
615
|
type SaasToolbarActionContributors = Partial<{
|
|
758
|
-
[eSaasComponents.Editions]: ToolbarActionContributorCallback<
|
|
759
|
-
[eSaasComponents.Tenants]: ToolbarActionContributorCallback<
|
|
616
|
+
[eSaasComponents.Editions]: ToolbarActionContributorCallback<EditionDto[]>[];
|
|
617
|
+
[eSaasComponents.Tenants]: ToolbarActionContributorCallback<SaasTenantDto[]>[];
|
|
760
618
|
}>;
|
|
761
619
|
/**
|
|
762
620
|
* SaaS entity prop contributors type
|
|
763
621
|
* Maps component keys to their entity prop contributor callbacks
|
|
764
622
|
* @since 3.0.0
|
|
623
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
765
624
|
*/
|
|
766
625
|
type SaasEntityPropContributors = Partial<{
|
|
767
|
-
[eSaasComponents.Editions]: EntityPropContributorCallback<
|
|
768
|
-
[eSaasComponents.Tenants]: EntityPropContributorCallback<
|
|
626
|
+
[eSaasComponents.Editions]: EntityPropContributorCallback<EditionDto>[];
|
|
627
|
+
[eSaasComponents.Tenants]: EntityPropContributorCallback<SaasTenantDto>[];
|
|
769
628
|
}>;
|
|
770
629
|
/**
|
|
771
630
|
* SaaS create form prop contributors type
|
|
772
631
|
* Maps component keys to their create form prop contributor callbacks
|
|
773
632
|
* @since 3.0.0
|
|
633
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
774
634
|
*/
|
|
775
635
|
type SaasCreateFormPropContributors = Partial<{
|
|
776
|
-
[eSaasComponents.Editions]: CreateFormPropContributorCallback<
|
|
777
|
-
[eSaasComponents.Tenants]: CreateFormPropContributorCallback<
|
|
636
|
+
[eSaasComponents.Editions]: CreateFormPropContributorCallback<EditionDto>[];
|
|
637
|
+
[eSaasComponents.Tenants]: CreateFormPropContributorCallback<SaasTenantDto>[];
|
|
778
638
|
}>;
|
|
779
639
|
/**
|
|
780
640
|
* SaaS edit form prop contributors type
|
|
781
641
|
* Maps component keys to their edit form prop contributor callbacks
|
|
782
642
|
* @since 3.0.0
|
|
643
|
+
* @updated 4.0.0 - Now uses EditionDto/SaasTenantDto
|
|
783
644
|
*/
|
|
784
645
|
type SaasEditFormPropContributors = Partial<{
|
|
785
|
-
[eSaasComponents.Editions]: EditFormPropContributorCallback<
|
|
786
|
-
[eSaasComponents.Tenants]: EditFormPropContributorCallback<
|
|
646
|
+
[eSaasComponents.Editions]: EditFormPropContributorCallback<EditionDto>[];
|
|
647
|
+
[eSaasComponents.Tenants]: EditFormPropContributorCallback<SaasTenantDto>[];
|
|
787
648
|
}>;
|
|
788
649
|
/**
|
|
789
650
|
* SaaS module configuration options
|
|
@@ -829,6 +690,152 @@ interface SaasConfigOptions {
|
|
|
829
690
|
editFormPropContributors?: SaasEditFormPropContributors;
|
|
830
691
|
}
|
|
831
692
|
|
|
693
|
+
/**
|
|
694
|
+
* SaaS Models
|
|
695
|
+
* Translated from @volo/abp.ng.saas v4.0.0
|
|
696
|
+
*
|
|
697
|
+
* @updated 2.4.0 - Updated CreateTenantRequest and UpdateTenantRequest types
|
|
698
|
+
* @updated 3.2.0 - Added deprecation notices for legacy types, state now uses proxy DTOs
|
|
699
|
+
* @updated 4.0.0 - Deprecated types kept for backward compatibility (to be deleted in v5.0)
|
|
700
|
+
*/
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* Saas namespace containing all models for SaaS management
|
|
704
|
+
*
|
|
705
|
+
* @deprecated The types in this namespace are deprecated in favor of the proxy DTOs.
|
|
706
|
+
* Use the following instead:
|
|
707
|
+
* - `SaasTenantDto` instead of `Saas.Tenant`
|
|
708
|
+
* - `EditionDto` instead of `Saas.Edition`
|
|
709
|
+
* - `SaasTenantCreateDto` instead of `Saas.CreateTenantRequest`
|
|
710
|
+
* - `SaasTenantUpdateDto` instead of `Saas.UpdateTenantRequest`
|
|
711
|
+
* - `EditionCreateDto` instead of `Saas.CreateEditionRequest`
|
|
712
|
+
* - `EditionUpdateDto` instead of `Saas.UpdateEditionRequest`
|
|
713
|
+
*
|
|
714
|
+
* These legacy types will be removed in v5.0.
|
|
715
|
+
*/
|
|
716
|
+
declare namespace Saas {
|
|
717
|
+
/**
|
|
718
|
+
* State interface for SaaS
|
|
719
|
+
* @updated 3.2.0 - Now uses proxy DTOs (PagedResultDto<SaasTenantDto>, PagedResultDto<EditionDto>)
|
|
720
|
+
*/
|
|
721
|
+
interface State {
|
|
722
|
+
tenants: PagedResultDto<SaasTenantDto>;
|
|
723
|
+
editions: PagedResultDto<EditionDto>;
|
|
724
|
+
usageStatistics: Record<string, number>;
|
|
725
|
+
latestTenants: SaasTenantDto[];
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* Tenant response type alias
|
|
729
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be deleted in v5.0.
|
|
730
|
+
*/
|
|
731
|
+
type TenantResponse = PagedResultDto<Tenant>;
|
|
732
|
+
/**
|
|
733
|
+
* Edition response type alias
|
|
734
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be deleted in v5.0.
|
|
735
|
+
*/
|
|
736
|
+
type EditionResponse = PagedResultDto<Edition>;
|
|
737
|
+
/**
|
|
738
|
+
* Tenant interface
|
|
739
|
+
* @deprecated Use SaasTenantDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
740
|
+
*/
|
|
741
|
+
interface Tenant {
|
|
742
|
+
id: string;
|
|
743
|
+
name: string;
|
|
744
|
+
editionId?: string;
|
|
745
|
+
editionName?: string;
|
|
746
|
+
concurrencyStamp?: string;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* Edition interface
|
|
750
|
+
* @deprecated Use EditionDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
751
|
+
*/
|
|
752
|
+
interface Edition {
|
|
753
|
+
id: string;
|
|
754
|
+
displayName: string;
|
|
755
|
+
concurrencyStamp?: string;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Query parameters for fetching tenants
|
|
759
|
+
* @deprecated Use GetTenantsInput from proxy/host/dtos instead. To be deleted in v5.0.
|
|
760
|
+
*/
|
|
761
|
+
interface TenantsQueryParams {
|
|
762
|
+
filter?: string;
|
|
763
|
+
editionId?: string;
|
|
764
|
+
getEditionNames?: boolean;
|
|
765
|
+
skipCount?: number;
|
|
766
|
+
maxResultCount?: number;
|
|
767
|
+
sorting?: string;
|
|
768
|
+
}
|
|
769
|
+
/**
|
|
770
|
+
* Query parameters for fetching editions
|
|
771
|
+
* @deprecated Use GetEditionsInput from proxy/host/dtos instead. To be deleted in v5.0.
|
|
772
|
+
*/
|
|
773
|
+
interface EditionsQueryParams {
|
|
774
|
+
filter?: string;
|
|
775
|
+
skipCount?: number;
|
|
776
|
+
maxResultCount?: number;
|
|
777
|
+
sorting?: string;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* Create tenant request
|
|
781
|
+
* @deprecated Use SaasTenantCreateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
782
|
+
* @updated 2.4.0 - adminEmailAddress and adminPassword are now required
|
|
783
|
+
*/
|
|
784
|
+
interface CreateTenantRequest {
|
|
785
|
+
adminEmailAddress: string;
|
|
786
|
+
adminPassword: string;
|
|
787
|
+
name: string;
|
|
788
|
+
editionId?: string;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Update tenant request
|
|
792
|
+
* @deprecated Use SaasTenantUpdateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
793
|
+
* @updated 2.4.0 - Now uses Omit<Tenant, 'editionName'> pattern
|
|
794
|
+
*/
|
|
795
|
+
type UpdateTenantRequest = Omit<Tenant, 'editionName'>;
|
|
796
|
+
/**
|
|
797
|
+
* Create edition request
|
|
798
|
+
* @deprecated Use EditionCreateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
799
|
+
*/
|
|
800
|
+
interface CreateEditionRequest {
|
|
801
|
+
displayName: string;
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* Update edition request
|
|
805
|
+
* @deprecated Use EditionUpdateDto from proxy/host/dtos instead. To be deleted in v5.0.
|
|
806
|
+
*/
|
|
807
|
+
interface UpdateEditionRequest {
|
|
808
|
+
id?: string;
|
|
809
|
+
displayName: string;
|
|
810
|
+
concurrencyStamp?: string;
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
813
|
+
* Default connection string request
|
|
814
|
+
* @deprecated Use TenantService.updateDefaultConnectionString(id, connectionString) instead. To be deleted in v5.0.
|
|
815
|
+
*/
|
|
816
|
+
interface DefaultConnectionStringRequest {
|
|
817
|
+
id: string;
|
|
818
|
+
defaultConnectionString: string;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* Paginated response for tenants
|
|
822
|
+
* @deprecated Use PagedResultDto<SaasTenantDto> instead. To be deleted in v5.0.
|
|
823
|
+
*/
|
|
824
|
+
type TenantsResponse = PagedResultDto<Tenant>;
|
|
825
|
+
/**
|
|
826
|
+
* Paginated response for editions
|
|
827
|
+
* @deprecated Use PagedResultDto<EditionDto> instead. To be deleted in v5.0.
|
|
828
|
+
*/
|
|
829
|
+
type EditionsResponse = PagedResultDto<Edition>;
|
|
830
|
+
/**
|
|
831
|
+
* Usage statistics response
|
|
832
|
+
* @deprecated Use GetEditionUsageStatisticsResult from proxy/host/models instead. To be deleted in v5.0.
|
|
833
|
+
*/
|
|
834
|
+
interface UsageStatisticsResponse {
|
|
835
|
+
data: Record<string, number>;
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
|
|
832
839
|
/**
|
|
833
840
|
* SaaS Routes
|
|
834
841
|
* Translated from @volo/abp.ng.saas v0.7.2
|
|
@@ -915,6 +922,9 @@ declare class SaasExtensionsGuard {
|
|
|
915
922
|
*
|
|
916
923
|
* Provides REST API methods for managing tenants, editions,
|
|
917
924
|
* and connection strings in a multi-tenant SaaS application.
|
|
925
|
+
*
|
|
926
|
+
* @deprecated To be deleted in v5.0. Use proxy services (TenantService, EditionService) instead.
|
|
927
|
+
* This service was deleted in the Angular source at v4.0.0.
|
|
918
928
|
*/
|
|
919
929
|
|
|
920
930
|
/**
|
|
@@ -923,6 +933,7 @@ declare class SaasExtensionsGuard {
|
|
|
923
933
|
*
|
|
924
934
|
* @since 2.0.0
|
|
925
935
|
* @updated 2.4.0 - Added apiName property
|
|
936
|
+
* @deprecated To be deleted in v5.0. Use proxy services (TenantService, EditionService) instead.
|
|
926
937
|
*/
|
|
927
938
|
declare class SaasService {
|
|
928
939
|
private restService;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@abpjs/saas",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "ABP Framework SaaS components for React - translated from @volo/abp.ng.saas",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@chakra-ui/react": "^3.2.0",
|
|
29
29
|
"@emotion/react": "^11.11.0",
|
|
30
|
-
"@abpjs/core": "
|
|
31
|
-
"@abpjs/
|
|
32
|
-
"@abpjs/
|
|
30
|
+
"@abpjs/core": "4.0.0",
|
|
31
|
+
"@abpjs/feature-management": "4.0.0",
|
|
32
|
+
"@abpjs/theme-shared": "4.0.0"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@volo/abp.ng.saas": "3.1.0",
|