@deepintel-ltd/farmpro-contracts 1.16.3 → 1.16.5

package/dist/schemas/terrain-profile.schemas.d.ts

@@ -0,0 +1,394 @@
+import { z } from 'zod';
+/** Risk levels shared by terrain consumers (planner, Farm Brain, irrigation). */
+export declare const terrainRiskLevelSchema: z.ZodEnum<["low", "medium", "high"]>;
+export type TerrainRiskLevel = z.infer<typeof terrainRiskLevelSchema>;
+export declare const wetnessClassSchema: z.ZodEnum<["low", "moderate", "high"]>;
+export type WetnessClass = z.infer<typeof wetnessClassSchema>;
+export declare const terrainSlopeClassSchema: z.ZodEnum<["flat", "gentle", "moderate", "steep"]>;
+export type SlopeClass = z.infer<typeof terrainSlopeClassSchema>;
+export declare const machineryAccessSchema: z.ZodEnum<["good", "limited", "poor"]>;
+export type MachineryAccess = z.infer<typeof machineryAccessSchema>;
+/**
+ * Stable field-scoped terrain summary. Any module may consume this without
+ * calling DEM APIs directly.
+ */
+export declare const fieldTerrainProfileSchema: z.ZodObject<{
+    fieldId: z.ZodString;
+    farmId: z.ZodOptional<z.ZodString>;
+    source: z.ZodString;
+    resolutionM: z.ZodNumber;
+    sampledAt: z.ZodString;
+    interpolated: z.ZodDefault<z.ZodBoolean>;
+    trustNote: z.ZodString;
+    elevation: z.ZodObject<{
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+        mean: z.ZodNumber;
+        range: z.ZodNumber;
+        unit: z.ZodLiteral<"meters">;
+    }, "strip", z.ZodTypeAny, {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    }, {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    }>;
+    slope: z.ZodObject<{
+        medianPct: z.ZodNumber;
+        meanPct: z.ZodNumber;
+        maxPct: z.ZodNumber;
+        percentByClass: z.ZodObject<{
+            flat: z.ZodNumber;
+            gentle: z.ZodNumber;
+            moderate: z.ZodNumber;
+            steep: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        }, {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    }, {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    }>;
+    aspect: z.ZodObject<{
+        dominant: z.ZodString;
+        flatPercent: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        flatPercent: number;
+        dominant: string;
+    }, {
+        flatPercent: number;
+        dominant: string;
+    }>;
+    hydrology: z.ZodObject<{
+        wetnessClass: z.ZodEnum<["low", "moderate", "high"]>;
+        lowPointCount: z.ZodNumber;
+        dominantFlowDirection: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    }, {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    }>;
+    risks: z.ZodObject<{
+        waterloggingRisk: z.ZodEnum<["low", "medium", "high"]>;
+        erosionRisk: z.ZodEnum<["low", "medium", "high"]>;
+        machineryAccess: z.ZodEnum<["good", "limited", "poor"]>;
+    }, "strip", z.ZodTypeAny, {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    }, {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    }>;
+    /** Short bullets for UI / Farm Brain */
+    insights: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    source: string;
+    fieldId: string;
+    risks: {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    };
+    elevation: {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    };
+    resolutionM: number;
+    interpolated: boolean;
+    trustNote: string;
+    slope: {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    };
+    sampledAt: string;
+    aspect: {
+        flatPercent: number;
+        dominant: string;
+    };
+    hydrology: {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    };
+    insights: string[];
+    farmId?: string | undefined;
+}, {
+    source: string;
+    fieldId: string;
+    risks: {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    };
+    elevation: {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    };
+    resolutionM: number;
+    trustNote: string;
+    slope: {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    };
+    sampledAt: string;
+    aspect: {
+        flatPercent: number;
+        dominant: string;
+    };
+    hydrology: {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    };
+    insights: string[];
+    farmId?: string | undefined;
+    interpolated?: boolean | undefined;
+}>;
+export type FieldTerrainProfile = z.infer<typeof fieldTerrainProfileSchema>;
+export declare const fieldTerrainProfileResponseSchema: z.ZodObject<{
+    fieldId: z.ZodString;
+    farmId: z.ZodOptional<z.ZodString>;
+    source: z.ZodString;
+    resolutionM: z.ZodNumber;
+    sampledAt: z.ZodString;
+    interpolated: z.ZodDefault<z.ZodBoolean>;
+    trustNote: z.ZodString;
+    elevation: z.ZodObject<{
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+        mean: z.ZodNumber;
+        range: z.ZodNumber;
+        unit: z.ZodLiteral<"meters">;
+    }, "strip", z.ZodTypeAny, {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    }, {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    }>;
+    slope: z.ZodObject<{
+        medianPct: z.ZodNumber;
+        meanPct: z.ZodNumber;
+        maxPct: z.ZodNumber;
+        percentByClass: z.ZodObject<{
+            flat: z.ZodNumber;
+            gentle: z.ZodNumber;
+            moderate: z.ZodNumber;
+            steep: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        }, {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    }, {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    }>;
+    aspect: z.ZodObject<{
+        dominant: z.ZodString;
+        flatPercent: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        flatPercent: number;
+        dominant: string;
+    }, {
+        flatPercent: number;
+        dominant: string;
+    }>;
+    hydrology: z.ZodObject<{
+        wetnessClass: z.ZodEnum<["low", "moderate", "high"]>;
+        lowPointCount: z.ZodNumber;
+        dominantFlowDirection: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    }, {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    }>;
+    risks: z.ZodObject<{
+        waterloggingRisk: z.ZodEnum<["low", "medium", "high"]>;
+        erosionRisk: z.ZodEnum<["low", "medium", "high"]>;
+        machineryAccess: z.ZodEnum<["good", "limited", "poor"]>;
+    }, "strip", z.ZodTypeAny, {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    }, {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    }>;
+    /** Short bullets for UI / Farm Brain */
+    insights: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    source: string;
+    fieldId: string;
+    risks: {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    };
+    elevation: {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    };
+    resolutionM: number;
+    interpolated: boolean;
+    trustNote: string;
+    slope: {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    };
+    sampledAt: string;
+    aspect: {
+        flatPercent: number;
+        dominant: string;
+    };
+    hydrology: {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    };
+    insights: string[];
+    farmId?: string | undefined;
+}, {
+    source: string;
+    fieldId: string;
+    risks: {
+        waterloggingRisk: "low" | "medium" | "high";
+        erosionRisk: "low" | "medium" | "high";
+        machineryAccess: "poor" | "good" | "limited";
+    };
+    elevation: {
+        min: number;
+        max: number;
+        unit: "meters";
+        mean: number;
+        range: number;
+    };
+    resolutionM: number;
+    trustNote: string;
+    slope: {
+        medianPct: number;
+        meanPct: number;
+        maxPct: number;
+        percentByClass: {
+            flat: number;
+            moderate: number;
+            gentle: number;
+            steep: number;
+        };
+    };
+    sampledAt: string;
+    aspect: {
+        flatPercent: number;
+        dominant: string;
+    };
+    hydrology: {
+        wetnessClass: "low" | "high" | "moderate";
+        lowPointCount: number;
+        dominantFlowDirection?: string | undefined;
+    };
+    insights: string[];
+    farmId?: string | undefined;
+    interpolated?: boolean | undefined;
+}>;
+//# sourceMappingURL=terrain-profile.schemas.d.ts.map

package/dist/schemas/terrain-profile.schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terrain-profile.schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/terrain-profile.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,iFAAiF;AACjF,eAAO,MAAM,sBAAsB,sCAAoC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,eAAO,MAAM,kBAAkB,wCAAsC,CAAC;AACtE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,uBAAuB,oDAAkD,CAAC;AACvF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB,wCAAsC,CAAC;AACzE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwCpC,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAExC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAN5C,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMgC,CAAC"}

package/dist/schemas/terrain-profile.schemas.js

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+/** Risk levels shared by terrain consumers (planner, Farm Brain, irrigation). */
+export const terrainRiskLevelSchema = z.enum(['low', 'medium', 'high']);
+export const wetnessClassSchema = z.enum(['low', 'moderate', 'high']);
+export const terrainSlopeClassSchema = z.enum(['flat', 'gentle', 'moderate', 'steep']);
+export const machineryAccessSchema = z.enum(['good', 'limited', 'poor']);
+/**
+ * Stable field-scoped terrain summary. Any module may consume this without
+ * calling DEM APIs directly.
+ */
+export const fieldTerrainProfileSchema = z.object({
+    fieldId: z.string().uuid(),
+    farmId: z.string().uuid().optional(),
+    source: z.string(), // e.g. srtm30m
+    resolutionM: z.number().positive(),
+    sampledAt: z.string().datetime(),
+    interpolated: z.boolean().default(false),
+    trustNote: z.string(),
+    elevation: z.object({
+        min: z.number(),
+        max: z.number(),
+        mean: z.number(),
+        range: z.number(),
+        unit: z.literal('meters'),
+    }),
+    slope: z.object({
+        medianPct: z.number(),
+        meanPct: z.number(),
+        maxPct: z.number(),
+        percentByClass: z.object({
+            flat: z.number(),
+            gentle: z.number(),
+            moderate: z.number(),
+            steep: z.number(),
+        }),
+    }),
+    aspect: z.object({
+        dominant: z.string(),
+        flatPercent: z.number(),
+    }),
+    hydrology: z.object({
+        wetnessClass: wetnessClassSchema,
+        lowPointCount: z.number().int().nonnegative(),
+        dominantFlowDirection: z.string().optional(),
+    }),
+    risks: z.object({
+        waterloggingRisk: terrainRiskLevelSchema,
+        erosionRisk: terrainRiskLevelSchema,
+        machineryAccess: machineryAccessSchema,
+    }),
+    /** Short bullets for UI / Farm Brain */
+    insights: z.array(z.string()),
+});
+export const fieldTerrainProfileResponseSchema = fieldTerrainProfileSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepintel-ltd/farmpro-contracts",
-  "version": "1.16.3",
+  "version": "1.16.5",
   "description": "Type-safe API contracts for FarmPro API",
   "main": "dist/index.js",
   "module": "dist/index.js",