amis-core 1.0.0-beta.0

package/dist/src/schema.d.ts

@@ -0,0 +1,369 @@
+import { ListenerAction } from './actions/Action';
+import { FormSchema } from './renderers/Form';
+export interface SchemaMap {
+    form: FormSchema;
+}
+export declare type SchemaType = keyof SchemaMap;
+declare type ValueOf<T> = T[keyof T];
+export declare type SchemaObject = ValueOf<SchemaMap> & BaseSchema;
+export declare type SchemaCollection = SchemaObject | SchemaTpl | Array<SchemaObject | SchemaTpl>;
+/**
+ * 表达式，语法 `data.xxx > 5`。
+ */
+export declare type SchemaExpression = string;
+/**
+ * css类名，配置字符串，或者对象。
+ *
+ *     className: "red"
+ *
+ * 用对象配置时意味着你能跟表达式一起搭配使用，如：
+ *
+ *     className: {
+ *         "red": "data.progress > 80",
+ *         "blue": "data.progress > 60"
+ *     }
+ */
+export declare type SchemaClassName = string | {
+    [propName: string]: boolean | undefined | null | SchemaExpression;
+};
+export interface SchemaApiObject {
+    /**
+     * API 发送类型
+     */
+    method?: 'get' | 'post' | 'put' | 'delete' | 'patch' | 'jsonp';
+    /**
+     * API 发送目标地址
+     */
+    url: SchemaUrlPath;
+    /**
+     * 用来控制携带数据. 当key 为 `&` 值为 `$$` 时, 将所有原始数据打平设置到 data 中. 当值为 $$ 将所有原始数据赋值到对应的 key 中. 当值为 $ 打头时, 将变量值设置到 key 中.
+     */
+    data?: {
+        [propName: string]: any;
+    };
+    /**
+     * 默认数据映射中的key如果带点，或者带大括号，会转成对象比如：
+     *
+     * {
+     *   'a.b': '123'
+     * }
+     *
+     * 经过数据映射后变成
+     * {
+     *  a: {
+     *   b: '123
+     *  }
+     * }
+     *
+     * 如果想要关闭此功能，请设置 convertKeyToPath 为 false
+     */
+    convertKeyToPath?: boolean;
+    /**
+     * 用来做接口返回的数据映射。
+     */
+    responseData?: {
+        [propName: string]: any;
+    };
+    /**
+     * 如果 method 为 get 的接口，设置了 data 信息。
+     * 默认 data 会自动附带在 query 里面发送给后端。
+     *
+     * 如果想通过 body 发送给后端，那么请把这个配置成 false。
+     *
+     * 但是，浏览器还不支持啊，设置了只是摆设。除非服务端支持 method-override
+     */
+    attachDataToQuery?: boolean;
+    /**
+     * 发送体的格式
+     */
+    dataType?: 'json' | 'form-data' | 'form';
+    /**
+     * 如果是文件下载接口，请配置这个。
+     */
+    responseType?: 'blob';
+    /**
+     * 携带 headers，用法和 data 一样，可以用变量。
+     */
+    headers?: {
+        [propName: string]: string | number;
+    };
+    /**
+     * 设置发送条件
+     */
+    sendOn?: SchemaExpression;
+    /**
+     * 默认都是追加模式，如果想完全替换把这个配置成 true
+     */
+    replaceData?: boolean;
+    /**
+     * 是否自动刷新，当 url 中的取值结果变化时，自动刷新数据。
+     *
+     * @default true
+     */
+    autoRefresh?: boolean;
+    /**
+     * 当开启自动刷新的时候，默认是 api 的 url 来自动跟踪变量变化的。
+     * 如果你希望监控 url 外的变量，请配置 traceExpression。
+     */
+    trackExpression?: string;
+    /**
+     * 如果设置了值，同一个接口，相同参数，指定的时间（单位：ms）内请求将直接走缓存。
+     */
+    cache?: number;
+    /**
+     * 强制将数据附加在 query，默认只有 api 地址中没有用变量的时候 crud 查询接口才会
+     * 自动附加数据到 query 部分，如果想强制附加请设置这个属性。
+     * 对于那种临时加了个变量但是又不想全部参数写一遍的时候配置很有用。
+     */
+    forceAppendDataToQuery?: boolean;
+    /**
+     * qs 配置项
+     */
+    qsOptions?: {
+        arrayFormat?: 'indices' | 'brackets' | 'repeat' | 'comma';
+        indices?: boolean;
+        allowDots?: boolean;
+    };
+    /**
+     * autoFillApi 是否显示自动填充错误提示
+     */
+    silent?: boolean;
+}
+export declare type SchemaApi = string | SchemaApiObject;
+/**
+ * 组件名字，这个名字可以用来定位，用于组件通信
+ */
+export declare type SchemaName = string;
+/**
+ * 配置刷新动作，这个动作通常在完成渲染器本省的固定动作后出发。
+ *
+ * 一般用来配置目标组件的 name 属性。多个目标可以用逗号隔开。
+ *
+ * 当目标是 windows 时表示刷新整个页面。
+ *
+ * 刷新目标的同时还支持传递参数如： `foo?a=${a}&b=${b},boo?c=${c}`
+ */
+export declare type SchemaReload = string;
+/**
+ * 页面跳转地址，支持相对地址。
+ */
+export declare type SchemaRedirect = string;
+/**
+ * 支持两种语法，但是不能混着用。分别是：
+ *
+ * 1. `${xxx}` 或者 `${xxx|upperCase}`
+ * 2. `<%= data.xxx %>`
+ *
+ *
+ * 更多文档：https://baidu.gitee.io/amis/docs/concepts/template
+ */
+export declare type SchemaTpl = string;
+/**
+ * 初始数据，设置得值可用于组件内部模板使用。
+ */
+export declare type SchemaDefaultData = {
+    [propName: string]: any;
+};
+/**
+ * 用来关联 json schema 的，不用管。
+ */
+export declare type SchemaSchema = string;
+/**
+ * iconfont 里面的类名。
+ */
+export declare type SchemaIcon = string;
+export declare type SchemaTokenizeableString = string;
+export declare type SchemaUrlPath = SchemaTokenizeableString;
+export declare type SchemaTooltip = string | {
+    /**
+     * 标题
+     */
+    title?: string;
+    /**
+     * 内容
+     */
+    content: string;
+};
+/**
+ * 消息文案配置，记住这个优先级是最低的，如果你的接口返回了 msg，接口返回的优先。
+ */
+export declare type SchemaMessage = {
+    /**
+     * 获取失败时的提示
+     */
+    fetchFailed?: string;
+    /**
+     * 获取成功的提示，默认为空。
+     */
+    fetchSuccess?: string;
+    /**
+     * 保存失败时的提示。
+     */
+    saveFailed?: string;
+    /**
+     * 保存成功时的提示。
+     */
+    saveSuccess?: string;
+};
+export declare type SchemaFunction = string | Function;
+export interface BaseSchema {
+    type: any;
+    /**
+     * 容器 css 类名
+     */
+    className?: SchemaClassName;
+    /**
+     * 配合 definitions 一起使用，可以实现无限循环的渲染器。
+     */
+    $ref?: string;
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 是否禁用表达式
+     */
+    disabledOn?: SchemaExpression;
+    /**
+     * 是否隐藏
+     * @deprecated 推荐用 visible
+     */
+    hidden?: boolean;
+    /**
+     * 是否隐藏表达式
+     * @deprecated 推荐用 visibleOn
+     */
+    hiddenOn?: SchemaExpression;
+    /**
+     * 是否显示
+     */
+    visible?: boolean;
+    /**
+     * 是否显示表达式
+     */
+    visibleOn?: SchemaExpression;
+    /**
+     * 组件唯一 id，主要用于日志采集
+     */
+    id?: string;
+    /**
+     * 事件动作配置
+     */
+    onEvent?: {
+        [propName: string]: {
+            weight?: number;
+            actions: ListenerAction[];
+        };
+    };
+}
+export interface Option {
+    /**
+     * 用来显示的文字
+     */
+    label?: string;
+    /**
+     * 可以用来给 Option 标记个范围，让数据展示更清晰。
+     *
+     * 这个只有在数值展示的时候显示。
+     */
+    scopeLabel?: string;
+    /**
+     * 请保证数值唯一，多个选项值一致会认为是同一个选项。
+     */
+    value?: any;
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 支持嵌套
+     */
+    children?: Options;
+    /**
+     * 是否可见
+     */
+    visible?: boolean;
+    /**
+     * 最好不要用！因为有 visible 就够了。
+     *
+     * @deprecated 用 visible
+     */
+    hidden?: boolean;
+    /**
+     * 描述，部分控件支持
+     */
+    description?: string;
+    /**
+     * 标记后数据延时加载
+     */
+    defer?: boolean;
+    /**
+     * 如果设置了，优先级更高，不设置走 source 接口加载。
+     */
+    deferApi?: SchemaApi;
+    /**
+     * 标记正在加载。只有 defer 为 true 时有意义。内部字段不可以外部设置
+     */
+    loading?: boolean;
+    /**
+     * 只有设置了 defer 才有意义，内部字段不可以外部设置
+     */
+    loaded?: boolean;
+    [propName: string]: any;
+}
+export interface Options extends Array<Option> {
+}
+export declare type OptionValue = string | number | null | undefined | Option;
+export interface DialogSchemaBase {
+}
+export interface FeedbackDialog extends DialogSchemaBase {
+    /**
+     * 可以用来配置 feedback 的出现条件
+     */
+    visibleOn?: string;
+    /**
+     * feedback 弹框取消是否中断后续操作
+     */
+    skipRestOnCancel?: boolean;
+    /**
+     * feedback 弹框确认是否中断后续操作
+     */
+    skipRestOnConfirm?: boolean;
+}
+export interface ToastSchemaBase extends BaseSchema {
+    /**
+     * 轻提示内容
+     */
+    items: Array<{
+        title?: SchemaCollection;
+        body: SchemaCollection;
+        level: 'info' | 'success' | 'error' | 'warning';
+        id: string;
+        position?: 'top-right' | 'top-center' | 'top-left' | 'bottom-center' | 'bottom-left' | 'bottom-right' | 'center';
+        closeButton?: boolean;
+        showIcon?: boolean;
+        timeout?: number;
+    }>;
+    /**
+     * 弹出位置
+     */
+    position: 'top-right' | 'top-center' | 'top-left' | 'bottom-center' | 'bottom-left' | 'bottom-right' | 'center';
+    /**
+     * 是否展示关闭按钮
+     */
+    closeButton: boolean;
+    /**
+     * 是否展示图标
+     */
+    showIcon?: boolean;
+    /**
+     * 持续时间
+     */
+    timeout: number;
+}
+export interface ActionSchema {
+}
+export interface RemarkSchema {
+}
+export declare type SchemaRemark = string | Omit<RemarkSchema, 'type'>;
+export {};

