@dintero/discounts-web-sdk 0.2.4 → 0.2.6

package/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# More details here: https://help.github.com/articles/about-codeowners/
+# Global rule:
+* @frodeaa

package/.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   pull_request:
-    branches: [ master ]
+    branches: [master]
   push:
     branches:
       - master
@@ -11,13 +11,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
-      with:
-        node-version: 'lts/*'
-        cache: npm
-    - name: npm install, build and test
-      run: |
-        npm install
-        npm run test
-        npm run build
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: yarn
+
+      - name: yarn install, build, test and lint
+        run: |
+          yarn install
+          yarn run test
+          yarn run build
+          yarn run lint

package/.github/workflows/release.yml

@@ -18,22 +18,23 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: 'lts/*'
+          node-version: "20.x"
 
-      - name: Install dependencies
+      - name: yarn install, test and lint
         run: |
-          npm install
-          npm run test
+          yarn install
+          yarn run test
+          yarn run lint
 
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
-        run: npm run semantic-release
+        run: yarn run semantic-release

package/.prettierrc.yml

@@ -0,0 +1,8 @@
+printWidth: 80
+tabWidth: 4
+trailingComma: "all"
+overrides:
+  - files:
+      - "*.yml"
+    options:
+      tabWidth: 2

package/README.md

@@ -26,10 +26,10 @@ Make sure to configure the plugin with an API client that only has grants giving
     const container = document.getElementById("checkout-container");
     discounts.embed({
         container: document.getElementById("deals-container"),
-        api:{
-            account: 'P00000000',
-            key: 'public_api_key',
-            secret: 'abcdef01-2345-6789-abcd-ef0123456789',
+        api: {
+            account: "P00000000",
+            key: "public_api_key",
+            secret: "abcdef01-2345-6789-abcd-ef0123456789",
         },
         theme: {
             fontSize: "14px",
@@ -37,7 +37,7 @@ Make sure to configure the plugin with an API client that only has grants giving
             primary: "hotpink",
             secondary: "aqua",
             background: "#fff",
-        }
+        },
     });
 </script>
 ```
@@ -53,11 +53,11 @@ Make sure to configure the plugin with an API client that only has grants giving
     const container = document.getElementById("checkout-container");
     discounts.embed({
         container: document.getElementById("deals-container"),
-        api:{
-            account: 'P00000000',
-            key: 'public_api_key',
-            secret: 'abcdef01-2345-6789-abcd-ef0123456789',
-            discountId: '1234'
+        api: {
+            account: "P00000000",
+            key: "public_api_key",
+            secret: "abcdef01-2345-6789-abcd-ef0123456789",
+            discountId: "1234",
         },
         theme: {
             fontSize: "14px",
@@ -65,7 +65,7 @@ Make sure to configure the plugin with an API client that only has grants giving
             primary: "hotpink",
             secondary: "aqua",
             background: "#fff",
-        }
+        },
     });
 </script>
 ```
@@ -86,37 +86,39 @@ In this example the SDK is supplied with a list of discount objects directly.
             secondary: "aqua",
             background: "#fff",
         },
-        discounts:[{
-            "id": "1",
-            "name": "Testvare",
-            "description": "Beskrivelse av testvare",
-            "requirement": {
-                "item": { "items": [{ "id": "testvare-1" }] },
-                "customer": {},
-                "store_ids": ["*"],
-                "purchase_to": "2030-06-13T21:59:00Z",
-                "purchase_from": "2080-06-06T22:00:00Z"
-            },
-            "limitation": {},
-            "reward": { "type": "discount_item_new_price", "value": 5000 },
-            "created_by": "DinteroTest",
-            "created_at": "2021-06-04T10:21:18.029Z",
-            "updated_at": "2021-06-04T10:21:18.029Z",
-            "receipt_text": "Ukens tilbud",
-            "type": "item",
-            "links": [
-                {
-                    "rel": "medium_discount_image",
-                    "href": "https://uploads-ssl.webflow.com/5f023ba9549ac22870f32943/5f1333ae5a496b0e0476975e_dintero-logo.svg"
-                }
-            ],
-            "metadata": {
-                "label": "Før: 100,-",
-                "subtitle": "Ukens tilbud",
-                "campaign_id": 1
+        discounts: [
+            {
+                id: "1",
+                name: "Testvare",
+                description: "Beskrivelse av testvare",
+                requirement: {
+                    item: { items: [{ id: "testvare-1" }] },
+                    customer: {},
+                    store_ids: ["*"],
+                    purchase_to: "2030-06-13T21:59:00Z",
+                    purchase_from: "2080-06-06T22:00:00Z",
+                },
+                limitation: {},
+                reward: { type: "discount_item_new_price", value: 5000 },
+                created_by: "DinteroTest",
+                created_at: "2021-06-04T10:21:18.029Z",
+                updated_at: "2021-06-04T10:21:18.029Z",
+                receipt_text: "Ukens tilbud",
+                type: "item",
+                links: [
+                    {
+                        rel: "medium_discount_image",
+                        href: "https://uploads-ssl.webflow.com/5f023ba9549ac22870f32943/5f1333ae5a496b0e0476975e_dintero-logo.svg",
+                    },
+                ],
+                metadata: {
+                    label: "Før: 100,-",
+                    subtitle: "Ukens tilbud",
+                    campaign_id: 1,
+                },
+                active: true,
             },
-            "active": true
-        }]
+        ],
     });
 </script>
 ```
@@ -131,7 +133,6 @@ The behaviour of opening links can be adjusted using `linkTarget` in the configu
 
 `_blank` will open the webshop link in a new tab.
 
-
 ```html
 <script type="text/javascript">
     const container = document.getElementById("checkout-container");
