@accounter/shaam-uniform-format-generator 0.1.0

package/cjs/validation/validate-input.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * Input validation utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateInput = validateInput;
+const zod_1 = require("zod");
+const index_js_1 = require("../types/index.js");
+const errors_js_1 = require("./errors.js");
+/**
+ * Converts Zod errors to ValidationError format
+ */
+function convertZodErrorsToValidationErrors(zodError) {
+    return zodError.errors.map((error, index) => ({
+        recordType: 'input',
+        recordIndex: index,
+        field: error.path.join('.') || 'unknown',
+        message: error.message,
+    }));
+}
+/**
+ * Validates report input data against the schema
+ *
+ * @param input - The input data to validate
+ * @param mode - Validation mode ('fail-fast' or 'collect-all')
+ * @returns Array of validation errors (empty if valid)
+ */
+function validateInput(input, mode = 'fail-fast') {
+    const errors = [];
+    try {
+        index_js_1.ReportInputSchema.parse(input);
+    }
+    catch (error) {
+        if (error instanceof zod_1.ZodError) {
+            const validationErrors = convertZodErrorsToValidationErrors(error);
+            if (mode === 'fail-fast') {
+                throw new errors_js_1.ShaamFormatError(`Validation failed: ${validationErrors[0]?.message || 'Unknown error'}`, validationErrors);
+            }
+            errors.push(...validationErrors);
+        }
+        else {
+            // Handle non-Zod errors
+            const unknownError = {
+                recordType: 'unknown',
+                recordIndex: 0,
+                field: 'unknown',
+                message: error instanceof Error ? error.message : 'Unknown validation error',
+            };
+            if (mode === 'fail-fast') {
+                throw new errors_js_1.ShaamFormatError('Validation failed', [unknownError]);
+            }
+            errors.push(unknownError);
+        }
+    }
+    return errors;
+}

package/esm/api/generate-report.js

@@ -0,0 +1,50 @@
+/**
+ * Main API for generating SHAAM uniform format reports
+ */
+import { ShaamFormatError } from '../validation/errors.js';
+import { validateInput } from '../validation/validate-input.js';
+/**
+ * Generates SHAAM uniform format report files (INI.TXT and BKMVDATA.TXT)
+ * from a high-level JSON input object.
+ *
+ * @param input - The report input data
+ * @param options - Generation options
+ * @returns Report output with generated file content
+ */
+export function generateUniformFormatReport(input, options = {}) {
+    // Validate input data first
+    const validationMode = options.validationMode || 'fail-fast';
+    const validationErrors = validateInput(input, validationMode);
+    if (validationErrors.length > 0) {
+        if (validationMode === 'fail-fast') {
+            // This should have already thrown, but just in case
+            throw new ShaamFormatError('Validation failed', validationErrors);
+        }
+        // For collect-all mode, we still throw if there are errors
+        // The user can catch and inspect the errors if needed
+        throw new ShaamFormatError('Input validation failed', validationErrors);
+    }
+    // TODO: Implement the actual generation logic
+    const iniText = 'A000placeholder\r\n'; // Placeholder
+    const dataText = 'A100placeholder\r\n'; // Placeholder
+    // Create virtual File objects
+    const iniFile = new File([iniText], `${options.fileNameBase || 'report'}.INI.TXT`, {
+        type: 'text/plain',
+    });
+    const dataFile = new File([dataText], `${options.fileNameBase || 'report'}.BKMVDATA.TXT`, {
+        type: 'text/plain',
+    });
+    return {
+        iniText,
+        dataText,
+        iniFile,
+        dataFile,
+        summary: {
+            totalRecords: 2, // Placeholder
+            perType: {
+                A000: 1,
+                A100: 1,
+            },
+        },
+    };
+}

package/esm/api/parse-files.js

@@ -0,0 +1,29 @@
+/**
+ * API for parsing SHAAM uniform format files
+ */
+/**
+ * Parses SHAAM uniform format files (INI.TXT and BKMVDATA.TXT)
+ * back into structured JSON objects.
+ *
+ * @param iniContent - Content of the INI.TXT file
+ * @param dataContent - Content of the BKMVDATA.TXT file
+ * @returns Parsed report input data
+ */
+export function parseUniformFormatFiles(_iniContent, _dataContent) {
+    // TODO: Implement the actual parsing logic
+    return {
+        business: {
+            businessId: 'placeholder',
+            name: 'Placeholder Business',
+            taxId: '000000000',
+            reportingPeriod: {
+                startDate: '2024-01-01',
+                endDate: '2024-12-31',
+            },
+        },
+        documents: [],
+        journalEntries: [],
+        accounts: [],
+        inventory: [],
+    };
+}

