@luca-financial/luca-schema 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.3.1] - 2026-04-05
+
+### Changed
+
+- Require `isSameSign` on both `transactionLink` and `recurringTransactionLink` so linked amounts can explicitly indicate same-sign versus opposite-sign matching behavior.
+- Update bundled examples, fixtures, tests, and README documentation to reflect the new required link-sign behavior flag.
+
 ## [3.3.0] - 2026-04-05
 
 ### Added

package/README.md

@@ -219,6 +219,7 @@ const recurringTransactionLink = {
   id: string;
   sourceRecurringTransactionId: string;
   destinationRecurringTransactionId: string;
+  isSameSign: boolean;
   createdAt: string;
   updatedAt: string | null;
   deletedAt?: string | null;
@@ -235,6 +236,7 @@ const transactionLink = {
   id: string;
   sourceTransactionId: string;
   destinationTransactionId: string;
+  isSameSign: boolean;
   createdAt: string;
   updatedAt: string | null;
   deletedAt?: string | null;
@@ -242,7 +244,7 @@ const transactionLink = {
 };
 ```
 
-Cross-transaction rules like matching dates, matching amounts, or opposite signs are not enforced by this schema and should be handled in application logic.
+`isSameSign` indicates whether linked amounts should share the same sign (`true`) or use opposite signs (`false`) while still matching by absolute value. Cross-transaction rules like matching dates or verifying absolute-value equality are not enforced by this schema and should be handled in application logic.
 
 ### LucaSchema
 

package/dist/esm/index.d.ts

@@ -532,6 +532,7 @@ export type ExpectedDate = string;
 export type RecurringTransactionLink = Common5 & {
   sourceRecurringTransactionId: SourceRecurringTransactionID;
   destinationRecurringTransactionId: DestinationRecurringTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -561,6 +562,10 @@ export type SourceRecurringTransactionID = string;
  * UUID of the destination recurring transaction in the link.
  */
 export type DestinationRecurringTransactionID = string;
+/**
+ * Whether the linked recurring transactions are expected to have matching signs. When false, the linked recurring transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 export type Transaction = Common6 & {
   accountId: AccountID2;
   date: Date;
@@ -658,6 +663,7 @@ export type AggregationServiceID1 = string | null;
 export type TransactionLink = Common7 & {
   sourceTransactionId: SourceTransactionID;
   destinationTransactionId: DestinationTransactionID;
+  isSameSign: IsSameSign1;
 };
 /**
  * UUID for the item
@@ -687,6 +693,10 @@ export type SourceTransactionID = string;
  * UUID of the destination transaction in the link.
  */
 export type DestinationTransactionID = string;
+/**
+ * Whether the linked transactions are expected to have matching signs. When false, the linked transactions are expected to have opposite signs.
+ */
+export type IsSameSign1 = boolean;
 /**
  * Defines a split within a transaction.
  */
@@ -1030,6 +1040,7 @@ export interface Common {
 export type RecurringTransactionLink = Common & {
   sourceRecurringTransactionId: SourceRecurringTransactionID;
   destinationRecurringTransactionId: DestinationRecurringTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -1059,6 +1070,10 @@ export type SourceRecurringTransactionID = string;
  * UUID of the destination recurring transaction in the link.
  */
 export type DestinationRecurringTransactionID = string;
+/**
+ * Whether the linked recurring transactions are expected to have matching signs. When false, the linked recurring transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 
 /**
  * Common properties for all schemas
@@ -1257,6 +1272,7 @@ export interface Common {
 export type TransactionLink = Common & {
   sourceTransactionId: SourceTransactionID;
   destinationTransactionId: DestinationTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -1286,6 +1302,10 @@ export type SourceTransactionID = string;
  * UUID of the destination transaction in the link.
  */
 export type DestinationTransactionID = string;
+/**
+ * Whether the linked transactions are expected to have matching signs. When false, the linked transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 
 /**
  * Common properties for all schemas

package/dist/esm/schemas/recurringTransactionLink.json

@@ -21,11 +21,17 @@
       "title": "Destination Recurring Transaction ID",
       "format": "uuid",
       "description": "UUID of the destination recurring transaction in the link."
+    },
+    "isSameSign": {
+      "type": "boolean",
+      "title": "Is Same Sign",
+      "description": "Whether the linked recurring transactions are expected to have matching signs. When false, the linked recurring transactions are expected to have opposite signs."
     }
   },
   "unevaluatedProperties": false,
   "required": [
     "sourceRecurringTransactionId",
-    "destinationRecurringTransactionId"
+    "destinationRecurringTransactionId",
+    "isSameSign"
   ]
 }

package/dist/esm/schemas/transactionLink.json

@@ -21,8 +21,13 @@
       "title": "Destination Transaction ID",
       "format": "uuid",
       "description": "UUID of the destination transaction in the link."
+    },
+    "isSameSign": {
+      "type": "boolean",
+      "title": "Is Same Sign",
+      "description": "Whether the linked transactions are expected to have matching signs. When false, the linked transactions are expected to have opposite signs."
     }
   },
   "unevaluatedProperties": false,
-  "required": ["sourceTransactionId", "destinationTransactionId"]
+  "required": ["sourceTransactionId", "destinationTransactionId", "isSameSign"]
 }

package/dist/index.d.ts

@@ -532,6 +532,7 @@ export type ExpectedDate = string;
 export type RecurringTransactionLink = Common5 & {
   sourceRecurringTransactionId: SourceRecurringTransactionID;
   destinationRecurringTransactionId: DestinationRecurringTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -561,6 +562,10 @@ export type SourceRecurringTransactionID = string;
  * UUID of the destination recurring transaction in the link.
  */
 export type DestinationRecurringTransactionID = string;
+/**
+ * Whether the linked recurring transactions are expected to have matching signs. When false, the linked recurring transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 export type Transaction = Common6 & {
   accountId: AccountID2;
   date: Date;
@@ -658,6 +663,7 @@ export type AggregationServiceID1 = string | null;
 export type TransactionLink = Common7 & {
   sourceTransactionId: SourceTransactionID;
   destinationTransactionId: DestinationTransactionID;
+  isSameSign: IsSameSign1;
 };
 /**
  * UUID for the item
@@ -687,6 +693,10 @@ export type SourceTransactionID = string;
  * UUID of the destination transaction in the link.
  */
 export type DestinationTransactionID = string;
+/**
+ * Whether the linked transactions are expected to have matching signs. When false, the linked transactions are expected to have opposite signs.
+ */
+export type IsSameSign1 = boolean;
 /**
  * Defines a split within a transaction.
  */
@@ -1030,6 +1040,7 @@ export interface Common {
 export type RecurringTransactionLink = Common & {
   sourceRecurringTransactionId: SourceRecurringTransactionID;
   destinationRecurringTransactionId: DestinationRecurringTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -1059,6 +1070,10 @@ export type SourceRecurringTransactionID = string;
  * UUID of the destination recurring transaction in the link.
  */
 export type DestinationRecurringTransactionID = string;
+/**
+ * Whether the linked recurring transactions are expected to have matching signs. When false, the linked recurring transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 
 /**
  * Common properties for all schemas
@@ -1257,6 +1272,7 @@ export interface Common {
 export type TransactionLink = Common & {
   sourceTransactionId: SourceTransactionID;
   destinationTransactionId: DestinationTransactionID;
+  isSameSign: IsSameSign;
 };
 /**
  * UUID for the item
@@ -1286,6 +1302,10 @@ export type SourceTransactionID = string;
  * UUID of the destination transaction in the link.
  */
 export type DestinationTransactionID = string;
+/**
+ * Whether the linked transactions are expected to have matching signs. When false, the linked transactions are expected to have opposite signs.
+ */
+export type IsSameSign = boolean;
 
 /**
  * Common properties for all schemas

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luca-financial/luca-schema",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Schemas for the Luca Ledger application",
   "author": "Johnathan Aspinwall",
   "main": "dist/esm/index.js",