@shan8851/companies-house-cli 0.1.0

package/dist/lib/normalizers.js

@@ -0,0 +1,235 @@
+const DOCUMENT_API_BASE_URL = "https://document-api.company-information.service.gov.uk";
+const toNullableString = (value) => typeof value === "string" && value.trim().length > 0 ? value : null;
+const toNullableBoolean = (value) => typeof value === "boolean" ? value : null;
+const toNullableNumber = (value) => typeof value === "number" ? value : null;
+const compactStrings = (values) => values.filter((value) => value !== null);
+export const normalizeAddress = (address) => {
+    if (!address) {
+        return null;
+    }
+    const normalizedAddress = {
+        addressLine1: toNullableString(address.address_line_1),
+        addressLine2: toNullableString(address.address_line_2),
+        careOf: toNullableString(address.care_of),
+        country: toNullableString(address.country),
+        formatted: null,
+        locality: toNullableString(address.locality),
+        poBox: toNullableString(address.po_box),
+        postalCode: toNullableString(address.postal_code),
+        premises: toNullableString(address.premises),
+        region: toNullableString(address.region)
+    };
+    const formattedParts = compactStrings([
+        normalizedAddress.careOf,
+        normalizedAddress.poBox,
+        normalizedAddress.premises,
+        normalizedAddress.addressLine1,
+        normalizedAddress.addressLine2,
+        normalizedAddress.locality,
+        normalizedAddress.region,
+        normalizedAddress.postalCode,
+        normalizedAddress.country
+    ]);
+    return {
+        ...normalizedAddress,
+        formatted: formattedParts.length > 0 ? formattedParts.join(", ") : null
+    };
+};
+export const normalizeDateOfBirth = (dateOfBirth) => {
+    if (!dateOfBirth) {
+        return null;
+    }
+    const day = toNullableNumber(dateOfBirth.day);
+    const month = toNullableNumber(dateOfBirth.month);
+    const year = toNullableNumber(dateOfBirth.year);
+    const formattedParts = compactStrings([
+        day !== null ? String(day).padStart(2, "0") : null,
+        month !== null ? String(month).padStart(2, "0") : null,
+        year !== null ? String(year) : null
+    ]);
+    return {
+        day,
+        formatted: formattedParts.length > 0 ? formattedParts.join("/") : null,
+        month,
+        year
+    };
+};
+export const normalizeCompanySearchResult = (item) => ({
+    address: normalizeAddress(item.address),
+    companyNumber: toNullableString(item.company_number),
+    companyStatus: toNullableString(item.company_status),
+    companyType: toNullableString(item.company_type),
+    dateOfCessation: toNullableString(item.date_of_cessation),
+    dateOfCreation: toNullableString(item.date_of_creation),
+    description: toNullableString(item.description),
+    descriptionIdentifiers: item.description_identifier ?? [],
+    name: toNullableString(item.title),
+    snippet: toNullableString(item.snippet)
+});
+export const normalizeCompanyProfile = (profile) => ({
+    accounts: {
+        nextAccountsDueOn: toNullableString(profile.accounts?.next_due),
+        nextAccountsMadeUpTo: toNullableString(profile.accounts?.next_made_up_to),
+        overdue: toNullableBoolean(profile.accounts?.overdue)
+    },
+    companyName: toNullableString(profile.company_name),
+    companyNumber: toNullableString(profile.company_number),
+    companyStatus: toNullableString(profile.company_status),
+    companyStatusDetail: toNullableString(profile.company_status_detail),
+    confirmationStatement: {
+        nextDueOn: toNullableString(profile.confirmation_statement?.next_due),
+        nextMadeUpTo: toNullableString(profile.confirmation_statement?.next_made_up_to),
+        overdue: toNullableBoolean(profile.confirmation_statement?.overdue)
+    },
+    dateOfCessation: toNullableString(profile.date_of_cessation),
+    dateOfCreation: toNullableString(profile.date_of_creation),
+    hasCharges: toNullableBoolean(profile.has_charges),
+    hasInsolvencyHistory: toNullableBoolean(profile.has_insolvency_history),
+    jurisdiction: toNullableString(profile.jurisdiction),
+    previousCompanyNames: profile.previous_company_names?.map((previousCompanyName) => ({
+        ceasedOn: toNullableString(previousCompanyName.ceased_on),
+        effectiveFrom: toNullableString(previousCompanyName.effective_from),
+        name: toNullableString(previousCompanyName.name)
+    })) ?? [],
+    registeredOfficeAddress: normalizeAddress(profile.registered_office_address),
+    sicCodes: profile.sic_codes ?? [],
+    subtype: toNullableString(profile.subtype),
+    type: toNullableString(profile.type)
+});
+export const normalizeOfficer = (item) => ({
+    address: normalizeAddress(item.address),
+    appointedOn: toNullableString(item.appointed_on),
+    countryOfResidence: toNullableString(item.country_of_residence),
+    dateOfBirth: normalizeDateOfBirth(item.date_of_birth),
+    name: toNullableString(item.name),
+    nationality: toNullableString(item.nationality),
+    occupation: toNullableString(item.occupation),
+    officerRole: toNullableString(item.officer_role),
+    personNumber: toNullableString(item.person_number),
+    principalOfficeAddress: normalizeAddress(item.principal_office_address),
+    resignedOn: toNullableString(item.resigned_on),
+    responsibilities: toNullableString(item.responsibilities)
+});
+const toDocumentContentUrl = (documentMetadataUrl, includeLinks) => {
+    if (!includeLinks || documentMetadataUrl === null) {
+        return null;
+    }
+    if (documentMetadataUrl.startsWith("http://") || documentMetadataUrl.startsWith("https://")) {
+        return documentMetadataUrl.endsWith("/content")
+            ? documentMetadataUrl
+            : `${documentMetadataUrl}/content`;
+    }
+    const normalizedPath = documentMetadataUrl.startsWith("/")
+        ? documentMetadataUrl
+        : `/${documentMetadataUrl}`;
+    const contentPath = normalizedPath.endsWith("/content")
+        ? normalizedPath
+        : `${normalizedPath}/content`;
+    return new URL(contentPath, DOCUMENT_API_BASE_URL).toString();
+};
+export const normalizeFiling = (item, options) => {
+    const documentMetadataUrl = toNullableString(item.links?.document_metadata);
+    return {
+        category: toNullableString(item.category),
+        date: toNullableString(item.date),
+        description: toNullableString(item.description),
+        documentContentUrl: toDocumentContentUrl(documentMetadataUrl, options?.includeLinks ?? false),
+        documentMetadataUrl,
+        pages: toNullableNumber(item.pages),
+        paperFiled: toNullableBoolean(item.paper_filed),
+        subcategory: toNullableString(item.subcategory),
+        transactionId: toNullableString(item.transaction_id),
+        type: toNullableString(item.type)
+    };
+};
+export const normalizePsc = (item) => ({
+    address: normalizeAddress(item.address),
+    ceased: toNullableBoolean(item.ceased),
+    ceasedOn: toNullableString(item.ceased_on),
+    countryOfResidence: toNullableString(item.country_of_residence),
+    dateOfBirth: normalizeDateOfBirth(item.date_of_birth),
+    description: toNullableString(item.description),
+    identification: item.identification
+        ? {
+            countryRegistered: toNullableString(item.identification.country_registered),
+            legalAuthority: toNullableString(item.identification.legal_authority),
+            legalForm: toNullableString(item.identification.legal_form),
+            placeRegistered: toNullableString(item.identification.place_registered),
+            registrationNumber: toNullableString(item.identification.registration_number)
+        }
+        : null,
+    isSanctioned: toNullableBoolean(item.is_sanctioned),
+    kind: toNullableString(item.kind),
+    name: toNullableString(item.name),
+    nationality: toNullableString(item.nationality),
+    naturesOfControl: item.natures_of_control ?? [],
+    notifiedOn: toNullableString(item.notified_on),
+    principalOfficeAddress: normalizeAddress(item.principal_office_address)
+});
+export const extractOfficerId = (selfLink) => {
+    if (typeof selfLink !== "string") {
+        return null;
+    }
+    const match = selfLink.match(/\/officers\/([^/]+)/);
+    return match?.[1] ?? null;
+};
+export const normalizeOfficerAppointment = (item) => ({
+    appointedOn: toNullableString(item.appointed_on),
+    companyName: toNullableString(item.appointed_to?.company_name),
+    companyNumber: toNullableString(item.appointed_to?.company_number),
+    companyStatus: toNullableString(item.appointed_to?.company_status),
+    countryOfResidence: toNullableString(item.country_of_residence),
+    name: toNullableString(item.name),
+    nationality: toNullableString(item.nationality),
+    occupation: toNullableString(item.occupation),
+    officerRole: toNullableString(item.officer_role),
+    principalOfficeAddress: normalizeAddress(item.principal_office_address ?? item.address),
+    resignedOn: toNullableString(item.resigned_on),
+    responsibilities: toNullableString(item.responsibilities)
+});
+export const normalizePersonSearchResult = (item, appointments) => ({
+    address: normalizeAddress(item.address),
+    appointmentCount: toNullableNumber(item.appointment_count),
+    appointments,
+    dateOfBirth: normalizeDateOfBirth(item.date_of_birth),
+    description: toNullableString(item.description),
+    descriptionIdentifiers: item.description_identifiers ?? [],
+    name: toNullableString(item.title),
+    officerId: extractOfficerId(item.links?.self)
+});
+export const normalizeCharge = (item) => ({
+    acquiredOn: toNullableString(item.acquired_on),
+    briefDescription: toNullableString(item.particulars?.brief_description),
+    chargeCode: toNullableString(item.charge_code),
+    chargeNumber: toNullableNumber(item.charge_number),
+    classification: toNullableString(item.classification?.description),
+    createdOn: toNullableString(item.created_on),
+    deliveredOn: toNullableString(item.delivered_on),
+    moreThanFourPersonsEntitled: toNullableBoolean(item.more_than_four_persons_entitled),
+    personsEntitled: item.persons_entitled
+        ?.map((personEntitled) => toNullableString(personEntitled.name))
+        .filter((name) => name !== null) ?? [],
+    resolvedOn: toNullableString(item.resolved_on),
+    satisfiedOn: toNullableString(item.satisfied_on),
+    status: toNullableString(item.status),
+    type: toNullableString(item.particulars?.type)
+});
+const normalizeInsolvencyPractitioner = (practitioner) => ({
+    address: normalizeAddress(practitioner.address),
+    appointedOn: toNullableString(practitioner.appointed_on),
+    ceasedToActOn: toNullableString(practitioner.ceased_to_act_on),
+    name: toNullableString(practitioner.name),
+    role: toNullableString(practitioner.role)
+});
+export const normalizeInsolvencyCase = (insolvencyCase) => ({
+    caseDates: insolvencyCase.dates?.map((caseDate) => ({
+        date: toNullableString(caseDate.date),
+        type: toNullableString(caseDate.type)
+    })) ?? [],
+    notes: insolvencyCase.notes ?? [],
+    number: toNullableString(insolvencyCase.number),
+    practitioners: insolvencyCase.practitioners?.map(normalizeInsolvencyPractitioner) ?? [],
+    type: toNullableString(insolvencyCase.type)
+});
+export const normalizeInsolvencyCases = (insolvency) => insolvency?.cases?.map(normalizeInsolvencyCase) ?? [];
+//# sourceMappingURL=normalizers.js.map

