@shan8851/companies-house-cli 0.2.2 → 0.3.0
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/README.md +114 -7
- package/dist/cli.d.ts +3 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +76 -12
- package/dist/cli.js.map +1 -1
- package/dist/commands/chargesCommand.d.ts.map +1 -1
- package/dist/commands/chargesCommand.js +12 -1
- package/dist/commands/chargesCommand.js.map +1 -1
- package/dist/commands/companyInfoCommand.d.ts.map +1 -1
- package/dist/commands/companyInfoCommand.js +8 -0
- package/dist/commands/companyInfoCommand.js.map +1 -1
- package/dist/commands/filingsCommand.d.ts +1 -1
- package/dist/commands/filingsCommand.d.ts.map +1 -1
- package/dist/commands/filingsCommand.js +12 -3
- package/dist/commands/filingsCommand.js.map +1 -1
- package/dist/commands/insolvencyCommand.d.ts.map +1 -1
- package/dist/commands/insolvencyCommand.js +7 -0
- package/dist/commands/insolvencyCommand.js.map +1 -1
- package/dist/commands/officersCommand.d.ts.map +1 -1
- package/dist/commands/officersCommand.js +10 -1
- package/dist/commands/officersCommand.js.map +1 -1
- package/dist/commands/pscCommand.d.ts.map +1 -1
- package/dist/commands/pscCommand.js +10 -1
- package/dist/commands/pscCommand.js.map +1 -1
- package/dist/commands/searchCompaniesCommand.d.ts.map +1 -1
- package/dist/commands/searchCompaniesCommand.js +10 -1
- package/dist/commands/searchCompaniesCommand.js.map +1 -1
- package/dist/commands/searchPeopleCommand.d.ts.map +1 -1
- package/dist/commands/searchPeopleCommand.js +10 -1
- package/dist/commands/searchPeopleCommand.js.map +1 -1
- package/dist/commands/shared.d.ts +3 -4
- package/dist/commands/shared.d.ts.map +1 -1
- package/dist/commands/shared.js +13 -29
- package/dist/commands/shared.js.map +1 -1
- package/dist/lib/companiesHouseClient.d.ts.map +1 -1
- package/dist/lib/companiesHouseClient.js +34 -10
- package/dist/lib/companiesHouseClient.js.map +1 -1
- package/dist/lib/config.js +2 -2
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/constants.d.ts +2 -0
- package/dist/lib/constants.d.ts.map +1 -0
- package/dist/lib/constants.js +2 -0
- package/dist/lib/constants.js.map +1 -0
- package/dist/lib/errors.d.ts +16 -4
- package/dist/lib/errors.d.ts.map +1 -1
- package/dist/lib/errors.js +38 -7
- package/dist/lib/errors.js.map +1 -1
- package/dist/lib/output.d.ts +13 -0
- package/dist/lib/output.d.ts.map +1 -0
- package/dist/lib/output.js +55 -0
- package/dist/lib/output.js.map +1 -0
- package/dist/types/cli.d.ts +26 -1
- package/dist/types/cli.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -4,6 +4,12 @@ import { compactRowValues, formatDateOfBirth, renderBulletedList, renderPaginati
|
|
|
4
4
|
import { normalizePsc } from "../lib/normalizers.js";
|
|
5
5
|
import { fetchPaginatedItems } from "../lib/pagination.js";
|
|
6
6
|
import { addListOptions, executeCommand, resolveListOptions } from "./shared.js";
|
|
7
|
+
const PSC_HELP_EXAMPLES = [
|
|
8
|
+
"ch psc 09215862",
|
|
9
|
+
"ch psc 09215862 --all",
|
|
10
|
+
"ch psc 09215862 --items-per-page 50",
|
|
11
|
+
"ch psc 09215862 --json"
|
|
12
|
+
].join("\n ");
|
|
7
13
|
const renderPscSummaryLine = (envelope, context) => {
|
|
8
14
|
const colours = createColours(context.ansiEnabled);
|
|
9
15
|
if (envelope.data.summary.activeCount === null && envelope.data.summary.ceasedCount === null) {
|
|
@@ -58,7 +64,10 @@ export const registerPscCommand = (program, dependencies) => {
|
|
|
58
64
|
addListOptions(program
|
|
59
65
|
.command("psc <companyNumber>")
|
|
60
66
|
.description("List persons with significant control for a company.")
|
|
61
|
-
.option("--register-view <registerView>", "Register view filter.")
|
|
67
|
+
.option("--register-view <registerView>", "Register view filter.")
|
|
68
|
+
.option("--json", "Force JSON output.")
|
|
69
|
+
.option("--text", "Force text output.")
|
|
70
|
+
.addHelpText("after", `\nExamples:\n ${PSC_HELP_EXAMPLES}`)).action(async (companyNumber, options, command) => {
|
|
62
71
|
const normalizedCompanyNumber = normalizeCompanyNumber(companyNumber);
|
|
63
72
|
await executeCommand({
|
|
64
73
|
command,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pscCommand.js","sourceRoot":"","sources":["../../src/commands/pscCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAI3D,OAAO,EACL,cAAc,EACd,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AASrB,MAAM,oBAAoB,GAAG,CAC3B,QAAqB,EACrB,OAA2B,EACZ,EAAE;IACjB,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnD,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI;YACxC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,SAAS,CAAC;YACpE,CAAC,CAAC,IAAI;QACR,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI;YACxC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,SAAS,CAAC;YAC5D,CAAC,CAAC,IAAI;KACT;SACE,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;SAClD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,QAAqB,EACrB,OAA2B,EACnB,EAAE;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG;QACnB,OAAO,CAAC,GAAG,CACT,uBAAuB,CACrB,QAAQ,CAAC,UAAU,EAAE,aAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAC9D,QAAQ,CAAC,UAAU,EAAE,YAAY,IAAI,IAAI,EACzC,QAAQ,CAAC,UAAU,EAAE,UAAU,IAAI,KAAK,CACzC,CACF;QACD,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC;KACxC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAClD,MAAM,SAAS,GACb,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC;QAC5B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;QAC7D,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,EAC7D,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CACxD,CAAC;YACF,MAAM,YAAY,GAAG,gBAAgB,CACnC,GAAG,CAAC,WAAW,EACf,GAAG,CAAC,kBAAkB,EACtB,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CACnC,CAAC;YAEF,OAAO;gBACL,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,aAAa,CAAC,CAAC;gBAC1E,GAAG,CAAC,QAAQ,KAAK,IAAI;oBACnB,CAAC,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;oBACzE,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,YAAY,KAAK,IAAI;oBACvB,CAAC,CAAC,iBAAiB,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;oBAC7E,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,iBAAiB,CAClB,GAAG,CAAC,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC,sBAAsB,EAAE,SAAS,IAAI,IAAI,EACvE,OAAO,EACP;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CACF;gBACD,GAAG,kBAAkB,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,EAAE;oBACnD,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;aACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IAET,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC;SAC3C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;SACnC,IAAI,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,OAAgB,EAChB,YAAiC,EAC3B,EAAE;IACR,cAAc,CACZ,OAAO;SACJ,OAAO,CAAC,qBAAqB,CAAC;SAC9B,WAAW,CAAC,sDAAsD,CAAC;SACnE,MAAM,CAAC,gCAAgC,EAAE,uBAAuB,CAAC,
|
|
1
|
+
{"version":3,"file":"pscCommand.js","sourceRoot":"","sources":["../../src/commands/pscCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAI3D,OAAO,EACL,cAAc,EACd,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AASrB,MAAM,iBAAiB,GAAG;IACxB,iBAAiB;IACjB,uBAAuB;IACvB,qCAAqC;IACrC,wBAAwB;CACzB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAEf,MAAM,oBAAoB,GAAG,CAC3B,QAAqB,EACrB,OAA2B,EACZ,EAAE;IACjB,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnD,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI;YACxC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,SAAS,CAAC;YACpE,CAAC,CAAC,IAAI;QACR,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI;YACxC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,SAAS,CAAC;YAC5D,CAAC,CAAC,IAAI;KACT;SACE,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;SAClD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,QAAqB,EACrB,OAA2B,EACnB,EAAE;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG;QACnB,OAAO,CAAC,GAAG,CACT,uBAAuB,CACrB,QAAQ,CAAC,UAAU,EAAE,aAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAC9D,QAAQ,CAAC,UAAU,EAAE,YAAY,IAAI,IAAI,EACzC,QAAQ,CAAC,UAAU,EAAE,UAAU,IAAI,KAAK,CACzC,CACF;QACD,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC;KACxC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAClD,MAAM,SAAS,GACb,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC;QAC5B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;QAC7D,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,EAC7D,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CACxD,CAAC;YACF,MAAM,YAAY,GAAG,gBAAgB,CACnC,GAAG,CAAC,WAAW,EACf,GAAG,CAAC,kBAAkB,EACtB,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,CACnC,CAAC;YAEF,OAAO;gBACL,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,aAAa,CAAC,CAAC;gBAC1E,GAAG,CAAC,QAAQ,KAAK,IAAI;oBACnB,CAAC,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;oBACzE,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,YAAY,KAAK,IAAI;oBACvB,CAAC,CAAC,iBAAiB,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;oBAC7E,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,iBAAiB,CAClB,GAAG,CAAC,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC,sBAAsB,EAAE,SAAS,IAAI,IAAI,EACvE,OAAO,EACP;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CACF;gBACD,GAAG,kBAAkB,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,EAAE;oBACnD,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;aACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IAET,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC;SAC3C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;SACnC,IAAI,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,OAAgB,EAChB,YAAiC,EAC3B,EAAE;IACR,cAAc,CACZ,OAAO;SACJ,OAAO,CAAC,qBAAqB,CAAC;SAC9B,WAAW,CAAC,sDAAsD,CAAC;SACnE,MAAM,CAAC,gCAAgC,EAAE,uBAAuB,CAAC;SACjE,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,WAAW,CAAC,OAAO,EAAE,kBAAkB,iBAAiB,EAAE,CAAC,CAC/D,CAAC,MAAM,CAAC,KAAK,EAAE,aAAqB,EAAE,OAA0B,EAAE,OAAgB,EAAE,EAAE;QACrF,MAAM,uBAAuB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEtE,MAAM,cAAc,CAAC;YACnB,OAAO;YACP,WAAW,EAAE,KAAK;YAClB,YAAY;YACZ,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC5B,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;oBAC5C,aAAa,EAAE,uBAAuB;oBACtC,YAAY,EACV,CAAC,WAAW,CAAC,GAAG,IAAI,KAAK,CAAC;wBACxB,CAAC,CAAC,WAAW,CAAC,YAAY,IAAI,GAAG;wBACjC,CAAC,CAAC,WAAW,CAAC,YAAY,IAAI,EAAE;oBACpC,UAAU,EAAE,WAAW,CAAC,UAAU,IAAI,CAAC;oBACvC,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS;wBACpC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE;wBACxC,CAAC,CAAC,EAAE,CAAC;iBACR,CAAC,CAAC;gBACH,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG;oBACpC,CAAC,CAAC,MAAM,mBAAmB,CAAiC;wBACxD,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC1C,MAAM,CAAC,OAAO,CAAC;4BACb,aAAa,EAAE,uBAAuB;4BACtC,YAAY;4BACZ,UAAU;4BACV,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS;gCACpC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE;gCACxC,CAAC,CAAC,EAAE,CAAC;yBACR,CAAC;wBACJ,OAAO,EAAE,WAAW;qBACrB,CAAC;oBACJ,CAAC,CAAC;wBACE,KAAK,EAAE,gBAAgB,CAAC,KAAK,IAAI,EAAE;wBACnC,UAAU,EAAE;4BACV,UAAU,EAAE,KAAK;4BACjB,YAAY,EAAE,WAAW,CAAC,YAAY,IAAI,EAAE;4BAC5C,aAAa,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC;4BAClD,UAAU,EAAE,WAAW,CAAC,UAAU,IAAI,CAAC;4BACvC,YAAY,EAAE,gBAAgB,CAAC,aAAa,IAAI,IAAI;yBACrD;qBACF,CAAC;gBAEN,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,IAAI,EAAE;wBACJ,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC;wBAC3C,OAAO,EAAE;4BACP,WAAW,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;4BAClD,WAAW,EAAE,gBAAgB,CAAC,YAAY,IAAI,IAAI;yBACnD;qBACF;oBACD,KAAK,EAAE;wBACL,aAAa,EAAE,uBAAuB;wBACtC,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,IAAI;qBAC3C;oBACD,UAAU,EAAE,cAAc,CAAC,UAAU;iBAChB,CAAC;YAC1B,CAAC;YACD,WAAW,EAAE,cAAc;SAC5B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchCompaniesCommand.d.ts","sourceRoot":"","sources":["../../src/commands/searchCompaniesCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAezC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"searchCompaniesCommand.d.ts","sourceRoot":"","sources":["../../src/commands/searchCompaniesCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAezC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAyF3D,eAAO,MAAM,8BAA8B,GACzC,SAAS,OAAO,EAChB,cAAc,mBAAmB,KAChC,IAkDF,CAAC"}
|
|
@@ -3,6 +3,12 @@ import { normalizeCompanySearchResult } from "../lib/normalizers.js";
|
|
|
3
3
|
import { fetchPaginatedItems } from "../lib/pagination.js";
|
|
4
4
|
import { compactRowValues, humanizeEnumValue, renderPaginationSummary, renderWrappedText, withFallback } from "../lib/formatting.js";
|
|
5
5
|
import { addListOptions, executeCommand, resolveListOptions } from "./shared.js";
|
|
6
|
+
const SEARCH_HELP_EXAMPLES = [
|
|
7
|
+
'ch search "Revolut"',
|
|
8
|
+
'ch search "Revolut" --items-per-page 5',
|
|
9
|
+
'ch search "Revolut" --start-index 20',
|
|
10
|
+
'ch search "Revolut" --json'
|
|
11
|
+
].join("\n ");
|
|
6
12
|
const formatCompanyStatus = (companyStatus, context) => {
|
|
7
13
|
if (companyStatus === null) {
|
|
8
14
|
return null;
|
|
@@ -50,7 +56,10 @@ export const registerSearchCompaniesCommand = (program, dependencies) => {
|
|
|
50
56
|
addListOptions(program
|
|
51
57
|
.command("search <query>")
|
|
52
58
|
.description("Search companies by name.")
|
|
53
|
-
.option("--restrictions <restrictions>", "Search restrictions to pass through to Companies House.")
|
|
59
|
+
.option("--restrictions <restrictions>", "Search restrictions to pass through to Companies House.")
|
|
60
|
+
.option("--json", "Force JSON output.")
|
|
61
|
+
.option("--text", "Force text output.")
|
|
62
|
+
.addHelpText("after", `\nExamples:\n ${SEARCH_HELP_EXAMPLES}`)).action(async (query, options, command) => {
|
|
54
63
|
await executeCommand({
|
|
55
64
|
command,
|
|
56
65
|
commandName: "search",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchCompaniesCommand.js","sourceRoot":"","sources":["../../src/commands/searchCompaniesCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EACL,cAAc,EACd,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AASrB,MAAM,mBAAmB,GAAG,CAC1B,aAA4B,EAC5B,OAA2B,EACZ,EAAE;IACjB,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAEzD,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CACjC,QAAiC,EACjC,OAA2B,EACnB,EAAE;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,aAAa,GACjB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;QAClC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACtC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG;gBACd,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;gBAC3E,OAAO,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,CAAC;aACpE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAC7E,CAAC;YACF,MAAM,WAAW,GAAG;gBAClB,mBAAmB,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC;gBACnD,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1F,GAAG,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,OAAO,EAAE;oBAChE,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;gBACF,GAAG,iBAAiB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE;oBACjD,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;aACH,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAElD,OAAO,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IAET,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;QACjC,CAAC,CAAC,OAAO,CAAC,GAAG,CACT,uBAAuB,CACrB,QAAQ,CAAC,UAAU,CAAC,aAAa,EACjC,QAAQ,CAAC,UAAU,CAAC,YAAY,EAChC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAC/B,CACF;QACH,CAAC,CAAC,IAAI,CAAC;IAET,OAAO,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC;SAC/B,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC;SAC/C,IAAI,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,OAAgB,EAChB,YAAiC,EAC3B,EAAE;IACR,cAAc,CACZ,OAAO;SACJ,OAAO,CAAC,gBAAgB,CAAC;SACzB,WAAW,CAAC,2BAA2B,CAAC;SACxC,MAAM,CACL,+BAA+B,EAC/B,yDAAyD,CAC1D,
|
|
1
|
+
{"version":3,"file":"searchCompaniesCommand.js","sourceRoot":"","sources":["../../src/commands/searchCompaniesCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EACL,cAAc,EACd,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AASrB,MAAM,oBAAoB,GAAG;IAC3B,qBAAqB;IACrB,wCAAwC;IACxC,sCAAsC;IACtC,4BAA4B;CAC7B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAEf,MAAM,mBAAmB,GAAG,CAC1B,aAA4B,EAC5B,OAA2B,EACZ,EAAE;IACjB,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAEzD,IAAI,aAAa,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CACjC,QAAiC,EACjC,OAA2B,EACnB,EAAE;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,aAAa,GACjB,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;QAClC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACtC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG;gBACd,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;gBAC3E,OAAO,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,CAAC;aACpE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAC7E,CAAC;YACF,MAAM,WAAW,GAAG;gBAClB,mBAAmB,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC;gBACnD,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1F,GAAG,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,OAAO,EAAE;oBAChE,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;gBACF,GAAG,iBAAiB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE;oBACjD,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;aACH,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAElD,OAAO,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IAET,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU;QACjC,CAAC,CAAC,OAAO,CAAC,GAAG,CACT,uBAAuB,CACrB,QAAQ,CAAC,UAAU,CAAC,aAAa,EACjC,QAAQ,CAAC,UAAU,CAAC,YAAY,EAChC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAC/B,CACF;QACH,CAAC,CAAC,IAAI,CAAC;IAET,OAAO,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC;SAC/B,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC;SAC/C,IAAI,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,OAAgB,EAChB,YAAiC,EAC3B,EAAE;IACR,cAAc,CACZ,OAAO;SACJ,OAAO,CAAC,gBAAgB,CAAC;SACzB,WAAW,CAAC,2BAA2B,CAAC;SACxC,MAAM,CACL,+BAA+B,EAC/B,yDAAyD,CAC1D;SACA,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,WAAW,CAAC,OAAO,EAAE,kBAAkB,oBAAoB,EAAE,CAAC,CAClE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,OAAsC,EAAE,OAAgB,EAAE,EAAE;QACzF,MAAM,cAAc,CAAC;YACnB,OAAO;YACP,WAAW,EAAE,QAAQ;YACrB,YAAY;YACZ,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC5B,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAGtC;oBACA,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC1C,MAAM,CAAC,eAAe,CAAC;wBACrB,YAAY;wBACZ,KAAK;wBACL,UAAU;wBACV,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS;4BACpC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE;4BACxC,CAAC,CAAC,EAAE,CAAC;qBACR,CAAC;oBACJ,OAAO,EAAE,WAAW;iBACrB,CAAC,CAAC;gBAEH,OAAO;oBACL,OAAO,EAAE,QAAQ;oBACjB,IAAI,EAAE;wBACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,4BAA4B,CAAC;qBAC1D;oBACD,KAAK,EAAE;wBACL,KAAK;wBACL,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,IAAI;qBAC3C;oBACD,UAAU,EAAE,MAAM,CAAC,UAAU;iBACI,CAAC;YACtC,CAAC;YACD,WAAW,EAAE,0BAA0B;SACxC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchPeopleCommand.d.ts","sourceRoot":"","sources":["../../src/commands/searchPeopleCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAsBzC,OAAO,KAAK,EAAsB,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"searchPeopleCommand.d.ts","sourceRoot":"","sources":["../../src/commands/searchPeopleCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAsBzC,OAAO,KAAK,EAAsB,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAuG/E,eAAO,MAAM,2BAA2B,GACtC,SAAS,OAAO,EAChB,cAAc,mBAAmB,KAChC,IAuFF,CAAC"}
|
|
@@ -4,6 +4,12 @@ import { extractOfficerId, normalizeOfficerAppointment, normalizePersonSearchRes
|
|
|
4
4
|
import { fetchPaginatedItems } from "../lib/pagination.js";
|
|
5
5
|
import { addListOptions, executeCommand, parsePositiveInteger, resolveListOptions } from "./shared.js";
|
|
6
6
|
const DEFAULT_MATCH_LIMIT = 10;
|
|
7
|
+
const SEARCH_PERSON_HELP_EXAMPLES = [
|
|
8
|
+
'ch search-person "Nik Storonsky"',
|
|
9
|
+
'ch search-person "Nik Storonsky" --match-limit 5',
|
|
10
|
+
'ch search-person "Nik Storonsky" --items-per-page 20',
|
|
11
|
+
'ch search-person "Nik Storonsky" --json'
|
|
12
|
+
].join("\n ");
|
|
7
13
|
const renderSearchPeopleHuman = (envelope, context) => {
|
|
8
14
|
const colours = createColours(context.ansiEnabled);
|
|
9
15
|
const summary = colours.dim(renderPaginationSummary(envelope.data.results.length, envelope.data.totalSearchHits, envelope.pagination?.fetchedAll ?? false));
|
|
@@ -62,7 +68,10 @@ export const registerSearchPeopleCommand = (program, dependencies) => {
|
|
|
62
68
|
addListOptions(program
|
|
63
69
|
.command("search-person <query>")
|
|
64
70
|
.description("Search officers and resolve their company appointments.")
|
|
65
|
-
.option("--match-limit <number>", "Number of officer matches to enrich with appointments.", parsePositiveInteger, DEFAULT_MATCH_LIMIT)
|
|
71
|
+
.option("--match-limit <number>", "Number of officer matches to enrich with appointments.", parsePositiveInteger, DEFAULT_MATCH_LIMIT)
|
|
72
|
+
.option("--json", "Force JSON output.")
|
|
73
|
+
.option("--text", "Force text output.")
|
|
74
|
+
.addHelpText("after", `\nExamples:\n ${SEARCH_PERSON_HELP_EXAMPLES}`)).action(async (query, options, command) => {
|
|
66
75
|
await executeCommand({
|
|
67
76
|
command,
|
|
68
77
|
commandName: "search-person",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchPeopleCommand.js","sourceRoot":"","sources":["../../src/commands/searchPeopleCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAS3D,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB,MAAM,mBAAmB,GAAG,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"searchPeopleCommand.js","sourceRoot":"","sources":["../../src/commands/searchPeopleCommand.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAS3D,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,MAAM,2BAA2B,GAAG;IAClC,kCAAkC;IAClC,kDAAkD;IAClD,sDAAsD;IACtD,yCAAyC;CAC1C,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AASf,MAAM,uBAAuB,GAAG,CAC9B,QAA8B,EAC9B,OAA2B,EACnB,EAAE;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CACzB,uBAAuB,CACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAC5B,QAAQ,CAAC,IAAI,CAAC,eAAe,EAC7B,QAAQ,CAAC,UAAU,EAAE,UAAU,IAAI,KAAK,CACzC,CACF,CAAC;IACF,MAAM,YAAY,GAChB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;QAChC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QAC5C,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,EACnE,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CACtC,CAAC;YACF,MAAM,qBAAqB,GACzB,MAAM,CAAC,gBAAgB,KAAK,IAAI;gBAC9B,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,eAAe;gBAC3C,CAAC,CAAC,sBAAsB,CAAC;YAC7B,MAAM,gBAAgB,GACpB,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC9B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBAC3C,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;oBAC1C,MAAM,iBAAiB,GAAG;wBACxB,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CACzE;wBACD,OAAO,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,CAAC;wBACzE,OAAO,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,GAAG,CAAC;qBACxE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACZ,MAAM,mBAAmB,GAAG,gBAAgB,CAC1C,WAAW,CAAC,WAAW,KAAK,IAAI;wBAC9B,CAAC,CAAC,aAAa,WAAW,CAAC,WAAW,EAAE;wBACxC,CAAC,CAAC,IAAI,EACR,WAAW,CAAC,UAAU,KAAK,IAAI;wBAC7B,CAAC,CAAC,YAAY,WAAW,CAAC,UAAU,EAAE;wBACtC,CAAC,CAAC,IAAI,CACT,CAAC;oBAEF,OAAO;wBACL,KAAK,iBAAiB,EAAE;wBACxB,GAAG,CAAC,mBAAmB,KAAK,IAAI;4BAC9B,CAAC,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,OAAO,EAAE;gCAC9C,MAAM,EAAE,CAAC;gCACT,KAAK,EAAE,OAAO,CAAC,GAAG;6BACnB,CAAC;4BACJ,CAAC,CAAC,EAAE,CAAC;qBACR,CAAC;gBACJ,CAAC,CAAC,CAAC;YAET,OAAO;gBACL;oBACE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;oBACzE,OAAO,CAAC,IAAI,CAAC,IAAI,qBAAqB,GAAG,CAAC;iBAC3C,CAAC,IAAI,CAAC,GAAG,CAAC;gBACX,GAAG,CAAC,QAAQ,KAAK,IAAI;oBACnB,CAAC,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;oBACzE,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,iBAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,OAAO,EAAE;oBAC/D,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;gBACF,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,EAAE;oBAChD,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,OAAO,CAAC,GAAG;iBACnB,CAAC;gBACF,GAAG,gBAAgB;aACpB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IAET,OAAO,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAgB,EAChB,YAAiC,EAC3B,EAAE;IACR,cAAc,CACZ,OAAO;SACJ,OAAO,CAAC,uBAAuB,CAAC;SAChC,WAAW,CAAC,yDAAyD,CAAC;SACtE,MAAM,CACL,wBAAwB,EACxB,wDAAwD,EACxD,oBAAoB,EACpB,mBAAmB,CACpB;SACA,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,MAAM,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SACtC,WAAW,CAAC,OAAO,EAAE,kBAAkB,2BAA2B,EAAE,CAAC,CACzE,CAAC,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,OAAmC,EAAE,OAAgB,EAAE,EAAE;QACtF,MAAM,cAAc,CAAC;YACnB,OAAO;YACP,WAAW,EAAE,eAAe;YAC5B,YAAY;YACZ,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC5B,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAG7C;oBACA,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC1C,MAAM,CAAC,cAAc,CAAC;wBACpB,YAAY;wBACZ,KAAK;wBACL,UAAU;qBACX,CAAC;oBACJ,OAAO,EAAE,WAAW;iBACrB,CAAC,CAAC;gBACH,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,mBAAmB,CAAC;gBAC7D,MAAM,sBAAsB,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,mBAAyC,EAAE,EAAE;oBAC7E,MAAM,QAAQ,GACZ,OAAO,mBAAmB,CAAC,KAAK,EAAE,IAAI,KAAK,QAAQ;wBACjD,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI;wBAChC,CAAC,CAAC,SAAS,CAAC;oBAChB,MAAM,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;oBAE7C,IAAI,CAAC,SAAS,EAAE,CAAC;wBACf,OAAO,2BAA2B,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;oBAC9D,CAAC;oBAED,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAG5C;wBACA,SAAS,EAAE,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC1C,MAAM,CAAC,uBAAuB,CAAC;4BAC7B,YAAY;4BACZ,SAAS;4BACT,UAAU;yBACX,CAAC;wBACJ,OAAO,EAAE;4BACP,GAAG,EAAE,IAAI;4BACT,YAAY,EAAE,GAAG;4BACjB,UAAU,EAAE,CAAC;yBACd;qBACF,CAAC,CAAC;oBAEH,OAAO,2BAA2B,CAChC,mBAAmB,EACnB,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,CAAC,CACpD,CAAC;gBACJ,CAAC,CAAC,CACH,CAAC;gBAEF,OAAO;oBACL,OAAO,EAAE,eAAe;oBACxB,IAAI,EAAE;wBACJ,OAAO,EAAE,eAAe;wBACxB,eAAe,EAAE,aAAa,CAAC,UAAU,CAAC,YAAY;qBACvD;oBACD,KAAK,EAAE;wBACL,UAAU;wBACV,KAAK;qBACN;oBACD,UAAU,EAAE,aAAa,CAAC,UAAU;iBACN,CAAC;YACnC,CAAC;YACD,WAAW,EAAE,uBAAuB;SACrC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
|
|
@@ -1,21 +1,20 @@
|
|
|
1
1
|
import type { Command } from "commander";
|
|
2
2
|
import { type CompaniesHouseClient } from "../lib/companiesHouseClient.js";
|
|
3
|
-
import type { CommandEnvelope, HumanRenderContext, ListCommandOptions,
|
|
3
|
+
import type { CommandEnvelope, HumanRenderContext, ListCommandOptions, RuntimeDependencies } from "../types/cli.js";
|
|
4
4
|
export declare const createDefaultRuntimeDependencies: () => RuntimeDependencies;
|
|
5
5
|
export declare const parsePositiveInteger: (value: string) => number;
|
|
6
6
|
export declare const parseNonNegativeInteger: (value: string) => number;
|
|
7
7
|
export declare const addListOptions: (command: Command) => Command;
|
|
8
8
|
export declare const resolveListOptions: (options: ListCommandOptions) => ListCommandOptions;
|
|
9
|
-
export declare const resolveOutputMode: (command: Command) => OutputMode;
|
|
10
9
|
export interface CommandExecutionContext {
|
|
11
10
|
client: CompaniesHouseClient;
|
|
12
11
|
}
|
|
13
|
-
export interface ExecuteCommandOptions<TInput, TData
|
|
12
|
+
export interface ExecuteCommandOptions<TInput, TData extends Record<string, unknown>> {
|
|
14
13
|
command: Command;
|
|
15
14
|
commandName: string;
|
|
16
15
|
dependencies: RuntimeDependencies;
|
|
17
16
|
execute: (context: CommandExecutionContext) => Promise<CommandEnvelope<TInput, TData>>;
|
|
18
17
|
renderHuman: (envelope: CommandEnvelope<TInput, TData>, context: HumanRenderContext) => string;
|
|
19
18
|
}
|
|
20
|
-
export declare const executeCommand: <TInput, TData
|
|
19
|
+
export declare const executeCommand: <TInput, TData extends Record<string, unknown>>({ command, commandName, dependencies, execute, renderHuman }: ExecuteCommandOptions<TInput, TData>) => Promise<void>;
|
|
21
20
|
//# sourceMappingURL=shared.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/commands/shared.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/commands/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,gCAAgC,CAAC;AAQxC,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAElB,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AAEzB,eAAO,MAAM,gCAAgC,QAAO,mBAYlD,CAAC;AAEH,eAAO,MAAM,oBAAoB,GAAI,OAAO,MAAM,KAAG,MAQpD,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,OAAO,MAAM,KAAG,MAQvD,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,SAAS,OAAO,KAAG,OAIA,CAAC;AAEnD,eAAO,MAAM,kBAAkB,GAAI,SAAS,kBAAkB,KAAG,kBAahE,CAAC;AA4BF,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB,CAAC,MAAM,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAClF,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,mBAAmB,CAAC;IAClC,OAAO,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IACvF,WAAW,EAAE,CACX,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,EACxC,OAAO,EAAE,kBAAkB,KACxB,MAAM,CAAC;CACb;AAED,eAAO,MAAM,cAAc,GAAU,MAAM,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,8DAMjF,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,KAAG,OAAO,CAAC,IAAI,CAiCrD,CAAC"}
|
package/dist/commands/shared.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { CommanderError, InvalidArgumentError } from "commander";
|
|
2
1
|
import { createCompaniesHouseClient } from "../lib/companiesHouseClient.js";
|
|
3
2
|
import { resolveCliConfig } from "../lib/config.js";
|
|
4
|
-
import { CliHandledError, toCliError } from "../lib/errors.js";
|
|
3
|
+
import { CliHandledError, createCliError, toCliError } from "../lib/errors.js";
|
|
4
|
+
import { resolveOutputMode, writeCommandError, writeCommandSuccess } from "../lib/output.js";
|
|
5
5
|
export const createDefaultRuntimeDependencies = () => ({
|
|
6
6
|
cwd: process.cwd(),
|
|
7
7
|
env: process.env,
|
|
@@ -18,14 +18,14 @@ export const createDefaultRuntimeDependencies = () => ({
|
|
|
18
18
|
export const parsePositiveInteger = (value) => {
|
|
19
19
|
const parsedValue = Number.parseInt(value, 10);
|
|
20
20
|
if (!Number.isInteger(parsedValue) || parsedValue <= 0) {
|
|
21
|
-
throw
|
|
21
|
+
throw createCliError("INVALID_INPUT", "Expected a positive integer.");
|
|
22
22
|
}
|
|
23
23
|
return parsedValue;
|
|
24
24
|
};
|
|
25
25
|
export const parseNonNegativeInteger = (value) => {
|
|
26
26
|
const parsedValue = Number.parseInt(value, 10);
|
|
27
27
|
if (!Number.isInteger(parsedValue) || parsedValue < 0) {
|
|
28
|
-
throw
|
|
28
|
+
throw createCliError("INVALID_INPUT", "Expected a non-negative integer.");
|
|
29
29
|
}
|
|
30
30
|
return parsedValue;
|
|
31
31
|
};
|
|
@@ -35,7 +35,7 @@ export const addListOptions = (command) => command
|
|
|
35
35
|
.option("--all", "Fetch all available pages.");
|
|
36
36
|
export const resolveListOptions = (options) => {
|
|
37
37
|
if ((options.all ?? false) && (options.startIndex ?? 0) !== 0) {
|
|
38
|
-
throw
|
|
38
|
+
throw createCliError("INVALID_INPUT", "--all cannot be combined with a non-zero --start-index.");
|
|
39
39
|
}
|
|
40
40
|
return {
|
|
41
41
|
all: options.all ?? false,
|
|
@@ -43,10 +43,7 @@ export const resolveListOptions = (options) => {
|
|
|
43
43
|
startIndex: options.startIndex ?? 0
|
|
44
44
|
};
|
|
45
45
|
};
|
|
46
|
-
|
|
47
|
-
const globalOptions = command.optsWithGlobals();
|
|
48
|
-
return globalOptions.json ? "json" : "human";
|
|
49
|
-
};
|
|
46
|
+
const resolveOutputOptions = (command) => command.optsWithGlobals();
|
|
50
47
|
const DEFAULT_TERMINAL_WIDTH = 80;
|
|
51
48
|
const resolveHumanRenderContext = (command, dependencies) => {
|
|
52
49
|
const globalOptions = command.optsWithGlobals();
|
|
@@ -61,8 +58,9 @@ const resolveHumanRenderContext = (command, dependencies) => {
|
|
|
61
58
|
terminalWidth
|
|
62
59
|
};
|
|
63
60
|
};
|
|
64
|
-
export const executeCommand = async ({ command, dependencies, execute, renderHuman }) => {
|
|
65
|
-
const
|
|
61
|
+
export const executeCommand = async ({ command, commandName, dependencies, execute, renderHuman }) => {
|
|
62
|
+
const requestedAt = new Date().toISOString();
|
|
63
|
+
const outputMode = resolveOutputMode(resolveOutputOptions(command), dependencies);
|
|
66
64
|
try {
|
|
67
65
|
const config = resolveCliConfig({
|
|
68
66
|
cwd: dependencies.cwd,
|
|
@@ -76,27 +74,13 @@ export const executeCommand = async ({ command, dependencies, execute, renderHum
|
|
|
76
74
|
const envelope = await execute({
|
|
77
75
|
client
|
|
78
76
|
});
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
return;
|
|
82
|
-
}
|
|
83
|
-
dependencies.writeStdout(`${renderHuman(envelope, resolveHumanRenderContext(command, dependencies))}\n`);
|
|
77
|
+
const humanRenderContext = resolveHumanRenderContext(command, dependencies);
|
|
78
|
+
writeCommandSuccess(envelope, requestedAt, outputMode, dependencies, (commandEnvelope) => renderHuman(commandEnvelope, humanRenderContext));
|
|
84
79
|
}
|
|
85
80
|
catch (error) {
|
|
86
81
|
const cliError = toCliError(error);
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
error: {
|
|
90
|
-
code: cliError.code,
|
|
91
|
-
message: cliError.message,
|
|
92
|
-
statusCode: cliError.statusCode ?? null
|
|
93
|
-
}
|
|
94
|
-
}, null, 2)}\n`);
|
|
95
|
-
}
|
|
96
|
-
else {
|
|
97
|
-
dependencies.writeStderr(`Error: ${cliError.message}\n`);
|
|
98
|
-
}
|
|
99
|
-
throw new CliHandledError();
|
|
82
|
+
writeCommandError(commandName, cliError, requestedAt, outputMode, dependencies);
|
|
83
|
+
throw new CliHandledError(cliError.exitCode);
|
|
100
84
|
}
|
|
101
85
|
};
|
|
102
86
|
//# sourceMappingURL=shared.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../src/commands/shared.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../src/commands/shared.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,0BAA0B,EAE3B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAS1B,MAAM,CAAC,MAAM,gCAAgC,GAAG,GAAwB,EAAE,CAAC,CAAC;IAC1E,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;IAClB,GAAG,EAAE,OAAO,CAAC,GAAG;IAChB,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;IACrC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK;IACjC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;QACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;QACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAU,EAAE;IAC5D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,cAAc,CAAC,eAAe,EAAE,8BAA8B,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAa,EAAU,EAAE;IAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;QACtD,MAAM,cAAc,CAAC,eAAe,EAAE,kCAAkC,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAgB,EAAW,EAAE,CAC1D,OAAO;KACJ,MAAM,CAAC,2BAA2B,EAAE,0BAA0B,EAAE,oBAAoB,CAAC;KACrF,MAAM,CAAC,wBAAwB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,CAAC,CAAC;KACvF,MAAM,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;AAEnD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAA2B,EAAsB,EAAE;IACpF,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,MAAM,cAAc,CAClB,eAAe,EACf,yDAAyD,CAC1D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,KAAK;QACzB,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrF,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;KACpC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,OAAgB,EAAiB,EAAE,CAC/D,OAAO,CAAC,eAAe,EAAiB,CAAC;AAE3C,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,MAAM,yBAAyB,GAAG,CAChC,OAAgB,EAChB,YAAiC,EACb,EAAE;IACtB,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,EAEzC,CAAC;IACL,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,IAAI,KAAK,CAAC;IACtD,MAAM,mBAAmB,GAAG,aAAa,CAAC,KAAK,KAAK,KAAK,CAAC;IAC1D,MAAM,kBAAkB,GAAG,UAAU,IAAI,YAAY,CAAC,GAAG,CAAC;IAC1D,MAAM,aAAa,GACjB,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,IAAI,YAAY,CAAC,aAAa,GAAG,CAAC;QAC9E,CAAC,CAAC,YAAY,CAAC,aAAa;QAC5B,CAAC,CAAC,sBAAsB,CAAC;IAE7B,OAAO;QACL,WAAW,EAAE,WAAW,IAAI,CAAC,mBAAmB,IAAI,CAAC,kBAAkB;QACvE,aAAa;KACd,CAAC;AACJ,CAAC,CAAC;AAiBF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAiD,EAClF,OAAO,EACP,WAAW,EACX,YAAY,EACZ,OAAO,EACP,WAAW,EAC0B,EAAiB,EAAE;IACxD,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC7C,MAAM,UAAU,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC;IAElF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,gBAAgB,CAAC;YAC9B,GAAG,EAAE,YAAY,CAAC,GAAG;YACrB,GAAG,EAAE,YAAY,CAAC,GAAG;SACtB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,0BAA0B,CAAC;YACxC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,mBAAmB,EAAE,YAAY,CAAC,mBAAmB;SACtD,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC;YAC7B,MAAM;SACP,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAE5E,mBAAmB,CACjB,QAAQ,EACR,WAAW,EACX,UAAU,EACV,YAAY,EACZ,CAAC,eAAe,EAAE,EAAE,CAAC,WAAW,CAAC,eAAe,EAAE,kBAAkB,CAAC,CACtE,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAEnC,iBAAiB,CAAC,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QAEhF,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companiesHouseClient.d.ts","sourceRoot":"","sources":["../../src/lib/companiesHouseClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"companiesHouseClient.d.ts","sourceRoot":"","sources":["../../src/lib/companiesHouseClient.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,iCAAiC,EACjC,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AASzB,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,OAAO,KAAK,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACzD,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,aAAa,EAAE,MAAM,CAAC;CACvB;AAsFD,MAAM,WAAW,oBAAoB;IACnC,iBAAiB,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACjF,aAAa,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IACvF,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC7E,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAChF,uBAAuB,EAAE,CACvB,OAAO,EAAE,8BAA8B,KACpC,OAAO,CAAC,iCAAiC,CAAC,CAAC;IAChD,YAAY,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAChF,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClE,eAAe,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACxF,cAAc,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACvF;AAED,eAAO,MAAM,0BAA0B,GAAI,0CAIxC,2BAA2B,KAAG,oBA+IhC,CAAC"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { createRequire } from "node:module";
|
|
2
|
+
import { createCliError } from "./errors.js";
|
|
3
|
+
const require = createRequire(import.meta.url);
|
|
4
|
+
const packageJson = require("../../package.json");
|
|
5
|
+
const USER_AGENT = `companies-house-cli/${packageJson.version}`;
|
|
3
6
|
const safeParseJson = (text) => {
|
|
4
7
|
if (text.trim().length === 0) {
|
|
5
8
|
return null;
|
|
@@ -24,14 +27,23 @@ const buildUrl = (baseUrl, path, query) => {
|
|
|
24
27
|
return url;
|
|
25
28
|
};
|
|
26
29
|
const createApiError = (statusCode, url, responseBody) => {
|
|
27
|
-
if (statusCode === 401) {
|
|
28
|
-
return
|
|
30
|
+
if (statusCode === 401 || statusCode === 403) {
|
|
31
|
+
return createCliError("AUTH_ERROR", "Companies House rejected the request. Check that COMPANIES_HOUSE_API_KEY is valid for the public data API.", {
|
|
32
|
+
statusCode,
|
|
33
|
+
url
|
|
34
|
+
});
|
|
29
35
|
}
|
|
30
36
|
if (statusCode === 404) {
|
|
31
|
-
return
|
|
37
|
+
return createCliError("NOT_FOUND", "The requested Companies House resource was not found.", {
|
|
38
|
+
statusCode,
|
|
39
|
+
url
|
|
40
|
+
});
|
|
32
41
|
}
|
|
33
42
|
if (statusCode === 429) {
|
|
34
|
-
return
|
|
43
|
+
return createCliError("RATE_LIMITED", "Companies House rate-limited the request. Wait a moment and try again.", {
|
|
44
|
+
statusCode,
|
|
45
|
+
url
|
|
46
|
+
});
|
|
35
47
|
}
|
|
36
48
|
const message = typeof responseBody === "object" &&
|
|
37
49
|
responseBody !== null &&
|
|
@@ -39,7 +51,10 @@ const createApiError = (statusCode, url, responseBody) => {
|
|
|
39
51
|
typeof responseBody.error === "string"
|
|
40
52
|
? responseBody.error
|
|
41
53
|
: `Companies House returned HTTP ${statusCode} for ${url}.`;
|
|
42
|
-
return
|
|
54
|
+
return createCliError("UPSTREAM_API_ERROR", message, {
|
|
55
|
+
statusCode,
|
|
56
|
+
url
|
|
57
|
+
});
|
|
43
58
|
};
|
|
44
59
|
export const createCompaniesHouseClient = ({ apiKey, baseUrl, fetchImplementation }) => {
|
|
45
60
|
const authorizationHeader = `Basic ${Buffer.from(`${apiKey}:`).toString("base64")}`;
|
|
@@ -56,9 +71,16 @@ export const createCompaniesHouseClient = ({ apiKey, baseUrl, fetchImplementatio
|
|
|
56
71
|
});
|
|
57
72
|
}
|
|
58
73
|
catch (error) {
|
|
59
|
-
throw
|
|
74
|
+
throw createCliError("UPSTREAM_API_ERROR", error instanceof Error
|
|
60
75
|
? `Failed to reach Companies House: ${error.message}`
|
|
61
|
-
: "Failed to reach Companies House.",
|
|
76
|
+
: "Failed to reach Companies House.", error instanceof Error
|
|
77
|
+
? {
|
|
78
|
+
reason: error.message,
|
|
79
|
+
url: url.toString()
|
|
80
|
+
}
|
|
81
|
+
: {
|
|
82
|
+
url: url.toString()
|
|
83
|
+
});
|
|
62
84
|
}
|
|
63
85
|
const responseText = await response.text();
|
|
64
86
|
const responseBody = safeParseJson(responseText);
|
|
@@ -69,7 +91,9 @@ export const createCompaniesHouseClient = ({ apiKey, baseUrl, fetchImplementatio
|
|
|
69
91
|
throw createApiError(response.status, url.toString(), responseBody);
|
|
70
92
|
}
|
|
71
93
|
if (typeof responseBody !== "object" || responseBody === null) {
|
|
72
|
-
throw
|
|
94
|
+
throw createCliError("UPSTREAM_API_ERROR", `Companies House returned an invalid JSON payload for ${url.toString()}.`, {
|
|
95
|
+
url: url.toString()
|
|
96
|
+
});
|
|
73
97
|
}
|
|
74
98
|
return responseBody;
|
|
75
99
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companiesHouseClient.js","sourceRoot":"","sources":["../../src/lib/companiesHouseClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"companiesHouseClient.js","sourceRoot":"","sources":["../../src/lib/companiesHouseClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAa5C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAwB,CAAC;AACzE,MAAM,UAAU,GAAG,uBAAuB,WAAW,CAAC,OAAO,EAAE,CAAC;AAiDhE,MAAM,aAAa,GAAG,CAAC,IAAY,EAAW,EAAE;IAC9C,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CACf,OAAe,EACf,IAAY,EACZ,KAAiC,EAC5B,EAAE;IACP,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;IAC1E,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACnE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IAEvD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAED,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,UAAkB,EAClB,GAAW,EACX,YAAqB,EACtB,EAAE;IACD,IAAI,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QAC7C,OAAO,cAAc,CACnB,YAAY,EACZ,4GAA4G,EAC5G;YACE,UAAU;YACV,GAAG;SACJ,CACF,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QACvB,OAAO,cAAc,CACnB,WAAW,EACX,uDAAuD,EACvD;YACE,UAAU;YACV,GAAG;SACJ,CACF,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QACvB,OAAO,cAAc,CACnB,cAAc,EACd,wEAAwE,EACxE;YACE,UAAU;YACV,GAAG;SACJ,CACF,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GACX,OAAO,YAAY,KAAK,QAAQ;QAChC,YAAY,KAAK,IAAI;QACrB,OAAO,IAAI,YAAY;QACvB,OAAO,YAAY,CAAC,KAAK,KAAK,QAAQ;QACpC,CAAC,CAAC,YAAY,CAAC,KAAK;QACpB,CAAC,CAAC,iCAAiC,UAAU,QAAQ,GAAG,GAAG,CAAC;IAEhE,OAAO,cAAc,CAAC,oBAAoB,EAAE,OAAO,EAAE;QACnD,UAAU;QACV,GAAG;KACJ,CAAC,CAAC;AACL,CAAC,CAAC;AAgBF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,EACzC,MAAM,EACN,OAAO,EACP,mBAAmB,EACS,EAAwB,EAAE;IACtD,MAAM,mBAAmB,GAAG,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;IAEpF,MAAM,WAAW,GAAG,KAAK,EACvB,IAAY,EACZ,KAAiC,EACjC,OAEC,EACkB,EAAE;QACrB,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAE3C,IAAI,QAAkB,CAAC;QAEvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,mBAAmB,CAAC,GAAG,EAAE;gBACxC,OAAO,EAAE;oBACP,MAAM,EAAE,kBAAkB;oBAC1B,aAAa,EAAE,mBAAmB;oBAClC,YAAY,EAAE,UAAU;iBACzB;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,cAAc,CAClB,oBAAoB,EACpB,KAAK,YAAY,KAAK;gBACpB,CAAC,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE;gBACrD,CAAC,CAAC,kCAAkC,EACtC,KAAK,YAAY,KAAK;gBACpB,CAAC,CAAC;oBACE,MAAM,EAAE,KAAK,CAAC,OAAO;oBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;iBACpB;gBACH,CAAC,CAAC;oBACE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;iBACpB,CACN,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,MAAM,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;QAEjD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YAC9D,MAAM,cAAc,CAClB,oBAAoB,EACpB,wDAAwD,GAAG,CAAC,QAAQ,EAAE,GAAG,EACzE;gBACE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE;aACpB,CACF,CAAC;QACJ,CAAC;QAED,OAAO,YAAiB,CAAC;IAC3B,CAAC,CAAC;IAEF,OAAO;QACL,iBAAiB,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,CACzC,CAAC,MAAM,WAAW,CAChB,YAAY,aAAa,EAAE,EAC3B,EAAE,CACH,CAA8B;QACjC,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,CACrC,MAAM,WAAW,CACf,YAAY,aAAa,aAAa,EACtC,EAAE,EACF;YACE,aAAa,EAAE,IAAI;SACpB,CACF;QACH,WAAW,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CACjE,CAAC,MAAM,WAAW,CAChB,YAAY,aAAa,UAAU,EACnC;YACE,cAAc,EAAE,YAAY;YAC5B,WAAW,EAAE,UAAU;SACxB,CACF,CAA0B;QAC7B,WAAW,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC3E,CAAC,MAAM,WAAW,CAChB,YAAY,aAAa,iBAAiB,EAC1C;YACE,QAAQ;YACR,cAAc,EAAE,YAAY;YAC5B,WAAW,EAAE,UAAU;SACxB,CACF,CAA6B;QAChC,uBAAuB,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CACzE,CAAC,MAAM,WAAW,CAChB,aAAa,SAAS,eAAe,EACrC;YACE,cAAc,EAAE,YAAY;YAC5B,WAAW,EAAE,UAAU;SACxB,CACF,CAAsC;QACzC,YAAY,EAAE,KAAK,EAAE,EACnB,aAAa,EACb,YAAY,EACZ,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,UAAU,EACX,EAAE,EAAE,CACH,CAAC,MAAM,WAAW,CAChB,YAAY,aAAa,WAAW,EACpC;YACE,cAAc,EAAE,YAAY;YAC5B,QAAQ,EAAE,OAAO;YACjB,aAAa,EAAE,YAAY;YAC3B,aAAa,EAAE,YAAY;YAC3B,WAAW,EAAE,UAAU;SACxB,CACF,CAA2B;QAC9B,OAAO,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC3E,CAAC,MAAM,WAAW,CAChB,YAAY,aAAa,mCAAmC,EAC5D;YACE,cAAc,EAAE,YAAY;YAC5B,aAAa,EAAE,YAAY;YAC3B,WAAW,EAAE,UAAU;SACxB,CACF,CAAuB;QAC1B,eAAe,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,CAC3E,CAAC,MAAM,WAAW,CAA2B,mBAAmB,EAAE;YAChE,cAAc,EAAE,YAAY;YAC5B,CAAC,EAAE,KAAK;YACR,YAAY;YACZ,WAAW,EAAE,UAAU;SACxB,CAAC,CAA6B;QACjC,cAAc,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5D,CAAC,MAAM,WAAW,CAA2B,kBAAkB,EAAE;YAC/D,cAAc,EAAE,YAAY;YAC5B,CAAC,EAAE,KAAK;YACR,WAAW,EAAE,UAAU;SACxB,CAAC,CAA6B;KAClC,CAAC;AACJ,CAAC,CAAC"}
|
package/dist/lib/config.js
CHANGED
|
@@ -2,7 +2,7 @@ import { existsSync, readFileSync } from "node:fs";
|
|
|
2
2
|
import { resolve } from "node:path";
|
|
3
3
|
import { parse } from "dotenv";
|
|
4
4
|
import { z } from "zod";
|
|
5
|
-
import {
|
|
5
|
+
import { createCliError } from "./errors.js";
|
|
6
6
|
const configSchema = z.object({
|
|
7
7
|
apiKey: z.string().trim().min(1)
|
|
8
8
|
});
|
|
@@ -23,7 +23,7 @@ export const resolveCliConfig = ({ cwd, env }) => {
|
|
|
23
23
|
apiKey
|
|
24
24
|
});
|
|
25
25
|
if (!parsedConfig.success) {
|
|
26
|
-
throw
|
|
26
|
+
throw createCliError("AUTH_ERROR", "Missing COMPANIES_HOUSE_API_KEY. Set it in your environment or add it to a local .env file.");
|
|
27
27
|
}
|
|
28
28
|
return {
|
|
29
29
|
apiKey: parsedConfig.data.apiKey,
|
package/dist/lib/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACjC,CAAC,CAAC;AAYH,MAAM,wBAAwB,GAAG,gDAAgD,CAAC;AAElF,MAAM,oBAAoB,GAAG,CAAC,GAAW,EAAsB,EAAE;IAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAExC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,YAAY,CAAC,uBAAuB,CAAC;IAEpD,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5F,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAC/B,GAAG,EACH,GAAG,EACqB,EAAa,EAAE;IACvC,MAAM,MAAM,GAAG,GAAG,CAAC,uBAAuB,EAAE,IAAI,EAAE,IAAI,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAEhF,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC;QAC1C,MAAM;KACP,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,cAAc,CAClB,YAAY,EACZ,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM;QAChC,OAAO,EAAE,wBAAwB;KAClC,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,MAAM,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC"}
|
package/dist/lib/errors.d.ts
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
|
+
export type CliErrorCode = "AUTH_ERROR" | "INTERNAL_ERROR" | "INVALID_INPUT" | "NOT_FOUND" | "RATE_LIMITED" | "UPSTREAM_API_ERROR";
|
|
2
|
+
export interface CompaniesHouseCliErrorOptions {
|
|
3
|
+
code: CliErrorCode;
|
|
4
|
+
details?: unknown;
|
|
5
|
+
exitCode?: number;
|
|
6
|
+
retryable?: boolean;
|
|
7
|
+
}
|
|
1
8
|
export declare class CompaniesHouseCliError extends Error {
|
|
2
|
-
readonly code:
|
|
3
|
-
readonly
|
|
4
|
-
|
|
9
|
+
readonly code: CliErrorCode;
|
|
10
|
+
readonly details: unknown;
|
|
11
|
+
readonly exitCode: number;
|
|
12
|
+
readonly retryable: boolean;
|
|
13
|
+
constructor(message: string, { code, details, exitCode, retryable }: CompaniesHouseCliErrorOptions);
|
|
5
14
|
}
|
|
6
15
|
export declare class CliHandledError extends Error {
|
|
7
|
-
|
|
16
|
+
readonly exitCode: number;
|
|
17
|
+
constructor(exitCode: number);
|
|
8
18
|
}
|
|
19
|
+
export declare const createCliError: (code: CliErrorCode, message: string, details?: unknown) => CompaniesHouseCliError;
|
|
20
|
+
export declare const isCliError: (error: unknown) => error is CompaniesHouseCliError;
|
|
9
21
|
export declare const toCliError: (error: unknown) => CompaniesHouseCliError;
|
|
10
22
|
//# sourceMappingURL=errors.d.ts.map
|
package/dist/lib/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GACpB,YAAY,GACZ,gBAAgB,GAChB,eAAe,GACf,WAAW,GACX,cAAc,GACd,oBAAoB,CAAC;AAgBzB,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,SAAgB,IAAI,EAAE,YAAY,CAAC;IACnC,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,SAAS,EAAE,OAAO,CAAC;gBAGjC,OAAO,EAAE,MAAM,EACf,EACE,IAAI,EACJ,OAAO,EACP,QAAmC,EACnC,SAA2C,EAC5C,EAAE,6BAA6B;CASnC;AAED,qBAAa,eAAgB,SAAQ,KAAK;IACxC,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAEd,QAAQ,EAAE,MAAM;CAKpC;AAED,eAAO,MAAM,cAAc,GACzB,MAAM,YAAY,EAClB,SAAS,MAAM,EACf,UAAU,OAAO,KAChB,sBAIC,CAAC;AAEL,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,sBAI/B,CAAC;AAKvB,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,sBAc3C,CAAC"}
|
package/dist/lib/errors.js
CHANGED
|
@@ -1,26 +1,57 @@
|
|
|
1
|
+
import { CommanderError } from "commander";
|
|
2
|
+
const EXIT_CODE_BY_ERROR = {
|
|
3
|
+
AUTH_ERROR: 3,
|
|
4
|
+
INTERNAL_ERROR: 4,
|
|
5
|
+
INVALID_INPUT: 2,
|
|
6
|
+
NOT_FOUND: 2,
|
|
7
|
+
RATE_LIMITED: 3,
|
|
8
|
+
UPSTREAM_API_ERROR: 3
|
|
9
|
+
};
|
|
10
|
+
const RETRYABLE_ERROR_CODES = new Set([
|
|
11
|
+
"RATE_LIMITED",
|
|
12
|
+
"UPSTREAM_API_ERROR"
|
|
13
|
+
]);
|
|
1
14
|
export class CompaniesHouseCliError extends Error {
|
|
2
15
|
code;
|
|
3
|
-
|
|
4
|
-
|
|
16
|
+
details;
|
|
17
|
+
exitCode;
|
|
18
|
+
retryable;
|
|
19
|
+
constructor(message, { code, details, exitCode = EXIT_CODE_BY_ERROR[code], retryable = RETRYABLE_ERROR_CODES.has(code) }) {
|
|
5
20
|
super(message);
|
|
6
21
|
this.name = "CompaniesHouseCliError";
|
|
7
22
|
this.code = code;
|
|
8
|
-
this.
|
|
23
|
+
this.details = details;
|
|
24
|
+
this.exitCode = exitCode;
|
|
25
|
+
this.retryable = retryable;
|
|
9
26
|
}
|
|
10
27
|
}
|
|
11
28
|
export class CliHandledError extends Error {
|
|
12
|
-
|
|
29
|
+
exitCode;
|
|
30
|
+
constructor(exitCode) {
|
|
13
31
|
super("CLI error already handled");
|
|
14
32
|
this.name = "CliHandledError";
|
|
33
|
+
this.exitCode = exitCode;
|
|
15
34
|
}
|
|
16
35
|
}
|
|
36
|
+
export const createCliError = (code, message, details) => new CompaniesHouseCliError(message, {
|
|
37
|
+
code,
|
|
38
|
+
details
|
|
39
|
+
});
|
|
40
|
+
export const isCliError = (error) => error instanceof Error &&
|
|
41
|
+
"code" in error &&
|
|
42
|
+
"exitCode" in error &&
|
|
43
|
+
"retryable" in error;
|
|
44
|
+
const normalizeCommanderMessage = (message) => message.replace(/^error:\s*/u, "");
|
|
17
45
|
export const toCliError = (error) => {
|
|
18
|
-
if (error
|
|
46
|
+
if (isCliError(error)) {
|
|
19
47
|
return error;
|
|
20
48
|
}
|
|
49
|
+
if (error instanceof CommanderError) {
|
|
50
|
+
return createCliError("INVALID_INPUT", normalizeCommanderMessage(error.message));
|
|
51
|
+
}
|
|
21
52
|
if (error instanceof Error) {
|
|
22
|
-
return
|
|
53
|
+
return createCliError("INTERNAL_ERROR", error.message);
|
|
23
54
|
}
|
|
24
|
-
return
|
|
55
|
+
return createCliError("INTERNAL_ERROR", "An unexpected internal error occurred.");
|
|
25
56
|
};
|
|
26
57
|
//# sourceMappingURL=errors.js.map
|
package/dist/lib/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC/B,IAAI,CAAS;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAU3C,MAAM,kBAAkB,GAAiC;IACvD,UAAU,EAAE,CAAC;IACb,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,CAAC;IAChB,SAAS,EAAE,CAAC;IACZ,YAAY,EAAE,CAAC;IACf,kBAAkB,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAe;IAClD,cAAc;IACd,oBAAoB;CACrB,CAAC,CAAC;AASH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC/B,IAAI,CAAe;IACnB,OAAO,CAAU;IACjB,QAAQ,CAAS;IACjB,SAAS,CAAU;IAEnC,YACE,OAAe,EACf,EACE,IAAI,EACJ,OAAO,EACP,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,EACnC,SAAS,GAAG,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,EACb;QAEhC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxB,QAAQ,CAAS;IAEjC,YAAmB,QAAgB;QACjC,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAkB,EAClB,OAAe,EACf,OAAiB,EACO,EAAE,CAC1B,IAAI,sBAAsB,CAAC,OAAO,EAAE;IAClC,IAAI;IACJ,OAAO;CACR,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAmC,EAAE,CAC5E,KAAK,YAAY,KAAK;IACtB,MAAM,IAAI,KAAK;IACf,UAAU,IAAI,KAAK;IACnB,WAAW,IAAI,KAAK,CAAC;AAEvB,MAAM,yBAAyB,GAAG,CAAC,OAAe,EAAU,EAAE,CAC5D,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAErC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAA0B,EAAE;IACnE,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;QACpC,OAAO,cAAc,CAAC,eAAe,EAAE,yBAAyB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,cAAc,CAAC,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,cAAc,CAAC,gBAAgB,EAAE,wCAAwC,CAAC,CAAC;AACpF,CAAC,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { CommandEnvelope, ErrorEnvelope, OutputMode, OutputOptions, RuntimeDependencies, SuccessEnvelope } from "../types/cli.js";
|
|
2
|
+
import type { CompaniesHouseCliError } from "./errors.js";
|
|
3
|
+
type SerializedCommandData<TInput, TData> = {
|
|
4
|
+
input: TInput;
|
|
5
|
+
pagination?: CommandEnvelope<TInput, TData>["pagination"];
|
|
6
|
+
} & TData;
|
|
7
|
+
export declare const resolveOutputMode: (options: OutputOptions, dependencies: Pick<RuntimeDependencies, "stdoutIsTTY">) => OutputMode;
|
|
8
|
+
export declare const serializeSuccessEnvelope: <TInput, TData extends Record<string, unknown>>(envelope: CommandEnvelope<TInput, TData>, requestedAt: string) => SuccessEnvelope<SerializedCommandData<TInput, TData>>;
|
|
9
|
+
export declare const serializeErrorEnvelope: (commandName: string, error: CompaniesHouseCliError, requestedAt: string) => ErrorEnvelope;
|
|
10
|
+
export declare const writeCommandSuccess: <TInput, TData extends Record<string, unknown>>(envelope: CommandEnvelope<TInput, TData>, requestedAt: string, outputMode: OutputMode, dependencies: RuntimeDependencies, renderText: (envelope: CommandEnvelope<TInput, TData>) => string) => void;
|
|
11
|
+
export declare const writeCommandError: (commandName: string, error: CompaniesHouseCliError, requestedAt: string, outputMode: OutputMode, dependencies: RuntimeDependencies) => void;
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=output.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/lib/output.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,UAAU,EACV,aAAa,EACb,mBAAmB,EACnB,eAAe,EAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAK1D,KAAK,qBAAqB,CAAC,MAAM,EAAE,KAAK,IAAI;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC;CAC3D,GAAG,KAAK,CAAC;AAMV,eAAO,MAAM,iBAAiB,GAC5B,SAAS,aAAa,EACtB,cAAc,IAAI,CAAC,mBAAmB,EAAE,aAAa,CAAC,KACrD,UAcF,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,MAAM,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpF,UAAU,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,EACxC,aAAa,MAAM,KAClB,eAAe,CAAC,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,CAUrD,CAAC;AAEH,eAAO,MAAM,sBAAsB,GACjC,aAAa,MAAM,EACnB,OAAO,sBAAsB,EAC7B,aAAa,MAAM,KAClB,aAWD,CAAC;AAEH,eAAO,MAAM,mBAAmB,GAAI,MAAM,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/E,UAAU,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,EACxC,aAAa,MAAM,EACnB,YAAY,UAAU,EACtB,cAAc,mBAAmB,EACjC,YAAY,CAAC,QAAQ,EAAE,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,MAAM,KAC/D,IAOF,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC5B,aAAa,MAAM,EACnB,OAAO,sBAAsB,EAC7B,aAAa,MAAM,EACnB,YAAY,UAAU,EACtB,cAAc,mBAAmB,KAChC,IAOF,CAAC"}
|