jmapserver-ng-core-types 2.8.3 → 2.9.0

package/index.ts

@@ -799,6 +799,7 @@ export interface JProjectService {
   hasProjectActivated(): boolean
   getActiveProject(): JProject
   activateById(projectId: JId): JProject
+  refreshById(projectId: JId): Promise<JProject>
   activateByName(projectName: string): JProject
   deactivate(): void
   getAllProjects(): Promise<JProject[]>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapserver-ng-core-types",
-  "version": "2.8.3",
+  "version": "2.9.0",
   "description": "JMap Server specific version of JMap Server NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -5713,6 +5713,30 @@ declare namespace JMap {
      */
     function activateById(projectId: JId): JProject
 
+    /**
+     * **JMap.Project.refreshById**
+     *
+     * Refreshes a project. This will refresh the project information from the server, or add it to the list of projects in NG if not already present, but will not refresh the project's layers if the map is already loaded.
+     * This method is reserved for internal usage, you should not need to call it.
+     *
+     * User session rigths are checked server side and an error is thrown if user doesn't have the access right for the project.
+     *
+     * @throws Error missing project id or if project is not found
+     * @param projectId The JMap project id
+     * @return a promise that is resolved when the project has been loaded successfully
+     * @example
+     *  ```ts
+     * try {
+     *   // refresh project id=2
+     *   const project = JMap.Project.refreshById(2)
+     *   console.info(`Project id=${project.id} has been refreshed.`, project)
+     * } catch (error) {
+     *   console.error(`Cannot refresh the project : ${error}`)
+     * }
+     * ```
+     */
+    function refreshById(projectId: JId): Promise<JProject>
+
     /**
      * **JMap.Project.activateByName**
      *