service/cms | proxy-use

Type Aliases

ColumnType

所有字段的类型

DataHierarchies

DataHierarchies<T>: { dataHierarchies: DataHierarchies<T>; detail: T; id: string; index: string; name: string }[]

层级详情

Type Parameters

T extends Record<string, string> = Record<string, string>

DataHierarchy

DataHierarchy<T, P>: { dataHierarchy: DataHierarchy<T, P>; dataRow?: { detail: P; id: string }; detail: T; id: string; name: string }

Type Parameters

Type declaration

dataHierarchy: DataHierarchy<T, P>
Optional dataRow?: { detail: P; id: string }

数据详情
- detail: P
- id: string
detail: T
id: string
name: string

DataHierarchyTemplate

DataHierarchyTemplate: { dataColumns: DataTemplates[number]["dataColumns"][]; dataModuleId: string; id: string }

层级信息

Type declaration

dataColumns: DataTemplates[number]["dataColumns"][]
dataModuleId: string

模块id
id: string

DataItem

DataItem<T, P>: { createTime: string; dataHierarchyIds?: string[]; dataRows?: DataItem[]; dataTemplateId: string; detail: T; id: string; status: DataStatus[number]; tagIds?: string[] }

template的数据主体

Type Parameters

T extends Record<string, string> = Record<string, string>
P extends Record<string, string> = Record<string, string>

Type declaration

createTime: string
Optional dataHierarchyIds?: string[]

最近的层级id
Optional dataRows?: DataItem[]
dataTemplateId: string
detail: T
id: string
status: DataStatus[number]
Optional tagIds?: string[]

DataPaths

DataPaths<T, P>: ({ dataHierarchy: DataHierarchy<T, P> } & Pick<ModulesRsp<T>[number], "id" | "name" | "image" | "summary">)[]

Type Parameters

T extends Record<string, string>
P extends Record<string, string> = Record<string, string>

DataRowsOrder

DataRowsOrder<needIndex, T>: "key" | "createtime" | "updateTime" | (needIndex extends true ? "index" : unknown) | keyof T

排序条件

param index: 根据层级下的数据索引排序,recursive必须为false，否则会返回400
param key: 根据主键的值排序
param createtime: 根据创建时间排序
param updateTime: 根据更新时间排序
remarks: 传入其他键名时根据键值排序

Type Parameters

needIndex = true
T = Record<string, string>

DataStatus

DataStatus: ("Enable" | "Test" | "Disable")[]

数据的三种状态

description: 默认在测试时展示"Enable" | "Test"；在正式时展示Enable

DataTemplates

DataTemplates: { createTime: string; dataColumns: { columnName: string; columnType: ColumnType; customId: string; id: string; index: string; isKey: false }[]; dataPoolId: string; id: string; name: string; updateTime: string }[]

template信息

ModulesRsp

ModulesRsp<T>: { createTime: string; dataHierarchies: DataHierarchies<T>; dataHierarchyTemplate: DataHierarchyTemplate; dataPoolId: string; dataTemplates: DataTemplates; description?: string; id: string; image: string; name: string; summary?: string; updateTime: string }[]

module的通用返回体

Type Parameters

T extends Record<string, string>

RecursiveData

RecursiveData: {}

DataItem的递归帮助类

Type Parameters

Type declaration

[key: string]: P extends [string] ? DataItem[] : P extends [string, string] ? Record<string, DataItem[]> : Record<string, Record<string, DataItem[]>>

SearchDataRowsParamsItem

SearchDataRowsParamsItem: { dataTemplates: { customIds?: string[]; id: string }[]; id: string }[]

全局搜索的查询条件

SearchGroupBy

SearchGroupBy: ("dataModule" | "dataHierarchy" | "dataTemplate")[]

查询范围

SearchQuery

SearchQuery: { recursive?: boolean; searchKey?: string; searchTags?: boolean; separator?: string }

Type declaration

Optional recursive?: boolean

递归搜索

description
获取某一范围的所有数据时需要开启
Optional searchKey?: string

搜索值
Optional searchTags?: boolean

同时搜索物料标签
Optional separator?: string

搜索的分隔符，传入值时，searchKey按分隔符进行多键查询

example
separator:' ',对searchKey按空格分隔后一一匹配

dataQueryOptions

dataQueryOptions: { includeDataHierarchies?: boolean; recursive?: boolean }

csm查询选项

Type declaration

Optional includeDataHierarchies?: boolean

是否包含子层级
Optional recursive?: boolean

递归查询，此项仅在includeDataHierarchies为true时生效

Variables

Const DefaultStatuses

DefaultStatuses: string[] = ...

默认的筛选状态

Functions

dataApi

dataApi(target: string, data?: any): Promise<any>

- Defined in service/cms.ts:12
cms 的代理接口

