@luca-financial/luca-schema 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Luca Financial
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# LucaSchema
+Schema for the Luca Ledger application

package/dist/cjs/index.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "schemas", {
+  enumerable: true,
+  get: function get() {
+    return _schemas["default"];
+  }
+});
+Object.defineProperty(exports, "validators", {
+  enumerable: true,
+  get: function get() {
+    return _validators["default"];
+  }
+});
+var _schemas = _interopRequireDefault(require("./schemas.js"));
+var _validators = _interopRequireDefault(require("./validators"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+//# sourceMappingURL=index.js.map

package/dist/cjs/schemas/category.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/category.json",
+  "title": "Category",
+  "description": "Defines the schema for categories used to organize transactions within a ledger application. Categories can be default, modified, or custom, providing flexibility in categorization.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the category."
+    },
+    "name": {
+      "type": "string",
+      "description": "The name of the category."
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "A description of the category, providing additional context. Can be null if not specified."
+    },
+    "parentId": {
+      "type": ["string", "null"],
+      "description": "The identifier of the parent category, if any. Null if the category is top-level."
+    },
+    "defaultCategoryId": {
+      "type": ["string", "null"],
+      "description": "For custom categories, this indicates the default category from which this was derived. Required if categoryType is CUSTOM."
+    },
+    "categoryType": {
+      "type": "string",
+      "enum": ["DEFAULT", "MODIFIED", "CUSTOM"],
+      "description": "The type of the category, indicating whether it is a default, modified, or custom category."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the category was created, in ISO 8601 format."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date and time when the category was last updated, in ISO 8601 format. Can be null if the category has never been updated."
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "description",
+    "parentId",
+    "defaultCategoryId",
+    "categoryType",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false,
+  "if": {
+    "properties": {
+      "categoryType": {
+        "const": "MODIFIED"
+      }
+    }
+  },
+  "then": {
+    "required": ["defaultCategoryId"]
+  }
+}

package/dist/cjs/schemas/entity.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/entity.json",
+  "title": "Entity",
+  "description": "Defines the schema for entities within the application, categorizing them into specific, predefined types such as account, retailer, business, individual, utility, and government. This schema includes basic details and timestamps for creation and updates.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "id": {
+      "type": "string",
+      "title": "ID",
+      "description": "A unique identifier for the entity."
+    },
+    "name": {
+      "type": "string",
+      "title": "Name",
+      "description": "The name of the entity."
+    },
+    "description": {
+      "type": ["string", "null"],
+      "title": "Description",
+      "description": "A description of the entity. This can be null if no description is provided."
+    },
+    "entityType": {
+      "type": "string",
+      "title": "Type",
+      "enum": [
+        "ACCOUNT",
+        "RETAILER",
+        "SERVICE",
+        "INDIVIDUAL",
+        "UTILITY",
+        "GOVERNMENT"
+      ],
+      "description": "The type of the entity, indicating its role or classification within the application. Controlled to specific predefined options for consistency and integrity."
+    },
+    "entityStatus": {
+      "type": "string",
+      "title": "Status",
+      "enum": ["ACTIVE", "INACTIVE", "SUSPENDED", "DELETED", "CLOSED"],
+      "description": "The status of the entity, indicating whether it is active, inactive, suspended, or deleted. Controlled to specific predefined options for consistency and integrity."
+    },
+    "createdAt": {
+      "type": "string",
+      "title": "Created At",
+      "format": "date-time",
+      "description": "The date and time when the entity was created, in ISO 8601 format."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "title": "Updated At",
+      "format": "date-time",
+      "description": "The date and time when the entity was last updated, in ISO 8601 format. This can be null if the entity has not been updated since creation."
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "description",
+    "entityType",
+    "entityStatus",
+    "createdAt",
+    "updatedAt"
+  ]
+}