package/dist/lib/normalizers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalizers.js","sourceRoot":"","sources":["../../src/lib/normalizers.ts"],"names":[],"mappings":"AA4BA,MAAM,qBAAqB,GAAG,yDAAyD,CAAC;AAExF,MAAM,gBAAgB,GAAG,CAAC,KAAyB,EAAiB,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAEtE,MAAM,iBAAiB,GAAG,CAAC,KAA0B,EAAkB,EAAE,CACvE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAE5C,MAAM,gBAAgB,GAAG,CAAC,KAAyB,EAAiB,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3C,MAAM,cAAc,GAAG,CAAC,MAA4B,EAAY,EAAE,CAChE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAA+B,EAA4B,EAAE;IAC5F,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,iBAAiB,GAAsB;QAC3C,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,cAAc,CAAC;QACtD,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,cAAc,CAAC;QACtD,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;QACzC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1C,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5C,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;QACvC,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC;QACjD,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5C,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;KACzC,CAAC;IAEF,MAAM,cAAc,GAAG,cAAc,CAAC;QACpC,iBAAiB,CAAC,MAAM;QACxB,iBAAiB,CAAC,KAAK;QACvB,iBAAiB,CAAC,QAAQ;QAC1B,iBAAiB,CAAC,YAAY;QAC9B,iBAAiB,CAAC,YAAY;QAC9B,iBAAiB,CAAC,QAAQ;QAC1B,iBAAiB,CAAC,MAAM;QACxB,iBAAiB,CAAC,UAAU;QAC5B,iBAAiB,CAAC,OAAO;KAC1B,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,iBAAiB;QACpB,SAAS,EAAE,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;KACxE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAMa,EACiB,EAAE;IAChC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,GAAG,GAAG,gBAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,cAAc,CAAC;QACpC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;QAClD,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;QACtD,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;KACpC,CAAC,CAAC;IAEH,OAAO;QACL,GAAG;QACH,SAAS,EAAE,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;QACtE,KAAK;QACL,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,IAA0B,EACK,EAAE,CAAC,CAAC;IACnC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;IACvC,aAAa,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC;IACpD,aAAa,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC;IACpD,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,eAAe,EAAE,gBAAgB,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACzD,cAAc,EAAE,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACvD,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,IAAI,EAAE;IACzD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;IAClC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,OAAkC,EACR,EAAE,CAAC,CAAC;IAC9B,QAAQ,EAAE;QACR,iBAAiB,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC/D,oBAAoB,EAAE,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,CAAC;QACzE,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC;KACtD;IACD,WAAW,EAAE,gBAAgB,CAAC,OAAO,CAAC,YAAY,CAAC;IACnD,aAAa,EAAE,gBAAgB,CAAC,OAAO,CAAC,cAAc,CAAC;IACvD,aAAa,EAAE,gBAAgB,CAAC,OAAO,CAAC,cAAc,CAAC;IACvD,mBAAmB,EAAE,gBAAgB,CAAC,OAAO,CAAC,qBAAqB,CAAC;IACpE,qBAAqB,EAAE;QACrB,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC,sBAAsB,EAAE,QAAQ,CAAC;QACrE,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,sBAAsB,EAAE,eAAe,CAAC;QAC/E,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,sBAAsB,EAAE,OAAO,CAAC;KACpE;IACD,eAAe,EAAE,gBAAgB,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAC5D,cAAc,EAAE,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC1D,UAAU,EAAE,iBAAiB,CAAC,OAAO,CAAC,WAAW,CAAC;IAClD,oBAAoB,EAAE,iBAAiB,CAAC,OAAO,CAAC,sBAAsB,CAAC;IACvE,YAAY,EAAE,gBAAgB,CAAC,OAAO,CAAC,YAAY,CAAC;IACpD,oBAAoB,EAClB,OAAO,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC5D,QAAQ,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC;QACzD,aAAa,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,cAAc,CAAC;QACnE,IAAI,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,IAAI,CAAC;KACjD,CAAC,CAAC,IAAI,EAAE;IACX,uBAAuB,EAAE,gBAAgB,CAAC,OAAO,CAAC,yBAAyB,CAAC;IAC5E,QAAQ,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE;IACjC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1C,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAoB,EAAqB,EAAE,CAAC,CAAC;IAC5E,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;IACvC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,kBAAkB,EAAE,gBAAgB,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAC/D,WAAW,EAAE,oBAAoB,CAAC,IAAI,CAAC,aAAa,CAAC;IACrD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7C,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC;IAClD,sBAAsB,EAAE,gBAAgB,CAAC,IAAI,CAAC,wBAAwB,CAAC;IACvE,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,gBAAgB,EAAE,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC;CAC1D,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAC3B,mBAAkC,EAClC,YAAqB,EACN,EAAE;IACjB,IAAI,CAAC,YAAY,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,mBAAmB,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5F,OAAO,mBAAmB,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC7C,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,GAAG,mBAAmB,UAAU,CAAC;IACvC,CAAC;IAED,MAAM,cAAc,GAAG,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC;QACxD,CAAC,CAAC,mBAAmB;QACrB,CAAC,CAAC,IAAI,mBAAmB,EAAE,CAAC;IAC9B,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC;QACrD,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,GAAG,cAAc,UAAU,CAAC;IAEhC,OAAO,IAAI,GAAG,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,IAA0B,EAC1B,OAEC,EACiB,EAAE;IACpB,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAE5E,OAAO;QACL,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;QACzC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/C,kBAAkB,EAAE,oBAAoB,CACtC,mBAAmB,EACnB,OAAO,EAAE,YAAY,IAAI,KAAK,CAC/B;QACD,mBAAmB;QACnB,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;QACnC,UAAU,EAAE,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/C,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;QAC/C,aAAa,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC;QACpD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;KAClC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAgB,EAAiB,EAAE,CAAC,CAAC;IAChE,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;IACvC,MAAM,EAAE,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;IAC1C,kBAAkB,EAAE,gBAAgB,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAC/D,WAAW,EAAE,oBAAoB,CAAC,IAAI,CAAC,aAAa,CAAC;IACrD,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,cAAc,EAAE,IAAI,CAAC,cAAc;QACjC,CAAC,CAAC;YACE,iBAAiB,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC;YAC3E,cAAc,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC;YACrE,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;YAC3D,eAAe,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC;YACvE,kBAAkB,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC;SAC9E;QACH,CAAC,CAAC,IAAI;IACR,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC;IACnD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,gBAAgB,EAAE,IAAI,CAAC,kBAAkB,IAAI,EAAE;IAC/C,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,sBAAsB,EAAE,gBAAgB,CAAC,IAAI,CAAC,wBAAwB,CAAC;CACxE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAA4B,EAAiB,EAAE;IAC9E,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpD,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,IAA+B,EACD,EAAE,CAAC,CAAC;IAClC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC;IAC9D,aAAa,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC;IAClE,aAAa,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC;IAClE,kBAAkB,EAAE,gBAAgB,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAC/D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;IACjC,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7C,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,sBAAsB,EAAE,gBAAgB,CAAC,IAAI,CAAC,wBAAwB,IAAI,IAAI,CAAC,OAAO,CAAC;IACvF,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,gBAAgB,EAAE,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,IAA0B,EAC1B,YAA4C,EACd,EAAE,CAAC,CAAC;IAClC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;IACvC,gBAAgB,EAAE,gBAAgB,CAAC,IAAI,CAAC,iBAAiB,CAAC;IAC1D,YAAY;IACZ,WAAW,EAAE,oBAAoB,CAAC,IAAI,CAAC,aAAa,CAAC;IACrD,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/C,sBAAsB,EAAE,IAAI,CAAC,uBAAuB,IAAI,EAAE;IAC1D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;IAClC,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC;CAC9C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAoB,EAAE,CAAC,CAAC;IACzE,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,gBAAgB,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACvE,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,YAAY,EAAE,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC;IAClD,cAAc,EAAE,gBAAgB,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC;IAClE,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;IAC5C,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,2BAA2B,EAAE,iBAAiB,CAAC,IAAI,CAAC,+BAA+B,CAAC;IACpF,eAAe,EACb,IAAI,CAAC,gBAAgB;QACnB,EAAE,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;SAC/D,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;IAC1D,UAAU,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9C,WAAW,EAAE,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;IAChD,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,+BAA+B,GAAG,CACtC,YAAuC,EACY,EAAE,CAAC,CAAC;IACvD,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,OAAO,CAAC;IAC/C,WAAW,EAAE,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC;IACxD,aAAa,EAAE,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAC9D,IAAI,EAAE,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC;IACzC,IAAI,EAAE,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC;CAC1C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,cAAiC,EACP,EAAE,CAAC,CAAC;IAC9B,SAAS,EACP,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACvC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;QACrC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;KACtC,CAAC,CAAC,IAAI,EAAE;IACX,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,EAAE;IACjC,MAAM,EAAE,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC;IAC/C,aAAa,EACX,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,+BAA+B,CAAC,IAAI,EAAE;IAC1E,IAAI,EAAE,gBAAgB,CAAC,cAAc,CAAC,IAAI,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,UAA+C,EACnB,EAAE,CAAC,UAAU,EAAE,KAAK,EAAE,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC"}

