@utilix-tech/sdk 0.1.0

package/dist/data-rMjWNiOJ.d.cts

@@ -0,0 +1,215 @@
+/**
+ * @module data
+ * Data format tools for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *  - yaml-validator  : validateYaml, getYamlStats
+ *  - toml-formatter  : formatToml, minifyToml, validateToml, tomlToJson, jsonToToml, getTomlStats
+ *  - xml-formatter   : validateXml, formatXml, minifyXml
+ *  - xml-to-json     : parseXmlToObject, xmlToJson, getXmlStats, jsonToXml
+ *  - csv-viewer      : detectDelimiter, parseCsv, csvToJson, toCsvString
+ *  - ini-parser      : parseIni, stringifyIni, iniToJson, jsonToIni, getSection, getSectionNames, validateIni
+ *  - env-parser      : parseEnv, envToJson, envToExport, validateEnvKey
+ */
+interface ValidationResult {
+    valid: boolean;
+    error?: {
+        message: string;
+        line?: number;
+        column?: number;
+    };
+    documentCount: number;
+    keyCount: number;
+}
+declare function validateYaml(input: string): ValidationResult;
+declare function getYamlStats(input: string): {
+    lines: number;
+    keys: number;
+    depth: number;
+} | {
+    error: string;
+};
+interface TomlFormatResult {
+    output: string;
+    valid: boolean;
+    error?: string;
+}
+declare function formatToml(input: string): TomlFormatResult;
+declare function minifyToml(input: string): TomlFormatResult;
+declare function validateToml(input: string): {
+    valid: boolean;
+    error?: string;
+};
+declare function tomlToJson(input: string): string | {
+    error: string;
+};
+declare function jsonToToml(input: string): string | {
+    error: string;
+};
+declare function getTomlStats(input: string): {
+    keys: number;
+    tables: number;
+    arrays: number;
+} | {
+    error: string;
+};
+interface XmlFormatResult {
+    output: string;
+    originalSize: number;
+    outputSize: number;
+    valid: boolean;
+    error?: string;
+}
+declare function validateXml(input: string): {
+    valid: boolean;
+    error?: string;
+};
+declare function formatXml(input: string, indentSize?: number): XmlFormatResult;
+declare function minifyXml(input: string): XmlFormatResult;
+interface XmlToJsonOptions {
+    compact?: boolean;
+    ignoreAttributes?: boolean;
+    attributePrefix?: string;
+    textKey?: string;
+    arrayMode?: boolean;
+    spaces?: number;
+}
+declare function parseXmlToObject(xml: string, options?: XmlToJsonOptions): Record<string, unknown> | {
+    error: string;
+};
+declare function xmlToJson(xml: string, options?: XmlToJsonOptions): string | {
+    error: string;
+};
+declare function getXmlStats(xml: string): {
+    elements: number;
+    attributes: number;
+    depth: number;
+    rootElement: string;
+};
+declare function jsonToXml(json: string, options?: {
+    rootElement?: string;
+    spaces?: number;
+}): string | {
+    error: string;
+};
+interface ParseOptions {
+    delimiter?: string;
+    hasHeader?: boolean;
+    trimWhitespace?: boolean;
+    maxRows?: number;
+}
+interface CsvParseResult {
+    headers: string[];
+    rows: string[][];
+    totalRows: number;
+    totalCols: number;
+    warnings: string[];
+}
+declare function detectDelimiter(input: string): string;
+declare function parseCsv(input: string, options?: ParseOptions): CsvParseResult | {
+    error: string;
+};
+declare function csvToJson(input: string, options?: ParseOptions): string | {
+    error: string;
+};
+declare function toCsvString(headers: string[], rows: string[][]): string;
+interface IniSection {
+    name: string;
+    keys: Record<string, string>;
+    comments: string[];
+    lineStart: number;
+    lineEnd: number;
+}
+interface ParsedIni {
+    sections: IniSection[];
+    global: Record<string, string>;
+    raw: string;
+}
+declare function parseIni(input: string): ParsedIni | {
+    error: string;
+};
+declare function stringifyIni(parsed: ParsedIni): string;
+declare function iniToJson(input: string): string | {
+    error: string;
+};
+declare function jsonToIni(json: string): string | {
+    error: string;
+};
+declare function getSection(parsed: ParsedIni, name: string): Record<string, string> | null;
+declare function getSectionNames(parsed: ParsedIni): string[];
+declare function validateIni(input: string): {
+    valid: boolean;
+    errors: string[];
+};
+interface EnvEntry {
+    key: string;
+    value: string;
+    line: number;
+    hasQuotes: boolean;
+    interpolated: boolean;
+    comment?: string;
+}
+interface EnvParseResult {
+    entries: EnvEntry[];
+    comments: Array<{
+        line: number;
+        text: string;
+    }>;
+    errors: Array<{
+        line: number;
+        message: string;
+    }>;
+    duplicates: string[];
+}
+declare function parseEnv(input: string): EnvParseResult;
+declare function envToJson(input: string): string | {
+    error: string;
+};
+declare function envToExport(input: string): string;
+declare function validateEnvKey(key: string): boolean;
+
+type data_CsvParseResult = CsvParseResult;
+type data_EnvEntry = EnvEntry;
+type data_EnvParseResult = EnvParseResult;
+type data_IniSection = IniSection;
+type data_ParseOptions = ParseOptions;
+type data_ParsedIni = ParsedIni;
+type data_TomlFormatResult = TomlFormatResult;
+type data_ValidationResult = ValidationResult;
+type data_XmlFormatResult = XmlFormatResult;
+type data_XmlToJsonOptions = XmlToJsonOptions;
+declare const data_csvToJson: typeof csvToJson;
+declare const data_detectDelimiter: typeof detectDelimiter;
+declare const data_envToExport: typeof envToExport;
+declare const data_envToJson: typeof envToJson;
+declare const data_formatToml: typeof formatToml;
+declare const data_formatXml: typeof formatXml;
+declare const data_getSection: typeof getSection;
+declare const data_getSectionNames: typeof getSectionNames;
+declare const data_getTomlStats: typeof getTomlStats;
+declare const data_getXmlStats: typeof getXmlStats;
+declare const data_getYamlStats: typeof getYamlStats;
+declare const data_iniToJson: typeof iniToJson;
+declare const data_jsonToIni: typeof jsonToIni;
+declare const data_jsonToToml: typeof jsonToToml;
+declare const data_jsonToXml: typeof jsonToXml;
+declare const data_minifyToml: typeof minifyToml;
+declare const data_minifyXml: typeof minifyXml;
+declare const data_parseCsv: typeof parseCsv;
+declare const data_parseEnv: typeof parseEnv;
+declare const data_parseIni: typeof parseIni;
+declare const data_parseXmlToObject: typeof parseXmlToObject;
+declare const data_stringifyIni: typeof stringifyIni;
+declare const data_toCsvString: typeof toCsvString;
+declare const data_tomlToJson: typeof tomlToJson;
+declare const data_validateEnvKey: typeof validateEnvKey;
+declare const data_validateIni: typeof validateIni;
+declare const data_validateToml: typeof validateToml;
+declare const data_validateXml: typeof validateXml;
+declare const data_validateYaml: typeof validateYaml;
+declare const data_xmlToJson: typeof xmlToJson;
+declare namespace data {
+  export { type data_CsvParseResult as CsvParseResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_envToExport as envToExport, data_envToJson as envToJson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
+}
+
+export { toCsvString as A, tomlToJson as B, type CsvParseResult as C, validateEnvKey as D, type EnvEntry as E, validateIni as F, validateToml as G, validateXml as H, type IniSection as I, validateYaml as J, xmlToJson as K, type ParseOptions as P, type TomlFormatResult as T, type ValidationResult as V, type XmlFormatResult as X, type EnvParseResult as a, type ParsedIni as b, type XmlToJsonOptions as c, data as d, csvToJson as e, detectDelimiter as f, envToExport as g, envToJson as h, formatToml as i, formatXml as j, getSection as k, getSectionNames as l, getTomlStats as m, getXmlStats as n, getYamlStats as o, iniToJson as p, jsonToIni as q, jsonToToml as r, jsonToXml as s, minifyToml as t, minifyXml as u, parseCsv as v, parseEnv as w, parseIni as x, parseXmlToObject as y, stringifyIni as z };

package/dist/data-rMjWNiOJ.d.ts

@@ -0,0 +1,215 @@
+/**
+ * @module data
+ * Data format tools for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *  - yaml-validator  : validateYaml, getYamlStats
+ *  - toml-formatter  : formatToml, minifyToml, validateToml, tomlToJson, jsonToToml, getTomlStats
+ *  - xml-formatter   : validateXml, formatXml, minifyXml
+ *  - xml-to-json     : parseXmlToObject, xmlToJson, getXmlStats, jsonToXml
+ *  - csv-viewer      : detectDelimiter, parseCsv, csvToJson, toCsvString
+ *  - ini-parser      : parseIni, stringifyIni, iniToJson, jsonToIni, getSection, getSectionNames, validateIni
+ *  - env-parser      : parseEnv, envToJson, envToExport, validateEnvKey
+ */
+interface ValidationResult {
+    valid: boolean;
+    error?: {
+        message: string;
+        line?: number;
+        column?: number;
+    };
+    documentCount: number;
+    keyCount: number;
+}
+declare function validateYaml(input: string): ValidationResult;
+declare function getYamlStats(input: string): {
+    lines: number;
+    keys: number;
+    depth: number;
+} | {
+    error: string;
+};
+interface TomlFormatResult {
+    output: string;
+    valid: boolean;
+    error?: string;
+}
+declare function formatToml(input: string): TomlFormatResult;
+declare function minifyToml(input: string): TomlFormatResult;
+declare function validateToml(input: string): {
+    valid: boolean;
+    error?: string;
+};
+declare function tomlToJson(input: string): string | {
+    error: string;
+};
+declare function jsonToToml(input: string): string | {
+    error: string;
+};
+declare function getTomlStats(input: string): {
+    keys: number;
+    tables: number;
+    arrays: number;
+} | {
+    error: string;
+};
+interface XmlFormatResult {
+    output: string;
+    originalSize: number;
+    outputSize: number;
+    valid: boolean;
+    error?: string;
+}
+declare function validateXml(input: string): {
+    valid: boolean;
+    error?: string;
+};
+declare function formatXml(input: string, indentSize?: number): XmlFormatResult;
+declare function minifyXml(input: string): XmlFormatResult;
+interface XmlToJsonOptions {
+    compact?: boolean;
+    ignoreAttributes?: boolean;
+    attributePrefix?: string;
+    textKey?: string;
+    arrayMode?: boolean;
+    spaces?: number;
+}
+declare function parseXmlToObject(xml: string, options?: XmlToJsonOptions): Record<string, unknown> | {
+    error: string;
+};
+declare function xmlToJson(xml: string, options?: XmlToJsonOptions): string | {
+    error: string;
+};
+declare function getXmlStats(xml: string): {
+    elements: number;
+    attributes: number;
+    depth: number;
+    rootElement: string;
+};
+declare function jsonToXml(json: string, options?: {
+    rootElement?: string;
+    spaces?: number;
+}): string | {
+    error: string;
+};
+interface ParseOptions {
+    delimiter?: string;
+    hasHeader?: boolean;
+    trimWhitespace?: boolean;
+    maxRows?: number;
+}
+interface CsvParseResult {
+    headers: string[];
+    rows: string[][];
+    totalRows: number;
+    totalCols: number;
+    warnings: string[];
+}
+declare function detectDelimiter(input: string): string;
+declare function parseCsv(input: string, options?: ParseOptions): CsvParseResult | {
+    error: string;
+};
+declare function csvToJson(input: string, options?: ParseOptions): string | {
+    error: string;
+};
+declare function toCsvString(headers: string[], rows: string[][]): string;
+interface IniSection {
+    name: string;
+    keys: Record<string, string>;
+    comments: string[];
+    lineStart: number;
+    lineEnd: number;
+}
+interface ParsedIni {
+    sections: IniSection[];
+    global: Record<string, string>;
+    raw: string;
+}
+declare function parseIni(input: string): ParsedIni | {
+    error: string;
+};
+declare function stringifyIni(parsed: ParsedIni): string;
+declare function iniToJson(input: string): string | {
+    error: string;
+};
+declare function jsonToIni(json: string): string | {
+    error: string;
+};
+declare function getSection(parsed: ParsedIni, name: string): Record<string, string> | null;
+declare function getSectionNames(parsed: ParsedIni): string[];
+declare function validateIni(input: string): {
+    valid: boolean;
+    errors: string[];
+};
+interface EnvEntry {
+    key: string;
+    value: string;
+    line: number;
+    hasQuotes: boolean;
+    interpolated: boolean;
+    comment?: string;
+}
+interface EnvParseResult {
+    entries: EnvEntry[];
+    comments: Array<{
+        line: number;
+        text: string;
+    }>;
+    errors: Array<{
+        line: number;
+        message: string;
+    }>;
+    duplicates: string[];
+}
+declare function parseEnv(input: string): EnvParseResult;
+declare function envToJson(input: string): string | {
+    error: string;
+};
+declare function envToExport(input: string): string;
+declare function validateEnvKey(key: string): boolean;
+
+type data_CsvParseResult = CsvParseResult;
+type data_EnvEntry = EnvEntry;
+type data_EnvParseResult = EnvParseResult;
+type data_IniSection = IniSection;
+type data_ParseOptions = ParseOptions;
+type data_ParsedIni = ParsedIni;
+type data_TomlFormatResult = TomlFormatResult;
+type data_ValidationResult = ValidationResult;
+type data_XmlFormatResult = XmlFormatResult;
+type data_XmlToJsonOptions = XmlToJsonOptions;
+declare const data_csvToJson: typeof csvToJson;
+declare const data_detectDelimiter: typeof detectDelimiter;
+declare const data_envToExport: typeof envToExport;
+declare const data_envToJson: typeof envToJson;
+declare const data_formatToml: typeof formatToml;
+declare const data_formatXml: typeof formatXml;
+declare const data_getSection: typeof getSection;
+declare const data_getSectionNames: typeof getSectionNames;
+declare const data_getTomlStats: typeof getTomlStats;
+declare const data_getXmlStats: typeof getXmlStats;
+declare const data_getYamlStats: typeof getYamlStats;
+declare const data_iniToJson: typeof iniToJson;
+declare const data_jsonToIni: typeof jsonToIni;
+declare const data_jsonToToml: typeof jsonToToml;
+declare const data_jsonToXml: typeof jsonToXml;
+declare const data_minifyToml: typeof minifyToml;
+declare const data_minifyXml: typeof minifyXml;
+declare const data_parseCsv: typeof parseCsv;
+declare const data_parseEnv: typeof parseEnv;
+declare const data_parseIni: typeof parseIni;
+declare const data_parseXmlToObject: typeof parseXmlToObject;
+declare const data_stringifyIni: typeof stringifyIni;
+declare const data_toCsvString: typeof toCsvString;
+declare const data_tomlToJson: typeof tomlToJson;
+declare const data_validateEnvKey: typeof validateEnvKey;
+declare const data_validateIni: typeof validateIni;
+declare const data_validateToml: typeof validateToml;
+declare const data_validateXml: typeof validateXml;
+declare const data_validateYaml: typeof validateYaml;
+declare const data_xmlToJson: typeof xmlToJson;
+declare namespace data {
+  export { type data_CsvParseResult as CsvParseResult, type data_EnvEntry as EnvEntry, type data_EnvParseResult as EnvParseResult, type data_IniSection as IniSection, type data_ParseOptions as ParseOptions, type data_ParsedIni as ParsedIni, type data_TomlFormatResult as TomlFormatResult, type data_ValidationResult as ValidationResult, type data_XmlFormatResult as XmlFormatResult, type data_XmlToJsonOptions as XmlToJsonOptions, data_csvToJson as csvToJson, data_detectDelimiter as detectDelimiter, data_envToExport as envToExport, data_envToJson as envToJson, data_formatToml as formatToml, data_formatXml as formatXml, data_getSection as getSection, data_getSectionNames as getSectionNames, data_getTomlStats as getTomlStats, data_getXmlStats as getXmlStats, data_getYamlStats as getYamlStats, data_iniToJson as iniToJson, data_jsonToIni as jsonToIni, data_jsonToToml as jsonToToml, data_jsonToXml as jsonToXml, data_minifyToml as minifyToml, data_minifyXml as minifyXml, data_parseCsv as parseCsv, data_parseEnv as parseEnv, data_parseIni as parseIni, data_parseXmlToObject as parseXmlToObject, data_stringifyIni as stringifyIni, data_toCsvString as toCsvString, data_tomlToJson as tomlToJson, data_validateEnvKey as validateEnvKey, data_validateIni as validateIni, data_validateToml as validateToml, data_validateXml as validateXml, data_validateYaml as validateYaml, data_xmlToJson as xmlToJson };
+}
+
+export { toCsvString as A, tomlToJson as B, type CsvParseResult as C, validateEnvKey as D, type EnvEntry as E, validateIni as F, validateToml as G, validateXml as H, type IniSection as I, validateYaml as J, xmlToJson as K, type ParseOptions as P, type TomlFormatResult as T, type ValidationResult as V, type XmlFormatResult as X, type EnvParseResult as a, type ParsedIni as b, type XmlToJsonOptions as c, data as d, csvToJson as e, detectDelimiter as f, envToExport as g, envToJson as h, formatToml as i, formatXml as j, getSection as k, getSectionNames as l, getTomlStats as m, getXmlStats as n, getYamlStats as o, iniToJson as p, jsonToIni as q, jsonToToml as r, jsonToXml as s, minifyToml as t, minifyXml as u, parseCsv as v, parseEnv as w, parseIni as x, parseXmlToObject as y, stringifyIni as z };

package/dist/encoding-7gmq-vkV.d.cts

@@ -0,0 +1,108 @@
+/**
+ * @module encoding
+ * Encoding/decoding utilities for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *  - base64   : encodeBase64, decodeBase64
+ *  - url-encode: encodeUrl, decodeUrl, diffSegments
+ *  - html-entities: encodeHtmlEntities, decodeHtmlEntities, encodeHtmlEntitiesAll
+ *  - base32   : base32Encode, base32Decode, base32EncodeBytes, base32DecodeBytes, isValidBase32, ALPHABETS
+ */
+type Base64Variant = 'standard' | 'urlsafe';
+interface EncodeResult {
+    ok: true;
+    output: string;
+    inputBytes: number;
+    outputChars: number;
+}
+interface DecodeResult {
+    ok: true;
+    output: string;
+    outputBytes: number;
+}
+interface Base64Error {
+    ok: false;
+    error: string;
+}
+type Base64EncodeResult = EncodeResult | Base64Error;
+type Base64DecodeResult = DecodeResult | Base64Error;
+declare function encodeBase64(input: string, variant?: Base64Variant): Base64EncodeResult;
+declare function decodeBase64(input: string, variant?: Base64Variant): Base64DecodeResult;
+type UrlEncodeMode = 'component' | 'full';
+interface UrlEncodeResult {
+    ok: true;
+    output: string;
+    changed: boolean;
+}
+interface UrlEncodeError {
+    ok: false;
+    error: string;
+}
+type UrlResult = UrlEncodeResult | UrlEncodeError;
+/**
+ * component mode: encodeURIComponent — encodes everything except A-Z a-z 0-9 - _ . ! ~ * ' ( )
+ * full mode: encodeURI — preserves :/?#[]@!$&'()*+,;= so a complete URL stays valid
+ */
+declare function encodeUrl(input: string, mode?: UrlEncodeMode): UrlResult;
+declare function decodeUrl(input: string, mode?: UrlEncodeMode): UrlResult;
+declare function diffSegments(original: string, encoded: string): Array<{
+    text: string;
+    changed: boolean;
+}>;
+type encodeMode = 'minimal' | 'all';
+/**
+ * Encode the 5 HTML special characters to named entities.
+ */
+declare function encodeHtmlEntities(input: string): string;
+/**
+ * Decode named HTML entities (a fixed set) and numeric entities (decimal and hex).
+ */
+declare function decodeHtmlEntities(input: string): string;
+/**
+ * Encode ALL printable non-ASCII characters (charCode > 127) plus the 5 HTML
+ * special characters as numeric entities.
+ */
+declare function encodeHtmlEntitiesAll(input: string): string;
+type Base32Alphabet = 'standard' | 'hex' | 'crockford' | 'z-base-32';
+declare const ALPHABETS: Record<Base32Alphabet, string>;
+declare function base32EncodeBytes(bytes: Uint8Array, alphabet?: Base32Alphabet): string;
+declare function base32DecodeBytes(input: string, alphabet?: Base32Alphabet): Uint8Array | {
+    error: string;
+};
+declare function base32Encode(input: string, alphabet?: Base32Alphabet): string;
+declare function base32Decode(input: string, alphabet?: Base32Alphabet): string | {
+    error: string;
+};
+declare function isValidBase32(input: string, alphabet?: Base32Alphabet): boolean;
+
+declare const encoding_ALPHABETS: typeof ALPHABETS;
+type encoding_Base32Alphabet = Base32Alphabet;
+type encoding_Base64DecodeResult = Base64DecodeResult;
+type encoding_Base64EncodeResult = Base64EncodeResult;
+type encoding_Base64Error = Base64Error;
+type encoding_Base64Variant = Base64Variant;
+type encoding_DecodeResult = DecodeResult;
+type encoding_EncodeResult = EncodeResult;
+type encoding_UrlEncodeError = UrlEncodeError;
+type encoding_UrlEncodeMode = UrlEncodeMode;
+type encoding_UrlEncodeResult = UrlEncodeResult;
+type encoding_UrlResult = UrlResult;
+declare const encoding_base32Decode: typeof base32Decode;
+declare const encoding_base32DecodeBytes: typeof base32DecodeBytes;
+declare const encoding_base32Encode: typeof base32Encode;
+declare const encoding_base32EncodeBytes: typeof base32EncodeBytes;
+declare const encoding_decodeBase64: typeof decodeBase64;
+declare const encoding_decodeHtmlEntities: typeof decodeHtmlEntities;
+declare const encoding_decodeUrl: typeof decodeUrl;
+declare const encoding_diffSegments: typeof diffSegments;
+declare const encoding_encodeBase64: typeof encodeBase64;
+declare const encoding_encodeHtmlEntities: typeof encodeHtmlEntities;
+declare const encoding_encodeHtmlEntitiesAll: typeof encodeHtmlEntitiesAll;
+type encoding_encodeMode = encodeMode;
+declare const encoding_encodeUrl: typeof encodeUrl;
+declare const encoding_isValidBase32: typeof isValidBase32;
+declare namespace encoding {
+  export { encoding_ALPHABETS as ALPHABETS, type encoding_Base32Alphabet as Base32Alphabet, type encoding_Base64DecodeResult as Base64DecodeResult, type encoding_Base64EncodeResult as Base64EncodeResult, type encoding_Base64Error as Base64Error, type encoding_Base64Variant as Base64Variant, type encoding_DecodeResult as DecodeResult, type encoding_EncodeResult as EncodeResult, type encoding_UrlEncodeError as UrlEncodeError, type encoding_UrlEncodeMode as UrlEncodeMode, type encoding_UrlEncodeResult as UrlEncodeResult, type encoding_UrlResult as UrlResult, encoding_base32Decode as base32Decode, encoding_base32DecodeBytes as base32DecodeBytes, encoding_base32Encode as base32Encode, encoding_base32EncodeBytes as base32EncodeBytes, encoding_decodeBase64 as decodeBase64, encoding_decodeHtmlEntities as decodeHtmlEntities, encoding_decodeUrl as decodeUrl, encoding_diffSegments as diffSegments, encoding_encodeBase64 as encodeBase64, encoding_encodeHtmlEntities as encodeHtmlEntities, encoding_encodeHtmlEntitiesAll as encodeHtmlEntitiesAll, type encoding_encodeMode as encodeMode, encoding_encodeUrl as encodeUrl, encoding_isValidBase32 as isValidBase32 };
+}
+
+export { ALPHABETS as A, type Base32Alphabet as B, type DecodeResult as D, type EncodeResult as E, type UrlEncodeError as U, type Base64DecodeResult as a, type Base64EncodeResult as b, type Base64Error as c, type Base64Variant as d, encoding as e, type UrlEncodeMode as f, type UrlEncodeResult as g, type UrlResult as h, base32Decode as i, base32DecodeBytes as j, base32Encode as k, base32EncodeBytes as l, decodeBase64 as m, decodeHtmlEntities as n, decodeUrl as o, diffSegments as p, encodeBase64 as q, encodeHtmlEntities as r, encodeHtmlEntitiesAll as s, type encodeMode as t, encodeUrl as u, isValidBase32 as v };

package/dist/encoding-7gmq-vkV.d.ts

@@ -0,0 +1,108 @@
+/**
+ * @module encoding
+ * Encoding/decoding utilities for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *  - base64   : encodeBase64, decodeBase64
+ *  - url-encode: encodeUrl, decodeUrl, diffSegments
+ *  - html-entities: encodeHtmlEntities, decodeHtmlEntities, encodeHtmlEntitiesAll
+ *  - base32   : base32Encode, base32Decode, base32EncodeBytes, base32DecodeBytes, isValidBase32, ALPHABETS
+ */
+type Base64Variant = 'standard' | 'urlsafe';
+interface EncodeResult {
+    ok: true;
+    output: string;
+    inputBytes: number;
+    outputChars: number;
+}
+interface DecodeResult {
+    ok: true;
+    output: string;
+    outputBytes: number;
+}
+interface Base64Error {
+    ok: false;
+    error: string;
+}
+type Base64EncodeResult = EncodeResult | Base64Error;
+type Base64DecodeResult = DecodeResult | Base64Error;
+declare function encodeBase64(input: string, variant?: Base64Variant): Base64EncodeResult;
+declare function decodeBase64(input: string, variant?: Base64Variant): Base64DecodeResult;
+type UrlEncodeMode = 'component' | 'full';
+interface UrlEncodeResult {
+    ok: true;
+    output: string;
+    changed: boolean;
+}
+interface UrlEncodeError {
+    ok: false;
+    error: string;
+}
+type UrlResult = UrlEncodeResult | UrlEncodeError;
+/**
+ * component mode: encodeURIComponent — encodes everything except A-Z a-z 0-9 - _ . ! ~ * ' ( )
+ * full mode: encodeURI — preserves :/?#[]@!$&'()*+,;= so a complete URL stays valid
+ */
+declare function encodeUrl(input: string, mode?: UrlEncodeMode): UrlResult;
+declare function decodeUrl(input: string, mode?: UrlEncodeMode): UrlResult;
+declare function diffSegments(original: string, encoded: string): Array<{
+    text: string;
+    changed: boolean;
+}>;
+type encodeMode = 'minimal' | 'all';
+/**
+ * Encode the 5 HTML special characters to named entities.
+ */
+declare function encodeHtmlEntities(input: string): string;
+/**
+ * Decode named HTML entities (a fixed set) and numeric entities (decimal and hex).
+ */
+declare function decodeHtmlEntities(input: string): string;
+/**
+ * Encode ALL printable non-ASCII characters (charCode > 127) plus the 5 HTML
+ * special characters as numeric entities.
+ */
+declare function encodeHtmlEntitiesAll(input: string): string;
+type Base32Alphabet = 'standard' | 'hex' | 'crockford' | 'z-base-32';
+declare const ALPHABETS: Record<Base32Alphabet, string>;
+declare function base32EncodeBytes(bytes: Uint8Array, alphabet?: Base32Alphabet): string;
+declare function base32DecodeBytes(input: string, alphabet?: Base32Alphabet): Uint8Array | {
+    error: string;
+};
+declare function base32Encode(input: string, alphabet?: Base32Alphabet): string;
+declare function base32Decode(input: string, alphabet?: Base32Alphabet): string | {
+    error: string;
+};
+declare function isValidBase32(input: string, alphabet?: Base32Alphabet): boolean;
+
+declare const encoding_ALPHABETS: typeof ALPHABETS;
+type encoding_Base32Alphabet = Base32Alphabet;
+type encoding_Base64DecodeResult = Base64DecodeResult;
+type encoding_Base64EncodeResult = Base64EncodeResult;
+type encoding_Base64Error = Base64Error;
+type encoding_Base64Variant = Base64Variant;
+type encoding_DecodeResult = DecodeResult;
+type encoding_EncodeResult = EncodeResult;
+type encoding_UrlEncodeError = UrlEncodeError;
+type encoding_UrlEncodeMode = UrlEncodeMode;
+type encoding_UrlEncodeResult = UrlEncodeResult;
+type encoding_UrlResult = UrlResult;
+declare const encoding_base32Decode: typeof base32Decode;
+declare const encoding_base32DecodeBytes: typeof base32DecodeBytes;
+declare const encoding_base32Encode: typeof base32Encode;
+declare const encoding_base32EncodeBytes: typeof base32EncodeBytes;
+declare const encoding_decodeBase64: typeof decodeBase64;
+declare const encoding_decodeHtmlEntities: typeof decodeHtmlEntities;
+declare const encoding_decodeUrl: typeof decodeUrl;
+declare const encoding_diffSegments: typeof diffSegments;
+declare const encoding_encodeBase64: typeof encodeBase64;
+declare const encoding_encodeHtmlEntities: typeof encodeHtmlEntities;
+declare const encoding_encodeHtmlEntitiesAll: typeof encodeHtmlEntitiesAll;
+type encoding_encodeMode = encodeMode;
+declare const encoding_encodeUrl: typeof encodeUrl;
+declare const encoding_isValidBase32: typeof isValidBase32;
+declare namespace encoding {
+  export { encoding_ALPHABETS as ALPHABETS, type encoding_Base32Alphabet as Base32Alphabet, type encoding_Base64DecodeResult as Base64DecodeResult, type encoding_Base64EncodeResult as Base64EncodeResult, type encoding_Base64Error as Base64Error, type encoding_Base64Variant as Base64Variant, type encoding_DecodeResult as DecodeResult, type encoding_EncodeResult as EncodeResult, type encoding_UrlEncodeError as UrlEncodeError, type encoding_UrlEncodeMode as UrlEncodeMode, type encoding_UrlEncodeResult as UrlEncodeResult, type encoding_UrlResult as UrlResult, encoding_base32Decode as base32Decode, encoding_base32DecodeBytes as base32DecodeBytes, encoding_base32Encode as base32Encode, encoding_base32EncodeBytes as base32EncodeBytes, encoding_decodeBase64 as decodeBase64, encoding_decodeHtmlEntities as decodeHtmlEntities, encoding_decodeUrl as decodeUrl, encoding_diffSegments as diffSegments, encoding_encodeBase64 as encodeBase64, encoding_encodeHtmlEntities as encodeHtmlEntities, encoding_encodeHtmlEntitiesAll as encodeHtmlEntitiesAll, type encoding_encodeMode as encodeMode, encoding_encodeUrl as encodeUrl, encoding_isValidBase32 as isValidBase32 };
+}
+
+export { ALPHABETS as A, type Base32Alphabet as B, type DecodeResult as D, type EncodeResult as E, type UrlEncodeError as U, type Base64DecodeResult as a, type Base64EncodeResult as b, type Base64Error as c, type Base64Variant as d, encoding as e, type UrlEncodeMode as f, type UrlEncodeResult as g, type UrlResult as h, base32Decode as i, base32DecodeBytes as j, base32Encode as k, base32EncodeBytes as l, decodeBase64 as m, decodeHtmlEntities as n, decodeUrl as o, diffSegments as p, encodeBase64 as q, encodeHtmlEntities as r, encodeHtmlEntitiesAll as s, type encodeMode as t, encodeUrl as u, isValidBase32 as v };