@tillhub/schemas 6.456.0 → 6.457.0

package/lib/v1/configurations/items/features.js

@@ -374,6 +374,49 @@ module.exports = oneOf({
           }
         })
       }
+    }),
+    press_item_barcode: oneOf({
+      description: 'German press products carry their retail price and VAT class inside the EAN-13 barcode, so they can be sold without being maintained in the catalog.',
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        enabled: {
+          description: 'Specifies if the feature is available. When false, behaviour is identical to a client without the feature.',
+          type: 'boolean',
+          default: false
+        },
+        lookup_priority: {
+          description: 'Which side is asked first for a scanned code, i.e. which article carries the line. \'catalog_first\' searches the catalog and decodes only what it does not find, \'barcode_first\' decodes before searching. An unrecognised value falls back to the default.',
+          type: 'string',
+          enum: [
+            'catalog_first',
+            'barcode_first'
+          ],
+          default: 'catalog_first'
+        },
+        price_source_on_catalog_hit: {
+          description: 'Which price is booked when a decodable press code also matches a catalog article. \'barcode\' charges the encoded amount and uses the article\'s own price only as the value it is compared against, \'catalog\' charges the article\'s own price and falls back to the encoded amount when it has none. A disagreement between the two is logged under either setting. The field is inert wherever no catalog hit occurs, which includes every scan under \'barcode_first\' - that combination is contradictory but not an error and must not be rejected. An unrecognised value falls back to the default.',
+          type: 'string',
+          enum: [
+            'barcode',
+            'catalog'
+          ],
+          default: 'barcode'
+        },
+        products: {
+          description: 'Maps a press prefix to the uuid of the fallback article that supplies VAT and accounting information for that prefix. The supported prefixes are the keys, not a fixed set, so adding one needs no client release. Enabled with an empty map is equivalent to disabled.',
+          type: 'object',
+          additionalProperties: false,
+          patternProperties: {
+            '^[0-9]{3}$': {
+              description: 'Uuid of the fallback article for this press prefix.',
+              type: 'string',
+              format: 'uuid'
+            }
+          },
+          default: {}
+        }
+      }
     })
   }
 })

package/lib/v1/configurations/items/interfaces.js

@@ -1,262 +1,257 @@
 const { oneOf } = require('../../../helpers/payload-or-null')
 
 module.exports = {
-  anyOf: [
-    {
-      type: 'null'
-    },
-    {
+  type: ['object', 'null'],
+  additionalProperties: false,
+  properties: {
+    scanner_apis: {
       type: 'object',
-      additionalProperties: false,
+      default: {},
       properties: {
-        scanner_apis: {
+        zebra: {
           type: 'object',
+          default: {},
           properties: {
-            zebra: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: false
-                },
-                background_release_seconds: {
-                  description: 'The time in seconds that the scanner will stay connected when the app is send to the background (for other apps to grab afterwards)',
-                  type: 'integer',
-                  example: 15,
-                  minimum: 0,
-                  maximum: 30, // to be on the safe side of Apple
-                  default: 25
-                }
-              }
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            epson: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                background_release_seconds: {
-                  description: 'The time in seconds that the scanner will stay connected when the app is send to the background (for other apps to grab afterwards)',
-                  type: 'integer',
-                  example: 15,
-                  minimum: 0,
-                  maximum: 30, // to be on the safe side of Apple
-                  default: 25
-                }
-              }
+            background_release_seconds: {
+              description: 'The time in seconds that the scanner will stay connected when the app is send to the background (for other apps to grab afterwards)',
+              type: 'integer',
+              example: 15,
+              minimum: 0,
+              maximum: 30, // to be on the safe side of Apple
+              default: 25
             }
           }
         },
-        printer_apis: {
+        epson: {
           type: 'object',
           properties: {
-            epson: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                pre_connect: oneOf({
-                  description: 'Try connecting to the printer without an actual printing task',
-                  type: 'array',
-                  items: {
-                    description: 'Views or conditions where a printer connection is tried just in case',
-                    type: 'string',
-                    enum: [
-                      'payment_view'
-                    ]
-                  }
-                }),
-                allow_force_narrow: oneOf({
-                  description: 'Potentially allow forcing 60mm-print on 80mm-printers via UI toggle ',
-                  type: 'boolean',
-                  default: false
-                })
-              }
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            epson_fp_it: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: false
-                }
+            background_release_seconds: {
+              description: 'The time in seconds that the scanner will stay connected when the app is send to the background (for other apps to grab afterwards)',
+              type: 'integer',
+              example: 15,
+              minimum: 0,
+              maximum: 30, // to be on the safe side of Apple
+              default: 25
+            }
+          }
+        }
+      }
+    },
+    printer_apis: {
+      type: 'object',
+      properties: {
+        epson: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
+            },
+            pre_connect: oneOf({
+              description: 'Try connecting to the printer without an actual printing task',
+              type: 'array',
+              items: {
+                description: 'Views or conditions where a printer connection is tried just in case',
+                type: 'string',
+                enum: [
+                  'payment_view'
+                ]
               }
+            }),
+            allow_force_narrow: oneOf({
+              description: 'Potentially allow forcing 60mm-print on 80mm-printers via UI toggle ',
+              type: 'boolean',
+              default: false
+            })
+          }
+        },
+        epson_fp_it: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: false
             }
           }