package/dist/lib/pagination.d.ts

@@ -0,0 +1,15 @@
+import type { ApiListResponse } from "../types/api.js";
+import type { ListCommandOptions, PaginationMeta } from "../types/cli.js";
+export interface FetchPaginatedItemsOptions<TItem, TResponse extends ApiListResponse<TItem>> {
+    fetchPage: (page: {
+        itemsPerPage: number;
+        startIndex: number;
+    }) => Promise<TResponse>;
+    options: ListCommandOptions;
+}
+export interface FetchPaginatedItemsResult<TItem> {
+    items: TItem[];
+    pagination: PaginationMeta;
+}
+export declare const fetchPaginatedItems: <TItem, TResponse extends ApiListResponse<TItem>>({ fetchPage, options }: FetchPaginatedItemsOptions<TItem, TResponse>) => Promise<FetchPaginatedItemsResult<TItem>>;
+//# sourceMappingURL=pagination.d.ts.map

package/dist/lib/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/lib/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAK1E,MAAM,WAAW,0BAA0B,CAAC,KAAK,EAAE,SAAS,SAAS,eAAe,CAAC,KAAK,CAAC;IACzF,SAAS,EAAE,CAAC,IAAI,EAAE;QAChB,YAAY,EAAE,MAAM,CAAC;QACrB,UAAU,EAAE,MAAM,CAAC;KACpB,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACzB,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB,CAAC,KAAK;IAC9C,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,UAAU,EAAE,cAAc,CAAC;CAC5B;AAcD,eAAO,MAAM,mBAAmB,GAAU,KAAK,EAAE,SAAS,SAAS,eAAe,CAAC,KAAK,CAAC,EAAE,wBAGxF,0BAA0B,CAAC,KAAK,EAAE,SAAS,CAAC,KAAG,OAAO,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAkEzF,CAAC"}

