mobx-lark 2.1.1 → 2.2.0

package/src/module/Task/type.ts

@@ -1,168 +1,168 @@
-import { TranslationMap } from '../../type';
-
-export type StringMap = Record<string, string>;
-
-export interface TaskOperator {
-    id: string;
-    type: 'user' | 'app';
-    role?: 'creator' | 'owner' | 'editor' | 'viewer' | 'assignee' | 'follower';
-}
-
-export interface TaskList
-    extends Record<
-        'guid' | 'name' | 'url' | 'created_at' | 'updated_at',
-        string
-    > {
-    creator: TaskOperator;
-    owner: TaskOperator;
-    members: TaskOperator[];
-}
-
-export type TaskResourceType = 'tasklist' | 'my_tasks';
-
-export interface TaskResource {
-    resource_type: TaskResourceType;
-    resource_id: string;
-}
-
-export interface TaskListSection
-    extends Pick<
-        TaskList,
-        'guid' | 'name' | 'creator' | 'created_at' | 'updated_at'
-    > {
-    resource_type: TaskResourceType;
-    is_default: boolean;
-    tasklist: Pick<TaskList, 'guid' | 'name'>;
-}
-
-export interface TaskTimeEnd {
-    timestamp: string;
-    is_all_day?: boolean;
-}
-
-export interface TaskCompletion {
-    href: string;
-    tip: TranslationMap;
-}
-
-export type BaseTaskField = Pick<TaskList, 'guid' | 'name'> &
-    Pick<TaskList, 'creator' | 'created_at' | 'updated_at'>;
-
-export interface TaskFieldNumberSetting {
-    format: 'normal' | 'percentage' | 'cny' | 'usd' | 'custom';
-    custom_symbol?: string;
-    custom_symbol_position?: 'left' | 'right';
-    separator: 'none' | 'thousand';
-    decimal_count: number;
-}
-
-export interface NumberTaskField extends BaseTaskField {
-    type: 'number';
-    number_setting: TaskFieldNumberSetting;
-}
-
-export interface TextTaskField extends BaseTaskField {
-    type: 'text';
-    text_setting: object;
-}
-
-export interface DateTimeTaskField extends BaseTaskField {
-    type: 'datetime';
-    datetime_setting: { format: string };
-}
-
-export interface TaskFieldOption extends Pick<TaskFieldValue, 'guid' | 'name'> {
-    color_index: number;
-    is_hidden: boolean;
-}
-
-export interface SingleSelectTaskField extends BaseTaskField {
-    type: 'single_select';
-    single_select_setting: { options: TaskFieldOption[] };
-}
-
-export interface MultiSelectTaskField extends BaseTaskField {
-    type: 'multi_select';
-    multi_select_setting: { options: TaskFieldOption[] };
-}
-
-export interface MemberTaskField extends BaseTaskField {
-    type: 'member';
-    member_setting: { multi: boolean };
-}
-
-export type TaskField =
-    | NumberTaskField
-    | TextTaskField
-    | DateTimeTaskField
-    | SingleSelectTaskField
-    | MultiSelectTaskField
-    | MemberTaskField;
-
-export type TaskFieldValue = Pick<TaskField, 'guid' | 'type' | 'name'> &
-    Partial<
-        Record<
-            `${Exclude<TaskField['type'], 'member' | 'multi_select'>}_value`,
-            string
-        > & {
-            member_value: TaskOperator[];
-            multi_select_value: string[];
-        }
-    >;
-
-export interface TaskDependency {
-    type: 'next';
-    task_guid: string;
-}
-
-export interface TaskAttachment
-    extends Pick<TaskList, 'guid' | 'name'>,
-        Record<'file_token' | 'uploaded_at', string> {
-    size: 62232;
-    uploader: TaskOperator;
-    is_cover: boolean;
-    resource: { type: 'task'; id: string };
-}
-
-export interface Task
-    extends TaskList,
-        Record<
-            | 'task_id'
-            | 'summary'
-            | 'description'
-            | 'completed_at'
-            | 'repeat_rule'
-            | 'extra'
-            | 'parent_task_guid',
-            string
-        >,
-        Record<'mode' | 'source' | 'subtask_count', number> {
-    status: 'todo';
-    is_milestone: boolean;
-    start: TaskTimeEnd;
-    due: TaskTimeEnd;
-    reminders: {
-        id?: string;
-        relative_fire_minute: number;
-    }[];
-    origin: {
-        platform_i18n_name: TranslationMap;
-        href: Record<'url' | 'title', string>;
-    };
-    custom_complete: Record<'pc' | 'ios' | 'android', TaskCompletion>;
-    custom_fields: TaskFieldValue[];
-    attachments: TaskAttachment[];
-    dependencies: TaskDependency[];
-    tasklists: Partial<Record<'tasklist_guid' | 'section_guid', string>>[];
-}
-
-export type TaskSummary = Pick<TaskList, 'guid'> &
-    Pick<
-        Task,
-        | 'summary'
-        | 'completed_at'
-        | 'start'
-        | 'due'
-        | 'members'
-        | 'subtask_count'
-    >;
+import { TranslationMap } from '../../type';
+
+export type StringMap = Record<string, string>;
+
+export interface TaskOperator {
+    id: string;
+    type: 'user' | 'app';
+    role?: 'creator' | 'owner' | 'editor' | 'viewer' | 'assignee' | 'follower';
+}
+
+export interface TaskList
+    extends Record<
+        'guid' | 'name' | 'url' | 'created_at' | 'updated_at',
+        string
+    > {
+    creator: TaskOperator;
+    owner: TaskOperator;
+    members: TaskOperator[];
+}
+
+export type TaskResourceType = 'tasklist' | 'my_tasks';
+
+export interface TaskResource {
+    resource_type: TaskResourceType;
+    resource_id: string;
+}
+
+export interface TaskListSection
+    extends Pick<
+        TaskList,
+        'guid' | 'name' | 'creator' | 'created_at' | 'updated_at'
+    > {
+    resource_type: TaskResourceType;
+    is_default: boolean;
+    tasklist: Pick<TaskList, 'guid' | 'name'>;
+}
+
+export interface TaskTimeEnd {
+    timestamp: string;
+    is_all_day?: boolean;
+}
+
+export interface TaskCompletion {
+    href: string;
+    tip: TranslationMap;
+}
+
+export type BaseTaskField = Pick<TaskList, 'guid' | 'name'> &
+    Pick<TaskList, 'creator' | 'created_at' | 'updated_at'>;
+
+export interface TaskFieldNumberSetting {
+    format: 'normal' | 'percentage' | 'cny' | 'usd' | 'custom';
+    custom_symbol?: string;
+    custom_symbol_position?: 'left' | 'right';
+    separator: 'none' | 'thousand';
+    decimal_count: number;
+}
+
+export interface NumberTaskField extends BaseTaskField {
+    type: 'number';
+    number_setting: TaskFieldNumberSetting;
+}
+
+export interface TextTaskField extends BaseTaskField {
+    type: 'text';
+    text_setting: object;
+}
+
+export interface DateTimeTaskField extends BaseTaskField {
+    type: 'datetime';
+    datetime_setting: { format: string };
+}
+
+export interface TaskFieldOption extends Pick<TaskFieldValue, 'guid' | 'name'> {
+    color_index: number;
+    is_hidden: boolean;
+}
+
+export interface SingleSelectTaskField extends BaseTaskField {
+    type: 'single_select';
+    single_select_setting: { options: TaskFieldOption[] };
+}
+
+export interface MultiSelectTaskField extends BaseTaskField {
+    type: 'multi_select';
+    multi_select_setting: { options: TaskFieldOption[] };
+}
+
+export interface MemberTaskField extends BaseTaskField {
+    type: 'member';
+    member_setting: { multi: boolean };
+}
+
+export type TaskField =
+    | NumberTaskField
+    | TextTaskField
+    | DateTimeTaskField
+    | SingleSelectTaskField
+    | MultiSelectTaskField
+    | MemberTaskField;
+
+export type TaskFieldValue = Pick<TaskField, 'guid' | 'type' | 'name'> &
+    Partial<
+        Record<
+            `${Exclude<TaskField['type'], 'member' | 'multi_select'>}_value`,
+            string
+        > & {
+            member_value: TaskOperator[];
+            multi_select_value: string[];
+        }
+    >;
+
+export interface TaskDependency {
+    type: 'next';
+    task_guid: string;
+}
+
+export interface TaskAttachment
+    extends Pick<TaskList, 'guid' | 'name'>,
+        Record<'file_token' | 'uploaded_at', string> {
+    size: 62232;
+    uploader: TaskOperator;
+    is_cover: boolean;
+    resource: { type: 'task'; id: string };
+}
+
+export interface Task
+    extends TaskList,
+        Record<
+            | 'task_id'
+            | 'summary'
+            | 'description'
+            | 'completed_at'
+            | 'repeat_rule'
+            | 'extra'
+            | 'parent_task_guid',
+            string
+        >,
+        Record<'mode' | 'source' | 'subtask_count', number> {
+    status: 'todo';
+    is_milestone: boolean;
+    start: TaskTimeEnd;
+    due: TaskTimeEnd;
+    reminders: {
+        id?: string;
+        relative_fire_minute: number;
+    }[];
+    origin: {
+        platform_i18n_name: TranslationMap;
+        href: Record<'url' | 'title', string>;
+    };
+    custom_complete: Record<'pc' | 'ios' | 'android', TaskCompletion>;
+    custom_fields: TaskFieldValue[];
+    attachments: TaskAttachment[];
+    dependencies: TaskDependency[];
+    tasklists: Partial<Record<'tasklist_guid' | 'section_guid', string>>[];
+}
+
+export type TaskSummary = Pick<TaskList, 'guid'> &
+    Pick<
+        Task,
+        | 'summary'
+        | 'completed_at'
+        | 'start'
+        | 'due'
+        | 'members'
+        | 'subtask_count'
+    >;

