@mamindom/contracts 1.0.50 → 1.0.52

package/gen/promotion.ts

@@ -0,0 +1,353 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.4
+//   protoc               v3.21.12
+// source: promotion.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+import { DeleteResponse, PaginationMeta, PaginationRequest, SuccessResponse } from "./common_promo";
+
+export const protobufPackage = "promo.v1";
+
+export enum PromotionType {
+  PROMOTION_TYPE_UNSPECIFIED = 0,
+  PROMOTION_TYPE_FIXED = 1,
+  PROMOTION_TYPE_PERCENTAGE = 2,
+  PROMOTION_TYPE_COUPON = 3,
+  PROMOTION_TYPE_BUY_N_GET_M = 4,
+  PROMOTION_TYPE_FIRST_ORDER = 5,
+  PROMOTION_TYPE_LOYALTY = 6,
+  PROMOTION_TYPE_PROMO_PERIOD = 7,
+  UNRECOGNIZED = -1,
+}
+
+export enum DiscountType {
+  DISCOUNT_TYPE_UNSPECIFIED = 0,
+  DISCOUNT_TYPE_FIXED = 1,
+  DISCOUNT_TYPE_PERCENTAGE = 2,
+  UNRECOGNIZED = -1,
+}
+
+export enum PromotionStatus {
+  PROMOTION_STATUS_UNSPECIFIED = 0,
+  PROMOTION_STATUS_DRAFT = 1,
+  PROMOTION_STATUS_ACTIVE = 2,
+  PROMOTION_STATUS_INACTIVE = 3,
+  PROMOTION_STATUS_EXPIRED = 4,
+  UNRECOGNIZED = -1,
+}
+
+export enum ConditionLogic {
+  CONDITION_LOGIC_UNSPECIFIED = 0,
+  CONDITION_LOGIC_AND = 1,
+  CONDITION_LOGIC_OR = 2,
+  UNRECOGNIZED = -1,
+}
+
+export enum ConditionType {
+  CONDITION_TYPE_UNSPECIFIED = 0,
+  CONDITION_TYPE_PRODUCT = 1,
+  CONDITION_TYPE_CATEGORY = 2,
+  CONDITION_TYPE_BRAND = 3,
+  CONDITION_TYPE_USER_GROUP = 4,
+  CONDITION_TYPE_FIRST_ORDER = 5,
+  CONDITION_TYPE_MIN_ORDER_COUNT = 6,
+  CONDITION_TYPE_MIN_AMOUNT = 7,
+  UNRECOGNIZED = -1,
+}
+
+export enum ExclusionEntityType {
+  EXCLUSION_ENTITY_UNSPECIFIED = 0,
+  EXCLUSION_ENTITY_PRODUCT = 1,
+  EXCLUSION_ENTITY_CATEGORY = 2,
+  EXCLUSION_ENTITY_BRAND = 3,
+  UNRECOGNIZED = -1,
+}
+
+export interface PromotionConditionPayload {
+  logicType: ConditionLogic;
+  conditionType: ConditionType;
+  value: string;
+}
+
+export interface PromotionExclusionPayload {
+  entityType: ExclusionEntityType;
+  entityId: string;
+}
+
+export interface PromotionConditionResponse {
+  id: string;
+  logicType: ConditionLogic;
+  conditionType: ConditionType;
+  value: string;
+}
+
+export interface PromotionExclusionResponse {
+  id: string;
+  entityType: ExclusionEntityType;
+  entityId: string;
+}
+
+export interface PromotionResponse {
+  id: string;
+  name: { [key: string]: string };
+  description: { [key: string]: string };
+  type: PromotionType;
+  discountType: DiscountType;
+  status: PromotionStatus;
+  discountValue: number;
+  startsAt?: string | undefined;
+  endsAt?: string | undefined;
+  minOrderAmount?: number | undefined;
+  usageLimitTotal?: number | undefined;
+  usageLimitPerUser?: number | undefined;
+  usageCount: number;
+  isActive: boolean;
+  isExclusive: boolean;
+  buyQuantity?: number | undefined;
+  getQuantity?: number | undefined;
+  seoSlug?: string | undefined;
+  seoTitle: { [key: string]: string };
+  seoDescription: { [key: string]: string };
+  createdById: string;
+  createdAt: string;
+  updatedAt: string;
+  conditions: PromotionConditionResponse[];
+  exclusions: PromotionExclusionResponse[];
+}
+
+export interface PromotionResponse_NameEntry {
+  key: string;
+  value: string;
+}
+
+export interface PromotionResponse_DescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface PromotionResponse_SeoTitleEntry {
+  key: string;
+  value: string;
+}
+
+export interface PromotionResponse_SeoDescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface GetPromotionsRequest {
+  pagination: PaginationRequest | undefined;
+  type?: PromotionType | undefined;
+  status?: PromotionStatus | undefined;
+  search?: string | undefined;
+  categoryId?: string | undefined;
+  dateFrom?: string | undefined;
+  dateTo?: string | undefined;
+}
+
+export interface GetPromotionsResponse {
+  items: PromotionListItem[];
+  meta: PaginationMeta | undefined;
+}
+
+export interface PromotionListItem {
+  id: string;
+  name: { [key: string]: string };
+  type: PromotionType;
+  status: PromotionStatus;
+  startsAt?: string | undefined;
+  endsAt?: string | undefined;
+  usageCount: number;
+  isActive: boolean;
+  createdAt: string;
+}
+
+export interface PromotionListItem_NameEntry {
+  key: string;
+  value: string;
+}
+
+export interface GetPromotionRequest {
+  id: string;
+}
+
+export interface CreatePromotionRequest {
+  name: { [key: string]: string };
+  description: { [key: string]: string };
+  type: PromotionType;
+  discountType: DiscountType;
+  discountValue: number;
+  startsAt?: string | undefined;
+  endsAt?: string | undefined;
+  minOrderAmount?: number | undefined;
+  usageLimitTotal?: number | undefined;
+  usageLimitPerUser?: number | undefined;
+  isActive: boolean;
+  isExclusive: boolean;
+  buyQuantity?: number | undefined;
+  getQuantity?: number | undefined;
+  seoSlug?: string | undefined;
+  seoTitle: { [key: string]: string };
+  seoDescription: { [key: string]: string };
+  createdById: string;
+  conditions: PromotionConditionPayload[];
+  exclusions: PromotionExclusionPayload[];
+}
+
+export interface CreatePromotionRequest_NameEntry {
+  key: string;
+  value: string;
+}
+
+export interface CreatePromotionRequest_DescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface CreatePromotionRequest_SeoTitleEntry {
+  key: string;
+  value: string;
+}
+
+export interface CreatePromotionRequest_SeoDescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface UpdatePromotionRequest {
+  id: string;
+  name: { [key: string]: string };
+  description: { [key: string]: string };
+  type?: PromotionType | undefined;
+  discountType?: DiscountType | undefined;
+  discountValue?: number | undefined;
+  startsAt?: string | undefined;
+  endsAt?: string | undefined;
+  minOrderAmount?: number | undefined;
+  usageLimitTotal?: number | undefined;
+  usageLimitPerUser?: number | undefined;
+  isActive?: boolean | undefined;
+  isExclusive?: boolean | undefined;
+  buyQuantity?: number | undefined;
+  getQuantity?: number | undefined;
+  seoSlug?: string | undefined;
+  seoTitle: { [key: string]: string };
+  seoDescription: { [key: string]: string };
+  conditions: PromotionConditionPayload[];
+  exclusions: PromotionExclusionPayload[];
+}
+
+export interface UpdatePromotionRequest_NameEntry {
+  key: string;
+  value: string;
+}
+
+export interface UpdatePromotionRequest_DescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface UpdatePromotionRequest_SeoTitleEntry {
+  key: string;
+  value: string;
+}
+
+export interface UpdatePromotionRequest_SeoDescriptionEntry {
+  key: string;
+  value: string;
+}
+
+export interface DeletePromotionRequest {
+  id: string;
+}
+
+export interface BulkApplyToCategoriesRequest {
+  promotionId: string;
+  categoryIds: string[];
+}
+
+export interface GetActivePromotionsRequest {
+  pagination: PaginationRequest | undefined;
+  lang?: string | undefined;
+}
+
+export interface GetActivePromotionsResponse {
+  items: PromotionListItem[];
+  meta: PaginationMeta | undefined;
+}
+
+export const PROMO_V1_PACKAGE_NAME = "promo.v1";
+
+export interface PromotionServiceClient {
+  getPromotions(request: GetPromotionsRequest): Observable<GetPromotionsResponse>;
+
+  getPromotion(request: GetPromotionRequest): Observable<PromotionResponse>;
+
+  createPromotion(request: CreatePromotionRequest): Observable<PromotionResponse>;
+
+  updatePromotion(request: UpdatePromotionRequest): Observable<PromotionResponse>;
+
+  deletePromotion(request: DeletePromotionRequest): Observable<DeleteResponse>;
+
+  bulkApplyToCategories(request: BulkApplyToCategoriesRequest): Observable<SuccessResponse>;
+
+  getActivePromotions(request: GetActivePromotionsRequest): Observable<GetActivePromotionsResponse>;
+}
+
+export interface PromotionServiceController {
+  getPromotions(
+    request: GetPromotionsRequest,
+  ): Promise<GetPromotionsResponse> | Observable<GetPromotionsResponse> | GetPromotionsResponse;
+
+  getPromotion(
+    request: GetPromotionRequest,
+  ): Promise<PromotionResponse> | Observable<PromotionResponse> | PromotionResponse;
+
+  createPromotion(
+    request: CreatePromotionRequest,
+  ): Promise<PromotionResponse> | Observable<PromotionResponse> | PromotionResponse;
+
+  updatePromotion(
+    request: UpdatePromotionRequest,
+  ): Promise<PromotionResponse> | Observable<PromotionResponse> | PromotionResponse;
+
+  deletePromotion(
+    request: DeletePromotionRequest,
+  ): Promise<DeleteResponse> | Observable<DeleteResponse> | DeleteResponse;
+
+  bulkApplyToCategories(
+    request: BulkApplyToCategoriesRequest,
+  ): Promise<SuccessResponse> | Observable<SuccessResponse> | SuccessResponse;
+
+  getActivePromotions(
+    request: GetActivePromotionsRequest,
+  ): Promise<GetActivePromotionsResponse> | Observable<GetActivePromotionsResponse> | GetActivePromotionsResponse;
+}
+
+export function PromotionServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      "getPromotions",
+      "getPromotion",
+      "createPromotion",
+      "updatePromotion",
+      "deletePromotion",
+      "bulkApplyToCategories",
+      "getActivePromotions",
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("PromotionService", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("PromotionService", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const PROMOTION_SERVICE_NAME = "PromotionService";

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mamindom/contracts",
 	"description": "proto",
-	"version": "1.0.50",
+	"version": "1.0.52",
 	"main": "./dist/src/index.js",
 	"types": "./dist/src/index.d.ts",
 	"exports": {

package/proto/calculation.proto

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+package promo.v1;
+
+import "common_promo.proto";
+
+
+service PromoCalculationService {
+  
+  rpc ValidateAndCalculate (ValidateAndCalculateRequest) returns (ValidateAndCalculateResponse);
+
+  
+  rpc ApplyPromotion (ApplyPromotionRequest) returns (SuccessResponse);
+}
+
+
+message CartItem {
+  string product_id  = 1;
+  string category_id = 2;
+  string brand_id    = 3;
+  int32  quantity    = 4;
+  double price       = 5; 
+}
+
+
+message ValidateAndCalculateRequest {
+  string          user_id      = 1;
+  repeated CartItem items      = 2;
+  double          order_total  = 3; 
+  optional string coupon_code  = 4; 
+  bool            is_first_order = 5; 
+  int32           order_count  = 6; 
+}
+
+message ValidateAndCalculateResponse {
+  bool   is_valid        = 1; 
+  double discount_amount = 2; 
+  double final_total     = 3;
+
+  repeated AppliedPromotion applied_promotions = 4;
+  optional AppliedCoupon    applied_coupon     = 5;
+
+  optional string error_message = 6; 
+}
+
+message AppliedPromotion {
+  string promotion_id   = 1;
+  string promotion_name = 2;
+  double discount_amount = 3;
+}
+
+message AppliedCoupon {
+  string coupon_id      = 1;
+  string code           = 2;
+  string promotion_id   = 3;
+  double discount_amount = 4;
+}
+
+
+message ApplyPromotionRequest {
+  string          user_id        = 1;
+  string          order_id       = 2;
+  double          discount_amount = 3;
+  optional string coupon_code    = 4;
+  repeated string promotion_ids  = 5;
+}

package/proto/common_post.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package content.v1;
+
+message SuccessResponse {
+  bool success = 1;
+}
+
+message DeleteResponse {
+  bool success = 1;
+}
+
+message PaginationRequest {
+  int32 page  = 1;
+  int32 limit = 2;
+}
+
+message PaginationMeta {
+  int32 total_items  = 1;
+  int32 total_pages  = 2;
+  int32 current_page = 3;
+  int32 per_page     = 4;
+}

package/proto/common_promo.proto

@@ -10,15 +10,14 @@ message DeleteResponse {
   bool success = 1;
 }
 
-
 message PaginationRequest {
-  int32 page = 1; 
-  int32 limit = 2; 
+  int32 page = 1;
+  int32 limit = 2;
 }
 
 message PaginationMeta {
-  int32 total_items = 1; 
-  int32 total_pages = 2; 
+  int32 total_items = 1;
+  int32 total_pages = 2;
   int32 current_page = 3;
-  int32 per_page = 4; 
-}
+  int32 per_page = 4;
+}

package/proto/coupon.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package promo.v1;
+
+import "common_promo.proto";
+
+
+service CouponService {
+  rpc GetCoupons      (GetCouponsRequest)      returns (GetCouponsResponse);
+  rpc GetCoupon       (GetCouponRequest)       returns (CouponResponse);
+  rpc CreateCoupon    (CreateCouponRequest)    returns (CouponResponse);
+  rpc UpdateCoupon    (UpdateCouponRequest)    returns (CouponResponse);
+  rpc DeactivateCoupon (DeactivateCouponRequest) returns (SuccessResponse);
+
+  
+  rpc GenerateCoupons (GenerateCouponsRequest) returns (GenerateCouponsResponse);
+
+  
+  rpc ExportCoupons   (ExportCouponsRequest)   returns (ExportCouponsResponse);
+  rpc ImportCoupons   (ImportCouponsRequest)   returns (ImportCouponsResponse);
+}
+
+
+message CouponResponse {
+  string id           = 1;
+  string promotion_id = 2;
+  string code         = 3;
+
+  optional int32 usage_limit_total    = 4;
+  optional int32 usage_limit_per_user = 5;
+  int32          usage_count          = 6;
+
+  bool            is_active  = 7;
+  optional string expires_at = 8; 
+
+  string created_at = 9;
+}
+
+
+message GetCouponsRequest {
+  PaginationRequest pagination   = 1;
+  optional string   promotion_id = 2;
+  optional bool     is_active    = 3;
+  optional string   search       = 4; 
+}
+
+message GetCouponsResponse {
+  repeated CouponResponse items = 1;
+  PaginationMeta          meta  = 2;
+}
+
+
+message GetCouponRequest {
+  string id = 1;
+  optional string code = 2; 
+}
+
+
+message CreateCouponRequest {
+  string promotion_id = 1;
+  string code         = 2; 
+
+  optional int32  usage_limit_total    = 3;
+  optional int32  usage_limit_per_user = 4;
+  optional string expires_at           = 5;
+  bool            is_active            = 6;
+}
+
+
+message UpdateCouponRequest {
+  string id = 1;
+
+  optional int32  usage_limit_total    = 2;
+  optional int32  usage_limit_per_user = 3;
+  optional string expires_at           = 4;
+  optional bool   is_active            = 5;
+}
+
+
+message DeactivateCouponRequest {
+  string id = 1;
+}
+
+
+message GenerateCouponsRequest {
+  string promotion_id = 1;
+  int32  count        = 2; 
+
+  
+  optional string prefix       = 3;
+  optional int32  random_length = 4;
+
+  optional int32  usage_limit_per_user = 5;
+  optional string expires_at           = 6;
+}
+
+message GenerateCouponsResponse {
+  int32 generated = 1; 
+}
+
+
+message ExportCouponsRequest {
+  string promotion_id = 1;
+  optional bool active_only = 2; 
+}
+
+message ExportCouponsResponse {
+  string csv_content = 1; 
+}
+
+
+message ImportCouponsRequest {
+  string promotion_id = 1;
+  string csv_content  = 2; 
+}
+
+message ImportCouponsResponse {
+  int32 imported = 1; 
+  int32 skipped  = 2; 
+  repeated string errors = 3; 
+}