@tillhub/schemas 6.387.0 → 6.391.0

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+# [6.391.0](https://github.com/tillhub/schemas/compare/v6.390.1...v6.391.0) (2025-06-18)
+
+
+### Features
+
+* **table-reservation:** enhance the schema ([5b67e2b](https://github.com/tillhub/schemas/commit/5b67e2b))
+* **table-reservation:** enhance the schema ([#1073](https://github.com/tillhub/schemas/issues/1073)) ([cf22b9a](https://github.com/tillhub/schemas/commit/cf22b9a))
+
+## [6.390.1](https://github.com/tillhub/schemas/compare/v6.390.0...v6.390.1) (2025-06-18)
+
+
+### Bug Fixes
+
+* **UNTIL-14219:** allow table count prop for table layout v1 ([#1071](https://github.com/tillhub/schemas/issues/1071)) ([460ea09](https://github.com/tillhub/schemas/commit/460ea09))
+
+# [6.390.0](https://github.com/tillhub/schemas/compare/v6.389.0...v6.390.0) (2025-06-05)
+
+
+### Features
+
+* **table_layout:** triggering build ([#1069](https://github.com/tillhub/schemas/issues/1069)) ([7741187](https://github.com/tillhub/schemas/commit/7741187))
+
+# [6.389.0](https://github.com/tillhub/schemas/compare/v6.388.0...v6.389.0) (2025-06-05)
+
+
+### Features
+
+* **table_layout:** fix eslint ([#1068](https://github.com/tillhub/schemas/issues/1068)) ([3f71149](https://github.com/tillhub/schemas/commit/3f71149))
+
+# [6.388.0](https://github.com/tillhub/schemas/compare/v6.387.0...v6.388.0) (2025-06-02)
+
+
+### Features
+
+* **table_layout:** enhance schema with new table management fields ([#1066](https://github.com/tillhub/schemas/issues/1066)) ([732015c](https://github.com/tillhub/schemas/commit/732015c))
+
 # [6.387.0](https://github.com/tillhub/schemas/compare/v6.386.0...v6.387.0) (2025-05-09)
 
 

package/lib/v1/table_layout/available_tables.js

@@ -0,0 +1,38 @@
+module.exports = {
+  id: {
+    type: 'string',
+    format: 'uuid'
+  },
+  layoutId: {
+    type: 'string',
+    format: 'uuid'
+  },
+  sortOrder: {
+    type: 'number'
+  },
+  name: {
+    type: 'string'
+  },
+  parents: {
+    type: 'array',
+    items: {
+      type: 'string',
+      format: 'uuid'
+    }
+  },
+  minPartySize: {
+    type: 'number'
+  },
+  maxPartySize: {
+    type: 'number'
+  },
+  isCombination: {
+    type: 'boolean'
+  },
+  isBookableExternally: {
+    type: 'boolean'
+  },
+  type: {
+    type: 'string'
+  }
+}

package/lib/v1/table_layout/base.js

@@ -1,27 +1,28 @@
+const combinationSchema = require('./combination_schema')
+const layoutSchema = require('./layout_schema')
 module.exports = {
   id: {
     type: 'string',
     format: 'uuid'
   },
   name: {
-    type: 'string',
-    minLength: 1
+    type: 'string'
   },
   location: {
     type: 'string',
     format: 'uuid'
   },
-  tables_count: {
-    type: 'integer',
-    minimum: 0
+  gridColumnCount: {
+    type: 'number',
+    default: 5
   },
   active: {
     type: 'boolean',
-    default: true
+    default: false
   },
-  layout: {
-    type: 'object',
-    additionalProperties: true,
-    default: {}
+  layout: layoutSchema,
+  combinations: {
+    ...combinationSchema,
+    default: []
   }
 }

package/lib/v1/table_layout/combination_schema.js

@@ -0,0 +1,32 @@
+module.exports = {
+  type: 'array',
+  additionalProperties: false,
+  minItems: 0,
+  items: {
+    additionalProperties: false,
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        format: 'uuid'
+      },
+      minPartySize: {
+        type: 'number'
+      },
+      maxPartySize: {
+        type: 'number'
+      },
+      isBookableExternally: {
+        type: 'boolean'
+      },
+      tables: {
+        type: 'array',
+        items: {
+          type: 'string',
+          format: 'uuid'
+        }
+      }
+    }
+    // TODO: add these line to the schema: required: ['id', 'minPartySize', 'maxPartySize', 'isBookableExternally', 'tables']
+  }
+}

package/lib/v1/table_layout/create.js

@@ -1,15 +1,15 @@
 const base = require('./base')
-
 module.exports.request = {
   $id: 'https://schemas.tillhub.com/v1/table_layout.create.request.schema.json',
   $schema: 'http://json-schema.org/draft-07/schema#',
-  additionalProperties: false,
-  required: [
-    'name',
-    'location',
-    'tables_count',
-    'active'
-  ],
-  properties: base,
+  additionalProperties: true, // @TODO: change this to false
+  required: ['name', 'location', 'active', 'layout'],
+  properties: {
+    ...base,
+    tables_count: { // @TODO: remove this field
+      type: 'number',
+      default: 0
+    }
+  },
   type: 'object'
 }

package/lib/v1/table_layout/index.js

@@ -2,3 +2,4 @@ module.exports.create = require('./create')
 module.exports.read = require('./read')
 module.exports.update = require('./update')
 module.exports.duplicate = require('./duplicate')
+module.exports.availableTables = require('./available_tables')

package/lib/v1/table_layout/layout_schema.js

@@ -0,0 +1,124 @@
+module.exports = {
+  type: 'object',
+  default: {},
+  properties: {
+    scene: {
+      type: 'object',
+      properties: {
+        color: {
+          oneOf: [
+            {
+              type: 'string',
+              pattern: '^#[0-9A-Fa-f]{6}$' // hex color code
+            },
+            {
+              type: 'string',
+              maxLength: 0
+            }
+          ]
+        },
+        width: {
+          type: 'number'
+        },
+        height: {
+          type: 'number'
+        }
+      },
+      additionalProperties: false
+    },
+    entities: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: {
+            type: 'string',
+            format: 'uuid'
+          },
+          sortOrder: {
+            type: 'number'
+          },
+          type: {
+            type: 'string'
+          },
+          kind: {
+            type: 'string'
+          },
+          text: {
+            type: 'string'
+          },
+          fontSize: {
+            type: 'number'
+          },
+          image: {
+            type: 'object',
+            properties: {
+              type: {
+                type: 'string'
+              },
+              value: {
+                type: 'string'
+              }
+            }
+          },
+          width: {
+            type: 'number'
+          },
+          height: {
+            type: 'number'
+          },
+          x: {
+            type: 'number'
+          },
+          y: {
+            type: 'number'
+          },
+          rotation: {
+            type: 'number'
+          },
+          name: {
+            type: 'string'
+          },
+          color: {
+            oneOf: [
+              {
+                type: 'string',
+                pattern: '^#[0-9A-Fa-f]{6}$' // hex color code
+              },
+              {
+                type: 'string',
+                maxLength: 0
+              }
+            ]
+          },
+          minPartySize: {
+            type: 'number'
+          },
+          maxPartySize: {
+            type: 'number'
+          },
+          isBookableExternally: {
+            type: 'boolean'
+          }
+        },
+        additionalProperties: false
+      },
+      required: ['id', 'type', 'x', 'y', 'width', 'height']
+    }
+  },
+  additionalProperties: false
+}
+
+/** @TODO: add these line to the schema :
+ *         required: ['id', 'type', 'x', 'y', 'width', 'height'],
+        if: {
+          properties: {
+            type: {
+              enum: ['table', 'stool']
+            }
+          }
+        },
+        then: {
+          required: ['sortOrder', 'name', 'minPartySize', 'maxPartySize', 'isBookableExternally', 'x', 'y']
+        }
+ */

package/lib/v1/table_layout/read.js

@@ -1,7 +1,27 @@
-const base = require('./base')
 const baseObject = require('../../common/base')
 const commonResponse = require('../../common/response')
 const commonQuery = require('../../common/query')
+const combinationSchema = require('./combination_schema')
+const layoutSchema = require('./layout_schema')
+const availableTables = require('./available_tables')
+
+const sharedSchema = {
+  name: {
+    type: 'string',
+    minLength: 1
+  },
+  location: {
+    type: 'string',
+    format: 'uuid'
+  },
+  gridColumnCount: {
+    type: 'number'
+  },
+  active: {
+    type: 'boolean',
+    default: false
+  }
+}
 
 module.exports.all = {
   query: {
@@ -23,6 +43,24 @@ module.exports.all = {
             format: 'uuid'
           }
         },
+        include_layout: {
+          description: 'The option to include or omit the layout field from the response',
+          example: 'true',
+          type: 'string',
+          enum: ['true', 'false']
+        },
+        start: {
+          description: 'The start date and time of the period to query',
+          example: '2025-01-01T00:00:00Z',
+          type: 'string',
+          format: 'date-time'
+        },
+        active: {
+          description: 'The active status of the layout',
+          example: 'true',
+          type: 'string',
+          enum: ['true', 'false']
+        },
         page: {
           description: 'The page number (for paginated output)',
           example: 3,
@@ -39,12 +77,6 @@ module.exports.all = {
           description: 'Cursor field and direction for sorting query by',
           example: '+name',
           type: 'string'
-        },
-        include_layout: {
-          description: 'The option to include or omit the layout field from the response',
-          example: 'true',
-          type: 'string',
-          enum: ['true', 'false']
         }
       }
     })
@@ -59,7 +91,21 @@ module.exports.all = {
         additionalProperties: false,
         properties: {
           ...baseObject(),
-          ...base
+          ...sharedSchema,
+          ...{
+            tablesCount: {
+              type: 'number'
+            },
+            combinationsCount: {
+              type: 'number'
+            },
+            bookableTablesCount: {
+              type: 'number'
+            },
+            bookableCombinationsCount: {
+              type: 'number'
+            }
+          }
         }
       }
     })
@@ -77,7 +123,29 @@ module.exports.one = {
         additionalProperties: false,
         properties: {
           ...baseObject(),
-          ...base
+          ...sharedSchema,
+          ...{
+            combinations: combinationSchema,
+            layout: layoutSchema
+          }
+        }
+      }
+    })
+  }
+}
+
+module.exports.available_tables = {
+  response: {
+    $id: 'https://schemas.tillhub.com/v1/table_layout.read.available_tables.response.schema.json',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    additionalProperties: false,
+    ...commonResponse({
+      resultItems: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          ...baseObject(),
+          ...availableTables
         }
       }
     })

package/package.json

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