@tillhub/schemas 6.140.0 → 6.143.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [6.143.0](https://github.com/tillhub/schemas/compare/v6.142.0...v6.143.0) (2022-06-02)
+
+
+### Features
+
+* **customers:** support customers v1 'read.all' ([470149f](https://github.com/tillhub/schemas/commit/470149f))
+
+# [6.142.0](https://github.com/tillhub/schemas/compare/v6.141.0...v6.142.0) (2022-06-01)
+
+
+### Features
+
+* **dashboard:** dashboard configuration ([d9613ce](https://github.com/tillhub/schemas/commit/d9613ce))
+
+# [6.141.0](https://github.com/tillhub/schemas/compare/v6.140.0...v6.141.0) (2022-05-30)
+
+
+### Features
+
+* **configurations:** order_receipts ([f9d5f14](https://github.com/tillhub/schemas/commit/f9d5f14))
+
 # [6.140.0](https://github.com/tillhub/schemas/compare/v6.139.0...v6.140.0) (2022-05-20)
 
 

package/lib/common/response.js

@@ -1,26 +1,48 @@
-const cursor = {
-  type: 'object',
-  description: 'Optional cursor in paginated API calls. The cursor next field must be called as fully quantifiable URI in order to hit the next if available.',
-  additionalProperties: false,
-  required: ['self'],
-  properties: {
-    next: {
-      type: 'string',
-      format: 'uri',
-      description: 'The URI pointing to the next page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
-    },
-    first: {
-      type: 'string',
-      format: 'uri',
-      description: 'The URI pointing to the the first page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
-    },
-    self: {
-      type: 'string',
-      format: 'uri',
-      description: 'The URI pointing to this page.',
-      example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
+const cursors = {
+  'first-self': {
+    type: 'object',
+    description: 'Optional cursor in paginated API calls. The cursor next field must be called as fully quantifiable URI in order to hit the next if available.',
+    additionalProperties: false,
+    required: ['self'],
+    properties: {
+      next: {
+        type: 'string',
+        format: 'uri',
+        description: 'The URI pointing to the next page.',
+        example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
+      },
+      first: {
+        type: 'string',
+        format: 'uri',
+        description: 'The URI pointing to the the first page.',
+        example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
+      },
+      self: {
+        type: 'string',
+        format: 'uri',
+        description: 'The URI pointing to this page.',
+        example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?cursor=2018-07-02T21%3A47%3A44.382Z&size=10&cursor_field=updated_at'
+      }
+    }
+  },
+  'current-next': {
+    type: 'object',
+    description: 'Optional cursor in paginated API calls. The cursor provides URIs in order to get near pages if available.',
+    additionalProperties: false,
+    required: ['current'],
+    properties: {
+      current: {
+        type: 'string',
+        format: 'uri',
+        description: 'The URI pointing to current page.',
+        example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?size=10&cursor=5694834'
+      },
+      next: {
+        type: 'string',
+        format: 'uri',
+        description: 'The URI pointing to the next page.',
+        example: 'https://api.tillhub.com/api/v1/products/061f91a3-eba2-40b8-9a76-115189d6741e?size=10&cursor=5694847'
+      }
     }
   }
 }
@@ -30,7 +52,14 @@ const cursor = {
  * @param {Object} payload
  * @param {Object} options
  */
-function commonResponse ({ resultItems, results, additionals } = {}, { hasCursor = false } = {}) {
+function commonResponse ({
+  resultItems,
+  results,
+  additionals
+} = {}, {
+  hasCursor = false,
+  cursorType = ''
+} = {}) {
   if (!resultItems) throw new TypeError('common response requires result items to be set')
 
   if (!results) {
@@ -85,7 +114,16 @@ function commonResponse ({ resultItems, results, additionals } = {}, { hasCursor
     }
   }
 
-  if (hasCursor) response.properties.cursor = cursor
+  if (hasCursor && !cursorType) {
+    cursorType = 'first-self'
+  }
+
+  if (cursorType) {
+    if (!cursors[cursorType]) {
+      throw new Error(`Unknown cursor type '${cursorType}'`)
+    }
+    response.properties.cursor = cursors[cursorType]
+  }
 
   return response
 }

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

@@ -369,6 +369,14 @@ module.exports = oneOf({
                 type: 'boolean',
                 default: true
               },
+              size_type: oneOf({
+                type: 'string',
+                enum: [
+                  'regular',
+                  'large'
+                ],
+                default: 'large'
+              }),
               triggers: oneOf({
                 type: 'object',
                 additionalProperties: false,

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

@@ -615,34 +615,10 @@ module.exports = {
           type: 'object',
           additionalProperties: false,
           properties: {
-            availability: {
-              type: 'string',
-              'enum': [
-                'legacy', // only the legacy dashboard (url) is available
-                'new', // only the new dashboard (url_new) is available
-                'both' // both dashboards are available and the user is prompted for selection
-              ],
-              default: 'legacy'
-            },
             url: {
-              description: 'URL of this account\'s perferred LEGACY dashboard',
-              type: 'string' // client default kDashboardUrlLegacy is 'https://dashboard.tillhub.de' or 'https://awsxstaging.tillhub.de'
-            },
-            url_new: {
-              description: 'URL of this account\'s perferred NEW dashboard',
+              description: 'URL of this account\'s dashboard',
               type: 'string' // client default kDashboardUrl is 'https://dashboard.tillhub.com' or 'https://staging-dashboard.tillhub.com'
             },
-            auth: {
-              description: ' -- client reads but does not use this, please provide a proper description --',
-              oneOf: [
-                {
-                  type: 'string'
-                },
-                {
-                  type: 'null'
-                }
-              ]
-            },
             navigation_after_creation: oneOf({
               type: 'string',
               enum: [

package/lib/v1/customers/index.js

@@ -0,0 +1,5 @@
+const read = require('./read')
+
+module.exports = {
+  read
+}

package/lib/v1/customers/read.js

@@ -0,0 +1,23 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
+const base = require('../../v0/customers/base')
+const baseExtended = require('../../v0/customers/baseExt')
+
+module.exports.all = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v1/customers.read.all.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject(),
+          ...base,
+          ...baseExtended
+        }
+      }
+    }, { cursorType: 'current-next' })
+  }
+}

package/lib/v1/index.js

@@ -2,6 +2,7 @@ module.exports.balances = require('./balances')
 module.exports.branches = require('./branches')
 module.exports.carts = require('./carts')
 module.exports.configurations = require('./configurations')
+module.exports.customers = require('./customers')
 module.exports.delivery_notes = require('./delivery_notes')
 module.exports.discounts = require('./discounts')
 module.exports.gastro_orders = require('./gastro_orders')

package/package.json

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

package/test/customers/customers.v1.spec.js

@@ -0,0 +1,11 @@
+const test = require('tape')
+const validate = require('../helpers/validate-schema')
+const customers = require('../../lib/v1/customers')
+
+test('Customers:v0: read.all schema validation', function (t) {
+  const { valid, error } = validate(customers.read.all.response)
+  t.ok(valid, 'update response schema is valid')
+  t.error(error, 'should not get any error')
+
+  t.end()
+})