piccolo_admin/admin_ui/src/interfaces.ts at c21bf11dd9aa87d3979513cbc16ecd6f12f9cf4c · piccolo-orm/piccolo_admin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
export interface CreateRow {
    tableName: string
    data: object
}

export interface DeleteRow {
    tableName: string
    rowID: number
}

export interface UpdateRow {
    tableName: string
    rowID: number
    data: object
}

export interface FetchIdsConfig {
    tableName: string
    limit: number
    search: string
    offset?: number
}

export interface FetchRowsConfig {
    tableName: string
    params: object
}

export interface FetchSingleRowConfig {
    tableName: string
    rowID: number
}

export interface APIResponseMessage {
    contents: string
    type: string
}

export interface OrderByConfig {
    column: string
    ascending: boolean
}

export interface RowCountAPIResponse {
    count: number
    page_size: number
}

export interface TableReference {
    tableName: string
    columnName: string
}

export interface TableReferencesAPIResponse {
    references: TableReference[]
}

/*****************************************************************************/
// Translations
export interface TranslationListItemAPI {
    language_name: string
    language_code: string
}

export interface TranslationsListAPIResponse {
    translations: TranslationListItemAPI[]
    default_language_code: string
}

export interface TranslationAPIResponse {
    language_name: string
    language_code: string
    translations: { [key: string]: string }
}

/*****************************************************************************/
// File storage

export interface StoreFileAPIResponse {
    file_key: string
}

export interface MediaViewerConfig {
    fileKey: string
    columnName: string
    tableName: string
}

/*****************************************************************************/

export interface Choice {
    display_name: string
    value: string
}

export interface Choices {
    [key: string]: Choice
}

/*****************************************************************************/

export interface Schema {
    title: string
    type: string
    properties: Properties
    help_text: null
    visible_column_names: string[]
    visible_filter_names: string[]
    rich_text_columns: string[]
    media_columns: string[]
    visible_fields_options: string[]
    primary_key_name: string
    link_column_name: string
    order_by: OrderByConfig[]
}

export interface Properties {
    [key: string]: RowConfig
}

export interface RowConfig {
    title: string
    default?: any
    extra: RowConfigExtra
    nullable: boolean
    type: string
    format?: string
    maxLength?: number
    items?: ArrayItems
}

export interface RowConfigExtra {
    help_text: null | string
    choices: Choices | null
    foreign_key?: boolean
    to?: string
}

export interface ArrayItems {
    type: string
}

export interface FormConfig {
    name: string
    slug: string
    description: string
}

export interface ChartConfig {
    title: string
    slug: string
    chart_type: string
    data: any
}