@carsayo/types 1.1.892080 → 1.1.892082

package/dist/types/modules/board/interface.d.ts

@@ -0,0 +1,233 @@
+import { BoardKey } from "../../../data";
+import { MemberType } from "../member";
+import { Board_watchableMemberType, Board_writableMemberType, Post_LikeHateState } from "./type";
+/** 글 리스트 검색 결과 */
+export interface PostList {
+    totalCount: number;
+    /** 해당 게시판 카테고리 내 중요 글(상단 고정글) */
+    importantPost: PostShortInfo[];
+    /** 검색 결과(고정글 제외) */
+    searchedPost: PostShortInfo[];
+}
+/** 글 상세정보 */
+export interface PostShortInfo {
+    /**
+     * 글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 글 카테고리 */
+    board_category: Board_Category;
+    title: string;
+    content: string;
+    /** 작성 회원 정보, 비회원 글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    /**
+     * 공개글인지 여부
+     * 비공개글일 경우 본인과 관리자만 읽을 수 있습니다.
+     */
+    isPublic: boolean;
+    /**
+     * 중요한 글인지 여부
+     * 게시판에서 important한 글은 상단에 고정되어야 합니다!!
+     */
+    isImportant: boolean;
+    /** 밴된 글인지 여부. 관리자가 밴먹인 글인지 여부입니다. */
+    isBanned: boolean;
+    /**
+     * 조회수
+     */
+    count_read: number;
+    /**
+     * 좋아요 개수
+     */
+    count_like: number;
+    /**
+     * 싫어요 개수
+     */
+    count_hate: number;
+    /**
+     * 댓글 개수
+     */
+    count_comment: number;
+    created_at: Date;
+    updated_at: Date;
+}
+/** 글 상세정보 */
+export interface PostDetailInfo {
+    /**
+     * 글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 게시판 정보 */
+    board: {
+        id: number;
+        name: string;
+        key: BoardKey;
+        description: string;
+        /** 게시판을 볼 수 있는 회원 타입 */
+        watchableMemberType: Board_watchableMemberType;
+        /** 게시판에 글을 쓸 수 있는 회원 타입 */
+        writableMemberType: Board_writableMemberType;
+    };
+    /** 글 카테고리 */
+    board_category: Board_Category;
+    title: string;
+    content: string;
+    content_html: string;
+    /** 댓글 리스트 */
+    comment: PostComment[];
+    /** 작성 회원 정보, 비회원 글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    /**
+     * 공개글인지 여부
+     * 비공개글일 경우 본인과 관리자만 읽을 수 있습니다.
+     */
+    isPublic: boolean;
+    /**
+     * 중요한 글인지 여부
+     * 게시판에서 important한 글은 상단에 고정되어야 합니다!!
+     */
+    isImportant: boolean;
+    /** 밴된 글인지 여부. 관리자가 밴먹인 글인지 여부입니다. */
+    isBanned: boolean;
+    /** 요청자가 이 글을 좋아요/싫어요했는지 여부
+     * @normal 비회원이거나, 좋아요/싫어요 상태가 아닌 것을 의미합니다
+     */
+    likeStatus: Post_LikeHateState;
+    /**
+     * 조회수
+     */
+    count_read: number;
+    /**
+     * 좋아요 개수
+     */
+    count_like: number;
+    /**
+     * 싫어요 개수
+     */
+    count_hate: number;
+    /**
+     * 댓글 개수
+     */
+    count_comment: number;
+    created_at: Date;
+    updated_at: Date;
+}
+/** 댓글 상세정보 */
+export interface PostComment {
+    /**
+     * 댓글 Id
+     * @description Autoincrement Integer
+     */
+    id: number;
+    /** 어느 글의 댓글인지 */
+    board_postId: number;
+    /** 작성 회원 정보, 비회원 댓글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 댓글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    content: string;
+    isBanned: boolean;
+    /** 대댓글 리스트 */
+    post_comment_reply: PostCommentReply[];
+    created_at: Date;
+    updated_at: Date;
+    /** 댓글 삭제 여부 판단은 이걸루 하세용 */
+    deleted_at: Date | null;
+}
+export interface PostCommentReply {
+    id: number;
+    /** 어느 댓글의 댓글인지 */
+    board_post_commentId: number;
+    /** 작성 회원 정보, 비회원 대댓글이 아닐 경우 정의됩니다 */
+    member: {
+        id: string;
+        name_nick: string;
+        type: MemberType;
+    } | null;
+    /** 비회원 작성 대댓글일 경우 정의됩니다 */
+    guest: {
+        name: string;
+    } | null;
+    content: string;
+    isBanned: boolean;
+    created_at: Date;
+    updated_at: Date;
+    /** 대댓글 삭제 여부 판단은 이걸루 하세용 */
+    deleted_at: Date | null;
+}
+/** 게시판 정보 */
+export interface BoardInfo {
+    /**
+     * 게시판 ID
+     */
+    id: number;
+    /**
+     * 게시판 키값. 중요합니다.
+     */
+    key: BoardKey;
+    /**
+     * 게시판 이름
+     */
+    name: string;
+    /**
+     * 게시판 설명
+     */
+    description: string;
+    /**
+     * 게시판을 볼 수 있는 회원 타입
+     */
+    watchableMemberType: Board_watchableMemberType;
+    /**
+     * 게시판에 글을 작성할  수 있는 회원 타입
+     */
+    writableMemberType: Board_writableMemberType;
+    /**
+     * 댓글 작성 가능 게시판 여부
+     */
+    commentAble: boolean;
+    /**
+     * 신고 기능 가능 여부
+     */
+    reportAble: boolean;
+    /**
+     * 싫어요 가능 여부
+     */
+    hateAble: boolean;
+    /**
+     * 좋아요 가능 여부
+     */
+    likeAble: boolean;
+    board_category_list: Board_Category[];
+}
+/** 게시판 카테고리 */
+export interface Board_Category {
+    id: number;
+    name: string;
+    /** 해당 게시판을 볼 수 있는 회원 타입 */
+    watchableMemberType: Board_watchableMemberType;
+}

