edgar-cli 0.1.3 → 0.2.1

package/dist/commands/facts.d.ts

@@ -1,8 +0,0 @@
-import { CommandContext, CommandResult } from '../core/runtime.js';
-export declare function runFactsGet(params: {
-    id: string;
-    taxonomy?: 'us-gaap' | 'dei';
-    concept?: string;
-    unit?: string;
-    latest?: boolean;
-}, context: CommandContext): Promise<CommandResult>;

package/dist/commands/facts.js

@@ -1,125 +0,0 @@
-import { CLIError, ErrorCode } from '../core/errors.js';
-import { companyFactsUrl } from '../sec/endpoints.js';
-import { resolveEntity } from '../sec/ticker-map.js';
-function buildConceptSummary(taxonomyFacts) {
-    return Object.entries(taxonomyFacts)
-        .map(([concept, payload]) => {
-        const units = Object.keys(payload.units ?? {});
-        return {
-            concept,
-            label: payload.label ?? null,
-            unit_count: units.length,
-            units
-        };
-    })
-        .sort((a, b) => a.concept.localeCompare(b.concept));
-}
-function pickLatest(points) {
-    if (points.length === 0) {
-        return null;
-    }
-    const sorted = [...points].sort((a, b) => {
-        const aKey = a.filed ?? a.end ?? '';
-        const bKey = b.filed ?? b.end ?? '';
-        return bKey.localeCompare(aKey);
-    });
-    return sorted[0] ?? null;
-}
-function selectTaxonomy(allFacts, concept, taxonomy) {
-    if (taxonomy) {
-        if (!allFacts[taxonomy]) {
-            throw new CLIError(ErrorCode.NOT_FOUND, `Taxonomy ${taxonomy} not found`);
-        }
-        return taxonomy;
-    }
-    const preferred = ['us-gaap', 'dei'];
-    for (const tax of preferred) {
-        if (allFacts[tax]?.[concept]) {
-            return tax;
-        }
-    }
-    const anyTaxonomy = Object.keys(allFacts).find((tax) => Boolean(allFacts[tax]?.[concept]));
-    if (anyTaxonomy) {
-        return anyTaxonomy;
-    }
-    throw new CLIError(ErrorCode.NOT_FOUND, `Concept ${concept} not found in company facts`);
-}
-export async function runFactsGet(params, context) {
-    const entity = await resolveEntity(params.id, context.secClient, { strictMapMatch: false });
-    const payload = await context.secClient.fetchSecJson(companyFactsUrl(entity.cik));
-    const allFacts = payload.facts ?? {};
-    if (!params.concept) {
-        if (params.taxonomy) {
-            const taxonomyFacts = allFacts[params.taxonomy];
-            if (!taxonomyFacts) {
-                throw new CLIError(ErrorCode.NOT_FOUND, `Taxonomy ${params.taxonomy} not found`);
-            }
-            return {
-                data: {
-                    cik: entity.cik,
-                    entityName: payload.entityName,
-                    taxonomy: params.taxonomy,
-                    concept_count: Object.keys(taxonomyFacts).length,
-                    concepts: buildConceptSummary(taxonomyFacts)
-                }
-            };
-        }
-        const taxonomySummary = Object.fromEntries(Object.entries(allFacts).map(([taxonomy, taxonomyFacts]) => [
-            taxonomy,
-            {
-                concept_count: Object.keys(taxonomyFacts).length
-            }
-        ]));
-        return {
-            data: {
-                cik: entity.cik,
-                entityName: payload.entityName,
-                taxonomies: taxonomySummary
-            }
-        };
-    }
-    const concept = params.concept;
-    const taxonomy = selectTaxonomy(allFacts, concept, params.taxonomy);
-    const conceptData = allFacts[taxonomy]?.[concept];
-    if (!conceptData) {
-        throw new CLIError(ErrorCode.NOT_FOUND, `Concept ${concept} not found in taxonomy ${taxonomy}`);
-    }
-    const rawUnits = conceptData.units ?? {};
-    let selectedUnits;
-    if (params.unit) {
-        if (!rawUnits[params.unit]) {
-            throw new CLIError(ErrorCode.NOT_FOUND, `Unit ${params.unit} not found for ${taxonomy}:${concept}`);
-        }
-        selectedUnits = {
-            [params.unit]: rawUnits[params.unit]
-        };
-    }
-    else {
-        selectedUnits = rawUnits;
-    }
-    if (params.latest) {
-        const latestByUnit = Object.fromEntries(Object.entries(selectedUnits).map(([unitName, points]) => [unitName, pickLatest(points)]));
-        return {
-            data: {
-                cik: entity.cik,
-                entityName: payload.entityName,
-                taxonomy,
-                concept,
-                label: conceptData.label ?? null,
-                description: conceptData.description ?? null,
-                latest: latestByUnit
-            }
-        };
-    }
-    return {
-        data: {
-            cik: entity.cik,
-            entityName: payload.entityName,
-            taxonomy,
-            concept,
-            label: conceptData.label ?? null,
-            description: conceptData.description ?? null,
-            units: selectedUnits
-        }
-    };
-}

