jmapcloud-ng-core-types 1.0.17 → 1.0.20

package/index.ts

@@ -13,6 +13,7 @@ export interface JCoreService extends JCoreMainService {
   Geometry: JGeometryService
   MouseOver: JMouseOverService
   Form: JFormService
+  FormJMC: JFormJMCService
   Query: JQueryService
   Event: JEventService
   History: JHistoryService
@@ -154,6 +155,7 @@ export interface JFeatureService {
   // TODO: see if the future endpoint will return detail about individual deleted features success or failure
   // https://k2geospatial.atlassian.net/browse/JMAP8-1589
   deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
+  geometryCreate(params: JFeatureGeometryCreateParams): Promise<GeoJSON.Feature>
 }
 
 export interface JCoreMainService {
@@ -574,6 +576,10 @@ export interface JServerState extends JServerInfo {
 
 export type JHistoryListener = (oldValue: string | undefined, newValue: string | undefined) => void
 
+export interface JFormJMCService {
+  getJsonForm(layerId: string): JJsonFormSchemas
+}
+
 export interface JFormService {
   // REPO METHODS
   getFormsMetaDataByLayerId(layerId: JId): Promise<JFormMetaData[]>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.17",
+  "version": "1.0.20",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -506,7 +506,7 @@ declare namespace JMap {
      *
      * Change the feature geometry for the given layer id, feature id and geometry (projection EPSG:4326).
      *
-     * @param params contains the JMap layer id, the JMap feature id, and the geojson geometry
+     * @param params contains the JMap layer id, the JMap feature id, the geojson geometry, and optionally its attributes
      * @throws if layer or feature not found, or if feature is invalid (undefined, wrong geometry type, etc ...)
      * @example
      * ```ts
@@ -565,6 +565,46 @@ declare namespace JMap {
     // TODO: see if the future endpoint will return detail about individual deleted features success or failure
     // https://k2geospatial.atlassian.net/browse/JMAP8-1589
     function deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
+
+    /**
+     * **JMap.Feature.geometryCreate**
+     *
+     * Creates a new Geometry
+     *
+     * @param params An object containing the parameters for geometry creation.
+     * params.layerId:  The JMap layer id (string).
+     * params.geometry: The GeoJSON geometry object.
+     * params.properties: The values of the feature's attributes.
+     * params.crs: An object representing the coordinate reference system of the geometry.
+     * @throws Will throw an error if the layerId is not found.
+     * @returns A promise that resolves with the created GeoJSON feature.
+     *
+     * @example
+     * ```ts
+     * // Create a feature
+     * JMap.Feature
+     *   .geometryCreate({
+     *     layerId: "123e4567-e89b-12d3-a456-426614174000",
+     *     crs: {
+     *       type: "EPSG",
+     *       properties: {
+     *         code: 4326
+     *       }
+     *     },
+     *     geometry: {
+     *       type: "Point",
+     *       coordinates: [-73.56, 45.51]
+     *     },
+     *     properties: {
+     *       property1: "value1",
+     *       property2: "value2"
+     *     }
+     *   })
+     *   .then(() => console.info("Feature has been created"))
+     *   .catch(error => console.error("An error occurred", error));
+     * ```
+     */
+    function geometryCreate(params: JFeatureGeometryCreateParams): Promise<GeoJSON.Feature>
   }
 
   /**
@@ -889,8 +929,8 @@ declare namespace JMap {
        *         styleMapScales: [
        *           {
        *             id: "a9ba5215-0511-4aa3-a724-6f14f10ab315",
-       *             maximumVisibleZoom: 23,
-       *             minimumVisibleZoom: 0,
+       *             maximumZoom: 23,
+       *             minimumZoom: 0,
        *             styleId: condition1StyleId
        *           }
        *         ]
@@ -909,8 +949,8 @@ declare namespace JMap {
        *         styleMapScales: [
        *           {
        *             id: "8fb646bb-afee-4a3c-9545-e9716049d307",
-       *             maximumVisibleZoom: 23,
-       *             minimumVisibleZoom: 0,
+       *             maximumZoom: 23,
+       *             minimumZoom: 0,
        *             styleId: condition2StyleId
        *           }
        *         ]
@@ -929,8 +969,8 @@ declare namespace JMap {
        *         styleMapScales: [
        *           {
        *             id: "d0ad4bf4-f6a7-46f1-866b-74f97a5e7775",
-       *             maximumVisibleZoom: 23,
-       *             minimumVisibleZoom: 0,
+       *             maximumZoom: 23,
+       *             minimumZoom: 0,
        *             styleId: condition3StyleId
        *           }
        *         ]
@@ -949,8 +989,8 @@ declare namespace JMap {
        *         styleMapScales: [
        *           {
        *             id: "94331295-86b3-455c-8946-d45f79b8bd21",
-       *             maximumVisibleZoom: 23,
-       *             minimumVisibleZoom: 0,
+       *             maximumZoom: 23,
+       *             minimumZoom: 0,
        *             styleId: condition4StyleId
        *           }
        *         ]
@@ -10183,6 +10223,33 @@ declare namespace JMap {
     function renderMouseOver(layer: JLayer, feature: GeoJSON.Feature): Array<JExtensionMouseOver | undefined>
   }
 
+  /**
+   * **JMap.FormJMC**
+   *
+   * Here you'll find all form related methods
+   */
+  namespace FormJMC {
+    /**
+     * ***JMap.FormJMC.getJsonForm***
+     *
+     * Returns the jsonForm schema and uiSchema for a layer.
+     *
+     * fetch the attributes of a layer and then builds and returns the schema and uiSchema required for jsonForms. The schemas will be null if there is no attributes on the layer
+     *
+     * @param layerId the JMap layer id
+     * @example
+     * ```ts
+     * // returns the schema and uiSchema for layer id=f47ac10b-58cc-4372-a567-0e02b2c3d479
+
+
+     * JMap.FormJMC
+     *  .getJsonForm("f47ac10b-58cc-4372-a567-0e02b2c3d479")
+     *  .then(schemas => console.log("jsonForms schemas of layer f47ac10b-58cc-4372-a567-0e02b2c3d479", schemas))
+     *  .catch(error => console.error("An error occurred when getting jsonForm schema", error))
+     * ```
+     */
+    function getJsonForm(layerId: JId): JJsonFormSchemas
+  }
   /**
    * **JMap.Form**
    *

package/public/jmap/features.d.ts

@@ -6,6 +6,7 @@ declare interface JFeatureGeometryUpdateParams {
   layerId: JId
   featureId: JId
   geometry: GeoJSON.Geometry
+  properties?: JAttributeValueByName
 }
 
 declare interface JFeatureEventGeometryUpdateParams {
@@ -30,3 +31,15 @@ declare interface JFeatureEventCreateParams {
   featureGeometry: GeoJSON.Geometry
   featureProperties: JAttributeValueByName
 }
+
+declare interface JFeatureGeometryCreateParams {
+  layerId: JId
+  geometry: GeoJSON.Geometry
+  properties?: JAttributeValueByName
+  crs: {
+    type: string
+    property: {
+      code: number
+    }
+  }
+}

package/public/jmap/formJMC.d.ts

@@ -0,0 +1,28 @@
+declare interface JJsonFormSchemas {
+  schema: JJsonFormSchema | null
+  uiSchema: JJsonFormUISchema | null
+}
+
+declare interface JJsonFormSchema {
+  type: "object"
+  properties: {
+    [key: string]: {
+      type: string
+      format?: string
+    }
+  }
+  required: string[]
+}
+declare interface JJsonFormControlElement {
+  type: "Control"
+  scope: string
+  label: string
+  options?: {
+    [key: string]: any
+  }
+}
+
+declare interface JJsonFormUISchema {
+  type: "VerticalLayout"
+  elements: JJsonFormControlElement[]
+}

package/public/jmap/layer.d.ts

@@ -271,11 +271,11 @@ declare interface JLayerGeometry {
 }
 
 declare interface JLayerPermissions {
-  ADD: boolean
-  DELETE: boolean
-  DUPLICATE: boolean
-  EDIT_ATTRIBUTE_VALUES: boolean
-  EDIT_GEOMETRY: boolean
+  ADD_FEATURE: boolean
+  DELETE_FEATURE: boolean
+  EXTRACT_FEATURE: boolean
+  EDIT_FEATURE_ATTRIBUTES: boolean
+  EDIT_FEATURE_GEOMETRY: boolean
   EDIT_ONLY_OWN: boolean
 }
 
@@ -294,15 +294,14 @@ declare interface JLayer extends JLayerTreeElement {
   metadataSections: JLayerMetadataSection[]
   attributes: JLayerAttribute[]
   mouseOver: JMapMouseOver
-  minimumVisibleZoom: number | undefined
-  maximumVisibleZoom: number | undefined
+  minimumZoom: number | undefined
+  maximumZoom: number | undefined
   styleRules: JLayerStyleRule[]
   defaultStyleRule: JLayerStyleRule | undefined
   thematics: JLayerThematic[]
   queries: JQuery[]
   extent: JBoundaryBox | null
   permissions: JLayerPermissions
-  canEditGeometry: boolean
   hasAttributeForm: boolean
   hasExternalForms: boolean
   selectable: boolean
@@ -459,8 +458,8 @@ declare interface JLayerStyleRuleCondition {
 declare interface JLayerStyleScaled {
   id: string
   styleId: string
-  minimumVisibleZoom: number
-  maximumVisibleZoom: number
+  minimumZoom: number
+  maximumZoom: number
 }
 
 declare interface JLayerStyleSample {

package/public/jmap/mouseover.d.ts

@@ -2,8 +2,8 @@ declare interface JMapMouseOver {
   text: string
   preventTextDuplication: boolean
   backgroundColor: string
-  maximumVisibleZoom: number
-  minimumVisibleZoom: number
+  maximumZoom: number
+  minimumZoom: number
 }
 
 declare interface JMouseOverContent {

package/public/jmap/project.d.ts

@@ -36,8 +36,6 @@ declare interface JProject {
   colorBackground: string
   terrain?: JTerrainSpecification
   initialExtent: JBounds | null
-  minimumVisibleZoom: number
-  maximumVisibleZoom: number
   mapUnit: JMAP_DISTANCE_UNITS
   apiKey: {
     google: string | null

package/public/jmap/query.d.ts

@@ -1,9 +1,15 @@
+/**
+ * @deprecated
+ */
 declare interface JQueryGroup {
   id: JId
   name: string
   queries: JQuery[]
 }
 
+/**
+ * @deprecated
+ */
 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)
@@ -11,7 +17,7 @@ declare interface JQuery {
   name: string
   layerId: JId
   maxScale: number
-  maxResults: number,
+  maxResults: number
   isInitialized: boolean
   isLoading: boolean
   hasLoadingError: boolean