@fulmenhq/tsfulmen 0.2.0 → 0.2.2

package/dist/fulencode/index.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Fulencode types - canonical encoding/decoding interfaces.
+ */
+declare const EncodingFormat: {
+    readonly BASE64: "base64";
+    readonly BASE64URL: "base64url";
+    readonly BASE64_RAW: "base64_raw";
+    readonly BASE32: "base32";
+    readonly BASE32HEX: "base32hex";
+    readonly HEX: "hex";
+    readonly UTF8: "utf-8";
+    readonly UTF16LE: "utf-16le";
+    readonly UTF16BE: "utf-16be";
+    readonly ISO_8859_1: "iso-8859-1";
+    readonly CP1252: "cp1252";
+    readonly ASCII: "ascii";
+};
+type EncodingFormat = (typeof EncodingFormat)[keyof typeof EncodingFormat];
+type OnErrorMode = "strict" | "replace" | "ignore";
+type DecodeOnErrorMode = OnErrorMode | "fallback";
+interface EncodeOptions {
+    padding?: boolean;
+    hexCase?: "upper" | "lower";
+    lineLength?: number | null;
+    lineEnding?: "\n" | "\r\n";
+    maxEncodedSize?: number;
+    computeChecksum?: string;
+    embedChecksum?: boolean;
+    onError?: OnErrorMode;
+}
+interface EncodingResult {
+    data: string;
+    format: EncodingFormat;
+    inputSize: number;
+    outputSize: number;
+    checksum?: string;
+    checksumAlgorithm?: string;
+    warnings: string[];
+}
+interface DecodeOptions {
+    verifyChecksum?: boolean;
+    computeChecksum?: string;
+    maxDecodedSize?: number;
+    onError?: DecodeOnErrorMode;
+    fallbackFormats?: EncodingFormat[];
+    ignoreWhitespace?: boolean;
+    validatePadding?: boolean;
+}
+interface DecodingResult {
+    data: Uint8Array;
+    format: EncodingFormat;
+    inputSize: number;
+    outputSize: number;
+    checksum?: string;
+    checksumVerified?: boolean;
+    checksumAlgorithm?: string;
+    warnings: string[];
+    correctionsApplied: number;
+}
+
+type FulencodeOperation = "encode" | "decode" | "detect" | "normalize" | "bom";
+interface FulencodeErrorDetails {
+    byteOffset?: number;
+    codepointOffset?: number;
+    detectedEncoding?: string;
+    confidence?: number;
+    invalidBytes?: number[];
+    expected?: string;
+    actual?: string;
+    [key: string]: unknown;
+}
+declare class FulencodeError extends Error {
+    readonly code: string;
+    readonly operation: FulencodeOperation;
+    readonly inputFormat?: EncodingFormat;
+    readonly outputFormat?: EncodingFormat;
+    readonly details?: FulencodeErrorDetails;
+    constructor(args: {
+        code: string;
+        message: string;
+        operation: FulencodeOperation;
+        inputFormat?: EncodingFormat;
+        outputFormat?: EncodingFormat;
+        details?: FulencodeErrorDetails;
+        cause?: unknown;
+    });
+}
+
+declare function encode(input: Uint8Array | string, format: EncodingFormat, options?: EncodeOptions): Promise<EncodingResult>;
+declare function decode(input: string | Uint8Array, format: EncodingFormat, options?: DecodeOptions): Promise<DecodingResult>;
+
+/**
+ * Fulencode - canonical encoding/decoding facade.
+ */
+declare const VERSION = "0.1.0";
+
+declare const fulencode: {
+    readonly encode: typeof encode;
+    readonly decode: typeof decode;
+};
+
+export { type DecodeOnErrorMode, type DecodeOptions, type DecodingResult, type EncodeOptions, EncodingFormat, type EncodingResult, FulencodeError, type FulencodeErrorDetails, type FulencodeOperation, type OnErrorMode, VERSION, decode, encode, fulencode };