@deepintel-ltd/farmpro-contracts 1.7.21 → 1.8.0

package/dist/schemas/device-gateway.schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-gateway.schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/device-gateway.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB;;;;;;;;;EAG5B,CAAC;AAEH,eAAO,MAAM,kBAAkB,sEAK7B,CAAC;AAEH,eAAO,MAAM,oBAAoB,sDAA8C,CAAC;AAEhF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;EASjC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;EAGhC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW7B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGlC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;EAMrC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;EAGtC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;EAOjC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAErC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;EAItC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;EAQ9B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;EAElC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAErC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;EAKlC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;EAEnC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;EAIvC,CAAC;AAGH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGpC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASrC,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAY9B,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEpC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGpC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAErC,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;EAItC,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUzB,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEtC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;EAKvC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;EAGxC,CAAC"}

package/dist/schemas/device-gateway.schemas.js

@@ -0,0 +1,165 @@
+import { z } from 'zod';
+export const deviceErrorSchema = z.object({
+    message: z.string(),
+    code: z.string(),
+});
+export const actuatorTypeSchema = z.enum([
+    'IRRIGATION_VALVE',
+    'FERT_PUMP_A',
+    'FERT_PUMP_B',
+    'FAN',
+]);
+export const actuatorStatesSchema = z.record(z.string(), z.string()).optional();
+export const heartbeatRequestSchema = z.object({
+    deviceId: z.string().uuid(),
+    firmwareVersion: z.string().max(50).optional(),
+    uptimeSec: z.number().int().nonnegative().optional(),
+    wifiRssi: z.number().optional(),
+    freeHeap: z.number().int().nonnegative().optional(),
+    bufferedReadingsCount: z.number().int().nonnegative().optional(),
+    bufferOverflow: z.boolean().optional(),
+    actuatorStates: actuatorStatesSchema,
+});
+export const pumpCalibrationSchema = z.object({
+    mlPerSecond: z.number().positive(),
+    calibratedAt: z.string().datetime().optional(),
+});
+export const deviceConfigSchema = z.object({
+    heartbeatIntervalSec: z.number().int().positive().optional(),
+    commandPollIntervalSec: z.number().int().positive().optional(),
+    sensorIntervals: z.record(z.string(), z.number().int().positive()).optional(),
+    pumpCalibration: z
+        .object({
+        fert_pump_a: pumpCalibrationSchema.optional(),
+        fert_pump_b: pumpCalibrationSchema.optional(),
+    })
+        .optional(),
+    gpioMap: z.record(z.string(), z.number().int()).optional(),
+});
+export const heartbeatResponseSchema = z.object({
+    serverTime: z.string().datetime(),
+    config: deviceConfigSchema,
+});
+export const sensorReadingRequestSchema = z.object({
+    value: z.number(),
+    unit: z.string().max(20),
+    quality: z.enum(['good', 'fair', 'poor']).optional(),
+    readAt: z.string().datetime(),
+    metadata: z.record(z.string(), z.unknown()).optional(),
+});
+export const sensorReadingResponseSchema = z.object({
+    readingId: z.string().uuid(),
+    alertTriggered: z.boolean(),
+});
+export const batchReadingItemSchema = z.object({
+    sensorId: z.string().uuid(),
+    value: z.number(),
+    unit: z.string().max(20),
+    quality: z.enum(['good', 'fair', 'poor']).optional(),
+    readAt: z.string().datetime(),
+    metadata: z.record(z.string(), z.unknown()).optional(),
+});
+export const batchReadingsRequestSchema = z.object({
+    readings: z.array(batchReadingItemSchema).min(1).max(500),
+});
+export const batchReadingsResponseSchema = z.object({
+    accepted: z.number().int().nonnegative(),
+    rejected: z.number().int().nonnegative(),
+    alertsTriggered: z.number().int().nonnegative(),
+});
+export const deviceCommandSchema = z.object({
+    id: z.string().uuid(),
+    actuatorId: z.string().uuid(),
+    actuatorType: actuatorTypeSchema,
+    command: z.enum(['ON', 'OFF', 'PULSE']),
+    durationSec: z.number().int().positive().nullable().optional(),
+    source: z.string(),
+    createdAt: z.string().datetime(),
+});
+export const listCommandsQuerySchema = z.object({
+    deviceId: z.string().uuid(),
+});
+export const listCommandsResponseSchema = z.object({
+    commands: z.array(deviceCommandSchema),
+});
+export const commandAckRequestSchema = z.object({
+    status: z.enum(['acked', 'failed']),
+    executedAt: z.string().datetime(),
+    error: z.string().optional(),
+    metadata: z.record(z.string(), z.unknown()).optional(),
+});
+export const commandAckResponseSchema = z.object({
+    success: z.boolean(),
+});
+export const snapshotUploadResponseSchema = z.object({
+    snapshotId: z.string().uuid(),
+    imageUrl: z.string(),
+    analysisQueued: z.boolean(),
+});
+// Admin (JWT) schemas
+export const createDeviceRequestSchema = z.object({
+    name: z.string().min(1).max(200),
+    config: deviceConfigSchema.optional(),
+});
+export const createDeviceResponseSchema = z.object({
+    device: z.object({
+        id: z.string().uuid(),
+        name: z.string(),
+        fieldId: z.string().uuid(),
+        farmId: z.string().uuid(),
+        createdAt: z.string().datetime(),
+    }),
+    apiKey: z.string(),
+});
+export const deviceSummarySchema = z.object({
+    id: z.string().uuid(),
+    name: z.string(),
+    fieldId: z.string().uuid(),
+    farmId: z.string().uuid(),
+    lastSeenAt: z.string().datetime().nullable(),
+    bufferedReadingsCount: z.number().int().nullable(),
+    bufferOverflow: z.boolean(),
+    firmwareVersion: z.string().nullable(),
+    isOnline: z.boolean(),
+    config: deviceConfigSchema.nullable(),
+    createdAt: z.string().datetime(),
+});
+export const listDevicesResponseSchema = z.object({
+    devices: z.array(deviceSummarySchema),
+});
+export const updateDeviceRequestSchema = z.object({
+    name: z.string().min(1).max(200).optional(),
+    config: deviceConfigSchema.optional(),
+});
+export const updateDeviceResponseSchema = z.object({
+    device: deviceSummarySchema,
+});
+export const createActuatorRequestSchema = z.object({
+    type: actuatorTypeSchema,
+    name: z.string().min(1).max(200),
+    gpioPin: z.number().int().optional(),
+});
+export const actuatorSchema = z.object({
+    id: z.string().uuid(),
+    deviceId: z.string().uuid(),
+    fieldId: z.string().uuid(),
+    farmId: z.string().uuid(),
+    type: actuatorTypeSchema,
+    name: z.string(),
+    gpioPin: z.number().int().nullable(),
+    status: z.string(),
+    lastCommandAt: z.string().datetime().nullable(),
+});
+export const listActuatorsResponseSchema = z.object({
+    actuators: z.array(actuatorSchema),
+});
+export const actuatorCommandRequestSchema = z.object({
+    command: z.enum(['ON', 'OFF', 'PULSE']),
+    durationSec: z.number().int().positive().optional(),
+    source: z.enum(['manual', 'schedule', 'rule']).default('manual'),
+    metadata: z.record(z.string(), z.unknown()).optional(),
+});
+export const actuatorCommandResponseSchema = z.object({
+    commandId: z.string().uuid(),
+    status: z.string(),
+});

package/package.json

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