package/src/module/Wiki/type.ts

@@ -1,16 +1,16 @@
-export interface LarkWikiNode
-    extends Record<
-        | 'title'
-        | 'creator'
-        | 'owner'
-        | `${'' | 'origin_'}space_id`
-        | `node_create_time`
-        | `${'' | 'parent_' | 'origin_'}node_token`
-        | `obj_token`
-        | `obj_${'create' | 'edit'}_time`,
-        string
-    > {
-    node_type: 'origin' | 'shortcut';
-    obj_type: `doc${'' | 'x'}` | 'sheet' | 'mindnote' | 'bitable' | 'file';
-    has_child: boolean;
-}
+export interface LarkWikiNode
+    extends Record<
+        | 'title'
+        | 'creator'
+        | 'owner'
+        | `${'' | 'origin_'}space_id`
+        | `node_create_time`
+        | `${'' | 'parent_' | 'origin_'}node_token`
+        | `obj_token`
+        | `obj_${'create' | 'edit'}_time`,
+        string
+    > {
+    node_type: 'origin' | 'shortcut';
+    obj_type: `doc${'' | 'x'}` | 'sheet' | 'mindnote' | 'bitable' | 'file';
+    has_child: boolean;
+}

package/src/module/base.ts

@@ -1,34 +1,34 @@
-import { DataObject, RESTClient } from 'mobx-restful';
-import { buildURLData } from 'web-utility';
-
-import { LarkPageData } from '../type';
-
-export async function* createPageStream<T extends DataObject>(
-    client: RESTClient,
-    path: string,
-    onCount: (total: number) => any,
-    filter: DataObject = {}
-) {
-    var count = 0,
-        lastPage = '';
-
-    do {
-        const { body } = await client.get<LarkPageData<T>>(
-            `${path}?${buildURLData({
-                ...filter,
-                page_size: 500,
-                page_token: lastPage
-            })}`
-        );
-        var { items, total, has_more, page_token } = body!.data!;
-
-        if (total != null) count = total;
-        else count += items?.length || 0;
-
-        lastPage = page_token;
-
-        onCount(has_more ? Infinity : count);
-
-        yield* items || [];
-    } while (has_more);
-}
+import { DataObject, RESTClient } from 'mobx-restful';
+import { buildURLData } from 'web-utility';
+
+import { LarkPageData } from '../type';
+
+export async function* createPageStream<T extends DataObject>(
+    client: RESTClient,
+    path: string,
+    onCount: (total: number) => any,
+    filter: DataObject = {}
+) {
+    var count = 0,
+        lastPage = '';
+
+    do {
+        const { body } = await client.get<LarkPageData<T>>(
+            `${path}?${buildURLData({
+                ...filter,
+                page_size: 500,
+                page_token: lastPage
+            })}`
+        );
+        var { items, total, has_more, page_token } = body!.data!;
+
+        if (total != null) count = total;
+        else count += items?.length || 0;
+
+        lastPage = page_token;
+
+        onCount(has_more ? Infinity : count);
+
+        yield* items || [];
+    } while (has_more);
+}

