@tillhub/schemas 6.464.0 → 6.465.1

package/lib/v0/customers/base.js

@@ -425,5 +425,36 @@ module.exports = {
     example: 'true',
     type: 'boolean',
     default: true
+  },
+  e_invoicing_email: {
+    description: 'Email address the electronic invoice is delivered to',
+    example: 'invoices@kamino.empire',
+    ...anyOf({
+      type: 'string',
+      maxLength: 128,
+      format: 'email'
+    }),
+    'default': null
+  },
+  e_invoicing_document_format: {
+    description: 'Document format of the electronic invoice',
+    example: 'ZUGFERD_V2',
+    type: 'string',
+    'enum': [
+      'ZUGFERD_V2',
+      'XRECHNUNG_V3'
+    ],
+    'default': 'ZUGFERD_V2'
+  },
+  e_invoicing_delivery_channel: {
+    description: 'Delivery channel the electronic invoice is sent through',
+    example: 'EMAIL',
+    type: 'string',
+    'enum': [
+      'EMAIL',
+      'PEPPOL',
+      'SDI'
+    ],
+    'default': 'EMAIL'
   }
 }

package/lib/v0/tags/create.js

@@ -9,7 +9,16 @@ module.exports.request = {
   required: [
     'name'
   ],
-  properties: base
+  properties: {
+    ...base,
+    name: {
+      type: 'string',
+      minLength: 1,
+      not: {
+        pattern: '^\\s|\\s$'
+      }
+    }
+  }
 }
 
 module.exports.response = {

package/lib/v0/tags/update.js

@@ -7,7 +7,16 @@ module.exports.request = {
   additionalProperties: false,
   type: 'object',
   required: [],
-  properties: base
+  properties: {
+    ...base,
+    name: {
+      type: 'string',
+      minLength: 1,
+      not: {
+        pattern: '^\\s|\\s$'
+      }
+    }
+  }
 }
 
 module.exports.response = {

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

@@ -44,6 +44,29 @@ module.exports = {
         phone: {
           type: 'string',
           description: 'Phone number of commercial contact'
+        },
+        trade_name: {
+          oneOf: [
+            {
+              type: 'string',
+              maxLength: 128
+            },
+            {
+              type: 'null'
+            }
+          ],
+          description: 'Trade name of the company, printed on the e-invoice instead of company_name'
+        },
+        official_email: {
+          oneOf: [
+            {
+              type: 'string'
+            },
+            {
+              type: 'null'
+            }
+          ],
+          description: 'Official contact email of the seller, printed on the e-invoice'
         }
       }
     }

package/package.json

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

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

@@ -476,3 +476,50 @@ test('Configurations: press_item_barcode rejects unknown enum values', function
   }), 'lookup_priority')
   t.end()
 })
+
+;['create', 'update', 'patch'].forEach(function (operation) {
+  const request = require('../../lib/v1/configurations')[operation].request
+  const validatePayload = ajv.compile(request)
+  const payload = function (tenant) {
+    return {
+      ...(operation === 'create' ? { name: 'E-Rechnung configuration', owner: 'self' } : {}),
+      tenant
+    }
+  }
+
+  test(`Configurations: ${operation} accepts the e-invoicing tenant properties`, function (t) {
+    const cases = [
+      ['both properties next to company_name', {
+        company_name: 'Muster GmbH',
+        trade_name: 'Muster',
+        official_email: 'invoices@seller.example'
+      }],
+      ['trade_name only', { trade_name: 'Muster' }],
+      ['official_email only', { official_email: 'invoices@seller.example' }],
+      ['neither property', { company_name: 'Muster GmbH' }],
+      ['a free-form official_email', { official_email: 'invoices at seller example' }],
+      ['a null trade_name', { trade_name: null }],
+      ['a null official_email', { official_email: null }]
+    ]
+    t.plan(cases.length)
+    cases.forEach(function ([description, tenant]) {
+      const valid = validatePayload(payload(tenant))
+      t.ok(valid, `${description}: ${ajv.errorsText(validatePayload.errors)}`)
+    })
+    t.end()
+  })
+
+  test(`Configurations: ${operation} rejects invalid e-invoicing tenant properties`, function (t) {
+    const cases = [
+      ['a numeric trade_name', { trade_name: 42 }],
+      ['a numeric official_email', { official_email: 42 }],
+      ['a trade_name over 128 characters', { trade_name: 'a'.repeat(129) }],
+      ['an undeclared property', { official_trade_name: 'Muster' }]
+    ]
+    t.plan(cases.length)
+    cases.forEach(function ([description, tenant]) {
+      t.notOk(validatePayload(payload(tenant)), description)
+    })
+    t.end()
+  })
+})

package/test/customers/customers.v0.spec.js

@@ -1,6 +1,12 @@
 const test = require('tape')
+const Ajv = require('ajv')
 const validate = require('../helpers/validate-schema')
 const customers = require('../../lib/v0/customers')
