@deepintel-ltd/farmpro-contracts 1.5.13 → 1.5.15

package/dist/routes/subscriptions.routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.routes.d.ts","sourceRoot":"","sources":["../../src/routes/subscriptions.routes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+J9B,CAAC"}

package/dist/routes/subscriptions.routes.js

@@ -0,0 +1,155 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { subscriptionResponseSchema, subscriptionListResponseSchema, upgradeSubscriptionAttributesSchema, usageTrackingListResponseSchema, tierLimitsResponseSchema, currentUsageResponseSchema, availablePlansResponseSchema, } from '../schemas/subscriptions.schemas';
+import { jsonApiErrorResponseSchema, jsonApiPaginationQuerySchema, } from '../schemas/common.schemas';
+const c = initContract();
+export const subscriptionsRouter = c.router({
+    // Get all available subscription plans (public endpoint for landing page)
+    getAvailablePlans: {
+        method: 'GET',
+        path: '/subscriptions/plans',
+        query: z.object({
+            'currency': z.enum(['NGN', 'USD']).optional(),
+            'country': z.string().optional(), // ISO 3166-1 alpha-2 country code (e.g., 'NG', 'US')
+            'farmId': z.string().uuid().optional(), // Optional: use farm location for detection
+        }),
+        responses: {
+            200: availablePlansResponseSchema,
+        },
+        summary: 'Get available subscription plans',
+        description: 'Get all available subscription tiers with pricing and features. Pricing is automatically detected based on location (farm, IP, or explicit hint).',
+    },
+    // Get current subscription for a farm
+    getCurrentSubscription: {
+        method: 'GET',
+        path: '/farms/:farmId/subscription',
+        pathParams: z.object({ farmId: z.string().uuid() }),
+        responses: {
+            200: subscriptionResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Get current subscription',
+        description: 'Get the current active subscription for a farm',
+    },
+    // Get subscription by ID
+    getSubscription: {
+        method: 'GET',
+        path: '/farms/:farmId/subscriptions/:id',
+        pathParams: z.object({
+            farmId: z.string().uuid(),
+            id: z.string().uuid(),
+        }),
+        responses: {
+            200: subscriptionResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Get subscription by ID',
+        description: 'Get a specific subscription by ID',
+    },
+    // List all subscriptions for a farm
+    listSubscriptions: {
+        method: 'GET',
+        path: '/farms/:farmId/subscriptions',
+        pathParams: z.object({ farmId: z.string().uuid() }),
+        query: jsonApiPaginationQuerySchema.merge(z.object({
+            'filter[status]': z.enum(['active', 'cancelled', 'expired', 'trial']).optional(),
+            'filter[tier]': z.enum(['FREE', 'STARTER_PACK', 'COOPERATIVE', 'ENTERPRISE', 'GOVERNMENT']).optional(),
+        })),
+        responses: {
+            200: subscriptionListResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'List subscriptions',
+        description: 'Get all subscriptions for a farm with optional filtering',
+    },
+    // Upgrade subscription
+    upgradeSubscription: {
+        method: 'POST',
+        path: '/farms/:farmId/subscriptions/upgrade',
+        pathParams: z.object({ farmId: z.string().uuid() }),
+        body: z.object({
+            data: z.object({
+                type: z.literal('subscriptions'),
+                attributes: upgradeSubscriptionAttributesSchema,
+            }),
+        }),
+        responses: {
+            200: subscriptionResponseSchema,
+            400: jsonApiErrorResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Upgrade subscription',
+        description: 'Upgrade a farm subscription to a new tier',
+    },
+    // Cancel subscription
+    cancelSubscription: {
+        method: 'POST',
+        path: '/farms/:farmId/subscriptions/:id/cancel',
+        pathParams: z.object({
+            farmId: z.string().uuid(),
+            id: z.string().uuid(),
+        }),
+        body: z.object({}).optional(),
+        responses: {
+            200: subscriptionResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Cancel subscription',
+        description: 'Cancel an active subscription',
+    },
+    // Get tier limits
+    getTierLimits: {
+        method: 'GET',
+        path: '/farms/:farmId/subscription/limits',
+        pathParams: z.object({ farmId: z.string().uuid() }),
+        responses: {
+            200: z.object({
+                data: tierLimitsResponseSchema,
+            }),
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Get tier limits',
+        description: 'Get the limits for the current subscription tier',
+    },
+    // Get usage tracking
+    getUsageTracking: {
+        method: 'GET',
+        path: '/farms/:farmId/subscription/usage',
+        pathParams: z.object({ farmId: z.string().uuid() }),
+        query: z.object({
+            'filter[resourceType]': z.string().optional(), // 'ai_image', 'satellite_check', etc.
+            'filter[periodStart]': z.string().datetime().optional(),
+        }),
+        responses: {
+            200: usageTrackingListResponseSchema,
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Get usage tracking',
+        description: 'Get usage tracking data for the current subscription period',
+    },
+    // Get current usage for a specific resource
+    getCurrentUsage: {
+        method: 'GET',
+        path: '/farms/:farmId/subscription/usage/:resourceType',
+        pathParams: z.object({
+            farmId: z.string().uuid(),
+            resourceType: z.string(), // 'ai_image', 'satellite_check', etc.
+        }),
+        responses: {
+            200: z.object({
+                data: currentUsageResponseSchema,
+            }),
+            404: jsonApiErrorResponseSchema,
+            401: jsonApiErrorResponseSchema,
+        },
+        summary: 'Get current usage',
+        description: 'Get current usage for a specific resource type in the current period',
+    },
+});