@peabody-soft/mbs-protos 1.6.0 → 1.7.0

package/Constants.proto

@@ -46,7 +46,7 @@ enum Constants {
   PRODUCT_BRAND_MAX_LENGTH = 32;
   PRODUCT_MANUFACTURER_MAX_LENGTH = 32;
 
-  // Product.taxes and ShoppingListItem.taxes
+  // Product.taxes, ShoppingListItem.taxes and GeneralSettings.deliveryChargeTaxes
   MAX_TAXES = 4;
 
   // Product.features
@@ -99,6 +99,18 @@ enum Constants {
   // GeneralSettings.deliveryRadiusKms - this value means there is no limit on the distance
   NO_RESTRICTIONS_DELIVERY_DISTANCE = 0;
 
+  // LatLong.latitude and LatLong.longitude
+  MIN_LATITUDE = -90;
+  MAX_LATITUDE = 90;
+  MIN_LONGITUDE = -180;
+  MAX_LONGITUDE = 180;
+
+  // GeneralSettings.googleBusinessCategoryId, GeneralSettings.googleBusinessCategoryName and
+  // GeneralSettings.onlineStoreThemeId
+  GOOGLE_BUSINESS_CATEGORY_ID_MAX_LENGTH = 128;
+  GOOGLE_BUSINESS_CATEGORY_NAME_MAX_LENGTH = 256;
+  ONLINE_STORE_THEME_ID_MAX_LENGTH = 64;
+
   // PaymentMethodDetail.data
   PAYMENT_METHOD_DATA_MAX_LENGTH = 320;
 

package/GeneralSettings.proto

@@ -6,11 +6,14 @@ option java_package = "com.merabills.server.core.generated";
 import "AddressList.proto";
 import "BusinessIdentifier.proto";
 import "FulfillmentMode.proto";
+import "LatLong.proto";
 import "PaymentMethodDetail.proto";
+import "Tax.proto";
 import "WorkingDays.proto";
 
-// The publicly visible settings of a business - tagline, contact info, fulfillment and payment
-// options - held in the value of the business's public Configuration entity.
+// The publicly visible settings of a business - tagline, contact info, location, fulfillment,
+// payment and delivery options, and online store presentation - held in the value of the
+// business's public Configuration entity.
 // Excluded: onlineShoppingEnabled, and the fields of the StoreSettings base class (authToken,
 // authTokenExpiry, lastSuccessfulSync and fees).
 // Not included because it is a constant: overdueAfterMillis.
@@ -40,16 +43,34 @@ message GeneralSettings {
   // Charge for delivering an order, multiplied by Constants.AMOUNT_FACTOR
   int64 deliveryCharge = 8;
 
+  // Taxes that apply to deliveryCharge (at most Constants.MAX_TAXES)
+  repeated Tax deliveryChargeTaxes = 9;
+
   // Order total at or above which delivery is free, multiplied by Constants.AMOUNT_FACTOR.
   // 0 means delivery is never free.
-  int64 freeDeliveryTotal = 9;
+  int64 freeDeliveryTotal = 10;
 
   // Distance, in kilometres, within which this business delivers.
   // Constants.NO_RESTRICTIONS_DELIVERY_DISTANCE (0) means there is no limit.
-  int32 deliveryRadiusKms = 10;
+  int32 deliveryRadiusKms = 11;
 
   // One line description of this business (at most Constants.STORE_TAGLINE_MAX_LENGTH)
-  optional string storeTagline = 11;
+  optional string storeTagline = 12;
+
+  WorkingDays workingDays = 13;
+
+  // Geographic coordinates of this business's primary (main) address
+  LatLong primaryStoreLocation = 14;
+
+  // Id of this business's category on Google Business Profile
+  // (at most Constants.GOOGLE_BUSINESS_CATEGORY_ID_MAX_LENGTH)
+  optional string googleBusinessCategoryId = 15;
+
+  // Name of this business's category on Google Business Profile
+  // (at most Constants.GOOGLE_BUSINESS_CATEGORY_NAME_MAX_LENGTH)
+  optional string googleBusinessCategoryName = 16;
 
-  WorkingDays workingDays = 12;
+  // Id of the visual theme applied to the online store
+  // (at most Constants.ONLINE_STORE_THEME_ID_MAX_LENGTH)
+  optional string onlineStoreThemeId = 17;
 }

package/LatLong.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// A point on Earth, given by its geographic coordinates.
+message LatLong {
+
+  // Degrees, between Constants.MIN_LATITUDE and Constants.MAX_LATITUDE
+  double latitude = 1;
+
+  // Degrees, between Constants.MIN_LONGITUDE and Constants.MAX_LONGITUDE
+  double longitude = 2;
+}

package/TaxType.proto

@@ -3,11 +3,18 @@ package com.merabills.storefront;
 option java_multiple_files = true;
 option java_package = "com.merabills.server.core.generated";
 
-// A tax that applies to a product or to a line item.
-// Values match the Java tax codes, which are unique within a country: the country of the business
-// that owns the item is needed to interpret them.
+// A tax that applies to a product or to a line item. A raw Java tax code is only unique within a
+// country, so values here are not that raw code: they are computed ids, TaxType.createId(country,
+// taxCode) = (country.getNumeric() << 8) | taxCode, making each value globally unique and
+// self-describing rather than meaningful only together with some other, separately carried country
+// code. A client can recover the ISO 3166-1 numeric country code with (value >> 8); it cannot
+// recover the raw tax code beyond the low 8 bits, and does not need to - the enum name already
+// carries that meaning.
 enum TaxType {
 
-  // India: Goods and Services Tax
-  GST = 0;
+  // No country's numeric code is ever 0, so this id can never collide with a real one
+  UNSPECIFIED_TAX_TYPE = 0;
+
+  // India (countryCode 356): Goods and Services Tax (taxCode 0)
+  GST = 91136;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-protos",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "The MeraBills shop wire protocol",
   "author": "Peabody Soft",
   "license": "AGPL-3.0-or-later",