+const customerBase = require('../../lib/v0/customers/base')
+
+const ajv = new Ajv()
+const validateCreatePayload = ajv.compile(customers.create.request)
+const validateUpdatePayload = ajv.compile(customers.update.request)
 
 test('Customers:v0: create schema validation', function (t) {
   {
@@ -97,3 +103,50 @@ test('Customers:v0: read.one schema validation', function (t) {
 
   t.end()
 })
+
+test('Customers:v0: create accepts every e-invoicing document format and delivery channel', function (t) {
+  const formats = customerBase.e_invoicing_document_format.enum
+  const channels = customerBase.e_invoicing_delivery_channel.enum
+  t.plan(formats.length + channels.length)
+
+  formats.forEach((format) => {
+    const valid = validateCreatePayload({ e_invoicing_document_format: format })
+    t.ok(valid, `should accept document format "${format}"`)
+  })
+
+  channels.forEach((channel) => {
+    const valid = validateCreatePayload({ e_invoicing_delivery_channel: channel })
+    t.ok(valid, `should accept delivery channel "${channel}"`)
+  })
+
+  t.end()
+})
+
+test('Customers:v0: create accepts an invoicing email and null', function (t) {
+  t.plan(2)
+  t.ok(validateCreatePayload({ e_invoicing_email: 'invoices@kamino.empire' }), 'should accept an email address')
+  t.ok(validateCreatePayload({ e_invoicing_email: null }), 'should accept null')
+
+  t.end()
+})
+
+test('Customers:v0: create rejects invalid e-invoicing values', function (t) {
+  t.plan(5)
+  t.notOk(validateCreatePayload({ e_invoicing_document_format: 'XRECHNUNG' }), 'should reject an unknown document format')
+  t.notOk(validateCreatePayload({ e_invoicing_document_format: null }), 'should reject a null document format')
+  t.notOk(validateCreatePayload({ e_invoicing_delivery_channel: 'FAX' }), 'should reject an unknown delivery channel')
+  t.notOk(validateCreatePayload({ e_invoicing_delivery_channel: null }), 'should reject a null delivery channel')
+  t.notOk(validateCreatePayload({ e_invoicing_email: 'not-an-email' }), 'should reject an invoicing email that is not an email address')
+
+  t.end()
+})
+
+test('Customers:v0: update accepts and rejects the same e-invoicing values', function (t) {
+  t.plan(4)
+  t.ok(validateUpdatePayload({ e_invoicing_document_format: 'XRECHNUNG_V3' }), 'should accept a known document format')
+  t.ok(validateUpdatePayload({ e_invoicing_delivery_channel: 'SDI' }), 'should accept a known delivery channel')
+  t.notOk(validateUpdatePayload({ e_invoicing_document_format: 'ZUGFERD' }), 'should reject an unknown document format')
+  t.notOk(validateUpdatePayload({ e_invoicing_email: 'not-an-email' }), 'should reject an invoicing email that is not an email address')
+
+  t.end()
+})

package/test/tags/tags.v0.spec.js

@@ -0,0 +1,42 @@
+const test = require('tape')
+const Ajv = require('ajv')
+const validate = require('../helpers/validate-schema')
+const tags = require('../../lib/v0/tags')
+
+test('Tags: create schema validation', function (t) {
+  t.plan(2)
+  const createRequest = require('../../lib/v0/tags').create.request
+  const { valid, error } = validate(createRequest)
+  t.ok(valid, 'create schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Tags: update schema validation', function (t) {
+  t.plan(2)
+  const updateRequest = require('../../lib/v0/tags').update.request
+  const { valid, error } = validate(updateRequest)
+  t.ok(valid, 'update schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+for (const operation of ['create', 'update']) {
+  test(`Tags: ${operation} rejects empty names and surrounding whitespace`, function (t) {
+    const validateRequest = new Ajv().compile(tags[operation].request)
+
+    for (const name of [
+      '', ' ', '\t\n', null, 42,
+      ' green', 'green ', ' green ',
+      '\tgreen', 'green\t', 'green\n', 'green\r\n',
+      '\u00a0green', 'green\u00a0', '\ufeffgreen', 'green\ufeff'
+    ]) {
+      t.notOk(validateRequest({ name }), `rejects name ${JSON.stringify(name)}`)
+    }
+    for (const name of ['g', 'green', 'Grüner Tee', 'Grüner  Tee', '🟢']) {
+      t.ok(validateRequest({ name }), `accepts name ${JSON.stringify(name)}`)
+    }
+    t.equal(validateRequest({ deleted: true }), operation === 'update', 'only updates may omit the name')
+    t.end()
+  })
+}

package/test/tags/tags.v0.specs.js

@@ -1,20 +0,0 @@
-const test = require('tape')
-const validate = require('../helpers/validate-schema')
-
-test('Tags: create schema validation', function (t) {
-  t.plan(2)
-  const createRequest = require('../../lib/v0/tags').create.request
-  const { valid, error } = validate(createRequest)
-  t.ok(valid, 'create schema is valid')
-  t.error(error, 'should not get any error')
-  t.end()
-})
-
-test('Tags: update schema validation', function (t) {
-  t.plan(2)
-  const updateRequest = require('../../lib/v0/tags').update.request
-  const { valid, error } = validate(updateRequest)
-  t.ok(valid, 'update schema is valid')
-  t.error(error, 'should not get any error')
-  t.end()
-})