mobx-lark 2.0.0 → 2.1.1

package/src/module/BITable/type.ts

@@ -1,112 +1,120 @@
-import { LarkData, LocaleUser } from '../../type';
-
-export interface RevisionTable {
-    name: string;
-    revision: number;
-}
-
-export interface BITable extends RevisionTable {
-    table_id: string;
-}
-
-export interface TableView extends Record<'view_id' | 'view_name', string> {
-    view_type: 'grid' | 'form';
-}
-
-export interface TableCellText {
-    type: 'text';
-    text: string;
-}
-
-export type TableCellLocation = Record<
-    | 'name'
-    | 'pname'
-    | 'cityname'
-    | 'adname'
-    | 'address'
-    | 'full_address'
-    | 'location',
-    string
->;
-
-export interface TableCellLink extends Record<'link' | 'text', string> {
-    type: 'url';
-}
-
-export interface TableCellMedia
-    extends Record<'file_token' | 'name' | `${'' | 'tmp_'}url`, string> {
-    type: `${string}/${string}`;
-    size: number;
-}
-
-export interface TableCellAttachment
-    extends Pick<TableCellMedia, 'name' | 'size'>,
-        Record<'id' | 'attachmentToken', string>,
-        Record<'height' | 'timeStamp' | 'width', number> {
-    mimeType: TableCellMedia['type'];
-}
-
-export interface TableCellUser extends LocaleUser {
-    id: string;
-}
-
-export type TableCellGroup = Record<'id' | 'name' | 'avatar_url', string>;
-
-export interface TableCellMetion
-    extends Record<'mentionType' | 'text', string> {
-    type: 'mention';
-}
-
-export interface TableCellUserMetion
-    extends TableCellMetion,
-        Record<'name' | 'token', string> {
-    mentionType: 'User';
-    mentionNotify: boolean;
-}
-
-export interface TableCellDocumentMetion
-    extends TableCellMetion,
-        Record<'link' | 'token', string> {
-    mentionType: 'Bitable';
-}
-
-export interface TableCellRelation extends TableCellText {
-    table_id: string;
-    record_ids: string[];
-    text_arr: string[];
-}
-
-export type TableCellObject =
-    | TableCellLocation
-    | TableCellText
-    | TableCellLink
-    | TableCellMedia
-    | TableCellAttachment
-    | TableCellUser
-    | TableCellGroup
-    | TableCellUserMetion
-    | TableCellDocumentMetion
-    | TableCellRelation;
-
-export type TableCellValue =
-    | string
-    | number
-    | boolean
-    | TableCellObject
-    | (string | TableCellObject)[]
-    | null;
-
-export type TableRecordFields = Record<string, TableCellValue>;
-
-export interface TableRecord<T extends TableRecordFields>
-    extends Record<'id' | 'record_id', string> {
-    created_by: TableCellUser;
-    created_time: number;
-    last_modified_by?: TableCellUser;
-    last_modified_time?: number;
-    fields: T;
-}
-
-export type TableRecordData<T extends TableRecordFields> = LarkData<{
-    record: TableRecord<T>;
-}>;
+import { LarkData, LocaleUser } from '../../type';
+
+export interface RevisionTable {
+    name: string;
+    revision: number;
+}
+
+export interface BITable extends RevisionTable {
+    table_id: string;
+}
+
+export interface TableView extends Record<'view_id' | 'view_name', string> {
+    view_type: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
+}
+
+export interface TableFormView
+    extends Record<'name' | 'description' | 'shared_url', string>,
+        Record<'shared' | 'submit_limit_once', boolean> {
+    shared_limit: 'tenant_editable';
+}
+
+export type LarkFormData = LarkData<{ form: TableFormView }>;
+
+export interface TableCellText {
+    type: 'text';
+    text: string;
+}
+
+export type TableCellLocation = Record<
+    | 'name'
+    | 'pname'
+    | 'cityname'
+    | 'adname'
+    | 'address'
+    | 'full_address'
+    | 'location',
+    string
+>;
+
+export interface TableCellLink extends Record<'link' | 'text', string> {
+    type: 'url';
+}
+
+export interface TableCellMedia
+    extends Record<'file_token' | 'name' | `${'' | 'tmp_'}url`, string> {
+    type: `${string}/${string}`;
+    size: number;
+}
+
+export interface TableCellAttachment
+    extends Pick<TableCellMedia, 'name' | 'size'>,
+        Record<'id' | 'attachmentToken', string>,
+        Record<'height' | 'timeStamp' | 'width', number> {
+    mimeType: TableCellMedia['type'];
+}
+
+export interface TableCellUser extends LocaleUser {
+    id: string;
+}
+
+export type TableCellGroup = Record<'id' | 'name' | 'avatar_url', string>;
+
+export interface TableCellMetion
+    extends Record<'mentionType' | 'text', string> {
+    type: 'mention';
+}
+
+export interface TableCellUserMetion
+    extends TableCellMetion,
+        Record<'name' | 'token', string> {
+    mentionType: 'User';
+    mentionNotify: boolean;
+}
+
+export interface TableCellDocumentMetion
+    extends TableCellMetion,
+        Record<'link' | 'token', string> {
+    mentionType: 'Bitable';
+}
+
+export interface TableCellRelation extends TableCellText {
+    table_id: string;
+    record_ids: string[];
+    text_arr: string[];
+}
+
+export type TableCellObject =
+    | TableCellLocation
+    | TableCellText
+    | TableCellLink
+    | TableCellMedia
+    | TableCellAttachment
+    | TableCellUser
+    | TableCellGroup
+    | TableCellUserMetion
+    | TableCellDocumentMetion
+    | TableCellRelation;
+
+export type TableCellValue =
+    | string
+    | number
+    | boolean
+    | TableCellObject
+    | (string | TableCellObject)[]
+    | null;
+
+export type TableRecordFields = Record<string, TableCellValue>;
+
+export interface TableRecord<T extends TableRecordFields>
+    extends Record<'id' | 'record_id', string> {
+    created_by: TableCellUser;
+    created_time: number;
+    last_modified_by?: TableCellUser;
+    last_modified_time?: number;
+    fields: T;
+}
+
+export type TableRecordData<T extends TableRecordFields> = LarkData<{
+    record: TableRecord<T>;
+}>;