package/dist/cjs/schemas/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _category = _interopRequireDefault(require("./category.json"));
+var _entity = _interopRequireDefault(require("./entity.json"));
+var _lucaSchema = _interopRequireDefault(require("./lucaSchema.json"));
+var _recurringTransaction = _interopRequireDefault(require("./recurringTransaction.json"));
+var _recurringTransactionEvent = _interopRequireDefault(require("./recurringTransactionEvent.json"));
+var _schema = _interopRequireDefault(require("./schema.json"));
+var _transaction = _interopRequireDefault(require("./transaction.json"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+var schemas = {
+  category: _category["default"],
+  entity: _entity["default"],
+  lucaSchema: _lucaSchema["default"],
+  recurringTransaction: _recurringTransaction["default"],
+  recurringTransactionEvent: _recurringTransactionEvent["default"],
+  schema: _schema["default"],
+  transaction: _transaction["default"]
+};
+var _default = exports["default"] = schemas;
+//# sourceMappingURL=index.js.map

package/dist/cjs/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_category","_interopRequireDefault","require","_entity","_lucaSchema","_recurringTransaction","_recurringTransactionEvent","_schema","_transaction","obj","__esModule","schemas","category","entity","lucaSchema","recurringTransaction","recurringTransactionEvent","schema","transaction","_default","exports"],"sources":["../../../src/schemas/index.js"],"sourcesContent":["import category from './category.json';\nimport entity from './entity.json';\nimport lucaSchema from './lucaSchema.json';\nimport recurringTransaction from './recurringTransaction.json';\nimport recurringTransactionEvent from './recurringTransactionEvent.json';\nimport schema from './schema.json';\nimport transaction from './transaction.json';\n\nconst schemas = {\n  category,\n  entity,\n  lucaSchema,\n  recurringTransaction,\n  recurringTransactionEvent,\n  schema,\n  transaction\n};\n\nexport default schemas;\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,WAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,qBAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,0BAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,OAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,YAAA,GAAAP,sBAAA,CAAAC,OAAA;AAA6C,SAAAD,uBAAAQ,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,gBAAAA,GAAA;AAE7C,IAAME,OAAO,GAAG;EACdC,QAAQ,EAARA,oBAAQ;EACRC,MAAM,EAANA,kBAAM;EACNC,UAAU,EAAVA,sBAAU;EACVC,oBAAoB,EAApBA,gCAAoB;EACpBC,yBAAyB,EAAzBA,qCAAyB;EACzBC,MAAM,EAANA,kBAAM;EACNC,WAAW,EAAXA;AACF,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,cAEaT,OAAO","ignoreList":[]}

package/dist/cjs/schemas/lucaSchema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/luca-schema.json",
+  "title": "Luca Schema",
+  "description": "Schema for the luca ledger",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "$ref": "./schema.json"
+    },
+    "categories": {
+      "type": "array",
+      "description": "List of categories",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./category.json"
+      }
+    },
+    "entities": {
+      "type": "array",
+      "description": "List of entities",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./entity.json"
+      }
+    },
+    "recurringTransactions": {
+      "type": "array",
+      "description": "List of recurring transactions",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./recurringTransaction.json"
+      }
+    },
+    "recurringTransactionEvents": {
+      "type": "array",
+      "description": "List of recurring transaction events",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./recurringTransactionEvent.json"
+      }
+    },
+    "transactions": {
+      "type": "array",
+      "description": "List of transactions",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./transaction.json"
+      }
+    }
+  },
+  "required": ["schema", "entities", "transactions"],
+  "additionalProperties": false
+}

