@bontabil/sdk 0.1.3

package/dist/index.js

@@ -0,0 +1,521 @@
+//#region src/api/constants.ts
+const DEFAULT_REQUEST_HEADERS = {
+	"Accept": "application/json",
+	"Content-Type": "application/json"
+};
+const DEFAULT_REQUEST_OPTIONS = { headers: DEFAULT_REQUEST_HEADERS };
+
+//#endregion
+//#region src/api/resource.ts
+/**
+* The base resource class.
+*/
+var Resource = class {
+	/**
+	* The base resource constructor.
+	*
+	* @param client The API client.
+	*/
+	constructor(client) {
+		this.client = client;
+	}
+};
+
+//#endregion
+//#region src/api/chatbot/resource.ts
+/**
+* The chatbot resource.
+*/
+var ChatbotResource = class extends Resource {
+	/**
+	* Send a message to the chatbot.
+	*
+	* @param request The chatbot request.
+	* @returns The chatbot response.
+	*/
+	sendMessage(request) {
+		return this.client.request("chatbot", {
+			...DEFAULT_REQUEST_OPTIONS,
+			method: "POST",
+			body: JSON.stringify(request)
+		}).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/utils.ts
+/**
+* Builds a query string for a list request.
+*
+* @param request The paginated request parameters.
+* @param initUrlSearchParams The initial URL search parameters.
+* @returns The query string for the paginated request.
+*/
+const buildListRequestQuery = (request, initUrlSearchParams) => {
+	return new URLSearchParams(buildPaginationRequestQuery(request, buildSortRequestQuery(request, buildIncludeRequestQuery(request, buildFilterRequestQuery(request, initUrlSearchParams))))).toString();
+};
+/**
+* Builds a query string for a filter request.
+*
+* @param request The filter request parameters.
+* @param initUrlSearchParams The initial URL search parameters.
+* @returns The query string for the filter request.
+*/
+const buildFilterRequestQuery = (request, initUrlSearchParams) => {
+	const result = new URLSearchParams(initUrlSearchParams);
+	Object.entries(request.filter ?? {}).forEach(([key, value]) => {
+		if (typeof value !== "undefined") result.append(`filter[${encodeURIComponent(key)}]`, String(value));
+	});
+	return result.toString();
+};
+/**
+* Builds a query string for a include request.
+*
+* @param request The include request parameters.
+* @param initUrlSearchParams The initial URL search parameters.
+* @returns The query string for the include request.
+*/
+const buildIncludeRequestQuery = (request, initUrlSearchParams) => {
+	const result = new URLSearchParams(initUrlSearchParams);
+	if (request.include && request.include.length > 0) result.append("include", request.include.join(","));
+	return result.toString();
+};
+/**
+* Builds a query string for a sort request.
+*
+* @param request The sort request parameters.
+* @param initUrlSearchParams The initial URL search parameters.
+* @returns The query string for the sort request.
+*/
+const buildSortRequestQuery = (request, initUrlSearchParams) => {
+	const result = new URLSearchParams(initUrlSearchParams);
+	if (request.sort) result.append("sort", request.sort.direction === "desc" ? `-${request.sort.field}` : request.sort.field);
+	return result.toString();
+};
+/**
+* Builds a query string for a pagination request.
+*
+* @param request The pagination request parameters.
+* @param initUrlSearchParams The initial URL search parameters.
+* @returns The query string for the pagination request.
+*/
+const buildPaginationRequestQuery = (request, initUrlSearchParams) => {
+	const result = new URLSearchParams(initUrlSearchParams);
+	if (typeof request.pagination?.page !== "undefined") result.append("page", String(request.pagination.page));
+	if (typeof request.pagination?.per_page !== "undefined") result.append("per_page", String(request.pagination.per_page));
+	return result.toString();
+};
+
+//#endregion
+//#region src/api/cities/resource.ts
+/**
+* The cities resource.
+*/
+var CitiesResource = class extends Resource {
+	/**
+	* Get a paginated list of cities.
+	*
+	* @param request The cities request parameters.
+	* @returns The paginated list of cities.
+	*/
+	list(request) {
+		return this.client.request(`cities${request ? `?${buildListRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/client/errors.ts
+/**
+* The base response error class.
+*/
+var ResponseError = class extends Error {};
+/**
+* The unauthenticated error class.
+*/
+var UnauthenticatedError = class extends ResponseError {};
+/**
+* The forbidden error class.
+*/
+var ForbiddenError = class extends ResponseError {};
+/**
+* The not found error class.
+*/
+var NotFoundError = class extends ResponseError {};
+/**
+* The internal server error class.
+*/
+var InternalServerError = class extends ResponseError {};
+/**
+* The validation error class.
+*/
+var ValidationError = class extends ResponseError {
+	/**
+	* The validation error constructor.
+	*
+	* @param message The error message.
+	* @param errors The validation errors.
+	*/
+	constructor(message, errors) {
+		super(message);
+		this.errors = errors;
+	}
+};
+
+//#endregion
+//#region src/client/constants.ts
+const DEFAULT_ENDPOINT = "https://api.bontabil.ro/api";
+const DEFAULT_OPTIONS = {
+	endpoint: DEFAULT_ENDPOINT,
+	requestOptions: {}
+};
+
+//#endregion
+//#region src/client/client.ts
+/**
+* The API client.
+*/
+var Client = class {
+	/**
+	* The client options.
+	*/
+	options;
+	/**
+	* The client constructor.
+	*
+	* @param options The client options.
+	*/
+	constructor(options) {
+		this.options = {
+			...DEFAULT_OPTIONS,
+			...options
+		};
+	}
+	/**
+	* Make a generic request to the API.
+	*
+	* @param path The path to request.
+	* @param options The request options.
+	* @returns The response.
+	*/
+	request(path, options) {
+		return fetch(this.buildUrl(path), {
+			...options,
+			...this.options.requestOptions,
+			headers: {
+				...this.options.token ? { Authorization: `Bearer ${this.options.token}` } : {},
+				...options?.headers ?? {},
+				...this.options.requestOptions.headers ?? {}
+			}
+		}).then(async (res) => {
+			if (!res.ok) this.handleError(res, await res.json());
+			return res;
+		});
+	}
+	/**
+	* Handle an error response.
+	*
+	* @param res The response.
+	* @param data The response data.
+	*/
+	handleError(res, data) {
+		if (res.status >= 300 && res.status < 400) throw new ResponseError("Redirection not supported");
+		else if (res.status === 401) throw new UnauthenticatedError(data.message);
+		else if (res.status === 403) throw new ForbiddenError(data.message);
+		else if (res.status === 404) throw new NotFoundError(data.message);
+		else if (res.status === 422) throw new ValidationError(data.message, data.errors);
+		else if (res.status >= 500 && res.status < 600) throw new InternalServerError(data.message);
+		else throw new ResponseError(`Unexpected response status: ${res.status} ${res.statusText}`);
+	}
+	/**
+	* Builds a full URL from the given path.
+	*
+	* @param path The path to build the URL for.
+	* @returns The full URL.
+	*/
+	buildUrl(path) {
+		return new URL(this.options.endpoint.replace(/\/$/, "") + "/" + path.replace(/^\//, ""));
+	}
+};
+
+//#endregion
+//#region src/api/counties/resource.ts
+/**
+* The counties resource.
+*/
+var CountiesResource = class extends Resource {
+	/**
+	* Get a paginated list of counties.
+	*
+	* @param request The counties request parameters.
+	* @returns The paginated list of counties.
+	*/
+	list(request) {
+		return this.client.request(`counties${request ? `?${buildListRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/merchants/resource.ts
+/**
+* The merchants resource.
+*/
+var MerchantsResource = class extends Resource {
+	/**
+	* Get a paginated list of merchants.
+	*
+	* @param request The merchants request parameters.
+	* @returns The paginated list of merchants.
+	*/
+	list(request) {
+		return this.client.request(`merchants${request ? `?${buildListRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/personal-access-tokens/resource.ts
+/**
+* The personal access tokens resource.
+*/
+var PersonalAccessTokensResource = class extends Resource {
+	/**
+	* List all personal access tokens.
+	*
+	* @returns A list of personal access tokens.
+	*/
+	all() {
+		return this.client.request("personal-access-tokens", DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+	/**
+	* Create a new personal access token.
+	*
+	* @param request The create personal access token request.
+	* @returns The created personal access token.
+	*/
+	create(request) {
+		return this.client.request("personal-access-tokens", {
+			...DEFAULT_REQUEST_OPTIONS,
+			method: "POST",
+			body: JSON.stringify(request)
+		}).then((res) => res.json());
+	}
+	/**
+	* Update a personal access token by ID.
+	*
+	* @param id The personal access token ID.
+	* @param request The update personal access token request.
+	* @returns The updated personal access token.
+	*/
+	update(id, request) {
+		return this.client.request(`personal-access-tokens/${id}`, {
+			...DEFAULT_REQUEST_OPTIONS,
+			method: "PATCH",
+			body: JSON.stringify(request)
+		}).then((res) => res.json());
+	}
+	/**
+	* Get a personal access token by ID.
+	*
+	* @param id The personal access token ID.
+	* @returns The personal access token.
+	*/
+	get(id) {
+		return this.client.request(`personal-access-tokens/${id}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+	/**
+	* Delete a personal access token by ID.
+	*
+	* @param id The personal access token ID.
+	*/
+	async delete(id) {
+		await this.client.request(`personal-access-tokens/${id}`, {
+			...DEFAULT_REQUEST_OPTIONS,
+			method: "DELETE"
+		});
+	}
+};
+
+//#endregion
+//#region src/api/profile/resource.ts
+/**
+* The profile resource.
+*/
+var ProfileResource = class extends Resource {
+	/**
+	* Get the current user's profile.
+	*
+	* @returns The current user's profile.
+	*/
+	me() {
+		return this.client.request("me", DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/receipts/resource.ts
+/**
+* The receipts resource.
+*/
+var ReceiptsResource = class extends Resource {
+	/**
+	* Get a paginated list of receipts.
+	*
+	* @param request The receipts request parameters.
+	* @returns The paginated list of receipts.
+	*/
+	list(request) {
+		return this.client.request(`receipts${request ? `?${buildListRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+	/**
+	* Create a receipt.
+	*
+	* @param request The create receipt request.
+	* @returns The created receipt.
+	*/
+	create(request) {
+		const formData = new FormData();
+		formData.append("file", request.file);
+		return this.client.request("receipts", {
+			...DEFAULT_REQUEST_OPTIONS,
+			headers: { Accept: "application/json" },
+			method: "POST",
+			body: formData
+		}).then((res) => res.json());
+	}
+	/**
+	* Get a receipt by ID.
+	*
+	* @param id The receipt ID.
+	* @returns The receipt.
+	*/
+	get(id) {
+		return this.client.request(`receipts/${id}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+	/**
+	* Delete a receipt by ID.
+	*
+	* @param id The receipt ID.
+	*/
+	async delete(id) {
+		await this.client.request(`receipts/${id}`, {
+			...DEFAULT_REQUEST_OPTIONS,
+			method: "DELETE"
+		});
+	}
+	/**
+	* Export receipts.
+	*
+	* @param request The export receipts request.
+	* @returns The exported receipts.
+	*/
+	export(request) {
+		return this.client.request(`receipts/export${request ? `?${buildListRequestQuery(request)}` : ""}`, {
+			...DEFAULT_REQUEST_OPTIONS,
+			headers: {
+				...DEFAULT_REQUEST_OPTIONS.headers,
+				Accept: "application/octet-stream"
+			}
+		}).then((res) => res.blob());
+	}
+};
+
+//#endregion
+//#region src/api/reports/resource.ts
+/**
+* The reports resource.
+*/
+var ReportsResource = class extends Resource {
+	/**
+	* Get spending by categories report.
+	*
+	* @param request The spending by categories request parameters.
+	* @returns The list of spending by category objects.
+	*/
+	spendingByCategories(request) {
+		return this.client.request(`reports/spending-by-categories${request ? `?${buildFilterRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/stores/resource.ts
+/**
+* The stores resource.
+*/
+var StoresResource = class extends Resource {
+	/**
+	* Get a paginated list of stores.
+	*
+	* @param request The stores request parameters.
+	* @returns The paginated list of stores.
+	*/
+	list(request) {
+		return this.client.request(`stores${request ? `?${buildListRequestQuery(request)}` : ""}`, DEFAULT_REQUEST_OPTIONS).then((res) => res.json());
+	}
+};
+
+//#endregion
+//#region src/api/api.ts
+/**
+* The Bontabil API.
+*/
+var BontabilApi = class {
+	/**
+	* The API client.
+	*/
+	client;
+	/**
+	* The profile resource.
+	*/
+	profile;
+	/**
+	* The personal access tokens resource.
+	*/
+	personalAccessTokens;
+	/**
+	* The counties resource.
+	*/
+	counties;
+	/**
+	* The cities resource.
+	*/
+	cities;
+	/**
+	* The stores resource.
+	*/
+	stores;
+	/**
+	* The merchants resource.
+	*/
+	merchants;
+	/**
+	* The chatbot resource.
+	*/
+	chatbot;
+	/**
+	* The receipts resource.
+	*/
+	receipts;
+	/**
+	* The reports resource.
+	*/
+	reports;
+	/**
+	* The Bontabil API constructor.
+	*
+	* @param client The API client or client options.
+	*/
+	constructor(client) {
+		this.client = client instanceof Client ? client : new Client(client);
+		this.profile = new ProfileResource(this.client);
+		this.personalAccessTokens = new PersonalAccessTokensResource(this.client);
+		this.counties = new CountiesResource(this.client);
+		this.cities = new CitiesResource(this.client);
+		this.stores = new StoresResource(this.client);
+		this.merchants = new MerchantsResource(this.client);
+		this.chatbot = new ChatbotResource(this.client);
+		this.receipts = new ReceiptsResource(this.client);
+		this.reports = new ReportsResource(this.client);
+	}
+};
+
+//#endregion
+export { BontabilApi, ChatbotResource, CitiesResource, Client, CountiesResource, DEFAULT_ENDPOINT, DEFAULT_OPTIONS, DEFAULT_REQUEST_HEADERS, DEFAULT_REQUEST_OPTIONS, MerchantsResource, PersonalAccessTokensResource, ProfileResource, ReceiptsResource, Resource, StoresResource };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@bontabil/sdk",
+  "version": "0.1.3",
+  "description": "The Bontabil SDK library",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.37.0",
+    "@types/node": "^22.18.8",
+    "@typescript-eslint/parser": "^8.46.2",
+    "@vitest/coverage-v8": "3.2.4",
+    "eslint": "^9.37.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.4.0",
+    "jiti": "^2.6.1",
+    "prettier": "3.6.2",
+    "tsdown": "^0.15.9",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.0",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type:check": "tsc --noEmit",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "format:fix": "prettier --write \"src/**/*.ts\"",
+    "lint:check": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix"
+  }
+}