vinmonopolet-ts 5.2.11 → 5.2.12

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [5.2.11]
 
+### Changed
+
+- All functions now throw `VinmonopoletError` if fetch fails.
+
+## [5.2.11]
+
 ### Added
 
 - Added the ability to override vinmonopolet base url by setting an environment variable

package/README.md

@@ -32,6 +32,24 @@ This project is a rewrite of the original package in typescript, so it is now fu
 
 You can override the base URL (`www.vinmonopolet.no`) by setting the `VINMONOPOLET_BASE_URL` environment variable, for example `VINMONOPOLET_BASE_URL=http://localhost:3000`.
 
+## Error handling
+
+All the functions throws `VinmonopoletError` if something goes wrong. It extends from the base javascript `Error`class and contains a http status code.
+
+```ts
+import { VinmonopoletError } from "vinmonopolet-ts";
+
+async function getAllProducs() {
+  try {
+    const procuts = await getProducts();
+  } catch (error) {
+    if (error instanceof VinmonopoletError) {
+      // Handle error
+    }
+  }
+}
+```
+
 ## Documentation
 
 ### GetProducts

package/dist/cjs/exceptions/VinmonopoletError.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class VinmonopoletError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.status = status;
+    }
+}
+exports.default = VinmonopoletError;

package/dist/cjs/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProductReleases = exports.getStore = exports.searchStores = exports.getAllStores = exports.getProductsByIds = exports.getProductsByStore = exports.getFacets = exports.getProduct = exports.getProducts = exports.PopulatedStore = exports.BaseStore = exports.RawMaterial = exports.ProductStatus = exports.ProductImage = exports.PopulatedProduct = exports.BaseProduct = exports.Pagination = exports.FoodPairing = exports.FacetCategory = exports.FacetValue = exports.Facet = void 0;
+exports.getProductReleases = exports.getStore = exports.searchStores = exports.getAllStores = exports.getProductsByIds = exports.getProductsByStore = exports.getFacets = exports.getProduct = exports.getProducts = exports.VinmonopoletError = exports.PopulatedStore = exports.BaseStore = exports.RawMaterial = exports.ProductStatus = exports.ProductImage = exports.PopulatedProduct = exports.BaseProduct = exports.Pagination = exports.FoodPairing = exports.FacetCategory = exports.FacetValue = exports.Facet = void 0;
 require("reflect-metadata");
 var Facet_1 = require("./models/Facet");
 Object.defineProperty(exports, "Facet", { enumerable: true, get: function () { return __importDefault(Facet_1).default; } });
@@ -51,6 +51,8 @@ var BaseStore_1 = require("./models/store/BaseStore");
 Object.defineProperty(exports, "BaseStore", { enumerable: true, get: function () { return __importDefault(BaseStore_1).default; } });
 var BaseStore_2 = require("./models/store/BaseStore");
 Object.defineProperty(exports, "PopulatedStore", { enumerable: true, get: function () { return __importDefault(BaseStore_2).default; } });
+var VinmonopoletError_1 = require("./exceptions/VinmonopoletError");
+Object.defineProperty(exports, "VinmonopoletError", { enumerable: true, get: function () { return __importDefault(VinmonopoletError_1).default; } });
 var getProducts_1 = require("./retrievers/getProducts");
 Object.defineProperty(exports, "getProducts", { enumerable: true, get: function () { return __importDefault(getProducts_1).default; } });
 var getProduct_1 = require("./retrievers/getProduct");

package/dist/cjs/util/GET.js