@@ -169,8 +170,8 @@ All major modern browsers above version `N - 1`, where `N` is the most recent ve
 ## Building from source
 
 ```bash
-npm install
-npm run build
+yarn install
+yarn run build
 ```
 
 ### Creating a new release

package/dist/declarations/src/index.d.ts

@@ -1,2 +1,2 @@
-import { Configuration, Embed } from "./types";
+import { Configuration, Embed } from "./types.js";
 export declare const embed: (configuration: Configuration) => Promise<Embed>;

package/dist/declarations/src/types.d.ts

@@ -13,21 +13,21 @@ export interface Item {
 export interface Limitation {
     /**
      * Limit the discount to hours of the day
-     * 
+     *
      */
     discount_hours?: {
         /**
          * The timezone identifier for the hour start/end, see
          * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
          * for examples. DST is handled when using a Timezone with DST.
-         * 
+         *
          */
         timezone?: string;
         /**
          * an array of periods, day and time when discount will be
          * available. Multiple periods for one day is accepted.
          * Any hour of purchase is accepted if the array is empty.
-         * 
+         *
          */
         hours: {
             day: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
@@ -46,7 +46,7 @@ export interface Limitation {
     /**
      * Limit the number of rewards to be given in a purchase
      * where multiple receipt items match the requirement
-     * 
+     *
      * example:
      * 1
      */
@@ -54,30 +54,33 @@ export interface Limitation {
     /**
      * Limit how many other discounts can be combined in a purchase
      * where multiple discounts are applicable.
-     * 
+     *
      */
     discount_combination?: -1 | 0;
     /**
      * Limit what items in the purchase is eligible for this discount
-     * 
+     *
      */
-    discount_eligible?: "item_eligible_for_discount" | "item_eligible_for_discount_no_discount" | "receipt_no_discount";
+    discount_eligible?:
+        | "item_eligible_for_discount"
+        | "item_eligible_for_discount_no_discount"
+        | "receipt_no_discount";
     /**
      * Limit how many purchases the discount can be used
-     * 
+     *
      */
     discount_repeat_usage?: number;
     /**
      * Number of days between first and last (exceeding count) stamp
      * where reward will be given
-     * 
+     *
      * example:
      * 100
      */
     stamp_expire_days?: number;
     /**
      * items not eligible for discount.
-     * 
+     *
      */
     blacklist?: Item[];
 }
@@ -93,14 +96,14 @@ export type Links = {
     href: string; // uri
     /**
      * Specifies the relationship between the discount and the link
-     * 
+     *
      * Following `rel` values are reserved for specific usage
-     * 
+     *
      *   - thumbnail_discount_image: link to discount image
      *   - medium_discount_image: link to discount image
      *   - large_discount_image: link to discount image
      *   - webshop: link to site where the discount may be used
-     * 
+     *
      */
     rel?: string;
     /**
@@ -112,12 +115,12 @@ export interface StoreRequirement {
     id?: string[];
     /**
      * name of the store, aka trade name of the store
-     * 
+     *
      */
     name?: string[];
     /**
      * Official name of the person or entity that owns the store.
-     * 
+     *
      */
     business_name?: string[];
     /**
@@ -148,14 +151,14 @@ export interface StoreRequirement {
     /**
      * A four-digit Merchant Category Code (MCC) for the store
      * [ISO 18245:2003](https://www.iso.org/standard/33365.html)
-     * 
+     *
      */
-    mcc?: string /* iso-18245 */ [];
+    mcc?: string /* iso-18245 */[];
     /**
      * Ranges of MCC codes to accept the discount for.
      * Multiple ranges are possible.
      * Prefer `mcc` if not a range.
-     * 
+     *
      */
     mcc_ranges?: {
         /**
@@ -172,13 +175,13 @@ export interface StoreRequirement {
     /**
      * Merchant number associated with the stores
      * payment terminal
-     * 
+     *
      */
     bax?: string[];
     /**
      * Id to a specific point-of-sale (POS) terminal
      * or workstation
-     * 
+     *
      */
     terminal_id?: string[];
 }
@@ -186,7 +189,7 @@ export interface ItemMixProperty {
     /**
      * Acceptable items for the mix "item" (`any`). No wildcard `*` is
      * accepted.
-     * 
+     *
      * example:
      * [object Object],[object Object]
      */
@@ -204,14 +207,14 @@ export interface ItemMixProperty {
     }[];
     /**
      * minimum quantity of given item (match by id or group) by the mix
-     * 
+     *
      */
     quantity: number;
     /**
      * The item will be eligible for discount when calculating the reward
      * Example: The value of `discount_item_new_price` reward will be the
      * total price of all items in a mix that has the applicable set to `true`
-     * 
+     *
      */
     reward_eligible: boolean;
 }
@@ -249,7 +252,7 @@ export interface CustomerRequirement {
     }[];
     /**
      * Require customer to be a company matching all properties defined.
-     * 
+     *
      */
     company?: {
         /**
@@ -340,7 +343,7 @@ export interface CustomerRequirement {
      * limit discount to only receipt where customer status
      * is included in the receipt and match one of the status
      * values required by the discount
-     * 
+     *
      * example:
      * vip
      */
@@ -355,23 +358,23 @@ export interface Requirement {
     item?: {
         /**
          * minimum number of items
-         * 
+         *
          */
         quantity?: number;
         /**
          * Required mix items for the discount.
-         * 
+         *
          * A purchase must include `all` the items to fulfill the `item.mixes`
          * requirement.
-         * 
+         *
          */
         mixes?: ItemMixProperty[];
         /**
          * Required items for the discount
-         * 
+         *
          * A purchase can include `any` of the items to fulfill the `item.items`
          * requirement.
-         * 
+         *
          */
         items?: Item[];
     };
@@ -379,18 +382,18 @@ export interface Requirement {
     /**
      * Minimum gross amount on purchase.
      * Monetary amount in smallest unit for the currency
-     * 
+     *
      */
     gross_amount?: number;
     /**
      * List of valid currencies, or `[{"anything-but": ["NOK"]}]` to exclude currencies.
      * Currency format is the three-character [ISO-4217 currency](https://en.wikipedia.org/wiki/ISO_4217).
-     * 
+     *
      */
     currencies?: any[];
     /**
      * Stamp count required for the reward
-     * 
+     *
      * example:
      * 5
      */
@@ -399,7 +402,7 @@ export interface Requirement {
      * A code required for the reward. The purchase must include the
      * promotion code in the `receipt.discount_code` property or as
      * an `receipt.item` where the `item.id` is the promotion code.
-     * 
+     *
      * example:
      * TACO
      */
@@ -410,7 +413,7 @@ export interface Requirement {
 }
 export interface Reward {
     /**
-     * 
+     *
      * Reward Type:
      *   * `discount_amount` - value as discount
      *   * `discount_percent` - value percentage of gross amount
@@ -423,18 +426,25 @@ export interface Reward {
      *     purchase will be available in future purchases (if not limited by usage)
      *   * `discount_mix_new_price` - discount as old mix total value (reward_eligible=true)
      *     subtracted with value
-     * 
+     *
      */
-    type: "discount_amount" | "discount_percent" | "discount_item_new_price" | "discount_item_quantity" | "discount_item_percent" | "discount_mix_new_price" | "discount_debit";
+    type:
+        | "discount_amount"
+        | "discount_percent"
+        | "discount_item_new_price"
+        | "discount_item_quantity"
+        | "discount_item_percent"
+        | "discount_mix_new_price"
+        | "discount_debit";
     /**
      * The reward value, unit of the value is resolved
      * from the reward type
-     * 
+     *
      * Examples:
      *   - Percent: 10.5
      *   - Amount: 10000 (amount in smallest unit for the currency)
      *   - Quantity: 1
-     * 
+     *
      * example:
      * 10000
      */
@@ -442,45 +452,45 @@ export interface Reward {
     /**
      * Let the discount reward be calculated from net or gross price.
      * Not applicable for `discount_item_new_price`
-     * 
+     *
      * *Example*:
      *   item A à 100,- NOK with existing rebate of 20,-
-     * 
+     *
      *   - 10% net reward is 10% of 80,- : 8,-
      *   - 10% gross reward is 10% of 100,- : 10,-
-     * 
+     *
      *   * *net*: `gross - "any existing discounts"`
      *   * *gross*: `"total expense amount, including taxes"`
-     * 
+     *
      */
     base?: "net" | "gross";
 }
 export interface Discount {
     /**
      * An UUID that uniquely identifies the resource
-     * 
+     *
      */
     readonly id?: string; // uuid
     /**
      * The date-time when the resource was created
-     * 
+     *
      */
     readonly created_at?: string; // date-time
     /**
      * The ID of the user/client created the resource
-     * 
+     *
      * example:
      * 1c92f7e1-2897-4d46-bdcc-c127a914fb4e
      */
     readonly created_by?: string;
     /**
      * The date-time when the resource was last updated
-     * 
+     *
      */
     readonly updated_at?: string; // date-time
     /**
      * The ID of the user/client created the resource
-     * 
+     *
      * example:
      * 1c92f7e1-2897-4d46-bdcc-c127a914fb4e
      */
@@ -488,24 +498,24 @@ export interface Discount {
     readonly deleted_at?: string; // date-time
     /**
      * The campaign the rule belongs to
-     * 
+     *
      */
     campaign_id?: string;
     /**
      * the discount is active and can be available
      * for purchase (if given to any or all customers)
-     * 
+     *
      */
     active?: boolean;
     /**
      * the discount will be exluded from  public discount collection
      * (GET /discounts/public/rules).
-     * 
+     *
      */
     private?: boolean;
     /**
      * The ID of the user/client that last updated the resource
-     * 
+     *
      * example:
      * 3d1e4824-5474-48e7-a369-4f603fa4c5b8
      */
@@ -522,7 +532,7 @@ export interface Discount {
     /**
      * Text that should be used when displaying
      * the discount, e.g. on receipt
-     * 
+     *
      * example:
      * Mai Salg
      */
@@ -532,7 +542,7 @@ export interface Discount {
      * given date. Default behavior is to only return
      * discount to the customer where the current time
      * is between purchase_from and purchase_to
-     * 
+     *
      */
     visible_from?: string; // date-time
     /**
@@ -545,53 +555,52 @@ export interface Discount {
     reward: Reward;
     /**
      * Additional metadata about the discount
-     * 
+     *
      * example:
      * [object Object]
      */
     metadata?: {
-        [key: string]: any
+        [key: string]: any;
     };
     links?: Links;
 }
 
 export type Theme = {
-    color?: string,
-    background?: string,
-    primary?: string,
-    secondary?: string,
-    borderRadius?: string,
-    fontSize?: string,
-}
+    color?: string;
+    background?: string;
+    primary?: string;
+    secondary?: string;
+    borderRadius?: string;
+    fontSize?: string;
+};
 
 export type Configuration = {
-    container: HTMLElement,
-    language?: string,
+    container: HTMLElement;
+    language?: string;
     currency?: {
-        value: string
-        position: 'prefix' | 'suffix',
-        exponent: 2
-    },
-    theme?: Theme,
+        value: string;
+        position: "prefix" | "suffix";
+        exponent: 2;
+    };
+    theme?: Theme;
     api?: {
-        account: string,
-        key: string,
-        secret: string,
-        url: string,
-        limit?: number,
-        discountId?: string,
-    }
-    linkTarget?: '_blank' | '_self', 
-    version?: string,
-    discounts?: Discount[] ,
-
-}
+        account: string;
+        key: string;
+        secret: string;
+        url: string;
+        limit?: number;
+        discountId?: string;
+    };
+    linkTarget?: "_blank" | "_self";
+    version?: string;
+    discounts?: Discount[];
+};
 
 type TokenResponse = {
-    access_token: string,
-    token_type: string
-}
+    access_token: string;
+    token_type: string;
+};
 
 export type Embed = {
     destroy: () => void;
-}
+};