@deepintel-ltd/farmpro-contracts 1.5.14 → 1.5.16

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

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/subscriptions.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB;;GAEG;AAGH,eAAO,MAAM,sBAAsB,gFAMjC,CAAC;AAGH,eAAO,MAAM,wBAAwB,wDAKnC,CAAC;AAGH,eAAO,MAAM,kBAAkB,yDAK7B,CAAC;AAGH,eAAO,MAAM,wBAAwB,2CAAyC,CAAC;AAK/E,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcf,CAAC;AAG3B,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;EAO7C,CAAC;AAGH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;EAO9C,CAAC;AAGH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIrC,CAAC;AAGH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA0D,CAAC;AAGlG,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA8D,CAAC;AAG1G,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;EAKhB,CAAC;AAG3B,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAItC,CAAC;AAGH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA2D,CAAC;AAGpG,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA+D,CAAC;AAG5G,eAAO,MAAM,wBAAwB;;;;;;;;;;;;EAInC,CAAC;AAGH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;EAMrC,CAAC;AAGH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+B9B,CAAC;AAGH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASvC,CAAC;AAGH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AACxF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAClE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/schemas/subscriptions.schemas.js

@@ -0,0 +1,150 @@
+import { z } from 'zod';
+import { timestampsSchema, jsonApiSingleResponseSchema, jsonApiCollectionResponseSchema, } from './common.schemas';
+import { paymentGatewaySchema, paymentCurrencySchema } from './payments.schemas';
+/**
+ * Subscription schemas - JSON:API compliant
+ */
+// Subscription tier enum
+export const subscriptionTierSchema = z.enum([
+    'FREE',
+    'STARTER_PACK',
+    'COOPERATIVE',
+    'ENTERPRISE',
+    'GOVERNMENT',
+]);
+// Subscription status enum
+export const subscriptionStatusSchema = z.enum([
+    'active',
+    'cancelled',
+    'expired',
+    'trial',
+]);
+// Billing cycle enum
+export const billingCycleSchema = z.enum([
+    'monthly',
+    'annual',
+    'bi_annual',
+    'custom',
+]);
+// Satellite frequency enum
+export const satelliteFrequencySchema = z.enum(['monthly', 'weekly', 'daily']);
+// Re-export payment gateway and currency schemas from payments to avoid duplication
+// Subscription attributes schema (for JSON:API attributes object)
+export const subscriptionAttributesSchema = z.object({
+    tier: subscriptionTierSchema,
+    status: subscriptionStatusSchema,
+    amount: z.number().nullable().optional(),
+    currency: paymentCurrencySchema,
+    billingCycle: billingCycleSchema.nullable().optional(),
+    currentPeriodStart: z.string().datetime(),
+    currentPeriodEnd: z.string().datetime(),
+    cancelledAt: z.string().datetime().nullable().optional(),
+    paymentGateway: paymentGatewaySchema.nullable().optional(),
+    gatewaySubscriptionId: z.string().nullable().optional(),
+    maxFields: z.number().int().nullable().optional(),
+    maxAiImagesPerMonth: z.number().int().nullable().optional(),
+    satelliteFrequency: satelliteFrequencySchema.nullable().optional(),
+}).merge(timestampsSchema);
+// Subscription attributes for creation (input)
+export const createSubscriptionAttributesSchema = z.object({
+    tier: subscriptionTierSchema,
+    amount: z.number().positive().optional(),
+    currency: paymentCurrencySchema.default('NGN'),
+    billingCycle: billingCycleSchema.optional(),
+    paymentGateway: paymentGatewaySchema.optional(),
+    gatewaySubscriptionId: z.string().optional(),
+});
+// Subscription attributes for upgrade (input)
+export const upgradeSubscriptionAttributesSchema = z.object({
+    tier: subscriptionTierSchema,
+    amount: z.number().positive(),
+    currency: paymentCurrencySchema.default('NGN'),
+    billingCycle: billingCycleSchema,
+    paymentGateway: paymentGatewaySchema.optional(),
+    gatewaySubscriptionId: z.string().optional(),
+});
+// Subscription resource schema (JSON:API resource object)
+export const subscriptionResourceSchema = z.object({
+    type: z.literal('subscriptions'),
+    id: z.string().uuid(),
+    attributes: subscriptionAttributesSchema,
+});
+// Subscription response schema (single)
+export const subscriptionResponseSchema = jsonApiSingleResponseSchema(subscriptionResourceSchema);
+// Subscription list response schema
+export const subscriptionListResponseSchema = jsonApiCollectionResponseSchema(subscriptionResourceSchema);
+// Usage tracking attributes schema
+export const usageTrackingAttributesSchema = z.object({
+    resourceType: z.string(), // 'ai_image', 'satellite_check', 'sms_alert'
+    count: z.number().int().nonnegative(),
+    periodStart: z.string().datetime(),
+    periodEnd: z.string().datetime(),
+}).merge(timestampsSchema);
+// Usage tracking resource schema
+export const usageTrackingResourceSchema = z.object({
+    type: z.literal('usage-tracking'),
+    id: z.string().uuid(),
+    attributes: usageTrackingAttributesSchema,
+});
+// Usage tracking response schema
+export const usageTrackingResponseSchema = jsonApiSingleResponseSchema(usageTrackingResourceSchema);
+// Usage tracking list response schema
+export const usageTrackingListResponseSchema = jsonApiCollectionResponseSchema(usageTrackingResourceSchema);
+// Tier limits response schema
+export const tierLimitsResponseSchema = z.object({
+    maxFields: z.number().int().nullable(),
+    maxAiImagesPerMonth: z.number().int().nullable(),
+    satelliteFrequency: satelliteFrequencySchema,
+});
+// Current usage response schema
+export const currentUsageResponseSchema = z.object({
+    resourceType: z.string(),
+    count: z.number().int().nonnegative(),
+    limit: z.number().int().nullable(),
+    periodStart: z.string().datetime(),
+    periodEnd: z.string().datetime(),
+});
+// Available subscription plan schema (for landing page)
+export const availablePlanSchema = z.object({
+    tier: subscriptionTierSchema,
+    name: z.string(), // Display name (e.g., "Starter Pack")
+    description: z.string(), // Short description
+    pricing: z.object({
+        monthly: z.object({
+            ngn: z.number().nullable(), // NGN amount, null for FREE or custom pricing
+            usd: z.number().nullable(), // USD amount, null for FREE or custom pricing
+        }).nullable(), // null if monthly not available
+        annual: z.object({
+            ngn: z.number().nullable(), // NGN amount, null for FREE or custom pricing
+            usd: z.number().nullable(), // USD amount, null for FREE or custom pricing
+        }).nullable(), // null if annual not available
+        custom: z.boolean(), // true if pricing is custom (COOPERATIVE, ENTERPRISE, GOVERNMENT)
+    }),
+    features: z.object({
+        maxFields: z.number().int().nullable(), // null = unlimited
+        maxAiImagesPerMonth: z.number().int().nullable(), // null = unlimited
+        satelliteFrequency: satelliteFrequencySchema.nullable(),
+        agronomicsAdvisor: z.boolean(),
+        agronomicsAdvisorLimit: z.number().int().nullable(), // null = unlimited
+        weatherAlerts: z.boolean(),
+        weatherAlertsLimit: z.number().int().nullable(), // null = unlimited
+        apiAccess: z.boolean(),
+        whiteLabel: z.boolean(),
+        cooperativeTools: z.boolean(),
+        extensionWorkerUI: z.boolean(),
+        meDashboard: z.boolean(),
+        support: z.enum(['community', 'email', 'phone', 'dedicated']),
+    }),
+    popular: z.boolean().optional(), // Mark popular/recommended plan
+});
+// Available plans response schema
+export const availablePlansResponseSchema = z.object({
+    data: z.array(availablePlanSchema),
+    meta: z.object({
+        detectedLocation: z.object({
+            country: z.string(), // ISO 3166-1 alpha-2 country code
+            countryName: z.string(),
+            currency: z.enum(['NGN', 'USD']),
+        }),
+    }).optional(), // Optional: location detection metadata
+});

package/package.json

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