package/dist/lib/pagination.js

@@ -0,0 +1,64 @@
+const DEFAULT_PAGE_SIZE = 10;
+const DEFAULT_ALL_PAGE_SIZE = 100;
+const getTotalResults = (response) => response.total_results ?? response.total_count ?? null;
+const getStartIndex = (response) => response.start_index ?? 0;
+const getItemsPerPage = (response, fallbackItemsPerPage, pageItemCount) => response.items_per_page ?? fallbackItemsPerPage ?? pageItemCount;
+export const fetchPaginatedItems = async ({ fetchPage, options }) => {
+    const all = options.all ?? false;
+    const startIndex = options.startIndex ?? 0;
+    const requestedItemsPerPage = options.itemsPerPage;
+    const effectiveItemsPerPage = all
+        ? requestedItemsPerPage ?? DEFAULT_ALL_PAGE_SIZE
+        : requestedItemsPerPage ?? DEFAULT_PAGE_SIZE;
+    const firstPage = await fetchPage({
+        itemsPerPage: effectiveItemsPerPage,
+        startIndex
+    });
+    const firstItems = firstPage.items ?? [];
+    if (!all) {
+        return {
+            items: firstItems,
+            pagination: {
+                fetchedAll: false,
+                itemsPerPage: effectiveItemsPerPage,
+                returnedCount: firstItems.length,
+                startIndex,
+                totalResults: getTotalResults(firstPage)
+            }
+        };
+    }
+    const collectedItems = [...firstItems];
+    let totalResults = getTotalResults(firstPage);
+    let currentStartIndex = getStartIndex(firstPage) +
+        getItemsPerPage(firstPage, effectiveItemsPerPage, firstItems.length);
+    let lastPageItemCount = firstItems.length;
+    while (lastPageItemCount > 0) {
+        if (totalResults !== null && collectedItems.length >= totalResults) {
+            break;
+        }
+        const page = await fetchPage({
+            itemsPerPage: effectiveItemsPerPage,
+            startIndex: currentStartIndex
+        });
+        const pageItems = page.items ?? [];
+        if (pageItems.length === 0) {
+            break;
+        }
+        collectedItems.push(...pageItems);
+        totalResults = totalResults ?? getTotalResults(page);
+        lastPageItemCount = pageItems.length;
+        currentStartIndex =
+            getStartIndex(page) + getItemsPerPage(page, effectiveItemsPerPage, pageItems.length);
+    }
+    return {
+        items: collectedItems,
+        pagination: {
+            fetchedAll: true,
+            itemsPerPage: effectiveItemsPerPage,
+            returnedCount: collectedItems.length,
+            startIndex,
+            totalResults
+        }
+    };
+};
+//# sourceMappingURL=pagination.js.map