package/esm/format/index.js

@@ -0,0 +1,5 @@
+/**
+ * Format utilities for SHAAM uniform format files
+ */
+export * from './padding.js';
+export * from './newline.js';

package/esm/format/newline.js

@@ -0,0 +1,7 @@
+/**
+ * Line ending constants for SHAAM format files
+ */
+/**
+ * CRLF line ending as required by SHAAM format specification
+ */
+export const CRLF = '\r\n';

package/esm/format/padding.js

@@ -0,0 +1,35 @@
+/**
+ * String padding utilities for fixed-width formatting
+ */
+/**
+ * Pads a string on the left (right-aligns the content)
+ *
+ * @param value - The string to pad
+ * @param width - Target width
+ * @param fill - Character to use for padding (default: space)
+ * @returns Left-padded string
+ */
+export function padLeft(value, width, fill = ' ') {
+    if (value.length >= width) {
+        return value.substring(0, width);
+    }
+    const padLength = width - value.length;
+    const padding = fill.repeat(padLength);
+    return padding + value;
+}
+/**
+ * Pads a string on the right (left-aligns the content)
+ *
+ * @param value - The string to pad
+ * @param width - Target width
+ * @param fill - Character to use for padding (default: space)
+ * @returns Right-padded string
+ */
+export function padRight(value, width, fill = ' ') {
+    if (value.length >= width) {
+        return value.substring(0, width);
+    }
+    const padLength = width - value.length;
+    const padding = fill.repeat(padLength);
+    return value + padding;
+}

package/esm/generator/format/decoder.js

@@ -0,0 +1,14 @@
+/**
+ * Fixed-width decoding utilities
+ */
+/**
+ * Decodes a fixed-width string value
+ *
+ * @param line - The line to decode from
+ * @param start - Start position (0-based)
+ * @param length - Field length
+ * @returns Decoded and trimmed value
+ */
+export function decodeFixedWidth(line, start, length) {
+    return line.substring(start, start + length).trim();
+}

package/esm/generator/format/encoder.js

@@ -0,0 +1,42 @@
+/**
+ * Fixed-wiexport function formatField(
+  value: string,
+  width: number,
+  align: 'left' | 'right',
+  padChar = ' '
+): string {
+  if (align === 'left') {
+    return padRight(value, width, padChar);
+  }
+  return padLeft(value, width, padChar);
+} utilities
+ */
+import { padLeft, padRight } from '../../format/padding.js';
+/**
+ * Formats a field value with specified width and alignment
+ *
+ * @param value - The value to format
+ * @param width - Target field width
+ * @param align - Alignment ('left' or 'right')
+ * @param padChar - Character to use for padding (default: space)
+ * @returns Formatted fixed-width string
+ */
+export function formatField(value, width, align, padChar = ' ') {
+    if (align === 'left') {
+        return padRight(value, width, padChar);
+    }
+    return padLeft(value, width, padChar);
+}
+/**
+ * Encodes a value to fixed-width format with padding
+ *
+ * @param value - The value to encode
+ * @param width - Target width
+ * @param padChar - Padding character (default: space)
+ * @param align - Alignment ('left' or 'right')
+ * @returns Fixed-width encoded string
+ */
+export function encodeFixedWidth(value, width, padChar = ' ', align = 'left') {
+    const str = String(value);
+    return formatField(str, width, align, padChar);
+}

package/esm/generator/format/index.js

@@ -0,0 +1,5 @@
+/**
+ * Format encoding and decoding utilities
+ */
+export * from './encoder.js';
+export * from './decoder.js';

package/esm/generator/index.js

@@ -0,0 +1,5 @@
+/**
+ * File generation utilities
+ */
+export * from './records/index.js';
+export * from './format/index.js';

package/esm/generator/records/a000.js

@@ -0,0 +1,5 @@
+/**
+ * A000 - Header record for INI.TXT
+ */
+// TODO: Implement A000 record schema and functions
+export const A000_PLACEHOLDER = 'A000';

