@tillhub/schemas 6.179.0 → 6.181.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
+
+
+### Features
+
+* **release:** trigger the release ([40f7c6d](https://github.com/tillhub/schemas/commit/40f7c6d))
+
 # [6.179.0](https://github.com/tillhub/schemas/compare/v6.178.0...v6.179.0) (2022-12-09)
 
 
@@ -10,7 +24,7 @@
 
 ### Features
 
-* **stocks-book:** add stocks book schemas #UNTIL-5820 ([8172c34](https://github.com/tillhub/schemas/commit/8172c34)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
+* **stocks-book:** add stocks book schemas ([8172c34](https://github.com/tillhub/schemas/commit/8172c34)), closes [#UNTIL-5820](https://github.com/tillhub/schemas/issues/UNTIL-5820)
 * **stocks-book:** fix linter issues ([a4d1ba8](https://github.com/tillhub/schemas/commit/a4d1ba8))
 
 # [6.177.0](https://github.com/tillhub/schemas/compare/v6.176.0...v6.177.0) (2022-12-07)

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/v0/stocks_book/create.js

@@ -3,17 +3,16 @@ const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
 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 {
-  purchase: omitPurchase,
-  images: omitImages,
-  ...eventBaseData
-} = baseStockBook
+const eventBaseData = pick({
+  ...baseObject({ entityName: 'stock book' }),
+  ...baseStockBook
+}, ['id', 'qty_change', 'type'])
 
-const eventEmbeddedData = {
-  product: oneOf({
+const eventOverrideData = {
+  product: {
+    description: 'The product which stock was affected',
     type: 'object',
     additionalProperties: false,
     properties: pick({
@@ -23,14 +22,11 @@ const eventEmbeddedData = {
       'id',
       'name',
       'client_id',
-      'custom_id',
-      'custom_properties',
-      'metadata',
-      'product_group',
-      'is_service'
+      'custom_id'
     ])
-  }),
-  location: oneOf({
+  },
+  location: {
+    description: 'The location the stock was booked at',
     type: 'object',
     additionalProperties: false,
     properties: pick({
@@ -43,18 +39,10 @@ const eventEmbeddedData = {
       'branch_number',
       'metadata'
     ])
-  }),
+  },
   reason: oneOf({
-    type: 'object',
-    additionalProperties: false,
-    properties: pick({
-      ...baseObject(),
-      ...baseReason
-    }, [
-      'id',
-      'name',
-      'type'
-    ])
+    description: 'The reason of stock book',
+    type: 'string'
   })
 }
 
@@ -66,17 +54,13 @@ module.exports = {
     additionalProperties: false,
     required: [
       'id',
-      'qty',
       'qty_change',
       'product',
-      'location',
-      'from',
-      'to'
+      'location'
     ],
     properties: {
-      ...baseObject(),
       ...eventBaseData,
-      ...eventEmbeddedData
+      ...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.179.0",
+  "version": "6.181.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",