package/dist/lib/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/lib/pagination.ts"],"names":[],"mappings":"AAGA,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAelC,MAAM,eAAe,GAAG,CAAQ,QAAgC,EAAiB,EAAE,CACjF,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC;AAEzD,MAAM,aAAa,GAAG,CAAQ,QAAgC,EAAU,EAAE,CACxE,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC;AAE5B,MAAM,eAAe,GAAG,CACtB,QAAgC,EAChC,oBAA4B,EAC5B,aAAqB,EACb,EAAE,CAAC,QAAQ,CAAC,cAAc,IAAI,oBAAoB,IAAI,aAAa,CAAC;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAmD,EACzF,SAAS,EACT,OAAO,EACsC,EAA6C,EAAE;IAC5F,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,KAAK,CAAC;IACjC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;IAC3C,MAAM,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IACnD,MAAM,qBAAqB,GAAG,GAAG;QAC/B,CAAC,CAAC,qBAAqB,IAAI,qBAAqB;QAChD,CAAC,CAAC,qBAAqB,IAAI,iBAAiB,CAAC;IAE/C,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC;QAChC,YAAY,EAAE,qBAAqB;QACnC,UAAU;KACX,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;IAEzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO;YACL,KAAK,EAAE,UAAU;YACjB,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,YAAY,EAAE,qBAAqB;gBACnC,aAAa,EAAE,UAAU,CAAC,MAAM;gBAChC,UAAU;gBACV,YAAY,EAAE,eAAe,CAAC,SAAS,CAAC;aACzC;SACF,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;IACvC,IAAI,YAAY,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAC9C,IAAI,iBAAiB,GACnB,aAAa,CAAC,SAAS,CAAC;QACxB,eAAe,CAAC,SAAS,EAAE,qBAAqB,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACvE,IAAI,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAC;IAE1C,OAAO,iBAAiB,GAAG,CAAC,EAAE,CAAC;QAC7B,IAAI,YAAY,KAAK,IAAI,IAAI,cAAc,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;YACnE,MAAM;QACR,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC;YAC3B,YAAY,EAAE,qBAAqB;YACnC,UAAU,EAAE,iBAAiB;SAC9B,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAEnC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM;QACR,CAAC;QAED,cAAc,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;QAClC,YAAY,GAAG,YAAY,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACrD,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC;QACrC,iBAAiB;YACf,aAAa,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,qBAAqB,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IACzF,CAAC;IAED,OAAO;QACL,KAAK,EAAE,cAAc;QACrB,UAAU,EAAE;YACV,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,qBAAqB;YACnC,aAAa,EAAE,cAAc,CAAC,MAAM;YACpC,UAAU;YACV,YAAY;SACb;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/types/api.d.ts

