@lemoncloud/ssocio-kiosk-api 0.25.423

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

@@ -0,0 +1,331 @@
+/**
+ * `goods/types.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { SimpleSet } from 'lemon-model';
+import { PaginateParam } from '../../cores/types';
+export { SimpleSet };
+/**
+ * type: `PriceInfo`
+ * - 가격 정보를 위한 인터페이스
+ */
+export interface PriceInfo {
+    /** type of currency code (ex: USD) */
+    currency: CurrencyType;
+    /** price in milli (:= price * 1000) */
+    millis: number;
+    /** double value */
+    double?: number;
+    /**
+     * price format
+     * - like `#.##0.00` (check the excel formatter)
+     */
+    format?: string;
+    /**
+     * formatted string
+     */
+    formatted?: string;
+}
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+export declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** product model */
+        product: string;
+        /** sales model */
+        sales: string;
+        /** notice model */
+        notice: string;
+        /** guide model */
+        guide: string;
+        /** agreed model */
+        agreed: string;
+        /** delivery model */
+        delivery: string;
+        /** policy model */
+        policy: string;
+        /** display model */
+        display: string;
+        /** catalog model */
+        catalog: string;
+        /** brand model */
+        brand: string;
+        /** cancel model */
+        cancel: string;
+    };
+    /** 상품의 종류 */
+    ProdStereo: {
+        '': string;
+        /** 배송형 */
+        delivery: string;
+        /** 방문형 */
+        visit: string;
+        /** 매장형 */
+        store: string;
+    };
+    /**
+     * CurrencyType
+     * - 화폐의 종류
+     */
+    CurrencyType: {
+        /** 달러 */
+        USD: string;
+        /** 원화 */
+        KRW: string;
+        /** 유로 */
+        EUR: string;
+    };
+    /**
+     * CurrencyFormatType
+     * - 화폐 양식 타입
+     */
+    CurrencyFormatType: {
+        USD: string;
+        KRW: string;
+        EUR: string;
+    };
+    /**
+     * NoticeStereo
+     */
+    NoticeStereo: {
+        '': string;
+        product: string;
+    };
+    InputType: {
+        '': string;
+        text: string;
+        textarea: string;
+    };
+    /** 약관종류 */
+    AgreedType: {
+        /** no selection */
+        '': string;
+        /** 필수 약관 */
+        required: string;
+        /** 선택 약관 */
+        optional: string;
+    };
+    PolicyStereo: {
+        '': string;
+        delivery: string;
+        exchange: string;
+    };
+    DeliveryStereo: {
+        '': string;
+        method: string;
+        company: string;
+    };
+    /**
+     * 상품 기간/시간 예약 설정 타입
+     */
+    ReserveStartType: {
+        /** 기간 설정 */
+        period: string;
+        /** 오늘 기준 */
+        today: string;
+    };
+    /**
+     * 배송 방법 타입
+     */
+    DeliveryMethod: {
+        /** 방문수령 */
+        visit: string;
+        /** 퀵서비스 */
+        quick: string;
+        /** 택배 */
+        parcel: string;
+        /** 직접배송 */
+        direct: string;
+    };
+    /**
+     * 배송비 타입
+     */
+    DeliveryFeeType: {
+        /** 무료배송 */
+        free: string;
+        /** 유료배송 */
+        paid: string;
+        /** 조건부무료배송 */
+        coditional: string;
+    };
+    /**
+     * 상품 상태 구분
+     */
+    ProductStatus: {
+        '': string;
+        /** 판매 */
+        sale: string;
+        /** 품절 */
+        soldout: string;
+        /** 숨김 */
+        hidden: string;
+    };
+    /**
+     * 할인방식
+     */
+    DiscountMethod: {
+        /** 금액 할인 */
+        price: string;
+        /** 할인율 */
+        percent: string;
+    };
+    /**
+     * 요일 (WeekDay)의 number 타입
+     * - Date 객체와 호환을 위함.
+     * */
+    WeekDayNumType: {
+        /** sun (Sunday): 0 */
+        sun: number;
+        /** mon (Monday): 1 */
+        mon: number;
+        /** tue (Tuesday): 2 */
+        tue: number;
+        /** wed (Wednesday): 3 */
+        wed: number;
+        /** thu (Thursday): 4 */
+        thu: number;
+        /** fri (Friday): 5 */
+        fri: number;
+        /** sat (Saturday): 6 */
+        sat: number;
+    };
+    /**
+     * 요일 (WeekDay)의 한국어 타입
+     * */
+    WeekDayKorType: {
+        /** 일요일 */
+        sun: string;
+        /** 월요일 */
+        mon: string;
+        /** 화요일 */
+        tue: string;
+        /** 수요일 */
+        wed: string;
+        /** 목요일 */
+        thu: string;
+        /** 금요일 */
+        fri: string;
+        /** 토요일 */
+        sat: string;
+    };
+    /** 상품 노출 뱃지 타입 */
+    ShowBadgeType: {
+        /** A type */
+        A: string;
+        /** B type */
+        B: string;
+        /** C type */
+        C: string;
+        /** D type */
+        D: string;
+        /** E type */
+        E: string;
+    };
+    /** 취소 조건 타입  */
+    CancelConditionType: {
+        /** 조건없음 */
+        '': string;
+        /** 상품 준비 전까지 취소 가능 */
+        beforePrepare: string;
+        /** 배송 전까지 취소 가능 */
+        beforeDelivery: string;
+        /** 취소기간내 */
+        inPeriod: string;
+    };
+};
+/**
+ *  type: `AgreedType`
+ */
+export declare type AgreedType = keyof typeof $LUT.AgreedType;
+/**
+ *  type: `InputType`
+ */
+export declare type InputType = keyof typeof $LUT.InputType;
+export declare type ReserveStartType = keyof typeof $LUT.ReserveStartType;
+/**
+ * type: DeliveryMethodType
+ */
+export declare type DeliveryMethodType = keyof typeof $LUT.DeliveryMethod;
+/**
+ * type: DeliveryFeeType
+ */
+export declare type DeliveryFeeType = keyof typeof $LUT.DeliveryFeeType;
+/**
+ * type: ProductStatusType
+ */
+export declare type ProductStatusType = keyof typeof $LUT.ProductStatus;
+/**
+ * type: DiscountMethod
+ */
+export declare type DiscountMethod = keyof typeof $LUT.DiscountMethod;
+/**
+ * stereo-type of notice (상품고시)
+ */
+export declare type NoticeStereo = keyof typeof $LUT.NoticeStereo;
+/**
+ * stereo-type of policy
+ */
+export declare type PolicyStereo = keyof typeof $LUT.PolicyStereo;
+/**
+ * stereo-type of delivery
+ */
+export declare type DeliveryStereo = keyof typeof $LUT.DeliveryStereo;
+/**
+ * type: `WeekDayNumType`
+ */
+export declare type WeekDayNumType = keyof typeof $LUT.WeekDayNumType;
+/**
+ * type: `WeekDayKorType`
+ */
+export declare type WeekDayKorType = keyof typeof $LUT.WeekDayKorType;
+/**
+ * type: `ProdStereo`
+ */
+export declare type ProdStereo = keyof typeof $LUT.ProdStereo;
+/**
+ * type: `CurrencyType`
+ */
+export declare type CurrencyType = keyof typeof $LUT.CurrencyType;
+/**
+ * type: `CurrencyFormatType`
+ */
+export declare type CurrencyFormatType = keyof typeof $LUT.CurrencyFormatType;
+/**
+ * type:`ShowBadgeType`
+ */
+export declare type ShowBadgeType = keyof typeof $LUT.ShowBadgeType;
+/**
+ * type:`CancelConditionType`
+ */
+export declare type CancelConditionType = keyof typeof $LUT.CancelConditionType;
+/**
+ * query param for prods-list
+ */
+export interface ProdListParam extends PaginateParam {
+    /** sort selection (default latest) */
+    sort?: 'latest' | 'popular' | 'lowPrice' | 'highPrice' | 'ranking';
+    /** filter by category-id */
+    categoryId?: string;
+    /** filter `isDisplay` condition (default true) */
+    display?: boolean | '' | 'true' | 'false';
+    /**
+     * where to view
+     * - main에서는 `priceSale`이 `isSale`과 상관없이 최종 구매가로 설정되도록 (false일때 `price`와 동일)
+     */
+    view?: '' | 'main';
+    /** show the detail infor (default false) */
+    detail?: boolean | string;
+}
+/** must export $LUT as default */
+export default $LUT;

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

