forked from join-monster/join-monster
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
158 lines (140 loc) · 3.77 KB
/
index.d.ts
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
155
156
157
158
import * as graphql from 'graphql'
export type Maybe<T> = null | undefined | T
// Extend graphql objects and fields
export type SqlJoin<TContext, TArgs> = (
table1: string,
table2: string,
args: TArgs,
context: TContext,
sqlASTNode: any
) => string
export type Where<TContext, TArgs> = (
usersTable: string,
args: TArgs,
context: TContext,
sqlASTNode: any
) => string | void
export type Direction = 'ASC' | 'asc' | 'DESC' | 'desc'
export type OrderBy =
| string
| { column: string; direction: Direction }[]
| { [key: string]: Direction }
export type SortKey =
| { column: string; direction: Direction }[]
| {
order: Direction
key: string | string[]
} // this is the old, pre 3.0 style limited to one direction for many keys
export type ThunkWithArgsCtx<T, TContext, TArgs> =
| ((args: TArgs, context: TContext) => T)
| T
export interface ObjectTypeExtension<TSource, TContext> {
alwaysFetch?: string | string[]
sqlTable?: ThunkWithArgsCtx<string, any, TContext>
uniqueKey?: string | string[]
}
export interface FieldConfigExtension<TSource, TContext, TArgs> {
ignoreAll?: boolean
ignoreTable?: boolean
junction?: {
include?: ThunkWithArgsCtx<
{
[column: string]: {
sqlColumn?: string
sqlExpr?: string
sqlDeps?: string | string[]
}
},
TContext,
TArgs
>
orderBy?: ThunkWithArgsCtx<OrderBy, TContext, TArgs>
sortKey?: ThunkWithArgsCtx<SortKey, TContext, TArgs>
sqlBatch?: {
thisKey: string
parentKey: string
sqlJoin: SqlJoin<TContext, TArgs>
}
sqlJoins?: [SqlJoin<TContext, TArgs>, SqlJoin<TContext, TArgs>]
sqlTable: ThunkWithArgsCtx<string, TContext, TArgs>
uniqueKey?: string | string[]
where?: Where<TContext, TArgs>
}
limit?: ThunkWithArgsCtx<number, TContext, TArgs>
orderBy?: ThunkWithArgsCtx<OrderBy, TContext, TArgs>
sortKey?: ThunkWithArgsCtx<SortKey, TContext, TArgs>
sqlBatch?: {
thisKey: string
parentKey: string
}
sqlColumn?: string
sqlDeps?: string[]
sqlExpr?: (
table: string,
args: TArgs,
context: TContext,
sqlASTNode: any
) => string
sqlJoin?: SqlJoin<TContext, TArgs>
sqlPaginate?: boolean
where?: Where<TContext, TArgs>
}
export interface UnionTypeExtension {
sqlTable?: string
uniqueKey?: string | string[]
alwaysFetch?: string | string[]
}
export interface InterfaceTypeExtension {
sqlTable?: string
uniqueKey?: string | string[]
alwaysFetch?: string | string[]
}
export interface ScalarTypeExtension {
sqlTable?: string
uniqueKey?: string | string[]
alwaysFetch?: string | string[]
}
declare module 'graphql' {
interface GraphQLObjectTypeExtensions<TSource = any, TContext = any> {
joinMonster?: ObjectTypeExtension<TSource, TContext>
}
interface GraphQLFieldExtensions<
TSource,
TContext,
TArgs = { [argName: string]: any }
> {
joinMonster?: FieldConfigExtension<TSource, TContext, TArgs>
}
interface GraphQLUnionTypeExtensions {
joinMonster?: UnionTypeExtension
}
interface GraphQLInterfaceTypeExtensions {
joinMonster?: InterfaceTypeExtension
}
interface GraphQLScalarTypeExtensions {
joinMonster?: ScalarTypeExtension
}
}
// JoinMonster lib interface
interface DialectModule {
name: string
}
type Dialect = 'pg' | 'oracle' | 'mariadb' | 'mysql' | 'mysql8' | 'sqlite3'
type JoinMonsterOptions = {
minify?: boolean
dialect?: Dialect
dialectModule?: DialectModule
}
type Rows = any
type DbCallCallback = (
sql: string,
done: (err?: any, rows?: Rows) => void
) => void
type DbCallPromise = (sql: string) => Promise<Rows>
declare function joinMonster(
resolveInfo: any,
context: any,
dbCall: DbCallCallback | DbCallPromise,
options?: JoinMonsterOptions
): Promise<any>
export default joinMonster