@prodoctors/contracts 1.1.3 → 1.1.5

package/gen/sales.ts

@@ -23,6 +23,14 @@ export enum SaleStatus {
   UNRECOGNIZED = -1,
 }
 
+export enum SaleSource {
+  SALE_SOURCE_UNSPECIFIED = 0,
+  SALE_SOURCE_POS = 1,
+  SALE_SOURCE_WEB = 2,
+  SALE_SOURCE_ADMIN = 3,
+  UNRECOGNIZED = -1,
+}
+
 export enum PaymentMethod {
   PAYMENT_METHOD_UNSPECIFIED = 0,
   PAYMENT_METHOD_CASH = 1,
@@ -81,6 +89,7 @@ export interface SaleOrder {
   createdAt: Timestamp | undefined;
   updatedAt: Timestamp | undefined;
   shiftId?: string | undefined;
+  source: SaleSource;
 }
 
 export interface SaleReturnItem {
@@ -174,6 +183,7 @@ export interface CreateSaleOrderRequest {
   soldAt?: Timestamp | undefined;
   items: CreateSaleItemInput[];
   shiftId?: string | undefined;
+  source?: SaleSource | undefined;
 }
 
 export interface UpdateSaleOrderRequest {
@@ -203,6 +213,7 @@ export interface ListSaleOrdersRequest {
   status?: SaleStatus | undefined;
   receiptNumber?: string | undefined;
   shiftId?: string | undefined;
+  source?: SaleSource | undefined;
 }
 
 export interface ListSaleOrdersResponse {
@@ -210,6 +221,48 @@ export interface ListSaleOrdersResponse {
   meta: PaginationMeta | undefined;
 }
 
+export interface CashierSalesSummaryRequest {
+  shiftId: string;
+}
+
+export interface CashierSalesPaymentSummary {
+  paymentMethod: PaymentMethod;
+  totalOrders: number;
+  totalAmount: string;
+  paidAmount: string;
+  changeAmount: string;
+}
+
+export interface CashierSalesProductSummary {
+  productId: string;
+  productName: string;
+  sku?: string | undefined;
+  totalQuantity: number;
+  totalBaseQuantity: number;
+  totalAmount: string;
+}
+
+export interface CashierSalesSummaryResponse {
+  shiftId: string;
+  branchId: string;
+  cashierId: string;
+  terminalId: string;
+  status: string;
+  openedAt: Timestamp | undefined;
+  closedAt?: Timestamp | undefined;
+  totalOrders: number;
+  totalQuantity: number;
+  totalBaseQuantity: number;
+  subtotal: string;
+  discountAmount: string;
+  taxAmount: string;
+  totalAmount: string;
+  paidAmount: string;
+  changeAmount: string;
+  paymentMethods: CashierSalesPaymentSummary[];
+  products: CashierSalesProductSummary[];
+}
+
 export interface CreateSaleReturnItemInput {
   productId: string;
   productBatchId: string;
@@ -312,6 +365,8 @@ export interface SaleOrderServiceClient {
 
   listSaleOrders(request: ListSaleOrdersRequest): Observable<ListSaleOrdersResponse>;
 
+  getCashierSalesSummary(request: CashierSalesSummaryRequest): Observable<CashierSalesSummaryResponse>;
+
   deleteSaleOrder(request: IdRequest): Observable<BoolResponse>;
 }
 
@@ -326,6 +381,10 @@ export interface SaleOrderServiceController {
     request: ListSaleOrdersRequest,
   ): Promise<ListSaleOrdersResponse> | Observable<ListSaleOrdersResponse> | ListSaleOrdersResponse;
 
+  getCashierSalesSummary(
+    request: CashierSalesSummaryRequest,
+  ): Promise<CashierSalesSummaryResponse> | Observable<CashierSalesSummaryResponse> | CashierSalesSummaryResponse;
+
   deleteSaleOrder(request: IdRequest): Promise<BoolResponse> | Observable<BoolResponse> | BoolResponse;
 }
 
@@ -336,6 +395,7 @@ export function SaleOrderServiceControllerMethods() {
       "updateSaleOrder",
       "getSaleOrderById",
       "listSaleOrders",
+      "getCashierSalesSummary",
       "deleteSaleOrder",
     ];
     for (const method of grpcMethods) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prodoctors/contracts",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Protobuf definitions and generated Typescript types for ProDoctors",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/proto/sales.proto

@@ -15,6 +15,13 @@ enum SaleStatus {
   SALE_STATUS_REFUNDED = 4;
 }
 
+enum SaleSource {
+  SALE_SOURCE_UNSPECIFIED = 0;
+  SALE_SOURCE_POS = 1;
+  SALE_SOURCE_WEB = 2;
+  SALE_SOURCE_ADMIN = 3;
+}
+
 enum PaymentMethod {
   PAYMENT_METHOD_UNSPECIFIED = 0;
   PAYMENT_METHOD_CASH = 1;
@@ -71,6 +78,7 @@ message SaleOrder {
   google.protobuf.Timestamp created_at = 18;
   google.protobuf.Timestamp updated_at = 19;
   optional string shift_id = 20;
+  SaleSource source = 21;
 }
 
 message SaleReturnItem {
@@ -164,6 +172,7 @@ message CreateSaleOrderRequest {
   optional google.protobuf.Timestamp sold_at = 14;
   repeated CreateSaleItemInput items = 15;
   optional string shift_id = 16;
+  optional SaleSource source = 17;
 }
 
 message UpdateSaleOrderRequest {
@@ -193,6 +202,7 @@ message ListSaleOrdersRequest {
   optional SaleStatus status = 5;
   optional string receipt_number = 6;
   optional string shift_id = 7;
+  optional SaleSource source = 8;
 }
 
 message ListSaleOrdersResponse {
@@ -200,6 +210,48 @@ message ListSaleOrdersResponse {
   common.v1.PaginationMeta meta = 2;
 }
 
+message CashierSalesSummaryRequest {
+  string shift_id = 1;
+}
+
+message CashierSalesPaymentSummary {
+  PaymentMethod payment_method = 1;
+  int32 total_orders = 2;
+  string total_amount = 3;
+  string paid_amount = 4;
+  string change_amount = 5;
+}
+
+message CashierSalesProductSummary {
+  string product_id = 1;
+  string product_name = 2;
+  optional string sku = 3;
+  int32 total_quantity = 4;
+  int32 total_base_quantity = 5;
+  string total_amount = 6;
+}
+
+message CashierSalesSummaryResponse {
+  string shift_id = 1;
+  string branch_id = 2;
+  string cashier_id = 3;
+  string terminal_id = 4;
+  string status = 5;
+  google.protobuf.Timestamp opened_at = 6;
+  optional google.protobuf.Timestamp closed_at = 7;
+  int32 total_orders = 8;
+  int32 total_quantity = 9;
+  int32 total_base_quantity = 10;
+  string subtotal = 11;
+  string discount_amount = 12;
+  string tax_amount = 13;
+  string total_amount = 14;
+  string paid_amount = 15;
+  string change_amount = 16;
+  repeated CashierSalesPaymentSummary payment_methods = 17;
+  repeated CashierSalesProductSummary products = 18;
+}
+
 message CreateSaleReturnItemInput {
   string product_id = 1;
   string product_batch_id = 2;
@@ -296,6 +348,7 @@ service SaleOrderService {
   rpc UpdateSaleOrder(UpdateSaleOrderRequest) returns (SaleOrder);
   rpc GetSaleOrderById(common.v1.IdRequest) returns (SaleOrder);
   rpc ListSaleOrders(ListSaleOrdersRequest) returns (ListSaleOrdersResponse);
+  rpc GetCashierSalesSummary(CashierSalesSummaryRequest) returns (CashierSalesSummaryResponse);
   rpc DeleteSaleOrder(common.v1.IdRequest) returns (common.v1.BoolResponse);
 }