@deepintel-ltd/farmpro-contracts 1.0.2 → 1.0.4

package/dist/schemas/common.schemas.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dateRangeQuerySchema = exports.paginationQuerySchema = exports.errorResponseSchema = exports.createJsonApiResourceSchema = exports.timestampsSchema = exports.idParamSchema = exports.jsonApiSuccessResponseSchema = exports.jsonApiErrorResponseSchema = exports.jsonApiErrorSchema = exports.jsonApiIncludeQuerySchema = exports.jsonApiFieldsQuerySchema = exports.jsonApiFilterQuerySchema = exports.jsonApiSortQuerySchema = exports.jsonApiPaginationMetaSchema = exports.jsonApiPaginationLinksSchema = exports.jsonApiPaginationQuerySchema = exports.jsonApiCollectionResponseSchema = exports.jsonApiSingleResponseSchema = exports.jsonApiResourceSchema = exports.geoJSONGeometrySchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Common schemas used across all API contracts - JSON:API compliant
+ */
+// GeoJSON Geometry Schema (Polygon, MultiPolygon, Point, LineString)
+exports.geoJSONGeometrySchema = zod_1.z.object({
+    type: zod_1.z.enum(['Polygon', 'MultiPolygon', 'Point', 'LineString']),
+    coordinates: zod_1.z.union([
+        zod_1.z.array(zod_1.z.array(zod_1.z.array(zod_1.z.number()))), // Polygon: [[[lng, lat], ...]]
+        zod_1.z.array(zod_1.z.array(zod_1.z.array(zod_1.z.array(zod_1.z.number())))), // MultiPolygon: [[[[lng, lat], ...]]]
+        zod_1.z.array(zod_1.z.number()), // Point: [lng, lat]
+        zod_1.z.array(zod_1.z.array(zod_1.z.number())), // LineString: [[lng, lat], ...]
+    ]),
+});
+// JSON:API Resource Object Base
+exports.jsonApiResourceSchema = zod_1.z.object({
+    type: zod_1.z.string(),
+    id: zod_1.z.string(),
+    attributes: zod_1.z.record(zod_1.z.unknown()).optional(),
+    relationships: zod_1.z.record(zod_1.z.unknown()).optional(),
+    links: zod_1.z.record(zod_1.z.string()).optional(),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+// JSON:API Single Resource Response
+const jsonApiSingleResponseSchema = (resourceSchema) => zod_1.z.object({
+    data: resourceSchema,
+    included: zod_1.z.array(exports.jsonApiResourceSchema).optional(),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+    links: zod_1.z.record(zod_1.z.string()).optional(),
+});
+exports.jsonApiSingleResponseSchema = jsonApiSingleResponseSchema;
+// JSON:API Collection Response
+const jsonApiCollectionResponseSchema = (resourceSchema) => zod_1.z.object({
+    data: zod_1.z.array(resourceSchema),
+    included: zod_1.z.array(exports.jsonApiResourceSchema).optional(),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+    links: zod_1.z.record(zod_1.z.string()).optional(),
+});
+exports.jsonApiCollectionResponseSchema = jsonApiCollectionResponseSchema;
+exports.jsonApiPaginationQuerySchema = zod_1.z.object({
+    'page[number]': zod_1.z.coerce.number().int().positive().default(1).optional(),
+    'page[size]': zod_1.z.coerce.number().int().positive().max(100).default(20).optional(),
+});
+exports.jsonApiPaginationLinksSchema = zod_1.z.object({
+    first: zod_1.z.string().optional(),
+    last: zod_1.z.string().optional(),
+    prev: zod_1.z.string().optional(),
+    next: zod_1.z.string().optional(),
+    self: zod_1.z.string(),
+});
+exports.jsonApiPaginationMetaSchema = zod_1.z.object({
+    totalRecords: zod_1.z.number().int().nonnegative(),
+    totalPages: zod_1.z.number().int().nonnegative(),
+    currentPage: zod_1.z.number().int().positive(),
+    pageSize: zod_1.z.number().int().positive(),
+});
+exports.jsonApiSortQuerySchema = zod_1.z.object({
+    sort: zod_1.z.string().optional(), // e.g., "name,-createdAt"
+});
+exports.jsonApiFilterQuerySchema = zod_1.z.object({
+    'filter[startDate]': zod_1.z.string().datetime().optional(),
+    'filter[endDate]': zod_1.z.string().datetime().optional(),
+    'filter[status]': zod_1.z.string().optional(),
+    'filter[crop]': zod_1.z.string().optional(),
+});
+exports.jsonApiFieldsQuerySchema = zod_1.z.record(zod_1.z.string(), // resource type
+zod_1.z.string() // comma-separated field names
+).optional();
+exports.jsonApiIncludeQuerySchema = zod_1.z.object({
+    include: zod_1.z.string().optional(), // e.g., "fields,team"
+});
+exports.jsonApiErrorSchema = zod_1.z.object({
+    id: zod_1.z.string().optional(),
+    links: zod_1.z.object({
+        about: zod_1.z.string().optional(),
+    }).optional(),
+    status: zod_1.z.string().optional(), // HTTP status code as string
+    code: zod_1.z.string().optional(), // Application-specific error code
+    title: zod_1.z.string().optional(), // Short, human-readable summary
+    detail: zod_1.z.string().optional(), // Human-readable explanation
+    source: zod_1.z.object({
+        pointer: zod_1.z.string().optional(), // JSON Pointer to associated field
+        parameter: zod_1.z.string().optional(), // Query parameter that caused the error
+    }).optional(),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+exports.jsonApiErrorResponseSchema = zod_1.z.object({
+    errors: zod_1.z.array(exports.jsonApiErrorSchema),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+exports.jsonApiSuccessResponseSchema = zod_1.z.object({
+    meta: zod_1.z.object({
+        message: zod_1.z.string(),
+    }),
+});
+exports.idParamSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid(),
+});
+exports.timestampsSchema = zod_1.z.object({
+    createdAt: zod_1.z.string().datetime(),
+    updatedAt: zod_1.z.string().datetime(),
+});
+// Helper to create a JSON:API resource schema
+const createJsonApiResourceSchema = (resourceType, attributesSchema) => zod_1.z.object({
+    type: zod_1.z.literal(resourceType),
+    id: zod_1.z.string(),
+    attributes: attributesSchema,
+    relationships: zod_1.z.record(zod_1.z.unknown()).optional(),
+    links: zod_1.z.record(zod_1.z.string()).optional(),
+    meta: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+exports.createJsonApiResourceSchema = createJsonApiResourceSchema;
+// Backward compatibility exports (deprecated - use JSON:API versions)
+exports.errorResponseSchema = exports.jsonApiErrorResponseSchema;
+exports.paginationQuerySchema = exports.jsonApiPaginationQuerySchema;
+exports.dateRangeQuerySchema = zod_1.z.object({
+    'filter[startDate]': zod_1.z.string().datetime().optional(),
+    'filter[endDate]': zod_1.z.string().datetime().optional(),
+});