@lemoncloud/clipbiz-goods-api 0.25.1027 → 0.25.1125

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

@@ -0,0 +1,136 @@
+/**
+ * `model.ts`
+ * - model definitions
+ *
+ * @author      Steve Jung <steve@lemoncloud.io>
+ * @date        2025-03-26 initial version.
+ *
+ * @copyright   (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ * @origin      `@lemoncloud/lemon-templates-api/modules/recommend`
+ */
+import { CoreModel } from 'lemon-model';
+import $LUT, { RecommendState, RecommendStereo, ReferencedContent, ReferencedUsage } from './types';
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
+/**
+ * Type: `RecommendHead`
+ */
+export interface RecommendHead {
+    /** auto sequence */
+    id?: string;
+    /** stereo */
+    stereo?: RecommendStereo;
+    /** name of recommend */
+    name?: string;
+}
+/**
+ * type: `RecommendModel` (콜백)
+ * - 콜백 모델
+ * - 콜백 요청과 응답에 대한 내용을 기록 관리하기 위함.
+ */
+export interface RecommendModel extends Model, RecommendHead {
+    /**
+     * auto-seq or child-no
+     * 1. [0-9]+ : auto sequence for all recommends.
+     * 2. '#'    : means this is root recommend.
+     * 3. [A-Z][0-9]+ : linked recommend from other model type. (see `asModelId()` in proxy)
+     */
+    id?: string;
+    /** stereo */
+    stereo?: RecommendStereo;
+    /** name of recommend */
+    name?: string;
+    /** type of llm model */
+    modelType?: string;
+    /** system prompt to use */
+    promptId?: string;
+    /** state of recommend */
+    state?: RecommendState;
+    /** single input */
+    input$?: ReferencedContent;
+    /** single output */
+    output$?: ReferencedContent;
+    /** token usage details */
+    usage$?: ReferencedUsage;
+    /** (optional) multiple input */
+    input$$?: ReferencedContent[];
+    /** (optional) multiple output */
+    output$$?: ReferencedContent[];
+    /** internal timestamp */
+    ts$?: {
+        /** time(ts) of request (entry) */
+        request?: number;
+        /** time(ts) of thinking (entry) */
+        thinking?: number;
+        /** time(ts) of response (entry) */
+        response?: number;
+    };
+    /**
+     * (optional) referenced documents
+     */
+    docs$$?: ReferencedContent[];
+    /** (optional) parent of this */
+    parentId?: string;
+    /** parent info */
+    parent$?: RecommendHead;
+    /**
+     * child-no for this recommend
+     * - if this is root recommend, `no` is `undefined`.
+     * - if this is child recommend, `no` is child sequence number (1,2,3,...).
+     */
+    no?: number;
+    /** meta in json */
+    meta?: string;
+    /** last error message */
+    error?: string;
+    /** domain of origin context */
+    domain?: string;
+    /** client-ip when requested */
+    clientIp?: string;
+    /** user-agent when requested */
+    userAgent?: string;
+    /** origin when requested */
+    origin?: string;
+    /** referer when requested */
+    referer?: string;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: BoolFlag;
+    /**
+     * optional(선택) flag
+     */
+    optional?: 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: {
+    recommend: string[];
+};
+export declare const $FIELD: {
+    recommend: string[];
+};
+/** must export default as below */
+declare const _default: {
+    $HEAD: {
+        recommend: string[];
+    };
+    $FIELD: {
+        recommend: string[];
+    };
+};
+export default _default;

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

@@ -0,0 +1,80 @@
+/**
+ * `types.ts`
+ * - basic types used in `proxy`
+ *
+ * **[중요! exports 순서]**
+ * 1. define data type in `types.ts` w/ internal types.
+ * 2. define Model in `model.ts`
+ * 3. define View/Body in `view.ts`, and external types.
+ *
+ * @author      Steve Jung <steve@lemoncloud.io>
+ * @date        2025-03-26 initial version.
+ *
+ * @copyright   (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ * @origin      `@lemoncloud/lemon-templates-api/modules/recommend`
+ */
+/**
+ * Lookup Table
+ *
+ * WARN! DO NOT EXPORT AS `$LUT`. use default export instead.
+ */
+declare const $LUT: {
+    /**
+     * Possible type of model.
+     */
+    ModelType: {
+        /** recommend model */
+        recommend: string;
+    };
+    /**
+     * 추천의 종류
+     */
+    RecommendStereo: {
+        '#': string;
+        '': string;
+        /** 내부 자식 노드의 경우 */
+        _child: string;
+    };
+    /**
+     * 추천의 상태(현재상태)
+     * - 상태: `initial` -> `request` -> `thinking` -> `response`
+     */
+    RecommendState: {
+        '': string;
+        /** request: 요청함 */
+        request: string;
+        /** thinking: 처리중 */
+        thinking: string;
+        /** response: 응답함 */
+        response: string;
+    };
+};
+/**
+ * type: `RecommendStereo`
+ */
+export declare type RecommendStereo = keyof typeof $LUT.RecommendStereo | string;
+/**
+ * type: `RecommendState`
+ */
+export declare type RecommendState = keyof typeof $LUT.RecommendState;
+/** must export $LUT as default */
+export default $LUT;
+/**
+ * type: `ReferencedContent`
+ * - (simply) referenced content information
+ */
+export interface ReferencedContent {
+    /** id of doc */
+    id?: string;
+    /** type of doc (might be content-type) */
+    type?: string;
+    /** main content in text */
+    content: string;
+}
+/**
+ * type: `ReferencedUsage`
+ * - token usage information.
+ */
+export interface ReferencedUsage {
+    [key: string]: number;
+}

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

@@ -0,0 +1,70 @@
+/**
+ * `views.ts`
+ * - type of views used in `transformer`
+ *
+ * @author      Steve Jung <steve@lemoncloud.io>
+ * @date        2025-03-26 initial version.
+ *
+ * @copyright   (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ * @origin      `@lemoncloud/lemon-templates-api/modules/recommend`
+ */
+import { View, Body } from 'lemon-model';
+import { RecommendModel } from './model';
+import $LUT from './types';
+export * from './types';
+export default $LUT;
+/**
+ * type `RecommendView`
+ */
+export interface RecommendView extends View, Omit<Partial<RecommendModel>, 'optional' | 'hidden'> {
+    /** 사용 활성화 여부 */
+    optional?: boolean;
+    /**
+     * hidden(숨김) flag
+     */
+    hidden?: boolean;
+}
+/**
+ * type `RecommendBody`
+ */
+export interface RecommendBody extends Body, Partial<Omit<RecommendView, ''>> {
+}
+/**
+ * type `RecommendCommonParam`
+ * - param for doGetItems() + doPostItems()
+ */
+export interface RecommendCommonParam {
+    /**
+     * type of recommend stereo
+     * - used to determine recommend model id.
+     *
+     * ex) id=123 type=recommend -> `RCM123`
+     */
+    type?: string;
+}
+/**
+ * type `RecommendItemsParam`
+ * - param for doGetItems() + doPostItems()
+ */
+export interface RecommendPostItemsParam extends RecommendCommonParam {
+    /**
+     * flag of save (default: true)
+     * - if true, save the recommend result.
+     */
+    save?: boolean | string;
+    /**
+     * flag of mocks (default: false)
+     * - if true, use mock data.
+     */
+    mocks?: boolean | string;
+    /**
+     * flag of async (default: false)
+     * - if true, return immediately after make notify()
+     */
+    async?: boolean | string;
+    /**
+     * (optional) id of connection-id
+     * - send the result of the change to a WebSocket
+     */
+    connId?: string;
+}

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

@@ -0,0 +1,157 @@
+/**
+ * `model.ts`
+ * - model definitions per contract data
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2025-11-30 implement a contract service.
+ *
+ * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel } from 'lemon-model';
+import $LUT, { ContractStereo, ContractState, DeliveryStereo, DeliveryState, ContractAgreement } from './types';
+import { DealHead, DealModel } from '../deals/model';
+import { Cores } from 'lemon-core';
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model interface
+ * - modifier 정보 저장을 위해 확장됨 @251124
+ *
+ * TODO [Steve] 아래의 `$` 부분은 추후 `lemon-model` 쪽으로 이전 검토 필요. @251124
+ */
+export interface Model extends CoreModel<ModelType> {
+    /**
+     * the modifier information
+     * - can't update manually.
+     */
+    readonly $?: Cores;
+}
+/**
+ * type: `ContractHead`
+ */
+export interface ContractHead {
+    /** id of model */
+    id?: string;
+    /** name of model */
+    name?: string;
+}
+/**
+ * type: `ContractModel`
+ * - 매칭(deal)에 대한 계약 정보를 관리함.
+ */
+export interface ContractModel extends ContractHead, Model {
+    /** name of model */
+    name?: string;
+    /** stereo of model */
+    stereo?: ContractStereo;
+    /** state of model */
+    state?: ContractState;
+    /** (linked) id of deal */
+    dealId?: string;
+    /** (linked) parital of deal */
+    deal$?: DealHead;
+    /** 총 주문수량 */
+    totalQuantity?: number;
+    /** 단가 */
+    unitPrice?: number;
+    /** 총 계약금액 */
+    totalAmount?: number;
+    /** 계약 시작 시각 */
+    startedAt?: number;
+    /** 계약 만료 시각 */
+    expiredAt?: number;
+    /** 특이사항 (for 기업) */
+    notes?: string;
+    /** 메모  (for 사업장) */
+    memo?: string;
+    /** 반려사유 (for 사업장) */
+    reasons?: string[];
+    /**
+     * no of revision
+     * - [parent] no-of-revision
+     * - [child] no-in-revision
+     */
+    revisionNo?: number;
+    /**
+     * no of delivery (원자적 증가)
+     * - 마지막 생성된 납기 번호
+     */
+    deliveryNo?: number;
+    /** (optional) id of parent */
+    parentId?: string;
+    /** (optional) partial of parent */
+    parent$?: ContractHead;
+    /**
+     * 약관 동의 기록
+     * - 기업, 표준사업장 동의 기록 관리
+     */
+    agreed$?: ContractAgreement;
+    /**
+     * (internal) detail info of deal
+     */
+    readonly $deal?: DealModel;
+}
+/**
+ * interface: `DeliveryHead`
+ * - common head of `DeliveryModel`
+ */
+export interface DeliveryHead {
+    /** id of model */
+    id?: string;
+    /** name of model */
+    name?: string;
+}
+/**
+ * interface: `DeliveryModel`
+ * - 계약(contract)애 대헌 회차/납기 정보를 관리함.
+ */
+export interface DeliveryModel extends DeliveryHead, Model {
+    /** name of model */
+    name?: string;
+    /** stereo of model */
+    stereo?: DeliveryStereo;
+    /** state of model */
+    state?: DeliveryState;
+    /** (linked) id of contract */
+    contractId?: string;
+    /** (linked) partial of contract */
+    contract$?: ContractHead;
+    /** (internal) 납기 번호 (:= Contract.deliveryNo) */
+    no?: number;
+    /** 납기 수량 */
+    quantity?: number;
+    /** 납기 단가 */
+    unitPrice?: number;
+    /** 납기 금액 */
+    amount?: number;
+    /** 예정 납기일 */
+    scheduledAt?: number;
+    /** 실제 납품일 */
+    deliveredAt?: number;
+    /** 메모 */
+    memo?: string;
+}
+export declare const filterFields: (fields: string[], base?: string[]) => string[];
+export declare const $HEAD: {
+    contract: string[];
+    delivery: string[];
+};
+export declare const $FIELD: {
+    contract: string[];
+    delivery: string[];
+};
+declare const _default: {
+    $HEAD: {
+        contract: string[];
+        delivery: string[];
+    };
+    $FIELD: {
+        contract: string[];
+        delivery: string[];
+    };
+};
+export default _default;

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

@@ -0,0 +1,88 @@
+/**
+ * `types.ts`
+ * - view types used in API controllers and transformer
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-06-21 optimized w/ `abstract-services`
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2025-11-30 implement a contract service.
+ *
+ * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+declare const $LUT: {
+    ModelType: {
+        contract: string;
+        delivery: string;
+    };
+    /** ContractStereo **/
+    ContractStereo: {
+        '': string;
+        '#': string;
+        '#revision': string;
+    };
+    /** ContractState */
+    ContractState: {
+        '': string;
+        draft: string;
+        pending: string;
+        approved: string;
+        active: string;
+        completed: string;
+        expired: string;
+        rejected: string;
+        cancelled: string;
+    };
+    /** DeliveryStereo */
+    DeliveryStereo: {
+        '': string;
+    };
+    /** DeliveryState */
+    DeliveryState: {
+        '': string;
+    };
+};
+/**
+ * type: `ContractStereo`
+ */
+export declare type ContractStereo = keyof typeof $LUT.ContractStereo;
+/**
+ * type: `ContractState`
+ */
+export declare type ContractState = keyof typeof $LUT.ContractState;
+/**
+ * type: `DeliveryStereo`
+ */
+export declare type DeliveryStereo = keyof typeof $LUT.DeliveryStereo;
+/**
+ * type: `DeliveryState`
+ */
+export declare type DeliveryState = keyof typeof $LUT.DeliveryState;
+/**
+ * type: `Agreement`
+ */
+export interface Agreement {
+    /**
+     * 동적 약관 동의 기록
+     * - key: 약관 ID
+     * - value: 약관 정보
+     */
+    [key: string]: {
+        /** 약관(term) ID */
+        id: string;
+        /** 약관(term)명 */
+        name: string;
+        /** 동의 시각 */
+        ts?: number;
+    };
+}
+/**
+ * type: `ContractAgreement`
+ * - 계약서별 약관 동의 기록
+ */
+export interface ContractAgreement {
+    /** 구매업체(기업) 약관 기록 */
+    seller?: Agreement;
+    /** 판매업체(표준사업장) 약관 기록 */
+    buyer?: Agreement;
+}
+export default $LUT;

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