package/dist/src/store/app.d.ts

@@ -0,0 +1,89 @@
+import { Instance, SnapshotIn } from 'mobx-state-tree';
+import { RendererEnv } from '../factory';
+import { Navigation } from '../types';
+export declare const AppStore: import("mobx-state-tree").IModelType<{
+    id: import("mobx-state-tree").ISimpleType<string>;
+    path: import("mobx-state-tree").IType<string | undefined, string, string>;
+    storeType: import("mobx-state-tree").ISimpleType<string>;
+    disposed: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    parentId: import("mobx-state-tree").IType<string | undefined, string, string>;
+    childrenIds: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").ISimpleType<string>>, [undefined]>;
+} & {
+    hasRemoteData: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<boolean>, [undefined]>;
+    data: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+    initedAt: import("mobx-state-tree").IType<number | undefined, number, number>;
+    updatedAt: import("mobx-state-tree").IType<number | undefined, number, number>;
+    pristine: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+    action: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+    dialogOpen: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    dialogData: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+    drawerOpen: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    drawerData: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+} & {
+    msg: import("mobx-state-tree").IType<string | undefined, string, string>;
+    error: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    fetching: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    saving: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    busying: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    checking: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    initializing: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    schema: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<any, any, any>, [undefined]>;
+    schemaKey: import("mobx-state-tree").IType<string | undefined, string, string>;
+} & {
+    pages: import("mobx-state-tree").IType<any, any, any>;
+    activePage: import("mobx-state-tree").IType<any, any, any>;
+    folded: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    offScreen: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+}, {
+    readonly parentStore: any;
+    readonly __: any;
+    readonly hasChildren: boolean;
+    readonly children: any[];
+} & {
+    onChildStoreDispose(child: any): void;
+    syncProps(props: any, prevProps: any, list?: string[]): void;
+    dispose: (callback?: (() => void) | undefined) => void;
+    addChildId: (id: string) => void;
+    removeChildId: (id: string) => void;
+} & {
+    getValueByName(name: string, canAccessSuper?: boolean): any;
+    getPristineValueByName(name: string): any;
+} & {
+    initData(data?: object, skipSetPristine?: boolean): void;
+    reset(): void;
+    updateData(data?: object, tag?: object | undefined, replace?: boolean | undefined): void;
+    changeValue(name: string, value: any, changePristine?: boolean | undefined, force?: boolean | undefined, otherModifier?: ((data: Object) => void) | undefined): void;
+    setCurrentAction(action: object): void;
+    openDialog(ctx: any, additonal?: object | undefined, callback?: ((ret: any) => void) | undefined): void;
+    closeDialog(result?: any): void;
+    openDrawer(ctx: any, additonal?: object | undefined, callback?: ((ret: any) => void) | undefined): void;
+    closeDrawer(result?: any): void;
+} & {
+    readonly loading: boolean;
+} & {
+    markFetching: (fetching?: boolean) => void;
+    markSaving: (saving?: boolean) => void;
+    markBusying: (busying?: boolean) => void;
+    fetchInitData: (api: import("../types").Api, data?: object | undefined, options?: import("../types").fetchOptions | undefined) => Promise<any>;
+    fetchData: (api: import("../types").Api, data?: object | undefined, options?: import("../types").fetchOptions | undefined) => Promise<any>;
+    reInitData: (data: object | undefined, replace?: boolean) => void;
+    updateMessage: (msg?: string | undefined, error?: boolean) => void;
+    clearMessage: () => void;
+    setHasRemoteData: () => void;
+    saveRemote: (api: import("../types").Api, data?: object | undefined, options?: import("../types").fetchOptions | undefined) => Promise<any>;
+    fetchSchema: (api: import("../types").Api, data?: object | undefined, options?: import("../types").fetchOptions | undefined) => Promise<any>;
+    checkRemote: (api: import("../types").Api, data?: object | undefined, options?: import("../types").fetchOptions | undefined) => Promise<any>;
+} & {
+    readonly navigations: Navigation[];
+    readonly bcn: any;
+    readonly pageData: object;
+} & {
+    toggleFolded(): void;
+    toggleOffScreen(): void;
+    setPages(pages: any): void;
+    rewrite(to: string, env: RendererEnv): void;
+    setActivePage(page: any, env: RendererEnv, params?: any): void;
+    updateActivePage(env: RendererEnv): void;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export declare type IAppStore = Instance<typeof AppStore>;
+export declare type SAppStore = SnapshotIn<typeof AppStore>;