@moatless/bookkeeping-types 0.2.0

package/dist/discarded-item.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Error information from a failed deletion attempt
+ */
+export interface DeletionError {
+    /** When the deletion was attempted */
+    attemptedAt: string;
+    /** HTTP status code from the API */
+    statusCode?: number;
+    /** Error code from the integration (e.g., Fortnox error code) */
+    errorCode?: number | string;
+    /** Human-readable error message */
+    message: string;
+}
+/**
+ * Represents a discarded inbox item that should be removed from the source integration.
+ * Stored in inbox/discarded.json in the organization's storage.
+ */
+export interface DiscardedItem {
+    /** Directory name in the inbox folder */
+    dir: string;
+    /** ID of the item in the source integration (e.g., Fortnox file ID) */
+    sourceId: string;
+    /** Which integration the item came from */
+    sourceIntegration: "fortnox" | "bokio" | "ledgit";
+    /** Error from the last failed deletion attempt (if any) */
+    lastDeletionError?: DeletionError;
+    /** Number of failed deletion attempts */
+    deletionAttempts?: number;
+}

package/dist/discarded-item.js

@@ -0,0 +1 @@
+export {};

package/dist/document.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Exported document format - optimized for Git-based workflow
+ * Using camelCase for TypeScript compatibility
+ *
+ * This format is designed for human-readable YAML exports stored in Git repositories.
+ * It removes database-specific metadata (UUIDs, timestamps, sync data) and focuses
+ * on the document content and parsed data. Git provides version history and timestamps.
+ */
+/**
+ * Monetary amount with currency
+ * Amount is stored as a string to preserve precision
+ */
+export interface DocumentMoneyAmount {
+    amount: string;
+    currency: string;
+}
+/**
+ * Tax detail line item
+ */
+export interface TaxDetail {
+    rate: number;
+    amount: string;
+    description?: string;
+}
+/**
+ * Document kind/type
+ */
+export type DocumentKind = "RECEIPT" | "SUPPLIER_INVOICE" | "CUSTOMER_INVOICE" | "TRAKTAMENTE" | "EMAIL" | "OTHER";
+/**
+ * Document status in workflow
+ */
+export type DocumentStatus = "DRAFT" | "REVIEWED" | "READY_TO_EXPORT" | "EXPORTED" | "ERROR" | "DISCARDED" | "POSTED";
+/**
+ * Complete exported document with parsed data
+ *
+ * Git-based workflow assumptions:
+ * - Creation/update timestamps: Use git log
+ * - Author information: Use git commit author
+ * - File location: Same directory as YAML file
+ * - Organization context: Repository structure
+ */
+export interface Document {
+    kind: DocumentKind;
+    status: DocumentStatus;
+    fileName: string;
+    mimeType: string;
+    documentDate?: string;
+    documentNumber?: string;
+    description?: string;
+    counterparty?: string;
+    totalAmount?: DocumentMoneyAmount;
+    totalTaxAmount?: DocumentMoneyAmount;
+    subTotal?: DocumentMoneyAmount;
+    taxDetails?: TaxDetail[];
+    dueDate?: string;
+    currencyRate?: number;
+    vendorTaxId?: string;
+    interpretationError?: string;
+    sourceIntegration?: "fortnox" | "bokio" | "ledgit";
+    sourceId?: string;
+    uploadedAt?: string;
+    interpretedAt?: string;
+    senderEmail?: string;
+    senderName?: string;
+    emailSubject?: string;
+}
+/**
+ * Type alias for backward compatibility
+ */
+export type InboxDocument = Document;

package/dist/document.js

@@ -0,0 +1,9 @@
+/**
+ * Exported document format - optimized for Git-based workflow
+ * Using camelCase for TypeScript compatibility
+ *
+ * This format is designed for human-readable YAML exports stored in Git repositories.
+ * It removes database-specific metadata (UUIDs, timestamps, sync data) and focuses
+ * on the document content and parsed data. Git provides version history and timestamps.
+ */
+export {};

package/dist/fiscal-year.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Exported fiscal year structure for Git storage (YAML format)
+ */
+export interface FiscalYear {
+    name: string;
+    startDate: string;
+    endDate: string;
+    status: "OPEN" | "CLOSED";
+    externalId?: string;
+}

package/dist/fiscal-year.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./journal-entry";
+export * from "./document";
+export * from "./fiscal-year";
+export * from "./ledger-account";
+export * from "./discarded-item";
+export * from "./sync";

package/dist/index.js

@@ -0,0 +1,12 @@
+// Journal entry types (used across Git YAML, API, and client)
+export * from "./journal-entry";
+// Document types
+export * from "./document";
+// Fiscal year
+export * from "./fiscal-year";
+// Ledger account
+export * from "./ledger-account";
+// Discarded items
+export * from "./discarded-item";
+// Sync types
+export * from "./sync";

