@cyanheads/secedgar-mcp-server 0.1.9

package/dist/mcp-server/tools/definitions/search-filings.tool.js

@@ -0,0 +1,179 @@
+/**
+ * @fileoverview Full-text search across all EDGAR filing documents since 1993.
+ * @module mcp-server/tools/definitions/search-filings
+ */
+import { tool, z } from '@cyanheads/mcp-ts-core';
+import { validationError } from '@cyanheads/mcp-ts-core/errors';
+import { getEdgarApiService } from '../../../services/edgar/edgar-api-service.js';
+/**
+ * Extract entity targeting (cik: or ticker:) from a query string,
+ * resolve to a CIK, and return the cleaned query + resolved CIK.
+ */
+async function resolveEntityTargeting(query) {
+    const tickerMatch = query.match(/\bticker:(\S+)/i);
+    const cikMatch = query.match(/\bcik:(\S+)/i);
+    const api = getEdgarApiService();
+    if (tickerMatch?.[1]) {
+        const token = tickerMatch[0];
+        const ticker = tickerMatch[1];
+        const resolved = await api.resolveCik(ticker);
+        const match = Array.isArray(resolved) ? resolved[0] : resolved;
+        if (match?.name) {
+            return {
+                query: query.replace(token, `"${match.name}"`).trim(),
+                entityCik: match.cik,
+            };
+        }
+        return { query: query.replace(token, '').trim() };
+    }
+    if (cikMatch?.[1]) {
+        const token = cikMatch[0];
+        const rawCik = cikMatch[1];
+        const padded = rawCik.padStart(10, '0');
+        const resolved = await api.resolveCik(rawCik);
+        const match = Array.isArray(resolved) ? resolved[0] : resolved;
+        if (match?.name) {
+            return {
+                query: query.replace(token, `"${match.name}"`).trim(),
+                entityCik: padded,
+            };
+        }
+        return { query: query.replace(token, '').trim(), entityCik: padded };
+    }
+    return { query };
+}
+export const searchFilingsTool = tool('secedgar_search_filings', {
+    description: 'Full-text search across all EDGAR filing documents since 1993. ' +
+        'Supports exact phrases, boolean operators, wildcards, and entity targeting (ticker:AAPL or cik:320193 in query).',
+    annotations: { readOnlyHint: true, idempotentHint: true, openWorldHint: true },
+    input: z.object({
+        query: z
+            .string()
+            .min(1)
+            .describe('Full-text search query. Supports: exact phrases ("material weakness"), ' +
+            'boolean operators (revenue OR income), exclusion (-preliminary), ' +
+            'wildcard suffix (account*), entity targeting (ticker:AAPL or cik:320193 in the query). ' +
+            "Terms are AND'd by default."),
+        forms: z
+            .array(z.string())
+            .optional()
+            .describe('Filter to specific form types (e.g., ["10-K", "10-Q", "8-K"]). Without this, searches all form types.'),
+        start_date: z
+            .string()
+            .optional()
+            .describe('Start of date range (YYYY-MM-DD). Both start_date and end_date must be provided for date filtering.'),
+        end_date: z
+            .string()
+            .optional()
+            .describe('End of date range (YYYY-MM-DD). Both start_date and end_date must be provided for date filtering.'),
+        limit: z
+            .number()
+            .int()
+            .min(1)
+            .max(100)
+            .default(20)
+            .describe('Results per page. Max 100. Default 20 to keep responses concise.'),
+        offset: z
+            .number()
+            .int()
+            .min(0)
+            .default(0)
+            .describe('Pagination offset. Increment by limit for next page. Hard cap at 10,000 total results.'),
+    }),
+    output: z.object({
+        total: z.number().describe('Total matching filings (capped at 10,000).'),
+        total_is_exact: z.boolean().describe('False when total hits the 10,000 cap.'),
+        results: z
+            .array(z.object({
+            accession_number: z
+                .string()
+                .describe('Use with secedgar_get_filing to retrieve content.'),
+            form: z.string().optional().describe('Form type.'),
+            filing_date: z.string().describe('Date filed.'),
+            period_ending: z.string().optional().describe('Period of report.'),
+            company_name: z.string().describe('Filing entity name.'),
+            cik: z.string().describe('Company CIK.'),
+            file_description: z.string().optional().describe('Document description.'),
+            sic: z.string().optional().describe('SIC code.'),
+            location: z.string().optional().describe('Business location.'),
+        }))
+            .describe('Matching filings.'),
+        form_distribution: z
+            .record(z.string(), z.number())
+            .optional()
+            .describe('Count of results by form type. Helps narrow follow-up searches.'),
+    }),
+    async handler(input, ctx) {
+        // Validate date range: both or neither
+        if ((input.start_date && !input.end_date) || (!input.start_date && input.end_date)) {
+            throw validationError('Both start_date and end_date are required when filtering by date.');
+        }
+        // Resolve ticker:/cik: entity targeting → company name in query + CIK for filtering
+        const { query, entityCik } = await resolveEntityTargeting(input.query);
+        // When entity-filtering, over-fetch from EFTS since we'll post-filter by CIK
+        const fetchSize = entityCik ? 100 : input.limit;
+        const api = getEdgarApiService();
+        const response = await api.searchFilings({
+            query,
+            forms: input.forms,
+            startDate: input.start_date,
+            endDate: input.end_date,
+            from: input.offset,
+            size: fetchSize,
+        });
+        let total = response.hits.total.value;
+        let totalIsExact = response.hits.total.relation === 'eq';
+        // search-index endpoint ignores size/from params (always returns up to 100),
+        // so apply client-side slicing to respect the requested limit
+        let hits = response.hits.hits;
+        // Post-filter by entity CIK when entity targeting was used
+        if (entityCik) {
+            hits = hits.filter((h) => h._source.ciks?.includes(entityCik));
+            total = hits.length;
+            totalIsExact = true;
+        }
+        const sliced = hits.slice(0, input.limit);
+        const results = sliced.map((hit) => {
+            const accessionNumber = hit._source.adsh || hit._id.split(':')[0] || hit._id;
+            return {
+                accession_number: accessionNumber,
+                form: hit._source.form ?? undefined,
+                filing_date: hit._source.file_date,
+                period_ending: hit._source.period_ending ?? undefined,
+                company_name: hit._source.display_names?.[0] || '',
+                cik: hit._source.ciks?.[0] || '',
+                file_description: hit._source.file_description ?? undefined,
+                sic: hit._source.sics?.[0] ?? undefined,
+                location: hit._source.biz_locations?.[0] ?? undefined,
+            };
+        });
+        // Extract form distribution from aggregations
+        let formDistribution;
+        if (response.aggregations?.form_filter?.buckets) {
+            formDistribution = {};
+            for (const bucket of response.aggregations.form_filter.buckets) {
+                formDistribution[bucket.key] = bucket.doc_count;
+            }
+        }
+        ctx.log.info('Filing search completed', {
+            query: input.query,
+            total,
+            resultCount: results.length,
+        });
+        return { total, total_is_exact: totalIsExact, results, form_distribution: formDistribution };
+    },
+    format: (result) => {
+        const lines = [`Found ${result.total}${result.total_is_exact ? '' : '+'} filings`];
+        for (const r of result.results) {
+            lines.push(`- ${r.form ?? 'N/A'} ${r.filing_date} — ${r.company_name} [${r.accession_number}]`);
+        }
+        if (result.form_distribution) {
+            const dist = Object.entries(result.form_distribution)
+                .map(([k, v]) => `${k}: ${v}`)
+                .join(', ');
+            lines.push(`\nForm distribution: ${dist}`);
+        }
+        return [{ type: 'text', text: lines.join('\n') }];
+    },
+});
+//# sourceMappingURL=search-filings.tool.js.map

