@luca-financial/luca-schema 1.1.1 → 1.2.3

package/README.md

@@ -1,3 +1,51 @@
 # LucaSchema
 
-Schema for the Luca Ledger application
+Schema validation library for the Luca Ledger application.
+
+## Installation
+
+```bash
+npm install @luca-financial/luca-schema
+```
+
+## Usage
+
+```javascript
+import { lucaValidator, enums } from '@luca-financial/luca-schema';
+
+// Validate a transaction
+const validateTransaction = lucaValidator.getSchema('transaction');
+const isValid = validateTransaction(transactionData);
+
+if (!isValid) {
+  console.error('Validation errors:', validateTransaction.errors);
+}
+
+// Access schemas directly
+console.log('Available schemas:', Object.keys(schemas));
+
+// Use enums for consistency
+const transactionState = enums.TransactionStateEnum.COMPLETED;
+```
+
+## Available Schemas
+
+- `transaction` - Financial transactions
+- `recurringTransaction` - Recurring transaction templates
+- `recurringTransactionEvent` - Recurring transaction events
+- `category` - Transaction categories
+- `entity` - Financial entities
+- `lucaSchema` - Complete schema structure
+
+### More to come
+
+- `account` (derives from entity)
+- `savingsAccount` (derives from account)
+
+## Development
+
+```bash
+yarn build    # Build the library
+yarn test     # Run tests
+yarn lint     # Check code style
+```

package/package.json

@@ -1,58 +1,58 @@
 {
   "name": "@luca-financial/luca-schema",
-  "version": "1.1.1",
+  "version": "1.2.3",
   "description": "Schemas for the Luca Ledger application",
   "author": "Johnathan Aspinwall",
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.js",
   "license": "MIT",
   "type": "module",
+  "types": "./dist/cjs/index.d.ts",
   "homepage": "https://lucaledger.app",
   "repository": {
     "type": "git",
     "url": "https://github.com/LucaFinancial/LucaSchema"
   },
   "jest": {
+    "preset": "ts-jest",
     "transform": {
       "^.+\\.[t|j]sx?$": "babel-jest"
     },
     "testMatch": [
-      "**/dist/cjs/tests/**/*.test.js"
+      "**/src/tests/**/*.test.[jt]s"
     ],
     "moduleFileExtensions": [
       "js",
+      "ts",
       "json",
       "node"
     ]
   },
   "scripts": {
-    "build": "yarn && yarn clean && node scripts/build.cjs && babel src --out-dir dist/cjs --source-maps",
-    "clean": "node scripts/clean.cjs",
+    "build": "yarn && yarn clean && node scripts/build.mjs && babel src --out-dir dist/cjs --source-maps --ignore 'src/examples/**','src/tests/**'",
+    "clean": "rimraf dist",
     "lint": "prettier --check . && eslint .",
-    "publish-beta": "yarn && yarn build && yarn publish --tag beta --access public",
-    "test": "yarn build && jest"
+    "test": "jest"
   },
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js"
-    },
-    "./schemas": {
-      "import": "./dist/esm/schemas/*.json",
-      "require": "./dist/cjs/schemas/*.json"
     }
   },
   "files": [
-    "dist/",
-    "LICENSE",
-    "README.md"
+    "dist/"
   ],
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "ajv-formats": "^2.1.1"
+  },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
     "@babel/core": "^7.24.4",
     "@babel/preset-env": "^7.24.4",
+    "@babel/preset-typescript": "^7.27.1",
     "@eslint/js": "^9.1.1",
-    "ajv": "^8.12.0",
-    "ajv-formats": "^2.1.1",
+    "@types/jest": "^29.5.14",
     "babel-jest": "^29.7.0",
     "eslint": "^9.1.1",
     "eslint-config-prettier": "^9.1.0",
@@ -62,6 +62,9 @@
     "globals": "^15.1.0",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
-    "rimraf": "^5.0.5"
-  }
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.3.4",
+    "typescript": "^5.8.3"
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/dist/cjs/enums.js

