cepik-api-client 0.0.3 → 0.0.6

package/README.md

@@ -1,3 +1,101 @@
 # cepik-api-client
 
 A modern TypeScript/JavaScript library for retrieving data from the public API of the Polish National Vehicles Database (CEPIK).
+
+## 📦 Installation
+
+```bash
+npm install cepik-client
+```
+
+```bash
+yarn add cepik-client
+```
+
+```bash
+pnpm add cepik-client
+```
+
+## 🚀 Quick Start
+
+```typescript
+import { CEPIKClient } from "cepik-client";
+
+
+```
+
+### 🛠️ Development
+
+To run the full quality suite locally:
+
+```bash
+npm install
+npm run build       # compile TypeScript to dist/
+npm run lint        # static analysis
+npm run test        # run unit tests
+npm run coverage    # generate coverage report
+```
+
+The package also includes a `prepare` script so that if you install directly
+directly from the Git repository (e.g. `npm install username/nbp-api-client`),
+it will compile automatically.
+
+### 🤝 Contributing
+
+Please open issues for bugs or feature requests and send pull requests with
+clear descriptions. The library follows semantic versioning; bump the
+version in `package.json` and update the changelog when adding features or
+fixes.
+
+## 📝 Types and Enums
+
+### Enums
+
+```typescript
+import {
+} from "nbp-api-client";
+```
+
+### Types
+
+```typescript
+import type {
+} from "nbp-api-client";
+```
+
+## 🧪 Testing
+
+```bash
+npm run test
+```
+
+## 🔍 Linting
+
+```bash
+npm run lint
+```
+
+## 🏗️ Building
+
+```bash
+npm run build
+```
+
+The compiled code is located in the `dist/` directory.
+
+## 📚 Resources
+
+- [Official CEPIK API](https://www.gov.pl/web/cepik/api-dla-centralnej-ewidencji-pojazdow-i-kierowcow-api-do-cepik)
+- [CEPIK API Documentation](https://api.cepik.gov.pl/doc) - Details about endpoints, formats and limitations.
+- [Dictionaries](https://api.cepik.gov.pl/slowniki) - all enums used in the project.
+
+## 📄 License
+
+[MIT © 2026](./LICENSE) [miqel-dll](https://github.com/miqel-dll)
+
+## 🤝 Support
+
+If you encounter a problem or have a suggestion, please open an [issue on GitHub](https://github.com/miqel-dll/nbp-api-client/issues).
+
+Author: [miqel-dll](https://github.com/miqel-dll)
+Version: 0.0.6

package/dist/cepik-address-resolver.d.ts

@@ -0,0 +1,17 @@
+export declare class CepikAddressResolver {
+    private static decode;
+    private static get host();
+    static get vehiclesEndpoint(): string;
+    static getEndpointForVehicle(vehicleId: string): string;
+    static get filesEndpoint(): string;
+    static getEndpointForFile(fileId: string): string;
+    static get drivingLicencesEndpoint(): string;
+    static getEndpointForDrivingLicence(licenceId: string): string;
+    static get permissionsEndpoint(): string;
+    static getEndpointForPermission(permissionId: string): string;
+    static get dictionariesEndpoint(): string;
+    static getEndpointForDictionary(dictionaryId: string): string;
+    static get statisticsEndpoint(): string;
+    static get versionEndpoint(): string;
+    static get v1VersionEndpoint(): string;
+}

package/dist/cepik-address-resolver.js

@@ -0,0 +1,62 @@
+export class CepikAddressResolver {
+    static decode(b64name) {
+        return Buffer.from(b64name, `base64`).toString(`utf-8`);
+    }
+    static get host() {
+        return this.decode(`aHR0cHM6Ly9hcGkuY2VwaWsuZ292LnBsLw==`);
+    }
+    ;
+    static get vehiclesEndpoint() {
+        return `${this.host}/${this.decode(`cG9qYXpkeQ==`)}`;
+    }
+    ;
+    static getEndpointForVehicle(vehicleId) {
+        return `${this.vehiclesEndpoint}/${vehicleId}`;
+    }
+    ;
+    static get filesEndpoint() {
+        return `${this.host}/${this.decode(`cGxpa2k=`)}`;
+    }
+    static getEndpointForFile(fileId) {
+        return `${this.filesEndpoint}/${fileId}`;
+    }
+    ;
+    static get drivingLicencesEndpoint() {
+        return `${this.host}/${this.decode(`cHJhd2EtamF6ZHk=`)}`;
+    }
+    ;
+    static getEndpointForDrivingLicence(licenceId) {
+        return `${this.drivingLicencesEndpoint}/${licenceId}`;
+    }
+    ;
+    static get permissionsEndpoint() {
+        return `${this.host}/${this.decode(`dXByYXduaWVuaWE=`)}`;
+    }
+    ;
+    static getEndpointForPermission(permissionId) {
+        return `${this.permissionsEndpoint}/${permissionId}`;
+    }
+    ;
+    static get dictionariesEndpoint() {
+        return `${this.host}/${this.decode(`c2xvd25pa2k=`)}`;
+    }
+    ;
+    static getEndpointForDictionary(dictionaryId) {
+        return `${this.dictionariesEndpoint}/${dictionaryId}`;
+    }
+    ;
+    static get statisticsEndpoint() {
+        return `${this.host}/${this.decode(`c3RhdHlzdHlraQ==`)}`;
+    }
+    ;
+    static get versionEndpoint() {
+        return `${this.host}/${this.decode(`dmVyc2lvbg==`)}`;
+    }
+    ;
+    static get v1VersionEndpoint() {
+        return `${this.host}/${this.decode(`djEvdmVyc2lvbg==`)}`;
+    }
+    ;
+}
+;
+//# sourceMappingURL=cepik-address-resolver.js.map

package/dist/cepik-address-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cepik-address-resolver.js","sourceRoot":"","sources":["../src/cepik-address-resolver.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,oBAAoB;IAErB,MAAM,CAAC,MAAM,CAAC,OAAe;QACjC,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAEO,MAAM,KAAK,IAAI;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,sCAAsC,CAAC,CAAC;IAC/D,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,gBAAgB;QAC9B,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;IACzD,CAAC;IAAA,CAAC;IAEK,MAAM,CAAC,qBAAqB,CAAC,SAAiB;QACjD,OAAO,GAAG,IAAI,CAAC,gBAAgB,IAAI,SAAS,EAAE,CAAC;IACnD,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,aAAa;QAC3B,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAA;IACpD,CAAC;IAEM,MAAM,CAAC,kBAAkB,CAAC,MAAc;QAC3C,OAAO,GAAG,IAAI,CAAC,aAAa,IAAI,MAAM,EAAE,CAAC;IAC7C,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,uBAAuB;QACrC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC7D,CAAC;IAAA,CAAC;IAEK,MAAM,CAAC,4BAA4B,CAAC,SAAiB;QACxD,OAAO,GAAG,IAAI,CAAC,uBAAuB,IAAI,SAAS,EAAE,CAAC;IAC1D,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,mBAAmB;QACjC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC7D,CAAC;IAAA,CAAC;IAEK,MAAM,CAAC,wBAAwB,CAAC,YAAoB;QACvD,OAAO,GAAG,IAAI,CAAC,mBAAmB,IAAI,YAAY,EAAE,CAAC;IACzD,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,oBAAoB;QAClC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;IACzD,CAAC;IAAA,CAAC;IAEK,MAAM,CAAC,wBAAwB,CAAC,YAAoB;QACvD,OAAO,GAAG,IAAI,CAAC,oBAAoB,IAAI,YAAY,EAAE,CAAA;IACzD,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,kBAAkB;QAChC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC7D,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,eAAe;QAC7B,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;IACzD,CAAC;IAAA,CAAC;IAEK,MAAM,KAAK,iBAAiB;QAC/B,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,CAAC;IAC7D,CAAC;IAAA,CAAC;CAEL;AAAA,CAAC"}

package/dist/cepik-address-resolver.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cepik-address-resolver.spec.js

@@ -0,0 +1,17 @@
+import { CepikAddressResolver } from "./cepik-address-resolver.js";
+global.fetch = jest.fn();
+const mockFetch = global.fetch;
+describe("CEPIKClient", () => {
+    let client;
+    beforeEach(() => {
+        mockFetch.mockClear();
+        client = new CepikAddressResolver();
+    });
+    describe("constructor", () => {
+        it("Should initialize", () => {
+            const newClient = new CepikAddressResolver();
+            expect(newClient).toBeInstanceOf(CepikAddressResolver);
+        });
+    });
+});
+//# sourceMappingURL=cepik-address-resolver.spec.js.map

package/dist/cepik-address-resolver.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cepik-address-resolver.spec.js","sourceRoot":"","sources":["../src/cepik-address-resolver.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAGnE,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AACzB,MAAM,SAAS,GAAG,MAAM,CAAC,KAA0C,CAAC;AAEpE,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAEzB,IAAI,MAA4B,CAAC;IAEjC,UAAU,CAAC,GAAG,EAAE;QACZ,SAAS,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAEzB,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YACzB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;YAC7C,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IAEP,CAAC,CAAC,CAAC;AAEP,CAAC,CAAC,CAAC"}

package/dist/cepik-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"cepik-client.js","sourceRoot":"","sources":["../src/cepik-client.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,WAAW;CAEvB"}
+{"version":3,"file":"cepik-client.js","sourceRoot":"","sources":["../src/cepik-client.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,WAAW;CAGvB"}

package/dist/enums.d.ts

@@ -1 +1,16 @@
-export {};
+export declare enum VoivodeshipEnum {
+}
+export declare enum BrandEnum {
+}
+export declare enum DictionariesEnum {
+}
+export declare enum VehicleBrandEnum {
+}
+export declare enum FuelTypeEnum {
+}
+export declare enum VehicleManufacturingCountryEnum {
+}
+export declare enum VehicleProductionMethodEnum {
+}
+export declare enum StatisticsSubjects {
+}

package/dist/enums.js

@@ -1,2 +1,33 @@
-export {};
+export var VoivodeshipEnum;
+(function (VoivodeshipEnum) {
+})(VoivodeshipEnum || (VoivodeshipEnum = {}));
+;
+export var BrandEnum;
+(function (BrandEnum) {
+})(BrandEnum || (BrandEnum = {}));
+;
+export var DictionariesEnum;
+(function (DictionariesEnum) {
+})(DictionariesEnum || (DictionariesEnum = {}));
+;
+export var VehicleBrandEnum;
+(function (VehicleBrandEnum) {
+})(VehicleBrandEnum || (VehicleBrandEnum = {}));
+;
+export var FuelTypeEnum;
+(function (FuelTypeEnum) {
+})(FuelTypeEnum || (FuelTypeEnum = {}));
+;
+export var VehicleManufacturingCountryEnum;
+(function (VehicleManufacturingCountryEnum) {
+})(VehicleManufacturingCountryEnum || (VehicleManufacturingCountryEnum = {}));
+;
+export var VehicleProductionMethodEnum;
+(function (VehicleProductionMethodEnum) {
+})(VehicleProductionMethodEnum || (VehicleProductionMethodEnum = {}));
+;
+export var StatisticsSubjects;
+(function (StatisticsSubjects) {
+})(StatisticsSubjects || (StatisticsSubjects = {}));
+;
 //# sourceMappingURL=enums.js.map

package/dist/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":""}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAEX;AAFD,WAAY,eAAe;AAE3B,CAAC,EAFW,eAAe,KAAf,eAAe,QAE1B;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,SAEX;AAFD,WAAY,SAAS;AAErB,CAAC,EAFW,SAAS,KAAT,SAAS,QAEpB;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,gBAEX;AAFD,WAAY,gBAAgB;AAE5B,CAAC,EAFW,gBAAgB,KAAhB,gBAAgB,QAE3B;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,gBAEX;AAFD,WAAY,gBAAgB;AAE5B,CAAC,EAFW,gBAAgB,KAAhB,gBAAgB,QAE3B;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,YAEX;AAFD,WAAY,YAAY;AAExB,CAAC,EAFW,YAAY,KAAZ,YAAY,QAEvB;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,+BAEX;AAFD,WAAY,+BAA+B;AAE3C,CAAC,EAFW,+BAA+B,KAA/B,+BAA+B,QAE1C;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,2BAEX;AAFD,WAAY,2BAA2B;AAEvC,CAAC,EAFW,2BAA2B,KAA3B,2BAA2B,QAEtC;AAAA,CAAC;AAEF,MAAM,CAAN,IAAY,kBAEX;AAFD,WAAY,kBAAkB;AAE9B,CAAC,EAFW,kBAAkB,KAAlB,kBAAkB,QAE7B;AAAA,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cepik-api-client",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "A modern TypeScript/JavaScript library for retrieving data from the public API of the Polish National Vehicles Database (CEPIK).",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",