@luca-financial/luca-schema 2.0.0 → 2.1.0

package/README.md

@@ -11,34 +11,25 @@ npm install @luca-financial/luca-schema
 ## Usage
 
 ```typescript
-import { lucaValidator, enums, schemas } from '@luca-financial/luca-schema';
+import { validate } from '@luca-financial/luca-schema';
 
-// Validate a transaction
-const validateTransaction = lucaValidator.getSchema('transaction');
 const transactionData = {
   id: '123e4567-e89b-12d3-a456-426614174000',
-  payorId: '123e4567-e89b-12d3-a456-426614174001',
-  payeeId: '123e4567-e89b-12d3-a456-426614174002',
-  categoryId: '123e4567-e89b-12d3-a456-426614174003',
-  amount: 100.5,
+  accountId: '123e4567-e89b-12d3-a456-426614174001',
+  categoryId: null,
+  statementId: null,
+  amount: -2599,
   date: '2024-01-01',
   description: 'Test transaction',
-  transactionState: enums.TransactionStateEnum.COMPLETED,
+  transactionState: 'COMPLETED',
   createdAt: '2024-01-01T00:00:00Z',
   updatedAt: null
 };
 
-const isValid = validateTransaction(transactionData);
-
-if (!isValid) {
-  console.error('Validation errors:', validateTransaction.errors);
+const result = validate('transaction', transactionData);
+if (!result.valid) {
+  console.error('Validation errors:', result.errors);
 }
-
-// Alternative: Use schemas directly with the validate method
-const isValidDirect = lucaValidator.validate(
-  schemas.transaction,
-  transactionData
-);
 ```
 
 ## Available Schemas