package/src/module/index.ts

@@ -1,6 +1,6 @@
-export * from './base';
-export * from './InstantMessenger';
-export * from './Task';
-export * from './SpreadSheet';
-export * from './BITable';
-export * from './Wiki/type';
+export * from './base';
+export * from './InstantMessenger';
+export * from './Task';
+export * from './SpreadSheet';
+export * from './BITable';
+export * from './Wiki/type';

package/src/type.ts

@@ -1,75 +1,75 @@
-export type LarkData<
-    D extends Record<string, any> = {},
-    E extends Record<string, any> = {}
-> = E & {
-    code: number;
-    msg: string;
-    data?: D;
-    error?: {
-        log_id: string;
-        [key: string]: any;
-    };
-};
-
-export type LarkPageData<D extends Record<string, any> = {}> = LarkData<{
-    page_token: string;
-    items: D[];
-    has_more: boolean;
-    total?: number;
-}>;
-
-export function isLarkError(data?: any): data is LarkData {
-    return !!(data as LarkData)?.code;
-}
-
-export type TenantAccessToken = LarkData<
-    {},
-    {
-        expire: number;
-        tenant_access_token: string;
-    }
->;
-
-export type UserIdType = `${'open' | 'union' | 'user'}_id`;
-
-export type LocaleUser = Record<
-    `${'' | 'en_'}name` | `${'' | 'enterprise_'}email`,
-    string
->;
-
-export interface UserMeta
-    extends LocaleUser,
-        Record<
-            | `avatar_${'url' | 'thumb' | 'middle' | 'big'}`
-            | UserIdType
-            | 'mobile'
-            | 'tenant_key'
-            | 'employee_no'
-            | `${'access' | 'refresh'}_token`,
-            string
-        >,
-        Record<`${'' | 'refresh_'}expires_in`, number> {
-    token_type: 'Bearer';
-}
-
-export interface JSTicket {
-    expire_in: number;
-    ticket: string;
-}
-
-export type I18nKey = `${string}_${string}`;
-
-export type TranslationMap = Record<I18nKey, string>;
-
-export type UploadTargetType =
-    | 'doc_image'
-    | 'docx_image'
-    | 'sheet_image'
-    | 'doc_file'
-    | 'docx_file'
-    | 'sheet_file'
-    | 'vc_virtual_background'
-    | 'bitable_image'
-    | 'bitable_file'
-    | 'moments'
-    | 'ccm_import_open';
+export type LarkData<
+    D extends Record<string, any> = {},
+    E extends Record<string, any> = {}
+> = E & {
+    code: number;
+    msg: string;
+    data?: D;
+    error?: {
+        log_id: string;
+        [key: string]: any;
+    };
+};
+
+export type LarkPageData<D extends Record<string, any> = {}> = LarkData<{
+    page_token: string;
+    items: D[];
+    has_more: boolean;
+    total?: number;
+}>;
+
+export function isLarkError(data?: any): data is LarkData {
+    return !!(data as LarkData)?.code;
+}
+
+export type TenantAccessToken = LarkData<
+    {},
+    {
+        expire: number;
+        tenant_access_token: string;
+    }
+>;
+
+export type UserIdType = `${'open' | 'union' | 'user'}_id`;
+
+export type LocaleUser = Record<
+    `${'' | 'en_'}name` | `${'' | 'enterprise_'}email`,
+    string
+>;
+
+export interface UserMeta
+    extends LocaleUser,
+        Record<
+            | `avatar_${'url' | 'thumb' | 'middle' | 'big'}`
+            | UserIdType
+            | 'mobile'
+            | 'tenant_key'
+            | 'employee_no'
+            | `${'access' | 'refresh'}_token`,
+            string
+        >,
+        Record<`${'' | 'refresh_'}expires_in`, number> {
+    token_type: 'Bearer';
+}
+
+export interface JSTicket {
+    expire_in: number;
+    ticket: string;
+}
+
+export type I18nKey = `${string}_${string}`;
+
+export type TranslationMap = Record<I18nKey, string>;
+
+export type UploadTargetType =
+    | 'doc_image'
+    | 'docx_image'
+    | 'sheet_image'
+    | 'doc_file'
+    | 'docx_file'
+    | 'sheet_file'
+    | 'vc_virtual_background'
+    | 'bitable_image'
+    | 'bitable_file'
+    | 'moments'
+    | 'ccm_import_open';

