@tablecraft/engine 0.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/__tests__/inputValidator.test.d.ts +2 -0
- package/dist/src/__tests__/inputValidator.test.d.ts.map +1 -0
- package/dist/src/__tests__/inputValidator.test.js +205 -0
- package/dist/src/__tests__/inputValidator.test.js.map +1 -0
- package/dist/src/__tests__/metadataBuilder.test.d.ts +2 -0
- package/dist/src/__tests__/metadataBuilder.test.d.ts.map +1 -0
- package/dist/src/__tests__/metadataBuilder.test.js +221 -0
- package/dist/src/__tests__/metadataBuilder.test.js.map +1 -0
- package/dist/src/core/aggregationBuilder.d.ts +17 -0
- package/dist/src/core/aggregationBuilder.d.ts.map +1 -0
- package/dist/src/core/aggregationBuilder.js +81 -0
- package/dist/src/core/aggregationBuilder.js.map +1 -0
- package/dist/src/core/cursorPagination.d.ts +36 -0
- package/dist/src/core/cursorPagination.d.ts.map +1 -0
- package/dist/src/core/cursorPagination.js +88 -0
- package/dist/src/core/cursorPagination.js.map +1 -0
- package/dist/src/core/datePresets.d.ts +19 -0
- package/dist/src/core/datePresets.d.ts.map +1 -0
- package/dist/src/core/datePresets.js +96 -0
- package/dist/src/core/datePresets.js.map +1 -0
- package/dist/src/core/dialect.d.ts +17 -0
- package/dist/src/core/dialect.d.ts.map +1 -0
- package/dist/src/core/dialect.js +60 -0
- package/dist/src/core/dialect.js.map +1 -0
- package/dist/src/core/fieldSelector.d.ts +19 -0
- package/dist/src/core/fieldSelector.d.ts.map +1 -0
- package/dist/src/core/fieldSelector.js +49 -0
- package/dist/src/core/fieldSelector.js.map +1 -0
- package/dist/src/core/filterBuilder.d.ts +22 -0
- package/dist/src/core/filterBuilder.d.ts.map +1 -0
- package/dist/src/core/filterBuilder.js +112 -0
- package/dist/src/core/filterBuilder.js.map +1 -0
- package/dist/src/core/filterGroupBuilder.d.ts +28 -0
- package/dist/src/core/filterGroupBuilder.d.ts.map +1 -0
- package/dist/src/core/filterGroupBuilder.js +73 -0
- package/dist/src/core/filterGroupBuilder.js.map +1 -0
- package/dist/src/core/groupByBuilder.d.ts +23 -0
- package/dist/src/core/groupByBuilder.d.ts.map +1 -0
- package/dist/src/core/groupByBuilder.js +127 -0
- package/dist/src/core/groupByBuilder.js.map +1 -0
- package/dist/src/core/inputValidator.d.ts +8 -0
- package/dist/src/core/inputValidator.d.ts.map +1 -0
- package/dist/src/core/inputValidator.js +117 -0
- package/dist/src/core/inputValidator.js.map +1 -0
- package/dist/src/core/metadataBuilder.d.ts +91 -0
- package/dist/src/core/metadataBuilder.d.ts.map +1 -0
- package/dist/src/core/metadataBuilder.js +220 -0
- package/dist/src/core/metadataBuilder.js.map +1 -0
- package/dist/src/core/paginationBuilder.d.ts +20 -0
- package/dist/src/core/paginationBuilder.d.ts.map +1 -0
- package/dist/src/core/paginationBuilder.js +42 -0
- package/dist/src/core/paginationBuilder.js.map +1 -0
- package/dist/src/core/queryBuilder.d.ts +20 -0
- package/dist/src/core/queryBuilder.d.ts.map +1 -0
- package/dist/src/core/queryBuilder.js +163 -0
- package/dist/src/core/queryBuilder.js.map +1 -0
- package/dist/src/core/recursiveBuilder.d.ts +25 -0
- package/dist/src/core/recursiveBuilder.d.ts.map +1 -0
- package/dist/src/core/recursiveBuilder.js +86 -0
- package/dist/src/core/recursiveBuilder.js.map +1 -0
- package/dist/src/core/relationBuilder.d.ts +19 -0
- package/dist/src/core/relationBuilder.d.ts.map +1 -0
- package/dist/src/core/relationBuilder.js +118 -0
- package/dist/src/core/relationBuilder.js.map +1 -0
- package/dist/src/core/roleFilter.d.ts +11 -0
- package/dist/src/core/roleFilter.d.ts.map +1 -0
- package/dist/src/core/roleFilter.js +24 -0
- package/dist/src/core/roleFilter.js.map +1 -0
- package/dist/src/core/searchBuilder.d.ts +17 -0
- package/dist/src/core/searchBuilder.d.ts.map +1 -0
- package/dist/src/core/searchBuilder.js +71 -0
- package/dist/src/core/searchBuilder.js.map +1 -0
- package/dist/src/core/softDelete.d.ts +12 -0
- package/dist/src/core/softDelete.d.ts.map +1 -0
- package/dist/src/core/softDelete.js +29 -0
- package/dist/src/core/softDelete.js.map +1 -0
- package/dist/src/core/sortBuilder.d.ts +14 -0
- package/dist/src/core/sortBuilder.d.ts.map +1 -0
- package/dist/src/core/sortBuilder.js +58 -0
- package/dist/src/core/sortBuilder.js.map +1 -0
- package/dist/src/core/subqueryBuilder.d.ts +13 -0
- package/dist/src/core/subqueryBuilder.d.ts.map +1 -0
- package/dist/src/core/subqueryBuilder.js +47 -0
- package/dist/src/core/subqueryBuilder.js.map +1 -0
- package/dist/src/core/validator.d.ts +18 -0
- package/dist/src/core/validator.d.ts.map +1 -0
- package/dist/src/core/validator.js +88 -0
- package/dist/src/core/validator.js.map +1 -0
- package/dist/src/define.d.ts +274 -0
- package/dist/src/define.d.ts.map +1 -0
- package/dist/src/define.js +690 -0
- package/dist/src/define.js.map +1 -0
- package/dist/src/engine.d.ts +17 -0
- package/dist/src/engine.d.ts.map +1 -0
- package/dist/src/engine.js +429 -0
- package/dist/src/engine.js.map +1 -0
- package/dist/src/errors.d.ts +53 -0
- package/dist/src/errors.d.ts.map +1 -0
- package/dist/src/errors.js +80 -0
- package/dist/src/errors.js.map +1 -0
- package/dist/src/index.d.ts +37 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +41 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/types/engine.d.ts +92 -0
- package/dist/src/types/engine.d.ts.map +1 -0
- package/dist/src/types/engine.js +2 -0
- package/dist/src/types/engine.js.map +1 -0
- package/dist/src/types/table.d.ts +867 -0
- package/dist/src/types/table.d.ts.map +1 -0
- package/dist/src/types/table.js +198 -0
- package/dist/src/types/table.js.map +1 -0
- package/dist/src/utils/adapterUtils.d.ts +16 -0
- package/dist/src/utils/adapterUtils.d.ts.map +1 -0
- package/dist/src/utils/adapterUtils.js +28 -0
- package/dist/src/utils/adapterUtils.js.map +1 -0
- package/dist/src/utils/codegen.d.ts +7 -0
- package/dist/src/utils/codegen.d.ts.map +1 -0
- package/dist/src/utils/codegen.js +126 -0
- package/dist/src/utils/codegen.js.map +1 -0
- package/dist/src/utils/export.d.ts +15 -0
- package/dist/src/utils/export.d.ts.map +1 -0
- package/dist/src/utils/export.js +42 -0
- package/dist/src/utils/export.js.map +1 -0
- package/dist/src/utils/introspect.d.ts +32 -0
- package/dist/src/utils/introspect.d.ts.map +1 -0
- package/dist/src/utils/introspect.js +174 -0
- package/dist/src/utils/introspect.js.map +1 -0
- package/dist/src/utils/openapi.d.ts +6 -0
- package/dist/src/utils/openapi.d.ts.map +1 -0
- package/dist/src/utils/openapi.js +138 -0
- package/dist/src/utils/openapi.js.map +1 -0
- package/dist/src/utils/operators.d.ts +8 -0
- package/dist/src/utils/operators.d.ts.map +1 -0
- package/dist/src/utils/operators.js +70 -0
- package/dist/src/utils/operators.js.map +1 -0
- package/dist/src/utils/requestParser.d.ts +18 -0
- package/dist/src/utils/requestParser.d.ts.map +1 -0
- package/dist/src/utils/requestParser.js +126 -0
- package/dist/src/utils/requestParser.js.map +1 -0
- package/dist/src/utils/responseFormatter.d.ts +12 -0
- package/dist/src/utils/responseFormatter.d.ts.map +1 -0
- package/dist/src/utils/responseFormatter.js +106 -0
- package/dist/src/utils/responseFormatter.js.map +1 -0
- package/dist/src/utils/typedSql.d.ts +70 -0
- package/dist/src/utils/typedSql.d.ts.map +1 -0
- package/dist/src/utils/typedSql.js +102 -0
- package/dist/src/utils/typedSql.js.map +1 -0
- package/dist/test/columnMeta.test.d.ts +2 -0
- package/dist/test/columnMeta.test.d.ts.map +1 -0
- package/dist/test/columnMeta.test.js +92 -0
- package/dist/test/columnMeta.test.js.map +1 -0
- package/dist/test/core/aggregationBuilder.test.d.ts +2 -0
- package/dist/test/core/aggregationBuilder.test.d.ts.map +1 -0
- package/dist/test/core/aggregationBuilder.test.js +64 -0
- package/dist/test/core/aggregationBuilder.test.js.map +1 -0
- package/dist/test/core/filterBuilder.test.d.ts +2 -0
- package/dist/test/core/filterBuilder.test.d.ts.map +1 -0
- package/dist/test/core/filterBuilder.test.js +80 -0
- package/dist/test/core/filterBuilder.test.js.map +1 -0
- package/dist/test/core/paginationBuilder.test.d.ts +2 -0
- package/dist/test/core/paginationBuilder.test.d.ts.map +1 -0
- package/dist/test/core/paginationBuilder.test.js +63 -0
- package/dist/test/core/paginationBuilder.test.js.map +1 -0
- package/dist/test/core/queryBuilder.test.d.ts +2 -0
- package/dist/test/core/queryBuilder.test.d.ts.map +1 -0
- package/dist/test/core/queryBuilder.test.js +92 -0
- package/dist/test/core/queryBuilder.test.js.map +1 -0
- package/dist/test/core/searchBuilder.test.d.ts +2 -0
- package/dist/test/core/searchBuilder.test.d.ts.map +1 -0
- package/dist/test/core/searchBuilder.test.js +68 -0
- package/dist/test/core/searchBuilder.test.js.map +1 -0
- package/dist/test/core/softDelete.test.d.ts +2 -0
- package/dist/test/core/softDelete.test.d.ts.map +1 -0
- package/dist/test/core/softDelete.test.js +60 -0
- package/dist/test/core/softDelete.test.js.map +1 -0
- package/dist/test/core/sortBuilder.test.d.ts +2 -0
- package/dist/test/core/sortBuilder.test.d.ts.map +1 -0
- package/dist/test/core/sortBuilder.test.js +59 -0
- package/dist/test/core/sortBuilder.test.js.map +1 -0
- package/dist/test/core/subqueryBuilder.test.d.ts +2 -0
- package/dist/test/core/subqueryBuilder.test.d.ts.map +1 -0
- package/dist/test/core/subqueryBuilder.test.js +48 -0
- package/dist/test/core/subqueryBuilder.test.js.map +1 -0
- package/dist/test/core/validator.test.d.ts +2 -0
- package/dist/test/core/validator.test.d.ts.map +1 -0
- package/dist/test/core/validator.test.js +81 -0
- package/dist/test/core/validator.test.js.map +1 -0
- package/dist/test/datePresets.test.d.ts +2 -0
- package/dist/test/datePresets.test.d.ts.map +1 -0
- package/dist/test/datePresets.test.js +57 -0
- package/dist/test/datePresets.test.js.map +1 -0
- package/dist/test/errors.test.d.ts +2 -0
- package/dist/test/errors.test.d.ts.map +1 -0
- package/dist/test/errors.test.js +62 -0
- package/dist/test/errors.test.js.map +1 -0
- package/dist/test/inputValidator.test.d.ts +2 -0
- package/dist/test/inputValidator.test.d.ts.map +1 -0
- package/dist/test/inputValidator.test.js +60 -0
- package/dist/test/inputValidator.test.js.map +1 -0
- package/dist/test/metadata.test.d.ts +2 -0
- package/dist/test/metadata.test.d.ts.map +1 -0
- package/dist/test/metadata.test.js +285 -0
- package/dist/test/metadata.test.js.map +1 -0
- package/dist/test/metadataComplete.test.d.ts +2 -0
- package/dist/test/metadataComplete.test.d.ts.map +1 -0
- package/dist/test/metadataComplete.test.js +113 -0
- package/dist/test/metadataComplete.test.js.map +1 -0
- package/dist/test/roleFilter.test.d.ts +2 -0
- package/dist/test/roleFilter.test.d.ts.map +1 -0
- package/dist/test/roleFilter.test.js +53 -0
- package/dist/test/roleFilter.test.js.map +1 -0
- package/dist/test/typedSql.test.d.ts +2 -0
- package/dist/test/typedSql.test.d.ts.map +1 -0
- package/dist/test/typedSql.test.js +63 -0
- package/dist/test/typedSql.test.js.map +1 -0
- package/dist/test/utils/codegen.test.d.ts +2 -0
- package/dist/test/utils/codegen.test.d.ts.map +1 -0
- package/dist/test/utils/codegen.test.js +65 -0
- package/dist/test/utils/codegen.test.js.map +1 -0
- package/dist/test/utils/export.test.d.ts +2 -0
- package/dist/test/utils/export.test.d.ts.map +1 -0
- package/dist/test/utils/export.test.js +54 -0
- package/dist/test/utils/export.test.js.map +1 -0
- package/dist/test/utils/openapi.test.d.ts +2 -0
- package/dist/test/utils/openapi.test.d.ts.map +1 -0
- package/dist/test/utils/openapi.test.js +65 -0
- package/dist/test/utils/openapi.test.js.map +1 -0
- package/dist/test/utils/requestParser.test.d.ts +2 -0
- package/dist/test/utils/requestParser.test.d.ts.map +1 -0
- package/dist/test/utils/requestParser.test.js +89 -0
- package/dist/test/utils/requestParser.test.js.map +1 -0
- package/dist/test/utils/responseFormatter.test.d.ts +2 -0
- package/dist/test/utils/responseFormatter.test.d.ts.map +1 -0
- package/dist/test/utils/responseFormatter.test.js +79 -0
- package/dist/test/utils/responseFormatter.test.js.map +1 -0
- package/package.json +42 -0
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
import { Table, SQL } from 'drizzle-orm';
|
|
2
|
+
import { TableConfig, ColumnConfig, Operator, FilterExpression, ColumnFormat, DatePreset } from './types/table';
|
|
3
|
+
type InferColumns<T> = T extends {
|
|
4
|
+
_: {
|
|
5
|
+
columns: infer C;
|
|
6
|
+
};
|
|
7
|
+
} ? keyof C & string : string;
|
|
8
|
+
export interface QuickOptions<T extends Table = Table> {
|
|
9
|
+
hide?: InferColumns<T>[];
|
|
10
|
+
search?: InferColumns<T>[];
|
|
11
|
+
filter?: InferColumns<T>[];
|
|
12
|
+
sort?: string;
|
|
13
|
+
pageSize?: number;
|
|
14
|
+
maxPageSize?: number;
|
|
15
|
+
labels?: Partial<Record<InferColumns<T>, string>>;
|
|
16
|
+
}
|
|
17
|
+
export interface RuntimeExtensions {
|
|
18
|
+
computedExpressions: Map<string, SQL>;
|
|
19
|
+
transforms: Map<string, (value: unknown) => unknown>;
|
|
20
|
+
rawSelects: Map<string, SQL>;
|
|
21
|
+
rawWheres: SQL[];
|
|
22
|
+
rawJoins: SQL[];
|
|
23
|
+
rawOrderBys: SQL[];
|
|
24
|
+
ctes: Map<string, SQL>;
|
|
25
|
+
sqlJoinConditions: Map<string, SQL>;
|
|
26
|
+
hooks?: {
|
|
27
|
+
beforeQuery?: (params: any, context: any) => any;
|
|
28
|
+
afterQuery?: (data: Record<string, unknown>[], params: any, context: any) => any;
|
|
29
|
+
onError?: (error: Error, params: any, context: any) => any;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
export declare class TableDefinitionBuilder<T extends Table = Table> {
|
|
33
|
+
_config: TableConfig;
|
|
34
|
+
_table: T;
|
|
35
|
+
_ext: RuntimeExtensions;
|
|
36
|
+
constructor(table: T, config: TableConfig);
|
|
37
|
+
/** Set display format for a column */
|
|
38
|
+
format(column: InferColumns<T>, fmt: ColumnFormat): this;
|
|
39
|
+
/** Set column alignment */
|
|
40
|
+
align(column: InferColumns<T>, alignment: 'left' | 'center' | 'right'): this;
|
|
41
|
+
/** Set column width (px) */
|
|
42
|
+
width(column: InferColumns<T>, w: number, options?: {
|
|
43
|
+
min?: number;
|
|
44
|
+
max?: number;
|
|
45
|
+
}): this;
|
|
46
|
+
/**
|
|
47
|
+
* Declare the valid values for a column.
|
|
48
|
+
* Used by frontend to render dropdown filters.
|
|
49
|
+
* @example
|
|
50
|
+
* .options('status', [
|
|
51
|
+
* { value: 'active', label: 'Active', color: 'green' },
|
|
52
|
+
* { value: 'inactive', label: 'Inactive', color: 'gray' },
|
|
53
|
+
* { value: 'banned', label: 'Banned', color: 'red' },
|
|
54
|
+
* ])
|
|
55
|
+
*/
|
|
56
|
+
options(column: InferColumns<T>, opts: {
|
|
57
|
+
value: string | number | boolean;
|
|
58
|
+
label: string;
|
|
59
|
+
color?: string;
|
|
60
|
+
}[]): this;
|
|
61
|
+
/**
|
|
62
|
+
* Set which date presets are available for filtering.
|
|
63
|
+
* @example
|
|
64
|
+
* .datePresets('createdAt', ['today', 'last7days', 'thisMonth', 'custom'])
|
|
65
|
+
*/
|
|
66
|
+
datePresets(column: InferColumns<T>, presets: DatePreset[]): this;
|
|
67
|
+
/**
|
|
68
|
+
* Restrict column visibility to specific roles.
|
|
69
|
+
* Columns without visibleTo are visible to everyone.
|
|
70
|
+
* @example
|
|
71
|
+
* .visibleTo('salary', ['admin', 'hr'])
|
|
72
|
+
* .visibleTo('internalNotes', ['admin'])
|
|
73
|
+
*/
|
|
74
|
+
visibleTo(column: InferColumns<T>, roles: string[]): this;
|
|
75
|
+
hide(...columns: InferColumns<T>[]): this;
|
|
76
|
+
show(...columns: InferColumns<T>[]): this;
|
|
77
|
+
only(...columns: InferColumns<T>[]): this;
|
|
78
|
+
autoHide(): this;
|
|
79
|
+
inspectSensitive(): string[];
|
|
80
|
+
label(column: InferColumns<T>, lbl: string): this;
|
|
81
|
+
labels(map: Partial<Record<InferColumns<T>, string>>): this;
|
|
82
|
+
search(...columns: InferColumns<T>[]): this;
|
|
83
|
+
searchAll(): this;
|
|
84
|
+
noSearch(): this;
|
|
85
|
+
filter(...columns: InferColumns<T>[]): this;
|
|
86
|
+
staticFilter(field: InferColumns<T>, operator: Operator, value: unknown): this;
|
|
87
|
+
noFilter(): this;
|
|
88
|
+
/**
|
|
89
|
+
* Add an OR group of conditions.
|
|
90
|
+
* @example .whereOr(
|
|
91
|
+
* { field: 'status', op: 'eq', value: 'active' },
|
|
92
|
+
* { field: 'priority', op: 'eq', value: 'high' },
|
|
93
|
+
* )
|
|
94
|
+
* → WHERE ... AND (status = 'active' OR priority = 'high')
|
|
95
|
+
*/
|
|
96
|
+
whereOr(...conditions: {
|
|
97
|
+
field: string;
|
|
98
|
+
op: Operator;
|
|
99
|
+
value: unknown;
|
|
100
|
+
}[]): this;
|
|
101
|
+
/**
|
|
102
|
+
* Add a filter group with explicit AND/OR type.
|
|
103
|
+
* Supports nested groups for complex logic.
|
|
104
|
+
* @example .whereGroup('or', [
|
|
105
|
+
* { field: 'status', operator: 'eq', value: 'active' },
|
|
106
|
+
* { type: 'and', conditions: [
|
|
107
|
+
* { field: 'priority', operator: 'eq', value: 'high' },
|
|
108
|
+
* { field: 'total', operator: 'gt', value: 1000 },
|
|
109
|
+
* ]},
|
|
110
|
+
* ])
|
|
111
|
+
*/
|
|
112
|
+
whereGroup(type: 'and' | 'or', conditions: FilterExpression[]): this;
|
|
113
|
+
sort(...specs: string[]): this;
|
|
114
|
+
sortable(...columns: InferColumns<T>[]): this;
|
|
115
|
+
noSort(): this;
|
|
116
|
+
pageSize(size: number, options?: {
|
|
117
|
+
max?: number;
|
|
118
|
+
}): this;
|
|
119
|
+
noPagination(): this;
|
|
120
|
+
join(table: Table, options?: {
|
|
121
|
+
on?: string | SQL;
|
|
122
|
+
type?: 'left' | 'right' | 'inner' | 'full';
|
|
123
|
+
alias?: string;
|
|
124
|
+
columns?: string[];
|
|
125
|
+
}): this;
|
|
126
|
+
computed(name: string, expression: SQL, options?: {
|
|
127
|
+
type?: ColumnConfig['type'];
|
|
128
|
+
label?: string;
|
|
129
|
+
}): this;
|
|
130
|
+
where(condition: {
|
|
131
|
+
field: string;
|
|
132
|
+
op: Operator;
|
|
133
|
+
value: unknown;
|
|
134
|
+
}): this;
|
|
135
|
+
dbTransform(column: InferColumns<T>, ...transforms: string[]): this;
|
|
136
|
+
jsTransform(column: InferColumns<T>, ...transforms: string[]): this;
|
|
137
|
+
transform(column: InferColumns<T>, fn: (value: unknown) => unknown): this;
|
|
138
|
+
groupBy(...fields: InferColumns<T>[]): this;
|
|
139
|
+
having(alias: string, operator: Operator, value: unknown): this;
|
|
140
|
+
aggregate(alias: string, type: 'count' | 'sum' | 'avg' | 'min' | 'max', field: InferColumns<T>): this;
|
|
141
|
+
include(table: Table, options: {
|
|
142
|
+
foreignKey: string;
|
|
143
|
+
localKey?: string;
|
|
144
|
+
as: string;
|
|
145
|
+
columns?: string[];
|
|
146
|
+
limit?: number;
|
|
147
|
+
where?: {
|
|
148
|
+
field: string;
|
|
149
|
+
op: Operator;
|
|
150
|
+
value: unknown;
|
|
151
|
+
}[];
|
|
152
|
+
orderBy?: string[];
|
|
153
|
+
}): this;
|
|
154
|
+
recursive(options: {
|
|
155
|
+
parentKey: string;
|
|
156
|
+
childKey?: string;
|
|
157
|
+
maxDepth?: number;
|
|
158
|
+
startWith?: {
|
|
159
|
+
field: string;
|
|
160
|
+
op: Operator;
|
|
161
|
+
value: unknown;
|
|
162
|
+
};
|
|
163
|
+
depthAlias?: string;
|
|
164
|
+
pathAlias?: string;
|
|
165
|
+
}): this;
|
|
166
|
+
/**
|
|
167
|
+
* Enrich any column's metadata — works on base columns, join columns,
|
|
168
|
+
* computed columns, rawSelect columns, or any column by name.
|
|
169
|
+
*
|
|
170
|
+
* Use this to describe raw SQL columns to the frontend, or override
|
|
171
|
+
* any auto-detected metadata.
|
|
172
|
+
*
|
|
173
|
+
* @example
|
|
174
|
+
* .rawSelect('revenue', sql`SUM(orders.total)`)
|
|
175
|
+
* .columnMeta('revenue', {
|
|
176
|
+
* type: 'number',
|
|
177
|
+
* label: 'Total Revenue',
|
|
178
|
+
* format: 'currency',
|
|
179
|
+
* align: 'right',
|
|
180
|
+
* filterable: true,
|
|
181
|
+
* sortable: true,
|
|
182
|
+
* options: [
|
|
183
|
+
* { value: 'high', label: 'High (>$1000)', color: 'green' },
|
|
184
|
+
* ],
|
|
185
|
+
* })
|
|
186
|
+
*/
|
|
187
|
+
columnMeta(column: string, meta: {
|
|
188
|
+
type?: ColumnConfig['type'];
|
|
189
|
+
label?: string;
|
|
190
|
+
format?: ColumnFormat;
|
|
191
|
+
align?: 'left' | 'center' | 'right';
|
|
192
|
+
width?: number;
|
|
193
|
+
minWidth?: number;
|
|
194
|
+
maxWidth?: number;
|
|
195
|
+
sortable?: boolean;
|
|
196
|
+
filterable?: boolean;
|
|
197
|
+
hidden?: boolean;
|
|
198
|
+
options?: {
|
|
199
|
+
value: string | number | boolean;
|
|
200
|
+
label: string;
|
|
201
|
+
color?: string;
|
|
202
|
+
}[];
|
|
203
|
+
datePresets?: DatePreset[];
|
|
204
|
+
visibleTo?: string[];
|
|
205
|
+
}): this;
|
|
206
|
+
/** Find a column inside the join tree by name */
|
|
207
|
+
private _findJoinColumn;
|
|
208
|
+
/**
|
|
209
|
+
* Add a raw SQL expression as a select column.
|
|
210
|
+
* By default typed as 'string'. Use the options parameter or
|
|
211
|
+
* chain `.columnMeta()` to set the correct type, label, format, etc.
|
|
212
|
+
*
|
|
213
|
+
* @example
|
|
214
|
+
* // Basic
|
|
215
|
+
* .rawSelect('revenue', sql`SUM(orders.total)`)
|
|
216
|
+
*
|
|
217
|
+
* // With inline metadata
|
|
218
|
+
* .rawSelect('revenue', sql`SUM(orders.total)`, {
|
|
219
|
+
* type: 'number', label: 'Revenue', format: 'currency',
|
|
220
|
+
* })
|
|
221
|
+
*
|
|
222
|
+
* // Or chain .columnMeta() for full control
|
|
223
|
+
* .rawSelect('revenue', sql`SUM(orders.total)`)
|
|
224
|
+
* .columnMeta('revenue', { type: 'number', label: 'Revenue', format: 'currency' })
|
|
225
|
+
*/
|
|
226
|
+
rawSelect(alias: string, sqlExpr: SQL, options?: {
|
|
227
|
+
type?: ColumnConfig['type'];
|
|
228
|
+
label?: string;
|
|
229
|
+
format?: ColumnFormat;
|
|
230
|
+
align?: 'left' | 'center' | 'right';
|
|
231
|
+
sortable?: boolean;
|
|
232
|
+
filterable?: boolean;
|
|
233
|
+
hidden?: boolean;
|
|
234
|
+
width?: number;
|
|
235
|
+
options?: {
|
|
236
|
+
value: string | number | boolean;
|
|
237
|
+
label: string;
|
|
238
|
+
color?: string;
|
|
239
|
+
}[];
|
|
240
|
+
visibleTo?: string[];
|
|
241
|
+
}): this;
|
|
242
|
+
rawWhere(sqlExpr: SQL): this;
|
|
243
|
+
rawJoin(sqlExpr: SQL): this;
|
|
244
|
+
rawOrderBy(sqlExpr: SQL): this;
|
|
245
|
+
cte(name: string, sqlExpr: SQL): this;
|
|
246
|
+
subquery(alias: string, table: Table, type: 'count' | 'exists' | 'first', filter?: string): this;
|
|
247
|
+
softDelete(field?: string): this;
|
|
248
|
+
tenant(field?: string): this;
|
|
249
|
+
exportable(...formats: ('csv' | 'json')[]): this;
|
|
250
|
+
access(options: {
|
|
251
|
+
roles?: string[];
|
|
252
|
+
permissions?: string[];
|
|
253
|
+
}): this;
|
|
254
|
+
as(name: string): this;
|
|
255
|
+
/**
|
|
256
|
+
* Control how row counting works.
|
|
257
|
+
* 'exact' = SELECT COUNT(*) — accurate but slow on large tables
|
|
258
|
+
* 'estimated' = PostgreSQL's reltuples — fast but approximate
|
|
259
|
+
* 'none' = skip counting entirely — fastest
|
|
260
|
+
*/
|
|
261
|
+
countMode(mode: 'exact' | 'estimated' | 'none'): this;
|
|
262
|
+
/** Enable DISTINCT on queries */
|
|
263
|
+
distinct(): this;
|
|
264
|
+
/** Add a hook that runs before every query */
|
|
265
|
+
beforeQuery(fn: (params: any, context: any) => any): this;
|
|
266
|
+
/** Add a hook that runs after every query */
|
|
267
|
+
afterQuery(fn: (data: Record<string, unknown>[], params: any, context: any) => any): this;
|
|
268
|
+
/** Add an error handler */
|
|
269
|
+
onError(fn: (error: Error, params: any, context: any) => any): this;
|
|
270
|
+
toConfig(): TableConfig;
|
|
271
|
+
}
|
|
272
|
+
export declare function defineTable<T extends Table>(table: T, options?: QuickOptions<T> | TableConfig): TableDefinitionBuilder<T>;
|
|
273
|
+
export {};
|
|
274
|
+
//# sourceMappingURL=define.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define.d.ts","sourceRoot":"","sources":["../../src/define.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,GAAG,EAEJ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,YAAY,EAEZ,QAAQ,EAER,gBAAgB,EAEhB,YAAY,EACZ,UAAU,EACX,MAAM,eAAe,CAAC;AAOvB,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACxD,MAAM,CAAC,GAAG,MAAM,GAChB,MAAM,CAAC;AAIX,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK;IACnD,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;CACnD;AAKD,MAAM,WAAW,iBAAiB;IAChC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC;IACrD,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,SAAS,EAAE,GAAG,EAAE,CAAC;IACjB,QAAQ,EAAE,GAAG,EAAE,CAAC;IAChB,WAAW,EAAE,GAAG,EAAE,CAAC;IACnB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;QACjD,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;QACjF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,CAAC;KAC5D,CAAC;CACH;AAiBD,qBAAa,sBAAsB,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK;IACzD,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC;IACV,IAAI,EAAE,iBAAiB,CAAC;gBAEZ,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW;IAQzC,sCAAsC;IACtC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,GAAG,IAAI;IAMxD,2BAA2B;IAC3B,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,IAAI;IAM5E,4BAA4B;IAC5B,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAYzF;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GAC1E,IAAI;IAQP;;;;OAIG;IACH,WAAW,CACT,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EACvB,OAAO,EAAE,UAAU,EAAE,GACpB,IAAI;IAQP;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAQzD,IAAI,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAQzC,IAAI,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAQzC,IAAI,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAQzC,QAAQ,IAAI,IAAI;IAQhB,gBAAgB,IAAI,MAAM,EAAE;IAM5B,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAMjD,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,IAAI;IAS3D,MAAM,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3C,SAAS,IAAI,IAAI;IAQjB,QAAQ,IAAI,IAAI;IAOhB,MAAM,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAQ3C,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAM9E,QAAQ,IAAI,IAAI;IAOhB;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,EAAE,GAAG,IAAI;IAa/E;;;;;;;;;;OAUG;IACH,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAQpE,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAK9B,QAAQ,CAAC,GAAG,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAQ7C,MAAM,IAAI,IAAI;IAQd,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAUxD,YAAY,IAAI,IAAI;IAOpB,IAAI,CACF,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE;QACR,EAAE,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;QAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,GACA,IAAI;IAkDP,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAgBxG,KAAK,CAAC,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IAYvE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAMnE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI;IAMnE,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,GAAG,IAAI;IAOzE,OAAO,CAAC,GAAG,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAS/D,SAAS,CACP,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAC7C,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GACrB,IAAI;IAQP,OAAO,CACL,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,OAAO,CAAA;SAAE,EAAE,CAAC;QAC1D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KAEpB,GACA,IAAI;IAwBP,SAAS,CAAC,OAAO,EAAE;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,OAAO,CAAA;SAAE,CAAC;QAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAoBR;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,IAAI,EAAE;QACJ,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;QACpC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAChF,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;QAC3B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACtB,GACA,IAAI;IAuCP,iDAAiD;IACjD,OAAO,CAAC,eAAe;IAgBvB;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,YAAY,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;QACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAChF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;KACtB,GACA,IAAI;IAoBP,QAAQ,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAK5B,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAK3B,UAAU,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAK9B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI;IAOrC,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,EAClC,MAAM,CAAC,EAAE,MAAM,GACd,IAAI;IAaP,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAQhC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ5B,UAAU,CAAC,GAAG,OAAO,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI;IAQhD,MAAM,CAAC,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,IAAI;IAOnE,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOtB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI;IAUrD,iCAAiC;IACjC,QAAQ,IAAI,IAAI;IAOhB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,GAAG,IAAI;IAMzD,6CAA6C;IAC7C,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,GAAG,IAAI;IAMzF,2BAA2B;IAC3B,OAAO,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,KAAK,GAAG,GAAG,IAAI;IAQnE,QAAQ,IAAI,WAAW;CAGxB;AAID,wBAAgB,WAAW,CAAC,CAAC,SAAS,KAAK,EACzC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,WAAW,GACtC,sBAAsB,CAAC,CAAC,CAAC,CAY3B"}
|