vinmonopolet-ts 2.0.1 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 #Changelog
 
+## [2.0.4]
+
+#### Added
+
+- GetProductsByStore now accepts page option.
+- Paginatiation now has correct return type for next and previous functions.
+
+### Changed
+
+- GetProductsByStore store parameter is now statically typed as a string.
+
 ## [2.0.0]
 
 Changed package export method to individual exports so that you no longer need to import the whole package.

package/dist/cjs/retrievers/getFacets.js

@@ -7,13 +7,12 @@ const request_1 = __importDefault(require("../util/request"));
 const Facet_1 = __importDefault(require("../models/Facet"));
 function getFacets() {
     return request_1.default
-        .get("/vmp/search/facets", {
+        .get("/api/search", {
         baseUrl: "https://www.vinmonopolet.no",
         query: {
-            // 500 thrown if no "q" parameter supplied.
-            q: "",
+            fields: "FULL",
         },
     })
-        .then((res) => res.facets.map((i) => new Facet_1.default(i)));
+        .then((res) => res.productSearchResult.facets.map((i) => new Facet_1.default(i)));
 }
 exports.default = getFacets;

package/dist/cjs/retrievers/getProductsByStore.js

@@ -6,9 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const FacetValue_1 = __importDefault(require("../models/FacetValue"));
 const getProducts_1 = __importDefault(require("./getProducts"));
 async function getProductsByStore(store, opts) {
-    const id = typeof store.name === "undefined" ? store : store.name;
     const storeFacet = new FacetValue_1.default({
-        query: { query: { value: `availableInStores:${id}` } },
+        query: { query: { value: `availableInStores:${store}` } },
     });
     let facets = [storeFacet];
     if (opts?.facet)
@@ -17,8 +16,7 @@ async function getProductsByStore(store, opts) {
         const safeFacets = opts?.facets.filter((facet) => facet !== undefined);
         facets = facets.concat(safeFacets);
     }
-    delete opts?.facet;
-    const options = { limit: opts?.limit, facets: facets };
+    const options = { limit: opts?.limit, facets: facets, page: opts?.page ?? 1 };
     const allProducts = await (0, getProducts_1.default)(options);
     return { ...allProducts, store };
 }

package/dist/esm/retrievers/getFacets.js

@@ -2,13 +2,12 @@ import request from "../util/request";
 import Facet from "../models/Facet";
 function getFacets() {
     return request
-        .get("/vmp/search/facets", {
+        .get("/api/search", {
         baseUrl: "https://www.vinmonopolet.no",
         query: {
-            // 500 thrown if no "q" parameter supplied.
-            q: "",
+            fields: "FULL",
         },
     })
-        .then((res) => res.facets.map((i) => new Facet(i)));
+        .then((res) => res.productSearchResult.facets.map((i) => new Facet(i)));
 }
 export default getFacets;

package/dist/esm/retrievers/getProductsByStore.js

@@ -1,9 +1,8 @@
 import FacetValue from "../models/FacetValue";
 import getProducts from "./getProducts";
 async function getProductsByStore(store, opts) {
-    const id = typeof store.name === "undefined" ? store : store.name;
     const storeFacet = new FacetValue({
-        query: { query: { value: `availableInStores:${id}` } },
+        query: { query: { value: `availableInStores:${store}` } },
     });
     let facets = [storeFacet];
     if (opts?.facet)
@@ -12,8 +11,7 @@ async function getProductsByStore(store, opts) {
         const safeFacets = opts?.facets.filter((facet) => facet !== undefined);
         facets = facets.concat(safeFacets);
     }
-    delete opts?.facet;
-    const options = { limit: opts?.limit, facets: facets };
+    const options = { limit: opts?.limit, facets: facets, page: opts?.page ?? 1 };
     const allProducts = await getProducts(options);
     return { ...allProducts, store };
 }

package/dist/types/models/Pagination.d.ts

@@ -1,4 +1,4 @@
-declare class Pagination {
+declare class Pagination<T> {
     /**
      * The current page of the results.
      */
@@ -29,8 +29,8 @@ declare class Pagination {
     sort: string;
     private fetcher;
     private options;
-    constructor(paging: any, options: any, fetcher: () => any);
-    next(): Promise<any>;
-    previous(): Promise<any>;
+    constructor(paging: any, options: any, fetcher: () => Promise<T>);
+    next(): Promise<T>;
+    previous(): Promise<T>;
 }
 export default Pagination;

package/dist/types/retrievers/getProducts.d.ts

@@ -33,7 +33,7 @@ export interface IGetProductsResponse {
     /**
      * Pagination object used to traverse the results.
      */
-    pagination: Pagination;
+    pagination: Pagination<IGetProductsResponse>;
     /**
      * a list of products. Represents one page of the results, use pagination.next to fetch next page of results.
      */

package/dist/types/retrievers/getProductsByStore.d.ts

@@ -13,9 +13,13 @@ interface IGetProductsByStoreOptions {
      * Limits the number of products returned in a single, paginated response (Default: 50)
      */
     limit?: number;
+    /**
+     * Which page of the pagination you want to get. (Default: 1)
+     */
+    page?: number;
 }
 interface getProductsByStoreResponse extends IGetProductsResponse {
     store: string;
 }
-declare function getProductsByStore(store: any, opts?: IGetProductsByStoreOptions): Promise<getProductsByStoreResponse>;
+declare function getProductsByStore(store: string, opts?: IGetProductsByStoreOptions): Promise<getProductsByStoreResponse>;
 export default getProductsByStore;

package/dist/types/retrievers/getStores.d.ts

@@ -29,7 +29,7 @@ export interface ISearchStoreResult {
     /**
      * Pagination object used to traverse the results.
      */
-    pagination?: Pagination;
+    pagination?: Pagination<ISearchStoreResult>;
 }
 export declare function searchStores(opts?: ISearchStoresOptions): Promise<ISearchStoreResult>;
 declare function getAllStores(): Promise<PopulatedStore[]>;

package/package.json

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