@@ -0,0 +1,210 @@
+/**
+ * `goods/views.ts`
+ * - type of views used in `backend-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2025-03-18 refactoring for goods service.
+ * @Copyright   (C) 2025 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { View, Body } from 'lemon-model';
+import { AgreedModel, BrandModel, CancelModel, CatalogModel, DeliveryModel, DisplayModel, InputElement, NoticeModel, PolicyModel, ProductModel, SalesModel, UsageGuideModel } from './model';
+import { CategoryView } from '../category/views';
+import { StockView } from '../stock/views';
+import $LUT from './types';
+export * from './types';
+export default $LUT;
+/**!SECTION */
+/**
+ * type `CatalogView`
+ */
+export interface CatalogView extends View, Partial<CatalogModel> {
+}
+/**
+ * type `CatalogBody`
+ */
+export interface CatalogBody extends Body, Partial<Omit<CatalogView, 'parentName'>> {
+}
+/**
+ * type `BrandView`
+ */
+export interface BrandView extends View, Omit<Partial<BrandModel>, 'hidden'> {
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: boolean;
+}
+/**
+ * type `BrandBody`
+ */
+export interface BrandBody extends Body, Partial<Omit<BrandView, 'parentName'>> {
+}
+/**
+ * type: `ProductView`
+ */
+export interface ProductView extends View, Partial<Omit<ProductModel, 'isHidden' | 'isDisplay' | 'usePriceRange' | 'notices' | 'deliveries' | 'policies' | 'guides' | 'sales$' | 'agreed$' | 'cancel$' | 'display$' | 'catalog$' | 'category$' | 'brand$' | 'notice$' | 'delivery$' | 'policy$' | 'guide$' | 'stock$' | 'originPrice' | 'savingPrice' | 'salesPrice'>> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+    /**
+     * 쇼핑숨김 설정여부 (외부에는 삭제등으로 보임)
+     */
+    isHidden?: boolean;
+    /**
+     * 쇼핑목록 보기여부 (검색에서 외부 노출여부)
+     */
+    isDisplay?: boolean;
+    /**
+     * 기본판매가(`price`) ‘~’ 기능 사용여부
+     */
+    usePriceRange?: boolean;
+    /** 원 상품 가격 (ex: `$1.1` ) */
+    originPrice?: string;
+    /** 할인된 금액 */
+    savingPrice?: string;
+    /** 최종 구매가 */
+    salesPrice?: string;
+    /**
+     * option layout (default is `grouped`)
+     */
+    /**
+     * 선택 옵션들
+     */
+    /**
+     * 추가 선택 옵션들
+     */
+    /** 상품고시 항목들 */
+    notices?: InputElementView[];
+    /** 배공 정책 항목들 */
+    deliveries?: InputElementView[];
+    /** 교환 정책 항목들 */
+    policies?: InputElementView[];
+    /** 이용 안내 항목들 */
+    guides?: InputElementView[];
+    /** (internal) the linked catalog-model */
+    readonly catalog$?: CatalogView;
+    /** (internal) the linked category-model */
+    readonly category$?: CategoryView[];
+    /** (internal) the linked brand-model */
+    readonly brand$?: BrandView;
+    /** (internal) the linked sales-model */
+    readonly sales$?: SalesView;
+    /** (internal) the linked agreed-model */
+    readonly agreed$?: AgreedView[];
+    /** (internal) the linked cancel-model */
+    readonly cancel$?: CancelView;
+    /** (internal) the linked display-model */
+    readonly display$?: DisplayView;
+    /** (internal) the linked notice-model */
+    readonly notice$?: NoticeView;
+    /** (internal) the linked delivery-model */
+    readonly delivery$?: DeliveryView;
+    /** (internal) the linked policy-model */
+    readonly policy$?: PolicyView;
+    /** (internal) the linked guide-model */
+    readonly guide$?: UsageGuideView;
+    /** (internal) the linked stock-model */
+    readonly stock$?: StockView;
+}
+/**
+ * Type `ProductBody`
+ */
+export interface ProductBody extends Body, Partial<Omit<ProductView, ''>> {
+}
+/** type: `NoticeView` */
+export interface NoticeView extends View, Partial<Omit<NoticeModel, 'required' | 'notices'>> {
+    /** 상품고시 항목들 */
+    notices?: InputElementView[];
+}
+/** type `NoticeBody` */
+export interface NoticeBody extends Body, Partial<NoticeView> {
+}
+/** type: `DeliveryView` */
+export interface DeliveryView extends View, Partial<Omit<DeliveryModel, 'required' | 'isFree'>> {
+    /** 무료배송여부 flag */
+    isFree?: boolean;
+}
+/** type `DeliveryBody` */
+export interface DeliveryBody extends Body, Partial<DeliveryView> {
+}
+/** type: `PolicyView` */
+export interface PolicyView extends View, Partial<Omit<PolicyModel, 'required' | 'isFree' | 'hasFreeCondition'>> {
+    /**
+     * 무료 배송 여부
+     */
+    isFree?: boolean;
+    /**
+     * 조건부 무료/유료
+     */
+    hasFreeCondition?: boolean;
+}
+/** type `PolicyBody` */
+export interface PolicyBody extends Body, Partial<PolicyView> {
+}
+/**
+ * type: `SalesView`
+ */
+export interface SalesView extends View, Omit<Partial<SalesModel>, 'usePeriod' | 'useCancelPeriod'> {
+    /** use period setting */
+    usePeriod?: boolean;
+    /** use cancel-period setting */
+    useCancelPeriod?: boolean;
+}
+/**
+ * type: `SalesBody`
+ */
+export interface SalesBody extends Body, Partial<SalesView> {
+}
+/**
+ * type: `AgreedView`
+ */
+export interface AgreedView extends View, Omit<Partial<AgreedModel>, 'required'> {
+    /** use image */
+    required?: boolean;
+}
+/**
+ * type: `AgreedBody`
+ */
+export interface AgreedBody extends Body, Partial<AgreedView> {
+}
+/**
+ * type: `CancelView`
+ */
+export interface CancelView extends View, Omit<Partial<CancelModel>, 'hasCondition' | 'useCancel'> {
+    /** flag to allow cancellation */
+    useCancel?: boolean;
+    /** use cancel condition */
+    hasCondition?: boolean;
+}
+/**
+ * type: `CancelBody`
+ */
+export interface CancelBody extends Body, Partial<CancelView> {
+}
+/**
+ * type: `DisplayView`
+ */
+export interface DisplayView extends View, Omit<Partial<DisplayModel>, 'isDisplay'> {
+    /** flag to display in front */
+    isDisplay?: boolean;
+}
+/**
+ * type: `DisplayBody`
+ */
+export interface DisplayBody extends Body, Partial<DisplayView> {
+}
+/** type: `UsageGuideView` */
+export interface UsageGuideView extends View, Partial<Omit<UsageGuideModel, 'required' | 'guides'>> {
+    /** 이용안내 항목들 */
+    guides?: InputElementView[];
+}
+/** type `UsageGuideBody` */
+export interface UsageGuideBody extends Body, Partial<UsageGuideView> {
+}
+/** custom input-element */
+export interface InputElementView extends Partial<Omit<InputElement, 'required'>> {
+    /** 필수 입력 항목 */
+    required?: boolean;
+}

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

