mobx-lark 2.1.1 → 2.2.0

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

@@ -1,141 +1,141 @@
-import { I18nKey, TranslationMap } from '../../../type';
-
-export interface TextMessage {
-    text: string;
-}
-
-export interface TextTag extends TextMessage {
-    tag: 'text';
-    un_escape?: boolean;
-}
-
-export interface LinkTag extends TextMessage {
-    tag: 'a';
-    href: string;
-}
-
-export interface AtTag {
-    tag: 'at';
-    user_id: string;
-    user_name?: string;
-}
-
-export interface ImageTag {
-    tag: 'img';
-    image_key: string;
-    width?: number;
-    height?: number;
-}
-
-export type RichTextTag = TextTag | LinkTag | AtTag | ImageTag;
-
-export type RichTextMessage = Record<
-    I18nKey,
-    {
-        title: string;
-        content: RichTextTag[][];
-    }
->;
-
-export interface UserCardMessage {
-    type: 'share_user';
-    user_id: string;
-}
-
-export interface ChatCardMessage {
-    type: 'share_chat';
-    chat_id: string;
-}
-
-export interface FileMessage<T extends string = 'file'> {
-    type: T;
-    file_key: string;
-}
-
-export type StickerMessage = FileMessage<'sticker'>;
-
-export type AudioMessage = FileMessage<'audio'>;
-
-export type VideoMessage = FileMessage<'media'> & Pick<ImageTag, 'image_key'>;
-
-export interface TextCardTag {
-    tag: 'plain_text' | 'lark_md';
-    content?: string;
-    i18n?: TranslationMap;
-    lines?: number;
-}
-
-export interface HrCardTag {
-    tag: 'hr';
-}
-
-export type URLCardTag = Record<
-    `${'' | 'pc_' | 'android_' | 'ios_'}url`,
-    string
->;
-
-export type ConfirmCardTag = Record<'title' | 'text', TextCardTag>;
-
-export interface ButtonCardTag {
-    tag: 'button';
-    type?: 'default' | 'primary' | 'danger';
-    text: TextCardTag;
-    value?: Record<string, string>;
-    url?: string;
-    multi_url?: URLCardTag;
-    confirm?: ConfirmCardTag;
-}
-
-export interface DivCardTag {
-    tag: 'div';
-    text?: TextCardTag;
-    fields?: {
-        is_short: boolean;
-        text: TextCardTag;
-    }[];
-    extra?: ButtonCardTag;
-}
-
-export interface ActionCardTag {
-    tag: 'action';
-    layout: 'bisected';
-    actions: ButtonCardTag[];
-}
-
-export type CardTag = HrCardTag | DivCardTag | ActionCardTag;
-
-export type TemplateColor =
-    | 'blue'
-    | 'wathet'
-    | 'turquoise'
-    | 'green'
-    | 'yellow'
-    | 'orange'
-    | 'red'
-    | 'carmine'
-    | 'violet'
-    | 'purple'
-    | 'indigo'
-    | 'grey';
-
-export interface CardHeader {
-    title: TextCardTag;
-    template?: TemplateColor;
-}
-
-export interface InteractiveMessage
-    extends Partial<Record<`${'' | 'i18n_'}elements`, CardTag[]>> {
-    config?: Partial<Record<'enable_forward' | 'update_multi', boolean>>;
-    header?: CardHeader;
-}
-
-export type ChatMessageContent =
-    | TextMessage
-    | RichTextMessage
-    | UserCardMessage
-    | ChatCardMessage
-    | FileMessage
-    | StickerMessage
-    | AudioMessage
-    | VideoMessage
-    | InteractiveMessage;
+import { I18nKey, TranslationMap } from '../../../type';
+
+export interface TextMessage {
+    text: string;
+}
+
+export interface TextTag extends TextMessage {
+    tag: 'text';
+    un_escape?: boolean;
+}
+
+export interface LinkTag extends TextMessage {
+    tag: 'a';
+    href: string;
+}
+
+export interface AtTag {
+    tag: 'at';
+    user_id: string;
+    user_name?: string;
+}
+
+export interface ImageTag {
+    tag: 'img';
+    image_key: string;
+    width?: number;
+    height?: number;
+}
+
+export type RichTextTag = TextTag | LinkTag | AtTag | ImageTag;
+
+export type RichTextMessage = Record<
+    I18nKey,
+    {
+        title: string;
+        content: RichTextTag[][];
+    }
+>;
+
+export interface UserCardMessage {
+    type: 'share_user';
+    user_id: string;
+}
+
+export interface ChatCardMessage {
+    type: 'share_chat';
+    chat_id: string;
+}
+
+export interface FileMessage<T extends string = 'file'> {
+    type: T;
+    file_key: string;
+}
+
+export type StickerMessage = FileMessage<'sticker'>;
+
+export type AudioMessage = FileMessage<'audio'>;
+
+export type VideoMessage = FileMessage<'media'> & Pick<ImageTag, 'image_key'>;
+
+export interface TextCardTag {
+    tag: 'plain_text' | 'lark_md';
+    content?: string;
+    i18n?: TranslationMap;
+    lines?: number;
+}
+
+export interface HrCardTag {
+    tag: 'hr';
+}
+
+export type URLCardTag = Record<
+    `${'' | 'pc_' | 'android_' | 'ios_'}url`,
+    string
+>;
+
+export type ConfirmCardTag = Record<'title' | 'text', TextCardTag>;
+
+export interface ButtonCardTag {
+    tag: 'button';
+    type?: 'default' | 'primary' | 'danger';
+    text: TextCardTag;
+    value?: Record<string, string>;
+    url?: string;
+    multi_url?: URLCardTag;
+    confirm?: ConfirmCardTag;
+}
+
+export interface DivCardTag {
+    tag: 'div';
+    text?: TextCardTag;
+    fields?: {
+        is_short: boolean;
+        text: TextCardTag;
+    }[];
+    extra?: ButtonCardTag;
+}
+
+export interface ActionCardTag {
+    tag: 'action';
+    layout: 'bisected';
+    actions: ButtonCardTag[];
+}
+
+export type CardTag = HrCardTag | DivCardTag | ActionCardTag;
+
+export type TemplateColor =
+    | 'blue'
+    | 'wathet'
+    | 'turquoise'
+    | 'green'
+    | 'yellow'
+    | 'orange'
+    | 'red'
+    | 'carmine'
+    | 'violet'
+    | 'purple'
+    | 'indigo'
+    | 'grey';
+
+export interface CardHeader {
+    title: TextCardTag;
+    template?: TemplateColor;
+}
+
+export interface InteractiveMessage
+    extends Partial<Record<`${'' | 'i18n_'}elements`, CardTag[]>> {
+    config?: Partial<Record<'enable_forward' | 'update_multi', boolean>>;
+    header?: CardHeader;
+}
+
+export type ChatMessageContent =
+    | TextMessage
+    | RichTextMessage
+    | UserCardMessage
+    | ChatCardMessage
+    | FileMessage
+    | StickerMessage
+    | AudioMessage
+    | VideoMessage
+    | InteractiveMessage;