package/dist/types/modules/board/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/modules/board/type.d.ts

@@ -0,0 +1,30 @@
+import { MemberType } from "../member";
+/**
+ * @case like: 좋아요
+ * @case normal: 기본 (좋아요도 싫어요도 아님)
+ * @case hate: 싫어요
+ */
+export type Post_LikeHateState = "like" | "hate" | "normal";
+export declare const Post_LikeHateState: {
+    like: string;
+    hate: string;
+    normal: string;
+};
+/**
+ * @description 해당 컨텐츠를 볼 수 있는 회원 타입
+ * @notice 어드민은 모든 컨텐츠를 볼 수 있습니다
+ * @case common: 모든 회원 타입에 대하여 허용된 컨텐츠
+ * @case customer: 일반 회원에 대하여 허용된 컨텐츠
+ * @case dealer: 딜러에게만 허용된 컨텐츠
+ * @case admin: 어드민에 대하여만 허용된 컨텐츠
+ */
+export type Board_watchableMemberType = null | MemberType;
+/**
+ * @description 글을 작성할 수 있는 회원 유형
+ * @notice 어드민은 모든 컨텐츠 작성이 가능합니다
+ * @case null: 모든 회원 타입에 대하여 작성이 허용된 컨텐츠
+ * @case customer: 일반 회원에 대하여만 작성이 허용된 컨텐츠
+ * @case dealer: 딜러에게 대하여만 작성이 허용된 컨텐츠
+ * @case admin: 어드민에 대하여만 작성이 허용된 컨텐츠
+ */
+export type Board_writableMemberType = null | MemberType;

package/dist/types/modules/board/type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Post_LikeHateState = void 0;
+exports.Post_LikeHateState = {
+    like: "like",
+    hate: "hate",
+    normal: "normal",
+};

package/dist/types/modules/car/dto.d.ts

