actual-jev 0.1.0

package/docs/library.md

@@ -0,0 +1,44 @@
+# Library usage
+
+Install `actual-jev`, `@actual-app/api`, and `@typesafe-ai/sdk` in your project. Initialize both clients in your script, then give them to `ActualJev`. Its first classification loads categories and relevant history from the open Actual budget; call `refresh()` after the budget changes.
+
+```ts
+import * as actual from '@actual-app/api';
+import { TypeSafeClient } from '@typesafe-ai/sdk';
+import { ActualJev } from 'actual-jev';
+
+await actual.init({
+    serverURL: process.env.ACTUAL_SERVER_URL!,
+    password: process.env.ACTUAL_PASSWORD!,
+    dataDir: '.actual-data',
+});
+await actual.downloadBudget(process.env.ACTUAL_SYNC_ID!, {
+    password: process.env.ACTUAL_ENCRYPTION_PASSWORD,
+});
+const jev = new TypeSafeClient();
+
+try {
+    const classifier = new ActualJev({ actual, jev });
+    const result = await classifier.classify({ payee_name: 'Fresh Market', amount: -2350 });
+    console.log(result.categoryId, result.confidence);
+} finally {
+    await actual.shutdown();
+}
+```
+
+You can instead supply categories and examples without an Actual client:
+
+```ts
+import { TypeSafeClient } from '@typesafe-ai/sdk';
+import { ActualJev } from 'actual-jev';
+
+const jev = new TypeSafeClient();
+const classifier = new ActualJev({
+    jev,
+    categories: [{ id: 'groceries', name: 'Groceries', groupName: 'Food' }],
+    examples: [{ categoryId: 'groceries', payeeName: 'Fresh Market' }],
+});
+const result = await classifier.classify({ importedPayee: 'Fresh Market', amount: -2350 });
+```
+
+Classification returns a suggestion and never updates Actual.

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "actual-jev",
+    "version": "0.1.0",
+    "description": "Categorize Actual Budget transactions with TypeSafe Jev",
+    "type": "module",
+    "packageManager": "pnpm@12.1.0",
+    "engines": {
+        "node": ">=24.10 <25"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "bin": {
+        "actual-jev": "./dist/cli.js"
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "docs",
+        ".env.example"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.json",
+        "prepack": "pnpm build",
+        "start": "node --import tsx src/cli.ts",
+        "test": "node --import tsx --test src/*.test.ts",
+        "lint": "eslint src",
+        "format": "prettier --write ."
+    },
+    "dependencies": {
+        "@actual-app/api": "^26.9.0",
+        "@inquirer/prompts": "^8.7.2",
+        "@inquirer/search": "^4.3.3",
+        "@typesafe-ai/sdk": "^0.6.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "^10.0.1",
+        "@types/node": "^24.13.6",
+        "@typescript/native": "npm:typescript@^7.0.2",
+        "eslint": "^10.11.0",
+        "prettier": "^3.9.9",
+        "tsx": "^4.23.15",
+        "typescript": "npm:@typescript/typescript6@^6.0.2",
+        "typescript-eslint": "^8.70.1"
+    }
+}