@tillhub/schemas 6.177.0 → 6.178.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [6.178.0](https://github.com/tillhub/schemas/compare/v6.177.0...v6.178.0) (2022-12-08)
+
+
+### 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:** 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/location_type.js

@@ -0,0 +1,10 @@
+module.exports = {
+  description: 'Location type',
+  type: 'string',
+  enum: [
+    'client',
+    'branch',
+    'warehouse',
+    'warehouse_shelf'
+  ]
+}

package/lib/v0/index.js

@@ -14,6 +14,7 @@ module.exports.invoices = require('./invoices')
 module.exports.accounts = require('./accounts')
 module.exports.expense_accounts = require('./expense_accounts')
 module.exports.stock = require('./stock')
+module.exports.stocks_book = require('./stocks_book')
 module.exports.payment_options = require('./payment_options')
 module.exports.discounts = require('./discounts')
 module.exports.staff = require('./staff')

package/lib/v0/stock/base.js

@@ -1,59 +1,23 @@
-const { oneOf } = require('../../helpers/payload-or-null')
+const { anyOf, oneOf } = require('../../helpers/payload-or-null')
+const locationType = require('../../common/location_type')
 
 module.exports = {
-  qty: {
-    anyOf: [
-      {
-        type: 'null'
-      },
-      {
-        type: 'number',
-        description: 'The quantity of this item/product.'
-      }
-    ]
-  },
-  product: {
-    anyOf: [
-      {
-        type: 'string',
-        minLength: 1,
-        maxLength: 64
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
-  location: {
-    anyOf: [
-      {
-        type: 'string',
-        description: 'Alphanumerical uuid of the location, e.g. branch or warehouse',
-        minLength: 1,
-        maxLength: 64
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
-  location_type: {
-    anyOf: [
-      {
-        type: 'string',
-        description: 'Location type of stock',
-        'enum': [
-          'client',
-          'branch',
-          'warehouse',
-          'warehouse_shelf'
-        ]
-      },
-      {
-        type: 'null'
-      }
-    ]
-  },
+  qty: anyOf({
+    type: 'number',
+    description: 'The quantity of this item/product.'
+  }),
+  product: anyOf({
+    type: 'string',
+    minLength: 1,
+    maxLength: 64
+  }),
+  location: anyOf({
+    type: 'string',
+    description: 'Alphanumerical uuid of the location, e.g. branch or warehouse',
+    minLength: 1,
+    maxLength: 64
+  }),
+  location_type: anyOf(locationType),
   status: oneOf({
     type: 'string',
     'enum': [

package/lib/v0/stock/transfer.js

@@ -1,4 +1,5 @@
 const { oneOf } = require('../../helpers/payload-or-null')
+const locationType = require('../../common/location_type')
 const defaultResponse = require('./default-response')
 
 module.exports.request = {
@@ -29,15 +30,7 @@ module.exports.request = {
           description: 'Alphanumeric uuid of the location, e.g. branch uuid or warehouse uuid',
           format: 'uuid'
         },
-        location_type: {
-          type: 'string',
-          'enum': [
-            'client',
-            'branch',
-            'warehouse',
-            'warehouse_shelf'
-          ]
-        }
+        location_type: locationType
       },
       required: [
         'id'
@@ -52,14 +45,7 @@ module.exports.request = {
           description: 'Alphanumeric uuid of the location, e.g. branch uuid or warehouse uuid',
           format: 'uuid'
         },
-        location_type: {
-          type: 'string',
-          'enum': [
-            'branch',
-            'warehouse',
-            'warehouse_shelf'
-          ]
-        }
+        location_type: locationType
       },
       required: [
         'id'

package/lib/v0/stock/update.js

@@ -1,5 +1,6 @@
 
 const { oneOf } = require('../../helpers/payload-or-null')
+const locationType = require('../../common/location_type')
 const defaultResponse = require('./default-response')
 
 module.exports.request = {
@@ -98,15 +99,7 @@ module.exports.response = {
           description: 'Alphanumeric uuid of the location, e.g. branch uuid or warehouse uuid',
           format: 'uuid'
         },
-        location_type: {
-          type: 'string',
-          'enum': [
-            'client',
-            'branch',
-            'warehouse',
-            'warehouse_shelf'
-          ]
-        }
+        location_type: locationType
       },
       required: [
         'id'
@@ -121,14 +114,7 @@ module.exports.response = {
           description: 'Alphanumeric uuid of the location, e.g. branch uuid or warehouse uuid',
           format: 'uuid'
         },
-        location_type: {
-          type: 'string',
-          'enum': [
-            'branch',
-            'warehouse',
-            'warehouse_shelf'
-          ]
-        }
+        location_type: locationType
       },
       required: [
         'id'

package/lib/v0/stocks_book/base.js

@@ -0,0 +1,149 @@
+const { oneOf } = require('../../helpers/payload-or-null')
+const baseObject = require('../../common/base')
+const locationType = require('../../common/location_type')
+const baseProduct = require('../../v1/products/base').response
+const baseBranch = require('../../v0/branches/base')
+
+const simple = {
+  metadata: oneOf({
+    type: 'object'
+  }),
+  qty: {
+    description: 'The quantity of product remain after book',
+    example: 11,
+    type: 'number'
+  },
+  qty_change: {
+    description: 'The quantity change with the book',
+    example: -2,
+    type: 'number'
+  },
+  product: {
+    description: 'The product UUID',
+    example: 'b98992bf-52b8-49e5-a44c-9e20eb921422',
+    type: 'string',
+    format: 'uuid'
+  },
+  branch: {
+    description: 'The branch UUID (use location instead)',
+    deprecated: true,
+    example: '3f7d26f4-96ff-45b2-8fce-a5c0ca6040b2',
+    type: 'string',
+    format: 'uuid'
+  },
+  status: oneOf({
+    description: 'The status of the product',
+    type: 'string',
+    enum: [
+      'available'
+    ]
+  }),
+  location: {
+    description: 'Alphanumerical UUID of the location, e.g. branch or warehouse',
+    example: '5b26131d-95e8-49a0-a9b4-58397569bba8',
+    type: 'string',
+    format: 'uuid'
+  },
+  location_type: locationType,
+  from: {
+    description: 'Alphanumerical UUID of the stock source location',
+    example: '75941a1a-01b0-47b8-806b-83bfa68f3bea',
+    type: 'string',
+    format: 'uuid'
+  },
+  to: {
+    description: 'Alphanumerical UUID of the stock target location',
+    example: '7b8806e7d-810f-4e18-b049-8e2cc6134a41',
+    type: 'string',
+    format: 'uuid'
+  },
+  channel: oneOf({
+    description: 'The channel from which stock deduction were made',
+    type: 'string',
+    enum: [
+      'transfer',
+      'transactions',
+      'delivery_notes'
+    ]
+  }),
+  purchase: oneOf({
+    description: 'The purchase object data',
+    deprecated: true,
+    type: 'object'
+  }),
+  reason: oneOf({
+    description: 'Alphanumerical UUID of the reason',
+    example: 'a1c1d0c6-f38b-4d89-ae26-7f1aea34985c',
+    type: 'string',
+    format: 'uuid'
+  }),
+  comments: oneOf({
+    description: 'Additional comments for stock book',
+    example: 'Actualized due to inventarisation',
+    type: 'string',
+    maxLength: 2048
+  }),
+  images: oneOf({
+    description: 'Images associated with stock book',
+    type: 'array',
+    items: {
+      type: 'string',
+      minLength: 1
+    }
+  }),
+  type: oneOf({
+    description: 'The type of stock book',
+    type: 'string',
+    enum: [
+      'add',
+      'deduct',
+      'goods_in',
+      'goods_out',
+      'relocation',
+      'sale',
+      'cancellation',
+      'refund',
+      'delivery_note',
+      'delivery_note_refund',
+      'delivery_note_cancellation'
+    ]
+  })
+}
+
+module.exports.simple = simple
+
+module.exports.embedded = {
+  ...simple,
+  product: oneOf([simple.product, {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      ...baseObject(),
+      ...baseProduct
+    }
+  }]),
+  location: oneOf([simple.location, {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      ...baseObject(),
+      ...baseBranch
+    }
+  }]),
+  from: oneOf([simple.from, {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      ...baseObject(),
+      ...baseBranch
+    }
+  }]),
+  to: oneOf([simple.to, {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+      ...baseObject(),
+      ...baseBranch
+    }
+  }])
+}

package/lib/v0/stocks_book/create.js

@@ -0,0 +1,76 @@
+const pick = require('just-pick')
+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 eventEmbeddedData = {
+  product: oneOf({
+    type: 'object',
+    additionalProperties: false,
+    properties: pick({
+      ...baseObject(),
+      ...baseProduct
+    }, [
+      'id',
+      'name',
+      'client_id',
+      'custom_id',
+      'custom_properties',
+      'metadata',
+      'product_group',
+      'is_service'
+    ])
+  }),
+  location: oneOf({
+    type: 'object',
+    additionalProperties: false,
+    properties: pick({
+      ...baseObject(),
+      ...baseBranch
+    }, [
+      'id',
+      'name',
+      'custom_id',
+      'branch_number',
+      'metadata'
+    ])
+  }),
+  reason: oneOf({
+    type: 'object',
+    additionalProperties: false,
+    properties: pick({
+      ...baseObject(),
+      ...baseReason
+    }, [
+      'id',
+      'name',
+      'type'
+    ])
+  })
+}
+
+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',
+      'qty_change',
+      'product',
+      'location',
+      'from',
+      'to'
+    ],
+    properties: {
+      ...baseObject(),
+      ...baseStockBook,
+      ...eventEmbeddedData
+    }
+  }
+}

package/lib/v0/stocks_book/index.js

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

package/lib/v0/stocks_book/read.js

@@ -0,0 +1,21 @@
+const baseObject = require('../../common/base')
+const commonResponse = require('../../common/response')
+const base = require('./base').embedded
+
+module.exports.all = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v0/stocks-book.read.all.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject(),
+          ...base
+        }
+      }
+    }, { hasCursor: true })
+  }
+}