@@ -1,76 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-var SchemasEnum = Object.freeze({
-  CATEGORY: 'category',
-  ENTITY: 'entity',
-  LUCASCHEMA: 'lucaSchema',
-  RECURRING_TRANSACTION: 'recurringTransaction',
-  RECURRING_TRANSACTION_EVENT: 'recurringTransactionEvent',
-  SCHEMA: 'schema',
-  TRANSACTION: 'transaction'
-});
-var TransactionStateEnum = Object.freeze({
-  PLANNED: 'PLANNED',
-  SCHEDULED: 'SCHEDULED',
-  PENDING: 'PENDING',
-  COMPLETED: 'COMPLETED',
-  CANCELLED: 'CANCELLED',
-  FAILED: 'FAILED',
-  DISPUTED: 'DISPUTED',
-  REFUNDED: 'REFUNDED',
-  TENTATIVE: 'TENTATIVE',
-  UPCOMING: 'UPCOMING',
-  DELETED: 'DELETED'
-});
-var CategoryTypeEnum = Object.freeze({
-  DEFAULT: 'DEFAULT',
-  MODIFIED: 'MODIFIED',
-  CUSTOM: 'CUSTOM'
-});
-var EntityTypeEnum = Object.freeze({
-  ACCOUNT: 'ACCOUNT',
-  RETAILER: 'RETAILER',
-  BUSINESS: 'BUSINESS',
-  INDIVIDUAL: 'INDIVIDUAL',
-  UTILITY: 'UTILITY',
-  GOVERNMENT: 'GOVERNMENT'
-});
-var EntityStatusEnum = Object.freeze({
-  ACTIVE: 'ACTIVE',
-  INACTIVE: 'INACTIVE',
-  SUSPENDED: 'SUSPENDED',
-  DELETED: 'DELETED',
-  CLOSED: 'CLOSED'
-});
-var RecurringTransactionFrequencyEnum = Object.freeze({
-  DAY: 'DAY',
-  WEEK: 'WEEK',
-  MONTH: 'MONTH',
-  YEAR: 'YEAR'
-});
-var RecurringTransactionStateEnum = Object.freeze({
-  ACTIVE: 'ACTIVE',
-  PAUSED: 'PAUSED',
-  COMPLETED: 'COMPLETED',
-  CANCELLED: 'CANCELLED'
-});
-var RecurringTransactionEventStatusEnum = Object.freeze({
-  MODIFIED: 'MODIFIED',
-  DELETED: 'DELETED'
-});
-var enums = {
-  CategoryTypeEnum: CategoryTypeEnum,
-  EntityTypeEnum: EntityTypeEnum,
-  EntityStatusEnum: EntityStatusEnum,
-  RecurringTransactionFrequencyEnum: RecurringTransactionFrequencyEnum,
-  RecurringTransactionStateEnum: RecurringTransactionStateEnum,
-  RecurringTransactionEventStatusEnum: RecurringTransactionEventStatusEnum,
-  SchemasEnum: SchemasEnum,
-  TransactionStateEnum: TransactionStateEnum
-};
-var _default = exports["default"] = enums;
-//# sourceMappingURL=enums.js.map

