@vc-shell/framework 1.0.87 → 1.0.89

package/core/api/platform.ts

@@ -1,6 +1,6 @@
 //----------------------
 // <auto-generated>
-//     Generated using the NSwag toolchain v13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v12.0.0.0)) (http://NSwag.org)
+//     Generated using the NSwag toolchain v13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org)
 // </auto-generated>
 //----------------------
 
@@ -288,6 +288,7 @@ export class AppsClient extends AuthApiBase {
     }
 
     /**
+     * Gets the list of available apps, filtered by user permissions.
      * @return Success
      */
     getApps(): Promise<AppDescriptor[]> {
@@ -346,6 +347,7 @@ export class ChangeLogClient extends AuthApiBase {
     }
 
     /**
+     * Force set changes last modified date
      * @param scope (optional) 
      * @return Success
      */
@@ -437,6 +439,8 @@ export class ChangeLogClient extends AuthApiBase {
     }
 
     /**
+     * Get last modified date for given scope
+    Used for signal of what something changed and for cache invalidation in external platform clients
      * @param scope (optional) 
      * @return Success
      */
@@ -751,6 +755,7 @@ export class DiagnosticsClient extends AuthApiBase {
     }
 
     /**
+     * Get installed modules with errors
      * @return Success
      */
     getModulesErrors(): Promise<ModuleDescriptor[]> {
@@ -809,6 +814,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Get object types which support dynamic properties
      * @return Success
      */
     getObjectTypes(): Promise<string[]> {
@@ -863,6 +869,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Get dynamic properties registered for object type
      * @param body (optional) 
      * @return Success
      */
@@ -915,6 +922,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Add new dynamic property
      * @param body (optional) 
      * @return Success
      */
@@ -967,6 +975,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Update existing dynamic property
      * @param body (optional) 
      * @return Success
      */
@@ -1015,6 +1024,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Delete dynamic property
      * @param propertyIds (optional) 
      * @return Success
      */
@@ -1063,6 +1073,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Does nothing. Just a way to expose DynamicObjectProperty thru Swagger.
      * @return Success
      */
     exposeDynamicObjectProperty(): Promise<DynamicObjectProperty> {
@@ -1114,6 +1125,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Get dictionary items
      * @param body (optional) 
      * @return Success
      */
@@ -1166,6 +1178,7 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
+     * Add or update dictionary items
      * @param body (optional) 
      * @return Success
      */
@@ -1214,7 +1227,8 @@ export class DynamicPropertiesClient extends AuthApiBase {
     }
 
     /**
-     * @param ids (optional) 
+     * Delete dictionary items
+     * @param ids (optional) IDs of dictionary items to delete.
      * @return Success
      */
     deleteDictionaryItem(ids?: string[] | undefined): Promise<void> {
@@ -1274,6 +1288,8 @@ export class JobsClient extends AuthApiBase {
     }
 
     /**
+     * Get background job status
+     * @param id Job ID.
      * @return Success
      */
     getStatus(id: string): Promise<Job> {
@@ -1336,6 +1352,7 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
+     * Reload  modules
      * @return Success
      */
     reloadModules(): Promise<void> {
@@ -1379,6 +1396,7 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
+     * Get installed modules
      * @return Success
      */
     getModules(): Promise<ModuleDescriptor[]> {
@@ -1433,7 +1451,8 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Get all dependent modules for module
+     * @param body (optional) modules descriptors
      * @return Success
      */
     getDependingModules(body?: ModuleDescriptor[] | undefined): Promise<ModuleDescriptor[]> {
@@ -1492,7 +1511,8 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Returns a flat expanded  list of modules that depend on passed modules
+     * @param body (optional) modules descriptors
      * @return Success
      */
     getMissingDependencies(body?: ModuleDescriptor[] | undefined): Promise<ModuleDescriptor[]> {
@@ -1551,6 +1571,7 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
+     * Upload module package for installation or update
      * @return Success
      */
     uploadModuleArchive(): Promise<ModuleDescriptor> {
@@ -1598,7 +1619,8 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Install modules
+     * @param body (optional) modules for install
      * @return Success
      */
     installModules(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification> {
@@ -1650,7 +1672,8 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Uninstall module
+     * @param body (optional) modules
      * @return Success
      */
     uninstallModule(body?: ModuleDescriptor[] | undefined): Promise<ModulePushNotification> {
@@ -1702,6 +1725,7 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
+     * Restart web application
      * @return Success
      */
     restart(): Promise<void> {
@@ -1745,6 +1769,7 @@ export class ModulesClient extends AuthApiBase {
     }
 
     /**
+     * Auto-install modules with specified groups
      * @return Success
      */
     tryToAutoInstallModules(): Promise<ModuleAutoInstallPushNotification> {
@@ -2015,7 +2040,8 @@ export class PushNotificationClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * SearchAsync push notifications
+     * @param body (optional) SearchAsync parameters.
      * @return Success
      */
     searchPushNotification(body?: PushNotificationSearchCriteria | undefined): Promise<PushNotificationSearchResult> {
@@ -2067,6 +2093,7 @@ export class PushNotificationClient extends AuthApiBase {
     }
 
     /**
+     * Mark all notifications as read
      * @return Success
      */
     markAllAsRead(): Promise<PushNotificationSearchResult> {
@@ -2126,7 +2153,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Sign in with user name and password
+     * @param body (optional) Login request.
      * @return Success
      */
     login(body?: LoginRequest | undefined): Promise<SignInResult> {
@@ -2170,6 +2198,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Sign out
      * @return Success
      */
     logout(): Promise<void> {
@@ -2213,6 +2242,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get current user details
      * @return Success
      */
     getCurrentUser(): Promise<UserDetail> {
@@ -2314,6 +2344,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get all registered permissions
      * @return Success
      */
     getAllRegisteredPermissions(): Promise<Permission[]> {
@@ -2368,7 +2399,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * SearchAsync roles by keyword
+     * @param body (optional) SearchAsync parameters.
      * @return Success
      */
     searchRoles(body?: RoleSearchCriteria | undefined): Promise<RoleSearchResult> {
@@ -2420,6 +2452,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get role by ID
      * @return Success
      */
     getRole(roleName: string): Promise<Role> {
@@ -2470,7 +2503,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param ids (optional) 
+     * Delete roles by ID
+     * @param ids (optional) An array of role IDs.
      * @return Success
      */
     deleteRoles(ids?: string[] | undefined): Promise<void> {
@@ -2518,6 +2552,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Update an existing role or create new
      * @param body (optional) 
      * @return Success
      */
@@ -2570,7 +2605,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * SearchAsync users by keyword
+     * @param body (optional) Search criteria.
      * @return Success
      */
     searchUsers(body?: UserSearchCriteria | undefined): Promise<UserSearchResult> {
@@ -2622,6 +2658,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get user details by user name
      * @return Success
      */
     getUserByName(userName: string): Promise<ApplicationUser> {
@@ -2672,6 +2709,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get user details by user ID
      * @return Success
      */
     getUserById(id: string): Promise<ApplicationUser> {
@@ -2722,6 +2760,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get user details by user email
      * @return Success
      */
     getUserByEmail(email: string): Promise<ApplicationUser> {
@@ -2772,6 +2811,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get user details by external login provider
      * @return Success
      */
     getUserByLogin(loginProvider: string, providerKey: string): Promise<ApplicationUser> {
@@ -2825,6 +2865,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Create new user
      * @param body (optional) 
      * @return Success
      */
@@ -2877,7 +2918,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Change password for current user.
+     * @param body (optional) Old and new passwords.
      * @return Success
      */
     changeCurrentUserPassword(body?: ChangePasswordRequest | undefined): Promise<SecurityResult> {
@@ -2933,7 +2975,9 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Change password
+     * @param userName user name
+     * @param body (optional) Old and new passwords.
      * @return Success
      */
     changePassword(userName: string, body?: ChangePasswordRequest | undefined): Promise<SecurityResult> {
@@ -2992,7 +3036,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Reset password confirmation
+     * @param body (optional) Password reset information containing new password.
      * @return Success
      */
     resetPassword(userName: string, body?: ResetPasswordConfirmRequest | undefined): Promise<SecurityResult> {
@@ -3047,7 +3092,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Reset password confirmation
+     * @param body (optional) New password.
      * @return Success
      */
     resetPasswordByToken(userId: string, body?: ResetPasswordConfirmRequest | undefined): Promise<SecurityResult> {
@@ -3094,6 +3140,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Validate password reset token
      * @param body (optional) 
      * @return Success
      */
@@ -3142,6 +3189,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Send email with instructions on how to reset user password.
      * @return Success
      */
     requestPasswordReset(loginOrEmail: string): Promise<void> {
@@ -3276,7 +3324,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param body (optional) 
+     * Update user details by user ID
+     * @param body (optional) User details.
      * @return Success
      */
     update(body?: ApplicationUser | undefined): Promise<SecurityResult> {
@@ -3328,7 +3377,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
-     * @param names (optional) 
+     * Delete users by name
+     * @param names (optional) An array of user names.
      * @return Success
      */
     delete(names?: string[] | undefined): Promise<void> {
@@ -3376,6 +3426,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Checks if user locked
+     * @param id User id
      * @return Success
      */
     isUserLocked(id: string): Promise<UserLockedResult> {
@@ -3426,6 +3478,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Checks if manual password change is enabled
      * @return Success
      */
     passwordChangeEnabled(): Promise<UserLockedResult> {
@@ -3473,6 +3526,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Lock user
+     * @param id >User id
      * @return Success
      */
     lockUser(id: string): Promise<SecurityResult> {
@@ -3523,6 +3578,8 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Unlock user
+     * @param id >User id
      * @return Success
      */
     unlockUser(id: string): Promise<SecurityResult> {
@@ -3807,6 +3864,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Get allowed login types
      * @return Success
      */
     getLoginTypes(): Promise<LoginType[]> {
@@ -3853,6 +3911,7 @@ export class SecurityClient extends AuthApiBase {
     }
 
     /**
+     * Verify user email
      * @return Success
      */
     sendVerificationEmail(userId: string): Promise<void> {
@@ -4241,6 +4300,7 @@ export class SettingClient extends AuthApiBase {
     }
 
     /**
+     * Get all settings
      * @return Success
      */
     getAllGlobalSettings(): Promise<ObjectSettingEntry> {
@@ -4288,6 +4348,7 @@ export class SettingClient extends AuthApiBase {
     }
 
     /**
+     * Update settings values
      * @param body (optional) 
      * @return Success
      */
@@ -4336,6 +4397,8 @@ export class SettingClient extends AuthApiBase {
     }
 
     /**
+     * Get settings registered by specific module
+     * @param id Module ID.
      * @return Success
      */
     getGlobalModuleSettings(id: string): Promise<ObjectSettingEntry[]> {
@@ -4393,6 +4456,8 @@ export class SettingClient extends AuthApiBase {
     }
 
     /**
+     * Get setting details by name
+     * @param name Setting system name.
      * @return Success
      */
     getGlobalSetting(name: string): Promise<ObjectSettingEntry> {
@@ -4443,6 +4508,7 @@ export class SettingClient extends AuthApiBase {
     }
 
     /**
+     * Get UI customization setting
      * @return Success
      */
     getUICustomizationSetting(): Promise<ObjectSettingEntry> {

package/core/composables/useNotifications/index.ts

@@ -1,4 +1,4 @@
-import { PushNotification, PushNotificationClient } from "./../../api";
+import { PushNotification, PushNotificationClient } from "./../../api/platform";
 import { useUser } from "./../useUser";
 import { computed, ComputedRef, ref } from "vue";
 import * as _ from "lodash-es";

package/core/composables/useSettings/index.ts

@@ -1,6 +1,6 @@
 import { useUser } from "./../useUser";
 import { computed, inject, Ref, ref } from "vue";
-import { SettingClient } from "./../../api";
+import { SettingClient } from "./../../api/platform";
 
 interface IUISetting {
   contrast_logo?: string;

package/core/composables/useUser/index.ts

@@ -11,7 +11,7 @@ import {
   ChangePasswordRequest,
   LoginType,
   ExternalSignInProviderInfo,
-} from "./../../api";
+} from "./../../api/platform";
 import { AuthData, RequestPasswordResult, SignInResults } from "./../../types";
 import { useLocalStorage } from "@vueuse/core";
 //The Platform Manager uses the same key to store authorization data in the
@@ -27,7 +27,6 @@ const authClient = new ClientOAuth2({
   scopes: ["offline_access"],
 });
 const securityClient = new SecurityClient();
-const externalSecurityClient = new ExternalSignInClient();
 
 interface IUseUser {
   user: ComputedRef<UserDetail | null>;
@@ -49,7 +48,8 @@ interface IUseUser {
 
 export function useUser(): IUseUser {
   const instance = getCurrentInstance();
-  const base = instance && inject("platformUrl");
+  const base = instance && inject<string>("platformUrl");
+  const externalSecurityClient = new ExternalSignInClient(base);
   const externalSignInStorage = useLocalStorage<{ providerType: string }>("externalSignIn", { providerType: null });
 
   const isAuthenticated = async () => {

package/core/plugins/signalR/index.ts

@@ -1,5 +1,5 @@
 import { HubConnectionBuilder, LogLevel } from "@microsoft/signalr";
-import { PushNotification } from "../../api";
+import { PushNotification } from "../../api/platform";
 import { useNotifications } from "./../../composables/useNotifications";
 
 const { addNotification } = useNotifications();

package/core/types/index.ts

@@ -20,7 +20,7 @@ export type IValidationRules = {
   max?: number;
   regex?: RegExp;
   min_value?: number;
-  max_value: number;
+  max_value?: number;
   after?: string;
   maxdimensions?: [string | number, string | number];
   size?: number;