jmapcloud-ng-core-types 0.0.4

package/public/jmap/form.d.ts

@@ -0,0 +1,590 @@
+// ALL_FORM_TYPES in all-enum.ts
+declare const enum JFORM_TYPES {
+  DEPRECATED = "DEPRECATED_FORM",
+  ATTRIBUTE = "LAYER_ATTRIBUTES_FORM",
+  ATTRIBUTE_SUB_FORM = "LAYER_ATTRIBUTES_SUB_FORM",
+  EXTERNAL = "EXTERNAL_ATTRIBUTES_FORM",
+  EXTERNAL_SUB_FORM = "EXTERNAL_ATTRIBUTES_SUB_FORM"
+}
+
+// ALL_FORM_UI_CONTROL_ALIGNMENTS in all-enum.ts
+declare const enum JFORM_UI_CONTROL_ALIGNMENTS {
+  LEFT = "LEFT",
+  CENTER = "CENTER",
+  RIGHT = "RIGHT"
+}
+
+// ALL_FORM_WIDGET_TYPES in all-enum.ts
+declare const enum JFORM_WIDGET_TYPES {
+  INPUT = "input",
+  RANGE = "range",
+  SWITCH = "switch",
+  SELECT = "select",
+  DATE = "date",
+  PHOTO = "photo",
+  TREE = "tree",
+  LABEL = "label",
+  SPAN = "span",
+  TABLE = "table"
+}
+
+// ALL_JSON_SCHEMA_TYPES in all-enum.ts
+declare const enum JJSON_SCHEMA_TYPES {
+  STRING = "string",
+  NUMBER = "number",
+  INTEGER = "integer",
+  BOOLEAN = "boolean",
+  ARRAY = "array",
+  OBJECT = "object"
+}
+
+// ALL_FORM_OPERATION_TYPES in all-enum.ts
+declare const enum JFORM_OPERATION_TYPES {
+  CREATION = "creation",
+  UPDATE = "update",
+  DELETE = "delete"
+}
+
+// FORM METADATA
+
+declare interface JFormFieldValidationRuleByAttributeName {
+  [fieldName: string]: any
+}
+
+declare interface JFormValidationRules {
+  globalRules: JFormGlobalValidationRule[]
+  requiredRuleByAttributeName?: JFormFieldValidationRuleByAttributeName
+  readonlyRuleByAttributeName?: JFormFieldValidationRuleByAttributeName
+  calculatedRuleByAttributeName?: JFormFieldValidationRuleByAttributeName
+  visibleRuleByAttributeName?: JFormFieldValidationRuleByAttributeName
+}
+
+declare interface JFormGlobalValidationRule {
+  id: string
+  expression: any
+  name: string
+  message: string
+}
+
+declare interface JFormPermissions {
+  editLayerAttributeValues: boolean
+  addExternalFormAttributeValues: boolean
+  deleteExternalFormAttributeValues: boolean
+  editExternalFormAttributeValues: boolean
+}
+
+declare interface JFormMetaData {
+  id: JId
+  type: JFORM_TYPES
+  name: string
+  schema: JFormSchema
+  uiSchema: JFormUISchema
+  validationRules: JFormValidationRules
+  idAttributeName: string | null
+  hasPhoto: boolean
+  readOnly: boolean
+  isDeleteSupported: boolean
+  isCreateSupported: boolean
+  isUpdateSupported: boolean
+  areAllInputControlsReadOnly: boolean
+  isFakeAttributeForm?: boolean // in JMap7 attribute form is optional
+  permissions: JFormPermissions
+}
+
+declare interface JFormSchema {
+  $id: string
+  type: "object"
+  $schema: "http://json-schema.org/draft-07/schema#"
+  definitions: {}
+  properties: JFormSchemaProperties
+  required: string[]
+}
+
+declare interface JFormSchemaProperties {
+  [name: string]: JFormSchemaProperty
+}
+
+declare interface JFormSchemaProperty {
+  title: string
+  type: JJSON_SCHEMA_TYPES
+  description: string
+  isRequired: boolean
+  items?: {
+    // used if property type = "array"
+    type: JJSON_SCHEMA_TYPES // here only number or string
+  }
+  readOnly?: boolean
+  format?: string
+  pattern?: string
+  minimum?: number
+  maximum?: number
+  minLength?: number // used for required (because required check only if object has attribute)
+  maxLength?: number
+  enum?: string[] | number[] | boolean[]
+  enumNames?: string[]
+  parents?: Array<string | undefined> | Array<string | undefined>
+  default?: any
+}
+
+// FORM METADATA UI
+
+declare type JFormUISchema = JFormUITab[]
+
+declare interface JFormUITab {
+  type: "Tab"
+  title: string
+  controls: JFormUIControl[]
+}
+
+declare interface JFormUIControl {
+  type: "Control"
+  id: string
+  widget: JFORM_WIDGET_TYPES
+  colSpan?: number // the layout grid has 12 columns
+  fontBold?: boolean
+  fontItalic?: boolean
+  ruleCalculated?: object
+  ruleReadOnly?: object
+  ruleRequired?: object
+  ruleVisible?: object // not yet implemented server side
+  scope?: string // use with attribute related controls. Ex of scope : "#/properties/done"
+  multi?: boolean // for select control
+  align?: JFORM_UI_CONTROL_ALIGNMENTS
+  rows?: number // for multiline input control
+  label?: string
+  tooltip?: string
+  date?: boolean
+  dateNow?: boolean // for date control : current date as default value
+  dateTime?: boolean // for date control
+  dateFormat?: string // for date control
+  onlyLeafSelection?: boolean // for tree control
+  tree?: JFormUIControlTreeElement[]
+  entries?: JFormUIControlEntry[]
+  parentAttributeName?: string // used for select that change following parent value
+  mask?: string
+  layerId?: JId // for table control
+  subFormId?: JId // for table control
+  tableAttributes?: JFormAttribute[] // for table control
+  deleteWithElement?: boolean // for photo control
+}
+
+declare interface JFormUIControlEntry {
+  label: string
+  value: number | string
+  parentValue: string | undefined
+}
+
+declare interface JFormUIControlTreeElement extends JFormUIControlEntry {
+  children: undefined | JFormUIControlTreeElement[]
+}
+
+// BELOW ALL OLD FORM TYPES RECEIVED FROM SERVERS IN JMAP 7
+
+// ALL_FORM_FIELD_TYPES in all-enum.ts
+declare const enum JFORM_FIELD_TYPES {
+  EMPTY = "TYPE_EMPTY",
+  COLUMN_SPAN = "TYPE_COLUMN_SPAN",
+  LABEL = "TYPE_LABEL",
+  TEXT = "TYPE_INPUT_TEXT",
+  RANGE = "TYPE_INPUT_RANGE",
+  SELECT_ONE = "TYPE_SELECT_ONE",
+  SELECT_MANY = "TYPE_SELECT_MANY",
+  DATE = "TYPE_INPUT_DATE",
+  BOOLEAN = "TYPE_SELECT_BOOLEAN",
+  GROUP_PANEL = "TYPE_GROUP_PANEL",
+  DOCUMENT = "TYPE_DOCUMENT",
+  TREE = "TYPE_TREE",
+  TABLE = "TYPE_TABLE"
+}
+
+declare interface JFormSection {
+  name: string
+  index: number
+  nbCol: number
+  rows: JFormRow[]
+}
+
+declare interface JFormRow {
+  sectionIndex: number
+  sectionName: string
+  index: number
+  fields: JFormField[]
+}
+
+declare type JFormField =
+  | JFormFieldLabel
+  | JFormFieldEmpty
+  | JFormFieldInput
+  | JFormFieldInputText
+  | JFormFieldDate
+  | JFormFieldRange
+  | JFormFieldCheckBox
+  | JFormFieldSelectOne
+  | JFormFieldSelectBase
+  | JFormFieldSelectTree
+  | JFormFieldPhoto
+
+declare interface JFormFieldBase {
+  id: string
+  type: JFORM_FIELD_TYPES
+  tooltip: string
+  align: JFORM_UI_CONTROL_ALIGNMENTS
+}
+
+declare interface JFormFieldEmpty extends JFormFieldBase {
+  type: JFORM_FIELD_TYPES.EMPTY
+}
+
+declare interface JFormFieldPhoto extends JFormFieldBase {
+  label: string
+  deleteWithElement: boolean
+}
+
+declare interface JFormFieldLabel extends JFormFieldBase {
+  text: string
+}
+
+declare interface JFormFieldColumnSpan extends JFormFieldBase {
+  id: string
+}
+
+declare interface JFormFieldInput extends JFormFieldBase {
+  required: boolean
+  readOnly: boolean
+  defaultValue: string
+  labelPrefix: string
+  labelSuffix: string
+  attribute: JFormFieldAttribute
+  parentAttribute: string
+  ruleCalculated?: string
+  ruleReadOnly?: string
+  ruleRequired?: string
+  ruleVisible?: string
+}
+
+declare interface JFormFieldAttribute {
+  name: string
+  type: number
+}
+
+declare interface JFormFieldDate extends JFormFieldInput {
+  dateFormat: string
+}
+
+declare interface JFormFieldInputText extends JFormFieldInput {
+  range: null | { min: number; max: number }
+  multiLine: boolean
+  maxNumberCharacter: number
+  maskFormatter: string
+}
+
+declare interface JFormFieldRange extends JFormFieldInput {
+  type: JFORM_FIELD_TYPES.RANGE
+}
+
+declare interface JFormFieldCheckBox extends JFormFieldInput {
+  checkedValue: string
+  uncheckedValue: string
+}
+
+declare interface JFormFieldTreeEntry {
+  parentValue: string
+  label: string
+  value: string
+}
+
+declare interface JFormFieldSelectBase extends JFormFieldInput {
+  selectEntries: JFormFieldTreeEntry[]
+}
+
+declare interface JFormFieldSelectOne extends JFormFieldSelectBase {
+  canAddNewValue: boolean
+  autoSelectUniqueValue: boolean
+}
+
+declare interface JFormFieldSelectTree extends JFormFieldSelectBase {
+  onlyLeafSelection: boolean
+}
+
+declare interface JFormAttribute {
+  id: string
+  label: string
+  type: JLAYER_ATTRIBUTE_TYPES
+  readOnly: boolean
+  nullable: boolean
+  isSystem: boolean
+  displayFormat: string
+  isShowInTable: boolean
+  formatPattern: string
+}
+
+declare interface JFormFieldTable extends JFormFieldBase {
+  label: string
+  subFormId: JId
+  attributes: JFormAttribute[]
+}
+
+// FORM DATA
+
+declare interface JFormElementData {
+  attributeValueByName: JAttributeValueByName
+}
+
+declare interface JFormElement extends JFormElementData {
+  /**
+   * undefined if element, set if it's an entry
+   */
+  parentId: JId
+  id: JId
+  /**
+   * empty object if element, set if it's an entry
+   */
+  parentAttributeValueByName: JAttributeValueByName
+  /**
+   * undefined if element, set if it's an entry
+   */
+  elementId?: JId
+  /**
+   * used to replace new created element temp id by new real id
+   */
+  tempId?: JId
+}
+
+// Used only for JMap 7 Rest API
+declare interface JFormExternalAttribute {
+  type: number
+  name: string
+}
+
+declare interface JFormPhotoData {
+  isLoading: boolean
+  hasLoadingError: boolean
+  hasChange: boolean
+  initialPhotos: JPhoto[]
+  photos: JPhoto[]
+}
+
+declare interface JFormPhotoUpdate {
+  photoId: JId
+  title?: string
+  comment?: string
+}
+
+declare interface JForm extends JFormElementData {
+  id: JId
+  layerId: JId
+  initialAttributeValueByName: JAttributeValueByName
+  metaData: JFormMetaData
+  parent: JForm | undefined
+  elements: JFormElement[]
+  fetchElementsFromServerFailed: boolean
+  errors: { [attributeName: string]: any }
+  hasChange: boolean
+  hasAttributeValueChange: boolean
+  isMultiple: boolean
+  isCreation: boolean
+  isAttributeForm: boolean
+  isExternalForm: boolean
+  isSubForm: boolean
+  isReadOnly: boolean
+  isReadOnlyEditOwn: boolean
+  canCreate: boolean
+  canUpdate: boolean
+  canDelete: boolean
+  photoData: JFormPhotoData
+  geometry?: GeoJSON.Geometry // required for attribute forms
+  subFormDataBySubFormId?: JSubFormDataBySubFormId // required for table support
+}
+
+declare interface JFormMetaDataById {
+  [formId: string]: JFormMetaData
+}
+
+declare interface JFormId {
+  layerId: JId
+  formId: JId
+}
+
+declare interface JFormElementId extends JFormId {
+  elementId: JId
+}
+
+declare interface JFormGetEntriesParams extends JFormId {
+  elementId: JId
+  parentId: JId
+  parentFormAttributesValuesByName: JAttributeValueByName
+  idAttributeName?: string
+}
+
+declare interface JFormElementIds extends JFormId {
+  elementIds: JId[]
+}
+
+declare interface JFormElements extends JFormId {
+  elements: JFormElement[]
+}
+
+declare interface JFormCreateAttributeFormElementParams extends JFormElementData, JFormId {
+  geometry: GeoJSON.Geometry
+  tempId?: JId // used to replace tempId by real one in external forms
+}
+
+declare interface JFormCreateElementParams extends JFormElement, JFormId {
+  idAttributeName: JId
+}
+
+declare interface JFormUpdateElementsParams extends JFormElements {
+  // nothing
+}
+
+declare interface JFormResult {
+  elementId: JId
+  success: boolean
+}
+
+declare interface JFormCreateParams extends JFormId {
+  geometry?: GeoJSON.Geometry
+}
+
+declare interface JFormEditParams extends JFormId {
+  elements: JFormElement[]
+}
+
+declare interface JFormOperation {
+  formType: JFORM_TYPES
+  layerId: JId
+  formId: JId
+  formName: string
+  isAttributeForm: boolean
+  isExternalForm: boolean
+  isSubForm: boolean
+  isPhoto: boolean
+  operationType: JFORM_OPERATION_TYPES
+  layerElementId: JId
+  id: JId
+}
+
+declare interface JFormAttributeOperation extends JFormOperation {
+  formType: JFORM_TYPES.ATTRIBUTE
+  isAttributeForm: true
+  isExternalForm: false
+  isSubForm: false
+  isPhoto: false
+  attributeValueByName: JAttributeValueByName
+}
+
+declare interface JFormExternalOperation extends JFormOperation {
+  formType: JFORM_TYPES.EXTERNAL
+  isAttributeForm: false
+  isExternalForm: true
+  isSubForm: false
+  isPhoto: false
+  idAttributeName: string
+  attributeValueByName: JAttributeValueByName
+  parentAttributeValueByName: JAttributeValueByName
+}
+
+declare interface JFormSubFormOperation extends JFormOperation {
+  formType: JFORM_TYPES.ATTRIBUTE_SUB_FORM | JFORM_TYPES.EXTERNAL_SUB_FORM
+  isAttributeForm: false
+  isExternalForm: false
+  isSubForm: true
+  isPhoto: false
+  idAttributeName: string
+  attributeValueByName: JAttributeValueByName
+  parentId: JId
+  parentAttributeValueByName: JAttributeValueByName
+}
+
+declare interface JFormPhotoOperation extends JFormOperation {
+  parentId: JId
+  photo: JPhoto
+  isPhoto: true
+}
+
+declare interface JFormSubmitResult {
+  successMessages: string[]
+  errorMessages: string[]
+  operations: JFormOperation[]
+  featureCreation?: {
+    layerId: JId
+    featureId: JId
+    geometry: GeoJSON.Geometry
+    properties: JAttributeValueByName
+  }
+  deletedFeatureIds?: JId[]
+}
+
+declare interface JFormDeleteResult extends JFeatureDeleteByIdsResult {
+  // nothing to add
+}
+
+declare interface JFormErrors {
+  [key: string]: string
+}
+
+declare interface JFormSubmitEventParams extends JFormSubmitResult {
+  // nothing to add
+}
+
+declare interface JFormBeforeSubmitEventParams {
+  layerId: JId
+  formId: JId
+  isAttributeForm: boolean
+  isExternalForm: boolean
+  isSubForm: boolean
+  isCreation: boolean
+  getFormData(): JAttributeValueByName
+  setFormData(attributeValueByName: JAttributeValueByName): void
+  /**
+   * Set only for attribute form creation
+   */
+  getGeometry?(): GeoJSON.Geometry
+  /**
+   * Set only for attribute form creation
+   */
+  setGeometry?(geometry: GeoJSON.Geometry): void
+}
+
+interface JFormDialogEventParams {
+  layerId: JId
+}
+
+declare interface JFormLayerDialogOpenEventParams extends JFormDialogEventParams {
+  attributeForm: JForm
+  externalForms: JForm[]
+}
+
+declare interface JFormLayerDialogCloseEventParams extends JFormDialogEventParams {
+  // nothing to add
+}
+
+declare interface JFormSubFormDialogOpenEventParams extends JFormDialogEventParams {
+  subForm: JForm
+}
+
+declare interface JFormSubFormDialogCloseEventParams extends JFormDialogEventParams {
+  // nothing to add
+}
+
+declare interface JSubFormDataBySubFormId {
+  [subFormId: string]: JSubFormData
+}
+
+declare interface JSubFormData {
+  parentForm: JForm
+  subFormId: JId
+  isLoadingEntries: boolean
+  hasLoadingError: boolean
+  idAttributeName: string
+  subFormEntries: JFormElement[]
+}
+
+declare interface JDeleteEntriesResult {
+  inSuccessLayerElementIds: JId[]
+  inErrorLayerElementIds: JId[]
+}
+
+declare interface JFormSubmitParams {
+  avoidClosePopupOnSuccess?: boolean
+}