package/dist/mcp-server/tools/definitions/search-filings.tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-filings.tool.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/definitions/search-filings.tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAE3E;;;GAGG;AACH,KAAK,UAAU,sBAAsB,CACnC,KAAa;IAEb,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAE7C,MAAM,GAAG,GAAG,kBAAkB,EAAE,CAAC;IAEjC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,IAAI,KAAK,EAAE,IAAI,EAAE,CAAC;YAChB,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;gBACrD,SAAS,EAAE,KAAK,CAAC,GAAG;aACrB,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IACpD,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/D,IAAI,KAAK,EAAE,IAAI,EAAE,CAAC;YAChB,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;gBACrD,SAAS,EAAE,MAAM;aAClB,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,EAAE;IAC/D,WAAW,EACT,iEAAiE;QACjE,kHAAkH;IACpH,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE;IAE9E,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,yEAAyE;YACvE,mEAAmE;YACnE,yFAAyF;YACzF,6BAA6B,CAChC;QACH,KAAK,EAAE,CAAC;aACL,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;aACjB,QAAQ,EAAE;aACV,QAAQ,CACP,uGAAuG,CACxG;QACH,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,qGAAqG,CACtG;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,mGAAmG,CACpG;QACH,KAAK,EAAE,CAAC;aACL,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;aACR,OAAO,CAAC,EAAE,CAAC;aACX,QAAQ,CAAC,kEAAkE,CAAC;QAC/E,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,OAAO,CAAC,CAAC,CAAC;aACV,QAAQ,CACP,wFAAwF,CACzF;KACJ,CAAC;IAEF,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;QACxE,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;QAC7E,OAAO,EAAE,CAAC;aACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,gBAAgB,EAAE,CAAC;iBAChB,MAAM,EAAE;iBACR,QAAQ,CAAC,mDAAmD,CAAC;YAChE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;YAClD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;YAC/C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YAClE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;YACxD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;YACxC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;YACzE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC;YAChD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;SAC/D,CAAC,CACH;aACA,QAAQ,CAAC,mBAAmB,CAAC;QAChC,iBAAiB,EAAE,CAAC;aACjB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;aAC9B,QAAQ,EAAE;aACV,QAAQ,CAAC,iEAAiE,CAAC;KAC/E,CAAC;IAEF,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG;QACtB,uCAAuC;QACvC,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnF,MAAM,eAAe,CAAC,mEAAmE,CAAC,CAAC;QAC7F,CAAC;QAED,oFAAoF;QACpF,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,sBAAsB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEvE,6EAA6E;QAC7E,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QAEhD,MAAM,GAAG,GAAG,kBAAkB,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,aAAa,CAAC;YACvC,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,SAAS,EAAE,KAAK,CAAC,UAAU;YAC3B,OAAO,EAAE,KAAK,CAAC,QAAQ;YACvB,IAAI,EAAE,KAAK,CAAC,MAAM;YAClB,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;QAEH,IAAI,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QACtC,IAAI,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC;QAEzD,6EAA6E;QAC7E,8DAA8D;QAC9D,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QAE9B,2DAA2D;QAC3D,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;YAC/D,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;YACpB,YAAY,GAAG,IAAI,CAAC;QACtB,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACjC,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC;YAE7E,OAAO;gBACL,gBAAgB,EAAE,eAAe;gBACjC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,SAAS;gBACnC,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS;gBAClC,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,SAAS;gBACrD,YAAY,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;gBAClD,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;gBAChC,gBAAgB,EAAE,GAAG,CAAC,OAAO,CAAC,gBAAgB,IAAI,SAAS;gBAC3D,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS;gBACvC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS;aACtD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,gBAAoD,CAAC;QACzD,IAAI,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;YAChD,gBAAgB,GAAG,EAAE,CAAC;YACtB,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC/D,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;YAClD,CAAC;QACH,CAAC;QAED,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE;YACtC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,KAAK;YACL,WAAW,EAAE,OAAO,CAAC,MAAM;SAC5B,CAAC,CAAC;QAEH,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IAC/F,CAAC;IAED,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;QACjB,MAAM,KAAK,GAAG,CAAC,SAAS,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC;QACnF,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CACR,KAAK,CAAC,CAAC,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,WAAW,MAAM,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,gBAAgB,GAAG,CACpF,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;iBAClD,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;iBAC7B,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,KAAK,CAAC,IAAI,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;CACF,CAAC,CAAC"}

