Move ChannelMetaType to channel module.

Declare contact, profile, map, voip attachments.
Separating text, attachment and content methods in ChatBuilder.

Author: storycraft

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-kakao",
-  "version": "4.0.0-beta.3",
+  "version": "4.0.0-beta.4",
   "description": "Loco protocol compatible library",
   "main": "./dist/index.js",
   "exports": {

src/channel/meta.ts

@@ -5,7 +5,26 @@
  */
 
 import { Long } from 'bson';
-import { ChannelMetaType } from '../packet/struct';
+
+export enum KnownChannelMetaType {
+
+  UNDEFINED = 0,
+  NOTICE = 1,
+  GROUP = 2,
+  TITLE = 3,
+  PROFILE = 4,
+  TV = 5,
+  PRIVILEGE = 6,
+  TV_LIVE = 7,
+  PLUS_BACKGROUND = 8,
+  LIVE_TALK_INFO = 11,
+  LIVE_TALK_COUNT = 12,
+  OPEN_CHANNEL_CHAT = 13,
+  BOT = 14,
+
+}
+
+export type ChannelMetaType = KnownChannelMetaType | number;
 
 export enum ChannelClientMetaType {
 
@@ -78,6 +97,23 @@ export interface TvLiveMetaContent {
 
 }
 
+export interface LiveTalkInfoOnMetaContent {
+  liveon: boolean;
+  title: string;
+  startTime: number;
+  userId: number | Long;
+  csIP: string;
+  csIP6: string;
+  csPort: number;
+  callId: string;
+}
+
+export interface LiveTalkInfoOffMetaContent extends Partial<LiveTalkInfoOnMetaContent> {
+  liveon: false;
+}
+
+export type LiveTalkInfoMetaContent = LiveTalkInfoOnMetaContent | LiveTalkInfoOffMetaContent;
+
 export interface LiveTalkCountMetaContent {
 
   count: number;

src/chat/attachment/contact.ts

@@ -0,0 +1,56 @@
+/*
+ * Created on Fri Feb 12 2021
+ *
+ * Copyright (c) storycraft. Licensed under the MIT Licence.
+ */
+
+import { Long } from 'bson';
+
+/**
+ * KakaoTalk profile attachment
+ */
+export interface ProfileAttachment {
+
+  /**
+   * Profile user id
+   */
+  userId: number | Long;
+
+  /**
+   * User nickname
+   */
+  nickName: string;
+
+  /**
+   * User main profile (full)
+   */
+  fullProfileImageUrl: string;
+
+  /**
+   * User profile
+   */
+  profileImageUrl: string;
+
+  /**
+   * Profile status message
+   */
+  statusMessage: string;
+
+}
+
+/**
+ * Call Contact attachment
+ */
+export interface ContactAttachment {
+
+  /**
+   * Contact name
+   */
+  name: string;
+
+  /**
+   * vcf contact file url
+   */
+  url: string;
+
+}

src/chat/attachment/index.ts

@@ -8,3 +8,6 @@ export * from './reply';
 export * from './mention';
 export * from './media';
 export * from './emoticon';
+export * from './voip';
+export * from './contact';
+export * from './map';

src/chat/attachment/map.ts

@@ -0,0 +1,29 @@
+/*
+ * Created on Fri Feb 12 2021
+ *
+ * Copyright (c) storycraft. Licensed under the MIT Licence.
+ */
+
+export interface MapAttachment {
+
+  /**
+   * Latitude (multiplied by 10000000000)
+   */
+  lat: number;
+
+  /**
+   * Longitude (multiplied by 10000000000)
+   */
+  lng: number;
+
+  /**
+   * Map address
+   */
+  a: string;
+
+  /**
+   * true if using kakao map
+   */
+  c: boolean;
+
+}

src/chat/attachment/voip.ts

@@ -0,0 +1,54 @@
+/*
+ * Created on Fri Feb 12 2021
+ *
+ * Copyright (c) storycraft. Licensed under the MIT Licence.
+ */
+
+import { VoipType } from '../../voip';
+
+/**
+ * Voip attachment
+ */
+export interface VoipAttachment {
+
+  /**
+   * Call type
+   */
+  type: VoipType;
+
+  /**
+   * Call server ip
+   */
+  csIP: string;
+
+  /**
+   * Call server ip (ipv6)
+   */
+  csIP6: string;
+
+  /**
+   * Call server port
+   */
+  csPort: number;
+
+  /**
+   * Call id
+   */
+  callId: string;
+
+  /**
+   * Supplied when the call is live talk
+   */
+  title?: string;
+
+  /**
+   * Call start time.
+   * Supplied when the call is live talk.
+   */
+  startTime?: number;
+
+  /**
+   * Call duration
+   */
+  duration: number;
+}

src/chat/chat-builder.ts

@@ -6,23 +6,27 @@
 
 import { Chat } from './chat';
 import { ChatType } from './chat-type';
-import { AttachmentContent, ChatContent } from './content';
+import { AttachmentContent, ChatContent, TextContent } from './content';
 
 /**
  * Build Chat object from existing chat or create new.
  */
 export class ChatBuilder {
-  private _contents: (string | ChatContent)[];
-
-  /**
-   * Set chat options (shout, inapp)
-   * This can be overridden by ChatContents.
-   */
-  public options: Record<string, unknown>;
+  private _contents: ChatContent[];
 
   constructor() {
     this._contents = [];
-    this.options = {};
+  }
+
+  /**
+   * Append text.
+   * this is equivalent of calling builder.append(new TextContent(text));
+   *
+   * @param {string} text
+   * @return {this}
+   */
+  text(text: string): this {
+    return this.append(new TextContent(text));
   }
 
   /**
@@ -37,12 +41,12 @@ export class ChatBuilder {
   }
 
   /**
-   * Append text or chat content.
+   * Append chat content.
    *
-   * @param {string | ChatContent} content
+   * @param {ChatContent} content
    * @return {this}
    */
-  append(content: string | ChatContent): this {
+  append(content: ChatContent): this {
     this._contents.push(content);
     return this;
   }
@@ -55,8 +59,7 @@ export class ChatBuilder {
    * @return {this}
    */
   shout(flag: boolean): this {
-    this.options['shout'] = flag;
-    return this;
+    return this.attachment({ shout: flag });
   }
 
   /**
@@ -81,14 +84,8 @@ export class ChatBuilder {
 
     if (!chat.attachment) chat.attachment = {};
 
-    chat.attachment = Object.assign(chat.attachment, this.options);
-
     for (const content of this._contents) {
-      if (typeof content === 'string') {
-        chat.text += content;
-      } else {
-        content.append(chat);
-      }
+      content.append(chat);
     }
 
     return chat;

src/chat/content/attachment.ts renamed to src/chat/content/default.ts

@@ -5,7 +5,20 @@
  */
 
 import { Chat } from '../chat';
-import { ChatContent } from '../content';
+import { ChatContent } from '.';
+
+/**
+ * Append text
+ */
+export class TextContent implements ChatContent {
+  constructor(public text: string) {
+
+  }
+  
+  append(chat: Chat): void {
+    chat.text += this.text;
+  }
+}
 
 /**
  * Append attachment

src/chat/content/index.ts

@@ -4,7 +4,7 @@
  * Copyright (c) storycraft. Licensed under the MIT Licence.
  */
 
-export * from './attachment';
+export * from './default';
 export * from './mention';
 export * from './reply';
 
@@ -19,4 +19,4 @@ export interface ChatContent {
    */
   append(chat: Chat): void;
 
-}
+}

src/packet/struct/channel.ts

@@ -6,28 +6,9 @@
 
 import { Long } from 'bson';
 import { ChannelType } from '../../channel';
+import { ChannelMetaType } from '../../channel/meta';
 import { ChatlogStruct } from './chat';
 
-export enum KnownChannelMetaType {
-
-  UNDEFINED = 0,
-  NOTICE = 1,
-  GROUP = 2,
-  TITLE = 3,
-  PROFILE = 4,
-  TV = 5,
-  PRIVILEGE = 6,
-  TV_LIVE = 7,
-  PLUS_BACKGROUND = 8,
-  LIVE_TALK_INFO = 11,
-  LIVE_TALK_COUNT = 12,
-  OPEN_CHANNEL_CHAT = 13,
-  BOT = 14,
-
-}
-
-export type ChannelMetaType = KnownChannelMetaType | number;
-
 export interface ChannelMetaStruct {
 
   type: ChannelMetaType;

src/talk/channel/index.ts

@@ -18,6 +18,7 @@ import { ChannelEvents } from '../event';
 import {
   GroupMetaContent,
   LiveTalkCountMetaContent,
+  LiveTalkInfoMetaContent,
   ProfileMetaContent,
   TvLiveMetaContent,
   TvMetaContent,
@@ -131,6 +132,13 @@ export interface TalkChannel extends Channel, ChannelSession, TypedEmitter<Chann
    */
   setLiveTalkCountMeta(content: LiveTalkCountMetaContent): AsyncCommandResult;
 
+  /**
+   * Set live talk info meta
+   *
+   * @param content
+   */
+  setLiveTalkInfoMeta(content: LiveTalkInfoMetaContent): AsyncCommandResult;
+
   /**
    * Set group profile meta
    *

src/talk/channel/talk-channel-session.ts

@@ -35,7 +35,6 @@ import {
 } from '../../packet/chat';
 import {
   ChannelInfoStruct,
-  ChannelMetaType,
   NormalChannelInfoExtra,
   NormalMemberStruct,
   structToChannelUserInfo,
@@ -50,6 +49,7 @@ import { LocoSecureLayer } from '../../network';
 import { newCryptoStore } from '../../crypto';
 import { MediaUploadTemplate } from '../media/upload';
 import { sha1 } from 'hash-wasm';
+import { ChannelMetaType } from '../../channel/meta';
 
 /**
  * Default ChannelSession implementation