+        }
+      }
+    },
+    terminal_apis: {
+      type: 'object',
+      properties: {
+        adyen: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
+            },
+            webserver: oneOf({
+              description: 'Defines which webserver implementation to use for secondary cashier messages (terminal -> POS)',
+              type: 'string',
+              enum: [
+                'none', // messages will not be visible on the POS but overall functionality is not affected
+                'criollo', // there have been issues (BSH)
+                'telegraph' // more stable than criollo
+              ],
+              default: 'telegraph'
+            }),
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
         },
-        terminal_apis: {
+        concardis: {
           type: 'object',
           properties: {
-            adyen: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                webserver: oneOf({
-                  description: 'Defines which webserver implementation to use for secondary cashier messages (terminal -> POS)',
-                  type: 'string',
-                  enum: [
-                    'none', // messages will not be visible on the POS but overall functionality is not affected
-                    'criollo', // there have been issues (BSH)
-                    'telegraph' // more stable than criollo
-                  ],
-                  default: 'telegraph'
-                }),
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            concardis: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
+        },
+        opi: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            opi: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                swiss: oneOf({
-                  description: 'Defines if swiss-specific handling of the OPI protocol will be used',
-                  type: 'boolean',
-                  default: false
-                }),
-                omit_amount_on_reversals: oneOf({
-                  description: 'Defines if amount can be omitted in reversals',
-                  type: 'boolean',
-                  default: false
-                }),
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 1.0 // defaults to 3.0 if Swiss
-                }),
-                language_code: oneOf({
-                  type: 'string',
-                  description: 'Language code send in card service requests. ISO 639-1:2002.',
-                  example: 'de',
-                  minLength: 2,
-                  maxLength: 2,
-                  default: null // fallback is defined by the current POS language
-                })
-              }
+            swiss: oneOf({
+              description: 'Defines if swiss-specific handling of the OPI protocol will be used',
+              type: 'boolean',
+              default: false
+            }),
+            omit_amount_on_reversals: oneOf({
+              description: 'Defines if amount can be omitted in reversals',
+              type: 'boolean',
+              default: false
+            }),
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 1.0 // defaults to 3.0 if Swiss
+            }),
+            language_code: oneOf({
+              type: 'string',
+              description: 'Language code send in card service requests. ISO 639-1:2002.',
+              example: 'de',
+              minLength: 2,
+              maxLength: 2,
+              default: null // fallback is defined by the current POS language
+            })
+          }
+        },
+        sumup: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            sumup: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
+        },
+        tim: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            tim: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
+        },
+        spos: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            spos: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
+        },
+        softpay: {
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            softpay: {
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
+          }
+        },
+        ZVT: { // capitalized for historical reasons
+          type: 'object',
+          properties: {
+            enabled: {
+              type: 'boolean',
+              default: true
             },
-            ZVT: { // capitalized for historical reasons
-              type: 'object',
-              properties: {
-                enabled: {
-                  type: 'boolean',
-                  default: true
-                },
-                inter_call_delay_seconds: oneOf({
-                  type: 'number',
-                  description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
-                  minimum: 0.0,
-                  maximum: 10.0,
-                  multipleOf: 0.001,
-                  default: 0.0
-                })
-              }
-            }
+            inter_call_delay_seconds: oneOf({
+              type: 'number',
+              description: 'Artificial delay between a previous terminal response and the next terminal request when performed automatically (some devices require additional cooldowns to avoid \'busy\' states)',
+              minimum: 0.0,
+              maximum: 10.0,
+              multipleOf: 0.001,
+              default: 0.0
+            })
           }
         }
       }
     }
