@mamindom/contracts 1.0.50 → 1.0.51

package/proto/promotion.proto

@@ -0,0 +1,257 @@
+syntax = "proto3";
+
+package promo.v1;
+
+import "common_promo.proto";
+
+
+service PromotionService {
+  
+  rpc GetPromotions       (GetPromotionsRequest)       returns (GetPromotionsResponse);
+  rpc GetPromotion        (GetPromotionRequest)        returns (PromotionResponse);
+  rpc CreatePromotion     (CreatePromotionRequest)     returns (PromotionResponse);
+  rpc UpdatePromotion     (UpdatePromotionRequest)     returns (PromotionResponse);
+  rpc DeletePromotion     (DeletePromotionRequest)     returns (DeleteResponse);
+
+ 
+  rpc BulkApplyToCategories (BulkApplyToCategoriesRequest) returns (SuccessResponse);
+
+  
+  rpc GetActivePromotions (GetActivePromotionsRequest) returns (GetActivePromotionsResponse);
+}
+
+
+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; 
+}
+
+enum DiscountType {
+  DISCOUNT_TYPE_UNSPECIFIED = 0;
+  DISCOUNT_TYPE_FIXED       = 1; 
+  DISCOUNT_TYPE_PERCENTAGE  = 2; 
+}
+
+enum PromotionStatus {
+  PROMOTION_STATUS_UNSPECIFIED = 0;
+  PROMOTION_STATUS_DRAFT       = 1;
+  PROMOTION_STATUS_ACTIVE      = 2;
+  PROMOTION_STATUS_INACTIVE    = 3;
+  PROMOTION_STATUS_EXPIRED     = 4;
+}
+
+enum ConditionLogic {
+  CONDITION_LOGIC_UNSPECIFIED = 0;
+  CONDITION_LOGIC_AND         = 1;
+  CONDITION_LOGIC_OR          = 2;
+}
+
+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;
+}
+
+enum ExclusionEntityType {
+  EXCLUSION_ENTITY_UNSPECIFIED = 0;
+  EXCLUSION_ENTITY_PRODUCT     = 1;
+  EXCLUSION_ENTITY_CATEGORY    = 2;
+  EXCLUSION_ENTITY_BRAND       = 3;
+}
+
+
+message PromotionConditionPayload {
+  ConditionLogic logic_type     = 1;
+  ConditionType  condition_type = 2;
+  string         value          = 3; 
+}
+
+message PromotionExclusionPayload {
+  ExclusionEntityType entity_type = 1;
+  string              entity_id   = 2;
+}
+
+message PromotionConditionResponse {
+  string         id             = 1;
+  ConditionLogic logic_type     = 2;
+  ConditionType  condition_type = 3;
+  string         value          = 4;
+}
+
+message PromotionExclusionResponse {
+  string              id          = 1;
+  ExclusionEntityType entity_type = 2;
+  string              entity_id   = 3;
+}
+
+
+message PromotionResponse {
+  string          id           = 1;
+  map<string, string> name     = 2;
+  map<string, string> description = 3;
+
+  PromotionType   type         = 4;
+  DiscountType    discount_type = 5;
+  PromotionStatus status       = 6;
+
+  double discount_value        = 7;
+
+  optional string starts_at    = 8;  
+  optional string ends_at      = 9;
+
+  optional double min_order_amount     = 10;
+  optional int32  usage_limit_total    = 11;
+  optional int32  usage_limit_per_user = 12;
+  int32           usage_count          = 13;
+
+  bool is_active    = 14;
+  bool is_exclusive = 15;
+
+ 
+  optional int32 buy_quantity = 16;
+  optional int32 get_quantity = 17;
+
+
+  optional string             seo_slug        = 18;
+  map<string, string>         seo_title       = 19;
+  map<string, string>         seo_description = 20;
+
+  string created_by_id = 21;
+  string created_at    = 22;
+  string updated_at    = 23;
+
+  repeated PromotionConditionResponse conditions = 24;
+  repeated PromotionExclusionResponse exclusions = 25;
+}
+
+
+message GetPromotionsRequest {
+  PaginationRequest pagination = 1;
+
+  optional PromotionType   type       = 2;
+  optional PromotionStatus status     = 3;
+  optional string          search     = 4;
+  optional string          category_id = 5;
+  optional string          date_from  = 6; 
+  optional string          date_to    = 7;
+}
+
+message GetPromotionsResponse {
+  repeated PromotionListItem items = 1;
+  PaginationMeta             meta  = 2;
+}
+
+message PromotionListItem {
+  string          id           = 1;
+  map<string, string> name     = 2;
+  PromotionType   type         = 3;
+  PromotionStatus status       = 4;
+  optional string starts_at    = 5;
+  optional string ends_at      = 6;
+  int32           usage_count  = 7;
+  bool            is_active    = 8;
+  string          created_at   = 9;
+}
+
+
+message GetPromotionRequest {
+  string id = 1;
+}
+
+
+message CreatePromotionRequest {
+  map<string, string> name        = 1;
+  map<string, string> description = 2;
+
+  PromotionType  type          = 3;
+  DiscountType   discount_type = 4;
+  double         discount_value = 5;
+
+  optional string starts_at = 6;
+  optional string ends_at   = 7;
+
+  optional double min_order_amount     = 8;
+  optional int32  usage_limit_total    = 9;
+  optional int32  usage_limit_per_user = 10;
+
+  bool is_active    = 11;
+  bool is_exclusive = 12;
+
+  optional int32 buy_quantity = 13;
+  optional int32 get_quantity = 14;
+
+  optional string     seo_slug        = 15;
+  map<string, string> seo_title       = 16;
+  map<string, string> seo_description = 17;
+
+  string created_by_id = 18;
+
+  repeated PromotionConditionPayload conditions = 19;
+  repeated PromotionExclusionPayload exclusions = 20;
+}
+
+
+message UpdatePromotionRequest {
+  string id = 1;
+
+  map<string, string> name        = 2;
+  map<string, string> description = 3;
+
+  optional PromotionType   type          = 4;
+  optional DiscountType    discount_type = 5;
+  optional double          discount_value = 6;
+
+  optional string starts_at = 7;
+  optional string ends_at   = 8;
+
+  optional double min_order_amount     = 9;
+  optional int32  usage_limit_total    = 10;
+  optional int32  usage_limit_per_user = 11;
+
+  optional bool is_active    = 12;
+  optional bool is_exclusive = 13;
+
+  optional int32 buy_quantity = 14;
+  optional int32 get_quantity = 15;
+
+  optional string     seo_slug        = 16;
+  map<string, string> seo_title       = 17;
+  map<string, string> seo_description = 18;
+
+  
+  repeated PromotionConditionPayload conditions = 19;
+  repeated PromotionExclusionPayload exclusions = 20;
+}
+
+
+message DeletePromotionRequest {
+  string id = 1;
+}
+
+
+message BulkApplyToCategoriesRequest {
+  string          promotion_id = 1;
+  repeated string category_ids = 2;
+}
+
+
+message GetActivePromotionsRequest {
+  PaginationRequest pagination = 1;
+  optional string   lang       = 2;
+}
+
+message GetActivePromotionsResponse {
+  repeated PromotionListItem items = 1;
+  PaginationMeta             meta  = 2;
+}