export
description
相关介绍见：https://www.tapd.cn/55958943/markdown_wikis/show/#1155958943001000717

Parameters
- target: string
 
 请求路由
- Optional data: any
Returns Promise<any>

getDataHierarchies

getDataHierarchies<T>(dataModuleId: string, customIds?: (string | number)[], searchKey?: string, statuses?: DataStatus): Promise<DataHierarchies<T>>

- Defined in service/cms.ts:126
获取数据模块层级列表

Type Parameters
- T extends Record<string, string>
 
 返回的数据结构
Parameters
- dataModuleId: string
- Optional customIds: (string | number)[]
 
 层级的属性id
- Optional searchKey: string
 
 匹配customIds包含的值
- Optional statuses: DataStatus
Returns Promise<DataHierarchies<T>>

getDataHierarchy

getDataHierarchy<T>(options: dataQueryOptions & { dataHierarchyId: string; statuses?: DataStatus }): Promise<DataHierarchies<T>[number]>

- Defined in service/cms.ts:138
获取模块层级

Type Parameters
- T extends Record<string, string>
Parameters
- options: dataQueryOptions & { dataHierarchyId: string; statuses?: DataStatus }
Returns Promise<DataHierarchies<T>[number]>

getDataHierarchyTemplate

getDataHierarchyTemplate(dataModuleId: string): Promise<DataHierarchyTemplate>

- Defined in service/cms.ts:113
获取数据模块层级字段

Parameters
- dataModuleId: string
Returns Promise<DataHierarchyTemplate>

getDataModule

getDataModule<T>(options: dataQueryOptions & { dataModuleId: string; statuses?: DataStatus }): Promise<ModulesRsp<T>[number]>

- Defined in service/cms.ts:99
获取数据模块详情

Type Parameters
- T extends Record<string, string> = any
Parameters
- options: dataQueryOptions & { dataModuleId: string; statuses?: DataStatus }
Returns Promise<ModulesRsp<T>[number]>

getDataModules

getDataModules<T>(dataPoolId: string, statuses?: DataStatus): Promise<ModulesRsp<T>>

- Defined in service/cms.ts:92
获取数据模块列表

Type Parameters
- T extends Record<string, string>
Parameters
- dataPoolId: string
- Optional statuses: DataStatus
Returns Promise<ModulesRsp<T>>

getDataPaths

getDataPaths<T, P>(params: { dataHierarchyId?: string; dataModuleId?: string; dataRowId?: string }): Promise<DataPaths<T, P>>

- Defined in service/cms.ts:308
获取数据或层级的完整路径

remarks
dataRowId,dataHierarchyId至少一项不为空; 传入dataRowId时最里层会有dataRow字段

Type Parameters
- T extends Record<string, string>
 
 模块属性
- P extends Record<string, string> = Record<string, string>
Parameters
- params: { dataHierarchyId?: string; dataModuleId?: string; dataRowId?: string }
 - Optional dataHierarchyId?: string
 - Optional dataModuleId?: string
 - Optional dataRowId?: string
Returns Promise<DataPaths<T, P>>

getDataRow

getDataRow<T, P>(params: { dataRowId: string; statuses?: DataStatus }): Promise<DataItem<T, P>>

- Defined in service/cms.ts:269
获取某一行数据

Type Parameters
- T extends Record<string, string>
- P extends Record<string, string> = Record<string, string>
Parameters
- params: { dataRowId: string; statuses?: DataStatus }
 - dataRowId: string
 - Optional statuses?: DataStatus
Returns Promise<DataItem<T, P>>

getDataRowByIds

getDataRowByIds<T, P>(params: { dataRowIds: string[]; statuses?: DataStatus }): Promise<DataItem<T, P>[]>

- Defined in service/cms.ts:275
批量获取数据

Type Parameters
- T extends Record<string, string>
- P extends Record<string, string> = Record<string, string>
Parameters
- params: { dataRowIds: string[]; statuses?: DataStatus }
 - dataRowIds: string[]
 - Optional statuses?: DataStatus
Returns Promise<DataItem<T, P>[]>

getDataRows

getDataRows<T, P>(params: Partial<{ customIds: string[]; dataHierarchyId: string; dataModuleId: string; includeParentDataHierarchyIds: boolean; orderBy: DataRowsOrder<true, T>; statuses: DataStatus }> & { dataTemplateId: string } & SearchQuery & ListPagination & { desc?: boolean }): ListResponse<DataItem<T, P>[]>

- Defined in service/cms.ts:236
获取数据列表

description
排序默认按createtime排序，desc为true时按反序排，false按顺序排

remarks
dataTemplateId必传； dataModuleId/dataHierarchyId 只能传其中一个，不传则获取templateid表的所有数据；传入dataModuleId时，recursive需要传true，用于获取模块下所有数据；传入dataHierarchyId时，recursive为ture获取本层和所有子层数据，为false只获取当前层级数据 includeParentDataHierarchyIds为true时每条数据会加上最近的层级(与搜索范围有关)