package/esm/generator/records/a100.js

@@ -0,0 +1,5 @@
+/**
+ * A100 - Opening record for BKMVDATA.TXT
+ */
+// TODO: Implement A100 record schema and functions
+export const A100_PLACEHOLDER = 'A100';

package/esm/generator/records/b100.js

@@ -0,0 +1,5 @@
+/**
+ * B100 - Journal entry line record
+ */
+// TODO: Implement B100 record schema and functions
+export const B100_PLACEHOLDER = 'B100';

package/esm/generator/records/b110.js

@@ -0,0 +1,5 @@
+/**
+ * B110 - Account record
+ */
+// TODO: Implement B110 record schema and functions
+export const B110_PLACEHOLDER = 'B110';

package/esm/generator/records/c100.js

@@ -0,0 +1,5 @@
+/**
+ * C100 - Document header record
+ */
+// TODO: Implement C100 record schema and functions
+export const C100_PLACEHOLDER = 'C100';

package/esm/generator/records/d110.js

@@ -0,0 +1,5 @@
+/**
+ * D110 - Document line record
+ */
+// TODO: Implement D110 record schema and functions
+export const D110_PLACEHOLDER = 'D110';

package/esm/generator/records/d120.js

@@ -0,0 +1,5 @@
+/**
+ * D120 - Payment/receipt record
+ */
+// TODO: Implement D120 record schema and functions
+export const D120_PLACEHOLDER = 'D120';

package/esm/generator/records/index.js

@@ -0,0 +1,12 @@
+/**
+ * Record type definitions and generators
+ */
+export * from './a000.js';
+export * from './a100.js';
+export * from './b100.js';
+export * from './b110.js';
+export * from './c100.js';
+export * from './d110.js';
+export * from './d120.js';
+export * from './m100.js';
+export * from './z900.js';

package/esm/generator/records/m100.js

@@ -0,0 +1,5 @@
+/**
+ * M100 - Inventory item record
+ */
+// TODO: Implement M100 record schema and functions
+export const M100_PLACEHOLDER = 'M100';

package/esm/generator/records/z900.js

@@ -0,0 +1,5 @@
+/**
+ * Z900 - Closing record for BKMVDATA.TXT
+ */
+// TODO: Implement Z900 record schema and functions
+export const Z900_PLACEHOLDER = 'Z900';

package/esm/index.js

@@ -0,0 +1,13 @@
+/**
+ * @accounter/shaam-uniform-format-generator
+ *
+ * A fully typed TypeScript library for generating, parsing, and validating
+ * SHAAM uniform format tax reports (INI.TXT and BKMVDATA.TXT files).
+ */
+export * from './types/index.js';
+export * from './generator/index.js';
+export * from './parser/index.js';
+export * from './validation/index.js';
+// Main API
+export { generateUniformFormatReport } from './api/generate-report.js';
+export { parseUniformFormatFiles } from './api/parse-files.js';

package/esm/parser/data-parser.js

@@ -0,0 +1,13 @@
+/**
+ * BKMVDATA.TXT file parsing utilities
+ */
+/**
+ * Parses BKMVDATA.TXT file content
+ *
+ * @param content - Raw BKMVDATA.TXT file content
+ * @returns Parsed data structure
+ */
+export function parseDataFile(_content) {
+    // TODO: Implement data file parsing logic
+    return {};
+}

package/esm/parser/index.js

@@ -0,0 +1,5 @@
+/**
+ * File parsing utilities
+ */
+export * from './ini-parser.js';
+export * from './data-parser.js';

package/esm/parser/ini-parser.js

@@ -0,0 +1,13 @@
+/**
+ * INI.TXT file parsing utilities
+ */
+/**
+ * Parses INI.TXT file content
+ *
+ * @param content - Raw INI.TXT file content
+ * @returns Parsed data structure
+ */
+export function parseIniFile(_content) {
+    // TODO: Implement INI file parsing logic
+    return {};
+}

package/esm/types/index.js