@@ -0,0 +1,45 @@
+/**
+ * `contracts/views.ts`
+ * - types used in `backed-proxy`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-08-29 initial version.
+ * @author      Aiden <aiden@lemoncloud.io>
+ * @date        2025-11-30 implement a contract service.
+ *
+ * @copyright   (C) lemoncloud.io 2022 - All Rights Reserved.
+ */
+import { View, Body } from 'lemon-model';
+import { ContractModel, DeliveryModel } from './model';
+import $LUT from './types';
+import { DealView } from '../deals/views';
+export * from './types';
+export default $LUT;
+/**!SECTION */
+/**
+ * type: `ContractView`
+ * - usually same as post's body.
+ */
+export interface ContractView extends View, Omit<Partial<ContractModel>, 'deal$'> {
+    /**
+     * (readonly) 매칭 정보
+     */
+    readonly deal$?: DealView;
+}
+export interface ContractBody extends Body, Partial<ContractView> {
+}
+/**
+ * type: `DeliveryView`
+ * - usually same as post's body.
+ */
+export interface DeliveryView extends View, Omit<Partial<DeliveryModel>, 'contract$'> {
+    /**
+     * (readonly) 계약서 정보
+     */
+    readonly contract$?: ContractView;
+}
+/**
+ * type: `DeliveryBody`
+ */
+export interface DeliveryBody extends Body, Partial<DeliveryView> {
+}

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

