@lemoncloud/ssocio-kiosk-api 0.25.423

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

@@ -0,0 +1,50 @@
+/**
+ * `mock/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-04-16 refactoring for mock service.
+ * @Copyright   (C) 2025 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { View, Body } from 'lemon-model';
+import $LUT from './types';
+import { MockModel, TestModel } from './model';
+export * from './types';
+export default $LUT;
+/**!SECTION */
+/**
+ * type: `MockView`
+ * - usually same as post's body.
+ */
+export interface MockView extends View, Omit<Partial<MockModel>, 'required'> {
+    /**
+     * (optional) flag required.
+     */
+    required?: boolean;
+}
+/**
+ * Type `MockBody`
+ */
+export interface MockBody extends Body, Partial<MockView> {
+}
+/**
+ * type: `TestView`
+ * - usually same as post's body.
+ */
+export interface TestView extends View, Omit<Partial<TestModel>, 'id' | 'required'> {
+    /**
+     * unique id of this type
+     */
+    id: string;
+    /**
+     * (optional) flag required.
+     */
+    required?: boolean;
+}
+/**
+ * Type `TestBody`
+ */
+export interface TestBody extends Body, Partial<TestView> {
+}

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

@@ -0,0 +1,185 @@
+/**
+ * `option/model.ts`
+ * - model definitions per account data
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * @author      Simon <wookeun@sl-platform.com>
+ * @date        2025-04-21 refactoring for product service.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel } from 'lemon-model';
+import { ModelType } from '../../service/backend-types';
+import { OptionStereo } from './types';
+import { StockModel } from '../stock/model';
+export { ModelType };
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * type: `OptionTypeName`
+ */
+export interface OptionTypeName {
+    /** type of option (ex: color) */
+    type: string;
+    /** (additional) name of option (ex: color) */
+    name?: string;
+    /** selectable option names (ex: blue,red) */
+    names?: string[];
+}
+/**
+ * type: `OptionUnitName`
+ */
+export interface OptionUnitName {
+    /** id of option-unit */
+    id: string;
+    /** name of option */
+    name: string;
+    /** option inline-string */
+    option: string;
+}
+/**
+ * Type: `OptionHead`
+ */
+export interface OptionHead {
+    /** auto sequence */
+    id?: string;
+    /** 옵션(관리) 이름 */
+    name?: string;
+}
+/**
+ * type: `OptionModel` (옵션)
+ * - selectable option model
+ * - 주의) 1차원으로 펼쳐놓은듯 데이터를 관리함 (엑셀 호환되도록)
+ */
+export interface OptionModel extends Model, OptionHead {
+    /**
+     * local id of option
+     */
+    id?: string;
+    /**
+     * stereo types.
+     */
+    stereo?: OptionStereo;
+    /**
+     * parent-id (:= id of option-group)
+     */
+    parent?: string;
+    /** option-id (which is unique in option-model) */
+    oid?: string;
+    /** (TODO) item-id linked */
+    iid?: string;
+    /** (TODO) prod-id linked */
+    pid?: string;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: BoolFlag;
+    /**
+     * soldout(품절) flag
+     */
+    soldout?: BoolFlag;
+    /**
+     * invalid flag
+     */
+    invalid?: BoolFlag;
+    /**
+     * required flag
+     */
+    required?: BoolFlag;
+    /**
+     * combined flag (options in combination)
+     */
+    combined?: BoolFlag;
+    /**
+     * type flag (option in classification)
+     */
+    useType?: BoolFlag;
+    /** name of this model */
+    name?: string;
+    /** selected option names */
+    names?: string[];
+    /** single-line option-text */
+    option?: string;
+    /** selected options */
+    options?: string[];
+    /** (only for stereo/group) list of option-type */
+    types?: OptionTypeName[];
+    /** (only for stereo/group) list of option-unit (NOTE has only if `.id` is valid) */
+    units?: OptionUnitName[];
+    /**
+     * price in millis (integer := price * 1000)
+     */
+    priceMillis?: number;
+    /** 재고 관리 id */
+    stockId?: string;
+    /**
+     * possible stocks (integer)
+     */
+    stock?: number;
+    /**
+     * selected counts.
+     */
+    count?: number;
+    /**
+     * limited maximum selections
+     * - default is same as `.stock` (or `999`)
+     */
+    max?: number;
+    /**
+     * (optional) limited maximum selections
+     * - default is `1`
+     */
+    min?: number;
+    /**
+     * (optinal) max selectable count of this option.
+     * - 옵션선택수: 같은 옵션 그룹을 추가할 수 있는 개수.
+     */
+    maxSelect?: number;
+    /**
+     * (optinal) flag to use `maxLimit`
+     */
+    useLimit?: number;
+    /**
+     * (optinal) max limitation to buy
+     * - 구매제한수: 옵션 선택하고, 구매할 수 있는 재고수
+     */
+    maxLimit?: number;
+    /**
+     * (optional) internal last error.
+     */
+    error?: string;
+    /** 재고 모델 */
+    readonly stock$?: StockModel;
+}
+/**
+ * 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: {
+    option: string[];
+};
+export declare const $FIELD: {
+    option: string[];
+    mock: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        option: string[];
+    };
+    $FIELD: {
+        option: string[];
+        mock: string[];
+    };
+};
+export default _default;

package/dist/modules/option/options-types.d.ts

@@ -0,0 +1,364 @@
+/**
+ * `lib/options-types.ts`
+ * - types for option support
+ *
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-10-18 initial version
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { WeekDayNumType } from './types';
+import { GenericNode } from '../../lib/types';
+/**
+ * defines the possible types
+ */
+export declare const $OptionLUT: {
+    /**
+     * 옵션 항목의 종류들
+     */
+    OptionStereo: {
+        /** 기본형 */
+        '': string;
+        /** 옵션그룹 */
+        group: string;
+        /** 종류 */
+        type: string;
+        /** 옵션명 */
+        name: string;
+        /** 옵션단위 */
+        unit: string;
+        /** 사용자정의 옵션 */
+        input: string;
+    };
+    /**
+     * 사용자 정의 항목 형식
+     */
+    OptionInputType: {
+        '': string;
+        /** 한줄텍스트 */
+        text: string;
+        /** 날짜 */
+        date: string;
+        /** 주소 */
+        address: string;
+        /** 전화번호 */
+        phone: string;
+        /** 단일선택 */
+        single: string;
+        /** 이미지(첨부파일) */
+        image: string;
+    };
+    /**
+     * 옵션 분류 항목
+     */
+    OptionCategoryType: {
+        /** 선택없음 */
+        '': string;
+        /** 카테고리 */
+        category: string;
+        /** 요일별 */
+        day: string;
+    };
+};
+/**
+ * stereo-type in option
+ */
+export declare type OptionStereo = keyof typeof $OptionLUT.OptionStereo;
+/**
+ * input type in option
+ */
+export declare type OptionInputType = keyof typeof $OptionLUT.OptionInputType;
+/**
+ * category-type in option
+ */
+export declare type OptionCategoryType = keyof typeof $OptionLUT.OptionCategoryType;
+/**
+ * type: `OptionState`
+ * - internal state of each option elements
+ */
+export interface OptionState {
+    /**
+     * hidden for user. (non-display)
+     */
+    hidden?: boolean;
+    /**
+     * internally invalidated. (like deleted)
+     */
+    invalid?: boolean;
+    /**
+     * soldout not for sale. (displayed but soldout)
+     */
+    soldout?: boolean;
+}
+/**
+ * type: `Option`
+ * - common class for option sub-class
+ */
+export interface Option<T extends OptionStereo = OptionStereo> extends OptionState {
+    /**
+     * local id of option
+     */
+    id: string;
+    /**
+     * stereo types.
+     */
+    stereo?: T;
+    /** option-id (which is unique in option-model) */
+    oid?: string;
+    /** item-id linked */
+    iid?: string;
+    /** prod-id linked */
+    pid?: string;
+    /**
+     * (optional) internal last error.
+     */
+    error?: string;
+}
+/**
+ * type: `OptionGroup`
+ * --------------
+ * 1. (requred) independant selectables (ex: free-gift)
+ *  - stock is seperated from main selection. but it should be selected.
+ * 2. (required) combinational selection (ex: color + size)
+ *  - option-unit is specified by combination.
+ * 3. (optional) additional options to order more (ex: accessories, packages)
+ *  - additions in ordering.
+ *
+ * **[Option-Structure]**
+ * 1. in group by `OptionGroup`
+ *      - required: 필수 선택항목
+ *      - (tbd) conditional required.
+ * 2. 각 그룹내에서 옵션선택(단건/조합)을 선택하도록
+ *      - 각 옵션은 고유의 재고단위로 매핑될 수 있어야함
+ * 3. 각 옵션 선택은 옵션그룹에 종속되며, 옵션그룹이 다르면 같은 조건이라도 다른 인스턴스임
+ *      - group.childs := list of units.
+ *      - unit.parent := parent.id
+ *
+ * => Goods(1) -> Groups(N) -> Units(M)
+ */
+export interface OptionGroup extends Option<'group'> {
+    /**
+     * name of group
+     * ex) 옵션1
+     */
+    name: string | null;
+    /**
+     * it should be selected. (or can be additional options)
+     */
+    required?: boolean;
+    /**
+     * (optional) no need to make all option instances (option-id would be null)
+     */
+    virtual?: boolean;
+    /**
+     * flag of combination types
+     * - if true, the possible combination := count(types[0]) x count(types[1]) x ....
+     * - if false, each option-type can be selectable exclusively.
+     *
+     * ex.A) 신발 컬러 + 사이즈 선택하기 (조합에 따른 고유 재고 단위).
+     * ex.B) 비스포크 냉장고, 4문 각기 다른 색상 선택 (4개 한꺼번에 선택 필수).
+     */
+    combined?: boolean;
+    /**
+     * (optinal) max selectable count of this option.
+     * - 옵션선택수: 같은 옵션 그룹을 추가할 수 있는 개수.
+     */
+    maxSelect?: number;
+    /**
+     * (optinal) flag to use `maxLimit`
+     */
+    useLimit?: boolean;
+    /**
+     * (optinal) max limitation to buy
+     * - 구매제한수: 옵션 선택하고, 구매할 수 있는 재고수
+     */
+    maxLimit?: number;
+    /**
+     * flag of classification
+     */
+    useType?: boolean;
+    /**
+     * classification of option
+     * - 옵션 분류
+     */
+    category?: OptionCategoryType;
+    /**
+     * 요일별 시각시각
+     */
+    dayT1?: string;
+    /**
+     * 요일별 종료시각
+     */
+    dayT2?: string;
+    /**
+     * 요일별 정보
+     */
+    weekDays?: WeekDayNumType[];
+    /**
+     * list of types
+     * - in summary of options.
+     */
+    types?: OptionType[];
+    /**
+     * selectable unit of options.
+     */
+    units?: OptionUnit[];
+}
+/**
+ * type: `option-type`
+ * - describe each possble type and selectable names.
+ */
+export interface OptionType extends Option<'type'> {
+    /**
+     * parent-id (= id of option-group)
+     */
+    parent?: string;
+    /**
+     * type of option
+     * ex) `color`
+     */
+    type?: string;
+    /**
+     * (optional) name of option-type
+     * ex) `color`
+     */
+    name?: string;
+    /**
+     * option-names in possible (or selectable).
+     * - help to give hint of selectable names.
+     * ex) `red,blue`
+     */
+    names: string[];
+}
+/**
+ * type: `option-name`
+ * - describe the selected `option-name` for `option-type`.
+ */
+export interface OptionName extends Omit<Option<'name'>, 'id' | 'stereo'> {
+    /**
+     * stereo types.
+     */
+    stereo?: 'name';
+    /**
+     * type of option
+     * ex) color
+     */
+    type?: string;
+    /**
+     * name of option
+     * ex) red
+     */
+    name?: string;
+}
+/**
+ * type: `option-unit`
+ * - single element which can be selected from option.
+ * - 기본적으로 판메 `가격`과 `재고`를 가지고 있는 단위.
+ */
+export interface OptionUnit extends Option<'unit'> {
+    /**
+     * name of this unit
+     */
+    name?: string;
+    /**
+     * parent-id (= id of option-group)
+     */
+    parent?: string;
+    /**
+     * selections(names) per each option-types
+     * - `null` means `non-selection`
+     */
+    types?: OptionName[];
+    /**
+     * in-line option text in display (:= ['<type>: <name>', ...].join('\n'))
+     * - ex: `color: red\n size: 220ms`
+     * - default delimter: `: ` (type delim) and `\n` (option delim)
+     * - `null` means not prepared.
+     */
+    option: string | null;
+    /**
+     * price of option (float -> use priceMillis)
+     */
+    price?: number;
+    /**
+     * (flag) `option.price` is added to `prod.price` as final sales price.
+     */
+    isPriceAdd?: boolean;
+    /**
+     * original price in millis (integer := price * 1000)
+     */
+    priceMillis?: number;
+    /**
+     * possible stocks (integer)
+     */
+    stock?: number;
+    /**
+     * selected counts.
+     */
+    count?: number;
+    /**
+     * limited maximum selections
+     * - default is same as `.stock` (or `999`)
+     */
+    max?: number;
+    /**
+     * (optional) limited maximum selections
+     * - default is `1`
+     */
+    min?: number;
+    /**
+     * it should be selected. (or can be additional options)
+     */
+    required?: boolean;
+}
+/**
+ * type: `option-input`
+ * - `가격`이나 `재고` 정보가 없으며, 주문시 사용자의 입력을 받는다.
+ * - 필수/선택에 따라 입력 필수 여부를 결정한다.
+ */
+export interface OptionInput extends Option<'input'> {
+    /**
+     * name of option
+     */
+    name: string | null;
+    /**
+     * (optional) parent-id (= id of option-input)
+     * - 아직 뚜렷한 사용성이 정의되지 않음  @230823
+     */
+    parent?: string;
+    /**
+     * 사용자정의 항목형식
+     */
+    type?: OptionInputType;
+    /**
+     * it should be selected. (or can be additional options)
+     */
+    required?: boolean;
+    /** 입력 도움말 (가이드문구) */
+    placeholder?: string;
+    /** 날짜 선택 제한값 */
+    dayLimit?: number;
+    /** (optional) 텍스트 입력 항목들 (ex: 옵션 항목) */
+    extras?: string[];
+}
+/**
+ * types in option-root.
+ */
+export declare type OptionRoots = OptionGroup | OptionInput;
+/**
+ * option's hyper modeling
+ * - supporting all stereo into single option data.
+ *
+ * NOTE
+ * - 옵션 생성 설정과 각 옵션별 재고 인스턴스를 분리할 필요가 있음. (재고 없으면 인스턴스 생성 할필요 없을듯!!)
+ * - 설정이 변경시, 옵션타입:이름이 같은것들은 살리고, 다르면 날림.
+ */
+export interface OptionNode extends GenericNode {
+    /** option id */
+    id?: string;
+    /** this name */
+    name?: string;
+    /** single-line option-text */
+    option?: string;
+}

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

