macoolka-type-model
Version:
`macoolka-type-model` is a library for define model in TypeScript. It easily build a type contain field and method to your Application. It provide a generation model for type and validition
1,058 lines (1,057 loc) • 23.5 kB
TypeScript
/**
* Code generated by github.com/macoolka/macoolka-gen-model, DO NOT EDIT.
*/
export interface NonEmptyArray<A> extends Array<A> {
0: A;
}
export declare type MaybeArray<A> = A | Array<A>;
/**
* @since 0.2.0
*/
/**
* basic scalar
* @desczh
* 基本标量
* @since 0.2.0
*/
export declare type MBasicScalar = 'string' | 'number' | 'boolean' | 'int' | 'datetime' | 'json';
/**
* Sring Format
* @desczh
* 文本格式
* @since 0.2.0
*/
export declare type MStringFormat = 'UUID' | 'EMail' | 'IPV4' | 'IPV6' | 'URL' | 'Search' | 'Password' | 'TextArea' | 'Icon';
/**
* Sring Format
* @desczh
* 文本格式
* @since 0.2.0
*/
export declare type MFileFormat = 'Image' | 'Audio' | 'Video' | 'Avatar' | 'File' | 'Markdown';
/**
* type kind
* @desczh
* 类型标示
* @since 0.2.0
*/
export declare type MIdentifierKind = 'field' | 'typealias' | 'interface' | 'class' | 'export' | 'function' | 'param' | 'constant' | 'module' | 'method' | 'staticmethod';
/**
* Scalar
* @desczh
* 标量
* @since 0.2.0
*/
export declare type MScalars = MEnumScalar | MStringScalar | MNumberScalar | MIntScalar | MBooleanScalar | MJsonScalar | MDateTimeScalar | MKindScalar | MTypeScalar | MTypeUnionScalar | MTypeIntersectionScalar | MFileScalar | MImageScalar;
/**
* Type have a name field
* @desczh
* 有一个name字段
* @since 0.2.0
*/
export interface MNameable {
/**
* The name is unique
* @desczh
* 唯一的名称
* @since 0.2.0
*/
name: string;
}
/**
* Information
* @desczh
* 信息
* @since 0.3.0
*/
export interface MInfoable {
/**
* description
* @desczh
* 注释
* @since 0.2.0
*/
description?: Array<string>;
/**
* i18n description
* @desczh
* 国际化注释
* @since 0.2.0
*/
descriptions?: Record<string, any>;
/**
* title
* @desczh
* 标题
* @since 0.2.0
*/
title?: string;
/**
* i18n title
* @desczh
* 国际化标题
* @since 0.2.0
*/
titles?: Record<string, any>;
/**
* help
* @desczh
* 帮助
* @since 0.2.0
*/
help?: Array<string>;
/**
* i18n help
* @desczh
* 国际化帮助
* @since 0.2.0
*/
helps?: Record<string, any>;
/**
* When was this feature added.
* @desczh
* 哪一个版本加入
* @since 0.2.0
*/
since?: string;
}
/**
* Document Tags
* @desczh
* 语句注释
* @since 0.2.0
*/
export interface MDocumentable extends MInfoable {
/**
* That this is no longer the preferred way.
* @desczh
* 过时，不再使用
* @since 0.2.0
*/
deprecated?: boolean;
/**
* Ignore the node when build docs
* @desczh
* 是否在生成文档时跳过
* @since 0.2.0
*/
ignore?: boolean;
/**
* example code
* @desczh
* 示例代码
* @since 0.2.0
*/
examples?: Array<string>;
/**
* signature
* @desczh
* 签名
* @since 0.2.0
*/
signature?: string;
/**
* That reason of deprecation.
* @desczh
* 废弃原因
* @since 0.2.0
*/
reason?: Array<string>;
/**
* The path on root
* @desczh
* 在根目录下的路径
* @since 0.2.0
*/
path?: Array<string>;
}
/**
* The Node can export on module
* @desczh
* 节点是否在模块导出
* @since 0.2.0
*/
export interface MExportable {
/**
* This contains tag 'export'
* @desczh
* 是否有导出标记
* @since 0.2.0
*/
isExported?: boolean;
}
/**
* The define basic info for scalar
* @desczh
* 定义一个标量的基本信息
* @since 0.2.0
*/
export interface MScalable {
/**
* The Node can be marked as undefined.
* @desczh
* 可能为空
* @since 0.2.0
*/
maybe?: boolean;
/**
* The field has the many multiplicity will also be marked.
* @desczh
* 是否是数组
* @since 0.2.0
*/
isArray?: boolean;
/**
* The field is T | Array<T>.
* @desczh
* T | Array<T>
* @since 0.2.0
*/
maybeArray?: boolean;
/**
* The means that no item in the list can be null
* @desczh
* 非空数组
* @since 0.2.0
*/
isArrayRequired?: boolean;
/**
* The means that defaultValue is []
* @desczh
* 缺省值为[]
* @since 0.2.0
*/
defaultEmptyArray?: boolean;
}
/**
* The define basic info for file
* @desczh
* 定义一个文件的基本信息
* @since 0.2.0
*/
export interface MFile {
/**
* The store name.
* @desczh
* 存储名称
* @since 0.2.0
*/
store?: string;
/**
* The container name.
* @desczh
* 容器名称
* @since 0.2.0
*/
container: string;
/**
* The folders array.
* @desczh
* 文件夹
* @since 0.2.0
*/
folders?: Array<string>;
}
/**
* Like a Boolean an Enum can have one of a predefined set of values.
* The difference is that you can define the possible values
* (whereas for a Boolean the options are restriced to true and false).
* For example you could specify how an article should be formatted
* by creating an Enum with the possible values COMPACT, WIDE and COVER.
* @desczh
* 枚举类型
* @since 0.2.0
*/
export interface MEnumScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'enum';
/**
* The values in enum.
* @desczh
* 枚举值
* @since 0.2.0
*/
values?: Array<string>;
/**
* The values in enum(i18n).
* @desczh
* 枚举值(国际化))
* @since 0.2.0
*/
ivalues?: Record<string, any>;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* json
* @desczh
* json类型
* @since 0.2.0
*/
export interface MJsonScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'json';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: Record<string, any>;
}
/**
* A String holds text. This is the type you would use for a username,
* the content of a blog post or anything else that is best represented as text.
* @desczh
* 文本类型
* @since 0.2.0
*/
export interface MStringScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'string';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
/**
* The length of value must great than given value
* @desczh
* 字段的最小长度
* @since 0.2.0
*/
minLength?: number;
/**
* The length of value must less than given value
* @desczh
* 字段的最大长度
* @since 0.2.0
*/
maxLength?: number;
/**
* The length value must match the given pattern
* @desczh
* 字段必须匹配这个正则表达式
* @since 0.2.0
*/
pattern?: string;
/**
* The rows define lines on input when format is textarea
* @desczh
* 当格式textarea时定义输入时的行数.
* @since 0.2.0
*/
rows?: string;
/**
* The value must match the given format
* @desczh
* 字段必须匹配指定的格式
* @since 0.2.0
*/
format?: MStringFormat;
}
/**
* A Image Information.
* @desczh
* 图片类型
* @since 0.2.0
*/
export interface MImageScalar extends MScalable, MFile {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'image';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
/**
* The value define image width
* @desczh
* 图片宽度
* @since 0.2.0
*/
width: number;
/**
* The value define image height
* @desczh
* 图片高度
* @since 0.2.0
*/
height: number;
/**
* The length value must match the given pattern
* @desczh
* 字段必须匹配这个正则表达式
* @since 0.2.0
*/
pattern?: string;
}
/**
* A File Information.
* @desczh
* 文件类型
* @since 0.2.0
*/
export interface MFileScalar extends MScalable, MFile {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'File';
/**
* The length value must match the given pattern
* @desczh
* 字段必须匹配这个正则表达式
* @since 0.2.0
*/
pattern?: string;
/**
* The File maxinum size
* @desczh
* 文件最大长度
* @since 0.2.0
*/
maximum?: number;
/**
* The file format
* @desczh
* 文件的格式
* @since 0.2.0
*/
format?: MFileFormat;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* A Number is a number that can have decimals.
* Use this to store values such as the price of an item in a store or the result of complex calculations.
* @desczh
* 数值型
* @since 0.2.0
*/
export interface MNumberScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'number';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: number;
/**
* The value must less than given value
* @desczh
* 字段的最大值
* @since 0.2.0
*/
maximum?: number;
/**
* The value must great than given value
* @desczh
* 字段的最小值
* @since 0.2.0
*/
minimum?: number;
}
/**
* An Int is a number that cannot have decimals.
* Use this to store values such as the weight of an ingredient required for a recipe or the minimum age for an event.
* @desczh
* 整型
* @since 0.2.0
*/
export interface MIntScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'int';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: number;
/**
* The value must less than given value
* @desczh
* 字段的最大值
* @since 0.2.0
*/
maximum?: number;
/**
* The value must great than given value
* @desczh
* 字段的最小值
* @since 0.2.0
*/
minimum?: number;
}
/**
* A Boolean can have the value true or false.
* This is useful to keep track of settings such as whether the user wants to receive an email newsletter
* or if a recipe is appropriate for vegetarians.
* @desczh
* 布尔型
* @since 0.2.0
*/
export interface MBooleanScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'boolean';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: boolean;
}
/**
* The DateTime type can be used to store date and/or time values.
* A good example might be a person's date of birth or the time/data when a specific event is happening.
* @desczh
* 日期型
* @since 0.2.0
*/
export interface MDateTimeScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'datetime';
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: 'now';
}
/**
* The _kind is a tag that check which Sclar be used.
* @desczh
* 标签
* @since 0.2.0
*/
export interface MKindScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'kind';
/**
* kind value
* @desczh
* 标签值
* @since 0.2.0
*/
value: string;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* A type give a value of model types.
* @desczh
* 类型
* @since 0.2.0
*/
export interface MTypeScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'type';
/**
* Model type name.
* @desczh
* 类型名称
* @since 0.2.0
*/
value: string;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* A union type describes a value that can be one of several types.
* @desczh
* 链接多个类型用OR
* @since 0.2.0
*/
export interface MTypeUnionScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'typeUnion';
/**
* Model type name.
* @since 0.2.0
*/
values?: Array<string>;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* A intersection type describes a value that can be one of several types.
* @desczh
* 链接多个类型用AND
* @since 0.2.0
*/
export interface MTypeIntersectionScalar extends MScalable {
/**
* The _kind is a tag that check which Scalar be used.
* @desczh
* 标签判断哪一个Scalar被使用
* @since 0.2.0
*/
_kind: 'typeIntersection';
/**
* Model type name.
* @since 0.2.0
*/
values?: Array<string>;
/**
* You can set a default value for the field
* The value will be applied to newly created records when no value was supplied during the create-operation.
* @desczh
* 缺省值
* @since 0.2.0
*/
defaultValue?: string;
}
/**
* The define a scalar ref
* @desczh
* 定义一个标量的引用
* @since 0.2.0
*/
export interface MValueable {
/**
* The type of this Node. A value of type indicates a scalar type.
* @desczh
* 一个节点的类型
* @since 0.2.0
*/
type?: MScalars | MBasicScalar;
/**
* The Node can be marked as required (also referred to as "non-nullable").
* @desczh
* 是否必填
* @since 0.2.0
*/
required?: boolean;
}
/**
* Represents a field in the datamodel.
* ModelField is referenced by its name and is either scalar or a relation field.
* @desczh
* 表示接口有字段集合
* @since 0.2.0
*/
export interface MVariable extends MDocumentable, MValueable, MNameable {
}
/**
* Represents a field in the datamodel.
* Field is referenced by its name and is either scalar or a relation field.
* @desczh
* 定义一个字段
* @since 0.2.0
*/
export interface MField extends MVariable {
/**
* @since 0.2.0
*/
_kind?: 'field';
/**
* Setting the unique constraint makes sure that two records of the model in question cannot have the same value for a certain field.
* @desczh
* 唯一.表示这个字段值在模型中不能重复
* @since 0.2.0
*/
unique?: boolean;
/**
* Id in a model").
* @desczh
* 这个字段标明模型的唯一性
* @since 0.2.0
*/
id?: boolean;
/**
* The field create by server.user can not edit
* @desczh
* 这个字段值有服务生成，用户不能修改
* @since 0.2.0
*/
readonly?: boolean;
/**
* The field used by order
* @desczh
* 可以根据这个字段排序
* @since 0.2.0
*/
order?: boolean;
/**
* That field exclusive when create model.
* @desczh
* 字段不在增加操作中使用
* @since 0.2.0
*/
exclusiveCreate?: boolean;
/**
* That field exclusive when update model.
* @desczh
* 字段不在更新操作中使用
* @since 0.2.0
*/
exclusiveUpdate?: boolean;
/**
* That field exclusive in where condition.
* @desczh
* 字段不在查询条件中
* @since 0.2.0
*/
exclusiveWhere?: boolean;
/**
* That field exclusive in search result.
* @desczh
* 字段不在查询结果中
* @since 0.2.0
*/
exclusiveSearch?: boolean;
/**
* That field exclusive in load result.
* @desczh
* 字段不在装载结果中
* @since 0.2.0
*/
exclusiveLoad?: boolean;
}
/**
* Param is used by method.
* @desczh
* 函数中的参数定义
* @since 0.2.0
*/
export interface MParam extends MVariable {
/**
* @since 0.2.0
*/
_kind?: 'param';
}
/**
* The define a basic function.
* @desczh
* 基本函数定义
* @since 0.2.0
*/
export interface MFunctional extends MDocumentable, MValueable, MNameable {
/**
* Param Array
* @desczh
* 参数集合
* @since 0.2.0
*/
params?: Array<MParam>;
/**
* The means that the method return void
* @desczh
* 是否返回值为void
* @since 0.2.0
*/
returnVoid?: boolean;
}
/**
* The define a method.
* @desczh
* 定义了一个方法
* @since 0.2.0
*/
export interface MMethod extends MFunctional {
/**
* @since 0.2.0
*/
_kind?: 'method';
}
/**
* The define a static method.
* @desczh
* 定义了一个静态方法
* @since 0.2.0
*/
export interface MStaticMethod extends MFunctional {
/**
* @since 0.2.0
*/
_kind?: 'staticmethod';
}
/**
* The define a function.
* @desczh
* 定义了一个方法
* @since 0.2.0
*/
export interface MFunction extends MFunctional, MExportable {
/**
* @since 0.2.0
*/
_kind?: 'function';
}
/**
* The define a constant.
* @desczh
* 定义了一个常量
* @since 0.2.0
*/
export interface MConstant extends MVariable, MExportable {
/**
* @since 0.2.0
*/
_kind?: 'constant';
}
/**
* The define a export.
* @desczh
* 定义了一个Export
* @since 0.2.0
*/
export interface MExport extends MDocumentable, MNameable {
/**
* @since 0.2.0
*/
_kind?: 'export';
}
/**
* MTypeable consist of multiple fields and multiple methods
* @desczh
* 可类型化表示这个类型由多个字段和方法组成
* @since 0.2.0
*/
export interface MTypeable extends MDocumentable, MExportable, MNameable {
/**
* The define fields on the type.
* @desczh
* 字段集合
* @since 0.2.0
*/
fields?: Array<MField>;
/**
* The define methods on the type.
* @desczh
* 方法集合
* @since 0.2.0
*/
methods?: Array<MMethod>;
}
/**
* The Define a interface
* @desczh
* 定义一个接口
* @since 0.2.0
*/
export interface MInterface extends MTypeable {
/**
* kind
* @desczh
* 标识
* @since 0.2.0
*/
_kind?: 'interface';
/**
* The names be implemented by the interface
* @desczh
* 实现的接口名称集合
* @since 0.2.0
*/
implements?: Array<string>;
}
/**
* The Define a Class
* @desczh
* 定义一个类
* @since 0.2.0
*/
export interface MClass extends MTypeable {
/**
* @since 0.2.0
*/
_kind?: 'class';
/**
* The names be implemented by the interface
* @desczh
* 实现的接口名称集合
* @since 0.2.0
*/
implements?: Array<string>;
/**
* Static Method Array
* @desczh
* 静态方法集合
* @since 0.2.0
*/
staticMethods?: Array<MStaticMethod>;
}
/**
* The Define a Type alias
* @desczh
* 定义一个类型别名
* @since 0.2.0
*/
export interface MTypeAlias extends MTypeable, MValueable {
/**
* @since 0.2.0
*/
_kind?: 'typealias';
}
/**
* The Define a Module
* @desczh
* 定义一个Module
* @since 0.2.0
*/
export interface MModule extends MDocumentable, MNameable {
/**
* True mean The module will generate doc
* @desczh
* 为真时表示产生文档
* @since 0.2.0
*/
file?: boolean;
/**
* @since 0.2.0
*/
_kind?: 'module';
/**
* interfaces
* @desczh
* 接口集合
* @since 0.2.0
*/
interfaces?: Array<MInterface>;
/**
* type aliases
* @desczh
* 类型别名集合
* @since 0.2.0
*/
typealiases?: Array<MTypeAlias>;
/**
* classes
* @desczh
* 类集合
* @since 0.2.0
*/
classes?: Array<MClass>;
/**
* functions
* @desczh
* 函数集合
* @since 0.2.0
*/
functions?: Array<MFunction>;
/**
* export
* @desczh
* 导出
* @since 0.2.0
*/
exports?: Array<MExport>;
/**
* constants
* @desczh
* 常量集合
* @since 0.2.0
*/
constants?: Array<MConstant>;
/**
* Id field only one
* @desczh
* 是否只有一个Id字段
* @since 0.2.0
*/
idUnique?: boolean;
}