@@ -0,0 +1,71 @@
+/**
+ * Type definitions for SHAAM uniform format generator
+ */
+import { z } from 'zod';
+// Business metadata schema
+export const BusinessMetadataSchema = z.object({
+    businessId: z.string().min(1, 'Business ID is required'),
+    name: z.string().min(1, 'Business name is required'),
+    taxId: z.string().min(1, 'Tax ID is required'),
+    reportingPeriod: z.object({
+        startDate: z.string().min(1, 'Start date is required'),
+        endDate: z.string().min(1, 'End date is required'),
+    }),
+});
+// Document schema
+export const DocumentSchema = z.object({
+    id: z.string().min(1, 'Document ID is required'),
+    type: z.string().min(1, 'Document type is required'),
+    date: z.string().min(1, 'Document date is required'),
+    amount: z.number(),
+    description: z.string().optional(),
+});
+// Journal entry schema
+export const JournalEntrySchema = z.object({
+    id: z.string().min(1, 'Journal entry ID is required'),
+    date: z.string().min(1, 'Journal entry date is required'),
+    amount: z.number(),
+    accountId: z.string().min(1, 'Account ID is required'),
+    description: z.string().optional(),
+});
+// Account schema
+export const AccountSchema = z.object({
+    id: z.string().min(1, 'Account ID is required'),
+    name: z.string().min(1, 'Account name is required'),
+    type: z.string().min(1, 'Account type is required'),
+    balance: z.number(),
+});
+// Inventory item schema
+export const InventoryItemSchema = z.object({
+    id: z.string().min(1, 'Inventory item ID is required'),
+    name: z.string().min(1, 'Inventory item name is required'),
+    quantity: z.number(),
+    unitPrice: z.number(),
+});
+// Main input schema
+export const ReportInputSchema = z.object({
+    business: BusinessMetadataSchema,
+    documents: z.array(DocumentSchema),
+    journalEntries: z.array(JournalEntrySchema),
+    accounts: z.array(AccountSchema),
+    inventory: z.array(InventoryItemSchema),
+});
+// Output schema
+export const ReportOutputSchema = z.object({
+    iniText: z.string(),
+    dataText: z.string(),
+    iniFile: z.instanceof(File),
+    dataFile: z.instanceof(File),
+    summary: z.object({
+        totalRecords: z.number(),
+        perType: z.record(z.string(), z.number()),
+        errors: z
+            .array(z.object({
+            recordType: z.string(),
+            recordIndex: z.number(),
+            field: z.string(),
+            message: z.string(),
+        }))
+            .optional(),
+    }),
+});

package/esm/validation/errors.js

@@ -0,0 +1,25 @@
+/**
+ * Error handling utilities
+ */
+/**
+ * Custom error class for SHAAM format generation errors
+ */
+export class ShaamFormatError extends Error {
+    errors;
+    constructor(message, errors = []) {
+        super(message);
+        this.errors = errors;
+        this.name = 'ShaamFormatError';
+    }
+}
+/**
+ * Creates a validation error object
+ */
+export function createValidationError(recordType, recordIndex, field, message) {
+    return {
+        recordType,
+        recordIndex,
+        field,
+        message,
+    };
+}

package/esm/validation/index.js

@@ -0,0 +1,5 @@
+/**
+ * Validation utilities
+ */
+export * from './validate-input.js';
+export * from './errors.js';

package/esm/validation/validate-input.js