@@ -7,7 +7,7 @@
  *
  * Copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
  */
-import { CoreModel } from 'lemon-model';
+import { CoreModel, Cores } from 'lemon-model';
 import $LUT, { DealStereo, DealStatus, DealStatusSet } from './types';
 import { ProdHead } from '../goods/model';
 import { ItemHead } from '../goods/model';
@@ -17,9 +17,18 @@ import { SiteHead } from '../sites/model';
  */
 export declare type ModelType = keyof typeof $LUT.ModelType;
 /**
- * type: `Model`: common model
+ * type: `Model`: common model interface
+ * - modifier 정보 저장을 위해 확장됨 @251124
+ *
+ * TODO [Steve] 아래의 `$` 부분은 추후 `lemon-model` 쪽으로 이전 검토 필요. @251124
  */
-export declare type Model = CoreModel<ModelType>;
+export interface Model extends CoreModel<ModelType> {
+    /**
+     * the modifier information
+     * - can't update manually.
+     */
+    readonly $?: Cores;
+}
 /**
  * interface: `DealHead`
  * - common head of deal-model
@@ -29,6 +38,23 @@ export interface DealHead {
     id?: string;
     /** name of deal */
     name?: string;
+    /** ==== 계약 시점의 스냅샷  ==== */
+    /** (linked) 상품(희망상품) ID */
+    prodId?: string;
+    /** (linked) 상품(희망상품) 정보 */
+    prod$?: ProdHead;
+    /** (linked) 품목 ID */
+    itemId?: string;
+    /** (linked) 품목 정보 */
+    item$?: ItemHead;
+    /** (linked) 신청 기업(업체) ID */
+    buyerSiteId?: string;
+    /** (linked) 신청 기업(업체) 정보 */
+    buyerSite$?: SiteHead;
+    /** (linked) 공급 기업(표준사업장) ID */
+    sellerSiteId?: string;
+    /** (linked) 공급 기업(표준사업장) 정보 */
+    sellerSite$?: SiteHead;
 }
 /**
  * interface: `DealModel`
@@ -63,6 +89,8 @@ export interface DealModel extends DealHead, Model {
     sellerSite$?: SiteHead;
     /** 전체 상태 */
     status?: DealStatus;
+    /** 상태 순서 (1-7) */
+    stateNo?: number;
     /** 상태 세트 (inner object) */
     status$?: DealStatusSet;
     /** 요청 정보 */