@@ -0,0 +1,112 @@
+/**
+ * `option/types.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ *
+ * @author      Simon <wookeun@sl-platform.com>
+ * @date        2025-04-21 refactoring for option service.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { SimpleSet } from 'lemon-model';
+import { PaginateParam } from '../../cores/types';
+export { SimpleSet };
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+export declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** option model */
+        option: string;
+    };
+    /**
+     * 옵션 항목의 종류들
+     */
+    OptionStereo: {
+        /** 기본형 */
+        '': string;
+        /** 옵션그룹 */
+        group: string;
+        /** 종류 */
+        type: string;
+        /** 옵션명 */
+        name: string;
+        /** 옵션단위 */
+        unit: string;
+        /** 사용자정의 옵션 */
+        input: 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;
+    };
+};
+/**
+ * type: `OptionStereo`
+ */
+export declare type OptionStereo = keyof typeof $LUT.OptionStereo;
+/**
+ * type: `WeekDayNumType`
+ */
+export declare type WeekDayNumType = keyof typeof $LUT.WeekDayNumType;
+/**
+ * type: `WeekDayKorType`
+ */
+export declare type WeekDayKorType = keyof typeof $LUT.WeekDayKorType;
+/**
+ * query param for options-list
+ */
+export interface OptionListParam extends PaginateParam {
+    /** sort selection (default latest) */
+    sort?: 'latest' | 'popular' | 'lowPrice' | 'highPrice' | 'ranking';
+    /** stereo */
+    stereo?: string | OptionStereo;
+}
+/** must export $LUT as default */
+export default $LUT;