package/src/module/BITable/utility.ts

@@ -0,0 +1,57 @@
+import { DataObject } from 'mobx-restful';
+import {
+    TableCellLink,
+    TableCellLocation,
+    TableCellRelation,
+    TableCellText
+} from './type';
+
+export type FilterOperator = '<' | '<=' | '=' | '!=' | '=>' | '>' | 'contains';
+
+/**
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter
+ */
+export function makeSimpleFilter(
+    data: DataObject,
+    operator: FilterOperator = 'contains',
+    relation: 'AND' | 'OR' = 'AND'
+) {
+    const list = Object.entries(data)
+        .map(
+            ([key, value]) =>
+                value != null &&
+                (value instanceof Array ? value : [value]).map(
+                    (item: string) =>
+                        `CurrentValue.[${key}]` +
+                        (operator === 'contains'
+                            ? `.contains("${item}")`
+                            : `${operator}${JSON.stringify(item)}`)
+                )
+        )
+        .filter(Boolean)
+        .flat() as string[];
+
+    return list[1] ? `${relation}(${list})` : list[0];
+}
+
+export const normalizeText = (
+    value: TableCellText | TableCellLink | TableCellRelation
+) =>
+    (value && typeof value === 'object' && 'text' in value && value.text) || '';
+
+export const normalizeTextArray = (list: TableCellText[]) =>
+    list.reduce(
+        (sum, item) => {
+            if (item.text === ',') sum.push('');
+            else sum[sum.length - 1] += normalizeText(item);
+
+            return sum;
+        },
+        ['']
+    );
+export function coordinateOf(location: TableCellLocation): [number, number] {
+    const [longitude, latitude] =
+        (location as TableCellLocation)?.location.split(',') || [];
+
+    return [+latitude, +longitude];
+}

package/src/module/InstantMessenger/index.ts

