@tillhub/schemas 6.182.0 → 6.184.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [6.184.0](https://github.com/tillhub/schemas/compare/v6.183.0...v6.184.0) (2022-12-15)
+
+
+### Features
+
+* **stocks-book:** align schema with requirements v5 #UNTIL-5820 ([1333558](https://github.com/tillhub/schemas/commit/1333558)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+
+# [6.183.0](https://github.com/tillhub/schemas/compare/v6.182.0...v6.183.0) (2022-12-14)
+
+
+### Features
+
+* **stocks-book:** add transaction event schema #UNTIL-5820 ([b458c35](https://github.com/tillhub/schemas/commit/b458c35)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+* **stocks-book:** align schema with requirements v4 #UNTIL-5820 ([eae9837](https://github.com/tillhub/schemas/commit/eae9837)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+
 # [6.182.0](https://github.com/tillhub/schemas/compare/v6.181.0...v6.182.0) (2022-12-13)
 
 

package/lib/common/{wenhooks.js → webhooks.js}

@@ -1,4 +1,8 @@
-module.exports.getEvent = function getEvent (payload) {
+module.exports.getEvent = function getEvent (payload, {
+  eventEntityExample = 'ice-cream',
+  eventTypeExample = 'create',
+  eventVersionExample = 0
+} = {}) {
   return {
     description: 'The webhook data set',
     type: 'object',
@@ -18,17 +22,17 @@ module.exports.getEvent = function getEvent (payload) {
       },
       eventEntity: {
         description: 'The entity name the event refers to',
-        example: 'transaction',
+        example: eventEntityExample,
         type: 'string'
       },
       eventType: {
         description: 'The event type (e.g. create, update, delete)',
-        example: 'create',
+        example: eventTypeExample,
         type: 'string'
       },
       eventVersion: {
         description: 'The event payload version',
-        example: 0,
+        example: eventVersionExample,
         type: 'number'
       },
       entityInstanceId: {

package/lib/v0/stocks_book/base.js

@@ -9,12 +9,12 @@ const simple = {
     type: 'object'
   }),
   qty: {
-    description: 'The quantity of product remain after book',
+    description: 'The quantity of product remain after stock booking',
     example: 11,
     type: 'number'
   },
   qty_change: {
-    description: 'The quantity change with the book',
+    description: 'The quantity change with the stock booking',
     example: -2,
     type: 'number'
   },
@@ -72,27 +72,27 @@ const simple = {
     type: 'object'
   }),
   reason: oneOf({
-    description: 'Alphanumerical UUID of the reason',
+    description: 'Alphanumerical UUID of the reason: the association with user generated entity which can be specifically set when booking things out manually',
     example: 'a1c1d0c6-f38b-4d89-ae26-7f1aea34985c',
     type: 'string',
     format: 'uuid'
   }),
   comments: oneOf({
-    description: 'Additional comments for stock book',
+    description: 'Additional comments for stock booking',
     example: 'Actualized due to inventarisation',
     type: 'string',
     maxLength: 2048
   }),
   images: oneOf({
-    description: 'Images associated with stock book',
+    description: 'Images associated with stock booking',
     type: 'array',
     items: {
       type: 'string',
       minLength: 1
     }
   }),
-  type: oneOf({
-    description: 'The type of stock book',
+  type: {
+    description: 'The type of stock booking',
     type: 'string',
     enum: [
       'add',
@@ -107,7 +107,7 @@ const simple = {
       'delivery_note_refund',
       'delivery_note_cancellation'
     ]
-  })
+  }
 }
 
 module.exports.simple = simple

package/lib/v0/stocks_book/create.js

@@ -1,16 +1,28 @@
 const pick = require('just-pick')
 const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
-const { getEvent } = require('../../common/wenhooks')
+const { getEvent } = require('../../common/webhooks')
 const baseProduct = require('../../v1/products/base').response
 const baseBranch = require('../../v0/branches/base')
-const baseReason = require('../../v0/reasons/base')
 const baseStockBook = require('./base').simple
 
+/**
+ * We transform all possible types into more generic ones:
+ * 'transfer': 'add', 'deduct', 'goods_in', 'goods_out', 'relocation'
+ * 'sale': 'sale', 'cancellation', 'refund'
+ * 'delivery_note': 'delivery_note', 'delivery_note_cancellation', 'delivery_note_refund"
+ */
+const eventTypeEnum = ['transfer', 'sale', 'delivery_note']
+
 const eventBaseData = pick({
   ...baseObject({ entityName: 'stock book' }),
-  ...baseStockBook
-}, ['id', 'created_at', 'qty_change', 'type', 'channel'])
+  ...baseStockBook,
+  type: {
+    ...baseStockBook.type,
+    description: `The type of stock booking: \n'transfer' - indicates a stock change made by the operator for the logistic purpose, positive value for goods-in and negative value for goods-out \n'sale' - indicates a stock change triggered by a sale, positive value for a successful transaction and negative value for a refund or cancellation \n'delivery_note' - indicates a stock change triggered by a delivery note, positive value for a successful delivery note and negative value for a refund or cancellation`,
+    enum: eventTypeEnum
+  }
+}, ['id', 'created_at', 'qty_change', 'type'])
 
 const eventOverrideData = {
   product: {
@@ -42,16 +54,9 @@ const eventOverrideData = {
     ])
   },
   reason: oneOf({
-    description: 'The reason of stock book',
-    type: 'object',
-    additionalProperties: false,
-    properties: pick({
-      ...baseObject(),
-      ...baseReason
-    }, [
-      'name',
-      'type'
-    ])
+    description: 'The reason name: the user generated text which can be specifically set when booking things out manually',
+    type: 'string',
+    example: 'Not arbitrary reason'
   })
 }
 