Type Parameters
- T extends Record<string, string>
- P extends Record<string, string> = Record<string, string>
Parameters
- params: Partial<{ customIds: string[]; dataHierarchyId: string; dataModuleId: string; includeParentDataHierarchyIds: boolean; orderBy: DataRowsOrder<true, T>; statuses: DataStatus }> & { dataTemplateId: string } & SearchQuery & ListPagination & { desc?: boolean }
Returns ListResponse<DataItem<T, P>[]>

getDataTemplate

getDataTemplate(dataTemplateId: string): Promise<DataTemplates[number]>

- Defined in service/cms.ts:156
获取Template详情

Parameters
- dataTemplateId: string
Returns Promise<DataTemplates[number]>

getDataTemplates

getDataTemplates(dataPoolId: string): Promise<DataTemplates>

- Defined in service/cms.ts:149
获取所有Template

Parameters
- dataPoolId: string
Returns Promise<DataTemplates>

getPathNames

getPathNames(dataHierarchyId: string, ...concatNames: string[]): Promise<string>

- Defined in service/cms.ts:317
获取并拼接层级路径名称

Parameters
- dataHierarchyId: string
 
 层级id
- Rest ...concatNames: string[]
 
 其他名称
Returns Promise<string>

getRecommendDataRows

getRecommendDataRows<T, P>(params: { dataRowId: string; dataTemplateId: string; desc?: boolean; orderBy?: unknown; size: number; statuses?: DataStatus }): Promise<DataItem<T, P>[]>

- Defined in service/cms.ts:282
获取推荐数据

Type Parameters
- T extends Record<string, string>
- P extends Record<string, string> = Record<string, string>
Parameters
- params: { dataRowId: string; dataTemplateId: string; desc?: boolean; orderBy?: unknown; size: number; statuses?: DataStatus }
 - dataRowId: string
 - dataTemplateId: string
 - Optional desc?: boolean
 - Optional orderBy?: unknown
 - size: number
 - Optional statuses?: DataStatus
Returns Promise<DataItem<T, P>[]>

searchDataRowsInGlobal

searchDataRowsInGlobal(params: { dataHierarchies?: SearchDataRowsParamsItem; dataModules?: SearchDataRowsParamsItem; desc?: boolean; groupBy: P; statuses?: DataStatus } & SearchQuery): Promise<{ data: RecursiveData }>

- Defined in service/cms.ts:251
全局搜索数据

Type Parameters
- P extends ("dataModule" | "dataHierarchy" | "dataTemplate")[]
 
 查询范围
Parameters
- params: { dataHierarchies?: SearchDataRowsParamsItem; dataModules?: SearchDataRowsParamsItem; desc?: boolean; groupBy: P; statuses?: DataStatus } & SearchQuery
Returns Promise<{ data: RecursiveData }>

Index

Type Aliases

Variables

Functions

Type Aliases

ColumnType

DataHierarchies

Type Parameters

T extends Record<string, string> = Record<string, string>

DataHierarchy

Type Parameters

T

P

Type declaration

dataHierarchy: DataHierarchy<T, P>

Optional dataRow?: { detail: P; id: string }

detail: P

id: string

detail: T

id: string

name: string

DataHierarchyTemplate

Type declaration

dataColumns: DataTemplates[number]["dataColumns"][]

dataModuleId: string

id: string

DataItem

Type Parameters

T extends Record<string, string> = Record<string, string>

P extends Record<string, string> = Record<string, string>

Type declaration

createTime: string

Optional dataHierarchyIds?: string[]

Optional dataRows?: DataItem<P>[]

dataTemplateId: string

detail: T

id: string

status: DataStatus[number]

Optional tagIds?: string[]

DataPaths

Type Parameters

T extends Record<string, string>

P extends Record<string, string> = Record<string, string>

DataRowsOrder

Type Parameters

needIndex = true

T = Record<string, string>

DataStatus

DataTemplates

ModulesRsp

Type Parameters

T extends Record<string, string>

RecursiveData

Type Parameters

P

Type declaration

[key: string]: P extends [string] ? DataItem[] : P extends [string, string] ? Record<string, DataItem[]> : Record<string, Record<string, DataItem[]>>

SearchDataRowsParamsItem

SearchGroupBy

SearchQuery

Type declaration

Optional recursive?: boolean

Optional searchKey?: string

Optional searchTags?: boolean

Optional separator?: string

dataQueryOptions

Type declaration

Optional includeDataHierarchies?: boolean

Optional recursive?: boolean

Variables

Const DefaultStatuses

Functions

dataApi

Parameters

target: string

Optional data: any

Returns Promise<any>

getDataHierarchies

Type Parameters

T extends Record<string, string>