@peabody-soft/mbs-model-ts 1.11.0 → 1.12.0

package/dist/generated/ProfileSyncOutResponse.d.ts

@@ -9,8 +9,8 @@ import { BusinessLink } from "./BusinessLink";
 import { User } from "./User";
 import { AuthTokens } from "./AuthTokens";
 /**
- * The answer to a ProfileSyncOutRequest: who the caller is, the businesses they are linked to, and
- * those businesses. Nothing is nested - match BusinessLink.businessId against Business.entity.id.
+ * The answer to a ProfileSyncOutRequest, and to a UserRequest, which carries one: who the caller is, the businesses they are linked
+ * to, and those businesses. Nothing is nested - match BusinessLink.businessId against Business.entity.id.
  * Every field is absent/empty unless that type has changed. A tombstone (updateNumber's update-type
  * bits = Constants.UPDATE_TYPE_DELETED) means the entity, and what it owned, was deleted.
  *

package/dist/generated/SalesOrderPayload.d.ts

@@ -10,10 +10,11 @@ import { FulfillmentMode } from "./FulfillmentMode";
 import { OrderStatus } from "./OrderStatus";
 /**
  * The payload of a SALES_ORDER message: an order placed by a customer.
- * Excluded: serviceStationNumber, dueDate, createdByParty. The last is set by the merchant app for an
- * order that its party placed itself and not an operator of the business on its behalf. Nothing reads
- * it and a storefront has no use for it, so it is not carried, and the server leaves it unset on an
- * order that a storefront pushes.
+ * Excluded: serviceStationNumber, dueDate, createdByParty, and the flag that an operator's app sets in the
+ * packed category once it has checked the lines of the order against its catalog. createdByParty is true for
+ * an order that its party placed and not an operator of the business on its behalf. The server sets it on
+ * every order that a storefront sends. A storefront has no use for either flag, so neither is carried. An
+ * order that already exists is not written again, so the stored flags are kept.
  *
  * @generated from protobuf message com.merabills.storefront.SalesOrderPayload
  */