@@ -0,0 +1,282 @@
+export interface AddressApi {
+    care_of?: string;
+    country?: string;
+    locality?: string;
+    po_box?: string;
+    postal_code?: string;
+    premises?: string;
+    region?: string;
+    address_line_1?: string;
+    address_line_2?: string;
+}
+export interface DateOfBirthApi {
+    day?: number;
+    month?: number;
+    year?: number;
+}
+export interface LinksApi {
+    self?: string;
+    [key: string]: unknown;
+}
+export interface ApiListResponse<TItem> {
+    items?: TItem[];
+    items_per_page?: number;
+    start_index?: number;
+    total_count?: number;
+    total_results?: number;
+}
+export interface CompanySearchMatchApi {
+    address_snippet?: number[];
+    snippet?: number[];
+    title?: number[];
+}
+export interface CompanySearchApiItem {
+    address?: AddressApi;
+    company_number?: string;
+    company_status?: string;
+    company_type?: string;
+    date_of_cessation?: string;
+    date_of_creation?: string;
+    description?: string;
+    description_identifier?: string[];
+    kind?: string;
+    matches?: CompanySearchMatchApi;
+    snippet?: string;
+    title?: string;
+}
+export interface CompanySearchApiResponse extends ApiListResponse<CompanySearchApiItem> {
+    kind?: string;
+}
+export interface CompanyProfileApiResponse {
+    accounts?: {
+        account_period_from?: string;
+        account_period_to?: string;
+        next_accounts?: {
+            due_on?: string;
+            overdue?: boolean;
+            period_end_on?: string;
+            period_start_on?: string;
+        };
+        next_due?: string;
+        next_made_up_to?: string;
+        overdue?: boolean;
+    };
+    company_name?: string;
+    company_number?: string;
+    company_status?: string;
+    company_status_detail?: string;
+    confirmation_statement?: {
+        next_due?: string;
+        next_made_up_to?: string;
+        overdue?: boolean;
+    };
+    date_of_cessation?: string;
+    date_of_creation?: string;
+    external_registration_number?: string;
+    foreign_company_details?: {
+        accounting_requirement?: {
+            foreign_account_type?: string;
+            terms_of_account_publication?: string;
+        };
+        business_activity?: string;
+        company_type?: string;
+        governed_by?: string;
+        is_a_credit_finance_institution?: boolean;
+        origin_country?: string;
+        place_registered?: string;
+        registration_number?: string;
+    };
+    has_charges?: boolean;
+    has_insolvency_history?: boolean;
+    jurisdiction?: string;
+    links?: LinksApi;
+    partial_data_available?: string;
+    previous_company_names?: Array<{
+        ceased_on?: string;
+        effective_from?: string;
+        name?: string;
+    }>;
+    registered_office_address?: AddressApi;
+    sic_codes?: string[];
+    subtype?: string;
+    type?: string;
+}
+export interface OfficerApiItem {
+    address?: AddressApi;
+    appointed_before?: string;
+    appointed_on?: string;
+    contact_details?: {
+        contact_name?: string;
+    };
+    country_of_residence?: string;
+    date_of_birth?: DateOfBirthApi;
+    former_names?: Array<{
+        forenames?: string;
+        surname?: string;
+    }>;
+    links?: LinksApi;
+    name?: string;
+    nationality?: string;
+    occupation?: string;
+    officer_role?: string;
+    person_number?: string;
+    principal_office_address?: AddressApi;
+    resigned_on?: string;
+    responsibilities?: string;
+}
+export interface OfficerListApiResponse extends ApiListResponse<OfficerApiItem> {
+    active_count?: number;
+    etag?: string;
+    kind?: string;
+    links?: LinksApi;
+    resigned_count?: number;
+}
+export interface FilingHistoryApiItem {
+    category?: string;
+    date?: string;
+    description?: string;
+    links?: {
+        document_metadata?: string;
+        self?: string;
+        [key: string]: unknown;
+    };
+    pages?: number;
+    paper_filed?: boolean;
+    subcategory?: string;
+    transaction_id?: string;
+    type?: string;
+}
+export interface FilingHistoryApiResponse extends ApiListResponse<FilingHistoryApiItem> {
+    filing_history_status?: string;
+    kind?: string;
+    total_count?: number;
+}
+export interface PscApiItem {
+    address?: AddressApi;
+    ceased?: boolean;
+    ceased_on?: string;
+    country_of_residence?: string;
+    date_of_birth?: DateOfBirthApi;
+    description?: string;
+    etag?: string;
+    identification?: {
+        country_registered?: string;
+        legal_authority?: string;
+        legal_form?: string;
+        place_registered?: string;
+        registration_number?: string;
+    };
+    is_sanctioned?: boolean;
+    kind?: string;
+    links?: LinksApi;
+    name?: string;
+    nationality?: string;
+    natures_of_control?: string[];
+    notified_on?: string;
+    principal_office_address?: AddressApi;
+}
+export interface PscListApiResponse extends ApiListResponse<PscApiItem> {
+    active_count?: number;
+    ceased_count?: number;
+    links?: LinksApi;
+    total_results?: number;
+}
+export interface OfficerSearchApiItem {
+    address?: AddressApi;
+    address_snippet?: string;
+    appointment_count?: number;
+    date_of_birth?: DateOfBirthApi;
+    description?: string;
+    description_identifiers?: string[];
+    kind?: string;
+    links?: LinksApi;
+    matches?: CompanySearchMatchApi;
+    snippet?: string;
+    title?: string;
+}
+export interface OfficerSearchApiResponse extends ApiListResponse<OfficerSearchApiItem> {
+    kind?: string;
+}
+export interface OfficerAppointmentApiItem {
+    address?: AddressApi;
+    appointed_on?: string;
+    appointed_to?: {
+        company_name?: string;
+        company_number?: string;
+        company_status?: string;
+    };
+    country_of_residence?: string;
+    links?: LinksApi;
+    name?: string;
+    nationality?: string;
+    occupation?: string;
+    officer_role?: string;
+    principal_office_address?: AddressApi;
+    resigned_on?: string;
+    responsibilities?: string;
+}
+export interface OfficerAppointmentListApiResponse extends ApiListResponse<OfficerAppointmentApiItem> {
+    date_of_birth?: DateOfBirthApi;
+    is_corporate_officer?: boolean;
+    links?: LinksApi;
+    name?: string;
+    total_results?: number;
+}
+export interface ChargePersonEntitledApi {
+    name?: string;
+}
+export interface ChargeParticularsApi {
+    brief_description?: string;
+    contains_fixed_charge?: boolean;
+    contains_floating_charge?: boolean;
+    floating_charge_covers_all?: boolean;
+    type?: string;
+}
+export interface ChargeApiItem {
+    acquired_on?: string;
+    charge_code?: string;
+    charge_number?: number;
+    classification?: {
+        description?: string;
+        type?: string;
+    };
+    created_on?: string;
+    delivered_on?: string;
+    id?: string;
+    more_than_four_persons_entitled?: boolean;
+    particulars?: ChargeParticularsApi;
+    persons_entitled?: ChargePersonEntitledApi[];
+    resolved_on?: string;
+    satisfied_on?: string;
+    status?: string;
+}
+export interface ChargeListApiResponse extends ApiListResponse<ChargeApiItem> {
+    part_satisfied_count?: number;
+    satisfied_count?: number;
+    total_count?: number;
+    unfiletered_count?: number;
+}
+export interface InsolvencyCaseDateApi {
+    date?: string;
+    type?: string;
+}
+export interface InsolvencyPractitionerApi {
+    address?: AddressApi;
+    appointed_on?: string;
+    ceased_to_act_on?: string;
+    name?: string;
+    role?: string;
+}
+export interface InsolvencyCaseApi {
+    dates?: InsolvencyCaseDateApi[];
+    notes?: string[];
+    number?: string;
+    practitioners?: InsolvencyPractitionerApi[];
+    type?: string;
+}
+export interface CompanyInsolvencyApiResponse {
+    cases?: InsolvencyCaseApi[];
+    etag?: string;
+    status?: string;
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/types/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/types/api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,eAAe,CAAC,KAAK;IACpC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACrF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE;QACT,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,aAAa,CAAC,EAAE;YACd,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,OAAO,CAAC,EAAE,OAAO,CAAC;YAClB,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC;QACF,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sBAAsB,CAAC,EAAE;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,uBAAuB,CAAC,EAAE;QACxB,sBAAsB,CAAC,EAAE;YACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAC9B,4BAA4B,CAAC,EAAE,MAAM,CAAC;SACvC,CAAC;QACF,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,+BAA+B,CAAC,EAAE,OAAO,CAAC;QAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,sBAAsB,CAAC,EAAE,KAAK,CAAC;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;IACH,yBAAyB,CAAC,EAAE,UAAU,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,YAAY,CAAC,EAAE,KAAK,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wBAAwB,CAAC,EAAE,UAAU,CAAC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAuB,SAAQ,eAAe,CAAC,cAAc,CAAC;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE;QACN,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACrF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE;QACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wBAAwB,CAAC,EAAE,UAAU,CAAC;CACvC;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe,CAAC,UAAU,CAAC;IACrE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACrF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE;QACb,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;IACF,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wBAAwB,CAAC,EAAE,UAAU,CAAC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,iCACf,SAAQ,eAAe,CAAC,yBAAyB,CAAC;IAClD,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe,CAAC,aAAa,CAAC;IAC3E,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.js.map

package/dist/types/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/types/api.ts"],"names":[],"mappings":""}