@accounter/shaam-uniform-format-generator 0.1.0

package/typings/types/index.d.ts

@@ -0,0 +1,371 @@
+/**
+ * Type definitions for SHAAM uniform format generator
+ */
+import { z } from 'zod';
+export declare const BusinessMetadataSchema: z.ZodObject<{
+    businessId: z.ZodString;
+    name: z.ZodString;
+    taxId: z.ZodString;
+    reportingPeriod: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    businessId: string;
+    name: string;
+    taxId: string;
+    reportingPeriod: {
+        startDate: string;
+        endDate: string;
+    };
+}, {
+    businessId: string;
+    name: string;
+    taxId: string;
+    reportingPeriod: {
+        startDate: string;
+        endDate: string;
+    };
+}>;
+export declare const DocumentSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    date: z.ZodString;
+    amount: z.ZodNumber;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    date: string;
+    id: string;
+    amount: number;
+    description?: string | undefined;
+}, {
+    type: string;
+    date: string;
+    id: string;
+    amount: number;
+    description?: string | undefined;
+}>;
+export declare const JournalEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    date: z.ZodString;
+    amount: z.ZodNumber;
+    accountId: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    id: string;
+    amount: number;
+    accountId: string;
+    description?: string | undefined;
+}, {
+    date: string;
+    id: string;
+    amount: number;
+    accountId: string;
+    description?: string | undefined;
+}>;
+export declare const AccountSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    balance: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    type: string;
+    id: string;
+    balance: number;
+}, {
+    name: string;
+    type: string;
+    id: string;
+    balance: number;
+}>;
+export declare const InventoryItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    quantity: z.ZodNumber;
+    unitPrice: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    quantity: number;
+    unitPrice: number;
+}, {
+    name: string;
+    id: string;
+    quantity: number;
+    unitPrice: number;
+}>;
+export declare const ReportInputSchema: z.ZodObject<{
+    business: z.ZodObject<{
+        businessId: z.ZodString;
+        name: z.ZodString;
+        taxId: z.ZodString;
+        reportingPeriod: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        businessId: string;
+        name: string;
+        taxId: string;
+        reportingPeriod: {
+            startDate: string;
+            endDate: string;
+        };
+    }, {
+        businessId: string;
+        name: string;
+        taxId: string;
+        reportingPeriod: {
+            startDate: string;
+            endDate: string;
+        };
+    }>;
+    documents: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodString;
+        date: z.ZodString;
+        amount: z.ZodNumber;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        date: string;
+        id: string;
+        amount: number;
+        description?: string | undefined;
+    }, {
+        type: string;
+        date: string;
+        id: string;
+        amount: number;
+        description?: string | undefined;
+    }>, "many">;
+    journalEntries: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        date: z.ZodString;
+        amount: z.ZodNumber;
+        accountId: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        id: string;
+        amount: number;
+        accountId: string;
+        description?: string | undefined;
+    }, {
+        date: string;
+        id: string;
+        amount: number;
+        accountId: string;
+        description?: string | undefined;
+    }>, "many">;
+    accounts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        balance: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        type: string;
+        id: string;
+        balance: number;
+    }, {
+        name: string;
+        type: string;
+        id: string;
+        balance: number;
+    }>, "many">;
+    inventory: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unitPrice: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        quantity: number;
+        unitPrice: number;
+    }, {
+        name: string;
+        id: string;
+        quantity: number;
+        unitPrice: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    business: {
+        businessId: string;
+        name: string;
+        taxId: string;
+        reportingPeriod: {
+            startDate: string;
+            endDate: string;
+        };
+    };
+    documents: {
+        type: string;
+        date: string;
+        id: string;
+        amount: number;
+        description?: string | undefined;
+    }[];
+    journalEntries: {
+        date: string;
+        id: string;
+        amount: number;
+        accountId: string;
+        description?: string | undefined;
+    }[];
+    accounts: {
+        name: string;
+        type: string;
+        id: string;
+        balance: number;
+    }[];
+    inventory: {
+        name: string;
+        id: string;
+        quantity: number;
+        unitPrice: number;
+    }[];
+}, {
+    business: {
+        businessId: string;
+        name: string;
+        taxId: string;
+        reportingPeriod: {
+            startDate: string;
+            endDate: string;
+        };
+    };
+    documents: {
+        type: string;
+        date: string;
+        id: string;
+        amount: number;
+        description?: string | undefined;
+    }[];
+    journalEntries: {
+        date: string;
+        id: string;
+        amount: number;
+        accountId: string;
+        description?: string | undefined;
+    }[];
+    accounts: {
+        name: string;
+        type: string;
+        id: string;
+        balance: number;
+    }[];
+    inventory: {
+        name: string;
+        id: string;
+        quantity: number;
+        unitPrice: number;
+    }[];
+}>;
+export declare const ReportOutputSchema: z.ZodObject<{
+    iniText: z.ZodString;
+    dataText: z.ZodString;
+    iniFile: z.ZodType<File, z.ZodTypeDef, File>;
+    dataFile: z.ZodType<File, z.ZodTypeDef, File>;
+    summary: z.ZodObject<{
+        totalRecords: z.ZodNumber;
+        perType: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            recordType: z.ZodString;
+            recordIndex: z.ZodNumber;
+            field: z.ZodString;
+            message: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }, {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        totalRecords: number;
+        perType: Record<string, number>;
+        errors?: {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }[] | undefined;
+    }, {
+        totalRecords: number;
+        perType: Record<string, number>;
+        errors?: {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    iniText: string;
+    dataText: string;
+    iniFile: File;
+    dataFile: File;
+    summary: {
+        totalRecords: number;
+        perType: Record<string, number>;
+        errors?: {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }[] | undefined;
+    };
+}, {
+    iniText: string;
+    dataText: string;
+    iniFile: File;
+    dataFile: File;
+    summary: {
+        totalRecords: number;
+        perType: Record<string, number>;
+        errors?: {
+            message: string;
+            recordType: string;
+            recordIndex: number;
+            field: string;
+        }[] | undefined;
+    };
+}>;
+export type BusinessMetadata = z.infer<typeof BusinessMetadataSchema>;
+export type Document = z.infer<typeof DocumentSchema>;
+export type JournalEntry = z.infer<typeof JournalEntrySchema>;
+export type Account = z.infer<typeof AccountSchema>;
+export type InventoryItem = z.infer<typeof InventoryItemSchema>;
+export type ReportInput = z.infer<typeof ReportInputSchema>;
+export type ReportOutput = z.infer<typeof ReportOutputSchema>;
+export interface ValidationError {
+    recordType: string;
+    recordIndex: number;
+    field: string;
+    message: string;
+}
+export interface GenerationOptions {
+    validationMode?: 'fail-fast' | 'collect-all';
+    fileNameBase?: string;
+}

package/typings/validation/errors.d.cts

@@ -0,0 +1,15 @@
+/**
+ * Error handling utilities
+ */
+import type { ValidationError } from '../types/index.cjs';
+/**
+ * Custom error class for SHAAM format generation errors
+ */
+export declare class ShaamFormatError extends Error {
+    readonly errors: ValidationError[];
+    constructor(message: string, errors?: ValidationError[]);
+}
+/**
+ * Creates a validation error object
+ */
+export declare function createValidationError(recordType: string, recordIndex: number, field: string, message: string): ValidationError;

package/typings/validation/errors.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Error handling utilities
+ */
+import type { ValidationError } from '../types/index.js';
+/**
+ * Custom error class for SHAAM format generation errors
+ */
+export declare class ShaamFormatError extends Error {
+    readonly errors: ValidationError[];
+    constructor(message: string, errors?: ValidationError[]);
+}
+/**
+ * Creates a validation error object
+ */
+export declare function createValidationError(recordType: string, recordIndex: number, field: string, message: string): ValidationError;

package/typings/validation/index.d.cts

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

package/typings/validation/index.d.ts

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

package/typings/validation/validate-input.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Input validation utilities
+ */
+import type { ReportInput, ValidationError } from '../types/index.cjs';
+/**
+ * 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 declare function validateInput(input: ReportInput, mode?: 'fail-fast' | 'collect-all'): ValidationError[];

package/typings/validation/validate-input.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Input validation utilities
+ */
+import type { ReportInput, ValidationError } from '../types/index.js';
+/**
+ * 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 declare function validateInput(input: ReportInput, mode?: 'fail-fast' | 'collect-all'): ValidationError[];