package/tsconfig.json

@@ -1,21 +1,21 @@
-{
-    "compilerOptions": {
-        "strict": true,
-        "target": "ES6",
-        "module": "CommonJS",
-        "moduleResolution": "Node",
-        "useDefineForClassFields": true,
-        "declaration": true,
-        "skipLibCheck": true,
-        "lib": ["ES2023", "DOM"],
-        "outDir": "dist/"
-    },
-    "include": ["src/**/*.ts"],
-    "typedocOptions": {
-        "name": "Lark SDK",
-        "excludeExternals": true,
-        "excludePrivate": true,
-        "readme": "./ReadMe.md",
-        "plugin": ["typedoc-plugin-mdn-links"]
-    }
-}
+{
+    "compilerOptions": {
+        "strict": true,
+        "target": "ES6",
+        "module": "CommonJS",
+        "moduleResolution": "Node",
+        "useDefineForClassFields": true,
+        "declaration": true,
+        "skipLibCheck": true,
+        "lib": ["ES2023", "DOM"],
+        "outDir": "dist/"
+    },
+    "include": ["src/**/*.ts"],
+    "typedocOptions": {
+        "name": "Lark SDK",
+        "excludeExternals": true,
+        "excludePrivate": true,
+        "readme": "./ReadMe.md",
+        "plugin": ["typedoc-plugin-mdn-links"]
+    }
+}