@deepintel-ltd/farmpro-contracts 1.7.1 → 1.7.2

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

@@ -0,0 +1 @@
+{"version":3,"file":"capital.schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/capital.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB;;;GAGG;AAGH,eAAO,MAAM,iBAAiB,4FAO5B,CAAC;AAGH,eAAO,MAAM,mBAAmB,qFAM9B,CAAC;AAGH,eAAO,MAAM,qBAAqB,2BAAyB,CAAC;AAG5D,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmBrB,CAAC;AAG3B,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsBnD,CAAC;AAGH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAenD,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;EAI3C,CAAC;AAGH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGzC,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIzC,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG5C,CAAC;AAGF,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQjD,CAAC;AAGH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAgE,CAAC;AAC9G,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAsE,CAAC;AAC1H,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAoE,CAAC;AAGtH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAezC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGxC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA4D,CAAC;AAGtG,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wCAAwC,CAAC,CAAC;AAC1G,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wCAAwC,CAAC,CAAC;AAC1G,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC3F,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC3F,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACzE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sCAAsC,CAAC,CAAC;AACtG,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAC1F,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sCAAsC,CAAC,CAAC;AACtG,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAClG,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/schemas/capital.schemas.js

@@ -0,0 +1,142 @@
+import { z } from 'zod';
+import { timestampsSchema, createJsonApiResourceSchema, jsonApiSingleResponseSchema, jsonApiCollectionResponseSchema } from './common.schemas';
+/**
+ * Capital Transaction schemas - JSON:API compliant
+ * Used for tracking capital injections, loans, grants, and other funding sources
+ */
+// Capital transaction type enum
+export const capitalTypeSchema = z.enum([
+    'OWNER_CONTRIBUTION',
+    'LOAN',
+    'GRANT',
+    'INVESTOR',
+    'WORKING_CAPITAL',
+    'OTHER'
+]);
+// Capital transaction status enum
+export const capitalStatusSchema = z.enum([
+    'received',
+    'pending',
+    'partially_repaid',
+    'fully_repaid',
+    'cancelled'
+]);
+// Currency enum (matching the rest of the system)
+export const capitalCurrencySchema = z.enum(['NGN', 'USD']);
+// Capital transaction attributes schema (for JSON:API attributes object)
+export const capitalTransactionAttributesSchema = z.object({
+    type: capitalTypeSchema,
+    amount: z.number().positive(),
+    currency: capitalCurrencySchema,
+    description: z.string().nullable(),
+    source: z.string().nullable(), // Who provided the funds
+    reference: z.string().nullable(), // External reference number
+    transactionDate: z.string().datetime(),
+    // For loans/repayable funds
+    isRepayable: z.boolean(),
+    repaymentTerms: z.string().nullable(),
+    interestRate: z.number().nullable(), // Annual interest rate as percentage
+    repaymentDueDate: z.string().datetime().nullable(),
+    // Status tracking
+    status: capitalStatusSchema,
+    amountRepaid: z.number().nonnegative(),
+    // Calculated fields
+    outstandingBalance: z.number().optional(), // amount - amountRepaid (for repayable)
+    notes: z.string().nullable(),
+}).merge(timestampsSchema);
+// Capital transaction attributes for creation (input)
+export const createCapitalTransactionAttributesSchema = z.object({
+    type: capitalTypeSchema,
+    amount: z.number().positive(),
+    currency: capitalCurrencySchema.default('NGN'),
+    description: z.string().max(2000).optional(),
+    source: z.string().max(200).optional(), // Who provided the funds
+    reference: z.string().max(100).optional(), // External reference number
+    transactionDate: z.string().datetime(),
+    // For loans/repayable funds
+    isRepayable: z.boolean().default(false),
+    repaymentTerms: z.string().max(2000).optional(),
+    interestRate: z.number().min(0).max(100).optional(), // Annual interest rate
+    repaymentDueDate: z.string().datetime().optional(),
+    notes: z.string().max(2000).optional(),
+}).refine((data) => {
+    // If repayable, due date should be provided
+    if (data.isRepayable && data.type === 'LOAN' && !data.repaymentDueDate) {
+        return true; // Allow loans without due date (open-ended)
+    }
+    return true;
+}, {
+    message: 'Repayment due date is recommended for repayable capital',
+});
+// Capital transaction attributes for update (input)
+export const updateCapitalTransactionAttributesSchema = z.object({
+    type: capitalTypeSchema.optional(),
+    amount: z.number().positive().optional(),
+    currency: capitalCurrencySchema.optional(),
+    description: z.string().max(2000).nullable().optional(),
+    source: z.string().max(200).nullable().optional(),
+    reference: z.string().max(100).nullable().optional(),
+    transactionDate: z.string().datetime().optional(),
+    isRepayable: z.boolean().optional(),
+    repaymentTerms: z.string().max(2000).nullable().optional(),
+    interestRate: z.number().min(0).max(100).nullable().optional(),
+    repaymentDueDate: z.string().datetime().nullable().optional(),
+    status: capitalStatusSchema.optional(),
+    amountRepaid: z.number().nonnegative().optional(),
+    notes: z.string().max(2000).nullable().optional(),
+});
+// Repayment input schema (for recording loan repayments)
+export const capitalRepaymentAttributesSchema = z.object({
+    amount: z.number().positive(),
+    repaymentDate: z.string().datetime(),
+    notes: z.string().max(500).optional(),
+});
+// Create input schemas (JSON:API format)
+export const createCapitalTransactionSchema = z.object({
+    type: z.literal('capital-transactions'),
+    attributes: createCapitalTransactionAttributesSchema,
+});
+export const updateCapitalTransactionSchema = z.object({
+    type: z.literal('capital-transactions'),
+    id: z.string().uuid(),
+    attributes: updateCapitalTransactionAttributesSchema,
+});
+export const recordRepaymentSchema = z.object({
+    type: z.literal('capital-repayments'),
+    attributes: capitalRepaymentAttributesSchema,
+});
+// Resource schemas (JSON:API resource objects)
+export const capitalTransactionResourceSchema = createJsonApiResourceSchema('capital-transactions', capitalTransactionAttributesSchema);
+// Detail resource schema with relationships
+export const capitalTransactionDetailResourceSchema = capitalTransactionResourceSchema.extend({
+    relationships: z.object({
+        farm: z.object({
+            links: z.object({
+                related: z.string(),
+            }),
+        }).optional(),
+    }).optional(),
+});
+// Response schemas (JSON:API format)
+export const capitalTransactionResponseSchema = jsonApiSingleResponseSchema(capitalTransactionResourceSchema);
+export const capitalTransactionDetailResponseSchema = jsonApiSingleResponseSchema(capitalTransactionDetailResourceSchema);
+export const capitalTransactionListResponseSchema = jsonApiCollectionResponseSchema(capitalTransactionResourceSchema);
+// Capital summary response (aggregate data)
+export const capitalSummaryAttributesSchema = z.object({
+    totalCapitalReceived: z.number().nonnegative(),
+    totalRepayableAmount: z.number().nonnegative(),
+    totalAmountRepaid: z.number().nonnegative(),
+    outstandingLiabilities: z.number().nonnegative(),
+    // Breakdown by type
+    byType: z.record(capitalTypeSchema, z.object({
+        count: z.number().int().nonnegative(),
+        totalAmount: z.number().nonnegative(),
+    })),
+    // Breakdown by status
+    byStatus: z.record(capitalStatusSchema, z.object({
+        count: z.number().int().nonnegative(),
+        totalAmount: z.number().nonnegative(),
+    })),
+});
+export const capitalSummaryResourceSchema = createJsonApiResourceSchema('capital-summaries', capitalSummaryAttributesSchema);
+export const capitalSummaryResponseSchema = jsonApiSingleResponseSchema(capitalSummaryResourceSchema);

package/package.json

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