@@ -0,0 +1,97 @@
+/**
+ * `mock/model.ts`
+ * - model definitions per account data
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel, NextIdentityAccess } from 'lemon-model';
+import { ModelType, SimpleSet } from '../../service/backend-types';
+export { ModelType };
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: `MockHead`
+ * - common head of mock-model.
+ */
+export interface MockHead {
+    /** id of mock */
+    id?: string;
+    /** name of mock */
+    name?: string;
+}
+/**
+ * `mock`: internal mock model.
+ * - provice mocks data
+ */
+export interface MockModel<T = string> extends MockHead, Model {
+    /** name of this model */
+    name?: string;
+    /** alias-id when stereo='#alias' */
+    aliasId?: string;
+    /** json encoding all data */
+    meta?: T;
+}
+export interface MockModelExt<T = string> extends MockModel<T> {
+    /** extended data with any type */
+    [key: string]: any;
+}
+/**
+ * type: `TestHead`
+ * - common head of test-model.
+ */
+export interface TestHead {
+    /** internal reference */
+    _idx?: number;
+    /** internal date(YYYY-MM-DD) */
+    _date?: string;
+}
+/**
+ * `test`: internal test model.
+ */
+export interface TestModel extends Model, TestHead {
+    /** name of model */
+    name?: string;
+    /** test count */
+    count?: number;
+    /** (optional) extra */
+    extra?: SimpleSet;
+    /**
+     * inner Object.
+     */
+    readonly Model?: Model;
+    /**
+     * (view) Access Infor.
+     */
+    readonly $identity?: NextIdentityAccess;
+}
+/**
+ * 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: {
+    mock: string[];
+    test: string[];
+};
+export declare const $FIELD: {
+    mock: string[];
+    test: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        mock: string[];
+        test: string[];
+    };
+    $FIELD: {
+        mock: string[];
+        test: string[];
+    };
+};
+export default _default;

package/dist/modules/mock/types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * `mock/types.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { SimpleSet } from 'lemon-model';
+export { SimpleSet };
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** mock model */
+        mock: string;
+        /** test model */
+        test: string;
+    };
+    /** type: MockStereo */
+    MockStereo: {
+        '': string;
+        '#': string;
+        '#alias': string;
+    };
+};
+/**
+ * type: `MockStereo`
+ */
+export declare type MockStereo = keyof typeof $LUT.MockStereo;
+/** must export $LUT as default */
+export default $LUT;