-  ]
+  }
 }

package/lib/v1/configurations/items/receipts.js

@@ -148,6 +148,11 @@ const cartReceipt = {
       type: 'boolean',
       default: true
     }),
+    print_barcode: oneOf({
+      description: 'Defines if the scanned barcode of a press item is printed on the specific receipt, as its own line below the product name. It governs press lines booked against a titled article, whose own name already identifies them. A line booked against one of the generic press fallback articles configured in features.press_item_barcode.products prints its barcode regardless of this flag, because the barcode is the only thing that tells two such lines apart. Defaults to true like print_serial_number, and is inert until that prefix map is populated. Per-receipt-type defaults are applied by the client, since this object is shared by every cart receipt type.',
+      type: 'boolean',
+      default: true
+    }),
     print_service_question_answers: oneOf({
       description: 'States if the product customization answers and questions will be printed',
       type: 'boolean',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tillhub/schemas",
-  "version": "6.456.0",
+  "version": "6.457.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",
@@ -17,7 +17,8 @@
     "clean": "rm -rf coverage coverage.lcov .nyc_output",
     "deploy:static": "firebase deploy --only=hosting",
     "compile": "node compile",
-    "new:schema": "hygen schema with-prompt"
+    "new:schema": "hygen schema with-prompt",
+    "commitlint": "commitlint --from origin/master --to HEAD --verbose"
   },
   "repository": {
     "type": "git",
@@ -51,6 +52,8 @@
   ],
   "homepage": "https://github.com/tillhub/schemas#readme",
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",

package/test/configurations/configurations.v1.spec.js

@@ -185,3 +185,156 @@ test('Configurations: payloads without opening_hours_exceptions remain valid', f
   t.ok(valid, ajv.errorsText(validateUpdatePayload.errors))
   t.end()
 })
