@lemoncloud/ssocio-kiosk-api 0.25.423

package/README.md

@@ -0,0 +1,4 @@
+# @lemoncloud/lemon-goods-api
+
+- 관리용 서비스 API
+

package/dist/cores/types.d.ts

@@ -0,0 +1,116 @@
+/**
+ * `types.ts`
+ * - common types used in `/cores`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-06-21 optimized w/ `abstract-services`
+ * @date        2022-06-28 added `Codable` interface for general types.
+ * @date        2023-01-18 optimized with `lemon-core@3.2.4`
+ * @date        2023-02-15 optimized with `lemon-core@3.2.5`
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel, View, Body } from 'lemon-model';
+export { CoreModel, View, Body };
+/**
+ * type `ListResult`
+ */
+export interface ListResult<T, R = any> {
+    /**
+     * total searched count
+     */
+    total?: number;
+    /**
+     * max items count in the page
+     */
+    limit?: number;
+    /**
+     * current page number.
+     */
+    page?: number;
+    /**
+     * (optional) time took in sec
+     */
+    took?: number;
+    /**
+     * items searched
+     */
+    list: T[];
+    /**
+     * (optional) aggr list
+     */
+    aggr?: R[];
+}
+export interface AggrKeyCount {
+    /** name of key(or bucket name) */
+    key: string;
+    /** number of count */
+    val: number;
+}
+/**
+ * type `PaginatedListResult`
+ */
+export interface PaginatedListResult<T, R = string> extends ListResult<T, R> {
+    /**
+     * current page
+     */
+    page: number;
+}
+/**
+ * type `ListParam`
+ */
+export interface ListParam {
+    /**
+     * max items count to be fetched
+     */
+    limit?: number;
+    /**
+     * (optional) sorting order
+     *  - 'asc': older first
+     *  - 'desc': newer first
+     *  - string: extended sorting features
+     */
+    sort?: 'asc' | 'desc' | string;
+}
+/**
+ * type `PaginateParam`
+ */
+export interface PaginateParam extends ListParam {
+    /**
+     * page # to fetch (0-indexed)
+     */
+    page?: number;
+    /**
+     * (optional) offset # from start.
+     */
+    offset?: number;
+    /**
+     * (optional) flag to filter by uid
+     */
+    uid?: string;
+}
+/**
+ * type `BulkUpdateBody`
+ */
+export interface BulkUpdateBody<T> extends BulkBody<T> {
+    /**
+     * list bulk update model with id
+     */
+    list: T[];
+}
+/**
+ * body data for bulk
+ */
+export interface BulkBody<T> {
+    list: T[];
+}
+/**
+ * list of the selected model-id
+ */
+export interface BodyList<T extends {
+    id: string;
+} = {
+    id: string;
+}> {
+    list: T[];
+}

package/dist/lib/types.d.ts

@@ -0,0 +1,36 @@
+/**
+ * `lib/types.ts`
+ * - contains only the hyper types.
+ * - `publish types` 할때, lemon-core 포함을 최소화하기 위한 조치!
+ *
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-10-18 initial version
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+export * from '../modules/option/options-types';
+/**
+ * a node represent.
+ */
+export interface GenericNode {
+    /** id of this node */
+    id?: string;
+}
+/**
+ * type: `ProxyAdaptor`
+ * - storage adaptor to support fetching the model from storage.
+ * - used to adapt w/ `backend-proxy`.
+ */
+export interface ProxyAdaptor<T extends GenericNode> {
+    /** say hello of this adaptor */
+    hello?(): string;
+    /** get the model (or load from stocks) */
+    get(id: string): Promise<T>;
+    /** set the model (or save into stocks) */
+    set?(id: string, model: T): Promise<T>;
+    /** increment fields in the model */
+    inc?(id: string, model: T): Promise<T>;
+    /** create new instance with initial data */
+    new?(model?: T): Promise<T>;
+}

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