package/dist/gen/promo.d.ts

@@ -1,293 +0,0 @@
-import { Observable } from "rxjs";
-import { DeleteResponse, PaginationMeta, PaginationRequest } from "./common_promo";
-export declare const protobufPackage = "promo.v1";
-export declare enum PromotionType {
-    PROMOTION_TYPE_UNSPECIFIED = 0,
-    PROMOTION_TYPE_FIXED = 1,
-    PROMOTION_TYPE_PERCENTAGE = 2,
-    PROMOTION_TYPE_COUPON = 3,
-    PROMOTION_TYPE_N_PLUS_M = 4,
-    PROMOTION_TYPE_FIRST_PURCHASE = 5,
-    PROMOTION_TYPE_PROMO_PERIOD = 6,
-    UNRECOGNIZED = -1
-}
-export declare enum PromotionStatus {
-    PROMOTION_STATUS_UNSPECIFIED = 0,
-    PROMOTION_STATUS_ACTIVE = 1,
-    PROMOTION_STATUS_INACTIVE = 2,
-    PROMOTION_STATUS_SCHEDULED = 3,
-    PROMOTION_STATUS_ARCHIVED = 4,
-    UNRECOGNIZED = -1
-}
-export interface ProductContextItem {
-    productId: string;
-    categoryId: string;
-    brandId: string;
-    basePrice: number;
-}
-export interface GetProductsDiscountsRequest {
-    items: ProductContextItem[];
-}
-export interface DiscountedProductItem {
-    productId: string;
-    originalPrice: number;
-    discountedPrice: number;
-    appliedPromotionId: string;
-}
-export interface GetProductsDiscountsResponse {
-    items: DiscountedProductItem[];
-}
-export interface CartItem {
-    productId: string;
-    categoryId: string;
-    brandId: string;
-    price: number;
-    quantity: number;
-}
-export interface ValidateAndCalculateRequest {
-    userId: string;
-    items: CartItem[];
-    promoCode?: string | undefined;
-    isFirstPurchase: boolean;
-}
-export interface AppliedDiscount {
-    promotionId: string;
-    title: string;
-    discountAmount: number;
-}
-export interface ValidateAndCalculateResponse {
-    originalTotal: number;
-    finalTotal: number;
-    totalDiscount: number;
-    appliedDiscounts: AppliedDiscount[];
-    isCouponValid: boolean;
-    couponErrorMessage?: string | undefined;
-}
-export interface PromotionResponse {
-    id: string;
-    type: PromotionType;
-    status: PromotionStatus;
-    title: {
-        [key: string]: string;
-    };
-    description: {
-        [key: string]: string;
-    };
-    metaTitle: {
-        [key: string]: string;
-    };
-    metaDescription: {
-        [key: string]: string;
-    };
-    metaKeywords: {
-        [key: string]: string;
-    };
-    image?: string | undefined;
-    imageId?: string | undefined;
-    discountValue?: number | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    minOrderAmount: number;
-    isCombinable: boolean;
-    isActive: boolean;
-    conditions: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface PromotionResponse_TitleEntry {
-    key: string;
-    value: string;
-}
-export interface PromotionResponse_DescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface PromotionResponse_MetaTitleEntry {
-    key: string;
-    value: string;
-}
-export interface PromotionResponse_MetaDescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface PromotionResponse_MetaKeywordsEntry {
-    key: string;
-    value: string;
-}
-export interface GetPromotionsRequest {
-    pagination: PaginationRequest | undefined;
-    type?: PromotionType | undefined;
-    status?: PromotionStatus | undefined;
-    search?: string | undefined;
-}
-export interface GetPromotionsResponse {
-    items: PromotionResponse[];
-    meta: PaginationMeta | undefined;
-}
-export interface GetPromotionRequest {
-    id: string;
-}
-export interface CreatePromotionRequest {
-    type: PromotionType;
-    status: PromotionStatus;
-    title: {
-        [key: string]: string;
-    };
-    description: {
-        [key: string]: string;
-    };
-    metaTitle: {
-        [key: string]: string;
-    };
-    metaDescription: {
-        [key: string]: string;
-    };
-    metaKeywords: {
-        [key: string]: string;
-    };
-    image?: string | undefined;
-    imageId?: string | undefined;
-    discountValue?: number | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    minOrderAmount?: number | undefined;
-    isCombinable: boolean;
-    isActive: boolean;
-    conditions: string;
-}
-export interface CreatePromotionRequest_TitleEntry {
-    key: string;
-    value: string;
-}
-export interface CreatePromotionRequest_DescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface CreatePromotionRequest_MetaTitleEntry {
-    key: string;
-    value: string;
-}
-export interface CreatePromotionRequest_MetaDescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface CreatePromotionRequest_MetaKeywordsEntry {
-    key: string;
-    value: string;
-}
-export interface UpdatePromotionRequest {
-    id: string;
-    type?: PromotionType | undefined;
-    status?: PromotionStatus | undefined;
-    title: {
-        [key: string]: string;
-    };
-    description: {
-        [key: string]: string;
-    };
-    metaTitle: {
-        [key: string]: string;
-    };
-    metaDescription: {
-        [key: string]: string;
-    };
-    metaKeywords: {
-        [key: string]: string;
-    };
-    image?: string | undefined;
-    imageId?: string | undefined;
-    discountValue?: number | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    minOrderAmount?: number | undefined;
-    isCombinable?: boolean | undefined;
-    isActive?: boolean | undefined;
-    conditions?: string | undefined;
-}
-export interface UpdatePromotionRequest_TitleEntry {
-    key: string;
-    value: string;
-}
-export interface UpdatePromotionRequest_DescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface UpdatePromotionRequest_MetaTitleEntry {
-    key: string;
-    value: string;
-}
-export interface UpdatePromotionRequest_MetaDescriptionEntry {
-    key: string;
-    value: string;
-}
-export interface UpdatePromotionRequest_MetaKeywordsEntry {
-    key: string;
-    value: string;
-}
-export interface DeletePromotionRequest {
-    id: string;
-}
-export interface GenerateCouponsBatchRequest {
-    promotionId: string;
-    batchName: string;
-    count: number;
-    prefix?: string | undefined;
-    globalUsageLimit?: number | undefined;
-    perUserUsageLimit?: number | undefined;
-}
-export interface GenerateCouponsBatchResponse {
-    batchId: string;
-    generatedCount: number;
-    success: boolean;
-}
-export interface ExportCouponsCSVRequest {
-    promotionId?: string | undefined;
-    batchId?: string | undefined;
-}
-export interface ExportCouponsCSVResponse {
-    downloadUrl: string;
-}
-export interface GetPromotionAnalyticsRequest {
-    promotionId: string;
-}
-export interface PromotionAnalyticsResponse {
-    promotionId: string;
-    totalUses: number;
-    totalDiscountGiven: number;
-    totalRevenue: number;
-    averageDiscount: number;
-    conversionRate: number;
-}
-export declare const PROMO_V1_PACKAGE_NAME = "promo.v1";
-export interface PublicPromoServiceClient {
-    getProductsDiscounts(request: GetProductsDiscountsRequest): Observable<GetProductsDiscountsResponse>;
-    validateAndCalculate(request: ValidateAndCalculateRequest): Observable<ValidateAndCalculateResponse>;
-}
-export interface PublicPromoServiceController {
-    getProductsDiscounts(request: GetProductsDiscountsRequest): Promise<GetProductsDiscountsResponse> | Observable<GetProductsDiscountsResponse> | GetProductsDiscountsResponse;
-    validateAndCalculate(request: ValidateAndCalculateRequest): Promise<ValidateAndCalculateResponse> | Observable<ValidateAndCalculateResponse> | ValidateAndCalculateResponse;
-}
-export declare function PublicPromoServiceControllerMethods(): (constructor: Function) => void;
-export declare const PUBLIC_PROMO_SERVICE_NAME = "PublicPromoService";
-export interface AdminPromoServiceClient {
-    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>;
-    generateCouponsBatch(request: GenerateCouponsBatchRequest): Observable<GenerateCouponsBatchResponse>;
-    exportCouponsCsv(request: ExportCouponsCSVRequest): Observable<ExportCouponsCSVResponse>;
-    getPromotionAnalytics(request: GetPromotionAnalyticsRequest): Observable<PromotionAnalyticsResponse>;
-}
-export interface AdminPromoServiceController {
-    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;
-    generateCouponsBatch(request: GenerateCouponsBatchRequest): Promise<GenerateCouponsBatchResponse> | Observable<GenerateCouponsBatchResponse> | GenerateCouponsBatchResponse;
-    exportCouponsCsv(request: ExportCouponsCSVRequest): Promise<ExportCouponsCSVResponse> | Observable<ExportCouponsCSVResponse> | ExportCouponsCSVResponse;
-    getPromotionAnalytics(request: GetPromotionAnalyticsRequest): Promise<PromotionAnalyticsResponse> | Observable<PromotionAnalyticsResponse> | PromotionAnalyticsResponse;
-}
-export declare function AdminPromoServiceControllerMethods(): (constructor: Function) => void;
-export declare const ADMIN_PROMO_SERVICE_NAME = "AdminPromoService";

package/dist/gen/promo.js

@@ -1,73 +0,0 @@
-"use strict";
-// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
-// versions:
-//   protoc-gen-ts_proto  v2.11.4
-//   protoc               v3.21.12
-// source: promo.proto
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADMIN_PROMO_SERVICE_NAME = exports.PUBLIC_PROMO_SERVICE_NAME = exports.PROMO_V1_PACKAGE_NAME = exports.PromotionStatus = exports.PromotionType = exports.protobufPackage = void 0;
-exports.PublicPromoServiceControllerMethods = PublicPromoServiceControllerMethods;
-exports.AdminPromoServiceControllerMethods = AdminPromoServiceControllerMethods;
-/* eslint-disable */
-const microservices_1 = require("@nestjs/microservices");
-exports.protobufPackage = "promo.v1";
-var PromotionType;
-(function (PromotionType) {
-    PromotionType[PromotionType["PROMOTION_TYPE_UNSPECIFIED"] = 0] = "PROMOTION_TYPE_UNSPECIFIED";
-    PromotionType[PromotionType["PROMOTION_TYPE_FIXED"] = 1] = "PROMOTION_TYPE_FIXED";
-    PromotionType[PromotionType["PROMOTION_TYPE_PERCENTAGE"] = 2] = "PROMOTION_TYPE_PERCENTAGE";
-    PromotionType[PromotionType["PROMOTION_TYPE_COUPON"] = 3] = "PROMOTION_TYPE_COUPON";
-    PromotionType[PromotionType["PROMOTION_TYPE_N_PLUS_M"] = 4] = "PROMOTION_TYPE_N_PLUS_M";
-    PromotionType[PromotionType["PROMOTION_TYPE_FIRST_PURCHASE"] = 5] = "PROMOTION_TYPE_FIRST_PURCHASE";
-    PromotionType[PromotionType["PROMOTION_TYPE_PROMO_PERIOD"] = 6] = "PROMOTION_TYPE_PROMO_PERIOD";
-    PromotionType[PromotionType["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(PromotionType || (exports.PromotionType = PromotionType = {}));
-var PromotionStatus;
-(function (PromotionStatus) {
-    PromotionStatus[PromotionStatus["PROMOTION_STATUS_UNSPECIFIED"] = 0] = "PROMOTION_STATUS_UNSPECIFIED";
-    PromotionStatus[PromotionStatus["PROMOTION_STATUS_ACTIVE"] = 1] = "PROMOTION_STATUS_ACTIVE";
-    PromotionStatus[PromotionStatus["PROMOTION_STATUS_INACTIVE"] = 2] = "PROMOTION_STATUS_INACTIVE";
-    PromotionStatus[PromotionStatus["PROMOTION_STATUS_SCHEDULED"] = 3] = "PROMOTION_STATUS_SCHEDULED";
-    PromotionStatus[PromotionStatus["PROMOTION_STATUS_ARCHIVED"] = 4] = "PROMOTION_STATUS_ARCHIVED";
-    PromotionStatus[PromotionStatus["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(PromotionStatus || (exports.PromotionStatus = PromotionStatus = {}));
-exports.PROMO_V1_PACKAGE_NAME = "promo.v1";
-function PublicPromoServiceControllerMethods() {
-    return function (constructor) {
-        const grpcMethods = ["getProductsDiscounts", "validateAndCalculate"];
-        for (const method of grpcMethods) {
-            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-            (0, microservices_1.GrpcMethod)("PublicPromoService", method)(constructor.prototype[method], method, descriptor);
-        }
-        const grpcStreamMethods = [];
-        for (const method of grpcStreamMethods) {
-            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-            (0, microservices_1.GrpcStreamMethod)("PublicPromoService", method)(constructor.prototype[method], method, descriptor);
-        }
-    };
-}
-exports.PUBLIC_PROMO_SERVICE_NAME = "PublicPromoService";
-function AdminPromoServiceControllerMethods() {
-    return function (constructor) {
-        const grpcMethods = [
-            "getPromotions",
-            "getPromotion",
-            "createPromotion",
-            "updatePromotion",
-            "deletePromotion",
-            "generateCouponsBatch",
-            "exportCouponsCsv",
-            "getPromotionAnalytics",
-        ];
-        for (const method of grpcMethods) {
-            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-            (0, microservices_1.GrpcMethod)("AdminPromoService", method)(constructor.prototype[method], method, descriptor);
-        }
-        const grpcStreamMethods = [];
-        for (const method of grpcStreamMethods) {
-            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
-            (0, microservices_1.GrpcStreamMethod)("AdminPromoService", method)(constructor.prototype[method], method, descriptor);
-        }
-    };
-}
-exports.ADMIN_PROMO_SERVICE_NAME = "AdminPromoService";