+
+test('Configurations: interfaces seeds scanner_apis.zebra.enabled when scanner_apis is absent', function (t) {
+  t.plan(2)
+  const ajvWithDefaults = new Ajv({ useDefaults: true })
+  const validateCreatePayload = ajvWithDefaults.compile(require('../../lib/v1/configurations').create.request)
+  const payload = {
+    name: 'Default Configurations',
+    owner: 'self',
+    interfaces: {
+      terminal_apis: {
+        opi: { enabled: true },
+        tim: { enabled: true },
+        adyen: { enabled: true },
+        sumup: { enabled: true },
+        concardis: { enabled: true }
+      }
+    }
+  }
+  const valid = validateCreatePayload(payload)
+
+  t.ok(valid, ajvWithDefaults.errorsText(validateCreatePayload.errors))
+  t.deepEquals(payload.interfaces.scanner_apis, {
+    zebra: {
+      enabled: true,
+      background_release_seconds: 25
+    }
+  }, 'zebra is enabled by default')
+  t.end()
+})
+
+test('Configurations: interfaces keeps an explicitly disabled zebra scanner', function (t) {
+  t.plan(2)
+  const ajvWithDefaults = new Ajv({ useDefaults: true })
+  const validateCreatePayload = ajvWithDefaults.compile(require('../../lib/v1/configurations').create.request)
+  const payload = {
+    name: 'Default Configurations',
+    owner: 'self',
+    interfaces: {
+      scanner_apis: {
+        zebra: { enabled: false }
+      }
+    }
+  }
+  const valid = validateCreatePayload(payload)
+
+  t.ok(valid, ajvWithDefaults.errorsText(validateCreatePayload.errors))
+  t.notOk(payload.interfaces.scanner_apis.zebra.enabled, 'explicit value wins over the default')
+  t.end()
+})
+
+test('Configurations: interfaces still accepts null', function (t) {
+  t.plan(2)
+  const validCreate = ajv.compile(require('../../lib/v1/configurations').create.request)({
+    name: 'Default Configurations',
+    owner: 'self',
+    interfaces: null
+  })
+  t.ok(validCreate, 'null interfaces is valid on create')
+
+  const validUpdate = validateUpdatePayload({ interfaces: null })
+  t.ok(validUpdate, ajv.errorsText(validateUpdatePayload.errors))
+  t.end()
+})
+
+const pressUuid = '5b1b1b1b-1b1b-4b1b-8b1b-1b1b1b1b1b1b'
+
+test('Configurations: press_item_barcode accepts the documented contract', function (t) {
+  t.plan(1)
+  const valid = validateUpdatePayload({
+    features: {
+      press_item_barcode: {
+        enabled: false,
+        lookup_priority: 'catalog_first',
+        price_source_on_catalog_hit: 'barcode',
+        products: {
+          414: pressUuid,
+          419: pressUuid,
+          434: pressUuid,
+          439: pressUuid
+        }
+      }
+    }
+  })
+  t.ok(valid, ajv.errorsText(validateUpdatePayload.errors))
+  t.end()
+})
+
+test('Configurations: press_item_barcode accepts a prefix the client does not know', function (t) {
+  t.plan(1)
+  const valid = validateUpdatePayload({
+    features: {
+      press_item_barcode: { enabled: true, products: { 444: pressUuid } }
+    }
+  })
+  t.ok(valid, 'the supported prefixes are the map keys, so a new one needs no schema change')
+  t.end()
+})
+
+test('Configurations: press_item_barcode accepts barcode_first with a catalog-hit price source', function (t) {
+  t.plan(1)
+  const valid = validateUpdatePayload({
+    features: {
+      press_item_barcode: {
+        lookup_priority: 'barcode_first',
+        price_source_on_catalog_hit: 'catalog'
+      }
+    }
+  })
+  t.ok(valid, 'the combination is inert rather than invalid and must not be rejected')
+  t.end()
+})
+
+test('Configurations: press_item_barcode accepts an empty products map', function (t) {
+  t.plan(1)
+  const valid = validateUpdatePayload({
+    features: {
+      press_item_barcode: { enabled: true, products: {} }
+    }
+  })
+  t.ok(valid, 'equivalent to disabled, which the client resolves rather than the schema')
+  t.end()
+})
+
+test('Configurations: press_item_barcode rejects a prefix that is not exactly three digits', function (t) {
+  t.plan(2)
+  t.notOk(validateUpdatePayload({
+    features: { press_item_barcode: { products: { 41: pressUuid } } }
+  }), 'two digits')
+  t.notOk(validateUpdatePayload({
+    features: { press_item_barcode: { products: { 4141: pressUuid } } }
+  }), 'four digits')
+  t.end()
+})
+
+test('Configurations: press_item_barcode rejects a product value that is not a uuid', function (t) {
+  t.plan(1)
+  const valid = validateUpdatePayload({
+    features: { press_item_barcode: { products: { 414: 'presse-19' } } }
+  })
+  t.notOk(valid, 'the map holds article uuids, not names or numbers')
+  t.end()
+})
+
+test('Configurations: press_item_barcode rejects unknown enum values', function (t) {
+  t.plan(2)
+  t.notOk(validateUpdatePayload({
+    features: { press_item_barcode: { lookup_priority: 'catalogue_first' } }
+  }), 'lookup_priority')
+  t.notOk(validateUpdatePayload({
+    features: { press_item_barcode: { price_source_on_catalog_hit: 'ean' } }
+  }), 'price_source_on_catalog_hit')
+  t.end()
+})