refactor: simplify types and descriptions

pawel-id · Jan 6, 2024 · 6a37e76 · 6a37e76
1 parent f12aab4
commit 6a37e76
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 14 deletions.
diff --git a/src/bir.ts b/src/bir.ts
@@ -88,9 +88,8 @@ export default class Bir {
   }
 
   /**
-   * Parse provided `result` xml string into native object. Skip some top level
-   * unnecessary properties and check for errors. Return javascript object
-   * reflecting provided xml.
+   * Parse provided `result` xml string into native javascript object. Check for
+   * errors and throws when neede. Return plain object reflecting provided xml.
    * @param result xml string
    * @returns parsed object
    */

diff --git a/src/types.ts b/src/types.ts
@@ -22,7 +22,10 @@ export const KomunikatKodErrorCodes = {
   '7': 'Brak sesji. Sesja wygasła lub przekazano nieprawidłową wartość nagłówka sid.',
 }
 
-export type DanePobierzPelnyRaportBir1Options =
+/**
+ * Reports for method `DanePobierzPelnyRaport`.
+ */
+export type DanePobierzPelnyRaportOptions =
   | 'PublDaneRaportFizycznaOsoba'
   | 'PublDaneRaportDzialalnoscFizycznejCeidg'
   | 'PublDaneRaportDzialalnoscFizycznejRolnicza'
@@ -39,8 +42,6 @@ export type DanePobierzPelnyRaportBir1Options =
   | 'PublDaneRaportDzialalnosciLokalnejPrawnej'
   | 'PublDaneRaportWspolnicyPrawnej'
   | 'PublDaneRaportTypJednostki'
-
-export type DanePobierzPelnyRaportBir11Options =
   | 'BIR11OsFizycznaDaneOgolne'
   | 'BIR11OsFizycznaDzialalnoscCeidg'
   | 'BIR11OsFizycznaDzialalnoscRolnicza'
@@ -58,14 +59,6 @@ export type DanePobierzPelnyRaportBir11Options =
   | 'BIR11OsPrawnaSpCywilnaWspolnicy'
   | 'BIR11TypPodmiotu'
 
-/**
- * Reports for method `DanePobierzPelnyRaport`.
- *
- */
-export type DanePobierzPelnyRaportOptions =
-  | DanePobierzPelnyRaportBir1Options
-  | DanePobierzPelnyRaportBir11Options
-
 /**
  * Reports for method `DanePobierzRaportZbiorczy`.
  */