package/lib/v1/products/base.js

@@ -1,4 +1,5 @@
-const { oneOf } = require('../../helpers/payload-or-null')
+const { anyOf, oneOf } = require('../../helpers/payload-or-null')
+const locationType = require('../../common/location_type')
 const customProperties = require('../../common/custom_properties')
 
 const stockConfigurationLocation = {
@@ -25,23 +26,7 @@ const stockConfigurationLocation = {
         description: 'Threshold at which a reorder should be triggered',
         type: 'number'
       }),
-      location_type: {
-        anyOf: [
-          {
-            type: 'string',
-            description: 'Type of stock to be created (supported only for bulk creation of products with stock)',
-            enum: [
-              'client',
-              'branch',
-              'warehouse',
-              'warehouse_shelf'
-            ]
-          },
-          {
-            type: 'null'
-          }
-        ]
-      },
+      location_type: anyOf(locationType),
       qty: oneOf({
         description: 'The amount/quantity of stock to be created (supported only for bulk creation of products with stock)',
         type: 'number'

package/package.json

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

package/test/stocks_book/stocks-book.v0.spec.js

@@ -0,0 +1,18 @@
+const test = require('tape')
+const validate = require('../helpers/validate-schema')
+
+test('Stocks Book: create schema validation', function (t) {
+  const createEvent = require('../../lib/v0/stocks_book').create.event
+  const { valid, error } = validate(createEvent)
+  t.ok(valid, 'create event schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})
+
+test('Stocks Book: read schema validation', function (t) {
+  const readAllResponse = require('../../lib/v0/stocks_book').read.all.response
+  const { valid, error } = validate(readAllResponse)
+  t.ok(valid, 'read all response schema is valid')
+  t.error(error, 'should not get any error')
+  t.end()
+})