@tillhub/schemas 6.180.0 → 6.182.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.182.0](https://github.com/tillhub/schemas/compare/v6.181.0...v6.182.0) (2022-12-13)
+
+
+### Features
+
+* **stocks-book:** align schema with requirements v3 #UNTIL-5820 ([9a828b3](https://github.com/tillhub/schemas/commit/9a828b3)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+
+# [6.181.0](https://github.com/tillhub/schemas/compare/v6.180.0...v6.181.0) (2022-12-12)
+
+
+### Features
+
+* **stocks-book:** align schema with requirements v1 #UNTIL-5820 ([c606cc8](https://github.com/tillhub/schemas/commit/c606cc8)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+
 # [6.180.0](https://github.com/tillhub/schemas/compare/v6.179.0...v6.180.0) (2022-12-12)
 
 

package/lib/common/base.js

@@ -5,6 +5,7 @@ const dateObject = require('./date_object')
  * @param {Object} [options]
  */
 function baseObject ({
+  entityName = 'entity',
   splitDate = false
 } = {}) {
   const dateType = splitDate ? dateObject : {
@@ -15,18 +16,18 @@ function baseObject ({
 
   return {
     id: {
-      description: 'Unique entity ID',
+      description: `Unique ${entityName} ID`,
       type: 'string',
       format: 'uuid',
       example: '936835f7-2d75-41d2-9001-38ed6e458328'
     },
     created_at: {
       ...dateType,
-      description: 'The date and time entity was created'
+      description: `The date and time ${entityName} was created`
     },
     updated_at: {
       ...dateType,
-      description: 'The date and time entity was updated'
+      description: `The date and time ${entityName} was updated`
     }
   }
 }

package/lib/common/wenhooks.js

@@ -0,0 +1,49 @@
+module.exports.getEvent = function getEvent (payload) {
+  return {
+    description: 'The webhook data set',
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      webhookId: {
+        description: 'The webhook UUID',
+        example: 'ff30cfdf-5167-4f72-b4fc-c1d72db3c07e',
+        type: 'string',
+        format: 'uuid'
+      },
+      eventId: {
+        description: 'The event UUID',
+        example: 'c6fe918a-7bdc-4ccd-af36-95c03853233d',
+        type: 'string',
+        format: 'uuid'
+      },
+      eventEntity: {
+        description: 'The entity name the event refers to',
+        example: 'transaction',
+        type: 'string'
+      },
+      eventType: {
+        description: 'The event type (e.g. create, update, delete)',
+        example: 'create',
+        type: 'string'
+      },
+      eventVersion: {
+        description: 'The event payload version',
+        example: 0,
+        type: 'number'
+      },
+      entityInstanceId: {
+        description: 'The entity instance UUID',
+        example: '10b06f38-031d-4e0c-8706-0474c8c5b61c',
+        type: 'string',
+        format: 'uuid'
+      },
+      timestamp: {
+        description: 'The date and time event was received by webhooks service',
+        example: new Date().toISOString(),
+        type: 'string',
+        format: 'date-time'
+      },
+      payload
+    }
+  }
+}

package/lib/v0/stocks_book/create.js

@@ -1,11 +1,16 @@
 const pick = require('just-pick')
 const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
+const { getEvent } = require('../../common/wenhooks')
 const baseProduct = require('../../v1/products/base').response
 const baseBranch = require('../../v0/branches/base')
+const baseReason = require('../../v0/reasons/base')
 const baseStockBook = require('./base').simple
 
-const eventBaseData = pick(baseStockBook, ['id', 'qty_change', 'type'])
+const eventBaseData = pick({
+  ...baseObject({ entityName: 'stock book' }),
+  ...baseStockBook
+}, ['id', 'created_at', 'qty_change', 'type', 'channel'])
 
 const eventOverrideData = {
   product: {
@@ -16,10 +21,10 @@ const eventOverrideData = {
       ...baseObject(),
       ...baseProduct
     }, [
-      'id',
       'name',
       'client_id',
-      'custom_id'
+      'custom_id',
+      'custom_properties'
     ])
   },
   location: {
@@ -30,7 +35,6 @@ const eventOverrideData = {
       ...baseObject(),
       ...baseBranch
     }, [
-      'id',
       'name',
       'custom_id',
       'branch_number',
@@ -39,7 +43,15 @@ const eventOverrideData = {
   },
   reason: oneOf({
     description: 'The reason of stock book',
-    type: 'string'
+    type: 'object',
+    additionalProperties: false,
+    properties: pick({
+      ...baseObject(),
+      ...baseReason
+    }, [
+      'name',
+      'type'
+    ])
   })
 }
 
@@ -47,18 +59,19 @@ module.exports = {
   event: {
     $id: 'https://schemas.tillhub.com/v0/stocks-book.create.event.schema.json',
     $schema: 'http://json-schema.org/draft-07/schema#',
-    type: 'object',
-    additionalProperties: false,
-    required: [
-      'id',
-      'qty_change',
-      'product',
-      'location'
-    ],
-    properties: {
-      ...baseObject(),
-      ...eventBaseData,
-      ...eventOverrideData
-    }
+    ...getEvent({
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'id',
+        'qty_change',
+        'product',
+        'location'
+      ],
+      properties: {
+        ...eventBaseData,
+        ...eventOverrideData
+      }
+    })
   }
 }

package/lib/v0/stocks_book/read.js

@@ -12,7 +12,7 @@ module.exports.all = {
         type: 'object',
         additionalProperties: false,
         properties: {
-          ...baseObject(),
+          ...baseObject({ entityName: 'stock book' }),
           ...base
         }
       }

package/package.json

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