@shopby/shop-sdk 1.30.6 → 1.31.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.31.0](https://gitlab.e-ncp.com/ncp-client/shop-sdk/compare/v1.30.6...v1.31.0) (2023-01-16)
+
+
+### Features
+
+* 상품 리뷰 조회 타입 정의 ([9032e96](https://gitlab.e-ncp.com/ncp-client/shop-sdk/commit/9032e969be5ea33a339750cfd05888833a3629ea))
+
 ### [1.30.6](https://gitlab.e-ncp.com/ncp-client/shop-sdk/compare/v1.30.5...v1.30.6) (2023-01-16)
 
 

package/build/src/common/maps/index.d.ts

@@ -1,3 +1,8 @@
 export * from './country';
 export * from './period';
 export * from './term';
+export declare const PLATFORM_TYPE_MAP: {
+    readonly PC: "PC";
+    readonly MOBILE_WEB: "MOBILE_WEB";
+    readonly MOBILE_APP: "MOBILE_APP";
+};

package/build/src/common/maps/index.js

@@ -1,4 +1,9 @@
 export * from './country';
 export * from './period';
 export * from './term';
+export var PLATFORM_TYPE_MAP = {
+    PC: 'PC',
+    MOBILE_WEB: 'MOBILE_WEB',
+    MOBILE_APP: 'MOBILE_APP',
+};
 //# sourceMappingURL=index.js.map

package/build/src/common/maps/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/maps/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/maps/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AAEvB,MAAM,CAAC,IAAM,iBAAiB,GAAG;IAC/B,EAAE,EAAE,IAAI;IACR,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;CAChB,CAAC"}

package/build/src/domain/display/maps/index.d.ts

@@ -28,3 +28,17 @@ export declare const SEARCH_TYPE_MAP: {
     PRODUCT_NAME: string;
     ALL: string;
 };
+export declare const BEST_REVIEW_MAP: {
+    readonly Y: "Y";
+    readonly N: "N";
+};
+export declare const REVIEW_ORDER_DIRECTION_MAP: {
+    readonly ASC: "ASC";
+    readonly DESC: "DESC";
+};
+export declare const REVIEW_ORDER_BY_MAP: {
+    readonly RECOMMEND: "RECOMMEND";
+    readonly REGISTER_YMDT: "REGISTER_YMDT";
+    readonly RATING: "RATING";
+    readonly BEST_REVIEW: "BEST_REVIEW";
+};

package/build/src/domain/display/maps/index.js

@@ -28,4 +28,18 @@ export var SEARCH_TYPE_MAP = {
     PRODUCT_NAME: "상품몀",
     ALL: "전체",
 };
+export var BEST_REVIEW_MAP = {
+    Y: 'Y',
+    N: 'N', // 일반상품평
+};
+export var REVIEW_ORDER_DIRECTION_MAP = {
+    ASC: 'ASC',
+    DESC: 'DESC' // 내림차순
+};
+export var REVIEW_ORDER_BY_MAP = {
+    RECOMMEND: 'RECOMMEND',
+    REGISTER_YMDT: 'REGISTER_YMDT',
+    RATING: 'RATING',
+    BEST_REVIEW: 'BEST_REVIEW', // 베스트리뷰순
+};
 //# sourceMappingURL=index.js.map

package/build/src/domain/display/maps/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/domain/display/maps/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,wBAAwB,GAAG;IACpC,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;CACd,CAAA;AAED,MAAM,CAAC,IAAM,iBAAiB,GAAG;IAC7B,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,OAAO;IAClB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,QAAQ;CACrB,CAAA;AAED,MAAM,CAAC,IAAM,uBAAuB,GAAG;IACnC,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,MAAM;CAChB,CAAA;AAED,MAAM,CAAC,IAAM,eAAe,GAAG;IAC3B,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,KAAK;IACnB,GAAG,EAAE,IAAI;CACZ,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/domain/display/maps/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,wBAAwB,GAAG;IACpC,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;CACd,CAAA;AAED,MAAM,CAAC,IAAM,iBAAiB,GAAG;IAC7B,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,KAAK;IACZ,KAAK,EAAE,KAAK;IACZ,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,OAAO;IAClB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,QAAQ;CACrB,CAAA;AAED,MAAM,CAAC,IAAM,uBAAuB,GAAG;IACnC,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,MAAM;CAChB,CAAA;AAED,MAAM,CAAC,IAAM,eAAe,GAAG;IAC3B,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,KAAK;IACnB,GAAG,EAAE,IAAI;CACZ,CAAA;AAED,MAAM,CAAC,IAAM,eAAe,GAAG;IAC3B,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG,EAAE,QAAQ;CACV,CAAC;AAEX,MAAM,CAAC,IAAM,0BAA0B,GAAG;IACtC,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM,CAAC,OAAO;CACd,CAAC;AAEX,MAAM,CAAC,IAAM,mBAAmB,GAAG;IAC/B,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;IAC9B,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,aAAa,EAAE,SAAS;CAC/B,CAAC"}

package/build/types/domain/display/index.d.ts

@@ -1,7 +1,9 @@
-import { RequestConfig } from '../../http';
-import { BannerGroupCode, OrderByType, SaleStatusType, SectionDisplayType } from '../../common/unions';
-import { ProductInquiryType, ProviderType, DisplayStatusType, SearchType } from './unions';
+import { OptionalAccessTokenRequest, RequestConfig } from '../../http';
+import { BannerGroupCode, OrderByType, SaleStatusType, SectionDisplayType, Yn } from '../../common/unions';
+import { ProductInquiryType, ProviderType, DisplayStatusType, SearchType, ReviewOrderByType, ReviewOrderDirectionType, BestReviewType, PlatformType } from './unions';
 import { Space, SpaceMappingResult } from './space';
+import { Nullable } from 'types/common';
+import { DefaultOrderStatusType, OrderOptionType } from 'types';
 export * from './space';
 export * from './unions';
 export interface GetCategoriesRequest extends RequestConfig {
@@ -819,19 +821,6 @@ export interface ProductsProductNoProductReviewsReviewRatingResponses {
     countOfRating?: number;
     rating?: number;
 }
-export interface ProductsProductNoProductReviews {
-    reviewNo?: number;
-}
-export interface ProductsProductNoProductReviews {
-    password?: string;
-    urls?: Array<object | boolean | string | number>;
-    rate?: number;
-    extraJson?: string;
-    optionNo?: number;
-    orderOptionNo?: number;
-    writerName?: string;
-    content?: string;
-}
 export interface ProductsProductNoProductReviewsReviewNo {
     productTotalCount?: number;
     myReview?: boolean;
@@ -931,14 +920,14 @@ export interface ProfileOrderOptionsProductReviewableDelivery {
     retrieveInvoiceUrl?: string;
     invoiceNo?: string;
 }
-export interface ProfileOrderOptionsProductReviewableInput {
-    inputLabel?: string;
-    inputValue?: string;
+export interface OrderInputOption {
+    inputLabel: string;
+    inputValue: string;
 }
 export interface ProfileOrderOptionsProductReviewableItem {
     claimNo?: number;
     reservationDeliveryYmdt?: string;
-    inputs?: Array<ProfileOrderOptionsProductReviewableInput>;
+    inputs?: Array<Partial<OrderInputOption>>;
     deliverable?: boolean;
     optionUsed?: boolean;
     productName?: string;
@@ -1176,3 +1165,75 @@ export interface DeleteSpacesMappingRequest {
         productNos: string;
     };
 }
+export interface GetProductsProductNoProductReviewsRequest extends OptionalAccessTokenRequest {
+    pathVariable: {
+        productNo: number;
+    };
+    queryString: {
+        'order.by': ReviewOrderByType;
+        'order.direction': ReviewOrderDirectionType;
+        bestReviewYn: Nullable<BestReviewType>;
+        pageNumber: number;
+        pageSize: number;
+        hasTotalCount: boolean;
+        hasAttachmentFile?: boolean;
+    };
+}
+export interface ReviewRating {
+    countOfRating: number;
+    rating: number;
+}
+export interface OrderedOption {
+    optionType: Exclude<OrderOptionType, 'PRODUCT_ONLY'>;
+    optionTitle: string;
+    inputs: Array<OrderInputOption>;
+    orderStatusType: DefaultOrderStatusType;
+    optionValue: string;
+    orderCnt: number;
+    addPrice: number;
+    optionName: string;
+    optionUsed: boolean;
+    orderOptionNo: number;
+}
+export interface ProductReview {
+    productTotalCount: number;
+    myReview: boolean;
+    platformType: PlatformType;
+    memberName: string;
+    content: string;
+    providerType: ProviderType;
+    productName: string;
+    updateYmdt: string;
+    bestReviewYn: BestReviewType;
+    rate: number;
+    imageUrl: string;
+    reviewNo: number;
+    nickname: string;
+    productNo: number;
+    registerYmdt: string;
+    memberId: string;
+    brandName: string;
+    recommendable: boolean;
+    blindReportCnt: number;
+    expelled: boolean;
+    reportCnt: number;
+    fileUrls: Array<string>;
+    reportable: boolean;
+    externalReview: boolean;
+    orderedOption: OrderedOption;
+    recommendCnt: number;
+    commentCount: number;
+    isDeletedProductReview: boolean;
+    productDiscountPrice: number;
+    brandNameEn: string;
+    productRate: number;
+    givenAccumulationYn: Yn;
+    extraJson: string;
+    registerName: string;
+}
+export interface GetProductsProductNoProductReviewsResponse {
+    rate: number;
+    totalCount: number;
+    reviewRatingResponses: Array<ReviewRating>;
+    items: Array<ProductReview>;
+}

package/build/types/domain/display/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../types/domain/display/index.ts"],"names":[],"mappings":"AAeA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../types/domain/display/index.ts"],"names":[],"mappings":"AAsBA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/build/types/domain/display/unions.d.ts

@@ -1,5 +1,9 @@
-import { PRODUCT_INQUIRY_TYPE_MAP, PROVIDER_TYPE_MAP, DISPLAY_STATUS_TYPE_MAP, SEARCH_TYPE_MAP } from '../../../src';
+import { PRODUCT_INQUIRY_TYPE_MAP, PROVIDER_TYPE_MAP, DISPLAY_STATUS_TYPE_MAP, SEARCH_TYPE_MAP, BEST_REVIEW_MAP, REVIEW_ORDER_DIRECTION_MAP, REVIEW_ORDER_BY_MAP, PLATFORM_TYPE_MAP } from '../../../src';
 export declare type ProductInquiryType = keyof typeof PRODUCT_INQUIRY_TYPE_MAP;
 export declare type ProviderType = keyof typeof PROVIDER_TYPE_MAP;
 export declare type DisplayStatusType = keyof typeof DISPLAY_STATUS_TYPE_MAP;
 export declare type SearchType = keyof typeof SEARCH_TYPE_MAP;
+export declare type BestReviewType = keyof typeof BEST_REVIEW_MAP;
+export declare type ReviewOrderDirectionType = keyof typeof REVIEW_ORDER_DIRECTION_MAP;
+export declare type ReviewOrderByType = keyof typeof REVIEW_ORDER_BY_MAP;
+export declare type PlatformType = keyof typeof PLATFORM_TYPE_MAP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopby/shop-sdk",
-  "version": "1.30.6",
+  "version": "1.31.0",
   "description": "",
   "main": "build/src/index.js",
   "types": "build/types/index.d.ts",