package/dist/journal-entry.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Unified Journal Entry types
+ *
+ * These types are used throughout the stack:
+ * - Git YAML storage (entry.yaml files)
+ * - Server API responses
+ * - Client state
+ *
+ * All monetary amounts use NUMBER type (not strings).
+ * All field names use camelCase.
+ */
+/**
+ * Monetary amount with currency
+ */
+export interface MoneyAmount {
+    amount: number;
+    currency: string;
+    originalAmount?: number;
+    originalCurrency?: string;
+}
+/**
+ * Single line in a journal entry
+ */
+export interface JournalLine {
+    lineNumber: number;
+    account: string;
+    debit: MoneyAmount;
+    credit: MoneyAmount;
+    memo?: string;
+    taxCode?: string;
+    costCenter?: string;
+    /** Populated by API when account details are available */
+    ledgerAccountName?: string;
+}
+/**
+ * Journal entry series
+ * Different series are used for different transaction types:
+ * - A: General/miscellaneous transactions
+ * - B: Customer invoices (sales)
+ * - C: Customer payments (collections)
+ * - D: Supplier invoices (purchases)
+ * - E: Supplier payments (disbursements)
+ * - I: Period-end accruals and adjustments
+ * - M: Monthly/quarterly tax reporting
+ */
+export type JournalEntrySeries = "A" | "B" | "C" | "D" | "E" | "I" | "M";
+/**
+ * Journal entry status
+ */
+export type JournalEntryStatus = "DRAFT" | "POSTED";
+/**
+ * Complete journal entry
+ */
+export interface JournalEntry {
+    /** Populated by API (derived from directory name), not stored in YAML */
+    id?: string;
+    series?: JournalEntrySeries;
+    entryNumber: number;
+    entryDate: string;
+    description: string;
+    status: JournalEntryStatus;
+    currency: string;
+    externalId?: string;
+    totalDebit: MoneyAmount;
+    totalCredit: MoneyAmount;
+    lines: JournalLine[];
+    postedAt?: string;
+    errorMessage?: string;
+    postingCheckpoint?: string;
+    voucherNumber?: number;
+    voucherSeriesCode?: string;
+    fortnoxFileId?: string;
+    sourceIntegration?: "fortnox" | "bokio" | "ledgit";
+    sourceSyncedAt?: string;
+    /** If this entry is a reversal, the external ID of the entry it reverses */
+    reversingEntryExternalId?: string;
+    /** If this entry was reversed/cancelled, the external ID of the reversing entry */
+    reversedByEntryExternalId?: string;
+}

package/dist/journal-entry.js

@@ -0,0 +1,12 @@
+/**
+ * Unified Journal Entry types
+ *
+ * These types are used throughout the stack:
+ * - Git YAML storage (entry.yaml files)
+ * - Server API responses
+ * - Client state
+ *
+ * All monetary amounts use NUMBER type (not strings).
+ * All field names use camelCase.
+ */
+export {};

package/dist/ledger-account.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Ledger account (chart of accounts entry)
+ */
+export interface LedgerAccount {
+    code: string;
+    name: string;
+    description?: string;
+}

package/dist/ledger-account.js

@@ -0,0 +1 @@
+export {};

package/dist/sync.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Result stats for sync operations
+ */
+export interface SyncStats {
+    fetched: number;
+    written: number;
+    skipped: number;
+    errors: number;
+}
+/**
+ * Stats per fiscal year (more detailed)
+ */
+export interface FiscalYearStats {
+    year: number;
+    fetched: number;
+    created: number;
+    updated: number;
+    unchanged: number;
+    failed: number;
+}
+/**
+ * Error entry for tracking issues
+ */
+export interface SyncError {
+    year: number;
+    externalId: string;
+    message: string;
+}
+/**
+ * Complete sync result
+ */
+export interface SyncJournalResult {
+    success: boolean;
+    fiscalYears: FiscalYearStats[];
+    totals: {
+        fetched: number;
+        created: number;
+        updated: number;
+        unchanged: number;
+        failed: number;
+    };
+    errors: SyncError[];
+    durationMs: number;
+}
+/**
+ * Fiscal year info for sync operations
+ */
+export interface FiscalYearInfo {
+    /** External ID from provider (used for API calls) */
+    externalId: number;
+    /** Calendar year (used for file paths) */
+    year: number;
+}
+/**
+ * Fiscal year with dates (from database)
+ */
+export interface FiscalYearWithDates {
+    name: string | null;
+    start_date: string;
+    end_date: string;
+}
+/**
+ * Progress update during sync operations
+ */
+export interface SyncProgress {
+    current: number;
+    total: number;
+    message?: string;
+    phase?: "discovering" | "fetching";
+}
+/**
+ * Summary info for a fiscal year (used in sync selection)
+ */
+export interface FiscalYearSummary {
+    id: number;
+    year: number;
+    fromDate: string;
+    toDate: string;
+    entryCount: number;
+}

package/dist/sync.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,22 @@
+{
+	"name": "@moatless/bookkeeping-types",
+	"version": "0.2.0",
+	"description": "Type definitions for Swedish bookkeeping domain models",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsc --watch",
+		"type-check": "tsc --noEmit"
+	},
+	"devDependencies": {
+		"typescript": "^5.8.3"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}