feat: callback schemas and types

src/schemas/core/callback.schema.ts

@@ -0,0 +1,32 @@
+import z from 'zod';
+import { OperationStatus } from '@map-colonies/mc-priority-queue';
+import { rasterProductTypeSchema, resourceIdSchema, versionSchema } from './job.schema';
+
+export const callbackUrlSchema = z.string().url();
+
+export const callbackUrlsArraySchema = z.array(callbackUrlSchema);
+
+export const fileMetadataSchema = z.object({
+  name: z.string(),
+  url: callbackUrlSchema,
+  size: z.number(),
+});
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export const createCallbackResponseSchema = <T>(dataSchema?: z.ZodType<T>) => {
+  return z.object({
+    jobId: z.string().uuid(),
+    taskId: z.string().uuid(),
+    jobType: z.string(),
+    taskType: z.string(),
+    productId: resourceIdSchema,
+    productType: rasterProductTypeSchema,
+    version: versionSchema,
+    status: z.nativeEnum(OperationStatus),
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+    progress: z.number().min(0).max(100).optional(),
+    message: z.string().optional(),
+    error: z.string().optional(),
+    data: dataSchema ?? z.unknown(),
+  });
+};

src/schemas/core/index.ts

@@ -3,4 +3,4 @@ export * from './job.schema';
 export * from './task.schema';
 export * from './mime.schema';
 export * from './aggregation.schema';
-export * from './callbackUrl.schema';
+export * from './callback.schema';

src/schemas/export/job.schema.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { CORE_VALIDATIONS, TileFormatStrategy, TileOutputFormat } from '../../constants';
 import { polygonPartsEntityNameSchema } from '../ingestion';
-import { callbackUrlsArraySchema } from '../core/callbackUrl.schema';
+import { callbackUrlsArraySchema } from '../core/callback.schema';
 import { callbackExportResponseSchema, cleanupDataSchema, roiFeatureCollectionSchema, fileNamesTemplatesSchema } from './export.schema';
 
 export const exportInputParamsSchema = z.object({

src/schemas/ingestion/callback.schema.ts

@@ -0,0 +1,14 @@
+import z from 'zod';
+import { fileMetadataSchema } from '../core';
+
+//#region Validation
+
+export const validationTaskCallbackDataSchema = z
+  .object({
+    isValid: z.boolean(),
+    sourceName: z.string(),
+    links: fileMetadataSchema.array().optional(),
+  })
+  .describe('validationTaskCallbackDataSchema');
+
+//#endregion Validation

src/schemas/ingestion/index.ts

@@ -5,3 +5,4 @@ export * from './polygonParts.schema';
 export * from './job.schema';
 export * from './task.schema';
 export * from './layerNameFormats.schema';
+export * from './callback.schema';

src/schemas/ingestion/job.schema.ts

@@ -1,6 +1,6 @@
 import z from 'zod';
 import { CORE_VALIDATIONS } from '../../constants';
-import { callbackUrlsArraySchema } from '../core/callbackUrl.schema';
+import { callbackUrlsArraySchema } from '../core/callback.schema';
 import { newAdditionalParamsSchema, swapUpdateAdditionalParamsSchema, updateAdditionalParamsSchema } from './additionalParams.schema';
 import { inputFilesSchema } from './inputFiles.schema';
 import { newRasterLayerMetadataSchema, updateRasterLayerMetadataSchema } from './metadata.schema';

src/types/core/callback.type.ts

@@ -0,0 +1,4 @@
+import z from 'zod';
+import { createCallbackResponseSchema } from '../../schemas';
+
+export type CallbackResponse<T> = z.infer<ReturnType<typeof createCallbackResponseSchema<T>>>;

src/types/export/export.type.ts

@@ -10,7 +10,7 @@ import {
   linksSchema,
   roiPropertiesSchema,
 } from '../../schemas/export/export.schema';
-import { callbackUrlsArraySchema, callbackUrlSchema } from '../../schemas/core/callbackUrl.schema';
+import { callbackUrlsArraySchema, callbackUrlSchema } from '../../schemas/core/callback.schema';
 
 export type RoiProperties = z.infer<typeof roiPropertiesSchema>;
 export type RoiFeature = Feature<Polygon | MultiPolygon, RoiProperties>;

src/types/ingestion/callback.type.ts

@@ -0,0 +1,4 @@
+import z from 'zod';
+import { validationTaskCallbackDataSchema } from '../../schemas/ingestion/callback.schema';
+
+export type ValidationCallbackData = z.infer<typeof validationTaskCallbackDataSchema>;

src/types/ingestion/index.ts

@@ -3,3 +3,4 @@ export * from './job.type';
 export * from './task.type';
 export * from './polygonParts.type';
 export * from './report.type';
+export * from './callback.type';