@lemoncloud/growing-socials-api 0.24.1224 → 0.25.104

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

@@ -0,0 +1,669 @@
+/**
+ * `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 $LUT, { ActivityStereo, CommentStereo, FeedStereo, TagStereo, TopicStereo, UserStereo } from './types';
+/**
+ * type: `ModelType`
+ */
+export declare type ModelType = keyof typeof $LUT.ModelType;
+/**
+ * type: `Model`: common model
+ */
+export declare type Model = CoreModel<ModelType>;
+/**
+ * mapping of `.extra`
+ * - ONLY having string value. (indexing 유지위해서)
+ */
+export interface ModelExtra {
+    [key: string]: string;
+}
+/**
+ * count of each `stereo` in child nodes
+ * - 자식글을 작성할경우, 부모에서 count를 저장함.
+ * - 검색을 최소화 하기 위해서, 정보를 저장함.
+ * - `delete`나 `hidden`시 카운트가 감소함.
+ */
+export interface StereoCount {
+    [key: string]: number;
+}
+/**
+ * common `.text` content body.
+ */
+export interface TextContent {
+    /**
+     * encoded html style with tag
+     * example:
+     * hello <t>world</t>
+     */
+    text?: string;
+    /**
+     * extracted tag text
+     * ex) `#some`
+     */
+    tags?: string[];
+    /** matched id of tag-model (not in order) */
+    tagIds?: string[];
+    /** (optional) partial tag-info by tagIds */
+    tag$$?: TagHead[];
+    /**
+     * extracted social-id text
+     * ex) `@who`
+     */
+    sids?: string[];
+    /** matched list of user-head by social-id */
+    sid$$?: UserHead[];
+    /** matched social-id (normalized, not in order, no duplicated) */
+    socialIds?: string[];
+    /** matched id of user-model by social-id (in order) */
+    userIds?: string[];
+    /** (optional) client-ip when created */
+    clientIp?: string;
+    /** (optional) user-agent when created */
+    userAgent?: string;
+}
+/**
+ * type: `UserHead`
+ * - common head of user-model.
+ */
+export interface UserHead {
+    /** id of user */
+    id?: string;
+    /** nick of user */
+    nick?: string;
+    /** name of user */
+    name?: string;
+    /** profile image of user */
+    image?: string;
+    /** profile link of user */
+    link?: string;
+    /**
+     * social-id (unique) by alias.
+     */
+    socialId?: string;
+}
+/**
+ * social information
+ */
+export interface SnsInfo {
+    /** facebook.com */
+    facebook?: string;
+    /** instagram.com */
+    instagram?: string;
+    /** tiktok.com */
+    tiktok?: string;
+    /** xiaohongshu.com */
+    xiaohongshu?: string;
+    /** lemon8-app.com */
+    lemon8?: string;
+}
+/**
+ * super class to support activity
+ */
+export interface ActivitySupport {
+    /** target model-id */
+    id?: string;
+    /**
+     * total count of `like`
+     * - increased when other user has liked this target.
+     */
+    likeCount?: number;
+    /**
+     * total count of `dislike`
+     * - increased when other user has disliked this target.
+     */
+    dislikeCount?: number;
+    /**
+     * total count of `mark`
+     */
+    markCount?: number;
+    /**
+     * total count of `view`
+     */
+    viewCount?: number;
+    /**
+     * total count of `click`
+     */
+    clickCount?: number;
+    /**
+     * total count of `block`
+     */
+    blockCount?: number;
+    /**
+     * total count of `report`
+     */
+    reportCount?: number;
+    /** (optional) referenced activity */
+    readonly $activity?: ActivityModel;
+}
+/**
+ * type: `UserModel`
+ * - `backend-api`의 user-id와 매칭됨.
+ */
+export interface UserModel<E = ModelExtra> extends UserHead, Model, ActivitySupport {
+    /** := backend-api/users/<id> */
+    id?: string;
+    /** stereo type */
+    stereo?: UserStereo;
+    /** target alias value */
+    alias?: string;
+    /**
+     * nick-name
+     */
+    nick?: string;
+    /**
+     * (optional) name of user
+     */
+    name?: string;
+    /**
+     * (optional) profile link of user.
+     */
+    link?: string;
+    /**
+     * user infor text content.
+     */
+    text?: string;
+    /**
+     * badge condition. (predefined in backend-api)
+     */
+    badge?: string;
+    /**
+     * social id (unique) by alias.
+     */
+    socialId?: string;
+    /**
+     * (alias) the matched identity-id
+     */
+    identityId?: string;
+    /**
+     * latest timestamp of feed.
+     */
+    lastFeedAt?: number;
+    /**
+     * latest id of feed.
+     */
+    lastFeedId?: string;
+    /**
+     * latest no of feed.
+     * - increased for every new feed content.
+     */
+    lastFeedNo?: number;
+    /**
+     * (optional) flag to have access to make ad-feed.
+     */
+    hasAdFeed?: number;
+    /**
+     * profile image of user.
+     */
+    image?: string;
+    /**
+     * background image (or color)
+     */
+    background?: string;
+    /**
+     * (optional) extra fields
+     * - custom extra object..
+     */
+    extra?: E;
+    /**
+     * (optional) sns infor
+     */
+    sns$?: SnsInfo;
+    /**
+     * (optional) count of followings
+     */
+    followings?: number;
+    /**
+     * (optional) count of followers
+     */
+    followers?: number;
+    /**
+     * (optional) count of ranking
+     */
+    ranking?: number;
+    /**
+     * (optional) the matched activity.
+     */
+    readonly $activity?: ActivityModel;
+}
+/**
+ * common head of goods
+ */
+export interface GoodsHead {
+    /**
+     * goods-id
+     */
+    id?: string;
+    /**
+     * 제품명
+     */
+    name?: string;
+    nameEn?: string;
+    /**
+     * 브랜드명
+     */
+    brand?: string;
+    brandEn?: string;
+    /**
+     * 컬러명
+     */
+    color?: string;
+    colorEn?: string;
+    /**
+     * 대표 제품 이미지
+     */
+    image?: string;
+    imageEn?: string;
+}
+/**
+ * type: `FeedHead`
+ * - common head of feed-model.
+ */
+export interface FeedHead {
+    /** id of feed */
+    id?: string;
+    /** name of feed */
+    name?: string;
+}
+/**
+ * type: `FeedModel`
+ * - modeling of feed
+ */
+export interface FeedModel extends FeedHead, Model, ActivitySupport, TextContent {
+    /** := <auto-seq> */
+    id?: string;
+    /** stereo type */
+    stereo?: FeedStereo;
+    /** (internal) target alias value */
+    alias?: string;
+    /** sequenced number of feeds in same user */
+    feedNo?: number;
+    /** sequenced number of childs of this feed */
+    childNo?: number;
+    /** (internal) no of feed/child */
+    no?: number;
+    /**
+     * (internal) 각 자식의 stereo별 카운트
+     * NOTE - `POST /feeds/<id>/child stereo` 을 통한 자동 카운트
+     * TODO - 생성/표시 +1, 삭제/숨김 -1 (다만, aggr이 정확하지 않을 수 있으니 async 업데이트 필요함!)
+     */
+    stereo$?: StereoCount;
+    /** (optional) parent feed-id */
+    parentId?: string;
+    /** (optional) parent feed-info */
+    parent$?: FeedHead;
+    /** (optional) topic linked */
+    topicId?: string;
+    /** (optional) partial topic-info */
+    topic$?: TopicHead;
+    /** user-id of owner */
+    userId?: string;
+    /** (optional) partial user-info */
+    user$?: UserHead;
+    /** (optional) the current identity-id when created */
+    identityId?: string;
+    /** (optional) flag of ad-feed */
+    isAd?: number;
+    /**
+     * (optional) target language to be displayed
+     * @deprecated use `lang$` mapping
+     */
+    langs?: string[];
+    /** posted images */
+    imageIds?: string[];
+    /** (optional) partial image-info */
+    image$$?: ImageHead[];
+    /** sequence number of comments */
+    commentNo?: number;
+    /** count of hidden comments */
+    commentHidden?: number;
+    /**
+     * count of post comments
+     * - total comments := commentPosted - commentHidden
+     */
+    commentPosted?: number;
+    /**
+     * (optional) goods linked
+     */
+    goods$?: GoodsHead;
+    /**
+     * hidden condition.
+     * - 삭제대신 이용하는것
+     * - delete 할 경우 parent/child관계가 끈어지므로, 내부적으로 절대 지우진 않음.
+     */
+    hidden?: number;
+    /**
+     * 숨김처리 시간
+     */
+    hiddenAt?: number;
+    /**
+     * (optional) the single comment embedded.
+     */
+    readonly $comment?: CommentModel;
+    /**
+     * (optional) the single feed in child.
+     */
+    readonly $child?: FeedModel;
+    /**
+     * (optional) the matched activity.
+     */
+    readonly $activity?: ActivityModel;
+    /**
+     * (internal) score value.
+     */
+    readonly _score?: number;
+}
+/**
+ * type: `CommentHead`
+ * - common head of comment-model.
+ */
+export interface CommentHead {
+    /** id of comment */
+    id?: string;
+    /** name of comment */
+    name?: string;
+}
+/**
+ * type: `CommentModel`
+ * - modeling of comment in feed
+ */
+export interface CommentModel extends CommentHead, Model, ActivitySupport, TextContent {
+    /** := <feed-id>:<no> */
+    id?: string;
+    /** stereo type */
+    stereo?: CommentStereo;
+    /** target alias value */
+    alias?: string;
+    /** user-id of comment */
+    userId?: string;
+    /** (optional) partial user-info */
+    user$?: UserHead;
+    /** (optional) the current identity-id when created */
+    identityId?: string;
+    /** parent feed */
+    feedId?: string;
+    /** (optional) partial feed-info */
+    feed$?: FeedHead;
+    /**
+     * (optional) goods linked
+     */
+    goods$?: GoodsHead;
+    /**
+     * internal seq-number in feed
+     */
+    no?: number;
+    /**
+     * indent depth (0: default)
+     */
+    depth?: number;
+    /**
+     * parent-id of comment.
+     * - 대댓글일 경우 생김
+     */
+    parent?: string;
+    /**
+     * hidden condition.
+     * - 삭제대신 이용하는것
+     * - delete 할 경우 parent/child관계가 끈어지므로, 내부적으로 절대 지우진 않음.
+     */
+    hidden?: number;
+    /**
+     * 숨김처리 시간
+     */
+    hiddenAt?: number;
+    /**
+     * (optional) the matched activity.
+     */
+    readonly $activity?: ActivityModel;
+}
+/**
+ * type: `ImageHead`
+ * - common head of image-model.
+ */
+export interface ImageHead {
+    /** id of image */
+    id?: string;
+    /** name of image */
+    name?: string;
+}
+/**
+ * type: `ImageModel`
+ * - modeling of image
+ */
+export interface ImageModel extends ImageHead, Model {
+    /** := <auto-seq> */
+    id?: string;
+    /**
+     * (optional) name of image
+     */
+    name?: string;
+    /** user-id of owner */
+    userId?: string;
+    /** (optional) partial user-info */
+    user$?: UserHead;
+    /**
+     * image bucket uploaded
+     */
+    bucket?: string;
+    /**
+     * image key uploaded
+     */
+    key?: string;
+    /** size in pixel */
+    width?: number;
+    /** size in pixel */
+    height?: number;
+    /**
+     * Orientation of image
+     */
+    orientation?: number;
+    /**
+     * Content-Type
+     */
+    contentType?: string;
+    /**
+     * final url to serve
+     */
+    url?: string;
+}
+/**
+ * type: `TagHead`
+ * - common head of tag-model.
+ */
+export interface TagHead {
+    /** id of tag */
+    id?: string;
+    /** name of tag */
+    name?: string;
+}
+/**
+ * type: `TagModel`
+ * - modeling of tag
+ */
+export interface TagModel extends TagHead, Model, ActivitySupport {
+    /**
+     * id := <auto-seq>
+     * - 동음 이의어등 여러가지 상황을 고려해서, name 에 대한 여러가지 ID를 가지도록함
+     * - `alias`로 대표 모델을 지정하도록함.
+     */
+    id?: string;
+    /** stereo of tag */
+    stereo?: TagStereo;
+    /** target alias value */
+    alias?: string;
+    /**
+     * tag name
+     */
+    name?: string;
+    /** flag of censored condition (검열대상) */
+    censored?: number;
+    /**
+     * (optional) the matched activity.
+     */
+    readonly $activity?: ActivityModel;
+}
+/**
+ * type: `TopicHead` (토픽)
+ * - common head of topic-model.
+ */
+export interface TopicHead {
+    /** id of topic */
+    id?: string;
+    /** name of topic */
+    name?: string;
+    /** parent-id of topic */
+    topicId?: string;
+}
+/**
+ * type: `TopicModel`
+ * - modeling of topic(토픽)
+ * - 토픽(주제)에 따른 피드(글)을 올릴 수 있다.
+ * - 특정 주제에 대한 내용 당음. (1피드에 1개의 토픽 매핑됨)
+ */
+export interface TopicModel extends TopicHead, Model, ActivitySupport, TextContent {
+    /**
+     * id := <auto-seq>
+     */
+    id?: string;
+    /** stereo of topic */
+    stereo?: TopicStereo;
+    /** target alias value */
+    alias?: string;
+    /**
+     * topic name
+     */
+    name?: string;
+    /** ordering number */
+    order?: number;
+    /** flag of censored condition (검열대상) */
+    censored?: number;
+    /** parent topic to support */
+    topicId?: string;
+    /** partial parent */
+    topic$?: TopicHead;
+    /** user-id of owner */
+    userId?: string;
+    /** (optional) partial social-info */
+    social$?: UserHead;
+    /**
+     * (optional) the matched activity.
+     */
+    readonly $activity?: ActivityModel;
+}
+/**
+ * type: `ActivityHead`
+ * - common head of activity-model.
+ */
+export interface ActivityHead {
+    /** id of activity */
+    id?: string;
+    /** name of activity */
+    name?: string;
+}
+/**
+ * type: `ActivityModel`
+ * - 사용자별 활동 정보 저장
+ * - 경주별 구매 여부, 읽기 카운트등..
+ */
+export interface ActivityModel extends ActivityHead, Model {
+    /**
+     * id = <stereo>:md5(<custom-key>).len(<custom-key>)
+     */
+    id?: string;
+    /** stereo of model */
+    stereo?: ActivityStereo;
+    /** owner user-id */
+    userId?: string;
+    /** target resource-id */
+    targetId?: string;
+    /**
+     * liked count for transaction
+     * - 게시글: 좋아요 (like)
+     * - 사용자: 팔로잉 (follow)
+     *
+     * [좋아요] (0 -> 1)
+     * - 1를 증가시키고, 그 결과가 1이면 `likeCount` 증가시킴
+     * - 1를 증가시키고, 그 결과가 >1 이면, set `liked := 1` 적용
+     * 기대치) 항상 값을 `1`으로 유지시킴.
+     *
+     * [좋아요 해제] -> 좋아도 반대 (1 -> 0)
+     * - 1를 감소키고, 그 결과가 0이면 `likeCount` 감소시킴
+     * 기대치) 항상 값을 0으로 유지시킴.
+     */
+    liked?: number;
+    /** 좋아요 설정 시간 (없으면 null) */
+    likedAt?: number;
+    /** disliked count for transaction */
+    disliked?: number;
+    /** 싫어요 설정 시간 (없으면 null) */
+    dislikedAt?: number;
+    /** 북마크: marked count for transaction */
+    marked?: number;
+    /** 북마크 설정 시간 (없으면 null) */
+    markedAt?: number;
+    /**
+     * 구독: 피드/유저의 구독 상태에 따른 여부
+     * - 피드 수신 상태를 나타낼때, 구독에 따른 피드인지 확인하기 위함
+     */
+    subscribed?: number;
+    /**
+     * 구독시간: 구독으로 수신된 시간
+     */
+    subscribedAt?: number;
+    /**
+     * 읽은 개수 처리
+     */
+    viewed?: number;
+    /** 읽기한 설정 시간 (없으면 null) */
+    viewedAt?: number;
+    /** (optional) the accumulated viewMilliSecond */
+    viewMilliSecond?: number;
+    /**
+     * 클릭 개수 처리
+     */
+    clicked?: number;
+    /** 클릭한 설정 시간 (없으면 null) */
+    clickedAt?: number;
+    /** 신고: reported count for transaction */
+    reported?: number;
+    /** 신고 시간 (if applicable) */
+    reportedAt?: number;
+    /** 신고 내용 */
+    reportedReason?: string;
+    /** 차단: blocked count for transaction */
+    blocked?: number;
+    /** 차단 시간 (if applicable) */
+    blockedAt?: number;
+    /** 차단 내용 */
+    blockedReason?: string;
+}
+/**
+ * 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: {
+    user: string[];
+    feed: string[];
+    comment: string[];
+    tag: string[];
+    topic: string[];
+    image: string[];
+    activity: string[];
+};
+export declare const $FIELD: {
+    user: string[];
+    feed: string[];
+    comment: string[];
+    tag: string[];
+    topic: string[];
+    image: string[];
+    activity: string[];
+};