@@ -0,0 +1,125 @@
+/**
+ * `cart/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-08-08 refactoring for carts service.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel } from 'lemon-model';
+import { ModelType } from '../../service/backend-types';
+import { DeliveryHead, ProductHead } from '../goods/model';
+import { CategoryHead } from '../category/model';
+import { StockHead } from '../stock/model';
+import { PriceInfo } from '../goods/types';
+export { ModelType };
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * Author information.
+ */
+export interface CartOwner {
+    /**
+     * id(= account-id or user-id) of `owner`
+     */
+    id?: string;
+    /**
+     * iid(= identity-id) of `owner`
+     */
+    iid?: string;
+    /**
+     * name of `owner`
+     */
+    name?: string;
+    /**
+     * image of `owner`
+     */
+    image?: string;
+}
+/**
+ * type: `CartHead`
+ * - common head of cart-model.
+ */
+export interface CartHead {
+    /** id of model */
+    id?: string;
+    /** name of model */
+    name?: string;
+}
+/**
+ * type: `CartModel`
+ * - 사용자별(owner) 장바구니에 담긴 상품정보
+ * - 선택상품 1개당, 1개의 장바구니가 만들어짐
+ */
+export interface CartModel extends CartHead, Model {
+    /** id of cart (auto-seq) */
+    id?: string;
+    /** version of goods-api (inited when creation) */
+    version?: string;
+    /**
+     * owner of this cart.
+     */
+    owner$?: CartOwner;
+    /** name of model */
+    name?: string;
+    /** single-line option-text */
+    option?: string;
+    /** thumb image (in small-size) */
+    thumb?: string;
+    /** count of product */
+    count?: number;
+    /** unit-price (single) of this cart */
+    unitPrice$?: PriceInfo;
+    /** price of this cart (= unitPrice * count) */
+    price$?: PriceInfo;
+    /** (optional) 상품 할인금액 (* 자동계산) */
+    discountPrice$?: PriceInfo;
+    deliveryPrice$?: PriceInfo;
+    /** hidden flag (= delete cart) */
+    isHidden?: number;
+    /** checked flag (= user has checked) */
+    isChecked?: number;
+    /** id of category-model */
+    categoryId?: string;
+    /** head of category-model */
+    category$?: CategoryHead;
+    /** id of prod-model */
+    prodId?: string;
+    /** head of prod-model */
+    prod$?: ProductHead;
+    /** id of stock-model */
+    stockId?: string;
+    /** head of stock-model */
+    stock$?: StockHead;
+    /** id of delivery */
+    deliveryId?: string;
+    /** head of delivery */
+    delivery$?: DeliveryHead;
+}
+/**
+ * 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: {
+    cart: string[];
+};
+export declare const $FIELD: {
+    cart: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        cart: string[];
+    };
+    $FIELD: {
+        cart: string[];
+    };
+};
+export default _default;

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

@@ -0,0 +1,35 @@
+/**
+ * `cart/types.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2024-08-08 refactoring for carts service.
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** cart model */
+        cart: string;
+    };
+};
+/**
+ * query param of `POST /carts/0/order`
+ */
+export interface CartOrderParam {
+    /**
+     * flag to start order by fetching `/start-order` of orders-api.
+     */
+    start?: boolean | string;
+}
+/** must export $LUT as default */
+export default $LUT;

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

@@ -0,0 +1,53 @@
+/**
+ * `cart/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 cart service.
+ * @Copyright   (C) 2025 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { View, Body } from 'lemon-model';
+import { BodyList } from '../../cores/types';
+import { CartModel } from './model';
+import { DeliveryView } from '../goods/views';
+import { CategoryView } from '../category/views';
+import $LUT from './types';
+export * from './types';
+export default $LUT;
+/**!SECTION */
+/**
+ * body of `POST /carts/0/order`
+ * - BodyList<>: selected cart-id list to start order.
+ * - CartBody[]: selected product-list to start order.
+ */
+export declare type CartOrderBody = BodyList | CartBody[];
+/**
+ * type: `CartView`
+ * - usually same as post's body.
+ */
+export interface CartView extends View, Omit<Partial<CartModel>, 'isHidden' | 'isChecked' | 'category$' | 'delivery$'> {
+    /** 카트 숨길처리 (삭제효과) */
+    isHidden?: boolean;
+    /** 선택박스 체크하기 */
+    isChecked?: boolean;
+    /**
+     * 해당 상품의 단일 가격 정보 (string)
+     * - ex) `$0.99`, `₩1,000`
+     */
+    unitPriceInfo?: string;
+    /** 해당 카트(금액) 정보 */
+    priceInfo?: string;
+    /** 할인금액 정보 */
+    discountInfo?: string;
+    /** 배송비 정보 */
+    deliveryInfo?: string;
+    /** (internal) the linked category-model */
+    readonly category$?: CategoryView;
+    /** (internal) the linked delivery-model */
+    readonly delivery$?: DeliveryView;
+}
+/** type `CartBody` */
+export interface CartBody extends Body, Partial<CartView> {
+}