package/dist/cjs/schemas/recurringTransaction.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/recurringTransaction.json",
+  "title": "Recurring Transaction",
+  "description": "Defines recurring financial transactions within the application, including their scheduling, frequency, interval, and optional constraints like total occurrences or an end date.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the transaction."
+    },
+    "payorId": {
+      "type": "string",
+      "description": "Identifier for the payor in the transaction."
+    },
+    "payeeId": {
+      "type": "string",
+      "description": "Identifier for the payee in the transaction."
+    },
+    "categoryId": {
+      "type": ["string", "null"],
+      "description": "Category identifier for organizing the transaction. Can be null if not categorized."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The monetary value of the transaction."
+    },
+    "frequency": {
+      "type": "string",
+      "enum": ["DAY", "WEEK", "MONTH", "YEAR"],
+      "description": "Defines the base unit of time for the repetition."
+    },
+    "interval": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Specifies the number of frequency units between each occurrence (e.g., every 2 weeks)."
+    },
+    "occurrences": {
+      "type": ["integer", "null"],
+      "minimum": 1,
+      "description": "The total number of times the transaction should occur. Can be null if not specified."
+    },
+    "startOn": {
+      "type": "string",
+      "format": "date",
+      "description": "The date on which the recurring transaction series should begin."
+    },
+    "endOn": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date on which the recurring transaction series should end. Can be null."
+    },
+    "description": {
+      "type": "string",
+      "description": "A detailed description of the transaction."
+    },
+    "recurringTransactionState": {
+      "type": "string",
+      "enum": ["ACTIVE", "PAUSED", "COMPLETED", "CANCELLED"],
+      "description": "Current state of the recurring transaction series."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of when the transaction was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Timestamp of the last update to the transaction. Can be null if not updated."
+    }
+  },
+  "required": [
+    "id",
+    "payorId",
+    "payeeId",
+    "categoryId",
+    "amount",
+    "frequency",
+    "interval",
+    "occurrences",
+    "startOn",
+    "endOn",
+    "description",
+    "recurringTransactionState",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/cjs/schemas/recurringTransactionEvent.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/recurringTransactionEvent.json",
+  "title": "Recurring Transaction Event",
+  "description": "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.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the occurrence record."
+    },
+    "transactionId": {
+      "type": ["string", "null"],
+      "description": "Identifier of the actual transaction, required if the occurrence is modified."
+    },
+    "recurringTransactionId": {
+      "type": "string",
+      "description": "Identifier of the associated recurring transaction."
+    },
+    "expectedDate": {
+      "type": "string",
+      "format": "date",
+      "description": "The date when the occurrence is expected."
+    },
+    "status": {
+      "type": "string",
+      "enum": ["MODIFIED", "DELETED"],
+      "description": "Status of the occurrence, indicating if it has been modified or logically deleted."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of when the occurrence was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Timestamp of the last update to the occurrence. Nullable to accommodate occurrences that have not been updated."
+    }
+  },
+  "required": [
+    "id",
+    "transactionId",
+    "recurringTransactionId",
+    "expectedDate",
+    "status",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false,
+  "if": {
+    "properties": { "status": { "const": "modified" } }
+  },
+  "then": {
+    "required": ["transactionId"]
+  }
+}

package/dist/cjs/schemas/schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/schema.json",
+  "title": "Schema",
+  "description": "Schema object for the Luca Schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "The id of the schema",
+      "type": "string",
+      "const": "luca-schema"
+    },
+    "name": {
+      "description": "The name of the schema",
+      "type": "string",
+      "const": "Luca Schema"
+    },
+    "version": {
+      "description": "The version of the schema",
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$"
+    }
+  }
+}

