@utilix-tech/sdk 0.1.2 → 0.2.0

package/dist/ai_agent-CcpkV2DR.d.ts

@@ -0,0 +1,393 @@
+/**
+ * @module ai_agent
+ * AI agent utility tools for the @utilix/sdk Node.js SDK.
+ *
+ * Tools covered:
+ *   - estimate-tokens       : estimateTokens, estimateCost
+ *   - pii-detector          : detectPii, redactPii
+ *   - secret-detector       : detectSecrets
+ *   - prompt-injection      : detectPromptInjection
+ *   - json-repair           : repairJson
+ */
+interface ModelPricing {
+    model: string;
+    label: string;
+    inputPer1M: number;
+    outputPer1M: number;
+}
+declare const MODEL_PRICING: ModelPricing[];
+interface TokenEstimate {
+    tokens: number;
+    chars: number;
+    words: number;
+    method: 'approximate';
+}
+interface CostEstimate {
+    model: string;
+    label: string;
+    inputCost: number;
+    outputCost: number;
+    totalCost: number;
+}
+interface TokenEstimateResult {
+    estimate: TokenEstimate;
+    costs: CostEstimate[];
+    model?: string;
+}
+/**
+ * Estimate token count using cl100k_base approximation.
+ * ~1 token per 4 chars, adjusted for whitespace and punctuation patterns.
+ */
+declare function estimateTokens(text: string): TokenEstimate;
+/**
+ * Estimate cost across all models for a given token count.
+ * Pass outputTokens to estimate output cost (defaults to same as input).
+ */
+declare function estimateCost(inputTokens: number, outputTokens?: number, model?: string): TokenEstimateResult;
+type PiiType = 'email' | 'phone' | 'ssn' | 'credit_card' | 'ip_address' | 'date_of_birth' | 'passport' | 'driver_license' | 'iban' | 'crypto_wallet';
+interface PiiFinding {
+    type: PiiType;
+    label: string;
+    value: string;
+    masked: string;
+    start: number;
+    end: number;
+}
+interface PiiDetectResult {
+    found: boolean;
+    count: number;
+    findings: PiiFinding[];
+    redacted?: string;
+}
+declare function detectPii(text: string): PiiDetectResult;
+declare function redactPii(text: string, replacement?: string): PiiDetectResult;
+type SecretType = 'openai_key' | 'anthropic_key' | 'aws_key' | 'github_token' | 'stripe_key' | 'google_api_key' | 'twilio_key' | 'jwt_token' | 'private_key' | 'generic_api_key' | 'slack_token' | 'sendgrid_key' | 'mailgun_key' | 'heroku_key' | 'npm_token';
+interface SecretFinding {
+    type: SecretType;
+    label: string;
+    value: string;
+    masked: string;
+    line: number;
+    column: number;
+}
+interface SecretDetectResult {
+    found: boolean;
+    count: number;
+    findings: SecretFinding[];
+    riskLevel: 'none' | 'low' | 'medium' | 'high' | 'critical';
+}
+declare function detectSecrets(text: string): SecretDetectResult;
+interface InjectionFinding {
+    pattern: string;
+    matched: string;
+    severity: 'low' | 'medium' | 'high';
+}
+interface InjectionDetectResult {
+    isInjection: boolean;
+    score: number;
+    severity: 'none' | 'low' | 'medium' | 'high';
+    findings: InjectionFinding[];
+}
+declare function detectPromptInjection(text: string): InjectionDetectResult;
+interface JsonRepairResult {
+    ok: boolean;
+    repaired: string;
+    original: string;
+    fixes: string[];
+    error?: string;
+}
+declare function repairJson(input: string): JsonRepairResult;
+type TrimStrategy = 'end' | 'start' | 'middle';
+interface TrimResult {
+    trimmed: string;
+    originalTokens: number;
+    trimmedTokens: number;
+    truncated: boolean;
+    removedChars: number;
+}
+declare function trimToTokens(text: string, maxTokens: number, strategy?: TrimStrategy): TrimResult;
+type ChunkStrategy = 'sentence' | 'paragraph' | 'fixed';
+interface TextChunk {
+    index: number;
+    text: string;
+    tokens: number;
+    startChar: number;
+    endChar: number;
+}
+declare function chunkText(text: string, chunkSize?: number, overlap?: number, strategy?: ChunkStrategy): TextChunk[];
+interface UrlMatch {
+    url: string;
+    protocol: string;
+    domain: string;
+    path: string;
+    position: number;
+}
+interface ExtractUrlsResult {
+    urls: UrlMatch[];
+    count: number;
+}
+declare function extractUrls(text: string): ExtractUrlsResult;
+interface SanitizeResult {
+    text: string;
+    removedTags: number;
+    removedScripts: number;
+    removedStyles: number;
+    originalLength: number;
+    cleanLength: number;
+}
+declare function sanitizeHtml(html: string, keepLinks?: boolean): SanitizeResult;
+declare function flattenJson(obj: unknown, separator?: string, prefix?: string): Record<string, unknown>;
+declare function unflattenJson(flat: Record<string, unknown>, separator?: string): unknown;
+type MergeStrategy = 'deep' | 'shallow' | 'replace-arrays';
+interface MergeResult {
+    merged: unknown;
+    conflicts: Array<{
+        path: string;
+        base: unknown;
+        override: unknown;
+    }>;
+}
+declare function mergeJson(base: unknown, override: unknown, strategy?: MergeStrategy): MergeResult;
+interface JsonBlock {
+    index: number;
+    raw: string;
+    parsed: unknown;
+    type: string;
+    source: 'code-block' | 'inline';
+    startPos: number;
+}
+interface ExtractJsonResult {
+    blocks: JsonBlock[];
+    count: number;
+}
+declare function extractJson(text: string): ExtractJsonResult;
+type DedupeStrategy = 'exact' | 'case-insensitive' | 'trimmed' | 'normalized';
+interface DedupeResult {
+    lines: string[];
+    originalCount: number;
+    uniqueCount: number;
+    removedCount: number;
+    duplicates: Array<{
+        line: string;
+        count: number;
+        firstLine: number;
+    }>;
+}
+declare function deduplicateLines(text: string, strategy?: DedupeStrategy): DedupeResult;
+interface Keyword {
+    word: string;
+    count: number;
+    score: number;
+    positions: number[];
+}
+interface ExtractKeywordsResult {
+    keywords: Keyword[];
+    totalWords: number;
+    uniqueWords: number;
+}
+declare function extractKeywords(text: string, maxKeywords?: number, minWordLen?: number): ExtractKeywordsResult;
+interface ValidationError {
+    path: string;
+    message: string;
+    value?: unknown;
+}
+interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+}
+declare function validateJsonSchema(data: unknown, schema: Record<string, unknown>): ValidationResult;
+type DiffOp2 = 'added' | 'removed' | 'changed' | 'unchanged';
+interface DiffEntry2 {
+    path: string;
+    op: DiffOp2;
+    oldValue?: unknown;
+    newValue?: unknown;
+}
+interface DiffResult2 {
+    entries: DiffEntry2[];
+    added: number;
+    removed: number;
+    changed: number;
+    unchanged: number;
+    totalPaths: number;
+}
+declare function diffJson(a: unknown, b: unknown): DiffResult2;
+interface TableResult2 {
+    index: number;
+    caption: string;
+    headers: string[];
+    rows: string[][];
+    rowCount: number;
+    colCount: number;
+}
+declare function extractTables(html: string): {
+    tables: TableResult2[];
+    count: number;
+};
+type EntityType2 = 'email' | 'phone' | 'date' | 'ip' | 'creditCard' | 'ssn' | 'iban' | 'hashtag' | 'mention' | 'currency';
+interface Entity2 {
+    type: EntityType2;
+    value: string;
+    position: number;
+}
+declare function extractEntities(text: string): {
+    entities: Entity2[];
+    byType: Partial<Record<EntityType2, Entity2[]>>;
+    count: number;
+};
+interface CompressHtmlResult {
+    compressed: string;
+    originalBytes: number;
+    compressedBytes: number;
+    originalTokens: number;
+    compressedTokens: number;
+    savings: number;
+    savingsPct: number;
+}
+declare function compressHtml(html: string, opts?: {
+    removeComments?: boolean;
+    removeScripts?: boolean;
+    removeStyles?: boolean;
+    collapseWhitespace?: boolean;
+}): CompressHtmlResult;
+interface CompressMarkdownResult {
+    compressed: string;
+    originalTokens: number;
+    compressedTokens: number;
+    savings: number;
+    savingsPct: number;
+    changes: string[];
+}
+declare function compressMarkdown(md: string, opts?: {
+    collapseBlankLines?: boolean;
+    removeComments?: boolean;
+    stripFrontmatter?: boolean;
+    trimLines?: boolean;
+    removeHorizontalRules?: boolean;
+}): CompressMarkdownResult;
+interface CompressJsonResult {
+    compressed: string;
+    originalTokens: number;
+    compressedTokens: number;
+    savings: number;
+    savingsPct: number;
+    removedNulls: number;
+    removedEmptyArrays: number;
+    removedEmptyObjects: number;
+}
+declare function compressJson(json: unknown, opts?: {
+    removeNulls?: boolean;
+    removeEmptyArrays?: boolean;
+    removeEmptyObjects?: boolean;
+    sortKeys?: boolean;
+}): CompressJsonResult;
+interface RankedChunk {
+    index: number;
+    text: string;
+    score: number;
+    matchedTerms: string[];
+}
+declare function rerankChunks(query: string, chunks: string[], topK?: number): {
+    ranked: RankedChunk[];
+    query: string;
+    totalChunks: number;
+};
+interface RelevanceResult {
+    score: number;
+    grade: 'high' | 'medium' | 'low' | 'none';
+    matchedTerms: string[];
+    coverage: number;
+}
+declare function scoreRelevance(query: string, passage: string): RelevanceResult;
+declare function expandQuery(query: string, maxSynonyms?: number): {
+    original: string;
+    expanded: string;
+    terms: string[];
+    synonymsAdded: string[];
+};
+interface SummaryResult {
+    summary: string;
+    originalTokens: number;
+    summaryTokens: number;
+    compressionRatio: number;
+    sentencesKept: number;
+    sentencesTotal: number;
+}
+declare function summarizeForLlm(text: string, maxTokens?: number, strategy?: 'extractive' | 'first' | 'last'): SummaryResult;
+
+type ai_agent_ChunkStrategy = ChunkStrategy;
+type ai_agent_CompressHtmlResult = CompressHtmlResult;
+type ai_agent_CompressJsonResult = CompressJsonResult;
+type ai_agent_CompressMarkdownResult = CompressMarkdownResult;
+type ai_agent_CostEstimate = CostEstimate;
+type ai_agent_DedupeResult = DedupeResult;
+type ai_agent_DedupeStrategy = DedupeStrategy;
+type ai_agent_DiffEntry2 = DiffEntry2;
+type ai_agent_DiffOp2 = DiffOp2;
+type ai_agent_DiffResult2 = DiffResult2;
+type ai_agent_Entity2 = Entity2;
+type ai_agent_EntityType2 = EntityType2;
+type ai_agent_ExtractJsonResult = ExtractJsonResult;
+type ai_agent_ExtractKeywordsResult = ExtractKeywordsResult;
+type ai_agent_ExtractUrlsResult = ExtractUrlsResult;
+type ai_agent_InjectionDetectResult = InjectionDetectResult;
+type ai_agent_InjectionFinding = InjectionFinding;
+type ai_agent_JsonBlock = JsonBlock;
+type ai_agent_JsonRepairResult = JsonRepairResult;
+type ai_agent_Keyword = Keyword;
+declare const ai_agent_MODEL_PRICING: typeof MODEL_PRICING;
+type ai_agent_MergeResult = MergeResult;
+type ai_agent_MergeStrategy = MergeStrategy;
+type ai_agent_ModelPricing = ModelPricing;
+type ai_agent_PiiDetectResult = PiiDetectResult;
+type ai_agent_PiiFinding = PiiFinding;
+type ai_agent_PiiType = PiiType;
+type ai_agent_RankedChunk = RankedChunk;
+type ai_agent_RelevanceResult = RelevanceResult;
+type ai_agent_SanitizeResult = SanitizeResult;
+type ai_agent_SecretDetectResult = SecretDetectResult;
+type ai_agent_SecretFinding = SecretFinding;
+type ai_agent_SecretType = SecretType;
+type ai_agent_SummaryResult = SummaryResult;
+type ai_agent_TableResult2 = TableResult2;
+type ai_agent_TextChunk = TextChunk;
+type ai_agent_TokenEstimate = TokenEstimate;
+type ai_agent_TokenEstimateResult = TokenEstimateResult;
+type ai_agent_TrimResult = TrimResult;
+type ai_agent_TrimStrategy = TrimStrategy;
+type ai_agent_UrlMatch = UrlMatch;
+type ai_agent_ValidationError = ValidationError;
+type ai_agent_ValidationResult = ValidationResult;
+declare const ai_agent_chunkText: typeof chunkText;
+declare const ai_agent_compressHtml: typeof compressHtml;
+declare const ai_agent_compressJson: typeof compressJson;
+declare const ai_agent_compressMarkdown: typeof compressMarkdown;
+declare const ai_agent_deduplicateLines: typeof deduplicateLines;
+declare const ai_agent_detectPii: typeof detectPii;
+declare const ai_agent_detectPromptInjection: typeof detectPromptInjection;
+declare const ai_agent_detectSecrets: typeof detectSecrets;
+declare const ai_agent_diffJson: typeof diffJson;
+declare const ai_agent_estimateCost: typeof estimateCost;
+declare const ai_agent_estimateTokens: typeof estimateTokens;
+declare const ai_agent_expandQuery: typeof expandQuery;
+declare const ai_agent_extractEntities: typeof extractEntities;
+declare const ai_agent_extractJson: typeof extractJson;
+declare const ai_agent_extractKeywords: typeof extractKeywords;
+declare const ai_agent_extractTables: typeof extractTables;
+declare const ai_agent_extractUrls: typeof extractUrls;
+declare const ai_agent_flattenJson: typeof flattenJson;
+declare const ai_agent_mergeJson: typeof mergeJson;
+declare const ai_agent_redactPii: typeof redactPii;
+declare const ai_agent_repairJson: typeof repairJson;
+declare const ai_agent_rerankChunks: typeof rerankChunks;
+declare const ai_agent_sanitizeHtml: typeof sanitizeHtml;
+declare const ai_agent_scoreRelevance: typeof scoreRelevance;
+declare const ai_agent_summarizeForLlm: typeof summarizeForLlm;
+declare const ai_agent_trimToTokens: typeof trimToTokens;
+declare const ai_agent_unflattenJson: typeof unflattenJson;
+declare const ai_agent_validateJsonSchema: typeof validateJsonSchema;
+declare namespace ai_agent {
+  export { type ai_agent_ChunkStrategy as ChunkStrategy, type ai_agent_CompressHtmlResult as CompressHtmlResult, type ai_agent_CompressJsonResult as CompressJsonResult, type ai_agent_CompressMarkdownResult as CompressMarkdownResult, type ai_agent_CostEstimate as CostEstimate, type ai_agent_DedupeResult as DedupeResult, type ai_agent_DedupeStrategy as DedupeStrategy, type ai_agent_DiffEntry2 as DiffEntry2, type ai_agent_DiffOp2 as DiffOp2, type ai_agent_DiffResult2 as DiffResult2, type ai_agent_Entity2 as Entity2, type ai_agent_EntityType2 as EntityType2, type ai_agent_ExtractJsonResult as ExtractJsonResult, type ai_agent_ExtractKeywordsResult as ExtractKeywordsResult, type ai_agent_ExtractUrlsResult as ExtractUrlsResult, type ai_agent_InjectionDetectResult as InjectionDetectResult, type ai_agent_InjectionFinding as InjectionFinding, type ai_agent_JsonBlock as JsonBlock, type ai_agent_JsonRepairResult as JsonRepairResult, type ai_agent_Keyword as Keyword, ai_agent_MODEL_PRICING as MODEL_PRICING, type ai_agent_MergeResult as MergeResult, type ai_agent_MergeStrategy as MergeStrategy, type ai_agent_ModelPricing as ModelPricing, type ai_agent_PiiDetectResult as PiiDetectResult, type ai_agent_PiiFinding as PiiFinding, type ai_agent_PiiType as PiiType, type ai_agent_RankedChunk as RankedChunk, type ai_agent_RelevanceResult as RelevanceResult, type ai_agent_SanitizeResult as SanitizeResult, type ai_agent_SecretDetectResult as SecretDetectResult, type ai_agent_SecretFinding as SecretFinding, type ai_agent_SecretType as SecretType, type ai_agent_SummaryResult as SummaryResult, type ai_agent_TableResult2 as TableResult2, type ai_agent_TextChunk as TextChunk, type ai_agent_TokenEstimate as TokenEstimate, type ai_agent_TokenEstimateResult as TokenEstimateResult, type ai_agent_TrimResult as TrimResult, type ai_agent_TrimStrategy as TrimStrategy, type ai_agent_UrlMatch as UrlMatch, type ai_agent_ValidationError as ValidationError, type ai_agent_ValidationResult as ValidationResult, ai_agent_chunkText as chunkText, ai_agent_compressHtml as compressHtml, ai_agent_compressJson as compressJson, ai_agent_compressMarkdown as compressMarkdown, ai_agent_deduplicateLines as deduplicateLines, ai_agent_detectPii as detectPii, ai_agent_detectPromptInjection as detectPromptInjection, ai_agent_detectSecrets as detectSecrets, ai_agent_diffJson as diffJson, ai_agent_estimateCost as estimateCost, ai_agent_estimateTokens as estimateTokens, ai_agent_expandQuery as expandQuery, ai_agent_extractEntities as extractEntities, ai_agent_extractJson as extractJson, ai_agent_extractKeywords as extractKeywords, ai_agent_extractTables as extractTables, ai_agent_extractUrls as extractUrls, ai_agent_flattenJson as flattenJson, ai_agent_mergeJson as mergeJson, ai_agent_redactPii as redactPii, ai_agent_repairJson as repairJson, ai_agent_rerankChunks as rerankChunks, ai_agent_sanitizeHtml as sanitizeHtml, ai_agent_scoreRelevance as scoreRelevance, ai_agent_summarizeForLlm as summarizeForLlm, ai_agent_trimToTokens as trimToTokens, ai_agent_unflattenJson as unflattenJson, ai_agent_validateJsonSchema as validateJsonSchema };
+}
+
+export { estimateCost as $, type TokenEstimate as A, type TokenEstimateResult as B, type ChunkStrategy as C, type DedupeResult as D, type Entity2 as E, type TrimResult as F, type TrimStrategy as G, type ValidationResult as H, type InjectionDetectResult as I, type JsonBlock as J, type Keyword as K, chunkText as L, MODEL_PRICING as M, compressHtml as N, compressJson as O, type PiiDetectResult as P, compressMarkdown as Q, type RankedChunk as R, type SanitizeResult as S, type TableResult2 as T, type UrlMatch as U, type ValidationError as V, deduplicateLines as W, detectPii as X, detectPromptInjection as Y, detectSecrets as Z, diffJson as _, ai_agent as a, estimateTokens as a0, expandQuery as a1, extractEntities as a2, extractJson as a3, extractKeywords as a4, extractTables as a5, extractUrls as a6, flattenJson as a7, mergeJson as a8, redactPii as a9, repairJson as aa, rerankChunks as ab, sanitizeHtml as ac, scoreRelevance as ad, summarizeForLlm as ae, trimToTokens as af, unflattenJson as ag, validateJsonSchema as ah, type CompressHtmlResult as b, type CompressJsonResult as c, type CompressMarkdownResult as d, type CostEstimate as e, type DedupeStrategy as f, type DiffEntry2 as g, type DiffOp2 as h, type DiffResult2 as i, type EntityType2 as j, type ExtractJsonResult as k, type ExtractKeywordsResult as l, type ExtractUrlsResult as m, type InjectionFinding as n, type JsonRepairResult as o, type MergeResult as p, type MergeStrategy as q, type ModelPricing as r, type PiiFinding as s, type PiiType as t, type RelevanceResult as u, type SecretDetectResult as v, type SecretFinding as w, type SecretType as x, type SummaryResult as y, type TextChunk as z };