@lemoncloud/ssocio-stacks-api 0.23.313

package/dist/lib/types.d.ts

@@ -0,0 +1,34 @@
+/**
+ * `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 './categories-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>;
+    /** create new instance with initial data */
+    new?(model?: T): Promise<T>;
+}

package/dist/service/backend-model.d.ts

@@ -0,0 +1,524 @@
+/**
+ * - model definitions per account data
+ * `backend-model.ts`
+ *
+ * @author      Tim Hong <tim@lemoncloud.io>
+ * @date        2021-05-26  initial version
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-03-04 refactoring for activity service.
+ *
+ * Copyright (C) 2020 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel, NextIdentityAccess } from 'lemon-model';
+import { CategoryNode } from '../lib/categories-types';
+import { BillingType, DeviceType, DiscountType, GenderType, MonthType, PaymentType, ProdStereoType, ProgramStartType, RefundType, ServiceStatus, ComissionRate, PeriodInfo, DayOfTheWeekPolicy, BaseTimeType, FirmStereoType } from './backend-types';
+/**
+ * type: model-type
+ * - use this type to make pkey per data.
+ */
+export declare type ModelType = 'category' | 'program' | 'payment' | 'cancel' | 'display' | 'period' | 'time' | 'push' | 'bank' | 'operator' | 'firm' | 'test' | 'mock';
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+export interface Codable {
+    /**
+     * encoded string (internal-link)
+     * Must be unique in each Model
+     */
+    code?: string;
+}
+/**
+ * Type: `CategoryModel`
+ * - 카테고리 모델
+ */
+export interface CategoryModel extends Model, CategoryNode {
+    /** 상위 부모의 ID */
+    parent?: string;
+    /** 상위 부모의 Name */
+    parentName?: string;
+    /** 카테고리 이름 */
+    name?: string;
+    /** 카테고리 (메뉴) 아이콘 이미지 */
+    icon?: string;
+    /** 카테고리 (메뉴) 이미지 */
+    images?: string[];
+    /** 카테고리 (메뉴) 페이지 설명 */
+    desc?: string;
+    /** 카테고리 (메뉴) 탭 메뉴 ex) ['키즈 프로그램', '여성 프로그램'] */
+    tapMenu?: string[];
+    /** 카테고리 보여주기 순서 */
+    order?: number;
+    /** hidden(숨김) flag */
+    hidden?: number;
+}
+/**
+ * Type: `ProdUniqueCode`
+ * - 상품 고유 코드 모델
+ * - 프로그램 카테고리와 시간 정보를 담음
+ */
+export interface ProdUniqueCode {
+    /** 카테고리 ids */
+    categoryIds?: string[];
+    /** name of parent Category */
+    categoryNames?: string[];
+    /** path of parent Category */
+    categoryPaths?: string[];
+    /** 운영요일 (ex: 목,금,토) */
+    operateDayOfTheWeek?: string;
+    /** 운영 시작 시간 (HH-MM) */
+    operateStartTime?: string;
+    /** 운영 종료 시간 (HH-MM) */
+    operateEndTime?: string;
+    /** 프로그램 시작일 (YYYY-MM-DD) */
+    startDay?: string;
+    /** 프로그램 종료일 (YYYY-MM-DD) */
+    endDay?: string;
+    /** 1회 운영 시간 */
+    hoursPerClass?: number;
+    /** 반복 설정 */
+    periodic?: string;
+    /** 세분화 코드 (stereo: 세분 생성) */
+    segmentCodes?: string[];
+}
+/**
+ * Type : `ProgramModel`
+ * - 프로그램 등록 모델
+ */
+export interface ProgramModel extends Model, ProdUniqueCode {
+    /** id: <auto-seq> */
+    id?: string;
+    /** stereo (단일, 세분) */
+    stereo?: ProdStereoType;
+    /** name of program */
+    name?: string;
+    /** 푸쉬 관리 이용 여부 (1: 사용, 0: 사용안함) */
+    usePushNotification?: number;
+    /** 수강인원 제한 (1: 제한 사용, 0: 사용안함) */
+    useNumOfPeopleLimit?: number;
+    /** 프로그램 수용 최소 인원 */
+    minNumOfPeople?: number;
+    /** 프로그램 수용 최대 인원 */
+    maxNumOfPeople?: number;
+    /** 성별 구분 */
+    gender?: GenderType;
+    /** 프로그램 참가 최소 연령 */
+    minAge?: number;
+    /** 프로그램 참가 최대 연령 */
+    maxAge?: number;
+    /** 안내사항 */
+    description?: string;
+    /** 옵션 상품 */
+    option?: string;
+    /** 이미지 사용 여부 */
+    useImage?: number;
+    /** 이미지 정보 */
+    images?: string[];
+    /** 시설 정보 사용 여부 */
+    useFacilityInfo?: number;
+    /** 시설 면적 (평) */
+    facilitySize?: number;
+    /** 시설 설명 */
+    facilityDesc?: string;
+    /** (optional) 요일 정책 (stereo = 단일 생성) */
+    dayOfTheWeekPolicy?: string[];
+    /** 자동 연장 사용 여부 */
+    useAutoExtend?: number;
+    /** 결제 방식등록 id */
+    paymentId?: string;
+    /** 결제 관리 모델 */
+    payment$?: PaymentModel;
+    /** 프로그램 취소 관리 id */
+    cancelId?: string;
+    /** 취소 관리 모델 */
+    cancel$?: CancelModel;
+    /** 프로그램 노출 관리 id */
+    displayId?: string;
+    /** 노출 관리 모델 */
+    display$?: DisplayModel;
+    /** 프로그램 기간 신청 관리 id */
+    periodId?: string;
+    /** 프로그램 기간 신청 관리 모델 */
+    period$?: PeriodEnrollModel;
+    /** 프로그램 시간 신청 관리 id */
+    timeId?: string;
+    /** 프로그램 시간 신청 관리 모델 */
+    time$?: TimeEnrollModel;
+    /** 푸쉬 관리 id */
+    pushId?: string;
+    /** 푸쉬 관리 모델 */
+    push$?: PushNotificationModel;
+    /** 업체/강사 관리 id */
+    operatorId?: string;
+    /** 업체/강사 관리 모델 */
+    operator$?: ProgramOperatorModel;
+}
+/**
+ * Type: `PaymentHead`
+ */
+export interface PaymentHead {
+    /** auto sequence */
+    id?: string;
+    /** parent program model id */
+    programId?: string;
+}
+/**
+ * Type: `PaymentModel`
+ * - 프로그램 결제 관리 모델
+ * - 프로그램 생성 시 같이 생성! (단독 생성 x)
+ */
+export interface PaymentModel extends PaymentHead {
+    /** 세대원 선택 여부 */
+    useTenant?: number;
+    /** 추가정책  */
+    addPolicies?: string[];
+    /** 결제방식 */
+    paymentMethod?: PaymentType;
+    /** 할인 종류 */
+    discountType?: DiscountType;
+    /** 청구 방식 */
+    billingMethod?: BillingType;
+    /** 해당 부가월 */
+    targetMonth?: MonthType;
+}
+/**
+ * Type: `PeriodEnrollHead`
+ */
+export interface PeriodEnrollHead {
+    /** auto sequence */
+    id?: string;
+    /** id of parent  */
+    programId?: string;
+    /** 월권 신청 사용 여부 (1: 사용함, 0: 사용안함) */
+    useMonthly?: number;
+    /** 일권 신청 사용 여부 (1: 사용함, 0: 사용안함) */
+    useDaily?: number;
+}
+/**
+ * Type: `PeriodEnrollModel`
+ * - 프로그램 기간 신청 관리 모델
+ */
+export interface PeriodEnrollModel extends PeriodEnrollHead {
+    /** 월권 금액 (원) */
+    monthlyPrice?: number;
+    /** 월권 시작일자 타입 */
+    monthlyStartType?: ProgramStartType;
+    /**
+     * 월권 예약 가능 일자
+     * - 월권 시작 일자 타입이 오늘 기준일 경우.
+     * - 오늘 날짜 + 월권 예약 가능 일자까지 예약 가능하게 됨.
+     */
+    monthlyAvailableReserveDate?: number;
+    /** 월권 시작일자 정보
+     * - 월권 시작 일자 타입이 기간 설정일 경우.
+     */
+    monthlyStartDate?: PeriodInfo;
+    /** 월권 예약 기간 정보 */
+    monthlyReservePeriod?: PeriodInfo;
+    /** 우선 등록 여부 (1: 사용함, 0: 사용안함) */
+    useEarlyRegister?: number;
+    /** 우선 등록 시작 일자 */
+    earlyRegisterPeriod?: PeriodInfo;
+    /** 자동 연장 사용 여부 (1: 사용함, 0: 사용안함) */
+    useAutoExtension?: number;
+    /** 일권 금액 (원) */
+    dailyPrice?: number;
+    /** 일권 시작일자 타입 */
+    dailyStartType?: ProgramStartType;
+    /**
+     * 일권 예약 가능 일자
+     * - 일권 시작 일자 타입이 오늘 기준일 경우.
+     * - 오늘 날짜 + 일권 예약 가능 일자까지 예약 가능하게 됨.
+     */
+    dailyAvailableReserveDate?: number;
+    /** 일권 시작 일자 정보
+     * - 일권 시작일자 타입이 기간 설정일 경우.
+     */
+    dailyStartDate?: PeriodInfo;
+    /** 일권 예약 가능 범위 (일) */
+    availableReserveRange?: number;
+    /** 일권 예약 불가 범위 (일) */
+    inAvailableReserveRange?: number;
+}
+/**
+ * Type: `CancelHead`
+ */
+export interface CancelHead {
+    /** auto sequence */
+    id?: string;
+    /** 취소 정책명 */
+    name?: string;
+    /** parent program model id */
+    programId?: string;
+}
+/**
+ * Type: `CancelModel`
+ * - 프로그램 취소 정책 관리 모델
+ * - 프로그램 생성 시 같이 생성! (단독 생성 x)
+ */
+export interface CancelModel extends Model, CancelHead {
+    /** 취소 기간 사용 (허용) 여부 */
+    useCancellationPeriod?: number;
+    /** 취소 가능 기간*/
+    cancellationPeriod?: number;
+    /** 취소 정책 */
+    cancellationPolicy?: string;
+    /** 환불 정책 타입*/
+    refundPolicy?: RefundType;
+    /** 환불정책 -> 일할 계산시 운영 일수 */
+    operationDay?: number;
+    /** 환불정책 -> 횟수 계산시 전체 횟수 */
+    noOfOperation?: number;
+    /** 환불정책 -> 시간기준 수수료 계산시 시간(hour) */
+    untilHour?: number;
+    /** 환불정책 -> 날짜기준 수수료 계산시 시간(date) */
+    untilDate?: number;
+    /** 환불정책 -> 날짜기준 수수료 계산시 위약금 비율 */
+    eachPenaltyRate?: ComissionRate[];
+    /** 위약금 사용 여부 */
+    usePenalty?: number;
+    /** 위약금 비율 (%) */
+    penaltyRate?: number;
+    /** 폐강 기준 인원 */
+    minNumOfPeople?: number;
+    /** 취소 사유 수집 사용 여부*/
+    useCollectReason?: number;
+    /** 취소 사유 */
+    cancellationReason?: string[];
+}
+/**
+ * Type: `DisplayHead`
+ */
+export interface DisplayHead {
+    /** auto-sequence */
+    id?: string;
+    /** 노출 상태 (1: 노출, 0: 노출안함 )*/
+    useDisplay?: number;
+    /** 서비스 상태 */
+    serviceStatus?: ServiceStatus;
+    /** parent program model id */
+    programId?: string;
+}
+/**
+ * Type: `DisplayModel`
+ * - 프로그램 노출 관리 모델
+ * - 프로그램 생성 시 같이 생성! (단독 생성 x)
+ */
+export interface DisplayModel extends DisplayHead {
+    /** 기기 종류 */
+    device?: DeviceType;
+    /** 대분류 카테고리 */
+    mainCategory?: string;
+    /** 중분류 카테고리 */
+    middleCategory?: string;
+    /** 탭 메뉴 */
+    tapMenu?: string[];
+}
+/**
+ * Type: `TimeEnrollHead`
+ */
+export interface TimeEnrollHead {
+    /** auto-sequence */
+    id?: string;
+    /** parent program model id */
+    programId?: string;
+}
+/**
+ * Type: `TimeEnrollModel`
+ * - 시간 신청 관리 모델
+ */
+export interface TimeEnrollModel extends TimeEnrollHead {
+    /** 금액 */
+    price?: number;
+    /** 예약 가능 일자 타입 */
+    reserveType?: ProgramStartType;
+    /**
+     * 예약 가능 일자
+     * - 예약 가능 일자 타입이 오늘 기준(today)일 경우.
+     * - 오늘 날짜 + 예약 가능 일자까지 예약 가능하게 됨.
+     */
+    availableReserveDate?: number;
+    /** 예약 가능 기간 정보.
+     * - 예약 가능 일자 타입이 기간 설정(period)일 경우.
+     */
+    availableReservePeriod?: PeriodInfo;
+    /** 예약 가능 범위 기준 (시간 or 분) */
+    baseOfReserveAvailableRange?: BaseTimeType;
+    /** 예약 가능 범위 */
+    reserveAvailableRange?: number;
+    /** 시간 간격 기준 (시간 or 분) */
+    baseOfTimeInterval?: BaseTimeType;
+    /** 시간 간격 */
+    timeInterval?: number;
+    /** 예약 불가 범위 간격 기준 (시간 or 분) */
+    baseOfReserveInAvailableRange?: BaseTimeType;
+    /** 예약 불가 범위 (Today 기준) */
+    reserveInAvailableRange?: number;
+    /** 시간 제한 사용 여부 */
+    useTimeLimit?: number;
+    /** 시간 제한 (시간 범위) */
+    timeLimits?: PeriodInfo[];
+    /** 요일 정책 사용 여부  */
+    useDayOfTheWeekPolicy?: number;
+    /** 요일 정책 */
+    dayOfTheWeekPolicies?: DayOfTheWeekPolicy[];
+}
+/**
+ * Type: `PushNotificationHead`
+ */
+export interface PushNotificationHead {
+    /** auto-sequence */
+    id?: string;
+    /** parent program model id */
+    programId?: string;
+}
+/**
+ * Type: `PushNotificationModel`
+ * - 푸쉬 관리 모델
+ */
+export interface PushNotificationModel extends Model, PushNotificationHead {
+    /** 메시지 (푸쉬 텍스트) */
+    msg?: string;
+    /** 발송 일자 (YYMMDD) */
+    dateToSent?: string;
+    /** 발송 시간 (HHMM) */
+    timeToSent?: string;
+    /** 발송한 시각 */
+    sentAt?: number;
+}
+/**
+ * Type: `ProgramOperatorHead`
+ */
+export interface ProgramOperatorHead {
+    /** auto-sequence */
+    id?: string;
+    /** 프로필 노출 여부 (1: 사용함, 0: 사용안함) */
+    useProfileDisplay?: number;
+    /** id of program model */
+    programId?: string;
+}
+/**
+ * Type: `ProgramOperatorModel`
+ * - 프로그램 업체/강사 관리 모델.
+ * - 프로그램 관리 및 담당에 대한 정보를 담음.
+ */
+export interface ProgramOperatorModel extends Model, ProgramOperatorHead {
+    /** 프로그램 담당 협력업체 id */
+    firmId?: string;
+    /** 프로그램 담당 협력업체 이름 */
+    firmName?: string;
+    /** 프로그램 담당 실무자/강사 id */
+    managerId?: string;
+    /** 프로그램 담당 실무자/강사 이름 */
+    managerName?: string;
+}
+/**
+ * Type: `FirmModel`
+ * - 협력 업체 관리 모델
+ */
+export interface FirmModel extends Model {
+    /** <auto-sequence> */
+    id?: string;
+    /** stereo type */
+    stereo?: FirmStereoType;
+    /** uniqueNo: 협력업체 고유 번호 */
+    uniqueNo?: string;
+    /** name: 업체 이름 */
+    name?: string;
+    /** type: 협력업체 유형 */
+    coopType?: string;
+    /** serviceSector: 서비스 분야 */
+    serviceSector?: string;
+    /** typeCode: 서비스 유형 코드 */
+    typeCode?: string;
+    /** uniqueTag: 식별 태그 */
+    uniqueTag?: string;
+    /** registerAt: 등록 일자 */
+    registerAt?: string;
+    /** endAt: 종료 일자 */
+    endAt?: string;
+    /** managerId: 책임자 id */
+    managerId?: string;
+    /** managerName: 책임자 이름 */
+    managerName?: string;
+    /** isValid: 협력업체 유효 상태 (1: 유효, 0: 종료) */
+    isValid?: number;
+}
+/**
+ * Bank model (은행 모델)
+ */
+export interface BankModel extends Model, Codable {
+    /**
+     * auto sequence id
+     */
+    id?: string;
+    /**
+     * bank code issued by south korea 금융결제원 (금융결제원에서 부여한 은행코드)
+     * (ex. 산업은행: 002, 국민은행: 004, 우리은행: 020)
+     */
+    bankKrCode?: string;
+    /**
+     * bank name (은행 이름)
+     * (ex. 우리은행, 국민은행)
+     */
+    name?: string;
+}
+/**
+ * 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 */
+    test?: number;
+    /**
+     * inner Object.
+     */
+    readonly Model?: Model;
+    /**
+     * (view) Access Infor.
+     */
+    readonly $identity?: NextIdentityAccess;
+}
+/**
+ * `mock`: internal mock model.
+ * - provice mocks data
+ */
+export interface MockModel extends Model {
+    /** name of this model */
+    name?: string;
+    /** json encoding all data */
+    meta?: string;
+    /** support any data-types */
+    [key: string]: any;
+}
+/**
+ * extract field names from models
+ * - only fields start with lowercase, or all upper.
+ */
+export declare const filterFields: (fields: string[], base?: string[]) => string[];
+export declare const $FIELD: {
+    category: string[];
+    program: string[];
+    payment: string[];
+    cancel: string[];
+    display: string[];
+    period: string[];
+    time: string[];
+    push: string[];
+    bank: string[];
+    operator: string[];
+    firm: string[];
+    test: string[];
+    mock: string[];
+};