@@ -48,7 +49,8 @@ export interface SalesOrderPayload {
      */
     shoppingListCount: number;
     /**
-     * Id of the delivery address, in User.addresses of the customer. 0 means no address.
+     * Id of the delivery address, in User.addresses of the customer and in the addresses of the Party sent with the order (the merchant
+     * app finds the address there). 0 means no address.
      *
      * @generated from protobuf field: int64 deliveryAddressId = 6
      */
@@ -72,9 +74,8 @@ export interface SalesOrderPayload {
      */
     note?: string;
     /**
-     * Payment received towards this order so far. Can only be set by an operator of the business. That is not
-     * enforced yet: sync in is not implemented (its route answers 501), and ProtoMap.fromProto accepts this
-     * from whoever pushes the order, so sync in must refuse or drop it from a customer when it is written.
+     * Payment received towards this order so far. Can only be set by an operator of the business: an order
+     * that a customer sends with one is a 400.
      *
      * @generated from protobuf field: optional int64 paymentReceived = 10
      */

package/dist/generated/User.d.ts

@@ -9,7 +9,9 @@ import { Entity } from "./Entity";
 /**
  * A user of MeraBills; a customer of a business is represented by one. Carried by a
  * ProfileSyncOutResponse, not by a business sync out - a client reads the caller once, at sign in.
- * Excluded: referralDetails, isCallingUser, all Translations fields.
+ * Also carried by a UserRequest, to create the caller's user or to update it. Only entity.id is read: it becomes the id of a new user,
+ * and matches the caller for an update.
+ * Excluded: referralDetails, isCallingUser, all Translations fields. An update keeps the ones the stored user has.
  * Not included because it is derived: formattedName (firstName + " " + lastName).
  *
  * @generated from protobuf message com.merabills.storefront.User

package/dist/generated/UserRequest.d.ts

@@ -0,0 +1,52 @@
+import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
+import type { IBinaryWriter } from "@protobuf-ts/runtime";
+import type { BinaryReadOptions } from "@protobuf-ts/runtime";
+import type { IBinaryReader } from "@protobuf-ts/runtime";
+import type { PartialMessage } from "@protobuf-ts/runtime";
+import { MessageType } from "@protobuf-ts/runtime";
+import { ProfileSyncOutRequest } from "./ProfileSyncOutRequest";
+import { User } from "./User";
+/**
+ * The request of shop-create-user and shop-update-user. Both are answered with a ProfileSyncOutResponse. See Prompt.txt, CREATE USER
+ * AND UPDATE USER.
+ * The phone number of the user must be the one the authentication token verified (401). An invalid field is a 400.
+ *
+ * @generated from protobuf message com.merabills.storefront.UserRequest
+ */
+export interface UserRequest {
+    /**
+     * For shop-create-user, the user to create. The id of its entity is required and is the id of the new user: it has to be the id of a
+     * user, and not 0 or in the reserved range (400). The server sets the times, and reads nothing else of the entity.
+     * A 409 means the user was not created: the subject has a user, the id is taken, or the insert failed. The client reads its profile
+     * with shop-profile-sync-out, and creates again under a new id if the subject has no profile.
+     * For shop-update-user, the caller's own user with its new details: it is matched to the caller by entity.id (401 if it is not the
+     * caller's), and the rest of its entity is not read.
+     * A 409 means the update was not applied, for example because a change with a later time is stored (a device clock that is ahead, or
+     * two updates in the same millisecond). The client reads its profile and tries again.
+     *
+     * @generated from protobuf field: com.merabills.storefront.User user = 1
+     */
+    user?: User;
+    /**
+     * The profile sync out that answers the call: the response carries what is newer than its cursors, as for shop-profile-sync-out.
+     * Absent is the same as all cursors at 0 and no business to join.
+     * joinBusinessId joins a business as a customer after a create. 0 means none, and anything else has to be the id of a business: one
+     * that is not is a 400, checked before the user is created. One that cannot be joined is refused as
+     * ProfileSyncOutRequest.joinBusinessId says - a 404, and the user is created all the same.
+     * An update joins no business, so a joinBusinessId that is not 0 is a 400, and nothing is changed.
+     *
+     * @generated from protobuf field: com.merabills.storefront.ProfileSyncOutRequest profileSyncOutRequest = 2
+     */
+    profileSyncOutRequest?: ProfileSyncOutRequest;
+}
+declare class UserRequest$Type extends MessageType<UserRequest> {
+    constructor();
+    create(value?: PartialMessage<UserRequest>): UserRequest;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: UserRequest): UserRequest;
+    internalBinaryWrite(message: UserRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message com.merabills.storefront.UserRequest
+ */
+export declare const UserRequest: UserRequest$Type;
+export {};

package/dist/generated/{CreateUserRequest.js → UserRequest.js}

@@ -2,18 +2,18 @@ import { WireType } from "@protobuf-ts/runtime";
 import { UnknownFieldHandler } from "@protobuf-ts/runtime";
 import { reflectionMergePartial } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
+import { ProfileSyncOutRequest } from "./ProfileSyncOutRequest";
 import { User } from "./User";
 // @generated message type with reflection information, may provide speed optimized methods
-class CreateUserRequest$Type extends MessageType {
+class UserRequest$Type extends MessageType {
     constructor() {
-        super("com.merabills.storefront.CreateUserRequest", [
+        super("com.merabills.storefront.UserRequest", [
             { no: 1, name: "user", kind: "message", T: () => User },
-            { no: 2, name: "joinBusinessId", kind: "scalar", T: 3 /*ScalarType.INT64*/, L: 0 /*LongType.BIGINT*/ }
+            { no: 2, name: "profileSyncOutRequest", kind: "message", T: () => ProfileSyncOutRequest }
         ]);
     }
     create(value) {
         const message = globalThis.Object.create((this.messagePrototype));
-        message.joinBusinessId = 0n;
         if (value !== undefined)
             reflectionMergePartial(this, message, value);
         return message;
@@ -26,8 +26,8 @@ class CreateUserRequest$Type extends MessageType {
                 case /* com.merabills.storefront.User user */ 1:
                     message.user = User.internalBinaryRead(reader, reader.uint32(), options, message.user);
                     break;
-                case /* int64 joinBusinessId */ 2:
-                    message.joinBusinessId = reader.int64().toBigInt();
+                case /* com.merabills.storefront.ProfileSyncOutRequest profileSyncOutRequest */ 2:
+                    message.profileSyncOutRequest = ProfileSyncOutRequest.internalBinaryRead(reader, reader.uint32(), options, message.profileSyncOutRequest);
                     break;
                 default:
                     let u = options.readUnknownField;
@@ -44,9 +44,9 @@ class CreateUserRequest$Type extends MessageType {
         /* com.merabills.storefront.User user = 1; */
         if (message.user)
             User.internalBinaryWrite(message.user, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
-        /* int64 joinBusinessId = 2; */
-        if (message.joinBusinessId !== 0n)
-            writer.tag(2, WireType.Varint).int64(message.joinBusinessId);
+        /* com.merabills.storefront.ProfileSyncOutRequest profileSyncOutRequest = 2; */
+        if (message.profileSyncOutRequest)
+            ProfileSyncOutRequest.internalBinaryWrite(message.profileSyncOutRequest, writer.tag(2, WireType.LengthDelimited).fork(), options).join();
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
@@ -54,6 +54,6 @@ class CreateUserRequest$Type extends MessageType {
     }
 }
 /**
- * @generated MessageType for protobuf message com.merabills.storefront.CreateUserRequest
+ * @generated MessageType for protobuf message com.merabills.storefront.UserRequest
  */
-export const CreateUserRequest = new CreateUserRequest$Type();
+export const UserRequest = new UserRequest$Type();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "MeraBills storefront client-side model (TypeScript)",
   "author": "Peabody Soft",
   "license": "AGPL-3.0-or-later",
@@ -49,7 +49,7 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "@peabody-soft/mbs-protos": "^1.14.0",
+    "@peabody-soft/mbs-protos": "^1.15.0",
     "@protobuf-ts/runtime": "^2.11.1"
   }
 }

package/dist/generated/CreateUserRequest.d.ts

@@ -1,43 +0,0 @@
-import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
-import type { IBinaryWriter } from "@protobuf-ts/runtime";
-import type { BinaryReadOptions } from "@protobuf-ts/runtime";
-import type { IBinaryReader } from "@protobuf-ts/runtime";
-import type { PartialMessage } from "@protobuf-ts/runtime";
-import { MessageType } from "@protobuf-ts/runtime";
-import { User } from "./User";
-/**
- * Creates a new user, optionally joining it to a business as a customer in the same call, and is
- * answered with a ProfileSyncOutResponse. Not implemented yet: the route (shopCreateUser) answers 501, and
- * every rule below is the contract that it is to meet, and not behaviour that the server has. See
- * Prompt.txt, CREATE USER AND UPDATE USER, which also gives the contract of the route that updates the
- * caller's own user (its request is a bare User, matched to the caller by entity.id).
- *
- * @generated from protobuf message com.merabills.storefront.CreateUserRequest
- */
-export interface CreateUserRequest {
-    /**
-     * The user to create.
-     *
-     * @generated from protobuf field: com.merabills.storefront.User user = 1
-     */
-    user?: User;
-    /**
-     * The business to join as a customer after creating the user. 0 means none, and anything else has to be
-     * the id of a business: one that is not is refused, not ignored. One that cannot be joined is to be refused
-     * as ProfileSyncOutRequest.joinBusinessId says - a 404, and the user is created all the same.
-     *
-     * @generated from protobuf field: int64 joinBusinessId = 2
-     */
-    joinBusinessId: bigint;
-}
-declare class CreateUserRequest$Type extends MessageType<CreateUserRequest> {
-    constructor();
-    create(value?: PartialMessage<CreateUserRequest>): CreateUserRequest;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CreateUserRequest): CreateUserRequest;
-    internalBinaryWrite(message: CreateUserRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
-}
-/**
- * @generated MessageType for protobuf message com.merabills.storefront.CreateUserRequest
- */
-export declare const CreateUserRequest: CreateUserRequest$Type;
-export {};