@deepintel-ltd/farmpro-contracts 1.0.2 → 1.0.4

package/dist/routes/analytics.routes.d.ts

@@ -0,0 +1,754 @@
+import { z } from 'zod';
+export declare const analyticsRouter: {
+    getAnalytics: {
+        pathParams: z.ZodObject<{
+            farmId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            farmId: string;
+        }, {
+            farmId: string;
+        }>;
+        query: z.ZodOptional<z.ZodObject<{
+            'filter[startDate]': z.ZodOptional<z.ZodString>;
+            'filter[endDate]': z.ZodOptional<z.ZodString>;
+            'filter[status]': z.ZodOptional<z.ZodString>;
+            'filter[crop]': z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            'filter[startDate]'?: string | undefined;
+            'filter[endDate]'?: string | undefined;
+            'filter[status]'?: string | undefined;
+            'filter[crop]'?: string | undefined;
+        }, {
+            'filter[startDate]'?: string | undefined;
+            'filter[endDate]'?: string | undefined;
+            'filter[status]'?: string | undefined;
+            'filter[crop]'?: string | undefined;
+        }>>;
+        summary: "Get analytics";
+        description: "Get comprehensive analytics including performance trends, yield, market data, and profitability";
+        method: "GET";
+        path: "/farms/:farmId/analytics";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodObject<{
+                    type: z.ZodLiteral<string>;
+                    id: z.ZodString;
+                    attributes: z.ZodObject<{
+                        farmId: z.ZodString;
+                        performanceData: z.ZodArray<z.ZodObject<{
+                            date: z.ZodString;
+                            ndvi: z.ZodNullable<z.ZodNumber>;
+                            moisture: z.ZodNullable<z.ZodNumber>;
+                            rainfall: z.ZodNullable<z.ZodNumber>;
+                        }, "strip", z.ZodTypeAny, {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }, {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }>, "many">;
+                        yield: z.ZodObject<{
+                            forecast: z.ZodNumber;
+                            target: z.ZodNumber;
+                            revenue: z.ZodNumber;
+                            costs: z.ZodNumber;
+                        }, "strip", z.ZodTypeAny, {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        }, {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        }>;
+                        marketData: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            crop: z.ZodString;
+                            price: z.ZodString;
+                            trend: z.ZodEnum<["up", "down", "stable"]>;
+                        }, "strip", z.ZodTypeAny, {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }, {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }>, "many">;
+                        fieldPerformance: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            ndvi: z.ZodNumber;
+                            trend: z.ZodEnum<["up", "down", "stable"]>;
+                            moisture: z.ZodString;
+                            issue: z.ZodNullable<z.ZodString>;
+                        }, "strip", z.ZodTypeAny, {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }, {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }>, "many">;
+                        profitability: z.ZodOptional<z.ZodObject<{
+                            totalRevenue: z.ZodNumber;
+                            totalCosts: z.ZodNumber;
+                            netProfit: z.ZodNumber;
+                            profitMargin: z.ZodNumber;
+                            fieldBreakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                fieldId: z.ZodString;
+                                fieldName: z.ZodString;
+                                revenue: z.ZodNumber;
+                                costs: z.ZodNumber;
+                                profit: z.ZodNumber;
+                                margin: z.ZodNumber;
+                            }, "strip", z.ZodTypeAny, {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }, {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }>, "many">>;
+                            cropBreakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                crop: z.ZodString;
+                                revenue: z.ZodNumber;
+                                costs: z.ZodNumber;
+                                profit: z.ZodNumber;
+                                margin: z.ZodNumber;
+                            }, "strip", z.ZodTypeAny, {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }, {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }>, "many">>;
+                        }, "strip", z.ZodTypeAny, {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        }, {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        }>>;
+                    }, "strip", z.ZodTypeAny, {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    }, {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    }>;
+                    relationships: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    type: string;
+                    id: string;
+                    attributes: {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    };
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    type: string;
+                    id: string;
+                    attributes: {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    };
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>;
+                included: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    type: z.ZodString;
+                    id: z.ZodString;
+                    attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    relationships: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    type: string;
+                    id: string;
+                    attributes?: Record<string, unknown> | undefined;
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    type: string;
+                    id: string;
+                    attributes?: Record<string, unknown> | undefined;
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">>;
+                meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    type: string;
+                    id: string;
+                    attributes: {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    };
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                };
+                links?: Record<string, string> | undefined;
+                meta?: Record<string, unknown> | undefined;
+                included?: {
+                    type: string;
+                    id: string;
+                    attributes?: Record<string, unknown> | undefined;
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }, {
+                data: {
+                    type: string;
+                    id: string;
+                    attributes: {
+                        yield: {
+                            revenue: number;
+                            forecast: number;
+                            target: number;
+                            costs: number;
+                        };
+                        farmId: string;
+                        performanceData: {
+                            date: string;
+                            ndvi: number | null;
+                            moisture: number | null;
+                            rainfall: number | null;
+                        }[];
+                        marketData: {
+                            id: string;
+                            crop: string;
+                            price: string;
+                            trend: "up" | "down" | "stable";
+                        }[];
+                        fieldPerformance: {
+                            id: string;
+                            name: string;
+                            ndvi: number;
+                            moisture: string;
+                            trend: "up" | "down" | "stable";
+                            issue: string | null;
+                        }[];
+                        profitability?: {
+                            totalRevenue: number;
+                            netProfit: number;
+                            profitMargin: number;
+                            totalCosts: number;
+                            fieldBreakdown?: {
+                                fieldId: string;
+                                fieldName: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                            cropBreakdown?: {
+                                crop: string;
+                                revenue: number;
+                                costs: number;
+                                profit: number;
+                                margin: number;
+                            }[] | undefined;
+                        } | undefined;
+                    };
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                };
+                links?: Record<string, string> | undefined;
+                meta?: Record<string, unknown> | undefined;
+                included?: {
+                    type: string;
+                    id: string;
+                    attributes?: Record<string, unknown> | undefined;
+                    relationships?: Record<string, unknown> | undefined;
+                    links?: Record<string, string> | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }>;
+            404: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    links: z.ZodOptional<z.ZodObject<{
+                        about: z.ZodOptional<z.ZodString>;
+                    }, "strip", z.ZodTypeAny, {
+                        about?: string | undefined;
+                    }, {
+                        about?: string | undefined;
+                    }>>;
+                    status: z.ZodOptional<z.ZodString>;
+                    code: z.ZodOptional<z.ZodString>;
+                    title: z.ZodOptional<z.ZodString>;
+                    detail: z.ZodOptional<z.ZodString>;
+                    source: z.ZodOptional<z.ZodObject<{
+                        pointer: z.ZodOptional<z.ZodString>;
+                        parameter: z.ZodOptional<z.ZodString>;
+                    }, "strip", z.ZodTypeAny, {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    }, {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    }>>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }, {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }>, "many">;
+                meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }[];
+                meta?: Record<string, unknown> | undefined;
+            }, {
+                errors: {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }[];
+                meta?: Record<string, unknown> | undefined;
+            }>;
+            401: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    links: z.ZodOptional<z.ZodObject<{
+                        about: z.ZodOptional<z.ZodString>;
+                    }, "strip", z.ZodTypeAny, {
+                        about?: string | undefined;
+                    }, {
+                        about?: string | undefined;
+                    }>>;
+                    status: z.ZodOptional<z.ZodString>;
+                    code: z.ZodOptional<z.ZodString>;
+                    title: z.ZodOptional<z.ZodString>;
+                    detail: z.ZodOptional<z.ZodString>;
+                    source: z.ZodOptional<z.ZodObject<{
+                        pointer: z.ZodOptional<z.ZodString>;
+                        parameter: z.ZodOptional<z.ZodString>;
+                    }, "strip", z.ZodTypeAny, {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    }, {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    }>>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }, {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }>, "many">;
+                meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }[];
+                meta?: Record<string, unknown> | undefined;
+            }, {
+                errors: {
+                    status?: string | undefined;
+                    code?: string | undefined;
+                    id?: string | undefined;
+                    links?: {
+                        about?: string | undefined;
+                    } | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                    title?: string | undefined;
+                    detail?: string | undefined;
+                    source?: {
+                        pointer?: string | undefined;
+                        parameter?: string | undefined;
+                    } | undefined;
+                }[];
+                meta?: Record<string, unknown> | undefined;
+            }>;
+        };
+    };
+};
+//# sourceMappingURL=analytics.routes.d.ts.map