@@ -1,82 +1,82 @@
-import { ListModel, NewData, Stream, toggle } from 'mobx-restful';
-import { buildURLData } from 'web-utility';
-
-import { LarkData } from '../../type';
-import { createPageStream } from '../base';
-import { ChatMessage, ChatMeta, SendChatMessage } from './type';
-
-export * from './type';
-
-export abstract class ChatListModel extends Stream<ChatMeta>(ListModel) {
-    baseURI = 'im/v1/chats';
-
-    /**
-     * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list}
-     */
-    async *openStream() {
-        for await (const item of createPageStream<ChatMeta>(
-            this.client,
-            this.baseURI,
-            total => (this.totalCount = total)
-        ))
-            yield item;
-    }
-
-    /**
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
-     */
-    @toggle('uploading')
-    async updateOne({ chat_id }: NewData<ChatMeta>) {
-        const { body } = await (chat_id
-            ? this.client.put<LarkData<ChatMeta>>(
-                  `${this.baseURI}/chats/${chat_id}`
-              )
-            : this.client.post<LarkData<ChatMeta>>(
-                  `${this.baseURI}/chats?${buildURLData({
-                      set_bot_manager: true
-                  })}`
-              ));
-        return (this.currentOne = body!.data!);
-    }
-}
-
-export abstract class MessageListModel extends Stream<ChatMessage>(ListModel) {
-    baseURI = 'im/v1/messages';
-
-    constructor(public chatId: string) {
-        super();
-    }
-
-    /**
-     * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list}
-     */
-    async *openStream() {
-        for await (const item of createPageStream<ChatMessage>(
-            this.client,
-            this.baseURI,
-            total => (this.totalCount = total)
-        ))
-            yield item;
-    }
-
-    /**
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create
-     */
-    @toggle('uploading')
-    async createOne({
-        msg_type,
-        content
-    }: Omit<SendChatMessage, 'receive_id'>) {
-        const { body } = await this.client.post<LarkData<ChatMessage>>(
-            `${this.baseURI}?${buildURLData({
-                receive_id_type: 'chat_id'
-            })}`,
-            {
-                receive_id: this.chatId,
-                msg_type,
-                content: JSON.stringify(content)
-            }
-        );
-        return (this.currentOne = body!.data!);
-    }
-}
+import { ListModel, NewData, Stream, toggle } from 'mobx-restful';
+import { buildURLData } from 'web-utility';
+
+import { LarkData } from '../../type';
+import { createPageStream } from '../base';
+import { ChatMessage, ChatMeta, SendChatMessage } from './type';
+
+export * from './type';
+
+export abstract class ChatListModel extends Stream<ChatMeta>(ListModel) {
+    baseURI = 'im/v1/chats';
+
+    /**
+     * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list}
+     */
+    async *openStream() {
+        for await (const item of createPageStream<ChatMeta>(
+            this.client,
+            this.baseURI,
+            total => (this.totalCount = total)
+        ))
+            yield item;
+    }
+
+    /**
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
+     */
+    @toggle('uploading')
+    async updateOne({ chat_id }: NewData<ChatMeta>) {
+        const { body } = await (chat_id
+            ? this.client.put<LarkData<ChatMeta>>(
+                  `${this.baseURI}/chats/${chat_id}`
+              )
+            : this.client.post<LarkData<ChatMeta>>(
+                  `${this.baseURI}/chats?${buildURLData({
+                      set_bot_manager: true
+                  })}`
+              ));
+        return (this.currentOne = body!.data!);
+    }
+}
+
+export abstract class MessageListModel extends Stream<ChatMessage>(ListModel) {
+    baseURI = 'im/v1/messages';
+
+    constructor(public chatId: string) {
+        super();
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list}
+     */
+    async *openStream() {
+        for await (const item of createPageStream<ChatMessage>(
+            this.client,
+            this.baseURI,
+            total => (this.totalCount = total)
+        ))
+            yield item;
+    }
+
+    /**
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create
+     */
+    @toggle('uploading')
+    async createOne({
+        msg_type,
+        content
+    }: Omit<SendChatMessage, 'receive_id'>) {
+        const { body } = await this.client.post<LarkData<ChatMessage>>(
+            `${this.baseURI}?${buildURLData({
+                receive_id_type: 'chat_id'
+            })}`,
+            {
+                receive_id: this.chatId,
+                msg_type,
+                content: JSON.stringify(content)
+            }
+        );
+        return (this.currentOne = body!.data!);
+    }
+}

package/src/module/InstantMessenger/type/index.ts