package/public/jmap/geocoding.d.ts

@@ -0,0 +1,33 @@
+declare interface JGeocodingOptions {
+    /**
+     * if true, returns all match that would begin with the search string
+     */
+    autoComplete?: boolean
+    /**
+     * if true, proceeds with a fuzzy search (ex: "montan" will match "montain")
+     */
+    fuzzyMatch?: boolean
+    /**
+     * a JLocation object, or null. If not specified, it is by default set to the map's extent center. If you want to disable proximity bias, pass null for this option.
+     */
+    proximity?: JLocation | null | undefined
+}
+
+declare interface JGeocodingResult {
+    id: string
+    location: GeoJSON.Feature<GeoJSON.Point>
+    boundingBox?:GeoJSON.Feature<GeoJSON.Polygon>
+    query: string
+    relevance: number
+    title: string
+    placeName: string
+    attribution: string
+}
+
+declare interface JGeocodingSuccessEventParams {
+    results: JGeocodingResult[]
+}
+
+declare interface JGeocodingErrorEventParams {
+    error: any
+}

package/public/jmap/geometry.d.ts

@@ -0,0 +1,44 @@
+// ALL_GEOMETRY_UNITS in all-enum.ts
+declare const enum JGEOMETRY_UNITS {
+  KILOMETERS = "kilometers",
+  MILES = "miles",
+  DEGREES = "degrees",
+  RADIANS = "radians"
+}
+
+declare interface JBounds {
+  x1: number
+  x2: number
+  y1: number
+  y2: number
+}
+
+declare interface JBoundaryBox {
+  sw: JLocation
+  ne: JLocation
+}
+
+declare interface JLocation {
+  x: number
+  y: number
+}
+
+declare type JPoint = [number, number] | [number, number, number]
+
+declare type JLine = JPoint[]
+
+declare type JPolygon = JPoint[]
+
+declare interface JCircle {
+  center: JLocation
+  /**
+   * With mapbox the radius unit is kilometer
+   */
+  radius: number
+}
+
+declare interface JObjectId {
+  project: string
+  layer: string
+  element: string
+}

package/public/jmap/language.d.ts

@@ -0,0 +1,38 @@
+// ALL_LOCALES in all-enum.ts
+declare const enum JLOCALES {
+  FR = "fr",
+  EN = "en",
+  ES = "es"
+}
+
+declare interface JLocaleTranslation {
+  [key: string]: string
+}
+
+declare interface JTranslationItem {
+  key: string
+  bundleId: string
+}
+
+interface JTranslateParams extends JTranslationItem {
+  params?: (string | number) | Array<string | number>
+  locale?: JLOCALES
+}
+
+declare interface JTranslationsByLocale {
+  [locale: string]: JLocaleTranslation
+}
+
+declare interface JTranslationBundle {
+  id: string
+  translationsByLocale: JTranslationsByLocale
+  defaultLocale?: JLOCALES
+}
+
+declare interface JTranslationBundleById {
+  [bundleId: string]: JTranslationBundle
+}
+
+declare interface JLanguageEventLocaleChangeParams {
+  locale: JLOCALES
+}