picnic-api-fix 3.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 MRVDH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# Picnic-API
+
+[![npm version](https://img.shields.io/npm/v/picnic-api.svg?style=flat-square)](https://www.npmjs.org/package/picnic-api) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/MRVDH/picnic-api/blob/master/LICENSE) [![Buy me an Affligem blond](https://img.shields.io/badge/buy%20me%20an-affligem%20blond-orange?style=flat-square)](https://www.buymeacoffee.com/MRVDH) [![MAAR3267](https://img.shields.io/badge/picnic%20discount-MAAR3267-E1171E?style=flat-square)](https://picnic.app/nl/vriendenkorting/MAAR3267)
+
+Unofficial and unaffiliated Node.js npm package as a wrapper for the API of the online supermarket Picnic.
+
+## Getting started
+
+Using `npm`:
+
+```bash
+npm install picnic-api
+```
+
+Then import the package into your project. `PicnicClient` is the default export.
+
+```js
+import PicnicClient from "picnic-api";
+
+// or
+
+const PicnicClient = require("picnic-api");
+```
+
+Now initialize the Picnic client with an optional options object.
+
+```js
+const picnicClient = new PicnicClient();
+
+// or
+
+const picnicClient = new PicnicClient({
+    countryCode: "NL", // The country code for the requests. Can be NL or DE. Untested for other countries.
+    apiVersion: "15", // default 15 as this is what the app currently uses. The api version for the requests. The effect of this version numbering is unknown to me.
+    authKey: "long string here", // default null. The code for the x-picnic-auth header to make authenticated requests. If not supplied then login() needs to be called before making any other requests.
+    url: "url here" // default https://storefront-prod.nl.picnicinternational.com/api/15. The url to send requests to.
+});
+```
+
+If no authKey was given in the options use the `login` method. Empty response if successful, otherwise an error.
+
+```js
+await picnicClient.login("email", "password");
+// and then send an authenticated request...
+```
+
+Example of a `GET` request:
+
+```js
+const searchResults = await picnicClient.search("Affligem blond");
+```
+
+Example of a `POST` request:
+
+```js
+await picnicClient.addProductToShoppingCart(11295810, 2);
+```
+
+Examples of a custom (unimplemented) request:
+
+```js
+picnicClient.sendRequest("GET", "/unknown/route");
+picnicClient.sendRequest("POST", "/invite/friend", { email: "email@email.email" });
+```
+
+## Contributing
+
+If you want to contribute to this project then please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file, and if you like this library then please consider using my discount code [MAAR3267](https://picnic.app/nl/vriendenkorting/MAAR3267) so that we both get a 10 euro discount on our orders. 😄

package/lib/index.d.ts

@@ -0,0 +1,216 @@
+import { ApiConfig, ApiError, Article, Category, ConsentSetting, CountryCode, CustomerServiceContactInfo, Delivery, DeliveryPosition, DeliveryScenario, DeliveryStatus, GetDeliverySlotsResult, ImageSize, LoginResult, MgmDetails, MyStore, Order, OrderStatus, PaymentProfile, ProfileMenu, SearchResult, SetConsentSettingsInput, SetConsentSettingsResult, SingleArticle, SubCategory, SuggestionResult, User, UserInfo, WalletTransaction, WalletTransactionDetails } from "./types/picnic-api";
+declare const _default: {
+    new (options?: ApiConfig): {
+        countryCode: CountryCode;
+        apiVersion: string;
+        authKey: string | null;
+        url: string;
+        /**
+         * Logs the user into picnic to be able to send requests.
+         * @param {string} username The username of the Picnic account.
+         * @param {string} password The password of the Picnic account.
+         */
+        login(username: string, password: string): Promise<LoginResult>;
+        /**
+         * Generates a 2FA code for the user to verify.
+         * @param {string} channel The channel to send the code to. Can be 'SMS' or possibly something else.
+         */
+        generate2FACode(channel: string): Promise<null>;
+        /**
+         * Verifies the 2FA code from the user.
+         * @param {string} code The code to verify.
+         */
+        verify2FACode(code: string): Promise<ApiError | null>;
+        /**
+         * Gets the details of the current logged in user.
+         */
+        getUserDetails(): Promise<User>;
+        /**
+         * Gets information about the user such as toggled features.
+         */
+        getUserInfo(): Promise<UserInfo>;
+        /**
+         * Gets information to display on the profile section.
+         */
+        getProfileMenu(): Promise<ProfileMenu>;
+        /**
+         * Searches in picnic products.
+         * @param {string} query The keywords to search for.
+         */
+        search(query: string): Promise<SearchResult[]>;
+        /**
+         * @deprecated This endpoint seems to be deprecated.
+         */
+        getBundleArticleIds(soleArticleId: string): Promise<string[]>;
+        /**
+         * Returns the full product page. Some digging is required to get the properties you want. The response is not typed as the content seems to be quite dynamic. Good luck!
+         * @param {string} productId The product ID to fetch the page for.
+         */
+        getProductDetailsPage(productId: string): Promise<any>;
+        /**
+         * returns a suggestion on Picnic products matching the query.
+         * @param {string} query The keywords for suggestions.
+         */
+        getSuggestions(query: string): Promise<SuggestionResult[]>;
+        /**
+         * Returns the details of a specific product.
+         * @param {string} productId The id of the product to get.
+         */
+        getArticle(productId: string): Promise<Article>;
+        /**
+         * Retreives product images from the server as an arrayBuffer.
+         * @param {string} imageId The image id to retreive.
+         * @param {ImageSize} size The size of the image to return.
+         */
+        getImage(imageId: string, size: ImageSize): Promise<string>;
+        /**
+         * Retreives product images from the server ad a DataUri.
+         * @param {string} imageId The image id to retreive.
+         * @param {ImageSize} size The size of the image to return.
+         */
+        getImageAsDataUri(imageId: string, size: ImageSize): Promise<string>;
+        /**
+         * Returns the catgories.
+         * @param {number} [depth=0] The category depth of items to retrieve.
+         */
+        getCategories(depth?: number): Promise<MyStore>;
+        /**
+         * Returns the shopping cart information of the user and contents.
+         */
+        getShoppingCart(): Promise<Order>;
+        /**
+         * Adds a product to the shopping cart.
+         * @param {string} productId The id of the product to add.
+         * @param {number} [count=1] The amount of this product to add.
+         */
+        addProductToShoppingCart(productId: string, count?: number): Promise<Order>;
+        /**
+         * Removes a product from the shopping cart.
+         * @param {string} productId The id of the product to remove.
+         * @param {number} [count=1] The amount of this product to remove.
+         */
+        removeProductFromShoppingCart(productId: string, count?: number): Promise<Order>;
+        /**
+         * Clears the shopping cart of the user.
+         */
+        clearShoppingCart(): Promise<Order>;
+        /**
+         * Get all the delivery slots.
+         */
+        getDeliverySlots(): Promise<GetDeliverySlotsResult>;
+        /**
+         * Selects a delivery slot.
+         * @param {string} slotId The id of the delivery slot to be selected.
+         */
+        setDeliverySlot(slotId: string): Promise<Order>;
+        /**
+         * Returns all past and current deliveries of the user.
+         * @param {DeliveryStatus[]} [filter=[]] An array with the statusses of the deliveries to filter on.
+         */
+        getDeliveries(filter?: DeliveryStatus[]): Promise<Delivery[]>;
+        /**
+         * Get the details of one specific delivery.
+         * @param {string} deliveryId The id of the delivery to look up.
+         */
+        getDelivery(deliveryId: string): Promise<Delivery>;
+        /**
+         * Get the position data of one specific delivery. For the route and delivery information, use the scenario call.
+         * @param {string} deliveryId The id of the delivery to look up.
+         */
+        getDeliveryPosition(deliveryId: string): Promise<DeliveryPosition>;
+        /**
+         * Get the driver and route information of the delivery.
+         * @param {string} deliveryId The id of the delivery to look up.
+         */
+        getDeliveryScenario(deliveryId: string): Promise<DeliveryScenario>;
+        /**
+         * Cancels the order with the given delivery id.
+         * @param {string} deliveryId
+         */
+        cancelDelivery(deliveryId: string): Promise<any>;
+        /**
+         * Sets a rating for the delivery from 0 to 10. Will return 400 if a delivery already has a rating.
+         * @param {string} deliveryId
+         * @param {number} rating
+         */
+        setDeliveryRating(deliveryId: string, rating: number): Promise<string>;
+        /**
+         * (Re)sends the invoice email of the delivery.
+         * @param {string} deliveryId
+         */
+        sendDeliveryInvoiceEmail(deliveryId: string): Promise<string>;
+        /**
+         * Returns the status of the order (not delivery) with the given id.
+         * @param {string} orderId
+         */
+        getOrderStatus(orderId: string): Promise<OrderStatus>;
+        /**
+         * Returns all the lists and sublists.
+         * @param {number} [depth=0] The category depth of items to retrieve.
+         */
+        getLists(depth?: number): Promise<Category[]>;
+        /**
+         * Returns the sublists of a list, the articles of a sublist if the subListId is given.
+         * @param {string} listId The id of the list to get.
+         * @param {string} [subListId] The id of the sub list to get.
+         * @param {number} [depth=0] The category depth of items to retrieve.
+         */
+        getList(listId: string, subListId?: string, depth?: number): Promise<SubCategory[] | SingleArticle[]>;
+        /**
+         * Returns the MGM details. This are the friends discount data.
+         */
+        getMgmDetails(): Promise<MgmDetails>;
+        /**
+         * Returns the list of consent settings.
+         * @param {boolean} [general=false] Returns only the 'general' consent settings.
+         */
+        getConsentSettings(general?: boolean): Promise<ConsentSetting[]>;
+        /**
+         * Sets one or multiple consent options to true or false.
+         * @param {SetConsentSettingsInput} consentSettingsInput An array of objects of consent items.
+         */
+        setConsentSettings(consentSettingsInput: SetConsentSettingsInput): Promise<SetConsentSettingsResult>;
+        /**
+         * Returns the popup messages in the app. For example, the message after a delivery, asking if the delivery was satisfactory.
+         */
+        getMessages(): Promise<any>;
+        /**
+         * Returns the reminders.
+         */
+        getReminders(): Promise<any>;
+        /**
+         * Gets payment information.
+         */
+        getPaymentProfile(): Promise<PaymentProfile>;
+        /**
+         * Gets transactions made.
+         * @param {number} pageNumber The page number to get the transactions from.
+         */
+        getWalletTransactions(pageNumber: number): Promise<WalletTransaction[]>;
+        /**
+         * Gets payment information.
+         * @param {string} walletTransactionId The id of the transaction to get the details from.
+         */
+        getWalletTransactionDetails(walletTransactionId: string): Promise<WalletTransactionDetails>;
+        /**
+         * Gets payment information.
+         */
+        getCustomerServiceContactInfo(): Promise<CustomerServiceContactInfo>;
+        /**
+         * Gets parcels.
+         * @todo Implement return type once known.
+         */
+        getParcels(): Promise<any[]>;
+        /**
+         * Can be used to send custom requests that are not implemented but do need authentication for it.
+         * @param {string} method The HTTP method to use, such as GET, POST, PUT and DELETE.
+         * @param {string} path The path, possibly including query params. Example: '/cart/set_delivery_slot' or '/my_store?depth=0'.
+         * @param {TRequestData|null} [data=null] The request body, usually in case of a POST or PUT request.
+         * @param {boolean} [includePicnicHeaders=false] If it should include x-picnic-agent and x-picnic-did headers.
+         * @param {boolean} [isImageRequest=false] Will add the arrayBuffer response type if true.
+         */
+        sendRequest<TRequestData, TResponseData>(method: "GET" | "POST" | "PUT" | "DELETE", path: string, data?: TRequestData | null, includePicnicHeaders?: boolean, isImageRequest?: boolean): Promise<TResponseData>;
+    };
+};
+export = _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,SAAS,EACT,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,cAAc,EACd,WAAW,EACX,0BAA0B,EAC1B,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EAEd,sBAAsB,EACtB,SAAS,EAET,WAAW,EACX,UAAU,EACV,OAAO,EACP,KAAK,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,YAAY,EACZ,uBAAuB,EACvB,wBAAwB,EAExB,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EAER,iBAAiB,EACjB,wBAAwB,EAEzB,MAAM,oBAAoB,CAAC;;mBAiBJ,SAAS;qBAblB,WAAW;oBACZ,MAAM;iBACT,MAAM,GAAG,IAAI;aACjB,MAAM;QAiBX;;;;WAIG;wBACmB,MAAM,YAAY,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAmCrE;;;WAGG;iCACsB,MAAM;QAI/B;;;WAGG;4BACiB,MAAM;QAI1B;;WAEG;0BACe,OAAO,CAAC,IAAI,CAAC;QAI/B;;WAEG;uBACY,OAAO,CAAC,QAAQ,CAAC;QAIhC;;WAEG;0BACe,OAAO,CAAC,WAAW,CAAC;QAItC;;;WAGG;sBACiB,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;QAKpD;;WAEG;2CACsC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAyBnE;;;WAGG;yCACoC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;QAS5D;;;WAGG;8BACmB,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAI1D;;;WAGG;8BACmB,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;QAI/C;;;;WAIG;0BACe,MAAM,QAAQ,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;QAM3D;;;;WAIG;mCAC8B,MAAM,QAAQ,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;QAQ1E;;;WAGG;8BACkB,MAAM,GAAO,OAAO,CAAC,OAAO,CAAC;QAIlD;;WAEG;2BACgB,OAAO,CAAC,KAAK,CAAC;QAIjC;;;;WAIG;4CACiC,MAAM,UAAS,MAAM,GAAO,OAAO,CAAC,KAAK,CAAC;QAI9E;;;;WAIG;iDACsC,MAAM,UAAS,MAAM,GAAO,OAAO,CAAC,KAAK,CAAC;QAInF;;WAEG;6BACkB,OAAO,CAAC,KAAK,CAAC;QAInC;;WAEG;4BACiB,OAAO,CAAC,sBAAsB,CAAC;QAInD;;;WAGG;gCACqB,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAI/C;;;WAGG;+BACmB,cAAc,EAAE,GAAQ,OAAO,CAAC,QAAQ,EAAE,CAAC;QAIjE;;;WAGG;gCACqB,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;QAIlD;;;WAGG;wCAC6B,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;QAIlE;;;WAGG;wCAC6B,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;QAIlE;;;WAGG;mCACwB,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;QAIhD;;;;WAIG;sCAC2B,MAAM,UAAU,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAItE;;;WAGG;6CACkC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAI7D;;;WAGG;gCACqB,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAIrD;;;WAGG;yBACa,MAAM,GAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;QAIhD;;;;;WAKG;wBACa,MAAM,cAAc,MAAM,UAAS,MAAM,GAAO,OAAO,CAAC,WAAW,EAAE,GAAG,aAAa,EAAE,CAAC;QAYxG;;WAEG;yBACc,OAAO,CAAC,UAAU,CAAC;QAIpC;;;WAGG;qCACyB,OAAO,GAAW,OAAO,CAAC,cAAc,EAAE,CAAC;QAIvE;;;WAGG;iDACsC,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;QAIpG;;WAEG;uBACY,OAAO,CAAC,GAAG,CAAC;QAI3B;;WAEG;wBACa,OAAO,CAAC,GAAG,CAAC;QAI5B;;WAEG;6BACkB,OAAO,CAAC,cAAc,CAAC;QAI5C;;;WAGG;0CAC+B,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAIvE;;;WAGG;yDAC8C,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;QAI3F;;WAEG;yCAC8B,OAAO,CAAC,0BAA0B,CAAC;QAIpE;;;WAGG;sBACW,OAAO,CAAC,GAAG,EAAE,CAAC;QAI5B;;;;;;;WAOG;oBACe,YAAY,EAAE,aAAa,UACnC,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,QACnC,MAAM,SACN,YAAY,GAAG,IAAI,yBACH,OAAO,mBACb,OAAO,GACtB,OAAO,CAAC,aAAa,CAAC;;;AAva3B,kBAgcE"}