package/dist/commands/filings.d.ts

@@ -1,14 +0,0 @@
-import { CommandContext, CommandResult } from '../core/runtime.js';
-export declare function runFilingsList(params: {
-    id: string;
-    form?: string;
-    from?: string;
-    to?: string;
-    queryLimit?: number;
-    offset?: number;
-}, context: CommandContext): Promise<CommandResult>;
-export declare function runFilingsGet(params: {
-    id: string;
-    accession: string;
-    format: 'url' | 'html' | 'text' | 'markdown';
-}, context: CommandContext): Promise<CommandResult>;

package/dist/commands/filings.js

@@ -1,198 +0,0 @@
-import TurndownService from 'turndown';
-import { gfm } from '@joplin/turndown-plugin-gfm';
-import { CLIError, ErrorCode } from '../core/errors.js';
-import { filingDocumentUrl, submissionsUrl } from '../sec/endpoints.js';
-import { dateInRange, normalizeAccession } from '../sec/normalizers.js';
-import { resolveEntity } from '../sec/ticker-map.js';
-function buildMarkdownConverter() {
-    const service = new TurndownService({
-        headingStyle: 'atx',
-        hr: '---',
-        bulletListMarker: '-',
-        codeBlockStyle: 'fenced',
-        fence: '```',
-        emDelimiter: '*',
-        strongDelimiter: '**',
-        linkStyle: 'inlined'
-    });
-    service.use(gfm);
-    service.remove(['script', 'style', 'noscript', 'iframe', 'canvas']);
-    return service;
-}
-const markdownConverter = buildMarkdownConverter();
-function stripInlineXbrlHeaders(content) {
-    return content
-        .replace(/<ix:header[\s\S]*?<\/ix:header>/gi, '')
-        .replace(/<ix:hidden[\s\S]*?<\/ix:hidden>/gi, '')
-        .replace(/<ix:resources[\s\S]*?<\/ix:resources>/gi, '');
-}
-function splitMarkdownTableCells(line) {
-    const trimmed = line.trim();
-    const withoutLeadingPipe = trimmed.startsWith('|') ? trimmed.slice(1) : trimmed;
-    const withoutTrailingPipe = withoutLeadingPipe.endsWith('|')
-        ? withoutLeadingPipe.slice(0, -1)
-        : withoutLeadingPipe;
-    return withoutTrailingPipe.split('|').map((cell) => cell.trim());
-}
-function isMarkdownTableSeparatorLine(line) {
-    const cells = splitMarkdownTableCells(line);
-    if (cells.length === 0) {
-        return false;
-    }
-    return cells.every((cell) => /^:?-{3,}:?$/.test(cell.replace(/\s+/g, '')));
-}
-function collapseLayoutTables(markdown) {
-    const lines = markdown.split('\n');
-    const output = [];
-    for (let idx = 0; idx < lines.length; idx += 1) {
-        const line = lines[idx];
-        if (!line.trimStart().startsWith('|')) {
-            output.push(line);
-            continue;
-        }
-        const tableBlock = [line];
-        while (idx + 1 < lines.length && lines[idx + 1].trimStart().startsWith('|')) {
-            idx += 1;
-            tableBlock.push(lines[idx]);
-        }
-        const hasSeparator = tableBlock.some(isMarkdownTableSeparatorLine);
-        if (!hasSeparator) {
-            output.push(...tableBlock);
-            continue;
-        }
-        const dataRows = tableBlock.filter((row) => !isMarkdownTableSeparatorLine(row));
-        const nonEmptyCellCounts = dataRows.map((row) => splitMarkdownTableCells(row).filter((cell) => cell.length > 0).length);
-        const maxNonEmptyCells = Math.max(...nonEmptyCellCounts, 0);
-        const avgNonEmptyCells = nonEmptyCellCounts.reduce((sum, count) => sum + count, 0) /
-            Math.max(nonEmptyCellCounts.length, 1);
-        const isLayoutTable = maxNonEmptyCells <= 1 || avgNonEmptyCells <= 1.2;
-        if (!isLayoutTable) {
-            output.push(...tableBlock);
-            continue;
-        }
-        const flattenedRows = dataRows
-            .map((row) => splitMarkdownTableCells(row).filter((cell) => cell.length > 0).join(' '))
-            .map((row) => row.replace(/\s+/g, ' ').trim())
-            .filter((row) => row.length > 0);
-        if (flattenedRows.length > 0) {
-            output.push(...flattenedRows, '');
-        }
-    }
-    return output.join('\n').replace(/\n{3,}/g, '\n\n').trim();
-}
-function zipRecentFilings(cik, recent) {
-    if (!recent) {
-        return [];
-    }
-    const accessionNumbers = recent.accessionNumber ?? [];
-    const forms = recent.form ?? [];
-    const filingDates = recent.filingDate ?? [];
-    const reportDates = recent.reportDate ?? [];
-    const primaryDocuments = recent.primaryDocument ?? [];
-    const rowCount = accessionNumbers.length;
-    const rows = [];
-    for (let idx = 0; idx < rowCount; idx += 1) {
-        const accession = accessionNumbers[idx];
-        if (!accession) {
-            continue;
-        }
-        const primaryDocument = primaryDocuments[idx] ?? null;
-        const filingUrl = primaryDocument && primaryDocument.length > 0
-            ? filingDocumentUrl({
-                cik,
-                accession,
-                primaryDocument
-            })
-            : null;
-        rows.push({
-            accession,
-            form: forms[idx] ?? null,
-            filingDate: filingDates[idx] ?? null,
-            reportDate: reportDates[idx] ?? null,
-            primaryDocument,
-            filingUrl
-        });
-    }
-    return rows;
-}
-function extractMarkdownFromHtml(content) {
-    const sanitizedHtml = stripInlineXbrlHeaders(content);
-    const markdown = markdownConverter
-        .turndown(sanitizedHtml)
-        .replace(/\u00a0/g, ' ')
-        .replace(/\r/g, '')
-        .replace(/[ \t]+\n/g, '\n')
-        .replace(/\n[ \t]+/g, '\n')
-        .replace(/\n{3,}/g, '\n\n')
-        .trim();
-    return collapseLayoutTables(markdown);
-}
-export async function runFilingsList(params, context) {
-    const entity = await resolveEntity(params.id, context.secClient, { strictMapMatch: false });
-    const submissions = await context.secClient.fetchSecJson(submissionsUrl(entity.cik));
-    const rows = zipRecentFilings(entity.cik, submissions.filings?.recent);
-    const normalizedForm = params.form?.toUpperCase();
-    const filteredRows = rows.filter((row) => {
-        if (normalizedForm && (row.form ?? '').toUpperCase() !== normalizedForm) {
-            return false;
-        }
-        if (!row.filingDate) {
-            return !params.from && !params.to;
-        }
-        return dateInRange(row.filingDate, params.from, params.to);
-    });
-    const offset = params.offset ?? 0;
-    const queryLimit = params.queryLimit ?? filteredRows.length;
-    const pagedRows = filteredRows.slice(offset, offset + queryLimit);
-    return {
-        data: pagedRows,
-        metaUpdates: {
-            query_total_count: filteredRows.length,
-            query_returned_count: pagedRows.length,
-            query_truncated: offset + pagedRows.length < filteredRows.length,
-            query_offset: offset
-        }
-    };
-}
-export async function runFilingsGet(params, context) {
-    const accession = normalizeAccession(params.accession);
-    const entity = await resolveEntity(params.id, context.secClient, { strictMapMatch: false });
-    const submissions = await context.secClient.fetchSecJson(submissionsUrl(entity.cik));
-    const rows = zipRecentFilings(entity.cik, submissions.filings?.recent);
-    const match = rows.find((row) => row.accession === accession);
-    if (!match) {
-        throw new CLIError(ErrorCode.NOT_FOUND, `Accession ${accession} not found in recent submissions for ${params.id}`);
-    }
-    if (!match.primaryDocument || !match.filingUrl) {
-        throw new CLIError(ErrorCode.NOT_FOUND, `No primary document found for accession ${accession}`);
-    }
-    if (params.format === 'url') {
-        return {
-            data: {
-                accession: match.accession,
-                form: match.form,
-                filingDate: match.filingDate,
-                reportDate: match.reportDate,
-                primaryDocument: match.primaryDocument,
-                url: match.filingUrl
-            }
-        };
-    }
-    const content = await context.secClient.fetchSecText(match.filingUrl);
-    if (params.format === 'html') {
-        return {
-            data: {
-                accession: match.accession,
-                url: match.filingUrl,
-                content
-            }
-        };
-    }
-    return {
-        data: {
-            accession: match.accession,
-            url: match.filingUrl,
-            content: extractMarkdownFromHtml(content)
-        }
-    };
-}

package/dist/commands/research.d.ts

@@ -1,28 +0,0 @@
-import { CommandContext, CommandResult } from '../core/runtime.js';
-type ResearchProfile = 'core' | 'events' | 'financials';
-export declare function parseResearchProfile(value: string): ResearchProfile;
-export declare function runResearchSync(params: {
-    id: string;
-    profile: ResearchProfile;
-    cacheDir?: string;
-    refresh?: boolean;
-}, context: CommandContext): Promise<CommandResult>;
-export declare function runResearchAsk(params: {
-    query: string;
-    docs: string[];
-    manifestPath?: string;
-    topK: number;
-    chunkLines: number;
-    chunkOverlap: number;
-}, context: CommandContext): Promise<CommandResult>;
-export declare function runResearchAskById(params: {
-    id: string;
-    query: string;
-    profile: ResearchProfile;
-    cacheDir?: string;
-    refresh?: boolean;
-    topK: number;
-    chunkLines: number;
-    chunkOverlap: number;
-}, context: CommandContext): Promise<CommandResult>;
-export {};