@tillhub/schemas 6.181.0 → 6.183.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [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)
+
+
+### 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)
 
 

package/lib/common/webhooks.js

@@ -0,0 +1,53 @@
+module.exports.getEvent = function getEvent (payload, {
+  eventEntityExample = 'ice-cream',
+  eventTypeExample = 'create',
+  eventVersionExample = 0
+} = {}) {
+  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: eventEntityExample,
+        type: 'string'
+      },
+      eventType: {
+        description: 'The event type (e.g. create, update, delete)',
+        example: eventTypeExample,
+        type: 'string'
+      },
+      eventVersion: {
+        description: 'The event payload version',
+        example: eventVersionExample,
+        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/base.js

@@ -91,7 +91,7 @@ const simple = {
       minLength: 1
     }
   }),
-  type: oneOf({
+  type: {
     description: 'The type of stock book',
     type: 'string',
     enum: [
@@ -107,7 +107,7 @@ const simple = {
       'delivery_note_refund',
       'delivery_note_cancellation'
     ]
-  })
+  }
 }
 
 module.exports.simple = simple

package/lib/v0/stocks_book/create.js

@@ -1,14 +1,27 @@
 const pick = require('just-pick')
 const { oneOf } = require('../../helpers/payload-or-null')
 const baseObject = require('../../common/base')
+const { getEvent } = require('../../common/webhooks')
 const baseProduct = require('../../v1/products/base').response
 const baseBranch = require('../../v0/branches/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', 'qty_change', 'type'])
+  ...baseStockBook,
+  type: {
+    ...baseStockBook.type,
+    enum: eventTypeEnum
+  }
+}, ['id', 'created_at', 'qty_change', 'type'])
 
 const eventOverrideData = {
   product: {
@@ -19,10 +32,10 @@ const eventOverrideData = {
       ...baseObject(),
       ...baseProduct
     }, [
-      'id',
       'name',
       'client_id',
-      'custom_id'
+      'custom_id',
+      'custom_properties'
     ])
   },
   location: {
@@ -33,7 +46,6 @@ const eventOverrideData = {
       ...baseObject(),
       ...baseBranch
     }, [
-      'id',
       'name',
       'custom_id',
       'branch_number',
@@ -42,7 +54,8 @@ const eventOverrideData = {
   },
   reason: oneOf({
     description: 'The reason of stock book',
-    type: 'string'
+    type: 'string',
+    example: 'Not arbitrary reason'
   })
 }
 
@@ -50,17 +63,21 @@ 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: {
-      ...eventBaseData,
-      ...eventOverrideData
-    }
+    ...getEvent({
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'id',
+        'created_at',
+        'qty_change',
+        'type',
+        'product',
+        'location'
+      ],
+      properties: {
+        ...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.181.0",
+  "version": "6.183.0",
   "private": false,
   "description": "All Tillhub API OpenAPI 3 compatible JSON Schemas.",
   "main": "./lib/index.js",