package/dist/cjs/schemas/transaction.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/transaction.json",
+  "title": "Transaction",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the transaction."
+    },
+    "payorId": {
+      "type": "string",
+      "description": "The identifier for the entity making the payment."
+    },
+    "payeeId": {
+      "type": "string",
+      "description": "The identifier for the entity receiving the payment."
+    },
+    "categoryId": {
+      "type": ["string", "null"],
+      "description": "The identifier for the category this transaction is associated with. Can be null if not categorized."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The monetary value of the transaction."
+    },
+    "date": {
+      "type": "string",
+      "format": "date",
+      "description": "The date the transaction took place."
+    },
+    "description": {
+      "type": "string",
+      "description": "A textual description of the transaction."
+    },
+    "transactionState": {
+      "type": "string",
+      "enum": [
+        "PLANNED",
+        "SCHEDULED",
+        "PENDING",
+        "COMPLETED",
+        "CANCELLED",
+        "FAILED",
+        "DISPUTED",
+        "REFUNDED",
+        "TENTATIVE",
+        "UPCOMING",
+        "DELETED"
+      ],
+      "description": "The current state of the transaction."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The timestamp when the transaction was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The timestamp when the transaction was last updated. Nullable to accommodate transactions that have not been updated."
+    }
+  },
+  "required": [
+    "id",
+    "payorId",
+    "payeeId",
+    "categoryId",
+    "amount",
+    "date",
+    "description",
+    "transactionState",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/cjs/validators.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ = _interopRequireDefault(require("ajv/dist/2020"));
+var _ajvFormats = _interopRequireDefault(require("ajv-formats"));
+var _schemas = _interopRequireDefault(require("./schemas"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+var ajv = new _["default"]();
+(0, _ajvFormats["default"])(ajv);
+Object.entries(_schemas["default"]).forEach(function (_ref) {
+  var _ref2 = _slicedToArray(_ref, 2),
+    key = _ref2[0],
+    schema = _ref2[1];
+  if (!ajv.validateSchema(schema)) {
+    console.error("Invalid schema: ".concat(key));
+    console.error(ajv.errors);
+  } else {
+    ajv.addSchema(schema, key);
+  }
+});
+var validators = {
+  validateCategory: ajv.getSchema('category'),
+  validateEntity: ajv.getSchema('entity'),
+  validateLucaSchema: ajv.getSchema('lucaSchema'),
+  validateRecurringTransaction: ajv.getSchema('recurringTransaction'),
+  validateRecurringTransactionEvent: ajv.getSchema('recurringTransactionEvent'),
+  validateSchema: ajv.getSchema('schema'),
+  validateTransaction: ajv.getSchema('transaction')
+};
+var _default = exports["default"] = validators;
+//# sourceMappingURL=validators.js.map

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+import schemas from './schemas.js';
+import validators from './validators';
+
+export { schemas, validators };

package/dist/esm/schemas/category.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/category.json",
+  "title": "Category",
+  "description": "Defines the schema for categories used to organize transactions within a ledger application. Categories can be default, modified, or custom, providing flexibility in categorization.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the category."
+    },
+    "name": {
+      "type": "string",
+      "description": "The name of the category."
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "A description of the category, providing additional context. Can be null if not specified."
+    },
+    "parentId": {
+      "type": ["string", "null"],
+      "description": "The identifier of the parent category, if any. Null if the category is top-level."
+    },
+    "defaultCategoryId": {
+      "type": ["string", "null"],
+      "description": "For custom categories, this indicates the default category from which this was derived. Required if categoryType is CUSTOM."
+    },
+    "categoryType": {
+      "type": "string",
+      "enum": ["DEFAULT", "MODIFIED", "CUSTOM"],
+      "description": "The type of the category, indicating whether it is a default, modified, or custom category."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the category was created, in ISO 8601 format."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The date and time when the category was last updated, in ISO 8601 format. Can be null if the category has never been updated."
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "description",
+    "parentId",
+    "defaultCategoryId",
+    "categoryType",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false,
+  "if": {
+    "properties": {
+      "categoryType": {
+        "const": "MODIFIED"
+      }
+    }
+  },
+  "then": {
+    "required": ["defaultCategoryId"]
+  }
+}

package/dist/esm/schemas/entity.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/entity.json",
+  "title": "Entity",
+  "description": "Defines the schema for entities within the application, categorizing them into specific, predefined types such as account, retailer, business, individual, utility, and government. This schema includes basic details and timestamps for creation and updates.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "id": {
+      "type": "string",
+      "title": "ID",
+      "description": "A unique identifier for the entity."
+    },
+    "name": {
+      "type": "string",
+      "title": "Name",
+      "description": "The name of the entity."
+    },
+    "description": {
+      "type": ["string", "null"],
+      "title": "Description",
+      "description": "A description of the entity. This can be null if no description is provided."
+    },
+    "entityType": {
+      "type": "string",
+      "title": "Type",
+      "enum": [
+        "ACCOUNT",
+        "RETAILER",
+        "SERVICE",
+        "INDIVIDUAL",
+        "UTILITY",
+        "GOVERNMENT"
+      ],
+      "description": "The type of the entity, indicating its role or classification within the application. Controlled to specific predefined options for consistency and integrity."
+    },
+    "entityStatus": {
+      "type": "string",
+      "title": "Status",
+      "enum": ["ACTIVE", "INACTIVE", "SUSPENDED", "DELETED", "CLOSED"],
+      "description": "The status of the entity, indicating whether it is active, inactive, suspended, or deleted. Controlled to specific predefined options for consistency and integrity."
+    },
+    "createdAt": {
+      "type": "string",
+      "title": "Created At",
+      "format": "date-time",
+      "description": "The date and time when the entity was created, in ISO 8601 format."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "title": "Updated At",
+      "format": "date-time",
+      "description": "The date and time when the entity was last updated, in ISO 8601 format. This can be null if the entity has not been updated since creation."
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "description",
+    "entityType",
+    "entityStatus",
+    "createdAt",
+    "updatedAt"
+  ]
+}

package/dist/esm/schemas/index.js

@@ -0,0 +1,19 @@
+import category from './category.json';
+import entity from './entity.json';
+import lucaSchema from './lucaSchema.json';
+import recurringTransaction from './recurringTransaction.json';
+import recurringTransactionEvent from './recurringTransactionEvent.json';
+import schema from './schema.json';
+import transaction from './transaction.json';
+
+const schemas = {
+  category,
+  entity,
+  lucaSchema,
+  recurringTransaction,
+  recurringTransactionEvent,
+  schema,
+  transaction
+};
+
+export default schemas;