@@ -1,22 +1,35 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GET = void 0;
+const VinmonopoletError_1 = __importDefault(require("../exceptions/VinmonopoletError"));
 async function GET(url, queryparams) {
-    const urlSearchParams = queryparams?.toString() ?? "";
-    const headers = {
-        "Content-Type": "Application/json",
-    };
-    if (process.env.USER_AGENT) {
-        headers["User-Agent"] = process.env.USER_AGENT;
+    try {
+        const urlSearchParams = queryparams?.toString() ?? "";
+        const headers = {
+            "Content-Type": "Application/json",
+        };
+        if (process.env.USER_AGENT) {
+            headers["User-Agent"] = process.env.USER_AGENT;
+        }
+        const response = await fetch(url + "?" + urlSearchParams, { headers });
+        if (!response.ok) {
+            const parsedErrorResponse = await response.text();
+            throw new VinmonopoletError_1.default(parsedErrorResponse != ""
+                ? parsedErrorResponse
+                : `Unable to get ${url}?${urlSearchParams}: http error ${response.status}`, response.status);
+        }
+        const responseJson = (await response.json());
+        return responseJson;
     }
-    const response = await fetch(url + "?" + urlSearchParams, { headers });
-    if (!response.ok) {
-        const parsedErrorResponse = await response.text();
-        throw new Error(parsedErrorResponse != ""
-            ? parsedErrorResponse
-            : `Unable to get ${url}?${urlSearchParams}: http error ${response.status}`);
+    catch (error) {
+        if (error instanceof VinmonopoletError_1.default)
+            throw error;
+        if (error instanceof Error)
+            throw new VinmonopoletError_1.default(`Network error fetching ${url}: ${error.message}`);
+        throw new VinmonopoletError_1.default(`Network error fetching ${url}: ${error}`);
     }
-    const responseJson = (await response.json());
-    return responseJson;
 }
 exports.GET = GET;

package/dist/esm/exceptions/VinmonopoletError.js

@@ -0,0 +1,8 @@
+class VinmonopoletError extends Error {
+    status;
+    constructor(message, status) {
+        super(message);
+        this.status = status;
+    }
+}
+export default VinmonopoletError;

package/dist/esm/index.js

@@ -11,6 +11,7 @@ export { default as ProductStatus } from "./models/ProductStatus";
 export { default as RawMaterial } from "./models/RawMaterial";
 export { default as BaseStore } from "./models/store/BaseStore";
 export { default as PopulatedStore } from "./models/store/BaseStore";
+export { default as VinmonopoletError } from "./exceptions/VinmonopoletError";
 export { default as getProducts } from "./retrievers/getProducts";
 export { default as getProduct } from "./retrievers/getProduct";
 export { default as getFacets } from "./retrievers/getFacets";

package/dist/esm/util/GET.js

@@ -1,18 +1,28 @@
+import VinmonopoletError from "../exceptions/VinmonopoletError";
 export async function GET(url, queryparams) {
-    const urlSearchParams = queryparams?.toString() ?? "";
-    const headers = {
-        "Content-Type": "Application/json",
-    };
-    if (process.env.USER_AGENT) {
-        headers["User-Agent"] = process.env.USER_AGENT;
+    try {
+        const urlSearchParams = queryparams?.toString() ?? "";
+        const headers = {
+            "Content-Type": "Application/json",
+        };
+        if (process.env.USER_AGENT) {
+            headers["User-Agent"] = process.env.USER_AGENT;
+        }
+        const response = await fetch(url + "?" + urlSearchParams, { headers });
+        if (!response.ok) {
+            const parsedErrorResponse = await response.text();
+            throw new VinmonopoletError(parsedErrorResponse != ""
+                ? parsedErrorResponse
+                : `Unable to get ${url}?${urlSearchParams}: http error ${response.status}`, response.status);
+        }
+        const responseJson = (await response.json());
+        return responseJson;
     }
-    const response = await fetch(url + "?" + urlSearchParams, { headers });
-    if (!response.ok) {
-        const parsedErrorResponse = await response.text();
-        throw new Error(parsedErrorResponse != ""
-            ? parsedErrorResponse
-            : `Unable to get ${url}?${urlSearchParams}: http error ${response.status}`);
+    catch (error) {
+        if (error instanceof VinmonopoletError)
+            throw error;
+        if (error instanceof Error)
+            throw new VinmonopoletError(`Network error fetching ${url}: ${error.message}`);
+        throw new VinmonopoletError(`Network error fetching ${url}: ${error}`);
     }
-    const responseJson = (await response.json());
-    return responseJson;
 }

package/dist/types/exceptions/VinmonopoletError.d.ts

@@ -0,0 +1,5 @@
+declare class VinmonopoletError extends Error {
+    status?: number;
+    constructor(message: string, status?: number);
+}
+export default VinmonopoletError;

package/dist/types/index.d.ts

@@ -11,6 +11,7 @@ export { default as ProductStatus } from "./models/ProductStatus";
 export { default as RawMaterial } from "./models/RawMaterial";
 export { default as BaseStore } from "./models/store/BaseStore";
 export { default as PopulatedStore } from "./models/store/BaseStore";
+export { default as VinmonopoletError } from "./exceptions/VinmonopoletError";
 export { default as getProducts } from "./retrievers/getProducts";
 export { default as getProduct } from "./retrievers/getProduct";
 export { default as getFacets } from "./retrievers/getFacets";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vinmonopolet-ts",
   "description": "Extracts information on products, categories and stores from Vinmonopolet",
-  "version": "5.2.11",
+  "version": "5.2.12",
   "keywords": [
     "vinmonopolet",
     "beer",