@@ -1,60 +1,60 @@
-import { TranslationMap } from '../../../type';
-import { ChatMessageContent } from './message';
-
-export * from './message';
-
-export type ChatPermission = 'all_members' | 'only_owner' | 'not_anyone';
-
-export interface CreateChatMeta
-    extends Record<'owner_id' | 'avatar' | 'name' | 'description', string>,
-        Record<`${'join' | 'leave'}_message_visibility`, ChatPermission>,
-        Record<`${'user' | 'bot'}_id_list`, string[]> {
-    chat_mode: 'group';
-    chat_type: 'private' | 'public';
-    i18n_names: TranslationMap;
-    external: boolean;
-    membership_approval: 'no_approval_required' | 'approval_required';
-}
-
-export interface ChatMeta
-    extends CreateChatMeta,
-        Record<'tenant_key' | 'chat_id', string>,
-        Record<
-            `${'add_member' | 'at_all' | 'edit' | 'moderation'}_permission`,
-            ChatPermission
-        > {
-    owner_id_type: 'user_id';
-    chat_tag: 'inner';
-    share_card_permission: 'allowed';
-}
-
-export type ChatMessageType = 'text' | 'card';
-
-export interface SendChatMessage {
-    msg_type: ChatMessageType;
-    content: ChatMessageContent;
-    receive_id: string;
-}
-
-export interface ChatSender extends Record<'id' | 'tenant_key', string> {
-    id_type: 'open_id' | 'app_id';
-    sender_type: 'app';
-}
-
-export type ChatMetion = Pick<ChatSender, 'id' | 'id_type' | 'tenant_key'> &
-    Record<'key' | 'name', string>;
-
-export interface ChatMessage
-    extends Pick<SendChatMessage, 'msg_type'>,
-        Record<`${'create' | 'update'}_time`, string>,
-        Record<'deleted' | 'updated', boolean>,
-        Record<
-            `${'chat' | 'message' | 'upper_message' | 'root' | 'parent'}_id`,
-            string
-        > {
-    sender: ChatSender;
-    mentions: ChatMetion[];
-    body: {
-        content: `${ChatMessageType}:${string}`;
-    };
-}
+import { TranslationMap } from '../../../type';
+import { ChatMessageContent } from './message';
+
+export * from './message';
+
+export type ChatPermission = 'all_members' | 'only_owner' | 'not_anyone';
+
+export interface CreateChatMeta
+    extends Record<'owner_id' | 'avatar' | 'name' | 'description', string>,
+        Record<`${'join' | 'leave'}_message_visibility`, ChatPermission>,
+        Record<`${'user' | 'bot'}_id_list`, string[]> {
+    chat_mode: 'group';
+    chat_type: 'private' | 'public';
+    i18n_names: TranslationMap;
+    external: boolean;
+    membership_approval: 'no_approval_required' | 'approval_required';
+}
+
+export interface ChatMeta
+    extends CreateChatMeta,
+        Record<'tenant_key' | 'chat_id', string>,
+        Record<
+            `${'add_member' | 'at_all' | 'edit' | 'moderation'}_permission`,
+            ChatPermission
+        > {
+    owner_id_type: 'user_id';
+    chat_tag: 'inner';
+    share_card_permission: 'allowed';
+}
+
+export type ChatMessageType = 'text' | 'card';
+
+export interface SendChatMessage {
+    msg_type: ChatMessageType;
+    content: ChatMessageContent;
+    receive_id: string;
+}
+
+export interface ChatSender extends Record<'id' | 'tenant_key', string> {
+    id_type: 'open_id' | 'app_id';
+    sender_type: 'app';
+}
+
+export type ChatMetion = Pick<ChatSender, 'id' | 'id_type' | 'tenant_key'> &
+    Record<'key' | 'name', string>;
+
+export interface ChatMessage
+    extends Pick<SendChatMessage, 'msg_type'>,
+        Record<`${'create' | 'update'}_time`, string>,
+        Record<'deleted' | 'updated', boolean>,
+        Record<
+            `${'chat' | 'message' | 'upper_message' | 'root' | 'parent'}_id`,
+            string
+        > {
+    sender: ChatSender;
+    mentions: ChatMetion[];
+    body: {
+        content: `${ChatMessageType}:${string}`;
+    };
+}