package/dist/esm/schemas/lucaSchema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/luca-schema.json",
+  "title": "Luca Schema",
+  "description": "Schema for the luca ledger",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "$ref": "./schema.json"
+    },
+    "categories": {
+      "type": "array",
+      "description": "List of categories",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./category.json"
+      }
+    },
+    "entities": {
+      "type": "array",
+      "description": "List of entities",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./entity.json"
+      }
+    },
+    "recurringTransactions": {
+      "type": "array",
+      "description": "List of recurring transactions",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./recurringTransaction.json"
+      }
+    },
+    "recurringTransactionEvents": {
+      "type": "array",
+      "description": "List of recurring transaction events",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./recurringTransactionEvent.json"
+      }
+    },
+    "transactions": {
+      "type": "array",
+      "description": "List of transactions",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "./transaction.json"
+      }
+    }
+  },
+  "required": ["schema", "entities", "transactions"],
+  "additionalProperties": false
+}

package/dist/esm/schemas/recurringTransaction.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/recurringTransaction.json",
+  "title": "Recurring Transaction",
+  "description": "Defines recurring financial transactions within the application, including their scheduling, frequency, interval, and optional constraints like total occurrences or an end date.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the transaction."
+    },
+    "payorId": {
+      "type": "string",
+      "description": "Identifier for the payor in the transaction."
+    },
+    "payeeId": {
+      "type": "string",
+      "description": "Identifier for the payee in the transaction."
+    },
+    "categoryId": {
+      "type": ["string", "null"],
+      "description": "Category identifier for organizing the transaction. Can be null if not categorized."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The monetary value of the transaction."
+    },
+    "frequency": {
+      "type": "string",
+      "enum": ["DAY", "WEEK", "MONTH", "YEAR"],
+      "description": "Defines the base unit of time for the repetition."
+    },
+    "interval": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Specifies the number of frequency units between each occurrence (e.g., every 2 weeks)."
+    },
+    "occurrences": {
+      "type": ["integer", "null"],
+      "minimum": 1,
+      "description": "The total number of times the transaction should occur. Can be null if not specified."
+    },
+    "startOn": {
+      "type": "string",
+      "format": "date",
+      "description": "The date on which the recurring transaction series should begin."
+    },
+    "endOn": {
+      "type": ["string", "null"],
+      "format": "date",
+      "description": "The date on which the recurring transaction series should end. Can be null."
+    },
+    "description": {
+      "type": "string",
+      "description": "A detailed description of the transaction."
+    },
+    "recurringTransactionState": {
+      "type": "string",
+      "enum": ["ACTIVE", "PAUSED", "COMPLETED", "CANCELLED"],
+      "description": "Current state of the recurring transaction series."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of when the transaction was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Timestamp of the last update to the transaction. Can be null if not updated."
+    }
+  },
+  "required": [
+    "id",
+    "payorId",
+    "payeeId",
+    "categoryId",
+    "amount",
+    "frequency",
+    "interval",
+    "occurrences",
+    "startOn",
+    "endOn",
+    "description",
+    "recurringTransactionState",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/esm/schemas/recurringTransactionEvent.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/recurringTransactionEvent.json",
+  "title": "Recurring Transaction Event",
+  "description": "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.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the occurrence record."
+    },
+    "transactionId": {
+      "type": ["string", "null"],
+      "description": "Identifier of the actual transaction, required if the occurrence is modified."
+    },
+    "recurringTransactionId": {
+      "type": "string",
+      "description": "Identifier of the associated recurring transaction."
+    },
+    "expectedDate": {
+      "type": "string",
+      "format": "date",
+      "description": "The date when the occurrence is expected."
+    },
+    "status": {
+      "type": "string",
+      "enum": ["MODIFIED", "DELETED"],
+      "description": "Status of the occurrence, indicating if it has been modified or logically deleted."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of when the occurrence was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "Timestamp of the last update to the occurrence. Nullable to accommodate occurrences that have not been updated."
+    }
+  },
+  "required": [
+    "id",
+    "transactionId",
+    "recurringTransactionId",
+    "expectedDate",
+    "status",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false,
+  "if": {
+    "properties": { "status": { "const": "modified" } }
+  },
+  "then": {
+    "required": ["transactionId"]
+  }
+}

package/dist/esm/schemas/schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/schema.json",
+  "title": "Schema",
+  "description": "Schema object for the Luca Schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "The id of the schema",
+      "type": "string",
+      "const": "luca-schema"
+    },
+    "name": {
+      "description": "The name of the schema",
+      "type": "string",
+      "const": "Luca Schema"
+    },
+    "version": {
+      "description": "The version of the schema",
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$"
+    }
+  }
+}

