@acteo/api 0.4.0 → 0.5.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/dist/index.js CHANGED
@@ -148,6 +148,27 @@ var EroareWebhook = class extends VerificRcaError {
148
148
  var TipVerificare = Schema.Literal("rca", "itp", "rovinieta", "arr");
149
149
  var StatusDocument = Schema.Literal("valid", "warning", "expired", "not_found");
150
150
  var DataNullabila = Schema.NullOr(Schema.Date);
151
+ var CODURI_EROARE = [
152
+ "UPSTREAM_UNAVAILABLE",
153
+ "UPSTREAM_TIMEOUT",
154
+ "UPSTREAM_BLOCKED",
155
+ "UPSTREAM_CHANGED",
156
+ "DAILY_LIMIT_REACHED",
157
+ "PLAN_LIMIT_REACHED",
158
+ "NOT_FOUND",
159
+ "INVALID_IDENTIFIER",
160
+ "SOLD_INSUFICIENT",
161
+ "PLAFON_NETAXAT",
162
+ "OCUPAT",
163
+ "INDISPONIBIL",
164
+ "VIN_NEDECODAT",
165
+ "VIN_INVALID",
166
+ "ARR_NECESITA_PLAN",
167
+ "LIMIT_ATINS",
168
+ "VEHICUL_EXISTENT",
169
+ "NEGASIT",
170
+ "LIMITA_FLOTA_ATINSA"
171
+ ];
151
172
  var RezultatVerificareSchema = Schema.Struct({
152
173
  /** Tipul verificarii. */
153
174
  tip: TipVerificare,
@@ -157,12 +178,14 @@ var RezultatVerificareSchema = Schema.Struct({
157
178
  numarInmatriculare: Schema.NullOr(Schema.String),
158
179
  /** Seria de sasiu (VIN) verificata, `null` cand cautarea s-a facut doar dupa numar. */
159
180
  serieSasiu: Schema.NullOr(Schema.String),
160
- /** Cand a fost interogata sursa oficiala. */
181
+ /** Momentul verificarii. */
161
182
  checkedAt: Schema.Date,
162
183
  /** Starea documentului. Vezi {@link StatusDocument}. */
163
184
  status: StatusDocument,
164
185
  /** Data expirarii documentului, `null` daca nu exista document valabil. */
165
186
  expiresAt: DataNullabila,
187
+ /** Doar la `status: "not_found"`: `"NOT_FOUND"`, identificatorul nu exista la sursa oficiala. */
188
+ code: Schema.optional(Schema.String),
166
189
  /** ID-ul cererii, prezent doar cand ai trimis `callbackUrl`. Apare si in webhook. */
167
190
  requestId: Schema.optional(Schema.String),
168
191
  /** Recomandarea API-ului, ex: la RCA cerut doar dupa numar, sa trimiti si VIN-ul. */
@@ -181,8 +204,10 @@ var EsuataSchema = Schema.Struct({
181
204
  tip: TipVerificare,
182
205
  query: Schema.String,
183
206
  status: Schema.Literal("error"),
207
+ /** Motivul. Vezi {@link CodEsecVerificare}. Lipseste doar la serverele mai vechi. */
208
+ code: Schema.optional(Schema.String),
184
209
  error: Schema.String,
185
- /** Doar cand sursa a refuzat datele trimise. Vezi {@link CodRefuzSursa}. */
210
+ /** Doar la `INVALID_IDENTIFIER`: campul refuzat. Vezi {@link CodRefuzSursa}. */
186
211
  cod: Schema.optional(Schema.String),
187
212
  hint: Schema.optional(Schema.String)
188
213
  });
@@ -238,10 +263,12 @@ var WebhookRezultatSchema = Schema.Struct({
238
263
  status: Schema.Union(StatusDocument, Schema.Literal("error")),
239
264
  /** Rezultatul complet, `null` la `status: "error"`. */
240
265
  result: Schema.NullOr(RezultatVerificareSchema),
241
- /** Cand a fost interogata sursa, `null` la eroare. */
266
+ /** Momentul verificarii, `null` la eroare. */
242
267
  checkedAt: DataNullabila,
243
268
  /** Mesajul de eroare, doar la `status: "error"`. */
244
- error: Schema.optional(Schema.String)
269
+ error: Schema.optional(Schema.String),
270
+ /** La `status: "error"`, motivul ({@link CodEsecVerificare}); la `status: "not_found"`, `"NOT_FOUND"`. */
271
+ code: Schema.optional(Schema.String)
245
272
  });
246
273
  var WebhookDocumentExpiraSchema = Schema.Struct({
247
274
  /** Numele evenimentului. */
@@ -632,7 +659,7 @@ function eroareDinRaspuns(status, headers, body) {
632
659
  switch (status) {
633
660
  case 400:
634
661
  return new EroareValidare({ ...comun, ...c?.accepted && { acceptate: c.accepted } });
635
- // 422: sursa oficiala refuza valoarea trimisa (ex: NUMAR_RESPINS).
662
+ // 422: sursa oficiala refuza valoarea trimisa (INVALID_IDENTIFIER).
636
663
  case 422:
637
664
  return new EroareValidare(comun);
638
665
  case 401:
@@ -1010,7 +1037,7 @@ var interpreteaza = (raspuns, serieSasiu, sinceImplicit) => decodeaza(RaspunsVer
1010
1037
  return Effect.fail(
1011
1038
  new EroareVerificare({
1012
1039
  message: corp.error,
1013
- cod: "VERIFICARE_ESUATA",
1040
+ cod: corp.code ?? "VERIFICARE_ESUATA",
1014
1041
  raspuns: corp,
1015
1042
  ...corp.cod && { codSursa: corp.cod },
1016
1043
  ...corp.hint && { hint: corp.hint }
@@ -1107,7 +1134,7 @@ var sterge = (id) => id.trim() ? trimite({ metoda: "DELETE", cale: `${CALE2}/${e
1107
1134
  ) : Effect.fail(new EroareValidare({ message: "Lipseste ID-ul vehiculului.", camp: "id", cod: "VALIDARE_LOCALA" }));
1108
1135
 
1109
1136
  // src/client.ts
1110
- var VERSIUNE_SDK = "0.4.0";
1137
+ var VERSIUNE_SDK = "0.5.0";
1111
1138
  var URL_IMPLICIT = "https://api.acteo.ro";
1112
1139
  var URL_IMPLICIT_LEGACY = "https://www.verificrca.ro";
1113
1140
  var RETRY_IMPLICIT = { incercari: 3, intarziereInitialaMs: 500, intarziereMaximaMs: 1e4 };
@@ -1182,9 +1209,8 @@ var ClientVerificari = class {
1182
1209
  /**
1183
1210
  * Porneste o verificare si consuma o unitate din cota planului.
1184
1211
  *
1185
- * Daca vehiculul a fost verificat de curand, primesti imediat rezultatul
1186
- * existent. Altfel verificarea intra in
1187
- * coada si primesti `status: "processing"`; rezultatul il afli cu
1212
+ * Fiecare cerere interogheaza sursa oficiala: verificarea intra in coada si
1213
+ * primesti `status: "processing"`; rezultatul il afli cu
1188
1214
  * {@link ClientVerificari.rezultat}, {@link ClientVerificari.asteapta} sau
1189
1215
  * prin webhook, daca ai trimis `callbackUrl`.
1190
1216
  *
@@ -1198,7 +1224,7 @@ var ClientVerificari = class {
1198
1224
  * @throws {@link EroareValidare} date invalide, local sau HTTP 400.
1199
1225
  * @throws {@link EroareAutentificare} cheie API invalida (401).
1200
1226
  * @throws {@link EroarePlanInactiv} contul nu are abonament API activ (402).
1201
- * @throws {@link EroareLimita} cota zilnica sau lunara atinsa (429, `cod: "COTA_ATINSA"`).
1227
+ * @throws {@link EroareLimita} cota zilnica sau lunara atinsa (429, `cod: "DAILY_LIMIT_REACHED"` sau `"PLAN_LIMIT_REACHED"`).
1202
1228
  * @throws {@link EroareVerificare} sursa oficiala nu a putut fi interogata sau a
1203
1229
  * refuzat datele trimise (`codSursa`, ex: `"serie_talon_invalida"`).
1204
1230
  * @throws {@link EroareRetea} fara raspuns sau timeout.
@@ -1257,7 +1283,7 @@ var ClientVerificari = class {
1257
1283
  * @param optiuni `intervalMs`, `timeoutMs` si `signal`, ca la {@link ClientVerificari.asteapta}.
1258
1284
  * @returns rezultatul final al verificarii.
1259
1285
  * @throws {@link EroareValidare} date invalide, local sau HTTP 400.
1260
- * @throws {@link EroareLimita} cota atinsa (`cod: "COTA_ATINSA"`).
1286
+ * @throws {@link EroareLimita} cota atinsa (`cod: "DAILY_LIMIT_REACHED"` sau `"PLAN_LIMIT_REACHED"`).
1261
1287
  * @throws {@link EroareTimeoutVerificare} rezultatul nu a venit in `timeoutMs`.
1262
1288
  * @throws {@link EroareVerificare} sursa oficiala nu a putut fi interogata sau a
1263
1289
  * refuzat datele trimise (`codSursa`, ex: `"serie_talon_invalida"`).
@@ -1495,14 +1521,14 @@ var ClientDocument = class {
1495
1521
  }
1496
1522
  /**
1497
1523
  * Verifica documentul si asteapta rezultatul final de la sursa oficiala.
1498
- * Daca vehiculul a fost verificat de curand, rezultatul vine imediat.
1499
1524
  *
1500
1525
  * @param identificator ce cere sursa oficiala pentru acest document.
1501
1526
  * @param optiuni `timeoutMs`, `intervalMs` pentru asteptare si `signal`.
1502
1527
  * @returns rezultatul final.
1503
1528
  * @throws {@link EroareValidare} identificator invalid, local sau HTTP 400.
1504
- * @throws {@link EroareLimita} cota zilnica sau lunara atinsa.
1505
- * @throws {@link EroareVerificare} sursa oficiala nu a putut fi interogata sau a refuzat datele.
1529
+ * @throws {@link EroareLimita} cota atinsa (`DAILY_LIMIT_REACHED`, `PLAN_LIMIT_REACHED`).
1530
+ * @throws {@link EroareServer} sursa oficiala oprita temporar (`UPSTREAM_BLOCKED`, `UPSTREAM_CHANGED`); netaxat.
1531
+ * @throws {@link EroareVerificare} sursa oficiala nu a dat un raspuns sau a refuzat datele; motivul e in `cod`.
1506
1532
  * @throws {@link EroareTimeoutVerificare} rezultatul nu a venit in `timeoutMs`.
1507
1533
  */
1508
1534
  verifica(identificator, optiuni) {
@@ -1512,14 +1538,15 @@ var ClientDocument = class {
1512
1538
  );
1513
1539
  }
1514
1540
  /**
1515
- * Porneste verificarea fara sa astepte. Primesti rezultatul imediat, daca
1516
- * vehiculul a fost verificat de curand, sau `status: "processing"`; atunci
1541
+ * Porneste verificarea fara sa astepte. Primesti `status: "processing"`;
1517
1542
  * afli raspunsul cu {@link ClientDocument.asteapta}, {@link ClientDocument.rezultat}
1518
1543
  * sau prin webhook la `callbackUrl`.
1519
1544
  *
1520
1545
  * @param identificator ce cere sursa oficiala pentru acest document.
1521
1546
  * @param optiuni `callbackUrl` si `signal`.
1522
1547
  * @returns rezultatul final sau verificarea in curs.
1548
+ * @throws {@link EroareLimita} cota atinsa (`DAILY_LIMIT_REACHED`, `PLAN_LIMIT_REACHED`).
1549
+ * @throws {@link EroareServer} sursa oficiala oprita temporar (`UPSTREAM_BLOCKED`, `UPSTREAM_CHANGED`); netaxat.
1523
1550
  */
1524
1551
  porneste(identificator, optiuni) {
1525
1552
  const cerere = {
@@ -1599,7 +1626,7 @@ var ClientVin = class {
1599
1626
  * @returns decodarea, completa, partiala sau doar structura.
1600
1627
  * @throws {@link EroareValidare} VIN invalid, local sau HTTP 400.
1601
1628
  * @throws {@link EroarePlanInactiv} lipseste abonamentul de decodare VIN.
1602
- * @throws {@link EroareLimita} cota atinsa (`LIMIT_ATINS`) sau prea multe decodari fara rezultat (`PLAFON_NETAXAT`).
1629
+ * @throws {@link EroareLimita} cota atinsa (`DAILY_LIMIT_REACHED`, `PLAN_LIMIT_REACHED`) sau prea multe decodari fara rezultat (`PLAFON_NETAXAT`).
1603
1630
  * @example
1604
1631
  * const d = await acteo.auto.vin.decodeaza("WVWZZZ1KZBW000000")
1605
1632
  * console.log(d.marca, d.model, d.anFabricatie)
@@ -1623,10 +1650,10 @@ var ClientNumere = class {
1623
1650
  * @param numar numarul complet: judetul, cifrele si trei litere, ex: `BV07ABC`.
1624
1651
  * @param optiuni `signal` pentru anulare.
1625
1652
  * @returns verdictul DGPCI.
1626
- * @throws {@link EroareValidare} numar invalid sau incomplet, ori refuzat de DGPCI (`NUMAR_RESPINS`).
1653
+ * @throws {@link EroareValidare} numar invalid sau incomplet, ori refuzat de DGPCI (`INVALID_IDENTIFIER`).
1627
1654
  * @throws {@link EroarePlanInactiv} lipseste abonamentul de numere disponibile.
1628
1655
  * @throws {@link EroareLimita} cota atinsa.
1629
- * @throws {@link EroareServer} `OCUPAT`, `INDISPONIBIL`, `EROARE_DGPCI` sau `TIMEOUT`; cererea nu s-a taxat.
1656
+ * @throws {@link EroareServer} `UPSTREAM_UNAVAILABLE`, `UPSTREAM_TIMEOUT`, `UPSTREAM_BLOCKED`, `UPSTREAM_CHANGED`, `OCUPAT` sau `INDISPONIBIL`; cererea nu s-a taxat.
1630
1657
  * @example
1631
1658
  * const r = await acteo.auto.numere.verifica("BV07ABC")
1632
1659
  * if (r.disponibil) console.log("Numarul e liber")
@@ -1652,7 +1679,7 @@ var ClientImagini = class {
1652
1679
  * @returns poza masinii sau poza generica.
1653
1680
  * @throws {@link EroareValidare} marca, model, an, unghi sau umbra invalide.
1654
1681
  * @throws {@link EroarePlanInactiv} lipseste abonamentul de imagini masini.
1655
- * @throws {@link EroareLimita} cota atinsa (`LIMIT_ATINS`) sau prea multe poze generice azi (`PLAFON_NETAXAT`).
1682
+ * @throws {@link EroareLimita} cota atinsa (`DAILY_LIMIT_REACHED`, `PLAN_LIMIT_REACHED`) sau prea multe poze generice azi (`PLAFON_NETAXAT`).
1656
1683
  * @example
1657
1684
  * const p = await acteo.auto.imagini.obtine({ marca: "Volkswagen", model: "Golf", an: 2015 })
1658
1685
  * if (p.status === "gata") afiseaza(p.url)
@@ -1747,6 +1774,6 @@ var Acteo = class {
1747
1774
  }
1748
1775
  };
1749
1776
 
1750
- export { Acteo, VerificRcaError as ActeoError, ClientAuto, ClientDocument, ClientImagini, ClientNumere, ClientVehicule, ClientVerificari, ClientVin, ClientWebhooks, EroareAutentificare, EroareConfigurare, EroareConflict, EroareHttp, EroareInterzis, EroareLimita, EroareNegasit, EroarePlanInactiv, EroareRaspunsInvalid, EroareRetea, EroareServer, EroareTimeoutVerificare, EroareValidare, EroareVerificare, EroareWebhook, HEADER_CHEIE_WEBHOOK, HEADER_EVENIMENT_WEBHOOK, TIPURI_VERIFICARE, UNGHIURI_IMAGINE, URL_IMPLICIT, URL_IMPLICIT_LEGACY, VERSIUNE_SDK, VerificRca, VerificRcaError, esteNumarInmatriculareValid, esteSerieTalonValida, esteVinValid, normalizeaza, normalizeazaSerieTalon, parseazaWebhookRezultat, verificaWebhookNotificare };
1777
+ export { Acteo, VerificRcaError as ActeoError, CODURI_EROARE, ClientAuto, ClientDocument, ClientImagini, ClientNumere, ClientVehicule, ClientVerificari, ClientVin, ClientWebhooks, EroareAutentificare, EroareConfigurare, EroareConflict, EroareHttp, EroareInterzis, EroareLimita, EroareNegasit, EroarePlanInactiv, EroareRaspunsInvalid, EroareRetea, EroareServer, EroareTimeoutVerificare, EroareValidare, EroareVerificare, EroareWebhook, HEADER_CHEIE_WEBHOOK, HEADER_EVENIMENT_WEBHOOK, TIPURI_VERIFICARE, UNGHIURI_IMAGINE, URL_IMPLICIT, URL_IMPLICIT_LEGACY, VERSIUNE_SDK, VerificRca, VerificRcaError, esteNumarInmatriculareValid, esteSerieTalonValida, esteVinValid, normalizeaza, normalizeazaSerieTalon, parseazaWebhookRezultat, verificaWebhookNotificare };
1751
1778
  //# sourceMappingURL=index.js.map
1752
1779
  //# sourceMappingURL=index.js.map