@lemoncloud/ssocio-kiosk-api 0.25.423

package/dist/modules/goods/model.d.ts

@@ -0,0 +1,635 @@
+/**
+ * `mock/model.ts`
+ * - model definitions per account data
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2024-07-31 refactoring for product service.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel } from 'lemon-model';
+import { ModelType } from '../../service/backend-types';
+import { AgreedType, CancelConditionType, CurrencyType, DeliveryFeeType, DeliveryMethodType, DeliveryStereo, InputType, NoticeStereo, PolicyStereo, PriceInfo, ProdStereo, ShowBadgeType } from './types';
+import { CategoryHead } from '../category/model';
+import { CategoryNode } from '../category/categories-types';
+import { StockModel } from '../stock/model';
+import { OptionHead } from '../option/model';
+export { ModelType };
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * Type: `ProductHead`
+ */
+export interface ProductHead {
+    /** auto sequence */
+    id?: string;
+    /** 제품 이름 */
+    name?: string;
+    /** stereo type */
+    stereo?: ProdStereo;
+}
+/**
+ * type: `ProductModel` (상품)
+ * - 상품 판매 구성과 관련된 내용
+ */
+export interface ProductModel extends Model, ProductHead {
+    /** stereo type */
+    stereo?: ProdStereo;
+    /** product name */
+    name?: string;
+    /** thumb image (in small-size) in list */
+    thumb?: string;
+    /** (optional) 간단한 설명 */
+    summary?: string;
+    /** 숨기기 설정 (검색조건 not_exists(isHidden) and isHidden=0) */
+    isHidden?: BoolFlag;
+    /** 목록 노출 여부 (must be isDisplay=1) */
+    isDisplay?: BoolFlag;
+    /** 지정된 카테고리 ID (list) */
+    categoryIds?: string[];
+    /** 지정된 카테고리 Head (list) */
+    category$?: CategoryHead[];
+    /** main image url (top) */
+    imageMain?: string;
+    /** additional images in main (추가 이미지들) */
+    imageAdds?: string[];
+    /** detailed images - from origin-url */
+    images?: string[];
+    /** 상세 내용 (in html) - 사용자 수정 */
+    detailHtml?: string;
+    /** 기본 금액 '~' 기능 사용 여부 */
+    usePriceRange?: BoolFlag;
+    /** 통화 타입 */
+    currencyType?: CurrencyType;
+    /** 상품 가격 */
+    price?: number;
+    /** (optional) 통화에 따른 금액 상세 정보 (자동설정) */
+    price$?: PriceInfo;
+    /** 상품 할인 비율 */
+    discount?: number;
+    /** 원 상품 가격 */
+    originPrice?: number;
+    /** 할인된 금액 */
+    savingPrice?: number;
+    /** 최종 판매가 */
+    salesPrice?: number;
+    /** id of catalog-model */
+    catalogId?: string;
+    /** head of catalog-model */
+    catalog$?: CatalogHead;
+    /** id of brand-model */
+    brandId?: string;
+    /** head of brand-model */
+    brand$?: BrandHead;
+    /** 재고 갯수 */
+    stocks?: number;
+    /** (optional) id of stock-model */
+    stockId?: string;
+    /** 판매 설정 관리 id */
+    salesId?: string;
+    /** 판매 설정 모델 */
+    sales$?: SalesHead;
+    /** list of option-id (as option-roots) */
+    optionIds?: string[];
+    /** list of option-name (as option-roots) */
+    option$?: OptionHead[];
+    /** 상품고시(Product Notice) ID */
+    noticeId?: string;
+    /** 상품고시(Product Notice) Name */
+    notice$?: NoticeHead;
+    /** 상품고시 항목들 (기본외의 변경된 값들) */
+    notices?: InputElement[];
+    /**
+     * 이용안내 (Usage Guide) 모델 Id
+     */
+    guideId?: string;
+    /** 이용 안내 모델 */
+    guide$?: UsageGuideHead;
+    /** 이용안내 입력 항목들 (기본설정외에 추가 변경값들) */
+    guides?: InputElement[];
+    /** 옵션 이미지 항목들. */
+    /** 약관 관리 id */
+    agreedIds?: string[];
+    /** 약관 관리 모델 */
+    agreed$?: AgreedHead[];
+    /** 취소 관리 id */
+    cancelId?: string;
+    /** 취소 관리 모델 */
+    cancel$?: CancelHead;
+    /**
+     * 배송정책(Delivery Policy) ID
+     * - 배송방법: 방문수령, 퀵서비스, 택배, 직접배송
+     * - 각 배송방법에 따라서 상세 내용이 달라짐
+     */
+    deliveryId?: string;
+    /** name of delivery-id */
+    delivery$?: DeliveryHead;
+    /** 배송정책 입력 항목들 (기본설정외에 추가 변경값들) */
+    deliveries?: InputElement[];
+    /**
+     * 반품/교환(Return and Exchange) 정책ID
+     * - 배송방법: 택배(기본)
+     * - 각 배송방법에 따라서 설정값이 달라짐
+     *
+     * TODO - 다중 정책에 대한 처리 방법 개선하기 @230720
+     */
+    policyId?: string;
+    /** name of exchange-id */
+    policy$?: PolicyHead;
+    /** 배송정책 입력 항목들 (기본설정외에 추가 변경값들) */
+    policies?: InputElement[];
+    /**
+     * (optional) 노출 관리 id
+     * - `displayId`가 비어 있는 경우, `display$` 만 저장됨
+     * - `displayId`가 존재하는 경우, `DisplayModel`를 참고해서 `display$`를 채워줌.
+     */
+    displayId?: string;
+    /** 노출 관리 모델 */
+    display$?: DisplayHead;
+    /**
+     * (internal) the linked cancel model.
+     */
+    readonly $cancel?: CancelModel;
+    /**
+     * (internal) the linked sales model.
+     */
+    readonly $sales?: SalesModel;
+    /**
+     * (internal) the linked notice model.
+     */
+    readonly $notice?: NoticeModel;
+    /**
+     * (internal) the linked display model.
+     */
+    readonly $display?: DisplayModel;
+    /**
+     * (internal) the linked delivery model.
+     */
+    readonly $delivery?: DeliveryModel;
+    /**
+     * (internal) the linked policy model.
+     */
+    readonly $policy?: PolicyModel;
+    /**
+     * (internal) the linked stock model.
+     */
+    readonly $stock?: StockModel;
+}
+/**
+ * Type: `CatalogHead`
+ */
+export interface CatalogHead {
+    /** auto sequence */
+    id?: string;
+    /** 카탈로그 이름 */
+    name?: string;
+}
+/**
+ * type: `CatalogModel` (카탈로그)
+ * - 카탈로그 모델
+ */
+export interface CatalogModel extends Model, CategoryNode, CatalogHead {
+    /** 상위 부모의 ID */
+    parent?: string;
+    /** 상위 부모의 Name */
+    parentName?: string;
+    /** 카탈로그 이름 */
+    name?: string;
+}
+/**
+ * Type: `BrandHead`
+ */
+export interface BrandHead {
+    /** auto sequence */
+    id?: string;
+    /** 브랜드 이름 */
+    name?: string;
+}
+/**
+ * 브랜드(Brand) 정보.
+ * - 이름별로 고유한 인덱스값을 가짐 (using md5 hash)
+ */
+export interface BrandModel extends Model, CategoryNode, BrandHead {
+    /**
+     * (UNIQUE) string name.
+     */
+    name?: string;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: BoolFlag;
+    /**
+     * (unique) hash code of name
+     */
+    hash?: string;
+    /**
+     * some description.
+     */
+    desc?: string;
+    /**
+     * 브랜드 이미지
+     */
+    image?: string;
+    /**
+     * 메이커이름.
+     */
+    maker?: string;
+    /**
+     * found some error.
+     */
+    error?: string;
+    /**
+     * 브랜드_영문
+     */
+    nameEn?: string;
+    /**
+     * 브랜드_상세이미지
+     */
+    imageDetail?: string;
+}
+/**
+ * Type: `NoticeHead`
+ */
+export interface NoticeHead {
+    /** auto sequence */
+    id?: string;
+    /** 고시(관리) 이름 */
+    name?: string;
+}
+/**
+ * type: `NoticeModel` (고시/안내 등)
+ * - 상품고시등 정보 관리
+ */
+export interface NoticeModel extends Model, NoticeHead {
+    /**
+     * 고시ID (auto)
+     */
+    id?: string;
+    /**
+     * stereo types.
+     */
+    stereo?: NoticeStereo;
+    /** name of model */
+    name?: string;
+    /** 지정된 카테고리 ID (list) */
+    categoryIds?: string[];
+    /** 지정된 카테고리 Name (list) */
+    categoryNames?: string[];
+    /** 지정된 카테고리 Path (list) */
+    categoryPaths?: string[];
+    /** 상품고시 항목들 (기본 값들) */
+    notices?: InputElement[];
+}
+/**
+ * Type: `DeliveryHead`
+ */
+export interface DeliveryHead extends UseAddressBasic {
+    /** 배송ID (auto) */
+    id?: string;
+    /** 배송(관리) 이름 */
+    name?: string;
+}
+/**
+ * type: `DeliveryModel` (배송)
+ * - 배송방법(업체)와 관련한 데이터 정리
+ * - 스테레오: 배송방법(method) / 택배사(company)
+ */
+export interface DeliveryModel extends Model, DeliveryHead {
+    /**
+     * stereo types.
+     */
+    stereo?: DeliveryStereo;
+    /** 배송 방법 타입 */
+    deliveryType?: DeliveryMethodType;
+    /** 배송 요금 타입  */
+    feeType?: DeliveryFeeType;
+    /** (optional) 배송안내 */
+    notice?: string;
+    /** (optional) 택배사명 */
+    company?: string;
+    /** (optional) 기본 배송비 */
+    deliveryDefaultFee?: number;
+    /** (optional) 기본 배송비 상세 정보 (자동설정) */
+    defaultPrice$?: PriceInfo;
+    /** (optional) 무료배송 충족 조건 */
+    deliveryFreeFee?: number;
+    /** (optional) 무료배송 충족 조건 (자동설정) */
+    minFreePrice$?: PriceInfo;
+    /** id of owner (mp) (linked `ssocio2-backend-api`) */
+    ownerId?: string;
+    /** name of owner (mp) (linked `ssocio2-backend-api`) */
+    ownerName?: string;
+    /** (linked) id of proudct */
+    prodId?: string;
+}
+/**
+ * Type: `PolicyHead`
+ */
+export interface PolicyHead {
+    /** auto sequence */
+    id?: string;
+    /** 정책(관리) 이름 */
+    name?: string;
+}
+/**
+ * type: `PolicyModel` (정책)
+ * - 정책 관련 정보를 저장함.
+ */
+export interface PolicyModel extends Model, UseAddressBasic, PolicyHead {
+    /**
+     * 정책ID (auto)
+     */
+    id?: string;
+    /**
+     * stereo types.
+     */
+    stereo?: PolicyStereo;
+    /** name of model */
+    name?: string;
+    /**
+     * 배송방법ID
+     */
+    deliveryMethodId?: string;
+    /** 배송방법 이름 (복제) */
+    deliveryMethodName?: string;
+    /**
+     * 배송회사ID
+     */
+    deliveryCompanyId?: string;
+    /** 배송회사 이름 (복제) */
+    deliveryCompanyName?: string;
+    /**
+     * 반품회사ID
+     */
+    returnCompanyId?: string;
+    /** 반품회사 이름 (복제) */
+    returnCompanyName?: string;
+    /** 반품 (편도) */
+    returnFee?: number;
+    /**
+     * 교환회사ID
+     */
+    exchangeCompanyId?: string;
+    /** 교환회사 이름 (복제) */
+    exchangeCompanyName?: string;
+    /** 교환 (왕복) */
+    exchangeFee?: number;
+    /**
+     * 무료 배송 여부
+     */
+    isFree?: number;
+    /**
+     * 조건부 무료 설정 여부
+     */
+    hasFreeCondition?: number;
+    /**
+     * 기본 배송비 (ex: 2000)
+     */
+    deliveryFee?: number;
+    /**
+     * 무료 배송 최소 구매액
+     * - 유효조건: `isFree && hasCondition`
+     */
+    minFreePrice?: number;
+}
+/**
+ * Type: `SalesHead`
+ * - 판매 및 할인 정보
+ */
+export interface SalesHead {
+    /** auto sequence */
+    id?: string;
+    /** 할인 이름 */
+    name?: string;
+    /** 할인 금액 */
+    salePrice?: number;
+    /** (optional) 할인 금액 정보 (자동설정) */
+    salePrice$?: PriceInfo;
+    /** (optional) 세일 기간 설정 사용여부 */
+    usePeriod?: BoolFlag;
+    /** (optional) 세일 기간 시작 (timestamp) */
+    periodT1?: number;
+    /** (optional) 세일 기간 종료 (timestamp) */
+    periodT2?: number;
+}
+/**
+ * Type: `SalesModel`
+ * - 판매 및 할인 관리 모델
+ */
+export interface SalesModel extends SalesHead, Model {
+    /** auto sequence */
+    id?: string;
+    /** (optional) 판매 시작 시각 (timestamp) */
+    salesFrom?: number;
+    /** (optional) 판매 종료 시각 (timestamp) */
+    salesTo?: number;
+    /** (optional) 취소 기간 사용 여부 */
+    useCancelPeriod?: BoolFlag;
+    /** (optional) 취소 시작 시각 (timestamp) */
+    cancelFrom?: number;
+    /** (optional) 취소 종료 시각 (timestamp) */
+    cancelTo?: number;
+    /** (optional) 최소 주문 수량 */
+    minOrderQuantity?: number;
+    /** (optional) 최대 주문 수량 */
+    maxOrderQuantity?: number;
+    /** (linked) id of proudct */
+    prodId?: string;
+}
+/**
+ * Type: `AgreedHead`
+ */
+export interface AgreedHead {
+    /** auto sequence */
+    id?: string;
+    /** 약관 정책 이름 */
+    name?: string;
+}
+/**
+ * Type : `AgreedModel`
+ * - 약정 모델
+ */
+export interface AgreedModel extends Model, AgreedHead {
+    /** id: <auto-seq> */
+    id?: string;
+    /** 카테고리 ids */
+    categoryId?: string;
+    /** name of parent Category */
+    categoryName?: string;
+    /** path of parent Category */
+    categoryPath?: string;
+    /** 약관명 */
+    name?: string;
+    /** type of agrees */
+    agreedType?: AgreedType;
+    /** agreement text */
+    text?: string;
+}
+/**
+ * Type: `CancelHead`
+ */
+export interface CancelHead {
+    /** auto sequence */
+    id?: string;
+    /** 취소 정책 이름 */
+    name?: string;
+    /** 취소 허용 여부 */
+    useCancel?: BoolFlag;
+    /** 취소 사유 */
+    reasons?: string[];
+}
+/**
+ * Type: `CancelModel`
+ * - 취소 관리 모델
+ */
+export interface CancelModel extends Model, CancelHead {
+    /** 취소 조건 사용 여부 */
+    hasCondition?: BoolFlag;
+    /** 취소 조건 타입 */
+    condition?: CancelConditionType;
+    /** 취소 허용 시작 시각 */
+    from?: number;
+    /** 취소 허용 종료 시각 */
+    to?: number;
+}
+/**
+ * Type: `DisplayHead`
+ */
+export interface DisplayHead {
+    /** auto-sequence */
+    id?: string;
+    /** 취소 정책 이름 */
+    name?: string;
+    /** 노출 상태 (1: 노출, 0: 노출안함 )*/
+    isDisplay?: BoolFlag;
+    /** 대분류 카테고리 ID */
+    majorCategoryId?: string;
+    /** 중분류 카테고리 */
+    minorCategoryId?: string;
+    /** 목록 노출 시작 일자 (timestamp) */
+    startedAt?: number;
+    /** 목록 노출 종료 일자 (timestamp) */
+    expiredAt?: number;
+    /** 상품뱃지타입 */
+    showBadgeType?: ShowBadgeType;
+}
+/**
+ * Type: `DisplayModel`
+ * - 노출 관리 모델
+ */
+export interface DisplayModel extends Model, DisplayHead {
+}
+/**
+ * Type: `UsageGuideHead`
+ */
+export interface UsageGuideHead {
+    /** id of model (auto-seq) */
+    id?: string;
+    /** name of model */
+    name?: string;
+    /** 이용 안내 항목들 */
+    guides?: InputElement[];
+}
+export interface UsageGuideModel extends Model, UsageGuideHead {
+}
+/** about each input-element */
+export interface InputElement {
+    /** name of notice (ex: 제품색상) */
+    name?: string;
+    /** stereo type */
+    type?: InputType;
+    /** placeholder help text (ex: 색상을 입력해주세요.) */
+    help?: string;
+    /** the input value in string (ex: 빨강,파랑) */
+    value?: string;
+    /** 필수 항목 */
+    required?: number;
+}
+/**
+ * 주소입력 지원
+ */
+export interface UseAddressBasic {
+    /** 주소(우편번호) */
+    addrPost?: string;
+    /** 주소(거리=우편번호매칭) */
+    addrStreet?: string;
+    /** 주소(상세) */
+    addrDetail?: string;
+    /** 주소(추가) */
+    addrExtra?: string;
+}
+/**
+ * extract field names from models
+ * - only fields start with lowercase, or all upper.
+ */
+export declare const filterFields: (fields: string[], base?: string[]) => string[];
+/** field names from head */
+export declare const $HEAD: {
+    product: string[];
+    catalog: string[];
+    category: string[];
+    brand: string[];
+    notice: string[];
+    delivery: string[];
+    policy: string[];
+    sales: string[];
+    agreed: string[];
+    cancel: string[];
+    display: string[];
+    guide: string[];
+};
+export declare const $FIELD: {
+    product: string[];
+    catalog: string[];
+    brand: string[];
+    notice: string[];
+    delivery: string[];
+    policy: string[];
+    sales: string[];
+    agreed: string[];
+    cancel: string[];
+    display: string[];
+    guide: string[];
+    mock: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        product: string[];
+        catalog: string[];
+        category: string[];
+        brand: string[];
+        notice: string[];
+        delivery: string[];
+        policy: string[];
+        sales: string[];
+        agreed: string[];
+        cancel: string[];
+        display: string[];
+        guide: string[];
+    };
+    $FIELD: {
+        product: string[];
+        catalog: string[];
+        brand: string[];
+        notice: string[];
+        delivery: string[];
+        policy: string[];
+        sales: string[];
+        agreed: string[];
+        cancel: string[];
+        display: string[];
+        guide: string[];
+        mock: string[];
+    };
+};
+export default _default;