dart-fss-cli 0.4.7 → 0.4.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/bin.js CHANGED
@@ -2,7 +2,7 @@
2
2
  import {
3
3
  createDartProgram,
4
4
  formatErrorJson
5
- } from "./chunk-2WVCVNX6.js";
5
+ } from "./chunk-HYSOUXSY.js";
6
6
 
7
7
  // src/bin.ts
8
8
  createDartProgram().parseAsync(process.argv).catch((err) => {
@@ -1173,7 +1173,7 @@ function getGlobalOpts(cmd) {
1173
1173
  }
1174
1174
  function registerDisclosureCommands(program) {
1175
1175
  const group = program.command("disclosure").description(
1176
- 'DS001: Disclosure info \u2014 search filings, company overview, original documents, corp codes.\nUse "disclosure list" to search filings by company/date/type.\nUse "disclosure company" to get company profile (CEO, address, industry code).'
1176
+ 'DS001: Disclosure info \u2014 search filings, company overview, original documents, corp codes.\n\nExamples:\n dart-fss disclosure company --corp "\uC0BC\uC131\uC804\uC790" --pretty\n dart-fss disclosure list --corp "\uCE74\uCE74\uC624" --from 20250101 --to 20251231'
1177
1177
  );
1178
1178
  group.command("list").description(
1179
1179
  "Search DART disclosure filings. Returns paginated results with report name, filing date, receipt number.\nWithout --corp, searches ALL companies (date range limited to 3 months).\nWith --corp, searches specific company with no date limit.\nDisclosure types: A=Regular, B=Major events, C=Issuance, D=Equity, E=Other, F=Audit, G=Fund, H=ABS, I=Exchange, J=FTC"
@@ -1289,7 +1289,7 @@ function getGlobalOpts2(cmd) {
1289
1289
  }
1290
1290
  function registerPeriodicReportCommands(program) {
1291
1291
  const group = program.command("report").description(
1292
- "DS002: Periodic report key information \u2014 28 APIs extracting data from annual/quarterly reports.\nCovers: capital changes, dividends, treasury stock, shareholders, executives, employees,\ncompensation, debt securities, audit info, outside directors, investments, fund usage.\nData available from 2015 onward."
1292
+ 'DS002: Periodic report key information \u2014 28 APIs extracting data from annual/quarterly reports.\nCovers: capital changes, dividends, treasury stock, shareholders, executives, employees,\ncompensation, debt securities, audit info, outside directors, investments, fund usage.\nData available from 2015 onward.\n\nAll subcommands require: --corp <name> --year <YYYY> --quarter <q1|half|q3|annual>\n\nExamples:\n dart-fss report employee --corp "\uC0BC\uC131\uC804\uC790" --year 2025 --quarter annual --pretty\n dart-fss report dividend --corp "\uCE74\uCE74\uC624" --year 2025 --quarter annual\n dart-fss report exec-pay-individual --corp "\uB124\uC774\uBC84" --year 2025 --quarter annual --fields "nm,ofcps,mendng_totamt"'
1293
1293
  );
1294
1294
  const endpoints = (REGISTRY_BY_GROUP.get("report") || []).filter(
1295
1295
  (ep) => ep.pattern === "periodic"
@@ -1329,7 +1329,7 @@ function getGlobalOpts3(cmd) {
1329
1329
  }
1330
1330
  function registerFinancialCommands(program) {
1331
1331
  const group = program.command("financial").description(
1332
- "DS003: Financial data \u2014 statements, indices, and XBRL for listed companies (KOSPI/KOSDAQ).\nIncludes key accounts (assets, liabilities, revenue), full financial statements,\nfinancial indices (profitability, stability, growth, activity), and XBRL taxonomy."
1332
+ 'DS003: Financial data \u2014 statements, indices, and XBRL for listed companies (KOSPI/KOSDAQ).\nIncludes key accounts (assets, liabilities, revenue), full financial statements,\nfinancial indices (profitability, stability, growth, activity), and XBRL taxonomy.\n\nMost subcommands require: --corp <name> --year <YYYY> --quarter <q1|half|q3|annual>\n\nExamples:\n dart-fss financial single-account --corp "\uC0BC\uC131\uC804\uC790" --year 2025 --quarter annual --pretty\n dart-fss financial full-statement --corp "SK\uD558\uC774\uB2C9\uC2A4" --year 2025 --quarter annual --fs-div CFS'
1333
1333
  );
1334
1334
  const endpoints = REGISTRY_BY_GROUP.get("financial") || [];
1335
1335
  for (const ep of endpoints) {
@@ -1448,7 +1448,7 @@ function getGlobalOpts4(cmd) {
1448
1448
  }
1449
1449
  function registerEquityDisclosureCommands(program) {
1450
1450
  const group = program.command("equity").description(
1451
- 'DS004: Equity disclosure \u2014 major shareholding reports and executive/major shareholder ownership.\nUse "equity major-stock" for large shareholding (5%+ ownership) status reports.\nUse "equity executive-stock" for executive and major shareholder ownership reports.'
1451
+ 'DS004: Equity disclosure \u2014 major shareholding reports and executive/major shareholder ownership.\n\nAll subcommands require: --corp <name>\n\nExamples:\n dart-fss equity major-stock --corp "\uC0BC\uC131\uC804\uC790" --pretty\n dart-fss equity executive-stock --corp "\uCE74\uCE74\uC624"'
1452
1452
  );
1453
1453
  const endpoints = (REGISTRY_BY_GROUP.get("equity") || []).filter(
1454
1454
  (ep) => ep.pattern === "corpOnly"
@@ -1484,7 +1484,7 @@ function getGlobalOpts5(cmd) {
1484
1484
  }
1485
1485
  function registerMajorReportCommands(program) {
1486
1486
  const group = program.command("major").description(
1487
- "DS005: Major event reports \u2014 36 APIs for significant corporate events.\nCovers: capital increases/reductions, bond issuances (convertible, exchangeable, warrant),\ntreasury stock, M&A (mergers, splits, business/asset transfers), lawsuits,\noverseas listings, defaults, business suspension, rehabilitation.\nData available from 2015 onward. Requires date range."
1487
+ 'DS005: Major event reports \u2014 36 APIs for significant corporate events.\nCovers: capital increases/reductions, bond issuances (convertible, exchangeable, warrant),\ntreasury stock, M&A (mergers, splits, business/asset transfers), lawsuits,\noverseas listings, defaults, business suspension, rehabilitation.\nData available from 2015 onward.\n\nAll subcommands require: --corp <name> --from <YYYYMMDD> --to <YYYYMMDD>\n\nExamples:\n dart-fss major lawsuit --corp "\uC0BC\uC131\uC804\uC790" --from 20230101 --to 20251231 --pretty\n dart-fss major convertible-bond --corp "\uCE74\uCE74\uC624" --from 20250101 --to 20251231'
1488
1488
  );
1489
1489
  const endpoints = (REGISTRY_BY_GROUP.get("major") || []).filter(
1490
1490
  (ep) => ep.pattern === "dateRange"
@@ -1520,7 +1520,7 @@ function getGlobalOpts6(cmd) {
1520
1520
  }
1521
1521
  function registerSecuritiesFilingCommands(program) {
1522
1522
  const group = program.command("securities").description(
1523
- "DS006: Securities registration statements \u2014 6 APIs for securities filings.\nCovers: equity securities, debt securities, depository receipts,\nmergers, comprehensive stock exchange/transfer, and splits.\nData available from 2015 onward. Requires date range."
1523
+ 'DS006: Securities registration statements \u2014 6 APIs for securities filings.\nCovers: equity securities, debt securities, depository receipts,\nmergers, comprehensive stock exchange/transfer, and splits.\nData available from 2015 onward.\n\nAll subcommands require: --corp <name> --from <YYYYMMDD> --to <YYYYMMDD>\n\nExamples:\n dart-fss securities equity-securities --corp "\uC0BC\uC131\uC804\uC790" --from 20230101 --to 20251231'
1524
1524
  );
1525
1525
  const endpoints = (REGISTRY_BY_GROUP.get("securities") || []).filter(
1526
1526
  (ep) => ep.pattern === "dateRange"
@@ -1677,7 +1677,7 @@ function createDartProgram() {
1677
1677
  const program = new Command();
1678
1678
  program.name("dart-fss").description(
1679
1679
  'DART Open API CLI \u2014 access Korea Financial Supervisory Service (FSS) electronic disclosure system.\nProvides 83 API endpoints for company filings, financial statements, equity disclosures, and more.\nAuthentication: set DART_API_KEY env var or pass --api-key. Get a key at https://opendart.fss.or.kr\nCompanies are identified by 8-digit corp_code or company name. Use "dart-fss lookup <name>" to find corp_code.\nOutput is JSON by default (compact single-line). Use --pretty for formatted output.\nRate limit: approximately 20,000 requests per day per API key.'
1680
- ).version("0.4.7").option("--api-key <key>", "DART API key (default: DART_API_KEY env). Get one at https://opendart.fss.or.kr").option("--pretty", "Pretty-print JSON output (default: compact single-line JSON)").option("--output <file>", "Save result to file instead of stdout").option("--json <params>", "Pass raw API parameters as JSON string, bypassing flag parsing").option("--fields <f1,f2,...>", "Comma-separated field names to include in output (reduces response size for agents)").option("--dry-run", "Validate parameters and print the resolved API request without calling the API").addHelpText("after", `
1680
+ ).version("0.4.8").option("--api-key <key>", "DART API key (default: DART_API_KEY env). Get one at https://opendart.fss.or.kr").option("--pretty", "Pretty-print JSON output (default: compact single-line JSON)").option("--output <file>", "Save result to file instead of stdout").option("--json <params>", "Pass raw API parameters as JSON string, bypassing flag parsing").option("--fields <f1,f2,...>", "Comma-separated field names to include in output (reduces response size for agents)").option("--dry-run", "Validate parameters and print the resolved API request without calling the API").addHelpText("after", `
1681
1681
  Examples:
1682
1682
  dart-fss lookup "\uC0BC\uC131\uC804\uC790"
1683
1683
  dart-fss disclosure company --corp "\uC0BC\uC131\uC804\uC790" --pretty
package/dist/cli.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  createDartProgram
3
- } from "./chunk-2WVCVNX6.js";
3
+ } from "./chunk-HYSOUXSY.js";
4
4
  export {
5
5
  createDartProgram
6
6
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dart-fss-cli",
3
- "version": "0.4.7",
3
+ "version": "0.4.8",
4
4
  "description": "DART (금융감독원 전자공시) Open API CLI",
5
5
  "type": "module",
6
6
  "bin": {