jmapcloud-ng-core-types 1.1.15 → 1.1.18

package/index.ts

@@ -1,4 +1,5 @@
 import { Feature, FeatureCollection, LineString, MultiLineString, Point, Polygon } from "geojson"
+import { JForm as JFormJMC } from "jmapcloud-types"
 import { Store } from "redux"
 
 export interface JCoreService extends JCoreMainService {
@@ -12,13 +13,13 @@ export interface JCoreService extends JCoreMainService {
   Geolocation: JGeolocationService
   Geometry: JGeometryService
   MouseOver: JMouseOverService
+  Attachment: JAttachmentService
   Form: JFormService
   FormJMC: JFormJMCService
   Event: JEventService
   History: JHistoryService
   Extension: JExtensionService
   Server: JServerService
-  Photo: JPhotoService
   Util: JUtilService
   Library: JLibraryService
   Projection: JProjectionService
@@ -138,13 +139,6 @@ export interface JLocalStorageService {
   remove(key: string): void
 }
 
-export interface JPhotoService {
-  displayFeaturePhotosPopup(layerId: JId, featureId: JId): Promise<void>
-  displayPhotosPopup(photos: JPhoto[], params?: JPhotoOpenPopupParams): void
-  downloadById(photoId: JId): Promise<void>
-  closePhotoPopup(): void
-}
-
 export interface JFeatureService {
   getById(layerId: JId, featureId: JId, includeAllAttributes?: boolean): Promise<GeoJSON.Feature>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
@@ -198,7 +192,6 @@ export interface JEventService {
   Map: JMapEventModule
   Geocoding: JGeocodingEventModule
   SimpleSearch: JSimpleSearchEventModule
-  Photo: JPhotoEventModule
   Project: JProjectEventModule
   User: JUserEventModule
   Feature: JFeatureEventModule
@@ -350,12 +343,6 @@ export interface JMapEventModule extends JEventModule {
   }
 }
 
-export interface JPhotoEventModule extends JEventModule {
-  on: {
-    containerCreated(listenerId: string, fn: (params: JPhotoEventContainerCreatedParams) => void): void
-  }
-}
-
 export interface JFeatureEventModule extends JEventModule {
   on: {
     deletion(listenerId: string, fn: (params: JFeatureEventDeleteParams) => void): void
@@ -395,7 +382,6 @@ export interface JCoreState {
   table: JTableState
   user: JUserState
   language: JLanguageState
-  photo: JPhotoState
   geocoding: JGeocodingState
   simpleSearch: JSimpleSearchState
   geolocation: JGeolocationState
@@ -525,15 +511,6 @@ export interface JTableState {
   tables: JTable[]
 }
 
-export interface JPhotoState {
-  selectedPhotoId: JId | undefined
-  photos: JPhoto[]
-  isPopupOpened: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-  isDownloading: boolean
-}
-
 export interface JUserState extends JTokenInfo {
   isAnonymous: boolean
   anonymousOrganizationId: string
@@ -569,6 +546,16 @@ export interface JFormJMCService {
   getForm(dataSourceId: string): Promise<JFormJMC | null>
 }
 
+export interface JAttachmentService {
+  getByItemId(dataSourceId: JId, itemId: JId): Promise<JAttachment[]>
+  create(dataSourceId: string, params: JCreateAttachmentParams): Promise<string>
+  remove(dataSourceId: string, attachmentId: string): Promise<string>
+  update(dataSourceId: string, attachmentId: string, params: JUpdateAttachmentParams): Promise<string>
+  download(dataSourceId: string, attachmentId: string): Promise<{ data: Blob; headers: any }>
+  downloadToDevice(attachment: JAttachmentFile, dataSourceId: string): Promise<void>
+  previewAttachments(attachment: JAttachmentFile, dataSourceId: string): Promise<void>
+}
+
 export interface JFormService {
   // REPO METHODS
   getFormsMetaDataByLayerId(layerId: JId): Promise<JFormMetaData[]>
@@ -898,7 +885,7 @@ export interface JTableService {
   getTables(): JTable[]
   getTableData(tableId: JId, params: JTableDataParams): Promise<JTableData>
   getById(tableId: JId): JTable
-  createRow(tableId: JId, row: { [key: string]: any }): Promise<void>
+  createRow(tableId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: Array<any> }>
   updateRow(tableId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
   deleteRow(tableId: JId, rowId: number): Promise<void>
   getDataSourceAttributes(tableId: JId): Promise<JDataSourceAttribute[]>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.1.15",
+  "version": "1.1.18",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
@@ -31,6 +31,7 @@
     "@auth0/auth0-spa-js": "^2.1.3",
     "@types/geojson": "^7946.0.14",
     "geojson": "^0.5.0",
+    "jmapcloud-types": "../../../packages/jmapcloud-types",
     "maplibre-gl": "^4.7.1",
     "redux": "^5.0.1"
   }

package/public/core.d.ts

@@ -201,68 +201,6 @@ declare namespace JMap {
     function getAllIdentityProvidersById(): JServerIdentityProviderById
   }
 
-  /* **JMap.Photo**
-   *
-   * This is where you can find JMap photo relative methods
-   */
-  namespace Photo {
-    /**
-     * **JMap.Photo.displayFeaturePhotosPopup**
-     *
-     * Display the photos of a given feature of a given layer.
-     *
-     * @param layerId the JMap layer id
-     * @param featureId the JMap feature id
-     * @example
-     * ```ts
-     * // Display the photos of feature id="345" in layer id="4"
-     * JMap.Photo.displayFeaturePhotosPopup(4, 345)
-     * ```
-     */
-    function displayFeaturePhotosPopup(layerId: JId, featureId: JId): Promise<void>
-
-    /**
-     * **JMap.Photo.displayPhotosPopup**
-     *
-     * Display your custom photos.
-     *
-     * @param photos your custom photos
-     * @param params optional parameters
-     * @example
-     * ```ts
-     * // Display the photos of feature id="345" in layer id="4"
-     * JMap.Photo.displayPhotosPopup(4, 345)
-     * ```
-     */
-    function displayPhotosPopup(photos: JPhoto[], params?: JPhotoOpenPopupParams): void
-
-    /**
-     * **JMap.Photo.closePhotoPopup**
-     *
-     * If displayed, close the photo popup
-     *
-     * @example
-     * ```ts
-     * // Close the photo popup
-     * JMap.Photo.closePhotoPopup()
-     * ```
-     */
-    function closePhotoPopup(): void
-
-    /**
-     * **JMap.Photo.downloadById**
-     *
-     * Triggers a file download for a given photo id.
-     *
-     * @example
-     * ```ts
-     * // download photo id="3"
-     * JMap.Photo.downloadById(3)
-     * ```
-     */
-    function downloadById(photoId: JId): Promise<void>
-  }
-
   /**
    * **JMap.Geocoding**
    *
@@ -10010,6 +9948,177 @@ declare namespace JMap {
      */
     function getForm(dataSourceId: JId): Promise<JFormJMC | null>
   }
+
+  /**
+   * **JMap.Attachment**
+   *
+   * Here you'll find all attachment related methods
+   */
+  namespace Attachment {
+    /**
+     * ***JMap.Attachment.getByItemId***
+     *
+     * Fetches every attachment linked to a specific **item** (row) of a data source.
+     *
+     * @param dataSourceId the data source identifier that contains the item
+     * @param itemId the identifier of the item whose attachments you want
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .getByItemId("f47ac10b-58cc-4372-a567-0e02b2c3d479", 7088)
+     *  .then(attachments => console.log("Attachments found:", attachments.length))
+     *  .catch(error => console.error("An error occurred while fetching attachments", error))
+     * ```
+     */
+    function getByItemId(dataSourceId: JId, itemId: JId): Promise<JAttachment[]>
+
+    /**
+     * ***JMap.Attachment.create***
+     *
+     * Creates a new attachment for a data source item. The payload can represent either a file upload (`file`) or a URL attachment (`url`).
+     *
+     * @param dataSourceId the data source identifier that will receive the attachment
+     * @param params see {@link JCreateAttachmentParams} (includes the `itemId`)
+     * @example
+     * ```ts
+     * // Upload a file attachment
+     * JMap.Attachment
+     *  .create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
+     *    itemId: 7088,
+     *    subject: "Site photo",
+     *    description: "Photo taken during inspection",
+     *    file: new File([blob], "inspection.jpg", { type: "image/jpeg" })
+     *  })
+     *  .then(id => console.log("Attachment created with id", id))
+     *  .catch(error => console.error("Attachment creation failed", error))
+     *
+     * // Add a URL attachment
+     * JMap.Attachment
+     *  .create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
+     *    itemId: 7088,
+     *    subject: "External link",
+     *    url: "https://example.com/report"
+     *  })
+     *  .then(id => console.log("Attachment created with id", id))
+     *  .catch(error => console.error("Attachment creation failed", error))
+     * ```
+     */
+    function create(dataSourceId: string, params: JCreateAttachmentParams): Promise<string>
+
+    /**
+     * ***JMap.Attachment.remove***
+     *
+     * Deletes an attachment previously created on a data source.
+     *
+     * @param dataSourceId the JMap data source id
+     * @param attachmentId the attachment identifier to remove
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .remove("f47ac10b-58cc-4372-a567-0e02b2c3d479", "d9428888-122b-11e1-b85c-61cd3cbb3210")
+     *  .then(() => console.log("Attachment removed"))
+     *  .catch(error => console.error("Failed to remove attachment", error))
+     * ```
+     */
+    function remove(dataSourceId: string, attachmentId: string): Promise<string>
+
+    /**
+     * ***JMap.Attachment.update***
+     *
+     * Updates the metadata (subject, description, URL) of an existing attachment.
+     *
+     * @param dataSourceId the JMap data source id
+     * @param attachmentId the attachment identifier to update
+     * @param params partial attachment payload containing the new values
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .update(
+     *    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+     *    "d9428888-122b-11e1-b85c-61cd3cbb3210",
+     *    { subject: "Updated subject", description: "New details" }
+     *  )
+     *  .then(() => console.log("Attachment updated"))
+     *  .catch(error => console.error("Failed to update attachment", error))
+     * ```
+     */
+    function update(dataSourceId: string, attachmentId: string, params: JUpdateAttachmentParams): Promise<string>
+    /**
+     * ***JMap.Attachment.download***
+     *
+     * Downloads an attachment and returns the raw binary data plus the HTTP headers sent by the server.
+     *
+     * @param dataSourceId the JMap data source id
+     * @param attachmentId the attachment to download
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .download("f47ac10b-58cc-4372-a567-0e02b2c3d479", "d9428888-122b-11e1-b85c-61cd3cbb3210")
+     *  .then(({ data, headers }) => console.log("Downloaded attachment", headers["content-type"], data.size))
+     *  .catch(error => console.error("Download failed", error))
+     * ```
+     */
+    function download(dataSourceId: string, attachmentId: string): Promise<{ data: Blob; headers: any }>
+
+    /**
+     * ***JMap.Attachment.downloadToDevice***
+     *
+     * Triggers a browser download for the provided file attachment.
+     *
+     * @param attachment the attachment to download 
+     * @param dataSourceId the JMap data source id
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .downloadToDevice(
+     *    {
+     *      id: "d9428888-122b-11e1-b85c-61cd3cbb3210",
+     *      organizationId: "c56a4180-65aa-42ec-a945-5fd21dec0538",
+     *      thumbnail: "",
+     *      fileId: "c56a4180-65aa-42ec-a945-5fd21dec0538",
+     *      fileName: "inspection.jpg",
+     *      fileSize: 481516,
+     *      mimeType: "image/jpeg"
+     *    },
+     *    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+     *  )
+     *  .then(() => console.log("Download started"))
+     *  .catch(error => console.error("Download failed", error))
+     * ```
+     */
+    function downloadToDevice(attachment: JAttachmentFile, dataSourceId: string): Promise<void>
+
+    /**
+     * ***JMap.Attachment.previewAttachments***
+     *
+     * Opens a client-side preview modal for the provided file attachment.
+     *
+     * The preview currently supports standard images and 360° panoramas; other file types will fall back to a download message.
+     *
+     * @param attachment the attachment to download
+     * @param dataSourceId the JMap data source id
+     * @example
+     * ```ts
+     * JMap.Attachment
+     *  .previewAttachments(
+     *    {
+     *      id: "c56a4180-65aa-42ec-a945-5fd21dec0538",
+     *      organizationId: "c56a4180-65aa-42ec-a945-5fd21dec0538",
+     *      thumbnail: "",
+     *      fileId: "d9428888-122b-11e1-b85c-61cd3cbb3210",
+     *      fileName: "panorama.jpg",
+     *      fileSize: 8675309,
+     *      mimeType: "image/jpeg"
+     *    },
+     *    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+     *  )
+     *  .then(() => console.log("Preview opened"))
+     *  .catch(error => console.error("Preview failed", error))
+     * ```
+     */
+    function previewAttachments(attachment: JAttachmentFile, dataSourceId: string): Promise<void>
+  }
+
   /**
    * **JMap.Form**
    *
@@ -12454,7 +12563,7 @@ declare namespace JMap {
   }
   namespace Table {
     /**
-     * **JMap.Layer.getTables**
+     * **JMap.Table.getTables**
      *
      * Returns an array of JMap tables available in the current project.
      *
@@ -12465,7 +12574,7 @@ declare namespace JMap {
      * @example
      * ```ts
      * // Retrieves all JMap tables
-     * JMap.Layer.getTables();
+     * JMap.Table.getTables();
      * ```
      */
     function getTables(): JTable[]
@@ -12521,7 +12630,7 @@ declare namespace JMap {
      * @param {JId} tableId - The Id of the table.
      * @param {{ [key: string]: any }} row - the data of the row to be updated.
      *
-     * @returns {Promise<void>}
+     * @returns {Promise<{ id: JId, links: Array<any> }>} id -the id of the created row
      *
      * @example
      * ```ts
@@ -12529,7 +12638,7 @@ declare namespace JMap {
      * JMap.Table.createRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", {city: "Montreal", country: "Canada"});
      * ```
      */
-    function createRow(tableId: JId, row: { [key: string]: any }): Promise<void>
+    function createRow(tableId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: Array<any> }>
 
     /**
      * **JMap.Table.updateRow**

package/public/jmap/ajax.d.ts

@@ -28,4 +28,9 @@ declare interface JRequestConfig {
    * To specify custom headers (Authorization, Content-type, etc) that you might want to use for external ressources.
    */
   headers?: { [key: string]: any }
+
+  /**
+   * Allow callers to request raw data (blob, arraybuffer, etc).
+   */
+  responseType?: "arraybuffer" | "document" | "json" | "text" | "stream" | "blob"
 }

package/public/jmap/attachment.d.ts

@@ -0,0 +1,37 @@
+declare interface JAttachmentBase {
+  id: string
+  organizationId: string
+  subject?: string
+  description?: string
+  thumbnail: string
+  // type: "url" | "file" | "image"  // TODO
+}
+
+declare interface JAttachmentFile extends JAttachmentBase {
+  fileName: string
+  fileSize: number
+  fileId: string
+  mimeType: string
+}
+
+declare interface JAttachmentUrl extends JAttachmentBase {
+  url: string
+}
+
+declare type JAttachment = JAttachmentUrl | JAttachmentFile
+
+declare type JCreateAttachmentUrlParams = {
+  itemId: number
+} & Pick<JAttachmentUrl, "subject" | "description" | "url">
+
+declare type JCreateAttachmentFileParams = {
+  itemId: number
+} & Pick<JAttachmentFile, "subject" | "description"> & {
+    file: File
+  }
+
+declare type JCreateAttachmentParams = JCreateAttachmentFileParams | JCreateAttachmentUrlParams
+
+declare type JUpdateAttachmentParams = Partial<
+  Pick<JAttachmentUrl, "subject" | "description" | "url"> | Pick<JAttachmentFile, "subject" | "description">
+>

package/public/jmap/formJMC.d.ts

@@ -31,7 +31,7 @@ declare const enum FORMSCHEMA_TYPES {
 
 declare interface JFormJMC {
   id: string
-  name: any
+  name: JLocaleTranslation
   createdBy: string
   creationDate: Date
   lastModifiedBy: string

package/public/jmap/layer.d.ts

@@ -318,7 +318,7 @@ declare interface JLayer extends JLayerTreeElement {
   selectionStyleId: string
   dynamicFilter: JDynamicFilter
   allowClientSideEditing: boolean
-  filter: string
+  baseFilter?: import("jmapcloud-types").JAnyFilterCondition
 }
 
 declare interface JLayerInformationReport {
@@ -629,8 +629,12 @@ declare enum ATTRIBUTE_TYPES {
   BOOLEAN = "BOOLEAN"
 }
 
-declare interface JValueDomain {
-  value?: any
-  nullValue?: boolean
-  title: JLocaleTranslation
-}
+declare type JValueDomain =
+  | {
+      value: string | number
+      title: JLocaleTranslation
+    }
+  | {
+      nullValue: true
+      title: JLocaleTranslation
+    }

package/public/jmap/table.d.ts

@@ -24,6 +24,7 @@ declare interface JTable {
   dataSourceId: string
   allowClientSideEditing: boolean
   permissions: JTablePermissions
+  baseFilter?: import("jmapcloud-types").JAnyFilterCondition
 }
 
 declare interface JTableAttribute {
@@ -45,7 +46,7 @@ declare interface JTableData {
 declare interface JTableDataParams {
   startIndex?: number
   limit?: number
-  filter?: string
+  filter?: import("jmapcloud-types").JAnyFilterCondition
   sort?: string
 }