@@ -50,9 +41,9 @@ Validates financial transactions with properties like amount, date, and state.
 ```typescript
 const transaction = {
   id: string;
-  payorId: string;
-  payeeId: string;
+  accountId: string;
   categoryId: string | null;
+  statementId: string | null;
   amount: number;
   date: string;
   description: string;
@@ -69,8 +60,7 @@ Validates recurring transaction templates with frequency and interval settings.
 ```typescript
 const recurringTransaction = {
   id: string;
-  payorId: string;
-  payeeId: string;
+  accountId: string;
   categoryId: string | null;
   amount: number;
   description: string;
@@ -85,22 +75,6 @@ const recurringTransaction = {
 };
 ```
 
-### Entity
-
-Validates financial entities like accounts, retailers, or individuals.
-
-```typescript
-const entity = {
-  id: string;
-  name: string;
-  description: string | null;
-  entityType: 'ACCOUNT' | 'RETAILER' | 'SERVICE' | 'INDIVIDUAL' | 'UTILITY' | 'GOVERNMENT';
-  entityStatus: 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'DELETED' | 'CLOSED';
-  createdAt: string;
-  updatedAt: string | null;
-};
-```
-
 ### Category
 
 Validates transaction categories with optional parent relationships.
@@ -108,11 +82,10 @@ Validates transaction categories with optional parent relationships.
 ```typescript
 const category = {
   id: string;
+  slug: string;
   name: string;
   description: string | null;
   parentId: string | null;
-  defaultCategoryId: string | null;
-  categoryType: 'DEFAULT' | 'MODIFIED' | 'CUSTOM';
   createdAt: string;
   updatedAt: string | null;
 };
@@ -134,6 +107,26 @@ const recurringTransactionEvent = {
 };
 ```
 
+### Statement
+
+Validates credit card statements with balances in integer minor units.
+
+```typescript
+const statement = {
+  id: string;
+  accountId: string;
+  startDate: string;
+  endDate: string;
+  startingBalance: number;
+  endingBalance: number;
+  totalCharges: number;
+  totalPayments: number;
+  status: 'draft' | 'current' | 'past' | 'locked';
+  createdAt: string;
+  updatedAt: string | null;
+};
+```
+
 ## Development
 
 ```bash

package/dist/esm/index.d.ts

@@ -213,6 +213,13 @@ export type RecurringTransactionState = 'ACTIVE' | 'PAUSED' | 'COMPLETED' | 'CAN
  * via the `definition` "RecurringTransactionEventStatus".
  */
 export type RecurringTransactionEventStatus = 'MODIFIED' | 'DELETED';
+/**
+ * Allowed statuses for statements
+ *
+ * This interface was referenced by `LucaSchemaEnums`'s JSON-Schema
+ * via the `definition` "StatementStatus".
+ */
+export type StatementStatus = 'draft' | 'current' | 'past' | 'locked';
 
 /**
  * Shared enumerations for Luca Schema objects
@@ -336,10 +343,74 @@ export type APR = number | null;
  */
 export type ClosedAt = string | null;
 /**
- * Defines recurring financial transactions within the application.
+ * Defines the schema for credit card statements.
  */
-export type RecurringTransaction = Common2 & {
+export type Statement = Common2 & {
   accountId: AccountID;
+  startDate: StartDate;
+  endDate: EndDate;
+  startingBalance: StartingBalance;
+  endingBalance: EndingBalance;
+  totalCharges: TotalCharges;
+  totalPayments: TotalPayments;
+  /**
+   * Allowed statuses for statements
+   */
+  status: 'draft' | 'current' | 'past' | 'locked';
+};
+/**
+ * UUID for the item
+ */
+export type ID2 = string;
+/**
+ * The timestamp of the creation of the item
+ */
+export type DateCreated2 = string;
+/**
+ * The timestamp of the last update or null if the item has not been updated yet
+ */
+export type LastUpdated2 = string | null;
+/**
+ * The timestamp of when the item was soft-deleted
+ */
+export type DateDeleted2 = string | null;
+/**
+ * Version number for optimistic concurrency control
+ */
+export type Version2 = number;
+/**
+ * ID of the account this statement belongs to
+ */
+export type AccountID = string;
+/**
+ * Statement start date (inclusive) in YYYY-MM-DD format
+ */
+export type StartDate = string;
+/**
+ * Statement end date (inclusive) in YYYY-MM-DD format
+ */
+export type EndDate = string;
+/**
+ * Balance carried into this statement period in integer minor units
+ */
+export type StartingBalance = number;
+/**
+ * Balance at the end of this statement period in integer minor units
+ */
+export type EndingBalance = number;
+/**
+ * Sum of all charges during the statement period in integer minor units
+ */
+export type TotalCharges = number;
+/**
+ * Sum of all payments/credits during the statement period in integer minor units
+ */
+export type TotalPayments = number;
+/**
+ * Defines recurring financial transactions within the application.
+ */
+export type RecurringTransaction = Common3 & {
+  accountId: AccountID1;
   categoryId?: CategoryID;
   amount: Amount;
   description: Description1;
@@ -349,8 +420,8 @@ export type RecurringTransaction = Common2 & {
   frequency: 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
   interval: FrequencyInterval;
   occurrences?: TotalOccurrences;
-  startOn: StartDate;
-  endOn?: EndDate;
+  startOn: StartDate1;
+  endOn?: EndDate1;
   /**
    * Allowed states for recurring transactions
    */
@@ -359,33 +430,33 @@ export type RecurringTransaction = Common2 & {
 /**
  * UUID for the item
  */
-export type ID2 = string;
+export type ID3 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated2 = string;
+export type DateCreated3 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated2 = string | null;
+export type LastUpdated3 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted2 = string | null;
+export type DateDeleted3 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version2 = number;
+export type Version3 = number;
 /**
  * ID of the account this transaction belongs to
  */
-export type AccountID = string;
+export type AccountID1 = string;
 /**
  * Category identifier for organizing the transaction. Can be null if not categorized.
  */
 export type CategoryID = string | null;
 /**
- * The monetary value of the transaction.
+ * The monetary value in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -403,15 +474,15 @@ export type TotalOccurrences = number | null;
 /**
  * The date on which the recurring transaction series should begin.
  */
-export type StartDate = string;
+export type StartDate1 = string;
 /**
  * The date on which the recurring transaction series should end. Can be null.
  */
-export type EndDate = string | null;
+export type EndDate1 = string | null;
 /**
  * Manages occurrences of recurring transactions, including tracking their modifications or logical deletions. 'transactionId' is required when an occurrence is modified to link it to an actual transaction.
  */
-export type RecurringTransactionEvent = Common3 & {
+export type RecurringTransactionEvent = Common4 & {
   transactionId?: AssociatedTransactionID;
   recurringTransactionId?: RecurringTransactionID;
   expectedDate?: ExpectedDate;
@@ -432,23 +503,23 @@ export type RecurringTransactionEvent = Common3 & {
 /**
  * UUID for the item
  */
-export type ID3 = string;
+export type ID4 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated3 = string;
+export type DateCreated4 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated3 = string | null;
+export type LastUpdated4 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted3 = string | null;
+export type DateDeleted4 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version3 = number;
+export type Version4 = number;
 /**
  * Identifier of the actual transaction when the occurrence is modified; must be null when deleted.
  */
@@ -461,8 +532,8 @@ export type RecurringTransactionID = string;
  * The date when the occurrence is expected.
  */
 export type ExpectedDate = string;
-export type Transaction = Common4 & {
-  accountId: AccountID1;
+export type Transaction = Common5 & {
+  accountId: AccountID2;
   date: Date;
   authorizedAt?: AuthorizedAt;
   postedAt?: PostedAt;
@@ -472,6 +543,7 @@ export type Transaction = Common4 & {
   memo?: Memo;
   counterparty?: Counterparty;
   categoryId?: CategoryID1;
+  statementId?: StatementID;
   aggregationServiceId?: AggregationServiceID1;
   /**
    * Allowed transaction lifecycle states
@@ -492,27 +564,27 @@ export type Transaction = Common4 & {
 /**
  * UUID for the item
  */
-export type ID4 = string;
+export type ID5 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated4 = string;
+export type DateCreated5 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated4 = string | null;
+export type LastUpdated5 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted4 = string | null;
+export type DateDeleted5 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version4 = number;
+export type Version5 = number;
 /**
  * ID of the account this transaction belongs to
  */
-export type AccountID1 = string;
+export type AccountID2 = string;
 /**
  * Date of the transaction in YYYY-MM-DD format
  */
@@ -530,7 +602,7 @@ export type PostedAt = string | null;
  */
 export type Currency = string | null;
 /**
- * Transaction amount (can be positive or negative)
+ * Transaction amount in integer minor units. Can be positive or negative.
  */
 export type Amount1 = number;
 /**
@@ -549,6 +621,10 @@ export type Counterparty = string | null;
  * Category UUID for this transaction
  */
 export type CategoryID1 = string | null;
+/**
+ * Statement UUID for this transaction
+ */
+export type StatementID = string | null;
 /**
  * Identifier for this transaction in a financial data aggregation service.
  */
@@ -560,7 +636,7 @@ export type DeletedAt = string | null;
 /**
  * Defines a split within a transaction.
  */
-export type TransactionSplit = Common5 & {
+export type TransactionSplit = Common6 & {
   transactionId: TransactionID;
   amount: Amount2;
   categoryId: CategoryID2;
@@ -570,29 +646,29 @@ export type TransactionSplit = Common5 & {
 /**
  * UUID for the item
  */
-export type ID5 = string;
+export type ID6 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated5 = string;
+export type DateCreated6 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated5 = string | null;
+export type LastUpdated6 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted5 = string | null;
+export type DateDeleted6 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version5 = number;
+export type Version6 = number;
 /**
  * The identifier of the parent transaction.
  */
 export type TransactionID = string;
 /**
- * The amount allocated to this split (must be non-zero; can be positive or negative).
+ * The amount allocated to this split in integer minor units. Must be greater than 0.
  */
 export type Amount2 = number;
 /**
@@ -624,6 +700,10 @@ export interface LucaSchema {
    * List of accounts
    */
   accounts: Account[];
+  /**
+   * List of statements
+   */
+  statements: Statement[];
   /**
    * List of recurring transactions
    */
@@ -701,6 +781,16 @@ export interface Common5 {
   deletedAt?: DateDeleted5;
   version?: Version5;
 }
+/**
+ * Common properties for all schemas
+ */
+export interface Common6 {
+  id: ID6;
+  createdAt: DateCreated6;
+  updatedAt: LastUpdated6;
+  deletedAt?: DateDeleted6;
+  version?: Version6;
+}
 
 /**
  * Defines recurring financial transactions within the application.
@@ -752,7 +842,7 @@ export type AccountID = string;
  */
 export type CategoryID = string | null;
 /**
- * The monetary value of the transaction.
+ * The monetary value in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -852,6 +942,82 @@ export interface Common {
   version?: Version;
 }
 
+/**
+ * Defines the schema for credit card statements.
+ */
+export type Statement = Common & {
+  accountId: AccountID;
+  startDate: StartDate;
+  endDate: EndDate;
+  startingBalance: StartingBalance;
+  endingBalance: EndingBalance;
+  totalCharges: TotalCharges;
+  totalPayments: TotalPayments;
+  /**
+   * Allowed statuses for statements
+   */
+  status: 'draft' | 'current' | 'past' | 'locked';
+};
+/**
+ * UUID for the item
+ */
+export type ID = string;
+/**
+ * The timestamp of the creation of the item
+ */
+export type DateCreated = string;
+/**
+ * The timestamp of the last update or null if the item has not been updated yet
+ */
+export type LastUpdated = string | null;
+/**
+ * The timestamp of when the item was soft-deleted
+ */
+export type DateDeleted = string | null;
+/**
+ * Version number for optimistic concurrency control
+ */
+export type Version = number;
+/**
+ * ID of the account this statement belongs to
+ */
+export type AccountID = string;
+/**
+ * Statement start date (inclusive) in YYYY-MM-DD format
+ */
+export type StartDate = string;
+/**
+ * Statement end date (inclusive) in YYYY-MM-DD format
+ */
+export type EndDate = string;
+/**
+ * Balance carried into this statement period in integer minor units
+ */
+export type StartingBalance = number;
+/**
+ * Balance at the end of this statement period in integer minor units
+ */
+export type EndingBalance = number;
+/**
+ * Sum of all charges during the statement period in integer minor units
+ */
+export type TotalCharges = number;
+/**
+ * Sum of all payments/credits during the statement period in integer minor units
+ */
+export type TotalPayments = number;
+
+/**
+ * Common properties for all schemas
+ */
+export interface Common {
+  id: ID;
+  createdAt: DateCreated;
+  updatedAt: LastUpdated;
+  deletedAt?: DateDeleted;
+  version?: Version;
+}
+
 export type Transaction = Common & {
   accountId: AccountID;
   date: Date;
@@ -863,6 +1029,7 @@ export type Transaction = Common & {
   memo?: Memo;
   counterparty?: Counterparty;
   categoryId?: CategoryID;
+  statementId?: StatementID;
   aggregationServiceId?: AggregationServiceID;
   /**
    * Allowed transaction lifecycle states
@@ -921,7 +1088,7 @@ export type PostedAt = string | null;
  */
 export type Currency = string | null;
 /**
- * Transaction amount (can be positive or negative)
+ * Transaction amount in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -940,6 +1107,10 @@ export type Counterparty = string | null;
  * Category UUID for this transaction
  */
 export type CategoryID = string | null;
+/**
+ * Statement UUID for this transaction
+ */
+export type StatementID = string | null;
 /**
  * Identifier for this transaction in a financial data aggregation service.
  */
@@ -995,7 +1166,7 @@ export type Version = number;
  */
 export type TransactionID = string;
 /**
- * The amount allocated to this split (must be non-zero; can be positive or negative).
+ * The amount allocated to this split in integer minor units. Must be greater than 0.
  */
 export type Amount = number;
 /**

package/dist/esm/index.js

@@ -7,6 +7,7 @@ const schemas = { ...schemaIndex, enums: schemaIndex.enums };
 export const accountSchema = schemas.account;
 export const categorySchema = schemas.category;
 export const lucaSchema = schemas.lucaSchema;
+export const statementSchema = schemas.statement;
 export const recurringTransactionSchema = schemas.recurringTransaction;
 export const recurringTransactionEventSchema =
   schemas.recurringTransactionEvent;

package/dist/esm/lucaValidator.js

@@ -5,6 +5,7 @@ import categorySchemaJson from './schemas/category.json' with { type: 'json' };
 import commonSchemaJson from './schemas/common.json' with { type: 'json' };
 import enumsSchemaJson from './schemas/enums.json' with { type: 'json' };
 import lucaSchemaJson from './schemas/lucaSchema.json' with { type: 'json' };
+import statementSchemaJson from './schemas/statement.json' with { type: 'json' };
 import recurringTransactionSchemaJson from './schemas/recurringTransaction.json' with { type: 'json' };
 import recurringTransactionEventSchemaJson from './schemas/recurringTransactionEvent.json' with { type: 'json' };
 import transactionSchemaJson from './schemas/transaction.json' with { type: 'json' };
@@ -14,6 +15,7 @@ const schemas = {
   account: accountSchemaJson,
   category: categorySchemaJson,
   lucaSchema: lucaSchemaJson,
+  statement: statementSchemaJson,
   recurringTransaction: recurringTransactionSchemaJson,
   recurringTransactionEvent: recurringTransactionEventSchemaJson,
   transaction: transactionSchemaJson,

package/dist/esm/schemas/enums.json

@@ -7,6 +7,7 @@
     "ACCOUNT": "account",
     "CATEGORY": "category",
     "LUCASCHEMA": "lucaSchema",
+    "STATEMENT": "statement",
     "RECURRING_TRANSACTION": "recurringTransaction",
     "RECURRING_TRANSACTION_EVENT": "recurringTransactionEvent",
     "TRANSACTION": "transaction",
@@ -48,6 +49,11 @@
       "type": "string",
       "enum": ["MODIFIED", "DELETED"],
       "description": "Allowed statuses for recurring transaction events"
+    },
+    "StatementStatus": {
+      "type": "string",
+      "enum": ["draft", "current", "past", "locked"],
+      "description": "Allowed statuses for statements"
     }
   }
 }

package/dist/esm/schemas/index.js

@@ -2,6 +2,7 @@ import account from './account.json' with { type: 'json' };
 import category from './category.json' with { type: 'json' };
 import common from './common.json' with { type: 'json' };
 import lucaSchema from './lucaSchema.json' with { type: 'json' };
+import statement from './statement.json' with { type: 'json' };
 import recurringTransaction from './recurringTransaction.json' with { type: 'json' };
 import recurringTransactionEvent from './recurringTransactionEvent.json' with { type: 'json' };
 import transaction from './transaction.json' with { type: 'json' };
@@ -13,6 +14,7 @@ export {
   category,
   common,
   lucaSchema,
+  statement,
   recurringTransaction,
   recurringTransactionEvent,
   transaction,
@@ -25,6 +27,7 @@ export default {
   category,
   common,
   lucaSchema,
+  statement,
   recurringTransaction,
   recurringTransactionEvent,
   transaction,

package/dist/esm/schemas/lucaSchema.json

@@ -8,6 +8,7 @@
     "schemaVersion",
     "categories",
     "accounts",
+    "statements",
     "recurringTransactions",
     "recurringTransactionEvents",
     "transactions",
@@ -34,6 +35,14 @@
         "$ref": "./account.json"
       }
     },
+    "statements": {
+      "type": "array",
+      "description": "List of statements",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./statement.json"
+      }
+    },
     "recurringTransactions": {
       "type": "array",
       "description": "List of recurring transactions",

package/dist/esm/schemas/recurringTransaction.json

@@ -23,9 +23,9 @@
       "description": "Category identifier for organizing the transaction. Can be null if not categorized."
     },
     "amount": {
-      "type": "number",
+      "type": "integer",
       "title": "Amount",
-      "description": "The monetary value of the transaction."
+      "description": "The monetary value in integer minor units. Can be positive or negative."
     },
     "description": {
       "type": "string",

package/dist/esm/schemas/statement.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/statement.json",
+  "title": "Statement",
+  "description": "Defines the schema for credit card statements.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "./common.json"
+    }
+  ],
+  "properties": {
+    "accountId": {
+      "type": "string",
+      "title": "Account ID",
+      "format": "uuid",
+      "description": "ID of the account this statement belongs to"
+    },
+    "startDate": {
+      "type": "string",
+      "title": "Start Date",
+      "format": "date",
+      "description": "Statement start date (inclusive) in YYYY-MM-DD format"
+    },
+    "endDate": {
+      "type": "string",
+      "title": "End Date",
+      "format": "date",
+      "description": "Statement end date (inclusive) in YYYY-MM-DD format"
+    },
+    "startingBalance": {
+      "type": "integer",
+      "title": "Starting Balance",
+      "description": "Balance carried into this statement period in integer minor units"
+    },
+    "endingBalance": {
+      "type": "integer",
+      "title": "Ending Balance",
+      "description": "Balance at the end of this statement period in integer minor units"
+    },
+    "totalCharges": {
+      "type": "integer",
+      "title": "Total Charges",
+      "minimum": 0,
+      "description": "Sum of all charges during the statement period in integer minor units"
+    },
+    "totalPayments": {
+      "type": "integer",
+      "title": "Total Payments",
+      "minimum": 0,
+      "description": "Sum of all payments/credits during the statement period in integer minor units"
+    },
+    "status": {
+      "type": "string",
+      "title": "Statement Status",
+      "$ref": "./enums.json#/$defs/StatementStatus",
+      "description": "Current status of the statement"
+    }
+  },
+  "required": [
+    "accountId",
+    "startDate",
+    "endDate",
+    "startingBalance",
+    "endingBalance",
+    "totalCharges",
+    "totalPayments",
+    "status"
+  ]
+}

package/dist/esm/schemas/transaction.json

@@ -42,9 +42,9 @@
       "description": "ISO 4217 currency code for the transaction."
     },
     "amount": {
-      "type": "number",
+      "type": "integer",
       "title": "Amount",
-      "description": "Transaction amount (can be positive or negative)"
+      "description": "Transaction amount in integer minor units. Can be positive or negative."
     },
     "description": {
       "type": "string",
@@ -68,6 +68,12 @@
       "format": "uuid",
       "description": "Category UUID for this transaction"
     },
+    "statementId": {
+      "type": ["string", "null"],
+      "title": "Statement ID",
+      "format": "uuid",
+      "description": "Statement UUID for this transaction"
+    },
     "aggregationServiceId": {
       "type": ["string", "null"],
       "title": "Aggregation Service ID",

package/dist/esm/schemas/transactionSplit.json

@@ -17,10 +17,10 @@
       "description": "The identifier of the parent transaction."
     },
     "amount": {
-      "type": "number",
+      "type": "integer",
       "title": "Amount",
-      "exclusiveMinimum": 0,
-      "description": "The amount allocated to this split (must be non-zero; can be positive or negative)."
+      "minimum": 1,
+      "description": "The amount allocated to this split in integer minor units. Must be greater than 0."
     },
     "categoryId": {
       "type": ["string", "null"],

package/dist/index.d.ts

@@ -213,6 +213,13 @@ export type RecurringTransactionState = 'ACTIVE' | 'PAUSED' | 'COMPLETED' | 'CAN
  * via the `definition` "RecurringTransactionEventStatus".
  */
 export type RecurringTransactionEventStatus = 'MODIFIED' | 'DELETED';
+/**
+ * Allowed statuses for statements
+ *
+ * This interface was referenced by `LucaSchemaEnums`'s JSON-Schema
+ * via the `definition` "StatementStatus".
+ */
+export type StatementStatus = 'draft' | 'current' | 'past' | 'locked';
 
 /**
  * Shared enumerations for Luca Schema objects
@@ -336,10 +343,74 @@ export type APR = number | null;
  */
 export type ClosedAt = string | null;
 /**
- * Defines recurring financial transactions within the application.
+ * Defines the schema for credit card statements.
  */
-export type RecurringTransaction = Common2 & {
+export type Statement = Common2 & {
   accountId: AccountID;
+  startDate: StartDate;
+  endDate: EndDate;
+  startingBalance: StartingBalance;
+  endingBalance: EndingBalance;
+  totalCharges: TotalCharges;
+  totalPayments: TotalPayments;
+  /**
+   * Allowed statuses for statements
+   */
+  status: 'draft' | 'current' | 'past' | 'locked';
+};
+/**
+ * UUID for the item
+ */
+export type ID2 = string;
+/**
+ * The timestamp of the creation of the item
+ */
+export type DateCreated2 = string;
+/**
+ * The timestamp of the last update or null if the item has not been updated yet
+ */
+export type LastUpdated2 = string | null;
+/**
+ * The timestamp of when the item was soft-deleted
+ */
+export type DateDeleted2 = string | null;
+/**
+ * Version number for optimistic concurrency control
+ */
+export type Version2 = number;
+/**
+ * ID of the account this statement belongs to
+ */
+export type AccountID = string;
+/**
+ * Statement start date (inclusive) in YYYY-MM-DD format
+ */
+export type StartDate = string;
+/**
+ * Statement end date (inclusive) in YYYY-MM-DD format
+ */
+export type EndDate = string;
+/**
+ * Balance carried into this statement period in integer minor units
+ */
+export type StartingBalance = number;
+/**
+ * Balance at the end of this statement period in integer minor units
+ */
+export type EndingBalance = number;
+/**
+ * Sum of all charges during the statement period in integer minor units
+ */
+export type TotalCharges = number;
+/**
+ * Sum of all payments/credits during the statement period in integer minor units
+ */
+export type TotalPayments = number;
+/**
+ * Defines recurring financial transactions within the application.
+ */
+export type RecurringTransaction = Common3 & {
+  accountId: AccountID1;
   categoryId?: CategoryID;
   amount: Amount;
   description: Description1;
@@ -349,8 +420,8 @@ export type RecurringTransaction = Common2 & {
   frequency: 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
   interval: FrequencyInterval;
   occurrences?: TotalOccurrences;
-  startOn: StartDate;
-  endOn?: EndDate;
+  startOn: StartDate1;
+  endOn?: EndDate1;
   /**
    * Allowed states for recurring transactions
    */
@@ -359,33 +430,33 @@ export type RecurringTransaction = Common2 & {
 /**
  * UUID for the item
  */
-export type ID2 = string;
+export type ID3 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated2 = string;
+export type DateCreated3 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated2 = string | null;
+export type LastUpdated3 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted2 = string | null;
+export type DateDeleted3 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version2 = number;
+export type Version3 = number;
 /**
  * ID of the account this transaction belongs to
  */
-export type AccountID = string;
+export type AccountID1 = string;
 /**
  * Category identifier for organizing the transaction. Can be null if not categorized.
  */
 export type CategoryID = string | null;
 /**
- * The monetary value of the transaction.
+ * The monetary value in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -403,15 +474,15 @@ export type TotalOccurrences = number | null;
 /**
  * The date on which the recurring transaction series should begin.
  */
-export type StartDate = string;
+export type StartDate1 = string;
 /**
  * The date on which the recurring transaction series should end. Can be null.
  */
-export type EndDate = string | null;
+export type EndDate1 = string | null;
 /**
  * Manages occurrences of recurring transactions, including tracking their modifications or logical deletions. 'transactionId' is required when an occurrence is modified to link it to an actual transaction.
  */
-export type RecurringTransactionEvent = Common3 & {
+export type RecurringTransactionEvent = Common4 & {
   transactionId?: AssociatedTransactionID;
   recurringTransactionId?: RecurringTransactionID;
   expectedDate?: ExpectedDate;
@@ -432,23 +503,23 @@ export type RecurringTransactionEvent = Common3 & {
 /**
  * UUID for the item
  */
-export type ID3 = string;
+export type ID4 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated3 = string;
+export type DateCreated4 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated3 = string | null;
+export type LastUpdated4 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted3 = string | null;
+export type DateDeleted4 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version3 = number;
+export type Version4 = number;
 /**
  * Identifier of the actual transaction when the occurrence is modified; must be null when deleted.
  */
@@ -461,8 +532,8 @@ export type RecurringTransactionID = string;
  * The date when the occurrence is expected.
  */
 export type ExpectedDate = string;
-export type Transaction = Common4 & {
-  accountId: AccountID1;
+export type Transaction = Common5 & {
+  accountId: AccountID2;
   date: Date;
   authorizedAt?: AuthorizedAt;
   postedAt?: PostedAt;
@@ -472,6 +543,7 @@ export type Transaction = Common4 & {
   memo?: Memo;
   counterparty?: Counterparty;
   categoryId?: CategoryID1;
+  statementId?: StatementID;
   aggregationServiceId?: AggregationServiceID1;
   /**
    * Allowed transaction lifecycle states
@@ -492,27 +564,27 @@ export type Transaction = Common4 & {
 /**
  * UUID for the item
  */
-export type ID4 = string;
+export type ID5 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated4 = string;
+export type DateCreated5 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated4 = string | null;
+export type LastUpdated5 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted4 = string | null;
+export type DateDeleted5 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version4 = number;
+export type Version5 = number;
 /**
  * ID of the account this transaction belongs to
  */
-export type AccountID1 = string;
+export type AccountID2 = string;
 /**
  * Date of the transaction in YYYY-MM-DD format
  */
@@ -530,7 +602,7 @@ export type PostedAt = string | null;
  */
 export type Currency = string | null;
 /**
- * Transaction amount (can be positive or negative)
+ * Transaction amount in integer minor units. Can be positive or negative.
  */
 export type Amount1 = number;
 /**
@@ -549,6 +621,10 @@ export type Counterparty = string | null;
  * Category UUID for this transaction
  */
 export type CategoryID1 = string | null;
+/**
+ * Statement UUID for this transaction
+ */
+export type StatementID = string | null;
 /**
  * Identifier for this transaction in a financial data aggregation service.
  */
@@ -560,7 +636,7 @@ export type DeletedAt = string | null;
 /**
  * Defines a split within a transaction.
  */
-export type TransactionSplit = Common5 & {
+export type TransactionSplit = Common6 & {
   transactionId: TransactionID;
   amount: Amount2;
   categoryId: CategoryID2;
@@ -570,29 +646,29 @@ export type TransactionSplit = Common5 & {
 /**
  * UUID for the item
  */
-export type ID5 = string;
+export type ID6 = string;
 /**
  * The timestamp of the creation of the item
  */
-export type DateCreated5 = string;
+export type DateCreated6 = string;
 /**
  * The timestamp of the last update or null if the item has not been updated yet
  */
-export type LastUpdated5 = string | null;
+export type LastUpdated6 = string | null;
 /**
  * The timestamp of when the item was soft-deleted
  */
-export type DateDeleted5 = string | null;
+export type DateDeleted6 = string | null;
 /**
  * Version number for optimistic concurrency control
  */
-export type Version5 = number;
+export type Version6 = number;
 /**
  * The identifier of the parent transaction.
  */
 export type TransactionID = string;
 /**
- * The amount allocated to this split (must be non-zero; can be positive or negative).
+ * The amount allocated to this split in integer minor units. Must be greater than 0.
  */
 export type Amount2 = number;
 /**
@@ -624,6 +700,10 @@ export interface LucaSchema {
    * List of accounts
    */
   accounts: Account[];
+  /**
+   * List of statements
+   */
+  statements: Statement[];
   /**
    * List of recurring transactions
    */
@@ -701,6 +781,16 @@ export interface Common5 {
   deletedAt?: DateDeleted5;
   version?: Version5;
 }
+/**
+ * Common properties for all schemas
+ */
+export interface Common6 {
+  id: ID6;
+  createdAt: DateCreated6;
+  updatedAt: LastUpdated6;
+  deletedAt?: DateDeleted6;
+  version?: Version6;
+}
 
 /**
  * Defines recurring financial transactions within the application.
@@ -752,7 +842,7 @@ export type AccountID = string;
  */
 export type CategoryID = string | null;
 /**
- * The monetary value of the transaction.
+ * The monetary value in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -852,6 +942,82 @@ export interface Common {
   version?: Version;
 }
 
+/**
+ * Defines the schema for credit card statements.
+ */
+export type Statement = Common & {
+  accountId: AccountID;
+  startDate: StartDate;
+  endDate: EndDate;
+  startingBalance: StartingBalance;
+  endingBalance: EndingBalance;
+  totalCharges: TotalCharges;
+  totalPayments: TotalPayments;
+  /**
+   * Allowed statuses for statements
+   */
+  status: 'draft' | 'current' | 'past' | 'locked';
+};
+/**
+ * UUID for the item
+ */
+export type ID = string;
+/**
+ * The timestamp of the creation of the item
+ */
+export type DateCreated = string;
+/**
+ * The timestamp of the last update or null if the item has not been updated yet
+ */
+export type LastUpdated = string | null;
+/**
+ * The timestamp of when the item was soft-deleted
+ */
+export type DateDeleted = string | null;
+/**
+ * Version number for optimistic concurrency control
+ */
+export type Version = number;
+/**
+ * ID of the account this statement belongs to
+ */
+export type AccountID = string;
+/**
+ * Statement start date (inclusive) in YYYY-MM-DD format
+ */
+export type StartDate = string;
+/**
+ * Statement end date (inclusive) in YYYY-MM-DD format
+ */
+export type EndDate = string;
+/**
+ * Balance carried into this statement period in integer minor units
+ */
+export type StartingBalance = number;
+/**
+ * Balance at the end of this statement period in integer minor units
+ */
+export type EndingBalance = number;
+/**
+ * Sum of all charges during the statement period in integer minor units
+ */
+export type TotalCharges = number;
+/**
+ * Sum of all payments/credits during the statement period in integer minor units
+ */
+export type TotalPayments = number;
+
+/**
+ * Common properties for all schemas
+ */
+export interface Common {
+  id: ID;
+  createdAt: DateCreated;
+  updatedAt: LastUpdated;
+  deletedAt?: DateDeleted;
+  version?: Version;
+}
+
 export type Transaction = Common & {
   accountId: AccountID;
   date: Date;
@@ -863,6 +1029,7 @@ export type Transaction = Common & {
   memo?: Memo;
   counterparty?: Counterparty;
   categoryId?: CategoryID;
+  statementId?: StatementID;
   aggregationServiceId?: AggregationServiceID;
   /**
    * Allowed transaction lifecycle states
@@ -921,7 +1088,7 @@ export type PostedAt = string | null;
  */
 export type Currency = string | null;
 /**
- * Transaction amount (can be positive or negative)
+ * Transaction amount in integer minor units. Can be positive or negative.
  */
 export type Amount = number;
 /**
@@ -940,6 +1107,10 @@ export type Counterparty = string | null;
  * Category UUID for this transaction
  */
 export type CategoryID = string | null;
+/**
+ * Statement UUID for this transaction
+ */
+export type StatementID = string | null;
 /**
  * Identifier for this transaction in a financial data aggregation service.
  */
@@ -995,7 +1166,7 @@ export type Version = number;
  */
 export type TransactionID = string;
 /**
- * The amount allocated to this split (must be non-zero; can be positive or negative).
+ * The amount allocated to this split in integer minor units. Must be greater than 0.
  */
 export type Amount = number;
 /**

package/package.json

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