package/dist/services/edgar/concept-map.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @fileoverview Static mapping of friendly financial concept names to XBRL tags.
+ * @module services/edgar/concept-map
+ */
+import type { ConceptMapping } from './types.js';
+/**
+ * Resolve a concept input to its mapping. Accepts friendly names or raw XBRL tags.
+ * Returns undefined if the input is not a known friendly name (caller should treat it as a raw tag).
+ */
+export declare function resolveConcept(input: string): ConceptMapping | undefined;
+/** Get all concept mappings for reference resource generation. */
+export declare function getAllConcepts(): Record<string, ConceptMapping>;
+//# sourceMappingURL=concept-map.d.ts.map

package/dist/services/edgar/concept-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concept-map.d.ts","sourceRoot":"","sources":["../../../src/services/edgar/concept-map.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AA+FjD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAGxE;AAED,kEAAkE;AAClE,wBAAgB,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAE/D"}

package/dist/services/edgar/concept-map.js

@@ -0,0 +1,109 @@
+/**
+ * @fileoverview Static mapping of friendly financial concept names to XBRL tags.
+ * @module services/edgar/concept-map
+ */
+/** Friendly name → XBRL tag mapping. Tags are tried in order for companyconcept lookups. */
+const CONCEPT_MAP = {
+    revenue: {
+        tags: [
+            'RevenueFromContractWithCustomerExcludingAssessedTax',
+            'Revenues',
+            'SalesRevenueNet',
+            'SalesRevenueGoodsNet',
+        ],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Revenue',
+    },
+    net_income: {
+        tags: ['NetIncomeLoss'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Net Income (Loss)',
+    },
+    operating_income: {
+        tags: ['OperatingIncomeLoss'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Operating Income (Loss)',
+    },
+    gross_profit: {
+        tags: ['GrossProfit'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Gross Profit',
+    },
+    eps_basic: {
+        tags: ['EarningsPerShareBasic'],
+        taxonomy: 'us-gaap',
+        unit: 'USD/shares',
+        label: 'Earnings Per Share (Basic)',
+    },
+    eps_diluted: {
+        tags: ['EarningsPerShareDiluted'],
+        taxonomy: 'us-gaap',
+        unit: 'USD/shares',
+        label: 'Earnings Per Share (Diluted)',
+    },
+    assets: {
+        tags: ['Assets'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Total Assets',
+    },
+    liabilities: {
+        tags: ['Liabilities'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Total Liabilities',
+    },
+    equity: {
+        tags: ['StockholdersEquity'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: "Stockholders' Equity",
+    },
+    cash: {
+        tags: ['CashAndCashEquivalentsAtCarryingValue'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Cash and Cash Equivalents',
+    },
+    debt: {
+        tags: ['LongTermDebt', 'LongTermDebtNoncurrent'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Long-Term Debt',
+    },
+    shares_outstanding: {
+        tags: ['EntityCommonStockSharesOutstanding'],
+        taxonomy: 'dei',
+        unit: 'shares',
+        label: 'Shares Outstanding',
+    },
+    operating_cash_flow: {
+        tags: ['NetCashProvidedByUsedInOperatingActivities'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Operating Cash Flow',
+    },
+    capex: {
+        tags: ['PaymentsToAcquirePropertyPlantAndEquipment'],
+        taxonomy: 'us-gaap',
+        unit: 'USD',
+        label: 'Capital Expenditures',
+    },
+};
+/**
+ * Resolve a concept input to its mapping. Accepts friendly names or raw XBRL tags.
+ * Returns undefined if the input is not a known friendly name (caller should treat it as a raw tag).
+ */
+export function resolveConcept(input) {
+    const normalized = input.toLowerCase().replace(/[- ]/g, '_');
+    return CONCEPT_MAP[normalized];
+}
+/** Get all concept mappings for reference resource generation. */
+export function getAllConcepts() {
+    return CONCEPT_MAP;
+}
+//# sourceMappingURL=concept-map.js.map

package/dist/services/edgar/concept-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"concept-map.js","sourceRoot":"","sources":["../../../src/services/edgar/concept-map.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,4FAA4F;AAC5F,MAAM,WAAW,GAAmC;IAClD,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,qDAAqD;YACrD,UAAU;YACV,iBAAiB;YACjB,sBAAsB;SACvB;QACD,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,SAAS;KACjB;IACD,UAAU,EAAE;QACV,IAAI,EAAE,CAAC,eAAe,CAAC;QACvB,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,mBAAmB;KAC3B;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,CAAC,qBAAqB,CAAC;QAC7B,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,yBAAyB;KACjC;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,CAAC,aAAa,CAAC;QACrB,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,cAAc;KACtB;IACD,SAAS,EAAE;QACT,IAAI,EAAE,CAAC,uBAAuB,CAAC;QAC/B,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,4BAA4B;KACpC;IACD,WAAW,EAAE;QACX,IAAI,EAAE,CAAC,yBAAyB,CAAC;QACjC,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE,8BAA8B;KACtC;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,QAAQ,CAAC;QAChB,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,cAAc;KACtB;IACD,WAAW,EAAE;QACX,IAAI,EAAE,CAAC,aAAa,CAAC;QACrB,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,mBAAmB;KAC3B;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,oBAAoB,CAAC;QAC5B,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,sBAAsB;KAC9B;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,uCAAuC,CAAC;QAC/C,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,2BAA2B;KACnC;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,cAAc,EAAE,wBAAwB,CAAC;QAChD,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,gBAAgB;KACxB;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,CAAC,oCAAoC,CAAC;QAC5C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,oBAAoB;KAC5B;IACD,mBAAmB,EAAE;QACnB,IAAI,EAAE,CAAC,4CAA4C,CAAC;QACpD,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,qBAAqB;KAC7B;IACD,KAAK,EAAE;QACL,IAAI,EAAE,CAAC,4CAA4C,CAAC;QACpD,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,sBAAsB;KAC9B;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC7D,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,cAAc;IAC5B,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/services/edgar/edgar-api-service.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @fileoverview Rate-limited HTTP client for all SEC EDGAR API interactions.
+ * Handles User-Agent compliance, rate limiting, retry with backoff, CIK resolution,
+ * and ticker/entity caching.
+ * @module services/edgar/edgar-api-service
+ */
+import type { CikMatch, CompanyConceptResponse, EftsResponse, FilingIndex, FramesResponse, SubmissionsResponse } from './types.js';
+declare class EdgarApiService {
+    private lastRequestAt;
+    private minIntervalMs;
+    private tickerCache;
+    constructor();
+    /** Rate-limited, retried fetch with User-Agent header. */
+    fetch(url: string): Promise<Response>;
+    /** Fetch and parse JSON, throwing on non-OK responses. */
+    fetchJson<T>(url: string): Promise<T>;
+    /** Fetch raw text content (HTML filing documents). */
+    fetchText(url: string): Promise<string>;
+    /**
+     * Resolve a query (ticker, name, or CIK) to company match(es).
+     * - Numeric input → direct CIK lookup
+     * - 1-5 uppercase letters → ticker lookup (O(1))
+     * - Otherwise → name search (prefix, then substring)
+     */
+    resolveCik(query: string): Promise<CikMatch | CikMatch[]>;
+    /** Reverse lookup: CIK → ticker symbol. */
+    cikToTicker(cik: string): Promise<string | undefined>;
+    getSubmissions(cik: string): Promise<SubmissionsResponse>;
+    searchFilings(params: {
+        query: string;
+        forms?: string[] | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        from?: number | undefined;
+        size?: number | undefined;
+    }): Promise<EftsResponse>;
+    getFilingIndex(cik: string, accessionNumber: string): Promise<FilingIndex>;
+    getFilingDocument(cik: string, accessionNumber: string, document: string): Promise<string>;
+    getCompanyConcept(cik: string, taxonomy: string, tag: string): Promise<CompanyConceptResponse>;
+    getFrames(taxonomy: string, tag: string, unit: string, period: string): Promise<FramesResponse>;
+    private throttle;
+    private getTickerCache;
+}
+export declare function initEdgarApiService(): void;
+export declare function getEdgarApiService(): EdgarApiService;
+export {};
+//# sourceMappingURL=edgar-api-service.d.ts.map

package/dist/services/edgar/edgar-api-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edgar-api-service.d.ts","sourceRoot":"","sources":["../../../src/services/edgar/edgar-api-service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EACV,QAAQ,EACR,sBAAsB,EACtB,YAAY,EACZ,WAAW,EACX,cAAc,EACd,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAapB,cAAM,eAAe;IACnB,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,WAAW,CAA0B;;IAO7C,0DAA0D;IACpD,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAwC3C,0DAA0D;IACpD,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAW3C,sDAAsD;IAChD,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB7C;;;;;OAKG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC;IA+C/D,2CAA2C;IACrC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO3D,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOzD,aAAa,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;QAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC3B,GAAG,OAAO,CAAC,YAAY,CAAC;IAezB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAQ1E,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ1F,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAO9F,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;YAQjF,QAAQ;YASR,cAAc;CA8B7B;AASD,wBAAgB,mBAAmB,IAAI,IAAI,CAE1C;AAED,wBAAgB,kBAAkB,IAAI,eAAe,CAIpD"}

package/dist/services/edgar/edgar-api-service.js

@@ -0,0 +1,213 @@
+/**
+ * @fileoverview Rate-limited HTTP client for all SEC EDGAR API interactions.
+ * Handles User-Agent compliance, rate limiting, retry with backoff, CIK resolution,
+ * and ticker/entity caching.
+ * @module services/edgar/edgar-api-service
+ */
+import { serviceUnavailable } from '@cyanheads/mcp-ts-core/errors';
+import { getServerConfig } from '../../config/server-config.js';
+const MAX_RETRIES = 3;
+const BASE_BACKOFF_MS = 1000;
+class EdgarApiService {
+    lastRequestAt = 0;
+    minIntervalMs;
+    tickerCache;
+    constructor() {
+        const config = getServerConfig();
+        this.minIntervalMs = Math.ceil(1000 / config.rateLimitRps);
+    }
+    /** Rate-limited, retried fetch with User-Agent header. */
+    async fetch(url) {
+        const config = getServerConfig();
+        for (let attempt = 0; attempt < MAX_RETRIES; attempt++) {
+            await this.throttle();
+            const response = await globalThis.fetch(url, {
+                headers: { 'User-Agent': config.userAgent, Accept: 'application/json' },
+            });
+            if (response.ok)
+                return response;
+            const retryable = response.status === 429 ||
+                response.status === 500 ||
+                response.status === 502 ||
+                response.status === 503 ||
+                response.status === 504;
+            if (retryable && attempt < MAX_RETRIES - 1) {
+                const delay = BASE_BACKOFF_MS * 2 ** attempt;
+                await sleep(delay);
+                continue;
+            }
+            if (response.status === 404)
+                return response;
+            const host = new URL(url).hostname;
+            const hint = response.status === 403
+                ? `. This may indicate ${host} is blocking requests — check EDGAR_USER_AGENT format ("AppName contact@email.com") or retry later.`
+                : '';
+            throw serviceUnavailable(`SEC EDGAR API returned ${response.status}: ${response.statusText} (${host})${hint}`, { url, status: response.status });
+        }
+        throw serviceUnavailable('SEC EDGAR API request failed after retries', { url });
+    }
+    /** Fetch and parse JSON, throwing on non-OK responses. */
+    async fetchJson(url) {
+        const response = await this.fetch(url);
+        if (!response.ok) {
+            throw serviceUnavailable(`SEC EDGAR API returned ${response.status} for ${url}`, {
+                url,
+                status: response.status,
+            });
+        }
+        return response.json();
+    }
+    /** Fetch raw text content (HTML filing documents). */
+    async fetchText(url) {
+        await this.throttle();
+        const config = getServerConfig();
+        const response = await globalThis.fetch(url, {
+            headers: { 'User-Agent': config.userAgent },
+        });
+        if (!response.ok) {
+            throw serviceUnavailable(`SEC EDGAR returned ${response.status} for ${url}`, {
+                url,
+                status: response.status,
+            });
+        }
+        return response.text();
+    }
+    // --- CIK Resolution ---
+    /**
+     * Resolve a query (ticker, name, or CIK) to company match(es).
+     * - Numeric input → direct CIK lookup
+     * - 1-5 uppercase letters → ticker lookup (O(1))
+     * - Otherwise → name search (prefix, then substring)
+     */
+    async resolveCik(query) {
+        const cache = await this.getTickerCache();
+        const trimmed = query.trim();
+        // Numeric → CIK
+        if (/^\d+$/.test(trimmed)) {
+            const padded = trimmed.padStart(10, '0');
+            const match = cache.byCik.get(padded);
+            if (match)
+                return match;
+            // Return a synthetic match — CIK may be valid even if not in tickers file
+            return { cik: padded, name: '', ticker: '' };
+        }
+        // Short alphabetic → ticker
+        const upper = trimmed.toUpperCase();
+        if (/^[A-Z]{1,5}$/.test(upper)) {
+            const match = cache.byTicker.get(upper);
+            if (match)
+                return match;
+        }
+        // Name search: exact → prefix → substring
+        const lower = trimmed.toLowerCase();
+        const exact = [];
+        const prefix = [];
+        const substring = [];
+        for (const entry of cache.allEntries) {
+            const name = entry.name.toLowerCase();
+            if (name === lower) {
+                exact.push(entry);
+            }
+            else if (name.startsWith(lower)) {
+                prefix.push(entry);
+            }
+            else if (name.includes(lower)) {
+                substring.push(entry);
+            }
+        }
+        const results = [...exact, ...prefix, ...substring].slice(0, 5);
+        if (results.length > 0) {
+            return results.length === 1 ? results[0] : results;
+        }
+        // Also try as ticker if nothing matched
+        const tickerMatch = cache.byTicker.get(upper);
+        return tickerMatch ?? [];
+    }
+    /** Reverse lookup: CIK → ticker symbol. */
+    async cikToTicker(cik) {
+        const cache = await this.getTickerCache();
+        return cache.byCik.get(cik.padStart(10, '0'))?.ticker;
+    }
+    // --- SEC API Methods ---
+    getSubmissions(cik) {
+        const padded = cik.padStart(10, '0');
+        return this.fetchJson(`https://data.sec.gov/submissions/CIK${padded}.json`);
+    }
+    searchFilings(params) {
+        const url = new URL('https://efts.sec.gov/LATEST/search-index');
+        url.searchParams.set('q', params.query);
+        if (params.forms?.length)
+            url.searchParams.set('forms', params.forms.join(','));
+        if (params.startDate && params.endDate) {
+            url.searchParams.set('dateRange', 'custom');
+            url.searchParams.set('startdt', params.startDate);
+            url.searchParams.set('enddt', params.endDate);
+        }
+        url.searchParams.set('from', String(params.from ?? 0));
+        url.searchParams.set('size', String(params.size ?? 20));
+        return this.fetchJson(url.toString());
+    }
+    getFilingIndex(cik, accessionNumber) {
+        const padded = cik.padStart(10, '0');
+        const noDashes = accessionNumber.replace(/-/g, '');
+        return this.fetchJson(`https://www.sec.gov/Archives/edgar/data/${padded}/${noDashes}/index.json`);
+    }
+    getFilingDocument(cik, accessionNumber, document) {
+        const padded = cik.padStart(10, '0');
+        const noDashes = accessionNumber.replace(/-/g, '');
+        return this.fetchText(`https://www.sec.gov/Archives/edgar/data/${padded}/${noDashes}/${document}`);
+    }
+    getCompanyConcept(cik, taxonomy, tag) {
+        const padded = cik.padStart(10, '0');
+        return this.fetchJson(`https://data.sec.gov/api/xbrl/companyconcept/CIK${padded}/${taxonomy}/${tag}.json`);
+    }
+    getFrames(taxonomy, tag, unit, period) {
+        return this.fetchJson(`https://data.sec.gov/api/xbrl/frames/${taxonomy}/${tag}/${unit}/${period}.json`);
+    }
+    // --- Internals ---
+    async throttle() {
+        const now = Date.now();
+        const elapsed = now - this.lastRequestAt;
+        if (elapsed < this.minIntervalMs) {
+            await sleep(this.minIntervalMs - elapsed);
+        }
+        this.lastRequestAt = Date.now();
+    }
+    async getTickerCache() {
+        const config = getServerConfig();
+        const now = Date.now();
+        if (this.tickerCache && now - this.tickerCache.loadedAt < config.tickerCacheTtl * 1000) {
+            return this.tickerCache;
+        }
+        const raw = await this.fetchJson('https://www.sec.gov/files/company_tickers.json');
+        const byTicker = new Map();
+        const byCik = new Map();
+        const allEntries = [];
+        for (const entry of Object.values(raw)) {
+            const match = {
+                cik: String(entry.cik_str).padStart(10, '0'),
+                name: entry.title,
+                ticker: entry.ticker,
+            };
+            byTicker.set(entry.ticker.toUpperCase(), match);
+            byCik.set(match.cik, match);
+            allEntries.push(match);
+        }
+        this.tickerCache = { byTicker, byCik, allEntries, loadedAt: now };
+        return this.tickerCache;
+    }
+}
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+// Init/accessor pattern
+let _service;
+export function initEdgarApiService() {
+    _service = new EdgarApiService();
+}
+export function getEdgarApiService() {
+    if (!_service)
+        throw new Error('EdgarApiService not initialized — call initEdgarApiService() in setup()');
+    return _service;
+}
+//# sourceMappingURL=edgar-api-service.js.map

package/dist/services/edgar/edgar-api-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"edgar-api-service.js","sourceRoot":"","sources":["../../../src/services/edgar/edgar-api-service.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAW5D,MAAM,WAAW,GAAG,CAAC,CAAC;AACtB,MAAM,eAAe,GAAG,IAAI,CAAC;AAU7B,MAAM,eAAe;IACX,aAAa,GAAG,CAAC,CAAC;IAClB,aAAa,CAAS;IACtB,WAAW,CAA0B;IAE7C;QACE,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;QAEjC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;YACvD,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YAEtB,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE;gBAC3C,OAAO,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE;aACxE,CAAC,CAAC;YAEH,IAAI,QAAQ,CAAC,EAAE;gBAAE,OAAO,QAAQ,CAAC;YAEjC,MAAM,SAAS,GACb,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;YAC1B,IAAI,SAAS,IAAI,OAAO,GAAG,WAAW,GAAG,CAAC,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,eAAe,GAAG,CAAC,IAAI,OAAO,CAAC;gBAC7C,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;gBAAE,OAAO,QAAQ,CAAC;YAE7C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;YACnC,MAAM,IAAI,GACR,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACrB,CAAC,CAAC,uBAAuB,IAAI,qGAAqG;gBAClI,CAAC,CAAC,EAAE,CAAC;YACT,MAAM,kBAAkB,CACtB,0BAA0B,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,KAAK,IAAI,IAAI,IAAI,EAAE,EACpF,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CACjC,CAAC;QACJ,CAAC;QAED,MAAM,kBAAkB,CAAC,4CAA4C,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,SAAS,CAAI,GAAW;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,kBAAkB,CAAC,0BAA0B,QAAQ,CAAC,MAAM,QAAQ,GAAG,EAAE,EAAE;gBAC/E,GAAG;gBACH,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAgB,CAAC;IACvC,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,SAAS,CAAC,GAAW;QACzB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAEtB,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE;YAC3C,OAAO,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE;SAC5C,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,kBAAkB,CAAC,sBAAsB,QAAQ,CAAC,MAAM,QAAQ,GAAG,EAAE,EAAE;gBAC3E,GAAG;gBACH,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,yBAAyB;IAEzB;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAE7B,gBAAgB;QAChB,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtC,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;YACxB,0EAA0E;YAC1E,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAC/C,CAAC;QAED,4BAA4B;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACxC,IAAI,KAAK;gBAAE,OAAO,KAAK,CAAC;QAC1B,CAAC;QAED,0CAA0C;QAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,KAAK,GAAe,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAe,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAe,EAAE,CAAC;QAEjC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAE,OAAO,CAAC,CAAC,CAAc,CAAC,CAAC,CAAC,OAAO,CAAC;QACnE,CAAC;QAED,wCAAwC;QACxC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,WAAW,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,WAAW,CAAC,GAAW;QAC3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC;IACxD,CAAC;IAED,0BAA0B;IAE1B,cAAc,CAAC,GAAW;QACxB,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CACnB,uCAAuC,MAAM,OAAO,CACrD,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,MAOb;QACC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,0CAA0C,CAAC,CAAC;QAChE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAChF,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACvC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC5C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QAExD,OAAO,IAAI,CAAC,SAAS,CAAe,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,eAAuB;QACjD,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,SAAS,CACnB,2CAA2C,MAAM,IAAI,QAAQ,aAAa,CAC3E,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,GAAW,EAAE,eAAuB,EAAE,QAAgB;QACtE,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,SAAS,CACnB,2CAA2C,MAAM,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAC5E,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,GAAW,EAAE,QAAgB,EAAE,GAAW;QAC1D,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CACnB,mDAAmD,MAAM,IAAI,QAAQ,IAAI,GAAG,OAAO,CACpF,CAAC;IACJ,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,GAAW,EAAE,IAAY,EAAE,MAAc;QACnE,OAAO,IAAI,CAAC,SAAS,CACnB,wCAAwC,QAAQ,IAAI,GAAG,IAAI,IAAI,IAAI,MAAM,OAAO,CACjF,CAAC;IACJ,CAAC;IAED,oBAAoB;IAEZ,KAAK,CAAC,QAAQ;QACpB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QACzC,IAAI,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACjC,MAAM,KAAK,CAAC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,cAAc;QAC1B,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,IAAI,CAAC,WAAW,IAAI,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,EAAE,CAAC;YACvF,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAC9B,gDAAgD,CACjD,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAoB,CAAC;QAC1C,MAAM,UAAU,GAAe,EAAE,CAAC;QAElC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,MAAM,KAAK,GAAa;gBACtB,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC;gBAC5C,IAAI,EAAE,KAAK,CAAC,KAAK;gBACjB,MAAM,EAAE,KAAK,CAAC,MAAM;aACrB,CAAC;YACF,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC;YAChD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;QAClE,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAED,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,wBAAwB;AACxB,IAAI,QAAqC,CAAC;AAE1C,MAAM,UAAU,mBAAmB;IACjC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC7F,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/services/edgar/filing-to-text.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @fileoverview Convert SEC filing HTML to readable plain text.
+ * @module services/edgar/filing-to-text
+ */
+/** Convert filing HTML to plain text, optionally truncating to a character limit. */
+export declare function filingToText(html: string, limit?: number): {
+    text: string;
+    truncated: boolean;
+    totalLength: number;
+};
+//# sourceMappingURL=filing-to-text.d.ts.map

package/dist/services/edgar/filing-to-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filing-to-text.d.ts","sourceRoot":"","sources":["../../../src/services/edgar/filing-to-text.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAuBH,qFAAqF;AACrF,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,GACb;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAgB3D"}