syshub-rest-module - npm Package Versions

[3.0.0] - 2023-12-07

Changed

• Fixed issue with permanent token refresh.
• Update peer dependencies to Angular 17.

[2.4.1] - 2023-08-08

Changed

• Fixed SyshubInterceptor: In the case of FormData objects as payload, the interceptor no longer sets a Content-Type header, as this would destroy the standard browser header.
• Removed postFile() method: Since no header is needed, the method is no longer necessary and has been removed.

Added

• Method uploadFileToJob(jobId: number, fileType: 'ticket' | 'source', file: File, fileName: string) to upload a file for a sysHUB job

[2.3.1] - 2023-07-31

Changed

• Fixed url for custom endpoints that are missing the webapi before the custom

[2.3.0] - 2023-07-26

Added

• Method deletec() to call a custom HTTP DELETE endpoint.
• Method getc() to call a custom HTTP GET endpoint.
• Method head() to call a HTTP HEAD endpoint.
• Method headc() to call a custom HTTP HEAD endpoint.
• Method options() to call a HTTP OPTIONS endpoint.
• Method optionsc() to call a custom HTTP OPTIONS endpoint.
• Method patchc() to call a custom HTTP PATCH endpoint.
• Method postc() to call a custom HTTP POST endpoint.
• Method putc() to call a custom HTTP PUT endpoint.

[2.2.0] - 2023-07-25

Added

• Method getCurrentUsersPermissions() to get a list of permission names of the current user.
• Method getCurrentUsersRoles() to get a list of role names of the current user.
• Method getDevices(withImg: boolean = false) to get the IPP devices.
• Method getPermissions() to get a list of permissions.
• Method getPermissionSets() to get a list of permissionsets.
• Method getRoles() to get a list of roles.
• Method getUsers() to get a list of users.
• Method getWorkflows(params: SearchParams) to get a filtered and sorted list of workflows.
• Method getWorkflowReferences(uuid: string) to get a list of workflow references.
• Method getWorkflowStartpoints(uuid: string) to get the start point names of a workflow.
• Method getWorkflowVersions(uuid: string) to get a list of workflow versions.

[2.1.0] - 2023-07-24

Added

• Method createCategory(category: SyshubCategory) to create a category.
• Method createSyslogEntry(entry: SyshubSyslogEntryToCreate) to create a syslog entry.
• Method createUserlogEntry(entry: SyshubUserlogEntryToCreate) to create a syslog entry.
• Method deleteCategory(uuid: string) to delete a category.
• Method deleteConfigItem(uuid: string) to delete a config item and all its children.
• Method deletePSetItem(uuid: string) to delete a parameterset item and all its children.
• Method getCategories() to retrieve a list of all categories.
• Method getCategory(uuid: string) to retrieve a category.
• Method getCategoryRefs(uuid: string, type?: 'Decision' | 'Process' | 'Jobtype' | 'Workflow' | undefined) to retrieve a category.
• Method getClusterStatus() to get the cluster status.
• Method getConfigChildren(uuid: string, maxDeep: number = 0) to get all children of a config item.
• Method getConfigItem(uuid: string) to get one item from the config tree.
• Method getConfigPath(uuid: string) to get the path of an item from the config tree.
• Method getConnectedClients(all: boolean = true) to get a list of connected clients.
• Method getJndiConnectionNames() to get a list of JNDI connections.
• Method getJndiDatabaseStructure(jndi: string = 'System', native: boolean = true) to get the structure of a JNDI connected database.
• Method getJobDir(id?: number | undefined) to get the jobdir.
• Method getNamedSystemsForConfigPath() to get a list of named systems for a path in the config tree.
• Method getPsetChildren(uuid: string, maxDeep: number = 0) to get all children of a parameterset item.
• Method getPsetItem(uuid: string) to get one item from the parameterset tree.
• Method getPsetPath(uuid: string) to get the path of an item from the parameterset tree.
• Method getSyslogEntries(params?: SearchParams) to retrieve a filterable and sortable list of syslog entries from the server.
• Method getSyslogEntry(id: number) to retrieve one syslog entry from the server.
• Method getSyslogHostnames() to retrieve a list of all hostnames used in syslog.
• Method getUserlogEntries(params?: SearchParams) to retrieve a filterable and sortable list of userlog entries from the server.
• Method getUserlogEntry(id: number) to retrieve one userlog entry from the server.
• Method searchConfig(search: SearchTree) to search inside the config tree.
• Method searchPSet(search: SearchTree) to search inside the config tree.

[2.0.0] - 2023-07-21

This is a breaking change if you upgrade from Version 1.1 or older. The methods delete(), get(), patch(), post(), postFile(), put() returns a new kind of object.

Added

• Provide interface Env in the module to provide typechecking for apps that make use of this module.
• Methods delete(), get(), patch(), post(), postFile(), put() will throw an NotLoggedinError if user is not loggedin via OAuth. In case of basic auth user counts as always logged in.
• Rest API calls like getServerInformation() throw an MissingScopeError if the scope configuration in the envionment is missing the correct scope.
• A new configuration switch throwErrors has been added to the environment configuration. If set to false (default) the previous stated errors will not be thrown.
• Method backupSyshub(backupName: string, backupDescription: string, folderpath: string, includeOptions: string[]) to create a new backup.
• Method createJob(job: SyshubJob) to create a new job.
• Method deleteJob(id: number) to delete one job from the server.
• Method getBackupMetadata(folder: string) to retrieve information for a created backup.
• Method getCertStoreItems() to retrieve cert store information.
• Method getJob(id: number) to retrieve one job from the server.
• Method getJobs(params?: SearchParams) to retrieve a filterable and sortable list of jobs from the server.
• Method getServerInformation() to retrieve server information like license, system and grid node name, version.
• Method getServerProperties() to retrieve items from server.properties file.
• Method getWorkflowExecution(uuid: string) to retrieve one running workflow executions.
• Method getWorkflowExecutions() to retrieve running workflow executions.
• Method replaceJob(id: number, job: SyshubJobToPatch) to replace a job on the server.
• Method restoreSyshub(folderpath: string, includeOptions: string[]) to restore from a backup.
• Method runConsoleCommand(cmd: string, params: string[] = []) to execute a console command.
• Method runConsoleCommandHelp() to execute the console command HELP and convert the server response into a list of key-value strings where key is the command and value the description of the command.
• Method runConsoleCommandMem() to execute the console command MEM and convert the server response into a usable object instead of string-array.
• Method runConsoleCommandP() to execute the console command P and convert the server response into a usable object instead of string-array.
• Method runWorkflow(uuid: string, async: boolean = true, jobId?: number) to start a workflow execution.
• Method runWorkflowAlias(alias: string, payload: any | undefined, method: 'DELETE' | 'GET' | 'POST' | 'PUT' = 'POST') to start a workflow based on it's alias name.

Changes

• Upgrade to Angular 16
• Changed default syHUB version to 2023
• Breaking Change: Now every Rest API call (using the methods delete(), get(), patch(), post(), postFile(), put()) will return an object of type Response in case of success. This object contains three objects:
  • content: Contains the response body (normally a string)
  • header: The headers from the response
  • status: The HTTP Status code of the response