package/dist/esm/schemas/transaction.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/LucaFinancial/LucaSchema/main/src/schemas/transaction.json",
+  "title": "Transaction",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the transaction."
+    },
+    "payorId": {
+      "type": "string",
+      "description": "The identifier for the entity making the payment."
+    },
+    "payeeId": {
+      "type": "string",
+      "description": "The identifier for the entity receiving the payment."
+    },
+    "categoryId": {
+      "type": ["string", "null"],
+      "description": "The identifier for the category this transaction is associated with. Can be null if not categorized."
+    },
+    "amount": {
+      "type": "number",
+      "description": "The monetary value of the transaction."
+    },
+    "date": {
+      "type": "string",
+      "format": "date",
+      "description": "The date the transaction took place."
+    },
+    "description": {
+      "type": "string",
+      "description": "A textual description of the transaction."
+    },
+    "transactionState": {
+      "type": "string",
+      "enum": [
+        "PLANNED",
+        "SCHEDULED",
+        "PENDING",
+        "COMPLETED",
+        "CANCELLED",
+        "FAILED",
+        "DISPUTED",
+        "REFUNDED",
+        "TENTATIVE",
+        "UPCOMING",
+        "DELETED"
+      ],
+      "description": "The current state of the transaction."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The timestamp when the transaction was created."
+    },
+    "updatedAt": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "The timestamp when the transaction was last updated. Nullable to accommodate transactions that have not been updated."
+    }
+  },
+  "required": [
+    "id",
+    "payorId",
+    "payeeId",
+    "categoryId",
+    "amount",
+    "date",
+    "description",
+    "transactionState",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/esm/validators.js

@@ -0,0 +1,28 @@
+import Ajv2020 from 'ajv/dist/2020';
+import addFormats from 'ajv-formats';
+
+import schemas from './schemas';
+
+const ajv = new Ajv2020();
+addFormats(ajv);
+
+Object.entries(schemas).forEach(([key, schema]) => {
+  if (!ajv.validateSchema(schema)) {
+    console.error(`Invalid schema: ${key}`);
+    console.error(ajv.errors);
+  } else {
+    ajv.addSchema(schema, key);
+  }
+});
+
+const validators = {
+  validateCategory: ajv.getSchema('category'),
+  validateEntity: ajv.getSchema('entity'),
+  validateLucaSchema: ajv.getSchema('lucaSchema'),
+  validateRecurringTransaction: ajv.getSchema('recurringTransaction'),
+  validateRecurringTransactionEvent: ajv.getSchema('recurringTransactionEvent'),
+  validateSchema: ajv.getSchema('schema'),
+  validateTransaction: ajv.getSchema('transaction')
+};
+
+export default validators;

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@luca-financial/luca-schema",
+  "version": "0.0.1",
+  "description": "Schemas for the Luca Ledger application",
+  "author": "Johnathan Aspinwall",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "https://lucaledger.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LucaFinancial/LucaSchema"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.[t|j]sx?$": "babel-jest"
+    },
+    "testMatch": [
+      "**/dist/cjs/tests/**/*.test.js"
+    ],
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "node"
+    ]
+  },
+  "scripts": {
+    "build": "yarn && yarn clean && node scripts/build.cjs && babel src --out-dir dist/cjs --source-maps",
+    "clean": "node scripts/clean.cjs",
+    "lint": "prettier --check . && eslint .",
+    "publish-beta": "yarn && yarn build && yarn publish --tag beta --access public",
+    "test": "yarn build && jest"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.24.1",
+    "@babel/core": "^7.24.4",
+    "@babel/preset-env": "^7.24.4",
+    "ajv": "^8.12.0",
+    "ajv-formats": "^2.1.1",
+    "babel-jest": "^29.7.0",
+    "fs-extra": "^11.2.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./schemas": {
+      "import": "./dist/esm/schemas/*.json",
+      "require": "./dist/cjs/schemas/*.json"
+    }
+  },
+  "files": [
+    "dist/cjs/index.js",
+    "dist/cjs/validators.js",
+    "dist/cjs/schemas/",
+    "dist/esm/index.js",
+    "dist/esm/validators.js",
+    "dist/esm/schemas/",
+    "LICENSE",
+    "README.md"
+  ]
+}