package/dist/cjs/enums.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enums.js","names":["SchemasEnum","Object","freeze","CATEGORY","ENTITY","LUCASCHEMA","RECURRING_TRANSACTION","RECURRING_TRANSACTION_EVENT","SCHEMA","TRANSACTION","TransactionStateEnum","PLANNED","SCHEDULED","PENDING","COMPLETED","CANCELLED","FAILED","DISPUTED","REFUNDED","TENTATIVE","UPCOMING","DELETED","CategoryTypeEnum","DEFAULT","MODIFIED","CUSTOM","EntityTypeEnum","ACCOUNT","RETAILER","BUSINESS","INDIVIDUAL","UTILITY","GOVERNMENT","EntityStatusEnum","ACTIVE","INACTIVE","SUSPENDED","CLOSED","RecurringTransactionFrequencyEnum","DAY","WEEK","MONTH","YEAR","RecurringTransactionStateEnum","PAUSED","RecurringTransactionEventStatusEnum","enums","_default","exports"],"sources":["../../src/enums.js"],"sourcesContent":["const SchemasEnum = Object.freeze({\n  CATEGORY: 'category',\n  ENTITY: 'entity',\n  LUCASCHEMA: 'lucaSchema',\n  RECURRING_TRANSACTION: 'recurringTransaction',\n  RECURRING_TRANSACTION_EVENT: 'recurringTransactionEvent',\n  SCHEMA: 'schema',\n  TRANSACTION: 'transaction'\n});\n\nconst TransactionStateEnum = Object.freeze({\n  PLANNED: 'PLANNED',\n  SCHEDULED: 'SCHEDULED',\n  PENDING: 'PENDING',\n  COMPLETED: 'COMPLETED',\n  CANCELLED: 'CANCELLED',\n  FAILED: 'FAILED',\n  DISPUTED: 'DISPUTED',\n  REFUNDED: 'REFUNDED',\n  TENTATIVE: 'TENTATIVE',\n  UPCOMING: 'UPCOMING',\n  DELETED: 'DELETED'\n});\n\nconst CategoryTypeEnum = Object.freeze({\n  DEFAULT: 'DEFAULT',\n  MODIFIED: 'MODIFIED',\n  CUSTOM: 'CUSTOM'\n});\n\nconst EntityTypeEnum = Object.freeze({\n  ACCOUNT: 'ACCOUNT',\n  RETAILER: 'RETAILER',\n  BUSINESS: 'BUSINESS',\n  INDIVIDUAL: 'INDIVIDUAL',\n  UTILITY: 'UTILITY',\n  GOVERNMENT: 'GOVERNMENT'\n});\n\nconst EntityStatusEnum = Object.freeze({\n  ACTIVE: 'ACTIVE',\n  INACTIVE: 'INACTIVE',\n  SUSPENDED: 'SUSPENDED',\n  DELETED: 'DELETED',\n  CLOSED: 'CLOSED'\n});\n\nconst RecurringTransactionFrequencyEnum = Object.freeze({\n  DAY: 'DAY',\n  WEEK: 'WEEK',\n  MONTH: 'MONTH',\n  YEAR: 'YEAR'\n});\n\nconst RecurringTransactionStateEnum = Object.freeze({\n  ACTIVE: 'ACTIVE',\n  PAUSED: 'PAUSED',\n  COMPLETED: 'COMPLETED',\n  CANCELLED: 'CANCELLED'\n});\n\nconst RecurringTransactionEventStatusEnum = Object.freeze({\n  MODIFIED: 'MODIFIED',\n  DELETED: 'DELETED'\n});\n\nconst enums = {\n  CategoryTypeEnum,\n  EntityTypeEnum,\n  EntityStatusEnum,\n  RecurringTransactionFrequencyEnum,\n  RecurringTransactionStateEnum,\n  RecurringTransactionEventStatusEnum,\n  SchemasEnum,\n  TransactionStateEnum\n};\n\nexport default enums;\n"],"mappings":";;;;;;AAAA,IAAMA,WAAW,GAAGC,MAAM,CAACC,MAAM,CAAC;EAChCC,QAAQ,EAAE,UAAU;EACpBC,MAAM,EAAE,QAAQ;EAChBC,UAAU,EAAE,YAAY;EACxBC,qBAAqB,EAAE,sBAAsB;EAC7CC,2BAA2B,EAAE,2BAA2B;EACxDC,MAAM,EAAE,QAAQ;EAChBC,WAAW,EAAE;AACf,CAAC,CAAC;AAEF,IAAMC,oBAAoB,GAAGT,MAAM,CAACC,MAAM,CAAC;EACzCS,OAAO,EAAE,SAAS;EAClBC,SAAS,EAAE,WAAW;EACtBC,OAAO,EAAE,SAAS;EAClBC,SAAS,EAAE,WAAW;EACtBC,SAAS,EAAE,WAAW;EACtBC,MAAM,EAAE,QAAQ;EAChBC,QAAQ,EAAE,UAAU;EACpBC,QAAQ,EAAE,UAAU;EACpBC,SAAS,EAAE,WAAW;EACtBC,QAAQ,EAAE,UAAU;EACpBC,OAAO,EAAE;AACX,CAAC,CAAC;AAEF,IAAMC,gBAAgB,GAAGrB,MAAM,CAACC,MAAM,CAAC;EACrCqB,OAAO,EAAE,SAAS;EAClBC,QAAQ,EAAE,UAAU;EACpBC,MAAM,EAAE;AACV,CAAC,CAAC;AAEF,IAAMC,cAAc,GAAGzB,MAAM,CAACC,MAAM,CAAC;EACnCyB,OAAO,EAAE,SAAS;EAClBC,QAAQ,EAAE,UAAU;EACpBC,QAAQ,EAAE,UAAU;EACpBC,UAAU,EAAE,YAAY;EACxBC,OAAO,EAAE,SAAS;EAClBC,UAAU,EAAE;AACd,CAAC,CAAC;AAEF,IAAMC,gBAAgB,GAAGhC,MAAM,CAACC,MAAM,CAAC;EACrCgC,MAAM,EAAE,QAAQ;EAChBC,QAAQ,EAAE,UAAU;EACpBC,SAAS,EAAE,WAAW;EACtBf,OAAO,EAAE,SAAS;EAClBgB,MAAM,EAAE;AACV,CAAC,CAAC;AAEF,IAAMC,iCAAiC,GAAGrC,MAAM,CAACC,MAAM,CAAC;EACtDqC,GAAG,EAAE,KAAK;EACVC,IAAI,EAAE,MAAM;EACZC,KAAK,EAAE,OAAO;EACdC,IAAI,EAAE;AACR,CAAC,CAAC;AAEF,IAAMC,6BAA6B,GAAG1C,MAAM,CAACC,MAAM,CAAC;EAClDgC,MAAM,EAAE,QAAQ;EAChBU,MAAM,EAAE,QAAQ;EAChB9B,SAAS,EAAE,WAAW;EACtBC,SAAS,EAAE;AACb,CAAC,CAAC;AAEF,IAAM8B,mCAAmC,GAAG5C,MAAM,CAACC,MAAM,CAAC;EACxDsB,QAAQ,EAAE,UAAU;EACpBH,OAAO,EAAE;AACX,CAAC,CAAC;AAEF,IAAMyB,KAAK,GAAG;EACZxB,gBAAgB,EAAhBA,gBAAgB;EAChBI,cAAc,EAAdA,cAAc;EACdO,gBAAgB,EAAhBA,gBAAgB;EAChBK,iCAAiC,EAAjCA,iCAAiC;EACjCK,6BAA6B,EAA7BA,6BAA6B;EAC7BE,mCAAmC,EAAnCA,mCAAmC;EACnC7C,WAAW,EAAXA,WAAW;EACXU,oBAAoB,EAApBA;AACF,CAAC;AAAC,IAAAqC,QAAA,GAAAC,OAAA,cAEaF,KAAK","ignoreList":[]}