refactor: update raster-shared dependency to version 1.7.0 and adjust related types (#110)

* fix: update raster-shared dependency to version 1.7.0 and adjust related types

* fix: update raster-shared dependency to version 1.7.1 and adjust related interfaces

* fix: use optional chaining

* fix: rename estimate function and update callbackURLs to callbackUrlArray

Author: almog8k

package-lock.json

@@ -39,7 +39,7 @@
     "@map-colonies/mc-priority-queue": "^8.2.1",
     "@map-colonies/mc-utils": "^3.2.0",
     "@map-colonies/openapi-express-viewer": "^3.0.0",
-    "@map-colonies/raster-shared": "^1.6.0",
+    "@map-colonies/raster-shared": "^1.7.1",
     "@map-colonies/read-pkg": "0.0.1",
     "@map-colonies/schemas": "v1.3.0",
     "@map-colonies/telemetry": "^7.0.1",

package.json

@@ -3,14 +3,15 @@ import { ICreateJobBody, IJobResponse, OperationStatus } from '@map-colonies/mc-
 import {
   CallbackUrlsTargetArray,
   ExportJobParameters,
-  LinksDefinition,
+  FileNamesTemplates,
   PolygonPartsEntityName,
   RasterProductTypes,
   RoiFeatureCollection,
   TileFormatStrategy,
   TileOutputFormat,
 } from '@map-colonies/raster-shared';
 import { BBox, Geometry } from 'geojson';
+import z from 'zod';
 
 export interface IConfig {
   get: <T>(setting: string) => T;
@@ -72,7 +73,7 @@ export interface IExportInitRequest {
   crs: string;
   roi: RoiFeatureCollection;
   callbackUrls?: CallbackUrlsTargetArray;
-  fileNamesTemplates: LinksDefinition;
+  fileNamesTemplates: FileNamesTemplates;
   relativeDirectoryPath: string;
   catalogId: string;
   priority?: number;

src/common/interfaces.ts

@@ -29,7 +29,7 @@ export const parseFeatureCollection = (featuresCollection: RoiFeatureCollection)
   return parsedGeoRecord;
 };
 
-export const calculateEstimateGpkgSize = (featuresRecords: IGeometryRecord[], tileOutputFormat: TileOutputFormat): number => {
+export const calculateEstimatedGpkgSize = (featuresRecords: IGeometryRecord[], tileOutputFormat: TileOutputFormat): number => {
   const tileEstimatedSize = getTileEstimatedSize(tileOutputFormat);
   const batches: ITileRange[] = [];
   featuresRecords.forEach((record) => {

src/common/utils.ts

@@ -8,19 +8,19 @@ import { feature, featureCollection } from '@turf/helpers';
 import { withSpanAsyncV4, withSpanV4 } from '@map-colonies/telemetry';
 import { IConfig, ICreateExportJobResponse, IExportInitRequest, IGeometryRecord, IJobStatusResponse } from '@src/common/interfaces';
 import { MultiPolygon, Polygon } from 'geojson';
-import { calculateEstimateGpkgSize, parseFeatureCollection } from '@src/common/utils';
+import { calculateEstimatedGpkgSize, parseFeatureCollection } from '@src/common/utils';
 import {
-  LinksDefinition,
   TileFormatStrategy,
   SourceType,
   CallbackExportResponse,
-  CallbackUrls,
   RoiProperties,
   RasterProductTypes,
   RoiFeatureCollection,
   RasterLayerMetadata,
   CORE_VALIDATIONS,
   generateEntityName,
+  CallbackUrl,
+  FileNamesTemplates,
 } from '@map-colonies/raster-shared';
 import { v4 as uuidv4 } from 'uuid';
 import { CreateExportRequest } from '@src/utils/zod/schemas';
@@ -49,7 +49,7 @@ export class ExportManager {
 
   @withSpanAsyncV4
   public async createExport(exportRequest: CreateExportRequest): Promise<ICreateExportJobResponse | CallbackExportResponse> {
-    const { dbId: catalogId, crs, priority, callbackURLs, description } = exportRequest;
+    const { dbId: catalogId, crs, priority, callbackUrlArray, description } = exportRequest;
     const layerMetadata = await this.validationManager.findLayer(catalogId);
 
     let roi = exportRequest.roi;
@@ -61,7 +61,13 @@ export class ExportManager {
 
     const { productId, productVersion: version, maxResolutionDeg: srcRes } = layerMetadata;
     const productType = layerMetadata.productType as RasterProductTypes;
-    const callbacks = callbackURLs ? callbackURLs.map((url) => <CallbackUrls>{ url }) : undefined;
+    const callbackUrls = callbackUrlArray?.map(
+      (url) =>
+        <CallbackUrl>{
+          url,
+        }
+    );
+
     const maxZoom = degreesPerPixelToZoomLevel(srcRes);
 
     // ROI vs layer validation section - zoom + geo intersection
@@ -72,34 +78,34 @@ export class ExportManager {
       srcRes
     );
 
-    const duplicationExist = await this.findJobDuplications(productId, version, catalogId, roi, crs ?? DEFAULT_CRS, callbacks);
+    const duplicationExist = await this.findJobDuplications(productId, version, catalogId, roi, crs ?? DEFAULT_CRS, callbackUrls);
     if (duplicationExist) {
       return duplicationExist;
     }
 
-    const estimatesGpkgSize = calculateEstimateGpkgSize(featuresRecords, layerMetadata.tileOutputFormat);
-    await this.validationManager.validateFreeSpace(estimatesGpkgSize, this.gpkgsLocation);
+    const gpkgEstimatedSize = calculateEstimatedGpkgSize(featuresRecords, layerMetadata.tileOutputFormat);
+    await this.validationManager.validateFreeSpace(gpkgEstimatedSize, this.gpkgsLocation);
 
     //creation of params
     const computedAttributes = this.computeFilePathAttributes(productType, productId, version, featuresRecords);
     const polygonPartsEntityName = generateEntityName(productId, productType);
 
     const exportInitRequest: IExportInitRequest = {
       crs: crs ?? DEFAULT_CRS,
-      roi: roi,
-      callbackUrls: callbacks,
+      roi,
+      callbackUrls,
       fileNamesTemplates: computedAttributes.fileNamesTemplates,
       relativeDirectoryPath: computedAttributes.additionalIdentifiers,
       packageRelativePath: computedAttributes.packageRelativePath,
       catalogId,
-      version: version,
+      version,
       productId,
       productType,
       priority: priority ?? DEFAULT_PRIORITY,
       description,
       targetFormat: layerMetadata.tileOutputFormat,
       outputFormatStrategy: TileFormatStrategy.MIXED,
-      gpkgEstimatedSize: estimatesGpkgSize,
+      gpkgEstimatedSize,
       jobTrackerUrl: this.jobTrackerUrl,
       polygonPartsEntityName,
     };
@@ -126,9 +132,9 @@ export class ExportManager {
     catalogId: string,
     roi: RoiFeatureCollection,
     crs: string,
-    callbacks?: CallbackUrls[]
+    callbackUrls?: CallbackUrl[]
   ): Promise<CallbackExportResponse | ICreateExportJobResponse | undefined> {
-    const duplicationExist = await this.validationManager.checkForExportDuplicate(productId, version, catalogId, roi, crs, callbacks);
+    const duplicationExist = await this.validationManager.checkForExportDuplicate(productId, version, catalogId, roi, crs, callbackUrls);
 
     if (duplicationExist && duplicationExist.status === OperationStatus.COMPLETED) {
       const callbackParam = duplicationExist as CallbackExportResponse;
@@ -174,11 +180,11 @@ export class ExportManager {
     productId: string,
     version: string,
     featuresRecords: IGeometryRecord[]
-  ): { fileNamesTemplates: LinksDefinition; additionalIdentifiers: string; packageRelativePath: string } {
+  ): { fileNamesTemplates: FileNamesTemplates; additionalIdentifiers: string; packageRelativePath: string } {
     const prefixPackageName = this.generateExportFileNames(productType, productId, version, featuresRecords);
     const packageName = `${prefixPackageName}.gpkg`;
-    const fileNamesTemplates: LinksDefinition = {
-      dataURI: packageName,
+    const fileNamesTemplates = {
+      packageName,
     };
     const additionalIdentifiers = uuidv4();
     const separator = this.getSeparator();

src/export/models/exportManager.ts

@@ -1,12 +1,12 @@
-import { roiFeatureCollectionSchema } from '@map-colonies/raster-shared';
+import { callbackUrlSchema, roiFeatureCollectionSchema } from '@map-colonies/raster-shared';
 import z from 'zod';
 
 export const createExportRequestSchema = z.object({
   dbId: z.string(),
   crs: z.string().optional(),
   priority: z.number().optional(),
   roi: roiFeatureCollectionSchema.optional(),
-  callbackURLs: z.array(z.string()).optional(),
+  callbackUrlArray: callbackUrlSchema.shape.url.array().optional(),
   description: z.string().optional(),
 });
 

src/utils/zod/schemas.ts

@@ -131,7 +131,7 @@ export const createExportData: IExportInitRequest = {
     },
   ],
   fileNamesTemplates: {
-    dataURI: 'Orthophoto_SOME_NAME_1_0_0_2025_01_06T09_29_04_933Z.gpkg',
+    packageName: 'Orthophoto_SOME_NAME_1_0_0_2025_01_06T09_29_04_933Z.gpkg',
   },
   relativeDirectoryPath: 'e315e6d204d92b1d2dbfdaab96ff2a7e',
   packageRelativePath: 'e315e6d204d92b1d2dbfdaab96ff2a7e/Orthophoto_SOME_NAME_1_0_0_2025_01_06T09_29_04_933Z.gpkg',
@@ -233,7 +233,7 @@ export const initExportRequestBody = {
     },
     additionalParams: {
       fileNamesTemplates: {
-        dataURI: 'Orthophoto_SOME_NAME_1_0_0_2025_01_09T10_04_06_711Z.gpkg',
+        packageName: 'Orthophoto_SOME_NAME_1_0_0_2025_01_09T10_04_06_711Z.gpkg',
       },
       relativeDirectoryPath: '63baedae-cb5b-4c0a-a7db-8eb6b9105cb7',
       packageRelativePath: '63baedae-cb5b-4c0a-a7db-8eb6b9105cb7/Orthophoto_SOME_NAME_1_0_0_2025_01_09T10_04_06_711Z.gpkg',
@@ -318,7 +318,7 @@ export const initExportRequestBodyNoRoiWithCallback = {
     },
     additionalParams: {
       fileNamesTemplates: {
-        dataURI: 'Orthophoto_SOME_NAME_1_0_0_2025_01_09T12_39_36_961Z.gpkg',
+        packageName: 'Orthophoto_SOME_NAME_1_0_0_2025_01_09T12_39_36_961Z.gpkg',
       },
       relativeDirectoryPath: 'b30e5a99b78a6c10e65164fd54b14ad0',
       packageRelativePath: 'b30e5a99b78a6c10e65164fd54b14ad0/Orthophoto_SOME_NAME_1_0_0_2025_01_09T12_39_36_961Z.gpkg',
@@ -600,18 +600,18 @@ export const createExportRequestWithoutCallback: CreateExportRequest = {
 
 export const createExportRequestNoRoiWithCallback: CreateExportRequest = {
   dbId: catalogId,
-  callbackURLs: ['http://callback1'],
+  callbackUrlArray: ['http://callback1'],
 };
 
 export const createExportRequestWithRoiAndCallback: CreateExportRequest = {
   dbId: catalogId,
-  callbackURLs: ['http://example.getmap.com/callback', 'http://example.getmap.com/callback2'],
+  callbackUrlArray: ['http://example.getmap.com/callback', 'http://example.getmap.com/callback2'],
   roi: defaultRoi,
 };
 
 export const createExportRequestWithRoiAndNewCallback: CreateExportRequest = {
   dbId: catalogId,
-  callbackURLs: ['http://example.getmap.com/callback3'],
+  callbackUrlArray: ['http://example.getmap.com/callback3'],
   roi: defaultRoi,
 };
 

tests/mocks/data.ts

@@ -62,7 +62,7 @@ export const inProgressJobsResponse = [
     parameters: {
       additionalParams: {
         fileNamesTemplates: {
-          dataURI: 'Orthophoto_SOME_NAME_1_0_0_2025_01_02T12_00_02_621Z.gpkg',
+          packageName: 'Orthophoto_SOME_NAME_1_0_0_2025_01_02T12_00_02_621Z.gpkg',
         },
         packageRelativePath: '63baedae-cb5b-4c0a-a7db-8eb6b9105cb7/Orthophoto_SOME_NAME_1_0_0_2025_01_02T12_00_02_621Z.gpkg',
         relativeDirectoryPath: '63baedae-cb5b-4c0a-a7db-8eb6b9105cb7',
@@ -158,7 +158,7 @@ export const inProgressJobsResponse = [
     parameters: {
       additionalParams: {
         fileNamesTemplates: {
-          dataURI: 'Orthophoto_SOME_NAME_1_0_0_2025_01_05T09_37_40_928Z.gpkg',
+          packageName: 'Orthophoto_SOME_NAME_1_0_0_2025_01_05T09_37_40_928Z.gpkg',
         },
         packageRelativePath: '65adbc306ad555ca82ca12df9153dee1/Orthophoto_SOME_NAME_1_0_0_2025_01_05T09_37_40_928Z.gpkg',
         relativeDirectoryPath: '65adbc306ad555ca82ca12df9153dee1',

tests/mocks/processingRequest.ts

@@ -51,7 +51,7 @@ describe('SchemasValidations', () => {
   });
 
   it('should throw an error if callbackURLs is not an array of strings', () => {
-    expect(() => createExportRequestSchema.parse({ ...validUserExportRequest, callbackURLs: [123] })).toThrow();
+    expect(() => createExportRequestSchema.parse({ ...validUserExportRequest, callbackUrlArray: [123] })).toThrow();
   });
 
   it('should throw an error if priority is not a number', () => {