jmapcloud-ng-core-types 0.0.4

package/public/jmap/project.d.ts

@@ -0,0 +1,45 @@
+declare interface JProjectLoadThumbnailsParams {
+  width: number
+  height: number
+}
+
+declare interface JProjectEventParams {
+  project: JProject
+}
+
+declare interface JProjectAllEventParams {
+  projects: JProject[]
+}
+
+declare interface JProjectServerExtension {
+  id: string
+  urn: string // Unique identifier. Same as id for JMS
+  name: string
+  jsUrl: string
+  data: any | null
+  version: string
+}
+
+declare interface JProject {
+  id: JId //TODO: refactoring will be done in JWNG-351
+  name: string
+  description: string
+  projection: JProjection
+  initialRotation: number
+  colorSelection: string
+  colorBackground: string
+  initialExtent: JBounds | null
+  minimumVisibleMapboxZoom: number
+  maximumVisibleMapboxZoom: number
+  mapUnit: JMAP_DISTANCE_UNITS
+  apiKey: {
+    google: string | null
+    bing: string | null
+    mapBox: string | null
+  }
+  queryGroups: JQueryGroup[]
+  defaultDistanceUnit: JMAP_DISTANCE_UNITS
+  base64ImageThumbnail: string
+  extensions: JProjectServerExtension[]
+  usageStatisticsActive: boolean
+}

package/public/jmap/query.d.ts

@@ -0,0 +1,41 @@
+declare interface JQueryGroup {
+  id: JId
+  name: string
+  queries: JQuery[]
+}
+
+declare interface JQuery {
+  id: string // unique id, set by NG
+  jmapId: JId // non unique id, set by server, used to fetch query form (associate to layer id)
+  groupId: JId
+  name: string
+  layerId: JId
+  maxScale: number
+  maxResults: number,
+  isInitialized: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+  formMetaData: JFormMetaData
+}
+
+declare interface JQueryBeforeEventParams {
+  id: string
+  groupId: string
+  name: string
+  layerId: JId
+  maxScale: number
+  maxResults: number
+  enteredData: any
+}
+
+declare interface JQuerySuccessEventParams extends JQueryBeforeEventParams {
+  returnedFeatures: GeoJSON.Feature[]
+}
+
+declare interface JQueryErrorEventParams extends JQueryBeforeEventParams {
+  error: string
+}
+
+declare interface JQueryQueryFormHasLoadedEventParams {
+  query: JQuery
+}

package/public/jmap/selection.d.ts

@@ -0,0 +1,25 @@
+declare type JElementSelection = {
+  [key in JId]: JId[]
+}
+
+declare interface JSelectionSetLayersSelectionParams {
+  layerId: JId
+  features: GeoJSON.Feature[]
+}
+
+declare interface JMapSelectionParams {
+  /**
+   * true by default.
+   * If new selection select a feature that is already selected,
+   * if parameter is true it will deselect the feature,
+   * else will let the feature selected.
+   */
+  toggleSelection?: boolean
+  /**
+   * false by default.
+   * If new selection doesn't select a feature that is already selected,
+   * if true will let the feature selected,
+   * else will deselect it.
+   */
+  keepCurrentSelection?: boolean
+}

package/public/jmap/server.d.ts

@@ -0,0 +1,79 @@
+// ALL_SERVER_TYPES in all-enum.ts
+declare const enum JSERVER_TYPES {
+  LEGACY = "legacy",
+  SAAS = "saas"
+}
+
+// ALL_SERVER_SAAS_STATUS in all-enum.ts
+declare const enum JSERVER_SAAS_STATUS {
+  STARTING = "STARTING",
+  UP = "UP",
+  DOWN = "DOWN"
+}
+
+// ALL_SERVER_SAAS_STATUS in all-enum.ts
+declare const enum JSERVER_IDENTITY_PROVIDER_TYPES {
+  SSO = "sso",
+  AUTH0_SPA = "auth0-spa"
+}
+
+declare interface JServerIdentityProviderById {
+  [id: string]: JServerAnyIdentityProvider
+}
+
+declare interface JServerSaasServiceById {
+  [id: string]: JServerSaasService
+}
+
+declare interface JServerInfo {
+  identityProviderById: JServerIdentityProviderById
+  standardLoginAvailable: boolean
+  version: JServerVersion
+  type: JSERVER_TYPES
+  saasServiceById?: JServerSaasServiceById
+}
+
+declare interface JServerSaasService {
+  id: string
+  name: string
+  version: string
+  status: JSERVER_SAAS_STATUS
+  restBaseUrl: string
+}
+
+declare type JServerAnyIdentityProvider = JServerIdentityProviderAuth0Password | JServerIdentityProviderSso
+
+declare interface JServerIdentityProviderBase {
+  id: string
+  name: string
+  type: JSERVER_IDENTITY_PROVIDER_TYPES
+}
+
+declare interface JServerIdentityProviderAuth0Password extends JServerIdentityProviderBase {
+  type: JSERVER_IDENTITY_PROVIDER_TYPES.AUTH0_SPA
+  domain: string
+  clientId: string
+  realm: string
+}
+
+declare interface JServerIdentityProviderSso extends JServerIdentityProviderBase {
+  type: JSERVER_IDENTITY_PROVIDER_TYPES.SSO
+  imageData: string
+  loginUrl: string
+}
+
+declare interface JServerVersion {
+  title: string
+  mainVersion: number
+  buildNumber: number
+}
+
+declare interface JMinimumServerVersion {
+  legacy: JServerVersion
+  saas: JServerVersion
+}
+
+declare interface JServerInfoReadyEventParams {
+  serverInfo: JServerInfo
+  isMinimumVersionRespected: boolean
+}