package/dist/modules/category/categories-types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * `lib/categories-types.ts`
+ * - types for category support
+ *
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-10-18 initial version
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { GenericNode } from '../../lib/types';
+/**
+ * type: `CategoryNode`
+ * - represent a single node of category tree.
+ * - node should have single parent's node.
+ */
+export interface CategoryNode extends GenericNode {
+    /** category-id */
+    id?: string;
+    /** this name */
+    name?: string;
+    /** id of parent node */
+    parent?: string;
+    /** name of parent node */
+    parentName?: string;
+    /** current depth (= parent.depth + 1) */
+    depth?: number;
+    /**
+     * the node path from root to node
+     * - list of [[id, name].join(':'),...]
+     */
+    paths?: string[];
+}

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

@@ -0,0 +1,85 @@
+/**
+ * `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 } from 'lemon-model';
+import { ModelType } from '../../service/backend-types';
+import { CategoryStereo } from './types';
+import { CategoryNode } from './categories-types';
+export { ModelType };
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * Type: `CategoryHead`
+ */
+export interface CategoryHead {
+    /** auto sequence */
+    id?: string;
+    /** stereo */
+    stereo?: CategoryStereo;
+    /** 분류 이름 */
+    name?: string;
+    /** status of activate */
+    optional?: BoolFlag;
+}
+/**
+ * type: `CategoryModel` (카테고리)
+ * - 카테고리(분류) 모델
+ */
+export interface CategoryModel extends Model, CategoryNode, CategoryHead {
+    /** stereo */
+    stereo?: CategoryStereo;
+    /** 상위 부모의 ID */
+    parent?: string;
+    /** 상위 부모의 Name */
+    parentName?: string;
+    /** 카테고리 (항목) 이름 */
+    name?: string;
+    /** 카테고리 아이콘 */
+    icon?: string;
+    /** 카테고리 텍스트 */
+    text?: string;
+    /** 카테고리 보여주기 순서 */
+    order?: number;
+    /** 탭메뉴 */
+    tapMenu?: string[];
+    /** 컨텐츠(html/text) 내용 */
+    content?: string;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: BoolFlag;
+}
+/**
+ * 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: {
+    category: string[];
+};
+export declare const $FIELD: {
+    category: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        category: string[];
+    };
+    $FIELD: {
+        category: string[];
+    };
+};
+export default _default;

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

@@ -0,0 +1,47 @@
+/**
+ * `category/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: {
+        /** category model */
+        category: string;
+    };
+    /**
+     * 카테고리의 종류
+     */
+    CategoryStereo: {
+        '': string;
+        /** 배송형 */
+        delivery: string;
+        /** 방문형 */
+        visit: string;
+        /** 약관설정 */
+        agreed: string;
+        /** 상품고시 */
+        notice: string;
+        /** 매장형 */
+        store: string;
+    };
+};
+/**
+ * type: `CategoryStereo`
+ */
+export declare type CategoryStereo = keyof typeof $LUT.CategoryStereo;
+/** must export $LUT as default */
+export default $LUT;

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

@@ -0,0 +1,32 @@
+/**
+ * `category/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 category service.
+ * @Copyright   (C) 2025 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { View, Body } from 'lemon-model';
+import { CategoryModel } from './model';
+import $LUT from './types';
+export * from './types';
+export default $LUT;
+/**!SECTION */
+/**
+ * type `CategoryView`
+ */
+export interface CategoryView extends View, Omit<Partial<CategoryModel>, 'optional' | 'hidden'> {
+    /** 사용 활성화 여부 */
+    optional?: boolean;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: boolean;
+}
+/**
+ * type `CategoryBody`
+ */
+export interface CategoryBody extends Body, Partial<Omit<CategoryView, 'parentName'>> {
+}