@vc-shell/framework 2.0.3-pr227.0c4f2c3 → 2.0.4-pr228.833ff5f
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/CHANGELOG.md +10 -0
- package/dist/ai-agent/index.js +2 -2
- package/dist/chunks/{VcAiAgentPanel.vue_vue_type_style_index_0_lang-CTHTF63Q.js → VcAiAgentPanel.vue_vue_type_style_index_0_lang-D5HgEXFw.js} +1578 -952
- package/dist/chunks/VcAiAgentPanel.vue_vue_type_style_index_0_lang-D5HgEXFw.js.map +1 -0
- package/dist/chunks/{VcTableAdapter.vue_vue_type_style_index_0_lang-dJW2U276.js → VcTableAdapter.vue_vue_type_style_index_0_lang-HqgHfIV-.js} +1 -1
- package/dist/chunks/{VcTableAdapter.vue_vue_type_style_index_0_lang-dJW2U276.js.map → VcTableAdapter.vue_vue_type_style_index_0_lang-HqgHfIV-.js.map} +1 -1
- package/dist/chunks/{index-CYv6y-92.js → index-CacTeJdd.js} +1 -1
- package/dist/chunks/{index-CYv6y-92.js.map → index-CacTeJdd.js.map} +1 -1
- package/dist/core/api/platform.d.ts +334 -104
- package/dist/core/api/platform.d.ts.map +1 -1
- package/dist/framework.js +315 -320
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/ui/index.js +2 -2
- package/package.json +4 -4
- package/dist/chunks/VcAiAgentPanel.vue_vue_type_style_index_0_lang-CTHTF63Q.js.map +0 -1
|
@@ -52,6 +52,43 @@ export declare class ExternalSignInClient extends AuthApiBase {
|
|
|
52
52
|
getExternalLoginProviders(): Promise<ExternalSignInProviderInfo[]>;
|
|
53
53
|
protected processGetExternalLoginProviders(response: Response): Promise<ExternalSignInProviderInfo[]>;
|
|
54
54
|
}
|
|
55
|
+
export declare class AppManifestClient extends AuthApiBase {
|
|
56
|
+
private http;
|
|
57
|
+
private baseUrl;
|
|
58
|
+
constructor(baseUrl?: string, http?: {
|
|
59
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
60
|
+
});
|
|
61
|
+
/**
|
|
62
|
+
* Returns the host app's plugin manifest.
|
|
63
|
+
|
|
64
|
+
In production: cacheable — responds 304 on matching
|
|
65
|
+
`If-None-Match`. The descriptor is built and hashed once at the
|
|
66
|
+
service layer (VirtoCommerce.Platform.Core.Modularity.IAppManifestService) and cached for the
|
|
67
|
+
process lifetime, so 304 cache-hits short-circuit without touching the
|
|
68
|
+
filesystem.
|
|
69
|
+
In Development: `Cache-Control: no-store` is emitted and the 304
|
|
70
|
+
fast path is skipped — every request returns 200 with a freshly built
|
|
71
|
+
body. This makes `yarn build` in a plugin folder visible on the
|
|
72
|
+
next page reload without restarting the platform.
|
|
73
|
+
* @return OK
|
|
74
|
+
*/
|
|
75
|
+
getManifest(appId: string): Promise<AppManifestResponse>;
|
|
76
|
+
protected processGetManifest(response: Response): Promise<AppManifestResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Force-invalidate the manifest cache for every `appId`. The next
|
|
79
|
+
call to `GET /api/apps/{appId}/manifest` will rebuild the
|
|
80
|
+
descriptor from disk, picking up any plugin changes since the last
|
|
81
|
+
build (new module installs, drop-in plugin replacements, plugin
|
|
82
|
+
rebuilds).
|
|
83
|
+
|
|
84
|
+
In Development this isn't normally needed (the service bypasses its
|
|
85
|
+
cache anyway), but the endpoint works in any environment for
|
|
86
|
+
operators who want to refresh without restarting the platform.
|
|
87
|
+
* @return No Content
|
|
88
|
+
*/
|
|
89
|
+
invalidateManifestCache(): Promise<void>;
|
|
90
|
+
protected processInvalidateManifestCache(response: Response): Promise<void>;
|
|
91
|
+
}
|
|
55
92
|
export declare class AppsClient extends AuthApiBase {
|
|
56
93
|
private http;
|
|
57
94
|
private baseUrl;
|
|
@@ -126,11 +163,11 @@ export declare class ChangeLogClient extends AuthApiBase {
|
|
|
126
163
|
resetPlatformCache(): Promise<void>;
|
|
127
164
|
protected processResetPlatformCache(response: Response): Promise<void>;
|
|
128
165
|
/**
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
166
|
+
* Get last modified date for given scope
|
|
167
|
+
Used for signal of what something changed and for cache invalidation in external platform clients
|
|
168
|
+
* @param scope (optional)
|
|
169
|
+
* @return OK
|
|
170
|
+
*/
|
|
134
171
|
getLastModifiedDate(scope?: string | undefined): Promise<LastModifiedResponse>;
|
|
135
172
|
protected processGetLastModifiedDate(response: Response): Promise<LastModifiedResponse>;
|
|
136
173
|
/**
|
|
@@ -149,8 +186,14 @@ export declare class ChangeLogClient extends AuthApiBase {
|
|
|
149
186
|
* @param body (optional)
|
|
150
187
|
* @return OK
|
|
151
188
|
*/
|
|
152
|
-
searchChanges(body?: ChangeLogSearchCriteria | undefined): Promise<
|
|
153
|
-
protected processSearchChanges(response: Response): Promise<
|
|
189
|
+
searchChanges(body?: ChangeLogSearchCriteria | undefined): Promise<OperationLog[]>;
|
|
190
|
+
protected processSearchChanges(response: Response): Promise<OperationLog[]>;
|
|
191
|
+
/**
|
|
192
|
+
* @param body (optional)
|
|
193
|
+
* @return OK
|
|
194
|
+
*/
|
|
195
|
+
searchChangesV2(body?: ChangeLogSearchCriteria | undefined): Promise<ChangeLogSearchResult>;
|
|
196
|
+
protected processSearchChangesV2(response: Response): Promise<ChangeLogSearchResult>;
|
|
154
197
|
/**
|
|
155
198
|
* @param start (optional)
|
|
156
199
|
* @param end (optional)
|
|
@@ -319,7 +362,7 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
319
362
|
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
320
363
|
});
|
|
321
364
|
/**
|
|
322
|
-
* Reload
|
|
365
|
+
* Reload modules
|
|
323
366
|
* @return No Content
|
|
324
367
|
*/
|
|
325
368
|
reloadModules(): Promise<void>;
|
|
@@ -331,14 +374,14 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
331
374
|
getModules(): Promise<ModuleDescriptor[]>;
|
|
332
375
|
protected processGetModules(response: Response): Promise<ModuleDescriptor[]>;
|
|
333
376
|
/**
|
|
334
|
-
* Get all dependent modules for module
|
|
377
|
+
* Get all dependent modules for a module
|
|
335
378
|
* @param body (optional) modules descriptors
|
|
336
379
|
* @return OK
|
|
337
380
|
*/
|
|
338
381
|
getDependingModules(body?: ModuleDescriptor[] | undefined): Promise<ModuleDescriptor[]>;
|
|
339
382
|
protected processGetDependingModules(response: Response): Promise<ModuleDescriptor[]>;
|
|
340
383
|
/**
|
|
341
|
-
* Returns a flat expanded
|
|
384
|
+
* Returns a flat expanded list of modules that depend on passed modules
|
|
342
385
|
* @param body (optional) modules descriptors
|
|
343
386
|
* @return OK
|
|
344
387
|
*/
|
|
@@ -357,6 +400,13 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
357
400
|
*/
|
|
358
401
|
installModules(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification>;
|
|
359
402
|
protected processInstallModules(response: Response): Promise<ModulePushNotification>;
|
|
403
|
+
/**
|
|
404
|
+
* Install modules using lightweight requests
|
|
405
|
+
* @param body (optional) module install requests (id + optional version)
|
|
406
|
+
* @return OK
|
|
407
|
+
*/
|
|
408
|
+
installModuleRequests(body?: ModuleInstallRequest[] | undefined): Promise<ModulePushNotification>;
|
|
409
|
+
protected processInstallModuleRequests(response: Response): Promise<ModulePushNotification>;
|
|
360
410
|
/**
|
|
361
411
|
* Update modules
|
|
362
412
|
* @param body (optional) modules for update
|
|
@@ -364,6 +414,13 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
364
414
|
*/
|
|
365
415
|
updateModules(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification>;
|
|
366
416
|
protected processUpdateModules(response: Response): Promise<ModulePushNotification>;
|
|
417
|
+
/**
|
|
418
|
+
* Update modules using lightweight requests
|
|
419
|
+
* @param body (optional) module install requests (id + optional version)
|
|
420
|
+
* @return OK
|
|
421
|
+
*/
|
|
422
|
+
updateModuleRequests(body?: ModuleInstallRequest[] | undefined): Promise<ModulePushNotification>;
|
|
423
|
+
protected processUpdateModuleRequests(response: Response): Promise<ModulePushNotification>;
|
|
367
424
|
/**
|
|
368
425
|
* Uninstall module
|
|
369
426
|
* @param body (optional) modules
|
|
@@ -371,6 +428,13 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
371
428
|
*/
|
|
372
429
|
uninstallModule(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification>;
|
|
373
430
|
protected processUninstallModule(response: Response): Promise<ModulePushNotification>;
|
|
431
|
+
/**
|
|
432
|
+
* Uninstall modules using lightweight requests
|
|
433
|
+
* @param body (optional) module install requests (id only, version ignored)
|
|
434
|
+
* @return OK
|
|
435
|
+
*/
|
|
436
|
+
uninstallModuleRequests(body?: ModuleInstallRequest[] | undefined): Promise<ModulePushNotification>;
|
|
437
|
+
protected processUninstallModuleRequests(response: Response): Promise<ModulePushNotification>;
|
|
374
438
|
/**
|
|
375
439
|
* Restart web application
|
|
376
440
|
* @return No Content
|
|
@@ -384,10 +448,42 @@ export declare class ModulesClient extends AuthApiBase {
|
|
|
384
448
|
tryToAutoInstallModules(): Promise<ModuleAutoInstallPushNotification>;
|
|
385
449
|
protected processTryToAutoInstallModules(response: Response): Promise<ModuleAutoInstallPushNotification>;
|
|
386
450
|
/**
|
|
451
|
+
* Get module loading order
|
|
387
452
|
* @return OK
|
|
388
453
|
*/
|
|
389
454
|
getModulesLoadingOrder(): Promise<string[]>;
|
|
390
455
|
protected processGetModulesLoadingOrder(response: Response): Promise<string[]>;
|
|
456
|
+
/**
|
|
457
|
+
* Validate that a specific module version package exists at the download URL.
|
|
458
|
+
* @param moduleId Module identifier
|
|
459
|
+
* @param version Version to validate
|
|
460
|
+
* @return OK
|
|
461
|
+
*/
|
|
462
|
+
validateModuleVersion(moduleId: string, version: string): Promise<boolean>;
|
|
463
|
+
protected processValidateModuleVersion(response: Response): Promise<boolean>;
|
|
464
|
+
/**
|
|
465
|
+
* Install a specific version of a module.
|
|
466
|
+
Validates the package URL, registers the custom version, and schedules installation.
|
|
467
|
+
* @param moduleId Module identifier
|
|
468
|
+
* @param version Version to install
|
|
469
|
+
* @return OK
|
|
470
|
+
*/
|
|
471
|
+
installModuleVersion(moduleId: string, version: string): Promise<ModulePushNotification>;
|
|
472
|
+
protected processInstallModuleVersion(response: Response): Promise<ModulePushNotification>;
|
|
473
|
+
/**
|
|
474
|
+
* Install the latest available version of a module.
|
|
475
|
+
* @param moduleId Module identifier
|
|
476
|
+
* @return OK
|
|
477
|
+
*/
|
|
478
|
+
installModule(moduleId: string): Promise<ModulePushNotification>;
|
|
479
|
+
protected processInstallModule(response: Response): Promise<ModulePushNotification>;
|
|
480
|
+
/**
|
|
481
|
+
* Uninstall a module.
|
|
482
|
+
* @param moduleId Module identifier
|
|
483
|
+
* @return OK
|
|
484
|
+
*/
|
|
485
|
+
uninstallSingleModule(moduleId: string): Promise<ModulePushNotification>;
|
|
486
|
+
protected processUninstallSingleModule(response: Response): Promise<ModulePushNotification>;
|
|
391
487
|
}
|
|
392
488
|
export declare class OAuthAppsClient extends AuthApiBase {
|
|
393
489
|
private http;
|
|
@@ -525,6 +621,27 @@ export declare class SecurityClient extends AuthApiBase {
|
|
|
525
621
|
*/
|
|
526
622
|
searchUsers(body?: UserSearchCriteria | undefined): Promise<UserSearchResult>;
|
|
527
623
|
protected processSearchUsers(response: Response): Promise<UserSearchResult>;
|
|
624
|
+
/**
|
|
625
|
+
* Get users by IDs
|
|
626
|
+
* @param ids (optional) An array of user IDs.
|
|
627
|
+
* @return OK
|
|
628
|
+
*/
|
|
629
|
+
getUsersByIds(ids?: string[] | undefined): Promise<ApplicationUser[]>;
|
|
630
|
+
protected processGetUsersByIds(response: Response): Promise<ApplicationUser[]>;
|
|
631
|
+
/**
|
|
632
|
+
* Update user details by user ID
|
|
633
|
+
* @param body (optional) User details.
|
|
634
|
+
* @return OK
|
|
635
|
+
*/
|
|
636
|
+
update(body?: ApplicationUser | undefined): Promise<SecurityResult>;
|
|
637
|
+
protected processUpdate(response: Response): Promise<SecurityResult>;
|
|
638
|
+
/**
|
|
639
|
+
* Delete users by name
|
|
640
|
+
* @param names (optional) An array of user names.
|
|
641
|
+
* @return OK
|
|
642
|
+
*/
|
|
643
|
+
delete(names?: string[] | undefined): Promise<void>;
|
|
644
|
+
protected processDelete(response: Response): Promise<void>;
|
|
528
645
|
/**
|
|
529
646
|
* Get user details by user name
|
|
530
647
|
* @return OK
|
|
@@ -610,20 +727,6 @@ export declare class SecurityClient extends AuthApiBase {
|
|
|
610
727
|
*/
|
|
611
728
|
validateUserPassword(body?: ChangePasswordRequest | undefined): Promise<IdentityResult>;
|
|
612
729
|
protected processValidateUserPassword(response: Response): Promise<IdentityResult>;
|
|
613
|
-
/**
|
|
614
|
-
* Update user details by user ID
|
|
615
|
-
* @param body (optional) User details.
|
|
616
|
-
* @return OK
|
|
617
|
-
*/
|
|
618
|
-
update(body?: ApplicationUser | undefined): Promise<SecurityResult>;
|
|
619
|
-
protected processUpdate(response: Response): Promise<SecurityResult>;
|
|
620
|
-
/**
|
|
621
|
-
* Delete users by name
|
|
622
|
-
* @param names (optional) An array of user names.
|
|
623
|
-
* @return OK
|
|
624
|
-
*/
|
|
625
|
-
delete(names?: string[] | undefined): Promise<void>;
|
|
626
|
-
protected processDelete(response: Response): Promise<void>;
|
|
627
730
|
/**
|
|
628
731
|
* Checks if user locked
|
|
629
732
|
* @param id User id
|
|
@@ -762,15 +865,142 @@ export declare class SettingClient extends AuthApiBase {
|
|
|
762
865
|
getUICustomizationSetting(): Promise<ObjectSettingEntry>;
|
|
763
866
|
protected processGetUICustomizationSetting(response: Response): Promise<ObjectSettingEntry>;
|
|
764
867
|
}
|
|
868
|
+
export declare class SettingsV2Client extends AuthApiBase {
|
|
869
|
+
private http;
|
|
870
|
+
private baseUrl;
|
|
871
|
+
constructor(baseUrl?: string, http?: {
|
|
872
|
+
fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
|
|
873
|
+
});
|
|
874
|
+
/**
|
|
875
|
+
* Get global settings schema (metadata only, no values)
|
|
876
|
+
* @param moduleId (optional)
|
|
877
|
+
* @param keyword (optional)
|
|
878
|
+
* @return OK
|
|
879
|
+
*/
|
|
880
|
+
getGlobalSchema(moduleId?: string | undefined, keyword?: string | undefined): Promise<SettingPropertySchema[]>;
|
|
881
|
+
protected processGetGlobalSchema(response: Response): Promise<SettingPropertySchema[]>;
|
|
882
|
+
/**
|
|
883
|
+
* Get global settings values as a flat { name: value } dictionary.
|
|
884
|
+
Optional moduleId narrows the response to a single
|
|
885
|
+
module's settings — same filter as M:VirtoCommerce.Platform.Web.Controllers.Api.SettingsV2Controller.GetGlobalSchema(System.String,System.String), so
|
|
886
|
+
a frontend can read+use one module's values in one round-trip
|
|
887
|
+
without a follow-up /schema lookup.
|
|
888
|
+
* @param modifiedOnly (optional)
|
|
889
|
+
* @param moduleId (optional)
|
|
890
|
+
* @return OK
|
|
891
|
+
*/
|
|
892
|
+
getGlobalValues(modifiedOnly?: boolean | undefined, moduleId?: string | undefined): Promise<void>;
|
|
893
|
+
protected processGetGlobalValues(response: Response): Promise<void>;
|
|
894
|
+
/**
|
|
895
|
+
* @param replaceAll (optional)
|
|
896
|
+
* @param body (optional)
|
|
897
|
+
* @return No Content
|
|
898
|
+
*/
|
|
899
|
+
saveGlobalValues(replaceAll?: boolean | undefined, body?: {
|
|
900
|
+
[key: string]: any;
|
|
901
|
+
} | undefined): Promise<void>;
|
|
902
|
+
protected processSaveGlobalValues(response: Response): Promise<void>;
|
|
903
|
+
/**
|
|
904
|
+
* Get tenant settings schema (metadata only, no values).
|
|
905
|
+
Schema depends only on tenantType registration, not on a specific tenant instance.
|
|
906
|
+
* @param moduleId (optional)
|
|
907
|
+
* @param keyword (optional)
|
|
908
|
+
* @return OK
|
|
909
|
+
*/
|
|
910
|
+
getTenantSchema(tenantType: string, moduleId?: string | undefined, keyword?: string | undefined): Promise<SettingPropertySchema[]>;
|
|
911
|
+
protected processGetTenantSchema(response: Response): Promise<SettingPropertySchema[]>;
|
|
912
|
+
/**
|
|
913
|
+
* Get tenant settings values as a flat { name: value } dictionary.
|
|
914
|
+
Optional moduleId narrows the response to a single
|
|
915
|
+
module's settings.
|
|
916
|
+
* @param modifiedOnly (optional)
|
|
917
|
+
* @param moduleId (optional)
|
|
918
|
+
* @return OK
|
|
919
|
+
*/
|
|
920
|
+
getTenantValues(tenantType: string, tenantId: string, modifiedOnly?: boolean | undefined, moduleId?: string | undefined): Promise<void>;
|
|
921
|
+
protected processGetTenantValues(response: Response): Promise<void>;
|
|
922
|
+
/**
|
|
923
|
+
* @param replaceAll (optional)
|
|
924
|
+
* @param body (optional)
|
|
925
|
+
* @return No Content
|
|
926
|
+
*/
|
|
927
|
+
saveTenantValues(tenantType: string, tenantId: string, replaceAll?: boolean | undefined, body?: {
|
|
928
|
+
[key: string]: any;
|
|
929
|
+
} | undefined): Promise<void>;
|
|
930
|
+
protected processSaveTenantValues(response: Response): Promise<void>;
|
|
931
|
+
/**
|
|
932
|
+
* Get the current user's UserProfile settings schema (metadata only).
|
|
933
|
+
Schema is the same for every user — it's defined by the
|
|
934
|
+
platform's UserProfile-tenant registration. Optionally filter
|
|
935
|
+
by moduleId so a frontend only fetches its own module's
|
|
936
|
+
per-user settings.
|
|
937
|
+
* @param moduleId (optional)
|
|
938
|
+
* @param keyword (optional)
|
|
939
|
+
* @return OK
|
|
940
|
+
*/
|
|
941
|
+
getMeSchema(moduleId?: string | undefined, keyword?: string | undefined): Promise<SettingPropertySchema[]>;
|
|
942
|
+
protected processGetMeSchema(response: Response): Promise<SettingPropertySchema[]>;
|
|
943
|
+
/**
|
|
944
|
+
* Get the current user's effective UserProfile settings values
|
|
945
|
+
as a flat { name: value } dictionary. Optional moduleId
|
|
946
|
+
narrows the response to a single module's per-user settings — same
|
|
947
|
+
filter M:VirtoCommerce.Platform.Web.Controllers.Api.SettingsV2Controller.GetMeSchema(System.String,System.String) accepts, so a frontend can do a
|
|
948
|
+
single round-trip read without a follow-up /me/schema lookup.
|
|
949
|
+
* @param modifiedOnly (optional)
|
|
950
|
+
* @param moduleId (optional)
|
|
951
|
+
* @return OK
|
|
952
|
+
*/
|
|
953
|
+
getMeValues(modifiedOnly?: boolean | undefined, moduleId?: string | undefined): Promise<void>;
|
|
954
|
+
protected processGetMeValues(response: Response): Promise<void>;
|
|
955
|
+
/**
|
|
956
|
+
* @param replaceAll (optional)
|
|
957
|
+
* @param body (optional)
|
|
958
|
+
* @return No Content
|
|
959
|
+
*/
|
|
960
|
+
saveMeValues(replaceAll?: boolean | undefined, body?: {
|
|
961
|
+
[key: string]: any;
|
|
962
|
+
} | undefined): Promise<void>;
|
|
963
|
+
protected processSaveMeValues(response: Response): Promise<void>;
|
|
964
|
+
}
|
|
765
965
|
export interface AppDescriptor {
|
|
766
966
|
title?: string | undefined;
|
|
767
967
|
description?: string | undefined;
|
|
768
968
|
iconUrl?: string | undefined;
|
|
769
969
|
relativeUrl?: string | undefined;
|
|
770
970
|
permission?: string | undefined;
|
|
971
|
+
/** Where the app surfaces in the admin navigation
|
|
972
|
+
(`AppMenu` / `MainMenu` / `Hidden`). */
|
|
973
|
+
placement?: AppPlacement;
|
|
974
|
+
/** Deprecated. Use VirtoCommerce.Platform.Web.Model.Modularity.AppDescriptor.Placement instead. Equivalent to
|
|
975
|
+
`Placement == AppPlacement.MainMenu`; kept on the JSON
|
|
976
|
+
contract for backwards compatibility. */
|
|
771
977
|
supportEmbeddedMode?: boolean;
|
|
772
978
|
id?: string | undefined;
|
|
773
979
|
}
|
|
980
|
+
/** Response shape for `GET /api/apps/{appId}/manifest`. Returns the host app metadata plus a topologically ordered, permission-filtered list of plugins the host should load. */
|
|
981
|
+
export interface AppManifestResponse {
|
|
982
|
+
/** Echo of the requested app id (e.g. `vc-shell-marketplace`, `system-operations`, `platform`). */
|
|
983
|
+
appId?: string | undefined;
|
|
984
|
+
/** Version of the host app — taken from the running platform when
|
|
985
|
+
VirtoCommerce.Platform.Web.Model.Modularity.AppManifestResponse.AppId is the reserved `platform` id, otherwise
|
|
986
|
+
from the module that declares the `<app>` in its
|
|
987
|
+
`module.manifest`. Useful for clients that want to surface the
|
|
988
|
+
host's version (e.g. footer banner, support diagnostics) without
|
|
989
|
+
a second round-trip. */
|
|
990
|
+
version?: string | undefined;
|
|
991
|
+
/** Display title of the host app, taken from the owning module's
|
|
992
|
+
`<app>` declaration in `module.manifest`. */
|
|
993
|
+
title?: string | undefined;
|
|
994
|
+
/** Plugins to load, in topological dependency order of their owning modules.
|
|
995
|
+
Already filtered by current user permissions and (for Module Federation
|
|
996
|
+
hosts) by host-app discovery folder convention. */
|
|
997
|
+
plugins?: PluginEntry[] | undefined;
|
|
998
|
+
}
|
|
999
|
+
export declare enum AppPlacement {
|
|
1000
|
+
AppMenu = "AppMenu",
|
|
1001
|
+
MainMenu = "MainMenu",
|
|
1002
|
+
Hidden = "Hidden"
|
|
1003
|
+
}
|
|
774
1004
|
export interface ApplicationUser {
|
|
775
1005
|
storeId?: string | undefined;
|
|
776
1006
|
memberId?: string | undefined;
|
|
@@ -870,6 +1100,21 @@ export interface ClaimsIdentity {
|
|
|
870
1100
|
export interface ConfirmEmailRequest {
|
|
871
1101
|
token?: string | undefined;
|
|
872
1102
|
}
|
|
1103
|
+
/** One asset belonging to a plugin (script, stylesheet, etc.). Carries the information a client-side loader needs to build the right HTML element with proper cache busting. */
|
|
1104
|
+
export interface ContentFile {
|
|
1105
|
+
/** Asset kind. See VirtoCommerce.Platform.Core.Modularity.ContentFileTypes
|
|
1106
|
+
for the canonical values. Lower-case string so the JSON contract is
|
|
1107
|
+
stable against future C# enum renames. */
|
|
1108
|
+
type?: string | undefined;
|
|
1109
|
+
/** Absolute URL path served by the platform's static-file middleware,
|
|
1110
|
+
e.g. `/modules/$(VirtoCommerce.Catalog)/dist/app.js`. */
|
|
1111
|
+
path?: string | undefined;
|
|
1112
|
+
/** Cache-busting hash (`?v={hash}`). Stable across requests as long
|
|
1113
|
+
as the file's last-write time is unchanged. `null` when the file
|
|
1114
|
+
doesn't exist on disk (e.g. a manifest reference that fell back to
|
|
1115
|
+
convention defaults). */
|
|
1116
|
+
hash?: string | undefined;
|
|
1117
|
+
}
|
|
873
1118
|
export interface CryptoProviderCache {
|
|
874
1119
|
}
|
|
875
1120
|
export interface CryptoProviderFactory {
|
|
@@ -900,7 +1145,7 @@ export interface DynamicObjectProperty {
|
|
|
900
1145
|
isMultilingual?: boolean;
|
|
901
1146
|
isRequired?: boolean;
|
|
902
1147
|
displayOrder?: number | undefined;
|
|
903
|
-
valueType?:
|
|
1148
|
+
valueType?: DynamicPropertyValueType;
|
|
904
1149
|
displayNames?: DynamicPropertyName[] | undefined;
|
|
905
1150
|
createdDate?: Date;
|
|
906
1151
|
modifiedDate?: Date | undefined;
|
|
@@ -917,7 +1162,7 @@ export interface DynamicProperty {
|
|
|
917
1162
|
isMultilingual?: boolean;
|
|
918
1163
|
isRequired?: boolean;
|
|
919
1164
|
displayOrder?: number | undefined;
|
|
920
|
-
valueType?:
|
|
1165
|
+
valueType?: DynamicPropertyValueType;
|
|
921
1166
|
displayNames?: DynamicPropertyName[] | undefined;
|
|
922
1167
|
createdDate?: Date;
|
|
923
1168
|
modifiedDate?: Date | undefined;
|
|
@@ -967,7 +1212,7 @@ export interface DynamicPropertyObjectValue {
|
|
|
967
1212
|
locale?: string | undefined;
|
|
968
1213
|
value?: any | undefined;
|
|
969
1214
|
valueId?: string | undefined;
|
|
970
|
-
valueType?:
|
|
1215
|
+
valueType?: DynamicPropertyValueType;
|
|
971
1216
|
propertyId?: string | undefined;
|
|
972
1217
|
propertyName?: string | undefined;
|
|
973
1218
|
}
|
|
@@ -1028,7 +1273,7 @@ export interface Job {
|
|
|
1028
1273
|
id?: string | undefined;
|
|
1029
1274
|
}
|
|
1030
1275
|
export interface JsonElement {
|
|
1031
|
-
readonly valueKind?:
|
|
1276
|
+
readonly valueKind?: JsonValueKind;
|
|
1032
1277
|
}
|
|
1033
1278
|
export declare enum JsonValueKind {
|
|
1034
1279
|
Undefined = "Undefined",
|
|
@@ -1077,6 +1322,7 @@ export interface JsonWebKeySet {
|
|
|
1077
1322
|
} | undefined;
|
|
1078
1323
|
readonly keys?: JsonWebKey[] | undefined;
|
|
1079
1324
|
skipUnresolvedJsonWebKeys?: boolean;
|
|
1325
|
+
jsonData?: string | undefined;
|
|
1080
1326
|
}
|
|
1081
1327
|
export interface KeyValue {
|
|
1082
1328
|
key?: string | undefined;
|
|
@@ -1121,6 +1367,7 @@ export interface ModuleAutoInstallPushNotification {
|
|
|
1121
1367
|
started?: Date | undefined;
|
|
1122
1368
|
finished?: Date | undefined;
|
|
1123
1369
|
progressLog?: ProgressMessage[] | undefined;
|
|
1370
|
+
totalCount?: number;
|
|
1124
1371
|
readonly errorCount?: number;
|
|
1125
1372
|
serverId?: string | undefined;
|
|
1126
1373
|
creator?: string | undefined;
|
|
@@ -1152,6 +1399,7 @@ export interface ModuleDescriptor {
|
|
|
1152
1399
|
isRemovable?: boolean;
|
|
1153
1400
|
isInstalled?: boolean;
|
|
1154
1401
|
installedVersion?: ModuleIdentity | undefined;
|
|
1402
|
+
packageUrl?: string | undefined;
|
|
1155
1403
|
id?: string | undefined;
|
|
1156
1404
|
}
|
|
1157
1405
|
export interface ModuleIdentity {
|
|
@@ -1159,10 +1407,15 @@ export interface ModuleIdentity {
|
|
|
1159
1407
|
version?: SemanticVersion | undefined;
|
|
1160
1408
|
optional?: boolean;
|
|
1161
1409
|
}
|
|
1410
|
+
export interface ModuleInstallRequest {
|
|
1411
|
+
id?: string | undefined;
|
|
1412
|
+
version?: string | undefined;
|
|
1413
|
+
}
|
|
1162
1414
|
export interface ModulePushNotification {
|
|
1163
1415
|
started?: Date | undefined;
|
|
1164
1416
|
finished?: Date | undefined;
|
|
1165
1417
|
progressLog?: ProgressMessage[] | undefined;
|
|
1418
|
+
totalCount?: number;
|
|
1166
1419
|
readonly errorCount?: number;
|
|
1167
1420
|
serverId?: string | undefined;
|
|
1168
1421
|
creator?: string | undefined;
|
|
@@ -1206,11 +1459,12 @@ export interface ObjectSettingEntry {
|
|
|
1206
1459
|
isRequired?: boolean;
|
|
1207
1460
|
isHidden?: boolean;
|
|
1208
1461
|
isPublic?: boolean;
|
|
1209
|
-
valueType?:
|
|
1462
|
+
valueType?: SettingValueType;
|
|
1210
1463
|
allowedValues?: any[] | undefined;
|
|
1211
1464
|
defaultValue?: any | undefined;
|
|
1212
1465
|
isDictionary?: boolean;
|
|
1213
1466
|
isLocalizable?: boolean;
|
|
1467
|
+
tenant?: string | undefined;
|
|
1214
1468
|
}
|
|
1215
1469
|
export interface OpenIddictApplicationDescriptor {
|
|
1216
1470
|
applicationType?: string | undefined;
|
|
@@ -1233,7 +1487,6 @@ export interface OpenIddictApplicationDescriptor {
|
|
|
1233
1487
|
readonly settings?: {
|
|
1234
1488
|
[key: string]: string;
|
|
1235
1489
|
} | undefined;
|
|
1236
|
-
type?: string | undefined;
|
|
1237
1490
|
}
|
|
1238
1491
|
export interface OpenIddictResponse {
|
|
1239
1492
|
accessToken?: string | undefined;
|
|
@@ -1245,7 +1498,9 @@ export interface OpenIddictResponse {
|
|
|
1245
1498
|
expiresIn?: number | undefined;
|
|
1246
1499
|
idToken?: string | undefined;
|
|
1247
1500
|
iss?: string | undefined;
|
|
1501
|
+
issuedTokenType?: string | undefined;
|
|
1248
1502
|
refreshToken?: string | undefined;
|
|
1503
|
+
requestUri?: string | undefined;
|
|
1249
1504
|
scope?: string | undefined;
|
|
1250
1505
|
state?: string | undefined;
|
|
1251
1506
|
tokenType?: string | undefined;
|
|
@@ -1257,7 +1512,7 @@ export interface OpenIddictResponse {
|
|
|
1257
1512
|
export interface OperationLog {
|
|
1258
1513
|
objectType?: string | undefined;
|
|
1259
1514
|
objectId?: string | undefined;
|
|
1260
|
-
operationType?:
|
|
1515
|
+
operationType?: EntryState;
|
|
1261
1516
|
detail?: string | undefined;
|
|
1262
1517
|
createdDate?: Date;
|
|
1263
1518
|
modifiedDate?: Date | undefined;
|
|
@@ -1277,9 +1532,32 @@ export interface PermissionScope {
|
|
|
1277
1532
|
label?: string | undefined;
|
|
1278
1533
|
scope?: string | undefined;
|
|
1279
1534
|
}
|
|
1535
|
+
/** One plugin contribution to a host app, returned by `GET /api/apps/{appId}/manifest`. */
|
|
1536
|
+
export interface PluginEntry {
|
|
1537
|
+
/** Unique plugin id within the (host app, request) tuple.
|
|
1538
|
+
Defaults to the owning .NET module id (e.g. `VirtoCommerce.MarketplaceReviews`). */
|
|
1539
|
+
id?: string | undefined;
|
|
1540
|
+
/** Plugin version. Defaults to the parent module version. */
|
|
1541
|
+
version?: string | undefined;
|
|
1542
|
+
/** The plugin's primary file. For Module Federation plugins this is the
|
|
1543
|
+
federation entry (`remoteEntry.js`). For the legacy AngularJS host
|
|
1544
|
+
it is the module bundle (`dist/app.js`). Always a script. */
|
|
1545
|
+
entry?: ContentFile | undefined;
|
|
1546
|
+
/** Additional assets the host should preload alongside VirtoCommerce.Platform.Web.Model.Modularity.PluginEntry.Entry
|
|
1547
|
+
(typically stylesheets). Each carries its own type so a generic loader
|
|
1548
|
+
can dispatch on it. */
|
|
1549
|
+
contentFiles?: ContentFile[] | undefined;
|
|
1550
|
+
/** Module Federation coordinates. `null` for the legacy AngularJS host. */
|
|
1551
|
+
remote?: PluginRemote | undefined;
|
|
1552
|
+
}
|
|
1553
|
+
/** Module Federation remote coordinates for a plugin. Mirrors the shape expected by `@module-federation/runtime`. */
|
|
1554
|
+
export interface PluginRemote {
|
|
1555
|
+
name?: string | undefined;
|
|
1556
|
+
exposed?: string | undefined;
|
|
1557
|
+
}
|
|
1280
1558
|
export interface ProgressMessage {
|
|
1281
1559
|
message?: string | undefined;
|
|
1282
|
-
level?:
|
|
1560
|
+
level?: ProgressMessageLevel;
|
|
1283
1561
|
}
|
|
1284
1562
|
export declare enum ProgressMessageLevel {
|
|
1285
1563
|
Info = "Info",
|
|
@@ -1364,6 +1642,21 @@ export interface SemanticVersion {
|
|
|
1364
1642
|
readonly patch?: number;
|
|
1365
1643
|
readonly prerelease?: string | undefined;
|
|
1366
1644
|
}
|
|
1645
|
+
export interface SettingPropertySchema {
|
|
1646
|
+
name?: string | undefined;
|
|
1647
|
+
displayName?: string | undefined;
|
|
1648
|
+
groupName?: string | undefined;
|
|
1649
|
+
moduleId?: string | undefined;
|
|
1650
|
+
valueType?: SettingValueType;
|
|
1651
|
+
defaultValue?: any | undefined;
|
|
1652
|
+
allowedValues?: any[] | undefined;
|
|
1653
|
+
isRequired?: boolean;
|
|
1654
|
+
isReadOnly?: boolean;
|
|
1655
|
+
isDictionary?: boolean;
|
|
1656
|
+
isLocalizable?: boolean;
|
|
1657
|
+
restartRequired?: boolean;
|
|
1658
|
+
assignedToTenants?: string[] | undefined;
|
|
1659
|
+
}
|
|
1367
1660
|
export declare enum SettingValueType {
|
|
1368
1661
|
ShortText = "ShortText",
|
|
1369
1662
|
LongText = "LongText",
|
|
@@ -1387,7 +1680,7 @@ export declare enum SortDirection {
|
|
|
1387
1680
|
}
|
|
1388
1681
|
export interface SortInfo {
|
|
1389
1682
|
sortColumn?: string | undefined;
|
|
1390
|
-
sortDirection?:
|
|
1683
|
+
sortDirection?: SortDirection;
|
|
1391
1684
|
}
|
|
1392
1685
|
export interface StringIdentityUserRole {
|
|
1393
1686
|
userId?: string | undefined;
|
|
@@ -1402,6 +1695,7 @@ export interface SystemInfo {
|
|
|
1402
1695
|
is64BitProcess?: boolean;
|
|
1403
1696
|
databaseProvider?: string | undefined;
|
|
1404
1697
|
environmentName?: string | undefined;
|
|
1698
|
+
runtimeIdentifier?: string | undefined;
|
|
1405
1699
|
}
|
|
1406
1700
|
export interface UserApiKey {
|
|
1407
1701
|
apiKey?: string | undefined;
|
|
@@ -1435,6 +1729,13 @@ export interface UserSearchCriteria {
|
|
|
1435
1729
|
roles?: string[] | undefined;
|
|
1436
1730
|
lasLoginDate?: Date | undefined;
|
|
1437
1731
|
onlyUnlocked?: boolean;
|
|
1732
|
+
onlyLocked?: boolean;
|
|
1733
|
+
emailConfirmed?: boolean | undefined;
|
|
1734
|
+
userType?: string | undefined;
|
|
1735
|
+
status?: string | undefined;
|
|
1736
|
+
storeId?: string | undefined;
|
|
1737
|
+
loginStartDate?: Date | undefined;
|
|
1738
|
+
loginEndDate?: Date | undefined;
|
|
1438
1739
|
responseGroup?: string | undefined;
|
|
1439
1740
|
objectType?: string | undefined;
|
|
1440
1741
|
objectTypes?: string[] | undefined;
|
|
@@ -1495,77 +1796,6 @@ export interface Body {
|
|
|
1495
1796
|
user_id?: string;
|
|
1496
1797
|
[key: string]: any;
|
|
1497
1798
|
}
|
|
1498
|
-
export declare enum DynamicObjectPropertyValueType {
|
|
1499
|
-
Undefined = "Undefined",
|
|
1500
|
-
ShortText = "ShortText",
|
|
1501
|
-
LongText = "LongText",
|
|
1502
|
-
Integer = "Integer",
|
|
1503
|
-
Decimal = "Decimal",
|
|
1504
|
-
DateTime = "DateTime",
|
|
1505
|
-
Boolean = "Boolean",
|
|
1506
|
-
Html = "Html",
|
|
1507
|
-
Image = "Image"
|
|
1508
|
-
}
|
|
1509
|
-
export declare enum DynamicPropertyValueType2 {
|
|
1510
|
-
Undefined = "Undefined",
|
|
1511
|
-
ShortText = "ShortText",
|
|
1512
|
-
LongText = "LongText",
|
|
1513
|
-
Integer = "Integer",
|
|
1514
|
-
Decimal = "Decimal",
|
|
1515
|
-
DateTime = "DateTime",
|
|
1516
|
-
Boolean = "Boolean",
|
|
1517
|
-
Html = "Html",
|
|
1518
|
-
Image = "Image"
|
|
1519
|
-
}
|
|
1520
|
-
export declare enum DynamicPropertyObjectValueValueType {
|
|
1521
|
-
Undefined = "Undefined",
|
|
1522
|
-
ShortText = "ShortText",
|
|
1523
|
-
LongText = "LongText",
|
|
1524
|
-
Integer = "Integer",
|
|
1525
|
-
Decimal = "Decimal",
|
|
1526
|
-
DateTime = "DateTime",
|
|
1527
|
-
Boolean = "Boolean",
|
|
1528
|
-
Html = "Html",
|
|
1529
|
-
Image = "Image"
|
|
1530
|
-
}
|
|
1531
|
-
export declare enum JsonElementValueKind {
|
|
1532
|
-
Undefined = "Undefined",
|
|
1533
|
-
Object = "Object",
|
|
1534
|
-
Array = "Array",
|
|
1535
|
-
String = "String",
|
|
1536
|
-
Number = "Number",
|
|
1537
|
-
True = "True",
|
|
1538
|
-
False = "False",
|
|
1539
|
-
Null = "Null"
|
|
1540
|
-
}
|
|
1541
|
-
export declare enum ObjectSettingEntryValueType {
|
|
1542
|
-
ShortText = "ShortText",
|
|
1543
|
-
LongText = "LongText",
|
|
1544
|
-
Integer = "Integer",
|
|
1545
|
-
Decimal = "Decimal",
|
|
1546
|
-
DateTime = "DateTime",
|
|
1547
|
-
Boolean = "Boolean",
|
|
1548
|
-
SecureString = "SecureString",
|
|
1549
|
-
Json = "Json",
|
|
1550
|
-
PositiveInteger = "PositiveInteger"
|
|
1551
|
-
}
|
|
1552
|
-
export declare enum OperationLogOperationType {
|
|
1553
|
-
Detached = "Detached",
|
|
1554
|
-
Unchanged = "Unchanged",
|
|
1555
|
-
Added = "Added",
|
|
1556
|
-
Deleted = "Deleted",
|
|
1557
|
-
Modified = "Modified"
|
|
1558
|
-
}
|
|
1559
|
-
export declare enum ProgressMessageLevel2 {
|
|
1560
|
-
Info = "Info",
|
|
1561
|
-
Warning = "Warning",
|
|
1562
|
-
Debug = "Debug",
|
|
1563
|
-
Error = "Error"
|
|
1564
|
-
}
|
|
1565
|
-
export declare enum SortInfoSortDirection {
|
|
1566
|
-
Ascending = "Ascending",
|
|
1567
|
-
Descending = "Descending"
|
|
1568
|
-
}
|
|
1569
1799
|
export declare class ApiException extends Error {
|
|
1570
1800
|
message: string;
|
|
1571
1801
|
status: number;
|