@tillhub/schemas 6.319.0 → 6.321.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [6.321.0](https://github.com/tillhub/schemas/compare/v6.320.0...v6.321.0) (2024-06-20)
+
+
+### Features
+
+* **promotions:** rename compiled js field ([60eaeba](https://github.com/tillhub/schemas/commit/60eaeba))
+* **transactions:** promotions ([1505e0b](https://github.com/tillhub/schemas/commit/1505e0b))
+
+# [6.320.0](https://github.com/tillhub/schemas/compare/v6.319.0...v6.320.0) (2024-06-20)
+
+
+### Features
+
+* **promotion:** add new promotion type ([#968](https://github.com/tillhub/schemas/issues/968)) ([8ed6a0a](https://github.com/tillhub/schemas/commit/8ed6a0a))
+
 # [6.319.0](https://github.com/tillhub/schemas/compare/v6.318.0...v6.319.0) (2024-06-17)
 
 

package/lib/v1/balances/legacy/embedded/payments/base.js

@@ -26,6 +26,13 @@ module.exports = {
       example: '5ad2351d-9a67-45f9-ad4f-0abcbefa9037',
       description: 'The payment_option ressource id'
     },
+    payment_option_id: {
+      ...oneOf({
+        type: 'integer',
+        example: 131,
+        description: 'Legacy id of the payment option'
+      })
+    },
     payment_option_name: {
       ...oneOf({
         type: 'string',
@@ -88,6 +95,13 @@ module.exports = {
         example: 1850,
         description: 'The daily discrepancy between calculated and counted amounts, POS: counted - calculated, not available anymore for non-cash types (e.g. terminal) (in cent-format: 1267 == 12.67€)'
       })
+    },
+    exchangeRate: {
+      ...oneOf({
+        type: 'number',
+        example: 1.403,
+        description: 'Exchange rate of the payment option, not used.'
+      })
     }
   }
 }

package/lib/v1/promotions/template/index.js

@@ -17,14 +17,71 @@ module.exports = {
           ]
         },
         inputs: {
-          oneOf: [
-            {
-              type: 'object'
+          type: 'object',
+          required: [
+            'repeatable_promotable',
+            'promotable_product',
+            'bundle_junctions',
+            'output'
+          ],
+          properties: {
+            repeatable_promotable: {
+              type: 'boolean'
+            },
+            promotable_product: {
+              required: ['property', 'value', 'qty'],
+              properties: {
+                property: {
+                  type: 'string'
+                },
+                value: {
+                  type: 'string'
+                },
+                qty: {
+                  type: 'number'
+                }
+              }
             },
-            {
-              type: 'null'
+            bundle_junctions: {
+              type: 'array',
+              uniqueItems: true,
+              additionalItems: false,
+              minItems: 2,
+              maxItems: 2,
+              items: {
+                required: ['type', 'property', 'value'],
+                properties: {
+                  property: { // its only assumed that the property is id
+                    type: 'string'
+                  },
+                  value: {
+                    type: 'array'
+                  },
+                  qty: { // only needs for type = product
+                    type: 'number'
+                  },
+                  type: {
+                    type: 'string',
+                    enum: ['product', 'product_group']
+                  }
+                }
+              }
+            },
+            output: {
+              type: 'object',
+              required: ['property', 'value'],
+              properties: {
+                property: {
+                  type: 'string',
+                  enum: ['amount_total_gross', 'percentage_discount', 'amount_discount']
+
+                },
+                value: {
+                  type: 'number'
+                }
+              }
             }
-          ]
+          }
         }
       }
     },
@@ -43,14 +100,71 @@ module.exports = {
           ]
         },
         inputs: {
-          oneOf: [
-            {
-              type: 'object'
+          type: 'object',
+          required: [
+            'repeatable_promotable',
+            'promotable_product',
+            'bundle_junctions',
+            'output'
+          ],
+          properties: {
+            repeatable_promotable: {
+              type: 'boolean'
+            },
+            promotable_product: {
+              required: ['property', 'value', 'qty'],
+              properties: {
+                property: {
+                  type: 'string'
+                },
+                value: {
+                  type: 'string'
+                },
+                qty: {
+                  type: 'number'
+                }
+              }
+            },
+            bundle_junctions: {
+              type: 'array',
+              maxItems: 1,
+              minItems: 1,
+              uniqueItems: true,
+              additionalItems: false,
+              items: {
+                required: ['type', 'property', 'value', 'qty'],
+                properties: {
+                  property: {
+                    type: 'string'
+                  },
+                  value: {
+                    type: 'string'
+                  },
+                  qty: {
+                    type: 'number'
+                  },
+                  type: {
+                    type: 'string',
+                    enum: ['product']
+                  }
+                }
+              }
             },
-            {
-              type: 'null'
+            output: {
+              type: 'object',
+              required: ['property', 'value'],
+              properties: {
+                property: {
+                  type: 'string',
+                  enum: ['amount_total_gross', 'percentage_discount', 'amount_discount']
+
+                },
+                value: {
+                  type: 'number'
+                }
+              }
             }
-          ]
+          }
         }
       }
     },
@@ -71,39 +185,37 @@ module.exports = {
         inputs: {
           type: 'object',
           required: [
-            'promotable_products',
-            'promotable_product_groups',
+            'promotable_product',
+            'required_amount',
+            'promotable_product_group',
             'output'
           ],
           properties: {
-            promotable_products: {
-              type: 'array',
-              items: {
-                required: ['property', 'value'],
-                properties: {
-                  property: {
-                    type: 'string'
-                  },
-                  value: {
-                    type: 'string'
-                  }
+            promotable_product: {
+              required: ['property', 'value'],
+              properties: {
+                property: {
+                  type: 'string'
+                },
+                value: {
+                  type: 'array'
                 }
               }
             },
-            promotable_product_groups: {
-              type: 'array',
-              items: {
-                required: ['property', 'value'],
-                properties: {
-                  property: {
-                    type: 'string'
-                  },
-                  value: {
-                    type: 'string'
-                  }
+            promotable_product_group: {
+              required: ['property', 'value'],
+              properties: {
+                property: {
+                  type: 'string'
+                },
+                value: {
+                  type: 'array'
                 }
               }
             },
+            required_amount: {
+              type: 'number'
+            },
             output: {
               type: 'object',
               required: ['property', 'value'],
@@ -114,7 +226,7 @@ module.exports = {
 
                 },
                 value: {
-                  type: 'string'
+                  type: 'number'
                 }
               }
             }

package/lib/v1/transactions/components/embedded/promotions/base.js

@@ -0,0 +1,26 @@
+const { oneOf } = require('../../../../../helpers/payload-or-null')
+
+module.exports = {
+  description: 'Promotion details applied on a transaction',
+  additionalProperties: false,
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      format: 'uuid',
+      example: 'AB3847a66-97dc-4ac2-8e8a-c44920e1f22f',
+      description: 'Identifier of the promotion used.'
+    },
+    name: oneOf({
+      type: 'string',
+      example: 'Summer Sale',
+      maxLength: 128,
+      description: 'Name of the promotion.'
+    }),
+    compiled: {
+      type: 'string',
+      example: 'IWZ1bmN0aW9uKHQpe2lmKCJvYmplY3QiPT10eXBlb2YgZXhwb3J0cyYmInVuZGVmaW5lZCIhPXR5cGVvZiBtb2R1bGUpbW9kdWxlLmV4cG9ydHM9dCgpO2Vsc2UgaWYoImZ1bmN0aW9uIj09dHlwZW9mIGRlZmluZSYmZGVmaW5lLmFtZClkZWZpbmUoW10sdCk7ZWxzZXsoInVuZGVmaW5lZCIhPXR5cGVvZiB3aW5kb3c/d2luZG93OiJ1bmRlZmluZWQiIT10eXBlb2YgZ2xvYmFsP2dsb2JhbDoidW5kZWZpbmVkIiE9dHlwZW9mIHNlbGY/c2VsZjp0aGlzKS5tYWluPXQoKX19KGZ1bmN0aW9uKCl7cmV0dXJuIGZ1bmN0aW9uKCl7cmV0dXJuIGZ1bmN0aW9uIHQoZSxvLHIpe2Z1bmN0aW9uIG4odSxpKXtpZighb1t1XSl7aWYoIWVbdV0pe3ZhciBzPSJmdW5jdGlvbiI9PXR5cGVvZiByZXF1aXJlJiZyZXF1aXJlO2lmKCFpJiZzKXJldHVybiBzKHUsITApO2lmKGYpcmV0dXJuIGYodSwhMCk7dmFyIGw9bmV3IEVycm9yKCJDYW5ub3QgZmluZCBtb2R1bGUgJyIrdSsiJyIpO3Rocm93IGwuY29kZT0iTU9EVUxFX05PVF9GT1VORCIsbH12YXIgYT1vW3VdPXtleHBvcnRzOnt9fTtlW3VdWzBdLmNhbGwoYS5leHBvcnRzLGZ1bmN0aW9uKHQpe3JldHVybiBuKGVbdV1bMV1bdF18fHQpfSxhLGEuZXhwb3J0cyx0LGUsbyxyKX1yZXR1cm4gb1t1XS5leHBvcnRzfWZvcih2YXIgZj0iZnVuY3Rpb24iPT10eXBlb2YgcmVxdWlyZSYmcmVxdWlyZSx1PTA7dTxyLmxlbmd0aDt1KyspbihyW3VdKTtyZXR1cm4gbn19KCkoezE6W2Z1bmN0aW9uKHQsZSxvKXsidXNlIHN0cmljdCI7ZS5leHBvcnRzPWZ1bmN0aW9uKCl7bGV0IHQ9YXJndW1lbnRzLmxlbmd0aD4wJiZ2b2lkIDAhPT1hcmd1bWVudHNbMF0/YXJndW1lbnRzWzBdOntpdGVtczpbXX07Y29uc3QgZT1bXSxvPVtdO2xldCByPTAsbj0wO2lmKHQuaXRlbXMuZm9yRWFjaCh0PT57IjFlMjcwNTNmLWZmZDEtNDk3Mi05YjEzLTdlMTBlNWJjODkwYyI9PT10LnByb2R1Y3RfaWQmJihyKz10LnF0eSksIjFlMjcwNTNmLWZmZDEtNDk3Mi05YjEzLTdlMTBlNWJjODkwYyI9PT10LnByb2R1Y3RfaWQmJihuKz10LnF0eSxlLnB1c2goT2JqZWN0LmFzc2lnbih7fSx0KSkpfSksIWUubGVuZ3RoKXJldHVybiBvO2NvbnN0IGY9ZnVuY3Rpb24odCxlLG8scil7cmV0dXJuIHIuYW1vdW50X3RvdGFsX2dyb3NzLHIucXR5LDV9KDAsMCwwLGVbMF0pLHU9TWF0aC5mbG9vcihyLzEpLGk9TWF0aC5mbG9vcihuLzEpO2xldCBzPXU8PWk/dTppO2lmKCEocz1NYXRoLmZsb29yKG4vMikpKXJldHVybiBvO2xldCBsPTA7Zm9yKGxldCB0IG9mIGUpe2NvbnN0IGU9dC5xdHk7aWYoIShNYXRoLmNlaWwoKGwrdC5xdHkpLzEpPD1zKSl7aWYobHx8cyl7Y29uc3Qgcj0xKnMtbCxuPXIqZix1PShlLXIpKih0LmFtb3VudF90b3RhbF9ncm9zcy9lKTt0LnByb21vdGVkX3RvdGFsX2dyb3NzPWEobit1LDIpLHQucHJvbW90YWJsZV9xdHk9cixkZWxldGUgdC5hbW91bnRfdG90YWxfZ3Jvc3Msby5wdXNoKHQpLHM9MH1icmVha31zLT1NYXRoLmZsb29yKChsK2UpLzEpLGw9KGwrZSklMSx0LnByb21vdGVkX3RvdGFsX2dyb3NzPWEoZSpmLDIpLHQucHJvbW90YWJsZV9xdHk9ZSxkZWxldGUgdC5hbW91bnRfdG90YWxfZ3Jvc3Msby5wdXNoKHQpfXJldHVybiBvO2Z1bmN0aW9uIGEodCxlKXtyZXR1cm4gTnVtYmVyKE1hdGgucm91bmQodCsiZSIrZSkrImUtIitlKX19fSx7fV19LHt9LFsxXSkoMSl9KTs=',
+      description: 'Base64 of the promotion function'
+    }
+  }
+}

package/lib/v1/transactions/legacy/base.js

@@ -6,6 +6,7 @@ const relatedObject = require('../components/embedded/reference/related')
 const dependsObject = require('../components/embedded/reference/depends')
 const originObject = require('../components/embedded/reference/origin')
 const gastroOrderOrigin = require('../../../common/gastro_order_origin')
+const promotionObject = require('../components/embedded/promotions/base')
 
 module.exports = {
   dev_uuid: {
@@ -372,6 +373,17 @@ module.exports = {
     default: false,
     description: 'If true, the transaction contains items modified by the promotion engine'
   }),
+  applied_promotions: oneOf({
+    type: 'array',
+    description: stripIndents`
+    A list of Tillhub promotion details applied to this transaction.
+
+    V3 promotions will have only 1 entry as they are restricted by a barcode match.
+    `,
+    items: {
+      ...promotionObject
+    }
+  }),
   branch: oneOf({
     type: 'string',
     format: 'uuid',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.319.0",
+  "version": "6.321.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",