@@ -0,0 +1,53 @@
+/**
+ * Input validation utilities
+ */
+import { ZodError } from 'zod';
+import { ReportInputSchema } from '../types/index.js';
+import { ShaamFormatError } from './errors.js';
+/**
+ * Converts Zod errors to ValidationError format
+ */
+function convertZodErrorsToValidationErrors(zodError) {
+    return zodError.errors.map((error, index) => ({
+        recordType: 'input',
+        recordIndex: index,
+        field: error.path.join('.') || 'unknown',
+        message: error.message,
+    }));
+}
+/**
+ * Validates report input data against the schema
+ *
+ * @param input - The input data to validate
+ * @param mode - Validation mode ('fail-fast' or 'collect-all')
+ * @returns Array of validation errors (empty if valid)
+ */
+export function validateInput(input, mode = 'fail-fast') {
+    const errors = [];
+    try {
+        ReportInputSchema.parse(input);
+    }
+    catch (error) {
+        if (error instanceof ZodError) {
+            const validationErrors = convertZodErrorsToValidationErrors(error);
+            if (mode === 'fail-fast') {
+                throw new ShaamFormatError(`Validation failed: ${validationErrors[0]?.message || 'Unknown error'}`, validationErrors);
+            }
+            errors.push(...validationErrors);
+        }
+        else {
+            // Handle non-Zod errors
+            const unknownError = {
+                recordType: 'unknown',
+                recordIndex: 0,
+                field: 'unknown',
+                message: error instanceof Error ? error.message : 'Unknown validation error',
+            };
+            if (mode === 'fail-fast') {
+                throw new ShaamFormatError('Validation failed', [unknownError]);
+            }
+            errors.push(unknownError);
+        }
+    }
+    return errors;
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@accounter/shaam-uniform-format-generator",
+  "version": "0.1.0",
+  "description": "Fully typed application that generates, parses, and validates SHAAM uniform format tax reports (INI.TXT and BKMVDATA.TXT).",
+  "dependencies": {
+    "iconv-lite": "0.6.3",
+    "zod": "3.25.76"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/urigo/accounter-fullstack.git",
+    "directory": "packages/shaam-uniform-format-generator"
+  },
+  "homepage": "https://github.com/urigo/accounter-fullstack/packages/shaam-uniform-format-generator#readme",
+  "keywords": [
+    "shaam",
+    "uniform-format",
+    "accountancy",
+    "accountant",
+    "accounter",
+    "tax-reports",
+    "ini",
+    "bkmvdata"
+  ],
+  "author": "Gil Gardosh <gilgardosh@gmail.com>",
+  "license": "MIT",
+  "engines": {
+    "node": "^20.0.0 || >= 22"
+  },
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
+  "typescript": {
+    "definition": "typings/index.d.ts"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./typings/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
+}

package/typings/api/generate-report.d.cts

@@ -0,0 +1,13 @@
+/**
+ * Main API for generating SHAAM uniform format reports
+ */
+import type { GenerationOptions, ReportInput, ReportOutput } from '../types/index.cjs';
+/**
+ * Generates SHAAM uniform format report files (INI.TXT and BKMVDATA.TXT)
+ * from a high-level JSON input object.
+ *
+ * @param input - The report input data
+ * @param options - Generation options
+ * @returns Report output with generated file content
+ */
+export declare function generateUniformFormatReport(input: ReportInput, options?: GenerationOptions): ReportOutput;

package/typings/api/generate-report.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Main API for generating SHAAM uniform format reports
+ */
+import type { GenerationOptions, ReportInput, ReportOutput } from '../types/index.js';
+/**
+ * Generates SHAAM uniform format report files (INI.TXT and BKMVDATA.TXT)
+ * from a high-level JSON input object.
+ *
+ * @param input - The report input data
+ * @param options - Generation options
+ * @returns Report output with generated file content
+ */
+export declare function generateUniformFormatReport(input: ReportInput, options?: GenerationOptions): ReportOutput;

package/typings/api/parse-files.d.cts

@@ -0,0 +1,13 @@
+/**
+ * API for parsing SHAAM uniform format files
+ */
+import type { ReportInput } from '../types/index.cjs';
+/**
+ * Parses SHAAM uniform format files (INI.TXT and BKMVDATA.TXT)
+ * back into structured JSON objects.
+ *
+ * @param iniContent - Content of the INI.TXT file
+ * @param dataContent - Content of the BKMVDATA.TXT file
+ * @returns Parsed report input data
+ */
+export declare function parseUniformFormatFiles(_iniContent: string, _dataContent: string): ReportInput;

package/typings/api/parse-files.d.ts

@@ -0,0 +1,13 @@
+/**
+ * API for parsing SHAAM uniform format files
+ */
+import type { ReportInput } from '../types/index.js';
+/**
+ * Parses SHAAM uniform format files (INI.TXT and BKMVDATA.TXT)
+ * back into structured JSON objects.
+ *
+ * @param iniContent - Content of the INI.TXT file
+ * @param dataContent - Content of the BKMVDATA.TXT file
+ * @returns Parsed report input data
+ */
+export declare function parseUniformFormatFiles(_iniContent: string, _dataContent: string): ReportInput;

package/typings/format/index.d.cts

@@ -0,0 +1,5 @@
+/**
+ * Format utilities for SHAAM uniform format files
+ */
+export * from './padding.cjs';
+export * from './newline.cjs';