package/public/jmap/startup-options.d.ts

@@ -0,0 +1,500 @@
+declare interface Window {
+  JMAP_OPTIONS?: JCoreOptions
+  __REDUX_DEVTOOLS_EXTENSION_COMPOSE__?: any
+}
+
+/**
+ * This section is about the JMAP Library startup options.
+ *
+ * JMap library executable is available through a CDN url.
+ *
+ * The URL is like "https://cdn.jsdelivr.net/npm/jmap-core-js@0.5.0/public/",
+ * but it depends on the version you want to use.
+ *
+ * First you need to import our JS file in your http file, in order to load the JMap Cloud NG Core library.
+ * It's recommended to put the CDN import at the end of the body tag, like that :
+ * ```html
+ * ...
+ * <html>
+ *   ...
+ *   <body>
+ *     ...
+ *     <!-- !!! Insert the import at the end of the body tag !!! -->
+ *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+ *   </body>
+ * </html>
+ * ```
+ * To make the JMap Cloud NG Core library working you need to provide some required information like :
+ *
+ *   - Your JMap Server Rest API URL
+ *   - The project id to open
+ *   - A valid JMap user session token, **or** set the JMap Cloud NG Core library to log as "anonymous"
+ *
+ * It can be passed by setting a global JS variable named "JMAP_OPTIONS" :
+ *
+ * ```html
+ * <html>
+ *   <body>
+ *     <script type="text/javascript">
+ *       window.JMAP_OPTIONS = {
+ *         // a valid project id
+ *         projectId: 10,
+ *         // a valid JMap server Rest url
+ *         restBaseUrl: "http://my-jmap-server/services/rest/v2.0",
+ *         session: {
+ *           // a valid session token
+ *           token: 2345677654
+ *         }
+ *         ... // other optional JMAP params
+ *       }
+ *     </script>
+ *     ... your web page
+ *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+ *   </body>
+ * </html>
+ * ```
+ *
+ * Below a full example of how to start the JMap library in a web page,
+ * where parameters ***ngToken*** and ***ngProjectId*** are get from the url :
+ * ```html
+ * <!DOCTYPE html>
+ * <html>
+ *   <head>
+ *     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ *     <meta charset="UTF-8">
+ *   </head>
+ *   <body class="jmap_wrapper">
+ *    <script type="text/javascript">
+ *       const url = new URL(window.location.href)
+ *       const token = url.searchParams.get("ngToken")
+ *       let projectId = Number(url.searchParams.get("ngProjectId"))
+ *       if (isNaN(projectId)) {
+ *         projectId = 0
+ *       }
+ *       window.JMAP_OPTIONS = {
+ *         projectId: Number(projectId),
+ *         restBaseUrl: "http://your-jmap-server-url/services/rest/v2.0",
+ *         token: token
+ *       }
+ *     </script>
+ *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/index.js">
+ *     </script>
+ *   </body>
+ * </html>
+ * ```
+ *
+ * For example, you can pass this parameters like that :
+ *   - **http:// my-company/my-custom-page-using-jmap?ngToken=95423672742&ngProjectId=10**.
+ *
+ * When JMap Cloud NG Core library starts, if the **JMap token "*95423672742*"** is valid, it will automatically load
+ * the **JMap project id=*10***, then load the map in the **div id="*jmap-map*"**.
+ */
+declare interface JCoreOptions {
+  /**
+   * The JMap project id.
+   *
+   * If both a project id and a project name are provided, project id will be used.
+   *
+   * If no project name or id are set, the library will do noting, you will have a blank page.
+   *
+   * So if you want the library to load the project automatically, you need to set the project id.
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         // a valid project id
+   *         projectId: 12
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  projectId?: JId
+
+  /**
+   * A JMap project name.
+   *
+   * If you can prefer using the project id over the name.
+   *
+   * If both a project id and a project name are provided, project id will be used.
+   *
+   * If no project name or id are set, the library will do noting, you will have a blank page.
+   *
+   * So if you want the library to load the project automatically, you need to set the project name (or id).
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         // a valid project name
+   *         projectName: "The world"
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  projectName?: string
+
+  /**
+   * If provided this function will be processed when the list of projects is received from the server :
+   *
+   * the event receives a JProjectAllEventParams object
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *           onProjectsChange: (params) => {
+   *              params.projects.forEach(project => console.log("project name: " + project.name))
+   *           },
+   *         ...
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  onProjectsChange?(params: JProjectAllEventParams): void
+
+  /**
+   * By default project thumbnails are not loaded, because they are not useful if JMap Cloud NG Core lib is used alone.
+   *
+   * To load asynchronously project thumbnails, set startup option "loadProjectThumbnails" to true.
+   *
+   * JMap Cloud NG Core lib will load all project thumbnails (or preview) in project objects (property "base64ImageThumbnail").
+   *
+   * The thumbnail is stored as a base64 string image, that you can use to set an img src attribute directly.
+   *
+   * For a project object, if thumbnail is not loaded, default value of its property "base64ImageThumbnail" is "" (empty string).
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         loadProjectThumbnails: true
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   *
+   * Then you will be able to get a project and use its thumbnail  :
+   * ```javascript
+   * JMap.Project.getBase64ImageThumbnail() // return loaded project image, "" if no image loaded
+   * JMap.Project.getById(3).base64ImageThumbnail // return project id=3 image, "" if no image loaded
+   * ```
+   */
+  loadProjectThumbnails?: boolean
+
+  /**
+   * The JMap Server Rest API url.
+   *
+   * Default value is : http://localhost:8080/services/rest/v2.0 (for test only).
+   *
+   * If your are not testing you must provide the url of your JMap REST API :
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         // a valid JMap REST Api url
+   *         restBaseUrl: "http://my-custom-jmap-server-url/services/rest/v2.0"
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  restBaseUrl?: string
+
+  /**
+   * If the project you access can be accessed anonymously,
+   * you are not forced to pass a session token but you have
+   * to explicitly tell the JMap Cloud NG library to log as an anonymous
+   * user by setting the "***anonymous***" parameter like that :
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         // a valid project id
+   *         projectId: 10,
+   *         // a valid JMap Server Rest url
+   *         restBaseUrl: "http://my-jmap-server/services/rest/v2.0",
+   *         // The anonymous parameter
+   *         anonymous: true
+   *         ... // other optional JMAP params
+   *       }
+   *     </script>
+   *
+   *     ... your web page
+   *
+   *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+   *   </body>
+   * </html>
+   * ```
+   */
+  anonymous?: boolean
+
+  /**
+   * The JMap user's session token.
+   *
+   * If you don't use the library with an anonymous user (see the [[***JCoreOptions.anonymous***]] parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
+   *
+   * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See [[JMap.User.setToken]] for detailed examples on how to fetch a token through JMap's REST API.
+   *
+   * So to start the library using the fetched token you can configure your startup options like this :
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         token: "23558109"
+   *       }
+   *     </script>
+   *     ...
+   *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+   *   </body>
+   * </html>
+   * ```
+   *
+   * If you don't want to make an AJAX call to the REST API, you can use the JMap library to login (JMap will make the AJAX call to the rest API). You have to wait for the lib to be loaded and the server to be ready to accept requests.
+   *
+   * To know if the lib has been loaded you can check if the JMAp namespace exists or not. See below for an example:
+   *
+   * ```html
+   * <!DOCTYPE html>
+   *   <html>
+   *     ...
+   *     <body class="jmap_wrapper">
+   *       <script type="text/javascript">
+   *         console.log("JMap", window.JMap)
+   *         window.JMAP_OPTIONS = {
+   *           projectId: 35,
+   *           restBaseUrl: "https://jmap7dev.jmaponline.net/services/rest/v2.0",
+   *           map: {
+   *             zoom: 9.757829447748511,
+   *             center: {
+   *               x: -73.66415865898597,
+   *               y: 45.53583011032552
+   *             }
+   *           }
+   *         }
+   *       </script>
+   *       ...
+   *       <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/index.js"></script>
+   *       <script>
+   *         (function jmapLogin() {
+   *           if (window.hasOwnProperty("JMap") && JMap.Server.isReady()) {
+   *             JMap.User.login("jdo@company.com", "xxx")
+   *           } else {
+   *             console.log("Waiting for the JMap lib to be loaded ...")
+   *             setTimeout(() => jmapLogin(), 150) // check every 150 milliseconds
+   *           }
+   *         })()
+   *       </script>
+   *     </body>
+   *   </html>
+   * ```
+   *
+   */
+  token?: string
+
+  /**
+   * The JMap Cloud organization id associated with the refresh token.
+   *
+   * For JMap CLoud only. Only taken into account if a refresh token has been passed via the [[JCoreOptions.token]] startup option (or the equivalent hash parameter version)
+   * ***or*** if the "anonymous" option has been passed, together with a project id.
+   *
+   * You can pass this organization id to open a session on JMap Cloud via the startup options.
+   *
+   * A typical usage for a session opening:
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         token: "v1.MRq [.....] Rehef72YWws", // a refresh token
+   *         organizationId: "my-organization-id"
+   *       }
+   *     </script>
+   *     ...
+   *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+   *   </body>
+   * </html>
+   * ```
+   *
+   * A typical usage for a JMap Cloud public project:
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         anonymous: true,
+   *         projectId: "my-project-id",
+   *         organizationId: "my-organization-id"
+   *       }
+   *     </script>
+   *     ...
+   *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+   *   </body>
+   * </html>
+   * ```   */
+  organizationId?: string
+
+  /**
+   * By default the geolocation service is enabled.
+   *
+   * But you can disable the geolocation service by setting the "***geolocationEnabled***" parameter to false :
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         geolocationEnabled: false
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  geolocationEnabled?: boolean
+
+  /**
+   * All map related options.
+   *
+   * Click on [[JCoreMapOptions]] to get details.
+   */
+  map?: JCoreMapOptions
+
+  /**
+   * Optional extensions.
+   *
+   * Click [[JCoreExtension]] to get details about how defining an extension.
+   */
+  extensions?: JCoreExtension[]
+
+  /**
+   * If true, changing project after one has been loaded will be disabled.
+   */
+  disableProjectChange?: boolean
+
+  /**
+   * If set to any of the locales supported by JMap, will define the default locale, bypassing browser or user-defined locale.
+   *
+   * Supported locales  can be retrieved by calling [[JMap.User.getLocales()]]
+   */
+  locale?: string
+
+  /**
+   * Call when the JMap library is loaded
+   */
+  onReady?: () => void
+
+  /**
+   * As a developer, you can override a project's extension jsUrl during development.
+   *
+   * Ex: the extension having id="custom-extension" is set on the project. Its unique identifier is:
+   * * for JMap Server: `serverExtensionId` = "my.extention.classPath"
+   * * for JMap Cloud: `jmapCloudExtensionUrn` = "949079ff-d021-45dd-93c0-611bfcebfc2b"
+   *
+   * Its jsUrl is "https://cdn.jsdelivr.net/npm/custom-extension@1.0.10/public/index.js"
+   *
+   * During development, you need to be able to load your local code instead of the code located at the extension's jsUrl location.
+   *
+   * Your local development code could for instance be available at: "https://localhost:8083/build/index.js".
+   *
+   * In order to change the extension jsUrl dynamically, you can set your `JMAP_OPTIONS.extensionsUrlOverride` property like this:
+   *
+   * For JMAp Server:
+   * [{
+   *  extensionUniqueIdentifier: "my.extention.classPath",
+   *  jsUrl: "https://localhost:8083/build/index.js"
+   * }]
+   *
+   * For JMap Cloud:
+   * [{
+   *  extensionUniqueIdentifier: "949079ff-d021-45dd-93c0-611bfcebfc2b",
+   *  jsUrl: "https://localhost:8083/build/index.js"
+   * }]
+   *
+   *
+   */
+  extensionsUrlOverride?: JExtensionServerOverride[]
+
+  /**
+   * By default NG Core provide a main layout in order to display:
+   *  - a loader incating NG Core is loading
+   *  - a login panel
+   *  - a project selection panel
+   *
+   * But you can avoid this UI by setting this option to true.
+   *
+   * For example NG don't need NG Core minimal UI and use this option.
+   */
+  hideMainLayout?: boolean
+
+  /**
+   * If true, no basemap will be available/displayed.
+   * In JMap Cloud NG, no basemap panel will be displayed in the left panel
+   */
+  disableBasemaps?: boolean
+
+  /**
+   * A basemap id.
+   *
+   * If provided, will use the corresponding basemap as the default basemap.
+   *
+   * If the id is unknown, will do nothing. To get all basemaps ids in the project, use [[JMap.Map.Basemap.getAllIds()]]
+   *
+   * Using the id "none" will use no basemap at startup.
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         // disable the default basemap
+   *         defaultBasemapId: "none"
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  defaultBasemapId?: string
+}

package/public/jmap/ui.d.ts

@@ -0,0 +1,13 @@
+declare interface JIFramePopup {
+  src: string
+  title: string
+  initialPosition: JLocation
+  initialWidth: string
+  initialHeight: string
+  resizable: boolean
+  hideBorder: boolean
+}
+
+declare interface JIFramePopupParams extends Partial<JIFramePopup> {
+  src: string
+}