package/src/module/SpreadSheet/index.ts

@@ -1,78 +1,78 @@
-import { observable } from 'mobx';
-import { DataObject, ListModel, NewData, toggle } from 'mobx-restful';
-import { buildURLData, objectFrom } from 'web-utility';
-
-import { LarkData } from '../../type';
-import { SheetMeta, SpreadSheetMeta, SpreadSheetRange } from './type';
-
-export * from './type';
-
-export abstract class SpreadSheetModel<
-    D extends DataObject,
-    F extends NewData<D> = NewData<D>
-> extends ListModel<D, F> {
-    baseURI = '';
-
-    offset: [number, number] = [0, 0];
-
-    abstract columnKeys: (keyof D)[];
-
-    @observable
-    accessor meta: SheetMeta | undefined;
-
-    constructor(
-        public id: string,
-        public sheetId: string
-    ) {
-        super();
-        this.baseURI = `sheets/v2/spreadsheets/${id}`;
-    }
-
-    /**
-     * @see {@link https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN}
-     */
-    @toggle('downloading')
-    async getMeta() {
-        if (this.meta) return this.meta;
-
-        const { body } = await this.client.get<LarkData<SpreadSheetMeta>>(
-                `${this.baseURI}/metainfo`
-            ),
-            { sheetId } = this;
-
-        const sheet = body!.data!.sheets.find(
-            ({ sheetId: ID }) => ID === sheetId
-        );
-        console.assert(sheet, `Sheet "${sheetId}" is not found`);
-
-        return (this.meta = sheet!);
-    }
-
-    /**
-     * @see {@link https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN}
-     */
-    async loadPage(pageIndex: number, pageSize: number, filter: NewData<D>) {
-        const { columnKeys } = this,
-            [rowOff, columnOff] = this.offset,
-            { rowCount } = await this.getMeta();
-
-        const startRow = rowOff + 1,
-            startColumnNumber = 'A'.charCodeAt(0) + columnOff;
-        const endRow = Math.min(startRow - 1 + pageSize * pageIndex, rowCount),
-            endColumnNumber = startColumnNumber - 1 + columnKeys.length;
-        const startColumn = String.fromCharCode(startColumnNumber),
-            endColumn = String.fromCharCode(endColumnNumber);
-
-        const { body } = await this.client.get<LarkData<SpreadSheetRange>>(
-            `${this.baseURI}/values/${
-                this.sheetId
-            }!${startColumn}${startRow}:${endColumn}${endRow}?${buildURLData({
-                dateTimeRenderOption: 'FormattedString'
-            })}`
-        );
-        const pageData = body!.data!.valueRange.values.map(
-            row => objectFrom(row, columnKeys as string[]) as D
-        );
-        return { pageData, totalCount: rowCount - rowOff };
-    }
-}
+import { observable } from 'mobx';
+import { DataObject, ListModel, NewData, toggle } from 'mobx-restful';
+import { buildURLData, objectFrom } from 'web-utility';
+
+import { LarkData } from '../../type';
+import { SheetMeta, SpreadSheetMeta, SpreadSheetRange } from './type';
+
+export * from './type';
+
+export abstract class SpreadSheetModel<
+    D extends DataObject,
+    F extends NewData<D> = NewData<D>
+> extends ListModel<D, F> {
+    baseURI = '';
+
+    offset: [number, number] = [0, 0];
+
+    abstract columnKeys: (keyof D)[];
+
+    @observable
+    accessor meta: SheetMeta | undefined;
+
+    constructor(
+        public id: string,
+        public sheetId: string
+    ) {
+        super();
+        this.baseURI = `sheets/v2/spreadsheets/${id}`;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ukTMukTMukTM/uETMzUjLxEzM14SMxMTN}
+     */
+    @toggle('downloading')
+    async getMeta() {
+        if (this.meta) return this.meta;
+
+        const { body } = await this.client.get<LarkData<SpreadSheetMeta>>(
+                `${this.baseURI}/metainfo`
+            ),
+            { sheetId } = this;
+
+        const sheet = body!.data!.sheets.find(
+            ({ sheetId: ID }) => ID === sheetId
+        );
+        console.assert(sheet, `Sheet "${sheetId}" is not found`);
+
+        return (this.meta = sheet!);
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ukTMukTMukTM/ugTMzUjL4EzM14COxMTN}
+     */
+    async loadPage(pageIndex: number, pageSize: number, filter: NewData<D>) {
+        const { columnKeys } = this,
+            [rowOff, columnOff] = this.offset,
+            { rowCount } = await this.getMeta();
+
+        const startRow = rowOff + 1,
+            startColumnNumber = 'A'.charCodeAt(0) + columnOff;
+        const endRow = Math.min(startRow - 1 + pageSize * pageIndex, rowCount),
+            endColumnNumber = startColumnNumber - 1 + columnKeys.length;
+        const startColumn = String.fromCharCode(startColumnNumber),
+            endColumn = String.fromCharCode(endColumnNumber);
+
+        const { body } = await this.client.get<LarkData<SpreadSheetRange>>(
+            `${this.baseURI}/values/${
+                this.sheetId
+            }!${startColumn}${startRow}:${endColumn}${endRow}?${buildURLData({
+                dateTimeRenderOption: 'FormattedString'
+            })}`
+        );
+        const pageData = body!.data!.valueRange.values.map(
+            row => objectFrom(row, columnKeys as string[]) as D
+        );
+        return { pageData, totalCount: rowCount - rowOff };
+    }
+}