@@ -0,0 +1,404 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { CarCategoryId, CarMakerId, CarShapeId, PopularCarCategoryId } from "../../../data";
+import { CarAdminAdditionalInfo, CarColorInternalSelection, CarColorRestrictions } from "./interface";
+export interface GetCarModelDTO {
+    carMakerId: CarMakerId;
+    /**
+     * 가격 정보가 없는 모델도 같이 검색하는 옵션
+     * @notice 기본값은 false입니다
+     * @description 슈퍼카에서만 사용합니다
+     */
+    withoutPriceModel?: boolean;
+}
+export interface GetCarTrimDTO {
+    carModelId: number;
+}
+export interface GetCarGradeDTO {
+    carTrimId: number;
+}
+export interface GetCarColorDTO {
+    carGradeId: number;
+}
+export interface GetCarOptionDTO {
+    carGradeId: number;
+}
+export interface GetCarOptionDescriptionDTO {
+    carOptionDescriptionId: number;
+}
+/** 차량 좋아요 정보 업데이트 */
+export interface UpdateInterestCarDTO {
+    carModelId: number;
+    isInterest: boolean;
+}
+/** 인기차량 설정 */
+export interface SetCarPopularDTO {
+    name: string;
+    description: string;
+    carModelId: number;
+    popularCategoryId: PopularCarCategoryId;
+    /** 인기차량 정렬을 위한 가중치
+     * @notice 높은 값이 먼저 정렬되어 나옵니다
+     */
+    orderWeight?: number;
+}
+/** 인기차량 제거 */
+export interface DeleteCarPopularDTO {
+    id: number;
+}
+export interface GetCarDTO {
+    carId: string;
+}
+export interface CarDataDTO {
+    id: string;
+    isPublic: boolean;
+    isForeign: boolean | null;
+    car_makerId: number | null;
+    car_modelId: number | null;
+    car_trimId: number | null;
+    car_gradeId: number | null;
+    car_colorId: number | null;
+    car_LINK_option: CarOptionDTO[] | null;
+    isDefaultOption: boolean | null;
+}
+export interface CarOptionDTO {
+    car_optionId: number;
+}
+export interface GetCarOptionColorListDTO {
+    carGradeId: number;
+}
+export declare class ModifyCarMakerDTO {
+    id: number;
+    name_changed?: string | null;
+    isHidden: boolean;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export interface ModifyCarModelDTO {
+    id: number;
+    modelName: string;
+    /** 모델 브랜드 이름 */
+    name_brand: string;
+    isHidden: boolean;
+    /** 모델 이미지 URL */
+    image_url?: string;
+    /** 사전예약 차량 여부 */
+    isPreorder: boolean;
+    /** 전기차 모델 여부 */
+    isElectric: boolean;
+    /** 카테고리 */
+    car_category?: CarCategoryId;
+    /** 신규 모델 기간 */
+    newCarPeriod?: Date | null;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export interface ModifyCarTrimDTO {
+    id: number;
+    trimName: string;
+    isHidden: boolean;
+    /** 해당 트림을 연결할 모델 id */
+    car_modelId?: number;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export interface ModifyCarGradeDTO {
+    id: number;
+    gradeName: string;
+    gradePrice: number;
+    /**
+     * @description 탑승 인원 수
+     * @db 0일 경우 빈 문자열 DB에 삽입
+     * @note 직접 생성한 데이터에만 업데이트 가능합니다
+     * @note 해당 데이터는 NiceDNR CarData 업데이트 앱에서 덮어씌우기 때문임
+     */
+    seatingCapacity: number;
+    /**
+     * @description 연료 타입 string
+     * @note 빈 문자열일 경우 빈 문자열 db에 삽입
+     * @note 직접 생성한 데이터에만 업데이트 가능합니다
+     * @note 해당 데이터는 NiceDNR CarData 업데이트 앱에서 덮어씌우기 때문임
+     */
+    fuel: string;
+    /**
+     * @description 엔진 배기량
+     * @db 0일 경우 빈 문자열 DB에 삽입
+     * @note 직접 생성한 데이터에만 업데이트 가능합니다
+     * @note 해당 데이터는 NiceDNR CarData 업데이트 앱에서 덮어씌우기 때문임
+     */
+    displace: number;
+    /** 해당 등급을 연결할 트림 id
+     * @note 직접 생성한 데이터에만 업데이트 가능합니다
+     * @note 해당 데이터는 NiceDNR CarData 업데이트 앱에서 덮어씌우기 때문임
+     */
+    car_trimId?: number;
+    isHidden: boolean;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export interface ModifyCarGradeOptionDTO {
+    gradeId: number;
+    /** 필수 옵션 카테고리 */
+    essential_category: string[];
+    /** 선택 옵션 카테고리 */
+    radio_category: string[];
+}
+export interface ModifyCarOptionDTO {
+    /** 옵션Id */
+    id: number;
+    /** 해당 등급Id
+     * @Note 필수 옵션 처리에 사용합니다.
+     */
+    gradeId: number;
+    optionName: string;
+    optionPrice: number;
+    /** 카테고리 */
+    category: string | null;
+    /** 옵션 짧은 설명 (한줄내외) */
+    optionInfo: string | null;
+    isHidden: boolean;
+    isEssential: boolean;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export declare class ModifyCarColorDTO {
+    id: number;
+    gradeId: number;
+    /** 색상 이름 */
+    colorName: string;
+    /** 색상 가격 */
+    colorPrice: number;
+    /** 색상 설명 */
+    description: string | null;
+    /** 카테고리 */
+    category: string | null;
+    /** 색상 이미지 URL */
+    image_url?: string | null;
+    /** 색상 코드 (주색)
+     * @example "#222"
+     * @note null일 경우 제거
+     */
+    color_code_main?: string | null;
+    /** 색상 코드 (보조색)
+     * @example "#222"
+     * @note 다중 색상일 경우(2개 색상이 섞이는 경우) 정의
+     * @note null일 경우 제거
+     */
+    color_code_sub?: string | null;
+    /** 경고 문구
+     * @example 프리미엄 셀렉션 2 필수
+     * @note null일 경우 제거
+     */
+    warning_text?: string | null;
+    /** 외장색상 여부
+     * @note 외장색상일 경우 false, 내장색상일 경우 true
+     * @default false
+     */
+    is_interior?: boolean;
+    isHidden: boolean;
+    /** 해당 색상 선택 시 걸리는 제한 사항 */
+    restrictions: CarColorRestrictions | null;
+    /** 색상 하위 선택항목 목록
+     * @note 현재 내장색상에서만 정상동작합니다.
+     */
+    internalSelection: CarColorInternalSelection[] | null;
+    /** 관리자용 추가정보 */
+    admin_additional_info?: CarAdminAdditionalInfo[];
+}
+export interface ModifyCarOptionRelationDTO {
+    /** 대상 옵션 Id */
+    id: number;
+    /** 대상 등급 Id */
+    gradeId: number;
+    include: number[];
+    nessary: number[];
+    incompatible: number[];
+}
+/** 옵션에 대한 상세 설명 */
+export interface ModifyCarOptionDescriptionDTO {
+    /** descriptionId */
+    id: number;
+    car_optionId: number;
+    car_makerId: number;
+    car_modelIdList: number[];
+    /** 옵션 설명 제목 */
+    name: string;
+    /** 상세 설명 내용,
+     * @notice 빈 String이 올 수 있습니다.
+     */
+    content: string;
+    /** 옵션 설명 이미지 url
+     * @example https://cdn.carsayo.net/resource/car/option/description/image/13181.jpg
+     */
+    imgSrc: string | null;
+    include: CarOptionDescriptionIncludeDTO[];
+}
+interface CarOptionDescriptionIncludeDTO {
+    id: number;
+    car_makerId: number;
+    car_modelIdList: number[];
+    /** 옵션 하위 내용 제목 */
+    name: string;
+    /** 옵션 하위 내용 상세 설명
+     * @notice 빈 String이 올 수 있습니다.
+     */
+    content: string;
+    /** 옵션 설명 이미지 url
+     * @example https://cdn.carsayo.net/resource/car/option/description/image/13181.jpg
+     */
+    imgSrc: string | null;
+}
+export interface UpdateSortOrderDTO {
+    id: number;
+    sort_order: number;
+}
+export interface ModifyCarSortOrderDTO {
+    key: "maker" | "model" | "trim" | "grade" | "option" | "color";
+    /** @note key: option, color일 때 필수조건 */
+    gradeId?: number;
+    data: UpdateSortOrderDTO[];
+}
+export interface CreateCarModelDTO {
+    /** 제조사 ID */
+    makerId: CarMakerId;
+    /** 모델 이름 */
+    name: string;
+    /** 모델 브랜드 이름 */
+    name_brand: string;
+    /** 모델 이미지 URL */
+    image_url: string;
+    /** YYYYMM 형식의 출시일
+     * @note Optional
+     */
+    release_day?: string;
+    /** 카테고리 */
+    car_category: CarCategoryId;
+    /** 전기차 모델 여부
+     * @default false
+     */
+    isElectric?: boolean;
+    /** 신규 모델 기간 */
+    newCarPeriod?: Date | null;
+    /** 사전예약 차량 여부
+     * @default false
+     */
+    isPreorder?: boolean;
+}
+export interface CreateCarTrimDTO {
+    /** 모델 ID */
+    modelId: number;
+    /** 트림 이름 */
+    name: string;
+    /** 트림 이미지 URL */
+    image_url: string;
+    /** 카테고리 */
+    car_shape: CarShapeId;
+}
+export interface CreateCarGradeDTO {
+    /** 트림 ID */
+    trimId: number;
+    /** 상세등급 이름 */
+    name: string;
+    /** 가격 */
+    price: number;
+    /** YYYYMM 형식의 출시년월
+     * @note Optional
+     */
+    released_month?: string;
+    /**
+     * @description 탑승 인원 수
+     * @db 0일 경우 빈 문자열 DB에 삽입
+     */
+    seatingCapacity: number | 0;
+    /**
+     * @description 연료 타입 string
+     * @note 빈 문자열일 경우 빈 문자열 db에 삽입
+     */
+    fuel: string | "";
+    /**
+     * @description 엔진 배기량
+     * @db 0일 경우 빈 문자열 DB에 삽입
+     */
+    displace: number | 0;
+}
+export interface DeleteCarDataDTO {
+    id: number;
+    key: "model" | "trim" | "grade";
+}
+export declare class DeleteCarOptionDataDTO {
+    optionId: number;
+    gradeId: number;
+}
+export declare class DeleteCarColorDataDTO {
+    colorId: number;
+    gradeId: number;
+}
+export interface CopyCarGradeDTO {
+    id: number;
+}
+export interface CopyCarColorDTO {
+    colorId: number;
+    gradeId: number;
+}
+export interface CopyCarOptionDTO {
+    optionId: number;
+    gradeId: number;
+}
+export interface CreateCarOptionDTO {
+    /** 옵션을 생성 후 연결할 상세등급 id 목록 */
+    gradeIdList: number[];
+    /** 옵션 이름 */
+    name: string;
+    price: number;
+    /** 카테고리 */
+    category: string | null;
+    /** 옵션 짧은 설명 (한줄내외) */
+    info: string | null;
+}
+export interface CreateCarColorDTO {
+    /** 색상을 생성 후 연결할 상세등급 id 목록 */
+    gradeIdList: number[];
+    /** 색상 이름 */
+    name: string;
+    /** 색상 가격 */
+    price: number;
+    /** 색상 설명 */
+    description: string | null;
+    /** 색상 카테고리 */
+    category: string | null;
+    /** 색상 이미지 URL */
+    image_url?: string;
+    /** 색상 코드 (주색)
+     * @example "#222"
+     */
+    color_code_main?: string;
+    /** 색상 코드 (보조색)
+     * @example "#222"
+     * @note 다중 색상일 경우(2개 색상이 섞이는 경우) 정의
+     */
+    color_code_sub?: string;
+    /** 경고 문구
+     * @example 프리미엄 셀렉션 2 필수
+     * @note null일 경우 제거
+     */
+    warning_text?: string | null;
+    /** 외장색상 여부
+     * @note 외장색상일 경우 false, 내장색상일 경우 true
+     * @default false
+     */
+    is_interior: boolean;
+}
+export interface ConnectCarOptionDTO {
+    gradeId: number;
+    /** @250409 배열 형태로 전달합니다. */
+    optionId: number[];
+}
+export interface ConnectCarColorDTO {
+    gradeId: number;
+    /** @250409 배열 형태로 전달합니다. */
+    colorId: number[];
+}
+/** 특정 모델 내 유효한 모든 옵션을 조회합니다. */
+export interface GetCarModelOptionColorDTO {
+    modelId: number;
+}
+export {};

package/dist/types/modules/car/dto.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteCarColorDataDTO = exports.DeleteCarOptionDataDTO = exports.ModifyCarColorDTO = exports.ModifyCarMakerDTO = void 0;
+class ModifyCarMakerDTO {
+}
+exports.ModifyCarMakerDTO = ModifyCarMakerDTO;
+class ModifyCarColorDTO {
+}
+exports.ModifyCarColorDTO = ModifyCarColorDTO;
+class DeleteCarOptionDataDTO {
+}
+exports.DeleteCarOptionDataDTO = DeleteCarOptionDataDTO;
+class DeleteCarColorDataDTO {
+}
+exports.DeleteCarColorDataDTO = DeleteCarColorDataDTO;

package/dist/types/modules/car/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dto";
+export * from "./interface";
+export * from "./type";