@@ -64,7 +69,9 @@ module.exports = {
       additionalProperties: false,
       required: [
         'id',
+        'created_at',
         'qty_change',
+        'type',
         'product',
         'location'
       ],
@@ -72,6 +79,6 @@ module.exports = {
         ...eventBaseData,
         ...eventOverrideData
       }
-    })
+    }, { eventEntityExample: 'stocks-book' })
   }
 }

package/lib/v1/transactions/{create.request.js → create.js}

@@ -3,7 +3,7 @@ const itemsCreate = require('./components/items/create.request')
 const paymentsCreate = require('./components/payments/create.request')
 const statusCreate = require('../statuses/create.request')
 
-module.exports = {
+module.exports.request = {
   $id: 'https://schemas.tillhub.com/v1/transactions.create.request.schema.json',
   $schema: 'http://json-schema.org/draft-07/schema#',
   type: 'object',

package/lib/v1/transactions/index.js

@@ -1,7 +1,7 @@
 const commonResponse = require('../../common/response')
 
 module.exports.create = {
-  request: require('./create.request'),
+  request: require('./create').request,
   response: {
     $id: 'https://schemas.tillhub.com/v1/transactions.post.response.schema.json',
     $schema: 'http://json-schema.org/draft-07/schema#',
@@ -28,12 +28,13 @@ module.exports.get = {
 
 module.exports.legacy = {
   create: {
-    request: require('./legacy/create.request'),
+    request: require('./legacy/create').request,
     response: {
       $id: 'https://schemas.tillhub.com/v1/transactions.legacy.post.response.schema.json',
       $schema: 'http://json-schema.org/draft-07/schema#',
       ...commonResponse({ resultItems: require('./legacy/response') })
-    }
+    },
+    event: require('./legacy/create').event
   }
 }
 

package/lib/v1/transactions/legacy/{create.request.js → create.js}

@@ -1,9 +1,11 @@
+const { getEvent } = require('../../../common/webhooks')
 const statusCreate = require('../../statuses/create.request')
 const base = require('./base')
+const response = require('./response')
 const itemsCreate = require('./items/create.request')
 const paymentsCreate = require('./payments/create.request')
 
-module.exports = {
+module.exports.request = {
   $id: 'https://schemas.tillhub.com/v1/transactions.legacy.create.request.schema.json',
   $schema: 'http://json-schema.org/draft-07/schema#',
   type: 'object',
@@ -34,3 +36,9 @@ module.exports = {
     }
   }
 }
+
+module.exports.event = {
+  $id: 'https://schemas.tillhub.com/v1/transactions.legacy.create.event.schema.json',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  ...getEvent(response, { eventEntityExample: 'transaction' })
+}

package/package.json

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