package/src/module/SpreadSheet/type.ts

@@ -1,31 +1,31 @@
-export type SheetMeta = Record<'sheetId' | 'title', string> &
-    Record<
-        `${'row' | 'column'}Count` | `frozen${'Row' | 'Col'}Count` | 'index',
-        number
-    >;
-
-export interface SpreadSheetMeta {
-    spreadsheetToken: string;
-    properties: {
-        title: string;
-    } & Record<'revision' | 'ownerUser' | 'sheetCount', number>;
-    sheets: SheetMeta[];
-}
-
-export interface SheetCellMedia {
-    type: 'url';
-    cellPosition: null;
-    text: string;
-    link?: string;
-}
-
-export type SheetCellValue = string | number | SheetCellMedia[] | null;
-
-export interface SpreadSheetRange {
-    revision: number;
-    spreadsheetToken: string;
-    valueRange: Record<'revision' | 'majorDimension', string> & {
-        range: `${string}!${string}:${string}`;
-        values: SheetCellValue[][];
-    };
-}
+export type SheetMeta = Record<'sheetId' | 'title', string> &
+    Record<
+        `${'row' | 'column'}Count` | `frozen${'Row' | 'Col'}Count` | 'index',
+        number
+    >;
+
+export interface SpreadSheetMeta {
+    spreadsheetToken: string;
+    properties: {
+        title: string;
+    } & Record<'revision' | 'ownerUser' | 'sheetCount', number>;
+    sheets: SheetMeta[];
+}
+
+export interface SheetCellMedia {
+    type: 'url';
+    cellPosition: null;
+    text: string;
+    link?: string;
+}
+
+export type SheetCellValue = string | number | SheetCellMedia[] | null;
+
+export interface SpreadSheetRange {
+    revision: number;
+    spreadsheetToken: string;
+    valueRange: Record<'revision' | 'majorDimension', string> & {
+        range: `${string}!${string}:${string}`;
+        values: SheetCellValue[][];
+    };
+}